xref: /xnu-12377.1.9/iokit/DriverKit/macro_help.h (revision f6217f891ac0bb64f3d375211650a4c1ff8ca1ea) !
1*f6217f89SApple OSS Distributions /*
2*f6217f89SApple OSS Distributions  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3*f6217f89SApple OSS Distributions  *
4*f6217f89SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*f6217f89SApple OSS Distributions  *
6*f6217f89SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*f6217f89SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*f6217f89SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*f6217f89SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*f6217f89SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*f6217f89SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*f6217f89SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*f6217f89SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*f6217f89SApple OSS Distributions  *
15*f6217f89SApple OSS Distributions  * Please obtain a copy of the License at
16*f6217f89SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*f6217f89SApple OSS Distributions  *
18*f6217f89SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*f6217f89SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*f6217f89SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*f6217f89SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*f6217f89SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*f6217f89SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*f6217f89SApple OSS Distributions  * limitations under the License.
25*f6217f89SApple OSS Distributions  *
26*f6217f89SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*f6217f89SApple OSS Distributions  */
28*f6217f89SApple OSS Distributions /*
29*f6217f89SApple OSS Distributions  * @OSF_COPYRIGHT@
30*f6217f89SApple OSS Distributions  */
31*f6217f89SApple OSS Distributions /*
32*f6217f89SApple OSS Distributions  * Mach Operating System
33*f6217f89SApple OSS Distributions  * Copyright (c) 1991,1990,1989,1988 Carnegie Mellon University
34*f6217f89SApple OSS Distributions  * All Rights Reserved.
35*f6217f89SApple OSS Distributions  *
36*f6217f89SApple OSS Distributions  * Permission to use, copy, modify and distribute this software and its
37*f6217f89SApple OSS Distributions  * documentation is hereby granted, provided that both the copyright
38*f6217f89SApple OSS Distributions  * notice and this permission notice appear in all copies of the
39*f6217f89SApple OSS Distributions  * software, derivative works or modified versions, and any portions
40*f6217f89SApple OSS Distributions  * thereof, and that both notices appear in supporting documentation.
41*f6217f89SApple OSS Distributions  *
42*f6217f89SApple OSS Distributions  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43*f6217f89SApple OSS Distributions  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44*f6217f89SApple OSS Distributions  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45*f6217f89SApple OSS Distributions  *
46*f6217f89SApple OSS Distributions  * Carnegie Mellon requests users of this software to return to
47*f6217f89SApple OSS Distributions  *
48*f6217f89SApple OSS Distributions  *  Software Distribution Coordinator  or  [email protected]
49*f6217f89SApple OSS Distributions  *  School of Computer Science
50*f6217f89SApple OSS Distributions  *  Carnegie Mellon University
51*f6217f89SApple OSS Distributions  *  Pittsburgh PA 15213-3890
52*f6217f89SApple OSS Distributions  *
53*f6217f89SApple OSS Distributions  * any improvements or extensions that they make and grant Carnegie Mellon
54*f6217f89SApple OSS Distributions  * the rights to redistribute these changes.
55*f6217f89SApple OSS Distributions  */
56*f6217f89SApple OSS Distributions /*
57*f6217f89SApple OSS Distributions  */
58*f6217f89SApple OSS Distributions /*
59*f6217f89SApple OSS Distributions  *	File:	kern/macro_help.h
60*f6217f89SApple OSS Distributions  *
61*f6217f89SApple OSS Distributions  *	Provide help in making lint-free macro routines
62*f6217f89SApple OSS Distributions  *
63*f6217f89SApple OSS Distributions  */
64*f6217f89SApple OSS Distributions 
65*f6217f89SApple OSS Distributions #ifndef _KERN_MACRO_HELP_H_
66*f6217f89SApple OSS Distributions #define _KERN_MACRO_HELP_H_
67*f6217f89SApple OSS Distributions 
68*f6217f89SApple OSS Distributions #if DRIVERKIT_FRAMEWORK_INCLUDE
69*f6217f89SApple OSS Distributions #define         NEVER           false
70*f6217f89SApple OSS Distributions #define         ALWAYS          true
71*f6217f89SApple OSS Distributions #else
72*f6217f89SApple OSS Distributions 
73*f6217f89SApple OSS Distributions #include <mach/boolean.h>
74*f6217f89SApple OSS Distributions 
75*f6217f89SApple OSS Distributions #ifdef  lint
76*f6217f89SApple OSS Distributions boolean_t       NEVER;
77*f6217f89SApple OSS Distributions boolean_t       ALWAYS;
78*f6217f89SApple OSS Distributions #else   /* lint */
79*f6217f89SApple OSS Distributions #define         NEVER           FALSE
80*f6217f89SApple OSS Distributions #define         ALWAYS          TRUE
81*f6217f89SApple OSS Distributions #endif  /* lint */
82*f6217f89SApple OSS Distributions 
83*f6217f89SApple OSS Distributions #endif /* DRIVERKIT_FRAMEWORK_INCLUDE */
84*f6217f89SApple OSS Distributions 
85*f6217f89SApple OSS Distributions 
86*f6217f89SApple OSS Distributions #define         MACRO_BEGIN     do {
87*f6217f89SApple OSS Distributions #define         MACRO_END       } while (NEVER)
88*f6217f89SApple OSS Distributions 
89*f6217f89SApple OSS Distributions #define         MACRO_RETURN    if (ALWAYS) return
90*f6217f89SApple OSS Distributions 
91*f6217f89SApple OSS Distributions #endif  /* _KERN_MACRO_HELP_H_ */
92