[thirdparty/gcc.git] / gcc / opts.h

/* Command line option handling.
   Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010
   Free Software Foundation, Inc.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.  */

#ifndef GCC_OPTS_H
#define GCC_OPTS_H

/* Specifies how a switch's VAR_VALUE relates to its FLAG_VAR.  */
enum cl_var_type {
  /* The switch is enabled when FLAG_VAR is nonzero.  */
  CLVC_BOOLEAN,

  /* The switch is enabled when FLAG_VAR == VAR_VALUE.  */
  CLVC_EQUAL,

  /* The switch is enabled when VAR_VALUE is not set in FLAG_VAR.  */
  CLVC_BIT_CLEAR,

  /* The switch is enabled when VAR_VALUE is set in FLAG_VAR.  */
  CLVC_BIT_SET,

  /* The switch takes a string argument and FLAG_VAR points to that
     argument.  */
  CLVC_STRING
};

struct cl_option
{
  const char *opt_text;
  const char *help;
  const char *missing_argument_error;
  unsigned short back_chain;
  unsigned char opt_len;
  int neg_index;
  unsigned int flags;
  void *flag_var;
  enum cl_var_type var_type;
  int var_value;
};

/* Records that the state of an option consists of SIZE bytes starting
   at DATA.  DATA might point to CH in some cases.  */
struct cl_option_state {
  const void *data;
  size_t size;
  char ch;
};

extern const struct cl_option cl_options[];
extern const unsigned int cl_options_count;
extern const char *const lang_names[];
extern const unsigned int cl_lang_count;

#define CL_PARAMS               (1 << 17) /* Fake entry.  Used to display --param info with --help.  */
#define CL_WARNING		(1 << 18) /* Enables an (optional) warning message.  */
#define CL_OPTIMIZATION		(1 << 19) /* Enables an (optional) optimization.  */
#define CL_TARGET		(1 << 20) /* Target-specific option.  */
#define CL_COMMON		(1 << 21) /* Language-independent.  */

#define CL_MIN_OPTION_CLASS	CL_PARAMS
#define CL_MAX_OPTION_CLASS	CL_COMMON

/* From here on the bits describe attributes of the options.
   Before this point the bits have described the class of the option.
   This distinction is important because --help will not list options
   which only have these higher bits set.  */

#define CL_SAVE			(1 << 22) /* Target-specific option for attribute.  */
#define CL_DISABLED		(1 << 23) /* Disabled in this configuration.  */
#define CL_REPORT		(1 << 24) /* Report argument with -fverbose-asm  */
#define CL_JOINED		(1 << 25) /* If takes joined argument.  */
#define CL_SEPARATE		(1 << 26) /* If takes a separate argument.  */
#define CL_REJECT_NEGATIVE	(1 << 27) /* Reject no- form.  */
#define CL_MISSING_OK		(1 << 28) /* Missing argument OK (joined).  */
#define CL_UINTEGER		(1 << 29) /* Argument is an integer >=0.  */
#define CL_UNDOCUMENTED		(1 << 30) /* Do not output with --help.  */

/* Possible ways in which a command-line option may be erroneous.
   These do not include not being known at all; an option index of
   OPT_SPECIAL_unknown is used for that.  */

#define CL_ERR_DISABLED		(1 << 0) /* Disabled in this configuration.  */
#define CL_ERR_MISSING_ARG	(1 << 1) /* Argument required but missing.  */
#define CL_ERR_WRONG_LANG	(1 << 2) /* Option for wrong language.  */
#define CL_ERR_UINT_ARG		(1 << 3) /* Bad unsigned integer argument.  */

/* Structure describing the result of decoding an option.  */

struct cl_decoded_option
{
  /* The index of this option, or an OPT_SPECIAL_* value for
     non-options and unknown options.  */
  size_t opt_index;

  /* The string argument, or NULL if none.  For OPT_SPECIAL_* cases,
     the option or non-option command-line argument.  */
  const char *arg;

  /* The original text of option plus arguments, with separate argv
     elements concatenated into one string with spaces separating
     them.  This is for such uses as diagnostics and
     -frecord-gcc-switches.  */
  const char *orig_option_with_args_text;

