Logo ROOT  
Reference Guide
 
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Loading...
Searching...
No Matches
TPluginHandler Class Reference

Definition at line 103 of file TPluginManager.h.

Public Member Functions

Int_t CheckPlugin () const
 Check if the plugin library for this handler exits.
 
Longptr_t ExecPlugin (int nargs)
 
template<typename... T>
Longptr_t ExecPlugin (int nargs, const T &... params)
 
Longptr_t ExecPluginImpl ()
 
const char * GetClass () const
 
TClassIsA () const override
 
Int_t LoadPlugin ()
 Load the plugin library for this handler.
 
void Print (Option_t *opt="") const override
 Print info about the plugin handler.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
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.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
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.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
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.
 
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).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
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.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

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.
 
 TPluginHandler (const TPluginHandler &)=delete
 
 ~TPluginHandler ()
 Cleanup plugin handler object.
 
Bool_t CanHandle (const char *base, const char *uri)
 Check if regular expression appears in the URI, if so return kTRUE.
 
template<typename T0 >
bool CheckExactMatch (int iarg, const T0 &)
 
template<typename T0 , typename... T>
bool CheckExactMatch (int iarg, const T0 &, const T &... params)
 
Bool_t CheckForExecPlugin (Int_t nargs)
 Check that we can properly run ExecPlugin.
 
bool CheckNameMatch (int iarg, const std::type_info &ti)
 Return true if the name of the iarg-th argument's type match type_name
 
template<typename... T>
bool ExactArgMatch (const T &... params)
 
template<typename... T>
Longptr_t ExecPluginImpl (const T &... params)
 
const char * GetBase () const
 
const char * GetCtor () const
 
const char * GetOrigin () const
 
const char * GetPlugin () const
 
const char * GetRegexp () const
 
void LoadPluginImpl ()
 Load the plugin library for this handler.
 
TPluginHandleroperator= (const TPluginHandler &)=delete
 
void SetupCallEnv ()
 Setup ctor or static method call environment.
 

Private Attributes

std::vector< std::string > fArgTupleTypeInfo
 ctor method or global function
 
TString fBase
 
TMethodCallfCallEnv
 
AtomicInt_t fCanCall
 
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.
 
Int_t fLoadStatus
 
std::once_flag fLoadStatusFlag
 
TFunctionfMethod
 ctor method call environment
 
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 = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- 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).
 
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 108 of file TPluginManager.h.

Constructor & Destructor Documentation

◆ TPluginHandler() [1/3]

TPluginHandler::TPluginHandler ( )
inlineprivate

Definition at line 125 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 116 of file TPluginManager.cxx.

◆ TPluginHandler() [3/3]

TPluginHandler::TPluginHandler ( const TPluginHandler & )
privatedelete

◆ ~TPluginHandler()

TPluginHandler::~TPluginHandler ( )
private

Cleanup plugin handler object.

Definition at line 150 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 159 of file TPluginManager.cxx.

◆ CheckExactMatch() [1/2]

template<typename T0 >
bool TPluginHandler::CheckExactMatch ( int iarg,
const T0 &  )
inlineprivate

Definition at line 151 of file TPluginManager.h.

◆ CheckExactMatch() [2/2]

template<typename T0 , typename... T>
bool TPluginHandler::CheckExactMatch ( int iarg,
const T0 & ,
const T &... params )
inlineprivate

Definition at line 157 of file TPluginManager.h.

◆ CheckForExecPlugin()

Bool_t TPluginHandler::CheckForExecPlugin ( Int_t nargs)
private

Check that we can properly run ExecPlugin.

Definition at line 303 of file TPluginManager.cxx.

◆ CheckNameMatch()

Bool_t TPluginHandler::CheckNameMatch ( int iarg,
const std::type_info & ti )
private

Return true if the name of the iarg-th argument's type match type_name

Definition at line 181 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 262 of file TPluginManager.cxx.

◆ Class()

static TClass * TPluginHandler::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TPluginHandler::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TPluginHandler::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 254 of file TPluginManager.h.

◆ DeclFileName()

static const char * TPluginHandler::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 254 of file TPluginManager.h.

◆ ExactArgMatch()

template<typename... T>
bool TPluginHandler::ExactArgMatch ( const T &... params)
inlineprivate

