info_ops.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 "DNA_packedFile_types.h"
#include "DNA_space_types.h"
#include "DNA_windowmanager_types.h"

#include "MEM_guardedalloc.h"

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

#include "BKE_context.h"
#include "BKE_global.h"
#include "BKE_image.h"
#include "BKE_main.h"
#include "BKE_packedFile.h"
#include "BKE_report.h"


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


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

#include "IMB_imbuf_types.h"

#include "RNA_access.h"
#include "RNA_define.h"


#include "info_intern.h"

/********************* pack all operator *********************/

static int pack_all_exec(bContext *C, wmOperator *op)
{
    Main *bmain= CTX_data_main(C);

    packAll(bmain, op->reports);
    G.fileflags |= G_AUTOPACK;

    return OPERATOR_FINISHED;
}

static int pack_all_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
{
    Main *bmain= CTX_data_main(C);
    Image *ima;
    ImBuf *ibuf;

    // first check for dirty images
    for(ima=bmain->image.first; ima; ima=ima->id.next) {
        if(ima->ibufs.first) { /* XXX FIX */
            ibuf= BKE_image_get_ibuf(ima, NULL);
            
            if(ibuf && (ibuf->userflags & IB_BITMAPDIRTY))
                break;
        }
    }

    if(ima) {
        uiPupMenuOkee(C, "FILE_OT_pack_all", "Some images are painted on. These changes will be lost. Continue?");
        return OPERATOR_CANCELLED;
    }

    return pack_all_exec(C, op);
}

void FILE_OT_pack_all(wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Pack All";
    ot->idname= "FILE_OT_pack_all";
    
    /* api callbacks */
    ot->exec= pack_all_exec;
    ot->invoke= pack_all_invoke;

    /* flags */
    ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
}

/********************* unpack all operator *********************/

static const EnumPropertyItem unpack_all_method_items[] = {
    {PF_USE_LOCAL, "USE_LOCAL", 0, "Use files in current directory (create when necessary)", ""},
    {PF_WRITE_LOCAL, "WRITE_LOCAL", 0, "Write files to current directory (overwrite existing files)", ""},
    {PF_USE_ORIGINAL, "USE_ORIGINAL", 0, "Use files in original location (create when necessary)", ""},
    {PF_WRITE_ORIGINAL, "WRITE_ORIGINAL", 0, "Write files to original location (overwrite existing files)", ""},
    {PF_KEEP, "KEEP", 0, "Disable AutoPack, keep all packed files", ""},
    {PF_ASK, "ASK", 0, "Ask for each file", ""},
    {0, NULL, 0, NULL, NULL}};

static int unpack_all_exec(bContext *C, wmOperator *op)
{
    Main *bmain= CTX_data_main(C);
    int method= RNA_enum_get(op->ptr, "method");

    if(method != PF_KEEP) unpackAll(bmain, op->reports, method); /* XXX PF_ASK can't work here */
    G.fileflags &= ~G_AUTOPACK;

    return OPERATOR_FINISHED;
}

static int unpack_all_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
{
    Main *bmain= CTX_data_main(C);
    uiPopupMenu *pup;
    uiLayout *layout;
    char title[64];
    int count = 0;
    
    count = countPackedFiles(bmain);
    
    if(!count) {
        BKE_report(op->reports, RPT_WARNING, "No packed files. Autopack disabled");
        G.fileflags &= ~G_AUTOPACK;
        return OPERATOR_CANCELLED;
    }

    if(count == 1)
        strcpy(title, "Unpack 1 file");
    else
        BLI_snprintf(title, sizeof(title), "Unpack %d files", count);
    
    pup= uiPupMenuBegin(C, title, ICON_NONE);
    layout= uiPupMenuLayout(pup);

    uiLayoutSetOperatorContext(layout, WM_OP_EXEC_DEFAULT);
    uiItemsEnumO(layout, "FILE_OT_unpack_all", "method");

    uiPupMenuEnd(C, pup);

    return OPERATOR_CANCELLED;
}

