Logo ROOT   6.19/01
Reference Guide
TXMLParser Class Referenceabstract


TXMLParser is an abstract class which interfaces with Libxml2.

Libxml2 is the XML C parser and toolkit developed for the Gnome project. The libxml library provides two interfaces to the parser, a DOM style tree interface and a SAX style event based interface. TXMLParser is parent class of TSAXParser and TDOMParser, which are a SAX interface and DOM interface of libxml.

Definition at line 24 of file TXMLParser.h.

Public Member Functions

 TXMLParser ()
 Initializes parser variables. More...
 
virtual ~TXMLParser ()
 Cleanup. More...
 
Int_t GetParseCode () const
 
const char * GetParseCodeMessage (Int_t parseCode) const
 Returns the parse code message. More...
 
Bool_t GetReplaceEntities () const
 
Bool_t GetStopOnError () const
 
Bool_t GetValidate () const
 
const char * GetValidateError () const
 
const char * GetValidateWarning () const
 
virtual Int_t ParseBuffer (const char *contents, Int_t len)=0
 
virtual Int_t ParseFile (const char *filename)=0
 
void SetReplaceEntities (Bool_t val=kTRUE)
 The parser will replace/expand entities. More...
 
void SetStopOnError (Bool_t stop=kTRUE)
 Set parser stops in case of error: More...
 
void SetValidate (Bool_t val=kTRUE)
 The parser will validate the xml file if val = true. More...
 
virtual void StopParser ()
 Stops parsing. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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. More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
- Public Member Functions inherited from TQObject
 TQObject ()
 TQObject Constructor. More...
 
virtual ~TQObject ()
 TQObject Destructor. More...
 
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. More...
 
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. More...
 
virtual void Connected (const char *)
 
virtual void Destroyed ()
 
Bool_t Disconnect (const char *signal=0, void *receiver=0, const char *slot=0)
 Disconnects signal of this object from slot of receiver. More...
 
virtual void Disconnected (const char *)
 
template<typename T >
void Emit (const char *signal, const T &arg)
 Activate signal with single parameter. More...
 
void Emit (const char *signal)
 Acitvate signal without args. More...
 
template<typename... T>
void EmitVA (const char *signal_name, Int_t, const T &... params)
 Emit a signal with a varying number of arguments. More...
 
TListGetListOfClassSignals () const
 Returns pointer to list of signals of this class. More...
 
TListGetListOfConnections () const
 
TListGetListOfSignals () const
 
virtual Bool_t HasConnection (const char *signal_name) const
 Return true if there is any object connected to this signal. More...
 
virtual void HighPriority (const char *signal_name, const char *slot_name=0)
 
virtual void LowPriority (const char *signal_name, const char *slot_name=0)
 
virtual void Message (const char *msg)
 
virtual Int_t NumberOfConnections () const
 Return number of connections for this object. More...
 
virtual Int_t NumberOfSignals () const
 Return number of signals for this object. More...
 

Protected Member Functions

virtual void InitializeContext ()
 Initialize parser parameters, such as, disactivate non-standards libxml1 features, on/off validation, clear error and warning messages. More...
 
virtual void OnValidateError (const TString &message)
 This function is called when an error from the parser has occured. More...
 
virtual void OnValidateWarning (const TString &message)
 This function is called when a warning from the parser has occured. More...
 
virtual void ReleaseUnderlying ()
 To release any existing document. More...
 
virtual void SetParseCode (Int_t code)
 Set the parse code: More...
 
- 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). More...
 
void MakeZombie ()
 
- Protected Member Functions inherited from TQObject
virtual voidGetSender ()
 
virtual const char * GetSenderClassName () const
 

Protected Attributes

_xmlParserCtxt * fContext
 Parse the xml file. More...
 
Int_t fParseCode
 To keep track of the errorcodes. More...
 
Bool_t fReplaceEntities
 Replace entities. More...
 
Bool_t fStopError
 Stop when parse error occurs. More...
 
Bool_t fValidate
 To validate the parse context. More...
 
TString fValidateError
 Parse error. More...
 
TString fValidateWarning
 Parse warning. More...
 
- Protected Attributes inherited from TQObject
TListfListOfConnections
 list of signals from this object More...
 
TListfListOfSignals
 
Bool_t fSignalsBlocked
 list of connections to this object More...
 

Private Member Functions

 TXMLParser (const TXMLParser &)
 
TXMLParseroperator= (const TXMLParser &)
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Static Public Member Functions inherited from TQObject
static Bool_t AreAllSignalsBlocked ()
 Returns true if all signals are blocked. More...
 
static Bool_t BlockAllSignals (Bool_t b)
 Block or unblock all signals. Returns the previous block status. More...
 
