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;
50 static guint layer_signals[VL_LAST_SIGNAL] = { 0 };
52 static GObjectClass *parent_class;
54 static void vik_layer_finalize ( VikLayer *vl );
55 static gboolean vik_layer_properties_factory ( VikLayer *vl, VikViewport *vp );
56 static gboolean layer_defaults_register ( VikLayerTypeEnum type );
58 G_DEFINE_TYPE (VikLayer, vik_layer, G_TYPE_OBJECT)
60 static void vik_layer_class_init (VikLayerClass *klass)
62 GObjectClass *object_class;
64 object_class = G_OBJECT_CLASS (klass);
66 object_class->finalize = (GObjectFinalizeFunc) vik_layer_finalize;
68 parent_class = g_type_class_peek_parent (klass);
70 layer_signals[VL_UPDATE_SIGNAL] = g_signal_new ( "update", G_TYPE_FROM_CLASS (klass),
71 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION, G_STRUCT_OFFSET (VikLayerClass, update), NULL, NULL,
72 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
74 // Register all parameter defaults, early in the start up sequence
75 VikLayerTypeEnum layer;
76 for ( layer = 0; layer < VIK_LAYER_NUM_TYPES; layer++ )
77 // ATM ignore the returned value
78 layer_defaults_register ( layer );
82 * Invoke the actual drawing via signal method
84 static gboolean idle_draw ( VikLayer *vl )
86 g_signal_emit ( G_OBJECT(vl), layer_signals[VL_UPDATE_SIGNAL], 0 );
87 return FALSE; // Nothing else to do
91 * Draw specified layer
93 void vik_layer_emit_update ( VikLayer *vl )
95 if ( vl->visible && vl->realized ) {
96 GThread *thread = vik_window_get_thread ( VIK_WINDOW(VIK_GTK_WINDOW_FROM_LAYER(vl)) );
101 vik_window_set_redraw_trigger(vl);
103 // Only ever draw when there is time to do so
104 if ( g_thread_self() != thread )
105 // Drawing requested from another (background) thread, so handle via the gdk thread method
106 gdk_threads_add_idle ( (GSourceFunc) idle_draw, vl );
108 g_idle_add ( (GSourceFunc) idle_draw, vl );
113 * should only be done by VikLayersPanel (hence never used from the background)
114 * need to redraw and record trigger when we make a layer invisible.
116 void vik_layer_emit_update_although_invisible ( VikLayer *vl )
118 vik_window_set_redraw_trigger(vl);
119 g_idle_add ( (GSourceFunc) idle_draw, vl );
122 /* doesn't set the trigger. should be done by aggregate layer when child emits update. */
123 void vik_layer_emit_update_secondary ( VikLayer *vl )
126 // TODO: this can used from the background - eg in acquire
127 // so will need to flow background update status through too
128 g_idle_add ( (GSourceFunc) idle_draw, vl );
131 static VikLayerInterface *vik_layer_interfaces[VIK_LAYER_NUM_TYPES] = {
132 &vik_aggregate_layer_interface,
133 &vik_trw_layer_interface,
134 &vik_coord_layer_interface,
135 &vik_georef_layer_interface,
136 &vik_gps_layer_interface,
137 &vik_maps_layer_interface,
138 &vik_dem_layer_interface,
141 VikLayerInterface *vik_layer_get_interface ( VikLayerTypeEnum type )
143 g_assert ( type < VIK_LAYER_NUM_TYPES );
144 return vik_layer_interfaces[type];
148 * Store default values for this layer
150 * Returns whether any parameters where registered
152 static gboolean layer_defaults_register ( VikLayerTypeEnum type )
154 // See if any parameters
155 VikLayerParam *params = vik_layer_interfaces[type]->params;
159 gboolean answer = FALSE; // Incase all parameters are 'not in properties'
160 guint16 params_count = vik_layer_interfaces[type]->params_count;
162 // Process each parameter
163 for ( i = 0; i < params_count; i++ ) {
164 if ( params[i].group != VIK_LAYER_NOT_IN_PROPERTIES ) {
165 if ( params[i].default_value ) {
166 VikLayerParamData paramd = params[i].default_value();
167 a_layer_defaults_register ( ¶ms[i], paramd, vik_layer_interfaces[type]->fixed_layer_name );
176 static void vik_layer_init ( VikLayer *vl )
180 vl->realized = FALSE;
183 void vik_layer_set_type ( VikLayer *vl, VikLayerTypeEnum type )
189 void vik_layer_rename ( VikLayer *l, const gchar *new_name )
191 g_assert ( l != NULL );
192 g_assert ( new_name != NULL );
194 l->name = g_strdup ( new_name );
197 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name )
199 g_assert ( l != NULL );
200 g_assert ( new_name != NULL );
205 const gchar *vik_layer_get_name ( VikLayer *l )
207 g_assert ( l != NULL);
211 VikLayer *vik_layer_create ( VikLayerTypeEnum type, VikViewport *vp, gboolean interactive )
213 VikLayer *new_layer = NULL;
214 g_assert ( type < VIK_LAYER_NUM_TYPES );
216 new_layer = vik_layer_interfaces[type]->create ( vp );
218 g_assert ( new_layer != NULL );
222 if ( vik_layer_properties ( new_layer, vp ) )
223 /* We translate the name here */
224 /* in order to avoid translating name set by user */
225 vik_layer_rename ( VIK_LAYER(new_layer), _(vik_layer_interfaces[type]->name) );
228 g_object_unref ( G_OBJECT(new_layer) ); /* cancel that */
235 /* returns TRUE if OK was pressed */
236 gboolean vik_layer_properties ( VikLayer *layer, VikViewport *vp )
238 if ( vik_layer_interfaces[layer->type]->properties )
239 return vik_layer_interfaces[layer->type]->properties ( layer, vp );
240 return vik_layer_properties_factory ( layer, vp );
243 void vik_layer_draw ( VikLayer *l, VikViewport *vp )
246 if ( vik_layer_interfaces[l->type]->draw )
247 vik_layer_interfaces[l->type]->draw ( l, vp );
250 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode )
252 if ( vik_layer_interfaces[l->type]->change_coord_mode )
253 vik_layer_interfaces[l->type]->change_coord_mode ( l, mode );
257 VikLayerTypeEnum layer_type;
262 void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len )
265 if ( vl && vik_layer_interfaces[vl->type]->marshall ) {
266 vik_layer_interfaces[vl->type]->marshall ( vl, data, len );
268 header = g_malloc(*len + sizeof(*header));
269 header->layer_type = vl->type;
271 memcpy(header->data, *data, *len);
273 *data = (guint8 *)header;
274 *len = *len + sizeof(*header);
281 void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *datalen )
283 VikLayerParam *params = vik_layer_get_interface(vl->type)->params;
284 VikLayerFuncGetParam get_param = vik_layer_get_interface(vl->type)->get_param;
285 GByteArray* b = g_byte_array_new ();
288 #define vlm_append(obj, sz) \
290 g_byte_array_append ( b, (guint8 *)&len, sizeof(len) ); \
291 g_byte_array_append ( b, (guint8 *)(obj), len );
293 vlm_append(vl->name, strlen(vl->name));
295 if ( params && get_param )
298 guint16 i, params_count = vik_layer_get_interface(vl->type)->params_count;
299 for ( i = 0; i < params_count; i++ )
301 g_debug("%s: %s", __FUNCTION__, params[i].name);
302 d = get_param(vl, i, FALSE);
303 switch ( params[i].type )
305 case VIK_LAYER_PARAM_STRING:
306 // Remember need braces as these are macro calls, not single statement functions!
308 vlm_append(d.s, strlen(d.s));
311 // Need to insert empty string otherwise the unmarshall will get confused
315 /* print out the string list in the array */
316 case VIK_LAYER_PARAM_STRING_LIST: {
319 /* write length of list (# of strings) */
320 gint listlen = g_list_length ( list );
321 g_byte_array_append ( b, (guint8 *)&listlen, sizeof(listlen) );
323 /* write each string */
325 gchar *s = (gchar *) list->data;
326 vlm_append(s, strlen(s));
333 vlm_append(&d, sizeof(d));
341 g_byte_array_free ( b, FALSE );
346 void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint datalen, VikViewport *vvp )
348 VikLayerParam *params = vik_layer_get_interface(vl->type)->params;
349 VikLayerFuncSetParam set_param = vik_layer_get_interface(vl->type)->set_param;
351 guint8 *b = (guint8 *)data;
353 #define vlm_size (*(gint *)b)
354 #define vlm_read(obj) \
355 memcpy((obj), b+sizeof(gint), vlm_size); \
356 b += sizeof(gint) + vlm_size;
358 s = g_malloc(vlm_size + 1);
362 vik_layer_rename(vl, s);
366 if ( params && set_param )
369 guint16 i, params_count = vik_layer_get_interface(vl->type)->params_count;
370 for ( i = 0; i < params_count; i++ )
372 g_debug("%s: %s", __FUNCTION__, params[i].name);
373 switch ( params[i].type )
375 case VIK_LAYER_PARAM_STRING:
376 s = g_malloc(vlm_size + 1);
380 set_param(vl, i, d, vvp, FALSE);
383 case VIK_LAYER_PARAM_STRING_LIST: {
384 gint listlen = vlm_size, j;
386 b += sizeof(gint); /* skip listlen */;
388 for ( j = 0; j < listlen; j++ ) {
390 s = g_malloc(vlm_size + 1);
393 list = g_list_append ( list, s );
396 set_param(vl, i, d, vvp, FALSE);
397 /* don't free -- string list is responsibility of the layer */
403 set_param(vl, i, d, vvp, FALSE);
410 VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp )
414 header = (header_t *)data;
416 if ( vik_layer_interfaces[header->layer_type]->unmarshall ) {
417 return vik_layer_interfaces[header->layer_type]->unmarshall ( header->data, header->len, vvp );
423 static void vik_layer_finalize ( VikLayer *vl )
425 g_assert ( vl != NULL );
426 if ( vik_layer_interfaces[vl->type]->free )
427 vik_layer_interfaces[vl->type]->free ( vl );
430 G_OBJECT_CLASS(parent_class)->finalize(G_OBJECT(vl));
433 /* sublayer switching */
434 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer )
436 if ( vik_layer_interfaces[l->type]->sublayer_toggle_visible )
437 return vik_layer_interfaces[l->type]->sublayer_toggle_visible ( l, subtype, sublayer );
438 return TRUE; /* if unknown, will always be visible */
441 gboolean vik_layer_selected ( VikLayer *l, gint subtype, gpointer sublayer, gint type, gpointer vlp )
443 if ( vik_layer_interfaces[l->type]->layer_selected )
444 return vik_layer_interfaces[l->type]->layer_selected ( l, subtype, sublayer, type, vlp );
445 /* Since no 'layer_selected' function explicitly turn off here */
446 return vik_window_clear_highlight ( (VikWindow *)VIK_GTK_WINDOW_FROM_LAYER(l) );
449 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter *layer_iter )
452 l->iter = *layer_iter;
454 if ( vik_layer_interfaces[l->type]->realize )
455 vik_layer_interfaces[l->type]->realize ( l, vt, layer_iter );
458 void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection)
460 if ( vik_layer_interfaces[l->type]->set_menu_selection )
461 vik_layer_interfaces[l->type]->set_menu_selection ( l, selection );
464 guint16 vik_layer_get_menu_items_selection(VikLayer *l)
466 if ( vik_layer_interfaces[l->type]->get_menu_selection )
467 return(vik_layer_interfaces[l->type]->get_menu_selection (l));
469 return(vik_layer_interfaces[l->type]->menu_items_selection);
472 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp )
474 if ( vik_layer_interfaces[l->type]->add_menu_items )
475 vik_layer_interfaces[l->type]->add_menu_items ( l, menu, vlp );
478 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter, VikViewport *vvp )
480 if ( vik_layer_interfaces[l->type]->sublayer_add_menu_items )
481 return vik_layer_interfaces[l->type]->sublayer_add_menu_items ( l, menu, vlp, subtype, sublayer, iter, vvp );
486 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter )
488 if ( vik_layer_interfaces[l->type]->sublayer_rename_request )
489 return vik_layer_interfaces[l->type]->sublayer_rename_request ( l, newname, vlp, subtype, sublayer, iter );
493 const gchar* vik_layer_sublayer_tooltip ( VikLayer *l, gint subtype, gpointer sublayer )
495 if ( vik_layer_interfaces[l->type]->sublayer_tooltip )
496 return vik_layer_interfaces[l->type]->sublayer_tooltip ( l, subtype, sublayer );
500 const gchar* vik_layer_layer_tooltip ( VikLayer *l )
502 if ( vik_layer_interfaces[l->type]->layer_tooltip )
503 return vik_layer_interfaces[l->type]->layer_tooltip ( l );
507 GdkPixbuf *vik_layer_load_icon ( VikLayerTypeEnum type )
509 g_assert ( type < VIK_LAYER_NUM_TYPES );
510 if ( vik_layer_interfaces[type]->icon )
511 return gdk_pixbuf_from_pixdata ( vik_layer_interfaces[type]->icon, FALSE, NULL );
515 gboolean vik_layer_set_param ( VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp, gboolean is_file_operation )
517 if ( vik_layer_interfaces[layer->type]->set_param )
518 return vik_layer_interfaces[layer->type]->set_param ( layer, id, data, vp, is_file_operation );
522 void vik_layer_post_read ( VikLayer *layer, VikViewport *vp, gboolean from_file )
524 if ( vik_layer_interfaces[layer->type]->post_read )
525 vik_layer_interfaces[layer->type]->post_read ( layer, vp, from_file );
528 static gboolean vik_layer_properties_factory ( VikLayer *vl, VikViewport *vp )
530 switch ( a_uibuilder_properties_factory ( _("Layer Properties"),
531 VIK_GTK_WINDOW_FROM_WIDGET(vp),
532 vik_layer_interfaces[vl->type]->params,
533 vik_layer_interfaces[vl->type]->params_count,
534 vik_layer_interfaces[vl->type]->params_groups,
535 vik_layer_interfaces[vl->type]->params_groups_count,
536 (gpointer) vik_layer_interfaces[vl->type]->set_param,
539 (gpointer) vik_layer_interfaces[vl->type]->get_param,
541 (gpointer) vik_layer_interfaces[vl->type]->change_param ) ) {
547 vik_layer_post_read ( vl, vp, FALSE ); /* update any gc's */
553 VikLayerTypeEnum vik_layer_type_from_string ( const gchar *str )
556 for ( i = 0; i < VIK_LAYER_NUM_TYPES; i++ )
557 if ( strcasecmp ( str, vik_layer_get_interface(i)->fixed_layer_name ) == 0 )
559 return VIK_LAYER_NUM_TYPES;
562 void vik_layer_typed_param_data_free ( gpointer gp )
564 VikLayerTypedParamData *val = (VikLayerTypedParamData *)gp;
565 switch ( val->type ) {
566 case VIK_LAYER_PARAM_STRING:
568 g_free ( (gpointer)val->data.s );
570 /* TODO: APPLICABLE TO US? NOTE: string layer works auniquely: data.sl should NOT be free'd when
571 * the internals call get_param -- i.e. it should be managed w/in the layer.
572 * The value passed by the internals into set_param should also be managed
573 * by the layer -- i.e. free'd by the layer.
575 case VIK_LAYER_PARAM_STRING_LIST:
576 g_warning ("Param strings not implemented"); //fake it
584 VikLayerTypedParamData *vik_layer_typed_param_data_copy_from_data (VikLayerParamType type, VikLayerParamData val) {
585 VikLayerTypedParamData *newval = g_new(VikLayerTypedParamData,1);
588 switch ( newval->type ) {
589 case VIK_LAYER_PARAM_STRING: {
590 gchar *s = g_strdup(newval->data.s);
594 /* TODO: APPLICABLE TO US? NOTE: string layer works auniquely: data.sl should NOT be free'd when
595 * the internals call get_param -- i.e. it should be managed w/in the layer.
596 * The value passed by the internals into set_param should also be managed
597 * by the layer -- i.e. free'd by the layer.
599 case VIK_LAYER_PARAM_STRING_LIST:
600 g_critical ( "Param strings not implemented"); //fake it
608 #define TEST_BOOLEAN(str) (! ((str)[0] == '\0' || (str)[0] == '0' || (str)[0] == 'n' || (str)[0] == 'N' || (str)[0] == 'f' || (str)[0] == 'F') )
610 VikLayerTypedParamData *vik_layer_data_typed_param_copy_from_string ( VikLayerParamType type, const gchar *str )
612 VikLayerTypedParamData *rv = g_new(VikLayerTypedParamData,1);
616 case VIK_LAYER_PARAM_DOUBLE: rv->data.d = strtod(str, NULL); break;
617 case VIK_LAYER_PARAM_UINT: rv->data.u = strtoul(str, NULL, 10); break;
618 case VIK_LAYER_PARAM_INT: rv->data.i = strtol(str, NULL, 10); break;
619 case VIK_LAYER_PARAM_BOOLEAN: rv->data.b = TEST_BOOLEAN(str); break;
620 case VIK_LAYER_PARAM_COLOR: memset(&(rv->data.c), 0, sizeof(rv->data.c)); /* default: black */
621 gdk_color_parse ( str, &(rv->data.c) ); break;
622 /* STRING or STRING_LIST -- if STRING_LIST, just set param to add a STRING */
624 gchar *s = g_strdup(str);
633 * vik_layer_set_defaults:
635 * Loop around all parameters for the specified layer to call the function to get the
636 * default value for that parameter
638 void vik_layer_set_defaults ( VikLayer *vl, VikViewport *vvp )
640 // Sneaky initialize of the viewport value here
642 VikLayerInterface *vli = vik_layer_get_interface ( vl->type );
643 const gchar *layer_name = vli->fixed_layer_name;
644 VikLayerParamData data;
647 for ( i = 0; i < vli->params_count; i++ ) {
648 // Ensure parameter is for use
649 if ( vli->params[i].group > VIK_LAYER_NOT_IN_PROPERTIES ) {
650 // ATM can't handle string lists
651 // only DEM files uses this currently
652 if ( vli->params[i].type != VIK_LAYER_PARAM_STRING_LIST ) {
653 data = a_layer_defaults_get ( layer_name, vli->params[i].name, vli->params[i].type );
654 vik_layer_set_param ( vl, i, data, vvp, TRUE ); // Possibly come from a file