mirror of
https://github.com/vcmi/vcmi.git
synced 2025-03-21 21:17:49 +02:00
65 lines
2.2 KiB
C++
65 lines
2.2 KiB
C++
|
|
/*
|
|
* CFilesystemLoader.h, part of VCMI engine
|
|
*
|
|
* Authors: listed in file AUTHORS in main folder
|
|
*
|
|
* License: GNU General Public License v2.0 or later
|
|
* Full text of license available in license.txt file, in main folder
|
|
*
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "ISimpleResourceLoader.h"
|
|
#include "CResourceLoader.h"
|
|
|
|
class CFileInfo;
|
|
class CInputStream;
|
|
|
|
/**
|
|
* A class which can scan and load files of directories.
|
|
*/
|
|
class DLL_LINKAGE CFilesystemLoader : public ISimpleResourceLoader
|
|
{
|
|
public:
|
|
/**
|
|
* Ctor.
|
|
*
|
|
* @param baseDirectory Specifies the base directory and their sub-directories which should be indexed.
|
|
* @param depth - recursion depth of subdirectories search. 0 = no recursion
|
|
*
|
|
* @throws std::runtime_error if the base directory is not a directory or if it is not available
|
|
*/
|
|
explicit CFilesystemLoader(const std::string & baseDirectory, size_t depth = 16, bool initial = false);
|
|
|
|
/// Interface implementation
|
|
/// @see ISimpleResourceLoader
|
|
std::unique_ptr<CInputStream> load(const std::string & resourceName) const override;
|
|
bool existsEntry(const std::string & resourceName) const override;
|
|
boost::unordered_map<ResourceID, std::string> getEntries() const override;
|
|
std::string getOrigin() const override;
|
|
bool createEntry(std::string filename, bool update) override;
|
|
|
|
private:
|
|
/** The base directory which is scanned and indexed. */
|
|
std::string baseDirectory;
|
|
|
|
/** A list of files in the directory
|
|
* key = ResourceID for resource loader
|
|
* value = name that can be used to access file
|
|
*/
|
|
boost::unordered_map<ResourceID, std::string> fileList;
|
|
|
|
/**
|
|
* Returns a list of pathnames denoting the files in the directory denoted by this pathname.
|
|
*
|
|
* If the pathname of this directory is absolute, then the file info pathnames are absolute as well. If the pathname of this directory is relative
|
|
* then the file info pathnames are relative to the basedir as well.
|
|
*
|
|
* @return a list of pathnames denoting the files and directories in the directory denoted by this pathname
|
|
* The array will be empty if the directory is empty. Ptr is null if the directory doesn't exist or if it isn't a directory.
|
|
*/
|
|
boost::unordered_map<ResourceID, std::string> listFiles(size_t depth, bool initial) const;
|
|
};
|