Definition at line 166 of file TPluginManager.h.

◆ ExecPlugin() [1/2]

Longptr_t TPluginHandler::ExecPlugin ( int nargs)
inline

Definition at line 231 of file TPluginManager.h.

◆ ExecPlugin() [2/2]

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

Definition at line 242 of file TPluginManager.h.

◆ ExecPluginImpl() [1/2]

Longptr_t TPluginHandler::ExecPluginImpl ( )
inline

Definition at line 217 of file TPluginManager.h.

◆ ExecPluginImpl() [2/2]

template<typename... T>
Longptr_t TPluginHandler::ExecPluginImpl ( const T &... params)
inlineprivate

Definition at line 180 of file TPluginManager.h.

◆ GetBase()

const char * TPluginHandler::GetBase ( ) const
inlineprivate

Definition at line 136 of file TPluginManager.h.

◆ GetClass()

const char * TPluginHandler::GetClass ( ) const
inline

Definition at line 212 of file TPluginManager.h.

◆ GetCtor()

const char * TPluginHandler::GetCtor ( ) const
inlineprivate

Definition at line 139 of file TPluginManager.h.

◆ GetOrigin()

const char * TPluginHandler::GetOrigin ( ) const
inlineprivate

Definition at line 140 of file TPluginManager.h.

◆ GetPlugin()

const char * TPluginHandler::GetPlugin ( ) const
inlineprivate

Definition at line 138 of file TPluginManager.h.

◆ GetRegexp()

const char * TPluginHandler::GetRegexp ( ) const
inlineprivate

Definition at line 137 of file TPluginManager.h.

◆ IsA()

TClass * TPluginHandler::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 254 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 293 of file TPluginManager.cxx.

◆ LoadPluginImpl()

void TPluginHandler::LoadPluginImpl ( )
private

Load the plugin library for this handler.

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

Definition at line 274 of file TPluginManager.cxx.

◆ operator=()

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

◆ Print()

void TPluginHandler::Print ( Option_t * opt = "") const
overridevirtual

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 341 of file TPluginManager.cxx.

◆ SetupCallEnv()

void TPluginHandler::SetupCallEnv ( )
private

Setup ctor or static method call environment.

Definition at line 198 of file TPluginManager.cxx.

◆ Streamer()

void TPluginHandler::Streamer ( TBuffer & R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TPluginHandler::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 254 of file TPluginManager.h.

Friends And Related Symbol Documentation

◆ TPluginManager

friend class TPluginManager
friend

Definition at line 105 of file TPluginManager.h.

Member Data Documentation

◆ fArgTupleTypeInfo

std::vector<std::string> TPluginHandler::fArgTupleTypeInfo
private

ctor method or global function

Definition at line 118 of file TPluginManager.h.

◆ fBase

TString TPluginHandler::fBase
private

Definition at line 110 of file TPluginManager.h.

◆ fCallEnv

TMethodCall* TPluginHandler::fCallEnv
private

Definition at line 116 of file TPluginManager.h.

◆ fCanCall

AtomicInt_t TPluginHandler::fCanCall
private

Definition at line 119 of file TPluginManager.h.

◆ fClass

TString TPluginHandler::fClass
private

Definition at line 112 of file TPluginManager.h.

◆ fCtor

TString TPluginHandler::fCtor
private

Definition at line 114 of file TPluginManager.h.

◆ fIsGlobal

Bool_t TPluginHandler::fIsGlobal
private

Definition at line 121 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 120 of file TPluginManager.h.

◆ fLoadStatus

Int_t TPluginHandler::fLoadStatus
private

Definition at line 123 of file TPluginManager.h.

◆ fLoadStatusFlag

std::once_flag TPluginHandler::fLoadStatusFlag
private

Definition at line 122 of file TPluginManager.h.

◆ fMethod

TFunction* TPluginHandler::fMethod
private

ctor method call environment

Definition at line 117 of file TPluginManager.h.

◆ fOrigin

TString TPluginHandler::fOrigin
private

Definition at line 115 of file TPluginManager.h.

◆ fPlugin

TString TPluginHandler::fPlugin
private

Definition at line 113 of file TPluginManager.h.

◆ fRegexp

TString TPluginHandler::fRegexp
private

Definition at line 111 of file TPluginManager.h.

Libraries for TPluginHandler:

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