NumberDate.subproj/CFNumber.h

   1 /*
   2  * Copyright (c) 2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*      CFNumber.h
  24         Copyright (c) 1999-2005, Apple, Inc. All rights reserved.
  25 */
  26
  27 #if !defined(__COREFOUNDATION_CFNUMBER__)
  28 #define __COREFOUNDATION_CFNUMBER__ 1
  29
  30 #include <CoreFoundation/CFBase.h>
  31
  32 #if defined(__cplusplus)
  33 extern "C" {
  34 #endif
  35
  36 typedef const struct __CFBoolean * CFBooleanRef;
  37
  38 CF_EXPORT
  39 const CFBooleanRef kCFBooleanTrue;
  40 CF_EXPORT
  41 const CFBooleanRef kCFBooleanFalse;
  42
  43 CF_EXPORT
  44 CFTypeID CFBooleanGetTypeID(void);
  45
  46 CF_EXPORT
  47 Boolean CFBooleanGetValue(CFBooleanRef boolean);
  48
  49 typedef enum {
  50     /* Types from MacTypes.h */
  51     kCFNumberSInt8Type = 1,
  52     kCFNumberSInt16Type = 2,
  53     kCFNumberSInt32Type = 3,
  54     kCFNumberSInt64Type = 4,
  55     kCFNumberFloat32Type = 5,
  56     kCFNumberFloat64Type = 6,   /* 64-bit IEEE 754 */
  57     /* Basic C types */
  58     kCFNumberCharType = 7,
  59     kCFNumberShortType = 8,
  60     kCFNumberIntType = 9,
  61     kCFNumberLongType = 10,
  62     kCFNumberLongLongType = 11,
  63     kCFNumberFloatType = 12,
  64     kCFNumberDoubleType = 13,
  65     /* Other */
  66     kCFNumberCFIndexType = 14,
  67     kCFNumberMaxType = 14
  68 } CFNumberType;
  69
  70 typedef const struct __CFNumber * CFNumberRef;
  71
  72 CF_EXPORT
  73 const CFNumberRef kCFNumberPositiveInfinity;
  74 CF_EXPORT
  75 const CFNumberRef kCFNumberNegativeInfinity;
  76 CF_EXPORT
  77 const CFNumberRef kCFNumberNaN;
  78
  79 CF_EXPORT
  80 CFTypeID CFNumberGetTypeID(void);
  81
  82 /*
  83         Creates a CFNumber with the given value. The type of number pointed
  84         to by the valuePtr is specified by type. If type is a floating point
  85         type and the value represents one of the infinities or NaN, the
  86         well-defined CFNumber for that value is returned. If either of
  87         valuePtr or type is an invalid value, the result is undefined.
  88 */
  89 CF_EXPORT
  90 CFNumberRef CFNumberCreate(CFAllocatorRef allocator, CFNumberType theType, const void *valuePtr);
  91
  92 /*
  93         Returns the storage format of the CFNumber's value.  Note that
  94         this is not necessarily the type provided in CFNumberCreate().
  95 */
  96 CF_EXPORT
  97 CFNumberType CFNumberGetType(CFNumberRef number);
  98
  99 /*
 100         Returns the size in bytes of the type of the number.
 101 */
 102 CF_EXPORT
 103 CFIndex CFNumberGetByteSize(CFNumberRef number);
 104
 105 /*
 106         Returns true if the type of the CFNumber's value is one of
 107         the defined floating point types.
 108 */
 109 CF_EXPORT
 110 Boolean CFNumberIsFloatType(CFNumberRef number);
 111
 112 /*
 113         Copies the CFNumber's value into the space pointed to by
 114         valuePtr, as the specified type. If conversion needs to take
 115         place, the conversion rules follow human expectation and not
 116         C's promotion and truncation rules. If the conversion is
 117         lossy, or the value is out of range, false is returned. Best
 118         attempt at conversion will still be in *valuePtr.
 119 */
 120 CF_EXPORT
 121 Boolean CFNumberGetValue(CFNumberRef number, CFNumberType theType, void *valuePtr);
 122
 123 /*
 124         Compares the two CFNumber instances. If conversion of the
 125         types of the values is needed, the conversion and comparison
 126         follow human expectations and not C's promotion and comparison
 127         rules. Negative zero compares less than positive zero.
 128         Positive infinity compares greater than everything except
 129         itself, to which it compares equal. Negative infinity compares
 130         less than everything except itself, to which it compares equal.
 131         Unlike standard practice, if both numbers are NaN, then they
 132         compare equal; if only one of the numbers is NaN, then the NaN
 133         compares greater than the other number if it is negative, and
 134         smaller than the other number if it is positive. (Note that in
 135         CFEqual() with two CFNumbers, if either or both of the numbers
 136         is NaN, true is returned.)
 137 */
 138 CF_EXPORT
 139 CFComparisonResult CFNumberCompare(CFNumberRef number, CFNumberRef otherNumber, void *context);
 140
 141 #if defined(__cplusplus)
 142 }
 143 #endif
 144
 145 #endif /* ! __COREFOUNDATION_CFNUMBER__ */
 146