Splitter.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2025 nfx
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

 
#pragma once
 
#include <cstddef>
#include <iterator>
#include <string_view>
 
namespace nfx::string
{
    //=====================================================================
    // Splitter class
    //=====================================================================

    class Splitter
    {
    public:
        //----------------------------------------------
        // Forward declarations
        //----------------------------------------------
 
        class Iterator;
 
        //----------------------------------------------
        // Construction
        //----------------------------------------------

        template <typename String>
        inline explicit Splitter( String&& str, char delimiter ) noexcept;
 
        //----------------------------------------------
        // Iteration
        //----------------------------------------------

        inline Iterator begin() const noexcept;

        inline Iterator end() const noexcept;
 
        //----------------------------------------------
        // Splitter::Iterator class
        //----------------------------------------------

        class Iterator
        {
        public:
            //-----------------------------
            // Iterator traits
            //-----------------------------

            using iterator_category = std::forward_iterator_tag;

            using value_type = std::string_view;

            using difference_type = std::ptrdiff_t;

            using pointer = const std::string_view*;

            using reference = std::string_view;
 
            //-----------------------------
            // Construction
            //-----------------------------

            inline Iterator() noexcept = default;

            inline explicit Iterator( const Splitter& splitter, bool at_end = false ) noexcept;
 
            //-----------------------------
            // Iterator operators
            //-----------------------------

            inline std::string_view operator*() const noexcept;

            inline Iterator& operator++() noexcept;

            inline Iterator operator++( int ) noexcept;
 
            //-----------------------------
            // Comparison operators
            //-----------------------------

            inline bool operator==( const Iterator& other ) const noexcept;

            inline bool operator!=( const Iterator& other ) const noexcept;
 
        private:
            //-----------------------------
            // Private member variables
            //-----------------------------
 
            const Splitter* m_splitter{ nullptr };
            size_t m_start{};
            size_t m_end{};
            bool m_isAtEnd{ true };
        };
 
    private:
        std::string_view m_str;
        char m_delimiter;
    };
 
    //=====================================================================
    // String splitting factory functions
    //=====================================================================

    template <typename String>
    [[nodiscard]] inline Splitter splitView( String&& str, char delimiter ) noexcept;
} // namespace nfx::string
 
#include "nfx/detail/string/Splitter.inl"