file_dialog.cpp 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153
  1. /*************************************************************************/
  2. /* file_dialog.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 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 "file_dialog.h"
  31. #include "core/os/keyboard.h"
  32. #include "core/string/print_string.h"
  33. #include "scene/gui/label.h"
  34. FileDialog::GetIconFunc FileDialog::get_icon_func = nullptr;
  35. FileDialog::GetIconFunc FileDialog::get_large_icon_func = nullptr;
  36. FileDialog::RegisterFunc FileDialog::register_func = nullptr;
  37. FileDialog::RegisterFunc FileDialog::unregister_func = nullptr;
  38. void FileDialog::popup_file_dialog() {
  39. popup_centered_clamped(Size2i(700, 500), 0.8f);
  40. _focus_file_text();
  41. }
  42. void FileDialog::_focus_file_text() {
  43. int lp = file->get_text().rfind(".");
  44. if (lp != -1) {
  45. file->select(0, lp);
  46. if (file->is_inside_tree() && !get_tree()->is_node_being_edited(file)) {
  47. file->grab_focus();
  48. }
  49. }
  50. }
  51. VBoxContainer *FileDialog::get_vbox() {
  52. return vbox;
  53. }
  54. void FileDialog::_update_theme_item_cache() {
  55. ConfirmationDialog::_update_theme_item_cache();
  56. theme_cache.parent_folder = get_theme_icon(SNAME("parent_folder"));
  57. theme_cache.forward_folder = get_theme_icon(SNAME("forward_folder"));
  58. theme_cache.back_folder = get_theme_icon(SNAME("back_folder"));
  59. theme_cache.reload = get_theme_icon(SNAME("reload"));
  60. theme_cache.toggle_hidden = get_theme_icon(SNAME("toggle_hidden"));
  61. theme_cache.folder = get_theme_icon(SNAME("folder"));
  62. theme_cache.file = get_theme_icon(SNAME("file"));
  63. theme_cache.folder_icon_modulate = get_theme_color(SNAME("folder_icon_modulate"));
  64. theme_cache.file_icon_modulate = get_theme_color(SNAME("file_icon_modulate"));
  65. theme_cache.files_disabled = get_theme_color(SNAME("files_disabled"));
  66. // TODO: Define own colors?
  67. theme_cache.icon_normal_color = get_theme_color(SNAME("font_color"), SNAME("Button"));
  68. theme_cache.icon_hover_color = get_theme_color(SNAME("font_hover_color"), SNAME("Button"));
  69. theme_cache.icon_focus_color = get_theme_color(SNAME("font_focus_color"), SNAME("Button"));
  70. theme_cache.icon_pressed_color = get_theme_color(SNAME("font_pressed_color"), SNAME("Button"));
  71. }
  72. void FileDialog::_notification(int p_what) {
  73. switch (p_what) {
  74. case NOTIFICATION_VISIBILITY_CHANGED: {
  75. if (!is_visible()) {
  76. set_process_shortcut_input(false);
  77. }
  78. } break;
  79. case NOTIFICATION_THEME_CHANGED: {
  80. dir_up->set_icon(theme_cache.parent_folder);
  81. if (vbox->is_layout_rtl()) {
  82. dir_prev->set_icon(theme_cache.forward_folder);
  83. dir_next->set_icon(theme_cache.back_folder);
  84. } else {
  85. dir_prev->set_icon(theme_cache.back_folder);
  86. dir_next->set_icon(theme_cache.forward_folder);
  87. }
  88. refresh->set_icon(theme_cache.reload);
  89. show_hidden->set_icon(theme_cache.toggle_hidden);
  90. dir_up->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
  91. dir_up->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
  92. dir_up->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
  93. dir_up->add_theme_color_override("icon_pressed_color", theme_cache.icon_pressed_color);
  94. dir_prev->add_theme_color_override("icon_color_normal", theme_cache.icon_normal_color);
  95. dir_prev->add_theme_color_override("icon_color_hover", theme_cache.icon_hover_color);
  96. dir_prev->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
  97. dir_prev->add_theme_color_override("icon_color_pressed", theme_cache.icon_pressed_color);
  98. dir_next->add_theme_color_override("icon_color_normal", theme_cache.icon_normal_color);
  99. dir_next->add_theme_color_override("icon_color_hover", theme_cache.icon_hover_color);
  100. dir_next->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
  101. dir_next->add_theme_color_override("icon_color_pressed", theme_cache.icon_pressed_color);
  102. refresh->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
  103. refresh->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
  104. refresh->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
  105. refresh->add_theme_color_override("icon_pressed_color", theme_cache.icon_pressed_color);
  106. show_hidden->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
  107. show_hidden->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
  108. show_hidden->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
  109. show_hidden->add_theme_color_override("icon_pressed_color", theme_cache.icon_pressed_color);
  110. } break;
  111. case NOTIFICATION_TRANSLATION_CHANGED: {
  112. update_filters();
  113. } break;
  114. }
  115. }
  116. void FileDialog::shortcut_input(const Ref<InputEvent> &p_event) {
  117. ERR_FAIL_COND(p_event.is_null());
  118. Ref<InputEventKey> k = p_event;
  119. if (k.is_valid() && has_focus()) {
  120. if (k->is_pressed()) {
  121. bool handled = true;
  122. switch (k->get_keycode()) {
  123. case Key::H: {
  124. if (k->is_command_pressed()) {
  125. set_show_hidden_files(!show_hidden_files);
  126. } else {
  127. handled = false;
  128. }
  129. } break;
  130. case Key::F5: {
  131. invalidate();
  132. } break;
  133. case Key::BACKSPACE: {
  134. _dir_submitted("..");
  135. } break;
  136. default: {
  137. handled = false;
  138. }
  139. }
  140. if (handled) {
  141. set_input_as_handled();
  142. }
  143. }
  144. }
  145. }
  146. void FileDialog::set_enable_multiple_selection(bool p_enable) {
  147. tree->set_select_mode(p_enable ? Tree::SELECT_MULTI : Tree::SELECT_SINGLE);
  148. };
  149. Vector<String> FileDialog::get_selected_files() const {
  150. Vector<String> list;
  151. TreeItem *item = tree->get_root();
  152. while ((item = tree->get_next_selected(item))) {
  153. list.push_back(dir_access->get_current_dir().path_join(item->get_text(0)));
  154. };
  155. return list;
  156. };
  157. void FileDialog::update_dir() {
  158. if (root_prefix.is_empty()) {
  159. dir->set_text(dir_access->get_current_dir(false));
  160. } else {
  161. dir->set_text(dir_access->get_current_dir(false).trim_prefix(root_prefix).trim_prefix("/"));
  162. }
  163. if (drives->is_visible()) {
  164. if (dir_access->get_current_dir().is_network_share_path()) {
  165. _update_drives(false);
  166. drives->add_item(RTR("Network"));
  167. drives->set_item_disabled(-1, true);
  168. drives->select(drives->get_item_count() - 1);
  169. } else {
  170. drives->select(dir_access->get_current_drive());
  171. }
  172. }
  173. // Deselect any item, to make "Select Current Folder" button text by default.
  174. deselect_all();
  175. }
  176. void FileDialog::_dir_submitted(String p_dir) {
  177. _change_dir(root_prefix.path_join(p_dir));
  178. file->set_text("");
  179. _push_history();
  180. }
  181. void FileDialog::_file_submitted(const String &p_file) {
  182. _action_pressed();
  183. }
  184. void FileDialog::_save_confirm_pressed() {
  185. String f = dir_access->get_current_dir().path_join(file->get_text());
  186. emit_signal(SNAME("file_selected"), f);
  187. hide();
  188. }
  189. void FileDialog::_post_popup() {
  190. ConfirmationDialog::_post_popup();
  191. if (invalidated) {
  192. update_file_list();
  193. invalidated = false;
  194. }
  195. if (mode == FILE_MODE_SAVE_FILE) {
  196. file->grab_focus();
  197. } else {
  198. tree->grab_focus();
  199. }
  200. set_process_shortcut_input(true);
  201. // For open dir mode, deselect all items on file dialog open.
  202. if (mode == FILE_MODE_OPEN_DIR) {
  203. deselect_all();
  204. file_box->set_visible(false);
  205. } else {
  206. file_box->set_visible(true);
  207. }
  208. local_history.clear();
  209. local_history_pos = -1;
  210. _push_history();
  211. }
  212. void FileDialog::_push_history() {
  213. local_history.resize(local_history_pos + 1);
  214. String new_path = dir_access->get_current_dir();
  215. if (local_history.size() == 0 || new_path != local_history[local_history_pos]) {
  216. local_history.push_back(new_path);
  217. local_history_pos++;
  218. dir_prev->set_disabled(local_history_pos == 0);
  219. dir_next->set_disabled(true);
  220. }
  221. }
  222. void FileDialog::_action_pressed() {
  223. if (mode == FILE_MODE_OPEN_FILES) {
  224. TreeItem *ti = tree->get_next_selected(nullptr);
  225. String fbase = dir_access->get_current_dir();
  226. Vector<String> files;
  227. while (ti) {
  228. files.push_back(fbase.path_join(ti->get_text(0)));
  229. ti = tree->get_next_selected(ti);
  230. }
  231. if (files.size()) {
  232. emit_signal(SNAME("files_selected"), files);
  233. hide();
  234. }
  235. return;
  236. }
  237. String file_text = file->get_text();
  238. String f = file_text.is_absolute_path() ? file_text : dir_access->get_current_dir().path_join(file_text);
  239. if ((mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_FILE) && dir_access->file_exists(f)) {
  240. emit_signal(SNAME("file_selected"), f);
  241. hide();
  242. } else if (mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_DIR) {
  243. String path = dir_access->get_current_dir();
  244. path = path.replace("\\", "/");
  245. TreeItem *item = tree->get_selected();
  246. if (item) {
  247. Dictionary d = item->get_metadata(0);
  248. if (d["dir"] && d["name"] != "..") {
  249. path = path.path_join(d["name"]);
  250. }
  251. }
  252. emit_signal(SNAME("dir_selected"), path);
  253. hide();
  254. }
  255. if (mode == FILE_MODE_SAVE_FILE) {
  256. bool valid = false;
  257. if (filter->get_selected() == filter->get_item_count() - 1) {
  258. valid = true; // match none
  259. } else if (filters.size() > 1 && filter->get_selected() == 0) {
  260. // match all filters
  261. for (int i = 0; i < filters.size(); i++) {
  262. String flt = filters[i].get_slice(";", 0);
  263. for (int j = 0; j < flt.get_slice_count(","); j++) {
  264. String str = flt.get_slice(",", j).strip_edges();
  265. if (f.match(str)) {
  266. valid = true;
  267. break;
  268. }
  269. }
  270. if (valid) {
  271. break;
  272. }
  273. }
  274. } else {
  275. int idx = filter->get_selected();
  276. if (filters.size() > 1) {
  277. idx--;
  278. }
  279. if (idx >= 0 && idx < filters.size()) {
  280. String flt = filters[idx].get_slice(";", 0);
  281. int filterSliceCount = flt.get_slice_count(",");
  282. for (int j = 0; j < filterSliceCount; j++) {
  283. String str = (flt.get_slice(",", j).strip_edges());
  284. if (f.match(str)) {
  285. valid = true;
  286. break;
  287. }
  288. }
  289. if (!valid && filterSliceCount > 0) {
  290. String str = (flt.get_slice(",", 0).strip_edges());
  291. f += str.substr(1, str.length() - 1);
  292. file->set_text(f.get_file());
  293. valid = true;
  294. }
  295. } else {
  296. valid = true;
  297. }
  298. }
  299. if (!valid) {
  300. exterr->popup_centered(Size2(250, 80));
  301. return;
  302. }
  303. if (dir_access->file_exists(f)) {
  304. confirm_save->set_text(RTR("File exists, overwrite?"));
  305. confirm_save->popup_centered(Size2(200, 80));
  306. } else {
  307. emit_signal(SNAME("file_selected"), f);
  308. hide();
  309. }
  310. }
  311. }
  312. void FileDialog::_cancel_pressed() {
  313. file->set_text("");
  314. invalidate();
  315. hide();
  316. }
  317. bool FileDialog::_is_open_should_be_disabled() {
  318. if (mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_SAVE_FILE) {
  319. return false;
  320. }
  321. TreeItem *ti = tree->get_next_selected(tree->get_root());
  322. while (ti) {
  323. TreeItem *prev_ti = ti;
  324. ti = tree->get_next_selected(tree->get_root());
  325. if (ti == prev_ti) {
  326. break;
  327. }
  328. }
  329. // We have something that we can't select?
  330. if (!ti) {
  331. return mode != FILE_MODE_OPEN_DIR; // In "Open folder" mode, having nothing selected picks the current folder.
  332. }
  333. Dictionary d = ti->get_metadata(0);
  334. // Opening a file, but selected a folder? Forbidden.
  335. return ((mode == FILE_MODE_OPEN_FILE || mode == FILE_MODE_OPEN_FILES) && d["dir"]) || // Flipped case, also forbidden.
  336. (mode == FILE_MODE_OPEN_DIR && !d["dir"]);
  337. }
  338. void FileDialog::_go_up() {
  339. _change_dir("..");
  340. _push_history();
  341. }
  342. void FileDialog::_go_back() {
  343. if (local_history_pos <= 0) {
  344. return;
  345. }
  346. local_history_pos--;
  347. _change_dir(local_history[local_history_pos]);
  348. dir_prev->set_disabled(local_history_pos == 0);
  349. dir_next->set_disabled(local_history_pos == local_history.size() - 1);
  350. }
  351. void FileDialog::_go_forward() {
  352. if (local_history_pos == local_history.size() - 1) {
  353. return;
  354. }
  355. local_history_pos++;
  356. _change_dir(local_history[local_history_pos]);
  357. dir_prev->set_disabled(local_history_pos == 0);
  358. dir_next->set_disabled(local_history_pos == local_history.size() - 1);
  359. }
  360. void FileDialog::deselect_all() {
  361. // Clear currently selected items in file manager.
  362. tree->deselect_all();
  363. // And change get_ok title.
  364. if (!tree->is_anything_selected()) {
  365. get_ok_button()->set_disabled(_is_open_should_be_disabled());
  366. switch (mode) {
  367. case FILE_MODE_OPEN_FILE:
  368. case FILE_MODE_OPEN_FILES:
  369. set_ok_button_text(RTR("Open"));
  370. break;
  371. case FILE_MODE_OPEN_DIR:
  372. set_ok_button_text(RTR("Select Current Folder"));
  373. break;
  374. case FILE_MODE_OPEN_ANY:
  375. case FILE_MODE_SAVE_FILE:
  376. // FIXME: Implement, or refactor to avoid duplication with set_mode
  377. break;
  378. }
  379. }
  380. }
  381. void FileDialog::_tree_multi_selected(Object *p_object, int p_cell, bool p_selected) {
  382. _tree_selected();
  383. }
  384. void FileDialog::_tree_selected() {
  385. TreeItem *ti = tree->get_selected();
  386. if (!ti) {
  387. return;
  388. }
  389. Dictionary d = ti->get_metadata(0);
  390. if (!d["dir"]) {
  391. file->set_text(d["name"]);
  392. } else if (mode == FILE_MODE_OPEN_DIR) {
  393. set_ok_button_text(RTR("Select This Folder"));
  394. }
  395. get_ok_button()->set_disabled(_is_open_should_be_disabled());
  396. }
  397. void FileDialog::_tree_item_activated() {
  398. TreeItem *ti = tree->get_selected();
  399. if (!ti) {
  400. return;
  401. }
  402. Dictionary d = ti->get_metadata(0);
  403. if (d["dir"]) {
  404. _change_dir(d["name"]);
  405. if (mode == FILE_MODE_OPEN_FILE || mode == FILE_MODE_OPEN_FILES || mode == FILE_MODE_OPEN_DIR || mode == FILE_MODE_OPEN_ANY) {
  406. file->set_text("");
  407. }
  408. _push_history();
  409. } else {
  410. _action_pressed();
  411. }
  412. }
  413. void FileDialog::update_file_name() {
  414. int idx = filter->get_selected() - 1;
  415. if ((idx == -1 && filter->get_item_count() == 2) || (filter->get_item_count() > 2 && idx >= 0 && idx < filter->get_item_count() - 2)) {
  416. if (idx == -1) {
  417. idx += 1;
  418. }
  419. String filter_str = filters[idx];
  420. String file_str = file->get_text();
  421. String base_name = file_str.get_basename();
  422. Vector<String> filter_substr = filter_str.split(";");
  423. if (filter_substr.size() >= 2) {
  424. file_str = base_name + "." + filter_substr[0].strip_edges().get_extension().to_lower();
  425. } else {
  426. file_str = base_name + "." + filter_str.strip_edges().get_extension().to_lower();
  427. }
  428. file->set_text(file_str);
  429. }
  430. }
  431. void FileDialog::update_file_list() {
  432. tree->clear();
  433. // Scroll back to the top after opening a directory
  434. tree->get_vscroll_bar()->set_value(0);
  435. dir_access->list_dir_begin();
  436. if (dir_access->is_readable(dir_access->get_current_dir().utf8().get_data())) {
  437. message->hide();
  438. } else {
  439. message->set_text(RTR("You don't have permission to access contents of this folder."));
  440. message->show();
  441. }
  442. TreeItem *root = tree->create_item();
  443. List<String> files;
  444. List<String> dirs;
  445. bool is_hidden;
  446. String item = dir_access->get_next();
  447. while (!item.is_empty()) {
  448. if (item == "." || item == "..") {
  449. item = dir_access->get_next();
  450. continue;
  451. }
  452. is_hidden = dir_access->current_is_hidden();
  453. if (show_hidden_files || !is_hidden) {
  454. if (!dir_access->current_is_dir()) {
  455. files.push_back(item);
  456. } else {
  457. dirs.push_back(item);
  458. }
  459. }
  460. item = dir_access->get_next();
  461. }
  462. dirs.sort_custom<NaturalNoCaseComparator>();
  463. files.sort_custom<NaturalNoCaseComparator>();
  464. while (!dirs.is_empty()) {
  465. String &dir_name = dirs.front()->get();
  466. TreeItem *ti = tree->create_item(root);
  467. ti->set_text(0, dir_name);
  468. ti->set_icon(0, theme_cache.folder);
  469. ti->set_icon_modulate(0, theme_cache.folder_icon_modulate);
  470. Dictionary d;
  471. d["name"] = dir_name;
  472. d["dir"] = true;
  473. ti->set_metadata(0, d);
  474. dirs.pop_front();
  475. }
  476. List<String> patterns;
  477. // build filter
  478. if (filter->get_selected() == filter->get_item_count() - 1) {
  479. // match all
  480. } else if (filters.size() > 1 && filter->get_selected() == 0) {
  481. // match all filters
  482. for (int i = 0; i < filters.size(); i++) {
  483. String f = filters[i].get_slice(";", 0);
  484. for (int j = 0; j < f.get_slice_count(","); j++) {
  485. patterns.push_back(f.get_slice(",", j).strip_edges());
  486. }
  487. }
  488. } else {
  489. int idx = filter->get_selected();
  490. if (filters.size() > 1) {
  491. idx--;
  492. }
  493. if (idx >= 0 && idx < filters.size()) {
  494. String f = filters[idx].get_slice(";", 0);
  495. for (int j = 0; j < f.get_slice_count(","); j++) {
  496. patterns.push_back(f.get_slice(",", j).strip_edges());
  497. }
  498. }
  499. }
  500. String base_dir = dir_access->get_current_dir();
  501. while (!files.is_empty()) {
  502. bool match = patterns.is_empty();
  503. String match_str;
  504. for (const String &E : patterns) {
  505. if (files.front()->get().matchn(E)) {
  506. match_str = E;
  507. match = true;
  508. break;
  509. }
  510. }
  511. if (match) {
  512. TreeItem *ti = tree->create_item(root);
  513. ti->set_text(0, files.front()->get());
  514. if (get_icon_func) {
  515. Ref<Texture2D> icon = get_icon_func(base_dir.path_join(files.front()->get()));
  516. ti->set_icon(0, icon);
  517. } else {
  518. ti->set_icon(0, theme_cache.file);
  519. }
  520. ti->set_icon_modulate(0, theme_cache.file_icon_modulate);
  521. if (mode == FILE_MODE_OPEN_DIR) {
  522. ti->set_custom_color(0, theme_cache.files_disabled);
  523. ti->set_selectable(0, false);
  524. }
  525. Dictionary d;
  526. d["name"] = files.front()->get();
  527. d["dir"] = false;
  528. ti->set_metadata(0, d);
  529. if (file->get_text() == files.front()->get() || match_str == files.front()->get()) {
  530. ti->select(0);
  531. }
  532. }
  533. files.pop_front();
  534. }
  535. if (tree->get_root() && tree->get_root()->get_first_child() && tree->get_selected() == nullptr) {
  536. tree->get_root()->get_first_child()->select(0);
  537. }
  538. }
  539. void FileDialog::_filter_selected(int) {
  540. update_file_name();
  541. update_file_list();
  542. }
  543. void FileDialog::update_filters() {
  544. filter->clear();
  545. if (filters.size() > 1) {
  546. String all_filters;
  547. const int max_filters = 5;
  548. for (int i = 0; i < MIN(max_filters, filters.size()); i++) {
  549. String flt = filters[i].get_slice(";", 0).strip_edges();
  550. if (i > 0) {
  551. all_filters += ", ";
  552. }
  553. all_filters += flt;
  554. }
  555. if (max_filters < filters.size()) {
  556. all_filters += ", ...";
  557. }
  558. filter->add_item(RTR("All Recognized") + " (" + all_filters + ")");
  559. }
  560. for (int i = 0; i < filters.size(); i++) {
  561. String flt = filters[i].get_slice(";", 0).strip_edges();
  562. String desc = filters[i].get_slice(";", 1).strip_edges();
  563. if (desc.length()) {
  564. filter->add_item(String(tr(desc)) + " (" + flt + ")");
  565. } else {
  566. filter->add_item("(" + flt + ")");
  567. }
  568. }
  569. filter->add_item(RTR("All Files") + " (*)");
  570. }
  571. void FileDialog::clear_filters() {
  572. filters.clear();
  573. update_filters();
  574. invalidate();
  575. }
  576. void FileDialog::add_filter(const String &p_filter, const String &p_description) {
  577. ERR_FAIL_COND_MSG(p_filter.begins_with("."), "Filter must be \"filename.extension\", can't start with dot.");
  578. if (p_description.is_empty()) {
  579. filters.push_back(p_filter);
  580. } else {
  581. filters.push_back(vformat("%s ; %s", p_filter, p_description));
  582. }
  583. update_filters();
  584. invalidate();
  585. }
  586. void FileDialog::set_filters(const Vector<String> &p_filters) {
  587. if (filters == p_filters) {
  588. return;
  589. }
  590. filters = p_filters;
  591. update_filters();
  592. invalidate();
  593. }
  594. Vector<String> FileDialog::get_filters() const {
  595. return filters;
  596. }
  597. String FileDialog::get_current_dir() const {
  598. return dir->get_text();
  599. }
  600. String FileDialog::get_current_file() const {
  601. return file->get_text();
  602. }
  603. String FileDialog::get_current_path() const {
  604. return dir->get_text().path_join(file->get_text());
  605. }
  606. void FileDialog::set_current_dir(const String &p_dir) {
  607. _change_dir(p_dir);
  608. _push_history();
  609. }
  610. void FileDialog::set_current_file(const String &p_file) {
  611. if (file->get_text() == p_file) {
  612. return;
  613. }
  614. file->set_text(p_file);
  615. update_dir();
  616. invalidate();
  617. _focus_file_text();
  618. }
  619. void FileDialog::set_current_path(const String &p_path) {
  620. if (!p_path.size()) {
  621. return;
  622. }
  623. int pos = MAX(p_path.rfind("/"), p_path.rfind("\\"));
  624. if (pos == -1) {
  625. set_current_file(p_path);
  626. } else {
  627. String dir = p_path.substr(0, pos);
  628. String file = p_path.substr(pos + 1, p_path.length());
  629. set_current_dir(dir);
  630. set_current_file(file);
  631. }
  632. }
  633. void FileDialog::set_root_subfolder(const String &p_root) {
  634. root_subfolder = p_root;
  635. ERR_FAIL_COND_MSG(!dir_access->dir_exists(p_root), "root_subfolder must be an existing sub-directory.");
  636. local_history.clear();
  637. local_history_pos = -1;
  638. dir_access->change_dir(root_subfolder);
  639. if (root_subfolder.is_empty()) {
  640. root_prefix = "";
  641. } else {
  642. root_prefix = dir_access->get_current_dir();
  643. }
  644. invalidate();
  645. update_dir();
  646. }
  647. String FileDialog::get_root_subfolder() const {
  648. return root_subfolder;
  649. }
  650. void FileDialog::set_mode_overrides_title(bool p_override) {
  651. mode_overrides_title = p_override;
  652. }
  653. bool FileDialog::is_mode_overriding_title() const {
  654. return mode_overrides_title;
  655. }
  656. void FileDialog::set_file_mode(FileMode p_mode) {
  657. ERR_FAIL_INDEX((int)p_mode, 5);
  658. if (mode == p_mode) {
  659. return;
  660. }
  661. mode = p_mode;
  662. switch (mode) {
  663. case FILE_MODE_OPEN_FILE:
  664. set_ok_button_text(RTR("Open"));
  665. if (mode_overrides_title) {
  666. set_title(TTRC("Open a File"));
  667. }
  668. makedir->hide();
  669. break;
  670. case FILE_MODE_OPEN_FILES:
  671. set_ok_button_text(RTR("Open"));
  672. if (mode_overrides_title) {
  673. set_title(TTRC("Open File(s)"));
  674. }
  675. makedir->hide();
  676. break;
  677. case FILE_MODE_OPEN_DIR:
  678. set_ok_button_text(RTR("Select Current Folder"));
  679. if (mode_overrides_title) {
  680. set_title(TTRC("Open a Directory"));
  681. }
  682. makedir->show();
  683. break;
  684. case FILE_MODE_OPEN_ANY:
  685. set_ok_button_text(RTR("Open"));
  686. if (mode_overrides_title) {
  687. set_title(TTRC("Open a File or Directory"));
  688. }
  689. makedir->show();
  690. break;
  691. case FILE_MODE_SAVE_FILE:
  692. set_ok_button_text(RTR("Save"));
  693. if (mode_overrides_title) {
  694. set_title(TTRC("Save a File"));
  695. }
  696. makedir->show();
  697. break;
  698. }
  699. if (mode == FILE_MODE_OPEN_FILES) {
  700. tree->set_select_mode(Tree::SELECT_MULTI);
  701. } else {
  702. tree->set_select_mode(Tree::SELECT_SINGLE);
  703. }
  704. }
  705. FileDialog::FileMode FileDialog::get_file_mode() const {
  706. return mode;
  707. }
  708. void FileDialog::set_access(Access p_access) {
  709. ERR_FAIL_INDEX(p_access, 3);
  710. if (access == p_access) {
  711. return;
  712. }
  713. switch (p_access) {
  714. case ACCESS_FILESYSTEM: {
  715. dir_access = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  716. } break;
  717. case ACCESS_RESOURCES: {
  718. dir_access = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  719. } break;
  720. case ACCESS_USERDATA: {
  721. dir_access = DirAccess::create(DirAccess::ACCESS_USERDATA);
  722. } break;
  723. }
  724. access = p_access;
  725. root_prefix = "";
  726. root_subfolder = "";
  727. _update_drives();
  728. invalidate();
  729. update_filters();
  730. update_dir();
  731. }
  732. void FileDialog::invalidate() {
  733. if (is_visible()) {
  734. update_file_list();
  735. invalidated = false;
  736. } else {
  737. invalidated = true;
  738. }
  739. }
  740. FileDialog::Access FileDialog::get_access() const {
  741. return access;
  742. }
  743. void FileDialog::_make_dir_confirm() {
  744. Error err = dir_access->make_dir(makedirname->get_text().strip_edges());
  745. if (err == OK) {
  746. _change_dir(makedirname->get_text().strip_edges());
  747. update_filters();
  748. _push_history();
  749. } else {
  750. mkdirerr->popup_centered(Size2(250, 50));
  751. }
  752. makedirname->set_text(""); // reset label
  753. }
  754. void FileDialog::_make_dir() {
  755. makedialog->popup_centered(Size2(250, 80));
  756. makedirname->grab_focus();
  757. }
  758. void FileDialog::_select_drive(int p_idx) {
  759. String d = drives->get_item_text(p_idx);
  760. _change_dir(d);
  761. file->set_text("");
  762. _push_history();
  763. }
  764. void FileDialog::_change_dir(const String &p_new_dir) {
  765. if (root_prefix.is_empty()) {
  766. dir_access->change_dir(p_new_dir);
  767. } else {
  768. String old_dir = dir_access->get_current_dir();
  769. dir_access->change_dir(p_new_dir);
  770. if (!dir_access->get_current_dir(false).begins_with(root_prefix)) {
  771. dir_access->change_dir(old_dir);
  772. return;
  773. }
  774. }
  775. invalidate();
  776. update_dir();
  777. }
  778. void FileDialog::_update_drives(bool p_select) {
  779. int dc = dir_access->get_drive_count();
  780. if (dc == 0 || access != ACCESS_FILESYSTEM) {
  781. drives->hide();
  782. } else {
  783. drives->clear();
  784. Node *dp = drives->get_parent();
  785. if (dp) {
  786. dp->remove_child(drives);
  787. }
  788. dp = dir_access->drives_are_shortcuts() ? shortcuts_container : drives_container;
  789. dp->add_child(drives);
  790. drives->show();
  791. for (int i = 0; i < dir_access->get_drive_count(); i++) {
  792. drives->add_item(dir_access->get_drive(i));
  793. }
  794. if (p_select) {
  795. drives->select(dir_access->get_current_drive());
  796. }
  797. }
  798. }
  799. bool FileDialog::default_show_hidden_files = false;
  800. void FileDialog::_bind_methods() {
  801. ClassDB::bind_method(D_METHOD("_cancel_pressed"), &FileDialog::_cancel_pressed);
  802. ClassDB::bind_method(D_METHOD("clear_filters"), &FileDialog::clear_filters);
  803. ClassDB::bind_method(D_METHOD("add_filter", "filter", "description"), &FileDialog::add_filter, DEFVAL(""));
  804. ClassDB::bind_method(D_METHOD("set_filters", "filters"), &FileDialog::set_filters);
  805. ClassDB::bind_method(D_METHOD("get_filters"), &FileDialog::get_filters);
  806. ClassDB::bind_method(D_METHOD("get_current_dir"), &FileDialog::get_current_dir);
  807. ClassDB::bind_method(D_METHOD("get_current_file"), &FileDialog::get_current_file);
  808. ClassDB::bind_method(D_METHOD("get_current_path"), &FileDialog::get_current_path);
  809. ClassDB::bind_method(D_METHOD("set_current_dir", "dir"), &FileDialog::set_current_dir);
  810. ClassDB::bind_method(D_METHOD("set_current_file", "file"), &FileDialog::set_current_file);
  811. ClassDB::bind_method(D_METHOD("set_current_path", "path"), &FileDialog::set_current_path);
  812. ClassDB::bind_method(D_METHOD("set_mode_overrides_title", "override"), &FileDialog::set_mode_overrides_title);
  813. ClassDB::bind_method(D_METHOD("is_mode_overriding_title"), &FileDialog::is_mode_overriding_title);
  814. ClassDB::bind_method(D_METHOD("set_file_mode", "mode"), &FileDialog::set_file_mode);
  815. ClassDB::bind_method(D_METHOD("get_file_mode"), &FileDialog::get_file_mode);
  816. ClassDB::bind_method(D_METHOD("get_vbox"), &FileDialog::get_vbox);
  817. ClassDB::bind_method(D_METHOD("get_line_edit"), &FileDialog::get_line_edit);
  818. ClassDB::bind_method(D_METHOD("set_access", "access"), &FileDialog::set_access);
  819. ClassDB::bind_method(D_METHOD("get_access"), &FileDialog::get_access);
  820. ClassDB::bind_method(D_METHOD("set_root_subfolder", "dir"), &FileDialog::set_root_subfolder);
  821. ClassDB::bind_method(D_METHOD("get_root_subfolder"), &FileDialog::get_root_subfolder);
  822. ClassDB::bind_method(D_METHOD("set_show_hidden_files", "show"), &FileDialog::set_show_hidden_files);
  823. ClassDB::bind_method(D_METHOD("is_showing_hidden_files"), &FileDialog::is_showing_hidden_files);
  824. ClassDB::bind_method(D_METHOD("_update_file_name"), &FileDialog::update_file_name);
  825. ClassDB::bind_method(D_METHOD("_update_dir"), &FileDialog::update_dir);
  826. ClassDB::bind_method(D_METHOD("_update_file_list"), &FileDialog::update_file_list);
  827. ClassDB::bind_method(D_METHOD("deselect_all"), &FileDialog::deselect_all);
  828. ClassDB::bind_method(D_METHOD("invalidate"), &FileDialog::invalidate);
  829. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "mode_overrides_title"), "set_mode_overrides_title", "is_mode_overriding_title");
  830. ADD_PROPERTY(PropertyInfo(Variant::INT, "file_mode", PROPERTY_HINT_ENUM, "Open File,Open Files,Open Folder,Open Any,Save"), "set_file_mode", "get_file_mode");
  831. ADD_PROPERTY(PropertyInfo(Variant::INT, "access", PROPERTY_HINT_ENUM, "Resources,User Data,File System"), "set_access", "get_access");
  832. ADD_PROPERTY(PropertyInfo(Variant::STRING, "root_subfolder"), "set_root_subfolder", "get_root_subfolder");
  833. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "filters"), "set_filters", "get_filters");
  834. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "show_hidden_files"), "set_show_hidden_files", "is_showing_hidden_files");
  835. ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_dir", PROPERTY_HINT_DIR, "", PROPERTY_USAGE_NONE), "set_current_dir", "get_current_dir");
  836. ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_file", PROPERTY_HINT_FILE, "*", PROPERTY_USAGE_NONE), "set_current_file", "get_current_file");
  837. ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_path", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "set_current_path", "get_current_path");
  838. ADD_SIGNAL(MethodInfo("file_selected", PropertyInfo(Variant::STRING, "path")));
  839. ADD_SIGNAL(MethodInfo("files_selected", PropertyInfo(Variant::PACKED_STRING_ARRAY, "paths")));
  840. ADD_SIGNAL(MethodInfo("dir_selected", PropertyInfo(Variant::STRING, "dir")));
  841. BIND_ENUM_CONSTANT(FILE_MODE_OPEN_FILE);
  842. BIND_ENUM_CONSTANT(FILE_MODE_OPEN_FILES);
  843. BIND_ENUM_CONSTANT(FILE_MODE_OPEN_DIR);
  844. BIND_ENUM_CONSTANT(FILE_MODE_OPEN_ANY);
  845. BIND_ENUM_CONSTANT(FILE_MODE_SAVE_FILE);
  846. BIND_ENUM_CONSTANT(ACCESS_RESOURCES);
  847. BIND_ENUM_CONSTANT(ACCESS_USERDATA);
  848. BIND_ENUM_CONSTANT(ACCESS_FILESYSTEM);
  849. }
  850. void FileDialog::set_show_hidden_files(bool p_show) {
  851. if (show_hidden_files == p_show) {
  852. return;
  853. }
  854. show_hidden_files = p_show;
  855. invalidate();
  856. }
  857. bool FileDialog::is_showing_hidden_files() const {
  858. return show_hidden_files;
  859. }
  860. void FileDialog::set_default_show_hidden_files(bool p_show) {
  861. default_show_hidden_files = p_show;
  862. }
  863. FileDialog::FileDialog() {
  864. show_hidden_files = default_show_hidden_files;
  865. vbox = memnew(VBoxContainer);
  866. add_child(vbox, false, INTERNAL_MODE_FRONT);
  867. mode = FILE_MODE_SAVE_FILE;
  868. set_title(TTRC("Save a File"));
  869. HBoxContainer *hbc = memnew(HBoxContainer);
  870. dir_prev = memnew(Button);
  871. dir_prev->set_flat(true);
  872. dir_prev->set_tooltip_text(RTR("Go to previous folder."));
  873. dir_next = memnew(Button);
  874. dir_next->set_flat(true);
  875. dir_next->set_tooltip_text(RTR("Go to next folder."));
  876. dir_up = memnew(Button);
  877. dir_up->set_flat(true);
  878. dir_up->set_tooltip_text(RTR("Go to parent folder."));
  879. hbc->add_child(dir_prev);
  880. hbc->add_child(dir_next);
  881. hbc->add_child(dir_up);
  882. dir_prev->connect("pressed", callable_mp(this, &FileDialog::_go_back));
  883. dir_next->connect("pressed", callable_mp(this, &FileDialog::_go_forward));
  884. dir_up->connect("pressed", callable_mp(this, &FileDialog::_go_up));
  885. hbc->add_child(memnew(Label(RTR("Path:"))));
  886. drives_container = memnew(HBoxContainer);
  887. hbc->add_child(drives_container);
  888. drives = memnew(OptionButton);
  889. drives->connect("item_selected", callable_mp(this, &FileDialog::_select_drive));
  890. hbc->add_child(drives);
  891. dir = memnew(LineEdit);
  892. dir->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
  893. hbc->add_child(dir);
  894. dir->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  895. refresh = memnew(Button);
  896. refresh->set_flat(true);
  897. refresh->set_tooltip_text(RTR("Refresh files."));
  898. refresh->connect("pressed", callable_mp(this, &FileDialog::update_file_list));
  899. hbc->add_child(refresh);
  900. show_hidden = memnew(Button);
  901. show_hidden->set_flat(true);
  902. show_hidden->set_toggle_mode(true);
  903. show_hidden->set_pressed(is_showing_hidden_files());
  904. show_hidden->set_tooltip_text(RTR("Toggle the visibility of hidden files."));
  905. show_hidden->connect("toggled", callable_mp(this, &FileDialog::set_show_hidden_files));
  906. hbc->add_child(show_hidden);
  907. shortcuts_container = memnew(HBoxContainer);
  908. hbc->add_child(shortcuts_container);
  909. makedir = memnew(Button);
  910. makedir->set_text(RTR("Create Folder"));
  911. makedir->connect("pressed", callable_mp(this, &FileDialog::_make_dir));
  912. hbc->add_child(makedir);
  913. vbox->add_child(hbc);
  914. tree = memnew(Tree);
  915. tree->set_hide_root(true);
  916. vbox->add_margin_child(RTR("Directories & Files:"), tree, true);
  917. message = memnew(Label);
  918. message->hide();
  919. message->set_anchors_and_offsets_preset(Control::PRESET_FULL_RECT);
  920. message->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_CENTER);
  921. message->set_vertical_alignment(VERTICAL_ALIGNMENT_CENTER);
  922. tree->add_child(message);
  923. file_box = memnew(HBoxContainer);
  924. file_box->add_child(memnew(Label(RTR("File:"))));
  925. file = memnew(LineEdit);
  926. file->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
  927. file->set_stretch_ratio(4);
  928. file->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  929. file_box->add_child(file);
  930. filter = memnew(OptionButton);
  931. filter->set_stretch_ratio(3);
  932. filter->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  933. filter->set_clip_text(true); // too many extensions overflows it
  934. file_box->add_child(filter);
  935. vbox->add_child(file_box);
  936. dir_access = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  937. _update_drives();
  938. connect("confirmed", callable_mp(this, &FileDialog::_action_pressed));
  939. tree->connect("multi_selected", callable_mp(this, &FileDialog::_tree_multi_selected), CONNECT_DEFERRED);
  940. tree->connect("cell_selected", callable_mp(this, &FileDialog::_tree_selected), CONNECT_DEFERRED);
  941. tree->connect("item_activated", callable_mp(this, &FileDialog::_tree_item_activated));
  942. tree->connect("nothing_selected", callable_mp(this, &FileDialog::deselect_all));
  943. dir->connect("text_submitted", callable_mp(this, &FileDialog::_dir_submitted));
  944. file->connect("text_submitted", callable_mp(this, &FileDialog::_file_submitted));
  945. filter->connect("item_selected", callable_mp(this, &FileDialog::_filter_selected));
  946. confirm_save = memnew(ConfirmationDialog);
  947. add_child(confirm_save, false, INTERNAL_MODE_FRONT);
  948. confirm_save->connect("confirmed", callable_mp(this, &FileDialog::_save_confirm_pressed));
  949. makedialog = memnew(ConfirmationDialog);
  950. makedialog->set_title(RTR("Create Folder"));
  951. VBoxContainer *makevb = memnew(VBoxContainer);
  952. makedialog->add_child(makevb);
  953. makedirname = memnew(LineEdit);
  954. makedirname->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
  955. makevb->add_margin_child(RTR("Name:"), makedirname);
  956. add_child(makedialog, false, INTERNAL_MODE_FRONT);
  957. makedialog->register_text_enter(makedirname);
  958. makedialog->connect("confirmed", callable_mp(this, &FileDialog::_make_dir_confirm));
  959. mkdirerr = memnew(AcceptDialog);
  960. mkdirerr->set_text(RTR("Could not create folder."));
  961. add_child(mkdirerr, false, INTERNAL_MODE_FRONT);
  962. exterr = memnew(AcceptDialog);
  963. exterr->set_text(RTR("Must use a valid extension."));
  964. add_child(exterr, false, INTERNAL_MODE_FRONT);
  965. update_filters();
  966. update_dir();
  967. set_hide_on_ok(false);
  968. if (register_func) {
  969. register_func(this);
  970. }
  971. }
  972. FileDialog::~FileDialog() {
  973. if (unregister_func) {
  974. unregister_func(this);
  975. }
  976. }