[binutils.git] / include / ansidecl.h

/* ANSI and traditional C compatability macros
   Copyright 1991, 1992 Free Software Foundation, Inc.
   This file is part of the GNU C Library.

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.  */

/* ANSI and traditional C compatibility macros

   ANSI C is assumed if __STDC__ is #defined.

   Macro	ANSI C definition	Traditional C definition
   -----	---- - ----------	----------- - ----------
   PTR		`void *'		`char *'
   LONG_DOUBLE	`long double'		`double'
   CONST	`const'			`'
   VOLATILE	`volatile'		`'
   SIGNED	`signed'		`'
   PTRCONST	`void *const'		`char *'

   DEFUN (name, arglist, args)

	Defines function NAME.

	ARGLIST lists the arguments, separated by commas and enclosed in
	parentheses.  ARGLIST becomes the argument list in traditional C.

	ARGS list the arguments with their types.  It becomes a prototype in
	ANSI C, and the type declarations in traditional C.  Arguments should
	be separated with `AND'.  For functions with a variable number of
	arguments, the last thing listed should be `DOTS'.

   DEFUN_VOID (name)

	Defines a function NAME, which takes no arguments.

   obsolete --     EXFUN (name, (prototype))	-- obsolete.

	Replaced by PARAMS.  Do not use; will disappear someday soon.
	Was used in external function declarations.
	In ANSI C it is `NAME PROTOTYPE' (so PROTOTYPE should be enclosed in
	parentheses).  In traditional C it is `NAME()'.
	For a function that takes no arguments, PROTOTYPE should be `(void)'.

    PARAMS ((args))

	We could use the EXFUN macro to handle prototype declarations, but
	the name is misleading and the result is ugly.  So we just define a
	simple macro to handle the parameter lists, as in:

	      static int foo PARAMS ((int, char));

	This produces:  `static int foo();' or `static int foo (int, char);'

	EXFUN would have done it like this:

	      static int EXFUN (foo, (int, char));

	but the function is not external...and it's hard to visually parse
	the function name out of the mess.   EXFUN should be considered
	obsolete; new code should be written to use PARAMS.

    For example:
	extern int printf PARAMS ((CONST char *format DOTS));
	int DEFUN(fprintf, (stream, format),
		  FILE *stream AND CONST char *format DOTS) { ... }
	void DEFUN_VOID(abort) { ... }
*/

#ifndef	_ANSIDECL_H

#define	_ANSIDECL_H	1


/* Every source file includes this file,
   so they will all get the switch for lint.  */
/* LINTLIBRARY */


#if defined (__STDC__) || defined (_AIX)
/* the AIX xlc compiler implements all these things even when it is in
   a mode which doesn't define __STDC__.  */

#define	PTR		void *
#define	PTRCONST	void *CONST
#define	LONG_DOUBLE	long double

#define	AND		,
#define	NOARGS		void
#define	CONST		const
#define	VOLATILE	volatile
#define	SIGNED		signed
#define	DOTS		, ...

#define	EXFUN(name, proto)		name proto
#define	DEFUN(name, arglist, args)	name(args)
#define	DEFUN_VOID(name)		name(void)

#define PROTO(type, name, arglist)	type name arglist
#define PARAMS(paramlist)		paramlist

#else	/* Not ANSI C.  */

#define	PTR		char *
#define	PTRCONST	PTR
#define	LONG_DOUBLE	double

#define	AND		;
#define	NOARGS
#define	CONST
#define	VOLATILE
#define	SIGNED
#define	DOTS

#define	EXFUN(name, proto)		name()
#define	DEFUN(name, arglist, args)	name arglist args;
#define	DEFUN_VOID(name)		name()
#define PROTO(type, name, arglist) type name ()
#define PARAMS(paramlist)		()

#endif	/* ANSI C.  */

