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 "vikstatus.h"
26 #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 static GSList *statusbars_to_update = NULL;
37 static gint bgitemcount = 0;
39 #define VIK_BG_NUM_ARGS 7
49 void a_background_update_status ( VikStatusbar *vs, gchar *str )
52 vik_statusbar_set_message ( vs, VIK_STATUSBAR_ITEMS, str );
56 static void background_thread_update ()
59 g_snprintf(buf, sizeof(buf), _("%d items"), bgitemcount);
60 g_slist_foreach ( statusbars_to_update, (GFunc) a_background_update_status, buf );
63 int a_background_thread_progress ( gpointer callbackdata, gdouble fraction )
65 gpointer *args = (gpointer *) callbackdata;
66 int res = a_background_testcancel ( callbackdata );
67 if (args[5] != NULL) {
69 gtk_list_store_set( GTK_LIST_STORE(bgstore), (GtkTreeIter *) args[5], PROGRESS_COLUMN, fraction*100, -1 );
73 args[6] = GINT_TO_POINTER(GPOINTER_TO_INT(args[6])-1);
75 background_thread_update();
79 static void thread_die ( gpointer args[VIK_BG_NUM_ARGS] )
81 vik_thr_free_func userdata_free_func = args[3];
83 if ( userdata_free_func != NULL )
84 userdata_free_func ( args[2] );
86 if ( GPOINTER_TO_INT(args[6]) )
88 bgitemcount -= GPOINTER_TO_INT(args[6]);
89 background_thread_update ();
92 g_free ( args[5] ); /* free iter */
96 int a_background_testcancel ( gpointer callbackdata )
98 gpointer *args = (gpointer *) callbackdata;
99 if ( stop_all_threads )
101 if ( args && args[0] )
103 vik_thr_free_func cleanup = args[4];
111 static void thread_helper ( gpointer args[VIK_BG_NUM_ARGS], gpointer user_data )
114 vik_thr_func func = args[1];
115 gpointer userdata = args[2];
117 g_debug(__FUNCTION__);
119 func ( userdata, args );
123 gtk_list_store_remove ( bgstore, (GtkTreeIter *) args[5] );
130 * a_background_thread:
133 * @func: worker function
135 * @userdata_free_func: free function for userdata
136 * @userdata_cancel_cleanup_func:
139 * Function to enlist new background function.
141 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 )
143 GtkTreeIter *piter = g_malloc ( sizeof ( GtkTreeIter ) );
144 gpointer *args = g_malloc ( sizeof(gpointer) * VIK_BG_NUM_ARGS );
146 g_debug(__FUNCTION__);
148 args[0] = GINT_TO_POINTER(0);
151 args[3] = userdata_free_func;
152 args[4] = userdata_cancel_cleanup_func;
154 args[6] = GINT_TO_POINTER(number_items);
156 bgitemcount += number_items;
158 gtk_list_store_append ( bgstore, piter );
159 gtk_list_store_set ( bgstore, piter,
160 TITLE_COLUMN, message,
161 PROGRESS_COLUMN, 0.0,
165 /* run the thread in the background */
166 g_thread_pool_push( thread_pool, args, NULL );
170 * a_background_show_window:
172 * Display the background window.
174 void a_background_show_window ()
176 gtk_widget_show_all ( bgwindow );
179 static void cancel_job_with_iter ( GtkTreeIter *piter )
183 g_debug(__FUNCTION__);
185 gtk_tree_model_get( GTK_TREE_MODEL(bgstore), piter, DATA_COLUMN, &args, -1 );
187 /* we know args still exists because it is free _after_ the list item is destroyed */
189 args[0] = GINT_TO_POINTER(1); /* set killswitch */
191 gtk_list_store_remove ( bgstore, piter );
195 static void bgwindow_response (GtkDialog *dialog, gint arg1 )
197 /* note this function is a signal handler called back from the GTK main loop,
198 * so GDK is already locked. We need to release the lock before calling
199 * thread-safe routines
201 if ( arg1 == 1 ) /* cancel */
204 if ( gtk_tree_selection_get_selected ( gtk_tree_view_get_selection ( GTK_TREE_VIEW(bgtreeview) ), NULL, &iter ) )
205 cancel_job_with_iter ( &iter );
207 background_thread_update();
210 else if ( arg1 == 2 ) /* clear */
213 while ( gtk_tree_model_get_iter_first ( GTK_TREE_MODEL(bgstore), &iter ) )
214 cancel_job_with_iter ( &iter );
216 background_thread_update();
220 gtk_widget_hide ( bgwindow );
226 * Initialize background feature.
228 void a_background_init()
230 /* initialize thread pool */
231 /* TODO parametrize this via preference and/or command line arg */
232 gint max_threads = 10; /* limit maximum number of threads running at one time */
233 thread_pool = g_thread_pool_new ( (GFunc) thread_helper, NULL, max_threads, FALSE, NULL );
235 GtkCellRenderer *renderer;
236 GtkTreeViewColumn *column;
237 GtkWidget *scrolled_window;
239 g_debug(__FUNCTION__);
241 /* store & treeview */
242 bgstore = gtk_list_store_new ( N_COLUMNS, G_TYPE_STRING, G_TYPE_DOUBLE, G_TYPE_POINTER );
243 bgtreeview = gtk_tree_view_new_with_model ( GTK_TREE_MODEL(bgstore) );
244 gtk_tree_view_set_rules_hint (GTK_TREE_VIEW (bgtreeview), TRUE);
245 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (GTK_TREE_VIEW (bgtreeview)),
246 GTK_SELECTION_SINGLE);
249 renderer = gtk_cell_renderer_text_new ();
250 column = gtk_tree_view_column_new_with_attributes ( _("Job"), renderer, "text", TITLE_COLUMN, NULL );
251 gtk_tree_view_append_column ( GTK_TREE_VIEW(bgtreeview), column );
253 renderer = gtk_cell_renderer_progress_new ();
254 column = gtk_tree_view_column_new_with_attributes ( _("Progress"), renderer, "value", PROGRESS_COLUMN, NULL );
255 gtk_tree_view_append_column ( GTK_TREE_VIEW(bgtreeview), column );
258 scrolled_window = gtk_scrolled_window_new ( NULL, NULL );
259 gtk_container_add ( GTK_CONTAINER(scrolled_window), bgtreeview );
260 gtk_scrolled_window_set_policy ( GTK_SCROLLED_WINDOW(scrolled_window), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
262 bgwindow = gtk_dialog_new_with_buttons ( "", NULL, 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_DELETE, 1, GTK_STOCK_CLEAR, 2, NULL );
263 gtk_dialog_set_default_response ( GTK_DIALOG(bgwindow), GTK_RESPONSE_ACCEPT );
264 GtkWidget *response_w = NULL;
265 #if GTK_CHECK_VERSION (2, 20, 0)
266 response_w = gtk_dialog_get_widget_for_response ( GTK_DIALOG(bgwindow), GTK_RESPONSE_ACCEPT );
268 gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(bgwindow)->vbox), scrolled_window, TRUE, TRUE, 0 );
269 gtk_window_set_default_size ( GTK_WINDOW(bgwindow), 400, 400 );
270 gtk_window_set_title ( GTK_WINDOW(bgwindow), _("Viking Background Jobs") );
272 gtk_widget_grab_focus ( response_w );
273 /* don't destroy win */
274 g_signal_connect ( G_OBJECT(bgwindow), "delete-event", G_CALLBACK(gtk_widget_hide_on_delete), NULL );
276 g_signal_connect ( G_OBJECT(bgwindow), "response", G_CALLBACK(bgwindow_response), 0 );
281 * a_background_uninit:
283 * Uninitialize background feature.
285 void a_background_uninit()
287 /* wait until all running threads stop */
288 stop_all_threads = TRUE;
289 g_thread_pool_free ( thread_pool, TRUE, TRUE );
292 void a_background_add_status(VikStatusbar *vs)
294 statusbars_to_update = g_slist_prepend(statusbars_to_update,vs);
297 void a_background_remove_status(VikStatusbar *vs)
299 statusbars_to_update = g_slist_remove(statusbars_to_update,vs);