Blender V5.0
filelist.cc File Reference
#include <algorithm>
#include <cstdlib>
#include <cstring>
#include <ctime>
#include <memory>
#include <optional>
#include <sys/stat.h>
#include <unistd.h>
#include "AS_asset_library.hh"
#include "AS_asset_representation.hh"
#include "MEM_guardedalloc.h"
#include "BLF_api.hh"
#include "BLI_fileops.h"
#include "BLI_fileops_types.h"
#include "BLI_ghash.h"
#include "BLI_linklist.h"
#include "BLI_listbase.h"
#include "BLI_math_vector.h"
#include "BLI_path_utils.hh"
#include "BLI_stack.h"
#include "BLI_string.h"
#include "BLI_string_utils.hh"
#include "BLI_task.h"
#include "BLI_threads.h"
#include "BLI_utildefines.h"
#include "BKE_asset.hh"
#include "BKE_blendfile.hh"
#include "BKE_context.hh"
#include "BKE_global.hh"
#include "BKE_icons.h"
#include "BKE_idtype.hh"
#include "BKE_main.hh"
#include "BKE_preferences.h"
#include "BKE_preview_image.hh"
#include "DNA_asset_types.h"
#include "DNA_space_types.h"
#include "DNA_userdef_types.h"
#include "ED_fileselect.hh"
#include "IMB_imbuf.hh"
#include "IMB_imbuf_types.hh"
#include "IMB_thumbs.hh"
#include "MOV_util.hh"
#include "WM_api.hh"
#include "WM_types.hh"
#include "UI_interface_icons.hh"
#include "UI_resources.hh"
#include "atomic_ops.h"
#include "../file_indexer.hh"
#include "../file_intern.hh"
#include "../filelist.hh"
#include "filelist_intern.hh"

Go to the source code of this file.

Classes

struct  TodoDir
struct  FileListReadJob
struct  FileIndexer

Macros

#define FILE_UID_UNSET   0

Enumerations

enum  ListLibOptions { LIST_LIB_OPTION_NONE = 0 , LIST_LIB_RECURSIVE = (1 << 0) , LIST_LIB_ASSETS_ONLY = (1 << 1) , LIST_LIB_ADD_PARENT = (1 << 2) }

Functions

