NSCL DDAS  1.0
Support for XIA DDAS at the NSCL
 All Classes Namespaces Files Functions Variables Macros Pages
toxml.h
Go to the documentation of this file.
1 
8 #ifndef TOXML_H
9 #define TOXML_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 "ToXml"
25 #endif
26 
27 #ifndef CMDLINE_PARSER_PACKAGE_NAME
28 
29 #define CMDLINE_PARSER_PACKAGE_NAME "ToXml"
30 #endif
31 
32 #ifndef CMDLINE_PARSER_VERSION
33 
34 #define CMDLINE_PARSER_VERSION "1.0"
35 #endif
36 
37 enum enum_source { source__NULL = -1, source_arg_setfile = 0, source_arg_modules };
38 
41 {
42  const char *help_help;
43  const char *version_help;
44  enum enum_source source_arg;
45  char * source_orig;
46  const char *source_help;
47  char * crate_arg;
48  char * crate_orig;
49  const char *crate_help;
50  char * file_arg;
51  char * file_orig;
52  const char *file_help;
53  char ** msps_arg;
54  char ** msps_orig;
55  unsigned int msps_min;
56  unsigned int msps_max;
57  const char *msps_help;
59  unsigned int help_given ;
60  unsigned int version_given ;
61  unsigned int source_given ;
62  unsigned int crate_given ;
63  unsigned int file_given ;
64  unsigned int msps_given ;
66 } ;
67 
70 {
71  int override;
72  int initialize;
73  int check_required;
74  int check_ambiguity;
75  int print_errors;
76 } ;
77 
79 extern const char *gengetopt_args_info_purpose;
81 extern const char *gengetopt_args_info_usage;
83 extern const char *gengetopt_args_info_description;
85 extern const char *gengetopt_args_info_help[];
86 
94 int cmdline_parser (int argc, char **argv,
95  struct gengetopt_args_info *args_info);
96 
108 int cmdline_parser2 (int argc, char **argv,
109  struct gengetopt_args_info *args_info,
110  int override, int initialize, int check_required);
111 
120 int cmdline_parser_ext (int argc, char **argv,
121  struct gengetopt_args_info *args_info,
122  struct cmdline_parser_params *params);
123 
130 int cmdline_parser_dump(FILE *outfile,
131  struct gengetopt_args_info *args_info);
132 
140 int cmdline_parser_file_save(const char *filename,
141  struct gengetopt_args_info *args_info);
142 
146 void cmdline_parser_print_help(void);
151 
158 
165 
171 void cmdline_parser_init (struct gengetopt_args_info *args_info);
177 void cmdline_parser_free (struct gengetopt_args_info *args_info);
178 
186 int cmdline_parser_required (struct gengetopt_args_info *args_info,
187  const char *prog_name);
188 
189 extern const char *cmdline_parser_source_values[];
192 #ifdef __cplusplus
193 }
194 #endif /* __cplusplus */
195 #endif /* TOXML_H */
char * crate_arg
XML Crate file that describes where module data are written.
Definition: toxml.h:47
const char * crate_help
ID of crate - only use this if source=setfile help description.
Definition: tocrate.h:54
const char * gengetopt_args_info_help[]
all the lines making the help output
Definition: dumperargs.cpp:36
char * file_arg
Set file or XML crate file depending on source.
Definition: tocrate.h:47
const char * msps_help
Speed specification of a digitizer (slot:mhz) default is 250MHz help description. ...
Definition: tocrate.h:64
int initialize
whether to initialize the option structure gengetopt_args_info (default 1)
Definition: dumperargs.h:79
char * file_orig
Set file or XML crate file depending on source original value given at command line.
Definition: tocrate.h:48
unsigned int crate_given
Whether crate was given.
Definition: tocrate.h:71
Where the command line options are stored.
Definition: dumperargs.h:38
int cmdline_parser_dump(FILE *outfile, struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:229
void cmdline_parser_print_help(void)
Definition: dumperargs.cpp:146
unsigned int help_given
Whether help was given.
Definition: dumperargs.h:63
char * source_arg
URL of source, ring buffer or file.
Definition: dumperargs.h:42
const char * source_help
URL of source, ring buffer or file help description.
Definition: dumperargs.h:44
const char * gengetopt_args_info_purpose
the purpose string of the program
Definition: dumperargs.cpp:28
unsigned int msps_given
Whether msps was given.
Definition: tocrate.h:73
unsigned int source_given
Whether source was given.
Definition: dumperargs.h:65
char ** msps_orig
Speed specification of a digitizer (slot:mhz) default is 250MHz original value given at command line...
Definition: tocrate.h:61
int cmdline_parser(int argc, char **argv, struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:305
The additional parameters to pass to parser functions.
Definition: dumperargs.h:76
char * crate_orig
ID of crate - only use this if source=setfile original value given at command line.
Definition: tocrate.h:53
char * source_orig
URL of source, ring buffer or file original value given at command line.
Definition: dumperargs.h:43
void cmdline_parser_init(struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:155
const char * version_help
Print version and exit help description.
Definition: dumperargs.h:41
int cmdline_parser_required(struct gengetopt_args_info *args_info, const char *prog_name)
Definition: dumperargs.cpp:350
unsigned int file_given
Whether file was given.
Definition: tocrate.h:69
unsigned int msps_min
Speed specification of a digitizer (slot:mhz) default is 250MHz's minimum occurreces.
Definition: tocrate.h:62
int cmdline_parser2(int argc, char **argv, struct gengetopt_args_info *args_info, int override, int initialize, int check_required)
Definition: dumperargs.cpp:327
const char * file_help
Set file or XML crate file depending on source help description.
Definition: tocrate.h:49
const char * cmdline_parser_source_values[]
Possible values for source.
void cmdline_parser_print_version(void)
Definition: dumperargs.cpp:120
const char * gengetopt_args_info_usage
the usage string of the program
Definition: dumperargs.cpp:30
const char * gengetopt_args_info_description
the description string of the program
Definition: dumperargs.cpp:34
int cmdline_parser_file_save(const char *filename, struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:264
const char * help_help
Print help and exit help description.
Definition: dumperargs.h:40
void cmdline_parser_params_init(struct cmdline_parser_params *params)
Definition: dumperargs.cpp:163
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
struct cmdline_parser_params * cmdline_parser_params_create(void)
Definition: dumperargs.cpp:176
int check_required
whether to check that all required options were provided (default 1)
Definition: dumperargs.h:80
void cmdline_parser_free(struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:284
unsigned int msps_max
Speed specification of a digitizer (slot:mhz) default is 250MHz's maximum occurreces.
Definition: tocrate.h:63
char ** msps_arg
Speed specification of a digitizer (slot:mhz) default is 250MHz.
Definition: tocrate.h:60
int cmdline_parser_ext(int argc, char **argv, struct gengetopt_args_info *args_info, struct cmdline_parser_params *params)
Definition: dumperargs.cpp:311
unsigned int version_given
Whether version was given.
Definition: dumperargs.h:64