static Bool_t Connect (TQObject *sender, const char *signal, const char *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver. More...
 
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. More...
 
static Bool_t Disconnect (TQObject *sender, const char *signal=0, void *receiver=0, const char *slot=0)
 Disconnects signal in object sender from slot_method in object receiver. More...
 
static Bool_t Disconnect (const char *class_name, const char *signal, void *receiver=0, const char *slot=0)
 Disconnects "class signal". More...
 
- 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 consitency of sender/receiver methods/arguments. More...
 
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. More...
 
static Bool_t ConnectToClass (TQObject *sender, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver. More...
 
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. More...
 
- Static Protected Attributes inherited from TQObject
static Bool_t fgAllSignalsBlocked = kFALSE
 flag used for suppression of signals More...
 

#include <TXMLParser.h>

Inheritance diagram for TXMLParser:
[legend]

Constructor & Destructor Documentation

◆ TXMLParser() [1/2]

TXMLParser::TXMLParser ( const TXMLParser )
private

◆ TXMLParser() [2/2]

TXMLParser::TXMLParser ( )

Initializes parser variables.

Definition at line 60 of file TXMLParser.cxx.

◆ ~TXMLParser()

TXMLParser::~TXMLParser ( )
virtual

Cleanup.

Definition at line 68 of file TXMLParser.cxx.

Member Function Documentation

◆ GetParseCode()

Int_t TXMLParser::GetParseCode ( ) const
inline

Definition at line 59 of file TXMLParser.h.

◆ GetParseCodeMessage()

const char * TXMLParser::GetParseCodeMessage ( Int_t  parseCode) const

Returns the parse code message.

Definition at line 123 of file TXMLParser.cxx.

◆ GetReplaceEntities()

Bool_t TXMLParser::GetReplaceEntities ( ) const
inline

Definition at line 53 of file TXMLParser.h.

◆ GetStopOnError()

Bool_t TXMLParser::GetStopOnError ( ) const
inline

Definition at line 64 of file TXMLParser.h.

◆ GetValidate()

Bool_t TXMLParser::GetValidate ( ) const
inline

Definition at line 50 of file TXMLParser.h.

◆ GetValidateError()

const char* TXMLParser::GetValidateError ( ) const
inline

Definition at line 66 of file TXMLParser.h.

◆ GetValidateWarning()

const char* TXMLParser::GetValidateWarning ( ) const
inline

Definition at line 67 of file TXMLParser.h.

◆ InitializeContext()

void TXMLParser::InitializeContext ( )
protectedvirtual

Initialize parser parameters, such as, disactivate non-standards libxml1 features, on/off validation, clear error and warning messages.

Definition at line 153 of file TXMLParser.cxx.

◆ OnValidateError()

void TXMLParser::OnValidateError ( const TString message)
protectedvirtual

This function is called when an error from the parser has occured.

Message is the parse error.

Definition at line 106 of file TXMLParser.cxx.

◆ OnValidateWarning()

void TXMLParser::OnValidateWarning ( const TString message)
protectedvirtual

This function is called when a warning from the parser has occured.

Message is the parse error.

Definition at line 115 of file TXMLParser.cxx.

◆ operator=()

TXMLParser& TXMLParser::operator= ( const TXMLParser )
private

◆ ParseBuffer()

virtual Int_t TXMLParser::ParseBuffer ( const char *  contents,
Int_t  len 
)
pure virtual

Implemented in TSAXParser, and TDOMParser.

◆ ParseFile()

virtual Int_t TXMLParser::ParseFile ( const char *  filename)
pure virtual

Implemented in TSAXParser, and TDOMParser.

◆ ReleaseUnderlying()

void TXMLParser::ReleaseUnderlying ( )
protectedvirtual

To release any existing document.

Reimplemented in TDOMParser.

Definition at line 93 of file TXMLParser.cxx.

◆ SetParseCode()

void TXMLParser::SetParseCode ( Int_t  errorcode)
protectedvirtual

Set the parse code:

  • 0: Parse successful
  • -1: Attempt to parse a second file while a parse is in progress
  • -2: Parse context is not created
  • -3: An error occured while parsing file
  • -4: A fatal error occured while parsing file
  • -5: Document is not well-formed

Definition at line 182 of file TXMLParser.cxx.

◆ SetReplaceEntities()

void TXMLParser::SetReplaceEntities ( Bool_t  val = kTRUE)

The parser will replace/expand entities.

Definition at line 85 of file TXMLParser.cxx.

◆ SetStopOnError()

void TXMLParser::SetStopOnError ( Bool_t  stop = kTRUE)

Set parser stops in case of error:

  • stop = true, stops on error
  • stop = false, continue parsing on error...

Definition at line 192 of file TXMLParser.cxx.

◆ SetValidate()

void TXMLParser::SetValidate ( Bool_t  val = kTRUE)

The parser will validate the xml file if val = true.

Definition at line 77 of file TXMLParser.cxx.

◆ StopParser()

void TXMLParser::StopParser ( )
virtual

Stops parsing.

Definition at line 167 of file TXMLParser.cxx.

Member Data Documentation

◆ fContext

_xmlParserCtxt* TXMLParser::fContext
protected

Parse the xml file.

Definition at line 31 of file TXMLParser.h.

◆ fParseCode

Int_t TXMLParser::fParseCode
protected

To keep track of the errorcodes.

Definition at line 37 of file TXMLParser.h.

◆ fReplaceEntities

Bool_t TXMLParser::fReplaceEntities
protected

Replace entities.

Definition at line 33 of file TXMLParser.h.

◆ fStopError

Bool_t TXMLParser::fStopError
protected

Stop when parse error occurs.

Definition at line 34 of file TXMLParser.h.

◆ fValidate

Bool_t TXMLParser::fValidate
protected

To validate the parse context.

Definition at line 32 of file TXMLParser.h.

◆ fValidateError

TString TXMLParser::fValidateError
protected

Parse error.

Definition at line 35 of file TXMLParser.h.

◆ fValidateWarning

TString TXMLParser::fValidateWarning
protected

Parse warning.

Definition at line 36 of file TXMLParser.h.

Libraries for TXMLParser:
[legend]

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