gre.h File Reference

Go to the source code of this file.

Functions
void	fgl_report_destroyContentHandler (ContentHandler *contentHandler)
void	fgl_report_processingInstruction (ContentHandler *content_handler, const char *target, const char *data)
void	fgl_report_startElement (ContentHandler *content_handler, const char *tagName)
void	fgl_report_attribute (ContentHandler *content_handler, const char *name, const char *value)
void	fgl_report_characters (ContentHandler *content_handler, const char *data)
void	fgl_report_endElement (ContentHandler *content_handler, const char *tagName)

Detailed Description

Runtime API for streaming documents to a simplified SAX ContentHandler

ContentHandlers are obtained from a RuntimeConfiguration by a call to createContentHandler()

The call grammar is as follows:

document: processingInstruction* tree;

tree: startElement(X) attribute* characters* forest characters* endElement(X) forest: tree*

Function Documentation

void fgl_report_attribute	(	ContentHandler *	content_handler,
		const char *	name,
		const char *	value
	)

Function to append an attribute to the document

Calls to this function are allowed only immediately after calling startElement or attribute (this function)

Parameters

contentHandler	The content handler
name	The attribute name
value	The attribute value

void fgl_report_characters	(	ContentHandler *	content_handler,
		const char *	data
	)

Function to append character data to the document

Calls to this function are allowed only immediately after calling startElement, attribute or characters (this function)

Parameters

contentHandler	The content handler
data	The character data

void fgl_report_destroyContentHandler

(

ContentHandler *

contentHandler

)

Function to dispose of a ContentHandler

Parameters

contentHandler

A content handler

void fgl_report_endElement	(	ContentHandler *	content_handler,
		const char *	tagName
	)

Function to append an end element to the document

Calls to startElement and endElement can be nested and need to be balanced so that for every call to startElement for a particular tag name, a corresponding call with the same tag name to endElement is required.

Parameters

contentHandler	The content handler
tagName	The tag name

void fgl_report_processingInstruction	(	ContentHandler *	content_handler,
		const char *	target,
		const char *	data
	)

Function to append a processing instruction to the document

Parameters

contentHandler	The content handler
target	The processing instruction target
data	The processing instruction data or 0. The data does not include any whitespace separating it from the target

void fgl_report_startElement	(	ContentHandler *	content_handler,
		const char *	tagName
	)

Function to append a start element to the document

Calls to startElement and endElement can be nested and need to be balanced so that for every call to startElement for a particular tag name, a corresponding call with the same tag name to endElement is required.

Parameters

contentHandler	The content handler
tagName	The tag name