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