gcc/opts.h

   1 /* Command line option handling.
   2    Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef GCC_OPTS_H
  22 #define GCC_OPTS_H
  23
  24 /* Specifies how a switch's VAR_VALUE relates to its FLAG_VAR.  */
  25 enum cl_var_type {
  26   /* The switch is enabled when FLAG_VAR is nonzero.  */
  27   CLVC_BOOLEAN,
  28
  29   /* The switch is enabled when FLAG_VAR == VAR_VALUE.  */
  30   CLVC_EQUAL,
  31
  32   /* The switch is enabled when VAR_VALUE is not set in FLAG_VAR.  */
  33   CLVC_BIT_CLEAR,
  34
  35   /* The switch is enabled when VAR_VALUE is set in FLAG_VAR.  */
  36   CLVC_BIT_SET,
  37
  38   /* The switch takes a string argument and FLAG_VAR points to that
  39      argument.  */
  40   CLVC_STRING
  41 };
  42
  43 struct cl_option
  44 {
  45   const char *opt_text;
  46   const char *help;
  47   const char *missing_argument_error;
  48   unsigned short back_chain;
  49   unsigned char opt_len;
  50   int neg_index;
  51   unsigned int flags;
  52   void *flag_var;
  53   enum cl_var_type var_type;
  54   int var_value;
  55 };
  56
  57 /* Records that the state of an option consists of SIZE bytes starting
  58    at DATA.  DATA might point to CH in some cases.  */
  59 struct cl_option_state {
  60   const void *data;
  61   size_t size;
  62   char ch;
  63 };
  64
  65 extern const struct cl_option cl_options[];
  66 extern const unsigned int cl_options_count;
  67 extern const char *const lang_names[];
  68 extern const unsigned int cl_lang_count;
  69
  70 #define CL_PARAMS               (1 << 17) /* Fake entry.  Used to display --param info with --help.  */
  71 #define CL_WARNING              (1 << 18) /* Enables an (optional) warning message.  */
  72 #define CL_OPTIMIZATION         (1 << 19) /* Enables an (optional) optimization.  */
  73 #define CL_TARGET               (1 << 20) /* Target-specific option.  */
  74 #define CL_COMMON               (1 << 21) /* Language-independent.  */
  75
  76 #define CL_MIN_OPTION_CLASS     CL_PARAMS
  77 #define CL_MAX_OPTION_CLASS     CL_COMMON
  78
  79 /* From here on the bits describe attributes of the options.
  80    Before this point the bits have described the class of the option.
  81    This distinction is important because --help will not list options
  82    which only have these higher bits set.  */
  83
  84 #define CL_SAVE                 (1 << 22) /* Target-specific option for attribute.  */
  85 #define CL_DISABLED             (1 << 23) /* Disabled in this configuration.  */
  86 #define CL_REPORT               (1 << 24) /* Report argument with -fverbose-asm  */
  87 #define CL_JOINED               (1 << 25) /* If takes joined argument.  */
  88 #define CL_SEPARATE             (1 << 26) /* If takes a separate argument.  */
  89 #define CL_REJECT_NEGATIVE      (1 << 27) /* Reject no- form.  */
  90 #define CL_MISSING_OK           (1 << 28) /* Missing argument OK (joined).  */
  91 #define CL_UINTEGER             (1 << 29) /* Argument is an integer >=0.  */
  92 #define CL_UNDOCUMENTED         (1 << 30) /* Do not output with --help.  */
  93
  94 /* Possible ways in which a command-line option may be erroneous.
  95    These do not include not being known at all; an option index of
  96    OPT_SPECIAL_unknown is used for that.  */
  97
  98 #define CL_ERR_DISABLED         (1 << 0) /* Disabled in this configuration.  */
  99 #define CL_ERR_MISSING_ARG      (1 << 1) /* Argument required but missing.  */
 100 #define CL_ERR_WRONG_LANG       (1 << 2) /* Option for wrong language.  */
 101 #define CL_ERR_UINT_ARG         (1 << 3) /* Bad unsigned integer argument.  */
 102
 103 /* Structure describing the result of decoding an option.  */
 104
 105 struct cl_decoded_option
 106 {
 107   /* The index of this option, or an OPT_SPECIAL_* value for
 108      non-options and unknown options.  */
 109   size_t opt_index;
 110
 111   /* The string argument, or NULL if none.  For OPT_SPECIAL_* cases,
 112      the option or non-option command-line argument.  */
 113   const char *arg;
 114
 115   /* The original text of option plus arguments, with separate argv
 116      elements concatenated into one string with spaces separating
 117      them.  This is for such uses as diagnostics and
 118      -frecord-gcc-switches.  */
 119   const char *orig_option_with_args_text;
 120
 121   /* The canonical form of the option and its argument, for when it is
 122      necessary to reconstruct argv elements (in particular, for
 123      processing specs and passing options to subprocesses from the
 124      driver).  */
 125   const char *canonical_option[4];
 126
 127   /* The number of elements in the canonical form of the option and
 128      arguments; always at least 1.  */
 129   size_t canonical_option_num_elements;
 130
 131   /* For a boolean option, 1 for the true case and 0 for the "no-"
 132      case.  For an unsigned integer option, the value of the
 133      argument.  1 in all other cases.  */
 134   int value;
 135
 136   /* Any flags describing errors detected in this option.  */
 137   int errors;
 138 };
 139
 140 /* Structure describing a single option-handling callback.  */
 141
 142 struct cl_option_handler_func
 143 {
 144   /* The function called to handle the option.  */
 145   bool (*handler) (size_t opt_index, const char *arg, int value,
 146                    unsigned int lang_mask, int kind,
 147                    const struct cl_option_handlers *handlers);
 148
 149   /* The mask that must have some bit in common with the flags for the
 150      option for this particular handler to be used.  */
 151   unsigned int mask;
 152 };
 153
 154 /* Structure describing the callbacks used in handling options.  */
 155
 156 struct cl_option_handlers
 157 {
 158   /* Callback for an unknown option to determine whether to give an
 159      error for it, and possibly store information to diagnose the
 160      option at a later point.  Return true if an error should be
 161      given, false otherwise.  */
 162   bool (*unknown_option_callback) (const char *opt);
 163
 164   /* Callback to handle, and possibly diagnose, an option for another
 165      language.  */
 166   void (*wrong_lang_callback) (const char *text,
 167                                const struct cl_option *option,
 168                                unsigned int lang_mask);
 169
 170   /* Callback to call after the successful handling of any option.  */
 171   void (*post_handling_callback) (size_t opt_index, const char *arg,
 172                                   int value, unsigned int mask);
 173
 174   /* The number of individual handlers.  */
 175   size_t num_handlers;
 176
 177   /* The handlers themselves.  */
 178   struct cl_option_handler_func handlers[3];
 179 };
 180
 181 /* Input file names.  */
 182
 183 extern const char **in_fnames;
 184
 185 /* The count of input filenames.  */
 186
 187 extern unsigned num_in_fnames;
 188
 189 size_t find_opt (const char *input, int lang_mask);
 190 extern int integral_argument (const char *arg);
 191 extern void decode_cmdline_options_to_array (unsigned int argc,
 192                                              const char **argv,
 193                                              unsigned int lang_mask,
 194                                              struct cl_decoded_option **decoded_options,
 195                                              unsigned int *decoded_options_count);
 196 extern void prune_options (int *argcp, char ***argvp);
 197 extern void decode_options (unsigned int argc, const char **argv,
 198                             struct cl_decoded_option **decoded_options,
 199                             unsigned int *decoded_options_count);
 200 extern int option_enabled (int opt_idx);
 201 extern bool get_option_state (int, struct cl_option_state *);
 202 extern void set_option (int opt_index, int value, const char *arg, int);
 203 bool handle_option (size_t opt_index, const char *arg, int value,
 204                     unsigned int lang_mask, int kind,
 205                     const struct cl_option_handlers *handlers);
 206 extern void read_cmdline_option (struct cl_decoded_option *decoded,
 207                                  unsigned int lang_mask,
 208                                  const struct cl_option_handlers *handlers);
 209 extern void register_warning_as_error_callback (void (*callback) (int));
 210 extern void enable_warning_as_error (const char *arg, int value,
 211                                      unsigned int lang_mask,
 212                                      const struct cl_option_handlers *handlers);
 213 extern void print_ignored_options (void);
 214 #endif