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).  The first element of this array is non-NULL; the second
 125      is NULL if the canonical form uses only one argv element,
 126      non-NULL otherwise.  */
 127   const char *canonical_option[2];
 128
 129   /* For a boolean option, 1 for the true case and 0 for the "no-"
 130      case.  For an unsigned integer option, the value of the
 131      argument.  1 in all other cases.  */
 132   int value;
 133
 134   /* Any flags describing errors detected in this option.  */
 135   int errors;
 136 };
 137
 138 /* Structure describing a single option-handling callback.  */
 139
 140 struct cl_option_handler_func
 141 {
 142   /* The function called to handle the option.  */
 143   bool (*handler) (size_t opt_index, const char *arg, int value,
 144                    unsigned int lang_mask, int kind,
 145                    const struct cl_option_handlers *handlers);
 146
 147   /* The mask that must have some bit in common with the flags for the
 148      option for this particular handler to be used.  */
 149   unsigned int mask;
 150 };
 151
 152 /* Structure describing the callbacks used in handling options.  */
 153
 154 struct cl_option_handlers
 155 {
 156   /* Callback for an unknown option to determine whether to give an
 157      error for it, and possibly store information to diagnose the
 158      option at a later point.  Return true if an error should be
 159      given, false otherwise.  */
 160   bool (*unknown_option_callback) (const char *opt);
 161
 162   /* Callback to handle, and possibly diagnose, an option for another
 163      language.  */
 164   void (*wrong_lang_callback) (const char *text,
 165                                const struct cl_option *option,
 166                                unsigned int lang_mask);
 167
 168   /* Callback to call after the successful handling of any option.  */
 169   void (*post_handling_callback) (size_t opt_index, const char *arg,
 170                                   int value, unsigned int mask);
 171
 172   /* The number of individual handlers.  */
 173   size_t num_handlers;
 174
 175   /* The handlers themselves.  */
 176   struct cl_option_handler_func handlers[3];
 177 };
 178
 179 /* Input file names.  */
 180
 181 extern const char **in_fnames;
 182
 183 /* The count of input filenames.  */
 184
 185 extern unsigned num_in_fnames;
 186
 187 size_t find_opt (const char *input, int lang_mask);
 188 extern int integral_argument (const char *arg);
 189 extern void decode_cmdline_options_to_array (unsigned int argc,
 190                                              const char **argv,
 191                                              unsigned int lang_mask,
 192                                              struct cl_decoded_option **decoded_options,
 193                                              unsigned int *decoded_options_count);
 194 extern void prune_options (int *argcp, char ***argvp);
 195 extern void decode_options (unsigned int argc, const char **argv,
 196                             struct cl_decoded_option **decoded_options,
 197                             unsigned int *decoded_options_count);
 198 extern int option_enabled (int opt_idx);
 199 extern bool get_option_state (int, struct cl_option_state *);
 200 extern void set_option (int opt_index, int value, const char *arg, int);
 201 bool handle_option (size_t opt_index, const char *arg, int value,
 202                     unsigned int lang_mask, int kind,
 203                     const struct cl_option_handlers *handlers);
 204 extern void read_cmdline_option (struct cl_decoded_option *decoded,
 205                                  unsigned int lang_mask,
 206                                  const struct cl_option_handlers *handlers);
 207 extern void register_warning_as_error_callback (void (*callback) (int));
 208 extern void enable_warning_as_error (const char *arg, int value,
 209                                      unsigned int lang_mask,
 210                                      const struct cl_option_handlers *handlers);
 211 extern void print_ignored_options (void);
 212 #endif