Merge branch 'master' into blender2.8
[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 ViewRender;
58 struct RegionView3D;
59 struct StructRNA;
60 struct ToolSettings;
61 struct Image;
62 struct Text;
63 struct EditBone;
64 struct bPoseChannel;
65 struct bGPdata;
66 struct bGPDlayer;
67 struct bGPDframe;
68 struct bGPDpalette;
69 struct bGPDpalettecolor;
70 struct bGPDbrush;
71 struct wmWindow;
72 struct wmWindowManager;
73 struct RenderEngineType;
74 struct SpaceText;
75 struct SpaceImage;
76 struct SpaceClip;
77 struct ID;
78 struct EvaluationContext;
79
80 /* Structs */
81
82 struct bContext;
83 typedef struct bContext bContext;
84
85 struct bContextDataResult;
86 typedef struct bContextDataResult bContextDataResult;
87
88 typedef int (*bContextDataCallback)(const bContext *C,
89                                     const char *member, bContextDataResult *result);
90
91 typedef struct bContextStoreEntry {
92         struct bContextStoreEntry *next, *prev;
93
94         char name[128];
95         PointerRNA ptr;
96 } bContextStoreEntry;
97
98 typedef struct bContextStore {
99         struct bContextStore *next, *prev;
100
101         ListBase entries;
102         bool used;
103 } bContextStore;
104
105 /* for the context's rna mode enum
106  * keep aligned with data_mode_strings in context.c */
107 enum {
108         CTX_MODE_EDIT_MESH = 0,
109         CTX_MODE_EDIT_CURVE,
110         CTX_MODE_EDIT_SURFACE,
111         CTX_MODE_EDIT_TEXT,
112         CTX_MODE_EDIT_ARMATURE,
113         CTX_MODE_EDIT_METABALL,
114         CTX_MODE_EDIT_LATTICE,
115         CTX_MODE_POSE,
116         CTX_MODE_SCULPT,
117         CTX_MODE_PAINT_WEIGHT,
118         CTX_MODE_PAINT_VERTEX,
119         CTX_MODE_PAINT_TEXTURE,
120         CTX_MODE_PARTICLE,
121         CTX_MODE_OBJECT
122 };
123
124 /* Context */
125
126 bContext *CTX_create(void);
127 void CTX_free(bContext *C);
128
129 bContext *CTX_copy(const bContext *C);
130
131 /* Stored Context */
132
133 bContextStore *CTX_store_add(ListBase *contexts, const char *name, PointerRNA *ptr);
134 bContextStore *CTX_store_add_all(ListBase *contexts, bContextStore *context);
135 void CTX_store_set(bContext *C, bContextStore *store);
136 bContextStore *CTX_store_copy(bContextStore *store);
137 void CTX_store_free(bContextStore *store);
138 void CTX_store_free_list(ListBase *contexts);
139
140 /* need to store if python is initialized or not */
141 int CTX_py_init_get(bContext *C);
142 void CTX_py_init_set(bContext *C, int value);
143
144 void *CTX_py_dict_get(const bContext *C);
145 void CTX_py_dict_set(bContext *C, void *value);
146
147 /* Window Manager Context */
148
149 struct wmWindowManager *CTX_wm_manager(const bContext *C);
150 struct wmWindow *CTX_wm_window(const bContext *C);
151 struct WorkSpace *CTX_wm_workspace(const bContext *C);
152 struct bScreen *CTX_wm_screen(const bContext *C);
153 struct ScrArea *CTX_wm_area(const bContext *C);
154 struct SpaceLink *CTX_wm_space_data(const bContext *C);
155 struct ARegion *CTX_wm_region(const bContext *C);
156 void *CTX_wm_region_data(const bContext *C);
157 struct ARegion *CTX_wm_menu(const bContext *C);
158 struct wmManipulatorGroup *CTX_wm_manipulator_group(const bContext *C);
159 struct ReportList *CTX_wm_reports(const bContext *C);
160
161 struct View3D *CTX_wm_view3d(const bContext *C);
162 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
163 struct SpaceText *CTX_wm_space_text(const bContext *C);
164 struct SpaceImage *CTX_wm_space_image(const bContext *C);
165 struct SpaceConsole *CTX_wm_space_console(const bContext *C);
166 struct SpaceButs *CTX_wm_space_buts(const bContext *C);
167 struct SpaceFile *CTX_wm_space_file(const bContext *C);
168 struct SpaceSeq *CTX_wm_space_seq(const bContext *C);
169 struct SpaceOops *CTX_wm_space_outliner(const bContext *C);
170 struct SpaceNla *CTX_wm_space_nla(const bContext *C);
171 struct SpaceTime *CTX_wm_space_time(const bContext *C);
172 struct SpaceNode *CTX_wm_space_node(const bContext *C);
173 struct SpaceLogic *CTX_wm_space_logic(const bContext *C);
174 struct SpaceIpo *CTX_wm_space_graph(const bContext *C);
175 struct SpaceAction *CTX_wm_space_action(const bContext *C);
176 struct SpaceInfo *CTX_wm_space_info(const bContext *C);
177 struct SpaceUserPref *CTX_wm_space_userpref(const bContext *C);
178 struct SpaceClip *CTX_wm_space_clip(const bContext *C);
179
180 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
181 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
182 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
183 void CTX_wm_area_set(bContext *C, struct ScrArea *sa);
184 void CTX_wm_region_set(bContext *C, struct ARegion *region);
185 void CTX_wm_menu_set(bContext *C, struct ARegion *menu);
186 void CTX_wm_manipulator_group_set(bContext *C, struct wmManipulatorGroup *mgroup);
187 const char *CTX_wm_operator_poll_msg_get(struct bContext *C);
188 void CTX_wm_operator_poll_msg_set(struct bContext *C, const char *msg);
189
190 /* Data Context
191  *
192  * - listbases consist of CollectionPointerLink items and must be
193  *   freed with BLI_freelistN!
194  * - the dir listbase consists of LinkData items */
195
196 /* data type, needed so we can tell between a NULL pointer and an empty list */
197 enum {
198         CTX_DATA_TYPE_POINTER = 0,
199         CTX_DATA_TYPE_COLLECTION
200 };
201
202 PointerRNA CTX_data_pointer_get(const bContext *C, const char *member);
203 PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type);
204 ListBase CTX_data_collection_get(const bContext *C, const char *member);
205 ListBase CTX_data_dir_get_ex(const bContext *C, const bool use_store, const bool use_rna, const bool use_all);
206 ListBase CTX_data_dir_get(const bContext *C);
207 int CTX_data_get(const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb, short *r_type);
208
209 void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
210 void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
211
212 void CTX_data_id_list_add(bContextDataResult *result, struct ID *id);
213 void CTX_data_list_add(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
214
215 void CTX_data_dir_set(bContextDataResult *result, const char **member);
216
217 void CTX_data_type_set(struct bContextDataResult *result, short type);
218 short CTX_data_type_get(struct bContextDataResult *result);
219
220 bool CTX_data_equals(const char *member, const char *str);
221 bool CTX_data_dir(const char *member);
222
223 #if 0
224 void CTX_data_pointer_set(bContextDataResult *result, void *data);
225 void CTX_data_list_add(bContextDataResult *result, void *data);
226 #endif
227
228 #define CTX_DATA_BEGIN(C, Type, instance, member)                             \
229         {                                                                         \
230                 ListBase ctx_data_list;                                               \
231                 CollectionPointerLink *ctx_link;                                      \
232                 CTX_data_##member(C, &ctx_data_list);                                 \
233                 for (ctx_link = ctx_data_list.first;                                  \
234                      ctx_link;                                                        \
235                      ctx_link = ctx_link->next)                                       \
236                 {                                                                     \
237                         Type instance = ctx_link->ptr.data;
238
239 #define CTX_DATA_END                                                          \
240                 }                                                                     \
241                 BLI_freelistN(&ctx_data_list);                                        \
242 } (void)0
243
244 int ctx_data_list_count(const bContext *C, int (*func)(const bContext *, ListBase *));
245
246 #define CTX_DATA_COUNT(C, member) \
247         ctx_data_list_count(C, CTX_data_##member)
248
249 /* Data Context Members */
250
251 struct Main *CTX_data_main(const bContext *C);
252 struct Scene *CTX_data_scene(const bContext *C);
253 struct LayerCollection *CTX_data_layer_collection(const bContext *C);
254 struct SceneCollection *CTX_data_scene_collection(const bContext *C);
255 struct SceneLayer *CTX_data_scene_layer(const bContext *C);
256 struct ViewRender *CTX_data_view_render(const bContext *C);
257 struct RenderEngineType *CTX_data_engine(const bContext *C);
258 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
259
260 const char *CTX_data_mode_string(const bContext *C);
261 int CTX_data_mode_enum_ex(const struct Object *obedit, const struct Object *ob);
262 int CTX_data_mode_enum(const bContext *C);
263
264 void CTX_data_main_set(bContext *C, struct Main *bmain);
265 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
266
267 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
268 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
269
270 int CTX_data_editable_objects(const bContext *C, ListBase *list);
271 int CTX_data_editable_bases(const bContext *C, ListBase *list);
272
273 int CTX_data_selected_objects(const bContext *C, ListBase *list);
274 int CTX_data_selected_bases(const bContext *C, ListBase *list);
275
276 int CTX_data_visible_objects(const bContext *C, ListBase *list);
277 int CTX_data_visible_bases(const bContext *C, ListBase *list);
278
279 int CTX_data_selectable_objects(const bContext *C, ListBase *list);
280 int CTX_data_selectable_bases(const bContext *C, ListBase *list);
281
282 struct Object *CTX_data_active_object(const bContext *C);
283 struct Base *CTX_data_active_base(const bContext *C);
284 struct Object *CTX_data_edit_object(const bContext *C);
285
286 struct Image *CTX_data_edit_image(const bContext *C);
287
288 struct Text *CTX_data_edit_text(const bContext *C);
289 struct MovieClip *CTX_data_edit_movieclip(const bContext *C);
290 struct Mask *CTX_data_edit_mask(const bContext *C);
291
292 struct CacheFile *CTX_data_edit_cachefile(const bContext *C);
293
294 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
295
296 struct EditBone *CTX_data_active_bone(const bContext *C);
297 int CTX_data_selected_bones(const bContext *C, ListBase *list);
298 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
299 int CTX_data_visible_bones(const bContext *C, ListBase *list);
300 int CTX_data_editable_bones(const bContext *C, ListBase *list);
301
302 struct bPoseChannel *CTX_data_active_pose_bone(const bContext *C);
303 int CTX_data_selected_pose_bones(const bContext *C, ListBase *list);
304 int CTX_data_visible_pose_bones(const bContext *C, ListBase *list);
305
306 struct bGPdata *CTX_data_gpencil_data(const bContext *C);
307 struct bGPDlayer *CTX_data_active_gpencil_layer(const bContext *C);
308 struct bGPDframe *CTX_data_active_gpencil_frame(const bContext *C);
309 struct bGPDpalette *CTX_data_active_gpencil_palette(const bContext *C);
310 struct bGPDpalettecolor *CTX_data_active_gpencil_palettecolor(const bContext *C);
311 struct bGPDbrush *CTX_data_active_gpencil_brush(const bContext *C);
312 int CTX_data_visible_gpencil_layers(const bContext *C, ListBase *list);
313 int CTX_data_editable_gpencil_layers(const bContext *C, ListBase *list);
314 int CTX_data_editable_gpencil_strokes(const bContext *C, ListBase *list);
315
316 struct Depsgraph *CTX_data_depsgraph(const bContext *C);
317
318 void CTX_data_eval_ctx(const bContext *C, struct EvaluationContext *eval_ctx);
319
320 #ifdef __cplusplus
321 }
322 #endif
323         
324 #endif
325