Blender V5.3
filelist.hh
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#pragma once
10
11#include <cstddef>
12#include <cstdint>
13
14#include "DNA_space_types.h"
15struct BlendHandle;
16namespace blender {
17
19struct bContext;
20struct FileIndexerType;
21struct FileList;
22struct FileSelection;
23struct ID;
24struct ImBuf;
25struct bUUID;
26struct wmWindowManager;
27namespace asset_system {
28class AssetLibrary;
30} // namespace asset_system
31
32struct FileDirEntry;
33
35
41
47
48void filelist_setsorting(FileList *filelist, short sort, bool invert_sort);
49void filelist_sort(FileList *filelist);
50
51void filelist_setfilter_options(FileList *filelist,
52 bool do_filter,
53 bool hide_dot,
54 bool hide_parent,
55 uint64_t filter,
56 uint64_t filter_id,
57 bool filter_assets_only,
58 bool filter_assets_hide_online,
59 bool filter_assets_hide_offline,
60 const char *filter_search);
66void filelist_setindexer(FileList *filelist, const FileIndexerType *indexer);
68 const FileList *filelist, StringRef remote_url, StringRef absolute_downloaded_file);
69void filelist_set_asset_include_online(FileList *filelist, bool show_online_assets);
75 FileList *filelist,
77 const bUUID *catalog_id);
80void filelist_filter(FileList *filelist);
86void filelist_setlibrary(FileList *filelist,
87 const AssetLibraryReference *asset_library_ref,
88 FunctionRef<void()> on_change = nullptr);
89
93 const FileDirEntry *file,
94 char r_filepath[/*FILE_MAX_LIBEXTRA*/ 1282]);
95bool filelist_file_is_preview_pending(const FileList *filelist, const FileDirEntry *file);
104int filelist_geticon_file_type(FileList *filelist, int index, bool is_main);
105
111FileList *filelist_new(short type, bool is_from_global_asset_list = false);
112void filelist_settype(FileList *filelist, short type);
113void filelist_clear(FileList *filelist);
114void filelist_clear_ex(FileList *filelist,
115 bool do_asset_library,
116 bool do_cache,
117 bool do_selection);
123void filelist_free(FileList *filelist);
124
129const char *filelist_dir(const FileList *filelist);
130bool filelist_is_dir(const FileList *filelist, const char *path);
134void filelist_setdir(FileList *filelist, char dirpath[/*FILE_MAX_LIBEXTRA*/ 1282]);
135
142int filelist_files_ensure(FileList *filelist);
143int filelist_needs_reading(const FileList *filelist);
155FileDirEntry *filelist_file_ex(FileList *filelist, int index, bool use_request);
156
161int filelist_file_find_path(FileList *filelist, const char *filename);
166int filelist_file_find_id(const FileList *filelist, const ID *id);
174ID *filelist_entry_get_id(const FileList *filelist, int index);
176 const FileList *filelist, const int index);
181const char *filelist_entry_get_relpath(const FileList *filelist, int index);
182bool filelist_uid_is_set(const FileUID uid);
183void filelist_uid_unset(FileUID *r_uid);
184void filelist_file_cache_slidingwindow_set(FileList *filelist, size_t window_size);
188bool filelist_file_cache_block(FileList *filelist, int index);
189
190bool filelist_needs_force_reset(const FileList *filelist);
191void filelist_tag_force_reset(FileList *filelist);
194bool filelist_pending(const FileList *filelist);
196bool filelist_is_ready(const FileList *filelist);
197
198unsigned int filelist_entry_select_set(const FileList *filelist,
199 const FileDirEntry *entry,
201 const eDirEntry_SelectFlag flag,
202 FileCheckType check);
204 int index,
207 FileCheckType check);
209 FileSelection *sel,
212 FileCheckType check);
214 FileDirEntry *entry,
215 FileCheckType check);
217 int index,
218 FileCheckType check);
219bool filelist_entry_is_selected(FileList *filelist, int index);
226 FileCheckType check);
227
228void filelist_setrecursion(FileList *filelist, int recursion_level);
230void filelist_setglob(FileList *filelist, const char *filter_glob);
231
233
234BlendHandle *filelist_lib(FileList *filelist);
238bool filelist_islibrary(FileList *filelist, char *dir, char **r_group);
239void filelist_freelib(FileList *filelist);
240
246
248void filelist_readjob_blocking_run(FileList *filelist, int space_notifier, const bContext *C);
249
251void filelist_readjob_start(FileList *filelist, int space_notifier, const bContext *C);
254
256void filelist_cache_previews_set(FileList *filelist, bool use_previews);
259
260} // namespace blender
#define C
Definition RandGen.cpp:29
unsigned long long int uint64_t
static DBVT_INLINE btDbvtNode * sort(btDbvtNode *n, btDbvtNode *&r)
Definition btDbvt.cpp:418
std::string filename(const std::string_view &str, size_t pos)
BMesh Iterators.
eDirEntry_SelectFlag filelist_entry_select_index_get(FileList *filelist, int index, FileCheckType check)
Definition filelist.cc:2084
int filelist_readjob_running(FileList *filelist, wmWindowManager *wm)
int filelist_file_find_path(FileList *filelist, const char *filename)
Definition filelist.cc:1354
void filelist_settype(FileList *filelist, short type)
Definition filelist.cc:892
void filelist_freelib(FileList *filelist)
Definition filelist.cc:1055
void filelist_tag_needs_filtering(FileList *filelist)
bool filelist_cache_previews_update(FileList *filelist)
Definition filelist.cc:1743
void filelist_uid_unset(FileUID *r_uid)
Definition filelist.cc:1437
void filelist_init_icons()
ImBuf * filelist_file_get_preview_image(const FileDirEntry *file)
Definition filelist.cc:284
bool filelist_is_dir(const FileList *filelist, const char *path)
Definition filelist.cc:1128
ImBuf * filelist_geticon_special_file_image(FileList *filelist, int index)
Definition filelist.cc:319
void filelist_entry_parent_select_set(FileList *filelist, FileSelType select, eDirEntry_SelectFlag flag, FileCheckType check)
Definition filelist.cc:2110
bool filelist_uid_is_set(const FileUID uid)
Definition filelist.cc:1430
void filelist_online_asset_preview_request(const bContext *C, FileDirEntry *entry)
Definition filelist.cc:722
void filelist_setrecursion(FileList *filelist, int recursion_level)
Definition filelist.cc:1150
void filelist_set_asset_include_online(FileList *filelist, bool show_online_assets)
Definition filelist.cc:139
@ FILE_SEL_TOGGLE
Definition filelist.hh:39
@ FILE_SEL_REMOVE
Definition filelist.hh:37
@ FILE_SEL_ADD
Definition filelist.hh:38
void filelist_clear_ex(FileList *filelist, bool do_asset_library, bool do_cache, bool do_selection)
Definition filelist.cc:942
void filelist_set_asset_catalog_filter_options(FileList *filelist, eFileSel_Params_AssetCatalogVisibility catalog_visibility, const bUUID *catalog_id)
Definition filelist.cc:163
void filelist_setsorting(FileList *filelist, short sort, bool invert_sort)
void filelist_setdir(FileList *filelist, char dirpath[1282])
void filelist_clear_from_reset_tag(FileList *filelist)
Definition filelist.cc:1011
int filelist_geticon_file_type(FileList *filelist, int index, bool is_main)
Definition filelist.cc:439
asset_system::AssetLibrary * filelist_asset_library(FileList *filelist)
Definition filelist.cc:1050
eDirEntry_SelectFlag filelist_entry_select_get(FileList *filelist, FileDirEntry *entry, FileCheckType check)
Definition filelist.cc:2066
void filelist_setglob(FileList *filelist, const char *filter_glob)
Definition filelist.cc:1185
asset_system::AssetRepresentation * filelist_entry_get_asset_representation(const FileList *filelist, const int index)
Definition filelist.cc:1402
void filelist_setfilter_options(FileList *filelist, bool do_filter, bool hide_dot, bool hide_parent, uint64_t filter, uint64_t filter_id, bool filter_assets_only, bool filter_assets_hide_online, bool filter_assets_hide_offline, const char *filter_search)
FileList * filelist_new(short type, bool is_from_global_asset_list=false)
Definition filelist.cc:876
void filelist_free_icons()
Definition filelist.cc:237
uint32_t FileUID
Definition filelist.hh:34
unsigned int uint32_t
Definition BKE_text.h:81
FileDirEntry * filelist_file_ex(FileList *filelist, int index, bool use_request)
Definition filelist.cc:1307
FileDirEntry * filelist_file(FileList *filelist, int index)
Definition filelist.cc:1349
bool filelist_cache_previews_done(FileList *filelist)
Definition filelist.cc:1812
void filelist_readjob_blocking_run(FileList *filelist, int space_notifier, const bContext *C)
void filelist_setindexer(FileList *filelist, const FileIndexerType *indexer)
Definition filelist.cc:131
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
FileCheckType
Definition filelist.hh:42
@ CHECK_ALL
Definition filelist.hh:45
@ CHECK_DIRS
Definition filelist.hh:43
@ CHECK_FILES
Definition filelist.hh:44
ImBuf * filelist_geticon_special_file_image_ex(const FileDirEntry *file)
Definition filelist.cc:300
bool filelist_islibrary(FileList *filelist, char *dir, char **r_group)
Definition filelist.cc:2120
int filelist_needs_reading(const FileList *filelist)
Definition filelist.cc:1981
bool filelist_file_cache_block(FileList *filelist, int index)
Definition filelist.cc:1502
bool filelist_is_ready(const FileList *filelist)
Definition filelist.cc:1220
void filelist_tag_force_reset(FileList *filelist)
Definition filelist.cc:1202
void filelist_readjob_stop(FileList *filelist, wmWindowManager *wm)
void filelist_setlibrary(FileList *filelist, const AssetLibraryReference *asset_library_ref, FunctionRef< void()> on_change=nullptr)
Definition filelist.cc:203
void filelist_remote_asset_library_refresh_online_assets_status(const FileList *filelist, StringRef remote_url, StringRef absolute_downloaded_file)
BlendHandle * filelist_lib(FileList *filelist)
Definition filelist.cc:1063
int filelist_files_ensure(FileList *filelist)
Definition filelist.cc:1235
bool filelist_needs_reset_on_main_changes(const FileList *filelist)
Definition filelist.cc:1230
void filelist_tag_reload_asset_library(FileList *filelist)
Definition filelist.cc:1215
void filelist_readjob_start(FileList *filelist, int space_notifier, const bContext *C)
unsigned int filelist_entry_select_set(const FileList *filelist, const FileDirEntry *entry, FileSelType select, const eDirEntry_SelectFlag flag, FileCheckType check)
Definition filelist.cc:1987
eFileSel_Params_AssetCatalogVisibility
void filelist_filter(FileList *filelist)
void filelist_sort(FileList *filelist)
bool filelist_file_is_preview_pending(const FileList *filelist, const FileDirEntry *file)
Definition filelist.cc:261
int filelist_file_find_id(const FileList *filelist, const ID *id)
Definition filelist.cc:1374
bool filelist_cache_previews_running(FileList *filelist)
Definition filelist.cc:1805
ID * filelist_file_get_id(const FileDirEntry *file)
Definition filelist.cc:1409
void filelist_file_cache_slidingwindow_set(FileList *filelist, size_t window_size)
Definition filelist.cc:1442
bool filelist_entry_is_selected(FileList *filelist, int index)
Definition filelist.cc:2097
void filelist_tag_force_reset_mainfiles(FileList *filelist)
Definition filelist.cc:1207
void filelist_free(FileList *filelist)
Definition filelist.cc:1025
void filelist_entries_select_index_range_set(FileList *filelist, FileSelection *sel, FileSelType select, eDirEntry_SelectFlag flag, FileCheckType check)
Definition filelist.cc:2049
void filelist_cache_previews_set(FileList *filelist, bool use_previews)
Definition filelist.cc:1718
void filelist_file_get_full_path(const FileList *filelist, const FileDirEntry *file, char r_filepath[1282])
const char * filelist_dir(const FileList *filelist)
Definition filelist.cc:1123
int filelist_files_num_entries(FileList *filelist)
Definition filelist.cc:1068
ID * filelist_entry_get_id(const FileList *filelist, int index)
Definition filelist.cc:1396
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
void filelist_clear(FileList *filelist)
Definition filelist.cc:1006
bool filelist_needs_filtering(FileList *filelist)
Universally Unique Identifier according to RFC4122.