openmw/components/files/collections.hpp

#ifndef COMPONENTS_FILES_COLLECTION_HPP
#define COMPONENTS_FILES_COLLECTION_HPP

#include <filesystem>

#include "multidircollection.hpp"

namespace Files
{
    class Collections
    {
        public:
            Collections();

            ///< Directories are listed with increasing priority.
            Collections(const Files::PathContainer& directories, bool foldCase);

            ///< Return a file collection for the given extension. Extension must contain the
            /// leading dot and must be all lower-case.
            const MultiDirCollection& getCollection(const std::string& extension) const;

            std::filesystem::path getPath(const std::string& file) const; //TODO(Project579): let's hope unicode characters are never used in these filenames on windows or this will break
            ///< Return full path (including filename) of \a file.
            ///
            /// If the file does not exist in any of the collection's
            /// directories, an exception is thrown. \a file must include the
            /// extension.

            bool doesExist(const std::string& file) const; //TODO(Project579): let's hope unicode characters are never used in these filenames on windows or this will break
            ///< \return Does a file with the given name exist?

            const Files::PathContainer& getPaths() const;

        private:
            typedef std::map<std::string, MultiDirCollection> MultiDirCollectionContainer;
            Files::PathContainer mDirectories;

            bool mFoldCase;
            mutable MultiDirCollectionContainer mCollections;
    };
}

#endif