1/**************************************************************************/
2/* dir_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 DIR_ACCESS_UNIX_H
32#define DIR_ACCESS_UNIX_H
33
34#if defined(UNIX_ENABLED)
35
36#include "core/io/dir_access.h"
37
38#include <dirent.h>
39#include <sys/stat.h>
40#include <sys/types.h>
41#include <unistd.h>
42
43class DirAccessUnix : public DirAccess {
44 DIR *dir_stream = nullptr;
45
46 bool _cisdir = false;
47 bool _cishidden = false;
48
49protected:
50 String current_dir;
51 virtual String fix_unicode_name(const char *p_name) const { return String::utf8(p_name); }
52 virtual bool is_hidden(const String &p_name);
53
54public:
55 virtual Error list_dir_begin() override; ///< This starts dir listing
56 virtual String get_next() override;
57 virtual bool current_is_dir() const override;
58 virtual bool current_is_hidden() const override;
59
60 virtual void list_dir_end() override; ///<
61
62 virtual int get_drive_count() override;
63 virtual String get_drive(int p_drive) override;
64 virtual int get_current_drive() override;
65 virtual bool drives_are_shortcuts() override;
66
67 virtual Error change_dir(String p_dir) override; ///< can be relative or absolute, return false on success
68 virtual String get_current_dir(bool p_include_drive = true) const override; ///< return current dir location
69 virtual Error make_dir(String p_dir) override;
70
71 virtual bool file_exists(String p_file) override;
72 virtual bool dir_exists(String p_dir) override;
73 virtual bool is_readable(String p_dir) override;
74 virtual bool is_writable(String p_dir) override;
75
76 virtual uint64_t get_modified_time(String p_file);
77
78 virtual Error rename(String p_path, String p_new_path) override;
79 virtual Error remove(String p_path) override;
80
81 virtual bool is_link(String p_file) override;
82 virtual String read_link(String p_file) override;
83 virtual Error create_link(String p_source, String p_target) override;
84
85 virtual uint64_t get_space_left() override;
86
87 virtual String get_filesystem_type() const override;
88
89 DirAccessUnix();
90 ~DirAccessUnix();
91};
92
93#endif // UNIX_ENABLED
94
95#endif // DIR_ACCESS_UNIX_H
96