// @(#)root/io:$Id: TStreamerInfo.h 26606 2008-12-02 20:36:09Z pcanal $ // Author: Rene Brun 12/10/2000 /************************************************************************* * Copyright (C) 1995-2000, 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_TStreamerInfo #define ROOT_TStreamerInfo ////////////////////////////////////////////////////////////////////////// // // // TStreamerInfo // // // // Describe Streamer information for one class version // // // ////////////////////////////////////////////////////////////////////////// #ifndef ROOT_TVirtualStreamerInfo #include "TVirtualStreamerInfo.h" #endif #include "TVirtualCollectionProxy.h" #if (defined(_MSC_VER) && (_MSC_VER < 1300)) || defined(R__ALPHA) || \ (defined(R__MACOSX) && defined(R__GNU) && __GNUC__==3 && __GNUC_MINOR<=3) || \ (defined(R__MACOSX) && defined(__xlC__)) #define R__BROKEN_FUNCTION_TEMPLATES #endif class TFile; class TClass; class TClonesArray; class TDataMember; class TMemberStreamer; class TStreamerElement; class TStreamerBasicType; class TClassStreamer; class TVirtualArray; namespace ROOT { class TCollectionProxyInfo; } class TStreamerInfo : public TVirtualStreamerInfo { #ifdef R__BROKEN_FUNCTION_TEMPLATES public: #endif class TCompInfo { // Class used to cache information (see fComp) private: TCompInfo(const TCompInfo&); // Not implemented TCompInfo& operator=(const TCompInfo&); // Not implemented public: TClass *fClass; TClass *fNewClass; TString fClassName; TMemberStreamer *fStreamer; TCompInfo() : fClass(0), fNewClass(0), fClassName(""), fStreamer(0) {}; ~TCompInfo() {}; void Update(const TClass *oldcl, TClass *newcl); }; protected: //--------------------------------------------------------------------------- // Adatper class used to handle streaming collection of pointers //--------------------------------------------------------------------------- class TPointerCollectionAdapter { public: TPointerCollectionAdapter( TVirtualCollectionProxy *proxy ): fProxy( proxy ) {} char* operator[]( UInt_t idx ) const { char **el = (char**)fProxy->At(idx); return *el; } private: TVirtualCollectionProxy *fProxy; }; private: UInt_t fCheckSum; //checksum of original class Int_t fClassVersion; //Class version identifier Int_t fOnFileClassVersion;//!Class version identifier as stored on file. Int_t fNumber; //!Unique identifier Int_t fNdata; //!number of optmized types Int_t fSize; //!size of the persistent class Int_t *fType; //![fNdata] Int_t *fNewType; //![fNdata] Int_t *fOffset; //![fNdata] Int_t *fLength; //![fNdata] ULong_t *fElem; //![fNdata] ULong_t *fMethod; //![fNdata] TCompInfo *fComp; //![fNdata] additional info Bool_t fOptimized; //! true if has been optimized TClass *fClass; //!pointer to class TObjArray *fElements; //Array of TStreamerElements Version_t fOldVersion; //! Version of the TStreamerInfo object read from the file Bool_t fIsBuilt; //! true if the TStreamerInfo has been 'built' static Int_t fgCount; //Number of TStreamerInfo instances static TStreamerElement *fgElement; //Pointer to current TStreamerElement static Double_t GetValueAux(Int_t type, void *ladd, int k, Int_t len); static void PrintValueAux(char *ladd, Int_t atype, TStreamerElement * aElement, Int_t aleng, Int_t *count); UInt_t GenerateIncludes(FILE *fp, char *inclist); void GenerateDeclaration(FILE *fp, FILE *sfp, const TList *subClasses, Bool_t top = kTRUE); void InsertArtificialElements(const TObjArray *rules); private: TStreamerInfo(const TStreamerInfo&); // TStreamerInfo are copiable. Not Implemented. TStreamerInfo& operator=(const TStreamerInfo&); // TStreamerInfo are copiable. Not Implemented. public: //status bits enum { kCannotOptimize = BIT(12), kIgnoreTObjectStreamer = BIT(13), // eventhough BIT(13) is taken up by TObject (to preserverse forward compatibility) kRecovered = BIT(14), kNeedCheck = BIT(15) }; enum EReadWrite { kBase = 0, kOffsetL = 20, kOffsetP = 40, kCounter = 6, kCharStar = 7, kChar = 1, kShort = 2, kInt = 3, kLong = 4, kFloat = 5, kDouble = 8, kDouble32= 9, kUChar = 11, kUShort = 12, kUInt = 13, kULong = 14, kBits = 15, kLong64 = 16, kULong64 = 17, kBool = 18, kFloat16 = 19, kObject = 61, kAny = 62, kObjectp = 63, kObjectP = 64, kTString = 65, kTObject = 66, kTNamed = 67, kAnyp = 68, kAnyP = 69, kAnyPnoVT = 70, kSTLp = 71, kSkip = 100, kSkipL = 120, kSkipP = 140, kConv = 200, kConvL = 220, kConvP = 240, kSTL = 300, kSTLstring = 365, kStreamer = 500, kStreamLoop = 501, kCache = 600, // Cache the value in memory than is not part of the object but is accessible via a SchemaRule kArtificial = 1000, kCacheNew = 1001, kCacheDelete = 1002, kMissing = 99999 }; // Some comments about EReadWrite // kBase : base class element // kOffsetL : fixed size array // kOffsetP : pointer to object // kCounter : counter for array size // kCharStar: pointer to array of char // kBits : TObject::fBits in case of a referenced object // kObject : Class derived from TObject // kObjectp : Class* derived from TObject and with comment field //->Class // kObjectP : Class* derived from TObject and with NO comment field //->Class // kAny : Class not derived from TObject // kAnyp : Class* not derived from TObject with comment field //->Class // kAnyP : Class* not derived from TObject with NO comment field //->Class // kAnyPnoVT: Class* not derived from TObject with NO comment field //->Class and Class has NO virtual table // kSTLp : Pointer to STL container. // kTString : TString, special case // kTObject : TObject, special case // kTNamed : TNamed , special case TStreamerInfo(); TStreamerInfo(TClass *cl); virtual ~TStreamerInfo(); void Build(); void BuildCheck(); void BuildEmulated(TFile *file); void BuildOld(); virtual Bool_t BuildFor( const TClass *cl ); void Clear(Option_t *); void Compile(); void ComputeSize(); void ForceWriteInfo(TFile *file, Bool_t force=kFALSE); Int_t GenerateHeaderFile(const char *dirname, const TList *subClasses = 0); TClass *GetClass() const {return fClass;} UInt_t GetCheckSum() const {return fCheckSum;} UInt_t GetCheckSum(UInt_t code) const; Int_t GetClassVersion() const {return fClassVersion;} Int_t GetDataMemberOffset(TDataMember *dm, TMemberStreamer *&streamer) const; TObjArray *GetElements() const {return fElements;} ULong_t *GetElems() const {return fElem;} Int_t GetNdata() const {return fNdata;} Int_t GetNumber() const {return fNumber;} Int_t *GetLengths() const {return fLength;} ULong_t *GetMethods() const {return fMethod;} Int_t *GetNewTypes() const {return fNewType;} Int_t GetOffset(const char *) const; Int_t *GetOffsets() const {return fOffset;} Version_t GetOldVersion() const {return fOldVersion;} Int_t GetOnFileClassVersion() const {return fOnFileClassVersion;} Int_t GetSize() const; Int_t GetSizeElements() const; TStreamerElement *GetStreamerElement(const char*datamember, Int_t& offset) const; TStreamerElement *GetStreamerElementReal(Int_t i, Int_t j) const; Int_t *GetTypes() const {return fType;} Double_t GetValue(char *pointer, Int_t i, Int_t j, Int_t len) const; Double_t GetValueClones(TClonesArray *clones, Int_t i, Int_t j, Int_t k, Int_t eoffset) const; Double_t GetValueSTL(TVirtualCollectionProxy *cont, Int_t i, Int_t j, Int_t k, Int_t eoffset) const; Double_t GetValueSTLP(TVirtualCollectionProxy *cont, Int_t i, Int_t j, Int_t k, Int_t eoffset) const; Bool_t IsBuilt() const { return fIsBuilt; } Bool_t IsOptimized() const {return fOptimized;} Int_t IsRecovered() const {return TestBit(kRecovered);} void ls(Option_t *option="") const; TVirtualStreamerInfo *NewInfo(TClass *cl) {return new TStreamerInfo(cl);} void *New(void *obj = 0); void *NewArray(Long_t nElements, void* ary = 0); void Destructor(void* p, Bool_t dtorOnly = kFALSE); void DeleteArray(void* p, Bool_t dtorOnly = kFALSE); void PrintValue(const char *name, char *pointer, Int_t i, Int_t len, Int_t lenmax=1000) const; void PrintValueClones(const char *name, TClonesArray *clones, Int_t i, Int_t eoffset, Int_t lenmax=1000) const; void PrintValueSTL(const char *name, TVirtualCollectionProxy *cont, Int_t i, Int_t eoffset, Int_t lenmax=1000) const; #ifdef R__BROKEN_FUNCTION_TEMPLATES // Support for non standard compilers Int_t ReadBuffer(TBuffer &b, char** const &arrptr, Int_t first,Int_t narr=1,Int_t eoffset=0,Int_t mode=0); Int_t ReadBufferSkip(TBuffer &b, char** const &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); Int_t ReadBufferConv(TBuffer &b, char** const &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); Int_t ReadBufferArtificial(TBuffer &b, char** const &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); Int_t ReadBuffer(TBuffer &b, const TVirtualCollectionProxy &arrptr, Int_t first,Int_t narr=1,Int_t eoffset=0,Int_t mode=0); Int_t ReadBufferSkip(TBuffer &b, const TVirtualCollectionProxy &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); Int_t ReadBufferConv(TBuffer &b, const TVirtualCollectionProxy &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); Int_t ReadBufferArtificial(TBuffer &b, const TVirtualCollectionProxy &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); Int_t ReadBuffer(TBuffer &b, const TPointerCollectionAdapter &arrptr, Int_t first,Int_t narr=1,Int_t eoffset=0,Int_t mode=0); Int_t ReadBufferSkip(TBuffer &b, const TPointerCollectionAdapter &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); Int_t ReadBufferConv(TBuffer &b, const TPointerCollectionAdapter &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); Int_t ReadBufferArtificial(TBuffer &b, const TPointerCollectionAdapter &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); Int_t ReadBuffer(TBuffer &b, const TVirtualArray &arrptr, Int_t first,Int_t narr=1,Int_t eoffset=0,Int_t mode=0); Int_t ReadBufferSkip(TBuffer &b, const TVirtualArray &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); Int_t ReadBufferConv(TBuffer &b, const TVirtualArray &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); Int_t ReadBufferArtificial(TBuffer &b, const TVirtualArray &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); #else template Int_t ReadBuffer(TBuffer &b, const T &arrptr, Int_t first,Int_t narr=1,Int_t eoffset=0,Int_t mode=0); template Int_t ReadBufferSkip(TBuffer &b, const T &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); template Int_t ReadBufferConv(TBuffer &b, const T &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); template Int_t ReadBufferArtificial(TBuffer &b, const T &arrptr, Int_t i,Int_t kase, TStreamerElement *aElement, Int_t narr, Int_t eoffset); #endif Int_t ReadBufferClones(TBuffer &b, TClonesArray *clones, Int_t nc, Int_t first, Int_t eoffset); Int_t ReadBufferSTL(TBuffer &b, TVirtualCollectionProxy *cont, Int_t nc, Int_t first, Int_t eoffset ); Int_t ReadBufferSTLPtrs(TBuffer &b, TVirtualCollectionProxy *cont, Int_t nc, Int_t first, Int_t eoffset ); void SetCheckSum(UInt_t checksum) {fCheckSum = checksum;} void SetClass(TClass *cl) {fClass = cl;} void SetClassVersion(Int_t vers) {fClassVersion=vers;} void TagFile(TFile *fFile); Int_t WriteBuffer(TBuffer &b, char *pointer, Int_t first); Int_t WriteBufferClones(TBuffer &b, TClonesArray *clones, Int_t nc, Int_t first, Int_t eoffset); Int_t WriteBufferSTL (TBuffer &b, TVirtualCollectionProxy *cont, Int_t nc, Int_t first, Int_t eoffset ); Int_t WriteBufferSTLPtrs( TBuffer &b, TVirtualCollectionProxy *cont, Int_t nc, Int_t first, Int_t eoffset ); virtual void Update(const TClass *oldClass, TClass *newClass); virtual TVirtualCollectionProxy *GenEmulatedProxy(const char* class_name); virtual TClassStreamer *GenEmulatedClassStreamer(const char* class_name); virtual TVirtualCollectionProxy *GenExplicitProxy( const ::ROOT::TCollectionProxyInfo &info, TClass *cl ); virtual TClassStreamer *GenExplicitClassStreamer( const ::ROOT::TCollectionProxyInfo &info, TClass *cl ); static TStreamerElement *GetCurrentElement(); #ifdef R__BROKEN_FUNCTION_TEMPLATES // Support for non standard compilers Int_t WriteBufferAux (TBuffer &b, char ** const &arr, Int_t first,Int_t narr,Int_t eoffset,Int_t mode); Int_t WriteBufferAux (TBuffer &b, const TVirtualCollectionProxy &arr, Int_t first,Int_t narr,Int_t eoffset,Int_t mode); Int_t WriteBufferAux (TBuffer &b, const TPointerCollectionAdapter &arr, Int_t first,Int_t narr,Int_t eoffset,Int_t mode); #else template Int_t WriteBufferAux (TBuffer &b, const T &arr, Int_t first,Int_t narr,Int_t eoffset,Int_t mode); #endif //WARNING this class version must be the same as TVirtualStreamerInfo ClassDef(TStreamerInfo,8) //Streamer information for one class version }; #endif