space_console.c

Go to the documentation of this file.

/*
 * ***** 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * 
 * Contributor(s): Campbell Barton
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include <string.h>
#include <stdio.h>

#ifdef WIN32
#include "BLI_winstuff.h"
#endif

#include "MEM_guardedalloc.h"

#include "BLI_blenlib.h"
#include "BLI_math.h"
#include "BLI_utildefines.h"

#include "BKE_context.h"
#include "BKE_screen.h"
#include "BKE_idcode.h"

#include "ED_space_api.h"
#include "ED_screen.h"

#include "BIF_gl.h"

#include "RNA_access.h"

#include "WM_api.h"
#include "WM_types.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 *UNUSED(C))
{
    ARegion *ar;
    SpaceConsole *sconsole;
    
    sconsole= MEM_callocN(sizeof(SpaceConsole), "initconsole");
    sconsole->spacetype= SPACE_CONSOLE;
    
    sconsole->lheight=  14;
    
    /* 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;
    
    /* keep in sync with info */
    ar->v2d.scroll |= (V2D_SCROLL_RIGHT);
    ar->v2d.align |= V2D_ALIGN_NO_NEG_X|V2D_ALIGN_NO_NEG_Y; /* align bottom left */
    ar->v2d.keepofs |= V2D_LOCKOFS_X;
    ar->v2d.keepzoom = (V2D_LOCKZOOM_X|V2D_LOCKZOOM_Y|V2D_LIMITZOOM|V2D_KEEPASPECT);
    ar->v2d.keeptot= V2D_KEEPTOT_BOUNDS;
    ar->v2d.minzoom= ar->v2d.maxzoom= 1.0f;

    /* for now, aspect ratio should be maintained, and zoom is clamped within sane default limits */
    //ar->v2d.keepzoom= (V2D_KEEPASPECT|V2D_LIMITZOOM);

    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 *UNUSED(wm), ScrArea *UNUSED(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)
{
    wmKeyMap *keymap;
    ListBase *lb;

    const float prev_y_min= ar->v2d.cur.ymin; /* so resizing keeps the cursor visible */

    UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_CUSTOM, ar->winx, ar->winy);

    /* always keep the bottom part of the view aligned, less annoying */
    if(prev_y_min != ar->v2d.cur.ymin) {
        const float cur_y_range= ar->v2d.cur.ymax - ar->v2d.cur.ymin;
        ar->v2d.cur.ymin= prev_y_min;
        ar->v2d.cur.ymax= prev_y_min + cur_y_range;
    }

    /* own keymap */
    keymap= WM_keymap_find(wm->defaultconf, "Console", SPACE_CONSOLE, 0);
    WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
    
    /* add drop boxes */
    lb= WM_dropboxmap_find("Console", SPACE_CONSOLE, RGN_TYPE_WINDOW);
    
    WM_event_add_dropbox_handler(&ar->handlers, lb);
}


/* ************* dropboxes ************* */

static int id_drop_poll(bContext *UNUSED(C), wmDrag *drag, wmEvent *UNUSED(event))
{
//  SpaceConsole *sc= CTX_wm_space_console(C);
    if(drag->type==WM_DRAG_ID)
        return 1;
    return 0;
}

static void id_drop_copy(wmDrag *drag, wmDropBox *drop)
{
    char text[64];
    ID *id= drag->poin;
    char id_esc[(sizeof(id->name) - 2) * 2];

    BLI_strescape(id_esc, id->name+2, sizeof(id_esc));

    BLI_snprintf(text, sizeof(text), "bpy.data.%s[\"%s\"]", BKE_idcode_to_name_plural(GS(id->name)), id_esc);

    /* copy drag path to properties */
    RNA_string_set(drop->ptr, "text", text);
}

static int path_drop_poll(bContext *UNUSED(C), wmDrag *drag, wmEvent *UNUSED(event))
{
//    SpaceConsole *sc= CTX_wm_space_console(C);
    if(drag->type==WM_DRAG_PATH)
        return 1;
    return 0;
}

static void path_drop_copy(wmDrag *drag, wmDropBox *drop)
{
    char pathname[FILE_MAX+2];
    BLI_snprintf(pathname, sizeof(pathname), "\"%s\"", drag->path);
    RNA_string_set(drop->ptr, "text", pathname);
}


/* this region dropbox definition */
static void console_dropboxes(void)
{
    ListBase *lb= WM_dropboxmap_find("Console", SPACE_CONSOLE, RGN_TYPE_WINDOW);
    
    WM_dropbox_add(lb, "CONSOLE_OT_insert", id_drop_poll, id_drop_copy);
    WM_dropbox_add(lb, "CONSOLE_OT_insert", path_drop_poll, path_drop_copy);
}

/* ************* end drop *********** */

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;
    View2DScrollers *scrollers;

    if(sc->scrollback.first==NULL)
        WM_operator_name_call((bContext *)C, "CONSOLE_OT_banner", WM_OP_EXEC_DEFAULT, NULL);

    /* clear and setup matrix */
    UI_ThemeClearColor(TH_BACK);
    glClear(GL_COLOR_BUFFER_BIT);

    /* worlks best with no view2d matrix set */
    UI_view2d_view_ortho(v2d);

    /* data... */

    console_history_verify(C); /* make sure we have some command line */
    console_textview_main(sc, ar);
    
    /* 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_GRID_CLAMP);
    UI_view2d_scrollers_draw(C, v2d, scrollers);
    UI_view2d_scrollers_free(scrollers);
}

static void console_operatortypes(void)
{
    /* console_ops.c */
    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_copy);
    WM_operatortype_append(CONSOLE_OT_paste);
    WM_operatortype_append(CONSOLE_OT_select_set);
}

