Blender V5.3
filelist_readjob.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2007 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "BKE_context.hh"
10#include "BKE_main.hh"
11
12#include "BLI_listbase.hh"
13#include "BLI_string.hh"
14
15#include "WM_api.hh"
16#include "WM_types.hh"
17
18#include "../filelist.hh"
19#include "filelist_intern.hh"
20#include "filelist_readjob.hh"
21
22namespace blender {
23
24static void filelist_readjob_initjob(void *flrjv)
25{
26 FileListReadJob *flrj = static_cast<FileListReadJob *>(flrjv);
27 if (flrj->filelist->start_job_fn) {
28 flrj->filelist->start_job_fn(flrj);
29 }
30}
31
36{
37 return read_job->only_main_data;
38}
39
45static void filelist_readjob_startjob(void *flrjv, wmJobWorkerStatus *worker_status)
46{
47 FileListReadJob *flrj = static_cast<FileListReadJob *>(flrjv);
48
49 // printf("START filelist reading (%d files, main thread: %d)\n",
50 // flrj->filelist->filelist.entries_num, BLI_thread_is_main());
51
52 {
53 std::scoped_lock lock(flrj->lock);
54 BLI_assert((flrj->tmp_filelist == nullptr) && flrj->filelist);
55
56 flrj->tmp_filelist = MEM_dupalloc(flrj->filelist);
57
58 flrj->tmp_filelist->filelist.entries.clear_no_delete();
60
61 flrj->tmp_filelist->filelist_intern.filtered = nullptr;
62 flrj->tmp_filelist->filelist_intern.entries.clear_no_delete();
64 /* Don't unset the current UID on partial read, would give duplicates otherwise. */
65 }
66 else {
68 }
69
70 flrj->tmp_filelist->libfiledata = nullptr;
71 flrj->tmp_filelist->filelist_cache = nullptr;
72 flrj->tmp_filelist->selection_state = nullptr;
73 flrj->tmp_filelist->asset_library_ref = nullptr;
75 }
76
78 flrj, &worker_status->stop, &worker_status->do_update, &worker_status->progress);
79}
80
86static void filelist_readjob_update(void *flrjv)
87{
88 FileListReadJob *flrj = static_cast<FileListReadJob *>(flrjv);
89 FileListIntern *fl_intern = &flrj->filelist->filelist_intern;
90 ListBaseT<FileListInternEntry> new_entries = {nullptr};
91 int entries_num, new_entries_num = 0;
92
93 BLI_movelisttolist(&new_entries, &fl_intern->entries);
94 entries_num = flrj->filelist->filelist.entries_num;
95
96 {
97 std::scoped_lock lock(flrj->lock);
98 if (flrj->tmp_filelist->filelist.entries_num > 0) {
99 /* We just move everything out of 'thread context' into final list. */
100 new_entries_num = flrj->tmp_filelist->filelist.entries_num;
101 BLI_movelisttolist(&new_entries, &flrj->tmp_filelist->filelist.entries);
103 }
104
105 if (flrj->tmp_filelist->asset_library) {
107 }
108
109 /* Important for partial reads: Copy increased UID counter back to the real list. */
110 fl_intern->curr_uid = std::max(flrj->tmp_filelist->filelist_intern.curr_uid,
111 fl_intern->curr_uid);
112 }
113
114 if (new_entries_num) {
115 /* Do not clear selection cache, we can assume already 'selected' UIDs are still valid! Keep
116 * the asset library data we just read. */
117 filelist_clear_ex(flrj->filelist, false, true, false);
118
120
121 /* The job tagged these entries with the glob it started with. */
122 if (!STREQ(flrj->tmp_filelist->filter_glob, flrj->filelist->filter_glob)) {
124 }
125 }
126
127 /* if no new_entries_num, this is NOP */
128 BLI_movelisttolist(&fl_intern->entries, &new_entries);
129 flrj->filelist->filelist.entries_num = std::max(entries_num, 0) + new_entries_num;
130}
131
132static void filelist_readjob_timer_step(void *flrjv)
133{
134 FileListReadJob *flrj = static_cast<FileListReadJob *>(flrjv);
135
136 if (flrj->filelist->timer_step_fn) {
137 flrj->filelist->timer_step_fn(flrj);
138 }
139}
140
141static void filelist_readjob_endjob(void *flrjv)
142{
143 FileListReadJob *flrj = static_cast<FileListReadJob *>(flrjv);
144
145 /* In case there would be some dangling update... */
147
148 flrj->filelist->flags &= ~FL_IS_PENDING;
149 flrj->filelist->flags |= FL_IS_READY;
150
153}
154
155static void filelist_readjob_free(void *flrjv)
156{
157 FileListReadJob *flrj = static_cast<FileListReadJob *>(flrjv);
158
159 // printf("END filelist reading (%d files)\n", flrj->filelist->filelist.entries_num);
160
161 if (flrj->tmp_filelist) {
162 /* tmp_filelist shall never ever be filtered! */
164 BLI_assert(flrj->tmp_filelist->filelist.entries.is_empty());
165
168 }
169
170 MEM_delete(flrj);
171}
172
174{
176 BLI_assert(filelist->asset_library_ref != nullptr);
178 }
179 if (filelist->asset_library_ref) {
181 }
183}
184
185/* TODO(Julian): This is temporary, because currently the job system identifies jobs to suspend by
186 * the startjob callback, rather than the type. See PR #123033. */
187static void assetlibrary_readjob_startjob(void *flrjv, wmJobWorkerStatus *worker_status)
188{
189 filelist_readjob_startjob(flrjv, worker_status);
190}
191
193 const int space_notifier,
194 const bContext *C,
195 const bool force_blocking_read)
196{
197 Main *bmain = CTX_data_main(C);
198 wmJob *wm_job;
199 FileListReadJob *flrj;
200
201 if (!filelist_is_dir(filelist, filelist->filelist.root)) {
202 return;
203 }
204
205 /* prepare job data */
206 flrj = MEM_new<FileListReadJob>(__func__);
207 flrj->filelist = filelist;
208 flrj->current_main = bmain;
209 flrj->wm = CTX_wm_manager(C);
211 if ((filelist->flags & FL_FORCE_RESET_MAIN_FILES) && !(filelist->flags & FL_FORCE_RESET) &&
213 {
214 flrj->only_main_data = true;
215 }
216 if (filelist->flags & FL_RELOAD_ASSET_LIBRARY) {
217 flrj->reload_asset_library = true;
218 }
221
224 filelist->flags |= FL_IS_PENDING;
225
226 /* The file list type may not support threading so execute immediately. Same when only rereading
227 * #Main data (which we do quite often on changes to #Main, since it's the easiest and safest way
228 * to ensure the displayed data is up to date), because some operations executing right after
229 * main data changed may need access to the ID files (see #93691). */
230 const bool no_threads = (filelist->tags & FILELIST_TAGS_NO_THREADS) || flrj->only_main_data;
231
232 if (force_blocking_read || no_threads) {
233 /* Single threaded execution. Just directly call the callbacks. */
234 wmJobWorkerStatus worker_status = {};
235 filelist_readjob_startjob(flrj, &worker_status);
238
239 WM_event_add_notifier(C, space_notifier | NA_JOB_FINISHED, nullptr);
240 return;
241 }
242
243 /* setup job */
244 wm_job = WM_jobs_get(CTX_wm_manager(C),
246 filelist,
247 filelist->asset_library_ref ? "Loading Asset Library..." :
248 "Listing directories...",
250 filelist_jobtype_get(filelist));
253 wm_job, 0.01, space_notifier, space_notifier | NA_JOB_FINISHED, filelist_readjob_timer_step);
254 WM_jobs_callbacks(wm_job,
260
261 /* start the job */
263}
264
265void filelist_readjob_start(FileList *filelist, const int space_notifier, const bContext *C)
266{
267 filelist_readjob_start_ex(filelist, space_notifier, C, false);
268}
269
270void filelist_readjob_blocking_run(FileList *filelist, int space_notifier, const bContext *C)
271{
272 filelist_readjob_start_ex(filelist, space_notifier, C, true);
273}
274
279
281{
282 return WM_jobs_has_running(wm, filelist, filelist_jobtype_get(filelist));
283}
284
285} // namespace blender
#define C
Definition RandGen.cpp:29
#define NA_JOB_FINISHED
Definition WM_types.hh:642
volatile int lock
#define STREQ(a, b)
#define FILEDIR_NBR_ENTRIES_UNSET
BMesh Iterators.
static void filelist_readjob_free(void *flrjv)
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
int filelist_readjob_running(FileList *filelist, wmWindowManager *wm)
char * STRNCPY(char(&dst)[N], const char *src)
void WM_jobs_kill_all_from_owner(wmWindowManager *wm, const void *owner)
Definition wm_jobs.cc:657
@ RPT_WARNING
Definition BKE_report.hh:40
void filelist_freelib(FileList *filelist)
Definition filelist.cc:1055
void WM_jobs_callbacks(wmJob *wm_job, wm_jobs_start_callback startjob, void(*initjob)(void *), void(*update)(void *), void(*endjob)(void *))
Definition wm_jobs.cc:407
static void filelist_readjob_endjob(void *flrjv)
void filelist_uid_unset(FileUID *r_uid)
Definition filelist.cc:1437
void BKE_reports_free(ReportList *reports)
Definition report.cc:106
void BKE_report_print_level_set(ReportList *reports, eReportType level)
Definition report.cc:276
bool filelist_is_dir(const FileList *filelist, const char *path)
Definition filelist.cc:1128
@ FL_RELOAD_ASSET_LIBRARY
@ FL_FORCE_RESET_MAIN_FILES
static bool filelist_readjob_is_partial_read(const FileListReadJob *read_job)
void BKE_reports_init(ReportList *reports, int flag)
Definition report.cc:91
@ WM_JOB_TYPE_ASSET_LIBRARY_LOAD
Definition WM_api.hh:2020
@ WM_JOB_TYPE_ASSET_LIBRARY_GLOBAL_LISTING_LOAD
Definition WM_api.hh:2027
@ WM_JOB_TYPE_FILESEL_READDIR
Definition WM_api.hh:2019
static void filelist_readjob_startjob(void *flrjv, wmJobWorkerStatus *worker_status)
void void void BLI_movelisttolist(ListBase *dst, ListBase *src) ATTR_NONNULL(1
Definition listbase.cc:32
static void filelist_readjob_start_ex(FileList *filelist, const int space_notifier, const bContext *C, const bool force_blocking_read)
wmWindow * CTX_wm_window(const bContext *C)
static void filelist_readjob_initjob(void *flrjv)
void WM_jobs_customdata_set(wmJob *wm_job, void *customdata, void(*free)(void *customdata))
Definition wm_jobs.cc:377
void filelist_clear_ex(FileList *filelist, bool do_asset_library, bool do_cache, bool do_selection)
Definition filelist.cc:942
@ WM_JOB_PROGRESS
Definition WM_api.hh:1997
static void filelist_readjob_timer_step(void *flrjv)
static eWM_JobType filelist_jobtype_get(const FileList *filelist)
void WM_jobs_start(wmWindowManager *wm, wmJob *wm_job)
Definition wm_jobs.cc:498
const char * BKE_main_blendfile_path(const Main *bmain) ATTR_NONNULL()
Definition main.cc:1058
void filelist_readjob_blocking_run(FileList *filelist, int space_notifier, const bContext *C)
bool WM_jobs_has_running(const wmWindowManager *window_manager, const void *owner, const eWM_JobType type, const eWM_JobFlag exclude_flags)
Definition wm_jobs.cc:809
wmWindowManager * CTX_wm_manager(const bContext *C)
void filelist_readjob_stop(FileList *filelist, wmWindowManager *wm)
void WM_event_add_notifier(const bContext *C, uint type, void *reference)
@ FILELIST_TAGS_FROM_GLOBAL_ASSET_LIST
@ FILELIST_TAGS_NO_THREADS
void filelist_readjob_start(FileList *filelist, int space_notifier, const bContext *C)
static void assetlibrary_readjob_startjob(void *flrjv, wmJobWorkerStatus *worker_status)
Main * CTX_data_main(const bContext *C)
void WM_reports_from_reports_move(wmWindowManager *wm, ReportList *reports)
wmJob * WM_jobs_get(wmWindowManager *wm, wmWindow *win, const void *owner, const char *name, const eWM_JobFlag flag, const eWM_JobType job_type)
Definition wm_jobs.cc:228
static void filelist_readjob_update(void *flrjv)
void filelist_free(FileList *filelist)
Definition filelist.cc:1025
void WM_jobs_timer(wmJob *wm_job, double time_step, uint note, uint endnote, void(*timer_step)(void *))
Definition wm_jobs.cc:393
ListBaseT< struct FileListInternEntry > entries
ed::asset_browser::AssetCatalogFilterSettings * asset_catalog_filter
ListBaseT< FileListInternEntry > entries
FileListInternEntry ** filtered
std::atomic< bool > reload_asset_library
void(*) timer_step_fn(FileListReadJob *job_params)
void(*) start_job_fn(FileListReadJob *job_params)
AssetLibraryReference * asset_library_ref
void(*) read_job_fn(FileListReadJob *job_params, bool *stop, bool *do_update, float *progress)
FileListEntryCache * filelist_cache
FileDirEntryArr filelist
FileListFilter filter_data
BlendHandle * libfiledata
char filter_glob[FILE_MAXFILE]
FileListIntern filelist_intern
asset_system::AssetLibrary * asset_library