[binutils.git] / gdb / language.h

/* Source-language-related definitions for GDB.
   Copyright 1991, 1992 Free Software Foundation, Inc.
   Contributed by the Department of Computer Science at the State University
   of New York at Buffalo.

This file is part of GDB.

This program 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 2 of the License, or
(at your option) any later version.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */

#if !defined (LANGUAGE_H)
#define LANGUAGE_H 1

#ifdef __STDC__		/* Forward decls for prototypes */
struct value;
/* enum exp_opcode;	ANSI's `wisdom' didn't include forward enum decls. */
#endif

/* This used to be included to configure GDB for one or more specific
   languages.  Now it is shortcutted to configure for all of them.  FIXME.  */
/* #include "lang_def.h" */
#define	_LANG_c
#define	_LANG_m2

/* range_mode ==
   range_mode_auto:   range_check set automatically to default of language.
   range_mode_manual: range_check set manually by user.  */

extern enum range_mode {range_mode_auto, range_mode_manual} range_mode;

/* range_check ==
   range_check_on:    Ranges are checked in GDB expressions, producing errors.
   range_check_warn:  Ranges are checked, producing warnings.
   range_check_off:   Ranges are not checked in GDB expressions.  */

extern enum range_check
  {range_check_off, range_check_warn, range_check_on} range_check;

/* type_mode ==
   type_mode_auto:   type_check set automatically to default of language
   type_mode_manual: type_check set manually by user. */

extern enum type_mode {type_mode_auto, type_mode_manual} type_mode;

/* type_check ==
   type_check_on:    Types are checked in GDB expressions, producing errors.
   type_check_warn:  Types are checked, producing warnings.
   type_check_off:   Types are not checked in GDB expressions.  */

extern enum type_check
  {type_check_off, type_check_warn, type_check_on} type_check;
\f
/* Structure tying together assorted information about a language.  */

struct language_defn {
  char *	   la_name;		/* Name of the language */
  enum language    la_language;		/* its symtab language-enum (defs.h) */
  struct type ** const
		  *la_builtin_type_vector;  /* Its builtin types */
  enum range_check la_range_check;	/* Default range checking */
  enum type_check  la_type_check;	/* Default type checking */
  int            (*la_parser) PARAMS((void));	/* Parser function */
  void           (*la_error) PARAMS ((char *)); /* Parser error function */
  struct type	 **la_longest_int;	/* Longest signed integral type */
  struct type	 **la_longest_unsigned_int; /* Longest uns integral type */
  struct type	 **la_longest_float;	/* Longest floating point type */
  char		  *la_hex_format;	/* Hexadecimal printf format str */
  char		  *la_hex_format_pre;	/* Prefix for custom format string */
  char		  *la_hex_format_suf;	/* Suffix for custom format string */
  char		  *la_octal_format;	/* Octal printf format str */
  char		  *la_octal_format_pre;	/* Prefix for custom format string */
  char		  *la_octal_format_suf;	/* Suffix for custom format string */
const struct op_print
		  *la_op_print_tab;	/* Table for printing expressions */
/* Add fields above this point, so the magic number is always last. */
  long 		   la_magic;		/* Magic number for compat checking */
};

#define LANG_MAGIC	910823L

/* Pointer to the language_defn for our current language.  This pointer
   always points to *some* valid struct; it can be used without checking
   it for validity.  */

extern const struct language_defn *current_language;

/* Pointer to the language_defn expected by the user, e.g. the language
   of main(), or the language we last mentioned in a message, or C.  */

extern const struct language_defn *expected_language;

/* language_mode == 
   language_mode_auto:   current_language automatically set upon selection
			 of scope (e.g. stack frame)
   language_mode_manual: current_language set only by user.  */

extern enum language_mode
  {language_mode_auto, language_mode_manual} language_mode;
\f
/* These macros define the behaviour of the expression 
   evaluator.  */

/* Should we strictly type check expressions? */
#define STRICT_TYPE (type_check != type_check_off)

