find_in_files.cpp 28 KB

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