2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2005, Alex Foobarian <foobarian@gmail.com>
5 * Copyright (C) 2003-2007, Evan Battaglia <gtoevan@gmx.net>
6 * Copyright (C) 2013, Rob Norris <rw_norris@hotmail.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include <glib/gi18n.h>
33 #include "viklayer_defaults.h"
35 /* functions common to all layers. */
36 /* TODO longone: rename interface free -> finalize */
38 extern VikLayerInterface vik_aggregate_layer_interface;
39 extern VikLayerInterface vik_trw_layer_interface;
40 extern VikLayerInterface vik_maps_layer_interface;
41 extern VikLayerInterface vik_coord_layer_interface;
42 extern VikLayerInterface vik_georef_layer_interface;
43 extern VikLayerInterface vik_gps_layer_interface;
44 extern VikLayerInterface vik_dem_layer_interface;
46 extern VikLayerInterface vik_mapnik_layer_interface;
53 static guint layer_signals[VL_LAST_SIGNAL] = { 0 };
55 static GObjectClass *parent_class;
57 static void vik_layer_finalize ( VikLayer *vl );
58 static gboolean vik_layer_properties_factory ( VikLayer *vl, VikViewport *vp );
59 static gboolean layer_defaults_register ( VikLayerTypeEnum type );
61 G_DEFINE_TYPE (VikLayer, vik_layer, G_TYPE_OBJECT)
63 static void vik_layer_class_init (VikLayerClass *klass)
65 GObjectClass *object_class;
67 object_class = G_OBJECT_CLASS (klass);
69 object_class->finalize = (GObjectFinalizeFunc) vik_layer_finalize;
71 parent_class = g_type_class_peek_parent (klass);
73 layer_signals[VL_UPDATE_SIGNAL] = g_signal_new ( "update", G_TYPE_FROM_CLASS (klass),
74 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION, G_STRUCT_OFFSET (VikLayerClass, update), NULL, NULL,
75 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
77 // Register all parameter defaults, early in the start up sequence
78 VikLayerTypeEnum layer;
79 for ( layer = 0; layer < VIK_LAYER_NUM_TYPES; layer++ )
80 // ATM ignore the returned value
81 layer_defaults_register ( layer );
85 * Invoke the actual drawing via signal method
87 static gboolean idle_draw ( VikLayer *vl )
89 g_signal_emit ( G_OBJECT(vl), layer_signals[VL_UPDATE_SIGNAL], 0 );
90 return FALSE; // Nothing else to do
94 * Draw specified layer
96 void vik_layer_emit_update ( VikLayer *vl )
98 if ( vl->visible && vl->realized ) {
99 GThread *thread = vik_window_get_thread ( VIK_WINDOW(VIK_GTK_WINDOW_FROM_LAYER(vl)) );
104 vik_window_set_redraw_trigger(vl);
106 // Only ever draw when there is time to do so
107 if ( g_thread_self() != thread )
108 // Drawing requested from another (background) thread, so handle via the gdk thread method
109 gdk_threads_add_idle ( (GSourceFunc) idle_draw, vl );
111 g_idle_add ( (GSourceFunc) idle_draw, vl );
116 * should only be done by VikLayersPanel (hence never used from the background)
117 * need to redraw and record trigger when we make a layer invisible.
119 void vik_layer_emit_update_although_invisible ( VikLayer *vl )
121 vik_window_set_redraw_trigger(vl);
122 g_idle_add ( (GSourceFunc) idle_draw, vl );
125 /* doesn't set the trigger. should be done by aggregate layer when child emits update. */
126 void vik_layer_emit_update_secondary ( VikLayer *vl )
129 // TODO: this can used from the background - eg in acquire
130 // so will need to flow background update status through too
131 g_idle_add ( (GSourceFunc) idle_draw, vl );
134 static VikLayerInterface *vik_layer_interfaces[VIK_LAYER_NUM_TYPES] = {
135 &vik_aggregate_layer_interface,
136 &vik_trw_layer_interface,
137 &vik_coord_layer_interface,
138 &vik_georef_layer_interface,
139 &vik_gps_layer_interface,
140 &vik_maps_layer_interface,
141 &vik_dem_layer_interface,
142 #ifdef HAVE_LIBMAPNIK
143 &vik_mapnik_layer_interface,
147 VikLayerInterface *vik_layer_get_interface ( VikLayerTypeEnum type )
149 g_assert ( type < VIK_LAYER_NUM_TYPES );
150 return vik_layer_interfaces[type];
154 * Store default values for this layer
156 * Returns whether any parameters where registered
158 static gboolean layer_defaults_register ( VikLayerTypeEnum type )
160 // See if any parameters
161 VikLayerParam *params = vik_layer_interfaces[type]->params;
165 gboolean answer = FALSE; // Incase all parameters are 'not in properties'
166 guint16 params_count = vik_layer_interfaces[type]->params_count;
168 // Process each parameter
169 for ( i = 0; i < params_count; i++ ) {
170 if ( params[i].group != VIK_LAYER_NOT_IN_PROPERTIES ) {
171 if ( params[i].default_value ) {
172 VikLayerParamData paramd = params[i].default_value();
173 a_layer_defaults_register ( ¶ms[i], paramd, vik_layer_interfaces[type]->fixed_layer_name );
182 static void vik_layer_init ( VikLayer *vl )
186 vl->realized = FALSE;
189 void vik_layer_set_type ( VikLayer *vl, VikLayerTypeEnum type )
195 void vik_layer_rename ( VikLayer *l, const gchar *new_name )
197 g_assert ( l != NULL );
198 g_assert ( new_name != NULL );
200 l->name = g_strdup ( new_name );
203 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name )
205 g_assert ( l != NULL );
206 g_assert ( new_name != NULL );
211 const gchar *vik_layer_get_name ( VikLayer *l )
213 g_assert ( l != NULL);
217 time_t vik_layer_get_timestamp ( VikLayer *vl )
219 if ( vik_layer_interfaces[vl->type]->get_timestamp )
220 return vik_layer_interfaces[vl->type]->get_timestamp ( vl );
224 VikLayer *vik_layer_create ( VikLayerTypeEnum type, VikViewport *vp, gboolean interactive )
226 VikLayer *new_layer = NULL;
227 g_assert ( type < VIK_LAYER_NUM_TYPES );
229 new_layer = vik_layer_interfaces[type]->create ( vp );
231 g_assert ( new_layer != NULL );
235 if ( vik_layer_properties ( new_layer, vp ) )
236 /* We translate the name here */
237 /* in order to avoid translating name set by user */
238 vik_layer_rename ( VIK_LAYER(new_layer), _(vik_layer_interfaces[type]->name) );
241 g_object_unref ( G_OBJECT(new_layer) ); /* cancel that */
248 /* returns TRUE if OK was pressed */
249 gboolean vik_layer_properties ( VikLayer *layer, VikViewport *vp )
251 if ( vik_layer_interfaces[layer->type]->properties )
252 return vik_layer_interfaces[layer->type]->properties ( layer, vp );
253 return vik_layer_properties_factory ( layer, vp );
256 void vik_layer_draw ( VikLayer *l, VikViewport *vp )
259 if ( vik_layer_interfaces[l->type]->draw )
260 vik_layer_interfaces[l->type]->draw ( l, vp );
263 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode )
265 if ( vik_layer_interfaces[l->type]->change_coord_mode )
266 vik_layer_interfaces[l->type]->change_coord_mode ( l, mode );
270 VikLayerTypeEnum layer_type;
275 void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len )
278 if ( vl && vik_layer_interfaces[vl->type]->marshall ) {
279 vik_layer_interfaces[vl->type]->marshall ( vl, data, len );
281 header = g_malloc(*len + sizeof(*header));
282 header->layer_type = vl->type;
284 memcpy(header->data, *data, *len);
286 *data = (guint8 *)header;
287 *len = *len + sizeof(*header);
294 void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *datalen )
296 VikLayerParam *params = vik_layer_get_interface(vl->type)->params;
297 VikLayerFuncGetParam get_param = vik_layer_get_interface(vl->type)->get_param;
298 GByteArray* b = g_byte_array_new ();
301 #define vlm_append(obj, sz) \
303 g_byte_array_append ( b, (guint8 *)&len, sizeof(len) ); \
304 g_byte_array_append ( b, (guint8 *)(obj), len );
306 // Store the internal properties first
307 vlm_append(&vl->visible, sizeof(vl->visible));
308 vlm_append(vl->name, strlen(vl->name));
310 // Now the actual parameters
311 if ( params && get_param )
314 guint16 i, params_count = vik_layer_get_interface(vl->type)->params_count;
315 for ( i = 0; i < params_count; i++ )
317 g_debug("%s: %s", __FUNCTION__, params[i].name);
318 d = get_param(vl, i, FALSE);
319 switch ( params[i].type )
321 case VIK_LAYER_PARAM_STRING:
322 // Remember need braces as these are macro calls, not single statement functions!
324 vlm_append(d.s, strlen(d.s));
327 // Need to insert empty string otherwise the unmarshall will get confused
331 /* print out the string list in the array */
332 case VIK_LAYER_PARAM_STRING_LIST: {
335 /* write length of list (# of strings) */
336 gint listlen = g_list_length ( list );
337 g_byte_array_append ( b, (guint8 *)&listlen, sizeof(listlen) );
339 /* write each string */
341 gchar *s = (gchar *) list->data;
342 vlm_append(s, strlen(s));
349 vlm_append(&d, sizeof(d));
357 g_byte_array_free ( b, FALSE );
362 void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint datalen, VikViewport *vvp )
364 VikLayerParam *params = vik_layer_get_interface(vl->type)->params;
365 VikLayerFuncSetParam set_param = vik_layer_get_interface(vl->type)->set_param;
367 guint8 *b = (guint8 *)data;
369 #define vlm_size (*(gint *)b)
370 #define vlm_read(obj) \
371 memcpy((obj), b+sizeof(gint), vlm_size); \
372 b += sizeof(gint) + vlm_size;
374 vlm_read(&vl->visible);
376 s = g_malloc(vlm_size + 1);
379 vik_layer_rename(vl, s);
382 if ( params && set_param )
384 VikLayerSetParam vlsp;
386 vlsp.is_file_operation = FALSE;
388 guint16 i, params_count = vik_layer_get_interface(vl->type)->params_count;
389 for ( i = 0; i < params_count; i++ )
392 g_debug("%s: %s", __FUNCTION__, params[i].name);
393 switch ( params[i].type )
395 case VIK_LAYER_PARAM_STRING:
396 s = g_malloc(vlm_size + 1);
400 set_param(vl, &vlsp);
403 case VIK_LAYER_PARAM_STRING_LIST: {
404 gint listlen = vlm_size, j;
406 b += sizeof(gint); /* skip listlen */;
408 for ( j = 0; j < listlen; j++ ) {
410 s = g_malloc(vlm_size + 1);
413 list = g_list_append ( list, s );
416 set_param(vl, &vlsp);
417 /* don't free -- string list is responsibility of the layer */
422 vlm_read(&vlsp.data);
423 set_param(vl, &vlsp);
430 VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp )
434 header = (header_t *)data;
436 if ( vik_layer_interfaces[header->layer_type]->unmarshall ) {
437 return vik_layer_interfaces[header->layer_type]->unmarshall ( header->data, header->len, vvp );
443 static void vik_layer_finalize ( VikLayer *vl )
445 g_assert ( vl != NULL );
446 if ( vik_layer_interfaces[vl->type]->free )
447 vik_layer_interfaces[vl->type]->free ( vl );
450 G_OBJECT_CLASS(parent_class)->finalize(G_OBJECT(vl));
453 /* sublayer switching */
454 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer )
456 if ( vik_layer_interfaces[l->type]->sublayer_toggle_visible )
457 return vik_layer_interfaces[l->type]->sublayer_toggle_visible ( l, subtype, sublayer );
458 return TRUE; /* if unknown, will always be visible */
461 gboolean vik_layer_selected ( VikLayer *l, gint subtype, gpointer sublayer, gint type, gpointer vlp )
463 if ( vik_layer_interfaces[l->type]->layer_selected )
464 return vik_layer_interfaces[l->type]->layer_selected ( l, subtype, sublayer, type, vlp );
465 /* Since no 'layer_selected' function explicitly turn off here */
466 return vik_window_clear_highlight ( (VikWindow *)VIK_GTK_WINDOW_FROM_LAYER(l) );
469 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter *layer_iter )
472 l->iter = *layer_iter;
474 if ( vik_layer_interfaces[l->type]->realize )
475 vik_layer_interfaces[l->type]->realize ( l, vt, layer_iter );
478 void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection)
480 if ( vik_layer_interfaces[l->type]->set_menu_selection )
481 vik_layer_interfaces[l->type]->set_menu_selection ( l, selection );
484 guint16 vik_layer_get_menu_items_selection(VikLayer *l)
486 if ( vik_layer_interfaces[l->type]->get_menu_selection )
487 return(vik_layer_interfaces[l->type]->get_menu_selection (l));
489 return(vik_layer_interfaces[l->type]->menu_items_selection);
492 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp )
494 if ( vik_layer_interfaces[l->type]->add_menu_items )
495 vik_layer_interfaces[l->type]->add_menu_items ( l, menu, vlp );
498 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter, VikViewport *vvp )
500 if ( vik_layer_interfaces[l->type]->sublayer_add_menu_items )
501 return vik_layer_interfaces[l->type]->sublayer_add_menu_items ( l, menu, vlp, subtype, sublayer, iter, vvp );
506 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter )
508 if ( vik_layer_interfaces[l->type]->sublayer_rename_request )
509 return vik_layer_interfaces[l->type]->sublayer_rename_request ( l, newname, vlp, subtype, sublayer, iter );
513 const gchar* vik_layer_sublayer_tooltip ( VikLayer *l, gint subtype, gpointer sublayer )
515 if ( vik_layer_interfaces[l->type]->sublayer_tooltip )
516 return vik_layer_interfaces[l->type]->sublayer_tooltip ( l, subtype, sublayer );
520 const gchar* vik_layer_layer_tooltip ( VikLayer *l )
522 if ( vik_layer_interfaces[l->type]->layer_tooltip )
523 return vik_layer_interfaces[l->type]->layer_tooltip ( l );
527 GdkPixbuf *vik_layer_load_icon ( VikLayerTypeEnum type )
529 g_assert ( type < VIK_LAYER_NUM_TYPES );
530 if ( vik_layer_interfaces[type]->icon )
531 return gdk_pixbuf_from_pixdata ( vik_layer_interfaces[type]->icon, FALSE, NULL );
535 gboolean vik_layer_set_param ( VikLayer *vl, VikLayerSetParam *vlsp )
537 if ( vik_layer_interfaces[vl->type]->set_param )
538 return vik_layer_interfaces[vl->type]->set_param ( vl, vlsp );
542 void vik_layer_post_read ( VikLayer *layer, VikViewport *vp, gboolean from_file )
544 if ( vik_layer_interfaces[layer->type]->post_read )
545 vik_layer_interfaces[layer->type]->post_read ( layer, vp, from_file );
548 static gboolean vik_layer_properties_factory ( VikLayer *vl, VikViewport *vp )
550 switch ( a_uibuilder_properties_factory ( _("Layer Properties"),
551 VIK_GTK_WINDOW_FROM_WIDGET(vp),
552 vik_layer_interfaces[vl->type]->params,
553 vik_layer_interfaces[vl->type]->params_count,
554 vik_layer_interfaces[vl->type]->params_groups,
555 vik_layer_interfaces[vl->type]->params_groups_count,
556 (gpointer) vik_layer_interfaces[vl->type]->set_param,
560 (gpointer) vik_layer_interfaces[vl->type]->get_param,
562 (gpointer) vik_layer_interfaces[vl->type]->change_param ) ) {
568 vik_layer_post_read ( vl, vp, FALSE ); /* update any gc's */
574 VikLayerTypeEnum vik_layer_type_from_string ( const gchar *str )
577 for ( i = 0; i < VIK_LAYER_NUM_TYPES; i++ )
578 if ( strcasecmp ( str, vik_layer_get_interface(i)->fixed_layer_name ) == 0 )
580 return VIK_LAYER_NUM_TYPES;
583 void vik_layer_typed_param_data_free ( gpointer gp )
585 VikLayerTypedParamData *val = (VikLayerTypedParamData *)gp;
586 switch ( val->type ) {
587 case VIK_LAYER_PARAM_STRING:
589 g_free ( (gpointer)val->data.s );
591 /* TODO: APPLICABLE TO US? NOTE: string layer works auniquely: data.sl should NOT be free'd when
592 * the internals call get_param -- i.e. it should be managed w/in the layer.
593 * The value passed by the internals into set_param should also be managed
594 * by the layer -- i.e. free'd by the layer.
596 case VIK_LAYER_PARAM_STRING_LIST:
597 g_warning ("Param strings not implemented"); //fake it
605 VikLayerTypedParamData *vik_layer_typed_param_data_copy_from_data (VikLayerParamType type, VikLayerParamData val) {
606 VikLayerTypedParamData *newval = g_new(VikLayerTypedParamData,1);
609 switch ( newval->type ) {
610 case VIK_LAYER_PARAM_STRING: {
611 gchar *s = g_strdup(newval->data.s);
615 /* TODO: APPLICABLE TO US? NOTE: string layer works auniquely: data.sl should NOT be free'd when
616 * the internals call get_param -- i.e. it should be managed w/in the layer.
617 * The value passed by the internals into set_param should also be managed
618 * by the layer -- i.e. free'd by the layer.
620 case VIK_LAYER_PARAM_STRING_LIST:
621 g_critical ( "Param strings not implemented"); //fake it
629 #define TEST_BOOLEAN(str) (! ((str)[0] == '\0' || (str)[0] == '0' || (str)[0] == 'n' || (str)[0] == 'N' || (str)[0] == 'f' || (str)[0] == 'F') )
631 VikLayerTypedParamData *vik_layer_data_typed_param_copy_from_string ( VikLayerParamType type, const gchar *str )
633 VikLayerTypedParamData *rv = g_new(VikLayerTypedParamData,1);
637 case VIK_LAYER_PARAM_DOUBLE: rv->data.d = strtod(str, NULL); break;
638 case VIK_LAYER_PARAM_UINT: rv->data.u = strtoul(str, NULL, 10); break;
639 case VIK_LAYER_PARAM_INT: rv->data.i = strtol(str, NULL, 10); break;
640 case VIK_LAYER_PARAM_BOOLEAN: rv->data.b = TEST_BOOLEAN(str); break;
641 case VIK_LAYER_PARAM_COLOR: memset(&(rv->data.c), 0, sizeof(rv->data.c)); /* default: black */
642 gdk_color_parse ( str, &(rv->data.c) ); break;
643 /* STRING or STRING_LIST -- if STRING_LIST, just set param to add a STRING */
645 gchar *s = g_strdup(str);
654 * vik_layer_set_defaults:
656 * Loop around all parameters for the specified layer to call the function to get the
657 * default value for that parameter
659 void vik_layer_set_defaults ( VikLayer *vl, VikViewport *vvp )
661 // Sneaky initialize of the viewport value here
663 VikLayerInterface *vli = vik_layer_get_interface ( vl->type );
664 const gchar *layer_name = vli->fixed_layer_name;
665 VikLayerSetParam vlsp;
667 vlsp.is_file_operation = TRUE; // Possibly come from a file
671 for ( i = 0; i < vli->params_count; i++ ) {
673 // Ensure parameter is for use
674 if ( vli->params[i].group > VIK_LAYER_NOT_IN_PROPERTIES ) {
675 // ATM can't handle string lists
676 // only DEM files uses this currently
677 if ( vli->params[i].type != VIK_LAYER_PARAM_STRING_LIST ) {
678 vlsp.data = a_layer_defaults_get ( layer_name, vli->params[i].name, vli->params[i].type );
679 vik_layer_set_param ( vl, &vlsp );
686 * Make the layer more accessible within the treeview
688 void vik_layer_expand_tree ( VikLayer *vl )
690 vik_treeview_expand ( vl->vt, &vl->iter );