2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
5 * Copyright (C) 2012-2013, Rob Norris <rw_norris@hotmail.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
45 static void a_gpspoint_write_track ( const gpointer id, const VikTrack *t, FILE *f );
46 static void a_gpspoint_write_trackpoint ( VikTrackpoint *tp, TP_write_info_type *write_info );
47 static void a_gpspoint_write_waypoint ( const gpointer id, const VikWaypoint *wp, FILE *f );
49 /* outline for file gpspoint.c
54 get first tag, if not type, skip it.
55 if type, record type. if waypoint list, etc move on. if track, make a new track, make it current track, add it, etc.
56 if waypoint, read on and store to the waypoint.
57 if trackpoint, make trackpoint, store to current track (error / skip if none)
61 /* Thanks to etrex-cache's gpsbabel's gpspoint.c for starting me off! */
63 static char line_buffer[2048];
65 #define GPSPOINT_TYPE_NONE 0
66 #define GPSPOINT_TYPE_WAYPOINT 1
67 #define GPSPOINT_TYPE_TRACKPOINT 2
68 #define GPSPOINT_TYPE_ROUTEPOINT 3
69 #define GPSPOINT_TYPE_TRACK 4
70 #define GPSPOINT_TYPE_ROUTE 5
72 static VikTrack *current_track; /* pointer to pointer to first GList */
74 static gint line_type = GPSPOINT_TYPE_NONE;
75 static struct LatLon line_latlon;
76 static gchar *line_name;
77 static gchar *line_comment;
78 static gchar *line_description;
79 static gchar *line_color;
80 static gint line_name_label = 0;
81 static gint line_dist_label = 0;
82 static gchar *line_image;
83 static gchar *line_symbol;
84 static gboolean line_newsegment = FALSE;
85 static gboolean line_has_timestamp = FALSE;
86 static time_t line_timestamp = 0;
87 static gdouble line_altitude = VIK_DEFAULT_ALTITUDE;
88 static gboolean line_visible = TRUE;
90 static gboolean line_extended = FALSE;
91 static gdouble line_speed = NAN;
92 static gdouble line_course = NAN;
93 static gint line_sat = 0;
94 static gint line_fix = 0;
95 static gdouble line_hdop = VIK_DEFAULT_DOP;
96 static gdouble line_vdop = VIK_DEFAULT_DOP;
97 static gdouble line_pdop = VIK_DEFAULT_DOP;
98 /* other possible properties go here */
101 static void gpspoint_process_tag ( const gchar *tag, guint len );
102 static void gpspoint_process_key_and_value ( const gchar *key, guint key_len, const gchar *value, guint value_len );
104 static gchar *slashdup(const gchar *str)
106 size_t len = strlen(str);
107 size_t need_bs_count, i, j;
109 for ( i = 0, need_bs_count = 0; i < len; i++ )
110 if ( str[i] == '\\' || str[i] == '"' )
112 rv = g_malloc ( (len+need_bs_count+1) * sizeof(gchar) );
113 for ( i = 0, j = 0; i < len; i++, j++ )
115 if ( str[i] == '\\' || str[i] == '"' )
118 // Basic normalization of strings - replace Linefeed and Carriage returns as blanks.
119 // although allowed in GPX Spec - Viking file format can't handle multi-line strings yet...
120 if ( str[i] == '\n' || str[i] == '\r' )
127 static gchar *deslashndup ( const gchar *str, guint16 len )
129 guint16 i,j, bs_count, new_len;
130 gboolean backslash = FALSE;
136 for ( i = 0, bs_count = 0; i < len; i++ )
137 if ( str[i] == '\\' )
143 if ( str[i-1] == '\\' && (len == 1 || str[i-2] != '\\') )
146 new_len = len - bs_count;
147 rv = g_malloc ( (new_len+1) * sizeof(gchar) );
148 for ( i = 0, j = 0; i < len && j < new_len; i++ )
149 if ( str[i] == '\\' && !backslash )
162 * Returns whether file read was a success
163 * No obvious way to test for a 'gpspoint' file,
164 * thus set a flag if any actual tag found during processing of the file
166 gboolean a_gpspoint_read_file(VikTrwLayer *trw, FILE *f, const gchar *dirpath ) {
167 VikCoordMode coord_mode = vik_trw_layer_get_coord_mode ( trw );
168 gchar *tag_start, *tag_end;
169 g_assert ( f != NULL && trw != NULL );
172 line_newsegment = FALSE;
175 current_track = NULL;
176 gboolean have_read_something = FALSE;
178 while (fgets(line_buffer, 2048, f))
180 gboolean inside_quote = 0;
181 gboolean backslash = 0;
183 line_buffer[strlen(line_buffer)-1] = '\0'; /* chop off newline */
185 /* for gpspoint files wrapped inside */
186 if ( strlen(line_buffer) >= 13 && strncmp ( line_buffer, "~EndLayerData", 13 ) == 0 ) {
187 // Even just a blank TRW is ok when in a .vik file
188 have_read_something = TRUE;
192 /* each line: nullify stuff, make thing if nes, free name if ness */
193 tag_start = line_buffer;
196 /* my addition: find first non-whitespace character. if the null, skip line. */
197 while (*tag_start != '\0' && isspace(*tag_start))
199 if (*tag_start == '\0')
202 if (*tag_start == '#')
207 inside_quote = !inside_quote;
208 while (*tag_end != '\0' && (!isspace(*tag_end) || inside_quote)) {
210 if (*tag_end == '\\' && !backslash)
214 else if (*tag_end == '"')
215 inside_quote = !inside_quote;
218 // Won't have super massively long strings, so potential truncation in cast is acceptable.
219 guint len = (guint)(tag_end - tag_start);
220 gpspoint_process_tag ( tag_start, len );
222 if (*tag_end == '\0' )
225 tag_start = tag_end+1;
227 if (line_type == GPSPOINT_TYPE_WAYPOINT && line_name)
229 have_read_something = TRUE;
230 VikWaypoint *wp = vik_waypoint_new();
231 wp->visible = line_visible;
232 wp->altitude = line_altitude;
233 wp->has_timestamp = line_has_timestamp;
234 wp->timestamp = line_timestamp;
236 vik_coord_load_from_latlon ( &(wp->coord), coord_mode, &line_latlon );
238 vik_trw_layer_filein_add_waypoint ( trw, line_name, wp );
239 g_free ( line_name );
243 vik_waypoint_set_comment ( wp, line_comment );
245 if ( line_description )
246 vik_waypoint_set_description ( wp, line_description );
249 // Ensure the filename is absolute
250 if ( g_path_is_absolute ( line_image ) )
251 vik_waypoint_set_image ( wp, line_image );
253 // Otherwise create the absolute filename from the directory of the .vik file & and the relative filename
254 gchar *full = g_strconcat(dirpath, G_DIR_SEPARATOR_S, line_image, NULL);
255 gchar *absolute = file_realpath_dup ( full ); // resolved into the canonical name
256 vik_waypoint_set_image ( wp, absolute );
263 vik_waypoint_set_symbol ( wp, line_symbol );
265 else if ((line_type == GPSPOINT_TYPE_TRACK || line_type == GPSPOINT_TYPE_ROUTE) && line_name)
267 have_read_something = TRUE;
268 VikTrack *pl = vik_track_new();
269 // NB don't set defaults here as all properties are stored in the GPS_POINT format
270 //vik_track_set_defaults ( pl );
272 /* Thanks to Peter Jones for this Fix */
273 if (!line_name) line_name = g_strdup("UNK");
275 pl->visible = line_visible;
276 pl->is_route = (line_type == GPSPOINT_TYPE_ROUTE);
279 vik_track_set_comment ( pl, line_comment );
281 if ( line_description )
282 vik_track_set_description ( pl, line_description );
286 if ( gdk_color_parse ( line_color, &(pl->color) ) )
287 pl->has_color = TRUE;
290 pl->draw_name_mode = line_name_label;
291 pl->max_number_dist_labels = line_dist_label;
293 pl->trackpoints = NULL;
294 vik_trw_layer_filein_add_track ( trw, line_name, pl );
295 g_free ( line_name );
300 else if ((line_type == GPSPOINT_TYPE_TRACKPOINT || line_type == GPSPOINT_TYPE_ROUTEPOINT) && current_track)
302 have_read_something = TRUE;
303 VikTrackpoint *tp = vik_trackpoint_new();
304 vik_coord_load_from_latlon ( &(tp->coord), coord_mode, &line_latlon );
305 tp->newsegment = line_newsegment;
306 tp->has_timestamp = line_has_timestamp;
307 tp->timestamp = line_timestamp;
308 tp->altitude = line_altitude;
309 vik_trackpoint_set_name ( tp, line_name );
311 tp->speed = line_speed;
312 tp->course = line_course;
313 tp->nsats = line_sat;
314 tp->fix_mode = line_fix;
315 tp->hdop = line_hdop;
316 tp->vdop = line_vdop;
317 tp->pdop = line_pdop;
319 current_track->trackpoints = g_list_append ( current_track->trackpoints, tp );
323 g_free ( line_name );
326 g_free ( line_comment );
327 if (line_description)
328 g_free ( line_description );
330 g_free ( line_color );
332 g_free ( line_image );
334 g_free ( line_symbol );
336 line_description = NULL;
340 line_type = GPSPOINT_TYPE_NONE;
341 line_newsegment = FALSE;
342 line_has_timestamp = FALSE;
344 line_altitude = VIK_DEFAULT_ALTITUDE;
348 line_extended = FALSE;
353 line_hdop = VIK_DEFAULT_DOP;
354 line_vdop = VIK_DEFAULT_DOP;
355 line_pdop = VIK_DEFAULT_DOP;
360 return have_read_something;
363 /* Tag will be of a few defined forms:
369 So we must determine end of tag name, start of value, end of value.
371 static void gpspoint_process_tag ( const gchar *tag, guint len )
373 const gchar *key_end, *value_start, *value_end;
375 /* Searching for key end */
378 while (++key_end - tag < len)
382 if (key_end - tag == len)
383 return; /* no good */
385 if (key_end - tag == len + 1)
386 value_start = value_end = 0; /* size = 0 */
389 value_start = key_end + 1; /* equal_sign plus one */
391 if (*value_start == '"')
394 if (*value_start == '"')
395 value_start = value_end = 0; /* size = 0 */
398 if (*(tag+len-1) == '"')
399 value_end = tag + len - 1;
405 value_end = tag + len; /* value start really IS value start. */
407 // Detect broken lines which end without any text or the enclosing ". i.e. like: comment="
408 if ( (value_end - value_start) < 0 )
411 gpspoint_process_key_and_value(tag, key_end - tag, value_start, value_end - value_start);
416 value = NULL for none
418 static void gpspoint_process_key_and_value ( const gchar *key, guint key_len, const gchar *value, guint value_len )
420 if (key_len == 4 && strncasecmp( key, "type", key_len ) == 0 )
423 line_type = GPSPOINT_TYPE_NONE;
424 else if (value_len == 5 && strncasecmp( value, "track", value_len ) == 0 )
425 line_type = GPSPOINT_TYPE_TRACK;
426 else if (value_len == 10 && strncasecmp( value, "trackpoint", value_len ) == 0 )
427 line_type = GPSPOINT_TYPE_TRACKPOINT;
428 else if (value_len == 8 && strncasecmp( value, "waypoint", value_len ) == 0 )
429 line_type = GPSPOINT_TYPE_WAYPOINT;
430 else if (value_len == 5 && strncasecmp( value, "route", value_len ) == 0 )
431 line_type = GPSPOINT_TYPE_ROUTE;
432 else if (value_len == 10 && strncasecmp( value, "routepoint", value_len ) == 0 )
433 line_type = GPSPOINT_TYPE_ROUTEPOINT;
435 /* all others are ignored */
436 line_type = GPSPOINT_TYPE_NONE;
438 else if (key_len == 4 && strncasecmp( key, "name", key_len ) == 0 && value != NULL)
440 if (line_name == NULL)
442 line_name = deslashndup ( value, value_len );
445 else if (key_len == 7 && strncasecmp( key, "comment", key_len ) == 0 && value != NULL)
447 if (line_comment == NULL)
448 line_comment = deslashndup ( value, value_len );
450 else if (key_len == 11 && strncasecmp( key, "description", key_len ) == 0 && value != NULL)
452 if (line_description == NULL)
453 line_description = deslashndup ( value, value_len );
455 else if (key_len == 5 && strncasecmp( key, "color", key_len ) == 0 && value != NULL)
457 if (line_color == NULL)
458 line_color = deslashndup ( value, value_len );
460 else if (key_len == 14 && strncasecmp( key, "draw_name_mode", key_len ) == 0 && value != NULL)
462 line_name_label = atoi(value);
464 else if (key_len == 18 && strncasecmp( key, "number_dist_labels", key_len ) == 0 && value != NULL)
466 line_dist_label = atoi(value);
468 else if (key_len == 5 && strncasecmp( key, "image", key_len ) == 0 && value != NULL)
470 if (line_image == NULL)
471 line_image = deslashndup ( value, value_len );
473 else if (key_len == 8 && strncasecmp( key, "latitude", key_len ) == 0 && value != NULL)
475 line_latlon.lat = g_ascii_strtod(value, NULL);
477 else if (key_len == 9 && strncasecmp( key, "longitude", key_len ) == 0 && value != NULL)
479 line_latlon.lon = g_ascii_strtod(value, NULL);
481 else if (key_len == 8 && strncasecmp( key, "altitude", key_len ) == 0 && value != NULL)
483 line_altitude = g_ascii_strtod(value, NULL);
485 else if (key_len == 7 && strncasecmp( key, "visible", key_len ) == 0 && value != NULL && value[0] != 'y' && value[0] != 'Y' && value[0] != 't' && value[0] != 'T')
487 line_visible = FALSE;
489 else if (key_len == 6 && strncasecmp( key, "symbol", key_len ) == 0 && value != NULL)
491 line_symbol = g_strndup ( value, value_len );
493 else if (key_len == 8 && strncasecmp( key, "unixtime", key_len ) == 0 && value != NULL)
495 line_timestamp = g_ascii_strtod(value, NULL);
496 if ( line_timestamp != 0x80000000 )
497 line_has_timestamp = TRUE;
499 else if (key_len == 10 && strncasecmp( key, "newsegment", key_len ) == 0 && value != NULL)
501 line_newsegment = TRUE;
503 else if (key_len == 8 && strncasecmp( key, "extended", key_len ) == 0 && value != NULL)
505 line_extended = TRUE;
507 else if (key_len == 5 && strncasecmp( key, "speed", key_len ) == 0 && value != NULL)
509 line_speed = g_ascii_strtod(value, NULL);
511 else if (key_len == 6 && strncasecmp( key, "course", key_len ) == 0 && value != NULL)
513 line_course = g_ascii_strtod(value, NULL);
515 else if (key_len == 3 && strncasecmp( key, "sat", key_len ) == 0 && value != NULL)
517 line_sat = atoi(value);
519 else if (key_len == 3 && strncasecmp( key, "fix", key_len ) == 0 && value != NULL)
521 line_fix = atoi(value);
523 else if (key_len == 4 && strncasecmp( key, "hdop", key_len ) == 0 && value != NULL)
525 line_hdop = g_ascii_strtod(value, NULL);
527 else if (key_len == 4 && strncasecmp( key, "vdop", key_len ) == 0 && value != NULL)
529 line_vdop = g_ascii_strtod(value, NULL);
531 else if (key_len == 4 && strncasecmp( key, "pdop", key_len ) == 0 && value != NULL)
533 line_pdop = g_ascii_strtod(value, NULL);
537 static void a_gpspoint_write_waypoint ( const gpointer id, const VikWaypoint *wp, FILE *f )
539 static struct LatLon ll;
540 gchar *s_lat, *s_lon;
547 vik_coord_to_latlon ( &(wp->coord), &ll );
548 s_lat = a_coords_dtostr(ll.lat);
549 s_lon = a_coords_dtostr(ll.lon);
550 gchar *tmp_name = slashdup(wp->name);
551 fprintf ( f, "type=\"waypoint\" latitude=\"%s\" longitude=\"%s\" name=\"%s\"", s_lat, s_lon, tmp_name );
556 if ( wp->altitude != VIK_DEFAULT_ALTITUDE ) {
557 gchar *s_alt = a_coords_dtostr(wp->altitude);
558 fprintf ( f, " altitude=\"%s\"", s_alt );
561 if ( wp->has_timestamp )
562 fprintf ( f, " unixtime=\"%ld\"", wp->timestamp );
565 gchar *tmp_comment = slashdup(wp->comment);
566 fprintf ( f, " comment=\"%s\"", tmp_comment );
567 g_free ( tmp_comment );
569 if ( wp->description )
571 gchar *tmp_description = slashdup(wp->description);
572 fprintf ( f, " description=\"%s\"", tmp_description );
573 g_free ( tmp_description );
577 gchar *tmp_image = NULL;
579 if ( a_vik_get_file_ref_format() == VIK_FILE_REF_FORMAT_RELATIVE ) {
580 cwd = g_get_current_dir();
582 tmp_image = g_strdup ( file_GetRelativeFilename ( cwd, wp->image ) );
585 // if cwd not available - use image filename as is
586 // this should be an absolute path as set in thumbnails
588 tmp_image = slashdup(wp->image);
591 fprintf ( f, " image=\"%s\"", tmp_image );
594 g_free ( tmp_image );
598 // Due to changes in garminsymbols - the symbol name is now in Title Case
599 // However to keep newly generated .vik files better compatible with older Viking versions
600 // The symbol names will always be lowercase
601 gchar *tmp_symbol = g_utf8_strdown(wp->symbol, -1);
602 fprintf ( f, " symbol=\"%s\"", tmp_symbol );
603 g_free ( tmp_symbol );
606 fprintf ( f, " visible=\"n\"" );
610 static void a_gpspoint_write_trackpoint ( VikTrackpoint *tp, TP_write_info_type *write_info )
612 static struct LatLon ll;
613 gchar *s_lat, *s_lon;
614 vik_coord_to_latlon ( &(tp->coord), &ll );
616 FILE *f = write_info->f;
618 /* TODO: modify a_coords_dtostr() to accept (optional) buffer
619 * instead of doing malloc/free everytime */
620 s_lat = a_coords_dtostr(ll.lat);
621 s_lon = a_coords_dtostr(ll.lon);
622 fprintf ( f, "type=\"%spoint\" latitude=\"%s\" longitude=\"%s\"", write_info->is_route ? "route" : "track", s_lat, s_lon );
627 gchar *name = slashdup(tp->name);
628 fprintf ( f, " name=\"%s\"", name );
632 if ( tp->altitude != VIK_DEFAULT_ALTITUDE ) {
633 gchar *s_alt = a_coords_dtostr(tp->altitude);
634 fprintf ( f, " altitude=\"%s\"", s_alt );
637 if ( tp->has_timestamp )
638 fprintf ( f, " unixtime=\"%ld\"", tp->timestamp );
639 if ( tp->newsegment )
640 fprintf ( f, " newsegment=\"yes\"" );
642 if (!isnan(tp->speed) || !isnan(tp->course) || tp->nsats > 0) {
643 fprintf ( f, " extended=\"yes\"" );
644 if (!isnan(tp->speed)) {
645 gchar *s_speed = a_coords_dtostr(tp->speed);
646 fprintf ( f, " speed=\"%s\"", s_speed );
649 if (!isnan(tp->course)) {
650 gchar *s_course = a_coords_dtostr(tp->course);
651 fprintf ( f, " course=\"%s\"", s_course );
655 fprintf ( f, " sat=\"%d\"", tp->nsats );
656 if (tp->fix_mode > 0)
657 fprintf ( f, " fix=\"%d\"", tp->fix_mode );
659 if ( tp->hdop != VIK_DEFAULT_DOP ) {
660 gchar *ss = a_coords_dtostr(tp->hdop);
661 fprintf ( f, " hdop=\"%s\"", ss );
664 if ( tp->vdop != VIK_DEFAULT_DOP ) {
665 gchar *ss = a_coords_dtostr(tp->vdop);
666 fprintf ( f, " vdop=\"%s\"", ss );
669 if ( tp->pdop != VIK_DEFAULT_DOP ) {
670 gchar *ss = a_coords_dtostr(tp->pdop);
671 fprintf ( f, " pdop=\"%s\"", ss );
679 static void a_gpspoint_write_track ( const gpointer id, const VikTrack *trk, FILE *f )
687 gchar *tmp_name = slashdup(trk->name);
688 fprintf ( f, "type=\"%s\" name=\"%s\"", trk->is_route ? "route" : "track", tmp_name );
691 if ( trk->comment ) {
692 gchar *tmp = slashdup(trk->comment);
693 fprintf ( f, " comment=\"%s\"", tmp );
697 if ( trk->description ) {
698 gchar *tmp = slashdup(trk->description);
699 fprintf ( f, " description=\"%s\"", tmp );
703 if ( trk->has_color ) {
704 fprintf ( f, " color=#%.2x%.2x%.2x", (int)(trk->color.red/256),(int)(trk->color.green/256),(int)(trk->color.blue/256));
707 if ( trk->draw_name_mode > 0 )
708 fprintf ( f, " draw_name_mode=\"%d\"", trk->draw_name_mode );
710 if ( trk->max_number_dist_labels > 0 )
711 fprintf ( f, " number_dist_labels=\"%d\"", trk->max_number_dist_labels );
713 if ( ! trk->visible ) {
714 fprintf ( f, " visible=\"n\"" );
718 TP_write_info_type tp_write_info = { f, trk->is_route };
719 g_list_foreach ( trk->trackpoints, (GFunc) a_gpspoint_write_trackpoint, &tp_write_info );
720 fprintf ( f, "type=\"%send\"\n", trk->is_route ? "route" : "track" );
723 void a_gpspoint_write_file ( VikTrwLayer *trw, FILE *f )
725 GHashTable *tracks = vik_trw_layer_get_tracks ( trw );
726 GHashTable *routes = vik_trw_layer_get_routes ( trw );
727 GHashTable *waypoints = vik_trw_layer_get_waypoints ( trw );
729 fprintf ( f, "type=\"waypointlist\"\n" );
730 g_hash_table_foreach ( waypoints, (GHFunc) a_gpspoint_write_waypoint, f );
731 fprintf ( f, "type=\"waypointlistend\"\n" );
732 g_hash_table_foreach ( tracks, (GHFunc) a_gpspoint_write_track, f );
733 g_hash_table_foreach ( routes, (GHFunc) a_gpspoint_write_track, f );