NumberFormatter Struct Reference

#include <NumberFormatter.h>

Overview

Number formatting and parsing.

Definition at line 57 of file NumberFormatter.h.

Inheritance diagram for NumberFormatter:

Properties
const char *	fmt
	The format string.
Object	object
	The superclass.
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class.
unsigned int	magic
	A header to allow introspection of Object types.

Methods
Class *	_NumberFormatter (void)
	The NumberFormatter archetype.
NumberFormatter *	initWithFormat (NumberFormatter *self, const char *fmt)
	Initializes a NumberFormatter with the specified format string.
Number *	numberFromString (const NumberFormatter *self, const String *string)
	Parses a Number from the specified String.
String *	stringFromNumber (const NumberFormatter *self, const Number *number)
	Yields a String representation of the specified Number instance.
Methods inherited from Object
Class *	_Object (void)
	The Object archetype.
Object *	copy (const Object *self)
	Creates a shallow copy of this Object.
void	dealloc (Object *self)
	Frees all resources held by this Object.
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object.
bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object.
bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership.

Protected Attributes
NumberFormatterInterface *	interface
	The interface.
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface.

Property Details

fmt

const char* NumberFormatter::fmt

The format string.

Definition at line 73 of file NumberFormatter.h.

interface

NumberFormatterInterface* NumberFormatter::interface

protected

The interface.

Definition at line 68 of file NumberFormatter.h.

object

Object NumberFormatter::object

The superclass.

Definition at line 62 of file NumberFormatter.h.

Method Details

_NumberFormatter()

Class * _NumberFormatter

(

void

)

The NumberFormatter archetype.

Returns

The NumberFormatter Class.

Definition at line 91 of file NumberFormatter.c.

                              {
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "NumberFormatter",
      .superclass = _Object(),
      .instanceSize = sizeof(NumberFormatter),
      .interfaceOffset = offsetof(NumberFormatter, interface),
      .interfaceSize = sizeof(NumberFormatterInterface),
      .initialize = initialize,
    });
  });
 
  return clazz;
}

initWithFormat()

NumberFormatter * initWithFormat	(	NumberFormatter *	self,
		const char *	fmt
	)

Initializes a NumberFormatter with the specified format string.

Parameters

self	The NumberFormatter.
fmt	The format string.

Returns

The initialized NumberFormatter, or NULL on error.

See also

strftime(3)

Definition at line 38 of file NumberFormatter.c.

                                                                               {
 
  self = (NumberFormatter *) super(Object, self, init);
  if (self) {
    self->fmt = fmt ?: NUMBERFORMAT_DECIMAL;
  }
 
  return self;
}

numberFromString()

Number * numberFromString	(	const NumberFormatter *	self,
		const String *	string
	)

Parses a Number from the specified String.

Parameters

self	The NumberFormatter.
string	The String to parse.

Returns

A Number instance, or NULL on error.

Definition at line 52 of file NumberFormatter.c.

                                                                                   {
 
  if (string) {
    double value;
 
    const int res = sscanf(string->chars, self->fmt, &value);
    if (res == 1) {
      return $(alloc(Number), initWithValue, value);
    }
  }
 
  return NULL;
}

stringFromNumber()

String * stringFromNumber	(	const NumberFormatter *	self,
		const Number *	number
	)

Yields a String representation of the specified Number instance.

Parameters

self	The NumberFormatter.
number	The Number to format.

Returns

The String representation of the Number, or NULL on error.

Definition at line 70 of file NumberFormatter.c.

                                                                                   {
 
  return $(alloc(String), initWithFormat, self->fmt, number->value);
}

---

The documentation for this struct was generated from the following files:

• Sources/Objectively/NumberFormatter.h
• Sources/Objectively/NumberFormatter.c