[apple/xnu.git] / bsd / sys / cdefs.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/* Copyright 1995 NeXT Computer, Inc. All rights reserved. */
/*
 * Copyright (c) 1991, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Berkeley Software Design, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)cdefs.h	8.8 (Berkeley) 1/9/95
 */

#ifndef	_CDEFS_H_
#define	_CDEFS_H_

#if defined(__cplusplus)
#define	__BEGIN_DECLS	extern "C" {
#define	__END_DECLS	}
#else
#define	__BEGIN_DECLS
#define	__END_DECLS
#endif

/*
 * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
 * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
 * The __CONCAT macro is a bit tricky -- make sure you don't put spaces
 * in between its arguments.  __CONCAT can also concatenate double-quoted
 * strings produced by the __STRING macro, but this only works with ANSI C.
 */
#if defined(__STDC__) || defined(__cplusplus)
#define	__P(protos)	protos		/* full-blown ANSI C */
#define	__CONCAT(x,y)	x ## y
#define	__STRING(x)	#x

#define	__const		const		/* define reserved names to standard */
#define	__signed	signed
#define	__volatile	volatile
#if defined(__cplusplus)
#define	__inline	inline		/* convert to C++ keyword */
#else
#ifndef __GNUC__
#define	__inline			/* delete GCC keyword */
#endif /* !__GNUC__ */
#endif /* !__cplusplus */

#else	/* !(__STDC__ || __cplusplus) */
#define	__P(protos)	()		/* traditional C preprocessor */
#define	__CONCAT(x,y)	x/**/y
#define	__STRING(x)	"x"

#ifndef __GNUC__
#define	__const				/* delete pseudo-ANSI C keywords */
#define	__inline
#define	__signed
#define	__volatile
#endif	/* !__GNUC__ */

/*
 * In non-ANSI C environments, new programs will want ANSI-only C keywords
 * deleted from the program and old programs will want them left alone.
 * When using a compiler other than gcc, programs using the ANSI C keywords
 * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
 * When using "gcc -traditional", we assume that this is the intent; if
 * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
 */
#ifndef	NO_ANSI_KEYWORDS
#define	const		__const			/* convert ANSI C keywords */
#define	inline		__inline
#define	signed		__signed
#define	volatile	__volatile
#endif /* !NO_ANSI_KEYWORDS */
#endif /* !(__STDC__ || __cplusplus) */

/*
 * GCC1 and some versions of GCC2 declare dead (non-returning) and
 * pure (no side effects) functions using "volatile" and "const";
 * unfortunately, these then cause warnings under "-ansi -pedantic".
 * GCC2 uses a new, peculiar __attribute__((attrs)) style.  All of
 * these work for GNU C++ (modulo a slight glitch in the C++ grammar
 * in the distribution version of 2.5.5).
 */
#if defined(__MWERKS__) && (__MWERKS__ > 0x2400)
	/* newer Metrowerks compilers support __attribute__() */
#elif !defined(__GNUC__) || __GNUC__ < 2 || \
	(__GNUC__ == 2 && __GNUC_MINOR__ < 5)
#define	__attribute__(x)	/* delete __attribute__ if non-gcc or gcc1 */
#if defined(__GNUC__) && !defined(__STRICT_ANSI__)
#define	__dead		__volatile
#define	__pure		__const
#endif
#endif

/* Delete pseudo-keywords wherever they are not available or needed. */
#ifndef __dead
#define	__dead
#define	__pure
#endif

#define __IDSTRING(name,string) \
     static const char name[] __attribute__((__unused__)) = string

#ifndef __COPYRIGHT
#define __COPYRIGHT(s) __IDSTRING(copyright,s)
#endif

#ifndef __RCSID
#define __RCSID(s) __IDSTRING(rcsid,s)
#endif

#ifndef __SCCSID
#define __SCCSID(s) __IDSTRING(sccsid,s)
#endif

#ifndef __PROJECT_VERSION
#define __PROJECT_VERSION(s) __IDSTRING(project_version,s)
#endif

