VTK  9.0.20201028
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
vtkXMLParser Class Reference

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

#include <vtkXMLParser.h>

Inheritance diagram for vtkXMLParser:
[legend]
Collaboration diagram for vtkXMLParser:
[legend]

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. More...
 
vtkXMLParserNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetStream (istream *)
 Get/Set the input stream. More...
 
virtual istream * GetStream ()
 
vtkTypeInt64 TellG ()
 Used by subclasses and their supporting classes. More...
 
void SeekG (vtkTypeInt64 position)
 
virtual int Parse ()
 Parse the XML input. More...
 
virtual int Parse (const char *inputString)
 Parse the XML message. More...
 
virtual int Parse (const char *inputString, unsigned int length)
 
virtual int InitializeParser ()
 When parsing fragments of XML, or when streaming XML, use the following three methods: More...
 
virtual int ParseChunk (const char *inputString, unsigned int length)
 
virtual int CleanupParser ()
 
virtual void SetFileName (const char *)
 Set and get file name. More...
 
virtual char * GetFileName ()
 
virtual void SetIgnoreCharacterData (int)
 If this is off (the default), CharacterDataHandler will be called to process text within XML Elements. More...
 
virtual int GetIgnoreCharacterData ()
 
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). More...
 
virtual char * GetEncoding ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLParserSafeDownCast (vtkObjectBase *o)
 
static vtkXMLParserNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 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
 
int IgnoreCharacterData
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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.

Definition at line 39 of file vtkXMLParser.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 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, vtkXMLDataParser, vtkExodusIIReaderParser, vtkLSDynaSummaryParser, and vtkXMLFileReadTester.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkXMLParser::NewInstanceInternal ( ) const
protectedvirtual

◆ 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

◆ 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)

◆ Parse() [1/3]

virtual int vtkXMLParser::Parse ( )
virtual

Parse the XML input.

Reimplemented in vtkXMLDataParser, and vtkBlueObeliskDataParser.

◆ 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 vtkXMLDataParser, and vtkBlueObeliskDataParser.

◆ Parse() [3/3]

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

◆ 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

◆ CleanupParser()

virtual int vtkXMLParser::CleanupParser ( )
virtual

◆ SetFileName()

virtual void vtkXMLParser::SetFileName ( const char *  )
virtual

Set and get file name.

◆ GetFileName()

virtual char* vtkXMLParser::GetFileName ( )
virtual

◆ SetIgnoreCharacterData()

virtual void vtkXMLParser::SetIgnoreCharacterData ( int  )
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 int vtkXMLParser::GetIgnoreCharacterData ( )
virtual

◆ 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

◆ CreateParser()

virtual int vtkXMLParser::CreateParser ( )
protectedvirtual

◆ ParseXML()

virtual int vtkXMLParser::ParseXML ( )
protectedvirtual

◆ ParsingComplete()

virtual int vtkXMLParser::ParsingComplete ( )
protectedvirtual

Reimplemented in vtkXMLDataParser, and vtkXMLFileReadTester.

◆ StartElement()

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

◆ EndElement()

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

◆ CharacterDataHandler()

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

◆ 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 Function 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 215 of file vtkXMLParser.h.

Member Data Documentation

◆ Stream

istream* vtkXMLParser::Stream
protected

Definition at line 129 of file vtkXMLParser.h.

◆ FileName

char* vtkXMLParser::FileName
protected

Definition at line 132 of file vtkXMLParser.h.

◆ Encoding

char* vtkXMLParser::Encoding
protected

Definition at line 135 of file vtkXMLParser.h.

◆ ParseError

int vtkXMLParser::ParseError
protected

Definition at line 139 of file vtkXMLParser.h.

◆ InputString

const char* vtkXMLParser::InputString
protected

Definition at line 142 of file vtkXMLParser.h.

◆ InputStringLength

int vtkXMLParser::InputStringLength
protected

Definition at line 143 of file vtkXMLParser.h.

◆ Parser

void* vtkXMLParser::Parser
protected

Definition at line 146 of file vtkXMLParser.h.

◆ IgnoreCharacterData

int vtkXMLParser::IgnoreCharacterData
protected

Definition at line 207 of file vtkXMLParser.h.


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