-/* gimmick_ggo.h */
-
-/* File autogenerated by gengetopt version 2.20 */
+/** @file gimmick_ggo.h
+ * @brief The header file for the command line option parser
+ * generated by GNU Gengetopt version 2.22
+ * http://www.gnu.org/software/gengetopt.
+ * DO NOT modify this file, since it can be overwritten
+ * @author GNU Gengetopt by Lorenzo Bettini */
#ifndef GIMMICK_GGO_H
#define GIMMICK_GGO_H
#include "config.h"
#endif
+#include <stdio.h> /* for FILE */
+
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
#ifndef CMDLINE_PARSER_PACKAGE
+/** @brief the program name */
#define CMDLINE_PARSER_PACKAGE "gimmick"
#endif
#ifndef CMDLINE_PARSER_VERSION
+/** @brief the program version */
#define CMDLINE_PARSER_VERSION "0.1.0"
#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 print_flag; /* Prints the local database tree (default=off). */
- const char *print_help; /* Prints the local database tree help description. */
- char * file_arg; /* Adds the file to local database. */
- char * file_orig; /* Adds the file to local database original value given at command line. */
- const char *file_help; /* Adds the file to local database help description. */
- char * dir_arg; /* Adds the directory to local database. */
- char * dir_orig; /* Adds the directory to local database original value given at command line. */
- const char *dir_help; /* Adds the directory to local database help description. */
- int recurse_flag; /* Recurse into sub-directories (default=off). */
- const char *recurse_help; /* Recurse into sub-directories help description. */
- int verbose_arg; /* Verbosity level (default='1'). */
- char * verbose_orig; /* Verbosity level original value given at command line. */
- const char *verbose_help; /* Verbosity level help description. */
- int debug_arg; /* Debug messages level (default='0'). */
- char * debug_orig; /* Debug messages level original value given at command line. */
- const char *debug_help; /* Debug messages level 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 print_flag; /**< @brief Prints the local database tree (default=off). */
+ const char *print_help; /**< @brief Prints the local database tree help description. */
+ char * file_arg; /**< @brief Adds the file to local database. */
+ char * file_orig; /**< @brief Adds the file to local database original value given at command line. */
+ const char *file_help; /**< @brief Adds the file to local database help description. */
+ char * dir_arg; /**< @brief Adds the directory to local database. */
+ char * dir_orig; /**< @brief Adds the directory to local database original value given at command line. */
+ const char *dir_help; /**< @brief Adds the directory to local database help description. */
+ int recurse_flag; /**< @brief Recurse into sub-directories (default=off). */
+ const char *recurse_help; /**< @brief Recurse into sub-directories help description. */
+ int verbose_arg; /**< @brief Verbosity level (default='1'). */
+ char * verbose_orig; /**< @brief Verbosity level original value given at command line. */
+ const char *verbose_help; /**< @brief Verbosity level help description. */
+ int debug_arg; /**< @brief Debug messages level (default='0'). */
+ char * debug_orig; /**< @brief Debug messages level original value given at command line. */
+ const char *debug_help; /**< @brief Debug messages level help description. */
- int help_given ; /* Whether help was given. */
- int version_given ; /* Whether version was given. */
- int print_given ; /* Whether print was given. */
- int file_given ; /* Whether file was given. */
- int dir_given ; /* Whether dir was given. */
- int recurse_given ; /* Whether recurse was given. */
- int verbose_given ; /* Whether verbose was given. */
- int debug_given ; /* Whether debug was given. */
+ unsigned int help_given ; /**< @brief Whether help was given. */
+ unsigned int version_given ; /**< @brief Whether version was given. */
+ unsigned int print_given ; /**< @brief Whether print was given. */
+ unsigned int file_given ; /**< @brief Whether file was given. */
+ unsigned int dir_given ; /**< @brief Whether dir was given. */
+ unsigned int recurse_given ; /**< @brief Whether recurse was given. */
+ unsigned int verbose_given ; /**< @brief Whether verbose was given. */
+ unsigned int debug_given ; /**< @brief Whether debug was given. */
+ char **inputs ; /**< @brief unamed options (options without names) */
+ unsigned inputs_num ; /**< @brief unamed options number */
+} ;
+
+/** @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 1) */
+ int check_required; /**< @brief whether to check that all required options were provided (default 1) */
+ int check_ambiguity; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */
+ int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
} ;
+/** @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 an already open FILE stream.
+ * @param outfile the stream where to dump options
+ * @param args_info the option struct to dump
+ * @return 0 if everything went fine, NON 0 if an error took place
+ */
+int cmdline_parser_dump(FILE *outfile,
+ struct gengetopt_args_info *args_info);
+
+/**
+ * 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);
+/**
+ * Initializes all the fields a cmdline_parser_params structure
+ * to their default values
+ * @param params the structure to initialize
+ */
+void cmdline_parser_params_init(struct cmdline_parser_params *params);
+
+/**
+ * Allocates dynamically a cmdline_parser_params structure and initializes
+ * all its fields to their default values
+ * @return the created and initialized cmdline_parser_params structure
+ */
+struct cmdline_parser_params *cmdline_parser_params_create(void);
+
+/**
+ * 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);
+/**
+ * The config file parser (deprecated version)
+ * @param filename the name of the config file
+ * @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_config_file() instead
+ */
+int cmdline_parser_configfile (char * const filename,
+ struct gengetopt_args_info *args_info,
+ int override, int initialize, int check_required);
+
+/**
+ * The config file parser
+ * @param filename the name of the config file
+ * @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_config_file (char * const filename,
+ struct gengetopt_args_info *args_info,
+ struct cmdline_parser_params *params);
+
+/**
+ * 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);
git://git.creatis.insa-lyon.fr / creaImageIO.git / blobdiff