3 * Interface definition for encapsulated commands.
4 * Started Spring 2001 by David Megginson, david@megginson.com
5 * This code is released into the Public Domain.
10 #ifndef __COMMANDS_HXX
11 #define __COMMANDS_HXX
14 #include <simgear/compiler.h>
20 #include <simgear/props/props.hxx>
30 * <p>This class allows the application to register and unregister
31 * commands, and provides shortcuts for executing them. Commands are
32 * simple functions that take a const pointer to an SGPropertyNode:
33 * the function may use the nodes children as parameters.</p>
35 * @author David Megginson, david@megginson.com
42 * Type for a command function.
44 typedef bool (*command_t) (const SGPropertyNode * arg);
48 * Default constructor.
56 virtual ~SGCommandMgr ();
60 * Register a new command with the manager.
62 * @param name The command name. Any existing command with
63 * the same name will silently be overwritten.
64 * @param command A pointer to a one-arg function returning
65 * a bool result. The argument is always a const pointer to
66 * an SGPropertyNode (which may contain multiple values).
68 virtual void addCommand (const string &name, command_t command);
72 * Look up an existing command.
74 * @param name The command name.
75 * @return A pointer to the command, or 0 if there is no registered
76 * command with the name specified.
78 virtual command_t getCommand (const string &name) const;
82 * Get a list of all existing command names.
84 * @return A (possibly empty) vector of the names of all registered
87 virtual vector<string> getCommandNames () const;
93 * @param name The name of the command.
94 * @param arg A const pointer to an SGPropertyNode. The node
95 * may have a value and/or children, etc., so that it is possible
96 * to pass an arbitrarily complex data structure to a command.
97 * @return true if the command is present and executes successfully,
100 virtual bool execute (const string &name, const SGPropertyNode * arg) const;
104 typedef map<string,command_t> command_map;
105 command_map _commands;
109 #endif // __COMMANDS_HXX
111 // end of commands.hxx