src/mac/corefoundation/strconv_cf.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/mac/corefoundation/strconv.cpp
   3 // Purpose:     Unicode conversion classes
   4 // Author:      David Elliott
   5 // Modified by:
   6 // Created:     2007-07-06
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2007 David Elliott
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifndef WX_PRECOMP
  16     #include "wx/string.h"
  17 #endif
  18
  19 #include "wx/strconv.h"
  20 #include "wx/fontmap.h"
  21
  22 #ifdef __DARWIN__
  23
  24 #include "wx/mac/corefoundation/private/strconv_cf.h"
  25 #include "wx/mac/corefoundation/cfref.h"
  26
  27
  28 // ============================================================================
  29 // CoreFoundation conversion classes
  30 // ============================================================================
  31
  32 /* Provide factory functions for unit tests.  Not in any header.  Do not
  33  * assume ABI compatibility even within a given wxWidgets release.
  34  */
  35
  36 WXDLLIMPEXP_BASE wxMBConv* new_wxMBConv_cf( const char* name)
  37 {
  38     wxMBConv_cf *result = new wxMBConv_cf(name);
  39     if(!result->IsOk())
  40     {
  41         delete result;
  42         return NULL;
  43     }
  44     else
  45         return result;
  46 }
  47
  48 WXDLLIMPEXP_BASE wxMBConv* new_wxMBConv_cf(wxFontEncoding encoding)
  49 {
  50     wxMBConv_cf *result = new wxMBConv_cf(encoding);
  51     if(!result->IsOk())
  52     {
  53         delete result;
  54         return NULL;
  55     }
  56     else
  57         return result;
  58 }
  59
  60 // Provide a constant for the wchat_t encoding used by the host platform.
  61 #ifdef WORDS_BIGENDIAN
  62     static const CFStringEncoding wxCFStringEncodingWcharT = kCFStringEncodingUTF32BE;
  63 #else
  64     static const CFStringEncoding wxCFStringEncodingWcharT = kCFStringEncodingUTF32LE;
  65 #endif
  66
  67     size_t wxMBConv_cf::ToWChar(wchar_t * dst, size_t dstSize, const char * src, size_t srcSize) const
  68     {
  69         wxCHECK(src, wxCONV_FAILED);
  70
  71         /* NOTE: This is wrong if the source encoding has an element size
  72          * other than char (e.g. it's kCFStringEncodingUnicode)
  73          * If the user specifies it, it's presumably right though.
  74          * Right now we don't support UTF-16 in anyway since wx can do a better job.
  75          */
  76         if(srcSize == wxNO_LEN)
  77             srcSize = strlen(src) + 1;
  78
  79         // First create the temporary CFString
  80         wxCFRef<CFStringRef> theString( CFStringCreateWithBytes (
  81                                                 NULL, //the allocator
  82                                                 (const UInt8*)src,
  83                                                 srcSize,
  84                                                 m_encoding,
  85                                                 false //no BOM/external representation
  86                                                 ));
  87
  88         wxCHECK(theString != NULL, wxCONV_FAILED);
  89
  90         /* NOTE: The string content includes the NULL element if the source string did
  91          * That means we have to do nothing special because the destination will have
  92          * the NULL element iff the source did and the NULL element will be included
  93          * in the count iff it was included in the source count.
  94          */
  95
  96
  97 /* If we're compiling against Tiger headers we can support direct conversion
  98  * to UTF32.  If we are then run against a pre-Tiger system, the encoding
  99  * won't be available so we'll defer to the string->UTF-16->UTF-32 conversion.
 100  */
 101         if(CFStringIsEncodingAvailable(wxCFStringEncodingWcharT))
 102         {
 103             CFRange fullStringRange = CFRangeMake(0, CFStringGetLength(theString));
 104             CFIndex usedBufLen;
 105
 106             CFIndex charsConverted = CFStringGetBytes(
 107                     theString,
 108                     fullStringRange,
 109                     wxCFStringEncodingWcharT,
 110                     0,
 111                     false,
 112                     // if dstSize is 0 then pass NULL to get required length in usedBufLen
 113                     dstSize != 0?(UInt8*)dst:NULL,
 114                     dstSize * sizeof(wchar_t),
 115                     &usedBufLen);
 116
 117             // charsConverted is > 0 iff conversion succeeded
 118             if(charsConverted <= 0)
 119                 return wxCONV_FAILED;
 120
 121             /* usedBufLen is the number of bytes written, so we divide by
 122              * sizeof(wchar_t) to get the number of elements written.
 123              */
 124             wxASSERT( (usedBufLen % sizeof(wchar_t)) == 0 );
 125
 126             // CFStringGetBytes does exactly the right thing when buffer
 127             // pointer is NULL and returns the number of bytes required
 128             return usedBufLen / sizeof(wchar_t);
 129         }
 130         else
 131         {
 132             // NOTE: Includes NULL iff source did
 133             /* NOTE: This is an approximation.  The eventual UTF-32 will
 134              * possibly have less elements but certainly not more.
 135              */
 136             size_t returnSize = CFStringGetLength(theString);
 137
 138             if (dstSize == 0 || dst == NULL)
 139             {
 140                 return returnSize;
 141             }
 142
 143             // Convert the entire string.. too hard to figure out how many UTF-16 we'd need
 144             // for an undersized UTF-32 destination buffer.
 145             CFRange fullStringRange = CFRangeMake(0, CFStringGetLength(theString));
 146             UniChar *szUniCharBuffer = new UniChar[fullStringRange.length];
 147
 148             CFStringGetCharacters(theString, fullStringRange, szUniCharBuffer);
 149
 150             wxMBConvUTF16 converter;
 151             returnSize = converter.ToWChar( dst, dstSize, (const char*)szUniCharBuffer, fullStringRange.length );
 152             delete [] szUniCharBuffer;
 153
 154             return returnSize;
 155         }
 156         // NOTREACHED
 157     }
 158
 159     size_t wxMBConv_cf::FromWChar(char *dst, size_t dstSize, const wchar_t *src, size_t srcSize) const
 160     {
 161         wxCHECK(src, wxCONV_FAILED);
 162
 163         if(srcSize == wxNO_LEN)
 164             srcSize = wxStrlen(src) + 1;
 165
 166         // Temporary CFString
 167         wxCFRef<CFStringRef> theString;
 168
 169 /* If we're compiling against Tiger headers we can support direct conversion
 170  * from UTF32.  If we are then run against a pre-Tiger system, the encoding
 171  * won't be available so we'll defer to the UTF-32->UTF-16->string conversion.
 172  */
 173         if(CFStringIsEncodingAvailable(wxCFStringEncodingWcharT))
 174         {
 175             theString = wxCFRef<CFStringRef>(CFStringCreateWithBytes(
 176                     kCFAllocatorDefault,
 177                     (UInt8*)src,
 178                     srcSize * sizeof(wchar_t),
 179                     wxCFStringEncodingWcharT,
 180                     false));
 181         }
 182         else
 183         {
 184             wxMBConvUTF16 converter;
 185             size_t cbUniBuffer = converter.FromWChar( NULL, 0, src, srcSize );
 186             wxASSERT(cbUniBuffer % sizeof(UniChar));
 187
 188             // Will be free'd by kCFAllocatorMalloc when CFString is released
 189             UniChar *tmpUniBuffer = (UniChar*)malloc(cbUniBuffer);
 190
 191             cbUniBuffer = converter.FromWChar( (char*) tmpUniBuffer, cbUniBuffer, src, srcSize );
 192             wxASSERT(cbUniBuffer % sizeof(UniChar));
 193
 194             theString = wxCFRef<CFStringRef>(CFStringCreateWithCharactersNoCopy(
 195                         kCFAllocatorDefault,
 196                         tmpUniBuffer,
 197                         cbUniBuffer / sizeof(UniChar),
 198                         kCFAllocatorMalloc
 199                     ));
 200
 201         }
 202
 203         wxCHECK(theString != NULL, wxCONV_FAILED);
 204
 205         CFIndex usedBufLen;
 206
 207         CFIndex charsConverted = CFStringGetBytes(
 208                 theString,
 209                 CFRangeMake(0, CFStringGetLength(theString)),
 210                 m_encoding,
 211                 0, // FAIL on unconvertible characters
 212                 false, // not an external representation
 213                 // if dstSize is 0 then pass NULL to get required length in usedBufLen
 214                 (dstSize != 0)?(UInt8*)dst:NULL,
 215                 dstSize,
 216                 &usedBufLen
 217             );
 218
 219         // charsConverted is > 0 iff conversion succeeded
 220         if(charsConverted <= 0)
 221             return wxCONV_FAILED;
 222
 223         return usedBufLen;
 224     }
 225
 226 #endif // __DARWIN__
 227
 228