doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / editors / space_script / space_script.c
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <string.h>
30 #include <stdio.h>
31
32 #include "MEM_guardedalloc.h"
33
34 #include "BLI_blenlib.h"
35 #include "BLI_math.h"
36 #include "BLI_rand.h"
37 #include "BLI_utildefines.h"
38
39 #include "BKE_context.h"
40 #include "BKE_screen.h"
41
42 #include "ED_space_api.h"
43 #include "ED_screen.h"
44
45 #include "BIF_gl.h"
46
47 #include "WM_api.h"
48 #include "WM_types.h"
49
50 #include "UI_resources.h"
51 #include "UI_view2d.h"
52
53 #ifdef WITH_PYTHON
54 #include "BPY_extern.h"
55 #endif
56
57 #include "script_intern.h"      // own include
58
59
60 //static script_run_python(char *funcname, )
61
62
63 /* ******************** default callbacks for script space ***************** */
64
65 static SpaceLink *script_new(const bContext *UNUSED(C))
66 {
67         ARegion *ar;
68         SpaceScript *sscript;
69         
70         sscript= MEM_callocN(sizeof(SpaceScript), "initscript");
71         sscript->spacetype= SPACE_SCRIPT;
72         
73         
74         /* header */
75         ar= MEM_callocN(sizeof(ARegion), "header for script");
76         
77         BLI_addtail(&sscript->regionbase, ar);
78         ar->regiontype= RGN_TYPE_HEADER;
79         ar->alignment= RGN_ALIGN_BOTTOM;
80         
81         /* main area */
82         ar= MEM_callocN(sizeof(ARegion), "main area for script");
83         
84         BLI_addtail(&sscript->regionbase, ar);
85         ar->regiontype= RGN_TYPE_WINDOW;
86         
87         /* channel list region XXX */
88
89         
90         return (SpaceLink *)sscript;
91 }
92
93 /* not spacelink itself */
94 static void script_free(SpaceLink *sl)
95 {       
96         SpaceScript *sscript= (SpaceScript*) sl;
97
98 #ifdef WITH_PYTHON
99         /*free buttons references*/
100         if (sscript->but_refs) {
101 // XXX          BPy_Set_DrawButtonsList(sscript->but_refs);
102 //              BPy_Free_DrawButtonsList();
103                 sscript->but_refs = NULL;
104         }
105 #endif
106         sscript->script = NULL;
107 }
108
109
110 /* spacetype; init callback */
111 static void script_init(struct wmWindowManager *UNUSED(wm), ScrArea *UNUSED(sa))
112 {
113
114 }
115
116 static SpaceLink *script_duplicate(SpaceLink *sl)
117 {
118         SpaceScript *sscriptn= MEM_dupallocN(sl);
119         
120         /* clear or remove stuff from old */
121         
122         return (SpaceLink *)sscriptn;
123 }
124
125
126
127 /* add handlers, stuff you only do once or on area/region changes */
128 static void script_main_area_init(wmWindowManager *wm, ARegion *ar)
129 {
130         wmKeyMap *keymap;
131         
132         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_STANDARD, ar->winx, ar->winy);
133         
134         /* own keymap */
135         keymap= WM_keymap_find(wm->defaultconf, "Script", SPACE_SCRIPT, 0);
136         WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
137 }
138
139 static void script_main_area_draw(const bContext *C, ARegion *ar)
140 {
141         /* draw entirely, view changes should be handled here */
142         SpaceScript *sscript= (SpaceScript*)CTX_wm_space_data(C);
143         View2D *v2d= &ar->v2d;
144
145         /* clear and setup matrix */
146         UI_ThemeClearColor(TH_BACK);
147         glClear(GL_COLOR_BUFFER_BIT);
148         
149         UI_view2d_view_ortho(v2d);
150                 
151         /* data... */
152         // BPY_script_exec(C, "/root/blender-svn/blender25/test.py", NULL);
153         
154 #ifdef WITH_PYTHON
155         if (sscript->script) {
156                 // BPY_run_script_space_draw(C, sscript);
157         }
158 #else
159         (void)sscript;
160 #endif
161         
162         /* reset view matrix */
163         UI_view2d_view_restore(C);
164         
165         /* scrollers? */
166 }
167
168 /* add handlers, stuff you only do once or on area/region changes */
169 static void script_header_area_init(wmWindowManager *UNUSED(wm), ARegion *ar)
170 {
171         ED_region_header_init(ar);
172 }
173
174 static void script_header_area_draw(const bContext *C, ARegion *ar)
175 {
176         ED_region_header(C, ar);
177 }
178
179 static void script_main_area_listener(ARegion *UNUSED(ar), wmNotifier *UNUSED(wmn))
180 {
181         /* context changes */
182         // XXX - Todo, need the ScriptSpace accessible to get the python script to run.
183         // BPY_run_script_space_listener()
184 }
185
186 /* only called once, from space/spacetypes.c */
187 void ED_spacetype_script(void)
188 {
189         SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype script");
190         ARegionType *art;
191         
192         st->spaceid= SPACE_SCRIPT;
193         strncpy(st->name, "Script", BKE_ST_MAXNAME);
194         
195         st->new= script_new;
196         st->free= script_free;
197         st->init= script_init;
198         st->duplicate= script_duplicate;
199         st->operatortypes= script_operatortypes;
200         st->keymap= script_keymap;
201         
202         /* regions: main window */
203         art= MEM_callocN(sizeof(ARegionType), "spacetype script region");
204         art->regionid = RGN_TYPE_WINDOW;
205         art->init= script_main_area_init;
206         art->draw= script_main_area_draw;
207         art->listener= script_main_area_listener;
208         art->keymapflag= ED_KEYMAP_VIEW2D|   ED_KEYMAP_UI|ED_KEYMAP_FRAMES; // XXX need to further test this ED_KEYMAP_UI is needed for button interaction
209
210         BLI_addhead(&st->regiontypes, art);
211         
212         /* regions: header */
213         art= MEM_callocN(sizeof(ARegionType), "spacetype script region");
214         art->regionid = RGN_TYPE_HEADER;
215         art->prefsizey= HEADERY;
216         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D|ED_KEYMAP_HEADER;
217         
218         art->init= script_header_area_init;
219         art->draw= script_header_area_draw;
220         
221         BLI_addhead(&st->regiontypes, art);
222         
223         
224         BKE_spacetype_register(st);
225 }
226