Logo ROOT   6.12/07
Reference Guide
List of all members | Public Member Functions | Private Member Functions | Private Attributes | List of all members
TEnv Class Reference

The TEnv class reads config files, by default named .rootrc.

Three types of config files are read: global, user and local files. The global file is $ROOTSYS/etc/system<name> (or ROOTETCDIR/system<name>) the user file is $HOME/<name> and the local file is ./<name>. By setting the shell variable ROOTENV_NO_HOME=1 the reading of the $HOME/<name> resource file will be skipped. This might be useful in case the home directory resides on an auto-mounted remote file system and one wants to avoid this file system from being mounted.

The format of the .rootrc file is similar to the .Xdefaults format:

[+]<SystemName>.<RootName|ProgName>.<name>[(type)]: <value>

Where <SystemName> is either Unix, WinNT, MacOS or Vms, <RootName> the name as given in the TApplication ctor (or "RootApp" in case no explicit TApplication derived object was created), <ProgName> the current program name and <name> the resource name, with optionally a type specification. <value> can be either a string, an integer, a float/double or a boolean with the values TRUE, FALSE, ON, OFF, YES, NO, OK, NOT. Booleans will be returned as an integer 0 or 1. The options [+] allows the concatenation of values to the same resource name.

E.g.:

Unix.Rint.Root.DynamicPath: .:$(ROOTSYS)/lib:~/lib
myapp.Root.Debug: FALSE
TH.Root.Debug: YES
*.Root.MemStat: 1

<SystemName> and <ProgName> or <RootName> may be the wildcard "*". A # in the first column starts comment line.

Note that the environment variables (like $ROOTSYS) need to be surrounded in parentheses in order to be expanded.

For the currently defined resources (and their default values) see $ROOTSYS/etc/system.rootrc.

Note that the .rootrc config files contain the config for all ROOT based applications.

To add new entries to a TEnv:

TEnv env(".myfile");
env.SetValue("myname","value");
env.SaveLevel(kEnvLocal);

All new entries will be saved in the file corresponding to the first SaveLevel() command. If Save() is used, new entries go into the local file by default.

Definition at line 125 of file TEnv.h.

Public Member Functions

 TEnv (const char *name="")
 Create a resource table and read the (possibly) three resource files, i.e $ROOTSYS/etc/system<name> (or ROOTETCDIR/system<name>), $HOME/<name> and `. More...
 
virtual ~TEnv ()
 Delete the resource table. More...
 
Bool_t Defined (const char *name) const
 
virtual const char * GetRcName () const
 
THashListGetTable () const
 
virtual Int_t GetValue (const char *name, Int_t dflt) const
 Returns the integer value for a resource. More...
 
virtual Double_t GetValue (const char *name, Double_t dflt) const
 Returns the double value for a resource. More...
 
virtual const char * GetValue (const char *name, const char *dflt) const
 Returns the character value for a named resource. More...
 
Bool_t IgnoreDuplicates (Bool_t ignore)
 If set to true, no warnings in case of duplicates are issued. More...
 
virtual TEnvRecLookup (const char *n) const
 Loop over all resource records and return the one with name. More...
 
virtual void Print (Option_t *option="") const
 Print all resources or the global, user or local resources separately. More...
 
virtual void PrintEnv (EEnvLevel level=kEnvAll) const
 Print all resources for a certain level (global, user, local, changed). More...
 
virtual Int_t ReadFile (const char *fname, EEnvLevel level)
 Read and parse the resource file for a certain level. More...
 
virtual void Save ()
 Write the resource files for each level. More...
 
virtual void SaveLevel (EEnvLevel level)
 Write the resource file for a certain level. More...
 
virtual void SetRcName (const char *name)
 
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. More...
 
virtual void SetValue (const char *name, EEnvLevel level=kEnvChange)
 Set the value of a resource or create a new resource. More...
 
virtual void SetValue (const char *name, Int_t value)
 Set or create an integer resource value. More...
 
virtual void SetValue (const char *name, Double_t value)
 Set or create a double resource value. More...
 
virtual Int_t WriteFile (const char *fname, EEnvLevel level=kEnvAll)
 Write resource records to file fname for a certain level. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Checked and record whether for this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Private Member Functions

 TEnv (const TEnv &)
 
const char * Getvalue (const char *name) const
 Returns the character value for a named resource. More...
 
TEnvoperator= (const TEnv &)
 

Private Attributes

Bool_t fIgnoreDup
 
TString fRcName
 
THashListfTable
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

#include <TEnv.h>

Inheritance diagram for TEnv:
[legend]

Constructor & Destructor Documentation

◆ TEnv() [1/2]

TEnv::TEnv ( const TEnv )
private

◆ TEnv() [2/2]

TEnv::TEnv ( const char *  name = "")

Create a resource table and read the (possibly) three resource files, i.e $ROOTSYS/etc/system<name> (or ROOTETCDIR/system<name>), $HOME/<name> and `.

