Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

cmdparam.h File Reference

Public headers for cmdparam.c. More...

#include <stdio.h>
#include "ipc.h"
#include "stringparser.h"

Include dependency graph for cmdparam.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Compounds

class  CmdParamStringParser
class  CmdWrapper
class  SetFnWrapper

Defines

#define PARAM_STRING   0
#define PARAM_BOOL   1
#define PARAM_INT   2
#define PARAM_DOUBLE   3
#define PARAM_NN(type,name,location,doc)
 Parameter which has no bounds. More...

#define PARAM_LL(type,name,location,lower,doc)
 Parameter (of any type) with an integer lower bound. More...

#define PARAM_II(type,name,location,lower,upper,doc)
 Parameter (of any type) with integer upper and lower bounds. More...

#define PARAM_N(type,name,doc)
#define PARAM_L(type,name,lower,doc)
#define PARAM_I(type,name,lower,upper,doc)
#define CONST_I(name,value,is_param,doc)
 Symbolic integer constant. More...

#define CONST_B(name,value,is_param,doc)
 Symbolic boolean constant. More...

#define CONST_F(name,value,is_param,doc)
 Symbolic floating-point constant. More...

#define CONST_S(name,is_param,doc)
 Symbolic string constant, useful only for documentation. More...

#define CMD_MAX_ARGUMENTS   64
 Maximum number of arguments that can be supplied to a command. More...

#define CMD_MAX_LINE_LENGTH   2048
 Command-line length limit. More...

#define CMD_NO_ERROR   0
#define CMD_FATAL_ERROR   -20000
#define CMD_MISC_ERROR   -20001
#define CMD_FILE_ERROR   -20002
#define CMD_PARAMETER_ERROR   -20003
#define CMD_MEMORY_ERROR   -20004
#define CMD_PREREQ_ERROR   -20005
#define CMD_EMPTY   -20006
 Can be returned by command_exec_str(). More...

#define CMD_PARSE_ERROR   -20007
 Can be returned by command_exec_str(). More...

#define CMD_NEVER_CALLED   -20008
 Used for prerequisites. More...

#define CMD_SIGINT_ERROR   -20009
 Command received a SIGINT. More...

#define CMD_ARGS   int argc, const char *argv[]
#define CMD_UNUSED_ARGS   int, const char *[]
#define CMD_DECLARE(name)
 Declare global command function with an associated function object wrapper. More...

#define CMDOBJ_DOC(name,prereq,cargs,numargs,usage,doc)
 Typical way to declare an ordinary command object with documentation. More...

#define CMD_DOC(name,prereq,numargs,usage,doc)
 Wrapper to call a global or static function as a CmdWrapper. More...

#define CMDOBJ_DEFINE_CATCHUP(cargs,numargs,name,usage,doc)
 Typical way to declare a command that should be run even if just catching up to a new counter value. More...

#define CMD_DEFINE_CATCHUP(numargs,name,usage,doc)
 Wrapper to call a global or static catchup function as a CmdWrapper. More...

#define CMDOBJ_DECLARE(Owner,name)
 Defines a simple CmdWrapper wrapping a member function as a subclass. More...

#define SETFN_ARGS   const char* name, void* param, const void* newvalue
 Function that can be registered to be called when a parameter changes. More...

#define SETFN_DECLARE(fnname)
#define SETFNOBJ_DEFINE(cargs,paramname,fnname)
#define SETFN_DEFINE(paramname,fnname)
 Wrapper to call a global or static setfn as a SetFnWrapper. More...

#define SETFNOBJ_DECLARE(Owner,fnname)
 Defines a simple SetFnWrapper wrapping a member function as a subclass. More...

#define CMD_ARG_ITERATORS
#define CMD_ARG_LIST

Typedefs

typedef int cmdstat
typedef cmdstat (* commandfunptr )( int argc, const char *argv[] )
typedef int (* CmdDefs_LineGenerator )( void )
 For use with cmddefs_exec_batch. More...

typedef int HooklistNum
 Type for hooklist index. More...

