beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-24 16:40:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6
ladybird/AK/FlyString.h

98 lines
2.6 KiB
C
Raw Normal View History

AK: Add FlyString, a simple flyweight string class FlyString is a flyweight string class that wraps a RefPtr<StringImpl> known to be unique among the set of FlyStrings. The class is very unoptimized at the moment. When to use FlyString: - When you want O(1) string comparison - When you want to deduplicate a lot of identical strings When not to use FlyString: - For strings that don't need either of the above features - For strings that are likely to be unique
2020-03-22 09:12:55 +00:00
/*
* Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 08:24:48 +00:00
* SPDX-License-Identifier: BSD-2-Clause
AK: Add FlyString, a simple flyweight string class FlyString is a flyweight string class that wraps a RefPtr<StringImpl> known to be unique among the set of FlyStrings. The class is very unoptimized at the moment. When to use FlyString: - When you want O(1) string comparison - When you want to deduplicate a lot of identical strings When not to use FlyString: - For strings that don't need either of the above features - For strings that are likely to be unique
2020-03-22 09:12:55 +00:00
*/
#pragma once
#include <AK/String.h>
namespace AK {
class FlyString {
public:
AK: Simplify constructors and conversions from nullptr_t Problem: - Many constructors are defined as `{}` rather than using the ` = default` compiler-provided constructor. - Some types provide an implicit conversion operator from `nullptr_t` instead of requiring the caller to default construct. This violates the C++ Core Guidelines suggestion to declare single-argument constructors explicit (https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#c46-by-default-declare-single-argument-constructors-explicit). Solution: - Change default constructors to use the compiler-provided default constructor. - Remove implicit conversion operators from `nullptr_t` and change usage to enforce type consistency without conversion.
2021-01-10 23:29:28 +00:00
FlyString() = default;
AK: Some FlyString improvements We're now clever enough to notice when we're constructing a FlyString from a String that is actually already a FlyString. :^)
2020-05-05 08:08:14 +00:00
FlyString(const FlyString& other)
: m_impl(other.impl())
{
}
FlyString(FlyString&& other)
: m_impl(move(other.m_impl))
{
}
AK: Add FlyString, a simple flyweight string class FlyString is a flyweight string class that wraps a RefPtr<StringImpl> known to be unique among the set of FlyStrings. The class is very unoptimized at the moment. When to use FlyString: - When you want O(1) string comparison - When you want to deduplicate a lot of identical strings When not to use FlyString: - For strings that don't need either of the above features - For strings that are likely to be unique
2020-03-22 09:12:55 +00:00
FlyString(const String&);
FlyString(const StringView&);
FlyString(const char*);
AK: Some FlyString improvements We're now clever enough to notice when we're constructing a FlyString from a String that is actually already a FlyString. :^)
2020-05-05 08:08:14 +00:00
FlyString& operator=(const FlyString& other)
{
m_impl = other.m_impl;
return *this;
}
FlyString& operator=(FlyString&& other)
{
m_impl = move(other.m_impl);
return *this;
}
AK: Add FlyString::is_empty()
2020-04-16 18:22:54 +00:00
bool is_empty() const { return !m_impl || !m_impl->length(); }
AK: Add FlyString::is_null()
2020-03-24 13:03:42 +00:00
bool is_null() const { return !m_impl; }
AK: Add FlyString, a simple flyweight string class FlyString is a flyweight string class that wraps a RefPtr<StringImpl> known to be unique among the set of FlyStrings. The class is very unoptimized at the moment. When to use FlyString: - When you want O(1) string comparison - When you want to deduplicate a lot of identical strings When not to use FlyString: - For strings that don't need either of the above features - For strings that are likely to be unique
2020-03-22 09:12:55 +00:00
bool operator==(const FlyString& other) const { return m_impl == other.m_impl; }
bool operator!=(const FlyString& other) const { return m_impl != other.m_impl; }
AK: Add some string comparison operators Some of these are very inefficient. It's nice to have some optimization opportunities in the future though. :^)
2020-03-28 08:11:00 +00:00
bool operator==(const String&) const;
bool operator!=(const String& string) const { return !(*this == string); }
bool operator==(const StringView&) const;
bool operator!=(const StringView& string) const { return !(*this == string); }
bool operator==(const char*) const;
bool operator!=(const char* string) const { return !(*this == string); }
AK: Add FlyString, a simple flyweight string class FlyString is a flyweight string class that wraps a RefPtr<StringImpl> known to be unique among the set of FlyStrings. The class is very unoptimized at the moment. When to use FlyString: - When you want O(1) string comparison - When you want to deduplicate a lot of identical strings When not to use FlyString: - For strings that don't need either of the above features - For strings that are likely to be unique
2020-03-22 09:12:55 +00:00
const StringImpl* impl() const { return m_impl; }
const char* characters() const { return m_impl ? m_impl->characters() : nullptr; }
size_t length() const { return m_impl ? m_impl->length() : 0; }
AK: Add ALWAYS_INLINE, NEVER_INLINE and FLATTEN macros It's tedious to write (and look at) [[gnu::always_inline]] etc. :^)
2020-04-30 09:43:25 +00:00
ALWAYS_INLINE u32 hash() const { return m_impl ? m_impl->existing_hash() : 0; }
AK: Add FlyString::hash()
2020-04-10 14:26:59 +00:00
AK: Reduce header dependency graph of String.h String.h no longer pulls in StringView.h. We do this by moving a bunch of String functions out-of-line.
2020-03-23 12:45:10 +00:00
StringView view() const;
AK: Add FlyString, a simple flyweight string class FlyString is a flyweight string class that wraps a RefPtr<StringImpl> known to be unique among the set of FlyStrings. The class is very unoptimized at the moment. When to use FlyString: - When you want O(1) string comparison - When you want to deduplicate a lot of identical strings When not to use FlyString: - For strings that don't need either of the above features - For strings that are likely to be unique
2020-03-22 09:12:55 +00:00
AK: Add FlyString::to_lowercase() and LogStream operator<<(FlyString)
2020-03-22 18:07:02 +00:00
FlyString to_lowercase() const;
AK: Generalize AK::String::to_int() for more types
2020-12-10 13:17:30 +00:00
template<typename T = int>
Optional<T> to_int() const;
template<typename T = unsigned>
Optional<T> to_uint() const;
AK: Add FlyString, a simple flyweight string class FlyString is a flyweight string class that wraps a RefPtr<StringImpl> known to be unique among the set of FlyStrings. The class is very unoptimized at the moment. When to use FlyString: - When you want O(1) string comparison - When you want to deduplicate a lot of identical strings When not to use FlyString: - For strings that don't need either of the above features - For strings that are likely to be unique
2020-03-22 09:12:55 +00:00
AK: Add FlyString::equals_ignoring_case(StringView) And share the code with String by moving the logic to StringUtils. :^)
2020-03-22 12:07:45 +00:00
bool equals_ignoring_case(const StringView&) const;
AK: Add case insensitive version of starts_with
2020-07-18 16:59:38 +00:00
bool starts_with(const StringView&, CaseSensitivity = CaseSensitivity::CaseSensitive) const;
AK: Unify FlyString/StringView::ends_with implementation on StringUtils::ends_with This creates a unified implementation of ends_with with case sensitivity across String/StringView/FlyString.
2020-05-26 10:21:34 +00:00
bool ends_with(const StringView&, CaseSensitivity = CaseSensitivity::CaseSensitive) const;
AK: Add FlyString::equals_ignoring_case(StringView) And share the code with String by moving the logic to StringUtils. :^)
2020-03-22 12:07:45 +00:00
AK: Add FlyString, a simple flyweight string class FlyString is a flyweight string class that wraps a RefPtr<StringImpl> known to be unique among the set of FlyStrings. The class is very unoptimized at the moment. When to use FlyString: - When you want O(1) string comparison - When you want to deduplicate a lot of identical strings When not to use FlyString: - For strings that don't need either of the above features - For strings that are likely to be unique
2020-03-22 09:12:55 +00:00
static void did_destroy_impl(Badge<StringImpl>, StringImpl&);
AK: Add String::is_one_of(...) This allows you to compare a string against an arbitrary number of other strings with a single call.
2020-05-25 10:36:41 +00:00
template<typename T, typename... Rest>
AK: Make {String,FlyString}::is_one_of() const Also, make the zero-argument variant private since it's not meant to be called by clients directly.
2020-05-29 19:44:06 +00:00
bool is_one_of(const T& string, Rest... rest) const
AK: Add String::is_one_of(...) This allows you to compare a string against an arbitrary number of other strings with a single call.
2020-05-25 10:36:41 +00:00
{
AK: Tweak String::is_one_of() and FlyString::is_one_of() Switch the comparisons from "other == *this" to "*this == other".
2020-07-28 15:40:23 +00:00
if (*this == string)
AK: Add String::is_one_of(...) This allows you to compare a string against an arbitrary number of other strings with a single call.
2020-05-25 10:36:41 +00:00
return true;
return is_one_of(rest...);
}
AK: Add FlyString, a simple flyweight string class FlyString is a flyweight string class that wraps a RefPtr<StringImpl> known to be unique among the set of FlyStrings. The class is very unoptimized at the moment. When to use FlyString: - When you want O(1) string comparison - When you want to deduplicate a lot of identical strings When not to use FlyString: - For strings that don't need either of the above features - For strings that are likely to be unique
2020-03-22 09:12:55 +00:00
private:
AK: Make {String,FlyString}::is_one_of() const Also, make the zero-argument variant private since it's not meant to be called by clients directly.
2020-05-29 19:44:06 +00:00
bool is_one_of() const { return false; }
AK: Add FlyString, a simple flyweight string class FlyString is a flyweight string class that wraps a RefPtr<StringImpl> known to be unique among the set of FlyStrings. The class is very unoptimized at the moment. When to use FlyString: - When you want O(1) string comparison - When you want to deduplicate a lot of identical strings When not to use FlyString: - For strings that don't need either of the above features - For strings that are likely to be unique
2020-03-22 09:12:55 +00:00
RefPtr<StringImpl> m_impl;
};
template<>
struct Traits<FlyString> : public GenericTraits<FlyString> {
AK: Let FlyString::hash() assume that the string was already hashed Since the FlyString deduplication mechanism uses a HashTable, we know that any StringImpl inside a non-null FlyString will already have its lazily computed hash.
2020-04-13 10:05:19 +00:00
static unsigned hash(const FlyString& s) { return s.hash(); }
AK: Add FlyString, a simple flyweight string class FlyString is a flyweight string class that wraps a RefPtr<StringImpl> known to be unique among the set of FlyStrings. The class is very unoptimized at the moment. When to use FlyString: - When you want O(1) string comparison - When you want to deduplicate a lot of identical strings When not to use FlyString: - For strings that don't need either of the above features - For strings that are likely to be unique
2020-03-22 09:12:55 +00:00
};
}
using AK::FlyString;
Reference in a new issue Copy permalink