void FILE_OT_unpack_all(wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Unpack All";
    ot->idname= "FILE_OT_unpack_all";
    
    /* api callbacks */
    ot->exec= unpack_all_exec;
    ot->invoke= unpack_all_invoke;

    /* flags */
    ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;

    /* properties */
    RNA_def_enum(ot->srna, "method", unpack_all_method_items, PF_USE_LOCAL, "Method", "How to unpack");
}

/********************* make paths relative operator *********************/

static int make_paths_relative_exec(bContext *C, wmOperator *op)
{
    Main *bmain= CTX_data_main(C);

    if(!G.relbase_valid) {
        BKE_report(op->reports, RPT_WARNING, "Can't set relative paths with an unsaved blend file");
        return OPERATOR_CANCELLED;
    }

    makeFilesRelative(bmain, bmain->name, op->reports);

    /* redraw everything so any changed paths register */
    WM_main_add_notifier(NC_WINDOW, NULL);

    return OPERATOR_FINISHED;
}

void FILE_OT_make_paths_relative(wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Make All Paths Relative";
    ot->idname= "FILE_OT_make_paths_relative";
    
    /* api callbacks */
    ot->exec= make_paths_relative_exec;

    /* flags */
    ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
}

/********************* make paths absolute operator *********************/

static int make_paths_absolute_exec(bContext *C, wmOperator *op)
{
    Main *bmain= CTX_data_main(C);

    if(!G.relbase_valid) {
        BKE_report(op->reports, RPT_WARNING, "Can't set absolute paths with an unsaved blend file");
        return OPERATOR_CANCELLED;
    }

    makeFilesAbsolute(bmain, bmain->name, op->reports);

    /* redraw everything so any changed paths register */
    WM_main_add_notifier(NC_WINDOW, NULL);

    return OPERATOR_FINISHED;
}

void FILE_OT_make_paths_absolute(wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Make All Paths Absolute";
    ot->idname= "FILE_OT_make_paths_absolute";
    
    /* api callbacks */
    ot->exec= make_paths_absolute_exec;

    /* flags */
    ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
}

/********************* report missing files operator *********************/

static int report_missing_files_exec(bContext *C, wmOperator *op)
{
    Main *bmain= CTX_data_main(C);

    /* run the missing file check */
    checkMissingFiles(bmain, op->reports);
    
    return OPERATOR_FINISHED;
}

void FILE_OT_report_missing_files(wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Report Missing Files";
    ot->idname= "FILE_OT_report_missing_files";
    
    /* api callbacks */
    ot->exec= report_missing_files_exec;

    /* flags */
    ot->flag= 0; /* only reports so no need to undo/register */
}

/********************* find missing files operator *********************/

static int find_missing_files_exec(bContext *C, wmOperator *op)
{
    Main *bmain= CTX_data_main(C);
    const char *searchpath= RNA_string_get_alloc(op->ptr, "filepath", NULL, 0);
    findMissingFiles(bmain, searchpath, op->reports);
    MEM_freeN((void *)searchpath);

    return OPERATOR_FINISHED;
}

static int find_missing_files_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
{
    /* XXX file open button text "Find Missing Files" */
    WM_event_add_fileselect(C, op); 
    return OPERATOR_RUNNING_MODAL;
}

void FILE_OT_find_missing_files(wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Find Missing Files";
    ot->idname= "FILE_OT_find_missing_files";
    
    /* api callbacks */
    ot->exec= find_missing_files_exec;
    ot->invoke= find_missing_files_invoke;

    /* flags */
    ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;

    /* properties */
    WM_operator_properties_filesel(ot, 0, FILE_SPECIAL, FILE_OPENFILE, WM_FILESEL_FILEPATH);
}

/********************* report box operator *********************/

/* Hard to decide whether to keep this as an operator, 
 * or turn it into a hardcoded ui control feature, 
 * handling TIMER events for all regions in interface_handlers.c
 * Not sure how good that is to be accessing UI data from 
 * inactive regions, so use this for now. --matt
 */

