wiiload_plugin/src/fs/DirList.h

/****************************************************************************
 * Copyright (C) 2010
 * by Dimok
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any
 * damages arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any
 * purpose, including commercial applications, and to alter it and
 * redistribute it freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you
 * must not claim that you wrote the original software. If you use
 * this software in a product, an acknowledgment in the product
 * documentation would be appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and
 * must not be misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source
 * distribution.
 *
 * DirList Class
 * for WiiXplorer 2010
 ***************************************************************************/
#pragma once

#include <string>
#include <vector>
#include <wut_types.h>

typedef struct {
    char *FilePath;
    BOOL isDir;
} DirEntry;

class DirList {
public:
    //!Constructor
    DirList();

    //!\param path Path from where to load the filelist of all files
    //!\param filter A fileext that needs to be filtered
    //!\param flags search/filter flags from the enum
    explicit DirList(const std::string &path, const char *filter = nullptr, uint32_t flags = Files | Dirs, uint32_t maxDepth = 0xffffffff);

    //!Destructor
    virtual ~DirList();

    //! Load all the files from a directory
    BOOL LoadPath(const std::string &path, const char *filter = nullptr, uint32_t flags = Files | Dirs, uint32_t maxDepth = 0xffffffff);

    //! Get a filename of the list
    //!\param list index
    [[nodiscard]] const char *GetFilename(int32_t index) const;

    //! Get the a filepath of the list
    //!\param list index
    [[nodiscard]] const char *GetFilepath(int32_t index) const {
        if (!valid(index)) return "";
        else
            return FileInfo[index].FilePath;
    }

    //! Get the a filesize of the list
    //!\param list index
    [[nodiscard]] uint64_t GetFilesize(int32_t index) const;

    //! Is index a dir or a file
    //!\param list index
    [[nodiscard]] BOOL IsDir(int32_t index) const {
        if (!valid(index)) return false;
        return FileInfo[index].isDir;
    };

    //! Get the filecount of the whole list
    [[nodiscard]] int32_t GetFilecount() const {
        return FileInfo.size();
    };

    //! Sort list by filepath
    void SortList();

    //! Custom sort command for custom sort functions definitions
    void SortList(BOOL (*SortFunc)(const DirEntry &a, const DirEntry &b));

    //! Get the index of the specified filename
    int32_t GetFileIndex(const char *filename) const;

    //! Enum for search/filter flags
    enum {
        Files           = 0x01,
        Dirs            = 0x02,
        CheckSubfolders = 0x08,
    };

protected:
    // Internal parser
    BOOL InternalLoadPath(std::string &path);

    //!Add a list entrie
    void AddEntrie(const std::string &filepath, const char *filename, BOOL isDir);

    //! Clear the list
    void ClearList();

    //! Check if valid pos is requested
    [[nodiscard]] inline BOOL valid(uint32_t pos) const {
        return (pos < FileInfo.size());
    };

    uint32_t Flags{};
    uint32_t Depth{};
    const char *Filter{};
    std::vector<DirEntry> FileInfo;
};