This repository has been archived on 2023-10-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
blender-archive/source/blender/blenkernel/intern/workspace.cc
Bastien Montagne 30b34735e3 Cleanup/refactor: Add a new flag for IDTypes that are not read in memfile undo.
Currently only affects 'UI' IDs (WindowManager, Screen, etc.), but in
the future other types may be affected as well.

NOTE: this is only used in readfile code itself, not in the
post-processing performed by `setup_app_data`, as this code is too
specific for such generic handling.
2023-01-24 18:15:06 +01:00

622 lines
20 KiB
C++

/* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup bke
*/
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include "BLI_listbase.h"
#include "BLI_string.h"
#include "BLI_string_utils.h"
#include "BLI_utildefines.h"
#include "BLT_translation.h"
#include "BKE_asset.h"
#include "BKE_global.h"
#include "BKE_idprop.h"
#include "BKE_idtype.h"
#include "BKE_lib_id.h"
#include "BKE_lib_query.h"
#include "BKE_main.h"
#include "BKE_object.h"
#include "BKE_scene.h"
#include "BKE_viewer_path.h"
#include "BKE_workspace.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "DNA_screen_types.h"
#include "DNA_windowmanager_types.h"
#include "DNA_workspace_types.h"
#include "DEG_depsgraph.h"
#include "MEM_guardedalloc.h"
#include "BLO_read_write.h"
/* -------------------------------------------------------------------- */
static void workspace_init_data(ID *id)
{
WorkSpace *workspace = (WorkSpace *)id;
BKE_asset_library_reference_init_default(&workspace->asset_library_ref);
}
static void workspace_free_data(ID *id)
{
WorkSpace *workspace = (WorkSpace *)id;
BKE_workspace_relations_free(&workspace->hook_layout_relations);
BLI_freelistN(&workspace->owner_ids);
BLI_freelistN(&workspace->layouts);
while (!BLI_listbase_is_empty(&workspace->tools)) {
BKE_workspace_tool_remove(workspace, static_cast<bToolRef *>(workspace->tools.first));
}
MEM_SAFE_FREE(workspace->status_text);
BKE_viewer_path_clear(&workspace->viewer_path);
}
static void workspace_foreach_id(ID *id, LibraryForeachIDData *data)
{
WorkSpace *workspace = (WorkSpace *)id;
BKE_LIB_FOREACHID_PROCESS_IDSUPER(data, workspace->pin_scene, IDWALK_CB_NOP);
LISTBASE_FOREACH (WorkSpaceLayout *, layout, &workspace->layouts) {
BKE_LIB_FOREACHID_PROCESS_IDSUPER(data, layout->screen, IDWALK_CB_USER);
}
BKE_viewer_path_foreach_id(data, &workspace->viewer_path);
}
static void workspace_blend_write(BlendWriter *writer, ID *id, const void *id_address)
{
WorkSpace *workspace = (WorkSpace *)id;
BLO_write_id_struct(writer, WorkSpace, id_address, &workspace->id);
BKE_id_blend_write(writer, &workspace->id);
BLO_write_struct_list(writer, WorkSpaceLayout, &workspace->layouts);
BLO_write_struct_list(writer, WorkSpaceDataRelation, &workspace->hook_layout_relations);
BLO_write_struct_list(writer, wmOwnerID, &workspace->owner_ids);
BLO_write_struct_list(writer, bToolRef, &workspace->tools);
LISTBASE_FOREACH (bToolRef *, tref, &workspace->tools) {
if (tref->properties) {
IDP_BlendWrite(writer, tref->properties);
}
}
BKE_viewer_path_blend_write(writer, &workspace->viewer_path);
}
static void workspace_blend_read_data(BlendDataReader *reader, ID *id)
{
WorkSpace *workspace = (WorkSpace *)id;
BLO_read_list(reader, &workspace->layouts);
BLO_read_list(reader, &workspace->hook_layout_relations);
BLO_read_list(reader, &workspace->owner_ids);
BLO_read_list(reader, &workspace->tools);
LISTBASE_FOREACH (WorkSpaceDataRelation *, relation, &workspace->hook_layout_relations) {
/* Parent pointer does not belong to workspace data and is therefore restored in lib_link step
* of window manager. */
BLO_read_data_address(reader, &relation->value);
}
LISTBASE_FOREACH (bToolRef *, tref, &workspace->tools) {
tref->runtime = nullptr;
BLO_read_data_address(reader, &tref->properties);
IDP_BlendDataRead(reader, &tref->properties);
}
workspace->status_text = nullptr;
id_us_ensure_real(&workspace->id);
BKE_viewer_path_blend_read_data(reader, &workspace->viewer_path);
}
static void workspace_blend_read_lib(BlendLibReader *reader, ID *id)
{
WorkSpace *workspace = (WorkSpace *)id;
Main *bmain = BLO_read_lib_get_main(reader);
/* Do not keep the scene reference when appending a workspace. Setting a scene for a workspace is
* a convenience feature, but the workspace should never truly depend on scene data. */
if (ID_IS_LINKED(id)) {
workspace->pin_scene = nullptr;
}
else {
BLO_read_id_address(reader, nullptr, &workspace->pin_scene);
}
/* Restore proper 'parent' pointers to relevant data, and clean up unused/invalid entries. */
LISTBASE_FOREACH_MUTABLE (WorkSpaceDataRelation *, relation, &workspace->hook_layout_relations) {
relation->parent = nullptr;
LISTBASE_FOREACH (wmWindowManager *, wm, &bmain->wm) {
LISTBASE_FOREACH (wmWindow *, win, &wm->windows) {
if (win->winid == relation->parentid) {
relation->parent = win->workspace_hook;
}
}
}
if (relation->parent == nullptr) {
BLI_freelinkN(&workspace->hook_layout_relations, relation);
}
}
LISTBASE_FOREACH_MUTABLE (WorkSpaceLayout *, layout, &workspace->layouts) {
BLO_read_id_address(reader, id->lib, &layout->screen);
if (layout->screen) {
if (ID_IS_LINKED(id)) {
layout->screen->winid = 0;
if (layout->screen->temp) {
/* delete temp layouts when appending */
BKE_workspace_layout_remove(bmain, workspace, layout);
}
}
}
else {
/* If we're reading a layout without screen stored, it's useless and we shouldn't keep it
* around. */
BKE_workspace_layout_remove(bmain, workspace, layout);
}
}
BKE_viewer_path_blend_read_lib(reader, id->lib, &workspace->viewer_path);
}
static void workspace_blend_read_expand(BlendExpander *expander, ID *id)
{
WorkSpace *workspace = (WorkSpace *)id;
LISTBASE_FOREACH (WorkSpaceLayout *, layout, &workspace->layouts) {
BLO_expand(expander, BKE_workspace_layout_screen_get(layout));
}
}
IDTypeInfo IDType_ID_WS = {
/*id_code*/ ID_WS,
/*id_filter*/ FILTER_ID_WS,
/*main_listbase_index*/ INDEX_ID_WS,
/*struct_size*/ sizeof(WorkSpace),
/*name*/ "WorkSpace",
/*name_plural*/ "workspaces",
/*translation_context*/ BLT_I18NCONTEXT_ID_WORKSPACE,
/*flags*/ IDTYPE_FLAGS_NO_COPY | IDTYPE_FLAGS_ONLY_APPEND | IDTYPE_FLAGS_NO_ANIMDATA |
IDTYPE_FLAGS_NO_MEMFILE_UNDO,
/*asset_type_info*/ nullptr,
/*init_data*/ workspace_init_data,
/*copy_data*/ nullptr,
/*free_data*/ workspace_free_data,
/*make_local*/ nullptr,
/*foreach_id*/ workspace_foreach_id,
/*foreach_cache*/ nullptr,
/*foreach_path*/ nullptr,
/*owner_pointer_get*/ nullptr,
/*blend_write*/ workspace_blend_write,
/*blend_read_data*/ workspace_blend_read_data,
/*blend_read_lib*/ workspace_blend_read_lib,
/*blend_read_expand*/ workspace_blend_read_expand,
/*blend_read_undo_preserve*/ nullptr,
/*lib_override_apply_post*/ nullptr,
};
/* -------------------------------------------------------------------- */
/** \name Internal Utils
* \{ */
static void workspace_layout_name_set(WorkSpace *workspace,
WorkSpaceLayout *layout,
const char *new_name)
{
BLI_strncpy(layout->name, new_name, sizeof(layout->name));
BLI_uniquename(&workspace->layouts,
layout,
"Layout",
'.',
offsetof(WorkSpaceLayout, name),
sizeof(layout->name));
}
/**
* This should only be used directly when it is to be expected that there isn't
* a layout within \a workspace that wraps \a screen. Usually - especially outside
* of BKE_workspace - #BKE_workspace_layout_find should be used!
*/
static WorkSpaceLayout *workspace_layout_find_exec(const WorkSpace *workspace,
const bScreen *screen)
{
return static_cast<WorkSpaceLayout *>(
BLI_findptr(&workspace->layouts, screen, offsetof(WorkSpaceLayout, screen)));
}
static void workspace_relation_add(ListBase *relation_list,
void *parent,
const int parentid,
void *data)
{
WorkSpaceDataRelation *relation = MEM_cnew<WorkSpaceDataRelation>(__func__);
relation->parent = parent;
relation->parentid = parentid;
relation->value = data;
/* add to head, if we switch back to it soon we find it faster. */
BLI_addhead(relation_list, relation);
}
static void workspace_relation_remove(ListBase *relation_list, WorkSpaceDataRelation *relation)
{
BLI_remlink(relation_list, relation);
MEM_freeN(relation);
}
static void workspace_relation_ensure_updated(ListBase *relation_list,
void *parent,
const int parentid,
void *data)
{
WorkSpaceDataRelation *relation = static_cast<WorkSpaceDataRelation *>(BLI_listbase_bytes_find(
relation_list, &parentid, sizeof(parentid), offsetof(WorkSpaceDataRelation, parentid)));
if (relation != nullptr) {
relation->parent = parent;
relation->value = data;
/* reinsert at the head of the list, so that more commonly used relations are found faster. */
BLI_remlink(relation_list, relation);
BLI_addhead(relation_list, relation);
}
else {
/* no matching relation found, add new one */
workspace_relation_add(relation_list, parent, parentid, data);
}
}
static void *workspace_relation_get_data_matching_parent(const ListBase *relation_list,
const void *parent)
{
WorkSpaceDataRelation *relation = static_cast<WorkSpaceDataRelation *>(
BLI_findptr(relation_list, parent, offsetof(WorkSpaceDataRelation, parent)));
if (relation != nullptr) {
return relation->value;
}
return nullptr;
}
/**
* Checks if \a screen is already used within any workspace. A screen should never be assigned to
* multiple WorkSpaceLayouts, but that should be ensured outside of the BKE_workspace module
* and without such checks.
* Hence, this should only be used as assert check before assigning a screen to a workspace.
*/
#ifndef NDEBUG
static bool workspaces_is_screen_used
#else
static bool UNUSED_FUNCTION(workspaces_is_screen_used)
#endif
(const Main *bmain, bScreen *screen)
{
for (WorkSpace *workspace = static_cast<WorkSpace *>(bmain->workspaces.first); workspace;
workspace = static_cast<WorkSpace *>(workspace->id.next)) {
if (workspace_layout_find_exec(workspace, screen)) {
return true;
}
}
return false;
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Create, Delete, Init
* \{ */
WorkSpace *BKE_workspace_add(Main *bmain, const char *name)
{
WorkSpace *new_workspace = static_cast<WorkSpace *>(BKE_id_new(bmain, ID_WS, name));
id_us_ensure_real(&new_workspace->id);
return new_workspace;
}
void BKE_workspace_remove(Main *bmain, WorkSpace *workspace)
{
for (WorkSpaceLayout *layout = static_cast<WorkSpaceLayout *>(workspace->layouts.first),
*layout_next;
layout;
layout = layout_next) {
layout_next = layout->next;
BKE_workspace_layout_remove(bmain, workspace, layout);
}
BKE_id_free(bmain, workspace);
}
WorkSpaceInstanceHook *BKE_workspace_instance_hook_create(const Main *bmain, const int winid)
{
WorkSpaceInstanceHook *hook = MEM_cnew<WorkSpaceInstanceHook>(__func__);
/* set an active screen-layout for each possible window/workspace combination */
for (WorkSpace *workspace = static_cast<WorkSpace *>(bmain->workspaces.first); workspace;
workspace = static_cast<WorkSpace *>(workspace->id.next)) {
BKE_workspace_active_layout_set(
hook, winid, workspace, static_cast<WorkSpaceLayout *>(workspace->layouts.first));
}
return hook;
}
void BKE_workspace_instance_hook_free(const Main *bmain, WorkSpaceInstanceHook *hook)
{
/* workspaces should never be freed before wm (during which we call this function).
* However, when running in background mode, loading a blend file may allocate windows (that need
* to be freed) without creating workspaces. This happens in BlendfileLoadingBaseTest. */
BLI_assert(!BLI_listbase_is_empty(&bmain->workspaces) || G.background);
/* Free relations for this hook */
for (WorkSpace *workspace = static_cast<WorkSpace *>(bmain->workspaces.first); workspace;
workspace = static_cast<WorkSpace *>(workspace->id.next)) {
for (WorkSpaceDataRelation *relation = static_cast<WorkSpaceDataRelation *>(
workspace->hook_layout_relations.first),
*relation_next;
relation;
relation = relation_next) {
relation_next = relation->next;
if (relation->parent == hook) {
workspace_relation_remove(&workspace->hook_layout_relations, relation);
}
}
}
MEM_freeN(hook);
}
WorkSpaceLayout *BKE_workspace_layout_add(Main *bmain,
WorkSpace *workspace,
bScreen *screen,
const char *name)
{
WorkSpaceLayout *layout = MEM_cnew<WorkSpaceLayout>(__func__);
BLI_assert(!workspaces_is_screen_used(bmain, screen));
#ifndef DEBUG
UNUSED_VARS(bmain);
#endif
layout->screen = screen;
id_us_plus(&layout->screen->id);
workspace_layout_name_set(workspace, layout, name);
BLI_addtail(&workspace->layouts, layout);
return layout;
}
void BKE_workspace_layout_remove(Main *bmain, WorkSpace *workspace, WorkSpaceLayout *layout)
{
/* Screen should usually be set, but we call this from file reading to get rid of invalid
* layouts. */
if (layout->screen) {
id_us_min(&layout->screen->id);
BKE_id_free(bmain, layout->screen);
}
BLI_freelinkN(&workspace->layouts, layout);
}
void BKE_workspace_relations_free(ListBase *relation_list)
{
for (WorkSpaceDataRelation *
relation = static_cast<WorkSpaceDataRelation *>(relation_list->first),
*relation_next;
relation;
relation = relation_next) {
relation_next = relation->next;
workspace_relation_remove(relation_list, relation);
}
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name General Utils
* \{ */
WorkSpaceLayout *BKE_workspace_layout_find(const WorkSpace *workspace, const bScreen *screen)
{
WorkSpaceLayout *layout = workspace_layout_find_exec(workspace, screen);
if (layout) {
return layout;
}
printf(
"%s: Couldn't find layout in this workspace: '%s' screen: '%s'. "
"This should not happen!\n",
__func__,
workspace->id.name + 2,
screen->id.name + 2);
return nullptr;
}
WorkSpaceLayout *BKE_workspace_layout_find_global(const Main *bmain,
const bScreen *screen,
WorkSpace **r_workspace)
{
WorkSpaceLayout *layout;
if (r_workspace) {
*r_workspace = nullptr;
}
for (WorkSpace *workspace = static_cast<WorkSpace *>(bmain->workspaces.first); workspace;
workspace = static_cast<WorkSpace *>(workspace->id.next)) {
if ((layout = workspace_layout_find_exec(workspace, screen))) {
if (r_workspace) {
*r_workspace = workspace;
}
return layout;
}
}
return nullptr;
}
WorkSpaceLayout *BKE_workspace_layout_iter_circular(const WorkSpace *workspace,
WorkSpaceLayout *start,
bool (*callback)(const WorkSpaceLayout *layout,
void *arg),
void *arg,
const bool iter_backward)
{
WorkSpaceLayout *iter_layout;
if (iter_backward) {
LISTBASE_CIRCULAR_BACKWARD_BEGIN (WorkSpaceLayout *, &workspace->layouts, iter_layout, start) {
if (!callback(iter_layout, arg)) {
return iter_layout;
}
}
LISTBASE_CIRCULAR_BACKWARD_END(WorkSpaceLayout *, &workspace->layouts, iter_layout, start);
}
else {
LISTBASE_CIRCULAR_FORWARD_BEGIN (WorkSpaceLayout *, &workspace->layouts, iter_layout, start) {
if (!callback(iter_layout, arg)) {
return iter_layout;
}
}
LISTBASE_CIRCULAR_FORWARD_END(WorkSpaceLayout *, &workspace->layouts, iter_layout, start);
}
return nullptr;
}
void BKE_workspace_tool_remove(struct WorkSpace *workspace, struct bToolRef *tref)
{
if (tref->runtime) {
MEM_freeN(tref->runtime);
}
if (tref->properties) {
IDP_FreeProperty(tref->properties);
}
BLI_remlink(&workspace->tools, tref);
MEM_freeN(tref);
}
bool BKE_workspace_owner_id_check(const WorkSpace *workspace, const char *owner_id)
{
if ((*owner_id == '\0') || ((workspace->flags & WORKSPACE_USE_FILTER_BY_ORIGIN) == 0)) {
return true;
}
/* We could use hash lookup, for now this list is highly likely under < ~16 items. */
return BLI_findstring(&workspace->owner_ids, owner_id, offsetof(wmOwnerID, name)) != nullptr;
}
void BKE_workspace_id_tag_all_visible(Main *bmain, int tag)
{
BKE_main_id_tag_listbase(&bmain->workspaces, tag, false);
wmWindowManager *wm = static_cast<wmWindowManager *>(bmain->wm.first);
LISTBASE_FOREACH (wmWindow *, win, &wm->windows) {
WorkSpace *workspace = BKE_workspace_active_get(win->workspace_hook);
workspace->id.tag |= tag;
}
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Getters/Setters
* \{ */
WorkSpace *BKE_workspace_active_get(WorkSpaceInstanceHook *hook)
{
return hook->active;
}
void BKE_workspace_active_set(WorkSpaceInstanceHook *hook, WorkSpace *workspace)
{
/* DO NOT check for `hook->active == workspace` here. Caller code is supposed to do it if
* that optimization is possible and needed.
* This code can be called from places where we might have this equality, but still want to
* ensure/update the active layout below.
* Known case where this is buggy and will crash later due to nullptr active layout: reading
* a blend file, when the new read workspace ID happens to have the exact same memory address
* as when it was saved in the blend file (extremely unlikely, but possible). */
hook->active = workspace;
if (workspace) {
WorkSpaceLayout *layout = static_cast<WorkSpaceLayout *>(
workspace_relation_get_data_matching_parent(&workspace->hook_layout_relations, hook));
if (layout) {
hook->act_layout = layout;
}
}
}
WorkSpaceLayout *BKE_workspace_active_layout_get(const WorkSpaceInstanceHook *hook)
{
return hook->act_layout;
}
WorkSpaceLayout *BKE_workspace_active_layout_for_workspace_get(const WorkSpaceInstanceHook *hook,
const WorkSpace *workspace)
{
/* If the workspace is active, the active layout can be returned, no need for a lookup. */
if (hook->active == workspace) {
return hook->act_layout;
}
/* Inactive workspace */
return static_cast<WorkSpaceLayout *>(
workspace_relation_get_data_matching_parent(&workspace->hook_layout_relations, hook));
}
void BKE_workspace_active_layout_set(WorkSpaceInstanceHook *hook,
const int winid,
WorkSpace *workspace,
WorkSpaceLayout *layout)
{
hook->act_layout = layout;
workspace_relation_ensure_updated(&workspace->hook_layout_relations, hook, winid, layout);
}
bScreen *BKE_workspace_active_screen_get(const WorkSpaceInstanceHook *hook)
{
return hook->act_layout->screen;
}
void BKE_workspace_active_screen_set(WorkSpaceInstanceHook *hook,
const int winid,
WorkSpace *workspace,
bScreen *screen)
{
/* we need to find the WorkspaceLayout that wraps this screen */
WorkSpaceLayout *layout = BKE_workspace_layout_find(hook->active, screen);
BKE_workspace_active_layout_set(hook, winid, workspace, layout);
}
const char *BKE_workspace_layout_name_get(const WorkSpaceLayout *layout)
{
return layout->name;
}
void BKE_workspace_layout_name_set(WorkSpace *workspace,
WorkSpaceLayout *layout,
const char *new_name)
{
workspace_layout_name_set(workspace, layout, new_name);
}
bScreen *BKE_workspace_layout_screen_get(const WorkSpaceLayout *layout)
{
return layout->screen;
}
/** \} */