/* Should we range check values against the domain of their type? */
#define RANGE_CHECK (range_check != range_check_off)

/* "cast" really means conversion */
/* FIXME -- should be a setting in language_defn */
#define CAST_IS_CONVERSION (current_language->la_language == language_c)

extern void
language_info PARAMS ((int));

extern void
set_language PARAMS ((enum language));

\f
/* This page contains functions that return things that are
   specific to languages.  Each of these functions is based on
   the current setting of working_lang, which the user sets
   with the "set language" command. */

/* Returns some built-in types */
#define	longest_int()		(*current_language->la_longest_int)
#define	longest_unsigned_int()	(*current_language->la_longest_unsigned_int)
#define	longest_float()		(*current_language->la_longest_float)

/* Hexadecimal number formatting is in defs.h because it is so common
   throughout GDB.  */

/* Return a format string for printf that will print a number in the local
   (language-specific) octal format.  Result is static and is
   overwritten by the next call.  local_octal_format_custom takes printf
   options like "08" or "l" (to produce e.g. %08x or %lx).  */

#define local_octal_format() (current_language->la_octal_format)

extern char *
local_octal_format_custom PARAMS ((char *));

/* Type predicates */

extern int
simple_type PARAMS ((struct type *));

extern int
ordered_type PARAMS ((struct type *));

extern int
same_type PARAMS ((struct type *, struct type *));

extern int
integral_type PARAMS ((struct type *));

extern int
numeric_type PARAMS ((struct type *));

extern int
character_type PARAMS ((struct type *));

extern int
boolean_type PARAMS ((struct type *));

extern int
float_type PARAMS ((struct type *));

extern int
pointer_type PARAMS ((struct type *));

extern int
structured_type PARAMS ((struct type *));

/* Checks Binary and Unary operations for semantic type correctness */
/* FIXME:  Does not appear to be used */
#define unop_type_check(v,o) binop_type_check((v),NULL,(o))

extern void
binop_type_check PARAMS ((struct value *, struct value *, int));

/* Error messages */

extern void
op_error PARAMS ((char *fmt, enum exp_opcode, int));

#define type_op_error(f,o) \
   op_error((f),(o),type_check==type_check_on ? 1 : 0)
#define range_op_error(f,o) \
   op_error((f),(o),range_check==range_check_on ? 1 : 0)

extern void
type_error ();

void
range_error ();

/* Data:  Does this value represent "truth" to the current language?  */

extern int
value_true PARAMS ((struct value *));

/* Misc:  The string representing a particular enum language.  */

extern char *
language_str PARAMS ((enum language));

/* Add a language to the set known by GDB (at initialization time).  */

extern void
add_language PARAMS ((const struct language_defn *));

extern enum language
get_frame_language PARAMS ((void));		/* In stack.c */

