/*
 * HelpAction.def
 *
 *  Created on: Aug 26, 2010
 *      Author: heber
 */

// all includes and forward declarations necessary for non-integral types below
#include <string> 
#include <vector> 

#include "Parameters/Validators/DiscreteValidator.hpp"
#include "Parameters/Validators/Ops_Validator.hpp"
#include "Parameters/Validators/Specific/ActionNameValidator.hpp"

// i.e. there is an integer with variable name Z that can be found in
// ValueStorage by the token "Z" -> first column: int, Z, "Z"
// "undefine" if no parameters are required, use (NOPARAM_DEFAULT) for each (undefined) default value
#define paramtypes (std::string)
#define paramtokens ("help")
#define paramdescriptions ("Name of an action whose option list is then given")
#define paramdefaults (PARAM_DEFAULT(std::string("none")))
#define paramreferences (actionname)
#define paramvalids \
(DiscreteValidator<std::string>(std::vector<std::string>(1, std::string("none"))) || ActionNameValidator())
// NOTE: The _default_ value MUST NOT require validation via ActionNameValidator!
// This will trigger an infinite loop of ActionRegistry::fillRegistry() calls as ActionRegistry is
// at the time of the filling on of the default values not yet completely constructed!

#undef statetypes
#undef statereferences

// some defines for all the names, you may use ACTION, STATE and PARAMS
#define CATEGORY Command
#define MENUNAME "command"
#define MENUPOSITION 4
#define ACTIONNAME Help
#define TOKEN "help"


// finally the information stored in the ActionTrait specialization
#define DESCRIPTION "prints help and available actions, or an action's options"
#define SHORTFORM "h"