1/**************************************************************************/
2/* file_access_memory.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef FILE_ACCESS_MEMORY_H
32#define FILE_ACCESS_MEMORY_H
33
34#include "core/io/file_access.h"
35
36class FileAccessMemory : public FileAccess {
37 uint8_t *data = nullptr;
38 uint64_t length = 0;
39 mutable uint64_t pos = 0;
40
41 static Ref<FileAccess> create();
42
43public:
44 static void register_file(String p_name, Vector<uint8_t> p_data);
45 static void cleanup();
46
47 virtual Error open_custom(const uint8_t *p_data, uint64_t p_len); ///< open a file
48 virtual Error open_internal(const String &p_path, int p_mode_flags) override; ///< open a file
49 virtual bool is_open() const override; ///< true when file is open
50
51 virtual void seek(uint64_t p_position) override; ///< seek to a given position
52 virtual void seek_end(int64_t p_position) override; ///< seek from the end of file
53 virtual uint64_t get_position() const override; ///< get position in the file
54 virtual uint64_t get_length() const override; ///< get size of the file
55
56 virtual bool eof_reached() const override; ///< reading passed EOF
57
58 virtual uint8_t get_8() const override; ///< get a byte
59
60 virtual uint64_t get_buffer(uint8_t *p_dst, uint64_t p_length) const override; ///< get an array of bytes
61
62 virtual Error get_error() const override; ///< get last error
63
64 virtual void flush() override;
65 virtual void store_8(uint8_t p_byte) override; ///< store a byte
66 virtual void store_buffer(const uint8_t *p_src, uint64_t p_length) override; ///< store an array of bytes
67
68 virtual bool file_exists(const String &p_name) override; ///< return true if a file exists
69
70 virtual uint64_t _get_modified_time(const String &p_file) override { return 0; }
71 virtual BitField<FileAccess::UnixPermissionFlags> _get_unix_permissions(const String &p_file) override { return 0; }
72 virtual Error _set_unix_permissions(const String &p_file, BitField<FileAccess::UnixPermissionFlags> p_permissions) override { return FAILED; }
73
74 virtual bool _get_hidden_attribute(const String &p_file) override { return false; }
75 virtual Error _set_hidden_attribute(const String &p_file, bool p_hidden) override { return ERR_UNAVAILABLE; }
76 virtual bool _get_read_only_attribute(const String &p_file) override { return false; }
77 virtual Error _set_read_only_attribute(const String &p_file, bool p_ro) override { return ERR_UNAVAILABLE; }
78
79 virtual void close() override {}
80
81 FileAccessMemory() {}
82};
83
84#endif // FILE_ACCESS_MEMORY_H
85