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