base/utf_string_conversions.h

   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_UTF_STRING_CONVERSIONS_H_
   6 #define BASE_UTF_STRING_CONVERSIONS_H_
   7 #pragma once
   8
   9 #include <string>
  10
  11 #include "base/base_export.h"
  12 #include "base/string16.h"
  13 #include "base/string_piece.h"
  14
  15 // These convert between UTF-8, -16, and -32 strings. They are potentially slow,
  16 // so avoid unnecessary conversions. The low-level versions return a boolean
  17 // indicating whether the conversion was 100% valid. In this case, it will still
  18 // do the best it can and put the result in the output buffer. The versions that
  19 // return strings ignore this error and just return the best conversion
  20 // possible.
  21 BASE_EXPORT bool WideToUTF8(const wchar_t* src, size_t src_len,
  22                             std::string* output);
  23 BASE_EXPORT std::string WideToUTF8(const std::wstring& wide);
  24 BASE_EXPORT bool UTF8ToWide(const char* src, size_t src_len,
  25                             std::wstring* output);
  26 BASE_EXPORT std::wstring UTF8ToWide(const base::StringPiece& utf8);
  27
  28 BASE_EXPORT bool WideToUTF16(const wchar_t* src, size_t src_len,
  29                              string16* output);
  30 BASE_EXPORT string16 WideToUTF16(const std::wstring& wide);
  31 BASE_EXPORT bool UTF16ToWide(const char16* src, size_t src_len,
  32                              std::wstring* output);
  33 BASE_EXPORT std::wstring UTF16ToWide(const string16& utf16);
  34
  35 BASE_EXPORT bool UTF8ToUTF16(const char* src, size_t src_len, string16* output);
  36 BASE_EXPORT string16 UTF8ToUTF16(const base::StringPiece& utf8);
  37 BASE_EXPORT bool UTF16ToUTF8(const char16* src, size_t src_len,
  38                              std::string* output);
  39 BASE_EXPORT std::string UTF16ToUTF8(const string16& utf16);
  40
  41 // We are trying to get rid of wstring as much as possible, but it's too big
  42 // a mess to do it all at once.  These conversions should be used when we
  43 // really should just be passing a string16 around, but we haven't finished
  44 // porting whatever module uses wstring and the conversion is being used as a
  45 // stopcock.  This makes it easy to grep for the ones that should be removed.
  46 #if defined(OS_WIN)
  47 # define WideToUTF16Hack
  48 # define UTF16ToWideHack
  49 #else
  50 # define WideToUTF16Hack WideToUTF16
  51 # define UTF16ToWideHack UTF16ToWide
  52 #endif
  53
  54 // These convert an ASCII string, typically a hardcoded constant, to a
  55 // UTF16/Wide string.
  56 BASE_EXPORT std::wstring ASCIIToWide(const base::StringPiece& ascii);
  57 BASE_EXPORT string16 ASCIIToUTF16(const base::StringPiece& ascii);
  58
  59 #endif  // BASE_UTF_STRING_CONVERSIONS_H_