Class supporting a collection of lines with C++ code.
A TMacro can be executed, saved to a ROOT file, edited, etc.
A macro can be built line by line by calling the AddLine function. or it can be created directly from a file via the special constructor when the first argument is a file name.
A macro can be executed via the Exec function. Arguments can be specified when calling Exec.
A macro can be drawn in a pad. When the pad is updated, the macro is automatically executed.
The code in the macro can be saved via the SaveSource function. If the macro is in the list of primitives of a pad/canvas, the macro will be saved in the script generated by TCanvas::SaveSource.
A macro can be written to a ROOT file via TObject::Write.
Examples:
Public Member Functions | |
TMacro () | |
Create an empty macro, use AddLine() or ReadFile() to fill this macro. | |
TMacro (const char *name, const char *title="") | |
Create a macro with a name and a title. | |
TMacro (const TMacro &) | |
Copy constructor. | |
virtual | ~TMacro () |
Delete this macro. | |
virtual TObjString * | AddLine (const char *text) |
Add line with text in the list of lines of this macro. | |
virtual void | Browse (TBrowser *b) |
When clicking in the browser, the following action is performed on this macro, depending the content of the variable TMacro.Browse. | |
virtual TMD5 * | Checksum () |
Returns checksum of the current content. | |
virtual Long_t | Exec (const char *params=0, Int_t *error=0) |
Execute this macro with params, if params is 0, default parameters (set via SetParams) are used. | |
virtual TObjString * | GetLineWith (const char *text) const |
Search the first line containing text. | |
TList * | GetListOfLines () const |
virtual Bool_t | Load () const |
Load the macro into the interpreter. | |
TMacro & | operator= (const TMacro &) |
Copy constructor. | |
virtual void | Paint (Option_t *option="") |
Execute this macro (called by TPad::Paint). | |
virtual void | Print (Option_t *option="") const |
Print contents of this macro. | |
virtual Int_t | ReadFile (const char *filename) |
Read lines in filename in this macro. | |
virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
Save macro source on stream out. | |
virtual void | SaveSource (const char *filename) |
Save macro source in filename. | |
virtual void | SetParams (const char *params=0) |
Set default parameters to execute this macro. | |
![]() | |
TNamed () | |
TNamed (const char *name, const char *title) | |
TNamed (const TNamed &named) | |
TNamed copy ctor. | |
TNamed (const TString &name, const TString &title) | |
virtual | ~TNamed () |
TNamed destructor. | |
virtual void | Clear (Option_t *option="") |
Set name and title to empty strings (""). | |
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 two TNamed objects. | |
virtual void | Copy (TObject &named) const |
Copy this to obj. | |
virtual void | FillBuffer (char *&buffer) |
Encode TNamed into output buffer. | |
virtual const char * | GetName () const |
Returns name of object. | |
virtual const char * | GetTitle () const |
Returns title of object. | |
virtual ULong_t | Hash () const |
Return hash value for this object. | |
virtual Bool_t | IsSortable () const |
virtual void | ls (Option_t *option="") const |
List TNamed name and title. | |
TNamed & | operator= (const TNamed &rhs) |
TNamed assignment operator. | |
virtual void | SetName (const char *name) |
Set the name of the TNamed. | |
virtual void | SetNameTitle (const char *name, const char *title) |
Set all the TNamed parameters (name and title). | |
virtual void | SetTitle (const char *title="") |
Set the title of the TNamed. | |
virtual Int_t | Sizeof () const |
Return size of the TNamed part of the 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. | |
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 | 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 for instance with: gROOT->SetSelectedPad(gPad) . | |
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=0) |
Execute method on this object with the given parameter string, e.g. | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=0) |
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 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 UInt_t | GetUniqueID () const |
Return the unique object id. | |
virtual Bool_t | HandleTimer (TTimer *timer) |
Execute action in response of a timer timing out. | |
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) |
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 |
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. | |
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) |
Operator delete []. | |
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 | 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. | |
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. | |
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=0, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. | |
Protected Member Functions | |
void | SaveSource (FILE *fp) |
Save macro source in file pointer fp. | |
![]() | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). | |
void | MakeZombie () |
Protected Attributes | |
TList * | fLines |
TString | fParams |
![]() | |
TString | fName |
TString | fTitle |
Additional Inherited Members | |
![]() | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) } |
enum | EDeprecatedStatusBits { kObjInCanvas = BIT(3) } |
enum | EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) } |
![]() | |
static Long_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. | |
![]() | |
enum | { kOnlyPrepStep = BIT(3) } |
#include <TMacro.h>
TMacro::TMacro | ( | ) |
Create an empty macro, use AddLine() or ReadFile() to fill this macro.
Definition at line 64 of file TMacro.cxx.
TMacro::TMacro | ( | const TMacro & | macro | ) |
Copy constructor.
Definition at line 98 of file TMacro.cxx.
TMacro::TMacro | ( | const char * | name, |
const char * | title = "" |
||
) |
Create a macro with a name and a title.
If name contains a '.' it is assumed to be the name of a file, and
Definition at line 75 of file TMacro.cxx.
|
virtual |
Delete this macro.
Definition at line 112 of file TMacro.cxx.
|
virtual |
Add line with text in the list of lines of this macro.
Definition at line 141 of file TMacro.cxx.
When clicking in the browser, the following action is performed on this macro, depending the content of the variable TMacro.Browse.
TMacro.Browse can be set in the system.rootrc or .rootrc file like:
or set via gEnv->SetValue, eg
By default TMacro.Browse="" -if TMacro.Browse ="" the macro is executed -if TMacro.Browse ="Print" the macro is printed in stdout -if TMacro.Browse is of the form "mymacro.C" the macro void mymacro.C(TMacro *m) is called where m=this macro An example of macro.C saving the macro into a file and viewing it with emacs is shown below:
Reimplemented from TObject.
Definition at line 174 of file TMacro.cxx.
|
virtual |
Returns checksum of the current content.
The returned TMD5 object must be deleted by the user. Returns 0 in case of error.
Definition at line 196 of file TMacro.cxx.
Execute this macro with params, if params is 0, default parameters (set via SetParams) are used.
error is set to an TInterpreter::EErrorCode by TApplication::ProcessLine(). Returns the result of the macro (return value or value of the last expression), cast to a Long_t.
Reimplemented in TEveMacro.
Definition at line 268 of file TMacro.cxx.
|
virtual |
Search the first line containing text.
Definition at line 303 of file TMacro.cxx.
|
virtual |
Load the macro into the interpreter.
Return true in case the loading was successful.
Definition at line 249 of file TMacro.cxx.
Copy constructor.
Definition at line 121 of file TMacro.cxx.
Execute this macro (called by TPad::Paint).
Reimplemented from TObject.
Definition at line 317 of file TMacro.cxx.
|
virtual |
Read lines in filename in this macro.
Definition at line 338 of file TMacro.cxx.
Save macro source on stream out.
Reimplemented from TObject.
Definition at line 397 of file TMacro.cxx.
|
virtual |
Save macro source in filename.
Definition at line 363 of file TMacro.cxx.
|
protected |
Save macro source in file pointer fp.
Definition at line 383 of file TMacro.cxx.
|
virtual |
Set default parameters to execute this macro.
Definition at line 421 of file TMacro.cxx.