dialog-custom-report.c

/********************************************************************\
 * dialog-custom-report.h -- dialog for managing custom reports     *
 *                                                                  *
 *                                                                  *
 * Copyright (C) 2009                                               *
 *                                                                  *
 * Andrew Sackville-West                                            *
 * (andrew@swclan.homelinux.org)                                    *
 *                                                                  *
 * 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, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
\********************************************************************/


#include "config.h"

#include <glib/gi18n.h>
#include <gtk/gtk.h>
#include <glade/glade.h>
#include <libguile.h>
#include "swig-runtime.h"

#include "dialog-custom-report.h"
#include "dialog-options.h"
#include "dialog-utils.h"
#include "gnc-main-window.h"
#include "option-util.h"
#include "window-report.h"
#include "guile-mappings.h"
#include "gnc-gui-query.h"
#include "gnc-ui.h"
#include "gnc-report.h"
#include "gnc-plugin-page-report.h"


/* convenience for accessing columns in the GtkListStore that holds
   the reports */
enum
{
    COL_NAME = 0,
    COL_NUM,
    NUM_COLS
};

/* all the pertinent stuff needed to pass around */
typedef struct _CustomReportDialog
{
    /* dialog */
    GtkWidget *dialog;
    GtkWidget *reportview;
    GncMainWindow *window;

    /* data */
    SCM reportlist;

} CustomReportDialog;

static void
custom_report_dialog_close_cb(GtkWidget* widget,
                              CustomReportDialog *crd)
{
    gtk_widget_destroy(crd->dialog);
    g_free(crd);

}


static void
cancel_custom_report_clicked_cb(GtkWidget* widget,
                                CustomReportDialog *crd)
{
    custom_report_dialog_close_cb(NULL, crd);
}


static void
update_report_list(GtkListStore *store, CustomReportDialog *crd)
{

    SCM get_names = scm_c_eval_string("gnc:custom-report-template-names");
    SCM template_menu_name = scm_c_eval_string("gnc:report-template-menu-name/report-guid");
    SCM names;
    const gchar *name;
    int i;
    GtkTreeIter iter;

    gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(store), COL_NAME, GTK_SORT_ASCENDING);

    crd->reportlist = scm_call_0(get_names);
    names = crd->reportlist;

    gtk_list_store_clear(store);

    if (scm_is_list(names))
    {

        /* for all the names in the list, store them, with a reference,
                 in the gtkliststore */
        for (i = 0; !scm_is_null(names); i++)
        {
            char * str;

            scm_dynwind_begin (0); 
            str = scm_to_locale_string (scm_call_2(template_menu_name, SCM_CAR(names), SCM_BOOL_F));
            name = g_strdup (str);
            scm_dynwind_free (str); 
            scm_dynwind_end (); 

            gtk_list_store_append(store, &iter);
            gtk_list_store_set(store, &iter,
                               COL_NAME, name,
                               COL_NUM, i,
                               -1);
            names = SCM_CDR(names);

        }

    }

}


static GtkTreeModel *
create_and_fill_report_list(CustomReportDialog *crd)
{
    GtkListStore *store;
    GtkTreeIter iter;

    store = gtk_list_store_new(NUM_COLS, G_TYPE_STRING, G_TYPE_INT);

    update_report_list(store, crd);

    return GTK_TREE_MODEL (store);

}

static void
set_reports_model(CustomReportDialog *crd)
{
    GtkCellRenderer *renderer;
    GtkTreeModel *model;

    renderer = gtk_cell_renderer_text_new();

    gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW (crd->reportview), -1, "Report Name", renderer, "text", COL_NAME, NULL);

    model = create_and_fill_report_list(crd);

    gtk_tree_view_set_model (GTK_TREE_VIEW (crd->reportview), model);

    g_object_unref(model);


}


static void
custom_report_run_report(SCM guid,
                         CustomReportDialog *crd)
{

    SCM make_report = scm_c_eval_string("gnc:make-report");
    int report_id;
    GncMainWindow *window = crd->window;

    if (!scm_is_null(guid))
    {

        /* this runs the report */
        report_id = SCM_INUM(scm_call_1(make_report, guid));

        /* do this *before* the report because sometimes the report
                 takes a while... */
        custom_report_dialog_close_cb(NULL, crd);

        /* display the report */
        gnc_main_window_open_report(report_id, window);

    }

}

