system/serenity
system/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity synced 2024-07-21 01:55:07 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
serenity/AK/FlyString.h

107 lines
2.8 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
AK: Add a way to disable the trimming of whitespace in to_*int This behavior might not always be desirable, and so this patch adds a way to disable it.
2021-06-18 16:21:27 +00:00
#include "AK/StringUtils.h"
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 :^)
2022-12-04 18:02:33 +00:00
#include <AK/DeprecatedString.h>
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
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;
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
FlyString(FlyString const& other)
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
: m_impl(other.impl())
{
}
FlyString(FlyString&& other)
: m_impl(move(other.m_impl))
{
}
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 :^)
2022-12-04 18:02:33 +00:00
FlyString(DeprecatedString const&);
Everywhere: Pass AK::StringView by value
2021-11-10 23:55:02 +00:00
FlyString(StringView);
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
FlyString(char const* string)
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 :^)
2022-12-04 18:02:33 +00:00
: FlyString(static_cast<DeprecatedString>(string))
AK: Allow inlining more string functions
2021-06-02 23:35:01 +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
AK: Add FlyString::from_fly_impl() This allows you to create a FlyString directly from a known-fly StringImpl instance.
2021-06-13 10:00:01 +00:00
static FlyString from_fly_impl(NonnullRefPtr<StringImpl> impl)
{
VERIFY(impl->is_fly());
FlyString string;
string.m_impl = move(impl);
return string;
}
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
FlyString& operator=(FlyString const& other)
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
{
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; }
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
bool operator==(FlyString const& other) const { return m_impl == 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
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 :^)
2022-12-04 18:02:33 +00:00
bool operator==(DeprecatedString const&) const;
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
Everywhere: Pass AK::StringView by value
2021-11-10 23:55:02 +00:00
bool operator==(StringView) const;
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
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
bool operator==(char const*) const;
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
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
StringImpl const* impl() const { return m_impl; }
char const* characters() const { return m_impl ? m_impl->characters() : nullptr; }
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
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; }
Revert "Revert "AK: Always inline FlyString::view()"" This reverts commit f09216ac42bac9108e7f36ed2938c6f278f497e4. This was supposed to be a local test only, didn't mean to push it. :^)
2021-06-06 07:05:49 +00:00
ALWAYS_INLINE StringView view() const { return m_impl ? m_impl->view() : StringView {}; }
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>
AK: Add a way to disable the trimming of whitespace in to_*int This behavior might not always be desirable, and so this patch adds a way to disable it.
2021-06-18 16:21:27 +00:00
Optional<T> to_int(TrimWhitespace = TrimWhitespace::Yes) const;
AK: Generalize AK::String::to_int() for more types
2020-12-10 13:17:30 +00:00
template<typename T = unsigned>
AK: Add a way to disable the trimming of whitespace in to_*int This behavior might not always be desirable, and so this patch adds a way to disable it.
2021-06-18 16:21:27 +00:00
Optional<T> to_uint(TrimWhitespace = TrimWhitespace::Yes) const;
AK: Add to_{double, float} convenience functions to all string types These are guarded with #ifndef KERNEL, since doubles (and floats) are not allowed in KERNEL mode. In StringUtils there is convert_to_floating_point which does have a template parameter incase you have a templated type.
2022-10-10 22:48:45 +00:00
#ifndef KERNEL
Optional<double> to_double(TrimWhitespace = TrimWhitespace::Yes) const;
Optional<float> to_float(TrimWhitespace = TrimWhitespace::Yes) const;
#endif
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
Everywhere: Pass AK::StringView by value
2021-11-10 23:55:02 +00:00
bool equals_ignoring_case(StringView) const;
bool starts_with(StringView, CaseSensitivity = CaseSensitivity::CaseSensitive) const;
bool ends_with(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: Inline *String::is_one_of<Ts...>() Previously this was generating a crazy number of symbols, and it was also pretty-damn-slow as it was defined recursively, which made the compiler incapable of inlining it (due to the many many layers of recursion before it terminated). This commit replaces the recursion with a pack expansion and marks it always-inline.
2021-06-04 09:46:29 +00:00
template<typename... Ts>
[[nodiscard]] ALWAYS_INLINE constexpr bool is_one_of(Ts... strings) 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: Inline *String::is_one_of<Ts...>() Previously this was generating a crazy number of symbols, and it was also pretty-damn-slow as it was defined recursively, which made the compiler incapable of inlining it (due to the many many layers of recursion before it terminated). This commit replaces the recursion with a pack expansion and marks it always-inline.
2021-06-04 09:46:29 +00:00
return (... || this->operator==(forward<Ts>(strings)));
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: 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:
RefPtr<StringImpl> m_impl;
};
template<>
struct Traits<FlyString> : public GenericTraits<FlyString> {
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
static unsigned hash(FlyString const& 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
};
}
AK: Make it possible to not `using` AK classes into the global namespace This patch adds the `USING_AK_GLOBALLY` macro which is enabled by default, but can be overridden by build flags. This is a step towards integrating Jakt and AK types.
2022-11-26 11:18:30 +00:00
#if USING_AK_GLOBALLY
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;
AK: Make it possible to not `using` AK classes into the global namespace This patch adds the `USING_AK_GLOBALLY` macro which is enabled by default, but can be overridden by build flags. This is a step towards integrating Jakt and AK types.
2022-11-26 11:18:30 +00:00
#endif
Reference in a new issue Copy permalink