The header file for the command line option parser generated by GNU Gengetopt version 2.23 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...

Macros
#define	CMDLINE_PARSER_PACKAGE "equationofstate"
	the program name (used for printing errors)

#define	CMDLINE_PARSER_PACKAGE_NAME "equationofstate"
	the complete program name (used for help and version)

#define	CMDLINE_PARSER_VERSION ""
	the program version

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_params *	cmdline_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_description
	the description string of the program

const char *	gengetopt_args_info_help []
	all the lines making the help output

Detailed Description

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

DO NOT modify this file, since it can be overwritten

Author: GNU Gengetopt

Definition in file equationofstateCmd.hpp.

Macro Definition Documentation

◆ CMDLINE_PARSER_PACKAGE

#define CMDLINE_PARSER_PACKAGE "equationofstate"

the program name (used for printing errors)

Definition at line 24 of file equationofstateCmd.hpp.

◆ CMDLINE_PARSER_PACKAGE_NAME

#define CMDLINE_PARSER_PACKAGE_NAME "equationofstate"

the complete program name (used for help and version)

Definition at line 29 of file equationofstateCmd.hpp.

◆ CMDLINE_PARSER_VERSION

#define CMDLINE_PARSER_VERSION ""

the program version

Definition at line 34 of file equationofstateCmd.hpp.

Function Documentation

◆ cmdline_parser()

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

The command line parser.

Parameters

argc	the number of command line options
argv	the command line options
args_info	the structure where option information will be stored

Returns: 0 if everything went fine, NON 0 if an error took place

Definition at line 405 of file Dump2XYZCmd.cpp.

◆ 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

argc	the number of command line options
argv	the command line options
args_info	the structure where option information will be stored
override	whether to override possibly already present options
initialize	whether to initialize the option structure my_args_info
check_required	whether 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

Parameters

argc	the number of command line options
argv	the command line options
args_info	the structure where option information will be stored
override	whether to override possibly already present options
initialize	whether to initialize the option structure my_args_info
check_required	whether 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 421 of file Dump2XYZCmd.cpp.

◆ 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

outfile	the stream where to dump options
args_info	the option struct to dump

Returns: 0 if everything went fine, NON 0 if an error took place

Definition at line 301 of file Dump2XYZCmd.cpp.

◆ 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

argc	the number of command line options
argv	the command line options
args_info	the structure where option information will be stored
params	additional parameters for the parser

Returns: 0 if everything went fine, NON 0 if an error took place

Definition at line 411 of file Dump2XYZCmd.cpp.

◆ 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

filename	the file where to save
args_info	the option struct to save

Returns: 0 if everything went fine, NON 0 if an error took place

Definition at line 364 of file Dump2XYZCmd.cpp.

◆ 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_info the structure to deallocate

Definition at line 384 of file Dump2XYZCmd.cpp.

◆ 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_info the structure to initialize

Definition at line 215 of file Dump2XYZCmd.cpp.

◆ 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 239 of file Dump2XYZCmd.cpp.

◆ 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

params the structure to initialize

Definition at line 226 of file Dump2XYZCmd.cpp.

◆ cmdline_parser_print_help()

void cmdline_parser_print_help ( void )

Print the help.

Definition at line 206 of file Dump2XYZCmd.cpp.

◆ cmdline_parser_print_version()

void cmdline_parser_print_version ( void )

Print the version.

Definition at line 180 of file Dump2XYZCmd.cpp.

◆ 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_info	the structure to check
prog_name	the name of the program that will be used to print possible errors

Returns

Definition at line 438 of file Dump2XYZCmd.cpp.

Variable Documentation

◆ gengetopt_args_info_description

const char* gengetopt_args_info_description

extern

the description string of the program

Definition at line 33 of file Dump2XYZCmd.cpp.

◆ gengetopt_args_info_help

const char* gengetopt_args_info_help[]

extern

all the lines making the help output

Definition at line 35 of file Dump2XYZCmd.cpp.

◆ gengetopt_args_info_purpose

const char* gengetopt_args_info_purpose

extern

the purpose string of the program

Definition at line 27 of file Dump2XYZCmd.cpp.

◆ gengetopt_args_info_usage

const char* gengetopt_args_info_usage

extern

the usage string of the program

Definition at line 29 of file Dump2XYZCmd.cpp.

Classes

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ CMDLINE_PARSER_PACKAGE

◆ CMDLINE_PARSER_PACKAGE_NAME

◆ CMDLINE_PARSER_VERSION

Function Documentation

◆ cmdline_parser()

◆ cmdline_parser2()

◆ cmdline_parser_dump()

◆ cmdline_parser_ext()

◆ cmdline_parser_file_save()

◆ cmdline_parser_free()

◆ cmdline_parser_init()

◆ cmdline_parser_params_create()

◆ cmdline_parser_params_init()

◆ cmdline_parser_print_help()

◆ cmdline_parser_print_version()

◆ cmdline_parser_required()

Variable Documentation

◆ gengetopt_args_info_description

◆ gengetopt_args_info_help

◆ gengetopt_args_info_purpose

◆ gengetopt_args_info_usage