#define INFO_TIMEOUT        5.0f
#define INFO_COLOR_TIMEOUT  3.0f
#define ERROR_TIMEOUT       10.0f
#define ERROR_COLOR_TIMEOUT 6.0f
#define COLLAPSE_TIMEOUT    0.25f
static int update_reports_display_invoke(bContext *C, wmOperator *UNUSED(op), wmEvent *event)
{
    wmWindowManager *wm= CTX_wm_manager(C);
    ReportList *reports= CTX_wm_reports(C);
    Report *report;
    ReportTimerInfo *rti;
    float progress=0.0, color_progress=0.0;
    float neutral_col[3] = {0.35, 0.35, 0.35};
    float neutral_grey= 0.6;
    float timeout=0.0, color_timeout=0.0;
    int send_note= 0;
    
    /* escape if not our timer */
    if(     (reports->reporttimer==NULL) ||
            (reports->reporttimer != event->customdata) ||
            ((report= BKE_reports_last_displayable(reports))==NULL) /* may have been deleted */
    ) {
        return OPERATOR_PASS_THROUGH;
    }

    rti = (ReportTimerInfo *)reports->reporttimer->customdata;
    
    timeout = (report->type & RPT_ERROR_ALL)?ERROR_TIMEOUT:INFO_TIMEOUT;
    color_timeout = (report->type & RPT_ERROR_ALL)?ERROR_COLOR_TIMEOUT:INFO_COLOR_TIMEOUT;
    
    /* clear the report display after timeout */
    if ((float)reports->reporttimer->duration > timeout) {
        WM_event_remove_timer(wm, NULL, reports->reporttimer);
        reports->reporttimer = NULL;
        
        WM_event_add_notifier(C, NC_SPACE|ND_SPACE_INFO, NULL);
        
        return (OPERATOR_FINISHED|OPERATOR_PASS_THROUGH);
    }

    if (rti->widthfac == 0.0f) {
        /* initialise colors based on report type */
        if(report->type & RPT_ERROR_ALL) {
            rti->col[0] = 1.0;
            rti->col[1] = 0.2;
            rti->col[2] = 0.0;
        } else if(report->type & RPT_WARNING_ALL) {
            rti->col[0] = 1.0;
            rti->col[1] = 1.0;
            rti->col[2] = 0.0;
        } else if(report->type & RPT_INFO_ALL) {
            rti->col[0] = 0.3;
            rti->col[1] = 0.45;
            rti->col[2] = 0.7;
        }
        rti->greyscale = 0.75;
        rti->widthfac=1.0;
    }
    
    progress = (float)reports->reporttimer->duration / timeout;
    color_progress = (float)reports->reporttimer->duration / color_timeout;
    
    /* save us from too many draws */
    if(color_progress <= 1.0f) {
        send_note= 1;
        
        /* fade colors out sharply according to progress through fade-out duration */
        interp_v3_v3v3(rti->col, rti->col, neutral_col, color_progress);
        rti->greyscale = interpf(neutral_grey, rti->greyscale, color_progress);
    }

    /* collapse report at end of timeout */
    if (progress*timeout > timeout - COLLAPSE_TIMEOUT) {
        rti->widthfac = (progress*timeout - (timeout - COLLAPSE_TIMEOUT)) / COLLAPSE_TIMEOUT;
        rti->widthfac = 1.0f - rti->widthfac;
        send_note= 1;
    }
    
    if(send_note) {
        WM_event_add_notifier(C, NC_SPACE|ND_SPACE_INFO, NULL);
    }
    
    return (OPERATOR_FINISHED|OPERATOR_PASS_THROUGH);
}

void INFO_OT_reports_display_update(wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Update Reports Display";
    ot->idname= "INFO_OT_reports_display_update";
    
    /* api callbacks */
    ot->invoke= update_reports_display_invoke;
    
    /* flags */
    ot->flag= 0;
    
    /* properties */
}

/* report operators */