TSAXParser is a subclass of TXMLParser, it is a wraper class to libxml library.

SAX (Simple API for XML) is an event based interface, which doesn't maintain the DOM tree in memory, in other words, it's much more efficient for large document. TSAXParserCallback contains a number of callback routines to the parser in a xmlSAXHandler structure. The parser will then parse the document and call the appropriate callback when certain conditions occur.

Definition at line 23 of file TSAXParser.h.

Public Member Functions
	TSAXParser ()
	Create SAX parser.

	~TSAXParser () override
	TSAXParser desctructor.

virtual void	ConnectToHandler (const char handlerName, void handler)
	A default TSAXParser to a user-defined Handler connection function.

TClass *	IsA () const override

virtual void	OnCdataBlock (const char *text, Int_t len)
	Emit a signal for OnCdataBlock.

virtual void	OnCharacters (const char *characters)
	Emit a signal for OnCharacters, where characters are the characters outside of tags.

virtual void	OnComment (const char *text)
	Emit a signal for OnComment, where text is the comment.

virtual void	OnEndDocument ()
	Emit a signal for OnEndDocument.

virtual void	OnEndElement (const char *name)
	Emit a signal for OnEndElement, where name is the Element's name.

virtual Int_t	OnError (const char *text)
	Emit a signal for OnError, where text is the error and it returns the Parse Error Code, see TXMLParser.

virtual Int_t	OnFatalError (const char *text)
	Emit a signal for OnFactalError, where text is the error and it returns the Parse Error Code, see TXMLParser.

virtual void	OnStartDocument ()
	Emit a signal for OnStartDocument.

virtual void	OnStartElement (const char name, const TList attr)
	Emit a signal for OnStarElement, where name is the Element's name and attribute is a TList of (TObjString, TObjString ) TPair's.

virtual void	OnWarning (const char *text)
	Emit a signal for OnWarning, where text is the warning.

Int_t	ParseBuffer (const char *contents, Int_t len) override
	It parse the contents, instead of a file.

Int_t	ParseFile (const char *filename) override
	It creates the parse context of the xml file, where the xml file name is filename.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TXMLParser
	TXMLParser ()
	Initializes parser variables.

	~TXMLParser () override
	Cleanup.

Int_t	GetParseCode () const

const char *	GetParseCodeMessage (Int_t parseCode) const
	Returns the parse code message.

Bool_t	GetReplaceEntities () const

Bool_t	GetStopOnError () const

Bool_t	GetValidate () const

const char *	GetValidateError () const

const char *	GetValidateWarning () const

TClass *	IsA () const override

void	SetReplaceEntities (Bool_t val=kTRUE)
	The parser will replace/expand entities.

void	SetStopOnError (Bool_t stop=kTRUE)
	Set parser stops in case of error:

void	SetValidate (Bool_t val=kTRUE)
	The parser will validate the xml file if val = true.

virtual void	StopParser ()
	Stops parsing.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Public Member Functions inherited from TQObject
	TQObject ()
	TQObject Constructor.

virtual	~TQObject ()
	TQObject Destructor.

Bool_t	AreSignalsBlocked () const

Bool_t	BlockSignals (Bool_t b)

virtual void	ChangedBy (const char *method)

void	CollectClassSignalLists (TList &list, TClass *cls)
	Collect class signal lists from class cls and all its base-classes.

Bool_t	Connect (const char signal, const char receiver_class, void receiver, const char slot)
	Non-static method is used to connect from the signal of this object to the receiver slot.

virtual void	Connected (const char *)

virtual void	Destroyed ()

Bool_t	Disconnect (const char signal=nullptr, void receiver=nullptr, const char *slot=nullptr)
	Disconnects signal of this object from slot of receiver.

virtual void	Disconnected (const char *)

void	Emit (const char *signal)
	Activate signal without args.

template<typename T >
void	Emit (const char *signal, const T &arg)
	Activate signal with single parameter.

template<typename... T>
void	EmitVA (const char *signal_name, Int_t, const T &... params)
	Emit a signal with a varying number of arguments.

TList *	GetListOfClassSignals () const
	Returns pointer to list of signals of this class.

TList *	GetListOfConnections () const

TList *	GetListOfSignals () const

virtual Bool_t	HasConnection (const char *signal_name) const
	Return true if there is any object connected to this signal.

virtual void	HighPriority (const char signal_name, const char slot_name=nullptr)

virtual void	LowPriority (const char signal_name, const char slot_name=nullptr)

virtual void	Message (const char *msg)

virtual Int_t	NumberOfConnections () const
	Return number of connections for this object.

virtual Int_t	NumberOfSignals () const
	Return number of signals for this object.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TXMLParser
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Static Public Member Functions inherited from TQObject
static Bool_t	AreAllSignalsBlocked ()
	Returns true if all signals are blocked.