typedef cmdstat (* ParamSetFn )( const char* name, void* param, const void* newvalue )

Functions

cmdstat cmd_set ( int argc, const char *argv[] )
 Allows control of any parameter in blackboard from command file. More...

cmdstat cmd_hook ( int argc, const char *argv[] )
char* cmdparams_completion_generator (char *text, int state)
 Returns possible completion for command (if any) or parameter (if any). More...

void cmdparam_init_hook (void)
 This routine must be called before using parameters or commands, and no commands should be defined after it is called. More...

int cmdparams_print_doc (FILE *fp, const char* name)
 Print documentation string for any known object to a file. More...

int cmdparam_save_current_state (const char * filename)
char* cmdparam_dupstr (const char *str)
 Allocate a copy of a string; must be freed when done using it. More...

cmdstat cmdparam_set ( const char *name, const char *expr )
 Set a parameter by name from an expression. More...

void params_add_lower_bound_int (const char *name, int lower_bound)
 Add lower bounds to an existing parameter in the user interface structure. More...

void params_add_upper_bound_int (const char *name, int upper_bound)
 Add upper bound to an existing parameter in the user interface structure. More...

int params_check_all ( void )
 Check upper and lower bounds for each parameter, if defined. More...

char* params_completion_generator (char *text, int state)
 For use with functions like readline(); returns a dynamically-allocated string with the next possible completion for the given partial word. More...

void params_define_doc ( const char* name, const char *doc )
 Define help string for a parameter. More...

int params_define_param (const char *name, int type, int is_constant, void *pointer)
 Add a parameter to the user interface structure. More...

void params_define_setfn ( const char* name, SetFnWrapper* setfn )
 Define function to set a specific parameter. More...

void params_define_default_expr (const char *name, const char *expr)
 Add an expression representing a default value. More...

int params_is_constant (int idx)
void params_log (void)
 Prints parameter values to the log file from the parameter blackboard. More...

double* params_lookup_double (const char *name)
 Looks up the given string as a command name and returns a pointer to the data value, or NULL if the parameter was not found (or is not type double). More...

int params_num_total (void)
 Returns current size of parameter blackboard. More...

void params_print_all (FILE *fp)
 Prints parameter values to a file from the parameter blackboard. More...

void params_print_constants (FILE *fp)
 Prints constant values to a file. More...

void params_print_constants_doc (FILE *file)
void params_print_doc (FILE *fp, const char* name)
 Print documentation string for a param to a file. More...

void params_print_doc_for_index (FILE *fp, int idx)
void params_print_parameters (FILE *fp)
 Prints values of all non-constant parameters to a file. More...

void params_print_parameters_doc (FILE *file)
int params_print_to_str (int number, char *str, size_t nchars)
 Converts parameter into the given string in a format suitable for cmddefs_exec_str(). More...

void params_update_all_default_values ( void )
 Generate the default value for all params having an expression for it. More...

void params_update_default_value (const char* name)
 Wrapper taking a name instead of an index. More...

long cmdi (const char* str)
 Integer equivalent of cmdf. More...

double cmdf (const char* str)
 Public routine to read an expression of type double. More...

const char* cmds (const char* str)
 Public routine to read an expression of string type. More...

char* cmddefs_completion_generator (char *text, int state)
 For use with functions like readline(); returns a dynamically-allocated string with the next possible completion for the given partial word. More...

void cmddefs_declare_prereq_status ( const char * name, cmdstat status )
 Ordinary prerequisites are handled automatically, but if a command makes mutually recursive calls to other commands which require it as a prerequisite, the command may call this routine beforehand to declare that its useful work is done, and thus that the prerequisite is satisfied. More...

void cmddefs_define_command ( const char* name, CmdWrapper* function, int minargs, int exec_for_catchups )
 Add command to list of known commands. More...

void cmddefs_define_command_doc ( const char* name, const char *usage, const char *doc )
 Define help string for command. More...

void cmddefs_define_command_prereq ( const char* name, const char *prereq )
 Put a prerequisite for a command into a temporary holding area while the other commands are defined; doesn't take effect until activated later. More...

