Blender V5.3
BKE_context.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
10
11#include <variant>
12
13#include "BLI_enum_flags.hh"
14#include "BLI_string_ref.hh"
15#include "BLI_vector.hh"
16
17#include "DNA_listBase.h"
18#include "DNA_object_enums.h"
19#include "RNA_types.hh"
20
21namespace blender {
22
23struct ARegion;
26struct Base;
27struct bGPDframe;
28struct bGPDlayer;
29struct bPoseChannel;
30struct bScreen;
31struct CacheFile;
32struct Collection;
33struct Depsgraph;
34struct EditBone;
35struct ID;
36struct Image;
37struct LayerCollection;
38struct Main;
39struct Mask;
40struct MovieClip;
41struct Object;
42struct PointerRNA;
43struct RegionView3D;
44struct RenderEngineType;
45struct ReportList;
46struct Scene;
47struct ScrArea;
48struct SpaceAction;
49struct SpaceClip;
50struct SpaceClip;
51struct SpaceConsole;
52struct SpaceFile;
53struct SpaceGraph;
54struct SpaceImage;
55struct SpaceInfo;
56struct SpaceLink;
57struct SpaceNla;
58struct SpaceNode;
59struct SpaceOutliner;
60struct SpaceProject;
61struct SpaceProperties;
62struct SpaceSeq;
63struct SpaceSpreadsheet;
64struct SpaceText;
65struct SpaceTopBar;
66struct SpaceUserPref;
67struct StructRNA;
68struct Text;
69struct ToolSettings;
70struct View3D;
71struct ViewLayer;
72struct wmGizmoGroup;
73struct wmMsgBus;
74struct wmWindow;
75struct wmWindowManager;
76struct WorkSpace;
77
81enum class CTX_LogFlag : uint8_t {
83 Access = (1 << 0),
85 HideMissing = (1 << 1),
86};
88
89/* Structs */
90
91struct bContext;
92
94
95/* Result of context lookups.
96 * The specific values are important, and used implicitly in ctx_data_get(). Some functions also
97 * still accept/return `int` instead, to ensure that the compiler uses the correct storage size
98 * when mixing C/C++ code. */
100 /* The context member was found, and its data is available. */
102
103 /* The context member was not found. */
105
106 /* The context member was found, but its data is not available.
107 * For example, "active_bone" is a valid context member, but has not data in Object mode. */
109};
110
111/* Function mapping a context member name to its value. */
112using bContextDataCallback = int /*eContextResult*/ (*)(const bContext *C,
113 const char *member,
115
117 std::string name;
118 std::variant<PointerRNA, std::string, int64_t> value;
119};
120
125
126namespace asset_system {
128}
129
130/* for the context's rna mode enum
131 * keep aligned with data_mode_strings in context.cc */
161#define CTX_MODE_NUM (CTX_MODE_VERTEX_GREASE_PENCIL + 1)
162
163/* Context */
164
165bContext *CTX_create();
166void CTX_free(bContext *C);
167
168bContext *CTX_copy(const bContext *C);
169
170/* Stored Context */
171
172bContextStore *CTX_store_add(Vector<std::unique_ptr<bContextStore>> &contexts,
173 StringRef name,
174 const PointerRNA *ptr);
175bContextStore *CTX_store_add(Vector<std::unique_ptr<bContextStore>> &contexts,
176 StringRef name,
177 StringRef str);
178bContextStore *CTX_store_add(Vector<std::unique_ptr<bContextStore>> &contexts,
179 StringRef name,
180 int64_t value);
181bContextStore *CTX_store_add_all(Vector<std::unique_ptr<bContextStore>> &contexts,
182 const bContextStore *context);
183const bContextStore *CTX_store_get(const bContext *C);
184void CTX_store_set(bContext *C, const bContextStore *store);
185const PointerRNA *CTX_store_ptr_lookup(const bContextStore *store,
186 StringRef name,
187 const StructRNA *type = nullptr);
188std::optional<StringRefNull> CTX_store_string_lookup(const bContextStore *store, StringRef name);
189std::optional<int64_t> CTX_store_int_lookup(const bContextStore *store, StringRef name);
190
191/* Set a temporary flag to indicate when writing via RNA is disallowed. */
192void CTX_rna_disallow_write_set_p(bContext *C, const bool *rna_disallow_writes);
193
195bool CTX_py_init_get(const bContext *C);
196void CTX_py_init_set(bContext *C, bool value);
197
198void *CTX_py_dict_get(const bContext *C);
199void *CTX_py_dict_get_orig(const bContext *C);
200
205void CTX_py_state_push(bContext *C, bContext_PyState *pystate, void *value);
207
208/* Window Manager Context */
209
217void *CTX_wm_region_data(const bContext *C);
222
242
245void CTX_wm_screen_set(bContext *C, bScreen *screen); /* to be removed */
246void CTX_wm_area_set(bContext *C, ScrArea *area);
247void CTX_wm_region_set(bContext *C, ARegion *region);
248void CTX_wm_region_popup_set(bContext *C, ARegion *region_popup);
250
258 char *(*get_fn)(bContext *C, void *user_data);
260 void (*free_fn)(bContext *C, void *user_data);
262};
263
264const char *CTX_wm_operator_poll_msg_get(bContext *C, bool *r_free);
265
277void CTX_wm_operator_poll_msg_set(bContext *C, const char *msg);
281
282/* Data Context
283 *
284 * - The dir #ListBaseT consists of #LinkData items.
285 */
286
295
296PointerRNA CTX_data_pointer_get(const bContext *C, const char *member);
297PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type);
298PointerRNA CTX_data_pointer_get_type_silent(const bContext *C,
299 const char *member,
300 StructRNA *type);
301Vector<PointerRNA> CTX_data_collection_get(const bContext *C, const char *member);
302
311void CTX_data_collection_remap_property(MutableSpan<PointerRNA> collection_pointers,
312 const char *propname);
313
314std::optional<StringRefNull> CTX_data_string_get(const bContext *C, const char *member);
315std::optional<int64_t> CTX_data_int_get(const bContext *C, const char *member);
316
323ListBaseT<LinkData> CTX_data_dir_get_ex(const bContext *C,
324 bool use_store,
325 bool use_rna,
326 bool use_all);
327ListBaseT<LinkData> CTX_data_dir_get(const bContext *C);
328int /*eContextResult*/ CTX_data_get(const bContext *C,
329 const char *member,
330 PointerRNA *r_ptr,
331 Vector<PointerRNA> *r_lb,
332 PropertyRNA **r_prop,
333 int *r_index,
334 StringRef *r_str,
335 std::optional<int64_t> *r_int_value,
336 ContextDataType *r_type);
337
338void CTX_data_id_pointer_set(bContextDataResult *result, ID *id);
339void CTX_data_pointer_set_ptr(bContextDataResult *result, const PointerRNA *ptr);
340void CTX_data_pointer_set(bContextDataResult *result, ID *id, StructRNA *type, void *data);
341
342void CTX_data_id_list_add(bContextDataResult *result, ID *id);
343void CTX_data_list_add_ptr(bContextDataResult *result, const PointerRNA *ptr);
344void CTX_data_list_add(bContextDataResult *result, ID *id, StructRNA *type, void *data);
345
353void CTX_data_prop_set(bContextDataResult *result, PropertyRNA *prop, int index);
354
355void CTX_data_dir_set(bContextDataResult *result, const char **dir);
356
357void CTX_data_type_set(bContextDataResult *result, ContextDataType type);
358ContextDataType CTX_data_type_get(bContextDataResult *result);
359
360bool CTX_data_equals(const char *member, const char *str);
361bool CTX_data_dir(const char *member);
362
363#define CTX_DATA_BEGIN(C, Type, instance, member) \
364 { \
365 Vector<PointerRNA> ctx_data_list; \
366 CTX_data_##member(C, &ctx_data_list); \
367 for (PointerRNA &ctx_link : ctx_data_list) { \
368 Type instance = (Type)ctx_link.data;
369
370#define CTX_DATA_END \
371 } \
372 } \
373 (void)0
374
375#define CTX_DATA_BEGIN_WITH_ID(C, Type, instance, member, Type_id, instance_id) \
376 CTX_DATA_BEGIN (C, Type, instance, member) \
377 Type_id instance_id = (Type_id)ctx_link.owner_id;
378
379int ctx_data_list_count(const bContext *C, bool (*func)(const bContext *, Vector<PointerRNA> *));
380
381#define CTX_DATA_COUNT(C, member) ctx_data_list_count(C, CTX_data_##member)
382
383/* Data Context Members */
384
385Main *CTX_data_main(const bContext *C);
386Scene *CTX_data_scene(const bContext *C);
387Scene *CTX_data_sequencer_scene(const bContext *C);
395LayerCollection *CTX_data_layer_collection(const bContext *C);
396Collection *CTX_data_collection(const bContext *C);
397ViewLayer *CTX_data_view_layer(const bContext *C);
398RenderEngineType *CTX_data_engine_type(const bContext *C);
399ToolSettings *CTX_data_tool_settings(const bContext *C);
400
401const char *CTX_data_mode_string(const bContext *C);
403 const Object *ob,
404 eObjectMode object_mode);
406
413
414void CTX_data_main_set(bContext *C, Main *bmain);
415void CTX_data_scene_set(bContext *C, Scene *scene);
416
417/* Only Outliner currently! */
419
422
425
428
431
434
438
440
444
446
448
454
460
463
465
475Depsgraph *CTX_data_depsgraph_pointer(const bContext *C);
476
485
497Depsgraph *CTX_data_ensure_evaluated_depsgraph(const bContext *C, bool rna_write_check = false);
498
499/* Will Return NULL if depsgraph is not allocated yet.
500 * Only used by handful of operators which are run on file load.
501 */
502Depsgraph *CTX_data_depsgraph_on_load(const bContext *C);
503
508
513
518
526
527} // namespace blender
These structs are the foundation for all linked lists in the library system.
#define C
Definition RandGen.cpp:29
long long int int64_t
Definition scene.h:133
#define str(s)
#define index(i)
ENUM_OPERATORS(Layer::Flags)
BMesh Iterators.
bool CTX_data_selected_ids(const bContext *C, Vector< PointerRNA > *list)
SpaceNla * CTX_wm_space_nla(const bContext *C)
const char * CTX_data_mode_string(const bContext *C)
Vector< PointerRNA > CTX_data_collection_get(const bContext *C, const char *member)
ScrArea * CTX_wm_area(const bContext *C)
void * CTX_py_dict_get(const bContext *C)
bool CTX_data_editable_bases(const bContext *C, Vector< PointerRNA > *list)
SpaceAction * CTX_wm_space_action(const bContext *C)
bool CTX_data_selected_bases(const bContext *C, Vector< PointerRNA > *list)
bool CTX_data_visible_bases(const bContext *C, Vector< PointerRNA > *list)
Scene * CTX_data_sequencer_scene(const bContext *C)
const PointerRNA * CTX_store_ptr_lookup(const bContextStore *store, StringRef name, const StructRNA *type=nullptr)
bool CTX_py_init_get(const bContext *C)
wmGizmoGroup * CTX_wm_gizmo_group(const bContext *C)
void CTX_data_dir_set(bContextDataResult *result, const char **dir)
CacheFile * CTX_data_edit_cachefile(const bContext *C)
SpaceConsole * CTX_wm_space_console(const bContext *C)
WorkSpace * CTX_wm_workspace(const bContext *C)
SpaceOutliner * CTX_wm_space_outliner(const bContext *C)
Depsgraph * CTX_data_depsgraph_pointer(const bContext *C)
class asset_system::AssetRepresentation * CTX_wm_asset(const bContext *C)
void CTX_wm_window_set(bContext *C, wmWindow *win)
SpaceClip * CTX_wm_space_clip(const bContext *C)
SpaceTopBar * CTX_wm_space_topbar(const bContext *C)
CTX_LogFlag CTX_member_logging_flag_get(const bContext *C)
bContextStore * CTX_store_add(Vector< std::unique_ptr< bContextStore > > &contexts, StringRef name, const PointerRNA *ptr)
Image * CTX_data_edit_image(const bContext *C)
SpaceUserPref * CTX_wm_space_userpref(const bContext *C)
bool CTX_data_selected_bones(const bContext *C, Vector< PointerRNA > *list)
wmWindow * CTX_wm_window(const bContext *C)
void CTX_py_init_set(bContext *C, bool value)
enum eContextObjectMode CTX_data_mode_enum(const bContext *C)
bool CTX_member_logging_get(const bContext *C)
bool CTX_data_equals(const char *member, const char *str)
RenderEngineType * CTX_data_engine_type(const bContext *C)
Text * CTX_data_edit_text(const bContext *C)
void * CTX_wm_region_data(const bContext *C)
Base * CTX_data_active_base(const bContext *C)
std::optional< StringRefNull > CTX_data_string_get(const bContext *C, const char *member)
@ CTX_MODE_VERTEX_GREASE_PENCIL
@ CTX_MODE_PARTICLE
@ CTX_MODE_EDIT_TEXT
@ CTX_MODE_EDIT_SURFACE
@ CTX_MODE_PAINT_VERTEX
@ CTX_MODE_EDIT_GPENCIL_LEGACY
@ CTX_MODE_VERTEX_GPENCIL_LEGACY
@ CTX_MODE_WEIGHT_GPENCIL_LEGACY
@ CTX_MODE_SCULPT_CURVES
@ CTX_MODE_EDIT_ARMATURE
@ CTX_MODE_SCULPT
@ CTX_MODE_EDIT_CURVES
@ CTX_MODE_EDIT_LATTICE
@ CTX_MODE_PAINT_GREASE_PENCIL
@ CTX_MODE_PAINT_GPENCIL_LEGACY
@ CTX_MODE_SCULPT_GREASE_PENCIL
@ CTX_MODE_EDIT_POINTCLOUD
@ CTX_MODE_EDIT_MESH
@ CTX_MODE_PAINT_TEXTURE
@ CTX_MODE_SCULPT_GPENCIL_LEGACY
@ CTX_MODE_EDIT_METABALL
@ CTX_MODE_OBJECT
@ CTX_MODE_EDIT_GREASE_PENCIL
@ CTX_MODE_WEIGHT_GREASE_PENCIL
@ CTX_MODE_EDIT_CURVE
@ CTX_MODE_PAINT_WEIGHT
ViewLayer * CTX_data_view_layer(const bContext *C)
SpaceSeq * CTX_wm_space_seq(const bContext *C)
bContext * CTX_create()
EditBone * CTX_data_active_bone(const bContext *C)
const bContextStore * CTX_store_get(const bContext *C)
void CTX_data_id_pointer_set(bContextDataResult *result, ID *id)
SpaceText * CTX_wm_space_text(const bContext *C)
bContextStore * CTX_store_add_all(Vector< std::unique_ptr< bContextStore > > &contexts, const bContextStore *context)
void CTX_wm_operator_poll_msg_set(bContext *C, const char *msg)
void * CTX_py_dict_get_orig(const bContext *C)
int(*)(const bContext *C, const char *member, bContextDataResult *result) bContextDataCallback
void CTX_wm_screen_set(bContext *C, bScreen *screen)
std::optional< int64_t > CTX_store_int_lookup(const bContextStore *store, StringRef name)
int ctx_data_list_count(const bContext *C, bool(*func)(const bContext *, Vector< PointerRNA > *))
bool CTX_data_visible_objects(const bContext *C, Vector< PointerRNA > *list)
void CTX_data_type_set(bContextDataResult *result, ContextDataType type)
BMesh const char void * data
SpaceInfo * CTX_wm_space_info(const bContext *C)
int CTX_data_get(const bContext *C, const char *member, PointerRNA *r_ptr, Vector< PointerRNA > *r_lb, PropertyRNA **r_prop, int *r_index, StringRef *r_str, std::optional< int64_t > *r_int_value, ContextDataType *r_type)
PointerRNA CTX_data_active_pose_bone_ptr(const bContext *C)
PointerRNA CTX_data_pointer_get(const bContext *C, const char *member)
wmWindowManager * CTX_wm_manager(const bContext *C)
Depsgraph * CTX_data_ensure_evaluated_depsgraph(const bContext *C, bool rna_write_check=false)
bool CTX_data_visible_pose_bones(const bContext *C, Vector< PointerRNA > *list)
void CTX_data_pointer_set_ptr(bContextDataResult *result, const PointerRNA *ptr)
Object * CTX_data_edit_object(const bContext *C)
void CTX_data_pointer_set(bContextDataResult *result, ID *id, StructRNA *type, void *data)
unsigned char uint8_t
Definition BKE_text.h:79
void CTX_free(bContext *C)
bool CTX_member_rna_write_check(const bContext *C)
PointerRNA CTX_data_pointer_get_type_silent(const bContext *C, const char *member, StructRNA *type)
MovieClip * CTX_data_edit_movieclip(const bContext *C)
SpaceNode * CTX_wm_space_node(const bContext *C)
Mask * CTX_data_edit_mask(const bContext *C)
SpaceGraph * CTX_wm_space_graph(const bContext *C)
bool CTX_data_selected_editable_objects(const bContext *C, Vector< PointerRNA > *list)
const char * CTX_wm_operator_poll_msg_get(bContext *C, bool *r_free)
RegionView3D * CTX_wm_region_view3d(const bContext *C)
ToolSettings * CTX_data_tool_settings(const bContext *C)
void CTX_wm_region_popup_set(bContext *C, ARegion *region_popup)
bool CTX_data_selected_pose_bones_from_active_object(const bContext *C, Vector< PointerRNA > *list)
bContext * CTX_copy(const bContext *C)
bool CTX_data_selected_pose_bones(const bContext *C, Vector< PointerRNA > *list)
wmMsgBus * CTX_wm_message_bus(const bContext *C)
bool CTX_data_selected_nodes(const bContext *C, Vector< PointerRNA > *list)
bool CTX_data_dir(const char *member)
void CTX_rna_disallow_write_set_p(bContext *C, const bool *rna_disallow_writes)
void CTX_py_state_push(bContext *C, bContext_PyState *pystate, void *value)
ListBaseT< LinkData > CTX_data_dir_get_ex(const bContext *C, bool use_store, bool use_rna, bool use_all)
void CTX_py_state_pop(bContext *C, bContext_PyState *pystate)
SpaceImage * CTX_wm_space_image(const bContext *C)
SpaceLink * CTX_wm_space_data(const bContext *C)
Depsgraph * CTX_data_depsgraph_on_load(const bContext *C)
Depsgraph * CTX_data_expect_evaluated_depsgraph(const bContext *C)
Main * CTX_data_main(const bContext *C)
void CTX_wm_operator_poll_msg_set_dynamic(bContext *C, const bContextPollMsgDyn_Params *params)
void CTX_data_collection_remap_property(MutableSpan< PointerRNA > collection_pointers, const char *propname)
ARegion * CTX_wm_region_popup(const bContext *C)
void CTX_data_id_list_add(bContextDataResult *result, ID *id)
bool CTX_data_selected_editable_bones(const bContext *C, Vector< PointerRNA > *list)
bPoseChannel * CTX_data_active_pose_bone(const bContext *C)
bool CTX_data_editable_bones(const bContext *C, Vector< PointerRNA > *list)
void CTX_wm_manager_set(bContext *C, wmWindowManager *wm)
std::optional< StringRefNull > CTX_store_string_lookup(const bContextStore *store, StringRef name)
void CTX_data_list_add_ptr(bContextDataResult *result, const PointerRNA *ptr)
SpaceFile * CTX_wm_space_file(const bContext *C)
Scene * CTX_data_scene(const bContext *C)
bScreen * CTX_wm_screen(const bContext *C)
void CTX_wm_region_set(bContext *C, ARegion *region)
void CTX_data_main_set(bContext *C, Main *bmain)
SpaceSpreadsheet * CTX_wm_space_spreadsheet(const bContext *C)
ListBaseT< LinkData > CTX_data_dir_get(const bContext *C)
void CTX_data_prop_set(bContextDataResult *result, PropertyRNA *prop, int index)
std::optional< int64_t > CTX_data_int_get(const bContext *C, const char *member)
SpaceProject * CTX_wm_space_project(const bContext *C)
@ CTX_RESULT_MEMBER_NOT_FOUND
@ CTX_RESULT_NO_DATA
void CTX_data_list_add(bContextDataResult *result, ID *id, StructRNA *type, void *data)
bool CTX_data_visible_bones(const bContext *C, Vector< PointerRNA > *list)
bool CTX_data_selected_objects(const bContext *C, Vector< PointerRNA > *list)
void CTX_data_ui_context_access_deny(bContext *C, bool deny)
void CTX_store_set(bContext *C, const bContextStore *store)
void CTX_member_logging_flag_set(bContext *C, CTX_LogFlag flag)
ReportList * CTX_wm_reports(const bContext *C)
bool CTX_data_selectable_objects(const bContext *C, Vector< PointerRNA > *list)
bool CTX_data_selected_editable_bases(const bContext *C, Vector< PointerRNA > *list)
bool CTX_wm_interface_locked(const bContext *C)
SpaceProperties * CTX_wm_space_properties(const bContext *C)
ContextDataType CTX_data_type_get(bContextDataResult *result)
Object * CTX_data_active_object(const bContext *C)
void CTX_wm_operator_poll_msg_clear(bContext *C)
void CTX_wm_gizmo_group_set(bContext *C, wmGizmoGroup *gzgroup)
ARegion * CTX_wm_region(const bContext *C)
PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type)
void CTX_data_scene_set(bContext *C, Scene *scene)
View3D * CTX_wm_view3d(const bContext *C)
bool CTX_data_selectable_bases(const bContext *C, Vector< PointerRNA > *list)
LayerCollection * CTX_data_layer_collection(const bContext *C)
const AssetLibraryReference * CTX_wm_asset_library_ref(const bContext *C)
Collection * CTX_data_collection(const bContext *C)
bool CTX_data_editable_objects(const bContext *C, Vector< PointerRNA > *list)
void CTX_wm_area_set(bContext *C, ScrArea *area)
enum eContextObjectMode CTX_data_mode_enum_ex(const Object *obedit, const Object *ob, eObjectMode object_mode)
@ String
Definition types.hh:154
void(*) free_fn(bContext *C, void *user_data)
std::variant< PointerRNA, std::string, int64_t > value
Vector< bContextStoreEntry > entries