BLCMDdefine Class Reference

Inheritance diagram for BLCMDdefine:

List of all members.

---

Detailed Description

class BLCMDdefine implements the "define" command to define a macro (an argument-expanded set of commands).

Public Member Functions
	BLCMDdefine ()
G4String	commandName ()
int	command (BLArgumentVector &argv, BLArgumentMap &namedArgs)

---

Constructor & Destructor Documentation

BLCMDdefine::BLCMDdefine

(

)

References BLCMDTYPE_CONTROL, BLCommand::registerCommand(), BLCommand::setDescription(), and BLCommand::setSynopsis().

                         : BLCommand()
{
        registerCommand(BLCMDTYPE_CONTROL);
        setSynopsis("defines a macro (argument-expanded set of commands).");
        setDescription("The first argument is the macro name, additional arguments\n"
          "become lines in the body of the expanded macro. The macro name\n"
          "becomes a command with up to 9 positional arguments. When the\n"
          "command is issued, the body is expanded and executed, with\n"
          "these substitutions:\n"
          "  $0     MacroName\n"
          "  $1-$9  Positional arguments of the command\n"
          "  $#     # macro expansions (for generating unique names)\n"
          "NOTE: $paramname is expanded in the define command, but $$paramname "
          "is expanded when the macro is invoked.");
}

---

Member Function Documentation

G4String BLCMDdefine::commandName

(

)

[inline, virtual]

Implements BLCommand.

Referenced by command().

{ return "define"; }

int BLCMDdefine::command	(	BLArgumentVector &	argv,
		BLArgumentMap &	namedArgs
	)			[virtual]

Implements BLCommand.

References commandName(), IndentDesc(), and BLCommand::printError().

{
        if(argv.size() < 1) {
                printError("define: need command name being defined");
                return -1;
        }

        // the arguments are the body
        G4String body;
        for(unsigned i=1; i<argv.size(); ++i) {
                if(argv[i].size() > 0) {body += argv[i]; body += "\n";}
        }

        new Macro(argv[0],body);

        // print the definition
        G4String indent1(commandName());
        do { indent1 += " "; } while(indent1.size() < IndentDesc.size());
        printf("%s%s:\n",indent1.c_str(),argv[0].c_str());
        for(unsigned i=1; i<argv.size(); ++i) {
                if(argv[i].size() > 0) 
                        printf("%s%s\n",IndentDesc.c_str(),argv[i].c_str());
        }

        return 0;
}

---

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

• BLCMDdefine.cc