Log4gPatternParser

Log4gPatternParser — Parse pattern layout conversion patterns

Synopsis

                    Log4gPatternParser;
                    Log4gPatternParserClass;
Log4gPatternParser * log4g_pattern_parser_new           (const gchar *pattern);
void                log4g_pattern_parser_add_converter  (Log4gPatternParser *self,
                                                         Log4gPatternConverter *pc);
void                log4g_pattern_parser_add_to_list    (Log4gPatternParser *self,
                                                         Log4gPatternConverter *pc);
gchar *             log4g_pattern_parser_extract_option (Log4gPatternParser *self);
gint                log4g_pattern_parser_extract_precision_option
                                                        (Log4gPatternParser *self);
void                log4g_pattern_parser_finalize_converter
                                                        (Log4gPatternParser *self,
                                                         gchar c);
Log4gPatternConverter * log4g_pattern_parser_parse      (Log4gPatternParser *self);

Description

This class performs most of the work done by the pattern layout class. The conversion pattern is parsed and a chained list of pattern converters is created.

Details

Log4gPatternParser

typedef struct {
} Log4gPatternParser;

The Log4gPatternParser structure does not have any public members.


Log4gPatternParserClass

typedef struct {
} Log4gPatternParserClass;

The Log4gPatternParserClass structure does not have any public members.


log4g_pattern_parser_new ()

Log4gPatternParser * log4g_pattern_parser_new           (const gchar *pattern);

Create a new pattern parser object.

pattern :

The conversion pattern to parse.

Returns :

A new pattern parser object.

Since 0.1


log4g_pattern_parser_add_converter ()

void                log4g_pattern_parser_add_converter  (Log4gPatternParser *self,
                                                         Log4gPatternConverter *pc);

Add a pattern converter to a pattern parser object.

self :

A pattern converter object.

pc :

The pattern converter to add to self.

Since 0.1


log4g_pattern_parser_add_to_list ()

void                log4g_pattern_parser_add_to_list    (Log4gPatternParser *self,
                                                         Log4gPatternConverter *pc);

Add a pattern converter to the current list.

self :

A pattern converter object.

pc :

The pattern converter to add to self.

Since 0.1


log4g_pattern_parser_extract_option ()

gchar *             log4g_pattern_parser_extract_option (Log4gPatternParser *self);

Extract a braced conversion pattern option.

self :

A pattern converter object.

Returns :

A conversion pattern option or NULL if none was found. The caller must free the returned string with g_free().

Since 0.1


log4g_pattern_parser_extract_precision_option ()

gint                log4g_pattern_parser_extract_precision_option
                                                        (Log4gPatternParser *self);

Extract a precision option from a conversion pattern.

self :

A pattern converter object.

Returns :

The precision value or zero if none was found.

Since 0.1


log4g_pattern_parser_finalize_converter ()

void                log4g_pattern_parser_finalize_converter
                                                        (Log4gPatternParser *self,
                                                         gchar c);

Finalize the conversion pattern being parsed.

self :

A pattern converter object.

c :

The current conversion character.

Since 0.1


log4g_pattern_parser_parse ()

Log4gPatternConverter * log4g_pattern_parser_parse      (Log4gPatternParser *self);

Parse the conversion pattern.

self :

A pattern converter object.

Returns :

A chained list of pattern converters or NULL if none were created.

Since 0.1

See Also

Log4gPatternLayoutClass, Log4gPatternConverterClass