Merge branch 'blender2.7'
[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
24  * \ingroup bke
25  */
26
27 #include "DNA_listBase.h"
28 #include "RNA_types.h"
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 struct ARegion;
35 struct Base;
36 struct Brush;
37 struct CacheFile;
38 struct Collection;
39 struct Depsgraph;
40 struct EditBone;
41 struct ID;
42 struct Image;
43 struct LayerCollection;
44 struct ListBase;
45 struct Main;
46 struct Object;
47 struct PointerRNA;
48 struct RegionView3D;
49 struct RenderEngineType;
50 struct ReportList;
51 struct Scene;
52 struct ScrArea;
53 struct SpaceClip;
54 struct SpaceImage;
55 struct SpaceLink;
56 struct SpaceText;
57 struct StructRNA;
58 struct Text;
59 struct ToolSettings;
60 struct View3D;
61 struct ViewLayer;
62 struct ViewRender;
63 struct bGPDframe;
64 struct bGPDlayer;
65 struct bGPdata;
66 struct bPoseChannel;
67 struct bScreen;
68 struct wmWindow;
69 struct wmWindowManager;
70
71 #include "DNA_object_enums.h"
72
73 /* Structs */
74
75 struct bContext;
76 typedef struct bContext bContext;
77
78 struct bContextDataResult;
79 typedef struct bContextDataResult bContextDataResult;
80
81 typedef int (*bContextDataCallback)(const bContext *C,
82                                     const char *member, bContextDataResult *result);
83
84 typedef struct bContextStoreEntry {
85         struct bContextStoreEntry *next, *prev;
86
87         char name[128];
88         PointerRNA ptr;
89 } bContextStoreEntry;
90
91 typedef struct bContextStore {
92         struct bContextStore *next, *prev;
93
94         ListBase entries;
95         bool used;
96 } bContextStore;
97
98 /* for the context's rna mode enum
99  * keep aligned with data_mode_strings in context.c */
100 enum eContextObjectMode {
101         CTX_MODE_EDIT_MESH = 0,
102         CTX_MODE_EDIT_CURVE,
103         CTX_MODE_EDIT_SURFACE,
104         CTX_MODE_EDIT_TEXT,
105         CTX_MODE_EDIT_ARMATURE,
106         CTX_MODE_EDIT_METABALL,
107         CTX_MODE_EDIT_LATTICE,
108         CTX_MODE_POSE,
109         CTX_MODE_SCULPT,
110         CTX_MODE_PAINT_WEIGHT,
111         CTX_MODE_PAINT_VERTEX,
112         CTX_MODE_PAINT_TEXTURE,
113         CTX_MODE_PARTICLE,
114         CTX_MODE_OBJECT,
115         CTX_MODE_PAINT_GPENCIL,
116         CTX_MODE_EDIT_GPENCIL,
117         CTX_MODE_SCULPT_GPENCIL,
118         CTX_MODE_WEIGHT_GPENCIL,
119 };
120 #define CTX_MODE_NUM (CTX_MODE_WEIGHT_GPENCIL + 1)
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 wmGizmoGroup *CTX_wm_gizmo_group(const bContext *C);
157 struct wmMsgBus *CTX_wm_message_bus(const bContext *C);
158 struct ReportList *CTX_wm_reports(const bContext *C);
159
160 struct View3D *CTX_wm_view3d(const bContext *C);
161 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
162 struct SpaceText *CTX_wm_space_text(const bContext *C);
163 struct SpaceImage *CTX_wm_space_image(const bContext *C);
164 struct SpaceConsole *CTX_wm_space_console(const bContext *C);
165 struct SpaceProperties *CTX_wm_space_properties(const bContext *C);
166 struct SpaceFile *CTX_wm_space_file(const bContext *C);
167 struct SpaceSeq *CTX_wm_space_seq(const bContext *C);
168 struct SpaceOutliner *CTX_wm_space_outliner(const bContext *C);
169 struct SpaceNla *CTX_wm_space_nla(const bContext *C);
170 struct SpaceNode *CTX_wm_space_node(const bContext *C);
171 struct SpaceGraph *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 struct SpaceTopBar *CTX_wm_space_topbar(const bContext *C);
177
178 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
179 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
180 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
181 void CTX_wm_area_set(bContext *C, struct ScrArea *sa);
182 void CTX_wm_region_set(bContext *C, struct ARegion *region);
183 void CTX_wm_menu_set(bContext *C, struct ARegion *menu);
184 void CTX_wm_gizmo_group_set(bContext *C, struct wmGizmoGroup *gzgroup);
185 const char *CTX_wm_operator_poll_msg_get(struct bContext *C);
186 void CTX_wm_operator_poll_msg_set(struct bContext *C, const char *msg);
187
188 /* Data Context
189  *
190  * - listbases consist of CollectionPointerLink items and must be
191  *   freed with BLI_freelistN!
192  * - the dir listbase consists of LinkData items */
193
194 /* data type, needed so we can tell between a NULL pointer and an empty list */
195 enum {
196         CTX_DATA_TYPE_POINTER = 0,
197         CTX_DATA_TYPE_COLLECTION,
198 };
199
200 PointerRNA CTX_data_pointer_get(const bContext *C, const char *member);
201 PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type);
202 ListBase CTX_data_collection_get(const bContext *C, const char *member);
203 ListBase CTX_data_dir_get_ex(const bContext *C, const bool use_store, const bool use_rna, const bool use_all);
204 ListBase CTX_data_dir_get(const bContext *C);
205 int CTX_data_get(const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb, short *r_type);
206
207 void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
208 void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
209
210 void CTX_data_id_list_add(bContextDataResult *result, struct ID *id);
211 void CTX_data_list_add(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
212
213 void CTX_data_dir_set(bContextDataResult *result, const char **member);
214
215 void CTX_data_type_set(struct bContextDataResult *result, short type);
216 short CTX_data_type_get(struct bContextDataResult *result);
217
218 bool CTX_data_equals(const char *member, const char *str);
219 bool CTX_data_dir(const char *member);
220
221 #define CTX_DATA_BEGIN(C, Type, instance, member)                             \
222         {                                                                         \
223                 ListBase ctx_data_list;                                               \
224                 CollectionPointerLink *ctx_link;                                      \
225                 CTX_data_##member(C, &ctx_data_list);                                 \
226                 for (ctx_link = ctx_data_list.first;                                  \
227                      ctx_link;                                                        \
228                      ctx_link = ctx_link->next)                                       \
229                 {                                                                     \
230                         Type instance = ctx_link->ptr.data;
231
232 #define CTX_DATA_END                                                          \
233                 }                                                                     \
234                 BLI_freelistN(&ctx_data_list);                                        \
235 } (void)0
236
237 #define CTX_DATA_BEGIN_WITH_ID(C, Type, instance, member, Type_id, instance_id)      \
238         CTX_DATA_BEGIN(C, Type, instance, member) \
239         Type_id instance_id = ctx_link->ptr.id.data; \
240
241 int ctx_data_list_count(const bContext *C, int (*func)(const bContext *, ListBase *));
242
243 #define CTX_DATA_COUNT(C, member) \
244         ctx_data_list_count(C, CTX_data_##member)
245
246 /* Data Context Members */
247
248 struct Main *CTX_data_main(const bContext *C);
249 struct Scene *CTX_data_scene(const bContext *C);
250 struct LayerCollection *CTX_data_layer_collection(const bContext *C);
251 struct Collection *CTX_data_collection(const bContext *C);
252 struct ViewLayer *CTX_data_view_layer(const bContext *C);
253 struct RenderEngineType *CTX_data_engine_type(const bContext *C);
254 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
255
256 const char *CTX_data_mode_string(const bContext *C);
257 enum eContextObjectMode CTX_data_mode_enum_ex(
258         const struct Object *obedit, const struct Object *ob,
259         const eObjectMode object_mode);
260 enum eContextObjectMode CTX_data_mode_enum(const bContext *C);
261
262 void CTX_data_main_set(bContext *C, struct Main *bmain);
263 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
264
265 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
266 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
267
268 int CTX_data_editable_objects(const bContext *C, ListBase *list);
269 int CTX_data_editable_bases(const bContext *C, ListBase *list);
270
271 int CTX_data_selected_objects(const bContext *C, ListBase *list);
272 int CTX_data_selected_bases(const bContext *C, ListBase *list);
273
274 int CTX_data_visible_objects(const bContext *C, ListBase *list);
275 int CTX_data_visible_bases(const bContext *C, ListBase *list);
276
277 int CTX_data_selectable_objects(const bContext *C, ListBase *list);
278 int CTX_data_selectable_bases(const bContext *C, ListBase *list);
279
280 struct Object *CTX_data_active_object(const bContext *C);
281 struct Base *CTX_data_active_base(const bContext *C);
282 struct Object *CTX_data_edit_object(const bContext *C);
283
284 struct Image *CTX_data_edit_image(const bContext *C);
285
286 struct Text *CTX_data_edit_text(const bContext *C);
287 struct MovieClip *CTX_data_edit_movieclip(const bContext *C);
288 struct Mask *CTX_data_edit_mask(const bContext *C);
289
290 struct CacheFile *CTX_data_edit_cachefile(const bContext *C);
291
292 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
293
294 struct EditBone *CTX_data_active_bone(const bContext *C);
295 int CTX_data_selected_bones(const bContext *C, ListBase *list);
296 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
297 int CTX_data_visible_bones(const bContext *C, ListBase *list);
298 int CTX_data_editable_bones(const bContext *C, ListBase *list);
299
300 struct bPoseChannel *CTX_data_active_pose_bone(const bContext *C);
301 int CTX_data_selected_pose_bones(const bContext *C, ListBase *list);
302 int CTX_data_selected_pose_bones_from_active_object(const bContext *C, ListBase *list);
303 int CTX_data_visible_pose_bones(const bContext *C, ListBase *list);
304
305 struct bGPdata *CTX_data_gpencil_data(const bContext *C);
306 struct bGPDlayer *CTX_data_active_gpencil_layer(const bContext *C);
307 struct bGPDframe *CTX_data_active_gpencil_frame(const bContext *C);
308 int CTX_data_visible_gpencil_layers(const bContext *C, ListBase *list);
309 int CTX_data_editable_gpencil_layers(const bContext *C, ListBase *list);
310 int CTX_data_editable_gpencil_strokes(const bContext *C, ListBase *list);
311
312 struct Depsgraph *CTX_data_depsgraph(const bContext *C);
313
314 /* Will Return NULL if depsgraph is not allocated yet.
315  * Only used by handful of operators which are run on file load.
316  */
317 struct Depsgraph *CTX_data_depsgraph_on_load(const bContext *C);
318
319 #ifdef __cplusplus
320 }
321 #endif
322
323 #endif