2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
5 * Copyright (C) 2013, 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
28 #include <glib/gprintf.h>
29 #include <glib/gi18n.h>
36 /************************ FILTER LIST *******************/
37 // extern VikDataSourceInterface vik_datasource_gps_interface;
39 /*** Input is TRWLayer ***/
40 extern VikDataSourceInterface vik_datasource_bfilter_simplify_interface;
41 extern VikDataSourceInterface vik_datasource_bfilter_dup_interface;
43 /*** Input is a track and a TRWLayer ***/
44 extern VikDataSourceInterface vik_datasource_bfilter_polygon_interface;
45 extern VikDataSourceInterface vik_datasource_bfilter_exclude_polygon_interface;
47 /*** Input is a track ***/
49 const VikDataSourceInterface *filters[] = {
50 &vik_datasource_bfilter_simplify_interface,
51 &vik_datasource_bfilter_dup_interface,
52 &vik_datasource_bfilter_polygon_interface,
53 &vik_datasource_bfilter_exclude_polygon_interface,
56 const guint N_FILTERS = sizeof(filters) / sizeof(filters[0]);
58 VikTrack *filter_track = NULL;
60 /********************************************************/
62 /* passed along to worker thread */
64 acq_dialog_widgets_t *w;
67 gboolean creating_new_layer;
73 /*********************************************************
74 * Definitions and routines for acquiring data from Data Sources in general
75 *********************************************************/
77 static void progress_func ( BabelProgressCode c, gpointer data, acq_dialog_widgets_t *w )
79 if ( w->source_interface->is_thread ) {
82 if ( w->source_interface->cleanup_func )
83 w->source_interface->cleanup_func ( w->user_data );
85 g_thread_exit ( NULL );
90 if ( w->source_interface->progress_func )
91 w->source_interface->progress_func ( c, data, w );
95 * Some common things to do on completion of a datasource process
97 * . Update dialog info
98 * . Update main dsisplay
100 static void on_complete_process (w_and_interface_t *wi)
102 if (wi->w->running) {
103 gtk_label_set_text ( GTK_LABEL(wi->w->status), _("Done.") );
104 if ( wi->creating_new_layer ) {
105 /* Only create the layer if it actually contains anything useful */
106 // TODO: create function for this operation to hide detail:
107 if ( ! vik_trw_layer_is_empty ( wi->vtl ) ) {
108 vik_layer_post_read ( VIK_LAYER(wi->vtl), wi->w->vvp, TRUE );
109 vik_aggregate_layer_add_layer ( vik_layers_panel_get_top_layer(wi->w->vlp), VIK_LAYER(wi->vtl), TRUE );
112 gtk_label_set_text ( GTK_LABEL(wi->w->status), _("No data.") );
114 if ( wi->w->source_interface->keep_dialog_open ) {
115 gtk_dialog_set_response_sensitive ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_ACCEPT, TRUE );
116 gtk_dialog_set_response_sensitive ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_REJECT, FALSE );
118 gtk_dialog_response ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_ACCEPT );
120 // Main display update
122 vik_layer_post_read ( VIK_LAYER(wi->vtl), wi->w->vvp, TRUE );
123 // View this data if desired - must be done after post read (so that the bounds are known)
124 if ( wi->w->source_interface->autoview ) {
125 vik_trw_layer_auto_set_view ( wi->vtl, vik_layers_panel_get_viewport(wi->w->vlp) );
127 vik_layers_panel_emit_update ( wi->w->vlp );
131 if ( wi->creating_new_layer )
132 g_object_unref(wi->vtl);
136 /* this routine is the worker thread. there is only one simultaneous download allowed */
137 static void get_from_anything ( w_and_interface_t *wi )
139 gchar *cmd = wi->cmd;
140 gchar *extra = wi->extra;
141 gboolean result = TRUE;
143 VikDataSourceInterface *source_interface = wi->w->source_interface;
145 if ( source_interface->process_func )
146 result = source_interface->process_func ( wi->vtl, cmd, extra, (BabelStatusFunc) progress_func, wi->w, wi->options );
150 g_free ( wi->options );
152 if (wi->w->running && !result) {
154 gtk_label_set_text ( GTK_LABEL(wi->w->status), _("Error: acquisition failed.") );
155 if ( wi->creating_new_layer )
156 g_object_unref ( G_OBJECT ( wi->vtl ) );
161 on_complete_process ( wi );
165 if ( source_interface->cleanup_func )
166 source_interface->cleanup_func ( wi->w->user_data );
168 if ( wi->w->running ) {
169 wi->w->running = FALSE;
177 g_thread_exit ( NULL );
181 static gchar *write_tmp_trwlayer ( VikTrwLayer *vtl )
186 g_assert ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0);
187 g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
188 f = fdopen(fd_src, "w");
189 a_gpx_write_file(vtl, f, NULL);
195 /* TODO: write with name of old track */
196 static gchar *write_tmp_track ( VikTrack *track )
201 g_assert ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0);
202 g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
203 f = fdopen(fd_src, "w");
204 a_gpx_write_track_file(track, f, NULL); /* Thank you Guilhem! Just when I needed this function... -- Evan */
210 /* TODO: cleanup, getr rid of redundancy */
212 /* depending on type of filter, often only vtl or track will be given.
213 * the other can be NULL.
215 static void acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface,
216 VikTrwLayer *vtl, VikTrack *track, gpointer userdata, VikDataSourceCleanupFunc cleanup_function )
218 /* for manual dialogs */
219 GtkWidget *dialog = NULL;
223 gchar *cmd_off = NULL;
224 gchar *extra_off = NULL;
225 acq_dialog_widgets_t *w;
227 gpointer options = NULL;
233 avt.userdata = userdata;
236 gpointer pass_along_data;
237 VikLayerParamData *paramdatas = NULL;
239 w_and_interface_t *wi;
241 /*** INIT AND CHECK EXISTENCE ***/
242 if ( source_interface->init_func )
243 user_data = source_interface->init_func(&avt);
246 pass_along_data = user_data;
248 if ( source_interface->check_existence_func ) {
249 gchar *error_str = source_interface->check_existence_func();
251 a_dialog_error_msg ( GTK_WINDOW(vw), error_str );
252 g_free ( error_str );
257 /* BUILD UI & GET OPTIONS IF NECESSARY. */
259 /* POSSIBILITY 0: NO OPTIONS. DO NOTHING HERE. */
260 /* POSSIBILITY 1: ADD_SETUP_WIDGETS_FUNC */
261 if ( source_interface->add_setup_widgets_func ) {
262 dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
264 gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
265 GtkWidget *response_w = NULL;
266 #if GTK_CHECK_VERSION (2, 20, 0)
267 response_w = gtk_dialog_get_widget_for_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
270 source_interface->add_setup_widgets_func(dialog, vvp, user_data);
271 gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
274 gtk_widget_grab_focus ( response_w );
276 if ( gtk_dialog_run ( GTK_DIALOG(dialog) ) != GTK_RESPONSE_ACCEPT ) {
277 source_interface->cleanup_func(user_data);
278 gtk_widget_destroy(dialog);
282 /* POSSIBILITY 2: UI BUILDER */
283 else if ( source_interface->params ) {
284 paramdatas = a_uibuilder_run_dialog ( source_interface->window_title, GTK_WINDOW(vw),
285 source_interface->params, source_interface->params_count,
286 source_interface->params_groups, source_interface->params_groups_count,
287 source_interface->params_defaults );
289 pass_along_data = paramdatas;
291 return; /* TODO: do we have to free anything here? */
294 /* CREATE INPUT DATA & GET COMMAND STRING */
296 if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER ) {
297 gchar *name_src = write_tmp_trwlayer ( vtl );
299 ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
300 ( pass_along_data, &cmd, &extra, name_src );
303 /* TODO: delete the tmp file? or delete it only after we're done with it? */
304 } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK ) {
305 gchar *name_src = write_tmp_trwlayer ( vtl );
306 gchar *name_src_track = write_tmp_track ( track );
308 ((VikDataSourceGetCmdStringFuncWithInputInput) source_interface->get_cmd_string_func)
309 ( pass_along_data, &cmd, &extra, name_src, name_src_track );
312 g_free ( name_src_track );
313 } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRACK ) {
314 gchar *name_src_track = write_tmp_track ( track );
316 ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
317 ( pass_along_data, &cmd, &extra, name_src_track );
319 g_free ( name_src_track );
320 } else if ( source_interface->get_cmd_string_func )
321 source_interface->get_cmd_string_func ( pass_along_data, &cmd, &extra, &options );
323 /* Get data for Off command */
324 if ( source_interface->off_func ) {
325 source_interface->off_func ( pass_along_data, &cmd_off, &extra_off );
328 /* cleanup for option dialogs */
329 if ( source_interface->add_setup_widgets_func ) {
330 gtk_widget_destroy(dialog);
332 } else if ( source_interface->params ) {
333 a_uibuilder_free_paramdatas ( paramdatas, source_interface->params, source_interface->params_count );
336 w = g_malloc(sizeof(*w));
337 wi = g_malloc(sizeof(*wi));
339 wi->w->source_interface = source_interface;
341 wi->extra = extra; /* usually input data type (?) */
342 wi->options = options;
344 wi->creating_new_layer = (!vtl);
346 dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
347 gtk_dialog_set_response_sensitive ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT, FALSE );
348 gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
352 status = gtk_label_new (_("Working..."));
353 gtk_box_pack_start ( GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dialog))), status, FALSE, FALSE, 5 );
354 gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
355 // May not want to see the dialog at all
356 if ( source_interface->is_thread || source_interface->keep_dialog_open )
357 gtk_widget_show_all(dialog);
363 if ( source_interface->add_progress_widgets_func ) {
364 source_interface->add_progress_widgets_func ( dialog, user_data );
366 w->user_data = user_data;
368 if (source_interface->mode == VIK_DATASOURCE_ADDTOLAYER) {
369 VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
370 if ( IS_VIK_TRW_LAYER(current_selected) ) {
371 wi->vtl = VIK_TRW_LAYER(current_selected);
372 wi->creating_new_layer = FALSE;
375 else if ( source_interface->mode == VIK_DATASOURCE_MANUAL_LAYER_MANAGEMENT ) {
376 // Don't create in acquire - as datasource will perform the necessary actions
377 wi->creating_new_layer = FALSE;
378 VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
379 if ( IS_VIK_TRW_LAYER(current_selected) )
380 wi->vtl = VIK_TRW_LAYER(current_selected);
382 if ( wi->creating_new_layer ) {
383 wi->vtl = VIK_TRW_LAYER ( vik_layer_create ( VIK_LAYER_TRW, w->vvp, NULL, FALSE ) );
384 vik_layer_rename ( VIK_LAYER ( wi->vtl ), _(source_interface->layer_title) );
387 if ( source_interface->is_thread ) {
389 #if GLIB_CHECK_VERSION (2, 32, 0)
390 g_thread_try_new ( "get_from_anything", (GThreadFunc)get_from_anything, wi, NULL );
392 g_thread_create ( (GThreadFunc)get_from_anything, wi, FALSE, NULL );
394 gtk_dialog_run ( GTK_DIALOG(dialog) );
396 // Cancel and mark for thread to finish
398 // NB Thread will free memory
402 a_babel_convert_from (NULL, cmd_off, extra_off, NULL, NULL, NULL);
406 g_free ( extra_off );
408 // Thread finished by normal completion - free memory
414 // This shouldn't happen...
415 gtk_label_set_text ( GTK_LABEL(w->status), _("Unable to create command\nAcquire method failed.") );
416 gtk_dialog_run (GTK_DIALOG (dialog));
420 // bypass thread method malarkly - you'll just have to wait...
421 if ( source_interface->process_func ) {
422 gboolean result = source_interface->process_func ( wi->vtl, cmd, extra, (BabelStatusFunc) progress_func, w, options );
424 a_dialog_msg ( GTK_WINDOW(vw), GTK_MESSAGE_ERROR, _("Error: acquisition failed."), NULL );
430 on_complete_process ( wi );
431 // Actually show it if necessary
432 if ( wi->w->source_interface->keep_dialog_open )
433 gtk_dialog_run ( GTK_DIALOG(dialog) );
439 gtk_widget_destroy ( dialog );
441 if ( cleanup_function )
442 cleanup_function ( source_interface );
447 * @vw: The #VikWindow to work with
448 * @vlp: The #VikLayersPanel in which a #VikTrwLayer layer may be created/appended
449 * @vvp: The #VikViewport defining the current view
450 * @source_interface: The #VikDataSourceInterface determining how and what actions to take
451 * @userdata: External data to be passed into the #VikDataSourceInterface
452 * @cleanup_function: The function to dispose the #VikDataSourceInterface if necessary
454 * Process the given VikDataSourceInterface for sources with no input data.
456 void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface,
457 gpointer userdata, VikDataSourceCleanupFunc cleanup_function )
459 acquire ( vw, vlp, vvp, source_interface, NULL, NULL, userdata, cleanup_function );
462 static void acquire_trwlayer_callback ( GObject *menuitem, gpointer *pass_along )
464 VikDataSourceInterface *iface = g_object_get_data ( menuitem, "vik_acq_iface" );
465 VikWindow *vw = pass_along[0];
466 VikLayersPanel *vlp = pass_along[1];
467 VikViewport *vvp = pass_along[2];
468 VikTrwLayer *vtl = pass_along[3];
469 VikTrack *tr = pass_along[4];
471 acquire ( vw, vlp, vvp, iface, vtl, tr, NULL, NULL );
474 static GtkWidget *acquire_build_menu ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp,
475 VikTrwLayer *vtl, VikTrack *track, /* both passed to acquire, although for many filters only one ness */
476 const gchar *menu_title, vik_datasource_inputtype_t inputtype )
478 static gpointer pass_along[5];
479 GtkWidget *menu_item=NULL, *menu=NULL;
480 GtkWidget *item=NULL;
487 pass_along[4] = track;
489 for ( i = 0; i < N_FILTERS; i++ ) {
490 if ( filters[i]->inputtype == inputtype ) {
491 if ( ! menu_item ) { /* do this just once, but return NULL if no filters */
492 menu = gtk_menu_new();
493 menu_item = gtk_menu_item_new_with_mnemonic ( menu_title );
494 gtk_menu_item_set_submenu (GTK_MENU_ITEM (menu_item), menu );
497 item = gtk_menu_item_new_with_label ( filters[i]->window_title );
498 g_object_set_data ( G_OBJECT(item), "vik_acq_iface", (gpointer) filters[i] );
499 g_signal_connect ( G_OBJECT(item), "activate", G_CALLBACK(acquire_trwlayer_callback), pass_along );
500 gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
501 gtk_widget_show ( item );
509 * a_acquire_trwlayer_menu:
511 * Create a sub menu intended for rightclicking on a TRWLayer's menu called "Filter".
513 * Returns: %NULL if no filters.
515 GtkWidget *a_acquire_trwlayer_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
517 return acquire_build_menu ( vw, vlp, vvp, vtl, NULL, _("_Filter"), VIK_DATASOURCE_INPUTTYPE_TRWLAYER );
521 * a_acquire_trwlayer_track_menu:
523 * Create a sub menu intended for rightclicking on a TRWLayer's menu called "Filter with Track "TRACKNAME"...".
525 * Returns: %NULL if no filters or no filter track has been set.
527 GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
529 if ( filter_track == NULL )
532 gchar *menu_title = g_strdup_printf ( _("Filter with %s"), filter_track->name );
533 GtkWidget *rv = acquire_build_menu ( vw, vlp, vvp, vtl, filter_track,
534 menu_title, VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK );
535 g_free ( menu_title );
541 * a_acquire_track_menu:
543 * Create a sub menu intended for rightclicking on a track's menu called "Filter".
545 * Returns: %NULL if no applicable filters
547 GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr)
549 return acquire_build_menu ( vw, vlp, vvp, NULL, tr, _("Filter"), VIK_DATASOURCE_INPUTTYPE_TRACK );
553 * a_acquire_set_filter_track:
555 * Sets application-wide track to use with filter. references the track.
557 void a_acquire_set_filter_track ( VikTrack *tr )
560 vik_track_free ( filter_track );
563 vik_track_ref ( tr );