FileSystemIterator.h

// Copyright (c) Stefano Cristiano
// SPDX-License-Identifier: MIT
#pragma once
#include "../File/FileDescriptor.h"
#include "../Foundation/OpaqueObject.h"
#include "../Foundation/Result.h"
#include "../Strings/StringView.h"
 
namespace SC
{
struct FileSystemIterator;
} // namespace SC
 
 
 
struct SC::FileSystemIterator
{
  private:
    struct Internal;
 
  public:
    enum class Type
    {
        Directory,
        File
    };
 
    struct Entry
    {
        StringView name;               
        StringView path;               
        uint32_t   level = 0;          
        Type       type  = Type::File; 
 
        bool isDirectory() const { return type == Type::Directory; }
 
      private:
        FileDescriptor parentFileDescriptor;
        friend struct Internal;
    };
 
    struct Options
    {
        bool recursive      = false; 
        bool forwardSlashes = false; 
    };
 
    Options options; 
 
    ~FileSystemIterator();
 
    const Entry& get() const { return currentEntry; }
 
    [[nodiscard]] Result checkErrors()
    {
        errorsChecked = true;
        return errorResult;
    }
 
    [[nodiscard]] Result init(StringView directory);
 
 
    [[nodiscard]] Result enumerateNext();
 
    [[nodiscard]] Result recurseSubdirectory();
 
  private:
    struct InternalDefinition
    {
        static constexpr int Windows = 4272;
        static constexpr int Apple   = 2104;
        static constexpr int Default = 2088;
 
        static constexpr size_t Alignment = sizeof(uint64_t);
 
        using Object = Internal;
    };
 
  public:
    using InternalOpaque = OpaqueObject<InternalDefinition>;
 
  private:
    InternalOpaque internal;
 
    Entry  currentEntry;
    Result errorResult   = Result(true);
    bool   errorsChecked = false;
};