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
23 #include "vikradiogroup.h"
24 #include "vikfilelist.h"
27 /* functions common to all layers. */
28 /* TODO longone: rename interface free -> finalize */
30 extern VikLayerInterface vik_aggregate_layer_interface;
31 extern VikLayerInterface vik_trw_layer_interface;
32 extern VikLayerInterface vik_maps_layer_interface;
33 extern VikLayerInterface vik_coord_layer_interface;
34 extern VikLayerInterface vik_georef_layer_interface;
35 extern VikLayerInterface vik_gps_layer_interface;
36 extern VikLayerInterface vik_dem_layer_interface;
42 static guint layer_signals[VL_LAST_SIGNAL] = { 0 };
44 static GObjectClass *parent_class;
46 static void layer_class_init ( VikLayerClass *klass );
47 static void layer_init ( VikLayer *vl );
48 static void layer_finalize ( VikLayer *vl );
49 static gboolean layer_properties_factory ( VikLayer *vl, gpointer vp );
52 /* TODO longone: rename vik_layer_init -> set_type */
54 GType vik_layer_get_type ()
56 static GType vl_type = 0;
60 static const GTypeInfo vl_info =
62 sizeof (VikLayerClass),
64 NULL, /* base_finalize */
65 (GClassInitFunc) layer_class_init, /* class init */
66 NULL, /* class_finalize */
67 NULL, /* class_data */
70 (GInstanceInitFunc) layer_init /* instance init */
72 vl_type = g_type_register_static ( G_TYPE_OBJECT, "VikLayer", &vl_info, 0 );
78 static void layer_class_init (VikLayerClass *klass)
80 GObjectClass *object_class;
82 object_class = G_OBJECT_CLASS (klass);
84 object_class->finalize = (GObjectFinalizeFunc) layer_finalize;
86 parent_class = g_type_class_peek_parent (klass);
88 layer_signals[VL_UPDATE_SIGNAL] = g_signal_new ( "update", G_TYPE_FROM_CLASS (klass),
89 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION, G_STRUCT_OFFSET (VikLayerClass, update), NULL, NULL,
90 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
93 void vik_layer_emit_update ( VikLayer *vl )
96 g_signal_emit ( G_OBJECT(vl), layer_signals[VL_UPDATE_SIGNAL], 0 );
99 static VikLayerInterface *vik_layer_interfaces[VIK_LAYER_NUM_TYPES] = {
100 &vik_aggregate_layer_interface,
101 &vik_trw_layer_interface,
102 &vik_coord_layer_interface,
103 &vik_georef_layer_interface,
104 &vik_gps_layer_interface,
105 &vik_maps_layer_interface,
106 &vik_dem_layer_interface,
109 VikLayerInterface *vik_layer_get_interface ( gint type )
111 g_assert ( type < VIK_LAYER_NUM_TYPES );
112 return vik_layer_interfaces[type];
115 static void layer_init ( VikLayer *vl )
119 vl->realized = FALSE;
122 void vik_layer_init ( VikLayer *vl, gint type )
128 void vik_layer_rename ( VikLayer *l, const gchar *new_name )
130 g_assert ( l != NULL );
131 g_assert ( new_name != NULL );
133 l->name = g_strdup ( new_name );
136 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name )
138 g_assert ( l != NULL );
139 g_assert ( new_name != NULL );
144 const gchar *vik_layer_get_name ( VikLayer *l )
146 g_assert ( l != NULL);
150 VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive )
152 VikLayer *new_layer = NULL;
153 g_assert ( type < VIK_LAYER_NUM_TYPES );
155 new_layer = vik_layer_interfaces[type]->create ( vp );
157 g_assert ( new_layer != NULL );
161 if ( vik_layer_properties ( new_layer, vp ) )
162 vik_layer_rename ( VIK_LAYER(new_layer), vik_layer_interfaces[type]->name );
165 g_object_unref ( G_OBJECT(new_layer) ); /* cancel that */
172 /* returns TRUE if OK was pressed */
173 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp )
175 if ( vik_layer_interfaces[layer->type]->properties )
176 return vik_layer_interfaces[layer->type]->properties ( layer, vp );
177 return layer_properties_factory ( layer, vp );
180 void vik_layer_draw ( VikLayer *l, gpointer data )
183 if ( vik_layer_interfaces[l->type]->draw )
184 vik_layer_interfaces[l->type]->draw ( l, data );
187 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode )
189 if ( vik_layer_interfaces[l->type]->change_coord_mode )
190 vik_layer_interfaces[l->type]->change_coord_mode ( l, mode );
193 VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp )
195 if ( vik_layer_interfaces[vl->type]->copy )
197 VikLayer *rv = vik_layer_interfaces[vl->type]->copy ( vl, vp );
200 vik_layer_rename ( rv, vl->name );
201 rv->visible = vl->visible;
215 void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len )
218 if ( vl && vik_layer_interfaces[vl->type]->marshall ) {
219 vik_layer_interfaces[vl->type]->marshall ( vl, data, len );
221 header = g_malloc(*len + sizeof(*header));
222 header->layer_type = vl->type;
224 memcpy(header->data, *data, *len);
226 *data = (guint8 *)header;
227 *len = *len + sizeof(*header);
234 void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *datalen )
236 VikLayerParam *params = vik_layer_get_interface(vl->type)->params;
237 VikLayerFuncGetParam get_param = vik_layer_get_interface(vl->type)->get_param;
238 GByteArray* b = g_byte_array_new ();
241 #define vlm_append(obj, sz) \
243 g_byte_array_append ( b, (guint8 *)&len, sizeof(len) ); \
244 g_byte_array_append ( b, (guint8 *)(obj), len );
246 vlm_append(vl->name, strlen(vl->name));
248 if ( params && get_param )
251 guint16 i, params_count = vik_layer_get_interface(vl->type)->params_count;
252 for ( i = 0; i < params_count; i++ )
254 d = get_param(vl, i);
255 switch ( params[i].type )
257 case VIK_LAYER_PARAM_STRING:
258 vlm_append(d.s, strlen(d.s));
261 vlm_append(&d, sizeof(d));
269 g_byte_array_free ( b, FALSE );
274 void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint datalen, VikViewport *vvp )
276 VikLayerParam *params = vik_layer_get_interface(vl->type)->params;
277 VikLayerFuncSetParam set_param = vik_layer_get_interface(vl->type)->set_param;
279 guint8 *b = (guint8 *)data;
281 #define vlm_size (*(gint *)b)
282 #define vlm_read(obj) \
283 memcpy((obj), b+sizeof(gint), vlm_size); \
284 b += sizeof(gint) + vlm_size;
286 s = g_malloc(vlm_size + 1);
290 vik_layer_rename(vl, s);
294 if ( params && set_param )
297 guint16 i, params_count = vik_layer_get_interface(vl->type)->params_count;
298 for ( i = 0; i < params_count; i++ )
300 switch ( params[i].type )
302 case VIK_LAYER_PARAM_STRING:
303 s = g_malloc(vlm_size + 1);
307 set_param(vl, i, d, vvp);
312 set_param(vl, i, d, vvp);
319 VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp )
323 header = (header_t *)data;
325 if ( vik_layer_interfaces[header->layer_type]->unmarshall ) {
326 return vik_layer_interfaces[header->layer_type]->unmarshall ( header->data, header->len, vvp );
332 static void layer_finalize ( VikLayer *vl )
334 g_assert ( vl != NULL );
335 if ( vik_layer_interfaces[vl->type]->free )
336 vik_layer_interfaces[vl->type]->free ( vl );
339 G_OBJECT_CLASS(parent_class)->finalize(G_OBJECT(vl));
342 /* sublayer switching */
343 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer )
345 if ( vik_layer_interfaces[l->type]->sublayer_toggle_visible )
346 return vik_layer_interfaces[l->type]->sublayer_toggle_visible ( l, subtype, sublayer );
347 return TRUE; /* if unknown, will always be visible */
350 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter *layer_iter )
353 l->iter = *layer_iter;
355 if ( vik_layer_interfaces[l->type]->realize )
356 vik_layer_interfaces[l->type]->realize ( l, vt, layer_iter );
359 void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection)
361 if ( vik_layer_interfaces[l->type]->set_menu_selection )
362 vik_layer_interfaces[l->type]->set_menu_selection ( l, selection );
365 guint16 vik_layer_get_menu_items_selection(VikLayer *l)
367 if ( vik_layer_interfaces[l->type]->get_menu_selection )
368 return(vik_layer_interfaces[l->type]->get_menu_selection (l));
370 return(vik_layer_interfaces[l->type]->menu_items_selection);
373 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp )
375 if ( vik_layer_interfaces[l->type]->add_menu_items )
376 vik_layer_interfaces[l->type]->add_menu_items ( l, menu, vlp );
379 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter )
381 if ( vik_layer_interfaces[l->type]->sublayer_add_menu_items )
382 return vik_layer_interfaces[l->type]->sublayer_add_menu_items ( l, menu, vlp, subtype, sublayer, iter );
387 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter )
389 if ( vik_layer_interfaces[l->type]->sublayer_rename_request )
390 return vik_layer_interfaces[l->type]->sublayer_rename_request ( l, newname, vlp, subtype, sublayer, iter );
394 GdkPixbuf *vik_layer_load_icon ( gint type )
396 g_assert ( type < VIK_LAYER_NUM_TYPES );
397 if ( vik_layer_interfaces[type]->icon )
398 return gdk_pixbuf_from_pixdata ( vik_layer_interfaces[type]->icon, FALSE, NULL );
402 gboolean vik_layer_set_param ( VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp )
404 if ( vik_layer_interfaces[layer->type]->set_param )
405 return vik_layer_interfaces[layer->type]->set_param ( layer, id, data, vp );
409 void vik_layer_post_read ( VikLayer *layer, gpointer vp )
411 if ( vik_layer_interfaces[layer->type]->post_read )
412 vik_layer_interfaces[layer->type]->post_read ( layer, vp );
415 static GtkWidget *properties_widget_new_widget ( VikLayerParam *param, VikLayerParamData data )
417 GtkWidget *rv = NULL;
418 switch ( param->widget_type )
420 case VIK_LAYER_WIDGET_COLOR:
421 if ( param->type == VIK_LAYER_PARAM_COLOR )
422 rv = gtk_color_button_new_with_color ( &(data.c) );
424 case VIK_LAYER_WIDGET_CHECKBUTTON:
425 if ( param->type == VIK_LAYER_PARAM_BOOLEAN )
427 //rv = gtk_check_button_new_with_label ( //param->title );
428 rv = gtk_check_button_new ();
430 gtk_toggle_button_set_active ( GTK_TOGGLE_BUTTON(rv), TRUE );
433 case VIK_LAYER_WIDGET_COMBOBOX:
435 if ( param->type == VIK_LAYER_PARAM_UINT && param->widget_data )
437 gchar **pstr = param->widget_data;
438 rv = gtk_combo_box_new_text ();
440 gtk_combo_box_append_text ( GTK_COMBO_BOX ( rv ), *(pstr++) );
441 if ( param->extra_widget_data ) /* map of alternate uint values for options */
444 for ( i = 0; ((const char **)param->widget_data)[i]; i++ )
445 if ( ((guint *)param->extra_widget_data)[i] == data.u )
447 gtk_combo_box_set_active ( GTK_COMBO_BOX(rv), i );
451 gtk_combo_box_set_active ( GTK_COMBO_BOX ( rv ), data.u );
455 case VIK_LAYER_WIDGET_RADIOGROUP:
456 /* widget_data and extra_widget_data are GList */
457 if ( param->type == VIK_LAYER_PARAM_UINT && param->widget_data )
459 rv = vik_radio_group_new ( param->widget_data );
460 if ( param->extra_widget_data ) /* map of alternate uint values for options */
463 int nb_elem = g_list_length(param->widget_data);
464 for ( i = 0; i < nb_elem; i++ )
465 if ( g_list_nth_data(param->extra_widget_data, i) == data.u )
467 vik_radio_group_set_selected ( VIK_RADIO_GROUP(rv), i );
471 else if ( data.u ) /* zero is already default */
472 vik_radio_group_set_selected ( VIK_RADIO_GROUP(rv), data.u );
475 case VIK_LAYER_WIDGET_SPINBUTTON:
476 if ( (param->type == VIK_LAYER_PARAM_DOUBLE || param->type == VIK_LAYER_PARAM_UINT
477 || param->type == VIK_LAYER_PARAM_INT) && param->widget_data )
479 gdouble init_val = (param->type == VIK_LAYER_PARAM_DOUBLE) ? data.d : (param->type == VIK_LAYER_PARAM_UINT ? data.u : data.i);
480 VikLayerParamScale *scale = (VikLayerParamScale *) param->widget_data;
481 rv = gtk_spin_button_new ( GTK_ADJUSTMENT(gtk_adjustment_new( init_val, scale->min, scale->max, scale->step, scale->step, scale->step )), scale->step, scale->digits );
484 case VIK_LAYER_WIDGET_ENTRY:
485 if ( param->type == VIK_LAYER_PARAM_STRING )
487 rv = gtk_entry_new ();
488 gtk_entry_set_text ( GTK_ENTRY(rv), data.s );
491 case VIK_LAYER_WIDGET_FILEENTRY:
492 if ( param->type == VIK_LAYER_PARAM_STRING )
494 rv = vik_file_entry_new ();
495 vik_file_entry_set_filename ( VIK_FILE_ENTRY(rv), data.s );
498 case VIK_LAYER_WIDGET_FILELIST:
499 if ( param->type == VIK_LAYER_PARAM_STRING_LIST )
501 rv = vik_file_list_new ( param->title );
502 vik_file_list_set_files ( VIK_FILE_LIST(rv), data.sl );
505 case VIK_LAYER_WIDGET_HSCALE:
506 if ( (param->type == VIK_LAYER_PARAM_DOUBLE || param->type == VIK_LAYER_PARAM_UINT
507 || param->type == VIK_LAYER_PARAM_INT) && param->widget_data )
509 gdouble init_val = (param->type == VIK_LAYER_PARAM_DOUBLE) ? data.d : (param->type == VIK_LAYER_PARAM_UINT ? data.u : data.i);
510 VikLayerParamScale *scale = (VikLayerParamScale *) param->widget_data;
511 rv = gtk_hscale_new_with_range ( scale->min, scale->max, scale->step );
512 gtk_scale_set_digits ( GTK_SCALE(rv), scale->digits );
513 gtk_range_set_value ( GTK_RANGE(rv), init_val );
519 static VikLayerParamData properties_widget_get_value ( GtkWidget *widget, VikLayerParam *param )
521 VikLayerParamData rv;
522 switch ( param->widget_type )
524 case VIK_LAYER_WIDGET_COLOR:
525 gtk_color_button_get_color ( GTK_COLOR_BUTTON(widget), &(rv.c) );
527 case VIK_LAYER_WIDGET_CHECKBUTTON:
528 rv.b = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));
530 case VIK_LAYER_WIDGET_COMBOBOX:
532 rv.i = gtk_combo_box_get_active ( GTK_COMBO_BOX(widget) );
533 if ( rv.i == -1 ) rv.i = 0;
535 if ( param->extra_widget_data )
536 rv.u = ((guint *)param->extra_widget_data)[rv.u];
539 case VIK_LAYER_WIDGET_RADIOGROUP:
540 rv.u = vik_radio_group_get_selected(VIK_RADIO_GROUP(widget));
541 if ( param->extra_widget_data )
542 rv.u = (guint32)g_list_nth_data(param->extra_widget_data, rv.u);
544 case VIK_LAYER_WIDGET_SPINBUTTON:
545 if ( param->type == VIK_LAYER_PARAM_UINT )
546 rv.u = gtk_spin_button_get_value_as_int ( GTK_SPIN_BUTTON(widget) );
547 else if ( param->type == VIK_LAYER_PARAM_INT )
548 rv.i = gtk_spin_button_get_value_as_int ( GTK_SPIN_BUTTON(widget) );
550 rv.d = gtk_spin_button_get_value ( GTK_SPIN_BUTTON(widget) );
552 case VIK_LAYER_WIDGET_ENTRY:
553 rv.s = gtk_entry_get_text ( GTK_ENTRY(widget) );
555 case VIK_LAYER_WIDGET_FILEENTRY:
556 rv.s = vik_file_entry_get_filename ( VIK_FILE_ENTRY(widget) );
558 case VIK_LAYER_WIDGET_FILELIST:
559 rv.sl = vik_file_list_get_files ( VIK_FILE_LIST(widget) );
561 case VIK_LAYER_WIDGET_HSCALE:
562 if ( param->type == VIK_LAYER_PARAM_UINT )
563 rv.u = (guint32) gtk_range_get_value ( GTK_RANGE(widget) );
564 else if ( param->type == VIK_LAYER_PARAM_INT )
565 rv.i = (gint32) gtk_range_get_value ( GTK_RANGE(widget) );
567 rv.d = gtk_range_get_value ( GTK_RANGE(widget) );
573 /* false if cancel, true if OK */
574 /* some would claim this wasn't written to be human-readable. */
575 static gboolean layer_properties_factory ( VikLayer *vl, gpointer vp )
577 VikLayerParam *params = vik_layer_interfaces[vl->type]->params;
578 guint16 params_count = vik_layer_interfaces[vl->type]->params_count;
579 guint16 i, j, widget_count = 0;
580 gboolean must_redraw = FALSE;
583 return TRUE; /* no params == no options, so all is good */
585 for ( i = 0; i < params_count; i++ )
586 if ( params[i].group != VIK_LAYER_NOT_IN_PROPERTIES )
589 if ( widget_count == 0)
593 /* create widgets and titles; place in table */
594 GtkWidget *dialog = gtk_dialog_new_with_buttons ( "Layer Properties",
595 VIK_GTK_WINDOW_FROM_WIDGET(vp),
596 GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
597 GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT,
598 GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, NULL );
601 gchar **groups = vik_layer_interfaces[vl->type]->params_groups;
602 guint8 groups_count = vik_layer_interfaces[vl->type]->params_groups_count;
604 GtkWidget *table = NULL;
605 GtkWidget **tables = NULL; /* for more than one group */
607 GtkWidget *notebook = NULL;
608 GtkWidget **widgets = g_malloc ( sizeof(GtkWidget *) * widget_count );
610 if ( groups && groups_count )
612 guint8 current_group;
613 guint16 tab_widget_count;
614 notebook = gtk_notebook_new ();
615 gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), notebook, FALSE, FALSE, 0);
616 tables = g_malloc ( sizeof(GtkWidget *) * groups_count );
617 for ( current_group = 0; current_group < groups_count; current_group++ )
619 tab_widget_count = 0;
620 for ( j = 0; j < params_count; j ++ )
621 if ( params[j].group == current_group )
624 if ( tab_widget_count )
626 tables[current_group] = gtk_table_new ( tab_widget_count, 1, FALSE );
627 gtk_notebook_append_page ( GTK_NOTEBOOK(notebook), tables[current_group], gtk_label_new(groups[current_group]) );
633 table = gtk_table_new( widget_count, 1, FALSE );
634 gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), table, FALSE, FALSE, 0);
637 for ( i = 0, j = 0; i < params_count; i++ )
639 if ( params[i].group != VIK_LAYER_NOT_IN_PROPERTIES )
642 table = tables[MAX(0, params[i].group)]; /* round up NOT_IN_GROUP, that's not reasonable here */
644 widgets[j] = properties_widget_new_widget ( &(params[i]),
645 vik_layer_interfaces[vl->type]->get_param ( vl, i ) );
647 g_assert ( widgets[j] != NULL );
649 gtk_table_attach ( GTK_TABLE(table), gtk_label_new(params[i].title), 0, 1, j, j+1, 0, 0, 0, 0 );
650 gtk_table_attach ( GTK_TABLE(table), widgets[j], 1, 2, j, j+1, GTK_EXPAND | GTK_FILL, 0, 2, 2 );
655 gtk_widget_show_all ( dialog );
657 resp = gtk_dialog_run (GTK_DIALOG (dialog));
658 if ( resp == GTK_RESPONSE_ACCEPT )
660 for ( i = 0, j = 0; i < params_count; i++ )
662 if ( params[i].group != VIK_LAYER_NOT_IN_PROPERTIES )
664 if ( vik_layer_interfaces[vl->type]->set_param ( vl, i,
665 properties_widget_get_value ( widgets[j], &(params[i]) ), vp ) )
670 vik_layer_post_read ( vl, vp ); /* update any gc's */
672 gtk_widget_destroy ( dialog ); /* hide before redrawing. */
676 vik_layer_emit_update ( vl ); /* if this is a new layer, it won't redraw twice because no on'es listening to this signal. */
677 return TRUE; /* user clicked OK */
682 gtk_widget_destroy ( dialog );