git.notmuchmail.org Git - notmuch/blob - command-line-arguments.h

   1 #ifndef NOTMUCH_OPTS_H
   2 #define NOTMUCH_OPTS_H
   3
   4 #include <stdbool.h>
   5
   6 #include "notmuch.h"
   7
   8 /*
   9  * Describe one of the possibilities for a keyword option
  10  * 'value' will be copied to the output variable
  11  */
  12
  13 typedef struct notmuch_keyword {
  14     const char *name;
  15     int value;
  16 } notmuch_keyword_t;
  17
  18 /* Describe one option. */
  19 typedef struct notmuch_opt_desc {
  20     /* One and only one of opt_* must be set. */
  21     const struct notmuch_opt_desc *opt_inherit;
  22     bool *opt_bool;
  23     int *opt_int;
  24     int *opt_keyword;
  25     int *opt_flags;
  26     const char **opt_string;
  27     const char **opt_position;
  28
  29     /* Must be set except for opt_inherit and opt_position. */
  30     const char *name;
  31
  32     /* Optional, if non-NULL, set to true if the option is present. */
  33     bool *present;
  34
  35     /* Optional, allow empty strings for opt_string. */
  36     bool allow_empty;
  37
  38     /* Must be set for opt_keyword and opt_flags. */
  39     const struct notmuch_keyword *keywords;
  40 } notmuch_opt_desc_t;
  41
  42
  43 /*
  44   This is the main entry point for command line argument parsing.
  45
  46   Parse command line arguments according to structure options,
  47   starting at position opt_index.
  48
  49   All output of parsed values is via pointers in options.
  50
  51   Parsing stops at -- (consumed) or at the (k+1)st argument
  52   not starting with -- (a "positional argument") if options contains
  53   k positional argument descriptors.
  54
  55   Returns the index of first non-parsed argument, or -1 in case of error.
  56
  57 */
  58 int
  59 parse_arguments (int argc, char **argv, const notmuch_opt_desc_t *options, int opt_index);
  60
  61 /*
  62  * If the argument parsing loop provided by parse_arguments is not
  63  * flexible enough, then the user might be interested in the following
  64  * routines, but note that the API to parse_option might have to
  65  * change. See command-line-arguments.c for descriptions of these
  66  * functions.
  67  */
  68
  69 int
  70 parse_option (int argc, char **argv, const notmuch_opt_desc_t* options, int opt_index);
  71
  72 bool
  73 parse_position_arg (const char *arg,
  74                     int position_arg_index,
  75                     const notmuch_opt_desc_t* options);
  76
  77
  78 #endif