src/gpx.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2007, Evan Battaglia <gtoevan@gmx.net>
   5  * Copyright (C) 2007, Quy Tonthat <qtonthat@gmail.com>
   6  * Copyright (C) 2008, Hein Ragas <viking@ragas.nl>
   7  * Copyright (C) 2009, Tal B <tal.bav@gmail.com>
   8  * Copyright (c) 2012, Rob Norris <rw_norris@hotmail.com>
   9  *
  10  * Some of the code adapted from GPSBabel 1.2.7
  11  * http://gpsbabel.sf.net/
  12  * Copyright (C) 2002, 2003, 2004, 2005 Robert Lipe, robertlipe@usa.net
  13  *
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program; if not, write to the Free Software
  26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  27  *
  28  */
  29 #ifdef HAVE_CONFIG_H
  30 #include "config.h"
  31 #endif
  32
  33 #define _XOPEN_SOURCE /* glibc2 needs this */
  34
  35 #include "gpx.h"
  36 #include "viking.h"
  37 #include <expat.h>
  38 #ifdef HAVE_STRING_H
  39 #include <string.h>
  40 #endif
  41 #include <glib.h>
  42 #ifdef HAVE_MATH_H
  43 #include <math.h>
  44 #endif
  45 #include <time.h>
  46
  47 typedef enum {
  48         tt_unknown = 0,
  49
  50         tt_gpx,
  51
  52         tt_wpt,
  53         tt_wpt_cmt,
  54         tt_wpt_desc,
  55         tt_wpt_name,
  56         tt_wpt_ele,
  57         tt_wpt_sym,
  58         tt_wpt_link,            /* New in GPX 1.1 */
  59
  60         tt_trk,
  61         tt_trk_cmt,
  62         tt_trk_desc,
  63         tt_trk_name,
  64
  65         tt_rte,
  66
  67         tt_trk_trkseg,
  68         tt_trk_trkseg_trkpt,
  69         tt_trk_trkseg_trkpt_ele,
  70         tt_trk_trkseg_trkpt_time,
  71         /* extended */
  72         tt_trk_trkseg_trkpt_course,
  73         tt_trk_trkseg_trkpt_speed,
  74         tt_trk_trkseg_trkpt_fix,
  75         tt_trk_trkseg_trkpt_sat,
  76
  77         tt_trk_trkseg_trkpt_hdop,
  78         tt_trk_trkseg_trkpt_vdop,
  79         tt_trk_trkseg_trkpt_pdop,
  80
  81         tt_waypoint,
  82         tt_waypoint_coord,
  83         tt_waypoint_name,
  84 } tag_type;
  85
  86 typedef struct tag_mapping {
  87         tag_type tag_type;              /* enum from above for this tag */
  88         const char *tag_name;           /* xpath-ish tag name */
  89 } tag_mapping;
  90
  91 typedef struct {
  92         GpxWritingOptions *options;
  93         FILE *file;
  94 } GpxWritingContext;
  95
  96 /*
  97  * xpath(ish) mappings between full tag paths and internal identifers.
  98  * These appear in the order they appear in the GPX specification.
  99  * If it's not a tag we explictly handle, it doesn't go here.
 100  */
 101
 102 tag_mapping tag_path_map[] = {
 103
 104         { tt_wpt, "/gpx/wpt" },
 105
 106         { tt_waypoint, "/loc/waypoint" },
 107         { tt_waypoint_coord, "/loc/waypoint/coord" },
 108         { tt_waypoint_name, "/loc/waypoint/name" },
 109
 110         { tt_wpt_ele, "/gpx/wpt/ele" },
 111         { tt_wpt_name, "/gpx/wpt/name" },
 112         { tt_wpt_cmt, "/gpx/wpt/cmt" },
 113         { tt_wpt_desc, "/gpx/wpt/desc" },
 114         { tt_wpt_sym, "/gpx/wpt/sym" },
 115         { tt_wpt_sym, "/loc/waypoint/type" },
 116         { tt_wpt_link, "/gpx/wpt/link" },                    /* GPX 1.1 */
 117
 118         { tt_trk, "/gpx/trk" },
 119         { tt_trk_name, "/gpx/trk/name" },
 120         { tt_trk_cmt, "/gpx/trk/cmt" },
 121         { tt_trk_desc, "/gpx/trk/desc" },
 122         { tt_trk_trkseg, "/gpx/trk/trkseg" },
 123         { tt_trk_trkseg_trkpt, "/gpx/trk/trkseg/trkpt" },
 124         { tt_trk_trkseg_trkpt_ele, "/gpx/trk/trkseg/trkpt/ele" },
 125         { tt_trk_trkseg_trkpt_time, "/gpx/trk/trkseg/trkpt/time" },
 126         /* extended */
 127         { tt_trk_trkseg_trkpt_course, "/gpx/trk/trkseg/trkpt/course" },
 128         { tt_trk_trkseg_trkpt_speed, "/gpx/trk/trkseg/trkpt/speed" },
 129         { tt_trk_trkseg_trkpt_fix, "/gpx/trk/trkseg/trkpt/fix" },
 130         { tt_trk_trkseg_trkpt_sat, "/gpx/trk/trkseg/trkpt/sat" },
 131
 132         { tt_trk_trkseg_trkpt_hdop, "/gpx/trk/trkseg/trkpt/hdop" },
 133         { tt_trk_trkseg_trkpt_vdop, "/gpx/trk/trkseg/trkpt/vdop" },
 134         { tt_trk_trkseg_trkpt_pdop, "/gpx/trk/trkseg/trkpt/pdop" },
 135
 136         { tt_rte, "/gpx/rte" },
 137         // NB Route reuses track point feature tags
 138         { tt_trk_name, "/gpx/rte/name" },
 139         { tt_trk_cmt, "/gpx/rte/cmt" },
 140         { tt_trk_desc, "/gpx/rte/desc" },
 141         { tt_trk_trkseg_trkpt, "/gpx/rte/rtept" },
 142         { tt_trk_trkseg_trkpt_ele, "/gpx/rte/rtept/ele" },
 143
 144         {0}
 145 };
 146
 147 static tag_type get_tag(const char *t)
 148 {
 149         tag_mapping *tm;
 150         for (tm = tag_path_map; tm->tag_type != 0; tm++)
 151                 if (0 == strcmp(tm->tag_name, t))
 152                         return tm->tag_type;
 153         return tt_unknown;
 154 }
 155
 156 /******************************************/
 157
 158 tag_type current_tag = tt_unknown;
 159 GString *xpath = NULL;
 160 GString *c_cdata = NULL;
 161
 162 /* current ("c_") objects */
 163 VikTrackpoint *c_tp = NULL;
 164 VikWaypoint *c_wp = NULL;
 165 VikTrack *c_tr = NULL;
 166
 167 gchar *c_wp_name = NULL;
 168 gchar *c_tr_name = NULL;
 169
 170 /* temporary things so we don't have to create them lots of times */
 171 const gchar *c_slat, *c_slon;
 172 struct LatLon c_ll;
 173
 174 /* specialty flags / etc */
 175 gboolean f_tr_newseg;
 176 guint unnamed_waypoints = 0;
 177 guint unnamed_tracks = 0;
 178
 179
 180 static const char *get_attr ( const char **attr, const char *key )
 181 {
 182   while ( *attr ) {
 183     if ( strcmp(*attr,key) == 0 )
 184       return *(attr + 1);
 185     attr += 2;
 186   }
 187   return NULL;
 188 }
 189
 190 static gboolean set_c_ll ( const char **attr )
 191 {
 192   if ( (c_slat = get_attr ( attr, "lat" )) && (c_slon = get_attr ( attr, "lon" )) ) {
 193     c_ll.lat = g_ascii_strtod(c_slat, NULL);
 194     c_ll.lon = g_ascii_strtod(c_slon, NULL);
 195     return TRUE;
 196   }
 197   return FALSE;
 198 }
 199
 200 static void gpx_start(VikTrwLayer *vtl, const char *el, const char **attr)
 201 {
 202   static const gchar *tmp;
 203
 204   g_string_append_c ( xpath, '/' );
 205   g_string_append ( xpath, el );
 206   current_tag = get_tag ( xpath->str );
 207
 208   switch ( current_tag ) {
 209
 210      case tt_wpt:
 211        if ( set_c_ll( attr ) ) {
 212          c_wp = vik_waypoint_new ();
 213          c_wp->visible = TRUE;
 214          if ( get_attr ( attr, "hidden" ) )
 215            c_wp->visible = FALSE;
 216
 217          vik_coord_load_from_latlon ( &(c_wp->coord), vik_trw_layer_get_coord_mode ( vtl ), &c_ll );
 218        }
 219        break;
 220
 221      case tt_trk:
 222      case tt_rte:
 223        c_tr = vik_track_new ();
 224        c_tr->is_route = (current_tag == tt_rte) ? TRUE : FALSE;
 225        c_tr->visible = TRUE;
 226        if ( get_attr ( attr, "hidden" ) )
 227          c_tr->visible = FALSE;
 228        break;
 229
 230      case tt_trk_trkseg:
 231        f_tr_newseg = TRUE;
 232        break;
 233
 234      case tt_trk_trkseg_trkpt:
 235        if ( set_c_ll( attr ) ) {
 236          c_tp = vik_trackpoint_new ();
 237          vik_coord_load_from_latlon ( &(c_tp->coord), vik_trw_layer_get_coord_mode ( vtl ), &c_ll );
 238          if ( f_tr_newseg ) {
 239            c_tp->newsegment = TRUE;
 240            f_tr_newseg = FALSE;
 241          }
 242          c_tr->trackpoints = g_list_append ( c_tr->trackpoints, c_tp );
 243        }
 244        break;
 245
 246      case tt_trk_trkseg_trkpt_ele:
 247      case tt_trk_trkseg_trkpt_time:
 248      case tt_wpt_cmt:
 249      case tt_wpt_desc:
 250      case tt_wpt_name:
 251      case tt_wpt_ele:
 252      case tt_wpt_link:
 253      case tt_trk_cmt:
 254      case tt_trk_desc:
 255      case tt_trk_name:
 256        g_string_erase ( c_cdata, 0, -1 ); /* clear the cdata buffer */
 257        break;
 258
 259      case tt_waypoint:
 260        c_wp = vik_waypoint_new ();
 261        c_wp->visible = TRUE;
 262        break;
 263
 264      case tt_waypoint_coord:
 265        if ( set_c_ll( attr ) )
 266          vik_coord_load_from_latlon ( &(c_wp->coord), vik_trw_layer_get_coord_mode ( vtl ), &c_ll );
 267        break;
 268
 269      case tt_waypoint_name:
 270        if ( ( tmp = get_attr(attr, "id") ) ) {
 271          if ( c_wp_name )
 272            g_free ( c_wp_name );
 273          c_wp_name = g_strdup ( tmp );
 274        }
 275        g_string_erase ( c_cdata, 0, -1 ); /* clear the cdata buffer for description */
 276        break;
 277
 278      default: break;
 279   }
 280 }
 281
 282 static void gpx_end(VikTrwLayer *vtl, const char *el)
 283 {
 284   static GTimeVal tp_time;
 285
 286   g_string_truncate ( xpath, xpath->len - strlen(el) - 1 );
 287
 288   switch ( current_tag ) {
 289
 290      case tt_waypoint:
 291      case tt_wpt:
 292        if ( ! c_wp_name )
 293          c_wp_name = g_strdup_printf("VIKING_WP%d", unnamed_waypoints++);
 294        vik_trw_layer_filein_add_waypoint ( vtl, c_wp_name, c_wp );
 295        g_free ( c_wp_name );
 296        c_wp = NULL;
 297        c_wp_name = NULL;
 298        break;
 299
 300      case tt_trk:
 301      case tt_rte:
 302        if ( ! c_tr_name )
 303          c_tr_name = g_strdup_printf("VIKING_TR%d", unnamed_tracks++);
 304        vik_trw_layer_filein_add_track ( vtl, c_tr_name, c_tr );
 305        g_free ( c_tr_name );
 306        c_tr = NULL;
 307        c_tr_name = NULL;
 308        break;
 309
 310      case tt_wpt_name:
 311        if ( c_wp_name )
 312          g_free ( c_wp_name );
 313        c_wp_name = g_strdup ( c_cdata->str );
 314        g_string_erase ( c_cdata, 0, -1 );
 315        break;
 316
 317      case tt_trk_name:
 318        if ( c_tr_name )
 319          g_free ( c_tr_name );
 320        c_tr_name = g_strdup ( c_cdata->str );
 321        g_string_erase ( c_cdata, 0, -1 );
 322        break;
 323
 324      case tt_wpt_ele:
 325        c_wp->altitude = g_ascii_strtod ( c_cdata->str, NULL );
 326        g_string_erase ( c_cdata, 0, -1 );
 327        break;
 328
 329      case tt_trk_trkseg_trkpt_ele:
 330        c_tp->altitude = g_ascii_strtod ( c_cdata->str, NULL );
 331        g_string_erase ( c_cdata, 0, -1 );
 332        break;
 333
 334      case tt_waypoint_name: /* .loc name is really description. */
 335      case tt_wpt_desc:
 336        vik_waypoint_set_description ( c_wp, c_cdata->str );
 337        g_string_erase ( c_cdata, 0, -1 );
 338        break;
 339
 340      case tt_wpt_cmt:
 341        vik_waypoint_set_comment ( c_wp, c_cdata->str );
 342        g_string_erase ( c_cdata, 0, -1 );
 343        break;
 344
 345      case tt_wpt_link:
 346        vik_waypoint_set_image ( c_wp, c_cdata->str );
 347        g_string_erase ( c_cdata, 0, -1 );
 348        break;
 349
 350      case tt_wpt_sym: {
 351        vik_waypoint_set_symbol ( c_wp, c_cdata->str );
 352        g_string_erase ( c_cdata, 0, -1 );
 353        break;
 354        }
 355
 356      case tt_trk_desc:
 357        vik_track_set_description ( c_tr, c_cdata->str );
 358        g_string_erase ( c_cdata, 0, -1 );
 359        break;
 360
 361      case tt_trk_cmt:
 362        vik_track_set_comment ( c_tr, c_cdata->str );
 363        g_string_erase ( c_cdata, 0, -1 );
 364        break;
 365
 366      case tt_trk_trkseg_trkpt_time:
 367        if ( g_time_val_from_iso8601(c_cdata->str, &tp_time) ) {
 368          c_tp->timestamp = tp_time.tv_sec;
 369          c_tp->has_timestamp = TRUE;
 370        }
 371        g_string_erase ( c_cdata, 0, -1 );
 372        break;
 373
 374      case tt_trk_trkseg_trkpt_course:
 375        c_tp->course = g_ascii_strtod ( c_cdata->str, NULL );
 376        g_string_erase ( c_cdata, 0, -1 );
 377        break;
 378
 379      case tt_trk_trkseg_trkpt_speed:
 380        c_tp->speed = g_ascii_strtod ( c_cdata->str, NULL );
 381        g_string_erase ( c_cdata, 0, -1 );
 382        break;
 383
 384      case tt_trk_trkseg_trkpt_fix:
 385        if (!strcmp("2d", c_cdata->str))
 386          c_tp->fix_mode = VIK_GPS_MODE_2D;
 387        else if (!strcmp("3d", c_cdata->str))
 388          c_tp->fix_mode = VIK_GPS_MODE_3D;
 389        else  /* TODO: more fix modes here */
 390          c_tp->fix_mode = VIK_GPS_MODE_NOT_SEEN;
 391        g_string_erase ( c_cdata, 0, -1 );
 392        break;
 393
 394      case tt_trk_trkseg_trkpt_sat:
 395        c_tp->nsats = atoi ( c_cdata->str );
 396        g_string_erase ( c_cdata, 0, -1 );
 397        break;
 398
 399      case tt_trk_trkseg_trkpt_hdop:
 400        c_tp->hdop = g_strtod ( c_cdata->str, NULL );
 401        g_string_erase ( c_cdata, 0, -1 );
 402        break;
 403
 404      case tt_trk_trkseg_trkpt_vdop:
 405        c_tp->vdop = g_strtod ( c_cdata->str, NULL );
 406        g_string_erase ( c_cdata, 0, -1 );
 407        break;
 408
 409      case tt_trk_trkseg_trkpt_pdop:
 410        c_tp->pdop = g_strtod ( c_cdata->str, NULL );
 411        g_string_erase ( c_cdata, 0, -1 );
 412        break;
 413
 414      default: break;
 415   }
 416
 417   current_tag = get_tag ( xpath->str );
 418 }
 419
 420 static void gpx_cdata(void *dta, const XML_Char *s, int len)
 421 {
 422   switch ( current_tag ) {
 423     case tt_wpt_name:
 424     case tt_trk_name:
 425     case tt_wpt_ele:
 426     case tt_trk_trkseg_trkpt_ele:
 427     case tt_wpt_cmt:
 428     case tt_wpt_desc:
 429     case tt_wpt_sym:
 430     case tt_wpt_link:
 431     case tt_trk_cmt:
 432     case tt_trk_desc:
 433     case tt_trk_trkseg_trkpt_time:
 434     case tt_trk_trkseg_trkpt_course:
 435     case tt_trk_trkseg_trkpt_speed:
 436     case tt_trk_trkseg_trkpt_fix:
 437     case tt_trk_trkseg_trkpt_sat:
 438     case tt_trk_trkseg_trkpt_hdop:
 439     case tt_trk_trkseg_trkpt_vdop:
 440     case tt_trk_trkseg_trkpt_pdop:
 441     case tt_waypoint_name: /* .loc name is really description. */
 442       g_string_append_len ( c_cdata, s, len );
 443       break;
 444
 445     default: break;  /* ignore cdata from other things */
 446   }
 447 }
 448
 449 // make like a "stack" of tag names
 450 // like gpspoint's separated like /gpx/wpt/whatever
 451
 452 gboolean a_gpx_read_file( VikTrwLayer *vtl, FILE *f ) {
 453   XML_Parser parser = XML_ParserCreate(NULL);
 454   int done=0, len;
 455   enum XML_Status status = XML_STATUS_ERROR;
 456
 457   XML_SetElementHandler(parser, (XML_StartElementHandler) gpx_start, (XML_EndElementHandler) gpx_end);
 458   XML_SetUserData(parser, vtl); /* in the future we could remove all global variables */
 459   XML_SetCharacterDataHandler(parser, (XML_CharacterDataHandler) gpx_cdata);
 460
 461   gchar buf[4096];
 462
 463   g_assert ( f != NULL && vtl != NULL );
 464
 465   xpath = g_string_new ( "" );
 466   c_cdata = g_string_new ( "" );
 467
 468   unnamed_waypoints = 0;
 469   unnamed_tracks = 0;
 470
 471   while (!done) {
 472     len = fread(buf, 1, sizeof(buf)-7, f);
 473     done = feof(f) || !len;
 474     status = XML_Parse(parser, buf, len, done);
 475   }
 476
 477   XML_ParserFree (parser);
 478   g_string_free ( xpath, TRUE );
 479   g_string_free ( c_cdata, TRUE );
 480
 481   return status != XML_STATUS_ERROR;
 482 }
 483
 484 /**** entitize from GPSBabel ****/
 485 typedef struct {
 486         const char * text;
 487         const char * entity;
 488         int  not_html;
 489 } entity_types;
 490
 491 static
 492 entity_types stdentities[] =  {
 493         { "&",  "&amp;", 0 },
 494         { "'",  "&apos;", 1 },
 495         { "<",  "&lt;", 0 },
 496         { ">",  "&gt;", 0 },
 497         { "\"", "&quot;", 0 },
 498         { NULL, NULL, 0 }
 499 };
 500
 501 void utf8_to_int( const char *cp, int *bytes, int *value )
 502 {
 503         if ( (*cp & 0xe0) == 0xc0 ) {
 504                 if ( (*(cp+1) & 0xc0) != 0x80 ) goto dodefault;
 505                 *bytes = 2;
 506                 *value = ((*cp & 0x1f) << 6) |
 507                         (*(cp+1) & 0x3f);
 508         }
 509         else if ( (*cp & 0xf0) == 0xe0 ) {
 510                 if ( (*(cp+1) & 0xc0) != 0x80 ) goto dodefault;
 511                 if ( (*(cp+2) & 0xc0) != 0x80 ) goto dodefault;
 512                 *bytes = 3;
 513                 *value = ((*cp & 0x0f) << 12) |
 514                         ((*(cp+1) & 0x3f) << 6) |
 515                         (*(cp+2) & 0x3f);
 516         }
 517         else if ( (*cp & 0xf8) == 0xf0 ) {
 518                 if ( (*(cp+1) & 0xc0) != 0x80 ) goto dodefault;
 519                 if ( (*(cp+2) & 0xc0) != 0x80 ) goto dodefault;
 520                 if ( (*(cp+3) & 0xc0) != 0x80 ) goto dodefault;
 521                 *bytes = 4;
 522                 *value = ((*cp & 0x07) << 18) |
 523                         ((*(cp+1) & 0x3f) << 12) |
 524                         ((*(cp+2) & 0x3f) << 6) |
 525                         (*(cp+3) & 0x3f);
 526         }
 527         else if ( (*cp & 0xfc) == 0xf8 ) {
 528                 if ( (*(cp+1) & 0xc0) != 0x80 ) goto dodefault;
 529                 if ( (*(cp+2) & 0xc0) != 0x80 ) goto dodefault;
 530                 if ( (*(cp+3) & 0xc0) != 0x80 ) goto dodefault;
 531                 if ( (*(cp+4) & 0xc0) != 0x80 ) goto dodefault;
 532                 *bytes = 5;
 533                 *value = ((*cp & 0x03) << 24) |
 534                         ((*(cp+1) & 0x3f) << 18) |
 535                         ((*(cp+2) & 0x3f) << 12) |
 536                         ((*(cp+3) & 0x3f) << 6) |
 537                         (*(cp+4) & 0x3f);
 538         }
 539         else if ( (*cp & 0xfe) == 0xfc ) {
 540                 if ( (*(cp+1) & 0xc0) != 0x80 ) goto dodefault;
 541                 if ( (*(cp+2) & 0xc0) != 0x80 ) goto dodefault;
 542                 if ( (*(cp+3) & 0xc0) != 0x80 ) goto dodefault;
 543                 if ( (*(cp+4) & 0xc0) != 0x80 ) goto dodefault;
 544                 if ( (*(cp+5) & 0xc0) != 0x80 ) goto dodefault;
 545                 *bytes = 6;
 546                 *value = ((*cp & 0x01) << 30) |
 547                         ((*(cp+1) & 0x3f) << 24) |
 548                         ((*(cp+2) & 0x3f) << 18) |
 549                         ((*(cp+3) & 0x3f) << 12) |
 550                         ((*(cp+4) & 0x3f) << 6) |
 551                         (*(cp+5) & 0x3f);
 552         }
 553         else {
 554 dodefault:
 555                 *bytes = 1;
 556                 *value = (unsigned char)*cp;
 557         }
 558 }
 559
 560 static
 561 char *
 562 entitize(const char * str)
 563 {
 564         int elen, ecount, nsecount;
 565         entity_types *ep;
 566         const char * cp;
 567         char * p, * tmp, * xstr;
 568
 569         char tmpsub[20];
 570         int bytes = 0;
 571         int value = 0;
 572         ep = stdentities;
 573         elen = ecount = nsecount = 0;
 574
 575         /* figure # of entity replacements and additional size. */
 576         while (ep->text) {
 577                 cp = str;
 578                 while ((cp = strstr(cp, ep->text)) != NULL) {
 579                         elen += strlen(ep->entity) - strlen(ep->text);
 580                         ecount++;
 581                         cp += strlen(ep->text);
 582                 }
 583                 ep++;
 584         }
 585
 586         /* figure the same for other than standard entities (i.e. anything
 587          * that isn't in the range U+0000 to U+007F */
 588         for ( cp = str; *cp; cp++ ) {
 589                 if ( *cp & 0x80 ) {
 590
 591                         utf8_to_int( cp, &bytes, &value );
 592                         cp += bytes-1;
 593                         elen += sprintf( tmpsub, "&#x%x;", value ) - bytes;
 594                         nsecount++;
 595                 }
 596         }
 597
 598         /* enough space for the whole string plus entity replacements, if any */
 599         tmp = g_malloc((strlen(str) + elen + 1));
 600         strcpy(tmp, str);
 601
 602         /* no entity replacements */
 603         if (ecount == 0 && nsecount == 0)
 604                 return (tmp);
 605
 606         if ( ecount != 0 ) {
 607                 for (ep = stdentities; ep->text; ep++) {
 608                         p = tmp;
 609                         while ((p = strstr(p, ep->text)) != NULL) {
 610                                 elen = strlen(ep->entity);
 611
 612                                 xstr = g_strdup(p + strlen(ep->text));
 613
 614                                 strcpy(p, ep->entity);
 615                                 strcpy(p + elen, xstr);
 616
 617                                 g_free(xstr);
 618
 619                                 p += elen;
 620                         }
 621                 }
 622         }
 623
 624         if ( nsecount != 0 ) {
 625                 p = tmp;
 626                 while (*p) {
 627                         if ( *p & 0x80 ) {
 628                                 utf8_to_int( p, &bytes, &value );
 629                                 if ( p[bytes] ) {
 630                                         xstr = g_strdup( p + bytes );
 631                                 }
 632                                 else {
 633                                         xstr = NULL;
 634                                 }
 635                                 sprintf( p, "&#x%x;", value );
 636                                 p = p+strlen(p);
 637                                 if ( xstr ) {
 638                                         strcpy( p, xstr );
 639                                         g_free(xstr);
 640                                 }
 641                         }
 642                         else {
 643                                 p++;
 644                         }
 645                 }
 646         }
 647         return (tmp);
 648 }
 649 /**** end GPSBabel code ****/
 650
 651 /* export GPX */
 652
 653 static void gpx_write_waypoint ( VikWaypoint *wp, GpxWritingContext *context )
 654 {
 655   // Don't write invisible waypoints when specified
 656   if (context->options && !context->options->hidden && !wp->visible)
 657     return;
 658
 659   FILE *f = context->file;
 660   static struct LatLon ll;
 661   gchar *s_lat,*s_lon;
 662   gchar *tmp;
 663   vik_coord_to_latlon ( &(wp->coord), &ll );
 664   s_lat = a_coords_dtostr( ll.lat );
 665   s_lon = a_coords_dtostr( ll.lon );
 666   // NB 'hidden' is not part of any GPX standard - this appears to be a made up Viking 'extension'
 667   //  luckily most other GPX processing software ignores things they don't understand
 668   fprintf ( f, "<wpt lat=\"%s\" lon=\"%s\"%s>\n",
 669                s_lat, s_lon, wp->visible ? "" : " hidden=\"hidden\"" );
 670   g_free ( s_lat );
 671   g_free ( s_lon );
 672
 673   // Sanity clause
 674   if ( wp->name )
 675     tmp = entitize ( wp->name );
 676   else
 677     tmp = g_strdup ("waypoint");
 678
 679   fprintf ( f, "  <name>%s</name>\n", tmp );
 680   g_free ( tmp);
 681
 682   if ( wp->altitude != VIK_DEFAULT_ALTITUDE )
 683   {
 684     tmp = a_coords_dtostr ( wp->altitude );
 685     fprintf ( f, "  <ele>%s</ele>\n", tmp );
 686     g_free ( tmp );
 687   }
 688   if ( wp->comment )
 689   {
 690     tmp = entitize(wp->comment);
 691     fprintf ( f, "  <cmt>%s</cmt>\n", tmp );
 692     g_free ( tmp );
 693   }
 694   if ( wp->description )
 695   {
 696     tmp = entitize(wp->description);
 697     fprintf ( f, "  <desc>%s</desc>\n", tmp );
 698     g_free ( tmp );
 699   }
 700   if ( wp->image )
 701   {
 702     tmp = entitize(wp->image);
 703     fprintf ( f, "  <link>%s</link>\n", tmp );
 704     g_free ( tmp );
 705   }
 706   if ( wp->symbol )
 707   {
 708     tmp = entitize(wp->symbol);
 709     if ( a_vik_gpx_export_wpt_sym_name ( ) ) {
 710        // Lowercase the symbol name
 711        gchar *tmp2 = g_utf8_strdown ( tmp, -1 );
 712        fprintf ( f, "  <sym>%s</sym>\n",  tmp2 );
 713        g_free ( tmp2 );
 714     }
 715     else
 716       fprintf ( f, "  <sym>%s</sym>\n", tmp);
 717     g_free ( tmp );
 718   }
 719
 720   fprintf ( f, "</wpt>\n" );
 721 }
 722
 723 static void gpx_write_trackpoint ( VikTrackpoint *tp, GpxWritingContext *context )
 724 {
 725   FILE *f = context->file;
 726   static struct LatLon ll;
 727   gchar *s_lat,*s_lon, *s_alt, *s_dop;
 728   gchar *time_iso8601;
 729   vik_coord_to_latlon ( &(tp->coord), &ll );
 730
 731   // No such thing as a rteseg! So make sure we don't put them in
 732   if ( context->options && !context->options->is_route && tp->newsegment )
 733     fprintf ( f, "  </trkseg>\n  <trkseg>\n" );
 734
 735   s_lat = a_coords_dtostr( ll.lat );
 736   s_lon = a_coords_dtostr( ll.lon );
 737   fprintf ( f, "  <%spt lat=\"%s\" lon=\"%s\">\n", (context->options && context->options->is_route) ? "rte" : "trk", s_lat, s_lon );
 738   g_free ( s_lat ); s_lat = NULL;
 739   g_free ( s_lon ); s_lon = NULL;
 740
 741   s_alt = NULL;
 742   if ( tp->altitude != VIK_DEFAULT_ALTITUDE )
 743   {
 744     s_alt = a_coords_dtostr ( tp->altitude );
 745   }
 746   else if ( context->options != NULL && context->options->force_ele )
 747   {
 748     s_alt = a_coords_dtostr ( 0 );
 749   }
 750   if (s_alt != NULL)
 751     fprintf ( f, "    <ele>%s</ele>\n", s_alt );
 752   g_free ( s_alt ); s_alt = NULL;
 753
 754   time_iso8601 = NULL;
 755   if ( tp->has_timestamp ) {
 756     GTimeVal timestamp;
 757     timestamp.tv_sec = tp->timestamp;
 758     timestamp.tv_usec = 0;
 759
 760     time_iso8601 = g_time_val_to_iso8601 ( &timestamp );
 761   }
 762   else if ( context->options != NULL && context->options->force_time )
 763   {
 764     GTimeVal current;
 765     g_get_current_time ( &current );
 766
 767     time_iso8601 = g_time_val_to_iso8601 ( &current );
 768   }
 769   if ( time_iso8601 != NULL )
 770     fprintf ( f, "    <time>%s</time>\n", time_iso8601 );
 771   g_free(time_iso8601);
 772   time_iso8601 = NULL;
 773
 774   if (!isnan(tp->course)) {
 775     gchar *s_course = a_coords_dtostr(tp->course);
 776     fprintf ( f, "    <course>%s</course>\n", s_course );
 777     g_free(s_course);
 778   }
 779   if (!isnan(tp->speed)) {
 780     gchar *s_speed = a_coords_dtostr(tp->speed);
 781     fprintf ( f, "    <speed>%s</speed>\n", s_speed );
 782     g_free(s_speed);
 783   }
 784   if (tp->fix_mode == VIK_GPS_MODE_2D)
 785     fprintf ( f, "    <fix>2d</fix>\n");
 786   if (tp->fix_mode == VIK_GPS_MODE_3D)
 787     fprintf ( f, "    <fix>3d</fix>\n");
 788   if (tp->nsats > 0)
 789     fprintf ( f, "    <sat>%d</sat>\n", tp->nsats );
 790
 791   s_dop = NULL;
 792   if ( tp->hdop != VIK_DEFAULT_DOP )
 793   {
 794     s_dop = a_coords_dtostr ( tp->hdop );
 795   }
 796   if (s_dop != NULL)
 797     fprintf ( f, "    <hdop>%s</hdop>\n", s_dop );
 798   g_free ( s_dop ); s_dop = NULL;
 799
 800   if ( tp->vdop != VIK_DEFAULT_DOP )
 801   {
 802     s_dop = a_coords_dtostr ( tp->vdop );
 803   }
 804   if (s_dop != NULL)
 805     fprintf ( f, "    <vdop>%s</vdop>\n", s_dop );
 806   g_free ( s_dop ); s_dop = NULL;
 807
 808   if ( tp->pdop != VIK_DEFAULT_DOP )
 809   {
 810     s_dop = a_coords_dtostr ( tp->pdop );
 811   }
 812   if (s_dop != NULL)
 813     fprintf ( f, "    <pdop>%s</pdop>\n", s_dop );
 814   g_free ( s_dop ); s_dop = NULL;
 815
 816   fprintf ( f, "  </%spt>\n", (context->options && context->options->is_route) ? "rte" : "trk" );
 817 }
 818
 819
 820 static void gpx_write_track ( VikTrack *t, GpxWritingContext *context )
 821 {
 822   // Don't write invisible tracks when specified
 823   if (context->options && !context->options->hidden && !t->visible)
 824     return;
 825
 826   FILE *f = context->file;
 827   gchar *tmp;
 828   gboolean first_tp_is_newsegment = FALSE; /* must temporarily make it not so, but we want to restore state. not that it matters. */
 829
 830   // Sanity clause
 831   if ( t->name )
 832     tmp = entitize ( t->name );
 833   else
 834     tmp = g_strdup ("track");
 835
 836   // NB 'hidden' is not part of any GPX standard - this appears to be a made up Viking 'extension'
 837   //  luckily most other GPX processing software ignores things they don't understand
 838   fprintf ( f, "<%s%s>\n  <name>%s</name>\n",
 839             t->is_route ? "rte" : "trk",
 840             t->visible ? "" : " hidden=\"hidden\"",
 841             tmp );
 842   g_free ( tmp );
 843
 844   if ( t->comment )
 845   {
 846     tmp = entitize ( t->comment );
 847     fprintf ( f, "  <cmt>%s</cmt>\n", tmp );
 848     g_free ( tmp );
 849   }
 850
 851   if ( t->description )
 852   {
 853     tmp = entitize ( t->description );
 854     fprintf ( f, "  <desc>%s</desc>\n", tmp );
 855     g_free ( tmp );
 856   }
 857
 858   /* No such thing as a rteseg! */
 859   if ( !t->is_route )
 860     fprintf ( f, "  <trkseg>\n" );
 861
 862   if ( t->trackpoints && t->trackpoints->data ) {
 863     first_tp_is_newsegment = VIK_TRACKPOINT(t->trackpoints->data)->newsegment;
 864     VIK_TRACKPOINT(t->trackpoints->data)->newsegment = FALSE; /* so we won't write </trkseg><trkseg> already */
 865     g_list_foreach ( t->trackpoints, (GFunc) gpx_write_trackpoint, context );
 866     VIK_TRACKPOINT(t->trackpoints->data)->newsegment = first_tp_is_newsegment; /* restore state */
 867   }
 868
 869   /* NB apparently no such thing as a rteseg! */
 870   if (!t->is_route)
 871     fprintf ( f, "  </trkseg>\n");
 872
 873   fprintf ( f, "</%s>\n", t->is_route ? "rte" : "trk" );
 874 }
 875
 876 static void gpx_write_header( FILE *f )
 877 {
 878   fprintf(f, "<?xml version=\"1.0\"?>\n"
 879           "<gpx version=\"1.0\" creator=\"Viking -- http://viking.sf.net/\"\n"
 880           "xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n"
 881           "xmlns=\"http://www.topografix.com/GPX/1/0\"\n"
 882           "xsi:schemaLocation=\"http://www.topografix.com/GPX/1/0 http://www.topografix.com/GPX/1/0/gpx.xsd\">\n");
 883 }
 884
 885 static void gpx_write_footer( FILE *f )
 886 {
 887   fprintf(f, "</gpx>\n");
 888 }
 889
 890 static int gpx_waypoint_compare(const void *x, const void *y)
 891 {
 892   VikWaypoint *a = (VikWaypoint *)x;
 893   VikWaypoint *b = (VikWaypoint *)y;
 894   return strcmp(a->name,b->name);
 895 }
 896
 897 static int gpx_track_compare_name(const void *x, const void *y)
 898 {
 899   VikTrack *a = (VikTrack *)x;
 900   VikTrack *b = (VikTrack *)y;
 901   return strcmp(a->name,b->name);
 902 }
 903
 904 /* Function to compare two tracks by their first timestamp */
 905 static int gpx_track_compare_timestamp (const void *x, const void *y)
 906 {
 907   VikTrack *a = (VikTrack *)x;
 908   VikTrack *b = (VikTrack *)y;
 909
 910   VikTrackpoint *tpa = NULL;
 911   VikTrackpoint *tpb = NULL;
 912
 913   if ( a->trackpoints )
 914     tpa = VIK_TRACKPOINT(g_list_first(a->trackpoints)->data);
 915
 916   if ( b->trackpoints )
 917     tpb = VIK_TRACKPOINT(g_list_first(b->trackpoints)->data);
 918
 919   if ( tpa && tpb ) {
 920     if ( tpa->timestamp < tpb->timestamp )
 921       return -1;
 922     if ( tpa->timestamp > tpb->timestamp )
 923       return 1;
 924   }
 925
 926   if ( tpa && !tpb )
 927     return 1;
 928
 929   if ( !tpa && tpb )
 930     return -1;
 931
 932   return 0;
 933 }
 934
 935 void a_gpx_write_file ( VikTrwLayer *vtl, FILE *f, GpxWritingOptions *options )
 936 {
 937   GpxWritingContext context = { options, f };
 938
 939   gpx_write_header ( f );
 940
 941   // gather waypoints in a list, then sort
 942   // g_hash_table_get_values: glib 2.14+
 943   GList *gl = g_hash_table_get_values ( vik_trw_layer_get_waypoints ( vtl ) );
 944   gl = g_list_sort ( gl, gpx_waypoint_compare );
 945
 946   GList *iter;
 947   for (iter = g_list_first (gl); iter != NULL; iter = g_list_next (iter)) {
 948     gpx_write_waypoint ( (VikWaypoint*)iter->data, &context );
 949   }
 950
 951   g_list_free ( gl );
 952
 953   gl = g_hash_table_get_values ( vik_trw_layer_get_tracks ( vtl ) );
 954   // Sort method determined by preference
 955   if ( a_vik_get_gpx_export_trk_sort() == VIK_GPX_EXPORT_TRK_SORT_TIME )
 956     gl = g_list_sort ( gl, gpx_track_compare_timestamp );
 957   else
 958     gl = g_list_sort ( gl, gpx_track_compare_name );
 959
 960   // Routes sorted by name
 961   GList *glrte = g_hash_table_get_values ( vik_trw_layer_get_routes ( vtl ) );
 962   glrte = g_list_sort ( glrte, gpx_track_compare_name );
 963
 964   // g_list_concat doesn't copy memory properly
 965   // so process each list separately
 966
 967   GpxWritingContext context_tmp = context;
 968   GpxWritingOptions opt_tmp = { FALSE, FALSE, FALSE };
 969   // Force trackpoints on tracks
 970   if ( !context.options )
 971     context_tmp.options = &opt_tmp;
 972   context_tmp.options->is_route = FALSE;
 973
 974   // Loop around each list and write each one
 975   for (iter = g_list_first (gl); iter != NULL; iter = g_list_next (iter)) {
 976     gpx_write_track ( (VikTrack*)iter->data, &context_tmp );
 977   }
 978
 979   // Routes (to get routepoints)
 980   context_tmp.options->is_route = TRUE;
 981   for (iter = g_list_first (glrte); iter != NULL; iter = g_list_next (iter)) {
 982     gpx_write_track ( (VikTrack*)iter->data, &context_tmp );
 983   }
 984
 985   g_list_free ( gl );
 986   g_list_free ( glrte );
 987
 988   gpx_write_footer ( f );
 989 }
 990
 991 void a_gpx_write_track_file ( VikTrack *trk, FILE *f, GpxWritingOptions *options )
 992 {
 993   GpxWritingContext context = {options, f};
 994   gpx_write_header ( f );
 995   gpx_write_track ( trk, &context );
 996   gpx_write_footer ( f );
 997 }