static SCM
get_custom_report_selection(CustomReportDialog *crd,
                            const gchar* message)
{
    GtkTreeSelection *sel;
    GtkTreeModel *model;
    GtkTreeIter iter;
    SCM guid;

    sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(crd->reportview));

    if (gtk_tree_selection_get_selected(sel, &model, &iter))
    {
        int num;

        gtk_tree_model_get(model, &iter, COL_NUM, &num, -1);
        guid = scm_list_ref(crd->reportlist, scm_int2num(num));
    }

    else
    {
        /* no selection, notify user */
        gnc_error_dialog(GTK_WIDGET(crd->window), "%s", message);
        return SCM_EOL;

    }

    return guid;

}

static void
on_custom_report_list_view_row_activated(GtkTreeView *view,
        GtkTreePath *path,
        GtkTreeViewColumn *column,
        CustomReportDialog *crd)
{

    GtkTreeModel *model;
    GtkTreeIter iter;

    model = gtk_tree_view_get_model(view);

    if (gtk_tree_model_get_iter(model, &iter, path))
    {
        int num;
        SCM guid;

        gtk_tree_model_get(model, &iter, COL_NUM, &num, -1);

        guid = scm_list_ref(crd->reportlist, scm_int2num(num));

        custom_report_run_report(guid, crd);

    }

}

static void
on_delete_custom_report_clicked(GtkWidget *button,
                                CustomReportDialog *crd)
{
    GtkTreeSelection *sel;
    GtkTreeModel *model;
    GtkTreeIter iter;

    SCM template_menu_name = scm_c_eval_string("gnc:report-template-menu-name/report-guid");
    SCM guid;
    gchar* report_name;

    sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(crd->reportview));

    guid = get_custom_report_selection(crd, _("You must select a report to delete."));
    if (!scm_is_null(guid))
    {
        char * str;

        scm_dynwind_begin (0); 
        str = scm_to_locale_string(scm_call_2(template_menu_name, guid, SCM_BOOL_F));
        report_name = g_strdup (str);
        scm_dynwind_free (str); 
        scm_dynwind_end (); 

        /* we must confirm the user wants to delete their precious custom report! */
        if (gnc_verify_dialog(crd->dialog, FALSE, "Are you sure you want to delete %s?", report_name))
        {
            SCM del_report = scm_c_eval_string("gnc:delete-report");
            scm_call_1(del_report, guid);
            update_report_list(GTK_LIST_STORE(gtk_tree_view_get_model(GTK_TREE_VIEW(crd->reportview))),
                               crd);
        }
        g_free (report_name);
    }
}

static void
run_custom_report_clicked_cb (GtkWidget* button,
                              CustomReportDialog *crd)
{

    SCM guid = get_custom_report_selection(crd, _("You must select a report to run."));
    custom_report_run_report(guid, crd);

}



void gnc_ui_custom_report(GncMainWindow * window)
{

    GladeXML* xml;
    CustomReportDialog *crd;

    crd = g_new0(CustomReportDialog, 1);

    xml = gnc_glade_xml_new("custom-report-dialog.glade", "custom_report_dialog");

    crd->dialog = glade_xml_get_widget(xml, "custom_report_dialog");
    crd->reportview = glade_xml_get_widget(xml, "custom_report_list_view");
    set_reports_model(crd);
    crd->window = window;

    /* connect the signals */
    glade_xml_signal_connect_data(xml, "cancel_custom_report_clicked_cb", G_CALLBACK(cancel_custom_report_clicked_cb), crd);
    glade_xml_signal_connect_data(xml, "custom_report_dialog_close_cb", G_CALLBACK(custom_report_dialog_close_cb), crd);
    glade_xml_signal_connect_data(xml, "on_custom_report_list_view_row_activated", G_CALLBACK(on_custom_report_list_view_row_activated), crd);
    glade_xml_signal_connect_data(xml, "on_delete_custom_report_clicked", G_CALLBACK(on_delete_custom_report_clicked), crd);
    glade_xml_signal_connect_data(xml, "run_custom_report_clicked_cb", G_CALLBACK(run_custom_report_clicked_cb), crd);

    gtk_widget_show_all(crd->dialog);

}

---