#endif /* !_CDEFS_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
de355530 A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
1c79356b	11	*
de355530 A	12	* This Original Code and all software distributed under the License are
de355530 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
de355530 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/* Copyright 1995 NeXT Computer, Inc. All rights reserved. */
	23	/*
	24	* Copyright (c) 1991, 1993
	25	* The Regents of the University of California. All rights reserved.
	26	*
	27	* This code is derived from software contributed to Berkeley by
	28	* Berkeley Software Design, Inc.
	29	*
	30	* Redistribution and use in source and binary forms, with or without
	31	* modification, are permitted provided that the following conditions
	32	* are met:
	33	* 1. Redistributions of source code must retain the above copyright
	34	* notice, this list of conditions and the following disclaimer.
	35	* 2. Redistributions in binary form must reproduce the above copyright
	36	* notice, this list of conditions and the following disclaimer in the
	37	* documentation and/or other materials provided with the distribution.
	38	* 3. All advertising materials mentioning features or use of this software
	39	* must display the following acknowledgement:
	40	* This product includes software developed by the University of
	41	* California, Berkeley and its contributors.
	42	* 4. Neither the name of the University nor the names of its contributors
	43	* may be used to endorse or promote products derived from this software
	44	* without specific prior written permission.
	45	*
	46	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	47	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	48	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	49	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	50	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	51	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	52	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	53	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	54	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	55	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	56	* SUCH DAMAGE.
	57	*
	58	* @(#)cdefs.h 8.8 (Berkeley) 1/9/95
	59	*/
	60
	61	#ifndef _CDEFS_H_
	62	#define _CDEFS_H_
	63
	64	#if defined(__cplusplus)
	65	#define __BEGIN_DECLS extern "C" {
	66	#define __END_DECLS }
	67	#else
	68	#define __BEGIN_DECLS
	69	#define __END_DECLS
	70	#endif
	71
	72	/*
	73	* The __CONCAT macro is used to concatenate parts of symbol names, e.g.
	74	* with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
	75	* The __CONCAT macro is a bit tricky -- make sure you don't put spaces
	76	* in between its arguments. __CONCAT can also concatenate double-quoted
	77	* strings produced by the __STRING macro, but this only works with ANSI C.
	78	*/
	79	#if defined(__STDC__) \|\| defined(__cplusplus)
	80	#define __P(protos) protos /* full-blown ANSI C */
	81	#define __CONCAT(x,y) x ## y
	82	#define __STRING(x) #x
83
84	#define __const const /* define reserved names to standard */
85	#define __signed signed
86	#define __volatile volatile
87	#if defined(__cplusplus)
88	#define __inline inline /* convert to C++ keyword */
89	#else
90	#ifndef __GNUC__
91	#define __inline /* delete GCC keyword */
92	#endif /* !__GNUC__ */
93	#endif /* !__cplusplus */
94
95	#else /* !(__STDC__ \|\| __cplusplus) */
96	#define __P(protos) () /* traditional C preprocessor */
97	#define __CONCAT(x,y) x/**/y
98	#define __STRING(x) "x"
99
100	#ifndef __GNUC__
101	#define __const /* delete pseudo-ANSI C keywords */
102	#define __inline
103	#define __signed
104	#define __volatile
105	#endif /* !__GNUC__ */
106
107	/*
108	* In non-ANSI C environments, new programs will want ANSI-only C keywords
109	* deleted from the program and old programs will want them left alone.
110	* When using a compiler other than gcc, programs using the ANSI C keywords
111	* const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
112	* When using "gcc -traditional", we assume that this is the intent; if
113	* __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
114	*/
115	#ifndef NO_ANSI_KEYWORDS
116	#define const __const /* convert ANSI C keywords */
117	#define inline __inline
118	#define signed __signed
119	#define volatile __volatile
120	#endif /* !NO_ANSI_KEYWORDS */
121	#endif /* !(__STDC__ \|\| __cplusplus) */
122
123	/*
124	* GCC1 and some versions of GCC2 declare dead (non-returning) and
125	* pure (no side effects) functions using "volatile" and "const";
126	* unfortunately, these then cause warnings under "-ansi -pedantic".
127	* GCC2 uses a new, peculiar __attribute__((attrs)) style. All of
128	* these work for GNU C++ (modulo a slight glitch in the C++ grammar
129	* in the distribution version of 2.5.5).
130	*/
0b4e3aa0 A	131	#if defined(__MWERKS__) && (__MWERKS__ > 0x2400)
	132	/* newer Metrowerks compilers support __attribute__() */
	133	#elif !defined(__GNUC__) \|\| __GNUC__ < 2 \|\| \
1c79356b A	134	(__GNUC__ == 2 && __GNUC_MINOR__ < 5)
	135	#define __attribute__(x) /* delete __attribute__ if non-gcc or gcc1 */
	136	#if defined(__GNUC__) && !defined(__STRICT_ANSI__)
	137	#define __dead __volatile
	138	#define __pure __const
	139	#endif
	140	#endif
	141
	142	/* Delete pseudo-keywords wherever they are not available or needed. */
	143	#ifndef __dead
	144	#define __dead
	145	#define __pure
	146	#endif
	147
	148	#define __IDSTRING(name,string) \
	149	static const char name[] __attribute__((__unused__)) = string
	150
	151	#ifndef __COPYRIGHT
	152	#define __COPYRIGHT(s) __IDSTRING(copyright,s)
	153	#endif
	154
	155	#ifndef __RCSID
	156	#define __RCSID(s) __IDSTRING(rcsid,s)
	157	#endif
	158
	159	#ifndef __SCCSID
	160	#define __SCCSID(s) __IDSTRING(sccsid,s)
	161	#endif
	162
	163	#ifndef __PROJECT_VERSION
	164	#define __PROJECT_VERSION(s) __IDSTRING(project_version,s)
	165	#endif
	166
	167	#endif /* !_CDEFS_H_ */