script_create_dialog.cpp 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948
  1. /*************************************************************************/
  2. /* script_create_dialog.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  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 "script_create_dialog.h"
  31. #include "core/io/resource_saver.h"
  32. #include "core/os/file_access.h"
  33. #include "core/project_settings.h"
  34. #include "core/script_language.h"
  35. #include "core/string_builder.h"
  36. #include "editor/create_dialog.h"
  37. #include "editor/editor_node.h"
  38. #include "editor/editor_scale.h"
  39. #include "editor_file_system.h"
  40. void ScriptCreateDialog::_notification(int p_what) {
  41. switch (p_what) {
  42. case NOTIFICATION_THEME_CHANGED:
  43. case NOTIFICATION_ENTER_TREE: {
  44. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  45. String lang = ScriptServer::get_language(i)->get_type();
  46. Ref<Texture> lang_icon = get_icon(lang, "EditorIcons");
  47. if (lang_icon.is_valid()) {
  48. language_menu->set_item_icon(i, lang_icon);
  49. }
  50. }
  51. String last_lang = EditorSettings::get_singleton()->get_project_metadata("script_setup", "last_selected_language", "");
  52. if (!last_lang.empty()) {
  53. for (int i = 0; i < language_menu->get_item_count(); i++) {
  54. if (language_menu->get_item_text(i) == last_lang) {
  55. language_menu->select(i);
  56. current_language = i;
  57. break;
  58. }
  59. }
  60. } else {
  61. language_menu->select(default_language);
  62. }
  63. path_button->set_icon(get_icon("Folder", "EditorIcons"));
  64. parent_browse_button->set_icon(get_icon("Folder", "EditorIcons"));
  65. parent_search_button->set_icon(get_icon("ClassList", "EditorIcons"));
  66. status_panel->add_style_override("panel", get_stylebox("bg", "Tree"));
  67. } break;
  68. }
  69. }
  70. void ScriptCreateDialog::_path_hbox_sorted() {
  71. if (is_visible()) {
  72. int filename_start_pos = initial_bp.rfind("/") + 1;
  73. int filename_end_pos = initial_bp.length();
  74. if (!is_built_in) {
  75. file_path->select(filename_start_pos, filename_end_pos);
  76. }
  77. // First set cursor to the end of line to scroll LineEdit view
  78. // to the right and then set the actual cursor position.
  79. file_path->set_cursor_position(file_path->get_text().length());
  80. file_path->set_cursor_position(filename_start_pos);
  81. file_path->grab_focus();
  82. }
  83. }
  84. bool ScriptCreateDialog::_can_be_built_in() {
  85. return (supports_built_in && built_in_enabled);
  86. }
  87. void ScriptCreateDialog::config(const String &p_base_name, const String &p_base_path, bool p_built_in_enabled, bool p_load_enabled) {
  88. class_name->set_text("");
  89. class_name->deselect();
  90. parent_name->set_text(p_base_name);
  91. parent_name->deselect();
  92. if (p_base_path != "") {
  93. initial_bp = p_base_path.get_basename();
  94. file_path->set_text(initial_bp + "." + ScriptServer::get_language(language_menu->get_selected())->get_extension());
  95. current_language = language_menu->get_selected();
  96. } else {
  97. initial_bp = "";
  98. file_path->set_text("");
  99. }
  100. file_path->deselect();
  101. built_in_enabled = p_built_in_enabled;
  102. load_enabled = p_load_enabled;
  103. _lang_changed(current_language);
  104. _class_name_changed("");
  105. _path_changed(file_path->get_text());
  106. }
  107. void ScriptCreateDialog::set_inheritance_base_type(const String &p_base) {
  108. base_type = p_base;
  109. }
  110. bool ScriptCreateDialog::_validate_parent(const String &p_string) {
  111. if (p_string.length() == 0) {
  112. return false;
  113. }
  114. if (can_inherit_from_file && p_string.is_quoted()) {
  115. String p = p_string.substr(1, p_string.length() - 2);
  116. if (_validate_path(p, true) == "") {
  117. return true;
  118. }
  119. }
  120. return ClassDB::class_exists(p_string) || ScriptServer::is_global_class(p_string);
  121. }
  122. bool ScriptCreateDialog::_validate_class(const String &p_string) {
  123. if (p_string.length() == 0) {
  124. return false;
  125. }
  126. for (int i = 0; i < p_string.length(); i++) {
  127. if (i == 0) {
  128. if (p_string[0] >= '0' && p_string[0] <= '9') {
  129. return false; // no start with number plz
  130. }
  131. }
  132. bool valid_char = (p_string[i] >= '0' && p_string[i] <= '9') || (p_string[i] >= 'a' && p_string[i] <= 'z') || (p_string[i] >= 'A' && p_string[i] <= 'Z') || p_string[i] == '_' || p_string[i] == '.';
  133. if (!valid_char) {
  134. return false;
  135. }
  136. }
  137. return true;
  138. }
  139. String ScriptCreateDialog::_validate_path(const String &p_path, bool p_file_must_exist) {
  140. String p = p_path.strip_edges();
  141. if (p == "") {
  142. return TTR("Path is empty.");
  143. }
  144. if (p.get_file().get_basename() == "") {
  145. return TTR("Filename is empty.");
  146. }
  147. p = ProjectSettings::get_singleton()->localize_path(p);
  148. if (!p.begins_with("res://")) {
  149. return TTR("Path is not local.");
  150. }
  151. DirAccess *d = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  152. if (d->change_dir(p.get_base_dir()) != OK) {
  153. memdelete(d);
  154. return TTR("Invalid base path.");
  155. }
  156. memdelete(d);
  157. /* Does file already exist */
  158. DirAccess *f = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  159. if (f->dir_exists(p)) {
  160. memdelete(f);
  161. return TTR("A directory with the same name exists.");
  162. } else if (p_file_must_exist && !f->file_exists(p)) {
  163. memdelete(f);
  164. return TTR("File does not exist.");
  165. }
  166. memdelete(f);
  167. /* Check file extension */
  168. String extension = p.get_extension();
  169. List<String> extensions;
  170. // get all possible extensions for script
  171. for (int l = 0; l < language_menu->get_item_count(); l++) {
  172. ScriptServer::get_language(l)->get_recognized_extensions(&extensions);
  173. }
  174. bool found = false;
  175. bool match = false;
  176. int index = 0;
  177. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  178. if (E->get().nocasecmp_to(extension) == 0) {
  179. //FIXME (?) - changing language this way doesn't update controls, needs rework
  180. //language_menu->select(index); // change Language option by extension
  181. found = true;
  182. if (E->get() == ScriptServer::get_language(language_menu->get_selected())->get_extension()) {
  183. match = true;
  184. }
  185. break;
  186. }
  187. index++;
  188. }
  189. if (!found) {
  190. return TTR("Invalid extension.");
  191. }
  192. if (!match) {
  193. return TTR("Wrong extension chosen.");
  194. }
  195. /* Let ScriptLanguage do custom validation */
  196. String path_error = ScriptServer::get_language(language_menu->get_selected())->validate_path(p);
  197. if (path_error != "") {
  198. return path_error;
  199. }
  200. /* All checks passed */
  201. return "";
  202. }
  203. String ScriptCreateDialog::_get_class_name() const {
  204. if (has_named_classes) {
  205. return class_name->get_text();
  206. } else {
  207. return ProjectSettings::get_singleton()->localize_path(file_path->get_text()).get_file().get_basename();
  208. }
  209. }
  210. void ScriptCreateDialog::_class_name_changed(const String &p_name) {
  211. if (_validate_class(class_name->get_text())) {
  212. is_class_name_valid = true;
  213. } else {
  214. is_class_name_valid = false;
  215. }
  216. _update_dialog();
  217. }
  218. void ScriptCreateDialog::_parent_name_changed(const String &p_parent) {
  219. if (_validate_parent(parent_name->get_text())) {
  220. is_parent_name_valid = true;
  221. } else {
  222. is_parent_name_valid = false;
  223. }
  224. _update_dialog();
  225. }
  226. void ScriptCreateDialog::_template_changed(int p_template) {
  227. String selected_template = p_template == 0 ? "" : template_menu->get_item_text(p_template);
  228. EditorSettings::get_singleton()->set_project_metadata("script_setup", "last_selected_template", selected_template);
  229. if (p_template == 0) {
  230. //default
  231. script_template = "";
  232. return;
  233. }
  234. int selected_id = template_menu->get_selected_id();
  235. for (int i = 0; i < template_list.size(); i++) {
  236. const ScriptTemplateInfo &sinfo = template_list[i];
  237. if (sinfo.id == selected_id) {
  238. script_template = sinfo.dir.plus_file(sinfo.name + "." + sinfo.extension);
  239. break;
  240. }
  241. }
  242. }
  243. void ScriptCreateDialog::ok_pressed() {
  244. if (is_new_script_created) {
  245. _create_new();
  246. } else {
  247. _load_exist();
  248. }
  249. is_new_script_created = true;
  250. _update_dialog();
  251. }
  252. void ScriptCreateDialog::_create_new() {
  253. String cname_param = _get_class_name();
  254. Ref<Script> scr;
  255. if (script_template != "") {
  256. scr = ResourceLoader::load(script_template);
  257. if (scr.is_null()) {
  258. alert->set_text(vformat(TTR("Error loading template '%s'"), script_template));
  259. alert->popup_centered();
  260. return;
  261. }
  262. scr = scr->duplicate();
  263. ScriptServer::get_language(language_menu->get_selected())->make_template(cname_param, parent_name->get_text(), scr);
  264. } else {
  265. scr = ScriptServer::get_language(language_menu->get_selected())->get_template(cname_param, parent_name->get_text());
  266. }
  267. if (has_named_classes) {
  268. String cname = class_name->get_text();
  269. if (cname.length()) {
  270. scr->set_name(cname);
  271. }
  272. }
  273. if (is_built_in) {
  274. scr->set_name(internal_name->get_text());
  275. } else {
  276. String lpath = ProjectSettings::get_singleton()->localize_path(file_path->get_text());
  277. scr->set_path(lpath);
  278. Error err = ResourceSaver::save(lpath, scr, ResourceSaver::FLAG_CHANGE_PATH);
  279. if (err != OK) {
  280. alert->set_text(TTR("Error - Could not create script in filesystem."));
  281. alert->popup_centered();
  282. return;
  283. }
  284. }
  285. emit_signal("script_created", scr);
  286. hide();
  287. }
  288. void ScriptCreateDialog::_load_exist() {
  289. String path = file_path->get_text();
  290. RES p_script = ResourceLoader::load(path, "Script");
  291. if (p_script.is_null()) {
  292. alert->set_text(vformat(TTR("Error loading script from %s"), path));
  293. alert->popup_centered();
  294. return;
  295. }
  296. emit_signal("script_created", p_script.get_ref_ptr());
  297. hide();
  298. }
  299. void ScriptCreateDialog::_lang_changed(int l) {
  300. ScriptLanguage *language = ScriptServer::get_language(l);
  301. has_named_classes = language->has_named_classes();
  302. can_inherit_from_file = language->can_inherit_from_file();
  303. supports_built_in = language->supports_builtin_mode();
  304. if (!supports_built_in) {
  305. is_built_in = false;
  306. }
  307. String selected_ext = "." + language->get_extension();
  308. String path = file_path->get_text();
  309. String extension = "";
  310. if (path != "") {
  311. if (path.find(".") != -1) {
  312. extension = path.get_extension();
  313. }
  314. if (extension.length() == 0) {
  315. // add extension if none
  316. path += selected_ext;
  317. _path_changed(path);
  318. } else {
  319. // change extension by selected language
  320. List<String> extensions;
  321. // get all possible extensions for script
  322. for (int m = 0; m < language_menu->get_item_count(); m++) {
  323. ScriptServer::get_language(m)->get_recognized_extensions(&extensions);
  324. }
  325. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  326. if (E->get().nocasecmp_to(extension) == 0) {
  327. path = path.get_basename() + selected_ext;
  328. _path_changed(path);
  329. break;
  330. }
  331. }
  332. }
  333. } else {
  334. path = "class" + selected_ext;
  335. _path_changed(path);
  336. }
  337. file_path->set_text(path);
  338. bool use_templates = language->is_using_templates();
  339. template_menu->set_disabled(!use_templates);
  340. template_menu->clear();
  341. if (use_templates) {
  342. _update_script_templates(language->get_extension());
  343. String last_lang = EditorSettings::get_singleton()->get_project_metadata("script_setup", "last_selected_language", "");
  344. String last_template = EditorSettings::get_singleton()->get_project_metadata("script_setup", "last_selected_template", "");
  345. template_menu->add_item(TTR("Default"));
  346. ScriptTemplateInfo *templates = template_list.ptrw();
  347. Vector<String> origin_names;
  348. origin_names.push_back(TTR("Project"));
  349. origin_names.push_back(TTR("Editor"));
  350. int cur_origin = -1;
  351. // Populate script template items previously sorted and now grouped by origin
  352. for (int i = 0; i < template_list.size(); i++) {
  353. if (int(templates[i].origin) != cur_origin) {
  354. template_menu->add_separator();
  355. String origin_name = origin_names[templates[i].origin];
  356. int last_index = template_menu->get_item_count() - 1;
  357. template_menu->set_item_text(last_index, origin_name);
  358. cur_origin = templates[i].origin;
  359. }
  360. String item_name = templates[i].name.capitalize();
  361. template_menu->add_item(item_name);
  362. int new_id = template_menu->get_item_count() - 1;
  363. templates[i].id = new_id;
  364. }
  365. // Disable overridden
  366. for (Map<String, Vector<int>>::Element *E = template_overrides.front(); E; E = E->next()) {
  367. const Vector<int> &overrides = E->get();
  368. if (overrides.size() == 1) {
  369. continue; // doesn't override anything
  370. }
  371. const ScriptTemplateInfo &extended = template_list[overrides[0]];
  372. StringBuilder override_info;
  373. override_info += TTR("Overrides");
  374. override_info += ": ";
  375. for (int i = 1; i < overrides.size(); i++) {
  376. const ScriptTemplateInfo &overridden = template_list[overrides[i]];
  377. int disable_index = template_menu->get_item_index(overridden.id);
  378. template_menu->set_item_disabled(disable_index, true);
  379. override_info += origin_names[overridden.origin];
  380. if (i < overrides.size() - 1) {
  381. override_info += ", ";
  382. }
  383. }
  384. template_menu->set_item_icon(extended.id, get_icon("Override", "EditorIcons"));
  385. template_menu->get_popup()->set_item_tooltip(extended.id, override_info.as_string());
  386. }
  387. // Reselect last selected template
  388. for (int i = 0; i < template_menu->get_item_count(); i++) {
  389. const String &ti = template_menu->get_item_text(i);
  390. if (language_menu->get_item_text(language_menu->get_selected()) == last_lang && last_template == ti) {
  391. template_menu->select(i);
  392. break;
  393. }
  394. }
  395. } else {
  396. template_menu->add_item(TTR("N/A"));
  397. script_template = "";
  398. }
  399. _template_changed(template_menu->get_selected());
  400. EditorSettings::get_singleton()->set_project_metadata("script_setup", "last_selected_language", language_menu->get_item_text(language_menu->get_selected()));
  401. _parent_name_changed(parent_name->get_text());
  402. _update_dialog();
  403. }
  404. void ScriptCreateDialog::_update_script_templates(const String &p_extension) {
  405. template_list.clear();
  406. template_overrides.clear();
  407. Vector<String> dirs;
  408. // Ordered from local to global for correct override mechanism
  409. dirs.push_back(EditorSettings::get_singleton()->get_project_script_templates_dir());
  410. dirs.push_back(EditorSettings::get_singleton()->get_script_templates_dir());
  411. for (int i = 0; i < dirs.size(); i++) {
  412. Vector<String> list = EditorSettings::get_singleton()->get_script_templates(p_extension, dirs[i]);
  413. for (int j = 0; j < list.size(); j++) {
  414. ScriptTemplateInfo sinfo;
  415. sinfo.origin = ScriptOrigin(i);
  416. sinfo.dir = dirs[i];
  417. sinfo.name = list[j];
  418. sinfo.extension = p_extension;
  419. template_list.push_back(sinfo);
  420. if (!template_overrides.has(sinfo.name)) {
  421. Vector<int> overrides;
  422. overrides.push_back(template_list.size() - 1); // first one
  423. template_overrides.insert(sinfo.name, overrides);
  424. } else {
  425. Vector<int> &overrides = template_overrides[sinfo.name];
  426. overrides.push_back(template_list.size() - 1);
  427. }
  428. }
  429. }
  430. }
  431. void ScriptCreateDialog::_built_in_pressed() {
  432. if (internal->is_pressed()) {
  433. is_built_in = true;
  434. is_new_script_created = true;
  435. } else {
  436. is_built_in = false;
  437. _path_changed(file_path->get_text());
  438. }
  439. _update_dialog();
  440. }
  441. void ScriptCreateDialog::_browse_path(bool browse_parent, bool p_save) {
  442. is_browsing_parent = browse_parent;
  443. if (p_save) {
  444. file_browse->set_mode(EditorFileDialog::MODE_SAVE_FILE);
  445. file_browse->set_title(TTR("Open Script / Choose Location"));
  446. file_browse->get_ok()->set_text(TTR("Open"));
  447. } else {
  448. file_browse->set_mode(EditorFileDialog::MODE_OPEN_FILE);
  449. file_browse->set_title(TTR("Open Script"));
  450. }
  451. file_browse->set_disable_overwrite_warning(true);
  452. file_browse->clear_filters();
  453. List<String> extensions;
  454. int lang = language_menu->get_selected();
  455. ScriptServer::get_language(lang)->get_recognized_extensions(&extensions);
  456. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  457. file_browse->add_filter("*." + E->get());
  458. }
  459. file_browse->set_current_path(file_path->get_text());
  460. file_browse->popup_centered_ratio();
  461. }
  462. void ScriptCreateDialog::_file_selected(const String &p_file) {
  463. String p = ProjectSettings::get_singleton()->localize_path(p_file);
  464. if (is_browsing_parent) {
  465. parent_name->set_text("\"" + p + "\"");
  466. _parent_name_changed(parent_name->get_text());
  467. } else {
  468. file_path->set_text(p);
  469. _path_changed(p);
  470. String filename = p.get_file().get_basename();
  471. int select_start = p.rfind(filename);
  472. file_path->select(select_start, select_start + filename.length());
  473. file_path->set_cursor_position(select_start + filename.length());
  474. file_path->grab_focus();
  475. }
  476. }
  477. void ScriptCreateDialog::_create() {
  478. parent_name->set_text(select_class->get_selected_type().split(" ")[0]);
  479. _parent_name_changed(parent_name->get_text());
  480. }
  481. void ScriptCreateDialog::_browse_class_in_tree() {
  482. select_class->set_base_type(base_type);
  483. select_class->popup_create(true);
  484. }
  485. void ScriptCreateDialog::_path_changed(const String &p_path) {
  486. if (is_built_in) {
  487. return;
  488. }
  489. is_path_valid = false;
  490. is_new_script_created = true;
  491. String path_error = _validate_path(p_path, false);
  492. if (path_error != "") {
  493. _msg_path_valid(false, path_error);
  494. _update_dialog();
  495. return;
  496. }
  497. /* Does file already exist */
  498. DirAccess *f = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  499. String p = ProjectSettings::get_singleton()->localize_path(p_path.strip_edges());
  500. if (f->file_exists(p)) {
  501. is_new_script_created = false;
  502. _msg_path_valid(true, TTR("File exists, it will be reused."));
  503. }
  504. memdelete(f);
  505. is_path_valid = true;
  506. _update_dialog();
  507. }
  508. void ScriptCreateDialog::_path_entered(const String &p_path) {
  509. ok_pressed();
  510. }
  511. void ScriptCreateDialog::_msg_script_valid(bool valid, const String &p_msg) {
  512. error_label->set_text(String::utf8("• ") + TTR(p_msg));
  513. if (valid) {
  514. error_label->add_color_override("font_color", get_color("success_color", "Editor"));
  515. } else {
  516. error_label->add_color_override("font_color", get_color("error_color", "Editor"));
  517. }
  518. }
  519. void ScriptCreateDialog::_msg_path_valid(bool valid, const String &p_msg) {
  520. path_error_label->set_text(String::utf8("• ") + TTR(p_msg));
  521. if (valid) {
  522. path_error_label->add_color_override("font_color", get_color("success_color", "Editor"));
  523. } else {
  524. path_error_label->add_color_override("font_color", get_color("error_color", "Editor"));
  525. }
  526. }
  527. void ScriptCreateDialog::_update_dialog() {
  528. /* "Add Script Dialog" GUI logic and script checks. */
  529. bool script_ok = true;
  530. // Is script path/name valid (order from top to bottom)?
  531. if (!is_built_in && !is_path_valid) {
  532. _msg_script_valid(false, TTR("Invalid path."));
  533. script_ok = false;
  534. }
  535. if (has_named_classes && (is_new_script_created && !is_class_name_valid)) {
  536. _msg_script_valid(false, TTR("Invalid class name."));
  537. script_ok = false;
  538. }
  539. if (!is_parent_name_valid && is_new_script_created) {
  540. _msg_script_valid(false, TTR("Invalid inherited parent name or path."));
  541. script_ok = false;
  542. }
  543. if (script_ok) {
  544. _msg_script_valid(true, TTR("Script path/name is valid."));
  545. }
  546. // Does script have named classes?
  547. if (has_named_classes) {
  548. if (is_new_script_created) {
  549. class_name->set_editable(true);
  550. class_name->set_placeholder(TTR("Allowed: a-z, A-Z, 0-9, _ and ."));
  551. class_name->set_placeholder_alpha(0.3);
  552. } else {
  553. class_name->set_editable(false);
  554. }
  555. } else {
  556. class_name->set_editable(false);
  557. class_name->set_placeholder(TTR("N/A"));
  558. class_name->set_placeholder_alpha(1);
  559. class_name->set_text("");
  560. }
  561. // Is script Built-in?
  562. if (is_built_in) {
  563. file_path->set_editable(false);
  564. path_button->set_disabled(true);
  565. re_check_path = true;
  566. } else {
  567. file_path->set_editable(true);
  568. path_button->set_disabled(false);
  569. if (re_check_path) {
  570. re_check_path = false;
  571. _path_changed(file_path->get_text());
  572. }
  573. }
  574. if (!_can_be_built_in()) {
  575. internal->set_pressed(false);
  576. }
  577. internal->set_disabled(!_can_be_built_in());
  578. // Is Script created or loaded from existing file?
  579. builtin_warning_label->set_visible(is_built_in);
  580. path_controls[0]->set_visible(!is_built_in);
  581. path_controls[1]->set_visible(!is_built_in);
  582. name_controls[0]->set_visible(is_built_in);
  583. name_controls[1]->set_visible(is_built_in);
  584. // Check if the script name is the same as the parent class.
  585. // This warning isn't relevant if the script is built-in.
  586. script_name_warning_label->set_visible(!is_built_in && _get_class_name() == parent_name->get_text());
  587. if (is_built_in) {
  588. get_ok()->set_text(TTR("Create"));
  589. parent_name->set_editable(true);
  590. parent_search_button->set_disabled(false);
  591. parent_browse_button->set_disabled(!can_inherit_from_file);
  592. _msg_path_valid(true, TTR("Built-in script (into scene file)."));
  593. } else if (is_new_script_created) {
  594. // New script created.
  595. get_ok()->set_text(TTR("Create"));
  596. parent_name->set_editable(true);
  597. parent_search_button->set_disabled(false);
  598. parent_browse_button->set_disabled(!can_inherit_from_file);
  599. if (is_path_valid) {
  600. _msg_path_valid(true, TTR("Will create a new script file."));
  601. }
  602. } else if (load_enabled) {
  603. // Script loaded.
  604. get_ok()->set_text(TTR("Load"));
  605. parent_name->set_editable(false);
  606. parent_search_button->set_disabled(true);
  607. parent_browse_button->set_disabled(true);
  608. if (is_path_valid) {
  609. _msg_path_valid(true, TTR("Will load an existing script file."));
  610. }
  611. } else {
  612. get_ok()->set_text(TTR("Create"));
  613. parent_name->set_editable(true);
  614. parent_search_button->set_disabled(false);
  615. parent_browse_button->set_disabled(!can_inherit_from_file);
  616. _msg_path_valid(false, TTR("Script file already exists."));
  617. script_ok = false;
  618. }
  619. get_ok()->set_disabled(!script_ok);
  620. set_size(Vector2());
  621. minimum_size_changed();
  622. }
  623. void ScriptCreateDialog::_bind_methods() {
  624. ClassDB::bind_method("_path_hbox_sorted", &ScriptCreateDialog::_path_hbox_sorted);
  625. ClassDB::bind_method("_class_name_changed", &ScriptCreateDialog::_class_name_changed);
  626. ClassDB::bind_method("_parent_name_changed", &ScriptCreateDialog::_parent_name_changed);
  627. ClassDB::bind_method("_lang_changed", &ScriptCreateDialog::_lang_changed);
  628. ClassDB::bind_method("_built_in_pressed", &ScriptCreateDialog::_built_in_pressed);
  629. ClassDB::bind_method("_browse_path", &ScriptCreateDialog::_browse_path);
  630. ClassDB::bind_method("_file_selected", &ScriptCreateDialog::_file_selected);
  631. ClassDB::bind_method("_path_changed", &ScriptCreateDialog::_path_changed);
  632. ClassDB::bind_method("_path_entered", &ScriptCreateDialog::_path_entered);
  633. ClassDB::bind_method("_template_changed", &ScriptCreateDialog::_template_changed);
  634. ClassDB::bind_method("_create", &ScriptCreateDialog::_create);
  635. ClassDB::bind_method("_browse_class_in_tree", &ScriptCreateDialog::_browse_class_in_tree);
  636. ClassDB::bind_method(D_METHOD("config", "inherits", "path", "built_in_enabled", "load_enabled"), &ScriptCreateDialog::config, DEFVAL(true), DEFVAL(true));
  637. ADD_SIGNAL(MethodInfo("script_created", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script")));
  638. }
  639. ScriptCreateDialog::ScriptCreateDialog() {
  640. /* DIALOG */
  641. /* Main Controls */
  642. GridContainer *gc = memnew(GridContainer);
  643. gc->set_columns(2);
  644. /* Error Messages Field */
  645. VBoxContainer *vb = memnew(VBoxContainer);
  646. vb->set_custom_minimum_size(Size2(340, 30) * EDSCALE);
  647. error_label = memnew(Label);
  648. vb->add_child(error_label);
  649. path_error_label = memnew(Label);
  650. vb->add_child(path_error_label);
  651. builtin_warning_label = memnew(Label);
  652. builtin_warning_label->set_custom_minimum_size(Size2(340, 10) * EDSCALE);
  653. builtin_warning_label->set_text(
  654. TTR("Note: Built-in scripts have some limitations and can't be edited using an external editor."));
  655. vb->add_child(builtin_warning_label);
  656. builtin_warning_label->set_autowrap(true);
  657. builtin_warning_label->hide();
  658. script_name_warning_label = memnew(Label);
  659. script_name_warning_label->set_custom_minimum_size(Size2(340, 10) * EDSCALE);
  660. script_name_warning_label->set_text(
  661. TTR("Warning: Having the script name be the same as a built-in type is usually not desired."));
  662. vb->add_child(script_name_warning_label);
  663. script_name_warning_label->add_color_override("font_color", Color(1, 0.85, 0.4));
  664. script_name_warning_label->set_autowrap(true);
  665. script_name_warning_label->hide();
  666. status_panel = memnew(PanelContainer);
  667. status_panel->set_custom_minimum_size(Size2(350, 40) * EDSCALE);
  668. status_panel->set_h_size_flags(Control::SIZE_FILL);
  669. status_panel->add_child(vb);
  670. /* Spacing */
  671. Control *spacing = memnew(Control);
  672. spacing->set_custom_minimum_size(Size2(0, 10 * EDSCALE));
  673. vb = memnew(VBoxContainer);
  674. vb->add_child(gc);
  675. vb->add_child(spacing);
  676. vb->add_child(status_panel);
  677. HBoxContainer *hb = memnew(HBoxContainer);
  678. hb->add_child(vb);
  679. add_child(hb);
  680. /* Language */
  681. language_menu = memnew(OptionButton);
  682. language_menu->set_custom_minimum_size(Size2(250, 0) * EDSCALE);
  683. language_menu->set_h_size_flags(SIZE_EXPAND_FILL);
  684. gc->add_child(memnew(Label(TTR("Language:"))));
  685. gc->add_child(language_menu);
  686. default_language = -1;
  687. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  688. String lang = ScriptServer::get_language(i)->get_name();
  689. language_menu->add_item(lang);
  690. if (lang == "GDScript") {
  691. default_language = i;
  692. }
  693. }
  694. if (default_language >= 0) {
  695. language_menu->select(default_language);
  696. }
  697. current_language = default_language;
  698. language_menu->connect("item_selected", this, "_lang_changed");
  699. /* Inherits */
  700. base_type = "Object";
  701. hb = memnew(HBoxContainer);
  702. hb->set_h_size_flags(SIZE_EXPAND_FILL);
  703. parent_name = memnew(LineEdit);
  704. parent_name->connect("text_changed", this, "_parent_name_changed");
  705. parent_name->set_h_size_flags(SIZE_EXPAND_FILL);
  706. hb->add_child(parent_name);
  707. parent_search_button = memnew(Button);
  708. parent_search_button->set_flat(true);
  709. parent_search_button->connect("pressed", this, "_browse_class_in_tree");
  710. hb->add_child(parent_search_button);
  711. parent_browse_button = memnew(Button);
  712. parent_browse_button->set_flat(true);
  713. parent_browse_button->connect("pressed", this, "_browse_path", varray(true, false));
  714. hb->add_child(parent_browse_button);
  715. gc->add_child(memnew(Label(TTR("Inherits:"))));
  716. gc->add_child(hb);
  717. is_browsing_parent = false;
  718. /* Class Name */
  719. class_name = memnew(LineEdit);
  720. class_name->connect("text_changed", this, "_class_name_changed");
  721. class_name->set_h_size_flags(SIZE_EXPAND_FILL);
  722. gc->add_child(memnew(Label(TTR("Class Name:"))));
  723. gc->add_child(class_name);
  724. /* Templates */
  725. template_menu = memnew(OptionButton);
  726. gc->add_child(memnew(Label(TTR("Template:"))));
  727. gc->add_child(template_menu);
  728. template_menu->connect("item_selected", this, "_template_changed");
  729. /* Built-in Script */
  730. internal = memnew(CheckBox);
  731. internal->set_text(TTR("On"));
  732. internal->connect("pressed", this, "_built_in_pressed");
  733. gc->add_child(memnew(Label(TTR("Built-in Script:"))));
  734. gc->add_child(internal);
  735. /* Path */
  736. hb = memnew(HBoxContainer);
  737. hb->connect("sort_children", this, "_path_hbox_sorted");
  738. file_path = memnew(LineEdit);
  739. file_path->connect("text_changed", this, "_path_changed");
  740. file_path->connect("text_entered", this, "_path_entered");
  741. file_path->set_h_size_flags(SIZE_EXPAND_FILL);
  742. hb->add_child(file_path);
  743. path_button = memnew(Button);
  744. path_button->set_flat(true);
  745. path_button->connect("pressed", this, "_browse_path", varray(false, true));
  746. hb->add_child(path_button);
  747. Label *label = memnew(Label(TTR("Path:")));
  748. gc->add_child(label);
  749. gc->add_child(hb);
  750. re_check_path = false;
  751. path_controls[0] = label;
  752. path_controls[1] = hb;
  753. /* Name */
  754. internal_name = memnew(LineEdit);
  755. internal_name->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  756. label = memnew(Label(TTR("Name:")));
  757. gc->add_child(label);
  758. gc->add_child(internal_name);
  759. name_controls[0] = label;
  760. name_controls[1] = internal_name;
  761. label->hide();
  762. internal_name->hide();
  763. /* Dialog Setup */
  764. select_class = memnew(CreateDialog);
  765. select_class->connect("create", this, "_create");
  766. add_child(select_class);
  767. file_browse = memnew(EditorFileDialog);
  768. file_browse->connect("file_selected", this, "_file_selected");
  769. file_browse->set_mode(EditorFileDialog::MODE_OPEN_FILE);
  770. add_child(file_browse);
  771. get_ok()->set_text(TTR("Create"));
  772. alert = memnew(AcceptDialog);
  773. alert->set_as_minsize();
  774. alert->get_label()->set_autowrap(true);
  775. alert->get_label()->set_align(Label::ALIGN_CENTER);
  776. alert->get_label()->set_valign(Label::VALIGN_CENTER);
  777. alert->get_label()->set_custom_minimum_size(Size2(325, 60) * EDSCALE);
  778. add_child(alert);
  779. set_as_minsize();
  780. set_hide_on_ok(false);
  781. set_title(TTR("Attach Node Script"));
  782. is_parent_name_valid = false;
  783. is_class_name_valid = false;
  784. is_path_valid = false;
  785. has_named_classes = false;
  786. supports_built_in = false;
  787. can_inherit_from_file = false;
  788. is_built_in = false;
  789. built_in_enabled = true;
  790. load_enabled = true;
  791. is_new_script_created = true;
  792. }