static void filelist_readjob_main (FileListReadJob *job_params, bool *stop, bool *do_update, float *progress)
static void filelist_readjob_lib (FileListReadJob *job_params, bool *stop, bool *do_update, float *progress)
static void filelist_readjob_dir (FileListReadJob *job_params, bool *stop, bool *do_update, float *progress)
static void filelist_readjob_asset_library (FileListReadJob *job_params, bool *stop, bool *do_update, float *progress)
static void filelist_readjob_main_assets (FileListReadJob *job_params, bool *stop, bool *do_update, float *progress)
static void filelist_readjob_all_asset_library (FileListReadJob *job_params, bool *stop, bool *do_update, float *progress)
static int groupname_to_code (const char *group)
void filelist_setindexer (FileList *filelist, const FileIndexerType *indexer)
void filelist_set_asset_catalog_filter_options (FileList *filelist, eFileSel_Params_AssetCatalogVisibility catalog_visibility, const ::bUUID *catalog_id)
static bool filelist_compare_asset_libraries (const AssetLibraryReference *library_a, const AssetLibraryReference *library_b)
void filelist_setlibrary (FileList *filelist, const AssetLibraryReference *asset_library_ref)
void filelist_free_icons ()
void filelist_file_get_full_path (const FileList *filelist, const FileDirEntry *file, char r_filepath[FILE_MAX_LIBEXTRA])
bool filelist_file_is_preview_pending (const FileList *filelist, const FileDirEntry *file)
static FileDirEntryfilelist_geticon_get_file (FileList *filelist, const int index)
ImBuffilelist_get_preview_image (FileList *filelist, const int index)
ImBuffilelist_file_get_preview_image (const FileDirEntry *file)
static ImBuffilelist_ensure_special_file_image (SpecialFileImages image, int icon)
ImBuffilelist_geticon_special_file_image_ex (const FileDirEntry *file)
ImBuffilelist_geticon_special_file_image (FileList *filelist, const int index)
static int filelist_geticon_file_type_ex (const FileList *filelist, const FileDirEntry *file, const bool is_main, const bool ignore_libdir)
int filelist_geticon_file_type (FileList *filelist, const int index, const bool is_main)
int ED_file_icon (const FileDirEntry *file)
bool filelist_intern_entry_is_main_file (const FileListInternEntry *intern_entry)
static void parent_dir_until_exists_or_default_root (char *dir)
static bool filelist_checkdir_dir (const FileList *, char dirpath[FILE_MAX_LIBEXTRA], const bool do_change)
static bool filelist_checkdir_lib (const FileList *, char dirpath[FILE_MAX_LIBEXTRA], const bool do_change)
static bool filelist_checkdir_main (const FileList *filelist, char dirpath[FILE_MAX_LIBEXTRA], const bool do_change)
static bool filelist_checkdir_return_always_valid (const FileList *, char[FILE_MAX_LIBEXTRA], const bool)
static void filelist_entry_clear (FileDirEntry *entry)
static void filelist_entry_free (FileDirEntry *entry)
static void filelist_direntryarr_free (FileDirEntryArr *array)
static void filelist_intern_entry_free (FileList *filelist, FileListInternEntry *entry)
static void filelist_intern_free (FileList *filelist)
static int filelist_intern_free_main_files (FileList *filelist)
static void filelist_cache_preview_runf (TaskPool *__restrict pool, void *taskdata)
static void filelist_cache_preview_freef (TaskPool *__restrict, void *taskdata)
static void filelist_cache_preview_ensure_running (FileListEntryCache *cache)
static void filelist_cache_previews_clear (FileListEntryCache *cache)
static void filelist_cache_previews_free (FileListEntryCache *cache)
static bool filelist_file_preview_load_poll (const FileDirEntry *entry)
static bool filelist_cache_previews_push (FileList *filelist, FileDirEntry *entry, const int index)
void filelist_cache_clear (FileListEntryCache *cache, size_t new_size)
FileListfilelist_new (short type)
void filelist_settype (FileList *filelist, short type)
static void filelist_clear_asset_library (FileList *filelist)
void filelist_clear_ex (FileList *filelist, const bool do_asset_library, const bool do_cache, const bool do_selection)
static void filelist_clear_main_files (FileList *filelist, const bool do_asset_library, const bool do_cache, const bool do_selection)
void filelist_clear (FileList *filelist)
void filelist_clear_from_reset_tag (FileList *filelist)
void filelist_free (FileList *filelist)
blender::asset_system::AssetLibraryfilelist_asset_library (FileList *filelist)
void filelist_freelib (FileList *filelist)
BlendHandle * filelist_lib (FileList *filelist)
int filelist_files_num_entries (FileList *filelist)
static const char * fileentry_uiname (const char *root, FileListInternEntry *entry, char *buff)
const char * filelist_dir (const FileList *filelist)
bool filelist_is_dir (const FileList *filelist, const char *path)
void filelist_setdir (FileList *filelist, char dirpath[FILE_MAX_LIBEXTRA])
void filelist_setrecursion (FileList *filelist, const int recursion_level)
bool filelist_needs_force_reset (const FileList *filelist)
void filelist_tag_force_reset (FileList *filelist)
void filelist_tag_force_reset_mainfiles (FileList *filelist)
void filelist_tag_reload_asset_library (FileList *filelist)
bool filelist_is_ready (const FileList *filelist)
bool filelist_pending (const FileList *filelist)
bool filelist_needs_reset_on_main_changes (const FileList *filelist)
int filelist_files_ensure (FileList *filelist)
static FileDirEntryfilelist_file_create_entry (FileList *filelist, const int index)
static void filelist_file_release_entry (FileList *filelist, FileDirEntry *entry)
static FileDirEntryfilelist_cache_file_lookup (FileListEntryCache *cache, const int index)
FileDirEntryfilelist_file_ex (FileList *filelist, const int index, const bool use_request)
FileDirEntryfilelist_file (FileList *filelist, int index)
int filelist_file_find_path (FileList *filelist, const char *filename)
int filelist_file_find_id (const FileList *filelist, const ID *id)
static FileListInternEntryfilelist_entry_intern_get (const FileList *filelist, const int index)
IDfilelist_entry_get_id (const FileList *filelist, const int index)
asset_system::AssetRepresentationfilelist_entry_get_asset_representation (const FileList *filelist, const int index)
IDfilelist_file_get_id (const FileDirEntry *file)
const char * filelist_entry_get_relpath (const FileList *filelist, int index)
static FileUID filelist_uid_generate (FileList *filelist)
bool filelist_uid_is_set (const FileUID uid)
void filelist_uid_unset (FileUID *r_uid)
void filelist_file_cache_slidingwindow_set (FileList *filelist, size_t window_size)
static bool filelist_file_cache_block_create (FileList *filelist, const int start_index, const int size, int cursor)
static void filelist_file_cache_block_release (FileList *filelist, const int size, int cursor)
bool filelist_file_cache_block (FileList *filelist, const int index)
void filelist_cache_previews_set (FileList *filelist, const bool use_previews)
bool filelist_cache_previews_update (FileList *filelist)
bool filelist_cache_previews_running (FileList *filelist)
bool filelist_cache_previews_done (FileList *filelist)
static bool file_is_blend_backup (const char *str)
int ED_path_extension_type (const char *path)
int ED_file_extension_icon (const char *path)
int filelist_needs_reading (const FileList *filelist)
uint filelist_entry_select_set (const FileList *filelist, const FileDirEntry *entry, FileSelType select, const eDirEntry_SelectFlag flag, FileCheckType check)
void filelist_entry_select_index_set (FileList *filelist, const int index, FileSelType select, const eDirEntry_SelectFlag flag, FileCheckType check)
void filelist_entries_select_index_range_set (FileList *filelist, FileSelection *sel, FileSelType select, const eDirEntry_SelectFlag flag, FileCheckType check)
eDirEntry_SelectFlag filelist_entry_select_get (FileList *filelist, FileDirEntry *entry, FileCheckType check)
eDirEntry_SelectFlag filelist_entry_select_index_get (FileList *filelist, const int index, FileCheckType check)
bool filelist_entry_is_selected (FileList *filelist, const int index)
void filelist_entry_parent_select_set (FileList *filelist, FileSelType select, const eDirEntry_SelectFlag flag, FileCheckType check)
bool filelist_islibrary (FileList *filelist, char *dir, char **r_group)
static char * current_relpath_append (const FileListReadJob *job_params, const char *filename)
static int filelist_readjob_list_dir (FileListReadJob *job_params, const char *root, ListBase *entries, const char *filter_glob, const bool do_lib, const char *main_filepath, const bool skip_currpar)
 ENUM_OPERATORS (ListLibOptions, LIST_LIB_ADD_PARENT)
