2019-09-04 13:17:26 +02:00
|
|
|
/*************************************************************************/
|
|
|
|
/* version_control_editor_plugin.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/*************************************************************************/
|
2022-01-13 09:45:09 +01:00
|
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
2019-09-04 13:17:26 +02:00
|
|
|
/* */
|
|
|
|
/* 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. */
|
|
|
|
/*************************************************************************/
|
|
|
|
|
2019-09-03 16:28:32 +02:00
|
|
|
#ifndef VERSION_CONTROL_EDITOR_PLUGIN_H
|
|
|
|
#define VERSION_CONTROL_EDITOR_PLUGIN_H
|
|
|
|
|
|
|
|
#include "editor/editor_plugin.h"
|
|
|
|
#include "editor/editor_vcs_interface.h"
|
|
|
|
#include "scene/gui/container.h"
|
2020-06-25 11:59:31 +02:00
|
|
|
#include "scene/gui/file_dialog.h"
|
|
|
|
#include "scene/gui/menu_button.h"
|
2019-09-03 16:28:32 +02:00
|
|
|
#include "scene/gui/rich_text_label.h"
|
2020-06-25 11:59:31 +02:00
|
|
|
#include "scene/gui/tab_container.h"
|
2019-09-03 16:28:32 +02:00
|
|
|
#include "scene/gui/text_edit.h"
|
2020-06-25 11:59:31 +02:00
|
|
|
#include "scene/gui/tool_button.h"
|
2019-09-03 16:28:32 +02:00
|
|
|
#include "scene/gui/tree.h"
|
|
|
|
|
|
|
|
class VersionControlEditorPlugin : public EditorPlugin {
|
|
|
|
GDCLASS(VersionControlEditorPlugin, EditorPlugin)
|
|
|
|
|
|
|
|
public:
|
2020-06-25 11:59:31 +02:00
|
|
|
enum ButtonType {
|
|
|
|
BUTTON_TYPE_OPEN = 0,
|
|
|
|
BUTTON_TYPE_DISCARD = 1,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum DiffViewType {
|
|
|
|
DIFF_VIEW_TYPE_SPLIT = 0,
|
|
|
|
DIFF_VIEW_TYPE_UNIFIED = 1,
|
|
|
|
};
|
2019-09-03 16:28:32 +02:00
|
|
|
|
2020-06-25 11:59:31 +02:00
|
|
|
enum ExtraOption {
|
|
|
|
EXTRA_OPTION_FORCE_PUSH,
|
|
|
|
EXTRA_OPTION_CREATE_BRANCH,
|
|
|
|
EXTRA_OPTION_CREATE_REMOTE,
|
2019-09-03 16:28:32 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
private:
|
|
|
|
static VersionControlEditorPlugin *singleton;
|
|
|
|
|
2020-06-25 11:59:31 +02:00
|
|
|
List<StringName> available_plugins;
|
2019-09-03 16:28:32 +02:00
|
|
|
|
|
|
|
PopupMenu *version_control_actions;
|
2020-06-25 11:59:31 +02:00
|
|
|
|
2019-09-03 16:28:32 +02:00
|
|
|
AcceptDialog *set_up_dialog;
|
|
|
|
OptionButton *set_up_choice;
|
|
|
|
Button *set_up_init_button;
|
2020-06-25 11:59:31 +02:00
|
|
|
VBoxContainer *set_up_vbc;
|
|
|
|
VBoxContainer *set_up_settings_vbc;
|
|
|
|
LineEdit *set_up_username;
|
|
|
|
LineEdit *set_up_password;
|
|
|
|
LineEdit *set_up_ssh_public_key_path;
|
|
|
|
LineEdit *set_up_ssh_private_key_path;
|
|
|
|
LineEdit *set_up_ssh_passphrase;
|
|
|
|
FileDialog *set_up_ssh_public_key_file_dialog;
|
|
|
|
FileDialog *set_up_ssh_private_key_file_dialog;
|
|
|
|
Label *set_up_warning_text;
|
|
|
|
|
|
|
|
OptionButton *commit_list_size_button;
|
|
|
|
|
|
|
|
AcceptDialog *branch_create_confirm;
|
|
|
|
LineEdit *branch_create_name_input;
|
|
|
|
Button *branch_create_ok;
|
|
|
|
|
|
|
|
AcceptDialog *remote_create_confirm;
|
|
|
|
LineEdit *remote_create_name_input;
|
|
|
|
LineEdit *remote_create_url_input;
|
|
|
|
Button *remote_create_ok;
|
|
|
|
|
|
|
|
HashMap<EditorVCSInterface::ChangeType, String> change_type_to_strings;
|
|
|
|
HashMap<EditorVCSInterface::ChangeType, Color> change_type_to_color;
|
|
|
|
HashMap<EditorVCSInterface::ChangeType, Ref<Texture>> change_type_to_icon;
|
|
|
|
|
|
|
|
TabContainer *dock_vbc;
|
2019-09-03 16:28:32 +02:00
|
|
|
VBoxContainer *version_commit_dock;
|
2020-06-25 11:59:31 +02:00
|
|
|
Tree *staged_files;
|
|
|
|
Tree *unstaged_files;
|
|
|
|
Tree *commit_list;
|
|
|
|
|
|
|
|
OptionButton *branch_select;
|
|
|
|
Button *branch_remove_button;
|
|
|
|
AcceptDialog *branch_remove_confirm;
|
|
|
|
|
|
|
|
ToolButton *fetch_button;
|
|
|
|
ToolButton *pull_button;
|
|
|
|
ToolButton *push_button;
|
|
|
|
OptionButton *remote_select;
|
|
|
|
Button *remote_remove_button;
|
|
|
|
AcceptDialog *remote_remove_confirm;
|
|
|
|
MenuButton *extra_options;
|
|
|
|
PopupMenu *extra_options_remove_branch_list;
|
|
|
|
PopupMenu *extra_options_remove_remote_list;
|
|
|
|
|
|
|
|
String branch_to_remove;
|
|
|
|
String remote_to_remove;
|
|
|
|
|
|
|
|
ToolButton *stage_all_button;
|
|
|
|
ToolButton *unstage_all_button;
|
|
|
|
ToolButton *discard_all_button;
|
|
|
|
ToolButton *refresh_button;
|
2019-09-03 16:28:32 +02:00
|
|
|
TextEdit *commit_message;
|
|
|
|
Button *commit_button;
|
|
|
|
|
2020-06-25 11:59:31 +02:00
|
|
|
VBoxContainer *version_control_dock;
|
2019-09-03 16:28:32 +02:00
|
|
|
ToolButton *version_control_dock_button;
|
2020-06-25 11:59:31 +02:00
|
|
|
Label *diff_title;
|
2019-09-03 16:28:32 +02:00
|
|
|
RichTextLabel *diff;
|
2020-06-25 11:59:31 +02:00
|
|
|
OptionButton *diff_view_type_select;
|
|
|
|
bool show_commit_diff_header = false;
|
|
|
|
List<EditorVCSInterface::DiffFile> diff_content;
|
2019-09-03 16:28:32 +02:00
|
|
|
|
2020-06-25 11:59:31 +02:00
|
|
|
void _notification(int p_what);
|
2019-09-03 16:28:32 +02:00
|
|
|
void _initialize_vcs();
|
2020-06-25 11:59:31 +02:00
|
|
|
void _set_credentials();
|
|
|
|
void _ssh_public_key_selected(String p_path);
|
|
|
|
void _ssh_private_key_selected(String p_path);
|
|
|
|
void _populate_available_vcs_names();
|
|
|
|
void _update_remotes_list();
|
|
|
|
void _update_set_up_warning(String p_new_text);
|
|
|
|
void _update_opened_tabs();
|
|
|
|
void _update_extra_options();
|
|
|
|
|
|
|
|
bool _load_plugin(String p_path);
|
|
|
|
void _set_up();
|
|
|
|
|
|
|
|
void _pull();
|
|
|
|
void _push();
|
|
|
|
void _force_push();
|
|
|
|
void _fetch();
|
|
|
|
void _commit();
|
|
|
|
void _discard_all();
|
2019-09-03 16:28:32 +02:00
|
|
|
void _refresh_stage_area();
|
2020-06-25 11:59:31 +02:00
|
|
|
void _refresh_branch_list();
|
2022-05-24 23:26:44 +02:00
|
|
|
void _refresh_commit_list(int p_index);
|
2020-06-25 11:59:31 +02:00
|
|
|
void _refresh_remote_list();
|
|
|
|
void _display_diff(int p_idx);
|
|
|
|
void _move_all(Object *p_tree);
|
|
|
|
void _load_diff(Object *p_tree);
|
|
|
|
void _clear_diff();
|
|
|
|
int _get_item_count(Tree *p_tree);
|
|
|
|
void _item_activated(Object *p_tree);
|
|
|
|
void _create_branch();
|
|
|
|
void _create_remote();
|
|
|
|
void _update_branch_create_button(String p_new_text);
|
|
|
|
void _update_remote_create_button(String p_new_text);
|
|
|
|
void _branch_item_selected(int p_index);
|
|
|
|
void _remote_selected(int p_index);
|
|
|
|
void _remove_branch();
|
|
|
|
void _remove_remote();
|
|
|
|
void _popup_branch_remove_confirm(int p_index);
|
|
|
|
void _popup_remote_remove_confirm(int p_index);
|
|
|
|
void _move_item(Tree *p_tree, TreeItem *p_itme);
|
|
|
|
void _display_diff_split_view(List<EditorVCSInterface::DiffLine> &p_diff_content);
|
|
|
|
void _display_diff_unified_view(List<EditorVCSInterface::DiffLine> &p_diff_content);
|
|
|
|
void _discard_file(String p_file_path, EditorVCSInterface::ChangeType p_change);
|
|
|
|
void _cell_button_pressed(Object *p_item, int p_column, int p_id);
|
|
|
|
void _add_new_item(Tree *p_tree, String p_file_path, EditorVCSInterface::ChangeType p_change);
|
2020-12-20 17:43:50 +01:00
|
|
|
void _update_commit_button();
|
2021-07-13 19:33:50 +02:00
|
|
|
void _commit_message_gui_input(const Ref<InputEvent> &p_event);
|
2020-06-25 11:59:31 +02:00
|
|
|
void _extra_option_selected(int p_index);
|
|
|
|
bool _is_staging_area_empty();
|
2022-02-23 23:30:29 +01:00
|
|
|
String _get_date_string_from(int64_t p_unix_timestamp, int64_t p_offset_minutes) const;
|
2019-09-03 16:28:32 +02:00
|
|
|
|
|
|
|
friend class EditorVCSInterface;
|
|
|
|
|
|
|
|
protected:
|
|
|
|
static void _bind_methods();
|
|
|
|
|
|
|
|
public:
|
|
|
|
static VersionControlEditorPlugin *get_singleton();
|
|
|
|
|
|
|
|
void popup_vcs_set_up_dialog(const Control *p_gui_base);
|
|
|
|
void set_version_control_tool_button(ToolButton *p_button) { version_control_dock_button = p_button; }
|
|
|
|
|
|
|
|
PopupMenu *get_version_control_actions_panel() const { return version_control_actions; }
|
|
|
|
VBoxContainer *get_version_commit_dock() const { return version_commit_dock; }
|
2020-06-25 11:59:31 +02:00
|
|
|
VBoxContainer *get_version_control_dock() const { return version_control_dock; }
|
2019-09-03 16:28:32 +02:00
|
|
|
|
2020-06-25 11:59:31 +02:00
|
|
|
List<StringName> get_available_vcs_names() const { return available_plugins; }
|
2019-09-03 16:28:32 +02:00
|
|
|
|
|
|
|
void register_editor();
|
2020-06-25 11:59:31 +02:00
|
|
|
void fetch_available_vcs_plugin_names();
|
2019-09-03 16:28:32 +02:00
|
|
|
void shut_down();
|
|
|
|
|
|
|
|
VersionControlEditorPlugin();
|
|
|
|
~VersionControlEditorPlugin();
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // !VERSION_CONTROL_EDITOR_PLUGIN_H
|