2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r19323...
[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 /* Context */
76
77 bContext *CTX_create(void);
78 void CTX_free(bContext *C);
79
80 bContext *CTX_copy(const bContext *C);
81
82 /* Window Manager Context */
83
84 struct wmWindowManager *CTX_wm_manager(const bContext *C);
85 struct wmWindow *CTX_wm_window(const bContext *C);
86 struct bScreen *CTX_wm_screen(const bContext *C);
87 struct ScrArea *CTX_wm_area(const bContext *C);
88 struct SpaceLink *CTX_wm_space_data(const bContext *C);
89 struct ARegion *CTX_wm_region(const bContext *C);
90 void *CTX_wm_region_data(const bContext *C);
91 struct ARegion *CTX_wm_menu(const bContext *C);
92
93 struct View3D *CTX_wm_view3d(const bContext *C);
94 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
95 struct SpaceText *CTX_wm_space_text(const bContext *C);
96 struct SpaceImage *CTX_wm_space_image(const bContext *C);
97
98 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
99 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
100 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
101 void CTX_wm_area_set(bContext *C, struct ScrArea *sa);
102 void CTX_wm_region_set(bContext *C, struct ARegion *region);
103 void CTX_wm_menu_set(bContext *C, struct ARegion *menu);
104
105 /* Data Context
106
107    - note: listbases consist of LinkData items and must be
108      freed with BLI_freelistN! */
109
110 PointerRNA CTX_data_pointer_get(bContext *C, const char *member);
111 ListBase CTX_data_collection_get(bContext *C, const char *member);
112 void CTX_data_get(bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb);
113
114 void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
115 void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
116
117 void CTX_data_id_list_add(bContextDataResult *result, struct ID *id);
118 void CTX_data_list_add(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
119
120 int CTX_data_equals(const char *member, const char *str);
121
122 /*void CTX_data_pointer_set(bContextDataResult *result, void *data);
123 void CTX_data_list_add(bContextDataResult *result, void *data);*/
124
125 #define CTX_DATA_BEGIN(C, Type, instance, member) \
126         { \
127                 ListBase ctx_data_list; \
128                 CollectionPointerLink *ctx_link; \
129                 CTX_data_##member(C, &ctx_data_list); \
130                 for(ctx_link=ctx_data_list.first; ctx_link; ctx_link=ctx_link->next) { \
131                         Type instance= ctx_link->ptr.data;
132
133 #define CTX_DATA_END \
134                 } \
135                 BLI_freelistN(&ctx_data_list); \
136         }
137
138 int ctx_data_list_count(const bContext *C, int (*func)(const bContext*, ListBase*));
139
140 #define CTX_DATA_COUNT(C, member) \
141         ctx_data_list_count(C, CTX_data_##member)
142
143 /* Data Context Members */
144
145 struct Main *CTX_data_main(const bContext *C);
146 struct Scene *CTX_data_scene(const bContext *C);
147 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
148
149 void CTX_data_main_set(bContext *C, struct Main *bmain);
150 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
151
152 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
153 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
154
155 int CTX_data_selected_objects(const bContext *C, ListBase *list);
156 int CTX_data_selected_bases(const bContext *C, ListBase *list);
157
158 int CTX_data_visible_objects(const bContext *C, ListBase *list);
159 int CTX_data_visible_bases(const bContext *C, ListBase *list);
160
161 struct Object *CTX_data_active_object(const bContext *C);
162 struct Base *CTX_data_active_base(const bContext *C);
163 struct Object *CTX_data_edit_object(const bContext *C);
164
165 struct Image *CTX_data_edit_image(const bContext *C);
166
167 struct Text *CTX_data_edit_text(const bContext *C);
168
169 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
170
171 struct EditBone *CTX_data_active_bone(const bContext *C);
172 int CTX_data_selected_bones(const bContext *C, ListBase *list);
173 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
174 int CTX_data_visible_bones(const bContext *C, ListBase *list);
175 int CTX_data_editable_bones(const bContext *C, ListBase *list);
176
177 struct bPoseChannel *CTX_data_active_pchan(const bContext *C);
178 int CTX_data_selected_pchans(const bContext *C, ListBase *list);
179 int CTX_data_visible_pchans(const bContext *C, ListBase *list);
180
181 #ifdef __cplusplus
182 }
183 #endif
184         
185 #endif
186