int cmddefs_exec_batch (CmdDefs_LineGenerator fn, const char * description)
 Reads commands iteratively and executes them in sequence. More...

int cmddefs_exec_file (const char *filename)
 Reads commands from a command file and executes them. More...

cmdstat cmddefs_exec_by_name (const char* name, int argc, const char *argv[] )
cmdstat cmddefs_exec_str (const char* cmdtxt)
 Parse and execute the command specified in the given string. More...

int cmddefs_num_total (void)
 Returns current size of command blackboard. More...

void cmddefs_print_all (FILE *fp)
 Print summary of command definitions to a file. More...

void cmddefs_print_all_doc (FILE *file)
void cmddefs_print_doc (FILE *fp, const char* name)
 Print documentation string for a command to a file. More...

void cmddefs_print_doc_for_index (FILE *fp, int idx)
void hooklists_empty_list (HooklistNum hooklistnum)
 Remove all the hooks defined in the given list. More...

void hooklists_reset_list (HooklistNum hooklist)
 Reset current hook of the given list to the beginning. More...

void hooklists_run_list (HooklistNum hooklist, int counter, int catchuponly)
 Run the counter hooks in the given list which specify this counter value. More...

int hooklists_define_list ( const char * listname, const char *countername )
 Defines a new hooklist and returns its number. More...


Detailed Description

Public headers for cmdparam.c.

Header:
/u/nn/cvsroot/lissom/src/cmdparam.h,v 1.52 2000/08/21 05:07:08 jbednar Exp

Definition in file cmdparam.h.


Define Documentation

#define CMDOBJ_DECLARE( Owner, name )
 

Initializer:

\
cmdstat cmd_ ## name ( CMD_ARGS );                         \
class cmdobj_ ## name : public CmdWrapper {                 \
  Owner* owner;                                              \
public:                                                       \
  cmdobj_ ## name (Owner* owner_i) : owner(owner_i) { };       \
  cmdstat operator() ( CMD_ARGS ) {                             \
    return owner->cmd_ ## name (argc,argv);                      \
  }                                                               \
};                                                                 \
friend class cmdobj_ ## name
Defines a simple CmdWrapper wrapping a member function as a subclass.

Definition at line 189 of file cmdparam.h.

#define CMDOBJ_DEFINE_CATCHUP( cargs, numargs, name, usage, doc )
 

Initializer:

