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