2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
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.
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.
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
36 #include <glib/gstdio.h>
37 #include <glib/gi18n.h>
39 /* Relax some dependencies */
40 #if ! GLIB_CHECK_VERSION(2,12,0)
41 static gboolean return_true (gpointer a, gpointer b, gpointer c) { return TRUE; }
42 static g_hash_table_remove_all (GHashTable *ght) { g_hash_table_foreach_remove ( ght, (GHRFunc) return_true, FALSE ); }
45 #define TEST_BOOLEAN(str) (! ((str)[0] == '\0' || (str)[0] == '0' || (str)[0] == 'n' || (str)[0] == 'N' || (str)[0] == 'f' || (str)[0] == 'F') )
46 #define VIK_MAGIC "#VIK"
47 #define GPX_MAGIC "<?xm"
48 #define VIK_MAGIC_LEN 4
56 typedef struct _Stack Stack;
63 static void pop(Stack **stack) {
64 Stack *tmp = (*stack)->under;
69 static void push(Stack **stack)
71 Stack *tmp = g_malloc ( sizeof ( Stack ) );
76 static gboolean check_magic ( FILE *f, const gchar *magic_number )
78 gchar magic[VIK_MAGIC_LEN];
81 if ( fread(magic, 1, sizeof(magic), f) == sizeof(magic) &&
82 strncmp(magic, magic_number, sizeof(magic)) == 0 )
84 for ( i = sizeof(magic)-1; i >= 0; i-- ) /* the ol' pushback */
90 static gboolean str_starts_with ( const gchar *haystack, const gchar *needle, guint16 len_needle, gboolean must_be_longer )
92 if ( strlen(haystack) > len_needle - (!must_be_longer) && strncasecmp ( haystack, needle, len_needle ) == 0 )
97 static guint16 layer_type_from_string ( const gchar *str )
100 for ( i = 0; i < VIK_LAYER_NUM_TYPES; i++ )
101 if ( strcasecmp ( str, vik_layer_get_interface(i)->name ) == 0 )
106 void file_write_layer_param ( FILE *f, const gchar *name, guint8 type, VikLayerParamData data ) {
107 /* string lists are handled differently. We get a GList (that shouldn't
108 * be freed) back for get_param and if it is null we shouldn't write
109 * anything at all (otherwise we'd read in a list with an empty string,
110 * not an empty string list.
112 if ( type == VIK_LAYER_PARAM_STRING_LIST ) {
114 GList *iter = (GList *)data.sl;
116 fprintf ( f, "%s=", name );
117 fprintf ( f, "%s\n", (gchar *)(iter->data) );
122 fprintf ( f, "%s=", name );
125 case VIK_LAYER_PARAM_DOUBLE: {
126 // char buf[15]; /* locale independent */
127 // fprintf ( f, "%s\n", (char *) g_dtostr (data.d, buf, sizeof (buf)) ); break;
128 fprintf ( f, "%f\n", data.d );
131 case VIK_LAYER_PARAM_UINT: fprintf ( f, "%d\n", data.u ); break;
132 case VIK_LAYER_PARAM_INT: fprintf ( f, "%d\n", data.i ); break;
133 case VIK_LAYER_PARAM_BOOLEAN: fprintf ( f, "%c\n", data.b ? 't' : 'f' ); break;
134 case VIK_LAYER_PARAM_STRING: fprintf ( f, "%s\n", data.s ); break;
135 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;
140 static void write_layer_params_and_data ( VikLayer *l, FILE *f )
142 VikLayerParam *params = vik_layer_get_interface(l->type)->params;
143 VikLayerFuncGetParam get_param = vik_layer_get_interface(l->type)->get_param;
145 fprintf ( f, "name=%s\n", l->name ? l->name : "" );
147 fprintf ( f, "visible=f\n" );
149 if ( params && get_param )
151 VikLayerParamData data;
152 guint16 i, params_count = vik_layer_get_interface(l->type)->params_count;
153 for ( i = 0; i < params_count; i++ )
155 data = get_param(l, i, TRUE);
156 file_write_layer_param(f, params[i].name, params[i].type, data);
159 if ( vik_layer_get_interface(l->type)->write_file_data )
161 fprintf ( f, "\n\n~LayerData\n" );
162 vik_layer_get_interface(l->type)->write_file_data ( l, f );
163 fprintf ( f, "~EndLayerData\n" );
166 write param, and get_value, etc.
167 then run layer data, and that's it.
171 static void file_write ( VikAggregateLayer *top, FILE *f, gpointer vp )
174 VikLayer *current_layer;
176 VikViewportDrawMode mode;
180 stack->data = (gpointer) vik_aggregate_layer_get_children(VIK_AGGREGATE_LAYER(top));
184 vik_coord_to_latlon ( vik_viewport_get_center ( VIK_VIEWPORT(vp) ), &ll );
186 mode = vik_viewport_get_drawmode ( VIK_VIEWPORT(vp) );
188 case VIK_VIEWPORT_DRAWMODE_UTM: modestring = "utm"; break;
189 case VIK_VIEWPORT_DRAWMODE_EXPEDIA: modestring = "expedia"; break;
190 case VIK_VIEWPORT_DRAWMODE_MERCATOR: modestring = "mercator"; break;
191 case VIK_VIEWPORT_DRAWMODE_LATLON: modestring = "latlon"; break;
193 g_critical("Houston, we've had a problem. mode=%d", mode);
196 fprintf ( f, "#VIKING GPS Data file " VIKING_URL "\n\nxmpp=%f\nympp=%f\nlat=%f\nlon=%f\nmode=%s\ncolor=%s\nhighlightcolor=%s\ndrawscale=%s\ndrawcentermark=%s\ndrawhighlight=%s\n",
197 vik_viewport_get_xmpp ( VIK_VIEWPORT(vp) ), vik_viewport_get_ympp ( VIK_VIEWPORT(vp) ), ll.lat, ll.lon,
198 modestring, vik_viewport_get_background_color(VIK_VIEWPORT(vp)),
199 vik_viewport_get_highlight_color(VIK_VIEWPORT(vp)),
200 vik_viewport_get_draw_scale(VIK_VIEWPORT(vp)) ? "t" : "f",
201 vik_viewport_get_draw_centermark(VIK_VIEWPORT(vp)) ? "t" : "f",
202 vik_viewport_get_draw_highlight(VIK_VIEWPORT(vp)) ? "t" : "f" );
204 if ( ! VIK_LAYER(top)->visible )
205 fprintf ( f, "visible=f\n" );
207 while (stack && stack->data)
209 current_layer = VIK_LAYER(((GList *)stack->data)->data);
210 fprintf ( f, "\n~Layer %s\n", vik_layer_get_interface(current_layer->type)->name );
211 write_layer_params_and_data ( current_layer, f );
212 if ( current_layer->type == VIK_LAYER_AGGREGATE && !vik_aggregate_layer_is_empty(VIK_AGGREGATE_LAYER(current_layer)) )
215 stack->data = (gpointer) vik_aggregate_layer_get_children(VIK_AGGREGATE_LAYER(current_layer));
217 else if ( current_layer->type == VIK_LAYER_GPS && !vik_gps_layer_is_empty(VIK_GPS_LAYER(current_layer)) )
220 stack->data = (gpointer) vik_gps_layer_get_children(VIK_GPS_LAYER(current_layer));
224 stack->data = (gpointer) ((GList *)stack->data)->next;
225 fprintf ( f, "~EndLayer\n\n" );
226 while ( stack && (!stack->data) )
231 stack->data = (gpointer) ((GList *)stack->data)->next;
232 fprintf ( f, "~EndLayer\n\n" );
238 get vikaggregatelayer's children (?)
239 foreach write ALL params,
240 then layer data (IF function exists)
244 stack of layers (LIST) we are working on
245 when layer->next == NULL ...
250 static void string_list_delete ( gpointer key, gpointer l, gpointer user_data )
252 /* 20071021 bugfix */
253 GList *iter = (GList *) l;
255 g_free ( iter->data );
258 g_list_free ( (GList *) l );
261 static void string_list_set_param (gint i, GList *list, gpointer *layer_and_vp)
265 vik_layer_set_param ( VIK_LAYER(layer_and_vp[0]), i, x, layer_and_vp[1], TRUE );
268 static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp )
271 struct LatLon ll = { 0.0, 0.0 };
277 VikLayerParam *params = NULL; /* for current layer, so we don't have to keep on looking up interface */
278 guint8 params_count = 0;
280 GHashTable *string_lists = g_hash_table_new(g_direct_hash,g_direct_equal);
284 stack->data = (gpointer) top;
286 while ( fgets ( buffer, 4096, f ) )
291 while ( *line == ' ' || *line =='\t' )
294 if ( line[0] == '#' )
299 if ( len > 0 && line[len-1] == '\n' )
301 if ( len > 0 && line[len-1] == '\r' )
308 if ( line[0] == '~' )
313 else if ( str_starts_with ( line, "Layer ", 6, TRUE ) )
315 int parent_type = VIK_LAYER(stack->data)->type;
316 if ( ( ! stack->data ) || ((parent_type != VIK_LAYER_AGGREGATE) && (parent_type != VIK_LAYER_GPS)) )
318 g_warning ( "Line %ld: Layer command inside non-Aggregate Layer (type %d)", line_num, parent_type );
319 push(&stack); /* inside INVALID layer */
325 gint16 type = layer_type_from_string ( line+6 );
329 g_warning ( "Line %ld: Unknown type %s", line_num, line+6 );
332 else if (parent_type == VIK_LAYER_GPS)
334 stack->data = (gpointer) vik_gps_layer_get_a_child(VIK_GPS_LAYER(stack->under->data));
335 params = vik_layer_get_interface(type)->params;
336 params_count = vik_layer_get_interface(type)->params_count;
340 stack->data = (gpointer) vik_layer_create ( type, vp, NULL, FALSE );
341 params = vik_layer_get_interface(type)->params;
342 params_count = vik_layer_get_interface(type)->params_count;
346 else if ( str_starts_with ( line, "EndLayer", 8, FALSE ) )
348 if ( stack->under == NULL )
349 g_warning ( "Line %ld: Mismatched ~EndLayer command", line_num );
352 /* add any string lists we've accumulated */
353 gpointer layer_and_vp[2];
354 layer_and_vp[0] = stack->data;
355 layer_and_vp[1] = vp;
356 g_hash_table_foreach ( string_lists, (GHFunc) string_list_set_param, layer_and_vp );
357 g_hash_table_remove_all ( string_lists );
359 if ( stack->data && stack->under->data )
361 if (VIK_LAYER(stack->under->data)->type == VIK_LAYER_AGGREGATE) {
362 vik_aggregate_layer_add_layer ( VIK_AGGREGATE_LAYER(stack->under->data), VIK_LAYER(stack->data) );
363 vik_layer_post_read ( VIK_LAYER(stack->data), vp, TRUE );
365 else if (VIK_LAYER(stack->under->data)->type == VIK_LAYER_GPS) {
366 /* TODO: anything else needs to be done here ? */
369 g_warning ( "Line %ld: EndLayer command inside non-Aggregate Layer (type %d)", line_num, VIK_LAYER(stack->data)->type );
374 else if ( str_starts_with ( line, "LayerData", 9, FALSE ) )
376 if ( stack->data && vik_layer_get_interface(VIK_LAYER(stack->data)->type)->read_file_data )
377 vik_layer_get_interface(VIK_LAYER(stack->data)->type)->read_file_data ( VIK_LAYER(stack->data), f );
378 /* must read until hits ~EndLayerData */
381 { /* simply skip layer data over */
382 while ( fgets ( buffer, 4096, f ) )
389 if ( len > 0 && line[len-1] == '\n' )
391 if ( len > 0 && line[len-1] == '\r' )
393 if ( strcasecmp ( line, "~EndLayerData" ) == 0 )
401 g_warning ( "Line %ld: Unknown tilde command", line_num );
411 for ( i = 0; i < len; i++ )
412 if ( line[i] == '=' )
415 if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "xmpp", eq_pos ) == 0) /* "hard coded" params: global & for all layer-types */
416 vik_viewport_set_xmpp ( VIK_VIEWPORT(vp), strtod ( line+5, NULL ) );
417 else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "ympp", eq_pos ) == 0)
418 vik_viewport_set_ympp ( VIK_VIEWPORT(vp), strtod ( line+5, NULL ) );
419 else if ( stack->under == NULL && eq_pos == 3 && strncasecmp ( line, "lat", eq_pos ) == 0 )
420 ll.lat = strtod ( line+4, NULL );
421 else if ( stack->under == NULL && eq_pos == 3 && strncasecmp ( line, "lon", eq_pos ) == 0 )
422 ll.lon = strtod ( line+4, NULL );
423 else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "utm" ) == 0)
424 vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_UTM);
425 else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "expedia" ) == 0)
426 vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_EXPEDIA );
427 else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "google" ) == 0)
429 g_warning ( _("Draw mode '%s' no more supported"), "google" );
431 else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "kh" ) == 0)
433 g_warning ( _("Draw mode '%s' no more supported"), "kh" );
435 else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "mercator" ) == 0)
436 vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_MERCATOR );
437 else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "latlon" ) == 0)
438 vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_LATLON );
439 else if ( stack->under == NULL && eq_pos == 5 && strncasecmp ( line, "color", eq_pos ) == 0 )
440 vik_viewport_set_background_color ( VIK_VIEWPORT(vp), line+6 );
441 else if ( stack->under == NULL && eq_pos == 14 && strncasecmp ( line, "highlightcolor", eq_pos ) == 0 )
442 vik_viewport_set_highlight_color ( VIK_VIEWPORT(vp), line+15 );
443 else if ( stack->under == NULL && eq_pos == 9 && strncasecmp ( line, "drawscale", eq_pos ) == 0 )
444 vik_viewport_set_draw_scale ( VIK_VIEWPORT(vp), TEST_BOOLEAN(line+10) );
445 else if ( stack->under == NULL && eq_pos == 14 && strncasecmp ( line, "drawcentermark", eq_pos ) == 0 )
446 vik_viewport_set_draw_centermark ( VIK_VIEWPORT(vp), TEST_BOOLEAN(line+15) );
447 else if ( stack->under == NULL && eq_pos == 13 && strncasecmp ( line, "drawhighlight", eq_pos ) == 0 )
448 vik_viewport_set_draw_highlight ( VIK_VIEWPORT(vp), TEST_BOOLEAN(line+14) );
449 else if ( stack->under && eq_pos == 4 && strncasecmp ( line, "name", eq_pos ) == 0 )
450 vik_layer_rename ( VIK_LAYER(stack->data), line+5 );
451 else if ( eq_pos == 7 && strncasecmp ( line, "visible", eq_pos ) == 0 )
452 VIK_LAYER(stack->data)->visible = TEST_BOOLEAN(line+8);
453 else if ( eq_pos != -1 && stack->under )
455 gboolean found_match = FALSE;
457 /* go thru layer params. if len == eq_pos && starts_with jazz, set it. */
458 /* also got to check for name and visible. */
462 g_warning ( "Line %ld: No options for this kind of layer", line_num );
466 for ( i = 0; i < params_count; i++ )
467 if ( strlen(params[i].name) == eq_pos && strncasecmp ( line, params[i].name, eq_pos ) == 0 )
471 if ( params[i].type == VIK_LAYER_PARAM_STRING_LIST ) {
472 GList *l = g_list_append ( g_hash_table_lookup ( string_lists, GINT_TO_POINTER ((gint) i) ),
474 g_hash_table_replace ( string_lists, GINT_TO_POINTER ((gint)i), l );
475 /* add the value to a list, possibly making a new list.
476 * this will be passed to the layer when we read an ~EndLayer */
478 switch ( params[i].type )
480 case VIK_LAYER_PARAM_DOUBLE: x.d = strtod(line, NULL); break;
481 case VIK_LAYER_PARAM_UINT: x.u = strtoul(line, NULL, 10); break;
482 case VIK_LAYER_PARAM_INT: x.i = strtol(line, NULL, 10); break;
483 case VIK_LAYER_PARAM_BOOLEAN: x.b = TEST_BOOLEAN(line); break;
484 case VIK_LAYER_PARAM_COLOR: memset(&(x.c), 0, sizeof(x.c)); /* default: black */
485 gdk_color_parse ( line, &(x.c) ); break;
486 /* STRING or STRING_LIST -- if STRING_LIST, just set param to add a STRING */
489 vik_layer_set_param ( VIK_LAYER(stack->data), i, x, vp, TRUE );
495 g_warning ( "Line %ld: Unknown parameter. Line:\n%s", line_num, line );
498 g_warning ( "Line %ld: Invalid parameter or parameter outside of layer.", line_num );
511 if ( stack->under && stack->under->data && stack->data )
513 vik_aggregate_layer_add_layer ( VIK_AGGREGATE_LAYER(stack->under->data), VIK_LAYER(stack->data) );
514 vik_layer_post_read ( VIK_LAYER(stack->data), vp, TRUE );
519 if ( ll.lat != 0.0 || ll.lon != 0.0 )
520 vik_viewport_set_center_latlon ( VIK_VIEWPORT(vp), &ll );
522 if ( ( ! VIK_LAYER(top)->visible ) && VIK_LAYER(top)->realized )
523 vik_treeview_item_set_visible ( VIK_LAYER(top)->vt, &(VIK_LAYER(top)->iter), FALSE );
525 /* delete anything we've forgotten about -- should only happen when file ends before an EndLayer */
526 g_hash_table_foreach ( string_lists, string_list_delete, NULL );
527 g_hash_table_destroy ( string_lists );
534 new default layer of type (str_to_type) (check interface->name)
536 VikLayer *vl = stack->data;
538 vik_aggregate_layer_add_layer(stack->data, vl);
540 vik_layer_data ( VIK_LAYER_DATA(stack->data), f, vp );
544 /* ---------------------------------------------------- */
546 static FILE *xfopen ( const char *fn, const char *mode )
548 if ( strcmp(fn,"-") == 0 )
551 return g_fopen(fn, "r");
554 static void xfclose ( FILE *f )
556 if ( f != stdin && f != stdout ) {
562 /* 0 on failure, 1 on success (vik file) 2 on success (other file) */
563 gshort a_file_load ( VikAggregateLayer *top, VikViewport *vp, const gchar *filename_or_uri )
565 char *filename = (char *)filename_or_uri;
566 if (strncmp(filename, "file://", 7) == 0)
567 filename = filename + 7;
569 gboolean is_gpx_file = check_file_ext ( filename, ".gpx" );
570 FILE *f = xfopen ( filename, "r" );
577 if ( !is_gpx_file && check_magic ( f, VIK_MAGIC ) )
579 file_read ( top, f, vp );
586 VikLayer *vtl = vik_layer_create ( VIK_LAYER_TRW, vp, NULL, FALSE );
587 vik_layer_rename ( vtl, a_file_basename ( filename ) );
589 if ( is_gpx_file || check_magic ( f, GPX_MAGIC ) )
590 a_gpx_read_file ( VIK_TRW_LAYER(vtl), f );
592 a_gpspoint_read_file ( VIK_TRW_LAYER(vtl), f );
594 vik_layer_post_read ( vtl, vp, TRUE );
596 vik_aggregate_layer_add_layer ( top, vtl );
598 vik_trw_layer_auto_set_view ( VIK_TRW_LAYER(vtl), vp );
605 gboolean a_file_save ( VikAggregateLayer *top, gpointer vp, const gchar *filename )
609 if (strncmp(filename, "file://", 7) == 0)
610 filename = filename + 7;
612 f = g_fopen(filename, "w");
617 file_write ( top, f, vp );
626 const gchar *a_file_basename ( const gchar *filename )
628 const gchar *t = filename + strlen(filename) - 1;
629 while ( --t > filename )
630 if ( *(t-1) == FILE_SEP )
638 gboolean is_gpx = check_file_ext ( "a/b/c.gpx", ".gpx" );
640 gboolean check_file_ext ( const gchar *filename, const gchar *fileext )
642 const gchar *basename = a_file_basename(filename);
643 g_assert( filename );
644 g_assert( fileext && fileext[0]=='.' );
648 const char * dot = strrchr(basename, '.');
649 if (dot && !strcmp(dot, fileext))
655 gboolean a_file_export ( VikTrwLayer *vtl, const gchar *filename, VikFileType_t file_type, const gchar *trackname )
657 FILE *f = g_fopen ( filename, "w" );
661 VikTrack *vt = vik_trw_layer_get_track ( vtl, trackname );
662 switch ( file_type ) {
664 a_gpx_write_track_file ( trackname, vt, f );
667 g_critical("Houston, we've had a problem. file_type=%d", file_type);
670 switch ( file_type ) {
671 case FILE_TYPE_GPSMAPPER:
672 a_gpsmapper_write_file ( vtl, f );
675 a_gpx_write_file ( vtl, f );
677 case FILE_TYPE_GPSPOINT:
678 a_gpspoint_write_file ( vtl, f );
681 g_critical("Houston, we've had a problem. file_type=%d", file_type);
691 const gchar *a_get_viking_dir()
693 static gchar *viking_dir = NULL;
695 // TODO: use g_get_user_config_dir ?
698 const gchar *home = g_getenv("HOME");
699 if (!home || g_access(home, W_OK))
700 home = g_get_home_dir ();
702 if (!home || g_access(home, W_OK))
704 static gchar temp[] = {"/tmp/vikXXXXXX"};
705 home = mkdtemp(temp);
708 if (!home || g_access(home, W_OK))
710 g_critical("Unable to find a base directory");
712 /* Build the name of the directory */
713 viking_dir = g_build_filename(home, ".viking", NULL);
714 if (g_file_test(viking_dir, G_FILE_TEST_EXISTS) == FALSE)
715 g_mkdir(viking_dir, 0755);