1/* Command line option handling.
2   Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008
3   Free Software Foundation, Inc.
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 3, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along 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.  */
25enum 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
43struct 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.  */
58struct cl_option_state {
59  const void *data;
60  size_t size;
61  char ch;
62};
63
64extern const struct cl_option cl_options[];
65extern const unsigned int cl_options_count;
66extern const char *const lang_names[];
67extern 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/* Input file names.  */
94
95extern const char **in_fnames;
96
97/* The count of input filenames.  */
98
99extern unsigned num_in_fnames;
100
101size_t find_opt (const char *input, int lang_mask);
102extern void prune_options (int *argcp, char ***argvp);
103extern void decode_options (unsigned int argc, const char **argv);
104extern int option_enabled (int opt_idx);
105extern bool get_option_state (int, struct cl_option_state *);
106extern void set_option (const struct cl_option *, int, const char *);
107
108extern void enable_warning_as_error (const char *arg, int value,
109				     unsigned int lang_mask);
110extern void print_ignored_options (void);
111#endif
112