Data Structures
struct	_formathandler
	Structure used to generate chains of format handlers. More...

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

Typedefs
typedef struct _formathandler	formathandler_t
	Opaque handle to the format handler. More...

Functions
TRANSFORMER_MODULE_EXPORT char *	format_apply (formathandler_t format, char text)
	Apply a format stream to an input value. More...

TRANSFORMER_MODULE_EXPORT void	format_delete (formathandler_t *format)
	Delete a format chain. More...

TRANSFORMER_MODULE_EXPORT char *	format_find_arg (char *argv, char search)
	Find an argument in the array of arguments. More...

TRANSFORMER_MODULE_EXPORT formathandler_t *	format_parse (char *formatstring)
	Construct a chain of formatters. More...

TRANSFORMER_MODULE_EXPORT void	formatter_add (char *ident, format_init_t func)
	Add a new formatter. More...

Detailed Description

Definition of the format interface

Function Documentation

TRANSFORMER_MODULE_EXPORT char* format_apply	(	formathandler_t *	format,
		char *	text
	)

Apply a format stream to an input value.

Parameters

format	The format chain
text	The string to be formatted

TRANSFORMER_MODULE_EXPORT void format_delete ( formathandler_t * format )

Delete a format chain.

Parameters

format The format chain

TRANSFORMER_MODULE_EXPORT char* format_find_arg	(	char **	argv,
		char *	search
	)

Find an argument in the array of arguments.

Parameters

argv	The arguments to search through
search	The argument whose value we really want

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

TRANSFORMER_MODULE_EXPORT formathandler_t* format_parse ( char * formatstring )

Construct a chain of formatters.

Parameters

formatstring The format string

TRANSFORMER_MODULE_EXPORT void formatter_add	(	char *	ident,
		format_init_t	func
	)

Add a new formatter.

Parameters

ident	The ident for this formatter
func	The initialisation function

This function will overwrite formatters should a duplicate be supplied. This permits developers to overwrite the inbuilt formatting types