From 97959a53df144222f468d1622a3cb7e2f7e48741 Mon Sep 17 00:00:00 2001 From: Twarit Date: Tue, 3 Sep 2019 20:01:14 +0530 Subject: 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. --- editor/editor_vcs_interface.h | 53 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 editor/editor_vcs_interface.h (limited to 'editor/editor_vcs_interface.h') diff --git a/editor/editor_vcs_interface.h b/editor/editor_vcs_interface.h new file mode 100644 index 0000000000..baf196de6e --- /dev/null +++ b/editor/editor_vcs_interface.h @@ -0,0 +1,53 @@ +#ifndef EDITOR_VCS_INTERFACE_H +#define EDITOR_VCS_INTERFACE_H + +#include "core/object.h" +#include "core/ustring.h" +#include "scene/gui/panel_container.h" + +class EditorVCSInterface : public Object { + + GDCLASS(EditorVCSInterface, Object) + + bool is_initialized; + +protected: + static EditorVCSInterface *singleton; + + static void _bind_methods(); + + // Implemented by addons as end points for the proxy functions + bool _initialize(String p_project_root_path); + bool _get_is_vcs_intialized(); + Dictionary _get_modified_files_data(); + void _stage_file(String p_file_path); + void _unstage_file(String p_file_path); + void _commit(String p_msg); + Array _get_file_diff(String p_file_path); + bool _shut_down(); + String _get_project_name(); + String _get_vcs_name(); + +public: + static EditorVCSInterface *get_singleton(); + static void set_singleton(EditorVCSInterface *p_singleton); + + bool is_addon_ready(); + + // Proxy functions to the editor for use + bool initialize(String p_project_root_path); + bool get_is_vcs_intialized(); + Dictionary get_modified_files_data(); + void stage_file(String p_file_path); + void unstage_file(String p_file_path); + void commit(String p_msg); + Array get_file_diff(String p_file_path); + bool shut_down(); + String get_project_name(); + String get_vcs_name(); + + EditorVCSInterface(); + virtual ~EditorVCSInterface(); +}; + +#endif // !EDITOR_VCS_INTERFACE_H -- cgit v1.2.3 From 444ba61aac60c71e4ee392d5b0df06f72cc3c8b6 Mon Sep 17 00:00:00 2001 From: Twarit Date: Wed, 4 Sep 2019 16:47:26 +0530 Subject: Add copyright headers to vcs integration --- editor/editor_vcs_interface.h | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) (limited to 'editor/editor_vcs_interface.h') diff --git a/editor/editor_vcs_interface.h b/editor/editor_vcs_interface.h index baf196de6e..896193ed92 100644 --- a/editor/editor_vcs_interface.h +++ b/editor/editor_vcs_interface.h @@ -1,3 +1,33 @@ +/*************************************************************************/ +/* editor_vcs_interface.h */ +/*************************************************************************/ +/* This file is part of: */ +/* GODOT ENGINE */ +/* https://godotengine.org */ +/*************************************************************************/ +/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */ +/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */ +/* */ +/* 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 EDITOR_VCS_INTERFACE_H #define EDITOR_VCS_INTERFACE_H -- cgit v1.2.3