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

Definition at line 35 of file TRint.h.

Public Member Functions

 TRint (const char *appClassName, int *argc, char **argv, void *options=0, int numOptions=0, Bool_t noLogo=kFALSE)
 
virtual ~TRint ()
 Destructor. More...
 
virtual char * GetPrompt ()
 Get prompt from interpreter. Either "root [n]" or "end with '}'". More...
 
virtual const char * SetPrompt (const char *newPrompt)
 Set a new default prompt. More...
 
virtual void SetEchoMode (Bool_t mode)
 Set console mode: More...
 
virtual void HandleException (Int_t sig)
 Handle exceptions (kSigBus, kSigSegmentationViolation, kSigIllegalInstruction and kSigFloatingException) trapped in TSystem. More...
 
virtual Bool_t HandleTermInput ()
 Handle input coming from terminal. More...
 
virtual void PrintLogo (Bool_t lite=kFALSE)
 Print the ROOT logo on standard output. More...
 
virtual void Run (Bool_t retrn=kFALSE)
 Main application eventloop. More...
 
virtual void Terminate (int status)
 Terminate the application. More...
 
void Interrupt ()
 
virtual Int_t TabCompletionHook (char *buf, int *pLoc, std::ostream &out)
 Forward tab completion request to our TTabCom::Hook(). More...
 
TFileHandlerGetInputHandler ()
 
 ClassDef (TRint, 0)
 
- Public Member Functions inherited from TApplication
 TApplication (const char *appClassName, Int_t *argc, char **argv, void *options=0, Int_t numOptions=0)
 Create an application environment. More...
 
virtual ~TApplication ()
 TApplication dtor. More...
 
void InitializeGraphics ()
 Initialize the graphics environment. More...
 
virtual void GetOptions (Int_t *argc, char **argv)
 Get and handle command line options. More...
 
TSignalHandlerGetSignalHandler () const
 
virtual void HandleIdleTimer ()
 Handle idle timeout. More...
 
virtual void Init ()
 
virtual Long_t ProcessLine (const char *line, Bool_t sync=kFALSE, Int_t *error=0)
 Process a single command line, either a C++ statement or an interpreter command starting with a ".". More...
 
virtual Long_t ProcessFile (const char *file, Int_t *error=0, Bool_t keep=kFALSE)
 Process a file containing a C++ macro. More...
 
virtual void SetIdleTimer (UInt_t idleTimeInSec, const char *command)
 Set the command to be executed after the system has been idle for idleTimeInSec seconds. More...
 
virtual void RemoveIdleTimer ()
 Remove idle timer. Normally called via TROOT::Idle(0). More...
 
const char * GetIdleCommand () const
 
virtual void StartIdleing ()
 Called when system starts idleing. More...
 
virtual void StopIdleing ()
 Called when system stops idleing. More...
 
EExitOnException ExitOnException (EExitOnException opt=kExit)
 Set the exit on exception option. More...
 
virtual const char * ApplicationName () const
 
virtual void Show ()
 
virtual void Hide ()
 
virtual void Iconify ()
 
virtual void Open ()
 
virtual void Raise ()
 
virtual void Lower ()
 
virtual Bool_t IsCmdThread ()
 
virtual TApplicationImpGetApplicationImp ()
 
virtual void ls (Option_t *option="") const
 Show available sessions. More...
 
Int_t Argc () const
 
char ** Argv () const
 
char * Argv (Int_t index) const
 Return specified argument. More...
 
Bool_t NoLogOpt () const
 
Bool_t NoLogoOpt () const
 
Bool_t QuitOpt () const
 
TObjArrayInputFiles () const
 
const char * WorkingDirectory () const
 
void ClearInputFiles ()
 Clear list containing macro files passed as program arguments. More...
 
TApplicationGetAppRemote () const
 
Bool_t IsRunning () const
 
Bool_t ReturnFromRun () const
 
void SetReturnFromRun (Bool_t ret)
 
virtual void LineProcessed (const char *line)
 Emit signal when a line has been processed. More...
 
virtual void KeyPressed (Int_t key)
 Emit signal when console keyboard key was pressed. More...
 
virtual void ReturnPressed (char *text)
 Emit signal when return key was pressed. 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 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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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...
 
