PyROOT::RPyROOTApplication Class Reference

Interactive application for Python.

The RPyROOTApplication sets up the nuts and bolts for interactive ROOT use from Python, closely following TRint. Note that not everything is done here, some bits are more easily done in Python and can be found in _application.py.

Definition at line 31 of file RPyROOTApplication.h.

Public Member Functions
	RPyROOTApplication (const char *name, int *argc, char **argv)
	Construct a TApplication for PyROOT.
virtual	~RPyROOTApplication ()
Public Member Functions inherited from TApplication
	TApplication (const char *appClassName, Int_t *argc, char **argv, void *options=nullptr, Int_t numOptions=0)
	Create an application environment.
virtual	~TApplication ()
	TApplication dtor.
virtual const char *	ApplicationName () const
Int_t	Argc () const
char **	Argv () const
char *	Argv (Int_t index) const
	Return specified argument.
void	ClearInputFiles ()
	Clear list containing macro files passed as program arguments.
EExitOnException	ExitOnException (EExitOnException opt=kExit)
	Set the exit on exception option.
virtual TApplicationImp *	GetApplicationImp ()
TApplication *	GetAppRemote () const
const char *	GetIdleCommand () const
virtual void	GetOptions (Int_t *argc, char **argv)
	Get and handle command line options.
TString	GetSetup ()
	It gets the ROOT installation setup as TString.
TSignalHandler *	GetSignalHandler () const
virtual void	HandleException (Int_t sig)
	Handle exceptions (kSigBus, kSigSegmentationViolation, kSigIllegalInstruction and kSigFloatingException) trapped in TSystem.
virtual void	HandleIdleTimer ()
	Handle idle timeout.
virtual Bool_t	HandleTermInput ()
virtual void	Hide ()
virtual void	Iconify ()
virtual void	Init ()
void	InitializeGraphics (Bool_t only_web=kFALSE)
	Initialize the graphics environment.
TObjArray *	InputFiles () const
TClass *	IsA () const override
virtual Bool_t	IsCmdThread ()
Bool_t	IsRunning () const
virtual void	KeyPressed (Int_t key)
	Emit signal when console keyboard key was pressed.
virtual void	LineProcessed (const char *line)
	Emit signal when a line has been processed.
virtual void	Lower ()
void	ls (Option_t *option="") const override
	Show available sessions.
Bool_t	NoLogoOpt () const
Bool_t	NoLogOpt () const
virtual void	Open ()
void	OpenForumTopic (const TString &type)
	It opens a Forum topic in a web browser with prefilled ROOT version.
void	OpenGitHubIssue (const TString &type)
	It opens a GitHub issue in a web browser with prefilled ROOT version.
void	OpenInBrowser (const TString &url)
	The function generates and executes a command that loads the Doxygen URL in a browser.
