2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
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.
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.
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
23 #include <glib/gi18n.h>
25 #include "background.h"
28 static GThreadPool *thread_pool = NULL;
29 static gboolean stop_all_threads = FALSE;
31 static GtkWidget *bgwindow = NULL;
32 static GtkWidget *bgtreeview = NULL;
33 static GtkListStore *bgstore = NULL;
35 // Still only actually updating the statusbar though
36 static GSList *windows_to_update = NULL;
38 static gint bgitemcount = 0;
40 #define VIK_BG_NUM_ARGS 7
50 void a_background_update_status ( VikWindow *vw, gpointer data )
53 g_snprintf(buf, sizeof(buf), _("%d items"), bgitemcount);
54 vik_window_statusbar_update ( vw, buf, VIK_STATUSBAR_ITEMS );
57 static void background_thread_update ()
59 g_slist_foreach ( windows_to_update, (GFunc) a_background_update_status, NULL );
62 int a_background_thread_progress ( gpointer callbackdata, gdouble fraction )
64 gpointer *args = (gpointer *) callbackdata;
65 int res = a_background_testcancel ( callbackdata );
66 if (args[5] != NULL) {
68 gtk_list_store_set( GTK_LIST_STORE(bgstore), (GtkTreeIter *) args[5], PROGRESS_COLUMN, fraction*100, -1 );
72 args[6] = GINT_TO_POINTER(GPOINTER_TO_INT(args[6])-1);
74 background_thread_update();
78 static void thread_die ( gpointer args[VIK_BG_NUM_ARGS] )
80 vik_thr_free_func userdata_free_func = args[3];
82 if ( userdata_free_func != NULL )
83 userdata_free_func ( args[2] );
85 if ( GPOINTER_TO_INT(args[6]) )
87 bgitemcount -= GPOINTER_TO_INT(args[6]);
88 background_thread_update ();
91 g_free ( args[5] ); /* free iter */
95 int a_background_testcancel ( gpointer callbackdata )
97 gpointer *args = (gpointer *) callbackdata;
98 if ( stop_all_threads )
100 if ( args && args[0] )
102 vik_thr_free_func cleanup = args[4];
110 static void thread_helper ( gpointer args[VIK_BG_NUM_ARGS], gpointer user_data )
113 vik_thr_func func = args[1];
114 gpointer userdata = args[2];
116 g_debug(__FUNCTION__);
118 func ( userdata, args );
122 gtk_list_store_remove ( bgstore, (GtkTreeIter *) args[5] );
129 * a_background_thread:
132 * @func: worker function
134 * @userdata_free_func: free function for userdata
135 * @userdata_cancel_cleanup_func:
138 * Function to enlist new background function.
140 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 )
142 GtkTreeIter *piter = g_malloc ( sizeof ( GtkTreeIter ) );
143 gpointer *args = g_malloc ( sizeof(gpointer) * VIK_BG_NUM_ARGS );
145 g_debug(__FUNCTION__);
147 args[0] = GINT_TO_POINTER(0);
150 args[3] = userdata_free_func;
151 args[4] = userdata_cancel_cleanup_func;
153 args[6] = GINT_TO_POINTER(number_items);
155 bgitemcount += number_items;
157 gtk_list_store_append ( bgstore, piter );
158 gtk_list_store_set ( bgstore, piter,
159 TITLE_COLUMN, message,
160 PROGRESS_COLUMN, 0.0,
164 /* run the thread in the background */
165 g_thread_pool_push( thread_pool, args, NULL );
169 * a_background_show_window:
171 * Display the background window.
173 void a_background_show_window ()
175 gtk_widget_show_all ( bgwindow );
178 static void cancel_job_with_iter ( GtkTreeIter *piter )
182 g_debug(__FUNCTION__);
184 gtk_tree_model_get( GTK_TREE_MODEL(bgstore), piter, DATA_COLUMN, &args, -1 );
186 /* we know args still exists because it is free _after_ the list item is destroyed */
188 args[0] = GINT_TO_POINTER(1); /* set killswitch */
190 gtk_list_store_remove ( bgstore, piter );
194 static void bgwindow_response (GtkDialog *dialog, gint arg1 )
196 /* note this function is a signal handler called back from the GTK main loop,
197 * so GDK is already locked. We need to release the lock before calling
198 * thread-safe routines
200 if ( arg1 == 1 ) /* cancel */
203 if ( gtk_tree_selection_get_selected ( gtk_tree_view_get_selection ( GTK_TREE_VIEW(bgtreeview) ), NULL, &iter ) )
204 cancel_job_with_iter ( &iter );
206 background_thread_update();
209 else if ( arg1 == 2 ) /* clear */
212 while ( gtk_tree_model_get_iter_first ( GTK_TREE_MODEL(bgstore), &iter ) )
213 cancel_job_with_iter ( &iter );
215 background_thread_update();
219 gtk_widget_hide ( bgwindow );
222 #define VIK_SETTINGS_BACKGROUND_MAX_THREADS "background_max_threads"
227 * Initialize background feature.
229 void a_background_init()
231 /* initialize thread pool */
232 gint max_threads = 10; /* limit maximum number of threads running at one time */
234 if ( a_settings_get_integer ( VIK_SETTINGS_BACKGROUND_MAX_THREADS, &maxt ) )
237 thread_pool = g_thread_pool_new ( (GFunc) thread_helper, NULL, max_threads, FALSE, NULL );
239 GtkCellRenderer *renderer;
240 GtkTreeViewColumn *column;
241 GtkWidget *scrolled_window;
243 g_debug(__FUNCTION__);
245 /* store & treeview */
246 bgstore = gtk_list_store_new ( N_COLUMNS, G_TYPE_STRING, G_TYPE_DOUBLE, G_TYPE_POINTER );
247 bgtreeview = gtk_tree_view_new_with_model ( GTK_TREE_MODEL(bgstore) );
248 gtk_tree_view_set_rules_hint (GTK_TREE_VIEW (bgtreeview), TRUE);
249 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (GTK_TREE_VIEW (bgtreeview)),
250 GTK_SELECTION_SINGLE);
253 renderer = gtk_cell_renderer_text_new ();
254 column = gtk_tree_view_column_new_with_attributes ( _("Job"), renderer, "text", TITLE_COLUMN, NULL );
255 gtk_tree_view_append_column ( GTK_TREE_VIEW(bgtreeview), column );
257 renderer = gtk_cell_renderer_progress_new ();
258 column = gtk_tree_view_column_new_with_attributes ( _("Progress"), renderer, "value", PROGRESS_COLUMN, NULL );
259 gtk_tree_view_append_column ( GTK_TREE_VIEW(bgtreeview), column );
262 scrolled_window = gtk_scrolled_window_new ( NULL, NULL );
263 gtk_container_add ( GTK_CONTAINER(scrolled_window), bgtreeview );
264 gtk_scrolled_window_set_policy ( GTK_SCROLLED_WINDOW(scrolled_window), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
266 bgwindow = gtk_dialog_new_with_buttons ( "", NULL, 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_DELETE, 1, GTK_STOCK_CLEAR, 2, NULL );
267 gtk_dialog_set_default_response ( GTK_DIALOG(bgwindow), GTK_RESPONSE_ACCEPT );
268 GtkWidget *response_w = NULL;
269 #if GTK_CHECK_VERSION (2, 20, 0)
270 response_w = gtk_dialog_get_widget_for_response ( GTK_DIALOG(bgwindow), GTK_RESPONSE_ACCEPT );
272 gtk_box_pack_start ( GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(bgwindow))), scrolled_window, TRUE, TRUE, 0 );
273 gtk_window_set_default_size ( GTK_WINDOW(bgwindow), 400, 400 );
274 gtk_window_set_title ( GTK_WINDOW(bgwindow), _("Viking Background Jobs") );
276 gtk_widget_grab_focus ( response_w );
277 /* don't destroy win */
278 g_signal_connect ( G_OBJECT(bgwindow), "delete-event", G_CALLBACK(gtk_widget_hide_on_delete), NULL );
280 g_signal_connect ( G_OBJECT(bgwindow), "response", G_CALLBACK(bgwindow_response), 0 );
285 * a_background_uninit:
287 * Uninitialize background feature.
289 void a_background_uninit()
291 /* wait until all running threads stop */
292 stop_all_threads = TRUE;
293 g_thread_pool_free ( thread_pool, TRUE, TRUE );
295 gtk_list_store_clear ( bgstore );
296 g_object_unref ( bgstore );
298 gtk_widget_destroy ( bgwindow );
301 void a_background_add_window (VikWindow *vw)
303 windows_to_update = g_slist_prepend(windows_to_update,vw);
306 void a_background_remove_window (VikWindow *vw)
308 windows_to_update = g_slist_remove(windows_to_update,vw);