godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/editor/editor_vcs_interface.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

184 lines
6.9 KiB
C++
Raw Normal View History

One Copyright Update to rule them all 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".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* editor_vcs_interface.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. */
/**************************************************************************/
Add copyright headers to vcs integration
2019-09-04 11:17:26 +00:00
Add an overridable VCS Interface for the editor The VCS interface can be thought of like a proxy system, where any call to the API is redirected to the actual implementation of the VCS API which may be existing in the form of a GDNative plugin which is marked as a singleton and is not marked reloadable. If the implementation doesn't exist in the file system, it only returns the default responses which contain mostly empty containers of the data type that every API call returns. EditorVCSInterface is used like a Godot object with a script attached to it. The script is the implementation of the API and the object is the interface to the script, which returns default responses if the script doesn't exist or if the script doesn't define a function that handles that particular API call. The entire system has been implemented using Object::call() and its ability to switch to the script instance to handle the API call if the script exists. Look for VersionControlEditorPlugin::_initialize() for the essential API setup.
2019-09-03 14:31:14 +00:00
#ifndef EDITOR_VCS_INTERFACE_H
#define EDITOR_VCS_INTERFACE_H
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-07 22:33:38 +00:00
#include "core/object/class_db.h"
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
#include "core/object/gdvirtual.gen.inc"
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-07 22:33:38 +00:00
#include "core/string/ustring.h"
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
#include "core/variant/type_info.h"
Extract ScriptInstance to simplify includes This allows to include script_instance.h directly in the generated gdvirtual.gen.inc, and remove excessive includes from the codebase. This should also allow Resource to use GDVIRTUAL macros, which wasn't possible previously due to a circular dependency.
2023-09-06 19:02:52 +00:00
#include "core/variant/typed_array.h"
Add an overridable VCS Interface for the editor The VCS interface can be thought of like a proxy system, where any call to the API is redirected to the actual implementation of the VCS API which may be existing in the form of a GDNative plugin which is marked as a singleton and is not marked reloadable. If the implementation doesn't exist in the file system, it only returns the default responses which contain mostly empty containers of the data type that every API call returns. EditorVCSInterface is used like a Godot object with a script attached to it. The script is the implementation of the API and the object is the interface to the script, which returns default responses if the script doesn't exist or if the script doesn't define a function that handles that particular API call. The entire system has been implemented using Object::call() and its ability to switch to the script instance to handle the API call if the script exists. Look for VersionControlEditorPlugin::_initialize() for the essential API setup.
2019-09-03 14:31:14 +00:00
class EditorVCSInterface : public Object {
GDCLASS(EditorVCSInterface, Object)
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
public:
enum ChangeType {
CHANGE_TYPE_NEW = 0,
CHANGE_TYPE_MODIFIED = 1,
CHANGE_TYPE_RENAMED = 2,
CHANGE_TYPE_DELETED = 3,
CHANGE_TYPE_TYPECHANGE = 4,
CHANGE_TYPE_UNMERGED = 5
};
enum TreeArea {
TREE_AREA_COMMIT = 0,
TREE_AREA_STAGED = 1,
TREE_AREA_UNSTAGED = 2
};
struct DiffLine {
int new_line_no;
int old_line_no;
String content;
String status;
String old_text;
String new_text;
};
struct DiffHunk {
int new_start;
int old_start;
int new_lines;
int old_lines;
List<DiffLine> diff_lines;
};
struct DiffFile {
String new_file;
String old_file;
List<DiffHunk> diff_hunks;
};
struct Commit {
String author;
String msg;
String id;
int64_t unix_timestamp;
int64_t offset_minutes;
};
struct StatusFile {
TreeArea area;
ChangeType change_type;
String file_path;
};
Add an overridable VCS Interface for the editor The VCS interface can be thought of like a proxy system, where any call to the API is redirected to the actual implementation of the VCS API which may be existing in the form of a GDNative plugin which is marked as a singleton and is not marked reloadable. If the implementation doesn't exist in the file system, it only returns the default responses which contain mostly empty containers of the data type that every API call returns. EditorVCSInterface is used like a Godot object with a script attached to it. The script is the implementation of the API and the object is the interface to the script, which returns default responses if the script doesn't exist or if the script doesn't define a function that handles that particular API call. The entire system has been implemented using Object::call() and its ability to switch to the script instance to handle the API call if the script exists. Look for VersionControlEditorPlugin::_initialize() for the essential API setup.
2019-09-03 14:31:14 +00:00
protected:
static EditorVCSInterface *singleton;
static void _bind_methods();
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
DiffLine _convert_diff_line(Dictionary p_diff_line);
DiffHunk _convert_diff_hunk(Dictionary p_diff_hunk);
DiffFile _convert_diff_file(Dictionary p_diff_file);
Commit _convert_commit(Dictionary p_commit);
StatusFile _convert_status_file(Dictionary p_status_file);
// Proxy endpoints for extensions to implement
GDVIRTUAL1R(bool, _initialize, String);
GDVIRTUAL5(_set_credentials, String, String, String, String, String);
Change Array arguments to TypedArray
2022-08-31 17:24:04 +00:00
GDVIRTUAL0R(TypedArray<Dictionary>, _get_modified_files_data);
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
GDVIRTUAL1(_stage_file, String);
GDVIRTUAL1(_unstage_file, String);
GDVIRTUAL1(_discard_file, String);
GDVIRTUAL1(_commit, String);
GDVIRTUAL2R(TypedArray<Dictionary>, _get_diff, String, int);
GDVIRTUAL0R(bool, _shut_down);
GDVIRTUAL0R(String, _get_vcs_name);
Change Array arguments to TypedArray
2022-08-31 17:24:04 +00:00
GDVIRTUAL1R(TypedArray<Dictionary>, _get_previous_commits, int);
VCS: Fix GDExtension return types for VCS after Array type hardening
2022-12-20 10:06:14 +00:00
GDVIRTUAL0R(TypedArray<String>, _get_branch_list);
GDVIRTUAL0R(TypedArray<String>, _get_remotes);
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
GDVIRTUAL1(_create_branch, String);
GDVIRTUAL1(_remove_branch, String);
GDVIRTUAL2(_create_remote, String, String);
GDVIRTUAL1(_remove_remote, String);
GDVIRTUAL0R(String, _get_current_branch_name);
GDVIRTUAL1R(bool, _checkout_branch, String);
GDVIRTUAL1(_pull, String);
GDVIRTUAL2(_push, String, bool);
GDVIRTUAL1(_fetch, String);
Change Array arguments to TypedArray
2022-08-31 17:24:04 +00:00
GDVIRTUAL2R(TypedArray<Dictionary>, _get_line_diff, String, String);
Add an overridable VCS Interface for the editor The VCS interface can be thought of like a proxy system, where any call to the API is redirected to the actual implementation of the VCS API which may be existing in the form of a GDNative plugin which is marked as a singleton and is not marked reloadable. If the implementation doesn't exist in the file system, it only returns the default responses which contain mostly empty containers of the data type that every API call returns. EditorVCSInterface is used like a Godot object with a script attached to it. The script is the implementation of the API and the object is the interface to the script, which returns default responses if the script doesn't exist or if the script doesn't define a function that handles that particular API call. The entire system has been implemented using Object::call() and its ability to switch to the script instance to handle the API call if the script exists. Look for VersionControlEditorPlugin::_initialize() for the essential API setup.
2019-09-03 14:31:14 +00:00
public:
static EditorVCSInterface *get_singleton();
static void set_singleton(EditorVCSInterface *p_singleton);
Allow creating .gitignore and .gitattributes when creating a new project Also allow creating these files later, and also allow disabling creating the default environment in editor settings.
2020-09-29 19:01:26 +00:00
enum class VCSMetadata {
NONE,
GIT,
};
static void create_vcs_metadata_files(VCSMetadata p_vcs_metadata_type, String &p_dir);
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
// Proxies to the editor for use
bool initialize(String p_project_path);
void set_credentials(String p_username, String p_password, String p_ssh_public_key_path, String p_ssh_private_key_path, String p_ssh_passphrase);
List<StatusFile> get_modified_files_data();
Add an overridable VCS Interface for the editor The VCS interface can be thought of like a proxy system, where any call to the API is redirected to the actual implementation of the VCS API which may be existing in the form of a GDNative plugin which is marked as a singleton and is not marked reloadable. If the implementation doesn't exist in the file system, it only returns the default responses which contain mostly empty containers of the data type that every API call returns. EditorVCSInterface is used like a Godot object with a script attached to it. The script is the implementation of the API and the object is the interface to the script, which returns default responses if the script doesn't exist or if the script doesn't define a function that handles that particular API call. The entire system has been implemented using Object::call() and its ability to switch to the script instance to handle the API call if the script exists. Look for VersionControlEditorPlugin::_initialize() for the essential API setup.
2019-09-03 14:31:14 +00:00
void stage_file(String p_file_path);
void unstage_file(String p_file_path);
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
void discard_file(String p_file_path);
Add an overridable VCS Interface for the editor The VCS interface can be thought of like a proxy system, where any call to the API is redirected to the actual implementation of the VCS API which may be existing in the form of a GDNative plugin which is marked as a singleton and is not marked reloadable. If the implementation doesn't exist in the file system, it only returns the default responses which contain mostly empty containers of the data type that every API call returns. EditorVCSInterface is used like a Godot object with a script attached to it. The script is the implementation of the API and the object is the interface to the script, which returns default responses if the script doesn't exist or if the script doesn't define a function that handles that particular API call. The entire system has been implemented using Object::call() and its ability to switch to the script instance to handle the API call if the script exists. Look for VersionControlEditorPlugin::_initialize() for the essential API setup.
2019-09-03 14:31:14 +00:00
void commit(String p_msg);
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
List<DiffFile> get_diff(String p_identifier, TreeArea p_area);
Add an overridable VCS Interface for the editor The VCS interface can be thought of like a proxy system, where any call to the API is redirected to the actual implementation of the VCS API which may be existing in the form of a GDNative plugin which is marked as a singleton and is not marked reloadable. If the implementation doesn't exist in the file system, it only returns the default responses which contain mostly empty containers of the data type that every API call returns. EditorVCSInterface is used like a Godot object with a script attached to it. The script is the implementation of the API and the object is the interface to the script, which returns default responses if the script doesn't exist or if the script doesn't define a function that handles that particular API call. The entire system has been implemented using Object::call() and its ability to switch to the script instance to handle the API call if the script exists. Look for VersionControlEditorPlugin::_initialize() for the essential API setup.
2019-09-03 14:31:14 +00:00
bool shut_down();
String get_vcs_name();
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
List<Commit> get_previous_commits(int p_max_commits);
List<String> get_branch_list();
List<String> get_remotes();
void create_branch(String p_branch_name);
void remove_branch(String p_branch_name);
void create_remote(String p_remote_name, String p_remote_url);
void remove_remote(String p_remote_name);
String get_current_branch_name();
bool checkout_branch(String p_branch_name);
void pull(String p_remote);
void push(String p_remote, bool p_force);
void fetch(String p_remote);
List<DiffHunk> get_line_diff(String p_file_path, String p_text);
Add an overridable VCS Interface for the editor The VCS interface can be thought of like a proxy system, where any call to the API is redirected to the actual implementation of the VCS API which may be existing in the form of a GDNative plugin which is marked as a singleton and is not marked reloadable. If the implementation doesn't exist in the file system, it only returns the default responses which contain mostly empty containers of the data type that every API call returns. EditorVCSInterface is used like a Godot object with a script attached to it. The script is the implementation of the API and the object is the interface to the script, which returns default responses if the script doesn't exist or if the script doesn't define a function that handles that particular API call. The entire system has been implemented using Object::call() and its ability to switch to the script instance to handle the API call if the script exists. Look for VersionControlEditorPlugin::_initialize() for the essential API setup.
2019-09-03 14:31:14 +00:00
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
// Helper functions to create and convert Dictionary into data structures
Dictionary create_diff_line(int p_new_line_no, int p_old_line_no, String p_content, String p_status);
Dictionary create_diff_hunk(int p_old_start, int p_new_start, int p_old_lines, int p_new_lines);
Dictionary create_diff_file(String p_new_file, String p_old_file);
Dictionary create_commit(String p_msg, String p_author, String p_id, int64_t p_unix_timestamp, int64_t p_offset_minutes);
Dictionary create_status_file(String p_file_path, ChangeType p_change, TreeArea p_area);
Change Array arguments to TypedArray
2022-08-31 17:24:04 +00:00
Dictionary add_line_diffs_into_diff_hunk(Dictionary p_diff_hunk, TypedArray<Dictionary> p_line_diffs);
Dictionary add_diff_hunks_into_diff_file(Dictionary p_diff_file, TypedArray<Dictionary> p_diff_hunks);
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
void popup_error(String p_msg);
Add an overridable VCS Interface for the editor The VCS interface can be thought of like a proxy system, where any call to the API is redirected to the actual implementation of the VCS API which may be existing in the form of a GDNative plugin which is marked as a singleton and is not marked reloadable. If the implementation doesn't exist in the file system, it only returns the default responses which contain mostly empty containers of the data type that every API call returns. EditorVCSInterface is used like a Godot object with a script attached to it. The script is the implementation of the API and the object is the interface to the script, which returns default responses if the script doesn't exist or if the script doesn't define a function that handles that particular API call. The entire system has been implemented using Object::call() and its ability to switch to the script instance to handle the API call if the script exists. Look for VersionControlEditorPlugin::_initialize() for the essential API setup.
2019-09-03 14:31:14 +00:00
};
VCS: Port Godot 3.5's VCS features to GDExtension
2022-06-13 18:47:40 +00:00
VARIANT_ENUM_CAST(EditorVCSInterface::ChangeType);
VARIANT_ENUM_CAST(EditorVCSInterface::TreeArea);
VCS: Improve VCS UI/UX by QoL changes The editor will now use the project path i.e. the place where the root of the repo is supposed to be according to the user. This project path is also sent into the plugin and so out-of-directory asset folders can also be maintained this way.
2022-08-09 21:56:19 +00:00
#endif // EDITOR_VCS_INTERFACE_H