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: fprintf ( f, "%f\n", data.d ); break;
 110         case VIK_LAYER_PARAM_UINT: fprintf ( f, "%d\n", data.u ); break;
 111         case VIK_LAYER_PARAM_INT: fprintf ( f, "%d\n", data.i ); break;
 112         case VIK_LAYER_PARAM_BOOLEAN: fprintf ( f, "%c\n", data.b ? 't' : 'f' ); break;
 113         case VIK_LAYER_PARAM_STRING: fprintf ( f, "%s\n", data.s ); break;
 114         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;
 115       }
 116     }
 117   }
 118   if ( vik_layer_get_interface(l->type)->write_file_data )
 119   {
 120     fprintf ( f, "\n\n~LayerData\n" );
 121     vik_layer_get_interface(l->type)->write_file_data ( l, f );
 122     fprintf ( f, "~EndLayerData\n" );
 123   }
 124   /* foreach param:
 125      write param, and get_value, etc.
 126      then run layer data, and that's it.
 127   */
 128 }
 129
 130 static void file_write ( VikAggregateLayer *top, FILE *f, gpointer vp )
 131 {
 132   Stack *stack = NULL;
 133   VikLayer *current_layer;
 134   struct LatLon ll;
 135   gchar *modestring;
 136
 137   push(&stack);
 138   stack->data = (gpointer) vik_aggregate_layer_get_children(VIK_AGGREGATE_LAYER(top));
 139   stack->under = NULL;
 140
 141   /* crazhy CRAZHY */
 142   vik_coord_to_latlon ( vik_viewport_get_center ( VIK_VIEWPORT(vp) ), &ll );
 143
 144   switch ( vik_viewport_get_drawmode ( VIK_VIEWPORT(vp) ) ) {
 145     case VIK_VIEWPORT_DRAWMODE_UTM: modestring = "utm"; break;
 146     case VIK_VIEWPORT_DRAWMODE_EXPEDIA: modestring = "expedia"; break;
 147     case VIK_VIEWPORT_DRAWMODE_GOOGLE: modestring = "google"; break;
 148     case VIK_VIEWPORT_DRAWMODE_KH: modestring = "kh"; break;
 149     default: modestring = "mercator";
 150   }
 151
 152   fprintf ( f, "#VIKING GPS Data file http://gpsmaps.org/viking/\n\nxmpp=%f\nympp=%f\nlat=%f\nlon=%f\nmode=%s\ncolor=%s\n",
 153       vik_viewport_get_xmpp ( VIK_VIEWPORT(vp) ), vik_viewport_get_ympp ( VIK_VIEWPORT(vp) ), ll.lat, ll.lon,
 154       modestring, vik_viewport_get_background_color(VIK_VIEWPORT(vp)) );
 155
 156   if ( ! VIK_LAYER(top)->visible )
 157     fprintf ( f, "visible=f\n" );
 158
 159   while (stack && stack->data)
 160   {
 161     current_layer = VIK_LAYER(((GList *)stack->data)->data);
 162     fprintf ( f, "\n~Layer %s\n", vik_layer_get_interface(current_layer->type)->name );
 163     write_layer_params_and_data ( current_layer, f );
 164     if ( current_layer->type == VIK_LAYER_AGGREGATE && !vik_aggregate_layer_is_empty(VIK_AGGREGATE_LAYER(current_layer)) )
 165     {
 166       push(&stack);
 167       stack->data = (gpointer) vik_aggregate_layer_get_children(VIK_AGGREGATE_LAYER(current_layer));
 168     }
 169     else
 170     {
 171       stack->data = (gpointer) ((GList *)stack->data)->next;
 172       fprintf ( f, "~EndLayer\n\n" );
 173       while ( stack && (!stack->data) )
 174       {
 175         pop(&stack);
 176         if ( stack )
 177         {
 178           stack->data = (gpointer) ((GList *)stack->data)->next;
 179           fprintf ( f, "~EndLayer\n\n" );
 180         }
 181       }
 182     }
 183   }
 184 /*
 185   get vikaggregatelayer's children (?)
 186   foreach write ALL params,
 187   then layer data (IF function exists)
 188   then endlayer
 189
 190   impl:
 191   stack of layers (LIST) we are working on
 192   when layer->next == NULL ...
 193   we move on.
 194 */
 195 }
 196
 197 static void file_read ( VikAggregateLayer *top, FILE *f, gpointer vp )
 198 {
 199   Stack *stack;
 200   struct LatLon ll = { 0.0, 0.0 };
 201   gchar buffer[4096];
 202   gchar *line;
 203   guint16 len;
 204   long line_num = 0;
 205
 206   VikLayerParam *params; /* for current layer, so we don't have to keep on looking up interface */
 207   guint8 params_count;
 208
 209   push(&stack);
 210   stack->under = NULL;
 211   stack->data = (gpointer) top;
 212
 213   while ( fgets ( buffer, 4096, f ) )
 214   {
 215     line_num++;
 216
 217     line = buffer;
 218     while ( *line == ' ' || *line =='\t' )
 219       line++;
 220
 221     if ( line[0] == '#' )
 222       continue;
 223
 224
 225     len = strlen(line);
 226     if ( len > 0 && line[len-1] == '\n' )
 227       line[--len] = '\0';
 228     if ( len > 0 && line[len-1] == '\r' )
 229       line[--len] = '\0';
 230
 231     if ( len == 0 )
 232       continue;
 233
 234
 235     if ( line[0] == '~' )
 236     {
 237       line++; len--;
 238       if ( *line == '\0' )
 239         continue;
 240       else if ( str_starts_with ( line, "Layer ", 6, TRUE ) )
 241       {
 242         if ( ( ! stack->data ) || VIK_LAYER(stack->data)->type != VIK_LAYER_AGGREGATE )
 243         {
 244           g_warning ( "Line %ld: Layer command inside non-Aggregate Layer", line_num );
 245           push(&stack); /* inside INVALID layer */
 246           stack->data = NULL;
 247           continue;
 248         }
 249         else
 250         {
 251           gint16 type = layer_type_from_string ( line+6 );
 252           push(&stack);
 253           if ( type == -1 )
 254           {
 255             g_warning ( "Line %ld: Unknown type %s\n", line_num, line+6 );
 256             stack->data = NULL;
 257           }
 258           else
 259           {
 260             stack->data = (gpointer) vik_layer_create ( type, vp, NULL, FALSE );
 261             params = vik_layer_get_interface(type)->params;
 262             params_count = vik_layer_get_interface(type)->params_count;
 263           }
 264         }
 265       }
 266       else if ( str_starts_with ( line, "EndLayer", 8, FALSE ) )
 267       {
 268         if ( stack->under == NULL )
 269           g_warning ( "Line %ld: Mismatched ~EndLayer command", line_num );
 270         else
 271         {
 272           if ( stack->data && stack->under->data )
 273           {
 274             vik_aggregate_layer_add_layer ( VIK_AGGREGATE_LAYER(stack->under->data), VIK_LAYER(stack->data) );
 275             vik_layer_post_read ( VIK_LAYER(stack->data), vp );
 276           }
 277           pop(&stack);
 278         }
 279       }
 280       else if ( str_starts_with ( line, "LayerData", 9, FALSE ) )
 281       {
 282         if ( stack->data && vik_layer_get_interface(VIK_LAYER(stack->data)->type)->read_file_data )
 283           vik_layer_get_interface(VIK_LAYER(stack->data)->type)->read_file_data ( VIK_LAYER(stack->data), f );
 284           /* must read until hits ~EndLayerData */
 285
 286         else
 287         { /* simply skip layer data over */
 288           while ( fgets ( buffer, 4096, f ) )
 289           {
 290             line_num++;
 291
 292             line = buffer;
 293
 294             len = strlen(line);
 295             if ( len > 0 && line[len-1] == '\n' )
 296               line[--len] = '\0';
 297             if ( len > 0 && line[len-1] == '\r' )
 298               line[--len] = '\0';
 299             if ( strcasecmp ( line, "~EndLayerData" ) == 0 )
 300               break;
 301           }
 302           continue;
 303         }
 304       }
 305       else
 306       {
 307         g_warning ( "Line %ld: Unknown tilde command", line_num );
 308       }
 309     }
 310     else
 311     {
 312       gint32 eq_pos = -1;
 313       guint16 i;
 314       if ( ! stack->data )
 315         continue;
 316
 317       for ( i = 0; i < len; i++ )
 318         if ( line[i] == '=' )
 319           eq_pos = i;
 320
 321       if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "xmpp", eq_pos ) == 0) /* "hard coded" params: global & for all layer-types */
 322         vik_viewport_set_xmpp ( VIK_VIEWPORT(vp), strtod ( line+5, NULL ) );
 323       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "ympp", eq_pos ) == 0)
 324         vik_viewport_set_ympp ( VIK_VIEWPORT(vp), strtod ( line+5, NULL ) );
 325       else if ( stack->under == NULL && eq_pos == 3 && strncasecmp ( line, "lat", eq_pos ) == 0 )
 326         ll.lat = strtod ( line+4, NULL );
 327       else if ( stack->under == NULL && eq_pos == 3 && strncasecmp ( line, "lon", eq_pos ) == 0 )
 328         ll.lon = strtod ( line+4, NULL );
 329       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "utm" ) == 0)
 330         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_UTM);
 331       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "expedia" ) == 0)
 332         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_EXPEDIA );
 333       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "google" ) == 0)
 334         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_GOOGLE );
 335       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "kh" ) == 0)
 336         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_KH );
 337       else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "mercator" ) == 0)
 338         vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_MERCATOR );
 339       else if ( stack->under == NULL && eq_pos == 5 && strncasecmp ( line, "color", eq_pos ) == 0 )
 340         vik_viewport_set_background_color ( VIK_VIEWPORT(vp), line+6 );
 341       else if ( stack->under && eq_pos == 4 && strncasecmp ( line, "name", eq_pos ) == 0 )
 342         vik_layer_rename ( VIK_LAYER(stack->data), line+5 );
 343       else if ( eq_pos == 7 && strncasecmp ( line, "visible", eq_pos ) == 0 )
 344         VIK_LAYER(stack->data)->visible = TEST_BOOLEAN(line+8);
 345       else if ( eq_pos != -1 && stack->under )
 346       {
 347         gboolean found_match = FALSE;
 348         /* go thru layer params. if len == eq_pos && starts_with jazz, set it. */
 349         /* also got to check for name and visible. */
 350
 351         if ( ! params )
 352         {
 353           g_warning ( "Line %ld: No options for this kind of layer", line_num );
 354           continue;
 355         }
 356
 357         for ( i = 0; i < params_count; i++ )
 358           if ( strlen(params[i].name) == eq_pos && strncasecmp ( line, params[i].name, eq_pos ) == 0 )
 359           {
 360             VikLayerParamData x;
 361             line += eq_pos+1;
 362             switch ( params[i].type )
 363             {
 364               case VIK_LAYER_PARAM_DOUBLE: x.d = strtod(line, NULL); break;
 365               case VIK_LAYER_PARAM_UINT: x.u = strtoul(line, NULL, 10); break;
 366               case VIK_LAYER_PARAM_INT: x.i = strtol(line, NULL, 10); break;
 367               case VIK_LAYER_PARAM_BOOLEAN: x.b = TEST_BOOLEAN(line); break;
 368               case VIK_LAYER_PARAM_COLOR: memset(&(x.c), 0, sizeof(x.c)); /* default: black */
 369                                           gdk_color_parse ( line, &(x.c) ); break;
 370               default: x.s = line;
 371             }
 372             vik_layer_set_param ( VIK_LAYER(stack->data), i, x, vp );
 373             found_match = TRUE;
 374             break;
 375           }
 376         if ( ! found_match )
 377           g_warning ( "Line %ld: Unknown parameter", line_num );
 378       }
 379       else
 380         g_warning ( "Line %ld: Invalid parameter or parameter outside of layer.", line_num );
 381     }
 382 /* could be:
 383 [Layer Type=Bla]
 384 [EndLayer]
 385 [LayerData]
 386 name=this
 387 #comment
 388 */
 389   }
 390
 391   while ( stack )
 392   {
 393     if ( stack->under && stack->under->data && stack->data )
 394     {
 395       vik_aggregate_layer_add_layer ( VIK_AGGREGATE_LAYER(stack->under->data), VIK_LAYER(stack->data) );
 396       vik_layer_post_read ( VIK_LAYER(stack->data), vp );
 397     }
 398     pop(&stack);
 399   }
 400
 401   if ( ll.lat != 0.0 || ll.lon != 0.0 )
 402     vik_viewport_set_center_latlon ( VIK_VIEWPORT(vp), &ll );
 403
 404   if ( ( ! VIK_LAYER(top)->visible ) && VIK_LAYER(top)->realized )
 405     vik_treeview_item_set_visible ( VIK_LAYER(top)->vt, &(VIK_LAYER(top)->iter), FALSE );
 406 }
 407
 408 /*
 409 read thru file
 410 if "[Layer Type="
 411   push(&stack)
 412   new default layer of type (str_to_type) (check interface->name)
 413 if "[EndLayer]"
 414   VikLayer *vl = stack->data;
 415   pop(&stack);
 416   vik_aggregate_layer_add_layer(stack->data, vl);
 417 if "[LayerData]"
 418   vik_layer_data ( VIK_LAYER_DATA(stack->data), f, vp );
 419
 420 */
 421
 422 /* ---------------------------------------------------- */
 423
 424 static FILE *xfopen ( const char *fn, const char *mode )
 425 {
 426   if ( strcmp(fn,"-") == 0 )
 427     return stdin;
 428   else
 429     return fopen(fn, "r");
 430 }
 431
 432 static void xfclose ( FILE *f )
 433 {
 434   if ( f != stdin && f != stdout )
 435     fclose ( f );
 436 }
 437
 438 /* 0 on failure, 1 on success (vik file) 2 on success (other file) */
 439 gshort a_file_load ( VikAggregateLayer *top, gpointer vp, const gchar *filename )
 440 {
 441   FILE *f = xfopen ( filename, "r" );
 442
 443   g_assert ( vp );
 444
 445   if ( ! f )
 446     return 0;
 447
 448   if ( check_magic ( f, VIK_MAGIC ) )
 449   {
 450     file_read ( top, f, vp );
 451     if ( f != stdin )
 452       xfclose(f);
 453     return 1;
 454   }
 455   else
 456   {
 457     VikCoord new_center;
 458     VikLayer *vtl = vik_layer_create ( VIK_LAYER_TRW, vp, NULL, FALSE );
 459     vik_layer_rename ( vtl, a_file_basename ( filename ) );
 460
 461     if ( check_magic ( f, GPX_MAGIC ) )
 462       a_gpx_read_file ( VIK_TRW_LAYER(vtl), f );
 463     else
 464      a_gpspoint_read_file ( VIK_TRW_LAYER(vtl), f );
 465
 466     vik_layer_post_read ( vtl, vp );
 467
 468     vik_aggregate_layer_add_layer ( top, vtl );
 469
 470     if ( vik_trw_layer_find_center ( VIK_TRW_LAYER(vtl), &new_center ) )
 471       vik_viewport_set_center_coord ( VIK_VIEWPORT(vp), &new_center );
 472     xfclose(f);
 473     return 2;
 474   }
 475 }
 476
 477 gboolean a_file_save ( VikAggregateLayer *top, gpointer vp, const gchar *filename )
 478 {
 479   FILE *f = fopen(filename, "w");
 480
 481   if ( ! f )
 482     return FALSE;
 483
 484   file_write ( top, f, vp );
 485
 486   fclose(f);
 487
 488   return TRUE;
 489 }
 490
 491
 492 const gchar *a_file_basename ( const gchar *filename )
 493 {
 494   const gchar *t = filename + strlen(filename) - 1;
 495   while ( --t > filename )
 496     if ( *(t-1) == FILE_SEP )
 497       break;
 498   if ( t >= filename )
 499     return t;
 500   return filename;
 501 }
 502
 503 gboolean a_file_export ( VikTrwLayer *vtl, const gchar *filename, gshort file_type )
 504 {
 505   FILE *f = fopen ( filename, "w" );
 506   if ( f )
 507   {
 508     if ( file_type == FILE_TYPE_GPSMAPPER )
 509       a_gpsmapper_write_file ( vtl, f );
 510     else if ( file_type == FILE_TYPE_GPX )
 511       a_gpx_write_file ( vtl, f );
 512     else
 513       a_gpspoint_write_file ( vtl, f );
 514     fclose ( f );
 515     return TRUE;
 516   }
 517   return FALSE;
 518 }