static Bool_t	BlockAllSignals (Bool_t b)
	Block or unblock all signals. Returns the previous block status.

static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static Bool_t	Connect (const char sender_class, const char signal, const char receiver_class, void receiver, const char *slot)
	This method allows to make a connection from any object of the same class to a single slot.

static Bool_t	Connect (TQObject sender, const char signal, const char receiver_class, void receiver, const char *slot)
	Create connection between sender and receiver.

static const char *	DeclFileName ()

static Bool_t	Disconnect (const char class_name, const char signal, void receiver=nullptr, const char slot=nullptr)
	Disconnects "class signal".

static Bool_t	Disconnect (TQObject sender, const char signal=nullptr, void receiver=nullptr, const char slot=nullptr)
	Disconnects signal in object sender from slot_method in object receiver.

Private Member Functions
	TSAXParser (const TSAXParser &)=delete

TSAXParser &	operator= (const TSAXParser &)=delete

virtual Int_t	Parse ()
	This function parses the xml file, by initializing the parser and checks whether the parse context is created or not, it will check as well whether the document is well formated.

Private Attributes
_xmlSAXHandler *	fSAXHandler
	libxml2 SAX handler

Friends
class	TSAXParserCallback

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from TXMLParser
virtual void	InitializeContext ()
	Initialize parser parameters, such as, disactivate non-standards libxml1 features, on/off validation, clear error and warning messages.

virtual void	OnValidateError (const TString &message)
	This function is called when an error from the parser has occurred.

virtual void	OnValidateWarning (const TString &message)
	This function is called when a warning from the parser has occurred.

virtual void	ReleaseUnderlying ()
	To release any existing document.

virtual void	SetParseCode (Int_t code)
	Set the parse code:

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Protected Member Functions inherited from TQObject
virtual void *	GetSender ()

virtual const char *	GetSenderClassName () const

Static Protected Member Functions inherited from TQObject
static Int_t	CheckConnectArgs (TQObject sender, TClass sender_class, const char signal, TClass receiver_class, const char *slot)
	Checking of consistency of sender/receiver methods/arguments.

static TString	CompressName (const char *method_name)
	Removes "const" words and blanks from full (with prototype) method name and resolve any typedefs in the method signature.

static Bool_t	ConnectToClass (const char sender_class, const char signal, TClass receiver_class, void receiver, const char *slot)
	This method allows to make connection from any object of the same class to the receiver object.

static Bool_t	ConnectToClass (TQObject sender, const char signal, TClass receiver_class, void receiver, const char *slot)
	Create connection between sender and receiver.

Protected Attributes inherited from TXMLParser
_xmlParserCtxt *	fContext
	Parse the xml file.

Int_t	fParseCode
	To keep track of the errorcodes.

Bool_t	fReplaceEntities
	Replace entities.

Bool_t	fStopError
	Stop when parse error occurs.

Bool_t	fValidate
	To validate the parse context.

TString	fValidateError
	Parse error.

TString	fValidateWarning
	Parse warning.

Protected Attributes inherited from TQObject
TList *	fListOfConnections
	list of signals from this object

TList *	fListOfSignals

Bool_t	fSignalsBlocked
	list of connections to this object

Static Protected Attributes inherited from TQObject
static Bool_t	fgAllSignalsBlocked = kFALSE
	flag used for suppression of signals

#include <TSAXParser.h>

Inheritance diagram for TSAXParser:

[legend]

Constructor & Destructor Documentation

◆ TSAXParser() [1/2]

TSAXParser::TSAXParser ( const TSAXParser & )

privatedelete

◆ TSAXParser() [2/2]

TSAXParser::TSAXParser ( )

Create SAX parser.

Definition at line 67 of file TSAXParser.cxx.

◆ ~TSAXParser()

TSAXParser::~TSAXParser ( )

override

TSAXParser desctructor.

Definition at line 97 of file TSAXParser.cxx.

Member Function Documentation

◆ Class()

static TClass * TSAXParser::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TSAXParser::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TSAXParser::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 55 of file TSAXParser.h.

◆ ConnectToHandler()

void TSAXParser::ConnectToHandler	(	const char *	handlerName,
		void *	handler
	)

virtual

A default TSAXParser to a user-defined Handler connection function.

This function makes connection between various function from TSAXParser with the user-define SAX Handler, whose functions has to be exactly the same as in TSAXParser.

Parameters

[in]	handlerName	User-defined SAX Handler class name
[in]	handler	Pointer to the user-defined SAX Handler

See SAXHandler.C tutorial.

Definition at line 447 of file TSAXParser.cxx.

◆ DeclFileName()

static const char * TSAXParser::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 55 of file TSAXParser.h.

◆ IsA()

