2.5
[blender.git] / source / blender / editors / space_api / spacetypes.c
1 /**
2  * $Id: spacetypes.c
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) Blender Foundation, 2008
21  *
22  * ***** END GPL/BL DUAL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "MEM_guardedalloc.h"
28 #include "BLI_blenlib.h"
29
30 #include "DNA_windowmanager_types.h"
31
32 #include "BKE_global.h"
33 #include "BKE_screen.h"
34
35 #include "UI_interface.h"
36 #include "UI_view2d.h"
37
38 #include "BIF_gl.h"
39
40 #include "ED_screen.h"
41 #include "ED_space_api.h"
42
43
44 ARegionType *ED_regiontype_from_id(SpaceType *st, int regionid)
45 {
46         ARegionType *art;
47         
48         for(art= st->regiontypes.first; art; art= art->next)
49                 if(art->regionid==regionid)
50                         return art;
51         
52         printf("Error, region type missing in %s\n", st->name);
53         return st->regiontypes.first;
54 }
55
56
57 /* only call once on startup, storage is global in BKE kernel listbase */
58 void ED_spacetypes_init(void)
59 {
60         const ListBase *spacetypes;
61         SpaceType *type;
62
63         /* create space types */
64         ED_spacetype_outliner();
65         ED_spacetype_time();
66         ED_spacetype_view3d();
67         ED_spacetype_ipo();
68 //      ...
69         
70         /* register operator types for screen and all spaces */
71         ED_operatortypes_screen();
72         ui_view2d_operatortypes();
73         
74         spacetypes = BKE_spacetypes_list();
75         for(type=spacetypes->first; type; type=type->next)
76                 type->operatortypes();
77 }
78
79 /* called in wm.c */
80 /* keymap definitions are registered only once per WM initialize, usually on file read,
81    using the keymap the actual areas/regions add the handlers */
82 void ED_spacetypes_keymap(wmWindowManager *wm)
83 {
84         const ListBase *spacetypes;
85         SpaceType *stype;
86         ARegionType *atype;
87
88         ED_keymap_screen(wm);
89         UI_view2d_keymap(wm);
90
91         spacetypes = BKE_spacetypes_list();
92         for(stype=spacetypes->first; stype; stype=stype->next) {
93                 if(stype->keymap)
94                         stype->keymap(wm);
95                 for(atype=stype->regiontypes.first; atype; atype=atype->next) {
96                         if(atype->keymap)
97                                 atype->keymap(wm);
98                 }
99         }
100 }
101
102 /* ****************************** space template *********************** */
103
104 /* allocate and init some vars */
105 static SpaceLink *xxx_new(void)
106 {
107         return NULL;
108 }
109
110 /* not spacelink itself */
111 static void xxx_free(SpaceLink *sl)
112 {
113
114 }
115
116 /* spacetype; init callback for usage, should be redoable */
117 static void xxx_init(wmWindowManager *wm, ScrArea *sa)
118 {
119         
120         /* link area to SpaceXXX struct */
121         
122         /* define how many regions, the order and types */
123         
124         /* add types to regions */
125 }
126
127 static SpaceLink *xxx_duplicate(SpaceLink *sl)
128 {
129         
130         return NULL;
131 }
132
133 static void xxx_operatortypes(void)
134 {
135         /* register operator types for this space */
136 }
137
138 static void xxx_keymap(wmWindowManager *wm)
139 {
140         /* add default items to keymap */
141 }
142
143 /* only called once, from screen/spacetypes.c */
144 void ED_spacetype_xxx(void)
145 {
146         static SpaceType st;
147         
148         st.spaceid= SPACE_VIEW3D;
149         
150         st.new= xxx_new;
151         st.free= xxx_free;
152         st.init= xxx_init;
153         st.duplicate= xxx_duplicate;
154         st.operatortypes= xxx_operatortypes;
155         st.keymap= xxx_keymap;
156         
157         BKE_spacetype_register(&st);
158 }
159
160 /* ****************************** end template *********************** */
161
162
163
164