Logo ROOT   master
Reference Guide
TPackMgr Class Reference

The PROOF package manager contains tools to manage packages.

This class has been created to eliminate duplications, and to allow for standalone usage.

Definition at line 37 of file TPackMgr.h.

Public Types

enum  ECheckVersionOpt { kDontCheck = 0, kCheckROOT = 1, kCheckGIT = 2 }
 
- 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)
}
 

Public Member Functions

 TPackMgr (const char *dir, const char *key="L0")
 Create a PROOF package manager. More...
 
virtual ~TPackMgr ()
 Destroy a TPackMgr instance. More...
 
Int_t Build (const char *pack, Int_t opt=TPackMgr::kCheckROOT)
 Method to build a package. More...
 
Int_t Clean (const char *pack)
 Clean dir for package 'pack' Return -1 in case of error, 0 otherwise. More...
 
const char * GetDir () const
 
Int_t GetDownloadDir (TString &dldir)
 Method to get the download dir; create if not existing Return -1 in case of error (not found; not created), 0 otherwise. More...
 
void GetEnabledPackages (TString &packlist)
 Method to get a semi-colon separated list with the names of the enabled packages. More...
 
TListGetList () const
 Get list of available packages Returns a pointer to a TList object, transferring ownership to the caller. More...
 
TListGetListOfEnabled () const
 Get list of enabled packages Returns a pointer to a TList object, transferring ownership to the caller. More...
 
TLockPathGetLock ()
 
TMD5GetMD5 (const char *pack)
 Get MD5 checksum of the PAR file corresponding to given package Returns a pointer to a TMD5 object, transferring ownership to the caller. More...
 
const char * GetName () const
 Returns name of object. More...
 
Int_t GetPackDir (const char *pack, TString &pdir)
 Method to get the path of the dir for package 'pack'. More...
 
Int_t GetParPath (const char *pack, TString &path)
 Method to get the path of the PAR file for package 'pack'. More...
 
const char * GetTitle () const
 Returns title of object. More...
 
Bool_t Has (const char *pack)
 Method to check if this package manager has package 'pack'. More...
 
Int_t Install (const char *par, Bool_t rmold=kFALSE)
 Install package from par (unpack the file in the directory); par can be an URL for remote retrieval. More...
 
Bool_t IsInDir (const char *path)
 Method to check if 'path' is in the managed directory Return kTRUE or kFALSE. More...
 
Bool_t IsPackageEnabled (const char *pack)
 
Int_t Load (const char *pack, TList *optls=0)
 Method to load a package taking an option list Return -1 on error, 0 otherwise. More...
 
Int_t Load (const char *pack, const char *opts)
 Method to load a package taking an option const char * Return -1 on error, 0 otherwise. More...
 
TMD5ReadMD5 (const char *pack)
 Read MD5 checksum of the PAR file from the PROOF-INF/md5.txt file. More...
 
Int_t Remove (const char *pack=0, Bool_t dolock=kTRUE)
 Remove package 'pack' If 'pack' is null or empty all packages are cleared. More...
 
void SetLogger (TPackMgrLog_t logger)
 
void SetName (const char *name)
 Set the name of the TNamed. More...
 
void SetPrefix (const char *pfx)
 
void Show (const char *title=0)
 Show available packages. More...
 
void ShowEnabled (const char *title=0)
 Show enabled packages. More...
 
Int_t Unload (const char *pack)
 Method to unload a package. More...
 
Int_t Unpack (const char *pack, TMD5 *sum=0)
 Read MD5 checksum of the PAR file from the PROOF-INF/md5.txt file. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
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 two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. 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 ()
 Check and record whether 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 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 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 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...
 
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
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
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...
 

Static Public Member Functions

static Int_t FindParPath (TPackMgr *packmgr, const char *pack, TString &par)
 Get the full path to PAR, looking also in the global dirs. More...
 
static TPackMgrGetPackMgr (const char *pack, TPackMgr *packmgr=nullptr)
 Get the package manager having 'pack'; priority is given to packmgr, if defined. More...
 
static Bool_t IsEnabled (const char *pack, TPackMgr *packmgr=nullptr)
 Check if the package is enabled; priority is given to packmgr, if defined. More...
 
static Int_t RegisterGlobalPath (const char *paths)
 Parse one or more paths as possible sources of packages Returns number of paths added; or -1 in case of problems. More...
 
- 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...
 

Private Member Functions

 TPackMgr (const TPackMgr &)
 
void Log (const char *msg)
 Wrapper to notofuer / logger. More...
 
TPackMgroperator= (const TPackMgr &)
 

Private Attributes

TString fDir
 
TListfEnabledPackages
 
TLockPath fLock
 
TPackMgrLog_t fLogger
 
TString fName
 
TString fPfx
 

