Logo ROOT   6.19/01
Reference Guide
TMacro Class Reference

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:

TMacro m("Peaks.C"); //macro m with name "Peaks" is created
//from file Peaks.C
m.Exec(); //macro executed with default arguments
m.Exec("4"); //macro executed with argument
m.SaveSource("newPeaks.C");
TFile f("mymacros.root","recreate");
m.Write(); //macro saved to file with name "Peaks"

Definition at line 31 of file TMacro.h.

Public Member Functions

 TMacro ()
 Create an empty macro, use AddLine() or ReadFile() to fill this macro. More...
 
 TMacro (const TMacro &)
 Copy constructor. More...
 
 TMacro (const char *name, const char *title="")
 Create a macro with a name and a title. More...
 
virtual ~TMacro ()
 Delete this macro. More...
 
virtual TObjStringAddLine (const char *text)
 Add line with text in the list of lines of this macro. More...
 
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. More...
 
virtual TMD5Checksum ()
 Returns checksum of the current content. More...
 
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. More...
 
virtual TObjStringGetLineWith (const char *text) const
 Search the first line containing text. More...
 
TListGetListOfLines () const
 
virtual Bool_t Load () const
 Load the macro into the interpreter. More...
 
TMacrooperator= (const TMacro &)
 Copy constructor. More...
 
virtual void Paint (Option_t *option="")
 Execute this macro (called by TPad::Paint). More...
 
virtual void Print (Option_t *option="") const
 Print contents of this macro. More...
 
virtual Int_t ReadFile (const char *filename)
 Read lines in filename in this macro. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save macro source on stream out. More...
 
virtual void SaveSource (const char *filename)
 Save macro source in filename. More...
 
virtual void SetParams (const char *params=0)
 Set default parameters to execute this macro. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
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 two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. 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 selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. 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 void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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 const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. 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...
 
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). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. 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...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. 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)
 
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 SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. 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...
 

Protected Member Functions

void SaveSource (FILE *fp)
 Save macro source in file pointer fp. More...
 
- 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). More...
 
void MakeZombie ()
 

Protected Attributes

TListfLines
 
TString fParams
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Additional Inherited Members

- Public Types inherited from TObject
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 Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TMacro.h>

Inheritance diagram for TMacro:
[legend]

Constructor & Destructor Documentation

◆ TMacro() [1/3]

TMacro::TMacro ( )

Create an empty macro, use AddLine() or ReadFile() to fill this macro.

Definition at line 62 of file TMacro.cxx.

◆ TMacro() [2/3]

TMacro::TMacro ( const TMacro macro)

Copy constructor.

Definition at line 96 of file TMacro.cxx.

◆ TMacro() [3/3]

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

  • the macro is automatically filled by reading all the lines in the file,
  • if the title is empty, it will be set to the name of the file,
  • the name will be set to the filename without path or extension.

Definition at line 73 of file TMacro.cxx.

◆ ~TMacro()

TMacro::~TMacro ( )
virtual

Delete this macro.

Definition at line 110 of file TMacro.cxx.

Member Function Documentation

◆ AddLine()

TObjString * TMacro::AddLine ( const char *  text)
virtual

Add line with text in the list of lines of this macro.

Definition at line 139 of file TMacro.cxx.

◆ Browse()

void TMacro::Browse ( TBrowser b)
virtual

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:

TMacro.Browse : Action

or set via gEnv->SetValue, eg

gEnv->SetValue("TMacro.Browse","Print");

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:

void mymacro(TMacro *m) {
m->SaveSource("xx.log");
gSystem->Exec("emacs xx.log&");
}

Reimplemented from TObject.

Definition at line 172 of file TMacro.cxx.

◆ Checksum()

TMD5 * TMacro::Checksum ( )
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 194 of file TMacro.cxx.

◆ Exec()

Long_t TMacro::Exec ( const char *  params = 0,
Int_t error = 0 
)
virtual

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 266 of file TMacro.cxx.

◆ GetLineWith()

TObjString * TMacro::GetLineWith ( const char *  text) const
virtual

Search the first line containing text.

Definition at line 301 of file TMacro.cxx.

◆ GetListOfLines()

TList* TMacro::GetListOfLines ( ) const
inline

Definition at line 51 of file TMacro.h.

◆ Load()

Bool_t TMacro::Load ( ) const
virtual

Load the macro into the interpreter.

Return true in case the loading was successful.

Definition at line 247 of file TMacro.cxx.

◆ operator=()

TMacro & TMacro::operator= ( const TMacro macro)

Copy constructor.

Definition at line 119 of file TMacro.cxx.

◆ Paint()

void TMacro::Paint ( Option_t option = "")
virtual

Execute this macro (called by TPad::Paint).

Reimplemented from TObject.

Definition at line 315 of file TMacro.cxx.

◆ Print()

void TMacro::Print ( Option_t option = "") const
virtual

Print contents of this macro.

Reimplemented from TNamed.

Definition at line 323 of file TMacro.cxx.

◆ ReadFile()

Int_t TMacro::ReadFile ( const char *  filename)
virtual

Read lines in filename in this macro.

Definition at line 336 of file TMacro.cxx.

◆ SavePrimitive()

void TMacro::SavePrimitive ( std::ostream &  out,
Option_t option = "" 
)
virtual

Save macro source on stream out.

Reimplemented from TObject.

Definition at line 395 of file TMacro.cxx.

◆ SaveSource() [1/2]

void TMacro::SaveSource ( FILE *  fp)
protected

Save macro source in file pointer fp.

Definition at line 381 of file TMacro.cxx.

◆ SaveSource() [2/2]

void TMacro::SaveSource ( const char *  filename)
virtual

Save macro source in filename.

Definition at line 361 of file TMacro.cxx.

◆ SetParams()

void TMacro::SetParams ( const char *  params = 0)
virtual

Set default parameters to execute this macro.

Definition at line 419 of file TMacro.cxx.

Member Data Documentation

◆ fLines

TList* TMacro::fLines
protected

Definition at line 34 of file TMacro.h.

◆ fParams

TString TMacro::fParams
protected

Definition at line 35 of file TMacro.h.


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