script_create_dialog.cpp 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969
  1. /**************************************************************************/
  2. /* script_create_dialog.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "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_system.h"
  37. #include "editor/editor_node.h"
  38. #include "editor/editor_paths.h"
  39. #include "editor/editor_settings.h"
  40. #include "editor/editor_string_names.h"
  41. #include "editor/gui/editor_file_dialog.h"
  42. #include "editor/gui/editor_validation_panel.h"
  43. #include "editor/themes/editor_scale.h"
  44. #include "scene/gui/grid_container.h"
  45. #include "scene/gui/line_edit.h"
  46. static String _get_parent_class_of_script(const String &p_path) {
  47. if (!ResourceLoader::exists(p_path, "Script")) {
  48. return "Object"; // A script eventually inherits from Object.
  49. }
  50. Ref<Script> script = ResourceLoader::load(p_path, "Script");
  51. ERR_FAIL_COND_V(script.is_null(), "Object");
  52. String class_name;
  53. Ref<Script> base = script->get_base_script();
  54. // Inherits from a built-in class.
  55. if (base.is_null()) {
  56. script->get_language()->get_global_class_name(script->get_path(), &class_name);
  57. return class_name;
  58. }
  59. // Inherits from a script that has class_name.
  60. class_name = script->get_language()->get_global_class_name(base->get_path());
  61. if (!class_name.is_empty()) {
  62. return class_name;
  63. }
  64. // Inherits from a plain script.
  65. return _get_parent_class_of_script(base->get_path());
  66. }
  67. static Vector<String> _get_hierarchy(const String &p_class_name) {
  68. Vector<String> hierarchy;
  69. String class_name = p_class_name;
  70. while (true) {
  71. // A registered class.
  72. if (ClassDB::class_exists(class_name)) {
  73. hierarchy.push_back(class_name);
  74. class_name = ClassDB::get_parent_class(class_name);
  75. continue;
  76. }
  77. // A class defined in script with class_name.
  78. if (ScriptServer::is_global_class(class_name)) {
  79. hierarchy.push_back(class_name);
  80. Ref<Script> script = EditorNode::get_editor_data().script_class_load_script(class_name);
  81. ERR_BREAK(script.is_null());
  82. class_name = _get_parent_class_of_script(script->get_path());
  83. continue;
  84. }
  85. break;
  86. }
  87. if (hierarchy.is_empty()) {
  88. if (p_class_name.is_valid_ascii_identifier()) {
  89. hierarchy.push_back(p_class_name);
  90. }
  91. hierarchy.push_back("Object");
  92. }
  93. return hierarchy;
  94. }
  95. void ScriptCreateDialog::_notification(int p_what) {
  96. switch (p_what) {
  97. case NOTIFICATION_ENTER_TREE: {
  98. String last_language = EditorSettings::get_singleton()->get_project_metadata("script_setup", "last_selected_language", "");
  99. if (!last_language.is_empty()) {
  100. for (int i = 0; i < language_menu->get_item_count(); i++) {
  101. if (language_menu->get_item_text(i) == last_language) {
  102. language_menu->select(i);
  103. break;
  104. }
  105. }
  106. } else {
  107. language_menu->select(default_language);
  108. }
  109. is_using_templates = EDITOR_DEF("_script_setup_use_script_templates", false);
  110. use_templates->set_pressed(is_using_templates);
  111. } break;
  112. case NOTIFICATION_THEME_CHANGED: {
  113. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  114. Ref<Texture2D> language_icon = get_editor_theme_icon(ScriptServer::get_language(i)->get_type());
  115. if (language_icon.is_valid()) {
  116. language_menu->set_item_icon(i, language_icon);
  117. }
  118. }
  119. path_button->set_icon(get_editor_theme_icon(SNAME("Folder")));
  120. parent_browse_button->set_icon(get_editor_theme_icon(SNAME("Folder")));
  121. parent_search_button->set_icon(get_editor_theme_icon(SNAME("ClassList")));
  122. } break;
  123. }
  124. }
  125. void ScriptCreateDialog::_path_hbox_sorted() {
  126. if (is_visible()) {
  127. int filename_start_pos = file_path->get_text().rfind("/") + 1;
  128. int filename_end_pos = file_path->get_text().get_basename().length();
  129. if (!is_built_in) {
  130. file_path->select(filename_start_pos, filename_end_pos);
  131. }
  132. // First set cursor to the end of line to scroll LineEdit view
  133. // to the right and then set the actual cursor position.
  134. file_path->set_caret_column(file_path->get_text().length());
  135. file_path->set_caret_column(filename_start_pos);
  136. file_path->grab_focus();
  137. }
  138. }
  139. bool ScriptCreateDialog::_can_be_built_in() {
  140. return (supports_built_in && built_in_enabled);
  141. }
  142. String ScriptCreateDialog::_adjust_file_path(const String &p_base_path) const {
  143. if (p_base_path.is_empty()) {
  144. return p_base_path;
  145. }
  146. String base_dir = p_base_path.get_base_dir();
  147. String file_name = p_base_path.get_file().get_basename();
  148. file_name = EditorNode::adjust_script_name_casing(file_name, language->preferred_file_name_casing());
  149. String extension = language->get_extension();
  150. return base_dir.path_join(file_name + "." + extension);
  151. }
  152. void ScriptCreateDialog::config(const String &p_base_name, const String &p_base_path, bool p_built_in_enabled, bool p_load_enabled) {
  153. parent_name->set_text(p_base_name);
  154. parent_name->deselect();
  155. built_in_name->set_text("");
  156. file_path->set_text(p_base_path);
  157. file_path->deselect();
  158. built_in_enabled = p_built_in_enabled;
  159. load_enabled = p_load_enabled;
  160. _language_changed(language_menu->get_selected());
  161. }
  162. void ScriptCreateDialog::set_inheritance_base_type(const String &p_base) {
  163. base_type = p_base;
  164. }
  165. bool ScriptCreateDialog::_validate_parent(const String &p_string) {
  166. if (p_string.length() == 0) {
  167. return false;
  168. }
  169. if (can_inherit_from_file && p_string.is_quoted()) {
  170. String p = p_string.substr(1, p_string.length() - 2);
  171. if (_validate_path(p, true) == "") {
  172. return true;
  173. }
  174. }
  175. return EditorNode::get_editor_data().is_type_recognized(p_string);
  176. }
  177. String ScriptCreateDialog::_validate_path(const String &p_path, bool p_file_must_exist) {
  178. String p = p_path.strip_edges();
  179. if (p.is_empty()) {
  180. return TTR("Path is empty.");
  181. }
  182. if (p.get_file().get_basename().is_empty()) {
  183. return TTR("Filename is empty.");
  184. }
  185. if (!p.get_file().get_basename().is_valid_filename()) {
  186. return TTR("Filename is invalid.");
  187. }
  188. if (p.get_file().begins_with(".")) {
  189. return TTR("Name begins with a dot.");
  190. }
  191. p = ProjectSettings::get_singleton()->localize_path(p);
  192. if (!p.begins_with("res://")) {
  193. return TTR("Path is not local.");
  194. }
  195. {
  196. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  197. if (da->change_dir(p.get_base_dir()) != OK) {
  198. return TTR("Base path is invalid.");
  199. }
  200. }
  201. {
  202. // Check if file exists.
  203. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  204. if (da->dir_exists(p)) {
  205. return TTR("A directory with the same name exists.");
  206. } else if (p_file_must_exist && !da->file_exists(p)) {
  207. return TTR("File does not exist.");
  208. }
  209. }
  210. // Check file extension.
  211. String extension = p.get_extension();
  212. List<String> extensions;
  213. // Get all possible extensions for script.
  214. for (int l = 0; l < language_menu->get_item_count(); l++) {
  215. ScriptServer::get_language(l)->get_recognized_extensions(&extensions);
  216. }
  217. bool found = false;
  218. bool match = false;
  219. for (const String &E : extensions) {
  220. if (E.nocasecmp_to(extension) == 0) {
  221. found = true;
  222. if (E == ScriptServer::get_language(language_menu->get_selected())->get_extension()) {
  223. match = true;
  224. }
  225. break;
  226. }
  227. }
  228. if (!found) {
  229. return TTR("Invalid extension.");
  230. }
  231. if (!match) {
  232. return TTR("Extension doesn't match chosen language.");
  233. }
  234. // Let ScriptLanguage do custom validation.
  235. return ScriptServer::get_language(language_menu->get_selected())->validate_path(p);
  236. }
  237. void ScriptCreateDialog::_parent_name_changed(const String &p_parent) {
  238. is_parent_name_valid = _validate_parent(parent_name->get_text());
  239. validation_panel->update();
  240. }
  241. void ScriptCreateDialog::_template_changed(int p_template) {
  242. const ScriptLanguage::ScriptTemplate &sinfo = _get_current_template();
  243. // Update last used dictionaries
  244. if (is_using_templates && !parent_name->get_text().begins_with("\"res:")) {
  245. if (sinfo.origin == ScriptLanguage::TemplateLocation::TEMPLATE_PROJECT) {
  246. // Save the last used template for this node into the project dictionary.
  247. Dictionary dic_templates_project = EditorSettings::get_singleton()->get_project_metadata("script_setup", "templates_dictionary", Dictionary());
  248. dic_templates_project[parent_name->get_text()] = sinfo.get_hash();
  249. EditorSettings::get_singleton()->set_project_metadata("script_setup", "templates_dictionary", dic_templates_project);
  250. } else {
  251. // Save template info to editor dictionary (not a project template).
  252. Dictionary dic_templates = EDITOR_GET("_script_setup_templates_dictionary");
  253. dic_templates[parent_name->get_text()] = sinfo.get_hash();
  254. EditorSettings::get_singleton()->set("_script_setup_templates_dictionary", dic_templates);
  255. // Remove template from project dictionary as we last used an editor level template.
  256. Dictionary dic_templates_project = EditorSettings::get_singleton()->get_project_metadata("script_setup", "templates_dictionary", Dictionary());
  257. if (dic_templates_project.has(parent_name->get_text())) {
  258. dic_templates_project.erase(parent_name->get_text());
  259. EditorSettings::get_singleton()->set_project_metadata("script_setup", "templates_dictionary", dic_templates_project);
  260. }
  261. }
  262. }
  263. // Update template label information.
  264. String template_info = U"• ";
  265. template_info += TTR("Template:");
  266. template_info += " " + sinfo.name;
  267. if (!sinfo.description.is_empty()) {
  268. template_info += " - " + sinfo.description;
  269. }
  270. validation_panel->set_message(MSG_ID_TEMPLATE, template_info, EditorValidationPanel::MSG_INFO, false);
  271. }
  272. void ScriptCreateDialog::ok_pressed() {
  273. if (is_new_script_created) {
  274. _create_new();
  275. } else {
  276. _load_exist();
  277. }
  278. EditorSettings::get_singleton()->save();
  279. is_new_script_created = true;
  280. validation_panel->update();
  281. }
  282. void ScriptCreateDialog::_create_new() {
  283. Ref<Script> scr;
  284. const ScriptLanguage::ScriptTemplate sinfo = _get_current_template();
  285. String parent_class = parent_name->get_text();
  286. if (!parent_name->get_text().is_quoted() && !ClassDB::class_exists(parent_class) && !ScriptServer::is_global_class(parent_class)) {
  287. // If base is a custom type, replace with script path instead.
  288. const EditorData::CustomType *type = EditorNode::get_editor_data().get_custom_type_by_name(parent_class);
  289. ERR_FAIL_NULL(type);
  290. parent_class = "\"" + type->script->get_path() + "\"";
  291. }
  292. String class_name = file_path->get_text().get_file().get_basename();
  293. scr = ScriptServer::get_language(language_menu->get_selected())->make_template(sinfo.content, class_name, parent_class);
  294. if (is_built_in) {
  295. scr->set_name(built_in_name->get_text());
  296. // Make sure the script is compiled to make its type recognizable.
  297. scr->reload();
  298. } else {
  299. String lpath = ProjectSettings::get_singleton()->localize_path(file_path->get_text());
  300. scr->set_path(lpath);
  301. Error err = ResourceSaver::save(scr, lpath, ResourceSaver::FLAG_CHANGE_PATH);
  302. if (err != OK) {
  303. alert->set_text(TTR("Error - Could not create script in filesystem."));
  304. alert->popup_centered();
  305. return;
  306. }
  307. }
  308. emit_signal(SNAME("script_created"), scr);
  309. hide();
  310. }
  311. void ScriptCreateDialog::_load_exist() {
  312. String path = file_path->get_text();
  313. Ref<Resource> p_script = ResourceLoader::load(path, "Script");
  314. if (p_script.is_null()) {
  315. alert->set_text(vformat(TTR("Error loading script from %s"), path));
  316. alert->popup_centered();
  317. return;
  318. }
  319. emit_signal(SNAME("script_created"), p_script);
  320. hide();
  321. }
  322. void ScriptCreateDialog::_language_changed(int l) {
  323. language = ScriptServer::get_language(l);
  324. can_inherit_from_file = language->can_inherit_from_file();
  325. supports_built_in = language->supports_builtin_mode();
  326. if (!supports_built_in) {
  327. is_built_in = false;
  328. }
  329. String path = file_path->get_text();
  330. path = _adjust_file_path(path);
  331. _path_changed(path);
  332. file_path->set_text(path);
  333. EditorSettings::get_singleton()->set_project_metadata("script_setup", "last_selected_language", language_menu->get_item_text(language_menu->get_selected()));
  334. _parent_name_changed(parent_name->get_text());
  335. validation_panel->update();
  336. }
  337. void ScriptCreateDialog::_built_in_pressed() {
  338. if (built_in->is_pressed()) {
  339. is_built_in = true;
  340. is_new_script_created = true;
  341. } else {
  342. is_built_in = false;
  343. _path_changed(file_path->get_text());
  344. }
  345. validation_panel->update();
  346. }
  347. void ScriptCreateDialog::_use_template_pressed() {
  348. is_using_templates = use_templates->is_pressed();
  349. EditorSettings::get_singleton()->set("_script_setup_use_script_templates", is_using_templates);
  350. validation_panel->update();
  351. }
  352. void ScriptCreateDialog::_browse_path(bool browse_parent, bool p_save) {
  353. is_browsing_parent = browse_parent;
  354. if (p_save) {
  355. file_browse->set_file_mode(EditorFileDialog::FILE_MODE_SAVE_FILE);
  356. file_browse->set_title(TTR("Open Script / Choose Location"));
  357. file_browse->set_ok_button_text(TTR("Open"));
  358. } else {
  359. file_browse->set_file_mode(EditorFileDialog::FILE_MODE_OPEN_FILE);
  360. file_browse->set_title(TTR("Open Script"));
  361. }
  362. file_browse->set_disable_overwrite_warning(true);
  363. file_browse->clear_filters();
  364. List<String> extensions;
  365. int lang = language_menu->get_selected();
  366. ScriptServer::get_language(lang)->get_recognized_extensions(&extensions);
  367. for (const String &E : extensions) {
  368. file_browse->add_filter("*." + E);
  369. }
  370. file_browse->set_current_path(file_path->get_text());
  371. file_browse->popup_file_dialog();
  372. }
  373. void ScriptCreateDialog::_file_selected(const String &p_file) {
  374. String path = ProjectSettings::get_singleton()->localize_path(p_file);
  375. if (is_browsing_parent) {
  376. parent_name->set_text("\"" + path + "\"");
  377. _parent_name_changed(parent_name->get_text());
  378. } else {
  379. file_path->set_text(path);
  380. _path_changed(path);
  381. String filename = path.get_file().get_basename();
  382. int select_start = path.rfind(filename);
  383. file_path->select(select_start, select_start + filename.length());
  384. file_path->set_caret_column(select_start + filename.length());
  385. file_path->grab_focus();
  386. }
  387. }
  388. void ScriptCreateDialog::_create() {
  389. parent_name->set_text(select_class->get_selected_type().split(" ")[0]);
  390. _parent_name_changed(parent_name->get_text());
  391. }
  392. void ScriptCreateDialog::_browse_class_in_tree() {
  393. select_class->set_base_type(base_type);
  394. select_class->popup_create(true);
  395. select_class->set_title(vformat(TTR("Inherit %s"), base_type));
  396. select_class->set_ok_button_text(TTR("Inherit"));
  397. }
  398. void ScriptCreateDialog::_path_changed(const String &p_path) {
  399. if (is_built_in) {
  400. return;
  401. }
  402. is_path_valid = false;
  403. is_new_script_created = true;
  404. path_error = _validate_path(p_path, false);
  405. if (!path_error.is_empty()) {
  406. validation_panel->update();
  407. return;
  408. }
  409. // Check if file exists.
  410. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  411. String p = ProjectSettings::get_singleton()->localize_path(p_path.strip_edges());
  412. if (da->file_exists(p)) {
  413. is_new_script_created = false;
  414. }
  415. is_path_valid = true;
  416. validation_panel->update();
  417. }
  418. void ScriptCreateDialog::_update_template_menu() {
  419. bool is_language_using_templates = language->is_using_templates();
  420. template_menu->set_disabled(false);
  421. template_menu->clear();
  422. template_list.clear();
  423. if (is_language_using_templates) {
  424. // Get the latest templates used for each type of node from project settings then global settings.
  425. Dictionary last_local_templates = EditorSettings::get_singleton()->get_project_metadata("script_setup", "templates_dictionary", Dictionary());
  426. Dictionary last_global_templates = EDITOR_GET("_script_setup_templates_dictionary");
  427. String inherits_base_type = parent_name->get_text();
  428. // If it inherits from a script, get its parent class first.
  429. if (inherits_base_type[0] == '"') {
  430. inherits_base_type = _get_parent_class_of_script(inherits_base_type.unquote());
  431. }
  432. // Get all ancestor node for selected base node.
  433. // There templates will also fit the base node.
  434. Vector<String> hierarchy = _get_hierarchy(inherits_base_type);
  435. int last_used_template = -1;
  436. int preselected_template = -1;
  437. int previous_ancestor_level = -1;
  438. // Templates can be stored in tree different locations.
  439. Vector<ScriptLanguage::TemplateLocation> template_locations;
  440. template_locations.append(ScriptLanguage::TEMPLATE_PROJECT);
  441. template_locations.append(ScriptLanguage::TEMPLATE_EDITOR);
  442. template_locations.append(ScriptLanguage::TEMPLATE_BUILT_IN);
  443. for (const ScriptLanguage::TemplateLocation &template_location : template_locations) {
  444. String display_name = _get_script_origin_label(template_location);
  445. bool separator = false;
  446. int ancestor_level = 0;
  447. for (const String &current_node : hierarchy) {
  448. Vector<ScriptLanguage::ScriptTemplate> templates_found;
  449. if (template_location == ScriptLanguage::TEMPLATE_BUILT_IN) {
  450. templates_found = language->get_built_in_templates(current_node);
  451. } else {
  452. String template_directory;
  453. if (template_location == ScriptLanguage::TEMPLATE_PROJECT) {
  454. template_directory = EditorPaths::get_singleton()->get_project_script_templates_dir();
  455. } else {
  456. template_directory = EditorPaths::get_singleton()->get_script_templates_dir();
  457. }
  458. templates_found = _get_user_templates(language, current_node, template_directory, template_location);
  459. }
  460. if (!templates_found.is_empty()) {
  461. if (!separator) {
  462. template_menu->add_separator();
  463. template_menu->set_item_text(-1, display_name);
  464. separator = true;
  465. }
  466. for (ScriptLanguage::ScriptTemplate &t : templates_found) {
  467. template_menu->add_item(t.inherit + ": " + t.name);
  468. int id = template_menu->get_item_count() - 1;
  469. // Check if this template should be preselected if node isn't in the last used dictionary.
  470. if (ancestor_level < previous_ancestor_level || previous_ancestor_level == -1) {
  471. previous_ancestor_level = ancestor_level;
  472. preselected_template = id;
  473. }
  474. // Check for last used template for this node in project settings then in global settings.
  475. if (last_local_templates.has(parent_name->get_text()) && t.get_hash() == String(last_local_templates[parent_name->get_text()])) {
  476. last_used_template = id;
  477. } else if (last_used_template == -1 && last_global_templates.has(parent_name->get_text()) && t.get_hash() == String(last_global_templates[parent_name->get_text()])) {
  478. last_used_template = id;
  479. }
  480. t.id = id;
  481. template_list.push_back(t);
  482. String icon = has_theme_icon(t.inherit, EditorStringName(EditorIcons)) ? t.inherit : "Object";
  483. template_menu->set_item_icon(id, get_editor_theme_icon(icon));
  484. }
  485. }
  486. ancestor_level++;
  487. }
  488. }
  489. if (last_used_template != -1) {
  490. template_menu->select(last_used_template);
  491. } else if (preselected_template != -1) {
  492. template_menu->select(preselected_template);
  493. }
  494. }
  495. _template_changed(template_menu->get_selected());
  496. }
  497. void ScriptCreateDialog::_update_dialog() {
  498. // "Add Script Dialog" GUI logic and script checks.
  499. _update_template_menu();
  500. // Is script path/name valid (order from top to bottom)?
  501. if (!is_built_in && !is_path_valid) {
  502. validation_panel->set_message(MSG_ID_SCRIPT, TTR("Invalid path."), EditorValidationPanel::MSG_ERROR);
  503. }
  504. if (!is_parent_name_valid && is_new_script_created) {
  505. validation_panel->set_message(MSG_ID_SCRIPT, TTR("Invalid inherited parent name or path."), EditorValidationPanel::MSG_ERROR);
  506. }
  507. if (validation_panel->is_valid() && !is_new_script_created) {
  508. validation_panel->set_message(MSG_ID_SCRIPT, TTR("File exists, it will be reused."), EditorValidationPanel::MSG_OK);
  509. }
  510. if (!is_built_in && !path_error.is_empty()) {
  511. validation_panel->set_message(MSG_ID_PATH, path_error, EditorValidationPanel::MSG_ERROR);
  512. }
  513. // Is script Built-in?
  514. if (is_built_in) {
  515. file_path->set_editable(false);
  516. path_button->set_disabled(true);
  517. re_check_path = true;
  518. } else {
  519. file_path->set_editable(true);
  520. path_button->set_disabled(false);
  521. if (re_check_path) {
  522. re_check_path = false;
  523. _path_changed(file_path->get_text());
  524. }
  525. }
  526. if (!_can_be_built_in()) {
  527. built_in->set_pressed(false);
  528. }
  529. built_in->set_disabled(!_can_be_built_in());
  530. // Is Script created or loaded from existing file?
  531. if (is_built_in) {
  532. validation_panel->set_message(MSG_ID_BUILT_IN, TTR("Note: Built-in scripts have some limitations and can't be edited using an external editor."), EditorValidationPanel::MSG_INFO, false);
  533. } else if (file_path->get_text().get_file().get_basename() == parent_name->get_text()) {
  534. validation_panel->set_message(MSG_ID_BUILT_IN, TTR("Warning: Having the script name be the same as a built-in type is usually not desired."), EditorValidationPanel::MSG_WARNING, false);
  535. }
  536. path_controls[0]->set_visible(!is_built_in);
  537. path_controls[1]->set_visible(!is_built_in);
  538. name_controls[0]->set_visible(is_built_in);
  539. name_controls[1]->set_visible(is_built_in);
  540. bool is_new_file = is_built_in || is_new_script_created;
  541. parent_name->set_editable(is_new_file);
  542. parent_search_button->set_disabled(!is_new_file);
  543. parent_browse_button->set_disabled(!is_new_file || !can_inherit_from_file);
  544. template_inactive_message = "";
  545. String button_text = is_new_file ? TTR("Create") : TTR("Load");
  546. set_ok_button_text(button_text);
  547. if (is_new_file) {
  548. if (is_built_in) {
  549. validation_panel->set_message(MSG_ID_PATH, TTR("Built-in script (into scene file)."), EditorValidationPanel::MSG_OK);
  550. }
  551. } else {
  552. template_inactive_message = TTR("Using existing script file.");
  553. if (load_enabled) {
  554. if (is_path_valid) {
  555. validation_panel->set_message(MSG_ID_PATH, TTR("Will load an existing script file."), EditorValidationPanel::MSG_OK);
  556. }
  557. } else {
  558. validation_panel->set_message(MSG_ID_PATH, TTR("Script file already exists."), EditorValidationPanel::MSG_ERROR);
  559. }
  560. }
  561. // Show templates list if needed.
  562. if (is_using_templates) {
  563. // Check if at least one suitable template has been found.
  564. if (template_menu->get_item_count() == 0 && template_inactive_message.is_empty()) {
  565. template_inactive_message = TTR("No suitable template.");
  566. }
  567. } else {
  568. template_inactive_message = TTR("Empty");
  569. }
  570. if (!template_inactive_message.is_empty()) {
  571. template_menu->set_disabled(true);
  572. template_menu->clear();
  573. template_menu->add_item(template_inactive_message);
  574. validation_panel->set_message(MSG_ID_TEMPLATE, "", EditorValidationPanel::MSG_INFO);
  575. }
  576. }
  577. ScriptLanguage::ScriptTemplate ScriptCreateDialog::_get_current_template() const {
  578. int selected_index = template_menu->get_selected();
  579. for (const ScriptLanguage::ScriptTemplate &t : template_list) {
  580. if (is_using_templates) {
  581. if (t.id == selected_index) {
  582. return t;
  583. }
  584. } else {
  585. // Using empty built-in template if templates are disabled.
  586. if (t.origin == ScriptLanguage::TemplateLocation::TEMPLATE_BUILT_IN && t.name == "Empty") {
  587. return t;
  588. }
  589. }
  590. }
  591. return ScriptLanguage::ScriptTemplate();
  592. }
  593. Vector<ScriptLanguage::ScriptTemplate> ScriptCreateDialog::_get_user_templates(const ScriptLanguage *p_language, const StringName &p_object, const String &p_dir, const ScriptLanguage::TemplateLocation &p_origin) const {
  594. Vector<ScriptLanguage::ScriptTemplate> user_templates;
  595. String extension = p_language->get_extension();
  596. String dir_path = p_dir.path_join(p_object);
  597. Ref<DirAccess> d = DirAccess::open(dir_path);
  598. if (d.is_valid()) {
  599. d->list_dir_begin();
  600. String file = d->get_next();
  601. while (file != String()) {
  602. if (file.get_extension() == extension) {
  603. user_templates.append(_parse_template(p_language, dir_path, file, p_origin, p_object));
  604. }
  605. file = d->get_next();
  606. }
  607. d->list_dir_end();
  608. }
  609. return user_templates;
  610. }
  611. ScriptLanguage::ScriptTemplate ScriptCreateDialog::_parse_template(const ScriptLanguage *p_language, const String &p_path, const String &p_filename, const ScriptLanguage::TemplateLocation &p_origin, const String &p_inherits) const {
  612. ScriptLanguage::ScriptTemplate script_template = ScriptLanguage::ScriptTemplate();
  613. script_template.origin = p_origin;
  614. script_template.inherit = p_inherits;
  615. int space_indent_size = 4;
  616. // Get meta delimiter
  617. String meta_delimiter;
  618. List<String> comment_delimiters;
  619. p_language->get_comment_delimiters(&comment_delimiters);
  620. for (const String &script_delimiter : comment_delimiters) {
  621. if (!script_delimiter.contains(" ")) {
  622. meta_delimiter = script_delimiter;
  623. break;
  624. }
  625. }
  626. String meta_prefix = meta_delimiter + " meta-";
  627. // Parse file for meta-information and script content
  628. Error err;
  629. Ref<FileAccess> file = FileAccess::open(p_path.path_join(p_filename), FileAccess::READ, &err);
  630. if (!err) {
  631. while (!file->eof_reached()) {
  632. String line = file->get_line();
  633. if (line.begins_with(meta_prefix)) {
  634. // Store meta information
  635. line = line.substr(meta_prefix.length());
  636. if (line.begins_with("name:")) {
  637. script_template.name = line.substr(5).strip_edges();
  638. } else if (line.begins_with("description:")) {
  639. script_template.description = line.substr(12).strip_edges();
  640. } else if (line.begins_with("space-indent:")) {
  641. String indent_value = line.substr(13).strip_edges();
  642. if (indent_value.is_valid_int()) {
  643. int indent_size = indent_value.to_int();
  644. if (indent_size >= 0) {
  645. space_indent_size = indent_size;
  646. } else {
  647. WARN_PRINT(vformat("Template meta-space-indent need to be a non-negative integer value. Found %s.", indent_value));
  648. }
  649. } else {
  650. WARN_PRINT(vformat("Template meta-space-indent need to be a valid integer value. Found %s.", indent_value));
  651. }
  652. }
  653. } else {
  654. // Replace indentation.
  655. int i = 0;
  656. int space_count = 0;
  657. for (; i < line.length(); i++) {
  658. if (line[i] == '\t') {
  659. if (space_count) {
  660. script_template.content += String(" ").repeat(space_count);
  661. space_count = 0;
  662. }
  663. script_template.content += "_TS_";
  664. } else if (line[i] == ' ') {
  665. space_count++;
  666. if (space_count == space_indent_size) {
  667. script_template.content += "_TS_";
  668. space_count = 0;
  669. }
  670. } else {
  671. break;
  672. }
  673. }
  674. if (space_count) {
  675. script_template.content += String(" ").repeat(space_count);
  676. }
  677. script_template.content += line.substr(i) + "\n";
  678. }
  679. }
  680. }
  681. script_template.content = script_template.content.lstrip("\n");
  682. // Get name from file name if no name in meta information
  683. if (script_template.name == String()) {
  684. script_template.name = p_filename.get_basename().capitalize();
  685. }
  686. return script_template;
  687. }
  688. String ScriptCreateDialog::_get_script_origin_label(const ScriptLanguage::TemplateLocation &p_origin) const {
  689. switch (p_origin) {
  690. case ScriptLanguage::TEMPLATE_BUILT_IN:
  691. return TTR("Built-in");
  692. case ScriptLanguage::TEMPLATE_EDITOR:
  693. return TTR("Editor");
  694. case ScriptLanguage::TEMPLATE_PROJECT:
  695. return TTR("Project");
  696. }
  697. return "";
  698. }
  699. void ScriptCreateDialog::_bind_methods() {
  700. ClassDB::bind_method(D_METHOD("config", "inherits", "path", "built_in_enabled", "load_enabled"), &ScriptCreateDialog::config, DEFVAL(true), DEFVAL(true));
  701. ADD_SIGNAL(MethodInfo("script_created", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script")));
  702. }
  703. ScriptCreateDialog::ScriptCreateDialog() {
  704. EDITOR_DEF("_script_setup_templates_dictionary", Dictionary());
  705. /* Main Controls */
  706. GridContainer *gc = memnew(GridContainer);
  707. gc->set_columns(2);
  708. /* Information Messages Field */
  709. validation_panel = memnew(EditorValidationPanel);
  710. validation_panel->add_line(MSG_ID_SCRIPT, TTR("Script path/name is valid."));
  711. validation_panel->add_line(MSG_ID_PATH, TTR("Will create a new script file."));
  712. validation_panel->add_line(MSG_ID_BUILT_IN);
  713. validation_panel->add_line(MSG_ID_TEMPLATE);
  714. validation_panel->set_update_callback(callable_mp(this, &ScriptCreateDialog::_update_dialog));
  715. validation_panel->set_accept_button(get_ok_button());
  716. /* Spacing */
  717. Control *spacing = memnew(Control);
  718. spacing->set_custom_minimum_size(Size2(0, 10 * EDSCALE));
  719. VBoxContainer *vb = memnew(VBoxContainer);
  720. vb->add_child(gc);
  721. vb->add_child(spacing);
  722. vb->add_child(validation_panel);
  723. add_child(vb);
  724. /* Language */
  725. language_menu = memnew(OptionButton);
  726. language_menu->set_custom_minimum_size(Size2(350, 0) * EDSCALE);
  727. language_menu->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  728. gc->add_child(memnew(Label(TTR("Language:"))));
  729. gc->add_child(language_menu);
  730. default_language = -1;
  731. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  732. String lang = ScriptServer::get_language(i)->get_name();
  733. language_menu->add_item(lang);
  734. if (lang == "GDScript") {
  735. default_language = i;
  736. }
  737. }
  738. if (default_language >= 0) {
  739. language_menu->select(default_language);
  740. }
  741. language_menu->connect(SceneStringName(item_selected), callable_mp(this, &ScriptCreateDialog::_language_changed));
  742. /* Inherits */
  743. base_type = "Object";
  744. HBoxContainer *hb = memnew(HBoxContainer);
  745. hb->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  746. parent_name = memnew(LineEdit);
  747. parent_name->connect(SceneStringName(text_changed), callable_mp(this, &ScriptCreateDialog::_parent_name_changed));
  748. parent_name->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  749. hb->add_child(parent_name);
  750. register_text_enter(parent_name);
  751. parent_search_button = memnew(Button);
  752. parent_search_button->connect(SceneStringName(pressed), callable_mp(this, &ScriptCreateDialog::_browse_class_in_tree));
  753. hb->add_child(parent_search_button);
  754. parent_browse_button = memnew(Button);
  755. parent_browse_button->connect(SceneStringName(pressed), callable_mp(this, &ScriptCreateDialog::_browse_path).bind(true, false));
  756. hb->add_child(parent_browse_button);
  757. gc->add_child(memnew(Label(TTR("Inherits:"))));
  758. gc->add_child(hb);
  759. /* Templates */
  760. gc->add_child(memnew(Label(TTR("Template:"))));
  761. HBoxContainer *template_hb = memnew(HBoxContainer);
  762. template_hb->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  763. use_templates = memnew(CheckBox);
  764. use_templates->set_pressed(is_using_templates);
  765. use_templates->connect(SceneStringName(pressed), callable_mp(this, &ScriptCreateDialog::_use_template_pressed));
  766. template_hb->add_child(use_templates);
  767. template_inactive_message = "";
  768. template_menu = memnew(OptionButton);
  769. template_menu->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  770. template_menu->connect(SceneStringName(item_selected), callable_mp(this, &ScriptCreateDialog::_template_changed));
  771. template_hb->add_child(template_menu);
  772. gc->add_child(template_hb);
  773. /* Built-in Script */
  774. built_in = memnew(CheckBox);
  775. built_in->set_text(TTR("On"));
  776. built_in->connect(SceneStringName(pressed), callable_mp(this, &ScriptCreateDialog::_built_in_pressed));
  777. gc->add_child(memnew(Label(TTR("Built-in Script:"))));
  778. gc->add_child(built_in);
  779. /* Path */
  780. hb = memnew(HBoxContainer);
  781. hb->connect(SceneStringName(sort_children), callable_mp(this, &ScriptCreateDialog::_path_hbox_sorted));
  782. file_path = memnew(LineEdit);
  783. file_path->connect(SceneStringName(text_changed), callable_mp(this, &ScriptCreateDialog::_path_changed));
  784. file_path->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  785. hb->add_child(file_path);
  786. register_text_enter(file_path);
  787. path_button = memnew(Button);
  788. path_button->connect(SceneStringName(pressed), callable_mp(this, &ScriptCreateDialog::_browse_path).bind(false, true));
  789. hb->add_child(path_button);
  790. Label *label = memnew(Label(TTR("Path:")));
  791. gc->add_child(label);
  792. gc->add_child(hb);
  793. path_controls[0] = label;
  794. path_controls[1] = hb;
  795. /* Name */
  796. built_in_name = memnew(LineEdit);
  797. built_in_name->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  798. register_text_enter(built_in_name);
  799. label = memnew(Label(TTR("Name:")));
  800. gc->add_child(label);
  801. gc->add_child(built_in_name);
  802. name_controls[0] = label;
  803. name_controls[1] = built_in_name;
  804. label->hide();
  805. built_in_name->hide();
  806. /* Dialog Setup */
  807. select_class = memnew(CreateDialog);
  808. select_class->connect("create", callable_mp(this, &ScriptCreateDialog::_create));
  809. add_child(select_class);
  810. file_browse = memnew(EditorFileDialog);
  811. file_browse->connect("file_selected", callable_mp(this, &ScriptCreateDialog::_file_selected));
  812. file_browse->set_file_mode(EditorFileDialog::FILE_MODE_OPEN_FILE);
  813. add_child(file_browse);
  814. set_ok_button_text(TTR("Create"));
  815. alert = memnew(AcceptDialog);
  816. alert->get_label()->set_autowrap_mode(TextServer::AUTOWRAP_WORD_SMART);
  817. alert->get_label()->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_CENTER);
  818. alert->get_label()->set_vertical_alignment(VERTICAL_ALIGNMENT_CENTER);
  819. alert->get_label()->set_custom_minimum_size(Size2(325, 60) * EDSCALE);
  820. add_child(alert);
  821. set_hide_on_ok(false);
  822. set_title(TTR("Attach Node Script"));
  823. }