xref: /aosp_15_r20/external/libtextclassifier/native/lang_id/common/utf8.h (revision 993b0882672172b81d12fad7a7ac0c3e5c824a12)
1*993b0882SAndroid Build Coastguard Worker /*
2*993b0882SAndroid Build Coastguard Worker  * Copyright (C) 2018 The Android Open Source Project
3*993b0882SAndroid Build Coastguard Worker  *
4*993b0882SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*993b0882SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*993b0882SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*993b0882SAndroid Build Coastguard Worker  *
8*993b0882SAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*993b0882SAndroid Build Coastguard Worker  *
10*993b0882SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*993b0882SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*993b0882SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*993b0882SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*993b0882SAndroid Build Coastguard Worker  * limitations under the License.
15*993b0882SAndroid Build Coastguard Worker  */
16*993b0882SAndroid Build Coastguard Worker 
17*993b0882SAndroid Build Coastguard Worker #ifndef TC3_STD_STRING_IMPORT
18*993b0882SAndroid Build Coastguard Worker #define TC3_STD_STRING_IMPORT
19*993b0882SAndroid Build Coastguard Worker #include <string>
20*993b0882SAndroid Build Coastguard Worker 
21*993b0882SAndroid Build Coastguard Worker namespace libtextclassifier3 {
22*993b0882SAndroid Build Coastguard Worker using string = std::string;
23*993b0882SAndroid Build Coastguard Worker template <class CharT, class Traits = std::char_traits<CharT>,
24*993b0882SAndroid Build Coastguard Worker           class Allocator = std::allocator<CharT> >
25*993b0882SAndroid Build Coastguard Worker using basic_string = std::basic_string<CharT, Traits, Allocator>;
26*993b0882SAndroid Build Coastguard Worker }  // namespace libtextclassifier3
27*993b0882SAndroid Build Coastguard Worker #endif
28*993b0882SAndroid Build Coastguard Worker #ifndef NLP_SAFT_COMPONENTS_COMMON_MOBILE_UTF8_H_
29*993b0882SAndroid Build Coastguard Worker #define NLP_SAFT_COMPONENTS_COMMON_MOBILE_UTF8_H_
30*993b0882SAndroid Build Coastguard Worker 
31*993b0882SAndroid Build Coastguard Worker #include <stddef.h>
32*993b0882SAndroid Build Coastguard Worker 
33*993b0882SAndroid Build Coastguard Worker #include <string>
34*993b0882SAndroid Build Coastguard Worker 
35*993b0882SAndroid Build Coastguard Worker namespace libtextclassifier3 {
36*993b0882SAndroid Build Coastguard Worker namespace mobile {
37*993b0882SAndroid Build Coastguard Worker namespace utils {
38*993b0882SAndroid Build Coastguard Worker 
39*993b0882SAndroid Build Coastguard Worker // Returns the length (number of bytes) of the UTF8 code point starting at src,
40*993b0882SAndroid Build Coastguard Worker // by reading only the byte from address src.
41*993b0882SAndroid Build Coastguard Worker //
42*993b0882SAndroid Build Coastguard Worker // The result is a number from the set {1, 2, 3, 4}.
OneCharLen(const char * src)43*993b0882SAndroid Build Coastguard Worker static inline int OneCharLen(const char *src) {
44*993b0882SAndroid Build Coastguard Worker   // On most platforms, char is unsigned by default, but iOS is an exception.
45*993b0882SAndroid Build Coastguard Worker   // The cast below makes sure we always interpret *src as an unsigned char.
46*993b0882SAndroid Build Coastguard Worker   return "\1\1\1\1\1\1\1\1\1\1\1\1\2\2\3\4"
47*993b0882SAndroid Build Coastguard Worker       [(*(reinterpret_cast<const unsigned char *>(src)) & 0xFF) >> 4];
48*993b0882SAndroid Build Coastguard Worker }
49*993b0882SAndroid Build Coastguard Worker 
50*993b0882SAndroid Build Coastguard Worker // Returns a pointer "end" inside [data, data + size) such that the prefix from
51*993b0882SAndroid Build Coastguard Worker // [data, end) is the largest one that does not contain '\0' and offers the
52*993b0882SAndroid Build Coastguard Worker // following guarantee: if one starts with
53*993b0882SAndroid Build Coastguard Worker //
54*993b0882SAndroid Build Coastguard Worker //   curr = text.data()
55*993b0882SAndroid Build Coastguard Worker //
56*993b0882SAndroid Build Coastguard Worker // and keeps executing
57*993b0882SAndroid Build Coastguard Worker //
58*993b0882SAndroid Build Coastguard Worker //   curr += OneCharLen(curr)
59*993b0882SAndroid Build Coastguard Worker //
60*993b0882SAndroid Build Coastguard Worker // one would eventually reach curr == end (the pointer returned by this
61*993b0882SAndroid Build Coastguard Worker // function) without accessing data outside the string.  This guards against
62*993b0882SAndroid Build Coastguard Worker // scenarios like a broken UTF8 string which has only e.g., the first 2 bytes
63*993b0882SAndroid Build Coastguard Worker // from a 3-byte UTF8 sequence.
64*993b0882SAndroid Build Coastguard Worker //
65*993b0882SAndroid Build Coastguard Worker // Preconditions: data != nullptr.
66*993b0882SAndroid Build Coastguard Worker const char *GetSafeEndOfUtf8String(const char *data, size_t size);
67*993b0882SAndroid Build Coastguard Worker 
GetSafeEndOfUtf8String(const std::string & text)68*993b0882SAndroid Build Coastguard Worker static inline const char *GetSafeEndOfUtf8String(const std::string &text) {
69*993b0882SAndroid Build Coastguard Worker   return GetSafeEndOfUtf8String(text.data(), text.size());
70*993b0882SAndroid Build Coastguard Worker }
71*993b0882SAndroid Build Coastguard Worker 
72*993b0882SAndroid Build Coastguard Worker }  // namespace utils
73*993b0882SAndroid Build Coastguard Worker }  // namespace mobile
74*993b0882SAndroid Build Coastguard Worker }  // namespace nlp_saft
75*993b0882SAndroid Build Coastguard Worker 
76*993b0882SAndroid Build Coastguard Worker #endif  // NLP_SAFT_COMPONENTS_COMMON_MOBILE_UTF8_H_
77