• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_I18N_ICU_STRING_CONVERSIONS_H_
6 #define BASE_I18N_ICU_STRING_CONVERSIONS_H_
7 
8 #include <string>
9 
10 #include "base/i18n/base_i18n_export.h"
11 #include "base/i18n/i18n_constants.h"
12 #include "base/strings/string16.h"
13 
14 namespace base {
15 
16 // Defines the error handling modes of UTF16ToCodepage, CodepageToUTF16,
17 // WideToCodepage and CodepageToWide.
18 class OnStringConversionError {
19  public:
20   enum Type {
21     // The function will return failure. The output buffer will be empty.
22     FAIL,
23 
24     // The offending characters are skipped and the conversion will proceed as
25     // if they did not exist.
26     SKIP,
27 
28     // When converting to Unicode, the offending byte sequences are substituted
29     // by Unicode replacement character (U+FFFD). When converting from Unicode,
30     // this is the same as SKIP.
31     SUBSTITUTE,
32   };
33 
34  private:
35   OnStringConversionError();
36 };
37 
38 // Converts between UTF-16 strings and the encoding specified.  If the
39 // encoding doesn't exist or the encoding fails (when on_error is FAIL),
40 // returns false.
41 BASE_I18N_EXPORT bool UTF16ToCodepage(const string16& utf16,
42                                       const char* codepage_name,
43                                       OnStringConversionError::Type on_error,
44                                       std::string* encoded);
45 BASE_I18N_EXPORT bool CodepageToUTF16(const std::string& encoded,
46                                       const char* codepage_name,
47                                       OnStringConversionError::Type on_error,
48                                       string16* utf16);
49 
50 // Converts between wide strings and the encoding specified.  If the
51 // encoding doesn't exist or the encoding fails (when on_error is FAIL),
52 // returns false.
53 BASE_I18N_EXPORT bool WideToCodepage(const std::wstring& wide,
54                                      const char* codepage_name,
55                                      OnStringConversionError::Type on_error,
56                                      std::string* encoded);
57 BASE_I18N_EXPORT bool CodepageToWide(const std::string& encoded,
58                                      const char* codepage_name,
59                                      OnStringConversionError::Type on_error,
60                                      std::wstring* wide);
61 
62 // Converts from any codepage to UTF-8 and ensures the resulting UTF-8 is
63 // normalized.
64 BASE_I18N_EXPORT bool ConvertToUtf8AndNormalize(const std::string& text,
65                                                 const std::string& charset,
66                                                 std::string* result);
67 
68 }  // namespace base
69 
70 #endif  // BASE_I18N_ICU_STRING_CONVERSIONS_H_
71