diff options
Diffstat (limited to 'source/blender/blenkernel/intern/workspace.c')
| -rw-r--r-- | source/blender/blenkernel/intern/workspace.c | 439 |
1 files changed, 222 insertions, 217 deletions
diff --git a/source/blender/blenkernel/intern/workspace.c b/source/blender/blenkernel/intern/workspace.c index e264856acb2..2e9591a99c7 100644 --- a/source/blender/blenkernel/intern/workspace.c +++ b/source/blender/blenkernel/intern/workspace.c @@ -42,15 +42,20 @@ #include "MEM_guardedalloc.h" - /* -------------------------------------------------------------------- */ /* Internal utils */ -static void workspace_layout_name_set( - WorkSpace *workspace, WorkSpaceLayout *layout, const char *new_name) +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)); + BLI_strncpy(layout->name, new_name, sizeof(layout->name)); + BLI_uniquename(&workspace->layouts, + layout, + "Layout", + '.', + offsetof(WorkSpaceLayout, name), + sizeof(layout->name)); } /** @@ -58,54 +63,53 @@ static void workspace_layout_name_set( * 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) +static WorkSpaceLayout *workspace_layout_find_exec(const WorkSpace *workspace, + const bScreen *screen) { - return BLI_findptr(&workspace->layouts, screen, offsetof(WorkSpaceLayout, screen)); + return BLI_findptr(&workspace->layouts, screen, offsetof(WorkSpaceLayout, screen)); } -static void workspace_relation_add( - ListBase *relation_list, void *parent, void *data) +static void workspace_relation_add(ListBase *relation_list, void *parent, void *data) { - WorkSpaceDataRelation *relation = MEM_callocN(sizeof(*relation), __func__); - relation->parent = parent; - relation->value = data; - /* add to head, if we switch back to it soon we find it faster. */ - BLI_addhead(relation_list, relation); + WorkSpaceDataRelation *relation = MEM_callocN(sizeof(*relation), __func__); + relation->parent = parent; + 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) +static void workspace_relation_remove(ListBase *relation_list, WorkSpaceDataRelation *relation) { - BLI_remlink(relation_list, relation); - MEM_freeN(relation); + BLI_remlink(relation_list, relation); + MEM_freeN(relation); } -static void workspace_relation_ensure_updated( - ListBase *relation_list, void *parent, void *data) +static void workspace_relation_ensure_updated(ListBase *relation_list, void *parent, void *data) { - WorkSpaceDataRelation *relation = BLI_findptr(relation_list, parent, offsetof(WorkSpaceDataRelation, parent)); - if (relation != NULL) { - 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, data); - } + WorkSpaceDataRelation *relation = BLI_findptr( + relation_list, parent, offsetof(WorkSpaceDataRelation, parent)); + if (relation != NULL) { + 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, data); + } } -static void *workspace_relation_get_data_matching_parent( - const ListBase *relation_list, const void *parent) +static void *workspace_relation_get_data_matching_parent(const ListBase *relation_list, + const void *parent) { - WorkSpaceDataRelation *relation = BLI_findptr(relation_list, parent, offsetof(WorkSpaceDataRelation, parent)); - if (relation != NULL) { - return relation->value; - } - else { - return NULL; - } + WorkSpaceDataRelation *relation = BLI_findptr( + relation_list, parent, offsetof(WorkSpaceDataRelation, parent)); + if (relation != NULL) { + return relation->value; + } + else { + return NULL; + } } /** @@ -118,15 +122,15 @@ static bool workspaces_is_screen_used #else static bool UNUSED_FUNCTION(workspaces_is_screen_used) #endif - (const Main *bmain, bScreen *screen) + (const Main *bmain, bScreen *screen) { - for (WorkSpace *workspace = bmain->workspaces.first; workspace; workspace = workspace->id.next) { - if (workspace_layout_find_exec(workspace, screen)) { - return true; - } - } + for (WorkSpace *workspace = bmain->workspaces.first; workspace; workspace = workspace->id.next) { + if (workspace_layout_find_exec(workspace, screen)) { + return true; + } + } - return false; + return false; } /* -------------------------------------------------------------------- */ @@ -134,8 +138,8 @@ static bool UNUSED_FUNCTION(workspaces_is_screen_used) WorkSpace *BKE_workspace_add(Main *bmain, const char *name) { - WorkSpace *new_workspace = BKE_libblock_alloc(bmain, ID_WS, name, 0); - return new_workspace; + WorkSpace *new_workspace = BKE_libblock_alloc(bmain, ID_WS, name, 0); + return new_workspace; } /** @@ -146,19 +150,19 @@ WorkSpace *BKE_workspace_add(Main *bmain, const char *name) */ void BKE_workspace_free(WorkSpace *workspace) { - BKE_workspace_relations_free(&workspace->hook_layout_relations); + BKE_workspace_relations_free(&workspace->hook_layout_relations); - BLI_freelistN(&workspace->owner_ids); - BLI_freelistN(&workspace->layouts); + BLI_freelistN(&workspace->owner_ids); + BLI_freelistN(&workspace->layouts); - while (!BLI_listbase_is_empty(&workspace->tools)) { - BKE_workspace_tool_remove(workspace, workspace->tools.first); - } + while (!BLI_listbase_is_empty(&workspace->tools)) { + BKE_workspace_tool_remove(workspace, workspace->tools.first); + } - if (workspace->status_text) { - MEM_freeN(workspace->status_text); - workspace->status_text = NULL; - } + if (workspace->status_text) { + MEM_freeN(workspace->status_text); + workspace->status_text = NULL; + } } /** @@ -170,102 +174,101 @@ void BKE_workspace_free(WorkSpace *workspace) */ void BKE_workspace_remove(Main *bmain, WorkSpace *workspace) { - for (WorkSpaceLayout *layout = 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); + for (WorkSpaceLayout *layout = 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) { - WorkSpaceInstanceHook *hook = MEM_callocN(sizeof(WorkSpaceInstanceHook), __func__); + WorkSpaceInstanceHook *hook = MEM_callocN(sizeof(WorkSpaceInstanceHook), __func__); - /* set an active screen-layout for each possible window/workspace combination */ - for (WorkSpace *workspace = bmain->workspaces.first; workspace; workspace = workspace->id.next) { - BKE_workspace_hook_layout_for_workspace_set(hook, workspace, workspace->layouts.first); - } + /* set an active screen-layout for each possible window/workspace combination */ + for (WorkSpace *workspace = bmain->workspaces.first; workspace; workspace = workspace->id.next) { + BKE_workspace_hook_layout_for_workspace_set(hook, workspace, workspace->layouts.first); + } - return hook; + 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) */ - BLI_assert(!BLI_listbase_is_empty(&bmain->workspaces)); + /* workspaces should never be freed before wm (during which we call this function) */ + BLI_assert(!BLI_listbase_is_empty(&bmain->workspaces)); - /* Free relations for this hook */ - for (WorkSpace *workspace = bmain->workspaces.first; workspace; workspace = workspace->id.next) { - for (WorkSpaceDataRelation *relation = 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); - } - } - } + /* Free relations for this hook */ + for (WorkSpace *workspace = bmain->workspaces.first; workspace; workspace = workspace->id.next) { + for (WorkSpaceDataRelation *relation = 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); + MEM_freeN(hook); } /** * Add a new layout to \a workspace for \a screen. */ -WorkSpaceLayout *BKE_workspace_layout_add( - Main *bmain, - WorkSpace *workspace, - bScreen *screen, - const char *name) +WorkSpaceLayout *BKE_workspace_layout_add(Main *bmain, + WorkSpace *workspace, + bScreen *screen, + const char *name) { - WorkSpaceLayout *layout = MEM_callocN(sizeof(*layout), __func__); + WorkSpaceLayout *layout = MEM_callocN(sizeof(*layout), __func__); - BLI_assert(!workspaces_is_screen_used(bmain, screen)); + BLI_assert(!workspaces_is_screen_used(bmain, screen)); #ifndef DEBUG - UNUSED_VARS(bmain); + 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); + layout->screen = screen; + id_us_plus(&layout->screen->id); + workspace_layout_name_set(workspace, layout, name); + BLI_addtail(&workspace->layouts, layout); - return layout; + return layout; } -void BKE_workspace_layout_remove( - Main *bmain, - WorkSpace *workspace, WorkSpaceLayout *layout) +void BKE_workspace_layout_remove(Main *bmain, WorkSpace *workspace, WorkSpaceLayout *layout) { - id_us_min(&layout->screen->id); - BKE_id_free(bmain, layout->screen); - BLI_freelinkN(&workspace->layouts, layout); + 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) +void BKE_workspace_relations_free(ListBase *relation_list) { - for (WorkSpaceDataRelation *relation = relation_list->first, *relation_next; relation; relation = relation_next) { - relation_next = relation->next; - workspace_relation_remove(relation_list, relation); - } + for (WorkSpaceDataRelation *relation = relation_list->first, *relation_next; relation; + relation = relation_next) { + relation_next = relation->next; + workspace_relation_remove(relation_list, relation); + } } /* -------------------------------------------------------------------- */ /* General Utils */ -WorkSpaceLayout *BKE_workspace_layout_find( - const WorkSpace *workspace, const bScreen *screen) +WorkSpaceLayout *BKE_workspace_layout_find(const WorkSpace *workspace, const bScreen *screen) { - WorkSpaceLayout *layout = workspace_layout_find_exec(workspace, screen); - if (layout) { - return layout; - } + 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); + 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 NULL; + return NULL; } /** @@ -274,27 +277,27 @@ WorkSpaceLayout *BKE_workspace_layout_find( * * \param r_workspace: Optionally return the workspace that contains the looked up layout (if found). */ -WorkSpaceLayout *BKE_workspace_layout_find_global( - const Main *bmain, const bScreen *screen, - WorkSpace **r_workspace) +WorkSpaceLayout *BKE_workspace_layout_find_global(const Main *bmain, + const bScreen *screen, + WorkSpace **r_workspace) { - WorkSpaceLayout *layout; + WorkSpaceLayout *layout; - if (r_workspace) { - *r_workspace = NULL; - } + if (r_workspace) { + *r_workspace = NULL; + } - for (WorkSpace *workspace = bmain->workspaces.first; workspace; workspace = workspace->id.next) { - if ((layout = workspace_layout_find_exec(workspace, screen))) { - if (r_workspace) { - *r_workspace = workspace; - } + for (WorkSpace *workspace = bmain->workspaces.first; workspace; workspace = workspace->id.next) { + if ((layout = workspace_layout_find_exec(workspace, screen))) { + if (r_workspace) { + *r_workspace = workspace; + } - return layout; - } - } + return layout; + } + } - return NULL; + return NULL; } /** @@ -305,47 +308,46 @@ WorkSpaceLayout *BKE_workspace_layout_find_global( * * \return the layout at which \a callback returned false. */ -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(&workspace->layouts, iter_layout, start) - { - if (!callback(iter_layout, arg)) { - return iter_layout; - } - } - LISTBASE_CIRCULAR_BACKWARD_END(&workspace->layouts, iter_layout, start); - } - else { - LISTBASE_CIRCULAR_FORWARD_BEGIN(&workspace->layouts, iter_layout, start) - { - if (!callback(iter_layout, arg)) { - return iter_layout; - } - } - LISTBASE_CIRCULAR_FORWARD_END(&workspace->layouts, iter_layout, start); - } - - return NULL; -} - -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); - MEM_freeN(tref->properties); - } - BLI_remlink(&workspace->tools, tref); - MEM_freeN(tref); +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 (&workspace->layouts, iter_layout, start) { + if (!callback(iter_layout, arg)) { + return iter_layout; + } + } + LISTBASE_CIRCULAR_BACKWARD_END(&workspace->layouts, iter_layout, start); + } + else { + LISTBASE_CIRCULAR_FORWARD_BEGIN (&workspace->layouts, iter_layout, start) { + if (!callback(iter_layout, arg)) { + return iter_layout; + } + } + LISTBASE_CIRCULAR_FORWARD_END(&workspace->layouts, iter_layout, start); + } + + return NULL; +} + +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); + MEM_freeN(tref->properties); + } + BLI_remlink(&workspace->tools, tref); + MEM_freeN(tref); } /* -------------------------------------------------------------------- */ @@ -353,84 +355,87 @@ void BKE_workspace_tool_remove( WorkSpace *BKE_workspace_active_get(WorkSpaceInstanceHook *hook) { - return hook->active; + return hook->active; } void BKE_workspace_active_set(WorkSpaceInstanceHook *hook, WorkSpace *workspace) { - hook->active = workspace; - if (workspace) { - WorkSpaceLayout *layout = workspace_relation_get_data_matching_parent(&workspace->hook_layout_relations, hook); - if (layout) { - hook->act_layout = layout; - } - } + hook->active = workspace; + if (workspace) { + WorkSpaceLayout *layout = 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; + return hook->act_layout; } void BKE_workspace_active_layout_set(WorkSpaceInstanceHook *hook, WorkSpaceLayout *layout) { - hook->act_layout = layout; + hook->act_layout = layout; } bScreen *BKE_workspace_active_screen_get(const WorkSpaceInstanceHook *hook) { - return hook->act_layout->screen; + return hook->act_layout->screen; } -void BKE_workspace_active_screen_set(WorkSpaceInstanceHook *hook, WorkSpace *workspace, bScreen *screen) +void BKE_workspace_active_screen_set(WorkSpaceInstanceHook *hook, + 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_hook_layout_for_workspace_set(hook, workspace, layout); + /* we need to find the WorkspaceLayout that wraps this screen */ + WorkSpaceLayout *layout = BKE_workspace_layout_find(hook->active, screen); + BKE_workspace_hook_layout_for_workspace_set(hook, workspace, layout); } ListBase *BKE_workspace_layouts_get(WorkSpace *workspace) { - return &workspace->layouts; + return &workspace->layouts; } const char *BKE_workspace_layout_name_get(const WorkSpaceLayout *layout) { - return layout->name; + return layout->name; } -void BKE_workspace_layout_name_set(WorkSpace *workspace, WorkSpaceLayout *layout, const char *new_name) +void BKE_workspace_layout_name_set(WorkSpace *workspace, + WorkSpaceLayout *layout, + const char *new_name) { - workspace_layout_name_set(workspace, layout, new_name); + workspace_layout_name_set(workspace, layout, new_name); } bScreen *BKE_workspace_layout_screen_get(const WorkSpaceLayout *layout) { - return layout->screen; + return layout->screen; } void BKE_workspace_layout_screen_set(WorkSpaceLayout *layout, bScreen *screen) { - layout->screen = screen; + layout->screen = screen; } -WorkSpaceLayout *BKE_workspace_hook_layout_for_workspace_get( - const WorkSpaceInstanceHook *hook, const WorkSpace *workspace) +WorkSpaceLayout *BKE_workspace_hook_layout_for_workspace_get(const WorkSpaceInstanceHook *hook, + const WorkSpace *workspace) { - return workspace_relation_get_data_matching_parent(&workspace->hook_layout_relations, hook); + return workspace_relation_get_data_matching_parent(&workspace->hook_layout_relations, hook); } -void BKE_workspace_hook_layout_for_workspace_set( - WorkSpaceInstanceHook *hook, WorkSpace *workspace, WorkSpaceLayout *layout) +void BKE_workspace_hook_layout_for_workspace_set(WorkSpaceInstanceHook *hook, + WorkSpace *workspace, + WorkSpaceLayout *layout) { - hook->act_layout = layout; - workspace_relation_ensure_updated(&workspace->hook_layout_relations, hook, layout); + hook->act_layout = layout; + workspace_relation_ensure_updated(&workspace->hook_layout_relations, hook, layout); } -bool BKE_workspace_owner_id_check( - const WorkSpace *workspace, const char *owner_id) +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; - } - else { - /* we could use hash lookup, for now this list is highly under < ~16 items. */ - return BLI_findstring(&workspace->owner_ids, owner_id, offsetof(wmOwnerID, name)) != NULL; - } + if ((*owner_id == '\0') || ((workspace->flags & WORKSPACE_USE_FILTER_BY_ORIGIN) == 0)) { + return true; + } + else { + /* we could use hash lookup, for now this list is highly under < ~16 items. */ + return BLI_findstring(&workspace->owner_ids, owner_id, offsetof(wmOwnerID, name)) != NULL; + } } |