static FileListInternEntryfilelist_readjob_list_lib_group_create (const FileListReadJob *job_params, const int idcode, const char *group_name)
static void filelist_readjob_list_lib_add_datablock (FileListReadJob *job_params, ListBase *entries, BLODataBlockInfo *datablock_info, const bool prefix_relpath_with_group_name, const int idcode, const char *group_name)
static void filelist_readjob_list_lib_add_datablocks (FileListReadJob *job_params, ListBase *entries, LinkNode *datablock_infos, const bool prefix_relpath_with_group_name, const int idcode, const char *group_name)
static void filelist_readjob_list_lib_add_from_indexer_entries (FileListReadJob *job_params, ListBase *entries, const FileIndexerEntries *indexer_entries, const bool prefix_relpath_with_group_name)
static FileListInternEntryfilelist_readjob_list_lib_navigate_to_parent_entry_create (const FileListReadJob *job_params)
static int filelist_readjob_list_lib_populate_from_index (FileListReadJob *job_params, ListBase *entries, const ListLibOptions options, const int read_from_index, const FileIndexerEntries *indexer_entries)
static std::optional< int > filelist_readjob_list_lib (FileListReadJob *job_params, const char *root, ListBase *entries, const ListLibOptions options, FileIndexer *indexer_runtime)
static bool filelist_readjob_append_entries (FileListReadJob *job_params, ListBase *from_entries, int from_entries_num)
static bool filelist_readjob_should_recurse_into_entry (const int max_recursion, const bool is_lib, const int current_recursion_level, FileListInternEntry *entry)
static void filelist_readjob_recursive_dir_add_items (const bool do_lib, FileListReadJob *job_params, const bool *stop, bool *do_update, float *progress)
static void filelist_readjob_do (const bool do_lib, FileListReadJob *job_params, const bool *stop, bool *do_update, float *progress)
static void filelist_readjob_load_asset_library_data (FileListReadJob *job_params, bool *do_update)
static void filelist_readjob_main_assets_add_items (FileListReadJob *job_params, bool *, bool *do_update, float *)
static bool filelist_contains_main (const FileList *filelist, const Main *bmain)
static bool filelist_readjob_is_partial_read (const FileListReadJob *read_job)
static void filelist_readjob_startjob (void *flrjv, wmJobWorkerStatus *worker_status)
static void filelist_readjob_update (void *flrjv)
static void filelist_readjob_endjob (void *flrjv)
static void filelist_readjob_free (void *flrjv)
static eWM_JobType filelist_jobtype_get (const FileList *filelist)
static void assetlibrary_readjob_startjob (void *flrjv, wmJobWorkerStatus *worker_status)
static void filelist_readjob_start_ex (FileList *filelist, const int space_notifier, const bContext *C, const bool force_blocking_read)
void filelist_readjob_start (FileList *filelist, const int space_notifier, const bContext *C)
void filelist_readjob_blocking_run (FileList *filelist, int space_notifier, const bContext *C)
void filelist_readjob_stop (FileList *filelist, wmWindowManager *wm)
int filelist_readjob_running (FileList *filelist, wmWindowManager *wm)

Variables

static ImBufgSpecialFileImages [int(SpecialFileImages::_Max)]

Macro Definition Documentation

◆ FILE_UID_UNSET

