NASA Ocean Color

ocssw V2022

  
 #ifndef __ARGPAR_H__
 #define __ARGPAR_H__
  
 #ifdef __cplusplus
 extern "C" {
 #endif
  
 #include <limits.h>
 #include <math.h>
 #include <stdio.h>
  
 #ifndef ARGPAR_API_VERSION
  
 #define ARGPAR_API_VERSION 2001000
  
 #define ARGPAR_API_VERSION_STR "2.1.0"
 #endif
  
 #ifndef MAX_PARFILES
 #define MAX_PARFILES 64
 #endif
  
 #ifndef PARFILE_STR
 #define PARFILE_STR "parfile"
 #endif
  
 extern const char *argpar_program_name;
  
 extern FILE *argpar_ostream;
  
 typedef struct argpar_option {
     const char *name;
     int key;
     const char *arg;
     int flags;
     const char *doc;
     int group;
 } argpar_option;
  
 #define ARGPAR_CAST_ARGS 0x1
  
 #define ARGPAR_SKIP_PARFILES 0x2
  
 #define ARGPAR_NO_KEYARGS 0x4
  
 #define ARGPAR_NO_HELP 0x8
  
 #define ARGPAR_NO_EXIT 0x10
  
 #define ARGPAR_ACCEPT_ANY 0x20
  
 #define ARGPAR_STORE_PARAMS 0x40
  
 #define OPTION_ARG_OPTIONAL 0x1
  
 #define OPTION_HIDDEN 0x2
  
 #define OPTION_DOC 0x4
  
 #define OPTION_DBL 0x10
  
 #define OPTION_INT 0x20
  
 #define OPTION_PARENT 0x40
  
 #define OPTION_CHILD 0x80
  
 #define OPTION_DOC_NO_BREAK 0x100
  
 #define OPTION_ALIAS 0x200
  
 #define OPTION_ENUM (OPTION_DOC | 0x400)
  
 #define OPTION_ATTR (OPTION_DOC | OPTION_HIDDEN | 0x800)
  
 typedef struct argpar_state {
     struct argpar *argpar;
  
     unsigned argc;
     char **argv;
  
     unsigned next;
  
     unsigned int flags;
  
     unsigned arg_num;
  
     unsigned quoted;
  
     void *input;
  
     void **child_inputs;
  
     void *hook;
  
     const char *parfile;
  
     char *name;
  
     const char *arg_name;
  
     const char *arg_alias;
  
     const char *arg_value;
  
     long argv_as_int;
     int argv_as_int_err;
  
     double argv_as_dbl;
     int argv_as_dbl_err;
 } argpar_state;
  
 extern const char *argpar_program_version;
  
 extern void (*argpar_program_version_hook) (FILE *stream, argpar_state *state);
  
 #define ARGPAR_KEY_ARG      0
  
 #define ARGPAR_KEY_ARGS     -8
  
 #define ARGPAR_KEY_END -1
  
 #define ARGPAR_KEY_INIT -3
  
 #define ARGPAR_KEY_FINI -4
  
 #define ARGPAR_KEY_SUCCESS -5
  
 #define ARGPAR_KEY_ERROR -6
  
 #define ARGPAR_KEY_NO_ARGS -7
  
 #define ARGPAR_KEY_UNKNOWN -8
  
 #define ARGPAR_KEY_HELP_ARGS_DOC -1
  
 #define ARGPAR_KEY_HELP_PRE_DOC -2
  
 #define ARGPAR_KEY_HELP_POST_DOC -3
  
 #define ARGPAR_KEY_HELP_HEADER -4
  
 #define ARGPAR_KEY_HELP_OPTION_DOC -5
  
 #define ARGPAR_KEY_HELP_EXTRA -7 /* After all other documentation; text is NULL for this key. */
  
 #define ARGPAR_ERR_ABORT -1
  
 #define ARGPAR_ERR_USAGE -2
  
 #define ARGPAR_ERR_UNKNOWN -5
  
 #define ARGPAR_ERR_PARFILE -3
  
 #define ARGPAR_LIMIT_REACHED -4
  
 typedef int (*argpar_parser)(int key, char *argv, argpar_state *state);
  
 typedef char *(*help_filter)(int key, const char *text, void *input);
  
 typedef struct argpar_child {
     struct argpar *argpar;
  
     unsigned flags;
  
     const char *header;
  
     int group;
 } argpar_child;
  
 typedef struct argpar {
     const argpar_option *options;
     argpar_parser parser;
     const char *args_doc;
     const char *doc;
     const argpar_child *children;
     help_filter help_filter;
     unsigned parfile_buffer_count;
     char **parfile_buffer;
 } argpar;
  
 int argpar_clean(argpar *p);
  
 int argpar_parse_file(argpar *p, const char *path, unsigned flags, void *input);
  
 int argpar_parse_args(argpar *p, unsigned argc, char *argv[], unsigned flags, unsigned *end_index, void *input);
  
 int argpar_usage(argpar_state *state);
  
 int argpar_usage_default(argpar *argpar);
  
 int argpar_help(argpar *argpar, FILE *stream, unsigned flags, char *name);
  
 int argpar_usage_json(argpar_state *state);
  
 int argpar_usage_default_json(argpar *argpar);
  
 int argpar_help_json(argpar *argpar, FILE *stream, unsigned flags, char *name);
  
 const char *argpar_version();
  
 char **argpar_split_str(char *str, const char *delim);
  
 char **argpar_split_trim(char *str, const char *delim);
  
 #ifndef NULL_INT
 #define NULL_INT INT_MIN
 #endif
  
 #ifndef EMPTY_INT
 #define EMPTY_INT INT_MAX
 #endif
  
 int *argpar_split_int(char *str, const char *delim);
  
 double *argpar_split_dbl(char *str, const char *delim);
  
 #ifdef __cplusplus
 }
 #endif
  
 #endif // __ARGPAR_H__