#endif	/* defined (LANGUAGE_H) */
Commit	Line	Data
c8023e66	1	/* Source-language-related definitions for GDB.
75af490b	2	Copyright 1991, 1992 Free Software Foundation, Inc.
c8023e66 JG	3	Contributed by the Department of Computer Science at the State University
	4	of New York at Buffalo.
	5
	6	This file is part of GDB.
	7
	8	This program is free software; you can redistribute it and/or modify
	9	it under the terms of the GNU General Public License as published by
	10	the Free Software Foundation; either version 2 of the License, or
	11	(at your option) any later version.
	12
	13	This program is distributed in the hope that it will be useful,
	14	but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	GNU General Public License for more details.
	17
	18	You should have received a copy of the GNU General Public License
	19	along with this program; if not, write to the Free Software
	20	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
	21
75af490b JG	22	#if !defined (LANGUAGE_H)
	23	#define LANGUAGE_H 1
	24
f9e3b3cc	25	#ifdef __STDC__ /* Forward decls for prototypes */
75af490b	26	struct value;
f9e3b3cc	27	/* enum exp_opcode; ANSI's `wisdom' didn't include forward enum decls. */
75af490b JG	28	#endif
75af490b JG	29
c8023e66 JG	30	/* This used to be included to configure GDB for one or more specific
	31	languages. Now it is shortcutted to configure for all of them. FIXME. */
	32	/* #include "lang_def.h" */
	33	#define _LANG_c
	34	#define _LANG_m2
	35
	36	/* range_mode ==
	37	range_mode_auto: range_check set automatically to default of language.
	38	range_mode_manual: range_check set manually by user. */
	39
	40	extern enum range_mode {range_mode_auto, range_mode_manual} range_mode;
	41
	42	/* range_check ==
	43	range_check_on: Ranges are checked in GDB expressions, producing errors.
	44	range_check_warn: Ranges are checked, producing warnings.
	45	range_check_off: Ranges are not checked in GDB expressions. */
	46
	47	extern enum range_check
	48	{range_check_off, range_check_warn, range_check_on} range_check;
	49
	50	/* type_mode ==
	51	type_mode_auto: type_check set automatically to default of language
	52	type_mode_manual: type_check set manually by user. */
	53
	54	extern enum type_mode {type_mode_auto, type_mode_manual} type_mode;
	55
	56	/* type_check ==
	57	type_check_on: Types are checked in GDB expressions, producing errors.
	58	type_check_warn: Types are checked, producing warnings.
	59	type_check_off: Types are not checked in GDB expressions. */
	60
	61	extern enum type_check
	62	{type_check_off, type_check_warn, type_check_on} type_check;
	63	\f
	64	/* Structure tying together assorted information about a language. */
	65
	66	struct language_defn {
	67	char * la_name; /* Name of the language */
	68	enum language la_language; /* its symtab language-enum (defs.h) */
	69	struct type ** const
	70	la_builtin_type_vector; / Its builtin types */
	71	enum range_check la_range_check; /* Default range checking */
	72	enum type_check la_type_check; /* Default type checking */
75af490b JG	73	int (la_parser) PARAMS((void)); / Parser function */
75af490b JG	74	void (la_error) PARAMS ((char )); /* Parser error function */
c8023e66 JG	75	struct type *la_longest_int; / Longest signed integral type */
	76	struct type *la_longest_unsigned_int; / Longest uns integral type */
	77	struct type *la_longest_float; / Longest floating point type */
	78	char la_hex_format; / Hexadecimal printf format str */
	79	char la_hex_format_pre; / Prefix for custom format string */
	80	char la_hex_format_suf; / Suffix for custom format string */
	81	char la_octal_format; / Octal printf format str */
	82	char la_octal_format_pre; / Prefix for custom format string */
	83	char la_octal_format_suf; / Suffix for custom format string */
	84	const struct op_print
	85	la_op_print_tab; / Table for printing expressions */
	86	/* Add fields above this point, so the magic number is always last. */
	87	long la_magic; /* Magic number for compat checking */
	88	};
	89
	90	#define LANG_MAGIC 910823L
	91
	92	/* Pointer to the language_defn for our current language. This pointer
	93	always points to some valid struct; it can be used without checking
	94	it for validity. */
	95
0c6efbcc	96	extern const struct language_defn *current_language;
c8023e66	97
b5af69c3 JG	98	/* Pointer to the language_defn expected by the user, e.g. the language
	99	of main(), or the language we last mentioned in a message, or C. */
	100
	101	extern const struct language_defn *expected_language;
	102
c8023e66 JG	103	/* language_mode ==
	104	language_mode_auto: current_language automatically set upon selection
	105	of scope (e.g. stack frame)
	106	language_mode_manual: current_language set only by user. */
	107
	108	extern enum language_mode
	109	{language_mode_auto, language_mode_manual} language_mode;
	110	\f
	111	/* These macros define the behaviour of the expression
	112	evaluator. */
	113
	114	/* Should we strictly type check expressions? */
