ladybird/AK/Utf8View.h
2020-07-13 15:07:29 +02:00

95 lines
3 KiB
C++

/*
* Copyright (c) 2019-2020, Sergey Bugaev <bugaevc@serenityos.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include <AK/StringView.h>
#include <AK/Types.h>
namespace AK {
class Utf8View;
class Utf8CodepointIterator {
friend class Utf8View;
public:
Utf8CodepointIterator() { }
~Utf8CodepointIterator() { }
bool operator==(const Utf8CodepointIterator&) const;
bool operator!=(const Utf8CodepointIterator&) const;
Utf8CodepointIterator& operator++();
u32 operator*() const;
int codepoint_length_in_bytes() const;
bool done() const { return !m_length; }
private:
Utf8CodepointIterator(const unsigned char*, int);
const unsigned char* m_ptr { nullptr };
int m_length { -1 };
};
class Utf8View {
public:
Utf8View() { }
explicit Utf8View(const String&);
explicit Utf8View(const StringView&);
explicit Utf8View(const char*);
~Utf8View() { }
const StringView& as_string() const { return m_string; }
Utf8CodepointIterator begin() const;
Utf8CodepointIterator end() const;
const unsigned char* bytes() const { return begin_ptr(); }
int byte_length() const { return m_string.length(); }
int byte_offset_of(const Utf8CodepointIterator&) const;
Utf8View substring_view(int byte_offset, int byte_length) const;
bool is_empty() const { return m_string.is_empty(); }
bool validate(size_t& valid_bytes) const;
bool validate() const
{
size_t valid_bytes;
return validate(valid_bytes);
}
size_t length_in_codepoints() const;
private:
const unsigned char* begin_ptr() const;
const unsigned char* end_ptr() const;
StringView m_string;
};
}
using AK::Utf8CodepointIterator;
using AK::Utf8View;