A SAX interface implementation for constructing an in-memory DOM model. More...

#include <xml.hh>

Inheritance diagram for ghidra::TreeHandler:

Collaboration diagram for ghidra::TreeHandler:

Public Member Functions
	TreeHandler (Element *rt)
	Constructor given root Element.

virtual void	setDocumentLocator (Locator locator)
	Set the Locator object for documents.

virtual void	startDocument (void)
	Start processing a new XML document.

virtual void	endDocument (void)
	End processing for the current XML document.

virtual void	startPrefixMapping (const string &prefix, const string &uri)
	Start a new prefix to namespace URI mapping.

virtual void	endPrefixMapping (const string &prefix)
	Finish the current prefix.

virtual void	startElement (const string &namespaceURI, const string &localName, const string &qualifiedName, const Attributes &atts)
	Callback indicating a new XML element has started.

virtual void	endElement (const string &namespaceURI, const string &localName, const string &qualifiedName)
	Callback indicating parsing of the current XML element is finished.

virtual void	characters (const char *text, int4 start, int4 length)
	Callback with raw characters to be inserted in the current XML element.

virtual void	ignorableWhitespace (const char *text, int4 start, int4 length)
	Callback with whitespace character data for the current XML element.

virtual void	processingInstruction (const string &target, const string &data)
	Callback for a formal processing instruction seen in the current document.

virtual void	setVersion (const string &val)
	Set the XML version as specified by the current document.

virtual void	setEncoding (const string &val)
	Set the character encoding as specified by the current document.

virtual void	skippedEntity (const string &name)
	Callback for an XML entity skipped by the parser.

virtual void	setError (const string &errmsg)
	Callback for handling an error condition during XML parsing.

const string &	getError (void) const
	Get the current error message.

Public Member Functions inherited from ghidra::ContentHandler
virtual	~ContentHandler (void)
	Destructor.

Private Attributes
Element *	root
	The root XML element being processed by this handler.

Element *	cur
	The current XML element being processed by this handler.

string	error
	The last error condition returned by the parser (if not empty)

Detailed Description

A SAX interface implementation for constructing an in-memory DOM model.

This implementation builds a DOM model of the XML stream being parsed, creating an Element object for each XML element tag in the stream. This handler is initialized with a root Element object, which after parsing is complete will own all parsed elements.

Member Function Documentation

◆ characters()

void ghidra::TreeHandler::characters	(	const char *	text,
		int4	start,
		int4	length
	)

virtual

Callback with raw characters to be inserted in the current XML element.

Parameters

text	is an array of character data being inserted.
start	is the first character within the array to insert.
length	is the number of characters to insert.

Implements ghidra::ContentHandler.

References ghidra::Element::addContent(), and cur.

◆ endDocument()

virtual void ghidra::TreeHandler::endDocument ( void )

inlinevirtual

End processing for the current XML document.

Implements ghidra::ContentHandler.

◆ endElement()

void ghidra::TreeHandler::endElement	(	const string &	namespaceURI,
		const string &	localName,
		const string &	qualifiedName
	)

virtual

Callback indicating parsing of the current XML element is finished.

Parameters

namespaceURI	is the namespace to which the element belongs
localName	is the local name of the new element
qualifiedName	is the fully qualified name of the element.

Implements ghidra::ContentHandler.

References cur, and ghidra::Element::getParent().

◆ endPrefixMapping()

virtual void ghidra::TreeHandler::endPrefixMapping ( const string & prefix )

inlinevirtual

Finish the current prefix.

Implements ghidra::ContentHandler.

◆ ignorableWhitespace()

virtual void ghidra::TreeHandler::ignorableWhitespace	(	const char *	text,
		int4	start,
		int4	length
	)

inlinevirtual

Callback with whitespace character data for the current XML element.

Parameters

text	is an array of character data that can be inserted.
start	is the first character within the array to insert.
length	is the number of characters to insert.

Implements ghidra::ContentHandler.

◆ processingInstruction()

virtual void ghidra::TreeHandler::processingInstruction	(	const string &	target,
		const string &	data
	)

inlinevirtual

Callback for a formal processing instruction seen in the current document.

Parameters

target	is the target instruction to process
data	is (optional) character data for the instruction

Implements ghidra::ContentHandler.

◆ setDocumentLocator()

virtual void ghidra::TreeHandler::setDocumentLocator ( Locator locator )

inlinevirtual

Set the Locator object for documents.

Implements ghidra::ContentHandler.

◆ setEncoding()

virtual void ghidra::TreeHandler::setEncoding ( const string & encoding )

inlinevirtual

Set the character encoding as specified by the current document.

Parameters

encoding is the parsed encoding string

Implements ghidra::ContentHandler.

◆ setError()

virtual void ghidra::TreeHandler::setError ( const string & errmsg )

inlinevirtual

Callback for handling an error condition during XML parsing.

Parameters

errmsg is a message describing the error condition

Implements ghidra::ContentHandler.

References error.

◆ setVersion()

virtual void ghidra::TreeHandler::setVersion ( const string & version )

inlinevirtual

Set the XML version as specified by the current document.

Parameters

version is the parsed version string

Implements ghidra::ContentHandler.

◆ skippedEntity()

virtual void ghidra::TreeHandler::skippedEntity ( const string & name )

inlinevirtual

Callback for an XML entity skipped by the parser.

Parameters

name	is the name of the entity being skipped

Implements ghidra::ContentHandler.

◆ startDocument()

virtual void ghidra::TreeHandler::startDocument ( void )

inlinevirtual

Start processing a new XML document.

Implements ghidra::ContentHandler.

◆ startElement()

void ghidra::TreeHandler::startElement	(	const string &	namespaceURI,
		const string &	localName,
		const string &	qualifiedName,
		const Attributes &	atts
	)

virtual

Callback indicating a new XML element has started.

Parameters

namespaceURI	is the namespace to which the new element belongs
localName	is the local name of the new element
qualifiedName	is the fully qualified name of the new element
atts	is the set of (previously parsed) attributes to attach to the new element

Implements ghidra::ContentHandler.

References ghidra::Element::addAttribute(), ghidra::Element::addChild(), cur, ghidra::Attributes::getLength(), ghidra::Attributes::getLocalName(), ghidra::Attributes::getValue(), and ghidra::Element::setName().

◆ startPrefixMapping()

virtual void ghidra::TreeHandler::startPrefixMapping	(	const string &	prefix,
		const string &	uri
	)

inlinevirtual

Start a new prefix to namespace URI mapping.

Implements ghidra::ContentHandler.

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

/builds/appsec/reveng-binrw/ghidraplusplus/src/core/xml.hh
/builds/appsec/reveng-binrw/ghidraplusplus/src/core/xml.cc

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ characters()

◆ endDocument()

◆ endElement()

◆ endPrefixMapping()

◆ ignorableWhitespace()

◆ processingInstruction()

◆ setDocumentLocator()

◆ setEncoding()

◆ setError()

◆ setVersion()

◆ skippedEntity()

◆ startDocument()

◆ startElement()

◆ startPrefixMapping()