#include <macros.h>

Inheritance diagram for Macro:

Collaboration diagram for Macro:

Public Types
typedef deque< MacroCommand * > ::iterator	iterator

Public Slots
void	run (void)

void	launch (void)

void	popup (void)

void	dialog (void)

void	acceptDialog (void)

void	dialogAction (int r)

void	dialogClosed (int r)

Public Member Functions
	Macro (void)

	Macro (Str name, Macros *mcs)

	Macro (const Macro &macro)

string	name (void) const

Options &	variables (void)

string	variablesStr (void) const

void	addParameter (const Str &param)

string	expandParameter (const Str &params) const

int	action (void) const

void	setAction (int action)

void	delAction (int action)

bool	button (void) const

MacroButton *	pushButton (void) const

void	addButton (const string &keys)

bool	menu (void) const

void	addMenu (QMenu *menu, int &num)

string	menuStr (void) const

bool	key (void) const

string	setKey (int &index)

void	clear (void)

bool	keep (void) const

bool	overwrite (void) const

int	size (void) const

MacroCommand *	command (int index)

void	push (MacroCommand *mc)

iterator	begin (void)

iterator	end (void)

string	load (ifstream &macrostream, string &line, int &linenum, string &warnings)

void	check (string &warnings)

void	checkOptions (string &warnings)

void	setMacroIndices (void)

void	init (int macronum)

void	reloadRePro (RePro *repro)

void	clearButton (void)

void	setRunButton (void)

void	setStackButton (bool base)

Static Public Member Functions
static void	createIcons (int size)

static void	destroyIcons (void)

Static Public Attributes
static const int	StartUp = 0x01

static const int	ShutDown = 0x02

static const int	FallBack = 0x04

static const int	ExplicitFallBack = 0x08

static const int	StartSession = 0x10

static const int	StopSession = 0x20

static const int	NoMacro = 0x40

Friends
ostream &	operator<< (ostream &str, const Macro &macro)

Detailed Description

A single Macro.

Member Typedef Documentation

typedef deque<MacroCommand*>::iterator iterator

Iterator used to iterate through the commands.

Constructor & Destructor Documentation

Macro ( void )

Default constructor.

Macro	(	Str	name,
		Macros *	mcs
	)

Construct a new macro with name name.

References Macro::addParameter(), Options::clear(), Str::erase(), Macro::ExplicitFallBack, Macro::FallBack, Str::find(), Macro::ShutDown, Macro::StartSession, Macro::StartUp, Macro::StopSession, Str::stripped(), Str::substr(), and Str::WordSpace.

Macro ( const Macro & macro )

Copy constructor.

Member Function Documentation

string name ( void ) const

The name of the macro.

Referenced by Macro::addMenu(), MacroCommand::check(), and Macro::expandParameter().

Options & variables ( void )

Returns the macro variables.

Referenced by MacroCommand::dialog(), MacroCommand::run(), and MacroCommand::start().

string variablesStr ( void ) const

Returns the macro variables as a string.

References Options::save(), and Options::size().

void addParameter ( const Str & param )

Add parameter from param to the macros variables.

References Options::load(), and Options::setToDefaults().

Referenced by Macro::Macro().

string expandParameter ( const Str & params ) const

Replaces macro variables in params by their value.

References Str::erase(), Str::find(), relacs::floor(), Parameter::isNotype(), Parameter::isNumber(), relacs::max(), relacs::min(), Macro::name(), Str::number(), Str::preventLast(), RELACSWidget::printlog(), relacs::rnd(), Macros::RW, StrQueue::size(), Str::stripped(), Str::substr(), Parameter::text(), and Str::WhiteSpace.

Referenced by MacroCommand::acceptDialog(), MacroCommand::checkOptions(), MacroCommand::dialog(), and MacroCommand::execute().

int action ( void ) const

The type of action on which this macro is executed.

Referenced by MacroCommand::execute(), relacs::operator<<(), and Macro::setAction().

void setAction ( int action )

Set the Macro's action flag to action.

References Macro::action().

void delAction ( int action )

Delete the action flag action from the Macro's action.

bool button ( void ) const

True if this Macro has a button.

Referenced by relacs::operator<<().

MacroButton * pushButton ( void ) const

The button of the macro.

void addButton ( const string & keys )

Add button for the macro and its commands to menu.

References Macro::clearButton(), Macro::launch(), and Macro::popup().

bool menu ( void ) const

True if this Macro has a menu.

Referenced by relacs::operator<<().

void addMenu	(	QMenu *	menu,
		int &	num
	)

Add menu for the macro and its commands to menu. num counts the number of macro menus (not each macro gets a menu!).

References Macro::dialog(), Options::empty(), Macro::menuStr(), Macro::name(), and Macro::run().

string menuStr ( void ) const

Forms a string for the menu consisting of the macro name and its variables.

References Options::FirstOnly, Macros::MenuWidth, Options::save(), and Options::size().

Referenced by Macro::acceptDialog(), and Macro::addMenu().

bool key ( void ) const

True if this Macro has a shortcut key.

string setKey ( int & index )

Set a shortcut key for the Macro and return it as a string.

References Macro::FallBack.

void clear ( void )

Clear menu and button.

bool keep ( void ) const

True if this Macro is not to be cleared.

bool overwrite ( void ) const

True if this Macro overwrites existing ones.

int size ( void ) const

The number of commands the macro owns.

Referenced by MacroCommand::addMenu(), and relacs::operator<<().

MacroCommand * command ( int index )

The index -th command of this Macro .

void push ( MacroCommand * mc )

Add the command mc to the list of commands.

Macro::iterator begin ( void )

Returns an iterator pointing to the first command pointer.

Macro::iterator end ( void )

Returns an iterator pointing behind the last command pointer.

string load	(	ifstream &	macrostream,
		string &	line,
		int &	linenum,
		string &	warnings
	)

Load commands from a file until a new macro definition is encountered. Returns the stripped line and in line the full line containing the macro definition or macro parameter. linenum holds the current line number and is incremented whenever load() reads a line. Warnings are appended tp warnings .

References MacroCommand::BrowseCom, MacroCommand::command(), MacroCommand::DetectorCom, Str::empty(), MacroCommand::FilterCom, Str::find(), relacs::line(), MacroCommand::MessageCom, MacroCommand::name(), MacroCommand::parameter(), MacroCommand::setReProCommand(), MacroCommand::ShellCom, MacroCommand::ShutdownCom, MacroCommand::StartSessionCom, MacroCommand::StopSessionCom, Str::strip(), MacroCommand::SwitchCom, MacroCommand::UnknownCom, and Str::WhiteSpace.