]> git.saurik.com Git - apple/mdnsresponder.git/blob - mDNSShared/CommonServices.h
projects / apple / mdnsresponder.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
mDNSResponder-1310.80.1.tar.gz
[apple/mdnsresponder.git] / mDNSShared / CommonServices.h
1 /* -*- Mode: C; tab-width: 4 -*-
2 *
3 * Copyright (c) 1997-2004 Apple Computer, Inc. All rights reserved.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 //---------------------------------------------------------------------------------------------------------------------------
19 /*! @header CommonServices
20
21 Common Services for Mac OS X, Linux, Palm, Windows, and Windows CE.
22 */
23
24 #ifndef __COMMON_SERVICES__
25 #define __COMMON_SERVICES__
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 #if 0
32 #pragma mark == Target ==
33 #endif
34
35 //===========================================================================================================================
36 // Target
37 //===========================================================================================================================
38
39 // Macintosh
40
41 #if ( !defined( TARGET_OS_MAC ) )
42 #if ( ( macintosh || __MACH__ ) && !KERNEL )
43 // ConditionalMacros.h in CoreServices will define this TARGET_* flag.
44 #else
45 #define TARGET_OS_MAC 0
46 #endif
47 #endif
48
49 #if ( !defined( TARGET_API_MAC_OSX_KERNEL ) )
50 #if ( __MACH__ && KERNEL )
51 #define TARGET_API_MAC_OSX_KERNEL 1
52 #else
53 #define TARGET_API_MAC_OSX_KERNEL 0
54 #endif
55 #endif
56
57 // FreeBSD
58
59 #if ( !defined( TARGET_OS_FREEBSD ) )
60 #if ( defined( __FreeBSD__ ) )
61 #define TARGET_OS_FREEBSD 1
62 #else
63 #define TARGET_OS_FREEBSD 0
64 #endif
65 #endif
66
67 // Linux
68
69 #if ( !defined( TARGET_OS_LINUX ) )
70 #if ( defined( __linux__ ) )
71 #define TARGET_OS_LINUX 1
72 #else
73 #define TARGET_OS_LINUX 0
74 #endif
75 #endif
76
77 // Solaris
78
79 #if ( !defined( TARGET_OS_SOLARIS ) )
80 #if ( defined(solaris) || (defined(__SVR4) && defined(sun)) )
81 #define TARGET_OS_SOLARIS 1
82 #else
83 #define TARGET_OS_SOLARIS 0
84 #endif
85 #endif
86
87 // Palm
88
89 #if ( !defined( TARGET_OS_PALM ) )
90 #if ( defined( __PALMOS_TRAPS__ ) || defined( __PALMOS_ARMLET__ ) )
91 #define TARGET_OS_PALM 1
92 #else
93 #define TARGET_OS_PALM 0
94 #endif
95 #endif
96
97 // Windows
98
99 #if ( !defined( TARGET_OS_WIN32 ) )
100 #if ( macintosh || __MACH__ )
101 // ConditionalMacros.h in CoreServices will define this TARGET_* flag.
102 #else
103 #if ( defined( _WIN32 ) )
104 #define TARGET_OS_WIN32 1
105 #else
106 #define TARGET_OS_WIN32 0
107 #endif
108 #endif
109 #endif
110
111 // Windows CE
112
113 #if ( !defined( TARGET_OS_WINDOWS_CE ) )
114 #if ( defined( _WIN32_WCE ) )
115 #define TARGET_OS_WINDOWS_CE 1
116 #else
117 #define TARGET_OS_WINDOWS_CE 0
118 #endif
119 #endif
120
121 #if 0
122 #pragma mark == Includes ==
123 #endif
124
125 //===========================================================================================================================
126 // Includes
127 //===========================================================================================================================
128
129 #if ( !KERNEL )
130 #if defined(WIN32) && !defined(_WSPIAPI_COUNTOF)
131 #define _WSPIAPI_COUNTOF(_Array) (sizeof(_Array) / sizeof(_Array[0]))
132 #endif
133 #include <stddef.h>
134 #endif
135
136 #if ( ( macintosh || __MACH__ ) && !KERNEL )
137
138 #if ( defined( __MWERKS__ ) )
139 #if ( __option( c9x ) )
140 #include <stdbool.h>
141 #endif
142 #else
143 #include <stdbool.h>
144 #endif
145
146 #include <stdint.h>
147
148 #if ( __MACH__ )
149
150 // Mac OS X
151
152 #include <sys/types.h>
153 #include <netinet/in.h>
154 #include <arpa/inet.h>
155 #include <fcntl.h>
156 #include <pthread.h>
157 #include <sys/ioctl.h>
158 #include <sys/socket.h>
159 #include <unistd.h>
160
161 #else
162
163 // Classic Mac OS
164
165 #include <ConditionalMacros.h>
166 #include <MacTypes.h>
167
168 #endif
169
170 #elif ( KERNEL )
171
172 // Mac OS X Kernel
173
174 #include <stdint.h>
175
176 #include <libkern/OSTypes.h>
177 #include <sys/types.h>
178
179 #elif ( TARGET_OS_FREEBSD )
180
181 // FreeBSD
182 #include <stdint.h>
183 #include <pthread.h>
184 #include <netinet/in.h>
185 #include <arpa/inet.h>
186 #include <sys/socket.h>
187
188 #elif ( TARGET_OS_LINUX )
189
190 // Linux
191
192 #include <stdint.h>
193 #include <arpa/inet.h>
194
195 #elif ( TARGET_OS_SOLARIS )
196
197 // Solaris
198
199 #include <stdint.h>
200
201 #include <arpa/inet.h>
202 #include <arpa/nameser.h>
203
204 #if ( defined( BYTE_ORDER ) && defined( LITTLE_ENDIAN ) && ( BYTE_ORDER == LITTLE_ENDIAN ) )
205 #define TARGET_RT_LITTLE_ENDIAN 1
206 #endif
207 #if ( defined( BYTE_ORDER ) && defined( BIG_ENDIAN ) && ( BYTE_ORDER == BIG_ENDIAN ) )
208 #define TARGET_RT_BIG_ENDIAN 1
209 #endif
210
211 #elif ( TARGET_OS_PALM )
212
213 // Palm (no special includes yet).
214
215 #elif ( TARGET_OS_WIN32 )
216
217 // Windows
218
219 #if ( !defined( WIN32_WINDOWS ) )
220 #define WIN32_WINDOWS 0x0401
221 #endif
222
223 #if ( !defined( _WIN32_WINDOWS ) )
224 #define _WIN32_WINDOWS 0x0401
225 #endif
226
227 #if ( !defined( WIN32_LEAN_AND_MEAN ) )
228 #define WIN32_LEAN_AND_MEAN // Needed to avoid redefinitions by Windows interfaces.
229 #endif
230
231 #if ( defined( __MWERKS__ ) )
232
233 #if ( __option( c9x ) )
234 #include <stdbool.h>
235 #endif
236
237 #include <stdint.h>
238
239 #elif ( defined( _MSC_VER ) )
240
241 #if ( _MSC_VER >= 1900 )
242 #include <stdint.h>
243 #include <stdbool.h>
244 #endif
245
246 #pragma warning( disable:4127 ) // Disable "conditional expression is constant" warning for debug macros.
247 #pragma warning( disable:4706 ) // Disable "assignment within conditional expression" for Microsoft headers.
248
249 #endif
250
251 #include <windows.h>
252 #include <winsock2.h>
253 #include <Ws2tcpip.h>
254
255 #if ( defined( _MSC_VER ) )
256 #pragma warning( default:4706 )
257 #endif
258
259 #else
260 #error unknown OS - update this file to support your OS
261 #endif
262
263 #if ( !defined( TARGET_BUILD_MAIN ) )
264 #define TARGET_BUILD_MAIN 1
265 #endif
266
267 #if 0
268 #pragma mark == CPU ==
269 #endif
270
271 //===========================================================================================================================
272 // CPU
273 //===========================================================================================================================
274
275 // PowerPC
276
277 #if ( !defined( TARGET_CPU_PPC ) )
278 #if ( defined( __ppc__ ) || defined( __PPC__ ) || defined( powerpc ) || defined( ppc ) || defined( _M_MPPC ) )
279 #define TARGET_CPU_PPC 1
280 #else
281 #define TARGET_CPU_PPC 0
282 #endif
283 #endif
284
285 // x86
286
287 #if ( !defined( TARGET_CPU_X86 ) )
288 #if ( __INTEL__ || defined( __i386__ ) || defined( i386 ) || defined( intel ) || defined( _M_IX86 ) )
289 #define TARGET_CPU_X86 1
290 #else
291 #define TARGET_CPU_X86 0
292 #endif
293 #endif
294
295 // MIPS
296
297 #if ( !defined( TARGET_CPU_MIPS ) )
298 #if ( __MIPS__ || defined( MIPS32 ) || defined( R3000 ) || defined( R4000 ) || defined( R4650 ) || defined( _M_MRX000 ) )
299 #define TARGET_CPU_MIPS 1
300 #else
301 #define TARGET_CPU_MIPS 0
302 #endif
303 #endif
304
305 #if ( !defined( TARGET_CPU_PPC ) && !defined( TARGET_CPU_X86 ) && !defined( TARGET_CPU_MIPS ) )
306 #error unknown CPU - update this file to support your CPU
307 #endif
308
309 #if 0
310 #pragma mark == Byte Order ==
311 #endif
312
313 //===========================================================================================================================
314 // Byte Order
315 //===========================================================================================================================
316
317 // TARGET_RT_LITTLE_ENDIAN
318
319 #if ( !defined( TARGET_RT_LITTLE_ENDIAN ) )
320 #if ( MIPSEL || IL_LITTLE_ENDIAN || defined( __LITTLE_ENDIAN__ ) || \
321 ( defined( BYTE_ORDER ) && defined( LITTLE_ENDIAN ) && ( BYTE_ORDER == LITTLE_ENDIAN ) ) || \
322 ( defined( _BYTE_ORDER ) && defined( _LITTLE_ENDIAN ) && ( _BYTE_ORDER == _LITTLE_ENDIAN ) ) || \
323 ( defined( __BYTE_ORDER ) && defined( __LITTLE_ENDIAN ) && ( __BYTE_ORDER == __LITTLE_ENDIAN ) ) || \
324 TARGET_CPU_X86 || ( defined( TARGET_RT_BIG_ENDIAN ) && !TARGET_RT_BIG_ENDIAN ) )
325 #define TARGET_RT_LITTLE_ENDIAN 1
326 #else
327 #define TARGET_RT_LITTLE_ENDIAN 0
328 #endif
329 #endif
330
331 // TARGET_RT_BIG_ENDIAN
332
333 #if ( !defined( TARGET_RT_BIG_ENDIAN ) )
334 #if ( MIPSEB || IL_BIG_ENDIAN || defined( __BIG_ENDIAN__ ) || \
335 ( defined( BYTE_ORDER ) && defined( BIG_ENDIAN ) && ( BYTE_ORDER == BIG_ENDIAN ) ) || \
336 ( defined( _BYTE_ORDER ) && defined( _BIG_ENDIAN ) && ( _BYTE_ORDER == _BIG_ENDIAN ) ) || \
337 ( defined( __BYTE_ORDER ) && defined( __BIG_ENDIAN ) && ( __BYTE_ORDER == __BIG_ENDIAN ) ) || \
338 ( defined( TARGET_RT_LITTLE_ENDIAN ) && !TARGET_RT_LITTLE_ENDIAN ) )
339 #define TARGET_RT_BIG_ENDIAN 1
340 #else
341 #define TARGET_RT_BIG_ENDIAN 0
342 #endif
343 #endif
344
345 #if ( defined( TARGET_RT_LITTLE_ENDIAN ) && !defined( TARGET_RT_BIG_ENDIAN ) )
346 #if ( TARGET_RT_LITTLE_ENDIAN )
347 #define TARGET_RT_BIG_ENDIAN 0
348 #else
349 #define TARGET_RT_BIG_ENDIAN 1
350 #endif
351 #endif
352
353 #if ( defined( TARGET_RT_BIG_ENDIAN ) && !defined( TARGET_RT_LITTLE_ENDIAN ) )
354 #if ( TARGET_RT_BIG_ENDIAN )
355 #define TARGET_RT_LITTLE_ENDIAN 0
356 #else
357 #define TARGET_RT_LITTLE_ENDIAN 1
358 #endif
359 #endif
360
361 #if ( !defined( TARGET_RT_LITTLE_ENDIAN ) || !defined( TARGET_RT_BIG_ENDIAN ) )
362 #error unknown byte order - update this file to support your byte order
363 #endif
364
365 // TARGET_RT_BYTE_ORDER
366
367 #if ( !defined( TARGET_RT_BYTE_ORDER_BIG_ENDIAN ) )
368 #define TARGET_RT_BYTE_ORDER_BIG_ENDIAN 1234
369 #endif
370
371 #if ( !defined( TARGET_RT_BYTE_ORDER_LITTLE_ENDIAN ) )
372 #define TARGET_RT_BYTE_ORDER_LITTLE_ENDIAN 4321
373 #endif
374
375 #if ( !defined( TARGET_RT_BYTE_ORDER ) )
376 #if ( TARGET_RT_LITTLE_ENDIAN )
377 #define TARGET_RT_BYTE_ORDER TARGET_RT_BYTE_ORDER_LITTLE_ENDIAN
378 #else
379 #define TARGET_RT_BYTE_ORDER TARGET_RT_BYTE_ORDER_BIG_ENDIAN
380 #endif
381 #endif
382
383 #if 0
384 #pragma mark == Constants ==
385 #endif
386
387 //===========================================================================================================================
388 // Constants
389 //===========================================================================================================================
390
391 #if ( !TARGET_OS_MAC )
392 #define CR '\r'
393 #endif
394
395 #define LF '\n'
396 #define CRSTR "\r"
397 #define LFSTR "\n"
398 #define CRLF "\r\n"
399 #define CRCR "\r\r"
400
401 #if 0
402 #pragma mark == Compatibility ==
403 #endif
404
405 //===========================================================================================================================
406 // Compatibility
407 //===========================================================================================================================
408
409 // Macros to allow the same code to work on Windows and other sockets API-compatible platforms.
410
411 #if ( TARGET_OS_WIN32 )
412 #define close_compat( X ) closesocket( X )
413 #define errno_compat() (int) GetLastError()
414 #define set_errno_compat( X ) SetLastError( X )
415 #define EWOULDBLOCK_compat WSAEWOULDBLOCK
416 #define ETIMEDOUT_compat WSAETIMEDOUT
417 #define ENOTCONN_compat WSAENOTCONN
418 #define IsValidSocket( X ) ( ( X ) != INVALID_SOCKET )
419 #define kInvalidSocketRef INVALID_SOCKET
420 typedef SOCKET SocketRef;
421 #else
422 #define close_compat( X ) close( X )
423 #define errno_compat() errno
424 #define set_errno_compat( X ) do { errno = ( X ); } while( 0 )
425 #define EWOULDBLOCK_compat EWOULDBLOCK
426 #define ETIMEDOUT_compat ETIMEDOUT
427 #define ENOTCONN_compat ENOTCONN
428 #define IsValidSocket( X ) ( ( X ) >= 0 )
429 #define kInvalidSocketRef -1
430 typedef int SocketRef;
431 #endif
432
433 // socklen_t is not defined on the following platforms so emulate it if not defined:
434 //
435 // - Pre-Panther Mac OS X. Panther defines SO_NOADDRERR so trigger off that.
436 // - Windows SDK prior to 2003. 2003+ SDK's define EAI_AGAIN so trigger off that.
437
438 #if ( ( TARGET_OS_MAC && !defined( SO_NOADDRERR ) ) || ( TARGET_OS_WIN32 && !defined( EAI_AGAIN ) ) )
439 typedef int socklen_t;
440 #endif
441
442 // ssize_t is not defined on the following platforms so emulate it if not defined:
443 //
444 // - Mac OS X when not building with BSD headers
445 // - Windows
446
447 #if ( !defined(_SSIZE_T) && ( TARGET_OS_WIN32 || !defined( _BSD_SSIZE_T_DEFINED_ ) ) && !TARGET_OS_FREEBSD && !TARGET_OS_LINUX && !TARGET_OS_MAC)
448 typedef int ssize_t;
449 #endif
450
451 // sockaddr_storage is not supported on non-IPv6 machines so alias it to an IPv4-compatible structure.
452
453 #if ( !defined( AF_INET6 ) )
454 #define sockaddr_storage sockaddr_in
455 #define ss_family sin_family
456 #endif
457
458 //---------------------------------------------------------------------------------------------------------------------------
459 /*! @defined SOCKADDR_IS_IP_LOOPBACK
460
461 @abstract Determines if a sockaddr is an IPv4 or IPv6 loopback address (if IPv6 is supported).
462 */
463
464 #if ( defined( AF_INET6 ) )
465 #define SOCKADDR_IS_IP_LOOPBACK( SA ) \
466 ( ( (const struct sockaddr *)( SA ) )->sa_family == AF_INET ) \
467 ? ( ( (const struct sockaddr_in *)( SA ) )->sin_addr.s_addr == htonl( INADDR_LOOPBACK ) ) \
468 : ( ( (const struct sockaddr *)( SA ) )->sa_family == AF_INET6 ) \
469 ? IN6_IS_ADDR_LOOPBACK( &( (const struct sockaddr_in6 *)( SA ) )->sin6_addr ) \
470 : 0
471 #else
472 #define SOCKADDR_IS_IP_LOOPBACK( SA ) \
473 ( ( (const struct sockaddr *)( SA ) )->sa_family == AF_INET ) \
474 ? ( ( (const struct sockaddr_in *)( SA ) )->sin_addr.s_addr == htonl( INADDR_LOOPBACK ) ) \
475 : 0
476 #endif
477
478 //---------------------------------------------------------------------------------------------------------------------------
479 /*! @defined SOCKADDR_IS_IP_LINK_LOCAL
480
481 @abstract Determines if a sockaddr is an IPv4 or IPv6 link-local address (if IPv6 is supported).
482 */
483
484 #if ( defined( AF_INET6 ) )
485 #define SOCKADDR_IS_IP_LINK_LOCAL( SA ) \
486 ( ( ( (const struct sockaddr *)( SA ) )->sa_family == AF_INET ) \
487 ? ( ( ( (uint8_t *)( &( (const struct sockaddr_in *)( SA ) )->sin_addr ) )[ 0 ] == 169 ) && \
488 ( ( (uint8_t *)( &( (const struct sockaddr_in *)( SA ) )->sin_addr ) )[ 1 ] == 254 ) ) \
489 : IN6_IS_ADDR_LOOPBACK( &( (const struct sockaddr_in6 *)( SA ) )->sin6_addr ) )
490 #else
491 #define SOCKADDR_IS_IP_LINK_LOCAL( SA ) \
492 ( ( ( (const struct sockaddr *)( SA ) )->sa_family == AF_INET ) \
493 ? ( ( ( (uint8_t *)( &( (const struct sockaddr_in *)( SA ) )->sin_addr ) )[ 0 ] == 169 ) && \
494 ( ( (uint8_t *)( &( (const struct sockaddr_in *)( SA ) )->sin_addr ) )[ 1 ] == 254 ) ) \
495 : 0 )
496 #endif
497
498 // _beginthreadex and _endthreadex are not supported on Windows CE 2.1 or later (the C runtime issues with leaking
499 // resources have apparently been resolved and they seem to have just ripped out support for the API) so map it to
500 // CreateThread on Windows CE.
501
502 #if ( TARGET_OS_WINDOWS_CE )
503 #define _beginthreadex_compat( SECURITY_PTR, STACK_SIZE, START_ADDRESS, ARG_LIST, FLAGS, THREAD_ID_PTR ) \
504 (uintptr_t) CreateThread( SECURITY_PTR, STACK_SIZE, (LPTHREAD_START_ROUTINE) START_ADDRESS, ARG_LIST, FLAGS, \
505 (LPDWORD) THREAD_ID_PTR )
506
507 #define _endthreadex_compat( RESULT ) ExitThread( (DWORD) RESULT )
508 #elif ( TARGET_OS_WIN32 )
509 #define _beginthreadex_compat _beginthreadex
510 #define _endthreadex_compat _endthreadex
511 #endif
512
513 // The C99 "inline" keyword is not supported by Microsoft compilers, but they do support __inline so map it when needed.
514
515 #if ( defined( _MSC_VER ) )
516 #define inline_compat __inline
517 #else
518 #define inline_compat inline
519 #endif
520
521 // Calling conventions
522
523 #if ( !defined( CALLBACK_COMPAT ) )
524 #if ( TARGET_OS_WIN32 || TARGET_OS_WINDOWS_CE )
525 #define CALLBACK_COMPAT CALLBACK
526 #else
527 #define CALLBACK_COMPAT
528 #endif
529 #endif
530
531 #if 0
532 #pragma mark == Macros ==
533 #endif
534
535 //---------------------------------------------------------------------------------------------------------------------------
536 /*! @defined kSizeCString
537
538 @abstract A meta-value to pass to supported routines to indicate the size should be calculated with strlen.
539 */
540
541 #define kSizeCString ( (size_t) -1 )
542
543 //---------------------------------------------------------------------------------------------------------------------------
544 /*! @defined sizeof_array
545
546 @abstract Determines the number of elements in an array.
547 */
548
549 #define sizeof_array( X ) ( sizeof( X ) / sizeof( X[ 0 ] ) )
550
551 //---------------------------------------------------------------------------------------------------------------------------
552 /*! @defined sizeof_element
553
554 @abstract Determines the size of an array element.
555 */
556
557 #define sizeof_element( X ) sizeof( X[ 0 ] )
558
559 //---------------------------------------------------------------------------------------------------------------------------
560 /*! @defined sizeof_string
561
562 @abstract Determines the size of a constant C string, excluding the null terminator.
563 */
564
565 #define sizeof_string( X ) ( sizeof( ( X ) ) - 1 )
566
567 //---------------------------------------------------------------------------------------------------------------------------
568 /*! @defined sizeof_field
569
570 @abstract Determines the size of a field of a type.
571 */
572
573 #define sizeof_field( TYPE, FIELD ) sizeof( ( ( (TYPE *) 0 )->FIELD ) )
574
575 //---------------------------------------------------------------------------------------------------------------------------
576 /*! @function RoundUp
577
578 @abstract Rounds X up to a multiple of Y.
579 */
580
581 #define RoundUp( X, Y ) ( ( X ) + ( ( Y ) -( ( X ) % ( Y ) ) ) )
582
583 //---------------------------------------------------------------------------------------------------------------------------
584 /*! @function IsAligned
585
586 @abstract Returns non-zero if X is aligned to a Y byte boundary and 0 if not. Y must be a power of 2.
587 */
588
589 #define IsAligned( X, Y ) ( ( ( X ) &( ( Y ) -1 ) ) == 0 )
590
591 //---------------------------------------------------------------------------------------------------------------------------
592 /*! @function IsFieldAligned
593
594 @abstract Returns non-zero if FIELD of type TYPE is aligned to a Y byte boundary and 0 if not. Y must be a power of 2.
595 */
596
597 #define IsFieldAligned( X, TYPE, FIELD, Y ) IsAligned( ( (uintptr_t)( X ) ) + offsetof( TYPE, FIELD ), ( Y ) )
598
599 //---------------------------------------------------------------------------------------------------------------------------
600 /*! @function AlignDown
601
602 @abstract Aligns X down to a Y byte boundary. Y must be a power of 2.
603 */
604
605 #define AlignDown( X, Y ) ( ( X ) &~( ( Y ) -1 ) )
606
607 //---------------------------------------------------------------------------------------------------------------------------
608 /*! @function AlignUp
609
610 @abstract Aligns X up to a Y byte boundary. Y must be a power of 2.
611 */
612
613 #define AlignUp( X, Y ) ( ( ( X ) + ( ( Y ) -1 ) ) & ~( ( Y ) -1 ) )
614
615 //---------------------------------------------------------------------------------------------------------------------------
616 /*! @function Min
617
618 @abstract Returns the lesser of X and Y.
619 */
620
621 #if ( !defined( Min ) )
622 #define Min( X, Y ) ( ( ( X ) < ( Y ) ) ? ( X ) : ( Y ) )
623 #endif
624
625 //---------------------------------------------------------------------------------------------------------------------------
626 /*! @function Max
627
628 @abstract Returns the greater of X and Y.
629 */
630
631 #if ( !defined( Max ) )
632 #define Max( X, Y ) ( ( ( X ) > ( Y ) ) ? ( X ) : ( Y ) )
633 #endif
634
635 //---------------------------------------------------------------------------------------------------------------------------
636 /*! @function InsertBits
637
638 @abstract Inserts BITS (both 0 and 1 bits) into X, controlled by MASK and SHIFT, and returns the result.
639
640 @discussion
641
642 MASK is the bitmask of the bits in the final position.
643 SHIFT is the number of bits to shift left for 1 to reach the first bit position of MASK.
644
645 For example, if you wanted to insert 0x3 into the leftmost 4 bits of a 32-bit value:
646
647 InsertBits( 0, 0x3, 0xF0000000U, 28 ) == 0x30000000
648 */
649
650 #define InsertBits( X, BITS, MASK, SHIFT ) ( ( ( X ) &~( MASK ) ) | ( ( ( BITS ) << ( SHIFT ) ) & ( MASK ) ) )
651
652 //---------------------------------------------------------------------------------------------------------------------------
653 /*! @function ExtractBits
654
655 @abstract Extracts bits from X, controlled by MASK and SHIFT, and returns the result.
656
657 @discussion
658
659 MASK is the bitmask of the bits in the final position.
660 SHIFT is the number of bits to shift right to right justify MASK.
661
662 For example, if you had a 32-bit value (e.g. 0x30000000) wanted the left-most 4 bits (e.g. 3 in this example):
663
664 ExtractBits( 0x30000000U, 0xF0000000U, 28 ) == 0x3
665 */
666
667 #define ExtractBits( X, MASK, SHIFT ) ( ( ( X ) >> ( SHIFT ) ) & ( ( MASK ) >> ( SHIFT ) ) )
668
669 //---------------------------------------------------------------------------------------------------------------------------
670 /*! @function Stringify
671
672 @abstract Stringify's an expression.
673
674 @discussion
675
676 Stringify macros to process raw text passed via -D options to C string constants. The double-wrapping is necessary
677 because the C preprocessor doesn't perform its normal argument expansion pre-scan with stringified macros so the
678 -D macro needs to be expanded once via the wrapper macro then stringified so the raw text is stringified. Otherwise,
679 the replacement value would be used instead of the symbolic name (only for preprocessor symbols like #defines).
680
681 For example:
682
683 #define kMyConstant 1
684
685 printf( "%s", Stringify( kMyConstant ) ); // Prints "kMyConstant"
686 printf( "%s", StringifyExpansion( kMyConstant ) ); // Prints "1"
687
688 Non-preprocessor symbols do not have this issue. For example:
689
690 enum
691 {
692 kMyConstant = 1
693 };
694
695 printf( "%s", Stringify( kMyConstant ) ); // Prints "kMyConstant"
696 printf( "%s", StringifyExpansion( kMyConstant ) ); // Prints "kMyConstant"
697
698 See <http://gcc.gnu.org/onlinedocs/cpp/Argument-Prescan.html> for more info on C preprocessor pre-scanning.
699 */
700
701 #define Stringify( X ) # X
702 #define StringifyExpansion( X ) Stringify( X )
703
704 #if 0
705 #pragma mark == Types ==
706 #endif
707
708 //===========================================================================================================================
709 // Standard Types
710 //===========================================================================================================================
711
712 #if ( !defined( INT8_MIN ) )
713
714 #define INT8_MIN SCHAR_MIN
715
716 #if ( defined( _MSC_VER ) )
717
718 // C99 stdint.h not supported in VC++/VS.NET yet.
719
720 typedef INT8 int8_t;
721 typedef UINT8 uint8_t;
722 typedef INT16 int16_t;
723 typedef UINT16 uint16_t;
724 typedef INT32 int32_t;
725 typedef UINT32 uint32_t;
726 typedef __int64 int64_t;
727 typedef unsigned __int64 uint64_t;
728 #endif
729
730 typedef int8_t int_least8_t;
731 typedef int16_t int_least16_t;
732 typedef int32_t int_least32_t;
733 typedef int64_t int_least64_t;
734
735 typedef uint8_t uint_least8_t;
736 typedef uint16_t uint_least16_t;
737 typedef uint32_t uint_least32_t;
738 typedef uint64_t uint_least64_t;
739
740 typedef int8_t int_fast8_t;
741 typedef int16_t int_fast16_t;
742 typedef int32_t int_fast32_t;
743 typedef int64_t int_fast64_t;
744
745 typedef uint8_t uint_fast8_t;
746 typedef uint16_t uint_fast16_t;
747 typedef uint32_t uint_fast32_t;
748 typedef uint64_t uint_fast64_t;
749
750 #if ( !defined( _MSC_VER ) || TARGET_OS_WINDOWS_CE )
751 typedef long int intptr_t;
752 typedef unsigned long int uintptr_t;
753 #endif
754
755 #endif
756
757 // Macros for minimum-width integer constants
758
759 #if ( !defined( INT8_C ) )
760 #define INT8_C( value ) value
761 #endif
762
763 #if ( !defined( INT16_C ) )
764 #define INT16_C( value ) value
765 #endif
766
767 #if ( !defined( INT32_C ) )
768 #define INT32_C( value ) value ## L
769 #endif
770
771 #if ( !defined( INT64_C ) )
772 #if ( defined( _MSC_VER ) )
773 #define INT64_C( value ) value ## i64
774 #else
775 #define INT64_C( value ) value ## LL
776 #endif
777 #endif
778
779 #if ( !defined( UINT8_C ) )
780 #define UINT8_C( value ) value ## U
781 #endif
782
783 #if ( !defined( UINT16_C ) )
784 #define UINT16_C( value ) value ## U
785 #endif
786
787 #if ( !defined( UINT32_C ) )
788 #define UINT32_C( value ) value ## UL
789 #endif
790
791 #if ( !defined( UINT64_C ) )
792 #if ( defined( _MSC_VER ) )
793 #define UINT64_C( value ) value ## UI64
794 #else
795 #define UINT64_C( value ) value ## ULL
796 #endif
797 #endif
798
799 // Limits
800
801 #if( !defined( UINT32_MAX ) )
802 #define UINT32_MAX UINT32_C( 4294967295 )
803 #endif
804
805 #if 0
806 #pragma mark == bool ==
807 #endif
808
809 //===========================================================================================================================
810 // Boolean Constants and Types
811 //===========================================================================================================================
812
813 // C++ defines bool, true, and false. Metrowerks allows this to be controlled by the "bool" option though.
814 // C99 defines __bool_true_false_are_defined when bool, true, and false are defined.
815 // MacTypes.h defines true and false (Mac builds only).
816 //
817 // Note: The Metrowerks has to be in its own block because Microsoft Visual Studio .NET does not completely
818 // short-circuit and gets confused by the option( bool ) portion of the conditional.
819
820 #if ( defined( __MWERKS__ ) )
821
822 // Note: The following test is done on separate lines because CodeWarrior doesn't like it all on one line.
823
824 #if ( !__bool_true_false_are_defined && ( !defined( __cplusplus ) || !__option( bool ) ) )
825 #define COMMON_SERVICES_NEEDS_BOOL 1
826 #else
827 #define COMMON_SERVICES_NEEDS_BOOL 0
828 #endif
829
830 // Workaround when building with CodeWarrior, but using the Apple stdbool.h header, which uses _Bool.
831
832 #if ( __bool_true_false_are_defined && !defined( __cplusplus ) && !__option( c9x ) )
833 #define _Bool int
834 #endif
835
836 // Workaround when building with CodeWarrior for C++ with bool disabled and using the Apple stdbool.h header,
837 // which defines true and false to map to C++ true and false (which are not enabled). Serenity Now!
838
839 #if ( __bool_true_false_are_defined && defined( __cplusplus ) && !__option( bool ) )
840 #define true 1
841 #define false 0
842 #endif
843 #else
844 #if ( !defined( __cplusplus ) && !__bool_true_false_are_defined )
845 #define COMMON_SERVICES_NEEDS_BOOL 1
846 #else
847 #define COMMON_SERVICES_NEEDS_BOOL 0
848 #endif
849 #endif
850
851 #if ( COMMON_SERVICES_NEEDS_BOOL )
852
853 typedef int bool;
854
855 #define bool bool
856
857 #if ( !defined( __MACTYPES__ ) && !defined( true ) && !defined( false ) )
858 #define true 1
859 #define false 0
860 #endif
861
862 #define __bool_true_false_are_defined 1
863 #endif
864
865 // IOKit IOTypes.h typedef's bool if TYPE_BOOL is not defined so define it here to prevent redefinition by IOTypes.h.
866
867 #if ( TARGET_API_MAC_OSX_KERNEL )
868 #define TYPE_BOOL 1
869 #endif
870
871 //---------------------------------------------------------------------------------------------------------------------------
872 /*! @typedef CStr255
873
874 @abstract 255 character null-terminated (C-style) string.
875 */
876
877 typedef char CStr255[ 256 ];
878
879 //---------------------------------------------------------------------------------------------------------------------------
880 /*! @defined TYPE_LONGLONG_NATIVE
881
882 @abstract Defines whether long long (or its equivalent) is natively supported or requires special libraries.
883 */
884
885 #if ( !defined( TYPE_LONGLONG_NATIVE ) )
886 #define TYPE_LONGLONG_NATIVE 1
887 #endif
888
889 //---------------------------------------------------------------------------------------------------------------------------
890 /*! @defined long_long_compat
891
892 @abstract Compatibility type to map to the closest thing to long long and unsigned long long.
893
894 @discussion
895
896 Neither long long nor unsigned long long are supported by Microsoft compilers, but they do support proprietary
897 "__int64" and "unsigned __int64" equivalents so map to those types if the real long long is not supported.
898 */
899
900 #if ( TARGET_OS_WIN32 )
901 typedef __int64 long_long_compat;
902 typedef unsigned __int64 unsigned_long_long_compat;
903 #else
904 typedef signed long long long_long_compat;
905 typedef unsigned long long unsigned_long_long_compat;
906 #endif
907
908 #if 0
909 #pragma mark == Errors ==
910 #endif
911
912 //---------------------------------------------------------------------------------------------------------------------------
913 /*! @enum OSStatus
914
915 @abstract Status Code
916
917 @constant kNoErr 0 No error occurred.
918 @constant kInProgressErr 1 Operation in progress.
919 @constant kUnknownErr -6700 Unknown error occurred.
920 @constant kOptionErr -6701 Option was not acceptable.
921 @constant kSelectorErr -6702 Selector passed in is invalid or unknown.
922 @constant kExecutionStateErr -6703 Call made in the wrong execution state (e.g. called at interrupt time).
923 @constant kPathErr -6704 Path is invalid, too long, or otherwise not usable.
924 @constant kParamErr -6705 Parameter is incorrect, missing, or not appropriate.
925 @constant kParamCountErr -6706 Incorrect or unsupported number of parameters.
926 @constant kCommandErr -6707 Command invalid or not supported.
927 @constant kIDErr -6708 Unknown, invalid, or inappropriate identifier.
928 @constant kStateErr -6709 Not in appropriate state to perform operation.
929 @constant kRangeErr -6710 Index is out of range or not valid.
930 @constant kRequestErr -6711 Request was improperly formed or not appropriate.
931 @constant kResponseErr -6712 Response was incorrect or out of sequence.
932 @constant kChecksumErr -6713 Checksum does not match the actual data.
933 @constant kNotHandledErr -6714 Operation was not handled (or not handled completely).
934 @constant kVersionErr -6715 Version is not incorrect or not compatibile.
935 @constant kSignatureErr -6716 Signature did not match what was expected.
936 @constant kFormatErr -6717 Unknown, invalid, or inappropriate file/data format.
937 @constant kNotInitializedErr -6718 Action request before needed services were initialized.
938 @constant kAlreadyInitializedErr -6719 Attempt made to initialize when already initialized.
939 @constant kNotInUseErr -6720 Object not in use (e.g. cannot abort if not already in use).
940 @constant kInUseErr -6721 Object is in use (e.g. cannot reuse active param blocks).
941 @constant kTimeoutErr -6722 Timeout occurred.
942 @constant kCanceledErr -6723 Operation canceled (successful cancel).
943 @constant kAlreadyCanceledErr -6724 Operation has already been canceled.
944 @constant kCannotCancelErr -6725 Operation could not be canceled (maybe already done or invalid).
945 @constant kDeletedErr -6726 Object has already been deleted.
946 @constant kNotFoundErr -6727 Something was not found.
947 @constant kNoMemoryErr -6728 Not enough memory was available to perform the operation.
948 @constant kNoResourcesErr -6729 Resources unavailable to perform the operation.
949 @constant kDuplicateErr -6730 Duplicate found or something is a duplicate.
950 @constant kImmutableErr -6731 Entity is not changeable.
951 @constant kUnsupportedDataErr -6732 Data is unknown or not supported.
952 @constant kIntegrityErr -6733 Data is corrupt.
953 @constant kIncompatibleErr -6734 Data is not compatible or it is in an incompatible format.
954 @constant kUnsupportedErr -6735 Feature or option is not supported.
955 @constant kUnexpectedErr -6736 Error occurred that was not expected.
956 @constant kValueErr -6737 Value is not appropriate.
957 @constant kNotReadableErr -6738 Could not read or reading is not allowed.
958 @constant kNotWritableErr -6739 Could not write or writing is not allowed.
959 @constant kBadReferenceErr -6740 An invalid or inappropriate reference was specified.
960 @constant kFlagErr -6741 An invalid, inappropriate, or unsupported flag was specified.
961 @constant kMalformedErr -6742 Something was not formed correctly.
962 @constant kSizeErr -6743 Size was too big, too small, or not appropriate.
963 @constant kNameErr -6744 Name was not correct, allowed, or appropriate.
964 @constant kNotReadyErr -6745 Device or service is not ready.
965 @constant kReadErr -6746 Could not read.
966 @constant kWriteErr -6747 Could not write.
967 @constant kMismatchErr -6748 Something does not match.
968 @constant kDateErr -6749 Date is invalid or out-of-range.
969 @constant kUnderrunErr -6750 Less data than expected.
970 @constant kOverrunErr -6751 More data than expected.
971 @constant kEndingErr -6752 Connection, session, or something is ending.
972 @constant kConnectionErr -6753 Connection failed or could not be established.
973 @constant kAuthenticationErr -6754 Authentication failed or is not supported.
974 @constant kOpenErr -6755 Could not open file, pipe, device, etc.
975 @constant kTypeErr -6756 Incorrect or incompatible type (e.g. file, data, etc.).
976 @constant kSkipErr -6757 Items should be or was skipped.
977 @constant kNoAckErr -6758 No acknowledge.
978 @constant kCollisionErr -6759 Collision occurred (e.g. two on bus at same time).
979 @constant kBackoffErr -6760 Backoff in progress and operation intentionally failed.
980 @constant kNoAddressAckErr -6761 No acknowledge of address.
981 @constant kBusyErr -6762 Cannot perform because something is busy.
982 @constant kNoSpaceErr -6763 Not enough space to perform operation.
983 */
984
985 #if ( !TARGET_OS_MAC && !TARGET_API_MAC_OSX_KERNEL )
986 typedef int32_t OSStatus;
987 #endif
988
989 #define kNoErr 0
990 #define kInProgressErr 1
991
992 // Generic error codes are in the range -6700 to -6779.
993
994 #define kGenericErrorBase -6700 // Starting error code for all generic errors.
995
996 #define kUnknownErr -6700
997 #define kOptionErr -6701
998 #define kSelectorErr -6702
999 #define kExecutionStateErr -6703
1000 #define kPathErr -6704
1001 #define kParamErr -6705
1002 #define kParamCountErr -6706
1003 #define kCommandErr -6707
1004 #define kIDErr -6708
1005 #define kStateErr -6709
1006 #define kRangeErr -6710
1007 #define kRequestErr -6711
1008 #define kResponseErr -6712
1009 #define kChecksumErr -6713
1010 #define kNotHandledErr -6714
1011 #define kVersionErr -6715
1012 #define kSignatureErr -6716
1013 #define kFormatErr -6717
1014 #define kNotInitializedErr -6718
1015 #define kAlreadyInitializedErr -6719
1016 #define kNotInUseErr -6720
1017 #define kInUseErr -6721
1018 #define kTimeoutErr -6722
1019 #define kCanceledErr -6723
1020 #define kAlreadyCanceledErr -6724
1021 #define kCannotCancelErr -6725
1022 #define kDeletedErr -6726
1023 #define kNotFoundErr -6727
1024 #define kNoMemoryErr -6728
1025 #define kNoResourcesErr -6729
1026 #define kDuplicateErr -6730
1027 #define kImmutableErr -6731
1028 #define kUnsupportedDataErr -6732
1029 #define kIntegrityErr -6733
1030 #define kIncompatibleErr -6734
1031 #define kUnsupportedErr -6735
1032 #define kUnexpectedErr -6736
1033 #define kValueErr -6737
1034 #define kNotReadableErr -6738
1035 #define kNotWritableErr -6739
1036 #define kBadReferenceErr -6740
1037 #define kFlagErr -6741
1038 #define kMalformedErr -6742
1039 #define kSizeErr -6743
1040 #define kNameErr -6744
1041 #define kNotReadyErr -6745
1042 #define kReadErr -6746
1043 #define kWriteErr -6747
1044 #define kMismatchErr -6748
1045 #define kDateErr -6749
1046 #define kUnderrunErr -6750
1047 #define kOverrunErr -6751
1048 #define kEndingErr -6752
1049 #define kConnectionErr -6753
1050 #define kAuthenticationErr -6754
1051 #define kOpenErr -6755
1052 #define kTypeErr -6756
1053 #define kSkipErr -6757
1054 #define kNoAckErr -6758
1055 #define kCollisionErr -6759
1056 #define kBackoffErr -6760
1057 #define kNoAddressAckErr -6761
1058 #define kBusyErr -6762
1059 #define kNoSpaceErr -6763
1060
1061 #define kGenericErrorEnd -6779 // Last generic error code (inclusive)
1062
1063 #if 0
1064 #pragma mark == Mac Compatibility ==
1065 #endif
1066
1067 //===========================================================================================================================
1068 // Mac Compatibility
1069 //===========================================================================================================================
1070
1071 //---------------------------------------------------------------------------------------------------------------------------
1072 /*! @enum Duration
1073
1074 @abstract Type used to specify a duration of time.
1075
1076 @constant kDurationImmediate Indicates no delay/wait time.
1077 @constant kDurationMicrosecond Microsecond units.
1078 @constant kDurationMillisecond Millisecond units.
1079 @constant kDurationSecond Second units.
1080 @constant kDurationMinute Minute units.
1081 @constant kDurationHour Hour units.
1082 @constant kDurationDay Day units.
1083 @constant kDurationForever Infinite period of time (no timeout).
1084
1085 @discussion
1086
1087 Duration values are intended to be multiplied by the specific interval to achieve an actual duration. For example,
1088 to wait for 5 seconds you would use "5 * kDurationSecond".
1089 */
1090
1091 #if ( !TARGET_OS_MAC )
1092 typedef int32_t Duration;
1093 #endif
1094
1095 #define kDurationImmediate 0L
1096 #define kDurationMicrosecond -1L
1097 #define kDurationMillisecond 1L
1098 #define kDurationSecond ( 1000L * kDurationMillisecond )
1099 #define kDurationMinute ( 60L * kDurationSecond )
1100 #define kDurationHour ( 60L * kDurationMinute )
1101 #define kDurationDay ( 24L * kDurationHour )
1102 #define kDurationForever 0x7FFFFFFFL
1103
1104 // Seconds <-> Minutes <-> Hours <-> Days <-> Weeks <-> Months <-> Years conversions
1105
1106 #define kNanosecondsPerMicrosecond 1000
1107 #define kNanosecondsPerMillisecond 1000000
1108 #define kNanosecondsPerSecond 1000000000
1109 #define kMicrosecondsPerSecond 1000000
1110 #define kMicrosecondsPerMillisecond 1000
1111 #define kMillisecondsPerSecond 1000
1112 #define kSecondsPerMinute 60
1113 #define kSecondsPerHour ( 60 * 60 ) // 3600
1114 #define kSecondsPerDay ( 60 * 60 * 24 ) // 86400
1115 #define kSecondsPerWeek ( 60 * 60 * 24 * 7 ) // 604800
1116 #define kMinutesPerHour 60
1117 #define kMinutesPerDay ( 60 * 24 ) // 1440
1118 #define kHoursPerDay 24
1119 #define kDaysPerWeek 7
1120 #define kWeeksPerYear 52
1121 #define kMonthsPerYear 12
1122
1123 //---------------------------------------------------------------------------------------------------------------------------
1124 /*! @defined VersionStages
1125
1126 @abstract NumVersion-style version stages.
1127 */
1128
1129 #define kVersionStageDevelopment 0x20
1130 #define kVersionStageAlpha 0x40
1131 #define kVersionStageBeta 0x60
1132 #define kVersionStageFinal 0x80
1133
1134 //---------------------------------------------------------------------------------------------------------------------------
1135 /*! @function NumVersionBuild
1136
1137 @abstract Builds a 32-bit Mac-style NumVersion value (e.g. NumVersionBuild( 1, 2, 3, kVersionStageBeta, 4 ) -> 1.2.3b4).
1138 */
1139
1140 #define NumVersionBuild( MAJOR, MINOR, BUGFIX, STAGE, REV ) \
1141 ( ( ( ( MAJOR ) & 0xFF ) << 24 ) | \
1142 ( ( ( MINOR ) & 0x0F ) << 20 ) | \
1143 ( ( ( BUGFIX ) & 0x0F ) << 16 ) | \
1144 ( ( ( STAGE ) & 0xFF ) << 8 ) | \
1145 ( ( ( REV ) & 0xFF ) ) )
1146
1147 #define NumVersionExtractMajor( VERSION ) ( (uint8_t)( ( ( VERSION ) >> 24 ) & 0xFF ) )
1148 #define NumVersionExtractMinorAndBugFix( VERSION ) ( (uint8_t)( ( ( VERSION ) >> 16 ) & 0xFF ) )
1149 #define NumVersionExtractMinor( VERSION ) ( (uint8_t)( ( ( VERSION ) >> 20 ) & 0x0F ) )
1150 #define NumVersionExtractBugFix( VERSION ) ( (uint8_t)( ( ( VERSION ) >> 16 ) & 0x0F ) )
1151 #define NumVersionExtractStage( VERSION ) ( (uint8_t)( ( ( VERSION ) >> 8 ) & 0xFF ) )
1152 #define NumVersionExtractRevision( VERSION ) ( (uint8_t)( ( VERSION ) & 0xFF ) )
1153
1154 //---------------------------------------------------------------------------------------------------------------------------
1155 /*! @function NumVersionCompare
1156
1157 @abstract Compares two NumVersion values and returns the following values:
1158
1159 left < right -> -1
1160 left > right -> 1
1161 left = right -> 0
1162 */
1163
1164 int NumVersionCompare( uint32_t inLeft, uint32_t inRight );
1165
1166 #if 0
1167 #pragma mark == Binary Constants ==
1168 #endif
1169
1170 //---------------------------------------------------------------------------------------------------------------------------
1171 /*! @defined binary_4
1172
1173 @abstract Macro to generate an 4-bit constant using binary notation (e.g. binary_4( 1010 ) == 0xA).
1174 */
1175
1176 #define binary_4( a ) binary_4_hex_wrap( hex_digit4( a ) )
1177 #define binary_4_hex_wrap( a ) binary_4_hex( a )
1178 #define binary_4_hex( a ) ( 0x ## a )
1179
1180 //---------------------------------------------------------------------------------------------------------------------------
1181 /*! @defined binary_8
1182
1183 @abstract Macro to generate an 8-bit constant using binary notation (e.g. binary_8( 01111011 ) == 0x7B).
1184 */
1185
1186 #define binary_8( a ) binary_8_hex_wrap( hex_digit8( a ) )
1187 #define binary_8_hex_wrap( a ) binary_8_hex( a )
1188 #define binary_8_hex( a ) ( 0x ## a )
1189
1190 //---------------------------------------------------------------------------------------------------------------------------
1191 /*! @defined binary_16
1192
1193 @abstract Macro to generate an 16-bit constant using binary notation (e.g. binary_16( 01111011, 01111011 ) == 0x7B7B).
1194 */
1195
1196 #define binary_16( a, b ) binary_16_hex_wrap( hex_digit8( a ), hex_digit8( b ) )
1197 #define binary_16_hex_wrap( a, b ) binary_16_hex( a, b )
1198 #define binary_16_hex( a, b ) ( 0x ## a ## b )
1199
1200 //---------------------------------------------------------------------------------------------------------------------------
1201 /*! @defined binary_32
1202
1203 @abstract Macro to generate an 32-bit constant using binary notation
1204 (e.g. binary_32( 01111011, 01111011, 01111011, 01111011 ) == 0x7B7B7B7B).
1205 */
1206
1207 #define binary_32( a, b, c, d ) binary_32_hex_wrap( hex_digit8( a ), hex_digit8( b ), hex_digit8( c ), hex_digit8( d ) )
1208 #define binary_32_hex_wrap( a, b, c, d ) binary_32_hex( a, b, c, d )
1209 #define binary_32_hex( a, b, c, d ) ( 0x ## a ## b ## c ## d )
1210
1211 // Binary Constant Helpers
1212
1213 #define hex_digit8( a ) HEX_DIGIT_ ## a
1214 #define hex_digit4( a ) HEX_DIGIT_ ## 0000 ## a
1215
1216 #define HEX_DIGIT_00000000 00
1217 #define HEX_DIGIT_00000001 01
1218 #define HEX_DIGIT_00000010 02
1219 #define HEX_DIGIT_00000011 03
1220 #define HEX_DIGIT_00000100 04
1221 #define HEX_DIGIT_00000101 05
1222 #define HEX_DIGIT_00000110 06
1223 #define HEX_DIGIT_00000111 07
1224 #define HEX_DIGIT_00001000 08
1225 #define HEX_DIGIT_00001001 09
1226 #define HEX_DIGIT_00001010 0A
1227 #define HEX_DIGIT_00001011 0B
1228 #define HEX_DIGIT_00001100 0C
1229 #define HEX_DIGIT_00001101 0D
1230 #define HEX_DIGIT_00001110 0E
1231 #define HEX_DIGIT_00001111 0F
1232 #define HEX_DIGIT_00010000 10
1233 #define HEX_DIGIT_00010001 11
1234 #define HEX_DIGIT_00010010 12
1235 #define HEX_DIGIT_00010011 13
1236 #define HEX_DIGIT_00010100 14
1237 #define HEX_DIGIT_00010101 15
1238 #define HEX_DIGIT_00010110 16
1239 #define HEX_DIGIT_00010111 17
1240 #define HEX_DIGIT_00011000 18
1241 #define HEX_DIGIT_00011001 19
1242 #define HEX_DIGIT_00011010 1A
1243 #define HEX_DIGIT_00011011 1B
1244 #define HEX_DIGIT_00011100 1C
1245 #define HEX_DIGIT_00011101 1D
1246 #define HEX_DIGIT_00011110 1E
1247 #define HEX_DIGIT_00011111 1F
1248 #define HEX_DIGIT_00100000 20
1249 #define HEX_DIGIT_00100001 21
1250 #define HEX_DIGIT_00100010 22
1251 #define HEX_DIGIT_00100011 23
1252 #define HEX_DIGIT_00100100 24
1253 #define HEX_DIGIT_00100101 25
1254 #define HEX_DIGIT_00100110 26
1255 #define HEX_DIGIT_00100111 27
1256 #define HEX_DIGIT_00101000 28
1257 #define HEX_DIGIT_00101001 29
1258 #define HEX_DIGIT_00101010 2A
1259 #define HEX_DIGIT_00101011 2B
1260 #define HEX_DIGIT_00101100 2C
1261 #define HEX_DIGIT_00101101 2D
1262 #define HEX_DIGIT_00101110 2E
1263 #define HEX_DIGIT_00101111 2F
1264 #define HEX_DIGIT_00110000 30
1265 #define HEX_DIGIT_00110001 31
1266 #define HEX_DIGIT_00110010 32
1267 #define HEX_DIGIT_00110011 33
1268 #define HEX_DIGIT_00110100 34
1269 #define HEX_DIGIT_00110101 35
1270 #define HEX_DIGIT_00110110 36
1271 #define HEX_DIGIT_00110111 37
1272 #define HEX_DIGIT_00111000 38
1273 #define HEX_DIGIT_00111001 39
1274 #define HEX_DIGIT_00111010 3A
1275 #define HEX_DIGIT_00111011 3B
1276 #define HEX_DIGIT_00111100 3C
1277 #define HEX_DIGIT_00111101 3D
1278 #define HEX_DIGIT_00111110 3E
1279 #define HEX_DIGIT_00111111 3F
1280 #define HEX_DIGIT_01000000 40
1281 #define HEX_DIGIT_01000001 41
1282 #define HEX_DIGIT_01000010 42
1283 #define HEX_DIGIT_01000011 43
1284 #define HEX_DIGIT_01000100 44
1285 #define HEX_DIGIT_01000101 45
1286 #define HEX_DIGIT_01000110 46
1287 #define HEX_DIGIT_01000111 47
1288 #define HEX_DIGIT_01001000 48
1289 #define HEX_DIGIT_01001001 49
1290 #define HEX_DIGIT_01001010 4A
1291 #define HEX_DIGIT_01001011 4B
1292 #define HEX_DIGIT_01001100 4C
1293 #define HEX_DIGIT_01001101 4D
1294 #define HEX_DIGIT_01001110 4E
1295 #define HEX_DIGIT_01001111 4F
1296 #define HEX_DIGIT_01010000 50
1297 #define HEX_DIGIT_01010001 51
1298 #define HEX_DIGIT_01010010 52
1299 #define HEX_DIGIT_01010011 53
1300 #define HEX_DIGIT_01010100 54
1301 #define HEX_DIGIT_01010101 55
1302 #define HEX_DIGIT_01010110 56
1303 #define HEX_DIGIT_01010111 57
1304 #define HEX_DIGIT_01011000 58
1305 #define HEX_DIGIT_01011001 59
1306 #define HEX_DIGIT_01011010 5A
1307 #define HEX_DIGIT_01011011 5B
1308 #define HEX_DIGIT_01011100 5C
1309 #define HEX_DIGIT_01011101 5D
1310 #define HEX_DIGIT_01011110 5E
1311 #define HEX_DIGIT_01011111 5F
1312 #define HEX_DIGIT_01100000 60
1313 #define HEX_DIGIT_01100001 61
1314 #define HEX_DIGIT_01100010 62
1315 #define HEX_DIGIT_01100011 63
1316 #define HEX_DIGIT_01100100 64
1317 #define HEX_DIGIT_01100101 65
1318 #define HEX_DIGIT_01100110 66
1319 #define HEX_DIGIT_01100111 67
1320 #define HEX_DIGIT_01101000 68
1321 #define HEX_DIGIT_01101001 69
1322 #define HEX_DIGIT_01101010 6A
1323 #define HEX_DIGIT_01101011 6B
1324 #define HEX_DIGIT_01101100 6C
1325 #define HEX_DIGIT_01101101 6D
1326 #define HEX_DIGIT_01101110 6E
1327 #define HEX_DIGIT_01101111 6F
1328 #define HEX_DIGIT_01110000 70
1329 #define HEX_DIGIT_01110001 71
1330 #define HEX_DIGIT_01110010 72
1331 #define HEX_DIGIT_01110011 73
1332 #define HEX_DIGIT_01110100 74
1333 #define HEX_DIGIT_01110101 75
1334 #define HEX_DIGIT_01110110 76
1335 #define HEX_DIGIT_01110111 77
1336 #define HEX_DIGIT_01111000 78
1337 #define HEX_DIGIT_01111001 79
1338 #define HEX_DIGIT_01111010 7A
1339 #define HEX_DIGIT_01111011 7B
1340 #define HEX_DIGIT_01111100 7C
1341 #define HEX_DIGIT_01111101 7D
1342 #define HEX_DIGIT_01111110 7E
1343 #define HEX_DIGIT_01111111 7F
1344 #define HEX_DIGIT_10000000 80
1345 #define HEX_DIGIT_10000001 81
1346 #define HEX_DIGIT_10000010 82
1347 #define HEX_DIGIT_10000011 83
1348 #define HEX_DIGIT_10000100 84
1349 #define HEX_DIGIT_10000101 85
1350 #define HEX_DIGIT_10000110 86
1351 #define HEX_DIGIT_10000111 87
1352 #define HEX_DIGIT_10001000 88
1353 #define HEX_DIGIT_10001001 89
1354 #define HEX_DIGIT_10001010 8A
1355 #define HEX_DIGIT_10001011 8B
1356 #define HEX_DIGIT_10001100 8C
1357 #define HEX_DIGIT_10001101 8D
1358 #define HEX_DIGIT_10001110 8E
1359 #define HEX_DIGIT_10001111 8F
1360 #define HEX_DIGIT_10010000 90
1361 #define HEX_DIGIT_10010001 91
1362 #define HEX_DIGIT_10010010 92
1363 #define HEX_DIGIT_10010011 93
1364 #define HEX_DIGIT_10010100 94
1365 #define HEX_DIGIT_10010101 95
1366 #define HEX_DIGIT_10010110 96
1367 #define HEX_DIGIT_10010111 97
1368 #define HEX_DIGIT_10011000 98
1369 #define HEX_DIGIT_10011001 99
1370 #define HEX_DIGIT_10011010 9A
1371 #define HEX_DIGIT_10011011 9B
1372 #define HEX_DIGIT_10011100 9C
1373 #define HEX_DIGIT_10011101 9D
1374 #define HEX_DIGIT_10011110 9E
1375 #define HEX_DIGIT_10011111 9F
1376 #define HEX_DIGIT_10100000 A0
1377 #define HEX_DIGIT_10100001 A1
1378 #define HEX_DIGIT_10100010 A2
1379 #define HEX_DIGIT_10100011 A3
1380 #define HEX_DIGIT_10100100 A4
1381 #define HEX_DIGIT_10100101 A5
1382 #define HEX_DIGIT_10100110 A6
1383 #define HEX_DIGIT_10100111 A7
1384 #define HEX_DIGIT_10101000 A8
1385 #define HEX_DIGIT_10101001 A9
1386 #define HEX_DIGIT_10101010 AA
1387 #define HEX_DIGIT_10101011 AB
1388 #define HEX_DIGIT_10101100 AC
1389 #define HEX_DIGIT_10101101 AD
1390 #define HEX_DIGIT_10101110 AE
1391 #define HEX_DIGIT_10101111 AF
1392 #define HEX_DIGIT_10110000 B0
1393 #define HEX_DIGIT_10110001 B1
1394 #define HEX_DIGIT_10110010 B2
1395 #define HEX_DIGIT_10110011 B3
1396 #define HEX_DIGIT_10110100 B4
1397 #define HEX_DIGIT_10110101 B5
1398 #define HEX_DIGIT_10110110 B6
1399 #define HEX_DIGIT_10110111 B7
1400 #define HEX_DIGIT_10111000 B8
1401 #define HEX_DIGIT_10111001 B9
1402 #define HEX_DIGIT_10111010 BA
1403 #define HEX_DIGIT_10111011 BB
1404 #define HEX_DIGIT_10111100 BC
1405 #define HEX_DIGIT_10111101 BD
1406 #define HEX_DIGIT_10111110 BE
1407 #define HEX_DIGIT_10111111 BF
1408 #define HEX_DIGIT_11000000 C0
1409 #define HEX_DIGIT_11000001 C1
1410 #define HEX_DIGIT_11000010 C2
1411 #define HEX_DIGIT_11000011 C3
1412 #define HEX_DIGIT_11000100 C4
1413 #define HEX_DIGIT_11000101 C5
1414 #define HEX_DIGIT_11000110 C6
1415 #define HEX_DIGIT_11000111 C7
1416 #define HEX_DIGIT_11001000 C8
1417 #define HEX_DIGIT_11001001 C9
1418 #define HEX_DIGIT_11001010 CA
1419 #define HEX_DIGIT_11001011 CB
1420 #define HEX_DIGIT_11001100 CC
1421 #define HEX_DIGIT_11001101 CD
1422 #define HEX_DIGIT_11001110 CE
1423 #define HEX_DIGIT_11001111 CF
1424 #define HEX_DIGIT_11010000 D0
1425 #define HEX_DIGIT_11010001 D1
1426 #define HEX_DIGIT_11010010 D2
1427 #define HEX_DIGIT_11010011 D3
1428 #define HEX_DIGIT_11010100 D4
1429 #define HEX_DIGIT_11010101 D5
1430 #define HEX_DIGIT_11010110 D6
1431 #define HEX_DIGIT_11010111 D7
1432 #define HEX_DIGIT_11011000 D8
1433 #define HEX_DIGIT_11011001 D9
1434 #define HEX_DIGIT_11011010 DA
1435 #define HEX_DIGIT_11011011 DB
1436 #define HEX_DIGIT_11011100 DC
1437 #define HEX_DIGIT_11011101 DD
1438 #define HEX_DIGIT_11011110 DE
1439 #define HEX_DIGIT_11011111 DF
1440 #define HEX_DIGIT_11100000 E0
1441 #define HEX_DIGIT_11100001 E1
1442 #define HEX_DIGIT_11100010 E2
1443 #define HEX_DIGIT_11100011 E3
1444 #define HEX_DIGIT_11100100 E4
1445 #define HEX_DIGIT_11100101 E5
1446 #define HEX_DIGIT_11100110 E6
1447 #define HEX_DIGIT_11100111 E7
1448 #define HEX_DIGIT_11101000 E8
1449 #define HEX_DIGIT_11101001 E9
1450 #define HEX_DIGIT_11101010 EA
1451 #define HEX_DIGIT_11101011 EB
1452 #define HEX_DIGIT_11101100 EC
1453 #define HEX_DIGIT_11101101 ED
1454 #define HEX_DIGIT_11101110 EE
1455 #define HEX_DIGIT_11101111 EF
1456 #define HEX_DIGIT_11110000 F0
1457 #define HEX_DIGIT_11110001 F1
1458 #define HEX_DIGIT_11110010 F2
1459 #define HEX_DIGIT_11110011 F3
1460 #define HEX_DIGIT_11110100 F4
1461 #define HEX_DIGIT_11110101 F5
1462 #define HEX_DIGIT_11110110 F6
1463 #define HEX_DIGIT_11110111 F7
1464 #define HEX_DIGIT_11111000 F8
1465 #define HEX_DIGIT_11111001 F9
1466 #define HEX_DIGIT_11111010 FA
1467 #define HEX_DIGIT_11111011 FB
1468 #define HEX_DIGIT_11111100 FC
1469 #define HEX_DIGIT_11111101 FD
1470 #define HEX_DIGIT_11111110 FE
1471 #define HEX_DIGIT_11111111 FF
1472
1473 #if 0
1474 #pragma mark == Debugging ==
1475 #endif
1476
1477 //---------------------------------------------------------------------------------------------------------------------------
1478 /*! @function CommonServicesTest
1479
1480 @abstract Unit test.
1481 */
1482
1483 #if ( DEBUG )
1484 OSStatus CommonServicesTest( void );
1485 #endif
1486
1487 #ifdef __cplusplus
1488 }
1489 #endif
1490
1491 #endif // __COMMON_SERVICES__
mirror of mDNSResponder