ROOT
6.06/09
Reference Guide
|
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:
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.:
<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:
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.
Public Member Functions | |
TEnv (const char *name="") | |
virtual | ~TEnv () |
Delete the resource table. More... | |
THashList * | GetTable () const |
Bool_t | Defined (const char *name) |
virtual const char * | GetRcName () const |
virtual void | SetRcName (const char *name) |
virtual Int_t | GetValue (const char *name, Int_t dflt) |
Returns the integer value for a resource. More... | |
virtual Double_t | GetValue (const char *name, Double_t dflt) |
Returns the double value for a resource. More... | |
virtual const char * | GetValue (const char *name, const char *dflt) |
Returns the character value for a named resource. More... | |
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 TEnvRec * | Lookup (const char *n) |
Loop over all resource records and return the one with name. More... | |
virtual Int_t | ReadFile (const char *fname, EEnvLevel level) |
Read and parse the resource file for a certain level. More... | |
virtual Int_t | WriteFile (const char *fname, EEnvLevel level=kEnvAll) |
Write resource records to file fname 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 | 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... | |
Bool_t | IgnoreDuplicates (Bool_t ignore) |
If set to true, no warnings in case of duplicates are issued. More... | |
Public Member Functions inherited from TObject | |
TObject () | |
TObject (const TObject &object) | |
TObject copy ctor. More... | |
TObject & | operator= (const TObject &rhs) |
TObject assignment operator. More... | |
virtual | ~TObject () |
TObject destructor. 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... | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. More... | |
virtual void | Clear (Option_t *="") |
virtual TObject * | Clone (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 TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current pad. More... | |
virtual void | Dump () const |
Dump contents of object on stdout. 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 TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. More... | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. More... | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. More... | |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. More... | |
virtual const char * | GetName () const |
Returns name of object. More... | |
virtual const char * | GetIconName () const |
Returns mime type name of object. More... | |
virtual Option_t * | GetOption () const |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). More... | |
virtual const char * | GetTitle () const |
Returns title of object. 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... | |
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... | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
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 | IsSortable () const |
Bool_t | IsOnHeap () const |
Bool_t | IsZombie () const |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification. More... | |
virtual void | ls (Option_t *option="") const |
The ls function lists the contents of a class on stdout. 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... | |
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... | |
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 | UseCurrentStyle () |
Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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... | |
void * | operator new (size_t sz) |
void * | operator new[] (size_t sz) |
void * | operator new (size_t sz, void *vp) |
void * | operator new[] (size_t sz, void *vp) |
void | operator delete (void *ptr) |
Operator delete. More... | |
void | operator delete[] (void *ptr) |
Operator delete []. 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) |
void | ResetBit (UInt_t f) |
Bool_t | TestBit (UInt_t f) const |
Int_t | TestBits (UInt_t f) const |
void | InvertBit (UInt_t f) |
virtual void | Info (const char *method, const char *msgfmt,...) const |
Issue info message. More... | |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. More... | |
virtual void | Error (const char *method, const char *msgfmt,...) const |
Issue error message. More... | |
virtual void | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. More... | |
virtual void | Fatal (const char *method, const char *msgfmt,...) const |
Issue fatal error message. 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... | |
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... | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. More... | |
Private Member Functions | |
TEnv (const TEnv &) | |
TEnv & | operator= (const TEnv &) |
const char * | Getvalue (const char *name) |
Returns the character value for a named resource. More... | |
Private Attributes | |
THashList * | fTable |
TString | fRcName |
Bool_t | fIgnoreDup |
Additional Inherited Members | |
Public Types inherited from TObject | |
enum | EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) } |
enum | { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) } |
Static Public Member Functions inherited from TObject | |
static Long_t | GetDtorOnly () |
Return destructor only flag. More... | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. More... | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. More... | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. More... | |
Protected Member Functions inherited from TObject | |
void | MakeZombie () |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). More... | |
#include <TEnv.h>
|
private |
TEnv::TEnv | ( | const char * | name = "" | ) |
|
inline |
Definition at line 145 of file TEnv.h.
Referenced by TFileIter::MapName().
|
inline |
Definition at line 144 of file TEnv.h.
Referenced by TCling::GetSharedLibDeps(), THtml::LoadAllLibs(), TPluginManager::LoadHandlersFromEnv(), TCling::LoadLibraryMap(), TSessionViewer::ReadConfiguration(), and TCling::UnloadLibraryMap().
|
private |
Returns the character value for a named resource.
Definition at line 444 of file TEnv.cxx.
Referenced by Defined(), and GetValue().
Returns the integer value for a resource.
If the resource is not found return the default value.
Definition at line 494 of file TEnv.cxx.
Referenced by TProof::AssertDataSet(), TRootAuth::Authenticate(), TSelectorDraw::Begin(), TMacro::Browse(), TMultiGraph::Browse(), TGraph::Browse(), TGeoManager::Browse(), TGSpeedo::Build(), ClassImp(), TProofLite::CleanupSandbox(), TXSocket::Close(), TProof::Collect(), TSystem::CompileMacro(), ConfigureDavixLogLevel(), TNetSystem::Create(), TProofMgr::Create(), TXSocket::Create(), TGFileBrowser::CreateBrowser(), TRootBrowserLite::CreateBrowser(), TRootGuiFactory::CreateBrowserImp(), TGSlider::CreateDisabledPicture(), TGPictureButton::CreateDisabledPicture(), TRootCanvas::CreateEditor(), ROOT::Internal::TBranchProxyDirector::CreateHistogram(), TProofLite::CreateSandbox(), TProofServLite::CreateServer(), TXProofServ::CreateServer(), TProofServ::CreateServer(), TXNetFile::CreateXClient(), DefaultErrorHandler(), ROOT::Math::MinimizerOptions::DefaultMinimizerType(), TProofDrawProfile::DefVar(), TProofDrawProfile2D::DefVar(), TProofDrawHist::DefVar1D(), TProofDrawHist::DefVar2D(), TProofDrawHist::DefVar3D(), TProof::Detach(), doBanner(), TGSpeedo::DoRedraw(), TProofProgressDialog::DoStop(), TGeoShape::Draw(), TGeoVolume::Draw(), TGeoVolume::DrawOnly(), TGSpeedo::DrawText(), DynamicPath(), TSystemFile::Edit(), TProof::EnablePackage(), TApplicationServer::ErrorHandler(), TProofServ::ErrorHandler(), TTabCom::ExcludedByFignore(), TRint::ExecLogon(), TApplicationServer::ExecLogon(), TProofServ::FilterLocalroot(), TGX11::FindBestVisual(), TUnixSystem::FindFile(), TWinNTSystem::FindFile(), TVirtualFitter::Fitter(), TPostScript::FontEmbed(), TAuthenticate::GenRSAKeys(), TSystem::GetBuildDir(), TTree::GetCacheAutoSize(), TTreeCache::GetConfiguredPrefillType(), TAuthenticate::GetDefaultDetails(), TGLFormat::GetDefaultSamples(), TWinNTSystem::GetEffectiveGid(), TWinNTSystem::GetEffectiveUid(), TDSetElement::GetEntries(), TDSet::GetEntries(), TWinNTSystem::GetGid(), TWinNTSystem::GetGroupInfo(), TSystem::GetLinkdefSuffix(), TROOT::GetMacroPath(), TProofLite::GetNumberOfWorkers(), TGLViewer::GetPictureUsingFBO(), TProofServ::GetPriority(), TProof::GetSandbox(), TProofMgrLite::GetSessionLogs(), TUrl::GetSpecialProtocols(), TFile::GetType(), TWinNTSystem::GetUid(), THtml::GetURL(), TWinNTSystem::GetUserInfo(), TXProofServ::GetWorkers(), TRootBrowser::HandleMenu(), TProofServ::HandleProcess(), TProofServ::HandleSocketInput(), TXProofServ::HandleTermination(), TXProofServ::HandleUrgentData(), TTabCom::Hook(), TDataSetManagerFile::Init(), TGX11TTF::Init(), TProofOutputFile::Init(), TProofLite::Init(), TTreeCacheUnzip::Init(), TCanvas::Init(), TFile::Init(), TSystem::Init(), TProof::Init(), init_icon_paths(), TProofLite::InitDataSetManager(), TXSocket::InitEnvs(), TGOSXGLManager::InitGLWindow(), RooStats::ToyMCStudy::initialize(), TApplication::InitializeGraphics(), TGLUtil::InitializeIfNeeded(), TDataSetManagerFile::InitLocalCache(), TProofPlayerRemote::InitPacketizer(), TRootBrowser::InitPlugins(), RooStudyPackage::initRandom(), TROOT::InitSystem(), TROOT::InitThreads(), TWinNTSystem::InitUsersGroups(), TXNetSystem::InitXrdClient(), TEventIterTree::Load(), TEventIter::LoadDir(), TVirtualPadEditor::LoadEditor(), TGApplication::LoadGraphicsLibs(), TApplication::LoadGraphicsLibs(), TPluginManager::LoadHandlersFromEnv(), TPluginManager::LoadHandlersFromPluginDirs(), TFileIter::MapName(), TProof::MarkBad(), TProofOutputFile::Merge(), TProofPlayerRemote::MergeOutput(), OldSlaveAuthSetup(), TRootContextMenu::OnlineHelp(), TXNetFile::Open(), TFile::Open(), TGX11::OpenDisplay(), TGWin32::OpenDisplay(), TGeoVolume::Paint(), TGeoShape::Paint(), TDavixFileInternal::parseConfig(), TXSocket::PickUpReady(), TProofLite::PollForNewWorkers(), TProofLite::Print(), TPad::Print(), TRootCanvas::PrintCanvas(), TSelHandleDataSet::Process(), TProofLite::Process(), TProofPlayer::Process(), TProofPlayerRemote::Process(), TS3WebFile::ProcessHttpHeader(), TRootCanvas::ProcessMessage(), TRootBrowserLite::ProcessMessage(), TProofServ::ProcessNext(), TProofProgressDialog::Progress(), TAuthenticate::PromptPasswd(), TAuthenticate::ProofAuthSetup(), TSessionViewer::ReadConfiguration(), TDatabasePDG::ReadPDGTable(), TXUnixSocket::Reconnect(), TXSocket::Reconnect(), TGLFontManager::RegisterFont(), TStyle::Reset(), TPad::SaveAs(), TGLViewer::SavePicture(), TGLViewer::SavePictureUsingFBO(), TCanvas::SaveSource(), TDataSetManager::ScanFile(), ROOT::MacOSX::Details::FontCache::SelectSymbolFont(), TGQuartz::SetAA(), TGCocoa::SetApplicationIcon(), TRootBrowserLite::SetDefaults(), TGScrollBarElement::SetEnabled(), TFileCacheRead::SetEnablePrefetchingImpl(), TNetXNGFile::SetEnv(), TXNetFile::SetEnv(), TAuthenticate::SetEnvironment(), TGLText::SetGLTextFont(), TTF::SetTextFont(), TProofServLite::Setup(), TXProofServ::Setup(), TPerfStats::Setup(), TProofServ::Setup(), TProofServ::SetupCommon(), TProofServLite::SetupOnFork(), TProofLite::SetupWorkers(), TPad::ShowGuidelines(), TEveViewer::SpawnGLViewer(), SrvAuthImpl(), SrvSetVars(), TAuthenticate::SshAuth(), TAuthenticate::SshError(), TUnixSystem::StackTrace(), TWinNTSystem::StackTrace(), TApplication::TApplication(), TAuthenticate::TAuthenticate(), TDavixFile_http_get_ucert(), TRint::Terminate(), TProofDrawGraph::Terminate(), TProofDrawPolyMarker3D::Terminate(), TProofDrawListOfGraphs::Terminate(), TProofDrawListOfPolyMarkers3D::Terminate(), TEventIterTree::TEventIterTree(), TPostScript::Text(), TFileCacheRead::TFileCacheRead(), TGLEventHandler::TGLEventHandler(), TGLViewerBase::TGLViewerBase(), TPerfStats::TPerfStats(), TProofServ::TProofServ(), TROOT::TROOT(), TShutdownTimer::TShutdownTimer(), TSQLMonitoringWriter::TSQLMonitoringWriter(), TWinNTSystem::TWinNTSystem(), TXNetFile::TXNetFile(), TXNetSystem::TXNetSystem(), and TUnixSystem::UnixSignal().
|
virtual |
If set to true, no warnings in case of duplicates are issued.
Returns previous value.
Definition at line 806 of file TEnv.cxx.
Referenced by TCling::InitRootmapFile(), TCling::LoadLibraryMap(), and TCling::SetClassSharedLibs().
|
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 550 of file TEnv.cxx.
Referenced by TCling::GetClassSharedLibs(), Getvalue(), TProofOutputFile::Init(), TProofPlayerRemote::Process(), TProofServ::ProcessNext(), TCling::ReadRootmapFile(), and SetValue().
Read and parse the resource file for a certain level.
Returns -1 on case of error, 0 in case of success.
Definition at line 595 of file TEnv.cxx.
Referenced by TProofLite::GetNumberOfWorkers(), TCling::InitRootmapFile(), TCling::LoadLibraryMap(), TSessionViewer::ReadConfiguration(), and TProofServ::TProofServ().
|
virtual |
|
inlinevirtual |
Definition at line 149 of file TEnv.h.
Referenced by TCling::InitRootmapFile().
|
virtual |
Set the value of a resource or create a new resource.
Definition at line 749 of file TEnv.cxx.
Referenced by TSelectorDraw::Begin(), ClassImp(), TXNetSystem::Connect(), TRootCanvas::CreateEditor(), TXProofServ::CreateServer(), TProofDrawProfile::DefVar(), TProofDrawProfile2D::DefVar(), TProofDrawHist::DefVar1D(), TProofDrawHist::DefVar2D(), TProofDrawHist::DefVar3D(), TSpider::Draw(), TGLFormat::GetDefaultSamples(), TGX11TTF::Init(), TProof::Open(), TProof::ParseConfigField(), TProofPlayer::Process(), TRootBrowserLite::ProcessMessage(), TSessionViewer::ProcessMessage(), TSessionViewer::ReadConfiguration(), TCling::ReadRootmapFile(), TCling::SetClassSharedLibs(), SetValue(), TProofDrawGraph::Terminate(), TProofDrawPolyMarker3D::Terminate(), TProofDrawListOfGraphs::Terminate(), TProofDrawListOfPolyMarkers3D::Terminate(), VerifyDataSet(), and TSessionViewer::WriteConfiguration().
|
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 620 of file TEnv.cxx.
Referenced by TSessionViewer::WriteConfiguration().
|
private |
Definition at line 133 of file TEnv.h.
Referenced by IgnoreDuplicates(), and SetValue().
|
private |
Definition at line 132 of file TEnv.h.
Referenced by GetRcName(), Save(), and SaveLevel().
|
private |
Definition at line 131 of file TEnv.h.
Referenced by GetTable(), Lookup(), PrintEnv(), SaveLevel(), SetValue(), WriteFile(), and ~TEnv().