ROOT  6.06/09
Reference Guide
Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
TPluginHandler Class Reference

Definition at line 113 of file TPluginManager.h.

Public Member Functions

const char * GetClass () const
 
Int_t CheckPlugin () const
 Check if the plugin library for this handler exits. More...
 
Int_t LoadPlugin ()
 Load the plugin library for this handler. More...
 
template<typename... T>
Long_t ExecPluginImpl (const T &...params)
 
template<typename... T>
Long_t ExecPlugin (int nargs, const T &...params)
 
void Print (Option_t *opt="") const
 Print info about the plugin handler. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (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 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 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 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 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_tGetOption () 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...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator 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 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)
 
 TPluginHandler (const TPluginHandler &)
 
TPluginHandleroperator= (const TPluginHandler &)
 
 ~TPluginHandler ()
 Cleanup plugin handler object. More...
 
const char * GetBase () const
 
const char * GetRegexp () const
 
const char * GetPlugin () const
 
const char * GetCtor () const
 
const char * GetOrigin () const
 
Bool_t CanHandle (const char *base, const char *uri)
 Check if regular expression appears in the URI, if so return kTRUE. More...
 
void SetupCallEnv ()
 Setup ctor or static method call environment. More...
 
Bool_t CheckForExecPlugin (Int_t nargs)
 Check that we can properly run ExecPlugin. More...
 

Private Attributes

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

Friends

class TPluginManager
 

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

+ Inheritance diagram for TPluginHandler:
+ Collaboration diagram for TPluginHandler:

Member Typedef Documentation

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

Definition at line 118 of file TPluginManager.h.

Constructor & Destructor Documentation

TPluginHandler::TPluginHandler ( )
inlineprivate

Definition at line 132 of file TPluginManager.h.

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

Cleanup plugin handler object.

Definition at line 153 of file TPluginManager.cxx.

Member Function Documentation

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

Referenced by TPluginManager::FindHandler().

Bool_t TPluginHandler::CheckForExecPlugin ( Int_t  nargs)
private

Check that we can properly run ExecPlugin.

Definition at line 272 of file TPluginManager.cxx.

Referenced by ExecPluginImpl().

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

Referenced by Print(), and TPluginManager::Print().

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

Definition at line 177 of file TPluginManager.h.

Referenced by TFile::AsyncOpen(), TSocket::Authenticate(), TGeoPainter::CheckEdit(), ClassImp(), TMinuit::Contour(), TVirtualProofPlayer::Create(), TRootCanvas::CreateCanvas(), ROOT::Math::Factory::CreateDistSampler(), ROOT::Math::IntegratorMultiDim::CreateIntegrator(), ROOT::Math::IntegratorOneDim::CreateIntegrator(), ROOT::Math::Factory::CreateMinimizer(), TXProofServ::CreateServer(), TProofServ::CreateServer(), TView::CreateView(), TFile::DrawMap(), TVirtualStreamerInfo::Factory(), TVirtualFFT::FFT(), TSystem::FindHelper(), TMultiGraph::FitPanel(), TGraph2D::FitPanel(), TGraph::FitPanel(), TH1::FitPanel(), TVirtualFitter::Fitter(), TVirtualGeoPainter::GeoPainter(), getDSMgr(), TGeoManager::GetGeomPainter(), TH1::GetPainter(), TProof::HandleInputMessage(), TProofLite::InitDataSetManager(), TVirtualDragManager::Instance(), TVirtualPadEditor::LoadEditor(), TGApplication::LoadGraphicsLibs(), TApplication::LoadGraphicsLibs(), TProof::LogViewer(), TMinuit::mnplot(), TFileStager::Open(), TArchiveFile::Open(), TApplication::Open(), TFile::Open(), TProof::Open(), TVirtualPadPainter::PadPainter(), TPad::Print(), TProofSuperMaster::Process(), TProofLite::Process(), TRootCanvas::ProcessMessage(), TAuthenticate::PromptPasswd(), TASImage::ReadImage(), ROOT::Math::RootFinder::SetMethod(), TChain::SetProof(), TProofServ::SetupCommon(), TVirtualFFT::SineCosine(), TAttImage::StartPaletteEditor(), TTreePlayer::StartViewer(), TDSet::StartViewer(), TAFS::TAFS(), TGuiBuilder::TGuiBuilder(), TPerfStats::TPerfStats(), TProofMonSenderML::TProofMonSenderML(), and TProofMonSenderSQL::TProofMonSenderSQL().

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

Definition at line 159 of file TPluginManager.h.

Referenced by ExecPlugin().

const char* TPluginHandler::GetBase ( ) const
inlineprivate

