1 files changed, 56 insertions, 0 deletions
diff --git a/include/fud_utf8_iterator.hpp b/include/fud_utf8_iterator.hpp
new file mode 100644
index 0000000..3721b00
--- /dev/null
+++ b/include/fud_utf8_iterator.hpp
@@ -0,0 +1,56 @@
+/*
+ * 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_UTF8_ITERATOR_HPP
+#define FUD_UTF8_ITERATOR_HPP
+
+#include "fud_string.hpp"
+#include "fud_utf8.hpp"
+
+#include <cstddef>
+#include <optional>
+
+namespace fud {
+
+class Utf8Iterator {
+  private:
+    size_t m_index{0};
+    // NOLINTBEGIN(cppcoreguidelines-avoid-const-or-ref-data-members)
+    const StringView m_view;
+    // NOLINTEND(cppcoreguidelines-avoid-const-or-ref-data-members)
+
+  public:
+    explicit constexpr Utf8Iterator(const String& fudString) : m_view{fudString}
+    {
+    }
+
+    explicit constexpr Utf8Iterator(const StringView& view) : m_view{view}
+    {
+    }
+
+    constexpr void reset()
+    {
+        m_index = 0;
+    }
+
+    [[nodiscard]] std::optional<FudUtf8> peek() const;
+    std::optional<FudUtf8> next();
+};
+
+} // namespace fud
+
+#endif