DSF2FLAC
Classes | Functions | Variables
cmdline.h File Reference

The header file for the command line option parser generated by GNU Gengetopt version 2.22.5 http://www.gnu.org/software/gengetopt. More...

#include <stdio.h>

Classes

struct  gengetopt_args_info
 Where the command line options are stored. More...
struct  cmdline_parser_params
 The additional parameters to pass to parser functions. More...

Functions

int cmdline_parser (int argc, char **argv, struct gengetopt_args_info *args_info)
 The command line parser.
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 - deprecated)
int cmdline_parser_ext (int argc, char **argv, struct gengetopt_args_info *args_info, struct cmdline_parser_params *params)
 The command line parser (version with additional parameters)
int cmdline_parser_dump (FILE *outfile, struct gengetopt_args_info *args_info)
 Save the contents of the option struct into an already open FILE stream.
int cmdline_parser_file_save (const char *filename, struct gengetopt_args_info *args_info)
 Save the contents of the option struct into a (text) file.
void cmdline_parser_print_help (void)
 Print the help.
void cmdline_parser_print_version (void)
 Print the version.
void cmdline_parser_params_init (struct cmdline_parser_params *params)
 Initializes all the fields a cmdline_parser_params structure to their default values.
struct cmdline_parser_paramscmdline_parser_params_create (void)
 Allocates dynamically a cmdline_parser_params structure and initializes all its fields to their default values.
void cmdline_parser_init (struct gengetopt_args_info *args_info)
 Initializes the passed gengetopt_args_info structure's fields (also set default values for options that have a default)
void cmdline_parser_free (struct gengetopt_args_info *args_info)
 Deallocates the string fields of the gengetopt_args_info structure (but does not deallocate the structure itself)
int cmdline_parser_required (struct gengetopt_args_info *args_info, const char *prog_name)
 Checks that all the required options were specified.

Variables

const char * gengetopt_args_info_purpose
 the purpose string of the program
const char * gengetopt_args_info_usage
 the usage string of the program
const char * gengetopt_args_info_help []
 all the lines making the help output
const char * cmdline_parser_samplerate_values []
 Possible values for samplerate.
const char * cmdline_parser_bits_values []
 Possible values for bits.

Detailed Description

The header file for the command line option parser generated by GNU Gengetopt version 2.22.5 http://www.gnu.org/software/gengetopt.

DO NOT modify this file, since it can be overwritten

Author:
GNU Gengetopt by Lorenzo Bettini

Function Documentation

int cmdline_parser ( int  argc,
char **  argv,
struct gengetopt_args_info args_info 
)

The command line parser.

Parameters:
argcthe number of command line options
argvthe command line options
args_infothe structure where option information will be stored
Returns:
0 if everything went fine, NON 0 if an error took place
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 - deprecated)

Parameters:
argcthe number of command line options
argvthe command line options
args_infothe structure where option information will be stored
overridewhether to override possibly already present options
initializewhether to initialize the option structure my_args_info
check_requiredwhether to check that all required options were provided
Returns:
0 if everything went fine, NON 0 if an error took place
Deprecated:
use cmdline_parser_ext() instead
int cmdline_parser_dump ( FILE *  outfile,
struct gengetopt_args_info args_info 
)

Save the contents of the option struct into an already open FILE stream.

Parameters:
outfilethe stream where to dump options
args_infothe option struct to dump
Returns:
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 
)

The command line parser (version with additional parameters)

Parameters:
argcthe number of command line options
argvthe command line options
args_infothe structure where option information will be stored
paramsadditional parameters for the parser
Returns:
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 
)

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)

Parameters:
filenamethe file where to save
args_infothe option struct to save
Returns:
0 if everything went fine, NON 0 if an error took place
void cmdline_parser_free ( struct gengetopt_args_info args_info)

Deallocates the string fields of the gengetopt_args_info structure (but does not deallocate the structure itself)

Parameters:
args_infothe structure to deallocate
void cmdline_parser_init ( struct gengetopt_args_info args_info)

Initializes the passed gengetopt_args_info structure's fields (also set default values for options that have a default)

Parameters:
args_infothe structure to initialize

Allocates dynamically a cmdline_parser_params structure and initializes all its fields to their default values.

Returns:
the created and initialized cmdline_parser_params structure

Initializes all the fields a cmdline_parser_params structure to their default values.

Parameters:
paramsthe structure to initialize
void cmdline_parser_print_help ( void  )

Print the help.

Print the version.

int cmdline_parser_required ( struct gengetopt_args_info args_info,
const char *  prog_name 
)

Checks that all the required options were specified.

Parameters:
args_infothe structure to check
prog_namethe name of the program that will be used to print possible errors
Returns:

Variable Documentation

Possible values for bits.

Possible values for samplerate.

const char* gengetopt_args_info_help[]

all the lines making the help output

the purpose string of the program

the usage string of the program

 All Classes Files Functions Variables