FileContentIterator.hpp

Go to the documentation of this file.

 
#pragma once
 
// --- Core Includes ---
#include "includes/lock_object.h" // Kratos::LockObject
 
// --- STL Includes ---
#include <iterator> // std::forward_iterator_tag, std::ptrdiff_t
#include <optional> // std::optional
#include <fstream> // std::fstream
#include <utility> // std::pair
#include <mutex> // std::unique_lock
 
 
namespace Kratos {
 
 
 
 
class FileContentIterator
{
public:
    using FileAccess = std::optional<std::pair<
        std::fstream,
        LockObject
    >>;
 
    using iterator_category = std::forward_iterator_tag;
 
    using value_type = std::pair<FileContentIterator,FileContentIterator>;
 
    using difference_type = std::ptrdiff_t;
 
    using pointer = void;
 
    using reference = void;
 
public:
    FileContentIterator(std::shared_ptr<FileAccess>&& rpFileAccess,
                        char delimiter = '\n');
 
    FileContentIterator(const std::shared_ptr<FileAccess>& rpFileAccess,
                        char delimiter = '\n');
 
    FileContentIterator() = delete;
 
    FileContentIterator(FileContentIterator&& rOther) = default;
 
    FileContentIterator(const FileContentIterator& rOther) = default;
 
    FileContentIterator& operator=(FileContentIterator&& rOther) = default;
 
    FileContentIterator& operator=(const FileContentIterator& rOther) = default;
 
    FileContentIterator& operator++();
 
    FileContentIterator operator++(int);
 
    value_type operator*() const;
 
    std::string value() const;
 
    friend bool operator==(const FileContentIterator& rLeft, const FileContentIterator& rRight);
 
    friend bool operator!=(const FileContentIterator& rLeft, const FileContentIterator& rRight);
 
    friend bool operator<(const FileContentIterator& rLeft, const FileContentIterator& rRight);
 
    void SeekEOF();
 
private:
    using Position = std::fstream::pos_type;
 
    Position GetPosition() const noexcept;
 
    bool SeekNext(char Target);
 
    void StoreState();
 
    void RestoreState() const;
 
    mutable std::shared_ptr<FileAccess> mpFileAccess;
 
    char mDelimiter;
 
    Position mPosition;
}; // class FileContentIterator
 
 
class FileStringIterator
{
public:
    using iterator_category = std::forward_iterator_tag;
 
    using value_type = std::string;
 
    using difference_type = std::ptrdiff_t;
 
    using pointer = void;
 
    using reference = void;
 
    using FileAccess = FileContentIterator::FileAccess;
 
public:
    FileStringIterator(std::shared_ptr<FileAccess>&& rpFileAccess,
                       char delimiter = '\n');
 
    FileStringIterator(const std::shared_ptr<FileAccess>& rpFileAccess,
                       char delimiter = '\n');
 
    FileStringIterator(FileStringIterator&& rOther) = default;
 
    FileStringIterator(const FileStringIterator& rOther) = default;
 
    FileStringIterator& operator=(FileStringIterator&& rOther) = default;
 
    FileStringIterator& operator=(const FileStringIterator& rOther) = default;
 
    FileStringIterator& operator++();
 
    FileStringIterator operator++(int);
 
    value_type operator*() const;
 
    void SeekEOF();
 
    friend bool operator==(const FileStringIterator& rLeft, const FileStringIterator& rRight);
 
    friend bool operator!=(const FileStringIterator& rLeft, const FileStringIterator& rRight);
 
    friend bool operator<(const FileStringIterator& rLeft, const FileStringIterator& rRight);
 
private:
    FileContentIterator mWrapped;
}; // class FileStringIterator
 
 
 
 
} // namespace Kratos