formatter

formatter

Synopsis




                    Formatter;
Formatter*          formatter_new                       (void);
void                formatter_destroy                   (Formatter *formatter);
void                formatter_associate                 (Formatter *formatter,
                                                         guchar id,
                                                         gchar *value);
void                formatter_dissociate                (Formatter *formatter,
                                                         guchar id);
gchar*              formatter_format                    (Formatter *formatter,
                                                         gchar *format);

Description

Details

Formatter

typedef struct {
    gchar *values[256];
} Formatter;

Formatter objects contain id->replacement mapping tables.

gchar *values[256];

 The stack of values used for replacement.

formatter_new ()

Formatter*          formatter_new                       (void);

Factory for Formatter objects.

Returns :

 A Formatter object.

formatter_destroy ()

void                formatter_destroy                   (Formatter *formatter);

Destroys Formatter objects.

formatter :

 A Formatter object to destroy.

formatter_associate ()

void                formatter_associate                 (Formatter *formatter,
                                                         guchar id,
                                                         gchar *value);

Adds a id->replacement set to the formatter's stack.

formatter :

 A Formatter object to use.

id :

 The character to use for replacement.

value :

 The value to replace with.

formatter_dissociate ()

void                formatter_dissociate                (Formatter *formatter,
                                                         guchar id);

Removes an id->replacement mapping from the formatter's stack.

formatter :

 A Formatter object to use.

id :

 The id to remove the id->replacement mapping for.

formatter_format ()

gchar*              formatter_format                    (Formatter *formatter,
                                                         gchar *format);

Performs id->replacement substitution on a string.

formatter :

 A Formatter object to use.

format :

 A string to format.

Returns :

 The formatted string.