gsasl  1.10.0
About: GNU SASL is an implementation of the Simple Authentication and Security Layer (SASL). Development version.
  Fossies Dox: gsasl-1.10.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

gsasl_cmd.h File Reference

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. More...

#include <stdio.h>
Include dependency graph for gsasl_cmd.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

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...
 

Macros

#define CMDLINE_PARSER_PACKAGE   PACKAGE
 the program name (used for printing errors) More...
 
#define CMDLINE_PARSER_PACKAGE_NAME   PACKAGE
 the complete program name (used for help and version) More...
 
#define CMDLINE_PARSER_VERSION   VERSION
 the program version More...
 

Functions

int cmdline_parser (int argc, char **argv, struct gengetopt_args_info *args_info)
 
int cmdline_parser2 (int argc, char **argv, struct gengetopt_args_info *args_info, int override, int initialize, int check_required)
 
int cmdline_parser_ext (int argc, char **argv, struct gengetopt_args_info *args_info, struct cmdline_parser_params *params)
 
int cmdline_parser_dump (FILE *outfile, struct gengetopt_args_info *args_info)
 
int cmdline_parser_file_save (const char *filename, struct gengetopt_args_info *args_info)
 
void cmdline_parser_print_help (void)
 
void cmdline_parser_print_version (void)
 
void cmdline_parser_params_init (struct cmdline_parser_params *params)
 
struct cmdline_parser_paramscmdline_parser_params_create (void)
 
void cmdline_parser_init (struct gengetopt_args_info *args_info)
 
void cmdline_parser_free (struct gengetopt_args_info *args_info)
 
int cmdline_parser_required (struct gengetopt_args_info *args_info, const char *prog_name)
 

Variables

const char * gengetopt_args_info_purpose
 the purpose string of the program More...
 
const char * gengetopt_args_info_usage
 the usage string of the program More...
 
const char * gengetopt_args_info_description
 the description string of the program More...
 
const char * gengetopt_args_info_help []
 all the lines making the help output More...
 

Detailed Description

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

Definition in file gsasl_cmd.h.

Macro Definition Documentation

◆ CMDLINE_PARSER_PACKAGE

#define CMDLINE_PARSER_PACKAGE   PACKAGE

the program name (used for printing errors)

Definition at line 24 of file gsasl_cmd.h.

◆ CMDLINE_PARSER_PACKAGE_NAME

#define CMDLINE_PARSER_PACKAGE_NAME   PACKAGE

the complete program name (used for help and version)

Definition at line 32 of file gsasl_cmd.h.

◆ CMDLINE_PARSER_VERSION

#define CMDLINE_PARSER_VERSION   VERSION

the program version

Definition at line 38 of file gsasl_cmd.h.

Function Documentation

◆ cmdline_parser()

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

Definition at line 518 of file gsasl_cmd.c.

References args_info, and cmdline_parser2().

Referenced by main().

◆ cmdline_parser2()

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

Definition at line 540 of file gsasl_cmd.c.

References args_info, cmdline_parser_params::check_ambiguity, cmdline_parser_params::check_required, cmdline_parser_free(), cmdline_parser_internal(), EXIT_FAILURE, cmdline_parser_params::initialize, cmdline_parser_params::override, and cmdline_parser_params::print_errors.

Referenced by cmdline_parser().

◆ cmdline_parser_dump()

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

Definition at line 388 of file gsasl_cmd.c.

