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>
37 /************************ FILTER LIST *******************/
38 // extern VikDataSourceInterface vik_datasource_gps_interface;
40 /*** Input is TRWLayer ***/
41 extern VikDataSourceInterface vik_datasource_bfilter_simplify_interface;
42 extern VikDataSourceInterface vik_datasource_bfilter_compress_interface;
43 extern VikDataSourceInterface vik_datasource_bfilter_dup_interface;
45 /*** Input is a track and a TRWLayer ***/
46 extern VikDataSourceInterface vik_datasource_bfilter_polygon_interface;
47 extern VikDataSourceInterface vik_datasource_bfilter_exclude_polygon_interface;
49 /*** Input is a track ***/
51 const VikDataSourceInterface *filters[] = {
52 &vik_datasource_bfilter_simplify_interface,
53 &vik_datasource_bfilter_compress_interface,
54 &vik_datasource_bfilter_dup_interface,
55 &vik_datasource_bfilter_polygon_interface,
56 &vik_datasource_bfilter_exclude_polygon_interface,
59 const guint N_FILTERS = sizeof(filters) / sizeof(filters[0]);
61 VikTrack *filter_track = NULL;
63 /********************************************************/
65 /* passed along to worker thread */
67 acq_dialog_widgets_t *w;
70 gboolean creating_new_layer;
76 /*********************************************************
77 * Definitions and routines for acquiring data from Data Sources in general
78 *********************************************************/
80 static void progress_func ( BabelProgressCode c, gpointer data, acq_dialog_widgets_t *w )
82 if ( w->source_interface->is_thread ) {
85 if ( w->source_interface->cleanup_func )
86 w->source_interface->cleanup_func ( w->user_data );
88 g_thread_exit ( NULL );
93 if ( w->source_interface->progress_func )
94 w->source_interface->progress_func ( c, data, w );
98 * Some common things to do on completion of a datasource process
100 * . Update dialog info
101 * . Update main dsisplay
103 static void on_complete_process (w_and_interface_t *wi)
105 if (wi->w->running) {
106 gtk_label_set_text ( GTK_LABEL(wi->w->status), _("Done.") );
107 if ( wi->creating_new_layer ) {
108 /* Only create the layer if it actually contains anything useful */
109 // TODO: create function for this operation to hide detail:
110 if ( ! vik_trw_layer_is_empty ( wi->vtl ) ) {
111 vik_layer_post_read ( VIK_LAYER(wi->vtl), wi->w->vvp, TRUE );
112 vik_aggregate_layer_add_layer ( vik_layers_panel_get_top_layer(wi->w->vlp), VIK_LAYER(wi->vtl), TRUE );
115 gtk_label_set_text ( GTK_LABEL(wi->w->status), _("No data.") );
117 if ( wi->w->source_interface->keep_dialog_open ) {
118 gtk_dialog_set_response_sensitive ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_ACCEPT, TRUE );
119 gtk_dialog_set_response_sensitive ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_REJECT, FALSE );
121 gtk_dialog_response ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_ACCEPT );
123 // Main display update
125 vik_layer_post_read ( VIK_LAYER(wi->vtl), wi->w->vvp, TRUE );
126 // View this data if desired - must be done after post read (so that the bounds are known)
127 if ( wi->w->source_interface->autoview ) {
128 vik_trw_layer_auto_set_view ( wi->vtl, vik_layers_panel_get_viewport(wi->w->vlp) );
130 vik_layers_panel_emit_update ( wi->w->vlp );
134 if ( wi->creating_new_layer )
135 g_object_unref(wi->vtl);
139 /* this routine is the worker thread. there is only one simultaneous download allowed */
140 static void get_from_anything ( w_and_interface_t *wi )
142 gchar *cmd = wi->cmd;
143 gchar *extra = wi->extra;
144 gboolean result = TRUE;
146 VikDataSourceInterface *source_interface = wi->w->source_interface;
148 if ( source_interface->process_func )
149 result = source_interface->process_func ( wi->vtl, cmd, extra, (BabelStatusFunc) progress_func, wi->w, wi->options );
153 g_free ( wi->options );
155 if (wi->w->running && !result) {
157 gtk_label_set_text ( GTK_LABEL(wi->w->status), _("Error: acquisition failed.") );
158 if ( wi->creating_new_layer )
159 g_object_unref ( G_OBJECT ( wi->vtl ) );
164 on_complete_process ( wi );
168 if ( source_interface->cleanup_func )
169 source_interface->cleanup_func ( wi->w->user_data );
171 if ( wi->w->running ) {
172 wi->w->running = FALSE;
180 g_thread_exit ( NULL );
183 /* depending on type of filter, often only vtl or track will be given.
184 * the other can be NULL.
186 static void acquire ( VikWindow *vw,
189 vik_datasource_mode_t mode,
190 VikDataSourceInterface *source_interface,
194 VikDataSourceCleanupFunc cleanup_function )
196 /* for manual dialogs */
197 GtkWidget *dialog = NULL;
201 gchar *cmd_off = NULL;
202 gchar *extra_off = NULL;
203 acq_dialog_widgets_t *w;
205 gpointer options = NULL;
211 avt.userdata = userdata;
214 gpointer pass_along_data;
215 VikLayerParamData *paramdatas = NULL;
217 w_and_interface_t *wi;
219 /*** INIT AND CHECK EXISTENCE ***/
220 if ( source_interface->init_func )
221 user_data = source_interface->init_func(&avt);
224 pass_along_data = user_data;
226 if ( source_interface->check_existence_func ) {
227 gchar *error_str = source_interface->check_existence_func();
229 a_dialog_error_msg ( GTK_WINDOW(vw), error_str );
230 g_free ( error_str );
235 /* BUILD UI & GET OPTIONS IF NECESSARY. */
237 /* POSSIBILITY 0: NO OPTIONS. DO NOTHING HERE. */
238 /* POSSIBILITY 1: ADD_SETUP_WIDGETS_FUNC */
239 if ( source_interface->add_setup_widgets_func ) {
240 dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
242 gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
243 GtkWidget *response_w = NULL;
244 #if GTK_CHECK_VERSION (2, 20, 0)
245 response_w = gtk_dialog_get_widget_for_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
248 source_interface->add_setup_widgets_func(dialog, vvp, user_data);
249 gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
252 gtk_widget_grab_focus ( response_w );
254 if ( gtk_dialog_run ( GTK_DIALOG(dialog) ) != GTK_RESPONSE_ACCEPT ) {
255 source_interface->cleanup_func(user_data);
256 gtk_widget_destroy(dialog);
260 /* POSSIBILITY 2: UI BUILDER */
261 else if ( source_interface->params ) {
262 paramdatas = a_uibuilder_run_dialog ( source_interface->window_title, GTK_WINDOW(vw),
263 source_interface->params, source_interface->params_count,
264 source_interface->params_groups, source_interface->params_groups_count,
265 source_interface->params_defaults );
267 pass_along_data = paramdatas;
269 return; /* TODO: do we have to free anything here? */
272 /* CREATE INPUT DATA & GET COMMAND STRING */
274 if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER ) {
275 gchar *name_src = a_gpx_write_tmp_file ( vtl, NULL );
277 ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
278 ( pass_along_data, &cmd, &extra, name_src );
280 util_add_to_deletion_list ( name_src );
283 } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK ) {
284 gchar *name_src = a_gpx_write_tmp_file ( vtl, NULL );
285 gchar *name_src_track = a_gpx_write_track_tmp_file ( track, NULL );
287 ((VikDataSourceGetCmdStringFuncWithInputInput) source_interface->get_cmd_string_func)
288 ( pass_along_data, &cmd, &extra, name_src, name_src_track );
290 util_add_to_deletion_list ( name_src );
291 util_add_to_deletion_list ( name_src_track );
294 g_free ( name_src_track );
295 } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRACK ) {
296 gchar *name_src_track = a_gpx_write_track_tmp_file ( track, NULL );
298 ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
299 ( pass_along_data, &cmd, &extra, name_src_track );
301 g_free ( name_src_track );
302 } else if ( source_interface->get_cmd_string_func )
303 source_interface->get_cmd_string_func ( pass_along_data, &cmd, &extra, &options );
305 /* Get data for Off command */
306 if ( source_interface->off_func ) {
307 source_interface->off_func ( pass_along_data, &cmd_off, &extra_off );
310 /* cleanup for option dialogs */
311 if ( source_interface->add_setup_widgets_func ) {
312 gtk_widget_destroy(dialog);
314 } else if ( source_interface->params ) {
315 a_uibuilder_free_paramdatas ( paramdatas, source_interface->params, source_interface->params_count );
318 w = g_malloc(sizeof(*w));
319 wi = g_malloc(sizeof(*wi));
321 wi->w->source_interface = source_interface;
323 wi->extra = extra; /* usually input data type (?) */
324 wi->options = options;
326 wi->creating_new_layer = (!vtl); // Default if Auto Layer Management is passed in
328 dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
329 gtk_dialog_set_response_sensitive ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT, FALSE );
330 gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
334 status = gtk_label_new (_("Working..."));
335 gtk_box_pack_start ( GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dialog))), status, FALSE, FALSE, 5 );
336 gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
337 // May not want to see the dialog at all
338 if ( source_interface->is_thread || source_interface->keep_dialog_open )
339 gtk_widget_show_all(dialog);
345 if ( source_interface->add_progress_widgets_func ) {
346 source_interface->add_progress_widgets_func ( dialog, user_data );
348 w->user_data = user_data;
350 if ( mode == VIK_DATASOURCE_ADDTOLAYER ) {
351 VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
352 if ( IS_VIK_TRW_LAYER(current_selected) ) {
353 wi->vtl = VIK_TRW_LAYER(current_selected);
354 wi->creating_new_layer = FALSE;
357 else if ( mode == VIK_DATASOURCE_CREATENEWLAYER ) {
358 wi->creating_new_layer = TRUE;
360 else if ( mode == VIK_DATASOURCE_MANUAL_LAYER_MANAGEMENT ) {
361 // Don't create in acquire - as datasource will perform the necessary actions
362 wi->creating_new_layer = FALSE;
363 VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
364 if ( IS_VIK_TRW_LAYER(current_selected) )
365 wi->vtl = VIK_TRW_LAYER(current_selected);
367 if ( wi->creating_new_layer ) {
368 wi->vtl = VIK_TRW_LAYER ( vik_layer_create ( VIK_LAYER_TRW, w->vvp, FALSE ) );
369 vik_layer_rename ( VIK_LAYER ( wi->vtl ), _(source_interface->layer_title) );
372 if ( source_interface->is_thread ) {
374 #if GLIB_CHECK_VERSION (2, 32, 0)
375 g_thread_try_new ( "get_from_anything", (GThreadFunc)get_from_anything, wi, NULL );
377 g_thread_create ( (GThreadFunc)get_from_anything, wi, FALSE, NULL );
379 gtk_dialog_run ( GTK_DIALOG(dialog) );
381 // Cancel and mark for thread to finish
383 // NB Thread will free memory
387 a_babel_convert_from (NULL, cmd_off, extra_off, NULL, NULL, NULL);
391 g_free ( extra_off );
393 // Thread finished by normal completion - free memory
399 // This shouldn't happen...
400 gtk_label_set_text ( GTK_LABEL(w->status), _("Unable to create command\nAcquire method failed.") );
401 gtk_dialog_run (GTK_DIALOG (dialog));
405 // bypass thread method malarkly - you'll just have to wait...
406 if ( source_interface->process_func ) {
407 gboolean result = source_interface->process_func ( wi->vtl, cmd, extra, (BabelStatusFunc) progress_func, w, options );
409 a_dialog_msg ( GTK_WINDOW(vw), GTK_MESSAGE_ERROR, _("Error: acquisition failed."), NULL );
415 on_complete_process ( wi );
416 // Actually show it if necessary
417 if ( wi->w->source_interface->keep_dialog_open )
418 gtk_dialog_run ( GTK_DIALOG(dialog) );
424 gtk_widget_destroy ( dialog );
426 if ( cleanup_function )
427 cleanup_function ( source_interface );
432 * @vw: The #VikWindow to work with
433 * @vlp: The #VikLayersPanel in which a #VikTrwLayer layer may be created/appended
434 * @vvp: The #VikViewport defining the current view
435 * @mode: How layers should be managed
436 * @source_interface: The #VikDataSourceInterface determining how and what actions to take
437 * @userdata: External data to be passed into the #VikDataSourceInterface
438 * @cleanup_function: The function to dispose the #VikDataSourceInterface if necessary
440 * Process the given VikDataSourceInterface for sources with no input data.
442 void a_acquire ( VikWindow *vw,
445 vik_datasource_mode_t mode,
446 VikDataSourceInterface *source_interface,
448 VikDataSourceCleanupFunc cleanup_function )
450 acquire ( vw, vlp, vvp, mode, source_interface, NULL, NULL, userdata, cleanup_function );
453 static void acquire_trwlayer_callback ( GObject *menuitem, gpointer *pass_along )
455 VikDataSourceInterface *iface = g_object_get_data ( menuitem, "vik_acq_iface" );
456 VikWindow *vw = pass_along[0];
457 VikLayersPanel *vlp = pass_along[1];
458 VikViewport *vvp = pass_along[2];
459 VikTrwLayer *vtl = pass_along[3];
460 VikTrack *tr = pass_along[4];
462 acquire ( vw, vlp, vvp, iface->mode, iface, vtl, tr, NULL, NULL );
465 static GtkWidget *acquire_build_menu ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp,
466 VikTrwLayer *vtl, VikTrack *track, /* both passed to acquire, although for many filters only one ness */
467 const gchar *menu_title, vik_datasource_inputtype_t inputtype )
469 static gpointer pass_along[5];
470 GtkWidget *menu_item=NULL, *menu=NULL;
471 GtkWidget *item=NULL;
478 pass_along[4] = track;
480 for ( i = 0; i < N_FILTERS; i++ ) {
481 if ( filters[i]->inputtype == inputtype ) {
482 if ( ! menu_item ) { /* do this just once, but return NULL if no filters */
483 menu = gtk_menu_new();
484 menu_item = gtk_menu_item_new_with_mnemonic ( menu_title );
485 gtk_menu_item_set_submenu (GTK_MENU_ITEM (menu_item), menu );
488 item = gtk_menu_item_new_with_label ( filters[i]->window_title );
489 g_object_set_data ( G_OBJECT(item), "vik_acq_iface", (gpointer) filters[i] );
490 g_signal_connect ( G_OBJECT(item), "activate", G_CALLBACK(acquire_trwlayer_callback), pass_along );
491 gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
492 gtk_widget_show ( item );
500 * a_acquire_trwlayer_menu:
502 * Create a sub menu intended for rightclicking on a TRWLayer's menu called "Filter".
504 * Returns: %NULL if no filters.
506 GtkWidget *a_acquire_trwlayer_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
508 return acquire_build_menu ( vw, vlp, vvp, vtl, NULL, _("_Filter"), VIK_DATASOURCE_INPUTTYPE_TRWLAYER );
512 * a_acquire_trwlayer_track_menu:
514 * Create a sub menu intended for rightclicking on a TRWLayer's menu called "Filter with Track "TRACKNAME"...".
516 * Returns: %NULL if no filters or no filter track has been set.
518 GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
520 if ( filter_track == NULL )
523 gchar *menu_title = g_strdup_printf ( _("Filter with %s"), filter_track->name );
524 GtkWidget *rv = acquire_build_menu ( vw, vlp, vvp, vtl, filter_track,
525 menu_title, VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK );
526 g_free ( menu_title );
532 * a_acquire_track_menu:
534 * Create a sub menu intended for rightclicking on a track's menu called "Filter".
536 * Returns: %NULL if no applicable filters
538 GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr)
540 return acquire_build_menu ( vw, vlp, vvp, NULL, tr, _("Filter"), VIK_DATASOURCE_INPUTTYPE_TRACK );
544 * a_acquire_set_filter_track:
546 * Sets application-wide track to use with filter. references the track.
548 void a_acquire_set_filter_track ( VikTrack *tr )
551 vik_track_free ( filter_track );
554 vik_track_ref ( tr );