irrlicht/source/Irrlicht/CZipReader.h

265 lines
7.4 KiB
C++

// Copyright (C) 2002-2009 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h
#ifndef __C_ZIP_READER_H_INCLUDED__
#define __C_ZIP_READER_H_INCLUDED__
#include "IReferenceCounted.h"
#include "IReadFile.h"
#include "irrArray.h"
#include "irrString.h"
#include "IFileSystem.h"
#include "IFileList.h"
namespace irr
{
namespace io
{
// set if the file is encrypted
const s16 ZIP_FILE_ENCRYPTED = 0x0001;
// the fields crc-32, compressed size and uncompressed size are set to
// zero in the local header
const s16 ZIP_INFO_IN_DATA_DESCRITOR = 0x0008;
#if defined(_MSC_VER) || defined(__BORLANDC__) || defined (__BCPLUSPLUS__)
# pragma pack( push, packing )
# pragma pack( 1 )
# define PACK_STRUCT
#elif defined( __GNUC__ )
# define PACK_STRUCT __attribute__((packed))
#else
# error compiler not supported
#endif
struct SZIPFileDataDescriptor
{
u32 CRC32;
u32 CompressedSize;
u32 UncompressedSize;
} PACK_STRUCT;
struct SZIPFileHeader
{
u32 Sig; // 'PK0304' little endian (0x04034b50)
s16 VersionToExtract;
s16 GeneralBitFlag;
s16 CompressionMethod;
s16 LastModFileTime;
s16 LastModFileDate;
SZIPFileDataDescriptor DataDescriptor;
s16 FilenameLength;
s16 ExtraFieldLength;
// filename (variable size)
// extra field (variable size )
} PACK_STRUCT;
struct SZIPFileCentralDirFileHeader
{
u32 central_file_header_signature; // 'PK0102' (0x02014b50)
u16 version_made_by;
u16 version_needed_to_extract;
u16 general_purpose_bit_flag;
u16 compression_method;
u16 last_mod_file_time;
u16 last_mod_file_date;
u32 crc_32;
u32 compressed_size;
u32 uncompressed_size;
u16 filename_length;
u16 extra_field_length;
u16 file_comment_length;
u16 disk_number_start;
u16 internal_file_attributes;
u32 external_file_attributes;
u32 relative_offset_of_local_header;
// filename (variable size)
// extra field (variable size)
// file comment (variable size)
} PACK_STRUCT;
struct SZIPFileCentralDirEnd
{
u32 sig; // 'PK0506' end_of central dir signature // (0x06054b50)
u16 numberDisk; // number of this disk
u16 numberStart; // number of the disk with the start of the central directory
u16 totalDisk; // total number of entries in the central dir on this disk
u16 totalEntries; // total number of entries in the central dir
u32 size; // size of the central directory
u32 offset; // offset of start of centraldirectory with respect to the starting disk number
u16 comment_length; // zipfile comment length
// zipfile comment (variable size)
} PACK_STRUCT;
// Default alignment
#if defined(_MSC_VER) || defined(__BORLANDC__) || defined (__BCPLUSPLUS__)
# pragma pack( pop, packing )
#endif
#undef PACK_STRUCT
struct SZipFileEntry : public IFileArchiveEntry
{
SZipFileEntry () {}
core::string<c16> zipFileName;
s32 fileDataPosition; // position of compressed data in file
SZIPFileHeader header;
};
//! Archiveloader capable of loading ZIP Archives
class CArchiveLoaderZIP : public IArchiveLoader
{
public:
//! Constructor
CArchiveLoaderZIP(io::IFileSystem* fs);
//! destructor
virtual ~CArchiveLoaderZIP();
//! returns true if the file maybe is able to be loaded by this class
//! based on the file extension (e.g. ".zip")
virtual bool isALoadableFileFormat(const core::string<c16>& filename) const;
//! Creates an archive from the filename
/** \param file File handle to check.
\return Pointer to newly created archive, or 0 upon error. */
virtual IFileArchive* createArchive(const core::string<c16>& filename, bool ignoreCase, bool ignorePaths) const;
//! Check if the file might be loaded by this class
/** Check might look into the file.
\param file File handle to check.
\return True if file seems to be loadable. */
virtual bool isALoadableFileFormat(io::IReadFile* file) const;
//! creates/loads an archive from the file.
//! \return Pointer to the created archive. Returns 0 if loading failed.
virtual io::IFileArchive* createArchive(io::IReadFile* file, bool ignoreCase, bool ignorePaths) const;
private:
io::IFileSystem* FileSystem;
};
/*!
Zip file Reader written April 2002 by N.Gebhardt.
Doesn't decompress data, only reads the file and is able to
open uncompressed entries.
*/
class CZipReader : public IFileArchive
{
public:
CZipReader(IReadFile* file, bool ignoreCase, bool ignorePaths);
virtual ~CZipReader();
//! opens a file by file name
virtual IReadFile* openFile(const core::string<c16>& filename);
//! opens a file by index
virtual IReadFile* openFile(s32 index);
//! returns count of files in archive
virtual u32 getFileCount();
//! returns data of file
virtual const IFileArchiveEntry* getFileInfo(u32 index);
//! returns fileindex
virtual s32 findFile(const core::string<c16>& filename);
//! return the id of the file Archive
virtual const core::string<c16>& getArchiveName ();
//! get the class Type
virtual const core::string<c16>& getArchiveType() { return Type; }
private:
//! scans for a local header, returns false if there is no more
//! local file header.
bool scanLocalHeader();
bool scanLocalHeader2();
IReadFile* File;
SZipFileEntry temp;
protected:
//! splits filename from zip file into useful filenames and paths
void extractFilename(SZipFileEntry* entry);
bool IgnoreCase;
bool IgnorePaths;
core::array<SZipFileEntry> FileList;
core::string<c16> Type;
core::string<c16> Base;
};
//! Archiveloader capable of loading MountPoint Archives
class CArchiveLoaderMount : public IArchiveLoader
{
public:
//! Constructor
CArchiveLoaderMount(io::IFileSystem* fs);
//! destructor
virtual ~CArchiveLoaderMount();
//! returns true if the file maybe is able to be loaded by this class
//! based on the file extension (e.g. ".zip")
virtual bool isALoadableFileFormat(const core::string<c16>& filename) const;
//! Creates an archive from the filename
/** \param file File handle to check.
\return Pointer to newly created archive, or 0 upon error. */
virtual IFileArchive* createArchive(const core::string<c16>& filename, bool ignoreCase, bool ignorePaths) const;
//! Check if the file might be loaded by this class
/** Check might look into the file.
\param file File handle to check.
\return True if file seems to be loadable. */
virtual bool isALoadableFileFormat(io::IReadFile* file) const;
//! creates/loads an archive from the file.
//! \return Pointer to the created archive. Returns 0 if loading failed.
virtual IFileArchive* createArchive(io::IReadFile* file, bool ignoreCase, bool ignorePaths) const;
private:
io::IFileSystem* FileSystem;
};
//! A File Archive whichs uses a a mountpoint
class CMountPointReader : public CZipReader
{
public:
CMountPointReader(IFileSystem *parent, const core::string<c16>& basename,
bool ignoreCase, bool ignorePaths);
//! opens a file by file name
virtual IReadFile* openFile(const core::string<c16>& filename);
//! returns fileindex
virtual s32 findFile(const core::string<c16>& filename);
private:
IFileSystem *Parent;
void buildDirectory ();
};
} // end namespace io
} // end namespace irr
#endif