summaryrefslogtreecommitdiff
path: root/include/fud_string_view.hpp
blob: 2ced639eb3cfc0293b3cbf27b3fdf2de667b40e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/*
 * libfud
 * Copyright 2024 Dominick Allen
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef FUD_STRING_VIEW_HPP
#define FUD_STRING_VIEW_HPP

#include "fud_status.hpp"
#include "fud_utf8.hpp"
#include "fud_config.hpp"
#include "fud_assert.hpp"

#include <string_view>

namespace fud {

class String;

struct StringView {
    constexpr StringView() noexcept = default;

    constexpr StringView(const StringView& rhs) noexcept = default;

    constexpr StringView(StringView&& rhs) noexcept = default;

    constexpr ~StringView() noexcept = default;

    constexpr StringView& operator=(const StringView& rhs) = default;
    constexpr StringView& operator=(StringView&& rhs) = default;

    constexpr StringView(size_t strLen, const utf8* strData) : m_length(strLen), m_data{strData}
    {
    }

    StringView(size_t strLen, const char* strData) :
        m_length(strLen), // line break
        m_data{reinterpret_cast<const utf8*>(strData)} // NOLINT(cppcoreguidelines-pro-type-reinterpret-cast)
    {
    }

    StringView(std::string_view rhs) noexcept : StringView(rhs.length(), rhs.data()) {}

    explicit StringView(const String& fudString) noexcept;

    [[nodiscard]] constexpr size_t length() const
    {
        return m_length;
    }

    [[nodiscard]] constexpr const utf8* data() const
    {
        return m_data;
    }

    constexpr const utf8& operator[](size_t index) const
    {
        if constexpr (fudBoundsChecking) {
            fudAssert(m_data != nullptr);
            fudAssert(index < m_length);
        }
        return m_data[index];
    }

    constexpr const utf8* begin() const noexcept
    {
        return m_data;
    }

    constexpr const utf8* end() const noexcept
    {
        return m_data + m_length;
    }

    [[nodiscard]] bool nullTerminated() const;

    [[nodiscard]] bool utf8Valid() const;

    Result<size_t, FudStatus> skipWhitespace();

    Result<size_t, FudStatus> trimWhitespace();

    [[nodiscard]] bool advance();

    void advanceUnsafe();

    [[nodiscard]] bool advance(size_t size);

    void advanceUnsafe(size_t size);

    size_t m_length{0};

    const utf8* m_data{nullptr};

    auto operator<=>(const StringView& rhs) const noexcept = default;
};

} // namespace fud

#endif