diff options
Diffstat (limited to 'src/progs/ingen/cmdline.h')
| -rw-r--r-- | src/progs/ingen/cmdline.h | 169 |
1 files changed, 128 insertions, 41 deletions
diff --git a/src/progs/ingen/cmdline.h b/src/progs/ingen/cmdline.h index 1c0bf681..9caa9529 100644 --- a/src/progs/ingen/cmdline.h +++ b/src/progs/ingen/cmdline.h @@ -1,6 +1,9 @@ -/* cmdline.h */ - -/* File autogenerated by gengetopt */ +/** @file cmdline.h + * @brief The header file for the command line option parser + * generated by GNU Gengetopt version 2.21 + * http://www.gnu.org/software/gengetopt. + * DO NOT modify this file, since it can be overwritten + * @author GNU Gengetopt by Lorenzo Bettini */ #ifndef CMDLINE_H #define CMDLINE_H @@ -15,75 +18,159 @@ extern "C" { #endif /* __cplusplus */ #ifndef CMDLINE_PARSER_PACKAGE +/** @brief the program name */ #define CMDLINE_PARSER_PACKAGE "ingen" #endif #ifndef CMDLINE_PARSER_VERSION +/** @brief the program version */ #define CMDLINE_PARSER_VERSION VERSION #endif +/** @brief Where the command line options are stored */ struct gengetopt_args_info { - const char *help_help; /* Print help and exit help description. */ - const char *version_help; /* Print version and exit help description. */ - int engine_flag; /* Run (JACK) engine (default=off). */ - const char *engine_help; /* Run (JACK) engine help description. */ - int engine_port_arg; /* Engine OSC port (default='16180'). */ - char * engine_port_orig; /* Engine OSC port original value given at command line. */ - const char *engine_port_help; /* Engine OSC port help description. */ - char * connect_arg; /* Connect to existing engine at OSC URI (default='osc.udp://localhost:16180'). */ - char * connect_orig; /* Connect to existing engine at OSC URI original value given at command line. */ - const char *connect_help; /* Connect to existing engine at OSC URI help description. */ - int gui_flag; /* Launch the GTK graphical interface (default=on). */ - const char *gui_help; /* Launch the GTK graphical interface help description. */ - int client_port_arg; /* Client OSC port. */ - char * client_port_orig; /* Client OSC port original value given at command line. */ - const char *client_port_help; /* Client OSC port help description. */ - char * load_arg; /* Load patch. */ - char * load_orig; /* Load patch original value given at command line. */ - const char *load_help; /* Load patch help description. */ - char * path_arg; /* Target path for loaded patch. */ - char * path_orig; /* Target path for loaded patch original value given at command line. */ - const char *path_help; /* Target path for loaded patch help description. */ - char * run_arg; /* Run script. */ - char * run_orig; /* Run script original value given at command line. */ - const char *run_help; /* Run script help description. */ - int parallelism_arg; /* Number of concurrent process threads (default='1'). */ - char * parallelism_orig; /* Number of concurrent process threads original value given at command line. */ - const char *parallelism_help; /* Number of concurrent process threads help description. */ + const char *help_help; /**< @brief Print help and exit help description. */ + const char *version_help; /**< @brief Print version and exit help description. */ + int engine_flag; /**< @brief Run (JACK) engine (default=off). */ + const char *engine_help; /**< @brief Run (JACK) engine help description. */ + int engine_port_arg; /**< @brief Engine OSC port (default='16180'). */ + char * engine_port_orig; /**< @brief Engine OSC port original value given at command line. */ + const char *engine_port_help; /**< @brief Engine OSC port help description. */ + char * connect_arg; /**< @brief Connect to existing engine at OSC URI (default='osc.udp://localhost:16180'). */ + char * connect_orig; /**< @brief Connect to existing engine at OSC URI original value given at command line. */ + const char *connect_help; /**< @brief Connect to existing engine at OSC URI help description. */ + int gui_flag; /**< @brief Launch the GTK graphical interface (default=off). */ + const char *gui_help; /**< @brief Launch the GTK graphical interface help description. */ + int client_port_arg; /**< @brief Client OSC port. */ + char * client_port_orig; /**< @brief Client OSC port original value given at command line. */ + const char *client_port_help; /**< @brief Client OSC port help description. */ + char * load_arg; /**< @brief Load patch. */ + char * load_orig; /**< @brief Load patch original value given at command line. */ + const char *load_help; /**< @brief Load patch help description. */ + char * path_arg; /**< @brief Target path for loaded patch. */ + char * path_orig; /**< @brief Target path for loaded patch original value given at command line. */ + const char *path_help; /**< @brief Target path for loaded patch help description. */ + char * run_arg; /**< @brief Run script. */ + char * run_orig; /**< @brief Run script original value given at command line. */ + const char *run_help; /**< @brief Run script help description. */ + int parallelism_arg; /**< @brief Number of concurrent process threads (default='1'). */ + char * parallelism_orig; /**< @brief Number of concurrent process threads original value given at command line. */ + const char *parallelism_help; /**< @brief Number of concurrent process threads help description. */ - int help_given ; /* Whether help was given. */ - int version_given ; /* Whether version was given. */ - int engine_given ; /* Whether engine was given. */ - int engine_port_given ; /* Whether engine-port was given. */ - int connect_given ; /* Whether connect was given. */ - int gui_given ; /* Whether gui was given. */ - int client_port_given ; /* Whether client-port was given. */ - int load_given ; /* Whether load was given. */ - int path_given ; /* Whether path was given. */ - int run_given ; /* Whether run was given. */ - int parallelism_given ; /* Whether parallelism was given. */ + int help_given ; /**< @brief Whether help was given. */ + int version_given ; /**< @brief Whether version was given. */ + int engine_given ; /**< @brief Whether engine was given. */ + int engine_port_given ; /**< @brief Whether engine-port was given. */ + int connect_given ; /**< @brief Whether connect was given. */ + int gui_given ; /**< @brief Whether gui was given. */ + int client_port_given ; /**< @brief Whether client-port was given. */ + int load_given ; /**< @brief Whether load was given. */ + int path_given ; /**< @brief Whether path was given. */ + int run_given ; /**< @brief Whether run was given. */ + int parallelism_given ; /**< @brief Whether parallelism was given. */ } ; +/** @brief The additional parameters to pass to parser functions */ +struct cmdline_parser_params +{ + int override; /**< @brief whether to override possibly already present options (default 0) */ + int initialize; /**< @brief whether to initialize the option structure gengetopt_args_info (default 0) */ + int check_required; /**< @brief whether to check that all required options were provided (default 0) */ + int check_ambiguity; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */ +} ; + +/** @brief the purpose string of the program */ extern const char *gengetopt_args_info_purpose; +/** @brief the usage string of the program */ extern const char *gengetopt_args_info_usage; +/** @brief all the lines making the help output */ extern const char *gengetopt_args_info_help[]; +/** + * The command line parser + * @param argc the number of command line options + * @param argv the command line options + * @param args_info the structure where option information will be stored + * @return 0 if everything went fine, NON 0 if an error took place + */ int cmdline_parser (int argc, char * const *argv, struct gengetopt_args_info *args_info); + +/** + * The command line parser (version with additional parameters - deprecated) + * @param argc the number of command line options + * @param argv the command line options + * @param args_info the structure where option information will be stored + * @param override whether to override possibly already present options + * @param initialize whether to initialize the option structure my_args_info + * @param check_required whether to check that all required options were provided + * @return 0 if everything went fine, NON 0 if an error took place + * @deprecated use cmdline_parser_ext() instead + */ int cmdline_parser2 (int argc, char * const *argv, struct gengetopt_args_info *args_info, int override, int initialize, int check_required); + +/** + * The command line parser (version with additional parameters) + * @param argc the number of command line options + * @param argv the command line options + * @param args_info the structure where option information will be stored + * @param params additional parameters for the parser + * @return 0 if everything went fine, NON 0 if an error took place + */ +int cmdline_parser_ext (int argc, char * const *argv, + struct gengetopt_args_info *args_info, + struct cmdline_parser_params *params); + +/** + * Save the contents of the option struct into a (text) file. + * This file can be read by the config file parser (if generated by gengetopt) + * @param filename the file where to save + * @param args_info the option struct to save + * @return 0 if everything went fine, NON 0 if an error took place + */ int cmdline_parser_file_save(const char *filename, struct gengetopt_args_info *args_info); +/** + * Print the help + */ void cmdline_parser_print_help(void); +/** + * Print the version + */ void cmdline_parser_print_version(void); +/** + * Allocates dynamically a cmdline_parser_params structure and initializes + * all its fields to 0 + * @return the initialized cmdline_parser_params structure + */ +struct cmdline_parser_params *cmdline_parser_params_init(); + +/** + * Initializes the passed gengetopt_args_info structure's fields + * (also set default values for options that have a default) + * @param args_info the structure to initialize + */ void cmdline_parser_init (struct gengetopt_args_info *args_info); +/** + * Deallocates the string fields of the gengetopt_args_info structure + * (but does not deallocate the structure itself) + * @param args_info the structure to deallocate + */ void cmdline_parser_free (struct gengetopt_args_info *args_info); +/** + * Checks that all the required options were specified + * @param args_info the structure to check + * @param prog_name the name of the program that will be used to print + * possible errors + * @return + */ int cmdline_parser_required (struct gengetopt_args_info *args_info, const char *prog_name); |