argpar_split_int

int * argpar_split_int(char *str, const char *delim)

Splits a string on a delimiter, returning a NULL_INT-terminated list of ints.

Definition: argpar.c:792

argpar

Master structure containing options, document strings, child parsers, and text filters....

Definition: argpar.h:391

argpar_state::argv_as_dbl

double argv_as_dbl

value part of key=value pair, parsed as a double, if OPTION_DBL was used.

Definition: argpar.h:244

argpar_parser

int(* argpar_parser)(int key, char *argv, argpar_state *state)

Pointer to a callback function to call for each argument and option parsed.

Definition: argpar.h:353

argpar_clean

int argpar_clean(argpar *p)

Free any space consumed by argpar for parfiles.

Definition: argpar.c:656

argpar_usage

int argpar_usage(argpar_state *state)

Print usage summary, called within a argpar_parser.

Definition: argpar-help.c:506

argpar::options

const argpar_option * options

Array of option structures, terminated by an empty entry (IE: {0}).

Definition: argpar.h:393

argpar::parfile_buffer_count

unsigned parfile_buffer_count

Used internally to store the number of parfiles parsed. Initialize to zero.

Definition: argpar.h:410

argpar_program_version

const char * argpar_program_version

Used as the program version string. If set, a version=1 option is automatically added....

Definition: leveltwo2csv-main.c:98

mapgen.key

key

Definition: mapgen.py:231

argpar_usage_default_json

int argpar_usage_default_json(argpar *argpar)

Print the default usage summary with all available sections, in a format more suitable for automated ...

Definition: argpar-json.c:417

argpar_state::flags

unsigned int flags

Flags passed to parser functions to modify the behavior.

Definition: argpar.h:202

argpar_state::next

unsigned next

The index in ARGV of the next arg that to be parsed. May be modified.

Definition: argpar.h:199

argpar_usage_json

int argpar_usage_json(argpar_state *state)

Print usage summary, called within a argpar_parser, in a format more suitable for automated parsing.

Definition: argpar-json.c:414

MDN.setup.name

name

Definition: setup.py:14

argpar_state::argv_as_int_err

int argv_as_int_err

Error state of integer casting, if OPTION_INT was used; 1 otherwise.

Definition: argpar.h:241

argpar::parser

argpar_parser parser

Parser function handed all options and arguments, as well as various ARGPAR_KEY_ keys for events such...

Definition: argpar.h:396

argpar_child::group

int group

The group after which to print the child's arguments.

Definition: argpar.h:383

argpar_child::flags

unsigned flags

This should probably be the flags passed to the parser and help functions, but is currently unused....

Definition: argpar.h:376

argpar_state::name

char * name

The name used when printing messages. This is initialized to ARGV[0], or PROGRAM_INVOCATION_NAME if t...

Definition: argpar.h:226

argpar_state::argv

char ** argv

Pointer to arguments passed to argpar_parse_args.

Definition: argpar.h:196

argpar_option::doc

const char * doc

A (generally short) description of an option. In case of a documentation option, this may be as lengt...

Definition: argpar.h:103

argpar_state::arg_value

const char * arg_value

value part of key=value pair.

Definition: argpar.h:236

argpar::args_doc

const char * args_doc

A string defining the desired arguments to the program, printed as part of the usage documentation.

Definition: argpar.h:399

argpar_child

Child parser for nesting argpars.

Definition: argpar.h:370

argpar_split_str

char ** argpar_split_str(char *str, const char *delim)

Splits a string on a delimiter, returning a NULL-terminated list of strings.

Definition: argpar.c:751

input

instr * input

Definition: main_l2binmatch.cpp:27

argpar_program_name

const char * argpar_program_name

Used as a default for the program's invocation name if one is not found.

Definition: leveltwo2csv-main.c:97

MDN.parameters.int

int

Definition: parameters.py:18

state

int state(double tjdTDB, JPLIntUtilType *util, double posvel[13][6], double *pnut)

argpar_usage_default

int argpar_usage_default(argpar *argpar)

Print the default usage summary with all available sections.

Definition: argpar-help.c:509

argpar_parse_file

