src/gpspoint.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #include "viking.h"
  23
  24 #include <ctype.h>
  25 #include <string.h>
  26
  27 #include <stdlib.h>
  28 /* strtod */
  29
  30
  31 static void a_gpspoint_write_track ( const gchar *name, VikTrack *t, FILE *f );
  32 static void a_gpspoint_write_trackpoint ( VikTrackpoint *tp, FILE *f );
  33 static void a_gpspoint_write_waypoint ( const gchar *name, VikWaypoint *wp, FILE *f );
  34
  35
  36 /* outline for file gpspoint.c
  37
  38 reading file:
  39
  40 take a line.
  41 get first tag, if not type, skip it.
  42 if type, record type.  if waypoint list, etc move on. if track, make a new track, make it current track, add it, etc.
  43 if waypoint, read on and store to the waypoint.
  44 if trackpoint, make trackpoint, store to current track (error / skip if none)
  45
  46 */
  47
  48 /* Thanks to etrex-cache's gpsbabel's gpspoint.c for starting me off! */
  49
  50 static char line_buffer[2048];
  51
  52 #define GPSPOINT_TYPE_NONE 0
  53 #define GPSPOINT_TYPE_WAYPOINT 1
  54 #define GPSPOINT_TYPE_TRACKPOINT 2
  55 /* #define GPSPOINT_TYPE_ROUTEPOINT 3 */
  56 #define GPSPOINT_TYPE_TRACK 4
  57
  58 /* #define GPSPOINT_TYPE_ROUTE 5 */
  59
  60 static VikTrack *current_track; /* pointer to pointer to first GList */
  61
  62 static gint line_type = GPSPOINT_TYPE_NONE;
  63 static struct LatLon line_latlon;
  64 static gchar *line_name;
  65 static gchar *line_comment;
  66 static gchar *line_image;
  67 static gchar *line_symbol;
  68 static gboolean line_newsegment = FALSE;
  69 static gboolean line_has_timestamp = FALSE;
  70 static time_t line_timestamp = 0;
  71 static gdouble line_altitude = VIK_DEFAULT_ALTITUDE;
  72 static gboolean line_visible = TRUE;
  73 /* other possible properties go here */
  74
  75
  76 static void gpspoint_process_tag ( const gchar *tag, gint len );
  77 static void gpspoint_process_key_and_value ( const gchar *key, gint key_len, const gchar *value, gint value_len );
  78
  79 static gchar *slashdup(const gchar *str)
  80 {
  81   guint16 len = strlen(str);
  82   guint16 need_bs_count, i, j;
  83   gchar *rv;
  84   for ( i = 0, need_bs_count = 0; i < len; i++ )
  85     if ( str[i] == '\\' || str[i] == '"' )
  86       need_bs_count++;
  87   rv = g_malloc ( (len+need_bs_count+1) * sizeof(gchar) );
  88   for ( i = 0, j = 0; i < len; i++, j++ )
  89   {
  90     if ( str[i] == '\\' || str[i] == '"' )
  91       rv[j++] = '\\';
  92     rv[j] = str[i];
  93   }
  94   rv[j] = '\0';
  95   return rv;
  96 }
  97
  98 static gchar *deslashndup ( const gchar *str, guint16 len )
  99 {
 100   guint16 i,j, bs_count, new_len;
 101   gboolean backslash = FALSE;
 102   gchar *rv;
 103
 104   if ( len < 1 )
 105     return NULL;
 106
 107   for ( i = 0, bs_count = 0; i < len; i++ )
 108    if ( str[i] == '\\' )
 109    {
 110      bs_count++;
 111      i++;
 112    }
 113
 114   if ( str[i-1] == '\\' && (len == 1 || str[i-2] != '\\') )
 115     bs_count--;
 116
 117   new_len = len - bs_count;
 118   rv = g_malloc ( (new_len+1) * sizeof(gchar) );
 119   for ( i = 0, j = 0; i < len && j < new_len; i++ )
 120     if ( str[i] == '\\' && !backslash )
 121       backslash = TRUE;
 122     else
 123     {
 124       rv[j++] = str[i];
 125       backslash = FALSE;
 126     }
 127
 128   rv[new_len] = '\0';
 129   return rv;
 130 }
 131
 132 void a_gpspoint_read_file(VikTrwLayer *trw, FILE *f ) {
 133   VikCoordMode coord_mode = vik_trw_layer_get_coord_mode ( trw );
 134   gchar *tag_start, *tag_end;
 135   g_assert ( f != NULL && trw != NULL );
 136   line_type = 0;
 137   line_timestamp = 0;
 138   line_newsegment = FALSE;
 139   line_image = NULL;
 140   line_symbol = NULL;
 141
 142   current_track = NULL;
 143   while (fgets(line_buffer, 2048, f))
 144   {
 145     gboolean inside_quote = 0;
 146     gboolean backslash = 0;
 147
 148     line_buffer[strlen(line_buffer)-1] = '\0'; /* chop off newline */
 149
 150     /* for gpspoint files wrapped inside */
 151     if ( strlen(line_buffer) >= 13 && strncmp ( line_buffer, "~EndLayerData", 13 ) == 0 )
 152       break;
 153
 154 /* each line: nullify stuff, make thing if nes, free name if ness */
 155     tag_start = line_buffer;
 156     for (;;)
 157     {
 158       /* my addition: find first non-whitespace character. if the null, skip line. */
 159       while (*tag_start != '\0' && isspace(*tag_start))
 160         tag_start++;
 161       if (tag_start == '\0')
 162         break;
 163
 164       if (*tag_start == '#')
 165         break;
 166
 167       tag_end = tag_start;
 168         if (*tag_end == '"')
 169           inside_quote = !inside_quote;
 170       while (*tag_end != '\0' && (!isspace(*tag_end) || inside_quote)) {
 171         tag_end++;
 172         if (*tag_end == '\\' && !backslash)
 173           backslash = TRUE;
 174         else if (backslash)
 175           backslash = FALSE;
 176         else if (*tag_end == '"')
 177           inside_quote = !inside_quote;
 178       }
 179
 180       gpspoint_process_tag ( tag_start, tag_end - tag_start );
 181
 182       if (*tag_end == '\0' )
 183         break;
 184       else
 185         tag_start = tag_end+1;
 186     }
 187     if (line_type == GPSPOINT_TYPE_WAYPOINT && line_name)
 188     {
 189       VikWaypoint *wp = vik_waypoint_new();
 190       gint i = strlen(line_name);
 191       wp->visible = line_visible;
 192       wp->altitude = line_altitude;
 193       while ( i-- )
 194         line_name[i] = toupper(line_name[i]); /* TODO: check for acceptable chars */
 195
 196       vik_coord_load_from_latlon ( &(wp->coord), coord_mode, &line_latlon );
 197
 198       vik_trw_layer_filein_add_waypoint ( trw, line_name, wp );
 199       g_free ( line_name );
 200       line_name = NULL;
 201
 202       if ( line_comment )
 203       {
 204         vik_waypoint_set_comment ( wp, line_comment );
 205         line_comment = NULL;
 206       }
 207
 208       if ( line_image )
 209       {
 210         vik_waypoint_set_image ( wp, line_image );
 211         line_image = NULL;
 212       }
 213
 214       if ( line_symbol )
 215       {
 216         vik_waypoint_set_symbol ( wp, line_symbol );
 217         line_symbol = NULL;
 218       }
 219     }
 220     else if (line_type == GPSPOINT_TYPE_TRACK && line_name)
 221     {
 222       VikTrack *pl = vik_track_new();
 223       gint i = strlen(line_name);
 224
 225       /* Thanks to Peter Jones for this Fix */
 226       if (!line_name) line_name = g_strdup("UNK");
 227
 228       pl->visible = line_visible;
 229
 230       while ( i-- )
 231         line_name[i] = toupper(line_name[i]);
 232
 233       if ( line_comment )
 234       {
 235         vik_track_set_comment ( pl, line_comment );
 236         line_comment = NULL;
 237       }
 238
 239       pl->trackpoints = NULL;
 240       vik_trw_layer_filein_add_track ( trw, line_name, pl );
 241       g_free ( line_name );
 242       line_name = NULL;
 243
 244       current_track = pl;
 245     }
 246     else if (line_type == GPSPOINT_TYPE_TRACKPOINT && current_track)
 247     {
 248       VikTrackpoint *tp = g_malloc ( sizeof ( VikTrackpoint ) );
 249       vik_coord_load_from_latlon ( &(tp->coord), coord_mode, &line_latlon );
 250       tp->newsegment = line_newsegment;
 251       tp->has_timestamp = line_has_timestamp;
 252       tp->timestamp = line_timestamp;
 253       tp->altitude = line_altitude;
 254       current_track->trackpoints = g_list_append ( current_track->trackpoints, tp );
 255     }
 256
 257     if (line_name)
 258       g_free ( line_name );
 259     line_name = NULL;
 260     if (line_comment)
 261       g_free ( line_comment );
 262     if (line_image)
 263       g_free ( line_image );
 264     if (line_symbol)
 265       g_free ( line_symbol );
 266     line_comment = NULL;
 267     line_image = NULL;
 268     line_symbol = NULL;
 269     line_type = GPSPOINT_TYPE_NONE;
 270     line_newsegment = FALSE;
 271     line_has_timestamp = FALSE;
 272     line_timestamp = 0;
 273     line_altitude = VIK_DEFAULT_ALTITUDE;
 274     line_visible = TRUE;
 275     line_symbol = NULL;
 276   }
 277 }
 278
 279 /* Tag will be of a few defined forms:
 280    ^[:alpha:]*=".*"$
 281    ^[:alpha:]*=.*$
 282
 283    <invalid tag>
 284
 285 So we must determine end of tag name, start of value, end of value.
 286 */
 287 static void gpspoint_process_tag ( const gchar *tag, gint len )
 288 {
 289   const gchar *key_end, *value_start, *value_end;
 290
 291   /* Searching for key end */
 292   key_end = tag;
 293
 294   while (++key_end - tag < len)
 295     if (*key_end == '=')
 296       break;
 297
 298   if (key_end - tag == len)
 299     return; /* no good */
 300
 301   if (key_end - tag == len + 1)
 302     value_start = value_end = 0; /* size = 0 */
 303   else
 304   {
 305     value_start = key_end + 1; /* equal_sign plus one */
 306
 307     if (*value_start == '"')
 308     {
 309       value_start++;
 310       if (*value_start == '"')
 311         value_start = value_end = 0; /* size = 0 */
 312       else
 313       {
 314         if (*(tag+len-1) == '"')
 315         value_end = tag + len - 1;
 316         else
 317           return; /* bogus */
 318       }
 319     }
 320     else
 321       value_end = tag + len; /* value start really IS value start. */
 322
 323     gpspoint_process_key_and_value(tag, key_end - tag, value_start, value_end - value_start);
 324   }
 325 }
 326
 327 /*
 328 value = NULL for none
 329 */
 330 static void gpspoint_process_key_and_value ( const gchar *key, gint key_len, const gchar *value, gint value_len )
 331 {
 332   if (key_len == 4 && strncasecmp( key, "type", key_len ) == 0 )
 333   {
 334     if (value == NULL)
 335       line_type = GPSPOINT_TYPE_NONE;
 336     else if (value_len == 5 && strncasecmp( value, "track", value_len ) == 0 )
 337       line_type = GPSPOINT_TYPE_TRACK;
 338     else if (value_len == 10 && strncasecmp( value, "trackpoint", value_len ) == 0 )
 339       line_type = GPSPOINT_TYPE_TRACKPOINT;
 340     else if (value_len == 8 && strncasecmp( value, "waypoint", value_len ) == 0 )
 341       line_type = GPSPOINT_TYPE_WAYPOINT;
 342     else
 343       /* all others are ignored */
 344       line_type = GPSPOINT_TYPE_NONE;
 345   }
 346   else if (key_len == 4 && strncasecmp( key, "name", key_len ) == 0 && value != NULL)
 347   {
 348     if (line_name == NULL)
 349     {
 350       line_name = g_strndup ( value, value_len );
 351     }
 352   }
 353   else if (key_len == 7 && strncasecmp( key, "comment", key_len ) == 0 && value != NULL)
 354   {
 355     if (line_comment == NULL)
 356       line_comment = deslashndup ( value, value_len );
 357   }
 358   else if (key_len == 5 && strncasecmp( key, "image", key_len ) == 0 && value != NULL)
 359   {
 360     if (line_image == NULL)
 361       line_image = deslashndup ( value, value_len );
 362   }
 363   else if (key_len == 8 && strncasecmp( key, "latitude", key_len ) == 0 && value != NULL)
 364   {
 365     line_latlon.lat = g_strtod(value, NULL);
 366   }
 367   else if (key_len == 9 && strncasecmp( key, "longitude", key_len ) == 0 && value != NULL)
 368   {
 369     line_latlon.lon = g_strtod(value, NULL);
 370   }
 371   else if (key_len == 8 && strncasecmp( key, "altitude", key_len ) == 0 && value != NULL)
 372   {
 373     line_altitude = g_strtod(value, NULL);
 374   }
 375   else if (key_len == 7 && strncasecmp( key, "visible", key_len ) == 0 && value[0] != 'y' && value[0] != 'Y' && value[0] != 't' && value[0] != 'T')
 376   {
 377     line_visible = FALSE;
 378   }
 379   else if (key_len == 6 && strncasecmp( key, "symbol", key_len ) == 0 && value != NULL)
 380   {
 381     line_symbol = g_strndup ( value, value_len );
 382   }
 383   else if (key_len == 8 && strncasecmp( key, "unixtime", key_len ) == 0 && value != NULL)
 384   {
 385     line_timestamp = g_strtod(value, NULL);
 386     if ( line_timestamp != 0x80000000 )
 387       line_has_timestamp = TRUE;
 388   }
 389   else if (key_len == 10 && strncasecmp( key, "newsegment", key_len ) == 0 && value != NULL)
 390   {
 391     line_newsegment = TRUE;
 392   }
 393 }
 394
 395 static void a_gpspoint_write_waypoint ( const gchar *name, VikWaypoint *wp, FILE *f )
 396 {
 397   static struct LatLon ll;
 398   gchar *s_lat, *s_lon;
 399   vik_coord_to_latlon ( &(wp->coord), &ll );
 400   s_lat = a_coords_dtostr(ll.lat);
 401   s_lon = a_coords_dtostr(ll.lon);
 402   fprintf ( f, "type=\"waypoint\" latitude=\"%s\" longitude=\"%s\" name=\"%s\"", s_lat, s_lon, name );
 403   g_free ( s_lat );
 404   g_free ( s_lon );
 405
 406   if ( wp->altitude != VIK_DEFAULT_ALTITUDE ) {
 407     gchar *s_alt = a_coords_dtostr(wp->altitude);
 408     fprintf ( f, " altitude=\"%s\"", s_alt );
 409     g_free(s_alt);
 410   }
 411   if ( wp->comment )
 412   {
 413     gchar *tmp_comment = slashdup(wp->comment);
 414     fprintf ( f, " comment=\"%s\"", tmp_comment );
 415     g_free ( tmp_comment );
 416   }
 417   if ( wp->image )
 418   {
 419     gchar *tmp_image = slashdup(wp->image);
 420     fprintf ( f, " image=\"%s\"", tmp_image );
 421     g_free ( tmp_image );
 422   }
 423   if ( wp->symbol )
 424   {
 425     fprintf ( f, " symbol=\"%s\"", wp->symbol );
 426   }
 427   if ( ! wp->visible )
 428     fprintf ( f, " visible=\"n\"" );
 429   fprintf ( f, "\n" );
 430 }
 431
 432 static void a_gpspoint_write_trackpoint ( VikTrackpoint *tp, FILE *f )
 433 {
 434   static struct LatLon ll;
 435   gchar *s_lat, *s_lon;
 436   vik_coord_to_latlon ( &(tp->coord), &ll );
 437
 438   s_lat = a_coords_dtostr(ll.lat);
 439   s_lon = a_coords_dtostr(ll.lon);
 440   fprintf ( f, "type=\"trackpoint\" latitude=\"%s\" longitude=\"%s\"", s_lat, s_lon );
 441   g_free ( s_lat );
 442   g_free ( s_lon );
 443
 444   if ( tp->altitude != VIK_DEFAULT_ALTITUDE ) {
 445     gchar *s_alt = a_coords_dtostr(tp->altitude);
 446     fprintf ( f, " altitude=\"%s\"", s_alt );
 447     g_free(s_alt);
 448   }
 449   if ( tp->has_timestamp )
 450     fprintf ( f, " unixtime=\"%ld\"", tp->timestamp );
 451   if ( tp->newsegment )
 452     fprintf ( f, " newsegment=\"yes\"" );
 453   fprintf ( f, "\n" );
 454 }
 455
 456
 457 static void a_gpspoint_write_track ( const gchar *name, VikTrack *t, FILE *f )
 458 {
 459   if ( t->comment )
 460   {
 461     gchar *tmp_comment = slashdup(t->comment);
 462     fprintf ( f, "type=\"track\" name=\"%s\" comment=\"%s\"%s\n", name, tmp_comment, t->visible ? "" : " visible=\"n\"" );
 463     g_free ( tmp_comment );
 464   }
 465   else
 466     fprintf ( f, "type=\"track\" name=\"%s\"%s\n", name, t->visible ? "" : " visible=\"n\"" );
 467   g_list_foreach ( t->trackpoints, (GFunc) a_gpspoint_write_trackpoint, f );
 468   fprintf ( f, "type=\"trackend\"\n" );
 469 }
 470
 471 void a_gpspoint_write_file ( VikTrwLayer *trw, FILE *f )
 472 {
 473   GHashTable *tracks = vik_trw_layer_get_tracks ( trw );
 474   GHashTable *waypoints = vik_trw_layer_get_waypoints ( trw );
 475
 476   fprintf ( f, "type=\"waypointlist\"\n" );
 477   g_hash_table_foreach ( waypoints, (GHFunc) a_gpspoint_write_waypoint, f );
 478   fprintf ( f, "type=\"waypointlistend\"\n" );
 479   g_hash_table_foreach ( tracks, (GHFunc) a_gpspoint_write_track, f );
 480 }