]> git.street.me.uk Git - andy/viking.git/blobdiff - src/datasource_gps.c
[QA] Make a local function static.
[andy/viking.git] / src / datasource_gps.c
index 95fcc3716e970ca29a9af85c40c2c98b44ad88d0..8e2fe9ed3f4f3d089d25652b47c17b1e83ac4ea7 100644 (file)
@@ -2,6 +2,8 @@
  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
  *
  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
+ * Copyright (C) 2006, Alex Foobarian <foobarian@gmail.com>
+ * Copyright (C) 2012, 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
 #include <glib/gprintf.h>
 #include <glib/gi18n.h>
 
+#include "datasource_gps.h"
 #include "viking.h"
 #include "babel.h"
 #include "gpx.h"
 #include "acquire.h"
 
-#if GTK_CHECK_VERSION(2,6,0)
-#define USE_NEW_COMBO_BOX
-#endif
-
 static gboolean gps_acquire_in_progress = FALSE;
 
+static gint last_active = -1;
+static gboolean last_get_tracks = TRUE;
+static gboolean last_get_waypoints = TRUE;
+
 static gpointer datasource_gps_init_func ( );
 static void datasource_gps_get_cmd_string ( gpointer add_widgets_data_not_used, gchar **babelargs, gchar **input_file );
 static void datasource_gps_cleanup ( gpointer user_data );
