asset_library_service.hh

Go to the documentation of this file.

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

 
#pragma once
 
#include <optional>
#include <utility>
 
#include "AS_asset_library.hh"
 
#include "BLI_function_ref.hh"
#include "BLI_map.hh"
 
#include <memory>
 
struct AssetLibraryReference;
struct bUserAssetLibrary;
 
namespace blender::asset_system {
 
class AllAssetLibrary;
class OnDiskAssetLibrary;
class RuntimeAssetLibrary;

class AssetLibraryService {
  static std::unique_ptr<AssetLibraryService> instance_;

  using OnDiskLibraryIdentifier = std::pair<eAssetLibraryType, std::string>;
  Map<OnDiskLibraryIdentifier, std::unique_ptr<OnDiskAssetLibrary>> on_disk_libraries_;
  std::unique_ptr<RuntimeAssetLibrary> current_file_library_;
  std::unique_ptr<AllAssetLibrary> all_library_;

  bCallbackFuncStore on_load_callback_store_;
  static bool atexit_handler_registered_;
 
 public:
  AssetLibraryService() = default;
  ~AssetLibraryService() = default;

  static AssetLibraryService *get();

  static void destroy();
 
  static std::string root_path_from_library_ref(const AssetLibraryReference &library_reference);
  static bUserAssetLibrary *find_custom_asset_library_from_library_ref(
      const AssetLibraryReference &library_reference);
  static bUserAssetLibrary *find_custom_preferences_asset_library_from_asset_weak_ref(
      const AssetWeakReference &asset_reference);
  static AssetLibrary *move_runtime_current_file_into_on_disk_library(const Main &bmain);
 
  AssetLibrary *get_asset_library(const Main *bmain,
                                  const AssetLibraryReference &library_reference);

  AssetLibrary *get_asset_library_on_disk_custom(StringRef name, StringRefNull root_path);
  AssetLibrary *get_asset_library_on_disk_custom_preferences(bUserAssetLibrary *custom_library);
  AssetLibrary *get_asset_library_on_disk_builtin(eAssetLibraryType type, StringRefNull root_path);
  AssetLibrary *get_asset_library_current_file();
  AssetLibrary *get_asset_library_all(const Main *bmain);
  void tag_all_library_catalogs_dirty();
  void reload_all_library_catalogs_if_dirty();

  int64_t rfind_blendfile_extension(StringRef path);
  std::string normalize_asset_weak_reference_relative_asset_identifier(
      const AssetWeakReference &asset_reference);
  std::string resolve_asset_weak_reference_to_library_path(
      const AssetWeakReference &asset_reference);
  std::string resolve_asset_weak_reference_to_full_path(const AssetWeakReference &asset_reference);
  struct ExplodedPath {
    std::unique_ptr<std::string> full_path;
    StringRef dir_component = "";
    StringRef group_component = "";
    StringRef name_component = "";
  };

  std::optional<ExplodedPath> resolve_asset_weak_reference_to_exploded_path(
      const AssetWeakReference &asset_reference);

  bool has_any_unsaved_catalogs() const;

  void foreach_loaded_asset_library(FunctionRef<void(AssetLibrary &)> fn,
                                    bool include_all_library) const;
 
 protected:
  static void allocate_service_instance();
 
  OnDiskAssetLibrary *lookup_on_disk_library(eAssetLibraryType type, StringRefNull root_path);
 
  AssetLibrary *find_loaded_on_disk_asset_library_from_name(StringRef name) const;

  AssetLibrary *get_asset_library_on_disk(eAssetLibraryType library_type,
                                          StringRef name,
                                          StringRefNull root_path,
                                          bool load_catalogs = true,
                                          bUserAssetLibrary *preferences_library = nullptr);
  void app_handler_register();
  void app_handler_unregister();
};
 
}  // namespace blender::asset_system