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