@@ -56,10 +59,12 @@ VikDataSourceInterface vik_datasource_gps_interface = {
   VIK_DATASOURCE_CREATENEWLAYER,
   VIK_DATASOURCE_INPUTTYPE_NONE,
   TRUE,
+  TRUE,
   (VikDataSourceInitFunc)              datasource_gps_init_func,
   (VikDataSourceCheckExistenceFunc)    NULL,
   (VikDataSourceAddSetupWidgetsFunc)   datasource_gps_add_setup_widgets,
   (VikDataSourceGetCmdStringFunc)      datasource_gps_get_cmd_string,
+  (VikDataSourceProcessFunc)           NULL,
   (VikDataSourceProgressFunc)          datasource_gps_progress,
   (VikDataSourceAddProgressWidgetsFunc)        datasource_gps_add_progress_widgets,
   (VikDataSourceCleanupFunc)           datasource_gps_cleanup,
@@ -81,6 +86,10 @@ typedef struct {
   GtkComboBox *ser_b;
   GtkWidget *off_request_l;
   GtkCheckButton *off_request_b;
+  GtkWidget *get_tracks_l;
+  GtkCheckButton *get_tracks_b;
+  GtkWidget *get_waypoints_l;
+  GtkCheckButton *get_waypoints_b;
 
   /* progress dialog */
   GtkWidget *gps_label;
@@ -100,15 +109,64 @@ static gpointer datasource_gps_init_func ()
   return g_malloc (sizeof(gps_user_data_t));
 }
 
+/**
+ * datasource_gps_get_protocol:
+ *
+ * Method to get the communication protocol of the GPS device from the widget structure
+ */
+gchar* datasource_gps_get_protocol ( gpointer user_data )
+{
+  // Uses the list of supported devices
+  gps_user_data_t *w = (gps_user_data_t *)user_data;
+  last_active = gtk_combo_box_get_active(GTK_COMBO_BOX(w->proto_b));
+  if (a_babel_device_list)
+    return ((BabelDevice*)g_list_nth_data(a_babel_device_list, last_active))->name;
+
+  return NULL;
+}
+
+/**
+ * datasource_gps_get_descriptor:
+ *
+ * Method to get the descriptor from the widget structure
+ * "Everything is a file"
+ * Could actually be normal file or a serial port
+ */
+gchar* datasource_gps_get_descriptor ( gpointer user_data )
+{
+  gps_user_data_t *w = (gps_user_data_t *)user_data;
+  return gtk_combo_box_get_active_text(GTK_COMBO_BOX(w->ser_b));
+}
+
+/**
+ * datasource_gps_get_do_tracks:
+ *
+ * Method to get the track handling behaviour from the widget structure
+ */
+gboolean datasource_gps_get_do_tracks ( gpointer user_data )
+{
+  gps_user_data_t *w = (gps_user_data_t *)user_data;
+  last_get_tracks = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(w->get_tracks_b));
+  return last_get_tracks;
+}
+
+/**
+ * datasource_gps_get_do_waypoints:
+ *
+ * Method to get the waypoint handling behaviour from the widget structure
+ */
+gboolean datasource_gps_get_do_waypoints ( gpointer user_data )
+{
+  gps_user_data_t *w = (gps_user_data_t *)user_data;
+  last_get_waypoints = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(w->get_waypoints_b));
+  return last_get_waypoints;
+}
+
 static void datasource_gps_get_cmd_string ( gpointer user_data, gchar **babelargs, gchar **input_file )
 {
-  char *proto = NULL;
-  char *ser = NULL;
   char *device = NULL;
-#ifndef USE_NEW_COMBO_BOX
-  GtkTreeIter iter;
-#endif
-  gps_user_data_t *w = (gps_user_data_t *)user_data;
+  char *tracks = NULL;
+  char *waypoints = NULL;
 
   if (gps_acquire_in_progress) {
     *babelargs = *input_file = NULL;
@@ -116,41 +174,44 @@ static void datasource_gps_get_cmd_string ( gpointer user_data, gchar **babelarg
   
   gps_acquire_in_progress = TRUE;
 
-#ifdef USE_NEW_COMBO_BOX
-  proto = gtk_combo_box_get_active_text(GTK_COMBO_BOX(w->proto_b));
-#else
-  proto = gtk_combo_box_get_active_iter(GTK_COMBO_BOX(w->proto_b),&iter);
-#endif
-  if (!strcmp(proto, "Garmin")) {
-    device = "garmin";
-  } else {
-    device = "magellan";
-  }
+  device = datasource_gps_get_protocol ( user_data );
+
+  if ( datasource_gps_get_do_tracks ( user_data ) )
+    tracks = "-t";
+  else
+    tracks = "";
+
+  if ( datasource_gps_get_do_waypoints ( user_data ) )
+    waypoints = "-w";
+  else
+    waypoints = "";
 
-  *babelargs = g_strdup_printf("-D 9 -t -w -i %s", device);
+  *babelargs = g_strdup_printf("-D 9 %s %s -i %s", tracks, waypoints, device);
   /* device points to static content => no free */
   device = NULL;
-  
-  /* Old stuff */
-#ifdef USE_NEW_COMBO_BOX
-  ser = gtk_combo_box_get_active_text(GTK_COMBO_BOX(w->ser_b));
-#else
-  ser = gtk_combo_box_get_active_iter(GTK_COMBO_BOX(w->ser_b),&iter);
-#endif
-  *input_file = g_strdup(ser);
+  tracks = NULL;
+  waypoints = NULL;
+
+  *input_file = g_strdup(datasource_gps_get_descriptor(user_data));
 
   g_debug(_("using cmdline '%s' and file '%s'\n"), *babelargs, *input_file);
 }
 
+/**
+ * datasource_gps_get_off:
+ *
+ * Method to get the off behaviour from the widget structure
+ */
+gboolean datasource_gps_get_off ( gpointer user_data )
+{
+  gps_user_data_t *w = (gps_user_data_t *)user_data;
+  return gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(w->off_request_b));
+}
 
 static void datasource_gps_off ( gpointer user_data, gchar **babelargs, gchar **input_file )
 {
-  char *proto = NULL;
   char *ser = NULL;
   char *device = NULL;
-#ifndef USE_NEW_COMBO_BOX
-  GtkTreeIter iter;
-#endif
   gps_user_data_t *w = (gps_user_data_t *)user_data;
 
   if (gps_acquire_in_progress) {
@@ -158,18 +219,21 @@ static void datasource_gps_off ( gpointer user_data, gchar **babelargs, gchar **
   }
 
   /* See if we should turn off the device */
-  if (!gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(w->off_request_b))) {
+  if (!datasource_gps_get_off ( user_data )){
     return;
   }
   
-#ifdef USE_NEW_COMBO_BOX
-  proto = gtk_combo_box_get_active_text(GTK_COMBO_BOX(w->proto_b));
-#else
-  proto = gtk_combo_box_get_active_iter(GTK_COMBO_BOX(w->proto_b),&iter);
-#endif
-  if (!strcmp(proto, "Garmin")) {
+  if (!a_babel_device_list)
+    return;
+  last_active = gtk_combo_box_get_active(GTK_COMBO_BOX(w->proto_b));
+  device = ((BabelDevice*)g_list_nth_data(a_babel_device_list, last_active))->name;
+  if (!strcmp(device, "garmin")) {
     device = "garmin,power_off";
-  } else {
+  }
+  else if (!strcmp(device, "navilink")) {
+    device = "navilink,power_off";
+  }
+  else {
     return;
   }
 
@@ -177,12 +241,7 @@ static void datasource_gps_off ( gpointer user_data, gchar **babelargs, gchar **
   /* device points to static content => no free */
   device = NULL;
   
-  /* Old stuff */
-#ifdef USE_NEW_COMBO_BOX
   ser = gtk_combo_box_get_active_text(GTK_COMBO_BOX(w->ser_b));
-#else
-  ser = gtk_combo_box_get_active_iter(GTK_COMBO_BOX(w->ser_b),&iter);
-#endif
   *input_file = g_strdup(ser);
 }
 
@@ -193,6 +252,16 @@ static void datasource_gps_cleanup ( gpointer user_data )
   gps_acquire_in_progress = FALSE;
 }
 
+/**
+ * datasource_gps_clean_up:
+ *
+ * External method to tidy up
+ */
+void datasource_gps_clean_up ( gpointer user_data )
+{
+  datasource_gps_cleanup ( user_data );
+}
+
 static void set_total_count(gint cnt, acq_dialog_widgets_t *w)
 {
   gchar *s = NULL;
@@ -257,6 +326,12 @@ static void datasource_gps_progress ( BabelProgressCode c, gpointer data, acq_di
   case BABEL_DIAG_OUTPUT:
     line = (gchar *)data;
 
+    gdk_threads_enter();
+    if (w->ok) {
+      gtk_label_set_text ( GTK_LABEL(w->status), _("Status: Working...") );
+    }
+    gdk_threads_leave();
+
     /* tells us how many items there will be */
     if (strstr(line, "Xfer Wpt")) { 
       gps_data->progress_label = gps_data->wp_label;
@@ -320,16 +395,47 @@ static void datasource_gps_progress ( BabelProgressCode c, gpointer data, acq_di
   }
 }
 
-void datasource_gps_add_setup_widgets ( GtkWidget *dialog, VikViewport *vvp, gpointer user_data )
+void append_element (gpointer elem, gpointer user_data)
+{
+  GtkComboBox *combo = GTK_COMBO_BOX (user_data);
+  const gchar *text = ((BabelDevice*)elem)->label;
+  gtk_combo_box_append_text (combo, text);
+}
+
+static gint find_entry = -1;
+static gint garmin_entry = -1;
+
+static void find_garmin (gpointer elem, gpointer user_data)
+{
+  const gchar *name = ((BabelDevice*)elem)->name;
+  find_entry++;
+  if (!strcmp(name, "garmin")) {
+    garmin_entry = find_entry;
+  }
+}
+
+static void datasource_gps_add_setup_widgets ( GtkWidget *dialog, VikViewport *vvp, gpointer user_data )
 {
   gps_user_data_t *w = (gps_user_data_t *)user_data;
-  GtkTable*  box;
+  GtkTable *box, *data_type_box;
 
   w->proto_l = gtk_label_new (_("GPS Protocol:"));
   w->proto_b = GTK_COMBO_BOX(gtk_combo_box_new_text ());
-  gtk_combo_box_append_text (w->proto_b, "Garmin");
-  gtk_combo_box_append_text (w->proto_b, "Magellan");
-  gtk_combo_box_set_active (w->proto_b, 0);
+  g_list_foreach (a_babel_device_list, append_element, w->proto_b);
+
+  // Maintain default to Garmin devices (assumed most popular/numerous device)
+  if ( last_active < 0 ) {
+    find_entry = -1;
+    g_list_foreach (a_babel_device_list, find_garmin, NULL);
+    if ( garmin_entry < 0 )
+      // Not found - so set it to the first entry
+      last_active = 0;
+    else
+      // Found
+      last_active = garmin_entry;
+  }
+
+  gtk_combo_box_set_active (w->proto_b, last_active);
   g_object_ref(w->proto_b);
 
   w->ser_l = gtk_label_new (_("Serial Port:"));
@@ -353,21 +459,61 @@ void datasource_gps_add_setup_widgets ( GtkWidget *dialog, VikViewport *vvp, gpo
   gtk_combo_box_set_active (w->ser_b, 0);
   g_object_ref(w->ser_b);
 
-  w->off_request_l = gtk_label_new (_("Turn Off After Transfer\n(Garmin Only)"));
+  w->off_request_l = gtk_label_new (_("Turn Off After Transfer\n(Garmin/NAViLink Only)"));
   w->off_request_b = GTK_CHECK_BUTTON ( gtk_check_button_new () );
 
-  box = GTK_TABLE(gtk_table_new(2, 3, FALSE));
+  w->get_tracks_l = gtk_label_new (_("Tracks:"));
+  w->get_tracks_b = GTK_CHECK_BUTTON ( gtk_check_button_new () );
+  gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(w->get_tracks_b), last_get_tracks);
+
+  w->get_waypoints_l = gtk_label_new (_("Waypoints:"));
+  w->get_waypoints_b = GTK_CHECK_BUTTON ( gtk_check_button_new () );
+  gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(w->get_waypoints_b), last_get_waypoints);
+
+  box = GTK_TABLE(gtk_table_new(2, 4, FALSE));
+  data_type_box = GTK_TABLE(gtk_table_new(4, 1, FALSE));
+
   gtk_table_attach_defaults(box, GTK_WIDGET(w->proto_l), 0, 1, 0, 1);
   gtk_table_attach_defaults(box, GTK_WIDGET(w->proto_b), 1, 2, 0, 1);
   gtk_table_attach_defaults(box, GTK_WIDGET(w->ser_l), 0, 1, 1, 2);
   gtk_table_attach_defaults(box, GTK_WIDGET(w->ser_b), 1, 2, 1, 2);
-  gtk_table_attach_defaults(box, GTK_WIDGET(w->off_request_l), 0, 1, 2, 3);
-  gtk_table_attach_defaults(box, GTK_WIDGET(w->off_request_b), 1, 3, 2, 3);
+  gtk_table_attach_defaults(data_type_box, GTK_WIDGET(w->get_tracks_l), 0, 1, 0, 1);
+  gtk_table_attach_defaults(data_type_box, GTK_WIDGET(w->get_tracks_b), 1, 2, 0, 1);
+  gtk_table_attach_defaults(data_type_box, GTK_WIDGET(w->get_waypoints_l), 2, 3, 0, 1);
+  gtk_table_attach_defaults(data_type_box, GTK_WIDGET(w->get_waypoints_b), 3, 4, 0, 1);
+  gtk_table_attach_defaults(box, GTK_WIDGET(data_type_box), 0, 2, 2, 3);
+  gtk_table_attach_defaults(box, GTK_WIDGET(w->off_request_l), 0, 1, 3, 4);
+  gtk_table_attach_defaults(box, GTK_WIDGET(w->off_request_b), 1, 3, 3, 4);
   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), GTK_WIDGET(box), FALSE, FALSE, 5 );
 
   gtk_widget_show_all ( dialog );
 }
 
+/**
+ * datasource_gps_setup:
+ * @dialog: The GTK dialog. The caller is responsible for managing the dialog creation/deletion
+ * @only_tracks: When only tracks are specified, waypoints will be disabled.
+ *
+ * Returns: A gpointer to the private structure for GPS progress/information widgets
+ *          Pass this pointer back into the other exposed datasource_gps_X functions
+ */
+gpointer datasource_gps_setup ( GtkWidget *dialog, gboolean only_tracks )
+{
+  gps_user_data_t *w_gps = (gps_user_data_t *)datasource_gps_init_func();
+  datasource_gps_add_setup_widgets ( dialog, NULL, w_gps );
+
+  if ( only_tracks ) {
+    // Indicate tracks enabled (although no option to turn off):
+    gtk_toggle_button_set_active ( GTK_TOGGLE_BUTTON(w_gps->get_tracks_b), TRUE);
+    gtk_widget_set_sensitive ( GTK_WIDGET(w_gps->get_tracks_b), FALSE );
+    // Disable waypoints
+    gtk_toggle_button_set_active ( GTK_TOGGLE_BUTTON(w_gps->get_waypoints_b), FALSE);
+    gtk_widget_set_sensitive ( GTK_WIDGET(w_gps->get_waypoints_l), FALSE );
+    gtk_widget_set_sensitive ( GTK_WIDGET(w_gps->get_waypoints_b), FALSE );
+  }
+  return (gpointer)w_gps;
+}
+
 void datasource_gps_add_progress_widgets ( GtkWidget *dialog, gpointer user_data )
 {
   GtkWidget *gpslabel, *verlabel, *idlabel, *wplabel, *trklabel;