audio-tool/cmdline.h

/** @file cmdline.h
 *  @brief The header file for the command line option parser
 *  generated by GNU Gengetopt version 2.22.6
 *  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

/* If we use autoconf.  */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <stdio.h> /* for FILE */

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#ifndef CMDLINE_PARSER_PACKAGE
/** @brief the program name (used for printing errors) */
#define CMDLINE_PARSER_PACKAGE "audio-tool"
#endif

#ifndef CMDLINE_PARSER_PACKAGE_NAME
/** @brief the complete program name (used for help and version) */
#define CMDLINE_PARSER_PACKAGE_NAME "audio-tool"
#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; /**< @brief Print help and exit help description.  */
  const char *version_help; /**< @brief Print version and exit help description.  */
  int card_arg;	/**< @brief audio card number (default='0').  */
  char * card_orig;	/**< @brief audio card number original value given at command line.  */
  const char *card_help; /**< @brief audio card number help description.  */
  int device_arg;	/**< @brief audio port (default='0').  */
  char * device_orig;	/**< @brief audio port original value given at command line.  */
  const char *device_help; /**< @brief audio port help description.  */
  int periods_arg;	/**< @brief frames per period (default='1032').  */
  char * periods_orig;	/**< @brief frames per period original value given at command line.  */
  const char *periods_help; /**< @brief frames per period help description.  */
  int num_periods_arg;	/**< @brief number of periods per buffer (default='4').  */
  char * num_periods_orig;	/**< @brief number of periods per buffer original value given at command line.  */
  const char *num_periods_help; /**< @brief number of periods per buffer help description.  */
  int time_arg;	/**< @brief maximum duration of command (default='0').  */
  char * time_orig;	/**< @brief maximum duration of command original value given at command line.  */
  const char *time_help; /**< @brief maximum duration of command help description.  */
  int channels_arg;	/**< @brief number of channels (default='2').  */
  char * channels_orig;	/**< @brief number of channels original value given at command line.  */
  const char *channels_help; /**< @brief number of channels help description.  */
  int channel_mask_arg;	/**< @brief Bit mask with enabled channels (default='0xFFFFFFFF').  */
  char * channel_mask_orig;	/**< @brief Bit mask with enabled channels original value given at command line.  */
  const char *channel_mask_help; /**< @brief Bit mask with enabled channels help description.  */
  int bits_arg;	/**< @brief Number of bits in output format (signed) (default='16').  */
  char * bits_orig;	/**< @brief Number of bits in output format (signed) original value given at command line.  */
  const char *bits_help; /**< @brief Number of bits in output format (signed) help description.  */
  int rate_arg;	/**< @brief Sample rate (default='48000').  */
  char * rate_orig;	/**< @brief Sample rate original value given at command line.  */
  const char *rate_help; /**< @brief Sample rate help description.  */
  
  unsigned int help_given ;	/**< @brief Whether help was given.  */
  unsigned int version_given ;	/**< @brief Whether version was given.  */
  unsigned int card_given ;	/**< @brief Whether card was given.  */
  unsigned int device_given ;	/**< @brief Whether device was given.  */
  unsigned int periods_given ;	/**< @brief Whether periods was given.  */
  unsigned int num_periods_given ;	/**< @brief Whether num-periods was given.  */
  unsigned int time_given ;	/**< @brief Whether time was given.  */
  unsigned int channels_given ;	/**< @brief Whether channels was given.  */
  unsigned int channel_mask_given ;	/**< @brief Whether channel-mask was given.  */
  unsigned int bits_given ;	/**< @brief Whether bits was given.  */
  unsigned int rate_given ;	/**< @brief Whether rate 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 the description string of the program */
extern const char *gengetopt_args_info_description;
/** @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 **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 **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 **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);

/**
 * 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);


#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* CMDLINE_H */