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