2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
5 * Copyright (c) 2015, Rob Norris <rw_norris@hotmail.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <glib/gi18n.h>
26 #include "background.h"
30 #include "uibuilder.h"
32 #include "preferences.h"
34 static GThreadPool *thread_pool_remote = NULL;
35 static GThreadPool *thread_pool_local = NULL;
37 static GThreadPool *thread_pool_local_mapnik = NULL;
39 static gboolean stop_all_threads = FALSE;
41 static GtkWidget *bgwindow = NULL;
42 static GtkWidget *bgtreeview = NULL;
43 static GtkListStore *bgstore = NULL;
45 // Still only actually updating the statusbar though
46 static GSList *windows_to_update = NULL;
48 static gint bgitemcount = 0;
50 #define VIK_BG_NUM_ARGS 7
60 void a_background_update_status ( VikWindow *vw, gpointer data )
63 g_snprintf(buf, sizeof(buf), _("%d items"), bgitemcount);
64 vik_window_statusbar_update ( vw, buf, VIK_STATUSBAR_ITEMS );
67 static void background_thread_update ()
69 g_slist_foreach ( windows_to_update, (GFunc) a_background_update_status, NULL );
73 * a_background_thread_progress:
74 * @callbackdata: Thread data
75 * @fraction: The value should be between 0.0 and 1.0 indicating percentage of the task complete
77 int a_background_thread_progress ( gpointer callbackdata, gdouble fraction )
79 gpointer *args = (gpointer *) callbackdata;
80 int res = a_background_testcancel ( callbackdata );
81 if (args[5] != NULL) {
82 gdouble myfraction = fabs(fraction);
83 if ( myfraction > 1.0 )
86 gtk_list_store_set( GTK_LIST_STORE(bgstore), (GtkTreeIter *) args[5], PROGRESS_COLUMN, myfraction*100, -1 );
90 args[6] = GINT_TO_POINTER(GPOINTER_TO_INT(args[6])-1);
92 background_thread_update();
96 static void thread_die ( gpointer args[VIK_BG_NUM_ARGS] )
98 vik_thr_free_func userdata_free_func = args[3];
100 if ( userdata_free_func != NULL )
101 userdata_free_func ( args[2] );
103 if ( GPOINTER_TO_INT(args[6]) )
105 bgitemcount -= GPOINTER_TO_INT(args[6]);
106 background_thread_update ();
109 g_free ( args[5] ); /* free iter */
113 int a_background_testcancel ( gpointer callbackdata )
115 gpointer *args = (gpointer *) callbackdata;
116 if ( stop_all_threads )
118 if ( args && args[0] )
120 vik_thr_free_func cleanup = args[4];
128 static void thread_helper ( gpointer args[VIK_BG_NUM_ARGS], gpointer user_data )
131 vik_thr_func func = args[1];
132 gpointer userdata = args[2];
134 g_debug(__FUNCTION__);
136 func ( userdata, args );
140 gtk_list_store_remove ( bgstore, (GtkTreeIter *) args[5] );
147 * a_background_thread:
148 * @bp: Which pool this thread should run in
151 * @func: worker function
153 * @userdata_free_func: free function for userdata
154 * @userdata_cancel_cleanup_func:
157 * Function to enlist new background function.
159 void a_background_thread ( Background_Pool_Type bp, 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 )
161 GtkTreeIter *piter = g_malloc ( sizeof ( GtkTreeIter ) );
162 gpointer *args = g_malloc ( sizeof(gpointer) * VIK_BG_NUM_ARGS );
164 g_debug(__FUNCTION__);
166 args[0] = GINT_TO_POINTER(0);
169 args[3] = userdata_free_func;
170 args[4] = userdata_cancel_cleanup_func;
172 args[6] = GINT_TO_POINTER(number_items);
174 bgitemcount += number_items;
176 gtk_list_store_append ( bgstore, piter );
177 gtk_list_store_set ( bgstore, piter,
178 TITLE_COLUMN, message,
179 PROGRESS_COLUMN, 0.0,
183 /* run the thread in the background */
184 if ( bp == BACKGROUND_POOL_REMOTE )
185 g_thread_pool_push( thread_pool_remote, args, NULL );
186 #ifdef HAVE_LIBMAPNIK
187 else if ( bp == BACKGROUND_POOL_LOCAL_MAPNIK )
188 g_thread_pool_push( thread_pool_local_mapnik, args, NULL );
191 g_thread_pool_push( thread_pool_local, args, NULL );
195 * a_background_show_window:
197 * Display the background window.
199 void a_background_show_window ()
201 gtk_widget_show_all ( bgwindow );
204 static void cancel_job_with_iter ( GtkTreeIter *piter )
208 g_debug(__FUNCTION__);
210 gtk_tree_model_get( GTK_TREE_MODEL(bgstore), piter, DATA_COLUMN, &args, -1 );
212 /* we know args still exists because it is free _after_ the list item is destroyed */
214 args[0] = GINT_TO_POINTER(1); /* set killswitch */
216 gtk_list_store_remove ( bgstore, piter );
220 static void bgwindow_response (GtkDialog *dialog, gint arg1 )
222 /* note this function is a signal handler called back from the GTK main loop,
223 * so GDK is already locked. We need to release the lock before calling
224 * thread-safe routines
226 if ( arg1 == 1 ) /* cancel */
229 if ( gtk_tree_selection_get_selected ( gtk_tree_view_get_selection ( GTK_TREE_VIEW(bgtreeview) ), NULL, &iter ) )
230 cancel_job_with_iter ( &iter );
232 background_thread_update();
235 else if ( arg1 == 2 ) /* clear */
238 while ( gtk_tree_model_get_iter_first ( GTK_TREE_MODEL(bgstore), &iter ) )
239 cancel_job_with_iter ( &iter );
241 background_thread_update();
245 gtk_widget_hide ( bgwindow );
248 #define VIK_SETTINGS_BACKGROUND_MAX_THREADS "background_max_threads"
249 #define VIK_SETTINGS_BACKGROUND_MAX_THREADS_LOCAL "background_max_threads_local"
251 #ifdef HAVE_LIBMAPNIK
252 VikLayerParamScale params_threads[] = { {1, 64, 1, 0} }; // 64 threads should be enough for anyone...
253 // implicit use of 'MAPNIK_PREFS_NAMESPACE' to avoid dependency issues
254 static VikLayerParam prefs_mapnik[] = {
255 { VIK_LAYER_NUM_TYPES, "mapnik.background_max_threads_local_mapnik", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Threads:"), VIK_LAYER_WIDGET_SPINBUTTON, params_threads, NULL,
256 N_("Number of threads to use for Mapnik tasks. You need to restart Viking for a change to this value to be used"), NULL, NULL, NULL },
263 * Just setup any preferences.
265 void a_background_init ()
267 #ifdef HAVE_LIBMAPNIK
268 VikLayerParamData tmp;
269 // implicit use of 'MAPNIK_PREFS_NAMESPACE' to avoid dependency issues
270 tmp.u = 1; // Default to 1 thread due to potential crashing issues
271 a_preferences_register(&prefs_mapnik[0], tmp, "mapnik");
276 * a_background_post_init:
278 * Initialize background feature.
280 void a_background_post_init()
282 // initialize thread pools
283 gint max_threads = 10; /* limit maximum number of threads running at one time */
285 if ( a_settings_get_integer ( VIK_SETTINGS_BACKGROUND_MAX_THREADS, &maxt ) )
288 thread_pool_remote = g_thread_pool_new ( (GFunc) thread_helper, NULL, max_threads, FALSE, NULL );
290 if ( a_settings_get_integer ( VIK_SETTINGS_BACKGROUND_MAX_THREADS_LOCAL, &maxt ) )
293 guint cpus = util_get_number_of_cpus ();
294 max_threads = cpus > 1 ? cpus-1 : 1; // Don't use all available CPUs!
297 thread_pool_local = g_thread_pool_new ( (GFunc) thread_helper, NULL, max_threads, FALSE, NULL );
299 #ifdef HAVE_LIBMAPNIK
300 // implicit use of 'MAPNIK_PREFS_NAMESPACE' to avoid dependency issues
301 guint mapnik_threads = a_preferences_get("mapnik.background_max_threads_local_mapnik")->u;
302 thread_pool_local_mapnik = g_thread_pool_new ( (GFunc) thread_helper, NULL, mapnik_threads, FALSE, NULL );
305 GtkCellRenderer *renderer;
306 GtkTreeViewColumn *column;
307 GtkWidget *scrolled_window;
309 g_debug(__FUNCTION__);
311 /* store & treeview */
312 bgstore = gtk_list_store_new ( N_COLUMNS, G_TYPE_STRING, G_TYPE_DOUBLE, G_TYPE_POINTER );
313 bgtreeview = gtk_tree_view_new_with_model ( GTK_TREE_MODEL(bgstore) );
314 gtk_tree_view_set_rules_hint (GTK_TREE_VIEW (bgtreeview), TRUE);
315 gtk_tree_selection_set_mode (gtk_tree_view_get_selection (GTK_TREE_VIEW (bgtreeview)),
316 GTK_SELECTION_SINGLE);
319 renderer = gtk_cell_renderer_text_new ();
320 column = gtk_tree_view_column_new_with_attributes ( _("Job"), renderer, "text", TITLE_COLUMN, NULL );
321 gtk_tree_view_append_column ( GTK_TREE_VIEW(bgtreeview), column );
323 renderer = gtk_cell_renderer_progress_new ();
324 column = gtk_tree_view_column_new_with_attributes ( _("Progress"), renderer, "value", PROGRESS_COLUMN, NULL );
325 gtk_tree_view_append_column ( GTK_TREE_VIEW(bgtreeview), column );
328 scrolled_window = gtk_scrolled_window_new ( NULL, NULL );
329 gtk_container_add ( GTK_CONTAINER(scrolled_window), bgtreeview );
330 gtk_scrolled_window_set_policy ( GTK_SCROLLED_WINDOW(scrolled_window), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
332 bgwindow = gtk_dialog_new_with_buttons ( "", NULL, 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_DELETE, 1, GTK_STOCK_CLEAR, 2, NULL );
333 gtk_dialog_set_default_response ( GTK_DIALOG(bgwindow), GTK_RESPONSE_ACCEPT );
334 GtkWidget *response_w = NULL;
335 #if GTK_CHECK_VERSION (2, 20, 0)
336 response_w = gtk_dialog_get_widget_for_response ( GTK_DIALOG(bgwindow), GTK_RESPONSE_ACCEPT );
338 gtk_box_pack_start ( GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(bgwindow))), scrolled_window, TRUE, TRUE, 0 );
339 gtk_window_set_default_size ( GTK_WINDOW(bgwindow), 400, 400 );
340 gtk_window_set_title ( GTK_WINDOW(bgwindow), _("Viking Background Jobs") );
342 gtk_widget_grab_focus ( response_w );
343 /* don't destroy win */
344 g_signal_connect ( G_OBJECT(bgwindow), "delete-event", G_CALLBACK(gtk_widget_hide_on_delete), NULL );
346 g_signal_connect ( G_OBJECT(bgwindow), "response", G_CALLBACK(bgwindow_response), 0 );
351 * a_background_uninit:
353 * Uninitialize background feature.
355 void a_background_uninit()
357 stop_all_threads = TRUE;
358 // wait until these threads stop
359 g_thread_pool_free ( thread_pool_remote, TRUE, TRUE );
360 // Don't wait for these
361 g_thread_pool_free ( thread_pool_local, TRUE, FALSE );
362 #ifdef HAVE_LIBMAPNIK
363 g_thread_pool_free ( thread_pool_local_mapnik, TRUE, FALSE );
366 gtk_list_store_clear ( bgstore );
367 g_object_unref ( bgstore );
369 gtk_widget_destroy ( bgwindow );
372 void a_background_add_window (VikWindow *vw)
374 windows_to_update = g_slist_prepend(windows_to_update,vw);
377 void a_background_remove_window (VikWindow *vw)
379 windows_to_update = g_slist_remove(windows_to_update,vw);