xref: /aosp_15_r20/external/cronet/base/i18n/icu_string_conversions.cc (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1*6777b538SAndroid Build Coastguard Worker // Copyright 2012 The Chromium Authors
2*6777b538SAndroid Build Coastguard Worker // Use of this source code is governed by a BSD-style license that can be
3*6777b538SAndroid Build Coastguard Worker // found in the LICENSE file.
4*6777b538SAndroid Build Coastguard Worker 
5*6777b538SAndroid Build Coastguard Worker #include "base/i18n/icu_string_conversions.h"
6*6777b538SAndroid Build Coastguard Worker 
7*6777b538SAndroid Build Coastguard Worker #include <stddef.h>
8*6777b538SAndroid Build Coastguard Worker #include <stdint.h>
9*6777b538SAndroid Build Coastguard Worker 
10*6777b538SAndroid Build Coastguard Worker #include <memory>
11*6777b538SAndroid Build Coastguard Worker #include <string_view>
12*6777b538SAndroid Build Coastguard Worker 
13*6777b538SAndroid Build Coastguard Worker #include "base/check.h"
14*6777b538SAndroid Build Coastguard Worker #include "base/notreached.h"
15*6777b538SAndroid Build Coastguard Worker #include "base/strings/string_util.h"
16*6777b538SAndroid Build Coastguard Worker #include "base/strings/utf_string_conversions.h"
17*6777b538SAndroid Build Coastguard Worker #include "third_party/icu/source/common/unicode/normalizer2.h"
18*6777b538SAndroid Build Coastguard Worker #include "third_party/icu/source/common/unicode/ucnv.h"
19*6777b538SAndroid Build Coastguard Worker #include "third_party/icu/source/common/unicode/ucnv_cb.h"
20*6777b538SAndroid Build Coastguard Worker #include "third_party/icu/source/common/unicode/ucnv_err.h"
21*6777b538SAndroid Build Coastguard Worker #include "third_party/icu/source/common/unicode/ustring.h"
22*6777b538SAndroid Build Coastguard Worker 
23*6777b538SAndroid Build Coastguard Worker namespace base {
24*6777b538SAndroid Build Coastguard Worker 
25*6777b538SAndroid Build Coastguard Worker namespace {
26*6777b538SAndroid Build Coastguard Worker // ToUnicodeCallbackSubstitute() is based on UCNV_TO_U_CALLBACK_SUBSTITUTE
27*6777b538SAndroid Build Coastguard Worker // in source/common/ucnv_err.c.
28*6777b538SAndroid Build Coastguard Worker 
29*6777b538SAndroid Build Coastguard Worker // Copyright (c) 1995-2006 International Business Machines Corporation
30*6777b538SAndroid Build Coastguard Worker // and others
31*6777b538SAndroid Build Coastguard Worker //
32*6777b538SAndroid Build Coastguard Worker // All rights reserved.
33*6777b538SAndroid Build Coastguard Worker //
34*6777b538SAndroid Build Coastguard Worker 
35*6777b538SAndroid Build Coastguard Worker // Permission is hereby granted, free of charge, to any person obtaining a
36*6777b538SAndroid Build Coastguard Worker // copy of this software and associated documentation files (the "Software"),
37*6777b538SAndroid Build Coastguard Worker // to deal in the Software without restriction, including without limitation
38*6777b538SAndroid Build Coastguard Worker // the rights to use, copy, modify, merge, publish, distribute, and/or
39*6777b538SAndroid Build Coastguard Worker // sell copies of the Software, and to permit persons to whom the Software
40*6777b538SAndroid Build Coastguard Worker // is furnished to do so, provided that the above copyright notice(s) and
41*6777b538SAndroid Build Coastguard Worker // this permission notice appear in all copies of the Software and that
42*6777b538SAndroid Build Coastguard Worker // both the above copyright notice(s) and this permission notice appear in
43*6777b538SAndroid Build Coastguard Worker // supporting documentation.
44*6777b538SAndroid Build Coastguard Worker //
45*6777b538SAndroid Build Coastguard Worker // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
46*6777b538SAndroid Build Coastguard Worker // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
47*6777b538SAndroid Build Coastguard Worker // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
48*6777b538SAndroid Build Coastguard Worker // OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
49*6777b538SAndroid Build Coastguard Worker // INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
50*6777b538SAndroid Build Coastguard Worker // OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
51*6777b538SAndroid Build Coastguard Worker // OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
52*6777b538SAndroid Build Coastguard Worker // OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
53*6777b538SAndroid Build Coastguard Worker // OR PERFORMANCE OF THIS SOFTWARE.
54*6777b538SAndroid Build Coastguard Worker //
55*6777b538SAndroid Build Coastguard Worker // Except as contained in this notice, the name of a copyright holder
56*6777b538SAndroid Build Coastguard Worker // shall not be used in advertising or otherwise to promote the sale, use
57*6777b538SAndroid Build Coastguard Worker // or other dealings in this Software without prior written authorization
58*6777b538SAndroid Build Coastguard Worker // of the copyright holder.
59*6777b538SAndroid Build Coastguard Worker 
60*6777b538SAndroid Build Coastguard Worker //  ___________________________________________________________________________
61*6777b538SAndroid Build Coastguard Worker //
62*6777b538SAndroid Build Coastguard Worker // All trademarks and registered trademarks mentioned herein are the property
63*6777b538SAndroid Build Coastguard Worker // of their respective owners.
64*6777b538SAndroid Build Coastguard Worker 
ToUnicodeCallbackSubstitute(const void * context,UConverterToUnicodeArgs * to_args,const char * code_units,int32_t length,UConverterCallbackReason reason,UErrorCode * err)65*6777b538SAndroid Build Coastguard Worker void ToUnicodeCallbackSubstitute(const void* context,
66*6777b538SAndroid Build Coastguard Worker                                  UConverterToUnicodeArgs *to_args,
67*6777b538SAndroid Build Coastguard Worker                                  const char* code_units,
68*6777b538SAndroid Build Coastguard Worker                                  int32_t length,
69*6777b538SAndroid Build Coastguard Worker                                  UConverterCallbackReason reason,
70*6777b538SAndroid Build Coastguard Worker                                  UErrorCode * err) {
71*6777b538SAndroid Build Coastguard Worker   static const UChar kReplacementChar = 0xFFFD;
72*6777b538SAndroid Build Coastguard Worker   if (reason <= UCNV_IRREGULAR) {
73*6777b538SAndroid Build Coastguard Worker     if (context == nullptr ||
74*6777b538SAndroid Build Coastguard Worker         (*(reinterpret_cast<const char*>(context)) == 'i' &&
75*6777b538SAndroid Build Coastguard Worker          reason == UCNV_UNASSIGNED)) {
76*6777b538SAndroid Build Coastguard Worker       *err = U_ZERO_ERROR;
77*6777b538SAndroid Build Coastguard Worker       ucnv_cbToUWriteUChars(to_args, &kReplacementChar, 1, 0, err);
78*6777b538SAndroid Build Coastguard Worker       }
79*6777b538SAndroid Build Coastguard Worker       // else the caller must have set the error code accordingly.
80*6777b538SAndroid Build Coastguard Worker   }
81*6777b538SAndroid Build Coastguard Worker   // else ignore the reset, close and clone calls.
82*6777b538SAndroid Build Coastguard Worker }
83*6777b538SAndroid Build Coastguard Worker 
ConvertFromUTF16(UConverter * converter,std::u16string_view src,OnStringConversionError::Type on_error,std::string * encoded)84*6777b538SAndroid Build Coastguard Worker bool ConvertFromUTF16(UConverter* converter,
85*6777b538SAndroid Build Coastguard Worker                       std::u16string_view src,
86*6777b538SAndroid Build Coastguard Worker                       OnStringConversionError::Type on_error,
87*6777b538SAndroid Build Coastguard Worker                       std::string* encoded) {
88*6777b538SAndroid Build Coastguard Worker   int encoded_max_length = UCNV_GET_MAX_BYTES_FOR_STRING(
89*6777b538SAndroid Build Coastguard Worker       src.length(), ucnv_getMaxCharSize(converter));
90*6777b538SAndroid Build Coastguard Worker   encoded->resize(encoded_max_length);
91*6777b538SAndroid Build Coastguard Worker 
92*6777b538SAndroid Build Coastguard Worker   UErrorCode status = U_ZERO_ERROR;
93*6777b538SAndroid Build Coastguard Worker 
94*6777b538SAndroid Build Coastguard Worker   // Setup our error handler.
95*6777b538SAndroid Build Coastguard Worker   switch (on_error) {
96*6777b538SAndroid Build Coastguard Worker     case OnStringConversionError::FAIL:
97*6777b538SAndroid Build Coastguard Worker       ucnv_setFromUCallBack(converter, UCNV_FROM_U_CALLBACK_STOP, nullptr,
98*6777b538SAndroid Build Coastguard Worker                             nullptr, nullptr, &status);
99*6777b538SAndroid Build Coastguard Worker       break;
100*6777b538SAndroid Build Coastguard Worker     case OnStringConversionError::SKIP:
101*6777b538SAndroid Build Coastguard Worker     case OnStringConversionError::SUBSTITUTE:
102*6777b538SAndroid Build Coastguard Worker       ucnv_setFromUCallBack(converter, UCNV_FROM_U_CALLBACK_SKIP, nullptr,
103*6777b538SAndroid Build Coastguard Worker                             nullptr, nullptr, &status);
104*6777b538SAndroid Build Coastguard Worker       break;
105*6777b538SAndroid Build Coastguard Worker   }
106*6777b538SAndroid Build Coastguard Worker 
107*6777b538SAndroid Build Coastguard Worker   // ucnv_fromUChars returns size not including terminating null
108*6777b538SAndroid Build Coastguard Worker   int actual_size =
109*6777b538SAndroid Build Coastguard Worker       ucnv_fromUChars(converter, &(*encoded)[0], encoded_max_length, src.data(),
110*6777b538SAndroid Build Coastguard Worker                       src.length(), &status);
111*6777b538SAndroid Build Coastguard Worker   encoded->resize(actual_size);
112*6777b538SAndroid Build Coastguard Worker   ucnv_close(converter);
113*6777b538SAndroid Build Coastguard Worker   if (U_SUCCESS(status))
114*6777b538SAndroid Build Coastguard Worker     return true;
115*6777b538SAndroid Build Coastguard Worker   encoded->clear();  // Make sure the output is empty on error.
116*6777b538SAndroid Build Coastguard Worker   return false;
117*6777b538SAndroid Build Coastguard Worker }
118*6777b538SAndroid Build Coastguard Worker 
119*6777b538SAndroid Build Coastguard Worker // Set up our error handler for ToUTF-16 converters
SetUpErrorHandlerForToUChars(OnStringConversionError::Type on_error,UConverter * converter,UErrorCode * status)120*6777b538SAndroid Build Coastguard Worker void SetUpErrorHandlerForToUChars(OnStringConversionError::Type on_error,
121*6777b538SAndroid Build Coastguard Worker                                   UConverter* converter, UErrorCode* status) {
122*6777b538SAndroid Build Coastguard Worker   switch (on_error) {
123*6777b538SAndroid Build Coastguard Worker     case OnStringConversionError::FAIL:
124*6777b538SAndroid Build Coastguard Worker       ucnv_setToUCallBack(converter, UCNV_TO_U_CALLBACK_STOP, nullptr, nullptr,
125*6777b538SAndroid Build Coastguard Worker                           nullptr, status);
126*6777b538SAndroid Build Coastguard Worker       break;
127*6777b538SAndroid Build Coastguard Worker     case OnStringConversionError::SKIP:
128*6777b538SAndroid Build Coastguard Worker       ucnv_setToUCallBack(converter, UCNV_TO_U_CALLBACK_SKIP, nullptr, nullptr,
129*6777b538SAndroid Build Coastguard Worker                           nullptr, status);
130*6777b538SAndroid Build Coastguard Worker       break;
131*6777b538SAndroid Build Coastguard Worker     case OnStringConversionError::SUBSTITUTE:
132*6777b538SAndroid Build Coastguard Worker       ucnv_setToUCallBack(converter, ToUnicodeCallbackSubstitute, nullptr,
133*6777b538SAndroid Build Coastguard Worker                           nullptr, nullptr, status);
134*6777b538SAndroid Build Coastguard Worker       break;
135*6777b538SAndroid Build Coastguard Worker   }
136*6777b538SAndroid Build Coastguard Worker }
137*6777b538SAndroid Build Coastguard Worker 
138*6777b538SAndroid Build Coastguard Worker }  // namespace
139*6777b538SAndroid Build Coastguard Worker 
140*6777b538SAndroid Build Coastguard Worker // Codepage <-> Wide/UTF-16  ---------------------------------------------------
141*6777b538SAndroid Build Coastguard Worker 
UTF16ToCodepage(std::u16string_view utf16,const char * codepage_name,OnStringConversionError::Type on_error,std::string * encoded)142*6777b538SAndroid Build Coastguard Worker bool UTF16ToCodepage(std::u16string_view utf16,
143*6777b538SAndroid Build Coastguard Worker                      const char* codepage_name,
144*6777b538SAndroid Build Coastguard Worker                      OnStringConversionError::Type on_error,
145*6777b538SAndroid Build Coastguard Worker                      std::string* encoded) {
146*6777b538SAndroid Build Coastguard Worker   encoded->clear();
147*6777b538SAndroid Build Coastguard Worker 
148*6777b538SAndroid Build Coastguard Worker   UErrorCode status = U_ZERO_ERROR;
149*6777b538SAndroid Build Coastguard Worker   UConverter* converter = ucnv_open(codepage_name, &status);
150*6777b538SAndroid Build Coastguard Worker   if (!U_SUCCESS(status))
151*6777b538SAndroid Build Coastguard Worker     return false;
152*6777b538SAndroid Build Coastguard Worker 
153*6777b538SAndroid Build Coastguard Worker   return ConvertFromUTF16(converter, utf16, on_error, encoded);
154*6777b538SAndroid Build Coastguard Worker }
155*6777b538SAndroid Build Coastguard Worker 
CodepageToUTF16(std::string_view encoded,const char * codepage_name,OnStringConversionError::Type on_error,std::u16string * utf16)156*6777b538SAndroid Build Coastguard Worker bool CodepageToUTF16(std::string_view encoded,
157*6777b538SAndroid Build Coastguard Worker                      const char* codepage_name,
158*6777b538SAndroid Build Coastguard Worker                      OnStringConversionError::Type on_error,
159*6777b538SAndroid Build Coastguard Worker                      std::u16string* utf16) {
160*6777b538SAndroid Build Coastguard Worker   utf16->clear();
161*6777b538SAndroid Build Coastguard Worker 
162*6777b538SAndroid Build Coastguard Worker   UErrorCode status = U_ZERO_ERROR;
163*6777b538SAndroid Build Coastguard Worker   UConverter* converter = ucnv_open(codepage_name, &status);
164*6777b538SAndroid Build Coastguard Worker   if (!U_SUCCESS(status))
165*6777b538SAndroid Build Coastguard Worker     return false;
166*6777b538SAndroid Build Coastguard Worker 
167*6777b538SAndroid Build Coastguard Worker   // Even in the worst case, the maximum length in 2-byte units of UTF-16
168*6777b538SAndroid Build Coastguard Worker   // output would be at most the same as the number of bytes in input. There
169*6777b538SAndroid Build Coastguard Worker   // is no single-byte encoding in which a character is mapped to a
170*6777b538SAndroid Build Coastguard Worker   // non-BMP character requiring two 2-byte units.
171*6777b538SAndroid Build Coastguard Worker   //
172*6777b538SAndroid Build Coastguard Worker   // Moreover, non-BMP characters in legacy multibyte encodings
173*6777b538SAndroid Build Coastguard Worker   // (e.g. EUC-JP, GB18030) take at least 2 bytes. The only exceptions are
174*6777b538SAndroid Build Coastguard Worker   // BOCU and SCSU, but we don't care about them.
175*6777b538SAndroid Build Coastguard Worker   size_t uchar_max_length = encoded.length() + 1;
176*6777b538SAndroid Build Coastguard Worker 
177*6777b538SAndroid Build Coastguard Worker   SetUpErrorHandlerForToUChars(on_error, converter, &status);
178*6777b538SAndroid Build Coastguard Worker   std::unique_ptr<char16_t[]> buffer(new char16_t[uchar_max_length]);
179*6777b538SAndroid Build Coastguard Worker   int actual_size = ucnv_toUChars(
180*6777b538SAndroid Build Coastguard Worker       converter, buffer.get(), static_cast<int>(uchar_max_length),
181*6777b538SAndroid Build Coastguard Worker       encoded.data(), static_cast<int>(encoded.length()), &status);
182*6777b538SAndroid Build Coastguard Worker   ucnv_close(converter);
183*6777b538SAndroid Build Coastguard Worker   if (!U_SUCCESS(status)) {
184*6777b538SAndroid Build Coastguard Worker     utf16->clear();  // Make sure the output is empty on error.
185*6777b538SAndroid Build Coastguard Worker     return false;
186*6777b538SAndroid Build Coastguard Worker   }
187*6777b538SAndroid Build Coastguard Worker 
188*6777b538SAndroid Build Coastguard Worker   utf16->assign(buffer.get(), actual_size);
189*6777b538SAndroid Build Coastguard Worker   return true;
190*6777b538SAndroid Build Coastguard Worker }
191*6777b538SAndroid Build Coastguard Worker 
ConvertToUtf8AndNormalize(std::string_view text,const std::string & charset,std::string * result)192*6777b538SAndroid Build Coastguard Worker bool ConvertToUtf8AndNormalize(std::string_view text,
193*6777b538SAndroid Build Coastguard Worker                                const std::string& charset,
194*6777b538SAndroid Build Coastguard Worker                                std::string* result) {
195*6777b538SAndroid Build Coastguard Worker   result->clear();
196*6777b538SAndroid Build Coastguard Worker   std::u16string utf16;
197*6777b538SAndroid Build Coastguard Worker   if (!CodepageToUTF16(text, charset.c_str(), OnStringConversionError::FAIL,
198*6777b538SAndroid Build Coastguard Worker                        &utf16))
199*6777b538SAndroid Build Coastguard Worker     return false;
200*6777b538SAndroid Build Coastguard Worker 
201*6777b538SAndroid Build Coastguard Worker   UErrorCode status = U_ZERO_ERROR;
202*6777b538SAndroid Build Coastguard Worker   const icu::Normalizer2* normalizer = icu::Normalizer2::getNFCInstance(status);
203*6777b538SAndroid Build Coastguard Worker   DCHECK(U_SUCCESS(status));
204*6777b538SAndroid Build Coastguard Worker   if (U_FAILURE(status))
205*6777b538SAndroid Build Coastguard Worker     return false;
206*6777b538SAndroid Build Coastguard Worker   int32_t utf16_length = static_cast<int32_t>(utf16.length());
207*6777b538SAndroid Build Coastguard Worker   icu::UnicodeString normalized(utf16.data(), utf16_length);
208*6777b538SAndroid Build Coastguard Worker   int32_t normalized_prefix_length =
209*6777b538SAndroid Build Coastguard Worker       normalizer->spanQuickCheckYes(normalized, status);
210*6777b538SAndroid Build Coastguard Worker   if (normalized_prefix_length < utf16_length) {
211*6777b538SAndroid Build Coastguard Worker     icu::UnicodeString un_normalized(normalized, normalized_prefix_length);
212*6777b538SAndroid Build Coastguard Worker     normalized.truncate(normalized_prefix_length);
213*6777b538SAndroid Build Coastguard Worker     normalizer->normalizeSecondAndAppend(normalized, un_normalized, status);
214*6777b538SAndroid Build Coastguard Worker   }
215*6777b538SAndroid Build Coastguard Worker   if (U_FAILURE(status))
216*6777b538SAndroid Build Coastguard Worker     return false;
217*6777b538SAndroid Build Coastguard Worker   normalized.toUTF8String(*result);
218*6777b538SAndroid Build Coastguard Worker   return true;
219*6777b538SAndroid Build Coastguard Worker }
220*6777b538SAndroid Build Coastguard Worker 
221*6777b538SAndroid Build Coastguard Worker }  // namespace base
222