Daily bump.
[official-gcc.git] / gcc / opts.h
blobf6940823403912f85d13b93edbea066fc2e9892e
1 /* Command line option handling.
2 Copyright (C) 2002-2014 Free Software Foundation, Inc.
4 This file is part of GCC.
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.
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.
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/>. */
20 #ifndef GCC_OPTS_H
21 #define GCC_OPTS_H
23 #include "input.h"
24 #include "vec.h"
25 #include "obstack.h"
27 /* Specifies how a switch's VAR_VALUE relates to its FLAG_VAR. */
28 enum cl_var_type {
29 /* The switch is enabled when FLAG_VAR is nonzero. */
30 CLVC_BOOLEAN,
32 /* The switch is enabled when FLAG_VAR == VAR_VALUE. */
33 CLVC_EQUAL,
35 /* The switch is enabled when VAR_VALUE is not set in FLAG_VAR. */
36 CLVC_BIT_CLEAR,
38 /* The switch is enabled when VAR_VALUE is set in FLAG_VAR. */
39 CLVC_BIT_SET,
41 /* The switch takes a string argument and FLAG_VAR points to that
42 argument. */
43 CLVC_STRING,
45 /* The switch takes an enumerated argument (VAR_ENUM says what
46 enumeration) and FLAG_VAR points to that argument. */
47 CLVC_ENUM,
49 /* The switch should be stored in the VEC pointed to by FLAG_VAR for
50 later processing. */
51 CLVC_DEFER
54 struct cl_option
56 /* Text of the option, including initial '-'. */
57 const char *opt_text;
58 /* Help text for --help, or NULL. */
59 const char *help;
60 /* Error message for missing argument, or NULL. */
61 const char *missing_argument_error;
62 /* Warning to give when this option is used, or NULL. */
63 const char *warn_message;
64 /* Argument of alias target when positive option given, or NULL. */
65 const char *alias_arg;
66 /* Argument of alias target when negative option given, or NULL. */
67 const char *neg_alias_arg;
68 /* Alias target, or N_OPTS if not an alias. */
69 unsigned short alias_target;
70 /* Previous option that is an initial substring of this one, or
71 N_OPTS if none. */
72 unsigned short back_chain;
73 /* Option length, not including initial '-'. */
74 unsigned char opt_len;
75 /* Next option in a sequence marked with Negative, or -1 if none. */
76 int neg_index;
77 /* CL_* flags for this option. */
78 unsigned int flags;
79 /* Disabled in this configuration. */
80 BOOL_BITFIELD cl_disabled : 1;
81 /* Options marked with CL_SEPARATE take a number of separate
82 arguments (1 to 4) that is one more than the number in this
83 bit-field. */
84 unsigned int cl_separate_nargs : 2;
85 /* Option is an alias when used with separate argument. */
86 BOOL_BITFIELD cl_separate_alias : 1;
87 /* Alias to negative form of option. */
88 BOOL_BITFIELD cl_negative_alias : 1;
89 /* Option takes no argument in the driver. */
90 BOOL_BITFIELD cl_no_driver_arg : 1;
91 /* Reject this option in the driver. */
92 BOOL_BITFIELD cl_reject_driver : 1;
93 /* Reject no- form. */
94 BOOL_BITFIELD cl_reject_negative : 1;
95 /* Missing argument OK (joined). */
96 BOOL_BITFIELD cl_missing_ok : 1;
97 /* Argument is an integer >=0. */
98 BOOL_BITFIELD cl_uinteger : 1;
99 /* Argument is a HOST_WIDE_INT. */
100 BOOL_BITFIELD cl_host_wide_int : 1;
101 /* Argument should be converted to lowercase. */
102 BOOL_BITFIELD cl_tolower : 1;
103 /* Report argument with -fverbose-asm */
104 BOOL_BITFIELD cl_report : 1;
105 /* Offset of field for this option in struct gcc_options, or
106 (unsigned short) -1 if none. */
107 unsigned short flag_var_offset;
108 /* Index in cl_enums of enum used for this option's arguments, for
109 CLVC_ENUM options. */
110 unsigned short var_enum;
111 /* How this option's value is determined and sets a field. */
112 enum cl_var_type var_type;
113 /* Value or bit-mask with which to set a field. */
114 HOST_WIDE_INT var_value;
117 /* Records that the state of an option consists of SIZE bytes starting
118 at DATA. DATA might point to CH in some cases. */
119 struct cl_option_state {
120 const void *data;
121 size_t size;
122 char ch;
125 extern const struct cl_option cl_options[];
126 extern const unsigned int cl_options_count;
127 extern const char *const lang_names[];
128 extern const unsigned int cl_lang_count;
130 #define CL_PARAMS (1U << 16) /* Fake entry. Used to display --param info with --help. */
131 #define CL_WARNING (1U << 17) /* Enables an (optional) warning message. */
132 #define CL_OPTIMIZATION (1U << 18) /* Enables an (optional) optimization. */
133 #define CL_DRIVER (1U << 19) /* Driver option. */
134 #define CL_TARGET (1U << 20) /* Target-specific option. */
135 #define CL_COMMON (1U << 21) /* Language-independent. */
137 #define CL_MIN_OPTION_CLASS CL_PARAMS
138 #define CL_MAX_OPTION_CLASS CL_COMMON
140 /* From here on the bits describe attributes of the options.
141 Before this point the bits have described the class of the option.
142 This distinction is important because --help will not list options
143 which only have these higher bits set. */
145 #define CL_JOINED (1U << 22) /* If takes joined argument. */
146 #define CL_SEPARATE (1U << 23) /* If takes a separate argument. */
147 #define CL_UNDOCUMENTED (1U << 24) /* Do not output with --help. */
148 #define CL_NO_DWARF_RECORD (1U << 25) /* Do not add to producer string. */
149 #define CL_PCH_IGNORE (1U << 26) /* Do compare state for pch. */
151 /* Flags for an enumerated option argument. */
152 #define CL_ENUM_CANONICAL (1 << 0) /* Canonical for this value. */
153 #define CL_ENUM_DRIVER_ONLY (1 << 1) /* Only accepted in the driver. */
155 /* Structure describing an enumerated option argument. */
157 struct cl_enum_arg
159 /* The argument text, or NULL at the end of the array. */
160 const char *arg;
162 /* The corresponding integer value. */
163 int value;
165 /* Flags associated with this argument. */
166 unsigned int flags;
169 /* Structure describing an enumerated set of option arguments. */
171 struct cl_enum
173 /* Help text, or NULL if the values should not be listed in --help
174 output. */
175 const char *help;
177 /* Error message for unknown arguments, or NULL to use a generic
178 error. */
179 const char *unknown_error;
181 /* Array of possible values. */
182 const struct cl_enum_arg *values;
184 /* The size of the type used to store a value. */
185 size_t var_size;
187 /* Function to set a variable of this type. */
188 void (*set) (void *var, int value);
190 /* Function to get the value of a variable of this type. */
191 int (*get) (const void *var);
194 extern const struct cl_enum cl_enums[];
195 extern const unsigned int cl_enums_count;
197 /* Possible ways in which a command-line option may be erroneous.
198 These do not include not being known at all; an option index of
199 OPT_SPECIAL_unknown is used for that. */
201 #define CL_ERR_DISABLED (1 << 0) /* Disabled in this configuration. */
202 #define CL_ERR_MISSING_ARG (1 << 1) /* Argument required but missing. */
203 #define CL_ERR_WRONG_LANG (1 << 2) /* Option for wrong language. */
204 #define CL_ERR_UINT_ARG (1 << 3) /* Bad unsigned integer argument. */
205 #define CL_ERR_ENUM_ARG (1 << 4) /* Bad enumerated argument. */
206 #define CL_ERR_NEGATIVE (1 << 5) /* Negative form of option
207 not permitted (together
208 with OPT_SPECIAL_unknown). */
210 /* Structure describing the result of decoding an option. */
212 struct cl_decoded_option
214 /* The index of this option, or an OPT_SPECIAL_* value for
215 non-options and unknown options. */
216 size_t opt_index;
218 /* Any warning to give for use of this option, or NULL if none. */
219 const char *warn_message;
221 /* The string argument, or NULL if none. For OPT_SPECIAL_* cases,
222 the option or non-option command-line argument. */
223 const char *arg;
225 /* The original text of option plus arguments, with separate argv
226 elements concatenated into one string with spaces separating
227 them. This is for such uses as diagnostics and
228 -frecord-gcc-switches. */
229 const char *orig_option_with_args_text;
231 /* The canonical form of the option and its argument, for when it is
232 necessary to reconstruct argv elements (in particular, for
233 processing specs and passing options to subprocesses from the
234 driver). */
235 const char *canonical_option[4];
237 /* The number of elements in the canonical form of the option and
238 arguments; always at least 1. */
239 size_t canonical_option_num_elements;
241 /* For a boolean option, 1 for the true case and 0 for the "no-"
242 case. For an unsigned integer option, the value of the
243 argument. 1 in all other cases. */
244 int value;
246 /* Any flags describing errors detected in this option. */
247 int errors;
250 /* Structure describing an option deferred for handling after the main
251 option handlers. */
253 struct cl_deferred_option
255 /* Elements from struct cl_decoded_option used for deferred
256 options. */
257 size_t opt_index;
258 const char *arg;
259 int value;
262 /* Structure describing a single option-handling callback. */
264 struct cl_option_handler_func
266 /* The function called to handle the option. */
267 bool (*handler) (struct gcc_options *opts,
268 struct gcc_options *opts_set,
269 const struct cl_decoded_option *decoded,
270 unsigned int lang_mask, int kind, location_t loc,
271 const struct cl_option_handlers *handlers,
272 diagnostic_context *dc);
274 /* The mask that must have some bit in common with the flags for the
275 option for this particular handler to be used. */
276 unsigned int mask;
279 /* Structure describing the callbacks used in handling options. */
281 struct cl_option_handlers
283 /* Callback for an unknown option to determine whether to give an
284 error for it, and possibly store information to diagnose the
285 option at a later point. Return true if an error should be
286 given, false otherwise. */
287 bool (*unknown_option_callback) (const struct cl_decoded_option *decoded);
289 /* Callback to handle, and possibly diagnose, an option for another
290 language. */
291 void (*wrong_lang_callback) (const struct cl_decoded_option *decoded,
292 unsigned int lang_mask);
294 /* The number of individual handlers. */
295 size_t num_handlers;
297 /* The handlers themselves. */
298 struct cl_option_handler_func handlers[3];
301 /* Input file names. */
303 extern const char **in_fnames;
305 /* The count of input filenames. */
307 extern unsigned num_in_fnames;
309 extern char *opts_concat (const char *first, ...);
311 /* Obstack for option strings. */
313 extern struct obstack opts_obstack;
315 size_t find_opt (const char *input, unsigned int lang_mask);
316 extern int integral_argument (const char *arg);
317 extern bool enum_value_to_arg (const struct cl_enum_arg *enum_args,
318 const char **argp, int value,
319 unsigned int lang_mask);
320 extern void decode_cmdline_options_to_array (unsigned int argc,
321 const char **argv,
322 unsigned int lang_mask,
323 struct cl_decoded_option **decoded_options,
324 unsigned int *decoded_options_count);
325 extern void init_options_once (void);
326 extern void init_options_struct (struct gcc_options *opts,
327 struct gcc_options *opts_set);
328 extern void decode_cmdline_options_to_array_default_mask (unsigned int argc,
329 const char **argv,
330 struct cl_decoded_option **decoded_options,
331 unsigned int *decoded_options_count);
332 extern void set_default_handlers (struct cl_option_handlers *handlers);
333 extern void decode_options (struct gcc_options *opts,
334 struct gcc_options *opts_set,
335 struct cl_decoded_option *decoded_options,
336 unsigned int decoded_options_count,
337 location_t loc,
338 diagnostic_context *dc);
339 extern int option_enabled (int opt_idx, void *opts);
340 extern bool get_option_state (struct gcc_options *, int,
341 struct cl_option_state *);
342 extern void set_option (struct gcc_options *opts,
343 struct gcc_options *opts_set,
344 int opt_index, int value, const char *arg, int kind,
345 location_t loc, diagnostic_context *dc);
346 extern void *option_flag_var (int opt_index, struct gcc_options *opts);
347 bool handle_generated_option (struct gcc_options *opts,
348 struct gcc_options *opts_set,
349 size_t opt_index, const char *arg, int value,
350 unsigned int lang_mask, int kind, location_t loc,
351 const struct cl_option_handlers *handlers,
352 diagnostic_context *dc);
353 void generate_option (size_t opt_index, const char *arg, int value,
354 unsigned int lang_mask,
355 struct cl_decoded_option *decoded);
356 void generate_option_input_file (const char *file,
357 struct cl_decoded_option *decoded);
358 extern void read_cmdline_option (struct gcc_options *opts,
359 struct gcc_options *opts_set,
360 struct cl_decoded_option *decoded,
361 location_t loc,
362 unsigned int lang_mask,
363 const struct cl_option_handlers *handlers,
364 diagnostic_context *dc);
365 extern void control_warning_option (unsigned int opt_index, int kind,
366 bool imply, location_t loc,
367 unsigned int lang_mask,
368 const struct cl_option_handlers *handlers,
369 struct gcc_options *opts,
370 struct gcc_options *opts_set,
371 diagnostic_context *dc);
372 extern void print_ignored_options (void);
373 extern void handle_common_deferred_options (void);
374 extern bool common_handle_option (struct gcc_options *opts,
375 struct gcc_options *opts_set,
376 const struct cl_decoded_option *decoded,
377 unsigned int lang_mask, int kind,
378 location_t loc,
379 const struct cl_option_handlers *handlers,
380 diagnostic_context *dc);
381 extern bool target_handle_option (struct gcc_options *opts,
382 struct gcc_options *opts_set,
383 const struct cl_decoded_option *decoded,
384 unsigned int lang_mask, int kind,
385 location_t loc,
386 const struct cl_option_handlers *handlers,
387 diagnostic_context *dc);
388 extern void finish_options (struct gcc_options *opts,
389 struct gcc_options *opts_set,
390 location_t loc);
391 extern void default_options_optimization (struct gcc_options *opts,
392 struct gcc_options *opts_set,
393 struct cl_decoded_option *decoded_options,
394 unsigned int decoded_options_count,
395 location_t loc,
396 unsigned int lang_mask,
397 const struct cl_option_handlers *handlers,
398 diagnostic_context *dc);
399 extern void set_struct_debug_option (struct gcc_options *opts,
400 location_t loc,
401 const char *value);
402 extern bool opt_enum_arg_to_value (size_t opt_index, const char *arg,
403 int *value, unsigned int lang_mask);
404 #endif