filter.h File Reference

#include <inttypes.h>
#include <parserutils/errors.h>
#include <parserutils/functypes.h>

Include dependency graph for filter.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
union	parserutils_filter_optparams

Typedefs
typedef struct parserutils_filter	parserutils_filter
typedef enum parserutils_filter_opttype	parserutils_filter_opttype
typedef union parserutils_filter_optparams	parserutils_filter_optparams

Enumerations
enum	parserutils_filter_opttype { PARSERUTILS_FILTER_SET_ENCODING = 0 }

Functions
parserutils_error	parserutils__filter_create (const char *int_enc, parserutils_filter **filter)
parserutils_error	parserutils__filter_destroy (parserutils_filter *input)
parserutils_error	parserutils__filter_setopt (parserutils_filter *input, parserutils_filter_opttype type, parserutils_filter_optparams *params)
parserutils_error	parserutils__filter_process_chunk (parserutils_filter *input, const uint8_t **data, size_t *len, uint8_t **output, size_t *outlen)
parserutils_error	parserutils__filter_reset (parserutils_filter *input)

Typedef Documentation

parserutils_filter

typedef struct parserutils_filter parserutils_filter

parserutils_filter_optparams

typedef union parserutils_filter_optparams parserutils_filter_optparams

Input filter option parameters

parserutils_filter_opttype

typedef enum parserutils_filter_opttype parserutils_filter_opttype

Input filter option types

Enumeration Type Documentation

parserutils_filter_opttype

enum parserutils_filter_opttype

Input filter option types

Enumerator
PARSERUTILS_FILTER_SET_ENCODING

Function Documentation

parserutils__filter_create()

parserutils_error parserutils__filter_create	(	const char *	int_enc,
		parserutils_filter **	filter
	)

Create an input filter

Parameters

int_enc	Desired encoding of document
filter	Pointer to location to receive filter instance

Returns

PARSERUTILS_OK on success, PARSERUTILS_BADPARM on bad parameters, PARSERUTILS_NOMEM on memory exhausion, PARSERUTILS_BADENCODING if the encoding is unsupported

parserutils__filter_destroy()

parserutils_error parserutils__filter_destroy

(

parserutils_filter *

input

)

Destroy an input filter

Parameters

input

Pointer to filter instance

Returns

PARSERUTILS_OK on success, appropriate error otherwise

parserutils__filter_process_chunk()

parserutils_error parserutils__filter_process_chunk	(	parserutils_filter *	input,
		const uint8_t **	data,
		size_t *	len,
		uint8_t **	output,
		size_t *	outlen
	)

Process a chunk of data

Parameters

input	Pointer to filter instance
data	Pointer to pointer to input buffer
len	Pointer to length of input buffer
output	Pointer to pointer to output buffer
outlen	Pointer to length of output buffer

Returns

PARSERUTILS_OK on success, appropriate error otherwise

Call this with an input buffer length of 0 to flush any buffers.

parserutils__filter_reset()

parserutils_error parserutils__filter_reset

(

parserutils_filter *

input

)

Reset an input filter's state

Parameters

input

The input filter to reset

Returns

PARSERUTILS_OK on success, appropriate error otherwise

parserutils__filter_setopt()

parserutils_error parserutils__filter_setopt	(	parserutils_filter *	input,
		parserutils_filter_opttype	type,
		parserutils_filter_optparams *	params
	)

Configure an input filter

Parameters

input	Pointer to filter instance
type	Input option type to configure
params	Option-specific parameters

Returns

PARSERUTILS_OK on success, appropriate error otherwise