SAFE public projects git trees. - safe/jmp/linux-2.6/blob - tools/perf/util/parse-options.h

   1 #ifndef __PERF_PARSE_OPTIONS_H
   2 #define __PERF_PARSE_OPTIONS_H
   3
   4 enum parse_opt_type {
   5         /* special types */
   6         OPTION_END,
   7         OPTION_ARGUMENT,
   8         OPTION_GROUP,
   9         /* options with no arguments */
  10         OPTION_BIT,
  11         OPTION_BOOLEAN,
  12         OPTION_INCR,
  13         OPTION_SET_INT,
  14         OPTION_SET_PTR,
  15         /* options with arguments (usually) */
  16         OPTION_STRING,
  17         OPTION_INTEGER,
  18         OPTION_LONG,
  19         OPTION_CALLBACK,
  20         OPTION_U64,
  21         OPTION_UINTEGER,
  22 };
  23
  24 enum parse_opt_flags {
  25         PARSE_OPT_KEEP_DASHDASH = 1,
  26         PARSE_OPT_STOP_AT_NON_OPTION = 2,
  27         PARSE_OPT_KEEP_ARGV0 = 4,
  28         PARSE_OPT_KEEP_UNKNOWN = 8,
  29         PARSE_OPT_NO_INTERNAL_HELP = 16,
  30 };
  31
  32 enum parse_opt_option_flags {
  33         PARSE_OPT_OPTARG  = 1,
  34         PARSE_OPT_NOARG   = 2,
  35         PARSE_OPT_NONEG   = 4,
  36         PARSE_OPT_HIDDEN  = 8,
  37         PARSE_OPT_LASTARG_DEFAULT = 16,
  38 };
  39
  40 struct option;
  41 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
  42
  43 /*
  44  * `type`::
  45  *   holds the type of the option, you must have an OPTION_END last in your
  46  *   array.
  47  *
  48  * `short_name`::
  49  *   the character to use as a short option name, '\0' if none.
  50  *
  51  * `long_name`::
  52  *   the long option name, without the leading dashes, NULL if none.
  53  *
  54  * `value`::
  55  *   stores pointers to the values to be filled.
  56  *
  57  * `argh`::
  58  *   token to explain the kind of argument this option wants. Keep it
  59  *   homogenous across the repository.
  60  *
  61  * `help`::
  62  *   the short help associated to what the option does.
  63  *   Must never be NULL (except for OPTION_END).
  64  *   OPTION_GROUP uses this pointer to store the group header.
  65  *
  66  * `flags`::
  67  *   mask of parse_opt_option_flags.
  68  *   PARSE_OPT_OPTARG: says that the argument is optionnal (not for BOOLEANs)
  69  *   PARSE_OPT_NOARG: says that this option takes no argument, for CALLBACKs
  70  *   PARSE_OPT_NONEG: says that this option cannot be negated
  71  *   PARSE_OPT_HIDDEN this option is skipped in the default usage, showed in
  72  *                    the long one.
  73  *
  74  * `callback`::
  75  *   pointer to the callback to use for OPTION_CALLBACK.
  76  *
  77  * `defval`::
  78  *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
  79  *   OPTION_{BIT,SET_INT,SET_PTR} store the {mask,integer,pointer} to put in
  80  *   the value when met.
  81  *   CALLBACKS can use it like they want.
  82  */
  83 struct option {
  84         enum parse_opt_type type;
  85         int short_name;
  86         const char *long_name;
  87         void *value;
  88         const char *argh;
  89         const char *help;
  90
  91         int flags;
  92         parse_opt_cb *callback;
  93         intptr_t defval;
  94 };
  95
  96 #define OPT_END()                   { .type = OPTION_END }
  97 #define OPT_ARGUMENT(l, h)          { .type = OPTION_ARGUMENT, .long_name = (l), .help = (h) }
  98 #define OPT_GROUP(h)                { .type = OPTION_GROUP, .help = (h) }
  99 #define OPT_BIT(s, l, v, h, b)      { .type = OPTION_BIT, .short_name = (s), .long_name = (l), .value = (v), .help = (h), .defval = (b) }
 100 #define OPT_BOOLEAN(s, l, v, h)     { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = (v), .help = (h) }
 101 #define OPT_INCR(s, l, v, h)        { .type = OPTION_INCR, .short_name = (s), .long_name = (l), .value = (v), .help = (h) }
 102 #define OPT_SET_INT(s, l, v, h, i)  { .type = OPTION_SET_INT, .short_name = (s), .long_name = (l), .value = (v), .help = (h), .defval = (i) }
 103 #define OPT_SET_PTR(s, l, v, h, p)  { .type = OPTION_SET_PTR, .short_name = (s), .long_name = (l), .value = (v), .help = (h), .defval = (p) }
 104 #define OPT_INTEGER(s, l, v, h)     { .type = OPTION_INTEGER, .short_name = (s), .long_name = (l), .value = (v), .help = (h) }
 105 #define OPT_UINTEGER(s, l, v, h)    { .type = OPTION_UINTEGER, .short_name = (s), .long_name = (l), .value = (v), .help = (h) }
 106 #define OPT_LONG(s, l, v, h)        { .type = OPTION_LONG, .short_name = (s), .long_name = (l), .value = (v), .help = (h) }
 107 #define OPT_U64(s, l, v, h)         { .type = OPTION_U64, .short_name = (s), .long_name = (l), .value = (v), .help = (h) }
 108 #define OPT_STRING(s, l, v, a, h)   { .type = OPTION_STRING,  .short_name = (s), .long_name = (l), .value = (v), (a), .help = (h) }
 109 #define OPT_DATE(s, l, v, h) \
 110         { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = "time", .help = (h), .callback = parse_opt_approxidate_cb }
 111 #define OPT_CALLBACK(s, l, v, a, h, f) \
 112         { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), (a), .help = (h), .callback = (f) }
 113 #define OPT_CALLBACK_NOOPT(s, l, v, a, h, f) \
 114         { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), (a), .help = (h), .callback = (f), .flags = PARSE_OPT_NOARG }
 115 #define OPT_CALLBACK_DEFAULT(s, l, v, a, h, f, d) \
 116         { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), (a), .help = (h), .callback = (f), .defval = (intptr_t)d, .flags = PARSE_OPT_LASTARG_DEFAULT }
 117
 118 /* parse_options() will filter out the processed options and leave the
 119  * non-option argments in argv[].
 120  * Returns the number of arguments left in argv[].
 121  */
 122 extern int parse_options(int argc, const char **argv,
 123                          const struct option *options,
 124                          const char * const usagestr[], int flags);
 125
 126 extern NORETURN void usage_with_options(const char * const *usagestr,
 127                                         const struct option *options);
 128
 129 /*----- incremantal advanced APIs -----*/
 130
 131 enum {
 132         PARSE_OPT_HELP = -1,
 133         PARSE_OPT_DONE,
 134         PARSE_OPT_UNKNOWN,
 135 };
 136
 137 /*
 138  * It's okay for the caller to consume argv/argc in the usual way.
 139  * Other fields of that structure are private to parse-options and should not
 140  * be modified in any way.
 141  */
 142 struct parse_opt_ctx_t {
 143         const char **argv;
 144         const char **out;
 145         int argc, cpidx;
 146         const char *opt;
 147         int flags;
 148 };
 149
 150 extern int parse_options_usage(const char * const *usagestr,
 151                                const struct option *opts);
 152
 153 extern void parse_options_start(struct parse_opt_ctx_t *ctx,
 154                                 int argc, const char **argv, int flags);
 155
 156 extern int parse_options_step(struct parse_opt_ctx_t *ctx,
 157                               const struct option *options,
 158                               const char * const usagestr[]);
 159
 160 extern int parse_options_end(struct parse_opt_ctx_t *ctx);
 161
 162
 163 /*----- some often used options -----*/
 164 extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
 165 extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
 166 extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
 167
 168 #define OPT__VERBOSE(var)  OPT_BOOLEAN('v', "verbose", (var), "be verbose")
 169 #define OPT__QUIET(var)    OPT_BOOLEAN('q', "quiet",   (var), "be quiet")
 170 #define OPT__VERBOSITY(var) \
 171         { OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
 172           PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
 173         { OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
 174           PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
 175 #define OPT__DRY_RUN(var)  OPT_BOOLEAN('n', "dry-run", (var), "dry run")
 176 #define OPT__ABBREV(var)  \
 177         { OPTION_CALLBACK, 0, "abbrev", (var), "n", \
 178           "use <n> digits to display SHA-1s", \
 179           PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
 180
 181 extern const char *parse_options_fix_filename(const char *prefix, const char *file);
 182
 183 #endif /* __PERF_PARSE_OPTIONS_H */