  /* The canonical form of the option and its argument, for when it is
     necessary to reconstruct argv elements (in particular, for
     processing specs and passing options to subprocesses from the
     driver).  The first element of this array is non-NULL; the second
     is NULL if the canonical form uses only one argv element,
     non-NULL otherwise.  */
  const char *canonical_option[2];

  /* For a boolean option, 1 for the true case and 0 for the "no-"
     case.  For an unsigned integer option, the value of the
     argument.  1 in all other cases.  */
  int value;

  /* Any flags describing errors detected in this option.  */
  int errors;
};

/* Structure describing a single option-handling callback.  */

struct cl_option_handler_func
{
  /* The function called to handle the option.  */
  bool (*handler) (size_t opt_index, const char *arg, int value,
		   unsigned int lang_mask, int kind,
		   const struct cl_option_handlers *handlers);

  /* The mask that must have some bit in common with the flags for the
     option for this particular handler to be used.  */
  unsigned int mask;
};

/* Structure describing the callbacks used in handling options.  */

struct cl_option_handlers
{
  /* Callback for an unknown option to determine whether to give an
     error for it, and possibly store information to diagnose the
     option at a later point.  Return true if an error should be
     given, false otherwise.  */
  bool (*unknown_option_callback) (const char *opt);

  /* Callback to handle, and possibly diagnose, an option for another
     language.  */
  void (*wrong_lang_callback) (const char *text,
			       const struct cl_option *option,
			       unsigned int lang_mask);

  /* Callback to call after the successful handling of any option.  */
  void (*post_handling_callback) (size_t opt_index, const char *arg,
				  int value, unsigned int mask);

  /* The number of individual handlers.  */
  size_t num_handlers;

  /* The handlers themselves.  */
  struct cl_option_handler_func handlers[3];
};

/* Input file names.  */

extern const char **in_fnames;

/* The count of input filenames.  */

extern unsigned num_in_fnames;

size_t find_opt (const char *input, int lang_mask);
extern int integral_argument (const char *arg);
extern void decode_cmdline_options_to_array (unsigned int argc,
					     const char **argv, 
					     unsigned int lang_mask,
					     struct cl_decoded_option **decoded_options,
					     unsigned int *decoded_options_count);
extern void prune_options (int *argcp, char ***argvp);
extern void decode_options (unsigned int argc, const char **argv,
			    struct cl_decoded_option **decoded_options,
			    unsigned int *decoded_options_count);
extern int option_enabled (int opt_idx);
extern bool get_option_state (int, struct cl_option_state *);
extern void set_option (int opt_index, int value, const char *arg, int);
bool handle_option (size_t opt_index, const char *arg, int value,
		    unsigned int lang_mask, int kind,
		    const struct cl_option_handlers *handlers);
extern void read_cmdline_option (struct cl_decoded_option *decoded,
				 unsigned int lang_mask,
				 const struct cl_option_handlers *handlers);
extern void register_warning_as_error_callback (void (*callback) (int));
extern void enable_warning_as_error (const char *arg, int value,
				     unsigned int lang_mask,
				     const struct cl_option_handlers *handlers);
extern void print_ignored_options (void);
#endif
Commit	Line	Data
5457b645	1	/* Command line option handling.
06907f25	2	Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010
cfaf579d	3	Free Software Foundation, Inc.
5457b645	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
8c4c00c1	9	Software Foundation; either version 3, or (at your option) any later
5457b645	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
8c4c00c1	18	along with GCC; see the file COPYING3. If not see
8c4c00c1	19	<http://www.gnu.org/licenses/>. */
5457b645	20
	21	#ifndef GCC_OPTS_H
	22	#define GCC_OPTS_H
	23
