src/background.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #include <gtk/gtk.h>
  23 #include <glib/gi18n.h>
  24
  25 #include "vikstatus.h"
  26 #include "background.h"
  27 #include "gtkcellrendererprogress.h"
  28
  29 static GtkWidget *bgwindow = NULL;
  30 static GtkWidget *bgtreeview = NULL;
  31 static GtkListStore *bgstore = NULL;
  32
  33 static GSList *statusbars_to_update = NULL;
  34
  35 static gint bgitemcount = 0;
  36
  37 enum
  38 {
  39   TITLE_COLUMN,
  40   PROGRESS_COLUMN,
  41   DATA_COLUMN,
  42   N_COLUMNS,
  43 };
  44
  45 void a_background_update_status ( VikStatusbar *vs, gchar *str )
  46 {
  47   gdk_threads_enter ();
  48   vik_statusbar_set_message ( vs, 1, str );
  49   gdk_threads_leave ();
  50 }
  51
  52 static void background_thread_update ()
  53 {
  54   static gchar buf[20];
  55   g_snprintf(buf, sizeof(buf), _("%d items"), bgitemcount);
  56   g_slist_foreach ( statusbars_to_update, (GFunc) a_background_update_status, buf );
  57 }
  58
  59 void a_background_thread_progress ( gpointer callbackdata, gdouble fraction )
  60 {
  61   gpointer *args = (gpointer *) callbackdata;
  62   a_background_testcancel ( callbackdata );
  63   gdk_threads_enter();
  64   gtk_list_store_set( GTK_LIST_STORE(bgstore), (GtkTreeIter *) args[5], PROGRESS_COLUMN, fraction, -1 );
  65   gdk_threads_leave();
  66
  67   args[6] = GINT_TO_POINTER(GPOINTER_TO_INT(args[6])-1);
  68   bgitemcount--;
  69   background_thread_update();
  70 }
  71
  72 static void thread_die ( gpointer args[6] )
  73 {
  74   vik_thr_free_func userdata_free_func = args[3];
  75
  76   userdata_free_func ( args[2] );
  77
  78   if ( GPOINTER_TO_INT(args[6]) )
  79   {
  80     bgitemcount -= GPOINTER_TO_INT(args[6]);
  81     background_thread_update ();
  82   }
  83
  84   g_free ( args[5] ); /* free iter */
  85   g_free ( args );
  86
  87   g_thread_exit ( NULL );
  88 }
  89
  90 void a_background_testcancel ( gpointer callbackdata )
  91 {
  92   gpointer *args = (gpointer *) callbackdata;
  93   if ( args[0] )
  94   {
  95     vik_thr_free_func cleanup = args[4];
  96     if ( cleanup )
  97       cleanup ( args[2] );
  98     thread_die( args );
  99   }
 100 }
 101
 102 void thread_helper ( gpointer args[6] )
 103 {
 104   /* unpack args */
 105   vik_thr_func func = args[1];
 106   gpointer userdata = args[2];
 107
 108   func ( userdata, args );
 109
 110   gdk_threads_enter();
 111   if ( ! args[0] )
 112     gtk_list_store_remove ( bgstore, (GtkTreeIter *) args[5] );
 113   gdk_threads_leave();
 114
 115   thread_die ( args );
 116 }
 117
 118 void a_background_thread ( GtkWindow *parent, const gchar *message, vik_thr_func func, gpointer userdata, vik_thr_free_func userdata_free_func, vik_thr_free_func userdata_cancel_cleanup_func, gint number_items )
 119 {
 120   GtkTreeIter *piter = g_malloc ( sizeof ( GtkTreeIter ) );
 121   gpointer *args = g_malloc ( sizeof(gpointer) * 7 );
 122
 123   args[0] = GINT_TO_POINTER(0);
 124   args[1] = func;
 125   args[2] = userdata;
 126   args[3] = userdata_free_func;
 127   args[4] = userdata_cancel_cleanup_func;
 128   args[5] = piter;
 129   args[6] = GINT_TO_POINTER(number_items);
 130
 131   bgitemcount += number_items;
 132
 133   gtk_list_store_append ( bgstore, piter );
 134   gtk_list_store_set ( bgstore, piter, TITLE_COLUMN, message, PROGRESS_COLUMN, 0.0, DATA_COLUMN, args, -1 );
 135
 136   /* run the thread in the background */
 137   g_thread_create( (GThreadFunc) thread_helper, args, FALSE, NULL );
 138 }
 139
 140 void a_background_show_window ()
 141 {
 142   gtk_widget_show_all ( bgwindow );
 143 }
 144
 145 static void cancel_job_with_iter ( GtkTreeIter *piter )
 146 {
 147     gpointer *args;
 148     gtk_tree_model_get( GTK_TREE_MODEL(bgstore), piter, DATA_COLUMN, &args, -1 );
 149
 150     /* we know args still exists because it is free _after_ the list item is destroyed */
 151     /* need MUTEX ? */
 152     args[0] = GINT_TO_POINTER(1); /* set killswitch */
 153
 154     gtk_list_store_remove ( bgstore, piter );
 155 }
 156
 157 static void bgwindow_response (GtkDialog *dialog, gint arg1 )
 158 {
 159   /* note this function is a signal handler called back from the GTK main loop,
 160    * so GDK is already locked.  We need to release the lock before calling
 161    * thread-safe routines
 162    */
 163   if ( arg1 == 1 ) /* cancel */
 164     {
 165       GtkTreeIter iter;
 166       if ( gtk_tree_selection_get_selected ( gtk_tree_view_get_selection ( GTK_TREE_VIEW(bgtreeview) ), NULL, &iter ) )
 167         cancel_job_with_iter ( &iter );
 168       gdk_threads_leave();
 169       background_thread_update();
 170       gdk_threads_enter();
 171     }
 172   else if ( arg1 == 2 ) /* clear */
 173     {
 174       GtkTreeIter iter;
 175       while ( gtk_tree_model_get_iter_first ( GTK_TREE_MODEL(bgstore), &iter ) )
 176         cancel_job_with_iter ( &iter );
 177       gdk_threads_leave();
 178       background_thread_update();
 179       gdk_threads_enter();
 180     }
 181   else /* OK */
 182     gtk_widget_hide ( bgwindow );
 183 }
 184
 185 void a_background_init()
 186 {
 187   GtkCellRenderer *renderer;
 188   GtkTreeViewColumn *column;
 189   GtkWidget *scrolled_window;
 190
 191   /* store & treeview */
 192   bgstore = gtk_list_store_new ( N_COLUMNS, G_TYPE_STRING, G_TYPE_DOUBLE, G_TYPE_POINTER );
 193   bgtreeview = gtk_tree_view_new_with_model ( GTK_TREE_MODEL(bgstore) );
 194   gtk_tree_view_set_rules_hint (GTK_TREE_VIEW (bgtreeview), TRUE);
 195   gtk_tree_selection_set_mode (gtk_tree_view_get_selection (GTK_TREE_VIEW (bgtreeview)),
 196                                GTK_SELECTION_SINGLE);
 197
 198   /* add columns */
 199   renderer = gtk_cell_renderer_text_new ();
 200   column = gtk_tree_view_column_new_with_attributes ( _("Job"), renderer, "text", TITLE_COLUMN, NULL );
 201   gtk_tree_view_append_column ( GTK_TREE_VIEW(bgtreeview), column );
 202
 203   renderer = gtk_cell_renderer_progress_new ();
 204   column = gtk_tree_view_column_new_with_attributes ( _("Progress"), renderer, "percentage", PROGRESS_COLUMN, NULL );
 205   gtk_tree_view_append_column ( GTK_TREE_VIEW(bgtreeview), column );
 206
 207   /* setup window */
 208   scrolled_window = gtk_scrolled_window_new ( NULL, NULL );
 209   gtk_container_add ( GTK_CONTAINER(scrolled_window), bgtreeview );
 210   gtk_scrolled_window_set_policy ( GTK_SCROLLED_WINDOW(scrolled_window), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
 211
 212   bgwindow = gtk_dialog_new_with_buttons ( "", NULL, 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_DELETE, 1, GTK_STOCK_CLEAR, 2, NULL );
 213   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(bgwindow)->vbox), scrolled_window, TRUE, TRUE, 0 );
 214   gtk_window_set_default_size ( GTK_WINDOW(bgwindow), 400, 400 );
 215   gtk_window_set_title ( GTK_WINDOW(bgwindow), _("Viking Background Jobs") );
 216   /* don't destroy win */
 217   g_signal_connect ( G_OBJECT(bgwindow), "delete-event", G_CALLBACK(gtk_widget_hide_on_delete), NULL );
 218
 219   g_signal_connect ( G_OBJECT(bgwindow), "response", G_CALLBACK(bgwindow_response), 0 );
 220
 221 }
 222
 223 void a_background_add_status(VikStatusbar *vs)
 224 {
 225   statusbars_to_update = g_slist_prepend(statusbars_to_update,vs);
 226 }
 227
 228 void a_background_remove_status(VikStatusbar *vs)
 229 {
 230   statusbars_to_update = g_slist_remove(statusbars_to_update,vs);
 231 }
 232