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     /* Must be set for opt_keyword and opt_flags. */
  36     const struct notmuch_keyword *keywords;
  37 } notmuch_opt_desc_t;
  38
  39
  40 /*
  41   This is the main entry point for command line argument parsing.
  42
  43   Parse command line arguments according to structure options,
  44   starting at position opt_index.
  45
  46   All output of parsed values is via pointers in options.
  47
  48   Parsing stops at -- (consumed) or at the (k+1)st argument
  49   not starting with -- (a "positional argument") if options contains
  50   k positional argument descriptors.
  51
  52   Returns the index of first non-parsed argument, or -1 in case of error.
  53
  54 */
  55 int
  56 parse_arguments (int argc, char **argv, const notmuch_opt_desc_t *options, int opt_index);
  57
  58 /*
  59  * If the argument parsing loop provided by parse_arguments is not
  60  * flexible enough, then the user might be interested in the following
  61  * routines, but note that the API to parse_option might have to
  62  * change. See command-line-arguments.c for descriptions of these
  63  * functions.
  64  */
  65
  66 int
  67 parse_option (int argc, char **argv, const notmuch_opt_desc_t* options, int opt_index);
  68
  69 bool
  70 parse_position_arg (const char *arg,
  71                     int position_arg_index,
  72                     const notmuch_opt_desc_t* options);
  73
  74
  75 #endif