]> git.street.me.uk Git - andy/viking.git/blobdiff - src/vikutils.c
Enable i18n on 'Routing' preferences tab name.
[andy/viking.git] / src / vikutils.c
index f51db19e4b52f678004a047340f5916f0c2cdf6b..c4f088fcf5e3352d971f06d296294000ac22af64 100644 (file)
@@ -28,6 +28,7 @@
 #include <glib/gi18n.h>
 #include <gtk/gtk.h>
 
+#include "viking.h"
 #include "vikutils.h"
 #include "globals.h"
 #include "download.h"
@@ -35,6 +36,8 @@
 #include "vikmapslayer.h"
 #include "settings.h"
 #include "util.h"
+#include "dir.h"
+#include "misc/kdtree.h"
 
 #define FMT_MAX_NUMBER_CODES 9
 
@@ -163,6 +166,7 @@ gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkp
                                // expect the difference between track points to be small hence use metres or yards
                                switch (dist_units) {
                                case VIK_UNITS_DISTANCE_MILES:
+                               case VIK_UNITS_DISTANCE_NAUTICAL_MILES:
                                        dist_units_str = g_strdup ( _("yards") );
                                        break;
                                default:
@@ -179,15 +183,15 @@ gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkp
                }
 
                case 'T': {
-                       gchar tmp[64];
-                       tmp[0] = '\0';
+                       gchar *msg;
                        if ( trkpt->has_timestamp ) {
                                // Compact date time format
-                               strftime (tmp, sizeof(tmp), "%x %X", localtime(&(trkpt->timestamp)));
+                               msg = vu_get_time_string ( &(trkpt->timestamp), "%x %X", &(trkpt->coord), NULL );
                        }
                        else
-                               g_snprintf (tmp, sizeof(tmp), "--");
-                       values[i] = g_strdup_printf ( _("%sTime %s"), separator, tmp );
+                               msg = g_strdup ("--");
+                       values[i] = g_strdup_printf ( _("%sTime %s"), separator, msg );
+                       g_free ( msg );
                        break;
                }
 
@@ -203,18 +207,50 @@ gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkp
 
                case 'X': values[i] = g_strdup_printf ( _("%sNo. of Sats %d"), separator, trkpt->nsats ); break;
 
