shader_editor_plugin.cpp 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835
  1. /*************************************************************************/
  2. /* shader_editor_plugin.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 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 "shader_editor_plugin.h"
  31. #include "core/io/resource_loader.h"
  32. #include "core/io/resource_saver.h"
  33. #include "core/os/keyboard.h"
  34. #include "core/os/os.h"
  35. #include "editor/editor_node.h"
  36. #include "editor/editor_scale.h"
  37. #include "editor/editor_settings.h"
  38. #include "editor/project_settings_editor.h"
  39. #include "editor/property_editor.h"
  40. #include "servers/display_server.h"
  41. #include "servers/rendering/shader_types.h"
  42. /*** SHADER SCRIPT EDITOR ****/
  43. static bool saved_warnings_enabled = false;
  44. static bool saved_treat_warning_as_errors = false;
  45. static Map<ShaderWarning::Code, bool> saved_warnings;
  46. static uint32_t saved_warning_flags = 0U;
  47. Ref<Shader> ShaderTextEditor::get_edited_shader() const {
  48. return shader;
  49. }
  50. void ShaderTextEditor::set_edited_shader(const Ref<Shader> &p_shader) {
  51. if (shader == p_shader) {
  52. return;
  53. }
  54. shader = p_shader;
  55. _load_theme_settings();
  56. get_text_editor()->set_text(p_shader->get_code());
  57. get_text_editor()->clear_undo_history();
  58. get_text_editor()->call_deferred(SNAME("set_h_scroll"), 0);
  59. get_text_editor()->call_deferred(SNAME("set_v_scroll"), 0);
  60. _validate_script();
  61. _line_col_changed();
  62. }
  63. void ShaderTextEditor::reload_text() {
  64. ERR_FAIL_COND(shader.is_null());
  65. CodeEdit *te = get_text_editor();
  66. int column = te->cursor_get_column();
  67. int row = te->cursor_get_line();
  68. int h = te->get_h_scroll();
  69. int v = te->get_v_scroll();
  70. te->set_text(shader->get_code());
  71. te->cursor_set_line(row);
  72. te->cursor_set_column(column);
  73. te->set_h_scroll(h);
  74. te->set_v_scroll(v);
  75. te->tag_saved_version();
  76. update_line_and_column();
  77. }
  78. void ShaderTextEditor::set_warnings_panel(RichTextLabel *p_warnings_panel) {
  79. warnings_panel = p_warnings_panel;
  80. }
  81. void ShaderTextEditor::_load_theme_settings() {
  82. CodeEdit *text_editor = get_text_editor();
  83. Color updated_marked_line_color = EDITOR_GET("text_editor/highlighting/mark_color");
  84. if (updated_marked_line_color != marked_line_color) {
  85. for (int i = 0; i < text_editor->get_line_count(); i++) {
  86. if (text_editor->get_line_background_color(i) == marked_line_color) {
  87. text_editor->set_line_background_color(i, updated_marked_line_color);
  88. }
  89. }
  90. marked_line_color = updated_marked_line_color;
  91. }
  92. syntax_highlighter->set_number_color(EDITOR_GET("text_editor/highlighting/number_color"));
  93. syntax_highlighter->set_symbol_color(EDITOR_GET("text_editor/highlighting/symbol_color"));
  94. syntax_highlighter->set_function_color(EDITOR_GET("text_editor/highlighting/function_color"));
  95. syntax_highlighter->set_member_variable_color(EDITOR_GET("text_editor/highlighting/member_variable_color"));
  96. syntax_highlighter->clear_keyword_colors();
  97. List<String> keywords;
  98. ShaderLanguage::get_keyword_list(&keywords);
  99. const Color keyword_color = EDITOR_GET("text_editor/highlighting/keyword_color");
  100. const Color control_flow_keyword_color = EDITOR_GET("text_editor/highlighting/control_flow_keyword_color");
  101. for (const String &E : keywords) {
  102. if (ShaderLanguage::is_control_flow_keyword(E)) {
  103. syntax_highlighter->add_keyword_color(E, control_flow_keyword_color);
  104. } else {
  105. syntax_highlighter->add_keyword_color(E, keyword_color);
  106. }
  107. }
  108. // Colorize built-ins like `COLOR` differently to make them easier
  109. // to distinguish from keywords at a quick glance.
  110. List<String> built_ins;
  111. if (shader.is_valid()) {
  112. for (const Map<StringName, ShaderLanguage::FunctionInfo>::Element *E = ShaderTypes::get_singleton()->get_functions(RenderingServer::ShaderMode(shader->get_mode())).front(); E; E = E->next()) {
  113. for (const Map<StringName, ShaderLanguage::BuiltInInfo>::Element *F = E->get().built_ins.front(); F; F = F->next()) {
  114. built_ins.push_back(F->key());
  115. }
  116. }
  117. for (int i = 0; i < ShaderTypes::get_singleton()->get_modes(RenderingServer::ShaderMode(shader->get_mode())).size(); i++) {
  118. built_ins.push_back(ShaderTypes::get_singleton()->get_modes(RenderingServer::ShaderMode(shader->get_mode()))[i]);
  119. }
  120. }
  121. const Color member_variable_color = EDITOR_GET("text_editor/highlighting/member_variable_color");
  122. for (const String &E : built_ins) {
  123. syntax_highlighter->add_keyword_color(E, member_variable_color);
  124. }
  125. // Colorize comments.
  126. const Color comment_color = EDITOR_GET("text_editor/highlighting/comment_color");
  127. syntax_highlighter->clear_color_regions();
  128. syntax_highlighter->add_color_region("/*", "*/", comment_color, false);
  129. syntax_highlighter->add_color_region("//", "", comment_color, true);
  130. text_editor->clear_comment_delimiters();
  131. text_editor->add_comment_delimiter("/*", "*/", false);
  132. text_editor->add_comment_delimiter("//", "", true);
  133. if (warnings_panel) {
  134. // Warnings panel
  135. warnings_panel->add_theme_font_override("normal_font", EditorNode::get_singleton()->get_gui_base()->get_theme_font(SNAME("main"), SNAME("EditorFonts")));
  136. warnings_panel->add_theme_font_size_override("normal_font_size", EditorNode::get_singleton()->get_gui_base()->get_theme_font_size(SNAME("main_size"), SNAME("EditorFonts")));
  137. }
  138. }
  139. void ShaderTextEditor::_check_shader_mode() {
  140. String type = ShaderLanguage::get_shader_type(get_text_editor()->get_text());
  141. Shader::Mode mode;
  142. if (type == "canvas_item") {
  143. mode = Shader::MODE_CANVAS_ITEM;
  144. } else if (type == "particles") {
  145. mode = Shader::MODE_PARTICLES;
  146. } else {
  147. mode = Shader::MODE_SPATIAL;
  148. }
  149. if (shader->get_mode() != mode) {
  150. shader->set_code(get_text_editor()->get_text());
  151. _load_theme_settings();
  152. }
  153. }
  154. static ShaderLanguage::DataType _get_global_variable_type(const StringName &p_variable) {
  155. RS::GlobalVariableType gvt = RS::get_singleton()->global_variable_get_type(p_variable);
  156. return RS::global_variable_type_get_shader_datatype(gvt);
  157. }
  158. void ShaderTextEditor::_code_complete_script(const String &p_code, List<ScriptCodeCompletionOption> *r_options) {
  159. _check_shader_mode();
  160. ShaderLanguage sl;
  161. String calltip;
  162. sl.complete(p_code, ShaderTypes::get_singleton()->get_functions(RenderingServer::ShaderMode(shader->get_mode())), ShaderTypes::get_singleton()->get_modes(RenderingServer::ShaderMode(shader->get_mode())), ShaderLanguage::VaryingFunctionNames(), ShaderTypes::get_singleton()->get_types(), _get_global_variable_type, r_options, calltip);
  163. get_text_editor()->set_code_hint(calltip);
  164. }
  165. void ShaderTextEditor::_validate_script() {
  166. _check_shader_mode();
  167. String code = get_text_editor()->get_text();
  168. //List<StringName> params;
  169. //shader->get_param_list(&params);
  170. ShaderLanguage sl;
  171. sl.enable_warning_checking(saved_warnings_enabled);
  172. sl.set_warning_flags(saved_warning_flags);
  173. Error err = sl.compile(code, ShaderTypes::get_singleton()->get_functions(RenderingServer::ShaderMode(shader->get_mode())), ShaderTypes::get_singleton()->get_modes(RenderingServer::ShaderMode(shader->get_mode())), ShaderLanguage::VaryingFunctionNames(), ShaderTypes::get_singleton()->get_types(), _get_global_variable_type);
  174. if (err != OK) {
  175. String error_text = "error(" + itos(sl.get_error_line()) + "): " + sl.get_error_text();
  176. set_error(error_text);
  177. set_error_pos(sl.get_error_line() - 1, 0);
  178. for (int i = 0; i < get_text_editor()->get_line_count(); i++) {
  179. get_text_editor()->set_line_background_color(i, Color(0, 0, 0, 0));
  180. }
  181. get_text_editor()->set_line_background_color(sl.get_error_line() - 1, marked_line_color);
  182. } else {
  183. for (int i = 0; i < get_text_editor()->get_line_count(); i++) {
  184. get_text_editor()->set_line_background_color(i, Color(0, 0, 0, 0));
  185. }
  186. set_error("");
  187. }
  188. if (warnings.size() > 0 || err != OK) {
  189. warnings_panel->clear();
  190. }
  191. warnings.clear();
  192. for (List<ShaderWarning>::Element *E = sl.get_warnings_ptr(); E; E = E->next()) {
  193. warnings.push_back(E->get());
  194. }
  195. if (warnings.size() > 0 && err == OK) {
  196. warnings.sort_custom<WarningsComparator>();
  197. _update_warning_panel();
  198. } else {
  199. set_warning_count(0);
  200. }
  201. emit_signal(SNAME("script_changed"));
  202. }
  203. void ShaderTextEditor::_update_warning_panel() {
  204. int warning_count = 0;
  205. warnings_panel->push_table(2);
  206. for (int i = 0; i < warnings.size(); i++) {
  207. ShaderWarning &w = warnings[i];
  208. if (warning_count == 0) {
  209. if (saved_treat_warning_as_errors) {
  210. String error_text = "error(" + itos(w.get_line()) + "): " + w.get_message() + " " + TTR("Warnings should be fixed to prevent errors.");
  211. set_error_pos(w.get_line() - 1, 0);
  212. set_error(error_text);
  213. get_text_editor()->set_line_background_color(w.get_line() - 1, marked_line_color);
  214. }
  215. }
  216. warning_count++;
  217. // First cell.
  218. warnings_panel->push_cell();
  219. warnings_panel->push_meta(w.get_line() - 1);
  220. warnings_panel->push_color(warnings_panel->get_theme_color(SNAME("warning_color"), SNAME("Editor")));
  221. warnings_panel->add_text(TTR("Line") + " " + itos(w.get_line()));
  222. warnings_panel->add_text(" (" + w.get_name() + "):");
  223. warnings_panel->pop(); // Color.
  224. warnings_panel->pop(); // Meta goto.
  225. warnings_panel->pop(); // Cell.
  226. // Second cell.
  227. warnings_panel->push_cell();
  228. warnings_panel->add_text(w.get_message());
  229. warnings_panel->pop(); // Cell.
  230. }
  231. warnings_panel->pop(); // Table.
  232. set_warning_count(warning_count);
  233. }
  234. void ShaderTextEditor::_bind_methods() {
  235. }
  236. ShaderTextEditor::ShaderTextEditor() {
  237. syntax_highlighter.instantiate();
  238. get_text_editor()->set_syntax_highlighter(syntax_highlighter);
  239. }
  240. /*** SCRIPT EDITOR ******/
  241. void ShaderEditor::_menu_option(int p_option) {
  242. switch (p_option) {
  243. case EDIT_UNDO: {
  244. shader_editor->get_text_editor()->undo();
  245. } break;
  246. case EDIT_REDO: {
  247. shader_editor->get_text_editor()->redo();
  248. } break;
  249. case EDIT_CUT: {
  250. shader_editor->get_text_editor()->cut();
  251. } break;
  252. case EDIT_COPY: {
  253. shader_editor->get_text_editor()->copy();
  254. } break;
  255. case EDIT_PASTE: {
  256. shader_editor->get_text_editor()->paste();
  257. } break;
  258. case EDIT_SELECT_ALL: {
  259. shader_editor->get_text_editor()->select_all();
  260. } break;
  261. case EDIT_MOVE_LINE_UP: {
  262. shader_editor->move_lines_up();
  263. } break;
  264. case EDIT_MOVE_LINE_DOWN: {
  265. shader_editor->move_lines_down();
  266. } break;
  267. case EDIT_INDENT_LEFT: {
  268. if (shader.is_null()) {
  269. return;
  270. }
  271. shader_editor->get_text_editor()->unindent_lines();
  272. } break;
  273. case EDIT_INDENT_RIGHT: {
  274. if (shader.is_null()) {
  275. return;
  276. }
  277. shader_editor->get_text_editor()->indent_lines();
  278. } break;
  279. case EDIT_DELETE_LINE: {
  280. shader_editor->delete_lines();
  281. } break;
  282. case EDIT_DUPLICATE_SELECTION: {
  283. shader_editor->duplicate_selection();
  284. } break;
  285. case EDIT_TOGGLE_COMMENT: {
  286. if (shader.is_null()) {
  287. return;
  288. }
  289. shader_editor->toggle_inline_comment("//");
  290. } break;
  291. case EDIT_COMPLETE: {
  292. shader_editor->get_text_editor()->request_code_completion();
  293. } break;
  294. case SEARCH_FIND: {
  295. shader_editor->get_find_replace_bar()->popup_search();
  296. } break;
  297. case SEARCH_FIND_NEXT: {
  298. shader_editor->get_find_replace_bar()->search_next();
  299. } break;
  300. case SEARCH_FIND_PREV: {
  301. shader_editor->get_find_replace_bar()->search_prev();
  302. } break;
  303. case SEARCH_REPLACE: {
  304. shader_editor->get_find_replace_bar()->popup_replace();
  305. } break;
  306. case SEARCH_GOTO_LINE: {
  307. goto_line_dialog->popup_find_line(shader_editor->get_text_editor());
  308. } break;
  309. case BOOKMARK_TOGGLE: {
  310. shader_editor->toggle_bookmark();
  311. } break;
  312. case BOOKMARK_GOTO_NEXT: {
  313. shader_editor->goto_next_bookmark();
  314. } break;
  315. case BOOKMARK_GOTO_PREV: {
  316. shader_editor->goto_prev_bookmark();
  317. } break;
  318. case BOOKMARK_REMOVE_ALL: {
  319. shader_editor->remove_all_bookmarks();
  320. } break;
  321. case HELP_DOCS: {
  322. OS::get_singleton()->shell_open("https://docs.godotengine.org/en/latest/tutorials/shaders/shader_reference/index.html");
  323. } break;
  324. }
  325. if (p_option != SEARCH_FIND && p_option != SEARCH_REPLACE && p_option != SEARCH_GOTO_LINE) {
  326. shader_editor->get_text_editor()->call_deferred(SNAME("grab_focus"));
  327. }
  328. }
  329. void ShaderEditor::_notification(int p_what) {
  330. if (p_what == NOTIFICATION_WM_WINDOW_FOCUS_IN) {
  331. _check_for_external_edit();
  332. }
  333. }
  334. void ShaderEditor::_editor_settings_changed() {
  335. shader_editor->update_editor_settings();
  336. shader_editor->get_text_editor()->add_theme_constant_override("line_spacing", EditorSettings::get_singleton()->get("text_editor/theme/line_spacing"));
  337. shader_editor->get_text_editor()->set_draw_breakpoints_gutter(false);
  338. shader_editor->get_text_editor()->set_draw_executing_lines_gutter(false);
  339. }
  340. void ShaderEditor::_show_warnings_panel(bool p_show) {
  341. warnings_panel->set_visible(p_show);
  342. }
  343. void ShaderEditor::_warning_clicked(Variant p_line) {
  344. if (p_line.get_type() == Variant::INT) {
  345. shader_editor->get_text_editor()->cursor_set_line(p_line.operator int64_t());
  346. }
  347. }
  348. void ShaderEditor::_bind_methods() {
  349. ClassDB::bind_method("_show_warnings_panel", &ShaderEditor::_show_warnings_panel);
  350. ClassDB::bind_method("_warning_clicked", &ShaderEditor::_warning_clicked);
  351. }
  352. void ShaderEditor::ensure_select_current() {
  353. /*
  354. if (tab_container->get_child_count() && tab_container->get_current_tab()>=0) {
  355. ShaderTextEditor *ste = Object::cast_to<ShaderTextEditor>(tab_container->get_child(tab_container->get_current_tab()));
  356. if (!ste)
  357. return;
  358. Ref<Shader> shader = ste->get_edited_shader();
  359. get_scene()->get_root_node()->call("_resource_selected",shader);
  360. }*/
  361. }
  362. void ShaderEditor::goto_line_selection(int p_line, int p_begin, int p_end) {
  363. shader_editor->goto_line_selection(p_line, p_begin, p_end);
  364. }
  365. void ShaderEditor::_project_settings_changed() {
  366. _update_warnings(true);
  367. }
  368. void ShaderEditor::_update_warnings(bool p_validate) {
  369. bool changed = false;
  370. bool warnings_enabled = GLOBAL_GET("debug/shader_language/warnings/enable").booleanize();
  371. if (warnings_enabled != saved_warnings_enabled) {
  372. saved_warnings_enabled = warnings_enabled;
  373. changed = true;
  374. }
  375. bool treat_warning_as_errors = GLOBAL_GET("debug/shader_language/warnings/treat_warnings_as_errors").booleanize();
  376. if (treat_warning_as_errors != saved_treat_warning_as_errors) {
  377. saved_treat_warning_as_errors = treat_warning_as_errors;
  378. changed = true;
  379. }
  380. bool update_flags = false;
  381. for (int i = 0; i < ShaderWarning::WARNING_MAX; i++) {
  382. ShaderWarning::Code code = (ShaderWarning::Code)i;
  383. bool value = GLOBAL_GET("debug/shader_language/warnings/" + ShaderWarning::get_name_from_code(code).to_lower());
  384. if (saved_warnings[code] != value) {
  385. saved_warnings[code] = value;
  386. update_flags = true;
  387. changed = true;
  388. }
  389. }
  390. if (update_flags) {
  391. saved_warning_flags = (uint32_t)ShaderWarning::get_flags_from_codemap(saved_warnings);
  392. }
  393. if (p_validate && changed && shader_editor && shader_editor->get_edited_shader().is_valid()) {
  394. shader_editor->validate_script();
  395. }
  396. }
  397. void ShaderEditor::_check_for_external_edit() {
  398. if (shader.is_null() || !shader.is_valid()) {
  399. return;
  400. }
  401. // internal shader.
  402. if (shader->get_path() == "" || shader->get_path().find("local://") != -1 || shader->get_path().find("::") != -1) {
  403. return;
  404. }
  405. bool use_autoreload = bool(EDITOR_DEF("text_editor/files/auto_reload_scripts_on_external_change", false));
  406. if (shader->get_last_modified_time() != FileAccess::get_modified_time(shader->get_path())) {
  407. if (use_autoreload) {
  408. _reload_shader_from_disk();
  409. } else {
  410. disk_changed->call_deferred(SNAME("popup_centered"));
  411. }
  412. }
  413. }
  414. void ShaderEditor::_reload_shader_from_disk() {
  415. Ref<Shader> rel_shader = ResourceLoader::load(shader->get_path(), shader->get_class(), ResourceFormatLoader::CACHE_MODE_IGNORE);
  416. ERR_FAIL_COND(!rel_shader.is_valid());
  417. shader->set_code(rel_shader->get_code());
  418. shader->set_last_modified_time(rel_shader->get_last_modified_time());
  419. shader_editor->reload_text();
  420. }
  421. void ShaderEditor::edit(const Ref<Shader> &p_shader) {
  422. if (p_shader.is_null() || !p_shader->is_text_shader()) {
  423. return;
  424. }
  425. if (shader == p_shader) {
  426. return;
  427. }
  428. shader = p_shader;
  429. shader_editor->set_edited_shader(p_shader);
  430. //vertex_editor->set_edited_shader(shader,ShaderLanguage::SHADER_MATERIAL_VERTEX);
  431. // see if already has it
  432. }
  433. void ShaderEditor::save_external_data(const String &p_str) {
  434. if (shader.is_null()) {
  435. disk_changed->hide();
  436. return;
  437. }
  438. apply_shaders();
  439. if (shader->get_path() != "" && shader->get_path().find("local://") == -1 && shader->get_path().find("::") == -1) {
  440. //external shader, save it
  441. ResourceSaver::save(shader->get_path(), shader);
  442. }
  443. disk_changed->hide();
  444. }
  445. void ShaderEditor::apply_shaders() {
  446. if (shader.is_valid()) {
  447. String shader_code = shader->get_code();
  448. String editor_code = shader_editor->get_text_editor()->get_text();
  449. if (shader_code != editor_code) {
  450. shader->set_code(editor_code);
  451. shader->set_edited(true);
  452. }
  453. }
  454. }
  455. void ShaderEditor::_text_edit_gui_input(const Ref<InputEvent> &ev) {
  456. Ref<InputEventMouseButton> mb = ev;
  457. if (mb.is_valid()) {
  458. if (mb->get_button_index() == MOUSE_BUTTON_RIGHT && mb->is_pressed()) {
  459. int col, row;
  460. CodeEdit *tx = shader_editor->get_text_editor();
  461. tx->_get_mouse_pos(mb->get_global_position() - tx->get_global_position(), row, col);
  462. tx->set_right_click_moves_caret(EditorSettings::get_singleton()->get("text_editor/cursor/right_click_moves_caret"));
  463. if (tx->is_right_click_moving_caret()) {
  464. if (tx->is_selection_active()) {
  465. int from_line = tx->get_selection_from_line();
  466. int to_line = tx->get_selection_to_line();
  467. int from_column = tx->get_selection_from_column();
  468. int to_column = tx->get_selection_to_column();
  469. if (row < from_line || row > to_line || (row == from_line && col < from_column) || (row == to_line && col > to_column)) {
  470. // Right click is outside the selected text
  471. tx->deselect();
  472. }
  473. }
  474. if (!tx->is_selection_active()) {
  475. tx->cursor_set_line(row, true, false);
  476. tx->cursor_set_column(col);
  477. }
  478. }
  479. _make_context_menu(tx->is_selection_active(), get_local_mouse_position());
  480. }
  481. }
  482. Ref<InputEventKey> k = ev;
  483. if (k.is_valid() && k->is_pressed() && k->get_keycode() == KEY_MENU) {
  484. CodeEdit *tx = shader_editor->get_text_editor();
  485. _make_context_menu(tx->is_selection_active(), (get_global_transform().inverse() * tx->get_global_transform()).xform(tx->_get_cursor_pixel_pos()));
  486. context_menu->grab_focus();
  487. }
  488. }
  489. void ShaderEditor::_update_bookmark_list() {
  490. bookmarks_menu->clear();
  491. bookmarks_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_bookmark"), BOOKMARK_TOGGLE);
  492. bookmarks_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/remove_all_bookmarks"), BOOKMARK_REMOVE_ALL);
  493. bookmarks_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/goto_next_bookmark"), BOOKMARK_GOTO_NEXT);
  494. bookmarks_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/goto_previous_bookmark"), BOOKMARK_GOTO_PREV);
  495. Array bookmark_list = shader_editor->get_text_editor()->get_bookmarked_lines();
  496. if (bookmark_list.size() == 0) {
  497. return;
  498. }
  499. bookmarks_menu->add_separator();
  500. for (int i = 0; i < bookmark_list.size(); i++) {
  501. String line = shader_editor->get_text_editor()->get_line(bookmark_list[i]).strip_edges();
  502. // Limit the size of the line if too big.
  503. if (line.length() > 50) {
  504. line = line.substr(0, 50);
  505. }
  506. bookmarks_menu->add_item(String::num((int)bookmark_list[i] + 1) + " - \"" + line + "\"");
  507. bookmarks_menu->set_item_metadata(bookmarks_menu->get_item_count() - 1, bookmark_list[i]);
  508. }
  509. }
  510. void ShaderEditor::_bookmark_item_pressed(int p_idx) {
  511. if (p_idx < 4) { // Any item before the separator.
  512. _menu_option(bookmarks_menu->get_item_id(p_idx));
  513. } else {
  514. shader_editor->goto_line(bookmarks_menu->get_item_metadata(p_idx));
  515. }
  516. }
  517. void ShaderEditor::_make_context_menu(bool p_selection, Vector2 p_position) {
  518. context_menu->clear();
  519. if (p_selection) {
  520. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_cut"), EDIT_CUT);
  521. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_copy"), EDIT_COPY);
  522. }
  523. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_paste"), EDIT_PASTE);
  524. context_menu->add_separator();
  525. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_text_select_all"), EDIT_SELECT_ALL);
  526. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_undo"), EDIT_UNDO);
  527. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_redo"), EDIT_REDO);
  528. context_menu->add_separator();
  529. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/indent_left"), EDIT_INDENT_LEFT);
  530. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/indent_right"), EDIT_INDENT_RIGHT);
  531. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_comment"), EDIT_TOGGLE_COMMENT);
  532. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_bookmark"), BOOKMARK_TOGGLE);
  533. context_menu->set_position(get_global_transform().xform(p_position));
  534. context_menu->set_size(Vector2(1, 1));
  535. context_menu->popup();
  536. }
  537. ShaderEditor::ShaderEditor(EditorNode *p_node) {
  538. GLOBAL_DEF("debug/shader_language/warnings/enable", true);
  539. GLOBAL_DEF("debug/shader_language/warnings/treat_warnings_as_errors", false);
  540. for (int i = 0; i < (int)ShaderWarning::WARNING_MAX; i++) {
  541. GLOBAL_DEF("debug/shader_language/warnings/" + ShaderWarning::get_name_from_code((ShaderWarning::Code)i).to_lower(), true);
  542. }
  543. _update_warnings(false);
  544. shader_editor = memnew(ShaderTextEditor);
  545. shader_editor->set_v_size_flags(SIZE_EXPAND_FILL);
  546. shader_editor->add_theme_constant_override("separation", 0);
  547. shader_editor->set_anchors_and_offsets_preset(Control::PRESET_WIDE);
  548. shader_editor->connect("show_warnings_panel", callable_mp(this, &ShaderEditor::_show_warnings_panel));
  549. shader_editor->connect("script_changed", callable_mp(this, &ShaderEditor::apply_shaders));
  550. EditorSettings::get_singleton()->connect("settings_changed", callable_mp(this, &ShaderEditor::_editor_settings_changed));
  551. ProjectSettingsEditor::get_singleton()->connect("confirmed", callable_mp(this, &ShaderEditor::_project_settings_changed));
  552. shader_editor->get_text_editor()->set_code_hint_draw_below(EditorSettings::get_singleton()->get("text_editor/completion/put_callhint_tooltip_below_current_line"));
  553. shader_editor->get_text_editor()->set_select_identifiers_on_hover(true);
  554. shader_editor->get_text_editor()->set_context_menu_enabled(false);
  555. shader_editor->get_text_editor()->connect("gui_input", callable_mp(this, &ShaderEditor::_text_edit_gui_input));
  556. shader_editor->update_editor_settings();
  557. context_menu = memnew(PopupMenu);
  558. add_child(context_menu);
  559. context_menu->connect("id_pressed", callable_mp(this, &ShaderEditor::_menu_option));
  560. VBoxContainer *main_container = memnew(VBoxContainer);
  561. HBoxContainer *hbc = memnew(HBoxContainer);
  562. edit_menu = memnew(MenuButton);
  563. edit_menu->set_shortcut_context(this);
  564. edit_menu->set_text(TTR("Edit"));
  565. edit_menu->set_switch_on_hover(true);
  566. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_undo"), EDIT_UNDO);
  567. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_redo"), EDIT_REDO);
  568. edit_menu->get_popup()->add_separator();
  569. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_cut"), EDIT_CUT);
  570. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_copy"), EDIT_COPY);
  571. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_paste"), EDIT_PASTE);
  572. edit_menu->get_popup()->add_separator();
  573. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_text_select_all"), EDIT_SELECT_ALL);
  574. edit_menu->get_popup()->add_separator();
  575. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/move_up"), EDIT_MOVE_LINE_UP);
  576. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/move_down"), EDIT_MOVE_LINE_DOWN);
  577. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/indent_left"), EDIT_INDENT_LEFT);
  578. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/indent_right"), EDIT_INDENT_RIGHT);
  579. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/delete_line"), EDIT_DELETE_LINE);
  580. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_comment"), EDIT_TOGGLE_COMMENT);
  581. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/duplicate_selection"), EDIT_DUPLICATE_SELECTION);
  582. edit_menu->get_popup()->add_separator();
  583. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_text_completion_query"), EDIT_COMPLETE);
  584. edit_menu->get_popup()->connect("id_pressed", callable_mp(this, &ShaderEditor::_menu_option));
  585. search_menu = memnew(MenuButton);
  586. search_menu->set_shortcut_context(this);
  587. search_menu->set_text(TTR("Search"));
  588. search_menu->set_switch_on_hover(true);
  589. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/find"), SEARCH_FIND);
  590. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/find_next"), SEARCH_FIND_NEXT);
  591. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/find_previous"), SEARCH_FIND_PREV);
  592. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/replace"), SEARCH_REPLACE);
  593. search_menu->get_popup()->connect("id_pressed", callable_mp(this, &ShaderEditor::_menu_option));
  594. MenuButton *goto_menu = memnew(MenuButton);
  595. goto_menu->set_shortcut_context(this);
  596. goto_menu->set_text(TTR("Go To"));
  597. goto_menu->set_switch_on_hover(true);
  598. goto_menu->get_popup()->connect("id_pressed", callable_mp(this, &ShaderEditor::_menu_option));
  599. goto_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/goto_line"), SEARCH_GOTO_LINE);
  600. goto_menu->get_popup()->add_separator();
  601. bookmarks_menu = memnew(PopupMenu);
  602. bookmarks_menu->set_name("Bookmarks");
  603. goto_menu->get_popup()->add_child(bookmarks_menu);
  604. goto_menu->get_popup()->add_submenu_item(TTR("Bookmarks"), "Bookmarks");
  605. _update_bookmark_list();
  606. bookmarks_menu->connect("about_to_popup", callable_mp(this, &ShaderEditor::_update_bookmark_list));
  607. bookmarks_menu->connect("index_pressed", callable_mp(this, &ShaderEditor::_bookmark_item_pressed));
  608. help_menu = memnew(MenuButton);
  609. help_menu->set_text(TTR("Help"));
  610. help_menu->set_switch_on_hover(true);
  611. help_menu->get_popup()->add_icon_item(p_node->get_gui_base()->get_theme_icon(SNAME("Instance"), SNAME("EditorIcons")), TTR("Online Docs"), HELP_DOCS);
  612. help_menu->get_popup()->connect("id_pressed", callable_mp(this, &ShaderEditor::_menu_option));
  613. add_child(main_container);
  614. main_container->add_child(hbc);
  615. hbc->add_child(search_menu);
  616. hbc->add_child(edit_menu);
  617. hbc->add_child(goto_menu);
  618. hbc->add_child(help_menu);
  619. hbc->add_theme_style_override("panel", p_node->get_gui_base()->get_theme_stylebox(SNAME("ScriptEditorPanel"), SNAME("EditorStyles")));
  620. VSplitContainer *editor_box = memnew(VSplitContainer);
  621. main_container->add_child(editor_box);
  622. editor_box->set_anchors_and_offsets_preset(Control::PRESET_WIDE);
  623. editor_box->set_v_size_flags(SIZE_EXPAND_FILL);
  624. editor_box->add_child(shader_editor);
  625. FindReplaceBar *bar = memnew(FindReplaceBar);
  626. main_container->add_child(bar);
  627. bar->hide();
  628. shader_editor->set_find_replace_bar(bar);
  629. warnings_panel = memnew(RichTextLabel);
  630. warnings_panel->set_custom_minimum_size(Size2(0, 100 * EDSCALE));
  631. warnings_panel->set_h_size_flags(SIZE_EXPAND_FILL);
  632. warnings_panel->set_meta_underline(true);
  633. warnings_panel->set_selection_enabled(true);
  634. warnings_panel->set_focus_mode(FOCUS_CLICK);
  635. warnings_panel->hide();
  636. warnings_panel->connect("meta_clicked", callable_mp(this, &ShaderEditor::_warning_clicked));
  637. editor_box->add_child(warnings_panel);
  638. shader_editor->set_warnings_panel(warnings_panel);
  639. goto_line_dialog = memnew(GotoLineDialog);
  640. add_child(goto_line_dialog);
  641. disk_changed = memnew(ConfirmationDialog);
  642. VBoxContainer *vbc = memnew(VBoxContainer);
  643. disk_changed->add_child(vbc);
  644. Label *dl = memnew(Label);
  645. dl->set_text(TTR("This shader has been modified on on disk.\nWhat action should be taken?"));
  646. vbc->add_child(dl);
  647. disk_changed->connect("confirmed", callable_mp(this, &ShaderEditor::_reload_shader_from_disk));
  648. disk_changed->get_ok_button()->set_text(TTR("Reload"));
  649. disk_changed->add_button(TTR("Resave"), !DisplayServer::get_singleton()->get_swap_cancel_ok(), "resave");
  650. disk_changed->connect("custom_action", callable_mp(this, &ShaderEditor::save_external_data));
  651. add_child(disk_changed);
  652. _editor_settings_changed();
  653. }
  654. void ShaderEditorPlugin::edit(Object *p_object) {
  655. Shader *s = Object::cast_to<Shader>(p_object);
  656. shader_editor->edit(s);
  657. }
  658. bool ShaderEditorPlugin::handles(Object *p_object) const {
  659. Shader *shader = Object::cast_to<Shader>(p_object);
  660. return shader != nullptr && shader->is_text_shader();
  661. }
  662. void ShaderEditorPlugin::make_visible(bool p_visible) {
  663. if (p_visible) {
  664. button->show();
  665. editor->make_bottom_panel_item_visible(shader_editor);
  666. } else {
  667. button->hide();
  668. if (shader_editor->is_visible_in_tree()) {
  669. editor->hide_bottom_panel();
  670. }
  671. shader_editor->apply_shaders();
  672. }
  673. }
  674. void ShaderEditorPlugin::selected_notify() {
  675. shader_editor->ensure_select_current();
  676. }
  677. void ShaderEditorPlugin::save_external_data() {
  678. shader_editor->save_external_data();
  679. }
  680. void ShaderEditorPlugin::apply_changes() {
  681. shader_editor->apply_shaders();
  682. }
  683. ShaderEditorPlugin::ShaderEditorPlugin(EditorNode *p_node) {
  684. editor = p_node;
  685. shader_editor = memnew(ShaderEditor(p_node));
  686. shader_editor->set_custom_minimum_size(Size2(0, 300) * EDSCALE);
  687. button = editor->add_bottom_panel_item(TTR("Shader"), shader_editor);
  688. button->hide();
  689. _2d = false;
  690. }
  691. ShaderEditorPlugin::~ShaderEditorPlugin() {
  692. }