1a5a8f2a	115	#define STRICT_TYPE (type_check != type_check_off)
c8023e66 JG	116
c8023e66 JG	117	/* Should we range check values against the domain of their type? */
1a5a8f2a	118	#define RANGE_CHECK (range_check != range_check_off)
c8023e66 JG	119
	120	/* "cast" really means conversion */
	121	/* FIXME -- should be a setting in language_defn */
	122	#define CAST_IS_CONVERSION (current_language->la_language == language_c)
	123
75af490b JG	124	extern void
	125	language_info PARAMS ((int));
	126
	127	extern void
	128	set_language PARAMS ((enum language));
	129
c8023e66 JG	130	\f
	131	/* This page contains functions that return things that are
	132	specific to languages. Each of these functions is based on
	133	the current setting of working_lang, which the user sets
	134	with the "set language" command. */
	135
	136	/* Returns some built-in types */
	137	#define longest_int() (*current_language->la_longest_int)
	138	#define longest_unsigned_int() (*current_language->la_longest_unsigned_int)
	139	#define longest_float() (*current_language->la_longest_float)
c8023e66 JG	140
	141	/* Hexadecimal number formatting is in defs.h because it is so common
	142	throughout GDB. */
	143
	144	/* Return a format string for printf that will print a number in the local
	145	(language-specific) octal format. Result is static and is
	146	overwritten by the next call. local_octal_format_custom takes printf
	147	options like "08" or "l" (to produce e.g. %08x or %lx). */
	148
	149	#define local_octal_format() (current_language->la_octal_format)
75af490b JG	150
	151	extern char *
	152	local_octal_format_custom PARAMS ((char *));
c8023e66 JG	153
c8023e66 JG	154	/* Type predicates */
75af490b JG	155
	156	extern int
	157	simple_type PARAMS ((struct type *));
	158
	159	extern int
	160	ordered_type PARAMS ((struct type *));
	161
	162	extern int
	163	same_type PARAMS ((struct type , struct type ));
	164
	165	extern int
	166	integral_type PARAMS ((struct type *));
	167
	168	extern int
	169	numeric_type PARAMS ((struct type *));
	170
	171	extern int
	172	character_type PARAMS ((struct type *));
	173
	174	extern int
	175	boolean_type PARAMS ((struct type *));
	176
	177	extern int
	178	float_type PARAMS ((struct type *));
	179
	180	extern int
	181	pointer_type PARAMS ((struct type *));
	182
	183	extern int
	184	structured_type PARAMS ((struct type *));
c8023e66 JG	185
c8023e66 JG	186	/* Checks Binary and Unary operations for semantic type correctness */
75af490b	187	/* FIXME: Does not appear to be used */
c8023e66 JG	188	#define unop_type_check(v,o) binop_type_check((v),NULL,(o))
c8023e66 JG	189
75af490b JG	190	extern void
	191	binop_type_check PARAMS ((struct value , struct value , int));
	192
c8023e66	193	/* Error messages */
75af490b JG	194
	195	extern void
	196	op_error PARAMS ((char *fmt, enum exp_opcode, int));
	197
c8023e66 JG	198	#define type_op_error(f,o) \
	199	op_error((f),(o),type_check==type_check_on ? 1 : 0)
	200	#define range_op_error(f,o) \
	201	op_error((f),(o),range_check==range_check_on ? 1 : 0)
75af490b JG	202
	203	extern void
	204	type_error ();
	205
	206	void
	207	range_error ();
c8023e66 JG	208
c8023e66 JG	209	/* Data: Does this value represent "truth" to the current language? */
75af490b JG	210
	211	extern int
	212	value_true PARAMS ((struct value *));
c8023e66 JG	213
c8023e66 JG	214	/* Misc: The string representing a particular enum language. */
75af490b JG	215
	216	extern char *
	217	language_str PARAMS ((enum language));
c8023e66 JG	218
c8023e66 JG	219	/* Add a language to the set known by GDB (at initialization time). */
d8ce1326	220
75af490b JG	221	extern void
	222	add_language PARAMS ((const struct language_defn *));
	223
	224	extern enum language
	225	get_frame_language PARAMS ((void)); /* In stack.c */
	226
	227	#endif /* defined (LANGUAGE_H) */