connections_dialog.cpp 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632
  1. /**************************************************************************/
  2. /* connections_dialog.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "connections_dialog.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/templates/hash_set.h"
  33. #include "editor/editor_help.h"
  34. #include "editor/editor_inspector.h"
  35. #include "editor/editor_node.h"
  36. #include "editor/editor_settings.h"
  37. #include "editor/editor_string_names.h"
  38. #include "editor/editor_undo_redo_manager.h"
  39. #include "editor/gui/scene_tree_editor.h"
  40. #include "editor/node_dock.h"
  41. #include "editor/scene_tree_dock.h"
  42. #include "editor/themes/editor_scale.h"
  43. #include "plugins/script_editor_plugin.h"
  44. #include "scene/gui/button.h"
  45. #include "scene/gui/check_box.h"
  46. #include "scene/gui/label.h"
  47. #include "scene/gui/line_edit.h"
  48. #include "scene/gui/margin_container.h"
  49. #include "scene/gui/option_button.h"
  50. #include "scene/gui/popup_menu.h"
  51. #include "scene/gui/spin_box.h"
  52. static Node *_find_first_script(Node *p_root, Node *p_node) {
  53. if (p_node != p_root && p_node->get_owner() != p_root) {
  54. return nullptr;
  55. }
  56. if (!p_node->get_script().is_null()) {
  57. return p_node;
  58. }
  59. for (int i = 0; i < p_node->get_child_count(); i++) {
  60. Node *ret = _find_first_script(p_root, p_node->get_child(i));
  61. if (ret) {
  62. return ret;
  63. }
  64. }
  65. return nullptr;
  66. }
  67. class ConnectDialogBinds : public Object {
  68. GDCLASS(ConnectDialogBinds, Object);
  69. public:
  70. Vector<Variant> params;
  71. bool _set(const StringName &p_name, const Variant &p_value) {
  72. String name = p_name;
  73. if (name.begins_with("bind/argument_")) {
  74. int which = name.get_slice("_", 1).to_int() - 1;
  75. ERR_FAIL_INDEX_V(which, params.size(), false);
  76. params.write[which] = p_value;
  77. } else {
  78. return false;
  79. }
  80. return true;
  81. }
  82. bool _get(const StringName &p_name, Variant &r_ret) const {
  83. String name = p_name;
  84. if (name.begins_with("bind/argument_")) {
  85. int which = name.get_slice("_", 1).to_int() - 1;
  86. ERR_FAIL_INDEX_V(which, params.size(), false);
  87. r_ret = params[which];
  88. } else {
  89. return false;
  90. }
  91. return true;
  92. }
  93. void _get_property_list(List<PropertyInfo> *p_list) const {
  94. for (int i = 0; i < params.size(); i++) {
  95. p_list->push_back(PropertyInfo(params[i].get_type(), "bind/argument_" + itos(i + 1)));
  96. }
  97. }
  98. void notify_changed() {
  99. notify_property_list_changed();
  100. }
  101. ConnectDialogBinds() {
  102. }
  103. };
  104. /*
  105. * Signal automatically called by parent dialog.
  106. */
  107. void ConnectDialog::ok_pressed() {
  108. String method_name = dst_method->get_text();
  109. if (method_name.is_empty()) {
  110. error->set_text(TTR("Method in target node must be specified."));
  111. error->popup_centered();
  112. return;
  113. }
  114. if (!TS->is_valid_identifier(method_name.strip_edges())) {
  115. error->set_text(TTR("Method name must be a valid identifier."));
  116. error->popup_centered();
  117. return;
  118. }
  119. Node *target = tree->get_selected();
  120. if (!target) {
  121. return; // Nothing selected in the tree, not an error.
  122. }
  123. if (target->get_script().is_null()) {
  124. if (!target->has_method(method_name)) {
  125. error->set_text(TTR("Target method not found. Specify a valid method or attach a script to the target node."));
  126. error->popup_centered();
  127. return;
  128. }
  129. }
  130. emit_signal(SNAME("connected"));
  131. hide();
  132. }
  133. void ConnectDialog::_cancel_pressed() {
  134. hide();
  135. }
  136. void ConnectDialog::_item_activated() {
  137. _ok_pressed(); // From AcceptDialog.
  138. }
  139. /*
  140. * Called each time a target node is selected within the target node tree.
  141. */
  142. void ConnectDialog::_tree_node_selected() {
  143. Node *current = tree->get_selected();
  144. if (!current) {
  145. return;
  146. }
  147. dst_path = source->get_path_to(current);
  148. if (!edit_mode) {
  149. set_dst_method(generate_method_callback_name(source, signal, current));
  150. }
  151. _update_method_tree();
  152. _update_warning_label();
  153. _update_ok_enabled();
  154. }
  155. void ConnectDialog::_focus_currently_connected() {
  156. tree->set_selected(source);
  157. }
  158. void ConnectDialog::_unbind_count_changed(double p_count) {
  159. for (Control *control : bind_controls) {
  160. BaseButton *b = Object::cast_to<BaseButton>(control);
  161. if (b) {
  162. b->set_disabled(p_count > 0);
  163. }
  164. EditorInspector *e = Object::cast_to<EditorInspector>(control);
  165. if (e) {
  166. e->set_read_only(p_count > 0);
  167. }
  168. }
  169. }
  170. void ConnectDialog::_method_selected() {
  171. TreeItem *selected_item = method_tree->get_selected();
  172. dst_method->set_text(selected_item->get_metadata(0));
  173. }
  174. /*
  175. * Adds a new parameter bind to connection.
  176. */
  177. void ConnectDialog::_add_bind() {
  178. Variant::Type type = (Variant::Type)type_list->get_item_id(type_list->get_selected());
  179. Variant value;
  180. Callable::CallError err;
  181. Variant::construct(type, value, nullptr, 0, err);
  182. cdbinds->params.push_back(value);
  183. cdbinds->notify_changed();
  184. }
  185. /*
  186. * Remove parameter bind from connection.
  187. */
  188. void ConnectDialog::_remove_bind() {
  189. String st = bind_editor->get_selected_path();
  190. if (st.is_empty()) {
  191. return;
  192. }
  193. int idx = st.get_slice("/", 1).to_int() - 1;
  194. ERR_FAIL_INDEX(idx, cdbinds->params.size());
  195. cdbinds->params.remove_at(idx);
  196. cdbinds->notify_changed();
  197. }
  198. /*
  199. * Automatically generates a name for the callback method.
  200. */
  201. StringName ConnectDialog::generate_method_callback_name(Node *p_source, const String &p_signal_name, Node *p_target) {
  202. String node_name = p_source->get_name();
  203. for (int i = 0; i < node_name.length(); i++) { // TODO: Regex filter may be cleaner.
  204. char32_t c = node_name[i];
  205. if ((i == 0 && !is_unicode_identifier_start(c)) || (i > 0 && !is_unicode_identifier_continue(c))) {
  206. if (c == ' ') {
  207. // Replace spaces with underlines.
  208. c = '_';
  209. } else {
  210. // Remove any other characters.
  211. node_name.remove_at(i);
  212. i--;
  213. continue;
  214. }
  215. }
  216. node_name[i] = c;
  217. }
  218. Dictionary subst;
  219. subst["NodeName"] = node_name.to_pascal_case();
  220. subst["nodeName"] = node_name.to_camel_case();
  221. subst["node_name"] = node_name.to_snake_case();
  222. subst["SignalName"] = p_signal_name.to_pascal_case();
  223. subst["signalName"] = p_signal_name.to_camel_case();
  224. subst["signal_name"] = p_signal_name.to_snake_case();
  225. String dst_method;
  226. if (p_source == p_target) {
  227. dst_method = String(GLOBAL_GET("editor/naming/default_signal_callback_to_self_name")).format(subst);
  228. } else {
  229. dst_method = String(GLOBAL_GET("editor/naming/default_signal_callback_name")).format(subst);
  230. }
  231. return dst_method;
  232. }
  233. void ConnectDialog::_create_method_tree_items(const List<MethodInfo> &p_methods, TreeItem *p_parent_item) {
  234. for (const MethodInfo &mi : p_methods) {
  235. TreeItem *method_item = method_tree->create_item(p_parent_item);
  236. method_item->set_text(0, get_signature(mi));
  237. method_item->set_metadata(0, mi.name);
  238. }
  239. }
  240. List<MethodInfo> ConnectDialog::_filter_method_list(const List<MethodInfo> &p_methods, const MethodInfo &p_signal, const String &p_search_string) const {
  241. bool check_signal = compatible_methods_only->is_pressed();
  242. List<MethodInfo> ret;
  243. for (const MethodInfo &mi : p_methods) {
  244. if (!p_search_string.is_empty() && !mi.name.containsn(p_search_string)) {
  245. continue;
  246. }
  247. if (check_signal) {
  248. if (mi.arguments.size() != p_signal.arguments.size()) {
  249. continue;
  250. }
  251. bool type_mismatch = false;
  252. const List<PropertyInfo>::Element *E = p_signal.arguments.front();
  253. for (const List<PropertyInfo>::Element *F = mi.arguments.front(); F; F = F->next(), E = E->next()) {
  254. Variant::Type stype = E->get().type;
  255. Variant::Type mtype = F->get().type;
  256. if (stype != Variant::NIL && mtype != Variant::NIL && stype != mtype) {
  257. type_mismatch = true;
  258. break;
  259. }
  260. if (stype == Variant::OBJECT && mtype == Variant::OBJECT && !ClassDB::is_parent_class(E->get().class_name, F->get().class_name)) {
  261. type_mismatch = true;
  262. break;
  263. }
  264. }
  265. if (type_mismatch) {
  266. continue;
  267. }
  268. }
  269. ret.push_back(mi);
  270. }
  271. return ret;
  272. }
  273. void ConnectDialog::_update_method_tree() {
  274. method_tree->clear();
  275. Color disabled_color = get_theme_color(SNAME("accent_color"), EditorStringName(Editor)) * 0.7;
  276. String search_string = method_search->get_text();
  277. Node *target = tree->get_selected();
  278. if (!target) {
  279. return;
  280. }
  281. MethodInfo signal_info;
  282. if (compatible_methods_only->is_pressed()) {
  283. List<MethodInfo> signals;
  284. source->get_signal_list(&signals);
  285. for (const MethodInfo &mi : signals) {
  286. if (mi.name == signal) {
  287. signal_info = mi;
  288. break;
  289. }
  290. }
  291. }
  292. TreeItem *root_item = method_tree->create_item();
  293. root_item->set_text(0, TTR("Methods"));
  294. root_item->set_selectable(0, false);
  295. // If a script is attached, get methods from it.
  296. ScriptInstance *si = target->get_script_instance();
  297. if (si) {
  298. if (si->get_script()->is_built_in()) {
  299. si->get_script()->reload();
  300. }
  301. List<MethodInfo> methods;
  302. si->get_method_list(&methods);
  303. methods = _filter_method_list(methods, signal_info, search_string);
  304. if (!methods.is_empty()) {
  305. TreeItem *si_item = method_tree->create_item(root_item);
  306. si_item->set_text(0, TTR("Attached Script"));
  307. si_item->set_icon(0, get_editor_theme_icon(SNAME("Script")));
  308. si_item->set_selectable(0, false);
  309. _create_method_tree_items(methods, si_item);
  310. }
  311. }
  312. if (script_methods_only->is_pressed()) {
  313. empty_tree_label->set_visible(root_item->get_first_child() == nullptr);
  314. return;
  315. }
  316. // Get methods from each class in the hierarchy.
  317. StringName current_class = target->get_class_name();
  318. do {
  319. TreeItem *class_item = method_tree->create_item(root_item);
  320. class_item->set_text(0, current_class);
  321. Ref<Texture2D> icon = get_editor_theme_icon(SNAME("Node"));
  322. if (has_theme_icon(current_class, EditorStringName(EditorIcons))) {
  323. icon = get_editor_theme_icon(current_class);
  324. }
  325. class_item->set_icon(0, icon);
  326. class_item->set_selectable(0, false);
  327. List<MethodInfo> methods;
  328. ClassDB::get_method_list(current_class, &methods, true);
  329. methods = _filter_method_list(methods, signal_info, search_string);
  330. if (methods.is_empty()) {
  331. class_item->set_custom_color(0, disabled_color);
  332. } else {
  333. _create_method_tree_items(methods, class_item);
  334. }
  335. current_class = ClassDB::get_parent_class_nocheck(current_class);
  336. } while (current_class != StringName());
  337. empty_tree_label->set_visible(root_item->get_first_child() == nullptr);
  338. }
  339. void ConnectDialog::_method_check_button_pressed(const CheckButton *p_button) {
  340. if (p_button == script_methods_only) {
  341. EditorSettings::get_singleton()->set_project_metadata("editor_metadata", "show_script_methods_only", p_button->is_pressed());
  342. } else if (p_button == compatible_methods_only) {
  343. EditorSettings::get_singleton()->set_project_metadata("editor_metadata", "show_compatible_methods_only", p_button->is_pressed());
  344. }
  345. _update_method_tree();
  346. }
  347. void ConnectDialog::_open_method_popup() {
  348. method_popup->popup_centered();
  349. method_search->clear();
  350. method_search->grab_focus();
  351. }
  352. /*
  353. * Enables or disables the connect button. The connect button is enabled if a
  354. * node is selected and valid in the selected mode.
  355. */
  356. void ConnectDialog::_update_ok_enabled() {
  357. Node *target = tree->get_selected();
  358. if (target == nullptr) {
  359. get_ok_button()->set_disabled(true);
  360. return;
  361. }
  362. if (dst_method->get_text().is_empty()) {
  363. get_ok_button()->set_disabled(true);
  364. return;
  365. }
  366. get_ok_button()->set_disabled(false);
  367. }
  368. void ConnectDialog::_update_warning_label() {
  369. Ref<Script> scr = source->get_node(dst_path)->get_script();
  370. if (scr.is_null()) {
  371. warning_label->set_visible(false);
  372. return;
  373. }
  374. ScriptLanguage *language = scr->get_language();
  375. if (language->can_make_function()) {
  376. warning_label->set_visible(false);
  377. return;
  378. }
  379. warning_label->set_text(vformat(TTR("%s: Callback code won't be generated, please add it manually."), language->get_name()));
  380. warning_label->set_visible(true);
  381. }
  382. void ConnectDialog::_post_popup() {
  383. callable_mp((Control *)dst_method, &Control::grab_focus).call_deferred();
  384. callable_mp(dst_method, &LineEdit::select_all).call_deferred();
  385. }
  386. void ConnectDialog::_notification(int p_what) {
  387. switch (p_what) {
  388. case NOTIFICATION_ENTER_TREE: {
  389. bind_editor->edit(cdbinds);
  390. [[fallthrough]];
  391. }
  392. case NOTIFICATION_THEME_CHANGED: {
  393. for (int i = 0; i < type_list->get_item_count(); i++) {
  394. String type_name = Variant::get_type_name((Variant::Type)type_list->get_item_id(i));
  395. type_list->set_item_icon(i, get_editor_theme_icon(type_name));
  396. }
  397. Ref<StyleBox> style = get_theme_stylebox("normal", "LineEdit")->duplicate();
  398. if (style.is_valid()) {
  399. style->set_content_margin(SIDE_TOP, style->get_content_margin(SIDE_TOP) + 1.0);
  400. from_signal->add_theme_style_override("normal", style);
  401. }
  402. method_search->set_right_icon(get_editor_theme_icon("Search"));
  403. open_method_tree->set_icon(get_editor_theme_icon("Edit"));
  404. } break;
  405. }
  406. }
  407. void ConnectDialog::_bind_methods() {
  408. ADD_SIGNAL(MethodInfo("connected"));
  409. }
  410. Node *ConnectDialog::get_source() const {
  411. return source;
  412. }
  413. ConnectDialog::ConnectionData ConnectDialog::get_source_connection_data() const {
  414. return source_connection_data;
  415. }
  416. StringName ConnectDialog::get_signal_name() const {
  417. return signal;
  418. }
  419. PackedStringArray ConnectDialog::get_signal_args() const {
  420. return signal_args;
  421. }
  422. NodePath ConnectDialog::get_dst_path() const {
  423. return dst_path;
  424. }
  425. void ConnectDialog::set_dst_node(Node *p_node) {
  426. tree->set_selected(p_node);
  427. }
  428. StringName ConnectDialog::get_dst_method_name() const {
  429. String txt = dst_method->get_text();
  430. if (txt.contains("(")) {
  431. txt = txt.left(txt.find("(")).strip_edges();
  432. }
  433. return txt;
  434. }
  435. void ConnectDialog::set_dst_method(const StringName &p_method) {
  436. dst_method->set_text(p_method);
  437. }
  438. int ConnectDialog::get_unbinds() const {
  439. return int(unbind_count->get_value());
  440. }
  441. Vector<Variant> ConnectDialog::get_binds() const {
  442. return cdbinds->params;
  443. }
  444. String ConnectDialog::get_signature(const MethodInfo &p_method, PackedStringArray *r_arg_names) {
  445. PackedStringArray signature;
  446. signature.append(p_method.name);
  447. signature.append("(");
  448. int i = 0;
  449. for (List<PropertyInfo>::ConstIterator itr = p_method.arguments.begin(); itr != p_method.arguments.end(); ++itr, ++i) {
  450. if (itr != p_method.arguments.begin()) {
  451. signature.append(", ");
  452. }
  453. const PropertyInfo &pi = *itr;
  454. String type_name;
  455. switch (pi.type) {
  456. case Variant::NIL:
  457. type_name = "Variant";
  458. break;
  459. case Variant::INT:
  460. if ((pi.usage & PROPERTY_USAGE_CLASS_IS_ENUM) && pi.class_name != StringName() && !String(pi.class_name).begins_with("res://")) {
  461. type_name = pi.class_name;
  462. } else {
  463. type_name = "int";
  464. }
  465. break;
  466. case Variant::ARRAY:
  467. if (pi.hint == PROPERTY_HINT_ARRAY_TYPE && !pi.hint_string.is_empty() && !pi.hint_string.begins_with("res://")) {
  468. type_name = "Array[" + pi.hint_string + "]";
  469. } else {
  470. type_name = "Array";
  471. }
  472. break;
  473. case Variant::OBJECT:
  474. if (pi.class_name != StringName()) {
  475. type_name = pi.class_name;
  476. } else {
  477. type_name = "Object";
  478. }
  479. break;
  480. default:
  481. type_name = Variant::get_type_name(pi.type);
  482. break;
  483. }
  484. String arg_name = pi.name.is_empty() ? "arg" + itos(i) : pi.name;
  485. signature.append(arg_name + ": " + type_name);
  486. if (r_arg_names) {
  487. r_arg_names->push_back(arg_name + ":" + type_name);
  488. }
  489. }
  490. signature.append(")");
  491. return String().join(signature);
  492. }
  493. bool ConnectDialog::get_deferred() const {
  494. return deferred->is_pressed();
  495. }
  496. bool ConnectDialog::get_one_shot() const {
  497. return one_shot->is_pressed();
  498. }
  499. /*
  500. * Returns true if ConnectDialog is being used to edit an existing connection.
  501. */
  502. bool ConnectDialog::is_editing() const {
  503. return edit_mode;
  504. }
  505. void ConnectDialog::shortcut_input(const Ref<InputEvent> &p_event) {
  506. const Ref<InputEventKey> &key = p_event;
  507. if (key.is_valid() && key->is_pressed() && !key->is_echo()) {
  508. if (ED_IS_SHORTCUT("editor/open_search", p_event)) {
  509. filter_nodes->grab_focus();
  510. filter_nodes->select_all();
  511. filter_nodes->accept_event();
  512. }
  513. }
  514. }
  515. /*
  516. * Initialize ConnectDialog and populate fields with expected data.
  517. * If creating a connection from scratch, sensible defaults are used.
  518. * If editing an existing connection, previous data is retained.
  519. */
  520. void ConnectDialog::init(const ConnectionData &p_cd, const PackedStringArray &p_signal_args, bool p_edit) {
  521. set_hide_on_ok(false);
  522. source = static_cast<Node *>(p_cd.source);
  523. signal = p_cd.signal;
  524. signal_args = p_signal_args;
  525. tree->set_selected(nullptr);
  526. tree->set_marked(source);
  527. if (p_cd.target) {
  528. set_dst_node(static_cast<Node *>(p_cd.target));
  529. set_dst_method(p_cd.method);
  530. }
  531. _update_ok_enabled();
  532. bool b_deferred = (p_cd.flags & CONNECT_DEFERRED) == CONNECT_DEFERRED;
  533. bool b_oneshot = (p_cd.flags & CONNECT_ONE_SHOT) == CONNECT_ONE_SHOT;
  534. deferred->set_pressed(b_deferred);
  535. one_shot->set_pressed(b_oneshot);
  536. unbind_count->set_max(p_signal_args.size());
  537. unbind_count->set_value(p_cd.unbinds);
  538. _unbind_count_changed(p_cd.unbinds);
  539. cdbinds->params.clear();
  540. cdbinds->params = p_cd.binds;
  541. cdbinds->notify_changed();
  542. edit_mode = p_edit;
  543. source_connection_data = p_cd;
  544. }
  545. void ConnectDialog::popup_dialog(const String &p_for_signal) {
  546. from_signal->set_text(p_for_signal);
  547. warning_label->add_theme_color_override("font_color", warning_label->get_theme_color(SNAME("warning_color"), EditorStringName(Editor)));
  548. error_label->add_theme_color_override("font_color", error_label->get_theme_color(SNAME("error_color"), EditorStringName(Editor)));
  549. filter_nodes->clear();
  550. if (!advanced->is_pressed()) {
  551. error_label->set_visible(!_find_first_script(get_tree()->get_edited_scene_root(), get_tree()->get_edited_scene_root()));
  552. }
  553. if (first_popup) {
  554. first_popup = false;
  555. _advanced_pressed();
  556. }
  557. popup_centered();
  558. }
  559. void ConnectDialog::_advanced_pressed() {
  560. if (advanced->is_pressed()) {
  561. connect_to_label->set_text(TTR("Connect to Node:"));
  562. tree->set_connect_to_script_mode(false);
  563. vbc_right->show();
  564. error_label->hide();
  565. } else {
  566. reset_size();
  567. connect_to_label->set_text(TTR("Connect to Script:"));
  568. tree->set_connect_to_script_mode(true);
  569. vbc_right->hide();
  570. error_label->set_visible(!_find_first_script(get_tree()->get_edited_scene_root(), get_tree()->get_edited_scene_root()));
  571. }
  572. EditorSettings::get_singleton()->set_project_metadata("editor_metadata", "use_advanced_connections", advanced->is_pressed());
  573. popup_centered();
  574. }
  575. ConnectDialog::ConnectDialog() {
  576. set_min_size(Size2(0, 500) * EDSCALE);
  577. HBoxContainer *main_hb = memnew(HBoxContainer);
  578. add_child(main_hb);
  579. VBoxContainer *vbc_left = memnew(VBoxContainer);
  580. main_hb->add_child(vbc_left);
  581. vbc_left->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  582. vbc_left->set_custom_minimum_size(Vector2(400 * EDSCALE, 0));
  583. from_signal = memnew(LineEdit);
  584. vbc_left->add_margin_child(TTR("From Signal:"), from_signal);
  585. from_signal->set_editable(false);
  586. tree = memnew(SceneTreeEditor(false));
  587. tree->set_connecting_signal(true);
  588. tree->set_show_enabled_subscene(true);
  589. tree->set_v_size_flags(Control::SIZE_FILL | Control::SIZE_EXPAND);
  590. tree->get_scene_tree()->connect("item_activated", callable_mp(this, &ConnectDialog::_item_activated));
  591. tree->connect("node_selected", callable_mp(this, &ConnectDialog::_tree_node_selected));
  592. tree->set_connect_to_script_mode(true);
  593. HBoxContainer *hbc_filter = memnew(HBoxContainer);
  594. filter_nodes = memnew(LineEdit);
  595. hbc_filter->add_child(filter_nodes);
  596. filter_nodes->set_h_size_flags(Control::SIZE_FILL | Control::SIZE_EXPAND);
  597. filter_nodes->set_placeholder(TTR("Filter Nodes"));
  598. filter_nodes->set_clear_button_enabled(true);
  599. filter_nodes->connect("text_changed", callable_mp(tree, &SceneTreeEditor::set_filter));
  600. Button *focus_current = memnew(Button);
  601. hbc_filter->add_child(focus_current);
  602. focus_current->set_text(TTR("Go to Source"));
  603. focus_current->connect(SceneStringName(pressed), callable_mp(this, &ConnectDialog::_focus_currently_connected));
  604. Node *mc = vbc_left->add_margin_child(TTR("Connect to Script:"), hbc_filter, false);
  605. connect_to_label = Object::cast_to<Label>(vbc_left->get_child(mc->get_index() - 1));
  606. vbc_left->add_child(tree);
  607. warning_label = memnew(Label);
  608. vbc_left->add_child(warning_label);
  609. warning_label->hide();
  610. error_label = memnew(Label);
  611. error_label->set_text(TTR("Scene does not contain any script."));
  612. vbc_left->add_child(error_label);
  613. error_label->hide();
  614. method_popup = memnew(AcceptDialog);
  615. method_popup->set_title(TTR("Select Method"));
  616. method_popup->set_min_size(Vector2(400, 600) * EDSCALE);
  617. add_child(method_popup);
  618. VBoxContainer *method_vbc = memnew(VBoxContainer);
  619. method_popup->add_child(method_vbc);
  620. method_search = memnew(LineEdit);
  621. method_vbc->add_child(method_search);
  622. method_search->set_placeholder(TTR("Filter Methods"));
  623. method_search->set_clear_button_enabled(true);
  624. method_search->connect("text_changed", callable_mp(this, &ConnectDialog::_update_method_tree).unbind(1));
  625. method_tree = memnew(Tree);
  626. method_vbc->add_child(method_tree);
  627. method_tree->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  628. method_tree->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  629. method_tree->set_hide_root(true);
  630. method_tree->connect("item_selected", callable_mp(this, &ConnectDialog::_method_selected));
  631. method_tree->connect("item_activated", callable_mp((Window *)method_popup, &Window::hide));
  632. empty_tree_label = memnew(Label(TTR("No method found matching given filters.")));
  633. method_popup->add_child(empty_tree_label);
  634. empty_tree_label->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_CENTER);
  635. empty_tree_label->set_vertical_alignment(VERTICAL_ALIGNMENT_CENTER);
  636. empty_tree_label->set_autowrap_mode(TextServer::AUTOWRAP_WORD);
  637. script_methods_only = memnew(CheckButton(TTR("Script Methods Only")));
  638. method_vbc->add_child(script_methods_only);
  639. script_methods_only->set_h_size_flags(Control::SIZE_SHRINK_END);
  640. script_methods_only->set_pressed(EditorSettings::get_singleton()->get_project_metadata("editor_metadata", "show_script_methods_only", true));
  641. script_methods_only->connect(SceneStringName(pressed), callable_mp(this, &ConnectDialog::_method_check_button_pressed).bind(script_methods_only));
  642. compatible_methods_only = memnew(CheckButton(TTR("Compatible Methods Only")));
  643. method_vbc->add_child(compatible_methods_only);
  644. compatible_methods_only->set_h_size_flags(Control::SIZE_SHRINK_END);
  645. compatible_methods_only->set_pressed(EditorSettings::get_singleton()->get_project_metadata("editor_metadata", "show_compatible_methods_only", true));
  646. compatible_methods_only->connect(SceneStringName(pressed), callable_mp(this, &ConnectDialog::_method_check_button_pressed).bind(compatible_methods_only));
  647. vbc_right = memnew(VBoxContainer);
  648. main_hb->add_child(vbc_right);
  649. vbc_right->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  650. vbc_right->set_custom_minimum_size(Vector2(150 * EDSCALE, 0));
  651. vbc_right->hide();
  652. HBoxContainer *add_bind_hb = memnew(HBoxContainer);
  653. type_list = memnew(OptionButton);
  654. type_list->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  655. add_bind_hb->add_child(type_list);
  656. for (int i = 0; i < Variant::VARIANT_MAX; i++) {
  657. if (i == Variant::NIL || i == Variant::OBJECT || i == Variant::CALLABLE || i == Variant::SIGNAL || i == Variant::RID) {
  658. // These types can't be constructed or serialized properly, so skip them.
  659. continue;
  660. }
  661. type_list->add_item(Variant::get_type_name(Variant::Type(i)), i);
  662. }
  663. bind_controls.push_back(type_list);
  664. Button *add_bind = memnew(Button);
  665. add_bind->set_text(TTR("Add"));
  666. add_bind_hb->add_child(add_bind);
  667. add_bind->connect(SceneStringName(pressed), callable_mp(this, &ConnectDialog::_add_bind));
  668. bind_controls.push_back(add_bind);
  669. Button *del_bind = memnew(Button);
  670. del_bind->set_text(TTR("Remove"));
  671. add_bind_hb->add_child(del_bind);
  672. del_bind->connect(SceneStringName(pressed), callable_mp(this, &ConnectDialog::_remove_bind));
  673. bind_controls.push_back(del_bind);
  674. vbc_right->add_margin_child(TTR("Add Extra Call Argument:"), add_bind_hb);
  675. bind_editor = memnew(EditorInspector);
  676. bind_controls.push_back(bind_editor);
  677. vbc_right->add_margin_child(TTR("Extra Call Arguments:"), bind_editor, true);
  678. unbind_count = memnew(SpinBox);
  679. unbind_count->set_tooltip_text(TTR("Allows to drop arguments sent by signal emitter."));
  680. unbind_count->connect("value_changed", callable_mp(this, &ConnectDialog::_unbind_count_changed));
  681. vbc_right->add_margin_child(TTR("Unbind Signal Arguments:"), unbind_count);
  682. HBoxContainer *hbc_method = memnew(HBoxContainer);
  683. vbc_left->add_margin_child(TTR("Receiver Method:"), hbc_method);
  684. dst_method = memnew(LineEdit);
  685. dst_method->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  686. dst_method->connect("text_changed", callable_mp(method_tree, &Tree::deselect_all).unbind(1));
  687. hbc_method->add_child(dst_method);
  688. register_text_enter(dst_method);
  689. open_method_tree = memnew(Button);
  690. hbc_method->add_child(open_method_tree);
  691. open_method_tree->set_text("Pick");
  692. open_method_tree->connect(SceneStringName(pressed), callable_mp(this, &ConnectDialog::_open_method_popup));
  693. advanced = memnew(CheckButton(TTR("Advanced")));
  694. vbc_left->add_child(advanced);
  695. advanced->set_h_size_flags(Control::SIZE_SHRINK_BEGIN | Control::SIZE_EXPAND);
  696. advanced->set_pressed(EditorSettings::get_singleton()->get_project_metadata("editor_metadata", "use_advanced_connections", false));
  697. advanced->connect(SceneStringName(pressed), callable_mp(this, &ConnectDialog::_advanced_pressed));
  698. HBoxContainer *hbox = memnew(HBoxContainer);
  699. vbc_right->add_child(hbox);
  700. deferred = memnew(CheckBox);
  701. deferred->set_h_size_flags(0);
  702. deferred->set_text(TTR("Deferred"));
  703. deferred->set_tooltip_text(TTR("Defers the signal, storing it in a queue and only firing it at idle time."));
  704. hbox->add_child(deferred);
  705. one_shot = memnew(CheckBox);
  706. one_shot->set_h_size_flags(0);
  707. one_shot->set_text(TTR("One Shot"));
  708. one_shot->set_tooltip_text(TTR("Disconnects the signal after its first emission."));
  709. hbox->add_child(one_shot);
  710. cdbinds = memnew(ConnectDialogBinds);
  711. error = memnew(AcceptDialog);
  712. add_child(error);
  713. error->set_title(TTR("Cannot connect signal"));
  714. error->set_ok_button_text(TTR("Close"));
  715. set_ok_button_text(TTR("Connect"));
  716. }
  717. ConnectDialog::~ConnectDialog() {
  718. memdelete(cdbinds);
  719. }
  720. //////////////////////////////////////////
  721. Control *ConnectionsDockTree::make_custom_tooltip(const String &p_text) const {
  722. // If it's not a doc tooltip, fallback to the default one.
  723. if (p_text.contains("::")) {
  724. return nullptr;
  725. }
  726. EditorHelpBit *help_bit = memnew(EditorHelpBit(p_text));
  727. EditorHelpBitTooltip::show_tooltip(help_bit, const_cast<ConnectionsDockTree *>(this));
  728. return memnew(Control); // Make the standard tooltip invisible.
  729. }
  730. struct _ConnectionsDockMethodInfoSort {
  731. _FORCE_INLINE_ bool operator()(const MethodInfo &a, const MethodInfo &b) const {
  732. return a.name < b.name;
  733. }
  734. };
  735. void ConnectionsDock::_filter_changed(const String &p_text) {
  736. update_tree();
  737. }
  738. /*
  739. * Post-ConnectDialog callback for creating/editing connections.
  740. * Creates or edits connections based on state of the ConnectDialog when "Connect" is pressed.
  741. */
  742. void ConnectionsDock::_make_or_edit_connection() {
  743. NodePath dst_path = connect_dialog->get_dst_path();
  744. Node *target = selected_node->get_node(dst_path);
  745. ERR_FAIL_NULL(target);
  746. ConnectDialog::ConnectionData cd;
  747. cd.source = connect_dialog->get_source();
  748. cd.target = target;
  749. cd.signal = connect_dialog->get_signal_name();
  750. cd.method = connect_dialog->get_dst_method_name();
  751. cd.unbinds = connect_dialog->get_unbinds();
  752. if (cd.unbinds == 0) {
  753. cd.binds = connect_dialog->get_binds();
  754. }
  755. bool b_deferred = connect_dialog->get_deferred();
  756. bool b_oneshot = connect_dialog->get_one_shot();
  757. cd.flags = CONNECT_PERSIST | (b_deferred ? CONNECT_DEFERRED : 0) | (b_oneshot ? CONNECT_ONE_SHOT : 0);
  758. // If the function is found in target's own script, check the editor setting
  759. // to determine if the script should be opened.
  760. // If the function is found in an inherited class or script no need to do anything
  761. // except making a connection.
  762. bool add_script_function_request = false;
  763. Ref<Script> scr = target->get_script();
  764. if (scr.is_valid() && !ClassDB::has_method(target->get_class(), cd.method)) {
  765. // Check in target's own script.
  766. int line = scr->get_language()->find_function(cd.method, scr->get_source_code());
  767. if (line != -1) {
  768. add_script_function_request = EDITOR_GET("text_editor/behavior/navigation/open_script_when_connecting_signal_to_existing_method");
  769. } else {
  770. // There is a chance that the method is inherited from another script.
  771. bool found_inherited_function = false;
  772. Ref<Script> inherited_scr = scr->get_base_script();
  773. while (inherited_scr.is_valid()) {
  774. int inherited_line = inherited_scr->get_language()->find_function(cd.method, inherited_scr->get_source_code());
  775. if (inherited_line != -1) {
  776. found_inherited_function = true;
  777. break;
  778. }
  779. inherited_scr = inherited_scr->get_base_script();
  780. }
  781. add_script_function_request = !found_inherited_function;
  782. }
  783. }
  784. if (connect_dialog->is_editing()) {
  785. _disconnect(connect_dialog->get_source_connection_data());
  786. _connect(cd);
  787. } else {
  788. _connect(cd);
  789. }
  790. if (add_script_function_request) {
  791. PackedStringArray script_function_args = connect_dialog->get_signal_args();
  792. script_function_args.resize(script_function_args.size() - cd.unbinds);
  793. for (int i = 0; i < cd.binds.size(); i++) {
  794. script_function_args.push_back("extra_arg_" + itos(i) + ":" + Variant::get_type_name(cd.binds[i].get_type()));
  795. }
  796. EditorNode::get_singleton()->emit_signal(SNAME("script_add_function_request"), target, cd.method, script_function_args);
  797. hide();
  798. }
  799. update_tree();
  800. }
  801. /*
  802. * Creates single connection w/ undo-redo functionality.
  803. */
  804. void ConnectionsDock::_connect(const ConnectDialog::ConnectionData &p_cd) {
  805. Node *source = Object::cast_to<Node>(p_cd.source);
  806. Node *target = Object::cast_to<Node>(p_cd.target);
  807. if (!source || !target) {
  808. return;
  809. }
  810. Callable callable = p_cd.get_callable();
  811. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  812. undo_redo->create_action(vformat(TTR("Connect '%s' to '%s'"), String(p_cd.signal), String(p_cd.method)));
  813. undo_redo->add_do_method(source, "connect", p_cd.signal, callable, p_cd.flags);
  814. undo_redo->add_undo_method(source, "disconnect", p_cd.signal, callable);
  815. undo_redo->add_do_method(this, "update_tree");
  816. undo_redo->add_undo_method(this, "update_tree");
  817. undo_redo->add_do_method(SceneTreeDock::get_singleton()->get_tree_editor(), "update_tree"); // To force redraw of scene tree.
  818. undo_redo->add_undo_method(SceneTreeDock::get_singleton()->get_tree_editor(), "update_tree");
  819. undo_redo->commit_action();
  820. }
  821. /*
  822. * Break single connection w/ undo-redo functionality.
  823. */
  824. void ConnectionsDock::_disconnect(const ConnectDialog::ConnectionData &p_cd) {
  825. ERR_FAIL_COND(p_cd.source != selected_node); // Shouldn't happen but... Bugcheck.
  826. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  827. undo_redo->create_action(vformat(TTR("Disconnect '%s' from '%s'"), p_cd.signal, p_cd.method));
  828. Callable callable = p_cd.get_callable();
  829. undo_redo->add_do_method(selected_node, "disconnect", p_cd.signal, callable);
  830. undo_redo->add_undo_method(selected_node, "connect", p_cd.signal, callable, p_cd.flags);
  831. undo_redo->add_do_method(this, "update_tree");
  832. undo_redo->add_undo_method(this, "update_tree");
  833. undo_redo->add_do_method(SceneTreeDock::get_singleton()->get_tree_editor(), "update_tree"); // To force redraw of scene tree.
  834. undo_redo->add_undo_method(SceneTreeDock::get_singleton()->get_tree_editor(), "update_tree");
  835. undo_redo->commit_action();
  836. }
  837. /*
  838. * Break all connections of currently selected signal.
  839. * Can undo-redo as a single action.
  840. */
  841. void ConnectionsDock::_disconnect_all() {
  842. TreeItem *item = tree->get_selected();
  843. if (!item || _get_item_type(*item) != TREE_ITEM_TYPE_SIGNAL) {
  844. return;
  845. }
  846. TreeItem *child = item->get_first_child();
  847. String signal_name = item->get_metadata(0).operator Dictionary()["name"];
  848. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  849. undo_redo->create_action(vformat(TTR("Disconnect all from signal: '%s'"), signal_name));
  850. while (child) {
  851. Connection connection = child->get_metadata(0);
  852. if (!_is_connection_inherited(connection)) {
  853. ConnectDialog::ConnectionData cd = connection;
  854. undo_redo->add_do_method(selected_node, "disconnect", cd.signal, cd.get_callable());
  855. undo_redo->add_undo_method(selected_node, "connect", cd.signal, cd.get_callable(), cd.flags);
  856. }
  857. child = child->get_next();
  858. }
  859. undo_redo->add_do_method(this, "update_tree");
  860. undo_redo->add_undo_method(this, "update_tree");
  861. undo_redo->add_do_method(SceneTreeDock::get_singleton()->get_tree_editor(), "update_tree");
  862. undo_redo->add_undo_method(SceneTreeDock::get_singleton()->get_tree_editor(), "update_tree");
  863. undo_redo->commit_action();
  864. }
  865. void ConnectionsDock::_tree_item_selected() {
  866. TreeItem *item = tree->get_selected();
  867. if (item && _get_item_type(*item) == TREE_ITEM_TYPE_SIGNAL) {
  868. connect_button->set_text(TTR("Connect..."));
  869. connect_button->set_icon(get_editor_theme_icon(SNAME("Instance")));
  870. connect_button->set_disabled(false);
  871. } else if (item && _get_item_type(*item) == TREE_ITEM_TYPE_CONNECTION) {
  872. connect_button->set_text(TTR("Disconnect"));
  873. connect_button->set_icon(get_editor_theme_icon(SNAME("Unlinked")));
  874. Object::Connection connection = item->get_metadata(0);
  875. connect_button->set_disabled(_is_connection_inherited(connection));
  876. } else {
  877. connect_button->set_text(TTR("Connect..."));
  878. connect_button->set_icon(get_editor_theme_icon(SNAME("Instance")));
  879. connect_button->set_disabled(true);
  880. }
  881. }
  882. void ConnectionsDock::_tree_item_activated() { // "Activation" on double-click.
  883. TreeItem *item = tree->get_selected();
  884. if (!item) {
  885. return;
  886. }
  887. if (_get_item_type(*item) == TREE_ITEM_TYPE_SIGNAL) {
  888. _open_connection_dialog(*item);
  889. } else if (_get_item_type(*item) == TREE_ITEM_TYPE_CONNECTION) {
  890. _go_to_method(*item);
  891. }
  892. }
  893. ConnectionsDock::TreeItemType ConnectionsDock::_get_item_type(const TreeItem &p_item) const {
  894. if (&p_item == tree->get_root()) {
  895. return TREE_ITEM_TYPE_ROOT;
  896. } else if (p_item.get_parent() == tree->get_root()) {
  897. return TREE_ITEM_TYPE_CLASS;
  898. } else if (p_item.get_parent()->get_parent() == tree->get_root()) {
  899. return TREE_ITEM_TYPE_SIGNAL;
  900. } else {
  901. return TREE_ITEM_TYPE_CONNECTION;
  902. }
  903. }
  904. bool ConnectionsDock::_is_connection_inherited(Connection &p_connection) {
  905. return bool(p_connection.flags & CONNECT_INHERITED);
  906. }
  907. /*
  908. * Open connection dialog with TreeItem data to CREATE a brand-new connection.
  909. */
  910. void ConnectionsDock::_open_connection_dialog(TreeItem &p_item) {
  911. Dictionary sinfo = p_item.get_metadata(0);
  912. String signal_name = sinfo["name"];
  913. PackedStringArray signal_args = sinfo["args"];
  914. Node *dst_node = selected_node->get_owner() ? selected_node->get_owner() : selected_node;
  915. if (!dst_node || dst_node->get_script().is_null()) {
  916. dst_node = _find_first_script(get_tree()->get_edited_scene_root(), get_tree()->get_edited_scene_root());
  917. }
  918. ConnectDialog::ConnectionData cd;
  919. cd.source = selected_node;
  920. cd.signal = StringName(signal_name);
  921. cd.target = dst_node;
  922. cd.method = ConnectDialog::generate_method_callback_name(cd.source, signal_name, cd.target);
  923. connect_dialog->init(cd, signal_args);
  924. connect_dialog->set_title(TTR("Connect a Signal to a Method"));
  925. connect_dialog->popup_dialog(signal_name + "(" + String(", ").join(signal_args) + ")");
  926. }
  927. /*
  928. * Open connection dialog with Connection data to EDIT an existing connection.
  929. */
  930. void ConnectionsDock::_open_edit_connection_dialog(TreeItem &p_item) {
  931. TreeItem *signal_item = p_item.get_parent();
  932. ERR_FAIL_NULL(signal_item);
  933. Connection connection = p_item.get_metadata(0);
  934. ConnectDialog::ConnectionData cd = connection;
  935. Node *src = Object::cast_to<Node>(cd.source);
  936. Node *dst = Object::cast_to<Node>(cd.target);
  937. if (src && dst) {
  938. const String &signal_name_ref = cd.signal;
  939. PackedStringArray signal_args = signal_item->get_metadata(0).operator Dictionary()["args"];
  940. connect_dialog->set_title(vformat(TTR("Edit Connection: '%s'"), cd.signal));
  941. connect_dialog->popup_dialog(signal_name_ref);
  942. connect_dialog->init(cd, signal_args, true);
  943. }
  944. }
  945. /*
  946. * Open slot method location in script editor.
  947. */
  948. void ConnectionsDock::_go_to_method(TreeItem &p_item) {
  949. if (_get_item_type(p_item) != TREE_ITEM_TYPE_CONNECTION) {
  950. return;
  951. }
  952. Connection connection = p_item.get_metadata(0);
  953. ConnectDialog::ConnectionData cd = connection;
  954. ERR_FAIL_COND(cd.source != selected_node); // Shouldn't happen but... bugcheck.
  955. if (!cd.target) {
  956. return;
  957. }
  958. Ref<Script> scr = cd.target->get_script();
  959. if (scr.is_null()) {
  960. return;
  961. }
  962. if (scr.is_valid() && ScriptEditor::get_singleton()->script_goto_method(scr, cd.method)) {
  963. EditorNode::get_singleton()->editor_select(EditorNode::EDITOR_SCRIPT);
  964. }
  965. }
  966. void ConnectionsDock::_handle_class_menu_option(int p_option) {
  967. switch (p_option) {
  968. case CLASS_MENU_OPEN_DOCS:
  969. ScriptEditor::get_singleton()->goto_help("class:" + class_menu_doc_class_name);
  970. EditorNode::get_singleton()->set_visible_editor(EditorNode::EDITOR_SCRIPT);
  971. break;
  972. }
  973. }
  974. void ConnectionsDock::_class_menu_about_to_popup() {
  975. class_menu->set_item_disabled(class_menu->get_item_index(CLASS_MENU_OPEN_DOCS), class_menu_doc_class_name.is_empty());
  976. }
  977. void ConnectionsDock::_handle_signal_menu_option(int p_option) {
  978. TreeItem *item = tree->get_selected();
  979. if (!item || _get_item_type(*item) != TREE_ITEM_TYPE_SIGNAL) {
  980. return;
  981. }
  982. Dictionary meta = item->get_metadata(0);
  983. switch (p_option) {
  984. case SIGNAL_MENU_CONNECT: {
  985. _open_connection_dialog(*item);
  986. } break;
  987. case SIGNAL_MENU_DISCONNECT_ALL: {
  988. disconnect_all_dialog->set_text(vformat(TTR("Are you sure you want to remove all connections from the \"%s\" signal?"), meta["name"]));
  989. disconnect_all_dialog->popup_centered();
  990. } break;
  991. case SIGNAL_MENU_COPY_NAME: {
  992. DisplayServer::get_singleton()->clipboard_set(meta["name"]);
  993. } break;
  994. case SIGNAL_MENU_OPEN_DOCS: {
  995. ScriptEditor::get_singleton()->goto_help("class_signal:" + String(meta["class"]) + ":" + String(meta["name"]));
  996. EditorNode::get_singleton()->set_visible_editor(EditorNode::EDITOR_SCRIPT);
  997. } break;
  998. }
  999. }
  1000. void ConnectionsDock::_signal_menu_about_to_popup() {
  1001. TreeItem *item = tree->get_selected();
  1002. if (!item || _get_item_type(*item) != TREE_ITEM_TYPE_SIGNAL) {
  1003. return;
  1004. }
  1005. Dictionary meta = item->get_metadata(0);
  1006. bool disable_disconnect_all = true;
  1007. for (int i = 0; i < item->get_child_count(); i++) {
  1008. if (!item->get_child(i)->has_meta("_inherited_connection")) {
  1009. disable_disconnect_all = false;
  1010. }
  1011. }
  1012. signal_menu->set_item_disabled(signal_menu->get_item_index(SIGNAL_MENU_DISCONNECT_ALL), disable_disconnect_all);
  1013. signal_menu->set_item_disabled(signal_menu->get_item_index(SIGNAL_MENU_OPEN_DOCS), String(meta["class"]).is_empty());
  1014. }
  1015. void ConnectionsDock::_handle_slot_menu_option(int p_option) {
  1016. TreeItem *item = tree->get_selected();
  1017. if (!item || _get_item_type(*item) != TREE_ITEM_TYPE_CONNECTION) {
  1018. return;
  1019. }
  1020. switch (p_option) {
  1021. case SLOT_MENU_EDIT: {
  1022. _open_edit_connection_dialog(*item);
  1023. } break;
  1024. case SLOT_MENU_GO_TO_METHOD: {
  1025. _go_to_method(*item);
  1026. } break;
  1027. case SLOT_MENU_DISCONNECT: {
  1028. Connection connection = item->get_metadata(0);
  1029. _disconnect(connection);
  1030. update_tree();
  1031. } break;
  1032. }
  1033. }
  1034. void ConnectionsDock::_slot_menu_about_to_popup() {
  1035. TreeItem *item = tree->get_selected();
  1036. if (!item || _get_item_type(*item) != TREE_ITEM_TYPE_CONNECTION) {
  1037. return;
  1038. }
  1039. bool connection_is_inherited = item->has_meta("_inherited_connection");
  1040. slot_menu->set_item_disabled(slot_menu->get_item_index(SLOT_MENU_EDIT), connection_is_inherited);
  1041. slot_menu->set_item_disabled(slot_menu->get_item_index(SLOT_MENU_DISCONNECT), connection_is_inherited);
  1042. }
  1043. void ConnectionsDock::_tree_gui_input(const Ref<InputEvent> &p_event) {
  1044. const Ref<InputEventKey> &key = p_event;
  1045. if (key.is_valid() && key->is_pressed() && !key->is_echo()) {
  1046. if (ED_IS_SHORTCUT("connections_editor/disconnect", p_event)) {
  1047. TreeItem *item = tree->get_selected();
  1048. if (item && _get_item_type(*item) == TREE_ITEM_TYPE_CONNECTION) {
  1049. Connection connection = item->get_metadata(0);
  1050. _disconnect(connection);
  1051. update_tree();
  1052. // Stop the Delete input from propagating elsewhere.
  1053. accept_event();
  1054. return;
  1055. }
  1056. } else if (ED_IS_SHORTCUT("editor/open_search", p_event)) {
  1057. search_box->grab_focus();
  1058. search_box->select_all();
  1059. accept_event();
  1060. return;
  1061. }
  1062. }
  1063. // Handle RMB press.
  1064. const Ref<InputEventMouseButton> &mb_event = p_event;
  1065. if (mb_event.is_valid() && mb_event->is_pressed() && mb_event->get_button_index() == MouseButton::RIGHT) {
  1066. TreeItem *item = tree->get_item_at_position(mb_event->get_position());
  1067. if (!item) {
  1068. return;
  1069. }
  1070. if (item->is_selectable(0)) {
  1071. // Update selection now, before `about_to_popup` signal. Needed for SIGNAL and CONNECTION context menus.
  1072. tree->set_selected(item);
  1073. }
  1074. Vector2 screen_position = tree->get_screen_position() + mb_event->get_position();
  1075. switch (_get_item_type(*item)) {
  1076. case TREE_ITEM_TYPE_ROOT:
  1077. break;
  1078. case TREE_ITEM_TYPE_CLASS:
  1079. class_menu_doc_class_name = item->get_metadata(0);
  1080. class_menu->set_position(screen_position);
  1081. class_menu->reset_size();
  1082. class_menu->popup();
  1083. accept_event(); // Don't collapse item.
  1084. break;
  1085. case TREE_ITEM_TYPE_SIGNAL:
  1086. signal_menu->set_position(screen_position);
  1087. signal_menu->reset_size();
  1088. signal_menu->popup();
  1089. break;
  1090. case TREE_ITEM_TYPE_CONNECTION:
  1091. slot_menu->set_position(screen_position);
  1092. slot_menu->reset_size();
  1093. slot_menu->popup();
  1094. break;
  1095. }
  1096. }
  1097. }
  1098. void ConnectionsDock::_close() {
  1099. hide();
  1100. }
  1101. void ConnectionsDock::_connect_pressed() {
  1102. TreeItem *item = tree->get_selected();
  1103. if (!item) {
  1104. connect_button->set_disabled(true);
  1105. return;
  1106. }
  1107. if (_get_item_type(*item) == TREE_ITEM_TYPE_SIGNAL) {
  1108. _open_connection_dialog(*item);
  1109. } else if (_get_item_type(*item) == TREE_ITEM_TYPE_CONNECTION) {
  1110. Connection connection = item->get_metadata(0);
  1111. _disconnect(connection);
  1112. update_tree();
  1113. }
  1114. }
  1115. void ConnectionsDock::_notification(int p_what) {
  1116. switch (p_what) {
  1117. case NOTIFICATION_ENTER_TREE:
  1118. case NOTIFICATION_THEME_CHANGED: {
  1119. search_box->set_right_icon(get_editor_theme_icon(SNAME("Search")));
  1120. class_menu->set_item_icon(class_menu->get_item_index(CLASS_MENU_OPEN_DOCS), get_editor_theme_icon(SNAME("Help")));
  1121. signal_menu->set_item_icon(signal_menu->get_item_index(SIGNAL_MENU_CONNECT), get_editor_theme_icon(SNAME("Instance")));
  1122. signal_menu->set_item_icon(signal_menu->get_item_index(SIGNAL_MENU_DISCONNECT_ALL), get_editor_theme_icon(SNAME("Unlinked")));
  1123. signal_menu->set_item_icon(signal_menu->get_item_index(SIGNAL_MENU_COPY_NAME), get_editor_theme_icon(SNAME("ActionCopy")));
  1124. signal_menu->set_item_icon(signal_menu->get_item_index(SIGNAL_MENU_OPEN_DOCS), get_editor_theme_icon(SNAME("Help")));
  1125. slot_menu->set_item_icon(slot_menu->get_item_index(SLOT_MENU_EDIT), get_editor_theme_icon(SNAME("Edit")));
  1126. slot_menu->set_item_icon(slot_menu->get_item_index(SLOT_MENU_GO_TO_METHOD), get_editor_theme_icon(SNAME("ArrowRight")));
  1127. slot_menu->set_item_icon(slot_menu->get_item_index(SLOT_MENU_DISCONNECT), get_editor_theme_icon(SNAME("Unlinked")));
  1128. tree->add_theme_constant_override("icon_max_width", get_theme_constant(SNAME("class_icon_size"), EditorStringName(Editor)));
  1129. } break;
  1130. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  1131. if (EditorSettings::get_singleton()->check_changed_settings_in_group("interface/editors")) {
  1132. update_tree();
  1133. }
  1134. } break;
  1135. }
  1136. }
  1137. void ConnectionsDock::_bind_methods() {
  1138. ClassDB::bind_method("update_tree", &ConnectionsDock::update_tree);
  1139. }
  1140. void ConnectionsDock::set_node(Node *p_node) {
  1141. selected_node = p_node;
  1142. update_tree();
  1143. }
  1144. void ConnectionsDock::update_tree() {
  1145. String prev_selected;
  1146. if (tree->is_anything_selected()) {
  1147. prev_selected = tree->get_selected()->get_text(0);
  1148. }
  1149. tree->clear();
  1150. if (!selected_node) {
  1151. return;
  1152. }
  1153. TreeItem *root = tree->create_item();
  1154. DocTools *doc_data = EditorHelp::get_doc_data();
  1155. EditorData &editor_data = EditorNode::get_editor_data();
  1156. StringName native_base = selected_node->get_class();
  1157. Ref<Script> script_base = selected_node->get_script();
  1158. while (native_base != StringName()) {
  1159. String class_name;
  1160. String doc_class_name;
  1161. Ref<Texture2D> class_icon;
  1162. List<MethodInfo> class_signals;
  1163. if (script_base.is_valid()) {
  1164. class_name = script_base->get_global_name();
  1165. if (class_name.is_empty()) {
  1166. class_name = script_base->get_path().get_file();
  1167. }
  1168. doc_class_name = script_base->get_global_name();
  1169. if (doc_class_name.is_empty()) {
  1170. doc_class_name = script_base->get_path().trim_prefix("res://").quote();
  1171. }
  1172. if (!doc_class_name.is_empty() && !doc_data->class_list.find(doc_class_name)) {
  1173. doc_class_name = String();
  1174. }
  1175. class_icon = editor_data.get_script_icon(script_base);
  1176. if (class_icon.is_null() && has_theme_icon(native_base, EditorStringName(EditorIcons))) {
  1177. class_icon = get_editor_theme_icon(native_base);
  1178. }
  1179. script_base->get_script_signal_list(&class_signals);
  1180. // TODO: Core: Add optional parameter to ignore base classes (no_inheritance like in ClassDB).
  1181. Ref<Script> base = script_base->get_base_script();
  1182. if (base.is_valid()) {
  1183. List<MethodInfo> base_signals;
  1184. base->get_script_signal_list(&base_signals);
  1185. HashSet<String> base_signal_names;
  1186. for (List<MethodInfo>::Element *F = base_signals.front(); F; F = F->next()) {
  1187. base_signal_names.insert(F->get().name);
  1188. }
  1189. for (List<MethodInfo>::Element *F = class_signals.front(); F; F = F->next()) {
  1190. if (base_signal_names.has(F->get().name)) {
  1191. class_signals.erase(F);
  1192. }
  1193. }
  1194. }
  1195. script_base = base;
  1196. } else {
  1197. class_name = native_base;
  1198. doc_class_name = native_base;
  1199. if (!doc_data->class_list.find(doc_class_name)) {
  1200. doc_class_name = String();
  1201. }
  1202. if (has_theme_icon(native_base, EditorStringName(EditorIcons))) {
  1203. class_icon = get_editor_theme_icon(native_base);
  1204. }
  1205. ClassDB::get_signal_list(native_base, &class_signals, true);
  1206. native_base = ClassDB::get_parent_class(native_base);
  1207. }
  1208. if (class_icon.is_null()) {
  1209. class_icon = get_editor_theme_icon(SNAME("Object"));
  1210. }
  1211. TreeItem *section_item = nullptr;
  1212. // Create subsections.
  1213. if (!class_signals.is_empty()) {
  1214. class_signals.sort();
  1215. section_item = tree->create_item(root);
  1216. section_item->set_text(0, class_name);
  1217. // `|` separators used in `EditorHelpBit`.
  1218. section_item->set_tooltip_text(0, "class|" + doc_class_name + "|");
  1219. section_item->set_icon(0, class_icon);
  1220. section_item->set_selectable(0, false);
  1221. section_item->set_editable(0, false);
  1222. section_item->set_custom_bg_color(0, get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor)));
  1223. section_item->set_metadata(0, doc_class_name);
  1224. }
  1225. for (MethodInfo &mi : class_signals) {
  1226. const StringName &signal_name = mi.name;
  1227. if (!search_box->get_text().is_subsequence_ofn(signal_name)) {
  1228. continue;
  1229. }
  1230. PackedStringArray argnames;
  1231. // Create the children of the subsection - the actual list of signals.
  1232. TreeItem *signal_item = tree->create_item(section_item);
  1233. String signame = connect_dialog->get_signature(mi, &argnames);
  1234. signal_item->set_text(0, signame);
  1235. if (signame == prev_selected) {
  1236. signal_item->select(0);
  1237. prev_selected = "";
  1238. }
  1239. Dictionary sinfo;
  1240. sinfo["class"] = doc_class_name;
  1241. sinfo["name"] = signal_name;
  1242. sinfo["args"] = argnames;
  1243. signal_item->set_metadata(0, sinfo);
  1244. signal_item->set_icon(0, get_editor_theme_icon(SNAME("Signal")));
  1245. // `|` separators used in `EditorHelpBit`.
  1246. signal_item->set_tooltip_text(0, "signal|" + doc_class_name + "|" + String(signal_name));
  1247. // List existing connections.
  1248. List<Object::Connection> existing_connections;
  1249. selected_node->get_signal_connection_list(signal_name, &existing_connections);
  1250. for (const Object::Connection &F : existing_connections) {
  1251. Connection connection = F;
  1252. if (!(connection.flags & CONNECT_PERSIST)) {
  1253. continue;
  1254. }
  1255. ConnectDialog::ConnectionData cd = connection;
  1256. Node *target = Object::cast_to<Node>(cd.target);
  1257. if (!target) {
  1258. continue;
  1259. }
  1260. String path = String(selected_node->get_path_to(target)) + " :: " + cd.method + "()";
  1261. if (cd.flags & CONNECT_DEFERRED) {
  1262. path += " (deferred)";
  1263. }
  1264. if (cd.flags & CONNECT_ONE_SHOT) {
  1265. path += " (one-shot)";
  1266. }
  1267. if (cd.unbinds > 0) {
  1268. path += " unbinds(" + itos(cd.unbinds) + ")";
  1269. } else if (!cd.binds.is_empty()) {
  1270. path += " binds(";
  1271. for (int i = 0; i < cd.binds.size(); i++) {
  1272. if (i > 0) {
  1273. path += ", ";
  1274. }
  1275. path += cd.binds[i].operator String();
  1276. }
  1277. path += ")";
  1278. }
  1279. TreeItem *connection_item = tree->create_item(signal_item);
  1280. connection_item->set_text(0, path);
  1281. connection_item->set_metadata(0, connection);
  1282. connection_item->set_icon(0, get_editor_theme_icon(SNAME("Slot")));
  1283. if (_is_connection_inherited(connection)) {
  1284. // The scene inherits this connection.
  1285. connection_item->set_custom_color(0, get_theme_color(SNAME("warning_color"), EditorStringName(Editor)));
  1286. connection_item->set_meta("_inherited_connection", true);
  1287. }
  1288. }
  1289. }
  1290. }
  1291. connect_button->set_text(TTR("Connect..."));
  1292. connect_button->set_icon(get_editor_theme_icon(SNAME("Instance")));
  1293. connect_button->set_disabled(true);
  1294. }
  1295. ConnectionsDock::ConnectionsDock() {
  1296. set_name(TTR("Signals"));
  1297. VBoxContainer *vbc = this;
  1298. search_box = memnew(LineEdit);
  1299. search_box->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  1300. search_box->set_placeholder(TTR("Filter Signals"));
  1301. search_box->set_clear_button_enabled(true);
  1302. search_box->connect("text_changed", callable_mp(this, &ConnectionsDock::_filter_changed));
  1303. vbc->add_child(search_box);
  1304. tree = memnew(ConnectionsDockTree);
  1305. tree->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  1306. tree->set_columns(1);
  1307. tree->set_select_mode(Tree::SELECT_ROW);
  1308. tree->set_hide_root(true);
  1309. tree->set_column_clip_content(0, true);
  1310. vbc->add_child(tree);
  1311. tree->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  1312. tree->set_allow_rmb_select(true);
  1313. connect_button = memnew(Button);
  1314. HBoxContainer *hb = memnew(HBoxContainer);
  1315. vbc->add_child(hb);
  1316. hb->add_spacer();
  1317. hb->add_child(connect_button);
  1318. connect_button->connect(SceneStringName(pressed), callable_mp(this, &ConnectionsDock::_connect_pressed));
  1319. connect_dialog = memnew(ConnectDialog);
  1320. connect_dialog->connect("connected", callable_mp(NodeDock::get_singleton(), &NodeDock::restore_last_valid_node), CONNECT_DEFERRED);
  1321. connect_dialog->set_process_shortcut_input(true);
  1322. add_child(connect_dialog);
  1323. disconnect_all_dialog = memnew(ConfirmationDialog);
  1324. add_child(disconnect_all_dialog);
  1325. disconnect_all_dialog->connect("confirmed", callable_mp(this, &ConnectionsDock::_disconnect_all));
  1326. disconnect_all_dialog->set_text(TTR("Are you sure you want to remove all connections from this signal?"));
  1327. class_menu = memnew(PopupMenu);
  1328. class_menu->connect("id_pressed", callable_mp(this, &ConnectionsDock::_handle_class_menu_option));
  1329. class_menu->connect("about_to_popup", callable_mp(this, &ConnectionsDock::_class_menu_about_to_popup));
  1330. class_menu->add_item(TTR("Open Documentation"), CLASS_MENU_OPEN_DOCS);
  1331. add_child(class_menu);
  1332. signal_menu = memnew(PopupMenu);
  1333. signal_menu->connect("id_pressed", callable_mp(this, &ConnectionsDock::_handle_signal_menu_option));
  1334. signal_menu->connect("about_to_popup", callable_mp(this, &ConnectionsDock::_signal_menu_about_to_popup));
  1335. signal_menu->add_item(TTR("Connect..."), SIGNAL_MENU_CONNECT);
  1336. signal_menu->add_item(TTR("Disconnect All"), SIGNAL_MENU_DISCONNECT_ALL);
  1337. signal_menu->add_item(TTR("Copy Name"), SIGNAL_MENU_COPY_NAME);
  1338. signal_menu->add_separator();
  1339. signal_menu->add_item(TTR("Open Documentation"), SIGNAL_MENU_OPEN_DOCS);
  1340. add_child(signal_menu);
  1341. slot_menu = memnew(PopupMenu);
  1342. slot_menu->connect("id_pressed", callable_mp(this, &ConnectionsDock::_handle_slot_menu_option));
  1343. slot_menu->connect("about_to_popup", callable_mp(this, &ConnectionsDock::_slot_menu_about_to_popup));
  1344. slot_menu->add_item(TTR("Edit..."), SLOT_MENU_EDIT);
  1345. slot_menu->add_item(TTR("Go to Method"), SLOT_MENU_GO_TO_METHOD);
  1346. slot_menu->add_shortcut(ED_SHORTCUT("connections_editor/disconnect", TTR("Disconnect"), Key::KEY_DELETE), SLOT_MENU_DISCONNECT);
  1347. add_child(slot_menu);
  1348. connect_dialog->connect("connected", callable_mp(this, &ConnectionsDock::_make_or_edit_connection));
  1349. tree->connect("item_selected", callable_mp(this, &ConnectionsDock::_tree_item_selected));
  1350. tree->connect("item_activated", callable_mp(this, &ConnectionsDock::_tree_item_activated));
  1351. tree->connect(SceneStringName(gui_input), callable_mp(this, &ConnectionsDock::_tree_gui_input));
  1352. add_theme_constant_override("separation", 3 * EDSCALE);
  1353. }
  1354. ConnectionsDock::~ConnectionsDock() {
  1355. }