d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
118 lines
4.6 KiB
C++
118 lines
4.6 KiB
C++
/**************************************************************************/
|
|
/* file_access_zip.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef FILE_ACCESS_ZIP_H
|
|
#define FILE_ACCESS_ZIP_H
|
|
|
|
#ifdef MINIZIP_ENABLED
|
|
|
|
#include "core/io/file_access_pack.h"
|
|
#include "core/templates/rb_map.h"
|
|
|
|
#include "thirdparty/minizip/unzip.h"
|
|
|
|
#include <stdlib.h>
|
|
|
|
class ZipArchive : public PackSource {
|
|
public:
|
|
struct File {
|
|
int package = -1;
|
|
unz_file_pos file_pos;
|
|
File() {}
|
|
};
|
|
|
|
private:
|
|
struct Package {
|
|
String filename;
|
|
unzFile zfile = nullptr;
|
|
};
|
|
Vector<Package> packages;
|
|
|
|
HashMap<String, File> files;
|
|
|
|
static ZipArchive *instance;
|
|
|
|
public:
|
|
void close_handle(unzFile p_file) const;
|
|
unzFile get_file_handle(String p_file) const;
|
|
|
|
Error add_package(String p_name);
|
|
|
|
bool file_exists(String p_name) const;
|
|
|
|
virtual bool try_open_pack(const String &p_path, bool p_replace_files, uint64_t p_offset) override;
|
|
Ref<FileAccess> get_file(const String &p_path, PackedData::PackedFile *p_file) override;
|
|
|
|
static ZipArchive *get_singleton();
|
|
|
|
ZipArchive();
|
|
~ZipArchive();
|
|
};
|
|
|
|
class FileAccessZip : public FileAccess {
|
|
unzFile zfile = nullptr;
|
|
unz_file_info64 file_info;
|
|
|
|
mutable bool at_eof = false;
|
|
|
|
void _close();
|
|
|
|
public:
|
|
virtual Error open_internal(const String &p_path, int p_mode_flags) override; ///< open a file
|
|
virtual bool is_open() const override; ///< true when file is open
|
|
|
|
virtual void seek(uint64_t p_position) override; ///< seek to a given position
|
|
virtual void seek_end(int64_t p_position = 0) override; ///< seek from the end of file
|
|
virtual uint64_t get_position() const override; ///< get position in the file
|
|
virtual uint64_t get_length() const override; ///< get size of the file
|
|
|
|
virtual bool eof_reached() const override; ///< reading passed EOF
|
|
|
|
virtual uint8_t get_8() const override; ///< get a byte
|
|
virtual uint64_t get_buffer(uint8_t *p_dst, uint64_t p_length) const override;
|
|
|
|
virtual Error get_error() const override; ///< get last error
|
|
|
|
virtual void flush() override;
|
|
virtual void store_8(uint8_t p_dest) override; ///< store a byte
|
|
|
|
virtual bool file_exists(const String &p_name) override; ///< return true if a file exists
|
|
|
|
virtual uint64_t _get_modified_time(const String &p_file) override { return 0; } // todo
|
|
virtual uint32_t _get_unix_permissions(const String &p_file) override { return 0; }
|
|
virtual Error _set_unix_permissions(const String &p_file, uint32_t p_permissions) override { return FAILED; }
|
|
|
|
FileAccessZip(const String &p_path, const PackedData::PackedFile &p_file);
|
|
~FileAccessZip();
|
|
};
|
|
|
|
#endif // MINIZIP_ENABLED
|
|
|
|
#endif // FILE_ACCESS_ZIP_H
|