Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TXMLSetup.cxx
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//________________________________________________________________________
13//
14// Class TXMLSetup is used as storage of xml file settings
15// This class is used in TXMLFile and in TXmlBuffer classes.
16// Xml settings can be coded via a string in following format
17//
18// "2xoo"
19// ||| \ .
20// || \ usage of name spaces.
21// | \ usage of DTD;
22// \ storage of TStreamerInfo objects in file;
23// layout of xml file (= 2 - specialized (default), = 3 - generic)
24//
25// For last three boolean parameters "x" means true, "o" - false
26//
27// Such string can be set as argument of TXMLFile constructor. In that
28// case new TXMLFile with such parameters will be created.
29// These settings automatically stored in xml file.
30
31//________________________________________________________________________
32
33#include "TXMLSetup.h"
34
35#include "TROOT.h"
36#include "TList.h"
37#include "TClass.h"
38#include "TStreamerElement.h"
39
40#include <iostream>
41#include <cstdlib>
42
43
44namespace xmlio {
45
46const char *Root = "root";
47const char *Setup = "setup";
48const char *ClassVersion = "version";
49const char *IOVersion = "version";
50const char *OnlyVersion = "Version";
51const char *Ptr = "ptr";
52const char *Ref = "ref";
53const char *Null = "null";
54const char *IdBase = "id";
55const char *Size = "size";
56const char *Xmlobject = "XmlObject";
57const char *Xmlkey = "XmlKey";
58const char *Cycle = "cycle";
59const char *XmlBlock = "XmlBlock";
60const char *Zip = "zip";
61const char *Object = "Object";
62const char *ObjClass = "class";
63const char *Class = "Class";
64const char *Member = "Member";
65const char *Item = "Item";
66const char *Name = "name";
67const char *Title = "title";
68const char *CreateTm = "created";
69const char *ModifyTm = "modified";
70const char *ObjectUUID = "uuid";
71const char *Type = "type";
72const char *Value = "value";
73const char *v = "v";
74const char *cnt = "cnt";
75const char *True = "true";
76const char *False = "false";
77const char *SInfos = "StreamerInfos";
78
79const char *Array = "Array";
80const char *Bool = "Bool_t";
81const char *Char = "Char_t";
82const char *Short = "Short_t";
83const char *Int = "Int_t";
84const char *Long = "Long_t";
85const char *Long64 = "Long64_t";
86const char *Float = "Float_t";
87const char *Double = "Double_t";
88const char *UChar = "UChar_t";
89const char *UShort = "UShort_t";
90const char *UInt = "UInt_t";
91const char *ULong = "ULong_t";
92const char *ULong64 = "ULong64_t";
93const char *String = "string";
94const char *CharStar = "CharStar";
95};
96
97const TString fgROOTDocNameSpaceBase = "https://root.cern.ch/doc/master/";
99
100////////////////////////////////////////////////////////////////////////////////
101/// return default value for XML setup
102
104{
105 return TString("2xoo");
106}
107
108////////////////////////////////////////////////////////////////////////////////
109/// set namespace base
110
115
116////////////////////////////////////////////////////////////////////////////////
117/// creates TXMLSetup object getting values from string
118
119TXMLSetup::TXMLSetup(const char *opt)
120{
121 ReadSetupFromStr(opt);
122}
123
124////////////////////////////////////////////////////////////////////////////////
125/// copy constructor of TXMLSetup class
126
128 : fXmlLayout(src.fXmlLayout), fStoreStreamerInfos(src.fStoreStreamerInfos), fUseDtd(src.fUseDtd),
129 fUseNamespaces(src.fUseNamespaces)
130{
131}
132
133////////////////////////////////////////////////////////////////////////////////
134/// assign operator
135
137{
138 fXmlLayout = rhs.fXmlLayout;
139 fStoreStreamerInfos = rhs.fStoreStreamerInfos;
140 fUseDtd = rhs.fUseDtd;
141 fUseNamespaces = rhs.fUseNamespaces;
142 return *this;
143}
144
145////////////////////////////////////////////////////////////////////////////////
146/// return setup values as string
147
149{
150 char setupstr[10] = "2xxx";
151
152 setupstr[0] = char(48 + fXmlLayout);
153 setupstr[1] = fStoreStreamerInfos ? 'x' : 'o';
154 setupstr[2] = fUseDtd ? 'x' : 'o';
155 setupstr[3] = fUseNamespaces ? 'x' : 'o';
156
157 return TString(setupstr);
158}
159
160////////////////////////////////////////////////////////////////////////////////
161/// checks if string is valid setup
162
164{
165 if (!setupstr || (strlen(setupstr) != 4))
166 return kFALSE;
167 TString str = setupstr;
168 str.ToLower();
169 if ((str[0] < 48) || (str[0] > 53))
170 return kFALSE;
171 for (int n = 1; n < 4; n++)
172 if ((str[n] != 'o') && (str[n] != 'x'))
173 return kFALSE;
174 return kTRUE;
175}
176
177////////////////////////////////////////////////////////////////////////////////
178/// get values from string
179
181{
182 if (!setupstr || (strlen(setupstr) < 4))
183 return kFALSE;
184 Int_t lay = EXMLLayout(setupstr[0] - 48);
185 if (lay == kGeneralized)
187 else
189
190 fStoreStreamerInfos = setupstr[1] == 'x';
191 fUseDtd = kFALSE;
192 fUseNamespaces = setupstr[3] == 'x';
193 return kTRUE;
194}
195
196////////////////////////////////////////////////////////////////////////////////
197/// show setup values
198
200{
201 std::cout << " *** Setup printout ***" << std::endl;
202 std::cout << "Attribute mode = " << fXmlLayout << std::endl;
203 std::cout << "Store streamer infos = " << (fStoreStreamerInfos ? "true" : "false") << std::endl;
204 std::cout << "Use dtd = " << (fUseDtd ? "true" : "false") << std::endl;
205 std::cout << "Use name spaces = " << (fUseNamespaces ? "true" : "false") << std::endl;
206}
207
208////////////////////////////////////////////////////////////////////////////////
209/// convert class name to exclude any special symbols like ':', '<' '>' ',' and spaces
210
212{
213 fStrBuf = clname;
214 fStrBuf.ReplaceAll("<", "_");
215 fStrBuf.ReplaceAll(">", "_");
216 fStrBuf.ReplaceAll(",", "_");
217 fStrBuf.ReplaceAll(" ", "_");
218 fStrBuf.ReplaceAll(":", "_");
219 return fStrBuf.Data();
220}
221
222////////////////////////////////////////////////////////////////////////////////
223/// produce string which used as reference in class namespace definition
224
226{
230 fStrBuf += "class";
231 fStrBuf += clname;
232 fStrBuf += ".html";
233 }
234 else {
235 fStrBuf += clname;
236 }
237 return fStrBuf.Data();
238}
239
240////////////////////////////////////////////////////////////////////////////////
241/// return converted name for TStreamerElement
242
244{
245 if (!el)
246 return nullptr;
247 if (!el->InheritsFrom(TStreamerSTL::Class()))
248 return el->GetName();
249 if (strcmp(el->GetName(), el->GetClassPointer()->GetName()) != 0)
250 return el->GetName();
251 return XmlConvertClassName(el->GetName());
252}
253
254////////////////////////////////////////////////////////////////////////////////
255/// get item name for given element
256
258{
259 if (!el)
260 return nullptr;
261 fStrBuf = el->GetName();
262 fStrBuf += "_item";
263 return fStrBuf.Data();
264}
265
266////////////////////////////////////////////////////////////////////////////////
267/// define class for the converted class name, where
268/// special symbols were replaced by '_'
269
271{
272 if (!strchr(xmlClassName, '_'))
274
275 TIter iter(gROOT->GetListOfClasses());
276 TClass *cl = nullptr;
277 while ((cl = (TClass *)iter()) != nullptr) {
278 const char *name = XmlConvertClassName(cl->GetName());
279 if (strcmp(xmlClassName, name) == 0)
280 return cl;
281 }
282 return nullptr;
283}
284
285////////////////////////////////////////////////////////////////////////////////
286/// converts string to integer.
287/// if error, returns default value
288
289Int_t TXMLSetup::AtoI(const char *sbuf, Int_t def, const char *errinfo)
290{
291 if (sbuf)
292 return atoi(sbuf);
293 if (errinfo)
294 std::cerr << "<Error in TXMLSetup::AtoI>" << errinfo << " not valid integer: sbuf <NULL>" << std::endl;
295 return def;
296}
constexpr Bool_t kFALSE
Definition RtypesCore.h:108
constexpr Bool_t kTRUE
Definition RtypesCore.h:107
ROOT::Detail::TRangeCast< T, true > TRangeDynCast
TRangeDynCast is an adapter class that allows the typed iteration through a TCollection.
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t src
char name[80]
Definition TGX11.cxx:110
#define gROOT
Definition TROOT.h:411
const TString fgROOTDocNameSpaceBase
Definition TXMLSetup.cxx:97
TClass instances represent classes, structs and namespaces in the ROOT type system.
Definition TClass.h:84
static TClass * GetClass(const char *name, Bool_t load=kTRUE, Bool_t silent=kFALSE)
Static method returning pointer to TClass of the specified class name.
Definition TClass.cxx:2973
const char * GetName() const override
Returns name of object.
Definition TNamed.h:49
Describe one element (data member) to be Streamed.
static TClass * Class()
Basic string class.
Definition TString.h:138
void ToLower()
Change string to lower-case.
Definition TString.cxx:1189
const char * Data() const
Definition TString.h:384
TString & ReplaceAll(const TString &s1, const TString &s2)
Definition TString.h:712
Bool_t fUseNamespaces
Definition TXMLSetup.h:128
TClass * XmlDefineClass(const char *xmlClassName)
define class for the converted class name, where special symbols were replaced by '_'
const char * XmlClassNameSpaceRef(const TClass *cl)
produce string which used as reference in class namespace definition
static void SetNameSpaceBase(const char *namespacebase)
set namespace base
Bool_t fUseDtd
Definition TXMLSetup.h:127
const char * XmlConvertClassName(const char *name)
convert class name to exclude any special symbols like ':', '<' '>' ',' and spaces
TString GetSetupAsString()
return setup values as string
Bool_t IsValidXmlSetup(const char *setupstr)
checks if string is valid setup
Bool_t ReadSetupFromStr(const char *setupstr)
get values from string
const char * GetElItemName(TStreamerElement *el)
get item name for given element
Int_t AtoI(const char *sbuf, Int_t def=0, const char *errinfo=nullptr)
converts string to integer.
static TString DefaultXmlSetup()
return default value for XML setup
const char * XmlGetElementName(const TStreamerElement *el)
return converted name for TStreamerElement
TXMLSetup()=default
EXMLLayout fXmlLayout
Definition TXMLSetup.h:125
Bool_t fStoreStreamerInfos
Definition TXMLSetup.h:126
static TString fgNameSpaceBase
buffer, used in XmlDefineClass() function
Definition TXMLSetup.h:134
TString fStrBuf
counter , used to build id of xml references
Definition TXMLSetup.h:132
void PrintSetup()
show setup values
@ kSpecialized
Definition TXMLSetup.h:84
@ kGeneralized
Definition TXMLSetup.h:84
TXMLSetup & operator=(const TXMLSetup &rhs)
assign operator
const Int_t n
Definition legend1.C:16
const char * UChar
Definition TXMLSetup.cxx:88
const char * Root
Definition TXMLSetup.cxx:46
const char * Ptr
Definition TXMLSetup.cxx:51
const char * Name
Definition TXMLSetup.cxx:66
const char * SInfos
Definition TXMLSetup.cxx:77
const char * IOVersion
Definition TXMLSetup.cxx:49
const char * v
Definition TXMLSetup.cxx:73
const char * Xmlobject
Definition TXMLSetup.cxx:56
const char * Long64
Definition TXMLSetup.cxx:85
const char * ModifyTm
Definition TXMLSetup.cxx:69
const char * False
Definition TXMLSetup.cxx:76
const char * True
Definition TXMLSetup.cxx:75
const char * Int
Definition TXMLSetup.cxx:83
const char * ULong64
Definition TXMLSetup.cxx:92
const char * Member
Definition TXMLSetup.cxx:64
const char * OnlyVersion
Definition TXMLSetup.cxx:50
const char * Long
Definition TXMLSetup.cxx:84
const char * Title
Definition TXMLSetup.cxx:67
const char * Float
Definition TXMLSetup.cxx:86
const char * Array
Definition TXMLSetup.cxx:79
const char * ClassVersion
Definition TXMLSetup.cxx:48
const char * String
Definition TXMLSetup.cxx:93
const char * Double
Definition TXMLSetup.cxx:87
const char * Object
Definition TXMLSetup.cxx:61
const char * Ref
Definition TXMLSetup.cxx:52
const char * cnt
Definition TXMLSetup.cxx:74
const char * IdBase
Definition TXMLSetup.cxx:54
const char * Size
Definition TXMLSetup.cxx:55
const char * XmlBlock
Definition TXMLSetup.cxx:59
const char * Cycle
Definition TXMLSetup.cxx:58
const char * Null
Definition TXMLSetup.cxx:53
const char * Char
Definition TXMLSetup.cxx:81
const char * UShort
Definition TXMLSetup.cxx:89
const char * CharStar
Definition TXMLSetup.cxx:94
const char * UInt
Definition TXMLSetup.cxx:90
const char * ULong
Definition TXMLSetup.cxx:91
const char * CreateTm
Definition TXMLSetup.cxx:68
const char * Class
Definition TXMLSetup.cxx:63
const char * ObjClass
Definition TXMLSetup.cxx:62
const char * Short
Definition TXMLSetup.cxx:82
const char * Zip
Definition TXMLSetup.cxx:60
const char * Setup
Definition TXMLSetup.cxx:47
const char * ObjectUUID
Definition TXMLSetup.cxx:70
const char * Xmlkey
Definition TXMLSetup.cxx:57
const char * Item
Definition TXMLSetup.cxx:65