NSCL DDAS  1.0
Support for XIA DDAS at the NSCL
 All Classes Namespaces Files Functions Variables Macros Pages
dumperargs.h
Go to the documentation of this file.
1 
8 #ifndef DUMPERARGS_H
9 #define DUMPERARGS_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
23 
24 #define CMDLINE_PARSER_PACKAGE "ddasdumper"
25 #endif
26 
27 #ifndef CMDLINE_PARSER_PACKAGE_NAME
28 
29 #define CMDLINE_PARSER_PACKAGE_NAME "ddasdumper"
30 #endif
31 
32 #ifndef CMDLINE_PARSER_VERSION
33 
34 #define CMDLINE_PARSER_VERSION "1.1"
35 #endif
36 
39 {
40  const char *help_help;
41  const char *version_help;
42  char * source_arg;
43  char * source_orig;
44  const char *source_help;
45  int skip_arg;
46  char * skip_orig;
47  const char *skip_help;
48  int count_arg;
49  char * count_orig;
50  const char *count_help;
51  char * sample_arg;
52  char * sample_orig;
53  const char *sample_help;
54  char * exclude_arg;
55  char * exclude_orig;
56  const char *exclude_help;
57  char * fileout_arg;
58  char * fileout_orig;
59  const char *fileout_help;
61  const char *legacy_mode_help;
63  unsigned int help_given ;
64  unsigned int version_given ;
65  unsigned int source_given ;
66  unsigned int skip_given ;
67  unsigned int count_given ;
68  unsigned int sample_given ;
69  unsigned int exclude_given ;
70  unsigned int fileout_given ;
71  unsigned int legacy_mode_given ;
73 } ;
74 
77 {
78  int override;
79  int initialize;
83 } ;
84 
86 extern const char *gengetopt_args_info_purpose;
88 extern const char *gengetopt_args_info_usage;
90 extern const char *gengetopt_args_info_description;
92 extern const char *gengetopt_args_info_help[];
93 
101 int cmdline_parser (int argc, char **argv,
102  struct gengetopt_args_info *args_info);
103 
115 int cmdline_parser2 (int argc, char **argv,
116  struct gengetopt_args_info *args_info,
117  int override, int initialize, int check_required);
118 
127 int cmdline_parser_ext (int argc, char **argv,
128  struct gengetopt_args_info *args_info,
129  struct cmdline_parser_params *params);
130 
137 int cmdline_parser_dump(FILE *outfile,
138  struct gengetopt_args_info *args_info);
139 
147 int cmdline_parser_file_save(const char *filename,
148  struct gengetopt_args_info *args_info);
149 
153 void cmdline_parser_print_help(void);
158 
165 
172 
178 void cmdline_parser_init (struct gengetopt_args_info *args_info);
184 void cmdline_parser_free (struct gengetopt_args_info *args_info);
185 
193 int cmdline_parser_required (struct gengetopt_args_info *args_info,
194  const char *prog_name);
195 
196 
197 #ifdef __cplusplus
198 }
199 #endif /* __cplusplus */
200 #endif /* DUMPERARGS_H */
const char * sample_help
List of item types to sample help description.
Definition: dumperargs.h:53
char * fileout_arg
Path of output file.
Definition: dumperargs.h:57
int initialize
whether to initialize the option structure gengetopt_args_info (default 1)
Definition: dumperargs.h:79
void cmdline_parser_init(struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:155
Where the command line options are stored.
Definition: dumperargs.h:38
int skip_arg
number of items to skip before dumping.
Definition: dumperargs.h:45
char * fileout_orig
Path of output file original value given at command line.
Definition: dumperargs.h:58
int cmdline_parser(int argc, char **argv, struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:305
char * count_orig
Number of items to dump before exiting original value given at command line.
Definition: dumperargs.h:49
unsigned int help_given
Whether help was given.
Definition: dumperargs.h:63
const char * count_help
Number of items to dump before exiting help description.
Definition: dumperargs.h:50
const char * exclude_help
List of item types to exclude from the dump help description.
Definition: dumperargs.h:56
char * source_arg
URL of source, ring buffer or file.
Definition: dumperargs.h:42
int cmdline_parser_dump(FILE *outfile, struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:229
const char * source_help
URL of source, ring buffer or file help description.
Definition: dumperargs.h:44
char * sample_orig
List of item types to sample original value given at command line.
Definition: dumperargs.h:52
unsigned int fileout_given
Whether fileout was given.
Definition: dumperargs.h:70
unsigned int source_given
Whether source was given.
Definition: dumperargs.h:65
int cmdline_parser_file_save(const char *filename, struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:264
const char * gengetopt_args_info_description
the description string of the program
Definition: dumperargs.cpp:34
int cmdline_parser_required(struct gengetopt_args_info *args_info, const char *prog_name)
Definition: dumperargs.cpp:350
The additional parameters to pass to parser functions.
Definition: dumperargs.h:76
int cmdline_parser_ext(int argc, char **argv, struct gengetopt_args_info *args_info, struct cmdline_parser_params *params)
Definition: dumperargs.cpp:311
char * source_orig
URL of source, ring buffer or file original value given at command line.
Definition: dumperargs.h:43
unsigned int sample_given
Whether sample was given.
Definition: dumperargs.h:68
const char * version_help
Print version and exit help description.
Definition: dumperargs.h:41
char * sample_arg
List of item types to sample.
Definition: dumperargs.h:51
void cmdline_parser_print_version(void)
Definition: dumperargs.cpp:120
unsigned int exclude_given
Whether exclude was given.
Definition: dumperargs.h:69
void cmdline_parser_free(struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:284
void cmdline_parser_print_help(void)
Definition: dumperargs.cpp:146
const char * help_help
Print help and exit help description.
Definition: dumperargs.h:40
const char * gengetopt_args_info_purpose
the purpose string of the program
Definition: dumperargs.cpp:28
int cmdline_parser2(int argc, char **argv, struct gengetopt_args_info *args_info, int override, int initialize, int check_required)
Definition: dumperargs.cpp:327
char * exclude_orig
List of item types to exclude from the dump original value given at command line. ...
Definition: dumperargs.h:55
const char * gengetopt_args_info_help[]
all the lines making the help output
Definition: dumperargs.cpp:36
unsigned int skip_given
Whether skip was given.
Definition: dumperargs.h:66
int print_errors
whether getopt_long should print an error message for a bad option (default 1)
Definition: dumperargs.h:82
int check_ambiguity
whether to check for options already specified in the option structure gengetopt_args_info (default 0...
Definition: dumperargs.h:81
int check_required
whether to check that all required options were provided (default 1)
Definition: dumperargs.h:80
unsigned int count_given
Whether count was given.
Definition: dumperargs.h:67
char * exclude_arg
List of item types to exclude from the dump.
Definition: dumperargs.h:54
int count_arg
Number of items to dump before exiting.
Definition: dumperargs.h:48
int legacy_mode_flag
Legacy data format enabled. This is not a default setting (default=off).
Definition: dumperargs.h:60
const char * legacy_mode_help
Legacy data format enabled. This is not a default setting help description.
Definition: dumperargs.h:61
const char * gengetopt_args_info_usage
the usage string of the program
Definition: dumperargs.cpp:30
void cmdline_parser_params_init(struct cmdline_parser_params *params)
Definition: dumperargs.cpp:163
unsigned int legacy_mode_given
Whether legacy-mode was given.
Definition: dumperargs.h:71
const char * skip_help
number of items to skip before dumping help description.
Definition: dumperargs.h:47
char * skip_orig
number of items to skip before dumping original value given at command line.
Definition: dumperargs.h:46
struct cmdline_parser_params * cmdline_parser_params_create(void)
Definition: dumperargs.cpp:176
const char * fileout_help
Path of output file help description.
Definition: dumperargs.h:59
unsigned int version_given
Whether version was given.
Definition: dumperargs.h:64