Static Private Attributes

static THashListfgGlobalPackMgrList = 0
 

Additional Inherited Members

- 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 ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TPackMgr.h>

Inheritance diagram for TPackMgr:
[legend]

Member Enumeration Documentation

◆ ECheckVersionOpt

Enumerator
kDontCheck 
kCheckROOT 
kCheckGIT 

Definition at line 39 of file TPackMgr.h.

Constructor & Destructor Documentation

◆ TPackMgr() [1/2]

TPackMgr::TPackMgr ( const TPackMgr )
private

◆ TPackMgr() [2/2]

TPackMgr::TPackMgr ( const char *  dir,
const char *  key = "L0" 
)

Create a PROOF package manager.

Definition at line 49 of file TPackMgr.cxx.

◆ ~TPackMgr()

TPackMgr::~TPackMgr ( )
virtual

Destroy a TPackMgr instance.

Definition at line 64 of file TPackMgr.cxx.

Member Function Documentation

◆ Build()

Int_t TPackMgr::Build ( const char *  pack,
Int_t  opt = TPackMgr::kCheckROOT 
)

Method to build a package.

Return -1 on error, 0 otherwise

Definition at line 87 of file TPackMgr.cxx.

◆ Clean()

Int_t TPackMgr::Clean ( const char *  pack)

Clean dir for package 'pack' Return -1 in case of error, 0 otherwise.

Definition at line 576 of file TPackMgr.cxx.

◆ FindParPath()

Int_t TPackMgr::FindParPath ( TPackMgr packmgr,
const char *  pack,
TString par 
)
static

Get the full path to PAR, looking also in the global dirs.

Returns -1 if not found, 0 if available in global dirs, 1 if it can be uploaded from the local package dir. For the cases >= 0, par is filled with the path of the PAR file

Definition at line 934 of file TPackMgr.cxx.

◆ GetDir()

const char* TPackMgr::GetDir ( ) const
inline

Definition at line 77 of file TPackMgr.h.

◆ GetDownloadDir()

Int_t TPackMgr::GetDownloadDir ( TString dldir)

Method to get the download dir; create if not existing Return -1 in case of error (not found; not created), 0 otherwise.

Definition at line 534 of file TPackMgr.cxx.

◆ GetEnabledPackages()

void TPackMgr::GetEnabledPackages ( TString packlist)

Method to get a semi-colon separated list with the names of the enabled packages.

Definition at line 501 of file TPackMgr.cxx.

◆ GetList()

TList * TPackMgr::GetList ( ) const

Get list of available packages Returns a pointer to a TList object, transferring ownership to the caller.

Definition at line 621 of file TPackMgr.cxx.

◆ GetListOfEnabled()

TList * TPackMgr::GetListOfEnabled ( ) const

Get list of enabled packages Returns a pointer to a TList object, transferring ownership to the caller.

Definition at line 644 of file TPackMgr.cxx.

◆ GetLock()

TLockPath* TPackMgr::GetLock ( )
inline

Definition at line 65 of file TPackMgr.h.

◆ GetMD5()

TMD5 * TPackMgr::GetMD5 ( const char *  pack)

Get MD5 checksum of the PAR file corresponding to given package Returns a pointer to a TMD5 object, transferring ownership to the caller.

Definition at line 692 of file TPackMgr.cxx.

◆ GetName()

const char* TPackMgr::GetName ( ) const
inlinevirtual

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TNamed.

Definition at line 61 of file TPackMgr.h.

◆ GetPackDir()

Int_t TPackMgr::GetPackDir ( const char *  pack,
TString pdir 
)

Method to get the path of the dir for package 'pack'.

Return -1 in case of error (not found), 0 otherwise

Definition at line 487 of file TPackMgr.cxx.

◆ GetPackMgr()

TPackMgr * TPackMgr::GetPackMgr ( const char *  pack,
TPackMgr packmgr = nullptr 
)
static

Get the package manager having 'pack'; priority is given to packmgr, if defined.

Returns packmgr or nullptr

Definition at line 912 of file TPackMgr.cxx.

◆ GetParPath()

Int_t TPackMgr::GetParPath ( const char *  pack,
TString path 
)

Method to get the path of the PAR file for package 'pack'.

Return -1 in case of error (not found), 0 otherwise

Definition at line 521 of file TPackMgr.cxx.

◆ GetTitle()

const char* TPackMgr::GetTitle ( ) const
inlinevirtual

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TNamed.

Definition at line 63 of file TPackMgr.h.

◆ Has()

Bool_t TPackMgr::Has ( const char *  pack)

Method to check if this package manager has package 'pack'.

Return kTRUE or kFALSE

Definition at line 458 of file TPackMgr.cxx.

◆ Install()

