text_shader_editor.cpp 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325
  1. /**************************************************************************/
  2. /* text_shader_editor.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 "text_shader_editor.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/version_generated.gen.h"
  33. #include "editor/editor_node.h"
  34. #include "editor/editor_string_names.h"
  35. #include "editor/file_system/editor_file_system.h"
  36. #include "editor/settings/editor_settings.h"
  37. #include "editor/themes/editor_scale.h"
  38. #include "editor/themes/editor_theme_manager.h"
  39. #include "scene/gui/separator.h"
  40. #include "scene/gui/split_container.h"
  41. #include "servers/rendering/shader_preprocessor.h"
  42. #include "servers/rendering/shader_types.h"
  43. /*** SHADER SYNTAX HIGHLIGHTER ****/
  44. Dictionary GDShaderSyntaxHighlighter::_get_line_syntax_highlighting_impl(int p_line) {
  45. Dictionary color_map;
  46. for (const Point2i &region : disabled_branch_regions) {
  47. if (p_line >= region.x && p_line <= region.y) {
  48. // When "color_regions[0].p_start_key.length() > 2",
  49. // disabled_branch_region causes color_region to break.
  50. // This should be seen as a temporary solution.
  51. CodeHighlighter::_get_line_syntax_highlighting_impl(p_line);
  52. Dictionary highlighter_info;
  53. highlighter_info["color"] = disabled_branch_color;
  54. color_map[0] = highlighter_info;
  55. return color_map;
  56. }
  57. }
  58. return CodeHighlighter::_get_line_syntax_highlighting_impl(p_line);
  59. }
  60. void GDShaderSyntaxHighlighter::add_disabled_branch_region(const Point2i &p_region) {
  61. ERR_FAIL_COND(p_region.x < 0);
  62. ERR_FAIL_COND(p_region.y < 0);
  63. for (int i = 0; i < disabled_branch_regions.size(); i++) {
  64. ERR_FAIL_COND_MSG(disabled_branch_regions[i].x == p_region.x, "Branch region with a start line '" + itos(p_region.x) + "' already exists.");
  65. }
  66. Point2i disabled_branch_region;
  67. disabled_branch_region.x = p_region.x;
  68. disabled_branch_region.y = p_region.y;
  69. disabled_branch_regions.push_back(disabled_branch_region);
  70. clear_highlighting_cache();
  71. }
  72. void GDShaderSyntaxHighlighter::clear_disabled_branch_regions() {
  73. disabled_branch_regions.clear();
  74. clear_highlighting_cache();
  75. }
  76. void GDShaderSyntaxHighlighter::set_disabled_branch_color(const Color &p_color) {
  77. disabled_branch_color = p_color;
  78. clear_highlighting_cache();
  79. }
  80. /*** SHADER SCRIPT EDITOR ****/
  81. static bool saved_warnings_enabled = false;
  82. static bool saved_treat_warning_as_errors = false;
  83. static HashMap<ShaderWarning::Code, bool> saved_warnings;
  84. static uint32_t saved_warning_flags = 0U;
  85. void ShaderTextEditor::_notification(int p_what) {
  86. switch (p_what) {
  87. case NOTIFICATION_THEME_CHANGED: {
  88. if (is_visible_in_tree()) {
  89. _load_theme_settings();
  90. if (warnings.size() > 0 && last_compile_result == OK) {
  91. warnings_panel->clear();
  92. _update_warning_panel();
  93. }
  94. }
  95. } break;
  96. }
  97. }
  98. Ref<Shader> ShaderTextEditor::get_edited_shader() const {
  99. return shader;
  100. }
  101. Ref<ShaderInclude> ShaderTextEditor::get_edited_shader_include() const {
  102. return shader_inc;
  103. }
  104. void ShaderTextEditor::set_edited_shader(const Ref<Shader> &p_shader) {
  105. set_edited_shader(p_shader, p_shader->get_code());
  106. }
  107. void ShaderTextEditor::set_edited_shader(const Ref<Shader> &p_shader, const String &p_code) {
  108. if (shader == p_shader) {
  109. return;
  110. }
  111. if (shader.is_valid()) {
  112. shader->disconnect_changed(callable_mp(this, &ShaderTextEditor::_shader_changed));
  113. }
  114. shader = p_shader;
  115. shader_inc = Ref<ShaderInclude>();
  116. set_edited_code(p_code);
  117. if (shader.is_valid()) {
  118. shader->connect_changed(callable_mp(this, &ShaderTextEditor::_shader_changed));
  119. }
  120. }
  121. void ShaderTextEditor::set_edited_shader_include(const Ref<ShaderInclude> &p_shader_inc) {
  122. set_edited_shader_include(p_shader_inc, p_shader_inc->get_code());
  123. }
  124. void ShaderTextEditor::_shader_changed() {
  125. // This function is used for dependencies (include changing changes main shader and forces it to revalidate)
  126. if (block_shader_changed) {
  127. return;
  128. }
  129. dependencies_version++;
  130. _validate_script();
  131. }
  132. void ShaderTextEditor::set_edited_shader_include(const Ref<ShaderInclude> &p_shader_inc, const String &p_code) {
  133. if (shader_inc == p_shader_inc) {
  134. return;
  135. }
  136. if (shader_inc.is_valid()) {
  137. shader_inc->disconnect_changed(callable_mp(this, &ShaderTextEditor::_shader_changed));
  138. }
  139. shader_inc = p_shader_inc;
  140. shader = Ref<Shader>();
  141. set_edited_code(p_code);
  142. if (shader_inc.is_valid()) {
  143. shader_inc->connect_changed(callable_mp(this, &ShaderTextEditor::_shader_changed));
  144. }
  145. }
  146. void ShaderTextEditor::set_edited_code(const String &p_code) {
  147. _load_theme_settings();
  148. get_text_editor()->set_text(p_code);
  149. get_text_editor()->clear_undo_history();
  150. callable_mp((TextEdit *)get_text_editor(), &TextEdit::set_h_scroll).call_deferred(0);
  151. callable_mp((TextEdit *)get_text_editor(), &TextEdit::set_v_scroll).call_deferred(0);
  152. get_text_editor()->tag_saved_version();
  153. _validate_script();
  154. _line_col_changed();
  155. }
  156. void ShaderTextEditor::reload_text() {
  157. ERR_FAIL_COND(shader.is_null() && shader_inc.is_null());
  158. String code;
  159. if (shader.is_valid()) {
  160. code = shader->get_code();
  161. } else {
  162. code = shader_inc->get_code();
  163. }
  164. CodeEdit *te = get_text_editor();
  165. int column = te->get_caret_column();
  166. int row = te->get_caret_line();
  167. int h = te->get_h_scroll();
  168. int v = te->get_v_scroll();
  169. te->set_text(code);
  170. te->set_caret_line(row);
  171. te->set_caret_column(column);
  172. te->set_h_scroll(h);
  173. te->set_v_scroll(v);
  174. te->tag_saved_version();
  175. update_line_and_column();
  176. }
  177. void ShaderTextEditor::set_warnings_panel(RichTextLabel *p_warnings_panel) {
  178. warnings_panel = p_warnings_panel;
  179. }
  180. void ShaderTextEditor::_load_theme_settings() {
  181. CodeEdit *te = get_text_editor();
  182. Color updated_marked_line_color = EDITOR_GET("text_editor/theme/highlighting/mark_color");
  183. if (updated_marked_line_color != marked_line_color) {
  184. for (int i = 0; i < te->get_line_count(); i++) {
  185. if (te->get_line_background_color(i) == marked_line_color) {
  186. te->set_line_background_color(i, updated_marked_line_color);
  187. }
  188. }
  189. marked_line_color = updated_marked_line_color;
  190. }
  191. syntax_highlighter->set_number_color(EDITOR_GET("text_editor/theme/highlighting/number_color"));
  192. syntax_highlighter->set_symbol_color(EDITOR_GET("text_editor/theme/highlighting/symbol_color"));
  193. syntax_highlighter->set_function_color(EDITOR_GET("text_editor/theme/highlighting/function_color"));
  194. syntax_highlighter->set_member_variable_color(EDITOR_GET("text_editor/theme/highlighting/member_variable_color"));
  195. syntax_highlighter->clear_keyword_colors();
  196. const Color keyword_color = EDITOR_GET("text_editor/theme/highlighting/keyword_color");
  197. const Color control_flow_keyword_color = EDITOR_GET("text_editor/theme/highlighting/control_flow_keyword_color");
  198. List<String> keywords;
  199. ShaderLanguage::get_keyword_list(&keywords);
  200. for (const String &E : keywords) {
  201. if (ShaderLanguage::is_control_flow_keyword(E)) {
  202. syntax_highlighter->add_keyword_color(E, control_flow_keyword_color);
  203. } else {
  204. syntax_highlighter->add_keyword_color(E, keyword_color);
  205. }
  206. }
  207. List<String> pp_keywords;
  208. ShaderPreprocessor::get_keyword_list(&pp_keywords, false);
  209. for (const String &E : pp_keywords) {
  210. syntax_highlighter->add_keyword_color(E, control_flow_keyword_color);
  211. }
  212. // Colorize built-ins like `COLOR` differently to make them easier
  213. // to distinguish from keywords at a quick glance.
  214. List<String> built_ins;
  215. if (shader_inc.is_valid()) {
  216. for (int i = 0; i < RenderingServer::SHADER_MAX; i++) {
  217. for (const KeyValue<StringName, ShaderLanguage::FunctionInfo> &E : ShaderTypes::get_singleton()->get_functions(RenderingServer::ShaderMode(i))) {
  218. for (const KeyValue<StringName, ShaderLanguage::BuiltInInfo> &F : E.value.built_ins) {
  219. built_ins.push_back(F.key);
  220. }
  221. }
  222. {
  223. const Vector<ShaderLanguage::ModeInfo> &render_modes = ShaderTypes::get_singleton()->get_modes(RenderingServer::ShaderMode(i));
  224. for (const ShaderLanguage::ModeInfo &mode_info : render_modes) {
  225. if (!mode_info.options.is_empty()) {
  226. for (const StringName &option : mode_info.options) {
  227. built_ins.push_back(String(mode_info.name) + "_" + String(option));
  228. }
  229. } else {
  230. built_ins.push_back(String(mode_info.name));
  231. }
  232. }
  233. }
  234. {
  235. const Vector<ShaderLanguage::ModeInfo> &stencil_modes = ShaderTypes::get_singleton()->get_stencil_modes(RenderingServer::ShaderMode(i));
  236. for (const ShaderLanguage::ModeInfo &mode_info : stencil_modes) {
  237. if (!mode_info.options.is_empty()) {
  238. for (const StringName &option : mode_info.options) {
  239. built_ins.push_back(String(mode_info.name) + "_" + String(option));
  240. }
  241. } else {
  242. built_ins.push_back(String(mode_info.name));
  243. }
  244. }
  245. }
  246. }
  247. } else if (shader.is_valid()) {
  248. for (const KeyValue<StringName, ShaderLanguage::FunctionInfo> &E : ShaderTypes::get_singleton()->get_functions(RenderingServer::ShaderMode(shader->get_mode()))) {
  249. for (const KeyValue<StringName, ShaderLanguage::BuiltInInfo> &F : E.value.built_ins) {
  250. built_ins.push_back(F.key);
  251. }
  252. }
  253. {
  254. const Vector<ShaderLanguage::ModeInfo> &shader_modes = ShaderTypes::get_singleton()->get_modes(RenderingServer::ShaderMode(shader->get_mode()));
  255. for (const ShaderLanguage::ModeInfo &mode_info : shader_modes) {
  256. if (!mode_info.options.is_empty()) {
  257. for (const StringName &option : mode_info.options) {
  258. built_ins.push_back(String(mode_info.name) + "_" + String(option));
  259. }
  260. } else {
  261. built_ins.push_back(String(mode_info.name));
  262. }
  263. }
  264. }
  265. {
  266. const Vector<ShaderLanguage::ModeInfo> &stencil_modes = ShaderTypes::get_singleton()->get_stencil_modes(RenderingServer::ShaderMode(shader->get_mode()));
  267. for (const ShaderLanguage::ModeInfo &mode_info : stencil_modes) {
  268. if (!mode_info.options.is_empty()) {
  269. for (const StringName &option : mode_info.options) {
  270. built_ins.push_back(String(mode_info.name) + "_" + String(option));
  271. }
  272. } else {
  273. built_ins.push_back(String(mode_info.name));
  274. }
  275. }
  276. }
  277. }
  278. const Color user_type_color = EDITOR_GET("text_editor/theme/highlighting/user_type_color");
  279. for (const String &E : built_ins) {
  280. syntax_highlighter->add_keyword_color(E, user_type_color);
  281. }
  282. // Colorize comments.
  283. const Color comment_color = EDITOR_GET("text_editor/theme/highlighting/comment_color");
  284. syntax_highlighter->clear_color_regions();
  285. syntax_highlighter->add_color_region("/*", "*/", comment_color, false);
  286. syntax_highlighter->add_color_region("//", "", comment_color, true);
  287. const Color doc_comment_color = EDITOR_GET("text_editor/theme/highlighting/doc_comment_color");
  288. syntax_highlighter->add_color_region("/**", "*/", doc_comment_color, false);
  289. // "/**/" will be treated as the start of the "/**" region, this line is guaranteed to end the color_region.
  290. syntax_highlighter->add_color_region("/**/", "", comment_color, true);
  291. // Disabled preprocessor branches use translucent text color to be easier to distinguish from comments.
  292. syntax_highlighter->set_disabled_branch_color(Color(EDITOR_GET("text_editor/theme/highlighting/text_color")) * Color(1, 1, 1, 0.5));
  293. te->clear_comment_delimiters();
  294. te->add_comment_delimiter("/*", "*/", false);
  295. te->add_comment_delimiter("//", "", true);
  296. if (!te->has_auto_brace_completion_open_key("/*")) {
  297. te->add_auto_brace_completion_pair("/*", "*/");
  298. }
  299. // Colorize preprocessor include strings.
  300. const Color string_color = EDITOR_GET("text_editor/theme/highlighting/string_color");
  301. syntax_highlighter->add_color_region("\"", "\"", string_color, false);
  302. if (warnings_panel) {
  303. // Warnings panel.
  304. warnings_panel->add_theme_font_override("normal_font", EditorNode::get_singleton()->get_editor_theme()->get_font(SNAME("main"), EditorStringName(EditorFonts)));
  305. warnings_panel->add_theme_font_size_override("normal_font_size", EditorNode::get_singleton()->get_editor_theme()->get_font_size(SNAME("main_size"), EditorStringName(EditorFonts)));
  306. }
  307. syntax_highlighter->set_uint_suffix_enabled(true);
  308. }
  309. void ShaderTextEditor::_check_shader_mode() {
  310. String type = ShaderLanguage::get_shader_type(get_text_editor()->get_text());
  311. Shader::Mode mode;
  312. if (type == "canvas_item") {
  313. mode = Shader::MODE_CANVAS_ITEM;
  314. } else if (type == "particles") {
  315. mode = Shader::MODE_PARTICLES;
  316. } else if (type == "sky") {
  317. mode = Shader::MODE_SKY;
  318. } else if (type == "fog") {
  319. mode = Shader::MODE_FOG;
  320. } else {
  321. mode = Shader::MODE_SPATIAL;
  322. }
  323. if (shader->get_mode() != mode) {
  324. set_block_shader_changed(true);
  325. shader->set_code(get_text_editor()->get_text());
  326. set_block_shader_changed(false);
  327. _load_theme_settings();
  328. }
  329. }
  330. static ShaderLanguage::DataType _get_global_shader_uniform_type(const StringName &p_variable) {
  331. RS::GlobalShaderParameterType gvt = RS::get_singleton()->global_shader_parameter_get_type(p_variable);
  332. return (ShaderLanguage::DataType)RS::global_shader_uniform_type_get_shader_datatype(gvt);
  333. }
  334. static String complete_from_path;
  335. static void _complete_include_paths_search(EditorFileSystemDirectory *p_efsd, List<ScriptLanguage::CodeCompletionOption> *r_options) {
  336. if (!p_efsd) {
  337. return;
  338. }
  339. for (int i = 0; i < p_efsd->get_file_count(); i++) {
  340. if (p_efsd->get_file_type(i) == SNAME("ShaderInclude")) {
  341. String path = p_efsd->get_file_path(i);
  342. if (path.begins_with(complete_from_path)) {
  343. path = path.replace_first(complete_from_path, "");
  344. }
  345. r_options->push_back(ScriptLanguage::CodeCompletionOption(path, ScriptLanguage::CODE_COMPLETION_KIND_FILE_PATH));
  346. }
  347. }
  348. for (int j = 0; j < p_efsd->get_subdir_count(); j++) {
  349. _complete_include_paths_search(p_efsd->get_subdir(j), r_options);
  350. }
  351. }
  352. static void _complete_include_paths(List<ScriptLanguage::CodeCompletionOption> *r_options) {
  353. _complete_include_paths_search(EditorFileSystem::get_singleton()->get_filesystem(), r_options);
  354. }
  355. void ShaderTextEditor::_code_complete_script(const String &p_code, List<ScriptLanguage::CodeCompletionOption> *r_options) {
  356. List<ScriptLanguage::CodeCompletionOption> pp_options;
  357. List<ScriptLanguage::CodeCompletionOption> pp_defines;
  358. ShaderPreprocessor preprocessor;
  359. String code;
  360. String resource_path = (shader.is_valid() ? shader->get_path() : shader_inc->get_path());
  361. complete_from_path = resource_path.get_base_dir();
  362. if (!complete_from_path.ends_with("/")) {
  363. complete_from_path += "/";
  364. }
  365. preprocessor.preprocess(p_code, resource_path, code, nullptr, nullptr, nullptr, nullptr, &pp_options, &pp_defines, _complete_include_paths);
  366. complete_from_path = String();
  367. if (pp_options.size()) {
  368. for (const ScriptLanguage::CodeCompletionOption &E : pp_options) {
  369. r_options->push_back(E);
  370. }
  371. return;
  372. }
  373. for (const ScriptLanguage::CodeCompletionOption &E : pp_defines) {
  374. r_options->push_back(E);
  375. }
  376. ShaderLanguage sl;
  377. String calltip;
  378. ShaderLanguage::ShaderCompileInfo comp_info;
  379. comp_info.global_shader_uniform_type_func = _get_global_shader_uniform_type;
  380. if (shader.is_null()) {
  381. comp_info.is_include = true;
  382. sl.complete(code, comp_info, r_options, calltip);
  383. get_text_editor()->set_code_hint(calltip);
  384. return;
  385. }
  386. _check_shader_mode();
  387. comp_info.functions = ShaderTypes::get_singleton()->get_functions(RenderingServer::ShaderMode(shader->get_mode()));
  388. comp_info.render_modes = ShaderTypes::get_singleton()->get_modes(RenderingServer::ShaderMode(shader->get_mode()));
  389. comp_info.stencil_modes = ShaderTypes::get_singleton()->get_stencil_modes(RenderingServer::ShaderMode(shader->get_mode()));
  390. comp_info.shader_types = ShaderTypes::get_singleton()->get_types();
  391. sl.complete(code, comp_info, r_options, calltip);
  392. get_text_editor()->set_code_hint(calltip);
  393. }
  394. void ShaderTextEditor::_validate_script() {
  395. emit_signal(CoreStringName(script_changed)); // Ensure to notify that it changed, so it is applied
  396. String code;
  397. if (shader.is_valid()) {
  398. _check_shader_mode();
  399. code = shader->get_code();
  400. } else {
  401. code = shader_inc->get_code();
  402. }
  403. ShaderPreprocessor preprocessor;
  404. String code_pp;
  405. String error_pp;
  406. List<ShaderPreprocessor::FilePosition> err_positions;
  407. List<ShaderPreprocessor::Region> regions;
  408. String filename;
  409. if (shader.is_valid()) {
  410. filename = shader->get_path();
  411. } else if (shader_inc.is_valid()) {
  412. filename = shader_inc->get_path();
  413. }
  414. last_compile_result = preprocessor.preprocess(code, filename, code_pp, &error_pp, &err_positions, &regions);
  415. for (int i = 0; i < get_text_editor()->get_line_count(); i++) {
  416. get_text_editor()->set_line_background_color(i, Color(0, 0, 0, 0));
  417. }
  418. syntax_highlighter->clear_disabled_branch_regions();
  419. for (const ShaderPreprocessor::Region &region : regions) {
  420. if (!region.enabled) {
  421. if (filename != region.file) {
  422. continue;
  423. }
  424. syntax_highlighter->add_disabled_branch_region(Point2i(region.from_line, region.to_line));
  425. }
  426. }
  427. set_error("");
  428. set_error_count(0);
  429. if (last_compile_result != OK) {
  430. // Preprocessor error.
  431. ERR_FAIL_COND(err_positions.is_empty());
  432. String err_text;
  433. const int err_line = err_positions.front()->get().line;
  434. if (err_positions.size() == 1) {
  435. // Error in the main file.
  436. const String message = error_pp.replace("[", "[lb]");
  437. err_text = vformat(TTR("Error at line %d:"), err_line) + " " + message;
  438. } else {
  439. // Error in an included file.
  440. const String inc_file = err_positions.back()->get().file.get_file();
  441. const int inc_line = err_positions.back()->get().line;
  442. const String message = error_pp.replace("[", "[lb]");
  443. err_text = vformat(TTR("Error at line %d in include %s:%d:"), err_line, inc_file, inc_line) + " " + message;
  444. set_error_count(err_positions.size() - 1);
  445. }
  446. set_error(err_text);
  447. set_error_pos(err_line - 1, 0);
  448. for (int i = 0; i < get_text_editor()->get_line_count(); i++) {
  449. get_text_editor()->set_line_background_color(i, Color(0, 0, 0, 0));
  450. }
  451. get_text_editor()->set_line_background_color(err_line - 1, marked_line_color);
  452. set_warning_count(0);
  453. } else {
  454. ShaderLanguage sl;
  455. sl.enable_warning_checking(saved_warnings_enabled);
  456. uint32_t flags = saved_warning_flags;
  457. if (shader.is_null()) {
  458. if (flags & ShaderWarning::UNUSED_CONSTANT) {
  459. flags &= ~(ShaderWarning::UNUSED_CONSTANT);
  460. }
  461. if (flags & ShaderWarning::UNUSED_FUNCTION) {
  462. flags &= ~(ShaderWarning::UNUSED_FUNCTION);
  463. }
  464. if (flags & ShaderWarning::UNUSED_STRUCT) {
  465. flags &= ~(ShaderWarning::UNUSED_STRUCT);
  466. }
  467. if (flags & ShaderWarning::UNUSED_UNIFORM) {
  468. flags &= ~(ShaderWarning::UNUSED_UNIFORM);
  469. }
  470. if (flags & ShaderWarning::UNUSED_VARYING) {
  471. flags &= ~(ShaderWarning::UNUSED_VARYING);
  472. }
  473. }
  474. sl.set_warning_flags(flags);
  475. ShaderLanguage::ShaderCompileInfo comp_info;
  476. comp_info.global_shader_uniform_type_func = _get_global_shader_uniform_type;
  477. if (shader.is_null()) {
  478. comp_info.is_include = true;
  479. } else {
  480. Shader::Mode mode = shader->get_mode();
  481. comp_info.functions = ShaderTypes::get_singleton()->get_functions(RenderingServer::ShaderMode(mode));
  482. comp_info.render_modes = ShaderTypes::get_singleton()->get_modes(RenderingServer::ShaderMode(mode));
  483. comp_info.stencil_modes = ShaderTypes::get_singleton()->get_stencil_modes(RenderingServer::ShaderMode(mode));
  484. comp_info.shader_types = ShaderTypes::get_singleton()->get_types();
  485. }
  486. code = code_pp;
  487. //compiler error
  488. last_compile_result = sl.compile(code, comp_info);
  489. if (last_compile_result != OK) {
  490. Vector<ShaderLanguage::FilePosition> include_positions = sl.get_include_positions();
  491. String err_text;
  492. int err_line;
  493. if (include_positions.size() > 1) {
  494. // Error in an included file.
  495. err_line = include_positions[0].line;
  496. const String inc_file = include_positions[include_positions.size() - 1].file;
  497. const int inc_line = include_positions[include_positions.size() - 1].line;
  498. const String message = sl.get_error_text().replace("[", "[lb]");
  499. err_text = vformat(TTR("Error at line %d in include %s:%d:"), err_line, inc_file, inc_line) + " " + message;
  500. set_error_count(include_positions.size() - 1);
  501. } else {
  502. // Error in the main file.
  503. err_line = sl.get_error_line();
  504. const String message = sl.get_error_text().replace("[", "[lb]");
  505. err_text = vformat(TTR("Error at line %d:"), err_line) + " " + message;
  506. set_error_count(0);
  507. }
  508. set_error(err_text);
  509. set_error_pos(err_line - 1, 0);
  510. get_text_editor()->set_line_background_color(err_line - 1, marked_line_color);
  511. } else {
  512. set_error("");
  513. }
  514. if (warnings.size() > 0 || last_compile_result != OK) {
  515. warnings_panel->clear();
  516. }
  517. warnings.clear();
  518. for (List<ShaderWarning>::Element *E = sl.get_warnings_ptr(); E; E = E->next()) {
  519. warnings.push_back(E->get());
  520. }
  521. if (warnings.size() > 0 && last_compile_result == OK) {
  522. warnings.sort_custom<WarningsComparator>();
  523. _update_warning_panel();
  524. } else {
  525. set_warning_count(0);
  526. }
  527. }
  528. emit_signal(SNAME("script_validated"), last_compile_result == OK); // Notify that validation finished, to update the list of scripts
  529. }
  530. void ShaderTextEditor::_update_warning_panel() {
  531. int warning_count = 0;
  532. warnings_panel->push_table(2);
  533. for (const ShaderWarning &w : warnings) {
  534. if (warning_count == 0) {
  535. if (saved_treat_warning_as_errors) {
  536. const String message = (w.get_message() + " " + TTR("Warnings should be fixed to prevent errors.")).replace("[", "[lb]");
  537. const String error_text = vformat(TTR("Error at line %d:"), w.get_line()) + " " + message;
  538. set_error(error_text);
  539. set_error_pos(w.get_line() - 1, 0);
  540. get_text_editor()->set_line_background_color(w.get_line() - 1, marked_line_color);
  541. }
  542. }
  543. warning_count++;
  544. int line = w.get_line();
  545. // First cell.
  546. warnings_panel->push_cell();
  547. warnings_panel->push_color(warnings_panel->get_theme_color(SNAME("warning_color"), EditorStringName(Editor)));
  548. if (line != -1) {
  549. warnings_panel->push_meta(line - 1);
  550. warnings_panel->add_text(vformat(TTR("Line %d (%s):"), line, w.get_name()));
  551. warnings_panel->pop(); // Meta goto.
  552. } else {
  553. warnings_panel->add_text(w.get_name() + ":");
  554. }
  555. warnings_panel->pop(); // Color.
  556. warnings_panel->pop(); // Cell.
  557. // Second cell.
  558. warnings_panel->push_cell();
  559. warnings_panel->add_text(w.get_message());
  560. warnings_panel->pop(); // Cell.
  561. }
  562. warnings_panel->pop(); // Table.
  563. set_warning_count(warning_count);
  564. }
  565. void ShaderTextEditor::_bind_methods() {
  566. ADD_SIGNAL(MethodInfo("script_validated", PropertyInfo(Variant::BOOL, "valid")));
  567. }
  568. ShaderTextEditor::ShaderTextEditor() {
  569. syntax_highlighter.instantiate();
  570. get_text_editor()->set_syntax_highlighter(syntax_highlighter);
  571. }
  572. /*** SCRIPT EDITOR ******/
  573. void TextShaderEditor::_menu_option(int p_option) {
  574. code_editor->get_text_editor()->apply_ime();
  575. switch (p_option) {
  576. case EDIT_UNDO: {
  577. code_editor->get_text_editor()->undo();
  578. } break;
  579. case EDIT_REDO: {
  580. code_editor->get_text_editor()->redo();
  581. } break;
  582. case EDIT_CUT: {
  583. code_editor->get_text_editor()->cut();
  584. } break;
  585. case EDIT_COPY: {
  586. code_editor->get_text_editor()->copy();
  587. } break;
  588. case EDIT_PASTE: {
  589. code_editor->get_text_editor()->paste();
  590. } break;
  591. case EDIT_SELECT_ALL: {
  592. code_editor->get_text_editor()->select_all();
  593. } break;
  594. case EDIT_MOVE_LINE_UP: {
  595. code_editor->get_text_editor()->move_lines_up();
  596. } break;
  597. case EDIT_MOVE_LINE_DOWN: {
  598. code_editor->get_text_editor()->move_lines_down();
  599. } break;
  600. case EDIT_INDENT: {
  601. if (shader.is_null() && shader_inc.is_null()) {
  602. return;
  603. }
  604. code_editor->get_text_editor()->indent_lines();
  605. } break;
  606. case EDIT_UNINDENT: {
  607. if (shader.is_null() && shader_inc.is_null()) {
  608. return;
  609. }
  610. code_editor->get_text_editor()->unindent_lines();
  611. } break;
  612. case EDIT_DELETE_LINE: {
  613. code_editor->get_text_editor()->delete_lines();
  614. } break;
  615. case EDIT_DUPLICATE_SELECTION: {
  616. code_editor->get_text_editor()->duplicate_selection();
  617. } break;
  618. case EDIT_DUPLICATE_LINES: {
  619. code_editor->get_text_editor()->duplicate_lines();
  620. } break;
  621. case EDIT_TOGGLE_WORD_WRAP: {
  622. TextEdit::LineWrappingMode wrap = code_editor->get_text_editor()->get_line_wrapping_mode();
  623. code_editor->get_text_editor()->set_line_wrapping_mode(wrap == TextEdit::LINE_WRAPPING_BOUNDARY ? TextEdit::LINE_WRAPPING_NONE : TextEdit::LINE_WRAPPING_BOUNDARY);
  624. } break;
  625. case EDIT_TOGGLE_COMMENT: {
  626. if (shader.is_null() && shader_inc.is_null()) {
  627. return;
  628. }
  629. code_editor->toggle_inline_comment("//");
  630. } break;
  631. case EDIT_COMPLETE: {
  632. code_editor->get_text_editor()->request_code_completion();
  633. } break;
  634. case SEARCH_FIND: {
  635. code_editor->get_find_replace_bar()->popup_search();
  636. } break;
  637. case SEARCH_FIND_NEXT: {
  638. code_editor->get_find_replace_bar()->search_next();
  639. } break;
  640. case SEARCH_FIND_PREV: {
  641. code_editor->get_find_replace_bar()->search_prev();
  642. } break;
  643. case SEARCH_REPLACE: {
  644. code_editor->get_find_replace_bar()->popup_replace();
  645. } break;
  646. case SEARCH_GOTO_LINE: {
  647. goto_line_popup->popup_find_line(code_editor);
  648. } break;
  649. case BOOKMARK_TOGGLE: {
  650. code_editor->toggle_bookmark();
  651. } break;
  652. case BOOKMARK_GOTO_NEXT: {
  653. code_editor->goto_next_bookmark();
  654. } break;
  655. case BOOKMARK_GOTO_PREV: {
  656. code_editor->goto_prev_bookmark();
  657. } break;
  658. case BOOKMARK_REMOVE_ALL: {
  659. code_editor->remove_all_bookmarks();
  660. } break;
  661. case HELP_DOCS: {
  662. OS::get_singleton()->shell_open(vformat("%s/tutorials/shaders/shader_reference/index.html", GODOT_VERSION_DOCS_URL));
  663. } break;
  664. case EDIT_EMOJI_AND_SYMBOL: {
  665. code_editor->get_text_editor()->show_emoji_and_symbol_picker();
  666. } break;
  667. }
  668. if (p_option != SEARCH_FIND && p_option != SEARCH_REPLACE && p_option != SEARCH_GOTO_LINE) {
  669. callable_mp((Control *)code_editor->get_text_editor(), &Control::grab_focus).call_deferred();
  670. }
  671. }
  672. void TextShaderEditor::_prepare_edit_menu() {
  673. const CodeEdit *tx = code_editor->get_text_editor();
  674. PopupMenu *popup = edit_menu->get_popup();
  675. popup->set_item_disabled(popup->get_item_index(EDIT_UNDO), !tx->has_undo());
  676. popup->set_item_disabled(popup->get_item_index(EDIT_REDO), !tx->has_redo());
  677. }
  678. void TextShaderEditor::_notification(int p_what) {
  679. switch (p_what) {
  680. case NOTIFICATION_THEME_CHANGED: {
  681. site_search->set_button_icon(get_editor_theme_icon(SNAME("ExternalLink")));
  682. } break;
  683. case NOTIFICATION_APPLICATION_FOCUS_IN: {
  684. _check_for_external_edit();
  685. } break;
  686. }
  687. }
  688. void TextShaderEditor::_editor_settings_changed() {
  689. if (!EditorThemeManager::is_generated_theme_outdated() &&
  690. !EditorSettings::get_singleton()->check_changed_settings_in_group("interface/editor") &&
  691. !EditorSettings::get_singleton()->check_changed_settings_in_group("text_editor")) {
  692. return;
  693. }
  694. _apply_editor_settings();
  695. }
  696. void TextShaderEditor::_apply_editor_settings() {
  697. code_editor->update_editor_settings();
  698. trim_trailing_whitespace_on_save = EDITOR_GET("text_editor/behavior/files/trim_trailing_whitespace_on_save");
  699. trim_final_newlines_on_save = EDITOR_GET("text_editor/behavior/files/trim_final_newlines_on_save");
  700. }
  701. void TextShaderEditor::_show_warnings_panel(bool p_show) {
  702. warnings_panel->set_visible(p_show);
  703. }
  704. void TextShaderEditor::_warning_clicked(const Variant &p_line) {
  705. if (p_line.get_type() == Variant::INT) {
  706. code_editor->goto_line_centered(p_line.operator int64_t());
  707. }
  708. }
  709. void TextShaderEditor::_bind_methods() {
  710. ClassDB::bind_method("_show_warnings_panel", &TextShaderEditor::_show_warnings_panel);
  711. ClassDB::bind_method("_warning_clicked", &TextShaderEditor::_warning_clicked);
  712. ADD_SIGNAL(MethodInfo("validation_changed"));
  713. }
  714. void TextShaderEditor::ensure_select_current() {
  715. }
  716. void TextShaderEditor::goto_line_selection(int p_line, int p_begin, int p_end) {
  717. code_editor->goto_line_selection(p_line, p_begin, p_end);
  718. }
  719. void TextShaderEditor::_project_settings_changed() {
  720. _update_warnings(true);
  721. }
  722. void TextShaderEditor::_update_warnings(bool p_validate) {
  723. bool changed = false;
  724. bool warnings_enabled = GLOBAL_GET("debug/shader_language/warnings/enable").booleanize();
  725. if (warnings_enabled != saved_warnings_enabled) {
  726. saved_warnings_enabled = warnings_enabled;
  727. changed = true;
  728. }
  729. bool treat_warning_as_errors = GLOBAL_GET("debug/shader_language/warnings/treat_warnings_as_errors").booleanize();
  730. if (treat_warning_as_errors != saved_treat_warning_as_errors) {
  731. saved_treat_warning_as_errors = treat_warning_as_errors;
  732. changed = true;
  733. }
  734. bool update_flags = false;
  735. for (int i = 0; i < ShaderWarning::WARNING_MAX; i++) {
  736. ShaderWarning::Code code = (ShaderWarning::Code)i;
  737. bool value = GLOBAL_GET("debug/shader_language/warnings/" + ShaderWarning::get_name_from_code(code).to_lower());
  738. if (saved_warnings[code] != value) {
  739. saved_warnings[code] = value;
  740. update_flags = true;
  741. changed = true;
  742. }
  743. }
  744. if (update_flags) {
  745. saved_warning_flags = (uint32_t)ShaderWarning::get_flags_from_codemap(saved_warnings);
  746. }
  747. if (p_validate && changed && code_editor && code_editor->get_edited_shader().is_valid()) {
  748. code_editor->validate_script();
  749. }
  750. }
  751. void TextShaderEditor::_check_for_external_edit() {
  752. bool use_autoreload = bool(EDITOR_GET("text_editor/behavior/files/auto_reload_scripts_on_external_change"));
  753. if (shader_inc.is_valid()) {
  754. if (shader_inc->get_last_modified_time() != FileAccess::get_modified_time(shader_inc->get_path())) {
  755. if (use_autoreload) {
  756. _reload_shader_include_from_disk();
  757. } else {
  758. callable_mp((Window *)disk_changed, &Window::popup_centered).call_deferred(Size2i());
  759. }
  760. }
  761. return;
  762. }
  763. if (shader.is_null() || shader->is_built_in()) {
  764. return;
  765. }
  766. if (shader->get_last_modified_time() != FileAccess::get_modified_time(shader->get_path())) {
  767. if (use_autoreload) {
  768. _reload_shader_from_disk();
  769. } else {
  770. callable_mp((Window *)disk_changed, &Window::popup_centered).call_deferred(Size2i());
  771. }
  772. }
  773. }
  774. void TextShaderEditor::_reload_shader_from_disk() {
  775. Ref<Shader> rel_shader = ResourceLoader::load(shader->get_path(), shader->get_class(), ResourceFormatLoader::CACHE_MODE_IGNORE);
  776. ERR_FAIL_COND(rel_shader.is_null());
  777. code_editor->set_block_shader_changed(true);
  778. shader->set_code(rel_shader->get_code());
  779. code_editor->set_block_shader_changed(false);
  780. shader->set_last_modified_time(rel_shader->get_last_modified_time());
  781. code_editor->reload_text();
  782. }
  783. void TextShaderEditor::_reload_shader_include_from_disk() {
  784. Ref<ShaderInclude> rel_shader_include = ResourceLoader::load(shader_inc->get_path(), shader_inc->get_class(), ResourceFormatLoader::CACHE_MODE_IGNORE);
  785. ERR_FAIL_COND(rel_shader_include.is_null());
  786. code_editor->set_block_shader_changed(true);
  787. shader_inc->set_code(rel_shader_include->get_code());
  788. code_editor->set_block_shader_changed(false);
  789. shader_inc->set_last_modified_time(rel_shader_include->get_last_modified_time());
  790. code_editor->reload_text();
  791. }
  792. void TextShaderEditor::_reload() {
  793. if (shader.is_valid()) {
  794. _reload_shader_from_disk();
  795. } else if (shader_inc.is_valid()) {
  796. _reload_shader_include_from_disk();
  797. }
  798. }
  799. void TextShaderEditor::edit_shader(const Ref<Shader> &p_shader) {
  800. if (p_shader.is_null() || !p_shader->is_text_shader()) {
  801. return;
  802. }
  803. if (shader == p_shader) {
  804. return;
  805. }
  806. shader = p_shader;
  807. shader_inc = Ref<ShaderInclude>();
  808. code_editor->set_edited_shader(shader);
  809. }
  810. void TextShaderEditor::edit_shader_include(const Ref<ShaderInclude> &p_shader_inc) {
  811. if (p_shader_inc.is_null()) {
  812. return;
  813. }
  814. if (shader_inc == p_shader_inc) {
  815. return;
  816. }
  817. shader_inc = p_shader_inc;
  818. shader = Ref<Shader>();
  819. code_editor->set_edited_shader_include(p_shader_inc);
  820. }
  821. void TextShaderEditor::save_external_data(const String &p_str) {
  822. if (shader.is_null() && shader_inc.is_null()) {
  823. disk_changed->hide();
  824. return;
  825. }
  826. if (trim_trailing_whitespace_on_save) {
  827. trim_trailing_whitespace();
  828. }
  829. if (trim_final_newlines_on_save) {
  830. trim_final_newlines();
  831. }
  832. apply_shaders();
  833. Ref<Shader> edited_shader = code_editor->get_edited_shader();
  834. if (edited_shader.is_valid()) {
  835. ResourceSaver::save(edited_shader);
  836. }
  837. if (shader.is_valid() && shader != edited_shader) {
  838. ResourceSaver::save(shader);
  839. }
  840. Ref<ShaderInclude> edited_shader_inc = code_editor->get_edited_shader_include();
  841. if (edited_shader_inc.is_valid()) {
  842. ResourceSaver::save(edited_shader_inc);
  843. }
  844. if (shader_inc.is_valid() && shader_inc != edited_shader_inc) {
  845. ResourceSaver::save(shader_inc);
  846. }
  847. code_editor->get_text_editor()->tag_saved_version();
  848. disk_changed->hide();
  849. }
  850. void TextShaderEditor::trim_trailing_whitespace() {
  851. code_editor->trim_trailing_whitespace();
  852. }
  853. void TextShaderEditor::trim_final_newlines() {
  854. code_editor->trim_final_newlines();
  855. }
  856. void TextShaderEditor::validate_script() {
  857. code_editor->_validate_script();
  858. }
  859. Control *TextShaderEditor::get_top_bar() {
  860. return hbc;
  861. }
  862. bool TextShaderEditor::is_unsaved() const {
  863. return code_editor->get_text_editor()->get_saved_version() != code_editor->get_text_editor()->get_version();
  864. }
  865. void TextShaderEditor::tag_saved_version() {
  866. code_editor->get_text_editor()->tag_saved_version();
  867. }
  868. void TextShaderEditor::apply_shaders() {
  869. String editor_code = code_editor->get_text_editor()->get_text();
  870. if (shader.is_valid()) {
  871. String shader_code = shader->get_code();
  872. if (shader_code != editor_code || dependencies_version != code_editor->get_dependencies_version()) {
  873. code_editor->set_block_shader_changed(true);
  874. shader->set_code(editor_code);
  875. code_editor->set_block_shader_changed(false);
  876. shader->set_edited(true);
  877. }
  878. }
  879. if (shader_inc.is_valid()) {
  880. String shader_inc_code = shader_inc->get_code();
  881. if (shader_inc_code != editor_code || dependencies_version != code_editor->get_dependencies_version()) {
  882. code_editor->set_block_shader_changed(true);
  883. shader_inc->set_code(editor_code);
  884. code_editor->set_block_shader_changed(false);
  885. shader_inc->set_edited(true);
  886. }
  887. }
  888. dependencies_version = code_editor->get_dependencies_version();
  889. }
  890. void TextShaderEditor::_text_edit_gui_input(const Ref<InputEvent> &ev) {
  891. Ref<InputEventMouseButton> mb = ev;
  892. if (mb.is_valid()) {
  893. if (mb->get_button_index() == MouseButton::RIGHT && mb->is_pressed()) {
  894. CodeEdit *tx = code_editor->get_text_editor();
  895. tx->apply_ime();
  896. Point2i pos = tx->get_line_column_at_pos(mb->get_global_position() - tx->get_global_position());
  897. int row = pos.y;
  898. int col = pos.x;
  899. tx->set_move_caret_on_right_click_enabled(EDITOR_GET("text_editor/behavior/navigation/move_caret_on_right_click"));
  900. if (tx->is_move_caret_on_right_click_enabled()) {
  901. tx->remove_secondary_carets();
  902. if (tx->has_selection()) {
  903. int from_line = tx->get_selection_from_line();
  904. int to_line = tx->get_selection_to_line();
  905. int from_column = tx->get_selection_from_column();
  906. int to_column = tx->get_selection_to_column();
  907. if (row < from_line || row > to_line || (row == from_line && col < from_column) || (row == to_line && col > to_column)) {
  908. // Right click is outside the selected text
  909. tx->deselect();
  910. }
  911. }
  912. if (!tx->has_selection()) {
  913. tx->set_caret_line(row, true, false, -1);
  914. tx->set_caret_column(col);
  915. }
  916. }
  917. _make_context_menu(tx->has_selection(), get_local_mouse_position());
  918. }
  919. }
  920. Ref<InputEventKey> k = ev;
  921. if (k.is_valid() && k->is_pressed() && k->is_action("ui_menu", true)) {
  922. CodeEdit *tx = code_editor->get_text_editor();
  923. tx->adjust_viewport_to_caret();
  924. _make_context_menu(tx->has_selection(), (get_global_transform().inverse() * tx->get_global_transform()).xform(tx->get_caret_draw_pos()));
  925. context_menu->grab_focus();
  926. }
  927. }
  928. void TextShaderEditor::_update_bookmark_list() {
  929. bookmarks_menu->clear();
  930. bookmarks_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_bookmark"), BOOKMARK_TOGGLE);
  931. bookmarks_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/remove_all_bookmarks"), BOOKMARK_REMOVE_ALL);
  932. bookmarks_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/goto_next_bookmark"), BOOKMARK_GOTO_NEXT);
  933. bookmarks_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/goto_previous_bookmark"), BOOKMARK_GOTO_PREV);
  934. PackedInt32Array bookmark_list = code_editor->get_text_editor()->get_bookmarked_lines();
  935. if (bookmark_list.is_empty()) {
  936. return;
  937. }
  938. bookmarks_menu->add_separator();
  939. for (int i = 0; i < bookmark_list.size(); i++) {
  940. String line = code_editor->get_text_editor()->get_line(bookmark_list[i]).strip_edges();
  941. // Limit the size of the line if too big.
  942. if (line.length() > 50) {
  943. line = line.substr(0, 50);
  944. }
  945. bookmarks_menu->add_item(String::num_int64(bookmark_list[i] + 1) + " - \"" + line + "\"");
  946. bookmarks_menu->set_item_metadata(-1, bookmark_list[i]);
  947. }
  948. }
  949. void TextShaderEditor::_bookmark_item_pressed(int p_idx) {
  950. if (p_idx < 4) { // Any item before the separator.
  951. _menu_option(bookmarks_menu->get_item_id(p_idx));
  952. } else {
  953. code_editor->goto_line(bookmarks_menu->get_item_metadata(p_idx));
  954. }
  955. }
  956. void TextShaderEditor::_make_context_menu(bool p_selection, Vector2 p_position) {
  957. context_menu->clear();
  958. if (DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_EMOJI_AND_SYMBOL_PICKER)) {
  959. context_menu->add_item(TTR("Emoji & Symbols"), EDIT_EMOJI_AND_SYMBOL);
  960. context_menu->add_separator();
  961. }
  962. if (p_selection) {
  963. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_cut"), EDIT_CUT);
  964. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_copy"), EDIT_COPY);
  965. }
  966. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_paste"), EDIT_PASTE);
  967. context_menu->add_separator();
  968. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_text_select_all"), EDIT_SELECT_ALL);
  969. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_undo"), EDIT_UNDO);
  970. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_redo"), EDIT_REDO);
  971. context_menu->add_separator();
  972. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/indent"), EDIT_INDENT);
  973. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/unindent"), EDIT_UNINDENT);
  974. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_comment"), EDIT_TOGGLE_COMMENT);
  975. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_bookmark"), BOOKMARK_TOGGLE);
  976. context_menu->set_item_disabled(context_menu->get_item_index(EDIT_UNDO), !code_editor->get_text_editor()->has_undo());
  977. context_menu->set_item_disabled(context_menu->get_item_index(EDIT_REDO), !code_editor->get_text_editor()->has_redo());
  978. context_menu->set_position(get_screen_position() + p_position);
  979. context_menu->reset_size();
  980. context_menu->popup();
  981. }
  982. TextShaderEditor::TextShaderEditor() {
  983. _update_warnings(false);
  984. code_editor = memnew(ShaderTextEditor);
  985. code_editor->connect("script_validated", callable_mp(this, &TextShaderEditor::_script_validated));
  986. code_editor->set_v_size_flags(SIZE_EXPAND_FILL);
  987. code_editor->add_theme_constant_override("separation", 0);
  988. code_editor->set_anchors_and_offsets_preset(Control::PRESET_FULL_RECT);
  989. code_editor->connect("show_warnings_panel", callable_mp(this, &TextShaderEditor::_show_warnings_panel));
  990. code_editor->connect(CoreStringName(script_changed), callable_mp(this, &TextShaderEditor::apply_shaders));
  991. EditorSettings::get_singleton()->connect("settings_changed", callable_mp(this, &TextShaderEditor::_editor_settings_changed));
  992. ProjectSettings::get_singleton()->connect("settings_changed", callable_mp(this, &TextShaderEditor::_project_settings_changed));
  993. code_editor->get_text_editor()->set_symbol_lookup_on_click_enabled(true);
  994. code_editor->get_text_editor()->set_context_menu_enabled(false);
  995. code_editor->get_text_editor()->set_draw_breakpoints_gutter(false);
  996. code_editor->get_text_editor()->set_draw_executing_lines_gutter(false);
  997. code_editor->get_text_editor()->connect(SceneStringName(gui_input), callable_mp(this, &TextShaderEditor::_text_edit_gui_input));
  998. code_editor->update_editor_settings();
  999. context_menu = memnew(PopupMenu);
  1000. add_child(context_menu);
  1001. context_menu->connect(SceneStringName(id_pressed), callable_mp(this, &TextShaderEditor::_menu_option));
  1002. VBoxContainer *main_container = memnew(VBoxContainer);
  1003. main_container->set_anchors_and_offsets_preset(Control::PRESET_FULL_RECT);
  1004. hbc = memnew(HBoxContainer);
  1005. edit_menu = memnew(MenuButton);
  1006. edit_menu->set_shortcut_context(this);
  1007. edit_menu->set_text(TTR("Edit"));
  1008. edit_menu->set_switch_on_hover(true);
  1009. edit_menu->connect("about_to_popup", callable_mp(this, &TextShaderEditor::_prepare_edit_menu));
  1010. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_undo"), EDIT_UNDO);
  1011. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_redo"), EDIT_REDO);
  1012. edit_menu->get_popup()->add_separator();
  1013. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_cut"), EDIT_CUT);
  1014. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_copy"), EDIT_COPY);
  1015. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_paste"), EDIT_PASTE);
  1016. edit_menu->get_popup()->add_separator();
  1017. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_text_select_all"), EDIT_SELECT_ALL);
  1018. edit_menu->get_popup()->add_separator();
  1019. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/move_up"), EDIT_MOVE_LINE_UP);
  1020. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/move_down"), EDIT_MOVE_LINE_DOWN);
  1021. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/indent"), EDIT_INDENT);
  1022. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/unindent"), EDIT_UNINDENT);
  1023. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/delete_line"), EDIT_DELETE_LINE);
  1024. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_comment"), EDIT_TOGGLE_COMMENT);
  1025. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/duplicate_selection"), EDIT_DUPLICATE_SELECTION);
  1026. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/duplicate_lines"), EDIT_DUPLICATE_LINES);
  1027. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_word_wrap"), EDIT_TOGGLE_WORD_WRAP);
  1028. edit_menu->get_popup()->add_separator();
  1029. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_text_completion_query"), EDIT_COMPLETE);
  1030. edit_menu->get_popup()->connect(SceneStringName(id_pressed), callable_mp(this, &TextShaderEditor::_menu_option));
  1031. search_menu = memnew(MenuButton);
  1032. search_menu->set_shortcut_context(this);
  1033. search_menu->set_text(TTR("Search"));
  1034. search_menu->set_switch_on_hover(true);
  1035. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/find"), SEARCH_FIND);
  1036. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/find_next"), SEARCH_FIND_NEXT);
  1037. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/find_previous"), SEARCH_FIND_PREV);
  1038. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/replace"), SEARCH_REPLACE);
  1039. search_menu->get_popup()->connect(SceneStringName(id_pressed), callable_mp(this, &TextShaderEditor::_menu_option));
  1040. MenuButton *goto_menu = memnew(MenuButton);
  1041. goto_menu->set_shortcut_context(this);
  1042. goto_menu->set_text(TTR("Go To"));
  1043. goto_menu->set_switch_on_hover(true);
  1044. goto_menu->get_popup()->connect(SceneStringName(id_pressed), callable_mp(this, &TextShaderEditor::_menu_option));
  1045. goto_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/goto_line"), SEARCH_GOTO_LINE);
  1046. goto_menu->get_popup()->add_separator();
  1047. bookmarks_menu = memnew(PopupMenu);
  1048. goto_menu->get_popup()->add_submenu_node_item(TTR("Bookmarks"), bookmarks_menu);
  1049. _update_bookmark_list();
  1050. bookmarks_menu->connect("about_to_popup", callable_mp(this, &TextShaderEditor::_update_bookmark_list));
  1051. bookmarks_menu->connect("index_pressed", callable_mp(this, &TextShaderEditor::_bookmark_item_pressed));
  1052. add_child(main_container);
  1053. hbc->add_child(edit_menu);
  1054. hbc->add_child(search_menu);
  1055. hbc->add_child(goto_menu);
  1056. hbc->add_spacer();
  1057. site_search = memnew(Button);
  1058. site_search->set_flat(true);
  1059. site_search->connect(SceneStringName(pressed), callable_mp(this, &TextShaderEditor::_menu_option).bind(HELP_DOCS));
  1060. site_search->set_text(TTR("Online Docs"));
  1061. site_search->set_tooltip_text(TTR("Open Godot online documentation."));
  1062. hbc->add_child(site_search);
  1063. hbc->add_child(memnew(VSeparator));
  1064. hbc->add_theme_style_override(SceneStringName(panel), EditorNode::get_singleton()->get_editor_theme()->get_stylebox(SNAME("ScriptEditorPanel"), EditorStringName(EditorStyles)));
  1065. VSplitContainer *editor_box = memnew(VSplitContainer);
  1066. main_container->add_child(editor_box);
  1067. editor_box->set_anchors_and_offsets_preset(Control::PRESET_FULL_RECT);
  1068. editor_box->set_v_size_flags(SIZE_EXPAND_FILL);
  1069. editor_box->add_child(code_editor);
  1070. FindReplaceBar *bar = memnew(FindReplaceBar);
  1071. main_container->add_child(bar);
  1072. bar->hide();
  1073. code_editor->set_find_replace_bar(bar);
  1074. warnings_panel = memnew(RichTextLabel);
  1075. warnings_panel->set_custom_minimum_size(Size2(0, 100 * EDSCALE));
  1076. warnings_panel->set_h_size_flags(SIZE_EXPAND_FILL);
  1077. warnings_panel->set_meta_underline(true);
  1078. warnings_panel->set_selection_enabled(true);
  1079. warnings_panel->set_context_menu_enabled(true);
  1080. warnings_panel->set_focus_mode(FOCUS_CLICK);
  1081. warnings_panel->hide();
  1082. warnings_panel->connect("meta_clicked", callable_mp(this, &TextShaderEditor::_warning_clicked));
  1083. editor_box->add_child(warnings_panel);
  1084. code_editor->set_warnings_panel(warnings_panel);
  1085. goto_line_popup = memnew(GotoLinePopup);
  1086. add_child(goto_line_popup);
  1087. disk_changed = memnew(ConfirmationDialog);
  1088. VBoxContainer *vbc = memnew(VBoxContainer);
  1089. disk_changed->add_child(vbc);
  1090. Label *dl = memnew(Label);
  1091. dl->set_focus_mode(FOCUS_ACCESSIBILITY);
  1092. dl->set_text(TTR("This shader has been modified on disk.\nWhat action should be taken?"));
  1093. vbc->add_child(dl);
  1094. disk_changed->connect(SceneStringName(confirmed), callable_mp(this, &TextShaderEditor::_reload));
  1095. disk_changed->set_ok_button_text(TTR("Reload"));
  1096. disk_changed->add_button(TTR("Resave"), !DisplayServer::get_singleton()->get_swap_cancel_ok(), "resave");
  1097. disk_changed->connect("custom_action", callable_mp(this, &TextShaderEditor::save_external_data));
  1098. add_child(disk_changed);
  1099. _editor_settings_changed();
  1100. code_editor->show_toggle_files_button(); // TODO: Disabled for now, because it doesn't work properly.
  1101. }