![]() |
ROOT 6.10/09 Reference Guide |
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. More... | |
virtual | ~TSAXParser () |
TSAXParser desctructor. More... | |
virtual void | ConnectToHandler (const char *handlerName, void *handler) |
A default TSAXParser to a user-defined Handler connection function. More... | |
virtual void | OnCdataBlock (const char *text, Int_t len) |
Emit a signal for OnCdataBlock. More... | |
virtual void | OnCharacters (const char *characters) |
Emit a signal for OnCharacters, where characters are the characters outside of tags. More... | |
virtual void | OnComment (const char *text) |
Emit a signal for OnComment, where text is the comment. More... | |
virtual void | OnEndDocument () |
Emit a signal for OnEndDocument. More... | |
virtual void | OnEndElement (const char *name) |
Emit a signal for OnEndElement, where name is the Element's name. More... | |
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. More... | |
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. More... | |
virtual void | OnStartDocument () |
Emit a signal for OnStartDocument. More... | |
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. More... | |
virtual void | OnWarning (const char *text) |
Emit a signal for OnWarning, where text is the warning. More... | |
virtual Int_t | ParseBuffer (const char *contents, Int_t len) |
It parse the contents, instead of a file. More... | |
virtual Int_t | ParseFile (const char *filename) |
It creates the parse context of the xml file, where the xml file name is filename. More... | |
![]() | |
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 |
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... | |
![]() | |
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... | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. More... | |
virtual void | Clear (Option_t *="") |
virtual TObject * | Clone (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 TObject * | DrawClone (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 TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. More... | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. More... | |
virtual Option_t * | GetDrawOption () 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_t * | GetOption () 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... | |
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... | |
Bool_t | IsOnHeap () const |
virtual Bool_t | IsSortable () const |
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... | |
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. 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... | |
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... | |
![]() | |
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... | |
TList * | GetListOfClassSignals () const |
Returns pointer to list of signals of this class. More... | |
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. 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... | |
Private Member Functions | |
TSAXParser (const TSAXParser &) | |
TSAXParser & | operator= (const TSAXParser &) |
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. More... | |
Private Attributes | |
_xmlSAXHandler * | fSAXHandler |
libxml2 SAX handler More... | |
Friends | |
class | TSAXParserCallback |
Additional Inherited Members | |
![]() | |
enum | { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) } |
enum | EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) } |
![]() | |
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 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... | |
![]() | |
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... | |
![]() | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). More... | |
void | MakeZombie () |
![]() | |
virtual void * | GetSender () |
virtual const char * | GetSenderClassName () const |
![]() | |
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... | |
![]() | |
_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... | |
![]() | |
TList * | fListOfConnections |
list of signals from this object More... | |
TList * | fListOfSignals |
Bool_t | fSignalsBlocked |
list of connections to this object More... | |
![]() | |
static Bool_t | fgAllSignalsBlocked = kFALSE |
flag used for suppression of signals More... | |
#include <TSAXParser.h>
|
private |
TSAXParser::TSAXParser | ( | ) |
Create SAX parser.
Definition at line 67 of file TSAXParser.cxx.
|
virtual |
TSAXParser desctructor.
Definition at line 97 of file TSAXParser.cxx.
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.
[in] | handler | Name User-defined SAX Handler class name |
[in] | handler | Pointer to the user-defined SAX Handler |
See SAXHandler.C tutorial.
Definition at line 441 of file TSAXParser.cxx.
Emit a signal for OnCdataBlock.
Definition at line 191 of file TSAXParser.cxx.
|
virtual |
Emit a signal for OnCharacters, where characters are the characters outside of tags.
Definition at line 147 of file TSAXParser.cxx.
|
virtual |
Emit a signal for OnComment, where text is the comment.
Definition at line 155 of file TSAXParser.cxx.
|
virtual |
Emit a signal for OnEndDocument.
Definition at line 115 of file TSAXParser.cxx.
|
virtual |
Emit a signal for OnEndElement, where name is the Element's name.
Definition at line 138 of file TSAXParser.cxx.
|
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.
|
virtual |
Emit a signal for OnFactalError, where text is the error and it returns the Parse Error Code, see TXMLParser.
Definition at line 182 of file TSAXParser.cxx.
|
virtual |
Emit a signal for OnStartDocument.
Definition at line 107 of file TSAXParser.cxx.
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.
|
virtual |
Emit a signal for OnWarning, where text is the warning.
Definition at line 163 of file TSAXParser.cxx.
|
private |
|
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 206 of file TSAXParser.cxx.
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 253 of file TSAXParser.cxx.
|
virtual |
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 236 of file TSAXParser.cxx.
|
friend |
Definition at line 25 of file TSAXParser.h.
|
private |
libxml2 SAX handler
Definition at line 28 of file TSAXParser.h.