Definition at line 143 of file TPluginManager.h.

const char* TPluginHandler::GetClass ( ) const
inline
const char* TPluginHandler::GetCtor ( ) const
inlineprivate

Definition at line 146 of file TPluginManager.h.

const char* TPluginHandler::GetOrigin ( ) const
inlineprivate

Definition at line 147 of file TPluginManager.h.

const char* TPluginHandler::GetPlugin ( ) const
inlineprivate

Definition at line 145 of file TPluginManager.h.

const char* TPluginHandler::GetRegexp ( ) const
inlineprivate

Definition at line 144 of file TPluginManager.h.

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

Referenced by TFile::AsyncOpen(), TSocket::Authenticate(), TGeoPainter::CheckEdit(), ClassImp(), TMinuit::Contour(), TVirtualProofPlayer::Create(), TRootCanvas::CreateCanvas(), ROOT::Math::Factory::CreateDistSampler(), ROOT::Math::IntegratorMultiDim::CreateIntegrator(), ROOT::Math::IntegratorOneDim::CreateIntegrator(), ROOT::Math::Factory::CreateMinimizer(), TXProofServ::CreateServer(), TProofServ::CreateServer(), TView::CreateView(), TFile::DrawMap(), TVirtualStreamerInfo::Factory(), TVirtualFFT::FFT(), TSystem::FindHelper(), TMultiGraph::FitPanel(), TGraph2D::FitPanel(), TGraph::FitPanel(), TH1::FitPanel(), TVirtualFitter::Fitter(), TVirtualGeoPainter::GeoPainter(), getDSMgr(), TGeoManager::GetGeomPainter(), TH1::GetPainter(), TProofLite::InitDataSetManager(), TApplication::InitializeGraphics(), TVirtualDragManager::Instance(), TVirtualPadEditor::LoadEditor(), TGApplication::LoadGraphicsLibs(), TApplication::LoadGraphicsLibs(), TProof::LogViewer(), TDSetElement::Lookup(), TMinuit::mnplot(), TFileStager::Open(), TArchiveFile::Open(), TApplication::Open(), TFile::Open(), TProof::Open(), TVirtualPadPainter::PadPainter(), TPad::Print(), TRootCanvas::ProcessMessage(), TAuthenticate::PromptPasswd(), TASImage::ReadImage(), ROOT::Math::RootFinder::SetMethod(), TChain::SetProof(), TProofServ::SetupCommon(), TProofLite::SetupWorkers(), TVirtualFFT::SineCosine(), TAttImage::StartPaletteEditor(), TProof::StartSlaves(), TTreePlayer::StartViewer(), TDSet::StartViewer(), TAFS::TAFS(), TGuiBuilder::TGuiBuilder(), TPerfStats::TPerfStats(), TProofMonSenderML::TProofMonSenderML(), and TProofMonSenderSQL::TProofMonSenderSQL().

TPluginHandler& TPluginHandler::operator= ( const TPluginHandler )
private
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 306 of file TPluginManager.cxx.

Referenced by TPluginManager::Print().

void TPluginHandler::SetupCallEnv ( )
private

Setup ctor or static method call environment.

Definition at line 185 of file TPluginManager.cxx.

Referenced by CheckForExecPlugin().

Friends And Related Function Documentation

friend class TPluginManager
friend

Definition at line 115 of file TPluginManager.h.

Member Data Documentation

TString TPluginHandler::fBase
private
TMethodCall* TPluginHandler::fCallEnv
private

Definition at line 126 of file TPluginManager.h.

Referenced by SetupCallEnv(), and ~TPluginHandler().

AtomicInt_t TPluginHandler::fCanCall
private

ctor method or global function

Definition at line 128 of file TPluginManager.h.

Referenced by CheckForExecPlugin(), and SetupCallEnv().

TString TPluginHandler::fClass
private
TString TPluginHandler::fCtor
private
Bool_t TPluginHandler::fIsGlobal
private

Definition at line 130 of file TPluginManager.h.

Referenced by SetupCallEnv().

Bool_t TPluginHandler::fIsMacro
private

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

Definition at line 129 of file TPluginManager.h.

Referenced by CheckPlugin(), and LoadPlugin().

TFunction* TPluginHandler::fMethod
private

ctor method call environment

Definition at line 127 of file TPluginManager.h.

Referenced by CheckForExecPlugin(), and SetupCallEnv().

TString TPluginHandler::fOrigin
private

Definition at line 125 of file TPluginManager.h.

Referenced by GetOrigin(), and Print().

TString TPluginHandler::fPlugin
private
TString TPluginHandler::fRegexp
private

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