mirror of
https://github.com/godotengine/godot.git
synced 2024-12-27 11:24:59 +08:00
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".
167 lines
6.6 KiB
C++
167 lines
6.6 KiB
C++
/**************************************************************************/
|
|
/* dir_access.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 DIR_ACCESS_H
|
|
#define DIR_ACCESS_H
|
|
|
|
#include "core/object/ref_counted.h"
|
|
#include "core/string/ustring.h"
|
|
#include "core/typedefs.h"
|
|
|
|
//@ TODO, excellent candidate for THREAD_SAFE MACRO, should go through all these and add THREAD_SAFE where it applies
|
|
class DirAccess : public RefCounted {
|
|
GDCLASS(DirAccess, RefCounted);
|
|
|
|
public:
|
|
enum AccessType {
|
|
ACCESS_RESOURCES,
|
|
ACCESS_USERDATA,
|
|
ACCESS_FILESYSTEM,
|
|
ACCESS_MAX
|
|
};
|
|
|
|
typedef Ref<DirAccess> (*CreateFunc)();
|
|
|
|
private:
|
|
AccessType _access_type = ACCESS_FILESYSTEM;
|
|
static CreateFunc create_func[ACCESS_MAX]; ///< set this to instance a filesystem object
|
|
static Ref<DirAccess> _open(const String &p_path);
|
|
|
|
Error _copy_dir(Ref<DirAccess> &p_target_da, String p_to, int p_chmod_flags, bool p_copy_links);
|
|
PackedStringArray _get_contents(bool p_directories);
|
|
|
|
thread_local static Error last_dir_open_error;
|
|
bool include_navigational = false;
|
|
bool include_hidden = false;
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
|
|
String _get_root_path() const;
|
|
virtual String _get_root_string() const;
|
|
|
|
AccessType get_access_type() const;
|
|
String fix_path(String p_path) const;
|
|
|
|
template <class T>
|
|
static Ref<DirAccess> _create_builtin() {
|
|
return memnew(T);
|
|
}
|
|
|
|
public:
|
|
virtual Error list_dir_begin() = 0; ///< This starts dir listing
|
|
virtual String get_next() = 0;
|
|
virtual bool current_is_dir() const = 0;
|
|
virtual bool current_is_hidden() const = 0;
|
|
|
|
virtual void list_dir_end() = 0; ///<
|
|
|
|
virtual int get_drive_count() = 0;
|
|
virtual String get_drive(int p_drive) = 0;
|
|
virtual int get_current_drive();
|
|
virtual bool drives_are_shortcuts();
|
|
|
|
virtual Error change_dir(String p_dir) = 0; ///< can be relative or absolute, return false on success
|
|
virtual String get_current_dir(bool p_include_drive = true) const = 0; ///< return current dir location
|
|
virtual Error make_dir(String p_dir) = 0;
|
|
virtual Error make_dir_recursive(String p_dir);
|
|
virtual Error erase_contents_recursive(); //super dangerous, use with care!
|
|
|
|
virtual bool file_exists(String p_file) = 0;
|
|
virtual bool dir_exists(String p_dir) = 0;
|
|
virtual bool is_readable(String p_dir) { return true; };
|
|
virtual bool is_writable(String p_dir) { return true; };
|
|
static bool exists(String p_dir);
|
|
virtual uint64_t get_space_left() = 0;
|
|
|
|
Error copy_dir(String p_from, String p_to, int p_chmod_flags = -1, bool p_copy_links = false);
|
|
virtual Error copy(String p_from, String p_to, int p_chmod_flags = -1);
|
|
virtual Error rename(String p_from, String p_to) = 0;
|
|
virtual Error remove(String p_name) = 0;
|
|
|
|
virtual bool is_link(String p_file) = 0;
|
|
virtual String read_link(String p_file) = 0;
|
|
virtual Error create_link(String p_source, String p_target) = 0;
|
|
|
|
// Meant for editor code when we want to quickly remove a file without custom
|
|
// handling (e.g. removing a cache file).
|
|
static void remove_file_or_error(String p_path) {
|
|
Ref<DirAccess> da = create(ACCESS_FILESYSTEM);
|
|
if (da->file_exists(p_path)) {
|
|
if (da->remove(p_path) != OK) {
|
|
ERR_FAIL_MSG("Cannot remove file or directory: " + p_path);
|
|
}
|
|
} else {
|
|
ERR_FAIL_MSG("Cannot remove non-existent file or directory: " + p_path);
|
|
}
|
|
}
|
|
|
|
virtual String get_filesystem_type() const = 0;
|
|
static String get_full_path(const String &p_path, AccessType p_access);
|
|
static Ref<DirAccess> create_for_path(const String &p_path);
|
|
|
|
static Ref<DirAccess> create(AccessType p_access);
|
|
static Error get_open_error();
|
|
|
|
template <class T>
|
|
static void make_default(AccessType p_access) {
|
|
create_func[p_access] = _create_builtin<T>;
|
|
}
|
|
|
|
static Ref<DirAccess> open(const String &p_path, Error *r_error = nullptr);
|
|
|
|
static int _get_drive_count();
|
|
static String get_drive_name(int p_idx);
|
|
|
|
static Error make_dir_absolute(const String &p_dir);
|
|
static Error make_dir_recursive_absolute(const String &p_dir);
|
|
static bool dir_exists_absolute(const String &p_dir);
|
|
|
|
static Error copy_absolute(const String &p_from, const String &p_to, int p_chmod_flags = -1);
|
|
static Error rename_absolute(const String &p_from, const String &p_to);
|
|
static Error remove_absolute(const String &p_path);
|
|
|
|
PackedStringArray get_files();
|
|
static PackedStringArray get_files_at(const String &p_path);
|
|
PackedStringArray get_directories();
|
|
static PackedStringArray get_directories_at(const String &p_path);
|
|
String _get_next();
|
|
|
|
void set_include_navigational(bool p_enable);
|
|
bool get_include_navigational() const;
|
|
void set_include_hidden(bool p_enable);
|
|
bool get_include_hidden() const;
|
|
|
|
DirAccess() {}
|
|
virtual ~DirAccess() {}
|
|
};
|
|
|
|
#endif // DIR_ACCESS_H
|