static void console_keymap(struct wmKeyConfig *keyconf)
{
    wmKeyMap *keymap= WM_keymap_find(keyconf, "Console", SPACE_CONSOLE, 0);
    wmKeyMapItem *kmi;
    
#ifdef __APPLE__
    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", RIGHTARROWKEY, KM_PRESS, KM_OSKEY, 0)->ptr, "type", LINE_END);
#endif

    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", 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);
    
    kmi = WM_keymap_add_item(keymap, "WM_OT_context_cycle_int", WHEELUPMOUSE, KM_PRESS, KM_CTRL, 0);
    RNA_string_set(kmi->ptr, "data_path", "space_data.font_size");
    RNA_boolean_set(kmi->ptr, "reverse", FALSE);
    
    kmi = WM_keymap_add_item(keymap, "WM_OT_context_cycle_int", WHEELDOWNMOUSE, KM_PRESS, KM_CTRL, 0);
    RNA_string_set(kmi->ptr, "data_path", "space_data.font_size");
    RNA_boolean_set(kmi->ptr, "reverse", TRUE);

    kmi = WM_keymap_add_item(keymap, "WM_OT_context_cycle_int", PADPLUSKEY, KM_PRESS, KM_CTRL, 0);
    RNA_string_set(kmi->ptr, "data_path", "space_data.font_size");
    RNA_boolean_set(kmi->ptr, "reverse", FALSE);
    
    kmi = WM_keymap_add_item(keymap, "WM_OT_context_cycle_int", PADMINUS, KM_PRESS, KM_CTRL, 0);
    RNA_string_set(kmi->ptr, "data_path", "space_data.font_size");
    RNA_boolean_set(kmi->ptr, "reverse", TRUE);

    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);
    
    kmi = WM_keymap_add_item(keymap, "CONSOLE_OT_history_cycle", UPARROWKEY, KM_PRESS, 0, 0);
    RNA_boolean_set(kmi->ptr, "reverse", TRUE);
    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);
    RNA_enum_set(WM_keymap_add_item(keymap, "CONSOLE_OT_delete", BACKSPACEKEY, KM_PRESS, KM_SHIFT, 0)->ptr, "type", DEL_PREV_CHAR);  /* same as above [#26623] */

#ifdef WITH_PYTHON
    WM_keymap_add_item(keymap, "CONSOLE_OT_execute", RETKEY, KM_PRESS, 0, 0); /* python operator - space_text.py */
    WM_keymap_add_item(keymap, "CONSOLE_OT_execute", PADENTER, KM_PRESS, 0, 0);
    
    //WM_keymap_add_item(keymap, "CONSOLE_OT_autocomplete", TABKEY, KM_PRESS, 0, 0); /* python operator - space_text.py */
    WM_keymap_add_item(keymap, "CONSOLE_OT_autocomplete", SPACEKEY, KM_PRESS, KM_CTRL, 0); /* python operator - space_text.py */
#endif

    WM_keymap_add_item(keymap, "CONSOLE_OT_copy", CKEY, KM_PRESS, KM_CTRL, 0);
    WM_keymap_add_item(keymap, "CONSOLE_OT_paste", VKEY, KM_PRESS, KM_CTRL, 0);
#ifdef __APPLE__
    WM_keymap_add_item(keymap, "CONSOLE_OT_copy", CKEY, KM_PRESS, KM_OSKEY, 0);
    WM_keymap_add_item(keymap, "CONSOLE_OT_paste", VKEY, KM_PRESS, KM_OSKEY, 0);
#endif
    
    WM_keymap_add_item(keymap, "CONSOLE_OT_select_set", LEFTMOUSE, KM_PRESS, 0, 0);

    RNA_string_set(WM_keymap_add_item(keymap, "CONSOLE_OT_insert", TABKEY, KM_PRESS, 0, 0)->ptr, "text", "\t"); /* fake tabs */
    WM_keymap_add_item(keymap, "CONSOLE_OT_insert", KM_TEXTINPUT, KM_ANY, 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 *UNUSED(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(ARegion *ar, wmNotifier *wmn)
{
    // SpaceInfo *sinfo= sa->spacedata.first;

    /* context changes */
    switch(wmn->category) {
        case NC_SPACE:
            if(wmn->data == ND_SPACE_CONSOLE) { /* generic redraw request */
                ED_region_tag_redraw(ar);
            }
            break;
    }
}

/* only called once, from space/spacetypes.c */
void ED_spacetype_console(void)
{
    SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype console");
    ARegionType *art;
    
    st->spaceid= SPACE_CONSOLE;
    strncpy(st->name, "Console", BKE_ST_MAXNAME);
    
    st->new= console_new;
    st->free= console_free;
    st->init= console_init;
    st->duplicate= console_duplicate;
    st->operatortypes= console_operatortypes;
    st->keymap= console_keymap;
    st->dropboxes= console_dropboxes;
    
    /* regions: main window */
    art= MEM_callocN(sizeof(ARegionType), "spacetype console region");
    art->regionid = RGN_TYPE_WINDOW;
    art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;

    art->init= console_main_area_init;
    art->draw= console_main_area_draw;
    art->listener= console_main_area_listener;
    
    

    BLI_addhead(&st->regiontypes, art);
    
    /* regions: header */
    art= MEM_callocN(sizeof(ARegionType), "spacetype console region");
    art->regionid = RGN_TYPE_HEADER;
    art->prefsizey= HEADERY;
    art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D|ED_KEYMAP_HEADER;
    
    art->init= console_header_area_init;
    art->draw= console_header_area_draw;
    
    BLI_addhead(&st->regiontypes, art);


    BKE_spacetype_register(st);
}