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 << 14) /* Fake entry.  Used to display --param info with --help.  */
  71 #define CL_WARNING              (1 << 15) /* Enables an (optional) warning message.  */
  72 #define CL_OPTIMIZATION         (1 << 16) /* Enables an (optional) optimization.  */
  73 #define CL_DRIVER               (1 << 17) /* Driver option.  */
  74 #define CL_TARGET               (1 << 18) /* Target-specific option.  */
  75 #define CL_COMMON               (1 << 19) /* Language-independent.  */
  76
  77 #define CL_MIN_OPTION_CLASS     CL_PARAMS
  78 #define CL_MAX_OPTION_CLASS     CL_COMMON
  79
  80 /* From here on the bits describe attributes of the options.
  81    Before this point the bits have described the class of the option.
  82    This distinction is important because --help will not list options
  83    which only have these higher bits set.  */
  84
  85 #define CL_NO_DRIVER_ARG        (1 << 20) /* Option takes no argument in the driver.  */
  86 #define CL_REJECT_DRIVER        (1 << 21) /* Reject this option in the driver.  */
  87 #define CL_SAVE                 (1 << 22) /* Target-specific option for attribute.  */
  88 #define CL_DISABLED             (1 << 23) /* Disabled in this configuration.  */
  89 #define CL_REPORT               (1 << 24) /* Report argument with -fverbose-asm  */
  90 #define CL_JOINED               (1 << 25) /* If takes joined argument.  */
  91 #define CL_SEPARATE             (1 << 26) /* If takes a separate argument.  */
  92 #define CL_REJECT_NEGATIVE      (1 << 27) /* Reject no- form.  */
  93 #define CL_MISSING_OK           (1 << 28) /* Missing argument OK (joined).  */
  94 #define CL_UINTEGER             (1 << 29) /* Argument is an integer >=0.  */
  95 #define CL_UNDOCUMENTED         (1 << 30) /* Do not output with --help.  */
  96
  97 /* Possible ways in which a command-line option may be erroneous.
  98    These do not include not being known at all; an option index of
  99    OPT_SPECIAL_unknown is used for that.  */
 100
 101 #define CL_ERR_DISABLED         (1 << 0) /* Disabled in this configuration.  */
 102 #define CL_ERR_MISSING_ARG      (1 << 1) /* Argument required but missing.  */
 103 #define CL_ERR_WRONG_LANG       (1 << 2) /* Option for wrong language.  */
 104 #define CL_ERR_UINT_ARG         (1 << 3) /* Bad unsigned integer argument.  */
 105 #define CL_ERR_NEGATIVE         (1 << 4) /* Negative form of option
 106                                             not permitted (together
 107                                             with OPT_SPECIAL_unknown).  */
 108
 109 /* Structure describing the result of decoding an option.  */
 110
 111 struct cl_decoded_option
 112 {
 113   /* The index of this option, or an OPT_SPECIAL_* value for
 114      non-options and unknown options.  */
 115   size_t opt_index;
 116
 117   /* The string argument, or NULL if none.  For OPT_SPECIAL_* cases,
 118      the option or non-option command-line argument.  */
 119   const char *arg;
 120
 121   /* The original text of option plus arguments, with separate argv
 122      elements concatenated into one string with spaces separating
 123      them.  This is for such uses as diagnostics and
 124      -frecord-gcc-switches.  */
 125   const char *orig_option_with_args_text;
 126
 127   /* The canonical form of the option and its argument, for when it is
 128      necessary to reconstruct argv elements (in particular, for
 129      processing specs and passing options to subprocesses from the
 130      driver).  */
 131   const char *canonical_option[4];
 132
 133   /* The number of elements in the canonical form of the option and
 134      arguments; always at least 1.  */
 135   size_t canonical_option_num_elements;
 136
 137   /* For a boolean option, 1 for the true case and 0 for the "no-"
 138      case.  For an unsigned integer option, the value of the
 139      argument.  1 in all other cases.  */
 140   int value;
 141
 142   /* Any flags describing errors detected in this option.  */
 143   int errors;
 144 };
 145
 146 /* Structure describing a single option-handling callback.  */
 147
 148 struct cl_option_handler_func
 149 {
 150   /* The function called to handle the option.  */
 151   bool (*handler) (const struct cl_decoded_option *decoded,
 152                    unsigned int lang_mask, int kind,
 153                    const struct cl_option_handlers *handlers);
 154
 155   /* The mask that must have some bit in common with the flags for the
 156      option for this particular handler to be used.  */
 157   unsigned int mask;
 158 };
 159
 160 /* Structure describing the callbacks used in handling options.  */
 161
 162 struct cl_option_handlers
 163 {
 164   /* Callback for an unknown option to determine whether to give an
 165      error for it, and possibly store information to diagnose the
 166      option at a later point.  Return true if an error should be
 167      given, false otherwise.  */
 168   bool (*unknown_option_callback) (const struct cl_decoded_option *decoded);
 169
 170   /* Callback to handle, and possibly diagnose, an option for another
 171      language.  */
 172   void (*wrong_lang_callback) (const struct cl_decoded_option *decoded,
 173                                unsigned int lang_mask);
 174
 175   /* Callback to call after the successful handling of any option.  */
 176   void (*post_handling_callback) (const struct cl_decoded_option *decoded,
 177                                   unsigned int mask);
 178
 179   /* The number of individual handlers.  */
 180   size_t num_handlers;
 181
 182   /* The handlers themselves.  */
 183   struct cl_option_handler_func handlers[3];
 184 };
 185
 186 /* Input file names.  */
 187
 188 extern const char **in_fnames;
 189
 190 /* The count of input filenames.  */
 191
 192 extern unsigned num_in_fnames;
 193
 194 size_t find_opt (const char *input, int lang_mask);
 195 extern int integral_argument (const char *arg);
 196 extern void decode_cmdline_options_to_array (unsigned int argc,
 197                                              const char **argv,
 198                                              unsigned int lang_mask,
 199                                              struct cl_decoded_option **decoded_options,
 200                                              unsigned int *decoded_options_count);
 201 extern void prune_options (int *argcp, char ***argvp);
 202 extern void decode_options (unsigned int argc, const char **argv,
 203                             struct cl_decoded_option **decoded_options,
 204                             unsigned int *decoded_options_count);
 205 extern int option_enabled (int opt_idx);
 206 extern bool get_option_state (int, struct cl_option_state *);
 207 extern void set_option (int opt_index, int value, const char *arg, int);
 208 bool handle_option (const struct cl_decoded_option *decoded,
 209                     unsigned int lang_mask, int kind,
 210                     const struct cl_option_handlers *handlers);
 211 bool handle_generated_option (size_t opt_index, const char *arg, int value,
 212                               unsigned int lang_mask, int kind,
 213                               const struct cl_option_handlers *handlers);
 214 void generate_option (size_t opt_index, const char *arg, int value,
 215                       unsigned int lang_mask,
 216                       struct cl_decoded_option *decoded);
 217 void generate_option_input_file (const char *file,
 218                                  struct cl_decoded_option *decoded);
 219 extern void read_cmdline_option (struct cl_decoded_option *decoded,
 220                                  unsigned int lang_mask,
 221                                  const struct cl_option_handlers *handlers);
 222 extern void register_warning_as_error_callback (void (*callback) (int));
 223 extern void enable_warning_as_error (const char *arg, int value,
 224                                      unsigned int lang_mask,
 225                                      const struct cl_option_handlers *handlers);
 226 extern void print_ignored_options (void);
 227 #endif