utf_string_conversions.h 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  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. #ifndef BASE_STRINGS_UTF_STRING_CONVERSIONS_H_
  5. #define BASE_STRINGS_UTF_STRING_CONVERSIONS_H_
  6. #include <stddef.h>
  7. #include <string>
  8. #include "base/base_export.h"
  9. #include "base/strings/string16.h"
  10. #include "base/strings/string_piece.h"
  11. #include "build/build_config.h"
  12. namespace base {
  13. // These convert between UTF-8, -16, and -32 strings. They are potentially slow,
  14. // so avoid unnecessary conversions. The low-level versions return a boolean
  15. // indicating whether the conversion was 100% valid. In this case, it will still
  16. // do the best it can and put the result in the output buffer. The versions that
  17. // return strings ignore this error and just return the best conversion
  18. // possible.
  19. BASE_EXPORT bool WideToUTF8(const wchar_t* src, size_t src_len,
  20. std::string* output);
  21. BASE_EXPORT std::string WideToUTF8(WStringPiece wide) WARN_UNUSED_RESULT;
  22. BASE_EXPORT bool UTF8ToWide(const char* src, size_t src_len,
  23. std::wstring* output);
  24. BASE_EXPORT std::wstring UTF8ToWide(StringPiece utf8) WARN_UNUSED_RESULT;
  25. BASE_EXPORT bool WideToUTF16(const wchar_t* src, size_t src_len,
  26. string16* output);
  27. BASE_EXPORT string16 WideToUTF16(WStringPiece wide) WARN_UNUSED_RESULT;
  28. BASE_EXPORT bool UTF16ToWide(const char16* src, size_t src_len,
  29. std::wstring* output);
  30. BASE_EXPORT std::wstring UTF16ToWide(StringPiece16 utf16) WARN_UNUSED_RESULT;
  31. BASE_EXPORT bool UTF8ToUTF16(const char* src, size_t src_len, string16* output);
  32. BASE_EXPORT string16 UTF8ToUTF16(StringPiece utf8) WARN_UNUSED_RESULT;
  33. BASE_EXPORT bool UTF16ToUTF8(const char16* src, size_t src_len,
  34. std::string* output);
  35. BASE_EXPORT std::string UTF16ToUTF8(StringPiece16 utf16) WARN_UNUSED_RESULT;
  36. // This converts an ASCII string, typically a hardcoded constant, to a UTF16
  37. // string.
  38. BASE_EXPORT string16 ASCIIToUTF16(StringPiece ascii) WARN_UNUSED_RESULT;
  39. // Converts to 7-bit ASCII by truncating. The result must be known to be ASCII
  40. // beforehand.
  41. BASE_EXPORT std::string UTF16ToASCII(StringPiece16 utf16) WARN_UNUSED_RESULT;
  42. #if defined(WCHAR_T_IS_UTF16)
  43. // This converts an ASCII string, typically a hardcoded constant, to a wide
  44. // string.
  45. BASE_EXPORT std::wstring ASCIIToWide(StringPiece ascii) WARN_UNUSED_RESULT;
  46. // Converts to 7-bit ASCII by truncating. The result must be known to be ASCII
  47. // beforehand.
  48. BASE_EXPORT std::string WideToASCII(WStringPiece wide) WARN_UNUSED_RESULT;
  49. #endif // defined(WCHAR_T_IS_UTF16)
  50. } // namespace base
  51. #endif // BASE_STRINGS_UTF_STRING_CONVERSIONS_H_