Home | History | Annotate | Download | only in base
      1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 
      5 #ifndef BASE_SYS_STRING_CONVERSIONS_H_
      6 #define BASE_SYS_STRING_CONVERSIONS_H_
      7 #pragma once
      8 
      9 // Provides system-dependent string type conversions for cases where it's
     10 // necessary to not use ICU. Generally, you should not need this in Chrome,
     11 // but it is used in some shared code. Dependencies should be minimal.
     12 
     13 #include <string>
     14 
     15 #include "base/base_api.h"
     16 #include "base/basictypes.h"
     17 #include "base/string16.h"
     18 
     19 #if defined(OS_MACOSX)
     20 #include <CoreFoundation/CoreFoundation.h>
     21 #ifdef __OBJC__
     22 @class NSString;
     23 #else
     24 class NSString;
     25 #endif
     26 #endif  // OS_MACOSX
     27 
     28 namespace base {
     29 
     30 class StringPiece;
     31 
     32 // Converts between wide and UTF-8 representations of a string. On error, the
     33 // result is system-dependent.
     34 BASE_API std::string SysWideToUTF8(const std::wstring& wide);
     35 BASE_API std::wstring SysUTF8ToWide(const StringPiece& utf8);
     36 
     37 // Converts between wide and the system multi-byte representations of a string.
     38 // DANGER: This will lose information and can change (on Windows, this can
     39 // change between reboots).
     40 BASE_API std::string SysWideToNativeMB(const std::wstring& wide);
     41 BASE_API std::wstring SysNativeMBToWide(const StringPiece& native_mb);
     42 
     43 // Windows-specific ------------------------------------------------------------
     44 
     45 #if defined(OS_WIN)
     46 
     47 // Converts between 8-bit and wide strings, using the given code page. The
     48 // code page identifier is one accepted by the Windows function
     49 // MultiByteToWideChar().
     50 BASE_API std::wstring SysMultiByteToWide(const StringPiece& mb,
     51                                          uint32 code_page);
     52 BASE_API std::string SysWideToMultiByte(const std::wstring& wide,
     53                                         uint32 code_page);
     54 
     55 #endif  // defined(OS_WIN)
     56 
     57 // Mac-specific ----------------------------------------------------------------
     58 
     59 #if defined(OS_MACOSX)
     60 
     61 // Converts between STL strings and CFStringRefs/NSStrings.
     62 
     63 // Creates a string, and returns it with a refcount of 1. You are responsible
     64 // for releasing it. Returns NULL on failure.
     65 CFStringRef SysUTF8ToCFStringRef(const std::string& utf8);
     66 CFStringRef SysUTF16ToCFStringRef(const string16& utf16);
     67 CFStringRef SysWideToCFStringRef(const std::wstring& wide);
     68 
     69 // Same, but returns an autoreleased NSString.
     70 NSString* SysUTF8ToNSString(const std::string& utf8);
     71 NSString* SysUTF16ToNSString(const string16& utf16);
     72 NSString* SysWideToNSString(const std::wstring& wide);
     73 
     74 // Converts a CFStringRef to an STL string. Returns an empty string on failure.
     75 std::string SysCFStringRefToUTF8(CFStringRef ref);
     76 string16 SysCFStringRefToUTF16(CFStringRef ref);
     77 std::wstring SysCFStringRefToWide(CFStringRef ref);
     78 
     79 // Same, but accepts NSString input. Converts nil NSString* to the appropriate
     80 // string type of length 0.
     81 std::string SysNSStringToUTF8(NSString* ref);
     82 string16 SysNSStringToUTF16(NSString* ref);
     83 std::wstring SysNSStringToWide(NSString* ref);
     84 
     85 #endif  // defined(OS_MACOSX)
     86 
     87 }  // namespace base
     88 
     89 #endif  // BASE_SYS_STRING_CONVERSIONS_H_
     90