void	OpenReferenceGuideFor (const TString &strippedClass)
	It opens the online reference guide, generated with Doxygen, for the chosen scope (class/namespace/struct) or member (method/function/ data member/enumeration/enumerator.
virtual Longptr_t	ProcessFile (const char *file, Int_t *error=nullptr, Bool_t keep=kFALSE)
	Process a file containing a C++ macro.
virtual Longptr_t	ProcessLine (const char *line, Bool_t sync=kFALSE, Int_t *error=nullptr)
	Process a single command line, either a C++ statement or an interpreter command starting with a ".".
Bool_t	QuitOpt () const
virtual void	Raise ()
virtual void	RemoveIdleTimer ()
	Remove idle timer. Normally called via TROOT::Idle(0).
Bool_t	ReturnFromRun () const
virtual void	ReturnPressed (char *text)
	Emit signal when return key was pressed.
virtual void	Run (Bool_t retrn=kFALSE)
	Main application eventloop. Calls system dependent eventloop via gSystem.
virtual void	SetEchoMode (Bool_t mode)
	Set console echo mode:
virtual void	SetIdleTimer (UInt_t idleTimeInSec, const char *command)
	Set the command to be executed after the system has been idle for idleTimeInSec seconds.
void	SetReturnFromRun (Bool_t ret)
virtual void	Show ()
virtual void	StartIdleing ()
	Called when system starts idleing.
virtual void	StopIdleing ()
	Called when system stops idleing.
void	Streamer (TBuffer &) override
	Stream an object of class TObject.
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
virtual Int_t	TabCompletionHook (char *buf, int *pLoc, std::ostream &out)
	What to do when tab is pressed.
virtual void	Terminate (Int_t status=0)
	Terminate the application by call TSystem::Exit() unless application has been told to return from Run(), by a call to SetReturnFromRun().
const char *	WorkingDirectory () const
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 TObject *	Clone (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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.
virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.
virtual Option_t *	GetDrawOption () 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_t *	GetOption () 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
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)
TObject &	operator= (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 void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.
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.
Public Member Functions inherited from TQObject
	TQObject ()
	TQObject Constructor.
virtual	~TQObject ()
	TQObject Destructor.
Bool_t	AreSignalsBlocked () const
Bool_t	BlockSignals (Bool_t b)
virtual void	ChangedBy (const char *method)
void	CollectClassSignalLists (TList &list, TClass *cls)
	Collect class signal lists from class cls and all its base-classes.
Bool_t	Connect (const char *signal, const char *receiver_class, void *receiver, const char *slot)
	Non-static method is used to connect from the signal of this object to the receiver slot.
virtual void	Connected (const char *)
virtual void	Destroyed ()
Bool_t	Disconnect (const char *signal=nullptr, void *receiver=nullptr, const char *slot=nullptr)
	Disconnects signal of this object from slot of receiver.
virtual void	Disconnected (const char *)
void	Emit (const char *signal)
	Activate signal without args.
template<typename T >
void	Emit (const char *signal, const T &arg)
	Activate signal with single parameter.
template<typename... T>
void	EmitVA (const char *signal_name, Int_t, const T &... params)
	Emit a signal with a varying number of arguments.
TList *	GetListOfClassSignals () const
	Returns pointer to list of signals of this class.
TList *	GetListOfConnections () const
TList *	GetListOfSignals () const
virtual Bool_t	HasConnection (const char *signal_name) const
	Return true if there is any object connected to this signal.
virtual void	HighPriority (const char *signal_name, const char *slot_name=nullptr)
virtual void	LowPriority (const char *signal_name, const char *slot_name=nullptr)
virtual void	Message (const char *msg)
virtual Int_t	NumberOfConnections () const
	Return number of connections for this object.
virtual Int_t	NumberOfSignals () const
	Return number of signals for this object.
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Static Public Member Functions
static PyObject *	InitApplication (PyObject *self, PyObject *args)
	Initialize an RPyROOTApplication.
static PyObject *	InstallGUIEventInputHook (PyObject *self, PyObject *args)
	Install a method hook for sending events to the GUI.
Static Public Member Functions inherited from TApplication
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static void	CreateApplication ()
	Static function used to create a default application environment.
static const char *	DeclFileName ()
static Longptr_t	ExecuteFile (const char *file, Int_t *error=nullptr, Bool_t keep=kFALSE)
	Execute a file containing a C++ macro (static method).
static TList *	GetApplications ()
	Static method returning the list of available applications.
static void	NeedGraphicsLibs ()
	Static method.
Static Public Member Functions inherited from TObject
static TClass *	Class ()
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.
Static Public Member Functions inherited from TQObject
static Bool_t	AreAllSignalsBlocked ()
	Returns true if all signals are blocked.
static Bool_t	BlockAllSignals (Bool_t b)
	Block or unblock all signals. Returns the previous block status.
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static Bool_t	Connect (const char *sender_class, const char *signal, const char *receiver_class, void *receiver, const char *slot)
	This method allows to make a connection from any object of the same class to a single slot.
static Bool_t	Connect (TQObject *sender, const char *signal, const char *receiver_class, void *receiver, const char *slot)
	Create connection between sender and receiver.
static const char *	DeclFileName ()
static Bool_t	Disconnect (const char *class_name, const char *signal, void *receiver=nullptr, const char *slot=nullptr)
	Disconnects "class signal".
static Bool_t	Disconnect (TQObject *sender, const char *signal=nullptr, void *receiver=nullptr, const char *slot=nullptr)
	Disconnects signal in object sender from slot_method in object receiver.

Static Private Member Functions
static bool	CreateApplication (int ignoreCmdLineOpts)
	Create an RPyROOTApplication.
static void	InitROOTGlobals ()
	Setup the basic ROOT globals gBenchmark, gStyle and gProgname, if not already set.
static void	InitROOTMessageCallback ()
	Install the ROOT message handler which will turn ROOT error messages into Python exceptions.

Additional Inherited Members
Public Types inherited from TApplication
enum	EExitOnException { kDontExit , kExit , kAbort }
enum	EFileBits { kExpression = (1ULL << ( 14 )) }
enum	EStatusBits { kProcessRemotely = (1ULL << ( 15 )) , kDefaultApplication = (1ULL << ( 16 )) }
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 TApplication
	TApplication ()
	Default ctor. Can be used by classes deriving from TApplication.
virtual void	Forum (const char *line)
	The function (".forum <type>") submits a new post on the ROOT forum via web browser.
virtual void	GitHub (const char *line)
	The function (".gh <type>") submits a new issue on GitHub via web browser.
virtual void	Help (const char *line)
	The function lists useful commands (".help") or opens the online reference guide, generated with Doxygen (".help scope" or ".help scope::member").
virtual void	LoadGraphicsLibs ()
	Load shared libs necessary for graphics.
virtual void	MakeBatch ()
	Switch to batch mode.
virtual Longptr_t	ProcessRemote (const char *line, Int_t *error=nullptr)
	Process the content of a line starting with ".R" (already stripped-off) The format is.
void	SetSignalHandler (TSignalHandler *sh)
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 ()
Protected Member Functions inherited from TQObject
virtual void *	GetSender ()
virtual const char *	GetSenderClassName () const
Static Protected Member Functions inherited from TApplication
static void	Close (TApplication *app)
	Static function used to close a remote application.
static TApplication *	Open (const char *url, Int_t debug, const char *script)
	Static function used to attach to an existing remote application or to start one.
static Int_t	ParseRemoteLine (const char *ln, TString &hostdir, TString &user, Int_t &dbg, TString &script)
	Parse the content of a line starting with ".R" (already stripped-off) The format is.
Static Protected Member Functions inherited from TQObject
static Int_t	CheckConnectArgs (TQObject *sender, TClass *sender_class, const char *signal, TClass *receiver_class, const char *slot)
	Checking of consistency of sender/receiver methods/arguments.
static TString	CompressName (const char *method_name)
	Removes "const" words and blanks from full (with prototype) method name and resolve any typedefs in the method signature.
static Bool_t	ConnectToClass (const char *sender_class, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
	This method allows to make connection from any object of the same class to the receiver object.
static Bool_t	ConnectToClass (TQObject *sender, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
	Create connection between sender and receiver.
Protected Attributes inherited from TApplication
TApplication *	fAppRemote
Protected Attributes inherited from TQObject
TList *	fListOfConnections
	list of signals from this object
TList *	fListOfSignals
Bool_t	fSignalsBlocked
	list of connections to this object
Static Protected Attributes inherited from TApplication
static TList *	fgApplications = nullptr
Static Protected Attributes inherited from TQObject
static Bool_t	fgAllSignalsBlocked = kFALSE
	flag used for suppression of signals

#include </home/sftnight/build/workspace/root-makedoc-v632/rootspi/rdoc/src/v6-32-00-patches/bindings/pyroot/pythonizations/src/RPyROOTApplication.h>

Inheritance diagram for PyROOT::RPyROOTApplication:

Constructor & Destructor Documentation

RPyROOTApplication()

PyROOT::RPyROOTApplication::RPyROOTApplication	(	const char *	name,
		int *	argc,
		char **	argv
	)

Construct a TApplication for PyROOT.

Parameters

[in]	name	Application class name.
[in]	argc	Number of arguments.
[in]	argv	Arguments.

Definition at line 168 of file RPyROOTApplication.cxx.

~RPyROOTApplication()

virtual PyROOT::RPyROOTApplication::~RPyROOTApplication ( )

inlinevirtual

Definition at line 37 of file RPyROOTApplication.h.

Member Function Documentation

CreateApplication()

bool PyROOT::RPyROOTApplication::CreateApplication ( int  ignoreCmdLineOpts )

staticprivate

Create an RPyROOTApplication.

Parameters

[in]

ignoreCmdLineOpts

True if Python command line options should be ignored.

Returns

false if gApplication is not null, true otherwise.

If ignoreCmdLineOpts is false, this method processes the command line arguments from sys.argv. A distinction between arguments for TApplication and user arguments can be made by using "-" or "--" as a separator on the command line.

For example, to enable batch mode from the command line:

‍python script_name.py -b – user_arg1 ... user_argn

or, if the user script receives no arguments:

‍python script_name.py -b

Definition at line 42 of file RPyROOTApplication.cxx.

InitApplication()

PyObject * PyROOT::RPyROOTApplication::InitApplication ( PyObject *  self, PyObject *  args  )

static

Initialize an RPyROOTApplication.

Parameters

[in]	self	Always null, since this is a module function.
[in]	args	[0] Boolean that tells whether to ignore the command line options.

Definition at line 140 of file RPyROOTApplication.cxx.

InitROOTGlobals()

void PyROOT::RPyROOTApplication::InitROOTGlobals ( )

staticprivate

Setup the basic ROOT globals gBenchmark, gStyle and gProgname, if not already set.

Definition at line 83 of file RPyROOTApplication.cxx.

InitROOTMessageCallback()

void PyROOT::RPyROOTApplication::InitROOTMessageCallback ( )

staticprivate

Install the ROOT message handler which will turn ROOT error messages into Python exceptions.

Definition at line 131 of file RPyROOTApplication.cxx.

InstallGUIEventInputHook()

PyObject * PyROOT::RPyROOTApplication::InstallGUIEventInputHook ( PyObject *  self, PyObject *  args  )

static

Install a method hook for sending events to the GUI.

Parameters

[in]	self	Always null, since this is a module function.
[in]	args	Pointer to an empty Python tuple.

Definition at line 208 of file RPyROOTApplication.cxx.