Int_t TPackMgr::Install ( const char *  parpath,
Bool_t  rmold = kFALSE 
)

Install package from par (unpack the file in the directory); par can be an URL for remote retrieval.

If rmold is kTRUE an existing version of the package is removed if existing. Returns 0 on success, <0 otherwise

Definition at line 766 of file TPackMgr.cxx.

◆ IsEnabled()

Bool_t TPackMgr::IsEnabled ( const char *  pack,
TPackMgr packmgr = nullptr 
)
static

Check if the package is enabled; priority is given to packmgr, if defined.

Returns kTRUE if enabled

Definition at line 961 of file TPackMgr.cxx.

◆ IsInDir()

Bool_t TPackMgr::IsInDir ( const char *  path)

Method to check if 'path' is in the managed directory Return kTRUE or kFALSE.

Definition at line 478 of file TPackMgr.cxx.

◆ IsPackageEnabled()

Bool_t TPackMgr::IsPackageEnabled ( const char *  pack)
inline

Definition at line 82 of file TPackMgr.h.

◆ Load() [1/2]

Int_t TPackMgr::Load ( const char *  pack,
TList optls = 0 
)

Method to load a package taking an option list Return -1 on error, 0 otherwise.

Definition at line 220 of file TPackMgr.cxx.

◆ Load() [2/2]

Int_t TPackMgr::Load ( const char *  pack,
const char *  opts 
)

Method to load a package taking an option const char * Return -1 on error, 0 otherwise.

Definition at line 206 of file TPackMgr.cxx.

◆ Log()

void TPackMgr::Log ( const char *  msg)
private

Wrapper to notofuer / logger.

Definition at line 73 of file TPackMgr.cxx.

◆ operator=()

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

◆ ReadMD5()

TMD5 * TPackMgr::ReadMD5 ( const char *  pack)

Read MD5 checksum of the PAR file from the PROOF-INF/md5.txt file.

Returns a pointer to a TMD5 object, transferring ownership to the caller

Definition at line 708 of file TPackMgr.cxx.

◆ RegisterGlobalPath()

Int_t TPackMgr::RegisterGlobalPath ( const char *  paths)
static

Parse one or more paths as possible sources of packages Returns number of paths added; or -1 in case of problems.

Definition at line 872 of file TPackMgr.cxx.

◆ Remove()

Int_t TPackMgr::Remove ( const char *  pack = 0,
Bool_t  dolock = kTRUE 
)

Remove package 'pack' If 'pack' is null or empty all packages are cleared.

Definition at line 593 of file TPackMgr.cxx.

◆ SetLogger()

void TPackMgr::SetLogger ( TPackMgrLog_t  logger)
inline

Definition at line 67 of file TPackMgr.h.

◆ SetName()

void TPackMgr::SetName ( const char *  name)
inlinevirtual

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented from TNamed.

Definition at line 62 of file TPackMgr.h.

◆ SetPrefix()

void TPackMgr::SetPrefix ( const char *  pfx)
inline

Definition at line 68 of file TPackMgr.h.

◆ Show()

void TPackMgr::Show ( const char *  title = 0)

Show available packages.

Definition at line 548 of file TPackMgr.cxx.

◆ ShowEnabled()

void TPackMgr::ShowEnabled ( const char *  title = 0)

Show enabled packages.

Definition at line 662 of file TPackMgr.cxx.

◆ Unload()

Int_t TPackMgr::Unload ( const char *  pack)

Method to unload a package.

Return -1 on error, 0 otherwise

Definition at line 411 of file TPackMgr.cxx.

◆ Unpack()

Int_t TPackMgr::Unpack ( const char *  pack,
TMD5 sum = 0 
)

Read MD5 checksum of the PAR file from the PROOF-INF/md5.txt file.

Returns a pointer to a TMD5 object, transferring ownership to the caller

Definition at line 723 of file TPackMgr.cxx.

Member Data Documentation

◆ fDir

TString TPackMgr::fDir
private

Definition at line 44 of file TPackMgr.h.

◆ fEnabledPackages

TList* TPackMgr::fEnabledPackages
private

Definition at line 47 of file TPackMgr.h.

◆ fgGlobalPackMgrList

THashList * TPackMgr::fgGlobalPackMgrList = 0
staticprivate

Definition at line 49 of file TPackMgr.h.

◆ fLock

TLockPath TPackMgr::fLock
private

Definition at line 45 of file TPackMgr.h.

◆ fLogger

TPackMgrLog_t TPackMgr::fLogger
private

Definition at line 42 of file TPackMgr.h.

◆ fName

TString TPackMgr::fName
private

Definition at line 43 of file TPackMgr.h.

◆ fPfx

TString TPackMgr::fPfx
private

Definition at line 46 of file TPackMgr.h.

Libraries for TPackMgr:
[legend]

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