merge with 2.5 (not trunk, last merge message said that on accident) at r22252
[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 /* Context */
90
91 bContext *CTX_create(void);
92 void CTX_free(bContext *C);
93
94 bContext *CTX_copy(const bContext *C);
95
96 /* Stored Context */
97
98 bContextStore *CTX_store_add(ListBase *contexts, char *name, PointerRNA *ptr);
99 void CTX_store_set(bContext *C, bContextStore *store);
100 bContextStore *CTX_store_copy(bContextStore *store);
101 void CTX_store_free(bContextStore *store);
102 void CTX_store_free_list(ListBase *contexts);
103
104 /* need to store if python is initialized or not */
105 int CTX_py_init_get(bContext *C);
106 void CTX_py_init_set(bContext *C, int value);
107
108 /* Window Manager Context */
109
110 struct wmWindowManager *CTX_wm_manager(const bContext *C);
111 struct wmWindow *CTX_wm_window(const bContext *C);
112 struct bScreen *CTX_wm_screen(const bContext *C);
113 struct ScrArea *CTX_wm_area(const bContext *C);
114 struct SpaceLink *CTX_wm_space_data(const bContext *C);
115 struct ARegion *CTX_wm_region(const bContext *C);
116 void *CTX_wm_region_data(const bContext *C);
117 struct ARegion *CTX_wm_menu(const bContext *C);
118 struct ReportList *CTX_wm_reports(const bContext *C);
119
120 struct View3D *CTX_wm_view3d(const bContext *C);
121 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
122 struct SpaceText *CTX_wm_space_text(const bContext *C);
123 struct SpaceImage *CTX_wm_space_image(const bContext *C);
124 struct SpaceConsole *CTX_wm_space_console(const bContext *C);
125 struct SpaceButs *CTX_wm_space_buts(const bContext *C);
126 struct SpaceFile *CTX_wm_space_file(const bContext *C);
127 struct SpaceSeq *CTX_wm_space_seq(const bContext *C);
128 struct SpaceOops *CTX_wm_space_outliner(const bContext *C);
129 struct SpaceNla *CTX_wm_space_nla(const bContext *C);
130 struct SpaceTime *CTX_wm_space_time(const bContext *C);
131 struct SpaceNode *CTX_wm_space_node(const bContext *C);
132 struct SpaceLogic *CTX_wm_space_logic(const bContext *C);
133 struct SpaceIpo *CTX_wm_space_graph(const bContext *C);
134 struct SpaceAction *CTX_wm_space_action(const bContext *C);
135 struct SpaceInfo *CTX_wm_space_info(const bContext *C);
136
137 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
138 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
139 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
140 void CTX_wm_area_set(bContext *C, struct ScrArea *sa);
141 void CTX_wm_region_set(bContext *C, struct ARegion *region);
142 void CTX_wm_menu_set(bContext *C, struct ARegion *menu);
143
144 /* Data Context
145
146    - listbases consist of CollectionPointerLink items and must be
147      freed with BLI_freelistN!
148    - the dir listbase consits of LinkData items */
149
150 PointerRNA CTX_data_pointer_get(const bContext *C, const char *member);
151 PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type);
152 ListBase CTX_data_collection_get(const bContext *C, const char *member);
153 ListBase CTX_data_dir_get(const bContext *C);
154 void CTX_data_get(const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb);
155
156 void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
157 void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
158
159 void CTX_data_id_list_add(bContextDataResult *result, struct ID *id);
160 void CTX_data_list_add(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
161
162 void CTX_data_dir_set(bContextDataResult *result, const char **member);
163
164 int CTX_data_equals(const char *member, const char *str);
165 int CTX_data_dir(const char *member);
166
167 /*void CTX_data_pointer_set(bContextDataResult *result, void *data);
168 void CTX_data_list_add(bContextDataResult *result, void *data);*/
169
170 #define CTX_DATA_BEGIN(C, Type, instance, member) \
171         { \
172                 ListBase ctx_data_list; \
173                 CollectionPointerLink *ctx_link; \
174                 CTX_data_##member(C, &ctx_data_list); \
175                 for(ctx_link=ctx_data_list.first; ctx_link; ctx_link=ctx_link->next) { \
176                         Type instance= ctx_link->ptr.data;
177
178 #define CTX_DATA_END \
179                 } \
180                 BLI_freelistN(&ctx_data_list); \
181         }
182
183 int ctx_data_list_count(const bContext *C, int (*func)(const bContext*, ListBase*));
184
185 #define CTX_DATA_COUNT(C, member) \
186         ctx_data_list_count(C, CTX_data_##member)
187
188 /* Data Context Members */
189
190 struct Main *CTX_data_main(const bContext *C);
191 struct Scene *CTX_data_scene(const bContext *C);
192 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
193
194 void CTX_data_main_set(bContext *C, struct Main *bmain);
195 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
196
197 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
198 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
199
200 int CTX_data_selected_objects(const bContext *C, ListBase *list);
201 int CTX_data_selected_bases(const bContext *C, ListBase *list);
202
203 int CTX_data_visible_objects(const bContext *C, ListBase *list);
204 int CTX_data_visible_bases(const bContext *C, ListBase *list);
205
206 int CTX_data_selectable_objects(const bContext *C, ListBase *list);
207 int CTX_data_selectable_bases(const bContext *C, ListBase *list);
208
209 struct Object *CTX_data_active_object(const bContext *C);
210 struct Base *CTX_data_active_base(const bContext *C);
211 struct Object *CTX_data_edit_object(const bContext *C);
212
213 struct Image *CTX_data_edit_image(const bContext *C);
214
215 struct Text *CTX_data_edit_text(const bContext *C);
216
217 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
218
219 struct EditBone *CTX_data_active_bone(const bContext *C);
220 int CTX_data_selected_bones(const bContext *C, ListBase *list);
221 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
222 int CTX_data_visible_bones(const bContext *C, ListBase *list);
223 int CTX_data_editable_bones(const bContext *C, ListBase *list);
224
225 struct bPoseChannel *CTX_data_active_pchan(const bContext *C);
226 int CTX_data_selected_pchans(const bContext *C, ListBase *list);
227 int CTX_data_visible_pchans(const bContext *C, ListBase *list);
228
229 #ifdef __cplusplus
230 }
231 #endif
232         
233 #endif
234