asset_list.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#include <optional>
#include <string>
 
#include "AS_asset_library.hh"
 
#include "BKE_context.hh"
#include "BKE_screen.hh"
 
#include "BLI_map.hh"
#include "BLI_string.h"
#include "BLI_utility_mixins.hh"
 
#include "DNA_space_types.h"
 
#include "WM_api.hh"
 
/* XXX uses private header of file-space. */
#include "../space_file/file_indexer.hh"
#include "../space_file/filelist.hh"
 
#include "ED_asset_indexer.hh"
#include "ED_asset_list.hh"
#include "ED_fileselect.hh"
#include "ED_screen.hh"
#include "asset_library_reference.hh"
 
namespace blender::ed::asset::list {
 
/* -------------------------------------------------------------------- */
class FileListWrapper {
  static void filelist_free_fn(FileList *list)
  {
    filelist_free(list);
    MEM_freeN(list);
  }
 
  std::unique_ptr<FileList, decltype(&filelist_free_fn)> file_list_;
 
 public:
  explicit FileListWrapper(eFileSelectType filesel_type)
      : file_list_(filelist_new(filesel_type), filelist_free_fn)
  {
  }
  FileListWrapper(FileListWrapper &&other) = default;
  FileListWrapper &operator=(FileListWrapper &&other) = default;
  ~FileListWrapper()
  {
    /* Destructs the owned pointer. */
    file_list_ = nullptr;
  }
 
  operator FileList *() const
  {
    return file_list_.get();
  }
};
 
class PreviewTimer {
  /* Non-owning! The Window-Manager registers and owns this. */
  wmTimer *timer_ = nullptr;
 
 public:
  void ensure_running(const bContext *C)
  {
    if (!timer_) {
      timer_ = WM_event_timer_add_notifier(
          CTX_wm_manager(C), CTX_wm_window(C), NC_ASSET | ND_ASSET_LIST_PREVIEW, 0.01);
    }
  }
 
  void stop(const bContext *C)
  {
    if (timer_) {
      WM_event_timer_remove_notifier(CTX_wm_manager(C), CTX_wm_window(C), timer_);
      timer_ = nullptr;
    }
  }
};
 
class AssetList : NonCopyable {
  FileListWrapper filelist_;
  AssetLibraryReference library_ref_;
  PreviewTimer previews_timer_;
 
 public:
  AssetList() = delete;
  AssetList(eFileSelectType filesel_type, const AssetLibraryReference &asset_library_ref);
  AssetList(AssetList &&other) = default;
  ~AssetList() = default;
 
  static bool listen(const wmNotifier &notifier);
 
  void setup();
  void fetch(const bContext &C);
  void update_previews(const bContext &C);
  void clear(const bContext *C);
 
  AssetHandle asset_get_by_index(int index) const;
 
