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>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include <glib/gi18n.h>
32 #include "viklayer_defaults.h"
34 /* functions common to all layers. */
35 /* TODO longone: rename interface free -> finalize */
37 extern VikLayerInterface vik_aggregate_layer_interface;
38 extern VikLayerInterface vik_trw_layer_interface;
39 extern VikLayerInterface vik_maps_layer_interface;
40 extern VikLayerInterface vik_coord_layer_interface;
41 extern VikLayerInterface vik_georef_layer_interface;
42 extern VikLayerInterface vik_gps_layer_interface;
43 extern VikLayerInterface vik_dem_layer_interface;
49 static guint layer_signals[VL_LAST_SIGNAL] = { 0 };
51 static GObjectClass *parent_class;
53 static void vik_layer_finalize ( VikLayer *vl );
54 static gboolean vik_layer_properties_factory ( VikLayer *vl, VikViewport *vp );
55 static gboolean layer_defaults_register ( VikLayerTypeEnum type );
57 G_DEFINE_TYPE (VikLayer, vik_layer, G_TYPE_OBJECT)
59 static void vik_layer_class_init (VikLayerClass *klass)
61 GObjectClass *object_class;
63 object_class = G_OBJECT_CLASS (klass);
65 object_class->finalize = (GObjectFinalizeFunc) vik_layer_finalize;
67 parent_class = g_type_class_peek_parent (klass);
69 layer_signals[VL_UPDATE_SIGNAL] = g_signal_new ( "update", G_TYPE_FROM_CLASS (klass),
70 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION, G_STRUCT_OFFSET (VikLayerClass, update), NULL, NULL,
71 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
73 // Register all parameter defaults, early in the start up sequence
74 VikLayerTypeEnum layer;
75 for ( layer = 0; layer < VIK_LAYER_NUM_TYPES; layer++ )
76 // ATM ignore the returned value
77 layer_defaults_register ( layer );
81 * Invoke the actual drawing via signal method
83 static gboolean idle_draw ( VikLayer *vl )
85 g_signal_emit ( G_OBJECT(vl), layer_signals[VL_UPDATE_SIGNAL], 0 );
86 return FALSE; // Nothing else to do
90 * Draw specified layer
92 void vik_layer_emit_update ( VikLayer *vl )
94 if ( vl->visible && vl->realized ) {
95 vik_window_set_redraw_trigger(vl);
97 // Only ever draw when there is time to do so
98 if ( g_thread_self() != vik_window_get_thread (VIK_WINDOW(VIK_GTK_WINDOW_FROM_LAYER(vl))) )
99 // Drawing requested from another (background) thread, so handle via the gdk thread method
100 gdk_threads_add_idle ( (GSourceFunc) idle_draw, vl );
102 g_idle_add ( (GSourceFunc) idle_draw, vl );
107 * should only be done by VikLayersPanel (hence never used from the background)
108 * need to redraw and record trigger when we make a layer invisible.
110 void vik_layer_emit_update_although_invisible ( VikLayer *vl )
112 vik_window_set_redraw_trigger(vl);
113 g_idle_add ( (GSourceFunc) idle_draw, vl );
116 /* doesn't set the trigger. should be done by aggregate layer when child emits update. */
117 void vik_layer_emit_update_secondary ( VikLayer *vl )
120 // TODO: this can used from the background - eg in acquire
121 // so will need to flow background update status through too
122 g_idle_add ( (GSourceFunc) idle_draw, vl );
125 static VikLayerInterface *vik_layer_interfaces[VIK_LAYER_NUM_TYPES] = {
126 &vik_aggregate_layer_interface,
127 &vik_trw_layer_interface,
128 &vik_coord_layer_interface,
129 &vik_georef_layer_interface,
130 &vik_gps_layer_interface,
131 &vik_maps_layer_interface,
132 &vik_dem_layer_interface,
135 VikLayerInterface *vik_layer_get_interface ( VikLayerTypeEnum type )
137 g_assert ( type < VIK_LAYER_NUM_TYPES );
138 return vik_layer_interfaces[type];
142 * Store default values for this layer
144 * Returns whether any parameters where registered
146 static gboolean layer_defaults_register ( VikLayerTypeEnum type )
148 // See if any parameters
149 VikLayerParam *params = vik_layer_interfaces[type]->params;
153 gboolean answer = FALSE; // Incase all parameters are 'not in properties'
154 guint16 params_count = vik_layer_interfaces[type]->params_count;
156 // Process each parameter
157 for ( i = 0; i < params_count; i++ ) {
158 if ( params[i].group != VIK_LAYER_NOT_IN_PROPERTIES ) {
159 if ( params[i].default_value ) {
160 VikLayerParamData paramd = params[i].default_value();
161 a_layer_defaults_register ( ¶ms[i], paramd, vik_layer_interfaces[type]->fixed_layer_name );
170 static void vik_layer_init ( VikLayer *vl )
174 vl->realized = FALSE;
177 void vik_layer_set_type ( VikLayer *vl, VikLayerTypeEnum type )
183 void vik_layer_rename ( VikLayer *l, const gchar *new_name )
185 g_assert ( l != NULL );
186 g_assert ( new_name != NULL );
188 l->name = g_strdup ( new_name );
191 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name )
193 g_assert ( l != NULL );
194 g_assert ( new_name != NULL );
199 const gchar *vik_layer_get_name ( VikLayer *l )
201 g_assert ( l != NULL);
205 VikLayer *vik_layer_create ( VikLayerTypeEnum type, gpointer vp, GtkWindow *w, gboolean interactive )
207 VikLayer *new_layer = NULL;
208 g_assert ( type < VIK_LAYER_NUM_TYPES );
210 new_layer = vik_layer_interfaces[type]->create ( vp );
212 g_assert ( new_layer != NULL );
216 if ( vik_layer_properties ( new_layer, vp ) )
217 /* We translate the name here */
218 /* in order to avoid translating name set by user */
219 vik_layer_rename ( VIK_LAYER(new_layer), _(vik_layer_interfaces[type]->name) );
222 g_object_unref ( G_OBJECT(new_layer) ); /* cancel that */
229 /* returns TRUE if OK was pressed */
230 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp )
232 if ( vik_layer_interfaces[layer->type]->properties )
233 return vik_layer_interfaces[layer->type]->properties ( layer, vp );
234 return vik_layer_properties_factory ( layer, vp );
237 void vik_layer_draw ( VikLayer *l, VikViewport *vp )
240 if ( vik_layer_interfaces[l->type]->draw )
241 vik_layer_interfaces[l->type]->draw ( l, vp );
244 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode )
246 if ( vik_layer_interfaces[l->type]->change_coord_mode )
247 vik_layer_interfaces[l->type]->change_coord_mode ( l, mode );
251 VikLayerTypeEnum layer_type;
256 void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len )
259 if ( vl && vik_layer_interfaces[vl->type]->marshall ) {
260 vik_layer_interfaces[vl->type]->marshall ( vl, data, len );
262 header = g_malloc(*len + sizeof(*header));
263 header->layer_type = vl->type;
265 memcpy(header->data, *data, *len);
267 *data = (guint8 *)header;
268 *len = *len + sizeof(*header);
275 void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *datalen )
277 VikLayerParam *params = vik_layer_get_interface(vl->type)->params;
278 VikLayerFuncGetParam get_param = vik_layer_get_interface(vl->type)->get_param;
279 GByteArray* b = g_byte_array_new ();
282 #define vlm_append(obj, sz) \
284 g_byte_array_append ( b, (guint8 *)&len, sizeof(len) ); \
285 g_byte_array_append ( b, (guint8 *)(obj), len );
287 vlm_append(vl->name, strlen(vl->name));
289 if ( params && get_param )
292 guint16 i, params_count = vik_layer_get_interface(vl->type)->params_count;
293 for ( i = 0; i < params_count; i++ )
295 g_debug("%s: %s", __FUNCTION__, params[i].name);
296 d = get_param(vl, i, FALSE);
297 switch ( params[i].type )
299 case VIK_LAYER_PARAM_STRING:
300 vlm_append(d.s, strlen(d.s));
303 /* print out the string list in the array */
304 case VIK_LAYER_PARAM_STRING_LIST: {
307 /* write length of list (# of strings) */
308 gint listlen = g_list_length ( list );
309 g_byte_array_append ( b, (guint8 *)&listlen, sizeof(listlen) );
311 /* write each string */
313 gchar *s = (gchar *) list->data;
314 vlm_append(s, strlen(s));
321 vlm_append(&d, sizeof(d));
329 g_byte_array_free ( b, FALSE );
334 void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint datalen, VikViewport *vvp )
336 VikLayerParam *params = vik_layer_get_interface(vl->type)->params;
337 VikLayerFuncSetParam set_param = vik_layer_get_interface(vl->type)->set_param;
339 guint8 *b = (guint8 *)data;
341 #define vlm_size (*(gint *)b)
342 #define vlm_read(obj) \
343 memcpy((obj), b+sizeof(gint), vlm_size); \
344 b += sizeof(gint) + vlm_size;
346 s = g_malloc(vlm_size + 1);
350 vik_layer_rename(vl, s);
354 if ( params && set_param )
357 guint16 i, params_count = vik_layer_get_interface(vl->type)->params_count;
358 for ( i = 0; i < params_count; i++ )
360 g_debug("%s: %s", __FUNCTION__, params[i].name);
361 switch ( params[i].type )
363 case VIK_LAYER_PARAM_STRING:
364 s = g_malloc(vlm_size + 1);
368 set_param(vl, i, d, vvp, FALSE);
371 case VIK_LAYER_PARAM_STRING_LIST: {
372 gint listlen = vlm_size, j;
374 b += sizeof(gint); /* skip listlen */;
376 for ( j = 0; j < listlen; j++ ) {
378 s = g_malloc(vlm_size + 1);
381 list = g_list_append ( list, s );
384 set_param(vl, i, d, vvp, FALSE);
385 /* don't free -- string list is responsibility of the layer */
391 set_param(vl, i, d, vvp, FALSE);
398 VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp )
402 header = (header_t *)data;
404 if ( vik_layer_interfaces[header->layer_type]->unmarshall ) {
405 return vik_layer_interfaces[header->layer_type]->unmarshall ( header->data, header->len, vvp );
411 static void vik_layer_finalize ( VikLayer *vl )
413 g_assert ( vl != NULL );
414 if ( vik_layer_interfaces[vl->type]->free )
415 vik_layer_interfaces[vl->type]->free ( vl );
418 G_OBJECT_CLASS(parent_class)->finalize(G_OBJECT(vl));
421 /* sublayer switching */
422 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer )
424 if ( vik_layer_interfaces[l->type]->sublayer_toggle_visible )
425 return vik_layer_interfaces[l->type]->sublayer_toggle_visible ( l, subtype, sublayer );
426 return TRUE; /* if unknown, will always be visible */
429 gboolean vik_layer_selected ( VikLayer *l, gint subtype, gpointer sublayer, gint type, gpointer vlp )
431 if ( vik_layer_interfaces[l->type]->layer_selected )
432 return vik_layer_interfaces[l->type]->layer_selected ( l, subtype, sublayer, type, vlp );
433 /* Since no 'layer_selected' function explicitly turn off here */
434 return vik_window_clear_highlight ( (VikWindow *)VIK_GTK_WINDOW_FROM_LAYER(l) );
437 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter *layer_iter )
440 l->iter = *layer_iter;
442 if ( vik_layer_interfaces[l->type]->realize )
443 vik_layer_interfaces[l->type]->realize ( l, vt, layer_iter );
446 void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection)
448 if ( vik_layer_interfaces[l->type]->set_menu_selection )
449 vik_layer_interfaces[l->type]->set_menu_selection ( l, selection );
452 guint16 vik_layer_get_menu_items_selection(VikLayer *l)
454 if ( vik_layer_interfaces[l->type]->get_menu_selection )
455 return(vik_layer_interfaces[l->type]->get_menu_selection (l));
457 return(vik_layer_interfaces[l->type]->menu_items_selection);
460 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp )
462 if ( vik_layer_interfaces[l->type]->add_menu_items )
463 vik_layer_interfaces[l->type]->add_menu_items ( l, menu, vlp );
466 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter, VikViewport *vvp )
468 if ( vik_layer_interfaces[l->type]->sublayer_add_menu_items )
469 return vik_layer_interfaces[l->type]->sublayer_add_menu_items ( l, menu, vlp, subtype, sublayer, iter, vvp );
474 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter )
476 if ( vik_layer_interfaces[l->type]->sublayer_rename_request )
477 return vik_layer_interfaces[l->type]->sublayer_rename_request ( l, newname, vlp, subtype, sublayer, iter );
481 const gchar* vik_layer_sublayer_tooltip ( VikLayer *l, gint subtype, gpointer sublayer )
483 if ( vik_layer_interfaces[l->type]->sublayer_tooltip )
484 return vik_layer_interfaces[l->type]->sublayer_tooltip ( l, subtype, sublayer );
488 const gchar* vik_layer_layer_tooltip ( VikLayer *l )
490 if ( vik_layer_interfaces[l->type]->layer_tooltip )
491 return vik_layer_interfaces[l->type]->layer_tooltip ( l );
495 GdkPixbuf *vik_layer_load_icon ( VikLayerTypeEnum type )
497 g_assert ( type < VIK_LAYER_NUM_TYPES );
498 if ( vik_layer_interfaces[type]->icon )
499 return gdk_pixbuf_from_pixdata ( vik_layer_interfaces[type]->icon, FALSE, NULL );
503 gboolean vik_layer_set_param ( VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp, gboolean is_file_operation )
505 if ( vik_layer_interfaces[layer->type]->set_param )
506 return vik_layer_interfaces[layer->type]->set_param ( layer, id, data, vp, is_file_operation );
510 void vik_layer_post_read ( VikLayer *layer, VikViewport *vp, gboolean from_file )
512 if ( vik_layer_interfaces[layer->type]->post_read )
513 vik_layer_interfaces[layer->type]->post_read ( layer, vp, from_file );
516 static gboolean vik_layer_properties_factory ( VikLayer *vl, VikViewport *vp )
518 switch ( a_uibuilder_properties_factory ( _("Layer Properties"),
519 VIK_GTK_WINDOW_FROM_WIDGET(vp),
520 vik_layer_interfaces[vl->type]->params,
521 vik_layer_interfaces[vl->type]->params_count,
522 vik_layer_interfaces[vl->type]->params_groups,
523 vik_layer_interfaces[vl->type]->params_groups_count,
524 (gpointer) vik_layer_interfaces[vl->type]->set_param,
527 (gpointer) vik_layer_interfaces[vl->type]->get_param,
534 vik_layer_post_read ( vl, vp, FALSE ); /* update any gc's */
540 VikLayerTypeEnum vik_layer_type_from_string ( const gchar *str )
543 for ( i = 0; i < VIK_LAYER_NUM_TYPES; i++ )
544 if ( strcasecmp ( str, vik_layer_get_interface(i)->fixed_layer_name ) == 0 )
546 return VIK_LAYER_NUM_TYPES;
549 void vik_layer_typed_param_data_free ( gpointer gp )
551 VikLayerTypedParamData *val = (VikLayerTypedParamData *)gp;
552 switch ( val->type ) {
553 case VIK_LAYER_PARAM_STRING:
555 g_free ( (gpointer)val->data.s );
557 /* TODO: APPLICABLE TO US? NOTE: string layer works auniquely: data.sl should NOT be free'd when
558 * the internals call get_param -- i.e. it should be managed w/in the layer.
559 * The value passed by the internals into set_param should also be managed
560 * by the layer -- i.e. free'd by the layer.
562 case VIK_LAYER_PARAM_STRING_LIST:
563 g_warning ("Param strings not implemented"); //fake it
571 VikLayerTypedParamData *vik_layer_typed_param_data_copy_from_data (VikLayerParamType type, VikLayerParamData val) {
572 VikLayerTypedParamData *newval = g_new(VikLayerTypedParamData,1);
575 switch ( newval->type ) {
576 case VIK_LAYER_PARAM_STRING: {
577 gchar *s = g_strdup(newval->data.s);
581 /* TODO: APPLICABLE TO US? NOTE: string layer works auniquely: data.sl should NOT be free'd when
582 * the internals call get_param -- i.e. it should be managed w/in the layer.
583 * The value passed by the internals into set_param should also be managed
584 * by the layer -- i.e. free'd by the layer.
586 case VIK_LAYER_PARAM_STRING_LIST:
587 g_critical ( "Param strings not implemented"); //fake it
595 #define TEST_BOOLEAN(str) (! ((str)[0] == '\0' || (str)[0] == '0' || (str)[0] == 'n' || (str)[0] == 'N' || (str)[0] == 'f' || (str)[0] == 'F') )
597 VikLayerTypedParamData *vik_layer_data_typed_param_copy_from_string ( VikLayerParamType type, const gchar *str )
599 VikLayerTypedParamData *rv = g_new(VikLayerTypedParamData,1);
603 case VIK_LAYER_PARAM_DOUBLE: rv->data.d = strtod(str, NULL); break;
604 case VIK_LAYER_PARAM_UINT: rv->data.u = strtoul(str, NULL, 10); break;
605 case VIK_LAYER_PARAM_INT: rv->data.i = strtol(str, NULL, 10); break;
606 case VIK_LAYER_PARAM_BOOLEAN: rv->data.b = TEST_BOOLEAN(str); break;
607 case VIK_LAYER_PARAM_COLOR: memset(&(rv->data.c), 0, sizeof(rv->data.c)); /* default: black */
608 gdk_color_parse ( str, &(rv->data.c) ); break;
609 /* STRING or STRING_LIST -- if STRING_LIST, just set param to add a STRING */
611 gchar *s = g_strdup(str);
620 * vik_layer_set_defaults:
622 * Loop around all parameters for the specified layer to call the function to get the
623 * default value for that parameter
625 void vik_layer_set_defaults ( VikLayer *vl, VikViewport *vvp )
627 VikLayerInterface *vli = vik_layer_get_interface ( vl->type );
628 const gchar *layer_name = vli->fixed_layer_name;
629 VikLayerParamData data;
632 for ( i = 0; i < vli->params_count; i++ ) {
633 // Ensure parameter is for use
634 if ( vli->params[i].group > VIK_LAYER_NOT_IN_PROPERTIES ) {
635 // ATM can't handle string lists
636 // only DEM files uses this currently
637 if ( vli->params[i].type != VIK_LAYER_PARAM_STRING_LIST ) {
638 data = a_layer_defaults_get ( layer_name, vli->params[i].name, vli->params[i].type );
639 vik_layer_set_param ( vl, i, data, vvp, FALSE );