* viking -- GPS Data and Topo Analyzer, Explorer, and Manager
*
* Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
+ * Copyright (C) 2013-2015, Rob Norris <rw_norris@hotmail.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
/*** Input is TRWLayer ***/
extern VikDataSourceInterface vik_datasource_bfilter_simplify_interface;
+extern VikDataSourceInterface vik_datasource_bfilter_compress_interface;
extern VikDataSourceInterface vik_datasource_bfilter_dup_interface;
+extern VikDataSourceInterface vik_datasource_bfilter_manual_interface;
/*** Input is a track and a TRWLayer ***/
extern VikDataSourceInterface vik_datasource_bfilter_polygon_interface;
const VikDataSourceInterface *filters[] = {
&vik_datasource_bfilter_simplify_interface,
+ &vik_datasource_bfilter_compress_interface,
&vik_datasource_bfilter_dup_interface,
+ &vik_datasource_bfilter_manual_interface,
&vik_datasource_bfilter_polygon_interface,
&vik_datasource_bfilter_exclude_polygon_interface,
};
/* passed along to worker thread */
typedef struct {
acq_dialog_widgets_t *w;
- gchar *cmd;
- gchar *extra;
+ ProcessOptions *po;
+ gboolean creating_new_layer;
+ VikTrwLayer *vtl;
+ DownloadFileOptions *options;
} w_and_interface_t;
static void progress_func ( BabelProgressCode c, gpointer data, acq_dialog_widgets_t *w )
{
- gdk_threads_enter ();
- if (!w->ok) {
- if ( w->source_interface->cleanup_func )
- w->source_interface->cleanup_func( w->user_data );
- g_free ( w );
- gdk_threads_leave();
- g_thread_exit ( NULL );
+ if ( w->source_interface->is_thread ) {
+ gdk_threads_enter ();
+ if ( !w->running ) {
+ if ( w->source_interface->cleanup_func )
+ w->source_interface->cleanup_func ( w->user_data );
+ gdk_threads_leave ();
+ g_thread_exit ( NULL );
+ }
+ gdk_threads_leave ();
}
- gdk_threads_leave ();
if ( w->source_interface->progress_func )
w->source_interface->progress_func ( c, data, w );
}
+/**
+ * Some common things to do on completion of a datasource process
+ * . Update layer
+ * . Update dialog info
+ * . Update main dsisplay
+ */
+static void on_complete_process (w_and_interface_t *wi)
+{
+ if (wi->w->running) {
+ gtk_label_set_text ( GTK_LABEL(wi->w->status), _("Done.") );
+ if ( wi->creating_new_layer ) {
+ /* Only create the layer if it actually contains anything useful */
+ // TODO: create function for this operation to hide detail:
+ if ( ! vik_trw_layer_is_empty ( wi->vtl ) ) {
+ vik_layer_post_read ( VIK_LAYER(wi->vtl), wi->w->vvp, TRUE );
+ vik_aggregate_layer_add_layer ( vik_layers_panel_get_top_layer(wi->w->vlp), VIK_LAYER(wi->vtl), TRUE );
+ }
+ else
+ gtk_label_set_text ( GTK_LABEL(wi->w->status), _("No data.") );
+ }
+ if ( wi->w->source_interface->keep_dialog_open ) {
+ gtk_dialog_set_response_sensitive ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_ACCEPT, TRUE );
+ gtk_dialog_set_response_sensitive ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_REJECT, FALSE );
+ } else {
+ gtk_dialog_response ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_ACCEPT );
+ }
+ // Main display update
+ if ( wi->vtl ) {
+ vik_layer_post_read ( VIK_LAYER(wi->vtl), wi->w->vvp, TRUE );
+ // View this data if desired - must be done after post read (so that the bounds are known)
+ if ( wi->w->source_interface->autoview ) {
+ vik_trw_layer_auto_set_view ( wi->vtl, vik_layers_panel_get_viewport(wi->w->vlp) );
+ }
+ vik_layers_panel_emit_update ( wi->w->vlp );
+ }
+ } else {
+ /* cancelled */
+ if ( wi->creating_new_layer )
+ g_object_unref(wi->vtl);
+ }
+}
+
+static void free_process_options ( ProcessOptions *po )
+{
+ if ( po ) {
+ g_free ( po->babelargs );
+ g_free ( po->filename );
+ g_free ( po->input_file_type );
+ g_free ( po->babel_filters );
+ g_free ( po->url );
+ g_free ( po->shell_command );
+ g_free ( po );
+ }
+}
/* this routine is the worker thread. there is only one simultaneous download allowed */
static void get_from_anything ( w_and_interface_t *wi )
{
- gchar *cmd = wi->cmd;
- gchar *extra = wi->extra;
gboolean result = TRUE;
- VikTrwLayer *vtl = NULL;
- gboolean creating_new_layer = TRUE;
-
- acq_dialog_widgets_t *w = wi->w;
VikDataSourceInterface *source_interface = wi->w->source_interface;
- g_free ( wi );
- wi = NULL;
- gdk_threads_enter();
- if (source_interface->mode == VIK_DATASOURCE_ADDTOLAYER) {
- VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
- if ( IS_VIK_TRW_LAYER(current_selected) ) {
- vtl = VIK_TRW_LAYER(current_selected);
- creating_new_layer = FALSE;
- }
- }
- if ( creating_new_layer ) {
- vtl = VIK_TRW_LAYER ( vik_layer_create ( VIK_LAYER_TRW, w->vvp, NULL, FALSE ) );
- vik_layer_rename ( VIK_LAYER ( vtl ), _(source_interface->layer_title) );
- gtk_label_set_text ( GTK_LABEL(w->status), _("Working...") );
+ if ( source_interface->process_func ) {
+ result = source_interface->process_func ( wi->vtl, wi->po, (BabelStatusFunc)progress_func, wi->w, wi->options );
}
- gdk_threads_leave();
-
- // TODO consider removing 'type' and make everything run via the specficied process function
- switch ( source_interface->type ) {
- case VIK_DATASOURCE_GPSBABEL_DIRECT:
- result = a_babel_convert_from (vtl, cmd, extra, (BabelStatusFunc) progress_func, w);
- break;
- case VIK_DATASOURCE_URL:
- result = a_babel_convert_from_url (vtl, cmd, extra, (BabelStatusFunc) progress_func, w);
- break;
- case VIK_DATASOURCE_SHELL_CMD:
- result = a_babel_convert_from_shellcommand ( vtl, cmd, extra, (BabelStatusFunc) progress_func, w);
- break;
- case VIK_DATASOURCE_INTERNAL:
- if ( source_interface->process_func )
- result = source_interface->process_func ( vtl, cmd, extra, (BabelStatusFunc) progress_func, w );
- break;
- default:
- g_critical("Houston, we've had a problem.");
- }
-
- g_free ( cmd );
- g_free ( extra );
+ free_process_options ( wi->po );
+ g_free ( wi->options );
- if (!result) {
+ if (wi->w->running && !result) {
gdk_threads_enter();
- gtk_label_set_text ( GTK_LABEL(w->status), _("Error: acquisition failed.") );
- if ( creating_new_layer )
- g_object_unref ( G_OBJECT ( vtl ) );
+ gtk_label_set_text ( GTK_LABEL(wi->w->status), _("Error: acquisition failed.") );
+ if ( wi->creating_new_layer )
+ g_object_unref ( G_OBJECT ( wi->vtl ) );
gdk_threads_leave();
}
else {
gdk_threads_enter();
- if (w->ok) {
- gtk_label_set_text ( GTK_LABEL(w->status), _("Done.") );
- if ( creating_new_layer ) {
- /* Only create the layer if it actually contains anything useful */
- // TODO: create function for this operation to hide detail:
- if ( g_hash_table_size (vik_trw_layer_get_tracks(vtl)) ||
- g_hash_table_size (vik_trw_layer_get_waypoints(vtl)) ||
- g_hash_table_size (vik_trw_layer_get_routes(vtl)) ) {
- vik_layer_post_read ( VIK_LAYER(vtl), w->vvp, TRUE );
- vik_aggregate_layer_add_layer( vik_layers_panel_get_top_layer(w->vlp), VIK_LAYER(vtl));
- }
- else
- gtk_label_set_text ( GTK_LABEL(w->status), _("No data.") );
- }
- /* View this data if available and is desired */
- if ( vtl && source_interface->autoview ) {
- vik_trw_layer_auto_set_view ( vtl, vik_layers_panel_get_viewport(w->vlp) );
- vik_layers_panel_emit_update (w->vlp);
- }
- if ( source_interface->keep_dialog_open ) {
- gtk_dialog_set_response_sensitive ( GTK_DIALOG(w->dialog), GTK_RESPONSE_ACCEPT, TRUE );
- gtk_dialog_set_response_sensitive ( GTK_DIALOG(w->dialog), GTK_RESPONSE_REJECT, FALSE );
- } else {
- gtk_dialog_response ( GTK_DIALOG(w->dialog), GTK_RESPONSE_ACCEPT );
- }
- } else {
- /* canceled */
- if ( creating_new_layer )
- g_object_unref(vtl);
- }
+ on_complete_process ( wi );
+ gdk_threads_leave();
}
+
if ( source_interface->cleanup_func )
- source_interface->cleanup_func ( w->user_data );
+ source_interface->cleanup_func ( wi->w->user_data );
- if ( w->ok ) {
- w->ok = FALSE;
- } else {
- g_free ( w );
+ if ( wi->w->running ) {
+ wi->w->running = FALSE;
+ }
+ else {
+ g_free ( wi->w );
+ g_free ( wi );
+ wi = NULL;
}
- gdk_threads_leave();
g_thread_exit ( NULL );
}
-
-static gchar *write_tmp_trwlayer ( VikTrwLayer *vtl )
-{
- int fd_src;
- gchar *name_src;
- FILE *f;
- g_assert ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0);
- g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
- f = fdopen(fd_src, "w");
- a_gpx_write_file(vtl, f, NULL);
- fclose(f);
- f = NULL;
- return name_src;
-}
-
-/* TODO: write with name of old track */
-static gchar *write_tmp_track ( VikTrack *track )
-{
- int fd_src;
- gchar *name_src;
- FILE *f;
- g_assert ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0);
- g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
- f = fdopen(fd_src, "w");
- a_gpx_write_track_file(track, f, NULL); /* Thank you Guilhem! Just when I needed this function... -- Evan */
- fclose(f);
- f = NULL;
- return name_src;
-}
-
-/* TODO: cleanup, getr rid of redundancy */
-
/* depending on type of filter, often only vtl or track will be given.
* the other can be NULL.
*/
-static void acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface,
- VikTrwLayer *vtl, VikTrack *track )
+static void acquire ( VikWindow *vw,
+ VikLayersPanel *vlp,
+ VikViewport *vvp,
+ vik_datasource_mode_t mode,
+ VikDataSourceInterface *source_interface,
+ VikTrwLayer *vtl,
+ VikTrack *track,
+ gpointer userdata,
+ VikDataSourceCleanupFunc cleanup_function )
{
/* for manual dialogs */
GtkWidget *dialog = NULL;
GtkWidget *status;
- gchar *cmd = NULL;
- gchar *extra = NULL;
- gchar *cmd_off = NULL;
- gchar *extra_off = NULL;
+ gchar *args_off = NULL;
+ gchar *fd_off = NULL;
acq_dialog_widgets_t *w;
gpointer user_data;
+ DownloadFileOptions *options = g_malloc0 ( sizeof(DownloadFileOptions) );
+
+ acq_vik_t avt;
+ avt.vlp = vlp;
+ avt.vvp = vvp;
+ avt.vw = vw;
+ avt.userdata = userdata;
/* for UI builder */
gpointer pass_along_data;
/*** INIT AND CHECK EXISTENCE ***/
if ( source_interface->init_func )
- user_data = source_interface->init_func();
+ user_data = source_interface->init_func(&avt);
else
user_data = NULL;
pass_along_data = user_data;
return; /* TODO: do we have to free anything here? */
}
- /* CREATE INPUT DATA & GET COMMAND STRING */
+ /* CREATE INPUT DATA & GET OPTIONS */
+ ProcessOptions *po = g_malloc0 ( sizeof(ProcessOptions) );
if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER ) {
- gchar *name_src = write_tmp_trwlayer ( vtl );
+ gchar *name_src = a_gpx_write_tmp_file ( vtl, NULL );
+
+ source_interface->get_process_options_func ( pass_along_data, po, NULL, name_src, NULL );
- ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
- ( pass_along_data, &cmd, &extra, name_src );
+ util_add_to_deletion_list ( name_src );
g_free ( name_src );
- /* TODO: delete the tmp file? or delete it only after we're done with it? */
} else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK ) {
- gchar *name_src = write_tmp_trwlayer ( vtl );
- gchar *name_src_track = write_tmp_track ( track );
+ gchar *name_src = a_gpx_write_tmp_file ( vtl, NULL );
+ gchar *name_src_track = a_gpx_write_track_tmp_file ( track, NULL );
+
+ source_interface->get_process_options_func ( pass_along_data, po, NULL, name_src, name_src_track );
- ((VikDataSourceGetCmdStringFuncWithInputInput) source_interface->get_cmd_string_func)
- ( pass_along_data, &cmd, &extra, name_src, name_src_track );
+ util_add_to_deletion_list ( name_src );
+ util_add_to_deletion_list ( name_src_track );
g_free ( name_src );
g_free ( name_src_track );
} else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRACK ) {
- gchar *name_src_track = write_tmp_track ( track );
+ gchar *name_src_track = a_gpx_write_track_tmp_file ( track, NULL );
- ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
- ( pass_along_data, &cmd, &extra, name_src_track );
+ source_interface->get_process_options_func ( pass_along_data, po, NULL, NULL, name_src_track );
g_free ( name_src_track );
- } else if ( source_interface->get_cmd_string_func )
- source_interface->get_cmd_string_func ( pass_along_data, &cmd, &extra );
+ } else if ( source_interface->get_process_options_func )
+ source_interface->get_process_options_func ( pass_along_data, po, options, NULL, NULL );
/* Get data for Off command */
if ( source_interface->off_func ) {
- source_interface->off_func ( pass_along_data, &cmd_off, &extra_off );
+ source_interface->off_func ( pass_along_data, &args_off, &fd_off );
}
/* cleanup for option dialogs */
a_uibuilder_free_paramdatas ( paramdatas, source_interface->params, source_interface->params_count );
}
- /*** LET'S DO IT! ***/
-
- if ( ! cmd )
- return;
-
w = g_malloc(sizeof(*w));
wi = g_malloc(sizeof(*wi));
wi->w = w;
wi->w->source_interface = source_interface;
- wi->cmd = cmd;
- wi->extra = extra; /* usually input data type (?) */
+ wi->po = po;
+ wi->options = options;
+ wi->vtl = vtl;
+ wi->creating_new_layer = (!vtl); // Default if Auto Layer Management is passed in
dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
gtk_dialog_set_response_sensitive ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT, FALSE );
gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
-
w->dialog = dialog;
- w->ok = TRUE;
- status = gtk_label_new (_("Status: detecting gpsbabel"));
- gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), status, FALSE, FALSE, 5 );
+ w->running = TRUE;
+ status = gtk_label_new (_("Working..."));
+ gtk_box_pack_start ( GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dialog))), status, FALSE, FALSE, 5 );
gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
- gtk_widget_show_all(status);
+ // May not want to see the dialog at all
+ if ( source_interface->is_thread || source_interface->keep_dialog_open )
+ gtk_widget_show_all(dialog);
w->status = status;
w->vw = vw;
}
w->user_data = user_data;
+ if ( mode == VIK_DATASOURCE_ADDTOLAYER ) {
+ VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
+ if ( IS_VIK_TRW_LAYER(current_selected) ) {
+ wi->vtl = VIK_TRW_LAYER(current_selected);
+ wi->creating_new_layer = FALSE;
+ }
+ }
+ else if ( mode == VIK_DATASOURCE_CREATENEWLAYER ) {
+ wi->creating_new_layer = TRUE;
+ }
+ else if ( mode == VIK_DATASOURCE_MANUAL_LAYER_MANAGEMENT ) {
+ // Don't create in acquire - as datasource will perform the necessary actions
+ wi->creating_new_layer = FALSE;
+ VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
+ if ( IS_VIK_TRW_LAYER(current_selected) )
+ wi->vtl = VIK_TRW_LAYER(current_selected);
+ }
+ if ( wi->creating_new_layer ) {
+ wi->vtl = VIK_TRW_LAYER ( vik_layer_create ( VIK_LAYER_TRW, w->vvp, FALSE ) );
+ vik_layer_rename ( VIK_LAYER ( wi->vtl ), _(source_interface->layer_title) );
+ }
- g_thread_create((GThreadFunc)get_from_anything, wi, FALSE, NULL );
-
- gtk_dialog_run ( GTK_DIALOG(dialog) );
- if ( w->ok )
- w->ok = FALSE; /* tell thread to stop. TODO: add mutex */
+ if ( source_interface->is_thread ) {
+ if ( po->babelargs || po->url || po->shell_command ) {
+#if GLIB_CHECK_VERSION (2, 32, 0)
+ g_thread_try_new ( "get_from_anything", (GThreadFunc)get_from_anything, wi, NULL );
+#else
+ g_thread_create ( (GThreadFunc)get_from_anything, wi, FALSE, NULL );
+#endif
+ gtk_dialog_run ( GTK_DIALOG(dialog) );
+ if (w->running) {
+ // Cancel and mark for thread to finish
+ w->running = FALSE;
+ // NB Thread will free memory
+ } else {
+ if ( args_off ) {
+ /* Turn off */
+ ProcessOptions off_po = { args_off, fd_off, NULL, NULL, NULL };
+ a_babel_convert_from (NULL, &off_po, NULL, NULL, NULL);
+ g_free ( args_off );
+ }
+ if ( fd_off )
+ g_free ( fd_off );
+
+ // Thread finished by normal completion - free memory
+ g_free ( w );
+ g_free ( wi );
+ }
+ }
+ else {
+ // This shouldn't happen...
+ gtk_label_set_text ( GTK_LABEL(w->status), _("Unable to create command\nAcquire method failed.") );
+ gtk_dialog_run (GTK_DIALOG (dialog));
+ }
+ }
else {
- if ( cmd_off ) {
- /* Turn off */
- a_babel_convert_from (NULL, cmd_off, extra_off, NULL, NULL);
+ // bypass thread method malarkly - you'll just have to wait...
+ if ( source_interface->process_func ) {
+ gboolean result = source_interface->process_func ( wi->vtl, po, (BabelStatusFunc) progress_func, w, options );
+ if ( !result )
+ a_dialog_msg ( GTK_WINDOW(vw), GTK_MESSAGE_ERROR, _("Error: acquisition failed."), NULL );
}
- g_free ( w ); /* thread has finished; free w */
+ free_process_options ( po );
+ g_free ( options );
+
+ on_complete_process ( wi );
+ // Actually show it if necessary
+ if ( wi->w->source_interface->keep_dialog_open )
+ gtk_dialog_run ( GTK_DIALOG(dialog) );
+
+ g_free ( w );
+ g_free ( wi );
}
+
gtk_widget_destroy ( dialog );
+
+ if ( cleanup_function )
+ cleanup_function ( source_interface );
}
/**
* a_acquire:
+ * @vw: The #VikWindow to work with
+ * @vlp: The #VikLayersPanel in which a #VikTrwLayer layer may be created/appended
+ * @vvp: The #VikViewport defining the current view
+ * @mode: How layers should be managed
+ * @source_interface: The #VikDataSourceInterface determining how and what actions to take
+ * @userdata: External data to be passed into the #VikDataSourceInterface
+ * @cleanup_function: The function to dispose the #VikDataSourceInterface if necessary
*
* Process the given VikDataSourceInterface for sources with no input data.
*/
-void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface ) {
- acquire ( vw, vlp, vvp, source_interface, NULL, NULL );
+void a_acquire ( VikWindow *vw,
+ VikLayersPanel *vlp,
+ VikViewport *vvp,
+ vik_datasource_mode_t mode,
+ VikDataSourceInterface *source_interface,
+ gpointer userdata,
+ VikDataSourceCleanupFunc cleanup_function )
+{
+ acquire ( vw, vlp, vvp, mode, source_interface, NULL, NULL, userdata, cleanup_function );
}
static void acquire_trwlayer_callback ( GObject *menuitem, gpointer *pass_along )
VikTrwLayer *vtl = pass_along[3];
VikTrack *tr = pass_along[4];
- acquire ( vw, vlp, vvp, iface, vtl, tr );
+ acquire ( vw, vlp, vvp, iface->mode, iface, vtl, tr, NULL, NULL );
}
static GtkWidget *acquire_build_menu ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp,