Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenkernel / BKE_context.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_CONTEXT_H__
21 #define __BKE_CONTEXT_H__
22
23 /** \file \ingroup bke
24  */
25
26 #include "DNA_listBase.h"
27 #include "RNA_types.h"
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 struct ARegion;
34 struct Base;
35 struct Brush;
36 struct CacheFile;
37 struct Collection;
38 struct Depsgraph;
39 struct EditBone;
40 struct ID;
41 struct Image;
42 struct LayerCollection;
43 struct ListBase;
44 struct Main;
45 struct Object;
46 struct PointerRNA;
47 struct RegionView3D;
48 struct RenderEngineType;
49 struct ReportList;
50 struct Scene;
51 struct ScrArea;
52 struct SpaceClip;
53 struct SpaceImage;
54 struct SpaceLink;
55 struct SpaceText;
56 struct StructRNA;
57 struct Text;
58 struct ToolSettings;
59 struct View3D;
60 struct ViewLayer;
61 struct ViewRender;
62 struct bGPDframe;
63 struct bGPDlayer;
64 struct bGPdata;
65 struct bPoseChannel;
66 struct bScreen;
67 struct wmWindow;
68 struct wmWindowManager;
69
70 #include "DNA_object_enums.h"
71
72 /* Structs */
73
74 struct bContext;
75 typedef struct bContext bContext;
76
77 struct bContextDataResult;
78 typedef struct bContextDataResult bContextDataResult;
79
80 typedef int (*bContextDataCallback)(const bContext *C,
81                                     const char *member, bContextDataResult *result);
82
83 typedef struct bContextStoreEntry {
84         struct bContextStoreEntry *next, *prev;
85
86         char name[128];
87         PointerRNA ptr;
88 } bContextStoreEntry;
89
90 typedef struct bContextStore {
91         struct bContextStore *next, *prev;
92
93         ListBase entries;
94         bool used;
95 } bContextStore;
96
97 /* for the context's rna mode enum
98  * keep aligned with data_mode_strings in context.c */
99 enum eContextObjectMode {
100         CTX_MODE_EDIT_MESH = 0,
101         CTX_MODE_EDIT_CURVE,
102         CTX_MODE_EDIT_SURFACE,
103         CTX_MODE_EDIT_TEXT,
104         CTX_MODE_EDIT_ARMATURE,
105         CTX_MODE_EDIT_METABALL,
106         CTX_MODE_EDIT_LATTICE,
107         CTX_MODE_POSE,
108         CTX_MODE_SCULPT,
109         CTX_MODE_PAINT_WEIGHT,
110         CTX_MODE_PAINT_VERTEX,
111         CTX_MODE_PAINT_TEXTURE,
112         CTX_MODE_PARTICLE,
113         CTX_MODE_OBJECT,
114         CTX_MODE_PAINT_GPENCIL,
115         CTX_MODE_EDIT_GPENCIL,
116         CTX_MODE_SCULPT_GPENCIL,
117         CTX_MODE_WEIGHT_GPENCIL,
118 };
119 #define CTX_MODE_NUM (CTX_MODE_WEIGHT_GPENCIL + 1)
120
121 /* Context */
122
123 bContext *CTX_create(void);
124 void CTX_free(bContext *C);
125
126 bContext *CTX_copy(const bContext *C);
127
128 /* Stored Context */
129
130 bContextStore *CTX_store_add(ListBase *contexts, const char *name, PointerRNA *ptr);
131 bContextStore *CTX_store_add_all(ListBase *contexts, bContextStore *context);
132 void CTX_store_set(bContext *C, bContextStore *store);
133 bContextStore *CTX_store_copy(bContextStore *store);
134 void CTX_store_free(bContextStore *store);
135 void CTX_store_free_list(ListBase *contexts);
136
137 /* need to store if python is initialized or not */
138 int CTX_py_init_get(bContext *C);
139 void CTX_py_init_set(bContext *C, int value);
140
141 void *CTX_py_dict_get(const bContext *C);
142 void CTX_py_dict_set(bContext *C, void *value);
143
144 /* Window Manager Context */
145
146 struct wmWindowManager *CTX_wm_manager(const bContext *C);
147 struct wmWindow *CTX_wm_window(const bContext *C);
148 struct WorkSpace *CTX_wm_workspace(const bContext *C);
149 struct bScreen *CTX_wm_screen(const bContext *C);
150 struct ScrArea *CTX_wm_area(const bContext *C);
151 struct SpaceLink *CTX_wm_space_data(const bContext *C);
152 struct ARegion *CTX_wm_region(const bContext *C);
153 void *CTX_wm_region_data(const bContext *C);
154 struct ARegion *CTX_wm_menu(const bContext *C);
155 struct wmGizmoGroup *CTX_wm_gizmo_group(const bContext *C);
156 struct wmMsgBus *CTX_wm_message_bus(const bContext *C);
157 struct ReportList *CTX_wm_reports(const bContext *C);
158
159 struct View3D *CTX_wm_view3d(const bContext *C);
160 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
161 struct SpaceText *CTX_wm_space_text(const bContext *C);
162 struct SpaceImage *CTX_wm_space_image(const bContext *C);
163 struct SpaceConsole *CTX_wm_space_console(const bContext *C);
164 struct SpaceButs *CTX_wm_space_buts(const bContext *C);
165 struct SpaceFile *CTX_wm_space_file(const bContext *C);
166 struct SpaceSeq *CTX_wm_space_seq(const bContext *C);
167 struct SpaceOops *CTX_wm_space_outliner(const bContext *C);
168 struct SpaceNla *CTX_wm_space_nla(const bContext *C);
169 struct SpaceNode *CTX_wm_space_node(const bContext *C);
170 struct SpaceIpo *CTX_wm_space_graph(const bContext *C);
171 struct SpaceAction *CTX_wm_space_action(const bContext *C);
172 struct SpaceInfo *CTX_wm_space_info(const bContext *C);
173 struct SpaceUserPref *CTX_wm_space_userpref(const bContext *C);
174 struct SpaceClip *CTX_wm_space_clip(const bContext *C);
175 struct SpaceTopBar *CTX_wm_space_topbar(const bContext *C);
176
177 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
178 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
179 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
180 void CTX_wm_area_set(bContext *C, struct ScrArea *sa);
181 void CTX_wm_region_set(bContext *C, struct ARegion *region);
182 void CTX_wm_menu_set(bContext *C, struct ARegion *menu);
183 void CTX_wm_gizmo_group_set(bContext *C, struct wmGizmoGroup *gzgroup);
184 const char *CTX_wm_operator_poll_msg_get(struct bContext *C);
185 void CTX_wm_operator_poll_msg_set(struct bContext *C, const char *msg);
186
187 /* Data Context
188  *
189  * - listbases consist of CollectionPointerLink items and must be
190  *   freed with BLI_freelistN!
191  * - the dir listbase consists of LinkData items */
192
193 /* data type, needed so we can tell between a NULL pointer and an empty list */
194 enum {
195         CTX_DATA_TYPE_POINTER = 0,
196         CTX_DATA_TYPE_COLLECTION,
197 };
198
199 PointerRNA CTX_data_pointer_get(const bContext *C, const char *member);
200 PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type);
201 ListBase CTX_data_collection_get(const bContext *C, const char *member);
202 ListBase CTX_data_dir_get_ex(const bContext *C, const bool use_store, const bool use_rna, const bool use_all);
203 ListBase CTX_data_dir_get(const bContext *C);
204 int CTX_data_get(const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb, short *r_type);
205
206 void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
207 void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
208
209 void CTX_data_id_list_add(bContextDataResult *result, struct ID *id);
210 void CTX_data_list_add(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
211
212 void CTX_data_dir_set(bContextDataResult *result, const char **member);
213
214 void CTX_data_type_set(struct bContextDataResult *result, short type);
215 short CTX_data_type_get(struct bContextDataResult *result);
216
217 bool CTX_data_equals(const char *member, const char *str);
218 bool CTX_data_dir(const char *member);
219
220 #define CTX_DATA_BEGIN(C, Type, instance, member)                             \
221         {                                                                         \
222                 ListBase ctx_data_list;                                               \
223                 CollectionPointerLink *ctx_link;                                      \
224                 CTX_data_##member(C, &ctx_data_list);                                 \
225                 for (ctx_link = ctx_data_list.first;                                  \
226                      ctx_link;                                                        \
227                      ctx_link = ctx_link->next)                                       \
228                 {                                                                     \
229                         Type instance = ctx_link->ptr.data;
230
231 #define CTX_DATA_END                                                          \
232                 }                                                                     \
233                 BLI_freelistN(&ctx_data_list);                                        \
234 } (void)0
235
236 #define CTX_DATA_BEGIN_WITH_ID(C, Type, instance, member, Type_id, instance_id)      \
237         CTX_DATA_BEGIN(C, Type, instance, member) \
238         Type_id instance_id = ctx_link->ptr.id.data; \
239
240 int ctx_data_list_count(const bContext *C, int (*func)(const bContext *, ListBase *));
241
242 #define CTX_DATA_COUNT(C, member) \
243         ctx_data_list_count(C, CTX_data_##member)
244
245 /* Data Context Members */
246
247 struct Main *CTX_data_main(const bContext *C);
248 struct Scene *CTX_data_scene(const bContext *C);
249 struct LayerCollection *CTX_data_layer_collection(const bContext *C);
250 struct Collection *CTX_data_collection(const bContext *C);
251 struct ViewLayer *CTX_data_view_layer(const bContext *C);
252 struct RenderEngineType *CTX_data_engine_type(const bContext *C);
253 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
254
255 const char *CTX_data_mode_string(const bContext *C);
256 int CTX_data_mode_enum_ex(
257         const struct Object *obedit, const struct Object *ob,
258         const eObjectMode object_mode);
259 int CTX_data_mode_enum(const bContext *C);
260
261 void CTX_data_main_set(bContext *C, struct Main *bmain);
262 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
263
264 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
265 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
266
267 int CTX_data_editable_objects(const bContext *C, ListBase *list);
268 int CTX_data_editable_bases(const bContext *C, ListBase *list);
269
270 int CTX_data_selected_objects(const bContext *C, ListBase *list);
271 int CTX_data_selected_bases(const bContext *C, ListBase *list);
272
273 int CTX_data_visible_objects(const bContext *C, ListBase *list);
274 int CTX_data_visible_bases(const bContext *C, ListBase *list);
275
276 int CTX_data_selectable_objects(const bContext *C, ListBase *list);
277 int CTX_data_selectable_bases(const bContext *C, ListBase *list);
278
279 struct Object *CTX_data_active_object(const bContext *C);
280 struct Base *CTX_data_active_base(const bContext *C);
281 struct Object *CTX_data_edit_object(const bContext *C);
282
283 struct Image *CTX_data_edit_image(const bContext *C);
284
285 struct Text *CTX_data_edit_text(const bContext *C);
286 struct MovieClip *CTX_data_edit_movieclip(const bContext *C);
287 struct Mask *CTX_data_edit_mask(const bContext *C);
288
289 struct CacheFile *CTX_data_edit_cachefile(const bContext *C);
290
291 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
292
293 struct EditBone *CTX_data_active_bone(const bContext *C);
294 int CTX_data_selected_bones(const bContext *C, ListBase *list);
295 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
296 int CTX_data_visible_bones(const bContext *C, ListBase *list);
297 int CTX_data_editable_bones(const bContext *C, ListBase *list);
298
299 struct bPoseChannel *CTX_data_active_pose_bone(const bContext *C);
300 int CTX_data_selected_pose_bones(const bContext *C, ListBase *list);
301 int CTX_data_selected_pose_bones_from_active_object(const bContext *C, ListBase *list);
302 int CTX_data_visible_pose_bones(const bContext *C, ListBase *list);
303
304 struct bGPdata *CTX_data_gpencil_data(const bContext *C);
305 struct bGPDlayer *CTX_data_active_gpencil_layer(const bContext *C);
306 struct bGPDframe *CTX_data_active_gpencil_frame(const bContext *C);
307 int CTX_data_visible_gpencil_layers(const bContext *C, ListBase *list);
308 int CTX_data_editable_gpencil_layers(const bContext *C, ListBase *list);
309 int CTX_data_editable_gpencil_strokes(const bContext *C, ListBase *list);
310
311 struct Depsgraph *CTX_data_depsgraph(const bContext *C);
312
313 /* Will Return NULL if depsgraph is not allocated yet.
314  * Only used by handful of operators which are run on file load.
315  */
316 struct Depsgraph *CTX_data_depsgraph_on_load(const bContext *C);
317
318 #ifdef __cplusplus
319 }
320 #endif
321
322 #endif