#define FILE_UID_UNSET   0

Definition at line 1356 of file filelist.cc.

Referenced by filelist_uid_unset().

Enumeration Type Documentation

◆ ListLibOptions

Enumerator
LIST_LIB_OPTION_NONE 
LIST_LIB_RECURSIVE 
LIST_LIB_ASSETS_ONLY 
LIST_LIB_ADD_PARENT 

Definition at line 2242 of file filelist.cc.

Function Documentation

◆ assetlibrary_readjob_startjob()

void assetlibrary_readjob_startjob ( void * flrjv,
wmJobWorkerStatus * worker_status )
static

Definition at line 3273 of file filelist.cc.

References filelist_readjob_startjob().

Referenced by filelist_readjob_start_ex().

◆ current_relpath_append()

char * current_relpath_append ( const FileListReadJob * job_params,
const char * filename )
static

Append filename (or even a path inside of a .blend, like Material/Material.001), to the current relative path being read within the filelist root. The returned string needs freeing with MEM_freeN().

Definition at line 2122 of file filelist.cc.

References ALTSEP, BLI_assert, BLI_path_is_rel(), BLI_strdup(), BLI_string_join, FileListReadJob::cur_relbase, ELEM, FILE_MAX_LIBEXTRA, and SEP.

Referenced by filelist_readjob_list_dir(), filelist_readjob_list_lib_add_datablock(), filelist_readjob_list_lib_group_create(), filelist_readjob_list_lib_navigate_to_parent_entry_create(), and filelist_readjob_main_assets_add_items().

◆ ED_file_extension_icon()

◆ ED_file_icon()

int ED_file_icon ( const FileDirEntry * file)

Definition at line 397 of file filelist.cc.

References filelist_geticon_file_type_ex(), and FileDirEntry::preview_icon_id.

◆ ED_path_extension_type()

◆ ENUM_OPERATORS()

ENUM_OPERATORS ( ListLibOptions ,
LIST_LIB_ADD_PARENT  )

References LIST_LIB_ADD_PARENT.

◆ file_is_blend_backup()

bool file_is_blend_backup ( const char * str)
static

Definition at line 1759 of file filelist.cc.

References b, BLI_strcasestr(), and str.

Referenced by ED_path_extension_type().

◆ fileentry_uiname()

◆ filelist_asset_library()

◆ filelist_cache_clear()

◆ filelist_cache_file_lookup()

◆ filelist_cache_preview_ensure_running()

◆ filelist_cache_preview_freef()

void filelist_cache_preview_freef ( TaskPool * __restrict,
void * taskdata )
static

Definition at line 618 of file filelist.cc.

References MEM_freeN(), and FileListEntryPreviewTaskData::preview.

Referenced by filelist_cache_previews_push().

◆ filelist_cache_preview_runf()

◆ filelist_cache_previews_clear()

◆ filelist_cache_previews_done()

◆ filelist_cache_previews_free()

◆ filelist_cache_previews_push()

◆ filelist_cache_previews_running()

bool filelist_cache_previews_running ( FileList * filelist)

Definition at line 1739 of file filelist.cc.

References FileList::filelist_cache, and FileListEntryCache::previews_pool.

Referenced by file_draw_list().

◆ filelist_cache_previews_set()

◆ filelist_cache_previews_update()

◆ filelist_checkdir_dir()

bool filelist_checkdir_dir ( const FileList * ,
char dirpath[FILE_MAX_LIBEXTRA],
const bool do_change )
static

◆ filelist_checkdir_lib()

bool filelist_checkdir_lib ( const FileList * ,
char dirpath[FILE_MAX_LIBEXTRA],
const bool do_change )
static

◆ filelist_checkdir_main()

bool filelist_checkdir_main ( const FileList * filelist,
char dirpath[FILE_MAX_LIBEXTRA],
const bool do_change )
static

Definition at line 458 of file filelist.cc.

References FILE_MAX_LIBEXTRA, and filelist_checkdir_lib().

Referenced by filelist_settype().

◆ filelist_checkdir_return_always_valid()

bool filelist_checkdir_return_always_valid ( const FileList * ,
char [FILE_MAX_LIBEXTRA],
const bool  )
static

Definition at line 466 of file filelist.cc.

References FILE_MAX_LIBEXTRA.

Referenced by filelist_settype().

◆ filelist_clear()

void filelist_clear ( FileList * filelist)

◆ filelist_clear_asset_library()

void filelist_clear_asset_library ( FileList * filelist)
static

◆ filelist_clear_ex()

◆ filelist_clear_from_reset_tag()

◆ filelist_clear_main_files()

◆ filelist_compare_asset_libraries()

bool filelist_compare_asset_libraries ( const AssetLibraryReference * library_a,
const AssetLibraryReference * library_b )
static

Checks two libraries for equality.

