Blender V5.3
BKE_lib_remap.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4#pragma once
5
22
23#include "BLI_compiler_attrs.hh"
24#include "BLI_enum_flags.hh"
25#include "BLI_function_ref.hh"
26#include "BLI_map.hh"
27#include "BLI_set.hh"
28#include "BLI_span.hh"
29
30namespace blender {
31
32struct ID;
33struct Main;
34
35namespace bke::id {
36class IDRemapper;
37}
38
39/* BKE_libblock_free, delete are declared in BKE_lib_id.hh for convenience. */
40
41/* Also IDRemap->flag. */
42enum {
93
101
131};
132
140
147 bke::id::IDRemapper &mappings,
148 const int remap_flags);
149
150void BKE_libblock_remap_multiple(Main *bmain,
151 bke::id::IDRemapper &mappings,
152 const int remap_flags);
153
164void BKE_libblock_remap_multiple_raw(Main *bmain,
165 bke::id::IDRemapper &mappings,
166 const int remap_flags);
174void BKE_libblock_remap_locked(Main *bmain, void *old_idv, void *new_idv, int remap_flags)
175 ATTR_NONNULL(1, 2);
176void BKE_libblock_remap(Main *bmain, void *old_idv, void *new_idv, int remap_flags)
177 ATTR_NONNULL(1, 2);
178
183void BKE_libblock_unlink(Main *bmain, void *idv, bool do_skip_indirect) ATTR_NONNULL();
184
194void BKE_libblock_relink_ex(Main *bmain, void *idv, void *old_idv, void *new_idv, int remap_flags)
195 ATTR_NONNULL(2);
200void BKE_libblock_relink_multiple(Main *bmain,
201 const Span<ID *> ids,
202 eIDRemapType remap_type,
203 bke::id::IDRemapper &id_remapper,
204 int remap_flags);
205
215void BKE_libblock_relink_to_newid(Main *bmain, ID *id, int remap_flag) ATTR_NONNULL();
216
217using BKE_library_free_notifier_reference_cb = void (*)(const void *);
219
223
224/* IDRemapper */
235
267
268using IDRemapperIterFunction = void (*)(ID *old_id, ID *new_id, void *user_data);
270
271namespace bke::id {
272
274 Map<ID *, ID *> mappings_;
275 IDTypeFilter source_types_ = 0;
276
281 Set<ID *> never_null_users_;
282
283 public:
289
290 void clear()
291 {
292 mappings_.clear();
293 never_null_users_.clear();
294 source_types_ = 0;
295 }
296
297 bool is_empty() const
298 {
299 return mappings_.is_empty();
300 }
301
303 {
304 return (source_types_ & filter) != 0;
305 }
306
308 void add(ID *old_id, ID *new_id);
310 void add_overwrite(ID *old_id, ID *new_id);
311
315 const ID *id_self) const;
316
325 IDRemapperApplyResult apply(ID **r_id_ptr,
327 ID *id_self = nullptr) const;
328
330 {
331 never_null_users_.add(id);
332 }
333
335 {
336 return never_null_users_;
337 }
338
340 void iter(FunctionRef<void(ID *old_id, ID *new_id)> func) const
341 {
342 for (auto item : mappings_.items()) {
343 func(item.key, item.value);
344 }
345 }
346
349
351 void print() const;
352};
353
354} // namespace bke::id
355} // namespace blender
#define ATTR_NONNULL(...)
#define ENUM_OPERATORS(_enum_type)
IDRemapperApplyResult get_mapping_result(ID *id, IDRemapperApplyOptions options, const ID *id_self) const
IDRemapperApplyResult apply(ID **r_id_ptr, IDRemapperApplyOptions options, ID *id_self=nullptr) const
static StringRefNull result_to_string(const IDRemapperApplyResult result)
void iter(FunctionRef< void(ID *old_id, ID *new_id)> func) const
void add(ID *old_id, ID *new_id)
bool contains_mappings_for_any(IDTypeFilter filter) const
const Set< ID * > & never_null_users() const
void add_overwrite(ID *old_id, ID *new_id)
CCL_NAMESPACE_BEGIN struct Options options
BMesh Iterators.
@ ID_REMAP_RESULT_SOURCE_UNASSIGNED
@ ID_REMAP_RESULT_SOURCE_UNAVAILABLE
@ ID_REMAP_RESULT_SOURCE_REMAPPED
@ ID_REMAP_RESULT_SOURCE_NOT_MAPPABLE
unsigned __int64 uint64_t
Definition BKE_text.h:91
void(*)(const void *) BKE_library_free_notifier_reference_cb
void BKE_libblock_relink_ex(Main *bmain, void *idv, void *old_idv, void *new_idv, int remap_flags) ATTR_NONNULL(2)
Definition lib_remap.cc:855
@ ID_REMAP_TYPE_CLEANUP
@ ID_REMAP_TYPE_REMAP
void BKE_libblock_relink_to_newid(Main *bmain, ID *id, int remap_flag) ATTR_NONNULL()
Definition lib_remap.cc:932
void BKE_libblock_remap_multiple_raw(Main *bmain, bke::id::IDRemapper &mappings, const int remap_flags)
Definition lib_remap.cc:678
void(*)(const bke::id::IDRemapper &mappings) BKE_library_remap_editor_id_reference_cb
void void BKE_libblock_remap(Main *bmain, void *old_idv, void *new_idv, int remap_flags) ATTR_NONNULL(1
Definition lib_remap.cc:701
@ ID_REMAP_SKIP_NEVER_NULL_USAGE
@ ID_REMAP_FORCE_INTERNAL_RUNTIME_POINTERS
@ ID_REMAP_NO_ORIG_POINTERS_ACCESS
@ ID_REMAP_SKIP_INDIRECT_USAGE
@ ID_REMAP_SKIP_USER_REFCOUNT
@ ID_REMAP_FORCE_USER_REFCOUNT
@ ID_REMAP_FORCE_NEVER_NULL_USAGE
@ ID_REMAP_SKIP_OVERRIDE_LIBRARY
@ ID_REMAP_SKIP_USER_CLEAR
@ ID_REMAP_STORE_NEVER_NULL_USAGE
@ ID_REMAP_SKIP_UPDATE_TAGGING
@ ID_REMAP_DO_LIBRARY_POINTERS
@ ID_REMAP_FORCE_OBDATA_IN_EDITMODE
@ ID_REMAP_ALLOW_IDTYPE_MISMATCH
@ ID_REMAP_FORCE_UI_POINTERS
uint64_t IDTypeFilter
void(*)(ID *old_id, ID *new_id, void *user_data) IDRemapperIterFunction
void BKE_libblock_remap_locked(Main *bmain, void *old_idv, void *new_idv, int remap_flags) ATTR_NONNULL(1
Definition lib_remap.cc:692
void BKE_libblock_remap_multiple(Main *bmain, bke::id::IDRemapper &mappings, const int remap_flags)
Definition lib_remap.cc:710
void BKE_libblock_remap_multiple_locked(Main *bmain, bke::id::IDRemapper &mappings, const int remap_flags)
Definition lib_remap.cc:654
void BKE_library_callback_remap_editor_id_reference_set(BKE_library_remap_editor_id_reference_cb func)
Definition lib_remap.cc:55
@ ID_REMAP_APPLY_ENSURE_REAL
@ ID_REMAP_APPLY_UNMAP_WHEN_REMAPPING_TO_SELF
@ ID_REMAP_APPLY_DEFAULT
@ ID_REMAP_APPLY_UPDATE_REFCOUNT
void void void BKE_libblock_unlink(Main *bmain, void *idv, bool do_skip_indirect) ATTR_NONNULL()
Definition lib_remap.cc:719
void BKE_libblock_relink_multiple(Main *bmain, const Span< ID * > ids, eIDRemapType remap_type, bke::id::IDRemapper &id_remapper, int remap_flags)
Definition lib_remap.cc:793
void BKE_library_callback_free_notifier_reference_set(BKE_library_free_notifier_reference_cb func)
Definition lib_remap.cc:48