mirror of
https://github.com/ZDoom/Raze.git
synced 2024-12-12 05:32:14 +00:00
226 lines
5.9 KiB
C++
226 lines
5.9 KiB
C++
|
|
|
|
#ifndef __RESFILE_H
|
|
#define __RESFILE_H
|
|
|
|
#include <limits.h>
|
|
|
|
#include "files.h"
|
|
#include "zstring.h"
|
|
|
|
struct LumpFilterInfo
|
|
{
|
|
TArray<FString> gameTypeFilter; // this can contain multiple entries
|
|
FString dotFilter;
|
|
|
|
// The following are for checking if the root directory of a zip can be removed.
|
|
TArray<FString> reservedFolders;
|
|
TArray<FString> requiredPrefixes;
|
|
TArray<FString> embeddings;
|
|
std::function<void()> postprocessFunc;
|
|
};
|
|
|
|
class FResourceFile;
|
|
|
|
// [RH] Namespaces from BOOM.
|
|
// These are needed here in the low level part so that WAD files can be properly set up.
|
|
typedef enum {
|
|
ns_hidden = -1,
|
|
|
|
ns_global = 0,
|
|
ns_sprites,
|
|
ns_flats,
|
|
ns_colormaps,
|
|
ns_acslibrary,
|
|
ns_newtextures,
|
|
ns_bloodraw, // no longer used - kept for ZScript.
|
|
ns_bloodsfx, // no longer used - kept for ZScript.
|
|
ns_bloodmisc, // no longer used - kept for ZScript.
|
|
ns_strifevoices,
|
|
ns_hires,
|
|
ns_voxels,
|
|
|
|
// These namespaces are only used to mark lumps in special subdirectories
|
|
// so that their contents doesn't interfere with the global namespace.
|
|
// searching for data in these namespaces works differently for lumps coming
|
|
// from Zips or other files.
|
|
ns_specialzipdirectory,
|
|
ns_sounds,
|
|
ns_patches,
|
|
ns_graphics,
|
|
ns_music,
|
|
|
|
ns_firstskin,
|
|
} namespace_t;
|
|
|
|
enum ELumpFlags
|
|
{
|
|
LUMPF_MAYBEFLAT = 1, // might be a flat outside F_START/END
|
|
LUMPF_FULLPATH = 2, // contains a full path. This will trigger extended namespace checks when looking up short names.
|
|
LUMPF_EMBEDDED = 4, // marks an embedded resource file for later processing.
|
|
LUMPF_SHORTNAME = 8, // the stored name is a short extension-less name
|
|
LUMPF_COMPRESSED = 16, // compressed or encrypted, i.e. cannot be read with the container file's reader.
|
|
};
|
|
|
|
// This holds a compresed Zip entry with all needed info to decompress it.
|
|
struct FCompressedBuffer
|
|
{
|
|
unsigned mSize;
|
|
unsigned mCompressedSize;
|
|
int mMethod;
|
|
int mZipFlags;
|
|
unsigned mCRC32;
|
|
char *mBuffer;
|
|
|
|
bool Decompress(char *destbuffer);
|
|
void Clean()
|
|
{
|
|
mSize = mCompressedSize = 0;
|
|
if (mBuffer != nullptr)
|
|
{
|
|
delete[] mBuffer;
|
|
mBuffer = nullptr;
|
|
}
|
|
}
|
|
};
|
|
|
|
struct FResourceLump
|
|
{
|
|
friend class FResourceFile;
|
|
friend class FWadFile; // this still needs direct access.
|
|
|
|
int LumpSize;
|
|
int RefCount;
|
|
protected:
|
|
FString FullName;
|
|
public:
|
|
uint8_t Flags;
|
|
char * Cache;
|
|
FResourceFile * Owner;
|
|
|
|
FResourceLump()
|
|
{
|
|
Cache = NULL;
|
|
Owner = NULL;
|
|
Flags = 0;
|
|
RefCount = 0;
|
|
}
|
|
|
|
virtual ~FResourceLump();
|
|
virtual FileReader *GetReader();
|
|
virtual FileReader NewReader();
|
|
virtual int GetFileOffset() { return -1; }
|
|
virtual int GetIndexNum() const { return -1; }
|
|
virtual int GetNamespace() const { return 0; }
|
|
void LumpNameSetup(FString iname);
|
|
void CheckEmbedded(LumpFilterInfo* lfi);
|
|
virtual FCompressedBuffer GetRawData();
|
|
|
|
void *Lock(); // validates the cache and increases the refcount.
|
|
int Unlock(); // decreases the refcount and frees the buffer
|
|
|
|
unsigned Size() const{ return LumpSize; }
|
|
int LockCount() const { return RefCount; }
|
|
const char* getName() { return FullName.GetChars(); }
|
|
|
|
protected:
|
|
virtual int FillCache() { return -1; }
|
|
|
|
};
|
|
|
|
class FResourceFile
|
|
{
|
|
public:
|
|
FileReader Reader;
|
|
FString FileName;
|
|
protected:
|
|
uint32_t NumLumps;
|
|
FString Hash;
|
|
|
|
FResourceFile(const char *filename);
|
|
FResourceFile(const char *filename, FileReader &r);
|
|
|
|
// for archives that can contain directories
|
|
void GenerateHash();
|
|
void PostProcessArchive(void *lumps, size_t lumpsize, LumpFilterInfo *filter);
|
|
|
|
private:
|
|
uint32_t FirstLump;
|
|
|
|
int FilterLumps(FString filtername, void *lumps, size_t lumpsize, uint32_t max);
|
|
int FilterLumpsByGameType(LumpFilterInfo *filter, void *lumps, size_t lumpsize, uint32_t max);
|
|
bool FindPrefixRange(FString filter, void *lumps, size_t lumpsize, uint32_t max, uint32_t &start, uint32_t &end);
|
|
void JunkLeftoverFilters(void *lumps, size_t lumpsize, uint32_t max);
|
|
static FResourceFile *DoOpenResourceFile(const char *filename, FileReader &file, bool quiet, bool containeronly, LumpFilterInfo* filter);
|
|
|
|
public:
|
|
static FResourceFile *OpenResourceFile(const char *filename, FileReader &file, bool quiet = false, bool containeronly = false, LumpFilterInfo* filter = nullptr);
|
|
static FResourceFile *OpenResourceFile(const char *filename, bool quiet = false, bool containeronly = false, LumpFilterInfo* filter = nullptr);
|
|
static FResourceFile *OpenDirectory(const char *filename, bool quiet = false, LumpFilterInfo* filter = nullptr);
|
|
virtual ~FResourceFile();
|
|
// If this FResourceFile represents a directory, the Reader object is not usable so don't return it.
|
|
FileReader *GetReader() { return Reader.isOpen()? &Reader : nullptr; }
|
|
uint32_t LumpCount() const { return NumLumps; }
|
|
uint32_t GetFirstEntry() const { return FirstLump; }
|
|
void SetFirstLump(uint32_t f) { FirstLump = f; }
|
|
const FString &GetHash() const { return Hash; }
|
|
|
|
|
|
virtual FResourceLump *GetLump(int no) = 0;
|
|
FResourceLump *FindLump(const char *name);
|
|
};
|
|
|
|
struct FUncompressedLump : public FResourceLump
|
|
{
|
|
int Position;
|
|
|
|
virtual FileReader *GetReader();
|
|
virtual int FillCache();
|
|
virtual int GetFileOffset() { return Position; }
|
|
|
|
};
|
|
|
|
|
|
// Base class for uncompressed resource files (WAD, GRP, PAK and single lumps)
|
|
class FUncompressedFile : public FResourceFile
|
|
{
|
|
protected:
|
|
TArray<FUncompressedLump> Lumps;
|
|
|
|
FUncompressedFile(const char *filename);
|
|
FUncompressedFile(const char *filename, FileReader &r);
|
|
virtual FResourceLump *GetLump(int no) { return ((unsigned)no < NumLumps)? &Lumps[no] : NULL; }
|
|
};
|
|
|
|
|
|
struct FExternalLump : public FResourceLump
|
|
{
|
|
FString Filename;
|
|
|
|
FExternalLump(const char *_filename, int filesize = -1);
|
|
virtual int FillCache();
|
|
|
|
};
|
|
|
|
struct FMemoryLump : public FResourceLump
|
|
{
|
|
FMemoryLump(const void* data, int length)
|
|
{
|
|
RefCount = INT_MAX / 2;
|
|
LumpSize = length;
|
|
Cache = new char[length];
|
|
memcpy(Cache, data, length);
|
|
}
|
|
|
|
virtual int FillCache() override
|
|
{
|
|
RefCount = INT_MAX / 2; // Make sure it never counts down to 0 by resetting it to something high each time it is used.
|
|
return 1;
|
|
}
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
#endif
|