+               case 'F': {
+                       if ( trk ) {
+                               // Distance to the end 'Finish' (along the track)
+                               gdouble distd = vik_track_get_length_to_trackpoint (trk, trkpt);
+                               gdouble diste = vik_track_get_length_including_gaps ( trk );
+                               gdouble dist = diste - distd;
+                               gchar *dist_units_str = NULL;
+                               vik_units_distance_t dist_units = a_vik_get_units_distance ();
+                               switch (dist_units) {
+                               case VIK_UNITS_DISTANCE_MILES:
+                                       dist_units_str = g_strdup ( _("miles") );
+                                       dist = VIK_METERS_TO_MILES(dist);
+                                       break;
+                               case VIK_UNITS_DISTANCE_NAUTICAL_MILES:
+                                       dist_units_str = g_strdup ( _("NM") );
+                                       dist = VIK_METERS_TO_NAUTICAL_MILES(dist);
+                                       break;
+                               default:
+                                       // VIK_UNITS_DISTANCE_KILOMETRES:
+                                       dist_units_str = g_strdup ( _("km") );
+                                       dist = dist / 1000.0;
+                                       break;
+                               }
+                               values[i] = g_strdup_printf ( _("%sTo End %.2f%s"), separator, dist, dist_units_str );
+                               g_free ( dist_units_str );
+                       }
+                       break;
+               }
+
                case 'D': {
                        if ( trk ) {
                                // Distance from start (along the track)
                                gdouble distd = vik_track_get_length_to_trackpoint (trk, trkpt);
                                gchar *dist_units_str = NULL;
                                vik_units_distance_t dist_units = a_vik_get_units_distance ();
-                               // expect the difference between track points to be small hence use metres or yards
                                switch (dist_units) {
                                case VIK_UNITS_DISTANCE_MILES:
                                        dist_units_str = g_strdup ( _("miles") );
                                        distd = VIK_METERS_TO_MILES(distd);
                                        break;
+                               case VIK_UNITS_DISTANCE_NAUTICAL_MILES:
+                                       dist_units_str = g_strdup ( _("NM") );
+                                       distd = VIK_METERS_TO_NAUTICAL_MILES(distd);
+                                       break;
                                default:
                                        // VIK_UNITS_DISTANCE_KILOMETRES:
                                        dist_units_str = g_strdup ( _("km") );
@@ -479,3 +515,204 @@ gchar *vu_get_canonical_filename ( VikLayer *vl, const gchar *filename )
 
   return canonical;
 }
+
+static struct kdtree *kd = NULL;
+
+static void load_ll_tz_dir ( const gchar *dir )
+{
+       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 );
+                       }
+                       g_free ( components );
+               }
+               fclose ( ff );
+       }
+       g_free ( lltz );
+}
+
+/**
+ * vu_setup_lat_lon_tz_lookup:
+ *
+ * Can be called multiple times but only initializes the lookup once
+ */
+void vu_setup_lat_lon_tz_lookup ()
+{
+       // Only setup once
+       if ( kd )
+               return;
+
+       kd = kd_create(2);
+
+       // Look in the directories of data path
+       gchar **data_dirs = a_get_viking_data_path();
+       // 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]);
+       }
+       g_strfreev ( data_dirs );
+}
+
+/**
+ * vu_finalize_lat_lon_tz_lookup:
+ *
+ * Clear memory used by the lookup.
+ *  only call on program exit
+ */
+void vu_finalize_lat_lon_tz_lookup ()
+{
+       if ( kd ) {
+               kd_data_destructor ( kd, g_free );
+               kd_free ( kd );
+       }
+}
+
+static double dist_sq( double *a1, double *a2, int dims ) {
+  double dist_sq = 0, diff;
+  while( --dims >= 0 ) {
+    diff = (a1[dims] - a2[dims]);
+    dist_sq += diff*diff;
+  }
+  return dist_sq;
+}
+
+static gchar* time_string_adjusted ( time_t *time, gint offset_s )
+{
+       time_t *mytime = time;
+       *mytime = *mytime + offset_s;
+       gchar *str = g_malloc ( 64 );
+       // Append asterisks to indicate use of simplistic model (i.e. no TZ)
+       strftime ( str, 64, "%a %X %x **", gmtime(mytime) );
+       return str;
+}
+
+static gchar* time_string_tz ( time_t *time, const gchar *format, GTimeZone *tz )
+{
+       GDateTime *utc = g_date_time_new_from_unix_utc (*time);
+       GDateTime *local = g_date_time_to_timezone ( utc, tz );
+       if ( !local ) {
+               g_date_time_unref ( utc );
+               return NULL;
+       }
+       gchar *str = g_date_time_format ( local, format );
+
+       g_date_time_unref ( local );
+       g_date_time_unref ( utc );
+       return str;
+}
+
+#define VIK_SETTINGS_NEAREST_TZ_FACTOR "utils_nearest_tz_factor"
+/**
+ * vu_get_tz_at_location:
+ *
+ * @vc:     Position for which the time zone is desired
+ *
+ * Returns: TimeZone string of the nearest known location. String may be NULL.
+ *
+ * Use the k-d tree method (http://en.wikipedia.org/wiki/Kd-tree) to quickly retreive
+ *  the nearest location to the given position.
+ */
+gchar* vu_get_tz_at_location ( const VikCoord* vc )
+{
+       gchar *tz = NULL;
+       if ( !vc || !kd )
+               return tz;
+
+       struct LatLon ll;
+       vik_coord_to_latlon ( vc, &ll );
+       double pt[2] = { ll.lat, ll.lon };
+
+       gdouble nearest;
+       if ( !a_settings_get_double(VIK_SETTINGS_NEAREST_TZ_FACTOR, &nearest) )
+               nearest = 1.0;
+
+       struct kdres *presults = kd_nearest_range ( kd, pt, nearest );
+       while( !kd_res_end( presults ) ) {
+               double pos[2];
+               gchar *ans = (gchar*)kd_res_item ( presults, pos );
+               // compute the distance of the current result from the pt
+               double dist = sqrt( dist_sq( pt, pos, 2 ) );
+               if ( dist < nearest ) {
+                       //printf( "NEARER node at (%.3f, %.3f, %.3f) is %.3f away is %s\n", pos[0], pos[1], pos[2], dist, ans );
+                       nearest = dist;
+                       tz = ans;
+               }
+               kd_res_next ( presults );
+       }
+       g_debug ( "TZ lookup found %d results - picked %s", kd_res_size(presults), tz );
+       kd_res_free ( presults );
+
+       return tz;
+}
+
+/**
+ * vu_get_time_string:
+ *
+ * @time_t: The time of which the string is wanted
+ * @format  The format of the time string - such as "%c"
+ * @vc:     Position of object for the time output - maybe NULL
+ *          (only applicable for VIK_TIME_REF_WORLD)
+ * @tz:     TimeZone string - maybe NULL.
+ *          (only applicable for VIK_TIME_REF_WORLD)
+ *          Useful to pass in the cached value from vu_get_tz_at_location() to save looking it up again for the same position
+ *
+ * Returns: A string of the time according to the time display property
+ */
+gchar* vu_get_time_string ( time_t *time, const gchar *format, const VikCoord* vc, const gchar *tz )
+{
+       if ( !format ) return NULL;
+       gchar *str = NULL;
+       switch ( a_vik_get_time_ref_frame() ) {
+               case VIK_TIME_REF_UTC:
+                       str = g_malloc ( 64 );
+                       strftime ( str, 64, format, gmtime(time) ); // Always 'GMT'
+                       break;
+               case VIK_TIME_REF_WORLD:
+                       if ( vc && !tz ) {
+                               // No timezone specified so work it out
+                               gchar *mytz = vu_get_tz_at_location ( vc );
+                               if ( mytz ) {
+                                       GTimeZone *gtz = g_time_zone_new ( mytz );
+                                       str = time_string_tz ( time, format, gtz );
+                                       g_time_zone_unref ( gtz );
+                               }
+                               else {
+                                       // No results (e.g. could be in the middle of a sea)
+                                       // Fallback to simplistic method that doesn't take into account Timezones of countries.
+                                       struct LatLon ll;
+                                       vik_coord_to_latlon ( vc, &ll );
+                                       str = time_string_adjusted ( time, round ( ll.lon / 15.0 ) * 3600 );
+                               }
+                       }
+                       else {
+                               // Use specified timezone
+                               GTimeZone *gtz = g_time_zone_new ( tz );
+                               str = time_string_tz ( time, format, gtz );
+                               g_time_zone_unref ( gtz );
+                       }
+                       break;
+               default: // VIK_TIME_REF_LOCALE
+                       str = g_malloc ( 64 );
+                       strftime ( str, 64, format, localtime(time) );
+                       break;
+       }
+       return str;
+}