1/**************************************************************************/
2/* file_access_unix.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_UNIX_H
32#define FILE_ACCESS_UNIX_H
33
34#include "core/io/file_access.h"
35#include "core/os/memory.h"
36
37#include <stdio.h>
38
39#if defined(UNIX_ENABLED)
40
41typedef void (*CloseNotificationFunc)(const String &p_file, int p_flags);
42
43class FileAccessUnix : public FileAccess {
44 FILE *f = nullptr;
45 int flags = 0;
46 void check_errors() const;
47 mutable Error last_error = OK;
48 String save_path;
49 String path;
50 String path_src;
51
52 void _close();
53
54public:
55 static CloseNotificationFunc close_notification_func;
56
57 virtual Error open_internal(const String &p_path, int p_mode_flags) override; ///< open a file
58 virtual bool is_open() const override; ///< true when file is open
59
60 virtual String get_path() const override; /// returns the path for the current open file
61 virtual String get_path_absolute() const override; /// returns the absolute path for the current open file
62
63 virtual void seek(uint64_t p_position) override; ///< seek to a given position
64 virtual void seek_end(int64_t p_position = 0) override; ///< seek from the end of file
65 virtual uint64_t get_position() const override; ///< get position in the file
66 virtual uint64_t get_length() const override; ///< get size of the file
67
68 virtual bool eof_reached() const override; ///< reading passed EOF
69
70 virtual uint8_t get_8() const override; ///< get a byte
71 virtual uint64_t get_buffer(uint8_t *p_dst, uint64_t p_length) const override;
72
73 virtual Error get_error() const override; ///< get last error
74
75 virtual void flush() override;
76 virtual void store_8(uint8_t p_dest) override; ///< store a byte
77 virtual void store_buffer(const uint8_t *p_src, uint64_t p_length) override; ///< store an array of bytes
78
79 virtual bool file_exists(const String &p_path) override; ///< return true if a file exists
80
81 virtual uint64_t _get_modified_time(const String &p_file) override;
82 virtual BitField<FileAccess::UnixPermissionFlags> _get_unix_permissions(const String &p_file) override;
83 virtual Error _set_unix_permissions(const String &p_file, BitField<FileAccess::UnixPermissionFlags> p_permissions) override;
84
85 virtual bool _get_hidden_attribute(const String &p_file) override;
86 virtual Error _set_hidden_attribute(const String &p_file, bool p_hidden) override;
87 virtual bool _get_read_only_attribute(const String &p_file) override;
88 virtual Error _set_read_only_attribute(const String &p_file, bool p_ro) override;
89
90 virtual void close() override;
91
92 FileAccessUnix() {}
93 virtual ~FileAccessUnix();
94};
95
96#endif // UNIX_ENABLED
97
98#endif // FILE_ACCESS_UNIX_H
99