Directory.h

Go to the documentation of this file.

/****
 * Directory.h
 *
 * Created: May 2019
 *
 * Copyright 2019 mikee47 <mike@sillyhouse.net>
 *
 * This file is part of the IFS Library
 *
 * This library is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, version 3 or later.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this library.
 * If not, see <https://www.gnu.org/licenses/>.
 *
 ****/

#pragma once

#include "FsBase.h"

namespace IFS
{
class Directory : public FsBase
{
public:
    using FsBase::FsBase;

    ~Directory()
    {
        close();
    }

    bool open(const String& dirName = nullptr);

    void close();

    bool rewind();

    const String& getDirName() const
    {
        return name;
    }

    bool dirExist() const
    {
        return dir != nullptr;
    }

    String getPath() const;

    String getParent() const;

    int index() const
    {
        return currentIndex;
    }

    uint32_t count() const
    {
        return uint32_t(maxIndex + 1);
    }

    bool isValid() const
    {
        return currentIndex >= 0;
    }

    file_size_t size() const
    {
        return totalSize;
    }

    const Stat& stat() const
    {
        return dirStat;
    }

    bool next();

private:
    String name;
    DirHandle dir{};
    NameStat dirStat;
    int currentIndex{-1};
    int maxIndex{-1};
    file_size_t totalSize{0};
};

} // namespace IFS