cdefs.h@ 2413

Last change on this file since 2413 was 2358, checked in by vboxsync, 18 years ago
New VMDK code.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 41.3 KB

Line
1	/** @file
2	* InnoTek Portable Runtime - Common C and C++ definitions.
3	*/
4
5	/*
6	* Copyright (C) 2006 InnoTek Systemberatung GmbH
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 as published by the Free Software Foundation,
12	* in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
13	* distribution. VirtualBox OSE is distributed in the hope that it will
14	* be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* If you received this file as part of a commercial VirtualBox
17	* distribution, then only the terms of your commercial VirtualBox
18	* license agreement apply instead of the previous paragraph.
19	*/
20
21	#ifndef __iprt_cdefs_h__
22	#define __iprt_cdefs_h__
23
24
25	/** @defgroup grp_rt_cdefs InnoTek Portable Runtime Common Definitions and Macros
26	* @{
27	*/
28
29	/*
30	* Include sys/cdefs.h if present, if not define the stuff we need.
31	*/
32	#ifdef HAVE_SYS_CDEFS_H
33	# if defined(__LINUX__) && defined(__KERNEL__)
34	# error "oops"
35	# endif
36	# include <sys/cdefs.h>
37	#else
38
39	/** @def __BEGIN_DECLS
40	* Used to start a block of function declarations which are shared
41	* between C and C++ program.
42	*/
43
44	/** @def __END_DECLS
45	* Used to end a block of function declarations which are shared
46	* between C and C++ program.
47	*/
48
49	#if defined(__cplusplus)
50	# define __BEGIN_DECLS extern "C" {
51	# define __END_DECLS }
52	#else
53	# define __BEGIN_DECLS
54	# define __END_DECLS
55	#endif
56
57	#endif
58
59
60	/*
61	* Shut up DOXYGEN warnings and guide it properly thru the code.
62	*/
63	#ifdef __DOXYGEN__
64	#define __AMD64__
65	#define __X86__
66	#define IN_RING0
67	#define IN_RING3
68	#define IN_GC
69	#define IN_RT_GC
70	#define IN_RT_R0
71	#define IN_RT_R3
72	#define RT_STRICT
73	#define Breakpoint
74	#define RT_NO_DEPRECATED_MACROS
75	#define ARCH_BITS
76	#define HC_ARCH_BITS
77	#define R3_ARCH_BITS
78	#define R0_ARCH_BITS
79	#define GC_ARCH_BITS
80	#endif /* __DOXYGEN__ */
81
82	/** @def __X86__
83	* Indicates that we're compiling for the X86 architecture.
84	*/
85
86	/** @def __AMD64__
87	* Indicates that we're compiling for the AMD64 architecture.
88	*/
89	#if !defined(__X86__) && !defined(__AMD64__)
90	# if defined(__amd64__) \|\| defined(__x86_64__) \|\| defined(_M_X64)
91	# define __AMD64__
92	# elif defined(__i386__) \|\| defined(_M_IX86)
93	# define __X86__
94	# else
95	# error "Check what predefined stuff your compiler uses to indicate architecture."
96	# endif
97	#elif defined(__X86__) && defined(__AMD64__)
98	# error "Both __X86__ and __AMD64__ cannot be defined at the same time!"
99	#endif
100
101	/** @def IN_RING0
102	* Used to indicate that we're compiling code which is running
103	* in Ring-0 Host Context.
104	*/
105
106	/** @def IN_RING3
107	* Used to indicate that we're compiling code which is running
108	* in Ring-3 Host Context.
109	*/
110
111	/** @def IN_GC
112	* Used to indicate that we're compiling code which is running
113	* in Guest Context (implies R0).
114	*/
115	#if !defined(IN_RING3) && !defined(IN_RING0) && !defined(IN_GC)
116	# error "You must defined which context the compiled code should run in; IN_RING3, IN_RING0 or IN_GC"
117	#endif
118	#if (defined(IN_RING3) && (defined(IN_RING0) \|\| defined(IN_GC)) ) \
119	\|\| (defined(IN_RING0) && (defined(IN_RING3) \|\| defined(IN_GC)) ) \
120	\|\| (defined(IN_GC) && (defined(IN_RING3) \|\| defined(IN_RING0)) )
121	# error "Only one of the IN_RING3, IN_RING0, IN_GC defines should be defined."
122	#endif
123
124
125	/** @def ARCH_BITS
126	* Defines the bit count of the current context.
127	*/
128	#ifndef ARCH_BITS
129	# if defined(__AMD64__)
130	# define ARCH_BITS 64
131	# else
132	# define ARCH_BITS 32
133	# endif
134	#endif
135
136	/** @def HC_ARCH_BITS
137	* Defines the host architechture bit count.
138	*/
139	#ifndef HC_ARCH_BITS
140	# ifndef IN_GC
141	# define HC_ARCH_BITS ARCH_BITS
142	# else
143	# define HC_ARCH_BITS 32
144	# endif
145	#endif
146
147	/** @def R3_ARCH_BITS
148	* Defines the host ring-3 architechture bit count.
149	*/
150	#ifndef R3_ARCH_BITS
151	# ifdef IN_RING3
152	# define R3_ARCH_BITS ARCH_BITS
153	# else
154	# define R3_ARCH_BITS HC_ARCH_BITS
155	# endif
156	#endif
157
158	/** @def R0_ARCH_BITS
159	* Defines the host ring-0 architechture bit count.
160	*/
161	#ifndef R0_ARCH_BITS
162	# ifdef IN_RING0
163	# define R0_ARCH_BITS ARCH_BITS
164	# else
165	# define R0_ARCH_BITS HC_ARCH_BITS
166	# endif
167	#endif
168
169	/** @def GC_ARCH_BITS
170	* Defines the guest architechture bit count.
171	*/
172	#ifndef GC_ARCH_BITS
173	# ifdef IN_GC
174	# define GC_ARCH_BITS ARCH_BITS
175	# else
176	# define GC_ARCH_BITS 32
177	# endif
178	#endif
179
180
181	/** @def CTXTYPE
182	* Declare a type differently in GC, R3 and R0.
183	*
184	* @param GCType The GC type.
185	* @param R3Type The R3 type.
186	* @param R0Type The R0 type.
187	* @remark For pointers used only in one context use GCPTRTYPE(), HCPTRTYPE(), R3PTRTYPE() or R0PTRTYPE().
188	*/
189	#ifdef IN_GC
190	# define CTXTYPE(GCType, R3Type, R0Type) GCType
191	#elif defined(IN_RING3)
192	# define CTXTYPE(GCType, R3Type, R0Type) R3Type
193	#else
194	# define CTXTYPE(GCType, R3Type, R0Type) R0Type
195	#endif
196
197	/** @def GCTYPE
198	* Declare a type differently in GC and HC.
199	*
200	* @param GCType The GC type.
201	* @param HCType The HC type.
202	* @remark For pointers used only in one context use GCPTRTYPE(), HCPTRTYPE(), R3PTRTYPE() or R0PTRTYPE().
203	*/
204	#define GCTYPE(GCType, HCType) CTXTYPE(GCType, HCType, HCType)
205
206	/** @def GCPTRTYPE
207	* Declare a pointer which is used in GC but appears in structure(s) used by
208	* both HC and GC. The main purpose is to make sure structures have the same
209	* size when built for different architectures.
210	*
211	* @param GCType The GC type.
212	*/
213	#define GCPTRTYPE(GCType) CTXTYPE(GCType, RTGCPTR, RTGCPTR)
214
215	/** @def HCPTRTYPE
216	* Declare a pointer which is used in HC but appears in structure(s) used by
217	* both HC and GC. The main purpose is to make sure structures have the same
218	* size when built for different architectures.
219	*
220	* @param HCType The HC type.
221	*/
222	#define HCPTRTYPE(HCType) CTXTYPE(RTHCPTR, HCType, HCType)
223
224	/** @def R3PTRTYPE
225	* Declare a pointer which is used in R3 but appears in structure(s) used by
226	* both HC and GC. The main purpose is to make sure structures have the same
227	* size when built for different architectures.
228	*
229	* @param R3Type The R3 type.
230	*/
231	#define R3PTRTYPE(R3Type) CTXTYPE(RTHCUINTPTR, R3Type, RTHCUINTPTR)
232
233	/** @def R0PTRTYPE
234	* Declare a pointer which is used in R0 but appears in structure(s) used by
235	* both HC and GC. The main purpose is to make sure structures have the same
236	* size when built for different architectures.
237	*
238	* @param R0Type The R0 type.
239	*/
240	#define R0PTRTYPE(R0Type) CTXTYPE(RTHCUINTPTR, RTHCUINTPTR, R0Type)
241
242	/** @def CTXSUFF
243	* Adds the suffix of the current context to the passed in
244	* identifier name. The suffix is HC or GC.
245	*
246	* This is macro should only be used in shared code to avoid a forrest of ifdefs.
247	* @param var Identifier name.
248	*/
249	/** @def OTHERCTXSUFF
250	* Adds the suffix of the other context to the passed in
251	* identifier name. The suffix is HC or GC.
252	*
253	* This is macro should only be used in shared code to avoid a forrest of ifdefs.
254	* @param var Identifier name.
255	*/
256	#ifdef IN_GC
257	# define CTXSUFF(var) var##GC
258	# define OTHERCTXSUFF(var) var##HC
259	#else
260	# define CTXSUFF(var) var##HC
261	# define OTHERCTXSUFF(var) var##GC
262	#endif
263
264	/** @def CTXALLSUFF
265	* Adds the suffix of the current context to the passed in
266	* identifier name. The suffix is R3, R0 or GC.
267	*
268	* This is macro should only be used in shared code to avoid a forrest of ifdefs.
269	* @param var Identifier name.
270	*/
271	#ifdef IN_GC
272	# define CTXALLSUFF(var) var##GC
273	#elif defined(IN_RING0)
274	# define CTXALLSUFF(var) var##R0
275	#else
276	# define CTXALLSUFF(var) var##R3
277	#endif
278
279	/** @def CTXMID
280	* Adds the current context as a middle name of an identifier name
281	* The middle name is HC or GC.
282	*
283	* This is macro should only be used in shared code to avoid a forrest of ifdefs.
284	* @param first First name.
285	* @param last Surname.
286	*/
287	/** @def OTHERCTXMID
288	* Adds the other context as a middle name of an identifier name
289	* The middle name is HC or GC.
290	*
291	* This is macro should only be used in shared code to avoid a forrest of ifdefs.
292	* @param first First name.
293	* @param last Surname.
294	*/
295	#ifdef IN_GC
296	# define CTXMID(first, last) first##GC##last
297	# define OTHERCTXMID(first, last) first##HC##last
298	#else
299	# define CTXMID(first, last) first##HC##last
300	# define OTHERCTXMID(first, last) first##GC##last
301	#endif
302
303	/** @def CTXALLMID
304	* Adds the current context as a middle name of an identifier name
305	* The middle name is R3, R0 or GC.
306	*
307	* This is macro should only be used in shared code to avoid a forrest of ifdefs.
308	* @param first First name.
309	* @param last Surname.
310	*/
311	#ifdef IN_GC
312	# define CTXALLMID(first, last) first##GC##last
313	#elif defined(IN_RING0)
314	# define CTXALLMID(first, last) first##R0##last
315	#else
316	# define CTXALLMID(first, last) first##R3##last
317	#endif
318
319
320	/** @def R3STRING
321	* A macro which in GC and R0 will return a dummy string while in R3 it will return
322	* the parameter.
323	*
324	* This is typically used to wrap description strings in structures shared
325	* between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_RING3 mess.
326	*
327	* @param pR3String The R3 string. Only referenced in R3.
328	* @see R0STRING and GCSTRING
329	*/
330	#ifdef IN_RING3
331	# define R3STRING(pR3String) (pR3String)
332	#else
333	# define R3STRING(pR3String) ("<R3_STRING>")
334	#endif
335
336	/** @def R0STRING
337	* A macro which in GC and R3 will return a dummy string while in R0 it will return
338	* the parameter.
339	*
340	* This is typically used to wrap description strings in structures shared
341	* between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_RING0 mess.
342	*
343	* @param pR0String The R0 string. Only referenced in R0.
344	* @see R3STRING and GCSTRING
345	*/
346	#ifdef IN_RING0
347	# define R0STRING(pR0String) (pR0String)
348	#else
349	# define R0STRING(pR0String) ("<R0_STRING>")
350	#endif
351
352	/** @def GCSTRING
353	* A macro which in R3 and R0 will return a dummy string while in GC it will return
354	* the parameter.
355	*
356	* This is typically used to wrap description strings in structures shared
357	* between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_GC mess.
358	*
359	* @param pR0String The GC string. Only referenced in GC.
360	* @see R3STRING, R0STRING
361	*/
362	#ifdef IN_GC
363	# define GCSTRING(pR0String) (pGCString)
364	#else
365	# define GCSTRING(pR0String) ("<GC_STRING>")
366	#endif
367
368	/** @def HCSTRING
369	* Macro which in GC will return a dummy string while in HC will return
370	* the parameter.
371	*
372	* This is typically used to wrap description strings in structures shared
373	* between HC and GC. The intention is to avoid the \#ifdef IN_GC kludge.
374	*
375	* @param pHCString The HC string. Only referenced in HC.
376	* @deprecated Use R3STRING or R0STRING instead.
377	*/
378	#ifdef IN_GC
379	# define HCSTRING(pHCString) ("<HC_STRING>")
380	#else
381	# define HCSTRING(pHCString) (pHCString)
382	#endif
383
384
385	/** @def RTCALL
386	* The standard calling convention for the Runtime interfaces.
387	*/
388	#ifdef _MSC_VER
389	# define RTCALL __cdecl
390	#elif defined(__GNUC__) && defined(IN_RING0) && !(defined(__OS2__) \|\| defined(__AMD64__)) /* the latter is kernel/gcc */
391	# define RTCALL __attribute__((cdecl,regparm(0)))
392	#else
393	# define RTCALL
394	#endif
395
396	/** @def DECLEXPORT
397	* How to declare an exported function.
398	* @param type The return type of the function declaration.
399	*/
400	#if defined(_MSC_VER) \|\| defined(__OS2__)
401	# define DECLEXPORT(type) __declspec(dllexport) type
402	#else
403	# define DECLEXPORT(type) type
404	#endif
405
406	/** @def DECLIMPORT
407	* How to declare an imported function.
408	* @param type The return type of the function declaration.
409	*/
410	#if defined(_MSC_VER) \|\| defined(__OS2__)
411	# define DECLIMPORT(type) __declspec(dllimport) type
412	#else
413	# define DECLIMPORT(type) type
414	#endif
415
416	/** @def DECLASM
417	* How to declare an internal assembly function.
418	* @param type The return type of the function declaration.
419	*/
420	#ifdef __cplusplus
421	# ifdef _MSC_VER
422	# define DECLASM(type) extern "C" type __cdecl
423	# else
424	# define DECLASM(type) extern "C" type
425	# endif
426	#else
427	# ifdef _MSC_VER
428	# define DECLASM(type) type __cdecl
429	# else
430	# define DECLASM(type) type
431	# endif
432	#endif
433
434	/** @def DECLASMTYPE
435	* How to declare an internal assembly function type.
436	* @param type The return type of the function.
437	*/
438	#ifdef _MSC_VER
439	# define DECLASMTYPE(type) type __cdecl
440	#else
441	# define DECLASMTYPE(type) type
442	#endif
443
444	/** @def DECLCALLBACK
445	* How to declare an call back function type.
446	* @param type The return type of the function declaration.
447	*/
448	#define DECLCALLBACK(type) type RTCALL
449
450	/** @def DECLCALLBACKPTR
451	* How to declare an call back function pointer.
452	* @param type The return type of the function declaration.
453	* @param name The name of the variable member.
454	*/
455	#define DECLCALLBACKPTR(type, name) type (RTCALL * name)
456
457	/** @def DECLCALLBACKMEMBER
458	* How to declare an call back function pointer member.
459	* @param type The return type of the function declaration.
460	* @param name The name of the struct/union/class member.
461	*/
462	#define DECLCALLBACKMEMBER(type, name) type (RTCALL * name)
463
464	/** @def DECLR3CALLBACKMEMBER
465	* How to declare an call back function pointer member - R3 Ptr.
466	* @param type The return type of the function declaration.
467	* @param name The name of the struct/union/class member.
468	* @param args The argument list enclosed in parentheses.
469	*/
470	#ifdef IN_RING3
471	# define DECLR3CALLBACKMEMBER(type, name, args) type (RTCALL * name) args
472	#else
473	# define DECLR3CALLBACKMEMBER(type, name, args) RTR3PTR name
474	#endif
475
476	/** @def DECLGCCALLBACKMEMBER
477	* How to declare an call back function pointer member - GC Ptr.
478	* @param type The return type of the function declaration.
479	* @param name The name of the struct/union/class member.
480	* @param args The argument list enclosed in parentheses.
481	*/
482	#ifdef IN_GC
483	# define DECLGCCALLBACKMEMBER(type, name, args) type (RTCALL * name) args
484	#else
485	# define DECLGCCALLBACKMEMBER(type, name, args) RTGCPTR name
486	#endif
487
488	/** @def DECLR0CALLBACKMEMBER
489	* How to declare an call back function pointer member - R0 Ptr.
490	* @param type The return type of the function declaration.
491	* @param name The name of the struct/union/class member.
492	* @param args The argument list enclosed in parentheses.
493	*/
494	#ifdef IN_RING0
495	# define DECLR0CALLBACKMEMBER(type, name, args) type (RTCALL * name) args
496	#else
497	# define DECLR0CALLBACKMEMBER(type, name, args) RTR0PTR name
498	#endif
499
500	/** @def DECLINLINE
501	* How to declare a function as inline.
502	* @param type The return type of the function declaration.
503	*/
504	#ifdef __GNUC__
505	# define DECLINLINE(type) static inline type
506	#elif defined(__cplusplus)
507	# define DECLINLINE(type) inline type
508	#elif defined(_MSC_VER)
509	# define DECLINLINE(type) _inline type
510	#else
511	# define DECLINLINE(type) inline type
512	#endif
513
514
515	/** @def IN_RT_R0
516	* Used to indicate whether we're inside the same link module as
517	* the HC Ring-0 Runtime Library.
518	*/
519	/** @def RTR0DECL(type)
520	* Runtime Library HC Ring-0 export or import declaration.
521	* @param type The return type of the function declaration.
522	*/
523	#ifdef IN_RT_R0
524	# define RTR0DECL(type) DECLEXPORT(type) RTCALL
525	#else
526	# define RTR0DECL(type) DECLIMPORT(type) RTCALL
527	#endif
528
529	/** @def IN_RT_R3
530	* Used to indicate whether we're inside the same link module as
531	* the HC Ring-3 Runtime Library.
532	*/
533	/** @def RTR3DECL(type)
534	* Runtime Library HC Ring-3 export or import declaration.
535	* @param type The return type of the function declaration.
536	*/
537	#ifdef IN_RT_R3
538	# define RTR3DECL(type) DECLEXPORT(type) RTCALL
539	#else
540	# define RTR3DECL(type) DECLIMPORT(type) RTCALL
541	#endif
542
543	/** @def IN_RT_GC
544	* Used to indicate whether we're inside the same link module as
545	* the GC Runtime Library.
546	*/
547	/** @def RTGCDECL(type)
548	* Runtime Library HC Ring-3 export or import declaration.
549	* @param type The return type of the function declaration.
550	*/
551	#ifdef IN_RT_GC
552	# define RTGCDECL(type) DECLEXPORT(type) RTCALL
553	#else
554	# define RTGCDECL(type) DECLIMPORT(type) RTCALL
555	#endif
556
557	/** @def RTDECL(type)
558	* Runtime Library export or import declaration.
559	* Functions declared using this macro exists in all contexts.
560	* @param type The return type of the function declaration.
561	*/
562	#if defined(IN_RT_R3) \|\| defined(IN_RT_GC) \|\| defined(IN_RT_R0)
563	# define RTDECL(type) DECLEXPORT(type) RTCALL
564	#else
565	# define RTDECL(type) DECLIMPORT(type) RTCALL
566	#endif
567
568	/** @def RTDATADECL(type)
569	* Runtime Library export or import declaration.
570	* Data declared using this macro exists in all contexts.
571	* @param type The return type of the function declaration.
572	*/
573	#if defined(IN_RT_R3) \|\| defined(IN_RT_GC) \|\| defined(IN_RT_R0)
574	# define RTDATADECL(type) DECLEXPORT(type)
575	#else
576	# define RTDATADECL(type) DECLIMPORT(type)
577	#endif
578
579
580	/** @def RT_NOCRT
581	* Symbol name wrapper for the No-CRT bits.
582	*
583	* In order to coexist in the same process as other CRTs, we need to
584	* decorate the symbols such that they don't conflict the ones in the
585	* other CRTs. The result of such conflicts / duplicate symbols can
586	* confuse the dynamic loader on unix like systems.
587	*
588	* Define RT_WITHOUT_NOCRT_WRAPPERS to drop the wrapping.
589	*/
590	/** @def RT_NOCRT_STR
591	* Same as RT_NOCRT only it'll return a double quoted string of the result.
592	*/
593	#ifndef RT_WITHOUT_NOCRT_WRAPPERS
594	# define RT_NOCRT(name) nocrt_ ## name
595	# define RT_NOCRT_STR(name) "nocrt_" # name
596	#else
597	# define RT_NOCRT(name) name
598	# define RT_NOCRT_STR(name) #name
599	#endif
600
601
602
603	/** @def RT_LIKELY
604	* Give the compiler a hint that an expression is very likely to hold true.
605	*
606	* Some compilers support explicit branch prediction so that the CPU backend
607	* can hint the processor and also so that code blocks can be reordered such
608	* that the predicted path sees a more linear flow, thus improving cache
609	* behaviour, etc.
610	*
611	* IPRT provides the macros RT_LIKELY() and RT_UNLIKELY() as a way to utilize
612	* this compiler feature when present.
613	*
614	* A few notes about the usage:
615	*
616	* - Generally, use RT_UNLIKELY() with error condition checks (unless you
617	* have some _strong_ reason to do otherwise, in which case document it),
618	* and/or RT_LIKELY() with success condition checks, assuming you want
619	* to optimize for the success path.
620	*
621	* - Other than that, if you don't know the likelihood of a test succeeding
622	* from empirical or other 'hard' evidence, don't make predictions unless
623	* you happen to be a Dirk Gently.
624	*
625	* - These macros are meant to be used in places that get executed a lot. It
626	* is wasteful to make predictions in code that is executed seldomly (e.g.
627	* at subsystem initialization time) as the basic block reording that this
628	* affecs can often generate larger code.
629	*
630	* - Note that RT_SUCCESS() and RT_FAILURE() already makes use of RT_LIKELY()
631	* and RT_UNLIKELY(). Should you wish for prediction free status checks,
632	* use the RT_SUCCESS_NP() and RT_FAILURE_NP() macros instead.
633	*
634	*
635	* @returns the boolean result of the expression.
636	* @param expr The expression that's very likely to be true.
637	* @see RT_UNLIKELY
638	*/
639	/** @def RT_UNLIKELY
640	* Give the compiler a hint that an expression is highly unlikely hold true.
641	*
642	* See the usage instructions give in the RT_LIKELY() docs.
643	*
644	* @returns the boolean result of the expression.
645	* @param expr The expression that's very unlikely to be true.
646	* @see RT_LIKELY
647	*/
648	#if defined(__GNUC__)
649	# if __GNUC__ >= 3
650	# define RT_LIKELY(expr) __builtin_expect(!!(expr), 1)
651	# define RT_UNLIKELY(expr) __builtin_expect(!!(expr), 0)
652	# else
653	# define RT_LIKELY(expr) (expr)
654	# define RT_UNLIKELY(expr) (expr)
655	# endif
656	#else
657	# define RT_LIKELY(expr) (expr)
658	# define RT_UNLIKELY(expr) (expr)
659	#endif
660
661
662	/** @def RT_BIT
663	* Make a bitmask for one integer sized bit.
664	* @param bit Bit number.
665	*/
666	#define RT_BIT(bit) (1U << (bit))
667
668	/** @def RT_BIT_32
669	* Make a 32-bit bitmask for one bit.
670	* @param bit Bit number.
671	*/
672	#define RT_BIT_32(bit) (UINT32_C(1) << (bit))
673
674	/** @def RT_BIT_64
675	* Make a 64-bit bitmask for one bit.
676	* @param bit Bit number.
677	*/
678	#define RT_BIT_64(bit) (UINT64_C(1) << (bit))
679
680	/** @def RT_ALIGN
681	* Align macro.
682	* @param u Value to align.
683	* @param uAlignment The alignment. Power of two!
684	*
685	* @remark Be extremely careful when using this macro with type which sizeof != sizeof int.
686	* When possible use any of the other RT_ALIGN_* macros. And when that's not
687	* possible, make 101% sure that uAlignment is specified with a right sized type.
688	*
689	* Specifying an unsigned 32-bit alignment constant with a 64-bit value will give
690	* you a 32-bit return value!
691	*
692	* In short: Don't use this macro. Use RT_ALIGN_T() instead.
693	*/
694	#define RT_ALIGN(u, uAlignment) ( ((u) + ((uAlignment) - 1)) & ~((uAlignment) - 1) )
695
696	/** @def RT_ALIGN_T
697	* Align macro.
698	* @param u Value to align.
699	* @param uAlignment The alignment. Power of two!
700	* @param type Integer type to use while aligning.
701	* @remark This macro is the prefered alignment macro, it doesn't have any of the pitfalls RT_ALIGN has.
702	*/
703	#define RT_ALIGN_T(u, uAlignment, type) ( ((type)(u) + ((uAlignment) - 1)) & ~(type)((uAlignment) - 1) )
704
705	/** @def RT_ALIGN_32
706	* Align macro for a 32-bit value.
707	* @param u32 Value to align.
708	* @param uAlignment The alignment. Power of two!
709	*/
710	#define RT_ALIGN_32(u32, uAlignment) RT_ALIGN_T(u32, uAlignment, uint32_t)
711
712	/** @def RT_ALIGN_64
713	* Align macro for a 64-bit value.
714	* @param u64 Value to align.
715	* @param uAlignment The alignment. Power of two!
716	*/
717	#define RT_ALIGN_64(u64, uAlignment) RT_ALIGN_T(u64, uAlignment, uint64_t)
718
719	/** @def RT_ALIGN_Z
720	* Align macro for size_t.
721	* @param cb Value to align.
722	* @param uAlignment The alignment. Power of two!
723	*/
724	#define RT_ALIGN_Z(cb, uAlignment) RT_ALIGN_T(cb, uAlignment, size_t)
725
726	/** @def RT_ALIGN_P
727	* Align macro for pointers.
728	* @param pv Value to align.
729	* @param uAlignment The alignment. Power of two!
730	*/
731	#define RT_ALIGN_P(pv, uAlignment) RT_ALIGN_PT(pv, uAlignment, void *)
732
733	/** @def RT_ALIGN_PT
734	* Align macro for pointers with type cast.
735	* @param u Value to align.
736	* @param uAlignment The alignment. Power of two!
737	* @param CastType The type to cast the result to.
738	*/
739	#define RT_ALIGN_PT(u, uAlignment, CastType) ((CastType)RT_ALIGN_T(u, uAlignment, uintptr_t))
740
741	/** @def RT_ALIGN_R3PT
742	* Align macro for ring-3 pointers with type cast.
743	* @param u Value to align.
744	* @param uAlignment The alignment. Power of two!
745	* @param CastType The type to cast the result to.
746	*/
747	#define RT_ALIGN_R3PT(u, uAlignment, CastType) ((CastType)RT_ALIGN_T(u, uAlignment, RTR3UINTPTR))
748
749	/** @def RT_ALIGN_R0PT
750	* Align macro for ring-0 pointers with type cast.
751	* @param u Value to align.
752	* @param uAlignment The alignment. Power of two!
753	* @param CastType The type to cast the result to.
754	*/
755	#define RT_ALIGN_R0PT(u, uAlignment, CastType) ((CastType)RT_ALIGN_T(u, uAlignment, RTR0UINTPTR))
756
757	/** @def RT_ALIGN_GCPT
758	* Align macro for GC pointers with type cast.
759	* @param u Value to align.
760	* @param uAlignment The alignment. Power of two!
761	* @param CastType The type to cast the result to.
762	*/
763	#define RT_ALIGN_GCPT(u, uAlignment, CastType) ((CastType)RT_ALIGN_T(u, uAlignment, RTGCUINTPTR))
764
765
766	/** @def RT_OFFSETOF
767	* Our own special offsetof() variant.
768	*
769	* This differs from the usual offsetof() in that it's not relying on builtin
770	* compiler stuff and thus can use variables in arrays the structure may
771	* contain. If in this usful to determin the sizes of structures ending
772	* with a variable length field.
773	*
774	* @returns offset into the structure of the specified member.
775	* @param type Structure type.
776	* @param member Member.
777	*/
778	#define RT_OFFSETOF(type, member) ( (int)(uintptr_t)&( ((type )(void )0)->member) )
779
780	/** @def RT_SIZEOFMEMB
781	* Get the size of a structure member.
782	*
783	* @returns size of the structure member.
784	* @param type Structure type.
785	* @param member Member.
786	*/
787	#define RT_SIZEOFMEMB(type, member) ( sizeof(((type )(void )0)->member) )
788
789	/** @def RT_ELEMENTS
790	* Calcs the number of elements in an array.
791	* @returns Element count.
792	* @param aArray Array in question.
793	*/
794	#define RT_ELEMENTS(aArray) ( sizeof(aArray) / sizeof((aArray)[0]) )
795
796	/** @def RT_MAX
797	* Finds the maximum value.
798	* @returns The higher of the two.
799	* @param Value1 Value 1
800	* @param Value2 Value 2
801	*/
802	#define RT_MAX(Value1, Value2) ((Value1) >= (Value2) ? (Value1) : (Value2))
803
804	/** @def RT_MIN
805	* Finds the minimum value.
806	* @returns The lower of the two.
807	* @param Value1 Value 1
808	* @param Value2 Value 2
809	*/
810	#define RT_MIN(Value1, Value2) ((Value1) <= (Value2) ? (Value1) : (Value2))
811
812	/** @def RT_ABS
813	* Get the absolute (non-negative) value.
814	* @returns The absolute value of Value.
815	* @param Value The value.
816	*/
817	#define RT_ABS(Value) ((Value) >= 0 ? (Value) : -(Value))
818
819	/** @def RT_LOWORD
820	* Gets the low word (=uint16_t) of something. */
821	#define RT_LOWORD(a) ((a) & 0xffff)
822
823	/** @def RT_HIWORD
824	* Gets the high word (=uint16_t) of a 32 bit something. */
825	#define RT_HIWORD(a) ((a) >> 16)
826
827	/** @def RT_LOBYTE
828	* Gets the low byte of something. */
829	#define RT_LOBYTE(a) ((a) & 0xff)
830
831	/** @def RT_HIBYTE
832	* Gets the low byte of a 16 bit something. */
833	#define RT_HIBYTE(a) ((a) >> 8)
834
835	/** @def RT_BYTE1
836	* Gets first byte of something. */
837	#define RT_BYTE1(a) ((a) & 0xff)
838
839	/** @def RT_BYTE2
840	* Gets second byte of something. */
841	#define RT_BYTE2(a) (((a) >> 8) & 0xff)
842
843	/** @def RT_BYTE3
844	* Gets second byte of something. */
845	#define RT_BYTE3(a) (((a) >> 16) & 0xff)
846
847	/** @def RT_BYTE4
848	* Gets fourth byte of something. */
849	#define RT_BYTE4(a) (((a) >> 24) & 0xff)
850
851
852	/** @def RT_MAKE_U64
853	* Constructs a uint64_t value from two uint32_t values.
854	*/
855	#define RT_MAKE_U64(Lo, Hi) ( (uint64_t)((uint32_t)(Hi)) << 32 \| (uint32_t)(Lo) )
856
857	/** @def RT_MAKE_U64_FROM_U16
858	* Constructs a uint64_t value from four uint16_t values.
859	*/
860	#define RT_MAKE_U64_FROM_U16(w0, w1, w2, w3) \
861	( (uint64_t)((uint16_t)(w3)) << 48 \
862	\| (uint64_t)((uint16_t)(w2)) << 32 \
863	\| (uint32_t)((uint16_t)(w1)) << 16 \
864	\| (uint16_t)(w0) )
865
866	/** @def RT_MAKE_U64_FROM_U8
867	* Constructs a uint64_t value from eight uint8_t values.
868	*/
869	#define RT_MAKE_U64_FROM_U8(b0, b1, b2, b3, b4, b5, b6, b7) \
870	( (uint64_t)((uint8_t)(b7)) << 56 \
871	\| (uint64_t)((uint8_t)(b6)) << 48 \
872	\| (uint64_t)((uint8_t)(b5)) << 40 \
873	\| (uint64_t)((uint8_t)(b4)) << 32 \
874	\| (uint32_t)((uint8_t)(b3)) << 24 \
875	\| (uint32_t)((uint8_t)(b2)) << 16 \
876	\| (uint16_t)((uint8_t)(b1)) << 8 \
877	\| (uint8_t)(b0) )
878
879	/** @def RT_MAKE_U32
880	* Constructs a uint32_t value from two uint16_t values.
881	*/
882	#define RT_MAKE_U32(Lo, Hi) ( (uint32_t)((uint16_t)(Hi)) << 16 \| (uint16_t)(Lo) )
883
884	/** @def RT_MAKE_U32_FROM_U8
885	* Constructs a uint32_t value from four uint8_t values.
886	*/
887	#define RT_MAKE_U32_FROM_U8(b0, b1, b2, b3) \
888	( (uint32_t)((uint8_t)(b3)) << 24 \
889	\| (uint32_t)((uint8_t)(b2)) << 16 \
890	\| (uint16_t)((uint8_t)(b1)) << 8 \
891	\| (uint8_t)(b0) )
892	/** @todo remove this after uses in VUSBUrb.cpp has been corrected. */
893	#define MAKE_U32_FROM_U8(b0,b1,b2,b3) RT_MAKE_U32_FROM_U8(b0,b1,b2,b3)
894
895	/** @def RT_MAKE_U16
896	* Constructs a uint32_t value from two uint16_t values.
897	*/
898	#define RT_MAKE_U16(Lo, Hi) ( (uint16_t)((uint8_t)(Hi)) << 8 \| (uint8_t)(Lo) )
899
900
901	/** @def RT_H2LE_U64
902	* Converts uint64_t value from host to little endian byte order. */
903	#define RT_H2LE_U64(u64) (u64)
904
905	/** @def RT_H2LE_U32
906	* Converts uint32_t value from host to little endian byte order. */
907	#define RT_H2LE_U32(u32) (u32)
908
909	/** @def RT_H2LE_U16
910	* Converts uint16_t value from host to little endian byte order. */
911	#define RT_H2LE_U16(u16) (u16)
912
913	/** @def RT_LE2H_U64
914	* Converts uint64_t value from little endian to host byte order. */
915	#define RT_LE2H_U64(u64) (u64)
916
917	/** @def RT_LE2H_U32
918	* Converts uint32_t value from little endian to host byte order. */
919	#define RT_LE2H_U32(u32) (u32)
920
921	/** @def RT_LE2H_U16
922	* Converts uint16_t value from little endian to host byte order. */
923	#define RT_LE2H_U16(u16) (u16)
924
925
926	/** @def RT_H2BE_U64
927	* Converts uint64_t value from host to big endian byte order. */
928	#define RT_H2BE_U64(u64) RT_MAKE_U64_FROM_U32(RT_H2BE_U32((u64) >> 32), RT_H2BE_U32((u64) & 0xffffffff))
929
930	/** @def RT_H2BE_U32
931	* Converts uint32_t value from host to big endian byte order. */
932	#define RT_H2BE_U32(u32) (RT_BYTE4(u32) \| (RT_BYTE3(u32) << 8) \| (RT_BYTE2(u32) << 16) \| (RT_BYTE1(u32) << 24))
933
934	/** @def RT_H2BE_U16
935	* Converts uint16_t value from host to big endian byte order. */
936	#define RT_H2BE_U16(u16) (RT_HIBYTE(u16) \| (RT_LOBYTE(u16) << 8))
937
938	/** @def RT_BE2H_U64
939	* Converts uint64_t value from big endian to host byte order. */
940	#define RT_BE2H_U64(u64) RT_MAKE_U64_FROM_U32(RT_H2BE_U32((u64) >> 32), RT_H2BE_U32((u64) & 0xffffffff))
941
942	/** @def RT_BE2H_U32
943	* Converts uint32_t value from big endian to host byte order. */
944	#define RT_BE2H_U32(u32) (RT_BYTE4(u32) \| (RT_BYTE3(u32) << 8) \| (RT_BYTE2(u32) << 16) \| (RT_BYTE1(u32) << 24))
945
946	/** @def RT_BE2H_U16
947	* Converts uint16_t value from big endian to host byte order. */
948	#define RT_BE2H_U16(u16) (RT_HIBYTE(u16) \| (RT_LOBYTE(u16) << 8))
949
950
951	/** @def RT_H2N_U32
952	* Converts uint32_t value from host to network byte order. */
953	#define RT_H2N_U32(u32) RT_H2BE_U32(u32)
954
955	/** @def RT_H2N_U16
956	* Converts uint16_t value from host to network byte order. */
957	#define RT_H2N_U16(u16) RT_H2BE_U16(u16)
958
959	/** @def RT_N2H_U32
960	* Converts uint32_t value from network to host byte order. */
961	#define RT_N2H_U32(u32) RT_BE2H_U32(u32)
962
963	/** @def RT_N2H_U16
964	* Converts uint16_t value from network to host byte order. */
965	#define RT_N2H_U16(u16) RT_BE2H_U16(u16)
966
967
968	/** @def RT_NO_DEPRECATED_MACROS
969	* Define RT_NO_DEPRECATED_MACROS to not define deprecated macros.
970	*/
971	#ifndef RT_NO_DEPRECATED_MACROS
972	/** @copydoc BIT
973	* @deprecated Use RT_BIT.
974	*/
975	# define BIT(bit) RT_BIT(bit)
976	/** @deprecated Use RT_BIT64. */
977	# define BIT64(bit) (1ULL << (bit))
978	/** @copydoc RT_ALIGN_P
979	* @deprecated use RT_ALIGN_P. */
980	# define ALIGNP(pv, uAlignment) RT_ALIGN_P(pv, uAlignment)
981	/** @copydoc RT_SIZEOFMEMB
982	* @deprecated Use RT_SIZEOFMEMB. */
983	# define SIZEOFMEMB(type, member) RT_SIZEOFMEMB(type, member)
984	/** @copydoc RT_ELEMENTS
985	* @deprecated use RT_ELEMENTS. */
986	# define ELEMENTS(aArray) RT_ELEMENTS(aArray)
987	#endif
988
989
990	/*
991	* The BSD sys/param.h + machine/param.h file is a major source of
992	* namespace pollution. Kill off some of the worse ones unless we're
993	* compiling kernel code.
994	*/
995	#if defined(__DARWIN__) \
996	&& !defined(KERNEL) \
997	&& !defined(RT_NO_BSD_PARAM_H_UNDEFING) \
998	&& ( defined(_SYS_PARAM_H_) \|\| defined(_I386_PARAM_H_) )
999	/* sys/param.h: */
1000	# undef PSWP
1001	# undef PVM
1002	# undef PINOD
1003	# undef PRIBO
1004	# undef PVFS
1005	# undef PZERO
1006	# undef PSOCK
1007	# undef PWAIT
1008	# undef PLOCK
1009	# undef PPAUSE
1010	# undef PUSER
1011	# undef PRIMASK
1012	# undef MINBUCKET
1013	# undef MAXALLOCSAVE
1014	# undef FSHIFT
1015	# undef FSCALE
1016
1017	/* i386/machine.h: */
1018	# undef ALIGN
1019	# undef ALIGNBYTES
1020	# undef DELAY
1021	# undef STATUS_WORD
1022	# undef USERMODE
1023	# undef BASEPRI
1024	# undef MSIZE
1025	# undef CLSIZE
1026	# undef CLSIZELOG2
1027	#endif
1028
1029
1030	/** @def NULL
1031	* NULL pointer.
1032	*/
1033	#ifndef NULL
1034	# ifdef __cplusplus
1035	# define NULL 0
1036	# else
1037	# define NULL ((void*)0)
1038	# endif
1039	#endif
1040
1041	/** @def NIL_OFFSET
1042	* NIL offset.
1043	* Whenever we use offsets instead of pointers to save space and relocation effort
1044	* NIL_OFFSET shall be used as the equivalent to NULL.
1045	*/
1046	#define NIL_OFFSET (~0U)
1047
1048	/** @def NOREF
1049	* Keeps the compiler from bitching about an unused parameters.
1050	*/
1051	#define NOREF(var) (void)(var)
1052
1053	/** @def Breakpoint
1054	* Emit a debug breakpoint instruction.
1055	*
1056	* Use this for instrumenting a debugging session only!
1057	* No comitted code shall use Breakpoint().
1058	*/
1059	#ifdef __GNUC__
1060	# define Breakpoint() __asm__ __volatile__("int $3\n\t")
1061	#endif
1062	#ifdef _MSC_VER
1063	# define Breakpoint() __asm int 3
1064	#endif
1065	#ifndef Breakpoint
1066	# error "This compiler is not supported!"
1067	#endif
1068
1069
1070	/** Size Constants
1071	* (Of course, these are binary computer terms, not SI.)
1072	* @{
1073	*/
1074	/** 1 K (Kilo) (1 024). */
1075	#define _1K 0x00000400
1076	/** 4 K (Kilo) (4 096). */
1077	#define _4K 0x00001000
1078	/** 32 K (Kilo) (32 678). */
1079	#define _32K 0x00008000
1080	/** 64 K (Kilo) (65 536). */
1081	#define _64K 0x00010000
1082	/** 128 K (Kilo) (131 072). */
1083	#define _128K 0x00020000
1084	/** 256 K (Kilo) (262 144). */
1085	#define _256K 0x00040000
1086	/** 512 K (Kilo) (524 288). */
1087	#define _512K 0x00080000
1088	/** 1 M (Mega) (1 048 576). */
1089	#define _1M 0x00100000
1090	/** 2 M (Mega) (2 097 152). */
1091	#define _2M 0x00200000
1092	/** 4 M (Mega) (4 194 304). */
1093	#define _4M 0x00400000
1094	/** 1 G (Giga) (1 073 741 824). */
1095	#define _1G 0x40000000
1096	/** 2 G (Giga) (2 147 483 648). (32-bit) */
1097	#define _2G32 0x80000000U
1098	/** 2 G (Giga) (2 147 483 648). (64-bit) */
1099	#define _2G 0x0000000080000000LL
1100	/** 4 G (Giga) (4 294 967 296). */
1101	#define _4G 0x0000000100000000LL
1102	/** 1 T (Tera) (1 099 511 627 776). */
1103	#define _1T 0x0000010000000000LL
1104	/** 1 P (Peta) (1 125 899 906 842 624). */
1105	#define _1P 0x0004000000000000LL
1106	/** 1 E (Exa) (1 152 921 504 606 846 976). */
1107	#define _1E 0x1000000000000000LL
1108	/** 2 E (Exa) (2 305 843 009 213 693 952). */
1109	#define _2E 0x2000000000000000ULL
1110	/** @} */
1111
1112	/** @def VALID_PTR
1113	* Pointer validation macro.
1114	* @param ptr
1115	*/
1116	#if defined(__AMD64__)
1117	# ifdef IN_RING3
1118	# if defined(__DARWIN__) /* first 4GB is reserved for legacy kernel. */
1119	# define VALID_PTR(ptr) ( (uintptr_t)(ptr) >= _4G \
1120	&& !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
1121	# else
1122	# define VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
1123	&& !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
1124	# endif
1125	# else /* !IN_RING3 */
1126	# define VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
1127	&& ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
1128	\|\| ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
1129	# endif /* !IN_RING3 */
1130	#elif defined(__X86__)
1131	# define VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
1132	#else
1133	# error "Architecture identifier missing / not implemented."
1134	#endif
1135
1136
1137	/** @def N_
1138	* The \#define N_ is used mark a string for translation. This is usable in
1139	* any part of the code, as it is only used by the tools that create message
1140	* catalogs. This macro is a no-op as far as the compiler and code generation
1141	* is concerned.
1142	*
1143	* If you want to both mark a string for translation and translate it, use _.
1144	*/
1145	#define N_(s) (s)
1146
1147	/** @def _
1148	* The \#define _ is used mark a string for translation and to translate it in
1149	* one step.
1150	*
1151	* If you want to only mark a string for translation, use N_.
1152	*/
1153	#define _(s) gettext(s)
1154
1155
1156	/** @def __PRETTY_FUNCTION__
1157	* With GNU C we'd like to use the builtin __PRETTY_FUNCTION__, so define that for the other compilers.
1158	*/
1159	#if !defined(__GNUC__) && !defined(__PRETTY_FUNCTION__)
1160	# define __PRETTY_FUNCTION__ __FUNCTION__
1161	#endif
1162
1163
1164	/** @def RT_STRICT
1165	* The \#define RT_STRICT controls whether or not assertions and other runtime checks
1166	* should be compiled in or not.
1167	*
1168	* If you want assertions which are not a subject to compile time options use
1169	* the AssertRelease*() flavors.
1170	*/
1171	#if !defined(RT_STRICT) && defined(DEBUG)
1172	# define RT_STRICT
1173	#endif
1174
1175	/** Source position. */
1176	#define RT_SRC_POS __FILE__, __LINE__, __PRETTY_FUNCTION__
1177
1178	/** Source position declaration. */
1179	#define RT_SRC_POS_DECL const char pszFile, unsigned iLine, const char pszFunction
1180
1181	/** Source position arguments. */
1182	#define RT_SRC_POS_ARGS pszFile, iLine, pszFunction
1183
1184	/** @} */
1185
1186
1187	/** @defgroup grp_rt_cdefs_cpp Special Macros for C++
1188	* @ingroup grp_rt_cdefs
1189	* @{
1190	*/
1191
1192	#ifdef __cplusplus
1193
1194	/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP
1195	* Macro to work around error C2593 of the not-so-smart MSVC 7.x ambiguity
1196	* resolver. The following snippet clearly demonstrates the code causing this
1197	* error:
1198	* @code
1199	* class A
1200	* {
1201	* public:
1202	* operator bool() const { return false; }
1203	* operator int*() const { return NULL; }
1204	* };
1205	* int main()
1206	* {
1207	* A a;
1208	* if (!a);
1209	* if (a && 0);
1210	* return 0;
1211	* }
1212	* @endcode
1213	* The code itself seems pretty valid to me and GCC thinks the same.
1214	*
1215	* This macro fixes the compiler error by explicitly overloading implicit
1216	* global operators !, && and \|\| that take the given class instance as one of
1217	* their arguments.
1218	*
1219	* The best is to use this macro right after the class declaration.
1220	*
1221	* @note The macro expands to nothing for compilers other than MSVC.
1222	*
1223	* @param Cls Class to apply the workaround to
1224	*/
1225	#if defined(_MSC_VER)
1226	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls) \
1227	inline bool operator! (const Cls &that) { return !bool (that); } \
1228	inline bool operator&& (const Cls &that, bool b) { return bool (that) && b; } \
1229	inline bool operator\|\| (const Cls &that, bool b) { return bool (that) \|\| b; } \
1230	inline bool operator&& (bool b, const Cls &that) { return b && bool (that); } \
1231	inline bool operator\|\| (bool b, const Cls &that) { return b \|\| bool (that); }
1232	#else
1233	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls)
1234	#endif
1235
1236	/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL
1237	* Version of WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP for template classes.
1238	*
1239	* @param Tpl Name of the template class to apply the workaround to
1240	* @param ArgsDecl arguments of the template, as declared in \|<>\| after the
1241	* \|template\| keyword, including \|<>\|
1242	* @param Args arguments of the template, as specified in \|<>\| after the
1243	* template class name when using the, including \|<>\|
1244	*
1245	* Example:
1246	* @code
1247	* // template class declaration
1248	* template <class C>
1249	* class Foo { ... };
1250	* // applied workaround
1251	* WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL (Foo, <class C>, <C>)
1252	* @endcode
1253	*/
1254	#if defined(_MSC_VER)
1255	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args) \
1256	template ArgsDecl \
1257	inline bool operator! (const Tpl Args &that) { return !bool (that); } \
1258	template ArgsDecl \
1259	inline bool operator&& (const Tpl Args &that, bool b) { return bool (that) && b; } \
1260	template ArgsDecl \
1261	inline bool operator\|\| (const Tpl Args &that, bool b) { return bool (that) \|\| b; } \
1262	template ArgsDecl \
1263	inline bool operator&& (bool b, const Tpl Args &that) { return b && bool (that); } \
1264	template ArgsDecl \
1265	inline bool operator\|\| (bool b, const Tpl Args &that) { return b \|\| bool (that); }
1266	#else
1267	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args)
1268	#endif
1269
1270
1271	/** @def DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP
1272	* Declares the copy constructor and the assignment operation as inlined no-ops
1273	* (non-existent functions) for the given class. Use this macro inside the
1274	* private section if you want to effectively disable these operations for your
1275	* class.
1276	*
1277	* @param Cls class name to declare for
1278	*/
1279
1280	#define DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(Cls) \
1281	inline Cls (Cls &); \
1282	inline Cls &operator= (Cls &);
1283
1284
1285	/** @def DECLARE_CLS_NEW_DELETE_NOOP
1286	* Declares the new and delete operations as no-ops (non-existent functions)
1287	* for the given class. Use this macro inside the private section if you want
1288	* to effectively limit creating class instances on the stack only.
1289	*
1290	* @note The destructor of the given class must not be virtual, otherwise a
1291	* compile time error will occur. Note that this is not a drawback: having
1292	* the virtual destructor for a stack-based class is absolutely useless
1293	* (the real class of the stack-based instance is always known to the compiler
1294	* at compile time, so it will always call the correct destructor).
1295	*
1296	* @param Cls class name to declare for
1297	*/
1298	#define DECLARE_CLS_NEW_DELETE_NOOP(Cls) \
1299	inline static void *operator new (size_t); \
1300	inline static void operator delete (void *);
1301
1302
1303	/**
1304	* Shortcut to \|const_cast<C &>()\| that automatically derives the correct
1305	* type (class) for the const_cast template's argument from its own argument.
1306	* Can be used to temporarily cancel the \|const\| modifier on the left-hand side
1307	* of assignment expressions, like this:
1308	* @code
1309	* const Class that;
1310	* ...
1311	* unconst (that) = some_value;
1312	* @endcode
1313	*/
1314	template <class C>
1315	inline C &unconst (const C &that) { return const_cast <C &> (that); }
1316
1317
1318	/**
1319	* Shortcut to \|const_cast<C *>()\| that automatically derives the correct
1320	* type (class) for the const_cast template's argument from its own argument.
1321	* Can be used to temporarily cancel the \|const\| modifier on the left-hand side
1322	* of assignment expressions, like this:
1323	* @code
1324	* const Class *that;
1325	* ...
1326	* unconst (that) = some_value;
1327	* @endcode
1328	*/
1329	template <class C>
1330	inline C unconst (const C that) { return const_cast <C *> (that); }
1331
1332	#endif /* defined(__cplusplus) */
1333
1334	/** @} */
1335
1336	#endif
1337

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

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

Download in other formats: