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));
112 gtk_label_set_text ( GTK_LABEL(wi->w->status), _("No data.") );
114 /* View this data if available and is desired */
115 if ( wi->vtl && wi->w->source_interface->autoview ) {
116 vik_trw_layer_auto_set_view ( wi->vtl, vik_layers_panel_get_viewport(wi->w->vlp) );
118 if ( wi->w->source_interface->keep_dialog_open ) {
119 gtk_dialog_set_response_sensitive ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_ACCEPT, TRUE );
120 gtk_dialog_set_response_sensitive ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_REJECT, FALSE );
122 gtk_dialog_response ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_ACCEPT );
124 // Main display update
126 vik_layer_post_read ( VIK_LAYER(wi->vtl), wi->w->vvp, TRUE );
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 )
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;
230 gpointer pass_along_data;
231 VikLayerParamData *paramdatas = NULL;
233 w_and_interface_t *wi;
235 /*** INIT AND CHECK EXISTENCE ***/
236 if ( source_interface->init_func )
237 user_data = source_interface->init_func();
240 pass_along_data = user_data;
242 if ( source_interface->check_existence_func ) {
243 gchar *error_str = source_interface->check_existence_func();
245 a_dialog_error_msg ( GTK_WINDOW(vw), error_str );
246 g_free ( error_str );
251 /* BUILD UI & GET OPTIONS IF NECESSARY. */
253 /* POSSIBILITY 0: NO OPTIONS. DO NOTHING HERE. */
254 /* POSSIBILITY 1: ADD_SETUP_WIDGETS_FUNC */
255 if ( source_interface->add_setup_widgets_func ) {
256 dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
258 gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
259 GtkWidget *response_w = NULL;
260 #if GTK_CHECK_VERSION (2, 20, 0)
261 response_w = gtk_dialog_get_widget_for_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
264 source_interface->add_setup_widgets_func(dialog, vvp, user_data);
265 gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
268 gtk_widget_grab_focus ( response_w );
270 if ( gtk_dialog_run ( GTK_DIALOG(dialog) ) != GTK_RESPONSE_ACCEPT ) {
271 source_interface->cleanup_func(user_data);
272 gtk_widget_destroy(dialog);
276 /* POSSIBILITY 2: UI BUILDER */
277 else if ( source_interface->params ) {
278 paramdatas = a_uibuilder_run_dialog ( source_interface->window_title, GTK_WINDOW(vw),
279 source_interface->params, source_interface->params_count,
280 source_interface->params_groups, source_interface->params_groups_count,
281 source_interface->params_defaults );
283 pass_along_data = paramdatas;
285 return; /* TODO: do we have to free anything here? */
288 /* CREATE INPUT DATA & GET COMMAND STRING */
290 if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER ) {
291 gchar *name_src = write_tmp_trwlayer ( vtl );
293 ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
294 ( pass_along_data, &cmd, &extra, name_src );
297 /* TODO: delete the tmp file? or delete it only after we're done with it? */
298 } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK ) {
299 gchar *name_src = write_tmp_trwlayer ( vtl );
300 gchar *name_src_track = write_tmp_track ( track );
302 ((VikDataSourceGetCmdStringFuncWithInputInput) source_interface->get_cmd_string_func)
303 ( pass_along_data, &cmd, &extra, name_src, name_src_track );
306 g_free ( name_src_track );
307 } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRACK ) {
308 gchar *name_src_track = write_tmp_track ( track );
310 ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
311 ( pass_along_data, &cmd, &extra, name_src_track );
313 g_free ( name_src_track );
314 } else if ( source_interface->get_cmd_string_func )
315 source_interface->get_cmd_string_func ( pass_along_data, &cmd, &extra, &options );
317 /* Get data for Off command */
318 if ( source_interface->off_func ) {
319 source_interface->off_func ( pass_along_data, &cmd_off, &extra_off );
322 /* cleanup for option dialogs */
323 if ( source_interface->add_setup_widgets_func ) {
324 gtk_widget_destroy(dialog);
326 } else if ( source_interface->params ) {
327 a_uibuilder_free_paramdatas ( paramdatas, source_interface->params, source_interface->params_count );
330 w = g_malloc(sizeof(*w));
331 wi = g_malloc(sizeof(*wi));
333 wi->w->source_interface = source_interface;
335 wi->extra = extra; /* usually input data type (?) */
336 wi->options = options;
338 wi->creating_new_layer = (!vtl);
340 dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
341 gtk_dialog_set_response_sensitive ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT, FALSE );
342 gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
346 status = gtk_label_new (_("Working..."));
347 gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), status, FALSE, FALSE, 5 );
348 gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
349 // May not want to see the dialog at all
350 if ( source_interface->is_thread || source_interface->keep_dialog_open )
351 gtk_widget_show_all(dialog);
357 if ( source_interface->add_progress_widgets_func ) {
358 source_interface->add_progress_widgets_func ( dialog, user_data );
360 w->user_data = user_data;
362 if (source_interface->mode == VIK_DATASOURCE_ADDTOLAYER) {
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);
366 wi->creating_new_layer = FALSE;
369 else if ( source_interface->mode == VIK_DATASOURCE_MANUAL_LAYER_MANAGEMENT ) {
370 // Don't create in acquire - as datasource will perform the necessary actions
371 wi->creating_new_layer = FALSE;
372 VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
373 if ( IS_VIK_TRW_LAYER(current_selected) )
374 wi->vtl = VIK_TRW_LAYER(current_selected);
376 if ( wi->creating_new_layer ) {
377 wi->vtl = VIK_TRW_LAYER ( vik_layer_create ( VIK_LAYER_TRW, w->vvp, NULL, FALSE ) );
378 vik_layer_rename ( VIK_LAYER ( wi->vtl ), _(source_interface->layer_title) );
381 if ( source_interface->is_thread ) {
383 g_thread_create((GThreadFunc)get_from_anything, wi, FALSE, NULL );
384 gtk_dialog_run ( GTK_DIALOG(dialog) );
386 // Cancel and mark for thread to finish
388 // NB Thread will free memory
392 a_babel_convert_from (NULL, cmd_off, extra_off, NULL, NULL, NULL);
396 g_free ( extra_off );
398 // Thread finished by normal completion - free memory
404 // This shouldn't happen...
405 gtk_label_set_text ( GTK_LABEL(w->status), _("Unable to create command\nAcquire method failed.") );
406 gtk_dialog_run (GTK_DIALOG (dialog));
410 // bypass thread method malarkly - you'll just have to wait...
411 if ( source_interface->process_func ) {
412 gboolean result = source_interface->process_func ( wi->vtl, cmd, extra, (BabelStatusFunc) progress_func, w, options );
414 a_dialog_msg ( GTK_WINDOW(vw), GTK_MESSAGE_ERROR, _("Error: acquisition failed."), NULL );
420 on_complete_process ( wi );
421 // Actually show it if necessary
422 if ( wi->w->source_interface->keep_dialog_open )
423 gtk_dialog_run ( GTK_DIALOG(dialog) );
429 gtk_widget_destroy ( dialog );
435 * Process the given VikDataSourceInterface for sources with no input data.
437 void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface ) {
438 acquire ( vw, vlp, vvp, source_interface, NULL, NULL );
441 static void acquire_trwlayer_callback ( GObject *menuitem, gpointer *pass_along )
443 VikDataSourceInterface *iface = g_object_get_data ( menuitem, "vik_acq_iface" );
444 VikWindow *vw = pass_along[0];
445 VikLayersPanel *vlp = pass_along[1];
446 VikViewport *vvp = pass_along[2];
447 VikTrwLayer *vtl = pass_along[3];
448 VikTrack *tr = pass_along[4];
450 acquire ( vw, vlp, vvp, iface, vtl, tr );
453 static GtkWidget *acquire_build_menu ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp,
454 VikTrwLayer *vtl, VikTrack *track, /* both passed to acquire, although for many filters only one ness */
455 const gchar *menu_title, vik_datasource_inputtype_t inputtype )
457 static gpointer pass_along[5];
458 GtkWidget *menu_item=NULL, *menu=NULL;
459 GtkWidget *item=NULL;
466 pass_along[4] = track;
468 for ( i = 0; i < N_FILTERS; i++ ) {
469 if ( filters[i]->inputtype == inputtype ) {
470 if ( ! menu_item ) { /* do this just once, but return NULL if no filters */
471 menu = gtk_menu_new();
472 menu_item = gtk_menu_item_new_with_mnemonic ( menu_title );
473 gtk_menu_item_set_submenu (GTK_MENU_ITEM (menu_item), menu );
476 item = gtk_menu_item_new_with_label ( filters[i]->window_title );
477 g_object_set_data ( G_OBJECT(item), "vik_acq_iface", (gpointer) filters[i] );
478 g_signal_connect ( G_OBJECT(item), "activate", G_CALLBACK(acquire_trwlayer_callback), pass_along );
479 gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
480 gtk_widget_show ( item );
488 * a_acquire_trwlayer_menu:
490 * Create a sub menu intended for rightclicking on a TRWLayer's menu called "Filter".
492 * Returns: %NULL if no filters.
494 GtkWidget *a_acquire_trwlayer_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
496 return acquire_build_menu ( vw, vlp, vvp, vtl, NULL, _("_Filter"), VIK_DATASOURCE_INPUTTYPE_TRWLAYER );
500 * a_acquire_trwlayer_track_menu:
502 * Create a sub menu intended for rightclicking on a TRWLayer's menu called "Filter with Track "TRACKNAME"...".
504 * Returns: %NULL if no filters or no filter track has been set.
506 GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
508 if ( filter_track == NULL )
511 gchar *menu_title = g_strdup_printf ( _("Filter with %s"), filter_track->name );
512 GtkWidget *rv = acquire_build_menu ( vw, vlp, vvp, vtl, filter_track,
513 menu_title, VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK );
514 g_free ( menu_title );
520 * a_acquire_track_menu:
522 * Create a sub menu intended for rightclicking on a track's menu called "Filter".
524 * Returns: %NULL if no applicable filters
526 GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr)
528 return acquire_build_menu ( vw, vlp, vvp, NULL, tr, _("Filter"), VIK_DATASOURCE_INPUTTYPE_TRACK );
532 * a_acquire_set_filter_track:
534 * Sets application-wide track to use with filter. references the track.
536 void a_acquire_set_filter_track ( VikTrack *tr )
539 vik_track_free ( filter_track );
542 vik_track_ref ( tr );