Logo ROOT  

Reference Guide
TXMLSetup.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_TXMLSetup
13#define ROOT_TXMLSetup
14
15#include "TObject.h"
16#include "TString.h"
17
18#ifdef Bool
19#undef Bool
20#endif
21#ifdef True
22#undef True
23#endif
24#ifdef False
25#undef False
26#endif
27
28namespace xmlio {
29extern const char *Root;
30extern const char *Setup;
31extern const char *ClassVersion;
32extern const char *IOVersion;
33extern const char *OnlyVersion;
34extern const char *Ptr;
35extern const char *Ref;
36extern const char *Null;
37extern const char *IdBase;
38extern const char *Size;
39extern const char *Xmlobject;
40extern const char *Xmlkey;
41extern const char *Cycle;
42extern const char *XmlBlock;
43extern const char *Zip;
44extern const char *Object;
45extern const char *ObjClass;
46extern const char *Class;
47extern const char *Member;
48extern const char *Item;
49extern const char *Name;
50extern const char *Title;
51extern const char *CreateTm;
52extern const char *ModifyTm;
53extern const char *ObjectUUID;
54extern const char *Type;
55extern const char *Value;
56extern const char *v;
57extern const char *cnt;
58extern const char *True;
59extern const char *False;
60extern const char *SInfos;
61
62extern const char *Array;
63extern const char *Bool;
64extern const char *Char;
65extern const char *Short;
66extern const char *Int;
67extern const char *Long;
68extern const char *Long64;
69extern const char *Float;
70extern const char *Double;
71extern const char *UChar;
72extern const char *UShort;
73extern const char *UInt;
74extern const char *ULong;
75extern const char *ULong64;
76extern const char *String;
77extern const char *CharStar;
78}
79
80class TStreamerElement;
81
82class TXMLSetup {
83public:
84 enum EXMLLayout { kSpecialized = 2, kGeneralized = 3 };
85
86 TXMLSetup() = default;
87 TXMLSetup(const char *opt);
88 TXMLSetup(const TXMLSetup &src);
89 virtual ~TXMLSetup() = default;
90
91 TXMLSetup &operator=(const TXMLSetup &rhs);
92
93 TString GetSetupAsString();
94
95 void PrintSetup();
96
97 EXMLLayout GetXmlLayout() const { return fXmlLayout; }
98 Bool_t IsStoreStreamerInfos() const { return fStoreStreamerInfos; }
99 Bool_t IsUseDtd() const { return fUseDtd; }
100 Bool_t IsUseNamespaces() const { return fUseNamespaces; }
101
102 virtual void SetXmlLayout(EXMLLayout layout) { fXmlLayout = layout; }
103 virtual void SetStoreStreamerInfos(Bool_t iConvert = kTRUE) { fStoreStreamerInfos = iConvert; }
104 virtual void SetUsedDtd(Bool_t use = kTRUE) { fUseDtd = use; }
105 virtual void SetUseNamespaces(Bool_t iUseNamespaces = kTRUE) { fUseNamespaces = iUseNamespaces; }
106
107 const char *XmlConvertClassName(const char *name);
108 const char *XmlClassNameSpaceRef(const TClass *cl);
109 const char *XmlGetElementName(const TStreamerElement *el);
110
111 Int_t GetNextRefCounter() { return fRefCounter++; }
112
113 static TString DefaultXmlSetup();
114 static void SetNameSpaceBase(const char *namespacebase);
115
116protected:
117 TClass *XmlDefineClass(const char *xmlClassName);
118 const char *GetElItemName(TStreamerElement *el);
119
120 Bool_t IsValidXmlSetup(const char *setupstr);
121 Bool_t ReadSetupFromStr(const char *setupstr);
122
123 Int_t AtoI(const char *sbuf, Int_t def = 0, const char *errinfo = nullptr);
124
125 EXMLLayout fXmlLayout{kSpecialized};
126 Bool_t fStoreStreamerInfos{kTRUE};
127 Bool_t fUseDtd{kFALSE};
128 Bool_t fUseNamespaces{kFALSE};
129
130 Int_t fRefCounter{0}; //! counter , used to build id of xml references
131
132 TString fStrBuf; //! buffer, used in XmlDefineClass() function
133
134 static TString fgNameSpaceBase;
135
136 ClassDef(TXMLSetup, 1) // settings to be stored in XML files
137};
138
139#endif
Int_t
int Int_t
Definition: RtypesCore.h:43
kFALSE
const Bool_t kFALSE
Definition: RtypesCore.h:90
Bool_t
bool Bool_t
Definition: RtypesCore.h:61
kTRUE
const Bool_t kTRUE
Definition: RtypesCore.h:89
ClassDef
#define ClassDef(name, id)
Definition: Rtypes.h:322
name
char name[80]
Definition: TGX11.cxx:109
TClass
TClass instances represent classes, structs and namespaces in the ROOT type system.
Definition: TClass.h:80
TString
Basic string class.
Definition: TString.h:131
TXMLSetup::SetUsedDtd
virtual void SetUsedDtd(Bool_t use=kTRUE)
Definition: TXMLSetup.h:104
TXMLSetup::fUseNamespaces
Bool_t fUseNamespaces
Definition: TXMLSetup.h:128
TXMLSetup::XmlDefineClass
TClass * XmlDefineClass(const char *xmlClassName)
define class for the converted class name, where special symbols were replaced by '_'
Definition: TXMLSetup.cxx:264
TXMLSetup::XmlClassNameSpaceRef
const char * XmlClassNameSpaceRef(const TClass *cl)
produce string which used as reference in class namespace definition
Definition: TXMLSetup.cxx:224
TXMLSetup::GetXmlLayout
EXMLLayout GetXmlLayout() const
Definition: TXMLSetup.h:97
TXMLSetup::SetNameSpaceBase
static void SetNameSpaceBase(const char *namespacebase)
set namespace base
Definition: TXMLSetup.cxx:110
TXMLSetup::SetUseNamespaces
virtual void SetUseNamespaces(Bool_t iUseNamespaces=kTRUE)
Definition: TXMLSetup.h:105
TXMLSetup::fUseDtd
Bool_t fUseDtd
Definition: TXMLSetup.h:127
TXMLSetup::XmlConvertClassName
const char * XmlConvertClassName(const char *name)
convert class name to exclude any special symbols like ':', '<' '>' ',' and spaces
Definition: TXMLSetup.cxx:210
TXMLSetup::GetSetupAsString
TString GetSetupAsString()
return setup values as string
Definition: TXMLSetup.cxx:147
TXMLSetup::IsValidXmlSetup
Bool_t IsValidXmlSetup(const char *setupstr)
checks if string is valid setup
Definition: TXMLSetup.cxx:162
TXMLSetup::ReadSetupFromStr
Bool_t ReadSetupFromStr(const char *setupstr)
get values from string
Definition: TXMLSetup.cxx:179
TXMLSetup::GetElItemName
const char * GetElItemName(TStreamerElement *el)
get item name for given element
Definition: TXMLSetup.cxx:251
TXMLSetup::AtoI
Int_t AtoI(const char *sbuf, Int_t def=0, const char *errinfo=nullptr)
converts string to integer.
Definition: TXMLSetup.cxx:283
TXMLSetup::IsStoreStreamerInfos
Bool_t IsStoreStreamerInfos() const
Definition: TXMLSetup.h:98
TXMLSetup::DefaultXmlSetup
static TString DefaultXmlSetup()
return default value for XML setup
Definition: TXMLSetup.cxx:102
TXMLSetup::XmlGetElementName
const char * XmlGetElementName(const TStreamerElement *el)
return converted name for TStreamerElement
Definition: TXMLSetup.cxx:237
TXMLSetup::IsUseDtd
Bool_t IsUseDtd() const
Definition: TXMLSetup.h:99
TXMLSetup::TXMLSetup
TXMLSetup()=default
TXMLSetup::fXmlLayout
EXMLLayout fXmlLayout
Definition: TXMLSetup.h:125
TXMLSetup::GetNextRefCounter
Int_t GetNextRefCounter()
Definition: TXMLSetup.h:111
TXMLSetup::fStoreStreamerInfos
Bool_t fStoreStreamerInfos
Definition: TXMLSetup.h:126
TXMLSetup::fRefCounter
Int_t fRefCounter
Definition: TXMLSetup.h:130
TXMLSetup::fgNameSpaceBase
static TString fgNameSpaceBase
buffer, used in XmlDefineClass() function
Definition: TXMLSetup.h:134
TXMLSetup::~TXMLSetup
virtual ~TXMLSetup()=default
TXMLSetup::fStrBuf
TString fStrBuf
counter , used to build id of xml references
Definition: TXMLSetup.h:132
TXMLSetup::IsUseNamespaces
Bool_t IsUseNamespaces() const
Definition: TXMLSetup.h:100
TXMLSetup::PrintSetup
void PrintSetup()
show setup values
Definition: TXMLSetup.cxx:198
TXMLSetup::SetStoreStreamerInfos
virtual void SetStoreStreamerInfos(Bool_t iConvert=kTRUE)
Definition: TXMLSetup.h:103
TXMLSetup::kSpecialized
@ kSpecialized
Definition: TXMLSetup.h:84
TXMLSetup::kGeneralized
@ kGeneralized
Definition: TXMLSetup.h:84
TXMLSetup::operator=
TXMLSetup & operator=(const TXMLSetup &rhs)
assign operator
Definition: TXMLSetup.cxx:135
TXMLSetup::SetXmlLayout
virtual void SetXmlLayout(EXMLLayout layout)
Definition: TXMLSetup.h:102
xmlio::UChar
const char * UChar
Definition: TXMLSetup.cxx:88
xmlio::Root
const char * Root
Definition: TXMLSetup.cxx:46
xmlio::Ptr
const char * Ptr
Definition: TXMLSetup.cxx:51
xmlio::Name
const char * Name
Definition: TXMLSetup.cxx:66
xmlio::SInfos
const char * SInfos
Definition: TXMLSetup.cxx:77
xmlio::IOVersion
const char * IOVersion
Definition: TXMLSetup.cxx:49
xmlio::v
const char * v
Definition: TXMLSetup.cxx:73
xmlio::Bool
const char * Bool
Definition: TXMLSetup.cxx:80
xmlio::Xmlobject
const char * Xmlobject
Definition: TXMLSetup.cxx:56
xmlio::Long64
const char * Long64
Definition: TXMLSetup.cxx:85
xmlio::ModifyTm
const char * ModifyTm
Definition: TXMLSetup.cxx:69
xmlio::False
const char * False
Definition: TXMLSetup.cxx:76
xmlio::True
const char * True
Definition: TXMLSetup.cxx:75
xmlio::Int
const char * Int
Definition: TXMLSetup.cxx:83
xmlio::ULong64
const char * ULong64
Definition: TXMLSetup.cxx:92
xmlio::Member
const char * Member
Definition: TXMLSetup.cxx:64
xmlio::OnlyVersion
const char * OnlyVersion
Definition: TXMLSetup.cxx:50
xmlio::Long
const char * Long
Definition: TXMLSetup.cxx:84
xmlio::Title
const char * Title
Definition: TXMLSetup.cxx:67
xmlio::Float
const char * Float
Definition: TXMLSetup.cxx:86
xmlio::Value
const char * Value
Definition: TXMLSetup.cxx:72
xmlio::Array
const char * Array
Definition: TXMLSetup.cxx:79
xmlio::ClassVersion
const char * ClassVersion
Definition: TXMLSetup.cxx:48
xmlio::String
const char * String
Definition: TXMLSetup.cxx:93
xmlio::Double
const char * Double
Definition: TXMLSetup.cxx:87
xmlio::Object
const char * Object
Definition: TXMLSetup.cxx:61
xmlio::Ref
const char * Ref
Definition: TXMLSetup.cxx:52
xmlio::cnt
const char * cnt
Definition: TXMLSetup.cxx:74
xmlio::IdBase
const char * IdBase
Definition: TXMLSetup.cxx:54
xmlio::Size
const char * Size
Definition: TXMLSetup.cxx:55
xmlio::XmlBlock
const char * XmlBlock
Definition: TXMLSetup.cxx:59
xmlio::Cycle
const char * Cycle
Definition: TXMLSetup.cxx:58
xmlio::Type
const char * Type
Definition: TXMLSetup.cxx:71
xmlio::Null
const char * Null
Definition: TXMLSetup.cxx:53
xmlio::Char
const char * Char
Definition: TXMLSetup.cxx:81
xmlio::UShort
const char * UShort
Definition: TXMLSetup.cxx:89
xmlio::CharStar
const char * CharStar
Definition: TXMLSetup.cxx:94
xmlio::UInt
const char * UInt
Definition: TXMLSetup.cxx:90
xmlio::ULong
const char * ULong
Definition: TXMLSetup.cxx:91
xmlio::CreateTm
const char * CreateTm
Definition: TXMLSetup.cxx:68
xmlio::Class
const char * Class
Definition: TXMLSetup.cxx:63
xmlio::ObjClass
const char * ObjClass
Definition: TXMLSetup.cxx:62
xmlio::Short
const char * Short
Definition: TXMLSetup.cxx:82
xmlio::Zip
const char * Zip
Definition: TXMLSetup.cxx:60
xmlio::Setup
const char * Setup
Definition: TXMLSetup.cxx:47
xmlio::ObjectUUID
const char * ObjectUUID
Definition: TXMLSetup.cxx:70
xmlio::Xmlkey
const char * Xmlkey
Definition: TXMLSetup.cxx:57
xmlio::Item
const char * Item
Definition: TXMLSetup.cxx:65