base/i18n/icu_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_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 and CodepageToUTF16.
  17 class OnStringConversionError {
  18  public:
  19   enum Type {
  20     // The function will return failure. The output buffer will be empty.
  21     FAIL,
  22
  23     // The offending characters are skipped and the conversion will proceed as
  24     // if they did not exist.
  25     SKIP,
  26
  27     // When converting to Unicode, the offending byte sequences are substituted
  28     // by Unicode replacement character (U+FFFD). When converting from Unicode,
  29     // this is the same as SKIP.
  30     SUBSTITUTE,
  31   };
  32
  33  private:
  34   OnStringConversionError();
  35 };
  36
  37 // Converts between UTF-16 strings and the encoding specified.  If the
  38 // encoding doesn't exist or the encoding fails (when on_error is FAIL),
  39 // returns false.
  40 BASE_I18N_EXPORT bool UTF16ToCodepage(const string16& utf16,
  41                                       const char* codepage_name,
  42                                       OnStringConversionError::Type on_error,
  43                                       std::string* encoded);
  44 BASE_I18N_EXPORT bool CodepageToUTF16(const std::string& encoded,
  45                                       const char* codepage_name,
  46                                       OnStringConversionError::Type on_error,
  47                                       string16* utf16);
  48
  49 // Converts from any codepage to UTF-8 and ensures the resulting UTF-8 is
  50 // normalized.
  51 BASE_I18N_EXPORT bool ConvertToUtf8AndNormalize(const std::string& text,
  52                                                 const std::string& charset,
  53                                                 std::string* result);
  54
  55 }  // namespace base
  56
  57 #endif  // BASE_I18N_ICU_STRING_CONVERSIONS_H_