Logo ROOT   6.19/01
Reference Guide
TPluginHandler Class Reference

Definition at line 102 of file TPluginManager.h.

Public Member Functions

Int_t CheckPlugin () const
 Check if the plugin library for this handler exits. More...
 
template<typename... T>
Long_t ExecPlugin (int nargs, const T &... params)
 
template<typename... T>
Long_t ExecPluginImpl (const T &... params)
 
const char * GetClass () const
 
Int_t LoadPlugin ()
 Load the plugin library for this handler. More...
 
void Print (Option_t *opt="") const
 Print info about the plugin handler. 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 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 Types

using AtomicInt_t = std::atomic< Int_t >
 

Private Member Functions

 TPluginHandler ()
 
 TPluginHandler (const char *base, const char *regexp, const char *className, const char *pluginName, const char *ctor, const char *origin)
 Create a plugin handler. Called by TPluginManager. More...
 
 TPluginHandler (const TPluginHandler &)
 
 ~TPluginHandler ()
 Cleanup plugin handler object. More...
 
Bool_t CanHandle (const char *base, const char *uri)
 Check if regular expression appears in the URI, if so return kTRUE. More...
 
Bool_t CheckForExecPlugin (Int_t nargs)
 Check that we can properly run ExecPlugin. More...
 
const char * GetBase () const
 
const char * GetCtor () const
 
const char * GetOrigin () const
 
const char * GetPlugin () const
 
const char * GetRegexp () const
 
TPluginHandleroperator= (const TPluginHandler &)
 
void SetupCallEnv ()
 Setup ctor or static method call environment. More...
 

Private Attributes

TString fBase
 
TMethodCallfCallEnv
 
AtomicInt_t fCanCall
 ctor method or global function More...
 
TString fClass
 
TString fCtor
 
Bool_t fIsGlobal
 
Bool_t fIsMacro
 if 1 fCallEnv is ok, -1 fCallEnv is not ok, 0 fCallEnv not setup yet. More...
 
TFunctionfMethod
 ctor method call environment More...
 
TString fOrigin
 
TString fPlugin
 
TString fRegexp
 

Friends

class TPluginManager
 

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 <TPluginManager.h>

Inheritance diagram for TPluginHandler:
[legend]

Member Typedef Documentation

◆ AtomicInt_t

using TPluginHandler::AtomicInt_t = std::atomic<Int_t>
private

Definition at line 107 of file TPluginManager.h.

Constructor & Destructor Documentation

◆ TPluginHandler() [1/3]

TPluginHandler::TPluginHandler ( )
inlineprivate

Definition at line 121 of file TPluginManager.h.

◆ TPluginHandler() [2/3]

TPluginHandler::TPluginHandler ( const char *  base,
const char *  regexp,
const char *  className,
const char *  pluginName,
const char *  ctor,
const char *  origin 
)
private

Create a plugin handler. Called by TPluginManager.

Definition at line 117 of file TPluginManager.cxx.

◆ TPluginHandler() [3/3]

TPluginHandler::TPluginHandler ( const TPluginHandler )
private

◆ ~TPluginHandler()

TPluginHandler::~TPluginHandler ( )
private

Cleanup plugin handler object.

Definition at line 151 of file TPluginManager.cxx.

Member Function Documentation

◆ CanHandle()

Bool_t TPluginHandler::CanHandle ( const char *  base,
const char *  uri 
)
private

Check if regular expression appears in the URI, if so return kTRUE.

If URI = 0 always return kTRUE.

Definition at line 160 of file TPluginManager.cxx.

◆ CheckForExecPlugin()

Bool_t TPluginHandler::CheckForExecPlugin ( Int_t  nargs)
private

Check that we can properly run ExecPlugin.

Definition at line 270 of file TPluginManager.cxx.

◆ CheckPlugin()

Int_t TPluginHandler::CheckPlugin ( ) const

Check if the plugin library for this handler exits.

Returns 0 when it exists and -1 in case the plugin does not exist.

Definition at line 242 of file TPluginManager.cxx.

◆ ExecPlugin()

template<typename... T>
Long_t TPluginHandler::ExecPlugin ( int  nargs,
const T &...  params 
)
inline

Definition at line 166 of file TPluginManager.h.

◆ ExecPluginImpl()

template<typename... T>
Long_t TPluginHandler::ExecPluginImpl ( const T &...  params)
inline

Definition at line 148 of file TPluginManager.h.

◆ GetBase()

const char* TPluginHandler::GetBase ( ) const
inlineprivate

Definition at line 132 of file TPluginManager.h.

◆ GetClass()

const char* TPluginHandler::GetClass ( ) const
inline

Definition at line 144 of file TPluginManager.h.

◆ GetCtor()

const char* TPluginHandler::GetCtor ( ) const
inlineprivate

Definition at line 135 of file TPluginManager.h.

◆ GetOrigin()

const char* TPluginHandler::GetOrigin ( ) const
inlineprivate

Definition at line 136 of file TPluginManager.h.

◆ GetPlugin()

const char* TPluginHandler::GetPlugin ( ) const
inlineprivate

Definition at line 134 of file TPluginManager.h.

◆ GetRegexp()

const char* TPluginHandler::GetRegexp ( ) const
inlineprivate

Definition at line 133 of file TPluginManager.h.

◆ LoadPlugin()

Int_t TPluginHandler::LoadPlugin ( )

Load the plugin library for this handler.

Returns 0 on successful loading and -1 in case the library does not exist or in case of error.

Definition at line 255 of file TPluginManager.cxx.

◆ operator=()

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

◆ Print()

void TPluginHandler::Print ( Option_t opt = "") const
virtual

Print info about the plugin handler.

If option is "a" print also the ctor's that will be used.

Reimplemented from TObject.

Definition at line 309 of file TPluginManager.cxx.

◆ SetupCallEnv()

void TPluginHandler::SetupCallEnv ( )
private

Setup ctor or static method call environment.

Definition at line 183 of file TPluginManager.cxx.

Friends And Related Function Documentation

◆ TPluginManager

friend class TPluginManager
friend

Definition at line 104 of file TPluginManager.h.

Member Data Documentation

◆ fBase

TString TPluginHandler::fBase
private

Definition at line 109 of file TPluginManager.h.

◆ fCallEnv

TMethodCall* TPluginHandler::fCallEnv
private

Definition at line 115 of file TPluginManager.h.

◆ fCanCall

AtomicInt_t TPluginHandler::fCanCall
private

ctor method or global function

Definition at line 117 of file TPluginManager.h.

◆ fClass

TString TPluginHandler::fClass
private

Definition at line 111 of file TPluginManager.h.

◆ fCtor

TString TPluginHandler::fCtor
private

Definition at line 113 of file TPluginManager.h.

◆ fIsGlobal

Bool_t TPluginHandler::fIsGlobal
private

Definition at line 119 of file TPluginManager.h.

◆ fIsMacro

Bool_t TPluginHandler::fIsMacro
private

if 1 fCallEnv is ok, -1 fCallEnv is not ok, 0 fCallEnv not setup yet.

Definition at line 118 of file TPluginManager.h.

◆ fMethod

TFunction* TPluginHandler::fMethod
private

ctor method call environment

Definition at line 116 of file TPluginManager.h.

◆ fOrigin

TString TPluginHandler::fOrigin
private

Definition at line 114 of file TPluginManager.h.

◆ fPlugin

TString TPluginHandler::fPlugin
private

Definition at line 112 of file TPluginManager.h.

◆ fRegexp

TString TPluginHandler::fRegexp
private

Definition at line 110 of file TPluginManager.h.


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