Logo ROOT   6.16/01
Reference Guide
TXMLFile.h
Go to the documentation of this file.
1// @(#)root/xml:$Id$
2// Author: Sergey Linev 10.05.2004
3
4/*************************************************************************
5 * Copyright (C) 1995-2004, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TXMLFile
13#define ROOT_TXMLFile
14
15#include "Compression.h"
16#include "TXMLEngine.h"
17#include "TFile.h"
18#include "TXMLSetup.h"
19
20class TKeyXML;
21class TList;
23class TStreamerInfo;
24
25class TXMLFile : public TFile, public TXMLSetup {
26
27protected:
28 void InitXmlFile(Bool_t create);
29 // Interface to basic system I/O routines
30 virtual Int_t SysOpen(const char *, Int_t, UInt_t) { return 0; }
31 virtual Int_t SysClose(Int_t) { return 0; }
32 virtual Int_t SysRead(Int_t, void *, Int_t) { return 0; }
33 virtual Int_t SysWrite(Int_t, const void *, Int_t) { return 0; }
34 virtual Long64_t SysSeek(Int_t, Long64_t, Int_t) { return 0; }
35 virtual Int_t SysStat(Int_t, Long_t *, Long64_t *, Long_t *, Long_t *) { return 0; }
36 virtual Int_t SysSync(Int_t) { return 0; }
37
38 // Overwrite methods for directory I/O
40 virtual Int_t DirReadKeys(TDirectory *);
41 virtual void DirWriteKeys(TDirectory *);
42 virtual void DirWriteHeader(TDirectory *);
43
44 InfoListRet GetStreamerInfoListImpl(bool lookupSICache);
45
46private:
47 // let the compiler do the job. gcc complains when the following line is activated
48 // TXMLFile(const TXMLFile &) {} //Files cannot be copied
49 void operator=(const TXMLFile &);
50
51public:
52 TXMLFile();
53 TXMLFile(const char *filename, Option_t *option = "read", const char *title = "title", Int_t compression = ROOT::RCompressionSetting::EDefaults::kUseGeneralPurpose);
54 virtual ~TXMLFile();
55
56 virtual void Close(Option_t *option = ""); // *MENU*
57 virtual TKey *CreateKey(TDirectory *mother, const TObject *obj, const char *name, Int_t bufsize);
58 virtual TKey *CreateKey(TDirectory *mother, const void *obj, const TClass *cl, const char *name, Int_t bufsize);
59 virtual void DrawMap(const char * = "*", Option_t * = "") {}
60 virtual void FillBuffer(char *&) {}
61 virtual void Flush() {}
62
63 virtual Long64_t GetEND() const { return 0; }
64 virtual Int_t GetErrno() const { return 0; }
65 virtual void ResetErrno() const {}
66
67 virtual Int_t GetNfree() const { return 0; }
68 virtual Int_t GetNbytesInfo() const { return 0; }
69 virtual Int_t GetNbytesFree() const { return 0; }
70 virtual Long64_t GetSeekFree() const { return 0; }
71 virtual Long64_t GetSeekInfo() const { return 0; }
72 virtual Long64_t GetSize() const { return 0; }
73
74 Int_t GetIOVersion() const { return fIOVersion; }
75
76 virtual Bool_t IsOpen() const;
77
78 virtual void MakeFree(Long64_t, Long64_t) {}
79 virtual void MakeProject(const char *, const char * = "*", Option_t * = "new") {} // *MENU*
80 virtual void Map(Option_t *) {} //
81 virtual void Map() {} //
82 virtual void Paint(Option_t * = "") {}
83 virtual void Print(Option_t * = "") const {}
84 virtual Bool_t ReadBuffer(char *, Int_t) { return kFALSE; }
85 virtual Bool_t ReadBuffer(char *, Long64_t, Int_t) { return kFALSE; }
86 virtual void ReadFree() {}
87 virtual Int_t Recover() { return 0; }
88 virtual Int_t ReOpen(Option_t *mode);
89 virtual void Seek(Long64_t, ERelativeTo = kBeg) {}
90
91 virtual void SetEND(Long64_t) {}
92 virtual Int_t Sizeof() const { return 0; }
93
94 virtual Bool_t WriteBuffer(const char *, Int_t) { return kFALSE; }
95 virtual Int_t Write(const char * = 0, Int_t = 0, Int_t = 0) { return 0; }
96 virtual Int_t Write(const char * = 0, Int_t = 0, Int_t = 0) const { return 0; }
97 virtual void WriteFree() {}
98 virtual void WriteHeader() {}
99 virtual void WriteStreamerInfo();
100
101 // XML specific functions
102
103 virtual void SetXmlLayout(EXMLLayout layout);
104 virtual void SetStoreStreamerInfos(Bool_t iConvert = kTRUE);
105 virtual void SetUsedDtd(Bool_t use = kTRUE);
106 virtual void SetUseNamespaces(Bool_t iUseNamespaces = kTRUE);
107
108 Bool_t AddXmlComment(const char *comment);
109 Bool_t AddXmlStyleSheet(const char *href, const char *type = "text/css", const char *title = 0, int alternate = -1,
110 const char *media = 0, const char *charset = 0);
111 Bool_t AddXmlLine(const char *line);
112
113 TXMLEngine *XML() { return fXML; }
114
115protected:
116 // functions to store streamer infos
117
120
124 TDirectory *FindKeyDir(TDirectory *mother, Long64_t keyid);
125 void CombineNodesTree(TDirectory *dir, XMLNodePointer_t topnode, Bool_t dolink);
126
127 void SaveToFile();
128
129 static void ProduceFileNames(const char *filename, TString &fname, TString &dtdname);
130
132
133 XMLNodePointer_t fStreamerInfoNode; //! pointer of node with streamer info data
134
135 TXMLEngine *fXML; //! object for interface with xml library
136
137 Int_t fIOVersion; //! indicates format of ROOT xml file
138
139 Long64_t fKeyCounter; //! counter of created keys, used for keys id
140
141 ClassDef(TXMLFile, 3) // ROOT file in XML format
142};
143
144#endif
int Int_t
Definition: RtypesCore.h:41
unsigned int UInt_t
Definition: RtypesCore.h:42
const Bool_t kFALSE
Definition: RtypesCore.h:88
long Long_t
Definition: RtypesCore.h:50
bool Bool_t
Definition: RtypesCore.h:59
long long Long64_t
Definition: RtypesCore.h:69
const Bool_t kTRUE
Definition: RtypesCore.h:87
const char Option_t
Definition: RtypesCore.h:62
#define ClassDef(name, id)
Definition: Rtypes.h:324
int type
Definition: TGX11.cxx:120
void * XMLNodePointer_t
Definition: TXMLEngine.h:17
void * XMLDocPointer_t
Definition: TXMLEngine.h:20
The ROOT global object gROOT contains a list of all defined classes.
Definition: TClass.h:75
Describe directory structure in memory.
Definition: TDirectory.h:34
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format.
Definition: TFile.h:48
ERelativeTo
Definition: TFile.h:184
@ kBeg
Definition: TFile.h:184
Book space in a file, create I/O buffers, to fill them, (un)compress them.
Definition: TKey.h:24
A doubly linked list.
Definition: TList.h:44
Mother of all ROOT objects.
Definition: TObject.h:37
Describe Streamer information for one class version.
Definition: TStreamerInfo.h:43
Basic string class.
Definition: TString.h:131
virtual void DirWriteKeys(TDirectory *)
Update key attributes.
Definition: TXMLFile.cxx:1094
virtual Int_t SysWrite(Int_t, const void *, Int_t)
Interface to system write. All arguments like in POSIX write().
Definition: TXMLFile.h:33
virtual void FillBuffer(char *&)
Encode file output buffer.
Definition: TXMLFile.h:60
virtual Bool_t ReadBuffer(char *, Int_t)
Read a buffer from the file.
Definition: TXMLFile.h:84
Int_t fIOVersion
object for interface with xml library
Definition: TXMLFile.h:137
virtual void WriteStreamerInfo()
convert all TStreamerInfo, used in file, to xml format
Definition: TXMLFile.cxx:677
TXMLFile()
default TXMLFile constructor
Definition: TXMLFile.cxx:96
TDirectory * FindKeyDir(TDirectory *mother, Long64_t keyid)
Find a directory in motherdir with a seek equal to keyid.
Definition: TXMLFile.cxx:1060
InfoListRet GetStreamerInfoListImpl(bool lookupSICache)
Read streamerinfo structures from xml format and provide them in the list It is user responsibility t...
Definition: TXMLFile.cxx:728
virtual Bool_t IsOpen() const
return kTRUE if file is opened and can be accessed
Definition: TXMLFile.cxx:385
virtual void Seek(Long64_t, ERelativeTo=kBeg)
Seek to a specific position in the file. Pos it either kBeg, kCur or kEnd.
Definition: TXMLFile.h:89
void InitXmlFile(Bool_t create)
initialize xml file and correspondent structures identical to TFile::Init() function
Definition: TXMLFile.cxx:272
virtual Int_t Sizeof() const
Return the size in bytes of the file header.
Definition: TXMLFile.h:92
virtual Int_t GetErrno() const
Method returning errno. Is overriden in TRFIOFile.
Definition: TXMLFile.h:64
virtual TKey * CreateKey(TDirectory *mother, const TObject *obj, const char *name, Int_t bufsize)
create XML key, which will store object in xml structures
Definition: TXMLFile.cxx:430
virtual void WriteFree()
Write FREE linked list on the file.
Definition: TXMLFile.h:97
void SaveToFile()
Saves xml structures to the file xml elements are kept in list of TKeyXML objects When saving,...
Definition: TXMLFile.cxx:476
virtual Int_t GetNbytesFree() const
Definition: TXMLFile.h:69
Bool_t AddXmlStyleSheet(const char *href, const char *type="text/css", const char *title=0, int alternate=-1, const char *media=0, const char *charset=0)
Adds style sheet definition on the top of xml document Creates <?xml-stylesheet alternate="yes" title...
Definition: TXMLFile.cxx:994
XMLNodePointer_t fStreamerInfoNode
Definition: TXMLFile.h:133
virtual void Close(Option_t *option="")
Close a XML file For more comments see TFile::Close() function.
Definition: TXMLFile.cxx:309
virtual Int_t Write(const char *=0, Int_t=0, Int_t=0)
Write memory objects to this file.
Definition: TXMLFile.h:95
Long64_t fKeyCounter
indicates format of ROOT xml file
Definition: TXMLFile.h:139
virtual void DrawMap(const char *="*", Option_t *="")
Draw map of objects in this file.
Definition: TXMLFile.h:59
virtual Int_t SysOpen(const char *, Int_t, UInt_t)
Interface to system open. All arguments like in POSIX open().
Definition: TXMLFile.h:30
void CombineNodesTree(TDirectory *dir, XMLNodePointer_t topnode, Bool_t dolink)
Connect/disconnect all file nodes to single tree before/after saving.
Definition: TXMLFile.cxx:548
virtual void ResetErrno() const
Method resetting the errno. Is overridden in TRFIOFile.
Definition: TXMLFile.h:65
virtual void MakeProject(const char *, const char *="*", Option_t *="new")
Generate source code necessary to access the objects stored in the file.
Definition: TXMLFile.h:79
virtual void SetUseNamespaces(Bool_t iUseNamespaces=kTRUE)
Specify usage of namespaces in xml file In current implementation every instrumented class in file ge...
Definition: TXMLFile.cxx:965
virtual void MakeFree(Long64_t, Long64_t)
Mark unused bytes on the file.
Definition: TXMLFile.h:78
virtual Bool_t ReadBuffer(char *, Long64_t, Int_t)
Read a buffer from the file at the offset 'pos' in the file.
Definition: TXMLFile.h:85
virtual Long64_t DirCreateEntry(TDirectory *)
Create key for directory entry in the key.
Definition: TXMLFile.cxx:1021
virtual Int_t DirReadKeys(TDirectory *)
Read keys for directory Make sense only once, while next time no new subnodes will be created.
Definition: TXMLFile.cxx:1082
virtual void Map()
Definition: TXMLFile.h:81
Bool_t AddXmlLine(const char *line)
Add just one line on the top of xml document For instance, line can contain special xml processing in...
Definition: TXMLFile.cxx:1010
virtual void DirWriteHeader(TDirectory *)
Write the directory header.
Definition: TXMLFile.cxx:1109
virtual Int_t SysSync(Int_t)
Interface to system fsync. All arguments like in POSIX fsync().
Definition: TXMLFile.h:36
Int_t ReadKeysList(TDirectory *dir, XMLNodePointer_t topnode)
Read list of keys for directory.
Definition: TXMLFile.cxx:643
virtual Int_t GetNbytesInfo() const
Definition: TXMLFile.h:68
virtual void Map(Option_t *)
List the contents of a file sequentially.
Definition: TXMLFile.h:80
virtual Int_t SysRead(Int_t, void *, Int_t)
Interface to system read. All arguments like in POSIX read().
Definition: TXMLFile.h:32
void operator=(const TXMLFile &)
make private to exclude copy operator
Definition: TXMLFile.cxx:378
virtual void SetStoreStreamerInfos(Bool_t iConvert=kTRUE)
If true, all correspondent to file TStreamerInfo objects will be stored in file this allows to apply ...
Definition: TXMLFile.cxx:934
virtual Int_t Write(const char *=0, Int_t=0, Int_t=0) const
One can not save a const TDirectory object.
Definition: TXMLFile.h:96
virtual Bool_t WriteBuffer(const char *, Int_t)
Write a buffer to the file.
Definition: TXMLFile.h:94
virtual void SetUsedDtd(Bool_t use=kTRUE)
Specify usage of DTD for this file.
Definition: TXMLFile.cxx:945
virtual Long64_t GetSeekFree() const
Definition: TXMLFile.h:70
virtual Int_t Recover()
Attempt to recover file if not correctly closed.
Definition: TXMLFile.h:87
virtual Long64_t GetSize() const
Returns the current file size.
Definition: TXMLFile.h:72
Int_t GetIOVersion() const
Definition: TXMLFile.h:74
virtual ~TXMLFile()
destructor of TXMLFile object
Definition: TXMLFile.cxx:365
virtual void WriteHeader()
Write File Header.
Definition: TXMLFile.h:98
XMLDocPointer_t fDoc
Definition: TXMLFile.h:131
virtual void Paint(Option_t *="")
Paint all objects in the file.
Definition: TXMLFile.h:82
virtual Int_t SysClose(Int_t)
Interface to system close. All arguments like in POSIX close().
Definition: TXMLFile.h:31
void StoreStreamerElement(XMLNodePointer_t node, TStreamerElement *elem)
store data of single TStreamerElement in streamer node
Definition: TXMLFile.cxx:780
virtual void Print(Option_t *="") const
Print all objects in the file.
Definition: TXMLFile.h:83
virtual Int_t GetNfree() const
Definition: TXMLFile.h:67
void ReadStreamerElement(XMLNodePointer_t node, TStreamerInfo *info)
read and reconstruct single TStreamerElement from xml node
Definition: TXMLFile.cxx:836
virtual Int_t ReOpen(Option_t *mode)
Reopen a file with a different access mode, like from READ to See TFile::Open() for details.
Definition: TXMLFile.cxx:394
Bool_t ReadFromFile()
read document from file Now full content of document reads into the memory Then document decomposed t...
Definition: TXMLFile.cxx:572
virtual void Flush()
Synchronize a file's in-memory and on-disk states.
Definition: TXMLFile.h:61
TXMLEngine * fXML
pointer of node with streamer info data
Definition: TXMLFile.h:135
virtual Long64_t GetSeekInfo() const
Definition: TXMLFile.h:71
TXMLEngine * XML()
Definition: TXMLFile.h:113
virtual Long64_t SysSeek(Int_t, Long64_t, Int_t)
Interface to system lseek.
Definition: TXMLFile.h:34
virtual void SetXmlLayout(EXMLLayout layout)
Change layout of objects in xml file Can be changed only for newly created file.
Definition: TXMLFile.cxx:922
virtual Long64_t GetEND() const
Definition: TXMLFile.h:63
virtual void ReadFree()
Read the FREE linked list.
Definition: TXMLFile.h:86
virtual void SetEND(Long64_t)
Definition: TXMLFile.h:91
Bool_t AddXmlComment(const char *comment)
Add comment line on the top of the xml document This line can only be seen in xml editor and cannot b...
Definition: TXMLFile.cxx:976
TKeyXML * FindDirKey(TDirectory *dir)
Search for key which correspond to directory dir.
Definition: TXMLFile.cxx:1037
static void ProduceFileNames(const char *filename, TString &fname, TString &dtdname)
function produces pair of xml and dtd file names
Definition: TXMLFile.cxx:446
virtual Int_t SysStat(Int_t, Long_t *, Long64_t *, Long_t *, Long_t *)
Return file stat information.
Definition: TXMLFile.h:35
TLine * line
@ kUseGeneralPurpose
Use the recommended general-purpose setting; moderate read / write speed and compression ratio.
Definition: Compression.h:53