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   unsigned short back_chain;
  48   unsigned char opt_len;
  49   int neg_index;
  50   unsigned int flags;
  51   void *flag_var;
  52   enum cl_var_type var_type;
  53   int var_value;
  54 };
  55
  56 /* Records that the state of an option consists of SIZE bytes starting
  57    at DATA.  DATA might point to CH in some cases.  */
  58 struct cl_option_state {
  59   const void *data;
  60   size_t size;
  61   char ch;
  62 };
  63
  64 extern const struct cl_option cl_options[];
  65 extern const unsigned int cl_options_count;
  66 extern const char *const lang_names[];
  67 extern const unsigned int cl_lang_count;
  68
  69 #define CL_PARAMS               (1 << 17) /* Fake entry.  Used to display --param info with --help.  */
  70 #define CL_WARNING              (1 << 18) /* Enables an (optional) warning message.  */
  71 #define CL_OPTIMIZATION         (1 << 19) /* Enables an (optional) optimization.  */
  72 #define CL_TARGET               (1 << 20) /* Target-specific option.  */
  73 #define CL_COMMON               (1 << 21) /* Language-independent.  */
  74
  75 #define CL_MIN_OPTION_CLASS     CL_PARAMS
  76 #define CL_MAX_OPTION_CLASS     CL_COMMON
  77
  78 /* From here on the bits describe attributes of the options.
  79    Before this point the bits have described the class of the option.
  80    This distinction is important because --help will not list options
  81    which only have these higher bits set.  */
  82
  83 #define CL_SAVE                 (1 << 22) /* Target-specific option for attribute.  */
  84 #define CL_DISABLED             (1 << 23) /* Disabled in this configuration.  */
  85 #define CL_REPORT               (1 << 24) /* Report argument with -fverbose-asm  */
  86 #define CL_JOINED               (1 << 25) /* If takes joined argument.  */
  87 #define CL_SEPARATE             (1 << 26) /* If takes a separate argument.  */
  88 #define CL_REJECT_NEGATIVE      (1 << 27) /* Reject no- form.  */
  89 #define CL_MISSING_OK           (1 << 28) /* Missing argument OK (joined).  */
  90 #define CL_UINTEGER             (1 << 29) /* Argument is an integer >=0.  */
  91 #define CL_UNDOCUMENTED         (1 << 30) /* Do not output with --help.  */
  92
  93 /* Possible ways in which a command-line option may be erroneous.
  94    These do not include not being known at all; an option index of
  95    OPT_SPECIAL_unknown is used for that.  */
  96
  97 #define CL_ERR_DISABLED         (1 << 0) /* Disabled in this configuration.  */
  98 #define CL_ERR_MISSING_ARG      (1 << 1) /* Argument required but missing.  */
  99 #define CL_ERR_WRONG_LANG       (1 << 2) /* Option for wrong language.  */
 100 #define CL_ERR_UINT_ARG         (1 << 3) /* Bad unsigned integer argument.  */
 101
 102 /* Structure describing the result of decoding an option.  */
 103
 104 struct cl_decoded_option
 105 {
 106   /* The index of this option, or an OPT_SPECIAL_* value for
 107      non-options and unknown options.  */
 108   size_t opt_index;
 109
 110   /* The string argument, or NULL if none.  For OPT_SPECIAL_* cases,
 111      the option or non-option command-line argument.  */
 112   const char *arg;
 113
 114   /* The original text of option plus arguments, with separate argv
 115      elements concatenated into one string with spaces separating
 116      them.  This is for such uses as diagnostics and
 117      -frecord-gcc-switches.  */
 118   const char *orig_option_with_args_text;
 119
 120   /* For a boolean option, 1 for the true case and 0 for the "no-"
 121      case.  For an unsigned integer option, the value of the
 122      argument.  1 in all other cases.  */
 123   int value;
 124
 125   /* Any flags describing errors detected in this option.  */
 126   int errors;
 127 };
 128
 129 /* Input file names.  */
 130
 131 extern const char **in_fnames;
 132
 133 /* The count of input filenames.  */
 134
 135 extern unsigned num_in_fnames;
 136
 137 size_t find_opt (const char *input, int lang_mask);
 138 extern int integral_argument (const char *arg);
 139 extern void decode_cmdline_options_to_array (unsigned int argc,
 140                                              const char **argv,
 141                                              unsigned int lang_mask,
 142                                              struct cl_decoded_option **decoded_options,
 143                                              unsigned int *decoded_options_count);
 144 extern void prune_options (int *argcp, char ***argvp);
 145 extern void decode_options (unsigned int argc, const char **argv,
 146                             struct cl_decoded_option **decoded_options,
 147                             unsigned int *decoded_options_count);
 148 extern int option_enabled (int opt_idx);
 149 extern bool get_option_state (int, struct cl_option_state *);
 150 extern void set_option (int opt_index, int value, const char *arg, int);
 151 bool handle_option (int opt_index, int value, const char *arg,
 152                     unsigned int lang_mask, int kind);
 153 extern void register_warning_as_error_callback (void (*callback) (int));
 154 extern void enable_warning_as_error (const char *arg, int value,
 155                                      unsigned int lang_mask);
 156 extern void print_ignored_options (void);
 157 #endif