Console Space Type

* interactive console python console.
* display reports and filter types. defaults to operator display so you can see the python commands for tools as you use them,
  eventually it should be possible to select commands and make macto/tools from them.

Example use of autocomp.  b<tab>, bpy.<tab>, bpy.<tab>, bpy.data.<tab> etc.

basic instructions are printed when opening the console.

Details...
* Console exec and autocomp are done with operators written in python.
* added CTX_wm_reports() to get the global report list.
* The window manager had a report ListBase but reports have their own struct, switched to allocate and assign when initializing the WM since the type is not available in DNA.
* changed report types flags for easier display filtering.
* added report type RPT_OPERATOR
* logging operators also adds a python-syntax report into CTX_wm_reports() so they can be displayed in the console as well as calling a notifier for console to redraw.
* RnaAPI context.area.tag_redraw() to redraw the current area from a python operator.

Todo...
* better interactions with the console, scrolling, copy/paste.
* the text displayed doesnt load back.
* colors need to be themed.
* scroll limit needs to be a user pref.
* only tested with cmake and scons.

1 files changed, 336 insertions, 0 deletions

diff --git a/source/blender/editors/space_console/space_console.c b/source/blender/editors/space_console/space_console.c
new file mode 100644
index 00000000000..ee80fe3d2d9
--- /dev/null
+++ b/source/blender/editors/space_console/space_console.c
@@ -0,0 +1,336 @@
+/**
+ * $Id:
+ *
+ * ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version. 
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ *
+ * The Original Code is Copyright (C) 2008 Blender Foundation.
+ * All rights reserved.
+ *
+ * 
+ * Contributor(s): Campbell Barton
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+ 
+ #include <string.h>
+#include <stdio.h>
+
+#include "DNA_space_types.h"
+#include "DNA_scene_types.h"
+#include "DNA_screen_types.h"
+
+#include "MEM_guardedalloc.h"
+
+#include "BLI_blenlib.h"
+#include "BLI_arithb.h"
+
+#include "BKE_colortools.h"
+#include "BKE_context.h"
+#include "BKE_screen.h"
+
+#include "ED_space_api.h"
+#include "ED_screen.h"
+
+#include "BIF_gl.h"
+
+
+#include "RNA_access.h"
+#include "RNA_define.h"
+
+#include "WM_api.h"
+#include "WM_types.h"
+
+#include "UI_interface.h"
+#include "UI_resources.h"
+#include "UI_view2d.h"
+
+#include "console_intern.h"	// own include
+
+
+/* ******************** default callbacks for console space ***************** */
+
+static SpaceLink *console_new(const bContext *C)
+{
+	ARegion *ar;
+	SpaceConsole *sconsole;
+	
+	sconsole= MEM_callocN(sizeof(SpaceConsole), "initconsole");
+	sconsole->spacetype= SPACE_CONSOLE;
+	
+	sconsole->lheight=	14;
+	sconsole->type=		CONSOLE_TYPE_PYTHON;
+	sconsole->rpt_mask=	CONSOLE_RPT_OP; /* ? - not sure whats a good default here?*/
+	
+	/* header */
+	ar= MEM_callocN(sizeof(ARegion), "header for console");
+	
+	BLI_addtail(&sconsole->regionbase, ar);
+	ar->regiontype= RGN_TYPE_HEADER;
+	ar->alignment= RGN_ALIGN_BOTTOM;
+	
+	
+	/* main area */
+	ar= MEM_callocN(sizeof(ARegion), "main area for text");
+	
+	BLI_addtail(&sconsole->regionbase, ar);
+	ar->regiontype= RGN_TYPE_WINDOW;
+	
+	ar->v2d.scroll = (V2D_SCROLL_RIGHT | V2D_SCROLL_BOTTOM_O);
+	ar->v2d.align = (V2D_ALIGN_NO_NEG_X|V2D_ALIGN_NO_POS_Y);
+	ar->v2d.keepzoom = (V2D_LOCKZOOM_X|V2D_LOCKZOOM_Y|V2D_KEEPZOOM|V2D_KEEPASPECT);
+	ar->v2d.keeptot= V2D_KEEPTOT_STRICT;
+	ar->v2d.minzoom= ar->v2d.maxzoom= 1.0f;
+	
+	return (SpaceLink *)sconsole;
+}
+
+/* not spacelink itself */
+static void console_free(SpaceLink *sl)
+{
+	SpaceConsole *sc= (SpaceConsole*) sl;
+	
+	while(sc->scrollback.first)
+		console_scrollback_free(sc, sc->scrollback.first);
+	
+	while(sc->history.first)
+		console_history_free(sc, sc->history.first);
+}
+
+
+/* spacetype; init callback */
+static void console_init(struct wmWindowManager *wm, ScrArea *sa)
+{
+
+}
+
+static SpaceLink *console_duplicate(SpaceLink *sl)
+{
+	SpaceConsole *sconsolen= MEM_dupallocN(sl);
+	
+	/* clear or remove stuff from old */
+	
+	/* TODO - duplicate?, then we also need to duplicate the py namespace */
+	sconsolen->scrollback.first= sconsolen->scrollback.last= NULL;
+	sconsolen->history.first= sconsolen->history.last= NULL;
+	
+	return (SpaceLink *)sconsolen;
+}
+
+
+
+/* add handlers, stuff you only do once or on area/region changes */
+static void console_main_area_init(wmWindowManager *wm, ARegion *ar)
+{
+	ListBase *keymap;
+	
+	UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_STANDARD, ar->winx, ar->winy);
+	
+	/* own keymap */
+	keymap= WM_keymap_listbase(wm, "Console", SPACE_CONSOLE, 0);	/* XXX weak? */
+	WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
+}
+
+static void console_main_area_draw(const bContext *C, ARegion *ar)
+{
+	/* draw entirely, view changes should be handled here */
+	SpaceConsole *sc= CTX_wm_space_console(C);
+	//View2D *v2d= &ar->v2d;
+	//float col[3];
+	
+	/* clear and setup matrix */
+	//UI_GetThemeColor3fv(TH_BACK, col);
+	//glClearColor(col[0], col[1], col[2], 0.0);
+	glClearColor(0, 0, 0, 1.0);
+	
+	glClear(GL_COLOR_BUFFER_BIT);
+	
+	/* worlks best with no view2d matrix set */
+	/*UI_view2d_view_ortho(C, v2d);*/
+		
+	/* data... */
+	
+	/* add helper text, why not? */
+	if(sc->scrollback.first==NULL) {
+		console_scrollback_add_str(C, " * Python Interactive Console *", 0);
+		console_scrollback_add_str(C, "Command History:  Up/Down Arrow", 0);
+		console_scrollback_add_str(C, "Cursor:           Left/Right Home/End", 0);
+		console_scrollback_add_str(C, "Remove:           Backspace/Delete", 0);
+		console_scrollback_add_str(C, "Execute:          Enter", 0);
+		console_scrollback_add_str(C, "Autocomplete:     Tab", 0);
+		console_scrollback_add_str(C, "Ctrl +/-  Wheel:  Zoom", 0);
+		console_scrollback_add_str(C, "Builtin Modules: bpy, bpy.data, bpy.ops, bpy.props, bpy.types, bpy.ui", 0);
+	}
+	
+	console_history_verify(C); /* make sure we have some command line */
+	console_text_main(sc, ar, CTX_wm_reports(C));
+	
+	/* reset view matrix */
+	/* UI_view2d_view_restore(C); */
+	
+	/* scrollers */
+	/*
+	scrollers= UI_view2d_scrollers_calc(C, v2d, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
+	UI_view2d_scrollers_draw(C, v2d, scrollers);
+	UI_view2d_scrollers_free(scrollers);
+	*/
+}
+
+void console_operatortypes(void)
+{
+	WM_operatortype_append(CONSOLE_OT_move);
+	WM_operatortype_append(CONSOLE_OT_delete);
+	WM_operatortype_append(CONSOLE_OT_insert);
+	
+	/* for use by python only */
+	WM_operatortype_append(CONSOLE_OT_history_append); 
+	WM_operatortype_append(CONSOLE_OT_scrollback_append);
+	
+	
+	WM_operatortype_append(CONSOLE_OT_clear); 
+	WM_operatortype_append(CONSOLE_OT_history_cycle);
+	WM_operatortype_append(CONSOLE_OT_zoom);
+}
+
+void console_keymap(struct wmWindowManager *wm)
+{
+	ListBase *keymap= WM_keymap_listbase(wm, "Console", SPACE_CONSOLE, 0);
+	
+	/*
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", LEFTARROWKEY, KM_PRESS, KM_OSKEY, 0)->ptr, "type", LINE_BEGIN);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", ENDKEY, KM_PRESS, 0, 0)->ptr, "type", LINE_END);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", RIGHTARROWKEY, KM_PRESS, KM_OSKEY, 0)->ptr, "type", LINE_BEGIN);
+	
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", EKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", LINE_END);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", EKEY, KM_PRESS, KM_CTRL|KM_SHIFT, 0)->ptr, "type", LINE_END);
+	*/
+	
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", HOMEKEY, KM_PRESS, 0, 0)->ptr, "type", LINE_BEGIN);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", ENDKEY, KM_PRESS, 0, 0)->ptr, "type", LINE_END);
+	
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_zoom", WHEELUPMOUSE, KM_PRESS, KM_CTRL, 0)->ptr, "delta", 1);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_zoom", WHEELDOWNMOUSE, KM_PRESS, KM_CTRL, 0)->ptr, "delta", -1);
+	
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_zoom", PADPLUSKEY, KM_PRESS, KM_CTRL, 0)->ptr, "delta", 1);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_zoom", PADMINUS, KM_PRESS, KM_CTRL, 0)->ptr, "delta", -1);
+	
+	
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", LEFTARROWKEY, KM_PRESS, 0, 0)->ptr, "type", PREV_CHAR);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", RIGHTARROWKEY, KM_PRESS, 0, 0)->ptr, "type", NEXT_CHAR);
+	
+	RNA_boolean_set(WM_keymap_add_item(keymap, "CONSOLE_OT_history_cycle", UPARROWKEY, KM_PRESS, 0, 0)->ptr, "reverse", 1);
+	WM_keymap_add_item(keymap, "CONSOLE_OT_history_cycle", DOWNARROWKEY, KM_PRESS, 0, 0);
+	
+	/*
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", LEFTARROWKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", PREV_WORD);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", RIGHTARROWKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", NEXT_WORD);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", UPARROWKEY, KM_PRESS, 0, 0)->ptr, "type", PREV_LINE);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", DOWNARROWKEY, KM_PRESS, 0, 0)->ptr, "type", NEXT_LINE);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", PAGEUPKEY, KM_PRESS, 0, 0)->ptr, "type", PREV_PAGE);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_move", PAGEDOWNKEY, KM_PRESS, 0, 0)->ptr, "type", NEXT_PAGE);
+
+
+	//RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", DELKEY, KM_PRESS, 0, 0)->ptr, "type", DEL_NEXT_CHAR);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", DKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", DEL_NEXT_CHAR);
+	//RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", BACKSPACEKEY, KM_PRESS, 0, 0)->ptr, "type", DEL_PREV_CHAR);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", DELKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", DEL_NEXT_WORD);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", BACKSPACEKEY, KM_PRESS, KM_CTRL, 0)->ptr, "type", DEL_PREV_WORD);
+	*/
+	
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", DELKEY, KM_PRESS, 0, 0)->ptr, "type", DEL_NEXT_CHAR);
+	RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", BACKSPACEKEY, KM_PRESS, 0, 0)->ptr, "type", DEL_PREV_CHAR);
+
+#ifndef DISABLE_PYTHON
+	WM_keymap_add_item(keymap, "CONSOLE_OT_exec", RETKEY, KM_PRESS, 0, 0); /* python operator - space_text.py */
+	WM_keymap_add_item(keymap, "CONSOLE_OT_autocomplete", TABKEY, KM_PRESS, 0, 0); /* python operator - space_text.py */
+#endif
+	WM_keymap_add_item(keymap, "CONSOLE_OT_insert", KM_TEXTINPUT, KM_PRESS, KM_ANY, 0); // last!
+}
+
+/****************** header region ******************/
+
+/* add handlers, stuff you only do once or on area/region changes */
+static void console_header_area_init(wmWindowManager *wm, ARegion *ar)
+{
+	ED_region_header_init(ar);
+}
+
+static void console_header_area_draw(const bContext *C, ARegion *ar)
+{
+	ED_region_header(C, ar);
+}
+
+static void console_main_area_listener(ScrArea *sa, wmNotifier *wmn)
+{
+	SpaceConsole *sc= sa->spacedata.first;
+
+	/* context changes */
+	switch(wmn->category) {
+		case NC_CONSOLE:
+			if(wmn->data == ND_CONSOLE) { /* generic redraw request */
+				ED_area_tag_redraw(sa);
+			}
+			else if(wmn->data == ND_CONSOLE_REPORT && sc->type==CONSOLE_TYPE_REPORT) {
+				/* redraw also but only for report view, could do less redraws by checking the type */
+				ED_area_tag_redraw(sa);
+			}
+			break;
+	}
+}
+
+/* only called once, from space/spacetypes.c */
+void ED_spacetype_console(void)
+{
+	SpaceType *sc= MEM_callocN(sizeof(SpaceType), "spacetype console");
+	ARegionType *art;
+	
+	sc->spaceid= SPACE_CONSOLE;
+	
+	sc->new= console_new;
+	sc->free= console_free;
+	sc->init= console_init;
+	sc->duplicate= console_duplicate;
+	sc->operatortypes= console_operatortypes;
+	sc->keymap= console_keymap;
+	sc->listener= console_main_area_listener;
+	
+	/* regions: main window */
+	art= MEM_callocN(sizeof(ARegionType), "spacetype console region");
+	art->regionid = RGN_TYPE_WINDOW;
+	art->init= console_main_area_init;
+	art->draw= console_main_area_draw;
+	
+	
+	
+	BLI_addhead(&sc->regiontypes, art);
+	
+	/* regions: header */
+	art= MEM_callocN(sizeof(ARegionType), "spacetype console region");
+	art->regionid = RGN_TYPE_HEADER;
+	art->minsizey= HEADERY;
+	art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
+	
+	art->init= console_header_area_init;
+	art->draw= console_header_area_draw;
+	
+	BLI_addhead(&sc->regiontypes, art);
+	
+	
+	
+	BKE_spacetype_register(sc);
+}
+
+