1 /* Command line option handling.
2 Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010
3 Free Software Foundation, Inc.
5 This file is part of GCC.
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
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
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/>. */
27 /* Specifies how a switch's VAR_VALUE relates to its FLAG_VAR. */
29 /* The switch is enabled when FLAG_VAR is nonzero. */
32 /* The switch is enabled when FLAG_VAR == VAR_VALUE. */
35 /* The switch is enabled when VAR_VALUE is not set in FLAG_VAR. */
38 /* The switch is enabled when VAR_VALUE is set in FLAG_VAR. */
41 /* The switch takes a string argument and FLAG_VAR points to that
45 /* The switch should be stored in the VEC pointed to by FLAG_VAR for
54 const char *missing_argument_error
;
55 const char *warn_message
;
56 const char *alias_arg
;
57 const char *neg_alias_arg
;
58 unsigned short alias_target
;
59 unsigned short back_chain
;
60 unsigned char opt_len
;
63 unsigned short flag_var_offset
;
64 enum cl_var_type var_type
;
68 /* Records that the state of an option consists of SIZE bytes starting
69 at DATA. DATA might point to CH in some cases. */
70 struct cl_option_state
{
76 extern const struct cl_option cl_options
[];
77 extern const unsigned int cl_options_count
;
78 extern const char *const lang_names
[];
79 extern const unsigned int cl_lang_count
;
81 #define CL_PARAMS (1 << 11) /* Fake entry. Used to display --param info with --help. */
82 #define CL_WARNING (1 << 12) /* Enables an (optional) warning message. */
83 #define CL_OPTIMIZATION (1 << 13) /* Enables an (optional) optimization. */
84 #define CL_DRIVER (1 << 14) /* Driver option. */
85 #define CL_TARGET (1 << 15) /* Target-specific option. */
86 #define CL_COMMON (1 << 16) /* Language-independent. */
88 #define CL_MIN_OPTION_CLASS CL_PARAMS
89 #define CL_MAX_OPTION_CLASS CL_COMMON
91 /* From here on the bits describe attributes of the options.
92 Before this point the bits have described the class of the option.
93 This distinction is important because --help will not list options
94 which only have these higher bits set. */
96 /* Options marked with CL_SEPARATE take a number of separate arguments
97 (1 to 4) that is one more than the number in this bit-field. */
98 #define CL_SEPARATE_NARGS_SHIFT 17
99 #define CL_SEPARATE_NARGS_MASK (3 << CL_SEPARATE_NARGS_SHIFT)
101 #define CL_SEPARATE_ALIAS (1 << 19) /* Option is an alias when used with separate argument. */
102 #define CL_NO_DRIVER_ARG (1 << 20) /* Option takes no argument in the driver. */
103 #define CL_REJECT_DRIVER (1 << 21) /* Reject this option in the driver. */
104 #define CL_SAVE (1 << 22) /* Target-specific option for attribute. */
105 #define CL_DISABLED (1 << 23) /* Disabled in this configuration. */
106 #define CL_REPORT (1 << 24) /* Report argument with -fverbose-asm */
107 #define CL_JOINED (1 << 25) /* If takes joined argument. */
108 #define CL_SEPARATE (1 << 26) /* If takes a separate argument. */
109 #define CL_REJECT_NEGATIVE (1 << 27) /* Reject no- form. */
110 #define CL_MISSING_OK (1 << 28) /* Missing argument OK (joined). */
111 #define CL_UINTEGER (1 << 29) /* Argument is an integer >=0. */
112 #define CL_UNDOCUMENTED (1 << 30) /* Do not output with --help. */
114 /* Possible ways in which a command-line option may be erroneous.
115 These do not include not being known at all; an option index of
116 OPT_SPECIAL_unknown is used for that. */
118 #define CL_ERR_DISABLED (1 << 0) /* Disabled in this configuration. */
119 #define CL_ERR_MISSING_ARG (1 << 1) /* Argument required but missing. */
120 #define CL_ERR_WRONG_LANG (1 << 2) /* Option for wrong language. */
121 #define CL_ERR_UINT_ARG (1 << 3) /* Bad unsigned integer argument. */
122 #define CL_ERR_NEGATIVE (1 << 4) /* Negative form of option
123 not permitted (together
124 with OPT_SPECIAL_unknown). */
126 /* Structure describing the result of decoding an option. */
128 struct cl_decoded_option
130 /* The index of this option, or an OPT_SPECIAL_* value for
131 non-options and unknown options. */
134 /* Any warning to give for use of this option, or NULL if none. */
135 const char *warn_message
;
137 /* The string argument, or NULL if none. For OPT_SPECIAL_* cases,
138 the option or non-option command-line argument. */
141 /* The original text of option plus arguments, with separate argv
142 elements concatenated into one string with spaces separating
143 them. This is for such uses as diagnostics and
144 -frecord-gcc-switches. */
145 const char *orig_option_with_args_text
;
147 /* The canonical form of the option and its argument, for when it is
148 necessary to reconstruct argv elements (in particular, for
149 processing specs and passing options to subprocesses from the
151 const char *canonical_option
[4];
153 /* The number of elements in the canonical form of the option and
154 arguments; always at least 1. */
155 size_t canonical_option_num_elements
;
157 /* For a boolean option, 1 for the true case and 0 for the "no-"
158 case. For an unsigned integer option, the value of the
159 argument. 1 in all other cases. */
162 /* Any flags describing errors detected in this option. */
166 /* Structure describing an option deferred for handling after the main
171 /* Elements from struct cl_decoded_option used for deferred
176 } cl_deferred_option
;
177 DEF_VEC_O(cl_deferred_option
);
178 DEF_VEC_ALLOC_O(cl_deferred_option
,heap
);
180 /* Structure describing a single option-handling callback. */
182 struct cl_option_handler_func
184 /* The function called to handle the option. */
185 bool (*handler
) (struct gcc_options
*opts
,
186 struct gcc_options
*opts_set
,
187 const struct cl_decoded_option
*decoded
,
188 unsigned int lang_mask
, int kind
, location_t loc
,
189 const struct cl_option_handlers
*handlers
,
190 diagnostic_context
*dc
);
192 /* The mask that must have some bit in common with the flags for the
193 option for this particular handler to be used. */
197 /* Structure describing the callbacks used in handling options. */
199 struct cl_option_handlers
201 /* Callback for an unknown option to determine whether to give an
202 error for it, and possibly store information to diagnose the
203 option at a later point. Return true if an error should be
204 given, false otherwise. */
205 bool (*unknown_option_callback
) (const struct cl_decoded_option
*decoded
);
207 /* Callback to handle, and possibly diagnose, an option for another
209 void (*wrong_lang_callback
) (const struct cl_decoded_option
*decoded
,
210 unsigned int lang_mask
);
212 /* Callback to call after the successful handling of any option. */
213 void (*post_handling_callback
) (const struct cl_decoded_option
*decoded
,
216 /* The number of individual handlers. */
219 /* The handlers themselves. */
220 struct cl_option_handler_func handlers
[3];
223 /* Input file names. */
225 extern const char **in_fnames
;
227 /* The count of input filenames. */
229 extern unsigned num_in_fnames
;
231 size_t find_opt (const char *input
, int lang_mask
);
232 extern int integral_argument (const char *arg
);
233 extern void decode_cmdline_options_to_array (unsigned int argc
,
235 unsigned int lang_mask
,
236 struct cl_decoded_option
**decoded_options
,
237 unsigned int *decoded_options_count
);
238 extern void init_options_once (void);
239 extern void init_options_struct (struct gcc_options
*opts
,
240 struct gcc_options
*opts_set
);
241 extern void decode_cmdline_options_to_array_default_mask (unsigned int argc
,
243 struct cl_decoded_option
**decoded_options
,
244 unsigned int *decoded_options_count
);
245 extern void set_default_handlers (struct cl_option_handlers
*handlers
);
246 extern void decode_options (struct gcc_options
*opts
,
247 struct gcc_options
*opts_set
,
248 struct cl_decoded_option
*decoded_options
,
249 unsigned int decoded_options_count
,
251 diagnostic_context
*dc
);
252 extern int option_enabled (int opt_idx
, void *opts
);
253 extern bool get_option_state (struct gcc_options
*, int,
254 struct cl_option_state
*);
255 extern void set_option (struct gcc_options
*opts
,
256 struct gcc_options
*opts_set
,
257 int opt_index
, int value
, const char *arg
, int kind
,
258 location_t loc
, diagnostic_context
*dc
);
259 extern void *option_flag_var (int opt_index
, struct gcc_options
*opts
);
260 bool handle_generated_option (struct gcc_options
*opts
,
261 struct gcc_options
*opts_set
,
262 size_t opt_index
, const char *arg
, int value
,
263 unsigned int lang_mask
, int kind
, location_t loc
,
264 const struct cl_option_handlers
*handlers
,
265 diagnostic_context
*dc
);
266 void generate_option (size_t opt_index
, const char *arg
, int value
,
267 unsigned int lang_mask
,
268 struct cl_decoded_option
*decoded
);
269 void generate_option_input_file (const char *file
,
270 struct cl_decoded_option
*decoded
);
271 extern void read_cmdline_option (struct gcc_options
*opts
,
272 struct gcc_options
*opts_set
,
273 struct cl_decoded_option
*decoded
,
275 unsigned int lang_mask
,
276 const struct cl_option_handlers
*handlers
,
277 diagnostic_context
*dc
);
278 extern void control_warning_option (unsigned int opt_index
, int kind
,
279 bool imply
, location_t loc
,
280 unsigned int lang_mask
,
281 const struct cl_option_handlers
*handlers
,
282 struct gcc_options
*opts
,
283 struct gcc_options
*opts_set
,
284 diagnostic_context
*dc
);
285 extern void print_ignored_options (void);
286 extern void handle_common_deferred_options (void);
287 extern bool common_handle_option (struct gcc_options
*opts
,
288 struct gcc_options
*opts_set
,
289 const struct cl_decoded_option
*decoded
,
290 unsigned int lang_mask
, int kind
,
292 const struct cl_option_handlers
*handlers
,
293 diagnostic_context
*dc
);
294 extern bool target_handle_option (struct gcc_options
*opts
,
295 struct gcc_options
*opts_set
,
296 const struct cl_decoded_option
*decoded
,
297 unsigned int lang_mask
, int kind
,
299 const struct cl_option_handlers
*handlers
,
300 diagnostic_context
*dc
);
301 extern void finish_options (struct gcc_options
*opts
,
302 struct gcc_options
*opts_set
,
304 extern void default_options_optimization (struct gcc_options
*opts
,
305 struct gcc_options
*opts_set
,
306 struct cl_decoded_option
*decoded_options
,
307 unsigned int decoded_options_count
,
309 unsigned int lang_mask
,
310 const struct cl_option_handlers
*handlers
,
311 diagnostic_context
*dc
);
312 extern void set_struct_debug_option (struct gcc_options
*opts
,