Logo ROOT  
Reference Guide
TEnv.h
Go to the documentation of this file.
1// @(#)root/base:$Id$
2// Author: Fons Rademakers 22/09/95
3
4/*************************************************************************
5 * Copyright (C) 1995-2000, 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_TEnv
13#define ROOT_TEnv
14
15
16//////////////////////////////////////////////////////////////////////////
17// //
18// TEnv //
19// //
20// The TEnv class reads config files, by default named .rootrc. Three //
21// types of config files are read: global, user and local files. The //
22// global file is $ROOTSYS/etc/system<name> (or ROOTETCDIR/system<name>)//
23// the user file is $HOME/<name> and the local file is ./<name>. //
24// By setting the shell variable ROOTENV_NO_HOME=1 the reading of //
25// the $HOME/<name> resource file will be skipped. This might be useful //
26// in case the home directory resides on an automounted remote file //
27// system and one wants to avoid this file system from being mounted. //
28// //
29// The format of the .rootrc file is similar to the .Xdefaults format: //
30// //
31// [+]<SystemName>.<RootName|ProgName>.<name>[(type)]: <value> //
32// //
33// Where <SystemName> is either Unix, WinNT, MacOS or Vms, //
34// <RootName> the name as given in the TApplication ctor (or "RootApp" //
35// in case no explicit TApplication derived object was created), //
36// <ProgName> the current program name and <name> the resource name, //
37// with optionally a type specification. <value> can be either a //
38// string, an integer, a float/double or a boolean with the values //
39// TRUE, FALSE, ON, OFF, YES, NO, OK, NOT. Booleans will be returned as //
40// an integer 0 or 1. The options [+] allows the concatenation of //
41// values to the same resouce name. //
42// //
43// E.g.: //
44// //
45// Unix.Rint.Root.DynamicPath: .:$ROOTSYS/lib:~/lib //
46// myapp.Root.Debug: FALSE //
47// TH.Root.Debug: YES //
48// *.Root.MemStat: 1 //
49// //
50// <SystemName> and <ProgName> or <RootName> may be the wildcard "*". //
51// A # in the first column starts comment line. //
52// //
53// For the currently defined resources (and their default values) see //
54// $ROOTSYS/etc/system.rootrc. //
55// //
56// Note that the .rootrc config files contain the config for all ROOT //
57// based applications. //
58// //
59//////////////////////////////////////////////////////////////////////////
60
61#include "TObject.h"
62#include "TString.h"
63
64class THashList;
65class TEnv;
66class TEnvParser;
67class TReadEnvParser;
68class TWriteEnvParser;
69
76};
77
78
79//////////////////////////////////////////////////////////////////////////
80// //
81// TEnvRec //
82// //
83// Individual TEnv records. //
84// //
85//////////////////////////////////////////////////////////////////////////
86
87class TEnvRec : public TObject {
88
89friend class TEnv;
90friend class TEnvParser;
91friend class TReadEnvParser;
92friend class TWriteEnvParser;
93
94private:
95 TString fName; // env rec key name
96 TString fType; // env rec type
97 TString fValue; // env rec value
98 EEnvLevel fLevel; // env rec level
99 Bool_t fModified; // if env rec has been modified
100
101 TEnvRec(const char *n, const char *v, const char *t, EEnvLevel l);
102 Int_t Compare(const TObject *obj) const;
103 void ChangeValue(const char *v, const char *t, EEnvLevel l,
104 Bool_t append = kFALSE, Bool_t ignoredup = kFALSE);
105 TString ExpandValue(const char *v);
106
107public:
109 ~TEnvRec();
110 const char *GetName() const { return fName; }
111 const char *GetValue() const { return fValue; }
112 const char *GetType() const { return fType; }
113 EEnvLevel GetLevel() const { return fLevel; }
114 ULong_t Hash() const { return fName.Hash(); }
115
116 ClassDef(TEnvRec,2) // Individual TEnv records
117};
118
119//////////////////////////////////////////////////////////////////////////
120// //
121// TEnv //
122// //
123//////////////////////////////////////////////////////////////////////////
124
125class TEnv : public TObject {
126
127private:
128 THashList *fTable; // hash table containing env records
129 TString fRcName; // resource file base name
130 Bool_t fIgnoreDup; // ignore duplicates, don't issue warning
131
132 TEnv(const TEnv&); // not implemented
133 TEnv& operator=(const TEnv&); // not implemented
134
135 const char *Getvalue(const char *name) const;
136
137public:
138 TEnv(const char *name="");
139 virtual ~TEnv();
140
141 THashList *GetTable() const { return fTable; }
142 Bool_t Defined(const char *name) const
143 { return Getvalue(name) != 0; }
144
145 virtual const char *GetRcName() const { return fRcName; }
146 virtual void SetRcName(const char *name) { fRcName = name; }
147
148 virtual Int_t GetValue(const char *name, Int_t dflt) const;
149 virtual Double_t GetValue(const char *name, Double_t dflt) const;
150 virtual const char *GetValue(const char *name, const char *dflt) const;
151
152 virtual void SetValue(const char *name, const char *value,
153 EEnvLevel level = kEnvChange,
154 const char *type = 0);
155 virtual void SetValue(const char *name, EEnvLevel level = kEnvChange);
156 virtual void SetValue(const char *name, Int_t value);
157 virtual void SetValue(const char *name, Double_t value);
158
159 virtual TEnvRec *Lookup(const char *n) const;
160 virtual Int_t ReadFile(const char *fname, EEnvLevel level);
161 virtual Int_t WriteFile(const char *fname, EEnvLevel level = kEnvAll);
162 virtual void Save();
163 virtual void SaveLevel(EEnvLevel level);
164 virtual void Print(Option_t *option="") const;
165 virtual void PrintEnv(EEnvLevel level = kEnvAll) const;
167
168 ClassDef(TEnv,2) // Handle ROOT configuration resources
169};
170
172
173#endif
int Int_t
Definition: CPyCppyy.h:43
unsigned long ULong_t
Definition: CPyCppyy.h:51
#define R__EXTERN
Definition: DllImport.h:27
const Bool_t kFALSE
Definition: RtypesCore.h:90
bool Bool_t
Definition: RtypesCore.h:61
double Double_t
Definition: RtypesCore.h:57
const Bool_t kTRUE
Definition: RtypesCore.h:89
const char Option_t
Definition: RtypesCore.h:64
#define ClassDef(name, id)
Definition: Rtypes.h:322
R__EXTERN TEnv * gEnv
Definition: TEnv.h:171
EEnvLevel
Definition: TEnv.h:70
@ kEnvUser
Definition: TEnv.h:72
@ kEnvChange
Definition: TEnv.h:74
@ kEnvAll
Definition: TEnv.h:75
@ kEnvGlobal
Definition: TEnv.h:71
@ kEnvLocal
Definition: TEnv.h:73
char name[80]
Definition: TGX11.cxx:109
Definition: TEnv.h:87
TString fValue
Definition: TEnv.h:97
void ChangeValue(const char *v, const char *t, EEnvLevel l, Bool_t append=kFALSE, Bool_t ignoredup=kFALSE)
Change the value of a resource.
Definition: TEnv.cxx:292
EEnvLevel fLevel
Definition: TEnv.h:98
friend class TReadEnvParser
Definition: TEnv.h:91
EEnvLevel GetLevel() const
Definition: TEnv.h:113
TEnvRec()
Definition: TEnv.h:108
TString ExpandValue(const char *v)
Replace all strings by the value defined in the shell (obtained via TSystem::Getenv()).
Definition: TEnv.cxx:333
ULong_t Hash() const
Return hash value for this object.
Definition: TEnv.h:114
const char * GetName() const
Returns name of object.
Definition: TEnv.h:110
TString fName
Definition: TEnv.h:95
Int_t Compare(const TObject *obj) const
Comparison function for resources.
Definition: TEnv.cxx:324
TString fType
Definition: TEnv.h:96
friend class TWriteEnvParser
Definition: TEnv.h:92
Bool_t fModified
Definition: TEnv.h:99
const char * GetType() const
Definition: TEnv.h:112
const char * GetValue() const
Definition: TEnv.h:111
~TEnvRec()
TNamed destructor.
Definition: TEnv.cxx:283
friend class TEnvParser
Definition: TEnv.h:90
The TEnv class reads config files, by default named .rootrc.
Definition: TEnv.h:125
THashList * fTable
Definition: TEnv.h:128
TEnv(const TEnv &)
virtual void PrintEnv(EEnvLevel level=kEnvAll) const
Print all resources for a certain level (global, user, local, changed).
Definition: TEnv.cxx:574
virtual Int_t GetValue(const char *name, Int_t dflt) const
Returns the integer value for a resource.
Definition: TEnv.cxx:491
TString fRcName
Definition: TEnv.h:129
virtual Int_t WriteFile(const char *fname, EEnvLevel level=kEnvAll)
Write resource records to file fname for a certain level.
Definition: TEnv.cxx:617
Bool_t IgnoreDuplicates(Bool_t ignore)
If set to true, no warnings in case of duplicates are issued.
Definition: TEnv.cxx:793
virtual void SetRcName(const char *name)
Definition: TEnv.h:146
virtual Int_t ReadFile(const char *fname, EEnvLevel level)
Read and parse the resource file for a certain level.
Definition: TEnv.cxx:592
TEnv & operator=(const TEnv &)
virtual TEnvRec * Lookup(const char *n) const
Loop over all resource records and return the one with name.
Definition: TEnv.cxx:547
virtual void Save()
Write the resource files for each level.
Definition: TEnv.cxx:649
Bool_t Defined(const char *name) const
Definition: TEnv.h:142
Bool_t fIgnoreDup
Definition: TEnv.h:130
virtual void SetValue(const char *name, const char *value, EEnvLevel level=kEnvChange, const char *type=0)
Set the value of a resource or create a new resource.
Definition: TEnv.cxx:736
THashList * GetTable() const
Definition: TEnv.h:141
const char * Getvalue(const char *name) const
Returns the character value for a named resource.
Definition: TEnv.cxx:441
virtual void Print(Option_t *option="") const
Print all resources or the global, user or local resources separately.
Definition: TEnv.cxx:556
virtual void SaveLevel(EEnvLevel level)
Write the resource file for a certain level.
Definition: TEnv.cxx:664
virtual ~TEnv()
Delete the resource table.
Definition: TEnv.cxx:430
virtual const char * GetRcName() const
Definition: TEnv.h:145
THashList implements a hybrid collection class consisting of a hash table and a list to store TObject...
Definition: THashList.h:34
Mother of all ROOT objects.
Definition: TObject.h:37
Basic string class.
Definition: TString.h:131
UInt_t Hash(ECaseCompare cmp=kExact) const
Return hash value.
Definition: TString.cxx:638
const Int_t n
Definition: legend1.C:16
auto * l
Definition: textangle.C:4