6d55acf35ecc6a9957d7f60c1964f7ce017150b9
[blender-staging.git] / source / blender / editors / space_console / space_console.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): Campbell Barton
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28  
29  #include <string.h>
30 #include <stdio.h>
31
32 #include "DNA_space_types.h"
33 #include "DNA_scene_types.h"
34 #include "DNA_screen_types.h"
35
36 #include "MEM_guardedalloc.h"
37
38 #include "BLI_blenlib.h"
39 #include "BLI_math.h"
40
41 #include "BKE_colortools.h"
42 #include "BKE_context.h"
43 #include "BKE_screen.h"
44
45 #include "ED_space_api.h"
46 #include "ED_screen.h"
47
48 #include "BIF_gl.h"
49
50
51 #include "RNA_access.h"
52 #include "RNA_define.h"
53
54 #include "WM_api.h"
55 #include "WM_types.h"
56
57 #include "UI_interface.h"
58 #include "UI_resources.h"
59 #include "UI_view2d.h"
60
61 #include "console_intern.h"     // own include
62
63 static void console_update_rect(const bContext *C, ARegion *ar)
64 {
65         SpaceConsole *sc= CTX_wm_space_console(C);
66         View2D *v2d= &ar->v2d;
67
68         UI_view2d_totRect_set(v2d, ar->winx-1, console_text_height(sc, ar, CTX_wm_reports(C)));
69 }
70
71 /* ******************** default callbacks for console space ***************** */
72
73 static SpaceLink *console_new(const bContext *C)
74 {
75         ARegion *ar;
76         SpaceConsole *sconsole;
77         
78         sconsole= MEM_callocN(sizeof(SpaceConsole), "initconsole");
79         sconsole->spacetype= SPACE_CONSOLE;
80         
81         sconsole->lheight=      14;
82         sconsole->type=         CONSOLE_TYPE_PYTHON;
83         sconsole->rpt_mask=     CONSOLE_RPT_OP; /* ? - not sure whats a good default here?*/
84         
85         /* header */
86         ar= MEM_callocN(sizeof(ARegion), "header for console");
87         
88         BLI_addtail(&sconsole->regionbase, ar);
89         ar->regiontype= RGN_TYPE_HEADER;
90         ar->alignment= RGN_ALIGN_BOTTOM;
91         
92         
93         /* main area */
94         ar= MEM_callocN(sizeof(ARegion), "main area for text");
95         
96         BLI_addtail(&sconsole->regionbase, ar);
97         ar->regiontype= RGN_TYPE_WINDOW;
98         
99         
100         ar->v2d.scroll |= (V2D_SCROLL_RIGHT);
101         ar->v2d.align |= V2D_ALIGN_NO_NEG_X|V2D_ALIGN_NO_NEG_Y; /* align bottom left */
102         ar->v2d.keepofs |= V2D_LOCKOFS_X;
103         ar->v2d.keepzoom = (V2D_LOCKZOOM_X|V2D_LOCKZOOM_Y|V2D_LIMITZOOM|V2D_KEEPASPECT);
104         ar->v2d.keeptot= V2D_KEEPTOT_BOUNDS;
105         ar->v2d.minzoom= ar->v2d.maxzoom= 1.0f;
106
107         /* for now, aspect ratio should be maintained, and zoom is clamped within sane default limits */
108         //ar->v2d.keepzoom= (V2D_KEEPASPECT|V2D_LIMITZOOM);
109
110         return (SpaceLink *)sconsole;
111 }
112
113 /* not spacelink itself */
114 static void console_free(SpaceLink *sl)
115 {
116         SpaceConsole *sc= (SpaceConsole*) sl;
117         
118         while(sc->scrollback.first)
119                 console_scrollback_free(sc, sc->scrollback.first);
120         
121         while(sc->history.first)
122                 console_history_free(sc, sc->history.first);
123 }
124
125
126 /* spacetype; init callback */
127 static void console_init(struct wmWindowManager *wm, ScrArea *sa)
128 {
129
130 }
131
132 static SpaceLink *console_duplicate(SpaceLink *sl)
133 {
134         SpaceConsole *sconsolen= MEM_dupallocN(sl);
135         
136         /* clear or remove stuff from old */
137         
138         /* TODO - duplicate?, then we also need to duplicate the py namespace */
139         sconsolen->scrollback.first= sconsolen->scrollback.last= NULL;
140         sconsolen->history.first= sconsolen->history.last= NULL;
141         
142         return (SpaceLink *)sconsolen;
143 }
144
145
146
147 /* add handlers, stuff you only do once or on area/region changes */
148 static void console_main_area_init(wmWindowManager *wm, ARegion *ar)
149 {
150         wmKeyMap *keymap;
151
152         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_CUSTOM, ar->winx, ar->winy);
153
154         /* own keymap */
155         keymap= WM_keymap_find(wm->defaultconf, "Console", SPACE_CONSOLE, 0);
156         WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
157 }
158
159 static void console_main_area_draw(const bContext *C, ARegion *ar)
160 {
161         /* draw entirely, view changes should be handled here */
162         SpaceConsole *sc= CTX_wm_space_console(C);
163         View2D *v2d= &ar->v2d;
164         View2DScrollers *scrollers;
165         float col[3];
166         
167         if((sc->type==CONSOLE_TYPE_PYTHON) && (sc->scrollback.first==NULL))
168                 WM_operator_name_call((bContext *)C, "CONSOLE_OT_banner", WM_OP_EXEC_DEFAULT, NULL);
169
170         /* clear and setup matrix */
171         UI_GetThemeColor3fv(TH_BACK, col);
172         glClearColor(col[0], col[1], col[2], 1.0);
173         glClear(GL_COLOR_BUFFER_BIT);
174
175         console_update_rect(C, ar);
176
177         /* worlks best with no view2d matrix set */
178         UI_view2d_view_ortho(C, v2d);
179
180         /* data... */
181
182         console_history_verify(C); /* make sure we have some command line */
183         console_text_main(sc, ar, CTX_wm_reports(C));
184         
185         /* reset view matrix */
186         UI_view2d_view_restore(C);
187         
188         /* scrollers */
189         scrollers= UI_view2d_scrollers_calc(C, v2d, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_GRID_CLAMP);
190         UI_view2d_scrollers_draw(C, v2d, scrollers);
191         UI_view2d_scrollers_free(scrollers);
192 }
193
194 void console_operatortypes(void)
195 {
196         /* console_ops.c */
197         WM_operatortype_append(CONSOLE_OT_move);
198         WM_operatortype_append(CONSOLE_OT_delete);
199         WM_operatortype_append(CONSOLE_OT_insert);
200         
201         /* for use by python only */
202         WM_operatortype_append(CONSOLE_OT_history_append); 
203         WM_operatortype_append(CONSOLE_OT_scrollback_append);
204         
205         WM_operatortype_append(CONSOLE_OT_clear); 
206         WM_operatortype_append(CONSOLE_OT_history_cycle);
207         WM_operatortype_append(CONSOLE_OT_copy);
208         WM_operatortype_append(CONSOLE_OT_paste);
209         WM_operatortype_append(CONSOLE_OT_select_set);
210
211         /* console_report.c */
212         WM_operatortype_append(CONSOLE_OT_select_pick);
213         WM_operatortype_append(CONSOLE_OT_select_all_toggle);
214         WM_operatortype_append(CONSOLE_OT_select_border);
215
216         WM_operatortype_append(CONSOLE_OT_report_replay);
217         WM_operatortype_append(CONSOLE_OT_report_delete);
218         WM_operatortype_append(CONSOLE_OT_report_copy);
219 }
220
221 void console_keymap(struct wmKeyConfig *keyconf)
222 {
223         wmKeyMap *keymap= WM_keymap_find(keyconf, "Console", SPACE_CONSOLE, 0);
224         wmKeyMapItem *kmi;
225         
226 #ifdef __APPLE__
227         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", LEFTARROWKEY, KM_PRESS, KM_OSKEY, 0)->ptr, "type", LINE_BEGIN);
228         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", RIGHTARROWKEY, KM_PRESS, KM_OSKEY, 0)->ptr, "type", LINE_END);
229 #endif
230
231         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", LEFTARROWKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", PREV_WORD);
232         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", RIGHTARROWKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", NEXT_WORD);
233         
234         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", HOMEKEY, KM_PRESS, 0, 0)->ptr, "type", LINE_BEGIN);
235         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", ENDKEY, KM_PRESS, 0, 0)->ptr, "type", LINE_END);
236         
237         kmi = WM_keymap_add_item(keymap, "WM_OT_context_cycle_int", WHEELUPMOUSE, KM_PRESS, KM_CTRL, 0);
238         RNA_string_set(kmi->ptr, "path", "space_data.font_size");
239         RNA_boolean_set(kmi->ptr, "reverse", 0);
240         
241         kmi = WM_keymap_add_item(keymap, "WM_OT_context_cycle_int", WHEELDOWNMOUSE, KM_PRESS, KM_CTRL, 0);
242         RNA_string_set(kmi->ptr, "path", "space_data.font_size");
243         RNA_boolean_set(kmi->ptr, "reverse", 1);
244
245         kmi = WM_keymap_add_item(keymap, "WM_OT_context_cycle_int", PADPLUSKEY, KM_PRESS, KM_CTRL, 0);
246         RNA_string_set(kmi->ptr, "path", "space_data.font_size");
247         RNA_boolean_set(kmi->ptr, "reverse", 0);
248         
249         kmi = WM_keymap_add_item(keymap, "WM_OT_context_cycle_int", PADMINUS, KM_PRESS, KM_CTRL, 0);
250         RNA_string_set(kmi->ptr, "path", "space_data.font_size");
251         RNA_boolean_set(kmi->ptr, "reverse", 1);
252
253         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", LEFTARROWKEY, KM_PRESS, 0, 0)->ptr, "type", PREV_CHAR);
254         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", RIGHTARROWKEY, KM_PRESS, 0, 0)->ptr, "type", NEXT_CHAR);
255         
256         RNA_boolean_set(WM_keymap_add_item(keymap, "CONSOLE_OT_history_cycle", UPARROWKEY, KM_PRESS, 0, 0)->ptr, "reverse", 1);
257         WM_keymap_add_item(keymap, "CONSOLE_OT_history_cycle", DOWNARROWKEY, KM_PRESS, 0, 0);
258         
259         /*
260         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", LEFTARROWKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", PREV_WORD);
261         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", RIGHTARROWKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", NEXT_WORD);
262         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", UPARROWKEY, KM_PRESS, 0, 0)->ptr, "type", PREV_LINE);
263         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", DOWNARROWKEY, KM_PRESS, 0, 0)->ptr, "type", NEXT_LINE);
264         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", PAGEUPKEY, KM_PRESS, 0, 0)->ptr, "type", PREV_PAGE);
265         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", PAGEDOWNKEY, KM_PRESS, 0, 0)->ptr, "type", NEXT_PAGE);
266
267
268         //RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", DELKEY, KM_PRESS, 0, 0)->ptr, "type", DEL_NEXT_CHAR);
269         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", DKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", DEL_NEXT_CHAR);
270         //RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", BACKSPACEKEY, KM_PRESS, 0, 0)->ptr, "type", DEL_PREV_CHAR);
271         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", DELKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", DEL_NEXT_WORD);
272         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", BACKSPACEKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", DEL_PREV_WORD);
273         */
274         
275         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", DELKEY, KM_PRESS, 0, 0)->ptr, "type", DEL_NEXT_CHAR);
276         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", BACKSPACEKEY, KM_PRESS, 0, 0)->ptr, "type", DEL_PREV_CHAR);
277
278 #ifndef DISABLE_PYTHON
279         WM_keymap_add_item(keymap, "CONSOLE_OT_execute", RETKEY, KM_PRESS, 0, 0); /* python operator - space_text.py */
280         WM_keymap_add_item(keymap, "CONSOLE_OT_execute", PADENTER, KM_PRESS, 0, 0);
281         
282         //WM_keymap_add_item(keymap, "CONSOLE_OT_autocomplete", TABKEY, KM_PRESS, 0, 0); /* python operator - space_text.py */
283         WM_keymap_add_item(keymap, "CONSOLE_OT_autocomplete", SPACEKEY, KM_PRESS, KM_CTRL, 0); /* python operator - space_text.py */
284 #endif
285
286         /* report selection */
287         WM_keymap_add_item(keymap, "CONSOLE_OT_select_pick", SELECTMOUSE, KM_PRESS, 0, 0);
288         WM_keymap_add_item(keymap, "CONSOLE_OT_select_all_toggle", AKEY, KM_PRESS, 0, 0);
289         WM_keymap_add_item(keymap, "CONSOLE_OT_select_border", BKEY, KM_PRESS, 0, 0);
290
291         WM_keymap_add_item(keymap, "CONSOLE_OT_report_replay", RKEY, KM_PRESS, 0, 0);
292         WM_keymap_add_item(keymap, "CONSOLE_OT_report_delete", XKEY, KM_PRESS, 0, 0);
293         WM_keymap_add_item(keymap, "CONSOLE_OT_report_delete", DELKEY, KM_PRESS, 0, 0);
294         WM_keymap_add_item(keymap, "CONSOLE_OT_report_copy", CKEY, KM_PRESS, KM_CTRL, 0);
295         
296         WM_keymap_add_item(keymap, "CONSOLE_OT_copy", CKEY, KM_PRESS, KM_CTRL, 0);
297         WM_keymap_add_item(keymap, "CONSOLE_OT_paste", VKEY, KM_PRESS, KM_CTRL, 0);
298 #ifdef __APPLE__
299         WM_keymap_add_item(keymap, "CONSOLE_OT_copy", CKEY, KM_PRESS, KM_OSKEY, 0);
300         WM_keymap_add_item(keymap, "CONSOLE_OT_paste", VKEY, KM_PRESS, KM_OSKEY, 0);
301 #endif
302         
303         WM_keymap_add_item(keymap, "CONSOLE_OT_select_set", LEFTMOUSE, KM_PRESS, 0, 0);
304
305         RNA_string_set(WM_keymap_add_item(keymap, "CONSOLE_OT_insert", TABKEY, KM_PRESS, 0, 0)->ptr, "text", "    "); /* fake tabs */
306         WM_keymap_add_item(keymap, "CONSOLE_OT_insert", KM_TEXTINPUT, KM_ANY, KM_ANY, 0); // last!
307 }
308
309 /****************** header region ******************/
310
311 /* add handlers, stuff you only do once or on area/region changes */
312 static void console_header_area_init(wmWindowManager *wm, ARegion *ar)
313 {
314         ED_region_header_init(ar);
315 }
316
317 static void console_header_area_draw(const bContext *C, ARegion *ar)
318 {
319         ED_region_header(C, ar);
320 }
321
322 static void console_main_area_listener(ScrArea *sa, wmNotifier *wmn)
323 {
324         SpaceConsole *sc= sa->spacedata.first;
325
326         /* context changes */
327         switch(wmn->category) {
328                 case NC_SPACE:
329                         if(wmn->data == ND_SPACE_CONSOLE) { /* generic redraw request */
330                                 ED_area_tag_redraw(sa);
331                         }
332                         else if(wmn->data == ND_SPACE_CONSOLE_REPORT && sc->type==CONSOLE_TYPE_REPORT) {
333                                 /* redraw also but only for report view, could do less redraws by checking the type */
334                                 ED_area_tag_redraw(sa);
335                         }
336                         break;
337         }
338 }
339
340 /* only called once, from space/spacetypes.c */
341 void ED_spacetype_console(void)
342 {
343         SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype console");
344         ARegionType *art;
345         
346         st->spaceid= SPACE_CONSOLE;
347         strncpy(st->name, "Console", BKE_ST_MAXNAME);
348         
349         st->new= console_new;
350         st->free= console_free;
351         st->init= console_init;
352         st->duplicate= console_duplicate;
353         st->operatortypes= console_operatortypes;
354         st->keymap= console_keymap;
355         st->listener= console_main_area_listener;
356         
357         /* regions: main window */
358         art= MEM_callocN(sizeof(ARegionType), "spacetype console region");
359         art->regionid = RGN_TYPE_WINDOW;
360         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
361
362         art->init= console_main_area_init;
363         art->draw= console_main_area_draw;
364         
365         
366         
367
368         BLI_addhead(&st->regiontypes, art);
369         
370         /* regions: header */
371         art= MEM_callocN(sizeof(ARegionType), "spacetype console region");
372         art->regionid = RGN_TYPE_HEADER;
373         art->prefsizey= HEADERY;
374         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D|ED_KEYMAP_HEADER;
375         
376         art->init= console_header_area_init;
377         art->draw= console_header_area_draw;
378         
379         BLI_addhead(&st->regiontypes, art);
380
381
382         BKE_spacetype_register(st);
383 }