shader_editor_plugin.cpp 31 KB

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