Returns
True if the libraries match.

Definition at line 149 of file filelist.cc.

References ASSET_LIBRARY_CUSTOM, BKE_preferences_asset_library_find_index(), AssetLibraryReference::custom_library_index, AssetLibraryReference::type, and U.

Referenced by filelist_setlibrary().

◆ filelist_contains_main()

bool filelist_contains_main ( const FileList * filelist,
const Main * bmain )
static

Check if bmain is stored within the root path of filelist. This means either directly or in some nested directory. In other words, it checks if the filelist root path is contained in the path to bmain. This is irrespective of the recursion level displayed, it basically assumes unlimited recursion levels.

Definition at line 3008 of file filelist.cc.

References ASSET_LIBRARY_ALL, FileList::asset_library_ref, BKE_main_blendfile_path(), BLI_path_contains(), FileList::filelist, FileDirEntryArr::root, and AssetLibraryReference::type.

Referenced by filelist_readjob_asset_library().

◆ filelist_dir()

const char * filelist_dir ( const FileList * filelist)

Get the root path of the file list. To get the full path for a file, use filelist_file_get_full_path().

Definition at line 1095 of file filelist.cc.

References FileList::filelist, and FileDirEntryArr::root.

Referenced by ED_file_change_dir_ex(), file_external_operation_exec(), file_os_operations_menu_draw(), and filelist_file_get_full_path().

◆ filelist_direntryarr_free()

void filelist_direntryarr_free ( FileDirEntryArr * array)
static

◆ filelist_ensure_special_file_image()

ImBuf * filelist_ensure_special_file_image ( SpecialFileImages image,
int icon )
static

Definition at line 242 of file filelist.cc.

References gSpecialFileImages, and UI_svg_icon_bitmap().

Referenced by filelist_geticon_special_file_image_ex().

◆ filelist_entries_select_index_range_set()

◆ filelist_entry_clear()

◆ filelist_entry_free()

void filelist_entry_free ( FileDirEntry * entry)
static

◆ filelist_entry_get_asset_representation()

asset_system::AssetRepresentation * filelist_entry_get_asset_representation ( const FileList * filelist,
const int index )

◆ filelist_entry_get_id()

ID * filelist_entry_get_id ( const FileList * filelist,
int index )

