format_interface_t Struct Reference

Interface returned to other modules which require integration with the pipeline. More...

Data Fields
char *(*	format_apply )(formathandler_t *format, char *text)
	Delete a format handle. More...
void(*	format_delete )(formathandler_t *format)
	Parse a format string to generate a format handle. More...
char *(*	format_find_arg )(char **argv, char *search)
	Add (or override) a format handler. More...
formathandler_t *(*	format_parse )(char *formatstring)
	Find an argument value in a format string. More...
int	patch
int	version

Detailed Description

Interface returned to other modules which require integration with the pipeline.

To obtain this interface, the following should be performed:

format_interface_t   *interface;
format_interface_t   *(*get_format)();

if ( ( get_format = tf_find_function("format_get_interface") ) != NULL ) {
    format_interface = get_format();
    // At this point, format_interface points to the interface definition of the format module
}

Field Documentation

char*(* format_interface_t::format_apply) (formathandler_t *format, char *text)

Delete a format handle.

Parameters

format

- Handle to delete

void(* format_interface_t::format_delete) (formathandler_t *format)

Parse a format string to generate a format handle.

Parameters

formatstring

- Format string to generate a format handle from

Returns

A format handle

Return values

NULL	- The format could not be parsed

char*(* format_interface_t::format_find_arg) (char **argv, char *search)

Add (or override) a format handler.

Parameters

identifier	- Identifier for this format
func	- Initialisation function for this format

formathandler_t*(* format_interface_t::format_parse) (char *formatstring)

Find an argument value in a format string.

Parameters

argv	- NULL terminated array of format arguments
search	- Parameter to search for

Returns

The argument value if found

Note

This function will NULL out any matched options so that we can define the same attribute multiple times

int format_interface_t::patch

Patch version of the format module

int format_interface_t::version

Version number of the format module

---

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

• formatter.h