herwig
is hosted by
Hepforge
,
IPPP Durham
Herwig
7.3.0
src
herwigopts.h
Go to the documentation of this file.
1
8
#ifndef HERWIGOPTS_H
9
#define HERWIGOPTS_H
10
11
/* If we use autoconf. */
12
#ifdef HAVE_CONFIG_H
13
#include "config.h"
14
#endif
15
16
#include <stdio.h>
/* for FILE */
17
18
#ifdef __cplusplus
19
extern
"C"
{
20
#endif
/* __cplusplus */
21
22
#ifndef CMDLINE_PARSER_PACKAGE
24
#define CMDLINE_PARSER_PACKAGE PACKAGE
25
#endif
26
27
#ifndef CMDLINE_PARSER_PACKAGE_NAME
29
#ifdef PACKAGE_NAME
30
#define CMDLINE_PARSER_PACKAGE_NAME PACKAGE_NAME
31
#else
32
#define CMDLINE_PARSER_PACKAGE_NAME PACKAGE
33
#endif
34
#endif
35
36
#ifndef CMDLINE_PARSER_VERSION
38
#define CMDLINE_PARSER_VERSION VERSION
39
#endif
40
42
struct
gengetopt_args_info
43
{
44
const
char
*
help_help
;
45
const
char
*
full_help_help
;
46
const
char
*
version_help
;
47
long
numevents_arg
;
48
char
*
numevents_orig
;
49
const
char
*
numevents_help
;
50
int
seed_arg
;
51
char
*
seed_orig
;
52
const
char
*
seed_help
;
53
char
*
tag_arg
;
54
char
*
tag_orig
;
55
const
char
*
tag_help
;
56
int
debug_arg
;
57
char
*
debug_orig
;
58
const
char
*
debug_help
;
59
int
debug_fpe_flag
;
60
const
char
*
debug_fpe_help
;
61
int
quiet_flag
;
62
const
char
*
quiet_help
;
63
int
jobs_arg
;
64
char
*
jobs_orig
;
65
const
char
*
jobs_help
;
66
char
*
setupfile_arg
;
67
char
*
setupfile_orig
;
68
const
char
*
setupfile_help
;
69
char
*
cachedir_arg
;
70
char
*
cachedir_orig
;
71
const
char
*
cachedir_help
;
72
long
jobsize_arg
;
73
char
*
jobsize_orig
;
74
const
char
*
jobsize_help
;
75
long
maxjobs_arg
;
76
char
*
maxjobs_orig
;
77
const
char
*
maxjobs_help
;
78
char
*
jobid_arg
;
79
char
*
jobid_orig
;
80
const
char
*
jobid_help
;
81
char
**
append_read_arg
;
82
char
**
append_read_orig
;
83
unsigned
int
append_read_min
;
84
unsigned
int
append_read_max
;
85
const
char
*
append_read_help
;
86
char
**
prepend_read_arg
;
87
char
**
prepend_read_orig
;
88
unsigned
int
prepend_read_min
;
89
unsigned
int
prepend_read_max
;
90
const
char
*
prepend_read_help
;
91
char
**
append_arg
;
92
char
**
append_orig
;
93
unsigned
int
append_min
;
94
unsigned
int
append_max
;
95
const
char
*
append_help
;
96
char
**
prepend_arg
;
97
char
**
prepend_orig
;
98
unsigned
int
prepend_min
;
99
unsigned
int
prepend_max
;
100
const
char
*
prepend_help
;
101
char
*
repo_arg
;
102
char
*
repo_orig
;
103
const
char
*
repo_help
;
104
int
noexitonerror_flag
;
105
const
char
*
noexitonerror_help
;
106
int
resume_flag
;
107
const
char
*
resume_help
;
109
unsigned
int
help_given
;
110
unsigned
int
full_help_given
;
111
unsigned
int
version_given
;
112
unsigned
int
numevents_given
;
113
unsigned
int
seed_given
;
114
unsigned
int
tag_given
;
115
unsigned
int
debug_given
;
116
unsigned
int
debug_fpe_given
;
117
unsigned
int
quiet_given
;
118
unsigned
int
jobs_given
;
119
unsigned
int
setupfile_given
;
120
unsigned
int
cachedir_given
;
121
unsigned
int
jobsize_given
;
122
unsigned
int
maxjobs_given
;
123
unsigned
int
jobid_given
;
124
unsigned
int
append_read_given
;
125
unsigned
int
prepend_read_given
;
126
unsigned
int
append_given
;
127
unsigned
int
prepend_given
;
128
unsigned
int
repo_given
;
129
unsigned
int
noexitonerror_given
;
130
unsigned
int
resume_given
;
132
char
**
inputs
;
133
unsigned
inputs_num
;
134
} ;
135
137
struct
cmdline_parser_params
138
{
139
int
override
;
140
int
initialize
;
141
int
check_required
;
142
int
check_ambiguity
;
143
int
print_errors
;
144
} ;
145
147
extern
const
char
*
gengetopt_args_info_purpose
;
149
extern
const
char
*
gengetopt_args_info_usage
;
151
extern
const
char
*
gengetopt_args_info_description
;
153
extern
const
char
*
gengetopt_args_info_help
[];
155
extern
const
char
*
gengetopt_args_info_full_help
[];
156
164
int
cmdline_parser
(
int
argc,
char
**argv,
165
struct
gengetopt_args_info
*args_info);
166
178
int
cmdline_parser2
(
int
argc,
char
**argv,
179
struct
gengetopt_args_info
*args_info,
180
int
override
,
int
initialize,
int
check_required);
181
190
int
cmdline_parser_ext
(
int
argc,
char
**argv,
191
struct
gengetopt_args_info
*args_info,
192
struct
cmdline_parser_params
*params);
193
200
int
cmdline_parser_dump
(FILE *outfile,
201
struct
gengetopt_args_info
*args_info);
202
210
int
cmdline_parser_file_save
(
const
char
*filename,
211
struct
gengetopt_args_info
*args_info);
212
216
void
cmdline_parser_print_help
(
void
);
220
void
cmdline_parser_print_full_help
(
void
);
224
void
cmdline_parser_print_version
(
void
);
225
231
void
cmdline_parser_params_init
(
struct
cmdline_parser_params
*params);
232
238
struct
cmdline_parser_params
*
cmdline_parser_params_create
(
void
);
239
245
void
cmdline_parser_init
(
struct
gengetopt_args_info
*args_info);
251
void
cmdline_parser_free
(
struct
gengetopt_args_info
*args_info);
252
260
int
cmdline_parser_required
(
struct
gengetopt_args_info
*args_info,
261
const
char
*prog_name);
262
263
264
#ifdef __cplusplus
265
}
266
#endif
/* __cplusplus */
267
#endif
/* HERWIGOPTS_H */
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.
cmdline_parser
int cmdline_parser(int argc, char **argv, struct gengetopt_args_info *args_info)
The command line parser.
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.
gengetopt_args_info_purpose
const char * gengetopt_args_info_purpose
the purpose string of the program
gengetopt_args_info_help
const char * gengetopt_args_info_help[]
all the lines making the help output
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)
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.
cmdline_parser_print_version
void cmdline_parser_print_version(void)
Print the version.
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 defau...
gengetopt_args_info_usage
const char * gengetopt_args_info_usage
the usage string of the program
gengetopt_args_info_full_help
const char * gengetopt_args_info_full_help[]
all the lines making the full help output (including hidden options)
cmdline_parser_print_full_help
void cmdline_parser_print_full_help(void)
Print the full help (including hidden options)
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)
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 th...
gengetopt_args_info_description
const char * gengetopt_args_info_description
the description string of the program
cmdline_parser_print_help
void cmdline_parser_print_help(void)
Print the help.
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 struc...
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.
cmdline_parser_params
The additional parameters to pass to parser functions.
Definition:
herwigopts.h:138
cmdline_parser_params::print_errors
int print_errors
whether getopt_long should print an error message for a bad option (default 1)
Definition:
herwigopts.h:143
cmdline_parser_params::check_required
int check_required
whether to check that all required options were provided (default 1)
Definition:
herwigopts.h:141
cmdline_parser_params::check_ambiguity
int check_ambiguity
whether to check for options already specified in the option structure gengetopt_args_info (default 0...
Definition:
herwigopts.h:142
cmdline_parser_params::initialize
int initialize
whether to initialize the option structure gengetopt_args_info (default 1)
Definition:
herwigopts.h:140
gengetopt_args_info
Where the command line options are stored.
Definition:
herwigopts.h:43
gengetopt_args_info::maxjobs_orig
char * maxjobs_orig
The maximum number of integration jobs to be created (build only).
Definition:
herwigopts.h:76
gengetopt_args_info::prepend_read_help
const char * prepend_read_help
Prepend a search path for the read command.
Definition:
herwigopts.h:90
gengetopt_args_info::setupfile_orig
char * setupfile_orig
An input file to modify run parameters.
Definition:
herwigopts.h:67
gengetopt_args_info::append_help
const char * append_help
Append a search path for dynamically loaded libraries.
Definition:
herwigopts.h:95
gengetopt_args_info::full_help_help
const char * full_help_help
Print help, including hidden options, and exit help description.
Definition:
herwigopts.h:45
gengetopt_args_info::append_orig
char ** append_orig
Append a search path for dynamically loaded libraries.
Definition:
herwigopts.h:92
gengetopt_args_info::debug_fpe_given
unsigned int debug_fpe_given
Whether debug-fpe was given.
Definition:
herwigopts.h:116
gengetopt_args_info::jobsize_orig
char * jobsize_orig
The number of subprocesses to integrate per job (build only).
Definition:
herwigopts.h:73
gengetopt_args_info::append_read_max
unsigned int append_read_max
Append a search path for the read command.
Definition:
herwigopts.h:84
gengetopt_args_info::jobsize_given
unsigned int jobsize_given
Whether jobsize was given.
Definition:
herwigopts.h:121
gengetopt_args_info::numevents_help
const char * numevents_help
Number of events to generate.
Definition:
herwigopts.h:49
gengetopt_args_info::maxjobs_given
unsigned int maxjobs_given
Whether maxjobs was given.
Definition:
herwigopts.h:122
gengetopt_args_info::cachedir_help
const char * cachedir_help
Matchbox cache directory.
Definition:
herwigopts.h:71
gengetopt_args_info::cachedir_arg
char * cachedir_arg
Matchbox cache directory.
Definition:
herwigopts.h:69
gengetopt_args_info::seed_orig
char * seed_orig
The random number generator seed.
Definition:
herwigopts.h:51
gengetopt_args_info::setupfile_given
unsigned int setupfile_given
Whether setupfile was given.
Definition:
herwigopts.h:119
gengetopt_args_info::append_read_given
unsigned int append_read_given
Whether append-read was given.
Definition:
herwigopts.h:124
gengetopt_args_info::jobsize_arg
long jobsize_arg
The number of subprocesses to integrate per job (build only).
Definition:
herwigopts.h:72
gengetopt_args_info::jobid_orig
char * jobid_orig
Integrate the given integration job.
Definition:
herwigopts.h:79
gengetopt_args_info::quiet_flag
int quiet_flag
Disable event counter.
Definition:
herwigopts.h:61
gengetopt_args_info::seed_help
const char * seed_help
The random number generator seed.
Definition:
herwigopts.h:52
gengetopt_args_info::tag_arg
char * tag_arg
A tag to append to the run name.
Definition:
herwigopts.h:53
gengetopt_args_info::inputs_num
unsigned inputs_num
unnamed options number
Definition:
herwigopts.h:133
gengetopt_args_info::noexitonerror_given
unsigned int noexitonerror_given
Whether noexitonerror was given.
Definition:
herwigopts.h:129
gengetopt_args_info::repo_orig
char * repo_orig
Repository file to use.
Definition:
herwigopts.h:102
gengetopt_args_info::debug_fpe_help
const char * debug_fpe_help
Enable floating point exceptions.
Definition:
herwigopts.h:60
gengetopt_args_info::append_read_orig
char ** append_read_orig
Append a search path for the read command.
Definition:
herwigopts.h:82
gengetopt_args_info::prepend_help
const char * prepend_help
Prepend a search path for dynamically loaded libraries.
Definition:
herwigopts.h:100
gengetopt_args_info::prepend_arg
char ** prepend_arg
Prepend a search path for dynamically loaded libraries.
Definition:
herwigopts.h:96
gengetopt_args_info::jobs_arg
int jobs_arg
Number of jobs to run in parallel.
Definition:
herwigopts.h:63
gengetopt_args_info::jobs_help
const char * jobs_help
Number of jobs to run in parallel.
Definition:
herwigopts.h:65
gengetopt_args_info::prepend_read_arg
char ** prepend_read_arg
Prepend a search path for the read command.
Definition:
herwigopts.h:86
gengetopt_args_info::seed_given
unsigned int seed_given
Whether seed was given.
Definition:
herwigopts.h:113
gengetopt_args_info::resume_given
unsigned int resume_given
Whether resume was given.
Definition:
herwigopts.h:130
gengetopt_args_info::noexitonerror_flag
int noexitonerror_flag
If set, ThePEG will not try to recover from failures, but will exit with a non-zero return code.
Definition:
herwigopts.h:104
gengetopt_args_info::seed_arg
int seed_arg
The random number generator seed.
Definition:
herwigopts.h:50
gengetopt_args_info::setupfile_arg
char * setupfile_arg
An input file to modify run parameters.
Definition:
herwigopts.h:66
gengetopt_args_info::append_arg
char ** append_arg
Append a search path for dynamically loaded libraries.
Definition:
herwigopts.h:91
gengetopt_args_info::append_max
unsigned int append_max
Append a search path for dynamically loaded libraries.
Definition:
herwigopts.h:94
gengetopt_args_info::cachedir_given
unsigned int cachedir_given
Whether cachedir was given.
Definition:
herwigopts.h:120
gengetopt_args_info::prepend_orig
char ** prepend_orig
Prepend a search path for dynamically loaded libraries.
Definition:
herwigopts.h:97
gengetopt_args_info::prepend_min
unsigned int prepend_min
Prepend a search path for dynamically loaded libraries.
Definition:
herwigopts.h:98
gengetopt_args_info::debug_help
const char * debug_help
Set the ThePEG debug level.
Definition:
herwigopts.h:58
gengetopt_args_info::prepend_given
unsigned int prepend_given
Whether prepend was given.
Definition:
herwigopts.h:127
gengetopt_args_info::resume_help
const char * resume_help
Try to resume execution from an earlier interrupted run.
Definition:
herwigopts.h:107
gengetopt_args_info::repo_given
unsigned int repo_given
Whether repo was given.
Definition:
herwigopts.h:128
gengetopt_args_info::setupfile_help
const char * setupfile_help
An input file to modify run parameters.
Definition:
herwigopts.h:68
gengetopt_args_info::numevents_given
unsigned int numevents_given
Whether numevents was given.
Definition:
herwigopts.h:112
gengetopt_args_info::full_help_given
unsigned int full_help_given
Whether full-help was given.
Definition:
herwigopts.h:110
gengetopt_args_info::prepend_read_orig
char ** prepend_read_orig
Prepend a search path for the read command.
Definition:
herwigopts.h:87
gengetopt_args_info::prepend_read_given
unsigned int prepend_read_given
Whether prepend-read was given.
Definition:
herwigopts.h:125
gengetopt_args_info::jobsize_help
const char * jobsize_help
The number of subprocesses to integrate per job (build only).
Definition:
herwigopts.h:74
gengetopt_args_info::debug_given
unsigned int debug_given
Whether debug was given.
Definition:
herwigopts.h:115
gengetopt_args_info::inputs
char ** inputs
unnamed options (options without names)
Definition:
herwigopts.h:132
gengetopt_args_info::append_min
unsigned int append_min
Append a search path for dynamically loaded libraries.
Definition:
herwigopts.h:93
gengetopt_args_info::jobid_arg
char * jobid_arg
Integrate the given integration job.
Definition:
herwigopts.h:78
gengetopt_args_info::jobs_given
unsigned int jobs_given
Whether jobs was given.
Definition:
herwigopts.h:118
gengetopt_args_info::append_read_min
unsigned int append_read_min
Append a search path for the read command.
Definition:
herwigopts.h:83
gengetopt_args_info::quiet_help
const char * quiet_help
Disable event counter.
Definition:
herwigopts.h:62
gengetopt_args_info::jobid_help
const char * jobid_help
Integrate the given integration job.
Definition:
herwigopts.h:80
gengetopt_args_info::repo_help
const char * repo_help
Repository file to use.
Definition:
herwigopts.h:103
gengetopt_args_info::prepend_max
unsigned int prepend_max
Prepend a search path for dynamically loaded libraries.
Definition:
herwigopts.h:99
gengetopt_args_info::maxjobs_help
const char * maxjobs_help
The maximum number of integration jobs to be created (build only).
Definition:
herwigopts.h:77
gengetopt_args_info::jobid_given
unsigned int jobid_given
Whether jobid was given.
Definition:
herwigopts.h:123
gengetopt_args_info::noexitonerror_help
const char * noexitonerror_help
If set, ThePEG will not try to recover from failures, but will exit with a non-zero return code.
Definition:
herwigopts.h:105
gengetopt_args_info::repo_arg
char * repo_arg
Repository file to use.
Definition:
herwigopts.h:101
gengetopt_args_info::tag_orig
char * tag_orig
A tag to append to the run name.
Definition:
herwigopts.h:54
gengetopt_args_info::help_given
unsigned int help_given
Whether help was given.
Definition:
herwigopts.h:109
gengetopt_args_info::numevents_arg
long numevents_arg
Number of events to generate.
Definition:
herwigopts.h:47
gengetopt_args_info::quiet_given
unsigned int quiet_given
Whether quiet was given.
Definition:
herwigopts.h:117
gengetopt_args_info::tag_given
unsigned int tag_given
Whether tag was given.
Definition:
herwigopts.h:114
gengetopt_args_info::maxjobs_arg
long maxjobs_arg
The maximum number of integration jobs to be created (build only).
Definition:
herwigopts.h:75
gengetopt_args_info::numevents_orig
char * numevents_orig
Number of events to generate.
Definition:
herwigopts.h:48
gengetopt_args_info::jobs_orig
char * jobs_orig
Number of jobs to run in parallel.
Definition:
herwigopts.h:64
gengetopt_args_info::debug_arg
int debug_arg
Set the ThePEG debug level.
Definition:
herwigopts.h:56
gengetopt_args_info::version_given
unsigned int version_given
Whether version was given.
Definition:
herwigopts.h:111
gengetopt_args_info::version_help
const char * version_help
Print version and exit help description.
Definition:
herwigopts.h:46
gengetopt_args_info::tag_help
const char * tag_help
A tag to append to the run name.
Definition:
herwigopts.h:55
gengetopt_args_info::prepend_read_min
unsigned int prepend_read_min
Prepend a search path for the read command.
Definition:
herwigopts.h:88
gengetopt_args_info::debug_orig
char * debug_orig
Set the ThePEG debug level.
Definition:
herwigopts.h:57
gengetopt_args_info::append_given
unsigned int append_given
Whether append was given.
Definition:
herwigopts.h:126
gengetopt_args_info::cachedir_orig
char * cachedir_orig
Matchbox cache directory.
Definition:
herwigopts.h:70
gengetopt_args_info::resume_flag
int resume_flag
Try to resume execution from an earlier interrupted run.
Definition:
herwigopts.h:106
gengetopt_args_info::prepend_read_max
unsigned int prepend_read_max
Prepend a search path for the read command.
Definition:
herwigopts.h:89
gengetopt_args_info::append_read_arg
char ** append_read_arg
Append a search path for the read command.
Definition:
herwigopts.h:81
gengetopt_args_info::append_read_help
const char * append_read_help
Append a search path for the read command.
Definition:
herwigopts.h:85
gengetopt_args_info::debug_fpe_flag
int debug_fpe_flag
Enable floating point exceptions.
Definition:
herwigopts.h:59
gengetopt_args_info::help_help
const char * help_help
Print help and exit help description.
Definition:
herwigopts.h:44
Generated on Thu Jun 20 2024 17:50:53 for Herwig by
1.9.6