TClass * TSAXParser::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 55 of file TSAXParser.h.

◆ OnCdataBlock()

void TSAXParser::OnCdataBlock	(	const char *	text,
		Int_t	len
	)

virtual

Emit a signal for OnCdataBlock.

Definition at line 197 of file TSAXParser.cxx.

◆ OnCharacters()

void TSAXParser::OnCharacters ( const char * characters )

virtual

Emit a signal for OnCharacters, where characters are the characters outside of tags.

Definition at line 147 of file TSAXParser.cxx.

◆ OnComment()

void TSAXParser::OnComment ( const char * text )

virtual

Emit a signal for OnComment, where text is the comment.

Definition at line 155 of file TSAXParser.cxx.

◆ OnEndDocument()

void TSAXParser::OnEndDocument ( )

virtual

Emit a signal for OnEndDocument.

Definition at line 115 of file TSAXParser.cxx.

◆ OnEndElement()

void TSAXParser::OnEndElement ( const char * name )

virtual

Emit a signal for OnEndElement, where name is the Element's name.

Definition at line 138 of file TSAXParser.cxx.

◆ OnError()

Int_t TSAXParser::OnError ( const char * text )

virtual

Emit a signal for OnError, where text is the error and it returns the Parse Error Code, see TXMLParser.

Definition at line 172 of file TSAXParser.cxx.

◆ OnFatalError()

Int_t TSAXParser::OnFatalError ( const char * text )

virtual

Emit a signal for OnFactalError, where text is the error and it returns the Parse Error Code, see TXMLParser.

Definition at line 185 of file TSAXParser.cxx.

◆ OnStartDocument()

void TSAXParser::OnStartDocument ( )

virtual

Emit a signal for OnStartDocument.

Definition at line 107 of file TSAXParser.cxx.

◆ OnStartElement()

void TSAXParser::OnStartElement	(	const char *	name,
		const TList *	attributes
	)

virtual

Emit a signal for OnStarElement, where name is the Element's name and attribute is a TList of (TObjString*, TObjString *) TPair's.

The TPair's key is the attribute's name and value is the attribute's value.

Definition at line 126 of file TSAXParser.cxx.

◆ OnWarning()

void TSAXParser::OnWarning ( const char * text )

virtual

Emit a signal for OnWarning, where text is the warning.

Definition at line 163 of file TSAXParser.cxx.

◆ operator=()

TSAXParser & TSAXParser::operator= ( const TSAXParser & )

privatedelete

◆ Parse()

Int_t TSAXParser::Parse ( )

privatevirtual

This function parses the xml file, by initializing the parser and checks whether the parse context is created or not, it will check as well whether the document is well formated.

It returns the parse error code, see TXMLParser.

Definition at line 212 of file TSAXParser.cxx.

◆ ParseBuffer()

Int_t TSAXParser::ParseBuffer	(	const char *	contents,
		Int_t	len
	)

overridevirtual

It parse the contents, instead of a file.

It will return error if is attempted to parse a second file while a parse is in progres. It returns parse code error, see TXMLParser.

Implements TXMLParser.

Definition at line 259 of file TSAXParser.cxx.

◆ ParseFile()

Int_t TSAXParser::ParseFile ( const char * filename )

overridevirtual

It creates the parse context of the xml file, where the xml file name is filename.

If context is created sucessfully, it will call Parse() It returns parse error code, see TXMLParser.

Implements TXMLParser.

Definition at line 242 of file TSAXParser.cxx.

◆ Streamer()

void TSAXParser::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TSAXParser::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 55 of file TSAXParser.h.

Friends And Related Symbol Documentation

◆ TSAXParserCallback

friend class TSAXParserCallback

friend

Definition at line 25 of file TSAXParser.h.

Member Data Documentation

◆ fSAXHandler

_xmlSAXHandler* TSAXParser::fSAXHandler

private

libxml2 SAX handler

Definition at line 28 of file TSAXParser.h.

Libraries for TSAXParser:

[legend]

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

io/xmlparser/inc/TSAXParser.h
io/xmlparser/src/TSAXParser.cxx

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ TSAXParser() [1/2]

◆ TSAXParser() [2/2]

◆ ~TSAXParser()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ ConnectToHandler()

◆ DeclFileName()

◆ IsA()

◆ OnCdataBlock()

◆ OnCharacters()

◆ OnComment()

◆ OnEndDocument()

◆ OnEndElement()

◆ OnError()

◆ OnFatalError()

◆ OnStartDocument()

◆ OnStartElement()

◆ OnWarning()

◆ operator=()

◆ Parse()

◆ ParseBuffer()

◆ ParseFile()

◆ Streamer()

◆ StreamerNVirtual()

Friends And Related Symbol Documentation

◆ TSAXParserCallback

Member Data Documentation

◆ fSAXHandler