tornavis/source/blender/blenkernel/intern/context.c

1542 lines
37 KiB
C

/* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup bke
*/
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include "MEM_guardedalloc.h"
#include "DNA_collection_types.h"
#include "DNA_gpencil_types.h"
#include "DNA_linestyle_types.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "DNA_screen_types.h"
#include "DNA_space_types.h"
#include "DNA_view3d_types.h"
#include "DNA_windowmanager_types.h"
#include "DNA_workspace_types.h"
#include "DEG_depsgraph.h"
#include "BLI_listbase.h"
#include "BLI_string.h"
#include "BLI_threads.h"
#include "BLI_utildefines.h"
#include "BLT_translation.h"
#include "BKE_context.h"
#include "BKE_layer.h"
#include "BKE_main.h"
#include "BKE_scene.h"
#include "BKE_screen.h"
#include "BKE_sound.h"
#include "BKE_workspace.h"
#include "RE_engine.h"
#include "RNA_access.h"
#include "RNA_prototypes.h"
#include "CLG_log.h"
#ifdef WITH_PYTHON
# include "BPY_extern.h"
#endif
static CLG_LogRef LOG = {"bke.context"};
/* struct */
struct bContext {
int thread;
/* windowmanager context */
struct {
struct wmWindowManager *manager;
struct wmWindow *window;
struct WorkSpace *workspace;
struct bScreen *screen;
struct ScrArea *area;
struct ARegion *region;
struct ARegion *menu;
struct wmGizmoGroup *gizmo_group;
struct bContextStore *store;
/* Operator poll. */
/**
* Store the reason the poll function fails (static string, not allocated).
* For more advanced formatting use `operator_poll_msg_dyn_params`.
*/
const char *operator_poll_msg;
/**
* Store values to dynamically to create the string (called when a tool-tip is shown).
*/
struct bContextPollMsgDyn_Params operator_poll_msg_dyn_params;
} wm;
/* data context */
struct {
struct Main *main;
struct Scene *scene;
int recursion;
/** True if python is initialized. */
bool py_init;
void *py_context;
/**
* If we need to remove members, do so in a copy
* (keep this to check if the copy needs freeing).
*/
void *py_context_orig;
} data;
};
/* context */
bContext *CTX_create(void)
{
bContext *C = MEM_callocN(sizeof(bContext), "bContext");
return C;
}
bContext *CTX_copy(const bContext *C)
{
bContext *newC = MEM_dupallocN((void *)C);
memset(&newC->wm.operator_poll_msg_dyn_params, 0, sizeof(newC->wm.operator_poll_msg_dyn_params));
return newC;
}
void CTX_free(bContext *C)
{
/* This may contain a dynamically allocated message, free. */
CTX_wm_operator_poll_msg_clear(C);
MEM_freeN(C);
}
/* store */
bContextStore *CTX_store_add(ListBase *contexts, const char *name, const PointerRNA *ptr)
{
/* ensure we have a context to put the entry in, if it was already used
* we have to copy the context to ensure */
bContextStore *ctx = contexts->last;
if (!ctx || ctx->used) {
if (ctx) {
bContextStore *lastctx = ctx;
ctx = MEM_dupallocN(lastctx);
BLI_duplicatelist(&ctx->entries, &lastctx->entries);
}
else {
ctx = MEM_callocN(sizeof(bContextStore), "bContextStore");
}
BLI_addtail(contexts, ctx);
}
bContextStoreEntry *entry = MEM_callocN(sizeof(bContextStoreEntry), "bContextStoreEntry");
BLI_strncpy(entry->name, name, sizeof(entry->name));
entry->ptr = *ptr;
BLI_addtail(&ctx->entries, entry);
return ctx;
}
bContextStore *CTX_store_add_all(ListBase *contexts, bContextStore *context)
{
/* ensure we have a context to put the entries in, if it was already used
* we have to copy the context to ensure */
bContextStore *ctx = contexts->last;
if (!ctx || ctx->used) {
if (ctx) {
bContextStore *lastctx = ctx;
ctx = MEM_dupallocN(lastctx);
BLI_duplicatelist(&ctx->entries, &lastctx->entries);
}
else {
ctx = MEM_callocN(sizeof(bContextStore), "bContextStore");
}
BLI_addtail(contexts, ctx);
}
LISTBASE_FOREACH (bContextStoreEntry *, tentry, &context->entries) {
bContextStoreEntry *entry = MEM_dupallocN(tentry);
BLI_addtail(&ctx->entries, entry);
}
return ctx;
}
bContextStore *CTX_store_get(bContext *C)
{
return C->wm.store;
}
void CTX_store_set(bContext *C, bContextStore *store)
{
C->wm.store = store;
}
const PointerRNA *CTX_store_ptr_lookup(const bContextStore *store,
const char *name,
const StructRNA *type)
{
bContextStoreEntry *entry = BLI_rfindstring(
&store->entries, name, offsetof(bContextStoreEntry, name));
if (!entry) {
return NULL;
}
if (type && !RNA_struct_is_a(entry->ptr.type, type)) {
return NULL;
}
return &entry->ptr;
}
bContextStore *CTX_store_copy(bContextStore *store)
{
bContextStore *ctx = MEM_dupallocN(store);
BLI_duplicatelist(&ctx->entries, &store->entries);
return ctx;
}
void CTX_store_free(bContextStore *store)
{
BLI_freelistN(&store->entries);
MEM_freeN(store);
}
void CTX_store_free_list(ListBase *contexts)
{
bContextStore *ctx;
while ((ctx = BLI_pophead(contexts))) {
CTX_store_free(ctx);
}
}
/* is python initialized? */
bool CTX_py_init_get(bContext *C)
{
return C->data.py_init;
}
void CTX_py_init_set(bContext *C, bool value)
{
C->data.py_init = value;
}
void *CTX_py_dict_get(const bContext *C)
{
return C->data.py_context;
}
void *CTX_py_dict_get_orig(const bContext *C)
{
return C->data.py_context_orig;
}
void CTX_py_state_push(bContext *C, struct bContext_PyState *pystate, void *value)
{
pystate->py_context = C->data.py_context;
pystate->py_context_orig = C->data.py_context_orig;
C->data.py_context = value;
C->data.py_context_orig = value;
}
void CTX_py_state_pop(bContext *C, struct bContext_PyState *pystate)
{
C->data.py_context = pystate->py_context;
C->data.py_context_orig = pystate->py_context_orig;
}
/* data context utility functions */
struct bContextDataResult {
PointerRNA ptr;
ListBase list;
const char **dir;
short type; /* 0: normal, 1: seq */
};
static void *ctx_wm_python_context_get(const bContext *C,
const char *member,
const StructRNA *member_type,
void *fall_through)
{
#ifdef WITH_PYTHON
if (UNLIKELY(C && CTX_py_dict_get(C))) {
bContextDataResult result;
memset(&result, 0, sizeof(bContextDataResult));
BPY_context_member_get((bContext *)C, member, &result);
if (result.ptr.data) {
if (RNA_struct_is_a(result.ptr.type, member_type)) {
return result.ptr.data;
}
CLOG_WARN(&LOG,
"PyContext '%s' is a '%s', expected a '%s'",
member,
RNA_struct_identifier(result.ptr.type),
RNA_struct_identifier(member_type));
}
}
#else
UNUSED_VARS(C, member, member_type);
#endif
/* don't allow UI context access from non-main threads */
if (!BLI_thread_is_main()) {
return NULL;
}
return fall_through;
}
static eContextResult ctx_data_get(bContext *C, const char *member, bContextDataResult *result)
{
bScreen *screen;
ScrArea *area;
ARegion *region;
int done = 0, recursion = C->data.recursion;
int ret = 0;
memset(result, 0, sizeof(bContextDataResult));
#ifdef WITH_PYTHON
if (CTX_py_dict_get(C)) {
if (BPY_context_member_get(C, member, result)) {
return 1;
}
}
#endif
/* don't allow UI context access from non-main threads */
if (!BLI_thread_is_main()) {
return done;
}
/* we check recursion to ensure that we do not get infinite
* loops requesting data from ourselves in a context callback */
/* Ok, this looks evil...
* if (ret) done = -(-ret | -done);
*
* Values in order of importance
* (0, -1, 1) - Where 1 is highest priority
*/
if (done != 1 && recursion < 1 && C->wm.store) {
C->data.recursion = 1;
const PointerRNA *ptr = CTX_store_ptr_lookup(C->wm.store, member, NULL);
if (ptr) {
result->ptr = *ptr;
done = 1;
}
}
if (done != 1 && recursion < 2 && (region = CTX_wm_region(C))) {
C->data.recursion = 2;
if (region->type && region->type->context) {
ret = region->type->context(C, member, result);
if (ret) {
done = -(-ret | -done);
}
}
}
if (done != 1 && recursion < 3 && (area = CTX_wm_area(C))) {
C->data.recursion = 3;
if (area->type && area->type->context) {
ret = area->type->context(C, member, result);
if (ret) {
done = -(-ret | -done);
}
}
}
if (done != 1 && recursion < 4 && (screen = CTX_wm_screen(C))) {
bContextDataCallback cb = screen->context;
C->data.recursion = 4;
if (cb) {
ret = cb(C, member, result);
if (ret) {
done = -(-ret | -done);
}
}
}
C->data.recursion = recursion;
return done;
}
static void *ctx_data_pointer_get(const bContext *C, const char *member)
{
bContextDataResult result;
if (C && ctx_data_get((bContext *)C, member, &result) == CTX_RESULT_OK) {
BLI_assert(result.type == CTX_DATA_TYPE_POINTER);
return result.ptr.data;
}
return NULL;
}
static int ctx_data_pointer_verify(const bContext *C, const char *member, void **pointer)
{
/* if context is NULL, pointer must be NULL too and that is a valid return */
if (C == NULL) {
*pointer = NULL;
return 1;
}
bContextDataResult result;
if (ctx_data_get((bContext *)C, member, &result) == CTX_RESULT_OK) {
BLI_assert(result.type == CTX_DATA_TYPE_POINTER);
*pointer = result.ptr.data;
return 1;
}
*pointer = NULL;
return 0;
}
static int ctx_data_collection_get(const bContext *C, const char *member, ListBase *list)
{
bContextDataResult result;
if (ctx_data_get((bContext *)C, member, &result) == CTX_RESULT_OK) {
BLI_assert(result.type == CTX_DATA_TYPE_COLLECTION);
*list = result.list;
return 1;
}
BLI_listbase_clear(list);
return 0;
}
static int ctx_data_base_collection_get(const bContext *C, const char *member, ListBase *list)
{
ListBase ctx_object_list;
if ((ctx_data_collection_get(C, member, &ctx_object_list) == false) ||
BLI_listbase_is_empty(&ctx_object_list)) {
BLI_listbase_clear(list);
return 0;
}
bContextDataResult result;
memset(&result, 0, sizeof(bContextDataResult));
Scene *scene = CTX_data_scene(C);
ViewLayer *view_layer = CTX_data_view_layer(C);
bool ok = false;
CollectionPointerLink *ctx_object;
for (ctx_object = ctx_object_list.first; ctx_object; ctx_object = ctx_object->next) {
Object *ob = ctx_object->ptr.data;
Base *base = BKE_view_layer_base_find(view_layer, ob);
if (base != NULL) {
CTX_data_list_add(&result, &scene->id, &RNA_ObjectBase, base);
ok = true;
}
}
CTX_data_type_set(&result, CTX_DATA_TYPE_COLLECTION);
BLI_freelistN(&ctx_object_list);
*list = result.list;
return ok;
}
PointerRNA CTX_data_pointer_get(const bContext *C, const char *member)
{
bContextDataResult result;
if (ctx_data_get((bContext *)C, member, &result) == CTX_RESULT_OK) {
BLI_assert(result.type == CTX_DATA_TYPE_POINTER);
return result.ptr;
}
return PointerRNA_NULL;
}
PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type)
{
PointerRNA ptr = CTX_data_pointer_get(C, member);
if (ptr.data) {
if (RNA_struct_is_a(ptr.type, type)) {
return ptr;
}
CLOG_WARN(&LOG,
"member '%s' is '%s', not '%s'",
member,
RNA_struct_identifier(ptr.type),
RNA_struct_identifier(type));
}
return PointerRNA_NULL;
}
PointerRNA CTX_data_pointer_get_type_silent(const bContext *C, const char *member, StructRNA *type)
{
PointerRNA ptr = CTX_data_pointer_get(C, member);
if (ptr.data && RNA_struct_is_a(ptr.type, type)) {
return ptr;
}
return PointerRNA_NULL;
}
ListBase CTX_data_collection_get(const bContext *C, const char *member)
{
bContextDataResult result;
if (ctx_data_get((bContext *)C, member, &result) == CTX_RESULT_OK) {
BLI_assert(result.type == CTX_DATA_TYPE_COLLECTION);
return result.list;
}
ListBase list = {NULL, NULL};
return list;
}
int /*eContextResult*/ CTX_data_get(
const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb, short *r_type)
{
bContextDataResult result;
eContextResult ret = ctx_data_get((bContext *)C, member, &result);
if (ret == CTX_RESULT_OK) {
*r_ptr = result.ptr;
*r_lb = result.list;
*r_type = result.type;
}
else {
memset(r_ptr, 0, sizeof(*r_ptr));
memset(r_lb, 0, sizeof(*r_lb));
*r_type = 0;
}
return ret;
}
static void data_dir_add(ListBase *lb, const char *member, const bool use_all)
{
LinkData *link;
if ((use_all == false) && STREQ(member, "scene")) { /* exception */
return;
}
if (BLI_findstring(lb, member, offsetof(LinkData, data))) {
return;
}
link = MEM_callocN(sizeof(LinkData), "LinkData");
link->data = (void *)member;
BLI_addtail(lb, link);
}
ListBase CTX_data_dir_get_ex(const bContext *C,
const bool use_store,
const bool use_rna,
const bool use_all)
{
bContextDataResult result;
ListBase lb;
bScreen *screen;
ScrArea *area;
ARegion *region;
int a;
memset(&lb, 0, sizeof(lb));
if (use_rna) {
char name[256], *nameptr;
int namelen;
PropertyRNA *iterprop;
PointerRNA ctx_ptr;
RNA_pointer_create(NULL, &RNA_Context, (void *)C, &ctx_ptr);
iterprop = RNA_struct_iterator_property(ctx_ptr.type);
RNA_PROP_BEGIN (&ctx_ptr, itemptr, iterprop) {
nameptr = RNA_struct_name_get_alloc(&itemptr, name, sizeof(name), &namelen);
data_dir_add(&lb, name, use_all);
if (nameptr) {
if (name != nameptr) {
MEM_freeN(nameptr);
}
}
}
RNA_PROP_END;
}
if (use_store && C->wm.store) {
bContextStoreEntry *entry;
for (entry = C->wm.store->entries.first; entry; entry = entry->next) {
data_dir_add(&lb, entry->name, use_all);
}
}
if ((region = CTX_wm_region(C)) && region->type && region->type->context) {
memset(&result, 0, sizeof(result));
region->type->context(C, "", &result);
if (result.dir) {
for (a = 0; result.dir[a]; a++) {
data_dir_add(&lb, result.dir[a], use_all);
}
}
}
if ((area = CTX_wm_area(C)) && area->type && area->type->context) {
memset(&result, 0, sizeof(result));
area->type->context(C, "", &result);
if (result.dir) {
for (a = 0; result.dir[a]; a++) {
data_dir_add(&lb, result.dir[a], use_all);
}
}
}
if ((screen = CTX_wm_screen(C)) && screen->context) {
bContextDataCallback cb = screen->context;
memset(&result, 0, sizeof(result));
cb(C, "", &result);
if (result.dir) {
for (a = 0; result.dir[a]; a++) {
data_dir_add(&lb, result.dir[a], use_all);
}
}
}
return lb;
}
ListBase CTX_data_dir_get(const bContext *C)
{
return CTX_data_dir_get_ex(C, true, false, false);
}
bool CTX_data_equals(const char *member, const char *str)
{
return (STREQ(member, str));
}
bool CTX_data_dir(const char *member)
{
return member[0] == '\0';
}
void CTX_data_id_pointer_set(bContextDataResult *result, ID *id)
{
RNA_id_pointer_create(id, &result->ptr);
}
void CTX_data_pointer_set(bContextDataResult *result, ID *id, StructRNA *type, void *data)
{
RNA_pointer_create(id, type, data, &result->ptr);
}
void CTX_data_pointer_set_ptr(bContextDataResult *result, const PointerRNA *ptr)
{
result->ptr = *ptr;
}
void CTX_data_id_list_add(bContextDataResult *result, ID *id)
{
CollectionPointerLink *link = MEM_callocN(sizeof(CollectionPointerLink), "CTX_data_id_list_add");
RNA_id_pointer_create(id, &link->ptr);
BLI_addtail(&result->list, link);
}
void CTX_data_list_add(bContextDataResult *result, ID *id, StructRNA *type, void *data)
{
CollectionPointerLink *link = MEM_callocN(sizeof(CollectionPointerLink), "CTX_data_list_add");
RNA_pointer_create(id, type, data, &link->ptr);
BLI_addtail(&result->list, link);
}
void CTX_data_list_add_ptr(bContextDataResult *result, const PointerRNA *ptr)
{
CollectionPointerLink *link = MEM_callocN(sizeof(CollectionPointerLink), "CTX_data_list_add");
link->ptr = *ptr;
BLI_addtail(&result->list, link);
}
int ctx_data_list_count(const bContext *C, int (*func)(const bContext *, ListBase *))
{
ListBase list;
if (func(C, &list)) {
int tot = BLI_listbase_count(&list);
BLI_freelistN(&list);
return tot;
}
return 0;
}
void CTX_data_dir_set(bContextDataResult *result, const char **dir)
{
result->dir = dir;
}
void CTX_data_type_set(bContextDataResult *result, short type)
{
result->type = type;
}
short CTX_data_type_get(bContextDataResult *result)
{
return result->type;
}
/* window manager context */
wmWindowManager *CTX_wm_manager(const bContext *C)
{
return C->wm.manager;
}
bool CTX_wm_interface_locked(const bContext *C)
{
return (bool)C->wm.manager->is_interface_locked;
}
wmWindow *CTX_wm_window(const bContext *C)
{
return ctx_wm_python_context_get(C, "window", &RNA_Window, C->wm.window);
}
WorkSpace *CTX_wm_workspace(const bContext *C)
{
return ctx_wm_python_context_get(C, "workspace", &RNA_WorkSpace, C->wm.workspace);
}
bScreen *CTX_wm_screen(const bContext *C)
{
return ctx_wm_python_context_get(C, "screen", &RNA_Screen, C->wm.screen);
}
ScrArea *CTX_wm_area(const bContext *C)
{
return ctx_wm_python_context_get(C, "area", &RNA_Area, C->wm.area);
}
SpaceLink *CTX_wm_space_data(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
return (area) ? area->spacedata.first : NULL;
}
ARegion *CTX_wm_region(const bContext *C)
{
return ctx_wm_python_context_get(C, "region", &RNA_Region, C->wm.region);
}
void *CTX_wm_region_data(const bContext *C)
{
ARegion *region = CTX_wm_region(C);
return (region) ? region->regiondata : NULL;
}
struct ARegion *CTX_wm_menu(const bContext *C)
{
return C->wm.menu;
}
struct wmGizmoGroup *CTX_wm_gizmo_group(const bContext *C)
{
return C->wm.gizmo_group;
}
struct wmMsgBus *CTX_wm_message_bus(const bContext *C)
{
return C->wm.manager ? C->wm.manager->message_bus : NULL;
}
struct ReportList *CTX_wm_reports(const bContext *C)
{
if (C->wm.manager) {
return &(C->wm.manager->reports);
}
return NULL;
}
View3D *CTX_wm_view3d(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_VIEW3D) {
return area->spacedata.first;
}
return NULL;
}
RegionView3D *CTX_wm_region_view3d(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
ARegion *region = CTX_wm_region(C);
if (area && area->spacetype == SPACE_VIEW3D) {
if (region && region->regiontype == RGN_TYPE_WINDOW) {
return region->regiondata;
}
}
return NULL;
}
struct SpaceText *CTX_wm_space_text(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_TEXT) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceConsole *CTX_wm_space_console(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_CONSOLE) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceImage *CTX_wm_space_image(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_IMAGE) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceProperties *CTX_wm_space_properties(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_PROPERTIES) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceFile *CTX_wm_space_file(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_FILE) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceSeq *CTX_wm_space_seq(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_SEQ) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceOutliner *CTX_wm_space_outliner(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_OUTLINER) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceNla *CTX_wm_space_nla(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_NLA) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceNode *CTX_wm_space_node(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_NODE) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceGraph *CTX_wm_space_graph(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_GRAPH) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceAction *CTX_wm_space_action(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_ACTION) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceInfo *CTX_wm_space_info(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_INFO) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceUserPref *CTX_wm_space_userpref(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_USERPREF) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceClip *CTX_wm_space_clip(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_CLIP) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceTopBar *CTX_wm_space_topbar(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_TOPBAR) {
return area->spacedata.first;
}
return NULL;
}
struct SpaceSpreadsheet *CTX_wm_space_spreadsheet(const bContext *C)
{
ScrArea *area = CTX_wm_area(C);
if (area && area->spacetype == SPACE_SPREADSHEET) {
return area->spacedata.first;
}
return NULL;
}
void CTX_wm_manager_set(bContext *C, wmWindowManager *wm)
{
C->wm.manager = wm;
C->wm.window = NULL;
C->wm.screen = NULL;
C->wm.area = NULL;
C->wm.region = NULL;
}
#ifdef WITH_PYTHON
# define PYCTX_REGION_MEMBERS "region", "region_data"
# define PYCTX_AREA_MEMBERS "area", "space_data", PYCTX_REGION_MEMBERS
# define PYCTX_SCREEN_MEMBERS "screen", PYCTX_AREA_MEMBERS
# define PYCTX_WINDOW_MEMBERS "window", "scene", "workspace", PYCTX_SCREEN_MEMBERS
#endif
void CTX_wm_window_set(bContext *C, wmWindow *win)
{
C->wm.window = win;
if (win) {
C->data.scene = win->scene;
}
C->wm.workspace = (win) ? BKE_workspace_active_get(win->workspace_hook) : NULL;
C->wm.screen = (win) ? BKE_workspace_active_screen_get(win->workspace_hook) : NULL;
C->wm.area = NULL;
C->wm.region = NULL;
#ifdef WITH_PYTHON
if (C->data.py_context != NULL) {
BPY_context_dict_clear_members(C, PYCTX_WINDOW_MEMBERS);
}
#endif
}
void CTX_wm_screen_set(bContext *C, bScreen *screen)
{
C->wm.screen = screen;
C->wm.area = NULL;
C->wm.region = NULL;
#ifdef WITH_PYTHON
if (C->data.py_context != NULL) {
BPY_context_dict_clear_members(C, PYCTX_SCREEN_MEMBERS);
}
#endif
}
void CTX_wm_area_set(bContext *C, ScrArea *area)
{
C->wm.area = area;
C->wm.region = NULL;
#ifdef WITH_PYTHON
if (C->data.py_context != NULL) {
BPY_context_dict_clear_members(C, PYCTX_AREA_MEMBERS);
}
#endif
}
void CTX_wm_region_set(bContext *C, ARegion *region)
{
C->wm.region = region;
#ifdef WITH_PYTHON
if (C->data.py_context != NULL) {
BPY_context_dict_clear_members(C, PYCTX_REGION_MEMBERS);
}
#endif
}
void CTX_wm_menu_set(bContext *C, ARegion *menu)
{
C->wm.menu = menu;
}
void CTX_wm_gizmo_group_set(bContext *C, struct wmGizmoGroup *gzgroup)
{
C->wm.gizmo_group = gzgroup;
}
void CTX_wm_operator_poll_msg_clear(bContext *C)
{
struct bContextPollMsgDyn_Params *params = &C->wm.operator_poll_msg_dyn_params;
if (params->free_fn != NULL) {
params->free_fn(C, params->user_data);
}
params->get_fn = NULL;
params->free_fn = NULL;
params->user_data = NULL;
C->wm.operator_poll_msg = NULL;
}
void CTX_wm_operator_poll_msg_set(bContext *C, const char *msg)
{
CTX_wm_operator_poll_msg_clear(C);
C->wm.operator_poll_msg = msg;
}
void CTX_wm_operator_poll_msg_set_dynamic(bContext *C,
const struct bContextPollMsgDyn_Params *params)
{
CTX_wm_operator_poll_msg_clear(C);
C->wm.operator_poll_msg_dyn_params = *params;
}
const char *CTX_wm_operator_poll_msg_get(bContext *C, bool *r_free)
{
struct bContextPollMsgDyn_Params *params = &C->wm.operator_poll_msg_dyn_params;
if (params->get_fn != NULL) {
char *msg = params->get_fn(C, params->user_data);
if (msg != NULL) {
*r_free = true;
}
return msg;
}
*r_free = false;
return IFACE_(C->wm.operator_poll_msg);
}
/* data context */
Main *CTX_data_main(const bContext *C)
{
Main *bmain;
if (ctx_data_pointer_verify(C, "blend_data", (void *)&bmain)) {
return bmain;
}
return C->data.main;
}
void CTX_data_main_set(bContext *C, Main *bmain)
{
C->data.main = bmain;
BKE_sound_init_main(bmain);
}
Scene *CTX_data_scene(const bContext *C)
{
Scene *scene;
if (ctx_data_pointer_verify(C, "scene", (void *)&scene)) {
return scene;
}
return C->data.scene;
}
ViewLayer *CTX_data_view_layer(const bContext *C)
{
ViewLayer *view_layer;
if (ctx_data_pointer_verify(C, "view_layer", (void *)&view_layer)) {
return view_layer;
}
wmWindow *win = CTX_wm_window(C);
Scene *scene = CTX_data_scene(C);
if (win) {
view_layer = BKE_view_layer_find(scene, win->view_layer_name);
if (view_layer) {
return view_layer;
}
}
return BKE_view_layer_default_view(scene);
}
RenderEngineType *CTX_data_engine_type(const bContext *C)
{
Scene *scene = CTX_data_scene(C);
return RE_engines_find(scene->r.engine);
}
LayerCollection *CTX_data_layer_collection(const bContext *C)
{
ViewLayer *view_layer = CTX_data_view_layer(C);
LayerCollection *layer_collection;
if (ctx_data_pointer_verify(C, "layer_collection", (void *)&layer_collection)) {
if (BKE_view_layer_has_collection(view_layer, layer_collection->collection)) {
return layer_collection;
}
}
/* fallback */
return BKE_layer_collection_get_active(view_layer);
}
Collection *CTX_data_collection(const bContext *C)
{
Collection *collection;
if (ctx_data_pointer_verify(C, "collection", (void *)&collection)) {
return collection;
}
LayerCollection *layer_collection = CTX_data_layer_collection(C);
if (layer_collection) {
return layer_collection->collection;
}
/* fallback */
Scene *scene = CTX_data_scene(C);
return scene->master_collection;
}
enum eContextObjectMode CTX_data_mode_enum_ex(const Object *obedit,
const Object *ob,
const eObjectMode object_mode)
{
// Object *obedit = CTX_data_edit_object(C);
if (obedit) {
switch (obedit->type) {
case OB_MESH:
return CTX_MODE_EDIT_MESH;
case OB_CURVES_LEGACY:
return CTX_MODE_EDIT_CURVE;
case OB_SURF:
return CTX_MODE_EDIT_SURFACE;
case OB_FONT:
return CTX_MODE_EDIT_TEXT;
case OB_ARMATURE:
return CTX_MODE_EDIT_ARMATURE;
case OB_MBALL:
return CTX_MODE_EDIT_METABALL;
case OB_LATTICE:
return CTX_MODE_EDIT_LATTICE;
case OB_CURVES:
return CTX_MODE_EDIT_CURVES;
}
}
else {
// Object *ob = CTX_data_active_object(C);
if (ob) {
if (object_mode & OB_MODE_POSE) {
return CTX_MODE_POSE;
}
if (object_mode & OB_MODE_SCULPT) {
return CTX_MODE_SCULPT;
}
if (object_mode & OB_MODE_WEIGHT_PAINT) {
return CTX_MODE_PAINT_WEIGHT;
}
if (object_mode & OB_MODE_VERTEX_PAINT) {
return CTX_MODE_PAINT_VERTEX;
}
if (object_mode & OB_MODE_TEXTURE_PAINT) {
return CTX_MODE_PAINT_TEXTURE;
}
if (object_mode & OB_MODE_PARTICLE_EDIT) {
return CTX_MODE_PARTICLE;
}
if (object_mode & OB_MODE_PAINT_GPENCIL) {
return CTX_MODE_PAINT_GPENCIL;
}
if (object_mode & OB_MODE_EDIT_GPENCIL) {
return CTX_MODE_EDIT_GPENCIL;
}
if (object_mode & OB_MODE_SCULPT_GPENCIL) {
return CTX_MODE_SCULPT_GPENCIL;
}
if (object_mode & OB_MODE_WEIGHT_GPENCIL) {
return CTX_MODE_WEIGHT_GPENCIL;
}
if (object_mode & OB_MODE_VERTEX_GPENCIL) {
return CTX_MODE_VERTEX_GPENCIL;
}
if (object_mode & OB_MODE_SCULPT_CURVES) {
return CTX_MODE_SCULPT_CURVES;
}
}
}
return CTX_MODE_OBJECT;
}
enum eContextObjectMode CTX_data_mode_enum(const bContext *C)
{
Object *obedit = CTX_data_edit_object(C);
Object *obact = obedit ? NULL : CTX_data_active_object(C);
return CTX_data_mode_enum_ex(obedit, obact, obact ? obact->mode : OB_MODE_OBJECT);
}
/**
* Would prefer if we can use the enum version below over this one - Campbell.
*
* \note Must be aligned with above enum.
*/
static const char *data_mode_strings[] = {
"mesh_edit",
"curve_edit",
"surface_edit",
"text_edit",
"armature_edit",
"mball_edit",
"lattice_edit",
"curves_edit",
"posemode",
"sculpt_mode",
"weightpaint",
"vertexpaint",
"imagepaint",
"particlemode",
"objectmode",
"greasepencil_paint",
"greasepencil_edit",
"greasepencil_sculpt",
"greasepencil_weight",
"greasepencil_vertex",
"curves_sculpt",
NULL,
};
BLI_STATIC_ASSERT(ARRAY_SIZE(data_mode_strings) == CTX_MODE_NUM + 1,
"Must have a string for each context mode")
const char *CTX_data_mode_string(const bContext *C)
{
return data_mode_strings[CTX_data_mode_enum(C)];
}
void CTX_data_scene_set(bContext *C, Scene *scene)
{
C->data.scene = scene;
#ifdef WITH_PYTHON
if (C->data.py_context != NULL) {
BPY_context_dict_clear_members(C, "scene");
}
#endif
}
ToolSettings *CTX_data_tool_settings(const bContext *C)
{
Scene *scene = CTX_data_scene(C);
if (scene) {
return scene->toolsettings;
}
return NULL;
}
int CTX_data_selected_ids(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "selected_ids", list);
}
int CTX_data_selected_nodes(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "selected_nodes", list);
}
int CTX_data_selected_editable_objects(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "selected_editable_objects", list);
}
int CTX_data_selected_editable_bases(const bContext *C, ListBase *list)
{
return ctx_data_base_collection_get(C, "selected_editable_objects", list);
}
int CTX_data_editable_objects(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "editable_objects", list);
}
int CTX_data_editable_bases(const bContext *C, ListBase *list)
{
return ctx_data_base_collection_get(C, "editable_objects", list);
}
int CTX_data_selected_objects(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "selected_objects", list);
}
int CTX_data_selected_bases(const bContext *C, ListBase *list)
{
return ctx_data_base_collection_get(C, "selected_objects", list);
}
int CTX_data_visible_objects(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "visible_objects", list);
}
int CTX_data_visible_bases(const bContext *C, ListBase *list)
{
return ctx_data_base_collection_get(C, "visible_objects", list);
}
int CTX_data_selectable_objects(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "selectable_objects", list);
}
int CTX_data_selectable_bases(const bContext *C, ListBase *list)
{
return ctx_data_base_collection_get(C, "selectable_objects", list);
}
struct Object *CTX_data_active_object(const bContext *C)
{
return ctx_data_pointer_get(C, "active_object");
}
struct Base *CTX_data_active_base(const bContext *C)
{
Object *ob = ctx_data_pointer_get(C, "active_object");
if (ob == NULL) {
return NULL;
}
ViewLayer *view_layer = CTX_data_view_layer(C);
return BKE_view_layer_base_find(view_layer, ob);
}
struct Object *CTX_data_edit_object(const bContext *C)
{
return ctx_data_pointer_get(C, "edit_object");
}
struct Image *CTX_data_edit_image(const bContext *C)
{
return ctx_data_pointer_get(C, "edit_image");
}
struct Text *CTX_data_edit_text(const bContext *C)
{
return ctx_data_pointer_get(C, "edit_text");
}
struct MovieClip *CTX_data_edit_movieclip(const bContext *C)
{
return ctx_data_pointer_get(C, "edit_movieclip");
}
struct Mask *CTX_data_edit_mask(const bContext *C)
{
return ctx_data_pointer_get(C, "edit_mask");
}
struct EditBone *CTX_data_active_bone(const bContext *C)
{
return ctx_data_pointer_get(C, "active_bone");
}
struct CacheFile *CTX_data_edit_cachefile(const bContext *C)
{
return ctx_data_pointer_get(C, "edit_cachefile");
}
int CTX_data_selected_bones(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "selected_bones", list);
}
int CTX_data_selected_editable_bones(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "selected_editable_bones", list);
}
int CTX_data_visible_bones(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "visible_bones", list);
}
int CTX_data_editable_bones(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "editable_bones", list);
}
struct bPoseChannel *CTX_data_active_pose_bone(const bContext *C)
{
return ctx_data_pointer_get(C, "active_pose_bone");
}
int CTX_data_selected_pose_bones(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "selected_pose_bones", list);
}
int CTX_data_selected_pose_bones_from_active_object(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "selected_pose_bones_from_active_object", list);
}
int CTX_data_visible_pose_bones(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "visible_pose_bones", list);
}
bGPdata *CTX_data_gpencil_data(const bContext *C)
{
return ctx_data_pointer_get(C, "gpencil_data");
}
bGPDlayer *CTX_data_active_gpencil_layer(const bContext *C)
{
return ctx_data_pointer_get(C, "active_gpencil_layer");
}
bGPDframe *CTX_data_active_gpencil_frame(const bContext *C)
{
return ctx_data_pointer_get(C, "active_gpencil_frame");
}
int CTX_data_visible_gpencil_layers(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "visible_gpencil_layers", list);
}
int CTX_data_editable_gpencil_layers(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "editable_gpencil_layers", list);
}
int CTX_data_editable_gpencil_strokes(const bContext *C, ListBase *list)
{
return ctx_data_collection_get(C, "editable_gpencil_strokes", list);
}
const AssetLibraryReference *CTX_wm_asset_library_ref(const bContext *C)
{
return ctx_data_pointer_get(C, "asset_library_ref");
}
AssetHandle CTX_wm_asset_handle(const bContext *C, bool *r_is_valid)
{
AssetHandle *asset_handle_p =
(AssetHandle *)CTX_data_pointer_get_type(C, "asset_handle", &RNA_AssetHandle).data;
if (asset_handle_p) {
*r_is_valid = true;
return *asset_handle_p;
}
/* If the asset handle was not found in context directly, try if there's an active file with
* asset data there instead. Not nice to have this here, would be better to have this in
* `ED_asset.h`, but we can't include that in BKE. Even better would be not needing this at all
* and being able to have editors return this in the usual `context` callback. But that would
* require returning a non-owning pointer, which we don't have in the Asset Browser (yet). */
FileDirEntry *file =
(FileDirEntry *)CTX_data_pointer_get_type(C, "active_file", &RNA_FileSelectEntry).data;
if (file && file->asset_data) {
*r_is_valid = true;
return (AssetHandle){.file_data = file};
}
*r_is_valid = false;
return (AssetHandle){0};
}
Depsgraph *CTX_data_depsgraph_pointer(const bContext *C)
{
Main *bmain = CTX_data_main(C);
Scene *scene = CTX_data_scene(C);
ViewLayer *view_layer = CTX_data_view_layer(C);
Depsgraph *depsgraph = BKE_scene_ensure_depsgraph(bmain, scene, view_layer);
/* Dependency graph might have been just allocated, and hence it will not be marked.
* This confuses redo system due to the lack of flushing changes back to the original data.
* In the future we would need to check whether the CTX_wm_window(C) is in editing mode (as an
* opposite of playback-preview-only) and set active flag based on that. */
DEG_make_active(depsgraph);
return depsgraph;
}
Depsgraph *CTX_data_expect_evaluated_depsgraph(const bContext *C)
{
Depsgraph *depsgraph = CTX_data_depsgraph_pointer(C);
/* TODO(sergey): Assert that the dependency graph is fully evaluated.
* Note that first the depsgraph and scene post-eval hooks needs to run extra round of updates
* first to make check here really reliable. */
return depsgraph;
}
Depsgraph *CTX_data_ensure_evaluated_depsgraph(const bContext *C)
{
Depsgraph *depsgraph = CTX_data_depsgraph_pointer(C);
Main *bmain = CTX_data_main(C);
BKE_scene_graph_evaluated_ensure(depsgraph, bmain);
return depsgraph;
}
Depsgraph *CTX_data_depsgraph_on_load(const bContext *C)
{
Scene *scene = CTX_data_scene(C);
ViewLayer *view_layer = CTX_data_view_layer(C);
return BKE_scene_get_depsgraph(scene, view_layer);
}