/`<name>. ROOT always reads ".rootrc" (in TROOT::InitSystem()). You can read additional user defined resource files by creating additional TEnv objects. By setting the shell variable ROOTENV_NO_HOME=1 the reading of the $HOME/<name> resource file will be skipped. This might be useful in case the home directory resides on an auto-mounted remote file system and one wants to avoid the file system from being mounted.

Definition at line 401 of file TEnv.cxx.

◆ ~TEnv()

TEnv::~TEnv ( )
virtual

Delete the resource table.

Definition at line 430 of file TEnv.cxx.

Member Function Documentation

◆ Defined()

Bool_t TEnv::Defined ( const char *  name) const
inline

Definition at line 142 of file TEnv.h.

◆ GetRcName()

virtual const char* TEnv::GetRcName ( ) const
inlinevirtual

Definition at line 145 of file TEnv.h.

◆ GetTable()

THashList* TEnv::GetTable ( ) const
inline

Definition at line 141 of file TEnv.h.

◆ Getvalue()

const char * TEnv::Getvalue ( const char *  name) const
private

Returns the character value for a named resource.

Definition at line 441 of file TEnv.cxx.

◆ GetValue() [1/3]

Int_t TEnv::GetValue ( const char *  name,
Int_t  dflt 
) const
virtual

Returns the integer value for a resource.

If the resource is not found return the default value.

Definition at line 491 of file TEnv.cxx.

◆ GetValue() [2/3]

Double_t TEnv::GetValue ( const char *  name,
Double_t  dflt 
) const
virtual

Returns the double value for a resource.

If the resource is not found return the default value.

Definition at line 518 of file TEnv.cxx.

◆ GetValue() [3/3]

const char * TEnv::GetValue ( const char *  name,
const char *  dflt 
) const
virtual

Returns the character value for a named resource.

If the resource is not found the default value is returned.

Definition at line 535 of file TEnv.cxx.

◆ IgnoreDuplicates()

Bool_t TEnv::IgnoreDuplicates ( Bool_t  ignore)

If set to true, no warnings in case of duplicates are issued.

Returns previous value.

Definition at line 793 of file TEnv.cxx.

◆ Lookup()

TEnvRec * TEnv::Lookup ( const char *  name) const
virtual

Loop over all resource records and return the one with name.

Return 0 in case name is not in the resource table.

Definition at line 547 of file TEnv.cxx.

◆ operator=()

TEnv& TEnv::operator= ( const TEnv )
private

◆ Print()

void TEnv::Print ( Option_t option = "") const
virtual

Print all resources or the global, user or local resources separately.

Reimplemented from TObject.

Definition at line 556 of file TEnv.cxx.

◆ PrintEnv()

void TEnv::PrintEnv ( EEnvLevel  level = kEnvAll) const
virtual

Print all resources for a certain level (global, user, local, changed).

Definition at line 574 of file TEnv.cxx.

◆ ReadFile()

Int_t TEnv::ReadFile ( const char *  fname,
EEnvLevel  level 
)
virtual

Read and parse the resource file for a certain level.

Returns -1 on case of error, 0 in case of success.

Definition at line 592 of file TEnv.cxx.

◆ Save()

void TEnv::Save ( )
virtual

Write the resource files for each level.

The new files have the same name as the original files. The old files are renamed to *.bak.

Definition at line 649 of file TEnv.cxx.

◆ SaveLevel()

void TEnv::SaveLevel ( EEnvLevel  level)
virtual

Write the resource file for a certain level.

Definition at line 664 of file TEnv.cxx.

◆ SetRcName()

virtual void TEnv::SetRcName ( const char *  name)
inlinevirtual

Definition at line 146 of file TEnv.h.

◆ SetValue() [1/4]

void TEnv::SetValue ( const char *  name,
const char *  value,
EEnvLevel  level = kEnvChange,
const char *  type = 0 
)
virtual

Set the value of a resource or create a new resource.

Definition at line 736 of file TEnv.cxx.

◆ SetValue() [2/4]

void TEnv::SetValue ( const char *  name,
EEnvLevel  level = kEnvChange 
)
virtual

Set the value of a resource or create a new resource.

Use this method to set a resource like, "name=val". If just "name" is given it will be interpreted as "name=1".

Definition at line 761 of file TEnv.cxx.

◆ SetValue() [3/4]

void TEnv::SetValue ( const char *  name,
Int_t  value 
)
virtual

Set or create an integer resource value.

Definition at line 776 of file TEnv.cxx.

◆ SetValue() [4/4]

void TEnv::SetValue ( const char *  name,
Double_t  value 
)
virtual

Set or create a double resource value.

Definition at line 784 of file TEnv.cxx.

◆ WriteFile()

Int_t TEnv::WriteFile ( const char *  fname,
EEnvLevel  level = kEnvAll 
)
virtual

Write resource records to file fname for a certain level.

Use level kEnvAll to write all resources. Returns -1 on case of error, 0 in case of success.

Definition at line 617 of file TEnv.cxx.

Member Data Documentation

◆ fIgnoreDup

Bool_t TEnv::fIgnoreDup
private

Definition at line 130 of file TEnv.h.

◆ fRcName

TString TEnv::fRcName
private

Definition at line 129 of file TEnv.h.

◆ fTable

THashList* TEnv::fTable
private

Definition at line 128 of file TEnv.h.

Libraries for TEnv:
[legend]

The documentation for this class was generated from the following files: