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