mirror of
https://github.com/vcmi/vcmi.git
synced 2024-12-16 10:19:47 +02:00
49 lines
1.1 KiB
C
49 lines
1.1 KiB
C
|
|
||
|
|
/*
|
||
|
|
* ISimpleResourceLoader.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 "CInputStream.h"
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A class which knows the files containing in the archive or system and how to load them.
|
||
|
|
*/
|
||
|
|
class DLL_LINKAGE ISimpleResourceLoader
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
/**
|
||
|
|
* Dtor.
|
||
|
|
*/
|
||
|
|
virtual ~ISimpleResourceLoader() { };
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Loads a resource with the given resource name.
|
||
|
|
*
|
||
|
|
* @param resourceName The unqiue resource name in space of the archive.
|
||
|
|
* @return a input stream object
|
||
|
|
*/
|
||
|
|
virtual std::unique_ptr<CInputStream> load(const std::string & resourceName) const =0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks if the entry exists.
|
||
|
|
*
|
||
|
|
* @return Returns true if the entry exists, false if not.
|
||
|
|
*/
|
||
|
|
virtual bool existsEntry(const std::string & resourceName) const =0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets all entries in the archive or (file) system.
|
||
|
|
*
|
||
|
|
* @return Returns a list of all entries in the archive or (file) system.
|
||
|
|
*/
|
||
|
|
virtual std::list<std::string> getEntries() const =0;
|
||
|
|
};
|