| 1 | /*
|
|---|
| 2 | * HelpAction.def
|
|---|
| 3 | *
|
|---|
| 4 | * Created on: Aug 26, 2010
|
|---|
| 5 | * Author: heber
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | // all includes and forward declarations necessary for non-integral types below
|
|---|
| 9 | #include <string>
|
|---|
| 10 | #include <vector>
|
|---|
| 11 |
|
|---|
| 12 | #include "Parameters/Validators/DiscreteValidator.hpp"
|
|---|
| 13 | #include "Parameters/Validators/Ops_Validator.hpp"
|
|---|
| 14 | #include "Parameters/Validators/Specific/ActionNameValidator.hpp"
|
|---|
| 15 |
|
|---|
| 16 | // i.e. there is an integer with variable name Z that can be found in
|
|---|
| 17 | // ValueStorage by the token "Z" -> first column: int, Z, "Z"
|
|---|
| 18 | // "undefine" if no parameters are required, use (NOPARAM_DEFAULT) for each (undefined) default value
|
|---|
| 19 | #define paramtypes (std::string)
|
|---|
| 20 | #define paramtokens ("help")
|
|---|
| 21 | #define paramdescriptions ("Name of an action whose option list is then given")
|
|---|
| 22 | #define paramdefaults (PARAM_DEFAULT(std::string("none")))
|
|---|
| 23 | #define paramreferences (actionname)
|
|---|
| 24 | #define paramvalids \
|
|---|
| 25 | (DiscreteValidator<std::string>(std::vector<std::string>(1, std::string("none"))) || ActionNameValidator())
|
|---|
| 26 | // NOTE: The _default_ value MUST NOT require validation via ActionNameValidator!
|
|---|
| 27 | // This will trigger an infinite loop of ActionRegistry::fillRegistry() calls as ActionRegistry is
|
|---|
| 28 | // at the time of the filling on of the default values not yet completely constructed!
|
|---|
| 29 |
|
|---|
| 30 | #undef statetypes
|
|---|
| 31 | #undef statereferences
|
|---|
| 32 |
|
|---|
| 33 | // some defines for all the names, you may use ACTION, STATE and PARAMS
|
|---|
| 34 | #define CATEGORY Command
|
|---|
| 35 | #define MENUNAME "command"
|
|---|
| 36 | #define MENUPOSITION 4
|
|---|
| 37 | #define ACTIONNAME Help
|
|---|
| 38 | #define TOKEN "help"
|
|---|
| 39 |
|
|---|
| 40 |
|
|---|
| 41 | // finally the information stored in the ActionTrait specialization
|
|---|
| 42 | #define DESCRIPTION "prints help and available actions, or an action's options"
|
|---|
| 43 | #define SHORTFORM "h"
|
|---|
