treebuilder.h File Reference

#include <stdbool.h>
#include <inttypes.h>
#include <hubbub/errors.h>
#include <hubbub/functypes.h>
#include <hubbub/tree.h>
#include <hubbub/types.h>
#include "tokeniser/tokeniser.h"

Go to the source code of this file.

Classes
union	hubbub_treebuilder_optparams
	Hubbub treebuilder option parameters. More...

Typedefs
typedef struct hubbub_treebuilder	hubbub_treebuilder
typedef enum hubbub_treebuilder_opttype	hubbub_treebuilder_opttype
	Hubbub treebuilder option types. More...
typedef union hubbub_treebuilder_optparams	hubbub_treebuilder_optparams
	Hubbub treebuilder option parameters. More...

Enumerations
enum	hubbub_treebuilder_opttype { HUBBUB_TREEBUILDER_ERROR_HANDLER , HUBBUB_TREEBUILDER_TREE_HANDLER , HUBBUB_TREEBUILDER_DOCUMENT_NODE , HUBBUB_TREEBUILDER_ENABLE_SCRIPTING }
	Hubbub treebuilder option types. More...

Functions
hubbub_error	hubbub_treebuilder_create (hubbub_tokeniser *tokeniser, hubbub_treebuilder **treebuilder)
	Create a hubbub treebuilder. More...
hubbub_error	hubbub_treebuilder_destroy (hubbub_treebuilder *treebuilder)
	Destroy a hubbub treebuilder. More...
hubbub_error	hubbub_treebuilder_setopt (hubbub_treebuilder *treebuilder, hubbub_treebuilder_opttype type, hubbub_treebuilder_optparams *params)
	Configure a hubbub treebuilder. More...

Typedef Documentation

hubbub_treebuilder

typedef struct hubbub_treebuilder hubbub_treebuilder

hubbub_treebuilder_optparams

typedef union hubbub_treebuilder_optparams hubbub_treebuilder_optparams

Hubbub treebuilder option parameters.

hubbub_treebuilder_opttype

typedef enum hubbub_treebuilder_opttype hubbub_treebuilder_opttype

Hubbub treebuilder option types.

Enumeration Type Documentation

hubbub_treebuilder_opttype

enum hubbub_treebuilder_opttype

Hubbub treebuilder option types.

Enumerator
HUBBUB_TREEBUILDER_ERROR_HANDLER
HUBBUB_TREEBUILDER_TREE_HANDLER
HUBBUB_TREEBUILDER_DOCUMENT_NODE
HUBBUB_TREEBUILDER_ENABLE_SCRIPTING

Function Documentation

hubbub_treebuilder_create()

hubbub_error hubbub_treebuilder_create	(	hubbub_tokeniser *	tokeniser,
		hubbub_treebuilder **	treebuilder
	)

Create a hubbub treebuilder.

Parameters

tokeniser	Underlying tokeniser instance
treebuilder	Pointer to location to receive treebuilder instance

Returns

HUBBUB_OK on success, HUBBUB_BADPARM on bad parameters HUBBUB_NOMEM on memory exhaustion

hubbub_treebuilder_destroy()

hubbub_error hubbub_treebuilder_destroy

(

hubbub_treebuilder *

treebuilder

)

Destroy a hubbub treebuilder.

Parameters

treebuilder

The treebuilder instance to destroy

Returns

HUBBUB_OK on success, appropriate error otherwise

hubbub_treebuilder_setopt()

hubbub_error hubbub_treebuilder_setopt	(	hubbub_treebuilder *	treebuilder,
		hubbub_treebuilder_opttype	type,
		hubbub_treebuilder_optparams *	params
	)

Configure a hubbub treebuilder.

Parameters

treebuilder	The treebuilder instance to configure
type	The option type to configure
params	Pointer to option-specific parameters

Returns

HUBBUB_OK on success, appropriate error otherwise.