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_api.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_API bool WideToUTF8(const wchar_t* src, size_t src_len,
  22                          std::string* output);
  23 BASE_API std::string WideToUTF8(const std::wstring& wide);
  24 BASE_API bool UTF8ToWide(const char* src, size_t src_len, std::wstring* output);
  25 BASE_API std::wstring UTF8ToWide(const base::StringPiece& utf8);
  26
  27 BASE_API bool WideToUTF16(const wchar_t* src, size_t src_len, string16* output);
  28 BASE_API string16 WideToUTF16(const std::wstring& wide);
  29 BASE_API bool UTF16ToWide(const char16* src, size_t src_len,
  30                           std::wstring* output);
  31 BASE_API std::wstring UTF16ToWide(const string16& utf16);
  32
  33 BASE_API bool UTF8ToUTF16(const char* src, size_t src_len, string16* output);
  34 BASE_API string16 UTF8ToUTF16(const base::StringPiece& utf8);
  35 BASE_API bool UTF16ToUTF8(const char16* src, size_t src_len,
  36                           std::string* output);
  37 BASE_API std::string UTF16ToUTF8(const string16& utf16);
  38
  39 // We are trying to get rid of wstring as much as possible, but it's too big
  40 // a mess to do it all at once.  These conversions should be used when we
  41 // really should just be passing a string16 around, but we haven't finished
  42 // porting whatever module uses wstring and the conversion is being used as a
  43 // stopcock.  This makes it easy to grep for the ones that should be removed.
  44 #if defined(OS_WIN)
  45 # define WideToUTF16Hack
  46 # define UTF16ToWideHack
  47 #else
  48 # define WideToUTF16Hack WideToUTF16
  49 # define UTF16ToWideHack UTF16ToWide
  50 #endif
  51
  52 // These convert an ASCII string, typically a hardcoded constant, to a
  53 // UTF16/Wide string.
  54 BASE_API std::wstring ASCIIToWide(const base::StringPiece& ascii);
  55 BASE_API string16 ASCIIToUTF16(const base::StringPiece& ascii);
  56
  57 #endif  // BASE_UTF_STRING_CONVERSIONS_H_