griefith/test2
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

PartialWriteContext: add the 'clipboard mark' new operation option.

Browse Source 
This is used by ID copy/paste code to detect which IDs from a copy/paste
buffer can be used as paste source.

Also slightly refactor implementation to handle both fake/extra ID user,
and clipboard mark in the same utils function.
This commit is contained in:
Bastien Montagne
2024-07-18 12:47:11 +02:00
parent 0c6365ecad
commit 7a87233c85
2 changed files with 62 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
source/blender/blenkernel/BKE_blendfile.hh
View File

@@ -204,36 +204,6 @@ class PartialWriteContext : NonCopyable, NonMovable {
/** A mapping from the absolute library paths to the #Library IDs in the context. */
blender::Map<std::string, Library *> libraries_map_;
/**
* In case an explicitly added ID has the same session_uid as an existing one in current
* context, the added one should be able to 'steal' that session_uid in the context, and
* re-assign a new one to the other ID.
*/
void preempt_session_uid(ID *ctx_id, unsigned int session_uid);
/**
* Ensures that given ID will be written on disk (within current context).
*
* This is achieved either by setting the 'fake user' flag, or the (runtime-only, cleared on next
* file load) 'extra user' tag. */
void ensure_id_user(ID *ctx_id, bool set_fake_user);
/**
* Utils for #PartialWriteContext::id_add, only adds (duplicate) the given source ID into
* current context.
*/
ID *id_add_copy(const ID *id, bool regenerate_session_uid);
/** Make given context ID local to the context. */
void make_local(ID *ctx_id, int make_local_flags);
/**
* Ensure that the given ID's library has a matching Library ID in the context, copying the
* current `ctx_id->lib` one if needed.
*/
Library *ensure_library(ID *ctx_id);
/**
* Ensure that the given library path has a matching Library ID in the context, creating a new
* one if needed.
*/
Library *ensure_library(StringRefNull library_absolute_path);
public:
/* Passing a reference root filepath is mandatory, for remapping of relative paths to work as
* expected. */
@@ -268,10 +238,15 @@ class PartialWriteContext : NonCopyable, NonMovable {
*/
MAKE_LOCAL = 1 << 0,
/**
* Set the 'fake user' flag to added ID. Ensures that it is never auto-removed from the
* Set the 'fake user' flag to the added ID. Ensures that it is never auto-removed from the
* context, and always written to disk.
*/
SET_FAKE_USER = 1 << 1,
/**
* Set the 'clipboard' flag to the added ID. Ensures that it is treated as potential cource
* data for a 'paste ID' operation.
*/
SET_CLIPBOARD_MARK = 1 << 4,
/**
* Clear all dependency IDs that are not in the partial write context. Mutually exclusive with
* #ADD_DEPENDENCIES.
@@ -309,9 +284,10 @@ class PartialWriteContext : NonCopyable, NonMovable {
*
* \param options: Control how the added ID (and its dependencies) are handled. See
* #IDAddOptions and #IDAddOperations above for details.
* \param dependencies_filter_cb: optional, a callback called for each ID usages. Currently, only
* accepted return values are #MAKE_LOCAL, #SET_FAKE_USER, and
* #ADD_DEPENDENCIES or #CLEAR_DEPENDENCIES.
* \param dependencies_filter_cb: Optional, a callback called for each ID usages. Currently, only
* accepted return values are #MAKE_LOCAL, #SET_FAKE_USER,
* #SET_CLIPBOARD_MARK, and #ADD_DEPENDENCIES or
* #CLEAR_DEPENDENCIES.
*
* \return The pointer to the duplicated ID in the partial write context.
*/
@@ -331,7 +307,8 @@ class PartialWriteContext : NonCopyable, NonMovable {
*
* \param options: Control how the added ID (and its dependencies) are handled. See
* #IDAddOptions and #IDAddOperations above for details, note that only
* relevant operation currently is the #SET_FAKE_USER one.
* relevant operations currently are the #SET_FAKE_USER and #SET_CLIPBOARD_MARK
* ones.
*/
ID *id_create(short id_type, StringRefNull id_name, Library *library, IDAddOptions options);
@@ -391,6 +368,38 @@ class PartialWriteContext : NonCopyable, NonMovable {
* loaded-from-disk temp context will have different root-path than the data from current
* G_MAIN.
*/
private:
/**
* In case an explicitly added ID has the same session_uid as an existing one in current
* context, the added one should be able to 'steal' that session_uid in the context, and
* re-assign a new one to the other ID.
*/
void preempt_session_uid(ID *ctx_id, unsigned int session_uid);
/**
* Ensures that given ID will be written on disk (within current context), by either setting the
* 'fake user' flag, or the (runtime-only, cleared on next file load) 'extra user' tag, depending
* on whether #SET_FAKE_USER is set or not.
*
* Also handles the setting of the #LIB_CLIPBOARD_MARK flag if #SET_CLIPBOARD_MARK is set. */
void process_added_id(ID *ctx_id, const IDAddOperations operations);
/**
* Utils for #PartialWriteContext::id_add, only adds (duplicate) the given source ID into
* current context.
*/
ID *id_add_copy(const ID *id, bool regenerate_session_uid);
/** Make given context ID local to the context. */
void make_local(ID *ctx_id, int make_local_flags);
/**
* Ensure that the given ID's library has a matching Library ID in the context, copying the
* current `ctx_id->lib` one if needed.
*/
Library *ensure_library(ID *ctx_id);
/**
* Ensure that the given library path has a matching Library ID in the context, creating a new
* one if needed.
*/
Library *ensure_library(StringRefNull library_absolute_path);
};
} // namespace blender::bke::blendfile

32
source/blender/blenkernel/intern/blendfile.cc
View File

@@ -1720,8 +1720,12 @@ void PartialWriteContext::preempt_session_uid(ID *ctx_id, uint session_uid)
ctx_id->session_uid = session_uid;
}
void PartialWriteContext::ensure_id_user(ID *ctx_id, const bool set_fake_user)
void PartialWriteContext::process_added_id(ID *ctx_id,
const PartialWriteContext::IDAddOperations operations)
{
const bool set_fake_user = (operations & SET_FAKE_USER) != 0;
const bool set_clipboard_mark = (operations & SET_CLIPBOARD_MARK) != 0;
if (set_fake_user) {
id_fake_user_set(ctx_id);
}
@@ -1730,6 +1734,10 @@ void PartialWriteContext::ensure_id_user(ID *ctx_id, const bool set_fake_user)
* context session). However, reloading the blendfile will clear this tag. */
id_us_ensure_real(ctx_id);
}
if (set_clipboard_mark) {
ctx_id->flag |= LIB_CLIPBOARD_MARK;
}
}
ID *PartialWriteContext::id_add_copy(const ID *id, const bool regenerate_session_uid)
@@ -1810,11 +1818,10 @@ ID *PartialWriteContext::id_add(
constexpr int make_local_flags = (LIB_ID_MAKELOCAL_INDIRECT | LIB_ID_MAKELOCAL_FORCE_LOCAL |
LIB_ID_MAKELOCAL_LIBOVERRIDE_CLEAR);
const bool set_fake_user = (options.operations & SET_FAKE_USER) != 0;
const bool add_dependencies = (options.operations & ADD_DEPENDENCIES) != 0;
const bool clear_dependencies = (options.operations & CLEAR_DEPENDENCIES) != 0;
const bool duplicate_dependencies = (options.operations & DUPLICATE_DEPENDENCIES) != 0;
BLI_assert(clear_dependencies || add_dependencies);
BLI_assert(clear_dependencies || add_dependencies || dependencies_filter_cb);
BLI_assert(!clear_dependencies || !(add_dependencies || duplicate_dependencies));
UNUSED_VARS_NDEBUG(add_dependencies, clear_dependencies, duplicate_dependencies);
@@ -1829,7 +1836,7 @@ ID *PartialWriteContext::id_add(
/* If the root orig ID is already in the context, assume all of its dependencies are as well.
*/
BLI_assert(ctx_root_id->session_uid == id->session_uid);
this->ensure_id_user(ctx_root_id, set_fake_user);
this->process_added_id(ctx_root_id, options.operations);
return ctx_root_id;
}
@@ -1847,7 +1854,7 @@ ID *PartialWriteContext::id_add(
BLI_assert(ctx_root_id->session_uid == id->session_uid);
local_ctx_id_map.add(id, ctx_root_id);
post_process_ids_todo.append({ctx_root_id, options.operations});
this->ensure_id_user(ctx_root_id, set_fake_user);
this->process_added_id(ctx_root_id, options.operations);
blender::VectorSet<ID *> ids_to_process{ctx_root_id};
auto dependencies_cb = [this,
@@ -1857,8 +1864,8 @@ ID *PartialWriteContext::id_add(
&post_process_ids_todo,
dependencies_filter_cb](LibraryIDLinkCallbackData *cb_data) -> int {
constexpr PartialWriteContext::IDAddOperations per_id_operations_filter =
PartialWriteContext::IDAddOperations(MAKE_LOCAL | SET_FAKE_USER | CLEAR_DEPENDENCIES |
ADD_DEPENDENCIES);
PartialWriteContext::IDAddOperations(MAKE_LOCAL | SET_FAKE_USER | SET_CLIPBOARD_MARK |
CLEAR_DEPENDENCIES | ADD_DEPENDENCIES);
ID **id_ptr = cb_data->id_pointer;
const ID *orig_deps_id = *id_ptr;
@@ -1877,14 +1884,13 @@ ID *PartialWriteContext::id_add(
PartialWriteContext::IDAddOperations operations_final = options.operations;
if (dependencies_filter_cb) {
PartialWriteContext::IDAddOperations operations_per_id = dependencies_filter_cb(cb_data,
options);
const PartialWriteContext::IDAddOperations operations_per_id = dependencies_filter_cb(
cb_data, options);
operations_final = PartialWriteContext::IDAddOperations(
(operations_per_id & per_id_operations_filter) |
(options.operations & ~per_id_operations_filter));
}
const bool set_fake_user = (operations_final & SET_FAKE_USER) != 0;
const bool add_dependencies = (operations_final & ADD_DEPENDENCIES) != 0;
const bool clear_dependencies = (operations_final & CLEAR_DEPENDENCIES) != 0;
const bool duplicate_dependencies = (operations_final & DUPLICATE_DEPENDENCIES) != 0;
@@ -1941,7 +1947,7 @@ ID *PartialWriteContext::id_add(
else {
BLI_assert(ctx_deps_id->session_uid == orig_deps_id->session_uid);
}
this->ensure_id_user(ctx_deps_id, set_fake_user);
this->process_added_id(ctx_deps_id, operations_final);
/* In-place remapping. */
*id_ptr = ctx_deps_id;
return IDWALK_RET_NOP;
@@ -1973,8 +1979,6 @@ ID *PartialWriteContext::id_create(const short id_type,
Library *library,
PartialWriteContext::IDAddOptions options)
{
const bool set_fake_user = (options.operations & SET_FAKE_USER) != 0;
Library *ctx_library = nullptr;
if (library) {
ctx_library = this->ensure_library(library->runtime.filepath_abs);
@@ -1983,7 +1987,7 @@ ID *PartialWriteContext::id_create(const short id_type,
BKE_id_new_in_lib(&this->bmain, ctx_library, id_type, id_name.c_str()));
ctx_id->tag |= LIB_TAG_TEMP_MAIN;
id_us_min(ctx_id);
this->ensure_id_user(ctx_id, set_fake_user);
this->process_added_id(ctx_id, options.operations);
/* See function doc about why handling of #matching_uid_map_ can be skipped here. */
BKE_main_idmap_insert_id(this->bmain.id_map, ctx_id);
return ctx_id;