Blender V5.3
filesel.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2008 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cstring>
10
11#include <sys/stat.h>
12#include <sys/types.h>
13
14/* path/file handling stuff */
15#ifdef WIN32
16# include "BLI_winstuff.hh"
17# include <direct.h>
18# include <io.h>
19#else
20# include <dirent.h>
21# include <sys/times.h>
22# include <unistd.h>
23#endif
24
26
27#include "DNA_screen_types.h"
28#include "DNA_space_enums.h"
29#include "DNA_space_types.h"
30#include "DNA_userdef_types.h"
31
32#include "MEM_guardedalloc.h"
33
34#include "BLI_fileops.hh"
35#include "BLI_fnmatch.hh"
36#include "BLI_math_base_c.hh"
37#include "BLI_path_utils.hh"
38#include "BLI_string.hh"
39#include "BLI_string_utf8.hh"
40#include "BLI_utildefines.hh"
41
42#include "BLT_date_string.hh"
43#include "BLT_lang.hh"
44#include "BLT_translation.hh"
45
46#include "BKE_appdir.hh"
47#include "BKE_context.hh"
48#include "BKE_idtype.hh"
49#include "BKE_main.hh"
50#include "BKE_preferences.h"
51
52#include "BLO_userdef_default.h"
53
54#include "BLF_api.hh"
55
56#include "ED_fileselect.hh"
57#include "ED_screen.hh"
58
59#include "WM_api.hh"
60#include "WM_types.hh"
61
62#include "RNA_access.hh"
63
64#include "UI_interface.hh"
65#include "UI_interface_icons.hh"
66#include "UI_view2d.hh"
67
68#include "AS_asset_library.hh"
70
71#include "file_banner.hh"
72#include "file_intern.hh"
73#include "filelist.hh"
74
75namespace blender {
76
78{
79 const char *blendfile_path = BKE_main_blendfile_path_from_global();
80
81 /* operator has no setting for this */
82 params->active_file = -1;
83
84 if (!params->dir[0]) {
85 if (blendfile_path[0] != '\0') {
86 BLI_path_split_dir_part(blendfile_path, params->dir, sizeof(params->dir));
87 }
88 else {
89 const char *doc_path = BKE_appdir_folder_default();
90 if (doc_path) {
91 STRNCPY(params->dir, doc_path);
92 }
93 }
94 }
95
97 folderlist_pushdir(sfile->folders_prev, params->dir);
98
99 /* Switching thumbnails needs to recalc layout #28809. */
100 if (sfile->layout) {
101 sfile->layout->dirty = true;
102 }
103}
104
106{
107 UserDef U_default = {};
108
110 BLI_assert(sfile->op == nullptr);
111
112 FileAssetSelectParams *asset_params = sfile->asset_params;
113
114 if (!asset_params) {
115 asset_params = sfile->asset_params = MEM_new<FileAssetSelectParams>("FileAssetSelectParams");
116 asset_params->base_params.details_flags = U_default.file_space_data.details_flags;
118 asset_params->asset_library_ref.custom_library_index = -1;
121 }
122
123 FileSelectParams *base_params = &asset_params->base_params;
124 base_params->file[0] = '\0';
125 base_params->filter_glob[0] = '\0';
126 base_params->flag |= U_default.file_space_data.flag | FILE_ASSETS_ONLY | FILE_FILTER;
127 base_params->flag &= ~FILE_DIRSEL_ONLY;
128 base_params->filter |= FILE_TYPE_BLENDERLIB;
129 base_params->filter_id = FILTER_ID_ALL;
130 base_params->display = FILE_IMGDISPLAY;
131 base_params->sort = FILE_SORT_ASSET_CATALOG;
132 /* No details columns supported for assets (wouldn't contain anything), disable them all. */
133 base_params->details_flags = eFileDetails{};
134 /* Asset libraries include all sub-directories, so enable maximal recursion. */
136 /* 'SMALL' size by default. More reasonable since this is typically used as regular editor,
137 * space is more of an issue here. */
138 base_params->thumbnail_size = 96;
139 base_params->list_thumbnail_size = 32;
140 base_params->list_column_size = 220;
141
142 fileselect_initialize_params_common(sfile, base_params);
143}
144
150{
152
153 UserDef U_default = {};
154 FileSelectParams *params;
155 wmOperator *op = sfile->op;
156
157 const char *blendfile_path = BKE_main_blendfile_path_from_global();
158
159 /* create new parameters if necessary */
160 if (!sfile->params) {
161 sfile->params = MEM_new<FileSelectParams>("fileselparams");
162 /* set path to most recently opened .blend */
163 BLI_path_split_dir_file(blendfile_path,
164 sfile->params->dir,
165 sizeof(sfile->params->dir),
166 sfile->params->file,
167 sizeof(sfile->params->file));
168 sfile->params->filter_glob[0] = '\0';
171 sfile->params->filter_id = U_default.file_space_data.filter_id;
172 sfile->params->list_thumbnail_size = 16;
173 sfile->params->list_column_size = 500;
174 }
175
176 params = sfile->params;
177
178 /* set the parameters from the operator, if it exists */
179 if (op) {
180 PropertyRNA *prop;
181 const bool is_files = (RNA_struct_find_property(op->ptr, "files") != nullptr);
182 const bool is_filepath = (RNA_struct_find_property(op->ptr, "filepath") != nullptr);
183 const bool is_filename = (RNA_struct_find_property(op->ptr, "filename") != nullptr);
184 const bool is_directory = (RNA_struct_find_property(op->ptr, "directory") != nullptr);
185 const bool is_relative_path = (RNA_struct_find_property(op->ptr, "relative_path") != nullptr);
186
188 params->title, WM_operatortype_name(op->type, op->ptr).c_str(), sizeof(params->title));
189
190 if ((prop = RNA_struct_find_property(op->ptr, "filemode"))) {
191 params->type = eFileSelectType(RNA_property_int_get(op->ptr, prop));
192 }
193 else {
194 params->type = FILE_SPECIAL;
195 }
196
197 if (is_filepath && RNA_struct_property_is_set_ex(op->ptr, "filepath", false)) {
198 char filepath[FILE_MAX];
199 RNA_string_get(op->ptr, "filepath", filepath);
200 if (params->type == FILE_LOADLIB) {
201 STRNCPY(params->dir, filepath);
202 params->file[0] = '\0';
203 }
204 else {
206 filepath, params->dir, sizeof(params->dir), params->file, sizeof(params->file));
207 }
208 }
209 else {
210 if (is_directory && RNA_struct_property_is_set_ex(op->ptr, "directory", false)) {
211 RNA_string_get(op->ptr, "directory", params->dir);
212 params->file[0] = '\0';
213 }
214
215 if (is_filename && RNA_struct_property_is_set_ex(op->ptr, "filename", false)) {
216 RNA_string_get(op->ptr, "filename", params->file);
217 }
218 }
219
220 if (params->dir[0]) {
221 BLI_path_abs(params->dir, blendfile_path);
222 BLI_path_normalize_dir(params->dir, sizeof(params->dir));
223 }
224
225 params->flag = eFileSel_Params_Flag{};
226 if (is_directory == true && is_filename == false && is_filepath == false && is_files == false)
227 {
228 params->flag |= FILE_DIRSEL_ONLY;
229 }
230 if ((prop = RNA_struct_find_property(op->ptr, "check_existing"))) {
231 params->flag |= RNA_property_boolean_get(op->ptr, prop) ? FILE_CHECK_EXISTING :
233 }
234 if ((prop = RNA_struct_find_property(op->ptr, "hide_props_region"))) {
235 params->flag |= RNA_property_boolean_get(op->ptr, prop) ? FILE_HIDE_TOOL_PROPS :
237 }
238
239 params->filter = 0;
240 if ((prop = RNA_struct_find_property(op->ptr, "filter_blender"))) {
241 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_BLENDER) : 0;
242 }
243 if ((prop = RNA_struct_find_property(op->ptr, "filter_blenlib"))) {
244 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_BLENDERLIB) : 0;
245 }
246 if ((prop = RNA_struct_find_property(op->ptr, "filter_backup"))) {
247 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_BLENDER_BACKUP) :
248 0;
249 }
250 if ((prop = RNA_struct_find_property(op->ptr, "filter_image"))) {
251 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_IMAGE) : 0;
252 }
253 if ((prop = RNA_struct_find_property(op->ptr, "filter_movie"))) {
254 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_MOVIE) : 0;
255 }
256 if ((prop = RNA_struct_find_property(op->ptr, "filter_python"))) {
257 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_PYSCRIPT) : 0;
258 }
259 if ((prop = RNA_struct_find_property(op->ptr, "filter_font"))) {
260 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_FTFONT) : 0;
261 }
262 if ((prop = RNA_struct_find_property(op->ptr, "filter_sound"))) {
263 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_SOUND) : 0;
264 }
265 if ((prop = RNA_struct_find_property(op->ptr, "filter_text"))) {
266 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_TEXT) : 0;
267 }
268 if ((prop = RNA_struct_find_property(op->ptr, "filter_archive"))) {
269 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_ARCHIVE) : 0;
270 }
271 if ((prop = RNA_struct_find_property(op->ptr, "filter_folder"))) {
272 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_FOLDER) : 0;
273 }
274 if ((prop = RNA_struct_find_property(op->ptr, "filter_btx"))) {
275 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_BTX) : 0;
276 }
277 if ((prop = RNA_struct_find_property(op->ptr, "filter_alembic"))) {
278 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_ALEMBIC) : 0;
279 }
280 if ((prop = RNA_struct_find_property(op->ptr, "filter_usd"))) {
281 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_USD) : 0;
282 }
283 if ((prop = RNA_struct_find_property(op->ptr, "filter_obj"))) {
284 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_OBJECT_IO) : 0;
285 }
286 if ((prop = RNA_struct_find_property(op->ptr, "filter_volume"))) {
287 params->filter |= RNA_property_boolean_get(op->ptr, prop) ? int(FILE_TYPE_VOLUME) : 0;
288 }
289 if ((prop = RNA_struct_find_property(op->ptr, "filter_glob"))) {
290 /* Protection against Python scripts not setting proper size limit. */
291 char *glob = RNA_property_string_get_alloc(op->ptr, prop, nullptr, 0, nullptr);
292 BLI_SCOPED_DEFER([&]() { MEM_delete(glob); });
293 STRNCPY_UTF8(params->filter_glob, glob);
294 /* Fix stupid things that truncating might have generated,
295 * like last group being a 'match everything' wildcard-only one... */
297 if (glob[0] != '\0') {
299 }
300 }
301 else {
302 params->filter_glob[0] = '\0';
303 }
304
305 if (params->filter != 0) {
306 if (U.uiflag & USER_FILTERFILEEXTS) {
307 params->flag |= FILE_FILTER;
308 }
309 else {
310 params->flag &= ~FILE_FILTER;
311 }
312 }
313
314 if (U.uiflag & USER_HIDE_DOT) {
315 params->flag |= FILE_HIDE_DOT;
316 }
317 else {
318 params->flag &= ~FILE_HIDE_DOT;
319 }
320
321 if (params->type == FILE_LOADLIB) {
322 params->flag |= RNA_boolean_get(op->ptr, "link") ? FILE_LINK : eFileSel_Params_Flag{};
323 params->flag |= RNA_boolean_get(op->ptr, "autoselect") ? FILE_AUTOSELECT :
325 params->flag |= RNA_boolean_get(op->ptr, "active_collection") ? FILE_ACTIVE_COLLECTION :
327 }
328
329 if ((prop = RNA_struct_find_property(op->ptr, "allow_path_tokens"))) {
332 }
333
334 if ((prop = RNA_struct_find_property(op->ptr, "display_type"))) {
336 }
337
338 if (params->display == FILE_DEFAULTDISPLAY) {
339 params->display = U_default.file_space_data.display_type;
340 }
341
342 if ((prop = RNA_struct_find_property(op->ptr, "sort_method"))) {
343 params->sort = eFileSortType(RNA_property_enum_get(op->ptr, prop));
344 }
345
346 if (params->sort == FILE_SORT_DEFAULT) {
347 params->sort = U_default.file_space_data.sort_type;
348 }
349
350 if (is_relative_path) {
351 if ((prop = RNA_struct_find_property(op->ptr, "relative_path"))) {
352 if (!RNA_property_is_set_ex(op->ptr, prop, false)) {
353 RNA_property_boolean_set(op->ptr, prop, (U.flag & USER_RELPATHS) != 0);
354 }
355 }
356 }
357 }
358 else {
359 /* default values, if no operator */
360 params->type = FILE_UNIX;
361 params->flag |= U_default.file_space_data.flag;
362 params->flag &= ~FILE_DIRSEL_ONLY;
364 params->sort = FILE_SORT_ALPHA;
365 params->filter = 0;
366 params->filter_glob[0] = '\0';
367 }
368
370
371 return params;
372}
373
375{
376 switch (eFileBrowse_Mode(sfile->browse_mode)) {
378 if (!sfile->params) {
380 }
381 return sfile->params;
383 if (!sfile->asset_params) {
385 }
386 return &sfile->asset_params->base_params;
387 }
388
389 BLI_assert_msg(0, "Invalid browse mode set in file space.");
390 return nullptr;
391}
392
394{
395 if (!sfile) {
396 /* Sometimes called in poll before space type was checked. */
397 return nullptr;
398 }
399
400 switch (eFileBrowse_Mode(sfile->browse_mode)) {
402 return sfile->params;
404 return reinterpret_cast<FileSelectParams *>(sfile->asset_params);
405 }
406
407 BLI_assert_msg(0, "Invalid browse mode set in file space.");
408 return nullptr;
409}
410
412{
413 return (sfile->browse_mode == FILE_BROWSE_MODE_FILES) ? sfile->params : nullptr;
414}
415
417{
418 return (sfile->browse_mode == FILE_BROWSE_MODE_ASSETS) ? sfile->asset_params : nullptr;
419}
420
422{
423 const FileAssetSelectParams *asset_params = ED_fileselect_get_asset_params(sfile);
424 if (asset_params == nullptr) {
425 return false;
426 }
427 return asset_params->asset_library_ref.type == ASSET_LIBRARY_LOCAL;
428}
429
431{
433 FileSelectParams *base_params = &asset_params->base_params;
434 bUserAssetLibrary *user_library = nullptr;
435
436 /* Ensure valid repository, or fall-back to local one. */
437 if (library->type == ASSET_LIBRARY_CUSTOM) {
438 BLI_assert(library->custom_library_index >= 0);
439
440 user_library = BKE_preferences_asset_library_find_index(&U, library->custom_library_index);
441 if (!user_library || !BKE_preferences_asset_library_is_valid(&U, user_library, false)) {
443 }
444 }
445
446 switch (eAssetLibraryType(library->type)) {
448 STRNCPY(base_params->dir, asset_system::essentials_directory_path().c_str());
449 base_params->type = FILE_ASSET_LIBRARY_ESSENTIALS;
450 break;
453 base_params->type = FILE_ASSET_LIBRARY_ESSENTIALS;
454 break;
456 base_params->dir[0] = '\0';
457 base_params->type = FILE_ASSET_LIBRARY_ALL;
458 break;
460 base_params->dir[0] = '\0';
461 base_params->type = FILE_MAIN_ASSET;
462 break;
464 BLI_assert(user_library);
465 STRNCPY(base_params->dir, user_library->resolved_dirpath);
466 base_params->type = (user_library->flag & ASSET_LIBRARY_USE_REMOTE_URL) ?
469 break;
470 }
471}
472
474{
476 if (asset_params) {
478 }
479}
480
482{
483 return (sfile->browse_mode == FILE_BROWSE_MODE_FILES);
484}
485
487{
488 return (sfile->browse_mode == FILE_BROWSE_MODE_ASSETS);
489}
490
492{
493 if (!ED_fileselect_is_asset_browser(sfile) || !sfile->files) {
494 return nullptr;
495 }
496
497 return filelist_asset_library(sfile->files);
498}
499
501{
502 if (!ED_fileselect_is_asset_browser(sfile)) {
503 return nullptr;
504 }
505
506 if (sfile->files == nullptr) {
507 return nullptr;
508 }
509
511 const FileDirEntry *file = filelist_file(sfile->files, params->active_file);
512 if (file == nullptr) {
513 return nullptr;
514 }
515
516 return filelist_file_get_id(file);
517}
518
519void ED_fileselect_activate_asset_catalog(const SpaceFile *sfile, const bUUID catalog_id)
520{
521 if (!ED_fileselect_is_asset_browser(sfile)) {
522 return;
523 }
524
527 params->catalog_id = catalog_id;
529}
530
532{
533 if (!ED_fileselect_is_asset_browser(sfile) || !file->asset) {
534 return -1;
535 }
536
537 /* First handle the case where the asset system dictates a certain import method. */
538 if (file->asset->may_override_import_method() == false) {
539 BLI_assert(file->asset->get_import_method().has_value());
540 return *file->asset->get_import_method();
541 }
542
545
546 if (import_method == FILE_ASSET_IMPORT_LINK && file->asset->owner_asset_library().remote_url()) {
547 /* Remote library assets cannot be linked. Use #remote_url() here since All and
548 * Essentials libraries are already handled above. */
549 import_method = FILE_ASSET_IMPORT_FOLLOW_PREFS;
550 }
551
552 if (import_method == FILE_ASSET_IMPORT_FOLLOW_PREFS) {
553 std::optional asset_import_method = file->asset->get_import_method();
554 return asset_import_method ? *asset_import_method : -1;
555 }
556
557 switch (import_method) {
559 return ASSET_IMPORT_LINK;
561 return ASSET_IMPORT_APPEND;
565 return ASSET_IMPORT_PACK;
566
567 /* Should be handled above already. Break and fail below. */
569 break;
570 }
571
573 return -1;
574}
575
576static void on_reload_activate_by_id(SpaceFile *sfile, onReloadFnData custom_data)
577{
578 ID *asset_id = static_cast<ID *>(custom_data);
579 ED_fileselect_activate_by_id(sfile, asset_id, false);
580}
581
582void ED_fileselect_activate_by_id(SpaceFile *sfile, ID *asset_id, const bool deferred)
583{
584 if (!ED_fileselect_is_asset_browser(sfile)) {
585 return;
586 }
587
588 /* If there are filelist operations running now ("pending" true) or soon ("force reset" true),
589 * there is a fair chance that the to-be-activated ID will only be present after these operations
590 * have completed. Defer activation until then. */
591 if (deferred || filelist_pending(sfile->files) || filelist_needs_force_reset(sfile->files)) {
592 /* This should be thread-safe, as this function is likely called from the main thread, and
593 * notifiers (which cause a call to the on-reload callback function) are handled on the main
594 * thread as well. */
596 return;
597 }
598
600 FileList *files = sfile->files;
601
602 const int file_index = filelist_file_find_id(files, asset_id);
603 const FileDirEntry *file = filelist_file_ex(files, file_index, true);
604 if (file == nullptr) {
605 return;
606 }
607
608 params->active_file = file_index;
610
613}
614
616{
617 const char *relative_path = static_cast<const char *>(custom_data);
618 ED_fileselect_activate_by_relpath(sfile, relative_path);
619}
620
621void ED_fileselect_activate_by_relpath(SpaceFile *sfile, const char *relative_path)
622{
623 /* If there are filelist operations running now ("pending" true) or soon ("force reset" true),
624 * there is a fair chance that the to-be-activated file at relative_path will only be present
625 * after these operations have completed. Defer activation until then. */
626 FileList *files = sfile->files;
627 if (files == nullptr || filelist_pending(files) || filelist_needs_force_reset(files)) {
628 /* Casting away the constness of `relative_path` is safe here, because eventually it just ends
629 * up in another call to this function, and then it's a const char* again. */
631 sfile, on_reload_select_by_relpath, const_cast<char *>(relative_path));
632 return;
633 }
634
636 const int num_files_filtered = filelist_files_ensure(files);
637
638 for (int file_index = 0; file_index < num_files_filtered; ++file_index) {
639 const FileDirEntry *file = filelist_file(files, file_index);
640
641 if (STREQ(file->relpath, relative_path)) {
642 params->active_file = file_index;
644 }
645 }
647}
648
655
656/* The subset of FileSelectParams.flag items we store into preferences. Note that FILE_SORT_ALPHA
657 * may also be remembered, but only conditionally. */
658#define PARAMS_FLAGS_REMEMBERED (FILE_HIDE_DOT)
659
660void ED_fileselect_window_params_get(const wmWindow *win, int r_win_size[2], bool *r_is_maximized)
661{
662 /* Get DPI/pixel-size independent size to be stored in preferences. */
663 WM_window_dpi_set_userdef(win); /* Ensure the DPI is taken from the right window. */
664
665 const int2 win_size = WM_window_native_pixel_size(win);
666 r_win_size[0] = win_size[0] / UI_SCALE_FAC;
667 r_win_size[1] = win_size[1] / UI_SCALE_FAC;
668
669 *r_is_maximized = WM_window_is_maximized(win);
670}
671
673{
674 PropertyRNA *prop;
675 return (sfile->op == nullptr) ||
676 !(prop = RNA_struct_find_property(sfile->op->ptr, "display_type")) ||
678}
679
681{
682 PropertyRNA *prop;
683 return (sfile->op == nullptr) ||
684 !(prop = RNA_struct_find_property(sfile->op->ptr, "sort_method")) ||
685 (RNA_property_enum_get(sfile->op->ptr, prop) == FILE_SORT_DEFAULT);
686}
687
689{
690 wmOperator *op = sfile->op;
691 UserDef_FileSpaceData *sfile_udata = &U.file_space_data;
692
694
696 if (!op) {
697 return;
698 }
699
700 if (sfile_udata->thumbnail_size == 0) {
701 /* Saved params are invalid so continue with defaults. */
702 return;
703 }
704
705 params->thumbnail_size = sfile_udata->thumbnail_size;
706 params->details_flags = sfile_udata->details_flags;
707 params->filter_id = sfile_udata->filter_id;
708
709 /* Combine flags we take from params with the flags we take from userdef. */
710 params->flag = (params->flag & ~PARAMS_FLAGS_REMEMBERED) |
711 (sfile_udata->flag & PARAMS_FLAGS_REMEMBERED);
712
714 params->display = sfile_udata->display_type;
715 }
717 params->sort = sfile_udata->sort_type;
718 /* For the default sorting, also take invert flag from userdef. */
719 params->flag = (params->flag & ~FILE_SORT_INVERT) | (sfile_udata->flag & FILE_SORT_INVERT);
720 }
721}
722
724{
726 UserDef_FileSpaceData *sfile_udata_new = &U.file_space_data;
727 UserDef_FileSpaceData sfile_udata_old = U.file_space_data;
728
729 sfile_udata_new->thumbnail_size = params->thumbnail_size;
730 sfile_udata_new->details_flags = params->details_flags;
731 sfile_udata_new->flag = params->flag & PARAMS_FLAGS_REMEMBERED;
732 sfile_udata_new->filter_id = params->filter_id;
733
734 /* In some rare cases, operators ask for a specific display or sort type (e.g. chronological
735 * sorting for "Recover Auto Save"). So the settings are optimized for a specific operation.
736 * Don't let that change the userdef memory for more general cases. */
738 sfile_udata_new->display_type = params->display;
739 }
741 sfile_udata_new->sort_type = params->sort;
742 /* In this case also remember the invert flag. */
743 sfile_udata_new->flag = (sfile_udata_new->flag & ~FILE_SORT_INVERT) |
744 (params->flag & FILE_SORT_INVERT);
745 }
746
747 /* Tag preferences as dirty if something has changed. */
748 if (memcmp(sfile_udata_new, &sfile_udata_old, sizeof(sfile_udata_old)) != 0) {
749 U.runtime.is_dirty = true;
750 }
751}
752
754{
755 const FileDirEntry *file = filelist_file(sfile->files, index);
756 if (file && file->relpath && file->relpath[0] && !(file->typeflag & FILE_TYPE_DIR)) {
758 STRNCPY(params->file, file->relpath);
759 if (sfile->op) {
760 /* Update the filepath properties of the operator. */
761 Main *bmain = CTX_data_main(C);
762 file_sfile_to_operator(C, bmain, sfile->op, sfile);
763 }
764 }
765}
766
768{
769 int numfiles;
770
771 /* Values in pixels.
772 *
773 * - *_item: size of each (row|col), (including padding)
774 * - *_view: (x|y) size of the view.
775 * - *_over: extra pixels, to take into account, when the fit isn't exact
776 * (needed since you may see the end of the previous column and the beginning of the next).
777 *
778 * Could be more clever and take scrolling into account,
779 * but for now don't bother.
780 */
781 if (layout->flag & FILE_LAYOUT_HOR) {
782 const int x_item = layout->tile_w + (2 * layout->tile_border_x);
783 const int x_view = int(BLI_rctf_size_x(&region->v2d.cur));
784 const int x_over = x_item - (x_view % x_item);
785 numfiles = int(float(x_view + x_over) / float(x_item));
786 return numfiles * layout->rows;
787 }
788
789 const int y_item = layout->tile_h + (2 * layout->tile_border_y);
790 const int y_view = int(BLI_rctf_size_y(&region->v2d.cur)) - layout->offset_top;
791 const int y_over = y_item - (y_view % y_item);
792 numfiles = int(float(y_view + y_over) / float(y_item));
793 return numfiles * layout->flow_columns;
794}
795
796static bool is_inside(int x, int y, int cols, int rows)
797{
798 return ((x >= 0) && (x < cols) && (y >= 0) && (y < rows));
799}
800
802{
803 int colmin, colmax, rowmin, rowmax;
804 FileSelection sel;
805 sel.first = sel.last = -1;
806
807 if (layout == nullptr) {
808 return sel;
809 }
810
811 colmin = (rect->xmin) / (layout->tile_w + 2 * layout->tile_border_x);
812 rowmin = (rect->ymin - layout->offset_top - layout->list_padding_top) /
813 (layout->tile_h + 2 * layout->tile_border_y);
814 colmax = (rect->xmax) / (layout->tile_w + 2 * layout->tile_border_x);
815 rowmax = (rect->ymax - layout->offset_top - layout->list_padding_top) /
816 (layout->tile_h + 2 * layout->tile_border_y);
817
818 if (is_inside(colmin, rowmin, layout->flow_columns, layout->rows) ||
819 is_inside(colmax, rowmax, layout->flow_columns, layout->rows))
820 {
821 CLAMP(colmin, 0, layout->flow_columns - 1);
822 CLAMP(rowmin, 0, layout->rows - 1);
823 CLAMP(colmax, 0, layout->flow_columns - 1);
824 CLAMP(rowmax, 0, layout->rows - 1);
825 }
826
827 if ((colmin > layout->flow_columns - 1) || (rowmin > layout->rows - 1)) {
828 sel.first = -1;
829 }
830 else {
831 if (layout->flag & FILE_LAYOUT_HOR) {
832 sel.first = layout->rows * colmin + rowmin;
833 }
834 else {
835 sel.first = colmin + layout->flow_columns * rowmin;
836 }
837 }
838 if ((colmax > layout->flow_columns - 1) || (rowmax > layout->rows - 1)) {
839 sel.last = -1;
840 }
841 else {
842 if (layout->flag & FILE_LAYOUT_HOR) {
843 sel.last = layout->rows * colmax + rowmax;
844 }
845 else {
846 sel.last = colmax + layout->flow_columns * rowmax;
847 }
848 }
849
850 return sel;
851}
852
854{
855 int offsetx, offsety;
856 int active_file;
857
858 if (layout == nullptr) {
859 return -1;
860 }
861
862 offsetx = (x) / (layout->tile_w + 2 * layout->tile_border_x);
863 offsety = (y - layout->offset_top - layout->list_padding_top) /
864 (layout->tile_h + 2 * layout->tile_border_y);
865
866 if (offsetx > layout->flow_columns - 1) {
867 return -1;
868 }
869 if (offsety > layout->rows - 1) {
870 return -1;
871 }
872
873 if (layout->flag & FILE_LAYOUT_HOR) {
874 active_file = layout->rows * offsetx + offsety;
875 }
876 else {
877 active_file = offsetx + layout->flow_columns * offsety;
878 }
879 return active_file;
880}
881
882void ED_fileselect_layout_maskrect(const FileLayout *layout, const View2D *v2d, rcti *r_rect)
883{
884 *r_rect = v2d->mask;
885 r_rect->ymax -= layout->offset_top;
886}
887
888bool ED_fileselect_layout_is_inside_pt(const FileLayout *layout, const View2D *v2d, int x, int y)
889{
890 rcti maskrect;
891 ED_fileselect_layout_maskrect(layout, v2d, &maskrect);
892 return BLI_rcti_isect_pt(&maskrect, x, y);
893}
894
896 const View2D *v2d,
897 const rcti *rect,
898 rcti *r_dst)
899{
900 rcti maskrect;
901 ED_fileselect_layout_maskrect(layout, v2d, &maskrect);
902 return BLI_rcti_isect(&maskrect, rect, r_dst);
903}
904
905void ED_fileselect_layout_tilepos(const FileLayout *layout, int tile, int *x, int *y)
906{
907 if (layout->flag == FILE_LAYOUT_HOR) {
908 *x = layout->tile_border_x +
909 (tile / layout->rows) * (layout->tile_w + 2 * layout->tile_border_x);
910 *y = layout->offset_top + layout->list_padding_top + layout->tile_border_y +
911 (tile % layout->rows) * (layout->tile_h + 2 * layout->tile_border_y);
912 }
913 else {
914 *x = layout->tile_border_x +
915 ((tile) % layout->flow_columns) * (layout->tile_w + 2 * layout->tile_border_x);
916 *y = layout->offset_top + layout->list_padding_top + layout->tile_border_y +
917 ((tile) / layout->flow_columns) * (layout->tile_h + 2 * layout->tile_border_y);
918 }
919}
920
922 const FileLayout *layout,
923 int x,
924 int y)
925{
926 rcti header_rect = v2d->mask;
927 header_rect.ymin = header_rect.ymax - layout->attribute_column_header_h;
928 return BLI_rcti_isect_pt(&header_rect, x, y);
929}
930
933 const FileLayout *layout)
934{
935 switch (column) {
936 case COLUMN_NAME:
937 /* Always enabled */
938 return true;
939 case COLUMN_DATETIME:
940 return ((params->details_flags & FILE_DETAILS_DATETIME) != 0) &&
941 !FILE_LAYOUT_HIDE_DATE(layout);
942 case COLUMN_SIZE:
943 return ((params->details_flags & FILE_DETAILS_SIZE) != 0) && !FILE_LAYOUT_HIDE_SIZE(layout);
944 default:
945 return false;
946 }
947}
948
950 const FileSelectParams *params,
951 FileLayout *layout,
952 int x)
953{
954 float mx, my;
955 int offset_tile;
956
957 ui::view2d_region_to_view(v2d, x, v2d->mask.ymax - layout->offset_top - 1, &mx, &my);
958 offset_tile = ED_fileselect_layout_offset(
959 layout, int(v2d->tot.xmin + mx), int(v2d->tot.ymax - my));
960 if (offset_tile > -1) {
961 int tile_x, tile_y;
962 int pos_x = 0;
963 int rel_x; /* x relative to the hovered tile */
964
965 ED_fileselect_layout_tilepos(layout, offset_tile, &tile_x, &tile_y);
966 /* Column header drawing doesn't use left tile border, so subtract it. */
967 rel_x = mx - (tile_x - layout->tile_border_x);
968
970 column < ATTRIBUTE_COLUMN_MAX;
971 column = FileAttributeColumnType(int(column) + 1))
972 {
973 if (!file_attribute_column_type_enabled(params, column, layout)) {
974 continue;
975 }
976 const int width = layout->attribute_columns[column].width;
977
978 if (IN_RANGE(rel_x, pos_x, pos_x + width)) {
979 return column;
980 }
981
982 pos_x += width;
983 }
984 }
985
986 return COLUMN_NONE;
987}
988
989float file_string_width(const char *str)
990{
991 const uiStyle *style = ui::style_get();
992 ui::fontstyle_set(&style->widget);
994}
995
997{
998 const uiStyle *style = ui::style_get();
999 return ui::fontstyle_height_max(&style->widget);
1000}
1001
1003{
1004 FileAttributeColumn *columns = layout->attribute_columns;
1005 const int pad = ATTRIBUTE_COLUMN_PADDING * 2;
1006 const bool compact = FILE_LAYOUT_COMPACT(layout);
1007
1008 for (int i = 0; i < ATTRIBUTE_COLUMN_MAX; i++) {
1009 layout->attribute_columns[i].width = 0;
1010 }
1011
1012 /* Biggest possible reasonable values... */
1014 const char *lang = BLT_lang_get();
1015 constexpr tm test = {59, 59, 3, 30, 8, 199, 6, 365, 0}; /* September 30, 2099 03:59:59 */
1016 std::string modified_s = compact ?
1017 date_string::date(test, lang) :
1019 lang,
1020 date_string::DateFormat(U.date_format),
1021 date_string::TimeFormat(U.time_format));
1022 int width = file_string_width(modified_s.c_str());
1023 columns[COLUMN_DATETIME].width = width + pad + (0.5f * UI_UNIT_X);
1024 }
1025 if (file_attribute_column_type_enabled(params, COLUMN_SIZE, layout)) {
1026 columns[COLUMN_SIZE].width = file_string_width(compact ? "369G" : "098.7 MiB") + pad;
1027 }
1028
1029 if (params->display == FILE_IMGDISPLAY) {
1030 columns[COLUMN_NAME].width = (float(params->thumbnail_size) / 8.0f) * UI_UNIT_X;
1031 }
1032 /* Name column uses remaining width */
1033 else {
1034 int remwidth = layout->tile_w;
1035 for (FileAttributeColumnType column_type =
1037 column_type >= 0;
1038 column_type = FileAttributeColumnType(int(column_type) - 1))
1039 {
1040 if ((column_type == COLUMN_NAME) ||
1041 !file_attribute_column_type_enabled(params, column_type, layout))
1042 {
1043 continue;
1044 }
1045 remwidth -= columns[column_type].width;
1046 }
1047 columns[COLUMN_NAME].width = remwidth;
1048 }
1049}
1050
1068
1070{
1072 FileLayout *layout = nullptr;
1073 View2D *v2d = &region->v2d;
1074 int numfiles;
1075
1076 if (sfile->layout == nullptr) {
1077 sfile->layout = MEM_new_zeroed<FileLayout>("file_layout");
1078 sfile->layout->dirty = true;
1079 }
1080 else if (sfile->layout->dirty == false) {
1081 return;
1082 }
1083
1084 numfiles = filelist_files_ensure(sfile->files);
1085 layout = sfile->layout;
1086 /* Slightly increased than font height for padding. */
1088 layout->text_lines_count = 1;
1089 layout->offset_top = 0;
1090
1091 if (params->display == FILE_IMGDISPLAY) {
1092 /* More compact spacing for asset browser. */
1093 const float pad_fac = ED_fileselect_is_asset_browser(sfile) ? 0.15f : 0.3f;
1094 /* Matches preview_tile_size_x()/_y() by default. */
1095 layout->prv_w = (float(params->thumbnail_size) / 20.0f) * UI_UNIT_X;
1096 layout->prv_h = (float(params->thumbnail_size) / 20.0f) * UI_UNIT_Y;
1097 layout->tile_border_x = pad_fac * UI_UNIT_X;
1098 layout->tile_border_y = pad_fac * UI_UNIT_X;
1099 layout->list_padding_top = 0;
1100 layout->prv_border_x = pad_fac * UI_UNIT_X;
1101 layout->prv_border_y = pad_fac * UI_UNIT_Y;
1102 layout->tile_w = layout->prv_w + 2 * layout->prv_border_x;
1103 layout->text_lines_count = 2;
1104 layout->tile_h = layout->prv_h + 2 * layout->prv_border_y +
1105 layout->text_lines_count * layout->text_line_height;
1106 layout->width = int(BLI_rctf_size_x(&v2d->cur) - 2 * layout->tile_border_x);
1107 layout->flow_columns = layout->width / (layout->tile_w + 2 * layout->tile_border_x);
1108 layout->attribute_column_header_h = 0;
1109 layout->offset_top = 0;
1110 if (layout->flow_columns > 0) {
1111 layout->rows = divide_ceil_u(numfiles, layout->flow_columns);
1112 }
1113 else {
1114 layout->flow_columns = 1;
1115 layout->rows = numfiles;
1116 }
1117 layout->height = sfile->layout->rows * (layout->tile_h + 2 * layout->tile_border_y) +
1118 layout->tile_border_y * 2 - layout->offset_top;
1119 layout->flag = FILE_LAYOUT_VER;
1120 }
1121 else if (params->display == FILE_VERTICALDISPLAY) {
1122 int rowcount;
1123
1126 layout->tile_border_x = 0.4f * UI_UNIT_X;
1127 layout->tile_border_y = 0.05f * UI_UNIT_Y;
1128 layout->list_padding_top = 2 * layout->tile_border_y;
1129 layout->tile_h = round_fl_to_int(layout->text_line_height * 1.4f);
1130 layout->width = int(BLI_rctf_size_x(&v2d->cur) - 2 * layout->tile_border_x);
1131 layout->tile_w = layout->width;
1132 layout->flow_columns = 1;
1133 layout->attribute_column_header_h = layout->tile_h * 1.2f + 2 * layout->tile_border_y;
1134 layout->offset_top = layout->attribute_column_header_h;
1135 rowcount = int(BLI_rctf_size_y(&v2d->cur) - layout->offset_top -
1136 2 * layout->list_padding_top) /
1137 (layout->tile_h + 2 * layout->tile_border_y);
1138 file_attribute_columns_init(params, layout);
1139
1140 layout->rows = std::max(rowcount, numfiles);
1141
1142 /* layout->rows can be zero if a very small area is changed to a File Browser. #124168. */
1143
1144 layout->height = sfile->layout->rows * (layout->tile_h + 2 * layout->tile_border_y) +
1145 layout->list_padding_top * 2 + layout->offset_top;
1146 layout->flag = FILE_LAYOUT_VER;
1147 }
1148 else if (params->display == FILE_HORIZONTALDISPLAY) {
1149 layout->prv_w = params->list_thumbnail_size * UI_SCALE_FAC;
1150 layout->prv_h = params->list_thumbnail_size * UI_SCALE_FAC;
1151 layout->tile_border_x = 0.4f * UI_UNIT_X;
1152 layout->tile_border_y = 0.05f * UI_UNIT_Y;
1153 layout->list_padding_top = 2 * layout->tile_border_y;
1154 layout->tile_h = std::max(round_fl_to_int(layout->text_line_height * 1.4f), layout->prv_h);
1155 layout->attribute_column_header_h = 0;
1156 layout->offset_top = layout->attribute_column_header_h;
1157 layout->height = int(BLI_rctf_size_y(&v2d->cur) - 2 * layout->tile_border_y);
1158 /* Padding by full scroll-bar H is too much, can overlap tile border Y. */
1159 layout->rows = (layout->height - V2D_SCROLL_HEIGHT + layout->tile_border_y) /
1160 (layout->tile_h + 2 * layout->tile_border_y);
1161
1162 layout->tile_w = params->list_column_size * UI_SCALE_FAC;
1163 file_attribute_columns_init(params, layout);
1164
1165 if (layout->rows > 0) {
1166 layout->flow_columns = divide_ceil_u(numfiles, layout->rows);
1167 }
1168 else {
1169 layout->rows = 1;
1170 layout->flow_columns = numfiles;
1171 }
1172 layout->width = (numfiles > 0) ? (sfile->layout->flow_columns *
1173 (layout->tile_w + 2 * layout->tile_border_x) +
1174 layout->tile_border_x * 2) :
1175 int(BLI_rctf_size_x(&v2d->cur) - 2 * layout->tile_border_x);
1176 layout->flag = FILE_LAYOUT_HOR;
1177 }
1178 layout->dirty = false;
1179
1180 if (sfile->runtime->banners_state.any_visible) {
1181 layout->offset_top += UI_UNIT_Y + 2 * sfile->layout->tile_border_y;
1182 }
1183}
1184
1186{
1187 if (!sfile->layout) {
1188 ED_fileselect_init_layout(sfile, region);
1189 }
1190 return sfile->layout;
1191}
1192
1194{
1195 /* May happen when manipulating non-active spaces. */
1196 if (area->spacetype != SPACE_FILE) [[unlikely]] {
1197 return;
1198 }
1199 SpaceFile *sfile = area->spacedata.first_as<SpaceFile>();
1201 if (params) {
1203 ED_fileselect_clear(wm, sfile);
1204
1205 /* Clear search string, it is very rare to want to keep that filter while changing dir,
1206 * and usually very annoying to keep it actually! */
1207 params->filter_search[0] = '\0';
1208 params->active_file = -1;
1209
1210 if (!filelist_is_dir(sfile->files, params->dir)) {
1211 STRNCPY(params->dir, filelist_dir(sfile->files));
1212 /* could return but just refresh the current dir */
1213 }
1214 filelist_setdir(sfile->files, params->dir);
1215
1216 if (folderlist_clear_next(sfile)) {
1218 }
1219
1220 folderlist_pushdir(sfile->folders_prev, params->dir);
1221
1222 file_draw_check_ex(C, area);
1223 }
1224}
1225
1227{
1228 ScrArea *area = CTX_wm_area(C);
1229 ED_file_change_dir_ex(C, area);
1230}
1231
1233{
1234 FileSelection sel;
1235 sel.first = 0;
1236 sel.last = filelist_files_ensure(sfile->files) - 1;
1237
1239}
1240
1241int file_select_match(SpaceFile *sfile, const char *pattern, char *matched_file)
1242{
1243 int match = 0;
1244
1245 int n = filelist_files_ensure(sfile->files);
1246
1247 /* select any file that matches the pattern, this includes exact match
1248 * if the user selects a single file by entering the filename
1249 */
1250 for (int i = 0; i < n; i++) {
1251 const char *relpath = filelist_entry_get_relpath(sfile->files, i);
1252 /* Do not check whether file is a file or dir here! Causes: #44243
1253 * (we do accept directories at this stage). */
1254 if (fnmatch(pattern, relpath, 0) == 0) {
1256 if (!match) {
1257 BLI_strncpy(matched_file, relpath, FILE_MAX);
1258 }
1259 match++;
1260 }
1261 }
1262
1263 return match;
1264}
1265
1266int autocomplete_directory(bContext *C, char *str, void * /*arg_v*/)
1267{
1268 SpaceFile *sfile = CTX_wm_space_file(C);
1269 int match = AUTOCOMPLETE_NO_MATCH;
1270
1271 /* search if str matches the beginning of name */
1272 if (str[0] && sfile->files) {
1273 char dirname[FILE_MAX];
1274
1275 DIR *dir;
1276 dirent *de;
1277
1279
1281 dir = opendir(dirname);
1282
1283 if (dir) {
1285
1286 while ((de = readdir(dir)) != nullptr) {
1287 if (FILENAME_IS_CURRPAR(de->d_name)) {
1288 /* pass */
1289 }
1290 else {
1291 char dirpath[FILE_MAX];
1292 BLI_stat_t status;
1293
1294 BLI_path_join(dirpath, sizeof(dirpath), dirname, de->d_name);
1295
1296 if (BLI_stat(dirpath, &status) == 0) {
1297 if (S_ISDIR(status.st_mode)) { /* is subdir */
1298 autocomplete_update_name(autocpl, dirpath);
1299 }
1300 }
1301 }
1302 }
1303 closedir(dir);
1304
1305 match = autocomplete_end(autocpl, str);
1306 if (match == AUTOCOMPLETE_FULL_MATCH) {
1308 }
1309 }
1310 }
1311
1312 return match;
1313}
1314
1315int autocomplete_file(bContext *C, char *str, void * /*arg_v*/)
1316{
1317 SpaceFile *sfile = CTX_wm_space_file(C);
1318 int match = AUTOCOMPLETE_NO_MATCH;
1319
1320 /* search if str matches the beginning of name */
1321 if (str[0] && sfile->files) {
1323 int nentries = filelist_files_ensure(sfile->files);
1324
1325 for (int i = 0; i < nentries; i++) {
1326 const char *relpath = filelist_entry_get_relpath(sfile->files, i);
1327 autocomplete_update_name(autocpl, relpath);
1328 }
1329 match = autocomplete_end(autocpl, str);
1330 }
1331
1332 return match;
1333}
1334
1336{
1337 /* Only null in rare cases, see: #29734. */
1338 if (sfile->files) {
1340 filelist_freelib(sfile->files);
1341 filelist_clear(sfile->files);
1342 }
1343
1345 params->highlight_file = -1;
1346 }
1348}
1349
1351{
1352 /* Only null in rare cases, see: #29734. */
1353 if (sfile->files) {
1355 filelist_freelib(sfile->files);
1359 }
1360
1362 params->highlight_file = -1;
1363 }
1365}
1366
1368{
1369 if (!sfile) {
1370 return;
1371 }
1372 if (sfile->op) {
1375 sfile->op = nullptr;
1376 }
1377
1379
1380 if (sfile->files) {
1381 ED_fileselect_clear(wm, sfile);
1382 filelist_free(sfile->files);
1383 sfile->files = nullptr;
1384 }
1385}
1386
1392
1394{
1396
1398
1399 if (sfile->smoothscroll_timer != nullptr) {
1401 }
1402 sfile->smoothscroll_timer = WM_event_timer_add(wm, win, TIMER1, 1.0 / 1000.0);
1403 sfile->scroll_offset = 0;
1404}
1405
1407 wmWindow *win,
1408 SpaceFile *sfile,
1409 const FileDirEntry *rename_file)
1410{
1412
1414 sfile->files, rename_file, FILE_SEL_REMOVE, FILE_SEL_EDITING, CHECK_ALL);
1415
1416 /* Ensure smooth-scroll timer is active, even if not needed, because that way rename state is
1417 * handled properly. */
1419 /* Also always activate the rename file, even if renaming was canceled. */
1420 file_params_renamefile_activate(sfile, params);
1421}
1422
1424{
1425 params->renamefile[0] = '\0';
1426 params->rename_id = nullptr;
1428}
1429
1430static int file_params_find_renamed(const FileSelectParams *params, FileList *filelist)
1431{
1432 /* Find the file either through the local ID/asset it represents or its relative path. */
1433 return (params->rename_id != nullptr) ? filelist_file_find_id(filelist, params->rename_id) :
1434 filelist_file_find_path(filelist, params->renamefile);
1435}
1436
1438{
1439 BLI_assert(params->rename_flag != 0);
1440
1442 0)
1443 {
1444 return;
1445 }
1446
1447 BLI_assert(params->renamefile[0] != '\0' || params->rename_id != nullptr);
1448
1449 int idx = file_params_find_renamed(params, sfile->files);
1450 if (idx >= 0) {
1451 FileDirEntry *file = filelist_file(sfile->files, idx);
1452 BLI_assert(file != nullptr);
1453
1454 params->active_file = idx;
1456
1457 if ((params->rename_flag & FILE_PARAMS_RENAME_PENDING) != 0) {
1460 }
1461 else if ((params->rename_flag & FILE_PARAMS_RENAME_POSTSCROLL_PENDING) != 0) {
1462 /* file_select_deselect_all() will resort and re-filter, so `idx` will probably have changed.
1463 * Need to get the correct #FileDirEntry again. */
1465 idx = file_params_find_renamed(params, sfile->files);
1466 file = filelist_file(sfile->files, idx);
1468 params->active_file = idx;
1471 }
1472 }
1473 /* File listing is now asynchronous, only reset renaming if matching entry is not found
1474 * when file listing is not done. */
1475 else if (filelist_is_ready(sfile->files)) {
1477 }
1478}
1479
1481{
1482 bScreen *screen = WM_window_get_active_screen(win);
1483
1484 ED_screen_areas_iter (win, screen, area) {
1485 if (area->spacetype == SPACE_FILE) {
1486 SpaceFile *sfile = area->spacedata.first_as<SpaceFile>();
1487
1488 if (sfile->op == file_operator) {
1489 return area;
1490 }
1491 }
1492 }
1493
1494 return nullptr;
1495}
1496
1498{
1499 const bScreen *screen = WM_window_get_active_screen(win);
1500
1501 ED_screen_areas_iter (win, screen, area) {
1502 if (area->spacetype != SPACE_FILE) {
1503 continue;
1504 }
1505
1506 const SpaceFile *sfile = area->spacedata.first_as<SpaceFile>();
1507 if (sfile->op) {
1508 return area;
1509 }
1510 }
1511
1512 return nullptr;
1513}
1514
1516{
1517 if (!RNA_struct_property_is_set_ex(op->ptr, "filepath", false)) {
1518 Main *bmain = CTX_data_main(C);
1519 char filepath[FILE_MAX];
1520 const char *blendfile_path = BKE_main_blendfile_path(bmain);
1521
1522 if (blendfile_path[0] == '\0') {
1523 STRNCPY(filepath, DATA_("Untitled"));
1524 }
1525 else {
1526 STRNCPY(filepath, blendfile_path);
1527 }
1528
1529 BLI_path_extension_replace(filepath, sizeof(filepath), extension);
1530 RNA_string_set(op->ptr, "filepath", filepath);
1531 }
1532}
1533
1535{
1536 Vector<std::string> paths;
1537 char path[FILE_MAX_LIBEXTRA];
1538 for (const int i : IndexRange(filelist_files_ensure(sfile->files))) {
1539 if (filelist_entry_is_selected(sfile->files, i)) {
1540 const FileDirEntry *entry = filelist_file(sfile->files, i);
1541 filelist_file_get_full_path(sfile->files, entry, path);
1542 paths.append(path);
1543 }
1544 }
1545 return paths;
1546}
1547
1548} // namespace blender
Main runtime representation of an asset.
#define BLF_DRAW_STR_DUMMY_MAX
Definition BLF_api.hh:456
File and directory operations.
#define BLI_SCOPED_DEFER(function_to_defer)
#define FILE_MAX
#define BLI_path_join(...)
#define FILENAME_IS_CURRPAR(_n)
#define STRNCPY_UTF8(dst, src)
Compatibility-like things for windows.
struct __dirstream DIR
struct dirent * readdir(DIR *dp)
int closedir(DIR *dp)
#define S_ISDIR(x)
const char * dirname(char *path)
DIR * opendir(const char *path)
#define DATA_(msgid)
#define FILTER_ID_ALL
Definition DNA_ID.h:1241
#define FILE_MAX_LIBEXTRA
#define FILE_SELECT_MAX_RECURSIONS
#define UI_SCALE_FAC
#define FILE_LAYOUT_HOR
#define FILE_LAYOUT_VER
#define ED_screen_areas_iter(win, screen, area_name)
Definition ED_screen.hh:322
Read Blender memory allocation and freeing.
#define C
Definition RandGen.cpp:29
#define UI_UNIT_Y
#define AUTOCOMPLETE_FULL_MATCH
#define AUTOCOMPLETE_NO_MATCH
#define UI_UNIT_X
#define ICON_DEFAULT_WIDTH_SCALE
#define ICON_DEFAULT_HEIGHT_SCALE
#define V2D_SCROLL_HEIGHT
Definition UI_view2d.hh:78
#define NA_ACTIVATED
Definition WM_types.hh:640
#define ND_SPACE_ASSET_PARAMS
Definition WM_types.hh:568
#define NC_ASSET
Definition WM_types.hh:417
#define ND_SPACE_FILE_PARAMS
Definition WM_types.hh:566
#define NC_SPACE
Definition WM_types.hh:405
#define NA_SELECTED
Definition WM_types.hh:639
#define ND_SPACE_FILE_LIST
Definition WM_types.hh:567
int pad[32 - sizeof(int)]
#define CLAMP(a, b, c)
#define BLI_assert_unreachable()
#define IN_RANGE(a, b, c)
#define BLI_assert_msg(a, msg)
#define STREQ(a, b)
constexpr IndexRange()=default
void append(const T &value)
virtual std::optional< StringRefNull > remote_url() const
std::optional< eAssetImportMethod > get_import_method() const
#define str(s)
#define FILE_LAYOUT_HIDE_SIZE(_layout)
#define FILE_LAYOUT_COMPACT(_layout)
#define ATTRIBUTE_COLUMN_PADDING
#define FILE_LAYOUT_HIDE_DATE(_layout)
#define PARAMS_FLAGS_REMEMBERED
Definition filesel.cc:658
const ccl_global KernelWorkTile * tile
StringRefNull online_essentials_cache_directory_path()
StringRefNull essentials_directory_path()
std::string datetime(const std::tm &date_time, StringRef locale_iso={}, DateFormat date_format=DateFormat::Default, TimeFormat time_format=TimeFormat::H24, const std::tm *now=nullptr, StringRef today={}, StringRef yesterday={})
std::string date(const std::tm &date_time, StringRef locale_iso={}, DateFormat format=DateFormat::Default)
const uiStyle * style_get()
void fontstyle_set(const uiFontStyle *fs)
void view2d_region_to_view(const View2D *v2d, float x, float y, float *r_view_x, float *r_view_y) ATTR_NONNULL()
Definition view2d.cc:1651
int fontstyle_height_max(const uiFontStyle *fs)
AutoComplete * autocomplete_begin(const char *startname, size_t maxncpy)
BMesh Iterators.
void file_params_renamefile_activate(SpaceFile *sfile, FileSelectParams *params)
Definition filesel.cc:1437
void WM_main_add_notifier(uint type, void *reference)
char * RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen, int *r_len)
UserDef U
Definition blender.cc:58
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
Vector< std::string > ED_fileselect_selected_files_full_paths(const SpaceFile *sfile)
Definition filesel.cc:1534
static void file_attribute_columns_init(const FileSelectParams *params, FileLayout *layout)
Definition filesel.cc:1051
int ED_fileselect_layout_offset(FileLayout *layout, int x, int y)
Definition filesel.cc:853
@ FILE_ASSET_IMPORT_LINK
@ FILE_ASSET_IMPORT_FOLLOW_PREFS
@ FILE_ASSET_IMPORT_APPEND_REUSE
@ FILE_ASSET_IMPORT_APPEND
@ FILE_ASSET_IMPORT_PACK
ScrArea * CTX_wm_area(const bContext *C)
char * STRNCPY(char(&dst)[N], const char *src)
int filelist_file_find_path(FileList *filelist, const char *filename)
Definition filelist.cc:1354
int ED_fileselect_layout_numfiles(FileLayout *layout, ARegion *region)
Definition filesel.cc:767
void ED_file_change_dir_ex(bContext *C, ScrArea *area)
Definition filesel.cc:1193
void filelist_freelib(FileList *filelist)
Definition filelist.cc:1055
PropertyRNA * RNA_struct_find_property(PointerRNA *ptr, const char *identifier)
FileLayout * ED_fileselect_get_layout(SpaceFile *sfile, ARegion *region)
Definition filesel.cc:1185
float BLF_width(int fontid, const char *str, size_t str_len, ResultBLF *r_info=nullptr) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2)
Definition blf.cc:835
void ED_file_change_dir(bContext *C)
Definition filesel.cc:1226
std::string WM_operatortype_name(wmOperatorType *ot, PointerRNA *properties)
bool BLI_path_abs(char path[FILE_MAX], const char *basepath) ATTR_NONNULL(1
bool filelist_is_dir(const FileList *filelist, const char *path)
Definition filelist.cc:1128
MINLINE int round_fl_to_int(float a)
int file_select_match(SpaceFile *sfile, const char *pattern, char *matched_file)
Definition filesel.cc:1241
static void fileselect_initialize_params_common(SpaceFile *sfile, FileSelectParams *params)
Definition filesel.cc:77
bool BLI_rcti_isect(const struct rcti *src1, const struct rcti *src2, struct rcti *dest)
@ ASSET_LIBRARY_USE_REMOTE_URL
int BLI_path_normalize_dir(char *dir, size_t dir_maxncpy) ATTR_NONNULL(1)
@ FILE_SORT_ASSET_CATALOG
void folder_history_list_ensure_for_active_browse_mode(SpaceFile *sfile)
void RNA_string_set(PointerRNA *ptr, const char *name, const char *value)
bool ED_fileselect_is_asset_browser(const SpaceFile *sfile)
Definition filesel.cc:486
int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop)
@ FILE_HORIZONTALDISPLAY
char * BLI_strncpy_utf8(char *__restrict dst, const char *__restrict src, size_t dst_maxncpy) ATTR_NONNULL(1
FileSelectParams * ED_fileselect_ensure_active_params(SpaceFile *sfile)
Definition filesel.cc:374
bool RNA_struct_property_is_set_ex(PointerRNA *ptr, const char *identifier, bool use_ghost)
struct bUserAssetLibrary * BKE_preferences_asset_library_find_index(const struct UserDef *userdef, int index) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
void ED_fileselect_layout_tilepos(const FileLayout *layout, int tile, int *x, int *y)
Definition filesel.cc:905
@ FILE_DETAILS_DATETIME
void folderlist_free(ListBaseT< FolderList > *folderlist)
@ FILE_BROWSE_MODE_FILES
@ FILE_BROWSE_MODE_ASSETS
const char * BKE_main_blendfile_path_from_global()
Definition main.cc:1063
static FileSelectParams * fileselect_ensure_updated_file_params(SpaceFile *sfile)
Definition filesel.cc:149
@ FILE_SEL_REMOVE
Definition filelist.hh:37
@ FILE_SEL_ADD
Definition filelist.hh:38
int autocomplete_file(bContext *C, char *str, void *arg_v)
Definition filesel.cc:1315
static int file_params_find_renamed(const FileSelectParams *params, FileList *filelist)
Definition filesel.cc:1430
bool BKE_preferences_asset_library_is_valid(const UserDef *userdef, const struct bUserAssetLibrary *library, const bool check_directory_exists) ATTR_NONNULL()
void filelist_setdir(FileList *filelist, char dirpath[1282])
void filelist_clear_from_reset_tag(FileList *filelist)
Definition filelist.cc:1011
void file_params_smoothscroll_timer_clear(wmWindowManager *wm, wmWindow *win, SpaceFile *sfile)
Definition filesel.cc:1387
int autocomplete_directory(bContext *C, char *str, void *arg_v)
Definition filesel.cc:1266
asset_system::AssetLibrary * filelist_asset_library(FileList *filelist)
Definition filelist.cc:1050
void file_select_deselect_all(SpaceFile *sfile, eDirEntry_SelectFlag flag)
Definition filesel.cc:1232
@ ASSET_LIBRARY_CUSTOM
@ ASSET_LIBRARY_ESSENTIALS
@ ASSET_LIBRARY_ONLINE_ESSENTIALS
@ ASSET_LIBRARY_LOCAL
ScrArea * ED_fileselect_handler_area_find(const wmWindow *win, const wmOperator *file_operator)
Definition filesel.cc:1480
@ FILE_PARAMS_RENAME_ACTIVE
@ FILE_PARAMS_RENAME_POSTSCROLL_PENDING
@ FILE_PARAMS_RENAME_POSTSCROLL_ACTIVE
@ FILE_PARAMS_RENAME_PENDING
@ EVT_FILESELECT_EXTERNAL_CANCEL
void ED_fileselect_activate_asset_catalog(const SpaceFile *sfile, bUUID catalog_id)
Definition filesel.cc:519
bool RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop)
bool ED_fileselect_layout_is_inside_pt(const FileLayout *layout, const View2D *v2d, int x, int y)
Definition filesel.cc:888
const char * BKE_main_blendfile_path(const Main *bmain) ATTR_NONNULL()
Definition main.cc:1058
void fileselect_refresh_params(SpaceFile *sfile)
Definition filesel.cc:473
@ FILE_ASSET_LIBRARY_ALL
@ FILE_ASSET_LIBRARY_ESSENTIALS
@ FILE_ASSET_LIBRARY_REMOTE
FileAttributeColumnType file_attribute_column_type_find_isect(const View2D *v2d, const FileSelectParams *params, FileLayout *layout, int x)
Definition filesel.cc:949
FileSelection ED_fileselect_layout_offset_rect(FileLayout *layout, const rcti *rect)
Definition filesel.cc:801
void ED_fileselect_activate_by_id(SpaceFile *sfile, ID *asset_id, bool deferred)
Definition filesel.cc:582
char * BLI_strncpy(char *__restrict dst, const char *__restrict src, size_t dst_maxncpy) ATTR_NONNULL(1
FileDirEntry * filelist_file_ex(FileList *filelist, int index, bool use_request)
Definition filelist.cc:1307
void void BLI_path_split_dir_part(const char *filepath, char *dir, size_t dir_maxncpy) ATTR_NONNULL(1
VecBase< int32_t, 2 > int2
void file_params_rename_end(wmWindowManager *wm, wmWindow *win, SpaceFile *sfile, const FileDirEntry *rename_file)
Definition filesel.cc:1406
void * MEM_new_zeroed(size_t len, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
FileDirEntry * filelist_file(FileList *filelist, int index)
Definition filelist.cc:1349
@ ASSET_IMPORT_APPEND
@ ASSET_IMPORT_APPEND_REUSE
void ED_fileselect_params_to_userdef(SpaceFile *sfile)
Definition filesel.cc:723
bool filelist_needs_force_reset(const FileList *filelist)
Definition filelist.cc:1197
void filelist_entry_select_index_set(FileList *filelist, int index, FileSelType select, eDirEntry_SelectFlag flag, FileCheckType check)
Definition filelist.cc:2036
@ CHECK_ALL
Definition filelist.hh:45
int BLI_stat(const char *path, BLI_stat_t *buffer) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
bool RNA_property_is_set_ex(PointerRNA *ptr, PropertyRNA *prop, bool use_ghost)
bool WM_window_is_maximized(const wmWindow *win)
BLI_INLINE float BLI_rctf_size_y(const struct rctf *rct)
Definition BLI_rect.hh:215
wmWindowManager * CTX_wm_manager(const bContext *C)
bool filelist_is_ready(const FileList *filelist)
Definition filelist.cc:1220
void ED_fileselect_ensure_default_filepath(bContext *C, wmOperator *op, const char *extension)
Definition filesel.cc:1515
void ED_fileselect_clear(wmWindowManager *wm, SpaceFile *sfile)
Definition filesel.cc:1335
int ED_fileselect_asset_import_method_get(const SpaceFile *sfile, const FileDirEntry *file)
Definition filesel.cc:531
@ FILE_ACTIVE_COLLECTION
@ FILE_PATH_TOKENS_ALLOW
void filelist_readjob_stop(FileList *filelist, wmWindowManager *wm)
void ED_fileselect_activate_by_relpath(SpaceFile *sfile, const char *relative_path)
Definition filesel.cc:621
static bool file_select_use_default_sort_type(const SpaceFile *sfile)
Definition filesel.cc:680
void file_params_renamefile_clear(FileSelectParams *params)
Definition filesel.cc:1423
@ FILE_ASSET_IMPORT_INSTANCE_COLLECTIONS_ON_LINK
bool BLI_path_extension_glob_validate(char *ext_fnmatch) ATTR_NONNULL(1)
static bool file_select_use_default_display_type(const SpaceFile *sfile)
Definition filesel.cc:672
void file_params_invoke_rename_postscroll(wmWindowManager *wm, wmWindow *win, SpaceFile *sfile)
Definition filesel.cc:1393
int filelist_files_ensure(FileList *filelist)
Definition filelist.cc:1235
void folderlist_pushdir(ListBaseT< FolderList > *folderlist, const char *dir)
FileAttributeColumnType
@ ATTRIBUTE_COLUMN_MAX
bool folderlist_clear_next(SpaceFile *sfile)
bool RNA_boolean_get(PointerRNA *ptr, const char *name)
int BLI_path_slash_ensure(char *path, size_t path_maxncpy) ATTR_NONNULL(1)
bool BLI_path_extension_replace(char *path, size_t path_maxncpy, const char *ext) ATTR_NONNULL(1
FileSelectParams * ED_fileselect_get_active_params(const SpaceFile *sfile)
Definition filesel.cc:393
void filelist_tag_reload_asset_library(FileList *filelist)
Definition filelist.cc:1215
void WM_event_fileselect_event(wmWindowManager *wm, void *ophandle, const int eventval)
void ED_fileselect_clear_main_assets(wmWindowManager *wm, SpaceFile *sfile)
Definition filesel.cc:1350
static void file_attribute_columns_widths(const FileSelectParams *params, FileLayout *layout)
Definition filesel.cc:1002
void folder_history_list_free(SpaceFile *sfile)
void ED_fileselect_layout_maskrect(const FileLayout *layout, const View2D *v2d, rcti *r_rect)
Definition filesel.cc:882
bool ED_fileselect_is_file_browser(const SpaceFile *sfile)
Definition filesel.cc:481
unsigned int filelist_entry_select_set(const FileList *filelist, const FileDirEntry *entry, FileSelType select, const eDirEntry_SelectFlag flag, FileCheckType check)
Definition filelist.cc:1987
static void on_reload_select_by_relpath(SpaceFile *sfile, onReloadFnData custom_data)
Definition filesel.cc:615
@ FILE_SHOW_ASSETS_FROM_CATALOG
void ED_fileselect_set_params_from_userdef(SpaceFile *sfile)
Definition filesel.cc:688
FileSelectParams * ED_fileselect_get_file_params(const SpaceFile *sfile)
Definition filesel.cc:411
float file_string_width(const char *str)
Definition filesel.cc:989
FileAssetSelectParams * ED_fileselect_get_asset_params(const SpaceFile *sfile)
Definition filesel.cc:416
void file_sfile_to_operator(bContext *C, Main *bmain, wmOperator *op, SpaceFile *sfile)
Definition file_ops.cc:1715
Main * CTX_data_main(const bContext *C)
int filelist_file_find_id(const FileList *filelist, const ID *id)
Definition filelist.cc:1374
BLI_INLINE float BLI_rctf_size_x(const struct rctf *rct)
Definition BLI_rect.hh:211
static void fileselect_refresh_asset_params(FileAssetSelectParams *asset_params)
Definition filesel.cc:430
void file_draw_check_ex(bContext *C, ScrArea *area)
Definition file_ops.cc:1769
static void fileselect_ensure_updated_asset_params(SpaceFile *sfile)
Definition filesel.cc:105
int2 WM_window_native_pixel_size(const wmWindow *win)
bool BLI_path_is_rel(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
asset_system::AssetLibrary * ED_fileselect_active_asset_library_get(const SpaceFile *sfile)
Definition filesel.cc:491
ID * filelist_file_get_id(const FileDirEntry *file)
Definition filelist.cc:1409
const char * BLT_lang_get()
Definition blt_lang.cc:268
MINLINE uint divide_ceil_u(uint a, uint b)
void BLI_path_split_dir_file(const char *filepath, char *dir, size_t dir_maxncpy, char *file, size_t file_maxncpy) ATTR_NONNULL(1
@ FILE_TYPE_BLENDER_BACKUP
bool filelist_entry_is_selected(FileList *filelist, int index)
Definition filelist.cc:2097
SpaceFile * CTX_wm_space_file(const bContext *C)
void filelist_tag_force_reset_mainfiles(FileList *filelist)
Definition filelist.cc:1207
void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, bool value)
void fileselect_file_set(bContext *C, SpaceFile *sfile, int index)
Definition filesel.cc:753
static bool is_inside(int x, int y, int cols, int rows)
Definition filesel.cc:796
void filelist_free(FileList *filelist)
Definition filelist.cc:1025
void WM_event_timer_remove(wmWindowManager *wm, wmWindow *, wmTimer *timer)
ID * ED_fileselect_active_asset_get(const SpaceFile *sfile)
Definition filesel.cc:500
bool BLI_rcti_isect_pt(const struct rcti *rect, int x, int y)
void file_on_reload_callback_register(SpaceFile *sfile, onReloadFn callback, onReloadFnData custom_data)
std::string RNA_string_get(PointerRNA *ptr, const char *name)
wmTimer * WM_event_timer_add(wmWindowManager *wm, wmWindow *win, const wmEventType event_type, const double time_step)
void filelist_entries_select_index_range_set(FileList *filelist, FileSelection *sel, FileSelType select, eDirEntry_SelectFlag flag, FileCheckType check)
Definition filelist.cc:2049
float file_font_pointsize()
Definition filesel.cc:996
struct stat BLI_stat_t
bool ED_fileselect_is_local_asset_library(const SpaceFile *sfile)
Definition filesel.cc:421
ScrArea * ED_fileselect_handler_area_find_any_with_op(const wmWindow *win)
Definition filesel.cc:1497
static void on_reload_activate_by_id(SpaceFile *sfile, onReloadFnData custom_data)
Definition filesel.cc:576
int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop)
bool file_attribute_column_type_enabled(const FileSelectParams *params, FileAttributeColumnType column, const FileLayout *layout)
Definition filesel.cc:931
void filelist_file_get_full_path(const FileList *filelist, const FileDirEntry *file, char r_filepath[1282])
void ED_fileselect_deselect_all(SpaceFile *sfile)
Definition filesel.cc:649
bScreen * WM_window_get_active_screen(const wmWindow *win)
const char * filelist_dir(const FileList *filelist)
Definition filelist.cc:1123
void WM_window_dpi_set_userdef(const wmWindow *win)
Definition wm_window.cc:737
bool ED_fileselect_layout_isect_rect(const FileLayout *layout, const View2D *v2d, const rcti *rect, rcti *r_dst)
Definition filesel.cc:895
void * onReloadFnData
void ED_fileselect_init_layout(SpaceFile *sfile, ARegion *region)
Definition filesel.cc:1069
const char * filelist_entry_get_relpath(const FileList *filelist, int index)
Definition filelist.cc:1414
bool filelist_pending(const FileList *filelist)
Definition filelist.cc:1225
const char * BKE_appdir_folder_default() ATTR_WARN_UNUSED_RESULT
Definition appdir.cc:139
void filelist_clear(FileList *filelist)
Definition filelist.cc:1006
void ED_fileselect_window_params_get(const wmWindow *win, int r_win_size[2], bool *r_is_maximized)
Definition filesel.cc:660
bool file_attribute_column_header_is_inside(const View2D *v2d, const FileLayout *layout, int x, int y)
Definition filesel.cc:921
void ED_fileselect_exit(wmWindowManager *wm, SpaceFile *sfile)
Definition filesel.cc:1367
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float
eFileSel_Params_AssetCatalogVisibility asset_catalog_visibility
AssetLibraryReference asset_library_ref
eFileAssetImportMethod import_method
eFileAssetImportFlags import_flags
asset_system::AssetRepresentation * asset
FileAttributeColumn attribute_columns[ATTRIBUTE_COLUMN_MAX]
unsigned short list_thumbnail_size
eFileSel_Params_RenameFlag rename_flag
eFileSel_Params_Flag flag
ListBaseT< SpaceLink > spacedata
eFileBrowse_Mode browse_mode
FileSelectParams * params
ListBaseT< struct FolderList > * folders_prev
ListBaseT< struct FolderList > * folders_next
struct wmOperator * op
struct wmTimer * smoothscroll_timer
struct FileLayout * layout
SpaceFile_Runtime * runtime
FileAssetSelectParams * asset_params
struct FileList * files
UserDef_FileSpaceData file_space_data
Universally Unique Identifier according to RFC4122.
struct wmOperatorType * type
char * d_name
uiFontStyle widget
#define N_(msgid)