-
-
Notifications
You must be signed in to change notification settings - Fork 24.6k
Expand file tree
/
Copy patheditor_plugin_settings.cpp
More file actions
290 lines (252 loc) · 11.5 KB
/
editor_plugin_settings.cpp
File metadata and controls
290 lines (252 loc) · 11.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
/**************************************************************************/
/* editor_plugin_settings.cpp */
/**************************************************************************/
/* 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. */
/**************************************************************************/
#include "editor_plugin_settings.h"
#include "core/config/engine.h"
#include "core/config/project_settings.h"
#include "core/io/config_file.h"
#include "core/io/dir_access.h"
#include "core/io/file_access.h"
#include "core/object/callable_mp.h"
#include "editor/editor_node.h"
#include "editor/editor_string_names.h"
#include "editor/themes/editor_scale.h"
#include "scene/gui/margin_container.h"
#include "scene/gui/separator.h"
#include "scene/gui/texture_rect.h"
#include "scene/gui/tree.h"
void EditorPluginSettings::_notification(int p_what) {
switch (p_what) {
case NOTIFICATION_WM_WINDOW_FOCUS_IN: {
update_plugins();
} break;
case NOTIFICATION_READY: {
plugin_config_dialog->connect("plugin_ready", callable_mp(EditorNode::get_singleton(), &EditorNode::_on_plugin_ready));
plugin_list->connect("button_clicked", callable_mp(this, &EditorPluginSettings::_cell_button_pressed));
} break;
case NOTIFICATION_TRANSLATION_CHANGED: {
if (plugin_list->get_root()) {
update_plugins();
}
} break;
case NOTIFICATION_THEME_CHANGED: {
if (Engine::get_singleton()->is_recovery_mode_hint()) {
recovery_mode_icon->set_texture(get_editor_theme_icon(SNAME("NodeWarning")));
}
} break;
}
}
void EditorPluginSettings::update_plugins() {
plugin_list->clear();
updating = true;
TreeItem *root = plugin_list->create_item();
Vector<String> plugins = _get_plugins("res://addons");
plugins.sort();
for (int i = 0; i < plugins.size(); i++) {
Ref<ConfigFile> cfg;
cfg.instantiate();
const String &path = plugins[i];
Error err = cfg->load(path);
if (err != OK) {
WARN_PRINT("Can't load plugin config at: " + path);
} else {
Vector<String> missing_keys;
for (const String required_key : { "name", "author", "version", "description", "script" }) {
if (!cfg->has_section_key("plugin", required_key)) {
missing_keys.append("\"plugin/" + required_key + "\"");
}
}
if (!missing_keys.is_empty()) {
WARN_PRINT(vformat("Plugin config at \"%s\" is missing the following keys: %s", path, String(",").join(missing_keys)));
} else {
String name = cfg->get_value("plugin", "name");
String author = cfg->get_value("plugin", "author");
String version = cfg->get_value("plugin", "version");
String description = cfg->get_value("plugin", "description");
String scr = cfg->get_value("plugin", "script");
bool is_enabled = EditorNode::get_singleton()->is_addon_plugin_enabled(path);
Color disabled_color = get_theme_color(SNAME("font_disabled_color"), EditorStringName(Editor));
const PackedInt32Array boundaries = TS->string_get_word_breaks(description, "", 80);
String wrapped_description;
for (int j = 0; j < boundaries.size(); j += 2) {
const int start = boundaries[j];
const int end = boundaries[j + 1];
wrapped_description += "\n" + description.substr(start, end - start + 1).rstrip("\n");
}
TreeItem *item = plugin_list->create_item(root);
item->set_text(COLUMN_NAME, name);
if (!is_enabled) {
item->set_custom_color(COLUMN_NAME, disabled_color);
}
item->set_tooltip_text(COLUMN_NAME, vformat(TTR("Name: %s\nPath: %s\nMain Script: %s\n\n%s"), name, path, scr, wrapped_description));
item->set_metadata(COLUMN_NAME, path);
item->set_text(COLUMN_VERSION, version);
item->set_custom_font(COLUMN_VERSION, get_theme_font("source", EditorStringName(EditorFonts)));
item->set_metadata(COLUMN_VERSION, scr);
item->set_text(COLUMN_AUTHOR, author);
item->set_metadata(COLUMN_AUTHOR, description);
item->set_cell_mode(COLUMN_STATUS, TreeItem::CELL_MODE_CHECK);
item->set_text(COLUMN_STATUS, TTRC("On"));
item->set_checked(COLUMN_STATUS, is_enabled);
item->set_editable(COLUMN_STATUS, true);
item->add_button(COLUMN_EDIT, get_editor_theme_icon(SNAME("Edit")), BUTTON_PLUGIN_EDIT, false, TTRC("Edit Plugin"));
}
}
}
updating = false;
}
void EditorPluginSettings::_plugin_activity_changed() {
if (updating) {
return;
}
TreeItem *ti = plugin_list->get_edited();
ERR_FAIL_NULL(ti);
bool checked = ti->is_checked(COLUMN_STATUS);
String name = ti->get_metadata(COLUMN_NAME);
EditorNode::get_singleton()->set_addon_plugin_enabled(name, checked, true);
bool is_enabled = EditorNode::get_singleton()->is_addon_plugin_enabled(name);
if (is_enabled != checked) {
updating = true;
ti->set_checked(COLUMN_STATUS, is_enabled);
updating = false;
}
if (is_enabled) {
ti->clear_custom_color(COLUMN_NAME);
} else {
ti->set_custom_color(COLUMN_NAME, get_theme_color(SNAME("font_disabled_color"), EditorStringName(Editor)));
}
}
void EditorPluginSettings::_create_clicked() {
plugin_config_dialog->config("");
plugin_config_dialog->popup_centered();
}
void EditorPluginSettings::_cell_button_pressed(Object *p_item, int p_column, int p_id, MouseButton p_button) {
if (p_button != MouseButton::LEFT) {
return;
}
TreeItem *item = Object::cast_to<TreeItem>(p_item);
if (!item) {
return;
}
if (p_id == BUTTON_PLUGIN_EDIT) {
if (p_column == COLUMN_EDIT) {
String dir = item->get_metadata(COLUMN_NAME);
plugin_config_dialog->config(dir);
plugin_config_dialog->popup_centered();
}
}
}
Vector<String> EditorPluginSettings::_get_plugins(const String &p_dir) {
Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
Error err = da->change_dir(p_dir);
if (err != OK) {
return Vector<String>();
}
Vector<String> plugins;
da->list_dir_begin();
for (String path = da->get_next(); !path.is_empty(); path = da->get_next()) {
if (path[0] == '.' || !da->current_is_dir()) {
continue;
}
const String full_path = p_dir.path_join(path);
const String plugin_config = full_path.path_join("plugin.cfg");
if (FileAccess::exists(plugin_config)) {
plugins.push_back(plugin_config);
} else {
plugins.append_array(_get_plugins(full_path));
}
}
da->list_dir_end();
return plugins;
}
EditorPluginSettings::EditorPluginSettings() {
ProjectSettings::get_singleton()->add_hidden_prefix("editor_plugins/");
plugin_config_dialog = memnew(PluginConfigDialog);
plugin_config_dialog->config("");
add_child(plugin_config_dialog);
if (Engine::get_singleton()->is_recovery_mode_hint()) {
HBoxContainer *c = memnew(HBoxContainer);
add_child(c);
recovery_mode_icon = memnew(TextureRect);
recovery_mode_icon->set_stretch_mode(TextureRect::STRETCH_KEEP_ASPECT_CENTERED);
c->add_child(recovery_mode_icon);
Label *recovery_mode_label = memnew(Label(TTRC("Recovery mode is enabled. Enabled plugins will not run while this mode is active.")));
recovery_mode_label->set_theme_type_variation("HeaderSmall");
recovery_mode_label->set_h_size_flags(SIZE_EXPAND_FILL);
c->add_child(recovery_mode_label);
HSeparator *sep = memnew(HSeparator);
add_child(sep);
}
HBoxContainer *title_hb = memnew(HBoxContainer);
Label *label = memnew(Label(TTRC("Installed Plugins:")));
label->set_theme_type_variation("HeaderSmall");
title_hb->add_child(label);
title_hb->add_spacer();
Button *create_plugin_button = memnew(Button(TTRC("Create New Plugin")));
create_plugin_button->connect(SceneStringName(pressed), callable_mp(this, &EditorPluginSettings::_create_clicked));
title_hb->add_child(create_plugin_button);
add_child(title_hb);
plugin_list = memnew(Tree);
plugin_list->set_v_size_flags(SIZE_EXPAND_FILL);
plugin_list->set_theme_type_variation("TreeTable");
plugin_list->set_hide_folding(true);
plugin_list->set_columns(COLUMN_MAX);
plugin_list->set_column_titles_visible(true);
plugin_list->set_column_title(COLUMN_STATUS, TTRC("Enabled"));
plugin_list->set_column_title(COLUMN_NAME, TTRC("Name"));
plugin_list->set_column_title(COLUMN_VERSION, TTRC("Version"));
plugin_list->set_column_title(COLUMN_AUTHOR, TTRC("Author"));
plugin_list->set_column_title(COLUMN_EDIT, TTRC("Edit"));
plugin_list->set_column_title_alignment(COLUMN_STATUS, HORIZONTAL_ALIGNMENT_LEFT);
plugin_list->set_column_title_alignment(COLUMN_NAME, HORIZONTAL_ALIGNMENT_LEFT);
plugin_list->set_column_title_alignment(COLUMN_VERSION, HORIZONTAL_ALIGNMENT_LEFT);
plugin_list->set_column_title_alignment(COLUMN_AUTHOR, HORIZONTAL_ALIGNMENT_LEFT);
plugin_list->set_column_title_alignment(COLUMN_EDIT, HORIZONTAL_ALIGNMENT_LEFT);
plugin_list->set_column_expand(COLUMN_STATUS, false);
plugin_list->set_column_expand(COLUMN_NAME, true);
plugin_list->set_column_expand(COLUMN_VERSION, false);
plugin_list->set_column_expand(COLUMN_AUTHOR, false);
plugin_list->set_column_expand(COLUMN_EDIT, false);
plugin_list->set_column_clip_content(COLUMN_STATUS, true);
plugin_list->set_column_clip_content(COLUMN_NAME, true);
plugin_list->set_column_clip_content(COLUMN_VERSION, true);
plugin_list->set_column_clip_content(COLUMN_AUTHOR, true);
plugin_list->set_column_clip_content(COLUMN_EDIT, true);
plugin_list->set_column_custom_minimum_width(COLUMN_STATUS, 80 * EDSCALE);
plugin_list->set_column_custom_minimum_width(COLUMN_VERSION, 100 * EDSCALE);
plugin_list->set_column_custom_minimum_width(COLUMN_AUTHOR, 250 * EDSCALE);
plugin_list->set_column_custom_minimum_width(COLUMN_EDIT, 40 * EDSCALE);
plugin_list->set_hide_root(true);
plugin_list->connect("item_edited", callable_mp(this, &EditorPluginSettings::_plugin_activity_changed), CONNECT_DEFERRED);
VBoxContainer *mc = memnew(VBoxContainer);
mc->add_child(plugin_list);
mc->set_v_size_flags(SIZE_EXPAND_FILL);
mc->set_h_size_flags(SIZE_EXPAND_FILL);
add_child(mc);
}