AK+Everywhere: Rename String to DeprecatedString

We have a new, improved string type coming up in AK (OOM aware, no null
state), and while it's going to use UTF-8, the name UTF8String is a
mouthful - so let's free up the String name by renaming the existing
class.
Making the old one have an annoying name will hopefully also help with
quick adoption :^)

1 files changed, 0 insertions, 452 deletions

diff --git a/AK/String.cpp b/AK/String.cpp
deleted file mode 100644
index 3c63b70b62..0000000000
--- a/AK/String.cpp
+++ /dev/null
@@ -1,452 +0,0 @@
-/*
- * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
- *
- * SPDX-License-Identifier: BSD-2-Clause
- */
-
-#include <AK/ByteBuffer.h>
-#include <AK/FlyString.h>
-#include <AK/Format.h>
-#include <AK/Function.h>
-#include <AK/Memory.h>
-#include <AK/StdLibExtras.h>
-#include <AK/String.h>
-#include <AK/StringView.h>
-#include <AK/Vector.h>
-
-namespace AK {
-
-bool String::operator==(FlyString const& fly_string) const
-{
-    return m_impl == fly_string.impl() || view() == fly_string.view();
-}
-
-bool String::operator==(String const& other) const
-{
-    return m_impl == other.impl() || view() == other.view();
-}
-
-bool String::operator==(StringView other) const
-{
-    return view() == other;
-}
-
-bool String::operator<(String const& other) const
-{
-    return view() < other.view();
-}
-
-bool String::operator>(String const& other) const
-{
-    return view() > other.view();
-}
-
-bool String::copy_characters_to_buffer(char* buffer, size_t buffer_size) const
-{
-    // We must fit at least the NUL-terminator.
-    VERIFY(buffer_size > 0);
-
-    size_t characters_to_copy = min(length(), buffer_size - 1);
-    __builtin_memcpy(buffer, characters(), characters_to_copy);
-    buffer[characters_to_copy] = 0;
-
-    return characters_to_copy == length();
-}
-
-String String::isolated_copy() const
-{
-    if (!m_impl)
-        return {};
-    if (!m_impl->length())
-        return empty();
-    char* buffer;
-    auto impl = StringImpl::create_uninitialized(length(), buffer);
-    memcpy(buffer, m_impl->characters(), m_impl->length());
-    return String(move(*impl));
-}
-
-String String::substring(size_t start, size_t length) const
-{
-    if (!length)
-        return String::empty();
-    VERIFY(m_impl);
-    VERIFY(!Checked<size_t>::addition_would_overflow(start, length));
-    VERIFY(start + length <= m_impl->length());
-    return { characters() + start, length };
-}
-
-String String::substring(size_t start) const
-{
-    VERIFY(m_impl);
-    VERIFY(start <= length());
-    return { characters() + start, length() - start };
-}
-
-StringView String::substring_view(size_t start, size_t length) const
-{
-    VERIFY(m_impl);
-    VERIFY(!Checked<size_t>::addition_would_overflow(start, length));
-    VERIFY(start + length <= m_impl->length());
-    return { characters() + start, length };
-}
-
-StringView String::substring_view(size_t start) const
-{
-    VERIFY(m_impl);
-    VERIFY(start <= length());
-    return { characters() + start, length() - start };
-}
-
-Vector<String> String::split(char separator, SplitBehavior split_behavior) const
-{
-    return split_limit(separator, 0, split_behavior);
-}
-
-Vector<String> String::split_limit(char separator, size_t limit, SplitBehavior split_behavior) const
-{
-    if (is_empty())
-        return {};
-
-    Vector<String> v;
-    size_t substart = 0;
-    bool keep_empty = has_flag(split_behavior, SplitBehavior::KeepEmpty);
-    bool keep_separator = has_flag(split_behavior, SplitBehavior::KeepTrailingSeparator);
-    for (size_t i = 0; i < length() && (v.size() + 1) != limit; ++i) {
-        char ch = characters()[i];
-        if (ch == separator) {
-            size_t sublen = i - substart;
-            if (sublen != 0 || keep_empty)
-                v.append(substring(substart, keep_separator ? sublen + 1 : sublen));
-            substart = i + 1;
-        }
-    }
-    size_t taillen = length() - substart;
-    if (taillen != 0 || keep_empty)
-        v.append(substring(substart, taillen));
-    return v;
-}
-
-Vector<StringView> String::split_view(Function<bool(char)> separator, SplitBehavior split_behavior) const
-{
-    if (is_empty())
-        return {};
-
-    Vector<StringView> v;
-    size_t substart = 0;
-    bool keep_empty = has_flag(split_behavior, SplitBehavior::KeepEmpty);
-    bool keep_separator = has_flag(split_behavior, SplitBehavior::KeepTrailingSeparator);
-    for (size_t i = 0; i < length(); ++i) {
-        char ch = characters()[i];
-        if (separator(ch)) {
-            size_t sublen = i - substart;
-            if (sublen != 0 || keep_empty)
-                v.append(substring_view(substart, keep_separator ? sublen + 1 : sublen));
-            substart = i + 1;
-        }
-    }
-    size_t taillen = length() - substart;
-    if (taillen != 0 || keep_empty)
-        v.append(substring_view(substart, taillen));
-    return v;
-}
-
-Vector<StringView> String::split_view(char const separator, SplitBehavior split_behavior) const
-{
-    return split_view([separator](char ch) { return ch == separator; }, split_behavior);
-}
-
-ByteBuffer String::to_byte_buffer() const
-{
-    if (!m_impl)
-        return {};
-    // FIXME: Handle OOM failure.
-    return ByteBuffer::copy(bytes()).release_value_but_fixme_should_propagate_errors();
-}
-
-template<typename T>
-Optional<T> String::to_int(TrimWhitespace trim_whitespace) const
-{
-    return StringUtils::convert_to_int<T>(view(), trim_whitespace);
-}
-
-template Optional<i8> String::to_int(TrimWhitespace) const;
-template Optional<i16> String::to_int(TrimWhitespace) const;
-template Optional<i32> String::to_int(TrimWhitespace) const;
-template Optional<i64> String::to_int(TrimWhitespace) const;
-
-template<typename T>
-Optional<T> String::to_uint(TrimWhitespace trim_whitespace) const
-{
-    return StringUtils::convert_to_uint<T>(view(), trim_whitespace);
-}
-
-template Optional<u8> String::to_uint(TrimWhitespace) const;
-template Optional<u16> String::to_uint(TrimWhitespace) const;
-template Optional<u32> String::to_uint(TrimWhitespace) const;
-template Optional<unsigned long> String::to_uint(TrimWhitespace) const;
-template Optional<unsigned long long> String::to_uint(TrimWhitespace) const;
-
-#ifndef KERNEL
-Optional<double> String::to_double(TrimWhitespace trim_whitespace) const
-{
-    return StringUtils::convert_to_floating_point<double>(*this, trim_whitespace);
-}
-
-Optional<float> String::to_float(TrimWhitespace trim_whitespace) const
-{
-    return StringUtils::convert_to_floating_point<float>(*this, trim_whitespace);
-}
-#endif
-
-bool String::starts_with(StringView str, CaseSensitivity case_sensitivity) const
-{
-    return StringUtils::starts_with(*this, str, case_sensitivity);
-}
-
-bool String::starts_with(char ch) const
-{
-    if (is_empty())
-        return false;
-    return characters()[0] == ch;
-}
-
-bool String::ends_with(StringView str, CaseSensitivity case_sensitivity) const
-{
-    return StringUtils::ends_with(*this, str, case_sensitivity);
-}
-
-bool String::ends_with(char ch) const
-{
-    if (is_empty())
-        return false;
-    return characters()[length() - 1] == ch;
-}
-
-String String::repeated(char ch, size_t count)
-{
-    if (!count)
-        return empty();
-    char* buffer;
-    auto impl = StringImpl::create_uninitialized(count, buffer);
-    memset(buffer, ch, count);
-    return *impl;
-}
-
-String String::repeated(StringView string, size_t count)
-{
-    if (!count || string.is_empty())
-        return empty();
-    char* buffer;
-    auto impl = StringImpl::create_uninitialized(count * string.length(), buffer);
-    for (size_t i = 0; i < count; i++)
-        __builtin_memcpy(buffer + i * string.length(), string.characters_without_null_termination(), string.length());
-    return *impl;
-}
-
-String String::bijective_base_from(size_t value, unsigned base, StringView map)
-{
-    if (map.is_null())
-        map = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"sv;
-
-    VERIFY(base >= 2 && base <= map.length());
-
-    // The '8 bits per byte' assumption may need to go?
-    Array<char, round_up_to_power_of_two(sizeof(size_t) * 8 + 1, 2)> buffer;
-    size_t i = 0;
-    do {
-        buffer[i++] = map[value % base];
-        value /= base;
-    } while (value > 0);
-
-    // NOTE: Weird as this may seem, the thing that comes after 'Z' is 'AA', which as a number would be '00'
-    //       to make this work, only the most significant digit has to be in a range of (1..25) as opposed to (0..25),
-    //       but only if it's not the only digit in the string.
-    if (i > 1)
-        --buffer[i - 1];
-
-    for (size_t j = 0; j < i / 2; ++j)
-        swap(buffer[j], buffer[i - j - 1]);
-
-    return String { ReadonlyBytes(buffer.data(), i) };
-}
-
-String String::roman_number_from(size_t value)
-{
-    if (value > 3999)
-        return String::number(value);
-
-    StringBuilder builder;
-
-    while (value > 0) {
-        if (value >= 1000) {
-            builder.append('M');
-            value -= 1000;
-        } else if (value >= 900) {
-            builder.append("CM"sv);
-            value -= 900;
-        } else if (value >= 500) {
-            builder.append('D');
-            value -= 500;
-        } else if (value >= 400) {
-            builder.append("CD"sv);
-            value -= 400;
-        } else if (value >= 100) {
-            builder.append('C');
-            value -= 100;
-        } else if (value >= 90) {
-            builder.append("XC"sv);
-            value -= 90;
-        } else if (value >= 50) {
-            builder.append('L');
-            value -= 50;
-        } else if (value >= 40) {
-            builder.append("XL"sv);
-            value -= 40;
-        } else if (value >= 10) {
-            builder.append('X');
-            value -= 10;
-        } else if (value == 9) {
-            builder.append("IX"sv);
-            value -= 9;
-        } else if (value >= 5 && value <= 8) {
-            builder.append('V');
-            value -= 5;
-        } else if (value == 4) {
-            builder.append("IV"sv);
-            value -= 4;
-        } else if (value <= 3) {
-            builder.append('I');
-            value -= 1;
-        }
-    }
-
-    return builder.to_string();
-}
-
-bool String::matches(StringView mask, Vector<MaskSpan>& mask_spans, CaseSensitivity case_sensitivity) const
-{
-    return StringUtils::matches(*this, mask, case_sensitivity, &mask_spans);
-}
-
-bool String::matches(StringView mask, CaseSensitivity case_sensitivity) const
-{
-    return StringUtils::matches(*this, mask, case_sensitivity);
-}
-
-bool String::contains(StringView needle, CaseSensitivity case_sensitivity) const
-{
-    return StringUtils::contains(*this, needle, case_sensitivity);
-}
-
-bool String::contains(char needle, CaseSensitivity case_sensitivity) const
-{
-    return StringUtils::contains(*this, StringView(&needle, 1), case_sensitivity);
-}
-
-bool String::equals_ignoring_case(StringView other) const
-{
-    return StringUtils::equals_ignoring_case(view(), other);
-}
-
-String String::reverse() const
-{
-    StringBuilder reversed_string(length());
-    for (size_t i = length(); i-- > 0;) {
-        reversed_string.append(characters()[i]);
-    }
-    return reversed_string.to_string();
-}
-
-String escape_html_entities(StringView html)
-{
-    StringBuilder builder;
-    for (size_t i = 0; i < html.length(); ++i) {
-        if (html[i] == '<')
-            builder.append("&lt;"sv);
-        else if (html[i] == '>')
-            builder.append("&gt;"sv);
-        else if (html[i] == '&')
-            builder.append("&amp;"sv);
-        else if (html[i] == '"')
-            builder.append("&quot;"sv);
-        else
-            builder.append(html[i]);
-    }
-    return builder.to_string();
-}
-
-String::String(FlyString const& string)
-    : m_impl(string.impl())
-{
-}
-
-String String::to_lowercase() const
-{
-    if (!m_impl)
-        return {};
-    return m_impl->to_lowercase();
-}
-
-String String::to_uppercase() const
-{
-    if (!m_impl)
-        return {};
-    return m_impl->to_uppercase();
-}
-
-String String::to_snakecase() const
-{
-    return StringUtils::to_snakecase(*this);
-}
-
-String String::to_titlecase() const
-{
-    return StringUtils::to_titlecase(*this);
-}
-
-String String::invert_case() const
-{
-    return StringUtils::invert_case(*this);
-}
-
-bool String::operator==(char const* cstring) const
-{
-    return view() == cstring;
-}
-
-InputStream& operator>>(InputStream& stream, String& string)
-{
-    StringBuilder builder;
-
-    for (;;) {
-        char next_char;
-        stream >> next_char;
-
-        if (stream.has_any_error()) {
-            stream.set_fatal_error();
-            string = nullptr;
-            return stream;
-        }
-
-        if (next_char) {
-            builder.append(next_char);
-        } else {
-            string = builder.to_string();
-            return stream;
-        }
-    }
-}
-
-String String::vformatted(StringView fmtstr, TypeErasedFormatParams& params)
-{
-    StringBuilder builder;
-    MUST(vformat(builder, fmtstr, params));
-    return builder.to_string();
-}
-
-Vector<size_t> String::find_all(StringView needle) const
-{
-    return StringUtils::find_all(*this, needle);
-}
-
-}