97959a53df
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.
54 lines
1.3 KiB
C++
54 lines
1.3 KiB
C++
#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
|