openrw/rwlib/source/platform/FileIndex.hpp

#ifndef _LIBRW_FILEINDEX_HPP_
#define _LIBRW_FILEINDEX_HPP_

#include <algorithm>
#include <cctype>
#include <map>
#include <string>
#include <unordered_map>

#include <rw/filesystem.hpp>
#include <rw/forward.hpp>

class FileIndex {
private:
    /**
     * Mapping type (lower case name) => (on disk name)
     */
    using FileSystemMap = std::unordered_map<rwfs::path, rwfs::path>;

    rwfs::path gamedatapath_;
    FileSystemMap filesystemfiles_;

public:
    /**
     * @brief indexDirectory finds the true case for each file in the tree
     * @param base_path
     *
     * This is used to build the mapping of lower-case file paths to the
     * true case on the file system for platforms where this is an issue.
     *
     */
    void indexGameDirectory(const rwfs::path& base_path);

    /**
     * @brief findFilePath finds disk path for a game data file
     * @param path
     * @return The file path as it exists on disk
     */
    rwfs::path findFilePath(std::string path) {
        auto backslash = std::string::npos;
        while ((backslash = path.find("\\")) != std::string::npos) {
            path.replace(backslash, 1, "/");
        }
        auto realpath = gamedatapath_ / path;
        std::string name = realpath.string();
        std::transform(name.begin(), name.end(), name.begin(), ::tolower);

        return filesystemfiles_[name];
    }

    /**
     * @brief openFilePath opens a file on the disk
     * @param file_path
     * @return A handle for the file on the disk
     */
    FileHandle openFilePath(const std::string& file_path);

    struct IndexData {
        /// Lowercase identifying filename
        std::string filename;
        /// Original filename
        std::string originalName;
        /// Containing directory
        std::string directory;
        /// The archive filename (if applicable)
        std::string archive;
    };

    /**
     * Adds the files contained within the given directory tree to the
     * file index.
     */
    void indexTree(const rwfs::path& root);

    /**
     * Adds the files contained within the given Archive file to the
     * file index.
     */
    void indexArchive(const std::string& archive);

    /**
     * Returns a FileHandle for the file if it can be found in the
     * file index, otherwise an empty FileHandle is returned.
     */
    FileHandle openFile(const std::string& filename);

private:
    std::map<std::string, IndexData> files;
};

#endif