  void previews_job_update(const bContext *C);
  bool needs_refetch() const;
  bool is_loaded() const;
  bool is_asset_preview_loading(const AssetHandle &asset) const;
  void ensure_asset_preview_requested(const bContext &C, AssetHandle &asset);
  asset_system::AssetLibrary *asset_library() const;
  void iterate(AssetListHandleIterFn fn,
               FunctionRef<bool(asset_system::AssetRepresentation &)> prefilter_fn) const;
  void iterate(AssetListIterFn fn) const;
  int size() const;
  void tag_main_data_dirty() const;
  void remap_id(ID *id_old, ID *id_new) const;
};
 
AssetList::AssetList(eFileSelectType filesel_type, const AssetLibraryReference &asset_library_ref)
    : filelist_(filesel_type), library_ref_(asset_library_ref)
{
}
 
void AssetList::setup()
{
  FileList *files = filelist_;
  std::string asset_lib_path = AS_asset_library_root_path_from_library_ref(library_ref_);
 
  /* Relevant bits from file_refresh(). */
  /* TODO pass options properly. */
  filelist_setrecursion(files, FILE_SELECT_MAX_RECURSIONS);
  filelist_setsorting(files, FILE_SORT_ASSET_CATALOG, false);
  filelist_setlibrary(files, &library_ref_);
  filelist_setfilter_options(
      files,
      true,
      true,
      true, /* Just always hide parent, prefer to not add an extra user option for this. */
      FILE_TYPE_BLENDERLIB,
      FILTER_ID_ALL,
      true,
      "",
      "");
  filelist_set_no_preview_auto_cache(files);
 
  const bool use_asset_indexer = !USER_EXPERIMENTAL_TEST(&U, no_asset_indexing);
  filelist_setindexer(files, use_asset_indexer ? &index::file_indexer_asset : &file_indexer_noop);
 
  char dirpath[FILE_MAX_LIBEXTRA] = "";
  if (!asset_lib_path.empty()) {
    STRNCPY(dirpath, asset_lib_path.c_str());
  }
  filelist_setdir(files, dirpath);
}
 
void AssetList::fetch(const bContext &C)
{
  FileList *files = filelist_;
 
  if (filelist_needs_force_reset(files)) {
    filelist_readjob_stop(files, CTX_wm_manager(&C));
    filelist_clear_from_reset_tag(files);
  }
 
  if (filelist_needs_reading(files)) {
    if (!filelist_pending(files)) {
      filelist_readjob_start(files, NC_ASSET | ND_ASSET_LIST_READING, &C);
    }
  }
  filelist_sort(files);
  filelist_filter(files);
}
 
void AssetList::update_previews(const bContext &C)
{
  if (filelist_cache_previews_enabled(filelist_)) {
    /* Get newest loaded previews from the background thread queue. */
    filelist_cache_previews_update(filelist_);
  }
  /* Update preview job, it might have to be stopped. */
  this->previews_job_update(&C);
}
 
bool AssetList::needs_refetch() const
{
  return filelist_needs_force_reset(filelist_) || filelist_needs_reading(filelist_);
}
 
bool AssetList::is_loaded() const
{
  return filelist_is_ready(filelist_);
}
 
void AssetList::ensure_asset_preview_requested(const bContext &C, AssetHandle &asset)
{
  /* Ensure previews are enabled. */
  filelist_cache_previews_set(filelist_, true);
 
  if (filelist_file_ensure_preview_requested(filelist_,
                                             const_cast<FileDirEntry *>(asset.file_data)))
  {
    previews_timer_.ensure_running(&C);
  }
}
 
bool AssetList::is_asset_preview_loading(const AssetHandle &asset) const
{
  return filelist_file_is_preview_pending(filelist_, asset.file_data);
}
 
asset_system::AssetLibrary *AssetList::asset_library() const
{
  return reinterpret_cast<asset_system::AssetLibrary *>(filelist_asset_library(filelist_));
}
 
void AssetList::iterate(AssetListHandleIterFn fn,
                        FunctionRef<bool(asset_system::AssetRepresentation &)> prefilter_fn) const
{
  FileList *files = filelist_;
  int numfiles = filelist_files_ensure(files);
 
  for (int i = 0; i < numfiles; i++) {
    asset_system::AssetRepresentation *asset = filelist_entry_get_asset_representation(files, i);
    if (!asset) {
      continue;
    }
 
    if (prefilter_fn && !prefilter_fn(*asset)) {
      continue;
    }
 
    FileDirEntry *file = filelist_file(files, i);
 
    AssetHandle asset_handle = {file};
    if (!fn(asset_handle)) {
      /* If the callback returns false, we stop iterating. */
      break;
    }
  }
}
 
void AssetList::iterate(AssetListIterFn fn) const
{
  FileList *files = filelist_;
  const int numfiles = filelist_files_ensure(files);
 
  for (int i = 0; i < numfiles; i++) {
    asset_system::AssetRepresentation *asset = filelist_entry_get_asset_representation(files, i);
    if (!asset) {
      continue;
    }
 
    if (!fn(*asset)) {
      break;
    }
  }
}
 
void AssetList::previews_job_update(const bContext *C)
{
  FileList *files = filelist_;
 
  if (!filelist_cache_previews_enabled(files)) {
    previews_timer_.stop(C);
    return;
  }
 
  {
    const bool previews_running = filelist_cache_previews_running(files) &&
                                  !filelist_cache_previews_done(files);
    if (previews_running) {
      previews_timer_.ensure_running(C);
    }
    else {
      /* Preview is not running, no need to keep generating update events! */
      previews_timer_.stop(C);
    }
  }
}
 
void AssetList::clear(const bContext *C)
{
  /* Based on #ED_fileselect_clear() */
 
  FileList *files = filelist_;
  filelist_readjob_stop(files, CTX_wm_manager(C));
  filelist_freelib(files);
  filelist_clear(files);
  filelist_tag_force_reset(files);
 
  WM_main_add_notifier(NC_ASSET | ND_ASSET_LIST, nullptr);
}
 
AssetHandle AssetList::asset_get_by_index(int index) const
{
  return {filelist_file(filelist_, index)};
}
 
bool AssetList::listen(const wmNotifier &notifier)
{
  switch (notifier.category) {
    case NC_ID: {
      if (ELEM(notifier.action, NA_RENAME)) {
        return true;
      }
      break;
    }
    case NC_ASSET:
      if (ELEM(notifier.data, ND_ASSET_LIST, ND_ASSET_LIST_READING, ND_ASSET_LIST_PREVIEW)) {
        return true;
      }
      if (ELEM(notifier.action, NA_ADDED, NA_REMOVED, NA_EDITED)) {
        return true;
      }
      break;
  }
 
  return false;
}
 
int AssetList::size() const
{
  return filelist_files_ensure(filelist_);
}
 
void AssetList::tag_main_data_dirty() const
{
  if (filelist_needs_reset_on_main_changes(filelist_)) {
    filelist_tag_force_reset_mainfiles(filelist_);
  }
}
 
void AssetList::remap_id(ID * /*id_old*/, ID * /*id_new*/) const
{
  /* Trigger full re-fetch of the file list if main data was changed, don't even attempt remap
   * pointers. We could give file list types a id-remap callback, but it's probably not worth it.
   * Refreshing local file lists is relatively cheap. */
  this->tag_main_data_dirty();
}
 
/* -------------------------------------------------------------------- */
using AssetListMap = Map<AssetLibraryReference, AssetList>;
 
static AssetListMap &global_storage()
{
  static AssetListMap global_storage;
  return global_storage;
}
 
static AssetList *lookup_list(const AssetLibraryReference &library_ref)
{
  return global_storage().lookup_ptr(library_ref);
}
 
void storage_tag_main_data_dirty()
{
  for (AssetList &list : global_storage().values()) {
    list.tag_main_data_dirty();
  }
}
 
void storage_id_remap(ID *id_old, ID *id_new)
{
  for (AssetList &list : global_storage().values()) {
    list.remap_id(id_old, id_new);
  }
}
 
static std::optional<eFileSelectType> asset_library_reference_to_fileselect_type(
    const AssetLibraryReference &library_reference)
{
  switch (eAssetLibraryType(library_reference.type)) {
    case ASSET_LIBRARY_ALL:
      return FILE_ASSET_LIBRARY_ALL;
    case ASSET_LIBRARY_ESSENTIALS:
    case ASSET_LIBRARY_CUSTOM:
      return FILE_ASSET_LIBRARY;
    case ASSET_LIBRARY_LOCAL:
      return FILE_MAIN_ASSET;
  }
 
  return std::nullopt;
}
 
using is_new_t = bool;
static std::tuple<AssetList &, is_new_t> ensure_list_storage(
    const AssetLibraryReference &library_reference, eFileSelectType filesel_type)
{
  AssetListMap &storage = global_storage();
 
  if (AssetList *list = storage.lookup_ptr(library_reference)) {
    return {*list, false};
  }
  storage.add(library_reference, AssetList(filesel_type, library_reference));
  return {storage.lookup(library_reference), true};
}
 
void asset_reading_region_listen_fn(const wmRegionListenerParams *params)
{
  const wmNotifier *wmn = params->notifier;
  ARegion *region = params->region;
 
  switch (wmn->category) {
    case NC_ASSET:
      if (ELEM(wmn->data, ND_ASSET_LIST_READING, ND_ASSET_LIST_PREVIEW)) {
        ED_region_tag_refresh_ui(region);
      }
      break;
  }
}
 
/* -------------------------------------------------------------------- */
void storage_fetch(const AssetLibraryReference *library_reference, const bContext *C)
{
  std::optional filesel_type = asset_library_reference_to_fileselect_type(*library_reference);
  if (!filesel_type) {
    return;
  }
 
  auto [list, is_new] = ensure_list_storage(*library_reference, *filesel_type);
  if (is_new || list.needs_refetch()) {
    list.setup();
    list.fetch(*C);
  }
}
 
bool is_loaded(const AssetLibraryReference *library_reference)
{
  AssetList *list = lookup_list(*library_reference);
  if (!list) {
    return false;
  }
  if (list->needs_refetch()) {
    return false;
  }
  return list->is_loaded();
}
 
void previews_fetch(const AssetLibraryReference *library_reference, const bContext *C)
{
  AssetList *list = lookup_list(*library_reference);
  if (list) {
    list->update_previews(*C);
  }
}
 
void clear(const AssetLibraryReference *library_reference, const bContext *C)
{
  AssetList *list = lookup_list(*library_reference);
  if (list) {
    list->clear(C);
  }
 
  wmWindowManager *wm = CTX_wm_manager(C);
  LISTBASE_FOREACH (const wmWindow *, win, &wm->windows) {
    const bScreen *screen = WM_window_get_active_screen(win);
    LISTBASE_FOREACH (const ScrArea *, area, &screen->areabase) {
      /* Only needs to cover visible file/asset browsers, since others are already cleared through
       * area exiting. */
      if (area->spacetype == SPACE_FILE) {
        SpaceFile *sfile = reinterpret_cast<SpaceFile *>(area->spacedata.first);
        if (sfile->browse_mode == FILE_BROWSE_MODE_ASSETS) {
          if (sfile->asset_params && sfile->asset_params->asset_library_ref == *library_reference)
          {
            ED_fileselect_clear(wm, sfile);
          }
        }
      }
    }
  }
 
  /* Always clear the all library when clearing a nested one. */
  if (library_reference->type != ASSET_LIBRARY_ALL) {
    clear_all_library(C);
  }
}
 
void clear_all_library(const bContext *C)
{
  const AssetLibraryReference all_lib_ref = asset_system::all_library_reference();
  clear(&all_lib_ref, C);
}
 
bool storage_has_list_for_library(const AssetLibraryReference *library_reference)
{
  return lookup_list(*library_reference) != nullptr;
}
 
void iterate(const AssetLibraryReference &library_reference,
             AssetListHandleIterFn fn,
             FunctionRef<bool(asset_system::AssetRepresentation &)> prefilter_fn)
{
  AssetList *list = lookup_list(library_reference);
  if (list) {
    list->iterate(fn, prefilter_fn);
  }
}
 
void iterate(const AssetLibraryReference &library_reference, AssetListIterFn fn)
{
  AssetList *list = lookup_list(library_reference);
  if (list) {
    list->iterate(fn);
  }
}
 
asset_system::AssetLibrary *library_get_once_available(
    const AssetLibraryReference &library_reference)
{
  const AssetList *list = lookup_list(library_reference);
  if (!list) {
    return nullptr;
  }
  return list->asset_library();
}
 
AssetHandle asset_handle_get_by_index(const AssetLibraryReference *library_reference,
                                      int asset_index)
{
  const AssetList *list = lookup_list(*library_reference);
  return list->asset_get_by_index(asset_index);
}
 
asset_system::AssetRepresentation *asset_get_by_index(
    const AssetLibraryReference &library_reference, int asset_index)
{
  AssetHandle asset_handle = asset_handle_get_by_index(&library_reference, asset_index);
  return reinterpret_cast<asset_system::AssetRepresentation *>(asset_handle.file_data->asset);
}
 
bool asset_image_is_loading(const AssetLibraryReference *library_reference,
                            const AssetHandle *asset_handle)
{
  const AssetList *list = lookup_list(*library_reference);
  return list->is_asset_preview_loading(*asset_handle);
}
 
void asset_preview_ensure_requested(const bContext &C,
                                    const AssetLibraryReference *library_reference,
                                    AssetHandle *asset_handle)
{
  AssetList *list = lookup_list(*library_reference);
  list->ensure_asset_preview_requested(C, *asset_handle);
}
 
ImBuf *asset_image_get(const AssetHandle *asset_handle)
{
  ImBuf *imbuf = filelist_file_getimage(asset_handle->file_data);
  if (imbuf) {
    return imbuf;
  }
 
  return filelist_geticon_image_ex(asset_handle->file_data);
}
 
bool listen(const wmNotifier *notifier)
{
  return AssetList::listen(*notifier);
}
 
int size(const AssetLibraryReference *library_reference)
{
  AssetList *list = lookup_list(*library_reference);
  if (list) {
    return list->size();
  }
  return -1;
}
 
void storage_exit()
{
  global_storage().clear_and_shrink();
}
 
}  // namespace blender::ed::asset::list