Merging r38988 through r38992 from trunk into soc-2011-tomato
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 /** \file BKE_context.h
32  *  \ingroup bke
33  */
34
35 #include "DNA_listBase.h"
36 #include "RNA_types.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 struct ARegion;
43 struct bScreen;
44 struct EditMesh;
45 struct ListBase;
46 struct Main;
47 struct Object;
48 struct PointerRNA;
49 struct ReportList;
50 struct Scene;
51 struct ScrArea;
52 struct SpaceLink;
53 struct View3D;
54 struct RegionView3D;
55 struct StructRNA;
56 struct ToolSettings;
57 struct Image;
58 struct Text;
59 struct ImBuf;
60 struct EditBone;
61 struct bPoseChannel;
62 struct wmWindow;
63 struct wmWindowManager;
64 struct SpaceText;
65 struct SpaceImage;
66 struct SpaceClip;
67 struct ID;
68
69 /* Structs */
70
71 struct bContext;
72 typedef struct bContext bContext;
73
74 struct bContextDataResult;
75 typedef struct bContextDataResult bContextDataResult;
76
77 typedef int (*bContextDataCallback)(const bContext *C,
78         const char *member, bContextDataResult *result);
79
80 typedef struct bContextStoreEntry {
81         struct bContextStoreEntry *next, *prev;
82
83         char name[128];
84         PointerRNA ptr;
85 } bContextStoreEntry;
86
87 typedef struct bContextStore {
88         struct bContextStore *next, *prev;
89
90         ListBase entries;
91         int used;
92 } bContextStore;
93
94 /* for the conrtext's rna mode enum
95  * keep aligned with data_mode_strings in context.c */
96 enum {
97         CTX_MODE_EDIT_MESH = 0,
98         CTX_MODE_EDIT_CURVE,
99         CTX_MODE_EDIT_SURFACE,
100         CTX_MODE_EDIT_TEXT,
101         CTX_MODE_EDIT_ARMATURE,
102         CTX_MODE_EDIT_METABALL,
103         CTX_MODE_EDIT_LATTICE,
104         CTX_MODE_POSE,
105         CTX_MODE_SCULPT,
106         CTX_MODE_PAINT_WEIGHT,
107         CTX_MODE_PAINT_VERTEX,
108         CTX_MODE_PAINT_TEXTURE,
109         CTX_MODE_PARTICLE,
110         CTX_MODE_OBJECT
111 };
112
113 /* Context */
114
115 bContext *CTX_create(void);
116 void CTX_free(bContext *C);
117
118 bContext *CTX_copy(const bContext *C);
119
120 /* Stored Context */
121
122 bContextStore *CTX_store_add(ListBase *contexts, const char *name, PointerRNA *ptr);
123 void CTX_store_set(bContext *C, bContextStore *store);
124 bContextStore *CTX_store_copy(bContextStore *store);
125 void CTX_store_free(bContextStore *store);
126 void CTX_store_free_list(ListBase *contexts);
127
128 /* need to store if python is initialized or not */
129 int CTX_py_init_get(bContext *C);
130 void CTX_py_init_set(bContext *C, int value);
131
132 void *CTX_py_dict_get(const bContext *C);
133 void CTX_py_dict_set(bContext *C, void *value);
134
135 /* Window Manager Context */
136
137 struct wmWindowManager *CTX_wm_manager(const bContext *C);
138 struct wmWindow *CTX_wm_window(const bContext *C);
139 struct bScreen *CTX_wm_screen(const bContext *C);
140 struct ScrArea *CTX_wm_area(const bContext *C);
141 struct SpaceLink *CTX_wm_space_data(const bContext *C);
142 struct ARegion *CTX_wm_region(const bContext *C);
143 void *CTX_wm_region_data(const bContext *C);
144 struct ARegion *CTX_wm_menu(const bContext *C);
145 struct ReportList *CTX_wm_reports(const bContext *C);
146
147 struct View3D *CTX_wm_view3d(const bContext *C);
148 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
149 struct SpaceText *CTX_wm_space_text(const bContext *C);
150 struct SpaceImage *CTX_wm_space_image(const bContext *C);
151 struct SpaceConsole *CTX_wm_space_console(const bContext *C);
152 struct SpaceButs *CTX_wm_space_buts(const bContext *C);
153 struct SpaceFile *CTX_wm_space_file(const bContext *C);
154 struct SpaceSeq *CTX_wm_space_seq(const bContext *C);
155 struct SpaceOops *CTX_wm_space_outliner(const bContext *C);
156 struct SpaceNla *CTX_wm_space_nla(const bContext *C);
157 struct SpaceTime *CTX_wm_space_time(const bContext *C);
158 struct SpaceNode *CTX_wm_space_node(const bContext *C);
159 struct SpaceLogic *CTX_wm_space_logic(const bContext *C);
160 struct SpaceIpo *CTX_wm_space_graph(const bContext *C);
161 struct SpaceAction *CTX_wm_space_action(const bContext *C);
162 struct SpaceInfo *CTX_wm_space_info(const bContext *C);
163 struct SpaceUserPref *CTX_wm_space_userpref(const bContext *C);
164 struct SpaceClip *CTX_wm_space_clip(const bContext *C);
165
166 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
167 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
168 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
169 void CTX_wm_area_set(bContext *C, struct ScrArea *sa);
170 void CTX_wm_region_set(bContext *C, struct ARegion *region);
171 void CTX_wm_menu_set(bContext *C, struct ARegion *menu);
172 const char *CTX_wm_operator_poll_msg_get(struct bContext *C);
173 void CTX_wm_operator_poll_msg_set(struct bContext *C, const char *msg);
174
175 /* Data Context
176
177    - listbases consist of CollectionPointerLink items and must be
178          freed with BLI_freelistN!
179    - the dir listbase consits of LinkData items */
180
181 /* data type, needed so we can tell between a NULL pointer and an empty list */
182 enum {
183         CTX_DATA_TYPE_POINTER = 0,
184         CTX_DATA_TYPE_COLLECTION
185 };
186
187 PointerRNA CTX_data_pointer_get(const bContext *C, const char *member);
188 PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type);
189 ListBase CTX_data_collection_get(const bContext *C, const char *member);
190 ListBase CTX_data_dir_get(const bContext *C);
191 int CTX_data_get(const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb, short *r_type);
192
193 void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
194 void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
195
196 void CTX_data_id_list_add(bContextDataResult *result, struct ID *id);
197 void CTX_data_list_add(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
198
199 void CTX_data_dir_set(bContextDataResult *result, const char **member);
200
201 void CTX_data_type_set(struct bContextDataResult *result, short type);
202 short CTX_data_type_get(struct bContextDataResult *result);
203
204 int CTX_data_equals(const char *member, const char *str);
205 int CTX_data_dir(const char *member);
206
207 /*void CTX_data_pointer_set(bContextDataResult *result, void *data);
208 void CTX_data_list_add(bContextDataResult *result, void *data);*/
209
210 #define CTX_DATA_BEGIN(C, Type, instance, member) \
211         { \
212                 ListBase ctx_data_list; \
213                 CollectionPointerLink *ctx_link; \
214                 CTX_data_##member(C, &ctx_data_list); \
215                 for(ctx_link=ctx_data_list.first; ctx_link; ctx_link=ctx_link->next) { \
216                         Type instance= ctx_link->ptr.data;
217
218 #define CTX_DATA_END \
219                 } \
220                 BLI_freelistN(&ctx_data_list); \
221         }
222
223 int ctx_data_list_count(const bContext *C, int (*func)(const bContext*, ListBase*));
224
225 #define CTX_DATA_COUNT(C, member) \
226         ctx_data_list_count(C, CTX_data_##member)
227
228 /* Data Context Members */
229
230 struct Main *CTX_data_main(const bContext *C);
231 struct Scene *CTX_data_scene(const bContext *C);
232 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
233
234 const char *CTX_data_mode_string(const bContext *C);
235 int CTX_data_mode_enum(const bContext *C);
236
237 void CTX_data_main_set(bContext *C, struct Main *bmain);
238 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
239
240 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
241 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
242
243 int CTX_data_selected_objects(const bContext *C, ListBase *list);
244 int CTX_data_selected_bases(const bContext *C, ListBase *list);
245
246 int CTX_data_visible_objects(const bContext *C, ListBase *list);
247 int CTX_data_visible_bases(const bContext *C, ListBase *list);
248
249 int CTX_data_selectable_objects(const bContext *C, ListBase *list);
250 int CTX_data_selectable_bases(const bContext *C, ListBase *list);
251
252 struct Object *CTX_data_active_object(const bContext *C);
253 struct Base *CTX_data_active_base(const bContext *C);
254 struct Object *CTX_data_edit_object(const bContext *C);
255
256 struct Image *CTX_data_edit_image(const bContext *C);
257
258 struct Text *CTX_data_edit_text(const bContext *C);
259 struct MovieClip *CTX_data_edit_movieclip(const bContext *C);
260
261 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
262
263 struct EditBone *CTX_data_active_bone(const bContext *C);
264 int CTX_data_selected_bones(const bContext *C, ListBase *list);
265 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
266 int CTX_data_visible_bones(const bContext *C, ListBase *list);
267 int CTX_data_editable_bones(const bContext *C, ListBase *list);
268
269 struct bPoseChannel *CTX_data_active_pose_bone(const bContext *C);
270 int CTX_data_selected_pose_bones(const bContext *C, ListBase *list);
271 int CTX_data_visible_pose_bones(const bContext *C, ListBase *list);
272
273 #ifdef __cplusplus
274 }
275 #endif
276         
277 #endif
278