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
26 #include <glib/gi18n.h>
31 /* functions common to all layers. */
32 /* TODO longone: rename interface free -> finalize */
34 extern VikLayerInterface vik_aggregate_layer_interface;
35 extern VikLayerInterface vik_trw_layer_interface;
36 extern VikLayerInterface vik_maps_layer_interface;
37 extern VikLayerInterface vik_coord_layer_interface;
38 extern VikLayerInterface vik_georef_layer_interface;
39 extern VikLayerInterface vik_gps_layer_interface;
40 extern VikLayerInterface vik_dem_layer_interface;
46 static guint layer_signals[VL_LAST_SIGNAL] = { 0 };
48 static GObjectClass *parent_class;
50 static void layer_class_init ( VikLayerClass *klass );
51 static void layer_init ( VikLayer *vl );
52 static void layer_finalize ( VikLayer *vl );
53 static gboolean layer_properties_factory ( VikLayer *vl, VikViewport *vp );
56 /* TODO longone: rename vik_layer_init -> set_type */
58 GType vik_layer_get_type ()
60 static GType vl_type = 0;
64 static const GTypeInfo vl_info =
66 sizeof (VikLayerClass),
68 NULL, /* base_finalize */
69 (GClassInitFunc) layer_class_init, /* class init */
70 NULL, /* class_finalize */
71 NULL, /* class_data */
74 (GInstanceInitFunc) layer_init /* instance init */
76 vl_type = g_type_register_static ( G_TYPE_OBJECT, "VikLayer", &vl_info, 0 );
82 static void layer_class_init (VikLayerClass *klass)
84 GObjectClass *object_class;
86 object_class = G_OBJECT_CLASS (klass);
88 object_class->finalize = (GObjectFinalizeFunc) layer_finalize;
90 parent_class = g_type_class_peek_parent (klass);
92 layer_signals[VL_UPDATE_SIGNAL] = g_signal_new ( "update", G_TYPE_FROM_CLASS (klass),
93 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION, G_STRUCT_OFFSET (VikLayerClass, update), NULL, NULL,
94 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
97 void vik_layer_emit_update ( VikLayer *vl )
100 vik_window_set_redraw_trigger(vl);
101 g_signal_emit ( G_OBJECT(vl), layer_signals[VL_UPDATE_SIGNAL], 0 );
105 /* should only be done by VikLayersPanel -- need to redraw and record trigger
106 * when we make a layer invisible.
108 void vik_layer_emit_update_although_invisible ( VikLayer *vl )
110 vik_window_set_redraw_trigger(vl);
111 g_signal_emit ( G_OBJECT(vl), layer_signals[VL_UPDATE_SIGNAL], 0 );
114 /* doesn't set the trigger. should be done by aggregate layer when child emits update. */
115 void vik_layer_emit_update_secondary ( VikLayer *vl )
118 g_signal_emit ( G_OBJECT(vl), layer_signals[VL_UPDATE_SIGNAL], 0 );
121 static VikLayerInterface *vik_layer_interfaces[VIK_LAYER_NUM_TYPES] = {
122 &vik_aggregate_layer_interface,
123 &vik_trw_layer_interface,
124 &vik_coord_layer_interface,
125 &vik_georef_layer_interface,
126 &vik_gps_layer_interface,
127 &vik_maps_layer_interface,
128 &vik_dem_layer_interface,
131 VikLayerInterface *vik_layer_get_interface ( gint type )
133 g_assert ( type < VIK_LAYER_NUM_TYPES );
134 return vik_layer_interfaces[type];
137 static void layer_init ( VikLayer *vl )
141 vl->realized = FALSE;
144 void vik_layer_init ( VikLayer *vl, gint type )
150 void vik_layer_rename ( VikLayer *l, const gchar *new_name )
152 g_assert ( l != NULL );
153 g_assert ( new_name != NULL );
155 l->name = g_strdup ( new_name );
158 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name )
160 g_assert ( l != NULL );
161 g_assert ( new_name != NULL );
166 const gchar *vik_layer_get_name ( VikLayer *l )
168 g_assert ( l != NULL);
172 VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive )
174 VikLayer *new_layer = NULL;
175 g_assert ( type < VIK_LAYER_NUM_TYPES );
177 new_layer = vik_layer_interfaces[type]->create ( vp );
179 g_assert ( new_layer != NULL );
183 if ( vik_layer_properties ( new_layer, vp ) )
184 /* We translate the name here */
185 /* in order to avoid translating name set by user */
186 vik_layer_rename ( VIK_LAYER(new_layer), _(vik_layer_interfaces[type]->name) );
189 g_object_unref ( G_OBJECT(new_layer) ); /* cancel that */
196 /* returns TRUE if OK was pressed */
197 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp )
199 if ( vik_layer_interfaces[layer->type]->properties )
200 return vik_layer_interfaces[layer->type]->properties ( layer, vp );
201 return layer_properties_factory ( layer, vp );
204 void vik_layer_draw ( VikLayer *l, gpointer data )
207 if ( vik_layer_interfaces[l->type]->draw )
208 vik_layer_interfaces[l->type]->draw ( l, data );
211 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode )
213 if ( vik_layer_interfaces[l->type]->change_coord_mode )
214 vik_layer_interfaces[l->type]->change_coord_mode ( l, mode );
223 void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len )
226 if ( vl && vik_layer_interfaces[vl->type]->marshall ) {
227 vik_layer_interfaces[vl->type]->marshall ( vl, data, len );
229 header = g_malloc(*len + sizeof(*header));
230 header->layer_type = vl->type;
232 memcpy(header->data, *data, *len);
234 *data = (guint8 *)header;
235 *len = *len + sizeof(*header);
242 void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *datalen )
244 VikLayerParam *params = vik_layer_get_interface(vl->type)->params;
245 VikLayerFuncGetParam get_param = vik_layer_get_interface(vl->type)->get_param;
246 GByteArray* b = g_byte_array_new ();
249 #define vlm_append(obj, sz) \
251 g_byte_array_append ( b, (guint8 *)&len, sizeof(len) ); \
252 g_byte_array_append ( b, (guint8 *)(obj), len );
254 vlm_append(vl->name, strlen(vl->name));
256 if ( params && get_param )
259 guint16 i, params_count = vik_layer_get_interface(vl->type)->params_count;
260 for ( i = 0; i < params_count; i++ )
262 g_debug("%s: %s", __FUNCTION__, params[i].name);
263 d = get_param(vl, i);
264 switch ( params[i].type )
266 case VIK_LAYER_PARAM_STRING:
267 vlm_append(d.s, strlen(d.s));
270 /* print out the string list in the array */
271 case VIK_LAYER_PARAM_STRING_LIST: {
274 /* write length of list (# of strings) */
275 gint listlen = g_list_length ( list );
276 g_byte_array_append ( b, (guint8 *)&listlen, sizeof(listlen) );
278 /* write each string */
280 gchar *s = (gchar *) list->data;
281 vlm_append(s, strlen(s));
288 vlm_append(&d, sizeof(d));
296 g_byte_array_free ( b, FALSE );
301 void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint datalen, VikViewport *vvp )
303 VikLayerParam *params = vik_layer_get_interface(vl->type)->params;
304 VikLayerFuncSetParam set_param = vik_layer_get_interface(vl->type)->set_param;
306 guint8 *b = (guint8 *)data;
308 #define vlm_size (*(gint *)b)
309 #define vlm_read(obj) \
310 memcpy((obj), b+sizeof(gint), vlm_size); \
311 b += sizeof(gint) + vlm_size;
313 s = g_malloc(vlm_size + 1);
317 vik_layer_rename(vl, s);
321 if ( params && set_param )
324 guint16 i, params_count = vik_layer_get_interface(vl->type)->params_count;
325 for ( i = 0; i < params_count; i++ )
327 g_debug("%s: %s", __FUNCTION__, params[i].name);
328 switch ( params[i].type )
330 case VIK_LAYER_PARAM_STRING:
331 s = g_malloc(vlm_size + 1);
335 set_param(vl, i, d, vvp);
338 case VIK_LAYER_PARAM_STRING_LIST: {
339 gint listlen = vlm_size, j;
341 b += sizeof(gint); /* skip listlen */;
343 for ( j = 0; j < listlen; j++ ) {
345 s = g_malloc(vlm_size + 1);
348 list = g_list_append ( list, s );
351 set_param ( vl, i, d, vvp );
352 /* don't free -- string list is responsibility of the layer */
358 set_param(vl, i, d, vvp);
365 VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp )
369 header = (header_t *)data;
371 if ( vik_layer_interfaces[header->layer_type]->unmarshall ) {
372 return vik_layer_interfaces[header->layer_type]->unmarshall ( header->data, header->len, vvp );
378 static void layer_finalize ( VikLayer *vl )
380 g_assert ( vl != NULL );
381 if ( vik_layer_interfaces[vl->type]->free )
382 vik_layer_interfaces[vl->type]->free ( vl );
385 G_OBJECT_CLASS(parent_class)->finalize(G_OBJECT(vl));
388 /* sublayer switching */
389 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer )
391 if ( vik_layer_interfaces[l->type]->sublayer_toggle_visible )
392 return vik_layer_interfaces[l->type]->sublayer_toggle_visible ( l, subtype, sublayer );
393 return TRUE; /* if unknown, will always be visible */
396 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter *layer_iter )
399 l->iter = *layer_iter;
401 if ( vik_layer_interfaces[l->type]->realize )
402 vik_layer_interfaces[l->type]->realize ( l, vt, layer_iter );
405 void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection)
407 if ( vik_layer_interfaces[l->type]->set_menu_selection )
408 vik_layer_interfaces[l->type]->set_menu_selection ( l, selection );
411 guint16 vik_layer_get_menu_items_selection(VikLayer *l)
413 if ( vik_layer_interfaces[l->type]->get_menu_selection )
414 return(vik_layer_interfaces[l->type]->get_menu_selection (l));
416 return(vik_layer_interfaces[l->type]->menu_items_selection);
419 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp )
421 if ( vik_layer_interfaces[l->type]->add_menu_items )
422 vik_layer_interfaces[l->type]->add_menu_items ( l, menu, vlp );
425 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter )
427 if ( vik_layer_interfaces[l->type]->sublayer_add_menu_items )
428 return vik_layer_interfaces[l->type]->sublayer_add_menu_items ( l, menu, vlp, subtype, sublayer, iter );
433 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter )
435 if ( vik_layer_interfaces[l->type]->sublayer_rename_request )
436 return vik_layer_interfaces[l->type]->sublayer_rename_request ( l, newname, vlp, subtype, sublayer, iter );
440 GdkPixbuf *vik_layer_load_icon ( gint type )
442 g_assert ( type < VIK_LAYER_NUM_TYPES );
443 if ( vik_layer_interfaces[type]->icon )
444 return gdk_pixbuf_from_pixdata ( vik_layer_interfaces[type]->icon, FALSE, NULL );
448 gboolean vik_layer_set_param ( VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp )
450 if ( vik_layer_interfaces[layer->type]->set_param )
451 return vik_layer_interfaces[layer->type]->set_param ( layer, id, data, vp );
455 void vik_layer_post_read ( VikLayer *layer, VikViewport *vp, gboolean from_file )
457 if ( vik_layer_interfaces[layer->type]->post_read )
458 vik_layer_interfaces[layer->type]->post_read ( layer, vp, from_file );
461 static gboolean layer_properties_factory ( VikLayer *vl, VikViewport *vp )
463 switch ( a_uibuilder_properties_factory ( VIK_GTK_WINDOW_FROM_WIDGET(vp),
464 vik_layer_interfaces[vl->type]->params,
465 vik_layer_interfaces[vl->type]->params_count,
466 vik_layer_interfaces[vl->type]->params_groups,
467 vik_layer_interfaces[vl->type]->params_groups_count,
468 (gpointer) vik_layer_interfaces[vl->type]->set_param,
471 (gpointer) vik_layer_interfaces[vl->type]->get_param,
478 vik_layer_post_read ( vl, vp, FALSE ); /* update any gc's */