cmdline.h File Reference

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

#include <stdio.h>

Include dependency graph for cmdline.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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   "iLumiCalc.exe"
	the program name (used for printing errors)
#define	CMDLINE_PARSER_PACKAGE_NAME   "iLumiCalc.exe"
	the complete program name (used for help and version)
#define	CMDLINE_PARSER_VERSION   "00-00-00"
	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_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.22.4 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 cmdline.h.

Macro Definition Documentation

CMDLINE_PARSER_PACKAGE

#define CMDLINE_PARSER_PACKAGE   "iLumiCalc.exe"

the program name (used for printing errors)

Definition at line 28 of file cmdline.h.

CMDLINE_PARSER_PACKAGE_NAME

#define CMDLINE_PARSER_PACKAGE_NAME   "iLumiCalc.exe"

the complete program name (used for help and version)

Definition at line 33 of file cmdline.h.

CMDLINE_PARSER_VERSION

#define CMDLINE_PARSER_VERSION   "00-00-00"

the program version

Definition at line 38 of file cmdline.h.

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 659 of file cmdline.cxx.

{
  return cmdline_parser2 (argc, argv, args_info, 0, 1, 1);
}

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

Definition at line 681 of file cmdline.cxx.

{
  int result;
  struct cmdline_parser_params params;
  
  params.override = override;
  params.initialize = initialize;
  params.check_required = check_required;
  params.check_ambiguity = 0;
  params.print_errors = 1;
 
  result = cmdline_parser_internal (argc, argv, args_info, &params, 0);
 
  if (result == EXIT_FAILURE)
    {
      cmdline_parser_free (args_info);
      exit (EXIT_FAILURE);
    }
  
  return result;
}

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 418 of file cmdline.cxx.

{
  int i = 0;
 
  if (!outfile)
    {
      fprintf (stderr, "%s: cannot dump options to stream\n", CMDLINE_PARSER_PACKAGE);
      return EXIT_FAILURE;
    }
 
  if (args_info->help_given)
    write_into_file(outfile, "help", 0, 0 );
  if (args_info->version_given)
    write_into_file(outfile, "version", 0, 0 );
  write_multiple_into_file(outfile, args_info->runnumber_given, "runnumber", args_info->runnumber_orig, 0);
  write_multiple_into_file(outfile, args_info->lbstart_given, "lbstart", args_info->lbstart_orig, 0);
  write_multiple_into_file(outfile, args_info->lbend_given, "lbend", args_info->lbend_orig, 0);
  write_multiple_into_file(outfile, args_info->xml_given, "xml", args_info->xml_orig, 0);
  if (args_info->xml_blacklist_given)
    write_into_file(outfile, "xml_blacklist", args_info->xml_blacklist_orig, 0);
  write_multiple_into_file(outfile, args_info->tag_given, "tag", args_info->tag_orig, 0);
  write_multiple_into_file(outfile, args_info->root_given, "root", args_info->root_orig, 0);
  if (args_info->tree_given)
    write_into_file(outfile, "tree", args_info->tree_orig, 0);
  if (args_info->d3pd_dir_given)
    write_into_file(outfile, "d3pd_dir", args_info->d3pd_dir_orig, 0);
  if (args_info->lumitag_given)
    write_into_file(outfile, "lumitag", args_info->lumitag_orig, 0);
  if (args_info->online_given)
    write_into_file(outfile, "online", 0, 0 );
  if (args_info->lumichannel_given)
    write_into_file(outfile, "lumichannel", args_info->lumichannel_orig, 0);
  if (args_info->lumimethod_given)
    write_into_file(outfile, "lumimethod", args_info->lumimethod_orig, 0);
  write_multiple_into_file(outfile, args_info->trigger_given, "trigger", args_info->trigger_orig, 0);
  if (args_info->livetrigger_given)
    write_into_file(outfile, "livetrigger", args_info->livetrigger_orig, 0);
  if (args_info->lar_given)
    write_into_file(outfile, "lar", 0, 0 );
  if (args_info->lartag_given)
    write_into_file(outfile, "lartag", args_info->lartag_orig, 0);
  if (args_info->beamspot_given)
    write_into_file(outfile, "beamspot", 0, 0 );
  if (args_info->beamspottag_given)
    write_into_file(outfile, "beamspottag", args_info->beamspottag_orig, 0);
  if (args_info->scale_lumi_given)
    write_into_file(outfile, "scale_lumi", args_info->scale_lumi_orig, 0);
  if (args_info->xml_out_given)
    write_into_file(outfile, "xml_out", args_info->xml_out_orig, 0);
  if (args_info->xml_collisionlist_given)
    write_into_file(outfile, "xml_collisionlist", 0, 0 );
  if (args_info->plots_given)
    write_into_file(outfile, "plots", 0, 0 );
  if (args_info->verbose_given)
    write_into_file(outfile, "verbose", 0, 0 );
  if (args_info->quiet_given)
    write_into_file(outfile, "quiet", 0, 0 );
  
 
  i = EXIT_SUCCESS;
  return i;
}

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 665 of file cmdline.cxx.

{
  int result;
  result = cmdline_parser_internal (argc, argv, args_info, params, 0);
 
  if (result == EXIT_FAILURE)
    {
      cmdline_parser_free (args_info);
      exit (EXIT_FAILURE);
    }
  
  return result;
}

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 482 of file cmdline.cxx.

