CFCharacterSetPriv.h

   1 /*
   2  * Copyright (c) 2010 Apple 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
  24 /*      CFCharacterSetPriv.h
  25         Copyright (c) 1998-2009, Apple Inc. All rights reserved.
  26 */
  27
  28 #if !defined(__COREFOUNDATION_CFCHARACTERSETPRIV__)
  29 #define __COREFOUNDATION_CFCHARACTERSETPRIV__ 1
  30
  31 #include <CoreFoundation/CFCharacterSet.h>
  32
  33 CF_EXTERN_C_BEGIN
  34
  35 #if MAC_OS_X_VERSION_10_2 <= MAC_OS_X_VERSION_MAX_ALLOWED
  36 /*!
  37         @function CFCharacterSetIsSurrogateHighCharacter
  38         Reports whether or not the character is a high surrogate.
  39         @param character  The character to be checked.
  40         @result true, if character is a high surrogate, otherwise false.
  41 */
  42 CF_INLINE Boolean CFCharacterSetIsSurrogateHighCharacter(UniChar character) {
  43     return ((character >= 0xD800UL) && (character <= 0xDBFFUL) ? true : false);
  44 }
  45
  46 /*!
  47         @function CFCharacterSetIsSurrogateLowCharacter
  48         Reports whether or not the character is a low surrogate.
  49         @param character  The character to be checked.
  50         @result true, if character is a low surrogate, otherwise false.
  51 */
  52 CF_INLINE Boolean CFCharacterSetIsSurrogateLowCharacter(UniChar character) {
  53     return ((character >= 0xDC00UL) && (character <= 0xDFFFUL) ? true : false);
  54 }
  55
  56 /*!
  57         @function CFCharacterSetGetLongCharacterForSurrogatePair
  58         Returns the UTF-32 value corresponding to the surrogate pair passed in.
  59         @param surrogateHigh  The high surrogate character.  If this parameter
  60                         is not a valid high surrogate character, the behavior is undefined.
  61         @param surrogateLow  The low surrogate character.  If this parameter
  62                         is not a valid low surrogate character, the behavior is undefined.
  63         @result The UTF-32 value for the surrogate pair.
  64 */
  65 CF_INLINE UTF32Char CFCharacterSetGetLongCharacterForSurrogatePair(UniChar surrogateHigh, UniChar surrogateLow) {
  66     return ((surrogateHigh - 0xD800UL) << 10) + (surrogateLow - 0xDC00UL) + 0x0010000UL;
  67 }
  68 #endif
  69
  70 /* Check to see if the character represented by the surrogate pair surrogateHigh & surrogateLow is in the chraracter set */
  71 CF_EXPORT Boolean CFCharacterSetIsSurrogatePairMember(CFCharacterSetRef theSet, UniChar surrogateHigh, UniChar surrogateLow) ;
  72
  73 /* Keyed-coding support
  74 */
  75 enum {
  76     kCFCharacterSetKeyedCodingTypeBitmap = 1,
  77     kCFCharacterSetKeyedCodingTypeBuiltin = 2,
  78     kCFCharacterSetKeyedCodingTypeRange = 3,
  79     kCFCharacterSetKeyedCodingTypeString = 4,
  80     kCFCharacterSetKeyedCodingTypeBuiltinAndBitmap = 5
  81 };
  82 typedef CFIndex CFCharacterSetKeyedCodingType;
  83
  84 CF_EXPORT CFCharacterSetKeyedCodingType _CFCharacterSetGetKeyedCodingType(CFCharacterSetRef cset);
  85 CF_EXPORT CFCharacterSetPredefinedSet _CFCharacterSetGetKeyedCodingBuiltinType(CFCharacterSetRef cset);
  86 CF_EXPORT CFRange _CFCharacterSetGetKeyedCodingRange(CFCharacterSetRef cset);
  87 CF_EXPORT CFStringRef _CFCharacterSetCreateKeyedCodingString(CFCharacterSetRef cset);
  88 CF_EXPORT bool _CFCharacterSetIsInverted(CFCharacterSetRef cset);
  89 CF_EXPORT void _CFCharacterSetSetIsInverted(CFCharacterSetRef cset, bool flag);
  90
  91 CF_EXTERN_C_END
  92
  93 #endif /* ! __COREFOUNDATION_CFCHARACTERSETPRIV__ */
  94