filelist.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2007 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include <cstddef>
#include <cstdint>
 
#include "DNA_space_types.h"
 
struct AssetLibraryReference;
struct bContext;
struct BlendHandle;
struct FileIndexerType;
struct FileList;
struct FileSelection;
struct ID;
struct ImBuf;
struct bUUID;
struct wmWindowManager;
namespace blender::asset_system {
class AssetLibrary;
class AssetRepresentation;
}  // namespace blender::asset_system
 
struct FileDirEntry;
 
using FileUID = uint32_t;
 
enum FileSelType {
  FILE_SEL_REMOVE = 0,
  FILE_SEL_ADD = 1,
  FILE_SEL_TOGGLE = 2,
};
 
enum FileCheckType {
  CHECK_DIRS = 1,
  CHECK_FILES = 2,
  CHECK_ALL = 3,
};
 
void filelist_setsorting(FileList *filelist, short sort, bool invert_sort);
void filelist_sort(FileList *filelist);
 
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,
                                const char *filter_glob,
                                const char *filter_search);
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);
bool filelist_needs_filtering(FileList *filelist);
void filelist_tag_needs_filtering(FileList *filelist);
void filelist_filter(FileList *filelist);
void filelist_setlibrary(FileList *filelist, const AssetLibraryReference *asset_library_ref);
 
void filelist_init_icons();
void filelist_free_icons();
void filelist_file_get_full_path(const FileList *filelist,
                                 const FileDirEntry *file,
                                 char r_filepath[/*FILE_MAX_LIBEXTRA*/ 1090]);
bool filelist_file_is_preview_pending(const FileList *filelist, const FileDirEntry *file);
ImBuf *filelist_get_preview_image(FileList *filelist, int index);
ImBuf *filelist_file_get_preview_image(const FileDirEntry *file);
ImBuf *filelist_geticon_special_file_image_ex(const FileDirEntry *file);
ImBuf *filelist_geticon_special_file_image(FileList *filelist, int index);
int filelist_geticon_file_type(FileList *filelist, int index, bool is_main);
 
FileList *filelist_new(short type);
void filelist_settype(FileList *filelist, short type);
void filelist_clear(FileList *filelist);
void filelist_clear_ex(FileList *filelist,
                       bool do_asset_library,
                       bool do_cache,
                       bool do_selection);
void filelist_clear_from_reset_tag(FileList *filelist);
void filelist_free(FileList *filelist);

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*/ 1090]);

int filelist_files_ensure(FileList *filelist);
int filelist_needs_reading(const FileList *filelist);
FileDirEntry *filelist_file(FileList *filelist, int index);
FileDirEntry *filelist_file_ex(FileList *filelist, int index, bool use_request);

int filelist_file_find_path(FileList *filelist, const char *filename);
int filelist_file_find_id(const FileList *filelist, const ID *id);
ID *filelist_file_get_id(const FileDirEntry *file);
ID *filelist_entry_get_id(const FileList *filelist, int index);
blender::asset_system::AssetRepresentation *filelist_entry_get_asset_representation(
    const FileList *filelist, const int index);
const char *filelist_entry_get_relpath(const FileList *filelist, int index);
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);
bool filelist_file_cache_block(FileList *filelist, int index);
 
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_pending(const FileList *filelist);
bool filelist_needs_reset_on_main_changes(const FileList *filelist);
bool filelist_is_ready(const FileList *filelist);
 
unsigned int 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,
                                     int index,
                                     FileSelType select,
                                     eDirEntry_SelectFlag flag,
                                     FileCheckType check);
void filelist_entries_select_index_range_set(FileList *filelist,
                                             FileSelection *sel,
                                             FileSelType select,
                                             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,
                                                     int index,
                                                     FileCheckType check);
bool filelist_entry_is_selected(FileList *filelist, int index);
void filelist_entry_parent_select_set(FileList *filelist,
                                      FileSelType select,
                                      eDirEntry_SelectFlag flag,
                                      FileCheckType check);
 
void filelist_setrecursion(FileList *filelist, int recursion_level);
 
blender::asset_system::AssetLibrary *filelist_asset_library(FileList *filelist);
 
BlendHandle *filelist_lib(FileList *filelist);
bool filelist_islibrary(FileList *filelist, char *dir, char **r_group);
void filelist_freelib(FileList *filelist);

int filelist_files_num_entries(FileList *filelist);

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

void filelist_readjob_start(FileList *filelist, int space_notifier, const bContext *C);
void filelist_readjob_stop(FileList *filelist, wmWindowManager *wm);
int filelist_readjob_running(FileList *filelist, wmWindowManager *wm);
 
bool filelist_cache_previews_update(FileList *filelist);
void filelist_cache_previews_set(FileList *filelist, bool use_previews);
bool filelist_cache_previews_running(FileList *filelist);
bool filelist_cache_previews_done(FileList *filelist);