#endif	/* ansidecl.h	*/
Commit	Line	Data
ee7d7cd8	1	/* ANSI and traditional C compatability macros
01b4d318	2	Copyright 1991, 1992 Free Software Foundation, Inc.
ee7d7cd8 SC	3	This file is part of the GNU C Library.
	4
	5	This program is free software; you can redistribute it and/or modify
	6	it under the terms of the GNU General Public License as published by
	7	the Free Software Foundation; either version 2 of the License, or
	8	(at your option) any later version.
	9
	10	This program is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	GNU General Public License for more details.
	14
	15	You should have received a copy of the GNU General Public License
	16	along with this program; if not, write to the Free Software
	17	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
	18
	19	/* ANSI and traditional C compatibility macros
	20
	21	ANSI C is assumed if __STDC__ is #defined.
	22
	23	Macro ANSI C definition Traditional C definition
	24	----- ---- - ---------- ----------- - ----------
	25	PTR `void ' `char '
	26	LONG_DOUBLE `long double' `double'
	27	CONST `const' `'
	28	VOLATILE `volatile' `'
	29	SIGNED `signed' `'
	30	PTRCONST `void const' `char '
	31
01b4d318	32	DEFUN (name, arglist, args)
ee7d7cd8 SC	33
	34	Defines function NAME.
	35
	36	ARGLIST lists the arguments, separated by commas and enclosed in
	37	parentheses. ARGLIST becomes the argument list in traditional C.
	38
	39	ARGS list the arguments with their types. It becomes a prototype in
	40	ANSI C, and the type declarations in traditional C. Arguments should
	41	be separated with `AND'. For functions with a variable number of
	42	arguments, the last thing listed should be `DOTS'.
	43
01b4d318	44	DEFUN_VOID (name)
ee7d7cd8 SC	45
	46	Defines a function NAME, which takes no arguments.
	47
01b4d318	48	obsolete -- EXFUN (name, (prototype)) -- obsolete.
ee7d7cd8	49
01b4d318 JK	50	Replaced by PARAMS. Do not use; will disappear someday soon.
	51	Was used in external function declarations.
	52	In ANSI C it is `NAME PROTOTYPE' (so PROTOTYPE should be enclosed in
ee7d7cd8	53	parentheses). In traditional C it is `NAME()'.
01b4d318 JK	54	For a function that takes no arguments, PROTOTYPE should be `(void)'.
	55
	56	PARAMS ((args))
	57
	58	We could use the EXFUN macro to handle prototype declarations, but
	59	the name is misleading and the result is ugly. So we just define a
	60	simple macro to handle the parameter lists, as in:
	61
	62	static int foo PARAMS ((int, char));
	63
	64	This produces: `static int foo();' or `static int foo (int, char);'
	65
	66	EXFUN would have done it like this:
	67
	68	static int EXFUN (foo, (int, char));
	69
	70	but the function is not external...and it's hard to visually parse
	71	the function name out of the mess. EXFUN should be considered
	72	obsolete; new code should be written to use PARAMS.
ee7d7cd8 SC	73
ee7d7cd8 SC	74	For example:
01b4d318	75	extern int printf PARAMS ((CONST char *format DOTS));
ee7d7cd8 SC	76	int DEFUN(fprintf, (stream, format),
	77	FILE stream AND CONST char format DOTS) { ... }
	78	void DEFUN_VOID(abort) { ... }
	79	*/
	80
	81	#ifndef _ANSIDECL_H
	82
	83	#define _ANSIDECL_H 1
	84
	85
	86	/* Every source file includes this file,
	87	so they will all get the switch for lint. */
	88	/* LINTLIBRARY */
	89
	90
01b4d318 JK	91	#if defined (__STDC__) \|\| defined (_AIX)
	92	/* the AIX xlc compiler implements all these things even when it is in
	93	a mode which doesn't define __STDC__. */
ee7d7cd8 SC	94
	95	#define PTR void *
	96	#define PTRCONST void *CONST
	97	#define LONG_DOUBLE long double
	98
	99	#define AND ,
	100	#define NOARGS void
	101	#define CONST const
	102	#define VOLATILE volatile
	103	#define SIGNED signed
	104	#define DOTS , ...
	105
	106	#define EXFUN(name, proto) name proto
	107	#define DEFUN(name, arglist, args) name(args)
01b4d318	108	#define DEFUN_VOID(name) name(void)
ee7d7cd8	109
01b4d318 JK	110	#define PROTO(type, name, arglist) type name arglist
01b4d318 JK	111	#define PARAMS(paramlist) paramlist
ee7d7cd8 SC	112
	113	#else /* Not ANSI C. */
	114
	115	#define PTR char *
	116	#define PTRCONST PTR
	117	#define LONG_DOUBLE double
	118
	119	#define AND ;
	120	#define NOARGS
	121	#define CONST
	122	#define VOLATILE
	123	#define SIGNED
	124	#define DOTS
	125
	126	#define EXFUN(name, proto) name()
	127	#define DEFUN(name, arglist, args) name arglist args;
	128	#define DEFUN_VOID(name) name()
	129	#define PROTO(type, name, arglist) type name ()
01b4d318	130	#define PARAMS(paramlist) ()
ee7d7cd8	131
01b4d318	132	#endif /* ANSI C. */
ee7d7cd8 SC	133
ee7d7cd8 SC	134	#endif /* ansidecl.h */