find_in_files.cpp 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989
  1. /*************************************************************************/
  2. /* find_in_files.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2020 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 "find_in_files.h"
  31. #include "core/os/dir_access.h"
  32. #include "core/os/os.h"
  33. #include "editor_node.h"
  34. #include "editor_scale.h"
  35. #include "scene/gui/box_container.h"
  36. #include "scene/gui/button.h"
  37. #include "scene/gui/check_box.h"
  38. #include "scene/gui/file_dialog.h"
  39. #include "scene/gui/grid_container.h"
  40. #include "scene/gui/label.h"
  41. #include "scene/gui/line_edit.h"
  42. #include "scene/gui/progress_bar.h"
  43. #include "scene/gui/tree.h"
  44. const char *FindInFiles::SIGNAL_RESULT_FOUND = "result_found";
  45. const char *FindInFiles::SIGNAL_FINISHED = "finished";
  46. // TODO Would be nice in Vector and Vectors
  47. template <typename T>
  48. inline void pop_back(T &container) {
  49. container.resize(container.size() - 1);
  50. }
  51. // TODO Copied from TextEdit private, would be nice to extract it in a single place
  52. static bool is_text_char(CharType c) {
  53. return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || c == '_';
  54. }
  55. static bool find_next(const String &line, String pattern, int from, bool match_case, bool whole_words, int &out_begin, int &out_end) {
  56. int end = from;
  57. while (true) {
  58. int begin = match_case ? line.find(pattern, end) : line.findn(pattern, end);
  59. if (begin == -1)
  60. return false;
  61. end = begin + pattern.length();
  62. out_begin = begin;
  63. out_end = end;
  64. if (whole_words) {
  65. if (begin > 0 && is_text_char(line[begin - 1])) {
  66. continue;
  67. }
  68. if (end < line.size() && is_text_char(line[end])) {
  69. continue;
  70. }
  71. }
  72. return true;
  73. }
  74. }
  75. //--------------------------------------------------------------------------------
  76. FindInFiles::FindInFiles() {
  77. _searching = false;
  78. _whole_words = true;
  79. _match_case = true;
  80. }
  81. void FindInFiles::set_search_text(String p_pattern) {
  82. _pattern = p_pattern;
  83. }
  84. void FindInFiles::set_whole_words(bool p_whole_word) {
  85. _whole_words = p_whole_word;
  86. }
  87. void FindInFiles::set_match_case(bool p_match_case) {
  88. _match_case = p_match_case;
  89. }
  90. void FindInFiles::set_folder(String folder) {
  91. _root_dir = folder;
  92. }
  93. void FindInFiles::set_filter(const Set<String> &exts) {
  94. _extension_filter = exts;
  95. }
  96. void FindInFiles::_notification(int p_notification) {
  97. if (p_notification == NOTIFICATION_PROCESS) {
  98. _process();
  99. }
  100. }
  101. void FindInFiles::start() {
  102. if (_pattern == "") {
  103. print_verbose("Nothing to search, pattern is empty");
  104. emit_signal(SIGNAL_FINISHED);
  105. return;
  106. }
  107. if (_extension_filter.size() == 0) {
  108. print_verbose("Nothing to search, filter matches no files");
  109. emit_signal(SIGNAL_FINISHED);
  110. return;
  111. }
  112. // Init search
  113. _current_dir = "";
  114. PackedStringArray init_folder;
  115. init_folder.push_back(_root_dir);
  116. _folders_stack.clear();
  117. _folders_stack.push_back(init_folder);
  118. _initial_files_count = 0;
  119. _searching = true;
  120. set_process(true);
  121. }
  122. void FindInFiles::stop() {
  123. _searching = false;
  124. _current_dir = "";
  125. set_process(false);
  126. }
  127. void FindInFiles::_process() {
  128. // This part can be moved to a thread if needed
  129. OS &os = *OS::get_singleton();
  130. float time_before = os.get_ticks_msec();
  131. while (is_processing()) {
  132. _iterate();
  133. float elapsed = (os.get_ticks_msec() - time_before);
  134. if (elapsed > 1000.0 / 120.0)
  135. break;
  136. }
  137. }
  138. void FindInFiles::_iterate() {
  139. if (_folders_stack.size() != 0) {
  140. // Scan folders first so we can build a list of files and have progress info later
  141. PackedStringArray &folders_to_scan = _folders_stack.write[_folders_stack.size() - 1];
  142. if (folders_to_scan.size() != 0) {
  143. // Scan one folder below
  144. String folder_name = folders_to_scan[folders_to_scan.size() - 1];
  145. pop_back(folders_to_scan);
  146. _current_dir = _current_dir.plus_file(folder_name);
  147. PackedStringArray sub_dirs;
  148. _scan_dir("res://" + _current_dir, sub_dirs);
  149. _folders_stack.push_back(sub_dirs);
  150. } else {
  151. // Go back one level
  152. pop_back(_folders_stack);
  153. _current_dir = _current_dir.get_base_dir();
  154. if (_folders_stack.size() == 0) {
  155. // All folders scanned
  156. _initial_files_count = _files_to_scan.size();
  157. }
  158. }
  159. } else if (_files_to_scan.size() != 0) {
  160. // Then scan files
  161. String fpath = _files_to_scan[_files_to_scan.size() - 1];
  162. pop_back(_files_to_scan);
  163. _scan_file(fpath);
  164. } else {
  165. print_verbose("Search complete");
  166. set_process(false);
  167. _current_dir = "";
  168. _searching = false;
  169. emit_signal(SIGNAL_FINISHED);
  170. }
  171. }
  172. float FindInFiles::get_progress() const {
  173. if (_initial_files_count != 0) {
  174. return static_cast<float>(_initial_files_count - _files_to_scan.size()) / static_cast<float>(_initial_files_count);
  175. }
  176. return 0;
  177. }
  178. void FindInFiles::_scan_dir(String path, PackedStringArray &out_folders) {
  179. DirAccessRef dir = DirAccess::open(path);
  180. if (!dir) {
  181. print_verbose("Cannot open directory! " + path);
  182. return;
  183. }
  184. dir->list_dir_begin();
  185. for (int i = 0; i < 1000; ++i) {
  186. String file = dir->get_next();
  187. if (file == "")
  188. break;
  189. // Ignore special dirs (such as .git and .import)
  190. if (file == "." || file == ".." || file.begins_with("."))
  191. continue;
  192. if (dir->current_is_hidden())
  193. continue;
  194. if (dir->current_is_dir())
  195. out_folders.push_back(file);
  196. else {
  197. String file_ext = file.get_extension();
  198. if (_extension_filter.has(file_ext)) {
  199. _files_to_scan.push_back(path.plus_file(file));
  200. }
  201. }
  202. }
  203. }
  204. void FindInFiles::_scan_file(String fpath) {
  205. FileAccessRef f = FileAccess::open(fpath, FileAccess::READ);
  206. if (!f) {
  207. print_verbose(String("Cannot open file ") + fpath);
  208. return;
  209. }
  210. int line_number = 0;
  211. while (!f->eof_reached()) {
  212. // line number starts at 1
  213. ++line_number;
  214. int begin = 0;
  215. int end = 0;
  216. String line = f->get_line();
  217. while (find_next(line, _pattern, end, _match_case, _whole_words, begin, end)) {
  218. emit_signal(SIGNAL_RESULT_FOUND, fpath, line_number, begin, end, line);
  219. }
  220. }
  221. f->close();
  222. }
  223. void FindInFiles::_bind_methods() {
  224. ADD_SIGNAL(MethodInfo(SIGNAL_RESULT_FOUND,
  225. PropertyInfo(Variant::STRING, "path"),
  226. PropertyInfo(Variant::INT, "line_number"),
  227. PropertyInfo(Variant::INT, "begin"),
  228. PropertyInfo(Variant::INT, "end"),
  229. PropertyInfo(Variant::STRING, "text")));
  230. ADD_SIGNAL(MethodInfo(SIGNAL_FINISHED));
  231. }
  232. //-----------------------------------------------------------------------------
  233. const char *FindInFilesDialog::SIGNAL_FIND_REQUESTED = "find_requested";
  234. const char *FindInFilesDialog::SIGNAL_REPLACE_REQUESTED = "replace_requested";
  235. FindInFilesDialog::FindInFilesDialog() {
  236. set_min_size(Size2(500 * EDSCALE, 0));
  237. set_title(TTR("Find in Files"));
  238. VBoxContainer *vbc = memnew(VBoxContainer);
  239. vbc->set_anchor_and_margin(MARGIN_LEFT, Control::ANCHOR_BEGIN, 8 * EDSCALE);
  240. vbc->set_anchor_and_margin(MARGIN_TOP, Control::ANCHOR_BEGIN, 8 * EDSCALE);
  241. vbc->set_anchor_and_margin(MARGIN_RIGHT, Control::ANCHOR_END, -8 * EDSCALE);
  242. vbc->set_anchor_and_margin(MARGIN_BOTTOM, Control::ANCHOR_END, -8 * EDSCALE);
  243. add_child(vbc);
  244. GridContainer *gc = memnew(GridContainer);
  245. gc->set_columns(2);
  246. vbc->add_child(gc);
  247. Label *find_label = memnew(Label);
  248. find_label->set_text(TTR("Find:"));
  249. gc->add_child(find_label);
  250. _search_text_line_edit = memnew(LineEdit);
  251. _search_text_line_edit->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  252. _search_text_line_edit->connect("text_changed", callable_mp(this, &FindInFilesDialog::_on_search_text_modified));
  253. _search_text_line_edit->connect("text_entered", callable_mp(this, &FindInFilesDialog::_on_search_text_entered));
  254. gc->add_child(_search_text_line_edit);
  255. _replace_label = memnew(Label);
  256. _replace_label->set_text(TTR("Replace:"));
  257. _replace_label->hide();
  258. gc->add_child(_replace_label);
  259. _replace_text_line_edit = memnew(LineEdit);
  260. _replace_text_line_edit->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  261. _replace_text_line_edit->connect("text_entered", callable_mp(this, &FindInFilesDialog::_on_replace_text_entered));
  262. _replace_text_line_edit->hide();
  263. gc->add_child(_replace_text_line_edit);
  264. gc->add_child(memnew(Control)); // Space to maintain the grid aligned.
  265. {
  266. HBoxContainer *hbc = memnew(HBoxContainer);
  267. _whole_words_checkbox = memnew(CheckBox);
  268. _whole_words_checkbox->set_text(TTR("Whole Words"));
  269. hbc->add_child(_whole_words_checkbox);
  270. _match_case_checkbox = memnew(CheckBox);
  271. _match_case_checkbox->set_text(TTR("Match Case"));
  272. hbc->add_child(_match_case_checkbox);
  273. gc->add_child(hbc);
  274. }
  275. Label *folder_label = memnew(Label);
  276. folder_label->set_text(TTR("Folder:"));
  277. gc->add_child(folder_label);
  278. {
  279. HBoxContainer *hbc = memnew(HBoxContainer);
  280. Label *prefix_label = memnew(Label);
  281. prefix_label->set_text("res://");
  282. hbc->add_child(prefix_label);
  283. _folder_line_edit = memnew(LineEdit);
  284. _folder_line_edit->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  285. hbc->add_child(_folder_line_edit);
  286. Button *folder_button = memnew(Button);
  287. folder_button->set_text("...");
  288. folder_button->connect("pressed", callable_mp(this, &FindInFilesDialog::_on_folder_button_pressed));
  289. hbc->add_child(folder_button);
  290. _folder_dialog = memnew(FileDialog);
  291. _folder_dialog->set_file_mode(FileDialog::FILE_MODE_OPEN_DIR);
  292. _folder_dialog->connect("dir_selected", callable_mp(this, &FindInFilesDialog::_on_folder_selected));
  293. add_child(_folder_dialog);
  294. gc->add_child(hbc);
  295. }
  296. Label *filter_label = memnew(Label);
  297. filter_label->set_text(TTR("Filters:"));
  298. filter_label->set_tooltip(TTR("Include the files with the following extensions. Add or remove them in ProjectSettings."));
  299. gc->add_child(filter_label);
  300. _filters_container = memnew(HBoxContainer);
  301. gc->add_child(_filters_container);
  302. _find_button = add_button(TTR("Find..."), false, "find");
  303. _find_button->set_disabled(true);
  304. _replace_button = add_button(TTR("Replace..."), false, "replace");
  305. _replace_button->set_disabled(true);
  306. Button *cancel_button = get_ok();
  307. cancel_button->set_text(TTR("Cancel"));
  308. _mode = SEARCH_MODE;
  309. }
  310. void FindInFilesDialog::set_search_text(String text) {
  311. _search_text_line_edit->set_text(text);
  312. _on_search_text_modified(text);
  313. }
  314. void FindInFilesDialog::set_replace_text(String text) {
  315. _replace_text_line_edit->set_text(text);
  316. }
  317. void FindInFilesDialog::set_find_in_files_mode(FindInFilesMode p_mode) {
  318. if (_mode == p_mode)
  319. return;
  320. _mode = p_mode;
  321. if (p_mode == SEARCH_MODE) {
  322. set_title(TTR("Find in Files"));
  323. _replace_label->hide();
  324. _replace_text_line_edit->hide();
  325. } else if (p_mode == REPLACE_MODE) {
  326. set_title(TTR("Replace in Files"));
  327. _replace_label->show();
  328. _replace_text_line_edit->show();
  329. }
  330. // After hiding some child controls, let's recalculate proper Dialog size
  331. set_size(Size2(get_size().x, 0));
  332. }
  333. String FindInFilesDialog::get_search_text() const {
  334. String text = _search_text_line_edit->get_text();
  335. return text.strip_edges();
  336. }
  337. String FindInFilesDialog::get_replace_text() const {
  338. return _replace_text_line_edit->get_text();
  339. }
  340. bool FindInFilesDialog::is_match_case() const {
  341. return _match_case_checkbox->is_pressed();
  342. }
  343. bool FindInFilesDialog::is_whole_words() const {
  344. return _whole_words_checkbox->is_pressed();
  345. }
  346. String FindInFilesDialog::get_folder() const {
  347. String text = _folder_line_edit->get_text();
  348. return text.strip_edges();
  349. }
  350. Set<String> FindInFilesDialog::get_filter() const {
  351. // could check the _filters_preferences but it might not have been generated yet.
  352. Set<String> filters;
  353. for (int i = 0; i < _filters_container->get_child_count(); ++i) {
  354. CheckBox *cb = (CheckBox *)_filters_container->get_child(i);
  355. if (cb->is_pressed()) {
  356. filters.insert(cb->get_text());
  357. }
  358. }
  359. return filters;
  360. }
  361. void FindInFilesDialog::_notification(int p_what) {
  362. if (p_what == NOTIFICATION_VISIBILITY_CHANGED) {
  363. if (is_visible()) {
  364. // Doesn't work more than once if not deferred...
  365. _search_text_line_edit->call_deferred("grab_focus");
  366. _search_text_line_edit->select_all();
  367. // Extensions might have changed in the meantime, we clean them and instance them again.
  368. for (int i = 0; i < _filters_container->get_child_count(); i++) {
  369. _filters_container->get_child(i)->queue_delete();
  370. }
  371. Array exts = ProjectSettings::get_singleton()->get("editor/search_in_file_extensions");
  372. for (int i = 0; i < exts.size(); ++i) {
  373. CheckBox *cb = memnew(CheckBox);
  374. cb->set_text(exts[i]);
  375. if (!_filters_preferences.has(exts[i])) {
  376. _filters_preferences[exts[i]] = true;
  377. }
  378. cb->set_pressed(_filters_preferences[exts[i]]);
  379. _filters_container->add_child(cb);
  380. }
  381. }
  382. }
  383. }
  384. void FindInFilesDialog::_on_folder_button_pressed() {
  385. _folder_dialog->popup_centered_ratio();
  386. }
  387. void FindInFilesDialog::custom_action(const String &p_action) {
  388. for (int i = 0; i < _filters_container->get_child_count(); ++i) {
  389. CheckBox *cb = (CheckBox *)_filters_container->get_child(i);
  390. _filters_preferences[cb->get_text()] = cb->is_pressed();
  391. }
  392. if (p_action == "find") {
  393. emit_signal(SIGNAL_FIND_REQUESTED);
  394. hide();
  395. } else if (p_action == "replace") {
  396. emit_signal(SIGNAL_REPLACE_REQUESTED);
  397. hide();
  398. }
  399. }
  400. void FindInFilesDialog::_on_search_text_modified(String text) {
  401. ERR_FAIL_COND(!_find_button);
  402. ERR_FAIL_COND(!_replace_button);
  403. _find_button->set_disabled(get_search_text().empty());
  404. _replace_button->set_disabled(get_search_text().empty());
  405. }
  406. void FindInFilesDialog::_on_search_text_entered(String text) {
  407. // This allows to trigger a global search without leaving the keyboard
  408. if (!_find_button->is_disabled()) {
  409. if (_mode == SEARCH_MODE) {
  410. custom_action("find");
  411. }
  412. }
  413. if (!_replace_button->is_disabled()) {
  414. if (_mode == REPLACE_MODE) {
  415. custom_action("replace");
  416. }
  417. }
  418. }
  419. void FindInFilesDialog::_on_replace_text_entered(String text) {
  420. // This allows to trigger a global search without leaving the keyboard
  421. if (!_replace_button->is_disabled()) {
  422. if (_mode == REPLACE_MODE) {
  423. custom_action("replace");
  424. }
  425. }
  426. }
  427. void FindInFilesDialog::_on_folder_selected(String path) {
  428. int i = path.find("://");
  429. if (i != -1)
  430. path = path.right(i + 3);
  431. _folder_line_edit->set_text(path);
  432. }
  433. void FindInFilesDialog::_bind_methods() {
  434. ADD_SIGNAL(MethodInfo(SIGNAL_FIND_REQUESTED));
  435. ADD_SIGNAL(MethodInfo(SIGNAL_REPLACE_REQUESTED));
  436. }
  437. //-----------------------------------------------------------------------------
  438. const char *FindInFilesPanel::SIGNAL_RESULT_SELECTED = "result_selected";
  439. const char *FindInFilesPanel::SIGNAL_FILES_MODIFIED = "files_modified";
  440. FindInFilesPanel::FindInFilesPanel() {
  441. _finder = memnew(FindInFiles);
  442. _finder->connect(FindInFiles::SIGNAL_RESULT_FOUND, callable_mp(this, &FindInFilesPanel::_on_result_found));
  443. _finder->connect(FindInFiles::SIGNAL_FINISHED, callable_mp(this, &FindInFilesPanel::_on_finished));
  444. add_child(_finder);
  445. VBoxContainer *vbc = memnew(VBoxContainer);
  446. vbc->set_anchor_and_margin(MARGIN_LEFT, ANCHOR_BEGIN, 0);
  447. vbc->set_anchor_and_margin(MARGIN_TOP, ANCHOR_BEGIN, 0);
  448. vbc->set_anchor_and_margin(MARGIN_RIGHT, ANCHOR_END, 0);
  449. vbc->set_anchor_and_margin(MARGIN_BOTTOM, ANCHOR_END, 0);
  450. add_child(vbc);
  451. {
  452. HBoxContainer *hbc = memnew(HBoxContainer);
  453. Label *find_label = memnew(Label);
  454. find_label->set_text(TTR("Find: "));
  455. hbc->add_child(find_label);
  456. _search_text_label = memnew(Label);
  457. _search_text_label->add_theme_font_override("font", EditorNode::get_singleton()->get_gui_base()->get_theme_font("source", "EditorFonts"));
  458. hbc->add_child(_search_text_label);
  459. _progress_bar = memnew(ProgressBar);
  460. _progress_bar->set_h_size_flags(SIZE_EXPAND_FILL);
  461. _progress_bar->set_v_size_flags(SIZE_SHRINK_CENTER);
  462. hbc->add_child(_progress_bar);
  463. set_progress_visible(false);
  464. _status_label = memnew(Label);
  465. hbc->add_child(_status_label);
  466. _refresh_button = memnew(Button);
  467. _refresh_button->set_text(TTR("Refresh"));
  468. _refresh_button->connect("pressed", callable_mp(this, &FindInFilesPanel::_on_refresh_button_clicked));
  469. _refresh_button->hide();
  470. hbc->add_child(_refresh_button);
  471. _cancel_button = memnew(Button);
  472. _cancel_button->set_text(TTR("Cancel"));
  473. _cancel_button->connect("pressed", callable_mp(this, &FindInFilesPanel::_on_cancel_button_clicked));
  474. _cancel_button->hide();
  475. hbc->add_child(_cancel_button);
  476. vbc->add_child(hbc);
  477. }
  478. _results_display = memnew(Tree);
  479. _results_display->add_theme_font_override("font", EditorNode::get_singleton()->get_gui_base()->get_theme_font("source", "EditorFonts"));
  480. _results_display->set_v_size_flags(SIZE_EXPAND_FILL);
  481. _results_display->connect("item_selected", callable_mp(this, &FindInFilesPanel::_on_result_selected));
  482. _results_display->connect("item_edited", callable_mp(this, &FindInFilesPanel::_on_item_edited));
  483. _results_display->set_hide_root(true);
  484. _results_display->set_select_mode(Tree::SELECT_ROW);
  485. _results_display->set_allow_rmb_select(true);
  486. _results_display->create_item(); // Root
  487. vbc->add_child(_results_display);
  488. _with_replace = false;
  489. {
  490. _replace_container = memnew(HBoxContainer);
  491. Label *replace_label = memnew(Label);
  492. replace_label->set_text(TTR("Replace: "));
  493. _replace_container->add_child(replace_label);
  494. _replace_line_edit = memnew(LineEdit);
  495. _replace_line_edit->set_h_size_flags(SIZE_EXPAND_FILL);
  496. _replace_line_edit->connect("text_changed", callable_mp(this, &FindInFilesPanel::_on_replace_text_changed));
  497. _replace_container->add_child(_replace_line_edit);
  498. _replace_all_button = memnew(Button);
  499. _replace_all_button->set_text(TTR("Replace all (no undo)"));
  500. _replace_all_button->connect("pressed", callable_mp(this, &FindInFilesPanel::_on_replace_all_clicked));
  501. _replace_container->add_child(_replace_all_button);
  502. _replace_container->hide();
  503. vbc->add_child(_replace_container);
  504. }
  505. }
  506. void FindInFilesPanel::set_with_replace(bool with_replace) {
  507. _with_replace = with_replace;
  508. _replace_container->set_visible(with_replace);
  509. if (with_replace) {
  510. // Results show checkboxes on their left so they can be opted out
  511. _results_display->set_columns(2);
  512. _results_display->set_column_expand(0, false);
  513. _results_display->set_column_min_width(0, 48 * EDSCALE);
  514. } else {
  515. // Results are single-cell items
  516. _results_display->set_column_expand(0, true);
  517. _results_display->set_columns(1);
  518. }
  519. }
  520. void FindInFilesPanel::set_replace_text(String text) {
  521. _replace_line_edit->set_text(text);
  522. }
  523. void FindInFilesPanel::clear() {
  524. _file_items.clear();
  525. _result_items.clear();
  526. _results_display->clear();
  527. _results_display->create_item(); // Root
  528. }
  529. void FindInFilesPanel::start_search() {
  530. clear();
  531. _status_label->set_text(TTR("Searching..."));
  532. _search_text_label->set_text(_finder->get_search_text());
  533. set_process(true);
  534. set_progress_visible(true);
  535. _finder->start();
  536. update_replace_buttons();
  537. _refresh_button->hide();
  538. _cancel_button->show();
  539. }
  540. void FindInFilesPanel::stop_search() {
  541. _finder->stop();
  542. _status_label->set_text("");
  543. update_replace_buttons();
  544. set_progress_visible(false);
  545. _refresh_button->show();
  546. _cancel_button->hide();
  547. }
  548. void FindInFilesPanel::_notification(int p_what) {
  549. if (p_what == NOTIFICATION_PROCESS) {
  550. _progress_bar->set_as_ratio(_finder->get_progress());
  551. }
  552. }
  553. void FindInFilesPanel::_on_result_found(String fpath, int line_number, int begin, int end, String text) {
  554. TreeItem *file_item;
  555. Map<String, TreeItem *>::Element *E = _file_items.find(fpath);
  556. if (E == nullptr) {
  557. file_item = _results_display->create_item();
  558. file_item->set_text(0, fpath);
  559. file_item->set_metadata(0, fpath);
  560. // The width of this column is restrained to checkboxes, but that doesn't make sense for the parent items,
  561. // so we override their width so they can expand to full width
  562. file_item->set_expand_right(0, true);
  563. _file_items[fpath] = file_item;
  564. } else {
  565. file_item = E->value();
  566. }
  567. int text_index = _with_replace ? 1 : 0;
  568. TreeItem *item = _results_display->create_item(file_item);
  569. // Do this first because it resets properties of the cell...
  570. item->set_cell_mode(text_index, TreeItem::CELL_MODE_CUSTOM);
  571. String item_text = vformat("%3s: %s", line_number, text.replace("\t", " "));
  572. item->set_text(text_index, item_text);
  573. item->set_custom_draw(text_index, this, "_draw_result_text");
  574. Ref<Font> font = _results_display->get_theme_font("font");
  575. float raw_text_width = font->get_string_size(text).x;
  576. float item_text_width = font->get_string_size(item_text).x;
  577. Result r;
  578. r.line_number = line_number;
  579. r.begin = begin;
  580. r.end = end;
  581. r.draw_begin = (item_text_width - raw_text_width) + font->get_string_size(text.left(r.begin)).x;
  582. r.draw_width = font->get_string_size(text.substr(r.begin, r.end - r.begin)).x;
  583. _result_items[item] = r;
  584. if (_with_replace) {
  585. item->set_cell_mode(0, TreeItem::CELL_MODE_CHECK);
  586. item->set_checked(0, true);
  587. item->set_editable(0, true);
  588. }
  589. }
  590. void FindInFilesPanel::draw_result_text(Object *item_obj, Rect2 rect) {
  591. TreeItem *item = Object::cast_to<TreeItem>(item_obj);
  592. if (!item)
  593. return;
  594. Map<TreeItem *, Result>::Element *E = _result_items.find(item);
  595. if (!E)
  596. return;
  597. Result r = E->value();
  598. Rect2 match_rect = rect;
  599. match_rect.position.x += r.draw_begin;
  600. match_rect.size.x = r.draw_width;
  601. match_rect.position.y += 1 * EDSCALE;
  602. match_rect.size.y -= 2 * EDSCALE;
  603. _results_display->draw_rect(match_rect, Color(0, 0, 0, 0.5));
  604. // Text is drawn by Tree already
  605. }
  606. void FindInFilesPanel::_on_item_edited() {
  607. TreeItem *item = _results_display->get_selected();
  608. if (item->is_checked(0)) {
  609. item->set_custom_color(1, _results_display->get_theme_color("font_color"));
  610. } else {
  611. // Grey out
  612. Color color = _results_display->get_theme_color("font_color");
  613. color.a /= 2.0;
  614. item->set_custom_color(1, color);
  615. }
  616. }
  617. void FindInFilesPanel::_on_finished() {
  618. _status_label->set_text(TTR("Search complete"));
  619. update_replace_buttons();
  620. set_progress_visible(false);
  621. _refresh_button->show();
  622. _cancel_button->hide();
  623. }
  624. void FindInFilesPanel::_on_refresh_button_clicked() {
  625. start_search();
  626. }
  627. void FindInFilesPanel::_on_cancel_button_clicked() {
  628. stop_search();
  629. }
  630. void FindInFilesPanel::_on_result_selected() {
  631. TreeItem *item = _results_display->get_selected();
  632. Map<TreeItem *, Result>::Element *E = _result_items.find(item);
  633. if (E == nullptr)
  634. return;
  635. Result r = E->value();
  636. TreeItem *file_item = item->get_parent();
  637. String fpath = file_item->get_metadata(0);
  638. emit_signal(SIGNAL_RESULT_SELECTED, fpath, r.line_number, r.begin, r.end);
  639. }
  640. void FindInFilesPanel::_on_replace_text_changed(String text) {
  641. update_replace_buttons();
  642. }
  643. void FindInFilesPanel::_on_replace_all_clicked() {
  644. String replace_text = get_replace_text();
  645. PackedStringArray modified_files;
  646. for (Map<String, TreeItem *>::Element *E = _file_items.front(); E; E = E->next()) {
  647. TreeItem *file_item = E->value();
  648. String fpath = file_item->get_metadata(0);
  649. Vector<Result> locations;
  650. for (TreeItem *item = file_item->get_children(); item; item = item->get_next()) {
  651. if (!item->is_checked(0))
  652. continue;
  653. Map<TreeItem *, Result>::Element *F = _result_items.find(item);
  654. ERR_FAIL_COND(F == nullptr);
  655. locations.push_back(F->value());
  656. }
  657. if (locations.size() != 0) {
  658. // Results are sorted by file, so we can batch replaces
  659. apply_replaces_in_file(fpath, locations, replace_text);
  660. modified_files.push_back(fpath);
  661. }
  662. }
  663. // Hide replace bar so we can't trigger the action twice without doing a new search
  664. _replace_container->hide();
  665. emit_signal(SIGNAL_FILES_MODIFIED, modified_files);
  666. }
  667. // Same as get_line, but preserves line ending characters
  668. class ConservativeGetLine {
  669. public:
  670. String get_line(FileAccess *f) {
  671. _line_buffer.clear();
  672. CharType c = f->get_8();
  673. while (!f->eof_reached()) {
  674. if (c == '\n') {
  675. _line_buffer.push_back(c);
  676. _line_buffer.push_back(0);
  677. return String::utf8(_line_buffer.ptr());
  678. } else if (c == '\0') {
  679. _line_buffer.push_back(c);
  680. return String::utf8(_line_buffer.ptr());
  681. } else if (c != '\r') {
  682. _line_buffer.push_back(c);
  683. }
  684. c = f->get_8();
  685. }
  686. _line_buffer.push_back(0);
  687. return String::utf8(_line_buffer.ptr());
  688. }
  689. private:
  690. Vector<char> _line_buffer;
  691. };
  692. void FindInFilesPanel::apply_replaces_in_file(String fpath, const Vector<Result> &locations, String new_text) {
  693. // If the file is already open, I assume the editor will reload it.
  694. // If there are unsaved changes, the user will be asked on focus,
  695. // however that means either losing changes or losing replaces.
  696. FileAccessRef f = FileAccess::open(fpath, FileAccess::READ);
  697. ERR_FAIL_COND_MSG(!f, "Cannot open file from path '" + fpath + "'.");
  698. String buffer;
  699. int current_line = 1;
  700. ConservativeGetLine conservative;
  701. String line = conservative.get_line(f);
  702. String search_text = _finder->get_search_text();
  703. int offset = 0;
  704. for (int i = 0; i < locations.size(); ++i) {
  705. int repl_line_number = locations[i].line_number;
  706. while (current_line < repl_line_number) {
  707. buffer += line;
  708. line = conservative.get_line(f);
  709. ++current_line;
  710. offset = 0;
  711. }
  712. int repl_begin = locations[i].begin + offset;
  713. int repl_end = locations[i].end + offset;
  714. int _;
  715. if (!find_next(line, search_text, repl_begin, _finder->is_match_case(), _finder->is_whole_words(), _, _)) {
  716. // Make sure the replace is still valid in case the file was tampered with.
  717. print_verbose(String("Occurrence no longer matches, replace will be ignored in {0}: line {1}, col {2}").format(varray(fpath, repl_line_number, repl_begin)));
  718. continue;
  719. }
  720. line = line.left(repl_begin) + new_text + line.right(repl_end);
  721. // keep an offset in case there are successive replaces in the same line
  722. offset += new_text.length() - (repl_end - repl_begin);
  723. }
  724. buffer += line;
  725. while (!f->eof_reached()) {
  726. buffer += conservative.get_line(f);
  727. }
  728. // Now the modified contents are in the buffer, rewrite the file with our changes
  729. Error err = f->reopen(fpath, FileAccess::WRITE);
  730. ERR_FAIL_COND_MSG(err != OK, "Cannot create file in path '" + fpath + "'.");
  731. f->store_string(buffer);
  732. f->close();
  733. }
  734. String FindInFilesPanel::get_replace_text() {
  735. return _replace_line_edit->get_text();
  736. }
  737. void FindInFilesPanel::update_replace_buttons() {
  738. bool disabled = _finder->is_searching();
  739. _replace_all_button->set_disabled(disabled);
  740. }
  741. void FindInFilesPanel::set_progress_visible(bool visible) {
  742. _progress_bar->set_self_modulate(Color(1, 1, 1, visible ? 1 : 0));
  743. }
  744. void FindInFilesPanel::_bind_methods() {
  745. ClassDB::bind_method("_on_result_found", &FindInFilesPanel::_on_result_found);
  746. ClassDB::bind_method("_on_finished", &FindInFilesPanel::_on_finished);
  747. ClassDB::bind_method("_draw_result_text", &FindInFilesPanel::draw_result_text);
  748. ADD_SIGNAL(MethodInfo(SIGNAL_RESULT_SELECTED,
  749. PropertyInfo(Variant::STRING, "path"),
  750. PropertyInfo(Variant::INT, "line_number"),
  751. PropertyInfo(Variant::INT, "begin"),
  752. PropertyInfo(Variant::INT, "end")));
  753. ADD_SIGNAL(MethodInfo(SIGNAL_FILES_MODIFIED, PropertyInfo(Variant::STRING, "paths")));
  754. }