cdefs.h@ 21139

Last change on this file since 21139 was 21109, checked in by vboxsync, 16 years ago
iprt/cdefs.h: Fixed RT_FROM_MEMBER.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 58.9 KB

Line
1	/** @file
2	* IPRT - Common C and C++ definitions.
3	*/
4
5	/*
6	* Copyright (C) 2006-2009 Sun Microsystems, Inc.
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*
25	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26	* Clara, CA 95054 USA or visit http://www.sun.com if you need
27	* additional information or have any questions.
28	*/
29
30	#ifndef ___iprt_cdefs_h
31	#define ___iprt_cdefs_h
32
33
34	/** @defgroup grp_rt_cdefs IPRT Common Definitions and Macros
35	* @{
36	*/
37
38	/*
39	* Include sys/cdefs.h if present, if not define the stuff we need.
40	*/
41	#ifdef HAVE_SYS_CDEFS_H
42	# if defined(RT_ARCH_LINUX) && defined(__KERNEL__)
43	# error "oops"
44	# endif
45	# include <sys/cdefs.h>
46	#else
47
48	/** @def RT_C_DECLS_BEGIN
49	* Used to start a block of function declarations which are shared
50	* between C and C++ program.
51	*/
52
53	/** @def RT_C_DECLS_END
54	* Used to end a block of function declarations which are shared
55	* between C and C++ program.
56	*/
57
58	# if defined(__cplusplus)
59	# define RT_C_DECLS_BEGIN extern "C" {
60	# define RT_C_DECLS_END }
61	# else
62	# define RT_C_DECLS_BEGIN
63	# define RT_C_DECLS_END
64	# endif
65
66	#endif
67
68
69	/*
70	* Shut up DOXYGEN warnings and guide it properly thru the code.
71	*/
72	#ifdef DOXYGEN_RUNNING
73	#define __AMD64__
74	#define __X86__
75	#define RT_ARCH_AMD64
76	#define RT_ARCH_X86
77	#define IN_RING0
78	#define IN_RING3
79	#define IN_RC
80	#define IN_RC
81	#define IN_RT_GC
82	#define IN_RT_R0
83	#define IN_RT_R3
84	#define IN_RT_STATIC
85	#define RT_STRICT
86	#define Breakpoint
87	#define RT_NO_DEPRECATED_MACROS
88	#endif /* DOXYGEN_RUNNING */
89
90	/** @def RT_ARCH_X86
91	* Indicates that we're compiling for the X86 architecture.
92	*/
93
94	/** @def RT_ARCH_AMD64
95	* Indicates that we're compiling for the AMD64 architecture.
96	*/
97	#if !defined(RT_ARCH_X86) && !defined(RT_ARCH_AMD64)
98	# if defined(__amd64__) \|\| defined(__x86_64__) \|\| defined(_M_X64) \|\| defined(__AMD64__)
99	# define RT_ARCH_AMD64
100	# elif defined(__i386__) \|\| defined(_M_IX86) \|\| defined(__X86__)
101	# define RT_ARCH_X86
102	# else /* PORTME: append test for new archs. */
103	# error "Check what predefined macros your compiler uses to indicate architecture."
104	# endif
105	#elif defined(RT_ARCH_X86) && defined(RT_ARCH_AMD64) /* PORTME: append new archs. */
106	# error "Both RT_ARCH_X86 and RT_ARCH_AMD64 cannot be defined at the same time!"
107	#endif
108
109
110	/** @def __X86__
111	* Indicates that we're compiling for the X86 architecture.
112	* @deprecated
113	*/
114
115	/** @def __AMD64__
116	* Indicates that we're compiling for the AMD64 architecture.
117	* @deprecated
118	*/
119	#if !defined(__X86__) && !defined(__AMD64__)
120	# if defined(RT_ARCH_AMD64)
121	# define __AMD64__
122	# elif defined(RT_ARCH_X86)
123	# define __X86__
124	# else
125	# error "Check what predefined macros your compiler uses to indicate architecture."
126	# endif
127	#elif defined(__X86__) && defined(__AMD64__)
128	# error "Both __X86__ and __AMD64__ cannot be defined at the same time!"
129	#elif defined(__X86__) && !defined(RT_ARCH_X86)
130	# error "Both __X86__ without RT_ARCH_X86!"
131	#elif defined(__AMD64__) && !defined(RT_ARCH_AMD64)
132	# error "Both __AMD64__ without RT_ARCH_AMD64!"
133	#endif
134
135	/** @def IN_RING0
136	* Used to indicate that we're compiling code which is running
137	* in Ring-0 Host Context.
138	*/
139
140	/** @def IN_RING3
141	* Used to indicate that we're compiling code which is running
142	* in Ring-3 Host Context.
143	*/
144
145	/** @def IN_RC
146	* Used to indicate that we're compiling code which is running
147	* in the Raw-mode Context (implies R0).
148	*/
149	#if !defined(IN_RING3) && !defined(IN_RING0) && !defined(IN_RC) && !defined(IN_RC)
150	# error "You must define which context the compiled code should run in; IN_RING3, IN_RING0 or IN_RC"
151	#endif
152	#if (defined(IN_RING3) && (defined(IN_RING0) \|\| defined(IN_RC)) ) \
153	\|\| (defined(IN_RING0) && (defined(IN_RING3) \|\| defined(IN_RC)) ) \
154	\|\| (defined(IN_RC) && (defined(IN_RING3) \|\| defined(IN_RING0)) )
155	# error "Only one of the IN_RING3, IN_RING0, IN_RC defines should be defined."
156	#endif
157
158
159	/** @def ARCH_BITS
160	* Defines the bit count of the current context.
161	*/
162	#if !defined(ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
163	# if defined(RT_ARCH_AMD64)
164	# define ARCH_BITS 64
165	# else
166	# define ARCH_BITS 32
167	# endif
168	#endif
169
170	/** @def HC_ARCH_BITS
171	* Defines the host architecture bit count.
172	*/
173	#if !defined(HC_ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
174	# ifndef IN_RC
175	# define HC_ARCH_BITS ARCH_BITS
176	# else
177	# define HC_ARCH_BITS 32
178	# endif
179	#endif
180
181	/** @def GC_ARCH_BITS
182	* Defines the guest architecture bit count.
183	*/
184	#if !defined(GC_ARCH_BITS) && !defined(DOXYGEN_RUNNING)
185	# ifdef VBOX_WITH_64_BITS_GUESTS
186	# define GC_ARCH_BITS 64
187	# else
188	# define GC_ARCH_BITS 32
189	# endif
190	#endif
191
192	/** @def R3_ARCH_BITS
193	* Defines the host ring-3 architecture bit count.
194	*/
195	#if !defined(R3_ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
196	# ifdef IN_RING3
197	# define R3_ARCH_BITS ARCH_BITS
198	# else
199	# define R3_ARCH_BITS HC_ARCH_BITS
200	# endif
201	#endif
202
203	/** @def R0_ARCH_BITS
204	* Defines the host ring-0 architecture bit count.
205	*/
206	#if !defined(R0_ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
207	# ifdef IN_RING0
208	# define R0_ARCH_BITS ARCH_BITS
209	# else
210	# define R0_ARCH_BITS HC_ARCH_BITS
211	# endif
212	#endif
213
214	/** @def GC_ARCH_BITS
215	* Defines the guest architecture bit count.
216	*/
217	#if !defined(GC_ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
218	# ifdef IN_RC
219	# define GC_ARCH_BITS ARCH_BITS
220	# else
221	# define GC_ARCH_BITS 32
222	# endif
223	#endif
224
225
226	/** @def CTXTYPE
227	* Declare a type differently in GC, R3 and R0.
228	*
229	* @param GCType The GC type.
230	* @param R3Type The R3 type.
231	* @param R0Type The R0 type.
232	* @remark For pointers used only in one context use RCPTRTYPE(), R3R0PTRTYPE(), R3PTRTYPE() or R0PTRTYPE().
233	*/
234	#ifdef IN_RC
235	# define CTXTYPE(GCType, R3Type, R0Type) GCType
236	#elif defined(IN_RING3)
237	# define CTXTYPE(GCType, R3Type, R0Type) R3Type
238	#else
239	# define CTXTYPE(GCType, R3Type, R0Type) R0Type
240	#endif
241
242	/** @def RCPTRTYPE
243	* Declare a pointer which is used in the raw mode context but appears in structure(s) used by
244	* both HC and RC. The main purpose is to make sure structures have the same
245	* size when built for different architectures.
246	*
247	* @param RCType The RC type.
248	*/
249	#define RCPTRTYPE(RCType) CTXTYPE(RCType, RTRCPTR, RTRCPTR)
250
251	/** @def R3R0PTRTYPE
252	* Declare a pointer which is used in HC, is explicitly valid in ring 3 and 0,
253	* but appears in structure(s) used by both HC and GC. The main purpose is to
254	* make sure structures have the same size when built for different architectures.
255	*
256	* @param R3R0Type The R3R0 type.
257	* @remarks This used to be called HCPTRTYPE.
258	*/
259	#define R3R0PTRTYPE(R3R0Type) CTXTYPE(RTHCPTR, R3R0Type, R3R0Type)
260
261	/** @def R3PTRTYPE
262	* Declare a pointer which is used in R3 but appears in structure(s) used by
263	* both HC and GC. The main purpose is to make sure structures have the same
264	* size when built for different architectures.
265	*
266	* @param R3Type The R3 type.
267	*/
268	#define R3PTRTYPE(R3Type) CTXTYPE(RTHCUINTPTR, R3Type, RTHCUINTPTR)
269
270	/** @def R0PTRTYPE
271	* Declare a pointer which is used in R0 but appears in structure(s) used by
272	* both HC and GC. The main purpose is to make sure structures have the same
273	* size when built for different architectures.
274	*
275	* @param R0Type The R0 type.
276	*/
277	#define R0PTRTYPE(R0Type) CTXTYPE(RTHCUINTPTR, RTHCUINTPTR, R0Type)
278
279	/** @def CTXSUFF
280	* Adds the suffix of the current context to the passed in
281	* identifier name. The suffix is HC or GC.
282	*
283	* This is macro should only be used in shared code to avoid a forest of ifdefs.
284	* @param var Identifier name.
285	* @deprecated Use CTX_SUFF. Do NOT use this for new code.
286	*/
287	/** @def OTHERCTXSUFF
288	* Adds the suffix of the other context to the passed in
289	* identifier name. The suffix is HC or GC.
290	*
291	* This is macro should only be used in shared code to avoid a forest of ifdefs.
292	* @param var Identifier name.
293	* @deprecated Use CTX_SUFF. Do NOT use this for new code.
294	*/
295	#ifdef IN_RC
296	# define CTXSUFF(var) var##GC
297	# define OTHERCTXSUFF(var) var##HC
298	#else
299	# define CTXSUFF(var) var##HC
300	# define OTHERCTXSUFF(var) var##GC
301	#endif
302
303	/** @def CTXALLSUFF
304	* Adds the suffix of the current context to the passed in
305	* identifier name. The suffix is R3, R0 or GC.
306	*
307	* This is macro should only be used in shared code to avoid a forest of ifdefs.
308	* @param var Identifier name.
309	* @deprecated Use CTX_SUFF. Do NOT use this for new code.
310	*/
311	#ifdef IN_RC
312	# define CTXALLSUFF(var) var##GC
313	#elif defined(IN_RING0)
314	# define CTXALLSUFF(var) var##R0
315	#else
316	# define CTXALLSUFF(var) var##R3
317	#endif
318
319	/** @def CTX_SUFF
320	* Adds the suffix of the current context to the passed in
321	* identifier name. The suffix is R3, R0 or RC.
322	*
323	* This is macro should only be used in shared code to avoid a forest of ifdefs.
324	* @param var Identifier name.
325	*
326	* @remark This will replace CTXALLSUFF and CTXSUFF before long.
327	*/
328	#ifdef IN_RC
329	# define CTX_SUFF(var) var##RC
330	#elif defined(IN_RING0)
331	# define CTX_SUFF(var) var##R0
332	#else
333	# define CTX_SUFF(var) var##R3
334	#endif
335
336	/** @def CTX_SUFF_Z
337	* Adds the suffix of the current context to the passed in
338	* identifier name, combining RC and R0 into RZ.
339	* The suffix thus is R3 or RZ.
340	*
341	* This is macro should only be used in shared code to avoid a forest of ifdefs.
342	* @param var Identifier name.
343	*
344	* @remark This will replace CTXALLSUFF and CTXSUFF before long.
345	*/
346	#ifdef IN_RING3
347	# define CTX_SUFF_Z(var) var##R3
348	#else
349	# define CTX_SUFF_Z(var) var##RZ
350	#endif
351
352
353	/** @def CTXMID
354	* Adds the current context as a middle name of an identifier name
355	* The middle name is HC or GC.
356	*
357	* This is macro should only be used in shared code to avoid a forest of ifdefs.
358	* @param first First name.
359	* @param last Surname.
360	*/
361	/** @def OTHERCTXMID
362	* Adds the other context as a middle name of an identifier name
363	* The middle name is HC or GC.
364	*
365	* This is macro should only be used in shared code to avoid a forest of ifdefs.
366	* @param first First name.
367	* @param last Surname.
368	* @deprecated use CTX_MID or CTX_MID_Z
369	*/
370	#ifdef IN_RC
371	# define CTXMID(first, last) first##GC##last
372	# define OTHERCTXMID(first, last) first##HC##last
373	#else
374	# define CTXMID(first, last) first##HC##last
375	# define OTHERCTXMID(first, last) first##GC##last
376	#endif
377
378	/** @def CTXALLMID
379	* Adds the current context as a middle name of an identifier name.
380	* The middle name is R3, R0 or GC.
381	*
382	* This is macro should only be used in shared code to avoid a forest of ifdefs.
383	* @param first First name.
384	* @param last Surname.
385	* @deprecated use CTX_MID or CTX_MID_Z
386	*/
387	#ifdef IN_RC
388	# define CTXALLMID(first, last) first##GC##last
389	#elif defined(IN_RING0)
390	# define CTXALLMID(first, last) first##R0##last
391	#else
392	# define CTXALLMID(first, last) first##R3##last
393	#endif
394
395	/** @def CTX_MID
396	* Adds the current context as a middle name of an identifier name.
397	* The middle name is R3, R0 or RC.
398	*
399	* This is macro should only be used in shared code to avoid a forest of ifdefs.
400	* @param first First name.
401	* @param last Surname.
402	*/
403	#ifdef IN_RC
404	# define CTX_MID(first, last) first##RC##last
405	#elif defined(IN_RING0)
406	# define CTX_MID(first, last) first##R0##last
407	#else
408	# define CTX_MID(first, last) first##R3##last
409	#endif
410
411	/** @def CTX_MID_Z
412	* Adds the current context as a middle name of an identifier name, combining RC
413	* and R0 into RZ.
414	* The middle name thus is either R3 or RZ.
415	*
416	* This is macro should only be used in shared code to avoid a forest of ifdefs.
417	* @param first First name.
418	* @param last Surname.
419	*/
420	#ifdef IN_RING3
421	# define CTX_MID_Z(first, last) first##R3##last
422	#else
423	# define CTX_MID_Z(first, last) first##RZ##last
424	#endif
425
426
427	/** @def R3STRING
428	* A macro which in GC and R0 will return a dummy string while in R3 it will return
429	* the parameter.
430	*
431	* This is typically used to wrap description strings in structures shared
432	* between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_RING3 mess.
433	*
434	* @param pR3String The R3 string. Only referenced in R3.
435	* @see R0STRING and GCSTRING
436	*/
437	#ifdef IN_RING3
438	# define R3STRING(pR3String) (pR3String)
439	#else
440	# define R3STRING(pR3String) ("<R3_STRING>")
441	#endif
442
443	/** @def R0STRING
444	* A macro which in GC and R3 will return a dummy string while in R0 it will return
445	* the parameter.
446	*
447	* This is typically used to wrap description strings in structures shared
448	* between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_RING0 mess.
449	*
450	* @param pR0String The R0 string. Only referenced in R0.
451	* @see R3STRING and GCSTRING
452	*/
453	#ifdef IN_RING0
454	# define R0STRING(pR0String) (pR0String)
455	#else
456	# define R0STRING(pR0String) ("<R0_STRING>")
457	#endif
458
459	/** @def RCSTRING
460	* A macro which in R3 and R0 will return a dummy string while in RC it will return
461	* the parameter.
462	*
463	* This is typically used to wrap description strings in structures shared
464	* between R3, R0 and/or RC. The intention is to avoid the \#ifdef IN_RC mess.
465	*
466	* @param pR0String The RC string. Only referenced in RC.
467	* @see R3STRING, R0STRING
468	*/
469	#ifdef IN_RC
470	# define RCSTRING(pRCString) (pRCString)
471	#else
472	# define RCSTRING(pRCString) ("<RC_STRING>")
473	#endif
474
475
476	/** @def RT_NOTHING
477	* A macro that expands to nothing.
478	* This is primarily intended as a dummy argument for macros to avoid the
479	* undefined behavior passing empty arguments to an macro (ISO C90 and C++98,
480	* gcc v4.4 warns about it).
481	*/
482	#define RT_NOTHING
483
484
485	/** @def RTCALL
486	* The standard calling convention for the Runtime interfaces.
487	*/
488	#ifdef _MSC_VER
489	# define RTCALL __cdecl
490	#elif defined(__GNUC__) && defined(IN_RING0) && !(defined(RT_OS_OS2) \|\| defined(RT_ARCH_AMD64)) /* the latter is kernel/gcc */
491	# define RTCALL __attribute__((cdecl,regparm(0)))
492	#else
493	# define RTCALL
494	#endif
495
496	/** @def RT_NO_THROW
497	* How to express that a function doesn't throw C++ exceptions
498	* and the compiler can thus save itself the bother of trying
499	* to catch any of them. Put this between the closing parenthesis
500	* and the semicolon in function prototypes (and implementation if C++).
501	*/
502	#if defined(__cplusplus) \
503	&& ( (defined(_MSC_VER) && defined(_CPPUNWIND)) \
504	\|\| (defined(__GNUC__) && defined(__EXCEPTIONS)))
505	# define RT_NO_THROW throw()
506	#else
507	# define RT_NO_THROW
508	#endif
509
510	/** @def DECLEXPORT
511	* How to declare an exported function.
512	* @param type The return type of the function declaration.
513	*/
514	#if defined(_MSC_VER) \|\| defined(RT_OS_OS2)
515	# define DECLEXPORT(type) __declspec(dllexport) type
516	#elif defined(RT_USE_VISIBILITY_DEFAULT)
517	# define DECLEXPORT(type) __attribute__((visibility("default"))) type
518	#else
519	# define DECLEXPORT(type) type
520	#endif
521
522	/** @def DECLIMPORT
523	* How to declare an imported function.
524	* @param type The return type of the function declaration.
525	*/
526	#if defined(_MSC_VER) \|\| (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__))
527	# define DECLIMPORT(type) __declspec(dllimport) type
528	#else
529	# define DECLIMPORT(type) type
530	#endif
531
532	/** @def DECLHIDDEN
533	* How to declare a non-exported function or variable.
534	* @param type The return type of the function or the data type of the variable.
535	*/
536	#if defined(RT_OS_OS2) \|\| defined(RT_OS_WINDOWS) \|\| !defined(RT_USE_VISIBILITY_HIDDEN)
537	# define DECLHIDDEN(type) type
538	#else
539	# define DECLHIDDEN(type) __attribute__((visibility("hidden"))) type
540	#endif
541
542	/** @def DECLASM
543	* How to declare an internal assembly function.
544	* @param type The return type of the function declaration.
545	*/
546	#ifdef __cplusplus
547	# ifdef _MSC_VER
548	# define DECLASM(type) extern "C" type __cdecl
549	# else
550	# define DECLASM(type) extern "C" type
551	# endif
552	#else
553	# ifdef _MSC_VER
554	# define DECLASM(type) type __cdecl
555	# else
556	# define DECLASM(type) type
557	# endif
558	#endif
559
560	/** @def DECLASMTYPE
561	* How to declare an internal assembly function type.
562	* @param type The return type of the function.
563	*/
564	#ifdef _MSC_VER
565	# define DECLASMTYPE(type) type __cdecl
566	#else
567	# define DECLASMTYPE(type) type
568	#endif
569
570	/** @def DECLNORETURN
571	* How to declare a function which does not return.
572	* @note: This macro can be combined with other macros, for example
573	* @code
574	* EMR3DECL(DECLNORETURN(void)) foo(void);
575	* @endcode
576	*/
577	#ifdef _MSC_VER
578	# define DECLNORETURN(type) __declspec(noreturn) type
579	#elif defined(__GNUC__)
580	# define DECLNORETURN(type) __attribute__((noreturn)) type
581	#else
582	# define DECLNORETURN(type) type
583	#endif
584
585	/** @def DECLCALLBACK
586	* How to declare an call back function type.
587	* @param type The return type of the function declaration.
588	*/
589	#define DECLCALLBACK(type) type RTCALL
590
591	/** @def DECLCALLBACKPTR
592	* How to declare an call back function pointer.
593	* @param type The return type of the function declaration.
594	* @param name The name of the variable member.
595	*/
596	#define DECLCALLBACKPTR(type, name) type (RTCALL * name)
597
598	/** @def DECLCALLBACKMEMBER
599	* How to declare an call back function pointer member.
600	* @param type The return type of the function declaration.
601	* @param name The name of the struct/union/class member.
602	*/
603	#define DECLCALLBACKMEMBER(type, name) type (RTCALL * name)
604
605	/** @def DECLR3CALLBACKMEMBER
606	* How to declare an call back function pointer member - R3 Ptr.
607	* @param type The return type of the function declaration.
608	* @param name The name of the struct/union/class member.
609	* @param args The argument list enclosed in parentheses.
610	*/
611	#ifdef IN_RING3
612	# define DECLR3CALLBACKMEMBER(type, name, args) type (RTCALL * name) args
613	#else
614	# define DECLR3CALLBACKMEMBER(type, name, args) RTR3PTR name
615	#endif
616
617	/** @def DECLRCCALLBACKMEMBER
618	* How to declare an call back function pointer member - RC Ptr.
619	* @param type The return type of the function declaration.
620	* @param name The name of the struct/union/class member.
621	* @param args The argument list enclosed in parentheses.
622	*/
623	#ifdef IN_RC
624	# define DECLRCCALLBACKMEMBER(type, name, args) type (RTCALL * name) args
625	#else
626	# define DECLRCCALLBACKMEMBER(type, name, args) RTRCPTR name
627	#endif
628
629	/** @def DECLR0CALLBACKMEMBER
630	* How to declare an call back function pointer member - R0 Ptr.
631	* @param type The return type of the function declaration.
632	* @param name The name of the struct/union/class member.
633	* @param args The argument list enclosed in parentheses.
634	*/
635	#ifdef IN_RING0
636	# define DECLR0CALLBACKMEMBER(type, name, args) type (RTCALL * name) args
637	#else
638	# define DECLR0CALLBACKMEMBER(type, name, args) RTR0PTR name
639	#endif
640
641	/** @def DECLINLINE
642	* How to declare a function as inline.
643	* @param type The return type of the function declaration.
644	* @remarks Don't use this macro on C++ methods.
645	*/
646	#ifdef __GNUC__
647	# define DECLINLINE(type) static __inline__ type
648	#elif defined(__cplusplus)
649	# define DECLINLINE(type) inline type
650	#elif defined(_MSC_VER)
651	# define DECLINLINE(type) _inline type
652	#elif defined(__IBMC__)
653	# define DECLINLINE(type) _Inline type
654	#else
655	# define DECLINLINE(type) inline type
656	#endif
657
658
659	/** @def DECL_FORCE_INLINE
660	* How to declare a function as inline and try convince the compiler to always
661	* inline it regardless of optimization switches.
662	* @param type The return type of the function declaration.
663	* @remarks Use sparsely and with care. Don't use this macro on C++ methods.
664	*/
665	#ifdef __GNUC__
666	# define DECL_FORCE_INLINE(type) __attribute__((always_inline)) DECLINLINE(type)
667	#elif defined(_MSC_VER)
668	# define DECL_FORCE_INLINE(type) __forceinline type
669	#else
670	# define DECL_FORCE_INLINE(type) DECLINLINE(type)
671	#endif
672
673
674	/** @def DECL_NO_INLINE
675	* How to declare a function telling the compiler not to inline it.
676	* @param scope The function scope, static or RT_NOTHING.
677	* @param type The return type of the function declaration.
678	* @remarks Don't use this macro on C++ methods.
679	*/
680	#ifdef __GNUC__
681	# define DECL_NO_INLINE(scope,type) __attribute__((noinline)) scope type
682	#elif defined(_MSC_VER)
683	# define DECL_NO_INLINE(scope,type) __declspec(noline) scope type
684	#else
685	# define DECL_NO_INLINE(scope,type) scope type
686	#endif
687
688
689	/** @def IN_RT_STATIC
690	* Used to indicate whether we're linking against a static IPRT
691	* or not. The IPRT symbols will be declared as hidden (if
692	* supported). Note that this define has no effect without setting
693	* IN_RT_R0, IN_RT_R3 or IN_RT_GC indicators are set first.
694	*/
695
696	/** @def IN_RT_R0
697	* Used to indicate whether we're inside the same link module as
698	* the HC Ring-0 Runtime Library.
699	*/
700	/** @def RTR0DECL(type)
701	* Runtime Library HC Ring-0 export or import declaration.
702	* @param type The return type of the function declaration.
703	*/
704	#ifdef IN_RT_R0
705	# ifdef IN_RT_STATIC
706	# define RTR0DECL(type) DECLHIDDEN(type) RTCALL
707	# else
708	# define RTR0DECL(type) DECLEXPORT(type) RTCALL
709	# endif
710	#else
711	# define RTR0DECL(type) DECLIMPORT(type) RTCALL
712	#endif
713
714	/** @def IN_RT_R3
715	* Used to indicate whether we're inside the same link module as
716	* the HC Ring-3 Runtime Library.
717	*/
718	/** @def RTR3DECL(type)
719	* Runtime Library HC Ring-3 export or import declaration.
720	* @param type The return type of the function declaration.
721	*/
722	#ifdef IN_RT_R3
723	# ifdef IN_RT_STATIC
724	# define RTR3DECL(type) DECLHIDDEN(type) RTCALL
725	# else
726	# define RTR3DECL(type) DECLEXPORT(type) RTCALL
727	# endif
728	#else
729	# define RTR3DECL(type) DECLIMPORT(type) RTCALL
730	#endif
731
732	/** @def IN_RT_GC
733	* Used to indicate whether we're inside the same link module as
734	* the GC Runtime Library.
735	*/
736	/** @def RTGCDECL(type)
737	* Runtime Library HC Ring-3 export or import declaration.
738	* @param type The return type of the function declaration.
739	*/
740	#ifdef IN_RT_GC
741	# ifdef IN_RT_STATIC
742	# define RTGCDECL(type) DECLHIDDEN(type) RTCALL
743	# else
744	# define RTGCDECL(type) DECLEXPORT(type) RTCALL
745	# endif
746	#else
747	# define RTGCDECL(type) DECLIMPORT(type) RTCALL
748	#endif
749
750	/** @def RTDECL(type)
751	* Runtime Library export or import declaration.
752	* Functions declared using this macro exists in all contexts.
753	* @param type The return type of the function declaration.
754	*/
755	#if defined(IN_RT_R3) \|\| defined(IN_RT_GC) \|\| defined(IN_RT_R0)
756	# ifdef IN_RT_STATIC
757	# define RTDECL(type) DECLHIDDEN(type) RTCALL
758	# else
759	# define RTDECL(type) DECLEXPORT(type) RTCALL
760	# endif
761	#else
762	# define RTDECL(type) DECLIMPORT(type) RTCALL
763	#endif
764
765	/** @def RTDATADECL(type)
766	* Runtime Library export or import declaration.
767	* Data declared using this macro exists in all contexts.
768	* @param type The return type of the function declaration.
769	*/
770	#if defined(IN_RT_R3) \|\| defined(IN_RT_GC) \|\| defined(IN_RT_R0)
771	# ifdef IN_RT_STATIC
772	# define RTDATADECL(type) DECLHIDDEN(type)
773	# else
774	# define RTDATADECL(type) DECLEXPORT(type)
775	# endif
776	#else
777	# define RTDATADECL(type) DECLIMPORT(type)
778	#endif
779
780	/** @def RT_DECL_CLASS
781	* Declares an class living in the runtime.
782	*/
783	#if defined(IN_RT_R3) \|\| defined(IN_RT_GC) \|\| defined(IN_RT_R0)
784	# ifdef IN_RT_STATIC
785	# define RT_DECL_CLASS
786	# else
787	# define RT_DECL_CLASS DECLEXPORT_CLASS
788	# endif
789	#else
790	# define RT_DECL_CLASS DECLIMPORT_CLASS
791	#endif
792
793
794	/** @def RT_NOCRT
795	* Symbol name wrapper for the No-CRT bits.
796	*
797	* In order to coexist in the same process as other CRTs, we need to
798	* decorate the symbols such that they don't conflict the ones in the
799	* other CRTs. The result of such conflicts / duplicate symbols can
800	* confuse the dynamic loader on Unix like systems.
801	*
802	* Define RT_WITHOUT_NOCRT_WRAPPERS to drop the wrapping.
803	* Define RT_WITHOUT_NOCRT_WRAPPER_ALIASES to drop the aliases to the
804	* wrapped names.
805	*/
806	/** @def RT_NOCRT_STR
807	* Same as RT_NOCRT only it'll return a double quoted string of the result.
808	*/
809	#ifndef RT_WITHOUT_NOCRT_WRAPPERS
810	# define RT_NOCRT(name) nocrt_ ## name
811	# define RT_NOCRT_STR(name) "nocrt_" # name
812	#else
813	# define RT_NOCRT(name) name
814	# define RT_NOCRT_STR(name) #name
815	#endif
816
817
818
819	/** @def RT_LIKELY
820	* Give the compiler a hint that an expression is very likely to hold true.
821	*
822	* Some compilers support explicit branch prediction so that the CPU backend
823	* can hint the processor and also so that code blocks can be reordered such
824	* that the predicted path sees a more linear flow, thus improving cache
825	* behaviour, etc.
826	*
827	* IPRT provides the macros RT_LIKELY() and RT_UNLIKELY() as a way to utilize
828	* this compiler feature when present.
829	*
830	* A few notes about the usage:
831	*
832	* - Generally, use RT_UNLIKELY() with error condition checks (unless you
833	* have some _strong_ reason to do otherwise, in which case document it),
834	* and/or RT_LIKELY() with success condition checks, assuming you want
835	* to optimize for the success path.
836	*
837	* - Other than that, if you don't know the likelihood of a test succeeding
838	* from empirical or other 'hard' evidence, don't make predictions unless
839	* you happen to be a Dirk Gently.
840	*
841	* - These macros are meant to be used in places that get executed a lot. It
842	* is wasteful to make predictions in code that is executed rarely (e.g.
843	* at subsystem initialization time) as the basic block reordering that this
844	* affects can often generate larger code.
845	*
846	* - Note that RT_SUCCESS() and RT_FAILURE() already makes use of RT_LIKELY()
847	* and RT_UNLIKELY(). Should you wish for prediction free status checks,
848	* use the RT_SUCCESS_NP() and RT_FAILURE_NP() macros instead.
849	*
850	*
851	* @returns the boolean result of the expression.
852	* @param expr The expression that's very likely to be true.
853	* @see RT_UNLIKELY
854	*/
855	/** @def RT_UNLIKELY
856	* Give the compiler a hint that an expression is highly unlikely to hold true.
857	*
858	* See the usage instructions give in the RT_LIKELY() docs.
859	*
860	* @returns the boolean result of the expression.
861	* @param expr The expression that's very unlikely to be true.
862	* @see RT_LIKELY
863	*/
864	#if defined(__GNUC__)
865	# if __GNUC__ >= 3
866	# define RT_LIKELY(expr) __builtin_expect(!!(expr), 1)
867	# define RT_UNLIKELY(expr) __builtin_expect(!!(expr), 0)
868	# else
869	# define RT_LIKELY(expr) (expr)
870	# define RT_UNLIKELY(expr) (expr)
871	# endif
872	#else
873	# define RT_LIKELY(expr) (expr)
874	# define RT_UNLIKELY(expr) (expr)
875	#endif
876
877
878	/** @def RT_STR
879	* Returns the argument as a string constant.
880	* @param str Argument to stringify. */
881	#define RT_STR(str) #str
882	/** @def RT_XSTR
883	* Returns the expanded argument as a string.
884	* @param str Argument to expand and stringy. */
885	#define RT_XSTR(str) RT_STR(str)
886
887
888	/** @def RT_BIT
889	* Convert a bit number into an integer bitmask (unsigned).
890	* @param bit The bit number.
891	*/
892	#define RT_BIT(bit) ( 1U << (bit) )
893
894	/** @def RT_BIT_32
895	* Convert a bit number into a 32-bit bitmask (unsigned).
896	* @param bit The bit number.
897	*/
898	#define RT_BIT_32(bit) ( UINT32_C(1) << (bit) )
899
900	/** @def RT_BIT_64
901	* Convert a bit number into a 64-bit bitmask (unsigned).
902	* @param bit The bit number.
903	*/
904	#define RT_BIT_64(bit) ( UINT64_C(1) << (bit) )
905
906	/** @def RT_ALIGN
907	* Align macro.
908	* @param u Value to align.
909	* @param uAlignment The alignment. Power of two!
910	*
911	* @remark Be extremely careful when using this macro with type which sizeof != sizeof int.
912	* When possible use any of the other RT_ALIGN_* macros. And when that's not
913	* possible, make 101% sure that uAlignment is specified with a right sized type.
914	*
915	* Specifying an unsigned 32-bit alignment constant with a 64-bit value will give
916	* you a 32-bit return value!
917	*
918	* In short: Don't use this macro. Use RT_ALIGN_T() instead.
919	*/
920	#define RT_ALIGN(u, uAlignment) ( ((u) + ((uAlignment) - 1)) & ~((uAlignment) - 1) )
921
922	/** @def RT_ALIGN_T
923	* Align macro.
924	* @param u Value to align.
925	* @param uAlignment The alignment. Power of two!
926	* @param type Integer type to use while aligning.
927	* @remark This macro is the preferred alignment macro, it doesn't have any of the pitfalls RT_ALIGN has.
928	*/
929	#define RT_ALIGN_T(u, uAlignment, type) ( ((type)(u) + ((uAlignment) - 1)) & ~(type)((uAlignment) - 1) )
930
931	/** @def RT_ALIGN_32
932	* Align macro for a 32-bit value.
933	* @param u32 Value to align.
934	* @param uAlignment The alignment. Power of two!
935	*/
936	#define RT_ALIGN_32(u32, uAlignment) RT_ALIGN_T(u32, uAlignment, uint32_t)
937
938	/** @def RT_ALIGN_64
939	* Align macro for a 64-bit value.
940	* @param u64 Value to align.
941	* @param uAlignment The alignment. Power of two!
942	*/
943	#define RT_ALIGN_64(u64, uAlignment) RT_ALIGN_T(u64, uAlignment, uint64_t)
944
945	/** @def RT_ALIGN_Z
946	* Align macro for size_t.
947	* @param cb Value to align.
948	* @param uAlignment The alignment. Power of two!
949	*/
950	#define RT_ALIGN_Z(cb, uAlignment) RT_ALIGN_T(cb, uAlignment, size_t)
951
952	/** @def RT_ALIGN_P
953	* Align macro for pointers.
954	* @param pv Value to align.
955	* @param uAlignment The alignment. Power of two!
956	*/
957	#define RT_ALIGN_P(pv, uAlignment) RT_ALIGN_PT(pv, uAlignment, void *)
958
959	/** @def RT_ALIGN_PT
960	* Align macro for pointers with type cast.
961	* @param u Value to align.
962	* @param uAlignment The alignment. Power of two!
963	* @param CastType The type to cast the result to.
964	*/
965	#define RT_ALIGN_PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, uintptr_t) )
966
967	/** @def RT_ALIGN_R3PT
968	* Align macro for ring-3 pointers with type cast.
969	* @param u Value to align.
970	* @param uAlignment The alignment. Power of two!
971	* @param CastType The type to cast the result to.
972	*/
973	#define RT_ALIGN_R3PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTR3UINTPTR) )
974
975	/** @def RT_ALIGN_R0PT
976	* Align macro for ring-0 pointers with type cast.
977	* @param u Value to align.
978	* @param uAlignment The alignment. Power of two!
979	* @param CastType The type to cast the result to.
980	*/
981	#define RT_ALIGN_R0PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTR0UINTPTR) )
982
983	/** @def RT_ALIGN_GCPT
984	* Align macro for GC pointers with type cast.
985	* @param u Value to align.
986	* @param uAlignment The alignment. Power of two!
987	* @param CastType The type to cast the result to.
988	*/
989	#define RT_ALIGN_GCPT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTGCUINTPTR) )
990
991
992	/** @def RT_OFFSETOF
993	* Our own special offsetof() variant, returns a signed result.
994	*
995	* This differs from the usual offsetof() in that it's not relying on builtin
996	* compiler stuff and thus can use variables in arrays the structure may
997	* contain. This is useful to determine the sizes of structures ending
998	* with a variable length field.
999	*
1000	* @returns offset into the structure of the specified member. signed.
1001	* @param type Structure type.
1002	* @param member Member.
1003	*/
1004	#define RT_OFFSETOF(type, member) ( (int)(uintptr_t)&( ((type )(void )0)->member) )
1005
1006	/** @def RT_UOFFSETOF
1007	* Our own special offsetof() variant, returns an unsigned result.
1008	*
1009	* This differs from the usual offsetof() in that it's not relying on builtin
1010	* compiler stuff and thus can use variables in arrays the structure may
1011	* contain. This is useful to determine the sizes of structures ending
1012	* with a variable length field.
1013	*
1014	* @returns offset into the structure of the specified member. unsigned.
1015	* @param type Structure type.
1016	* @param member Member.
1017	*/
1018	#define RT_UOFFSETOF(type, member) ( (uintptr_t)&( ((type )(void )0)->member) )
1019
1020	/** @def RT_OFFSETOF_ADD
1021	* RT_OFFSETOF with an addend.
1022	*
1023	* @returns offset into the structure of the specified member. signed.
1024	* @param type Structure type.
1025	* @param member Member.
1026	* @param addend The addend to add to the offset.
1027	*/
1028	#define RT_OFFSETOF_ADD(type, member, addend) ( (int)RT_UOFFSETOF_ADD(type, member, addend) )
1029
1030	/** @def RT_UOFFSETOF_ADD
1031	* RT_UOFFSETOF with an addend.
1032	*
1033	* @returns offset into the structure of the specified member. signed.
1034	* @param type Structure type.
1035	* @param member Member.
1036	* @param addend The addend to add to the offset.
1037	*/
1038	#define RT_UOFFSETOF_ADD(type, member, addend) ( (uintptr_t)&( ((type )(void )(uintptr_t)(addend))->member) )
1039
1040	/** @def RT_SIZEOFMEMB
1041	* Get the size of a structure member.
1042	*
1043	* @returns size of the structure member.
1044	* @param type Structure type.
1045	* @param member Member.
1046	*/
1047	#define RT_SIZEOFMEMB(type, member) ( sizeof(((type )(void )0)->member) )
1048
1049	/** @def RT_FROM_MEMBER
1050	* Convert a pointer to a structure member into a pointer to the structure.
1051	* @returns pointer to the structure.
1052	* @param pMember Pointer to the member.
1053	* @param Type Strucutre type.
1054	* @param Member Member name.
1055	*/
1056	#define RT_FROM_MEMBER(pMem, Type, Member) ( (Type ) ((uint8_t )(void *)(pMem) - RT_UOFFSETOF(Type, Member)) )
1057
1058	/** @def RT_ELEMENTS
1059	* Calculates the number of elements in a statically sized array.
1060	* @returns Element count.
1061	* @param aArray Array in question.
1062	*/
1063	#define RT_ELEMENTS(aArray) ( sizeof(aArray) / sizeof((aArray)[0]) )
1064
1065	#ifdef RT_OS_OS2
1066	/* Undefine RT_MAX since there is an unfortunate clash with the max
1067	resource type define in os2.h. */
1068	# undef RT_MAX
1069	#endif
1070
1071	/** @def RT_MAX
1072	* Finds the maximum value.
1073	* @returns The higher of the two.
1074	* @param Value1 Value 1
1075	* @param Value2 Value 2
1076	*/
1077	#define RT_MAX(Value1, Value2) ( (Value1) >= (Value2) ? (Value1) : (Value2) )
1078
1079	/** @def RT_MIN
1080	* Finds the minimum value.
1081	* @returns The lower of the two.
1082	* @param Value1 Value 1
1083	* @param Value2 Value 2
1084	*/
1085	#define RT_MIN(Value1, Value2) ( (Value1) <= (Value2) ? (Value1) : (Value2) )
1086
1087	/** @def RT_ABS
1088	* Get the absolute (non-negative) value.
1089	* @returns The absolute value of Value.
1090	* @param Value The value.
1091	*/
1092	#define RT_ABS(Value) ( (Value) >= 0 ? (Value) : -(Value) )
1093
1094	/** @def RT_LODWORD
1095	* Gets the low dword (=uint32_t) of something. */
1096	#define RT_LODWORD(a) ( (uint32_t)(a) )
1097
1098	/** @def RT_HIDWORD
1099	* Gets the high dword (=uint32_t) of a 64-bit of something. */
1100	#define RT_HIDWORD(a) ( (uint32_t)((a) >> 32) )
1101
1102	/** @def RT_LOWORD
1103	* Gets the low word (=uint16_t) of something. */
1104	#define RT_LOWORD(a) ( (a) & 0xffff )
1105
1106	/** @def RT_HIWORD
1107	* Gets the high word (=uint16_t) of a 32-bit something. */
1108	#define RT_HIWORD(a) ( (a) >> 16 )
1109
1110	/** @def RT_LOBYTE
1111	* Gets the low byte of something. */
1112	#define RT_LOBYTE(a) ( (a) & 0xff )
1113
1114	/** @def RT_HIBYTE
1115	* Gets the low byte of a 16-bit something. */
1116	#define RT_HIBYTE(a) ( (a) >> 8 )
1117
1118	/** @def RT_BYTE1
1119	* Gets first byte of something. */
1120	#define RT_BYTE1(a) ( (a) & 0xff )
1121
1122	/** @def RT_BYTE2
1123	* Gets second byte of something. */
1124	#define RT_BYTE2(a) ( ((a) >> 8) & 0xff )
1125
1126	/** @def RT_BYTE3
1127	* Gets second byte of something. */
1128	#define RT_BYTE3(a) ( ((a) >> 16) & 0xff )
1129
1130	/** @def RT_BYTE4
1131	* Gets fourth byte of something. */
1132	#define RT_BYTE4(a) ( ((a) >> 24) & 0xff )
1133
1134
1135	/** @def RT_MAKE_U64
1136	* Constructs a uint64_t value from two uint32_t values.
1137	*/
1138	#define RT_MAKE_U64(Lo, Hi) ( (uint64_t)((uint32_t)(Hi)) << 32 \| (uint32_t)(Lo) )
1139
1140	/** @def RT_MAKE_U64_FROM_U16
1141	* Constructs a uint64_t value from four uint16_t values.
1142	*/
1143	#define RT_MAKE_U64_FROM_U16(w0, w1, w2, w3) \
1144	( (uint64_t)((uint16_t)(w3)) << 48 \
1145	\| (uint64_t)((uint16_t)(w2)) << 32 \
1146	\| (uint32_t)((uint16_t)(w1)) << 16 \
1147	\| (uint16_t)(w0) )
1148
1149	/** @def RT_MAKE_U64_FROM_U8
1150	* Constructs a uint64_t value from eight uint8_t values.
1151	*/
1152	#define RT_MAKE_U64_FROM_U8(b0, b1, b2, b3, b4, b5, b6, b7) \
1153	( (uint64_t)((uint8_t)(b7)) << 56 \
1154	\| (uint64_t)((uint8_t)(b6)) << 48 \
1155	\| (uint64_t)((uint8_t)(b5)) << 40 \
1156	\| (uint64_t)((uint8_t)(b4)) << 32 \
1157	\| (uint32_t)((uint8_t)(b3)) << 24 \
1158	\| (uint32_t)((uint8_t)(b2)) << 16 \
1159	\| (uint16_t)((uint8_t)(b1)) << 8 \
1160	\| (uint8_t)(b0) )
1161
1162	/** @def RT_MAKE_U32
1163	* Constructs a uint32_t value from two uint16_t values.
1164	*/
1165	#define RT_MAKE_U32(Lo, Hi) ( (uint32_t)((uint16_t)(Hi)) << 16 \| (uint16_t)(Lo) )
1166
1167	/** @def RT_MAKE_U32_FROM_U8
1168	* Constructs a uint32_t value from four uint8_t values.
1169	*/
1170	#define RT_MAKE_U32_FROM_U8(b0, b1, b2, b3) \
1171	( (uint32_t)((uint8_t)(b3)) << 24 \
1172	\| (uint32_t)((uint8_t)(b2)) << 16 \
1173	\| (uint16_t)((uint8_t)(b1)) << 8 \
1174	\| (uint8_t)(b0) )
1175
1176	/** @def RT_MAKE_U16
1177	* Constructs a uint32_t value from two uint16_t values.
1178	*/
1179	#define RT_MAKE_U16(Lo, Hi) ( (uint16_t)((uint8_t)(Hi)) << 8 \| (uint8_t)(Lo) )
1180
1181
1182	/** @def RT_BSWAP_U64
1183	* Reverses the byte order of an uint64_t value. */
1184	#if 0
1185	# define RT_BSWAP_U64(u64) RT_BSWAP_U64_C(u64)
1186	#elif defined(__GNUC__)
1187	/** @todo use __builtin_constant_p? */
1188	# define RT_BSWAP_U64(u64) ASMByteSwapU64(u64)
1189	#else
1190	# define RT_BSWAP_U64(u64) ASMByteSwapU64(u64)
1191	#endif
1192
1193	/** @def RT_BSWAP_U32
1194	* Reverses the byte order of an uint32_t value. */
1195	#if 0
1196	# define RT_BSWAP_U32(u32) RT_BSWAP_U32_C(u32)
1197	#elif defined(__GNUC__)
1198	/** @todo use __builtin_constant_p? */
1199	# define RT_BSWAP_U32(u32) ASMByteSwapU32(u32)
1200	#else
1201	# define RT_BSWAP_U32(u32) ASMByteSwapU32(u32)
1202	#endif
1203
1204	/** @def RT_BSWAP_U16
1205	* Reverses the byte order of an uint16_t value. */
1206	#if 0
1207	# define RT_BSWAP_U16(u16) RT_BSWAP_U16_C(u16)
1208	#elif defined(__GNUC__)
1209	/** @todo use __builtin_constant_p? */
1210	# define RT_BSWAP_U16(u16) ASMByteSwapU16(u16)
1211	#else
1212	# define RT_BSWAP_U16(u16) ASMByteSwapU16(u16)
1213	#endif
1214
1215
1216	/** @def RT_BSWAP_U64_C
1217	* Reverses the byte order of an uint64_t constant. */
1218	#define RT_BSWAP_U64_C(u64) RT_MAKE_U64(RT_BSWAP_U32_C((u64) >> 32), RT_BSWAP_U32_C((u64) & 0xffffffff))
1219
1220	/** @def RT_BSWAP_U32_C
1221	* Reverses the byte order of an uint32_t constant. */
1222	#define RT_BSWAP_U32_C(u32) (RT_BYTE4(u32) \| (RT_BYTE3(u32) << 8) \| (RT_BYTE2(u32) << 16) \| (RT_BYTE1(u32) << 24))
1223
1224	/** @def RT_BSWAP_U16_C
1225	* Reverses the byte order of an uint16_t constant. */
1226	#define RT_BSWAP_U16_C(u16) (RT_HIBYTE(u16) \| (RT_LOBYTE(u16) << 8))
1227
1228
1229	/** @def RT_H2LE_U64
1230	* Converts an uint64_t value from host to little endian byte order. */
1231	#ifdef RT_BIG_ENDIAN
1232	# define RT_H2LE_U64(u64) RT_BSWAP_U64(u64)
1233	#else
1234	# define RT_H2LE_U64(u64) (u64)
1235	#endif
1236
1237	/** @def RT_H2LE_U64_C
1238	* Converts an uint64_t constant from host to little endian byte order. */
1239	#ifdef RT_BIG_ENDIAN
1240	# define RT_H2LE_U64_C(u64) RT_BSWAP_U64_C(u64)
1241	#else
1242	# define RT_H2LE_U64_C(u64) (u64)
1243	#endif
1244
1245	/** @def RT_H2LE_U32
1246	* Converts an uint32_t value from host to little endian byte order. */
1247	#ifdef RT_BIG_ENDIAN
1248	# define RT_H2LE_U32(u32) RT_BSWAP_U32(u32)
1249	#else
1250	# define RT_H2LE_U32(u32) (u32)
1251	#endif
1252
1253	/** @def RT_H2LE_U32_C
1254	* Converts an uint32_t constant from host to little endian byte order. */
1255	#ifdef RT_BIG_ENDIAN
1256	# define RT_H2LE_U32_C(u32) RT_BSWAP_U32_C(u32)
1257	#else
1258	# define RT_H2LE_U32_C(u32) (u32)
1259	#endif
1260
1261	/** @def RT_H2LE_U16
1262	* Converts an uint16_t value from host to little endian byte order. */
1263	#ifdef RT_BIG_ENDIAN
1264	# define RT_H2LE_U16(u16) RT_BSWAP_U16(u16)
1265	#else
1266	# define RT_H2LE_U16(u16) (u16)
1267	#endif
1268
1269	/** @def RT_H2LE_U16_C
1270	* Converts an uint16_t constant from host to little endian byte order. */
1271	#ifdef RT_BIG_ENDIAN
1272	# define RT_H2LE_U16_C(u16) RT_BSWAP_U16_C(u16)
1273	#else
1274	# define RT_H2LE_U16_C(u16) (u16)
1275	#endif
1276
1277
1278	/** @def RT_LE2H_U64
1279	* Converts an uint64_t value from little endian to host byte order. */
1280	#ifdef RT_BIG_ENDIAN
1281	# define RT_LE2H_U64(u64) RT_BSWAP_U64(u64)
1282	#else
1283	# define RT_LE2H_U64(u64) (u64)
1284	#endif
1285
1286	/** @def RT_LE2H_U64_C
1287	* Converts an uint64_t constant from little endian to host byte order. */
1288	#ifdef RT_BIG_ENDIAN
1289	# define RT_LE2H_U64_C(u64) RT_BSWAP_U64_C(u64)
1290	#else
1291	# define RT_LE2H_U64_C(u64) (u64)
1292	#endif
1293
1294	/** @def RT_LE2H_U32
1295	* Converts an uint32_t value from little endian to host byte order. */
1296	#ifdef RT_BIG_ENDIAN
1297	# define RT_LE2H_U32(u32) RT_BSWAP_U32(u32)
1298	#else
1299	# define RT_LE2H_U32(u32) (u32)
1300	#endif
1301
1302	/** @def RT_LE2H_U32_C
1303	* Converts an uint32_t constant from little endian to host byte order. */
1304	#ifdef RT_BIG_ENDIAN
1305	# define RT_LE2H_U32_C(u32) RT_BSWAP_U32_C(u32)
1306	#else
1307	# define RT_LE2H_U32_C(u32) (u32)
1308	#endif
1309
1310	/** @def RT_LE2H_U16
1311	* Converts an uint16_t value from little endian to host byte order. */
1312	#ifdef RT_BIG_ENDIAN
1313	# define RT_LE2H_U16(u16) RT_BSWAP_U16(u16)
1314	#else
1315	# define RT_LE2H_U16(u16) (u16)
1316	#endif
1317
1318	/** @def RT_LE2H_U16_C
1319	* Converts an uint16_t constant from little endian to host byte order. */
1320	#ifdef RT_BIG_ENDIAN
1321	# define RT_LE2H_U16_C(u16) RT_BSWAP_U16_C(u16)
1322	#else
1323	# define RT_LE2H_U16_C(u16) (u16)
1324	#endif
1325
1326
1327	/** @def RT_H2BE_U64
1328	* Converts an uint64_t value from host to big endian byte order. */
1329	#ifdef RT_BIG_ENDIAN
1330	# define RT_H2BE_U64(u64) (u64)
1331	#else
1332	# define RT_H2BE_U64(u64) RT_BSWAP_U64(u64)
1333	#endif
1334
1335	/** @def RT_H2BE_U64_C
1336	* Converts an uint64_t constant from host to big endian byte order. */
1337	#ifdef RT_BIG_ENDIAN
1338	# define RT_H2BE_U64_C(u64) (u64)
1339	#else
1340	# define RT_H2BE_U64_C(u64) RT_BSWAP_U64_C(u64)
1341	#endif
1342
1343	/** @def RT_H2BE_U32
1344	* Converts an uint32_t value from host to big endian byte order. */
1345	#ifdef RT_BIG_ENDIAN
1346	# define RT_H2BE_U32(u32) (u32)
1347	#else
1348	# define RT_H2BE_U32(u32) RT_BSWAP_U32(u32)
1349	#endif
1350
1351	/** @def RT_H2BE_U32_C
1352	* Converts an uint32_t constant from host to big endian byte order. */
1353	#ifdef RT_BIG_ENDIAN
1354	# define RT_H2BE_U32_C(u32) (u32)
1355	#else
1356	# define RT_H2BE_U32_C(u32) RT_BSWAP_U32_C(u32)
1357	#endif
1358
1359	/** @def RT_H2BE_U16
1360	* Converts an uint16_t value from host to big endian byte order. */
1361	#ifdef RT_BIG_ENDIAN
1362	# define RT_H2BE_U16(u16) (u16)
1363	#else
1364	# define RT_H2BE_U16(u16) RT_BSWAP_U16(u16)
1365	#endif
1366
1367	/** @def RT_H2BE_U16_C
1368	* Converts an uint16_t constant from host to big endian byte order. */
1369	#ifdef RT_BIG_ENDIAN
1370	# define RT_H2BE_U16_C(u16) (u16)
1371	#else
1372	# define RT_H2BE_U16_C(u16) RT_BSWAP_U16_C(u16)
1373	#endif
1374
1375	/** @def RT_BE2H_U64
1376	* Converts an uint64_t value from big endian to host byte order. */
1377	#ifdef RT_BIG_ENDIAN
1378	# define RT_BE2H_U64(u64) (u64)
1379	#else
1380	# define RT_BE2H_U64(u64) RT_BSWAP_U64(u64)
1381	#endif
1382
1383	/** @def RT_BE2H_U64
1384	* Converts an uint64_t constant from big endian to host byte order. */
1385	#ifdef RT_BIG_ENDIAN
1386	# define RT_BE2H_U64_C(u64) (u64)
1387	#else
1388	# define RT_BE2H_U64_C(u64) RT_BSWAP_U64_C(u64)
1389	#endif
1390
1391	/** @def RT_BE2H_U32
1392	* Converts an uint32_t value from big endian to host byte order. */
1393	#ifdef RT_BIG_ENDIAN
1394	# define RT_BE2H_U32(u32) (u32)
1395	#else
1396	# define RT_BE2H_U32(u32) RT_BSWAP_U32(u32)
1397	#endif
1398
1399	/** @def RT_BE2H_U32_C
1400	* Converts an uint32_t value from big endian to host byte order. */
1401	#ifdef RT_BIG_ENDIAN
1402	# define RT_BE2H_U32_C(u32) (u32)
1403	#else
1404	# define RT_BE2H_U32_C(u32) RT_BSWAP_U32_C(u32)
1405	#endif
1406
1407	/** @def RT_BE2H_U16
1408	* Converts an uint16_t value from big endian to host byte order. */
1409	#ifdef RT_BIG_ENDIAN
1410	# define RT_BE2H_U16(u16) (u16)
1411	#else
1412	# define RT_BE2H_U16(u16) RT_BSWAP_U16(u16)
1413	#endif
1414
1415	/** @def RT_BE2H_U16_C
1416	* Converts an uint16_t constant from big endian to host byte order. */
1417	#ifdef RT_BIG_ENDIAN
1418	# define RT_BE2H_U16_C(u16) (u16)
1419	#else
1420	# define RT_BE2H_U16_C(u16) RT_BSWAP_U16_C(u16)
1421	#endif
1422
1423
1424	/** @def RT_H2N_U64
1425	* Converts an uint64_t value from host to network byte order. */
1426	#define RT_H2N_U64(u64) RT_H2BE_U64(u64)
1427
1428	/** @def RT_H2N_U64_C
1429	* Converts an uint64_t constant from host to network byte order. */
1430	#define RT_H2N_U64_C(u64) RT_H2BE_U64_C(u64)
1431
1432	/** @def RT_H2N_U32
1433	* Converts an uint32_t value from host to network byte order. */
1434	#define RT_H2N_U32(u32) RT_H2BE_U32(u32)
1435
1436	/** @def RT_H2N_U32_C
1437	* Converts an uint32_t constant from host to network byte order. */
1438	#define RT_H2N_U32_C(u32) RT_H2BE_U32_C(u32)
1439
1440	/** @def RT_H2N_U16
1441	* Converts an uint16_t value from host to network byte order. */
1442	#define RT_H2N_U16(u16) RT_H2BE_U16(u16)
1443
1444	/** @def RT_H2N_U16_C
1445	* Converts an uint16_t constant from host to network byte order. */
1446	#define RT_H2N_U16_C(u16) RT_H2BE_U16_C(u16)
1447
1448	/** @def RT_N2H_U64
1449	* Converts an uint64_t value from network to host byte order. */
1450	#define RT_N2H_U64(u64) RT_BE2H_U64(u64)
1451
1452	/** @def RT_N2H_U64_C
1453	* Converts an uint64_t constant from network to host byte order. */
1454	#define RT_N2H_U64_C(u64) RT_BE2H_U64_C(u64)
1455
1456	/** @def RT_N2H_U32
1457	* Converts an uint32_t value from network to host byte order. */
1458	#define RT_N2H_U32(u32) RT_BE2H_U32(u32)
1459
1460	/** @def RT_N2H_U32_C
1461	* Converts an uint32_t constant from network to host byte order. */
1462	#define RT_N2H_U32_C(u32) RT_BE2H_U32_C(u32)
1463
1464	/** @def RT_N2H_U16
1465	* Converts an uint16_t value from network to host byte order. */
1466	#define RT_N2H_U16(u16) RT_BE2H_U16(u16)
1467
1468	/** @def RT_N2H_U16_C
1469	* Converts an uint16_t value from network to host byte order. */
1470	#define RT_N2H_U16_C(u16) RT_BE2H_U16_C(u16)
1471
1472
1473	/*
1474	* The BSD sys/param.h + machine/param.h file is a major source of
1475	* namespace pollution. Kill off some of the worse ones unless we're
1476	* compiling kernel code.
1477	*/
1478	#if defined(RT_OS_DARWIN) \
1479	&& !defined(KERNEL) \
1480	&& !defined(RT_NO_BSD_PARAM_H_UNDEFING) \
1481	&& ( defined(_SYS_PARAM_H_) \|\| defined(_I386_PARAM_H_) )
1482	/* sys/param.h: */
1483	# undef PSWP
1484	# undef PVM
1485	# undef PINOD
1486	# undef PRIBO
1487	# undef PVFS
1488	# undef PZERO
1489	# undef PSOCK
1490	# undef PWAIT
1491	# undef PLOCK
1492	# undef PPAUSE
1493	# undef PUSER
1494	# undef PRIMASK
1495	# undef MINBUCKET
1496	# undef MAXALLOCSAVE
1497	# undef FSHIFT
1498	# undef FSCALE
1499
1500	/* i386/machine.h: */
1501	# undef ALIGN
1502	# undef ALIGNBYTES
1503	# undef DELAY
1504	# undef STATUS_WORD
1505	# undef USERMODE
1506	# undef BASEPRI
1507	# undef MSIZE
1508	# undef CLSIZE
1509	# undef CLSIZELOG2
1510	#endif
1511
1512
1513	/** @def NULL
1514	* NULL pointer.
1515	*/
1516	#ifndef NULL
1517	# ifdef __cplusplus
1518	# define NULL 0
1519	# else
1520	# define NULL ((void*)0)
1521	# endif
1522	#endif
1523
1524	/** @def NIL_OFFSET
1525	* NIL offset.
1526	* Whenever we use offsets instead of pointers to save space and relocation effort
1527	* NIL_OFFSET shall be used as the equivalent to NULL.
1528	*/
1529	#define NIL_OFFSET (~0U)
1530
1531	/** @def NOREF
1532	* Keeps the compiler from bitching about an unused parameter.
1533	*/
1534	#define NOREF(var) (void)(var)
1535
1536	/** @def Breakpoint
1537	* Emit a debug breakpoint instruction.
1538	*
1539	* Use this for instrumenting a debugging session only!
1540	* No committed code shall use Breakpoint().
1541	*/
1542	#ifdef __GNUC__
1543	# define Breakpoint() __asm__ __volatile__("int $3\n\t")
1544	#endif
1545	#ifdef _MSC_VER
1546	# define Breakpoint() __asm int 3
1547	#endif
1548	#if defined(__IBMC__) \|\| defined(__IBMCPP__)
1549	# define Breakpoint() __interrupt(3)
1550	#endif
1551	#ifndef Breakpoint
1552	# error "This compiler is not supported!"
1553	#endif
1554
1555
1556	/** @defgroup grp_rt_cdefs_size Size Constants
1557	* (Of course, these are binary computer terms, not SI.)
1558	* @{
1559	*/
1560	/** 1 K (Kilo) (1 024). */
1561	#define _1K 0x00000400
1562	/** 4 K (Kilo) (4 096). */
1563	#define _4K 0x00001000
1564	/** 32 K (Kilo) (32 678). */
1565	#define _32K 0x00008000
1566	/** 64 K (Kilo) (65 536). */
1567	#define _64K 0x00010000
1568	/** 128 K (Kilo) (131 072). */
1569	#define _128K 0x00020000
1570	/** 256 K (Kilo) (262 144). */
1571	#define _256K 0x00040000
1572	/** 512 K (Kilo) (524 288). */
1573	#define _512K 0x00080000
1574	/** 1 M (Mega) (1 048 576). */
1575	#define _1M 0x00100000
1576	/** 2 M (Mega) (2 097 152). */
1577	#define _2M 0x00200000
1578	/** 4 M (Mega) (4 194 304). */
1579	#define _4M 0x00400000
1580	/** 1 G (Giga) (1 073 741 824). */
1581	#define _1G 0x40000000
1582	/** 2 G (Giga) (2 147 483 648). (32-bit) */
1583	#define _2G32 0x80000000U
1584	/** 2 G (Giga) (2 147 483 648). (64-bit) */
1585	#define _2G 0x0000000080000000LL
1586	/** 4 G (Giga) (4 294 967 296). */
1587	#define _4G 0x0000000100000000LL
1588	/** 1 T (Tera) (1 099 511 627 776). */
1589	#define _1T 0x0000010000000000LL
1590	/** 1 P (Peta) (1 125 899 906 842 624). */
1591	#define _1P 0x0004000000000000LL
1592	/** 1 E (Exa) (1 152 921 504 606 846 976). */
1593	#define _1E 0x1000000000000000LL
1594	/** 2 E (Exa) (2 305 843 009 213 693 952). */
1595	#define _2E 0x2000000000000000ULL
1596	/** @} */
1597
1598
1599	/** @defgroup grp_rt_cdefs_dbgtype Debug Info Types
1600	* @{ */
1601	/** Other format. */
1602	#define RT_DBGTYPE_OTHER RT_BIT_32(0)
1603	/** Stabs. */
1604	#define RT_DBGTYPE_STABS RT_BIT_32(1)
1605	/** Debug With Arbitrary Record Format (DWARF). */
1606	#define RT_DBGTYPE_DWARF RT_BIT_32(2)
1607	/** Microsoft Codeview debug info. */
1608	#define RT_DBGTYPE_CODEVIEW RT_BIT_32(3)
1609	/** Watcom debug info. */
1610	#define RT_DBGTYPE_WATCOM RT_BIT_32(4)
1611	/** IBM High Level Language debug info. */
1612	#define RT_DBGTYPE_HLL RT_BIT_32(5)
1613	/** Old OS/2 and Windows symbol file. */
1614	#define RT_DBGTYPE_SYM RT_BIT_32(6)
1615	/** Map file. */
1616	#define RT_DBGTYPE_MAP RT_BIT_32(7)
1617	/** @} */
1618
1619
1620	/** @defgroup grp_rt_cdefs_exetype Executable Image Types
1621	* @{ */
1622	/** Some other format. */
1623	#define RT_EXETYPE_OTHER RT_BIT_32(0)
1624	/** Portable Executable. */
1625	#define RT_EXETYPE_PE RT_BIT_32(1)
1626	/** Linear eXecutable. */
1627	#define RT_EXETYPE_LX RT_BIT_32(2)
1628	/** Linear Executable. */
1629	#define RT_EXETYPE_LE RT_BIT_32(3)
1630	/** New Executable. */
1631	#define RT_EXETYPE_NE RT_BIT_32(4)
1632	/** DOS Executable (Mark Zbikowski). */
1633	#define RT_EXETYPE_MZ RT_BIT_32(5)
1634	/** COM Executable. */
1635	#define RT_EXETYPE_COM RT_BIT_32(6)
1636	/** a.out Executable. */
1637	#define RT_EXETYPE_AOUT RT_BIT_32(7)
1638	/** Executable and Linkable Format. */
1639	#define RT_EXETYPE_ELF RT_BIT_32(8)
1640	/** Mach-O Executable (including FAT ones). */
1641	#define RT_EXETYPE_MACHO RT_BIT_32(9)
1642	/** TE from UEFI. */
1643	#define RT_EXETYPE_TE RT_BIT_32(9)
1644	/** @} */
1645
1646
1647	/** @def VALID_PTR
1648	* Pointer validation macro.
1649	* @param ptr The pointer.
1650	*/
1651	#if defined(RT_ARCH_AMD64)
1652	# ifdef IN_RING3
1653	# if defined(RT_OS_DARWIN) /* first 4GB is reserved for legacy kernel. */
1654	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= _4G \
1655	&& !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
1656	# elif defined(RT_OS_SOLARIS) /* The kernel only used the top 2TB, but keep it simple. */
1657	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
1658	&& ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
1659	\|\| ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
1660	# else
1661	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
1662	&& !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
1663	# endif
1664	# else /* !IN_RING3 */
1665	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
1666	&& ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
1667	\|\| ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
1668	# endif /* !IN_RING3 */
1669	#elif defined(RT_ARCH_X86)
1670	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
1671	#else
1672	# error "Architecture identifier missing / not implemented."
1673	#endif
1674
1675	/** Old name for RT_VALID_PTR. */
1676	#define VALID_PTR(ptr) RT_VALID_PTR(ptr)
1677
1678	/** @def RT_VALID_ALIGNED_PTR
1679	* Pointer validation macro that also checks the alignment.
1680	* @param ptr The pointer.
1681	* @param align The alignment, must be a power of two.
1682	*/
1683	#define RT_VALID_ALIGNED_PTR(ptr, align) \
1684	( !((uintptr_t)(ptr) & (uintptr_t)((align) - 1)) \
1685	&& VALID_PTR(ptr) )
1686
1687
1688	/** @def VALID_PHYS32
1689	* 32 bits physical address validation macro.
1690	* @param Phys The RTGCPHYS address.
1691	*/
1692	#define VALID_PHYS32(Phys) ( (uint64_t)(Phys) < (uint64_t)_4G )
1693
1694	/** @def N_
1695	* The \#define N_ is used to mark a string for translation. This is usable in
1696	* any part of the code, as it is only used by the tools that create message
1697	* catalogs. This macro is a no-op as far as the compiler and code generation
1698	* is concerned.
1699	*
1700	* If you want to both mark a string for translation and translate it, use _().
1701	*/
1702	#define N_(s) (s)
1703
1704	/** @def _
1705	* The \#define _ is used to mark a string for translation and to translate it
1706	* in one step.
1707	*
1708	* If you want to only mark a string for translation, use N_().
1709	*/
1710	#define _(s) gettext(s)
1711
1712
1713	/** @def __PRETTY_FUNCTION__
1714	* With GNU C we'd like to use the builtin __PRETTY_FUNCTION__, so define that
1715	* for the other compilers.
1716	*/
1717	#if !defined(__GNUC__) && !defined(__PRETTY_FUNCTION__)
1718	# define __PRETTY_FUNCTION__ __FUNCTION__
1719	#endif
1720
1721
1722	/** @def RT_STRICT
1723	* The \#define RT_STRICT controls whether or not assertions and other runtime
1724	* checks should be compiled in or not.
1725	*
1726	* If you want assertions which are not subject to compile time options use
1727	* the AssertRelease*() flavors.
1728	*/
1729	#if !defined(RT_STRICT) && defined(DEBUG)
1730	# define RT_STRICT
1731	#endif
1732
1733	/** Source position. */
1734	#define RT_SRC_POS __FILE__, __LINE__, __PRETTY_FUNCTION__
1735
1736	/** Source position declaration. */
1737	#define RT_SRC_POS_DECL const char pszFile, unsigned iLine, const char pszFunction
1738
1739	/** Source position arguments. */
1740	#define RT_SRC_POS_ARGS pszFile, iLine, pszFunction
1741
1742	/** @} */
1743
1744
1745	/** @defgroup grp_rt_cdefs_cpp Special Macros for C++
1746	* @ingroup grp_rt_cdefs
1747	* @{
1748	*/
1749
1750	#ifdef __cplusplus
1751
1752	/** @def DECLEXPORT_CLASS
1753	* How to declare an exported class. Place this macro after the 'class'
1754	* keyword in the declaration of every class you want to export.
1755	*
1756	* @note It is necessary to use this macro even for inner classes declared
1757	* inside the already exported classes. This is a GCC specific requirement,
1758	* but it seems not to harm other compilers.
1759	*/
1760	#if defined(_MSC_VER) \|\| defined(RT_OS_OS2)
1761	# define DECLEXPORT_CLASS __declspec(dllexport)
1762	#elif defined(RT_USE_VISIBILITY_DEFAULT)
1763	# define DECLEXPORT_CLASS __attribute__((visibility("default")))
1764	#else
1765	# define DECLEXPORT_CLASS
1766	#endif
1767
1768	/** @def DECLIMPORT_CLASS
1769	* How to declare an imported class Place this macro after the 'class'
1770	* keyword in the declaration of every class you want to export.
1771	*
1772	* @note It is necessary to use this macro even for inner classes declared
1773	* inside the already exported classes. This is a GCC specific requirement,
1774	* but it seems not to harm other compilers.
1775	*/
1776	#if defined(_MSC_VER) \|\| (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__))
1777	# define DECLIMPORT_CLASS __declspec(dllimport)
1778	#elif defined(RT_USE_VISIBILITY_DEFAULT)
1779	# define DECLIMPORT_CLASS __attribute__((visibility("default")))
1780	#else
1781	# define DECLIMPORT_CLASS
1782	#endif
1783
1784	/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP
1785	* Macro to work around error C2593 of the not-so-smart MSVC 7.x ambiguity
1786	* resolver. The following snippet clearly demonstrates the code causing this
1787	* error:
1788	* @code
1789	* class A
1790	* {
1791	* public:
1792	* operator bool() const { return false; }
1793	* operator int*() const { return NULL; }
1794	* };
1795	* int main()
1796	* {
1797	* A a;
1798	* if (!a);
1799	* if (a && 0);
1800	* return 0;
1801	* }
1802	* @endcode
1803	* The code itself seems pretty valid to me and GCC thinks the same.
1804	*
1805	* This macro fixes the compiler error by explicitly overloading implicit
1806	* global operators !, && and \|\| that take the given class instance as one of
1807	* their arguments.
1808	*
1809	* The best is to use this macro right after the class declaration.
1810	*
1811	* @note The macro expands to nothing for compilers other than MSVC.
1812	*
1813	* @param Cls Class to apply the workaround to
1814	*/
1815	#if defined(_MSC_VER)
1816	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls) \
1817	inline bool operator! (const Cls &that) { return !bool (that); } \
1818	inline bool operator&& (const Cls &that, bool b) { return bool (that) && b; } \
1819	inline bool operator\|\| (const Cls &that, bool b) { return bool (that) \|\| b; } \
1820	inline bool operator&& (bool b, const Cls &that) { return b && bool (that); } \
1821	inline bool operator\|\| (bool b, const Cls &that) { return b \|\| bool (that); }
1822	#else
1823	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls)
1824	#endif
1825
1826	/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL
1827	* Version of WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP for template classes.
1828	*
1829	* @param Tpl Name of the template class to apply the workaround to
1830	* @param ArgsDecl arguments of the template, as declared in \|<>\| after the
1831	* \|template\| keyword, including \|<>\|
1832	* @param Args arguments of the template, as specified in \|<>\| after the
1833	* template class name when using the, including \|<>\|
1834	*
1835	* Example:
1836	* @code
1837	* // template class declaration
1838	* template <class C>
1839	* class Foo { ... };
1840	* // applied workaround
1841	* WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL (Foo, <class C>, <C>)
1842	* @endcode
1843	*/
1844	#if defined(_MSC_VER)
1845	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args) \
1846	template ArgsDecl \
1847	inline bool operator! (const Tpl Args &that) { return !bool (that); } \
1848	template ArgsDecl \
1849	inline bool operator&& (const Tpl Args &that, bool b) { return bool (that) && b; } \
1850	template ArgsDecl \
1851	inline bool operator\|\| (const Tpl Args &that, bool b) { return bool (that) \|\| b; } \
1852	template ArgsDecl \
1853	inline bool operator&& (bool b, const Tpl Args &that) { return b && bool (that); } \
1854	template ArgsDecl \
1855	inline bool operator\|\| (bool b, const Tpl Args &that) { return b \|\| bool (that); }
1856	#else
1857	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args)
1858	#endif
1859
1860
1861	/** @def DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP
1862	* Declares the copy constructor and the assignment operation as inlined no-ops
1863	* (non-existent functions) for the given class. Use this macro inside the
1864	* private section if you want to effectively disable these operations for your
1865	* class.
1866	*
1867	* @param Cls class name to declare for
1868	*/
1869
1870	#define DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(Cls) \
1871	inline Cls (const Cls &); \
1872	inline Cls &operator= (const Cls &);
1873
1874
1875	/** @def DECLARE_CLS_NEW_DELETE_NOOP
1876	* Declares the new and delete operations as no-ops (non-existent functions)
1877	* for the given class. Use this macro inside the private section if you want
1878	* to effectively limit creating class instances on the stack only.
1879	*
1880	* @note The destructor of the given class must not be virtual, otherwise a
1881	* compile time error will occur. Note that this is not a drawback: having
1882	* the virtual destructor for a stack-based class is absolutely useless
1883	* (the real class of the stack-based instance is always known to the compiler
1884	* at compile time, so it will always call the correct destructor).
1885	*
1886	* @param Cls class name to declare for
1887	*/
1888	#define DECLARE_CLS_NEW_DELETE_NOOP(Cls) \
1889	inline static void *operator new (size_t); \
1890	inline static void operator delete (void *);
1891
1892	#endif /* defined(__cplusplus) */
1893
1894	/** @} */
1895
1896	#endif
1897

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/iprt/cdefs.h@ 21139

Download in other formats: