]> git.street.me.uk Git - andy/viking.git/blobdiff - src/vikutils.c
Retain DOP values when saving to .vik files
[andy/viking.git] / src / vikutils.c
index c4f088fcf5e3352d971f06d296294000ac22af64..ac5ec59057a174c920f3e3f316a6901b73ad8f4c 100644 (file)
@@ -35,7 +35,7 @@
 #include "preferences.h"
 #include "vikmapslayer.h"
 #include "settings.h"
-#include "util.h"
+#include "ui_util.h"
 #include "dir.h"
 #include "misc/kdtree.h"
 
  * @trkpt:        The trackpoint for which the message is generated about
  * @trkpt_prev:   A trackpoint (presumed previous) for interpolating values with the other trackpoint (such as speed)
  * @trk:          The track in which the trackpoints reside
+ * @climb:        Vertical speed (Out of band (i.e. not in a trackpoint) value for display currently only for GPSD usage)
  *
  *  TODO: One day replace this cryptic format code with some kind of tokenizer parsing
  *    thus would make it more user friendly and maybe even GUI controlable.
  * However for now at least there is some semblance of user control
  */
-gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkpt, VikTrackpoint *trkpt_prev, VikTrack *trk )
+gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkpt, VikTrackpoint *trkpt_prev, VikTrack *trk, gdouble climb )
 {
        if ( !trkpt )
                return NULL;
@@ -99,26 +100,10 @@ gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkp
                        gchar *speedtype = NULL;
                        if ( isnan(trkpt->speed) && trkpt_prev ) {
                                if ( trkpt->has_timestamp && trkpt_prev->has_timestamp ) {
-                                       if ( trkpt->timestamp == trkpt_prev->timestamp ) {
+                                       if ( trkpt->timestamp != trkpt_prev->timestamp ) {
 
                                                // Work out from previous trackpoint location and time difference
                                                speed = vik_coord_diff(&(trkpt->coord), &(trkpt_prev->coord)) / ABS(trkpt->timestamp - trkpt_prev->timestamp);
-
-                                               switch (speed_units) {
-                                               case VIK_UNITS_SPEED_KILOMETRES_PER_HOUR:
-                                                       speed = VIK_MPS_TO_KPH(speed);
-                                                       break;
-                                               case VIK_UNITS_SPEED_MILES_PER_HOUR:
-                                                       speed = VIK_MPS_TO_MPH(speed);
-                                                       break;
-                                               case VIK_UNITS_SPEED_KNOTS:
-                                                       speed = VIK_MPS_TO_KNOTS(speed);
-                                                       break;
-                                               default:
-                                                       // VIK_UNITS_SPEED_METRES_PER_SECOND:
-                                                       // Already in m/s so nothing to do
-                                                       break;
-                                               }
                                                speedtype = g_strdup ( "*" ); // Interpolated
                                        }
                                        else
@@ -131,12 +116,69 @@ gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkp
                                speed = trkpt->speed;
                                speedtype = g_strdup ( "" );
                        }
+                       switch (speed_units) {
+                       case VIK_UNITS_SPEED_KILOMETRES_PER_HOUR:
+                               speed = VIK_MPS_TO_KPH(speed);
+                               break;
+                       case VIK_UNITS_SPEED_MILES_PER_HOUR:
+                               speed = VIK_MPS_TO_MPH(speed);
+                               break;
+                       case VIK_UNITS_SPEED_KNOTS:
+                               speed = VIK_MPS_TO_KNOTS(speed);
+                               break;
+                       default:
+                               // VIK_UNITS_SPEED_METRES_PER_SECOND:
+                               // Already in m/s so nothing to do
+                               break;
+                       }
 
                        values[i] = g_strdup_printf ( _("%sSpeed%s %.1f%s"), separator, speedtype, speed, speed_units_str );
                        g_free ( speedtype );
                        break;
                }
 
+               case 'B': {
+                       gdouble speed = 0.0;
+                       gchar *speedtype = NULL;
+                       if ( isnan(climb) && trkpt_prev ) {
+                               if ( trkpt->has_timestamp && trkpt_prev->has_timestamp ) {
+                                       if ( trkpt->timestamp != trkpt_prev->timestamp ) {
+                                               // Work out from previous trackpoint altitudes and time difference
+                                               // 'speed' can be negative if going downhill
+                                               speed = (trkpt->altitude - trkpt_prev->altitude) / ABS(trkpt->timestamp - trkpt_prev->timestamp);
+                                               speedtype = g_strdup ( "*" ); // Interpolated
+                                       }
+                                       else
+                                               speedtype = g_strdup ( "**" ); // Unavailable
+                               }
+                               else
+                                       speedtype = g_strdup ( "**" );
+                       }
+                       else {
+                               speed = climb;
+                               speedtype = g_strdup ( "" );
+                       }
+                       switch (speed_units) {
+                       case VIK_UNITS_SPEED_KILOMETRES_PER_HOUR:
+                               speed = VIK_MPS_TO_KPH(speed);
+                               break;
+                       case VIK_UNITS_SPEED_MILES_PER_HOUR:
+                               speed = VIK_MPS_TO_MPH(speed);
+                               break;
+                       case VIK_UNITS_SPEED_KNOTS:
+                               speed = VIK_MPS_TO_KNOTS(speed);
+                               break;
+                       default:
+                               // VIK_UNITS_SPEED_METRES_PER_SECOND:
+                               // Already in m/s so nothing to do
+                               break;
+                       }
+                       // Go for 2dp as expect low values for vertical speeds
+                       values[i] = g_strdup_printf ( _("%sClimb%s %.2f%s"), separator, speedtype, speed, speed_units_str );
+                       g_free ( speedtype );
+                       break;
+               }
+
                case 'A': {
                        vik_units_height_t height_units = a_vik_get_units_height ();
                        switch (height_units) {
@@ -276,7 +318,8 @@ gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkp
                }
 
                case 'N': // Name of track
-                       values[i] = g_strdup_printf ( _("%sTrack: %s"), separator, trk->name );
+                       if ( trk )
+                               values[i] = g_strdup_printf ( _("%sTrack: %s"), separator, trk->name );
                        break;
 
                case 'E': // Name of trackpoint if available
@@ -328,7 +371,7 @@ static gboolean new_version_available_message ( new_version_thread_data *nvtd )
 static void latest_version_thread ( GtkWindow *window )
 {
        // Need to allow a few redirects, as SF file is often served from different server
-       DownloadMapOptions options = { FALSE, FALSE, NULL, 5, NULL, NULL, NULL };
+       DownloadFileOptions options = { FALSE, FALSE, NULL, 5, NULL, NULL, NULL };
        gchar *filename = a_download_uri_to_tmp_file ( "http://sourceforge.net/projects/viking/files/VERSION", &options );
        //gchar *filename = g_strdup ( "VERSION" );
        if ( !filename ) {
@@ -436,6 +479,8 @@ void vu_check_latest_version ( GtkWindow *window )
 void vu_set_auto_features_on_first_run ( void )
 {
        gboolean auto_features = FALSE;
+       gboolean set_defaults = FALSE;
+
        if ( a_vik_very_first_run () ) {
 
                GtkWidget *win = gtk_window_new ( GTK_WINDOW_TOPLEVEL );
@@ -443,12 +488,17 @@ void vu_set_auto_features_on_first_run ( void )
                if ( a_dialog_yes_or_no ( GTK_WINDOW(win),
                                          _("This appears to be Viking's very first run.\n\nDo you wish to enable automatic internet features?\n\nIndividual settings can be controlled in the Preferences."), NULL ) )
                        auto_features = TRUE;
+
+               // Default to more standard cache layout for new users (well new installs at least)
+               maps_layer_set_cache_default ( VIK_MAPS_CACHE_LAYOUT_OSM );
+               set_defaults = TRUE;
        }
 
        if ( auto_features ) {
                // Set Maps to autodownload
                // Ensure the default is true
                maps_layer_set_autodownload_default ( TRUE );
+               set_defaults = TRUE;
 
                // Simplistic repeat of preference settings
                //  Only the name & type are important for setting a preference via this 'external' way
@@ -476,6 +526,10 @@ void vu_set_auto_features_on_first_run ( void )
                // Ensure settings are saved for next time
                a_preferences_save_to_file ();
        }
+
+       // Ensure defaults are saved if changed
+       if ( set_defaults )
+               a_layer_defaults_save ();
 }
 
 /**
@@ -518,34 +572,49 @@ gchar *vu_get_canonical_filename ( VikLayer *vl, const gchar *filename )
 
 static struct kdtree *kd = NULL;
 
-static void load_ll_tz_dir ( const gchar *dir )
+/**
+ * load_ll_tz_dir
+ * @dir: The directory from which to load the latlontz.txt file
+ *
+ * Returns: The number of elements within the latlontz.txt loaded
+ */
+static gint load_ll_tz_dir ( const gchar *dir )
 {
+       gint inserted = 0;
        gchar *lltz = g_build_filename ( dir, "latlontz.txt", NULL );
        if ( g_access(lltz, R_OK) == 0 ) {
                gchar buffer[4096];
                long line_num = 0;
                FILE *ff = g_fopen ( lltz, "r" );
-
-               while ( fgets ( buffer, 4096, ff ) ) {
-                       line_num++;
-                       gchar **components = g_strsplit (buffer, " ", 3);
-                       guint nn = g_strv_length ( components );
-                       if ( nn == 3 ) {
-                               double pt[2] = { g_ascii_strtod (components[0], NULL), g_ascii_strtod (components[1], NULL) };
-                               gchar *timezone = g_strchomp ( components[2] );
-                               if ( kd_insert ( kd, pt, timezone ) )
-                                       g_critical ( "Insertion problem of %s for line %ld of latlontz.txt", timezone, line_num );
-                               // NB Don't free timezone as it's part of the kdtree data now
-                               g_free ( components[0] );
-                               g_free ( components[1] );
-                       } else {
-                               g_warning ( "Line %ld of latlontz.txt does not have 3 parts", line_num );
+               if ( ff ) {
+                       while ( fgets ( buffer, 4096, ff ) ) {
+                               line_num++;
+                               gchar **components = g_strsplit (buffer, " ", 3);
+                               guint nn = g_strv_length ( components );
+                               if ( nn == 3 ) {
+                                       double pt[2] = { g_ascii_strtod (components[0], NULL), g_ascii_strtod (components[1], NULL) };
+                                       gchar *timezone = g_strchomp ( components[2] );
+                                       if ( kd_insert ( kd, pt, timezone ) )
+                                               g_critical ( "Insertion problem of %s for line %ld of latlontz.txt", timezone, line_num );
+                                       else
+                                               inserted++;
+                                       // NB Don't free timezone as it's part of the kdtree data now
+                                       g_free ( components[0] );
+                                       g_free ( components[1] );
+                               } else {
+                                       g_warning ( "Line %ld of latlontz.txt does not have 3 parts", line_num );
+                               }
+                               g_free ( components );
                        }
-                       g_free ( components );
+                       fclose ( ff );
+               }
+               else {
+                       g_warning ( "%s: Could not open %s", __FUNCTION__, lltz);
                }
-               fclose ( ff );
        }
        g_free ( lltz );
+
+       return inserted;
 }
 
 /**
@@ -563,12 +632,17 @@ void vu_setup_lat_lon_tz_lookup ()
 
        // Look in the directories of data path
        gchar **data_dirs = a_get_viking_data_path();
+       guint loaded = 0;
        // Process directories in reverse order for priority
        guint n_data_dirs = g_strv_length ( data_dirs );
        for (; n_data_dirs > 0; n_data_dirs--) {
-               load_ll_tz_dir(data_dirs[n_data_dirs-1]);
+               loaded += load_ll_tz_dir(data_dirs[n_data_dirs-1]);
        }
        g_strfreev ( data_dirs );
+
+       g_debug ( "%s: Loaded %d elements", __FUNCTION__, loaded );
+       if ( loaded == 0 )
+               g_critical ( "%s: No lat/lon/timezones loaded", __FUNCTION__ );
 }
 
 /**
@@ -607,9 +681,14 @@ static gchar* time_string_adjusted ( time_t *time, gint offset_s )
 static gchar* time_string_tz ( time_t *time, const gchar *format, GTimeZone *tz )
 {
        GDateTime *utc = g_date_time_new_from_unix_utc (*time);
+       if ( !utc ) {
+               g_warning ( "%s: result from g_date_time_new_from_unix_utc() is NULL", __FUNCTION__ );
+               return NULL;
+       }
        GDateTime *local = g_date_time_to_timezone ( utc, tz );
        if ( !local ) {
                g_date_time_unref ( utc );
+               g_warning ( "%s: result from g_date_time_to_timezone() is NULL", __FUNCTION__ );
                return NULL;
        }
        gchar *str = g_date_time_format ( local, format );
@@ -716,3 +795,135 @@ gchar* vu_get_time_string ( time_t *time, const gchar *format, const VikCoord* v
        }
        return str;
 }
+
+/**
+ * vu_command_line:
+ *
+ * Apply any startup values that have been specified from the command line
+ * Values are defaulted in such a manner not to be applied when they haven't been specified
+ *
+ */
+void vu_command_line ( VikWindow *vw, gdouble latitude, gdouble longitude, gint zoom_osm_level, gint map_id )
+{
+       if ( !vw )
+               return;
+
+       VikViewport *vvp = vik_window_viewport(vw);
+
+       if ( latitude != 0.0 || longitude != 0.0 ) {
+               struct LatLon ll;
+               ll.lat = latitude;
+               ll.lon = longitude;
+               vik_viewport_set_center_latlon ( vvp, &ll, TRUE );
+       }
+
+       if ( zoom_osm_level >= 0 ) {
+               // Convert OSM zoom level into Viking zoom level
+               gdouble mpp = exp ( (17-zoom_osm_level) * log(2) );
+               if ( mpp > 1.0 )
+                       mpp = round (mpp);
+               vik_viewport_set_zoom ( vvp, mpp );
+       }
+
+       if ( map_id >= 0 ) {
+               guint my_map_id = map_id;
+               if ( my_map_id == 0 )
+                       my_map_id = vik_maps_layer_get_default_map_type ();
+
+               // Don't add map layer if one already exists
+               GList *vmls = vik_layers_panel_get_all_layers_of_type(vik_window_layers_panel(vw), VIK_LAYER_MAPS, TRUE);
+               int num_maps = g_list_length(vmls);
+               gboolean add_map = TRUE;
+
+               for (int i = 0; i < num_maps; i++) {
+                       VikMapsLayer *vml = (VikMapsLayer*)(vmls->data);
+                       gint id = vik_maps_layer_get_map_type(vml);
+                       if ( my_map_id == id ) {
+                               add_map = FALSE;
+                               break;
+                       }
+                       vmls = vmls->next;
+               }
+
+               if ( add_map ) {
+                       VikMapsLayer *vml = VIK_MAPS_LAYER ( vik_layer_create(VIK_LAYER_MAPS, vvp, FALSE) );
+                       vik_maps_layer_set_map_type ( vml, my_map_id );
+                       vik_layer_rename ( VIK_LAYER(vml), _("Map") );
+                       vik_aggregate_layer_add_layer ( vik_layers_panel_get_top_layer(vik_window_layers_panel(vw)), VIK_LAYER(vml), TRUE );
+                       vik_layer_emit_update ( VIK_LAYER(vml) );
+               }
+       }
+}
+
+/**
+ * Copy the displayed text of a widget (should be a GtkButton ATM)
+ */
+static void vu_copy_label ( GtkWidget *widget )
+{
+       a_clipboard_copy (VIK_CLIPBOARD_DATA_TEXT, 0, 0, 0, gtk_button_get_label(GTK_BUTTON(widget)), NULL );
+}
+
+/**
+ * Generate a single entry menu to allow copying the displayed text of a widget (should be a GtkButton ATM)
+ */
+void vu_copy_label_menu ( GtkWidget *widget, guint button )
+{
+       GtkWidget *menu = gtk_menu_new();
+       GtkWidget *item = gtk_image_menu_item_new_from_stock ( GTK_STOCK_COPY, NULL );
+       g_signal_connect_swapped ( G_OBJECT(item), "activate", G_CALLBACK(vu_copy_label), widget );
+       gtk_menu_shell_append ( GTK_MENU_SHELL(menu), item );
+       gtk_widget_show ( item );
+       gtk_menu_popup ( GTK_MENU(menu), NULL, NULL, NULL, NULL, button, gtk_get_current_event_time() );
+}
+
+/**
+ * Work out the best zoom level for the LatLon area and set the viewport to that zoom level
+ */
+void vu_zoom_to_show_latlons ( VikCoordMode mode, VikViewport *vvp, struct LatLon maxmin[2] )
+{
+       /* First set the center [in case previously viewing from elsewhere] */
+       /* Then loop through zoom levels until provided positions are in view */
+       /* This method is not particularly fast - but should work well enough */
+       struct LatLon average = { (maxmin[0].lat+maxmin[1].lat)/2, (maxmin[0].lon+maxmin[1].lon)/2 };
+       VikCoord coord;
+       vik_coord_load_from_latlon ( &coord, mode, &average );
+       vik_viewport_set_center_coord ( vvp, &coord, TRUE );
+
+       /* Convert into definite 'smallest' and 'largest' positions */
+       struct LatLon minmin;
+       if ( maxmin[0].lat < maxmin[1].lat )
+               minmin.lat = maxmin[0].lat;
+       else
+               minmin.lat = maxmin[1].lat;
+
+       struct LatLon maxmax;
+       if ( maxmin[0].lon > maxmin[1].lon )
+               maxmax.lon = maxmin[0].lon;
+       else
+               maxmax.lon = maxmin[1].lon;
+
+       /* Never zoom in too far - generally not that useful, as too close ! */
+       /* Always recalculate the 'best' zoom level */
+       gdouble zoom = 1.0;
+       vik_viewport_set_zoom ( vvp, zoom );
+
+       gdouble min_lat, max_lat, min_lon, max_lon;
+       /* Should only be a maximum of about 18 iterations from min to max zoom levels */
+       while ( zoom <= VIK_VIEWPORT_MAX_ZOOM ) {
+               vik_viewport_get_min_max_lat_lon ( vvp, &min_lat, &max_lat, &min_lon, &max_lon );
+               /* NB I think the logic used in this test to determine if the bounds is within view
+                  fails if track goes across 180 degrees longitude.
+                  Hopefully that situation is not too common...
+                  Mind you viking doesn't really do edge locations to well anyway */
+               if ( min_lat < minmin.lat &&
+                    max_lat > minmin.lat &&
+                    min_lon < maxmax.lon &&
+                    max_lon > maxmax.lon )
+                       /* Found within zoom level */
+                       break;
+
+               /* Try next */
+               zoom = zoom * 2;
+               vik_viewport_set_zoom ( vvp, zoom );
+       }
+}