9e328bb5b7
File handling APIs are typically considered part of I/O, and we did have most `FileAccess` implementations in `core/io` already.
100 lines
4.3 KiB
C++
100 lines
4.3 KiB
C++
/*************************************************************************/
|
|
/* file_access_compressed.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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_COMPRESSED_H
|
|
#define FILE_ACCESS_COMPRESSED_H
|
|
|
|
#include "core/io/compression.h"
|
|
#include "core/io/file_access.h"
|
|
|
|
class FileAccessCompressed : public FileAccess {
|
|
Compression::Mode cmode = Compression::MODE_ZSTD;
|
|
bool writing = false;
|
|
uint64_t write_pos = 0;
|
|
uint8_t *write_ptr = nullptr;
|
|
uint32_t write_buffer_size = 0;
|
|
uint64_t write_max = 0;
|
|
uint32_t block_size = 0;
|
|
mutable bool read_eof = false;
|
|
mutable bool at_end = false;
|
|
|
|
struct ReadBlock {
|
|
uint32_t csize;
|
|
uint64_t offset;
|
|
};
|
|
|
|
mutable Vector<uint8_t> comp_buffer;
|
|
uint8_t *read_ptr = nullptr;
|
|
mutable uint32_t read_block = 0;
|
|
uint32_t read_block_count = 0;
|
|
mutable uint32_t read_block_size = 0;
|
|
mutable uint64_t read_pos = 0;
|
|
Vector<ReadBlock> read_blocks;
|
|
uint64_t read_total = 0;
|
|
|
|
String magic = "GCMP";
|
|
mutable Vector<uint8_t> buffer;
|
|
FileAccess *f = nullptr;
|
|
|
|
public:
|
|
void configure(const String &p_magic, Compression::Mode p_mode = Compression::MODE_ZSTD, uint32_t p_block_size = 4096);
|
|
|
|
Error open_after_magic(FileAccess *p_base);
|
|
|
|
virtual Error _open(const String &p_path, int p_mode_flags); ///< open a file
|
|
virtual void close(); ///< close a file
|
|
virtual bool is_open() const; ///< true when file is open
|
|
|
|
virtual void seek(uint64_t p_position); ///< seek to a given position
|
|
virtual void seek_end(int64_t p_position = 0); ///< seek from the end of file
|
|
virtual uint64_t get_position() const; ///< get position in the file
|
|
virtual uint64_t get_length() const; ///< get size of the file
|
|
|
|
virtual bool eof_reached() const; ///< reading passed EOF
|
|
|
|
virtual uint8_t get_8() const; ///< get a byte
|
|
virtual uint64_t get_buffer(uint8_t *p_dst, uint64_t p_length) const;
|
|
|
|
virtual Error get_error() const; ///< get last error
|
|
|
|
virtual void flush();
|
|
virtual void store_8(uint8_t p_dest); ///< store a byte
|
|
|
|
virtual bool file_exists(const String &p_name); ///< return true if a file exists
|
|
|
|
virtual uint64_t _get_modified_time(const String &p_file);
|
|
virtual uint32_t _get_unix_permissions(const String &p_file);
|
|
virtual Error _set_unix_permissions(const String &p_file, uint32_t p_permissions);
|
|
|
|
FileAccessCompressed() {}
|
|
virtual ~FileAccessCompressed();
|
|
};
|
|
|
|
#endif // FILE_ACCESS_COMPRESSED_H
|