ff05e09e	24	/* Specifies how a switch's VAR_VALUE relates to its FLAG_VAR. */
0fe44c73	25	enum cl_var_type {
ff05e09e	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. */
0fe44c73	36	CLVC_BIT_SET,
	37
	38	/* The switch takes a string argument and FLAG_VAR points to that
	39	argument. */
	40	CLVC_STRING
ff05e09e	41	};
5457b645	42
55da3817	43	struct cl_option
	44	{
	45	const char *opt_text;
53b8e5c1	46	const char *help;
fecf9011	47	const char *missing_argument_error;
6b1f09ff	48	unsigned short back_chain;
55da3817	49	unsigned char opt_len;
a1baa5f1	50	int neg_index;
3272db82	51	unsigned int flags;
0fe44c73	52	void *flag_var;
0fe44c73	53	enum cl_var_type var_type;
ff05e09e	54	int var_value;
55da3817	55	};
55da3817	56
7abcc497	57	/* Records that the state of an option consists of SIZE bytes starting
	58	at DATA. DATA might point to CH in some cases. */
	59	struct cl_option_state {
	60	const void *data;
	61	size_t size;
	62	char ch;
	63	};
	64
55da3817	65	extern const struct cl_option cl_options[];
55da3817	66	extern const unsigned int cl_options_count;
9cf6679e	67	extern const char *const lang_names[];
87c75316	68	extern const unsigned int cl_lang_count;
55da3817	69
151ef6b4	70	#define CL_PARAMS (1 << 17) /* Fake entry. Used to display --param info with --help. */
	71	#define CL_WARNING (1 << 18) /* Enables an (optional) warning message. */
	72	#define CL_OPTIMIZATION (1 << 19) /* Enables an (optional) optimization. */
	73	#define CL_TARGET (1 << 20) /* Target-specific option. */
	74	#define CL_COMMON (1 << 21) /* Language-independent. */
	75
	76	#define CL_MIN_OPTION_CLASS CL_PARAMS
87c75316	77	#define CL_MAX_OPTION_CLASS CL_COMMON
	78
	79	/* From here on the bits describe attributes of the options.
	80	Before this point the bits have described the class of the option.
	81	This distinction is important because --help will not list options
	82	which only have these higher bits set. */
	83
151ef6b4	84	#define CL_SAVE (1 << 22) /* Target-specific option for attribute. */
87c75316	85	#define CL_DISABLED (1 << 23) /* Disabled in this configuration. */
	86	#define CL_REPORT (1 << 24) /* Report argument with -fverbose-asm */
	87	#define CL_JOINED (1 << 25) /* If takes joined argument. */
	88	#define CL_SEPARATE (1 << 26) /* If takes a separate argument. */
	89	#define CL_REJECT_NEGATIVE (1 << 27) /* Reject no- form. */
	90	#define CL_MISSING_OK (1 << 28) /* Missing argument OK (joined). */
	91	#define CL_UINTEGER (1 << 29) /* Argument is an integer >=0. */
976650bc	92	#define CL_UNDOCUMENTED (1 << 30) /* Do not output with --help. */
5457b645	93
06907f25	94	/* Possible ways in which a command-line option may be erroneous.
06907f25	95	These do not include not being known at all; an option index of
615ef0bb	96	OPT_SPECIAL_unknown is used for that. */
06907f25	97
	98	#define CL_ERR_DISABLED (1 << 0) /* Disabled in this configuration. */
	99	#define CL_ERR_MISSING_ARG (1 << 1) /* Argument required but missing. */
	100	#define CL_ERR_WRONG_LANG (1 << 2) /* Option for wrong language. */
	101	#define CL_ERR_UINT_ARG (1 << 3) /* Bad unsigned integer argument. */
	102
	103	/* Structure describing the result of decoding an option. */
	104
	105	struct cl_decoded_option
	106	{
615ef0bb	107	/* The index of this option, or an OPT_SPECIAL_* value for
615ef0bb	108	non-options and unknown options. */
06907f25	109	size_t opt_index;
06907f25	110
615ef0bb	111	/* The string argument, or NULL if none. For OPT_SPECIAL_* cases,
615ef0bb	112	the option or non-option command-line argument. */
06907f25	113	const char *arg;
06907f25	114
615ef0bb	115	/* The original text of option plus arguments, with separate argv
	116	elements concatenated into one string with spaces separating
	117	them. This is for such uses as diagnostics and
	118	-frecord-gcc-switches. */
	119	const char *orig_option_with_args_text;
	120
e88d34f6	121	/* The canonical form of the option and its argument, for when it is
	122	necessary to reconstruct argv elements (in particular, for
	123	processing specs and passing options to subprocesses from the
	124	driver). The first element of this array is non-NULL; the second
	125	is NULL if the canonical form uses only one argv element,
	126	non-NULL otherwise. */
	127	const char *canonical_option[2];
	128
06907f25	129	/* For a boolean option, 1 for the true case and 0 for the "no-"
	130	case. For an unsigned integer option, the value of the
	131	argument. 1 in all other cases. */
	132	int value;
	133
	134	/* Any flags describing errors detected in this option. */
	135	int errors;
	136	};
	137