{
  FILE *outfile;
  int i = 0;
 
  outfile = fopen(filename, "w");
 
  if (!outfile)
    {
      fprintf (stderr, "%s: cannot open file for writing: %s\n", CMDLINE_PARSER_PACKAGE, filename);
      return EXIT_FAILURE;
    }
 
  i = cmdline_parser_dump(outfile, args_info);
  fclose (outfile);
 
  return i;
}

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 502 of file cmdline.cxx.

{
  cmdline_parser_release (args_info);
}

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 252 of file cmdline.cxx.

{
  clear_given (args_info);
  clear_args (args_info);
  init_args_info (args_info);
}

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 273 of file cmdline.cxx.

{
  struct cmdline_parser_params *params = 
    (struct cmdline_parser_params *)malloc(sizeof(struct cmdline_parser_params));
  cmdline_parser_params_init(params);  
  return params;
}

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 260 of file cmdline.cxx.

{
  if (params)
    { 
      params->override = 0;
      params->initialize = 1;
      params->check_required = 1;
      params->check_ambiguity = 0;
      params->print_errors = 1;
    }
}

cmdline_parser_print_help()

void cmdline_parser_print_help

(

void

)

Print the help.

Definition at line 243 of file cmdline.cxx.

{
  int i = 0;
  print_help_common();
  while (gengetopt_args_info_help[i])
    printf("%s\n", gengetopt_args_info_help[i++]);
}

cmdline_parser_print_version()

void cmdline_parser_print_version

(

void

)

Print the version.

Definition at line 220 of file cmdline.cxx.

{
  printf ("%s %s\n",
     (strlen(CMDLINE_PARSER_PACKAGE_NAME) ? CMDLINE_PARSER_PACKAGE_NAME : CMDLINE_PARSER_PACKAGE),
     CMDLINE_PARSER_VERSION);
}

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 704 of file cmdline.cxx.

{
  int result = EXIT_SUCCESS;
 
  if (cmdline_parser_required2(args_info, prog_name, 0) > 0)
    result = EXIT_FAILURE;
 
  if (result == EXIT_FAILURE)
    {
      cmdline_parser_free (args_info);
      exit (EXIT_FAILURE);
    }
  
  return result;
}

Variable Documentation

gengetopt_args_info_help

const char* gengetopt_args_info_help[]

extern

all the lines making the help output

Definition at line 33 of file cmdline.cxx.

                                         {
  "  -h, --help                  Print help and exit",
  "      --version               Print version and exit",
  "\nFlags to specify data sample:",
  "  -r, --runnumber=STRING      Run number, range, or comma separated list, e.g. \n                                177986-178109,179710",
  "      --lbstart=INT           LumiBlock number begin",
  "      --lbend=INT             LumiBlock number end",
  "  -x, --xml=STRING            Input XML file name",
  "      --xml_blacklist=STRING  Input XML file of blacklist",
  "  -T, --tag=STRING            Input TAG file name",
  "      --root=STRING           Input ROOT file name",
  "      --tree=STRING           Name of TTree in input ROOT file to which Lumi \n                                string is attached",
  "      --d3pd_dir=STRING       Name of TDirectory in input ROOT file where Lumi \n                                string is stored",
  "\nFlags to control luminosity calculation:",
  "      --lumitag=STRING        Offline luminosity database tag  \n                                (default=`OflLumi-8TeV-002')",
  "      --online                Use online luminosity estimates instead of \n                                offline database  (default=off)",
  "      --lumichannel=INT       Luminosity estimate method by value  \n                                (default=`0')",
  "      --lumimethod=STRING     Luminosity estimate method by string  \n                                (default=`ATLAS_PREFERRED')",
  "  -t, --trigger=STRING        Trigger chain name used for prescale calculation",
  "      --livetrigger=STRING    L1 Trigger used for livetime calculation  \n                                (default=`L1_EM30')",
  "      --lar                   Calculate LAr defect fraction  (default=off)",
  "      --lartag=STRING         LAr noise burst database tag  \n                                (default=`LARBadChannelsOflEventVeto-UPD4-01')",
  "      --beamspot              Require online beamspot valid in trigger \n                                livefraction  (default=off)",
  "      --beamspottag=STRING    Online beamspot database tag  \n                                (default=`IndetBeamposOnl-HLT-UPD1-001-00')",
  "      --scale_lumi=DOUBLE     Scale luminosity with a constant value  \n                                (default=`1.0')",
  "\nFlags to control output:",
  "      --xml_out=STRING        Output XML file name",
  "      --xml_collisionlist     Output XML file of lists of collision candidates  \n                                (default=off)",
  "      --plots                 Create some plots on demand  (default=off)",
  "  -V, --verbose               Verbose output level  (default=off)",
  "      --quiet                 Quiet output level  (default=off)",
    0
};

gengetopt_args_info_purpose

const char* gengetopt_args_info_purpose

extern

the purpose string of the program

Definition at line 27 of file cmdline.cxx.

gengetopt_args_info_usage

const char* gengetopt_args_info_usage

extern

the usage string of the program

Definition at line 29 of file cmdline.cxx.