xref: /aosp_15_r20/frameworks/base/libs/androidfw/Util.cpp (revision d57664e9bc4670b3ecf6748a746a57c557b6bc9e)
1*d57664e9SAndroid Build Coastguard Worker /*
2*d57664e9SAndroid Build Coastguard Worker  * Copyright (C) 2016 The Android Open Source Project
3*d57664e9SAndroid Build Coastguard Worker  *
4*d57664e9SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*d57664e9SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*d57664e9SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*d57664e9SAndroid Build Coastguard Worker  *
8*d57664e9SAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*d57664e9SAndroid Build Coastguard Worker  *
10*d57664e9SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*d57664e9SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*d57664e9SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*d57664e9SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*d57664e9SAndroid Build Coastguard Worker  * limitations under the License.
15*d57664e9SAndroid Build Coastguard Worker  */
16*d57664e9SAndroid Build Coastguard Worker 
17*d57664e9SAndroid Build Coastguard Worker #include "androidfw/Util.h"
18*d57664e9SAndroid Build Coastguard Worker 
19*d57664e9SAndroid Build Coastguard Worker #include <algorithm>
20*d57664e9SAndroid Build Coastguard Worker #include <string>
21*d57664e9SAndroid Build Coastguard Worker 
22*d57664e9SAndroid Build Coastguard Worker #include "utils/ByteOrder.h"
23*d57664e9SAndroid Build Coastguard Worker #include "utils/Unicode.h"
24*d57664e9SAndroid Build Coastguard Worker 
25*d57664e9SAndroid Build Coastguard Worker #ifdef _WIN32
26*d57664e9SAndroid Build Coastguard Worker #ifdef ERROR
27*d57664e9SAndroid Build Coastguard Worker #undef ERROR
28*d57664e9SAndroid Build Coastguard Worker #endif
29*d57664e9SAndroid Build Coastguard Worker #endif
30*d57664e9SAndroid Build Coastguard Worker 
31*d57664e9SAndroid Build Coastguard Worker namespace android {
32*d57664e9SAndroid Build Coastguard Worker namespace util {
33*d57664e9SAndroid Build Coastguard Worker 
ReadUtf16StringFromDevice(const uint16_t * src,size_t len,std::string * out)34*d57664e9SAndroid Build Coastguard Worker void ReadUtf16StringFromDevice(const uint16_t* src, size_t len, std::string* out) {
35*d57664e9SAndroid Build Coastguard Worker   char buf[5];
36*d57664e9SAndroid Build Coastguard Worker   while (*src && len != 0) {
37*d57664e9SAndroid Build Coastguard Worker     char16_t c = static_cast<char16_t>(dtohs(*src));
38*d57664e9SAndroid Build Coastguard Worker     utf16_to_utf8(&c, 1, buf, sizeof(buf));
39*d57664e9SAndroid Build Coastguard Worker     out->append(buf, strlen(buf));
40*d57664e9SAndroid Build Coastguard Worker     ++src;
41*d57664e9SAndroid Build Coastguard Worker     --len;
42*d57664e9SAndroid Build Coastguard Worker   }
43*d57664e9SAndroid Build Coastguard Worker }
44*d57664e9SAndroid Build Coastguard Worker 
Utf8ToUtf16(StringPiece utf8)45*d57664e9SAndroid Build Coastguard Worker std::u16string Utf8ToUtf16(StringPiece utf8) {
46*d57664e9SAndroid Build Coastguard Worker   ssize_t utf16_length =
47*d57664e9SAndroid Build Coastguard Worker       utf8_to_utf16_length(reinterpret_cast<const uint8_t*>(utf8.data()), utf8.length());
48*d57664e9SAndroid Build Coastguard Worker   if (utf16_length <= 0) {
49*d57664e9SAndroid Build Coastguard Worker     return {};
50*d57664e9SAndroid Build Coastguard Worker   }
51*d57664e9SAndroid Build Coastguard Worker 
52*d57664e9SAndroid Build Coastguard Worker   std::u16string utf16;
53*d57664e9SAndroid Build Coastguard Worker   utf16.resize(utf16_length);
54*d57664e9SAndroid Build Coastguard Worker   utf8_to_utf16(reinterpret_cast<const uint8_t*>(utf8.data()), utf8.length(), &*utf16.begin(),
55*d57664e9SAndroid Build Coastguard Worker                 utf16_length + 1);
56*d57664e9SAndroid Build Coastguard Worker   return utf16;
57*d57664e9SAndroid Build Coastguard Worker }
58*d57664e9SAndroid Build Coastguard Worker 
Utf16ToUtf8(StringPiece16 utf16)59*d57664e9SAndroid Build Coastguard Worker std::string Utf16ToUtf8(StringPiece16 utf16) {
60*d57664e9SAndroid Build Coastguard Worker   ssize_t utf8_length = utf16_to_utf8_length(utf16.data(), utf16.length());
61*d57664e9SAndroid Build Coastguard Worker   if (utf8_length <= 0) {
62*d57664e9SAndroid Build Coastguard Worker     return {};
63*d57664e9SAndroid Build Coastguard Worker   }
64*d57664e9SAndroid Build Coastguard Worker 
65*d57664e9SAndroid Build Coastguard Worker   std::string utf8;
66*d57664e9SAndroid Build Coastguard Worker   utf8.resize(utf8_length);
67*d57664e9SAndroid Build Coastguard Worker   utf16_to_utf8(utf16.data(), utf16.length(), &*utf8.begin(), utf8_length + 1);
68*d57664e9SAndroid Build Coastguard Worker   return utf8;
69*d57664e9SAndroid Build Coastguard Worker }
70*d57664e9SAndroid Build Coastguard Worker 
Utf8ToModifiedUtf8(std::string_view utf8)71*d57664e9SAndroid Build Coastguard Worker std::string Utf8ToModifiedUtf8(std::string_view utf8) {
72*d57664e9SAndroid Build Coastguard Worker   // Java uses Modified UTF-8 which only supports the 1, 2, and 3 byte formats of UTF-8. To encode
73*d57664e9SAndroid Build Coastguard Worker   // 4 byte UTF-8 codepoints, Modified UTF-8 allows the use of surrogate pairs in the same format
74*d57664e9SAndroid Build Coastguard Worker   // of CESU-8 surrogate pairs. Calculate the size of the utf8 string with all 4 byte UTF-8
75*d57664e9SAndroid Build Coastguard Worker   // codepoints replaced with 2 3 byte surrogate pairs
76*d57664e9SAndroid Build Coastguard Worker   size_t modified_size = 0;
77*d57664e9SAndroid Build Coastguard Worker   const size_t size = utf8.size();
78*d57664e9SAndroid Build Coastguard Worker   for (size_t i = 0; i < size; i++) {
79*d57664e9SAndroid Build Coastguard Worker     if (((uint8_t)utf8[i] >> 4) == 0xF) {
80*d57664e9SAndroid Build Coastguard Worker       modified_size += 6;
81*d57664e9SAndroid Build Coastguard Worker       i += 3;
82*d57664e9SAndroid Build Coastguard Worker     } else {
83*d57664e9SAndroid Build Coastguard Worker       modified_size++;
84*d57664e9SAndroid Build Coastguard Worker     }
85*d57664e9SAndroid Build Coastguard Worker   }
86*d57664e9SAndroid Build Coastguard Worker 
87*d57664e9SAndroid Build Coastguard Worker   // Early out if no 4 byte codepoints are found
88*d57664e9SAndroid Build Coastguard Worker   if (size == modified_size) {
89*d57664e9SAndroid Build Coastguard Worker     return std::string(utf8);
90*d57664e9SAndroid Build Coastguard Worker   }
91*d57664e9SAndroid Build Coastguard Worker 
92*d57664e9SAndroid Build Coastguard Worker   std::string output;
93*d57664e9SAndroid Build Coastguard Worker   output.reserve(modified_size);
94*d57664e9SAndroid Build Coastguard Worker   for (size_t i = 0; i < size; i++) {
95*d57664e9SAndroid Build Coastguard Worker     if (((uint8_t)utf8[i] >> 4) == 0xF) {
96*d57664e9SAndroid Build Coastguard Worker       int32_t codepoint = utf32_from_utf8_at(utf8.data(), size, i, nullptr);
97*d57664e9SAndroid Build Coastguard Worker 
98*d57664e9SAndroid Build Coastguard Worker       // Calculate the high and low surrogates as UTF-16 would
99*d57664e9SAndroid Build Coastguard Worker       int32_t high = ((codepoint - 0x10000) / 0x400) + 0xD800;
100*d57664e9SAndroid Build Coastguard Worker       int32_t low = ((codepoint - 0x10000) % 0x400) + 0xDC00;
101*d57664e9SAndroid Build Coastguard Worker 
102*d57664e9SAndroid Build Coastguard Worker       // Encode each surrogate in UTF-8
103*d57664e9SAndroid Build Coastguard Worker       output.push_back((char)(0xE4 | ((high >> 12) & 0xF)));
104*d57664e9SAndroid Build Coastguard Worker       output.push_back((char)(0x80 | ((high >> 6) & 0x3F)));
105*d57664e9SAndroid Build Coastguard Worker       output.push_back((char)(0x80 | (high & 0x3F)));
106*d57664e9SAndroid Build Coastguard Worker       output.push_back((char)(0xE4 | ((low >> 12) & 0xF)));
107*d57664e9SAndroid Build Coastguard Worker       output.push_back((char)(0x80 | ((low >> 6) & 0x3F)));
108*d57664e9SAndroid Build Coastguard Worker       output.push_back((char)(0x80 | (low & 0x3F)));
109*d57664e9SAndroid Build Coastguard Worker       i += 3;
110*d57664e9SAndroid Build Coastguard Worker     } else {
111*d57664e9SAndroid Build Coastguard Worker       output.push_back(utf8[i]);
112*d57664e9SAndroid Build Coastguard Worker     }
113*d57664e9SAndroid Build Coastguard Worker   }
114*d57664e9SAndroid Build Coastguard Worker 
115*d57664e9SAndroid Build Coastguard Worker   return output;
116*d57664e9SAndroid Build Coastguard Worker }
117*d57664e9SAndroid Build Coastguard Worker 
ModifiedUtf8ToUtf8(std::string_view modified_utf8)118*d57664e9SAndroid Build Coastguard Worker std::string ModifiedUtf8ToUtf8(std::string_view modified_utf8) {
119*d57664e9SAndroid Build Coastguard Worker   // The UTF-8 representation will have a byte length less than or equal to the Modified UTF-8
120*d57664e9SAndroid Build Coastguard Worker   // representation.
121*d57664e9SAndroid Build Coastguard Worker   std::string output;
122*d57664e9SAndroid Build Coastguard Worker   output.reserve(modified_utf8.size());
123*d57664e9SAndroid Build Coastguard Worker 
124*d57664e9SAndroid Build Coastguard Worker   size_t index = 0;
125*d57664e9SAndroid Build Coastguard Worker   const size_t modified_size = modified_utf8.size();
126*d57664e9SAndroid Build Coastguard Worker   while (index < modified_size) {
127*d57664e9SAndroid Build Coastguard Worker     size_t next_index;
128*d57664e9SAndroid Build Coastguard Worker     int32_t high_surrogate =
129*d57664e9SAndroid Build Coastguard Worker         utf32_from_utf8_at(modified_utf8.data(), modified_size, index, &next_index);
130*d57664e9SAndroid Build Coastguard Worker     if (high_surrogate < 0) {
131*d57664e9SAndroid Build Coastguard Worker       return {};
132*d57664e9SAndroid Build Coastguard Worker     }
133*d57664e9SAndroid Build Coastguard Worker 
134*d57664e9SAndroid Build Coastguard Worker     // Check that the first codepoint is within the high surrogate range
135*d57664e9SAndroid Build Coastguard Worker     if (high_surrogate >= 0xD800 && high_surrogate <= 0xDB7F) {
136*d57664e9SAndroid Build Coastguard Worker       int32_t low_surrogate =
137*d57664e9SAndroid Build Coastguard Worker           utf32_from_utf8_at(modified_utf8.data(), modified_size, next_index, &next_index);
138*d57664e9SAndroid Build Coastguard Worker       if (low_surrogate < 0) {
139*d57664e9SAndroid Build Coastguard Worker         return {};
140*d57664e9SAndroid Build Coastguard Worker       }
141*d57664e9SAndroid Build Coastguard Worker 
142*d57664e9SAndroid Build Coastguard Worker       // Check that the second codepoint is within the low surrogate range
143*d57664e9SAndroid Build Coastguard Worker       if (low_surrogate >= 0xDC00 && low_surrogate <= 0xDFFF) {
144*d57664e9SAndroid Build Coastguard Worker         const char32_t codepoint =
145*d57664e9SAndroid Build Coastguard Worker             (char32_t)(((high_surrogate - 0xD800) * 0x400) + (low_surrogate - 0xDC00) + 0x10000);
146*d57664e9SAndroid Build Coastguard Worker 
147*d57664e9SAndroid Build Coastguard Worker         // The decoded codepoint should represent a 4 byte, UTF-8 character
148*d57664e9SAndroid Build Coastguard Worker         const size_t utf8_length = (size_t)utf32_to_utf8_length(&codepoint, 1);
149*d57664e9SAndroid Build Coastguard Worker         if (utf8_length != 4) {
150*d57664e9SAndroid Build Coastguard Worker           return {};
151*d57664e9SAndroid Build Coastguard Worker         }
152*d57664e9SAndroid Build Coastguard Worker 
153*d57664e9SAndroid Build Coastguard Worker         // Encode the UTF-8 representation of the codepoint into the string
154*d57664e9SAndroid Build Coastguard Worker         const size_t start_index = output.size();
155*d57664e9SAndroid Build Coastguard Worker         output.resize(start_index + utf8_length);
156*d57664e9SAndroid Build Coastguard Worker         char* start = &output[start_index];
157*d57664e9SAndroid Build Coastguard Worker         utf32_to_utf8((char32_t*)&codepoint, 1, start, utf8_length + 1);
158*d57664e9SAndroid Build Coastguard Worker 
159*d57664e9SAndroid Build Coastguard Worker         index = next_index;
160*d57664e9SAndroid Build Coastguard Worker         continue;
161*d57664e9SAndroid Build Coastguard Worker       }
162*d57664e9SAndroid Build Coastguard Worker     }
163*d57664e9SAndroid Build Coastguard Worker 
164*d57664e9SAndroid Build Coastguard Worker     // Append non-surrogate pairs to the output string
165*d57664e9SAndroid Build Coastguard Worker     for (size_t i = index; i < next_index; i++) {
166*d57664e9SAndroid Build Coastguard Worker       output.push_back(modified_utf8[i]);
167*d57664e9SAndroid Build Coastguard Worker     }
168*d57664e9SAndroid Build Coastguard Worker     index = next_index;
169*d57664e9SAndroid Build Coastguard Worker   }
170*d57664e9SAndroid Build Coastguard Worker   return output;
171*d57664e9SAndroid Build Coastguard Worker }
172*d57664e9SAndroid Build Coastguard Worker 
173*d57664e9SAndroid Build Coastguard Worker template <class Func>
SplitAndTransform(StringPiece str,char sep,Func && f)174*d57664e9SAndroid Build Coastguard Worker static std::vector<std::string> SplitAndTransform(StringPiece str, char sep, Func&& f) {
175*d57664e9SAndroid Build Coastguard Worker   std::vector<std::string> parts;
176*d57664e9SAndroid Build Coastguard Worker   const StringPiece::const_iterator end = std::end(str);
177*d57664e9SAndroid Build Coastguard Worker   StringPiece::const_iterator start = std::begin(str);
178*d57664e9SAndroid Build Coastguard Worker   StringPiece::const_iterator current;
179*d57664e9SAndroid Build Coastguard Worker   do {
180*d57664e9SAndroid Build Coastguard Worker     current = std::find(start, end, sep);
181*d57664e9SAndroid Build Coastguard Worker     parts.emplace_back(StringPiece(start, current - start));
182*d57664e9SAndroid Build Coastguard Worker     std::string& part = parts.back();
183*d57664e9SAndroid Build Coastguard Worker     std::transform(part.begin(), part.end(), part.begin(), f);
184*d57664e9SAndroid Build Coastguard Worker     start = current + 1;
185*d57664e9SAndroid Build Coastguard Worker   } while (current != end);
186*d57664e9SAndroid Build Coastguard Worker   return parts;
187*d57664e9SAndroid Build Coastguard Worker }
188*d57664e9SAndroid Build Coastguard Worker 
SplitAndLowercase(StringPiece str,char sep)189*d57664e9SAndroid Build Coastguard Worker std::vector<std::string> SplitAndLowercase(StringPiece str, char sep) {
190*d57664e9SAndroid Build Coastguard Worker   return SplitAndTransform(str, sep, [](char c) { return ::tolower(c); });
191*d57664e9SAndroid Build Coastguard Worker }
192*d57664e9SAndroid Build Coastguard Worker 
Copy(const BigBuffer & buffer)193*d57664e9SAndroid Build Coastguard Worker std::unique_ptr<uint8_t[]> Copy(const BigBuffer& buffer) {
194*d57664e9SAndroid Build Coastguard Worker   auto data = std::unique_ptr<uint8_t[]>(new uint8_t[buffer.size()]);
195*d57664e9SAndroid Build Coastguard Worker   uint8_t* p = data.get();
196*d57664e9SAndroid Build Coastguard Worker   for (const auto& block : buffer) {
197*d57664e9SAndroid Build Coastguard Worker     memcpy(p, block.buffer.get(), block.size);
198*d57664e9SAndroid Build Coastguard Worker     p += block.size;
199*d57664e9SAndroid Build Coastguard Worker   }
200*d57664e9SAndroid Build Coastguard Worker   return data;
201*d57664e9SAndroid Build Coastguard Worker }
202*d57664e9SAndroid Build Coastguard Worker 
GetString16(const android::ResStringPool & pool,size_t idx)203*d57664e9SAndroid Build Coastguard Worker StringPiece16 GetString16(const android::ResStringPool& pool, size_t idx) {
204*d57664e9SAndroid Build Coastguard Worker   if (auto str = pool.stringAt(idx); str.ok()) {
205*d57664e9SAndroid Build Coastguard Worker     return *str;
206*d57664e9SAndroid Build Coastguard Worker   }
207*d57664e9SAndroid Build Coastguard Worker   return StringPiece16();
208*d57664e9SAndroid Build Coastguard Worker }
209*d57664e9SAndroid Build Coastguard Worker 
GetString(const android::ResStringPool & pool,size_t idx)210*d57664e9SAndroid Build Coastguard Worker std::string GetString(const android::ResStringPool& pool, size_t idx) {
211*d57664e9SAndroid Build Coastguard Worker   if (auto str = pool.string8At(idx); str.ok()) {
212*d57664e9SAndroid Build Coastguard Worker     return ModifiedUtf8ToUtf8(*str);
213*d57664e9SAndroid Build Coastguard Worker   }
214*d57664e9SAndroid Build Coastguard Worker   return Utf16ToUtf8(GetString16(pool, idx));
215*d57664e9SAndroid Build Coastguard Worker }
216*d57664e9SAndroid Build Coastguard Worker 
217*d57664e9SAndroid Build Coastguard Worker } // namespace util
218*d57664e9SAndroid Build Coastguard Worker } // namespace android
219