StringIterator.h

// Copyright (c) Stefano Cristiano
// SPDX-License-Identifier: MIT
#pragma once
#include "../Foundation/Assert.h" //Assert::unreachable
#include "../Foundation/Span.h"
#include "../Foundation/StringSpan.h"
#include "StringsExport.h"
 
namespace SC
{
 
using StringCodePoint = uint32_t;
 
constexpr bool StringEncodingAreBinaryCompatible(StringEncoding encoding1, StringEncoding encoding2)
{
    return (encoding1 == encoding2) or (encoding2 == StringEncoding::Ascii and encoding1 == StringEncoding::Utf8) or
           (encoding2 == StringEncoding::Utf8 and encoding1 == StringEncoding::Ascii);
}
 
template <typename CharIterator>
struct SC_STRINGS_EXPORT StringIterator
{
    static constexpr StringEncoding getEncoding() { return CharIterator::getEncoding(); }
 
    using CodeUnit  = char;
    using CodePoint = StringCodePoint;
 
    constexpr void setToStart() { it = start; }
 
    constexpr void setToEnd() { it = end; }
 
    [[nodiscard]] constexpr bool isAtEnd() const { return it >= end; }
 
    [[nodiscard]] constexpr bool isAtStart() const { return it <= start; }
 
    [[nodiscard]] constexpr bool advanceUntilMatches(CodePoint c);
 
    [[nodiscard]] bool reverseAdvanceUntilMatches(CodePoint c);
 
    template <typename OtherIterator>
    [[nodiscard]] bool advanceAfterFinding(StringIterator<OtherIterator> other)
    {
        return advanceBeforeOrAfterFinding<OtherIterator, true>(other);
    }
 
    [[nodiscard]] bool advanceAfterFinding(StringIterator other) { return advanceAfterFindingSameIterator(other); }
 
    template <typename OtherIterator>
    [[nodiscard]] bool advanceBeforeFinding(StringIterator<OtherIterator> other)
    {
        return advanceBeforeOrAfterFinding<OtherIterator, false>(other);
    }
 
    [[nodiscard]] bool advanceBeforeFinding(StringIterator other) { return advanceBeforeFindingSameIterator(other); }
 
    [[nodiscard]] bool advanceByLengthOf(StringIterator other) { return advanceOfBytes(other.end - other.it); }
 
    [[nodiscard]] bool advanceUntilMatchesAny(Span<const CodePoint> items, CodePoint& matched);
 
    [[nodiscard]] bool reverseAdvanceUntilMatchesAny(Span<const CodePoint> items, CodePoint& matched);
 
    [[nodiscard]] bool advanceUntilDifferentFrom(CodePoint c, CodePoint* optionalReadChar = nullptr);
 
    [[nodiscard]] constexpr bool advanceIfMatches(CodePoint c);
 
    [[nodiscard]] bool advanceBackwardIfMatches(CodePoint c);
 
    [[nodiscard]] bool advanceIfMatchesAny(Span<const CodePoint> items);
 
    [[nodiscard]] bool advanceIfMatchesRange(CodePoint first, CodePoint last);
 
    [[nodiscard]] bool match(CodePoint c) { return it < end and CharIterator::decode(it, end) == c; }
 
    [[nodiscard]] constexpr bool advanceRead(CodePoint& c);
 
    [[nodiscard]] bool read(CodePoint& c);
 
    [[nodiscard]] bool advanceBackwardRead(CodePoint& c);
 
    [[nodiscard]] constexpr bool stepForward();
 
    [[nodiscard]] constexpr bool stepBackward();
 
    [[nodiscard]] constexpr bool advanceCodePoints(size_t numCodePoints);
 
    [[nodiscard]] bool reverseAdvanceCodePoints(size_t numCodePoints);
 
    [[nodiscard]] constexpr bool isFollowedBy(CodePoint c);
 
    [[nodiscard]] constexpr bool isPrecededBy(CodePoint c);
 
    [[nodiscard]] constexpr StringIterator sliceFromStartUntil(StringIterator otherPoint) const;
 
    [[nodiscard]] constexpr ssize_t bytesDistanceFrom(StringIterator other) const;
 
    [[nodiscard]] bool endsWithAnyOf(Span<const CodePoint> codePoints) const;
 
    [[nodiscard]] bool startsWithAnyOf(Span<const CodePoint> codePoints) const;
 
    template <typename IteratorType>
    [[nodiscard]] bool endsWith(IteratorType other) const;
 
    template <typename IteratorType>
    [[nodiscard]] bool startsWith(IteratorType other) const;
 
  protected:
    template <typename OtherIterator, bool after>
    [[nodiscard]] bool advanceBeforeOrAfterFinding(StringIterator<OtherIterator> other);
    [[nodiscard]] bool advanceAfterFindingSameIterator(StringIterator other);
    [[nodiscard]] bool advanceBeforeFindingSameIterator(StringIterator other);
    [[nodiscard]] bool advanceOfBytes(ssize_t bytesLength);
 
    friend struct StringView;
    static constexpr const CodeUnit* getNextOf(const CodeUnit* src, const char* end)
    {
        return CharIterator::getNextOf(src, end);
    }
    static constexpr const CodeUnit* getPreviousOf(const CodeUnit* src, const char* start)
    {
        return CharIterator::getPreviousOf(src, start);
    }
    constexpr StringIterator(const CodeUnit* it, const CodeUnit* end) : it(it), start(it), end(end) {}
    const CodeUnit* it;
    const CodeUnit* start;
    const CodeUnit* end;
};
 
struct SC_STRINGS_EXPORT StringIteratorASCII : public StringIterator<StringIteratorASCII>
{
    [[nodiscard]] constexpr bool advanceUntilMatches(CodePoint c);
 
