space_info.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.
 *
 * The Original Code is Copyright (C) 2008 Blender Foundation.
 * All rights reserved.
 *
 * 
 * Contributor(s): Blender Foundation
 *
 * ***** END GPL LICENSE BLOCK *****
 */

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

#include "MEM_guardedalloc.h"

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

#include "BLF_translation.h"

#include "BKE_context.h"
#include "BKE_global.h"
#include "BKE_screen.h"

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

#include "BIF_gl.h"

#include "WM_api.h"
#include "WM_types.h"

#include "UI_resources.h"
#include "UI_interface.h"
#include "UI_view2d.h"

#include "info_intern.h"    // own include

/* ******************** default callbacks for info space ***************** */

static SpaceLink *info_new(const bContext *UNUSED(C))
{
    ARegion *ar;
    SpaceInfo *sinfo;
    
    sinfo= MEM_callocN(sizeof(SpaceInfo), "initinfo");
    sinfo->spacetype= SPACE_INFO;

    sinfo->rpt_mask= INFO_RPT_OP;

    /* header */
    ar= MEM_callocN(sizeof(ARegion), "header for info");
    
    BLI_addtail(&sinfo->regionbase, ar);
    ar->regiontype= RGN_TYPE_HEADER;
    ar->alignment= RGN_ALIGN_BOTTOM;
    
    /* main area */
    ar= MEM_callocN(sizeof(ARegion), "main area for info");
    
    BLI_addtail(&sinfo->regionbase, ar);
    ar->regiontype= RGN_TYPE_WINDOW;
    
    /* keep in sync with console */
    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 *)sinfo;
}

/* not spacelink itself */
static void info_free(SpaceLink *UNUSED(sl))
{   
//  SpaceInfo *sinfo= (SpaceInfo*) sl;
    
}


/* spacetype; init callback */
static void info_init(struct wmWindowManager *UNUSED(wm), ScrArea *UNUSED(sa))
{

}

static SpaceLink *info_duplicate(SpaceLink *sl)
{
    SpaceInfo *sinfon= MEM_dupallocN(sl);
    
    /* clear or remove stuff from old */
    
    return (SpaceLink *)sinfon;
}



/* add handlers, stuff you only do once or on area/region changes */
static void info_main_area_init(wmWindowManager *wm, ARegion *ar)
{
    wmKeyMap *keymap;

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

    /* own keymap */
    keymap= WM_keymap_find(wm->defaultconf, "Info", SPACE_INFO, 0);
    WM_event_add_keymap_handler(&ar->handlers, keymap);
}

static void info_textview_update_rect(const bContext *C, ARegion *ar)
{
    SpaceInfo *sinfo= CTX_wm_space_info(C);
    View2D *v2d= &ar->v2d;

    UI_view2d_totRect_set(v2d, ar->winx-1, info_textview_height(sinfo, ar, CTX_wm_reports(C)));
}

static void info_main_area_draw(const bContext *C, ARegion *ar)
{
    /* draw entirely, view changes should be handled here */
    SpaceInfo *sinfo= CTX_wm_space_info(C);
    View2D *v2d= &ar->v2d;
    View2DScrollers *scrollers;

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

    /* quick way to avoid drawing if not bug enough */
    if(ar->winy < 16)
        return;
        
    info_textview_update_rect(C, ar);

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

    info_textview_main(sinfo, 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_GRID_CLAMP);
    UI_view2d_scrollers_draw(C, v2d, scrollers);
    UI_view2d_scrollers_free(scrollers);
}

static void info_operatortypes(void)
{
    WM_operatortype_append(FILE_OT_pack_all);
    WM_operatortype_append(FILE_OT_unpack_all);
    WM_operatortype_append(FILE_OT_make_paths_relative);
    WM_operatortype_append(FILE_OT_make_paths_absolute);
    WM_operatortype_append(FILE_OT_report_missing_files);
    WM_operatortype_append(FILE_OT_find_missing_files);
    WM_operatortype_append(INFO_OT_reports_display_update);

    /* info_report.c */
    WM_operatortype_append(INFO_OT_select_pick);
    WM_operatortype_append(INFO_OT_select_all_toggle);
    WM_operatortype_append(INFO_OT_select_border);

    WM_operatortype_append(INFO_OT_report_replay);
    WM_operatortype_append(INFO_OT_report_delete);
    WM_operatortype_append(INFO_OT_report_copy);
}

