Parse XML to handle element tags and attributes. More...

#include <vtkXMLParser.h>

Inheritance diagram for vtkXMLParser:

Collaboration diagram for vtkXMLParser:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkXMLParser *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual int	Parse ()
	Parse the XML input.


virtual void	SetStream (istream *)
	Get/Set the input stream.

virtual istream *	GetStream ()
	Get/Set the input stream.


vtkTypeInt64	TellG ()
	Used by subclasses and their supporting classes.

void	SeekG (vtkTypeInt64 position)
	Used by subclasses and their supporting classes.


virtual int	Parse (const char *inputString)
	Parse the XML message.

virtual int	Parse (const char *inputString, unsigned int length)
	Parse the XML message.


virtual int	InitializeParser ()
	When parsing fragments of XML, or when streaming XML, use the following three methods:

virtual int	ParseChunk (const char *inputString, unsigned int length)
	When parsing fragments of XML, or when streaming XML, use the following three methods:

virtual int	CleanupParser ()
	When parsing fragments of XML, or when streaming XML, use the following three methods:


	vtkSetFilePathMacro (FileName)
	Set and get file name.

	vtkGetFilePathMacro (FileName)
	Set and get file name.


virtual void	SetIgnoreCharacterData (vtkTypeBool)
	If this is off (the default), CharacterDataHandler will be called to process text within XML Elements.

virtual vtkTypeBool	GetIgnoreCharacterData ()
	If this is off (the default), CharacterDataHandler will be called to process text within XML Elements.


