1*6777b538SAndroid Build Coastguard Worker // Copyright 2013 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 // This file defines utility functions for working with strings.
6*6777b538SAndroid Build Coastguard Worker
7*6777b538SAndroid Build Coastguard Worker #ifndef BASE_STRINGS_STRING_UTIL_H_
8*6777b538SAndroid Build Coastguard Worker #define BASE_STRINGS_STRING_UTIL_H_
9*6777b538SAndroid Build Coastguard Worker
10*6777b538SAndroid Build Coastguard Worker #include <stdarg.h> // va_list
11*6777b538SAndroid Build Coastguard Worker #include <stddef.h>
12*6777b538SAndroid Build Coastguard Worker #include <stdint.h>
13*6777b538SAndroid Build Coastguard Worker
14*6777b538SAndroid Build Coastguard Worker #include <concepts>
15*6777b538SAndroid Build Coastguard Worker #include <initializer_list>
16*6777b538SAndroid Build Coastguard Worker #include <memory>
17*6777b538SAndroid Build Coastguard Worker #include <string>
18*6777b538SAndroid Build Coastguard Worker #include <string_view>
19*6777b538SAndroid Build Coastguard Worker #include <vector>
20*6777b538SAndroid Build Coastguard Worker
21*6777b538SAndroid Build Coastguard Worker #include "base/base_export.h"
22*6777b538SAndroid Build Coastguard Worker #include "base/check_op.h"
23*6777b538SAndroid Build Coastguard Worker #include "base/compiler_specific.h"
24*6777b538SAndroid Build Coastguard Worker #include "base/containers/span.h"
25*6777b538SAndroid Build Coastguard Worker #include "base/strings/string_piece.h" // For implicit conversions.
26*6777b538SAndroid Build Coastguard Worker #include "base/strings/string_util_internal.h"
27*6777b538SAndroid Build Coastguard Worker #include "base/types/to_address.h"
28*6777b538SAndroid Build Coastguard Worker #include "build/build_config.h"
29*6777b538SAndroid Build Coastguard Worker
30*6777b538SAndroid Build Coastguard Worker namespace base {
31*6777b538SAndroid Build Coastguard Worker
32*6777b538SAndroid Build Coastguard Worker // C standard-library functions that aren't cross-platform are provided as
33*6777b538SAndroid Build Coastguard Worker // "base::...", and their prototypes are listed below. These functions are
34*6777b538SAndroid Build Coastguard Worker // then implemented as inline calls to the platform-specific equivalents in the
35*6777b538SAndroid Build Coastguard Worker // platform-specific headers.
36*6777b538SAndroid Build Coastguard Worker
37*6777b538SAndroid Build Coastguard Worker // Wrapper for vsnprintf that always null-terminates and always returns the
38*6777b538SAndroid Build Coastguard Worker // number of characters that would be in an untruncated formatted
39*6777b538SAndroid Build Coastguard Worker // string, even when truncation occurs.
40*6777b538SAndroid Build Coastguard Worker int vsnprintf(char* buffer, size_t size, const char* format, va_list arguments)
41*6777b538SAndroid Build Coastguard Worker PRINTF_FORMAT(3, 0);
42*6777b538SAndroid Build Coastguard Worker
43*6777b538SAndroid Build Coastguard Worker // Some of these implementations need to be inlined.
44*6777b538SAndroid Build Coastguard Worker
45*6777b538SAndroid Build Coastguard Worker // We separate the declaration from the implementation of this inline
46*6777b538SAndroid Build Coastguard Worker // function just so the PRINTF_FORMAT works.
47*6777b538SAndroid Build Coastguard Worker inline int snprintf(char* buffer, size_t size, const char* format, ...)
48*6777b538SAndroid Build Coastguard Worker PRINTF_FORMAT(3, 4);
snprintf(char * buffer,size_t size,const char * format,...)49*6777b538SAndroid Build Coastguard Worker inline int snprintf(char* buffer, size_t size, const char* format, ...) {
50*6777b538SAndroid Build Coastguard Worker va_list arguments;
51*6777b538SAndroid Build Coastguard Worker va_start(arguments, format);
52*6777b538SAndroid Build Coastguard Worker int result = vsnprintf(buffer, size, format, arguments);
53*6777b538SAndroid Build Coastguard Worker va_end(arguments);
54*6777b538SAndroid Build Coastguard Worker return result;
55*6777b538SAndroid Build Coastguard Worker }
56*6777b538SAndroid Build Coastguard Worker
57*6777b538SAndroid Build Coastguard Worker // BSD-style safe and consistent string copy functions.
58*6777b538SAndroid Build Coastguard Worker // Copies |src| to |dst|, where |dst_size| is the total allocated size of |dst|.
59*6777b538SAndroid Build Coastguard Worker // Copies at most |dst_size|-1 characters, and always NULL terminates |dst|, as
60*6777b538SAndroid Build Coastguard Worker // long as |dst_size| is not 0. Returns the length of |src| in characters.
61*6777b538SAndroid Build Coastguard Worker // If the return value is >= dst_size, then the output was truncated.
62*6777b538SAndroid Build Coastguard Worker // NOTE: All sizes are in number of characters, NOT in bytes.
63*6777b538SAndroid Build Coastguard Worker BASE_EXPORT size_t strlcpy(char* dst, const char* src, size_t dst_size);
64*6777b538SAndroid Build Coastguard Worker BASE_EXPORT size_t u16cstrlcpy(char16_t* dst,
65*6777b538SAndroid Build Coastguard Worker const char16_t* src,
66*6777b538SAndroid Build Coastguard Worker size_t dst_size);
67*6777b538SAndroid Build Coastguard Worker BASE_EXPORT size_t wcslcpy(wchar_t* dst, const wchar_t* src, size_t dst_size);
68*6777b538SAndroid Build Coastguard Worker
69*6777b538SAndroid Build Coastguard Worker // Scan a wprintf format string to determine whether it's portable across a
70*6777b538SAndroid Build Coastguard Worker // variety of systems. This function only checks that the conversion
71*6777b538SAndroid Build Coastguard Worker // specifiers used by the format string are supported and have the same meaning
72*6777b538SAndroid Build Coastguard Worker // on a variety of systems. It doesn't check for other errors that might occur
73*6777b538SAndroid Build Coastguard Worker // within a format string.
74*6777b538SAndroid Build Coastguard Worker //
75*6777b538SAndroid Build Coastguard Worker // Nonportable conversion specifiers for wprintf are:
76*6777b538SAndroid Build Coastguard Worker // - 's' and 'c' without an 'l' length modifier. %s and %c operate on char
77*6777b538SAndroid Build Coastguard Worker // data on all systems except Windows, which treat them as wchar_t data.
78*6777b538SAndroid Build Coastguard Worker // Use %ls and %lc for wchar_t data instead.
79*6777b538SAndroid Build Coastguard Worker // - 'S' and 'C', which operate on wchar_t data on all systems except Windows,
80*6777b538SAndroid Build Coastguard Worker // which treat them as char data. Use %ls and %lc for wchar_t data
81*6777b538SAndroid Build Coastguard Worker // instead.
82*6777b538SAndroid Build Coastguard Worker // - 'F', which is not identified by Windows wprintf documentation.
83*6777b538SAndroid Build Coastguard Worker // - 'D', 'O', and 'U', which are deprecated and not available on all systems.
84*6777b538SAndroid Build Coastguard Worker // Use %ld, %lo, and %lu instead.
85*6777b538SAndroid Build Coastguard Worker //
86*6777b538SAndroid Build Coastguard Worker // Note that there is no portable conversion specifier for char data when
87*6777b538SAndroid Build Coastguard Worker // working with wprintf.
88*6777b538SAndroid Build Coastguard Worker //
89*6777b538SAndroid Build Coastguard Worker // This function is intended to be called from base::vswprintf.
90*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool IsWprintfFormatPortable(const wchar_t* format);
91*6777b538SAndroid Build Coastguard Worker
92*6777b538SAndroid Build Coastguard Worker // Simplified implementation of C++20's std::basic_string_view(It, End).
93*6777b538SAndroid Build Coastguard Worker // Reference: https://wg21.link/string.view.cons
94*6777b538SAndroid Build Coastguard Worker template <typename CharT, typename Iter>
MakeBasicStringPiece(Iter begin,Iter end)95*6777b538SAndroid Build Coastguard Worker constexpr std::basic_string_view<CharT> MakeBasicStringPiece(Iter begin,
96*6777b538SAndroid Build Coastguard Worker Iter end) {
97*6777b538SAndroid Build Coastguard Worker DCHECK_GE(end - begin, 0);
98*6777b538SAndroid Build Coastguard Worker return {base::to_address(begin), static_cast<size_t>(end - begin)};
99*6777b538SAndroid Build Coastguard Worker }
100*6777b538SAndroid Build Coastguard Worker
101*6777b538SAndroid Build Coastguard Worker // Explicit instantiations of MakeBasicStringPiece for the BasicStringPiece
102*6777b538SAndroid Build Coastguard Worker // aliases defined in base/strings/string_piece.h
103*6777b538SAndroid Build Coastguard Worker template <typename Iter>
MakeStringPiece(Iter begin,Iter end)104*6777b538SAndroid Build Coastguard Worker constexpr StringPiece MakeStringPiece(Iter begin, Iter end) {
105*6777b538SAndroid Build Coastguard Worker return MakeBasicStringPiece<char>(begin, end);
106*6777b538SAndroid Build Coastguard Worker }
107*6777b538SAndroid Build Coastguard Worker
108*6777b538SAndroid Build Coastguard Worker template <typename Iter>
MakeStringPiece16(Iter begin,Iter end)109*6777b538SAndroid Build Coastguard Worker constexpr StringPiece16 MakeStringPiece16(Iter begin, Iter end) {
110*6777b538SAndroid Build Coastguard Worker return MakeBasicStringPiece<char16_t>(begin, end);
111*6777b538SAndroid Build Coastguard Worker }
112*6777b538SAndroid Build Coastguard Worker
113*6777b538SAndroid Build Coastguard Worker template <typename Iter>
MakeWStringView(Iter begin,Iter end)114*6777b538SAndroid Build Coastguard Worker constexpr std::wstring_view MakeWStringView(Iter begin, Iter end) {
115*6777b538SAndroid Build Coastguard Worker return MakeBasicStringPiece<wchar_t>(begin, end);
116*6777b538SAndroid Build Coastguard Worker }
117*6777b538SAndroid Build Coastguard Worker
118*6777b538SAndroid Build Coastguard Worker // ASCII-specific tolower. The standard library's tolower is locale sensitive,
119*6777b538SAndroid Build Coastguard Worker // so we don't want to use it here.
120*6777b538SAndroid Build Coastguard Worker template <typename CharT>
requires(std::integral<CharT>)121*6777b538SAndroid Build Coastguard Worker requires(std::integral<CharT>)
122*6777b538SAndroid Build Coastguard Worker constexpr CharT ToLowerASCII(CharT c) {
123*6777b538SAndroid Build Coastguard Worker return internal::ToLowerASCII(c);
124*6777b538SAndroid Build Coastguard Worker }
125*6777b538SAndroid Build Coastguard Worker
126*6777b538SAndroid Build Coastguard Worker // ASCII-specific toupper. The standard library's toupper is locale sensitive,
127*6777b538SAndroid Build Coastguard Worker // so we don't want to use it here.
128*6777b538SAndroid Build Coastguard Worker template <typename CharT>
requires(std::integral<CharT>)129*6777b538SAndroid Build Coastguard Worker requires(std::integral<CharT>)
130*6777b538SAndroid Build Coastguard Worker CharT ToUpperASCII(CharT c) {
131*6777b538SAndroid Build Coastguard Worker return (c >= 'a' && c <= 'z') ? static_cast<CharT>(c + 'A' - 'a') : c;
132*6777b538SAndroid Build Coastguard Worker }
133*6777b538SAndroid Build Coastguard Worker
134*6777b538SAndroid Build Coastguard Worker // Converts the given string to its ASCII-lowercase equivalent. Non-ASCII
135*6777b538SAndroid Build Coastguard Worker // bytes (or UTF-16 code units in `StringPiece16`) are permitted but will be
136*6777b538SAndroid Build Coastguard Worker // unmodified.
137*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::string ToLowerASCII(StringPiece str);
138*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::u16string ToLowerASCII(StringPiece16 str);
139*6777b538SAndroid Build Coastguard Worker
140*6777b538SAndroid Build Coastguard Worker // Converts the given string to its ASCII-uppercase equivalent. Non-ASCII
141*6777b538SAndroid Build Coastguard Worker // bytes (or UTF-16 code units in `StringPiece16`) are permitted but will be
142*6777b538SAndroid Build Coastguard Worker // unmodified.
143*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::string ToUpperASCII(StringPiece str);
144*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::u16string ToUpperASCII(StringPiece16 str);
145*6777b538SAndroid Build Coastguard Worker
146*6777b538SAndroid Build Coastguard Worker // Functor for ASCII case-insensitive comparisons for STL algorithms like
147*6777b538SAndroid Build Coastguard Worker // std::search. Non-ASCII bytes (or UTF-16 code units in `StringPiece16`) are
148*6777b538SAndroid Build Coastguard Worker // permitted but will be compared as-is.
149*6777b538SAndroid Build Coastguard Worker //
150*6777b538SAndroid Build Coastguard Worker // Note that a full Unicode version of this functor is not possible to write
151*6777b538SAndroid Build Coastguard Worker // because case mappings might change the number of characters, depend on
152*6777b538SAndroid Build Coastguard Worker // context (combining accents), and require handling UTF-16. If you need
153*6777b538SAndroid Build Coastguard Worker // proper Unicode support, use base::i18n::ToLower/FoldCase and then just
154*6777b538SAndroid Build Coastguard Worker // use a normal operator== on the result.
155*6777b538SAndroid Build Coastguard Worker template<typename Char> struct CaseInsensitiveCompareASCII {
156*6777b538SAndroid Build Coastguard Worker public:
operatorCaseInsensitiveCompareASCII157*6777b538SAndroid Build Coastguard Worker bool operator()(Char x, Char y) const {
158*6777b538SAndroid Build Coastguard Worker return ToLowerASCII(x) == ToLowerASCII(y);
159*6777b538SAndroid Build Coastguard Worker }
160*6777b538SAndroid Build Coastguard Worker };
161*6777b538SAndroid Build Coastguard Worker
162*6777b538SAndroid Build Coastguard Worker // Like strcasecmp for ASCII case-insensitive comparisons only. Returns:
163*6777b538SAndroid Build Coastguard Worker // -1 (a < b)
164*6777b538SAndroid Build Coastguard Worker // 0 (a == b)
165*6777b538SAndroid Build Coastguard Worker // 1 (a > b)
166*6777b538SAndroid Build Coastguard Worker // (unlike strcasecmp which can return values greater or less than 1/-1). To
167*6777b538SAndroid Build Coastguard Worker // compare all Unicode code points case-insensitively, use base::i18n::ToLower
168*6777b538SAndroid Build Coastguard Worker // or base::i18n::FoldCase and then just call the normal string operators on the
169*6777b538SAndroid Build Coastguard Worker // result.
170*6777b538SAndroid Build Coastguard Worker //
171*6777b538SAndroid Build Coastguard Worker // Non-ASCII bytes (or UTF-16 code units in `StringPiece16`) are permitted but
172*6777b538SAndroid Build Coastguard Worker // will be compared unmodified.
CompareCaseInsensitiveASCII(StringPiece a,StringPiece b)173*6777b538SAndroid Build Coastguard Worker BASE_EXPORT constexpr int CompareCaseInsensitiveASCII(StringPiece a,
174*6777b538SAndroid Build Coastguard Worker StringPiece b) {
175*6777b538SAndroid Build Coastguard Worker return internal::CompareCaseInsensitiveASCIIT(a, b);
176*6777b538SAndroid Build Coastguard Worker }
CompareCaseInsensitiveASCII(StringPiece16 a,StringPiece16 b)177*6777b538SAndroid Build Coastguard Worker BASE_EXPORT constexpr int CompareCaseInsensitiveASCII(StringPiece16 a,
178*6777b538SAndroid Build Coastguard Worker StringPiece16 b) {
179*6777b538SAndroid Build Coastguard Worker return internal::CompareCaseInsensitiveASCIIT(a, b);
180*6777b538SAndroid Build Coastguard Worker }
181*6777b538SAndroid Build Coastguard Worker
182*6777b538SAndroid Build Coastguard Worker // Equality for ASCII case-insensitive comparisons. Non-ASCII bytes (or UTF-16
183*6777b538SAndroid Build Coastguard Worker // code units in `StringPiece16`) are permitted but will be compared unmodified.
184*6777b538SAndroid Build Coastguard Worker // To compare all Unicode code points case-insensitively, use
185*6777b538SAndroid Build Coastguard Worker // base::i18n::ToLower or base::i18n::FoldCase and then compare with either ==
186*6777b538SAndroid Build Coastguard Worker // or !=.
EqualsCaseInsensitiveASCII(StringPiece a,StringPiece b)187*6777b538SAndroid Build Coastguard Worker inline bool EqualsCaseInsensitiveASCII(StringPiece a, StringPiece b) {
188*6777b538SAndroid Build Coastguard Worker return internal::EqualsCaseInsensitiveASCIIT(a, b);
189*6777b538SAndroid Build Coastguard Worker }
EqualsCaseInsensitiveASCII(StringPiece16 a,StringPiece16 b)190*6777b538SAndroid Build Coastguard Worker inline bool EqualsCaseInsensitiveASCII(StringPiece16 a, StringPiece16 b) {
191*6777b538SAndroid Build Coastguard Worker return internal::EqualsCaseInsensitiveASCIIT(a, b);
192*6777b538SAndroid Build Coastguard Worker }
EqualsCaseInsensitiveASCII(StringPiece16 a,StringPiece b)193*6777b538SAndroid Build Coastguard Worker inline bool EqualsCaseInsensitiveASCII(StringPiece16 a, StringPiece b) {
194*6777b538SAndroid Build Coastguard Worker return internal::EqualsCaseInsensitiveASCIIT(a, b);
195*6777b538SAndroid Build Coastguard Worker }
EqualsCaseInsensitiveASCII(StringPiece a,StringPiece16 b)196*6777b538SAndroid Build Coastguard Worker inline bool EqualsCaseInsensitiveASCII(StringPiece a, StringPiece16 b) {
197*6777b538SAndroid Build Coastguard Worker return internal::EqualsCaseInsensitiveASCIIT(a, b);
198*6777b538SAndroid Build Coastguard Worker }
199*6777b538SAndroid Build Coastguard Worker
200*6777b538SAndroid Build Coastguard Worker // These threadsafe functions return references to globally unique empty
201*6777b538SAndroid Build Coastguard Worker // strings.
202*6777b538SAndroid Build Coastguard Worker //
203*6777b538SAndroid Build Coastguard Worker // It is likely faster to construct a new empty string object (just a few
204*6777b538SAndroid Build Coastguard Worker // instructions to set the length to 0) than to get the empty string instance
205*6777b538SAndroid Build Coastguard Worker // returned by these functions (which requires threadsafe static access).
206*6777b538SAndroid Build Coastguard Worker //
207*6777b538SAndroid Build Coastguard Worker // Therefore, DO NOT USE THESE AS A GENERAL-PURPOSE SUBSTITUTE FOR DEFAULT
208*6777b538SAndroid Build Coastguard Worker // CONSTRUCTORS. There is only one case where you should use these: functions
209*6777b538SAndroid Build Coastguard Worker // which need to return a string by reference (e.g. as a class member
210*6777b538SAndroid Build Coastguard Worker // accessor), and don't have an empty string to use (e.g. in an error case).
211*6777b538SAndroid Build Coastguard Worker // These should not be used as initializers, function arguments, or return
212*6777b538SAndroid Build Coastguard Worker // values for functions which return by value or outparam.
213*6777b538SAndroid Build Coastguard Worker BASE_EXPORT const std::string& EmptyString();
214*6777b538SAndroid Build Coastguard Worker BASE_EXPORT const std::u16string& EmptyString16();
215*6777b538SAndroid Build Coastguard Worker
216*6777b538SAndroid Build Coastguard Worker // Contains the set of characters representing whitespace in the corresponding
217*6777b538SAndroid Build Coastguard Worker // encoding. Null-terminated. The ASCII versions are the whitespaces as defined
218*6777b538SAndroid Build Coastguard Worker // by HTML5, and don't include control characters.
219*6777b538SAndroid Build Coastguard Worker BASE_EXPORT extern const wchar_t kWhitespaceWide[]; // Includes Unicode.
220*6777b538SAndroid Build Coastguard Worker BASE_EXPORT extern const char16_t kWhitespaceUTF16[]; // Includes Unicode.
221*6777b538SAndroid Build Coastguard Worker BASE_EXPORT extern const char16_t
222*6777b538SAndroid Build Coastguard Worker kWhitespaceNoCrLfUTF16[]; // Unicode w/o CR/LF.
223*6777b538SAndroid Build Coastguard Worker BASE_EXPORT extern const char kWhitespaceASCII[];
224*6777b538SAndroid Build Coastguard Worker BASE_EXPORT extern const char16_t kWhitespaceASCIIAs16[]; // No unicode.
225*6777b538SAndroid Build Coastguard Worker //
226*6777b538SAndroid Build Coastguard Worker // https://infra.spec.whatwg.org/#ascii-whitespace
227*6777b538SAndroid Build Coastguard Worker BASE_EXPORT extern const char kInfraAsciiWhitespace[];
228*6777b538SAndroid Build Coastguard Worker
229*6777b538SAndroid Build Coastguard Worker // Null-terminated string representing the UTF-8 byte order mark.
230*6777b538SAndroid Build Coastguard Worker BASE_EXPORT extern const char kUtf8ByteOrderMark[];
231*6777b538SAndroid Build Coastguard Worker
232*6777b538SAndroid Build Coastguard Worker // Removes characters in |remove_chars| from anywhere in |input|. Returns true
233*6777b538SAndroid Build Coastguard Worker // if any characters were removed. |remove_chars| must be null-terminated.
234*6777b538SAndroid Build Coastguard Worker // NOTE: Safe to use the same variable for both |input| and |output|.
235*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool RemoveChars(StringPiece16 input,
236*6777b538SAndroid Build Coastguard Worker StringPiece16 remove_chars,
237*6777b538SAndroid Build Coastguard Worker std::u16string* output);
238*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool RemoveChars(StringPiece input,
239*6777b538SAndroid Build Coastguard Worker StringPiece remove_chars,
240*6777b538SAndroid Build Coastguard Worker std::string* output);
241*6777b538SAndroid Build Coastguard Worker
242*6777b538SAndroid Build Coastguard Worker // Replaces characters in |replace_chars| from anywhere in |input| with
243*6777b538SAndroid Build Coastguard Worker // |replace_with|. Each character in |replace_chars| will be replaced with
244*6777b538SAndroid Build Coastguard Worker // the |replace_with| string. Returns true if any characters were replaced.
245*6777b538SAndroid Build Coastguard Worker // |replace_chars| must be null-terminated.
246*6777b538SAndroid Build Coastguard Worker // NOTE: Safe to use the same variable for both |input| and |output|.
247*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool ReplaceChars(StringPiece16 input,
248*6777b538SAndroid Build Coastguard Worker StringPiece16 replace_chars,
249*6777b538SAndroid Build Coastguard Worker StringPiece16 replace_with,
250*6777b538SAndroid Build Coastguard Worker std::u16string* output);
251*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool ReplaceChars(StringPiece input,
252*6777b538SAndroid Build Coastguard Worker StringPiece replace_chars,
253*6777b538SAndroid Build Coastguard Worker StringPiece replace_with,
254*6777b538SAndroid Build Coastguard Worker std::string* output);
255*6777b538SAndroid Build Coastguard Worker
256*6777b538SAndroid Build Coastguard Worker enum TrimPositions {
257*6777b538SAndroid Build Coastguard Worker TRIM_NONE = 0,
258*6777b538SAndroid Build Coastguard Worker TRIM_LEADING = 1 << 0,
259*6777b538SAndroid Build Coastguard Worker TRIM_TRAILING = 1 << 1,
260*6777b538SAndroid Build Coastguard Worker TRIM_ALL = TRIM_LEADING | TRIM_TRAILING,
261*6777b538SAndroid Build Coastguard Worker };
262*6777b538SAndroid Build Coastguard Worker
263*6777b538SAndroid Build Coastguard Worker // Removes characters in |trim_chars| from the beginning and end of |input|.
264*6777b538SAndroid Build Coastguard Worker // The 8-bit version only works on 8-bit characters, not UTF-8. Returns true if
265*6777b538SAndroid Build Coastguard Worker // any characters were removed.
266*6777b538SAndroid Build Coastguard Worker //
267*6777b538SAndroid Build Coastguard Worker // It is safe to use the same variable for both |input| and |output| (this is
268*6777b538SAndroid Build Coastguard Worker // the normal usage to trim in-place).
269*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool TrimString(StringPiece16 input,
270*6777b538SAndroid Build Coastguard Worker StringPiece16 trim_chars,
271*6777b538SAndroid Build Coastguard Worker std::u16string* output);
272*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool TrimString(StringPiece input,
273*6777b538SAndroid Build Coastguard Worker StringPiece trim_chars,
274*6777b538SAndroid Build Coastguard Worker std::string* output);
275*6777b538SAndroid Build Coastguard Worker
276*6777b538SAndroid Build Coastguard Worker // StringPiece versions of the above. The returned pieces refer to the original
277*6777b538SAndroid Build Coastguard Worker // buffer.
278*6777b538SAndroid Build Coastguard Worker BASE_EXPORT StringPiece16 TrimString(StringPiece16 input,
279*6777b538SAndroid Build Coastguard Worker StringPiece16 trim_chars,
280*6777b538SAndroid Build Coastguard Worker TrimPositions positions);
281*6777b538SAndroid Build Coastguard Worker BASE_EXPORT StringPiece TrimString(StringPiece input,
282*6777b538SAndroid Build Coastguard Worker StringPiece trim_chars,
283*6777b538SAndroid Build Coastguard Worker TrimPositions positions);
284*6777b538SAndroid Build Coastguard Worker
285*6777b538SAndroid Build Coastguard Worker // Truncates a string to the nearest UTF-8 character that will leave
286*6777b538SAndroid Build Coastguard Worker // the string less than or equal to the specified byte size.
287*6777b538SAndroid Build Coastguard Worker BASE_EXPORT void TruncateUTF8ToByteSize(const std::string& input,
288*6777b538SAndroid Build Coastguard Worker const size_t byte_size,
289*6777b538SAndroid Build Coastguard Worker std::string* output);
290*6777b538SAndroid Build Coastguard Worker
291*6777b538SAndroid Build Coastguard Worker // Trims any whitespace from either end of the input string.
292*6777b538SAndroid Build Coastguard Worker //
293*6777b538SAndroid Build Coastguard Worker // The StringPiece versions return a substring referencing the input buffer.
294*6777b538SAndroid Build Coastguard Worker // The ASCII versions look only for ASCII whitespace.
295*6777b538SAndroid Build Coastguard Worker //
296*6777b538SAndroid Build Coastguard Worker // The std::string versions return where whitespace was found.
297*6777b538SAndroid Build Coastguard Worker // NOTE: Safe to use the same variable for both input and output.
298*6777b538SAndroid Build Coastguard Worker BASE_EXPORT TrimPositions TrimWhitespace(StringPiece16 input,
299*6777b538SAndroid Build Coastguard Worker TrimPositions positions,
300*6777b538SAndroid Build Coastguard Worker std::u16string* output);
301*6777b538SAndroid Build Coastguard Worker BASE_EXPORT StringPiece16 TrimWhitespace(StringPiece16 input,
302*6777b538SAndroid Build Coastguard Worker TrimPositions positions);
303*6777b538SAndroid Build Coastguard Worker BASE_EXPORT TrimPositions TrimWhitespaceASCII(StringPiece input,
304*6777b538SAndroid Build Coastguard Worker TrimPositions positions,
305*6777b538SAndroid Build Coastguard Worker std::string* output);
306*6777b538SAndroid Build Coastguard Worker BASE_EXPORT StringPiece TrimWhitespaceASCII(StringPiece input,
307*6777b538SAndroid Build Coastguard Worker TrimPositions positions);
308*6777b538SAndroid Build Coastguard Worker
309*6777b538SAndroid Build Coastguard Worker // Searches for CR or LF characters. Removes all contiguous whitespace
310*6777b538SAndroid Build Coastguard Worker // strings that contain them. This is useful when trying to deal with text
311*6777b538SAndroid Build Coastguard Worker // copied from terminals.
312*6777b538SAndroid Build Coastguard Worker // Returns |text|, with the following three transformations:
313*6777b538SAndroid Build Coastguard Worker // (1) Leading and trailing whitespace is trimmed.
314*6777b538SAndroid Build Coastguard Worker // (2) If |trim_sequences_with_line_breaks| is true, any other whitespace
315*6777b538SAndroid Build Coastguard Worker // sequences containing a CR or LF are trimmed.
316*6777b538SAndroid Build Coastguard Worker // (3) All other whitespace sequences are converted to single spaces.
317*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::u16string CollapseWhitespace(
318*6777b538SAndroid Build Coastguard Worker StringPiece16 text,
319*6777b538SAndroid Build Coastguard Worker bool trim_sequences_with_line_breaks);
320*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::string CollapseWhitespaceASCII(
321*6777b538SAndroid Build Coastguard Worker StringPiece text,
322*6777b538SAndroid Build Coastguard Worker bool trim_sequences_with_line_breaks);
323*6777b538SAndroid Build Coastguard Worker
324*6777b538SAndroid Build Coastguard Worker // Returns true if |input| is empty or contains only characters found in
325*6777b538SAndroid Build Coastguard Worker // |characters|.
326*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool ContainsOnlyChars(StringPiece input, StringPiece characters);
327*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool ContainsOnlyChars(StringPiece16 input,
328*6777b538SAndroid Build Coastguard Worker StringPiece16 characters);
329*6777b538SAndroid Build Coastguard Worker
330*6777b538SAndroid Build Coastguard Worker // Returns true if |str| is structurally valid UTF-8 and also doesn't
331*6777b538SAndroid Build Coastguard Worker // contain any non-character code point (e.g. U+10FFFE). Prohibiting
332*6777b538SAndroid Build Coastguard Worker // non-characters increases the likelihood of detecting non-UTF-8 in
333*6777b538SAndroid Build Coastguard Worker // real-world text, for callers which do not need to accept
334*6777b538SAndroid Build Coastguard Worker // non-characters in strings.
335*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool IsStringUTF8(StringPiece str);
336*6777b538SAndroid Build Coastguard Worker
337*6777b538SAndroid Build Coastguard Worker // Returns true if |str| contains valid UTF-8, allowing non-character
338*6777b538SAndroid Build Coastguard Worker // code points.
339*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool IsStringUTF8AllowingNoncharacters(StringPiece str);
340*6777b538SAndroid Build Coastguard Worker
341*6777b538SAndroid Build Coastguard Worker // Returns true if |str| contains only valid ASCII character values.
342*6777b538SAndroid Build Coastguard Worker // Note 1: IsStringASCII executes in time determined solely by the
343*6777b538SAndroid Build Coastguard Worker // length of the string, not by its contents, so it is robust against
344*6777b538SAndroid Build Coastguard Worker // timing attacks for all strings of equal length.
345*6777b538SAndroid Build Coastguard Worker // Note 2: IsStringASCII assumes the input is likely all ASCII, and
346*6777b538SAndroid Build Coastguard Worker // does not leave early if it is not the case.
347*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool IsStringASCII(StringPiece str);
348*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool IsStringASCII(StringPiece16 str);
349*6777b538SAndroid Build Coastguard Worker
350*6777b538SAndroid Build Coastguard Worker #if defined(WCHAR_T_IS_32_BIT)
351*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool IsStringASCII(std::wstring_view str);
352*6777b538SAndroid Build Coastguard Worker #endif
353*6777b538SAndroid Build Coastguard Worker
354*6777b538SAndroid Build Coastguard Worker // Performs a case-sensitive string compare of the given 16-bit string against
355*6777b538SAndroid Build Coastguard Worker // the given 8-bit ASCII string (typically a constant). The behavior is
356*6777b538SAndroid Build Coastguard Worker // undefined if the |ascii| string is not ASCII.
357*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool EqualsASCII(StringPiece16 str, StringPiece ascii);
358*6777b538SAndroid Build Coastguard Worker
359*6777b538SAndroid Build Coastguard Worker // Indicates case sensitivity of comparisons. Only ASCII case insensitivity
360*6777b538SAndroid Build Coastguard Worker // is supported. Full Unicode case-insensitive conversions would need to go in
361*6777b538SAndroid Build Coastguard Worker // base/i18n so it can use ICU.
362*6777b538SAndroid Build Coastguard Worker //
363*6777b538SAndroid Build Coastguard Worker // If you need to do Unicode-aware case-insensitive StartsWith/EndsWith, it's
364*6777b538SAndroid Build Coastguard Worker // best to call base::i18n::ToLower() or base::i18n::FoldCase() (see
365*6777b538SAndroid Build Coastguard Worker // base/i18n/case_conversion.h for usage advice) on the arguments, and then use
366*6777b538SAndroid Build Coastguard Worker // the results to a case-sensitive comparison.
367*6777b538SAndroid Build Coastguard Worker enum class CompareCase {
368*6777b538SAndroid Build Coastguard Worker SENSITIVE,
369*6777b538SAndroid Build Coastguard Worker INSENSITIVE_ASCII,
370*6777b538SAndroid Build Coastguard Worker };
371*6777b538SAndroid Build Coastguard Worker
372*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool StartsWith(
373*6777b538SAndroid Build Coastguard Worker StringPiece str,
374*6777b538SAndroid Build Coastguard Worker StringPiece search_for,
375*6777b538SAndroid Build Coastguard Worker CompareCase case_sensitivity = CompareCase::SENSITIVE);
376*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool StartsWith(
377*6777b538SAndroid Build Coastguard Worker StringPiece16 str,
378*6777b538SAndroid Build Coastguard Worker StringPiece16 search_for,
379*6777b538SAndroid Build Coastguard Worker CompareCase case_sensitivity = CompareCase::SENSITIVE);
380*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool EndsWith(
381*6777b538SAndroid Build Coastguard Worker StringPiece str,
382*6777b538SAndroid Build Coastguard Worker StringPiece search_for,
383*6777b538SAndroid Build Coastguard Worker CompareCase case_sensitivity = CompareCase::SENSITIVE);
384*6777b538SAndroid Build Coastguard Worker BASE_EXPORT bool EndsWith(
385*6777b538SAndroid Build Coastguard Worker StringPiece16 str,
386*6777b538SAndroid Build Coastguard Worker StringPiece16 search_for,
387*6777b538SAndroid Build Coastguard Worker CompareCase case_sensitivity = CompareCase::SENSITIVE);
388*6777b538SAndroid Build Coastguard Worker
389*6777b538SAndroid Build Coastguard Worker // Determines the type of ASCII character, independent of locale (the C
390*6777b538SAndroid Build Coastguard Worker // library versions will change based on locale).
391*6777b538SAndroid Build Coastguard Worker template <typename Char>
IsAsciiWhitespace(Char c)392*6777b538SAndroid Build Coastguard Worker inline bool IsAsciiWhitespace(Char c) {
393*6777b538SAndroid Build Coastguard Worker // kWhitespaceASCII is a null-terminated string.
394*6777b538SAndroid Build Coastguard Worker for (const char* cur = kWhitespaceASCII; *cur; ++cur) {
395*6777b538SAndroid Build Coastguard Worker if (*cur == c)
396*6777b538SAndroid Build Coastguard Worker return true;
397*6777b538SAndroid Build Coastguard Worker }
398*6777b538SAndroid Build Coastguard Worker return false;
399*6777b538SAndroid Build Coastguard Worker }
400*6777b538SAndroid Build Coastguard Worker template <typename Char>
IsAsciiAlpha(Char c)401*6777b538SAndroid Build Coastguard Worker inline bool IsAsciiAlpha(Char c) {
402*6777b538SAndroid Build Coastguard Worker return (c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z');
403*6777b538SAndroid Build Coastguard Worker }
404*6777b538SAndroid Build Coastguard Worker template <typename Char>
IsAsciiUpper(Char c)405*6777b538SAndroid Build Coastguard Worker inline bool IsAsciiUpper(Char c) {
406*6777b538SAndroid Build Coastguard Worker return c >= 'A' && c <= 'Z';
407*6777b538SAndroid Build Coastguard Worker }
408*6777b538SAndroid Build Coastguard Worker template <typename Char>
IsAsciiLower(Char c)409*6777b538SAndroid Build Coastguard Worker inline bool IsAsciiLower(Char c) {
410*6777b538SAndroid Build Coastguard Worker return c >= 'a' && c <= 'z';
411*6777b538SAndroid Build Coastguard Worker }
412*6777b538SAndroid Build Coastguard Worker template <typename Char>
IsAsciiDigit(Char c)413*6777b538SAndroid Build Coastguard Worker inline bool IsAsciiDigit(Char c) {
414*6777b538SAndroid Build Coastguard Worker return c >= '0' && c <= '9';
415*6777b538SAndroid Build Coastguard Worker }
416*6777b538SAndroid Build Coastguard Worker template <typename Char>
IsAsciiAlphaNumeric(Char c)417*6777b538SAndroid Build Coastguard Worker inline bool IsAsciiAlphaNumeric(Char c) {
418*6777b538SAndroid Build Coastguard Worker return IsAsciiAlpha(c) || IsAsciiDigit(c);
419*6777b538SAndroid Build Coastguard Worker }
420*6777b538SAndroid Build Coastguard Worker template <typename Char>
IsAsciiPrintable(Char c)421*6777b538SAndroid Build Coastguard Worker inline bool IsAsciiPrintable(Char c) {
422*6777b538SAndroid Build Coastguard Worker return c >= ' ' && c <= '~';
423*6777b538SAndroid Build Coastguard Worker }
424*6777b538SAndroid Build Coastguard Worker
425*6777b538SAndroid Build Coastguard Worker template <typename Char>
IsAsciiControl(Char c)426*6777b538SAndroid Build Coastguard Worker inline bool IsAsciiControl(Char c) {
427*6777b538SAndroid Build Coastguard Worker if constexpr (std::is_signed_v<Char>) {
428*6777b538SAndroid Build Coastguard Worker if (c < 0) {
429*6777b538SAndroid Build Coastguard Worker return false;
430*6777b538SAndroid Build Coastguard Worker }
431*6777b538SAndroid Build Coastguard Worker }
432*6777b538SAndroid Build Coastguard Worker return c <= 0x1f || c == 0x7f;
433*6777b538SAndroid Build Coastguard Worker }
434*6777b538SAndroid Build Coastguard Worker
435*6777b538SAndroid Build Coastguard Worker template <typename Char>
IsUnicodeControl(Char c)436*6777b538SAndroid Build Coastguard Worker inline bool IsUnicodeControl(Char c) {
437*6777b538SAndroid Build Coastguard Worker return IsAsciiControl(c) ||
438*6777b538SAndroid Build Coastguard Worker // C1 control characters: http://unicode.org/charts/PDF/U0080.pdf
439*6777b538SAndroid Build Coastguard Worker (c >= 0x80 && c <= 0x9F);
440*6777b538SAndroid Build Coastguard Worker }
441*6777b538SAndroid Build Coastguard Worker
442*6777b538SAndroid Build Coastguard Worker template <typename Char>
IsAsciiPunctuation(Char c)443*6777b538SAndroid Build Coastguard Worker inline bool IsAsciiPunctuation(Char c) {
444*6777b538SAndroid Build Coastguard Worker return c > 0x20 && c < 0x7f && !IsAsciiAlphaNumeric(c);
445*6777b538SAndroid Build Coastguard Worker }
446*6777b538SAndroid Build Coastguard Worker
447*6777b538SAndroid Build Coastguard Worker template <typename Char>
IsHexDigit(Char c)448*6777b538SAndroid Build Coastguard Worker inline bool IsHexDigit(Char c) {
449*6777b538SAndroid Build Coastguard Worker return (c >= '0' && c <= '9') ||
450*6777b538SAndroid Build Coastguard Worker (c >= 'A' && c <= 'F') ||
451*6777b538SAndroid Build Coastguard Worker (c >= 'a' && c <= 'f');
452*6777b538SAndroid Build Coastguard Worker }
453*6777b538SAndroid Build Coastguard Worker
454*6777b538SAndroid Build Coastguard Worker // Returns the integer corresponding to the given hex character. For example:
455*6777b538SAndroid Build Coastguard Worker // '4' -> 4
456*6777b538SAndroid Build Coastguard Worker // 'a' -> 10
457*6777b538SAndroid Build Coastguard Worker // 'B' -> 11
458*6777b538SAndroid Build Coastguard Worker // Assumes the input is a valid hex character.
459*6777b538SAndroid Build Coastguard Worker BASE_EXPORT char HexDigitToInt(char c);
HexDigitToInt(char16_t c)460*6777b538SAndroid Build Coastguard Worker inline char HexDigitToInt(char16_t c) {
461*6777b538SAndroid Build Coastguard Worker DCHECK(IsHexDigit(c));
462*6777b538SAndroid Build Coastguard Worker return HexDigitToInt(static_cast<char>(c));
463*6777b538SAndroid Build Coastguard Worker }
464*6777b538SAndroid Build Coastguard Worker
465*6777b538SAndroid Build Coastguard Worker // Returns whether `c` is a Unicode whitespace character.
466*6777b538SAndroid Build Coastguard Worker // This cannot be used on eight-bit characters, since if they are ASCII you
467*6777b538SAndroid Build Coastguard Worker // should call IsAsciiWhitespace(), and if they are from a UTF-8 string they may
468*6777b538SAndroid Build Coastguard Worker // be individual units of a multi-unit code point. Convert to 16- or 32-bit
469*6777b538SAndroid Build Coastguard Worker // values known to hold the full code point before calling this.
470*6777b538SAndroid Build Coastguard Worker template <typename Char>
471*6777b538SAndroid Build Coastguard Worker requires(sizeof(Char) > 1)
IsUnicodeWhitespace(Char c)472*6777b538SAndroid Build Coastguard Worker inline bool IsUnicodeWhitespace(Char c) {
473*6777b538SAndroid Build Coastguard Worker // kWhitespaceWide is a null-terminated string.
474*6777b538SAndroid Build Coastguard Worker for (const auto* cur = kWhitespaceWide; *cur; ++cur) {
475*6777b538SAndroid Build Coastguard Worker if (static_cast<typename std::make_unsigned_t<wchar_t>>(*cur) ==
476*6777b538SAndroid Build Coastguard Worker static_cast<typename std::make_unsigned_t<Char>>(c))
477*6777b538SAndroid Build Coastguard Worker return true;
478*6777b538SAndroid Build Coastguard Worker }
479*6777b538SAndroid Build Coastguard Worker return false;
480*6777b538SAndroid Build Coastguard Worker }
481*6777b538SAndroid Build Coastguard Worker
482*6777b538SAndroid Build Coastguard Worker // DANGEROUS: Assumes ASCII or not base on the size of `Char`. You should
483*6777b538SAndroid Build Coastguard Worker // probably be explicitly calling IsUnicodeWhitespace() or IsAsciiWhitespace()
484*6777b538SAndroid Build Coastguard Worker // instead!
485*6777b538SAndroid Build Coastguard Worker template <typename Char>
IsWhitespace(Char c)486*6777b538SAndroid Build Coastguard Worker inline bool IsWhitespace(Char c) {
487*6777b538SAndroid Build Coastguard Worker if constexpr (sizeof(Char) > 1) {
488*6777b538SAndroid Build Coastguard Worker return IsUnicodeWhitespace(c);
489*6777b538SAndroid Build Coastguard Worker } else {
490*6777b538SAndroid Build Coastguard Worker return IsAsciiWhitespace(c);
491*6777b538SAndroid Build Coastguard Worker }
492*6777b538SAndroid Build Coastguard Worker }
493*6777b538SAndroid Build Coastguard Worker
494*6777b538SAndroid Build Coastguard Worker // Return a byte string in human-readable format with a unit suffix. Not
495*6777b538SAndroid Build Coastguard Worker // appropriate for use in any UI; use of FormatBytes and friends in ui/base is
496*6777b538SAndroid Build Coastguard Worker // highly recommended instead. TODO(avi): Figure out how to get callers to use
497*6777b538SAndroid Build Coastguard Worker // FormatBytes instead; remove this.
498*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::u16string FormatBytesUnlocalized(int64_t bytes);
499*6777b538SAndroid Build Coastguard Worker
500*6777b538SAndroid Build Coastguard Worker // Starting at |start_offset| (usually 0), replace the first instance of
501*6777b538SAndroid Build Coastguard Worker // |find_this| with |replace_with|.
502*6777b538SAndroid Build Coastguard Worker BASE_EXPORT void ReplaceFirstSubstringAfterOffset(std::u16string* str,
503*6777b538SAndroid Build Coastguard Worker size_t start_offset,
504*6777b538SAndroid Build Coastguard Worker StringPiece16 find_this,
505*6777b538SAndroid Build Coastguard Worker StringPiece16 replace_with);
506*6777b538SAndroid Build Coastguard Worker BASE_EXPORT void ReplaceFirstSubstringAfterOffset(
507*6777b538SAndroid Build Coastguard Worker std::string* str,
508*6777b538SAndroid Build Coastguard Worker size_t start_offset,
509*6777b538SAndroid Build Coastguard Worker StringPiece find_this,
510*6777b538SAndroid Build Coastguard Worker StringPiece replace_with);
511*6777b538SAndroid Build Coastguard Worker
512*6777b538SAndroid Build Coastguard Worker // Starting at |start_offset| (usually 0), look through |str| and replace all
513*6777b538SAndroid Build Coastguard Worker // instances of |find_this| with |replace_with|.
514*6777b538SAndroid Build Coastguard Worker //
515*6777b538SAndroid Build Coastguard Worker // This does entire substrings; use std::replace in <algorithm> for single
516*6777b538SAndroid Build Coastguard Worker // characters, for example:
517*6777b538SAndroid Build Coastguard Worker // std::replace(str.begin(), str.end(), 'a', 'b');
518*6777b538SAndroid Build Coastguard Worker BASE_EXPORT void ReplaceSubstringsAfterOffset(std::u16string* str,
519*6777b538SAndroid Build Coastguard Worker size_t start_offset,
520*6777b538SAndroid Build Coastguard Worker StringPiece16 find_this,
521*6777b538SAndroid Build Coastguard Worker StringPiece16 replace_with);
522*6777b538SAndroid Build Coastguard Worker BASE_EXPORT void ReplaceSubstringsAfterOffset(
523*6777b538SAndroid Build Coastguard Worker std::string* str,
524*6777b538SAndroid Build Coastguard Worker size_t start_offset,
525*6777b538SAndroid Build Coastguard Worker StringPiece find_this,
526*6777b538SAndroid Build Coastguard Worker StringPiece replace_with);
527*6777b538SAndroid Build Coastguard Worker
528*6777b538SAndroid Build Coastguard Worker // Reserves enough memory in |str| to accommodate |length_with_null| characters,
529*6777b538SAndroid Build Coastguard Worker // sets the size of |str| to |length_with_null - 1| characters, and returns a
530*6777b538SAndroid Build Coastguard Worker // pointer to the underlying contiguous array of characters. This is typically
531*6777b538SAndroid Build Coastguard Worker // used when calling a function that writes results into a character array, but
532*6777b538SAndroid Build Coastguard Worker // the caller wants the data to be managed by a string-like object. It is
533*6777b538SAndroid Build Coastguard Worker // convenient in that is can be used inline in the call, and fast in that it
534*6777b538SAndroid Build Coastguard Worker // avoids copying the results of the call from a char* into a string.
535*6777b538SAndroid Build Coastguard Worker //
536*6777b538SAndroid Build Coastguard Worker // Internally, this takes linear time because the resize() call 0-fills the
537*6777b538SAndroid Build Coastguard Worker // underlying array for potentially all
538*6777b538SAndroid Build Coastguard Worker // (|length_with_null - 1| * sizeof(string_type::value_type)) bytes. Ideally we
539*6777b538SAndroid Build Coastguard Worker // could avoid this aspect of the resize() call, as we expect the caller to
540*6777b538SAndroid Build Coastguard Worker // immediately write over this memory, but there is no other way to set the size
541*6777b538SAndroid Build Coastguard Worker // of the string, and not doing that will mean people who access |str| rather
542*6777b538SAndroid Build Coastguard Worker // than str.c_str() will get back a string of whatever size |str| had on entry
543*6777b538SAndroid Build Coastguard Worker // to this function (probably 0).
544*6777b538SAndroid Build Coastguard Worker BASE_EXPORT char* WriteInto(std::string* str, size_t length_with_null);
545*6777b538SAndroid Build Coastguard Worker BASE_EXPORT char16_t* WriteInto(std::u16string* str, size_t length_with_null);
546*6777b538SAndroid Build Coastguard Worker
547*6777b538SAndroid Build Coastguard Worker // Joins a list of strings into a single string, inserting |separator| (which
548*6777b538SAndroid Build Coastguard Worker // may be empty) in between all elements.
549*6777b538SAndroid Build Coastguard Worker //
550*6777b538SAndroid Build Coastguard Worker // Note this is inverse of SplitString()/SplitStringPiece() defined in
551*6777b538SAndroid Build Coastguard Worker // string_split.h.
552*6777b538SAndroid Build Coastguard Worker //
553*6777b538SAndroid Build Coastguard Worker // If possible, callers should build a vector of StringPieces and use the
554*6777b538SAndroid Build Coastguard Worker // StringPiece variant, so that they do not create unnecessary copies of
555*6777b538SAndroid Build Coastguard Worker // strings. For example, instead of using SplitString, modifying the vector,
556*6777b538SAndroid Build Coastguard Worker // then using JoinString, use SplitStringPiece followed by JoinString so that no
557*6777b538SAndroid Build Coastguard Worker // copies of those strings are created until the final join operation.
558*6777b538SAndroid Build Coastguard Worker //
559*6777b538SAndroid Build Coastguard Worker // Use StrCat (in base/strings/strcat.h) if you don't need a separator.
560*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::string JoinString(span<const std::string> parts,
561*6777b538SAndroid Build Coastguard Worker StringPiece separator);
562*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::u16string JoinString(span<const std::u16string> parts,
563*6777b538SAndroid Build Coastguard Worker StringPiece16 separator);
564*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::string JoinString(span<const StringPiece> parts,
565*6777b538SAndroid Build Coastguard Worker StringPiece separator);
566*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::u16string JoinString(span<const StringPiece16> parts,
567*6777b538SAndroid Build Coastguard Worker StringPiece16 separator);
568*6777b538SAndroid Build Coastguard Worker // Explicit initializer_list overloads are required to break ambiguity when used
569*6777b538SAndroid Build Coastguard Worker // with a literal initializer list (otherwise the compiler would not be able to
570*6777b538SAndroid Build Coastguard Worker // decide between the string and StringPiece overloads).
571*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::string JoinString(std::initializer_list<StringPiece> parts,
572*6777b538SAndroid Build Coastguard Worker StringPiece separator);
573*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::u16string JoinString(
574*6777b538SAndroid Build Coastguard Worker std::initializer_list<StringPiece16> parts,
575*6777b538SAndroid Build Coastguard Worker StringPiece16 separator);
576*6777b538SAndroid Build Coastguard Worker
577*6777b538SAndroid Build Coastguard Worker // Replace $1-$2-$3..$9 in the format string with values from |subst|.
578*6777b538SAndroid Build Coastguard Worker // Additionally, any number of consecutive '$' characters is replaced by that
579*6777b538SAndroid Build Coastguard Worker // number less one. Eg $$->$, $$$->$$, etc. The offsets parameter here can be
580*6777b538SAndroid Build Coastguard Worker // NULL. This only allows you to use up to nine replacements.
581*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::u16string ReplaceStringPlaceholders(
582*6777b538SAndroid Build Coastguard Worker StringPiece16 format_string,
583*6777b538SAndroid Build Coastguard Worker const std::vector<std::u16string>& subst,
584*6777b538SAndroid Build Coastguard Worker std::vector<size_t>* offsets);
585*6777b538SAndroid Build Coastguard Worker
586*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::string ReplaceStringPlaceholders(
587*6777b538SAndroid Build Coastguard Worker StringPiece format_string,
588*6777b538SAndroid Build Coastguard Worker const std::vector<std::string>& subst,
589*6777b538SAndroid Build Coastguard Worker std::vector<size_t>* offsets);
590*6777b538SAndroid Build Coastguard Worker
591*6777b538SAndroid Build Coastguard Worker // Single-string shortcut for ReplaceStringHolders. |offset| may be NULL.
592*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::u16string ReplaceStringPlaceholders(
593*6777b538SAndroid Build Coastguard Worker const std::u16string& format_string,
594*6777b538SAndroid Build Coastguard Worker const std::u16string& a,
595*6777b538SAndroid Build Coastguard Worker size_t* offset);
596*6777b538SAndroid Build Coastguard Worker
597*6777b538SAndroid Build Coastguard Worker } // namespace base
598*6777b538SAndroid Build Coastguard Worker
599*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
600*6777b538SAndroid Build Coastguard Worker #include "base/strings/string_util_win.h"
601*6777b538SAndroid Build Coastguard Worker #elif BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
602*6777b538SAndroid Build Coastguard Worker #include "base/strings/string_util_posix.h"
603*6777b538SAndroid Build Coastguard Worker #else
604*6777b538SAndroid Build Coastguard Worker #error Define string operations appropriately for your platform
605*6777b538SAndroid Build Coastguard Worker #endif
606*6777b538SAndroid Build Coastguard Worker
607*6777b538SAndroid Build Coastguard Worker #endif // BASE_STRINGS_STRING_UTIL_H_
608