gcc/opts.h

   1 /* Command line option handling.
   2    Copyright (C) 2002, 2003, 2004, 2005, 2007 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GCC_OPTS_H
  21 #define GCC_OPTS_H
  22
  23 /* Specifies how a switch's VAR_VALUE relates to its FLAG_VAR.  */
  24 enum cl_var_type {
  25   /* The switch is enabled when FLAG_VAR is nonzero.  */
  26   CLVC_BOOLEAN,
  27
  28   /* The switch is enabled when FLAG_VAR == VAR_VALUE.  */
  29   CLVC_EQUAL,
  30
  31   /* The switch is enabled when VAR_VALUE is not set in FLAG_VAR.  */
  32   CLVC_BIT_CLEAR,
  33
  34   /* The switch is enabled when VAR_VALUE is set in FLAG_VAR.  */
  35   CLVC_BIT_SET,
  36
  37   /* The switch takes a string argument and FLAG_VAR points to that
  38      argument.  */
  39   CLVC_STRING
  40 };
  41
  42 struct cl_option
  43 {
  44   const char *opt_text;
  45   const char *help;
  46   unsigned short back_chain;
  47   unsigned char opt_len;
  48   int neg_index;
  49   unsigned int flags;
  50   void *flag_var;
  51   enum cl_var_type var_type;
  52   int var_value;
  53 };
  54
  55 /* Records that the state of an option consists of SIZE bytes starting
  56    at DATA.  DATA might point to CH in some cases.  */
  57 struct cl_option_state {
  58   const void *data;
  59   size_t size;
  60   char ch;
  61 };
  62
  63 extern const struct cl_option cl_options[];
  64 extern const unsigned int cl_options_count;
  65 extern const char *const lang_names[];
  66 extern const unsigned int cl_lang_count;
  67
  68 #define CL_PARAMS               (1 << 17) /* Fake entry.  Used to display --param info with --help.  */
  69 #define CL_WARNING              (1 << 18) /* Enables an (optional) warning message.  */
  70 #define CL_OPTIMIZATION         (1 << 19) /* Enables an (optional) optimization.  */
  71 #define CL_TARGET               (1 << 20) /* Target-specific option.  */
  72 #define CL_COMMON               (1 << 21) /* Language-independent.  */
  73
  74 #define CL_MIN_OPTION_CLASS     CL_PARAMS
  75 #define CL_MAX_OPTION_CLASS     CL_COMMON
  76
  77 /* From here on the bits describe attributes of the options.
  78    Before this point the bits have described the class of the option.
  79    This distinction is important because --help will not list options
  80    which only have these higher bits set.  */
  81
  82 #define CL_SAVE                 (1 << 22) /* Target-specific option for attribute.  */
  83 #define CL_DISABLED             (1 << 23) /* Disabled in this configuration.  */
  84 #define CL_REPORT               (1 << 24) /* Report argument with -fverbose-asm  */
  85 #define CL_JOINED               (1 << 25) /* If takes joined argument.  */
  86 #define CL_SEPARATE             (1 << 26) /* If takes a separate argument.  */
  87 #define CL_REJECT_NEGATIVE      (1 << 27) /* Reject no- form.  */
  88 #define CL_MISSING_OK           (1 << 28) /* Missing argument OK (joined).  */
  89 #define CL_UINTEGER             (1 << 29) /* Argument is an integer >=0.  */
  90 #define CL_UNDOCUMENTED         (1 << 30) /* Do not output with --help.  */
  91
  92 /* Input file names.  */
  93
  94 extern const char **in_fnames;
  95
  96 /* The count of input filenames.  */
  97
  98 extern unsigned num_in_fnames;
  99
 100 size_t find_opt (const char *input, int lang_mask);
 101 extern void prune_options (int *argcp, char ***argvp);
 102 extern void decode_options (unsigned int argc, const char **argv);
 103 extern int option_enabled (int opt_idx);
 104 extern bool get_option_state (int, struct cl_option_state *);
 105
 106 extern void enable_warning_as_error (const char *arg, int value,
 107                                      unsigned int lang_mask);
 108 extern void print_ignored_options (void);
 109 #endif