- Public Member Functions inherited from TQObject
 TQObject ()
 TQObject Constructor. More...
 
virtual ~TQObject ()
 TQObject Destructor. More...
 
TListGetListOfClassSignals () const
 Returns pointer to list of signals of this class. More...
 
TListGetListOfSignals () const
 
TListGetListOfConnections () const
 
Bool_t AreSignalsBlocked () const
 
Bool_t BlockSignals (Bool_t b)
 
void CollectClassSignalLists (TList &list, TClass *cls)
 Collect class signal lists from class cls and all its base-classes. More...
 
template<typename... T>
void EmitVA (const char *signal_name, Int_t, const T &...params)
 
void EmitVA (const char *signal, Int_t nargs, va_list va)=delete
 
void Emit (const char *signal)
 Acitvate signal without args. More...
 
void Emit (const char *signal, Long_t *paramArr)
 Emit a signal with a varying number of arguments, paramArr is an array of the parameters. More...
 
void Emit (const char *signal, const char *params)
 Activate signal with parameter text string. More...
 
void Emit (const char *signal, Double_t param)
 Activate signal with single parameter. More...
 
void Emit (const char *signal, Long_t param)
 Activate signal with single parameter. More...
 
void Emit (const char *signal, Long64_t param)
 Activate signal with single parameter. More...
 
void Emit (const char *signal, Bool_t param)
 
void Emit (const char *signal, Char_t param)
 
void Emit (const char *signal, UChar_t param)
 
void Emit (const char *signal, Short_t param)
 
void Emit (const char *signal, UShort_t param)
 
void Emit (const char *signal, Int_t param)
 
void Emit (const char *signal, UInt_t param)
 
void Emit (const char *signal, ULong_t param)
 
void Emit (const char *signal, ULong64_t param)
 
void Emit (const char *signal, Float_t param)
 
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. More...
 
Bool_t Disconnect (const char *signal=0, void *receiver=0, const char *slot=0)
 Disconnects signal of this object from slot of receiver. More...
 
virtual void HighPriority (const char *signal_name, const char *slot_name=0)
 
virtual void LowPriority (const char *signal_name, const char *slot_name=0)
 
virtual Bool_t HasConnection (const char *signal_name) const
 Return true if there is any object connected to this signal. More...
 
virtual Int_t NumberOfSignals () const
 Return number of signals for this object. More...
 
virtual Int_t NumberOfConnections () const
 Return number of connections for this object. More...
 
virtual void Connected (const char *)
 
virtual void Disconnected (const char *)
 
virtual void Destroyed ()
 
virtual void ChangedBy (const char *method)
 
virtual void Message (const char *msg)
 

Private Member Functions

 TRint (const TRint &)
 
TRintoperator= (const TRint &)
 
void ExecLogon ()
 Execute logon macro's. More...
 
Long_t ProcessRemote (const char *line, Int_t *error=0)
 Process the content of a line starting with ".R" (already stripped-off) The format is [user@]host[:dir] [-l user] [-d dbg] [script] The variable 'dir' is the remote directory to be used as working dir. More...
 
Long_t ProcessLineNr (const char *filestem, const char *line, Int_t *error=0)
 Calls ProcessLine() possibly prepending a line directive for better diagnostics. More...
 

Private Attributes

Int_t fNcmd
 
TString fDefaultPrompt
 
char fPrompt [64]
 
Bool_t fInterrupt
 
Bool_t fCaughtException
 
TFileHandlerfInputHandler
 

Additional Inherited Members

- Public Types inherited from TApplication
enum  EStatusBits { kProcessRemotely = BIT(15), kDefaultApplication = BIT(16) }
 
enum  EFileBits { kExpression = BIT(14) }
 
enum  EExitOnException { kDontExit, kExit, kAbort }
 
- 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 TApplication
static Long_t ExecuteFile (const char *file, Int_t *error=0, Bool_t keep=kFALSE)
 Execute a file containing a C++ macro (static method). More...
 
static TListGetApplications ()
 Static method returning the list of available applications. More...
 
static void CreateApplication ()
 Static function used to create a default application environment. More...
 
