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
46 static void a_gpspoint_write_track ( const gpointer id, const VikTrack *t, FILE *f );
47 static void a_gpspoint_write_trackpoint ( VikTrackpoint *tp, TP_write_info_type *write_info );
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! */
62 #define VIKING_LINE_SIZE 4096
63 static char line_buffer[VIKING_LINE_SIZE];
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_source;
80 static gchar *line_xtype;
81 static gchar *line_color;
82 static gint line_name_label = 0;
83 static gint line_dist_label = 0;
84 static gchar *line_image;
85 static gchar *line_symbol;
86 static gboolean line_newsegment = FALSE;
87 static gboolean line_has_timestamp = FALSE;
88 static time_t line_timestamp = 0;
89 static gdouble line_altitude = VIK_DEFAULT_ALTITUDE;
90 static gboolean line_visible = TRUE;
92 static gboolean line_extended = FALSE;
93 static gdouble line_speed = NAN;
94 static gdouble line_course = NAN;
95 static gint line_sat = 0;
96 static gint line_fix = 0;
97 static gdouble line_hdop = VIK_DEFAULT_DOP;
98 static gdouble line_vdop = VIK_DEFAULT_DOP;
99 static gdouble line_pdop = VIK_DEFAULT_DOP;
100 /* other possible properties go here */
103 static void gpspoint_process_tag ( const gchar *tag, guint len );
104 static void gpspoint_process_key_and_value ( const gchar *key, guint key_len, const gchar *value, guint value_len );
106 static gchar *slashdup(const gchar *str)
108 size_t len = strlen(str);
109 size_t need_bs_count, i, j;
111 for ( i = 0, need_bs_count = 0; i < len; i++ )
112 if ( str[i] == '\\' || str[i] == '"' )
114 rv = g_malloc ( (len+need_bs_count+1) * sizeof(gchar) );
115 for ( i = 0, j = 0; i < len; i++, j++ )
117 if ( str[i] == '\\' || str[i] == '"' )
120 // Basic normalization of strings - replace Linefeed and Carriage returns as blanks.
121 // although allowed in GPX Spec - Viking file format can't handle multi-line strings yet...
122 if ( str[i] == '\n' || str[i] == '\r' )
129 static gchar *deslashndup ( const gchar *str, guint16 len )
131 guint16 i,j, bs_count, new_len;
132 gboolean backslash = FALSE;
138 for ( i = 0, bs_count = 0; i < len; i++ )
139 if ( str[i] == '\\' )
145 if ( str[i-1] == '\\' && (len == 1 || str[i-2] != '\\') )
148 new_len = len - bs_count;
149 rv = g_malloc ( (new_len+1) * sizeof(gchar) );
150 for ( i = 0, j = 0; i < len && j < new_len; i++ )
151 if ( str[i] == '\\' && !backslash )
164 * Returns whether file read was a success
165 * No obvious way to test for a 'gpspoint' file,
166 * thus set a flag if any actual tag found during processing of the file
168 gboolean a_gpspoint_read_file(VikTrwLayer *trw, FILE *f, const gchar *dirpath ) {
169 VikCoordMode coord_mode = vik_trw_layer_get_coord_mode ( trw );
170 gchar *tag_start, *tag_end;
171 g_assert ( f != NULL && trw != NULL );
174 line_newsegment = FALSE;
177 current_track = NULL;
178 gboolean have_read_something = FALSE;
180 while (fgets(line_buffer, VIKING_LINE_SIZE, f))
182 gboolean inside_quote = 0;
183 gboolean backslash = 0;
185 line_buffer[strlen(line_buffer)-1] = '\0'; /* chop off newline */
187 /* for gpspoint files wrapped inside */
188 if ( strlen(line_buffer) >= 13 && strncmp ( line_buffer, "~EndLayerData", 13 ) == 0 ) {
189 // Even just a blank TRW is ok when in a .vik file
190 have_read_something = TRUE;
194 /* each line: nullify stuff, make thing if nes, free name if ness */
195 tag_start = line_buffer;
198 /* my addition: find first non-whitespace character. if the null, skip line. */
199 while (*tag_start != '\0' && isspace(*tag_start))
201 if (*tag_start == '\0')
204 if (*tag_start == '#')
209 inside_quote = !inside_quote;
210 while (*tag_end != '\0' && (!isspace(*tag_end) || inside_quote)) {
212 if (*tag_end == '\\' && !backslash)
216 else if (*tag_end == '"')
217 inside_quote = !inside_quote;
220 // Won't have super massively long strings, so potential truncation in cast is acceptable.
221 guint len = (guint)(tag_end - tag_start);
222 gpspoint_process_tag ( tag_start, len );
224 if (*tag_end == '\0' )
227 tag_start = tag_end+1;
229 if (line_type == GPSPOINT_TYPE_WAYPOINT && line_name)
231 have_read_something = TRUE;
232 VikWaypoint *wp = vik_waypoint_new();
233 wp->visible = line_visible;
234 wp->altitude = line_altitude;
235 wp->has_timestamp = line_has_timestamp;
236 wp->timestamp = line_timestamp;
238 vik_coord_load_from_latlon ( &(wp->coord), coord_mode, &line_latlon );
240 vik_trw_layer_filein_add_waypoint ( trw, line_name, wp );
241 g_free ( line_name );
245 vik_waypoint_set_comment ( wp, line_comment );
247 if ( line_description )
248 vik_waypoint_set_description ( wp, line_description );
251 vik_waypoint_set_source ( wp, line_source );
254 vik_waypoint_set_type ( wp, line_xtype );
257 gchar *fn = util_make_absolute_filename ( line_image, dirpath );
258 vik_waypoint_set_image ( wp, fn ? fn : line_image );
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 );
285 vik_track_set_source ( pl, line_source );
288 vik_track_set_type ( pl, line_xtype );
292 if ( gdk_color_parse ( line_color, &(pl->color) ) )
293 pl->has_color = TRUE;
296 pl->draw_name_mode = line_name_label;
297 pl->max_number_dist_labels = line_dist_label;
299 pl->trackpoints = NULL;
300 vik_trw_layer_filein_add_track ( trw, line_name, pl );
301 g_free ( line_name );
306 else if ((line_type == GPSPOINT_TYPE_TRACKPOINT || line_type == GPSPOINT_TYPE_ROUTEPOINT) && current_track)
308 have_read_something = TRUE;
309 VikTrackpoint *tp = vik_trackpoint_new();
310 vik_coord_load_from_latlon ( &(tp->coord), coord_mode, &line_latlon );
311 tp->newsegment = line_newsegment;
312 tp->has_timestamp = line_has_timestamp;
313 tp->timestamp = line_timestamp;
314 tp->altitude = line_altitude;
315 vik_trackpoint_set_name ( tp, line_name );
317 tp->speed = line_speed;
318 tp->course = line_course;
319 tp->nsats = line_sat;
320 tp->fix_mode = line_fix;
321 tp->hdop = line_hdop;
322 tp->vdop = line_vdop;
323 tp->pdop = line_pdop;
325 current_track->trackpoints = g_list_append ( current_track->trackpoints, tp );
329 g_free ( line_name );
332 g_free ( line_comment );
333 if (line_description)
334 g_free ( line_description );
336 g_free ( line_source );
338 g_free ( line_xtype );
340 g_free ( line_color );
342 g_free ( line_image );
344 g_free ( line_symbol );
346 line_description = NULL;
352 line_type = GPSPOINT_TYPE_NONE;
353 line_newsegment = FALSE;
354 line_has_timestamp = FALSE;
356 line_altitude = VIK_DEFAULT_ALTITUDE;
360 line_extended = FALSE;
365 line_hdop = VIK_DEFAULT_DOP;
366 line_vdop = VIK_DEFAULT_DOP;
367 line_pdop = VIK_DEFAULT_DOP;
372 return have_read_something;
375 /* Tag will be of a few defined forms:
381 So we must determine end of tag name, start of value, end of value.
383 static void gpspoint_process_tag ( const gchar *tag, guint len )
385 const gchar *key_end, *value_start, *value_end;
387 /* Searching for key end */
390 while (++key_end - tag < len)
394 if (key_end - tag == len)
395 return; /* no good */
397 if (key_end - tag == len + 1)
398 value_start = value_end = 0; /* size = 0 */
401 value_start = key_end + 1; /* equal_sign plus one */
403 if (*value_start == '"')
406 if (*value_start == '"')
407 value_start = value_end = 0; /* size = 0 */
410 if (*(tag+len-1) == '"')
411 value_end = tag + len - 1;
417 value_end = tag + len; /* value start really IS value start. */
419 // Detect broken lines which end without any text or the enclosing ". i.e. like: comment="
420 if ( (value_end - value_start) < 0 )
423 gpspoint_process_key_and_value(tag, key_end - tag, value_start, value_end - value_start);
428 value = NULL for none
430 static void gpspoint_process_key_and_value ( const gchar *key, guint key_len, const gchar *value, guint value_len )
432 if (key_len == 4 && strncasecmp( key, "type", key_len ) == 0 )
435 line_type = GPSPOINT_TYPE_NONE;
436 else if (value_len == 5 && strncasecmp( value, "track", value_len ) == 0 )
437 line_type = GPSPOINT_TYPE_TRACK;
438 else if (value_len == 10 && strncasecmp( value, "trackpoint", value_len ) == 0 )
439 line_type = GPSPOINT_TYPE_TRACKPOINT;
440 else if (value_len == 8 && strncasecmp( value, "waypoint", value_len ) == 0 )
441 line_type = GPSPOINT_TYPE_WAYPOINT;
442 else if (value_len == 5 && strncasecmp( value, "route", value_len ) == 0 )
443 line_type = GPSPOINT_TYPE_ROUTE;
444 else if (value_len == 10 && strncasecmp( value, "routepoint", value_len ) == 0 )
445 line_type = GPSPOINT_TYPE_ROUTEPOINT;
447 /* all others are ignored */
448 line_type = GPSPOINT_TYPE_NONE;
450 else if (key_len == 4 && strncasecmp( key, "name", key_len ) == 0 && value != NULL)
452 if (line_name == NULL)
454 line_name = deslashndup ( value, value_len );
457 else if (key_len == 7 && strncasecmp( key, "comment", key_len ) == 0 && value != NULL)
459 if (line_comment == NULL)
460 line_comment = deslashndup ( value, value_len );
462 else if (key_len == 11 && strncasecmp( key, "description", key_len ) == 0 && value != NULL)
464 if (line_description == NULL)
465 line_description = deslashndup ( value, value_len );
467 else if (key_len == 6 && strncasecmp( key, "source", key_len ) == 0 && value != NULL)
469 if (line_source == NULL)
470 line_source = deslashndup ( value, value_len );
472 // NB using 'xtype' to differentiate from our own 'type' key
473 else if (key_len == 5 && strncasecmp( key, "xtype", key_len ) == 0 && value != NULL)
475 if (line_xtype == NULL)
476 line_xtype = deslashndup ( value, value_len );
478 else if (key_len == 5 && strncasecmp( key, "color", key_len ) == 0 && value != NULL)
480 if (line_color == NULL)
481 line_color = deslashndup ( value, value_len );
483 else if (key_len == 14 && strncasecmp( key, "draw_name_mode", key_len ) == 0 && value != NULL)
485 line_name_label = atoi(value);
487 else if (key_len == 18 && strncasecmp( key, "number_dist_labels", key_len ) == 0 && value != NULL)
489 line_dist_label = atoi(value);
491 else if (key_len == 5 && strncasecmp( key, "image", key_len ) == 0 && value != NULL)
493 if (line_image == NULL)
494 line_image = deslashndup ( value, value_len );
496 else if (key_len == 8 && strncasecmp( key, "latitude", key_len ) == 0 && value != NULL)
498 line_latlon.lat = g_ascii_strtod(value, NULL);
500 else if (key_len == 9 && strncasecmp( key, "longitude", key_len ) == 0 && value != NULL)
502 line_latlon.lon = g_ascii_strtod(value, NULL);
504 else if (key_len == 8 && strncasecmp( key, "altitude", key_len ) == 0 && value != NULL)
506 line_altitude = g_ascii_strtod(value, NULL);
508 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')
510 line_visible = FALSE;
512 else if (key_len == 6 && strncasecmp( key, "symbol", key_len ) == 0 && value != NULL)
514 line_symbol = g_strndup ( value, value_len );
516 else if (key_len == 8 && strncasecmp( key, "unixtime", key_len ) == 0 && value != NULL)
518 line_timestamp = g_ascii_strtod(value, NULL);
519 if ( line_timestamp != 0x80000000 )
520 line_has_timestamp = TRUE;
522 else if (key_len == 10 && strncasecmp( key, "newsegment", key_len ) == 0 && value != NULL)
524 line_newsegment = TRUE;
526 else if (key_len == 8 && strncasecmp( key, "extended", key_len ) == 0 && value != NULL)
528 line_extended = TRUE;
530 else if (key_len == 5 && strncasecmp( key, "speed", key_len ) == 0 && value != NULL)
532 line_speed = g_ascii_strtod(value, NULL);
534 else if (key_len == 6 && strncasecmp( key, "course", key_len ) == 0 && value != NULL)
536 line_course = g_ascii_strtod(value, NULL);
538 else if (key_len == 3 && strncasecmp( key, "sat", key_len ) == 0 && value != NULL)
540 line_sat = atoi(value);
542 else if (key_len == 3 && strncasecmp( key, "fix", key_len ) == 0 && value != NULL)
544 line_fix = atoi(value);
546 else if (key_len == 4 && strncasecmp( key, "hdop", key_len ) == 0 && value != NULL)
548 line_hdop = g_ascii_strtod(value, NULL);
550 else if (key_len == 4 && strncasecmp( key, "vdop", key_len ) == 0 && value != NULL)
552 line_vdop = g_ascii_strtod(value, NULL);
554 else if (key_len == 4 && strncasecmp( key, "pdop", key_len ) == 0 && value != NULL)
556 line_pdop = g_ascii_strtod(value, NULL);
562 const gchar *dirpath;
565 static void a_gpspoint_write_waypoint ( const gpointer id, const VikWaypoint *wp, WritingContext *wc )
568 gchar s_lat[COORDS_STR_BUFFER_SIZE];
569 gchar s_lon[COORDS_STR_BUFFER_SIZE];
580 vik_coord_to_latlon ( &(wp->coord), &ll );
581 a_coords_dtostr_buffer ( ll.lat, s_lat );
582 a_coords_dtostr_buffer ( ll.lon, s_lon );
583 gchar *tmp_name = slashdup(wp->name);
584 fprintf ( f, "type=\"waypoint\" latitude=\"%s\" longitude=\"%s\" name=\"%s\"", s_lat, s_lon, tmp_name );
587 if ( wp->altitude != VIK_DEFAULT_ALTITUDE ) {
588 gchar s_alt[COORDS_STR_BUFFER_SIZE];
589 a_coords_dtostr_buffer ( wp->altitude, s_alt );
590 fprintf ( f, " altitude=\"%s\"", s_alt );
592 if ( wp->has_timestamp )
593 fprintf ( f, " unixtime=\"%ld\"", wp->timestamp );
596 gchar *tmp_comment = slashdup(wp->comment);
597 fprintf ( f, " comment=\"%s\"", tmp_comment );
598 g_free ( tmp_comment );
600 if ( wp->description )
602 gchar *tmp_description = slashdup(wp->description);
603 fprintf ( f, " description=\"%s\"", tmp_description );
604 g_free ( tmp_description );
608 gchar *tmp_source = slashdup(wp->source);
609 fprintf ( f, " source=\"%s\"", tmp_source );
610 g_free ( tmp_source );
614 gchar *tmp_type = slashdup(wp->type);
615 fprintf ( f, " xtype=\"%s\"", tmp_type );
620 gchar *tmp_image = NULL;
621 if ( a_vik_get_file_ref_format() == VIK_FILE_REF_FORMAT_RELATIVE ) {
623 tmp_image = g_strdup ( file_GetRelativeFilename ( (gchar*)wc->dirpath, wp->image ) );
626 // if tmp_image not available - use image filename as is
627 // this should be an absolute path as set in thumbnails
629 tmp_image = slashdup(wp->image);
632 fprintf ( f, " image=\"%s\"", tmp_image );
634 g_free ( tmp_image );
638 // Due to changes in garminsymbols - the symbol name is now in Title Case
639 // However to keep newly generated .vik files better compatible with older Viking versions
640 // The symbol names will always be lowercase
641 gchar *tmp_symbol = g_utf8_strdown(wp->symbol, -1);
642 fprintf ( f, " symbol=\"%s\"", tmp_symbol );
643 g_free ( tmp_symbol );
646 fprintf ( f, " visible=\"n\"" );
650 static void a_gpspoint_write_trackpoint ( VikTrackpoint *tp, TP_write_info_type *write_info )
653 gchar s_lat[COORDS_STR_BUFFER_SIZE];
654 gchar s_lon[COORDS_STR_BUFFER_SIZE];
655 gchar s_alt[COORDS_STR_BUFFER_SIZE];
656 vik_coord_to_latlon ( &(tp->coord), &ll );
658 FILE *f = write_info->f;
660 a_coords_dtostr_buffer ( ll.lat, s_lat );
661 a_coords_dtostr_buffer ( ll.lon, s_lon );
662 fprintf ( f, "type=\"%spoint\" latitude=\"%s\" longitude=\"%s\"", write_info->is_route ? "route" : "track", s_lat, s_lon );
665 gchar *name = slashdup(tp->name);
666 fprintf ( f, " name=\"%s\"", name );
670 if ( tp->altitude != VIK_DEFAULT_ALTITUDE ) {
671 a_coords_dtostr_buffer ( tp->altitude, s_alt );
672 fprintf ( f, " altitude=\"%s\"", s_alt );
674 if ( tp->has_timestamp )
675 fprintf ( f, " unixtime=\"%ld\"", tp->timestamp );
676 if ( tp->newsegment )
677 fprintf ( f, " newsegment=\"yes\"" );
679 if (!isnan(tp->speed) || !isnan(tp->course) || tp->nsats > 0) {
680 fprintf ( f, " extended=\"yes\"" );
681 if (!isnan(tp->speed)) {
682 gchar s_speed[COORDS_STR_BUFFER_SIZE];
683 a_coords_dtostr_buffer ( tp->speed, s_speed );
684 fprintf ( f, " speed=\"%s\"", s_speed );
686 if (!isnan(tp->course)) {
687 gchar s_course[COORDS_STR_BUFFER_SIZE];
688 a_coords_dtostr_buffer ( tp->course, s_course );
689 fprintf ( f, " course=\"%s\"", s_course );
692 fprintf ( f, " sat=\"%d\"", tp->nsats );
693 if (tp->fix_mode > 0)
694 fprintf ( f, " fix=\"%d\"", tp->fix_mode );
696 if ( tp->hdop != VIK_DEFAULT_DOP ) {
697 gchar ss[COORDS_STR_BUFFER_SIZE];
698 a_coords_dtostr_buffer ( tp->hdop, ss );
699 fprintf ( f, " hdop=\"%s\"", ss );
701 if ( tp->vdop != VIK_DEFAULT_DOP ) {
702 gchar ss[COORDS_STR_BUFFER_SIZE];
703 a_coords_dtostr_buffer ( tp->vdop, ss );
704 fprintf ( f, " vdop=\"%s\"", ss );
706 if ( tp->pdop != VIK_DEFAULT_DOP ) {
707 gchar ss[COORDS_STR_BUFFER_SIZE];
708 a_coords_dtostr_buffer ( tp->pdop, ss );
709 fprintf ( f, " pdop=\"%s\"", ss );
716 static void a_gpspoint_write_track ( const gpointer id, const VikTrack *trk, FILE *f )
724 gchar *tmp_name = slashdup(trk->name);
725 fprintf ( f, "type=\"%s\" name=\"%s\"", trk->is_route ? "route" : "track", tmp_name );
728 if ( trk->comment ) {
729 gchar *tmp = slashdup(trk->comment);
730 fprintf ( f, " comment=\"%s\"", tmp );
734 if ( trk->description ) {
735 gchar *tmp = slashdup(trk->description);
736 fprintf ( f, " description=\"%s\"", tmp );
741 gchar *tmp = slashdup(trk->source);
742 fprintf ( f, " source=\"%s\"", tmp );
747 gchar *tmp = slashdup(trk->type);
748 fprintf ( f, " xtype=\"%s\"", tmp );
752 if ( trk->has_color ) {
753 fprintf ( f, " color=#%.2x%.2x%.2x", (int)(trk->color.red/256),(int)(trk->color.green/256),(int)(trk->color.blue/256));
756 if ( trk->draw_name_mode > 0 )
757 fprintf ( f, " draw_name_mode=\"%d\"", trk->draw_name_mode );
759 if ( trk->max_number_dist_labels > 0 )
760 fprintf ( f, " number_dist_labels=\"%d\"", trk->max_number_dist_labels );
762 if ( ! trk->visible ) {
763 fprintf ( f, " visible=\"n\"" );
767 TP_write_info_type tp_write_info = { f, trk->is_route };
768 g_list_foreach ( trk->trackpoints, (GFunc) a_gpspoint_write_trackpoint, &tp_write_info );
769 fprintf ( f, "type=\"%send\"\n", trk->is_route ? "route" : "track" );
772 void a_gpspoint_write_file ( VikTrwLayer *trw, FILE *f, const gchar *dirpath )
774 GHashTable *tracks = vik_trw_layer_get_tracks ( trw );
775 GHashTable *routes = vik_trw_layer_get_routes ( trw );
776 GHashTable *waypoints = vik_trw_layer_get_waypoints ( trw );
778 WritingContext wc = { f, dirpath };
779 fprintf ( f, "type=\"waypointlist\"\n" );
780 g_hash_table_foreach ( waypoints, (GHFunc) a_gpspoint_write_waypoint, &wc );
781 fprintf ( f, "type=\"waypointlistend\"\n" );
782 g_hash_table_foreach ( tracks, (GHFunc) a_gpspoint_write_track, f );
783 g_hash_table_foreach ( routes, (GHFunc) a_gpspoint_write_track, f );