virtual void	SetEncoding (const char *)
	Set and get the encoding the parser should expect (nullptr defaults to Expat's own default encoder, i.e UTF-8).

virtual char *	GetEncoding ()
	Set and get the encoding the parser should expect (nullptr defaults to Expat's own default encoder, i.e UTF-8).

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkXMLParser *	SafeDownCast (vtkObjectBase *o)

static vtkXMLParser *	New ()

static bool	hasLargeOffsets ()
	The Expat library can only handle binary files > 2Gb if either size_of(long) == 8 or the "large size" feature is present.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXMLParser ()

	~vtkXMLParser () override

virtual int	CreateParser ()

virtual int	ParseXML ()

virtual int	ParsingComplete ()

virtual void	StartElement (const char name, const char *atts)

virtual void	EndElement (const char *name)

virtual void	CharacterDataHandler (const char *data, int length)

virtual void	ReportStrayAttribute (const char element, const char attr, const char *value)

virtual void	ReportMissingAttribute (const char element, const char attr)

virtual void	ReportBadAttribute (const char element, const char attr, const char *value)

virtual void	ReportUnknownElement (const char *element)

virtual void	ReportXmlParseError ()

vtkTypeInt64	GetXMLByteIndex ()

virtual int	ParseBuffer (const char *buffer, unsigned int count)

int	ParseBuffer (const char *buffer)

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static int	IsSpace (char c)

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
istream *	Stream

char *	FileName

char *	Encoding

int	ParseError

const char *	InputString

int	InputStringLength

void *	Parser

vtkTypeBool	IgnoreCharacterData

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
void	vtkXMLParserStartElement (void , const char , const char **)

void	vtkXMLParserEndElement (void , const char )

void	vtkXMLParserCharacterDataHandler (void , const char , int)

Detailed Description

Parse XML to handle element tags and attributes.

vtkXMLParser reads a stream and parses XML element tags and corresponding attributes. Each element begin tag and its attributes are sent to the StartElement method. Each element end tag is sent to the EndElement method. Subclasses should replace these methods to actually use the tags.

Tests:: vtkXMLParser (Tests)

Definition at line 28 of file vtkXMLParser.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkXMLParser::Superclass

Definition at line 31 of file vtkXMLParser.h.

Constructor & Destructor Documentation

◆ vtkXMLParser()

vtkXMLParser::vtkXMLParser ( )

protected

◆ ~vtkXMLParser()

vtkXMLParser::~vtkXMLParser ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkXMLParser::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkXMLParser::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

Reimplemented in vtkBlueObeliskDataParser, vtkExodusIIReaderParser, vtkLSDynaSummaryParser, vtkXMLFileReadTester, and vtkXMLDataParser.

◆ SafeDownCast()

static vtkXMLParser * vtkXMLParser::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXMLParser::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkBlueObeliskDataParser, vtkExodusIIReaderParser, vtkLSDynaSummaryParser, vtkXMLFileReadTester, and vtkXMLDataParser.

◆ NewInstance()

vtkXMLParser * vtkXMLParser::NewInstance ( ) const

◆ PrintSelf()

void vtkXMLParser::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ New()

static vtkXMLParser * vtkXMLParser::New ( )

static

◆ SetStream()

virtual void vtkXMLParser::SetStream ( istream * )

virtual

Get/Set the input stream.

◆ GetStream()

virtual istream * vtkXMLParser::GetStream ( )

virtual

Get/Set the input stream.

◆ TellG()

vtkTypeInt64 vtkXMLParser::TellG ( )

Used by subclasses and their supporting classes.

These methods wrap around the tellg and seekg methods of the input stream to work-around stream bugs on various platforms.

◆ SeekG()

void vtkXMLParser::SeekG ( vtkTypeInt64 position )

Used by subclasses and their supporting classes.

These methods wrap around the tellg and seekg methods of the input stream to work-around stream bugs on various platforms.

◆ Parse() [1/3]

virtual int vtkXMLParser::Parse ( )

virtual

Parse the XML input.

Reimplemented in vtkBlueObeliskDataParser, and vtkXMLDataParser.

◆ Parse() [2/3]

virtual int vtkXMLParser::Parse ( const char * inputString )

virtual

Parse the XML message.

If length is specified, parse only the first "length" characters

Reimplemented in vtkBlueObeliskDataParser, and vtkXMLDataParser.

◆ Parse() [3/3]

virtual int vtkXMLParser::Parse	(	const char *	inputString,
		unsigned int	length
	)

virtual

Parse the XML message.

If length is specified, parse only the first "length" characters

Reimplemented in vtkBlueObeliskDataParser, and vtkXMLDataParser.

◆ InitializeParser()

virtual int vtkXMLParser::InitializeParser ( )

virtual

When parsing fragments of XML, or when streaming XML, use the following three methods:

InitializeParser() initializes the parser but does not perform any actual parsing.
ParseChunk() parses a fragment of XML; this has to match to what was already parsed.
CleanupParser() finishes parsing; if there were errors, it will report them.

◆ ParseChunk()

virtual int vtkXMLParser::ParseChunk	(	const char *	inputString,
		unsigned int	length
	)

virtual

When parsing fragments of XML, or when streaming XML, use the following three methods:

InitializeParser() initializes the parser but does not perform any actual parsing.
ParseChunk() parses a fragment of XML; this has to match to what was already parsed.
CleanupParser() finishes parsing; if there were errors, it will report them.

◆ CleanupParser()

virtual int vtkXMLParser::CleanupParser ( )

virtual

When parsing fragments of XML, or when streaming XML, use the following three methods:

InitializeParser() initializes the parser but does not perform any actual parsing.
ParseChunk() parses a fragment of XML; this has to match to what was already parsed.
CleanupParser() finishes parsing; if there were errors, it will report them.

◆ vtkSetFilePathMacro()

vtkXMLParser::vtkSetFilePathMacro ( FileName )

Set and get file name.

◆ vtkGetFilePathMacro()

vtkXMLParser::vtkGetFilePathMacro ( FileName )

Set and get file name.

◆ SetIgnoreCharacterData()

virtual void vtkXMLParser::SetIgnoreCharacterData ( vtkTypeBool )

virtual

If this is off (the default), CharacterDataHandler will be called to process text within XML Elements.

If this is on, the text will be ignored.

◆ GetIgnoreCharacterData()

virtual vtkTypeBool vtkXMLParser::GetIgnoreCharacterData ( )

virtual

If this is off (the default), CharacterDataHandler will be called to process text within XML Elements.

If this is on, the text will be ignored.

◆ SetEncoding()

virtual void vtkXMLParser::SetEncoding ( const char * )

virtual

Set and get the encoding the parser should expect (nullptr defaults to Expat's own default encoder, i.e UTF-8).

This should be set before parsing (i.e. a call to Parse()) or even initializing the parser (i.e. a call to InitializeParser())

◆ GetEncoding()

virtual char * vtkXMLParser::GetEncoding ( )

virtual

Set and get the encoding the parser should expect (nullptr defaults to Expat's own default encoder, i.e UTF-8).

This should be set before parsing (i.e. a call to Parse()) or even initializing the parser (i.e. a call to InitializeParser())

◆ hasLargeOffsets()

static bool vtkXMLParser::hasLargeOffsets ( )

static

The Expat library can only handle binary files > 2Gb if either size_of(long) == 8 or the "large size" feature is present.

◆ CreateParser()

virtual int vtkXMLParser::CreateParser ( )

protectedvirtual

◆ ParseXML()

virtual int vtkXMLParser::ParseXML ( )

protectedvirtual

◆ ParsingComplete()

virtual int vtkXMLParser::ParsingComplete ( )

protectedvirtual

Reimplemented in vtkXMLFileReadTester, and vtkXMLDataParser.

◆ StartElement()

virtual void vtkXMLParser::StartElement	(	const char *	name,
		const char **	atts
	)

protectedvirtual

Reimplemented in vtkBlueObeliskDataParser, vtkLSDynaSummaryParser, vtkXMLFileReadTester, vtkXMLDataParser, and vtkExodusIIReaderParser.

◆ EndElement()

virtual void vtkXMLParser::EndElement ( const char * name )

protectedvirtual

Reimplemented in vtkXMLDataParser, vtkBlueObeliskDataParser, vtkLSDynaSummaryParser, and vtkExodusIIReaderParser.

◆ CharacterDataHandler()

virtual void vtkXMLParser::CharacterDataHandler	(	const char *	data,
		int	length
	)

protectedvirtual

Reimplemented in vtkBlueObeliskDataParser, vtkLSDynaSummaryParser, and vtkXMLDataParser.

◆ ReportStrayAttribute()

virtual void vtkXMLParser::ReportStrayAttribute	(	const char *	element,
		const char *	attr,
		const char *	value
	)

protectedvirtual

Reimplemented in vtkXMLFileReadTester.

◆ ReportMissingAttribute()

virtual void vtkXMLParser::ReportMissingAttribute	(	const char *	element,
		const char *	attr
	)

protectedvirtual

Reimplemented in vtkXMLFileReadTester.

◆ ReportBadAttribute()

virtual void vtkXMLParser::ReportBadAttribute	(	const char *	element,
		const char *	attr,
		const char *	value
	)

protectedvirtual

Reimplemented in vtkXMLFileReadTester.

◆ ReportUnknownElement()

virtual void vtkXMLParser::ReportUnknownElement ( const char * element )

protectedvirtual

Reimplemented in vtkXMLFileReadTester.

◆ ReportXmlParseError()

virtual void vtkXMLParser::ReportXmlParseError ( )

protectedvirtual

Reimplemented in vtkXMLFileReadTester.

◆ GetXMLByteIndex()

vtkTypeInt64 vtkXMLParser::GetXMLByteIndex ( )

protected

◆ ParseBuffer() [1/2]

virtual int vtkXMLParser::ParseBuffer	(	const char *	buffer,
		unsigned int	count
	)

protectedvirtual

Reimplemented in vtkXMLDataParser.

◆ ParseBuffer() [2/2]

int vtkXMLParser::ParseBuffer ( const char * buffer )

protected

◆ IsSpace()

static int vtkXMLParser::IsSpace ( char c )

staticprotected

Friends And Related Symbol Documentation

◆ vtkXMLParserStartElement

void vtkXMLParserStartElement	(	void *	,
		const char *	,
		const char **
	)

friend

◆ vtkXMLParserEndElement

void vtkXMLParserEndElement	(	void *	,
		const char *
	)

friend

◆ vtkXMLParserCharacterDataHandler

void vtkXMLParserCharacterDataHandler	(	void *	parser,
		const char *	data,
		int	length
	)

friend

Definition at line 210 of file vtkXMLParser.h.

Member Data Documentation

◆ Stream

istream* vtkXMLParser::Stream

protected

Definition at line 124 of file vtkXMLParser.h.

◆ FileName

char* vtkXMLParser::FileName

protected

Definition at line 127 of file vtkXMLParser.h.

◆ Encoding

char* vtkXMLParser::Encoding

protected

Definition at line 130 of file vtkXMLParser.h.

◆ ParseError

int vtkXMLParser::ParseError

protected

Definition at line 134 of file vtkXMLParser.h.

◆ InputString

const char* vtkXMLParser::InputString

protected

Definition at line 137 of file vtkXMLParser.h.

◆ InputStringLength

int vtkXMLParser::InputStringLength

protected

Definition at line 138 of file vtkXMLParser.h.

◆ Parser

void* vtkXMLParser::Parser

protected

Definition at line 141 of file vtkXMLParser.h.

◆ IgnoreCharacterData

vtkTypeBool vtkXMLParser::IgnoreCharacterData

protected

Definition at line 202 of file vtkXMLParser.h.

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

IO/XMLParser/vtkXMLParser.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkXMLParser()

◆ ~vtkXMLParser()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetStream()

◆ GetStream()

◆ TellG()

◆ SeekG()

◆ Parse() [1/3]

◆ Parse() [2/3]

◆ Parse() [3/3]

◆ InitializeParser()

◆ ParseChunk()

◆ CleanupParser()

◆ vtkSetFilePathMacro()

◆ vtkGetFilePathMacro()

◆ SetIgnoreCharacterData()

◆ GetIgnoreCharacterData()

◆ SetEncoding()

◆ GetEncoding()

◆ hasLargeOffsets()

◆ CreateParser()

◆ ParseXML()

◆ ParsingComplete()

◆ StartElement()

◆ EndElement()

◆ CharacterDataHandler()

◆ ReportStrayAttribute()

◆ ReportMissingAttribute()

◆ ReportBadAttribute()

◆ ReportUnknownElement()

◆ ReportXmlParseError()

◆ GetXMLByteIndex()

◆ ParseBuffer() [1/2]

◆ ParseBuffer() [2/2]

◆ IsSpace()

Friends And Related Symbol Documentation

◆ vtkXMLParserStartElement

◆ vtkXMLParserEndElement

◆ vtkXMLParserCharacterDataHandler

Member Data Documentation

◆ Stream

◆ FileName

◆ Encoding

◆ ParseError

◆ InputString

◆ InputStringLength

◆ Parser

◆ IgnoreCharacterData