b78351e5	138	/* Structure describing a single option-handling callback. */
	139
	140	struct cl_option_handler_func
	141	{
	142	/* The function called to handle the option. */
	143	bool (handler) (size_t opt_index, const char arg, int value,
	144	unsigned int lang_mask, int kind,
	145	const struct cl_option_handlers *handlers);
	146
	147	/* The mask that must have some bit in common with the flags for the
	148	option for this particular handler to be used. */
	149	unsigned int mask;
	150	};
	151
	152	/* Structure describing the callbacks used in handling options. */
	153
	154	struct cl_option_handlers
	155	{
	156	/* Callback for an unknown option to determine whether to give an
	157	error for it, and possibly store information to diagnose the
	158	option at a later point. Return true if an error should be
	159	given, false otherwise. */
	160	bool (unknown_option_callback) (const char opt);
	161
	162	/* Callback to handle, and possibly diagnose, an option for another
	163	language. */
	164	void (wrong_lang_callback) (const char text,
	165	const struct cl_option *option,
	166	unsigned int lang_mask);
	167
	168	/* Callback to call after the successful handling of any option. */
	169	void (post_handling_callback) (size_t opt_index, const char arg,
	170	int value, unsigned int mask);
	171
	172	/* The number of individual handlers. */
	173	size_t num_handlers;
	174
	175	/* The handlers themselves. */
	176	struct cl_option_handler_func handlers[3];
	177	};
	178
7981458e	179	/* Input file names. */
dcfa26d9	180
	181	extern const char **in_fnames;
	182
7981458e	183	/* The count of input filenames. */
dcfa26d9	184
	185	extern unsigned num_in_fnames;
	186
a1baa5f1	187	size_t find_opt (const char *input, int lang_mask);
06907f25	188	extern int integral_argument (const char *arg);
615ef0bb	189	extern void decode_cmdline_options_to_array (unsigned int argc,
	190	const char **argv,
	191	unsigned int lang_mask,
	192	struct cl_decoded_option **decoded_options,
	193	unsigned int *decoded_options_count);
a1baa5f1	194	extern void prune_options (int argcp, char **argvp);
615ef0bb	195	extern void decode_options (unsigned int argc, const char **argv,
	196	struct cl_decoded_option **decoded_options,
	197	unsigned int *decoded_options_count);
efb9d9ee	198	extern int option_enabled (int opt_idx);
7abcc497	199	extern bool get_option_state (int, struct cl_option_state *);
1f3db819	200	extern void set_option (int opt_index, int value, const char *arg, int);
b78351e5	201	bool handle_option (size_t opt_index, const char *arg, int value,
	202	unsigned int lang_mask, int kind,
	203	const struct cl_option_handlers *handlers);
	204	extern void read_cmdline_option (struct cl_decoded_option *decoded,
	205	unsigned int lang_mask,
	206	const struct cl_option_handlers *handlers);
3a79f5da	207	extern void register_warning_as_error_callback (void (*callback) (int));
3ba510aa	208	extern void enable_warning_as_error (const char *arg, int value,
b78351e5	209	unsigned int lang_mask,
b78351e5	210	const struct cl_option_handlers *handlers);
ddb48b82	211	extern void print_ignored_options (void);
5457b645	212	#endif