  private:
    [[nodiscard]] bool advanceUntilMatchesNonConstexpr(CodePoint c);
    using StringIterator::StringIterator;
    constexpr StringIteratorASCII(const CodeUnit* it, const CodeUnit* end) : StringIterator(it, end) {}
    using Parent = StringIterator<StringIteratorASCII>;
    friend Parent;
    friend struct StringView;
 
    [[nodiscard]] static constexpr StringEncoding getEncoding() { return StringEncoding::Ascii; }
 
    [[nodiscard]] static constexpr const char* getNextOf(const char* src, const char*) { return src + 1; }
    [[nodiscard]] static constexpr const char* getPreviousOf(const char* src, const char*) { return src - 1; }
    [[nodiscard]] static constexpr CodePoint   decode(const char* src, const char*)
    {
        return static_cast<CodePoint>(*src);
    }
};
 
struct SC_STRINGS_EXPORT StringIteratorUTF16 : public StringIterator<StringIteratorUTF16>
{
  private:
    using StringIterator::StringIterator;
    constexpr StringIteratorUTF16(const CodeUnit* it, const CodeUnit* end) : StringIterator(it, end) {}
    using Parent = StringIterator<StringIteratorUTF16>;
    friend Parent;
    friend struct StringView;
 
    [[nodiscard]] static StringEncoding getEncoding() { return StringEncoding::Utf16; }
 
    [[nodiscard]] static const char* getNextOf(const char* bytes, const char* end);
    [[nodiscard]] static const char* getPreviousOf(const char* bytes, const char* start);
 
    [[nodiscard]] static uint32_t decode(const char* bytes, const char* end);
};
 
struct SC_STRINGS_EXPORT StringIteratorUTF8 : public StringIterator<StringIteratorUTF8>
{
  private:
    using Parent = StringIterator<StringIteratorUTF8>;
    friend Parent;
    friend struct StringView;
    using StringIterator::StringIterator;
    constexpr StringIteratorUTF8(const CodeUnit* it, const CodeUnit* end) : StringIterator(it, end) {}
 
    [[nodiscard]] static StringEncoding getEncoding() { return StringEncoding::Utf8; }
 
    [[nodiscard]] static const char* getNextOf(const char* src, const char* end);
    [[nodiscard]] static const char* getPreviousOf(const char* src, const char* start);
 
    [[nodiscard]] static uint32_t decode(const char* src, const char* end);
};
 
struct StringIteratorSkipTable
{
    bool matches[256] = {false};
    constexpr StringIteratorSkipTable(Span<const char> chars)
    {
        for (auto c : chars)
        {
            matches[static_cast<int>(c)] = true;
        }
    }
};
 
//-----------------------------------------------------------------------------------------------------------------------
// Implementations Details
//-----------------------------------------------------------------------------------------------------------------------
template <typename CharIterator>
constexpr bool StringIterator<CharIterator>::advanceUntilMatches(CodePoint c)
{
    while (it < end)
    {
        if (CharIterator::decode(it, end) == c)
            return true;
        it = getNextOf(it, end);
    }
    return false;
}
 
template <typename CharIterator>
constexpr bool StringIterator<CharIterator>::advanceIfMatches(CodePoint c)
{
    if (it < end and CharIterator::decode(it, end) == c)
    {
        it = getNextOf(it, end);
        return true;
    }
    return false;
}
 
template <typename CharIterator>
constexpr bool StringIterator<CharIterator>::advanceRead(CodePoint& c)
{
    if (it < end)
    {
        c  = CharIterator::decode(it, end);
        it = getNextOf(it, end);
        return true;
    }
    return false;
}
 
template <typename CharIterator>
constexpr bool StringIterator<CharIterator>::stepForward()
{
    if (it < end)
    {
        it = getNextOf(it, end);
        return true;
    }
    return false;
}
 
template <typename CharIterator>
constexpr bool StringIterator<CharIterator>::stepBackward()
{
    if (it > start)
    {
        it = getPreviousOf(it, start);
        return true;
    }
    return false;
}
 
template <typename CharIterator>
constexpr bool StringIterator<CharIterator>::advanceCodePoints(size_t numCodePoints)
{
    while (numCodePoints > 0)
    {
        numCodePoints -= 1;
        if (it >= end)
        {
            return false;
        }
        it = getNextOf(it, end);
    }
    return true;
}
 
template <typename CharIterator>
constexpr bool StringIterator<CharIterator>::isFollowedBy(CodePoint c)
{
    return it < end ? CharIterator::decode(getNextOf(it, end), end) == c : false;
}
 
template <typename CharIterator>
constexpr bool StringIterator<CharIterator>::isPrecededBy(CodePoint c)
{
    return it > start ? CharIterator::decode(getPreviousOf(it, start), it) == c : false;
}
 
template <typename CharIterator>
constexpr StringIterator<CharIterator> StringIterator<CharIterator>::sliceFromStartUntil(
    StringIterator otherPoint) const
{
    SC_ASSERT_RELEASE(it <= otherPoint.it);
    return StringIterator(it, otherPoint.it);
}
 
template <typename CharIterator>
constexpr ssize_t StringIterator<CharIterator>::bytesDistanceFrom(StringIterator other) const
{
    return (it - other.it) * static_cast<ssize_t>(sizeof(CodeUnit));
}
 
// StringIteratorASCII
[[nodiscard]] constexpr bool StringIteratorASCII::advanceUntilMatches(CodePoint c)
{
#if defined(__clang__)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunreachable-code"
#endif
    return __builtin_is_constant_evaluated() ? StringIterator::advanceUntilMatches(c)
                                             : advanceUntilMatchesNonConstexpr(c);
#if defined(__clang__)
#pragma clang diagnostic pop
#endif
}
 
} // namespace SC