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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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_arithb.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_KEEPZOOM|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_KEEPZOOM);
 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         ListBase *keymap;
 151
 152         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_CUSTOM, ar->winx, ar->winy);
 153
 154         /* own keymap */
 155         keymap= WM_keymap_listbase(wm, "Console", SPACE_CONSOLE, 0);    /* XXX weak? */
 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         /* add helper text, why not? */
 168         if(sc->scrollback.first==NULL) {
 169                 console_scrollback_add_str(C, " * Python Interactive Console *", 0);
 170                 console_scrollback_add_str(C, "Command History:  Up/Down Arrow", 0);
 171                 console_scrollback_add_str(C, "Cursor:           Left/Right Home/End", 0);
 172                 console_scrollback_add_str(C, "Remove:           Backspace/Delete", 0);
 173                 console_scrollback_add_str(C, "Execute:          Enter", 0);
 174                 console_scrollback_add_str(C, "Autocomplete:     Ctrl+Enter", 0);
 175                 console_scrollback_add_str(C, "Ctrl +/-  Wheel:  Zoom", 0);
 176                 console_scrollback_add_str(C, "Builtin Modules: bpy, bpy.data, bpy.ops, bpy.props, bpy.types, bpy.ui", 0);
 177         }
 178
 179         /* clear and setup matrix */
 180         //UI_GetThemeColor3fv(TH_BACK, col);
 181         //glClearColor(col[0], col[1], col[2], 0.0);
 182         glClearColor(0, 0, 0, 1.0);
 183         glClear(GL_COLOR_BUFFER_BIT);
 184
 185         console_update_rect(C, ar);
 186
 187         /* worlks best with no view2d matrix set */
 188         UI_view2d_view_ortho(C, v2d);
 189
 190         /* data... */
 191
 192         console_history_verify(C); /* make sure we have some command line */
 193         console_text_main(sc, ar, CTX_wm_reports(C));
 194
 195         /* reset view matrix */
 196         UI_view2d_view_restore(C);
 197
 198         /* scrollers */
 199         scrollers= UI_view2d_scrollers_calc(C, v2d, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_GRID_CLAMP);
 200         UI_view2d_scrollers_draw(C, v2d, scrollers);
 201         UI_view2d_scrollers_free(scrollers);
 202 }
 203
 204 void console_operatortypes(void)
 205 {
 206         /* console_ops.c */
 207         WM_operatortype_append(CONSOLE_OT_move);
 208         WM_operatortype_append(CONSOLE_OT_delete);
 209         WM_operatortype_append(CONSOLE_OT_insert);
 210
 211         /* for use by python only */
 212         WM_operatortype_append(CONSOLE_OT_history_append);
 213         WM_operatortype_append(CONSOLE_OT_scrollback_append);
 214
 215         WM_operatortype_append(CONSOLE_OT_clear);
 216         WM_operatortype_append(CONSOLE_OT_history_cycle);
 217         WM_operatortype_append(CONSOLE_OT_copy);
 218         WM_operatortype_append(CONSOLE_OT_zoom);
 219
 220
 221         /* console_report.c */
 222         WM_operatortype_append(CONSOLE_OT_select_pick);
 223         WM_operatortype_append(CONSOLE_OT_select_all_toggle);
 224         WM_operatortype_append(CONSOLE_OT_select_border);
 225
 226         WM_operatortype_append(CONSOLE_OT_report_replay);
 227         WM_operatortype_append(CONSOLE_OT_report_delete);
 228         WM_operatortype_append(CONSOLE_OT_report_copy);
 229 }
 230
 231 void console_keymap(struct wmWindowManager *wm)
 232 {
 233         ListBase *keymap= WM_keymap_listbase(wm, "Console", SPACE_CONSOLE, 0);
 234
 235         /*
 236         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", LEFTARROWKEY, KM_PRESS, KM_OSKEY, 0)->ptr, "type", LINE_BEGIN);
 237         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", ENDKEY, KM_PRESS, 0, 0)->ptr, "type", LINE_END);
 238         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", RIGHTARROWKEY, KM_PRESS, KM_OSKEY, 0)->ptr, "type", LINE_BEGIN);
 239
 240         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", EKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", LINE_END);
 241         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", EKEY, KM_PRESS, KM_CTRL|KM_SHIFT, 0)->ptr, "type", LINE_END);
 242         */
 243
 244         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", HOMEKEY, KM_PRESS, 0, 0)->ptr, "type", LINE_BEGIN);
 245         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", ENDKEY, KM_PRESS, 0, 0)->ptr, "type", LINE_END);
 246
 247         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_zoom", WHEELUPMOUSE, KM_PRESS, KM_CTRL, 0)->ptr, "delta", 1);
 248         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_zoom", WHEELDOWNMOUSE, KM_PRESS, KM_CTRL, 0)->ptr, "delta", -1);
 249
 250         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_zoom", PADPLUSKEY, KM_PRESS, KM_CTRL, 0)->ptr, "delta", 1);
 251         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_zoom", PADMINUS, KM_PRESS, KM_CTRL, 0)->ptr, "delta", -1);
 252
 253
 254         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", LEFTARROWKEY, KM_PRESS, 0, 0)->ptr, "type", PREV_CHAR);
 255         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", RIGHTARROWKEY, KM_PRESS, 0, 0)->ptr, "type", NEXT_CHAR);
 256
 257         RNA_boolean_set(WM_keymap_add_item(keymap, "CONSOLE_OT_history_cycle", UPARROWKEY, KM_PRESS, 0, 0)->ptr, "reverse", 1);
 258         WM_keymap_add_item(keymap, "CONSOLE_OT_history_cycle", DOWNARROWKEY, KM_PRESS, 0, 0);
 259
 260         /*
 261         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", LEFTARROWKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", PREV_WORD);
 262         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", RIGHTARROWKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", NEXT_WORD);
 263         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", UPARROWKEY, KM_PRESS, 0, 0)->ptr, "type", PREV_LINE);
 264         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", DOWNARROWKEY, KM_PRESS, 0, 0)->ptr, "type", NEXT_LINE);
 265         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", PAGEUPKEY, KM_PRESS, 0, 0)->ptr, "type", PREV_PAGE);
 266         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", PAGEDOWNKEY, KM_PRESS, 0, 0)->ptr, "type", NEXT_PAGE);
 267
 268
 269         //RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", DELKEY, KM_PRESS, 0, 0)->ptr, "type", DEL_NEXT_CHAR);
 270         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", DKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", DEL_NEXT_CHAR);
 271         //RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", BACKSPACEKEY, KM_PRESS, 0, 0)->ptr, "type", DEL_PREV_CHAR);
 272         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", DELKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", DEL_NEXT_WORD);
 273         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", BACKSPACEKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", DEL_PREV_WORD);
 274         */
 275
 276         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", DELKEY, KM_PRESS, 0, 0)->ptr, "type", DEL_NEXT_CHAR);
 277         RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", BACKSPACEKEY, KM_PRESS, 0, 0)->ptr, "type", DEL_PREV_CHAR);
 278
 279 #ifndef DISABLE_PYTHON
 280         WM_keymap_add_item(keymap, "CONSOLE_OT_exec", RETKEY, KM_PRESS, 0, 0); /* python operator - space_text.py */
 281         WM_keymap_add_item(keymap, "CONSOLE_OT_exec", PADENTER, KM_PRESS, 0, 0);
 282
 283         //WM_keymap_add_item(keymap, "CONSOLE_OT_autocomplete", TABKEY, KM_PRESS, 0, 0); /* python operator - space_text.py */
 284         WM_keymap_add_item(keymap, "CONSOLE_OT_autocomplete", RETKEY, KM_PRESS, KM_CTRL, 0); /* python operator - space_text.py */
 285 #endif
 286
 287         /* report selection */
 288         WM_keymap_add_item(keymap, "CONSOLE_OT_select_pick", SELECTMOUSE, KM_PRESS, 0, 0);
 289         WM_keymap_add_item(keymap, "CONSOLE_OT_select_all_toggle", AKEY, KM_PRESS, 0, 0);
 290         WM_keymap_add_item(keymap, "CONSOLE_OT_select_border", BKEY, KM_PRESS, 0, 0);
 291
 292         WM_keymap_add_item(keymap, "CONSOLE_OT_report_replay", RKEY, KM_PRESS, 0, 0);
 293         WM_keymap_add_item(keymap, "CONSOLE_OT_report_delete", XKEY, KM_PRESS, 0, 0);
 294         WM_keymap_add_item(keymap, "CONSOLE_OT_report_delete", DELKEY, KM_PRESS, 0, 0);
 295         WM_keymap_add_item(keymap, "CONSOLE_OT_report_copy", CKEY, KM_PRESS, KM_CTRL, 0);
 296
 297         WM_keymap_add_item(keymap, "CONSOLE_OT_copy", CKEY, KM_PRESS, KM_CTRL, 0);
 298
 299         RNA_string_set(WM_keymap_add_item(keymap, "CONSOLE_OT_insert", TABKEY, KM_PRESS, 0, 0)->ptr, "text", "    "); /* fake tabs */
 300         WM_keymap_add_item(keymap, "CONSOLE_OT_insert", KM_TEXTINPUT, KM_ANY, KM_ANY, 0); // last!
 301 }
 302
 303 /****************** header region ******************/
 304
 305 /* add handlers, stuff you only do once or on area/region changes */
 306 static void console_header_area_init(wmWindowManager *wm, ARegion *ar)
 307 {
 308         ED_region_header_init(ar);
 309 }
 310
 311 static void console_header_area_draw(const bContext *C, ARegion *ar)
 312 {
 313         ED_region_header(C, ar);
 314 }
 315
 316 static void console_main_area_listener(ScrArea *sa, wmNotifier *wmn)
 317 {
 318         SpaceConsole *sc= sa->spacedata.first;
 319
 320         /* context changes */
 321         switch(wmn->category) {
 322                 case NC_CONSOLE:
 323                         if(wmn->data == ND_CONSOLE) { /* generic redraw request */
 324                                 ED_area_tag_redraw(sa);
 325                         }
 326                         else if(wmn->data == ND_CONSOLE_REPORT && sc->type==CONSOLE_TYPE_REPORT) {
 327                                 /* redraw also but only for report view, could do less redraws by checking the type */
 328                                 ED_area_tag_redraw(sa);
 329                         }
 330                         break;
 331         }
 332 }
 333
 334 /* only called once, from space/spacetypes.c */
 335 void ED_spacetype_console(void)
 336 {
 337         SpaceType *sc= MEM_callocN(sizeof(SpaceType), "spacetype console");
 338         ARegionType *art;
 339
 340         sc->spaceid= SPACE_CONSOLE;
 341
 342         sc->new= console_new;
 343         sc->free= console_free;
 344         sc->init= console_init;
 345         sc->duplicate= console_duplicate;
 346         sc->operatortypes= console_operatortypes;
 347         sc->keymap= console_keymap;
 348         sc->listener= console_main_area_listener;
 349
 350         /* regions: main window */
 351         art= MEM_callocN(sizeof(ARegionType), "spacetype console region");
 352         art->regionid = RGN_TYPE_WINDOW;
 353         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
 354
 355         art->init= console_main_area_init;
 356         art->draw= console_main_area_draw;
 357
 358
 359
 360
 361         BLI_addhead(&sc->regiontypes, art);
 362
 363         /* regions: header */
 364         art= MEM_callocN(sizeof(ARegionType), "spacetype console region");
 365         art->regionid = RGN_TYPE_HEADER;
 366         art->minsizey= HEADERY;
 367         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
 368
 369         art->init= console_header_area_init;
 370         art->draw= console_header_area_draw;
 371
 372         BLI_addhead(&sc->regiontypes, art);
 373
 374
 375         BKE_spacetype_register(sc);
 376 }