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 ListBase;
44 struct Main;
45 struct Object;
46 struct PointerRNA;
47 struct ReportList;
48 struct Scene;
49 struct ScrArea;
50 struct SpaceLink;
51 struct View3D;
52 struct RegionView3D;
53 struct StructRNA;
54 struct ToolSettings;
55 struct Image;
56 struct Text;
57 struct EditBone;
58 struct bPoseChannel;
59 struct bGPdata;
60 struct bGPDlayer;
61 struct bGPDframe;
62 struct bGPDpalette;
63 struct bGPDpalettecolor;
64 struct bGPDbrush;
65 struct wmWindow;
66 struct wmWindowManager;
67 struct SpaceText;
68 struct SpaceImage;
69 struct SpaceClip;
70 struct ID;
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 {
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_OBJECT
113 };
114
115 /* Context */
116
117 bContext *CTX_create(void);
118 void CTX_free(bContext *C);
119
120 bContext *CTX_copy(const bContext *C);
121
122 /* Stored Context */
123
124 bContextStore *CTX_store_add(ListBase *contexts, const char *name, PointerRNA *ptr);
125 bContextStore *CTX_store_add_all(ListBase *contexts, bContextStore *context);
126 void CTX_store_set(bContext *C, bContextStore *store);
127 bContextStore *CTX_store_copy(bContextStore *store);
128 void CTX_store_free(bContextStore *store);
129 void CTX_store_free_list(ListBase *contexts);
130
131 /* need to store if python is initialized or not */
132 int CTX_py_init_get(bContext *C);
133 void CTX_py_init_set(bContext *C, int value);
134
135 void *CTX_py_dict_get(const bContext *C);
136 void CTX_py_dict_set(bContext *C, void *value);
137
138 /* Window Manager Context */
139
140 struct wmWindowManager *CTX_wm_manager(const bContext *C);
141 struct wmWindow *CTX_wm_window(const bContext *C);
142 struct bScreen *CTX_wm_screen(const bContext *C);
143 struct ScrArea *CTX_wm_area(const bContext *C);
144 struct SpaceLink *CTX_wm_space_data(const bContext *C);
145 struct ARegion *CTX_wm_region(const bContext *C);
146 void *CTX_wm_region_data(const bContext *C);
147 struct ARegion *CTX_wm_menu(const bContext *C);
148 struct ReportList *CTX_wm_reports(const bContext *C);
149
150 struct View3D *CTX_wm_view3d(const bContext *C);
151 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
152 struct SpaceText *CTX_wm_space_text(const bContext *C);
153 struct SpaceImage *CTX_wm_space_image(const bContext *C);
154 struct SpaceConsole *CTX_wm_space_console(const bContext *C);
155 struct SpaceButs *CTX_wm_space_buts(const bContext *C);
156 struct SpaceFile *CTX_wm_space_file(const bContext *C);
157 struct SpaceSeq *CTX_wm_space_seq(const bContext *C);
158 struct SpaceOops *CTX_wm_space_outliner(const bContext *C);
159 struct SpaceNla *CTX_wm_space_nla(const bContext *C);
160 struct SpaceTime *CTX_wm_space_time(const bContext *C);
161 struct SpaceNode *CTX_wm_space_node(const bContext *C);
162 struct SpaceLogic *CTX_wm_space_logic(const bContext *C);
163 struct SpaceIpo *CTX_wm_space_graph(const bContext *C);
164 struct SpaceAction *CTX_wm_space_action(const bContext *C);
165 struct SpaceInfo *CTX_wm_space_info(const bContext *C);
166 struct SpaceUserPref *CTX_wm_space_userpref(const bContext *C);
167 struct SpaceClip *CTX_wm_space_clip(const bContext *C);
168
169 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
170 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
171 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
172 void CTX_wm_area_set(bContext *C, struct ScrArea *sa);
173 void CTX_wm_region_set(bContext *C, struct ARegion *region);
174 void CTX_wm_menu_set(bContext *C, struct ARegion *menu);
175 const char *CTX_wm_operator_poll_msg_get(struct bContext *C);
176 void CTX_wm_operator_poll_msg_set(struct bContext *C, const char *msg);
177
178 /* Data Context
179  *
180  * - listbases consist of CollectionPointerLink items and must be
181  *   freed with BLI_freelistN!
182  * - the dir listbase consists of LinkData items */
183
184 /* data type, needed so we can tell between a NULL pointer and an empty list */
185 enum {
186         CTX_DATA_TYPE_POINTER = 0,
187         CTX_DATA_TYPE_COLLECTION
188 };
189
190 PointerRNA CTX_data_pointer_get(const bContext *C, const char *member);
191 PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type);
192 ListBase CTX_data_collection_get(const bContext *C, const char *member);
193 ListBase CTX_data_dir_get_ex(const bContext *C, const bool use_store, const bool use_rna, const bool use_all);
194 ListBase CTX_data_dir_get(const bContext *C);
195 int CTX_data_get(const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb, short *r_type);
196
197 void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
198 void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
199
200 void CTX_data_id_list_add(bContextDataResult *result, struct ID *id);
201 void CTX_data_list_add(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
202
203 void CTX_data_dir_set(bContextDataResult *result, const char **member);
204
205 void CTX_data_type_set(struct bContextDataResult *result, short type);
206 short CTX_data_type_get(struct bContextDataResult *result);
207
208 bool CTX_data_equals(const char *member, const char *str);
209 bool CTX_data_dir(const char *member);
210
211 #if 0
212 void CTX_data_pointer_set(bContextDataResult *result, void *data);
213 void CTX_data_list_add(bContextDataResult *result, void *data);
214 #endif
215
216 #define CTX_DATA_BEGIN(C, Type, instance, member)                             \
217         {                                                                         \
218                 ListBase ctx_data_list;                                               \
219                 CollectionPointerLink *ctx_link;                                      \
220                 CTX_data_##member(C, &ctx_data_list);                                 \
221                 for (ctx_link = ctx_data_list.first;                                  \
222                      ctx_link;                                                        \
223                      ctx_link = ctx_link->next)                                       \
224                 {                                                                     \
225                         Type instance = ctx_link->ptr.data;
226
227 #define CTX_DATA_END                                                          \
228                 }                                                                     \
229                 BLI_freelistN(&ctx_data_list);                                        \
230 } (void)0
231
232 int ctx_data_list_count(const bContext *C, int (*func)(const bContext *, ListBase *));
233
234 #define CTX_DATA_COUNT(C, member) \
235         ctx_data_list_count(C, CTX_data_##member)
236
237 /* Data Context Members */
238
239 struct Main *CTX_data_main(const bContext *C);
240 struct Scene *CTX_data_scene(const bContext *C);
241 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
242
243 const char *CTX_data_mode_string(const bContext *C);
244 int CTX_data_mode_enum(const bContext *C);
245
246 void CTX_data_main_set(bContext *C, struct Main *bmain);
247 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
248
249 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
250 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
251
252 int CTX_data_editable_objects(const bContext *C, ListBase *list);
253 int CTX_data_editable_bases(const bContext *C, ListBase *list);
254
255 int CTX_data_selected_objects(const bContext *C, ListBase *list);
256 int CTX_data_selected_bases(const bContext *C, ListBase *list);
257
258 int CTX_data_visible_objects(const bContext *C, ListBase *list);
259 int CTX_data_visible_bases(const bContext *C, ListBase *list);
260
261 int CTX_data_selectable_objects(const bContext *C, ListBase *list);
262 int CTX_data_selectable_bases(const bContext *C, ListBase *list);
263
264 struct Object *CTX_data_active_object(const bContext *C);
265 struct Base *CTX_data_active_base(const bContext *C);
266 struct Object *CTX_data_edit_object(const bContext *C);
267
268 struct Image *CTX_data_edit_image(const bContext *C);
269
270 struct Text *CTX_data_edit_text(const bContext *C);
271 struct MovieClip *CTX_data_edit_movieclip(const bContext *C);
272 struct Mask *CTX_data_edit_mask(const bContext *C);
273
274 struct CacheFile *CTX_data_edit_cachefile(const bContext *C);
275
276 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
277
278 struct EditBone *CTX_data_active_bone(const bContext *C);
279 int CTX_data_selected_bones(const bContext *C, ListBase *list);
280 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
281 int CTX_data_visible_bones(const bContext *C, ListBase *list);
282 int CTX_data_editable_bones(const bContext *C, ListBase *list);
283
284 struct bPoseChannel *CTX_data_active_pose_bone(const bContext *C);
285 int CTX_data_selected_pose_bones(const bContext *C, ListBase *list);
286 int CTX_data_visible_pose_bones(const bContext *C, ListBase *list);
287
288 struct bGPdata *CTX_data_gpencil_data(const bContext *C);
289 struct bGPDlayer *CTX_data_active_gpencil_layer(const bContext *C);
290 struct bGPDframe *CTX_data_active_gpencil_frame(const bContext *C);
291 struct bGPDpalette *CTX_data_active_gpencil_palette(const bContext *C);
292 struct bGPDpalettecolor *CTX_data_active_gpencil_palettecolor(const bContext *C);
293 struct bGPDbrush *CTX_data_active_gpencil_brush(const bContext *C);
294 int CTX_data_visible_gpencil_layers(const bContext *C, ListBase *list);
295 int CTX_data_editable_gpencil_layers(const bContext *C, ListBase *list);
296 int CTX_data_editable_gpencil_strokes(const bContext *C, ListBase *list);
297
298
299 #ifdef __cplusplus
300 }
301 #endif
302         
303 #endif
304