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.

	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.

void	Browse (TBrowser *b) override
	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 Longptr_t	Exec (const char params=nullptr, Int_t error=nullptr)
	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

TClass *	IsA () const override

virtual Bool_t	Load () const
	Load the macro into the interpreter.

TMacro &	operator= (const TMacro &)
	Copy constructor.

void	Paint (Option_t *option="") override
	Execute this macro (called by TPad::Paint).

void	Print (Option_t *option="") const override
	Print contents of this macro.

virtual Int_t	ReadFile (const char *filename)
	Read lines in filename in this macro.

void	SavePrimitive (std::ostream &out, Option_t *option="") override
	Save macro source on stream out.

virtual void	SaveSource (const char *filename)
	Save macro source in filename.

virtual void	SetParams (const char *params=nullptr)
	Set default parameters to execute this macro.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TNamed
	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.

void	Clear (Option_t *option="") override
	Set name and title to empty strings ("").

TObject *	Clone (const char *newname="") const override
	Make a clone of an object using the Streamer facility.

Int_t	Compare (const TObject *obj) const override
	Compare two TNamed objects.

void	Copy (TObject &named) const override
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

const char *	GetName () const override
	Returns name of object.

const char *	GetTitle () const override
	Returns title of object.

ULong_t	Hash () const override
	Return hash value for this object.

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

void	Print (Option_t *option="") const override
	Print TNamed name and title.

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.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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.

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 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 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)

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

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	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.

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.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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.

Protected Member Functions
void	SaveSource (FILE *fp)
	Save macro source in file pointer fp.

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 Attributes
TList *	fLines

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 = (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 )) }

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

◆ TMacro() [2/3]

TMacro::TMacro ( const TMacro & macro )

Copy constructor.

Definition at line 98 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 75 of file TMacro.cxx.

◆ ~TMacro()

TMacro::~TMacro ( )

virtual

Delete this macro.

Definition at line 111 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 138 of file TMacro.cxx.

◆ Browse()

void TMacro::Browse ( TBrowser * b )

overridevirtual

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

TMacro::Browse

void Browse(TBrowser *b) override

When clicking in the browser, the following action is performed on this macro, depending the content ...

Definition TMacro.cxx:171

or set via gEnv->SetValue, eg

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

gEnv

R__EXTERN TEnv * gEnv

Definition TEnv.h:170

TEnv::SetValue

virtual void SetValue(const char *name, const char *value, EEnvLevel level=kEnvChange, const char *type=nullptr)

Set the value of a resource or create a new resource.

Definition TEnv.cxx:736

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

◆ Class()

static TClass * TMacro::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TMacro::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TMacro::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 59 of file TMacro.h.

◆ DeclFileName()

static const char * TMacro::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 59 of file TMacro.h.

◆ Exec()

Longptr_t TMacro::Exec	(	const char *	params = `nullptr`,
		Int_t *	error = `nullptr`
	)

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

◆ GetLineWith()

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

virtual

Search the first line containing text.

Definition at line 297 of file TMacro.cxx.

◆ GetListOfLines()

TList * TMacro::GetListOfLines ( ) const

inline

Definition at line 51 of file TMacro.h.

◆ IsA()

TClass * TMacro::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 59 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 244 of file TMacro.cxx.

◆ operator=()

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

Copy constructor.

Definition at line 120 of file TMacro.cxx.

◆ Paint()

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

overridevirtual

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

Reimplemented from TObject.

Definition at line 311 of file TMacro.cxx.

◆ Print()

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

overridevirtual

Print contents of this macro.

Reimplemented from TObject.

Definition at line 319 of file TMacro.cxx.

◆ ReadFile()

Int_t TMacro::ReadFile ( const char * filename )

virtual

Read lines in filename in this macro.

Definition at line 329 of file TMacro.cxx.

◆ SavePrimitive()

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

overridevirtual

Save macro source on stream out.

Reimplemented from TObject.

Definition at line 382 of file TMacro.cxx.

◆ SaveSource() [1/2]

void TMacro::SaveSource ( const char * filename )

virtual

Save macro source in filename.

Definition at line 354 of file TMacro.cxx.

◆ SaveSource() [2/2]

void TMacro::SaveSource ( FILE * fp )

protected

Save macro source in file pointer fp.

Definition at line 371 of file TMacro.cxx.

◆ SetParams()

void TMacro::SetParams ( const char * params = nullptr )

virtual

Set default parameters to execute this macro.

Definition at line 404 of file TMacro.cxx.

◆ Streamer()

void TMacro::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TMacro::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 59 of file TMacro.h.

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.

core/base/inc/TMacro.h

core/base/src/TMacro.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TMacro() [1/3]

◆ TMacro() [2/3]

◆ TMacro() [3/3]

◆ ~TMacro()

Member Function Documentation

◆ AddLine()

◆ Browse()

◆ Checksum()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ Exec()

◆ GetLineWith()

◆ GetListOfLines()

◆ IsA()

◆ Load()

◆ operator=()

◆ Paint()

◆ Print()

◆ ReadFile()

◆ SavePrimitive()

◆ SaveSource() [1/2]

◆ SaveSource() [2/2]

◆ SetParams()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fLines

◆ fParams