#include <D4ParserSax2.h>

Public Member Functions
bool	get_strict () const
	Get the setting of the 'strict' mode. More...

void	intern (istream &f, DMR *dest_dmr, bool debug=false)

void	intern (const string &document, DMR *dest_dmr, bool debug=false)

void	intern (const char buffer, int size, DMR dest_dmr, bool debug=false)

void	set_strict (bool s)
	Set the 'strict' mode to true or false. More...

Static Public Member Functions
SAX Parser Callbacks
These methods are declared static in the class header. This gives them C linkage which allows them to be used as callbacks by the SAX parser engine.
static void	dmr_start_document (void *parser)

static void	dmr_end_document (void *parser)

static void	dmr_start_element (void parser, const xmlChar localname, const xmlChar prefix, const xmlChar URI, int nb_namespaces, const xmlChar namespaces, int nb_attributes, int nb_defaulted, const xmlChar attributes)

static void	dmr_end_element (void parser, const xmlChar localname, const xmlChar prefix, const xmlChar URI)

static void	dmr_get_characters (void parser, const xmlChar ch, int len)

static void	dmr_ignoreable_whitespace (void parser, const xmlChar ch, int len)

static void	dmr_get_cdata (void parser, const xmlChar value, int len)

static xmlEntityPtr	dmr_get_entity (void parser, const xmlChar name)

static void	dmr_fatal_error (void parser, const char msg,...)

static void	dmr_error (void parser, const char msg,...)

Friends
class	D4ParserSax2Test

Detailed Description

Parse the XML text which encodes the network/persistent representation of the DMR object. In the current implementation, the DMR is held by an instance of the class DDS which in turn holds variables which include attributes.

This parser for the DMR document uses the SAX interface of libxml2. Static methods are used as callbacks for the SAX parser. These static methods are public because making them private complicates compilation. They should not be called by anything other than the intern method. They do not throw exceptions because exceptions from within callbacks are not reliable or portable. To signal errors, the methods record information in the D4ParserSax2 object. Once the error handler is called, construction of an DMR object ends even though the SAX parser still calls the various callback functions. The parser treats warnings, errors and fatal_errors the same way; when any are found parsing stops. The intern method throws an Error of InternalErr exception if an error was found.

Note that this class uses the C++-supplied default definitions for the default and copy constructors as well as the destructor and assignment operator.

See also: DMR

Definition at line 77 of file D4ParserSax2.h.

Member Function Documentation

◆ dmr_end_document()

void libdap::D4ParserSax2::dmr_end_document ( void * p )

static

Clean up after finishing a parse.

Parameters

p	The SAX parser

Definition at line 608 of file D4ParserSax2.cc.

◆ dmr_fatal_error()

void libdap::D4ParserSax2::dmr_fatal_error	(	void *	p,
		const char *	msg,
			...
	)

static

Process an XML fatal error. Note that SAX provides for warnings, errors and fatal errors. This code treats them all as fatal errors since there's typically no way to tell a user about the error since there's often no user interface for this software.

Note: This static function does not throw an exception or otherwise alter flow of control except for altering the parser state.

Parameters

p	The SAX parser
msg	A printf-style format string.

Definition at line 1196 of file D4ParserSax2.cc.

◆ dmr_get_cdata()

void libdap::D4ParserSax2::dmr_get_cdata	(	void *	p,
		const xmlChar *	value,
		int	len
	)

static

Get characters in a cdata block. DAP does not use CData, but XML in an OtherXML attribute (the value of that DAP attribute) might use it. This callback also allows CData when the parser is in the 'parser_unknown' state since some future DAP element might use it.

Definition at line 1158 of file D4ParserSax2.cc.

◆ dmr_get_characters()

void libdap::D4ParserSax2::dmr_get_characters	(	void *	p,
		const xmlChar *	ch,
		int	len
	)

static

Process/accumulate character data. This may be called more than once for one logical clump of data. Only save character data when processing 'value' elements; throw away all other characters.

Definition at line 1115 of file D4ParserSax2.cc.

◆ dmr_get_entity()

xmlEntityPtr libdap::D4ParserSax2::dmr_get_entity	(	void *	parser,
		const xmlChar *	name
	)

static

Handle the standard XML entities.

Parameters

parser	The SAX parser
name	The XML entity.

Definition at line 1181 of file D4ParserSax2.cc.

◆ dmr_ignoreable_whitespace()

void libdap::D4ParserSax2::dmr_ignoreable_whitespace	(	void *	p,
		const xmlChar *	ch,
		int	len
	)

static

Read whitespace that's not really important for content. This is used only for the OtherXML attribute type to preserve formating of the XML. Doing so makes the attribute value far easier to read.

Definition at line 1139 of file D4ParserSax2.cc.

◆ dmr_start_document()

void libdap::D4ParserSax2::dmr_start_document ( void * p )

static

Initialize the SAX parser state object. This object is passed to each callback as a void pointer. The initial state is parser_start.

Parameters

p	The SAX parser

Definition at line 590 of file D4ParserSax2.cc.

◆ dmr_start_element()

void libdap::D4ParserSax2::dmr_start_element	(	void *	p,
		const xmlChar *	l,
		const xmlChar *	prefix,
		const xmlChar *	URI,
		int	nb_namespaces,
		const xmlChar **	namespaces,
		int	nb_attributes,
		int	nb_defaulted,
		const xmlChar **	attributes
	)

static

Callback run when libxml2 reads the start of an element

Parameters

p	Pointer to the parser object
l	Localname of the element
prefix	Namespace prefix of the element
URI	the Element namespace name if available
nb_namespaces	Number of namespace definitions on that node
namespaces	Pointer to the array of prefix/URI pairs namespace definitions
nb_attributes	The number of attributes on that node
nb_defaulted	The number of defaulted attributes. The defaulted ones are at the end of the array
attributes	Pointer to the array of (localname/prefix/URI/value/end) attribute values.

Definition at line 642 of file D4ParserSax2.cc.

◆ intern()

void libdap::D4ParserSax2::intern	(	const char *	buffer,
		int	size,
		DMR *	dest_dmr,
		bool	debug = `false`
	)

Parse a DMR document stored in a char *buffer.

Parameters

document	Read the DMR from this string.
dest_dmr	Value/result parameter; dumps the information to this DMR instance.
debug	If true, ouput helpful debugging messages, False by default

Exceptions

Error	Thrown if the XML document could not be read or parsed.
InternalErr	Thrown if an internal error is found.

Definition at line 1397 of file D4ParserSax2.cc.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ dmr_end_document()

◆ dmr_fatal_error()

◆ dmr_get_cdata()

◆ dmr_get_characters()

◆ dmr_get_entity()

◆ dmr_ignoreable_whitespace()

◆ dmr_start_document()

◆ dmr_start_element()

◆ intern()