int argpar_parse_file(argpar *p, const char *path, unsigned flags, void *input)

Parse a key=value store file.

Definition: argpar.c:737

argpar_option::flags

int flags

Modify the behavior of the argument by OR'ing one or more OPTION_ macros.

Definition: argpar.h:100

color_dtdb.path

string path

Definition: color_dtdb.py:221

oci_hdr_strip.argc

argc

Definition: oci_hdr_strip.py:7

argpar_state::argv_as_int

long argv_as_int

value part of key=value pair, parsed as a long, if OPTION_INT was used.

Definition: argpar.h:239

argpar_state::child_inputs

void ** child_inputs

Values to pass to child parsers, same length as the number of child parsers for the current parser.

Definition: argpar.h:215

argpar_parse_args

int argpar_parse_args(argpar *p, unsigned argc, char *argv[], unsigned flags, unsigned *end_index, void *input)

Parse an array of key=value pairs and/or key arguments.

Definition: argpar.c:686

argpar_state::input

void * input

Arbitrary pointer given by the user, generally to store parsed arguments.

Definition: argpar.h:211

argpar_child::header

const char * header

If non-NULL, don't merge this child's options with the the parent's. If header length is non-zero,...

Definition: argpar.h:380

argpar_state::argc

unsigned argc

Total number of arguments being parsed by a call of argpar_parse_args.

Definition: argpar.h:194

argpar_split_dbl

double * argpar_split_dbl(char *str, const char *delim)

Splits a string on a delimiter, returning a NAN-terminated list of doubles.

Definition: argpar.c:816

argpar_help

int argpar_help(argpar *argpar, FILE *stream, unsigned flags, char *name)

Print the default usage summary with all available sections.

Definition: argpar-help.c:512

argpar_state::arg_alias

const char * arg_alias

key part of key=value pair.

Definition: argpar.h:233

argpar_state::hook

void * hook

For the parser's use. Initialized to NULL.

Definition: argpar.h:218

argpar_version

const char * argpar_version()

Returns the source code version and the implemented API version.

Definition: argpar.c:747

flags

Definition: DDAlgorithm.h:22

argpar_state::arg_num

unsigned arg_num

The number of key arguments processed so far.

Definition: argpar.h:205

argpar_state

State variable to be filled before each call to the parser callback.

Definition: argpar.h:189

argpar_help_json

int argpar_help_json(argpar *argpar, FILE *stream, unsigned flags, char *name)

Print the default usage summary with all available sections, in a format more suitable for automated ...

Definition: argpar-json.c:420

argpar::children

const argpar_child * children

Array of argpar_child structures containing parsers to nest within this one. All options and argument...

Definition: argpar.h:406

argpar_split_trim

char ** argpar_split_trim(char *str, const char *delim)

Splits a string on a delimiter, returning a NULL-terminated list of strings, trimming left and right ...

Definition: argpar.c:776

argpar_state::quoted

unsigned quoted

The index of the first argument after –, if found.

Definition: argpar.h:208

argpar_option::name

const char * name

The key to search for.

Definition: argpar.h:89

argpar_state::parfile

const char * parfile

The name of the parfile being parsed, or NULL if the argument comes from the command line.

Definition: argpar.h:222

argpar_state::argv_as_dbl_err

int argv_as_dbl_err

Error state of double casting, if OPTION_DBL was used; 1 otherwise.

Definition: argpar.h:246

argpar_child::argpar

struct argpar * argpar

Underlying argpar struct.

Definition: argpar.h:372

argpar::doc

const char * doc

A string printed before and/or after the options. To display text after options, use a vertical-tab (...

Definition: argpar.h:402

argpar::help_filter

help_filter help_filter

A function passed all documentation to print.

Definition: argpar.h:408

argpar_program_version_hook

void(* argpar_program_version_hook)(FILE *stream, argpar_state *state)

Called to print the version string. If set, a version=1 option is automatically added.

Definition: argpar.c:27

str

Definition: aerosol.c:136

argpar_option::arg

const char * arg

What to display as the right side of the argument in the usage statement.

Definition: argpar.h:98

argpar_option

Stores the configuration for a par argument.

Definition: argpar.h:87

float p[MODELMAX]

Definition: atrem_corl1.h:131

argpar_state::argpar

struct argpar * argpar

Pointer to the parent argpar object.

Definition: argpar.h:191

argpar_ostream

FILE * argpar_ostream

Used as the stream for printing help and usage messages. Defaults to STDERR.

Definition: argpar.c:24

argpar_option::key

int key

The value to pass to the parser callback. Must be a positive and non-zero.

Definition: argpar.h:91

argpar_state::arg_name

const char * arg_name

key part of key=value pair. When an alias is used, this is the name of the actual option,...

Definition: argpar.h:230

argpar_option::group

int group

The group associated with this option. If 0 and a documentation option, it is auto-incremented.

Definition: argpar.h:111

argpar::parfile_buffer

char ** parfile_buffer

Used internally to store the parfiles. Initialize to NULL.

Definition: argpar.h:412