Transformer SDK For C  6.2.11.309924
formatter.h File Reference

Go to the source code of this file.

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_tformat_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
formatThe format chain
textThe string to be formatted
Deprecated:
Use the format interface
TRANSFORMER_MODULE_EXPORT void format_delete ( formathandler_t format)

Delete a format chain.

Parameters
formatThe format chain
Deprecated:
Use the format interface
TRANSFORMER_MODULE_EXPORT char* format_find_arg ( char **  argv,
char *  search 
)

Find an argument in the array of arguments.

Parameters
argvThe arguments to search through
searchThe argument whose value we really want
Returns
Any value, or NULL if not defined
Note
This function will NULL out any matched options so that we can define the same attribute multiple times
Deprecated:
Use the format interface
TRANSFORMER_MODULE_EXPORT formathandler_t* format_parse ( char *  formatstring)

Construct a chain of formatters.

Parameters
formatstringThe format string
Returns
The chain of formatters
Deprecated:
Use the format interface
TRANSFORMER_MODULE_EXPORT void formatter_add ( char *  ident,
format_init_t  func 
)

Add a new formatter.

Parameters
identThe ident for this formatter
funcThe initialisation function

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

Deprecated:
Use the format interface

Generated on Sat Aug 26 2017 12:36:32 for Transformer SDK For C