// @(#)root/xml:$Id: TBufferXML.h 25450 2008-09-18 21:13:42Z pcanal $ // Author: Sergey Linev 10.05.2004 /************************************************************************* * Copyright (C) 1995-2004, Rene Brun and Fons Rademakers. * * All rights reserved. * * * * For the licensing terms see $ROOTSYS/LICENSE. * * For the list of contributors see $ROOTSYS/README/CREDITS. * *************************************************************************/ #ifndef ROOT_TBufferXML #define ROOT_TBufferXML #ifndef ROOT_TBufferFile #include "TBufferFile.h" #endif #ifndef ROOT_TXMLSetup #include "TXMLSetup.h" #endif #ifndef ROOT_TXMLEngine #include "TXMLEngine.h" #endif #ifndef ROOT_TString #include "TString.h" #endif #ifndef ROOT_TObjArray #include "TObjArray.h" #endif class TExMap; class TVirtualStreamerInfo; class TStreamerInfo; class TStreamerElement; class TObjArray; class TMemberStreamer; class TXMLFile; class TXMLStackObj; class TBufferXML : public TBufferFile, public TXMLSetup { friend class TKeyXML; public: TBufferXML(TBuffer::EMode mode); TBufferXML(TBuffer::EMode mode, TXMLFile* file); virtual ~TBufferXML(); static TString ConvertToXML(TObject* obj, Bool_t GenericLayout = kFALSE, Bool_t UseNamespaces = kFALSE); static TString ConvertToXML(void* obj, TClass* cl, Bool_t GenericLayout = kFALSE, Bool_t UseNamespaces = kFALSE); static TObject* ConvertFromXML(const char* str, Bool_t GenericLayout = kFALSE, Bool_t UseNamespaces = kFALSE); static void* ConvertFromXMLAny(const char* str, TClass** cl = 0, Bool_t GenericLayout = kFALSE, Bool_t UseNamespaces = kFALSE); // suppress class writing/reading virtual TClass* ReadClass(const TClass* cl = 0, UInt_t* objTag = 0); virtual void WriteClass(const TClass* cl); // redefined virtual functions of TBuffer virtual Int_t CheckByteCount(UInt_t startpos, UInt_t bcnt, const TClass *clss); // SL virtual Int_t CheckByteCount(UInt_t startpos, UInt_t bcnt, const char *classname); // SL virtual void SetByteCount(UInt_t cntpos, Bool_t packInVersion = kFALSE); // SL virtual Version_t ReadVersion(UInt_t *start = 0, UInt_t *bcnt = 0, const TClass *cl = 0); // SL virtual UInt_t WriteVersion(const TClass *cl, Bool_t useBcnt = kFALSE); // SL virtual void* ReadObjectAny(const TClass* clCast); virtual void SkipObjectAny(); virtual void IncrementLevel(TVirtualStreamerInfo*); virtual void SetStreamerElementNumber(Int_t); virtual void DecrementLevel(TVirtualStreamerInfo*); virtual void ClassBegin(const TClass*, Version_t = -1); virtual void ClassEnd(const TClass*); virtual void ClassMember(const char* name, const char* typeName = 0, Int_t arrsize1 = -1, Int_t arrsize2 = -1); virtual void WriteObject(const TObject *obj); virtual void ReadFloat16 (Float_t *f, TStreamerElement *ele=0); virtual void WriteFloat16(Float_t *f, TStreamerElement *ele=0); virtual void ReadDouble32 (Double_t *d, TStreamerElement *ele=0); virtual void WriteDouble32(Double_t *d, TStreamerElement *ele=0); virtual Int_t ReadArray(Bool_t *&b); virtual Int_t ReadArray(Char_t *&c); virtual Int_t ReadArray(UChar_t *&c); virtual Int_t ReadArray(Short_t *&h); virtual Int_t ReadArray(UShort_t *&h); virtual Int_t ReadArray(Int_t *&i); virtual Int_t ReadArray(UInt_t *&i); virtual Int_t ReadArray(Long_t *&l); virtual Int_t ReadArray(ULong_t *&l); virtual Int_t ReadArray(Long64_t *&l); virtual Int_t ReadArray(ULong64_t *&l); virtual Int_t ReadArray(Float_t *&f); virtual Int_t ReadArray(Double_t *&d); virtual Int_t ReadArrayFloat16(Float_t *&f, TStreamerElement *ele=0); virtual Int_t ReadArrayDouble32(Double_t *&d, TStreamerElement *ele=0); virtual Int_t ReadStaticArray(Bool_t *b); virtual Int_t ReadStaticArray(Char_t *c); virtual Int_t ReadStaticArray(UChar_t *c); virtual Int_t ReadStaticArray(Short_t *h); virtual Int_t ReadStaticArray(UShort_t *h); virtual Int_t ReadStaticArray(Int_t *i); virtual Int_t ReadStaticArray(UInt_t *i); virtual Int_t ReadStaticArray(Long_t *l); virtual Int_t ReadStaticArray(ULong_t *l); virtual Int_t ReadStaticArray(Long64_t *l); virtual Int_t ReadStaticArray(ULong64_t *l); virtual Int_t ReadStaticArray(Float_t *f); virtual Int_t ReadStaticArray(Double_t *d); virtual Int_t ReadStaticArrayFloat16(Float_t *f, TStreamerElement *ele=0); virtual Int_t ReadStaticArrayDouble32(Double_t *d, TStreamerElement *ele=0); virtual void ReadFastArray(Bool_t *b, Int_t n); virtual void ReadFastArray(Char_t *c, Int_t n); virtual void ReadFastArray(UChar_t *c, Int_t n); virtual void ReadFastArray(Short_t *h, Int_t n); virtual void ReadFastArray(UShort_t *h, Int_t n); virtual void ReadFastArray(Int_t *i, Int_t n); virtual void ReadFastArray(UInt_t *i, Int_t n); virtual void ReadFastArray(Long_t *l, Int_t n); virtual void ReadFastArray(ULong_t *l, Int_t n); virtual void ReadFastArray(Long64_t *l, Int_t n); virtual void ReadFastArray(ULong64_t *l, Int_t n); virtual void ReadFastArray(Float_t *f, Int_t n); virtual void ReadFastArray(Double_t *d, Int_t n); virtual void ReadFastArrayFloat16(Float_t *f, Int_t n, TStreamerElement *ele=0); virtual void ReadFastArrayDouble32(Double_t *d, Int_t n, TStreamerElement *ele=0); virtual void WriteArray(const Bool_t *b, Int_t n); virtual void WriteArray(const Char_t *c, Int_t n); virtual void WriteArray(const UChar_t *c, Int_t n); virtual void WriteArray(const Short_t *h, Int_t n); virtual void WriteArray(const UShort_t *h, Int_t n); virtual void WriteArray(const Int_t *i, Int_t n); virtual void WriteArray(const UInt_t *i, Int_t n); virtual void WriteArray(const Long_t *l, Int_t n); virtual void WriteArray(const ULong_t *l, Int_t n); virtual void WriteArray(const Long64_t *l, Int_t n); virtual void WriteArray(const ULong64_t *l, Int_t n); virtual void WriteArray(const Float_t *f, Int_t n); virtual void WriteArray(const Double_t *d, Int_t n); virtual void WriteArrayFloat16(const Float_t *f, Int_t n, TStreamerElement *ele=0); virtual void WriteArrayDouble32(const Double_t *d, Int_t n, TStreamerElement *ele=0); virtual void ReadFastArray(void *start , const TClass *cl, Int_t n=1, TMemberStreamer *s=0, const TClass* onFileClass = 0); virtual void ReadFastArray(void **startp, const TClass *cl, Int_t n=1, Bool_t isPreAlloc=kFALSE, TMemberStreamer *s=0, const TClass* onFileClass = 0); virtual void WriteFastArray(const Bool_t *b, Int_t n); virtual void WriteFastArray(const Char_t *c, Int_t n); virtual void WriteFastArray(const UChar_t *c, Int_t n); virtual void WriteFastArray(const Short_t *h, Int_t n); virtual void WriteFastArray(const UShort_t *h, Int_t n); virtual void WriteFastArray(const Int_t *i, Int_t n); virtual void WriteFastArray(const UInt_t *i, Int_t n); virtual void WriteFastArray(const Long_t *l, Int_t n); virtual void WriteFastArray(const ULong_t *l, Int_t n); virtual void WriteFastArray(const Long64_t *l, Int_t n); virtual void WriteFastArray(const ULong64_t *l, Int_t n); virtual void WriteFastArray(const Float_t *f, Int_t n); virtual void WriteFastArray(const Double_t *d, Int_t n); virtual void WriteFastArrayFloat16(const Float_t *d, Int_t n, TStreamerElement *ele=0); virtual void WriteFastArrayDouble32(const Double_t *d, Int_t n, TStreamerElement *ele=0); virtual void WriteFastArray(void *start, const TClass *cl, Int_t n=1, TMemberStreamer *s=0); virtual Int_t WriteFastArray(void **startp, const TClass *cl, Int_t n=1, Bool_t isPreAlloc=kFALSE, TMemberStreamer *s=0); virtual void StreamObject(void *obj, const type_info &typeinfo, const TClass* onFileClass = 0); virtual void StreamObject(void *obj, const char *className, const TClass* onFileClass = 0 ); virtual void StreamObject(void *obj, const TClass *cl, const TClass* onFileClass = 0 ); virtual void StreamObject(TObject *obj); virtual void ReadBool(Bool_t &b); virtual void ReadChar(Char_t &c); virtual void ReadUChar(UChar_t &c); virtual void ReadShort(Short_t &s); virtual void ReadUShort(UShort_t &s); virtual void ReadInt(Int_t &i); virtual void ReadUInt(UInt_t &i); virtual void ReadLong(Long_t &l); virtual void ReadULong(ULong_t &l); virtual void ReadLong64(Long64_t &l); virtual void ReadULong64(ULong64_t &l); virtual void ReadFloat(Float_t &f); virtual void ReadDouble(Double_t &d); virtual void ReadCharP(Char_t *c); virtual void ReadTString(TString &s); virtual void WriteBool(Bool_t b); virtual void WriteChar(Char_t c); virtual void WriteUChar(UChar_t c); virtual void WriteShort(Short_t s); virtual void WriteUShort(UShort_t s); virtual void WriteInt(Int_t i); virtual void WriteUInt(UInt_t i); virtual void WriteLong(Long_t l); virtual void WriteULong(ULong_t l); virtual void WriteLong64(Long64_t l); virtual void WriteULong64(ULong64_t l); virtual void WriteFloat(Float_t f); virtual void WriteDouble(Double_t d); virtual void WriteCharP(const Char_t *c); virtual void WriteTString(const TString &s); // end of redefined virtual functions protected: TBufferXML(); // redefined protected virtual functions virtual void WriteObjectClass(const void *actualObjStart, const TClass *actualClass); // end redefined protected virtual functions TXMLFile* XmlFile(); void SetCompressionLevel(int level) { fCompressLevel = level; } void SetXML(TXMLEngine* xml) { fXML = xml; } void XmlWriteBlock(XMLNodePointer_t node); XMLNodePointer_t XmlWriteAny(const void* obj, const TClass* cl); void XmlReadBlock(XMLNodePointer_t node); void* XmlReadAny(XMLNodePointer_t node, void* obj, TClass** cl); TXMLStackObj* PushStack(XMLNodePointer_t current, Bool_t simple = kFALSE); TXMLStackObj* PopStack(); void ShiftStack(const char* info = 0); XMLNodePointer_t StackNode(); TXMLStackObj* Stack(Int_t depth = 0); void WorkWithClass(TStreamerInfo* info, const TClass* cl = 0); void WorkWithElement(TStreamerElement* elem, Int_t number); Bool_t VerifyNode(XMLNodePointer_t node, const char* name, const char* errinfo = 0); Bool_t VerifyStackNode(const char* name, const char* errinfo = 0); Bool_t VerifyAttr(XMLNodePointer_t node, const char* name, const char* value, const char* errinfo = 0); Bool_t VerifyStackAttr(const char* name, const char* value, const char* errinfo = 0); Bool_t ProcessPointer(const void* ptr, XMLNodePointer_t node); void RegisterPointer(const void* ptr, XMLNodePointer_t node); Bool_t ExtractPointer(XMLNodePointer_t node, void* &ptr, TClass* &cl); void ExtractReference(XMLNodePointer_t node, const void* ptr, const TClass* cl); XMLNodePointer_t CreateItemNode(const char* name); Bool_t VerifyItemNode(const char* name, const char* errinfo = 0); void CreateElemNode(const TStreamerElement* elem); Bool_t VerifyElemNode(const TStreamerElement* elem); void PerformPreProcessing(const TStreamerElement* elem, XMLNodePointer_t elemnode); void PerformPostProcessing(); XMLNodePointer_t XmlWriteBasic(Char_t value); XMLNodePointer_t XmlWriteBasic(Short_t value); XMLNodePointer_t XmlWriteBasic(Int_t value); XMLNodePointer_t XmlWriteBasic(Long_t value); XMLNodePointer_t XmlWriteBasic(Long64_t value); XMLNodePointer_t XmlWriteBasic(Float_t value); XMLNodePointer_t XmlWriteBasic(Double_t value); XMLNodePointer_t XmlWriteBasic(Bool_t value); XMLNodePointer_t XmlWriteBasic(UChar_t value); XMLNodePointer_t XmlWriteBasic(UShort_t value); XMLNodePointer_t XmlWriteBasic(UInt_t value); XMLNodePointer_t XmlWriteBasic(ULong_t value); XMLNodePointer_t XmlWriteBasic(ULong64_t value); XMLNodePointer_t XmlWriteValue(const char* value, const char* name); void XmlReadBasic(Char_t& value); void XmlReadBasic(Short_t& value); void XmlReadBasic(Int_t& value); void XmlReadBasic(Long_t& value); void XmlReadBasic(Long64_t& value); void XmlReadBasic(Float_t& value); void XmlReadBasic(Double_t& value); void XmlReadBasic(Bool_t& value); void XmlReadBasic(UChar_t& value); void XmlReadBasic(UShort_t& value); void XmlReadBasic(UInt_t& value); void XmlReadBasic(ULong_t& value); void XmlReadBasic(ULong64_t& value); const char* XmlReadValue(const char* name); XMLNodePointer_t XmlWriteObject(const void* obj, const TClass* objClass); void* XmlReadObject(void* obj, TClass** cl = 0); void BeforeIOoperation(); void CheckVersionBuf(); TXMLEngine* fXML; //! TObjArray fStack; //! Version_t fVersionBuf; //! TExMap* fObjMap; //! TObjArray* fIdArray; //! TString fValueBuf; //! Int_t fErrorFlag; //! Bool_t fCanUseCompact; //! flag indicate that basic type (like Int_t) can be placed in the same tag Bool_t fExpectedChain; //! flag to resolve situation when several elements of same basic type stored as FastArray TClass* fExpectedBaseClass; //! pointer to class, which should be stored as parent of current Int_t fCompressLevel; //! compress level used to minimize size of file ClassDef(TBufferXML,1) //a specialized TBuffer to read/write to XML files }; #endif