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 /* other possible properties go here */
98 static void gpspoint_process_tag ( const gchar *tag, gint len );
99 static void gpspoint_process_key_and_value ( const gchar *key, gint key_len, const gchar *value, gint value_len );
101 static gchar *slashdup(const gchar *str)
103 guint16 len = strlen(str);
104 guint16 need_bs_count, i, j;
106 for ( i = 0, need_bs_count = 0; i < len; i++ )
107 if ( str[i] == '\\' || str[i] == '"' )
109 rv = g_malloc ( (len+need_bs_count+1) * sizeof(gchar) );
110 for ( i = 0, j = 0; i < len; i++, j++ )
112 if ( str[i] == '\\' || str[i] == '"' )
120 static gchar *deslashndup ( const gchar *str, guint16 len )
122 guint16 i,j, bs_count, new_len;
123 gboolean backslash = FALSE;
129 for ( i = 0, bs_count = 0; i < len; i++ )
130 if ( str[i] == '\\' )
136 if ( str[i-1] == '\\' && (len == 1 || str[i-2] != '\\') )
139 new_len = len - bs_count;
140 rv = g_malloc ( (new_len+1) * sizeof(gchar) );
141 for ( i = 0, j = 0; i < len && j < new_len; i++ )
142 if ( str[i] == '\\' && !backslash )
155 * Returns whether file read was a success
156 * No obvious way to test for a 'gpspoint' file,
157 * thus set a flag if any actual tag found during processing of the file
159 gboolean a_gpspoint_read_file(VikTrwLayer *trw, FILE *f, const gchar *dirpath ) {
160 VikCoordMode coord_mode = vik_trw_layer_get_coord_mode ( trw );
161 gchar *tag_start, *tag_end;
162 g_assert ( f != NULL && trw != NULL );
165 line_newsegment = FALSE;
168 current_track = NULL;
169 gboolean have_read_something = FALSE;
171 while (fgets(line_buffer, 2048, f))
173 gboolean inside_quote = 0;
174 gboolean backslash = 0;
176 line_buffer[strlen(line_buffer)-1] = '\0'; /* chop off newline */
178 /* for gpspoint files wrapped inside */
179 if ( strlen(line_buffer) >= 13 && strncmp ( line_buffer, "~EndLayerData", 13 ) == 0 ) {
180 // Even just a blank TRW is ok when in a .vik file
181 have_read_something = TRUE;
185 /* each line: nullify stuff, make thing if nes, free name if ness */
186 tag_start = line_buffer;
189 /* my addition: find first non-whitespace character. if the null, skip line. */
190 while (*tag_start != '\0' && isspace(*tag_start))
192 if (tag_start == '\0')
195 if (*tag_start == '#')
200 inside_quote = !inside_quote;
201 while (*tag_end != '\0' && (!isspace(*tag_end) || inside_quote)) {
203 if (*tag_end == '\\' && !backslash)
207 else if (*tag_end == '"')
208 inside_quote = !inside_quote;
211 gpspoint_process_tag ( tag_start, tag_end - tag_start );
213 if (*tag_end == '\0' )
216 tag_start = tag_end+1;
218 if (line_type == GPSPOINT_TYPE_WAYPOINT && line_name)
220 have_read_something = TRUE;
221 VikWaypoint *wp = vik_waypoint_new();
222 wp->visible = line_visible;
223 wp->altitude = line_altitude;
224 wp->has_timestamp = line_has_timestamp;
225 wp->timestamp = line_timestamp;
227 vik_coord_load_from_latlon ( &(wp->coord), coord_mode, &line_latlon );
229 vik_trw_layer_filein_add_waypoint ( trw, line_name, wp );
230 g_free ( line_name );
234 vik_waypoint_set_comment ( wp, line_comment );
236 if ( line_description )
237 vik_waypoint_set_description ( wp, line_description );
240 // Ensure the filename is absolute
241 if ( g_path_is_absolute ( line_image ) )
242 vik_waypoint_set_image ( wp, line_image );
244 // Otherwise create the absolute filename from the directory of the .vik file & and the relative filename
245 gchar *full = g_strconcat(dirpath, G_DIR_SEPARATOR_S, line_image, NULL);
246 gchar *absolute = file_realpath_dup ( full ); // resolved into the canonical name
247 vik_waypoint_set_image ( wp, absolute );
254 vik_waypoint_set_symbol ( wp, line_symbol );
256 else if ((line_type == GPSPOINT_TYPE_TRACK || line_type == GPSPOINT_TYPE_ROUTE) && line_name)
258 have_read_something = TRUE;
259 VikTrack *pl = vik_track_new();
260 // NB don't set defaults here as all properties are stored in the GPS_POINT format
261 //vik_track_set_defaults ( pl );
263 /* Thanks to Peter Jones for this Fix */
264 if (!line_name) line_name = g_strdup("UNK");
266 pl->visible = line_visible;
267 pl->is_route = (line_type == GPSPOINT_TYPE_ROUTE);
270 vik_track_set_comment ( pl, line_comment );
272 if ( line_description )
273 vik_track_set_description ( pl, line_description );
277 if ( gdk_color_parse ( line_color, &(pl->color) ) )
278 pl->has_color = TRUE;
281 pl->draw_name_mode = line_name_label;
282 pl->max_number_dist_labels = line_dist_label;
284 pl->trackpoints = NULL;
285 vik_trw_layer_filein_add_track ( trw, line_name, pl );
286 g_free ( line_name );
291 else if ((line_type == GPSPOINT_TYPE_TRACKPOINT || line_type == GPSPOINT_TYPE_ROUTEPOINT) && current_track)
293 have_read_something = TRUE;
294 VikTrackpoint *tp = vik_trackpoint_new();
295 vik_coord_load_from_latlon ( &(tp->coord), coord_mode, &line_latlon );
296 tp->newsegment = line_newsegment;
297 tp->has_timestamp = line_has_timestamp;
298 tp->timestamp = line_timestamp;
299 tp->altitude = line_altitude;
300 vik_trackpoint_set_name ( tp, line_name );
302 tp->speed = line_speed;
303 tp->course = line_course;
304 tp->nsats = line_sat;
305 tp->fix_mode = line_fix;
307 current_track->trackpoints = g_list_append ( current_track->trackpoints, tp );
311 g_free ( line_name );
314 g_free ( line_comment );
315 if (line_description)
316 g_free ( line_description );
318 g_free ( line_color );
320 g_free ( line_image );
322 g_free ( line_symbol );
324 line_description = NULL;
328 line_type = GPSPOINT_TYPE_NONE;
329 line_newsegment = FALSE;
330 line_has_timestamp = FALSE;
332 line_altitude = VIK_DEFAULT_ALTITUDE;
336 line_extended = FALSE;
345 return have_read_something;
348 /* Tag will be of a few defined forms:
354 So we must determine end of tag name, start of value, end of value.
356 static void gpspoint_process_tag ( const gchar *tag, gint len )
358 const gchar *key_end, *value_start, *value_end;
360 /* Searching for key end */
363 while (++key_end - tag < len)
367 if (key_end - tag == len)
368 return; /* no good */
370 if (key_end - tag == len + 1)
371 value_start = value_end = 0; /* size = 0 */
374 value_start = key_end + 1; /* equal_sign plus one */
376 if (*value_start == '"')
379 if (*value_start == '"')
380 value_start = value_end = 0; /* size = 0 */
383 if (*(tag+len-1) == '"')
384 value_end = tag + len - 1;
390 value_end = tag + len; /* value start really IS value start. */
392 gpspoint_process_key_and_value(tag, key_end - tag, value_start, value_end - value_start);
397 value = NULL for none
399 static void gpspoint_process_key_and_value ( const gchar *key, gint key_len, const gchar *value, gint value_len )
401 if (key_len == 4 && strncasecmp( key, "type", key_len ) == 0 )
404 line_type = GPSPOINT_TYPE_NONE;
405 else if (value_len == 5 && strncasecmp( value, "track", value_len ) == 0 )
406 line_type = GPSPOINT_TYPE_TRACK;
407 else if (value_len == 10 && strncasecmp( value, "trackpoint", value_len ) == 0 )
408 line_type = GPSPOINT_TYPE_TRACKPOINT;
409 else if (value_len == 8 && strncasecmp( value, "waypoint", value_len ) == 0 )
410 line_type = GPSPOINT_TYPE_WAYPOINT;
411 else if (value_len == 5 && strncasecmp( value, "route", value_len ) == 0 )
412 line_type = GPSPOINT_TYPE_ROUTE;
413 else if (value_len == 10 && strncasecmp( value, "routepoint", value_len ) == 0 )
414 line_type = GPSPOINT_TYPE_ROUTEPOINT;
416 /* all others are ignored */
417 line_type = GPSPOINT_TYPE_NONE;
419 else if (key_len == 4 && strncasecmp( key, "name", key_len ) == 0 && value != NULL)
421 if (line_name == NULL)
423 line_name = deslashndup ( value, value_len );
426 else if (key_len == 7 && strncasecmp( key, "comment", key_len ) == 0 && value != NULL)
428 if (line_comment == NULL)
429 line_comment = deslashndup ( value, value_len );
431 else if (key_len == 11 && strncasecmp( key, "description", key_len ) == 0 && value != NULL)
433 if (line_description == NULL)
434 line_description = deslashndup ( value, value_len );
436 else if (key_len == 5 && strncasecmp( key, "color", key_len ) == 0 && value != NULL)
438 if (line_color == NULL)
439 line_color = deslashndup ( value, value_len );
441 else if (key_len == 14 && strncasecmp( key, "draw_name_mode", key_len ) == 0 && value != NULL)
443 line_name_label = atoi(value);
445 else if (key_len == 18 && strncasecmp( key, "number_dist_labels", key_len ) == 0 && value != NULL)
447 line_dist_label = atoi(value);
449 else if (key_len == 5 && strncasecmp( key, "image", key_len ) == 0 && value != NULL)
451 if (line_image == NULL)
452 line_image = deslashndup ( value, value_len );
454 else if (key_len == 8 && strncasecmp( key, "latitude", key_len ) == 0 && value != NULL)
456 line_latlon.lat = g_ascii_strtod(value, NULL);
458 else if (key_len == 9 && strncasecmp( key, "longitude", key_len ) == 0 && value != NULL)
460 line_latlon.lon = g_ascii_strtod(value, NULL);
462 else if (key_len == 8 && strncasecmp( key, "altitude", key_len ) == 0 && value != NULL)
464 line_altitude = g_ascii_strtod(value, NULL);
466 else if (key_len == 7 && strncasecmp( key, "visible", key_len ) == 0 && value[0] != 'y' && value[0] != 'Y' && value[0] != 't' && value[0] != 'T')
468 line_visible = FALSE;
470 else if (key_len == 6 && strncasecmp( key, "symbol", key_len ) == 0 && value != NULL)
472 line_symbol = g_strndup ( value, value_len );
474 else if (key_len == 8 && strncasecmp( key, "unixtime", key_len ) == 0 && value != NULL)
476 line_timestamp = g_ascii_strtod(value, NULL);
477 if ( line_timestamp != 0x80000000 )
478 line_has_timestamp = TRUE;
480 else if (key_len == 10 && strncasecmp( key, "newsegment", key_len ) == 0 && value != NULL)
482 line_newsegment = TRUE;
484 else if (key_len == 8 && strncasecmp( key, "extended", key_len ) == 0 && value != NULL)
486 line_extended = TRUE;
488 else if (key_len == 5 && strncasecmp( key, "speed", key_len ) == 0 && value != NULL)
490 line_speed = g_ascii_strtod(value, NULL);
492 else if (key_len == 6 && strncasecmp( key, "course", key_len ) == 0 && value != NULL)
494 line_course = g_ascii_strtod(value, NULL);
496 else if (key_len == 3 && strncasecmp( key, "sat", key_len ) == 0 && value != NULL)
498 line_sat = atoi(value);
500 else if (key_len == 3 && strncasecmp( key, "fix", key_len ) == 0 && value != NULL)
502 line_fix = atoi(value);
506 static void a_gpspoint_write_waypoint ( const gpointer id, const VikWaypoint *wp, FILE *f )
508 static struct LatLon ll;
509 gchar *s_lat, *s_lon;
511 if ( wp && !(wp->name) ) {
514 vik_coord_to_latlon ( &(wp->coord), &ll );
515 s_lat = a_coords_dtostr(ll.lat);
516 s_lon = a_coords_dtostr(ll.lon);
517 gchar *tmp_name = slashdup(wp->name);
518 fprintf ( f, "type=\"waypoint\" latitude=\"%s\" longitude=\"%s\" name=\"%s\"", s_lat, s_lon, tmp_name );
523 if ( wp->altitude != VIK_DEFAULT_ALTITUDE ) {
524 gchar *s_alt = a_coords_dtostr(wp->altitude);
525 fprintf ( f, " altitude=\"%s\"", s_alt );
528 if ( wp->has_timestamp )
529 fprintf ( f, " unixtime=\"%ld\"", wp->timestamp );
532 gchar *tmp_comment = slashdup(wp->comment);
533 fprintf ( f, " comment=\"%s\"", tmp_comment );
534 g_free ( tmp_comment );
536 if ( wp->description )
538 gchar *tmp_description = slashdup(wp->description);
539 fprintf ( f, " description=\"%s\"", tmp_description );
540 g_free ( tmp_description );
544 gchar *tmp_image = NULL;
546 if ( a_vik_get_file_ref_format() == VIK_FILE_REF_FORMAT_RELATIVE ) {
547 cwd = g_get_current_dir();
549 tmp_image = g_strdup ( file_GetRelativeFilename ( cwd, wp->image ) );
552 // if cwd not available - use image filename as is
553 // this should be an absolute path as set in thumbnails
555 tmp_image = slashdup(wp->image);
558 fprintf ( f, " image=\"%s\"", tmp_image );
561 g_free ( tmp_image );
565 // Due to changes in garminsymbols - the symbol name is now in Title Case
566 // However to keep newly generated .vik files better compatible with older Viking versions
567 // The symbol names will always be lowercase
568 gchar *tmp_symbol = g_utf8_strdown(wp->symbol, -1);
569 fprintf ( f, " symbol=\"%s\"", tmp_symbol );
570 g_free ( tmp_symbol );
573 fprintf ( f, " visible=\"n\"" );
577 static void a_gpspoint_write_trackpoint ( VikTrackpoint *tp, TP_write_info_type *write_info )
579 static struct LatLon ll;
580 gchar *s_lat, *s_lon;
581 vik_coord_to_latlon ( &(tp->coord), &ll );
583 FILE *f = write_info->f;
585 /* TODO: modify a_coords_dtostr() to accept (optional) buffer
586 * instead of doing malloc/free everytime */
587 s_lat = a_coords_dtostr(ll.lat);
588 s_lon = a_coords_dtostr(ll.lon);
589 fprintf ( f, "type=\"%spoint\" latitude=\"%s\" longitude=\"%s\"", write_info->is_route ? "route" : "track", s_lat, s_lon );
594 gchar *name = slashdup(tp->name);
595 fprintf ( f, " name=\"%s\"", name );
599 if ( tp->altitude != VIK_DEFAULT_ALTITUDE ) {
600 gchar *s_alt = a_coords_dtostr(tp->altitude);
601 fprintf ( f, " altitude=\"%s\"", s_alt );
604 if ( tp->has_timestamp )
605 fprintf ( f, " unixtime=\"%ld\"", tp->timestamp );
606 if ( tp->newsegment )
607 fprintf ( f, " newsegment=\"yes\"" );
609 if (!isnan(tp->speed) || !isnan(tp->course) || tp->nsats > 0) {
610 fprintf ( f, " extended=\"yes\"" );
611 if (!isnan(tp->speed)) {
612 gchar *s_speed = a_coords_dtostr(tp->speed);
613 fprintf ( f, " speed=\"%s\"", s_speed );
616 if (!isnan(tp->course)) {
617 gchar *s_course = a_coords_dtostr(tp->course);
618 fprintf ( f, " course=\"%s\"", s_course );
622 fprintf ( f, " sat=\"%d\"", tp->nsats );
623 if (tp->fix_mode > 0)
624 fprintf ( f, " fix=\"%d\"", tp->fix_mode );
630 static void a_gpspoint_write_track ( const gpointer id, const VikTrack *trk, FILE *f )
638 gchar *tmp_name = slashdup(trk->name);
639 fprintf ( f, "type=\"%s\" name=\"%s\"", trk->is_route ? "route" : "track", tmp_name );
642 if ( trk->comment ) {
643 gchar *tmp = slashdup(trk->comment);
644 fprintf ( f, " comment=\"%s\"", tmp );
648 if ( trk->description ) {
649 gchar *tmp = slashdup(trk->description);
650 fprintf ( f, " description=\"%s\"", tmp );
654 if ( trk->has_color ) {
655 fprintf ( f, " color=#%.2x%.2x%.2x", (int)(trk->color.red/256),(int)(trk->color.green/256),(int)(trk->color.blue/256));
658 if ( trk->draw_name_mode > 0 )
659 fprintf ( f, " draw_name_mode=\"%d\"", trk->draw_name_mode );
661 if ( trk->max_number_dist_labels > 0 )
662 fprintf ( f, " number_dist_labels=\"%d\"", trk->max_number_dist_labels );
664 if ( ! trk->visible ) {
665 fprintf ( f, " visible=\"n\"" );
669 TP_write_info_type tp_write_info = { f, trk->is_route };
670 g_list_foreach ( trk->trackpoints, (GFunc) a_gpspoint_write_trackpoint, &tp_write_info );
671 fprintf ( f, "type=\"%send\"\n", trk->is_route ? "route" : "track" );
674 void a_gpspoint_write_file ( VikTrwLayer *trw, FILE *f )
676 GHashTable *tracks = vik_trw_layer_get_tracks ( trw );
677 GHashTable *routes = vik_trw_layer_get_routes ( trw );
678 GHashTable *waypoints = vik_trw_layer_get_waypoints ( trw );
680 fprintf ( f, "type=\"waypointlist\"\n" );
681 g_hash_table_foreach ( waypoints, (GHFunc) a_gpspoint_write_waypoint, f );
682 fprintf ( f, "type=\"waypointlistend\"\n" );
683 g_hash_table_foreach ( tracks, (GHFunc) a_gpspoint_write_track, f );
684 g_hash_table_foreach ( routes, (GHFunc) a_gpspoint_write_track, f );