Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / space_api / spacetypes.c
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) Blender Foundation, 2008
19  *
20  * ***** END GPL/BL DUAL LICENSE BLOCK *****
21  */
22
23 /** \file blender/editors/space_api/spacetypes.c
24  *  \ingroup spapi
25  */
26
27
28 #include <stdlib.h>
29
30 #include "MEM_guardedalloc.h"
31
32 #include "BLI_blenlib.h"
33 #include "BLI_utildefines.h"
34
35 #include "DNA_scene_types.h"
36 #include "DNA_windowmanager_types.h"
37
38
39 #include "BKE_context.h"
40 #include "BKE_screen.h"
41
42 #include "UI_interface.h"
43 #include "UI_view2d.h"
44
45
46 #include "ED_anim_api.h"
47 #include "ED_armature.h"
48 #include "ED_curve.h"
49 #include "ED_fileselect.h"
50 #include "ED_gpencil.h"
51 #include "ED_markers.h"
52 #include "ED_mesh.h"
53 #include "ED_node.h"
54 #include "ED_object.h"
55 #include "ED_paint.h"
56 #include "ED_physics.h"
57 #include "ED_render.h"
58 #include "ED_scene.h"
59 #include "ED_screen.h"
60 #include "ED_sculpt.h"
61 #include "ED_space_api.h"
62 #include "ED_sound.h"
63 #include "ED_uvedit.h"
64 #include "ED_lattice.h"
65 #include "ED_mball.h"
66 #include "ED_logic.h"
67 #include "ED_clip.h"
68 #include "ED_mask.h"
69 #include "ED_sequencer.h"
70 #include "ED_manipulator_library.h"
71
72 #include "io_ops.h"
73
74 /* only call once on startup, storage is global in BKE kernel listbase */
75 void ED_spacetypes_init(void)
76 {
77         const ListBase *spacetypes;
78         SpaceType *type;
79
80         /* UI_UNIT_X is now a variable, is used in some spacetype inits? */
81         U.widget_unit = 20;
82         
83         /* create space types */
84         ED_spacetype_outliner();
85         ED_spacetype_view3d();
86         ED_spacetype_ipo();
87         ED_spacetype_image();
88         ED_spacetype_node();
89         ED_spacetype_buttons();
90         ED_spacetype_info();
91         ED_spacetype_file();
92         ED_spacetype_action();
93         ED_spacetype_nla();
94         ED_spacetype_script();
95         ED_spacetype_text();
96         ED_spacetype_sequencer();
97         ED_spacetype_console();
98         ED_spacetype_userpref();
99         ED_spacetype_clip();
100         ED_spacetype_topbar();
101 //      ...
102         
103         /* register operator types for screen and all spaces */
104         ED_operatortypes_workspace();
105         ED_operatortypes_scene();
106         ED_operatortypes_screen();
107         ED_operatortypes_anim();
108         ED_operatortypes_animchannels();
109         ED_operatortypes_gpencil();
110         ED_operatortypes_object();
111         ED_operatortypes_lattice();
112         ED_operatortypes_mesh();
113         ED_operatortypes_sculpt();
114         ED_operatortypes_uvedit();
115         ED_operatortypes_paint();
116         ED_operatortypes_physics();
117         ED_operatortypes_curve();
118         ED_operatortypes_armature();
119         ED_operatortypes_marker();
120         ED_operatortypes_metaball();
121         ED_operatortypes_sound();
122         ED_operatortypes_render();
123         ED_operatortypes_mask();
124         ED_operatortypes_io();
125         
126         ED_operatortypes_view2d();
127         ED_operatortypes_ui();
128
129         /* manipulator types */
130         ED_manipulatortypes_button_2d();
131         ED_manipulatortypes_dial_3d();
132         ED_manipulatortypes_grab_3d();
133         ED_manipulatortypes_arrow_2d();
134         ED_manipulatortypes_arrow_3d();
135         ED_manipulatortypes_primitive_3d();
136         ED_manipulatortypes_cage_2d();
137         ED_manipulatortypes_cage_3d();
138
139         /* register types for operators and manipulators */
140         spacetypes = BKE_spacetypes_list();
141         for (type = spacetypes->first; type; type = type->next) {
142                 /* init manipulator types first, operator-types need them */
143                 if (type->manipulators) {
144                         type->manipulators();
145                 }
146                 if (type->operatortypes) {
147                         type->operatortypes();
148                 }
149         }
150 }
151
152 void ED_spacemacros_init(void)
153 {
154         const ListBase *spacetypes;
155         SpaceType *type;
156
157         /* Macros's must go last since they reference other operators.
158          * We need to have them go after python operators too */
159         ED_operatormacros_armature();
160         ED_operatormacros_mesh();
161         ED_operatormacros_metaball();
162         ED_operatormacros_node();
163         ED_operatormacros_object();
164         ED_operatormacros_file();
165         ED_operatormacros_graph();
166         ED_operatormacros_action();
167         ED_operatormacros_clip();
168         ED_operatormacros_curve();
169         ED_operatormacros_mask();
170         ED_operatormacros_sequencer();
171         ED_operatormacros_paint();
172         ED_operatormacros_gpencil();
173
174         /* register dropboxes (can use macros) */
175         spacetypes = BKE_spacetypes_list();
176         for (type = spacetypes->first; type; type = type->next) {
177                 if (type->dropboxes)
178                         type->dropboxes();
179         }
180 }
181
182 /* called in wm.c */
183 /* keymap definitions are registered only once per WM initialize, usually on file read,
184  * using the keymap the actual areas/regions add the handlers */
185 void ED_spacetypes_keymap(wmKeyConfig *keyconf)
186 {
187         const ListBase *spacetypes;
188         SpaceType *stype;
189         ARegionType *atype;
190
191         ED_keymap_screen(keyconf);
192         ED_keymap_anim(keyconf);
193         ED_keymap_animchannels(keyconf);
194         ED_keymap_gpencil(keyconf);
195         ED_keymap_object(keyconf);
196         ED_keymap_lattice(keyconf);
197         ED_keymap_mesh(keyconf);
198         ED_keymap_uvedit(keyconf);
199         ED_keymap_curve(keyconf);
200         ED_keymap_armature(keyconf);
201         ED_keymap_physics(keyconf);
202         ED_keymap_metaball(keyconf);
203         ED_keymap_paint(keyconf);
204         ED_keymap_mask(keyconf);
205         ED_keymap_marker(keyconf);
206
207         ED_keymap_view2d(keyconf);
208         ED_keymap_ui(keyconf);
209
210         spacetypes = BKE_spacetypes_list();
211         for (stype = spacetypes->first; stype; stype = stype->next) {
212                 if (stype->keymap)
213                         stype->keymap(keyconf);
214                 for (atype = stype->regiontypes.first; atype; atype = atype->next) {
215                         if (atype->keymap)
216                                 atype->keymap(keyconf);
217                 }
218         }
219 }
220
221 /* ********************** custom drawcall api ***************** */
222
223 typedef struct RegionDrawCB {
224         struct RegionDrawCB *next, *prev;
225         
226         void (*draw)(const struct bContext *, struct ARegion *, void *);
227         void *customdata;
228         
229         int type;
230         
231 } RegionDrawCB;
232
233 void *ED_region_draw_cb_activate(ARegionType *art, 
234                                  void (*draw)(const struct bContext *, struct ARegion *, void *),
235                                  void *customdata, int type)
236 {
237         RegionDrawCB *rdc = MEM_callocN(sizeof(RegionDrawCB), "RegionDrawCB");
238         
239         BLI_addtail(&art->drawcalls, rdc);
240         rdc->draw = draw;
241         rdc->customdata = customdata;
242         rdc->type = type;
243         
244         return rdc;
245 }
246
247 void ED_region_draw_cb_exit(ARegionType *art, void *handle)
248 {
249         RegionDrawCB *rdc;
250         
251         for (rdc = art->drawcalls.first; rdc; rdc = rdc->next) {
252                 if (rdc == (RegionDrawCB *)handle) {
253                         BLI_remlink(&art->drawcalls, rdc);
254                         MEM_freeN(rdc);
255                         return;
256                 }
257         }
258 }
259
260 void *ED_region_draw_cb_customdata(void *handle)
261 {
262         return ((RegionDrawCB *)handle)->customdata;
263 }
264
265 void ED_region_draw_cb_draw(const bContext *C, ARegion *ar, int type)
266 {
267         RegionDrawCB *rdc;
268         
269         for (rdc = ar->type->drawcalls.first; rdc; rdc = rdc->next) {
270                 if (rdc->type == type) {
271                         rdc->draw(C, ar, rdc->customdata);
272                 }
273         }
274 }
275
276
277
278 /* ********************* space template *********************** */
279 /* forward declare */
280 void ED_spacetype_xxx(void);
281
282 /* allocate and init some vars */
283 static SpaceLink *xxx_new(const ScrArea *UNUSED(sa), const Scene *UNUSED(scene))
284 {
285         return NULL;
286 }
287
288 /* not spacelink itself */
289 static void xxx_free(SpaceLink *UNUSED(sl))
290 {
291
292 }
293
294 /* spacetype; init callback for usage, should be redoable */
295 static void xxx_init(wmWindowManager *UNUSED(wm), ScrArea *UNUSED(sa))
296 {
297         
298         /* link area to SpaceXXX struct */
299         
300         /* define how many regions, the order and types */
301         
302         /* add types to regions */
303 }
304
305 static SpaceLink *xxx_duplicate(SpaceLink *UNUSED(sl))
306 {
307         
308         return NULL;
309 }
310
311 static void xxx_operatortypes(void)
312 {
313         /* register operator types for this space */
314 }
315
316 static void xxx_keymap(wmKeyConfig *UNUSED(keyconf))
317 {
318         /* add default items to keymap */
319 }
320
321 /* only called once, from screen/spacetypes.c */
322 void ED_spacetype_xxx(void)
323 {
324         static SpaceType st;
325         
326         st.spaceid = SPACE_VIEW3D;
327         
328         st.new = xxx_new;
329         st.free = xxx_free;
330         st.init = xxx_init;
331         st.duplicate = xxx_duplicate;
332         st.operatortypes = xxx_operatortypes;
333         st.keymap = xxx_keymap;
334         
335         BKE_spacetype_register(&st);
336 }
337
338 /* ****************************** end template *********************** */