References gengetopt_args_info::anonymous_token_given, gengetopt_args_info::anonymous_token_orig, gengetopt_args_info::application_data_given, args_info, gengetopt_args_info::authentication_id_given, gengetopt_args_info::authentication_id_orig, gengetopt_args_info::authorization_id_given, gengetopt_args_info::authorization_id_orig, gengetopt_args_info::client_given, gengetopt_args_info::client_mechanisms_given, CMDLINE_PARSER_PACKAGE, gengetopt_args_info::connect_given, gengetopt_args_info::connect_orig, gengetopt_args_info::disable_cleartext_validate_given, gengetopt_args_info::enable_cram_md5_validate_given, EXIT_FAILURE, EXIT_SUCCESS, gengetopt_args_info::help_given, gengetopt_args_info::hostname_given, gengetopt_args_info::hostname_orig, gengetopt_args_info::imap_given, gengetopt_args_info::iteration_count_given, gengetopt_args_info::iteration_count_orig, gengetopt_args_info::mechanism_given, gengetopt_args_info::mechanism_orig, gengetopt_args_info::mkpasswd_given, gengetopt_args_info::no_cb_given, gengetopt_args_info::no_client_first_given, gengetopt_args_info::no_starttls_given, gengetopt_args_info::passcode_given, gengetopt_args_info::passcode_orig, gengetopt_args_info::password_given, gengetopt_args_info::password_orig, gengetopt_args_info::priority_given, gengetopt_args_info::priority_orig, gengetopt_args_info::quality_of_protection_given, gengetopt_args_info::quality_of_protection_orig, gengetopt_args_info::quiet_given, gengetopt_args_info::realm_given, gengetopt_args_info::realm_orig, gengetopt_args_info::salt_given, gengetopt_args_info::salt_orig, gengetopt_args_info::server_given, gengetopt_args_info::server_mechanisms_given, gengetopt_args_info::service_given, gengetopt_args_info::service_name_given, gengetopt_args_info::service_name_orig, gengetopt_args_info::service_orig, gengetopt_args_info::smtp_given, gengetopt_args_info::starttls_given, gengetopt_args_info::verbose_given, gengetopt_args_info::version_given, write_into_file(), gengetopt_args_info::x509_ca_file_given, gengetopt_args_info::x509_ca_file_orig, gengetopt_args_info::x509_cert_file_given, gengetopt_args_info::x509_cert_file_orig, gengetopt_args_info::x509_key_file_given, and gengetopt_args_info::x509_key_file_orig.

Referenced by cmdline_parser_file_save().

◆ cmdline_parser_ext()

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

Definition at line 524 of file gsasl_cmd.c.

References args_info, cmdline_parser_free(), cmdline_parser_internal(), and EXIT_FAILURE.

◆ cmdline_parser_file_save()

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

Definition at line 477 of file gsasl_cmd.c.

References args_info, cmdline_parser_dump(), CMDLINE_PARSER_PACKAGE, and EXIT_FAILURE.

◆ cmdline_parser_free()

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

Definition at line 497 of file gsasl_cmd.c.

References args_info, and cmdline_parser_release().

Referenced by cmdline_parser2(), cmdline_parser_ext(), and cmdline_parser_internal().

◆ cmdline_parser_init()

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

Definition at line 281 of file gsasl_cmd.c.

References args_info, clear_args(), clear_given(), init_args_info(), gengetopt_args_info::inputs, and gengetopt_args_info::inputs_num.

Referenced by cmdline_parser_internal().

◆ cmdline_parser_params_create()

struct cmdline_parser_params* cmdline_parser_params_create ( void  )

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

Definition at line 305 of file gsasl_cmd.c.

References cmdline_parser_params_init().

◆ cmdline_parser_params_init()

void cmdline_parser_params_init ( struct cmdline_parser_params params)

Initializes all the fields a cmdline_parser_params structure to their default values

Parameters
paramsthe structure to initialize

Definition at line 292 of file gsasl_cmd.c.

References cmdline_parser_params::check_ambiguity, cmdline_parser_params::check_required, cmdline_parser_params::initialize, cmdline_parser_params::override, and cmdline_parser_params::print_errors.

Referenced by cmdline_parser_params_create().

◆ cmdline_parser_print_help()

void cmdline_parser_print_help ( void  )

Print the help

Definition at line 272 of file gsasl_cmd.c.

References gengetopt_args_info_help, and print_help_common().

Referenced by main(), and usage().

◆ cmdline_parser_print_version()

void cmdline_parser_print_version ( void  )

◆ cmdline_parser_required()

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

Definition at line 563 of file gsasl_cmd.c.

References args_info, EXIT_SUCCESS, and FIX_UNUSED.

Variable Documentation

◆ gengetopt_args_info_description

const char* gengetopt_args_info_description
extern

the description string of the program

Definition at line 34 of file gsasl_cmd.c.

Referenced by print_help_common().

◆ gengetopt_args_info_help

const char* gengetopt_args_info_help[]
extern

all the lines making the help output

Definition at line 36 of file gsasl_cmd.c.

Referenced by cmdline_parser_print_help(), and init_args_info().

◆ gengetopt_args_info_purpose

const char* gengetopt_args_info_purpose
extern

the purpose string of the program

Definition at line 28 of file gsasl_cmd.c.

Referenced by print_help_common().

◆ gengetopt_args_info_usage

const char* gengetopt_args_info_usage
extern

the usage string of the program

Definition at line 30 of file gsasl_cmd.c.

Referenced by print_help_common().