mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2024-11-25 17:10:23 +00:00
6e19ab2bbc
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 :^)
130 lines
3.7 KiB
C++
130 lines
3.7 KiB
C++
/*
|
|
* Copyright (c) 2021, Tim Flynn <trflynn89@serenityos.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/DeprecatedString.h>
|
|
#include <AK/Format.h>
|
|
#include <AK/Forward.h>
|
|
#include <AK/Optional.h>
|
|
#include <AK/Span.h>
|
|
#include <AK/Types.h>
|
|
#include <AK/Vector.h>
|
|
|
|
namespace AK {
|
|
|
|
Vector<u16, 1> utf8_to_utf16(StringView);
|
|
Vector<u16, 1> utf8_to_utf16(Utf8View const&);
|
|
Vector<u16, 1> utf32_to_utf16(Utf32View const&);
|
|
void code_point_to_utf16(Vector<u16, 1>&, u32);
|
|
|
|
class Utf16View;
|
|
|
|
class Utf16CodePointIterator {
|
|
friend class Utf16View;
|
|
|
|
public:
|
|
Utf16CodePointIterator() = default;
|
|
~Utf16CodePointIterator() = default;
|
|
|
|
bool operator==(Utf16CodePointIterator const& other) const
|
|
{
|
|
return (m_ptr == other.m_ptr) && (m_remaining_code_units == other.m_remaining_code_units);
|
|
}
|
|
|
|
Utf16CodePointIterator& operator++();
|
|
u32 operator*() const;
|
|
|
|
size_t length_in_code_units() const;
|
|
|
|
private:
|
|
Utf16CodePointIterator(u16 const* ptr, size_t length)
|
|
: m_ptr(ptr)
|
|
, m_remaining_code_units(length)
|
|
{
|
|
}
|
|
|
|
u16 const* m_ptr { nullptr };
|
|
size_t m_remaining_code_units { 0 };
|
|
};
|
|
|
|
class Utf16View {
|
|
public:
|
|
static bool is_high_surrogate(u16);
|
|
static bool is_low_surrogate(u16);
|
|
static u32 decode_surrogate_pair(u16 high_surrogate, u16 low_surrogate);
|
|
|
|
Utf16View() = default;
|
|
~Utf16View() = default;
|
|
|
|
explicit Utf16View(Span<u16 const> code_units)
|
|
: m_code_units(code_units)
|
|
{
|
|
}
|
|
|
|
bool operator==(Utf16View const& other) const { return m_code_units == other.m_code_units; }
|
|
|
|
enum class AllowInvalidCodeUnits {
|
|
Yes,
|
|
No,
|
|
};
|
|
|
|
DeprecatedString to_utf8(AllowInvalidCodeUnits = AllowInvalidCodeUnits::No) const;
|
|
|
|
bool is_null() const { return m_code_units.is_null(); }
|
|
bool is_empty() const { return m_code_units.is_empty(); }
|
|
size_t length_in_code_units() const { return m_code_units.size(); }
|
|
size_t length_in_code_points() const;
|
|
|
|
Utf16CodePointIterator begin() const { return { begin_ptr(), m_code_units.size() }; }
|
|
Utf16CodePointIterator end() const { return { end_ptr(), 0 }; }
|
|
|
|
u16 const* data() const { return m_code_units.data(); }
|
|
u16 code_unit_at(size_t index) const;
|
|
u32 code_point_at(size_t index) const;
|
|
|
|
size_t code_point_offset_of(size_t code_unit_offset) const;
|
|
size_t code_unit_offset_of(size_t code_point_offset) const;
|
|
size_t code_unit_offset_of(Utf16CodePointIterator const&) const;
|
|
|
|
Utf16View substring_view(size_t code_unit_offset, size_t code_unit_length) const;
|
|
Utf16View substring_view(size_t code_unit_offset) const { return substring_view(code_unit_offset, length_in_code_units() - code_unit_offset); }
|
|
|
|
Utf16View unicode_substring_view(size_t code_point_offset, size_t code_point_length) const;
|
|
Utf16View unicode_substring_view(size_t code_point_offset) const { return unicode_substring_view(code_point_offset, length_in_code_points() - code_point_offset); }
|
|
|
|
bool validate(size_t& valid_code_units) const;
|
|
bool validate() const
|
|
{
|
|
size_t valid_code_units;
|
|
return validate(valid_code_units);
|
|
}
|
|
|
|
bool equals_ignoring_case(Utf16View const&) const;
|
|
|
|
private:
|
|
u16 const* begin_ptr() const { return m_code_units.data(); }
|
|
u16 const* end_ptr() const { return begin_ptr() + m_code_units.size(); }
|
|
|
|
size_t calculate_length_in_code_points() const;
|
|
|
|
Span<u16 const> m_code_units;
|
|
mutable Optional<size_t> m_length_in_code_points;
|
|
};
|
|
|
|
}
|
|
|
|
template<>
|
|
struct AK::Formatter<AK::Utf16View> : Formatter<FormatString> {
|
|
ErrorOr<void> format(FormatBuilder& builder, AK::Utf16View const& value)
|
|
{
|
|
return builder.builder().try_append(value);
|
|
}
|
|
};
|
|
|
|
#if USING_AK_GLOBALLY
|
|
using AK::Utf16View;
|
|
#endif
|