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_source;
80 static gchar *line_color;
81 static gint line_name_label = 0;
82 static gint line_dist_label = 0;
83 static gchar *line_image;
84 static gchar *line_symbol;
85 static gboolean line_newsegment = FALSE;
86 static gboolean line_has_timestamp = FALSE;
87 static time_t line_timestamp = 0;
88 static gdouble line_altitude = VIK_DEFAULT_ALTITUDE;
89 static gboolean line_visible = TRUE;
91 static gboolean line_extended = FALSE;
92 static gdouble line_speed = NAN;
93 static gdouble line_course = NAN;
94 static gint line_sat = 0;
95 static gint line_fix = 0;
96 static gdouble line_hdop = VIK_DEFAULT_DOP;
97 static gdouble line_vdop = VIK_DEFAULT_DOP;
98 static gdouble line_pdop = VIK_DEFAULT_DOP;
99 /* other possible properties go here */
102 static void gpspoint_process_tag ( const gchar *tag, guint len );
103 static void gpspoint_process_key_and_value ( const gchar *key, guint key_len, const gchar *value, guint value_len );
105 static gchar *slashdup(const gchar *str)
107 size_t len = strlen(str);
108 size_t need_bs_count, i, j;
110 for ( i = 0, need_bs_count = 0; i < len; i++ )
111 if ( str[i] == '\\' || str[i] == '"' )
113 rv = g_malloc ( (len+need_bs_count+1) * sizeof(gchar) );
114 for ( i = 0, j = 0; i < len; i++, j++ )
116 if ( str[i] == '\\' || str[i] == '"' )
119 // Basic normalization of strings - replace Linefeed and Carriage returns as blanks.
120 // although allowed in GPX Spec - Viking file format can't handle multi-line strings yet...
121 if ( str[i] == '\n' || str[i] == '\r' )
128 static gchar *deslashndup ( const gchar *str, guint16 len )
130 guint16 i,j, bs_count, new_len;
131 gboolean backslash = FALSE;
137 for ( i = 0, bs_count = 0; i < len; i++ )
138 if ( str[i] == '\\' )
144 if ( str[i-1] == '\\' && (len == 1 || str[i-2] != '\\') )
147 new_len = len - bs_count;
148 rv = g_malloc ( (new_len+1) * sizeof(gchar) );
149 for ( i = 0, j = 0; i < len && j < new_len; i++ )
150 if ( str[i] == '\\' && !backslash )
163 * Returns whether file read was a success
164 * No obvious way to test for a 'gpspoint' file,
165 * thus set a flag if any actual tag found during processing of the file
167 gboolean a_gpspoint_read_file(VikTrwLayer *trw, FILE *f, const gchar *dirpath ) {
168 VikCoordMode coord_mode = vik_trw_layer_get_coord_mode ( trw );
169 gchar *tag_start, *tag_end;
170 g_assert ( f != NULL && trw != NULL );
173 line_newsegment = FALSE;
176 current_track = NULL;
177 gboolean have_read_something = FALSE;
179 while (fgets(line_buffer, 2048, f))
181 gboolean inside_quote = 0;
182 gboolean backslash = 0;
184 line_buffer[strlen(line_buffer)-1] = '\0'; /* chop off newline */
186 /* for gpspoint files wrapped inside */
187 if ( strlen(line_buffer) >= 13 && strncmp ( line_buffer, "~EndLayerData", 13 ) == 0 ) {
188 // Even just a blank TRW is ok when in a .vik file
189 have_read_something = TRUE;
193 /* each line: nullify stuff, make thing if nes, free name if ness */
194 tag_start = line_buffer;
197 /* my addition: find first non-whitespace character. if the null, skip line. */
198 while (*tag_start != '\0' && isspace(*tag_start))
200 if (*tag_start == '\0')
203 if (*tag_start == '#')
208 inside_quote = !inside_quote;
209 while (*tag_end != '\0' && (!isspace(*tag_end) || inside_quote)) {
211 if (*tag_end == '\\' && !backslash)
215 else if (*tag_end == '"')
216 inside_quote = !inside_quote;
219 // Won't have super massively long strings, so potential truncation in cast is acceptable.
220 guint len = (guint)(tag_end - tag_start);
221 gpspoint_process_tag ( tag_start, len );
223 if (*tag_end == '\0' )
226 tag_start = tag_end+1;
228 if (line_type == GPSPOINT_TYPE_WAYPOINT && line_name)
230 have_read_something = TRUE;
231 VikWaypoint *wp = vik_waypoint_new();
232 wp->visible = line_visible;
233 wp->altitude = line_altitude;
234 wp->has_timestamp = line_has_timestamp;
235 wp->timestamp = line_timestamp;
237 vik_coord_load_from_latlon ( &(wp->coord), coord_mode, &line_latlon );
239 vik_trw_layer_filein_add_waypoint ( trw, line_name, wp );
240 g_free ( line_name );
244 vik_waypoint_set_comment ( wp, line_comment );
246 if ( line_description )
247 vik_waypoint_set_description ( wp, line_description );
250 vik_waypoint_set_source ( wp, line_source );
253 // Ensure the filename is absolute
254 if ( g_path_is_absolute ( line_image ) )
255 vik_waypoint_set_image ( wp, line_image );
257 // Otherwise create the absolute filename from the directory of the .vik file & and the relative filename
258 gchar *full = g_strconcat(dirpath, G_DIR_SEPARATOR_S, line_image, NULL);
259 gchar *absolute = file_realpath_dup ( full ); // resolved into the canonical name
260 vik_waypoint_set_image ( wp, absolute );
267 vik_waypoint_set_symbol ( wp, line_symbol );
269 else if ((line_type == GPSPOINT_TYPE_TRACK || line_type == GPSPOINT_TYPE_ROUTE) && line_name)
271 have_read_something = TRUE;
272 VikTrack *pl = vik_track_new();
273 // NB don't set defaults here as all properties are stored in the GPS_POINT format
274 //vik_track_set_defaults ( pl );
276 /* Thanks to Peter Jones for this Fix */
277 if (!line_name) line_name = g_strdup("UNK");
279 pl->visible = line_visible;
280 pl->is_route = (line_type == GPSPOINT_TYPE_ROUTE);
283 vik_track_set_comment ( pl, line_comment );
285 if ( line_description )
286 vik_track_set_description ( pl, line_description );
289 vik_track_set_source ( pl, line_source );
293 if ( gdk_color_parse ( line_color, &(pl->color) ) )
294 pl->has_color = TRUE;
297 pl->draw_name_mode = line_name_label;
298 pl->max_number_dist_labels = line_dist_label;
300 pl->trackpoints = NULL;
301 vik_trw_layer_filein_add_track ( trw, line_name, pl );
302 g_free ( line_name );
307 else if ((line_type == GPSPOINT_TYPE_TRACKPOINT || line_type == GPSPOINT_TYPE_ROUTEPOINT) && current_track)
309 have_read_something = TRUE;
310 VikTrackpoint *tp = vik_trackpoint_new();
311 vik_coord_load_from_latlon ( &(tp->coord), coord_mode, &line_latlon );
312 tp->newsegment = line_newsegment;
313 tp->has_timestamp = line_has_timestamp;
314 tp->timestamp = line_timestamp;
315 tp->altitude = line_altitude;
316 vik_trackpoint_set_name ( tp, line_name );
318 tp->speed = line_speed;
319 tp->course = line_course;
320 tp->nsats = line_sat;
321 tp->fix_mode = line_fix;
322 tp->hdop = line_hdop;
323 tp->vdop = line_vdop;
324 tp->pdop = line_pdop;
326 current_track->trackpoints = g_list_append ( current_track->trackpoints, tp );
330 g_free ( line_name );
333 g_free ( line_comment );
334 if (line_description)
335 g_free ( line_description );
337 g_free ( line_source );
339 g_free ( line_color );
341 g_free ( line_image );
343 g_free ( line_symbol );
345 line_description = NULL;
350 line_type = GPSPOINT_TYPE_NONE;
351 line_newsegment = FALSE;
352 line_has_timestamp = FALSE;
354 line_altitude = VIK_DEFAULT_ALTITUDE;
358 line_extended = FALSE;
363 line_hdop = VIK_DEFAULT_DOP;
364 line_vdop = VIK_DEFAULT_DOP;
365 line_pdop = VIK_DEFAULT_DOP;
370 return have_read_something;
373 /* Tag will be of a few defined forms:
379 So we must determine end of tag name, start of value, end of value.
381 static void gpspoint_process_tag ( const gchar *tag, guint len )
383 const gchar *key_end, *value_start, *value_end;
385 /* Searching for key end */
388 while (++key_end - tag < len)
392 if (key_end - tag == len)
393 return; /* no good */
395 if (key_end - tag == len + 1)
396 value_start = value_end = 0; /* size = 0 */
399 value_start = key_end + 1; /* equal_sign plus one */
401 if (*value_start == '"')
404 if (*value_start == '"')
405 value_start = value_end = 0; /* size = 0 */
408 if (*(tag+len-1) == '"')
409 value_end = tag + len - 1;
415 value_end = tag + len; /* value start really IS value start. */
417 // Detect broken lines which end without any text or the enclosing ". i.e. like: comment="
418 if ( (value_end - value_start) < 0 )
421 gpspoint_process_key_and_value(tag, key_end - tag, value_start, value_end - value_start);
426 value = NULL for none
428 static void gpspoint_process_key_and_value ( const gchar *key, guint key_len, const gchar *value, guint value_len )
430 if (key_len == 4 && strncasecmp( key, "type", key_len ) == 0 )
433 line_type = GPSPOINT_TYPE_NONE;
434 else if (value_len == 5 && strncasecmp( value, "track", value_len ) == 0 )
435 line_type = GPSPOINT_TYPE_TRACK;
436 else if (value_len == 10 && strncasecmp( value, "trackpoint", value_len ) == 0 )
437 line_type = GPSPOINT_TYPE_TRACKPOINT;
438 else if (value_len == 8 && strncasecmp( value, "waypoint", value_len ) == 0 )
439 line_type = GPSPOINT_TYPE_WAYPOINT;
440 else if (value_len == 5 && strncasecmp( value, "route", value_len ) == 0 )
441 line_type = GPSPOINT_TYPE_ROUTE;
442 else if (value_len == 10 && strncasecmp( value, "routepoint", value_len ) == 0 )
443 line_type = GPSPOINT_TYPE_ROUTEPOINT;
445 /* all others are ignored */
446 line_type = GPSPOINT_TYPE_NONE;
448 else if (key_len == 4 && strncasecmp( key, "name", key_len ) == 0 && value != NULL)
450 if (line_name == NULL)
452 line_name = deslashndup ( value, value_len );
455 else if (key_len == 7 && strncasecmp( key, "comment", key_len ) == 0 && value != NULL)
457 if (line_comment == NULL)
458 line_comment = deslashndup ( value, value_len );
460 else if (key_len == 11 && strncasecmp( key, "description", key_len ) == 0 && value != NULL)
462 if (line_description == NULL)
463 line_description = deslashndup ( value, value_len );
465 else if (key_len == 6 && strncasecmp( key, "source", key_len ) == 0 && value != NULL)
467 if (line_source == NULL)
468 line_source = deslashndup ( value, value_len );
470 else if (key_len == 5 && strncasecmp( key, "color", key_len ) == 0 && value != NULL)
472 if (line_color == NULL)
473 line_color = deslashndup ( value, value_len );
475 else if (key_len == 14 && strncasecmp( key, "draw_name_mode", key_len ) == 0 && value != NULL)
477 line_name_label = atoi(value);
479 else if (key_len == 18 && strncasecmp( key, "number_dist_labels", key_len ) == 0 && value != NULL)
481 line_dist_label = atoi(value);
483 else if (key_len == 5 && strncasecmp( key, "image", key_len ) == 0 && value != NULL)
485 if (line_image == NULL)
486 line_image = deslashndup ( value, value_len );
488 else if (key_len == 8 && strncasecmp( key, "latitude", key_len ) == 0 && value != NULL)
490 line_latlon.lat = g_ascii_strtod(value, NULL);
492 else if (key_len == 9 && strncasecmp( key, "longitude", key_len ) == 0 && value != NULL)
494 line_latlon.lon = g_ascii_strtod(value, NULL);
496 else if (key_len == 8 && strncasecmp( key, "altitude", key_len ) == 0 && value != NULL)
498 line_altitude = g_ascii_strtod(value, NULL);
500 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')
502 line_visible = FALSE;
504 else if (key_len == 6 && strncasecmp( key, "symbol", key_len ) == 0 && value != NULL)
506 line_symbol = g_strndup ( value, value_len );
508 else if (key_len == 8 && strncasecmp( key, "unixtime", key_len ) == 0 && value != NULL)
510 line_timestamp = g_ascii_strtod(value, NULL);
511 if ( line_timestamp != 0x80000000 )
512 line_has_timestamp = TRUE;
514 else if (key_len == 10 && strncasecmp( key, "newsegment", key_len ) == 0 && value != NULL)
516 line_newsegment = TRUE;
518 else if (key_len == 8 && strncasecmp( key, "extended", key_len ) == 0 && value != NULL)
520 line_extended = TRUE;
522 else if (key_len == 5 && strncasecmp( key, "speed", key_len ) == 0 && value != NULL)
524 line_speed = g_ascii_strtod(value, NULL);
526 else if (key_len == 6 && strncasecmp( key, "course", key_len ) == 0 && value != NULL)
528 line_course = g_ascii_strtod(value, NULL);
530 else if (key_len == 3 && strncasecmp( key, "sat", key_len ) == 0 && value != NULL)
532 line_sat = atoi(value);
534 else if (key_len == 3 && strncasecmp( key, "fix", key_len ) == 0 && value != NULL)
536 line_fix = atoi(value);
538 else if (key_len == 4 && strncasecmp( key, "hdop", key_len ) == 0 && value != NULL)
540 line_hdop = g_ascii_strtod(value, NULL);
542 else if (key_len == 4 && strncasecmp( key, "vdop", key_len ) == 0 && value != NULL)
544 line_vdop = g_ascii_strtod(value, NULL);
546 else if (key_len == 4 && strncasecmp( key, "pdop", key_len ) == 0 && value != NULL)
548 line_pdop = g_ascii_strtod(value, NULL);
552 static void a_gpspoint_write_waypoint ( const gpointer id, const VikWaypoint *wp, FILE *f )
554 static struct LatLon ll;
555 gchar *s_lat, *s_lon;
562 vik_coord_to_latlon ( &(wp->coord), &ll );
563 s_lat = a_coords_dtostr(ll.lat);
564 s_lon = a_coords_dtostr(ll.lon);
565 gchar *tmp_name = slashdup(wp->name);
566 fprintf ( f, "type=\"waypoint\" latitude=\"%s\" longitude=\"%s\" name=\"%s\"", s_lat, s_lon, tmp_name );
571 if ( wp->altitude != VIK_DEFAULT_ALTITUDE ) {
572 gchar *s_alt = a_coords_dtostr(wp->altitude);
573 fprintf ( f, " altitude=\"%s\"", s_alt );
576 if ( wp->has_timestamp )
577 fprintf ( f, " unixtime=\"%ld\"", wp->timestamp );
580 gchar *tmp_comment = slashdup(wp->comment);
581 fprintf ( f, " comment=\"%s\"", tmp_comment );
582 g_free ( tmp_comment );
584 if ( wp->description )
586 gchar *tmp_description = slashdup(wp->description);
587 fprintf ( f, " description=\"%s\"", tmp_description );
588 g_free ( tmp_description );
592 gchar *tmp_source = slashdup(wp->source);
593 fprintf ( f, " source=\"%s\"", tmp_source );
594 g_free ( tmp_source );
598 gchar *tmp_image = NULL;
600 if ( a_vik_get_file_ref_format() == VIK_FILE_REF_FORMAT_RELATIVE ) {
601 cwd = g_get_current_dir();
603 tmp_image = g_strdup ( file_GetRelativeFilename ( cwd, wp->image ) );
606 // if cwd not available - use image filename as is
607 // this should be an absolute path as set in thumbnails
609 tmp_image = slashdup(wp->image);
612 fprintf ( f, " image=\"%s\"", tmp_image );
615 g_free ( tmp_image );
619 // Due to changes in garminsymbols - the symbol name is now in Title Case
620 // However to keep newly generated .vik files better compatible with older Viking versions
621 // The symbol names will always be lowercase
622 gchar *tmp_symbol = g_utf8_strdown(wp->symbol, -1);
623 fprintf ( f, " symbol=\"%s\"", tmp_symbol );
624 g_free ( tmp_symbol );
627 fprintf ( f, " visible=\"n\"" );
631 static void a_gpspoint_write_trackpoint ( VikTrackpoint *tp, TP_write_info_type *write_info )
633 static struct LatLon ll;
634 gchar *s_lat, *s_lon;
635 vik_coord_to_latlon ( &(tp->coord), &ll );
637 FILE *f = write_info->f;
639 /* TODO: modify a_coords_dtostr() to accept (optional) buffer
640 * instead of doing malloc/free everytime */
641 s_lat = a_coords_dtostr(ll.lat);
642 s_lon = a_coords_dtostr(ll.lon);
643 fprintf ( f, "type=\"%spoint\" latitude=\"%s\" longitude=\"%s\"", write_info->is_route ? "route" : "track", s_lat, s_lon );
648 gchar *name = slashdup(tp->name);
649 fprintf ( f, " name=\"%s\"", name );
653 if ( tp->altitude != VIK_DEFAULT_ALTITUDE ) {
654 gchar *s_alt = a_coords_dtostr(tp->altitude);
655 fprintf ( f, " altitude=\"%s\"", s_alt );
658 if ( tp->has_timestamp )
659 fprintf ( f, " unixtime=\"%ld\"", tp->timestamp );
660 if ( tp->newsegment )
661 fprintf ( f, " newsegment=\"yes\"" );
663 if (!isnan(tp->speed) || !isnan(tp->course) || tp->nsats > 0) {
664 fprintf ( f, " extended=\"yes\"" );
665 if (!isnan(tp->speed)) {
666 gchar *s_speed = a_coords_dtostr(tp->speed);
667 fprintf ( f, " speed=\"%s\"", s_speed );
670 if (!isnan(tp->course)) {
671 gchar *s_course = a_coords_dtostr(tp->course);
672 fprintf ( f, " course=\"%s\"", s_course );
676 fprintf ( f, " sat=\"%d\"", tp->nsats );
677 if (tp->fix_mode > 0)
678 fprintf ( f, " fix=\"%d\"", tp->fix_mode );
680 if ( tp->hdop != VIK_DEFAULT_DOP ) {
681 gchar *ss = a_coords_dtostr(tp->hdop);
682 fprintf ( f, " hdop=\"%s\"", ss );
685 if ( tp->vdop != VIK_DEFAULT_DOP ) {
686 gchar *ss = a_coords_dtostr(tp->vdop);
687 fprintf ( f, " vdop=\"%s\"", ss );
690 if ( tp->pdop != VIK_DEFAULT_DOP ) {
691 gchar *ss = a_coords_dtostr(tp->pdop);
692 fprintf ( f, " pdop=\"%s\"", ss );
700 static void a_gpspoint_write_track ( const gpointer id, const VikTrack *trk, FILE *f )
708 gchar *tmp_name = slashdup(trk->name);
709 fprintf ( f, "type=\"%s\" name=\"%s\"", trk->is_route ? "route" : "track", tmp_name );
712 if ( trk->comment ) {
713 gchar *tmp = slashdup(trk->comment);
714 fprintf ( f, " comment=\"%s\"", tmp );
718 if ( trk->description ) {
719 gchar *tmp = slashdup(trk->description);
720 fprintf ( f, " description=\"%s\"", tmp );
725 gchar *tmp = slashdup(trk->source);
726 fprintf ( f, " source=\"%s\"", tmp );
730 if ( trk->has_color ) {
731 fprintf ( f, " color=#%.2x%.2x%.2x", (int)(trk->color.red/256),(int)(trk->color.green/256),(int)(trk->color.blue/256));
734 if ( trk->draw_name_mode > 0 )
735 fprintf ( f, " draw_name_mode=\"%d\"", trk->draw_name_mode );
737 if ( trk->max_number_dist_labels > 0 )
738 fprintf ( f, " number_dist_labels=\"%d\"", trk->max_number_dist_labels );
740 if ( ! trk->visible ) {
741 fprintf ( f, " visible=\"n\"" );
745 TP_write_info_type tp_write_info = { f, trk->is_route };
746 g_list_foreach ( trk->trackpoints, (GFunc) a_gpspoint_write_trackpoint, &tp_write_info );
747 fprintf ( f, "type=\"%send\"\n", trk->is_route ? "route" : "track" );
750 void a_gpspoint_write_file ( VikTrwLayer *trw, FILE *f )
752 GHashTable *tracks = vik_trw_layer_get_tracks ( trw );
753 GHashTable *routes = vik_trw_layer_get_routes ( trw );
754 GHashTable *waypoints = vik_trw_layer_get_waypoints ( trw );
756 fprintf ( f, "type=\"waypointlist\"\n" );
757 g_hash_table_foreach ( waypoints, (GHFunc) a_gpspoint_write_waypoint, f );
758 fprintf ( f, "type=\"waypointlistend\"\n" );
759 g_hash_table_foreach ( tracks, (GHFunc) a_gpspoint_write_track, f );
760 g_hash_table_foreach ( routes, (GHFunc) a_gpspoint_write_track, f );