Python can now run operators with their own context (data context).
[blender.git] / source / blender / blenkernel / BKE_context.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * Contributor(s): Blender Foundation (2008).
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef BKE_CONTEXT_H
29 #define BKE_CONTEXT_H
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #include "DNA_listBase.h"
36 #include "RNA_types.h"
37
38 struct ARegion;
39 struct bScreen;
40 struct EditMesh;
41 struct ListBase;
42 struct Main;
43 struct Object;
44 struct PointerRNA;
45 struct ReportList;
46 struct Scene;
47 struct ScrArea;
48 struct SpaceLink;
49 struct View3D;
50 struct RegionView3D;
51 struct StructRNA;
52 struct ToolSettings;
53 struct Image;
54 struct Text;
55 struct ImBuf;
56 struct EditBone;
57 struct bPoseChannel;
58 struct wmWindow;
59 struct wmWindowManager;
60 struct SpaceText;
61 struct SpaceImage;
62 struct ID;
63
64 /* Structs */
65
66 struct bContext;
67 typedef struct bContext bContext;
68
69 struct bContextDataResult;
70 typedef struct bContextDataResult bContextDataResult;
71
72 typedef int (*bContextDataCallback)(const bContext *C,
73         const char *member, bContextDataResult *result);
74
75 typedef struct bContextStoreEntry {
76         struct bContextStoreEntry *next, *prev;
77
78         char name[128];
79         PointerRNA ptr;
80 } bContextStoreEntry;
81
82 typedef struct bContextStore {
83         struct bContextStore *next, *prev;
84
85         ListBase entries;
86         int used;
87 } bContextStore;
88
89 /* for the conrtext's rna mode enum
90  * keep aligned with data_mode_strings in context.c */
91 enum {
92         CTX_MODE_EDIT_MESH = 0,
93         CTX_MODE_EDIT_CURVE,
94         CTX_MODE_EDIT_SURFACE,
95         CTX_MODE_EDIT_TEXT,
96         CTX_MODE_EDIT_ARMATURE,
97         CTX_MODE_EDIT_METABALL,
98         CTX_MODE_EDIT_LATTICE,
99         CTX_MODE_POSE,
100         CTX_MODE_SCULPT,
101         CTX_MODE_PAINT_WEIGHT,
102         CTX_MODE_PAINT_VERTEX,
103         CTX_MODE_PAINT_TEXTURE,
104         CTX_MODE_PARTICLE,
105         CTX_MODE_OBJECT
106 };
107
108 /* Context */
109
110 bContext *CTX_create(void);
111 void CTX_free(bContext *C);
112
113 bContext *CTX_copy(const bContext *C);
114
115 /* Stored Context */
116
117 bContextStore *CTX_store_add(ListBase *contexts, char *name, PointerRNA *ptr);
118 void CTX_store_set(bContext *C, bContextStore *store);
119 bContextStore *CTX_store_copy(bContextStore *store);
120 void CTX_store_free(bContextStore *store);
121 void CTX_store_free_list(ListBase *contexts);
122
123 /* need to store if python is initialized or not */
124 int CTX_py_init_get(bContext *C);
125 void CTX_py_init_set(bContext *C, int value);
126
127 void *CTX_py_dict_get(bContext *C);
128 void CTX_py_dict_set(bContext *C, void *value);
129
130 /* Window Manager Context */
131
132 struct wmWindowManager *CTX_wm_manager(const bContext *C);
133 struct wmWindow *CTX_wm_window(const bContext *C);
134 struct bScreen *CTX_wm_screen(const bContext *C);
135 struct ScrArea *CTX_wm_area(const bContext *C);
136 struct SpaceLink *CTX_wm_space_data(const bContext *C);
137 struct ARegion *CTX_wm_region(const bContext *C);
138 void *CTX_wm_region_data(const bContext *C);
139 struct ARegion *CTX_wm_menu(const bContext *C);
140 struct ReportList *CTX_wm_reports(const bContext *C);
141
142 struct View3D *CTX_wm_view3d(const bContext *C);
143 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
144 struct SpaceText *CTX_wm_space_text(const bContext *C);
145 struct SpaceImage *CTX_wm_space_image(const bContext *C);
146 struct SpaceConsole *CTX_wm_space_console(const bContext *C);
147 struct SpaceButs *CTX_wm_space_buts(const bContext *C);
148 struct SpaceFile *CTX_wm_space_file(const bContext *C);
149 struct SpaceSeq *CTX_wm_space_seq(const bContext *C);
150 struct SpaceOops *CTX_wm_space_outliner(const bContext *C);
151 struct SpaceNla *CTX_wm_space_nla(const bContext *C);
152 struct SpaceTime *CTX_wm_space_time(const bContext *C);
153 struct SpaceNode *CTX_wm_space_node(const bContext *C);
154 struct SpaceLogic *CTX_wm_space_logic(const bContext *C);
155 struct SpaceIpo *CTX_wm_space_graph(const bContext *C);
156 struct SpaceAction *CTX_wm_space_action(const bContext *C);
157 struct SpaceInfo *CTX_wm_space_info(const bContext *C);
158 struct SpaceUserPref *CTX_wm_space_userpref(const bContext *C);
159
160 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
161 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
162 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
163 void CTX_wm_area_set(bContext *C, struct ScrArea *sa);
164 void CTX_wm_region_set(bContext *C, struct ARegion *region);
165 void CTX_wm_menu_set(bContext *C, struct ARegion *menu);
166
167 /* Data Context
168
169    - listbases consist of CollectionPointerLink items and must be
170      freed with BLI_freelistN!
171    - the dir listbase consits of LinkData items */
172
173 PointerRNA CTX_data_pointer_get(const bContext *C, const char *member);
174 PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type);
175 ListBase CTX_data_collection_get(const bContext *C, const char *member);
176 ListBase CTX_data_dir_get(const bContext *C);
177 void CTX_data_get(const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb);
178
179 void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
180 void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
181
182 void CTX_data_id_list_add(bContextDataResult *result, struct ID *id);
183 void CTX_data_list_add(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
184
185 void CTX_data_dir_set(bContextDataResult *result, const char **member);
186
187 int CTX_data_equals(const char *member, const char *str);
188 int CTX_data_dir(const char *member);
189
190 /*void CTX_data_pointer_set(bContextDataResult *result, void *data);
191 void CTX_data_list_add(bContextDataResult *result, void *data);*/
192
193 #define CTX_DATA_BEGIN(C, Type, instance, member) \
194         { \
195                 ListBase ctx_data_list; \
196                 CollectionPointerLink *ctx_link; \
197                 CTX_data_##member(C, &ctx_data_list); \
198                 for(ctx_link=ctx_data_list.first; ctx_link; ctx_link=ctx_link->next) { \
199                         Type instance= ctx_link->ptr.data;
200
201 #define CTX_DATA_END \
202                 } \
203                 BLI_freelistN(&ctx_data_list); \
204         }
205
206 int ctx_data_list_count(const bContext *C, int (*func)(const bContext*, ListBase*));
207
208 #define CTX_DATA_COUNT(C, member) \
209         ctx_data_list_count(C, CTX_data_##member)
210
211 /* Data Context Members */
212
213 struct Main *CTX_data_main(const bContext *C);
214 struct Scene *CTX_data_scene(const bContext *C);
215 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
216
217 char *CTX_data_mode_string(const bContext *C);
218 int CTX_data_mode_enum(const bContext *C);
219
220 void CTX_data_main_set(bContext *C, struct Main *bmain);
221 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
222
223 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
224 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
225
226 int CTX_data_selected_objects(const bContext *C, ListBase *list);
227 int CTX_data_selected_bases(const bContext *C, ListBase *list);
228
229 int CTX_data_visible_objects(const bContext *C, ListBase *list);
230 int CTX_data_visible_bases(const bContext *C, ListBase *list);
231
232 int CTX_data_selectable_objects(const bContext *C, ListBase *list);
233 int CTX_data_selectable_bases(const bContext *C, ListBase *list);
234
235 struct Object *CTX_data_active_object(const bContext *C);
236 struct Base *CTX_data_active_base(const bContext *C);
237 struct Object *CTX_data_edit_object(const bContext *C);
238
239 struct Image *CTX_data_edit_image(const bContext *C);
240
241 struct Text *CTX_data_edit_text(const bContext *C);
242
243 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
244
245 struct EditBone *CTX_data_active_bone(const bContext *C);
246 int CTX_data_selected_bones(const bContext *C, ListBase *list);
247 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
248 int CTX_data_visible_bones(const bContext *C, ListBase *list);
249 int CTX_data_editable_bones(const bContext *C, ListBase *list);
250
251 struct bPoseChannel *CTX_data_active_pchan(const bContext *C);
252 int CTX_data_selected_pchans(const bContext *C, ListBase *list);
253 int CTX_data_visible_pchans(const bContext *C, ListBase *list);
254
255 #ifdef __cplusplus
256 }
257 #endif
258         
259 #endif
260