mirror of
https://gitea.wildfiregames.com/0ad/0ad.git
synced 2026-07-09 17:37:09 +00:00
Ykkrosh
0d172264f8
Fix terrain manager to understand .cached.dds files. Fix IArchiveWriter so you can pass it absolute paths of files to load, and different relative paths for storing inside the archive. Fix fs_util::ForEachFile when called on the VFS root. This was SVN commit r8130.
100 lines
3.5 KiB
C++
100 lines
3.5 KiB
C++
/* Copyright (c) 2010 Wildfire Games
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included
|
|
* in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
/*
|
|
* interface for reading from and creating archives.
|
|
*/
|
|
|
|
#ifndef INCLUDED_ARCHIVE
|
|
#define INCLUDED_ARCHIVE
|
|
|
|
#include "lib/file/file_system.h" // FileInfo
|
|
#include "lib/file/common/file_loader.h"
|
|
#include "lib/file/vfs/vfs_path.h"
|
|
|
|
// rationale: this module doesn't build a directory tree of the entries
|
|
// within an archive. that task is left to the VFS; here, we are only
|
|
// concerned with enumerating all archive entries.
|
|
|
|
namespace ERR
|
|
{
|
|
const LibError ARCHIVE_UNKNOWN_FORMAT = -110400;
|
|
const LibError ARCHIVE_UNKNOWN_METHOD = -110401;
|
|
}
|
|
|
|
struct IArchiveFile : public IFileLoader
|
|
{
|
|
};
|
|
|
|
typedef shared_ptr<IArchiveFile> PIArchiveFile;
|
|
|
|
struct IArchiveReader
|
|
{
|
|
virtual ~IArchiveReader();
|
|
|
|
/**
|
|
* called for each archive entry.
|
|
* @param pathname full pathname of entry; only valid during the callback.
|
|
**/
|
|
typedef void (*ArchiveEntryCallback)(const VfsPath& pathname, const FileInfo& fileInfo, PIArchiveFile archiveFile, uintptr_t cbData);
|
|
virtual LibError ReadEntries(ArchiveEntryCallback cb, uintptr_t cbData) = 0;
|
|
};
|
|
|
|
typedef shared_ptr<IArchiveReader> PIArchiveReader;
|
|
|
|
// note: when creating an archive, any existing file with the given pathname
|
|
// will be overwritten.
|
|
|
|
// rationale: don't support partial adding, i.e. updating archive with
|
|
// only one file. this would require overwriting parts of the Zip archive,
|
|
// which is annoying and slow. also, archives are usually built in
|
|
// seek-optimal order, which would break if we start inserting files.
|
|
// while testing, loose files can be used, so there's no loss.
|
|
|
|
struct IArchiveWriter
|
|
{
|
|
/**
|
|
* write out the archive to disk; only hereafter is it valid.
|
|
**/
|
|
virtual ~IArchiveWriter();
|
|
|
|
/**
|
|
* add a file to the archive.
|
|
*
|
|
* rationale: passing in a filename instead of the compressed file
|
|
* contents makes for better encapsulation because callers don't need
|
|
* to know about the codec. one disadvantage is that loading the file
|
|
* contents can no longer take advantage of the VFS cache nor previously
|
|
* archived versions. however, the archive builder usually adds files
|
|
* precisely because they aren't in archives, and the cache would
|
|
* thrash anyway, so this is deemed acceptable.
|
|
*
|
|
* @param sourcepathname the path to the source file on the filesystem
|
|
* @param pathname the path to use for the file inside the archive
|
|
**/
|
|
virtual LibError AddFile(const fs::wpath& sourcepathname, const fs::wpath& pathame) = 0;
|
|
};
|
|
|
|
typedef shared_ptr<IArchiveWriter> PIArchiveWriter;
|
|
|
|
#endif // #ifndef INCLUDED_ARCHIVE
|