Logo ROOT  
Reference Guide
Go to the documentation of this file.
1// @(#)root/base:$Id$
2// Author: Fons Rademakers 22/12/95
5 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
12#ifndef ROOT_TApplication
13#define ROOT_TApplication
17// //
18// TApplication //
19// //
20// This class creates the ROOT Application Environment that interfaces //
21// to the windowing system eventloop and eventhandlers. //
22// This class must be instantiated exactly once in any given //
23// application. Normally the specific application class inherits from //
24// TApplication (see TRint). //
25// //
28#include "TObject.h"
30#include "TQObject.h"
32#include "TApplicationImp.h"
34class TObjArray;
35class TTimer;
36class TSignalHandler;
39class TApplication : public TObject, public TQObject {
42 // TApplication specific bits
44 kProcessRemotely = BIT(15), // TRUE if this line has to be processed remotely
45 kDefaultApplication = BIT(16) // TRUE if created via CreateApplication()
46 };
47 // TApplication specific bits for fFiles
48 enum EFileBits {
49 kExpression = BIT(14) // If the arguments is an expression rather than a file.
50 };
54 kAbort
55 };
58 Int_t fArgc; //Number of com mand line arguments
59 char **fArgv; //Command line arguments
60 TApplicationImp *fAppImp; //!Window system specific application implementation
61 std::atomic<bool> fIsRunning; //True when in event loop (Run() has been called)
62 Bool_t fReturnFromRun; //When true return from Run()
63 Bool_t fNoLog; //Do not process logon and logoff macros
64 Bool_t fNoLogo; //Do not show splash screen and welcome message
65 Bool_t fQuit; //Exit after having processed input files
66 TObjArray *fFiles; //Array of input files or C++ expression (TObjString's) specified via argv
67 TString fWorkDir; //Working directory specified via argv
68 TString fIdleCommand; //Command to execute while application is idle
69 TTimer *fIdleTimer; //Idle timer
70 TSignalHandler *fSigHandler; //Interrupt handler
71 EExitOnException fExitOnException; //Exit on exception option
73 static Bool_t fgGraphNeeded; // True if graphics libs need to be initialized
74 static Bool_t fgGraphInit; // True if graphics libs initialized
76 TApplication(const TApplication&) = delete;
80 TApplication *fAppRemote; //Current remote application, if defined
82 static TList *fgApplications; //List of available applications
86 virtual Longptr_t ProcessRemote(const char *line, Int_t *error = nullptr);
87 virtual void Help(const char *line);
88 virtual void LoadGraphicsLibs();
89 virtual void MakeBatch();
92 static Int_t ParseRemoteLine(const char *ln,
93 TString &hostdir, TString &user,
94 Int_t &dbg, TString &script);
95 static TApplication *Open(const char *url, Int_t debug, const char *script);
96 static void Close(TApplication *app);
99 TApplication(const char *appClassName, Int_t *argc, char **argv,
100 void *options = nullptr, Int_t numOptions = 0);
101 virtual ~TApplication();
103 void InitializeGraphics(Bool_t only_web = kFALSE);
104 virtual void GetOptions(Int_t *argc, char **argv);
106 virtual void SetEchoMode(Bool_t mode);
107 void OpenInBrowser(const TString & url);
108 void OpenReferenceGuideFor(const TString & strippedClass);
109 virtual void HandleException(Int_t sig);
110 virtual void HandleIdleTimer(); //*SIGNAL*
111 virtual Bool_t HandleTermInput() { return kFALSE; }
112 virtual void Init() { fAppImp->Init(); }
113 virtual Longptr_t ProcessLine(const char *line, Bool_t sync = kFALSE, Int_t *error = nullptr);
114 virtual Longptr_t ProcessFile(const char *file, Int_t *error = nullptr, Bool_t keep = kFALSE);
115 virtual void Run(Bool_t retrn = kFALSE);
116 virtual void SetIdleTimer(UInt_t idleTimeInSec, const char *command);
117 virtual void RemoveIdleTimer();
118 const char *GetIdleCommand() const { return fIdleCommand; }
119 virtual void StartIdleing();
120 virtual void StopIdleing();
123 virtual const char *ApplicationName() const { return fAppImp->ApplicationName(); }
124 virtual void Show() { fAppImp->Show(); }
125 virtual void Hide() { fAppImp->Hide(); }
126 virtual void Iconify() { fAppImp->Iconify(); }
127 virtual void Open() { fAppImp->Open(); }
128 virtual void Raise() { fAppImp->Raise(); }
129 virtual void Lower() { fAppImp->Lower(); }
130 virtual Bool_t IsCmdThread() { return fAppImp ? fAppImp->IsCmdThread() : kTRUE; }
133 void ls(Option_t *option="") const override;
135 Int_t Argc() const { return fArgc; }
136 char **Argv() const { return fArgv; }
137 char *Argv(Int_t index) const;
138 Bool_t NoLogOpt() const { return fNoLog; }
139 Bool_t NoLogoOpt() const { return fNoLogo; }
140 Bool_t QuitOpt() const { return fQuit; }
141 TObjArray *InputFiles() const { return fFiles; }
142 const char *WorkingDirectory() const { return fWorkDir; }
143 void ClearInputFiles();
147 Bool_t IsRunning() const { return fIsRunning; }
151 virtual void LineProcessed(const char *line); //*SIGNAL*
152 virtual void Terminate(Int_t status = 0); //*SIGNAL*
153 virtual void KeyPressed(Int_t key); //*SIGNAL*
154 virtual void ReturnPressed(char *text ); //*SIGNAL*
155 virtual Int_t TabCompletionHook(char *buf, int *pLoc, std::ostream& out);
157 static Longptr_t ExecuteFile(const char *file, Int_t *error = nullptr, Bool_t keep = kFALSE);
158 static TList *GetApplications();
159 static void CreateApplication();
160 static void NeedGraphicsLibs();
162 ClassDefOverride(TApplication,0) //GUI application singleton
#define R__EXTERN
Definition: DllImport.h:27
bool Bool_t
Definition: RtypesCore.h:63
int Int_t
Definition: RtypesCore.h:45
long Longptr_t
Definition: RtypesCore.h:82
const Bool_t kFALSE
Definition: RtypesCore.h:101
unsigned int UInt_t
Definition: RtypesCore.h:46
const Bool_t kTRUE
Definition: RtypesCore.h:100
const char Option_t
Definition: RtypesCore.h:66
#define BIT(n)
Definition: Rtypes.h:85
#define ClassDefOverride(name, id)
Definition: Rtypes.h:339
R__EXTERN TApplication * gApplication
Definition: TApplication.h:165
Option_t Option_t option
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t index
Option_t Option_t TPoint TPoint const char mode
Option_t Option_t TPoint TPoint const char text
ABC describing GUI independent application implementation protocol.
virtual void Show()
virtual const char * ApplicationName() const
virtual void Raise()
virtual void Hide()
virtual void Init()
virtual void Iconify()
virtual void Lower()
virtual Bool_t IsCmdThread()
virtual void Open()
This class creates the ROOT Application Environment that interfaces to the windowing system eventloop...
Definition: TApplication.h:39
EExitOnException ExitOnException(EExitOnException opt=kExit)
Set the exit on exception option.
virtual void KeyPressed(Int_t key)
Emit signal when console keyboard key was pressed.
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 "....
static TList * fgApplications
Definition: TApplication.h:82
static void Close(TApplication *app)
Static function used to close a remote application.
virtual Bool_t HandleTermInput()
Definition: TApplication.h:111
Bool_t IsRunning() const
Definition: TApplication.h:147
virtual void SetEchoMode(Bool_t mode)
Set console echo mode:
TObjArray * InputFiles() const
Definition: TApplication.h:141
virtual void Help(const char *line)
The function lists useful commands (".help") or opens the online reference guide, generated with Doxy...
virtual void LineProcessed(const char *line)
Emit signal when a line has been processed.
void ClearInputFiles()
Clear list containing macro files passed as program arguments.
TApplicationImp * fAppImp
Definition: TApplication.h:60
TApplication(const TApplication &)=delete
static Longptr_t ExecuteFile(const char *file, Int_t *error=nullptr, Bool_t keep=kFALSE)
Execute a file containing a C++ macro (static method).
TSignalHandler * GetSignalHandler() const
Definition: TApplication.h:105
void InitializeGraphics(Bool_t only_web=kFALSE)
Initialize the graphics environment.
virtual void Open()
Definition: TApplication.h:127
virtual void LoadGraphicsLibs()
Load shared libs necessary for graphics.
virtual void StopIdleing()
Called when system stops idleing.
virtual void Iconify()
Definition: TApplication.h:126
Bool_t ReturnFromRun() const
Definition: TApplication.h:148
virtual void StartIdleing()
Called when system starts idleing.
virtual void Run(Bool_t retrn=kFALSE)
Main application eventloop. Calls system dependent eventloop via gSystem.
virtual ~TApplication()
TApplication dtor.
virtual void Lower()
Definition: TApplication.h:129
void OpenReferenceGuideFor(const TString &strippedClass)
It opens the online reference guide, generated with Doxygen, for the chosen scope (class/namespace/st...
virtual void HandleException(Int_t sig)
Handle exceptions (kSigBus, kSigSegmentationViolation, kSigIllegalInstruction and kSigFloatingExcepti...
virtual void MakeBatch()
Switch to batch mode.
virtual void Hide()
Definition: TApplication.h:125
Bool_t fReturnFromRun
Definition: TApplication.h:62
virtual void Init()
Definition: TApplication.h:112
TString fIdleCommand
Definition: TApplication.h:68
char ** Argv() const
Definition: TApplication.h:136
static Bool_t fgGraphNeeded
Definition: TApplication.h:73
virtual void Terminate(Int_t status=0)
Terminate the application by call TSystem::Exit() unless application has been told to return from Run...
TApplication * GetAppRemote() const
Definition: TApplication.h:145
void OpenInBrowser(const TString &url)
The function generates and executes a command that loads the Doxygen URL in a browser.
virtual const char * ApplicationName() const
Definition: TApplication.h:123
void SetReturnFromRun(Bool_t ret)
Definition: TApplication.h:149
Bool_t fQuit
Definition: TApplication.h:65
virtual Int_t TabCompletionHook(char *buf, int *pLoc, std::ostream &out)
What to do when tab is pressed.
EExitOnException fExitOnException
Definition: TApplication.h:71
virtual TApplicationImp * GetApplicationImp()
Definition: TApplication.h:131
TObjArray * fFiles
Definition: TApplication.h:66
const char * GetIdleCommand() const
Definition: TApplication.h:118
Default ctor. Can be used by classes deriving from TApplication.
virtual Longptr_t ProcessFile(const char *file, Int_t *error=nullptr, Bool_t keep=kFALSE)
Process a file containing a C++ macro.
TString fWorkDir
Definition: TApplication.h:67
virtual void ReturnPressed(char *text)
Emit signal when return key was pressed.
static Bool_t fgGraphInit
Definition: TApplication.h:74
virtual void RemoveIdleTimer()
Remove idle timer. Normally called via TROOT::Idle(0).
Bool_t NoLogOpt() const
Definition: TApplication.h:138
virtual void SetIdleTimer(UInt_t idleTimeInSec, const char *command)
Set the command to be executed after the system has been idle for idleTimeInSec seconds.
static void CreateApplication()
Static function used to create a default application environment.
virtual void GetOptions(Int_t *argc, char **argv)
Get and handle command line options.
Bool_t NoLogoOpt() const
Definition: TApplication.h:139
static TList * GetApplications()
Static method returning the list of available applications.
std::atomic< bool > fIsRunning
Window system specific application implementation.
Definition: TApplication.h:61
TApplication & operator=(const TApplication &)=delete
static void NeedGraphicsLibs()
Static method.
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.
TTimer * fIdleTimer
Definition: TApplication.h:69
virtual Bool_t IsCmdThread()
Definition: TApplication.h:130
void ls(Option_t *option="") const override
Show available sessions.
virtual void Raise()
Definition: TApplication.h:128
Bool_t fNoLog
Definition: TApplication.h:63
Bool_t fNoLogo
Definition: TApplication.h:64
virtual void HandleIdleTimer()
Handle idle timeout.
const char * WorkingDirectory() const
Definition: TApplication.h:142
Bool_t QuitOpt() const
Definition: TApplication.h:140
TSignalHandler * fSigHandler
Definition: TApplication.h:70
Int_t Argc() const
Definition: TApplication.h:135
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.
TApplication * fAppRemote
Definition: TApplication.h:80
virtual void Show()
Definition: TApplication.h:124
void SetSignalHandler(TSignalHandler *sh)
Definition: TApplication.h:90
char ** fArgv
Definition: TApplication.h:59
A doubly linked list.
Definition: TList.h:38
An array of TObjects.
Definition: TObjArray.h:31
Mother of all ROOT objects.
Definition: TObject.h:41
This is the ROOT implementation of the Qt object communication mechanism (see also http://www....
Definition: TQObject.h:48
Basic string class.
Definition: TString.h:136
Handles synchronous and a-synchronous timer events.
Definition: TTimer.h:51
TLine * line
Definition: file.py:1