script_create_dialog.cpp 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101
  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/config/project_settings.h"
  32. #include "core/io/file_access.h"
  33. #include "core/io/resource_saver.h"
  34. #include "core/string/string_builder.h"
  35. #include "editor/create_dialog.h"
  36. #include "editor/editor_file_dialog.h"
  37. #include "editor/editor_file_system.h"
  38. #include "editor/editor_node.h"
  39. #include "editor/editor_scale.h"
  40. #include "editor/editor_settings.h"
  41. static String _get_parent_class_of_script(String p_path) {
  42. if (!ResourceLoader::exists(p_path, "Script")) {
  43. return "Object"; // A script eventually inherits from Object.
  44. }
  45. Ref<Script> script = ResourceLoader::load(p_path, "Script");
  46. ERR_FAIL_COND_V(script.is_null(), "Object");
  47. String class_name;
  48. Ref<Script> base = script->get_base_script();
  49. // Inherits from a built-in class.
  50. if (base.is_null()) {
  51. script->get_language()->get_global_class_name(script->get_path(), &class_name);
  52. return class_name;
  53. }
  54. // Inherits from a script that has class_name.
  55. class_name = script->get_language()->get_global_class_name(base->get_path());
  56. if (!class_name.is_empty()) {
  57. return class_name;
  58. }
  59. // Inherits from a plain script.
  60. return _get_parent_class_of_script(base->get_path());
  61. }
  62. static Vector<String> _get_hierarchy(String p_class_name) {
  63. Vector<String> hierarchy;
  64. String class_name = p_class_name;
  65. while (true) {
  66. // A registered class.
  67. if (ClassDB::class_exists(class_name)) {
  68. hierarchy.push_back(class_name);
  69. class_name = ClassDB::get_parent_class(class_name);
  70. continue;
  71. }
  72. // A class defined in script with class_name.
  73. if (ScriptServer::is_global_class(class_name)) {
  74. hierarchy.push_back(class_name);
  75. Ref<Script> script = EditorNode::get_editor_data().script_class_load_script(class_name);
  76. ERR_BREAK(script.is_null());
  77. class_name = _get_parent_class_of_script(script->get_path());
  78. continue;
  79. }
  80. break;
  81. }
  82. if (hierarchy.is_empty()) {
  83. if (p_class_name.is_valid_identifier()) {
  84. hierarchy.push_back(p_class_name);
  85. }
  86. hierarchy.push_back("Object");
  87. }
  88. return hierarchy;
  89. }
  90. void ScriptCreateDialog::_notification(int p_what) {
  91. switch (p_what) {
  92. case NOTIFICATION_ENTER_TREE: {
  93. String last_language = EditorSettings::get_singleton()->get_project_metadata("script_setup", "last_selected_language", "");
  94. if (!last_language.is_empty()) {
  95. for (int i = 0; i < language_menu->get_item_count(); i++) {
  96. if (language_menu->get_item_text(i) == last_language) {
  97. language_menu->select(i);
  98. current_language = i;
  99. break;
  100. }
  101. }
  102. } else {
  103. language_menu->select(default_language);
  104. }
  105. [[fallthrough]];
  106. }
  107. case NOTIFICATION_THEME_CHANGED: {
  108. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  109. Ref<Texture2D> language_icon = get_theme_icon(ScriptServer::get_language(i)->get_type(), SNAME("EditorIcons"));
  110. if (language_icon.is_valid()) {
  111. language_menu->set_item_icon(i, language_icon);
  112. }
  113. }
  114. path_button->set_icon(get_theme_icon(SNAME("Folder"), SNAME("EditorIcons")));
  115. parent_browse_button->set_icon(get_theme_icon(SNAME("Folder"), SNAME("EditorIcons")));
  116. parent_search_button->set_icon(get_theme_icon(SNAME("ClassList"), SNAME("EditorIcons")));
  117. status_panel->add_theme_style_override("panel", get_theme_stylebox(SNAME("bg"), SNAME("Tree")));
  118. } break;
  119. }
  120. }
  121. void ScriptCreateDialog::_path_hbox_sorted() {
  122. if (is_visible()) {
  123. int filename_start_pos = initial_bp.rfind("/") + 1;
  124. int filename_end_pos = initial_bp.length();
  125. if (!is_built_in) {
  126. file_path->select(filename_start_pos, filename_end_pos);
  127. }
  128. // First set cursor to the end of line to scroll LineEdit view
  129. // to the right and then set the actual cursor position.
  130. file_path->set_caret_column(file_path->get_text().length());
  131. file_path->set_caret_column(filename_start_pos);
  132. file_path->grab_focus();
  133. }
  134. }
  135. bool ScriptCreateDialog::_can_be_built_in() {
  136. return (supports_built_in && built_in_enabled);
  137. }
  138. void ScriptCreateDialog::config(const String &p_base_name, const String &p_base_path, bool p_built_in_enabled, bool p_load_enabled) {
  139. class_name->set_text("");
  140. class_name->deselect();
  141. parent_name->set_text(p_base_name);
  142. parent_name->deselect();
  143. if (!p_base_path.is_empty()) {
  144. initial_bp = p_base_path.get_basename();
  145. file_path->set_text(initial_bp + "." + ScriptServer::get_language(language_menu->get_selected())->get_extension());
  146. current_language = language_menu->get_selected();
  147. } else {
  148. initial_bp = "";
  149. file_path->set_text("");
  150. }
  151. file_path->deselect();
  152. built_in_enabled = p_built_in_enabled;
  153. load_enabled = p_load_enabled;
  154. _language_changed(current_language);
  155. _class_name_changed("");
  156. _path_changed(file_path->get_text());
  157. }
  158. void ScriptCreateDialog::set_inheritance_base_type(const String &p_base) {
  159. base_type = p_base;
  160. }
  161. bool ScriptCreateDialog::_validate_parent(const String &p_string) {
  162. if (p_string.length() == 0) {
  163. return false;
  164. }
  165. if (can_inherit_from_file && p_string.is_quoted()) {
  166. String p = p_string.substr(1, p_string.length() - 2);
  167. if (_validate_path(p, true) == "") {
  168. return true;
  169. }
  170. }
  171. return ClassDB::class_exists(p_string) || ScriptServer::is_global_class(p_string);
  172. }
  173. bool ScriptCreateDialog::_validate_class(const String &p_string) {
  174. if (p_string.length() == 0) {
  175. return false;
  176. }
  177. for (int i = 0; i < p_string.length(); i++) {
  178. if (i == 0) {
  179. // Cannot start with a number.
  180. if (p_string[0] >= '0' && p_string[0] <= '9') {
  181. return false;
  182. }
  183. }
  184. bool valid_char = is_ascii_identifier_char(p_string[i]) || p_string[i] == '.';
  185. if (!valid_char) {
  186. return false;
  187. }
  188. }
  189. return true;
  190. }
  191. String ScriptCreateDialog::_validate_path(const String &p_path, bool p_file_must_exist) {
  192. String p = p_path.strip_edges();
  193. if (p.is_empty()) {
  194. return TTR("Path is empty.");
  195. }
  196. if (p.get_file().get_basename().is_empty()) {
  197. return TTR("Filename is empty.");
  198. }
  199. if (!p.get_file().get_basename().is_valid_filename()) {
  200. return TTR("Filename is invalid.");
  201. }
  202. p = ProjectSettings::get_singleton()->localize_path(p);
  203. if (!p.begins_with("res://")) {
  204. return TTR("Path is not local.");
  205. }
  206. {
  207. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  208. if (da->change_dir(p.get_base_dir()) != OK) {
  209. return TTR("Base path is invalid.");
  210. }
  211. }
  212. {
  213. // Check if file exists.
  214. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  215. if (da->dir_exists(p)) {
  216. return TTR("A directory with the same name exists.");
  217. } else if (p_file_must_exist && !da->file_exists(p)) {
  218. return TTR("File does not exist.");
  219. }
  220. }
  221. // Check file extension.
  222. String extension = p.get_extension();
  223. List<String> extensions;
  224. // Get all possible extensions for script.
  225. for (int l = 0; l < language_menu->get_item_count(); l++) {
  226. ScriptServer::get_language(l)->get_recognized_extensions(&extensions);
  227. }
  228. bool found = false;
  229. bool match = false;
  230. int index = 0;
  231. for (const String &E : extensions) {
  232. if (E.nocasecmp_to(extension) == 0) {
  233. found = true;
  234. if (E == ScriptServer::get_language(language_menu->get_selected())->get_extension()) {
  235. match = true;
  236. }
  237. break;
  238. }
  239. index++;
  240. }
  241. if (!found) {
  242. return TTR("Invalid extension.");
  243. }
  244. if (!match) {
  245. return TTR("Extension doesn't match chosen language.");
  246. }
  247. // Let ScriptLanguage do custom validation.
  248. String path_error = ScriptServer::get_language(language_menu->get_selected())->validate_path(p);
  249. if (!path_error.is_empty()) {
  250. return path_error;
  251. }
  252. // All checks passed.
  253. return "";
  254. }
  255. String ScriptCreateDialog::_get_class_name() const {
  256. if (has_named_classes) {
  257. return class_name->get_text();
  258. } else {
  259. return ProjectSettings::get_singleton()->localize_path(file_path->get_text()).get_file().get_basename();
  260. }
  261. }
  262. void ScriptCreateDialog::_class_name_changed(const String &p_name) {
  263. is_class_name_valid = _validate_class(class_name->get_text());
  264. _update_dialog();
  265. }
  266. void ScriptCreateDialog::_parent_name_changed(const String &p_parent) {
  267. is_parent_name_valid = _validate_parent(parent_name->get_text());
  268. _update_dialog();
  269. }
  270. void ScriptCreateDialog::_template_changed(int p_template) {
  271. const ScriptLanguage::ScriptTemplate &sinfo = _get_current_template();
  272. // Update last used dictionaries
  273. if (is_using_templates && !parent_name->get_text().begins_with("\"res:")) {
  274. if (sinfo.origin == ScriptLanguage::TemplateLocation::TEMPLATE_PROJECT) {
  275. // Save the last used template for this node into the project dictionary.
  276. Dictionary dic_templates_project = EditorSettings::get_singleton()->get_project_metadata("script_setup", "templates_dictionary", Dictionary());
  277. dic_templates_project[parent_name->get_text()] = sinfo.get_hash();
  278. EditorSettings::get_singleton()->set_project_metadata("script_setup", "templates_dictionary", dic_templates_project);
  279. } else {
  280. // Save template info to editor dictionary (not a project template).
  281. templates_dictionary[parent_name->get_text()] = sinfo.get_hash();
  282. // Remove template from project dictionary as we last used an editor level template.
  283. Dictionary dic_templates_project = EditorSettings::get_singleton()->get_project_metadata("script_setup", "templates_dictionary", Dictionary());
  284. if (dic_templates_project.has(parent_name->get_text())) {
  285. dic_templates_project.erase(parent_name->get_text());
  286. EditorSettings::get_singleton()->set_project_metadata("script_setup", "templates_dictionary", dic_templates_project);
  287. }
  288. }
  289. }
  290. // Update template label information.
  291. String template_info = String::utf8("• ");
  292. template_info += TTR("Template:");
  293. template_info += " " + sinfo.name;
  294. if (!sinfo.description.is_empty()) {
  295. template_info += " - " + sinfo.description;
  296. }
  297. template_info_label->set_text(template_info);
  298. template_info_label->add_theme_color_override("font_color", get_theme_color(SNAME("success_color"), SNAME("Editor")));
  299. }
  300. void ScriptCreateDialog::ok_pressed() {
  301. if (is_new_script_created) {
  302. _create_new();
  303. } else {
  304. _load_exist();
  305. }
  306. EditorSettings::get_singleton()->save();
  307. is_new_script_created = true;
  308. _update_dialog();
  309. }
  310. void ScriptCreateDialog::_create_new() {
  311. String cname_param = _get_class_name();
  312. Ref<Script> scr;
  313. const ScriptLanguage::ScriptTemplate sinfo = _get_current_template();
  314. scr = ScriptServer::get_language(language_menu->get_selected())->make_template(sinfo.content, cname_param, parent_name->get_text());
  315. if (has_named_classes) {
  316. String cname = class_name->get_text();
  317. if (cname.length()) {
  318. scr->set_name(cname);
  319. }
  320. }
  321. if (is_built_in) {
  322. scr->set_name(internal_name->get_text());
  323. } else {
  324. String lpath = ProjectSettings::get_singleton()->localize_path(file_path->get_text());
  325. scr->set_path(lpath);
  326. Error err = ResourceSaver::save(lpath, scr, ResourceSaver::FLAG_CHANGE_PATH);
  327. if (err != OK) {
  328. alert->set_text(TTR("Error - Could not create script in filesystem."));
  329. alert->popup_centered();
  330. return;
  331. }
  332. }
  333. emit_signal(SNAME("script_created"), scr);
  334. hide();
  335. }
  336. void ScriptCreateDialog::_load_exist() {
  337. String path = file_path->get_text();
  338. Ref<Resource> p_script = ResourceLoader::load(path, "Script");
  339. if (p_script.is_null()) {
  340. alert->set_text(vformat(TTR("Error loading script from %s"), path));
  341. alert->popup_centered();
  342. return;
  343. }
  344. emit_signal(SNAME("script_created"), p_script);
  345. hide();
  346. }
  347. void ScriptCreateDialog::_language_changed(int l) {
  348. language = ScriptServer::get_language(l);
  349. has_named_classes = language->has_named_classes();
  350. can_inherit_from_file = language->can_inherit_from_file();
  351. supports_built_in = language->supports_builtin_mode();
  352. if (!supports_built_in) {
  353. is_built_in = false;
  354. }
  355. String selected_ext = "." + language->get_extension();
  356. String path = file_path->get_text();
  357. String extension = "";
  358. if (!path.is_empty()) {
  359. if (path.contains(".")) {
  360. extension = path.get_extension();
  361. }
  362. if (extension.length() == 0) {
  363. // Add extension if none.
  364. path += selected_ext;
  365. _path_changed(path);
  366. } else {
  367. // Change extension by selected language.
  368. List<String> extensions;
  369. // Get all possible extensions for script.
  370. for (int m = 0; m < language_menu->get_item_count(); m++) {
  371. ScriptServer::get_language(m)->get_recognized_extensions(&extensions);
  372. }
  373. for (const String &E : extensions) {
  374. if (E.nocasecmp_to(extension) == 0) {
  375. path = path.get_basename() + selected_ext;
  376. _path_changed(path);
  377. break;
  378. }
  379. }
  380. }
  381. } else {
  382. path = "class" + selected_ext;
  383. _path_changed(path);
  384. }
  385. file_path->set_text(path);
  386. EditorSettings::get_singleton()->set_project_metadata("script_setup", "last_selected_language", language_menu->get_item_text(language_menu->get_selected()));
  387. _parent_name_changed(parent_name->get_text());
  388. _update_dialog();
  389. }
  390. void ScriptCreateDialog::_built_in_pressed() {
  391. if (internal->is_pressed()) {
  392. is_built_in = true;
  393. is_new_script_created = true;
  394. } else {
  395. is_built_in = false;
  396. _path_changed(file_path->get_text());
  397. }
  398. _update_dialog();
  399. }
  400. void ScriptCreateDialog::_use_template_pressed() {
  401. is_using_templates = use_templates->is_pressed();
  402. _update_dialog();
  403. }
  404. void ScriptCreateDialog::_browse_path(bool browse_parent, bool p_save) {
  405. is_browsing_parent = browse_parent;
  406. if (p_save) {
  407. file_browse->set_file_mode(EditorFileDialog::FILE_MODE_SAVE_FILE);
  408. file_browse->set_title(TTR("Open Script / Choose Location"));
  409. file_browse->set_ok_button_text(TTR("Open"));
  410. } else {
  411. file_browse->set_file_mode(EditorFileDialog::FILE_MODE_OPEN_FILE);
  412. file_browse->set_title(TTR("Open Script"));
  413. }
  414. file_browse->set_disable_overwrite_warning(true);
  415. file_browse->clear_filters();
  416. List<String> extensions;
  417. int lang = language_menu->get_selected();
  418. ScriptServer::get_language(lang)->get_recognized_extensions(&extensions);
  419. for (const String &E : extensions) {
  420. file_browse->add_filter("*." + E);
  421. }
  422. file_browse->set_current_path(file_path->get_text());
  423. file_browse->popup_file_dialog();
  424. }
  425. void ScriptCreateDialog::_file_selected(const String &p_file) {
  426. String path = ProjectSettings::get_singleton()->localize_path(p_file);
  427. if (is_browsing_parent) {
  428. parent_name->set_text("\"" + path + "\"");
  429. _parent_name_changed(parent_name->get_text());
  430. } else {
  431. file_path->set_text(path);
  432. _path_changed(path);
  433. String filename = path.get_file().get_basename();
  434. int select_start = path.rfind(filename);
  435. file_path->select(select_start, select_start + filename.length());
  436. file_path->set_caret_column(select_start + filename.length());
  437. file_path->grab_focus();
  438. }
  439. }
  440. void ScriptCreateDialog::_create() {
  441. parent_name->set_text(select_class->get_selected_type().split(" ")[0]);
  442. _parent_name_changed(parent_name->get_text());
  443. }
  444. void ScriptCreateDialog::_browse_class_in_tree() {
  445. select_class->set_base_type(base_type);
  446. select_class->popup_create(true);
  447. select_class->set_title(vformat(TTR("Inherit %s"), base_type));
  448. select_class->set_ok_button_text(TTR("Inherit"));
  449. }
  450. void ScriptCreateDialog::_path_changed(const String &p_path) {
  451. if (is_built_in) {
  452. return;
  453. }
  454. is_path_valid = false;
  455. is_new_script_created = true;
  456. String path_error = _validate_path(p_path, false);
  457. if (!path_error.is_empty()) {
  458. _msg_path_valid(false, path_error);
  459. _update_dialog();
  460. return;
  461. }
  462. // Check if file exists.
  463. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  464. String p = ProjectSettings::get_singleton()->localize_path(p_path.strip_edges());
  465. if (da->file_exists(p)) {
  466. is_new_script_created = false;
  467. _msg_path_valid(true, TTR("File exists, it will be reused."));
  468. }
  469. is_path_valid = true;
  470. _update_dialog();
  471. }
  472. void ScriptCreateDialog::_path_submitted(const String &p_path) {
  473. ok_pressed();
  474. }
  475. void ScriptCreateDialog::_msg_script_valid(bool valid, const String &p_msg) {
  476. error_label->set_text(String::utf8("• ") + p_msg);
  477. if (valid) {
  478. error_label->add_theme_color_override("font_color", get_theme_color(SNAME("success_color"), SNAME("Editor")));
  479. } else {
  480. error_label->add_theme_color_override("font_color", get_theme_color(SNAME("error_color"), SNAME("Editor")));
  481. }
  482. }
  483. void ScriptCreateDialog::_msg_path_valid(bool valid, const String &p_msg) {
  484. path_error_label->set_text(String::utf8("• ") + p_msg);
  485. if (valid) {
  486. path_error_label->add_theme_color_override("font_color", get_theme_color(SNAME("success_color"), SNAME("Editor")));
  487. } else {
  488. path_error_label->add_theme_color_override("font_color", get_theme_color(SNAME("error_color"), SNAME("Editor")));
  489. }
  490. }
  491. void ScriptCreateDialog::_update_template_menu() {
  492. bool is_language_using_templates = language->is_using_templates();
  493. template_menu->set_disabled(false);
  494. template_menu->clear();
  495. template_list.clear();
  496. if (is_language_using_templates) {
  497. // Get the latest templates used for each type of node from project settings then global settings.
  498. Dictionary last_local_templates = EditorSettings::get_singleton()->get_project_metadata("script_setup", "templates_dictionary", Dictionary());
  499. String inherits_base_type = parent_name->get_text();
  500. // If it inherits from a script, get its parent class first.
  501. if (inherits_base_type[0] == '"') {
  502. inherits_base_type = _get_parent_class_of_script(inherits_base_type.unquote());
  503. }
  504. // Get all ancestor node for selected base node.
  505. // There templates will also fit the base node.
  506. Vector<String> hierarchy = _get_hierarchy(inherits_base_type);
  507. int last_used_template = -1;
  508. int preselected_template = -1;
  509. int previous_ancestor_level = -1;
  510. // Templates can be stored in tree different locations.
  511. Vector<ScriptLanguage::TemplateLocation> template_locations;
  512. template_locations.append(ScriptLanguage::TEMPLATE_PROJECT);
  513. template_locations.append(ScriptLanguage::TEMPLATE_EDITOR);
  514. template_locations.append(ScriptLanguage::TEMPLATE_BUILT_IN);
  515. for (const ScriptLanguage::TemplateLocation &template_location : template_locations) {
  516. String display_name = _get_script_origin_label(template_location);
  517. bool separator = false;
  518. int ancestor_level = 0;
  519. for (const String &current_node : hierarchy) {
  520. Vector<ScriptLanguage::ScriptTemplate> templates_found;
  521. if (template_location == ScriptLanguage::TEMPLATE_BUILT_IN) {
  522. templates_found = language->get_built_in_templates(current_node);
  523. } else {
  524. String template_directory;
  525. if (template_location == ScriptLanguage::TEMPLATE_PROJECT) {
  526. template_directory = EditorSettings::get_singleton()->get_project_script_templates_dir();
  527. } else {
  528. template_directory = EditorSettings::get_singleton()->get_script_templates_dir();
  529. }
  530. templates_found = _get_user_templates(language, current_node, template_directory, template_location);
  531. }
  532. if (!templates_found.is_empty()) {
  533. if (!separator) {
  534. template_menu->add_separator();
  535. template_menu->set_item_text(-1, display_name);
  536. separator = true;
  537. }
  538. for (ScriptLanguage::ScriptTemplate &t : templates_found) {
  539. template_menu->add_item(t.inherit + ": " + t.name);
  540. int id = template_menu->get_item_count() - 1;
  541. // Check if this template should be preselected if node isn't in the last used dictionary.
  542. if (ancestor_level < previous_ancestor_level || previous_ancestor_level == -1) {
  543. previous_ancestor_level = ancestor_level;
  544. preselected_template = id;
  545. }
  546. // Check for last used template for this node in project settings then in global settings.
  547. if (last_local_templates.has(parent_name->get_text()) && t.get_hash() == String(last_local_templates[parent_name->get_text()])) {
  548. last_used_template = id;
  549. } else if (last_used_template == -1 && templates_dictionary.has(parent_name->get_text()) && t.get_hash() == String(templates_dictionary[parent_name->get_text()])) {
  550. last_used_template = id;
  551. }
  552. t.id = id;
  553. template_list.push_back(t);
  554. String icon = has_theme_icon(t.inherit, SNAME("EditorIcons")) ? t.inherit : "Object";
  555. template_menu->set_item_icon(id, get_theme_icon(icon, SNAME("EditorIcons")));
  556. }
  557. }
  558. ancestor_level++;
  559. }
  560. }
  561. if (last_used_template != -1) {
  562. template_menu->select(last_used_template);
  563. } else if (preselected_template != -1) {
  564. template_menu->select(preselected_template);
  565. }
  566. }
  567. _template_changed(template_menu->get_selected());
  568. }
  569. void ScriptCreateDialog::_update_dialog() {
  570. // "Add Script Dialog" GUI logic and script checks.
  571. _update_template_menu();
  572. bool script_ok = true;
  573. // Is script path/name valid (order from top to bottom)?
  574. if (!is_built_in && !is_path_valid) {
  575. _msg_script_valid(false, TTR("Invalid path."));
  576. script_ok = false;
  577. }
  578. if (has_named_classes && (is_new_script_created && !is_class_name_valid)) {
  579. _msg_script_valid(false, TTR("Invalid class name."));
  580. script_ok = false;
  581. }
  582. if (!is_parent_name_valid && is_new_script_created) {
  583. _msg_script_valid(false, TTR("Invalid inherited parent name or path."));
  584. script_ok = false;
  585. }
  586. if (script_ok) {
  587. _msg_script_valid(true, TTR("Script path/name is valid."));
  588. }
  589. // Does script have named classes?
  590. if (has_named_classes) {
  591. if (is_new_script_created) {
  592. class_name->set_editable(true);
  593. class_name->set_placeholder(TTR("Allowed: a-z, A-Z, 0-9, _ and ."));
  594. Color placeholder_color = class_name->get_theme_color(SNAME("font_placeholder_color"));
  595. placeholder_color.a = 0.3;
  596. class_name->add_theme_color_override("font_placeholder_color", placeholder_color);
  597. } else {
  598. class_name->set_editable(false);
  599. }
  600. } else {
  601. class_name->set_editable(false);
  602. class_name->set_placeholder(TTR("N/A"));
  603. Color placeholder_color = class_name->get_theme_color(SNAME("font_placeholder_color"));
  604. placeholder_color.a = 1;
  605. class_name->add_theme_color_override("font_placeholder_color", placeholder_color);
  606. class_name->set_text("");
  607. }
  608. // Is script Built-in?
  609. if (is_built_in) {
  610. file_path->set_editable(false);
  611. path_button->set_disabled(true);
  612. re_check_path = true;
  613. } else {
  614. file_path->set_editable(true);
  615. path_button->set_disabled(false);
  616. if (re_check_path) {
  617. re_check_path = false;
  618. _path_changed(file_path->get_text());
  619. }
  620. }
  621. if (!_can_be_built_in()) {
  622. internal->set_pressed(false);
  623. }
  624. internal->set_disabled(!_can_be_built_in());
  625. // Is Script created or loaded from existing file?
  626. builtin_warning_label->set_visible(is_built_in);
  627. path_controls[0]->set_visible(!is_built_in);
  628. path_controls[1]->set_visible(!is_built_in);
  629. name_controls[0]->set_visible(is_built_in);
  630. name_controls[1]->set_visible(is_built_in);
  631. // Check if the script name is the same as the parent class.
  632. // This warning isn't relevant if the script is built-in.
  633. script_name_warning_label->set_visible(!is_built_in && _get_class_name() == parent_name->get_text());
  634. bool is_new_file = is_built_in || is_new_script_created;
  635. parent_name->set_editable(is_new_file);
  636. parent_search_button->set_disabled(!is_new_file);
  637. parent_browse_button->set_disabled(!is_new_file || !can_inherit_from_file);
  638. template_inactive_message = "";
  639. String button_text = is_new_file ? TTR("Create") : TTR("Load");
  640. set_ok_button_text(button_text);
  641. if (is_new_file) {
  642. if (is_built_in) {
  643. _msg_path_valid(true, TTR("Built-in script (into scene file)."));
  644. }
  645. if (is_new_script_created && is_path_valid) {
  646. _msg_path_valid(true, TTR("Will create a new script file."));
  647. }
  648. } else {
  649. if (load_enabled) {
  650. template_inactive_message = TTR("Using existing script file.");
  651. if (is_path_valid) {
  652. _msg_path_valid(true, TTR("Will load an existing script file."));
  653. }
  654. } else {
  655. template_inactive_message = TTR("Using existing script file.");
  656. _msg_path_valid(false, TTR("Script file already exists."));
  657. script_ok = false;
  658. }
  659. }
  660. // Show templates list if needed.
  661. if (is_using_templates) {
  662. // Check if at least one suitable template has been found.
  663. if (template_menu->get_item_count() == 0 && template_inactive_message.is_empty()) {
  664. template_inactive_message = TTR("No suitable template.");
  665. }
  666. } else {
  667. template_inactive_message = TTR("Empty");
  668. }
  669. if (!template_inactive_message.is_empty()) {
  670. template_menu->set_disabled(true);
  671. template_menu->clear();
  672. template_menu->add_item(template_inactive_message);
  673. }
  674. template_info_label->set_visible(!template_menu->is_disabled());
  675. get_ok_button()->set_disabled(!script_ok);
  676. Callable entered_call = callable_mp(this, &ScriptCreateDialog::_path_submitted);
  677. if (script_ok) {
  678. if (!file_path->is_connected("text_submitted", entered_call)) {
  679. file_path->connect("text_submitted", entered_call);
  680. }
  681. } else if (file_path->is_connected("text_submitted", entered_call)) {
  682. file_path->disconnect("text_submitted", entered_call);
  683. }
  684. }
  685. ScriptLanguage::ScriptTemplate ScriptCreateDialog::_get_current_template() const {
  686. int selected_index = template_menu->get_selected();
  687. for (const ScriptLanguage::ScriptTemplate &t : template_list) {
  688. if (is_using_templates) {
  689. if (t.id == selected_index) {
  690. return t;
  691. }
  692. } else {
  693. // Using empty built-in template if templates are disabled.
  694. if (t.origin == ScriptLanguage::TemplateLocation::TEMPLATE_BUILT_IN && t.name == "Empty") {
  695. return t;
  696. }
  697. }
  698. }
  699. return ScriptLanguage::ScriptTemplate();
  700. }
  701. Vector<ScriptLanguage::ScriptTemplate> ScriptCreateDialog::_get_user_templates(const ScriptLanguage *language, const StringName &p_object, const String &p_dir, const ScriptLanguage::TemplateLocation &p_origin) const {
  702. Vector<ScriptLanguage::ScriptTemplate> user_templates;
  703. String extension = language->get_extension();
  704. String dir_path = p_dir.plus_file(p_object);
  705. Ref<DirAccess> d = DirAccess::open(dir_path);
  706. if (d.is_valid()) {
  707. d->list_dir_begin();
  708. String file = d->get_next();
  709. while (file != String()) {
  710. if (file.get_extension() == extension) {
  711. user_templates.append(_parse_template(language, dir_path, file, p_origin, p_object));
  712. }
  713. file = d->get_next();
  714. }
  715. d->list_dir_end();
  716. }
  717. return user_templates;
  718. }
  719. ScriptLanguage::ScriptTemplate ScriptCreateDialog::_parse_template(const ScriptLanguage *language, const String &p_path, const String &p_filename, const ScriptLanguage::TemplateLocation &p_origin, const String &p_inherits) const {
  720. ScriptLanguage::ScriptTemplate script_template = ScriptLanguage::ScriptTemplate();
  721. script_template.origin = p_origin;
  722. script_template.inherit = p_inherits;
  723. String space_indent = " ";
  724. // Get meta delimiter
  725. String meta_delimiter = String();
  726. List<String> comment_delimiters;
  727. language->get_comment_delimiters(&comment_delimiters);
  728. for (const String &script_delimiter : comment_delimiters) {
  729. if (!script_delimiter.contains(" ")) {
  730. meta_delimiter = script_delimiter;
  731. break;
  732. }
  733. }
  734. String meta_prefix = meta_delimiter + " meta-";
  735. // Parse file for meta-information and script content
  736. Error err;
  737. Ref<FileAccess> file = FileAccess::open(p_path.plus_file(p_filename), FileAccess::READ, &err);
  738. if (!err) {
  739. while (!file->eof_reached()) {
  740. String line = file->get_line();
  741. if (line.begins_with(meta_prefix)) {
  742. // Store meta information
  743. line = line.substr(meta_prefix.length(), -1);
  744. if (line.begins_with("name")) {
  745. script_template.name = line.substr(5, -1).strip_edges();
  746. }
  747. if (line.begins_with("description")) {
  748. script_template.description = line.substr(12, -1).strip_edges();
  749. }
  750. if (line.begins_with("space-indent")) {
  751. String indent_value = line.substr(17, -1).strip_edges();
  752. if (indent_value.is_valid_int()) {
  753. space_indent = "";
  754. for (int i = 0; i < indent_value.to_int(); i++) {
  755. space_indent += " ";
  756. }
  757. } else {
  758. WARN_PRINT(vformat("Template meta-use_space_indent need to be a valid integer value. Found %s.", indent_value));
  759. }
  760. }
  761. } else {
  762. // Store script
  763. if (space_indent != "") {
  764. line = line.replace(space_indent, "_TS_");
  765. }
  766. script_template.content += line.replace("\t", "_TS_") + "\n";
  767. }
  768. }
  769. }
  770. script_template.content = script_template.content.lstrip("\n");
  771. // Get name from file name if no name in meta information
  772. if (script_template.name == String()) {
  773. script_template.name = p_filename.get_basename().replace("_", " ").capitalize();
  774. }
  775. return script_template;
  776. }
  777. String ScriptCreateDialog::_get_script_origin_label(const ScriptLanguage::TemplateLocation &p_origin) const {
  778. switch (p_origin) {
  779. case ScriptLanguage::TEMPLATE_BUILT_IN:
  780. return TTR("Built-in");
  781. case ScriptLanguage::TEMPLATE_EDITOR:
  782. return TTR("Editor");
  783. case ScriptLanguage::TEMPLATE_PROJECT:
  784. return TTR("Project");
  785. }
  786. return "";
  787. }
  788. void ScriptCreateDialog::_bind_methods() {
  789. ClassDB::bind_method(D_METHOD("config", "inherits", "path", "built_in_enabled", "load_enabled"), &ScriptCreateDialog::config, DEFVAL(true), DEFVAL(true));
  790. ADD_SIGNAL(MethodInfo("script_created", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script")));
  791. }
  792. ScriptCreateDialog::ScriptCreateDialog() {
  793. /* Main Controls */
  794. GridContainer *gc = memnew(GridContainer);
  795. gc->set_columns(2);
  796. /* Information Messages Field */
  797. VBoxContainer *vb = memnew(VBoxContainer);
  798. error_label = memnew(Label);
  799. vb->add_child(error_label);
  800. path_error_label = memnew(Label);
  801. vb->add_child(path_error_label);
  802. builtin_warning_label = memnew(Label);
  803. builtin_warning_label->set_text(
  804. TTR("Note: Built-in scripts have some limitations and can't be edited using an external editor."));
  805. vb->add_child(builtin_warning_label);
  806. builtin_warning_label->set_autowrap_mode(TextServer::AUTOWRAP_WORD_SMART);
  807. builtin_warning_label->hide();
  808. script_name_warning_label = memnew(Label);
  809. script_name_warning_label->set_text(
  810. TTR("Warning: Having the script name be the same as a built-in type is usually not desired."));
  811. vb->add_child(script_name_warning_label);
  812. script_name_warning_label->add_theme_color_override("font_color", Color(1, 0.85, 0.4));
  813. script_name_warning_label->set_autowrap_mode(TextServer::AUTOWRAP_WORD_SMART);
  814. script_name_warning_label->hide();
  815. template_info_label = memnew(Label);
  816. vb->add_child(template_info_label);
  817. template_info_label->set_autowrap_mode(TextServer::AUTOWRAP_WORD_SMART);
  818. status_panel = memnew(PanelContainer);
  819. status_panel->set_h_size_flags(Control::SIZE_FILL);
  820. status_panel->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  821. status_panel->add_child(vb);
  822. /* Spacing */
  823. Control *spacing = memnew(Control);
  824. spacing->set_custom_minimum_size(Size2(0, 10 * EDSCALE));
  825. vb = memnew(VBoxContainer);
  826. vb->add_child(gc);
  827. vb->add_child(spacing);
  828. vb->add_child(status_panel);
  829. add_child(vb);
  830. /* Language */
  831. language_menu = memnew(OptionButton);
  832. language_menu->set_custom_minimum_size(Size2(350, 0) * EDSCALE);
  833. language_menu->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  834. gc->add_child(memnew(Label(TTR("Language:"))));
  835. gc->add_child(language_menu);
  836. default_language = -1;
  837. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  838. String lang = ScriptServer::get_language(i)->get_name();
  839. language_menu->add_item(lang);
  840. if (lang == "GDScript") {
  841. default_language = i;
  842. }
  843. }
  844. if (default_language >= 0) {
  845. language_menu->select(default_language);
  846. }
  847. current_language = default_language;
  848. language_menu->connect("item_selected", callable_mp(this, &ScriptCreateDialog::_language_changed));
  849. /* Inherits */
  850. base_type = "Object";
  851. HBoxContainer *hb = memnew(HBoxContainer);
  852. hb->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  853. parent_name = memnew(LineEdit);
  854. parent_name->connect("text_changed", callable_mp(this, &ScriptCreateDialog::_parent_name_changed));
  855. parent_name->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  856. hb->add_child(parent_name);
  857. parent_search_button = memnew(Button);
  858. parent_search_button->connect("pressed", callable_mp(this, &ScriptCreateDialog::_browse_class_in_tree));
  859. hb->add_child(parent_search_button);
  860. parent_browse_button = memnew(Button);
  861. parent_browse_button->connect("pressed", callable_mp(this, &ScriptCreateDialog::_browse_path).bind(true, false));
  862. hb->add_child(parent_browse_button);
  863. gc->add_child(memnew(Label(TTR("Inherits:"))));
  864. gc->add_child(hb);
  865. /* Class Name */
  866. class_name = memnew(LineEdit);
  867. class_name->connect("text_changed", callable_mp(this, &ScriptCreateDialog::_class_name_changed));
  868. class_name->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  869. gc->add_child(memnew(Label(TTR("Class Name:"))));
  870. gc->add_child(class_name);
  871. /* Templates */
  872. gc->add_child(memnew(Label(TTR("Template:"))));
  873. HBoxContainer *template_hb = memnew(HBoxContainer);
  874. template_hb->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  875. use_templates = memnew(CheckBox);
  876. use_templates->set_pressed(is_using_templates);
  877. use_templates->connect("pressed", callable_mp(this, &ScriptCreateDialog::_use_template_pressed));
  878. template_hb->add_child(use_templates);
  879. template_inactive_message = "";
  880. template_menu = memnew(OptionButton);
  881. template_menu->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  882. template_menu->connect("item_selected", callable_mp(this, &ScriptCreateDialog::_template_changed));
  883. template_hb->add_child(template_menu);
  884. gc->add_child(template_hb);
  885. /* Built-in Script */
  886. internal = memnew(CheckBox);
  887. internal->set_text(TTR("On"));
  888. internal->connect("pressed", callable_mp(this, &ScriptCreateDialog::_built_in_pressed));
  889. gc->add_child(memnew(Label(TTR("Built-in Script:"))));
  890. gc->add_child(internal);
  891. /* Path */
  892. hb = memnew(HBoxContainer);
  893. hb->connect("sort_children", callable_mp(this, &ScriptCreateDialog::_path_hbox_sorted));
  894. file_path = memnew(LineEdit);
  895. file_path->connect("text_changed", callable_mp(this, &ScriptCreateDialog::_path_changed));
  896. file_path->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  897. hb->add_child(file_path);
  898. path_button = memnew(Button);
  899. path_button->connect("pressed", callable_mp(this, &ScriptCreateDialog::_browse_path).bind(false, true));
  900. hb->add_child(path_button);
  901. Label *label = memnew(Label(TTR("Path:")));
  902. gc->add_child(label);
  903. gc->add_child(hb);
  904. path_controls[0] = label;
  905. path_controls[1] = hb;
  906. /* Name */
  907. internal_name = memnew(LineEdit);
  908. internal_name->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  909. internal_name->connect("text_submitted", callable_mp(this, &ScriptCreateDialog::_path_submitted));
  910. label = memnew(Label(TTR("Name:")));
  911. gc->add_child(label);
  912. gc->add_child(internal_name);
  913. name_controls[0] = label;
  914. name_controls[1] = internal_name;
  915. label->hide();
  916. internal_name->hide();
  917. /* Dialog Setup */
  918. select_class = memnew(CreateDialog);
  919. select_class->connect("create", callable_mp(this, &ScriptCreateDialog::_create));
  920. add_child(select_class);
  921. file_browse = memnew(EditorFileDialog);
  922. file_browse->connect("file_selected", callable_mp(this, &ScriptCreateDialog::_file_selected));
  923. file_browse->set_file_mode(EditorFileDialog::FILE_MODE_OPEN_FILE);
  924. add_child(file_browse);
  925. set_ok_button_text(TTR("Create"));
  926. alert = memnew(AcceptDialog);
  927. alert->get_label()->set_autowrap_mode(TextServer::AUTOWRAP_WORD_SMART);
  928. alert->get_label()->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_CENTER);
  929. alert->get_label()->set_vertical_alignment(VERTICAL_ALIGNMENT_CENTER);
  930. alert->get_label()->set_custom_minimum_size(Size2(325, 60) * EDSCALE);
  931. add_child(alert);
  932. set_hide_on_ok(false);
  933. set_title(TTR("Attach Node Script"));
  934. }