Same as filelist_file_get_id(), but gets the file by index (doesn't require the file to be cached, uses FileListInternEntry only).

Definition at line 1332 of file filelist.cc.

References filelist_entry_intern_get(), FileListInternEntry::id, and FileListInternEntry::local_data.

Referenced by file_context().

◆ filelist_entry_get_relpath()

const char * filelist_entry_get_relpath ( const FileList * filelist,
int index )

Get the FileDirEntry.relpath value without requiring the FileDirEntry to be available (doesn't require the file to be cached, uses FileListInternEntry only).

Definition at line 1350 of file filelist.cc.

References filelist_entry_intern_get(), and FileListInternEntry::relpath.

Referenced by autocomplete_file(), and file_select_match().

◆ filelist_entry_intern_get()

FileListInternEntry * filelist_entry_intern_get ( const FileList * filelist,
const int index )
static

◆ filelist_entry_is_selected()

◆ filelist_entry_parent_select_set()

void filelist_entry_parent_select_set ( FileList * filelist,
FileSelType select,
eDirEntry_SelectFlag flag,
FileCheckType check )

Set selection of the '..' parent entry, but only if it's actually visible.

Definition at line 2033 of file filelist.cc.

References filelist_entry_select_index_set(), FileList::filter_data, flag, FileListFilter::flags, FLF_HIDE_PARENT, and select.

Referenced by file_box_select_exec(), file_select_exec(), and file_walk_select_selection_set().

◆ filelist_entry_select_get()

◆ filelist_entry_select_index_get()

◆ filelist_entry_select_index_set()

void filelist_entry_select_index_set ( FileList * filelist,
const int index,
FileSelType select,
const eDirEntry_SelectFlag flag,
FileCheckType check )

◆ filelist_entry_select_set()

◆ filelist_file()

FileDirEntry * filelist_file ( FileList * filelist,
int index )

Request a file from the file browser cache, adding it to the cache if necessary.

As a rule of thumb, this can be used for operations on individual files (e.g. selection, active, renaming, etc.). But avoid calling this on many files (like when iterating the entire list), to not create a bunch of cache entries for a single operation. While a bit against the point of "intern" entries, in this case it's probably better to have queries like filelist_entry_get_id(), that take a file index and return data directly from the FileListInternEntry.

Definition at line 1285 of file filelist.cc.

References filelist_file_ex().

Referenced by ED_fileselect_activate_by_relpath(), ED_fileselect_active_asset_get(), ED_fileselect_selected_files_full_paths(), file_box_select_modal(), file_context(), file_delete_exec(), file_draw_list(), file_execute(), file_external_operation_exec(), file_os_operations_menu_draw(), file_params_renamefile_activate(), file_rename_state_activate(), file_select_do(), file_sfile_to_operator_ex(), filelist_entry_select_index_get(), filelist_entry_select_index_set(), filelist_geticon_get_file(), and fileselect_file_set().

◆ filelist_file_cache_block()

◆ filelist_file_cache_block_create()

bool filelist_file_cache_block_create ( FileList * filelist,
const int start_index,
const int size,
int cursor )
static

◆ filelist_file_cache_block_release()

void filelist_file_cache_block_release ( FileList * filelist,
const int size,
int cursor )
static

◆ filelist_file_cache_slidingwindow_set()

void filelist_file_cache_slidingwindow_set ( FileList * filelist,
size_t window_size )

◆ filelist_file_create_entry()

◆ filelist_file_ex()

◆ filelist_file_find_id()

int filelist_file_find_id ( const FileList * filelist,
const ID * id )

◆ filelist_file_find_path()

int filelist_file_find_path ( FileList * filelist,
const char * filename )

Find a file from a file name, or more precisely, its file-list relative path, inside the filtered items.

Returns
The index of the found file or -1.

Definition at line 1290 of file filelist.cc.

References FileDirEntryArr::entries_filtered_num, FILEDIR_NBR_ENTRIES_UNSET, FileList::filelist, FileList::filelist_intern, FileListIntern::filtered, FileListInternEntry::relpath, and STREQ.

Referenced by file_params_find_renamed().

◆ filelist_file_get_full_path()

void filelist_file_get_full_path ( const FileList * filelist,
const FileDirEntry * file,
char r_filepath[FILE_MAX_LIBEXTRA] )

◆ filelist_file_get_id()

ID * filelist_file_get_id ( const FileDirEntry * file)

Get the ID a file represents (if any). For FILE_MAIN, FILE_MAIN_ASSET.

Definition at line 1345 of file filelist.cc.

References FileDirEntry::id.

Referenced by ED_fileselect_active_asset_get(), file_but_enable_drag(), file_context(), and file_draw_indicator_icons().

◆ filelist_file_get_preview_image()

ImBuf * filelist_file_get_preview_image ( const FileDirEntry * file)

◆ filelist_file_is_preview_pending()

bool filelist_file_is_preview_pending ( const FileList * filelist,
const FileDirEntry * file )

◆ filelist_file_preview_load_poll()

bool filelist_file_preview_load_poll ( const FileDirEntry * entry)
static

Check if a preview for entry may be requested. Further conditions may apply, this just helps to skip plenty of entries where it's easy to tell that no valid preview will be available or is being loaded already.

Definition at line 690 of file filelist.cc.

References FILE_ENTRY_BLENDERLIB_NO_PREVIEW, FILE_ENTRY_INVALID_PREVIEW, FILE_ENTRY_PREVIEW_LOADING, FILE_TYPE_BLENDER, FILE_TYPE_BLENDER_BACKUP, FILE_TYPE_BLENDERLIB, FILE_TYPE_DIR, FILE_TYPE_FTFONT, FILE_TYPE_IMAGE, FILE_TYPE_MOVIE, FILE_TYPE_OBJECT_IO, FileDirEntry::flags, and FileDirEntry::typeflag.

Referenced by filelist_cache_previews_push().

◆ filelist_file_release_entry()

void filelist_file_release_entry ( FileList * filelist,
FileDirEntry * entry )
static

◆ filelist_files_ensure()

◆ filelist_files_num_entries()

int filelist_files_num_entries ( FileList * filelist)

Return the total raw number of entries listed in the given filelist, whether they are filtered out or not.

Definition at line 1045 of file filelist.cc.

References FileDirEntryArr::entries_num, and FileList::filelist.

Referenced by file_draw_hint_if_invalid().

◆ filelist_free()

◆ filelist_free_icons()

void filelist_free_icons ( )

Definition at line 191 of file filelist.cc.

References _Max, BLI_assert, G, gSpecialFileImages, i, and IMB_freeImBuf().

Referenced by ED_file_exit().

◆ filelist_freelib()

◆ filelist_get_preview_image()

ImBuf * filelist_get_preview_image ( FileList * filelist,
int index )
Returns
True if a new preview request was pushed, false otherwise (e.g. because the preview is already loaded, invalid or not supported).

Definition at line 230 of file filelist.cc.

References BKE_icon_imbuf_get_buffer(), filelist_geticon_get_file(), and FileDirEntry::preview_icon_id.

Referenced by file_draw_list().

◆ filelist_geticon_file_type()

int filelist_geticon_file_type ( FileList * filelist,
const int index,
const bool is_main )

Definition at line 390 of file filelist.cc.

References filelist_geticon_file_type_ex(), and filelist_geticon_get_file().

Referenced by file_draw_list().

◆ filelist_geticon_file_type_ex()

◆ filelist_geticon_get_file()

FileDirEntry * filelist_geticon_get_file ( FileList * filelist,
const int index )
static

◆ filelist_geticon_special_file_image()

ImBuf * filelist_geticon_special_file_image ( FileList * filelist,
int index )

Get one of the larger document icons as image. E.g. a folder or file icon. A file type icon can be overlaid on top then.

Definition at line 270 of file filelist.cc.

References filelist_geticon_get_file(), and filelist_geticon_special_file_image_ex().

◆ filelist_geticon_special_file_image_ex()

◆ filelist_intern_entry_free()

◆ filelist_intern_entry_is_main_file()

bool filelist_intern_entry_is_main_file ( const FileListInternEntry * intern_entry)

◆ filelist_intern_free()

◆ filelist_intern_free_main_files()

int filelist_intern_free_main_files ( FileList * filelist)
static

◆ filelist_is_dir()

bool filelist_is_dir ( const FileList * filelist,
const char * path )

◆ filelist_is_ready()

◆ filelist_islibrary()

◆ filelist_jobtype_get()

◆ filelist_lib()

BlendHandle * filelist_lib ( FileList * filelist)

Definition at line 1040 of file filelist.cc.

References FileList::libfiledata.

Referenced by ED_file_path_button().

◆ filelist_needs_force_reset()

◆ filelist_needs_reading()

◆ filelist_needs_reset_on_main_changes()

◆ filelist_new()

◆ filelist_pending()

bool filelist_pending ( const FileList * filelist)

◆ filelist_readjob_all_asset_library()

◆ filelist_readjob_append_entries()

bool filelist_readjob_append_entries ( FileListReadJob * job_params,
ListBase * from_entries,
int from_entries_num )
static

◆ filelist_readjob_asset_library()

◆ filelist_readjob_blocking_run()

void filelist_readjob_blocking_run ( FileList * filelist,
int space_notifier,
const bContext * C )

Forcibly run the job as a blocking task on the main thread.

Definition at line 3351 of file filelist.cc.

References C, and filelist_readjob_start_ex().

Referenced by blender::ed::asset::list::AssetList::ensure_blocking().

◆ filelist_readjob_dir()

void filelist_readjob_dir ( FileListReadJob * job_params,
bool * stop,
bool * do_update,
float * progress )
static

Definition at line 2905 of file filelist.cc.

References filelist_readjob_do().

Referenced by filelist_readjob_main(), and filelist_settype().

◆ filelist_readjob_do()

void filelist_readjob_do ( const bool do_lib,
FileListReadJob * job_params,
const bool * stop,
bool * do_update,
float * progress )
static

◆ filelist_readjob_endjob()

void filelist_readjob_endjob ( void * flrjv)
static

◆ filelist_readjob_free()

◆ filelist_readjob_is_partial_read()

bool filelist_readjob_is_partial_read ( const FileListReadJob * read_job)
static

Check if the read-job is requesting a partial reread of the file list only.

Definition at line 3142 of file filelist.cc.

References FileListReadJob::only_main_data.

Referenced by filelist_readjob_startjob().

◆ filelist_readjob_lib()

void filelist_readjob_lib ( FileListReadJob * job_params,
bool * stop,
bool * do_update,
float * progress )
static

Definition at line 2913 of file filelist.cc.

References filelist_readjob_do().

Referenced by filelist_settype().

◆ filelist_readjob_list_dir()

◆ filelist_readjob_list_lib()

◆ filelist_readjob_list_lib_add_datablock()

void filelist_readjob_list_lib_add_datablock ( FileListReadJob * job_params,
ListBase * entries,
BLODataBlockInfo * datablock_info,
const bool prefix_relpath_with_group_name,
const int idcode,
const char * group_name )
static

◆ filelist_readjob_list_lib_add_datablocks()

void filelist_readjob_list_lib_add_datablocks ( FileListReadJob * job_params,
ListBase * entries,
LinkNode * datablock_infos,
const bool prefix_relpath_with_group_name,
const int idcode,
const char * group_name )
static

Definition at line 2317 of file filelist.cc.

References filelist_readjob_list_lib_add_datablock(), and LinkNode::next.

Referenced by filelist_readjob_list_lib().

◆ filelist_readjob_list_lib_add_from_indexer_entries()

void filelist_readjob_list_lib_add_from_indexer_entries ( FileListReadJob * job_params,
ListBase * entries,
const FileIndexerEntries * indexer_entries,
const bool prefix_relpath_with_group_name )
static

◆ filelist_readjob_list_lib_group_create()

FileListInternEntry * filelist_readjob_list_lib_group_create ( const FileListReadJob * job_params,
const int idcode,
const char * group_name )
static

◆ filelist_readjob_list_lib_navigate_to_parent_entry_create()

FileListInternEntry * filelist_readjob_list_lib_navigate_to_parent_entry_create ( const FileListReadJob * job_params)
static

◆ filelist_readjob_list_lib_populate_from_index()

int filelist_readjob_list_lib_populate_from_index ( FileListReadJob * job_params,
ListBase * entries,
const ListLibOptions options,
const int read_from_index,
const FileIndexerEntries * indexer_entries )
static

◆ filelist_readjob_load_asset_library_data()

void filelist_readjob_load_asset_library_data ( FileListReadJob * job_params,
bool * do_update )
static

◆ filelist_readjob_main()

void filelist_readjob_main ( FileListReadJob * job_params,
bool * stop,
bool * do_update,
float * progress )
static

Definition at line 3048 of file filelist.cc.

References filelist_readjob_dir().

Referenced by filelist_settype().

◆ filelist_readjob_main_assets()

◆ filelist_readjob_main_assets_add_items()

◆ filelist_readjob_recursive_dir_add_items()

◆ filelist_readjob_running()

int filelist_readjob_running ( FileList * filelist,
wmWindowManager * wm )

Definition at line 3361 of file filelist.cc.

References filelist_jobtype_get(), and WM_jobs_test().

◆ filelist_readjob_should_recurse_into_entry()

bool filelist_readjob_should_recurse_into_entry ( const int max_recursion,
const bool is_lib,
const int current_recursion_level,
FileListInternEntry * entry )
static

◆ filelist_readjob_start()

void filelist_readjob_start ( FileList * filelist,
int space_notifier,
const bContext * C )

May run the job in either the main thread or asynchronously.

Definition at line 3346 of file filelist.cc.

References C, and filelist_readjob_start_ex().

Referenced by blender::ed::asset::list::AssetList::fetch(), and file_refresh().

◆ filelist_readjob_start_ex()

◆ filelist_readjob_startjob()

◆ filelist_readjob_stop()

◆ filelist_readjob_update()

void filelist_readjob_update ( void * flrjv)
static

◆ filelist_set_asset_catalog_filter_options()

void filelist_set_asset_catalog_filter_options ( FileList * filelist,
eFileSel_Params_AssetCatalogVisibility catalog_visibility,
const ::bUUID * catalog_id )

◆ filelist_setdir()

◆ filelist_setindexer()

void filelist_setindexer ( FileList * filelist,
const FileIndexerType * indexer )

Set the indexer to be used by the filelist.

The given indexer allocation should be handled by the caller or defined statically.

Definition at line 118 of file filelist.cc.

References BLI_assert, and FileList::indexer.

Referenced by file_refresh(), and blender::ed::asset::list::AssetList::setup().

◆ filelist_setlibrary()

void filelist_setlibrary ( FileList * filelist,
const AssetLibraryReference * asset_library_ref )
Parameters
asset_library_refMay be NULL to unset the library.

Definition at line 166 of file filelist.cc.

References FileList::asset_library_ref, filelist_compare_asset_libraries(), FL_FORCE_RESET, FileList::flags, MEM_callocN(), and MEM_SAFE_FREE.

Referenced by file_refresh(), and blender::ed::asset::list::AssetList::setup().

◆ filelist_setrecursion()

void filelist_setrecursion ( FileList * filelist,
const int recursion_level )

◆ filelist_settype()

◆ filelist_tag_force_reset()

void filelist_tag_force_reset ( FileList * filelist)

Definition at line 1135 of file filelist.cc.

References FL_FORCE_RESET, and FileList::flags.

Referenced by blender::ed::asset::list::AssetList::clear().

◆ filelist_tag_force_reset_mainfiles()

◆ filelist_tag_reload_asset_library()

void filelist_tag_reload_asset_library ( FileList * filelist)

◆ filelist_uid_generate()

◆ filelist_uid_is_set()

bool filelist_uid_is_set ( const FileUID uid)

Definition at line 1366 of file filelist.cc.

References filelist_uid_unset().

◆ filelist_uid_unset()

void filelist_uid_unset ( FileUID * r_uid)

Definition at line 1373 of file filelist.cc.

References FILE_UID_UNSET.

Referenced by filelist_readjob_startjob(), and filelist_uid_is_set().

◆ groupname_to_code()

int groupname_to_code ( const char * group)
static

◆ parent_dir_until_exists_or_default_root()

void parent_dir_until_exists_or_default_root ( char * dir)
static

Variable Documentation

◆ gSpecialFileImages

ImBuf* gSpecialFileImages[int(SpecialFileImages::_Max)]
static

Definition at line 88 of file filelist.cc.

Referenced by filelist_ensure_special_file_image(), and filelist_free_icons().