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