ladybird/AK/Utf32View.h
Lenny Maiorani e6f907a155 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-12 09:11:45 +01:00

142 lines
4.0 KiB
C++

/*
* Copyright (c) 2020, Andreas Kling <kling@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/Assertions.h>
#include <AK/Checked.h>
#include <AK/Types.h>
namespace AK {
class Utf32View;
class Utf32CodepointIterator {
friend class Utf32View;
public:
Utf32CodepointIterator() = default;
~Utf32CodepointIterator() = default;
bool operator==(const Utf32CodepointIterator& other) const
{
return m_ptr == other.m_ptr && m_length == other.m_length;
}
bool operator!=(const Utf32CodepointIterator& other) const
{
return !(*this == other);
}
Utf32CodepointIterator& operator++()
{
ASSERT(m_length > 0);
m_ptr++;
m_length--;
return *this;
}
ssize_t operator-(const Utf32CodepointIterator& other) const
{
return m_ptr - other.m_ptr;
}
u32 operator*() const
{
ASSERT(m_length > 0);
return *m_ptr;
}
constexpr int code_point_length_in_bytes() const { return sizeof(u32); }
bool done() const { return !m_length; }
private:
Utf32CodepointIterator(const u32* ptr, size_t length)
: m_ptr(ptr)
, m_length((ssize_t)length)
{
}
const u32* m_ptr { nullptr };
ssize_t m_length { -1 };
};
class Utf32View {
public:
using Iterator = Utf32CodepointIterator;
Utf32View() = default;
Utf32View(const u32* code_points, size_t length)
: m_code_points(code_points)
, m_length(length)
{
ASSERT(code_points || length == 0);
}
Utf32CodepointIterator begin() const
{
return { begin_ptr(), m_length };
}
Utf32CodepointIterator end() const
{
return { end_ptr(), 0 };
}
const u32* code_points() const { return m_code_points; }
bool is_empty() const { return m_length == 0; }
size_t length() const { return m_length; }
size_t iterator_offset(const Utf32CodepointIterator& it) const
{
ASSERT(it.m_ptr >= m_code_points);
ASSERT(it.m_ptr < m_code_points + m_length);
return ((ptrdiff_t)it.m_ptr - (ptrdiff_t)m_code_points) / sizeof(u32);
}
Utf32View substring_view(size_t offset, size_t length) const
{
if (length == 0)
return {};
ASSERT(offset < m_length);
ASSERT(!Checked<size_t>::addition_would_overflow(offset, length));
ASSERT((offset + length) <= m_length);
return Utf32View(m_code_points + offset, length);
}
private:
const u32* begin_ptr() const
{
return m_code_points;
}
const u32* end_ptr() const
{
return m_code_points + m_length;
}
const u32* m_code_points { nullptr };
size_t m_length { 0 };
};
}
using AK::Utf32View;