a87529fc6b3b82f238ae750ff9c293d648b2c3e7
[WebKit-https.git] / Source / WTF / wtf / text / WTFString.cpp
1 /*
2  * (C) 1999 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2004-2017 Apple Inc. All rights reserved.
4  * Copyright (C) 2007-2009 Torch Mobile, Inc.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #include "config.h"
23 #include "WTFString.h"
24
25 #include "IntegerToStringConversion.h"
26 #include <stdarg.h>
27 #include <wtf/ASCIICType.h>
28 #include <wtf/DataLog.h>
29 #include <wtf/HexNumber.h>
30 #include <wtf/MathExtras.h>
31 #include <wtf/NeverDestroyed.h>
32 #include <wtf/text/CString.h>
33 #include <wtf/Vector.h>
34 #include <wtf/dtoa.h>
35 #include <wtf/unicode/CharacterNames.h>
36 #include <wtf/unicode/UTF8.h>
37
38 namespace WTF {
39
40 using namespace Unicode;
41
42 // Construct a string with UTF-16 data.
43 String::String(const UChar* characters, unsigned length)
44 {
45     if (characters)
46         m_impl = StringImpl::create(characters, length);
47 }
48
49 // Construct a string with UTF-16 data, from a null-terminated source.
50 String::String(const UChar* nullTerminatedString)
51 {
52     if (nullTerminatedString)
53         m_impl = StringImpl::create(nullTerminatedString, lengthOfNullTerminatedString(nullTerminatedString));
54 }
55
56 // Construct a string with latin1 data.
57 String::String(const LChar* characters, unsigned length)
58 {
59     if (characters)
60         m_impl = StringImpl::create(characters, length);
61 }
62
63 String::String(const char* characters, unsigned length)
64 {
65     if (characters)
66         m_impl = StringImpl::create(reinterpret_cast<const LChar*>(characters), length);
67 }
68
69 // Construct a string with Latin-1 data, from a null-terminated source.
70 String::String(const LChar* nullTerminatedString)
71 {
72     if (nullTerminatedString)
73         m_impl = StringImpl::create(nullTerminatedString);
74 }
75
76 String::String(const char* nullTerminatedString)
77 {
78     if (nullTerminatedString)
79         m_impl = StringImpl::create(reinterpret_cast<const LChar*>(nullTerminatedString));
80 }
81
82 String::String(ASCIILiteral characters)
83     : m_impl(StringImpl::createFromLiteral(characters))
84 {
85 }
86
87 void String::append(const String& otherString)
88 {
89     // FIXME: This is extremely inefficient. So much so that we might want to take this out of String's API.
90
91     if (!m_impl) {
92         m_impl = otherString.m_impl;
93         return;
94     }
95
96     if (otherString.isEmpty())
97         return;
98
99     auto length = m_impl->length();
100     auto otherLength = otherString.m_impl->length();
101     if (otherLength > std::numeric_limits<unsigned>::max() - length)
102         CRASH();
103
104     if (m_impl->is8Bit() && otherString.m_impl->is8Bit()) {
105         LChar* data;
106         auto newImpl = StringImpl::createUninitialized(length + otherLength, data);
107         StringImpl::copyCharacters(data, m_impl->characters8(), length);
108         StringImpl::copyCharacters(data + length, otherString.m_impl->characters8(), otherLength);
109         m_impl = WTFMove(newImpl);
110         return;
111     }
112     UChar* data;
113     auto newImpl = StringImpl::createUninitialized(length + otherLength, data);
114     StringView(*m_impl).getCharactersWithUpconvert(data);
115     StringView(*otherString.m_impl).getCharactersWithUpconvert(data + length);
116     m_impl = WTFMove(newImpl);
117 }
118
119 void String::append(LChar character)
120 {
121     // FIXME: This is extremely inefficient. So much so that we might want to take this out of String's API.
122
123     if (!m_impl) {
124         m_impl = StringImpl::create(&character, 1);
125         return;
126     }
127     if (!is8Bit()) {
128         append(static_cast<UChar>(character));
129         return;
130     }
131     if (m_impl->length() >= std::numeric_limits<unsigned>::max())
132         CRASH();
133     LChar* data;
134     auto newImpl = StringImpl::createUninitialized(m_impl->length() + 1, data);
135     StringImpl::copyCharacters(data, m_impl->characters8(), m_impl->length());
136     data[m_impl->length()] = character;
137     m_impl = WTFMove(newImpl);
138 }
139
140 void String::append(UChar character)
141 {
142     // FIXME: This is extremely inefficient. So much so that we might want to take this out of String's API.
143
144     if (!m_impl) {
145         m_impl = StringImpl::create(&character, 1);
146         return;
147     }
148     if (character <= 0xFF && is8Bit()) {
149         append(static_cast<LChar>(character));
150         return;
151     }
152     if (m_impl->length() >= std::numeric_limits<unsigned>::max())
153         CRASH();
154     UChar* data;
155     auto newImpl = StringImpl::createUninitialized(m_impl->length() + 1, data);
156     StringView(*m_impl).getCharactersWithUpconvert(data);
157     data[m_impl->length()] = character;
158     m_impl = WTFMove(newImpl);
159 }
160
161 int codePointCompare(const String& a, const String& b)
162 {
163     return codePointCompare(a.impl(), b.impl());
164 }
165
166 void String::insert(const String& string, unsigned position)
167 {
168     // FIXME: This is extremely inefficient. So much so that we might want to take this out of String's API.
169
170     unsigned lengthToInsert = string.length();
171
172     if (!lengthToInsert) {
173         if (string.isNull())
174             return;
175         if (isNull())
176             m_impl = string.impl();
177         return;
178     }
179
180     if (position >= length()) {
181         append(string);
182         return;
183     }
184
185     if (lengthToInsert > std::numeric_limits<unsigned>::max() - length())
186         CRASH();
187
188     if (is8Bit() && string.is8Bit()) {
189         LChar* data;
190         auto newString = StringImpl::createUninitialized(length() + lengthToInsert, data);
191         StringView(*m_impl).substring(0, position).getCharactersWithUpconvert(data);
192         StringView(string).getCharactersWithUpconvert(data + position);
193         StringView(*m_impl).substring(position).getCharactersWithUpconvert(data + position + lengthToInsert);
194         m_impl = WTFMove(newString);
195     } else {
196         UChar* data;
197         auto newString = StringImpl::createUninitialized(length() + lengthToInsert, data);
198         StringView(*m_impl).substring(0, position).getCharactersWithUpconvert(data);
199         StringView(string).getCharactersWithUpconvert(data + position);
200         StringView(*m_impl).substring(position).getCharactersWithUpconvert(data + position + lengthToInsert);
201         m_impl = WTFMove(newString);
202     }
203 }
204
205 void String::append(const LChar* charactersToAppend, unsigned lengthToAppend)
206 {
207     // FIXME: This is extremely inefficient. So much so that we might want to take this out of String's API.
208
209     if (!m_impl) {
210         if (!charactersToAppend)
211             return;
212         m_impl = StringImpl::create(charactersToAppend, lengthToAppend);
213         return;
214     }
215
216     if (!lengthToAppend)
217         return;
218
219     ASSERT(charactersToAppend);
220
221     unsigned strLength = m_impl->length();
222
223     if (m_impl->is8Bit()) {
224         if (lengthToAppend > std::numeric_limits<unsigned>::max() - strLength)
225             CRASH();
226         LChar* data;
227         auto newImpl = StringImpl::createUninitialized(strLength + lengthToAppend, data);
228         StringImpl::copyCharacters(data, m_impl->characters8(), strLength);
229         StringImpl::copyCharacters(data + strLength, charactersToAppend, lengthToAppend);
230         m_impl = WTFMove(newImpl);
231         return;
232     }
233
234     if (lengthToAppend > std::numeric_limits<unsigned>::max() - strLength)
235         CRASH();
236     UChar* data;
237     auto newImpl = StringImpl::createUninitialized(length() + lengthToAppend, data);
238     StringImpl::copyCharacters(data, m_impl->characters16(), strLength);
239     StringImpl::copyCharacters(data + strLength, charactersToAppend, lengthToAppend);
240     m_impl = WTFMove(newImpl);
241 }
242
243 void String::append(const UChar* charactersToAppend, unsigned lengthToAppend)
244 {
245     // FIXME: This is extremely inefficient. So much so that we might want to take this out of String's API.
246
247     if (!m_impl) {
248         if (!charactersToAppend)
249             return;
250         m_impl = StringImpl::create(charactersToAppend, lengthToAppend);
251         return;
252     }
253
254     if (!lengthToAppend)
255         return;
256
257     unsigned strLength = m_impl->length();
258     
259     ASSERT(charactersToAppend);
260     if (lengthToAppend > std::numeric_limits<unsigned>::max() - strLength)
261         CRASH();
262     UChar* data;
263     auto newImpl = StringImpl::createUninitialized(strLength + lengthToAppend, data);
264     if (m_impl->is8Bit())
265         StringImpl::copyCharacters(data, characters8(), strLength);
266     else
267         StringImpl::copyCharacters(data, characters16(), strLength);
268     StringImpl::copyCharacters(data + strLength, charactersToAppend, lengthToAppend);
269     m_impl = WTFMove(newImpl);
270 }
271
272
273 UChar32 String::characterStartingAt(unsigned i) const
274 {
275     if (!m_impl || i >= m_impl->length())
276         return 0;
277     return m_impl->characterStartingAt(i);
278 }
279
280 void String::truncate(unsigned position)
281 {
282     if (m_impl)
283         m_impl = m_impl->substring(0, position);
284 }
285
286 template<typename CharacterType> inline void String::removeInternal(const CharacterType* characters, unsigned position, unsigned lengthToRemove)
287 {
288     CharacterType* data;
289     auto newImpl = StringImpl::createUninitialized(length() - lengthToRemove, data);
290     StringImpl::copyCharacters(data, characters, position);
291     StringImpl::copyCharacters(data + position, characters + position + lengthToRemove, length() - lengthToRemove - position);
292     m_impl = WTFMove(newImpl);
293 }
294
295 void String::remove(unsigned position, unsigned lengthToRemove)
296 {
297     if (!lengthToRemove)
298         return;
299     auto length = this->length();
300     if (position >= length)
301         return;
302     lengthToRemove = std::min(lengthToRemove, length - position);
303     if (is8Bit())
304         removeInternal(characters8(), position, lengthToRemove);
305     else
306         removeInternal(characters16(), position, lengthToRemove);
307 }
308
309 String String::substring(unsigned position, unsigned length) const
310 {
311     // FIXME: Should this function, and the many others like it, be inlined?
312     return m_impl ? m_impl->substring(position, length) : String { };
313 }
314
315 String String::substringSharingImpl(unsigned offset, unsigned length) const
316 {
317     // FIXME: We used to check against a limit of Heap::minExtraCost / sizeof(UChar).
318
319     unsigned stringLength = this->length();
320     offset = std::min(offset, stringLength);
321     length = std::min(length, stringLength - offset);
322
323     if (!offset && length == stringLength)
324         return *this;
325     return StringImpl::createSubstringSharingImpl(*m_impl, offset, length);
326 }
327
328 String String::convertToASCIILowercase() const
329 {
330     // FIXME: Should this function, and the many others like it, be inlined?
331     return m_impl ? m_impl->convertToASCIILowercase() : String { };
332 }
333
334 String String::convertToASCIIUppercase() const
335 {
336     // FIXME: Should this function, and the many others like it, be inlined?
337     return m_impl ? m_impl->convertToASCIIUppercase() : String { };
338 }
339
340 String String::convertToLowercaseWithoutLocale() const
341 {
342     // FIXME: Should this function, and the many others like it, be inlined?
343     return m_impl ? m_impl->convertToLowercaseWithoutLocale() : String { };
344 }
345
346 String String::convertToLowercaseWithoutLocaleStartingAtFailingIndex8Bit(unsigned failingIndex) const
347 {
348     // FIXME: Should this function, and the many others like it, be inlined?
349     return m_impl ? m_impl->convertToLowercaseWithoutLocaleStartingAtFailingIndex8Bit(failingIndex) : String { };
350 }
351
352 String String::convertToUppercaseWithoutLocale() const
353 {
354     // FIXME: Should this function, and the many others like it, be inlined?
355     return m_impl ? m_impl->convertToUppercaseWithoutLocale() : String { };
356 }
357
358 String String::convertToLowercaseWithLocale(const AtomicString& localeIdentifier) const
359 {
360     // FIXME: Should this function, and the many others like it, be inlined?
361     return m_impl ? m_impl->convertToLowercaseWithLocale(localeIdentifier) : String { };
362 }
363
364 String String::convertToUppercaseWithLocale(const AtomicString& localeIdentifier) const
365 {
366     // FIXME: Should this function, and the many others like it, be inlined?
367     return m_impl ? m_impl->convertToUppercaseWithLocale(localeIdentifier) : String { };
368 }
369
370 String String::stripWhiteSpace() const
371 {
372     // FIXME: Should this function, and the many others like it, be inlined?
373     // FIXME: This function needs a new name. For one thing, "whitespace" is a single
374     // word so the "s" should be lowercase. For another, it's not clear from this name
375     // that the function uses the Unicode definition of whitespace. Most WebKit callers
376     // don't want that and eventually we should consider deleting this.
377     return m_impl ? m_impl->stripWhiteSpace() : String { };
378 }
379
380 String String::stripLeadingAndTrailingCharacters(CodeUnitMatchFunction predicate) const
381 {
382     // FIXME: Should this function, and the many others like it, be inlined?
383     return m_impl ? m_impl->stripLeadingAndTrailingCharacters(predicate) : String { };
384 }
385
386 String String::simplifyWhiteSpace() const
387 {
388     // FIXME: Should this function, and the many others like it, be inlined?
389     // FIXME: This function needs a new name. For one thing, "whitespace" is a single
390     // word so the "s" should be lowercase. For another, it's not clear from this name
391     // that the function uses the Unicode definition of whitespace. Most WebKit callers
392     // don't want that and eventually we should consider deleting this.
393     return m_impl ? m_impl->simplifyWhiteSpace() : String { };
394 }
395
396 String String::simplifyWhiteSpace(CodeUnitMatchFunction isWhiteSpace) const
397 {
398     // FIXME: Should this function, and the many others like it, be inlined?
399     return m_impl ? m_impl->simplifyWhiteSpace(isWhiteSpace) : String { };
400 }
401
402 String String::removeCharacters(CodeUnitMatchFunction findMatch) const
403 {
404     // FIXME: Should this function, and the many others like it, be inlined?
405     return m_impl ? m_impl->removeCharacters(findMatch) : String { };
406 }
407
408 String String::foldCase() const
409 {
410     // FIXME: Should this function, and the many others like it, be inlined?
411     return m_impl ? m_impl->foldCase() : String { };
412 }
413
414 bool String::percentage(int& result) const
415 {
416     if (!m_impl || !m_impl->length())
417         return false;
418
419     if ((*m_impl)[m_impl->length() - 1] != '%')
420        return false;
421
422     if (m_impl->is8Bit())
423         result = charactersToIntStrict(m_impl->characters8(), m_impl->length() - 1);
424     else
425         result = charactersToIntStrict(m_impl->characters16(), m_impl->length() - 1);
426     return true;
427 }
428
429 Vector<UChar> String::charactersWithNullTermination() const
430 {
431     Vector<UChar> result;
432
433     if (m_impl) {
434         result.reserveInitialCapacity(length() + 1);
435
436         if (is8Bit()) {
437             const LChar* characters8 = m_impl->characters8();
438             for (size_t i = 0; i < length(); ++i)
439                 result.uncheckedAppend(characters8[i]);
440         } else {
441             const UChar* characters16 = m_impl->characters16();
442             result.append(characters16, m_impl->length());
443         }
444
445         result.append(0);
446     }
447
448     return result;
449 }
450
451 WTF_ATTRIBUTE_PRINTF(1, 0) static String createWithFormatAndArguments(const char *format, va_list args)
452 {
453     va_list argsCopy;
454     va_copy(argsCopy, args);
455
456     ALLOW_NONLITERAL_FORMAT_BEGIN
457
458 #if USE(CF) && !OS(WINDOWS)
459     if (strstr(format, "%@")) {
460         auto cfFormat = adoptCF(CFStringCreateWithCString(kCFAllocatorDefault, format, kCFStringEncodingUTF8));
461         auto result = adoptCF(CFStringCreateWithFormatAndArguments(kCFAllocatorDefault, nullptr, cfFormat.get(), args));
462         va_end(argsCopy);
463         return result.get();
464     }
465 #endif
466
467     // Do the format once to get the length.
468 #if COMPILER(MSVC)
469     int result = _vscprintf(format, args);
470 #else
471     char ch;
472     int result = vsnprintf(&ch, 1, format, args);
473 #endif
474
475     if (!result) {
476         va_end(argsCopy);
477         return emptyString();
478     }
479     if (result < 0) {
480         va_end(argsCopy);
481         return String();
482     }
483
484     Vector<char, 256> buffer;
485     unsigned len = result;
486     buffer.grow(len + 1);
487
488     // Now do the formatting again, guaranteed to fit.
489     vsnprintf(buffer.data(), buffer.size(), format, argsCopy);
490     va_end(argsCopy);
491
492     ALLOW_NONLITERAL_FORMAT_END
493
494     return StringImpl::create(reinterpret_cast<const LChar*>(buffer.data()), len);
495 }
496
497 String String::format(const char *format, ...)
498 {
499     va_list args;
500     va_start(args, format);
501     String result = createWithFormatAndArguments(format, args);
502     va_end(args);
503     return result;
504 }
505
506 String String::number(int number)
507 {
508     return numberToStringSigned<String>(number);
509 }
510
511 String String::number(unsigned int number)
512 {
513     return numberToStringUnsigned<String>(number);
514 }
515
516 String String::number(long number)
517 {
518     return numberToStringSigned<String>(number);
519 }
520
521 String String::number(unsigned long number)
522 {
523     return numberToStringUnsigned<String>(number);
524 }
525
526 String String::number(long long number)
527 {
528     return numberToStringSigned<String>(number);
529 }
530
531 String String::number(unsigned long long number)
532 {
533     return numberToStringUnsigned<String>(number);
534 }
535
536 String String::number(double number, unsigned precision, TrailingZerosTruncatingPolicy trailingZerosTruncatingPolicy)
537 {
538     NumberToStringBuffer buffer;
539     return String(numberToFixedPrecisionString(number, precision, buffer, trailingZerosTruncatingPolicy == TruncateTrailingZeros));
540 }
541
542 String String::numberToStringECMAScript(double number)
543 {
544     NumberToStringBuffer buffer;
545     return String(numberToString(number, buffer));
546 }
547
548 String String::numberToStringFixedWidth(double number, unsigned decimalPlaces)
549 {
550     NumberToStringBuffer buffer;
551     return String(numberToFixedWidthString(number, decimalPlaces, buffer));
552 }
553
554 int String::toIntStrict(bool* ok, int base) const
555 {
556     if (!m_impl) {
557         if (ok)
558             *ok = false;
559         return 0;
560     }
561     return m_impl->toIntStrict(ok, base);
562 }
563
564 unsigned String::toUIntStrict(bool* ok, int base) const
565 {
566     if (!m_impl) {
567         if (ok)
568             *ok = false;
569         return 0;
570     }
571     return m_impl->toUIntStrict(ok, base);
572 }
573
574 int64_t String::toInt64Strict(bool* ok, int base) const
575 {
576     if (!m_impl) {
577         if (ok)
578             *ok = false;
579         return 0;
580     }
581     return m_impl->toInt64Strict(ok, base);
582 }
583
584 uint64_t String::toUInt64Strict(bool* ok, int base) const
585 {
586     if (!m_impl) {
587         if (ok)
588             *ok = false;
589         return 0;
590     }
591     return m_impl->toUInt64Strict(ok, base);
592 }
593
594 intptr_t String::toIntPtrStrict(bool* ok, int base) const
595 {
596     if (!m_impl) {
597         if (ok)
598             *ok = false;
599         return 0;
600     }
601     return m_impl->toIntPtrStrict(ok, base);
602 }
603
604 int String::toInt(bool* ok) const
605 {
606     if (!m_impl) {
607         if (ok)
608             *ok = false;
609         return 0;
610     }
611     return m_impl->toInt(ok);
612 }
613
614 unsigned String::toUInt(bool* ok) const
615 {
616     if (!m_impl) {
617         if (ok)
618             *ok = false;
619         return 0;
620     }
621     return m_impl->toUInt(ok);
622 }
623
624 int64_t String::toInt64(bool* ok) const
625 {
626     if (!m_impl) {
627         if (ok)
628             *ok = false;
629         return 0;
630     }
631     return m_impl->toInt64(ok);
632 }
633
634 uint64_t String::toUInt64(bool* ok) const
635 {
636     if (!m_impl) {
637         if (ok)
638             *ok = false;
639         return 0;
640     }
641     return m_impl->toUInt64(ok);
642 }
643
644 intptr_t String::toIntPtr(bool* ok) const
645 {
646     if (!m_impl) {
647         if (ok)
648             *ok = false;
649         return 0;
650     }
651     return m_impl->toIntPtr(ok);
652 }
653
654 double String::toDouble(bool* ok) const
655 {
656     if (!m_impl) {
657         if (ok)
658             *ok = false;
659         return 0.0;
660     }
661     return m_impl->toDouble(ok);
662 }
663
664 float String::toFloat(bool* ok) const
665 {
666     if (!m_impl) {
667         if (ok)
668             *ok = false;
669         return 0.0f;
670     }
671     return m_impl->toFloat(ok);
672 }
673
674 String String::isolatedCopy() const &
675 {
676     // FIXME: Should this function, and the many others like it, be inlined?
677     return m_impl ? m_impl->isolatedCopy() : String { };
678 }
679
680 String String::isolatedCopy() &&
681 {
682     if (isSafeToSendToAnotherThread()) {
683         // Since we know that our string is a temporary that will be destroyed
684         // we can just steal the m_impl from it, thus avoiding a copy.
685         return { WTFMove(*this) };
686     }
687
688     return m_impl ? m_impl->isolatedCopy() : String { };
689 }
690
691 bool String::isSafeToSendToAnotherThread() const
692 {
693     // AtomicStrings are not safe to send between threads as ~StringImpl()
694     // will try to remove them from the wrong AtomicStringTable.
695     return isEmpty() || (m_impl->hasOneRef() && !m_impl->isAtomic());
696 }
697
698 template<bool allowEmptyEntries>
699 inline Vector<String> String::splitInternal(const String& separator) const
700 {
701     Vector<String> result;
702
703     unsigned startPos = 0;
704     size_t endPos;
705     while ((endPos = find(separator, startPos)) != notFound) {
706         if (allowEmptyEntries || startPos != endPos)
707             result.append(substring(startPos, endPos - startPos));
708         startPos = endPos + separator.length();
709     }
710     if (allowEmptyEntries || startPos != length())
711         result.append(substring(startPos));
712
713     return result;
714 }
715
716 template<bool allowEmptyEntries>
717 inline void String::splitInternal(UChar separator, const SplitFunctor& functor) const
718 {
719     StringView view(*this);
720
721     unsigned startPos = 0;
722     size_t endPos;
723     while ((endPos = find(separator, startPos)) != notFound) {
724         if (allowEmptyEntries || startPos != endPos)
725             functor(view.substring(startPos, endPos - startPos));
726         startPos = endPos + 1;
727     }
728     if (allowEmptyEntries || startPos != length())
729         functor(view.substring(startPos));
730 }
731
732 template<bool allowEmptyEntries>
733 inline Vector<String> String::splitInternal(UChar separator) const
734 {
735     Vector<String> result;
736     splitInternal<allowEmptyEntries>(separator, [&result](StringView item) {
737         result.append(item.toString());
738     });
739
740     return result;
741 }
742
743 void String::split(UChar separator, const SplitFunctor& functor) const
744 {
745     splitInternal<false>(separator, functor);
746 }
747
748 Vector<String> String::split(UChar separator) const
749 {
750     return splitInternal<false>(separator);
751 }
752
753 Vector<String> String::split(const String& separator) const
754 {
755     return splitInternal<false>(separator);
756 }
757
758 void String::splitAllowingEmptyEntries(UChar separator, const SplitFunctor& functor) const
759 {
760     splitInternal<true>(separator, functor);
761 }
762
763 Vector<String> String::splitAllowingEmptyEntries(UChar separator) const
764 {
765     return splitInternal<true>(separator);
766 }
767
768 Vector<String> String::splitAllowingEmptyEntries(const String& separator) const
769 {
770     return splitInternal<true>(separator);
771 }
772
773 CString String::ascii() const
774 {
775     // Printable ASCII characters 32..127 and the null character are
776     // preserved, characters outside of this range are converted to '?'.
777
778     unsigned length = this->length();
779     if (!length) { 
780         char* characterBuffer;
781         return CString::newUninitialized(length, characterBuffer);
782     }
783
784     if (this->is8Bit()) {
785         const LChar* characters = this->characters8();
786
787         char* characterBuffer;
788         CString result = CString::newUninitialized(length, characterBuffer);
789
790         for (unsigned i = 0; i < length; ++i) {
791             LChar ch = characters[i];
792             characterBuffer[i] = ch && (ch < 0x20 || ch > 0x7f) ? '?' : ch;
793         }
794
795         return result;        
796     }
797
798     const UChar* characters = this->characters16();
799
800     char* characterBuffer;
801     CString result = CString::newUninitialized(length, characterBuffer);
802
803     for (unsigned i = 0; i < length; ++i) {
804         UChar ch = characters[i];
805         characterBuffer[i] = ch && (ch < 0x20 || ch > 0x7f) ? '?' : ch;
806     }
807
808     return result;
809 }
810
811 CString String::latin1() const
812 {
813     // Basic Latin1 (ISO) encoding - Unicode characters 0..255 are
814     // preserved, characters outside of this range are converted to '?'.
815
816     unsigned length = this->length();
817
818     if (!length)
819         return CString("", 0);
820
821     if (is8Bit())
822         return CString(reinterpret_cast<const char*>(this->characters8()), length);
823
824     const UChar* characters = this->characters16();
825
826     char* characterBuffer;
827     CString result = CString::newUninitialized(length, characterBuffer);
828
829     for (unsigned i = 0; i < length; ++i) {
830         UChar ch = characters[i];
831         characterBuffer[i] = ch > 0xff ? '?' : ch;
832     }
833
834     return result;
835 }
836
837 Expected<CString, UTF8ConversionError> String::tryGetUtf8(ConversionMode mode) const
838 {
839     return m_impl ? m_impl->tryGetUtf8(mode) : CString { "", 0 };
840 }
841
842 Expected<CString, UTF8ConversionError> String::tryGetUtf8() const
843 {
844     return tryGetUtf8(LenientConversion);
845 }
846
847 CString String::utf8(ConversionMode mode) const
848 {
849     Expected<CString, UTF8ConversionError> expectedString = tryGetUtf8(mode);
850     RELEASE_ASSERT(expectedString);
851     return expectedString.value();
852 }
853
854 CString String::utf8() const
855 {
856     return utf8(LenientConversion);
857 }
858
859 String String::make8BitFrom16BitSource(const UChar* source, size_t length)
860 {
861     if (!length)
862         return String();
863
864     LChar* destination;
865     String result = String::createUninitialized(length, destination);
866
867     copyLCharsFromUCharSource(destination, source, length);
868
869     return result;
870 }
871
872 String String::make16BitFrom8BitSource(const LChar* source, size_t length)
873 {
874     if (!length)
875         return String();
876     
877     UChar* destination;
878     String result = String::createUninitialized(length, destination);
879     
880     StringImpl::copyCharacters(destination, source, length);
881     
882     return result;
883 }
884
885 String String::fromUTF8(const LChar* stringStart, size_t length)
886 {
887     if (length > std::numeric_limits<unsigned>::max())
888         CRASH();
889
890     if (!stringStart)
891         return String();
892
893     if (!length)
894         return emptyString();
895
896     if (charactersAreAllASCII(stringStart, length))
897         return StringImpl::create(stringStart, length);
898
899     Vector<UChar, 1024> buffer(length);
900     UChar* bufferStart = buffer.data();
901  
902     UChar* bufferCurrent = bufferStart;
903     const char* stringCurrent = reinterpret_cast<const char*>(stringStart);
904     if (convertUTF8ToUTF16(&stringCurrent, reinterpret_cast<const char *>(stringStart + length), &bufferCurrent, bufferCurrent + buffer.size()) != conversionOK)
905         return String();
906
907     unsigned utf16Length = bufferCurrent - bufferStart;
908     ASSERT_WITH_SECURITY_IMPLICATION(utf16Length < length);
909     return StringImpl::create(bufferStart, utf16Length);
910 }
911
912 String String::fromUTF8(const LChar* string)
913 {
914     if (!string)
915         return String();
916     return fromUTF8(string, strlen(reinterpret_cast<const char*>(string)));
917 }
918
919 String String::fromUTF8(const CString& s)
920 {
921     return fromUTF8(s.data());
922 }
923
924 String String::fromUTF8WithLatin1Fallback(const LChar* string, size_t size)
925 {
926     String utf8 = fromUTF8(string, size);
927     if (!utf8)
928         return String(string, size);
929     return utf8;
930 }
931
932 // String Operations
933
934 static bool isCharacterAllowedInBase(UChar c, int base)
935 {
936     if (c > 0x7F)
937         return false;
938     if (isASCIIDigit(c))
939         return c - '0' < base;
940     if (isASCIIAlpha(c)) {
941         if (base > 36)
942             base = 36;
943         return (c >= 'a' && c < 'a' + base - 10)
944             || (c >= 'A' && c < 'A' + base - 10);
945     }
946     return false;
947 }
948
949 template<typename IntegralType, typename CharacterType>
950 static inline IntegralType toIntegralType(const CharacterType* data, size_t length, bool* ok, int base)
951 {
952     static const IntegralType integralMax = std::numeric_limits<IntegralType>::max();
953     static const bool isSigned = std::numeric_limits<IntegralType>::is_signed;
954     const IntegralType maxMultiplier = integralMax / base;
955
956     IntegralType value = 0;
957     bool isOk = false;
958     bool isNegative = false;
959
960     if (!data)
961         goto bye;
962
963     // skip leading whitespace
964     while (length && isSpaceOrNewline(*data)) {
965         --length;
966         ++data;
967     }
968
969     if (isSigned && length && *data == '-') {
970         --length;
971         ++data;
972         isNegative = true;
973     } else if (length && *data == '+') {
974         --length;
975         ++data;
976     }
977
978     if (!length || !isCharacterAllowedInBase(*data, base))
979         goto bye;
980
981     while (length && isCharacterAllowedInBase(*data, base)) {
982         --length;
983         IntegralType digitValue;
984         auto c = *data;
985         if (isASCIIDigit(c))
986             digitValue = c - '0';
987         else if (c >= 'a')
988             digitValue = c - 'a' + 10;
989         else
990             digitValue = c - 'A' + 10;
991
992         if (value > maxMultiplier || (value == maxMultiplier && digitValue > (integralMax % base) + isNegative))
993             goto bye;
994
995         value = base * value + digitValue;
996         ++data;
997     }
998
999 #if COMPILER(MSVC)
1000 #pragma warning(push, 0)
1001 #pragma warning(disable:4146)
1002 #endif
1003
1004     if (isNegative)
1005         value = -value;
1006
1007 #if COMPILER(MSVC)
1008 #pragma warning(pop)
1009 #endif
1010
1011     // skip trailing space
1012     while (length && isSpaceOrNewline(*data)) {
1013         --length;
1014         ++data;
1015     }
1016
1017     if (!length)
1018         isOk = true;
1019 bye:
1020     if (ok)
1021         *ok = isOk;
1022     return isOk ? value : 0;
1023 }
1024
1025 template<typename CharacterType>
1026 static unsigned lengthOfCharactersAsInteger(const CharacterType* data, size_t length)
1027 {
1028     size_t i = 0;
1029
1030     // Allow leading spaces.
1031     for (; i != length; ++i) {
1032         if (!isSpaceOrNewline(data[i]))
1033             break;
1034     }
1035     
1036     // Allow sign.
1037     if (i != length && (data[i] == '+' || data[i] == '-'))
1038         ++i;
1039     
1040     // Allow digits.
1041     for (; i != length; ++i) {
1042         if (!isASCIIDigit(data[i]))
1043             break;
1044     }
1045
1046     return i;
1047 }
1048
1049 int charactersToIntStrict(const LChar* data, size_t length, bool* ok, int base)
1050 {
1051     return toIntegralType<int, LChar>(data, length, ok, base);
1052 }
1053
1054 int charactersToIntStrict(const UChar* data, size_t length, bool* ok, int base)
1055 {
1056     return toIntegralType<int, UChar>(data, length, ok, base);
1057 }
1058
1059 unsigned charactersToUIntStrict(const LChar* data, size_t length, bool* ok, int base)
1060 {
1061     return toIntegralType<unsigned, LChar>(data, length, ok, base);
1062 }
1063
1064 unsigned charactersToUIntStrict(const UChar* data, size_t length, bool* ok, int base)
1065 {
1066     return toIntegralType<unsigned, UChar>(data, length, ok, base);
1067 }
1068
1069 int64_t charactersToInt64Strict(const LChar* data, size_t length, bool* ok, int base)
1070 {
1071     return toIntegralType<int64_t, LChar>(data, length, ok, base);
1072 }
1073
1074 int64_t charactersToInt64Strict(const UChar* data, size_t length, bool* ok, int base)
1075 {
1076     return toIntegralType<int64_t, UChar>(data, length, ok, base);
1077 }
1078
1079 uint64_t charactersToUInt64Strict(const LChar* data, size_t length, bool* ok, int base)
1080 {
1081     return toIntegralType<uint64_t, LChar>(data, length, ok, base);
1082 }
1083
1084 uint64_t charactersToUInt64Strict(const UChar* data, size_t length, bool* ok, int base)
1085 {
1086     return toIntegralType<uint64_t, UChar>(data, length, ok, base);
1087 }
1088
1089 intptr_t charactersToIntPtrStrict(const LChar* data, size_t length, bool* ok, int base)
1090 {
1091     return toIntegralType<intptr_t, LChar>(data, length, ok, base);
1092 }
1093
1094 intptr_t charactersToIntPtrStrict(const UChar* data, size_t length, bool* ok, int base)
1095 {
1096     return toIntegralType<intptr_t, UChar>(data, length, ok, base);
1097 }
1098
1099 int charactersToInt(const LChar* data, size_t length, bool* ok)
1100 {
1101     return toIntegralType<int, LChar>(data, lengthOfCharactersAsInteger<LChar>(data, length), ok, 10);
1102 }
1103
1104 int charactersToInt(const UChar* data, size_t length, bool* ok)
1105 {
1106     return toIntegralType<int, UChar>(data, lengthOfCharactersAsInteger(data, length), ok, 10);
1107 }
1108
1109 unsigned charactersToUInt(const LChar* data, size_t length, bool* ok)
1110 {
1111     return toIntegralType<unsigned, LChar>(data, lengthOfCharactersAsInteger<LChar>(data, length), ok, 10);
1112 }
1113
1114 unsigned charactersToUInt(const UChar* data, size_t length, bool* ok)
1115 {
1116     return toIntegralType<unsigned, UChar>(data, lengthOfCharactersAsInteger<UChar>(data, length), ok, 10);
1117 }
1118
1119 int64_t charactersToInt64(const LChar* data, size_t length, bool* ok)
1120 {
1121     return toIntegralType<int64_t, LChar>(data, lengthOfCharactersAsInteger<LChar>(data, length), ok, 10);
1122 }
1123
1124 int64_t charactersToInt64(const UChar* data, size_t length, bool* ok)
1125 {
1126     return toIntegralType<int64_t, UChar>(data, lengthOfCharactersAsInteger<UChar>(data, length), ok, 10);
1127 }
1128
1129 uint64_t charactersToUInt64(const LChar* data, size_t length, bool* ok)
1130 {
1131     return toIntegralType<uint64_t, LChar>(data, lengthOfCharactersAsInteger<LChar>(data, length), ok, 10);
1132 }
1133
1134 uint64_t charactersToUInt64(const UChar* data, size_t length, bool* ok)
1135 {
1136     return toIntegralType<uint64_t, UChar>(data, lengthOfCharactersAsInteger<UChar>(data, length), ok, 10);
1137 }
1138
1139 intptr_t charactersToIntPtr(const LChar* data, size_t length, bool* ok)
1140 {
1141     return toIntegralType<intptr_t, LChar>(data, lengthOfCharactersAsInteger<LChar>(data, length), ok, 10);
1142 }
1143
1144 intptr_t charactersToIntPtr(const UChar* data, size_t length, bool* ok)
1145 {
1146     return toIntegralType<intptr_t, UChar>(data, lengthOfCharactersAsInteger<UChar>(data, length), ok, 10);
1147 }
1148
1149 enum TrailingJunkPolicy { DisallowTrailingJunk, AllowTrailingJunk };
1150
1151 template<typename CharacterType, TrailingJunkPolicy policy>
1152 static inline double toDoubleType(const CharacterType* data, size_t length, bool* ok, size_t& parsedLength)
1153 {
1154     size_t leadingSpacesLength = 0;
1155     while (leadingSpacesLength < length && isASCIISpace(data[leadingSpacesLength]))
1156         ++leadingSpacesLength;
1157
1158     double number = parseDouble(data + leadingSpacesLength, length - leadingSpacesLength, parsedLength);
1159     if (!parsedLength) {
1160         if (ok)
1161             *ok = false;
1162         return 0.0;
1163     }
1164
1165     parsedLength += leadingSpacesLength;
1166     if (ok)
1167         *ok = policy == AllowTrailingJunk || parsedLength == length;
1168     return number;
1169 }
1170
1171 double charactersToDouble(const LChar* data, size_t length, bool* ok)
1172 {
1173     size_t parsedLength;
1174     return toDoubleType<LChar, DisallowTrailingJunk>(data, length, ok, parsedLength);
1175 }
1176
1177 double charactersToDouble(const UChar* data, size_t length, bool* ok)
1178 {
1179     size_t parsedLength;
1180     return toDoubleType<UChar, DisallowTrailingJunk>(data, length, ok, parsedLength);
1181 }
1182
1183 float charactersToFloat(const LChar* data, size_t length, bool* ok)
1184 {
1185     // FIXME: This will return ok even when the string fits into a double but not a float.
1186     size_t parsedLength;
1187     return static_cast<float>(toDoubleType<LChar, DisallowTrailingJunk>(data, length, ok, parsedLength));
1188 }
1189
1190 float charactersToFloat(const UChar* data, size_t length, bool* ok)
1191 {
1192     // FIXME: This will return ok even when the string fits into a double but not a float.
1193     size_t parsedLength;
1194     return static_cast<float>(toDoubleType<UChar, DisallowTrailingJunk>(data, length, ok, parsedLength));
1195 }
1196
1197 float charactersToFloat(const LChar* data, size_t length, size_t& parsedLength)
1198 {
1199     // FIXME: This will return ok even when the string fits into a double but not a float.
1200     return static_cast<float>(toDoubleType<LChar, AllowTrailingJunk>(data, length, 0, parsedLength));
1201 }
1202
1203 float charactersToFloat(const UChar* data, size_t length, size_t& parsedLength)
1204 {
1205     // FIXME: This will return ok even when the string fits into a double but not a float.
1206     return static_cast<float>(toDoubleType<UChar, AllowTrailingJunk>(data, length, 0, parsedLength));
1207 }
1208
1209 const String& emptyString()
1210 {
1211     static NeverDestroyed<String> emptyString(StringImpl::empty());
1212     return emptyString;
1213 }
1214
1215 } // namespace WTF
1216
1217 #ifndef NDEBUG
1218
1219 // For use in the debugger.
1220 String* string(const char*);
1221 Vector<char> asciiDebug(StringImpl* impl);
1222 Vector<char> asciiDebug(String& string);
1223
1224 void String::show() const
1225 {
1226     dataLogF("%s\n", asciiDebug(impl()).data());
1227 }
1228
1229 String* string(const char* s)
1230 {
1231     // Intentionally leaks memory!
1232     return new String(s);
1233 }
1234
1235 Vector<char> asciiDebug(StringImpl* impl)
1236 {
1237     if (!impl)
1238         return asciiDebug(String("[null]"_s).impl());
1239
1240     Vector<char> buffer;
1241     for (unsigned i = 0; i < impl->length(); ++i) {
1242         UChar ch = (*impl)[i];
1243         if (isASCIIPrintable(ch)) {
1244             if (ch == '\\')
1245                 buffer.append(ch);
1246             buffer.append(ch);
1247         } else {
1248             buffer.append('\\');
1249             buffer.append('u');
1250             appendUnsignedAsHexFixedSize(ch, buffer, 4);
1251         }
1252     }
1253     buffer.append('\0');
1254     return buffer;
1255 }
1256
1257 Vector<char> asciiDebug(String& string)
1258 {
1259     return asciiDebug(string.impl());
1260 }
1261
1262 #endif