src/file.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #include "viking.h"
  23
  24 #include "gpx.h"
  25
  26 #include <string.h>
  27 #include <stdlib.h>
  28
  29 #define TEST_BOOLEAN(str) (! ((str)[0] == '\0' || (str)[0] == '0' || (str)[0] == 'n' || (str)[0] == 'N' || (str)[0] == 'f' || (str)[0] == 'F') )
  30 #define VIK_MAGIC "#VIK"
  31 #define GPX_MAGIC "<?xm"
  32 #define VIK_MAGIC_LEN 4
  33
  34 #ifdef WINDOWS
  35 #define FILE_SEP '\\'
  36 #else
  37 #define FILE_SEP '/'
  38 #endif
  39
  40 typedef struct _Stack Stack;
  41
  42 struct _Stack {
  43   Stack *under;
  44   gpointer *data;
  45 };
  46
  47 static void pop(Stack **stack) {
  48   Stack *tmp = (*stack)->under;
  49   g_free ( *stack );
  50   *stack = tmp;
  51 }
  52
  53 static void push(Stack **stack)
  54 {
  55   Stack *tmp = g_malloc ( sizeof ( Stack ) );
  56   tmp->under = *stack;
  57   *stack = tmp;
  58 }
  59
  60 static gboolean check_magic ( FILE *f, const gchar *magic_number )
  61 {
  62   gchar magic[VIK_MAGIC_LEN];
  63   gboolean rv = FALSE;
  64   gint8 i;
  65   if ( fread(magic, 1, sizeof(magic), f) == sizeof(magic) &&
  66       strncmp(magic, magic_number, sizeof(magic)) == 0 )
  67     rv = TRUE;
  68   for ( i = sizeof(magic)-1; i >= 0; i-- ) /* the ol' pushback */
  69     ungetc(magic[i],f);
  70   return rv;
  71 }
  72
  73
  74 static gboolean str_starts_with ( const gchar *haystack, const gchar *needle, guint16 len_needle, gboolean must_be_longer )
  75 {
  76   if ( strlen(haystack) > len_needle - (!must_be_longer) && strncasecmp ( haystack, needle, len_needle ) == 0 )
  77     return TRUE;
  78   return FALSE;
  79 }
  80
  81 static guint16 layer_type_from_string ( const gchar *str )
  82 {
  83   guint8 i;
  84   for ( i = 0; i < VIK_LAYER_NUM_TYPES; i++ )
  85     if ( strcasecmp ( str, vik_layer_get_interface(i)->name ) == 0 )
  86       return i;
  87   return -1;
  88 }
  89
  90 static void write_layer_params_and_data ( VikLayer *l, FILE *f )
  91 {
  92   VikLayerParam *params = vik_layer_get_interface(l->type)->params;
  93   VikLayerFuncGetParam get_param = vik_layer_get_interface(l->type)->get_param;
  94
  95   fprintf ( f, "name=%s\n", l->name ? l->name : "" );
  96   if ( !l->visible )
  97     fprintf ( f, "visible=f\n" );
  98
  99   if ( params && get_param )
 100   {
 101     VikLayerParamData data;
 102     guint16 i, params_count = vik_layer_get_interface(l->type)->params_count;
 103     for ( i = 0; i < params_count; i++ )
 104     {
 105       data = get_param(l,i);
 106       fprintf ( f, "%s=", params[i].name );
 107       switch ( params[i].type )
 108       {
 109         case VIK_LAYER_PARAM_DOUBLE: {
 110 //          char buf[15]; /* locale independent */
 111 //          fprintf ( f, "%s\n", (char *) g_dtostr (data.d, buf, sizeof (buf)) ); break;
 112             fprintf ( f, "%f\n", data.d );
 113             break;
 114        }
 115         case VIK_LAYER_PARAM_UINT: fprintf ( f, "%d\n", data.u ); break;
 116         case VIK_LAYER_PARAM_INT: fprintf ( f, "%d\n", data.i ); break;
 117         case VIK_LAYER_PARAM_BOOLEAN: fprintf ( f, "%c\n", data.b ? 't' : 'f' ); break;
 118         case VIK_LAYER_PARAM_STRING: fprintf ( f, "%s\n", data.s ); break;
 119         case VIK_LAYER_PARAM_COLOR: fprintf ( f, "#%.2x%.2x%.2x\n", (int)(data.c.red/256),(int)(data.c.green/256),(int)(data.c.blue/256)); break;
 120       }
 121     }
 122   }
 123   if ( vik_layer_get_interface(l->type)->write_file_data )
 124   {
 125     fprintf ( f, "\n\n~LayerData\n" );
 126     vik_layer_get_interface(l->type)->write_file_data ( l, f );
 127     fprintf ( f, "~EndLayerData\n" );
 128   }
 129   /* foreach param:
 130      write param, and get_value, etc.
 131      then run layer data, and that's it.
 132   */
 133 }
 134
 135 static void file_write ( VikAggregateLayer *top, FILE *f, gpointer vp )
 136 {
 137   Stack *stack = NULL;
 138   VikLayer *current_layer;
 139   struct LatLon ll;
 140   gchar *modestring;
 141
 142   push(&stack);
 143   stack->data = (gpointer) vik_aggregate_layer_get_children(VIK_AGGREGATE_LAYER(top));
 144   stack->under = NULL;
 145
 146   /* crazhy CRAZHY */
 147   vik_coord_to_latlon ( vik_viewport_get_center ( VIK_VIEWPORT(vp) ), &ll );
 148
 149   switch ( vik_viewport_get_drawmode ( VIK_VIEWPORT(vp) ) ) {
 150     case VIK_VIEWPORT_DRAWMODE_UTM: modestring = "utm"; break;
 151     case VIK_VIEWPORT_DRAWMODE_EXPEDIA: modestring = "expedia"; break;
 152     case VIK_VIEWPORT_DRAWMODE_GOOGLE: modestring = "google"; break;
 153     case VIK_VIEWPORT_DRAWMODE_KH: modestring = "kh"; break;
 154     default: modestring = "mercator";
 155   }
 156
 157   fprintf ( f, "#VIKING GPS Data file " VIKING_URL "\n\nxmpp=%f\nympp=%f\nlat=%f\nlon=%f\nmode=%s\ncolor=%s\ndrawscale=%s\n",
 158       vik_viewport_get_xmpp ( VIK_VIEWPORT(vp) ), vik_viewport_get_ympp ( VIK_VIEWPORT(vp) ), ll.lat, ll.lon,
 159       modestring, vik_viewport_get_background_color(VIK_VIEWPORT(vp)),
 160       vik_viewport_get_draw_scale(VIK_VIEWPORT(vp)) ? "t" : "f" );
 161
 162   if ( ! VIK_LAYER(top)->visible )
 163     fprintf ( f, "visible=f\n" );
 164
 165   while (stack && stack->data)
 166   {
 167     current_layer = VIK_LAYER(((GList *)stack->data)->data);
 168     fprintf ( f, "\n~Layer %s\n", vik_layer_get_interface(current_layer->type)->name );
 169     write_layer_params_and_data ( current_layer, f );
 170     if ( current_layer->type == VIK_LAYER_AGGREGATE && !vik_aggregate_layer_is_empty(VIK_AGGREGATE_LAYER(current_layer)) )
 171     {
 172       push(&stack);
 173       stack->data = (gpointer) vik_aggregate_layer_get_children(VIK_AGGREGATE_LAYER(current_layer));
 174     }
 175     else if ( current_layer->type == VIK_LAYER_GPS && !vik_gps_layer_is_empty(VIK_GPS_LAYER(current_layer)) )
 176     {
 177       push(&stack);
 178       stack->data = (gpointer) vik_gps_layer_get_children(VIK_GPS_LAYER(current_layer));
 179     }
 180     else
 181     {
 182       stack->data = (gpointer) ((GList *)stack->data)->next;
 183       fprintf ( f, "~EndLayer\n\n" );
 184       while ( stack && (!stack->data) )
 185       {
 186         pop(&stack);
 187         if ( stack )
 188         {
 189           stack->data = (gpointer) ((GList *)stack->data)->next;
 190           fprintf ( f, "~EndLayer\n\n" );
 191         }
 192       }
 193     }
 194   }
 195 /*
 196   get vikaggregatelayer's children (?)
 197   foreach write ALL params,
 198   then layer data (IF function exists)
 199   then endlayer
 200
 201   impl:
 202   stack of layers (LIST) we are working on
 203   when layer->next == NULL ...
 204   we move on.
 205 */
 206 }
 207
 208 static void file_read ( VikAggregateLayer *top, FILE *f, gpointer vp )
 209 {
 210   Stack *stack;
 211   struct LatLon ll = { 0.0, 0.0 };
 212   gchar buffer[4096];
 213   gchar *line;
 214   guint16 len;
 215   long line_num = 0;
 216
 217   VikLayerParam *params; /* for current layer, so we don't have to keep on looking up interface */
 218   guint8 params_count;
 219
 220   push(&stack);
 221   stack->under = NULL;
 222   stack->data = (gpointer) top;
 223
 224   while ( fgets ( buffer, 4096, f ) )
 225   {
 226     line_num++;
 227
 228     line = buffer;
 229     while ( *line == ' ' || *line =='\t' )
 230       line++;
 231
 232     if ( line[0] == '#' )
 233       continue;
 234
 235
 236     len = strlen(line);
 237     if ( len > 0 && line[len-1] == '\n' )
 238       line[--len] = '\0';
 239     if ( len > 0 && line[len-1] == '\r' )
 240       line[--len] = '\0';
 241
 242     if ( len == 0 )
 243       continue;
 244
 245
 246     if ( line[0] == '~' )
 247     {
 248       line++; len--;
 249       if ( *line == '\0' )
 250         continue;
 251       else if ( str_starts_with ( line, "Layer ", 6, TRUE ) )
 252       {
 253         int parent_type = VIK_LAYER(stack->data)->type;
 254         if ( ( ! stack->data ) || ((parent_type != VIK_LAYER_AGGREGATE) && (parent_type != VIK_LAYER_GPS)) )
 255         {
 256           g_warning ( "Line %ld: Layer command inside non-Aggregate Layer (type %d)", line_num, parent_type );
 257           push(&stack); /* inside INVALID layer */
 258           stack->data = NULL;
 259           continue;
 260         }
 261         else
 262         {
 263           gint16 type = layer_type_from_string ( line+6 );
 264           push(&stack);
 265           if ( type == -1 )
 266           {
 267             g_warning ( "Line %ld: Unknown type %s\n", line_num, line+6 );
 268             stack->data = NULL;
 269           }
 270           else if (parent_type == VIK_LAYER_GPS)
 271           {
 272             stack->data = (gpointer) vik_gps_layer_get_a_child(VIK_GPS_LAYER(stack->under->data));
 273             params = vik_layer_get_interface(type)->params;
 274             params_count = vik_layer_get_interface(type)->params_count;
 275           }
 276           else
 277           {
 278             stack->data = (gpointer) vik_layer_create ( type, vp, NULL, FALSE );
 279             params = vik_layer_get_interface(type)->params;
 280             params_count = vik_layer_get_interface(type)->params_count;
 281           }
 282         }
 283       }
 284       else if ( str_starts_with ( line, "EndLayer", 8, FALSE ) )
 285       {
 286         if ( stack->under == NULL )
 287           g_warning ( "Line %ld: Mismatched ~EndLayer command", line_num );
 288         else
 289         {
 290           if ( stack->data && stack->under->data )
 291           {
 292             if (VIK_LAYER(stack->under->data)->type == VIK_LAYER_AGGREGATE) {
 293               vik_aggregate_layer_add_layer ( VIK_AGGREGATE_LAYER(stack->under->data), VIK_LAYER(stack->data) );
 294               vik_layer_post_read ( VIK_LAYER(stack->data), vp );
 295             }
 296             else if (VIK_LAYER(stack->under->data)->type == VIK_LAYER_GPS) {
 297               /* TODO: anything else needs to be done here ? */
 298             }
 299             else
 300               g_warning ( "Line %ld: EndLayer command inside non-Aggregate Layer (type %d)", line_num, VIK_LAYER(stack->data)->type );
 301           }
 302           pop(&stack);
 303         }
 304       }
 305       else if ( str_starts_with ( line, "LayerData", 9, FALSE ) )
 306       {
 307         if ( stack->data && vik_layer_get_interface(VIK_LAYER(stack->data)->type)->read_file_data )
 308           vik_layer_get_interface(VIK_LAYER(stack->data)->type)->read_file_data ( VIK_LAYER(stack->data), f );
 309           /* must read until hits ~EndLayerData */
 310
 311         else
 312         { /* simply skip layer data over */
 313           while ( fgets ( buffer, 4096, f ) )
 314           {
 315             line_num++;
 316
 317             line = buffer;
 318
 319             len = strlen(line);
 320             if ( len > 0 && line[len-1] == '\n' )
 321               line[--len] = '\0';
 322             if ( len > 0 && line[len-1] == '\r' )
 323               line[--len] = '\0';
 324             if ( strcasecmp ( line, "~EndLayerData" ) == 0 )
 325               break;
 326           }
 327           continue;
 328         }
 329       }
 330       else
 331       {
 332         g_warning ( "Line %ld: Unknown tilde command", line_num );
 333       }
 334     }
 335     else
 336     {
 337       gint32 eq_pos = -1;
 338       guint16 i;
 339       if ( ! stack->data )
 340         continue;
 341
 342       for ( i = 0; i < len; i++ )
 343         if ( line[i] == '=' )
 344           eq_pos = i;
 345
 346       if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "xmpp", eq_pos ) == 0) /* "hard coded" params: global & for all layer-types */
 347         vik_viewport_set_xmpp ( VIK_VIEWPORT(vp), strtod ( line+5, NULL ) );
 348       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "ympp", eq_pos ) == 0)
 349         vik_viewport_set_ympp ( VIK_VIEWPORT(vp), strtod ( line+5, NULL ) );
 350       else if ( stack->under == NULL && eq_pos == 3 && strncasecmp ( line, "lat", eq_pos ) == 0 )
 351         ll.lat = strtod ( line+4, NULL );
 352       else if ( stack->under == NULL && eq_pos == 3 && strncasecmp ( line, "lon", eq_pos ) == 0 )
 353         ll.lon = strtod ( line+4, NULL );
 354       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "utm" ) == 0)
 355         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_UTM);
 356       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "expedia" ) == 0)
 357         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_EXPEDIA );
 358       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "google" ) == 0)
 359         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_GOOGLE );
 360       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "kh" ) == 0)
 361         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_KH );
 362       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "mercator" ) == 0)
 363         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_MERCATOR );
 364       else if ( stack->under == NULL && eq_pos == 5 && strncasecmp ( line, "color", eq_pos ) == 0 )
 365         vik_viewport_set_background_color ( VIK_VIEWPORT(vp), line+6 );
 366       else if ( stack->under == NULL && eq_pos == 9 && strncasecmp ( line, "drawscale", eq_pos ) == 0 )
 367         vik_viewport_set_draw_scale ( VIK_VIEWPORT(vp), TEST_BOOLEAN(line+10) );
 368       else if ( stack->under && eq_pos == 4 && strncasecmp ( line, "name", eq_pos ) == 0 )
 369         vik_layer_rename ( VIK_LAYER(stack->data), line+5 );
 370       else if ( eq_pos == 7 && strncasecmp ( line, "visible", eq_pos ) == 0 )
 371         VIK_LAYER(stack->data)->visible = TEST_BOOLEAN(line+8);
 372       else if ( eq_pos != -1 && stack->under )
 373       {
 374         gboolean found_match = FALSE;
 375         /* go thru layer params. if len == eq_pos && starts_with jazz, set it. */
 376         /* also got to check for name and visible. */
 377
 378         if ( ! params )
 379         {
 380           g_warning ( "Line %ld: No options for this kind of layer", line_num );
 381           continue;
 382         }
 383
 384         for ( i = 0; i < params_count; i++ )
 385           if ( strlen(params[i].name) == eq_pos && strncasecmp ( line, params[i].name, eq_pos ) == 0 )
 386           {
 387             VikLayerParamData x;
 388             line += eq_pos+1;
 389             switch ( params[i].type )
 390             {
 391               case VIK_LAYER_PARAM_DOUBLE: x.d = strtod(line, NULL); break;
 392               case VIK_LAYER_PARAM_UINT: x.u = strtoul(line, NULL, 10); break;
 393               case VIK_LAYER_PARAM_INT: x.i = strtol(line, NULL, 10); break;
 394               case VIK_LAYER_PARAM_BOOLEAN: x.b = TEST_BOOLEAN(line); break;
 395               case VIK_LAYER_PARAM_COLOR: memset(&(x.c), 0, sizeof(x.c)); /* default: black */
 396                                           gdk_color_parse ( line, &(x.c) ); break;
 397               default: x.s = line;
 398             }
 399             vik_layer_set_param ( VIK_LAYER(stack->data), i, x, vp );
 400             found_match = TRUE;
 401             break;
 402           }
 403         if ( ! found_match )
 404           g_warning ( "Line %ld: Unknown parameter. Line:\n%s", line_num, line );
 405       }
 406       else
 407         g_warning ( "Line %ld: Invalid parameter or parameter outside of layer.", line_num );
 408     }
 409 /* could be:
 410 [Layer Type=Bla]
 411 [EndLayer]
 412 [LayerData]
 413 name=this
 414 #comment
 415 */
 416   }
 417
 418   while ( stack )
 419   {
 420     if ( stack->under && stack->under->data && stack->data )
 421     {
 422       vik_aggregate_layer_add_layer ( VIK_AGGREGATE_LAYER(stack->under->data), VIK_LAYER(stack->data) );
 423       vik_layer_post_read ( VIK_LAYER(stack->data), vp );
 424     }
 425     pop(&stack);
 426   }
 427
 428   if ( ll.lat != 0.0 || ll.lon != 0.0 )
 429     vik_viewport_set_center_latlon ( VIK_VIEWPORT(vp), &ll );
 430
 431   if ( ( ! VIK_LAYER(top)->visible ) && VIK_LAYER(top)->realized )
 432     vik_treeview_item_set_visible ( VIK_LAYER(top)->vt, &(VIK_LAYER(top)->iter), FALSE );
 433 }
 434
 435 /*
 436 read thru file
 437 if "[Layer Type="
 438   push(&stack)
 439   new default layer of type (str_to_type) (check interface->name)
 440 if "[EndLayer]"
 441   VikLayer *vl = stack->data;
 442   pop(&stack);
 443   vik_aggregate_layer_add_layer(stack->data, vl);
 444 if "[LayerData]"
 445   vik_layer_data ( VIK_LAYER_DATA(stack->data), f, vp );
 446
 447 */
 448
 449 /* ---------------------------------------------------- */
 450
 451 static FILE *xfopen ( const char *fn, const char *mode )
 452 {
 453   if ( strcmp(fn,"-") == 0 )
 454     return stdin;
 455   else
 456     return fopen(fn, "r");
 457 }
 458
 459 static void xfclose ( FILE *f )
 460 {
 461   if ( f != stdin && f != stdout )
 462     fclose ( f );
 463 }
 464
 465 /* 0 on failure, 1 on success (vik file) 2 on success (other file) */
 466 gshort a_file_load ( VikAggregateLayer *top, gpointer vp, const gchar *filename )
 467 {
 468   FILE *f = xfopen ( filename, "r" );
 469
 470   g_assert ( vp );
 471
 472   if ( ! f )
 473     return 0;
 474
 475   if ( check_magic ( f, VIK_MAGIC ) )
 476   {
 477     file_read ( top, f, vp );
 478     if ( f != stdin )
 479       xfclose(f);
 480     return 1;
 481   }
 482   else
 483   {
 484     VikCoord new_center;
 485     VikLayer *vtl = vik_layer_create ( VIK_LAYER_TRW, vp, NULL, FALSE );
 486     vik_layer_rename ( vtl, a_file_basename ( filename ) );
 487
 488     if ( check_magic ( f, GPX_MAGIC ) )
 489       a_gpx_read_file ( VIK_TRW_LAYER(vtl), f );
 490     else
 491      a_gpspoint_read_file ( VIK_TRW_LAYER(vtl), f );
 492
 493     vik_layer_post_read ( vtl, vp );
 494
 495     vik_aggregate_layer_add_layer ( top, vtl );
 496
 497     if ( vik_trw_layer_find_center ( VIK_TRW_LAYER(vtl), &new_center ) )
 498       vik_viewport_set_center_coord ( VIK_VIEWPORT(vp), &new_center );
 499     xfclose(f);
 500     return 2;
 501   }
 502 }
 503
 504 gboolean a_file_save ( VikAggregateLayer *top, gpointer vp, const gchar *filename )
 505 {
 506   FILE *f = fopen(filename, "w");
 507
 508   if ( ! f )
 509     return FALSE;
 510
 511   file_write ( top, f, vp );
 512
 513   fclose(f);
 514
 515   return TRUE;
 516 }
 517
 518
 519 const gchar *a_file_basename ( const gchar *filename )
 520 {
 521   const gchar *t = filename + strlen(filename) - 1;
 522   while ( --t > filename )
 523     if ( *(t-1) == FILE_SEP )
 524       break;
 525   if ( t >= filename )
 526     return t;
 527   return filename;
 528 }
 529
 530 gboolean a_file_export ( VikTrwLayer *vtl, const gchar *filename, gshort file_type )
 531 {
 532   FILE *f = fopen ( filename, "w" );
 533   if ( f )
 534   {
 535     if ( file_type == FILE_TYPE_GPSMAPPER )
 536       a_gpsmapper_write_file ( vtl, f );
 537     else if ( file_type == FILE_TYPE_GPX )
 538       a_gpx_write_file ( vtl, f );
 539     else
 540       a_gpspoint_write_file ( vtl, f );
 541     fclose ( f );
 542     return TRUE;
 543   }
 544   return FALSE;
 545 }