script_create_dialog.cpp 28 KB

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