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