\
cmddefs_define_command(#name,new cmdobj_ ## name(cargs),numargs,True); \
cmddefs_define_command_doc(#name,usage,doc)
Typical way to declare a command that should be run even if just catching up to a new counter value.

Definition at line 178 of file cmdparam.h.

#define CMDOBJ_DOC( name, prereq, cargs, numargs, usage, doc )
 

Initializer:

\
cmddefs_define_command(#name,new cmdobj_ ## name(cargs),numargs,False); \
cmddefs_define_command_doc(#name,usage,doc);                             \
cmddefs_define_command_prereq(#name,prereq)
Typical way to declare an ordinary command object with documentation.

Definition at line 163 of file cmdparam.h.

#define CMD_ARGS   int argc, const char *argv[]
 

Definition at line 134 of file cmdparam.h.

#define CMD_ARG_ITERATORS
 

Initializer:

\
  StringParser::arglist argl(&argv[0],&argv[argc]);\
  StringParser::argptr  args=argl.begin();\
  StringParser::argptr  end =argl.end();\
  const CmdParamStringParser p

Definition at line 387 of file cmdparam.h.

#define CMD_ARG_LIST
 

Initializer:

\
  StringParser::arglist argl(&argv[0],&argv[argc]);\
  const CmdParamStringParser p;\
  StringArgs arglist(p, argl.begin(), argl.end())

Definition at line 394 of file cmdparam.h.

#define CMD_DECLARE( name )
 

Initializer:

\
cmdstat cmd_ ## name ( CMD_ARGS );                         \
struct cmdobj_ ## name : public CmdWrapper {                \
  cmdstat operator() ( CMD_ARGS ) {                          \
    return cmd_ ## name(argc,argv);                           \
  }                                                            \
}
Declare global command function with an associated function object wrapper.

Definition at line 154 of file cmdparam.h.

#define CMD_DEFINE_CATCHUP( numargs, name, usage, doc )
 

Initializer:

\
CMDOBJ_DEFINE_CATCHUP(,numargs,name,usage,doc)
Wrapper to call a global or static catchup function as a CmdWrapper.

Definition at line 184 of file cmdparam.h.

#define CMD_DOC( name, prereq, numargs, usage, doc )
 

Initializer:

\
CMDOBJ_DOC(name,prereq,,numargs,usage,doc)
Wrapper to call a global or static function as a CmdWrapper.

Definition at line 170 of file cmdparam.h.

Referenced by ae_base_response(), and lissom_init_hooks().

#define CMD_EMPTY   -20006
 

Can be returned by command_exec_str().

Definition at line 124 of file cmdparam.h.

#define CMD_FATAL_ERROR   -20000
 

Definition at line 118 of file cmdparam.h.

#define CMD_FILE_ERROR   -20002
 

Definition at line 120 of file cmdparam.h.

#define CMD_MAX_ARGUMENTS   64
 

Maximum number of arguments that can be supplied to a command.

Definition at line 105 of file cmdparam.h.

#define CMD_MAX_LINE_LENGTH   2048
 

Command-line length limit.

Definition at line 108 of file cmdparam.h.

#define CMD_MEMORY_ERROR   -20004
 

Definition at line 122 of file cmdparam.h.

#define CMD_MISC_ERROR   -20001
 

Definition at line 119 of file cmdparam.h.

#define CMD_NEVER_CALLED   -20008
 

Used for prerequisites.

Definition at line 128 of file cmdparam.h.

#define CMD_NO_ERROR   0
 

Definition at line 117 of file cmdparam.h.

#define CMD_PARAMETER_ERROR   -20003
 

Definition at line 121 of file cmdparam.h.

#define CMD_PARSE_ERROR   -20007
 

Can be returned by command_exec_str().

Definition at line 126 of file cmdparam.h.

#define CMD_PREREQ_ERROR   -20005
 

Definition at line 123 of file cmdparam.h.

#define CMD_SIGINT_ERROR   -20009
 

Command received a SIGINT.

Definition at line 130 of file cmdparam.h.

#define CMD_UNUSED_ARGS   int, const char *[]
 

Definition at line 135 of file cmdparam.h.

#define CONST_B( name, value, is_param, doc )
 

Initializer:

\
{ static int param_const_name=value;                                        \
  params_define_param(#name,PARAM_BOOL,!is_param,(void*)&param_const_name);  \
  params_add_lower_bound_int(#name,value);                                    \
  params_add_upper_bound_int(#name,value);                                     \
  params_define_doc(#name,doc);                                                 }
Symbolic boolean constant.

Definition at line 81 of file cmdparam.h.

#define CONST_F( name, value, is_param, doc )
 

Initializer:

\
{ static double param_const_name=value;                                      \
  params_define_param(#name,PARAM_DOUBLE,!is_param,(void*)&param_const_name); \
  params_define_doc(#name,doc);                                               }
Symbolic floating-point constant.

Definition at line 90 of file cmdparam.h.

#define CONST_I( name, value, is_param, doc )
 

Initializer:

\
{ static int param_const_name=value;                                        \
  params_define_param(#name,PARAM_INT,!is_param,(void*)&param_const_name);   \
  params_add_lower_bound_int(#name,value);                                    \
  params_add_upper_bound_int(#name,value);                                     \
  params_define_doc(#name,doc);                                                 }
Symbolic integer constant.

Definition at line 72 of file cmdparam.h.

Referenced by WorldViews::register_params_and_commands(), and KernelFactory::register_params_and_commands().

#define CONST_S( name, is_param, doc )
 

Initializer:

\
{ static char param_const_name[]="";                                         \
  params_define_param(#name,PARAM_STRING,!is_param,(void*)&param_const_name); \
  params_define_doc(#name,doc);                                                }
Symbolic string constant, useful only for documentation.

Definition at line 97 of file cmdparam.h.

Referenced by WorldViews::register_params_and_commands().

#define PARAM_BOOL   1
 

Definition at line 19 of file cmdparam.h.

#define PARAM_DOUBLE   3
 

Definition at line 21 of file cmdparam.h.

#define PARAM_I( type, name, lower, upper, doc )
 

Initializer:

\
params_define_param(#name,type,False,(void*)&name); \
params_add_lower_bound_int(#name,lower);             \
params_add_upper_bound_int(#name,upper);              \
params_define_doc(#name,doc)

Definition at line 58 of file cmdparam.h.

#define PARAM_II( type, name, location, lower, upper, doc )
 

Initializer:

\
params_define_param(#name,type,False,(void*)location); \
params_add_lower_bound_int(#name,lower);                \
params_add_upper_bound_int(#name,upper);                 \
params_define_doc(#name,doc)
Parameter (of any type) with integer upper and lower bounds.

Definition at line 40 of file cmdparam.h.

Referenced by WorldViews::register_params_and_commands(), and KernelFactory::register_params_and_commands().

#define PARAM_INT   2
 

Definition at line 20 of file cmdparam.h.

#define PARAM_L( type, name, lower, doc )
 

Initializer:

\
params_define_param(#name,type,False,(void*)&name); \
params_add_lower_bound_int(#name,lower);             \
params_define_doc(#name,doc)

Definition at line 53 of file cmdparam.h.

#define PARAM_LL( type, name, location, lower, doc )
 

Initializer:

\
params_define_param(#name,type,False,(void*)location); \
params_add_lower_bound_int(#name,lower);                \
params_define_doc(#name,doc)
Parameter (of any type) with an integer lower bound.

Definition at line 33 of file cmdparam.h.

Referenced by WorldViews::register_params_and_commands(), and KernelFactory::register_params_and_commands().

#define PARAM_N( type, name, doc )
 

Initializer:

\
params_define_param(#name,type,False,(void*)&name);   \
params_define_doc(#name,doc)

Definition at line 49 of file cmdparam.h.

#define PARAM_NN( type, name, location, doc )
 

Initializer:

\
params_define_param(#name,type,False,(void*)location);  \
params_define_doc(#name,doc)
Parameter which has no bounds.

Definition at line 27 of file cmdparam.h.

Referenced by WorldViews::register_params_and_commands().

#define PARAM_STRING   0
 

Definition at line 18 of file cmdparam.h.

#define SETFNOBJ_DECLARE( Owner, fnname )
 

Initializer:

\
cmdstat fnname ( SETFN_ARGS );                             \
class setfnobj_ ## fnname : public SetFnWrapper {           \
  Owner* owner;                                              \
public:                                                       \
  setfnobj_ ## fnname (Owner* owner_i) : owner(owner_i) { };   \
  cmdstat operator() ( SETFN_ARGS )  {                          \
    return owner->fnname(name,param,newvalue);                   \
  }                                                               \
};                                                                 \
friend class setfnobj_ ## fnname
Defines a simple SetFnWrapper wrapping a member function as a subclass.

Definition at line 247 of file cmdparam.h.

#define SETFNOBJ_DEFINE( cargs, paramname, fnname )
 

Initializer:

\
params_define_setfn(#paramname,new setfnobj_ ## fnname(cargs))

Definition at line 238 of file cmdparam.h.

#define SETFN_ARGS   const char* name, void* param, const void* newvalue
 

Function that can be registered to be called when a parameter changes.

Definition at line 211 of file cmdparam.h.

#define SETFN_DECLARE( fnname )
 

Initializer:

\
cmdstat fnname( SETFN_ARGS );                               \
struct setfnobj_ ## fnname : public SetFnWrapper {           \
  cmdstat operator() ( SETFN_ARGS )  {                        \
    return fnname(name,param,newvalue);                        \
  }                                                             \
}

Definition at line 228 of file cmdparam.h.

#define SETFN_DEFINE( paramname, fnname )
 

Initializer:

\
SETFNOBJ_DEFINE(,paramname,fnname)
Wrapper to call a global or static setfn as a SetFnWrapper.

Definition at line 242 of file cmdparam.h.

Referenced by WorldViews::register_params_and_commands().


Typedef Documentation

typedef int (* CmdDefs_LineGenerator)( void )
 

For use with cmddefs_exec_batch.

Definition at line 203 of file cmdparam.h.

typedef int HooklistNum
 

Type for hooklist index.

Definition at line 207 of file cmdparam.h.

typedef cmdstat (* ParamSetFn)( const char* name, void* param, const void* newvalue )
 

Definition at line 212 of file cmdparam.h.

typedef int cmdstat
 

Definition at line 116 of file cmdparam.h.

typedef cmdstat (* commandfunptr)( int argc, const char *argv[] )
 

Definition at line 136 of file cmdparam.h.


Function Documentation

cmdstat cmd_hook ( int argc,
const char * argv[] )
 

Definition at line 2502 of file cmdparam.c.

cmdstat cmd_set ( int argc,
const char * argv[] )
 

Allows control of any parameter in blackboard from command file.

Definition at line 3075 of file cmdparam.c.

char * cmddefs_completion_generator ( char * text,
int state )
 

For use with functions like readline(); returns a dynamically-allocated string with the next possible completion for the given partial word.

Free should be called on the string when done with it.

Definition at line 2405 of file cmdparam.c.

void cmddefs_declare_prereq_status ( const char * name,
cmdstat status )
 

Ordinary prerequisites are handled automatically, but if a command makes mutually recursive calls to other commands which require it as a prerequisite, the command may call this routine beforehand to declare that its useful work is done, and thus that the prerequisite is satisfied.

This prevents a vicious circle of attempted prerequisite satisfaction.

Definition at line 1717 of file cmdparam.c.

Referenced by cmd_uninit_network().

void cmddefs_define_command ( const char * name,
CmdWrapper * function,
int minargs,
int exec_for_catchups )
 

Add command to list of known commands.

Definition at line 1643 of file cmdparam.c.

void cmddefs_define_command_doc ( const char * name,
const char * usage,
const char * doc )
 

Define help string for command.

Definition at line 1668 of file cmdparam.c.

void cmddefs_define_command_prereq ( const char * name,
const char * prereq )
 

Put a prerequisite for a command into a temporary holding area while the other commands are defined; doesn't take effect until activated later.

Definition at line 1692 of file cmdparam.c.

int cmddefs_exec_batch ( CmdDefs_LineGenerator fn,
const char * description )
 

Reads commands iteratively and executes them in sequence.

The command lines come from cmddefs_line_buffer, which the given function should place a string into once it is called with no arguments on a single PE. The fn should return True ("done") when there is no more input available.

Each line may be up to CMD_MAX_LINE_LENGTH total, and may contain up to one command with up to CMD_MAX_ARGUMENTS arguments, up to CMD_MAX_LINE_LENGTH total.

The description should be something like "file filename..." or "prompt".

Definition at line 2103 of file cmdparam.c.

Referenced by main().

cmdstat cmddefs_exec_by_name ( const char * name,
int argc,
const char * argv[] )
 

Definition at line 1798 of file cmdparam.c.

int cmddefs_exec_file ( const char * filename )
 

Reads commands from a command file and executes them.

Definition at line 2203 of file cmdparam.c.

Referenced by process_command_line_args(), and read_command_file_if_present().

cmdstat cmddefs_exec_str ( const char * cmdtxt )
 

Parse and execute the command specified in the given string.

Definition at line 2074 of file cmdparam.c.

Referenced by WorldViews::init(), lissom_init_hooks(), load_current(), process_command_line_args(), and WorldViews::set_distribution().

int cmddefs_num_total ( void )
 

Returns current size of command blackboard.

Definition at line 2248 of file cmdparam.c.

void cmddefs_print_all ( FILE * fp )
 

Print summary of command definitions to a file.

Definition at line 2340 of file cmdparam.c.

Referenced by cmd_make_doc().

void cmddefs_print_all_doc ( FILE * file )
 

Definition at line 2386 of file cmdparam.c.

void cmddefs_print_doc ( FILE * fp,
const char * name )
 

Print documentation string for a command to a file.

Definition at line 2369 of file cmdparam.c.

void cmddefs_print_doc_for_index ( FILE * fp,
int idx )
 

Definition at line 2352 of file cmdparam.c.

double cmdf ( const char * str )
 

Public routine to read an expression of type double.

Definition at line 1609 of file cmdparam.c.

Referenced by cmd_kill_connections(), and cmdparam_set().

long cmdi ( const char * str )
 

Integer equivalent of cmdf.

Returns type long but warns if can't fit in int.

Definition at line 1615 of file cmdparam.c.

Referenced by cmd_analyze_activity(), cmd_dump_lat_wts_sq(), cmd_read_args(), cmd_training(), cmdparam_set(), and find_max().

char * cmdparam_dupstr ( const char * str )
 

Allocate a copy of a string; must be freed when done using it.

Definition at line 2863 of file cmdparam.c.

Referenced by cmd_read_args(), and NamedValueGenerators::create().

void cmdparam_init_hook ( void )
 

This routine must be called before using parameters or commands, and no commands should be defined after it is called.

Definition at line 350 of file cmdparam.c.

int cmdparam_save_current_state ( const char * filename )
 

Definition at line 2908 of file cmdparam.c.

cmdstat cmdparam_set ( const char * name,
const char * expr )
 

Set a parameter by name from an expression.

Definition at line 2946 of file cmdparam.c.

Referenced by cmd_read_args(), and process_command_line_args().

char * cmdparams_completion_generator ( char * text,
int state )
 

Returns possible completion for command (if any) or parameter (if any).

Definition at line 2900 of file cmdparam.c.

int cmdparams_print_doc ( FILE * fp,
const char * name )
 

Print documentation string for any known object to a file.

Returns True if object was found.

Definition at line 2876 of file cmdparam.c.

const char * cmds ( const char * str )
 

Public routine to read an expression of string type.

Definition at line 1631 of file cmdparam.c.

Referenced by CmdParamStringParser::clone(), cmd_make_doc(), cmd_read_args(), cmdparam_set(), WorldViews::print_object(), and WorldViews::remove_object().

int hooklists_define_list ( const char * listname,
const char * countername )
 

Defines a new hooklist and returns its number.

 Example C usage:

(at start of program) HooklistNum before_input; before_input = hooklists_define_list("before_input");

(at location where hooks should execute) hooklists_run_list(before_input,t,False);

Now the command hook before_input 5 set exc_rad 1

will cause parameter exc_rad to be changed to 1 whenever hooklists_run_list is called with t=5.

Returns the number assigned to this list.

Definition at line 2457 of file cmdparam.c.

void hooklists_empty_list ( HooklistNum hooklistnum )
 

Remove all the hooks defined in the given list.

Definition at line 2764 of file cmdparam.c.

Referenced by cmd_uninit_network().

void hooklists_reset_list ( HooklistNum hooklist )
 

Reset current hook of the given list to the beginning.

Definition at line 2753 of file cmdparam.c.

void hooklists_run_list ( HooklistNum hooklist,
int counter,
int catchuponly )
 

Run the counter hooks in the given list which specify this counter value.

Earlier values not yet run are called only if their definition specifies that.

This routine should be called at most once for each counter value, from the location where you want hooks from the given list to be called.

Definition at line 2690 of file cmdparam.c.

Referenced by advance_iteration_counter(), cmd_training(), load_current(), and present_inputs().

void params_add_lower_bound_int ( const char * name,
int lower_bound )
 

Add lower bounds to an existing parameter in the user interface structure.

Only supports integer bounds at present, though it can add them to either integer or float parameters.

Definition at line 656 of file cmdparam.c.

Referenced by cmd_read_args().

void params_add_upper_bound_int ( const char * name,
int upper_bound )
 

Add upper bound to an existing parameter in the user interface structure.

Only supports integer bounds at present, though it can add them to either integer or float parameters

Definition at line 692 of file cmdparam.c.

Referenced by cmd_read_args().

int params_check_all ( void )
 

Check upper and lower bounds for each parameter, if defined.

Returns the number that had errors.

Definition at line 918 of file cmdparam.c.

char * params_completion_generator ( char * text,
int state )
 

For use with functions like readline(); returns a dynamically-allocated string with the next possible completion for the given partial word.

Free should be called on the string when done with it.

Definition at line 1257 of file cmdparam.c.

void params_define_default_expr ( const char * name,
const char * expr )
 

Add an expression representing a default value.

The expression must be allocated in storage that will persist until the last call to params_update_default_value(const char *name) is issued; a string literal will suffice.

Definition at line 730 of file cmdparam.c.

Referenced by ae_base_response(), WorldViews::register_params_and_commands(), and KernelFactory::register_params_and_commands().

void params_define_doc ( const char * name,
const char * doc )
 

Define help string for a parameter.

The docstring should ordinarily be a string literal to avoid scoping and lifetime problems.

Definition at line 878 of file cmdparam.c.

Referenced by cmd_read_args(), NamedValueGenerators::create(), and WorldViews::register_params_and_commands().

int params_define_param ( const char * name,
int type,
int is_constant,
void * pointer )
 

Add a parameter to the user interface structure.

Returns a true value if the parameter is defined by the end of the call -- 1 if it was defined by this call, 2 if it was already defined

Definition at line 602 of file cmdparam.c.

Referenced by cmd_read_args(), NamedValueGenerators::create(), and WorldViews::register_params_and_commands().

void params_define_setfn ( const char * name,
SetFnWrapper * setfn )
 

Define function to set a specific parameter.

Definition at line 897 of file cmdparam.c.

int params_is_constant ( int idx )
 

Definition at line 1198 of file cmdparam.c.

void params_log ( void )
 

Prints parameter values to the log file from the parameter blackboard.

Definition at line 968 of file cmdparam.c.

double * params_lookup_double ( const char * name )
 

Looks up the given string as a command name and returns a pointer to the data value, or NULL if the parameter was not found (or is not type double).

Definition at line 1288 of file cmdparam.c.

int params_num_total ( void )
 

Returns current size of parameter blackboard.

Definition at line 932 of file cmdparam.c.

void params_print_all ( FILE * fp )
 

Prints parameter values to a file from the parameter blackboard.

Definition at line 1005 of file cmdparam.c.

void params_print_constants ( FILE * fp )
 

Prints constant values to a file.

Definition at line 1030 of file cmdparam.c.

Referenced by cmd_make_doc().

void params_print_constants_doc ( FILE * file )
 

Definition at line 1223 of file cmdparam.c.

void params_print_doc ( FILE * fp,
const char * name )
 

Print documentation string for a param to a file.

Definition at line 1206 of file cmdparam.c.

void params_print_doc_for_index ( FILE * fp,
int idx )
 

Definition at line 1182 of file cmdparam.c.

void params_print_parameters ( FILE * fp )
 

Prints values of all non-constant parameters to a file.

Definition at line 1017 of file cmdparam.c.

Referenced by cmd_make_doc().

void params_print_parameters_doc ( FILE * file )
 

Definition at line 1237 of file cmdparam.c.

int params_print_to_str ( int number,
char * str,
size_t nchars )
 

Converts parameter into the given string in a format suitable for cmddefs_exec_str().

Definition at line 941 of file cmdparam.c.

void params_update_all_default_values ( void )
 

Generate the default value for all params having an expression for it.

Definition at line 784 of file cmdparam.c.

void params_update_default_value ( const char * name )
 

Wrapper taking a name instead of an index.

Definition at line 766 of file cmdparam.c.


Generated at Mon Aug 21 00:30:58 2000 for RF-LISSOM by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000