Merge pull request #62157 from ChronicallySerious/front-port-vcs-plugin

VCS: Port Godot 3.5's VCS features to GDExtension

1 files changed, 312 insertions, 73 deletions

diff --git a/editor/editor_vcs_interface.cpp b/editor/editor_vcs_interface.cpp
index 53cc8d5b22..0c6c876b2f 100644
--- a/editor/editor_vcs_interface.cpp
+++ b/editor/editor_vcs_interface.cpp
@@ -30,132 +30,371 @@
 
 #include "editor_vcs_interface.h"
 
+#include "editor_node.h"
+
+#define UNIMPLEMENTED() ERR_PRINT(vformat("Unimplemented virtual function in EditorVCSInterface based plugin: %s", __func__))
+
 EditorVCSInterface *EditorVCSInterface::singleton = nullptr;
 
-void EditorVCSInterface::_bind_methods() {
-	// Proxy end points that act as fallbacks to unavailability of a function in the VCS addon
-	ClassDB::bind_method(D_METHOD("_initialize", "project_root_path"), &EditorVCSInterface::_initialize);
-	ClassDB::bind_method(D_METHOD("_is_vcs_initialized"), &EditorVCSInterface::_is_vcs_initialized);
-	ClassDB::bind_method(D_METHOD("_get_vcs_name"), &EditorVCSInterface::_get_vcs_name);
-	ClassDB::bind_method(D_METHOD("_shut_down"), &EditorVCSInterface::_shut_down);
-	ClassDB::bind_method(D_METHOD("_get_project_name"), &EditorVCSInterface::_get_project_name);
-	ClassDB::bind_method(D_METHOD("_get_modified_files_data"), &EditorVCSInterface::_get_modified_files_data);
-	ClassDB::bind_method(D_METHOD("_commit", "msg"), &EditorVCSInterface::_commit);
-	ClassDB::bind_method(D_METHOD("_get_file_diff", "file_path"), &EditorVCSInterface::_get_file_diff);
-	ClassDB::bind_method(D_METHOD("_stage_file", "file_path"), &EditorVCSInterface::_stage_file);
-	ClassDB::bind_method(D_METHOD("_unstage_file", "file_path"), &EditorVCSInterface::_unstage_file);
+void EditorVCSInterface::popup_error(String p_msg) {
+	// TRANSLATORS: %s refers to the name of a version control system (e.g. "Git").
+	EditorNode::get_singleton()->show_warning(p_msg.strip_edges(), vformat(TTR("%s Error"), get_vcs_name()));
+}
 
-	ClassDB::bind_method(D_METHOD("is_addon_ready"), &EditorVCSInterface::is_addon_ready);
+bool EditorVCSInterface::initialize(String p_project_path) {
+	bool result = false;
+	if (!GDVIRTUAL_CALL(_initialize, p_project_path, result)) {
+		UNIMPLEMENTED();
+		return false;
+	}
+	return result;
+}
 
-	// API methods that redirect calls to the proxy end points
-	ClassDB::bind_method(D_METHOD("initialize", "project_root_path"), &EditorVCSInterface::initialize);
-	ClassDB::bind_method(D_METHOD("is_vcs_initialized"), &EditorVCSInterface::is_vcs_initialized);
-	ClassDB::bind_method(D_METHOD("get_modified_files_data"), &EditorVCSInterface::get_modified_files_data);
-	ClassDB::bind_method(D_METHOD("stage_file", "file_path"), &EditorVCSInterface::stage_file);
-	ClassDB::bind_method(D_METHOD("unstage_file", "file_path"), &EditorVCSInterface::unstage_file);
-	ClassDB::bind_method(D_METHOD("commit", "msg"), &EditorVCSInterface::commit);
-	ClassDB::bind_method(D_METHOD("get_file_diff", "file_path"), &EditorVCSInterface::get_file_diff);
-	ClassDB::bind_method(D_METHOD("shut_down"), &EditorVCSInterface::shut_down);
-	ClassDB::bind_method(D_METHOD("get_project_name"), &EditorVCSInterface::get_project_name);
-	ClassDB::bind_method(D_METHOD("get_vcs_name"), &EditorVCSInterface::get_vcs_name);
+void EditorVCSInterface::set_credentials(String p_username, String p_password, String p_ssh_public_key, String p_ssh_private_key, String p_ssh_passphrase) {
+	if (!GDVIRTUAL_CALL(_set_credentials, p_username, p_password, p_ssh_public_key, p_ssh_private_key, p_ssh_passphrase)) {
+		UNIMPLEMENTED();
+	}
 }
 
-bool EditorVCSInterface::_initialize(String p_project_root_path) {
-	WARN_PRINT("Selected VCS addon does not implement an initialization function. This warning will be suppressed.");
-	return true;
+List<String> EditorVCSInterface::get_remotes() {
+	Array result;
+	if (!GDVIRTUAL_CALL(_get_remotes, result)) {
+		UNIMPLEMENTED();
+		return {};
+	}
+
+	List<String> remotes;
+	for (int i = 0; i < result.size(); i++) {
+		remotes.push_back(result[i]);
+	}
+	return remotes;
 }
 
-bool EditorVCSInterface::_is_vcs_initialized() {
-	return false;
+List<EditorVCSInterface::StatusFile> EditorVCSInterface::get_modified_files_data() {
+	Array result;
+	if (!GDVIRTUAL_CALL(_get_modified_files_data, result)) {
+		UNIMPLEMENTED();
+		return {};
+	}
+
+	List<EditorVCSInterface::StatusFile> status_files;
+	for (int i = 0; i < result.size(); i++) {
+		status_files.push_back(_convert_status_file(result[i]));
+	}
+	return status_files;
 }
 
-Dictionary EditorVCSInterface::_get_modified_files_data() {
-	return Dictionary();
+void EditorVCSInterface::stage_file(String p_file_path) {
+	if (!GDVIRTUAL_CALL(_stage_file, p_file_path)) {
+		UNIMPLEMENTED();
+	}
 }
 
-void EditorVCSInterface::_stage_file(String p_file_path) {
+void EditorVCSInterface::unstage_file(String p_file_path) {
+	if (!GDVIRTUAL_CALL(_unstage_file, p_file_path)) {
+		UNIMPLEMENTED();
+	}
 }
 
-void EditorVCSInterface::_unstage_file(String p_file_path) {
+void EditorVCSInterface::discard_file(String p_file_path) {
+	if (!GDVIRTUAL_CALL(_discard_file, p_file_path)) {
+		UNIMPLEMENTED();
+	}
 }
 
-void EditorVCSInterface::_commit(String p_msg) {
+void EditorVCSInterface::commit(String p_msg) {
+	if (!GDVIRTUAL_CALL(_commit, p_msg)) {
+		UNIMPLEMENTED();
+	}
 }
 
-TypedArray<Dictionary> EditorVCSInterface::_get_file_diff(String p_file_path) {
-	return TypedArray<Dictionary>();
+List<EditorVCSInterface::DiffFile> EditorVCSInterface::get_diff(String p_identifier, TreeArea p_area) {
+	TypedArray<Dictionary> result;
+	if (!GDVIRTUAL_CALL(_get_diff, p_identifier, int(p_area), result)) {
+		UNIMPLEMENTED();
+		return {};
+	}
+
+	List<DiffFile> diff_files;
+	for (int i = 0; i < result.size(); i++) {
+		diff_files.push_back(_convert_diff_file(result[i]));
+	}
+	return diff_files;
 }
 
-bool EditorVCSInterface::_shut_down() {
-	return false;
+List<EditorVCSInterface::Commit> EditorVCSInterface::get_previous_commits(int p_max_commits) {
+	Array result;
+	if (!GDVIRTUAL_CALL(_get_previous_commits, p_max_commits, result)) {
+		UNIMPLEMENTED();
+		return {};
+	}
+
+	List<EditorVCSInterface::Commit> commits;
+	for (int i = 0; i < result.size(); i++) {
+		commits.push_back(_convert_commit(result[i]));
+	}
+	return commits;
 }
 
-String EditorVCSInterface::_get_project_name() {
-	return String();
+List<String> EditorVCSInterface::get_branch_list() {
+	Array result;
+	if (!GDVIRTUAL_CALL(_get_branch_list, result)) {
+		UNIMPLEMENTED();
+		return {};
+	}
+
+	List<String> branch_list;
+	for (int i = 0; i < result.size(); i++) {
+		branch_list.push_back(result[i]);
+	}
+	return branch_list;
 }
 
-String EditorVCSInterface::_get_vcs_name() {
-	return "";
+void EditorVCSInterface::create_branch(String p_branch_name) {
+	if (!GDVIRTUAL_CALL(_create_branch, p_branch_name)) {
+		UNIMPLEMENTED();
+	}
 }
 
-bool EditorVCSInterface::initialize(String p_project_root_path) {
-	is_initialized = call("_initialize", p_project_root_path);
-	return is_initialized;
+void EditorVCSInterface::create_remote(String p_remote_name, String p_remote_url) {
+	if (!GDVIRTUAL_CALL(_create_remote, p_remote_name, p_remote_url)) {
+		UNIMPLEMENTED();
+	}
 }
 
-bool EditorVCSInterface::is_vcs_initialized() {
-	return call("_is_vcs_initialized");
+void EditorVCSInterface::remove_branch(String p_branch_name) {
+	if (!GDVIRTUAL_CALL(_remove_branch, p_branch_name)) {
+		UNIMPLEMENTED();
+	}
 }
 
-Dictionary EditorVCSInterface::get_modified_files_data() {
-	return call("_get_modified_files_data");
+void EditorVCSInterface::remove_remote(String p_remote_name) {
+	if (!GDVIRTUAL_CALL(_remove_remote, p_remote_name)) {
+		UNIMPLEMENTED();
+	}
 }
 
-void EditorVCSInterface::stage_file(String p_file_path) {
-	if (is_addon_ready()) {
-		call("_stage_file", p_file_path);
+String EditorVCSInterface::get_current_branch_name() {
+	String result;
+	if (!GDVIRTUAL_CALL(_get_current_branch_name, result)) {
+		UNIMPLEMENTED();
+		return "";
 	}
+	return result;
 }
 
-void EditorVCSInterface::unstage_file(String p_file_path) {
-	if (is_addon_ready()) {
-		call("_unstage_file", p_file_path);
+bool EditorVCSInterface::checkout_branch(String p_branch_name) {
+	bool result = false;
+	if (!GDVIRTUAL_CALL(_checkout_branch, p_branch_name, result)) {
+		UNIMPLEMENTED();
 	}
+	return result;
 }
 
-bool EditorVCSInterface::is_addon_ready() {
-	return is_initialized;
+void EditorVCSInterface::pull(String p_remote) {
+	if (!GDVIRTUAL_CALL(_pull, p_remote)) {
+		UNIMPLEMENTED();
+	}
 }
 
-void EditorVCSInterface::commit(String p_msg) {
-	if (is_addon_ready()) {
-		call("_commit", p_msg);
+void EditorVCSInterface::push(String p_remote, bool p_force) {
+	if (!GDVIRTUAL_CALL(_push, p_remote, p_force)) {
+		UNIMPLEMENTED();
 	}
 }
 
-TypedArray<Dictionary> EditorVCSInterface::get_file_diff(String p_file_path) {
-	if (is_addon_ready()) {
-		return call("_get_file_diff", p_file_path);
+void EditorVCSInterface::fetch(String p_remote) {
+	if (!GDVIRTUAL_CALL(_fetch, p_remote)) {
+		UNIMPLEMENTED();
 	}
-	return TypedArray<Dictionary>();
 }
 
-bool EditorVCSInterface::shut_down() {
-	return call("_shut_down");
+List<EditorVCSInterface::DiffHunk> EditorVCSInterface::get_line_diff(String p_file_path, String p_text) {
+	Array result;
+	if (!GDVIRTUAL_CALL(_get_line_diff, p_file_path, p_text, result)) {
+		UNIMPLEMENTED();
+		return {};
+	}
+
+	List<DiffHunk> diff_hunks;
+	for (int i = 0; i < result.size(); i++) {
+		diff_hunks.push_back(_convert_diff_hunk(result[i]));
+	}
+	return diff_hunks;
 }
 
-String EditorVCSInterface::get_project_name() {
-	return call("_get_project_name");
+bool EditorVCSInterface::shut_down() {
+	bool result = false;
+	if (!GDVIRTUAL_CALL(_shut_down, result)) {
+		UNIMPLEMENTED();
+		return false;
+	}
+	return result;
 }
 
 String EditorVCSInterface::get_vcs_name() {
-	return call("_get_vcs_name");
+	String result;
+	if (!GDVIRTUAL_CALL(_get_vcs_name, result)) {
+		UNIMPLEMENTED();
+		return {};
+	}
+	return result;
+}
+
+Dictionary EditorVCSInterface::create_diff_line(int p_new_line_no, int p_old_line_no, String p_content, String p_status) {
+	Dictionary diff_line;
+	diff_line["new_line_no"] = p_new_line_no;
+	diff_line["old_line_no"] = p_old_line_no;
+	diff_line["content"] = p_content;
+	diff_line["status"] = p_status;
+
+	return diff_line;
+}
+
+Dictionary EditorVCSInterface::create_diff_hunk(int p_old_start, int p_new_start, int p_old_lines, int p_new_lines) {
+	Dictionary diff_hunk;
+	diff_hunk["new_lines"] = p_new_lines;
+	diff_hunk["old_lines"] = p_old_lines;
+	diff_hunk["new_start"] = p_new_start;
+	diff_hunk["old_start"] = p_old_start;
+	diff_hunk["diff_lines"] = Array();
+	return diff_hunk;
+}
+
+Dictionary EditorVCSInterface::add_line_diffs_into_diff_hunk(Dictionary p_diff_hunk, Array p_line_diffs) {
+	p_diff_hunk["diff_lines"] = p_line_diffs;
+	return p_diff_hunk;
+}
+
+Dictionary EditorVCSInterface::create_diff_file(String p_new_file, String p_old_file) {
+	Dictionary file_diff;
+	file_diff["new_file"] = p_new_file;
+	file_diff["old_file"] = p_old_file;
+	file_diff["diff_hunks"] = Array();
+	return file_diff;
+}
+
+Dictionary EditorVCSInterface::create_commit(String p_msg, String p_author, String p_id, int64_t p_unix_timestamp, int64_t p_offset_minutes) {
+	Dictionary commit_info;
+	commit_info["message"] = p_msg;
+	commit_info["author"] = p_author;
+	commit_info["unix_timestamp"] = p_unix_timestamp;
+	commit_info["offset_minutes"] = p_offset_minutes;
+	commit_info["id"] = p_id;
+	return commit_info;
 }
 
-EditorVCSInterface::EditorVCSInterface() {
+Dictionary EditorVCSInterface::add_diff_hunks_into_diff_file(Dictionary p_diff_file, Array p_diff_hunks) {
+	p_diff_file["diff_hunks"] = p_diff_hunks;
+	return p_diff_file;
 }
 
-EditorVCSInterface::~EditorVCSInterface() {
+Dictionary EditorVCSInterface::create_status_file(String p_file_path, ChangeType p_change, TreeArea p_area) {
+	Dictionary sf;
+	sf["file_path"] = p_file_path;
+	sf["change_type"] = p_change;
+	sf["area"] = p_area;
+	return sf;
+}
+
+EditorVCSInterface::DiffLine EditorVCSInterface::_convert_diff_line(Dictionary p_diff_line) {
+	DiffLine d;
+	d.new_line_no = p_diff_line["new_line_no"];
+	d.old_line_no = p_diff_line["old_line_no"];
+	d.content = p_diff_line["content"];
+	d.status = p_diff_line["status"];
+	return d;
+}
+
+EditorVCSInterface::DiffHunk EditorVCSInterface::_convert_diff_hunk(Dictionary p_diff_hunk) {
+	DiffHunk dh;
+	dh.new_lines = p_diff_hunk["new_lines"];
+	dh.old_lines = p_diff_hunk["old_lines"];
+	dh.new_start = p_diff_hunk["new_start"];
+	dh.old_start = p_diff_hunk["old_start"];
+	Array diff_lines = p_diff_hunk["diff_lines"];
+	for (int i = 0; i < diff_lines.size(); i++) {
+		DiffLine dl = _convert_diff_line(diff_lines[i]);
+		dh.diff_lines.push_back(dl);
+	}
+	return dh;
+}
+
+EditorVCSInterface::DiffFile EditorVCSInterface::_convert_diff_file(Dictionary p_diff_file) {
+	DiffFile df;
+	df.new_file = p_diff_file["new_file"];
+	df.old_file = p_diff_file["old_file"];
+	Array diff_hunks = p_diff_file["diff_hunks"];
+	for (int i = 0; i < diff_hunks.size(); i++) {
+		DiffHunk dh = _convert_diff_hunk(diff_hunks[i]);
+		df.diff_hunks.push_back(dh);
+	}
+	return df;
+}
+
+EditorVCSInterface::Commit EditorVCSInterface::_convert_commit(Dictionary p_commit) {
+	EditorVCSInterface::Commit c;
+	c.msg = p_commit["message"];
+	c.author = p_commit["author"];
+	c.unix_timestamp = p_commit["unix_timestamp"];
+	c.offset_minutes = p_commit["offset_minutes"];
+	c.id = p_commit["id"];
+	return c;
+}
+
+EditorVCSInterface::StatusFile EditorVCSInterface::_convert_status_file(Dictionary p_status_file) {
+	StatusFile sf;
+	sf.file_path = p_status_file["file_path"];
+	sf.change_type = (ChangeType)(int)p_status_file["change_type"];
+	sf.area = (TreeArea)(int)p_status_file["area"];
+	return sf;
+}
+
+void EditorVCSInterface::_bind_methods() {
+	// Proxy end points that implement the VCS specific operations that the editor demands.
+	GDVIRTUAL_BIND(_initialize, "project_path");
+	GDVIRTUAL_BIND(_set_credentials, "username", "password", "ssh_public_key_path", "ssh_private_key_path", "ssh_passphrase");
+	GDVIRTUAL_BIND(_get_modified_files_data);
+	GDVIRTUAL_BIND(_stage_file, "file_path");
+	GDVIRTUAL_BIND(_unstage_file, "file_path");
+	GDVIRTUAL_BIND(_discard_file, "file_path");
+	GDVIRTUAL_BIND(_commit, "msg");
+	GDVIRTUAL_BIND(_get_diff, "identifier", "area");
+	GDVIRTUAL_BIND(_shut_down);
+	GDVIRTUAL_BIND(_get_vcs_name);
+	GDVIRTUAL_BIND(_get_previous_commits, "max_commits");
+	GDVIRTUAL_BIND(_get_branch_list);
+	GDVIRTUAL_BIND(_get_remotes);
+	GDVIRTUAL_BIND(_create_branch, "branch_name");
+	GDVIRTUAL_BIND(_remove_branch, "branch_name");
+	GDVIRTUAL_BIND(_create_remote, "remote_name", "remote_url");
+	GDVIRTUAL_BIND(_remove_remote, "remote_name");
+	GDVIRTUAL_BIND(_get_current_branch_name);
+	GDVIRTUAL_BIND(_checkout_branch, "branch_name");
+	GDVIRTUAL_BIND(_pull, "remote");
+	GDVIRTUAL_BIND(_push, "remote", "force");
+	GDVIRTUAL_BIND(_fetch, "remote");
+	GDVIRTUAL_BIND(_get_line_diff, "file_path", "text");
+
+	ClassDB::bind_method(D_METHOD("create_diff_line", "new_line_no", "old_line_no", "content", "status"), &EditorVCSInterface::create_diff_line);
+	ClassDB::bind_method(D_METHOD("create_diff_hunk", "old_start", "new_start", "old_lines", "new_lines"), &EditorVCSInterface::create_diff_hunk);
+	ClassDB::bind_method(D_METHOD("create_diff_file", "new_file", "old_file"), &EditorVCSInterface::create_diff_file);
+	ClassDB::bind_method(D_METHOD("create_commit", "msg", "author", "id", "unix_timestamp", "offset_minutes"), &EditorVCSInterface::create_commit);
+	ClassDB::bind_method(D_METHOD("create_status_file", "file_path", "change_type", "area"), &EditorVCSInterface::create_status_file);
+	ClassDB::bind_method(D_METHOD("add_diff_hunks_into_diff_file", "diff_file", "diff_hunks"), &EditorVCSInterface::add_diff_hunks_into_diff_file);
+	ClassDB::bind_method(D_METHOD("add_line_diffs_into_diff_hunk", "diff_hunk", "line_diffs"), &EditorVCSInterface::add_line_diffs_into_diff_hunk);
+	ClassDB::bind_method(D_METHOD("popup_error", "msg"), &EditorVCSInterface::popup_error);
+
+	BIND_ENUM_CONSTANT(CHANGE_TYPE_NEW);
+	BIND_ENUM_CONSTANT(CHANGE_TYPE_MODIFIED);
+	BIND_ENUM_CONSTANT(CHANGE_TYPE_RENAMED);
+	BIND_ENUM_CONSTANT(CHANGE_TYPE_DELETED);
+	BIND_ENUM_CONSTANT(CHANGE_TYPE_TYPECHANGE);
+	BIND_ENUM_CONSTANT(CHANGE_TYPE_UNMERGED);
+
+	BIND_ENUM_CONSTANT(TREE_AREA_COMMIT);
+	BIND_ENUM_CONSTANT(TREE_AREA_STAGED);
+	BIND_ENUM_CONSTANT(TREE_AREA_UNSTAGED);
 }
 
 EditorVCSInterface *EditorVCSInterface::get_singleton() {
@@ -170,14 +409,14 @@ void EditorVCSInterface::create_vcs_metadata_files(VCSMetadata p_vcs_metadata_ty
 	if (p_vcs_metadata_type == VCSMetadata::GIT) {
 		Ref<FileAccess> f = FileAccess::open(p_dir.path_join(".gitignore"), FileAccess::WRITE);
 		if (f.is_null()) {
-			ERR_FAIL_MSG(TTR("Couldn't create .gitignore in project path."));
+			ERR_FAIL_MSG("Couldn't create .gitignore in project path.");
 		} else {
 			f->store_line("# Godot 4+ specific ignores");
 			f->store_line(".godot/");
 		}
 		f = FileAccess::open(p_dir.path_join(".gitattributes"), FileAccess::WRITE);
 		if (f.is_null()) {
-			ERR_FAIL_MSG(TTR("Couldn't create .gitattributes in project path."));
+			ERR_FAIL_MSG("Couldn't create .gitattributes in project path.");
 		} else {
 			f->store_line("# Normalize EOL for all files that Git considers text files.");
 			f->store_line("* text=auto eol=lf");