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