static void NeedGraphicsLibs ()
 Static method. More...
 
- 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...
 
- Static Public Member Functions inherited from TQObject
static Bool_t Connect (TQObject *sender, const char *signal, const char *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver. More...
 
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. More...
 
static Bool_t Disconnect (TQObject *sender, const char *signal=0, void *receiver=0, const char *slot=0)
 Disconnects signal in object sender from slot_method in object receiver. More...
 
static Bool_t Disconnect (const char *class_name, const char *signal, void *receiver=0, const char *slot=0)
 Disconnects "class signal". More...
 
static Bool_t AreAllSignalsBlocked ()
 Returns true if all signals are blocked. More...
 
static Bool_t BlockAllSignals (Bool_t b)
 Block or unblock all signals. Returns the previous block status. More...
 
- Protected Member Functions inherited from TApplication
 TApplication ()
 Default ctor. Can be used by classes deriving from TApplication. More...
 
virtual void Help (const char *line)
 Print help on interpreter. More...
 
virtual void LoadGraphicsLibs ()
 Load shared libs necessary for graphics. More...
 
virtual void MakeBatch ()
 Switch to batch mode. More...
 
void SetSignalHandler (TSignalHandler *sh)
 
- 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...
 
- Protected Member Functions inherited from TQObject
virtual voidGetSender ()
 
virtual const char * GetSenderClassName () const
 
- Static Protected Member Functions inherited from TApplication
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

[user@]host[:dir] [-l user] [-d dbg] [script]

The variable 'dir' is the remote directory to be used as working dir. More...

 
static TApplicationOpen (const char *url, Int_t debug, const char *script)
 Static function used to attach to an existing remote application or to start one. More...
 
static void Close (TApplication *app)
 Static function used to close a remote application. More...
 
- Static Protected Member Functions inherited from TQObject
static Bool_t ConnectToClass (TQObject *sender, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver. More...
 
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. More...
 
static Int_t CheckConnectArgs (TQObject *sender, TClass *sender_class, const char *signal, TClass *receiver_class, const char *slot)
 Checking of consitency of sender/receiver methods/arguments. More...
 
static TString CompressName (const char *method_name)
 
- Protected Attributes inherited from TApplication
TApplicationfAppRemote
 
- Protected Attributes inherited from TQObject
TListfListOfSignals
 
TListfListOfConnections
 list of signals from this object More...
 
Bool_t fSignalsBlocked
 list of connections to this object More...
 
- Static Protected Attributes inherited from TApplication
static TListfgApplications = 0
 
- Static Protected Attributes inherited from TQObject
static Bool_t fgAllSignalsBlocked = kFALSE
 flag used for suppression of signals More...
 

#include <TRint.h>

+ Inheritance diagram for TRint:
+ Collaboration diagram for TRint:

Constructor & Destructor Documentation

TRint::TRint ( const TRint )
private
TRint::TRint ( const char *  appClassName,
int *  argc,
char **  argv,
void options = 0,
int  numOptions = 0,
Bool_t  noLogo = kFALSE 
)
TRint::~TRint ( )
virtual

Destructor.

Definition at line 272 of file TRint.cxx.

Member Function Documentation

TRint::ClassDef ( TRint  ,
 
)
void TRint::ExecLogon ( )
private

Execute logon macro's.

There are three levels of logon macros that will be executed: the system logon etc/system.rootlogon.C, the global user logon ~/.rootlogon.C and the local ./.rootlogon.C. For backward compatibility also the logon macro as specified by the Rint.Logon environment setting, by default ./rootlogon.C, will be executed. No logon macros will be executed when the system is started with the -n option.

Definition at line 297 of file TRint.cxx.

TFileHandler* TRint::GetInputHandler ( )
inline

Definition at line 67 of file TRint.h.

char * TRint::GetPrompt ( )
virtual

Get prompt from interpreter. Either "root [n]" or "end with '}'".

Definition at line 528 of file TRint.cxx.

Referenced by HandleTermInput(), and Run().

void TRint::HandleException ( Int_t  sig)
virtual

Handle exceptions (kSigBus, kSigSegmentationViolation, kSigIllegalInstruction and kSigFloatingException) trapped in TSystem.

Specific TApplication implementations may want something different here.

Reimplemented from TApplication.

Definition at line 643 of file TRint.cxx.

Bool_t TRint::HandleTermInput ( )
virtual

Handle input coming from terminal.

Reimplemented from TApplication.

Definition at line 563 of file TRint.cxx.

void TRint::Interrupt ( )
inline

Definition at line 64 of file TRint.h.

TRint& TRint::operator= ( const TRint )
private
void TRint::PrintLogo ( Bool_t  lite = kFALSE)
virtual

Print the ROOT logo on standard output.

Definition at line 467 of file TRint.cxx.

Long_t TRint::ProcessLineNr ( const char *  filestem,
const char *  line,
Int_t error = 0 
)
private

Calls ProcessLine() possibly prepending a line directive for better diagnostics.

Must be called after fNcmd has been increased for the next line.

Definition at line 727 of file TRint.cxx.

Referenced by HandleTermInput(), and Run().

Long_t TRint::ProcessRemote ( const char *  line,
Int_t error = 0 
)
privatevirtual

Process the content of a line starting with ".R" (already stripped-off) The format is [user@]host[:dir] [-l user] [-d dbg] [script] The variable 'dir' is the remote directory to be used as working dir.

The username can be specified in two ways, "-l" having the priority (as in ssh). A 'dbg' value > 0 gives increasing verbosity. The last argument 'script' allows to specify an alternative script to be executed remotely to startup the session.

Reimplemented from TApplication.

Definition at line 705 of file TRint.cxx.

void TRint::Run ( Bool_t  retrn = kFALSE)
virtual

Main application eventloop.

First process files given on the command line and then go into the main application event loop, unless the -q command line option was specfied in which case the program terminates. When retrun is true this method returns even when -q was specified.

When QuitOpt is true and retrn is false, terminate the application with an error code equal to either the ProcessLine error (if any) or the return value of the command casted to a long.

Reimplemented from TApplication.

Definition at line 350 of file TRint.cxx.

void TRint::SetEchoMode ( Bool_t  mode)
virtual

Set console mode:

mode = kTRUE - echo input symbols mode = kFALSE - noecho input symbols

Reimplemented from TApplication.

Definition at line 689 of file TRint.cxx.

const char * TRint::SetPrompt ( const char *  newPrompt)
virtual

Set a new default prompt.

It returns the previous prompt. The prompt may contain a d which will be replaced by the commend number. The default prompt is "root [%d] ". The maximum length of the prompt is 55 characters. To set the prompt in an interactive session do: root [0] ((TRint*)gROOT->GetApplication())->SetPrompt("aap> ") aap>

Definition at line 548 of file TRint.cxx.

Referenced by ProcessLineNr(), and ProcessRemote().

Int_t TRint::TabCompletionHook ( char *  buf,
int *  pLoc,
std::ostream &  out 
)
virtual

Forward tab completion request to our TTabCom::Hook().

Reimplemented from TApplication.

Definition at line 752 of file TRint.cxx.

void TRint::Terminate ( int  status)
virtual

Terminate the application.

Reset the terminal to sane mode and call the logoff macro defined via Rint.Logoff environment variable.

Reimplemented from TApplication.

Definition at line 659 of file TRint.cxx.

Referenced by HandleTermInput(), and Run().

Member Data Documentation

Bool_t TRint::fCaughtException
private

Definition at line 42 of file TRint.h.

Referenced by HandleException(), and Run().

TString TRint::fDefaultPrompt
private

Definition at line 39 of file TRint.h.

Referenced by GetPrompt(), and SetPrompt().

TFileHandler* TRint::fInputHandler
private

Definition at line 43 of file TRint.h.

Referenced by GetInputHandler(), HandleTermInput(), Run(), and ~TRint().

Bool_t TRint::fInterrupt
private

Definition at line 41 of file TRint.h.

Referenced by HandleTermInput().

Int_t TRint::fNcmd
private

Definition at line 38 of file TRint.h.

Referenced by GetPrompt(), HandleTermInput(), ProcessLineNr(), and Run().

char TRint::fPrompt[64]
private

Definition at line 40 of file TRint.h.

Referenced by GetPrompt().


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