static void info_keymap(struct wmKeyConfig *keyconf)
{
    wmKeyMap *keymap= WM_keymap_find(keyconf, "Window", 0, 0);
    
    WM_keymap_verify_item(keymap, "INFO_OT_reports_display_update", TIMERREPORT, KM_ANY, KM_ANY, 0);

    /* info space */
    keymap= WM_keymap_find(keyconf, "Info", SPACE_INFO, 0);
    
    
    /* report selection */
    WM_keymap_add_item(keymap, "INFO_OT_select_pick", SELECTMOUSE, KM_PRESS, 0, 0);
    WM_keymap_add_item(keymap, "INFO_OT_select_all_toggle", AKEY, KM_PRESS, 0, 0);
    WM_keymap_add_item(keymap, "INFO_OT_select_border", BKEY, KM_PRESS, 0, 0);

    WM_keymap_add_item(keymap, "INFO_OT_report_replay", RKEY, KM_PRESS, 0, 0);
    WM_keymap_add_item(keymap, "INFO_OT_report_delete", XKEY, KM_PRESS, 0, 0);
    WM_keymap_add_item(keymap, "INFO_OT_report_delete", DELKEY, KM_PRESS, 0, 0);
    WM_keymap_add_item(keymap, "INFO_OT_report_copy", CKEY, KM_PRESS, KM_CTRL, 0);
}

/* add handlers, stuff you only do once or on area/region changes */
static void info_header_area_init(wmWindowManager *UNUSED(wm), ARegion *ar)
{
    ED_region_header_init(ar);
}

static void info_header_area_draw(const bContext *C, ARegion *ar)
{
    ED_region_header(C, ar);
}

static void info_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_INFO_REPORT) {
                /* redraw also but only for report view, could do less redraws by checking the type */
                ED_region_tag_redraw(ar);
            }
            break;
    }
}

static void info_header_listener(ARegion *ar, wmNotifier *wmn)
{
    /* context changes */
    switch(wmn->category) {
        case NC_SCREEN:
            if(ELEM(wmn->data, ND_SCREENCAST, ND_ANIMPLAY))
                ED_region_tag_redraw(ar);
            break;
        case NC_WM: 
            if(wmn->data == ND_JOB)
                ED_region_tag_redraw(ar);
            break;
        case NC_SCENE:
            if(wmn->data==ND_RENDER_RESULT)
                ED_region_tag_redraw(ar);
            break;
        case NC_SPACE:  
            if(wmn->data == ND_SPACE_INFO)
                ED_region_tag_redraw(ar);
            break;
        case NC_ID:
            if(wmn->action == NA_RENAME)
                ED_region_tag_redraw(ar);
    }
    
}

static void recent_files_menu_draw(const bContext *UNUSED(C), Menu *menu)
{
    struct RecentFile *recent;
    uiLayout *layout= menu->layout;
    uiLayoutSetOperatorContext(layout, WM_OP_EXEC_REGION_WIN);
    if (G.recent_files.first) {
        for(recent = G.recent_files.first; (recent); recent = recent->next) {
            uiItemStringO(layout, BLI_path_basename(recent->filepath), ICON_FILE_BLEND, "WM_OT_open_mainfile", "filepath", recent->filepath);
        }
    } else {
        uiItemL(layout, IFACE_("No Recent Files"), ICON_NONE);
    }
}

static void recent_files_menu_register(void)
{
    MenuType *mt;

    mt= MEM_callocN(sizeof(MenuType), "spacetype info menu recent files");
    strcpy(mt->idname, "INFO_MT_file_open_recent");
    strcpy(mt->label, N_("Open Recent..."));
    mt->draw= recent_files_menu_draw;
    WM_menutype_add(mt);
}

/* only called once, from space/spacetypes.c */
void ED_spacetype_info(void)
{
    SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype info");
    ARegionType *art;
    
    st->spaceid= SPACE_INFO;
    strncpy(st->name, "Info", BKE_ST_MAXNAME);
    
    st->new= info_new;
    st->free= info_free;
    st->init= info_init;
    st->duplicate= info_duplicate;
    st->operatortypes= info_operatortypes;
    st->keymap= info_keymap;
    
    /* regions: main window */
    art= MEM_callocN(sizeof(ARegionType), "spacetype info region");
    art->regionid = RGN_TYPE_WINDOW;
    art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;

    art->init= info_main_area_init;
    art->draw= info_main_area_draw;
    art->listener= info_main_area_listener;

    BLI_addhead(&st->regiontypes, art);
    
    /* regions: header */
    art= MEM_callocN(sizeof(ARegionType), "spacetype info region");
    art->regionid = RGN_TYPE_HEADER;
    art->prefsizey= HEADERY;
    
    art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D|ED_KEYMAP_FRAMES|ED_KEYMAP_HEADER;
    art->listener= info_header_listener;
    art->init= info_header_area_init;
    art->draw= info_header_area_draw;
    
    BLI_addhead(&st->regiontypes, art);
    
    recent_files_menu_register();

    BKE_spacetype_register(st);
}