scummvm/engines/kyra/resource.h
Johannes Schickel acb4bda9df - Added support for filename length > 64 in static resource code.
- Updated warning when 'INDEX' is not found
- Added filesize check for 'INDEX' file

svn-id: r31368
2008-04-03 19:56:45 +00:00

341 lines
7.7 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
*/
#ifndef KYRA_RESOURCE_H
#define KYRA_RESOURCE_H
#include "common/scummsys.h"
#include "common/str.h"
#include "common/file.h"
#include "common/list.h"
#include "common/hash-str.h"
#include "common/hashmap.h"
#include "common/stream.h"
#include "common/ptr.h"
#include "kyra/kyra.h"
namespace Kyra {
struct ResFileEntry {
Common::String parent;
uint32 size;
bool preload;
bool mounted;
bool prot;
enum kType {
kRaw = 0,
kPak = 1,
kIns = 2,
kAutoDetect
};
kType type;
uint32 offset;
};
typedef Common::HashMap<Common::String, ResFileEntry, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> ResFileMap;
class Resource;
class ResArchiveLoader {
public:
struct File {
File() : filename(), entry() {}
File(const Common::String &f, const ResFileEntry &e) : filename(f), entry(e) {}
Common::String filename;
ResFileEntry entry;
};
typedef Common::List<File> FileList;
virtual ~ResArchiveLoader() {}
virtual bool checkFilename(Common::String filename) const = 0;
virtual bool isLoadable(const Common::String &filename, Common::SeekableReadStream &stream) const = 0;
virtual bool loadFile(const Common::String &filename, Common::SeekableReadStream &stream, FileList &files) const = 0;
// parameter 'archive' can be deleted by this method and it may not be deleted from the caller
virtual Common::SeekableReadStream *loadFileFromArchive(const Common::String &file, Common::SeekableReadStream *archive, const ResFileEntry entry) const = 0;
virtual ResFileEntry::kType getType() const = 0;
protected:
};
class Resource {
public:
Resource(KyraEngine *vm);
~Resource();
bool reset();
bool addSearchPath(const Common::String &path);
bool loadPakFile(const Common::String &filename);
void unloadPakFile(const Common::String &filename);
bool isInPakList(const Common::String &filename) const;
bool loadFileList(const Common::String &filedata);
bool loadFileList(const char * const *filelist, uint32 numFiles);
// This unloads *all* pakfiles, even kyra.dat and protected ones
void unloadAllPakFiles();
uint32 getFileSize(const char *file) const;
uint8* fileData(const char *file, uint32 *size) const;
Common::SeekableReadStream *getFileStream(const Common::String &file) const;
bool loadFileToBuf(const char *file, void *buf, uint32 maxSize);
protected:
bool isAccessable(const Common::String &file) const;
void detectFileTypes();
void initializeLoaders();
const ResArchiveLoader *getLoader(ResFileEntry::kType type) const;
typedef Common::List<Common::SharedPtr<ResArchiveLoader> > LoaderList;
typedef LoaderList::iterator LoaderIterator;
typedef LoaderList::const_iterator CLoaderIterator;
LoaderList _loaders;
ResFileMap _map;
KyraEngine *_vm;
};
// TODO?: maybe prefix all things here with 'kKyra1' instead of 'k'
enum kKyraResources {
kLoadAll = -1,
kForestSeq,
kKallakWritingSeq,
kKyrandiaLogoSeq,
kKallakMalcolmSeq,
kMalcolmTreeSeq,
kWestwoodLogoSeq,
kDemo1Seq,
kDemo2Seq,
kDemo3Seq,
kDemo4Seq,
kAmuleteAnimSeq,
kOutroReunionSeq,
kIntroCPSStrings,
kIntroCOLStrings,
kIntroWSAStrings,
kIntroStrings,
kOutroHomeString,
kRoomFilenames,
kRoomList,
kCharacterImageFilenames,
kItemNames,
kTakenStrings,
kPlacedStrings,
kDroppedStrings,
kNoDropStrings,
kPutDownString,
kWaitAmuletString,
kBlackJewelString,
kPoisonGoneString,
kHealingTipString,
kWispJewelStrings,
kMagicJewelStrings,
kThePoisonStrings,
kFluteStrings,
kFlaskFullString,
kFullFlaskString,
kVeryCleverString,
kNewGameString,
kDefaultShapes,
kHealing1Shapes,
kHealing2Shapes,
kPoisonDeathShapes,
kFluteShapes,
kWinter1Shapes,
kWinter2Shapes,
kWinter3Shapes,
kDrinkShapes,
kWispShapes,
kMagicAnimShapes,
kBranStoneShapes,
kPaletteList,
kGUIStrings,
kConfigStrings,
kAudioTracks,
kAudioTracksIntro,
kKyra1TownsSFXwdTable,
kKyra1TownsSFXbtTable,
kKyra1TownsCDATable,
kCreditsStrings,
k2SeqplayPakFiles,
k2SeqplayCredits,
k2SeqplayCreditsSpecial,
k2SeqplayStrings,
k2SeqplaySfxFiles,
k2SeqplayTlkFiles,
k2SeqplaySeqData,
k2SeqplayIntroTracks,
k2SeqplayFinaleTracks,
k2SeqplayIntroCDA,
k2SeqplayFinaleCDA,
k2SeqplayShapeDefs,
k2IngamePakFiles,
k2IngameSfxFiles,
k2IngameSfxIndex,
k2IngameTracks,
k2IngameCDA,
k2IngameTalkObjIndex,
k2IngameTimJpStrings,
k2IngameItemAnimTable,
kMaxResIDs
};
struct Shape;
struct Room;
class StaticResource {
public:
static const Common::String staticDataFilename() { return "kyra.dat"; }
StaticResource(KyraEngine *vm) : _vm(vm), _resList(), _fileLoader(0), _builtIn(0), _filenameTable(0) {}
~StaticResource() { deinit(); }
static bool checkKyraDat();
bool init();
void deinit();
const char * const*loadStrings(int id, int &strings);
const uint8 *loadRawData(int id, int &size);
const Shape *loadShapeTable(int id, int &entries);
const Room *loadRoomTable(int id, int &entries);
const uint8 * const*loadPaletteTable(int id, int &entries);
// use '-1' to prefetch/unload all ids
// prefetchId retruns false if only on of the resources
// can't be loaded and it breaks then the first res
// can't be loaded
bool prefetchId(int id);
void unloadId(int id);
private:
KyraEngine *_vm;
struct FilenameTable;
struct ResData;
struct FileType;
bool checkResList(int id, int &type, const void *&ptr, int &size);
const void *checkForBuiltin(int id, int &type, int &size);
const FilenameTable *searchFile(int id);
const FileType *getFiletype(int type);
const void *getData(int id, int requesttype, int &size);
bool loadLanguageTable(const char *filename, void *&ptr, int &size);
bool loadStringTable(const char *filename, void *&ptr, int &size);
bool loadRawData(const char *filename, void *&ptr, int &size);
bool loadShapeTable(const char *filename, void *&ptr, int &size);
bool loadRoomTable(const char *filename, void *&ptr, int &size);
bool loadPaletteTable(const char *filename, void *&ptr, int &size);
void freeRawData(void *&ptr, int &size);
void freeStringTable(void *&ptr, int &size);
void freeShapeTable(void *&ptr, int &size);
void freeRoomTable(void *&ptr, int &size);
void freePaletteTable(void *&ptr, int &size);
const char *getFilename(const char *name);
uint8 *getFile(const char *name, int &size);
enum kResTypes {
kLanguageList,
kStringList,
kRoomList,
kShapeList,
kRawData,
kPaletteTable,
k2SeqData
};
struct BuiltinRes {
int id;
int type;
int size;
const void *data;
};
struct FilenameTable {
int id;
int type;
const char *filename;
};
struct FileType {
int type;
typedef bool (StaticResource::*LoadFunc)(const char *filename, void *&ptr, int &size);
typedef void (StaticResource::*FreeFunc)(void *&ptr, int &size);
LoadFunc load;
FreeFunc free;
};
struct ResData {
int id;
int type;
int size;
void *data;
};
Common::List<ResData> _resList;
const FileType *_fileLoader;
const BuiltinRes *_builtIn;
const FilenameTable *_filenameTable;
};
} // end of namespace Kyra
#endif