src/viklayer.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  */
  21
  22 #include "viking.h"
  23 #include "vikradiogroup.h"
  24
  25 /* functions common to all layers. */
  26 /* TODO longone: rename interface free -> finalize */
  27
  28 extern VikLayerInterface vik_aggregate_layer_interface;
  29 extern VikLayerInterface vik_trw_layer_interface;
  30 extern VikLayerInterface vik_maps_layer_interface;
  31 extern VikLayerInterface vik_coord_layer_interface;
  32 extern VikLayerInterface vik_georef_layer_interface;
  33
  34 enum {
  35   VL_UPDATE_SIGNAL,
  36   VL_LAST_SIGNAL
  37 };
  38 static guint layer_signals[VL_LAST_SIGNAL] = { 0 };
  39
  40 static GObjectClass *parent_class;
  41
  42 static void layer_class_init ( VikLayerClass *klass );
  43 static void layer_init ( VikLayer *vl );
  44 static void layer_finalize ( VikLayer *vl );
  45 static gboolean layer_properties_factory ( VikLayer *vl, gpointer vp );
  46
  47
  48 /* TODO longone: rename vik_layer_init -> set_type */
  49
  50 GType vik_layer_get_type ()
  51 {
  52   static GType vl_type = 0;
  53
  54   if (!vl_type)
  55   {
  56     static const GTypeInfo vl_info =
  57     {
  58       sizeof (VikLayerClass),
  59       NULL, /* base_init */
  60       NULL, /* base_finalize */
  61       (GClassInitFunc) layer_class_init, /* class init */
  62       NULL, /* class_finalize */
  63       NULL, /* class_data */
  64       sizeof (VikLayer),
  65       0,
  66       (GInstanceInitFunc) layer_init /* instance init */
  67     };
  68     vl_type = g_type_register_static ( G_TYPE_OBJECT, "VikLayer", &vl_info, 0 );
  69   }
  70
  71   return vl_type;
  72 }
  73
  74 static void layer_class_init (VikLayerClass *klass)
  75 {
  76   GObjectClass *object_class;
  77
  78   object_class = G_OBJECT_CLASS (klass);
  79
  80   object_class->finalize = (GObjectFinalizeFunc) layer_finalize;
  81
  82   parent_class = g_type_class_peek_parent (klass);
  83
  84   layer_signals[VL_UPDATE_SIGNAL] = g_signal_new ( "update", G_TYPE_FROM_CLASS (klass),
  85       G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION, G_STRUCT_OFFSET (VikLayerClass, update), NULL, NULL,
  86       g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
  87 }
  88
  89 void vik_layer_emit_update ( VikLayer *vl )
  90 {
  91   if ( vl->visible )
  92     g_signal_emit ( G_OBJECT(vl), layer_signals[VL_UPDATE_SIGNAL], 0 );
  93 }
  94
  95 static VikLayerInterface *vik_layer_interfaces[VIK_LAYER_NUM_TYPES] = {
  96   &vik_aggregate_layer_interface,
  97   &vik_trw_layer_interface,
  98   &vik_coord_layer_interface,
  99   &vik_georef_layer_interface,
 100   &vik_maps_layer_interface,
 101 };
 102
 103 VikLayerInterface *vik_layer_get_interface ( gint type )
 104 {
 105   g_assert ( type < VIK_LAYER_NUM_TYPES );
 106   return vik_layer_interfaces[type];
 107 }
 108
 109 static void layer_init ( VikLayer *vl )
 110 {
 111   vl->visible = TRUE;
 112   vl->name = NULL;
 113   vl->realized = FALSE;
 114 }
 115
 116 void vik_layer_init ( VikLayer *vl, gint type )
 117 {
 118   vl->type = type;
 119 }
 120
 121 /* frees old name */
 122 void vik_layer_rename ( VikLayer *l, const gchar *new_name )
 123 {
 124   g_assert ( l != NULL);
 125   if ( l->name )
 126     g_free ( l->name );
 127   l->name = g_strdup ( new_name );
 128 }
 129
 130 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name )
 131 {
 132   g_assert ( l != NULL);
 133   if ( l->name )
 134     g_free ( l->name );
 135   l->name = new_name;
 136 }
 137
 138 VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive )
 139 {
 140   VikLayer *new_layer = NULL;
 141   g_assert ( type < VIK_LAYER_NUM_TYPES );
 142
 143   new_layer = vik_layer_interfaces[type]->create ( vp );
 144
 145   g_assert ( new_layer != NULL );
 146
 147   if ( interactive )
 148   {
 149     if ( vik_layer_properties ( new_layer, vp ) )
 150       vik_layer_rename ( VIK_LAYER(new_layer), vik_layer_interfaces[type]->name );
 151     else
 152     {
 153       g_object_unref ( G_OBJECT(new_layer) ); /* cancel that */
 154       new_layer = NULL;
 155     }
 156   }
 157   return new_layer;
 158 }
 159
 160 /* returns TRUE if OK was pressed */
 161 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp )
 162 {
 163   if ( vik_layer_interfaces[layer->type]->properties )
 164     return vik_layer_interfaces[layer->type]->properties ( layer, vp );
 165   return layer_properties_factory ( layer, vp );
 166 }
 167
 168 void vik_layer_draw ( VikLayer *l, gpointer data )
 169 {
 170   if ( l->visible )
 171     if ( vik_layer_interfaces[l->type]->draw )
 172       vik_layer_interfaces[l->type]->draw ( l, data );
 173 }
 174
 175 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode )
 176 {
 177   if ( vik_layer_interfaces[l->type]->change_coord_mode )
 178     vik_layer_interfaces[l->type]->change_coord_mode ( l, mode );
 179 }
 180
 181 VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp )
 182 {
 183   if ( vik_layer_interfaces[vl->type]->copy )
 184   {
 185     VikLayer *rv = vik_layer_interfaces[vl->type]->copy ( vl, vp );
 186     if ( rv )
 187     {
 188       vik_layer_rename ( rv, vl->name );
 189       rv->visible = vl->visible;
 190     }
 191     return rv;
 192   }
 193   else
 194     return NULL;
 195 }
 196
 197
 198 static void layer_finalize ( VikLayer *vl )
 199 {
 200   g_assert ( vl != NULL );
 201   if ( vik_layer_interfaces[vl->type]->free )
 202     vik_layer_interfaces[vl->type]->free ( vl );
 203   if ( vl->name )
 204     g_free ( vl->name );
 205   G_OBJECT_CLASS(parent_class)->finalize(G_OBJECT(vl));
 206 }
 207
 208 /* sublayer switching */
 209 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer )
 210 {
 211   if ( vik_layer_interfaces[l->type]->sublayer_toggle_visible )
 212     return vik_layer_interfaces[l->type]->sublayer_toggle_visible ( l, subtype, sublayer );
 213   return TRUE; /* if unknown, will always be visible */
 214 }
 215
 216 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter *layer_iter )
 217 {
 218   l->vt = vt;
 219   l->iter = *layer_iter;
 220   l->realized = TRUE;
 221   if ( vik_layer_interfaces[l->type]->realize )
 222     vik_layer_interfaces[l->type]->realize ( l, vt, layer_iter );
 223 }
 224
 225 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp )
 226 {
 227   if ( vik_layer_interfaces[l->type]->add_menu_items )
 228     vik_layer_interfaces[l->type]->add_menu_items ( l, menu, vlp );
 229 }
 230
 231 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter )
 232 {
 233   if ( vik_layer_interfaces[l->type]->sublayer_add_menu_items )
 234     return vik_layer_interfaces[l->type]->sublayer_add_menu_items ( l, menu, vlp, subtype, sublayer, iter );
 235   return FALSE;
 236 }
 237
 238
 239 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter )
 240 {
 241   if ( vik_layer_interfaces[l->type]->sublayer_rename_request )
 242     return vik_layer_interfaces[l->type]->sublayer_rename_request ( l, newname, vlp, subtype, sublayer, iter );
 243   return NULL;
 244 }
 245
 246 GdkPixbuf *vik_layer_load_icon ( gint type )
 247 {
 248   g_assert ( type < VIK_LAYER_NUM_TYPES );
 249   if ( vik_layer_interfaces[type]->icon )
 250     return gdk_pixbuf_from_pixdata ( vik_layer_interfaces[type]->icon, FALSE, NULL );
 251   return NULL;
 252 }
 253
 254 gboolean vik_layer_set_param ( VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp )
 255 {
 256   if ( vik_layer_interfaces[layer->type]->set_param )
 257     return vik_layer_interfaces[layer->type]->set_param ( layer, id, data, vp );
 258   return FALSE;
 259 }
 260
 261 void vik_layer_post_read ( VikLayer *layer, gpointer vp )
 262 {
 263   if ( vik_layer_interfaces[layer->type]->post_read )
 264     vik_layer_interfaces[layer->type]->post_read ( layer, vp );
 265 }
 266
 267 static GtkWidget *properties_widget_new_widget ( VikLayerParam *param, VikLayerParamData data )
 268 {
 269   GtkWidget *rv;
 270   switch ( param->widget_type )
 271   {
 272     case VIK_LAYER_WIDGET_COLOR:
 273       if ( param->type == VIK_LAYER_PARAM_COLOR )
 274         rv = gtk_color_button_new_with_color ( &(data.c) );
 275       break;
 276     case VIK_LAYER_WIDGET_CHECKBUTTON:
 277       if ( param->type == VIK_LAYER_PARAM_BOOLEAN )
 278       {
 279         //rv = gtk_check_button_new_with_label ( //param->title );
 280         rv = gtk_check_button_new ();
 281         if ( data.b )
 282           gtk_toggle_button_set_active ( GTK_TOGGLE_BUTTON(rv), TRUE );
 283       }
 284       break;
 285     case VIK_LAYER_WIDGET_COMBOBOX:
 286 #ifndef GTK_2_2
 287       if ( param->type == VIK_LAYER_PARAM_UINT && param->widget_data )
 288       {
 289         gchar **pstr = param->widget_data;
 290         rv = gtk_combo_box_new_text ();
 291         while ( *pstr )
 292           gtk_combo_box_append_text ( GTK_COMBO_BOX ( rv ), *(pstr++) );
 293         if ( param->extra_widget_data ) /* map of alternate uint values for options */
 294         {
 295           int i;
 296           for ( i = 0; ((const char **)param->widget_data)[i]; i++ )
 297             if ( ((guint *)param->extra_widget_data)[i] == data.u )
 298             {
 299               gtk_combo_box_set_active ( GTK_COMBO_BOX(rv), i );
 300               break;
 301             }
 302         }
 303         gtk_combo_box_set_active ( GTK_COMBO_BOX ( rv ), data.u );
 304       }
 305       break;
 306 #endif
 307     case VIK_LAYER_WIDGET_RADIOGROUP:
 308       if ( param->type == VIK_LAYER_PARAM_UINT && param->widget_data )
 309       {
 310         rv = vik_radio_group_new ( (const gchar **) param->widget_data );
 311         if ( param->extra_widget_data ) /* map of alternate uint values for options */
 312         {
 313           int i;
 314           for ( i = 0; ((const char **)param->widget_data)[i]; i++ )
 315             if ( ((guint *)param->extra_widget_data)[i] == data.u )
 316             {
 317               vik_radio_group_set_selected ( VIK_RADIO_GROUP(rv), i );
 318               break;
 319             }
 320         }
 321         else if ( data.u ) /* zero is already default */
 322           vik_radio_group_set_selected ( VIK_RADIO_GROUP(rv), data.u );
 323       }
 324       break;
 325     case VIK_LAYER_WIDGET_SPINBUTTON:
 326       if ( (param->type == VIK_LAYER_PARAM_DOUBLE || param->type == VIK_LAYER_PARAM_UINT
 327            || param->type == VIK_LAYER_PARAM_INT)  && param->widget_data )
 328       {
 329         gdouble init_val = (param->type == VIK_LAYER_PARAM_DOUBLE) ? data.d : (param->type == VIK_LAYER_PARAM_UINT ? data.u : data.i);
 330         VikLayerParamScale *scale = (VikLayerParamScale *) param->widget_data;
 331         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 );
 332       }
 333     break;
 334     case VIK_LAYER_WIDGET_ENTRY:
 335       if ( param->type == VIK_LAYER_PARAM_STRING )
 336       {
 337         rv = gtk_entry_new ();
 338         gtk_entry_set_text ( GTK_ENTRY(rv), data.s );
 339       }
 340       break;
 341     case VIK_LAYER_WIDGET_FILEENTRY:
 342       if ( param->type == VIK_LAYER_PARAM_STRING )
 343       {
 344         rv = vik_file_entry_new ();
 345         vik_file_entry_set_filename ( VIK_FILE_ENTRY(rv), data.s );
 346       }
 347       break;
 348     case VIK_LAYER_WIDGET_HSCALE:
 349       if ( (param->type == VIK_LAYER_PARAM_DOUBLE || param->type == VIK_LAYER_PARAM_UINT
 350            || param->type == VIK_LAYER_PARAM_INT)  && param->widget_data )
 351       {
 352         gdouble init_val = (param->type == VIK_LAYER_PARAM_DOUBLE) ? data.d : (param->type == VIK_LAYER_PARAM_UINT ? data.u : data.i);
 353         VikLayerParamScale *scale = (VikLayerParamScale *) param->widget_data;
 354         rv = gtk_hscale_new_with_range ( scale->min, scale->max, scale->step );
 355         gtk_scale_set_digits ( GTK_SCALE(rv), scale->digits );
 356         gtk_range_set_value ( GTK_RANGE(rv), init_val );
 357       }
 358   }
 359   return rv;
 360 }
 361
 362 static VikLayerParamData properties_widget_get_value ( GtkWidget *widget, VikLayerParam *param )
 363 {
 364   VikLayerParamData rv;
 365   switch ( param->widget_type )
 366   {
 367     case VIK_LAYER_WIDGET_COLOR:
 368       gtk_color_button_get_color ( GTK_COLOR_BUTTON(widget), &(rv.c) );
 369       break;
 370     case VIK_LAYER_WIDGET_CHECKBUTTON:
 371       rv.b = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));
 372       break;
 373     case VIK_LAYER_WIDGET_COMBOBOX:
 374 #ifndef GTK_2_2
 375       rv.i = gtk_combo_box_get_active ( GTK_COMBO_BOX(widget) );
 376       if ( rv.i == -1 ) rv.i = 0;
 377       rv.u = rv.i;
 378       if ( param->extra_widget_data )
 379         rv.u = ((guint *)param->extra_widget_data)[rv.u];
 380       break;
 381 #endif
 382     case VIK_LAYER_WIDGET_RADIOGROUP:
 383       rv.u = vik_radio_group_get_selected(VIK_RADIO_GROUP(widget));
 384       if ( param->extra_widget_data )
 385         rv.u = ((guint *)param->extra_widget_data)[rv.u];
 386       break;
 387     case VIK_LAYER_WIDGET_SPINBUTTON:
 388       if ( param->type == VIK_LAYER_PARAM_UINT )
 389         rv.u = gtk_spin_button_get_value_as_int ( GTK_SPIN_BUTTON(widget) );
 390       else if ( param->type == VIK_LAYER_PARAM_INT )
 391         rv.i = gtk_spin_button_get_value_as_int ( GTK_SPIN_BUTTON(widget) );
 392       else
 393         rv.d = gtk_spin_button_get_value ( GTK_SPIN_BUTTON(widget) );
 394       break;
 395     case VIK_LAYER_WIDGET_ENTRY:
 396       rv.s = gtk_entry_get_text ( GTK_ENTRY(widget) );
 397       break;
 398     case VIK_LAYER_WIDGET_FILEENTRY:
 399       rv.s = vik_file_entry_get_filename ( VIK_FILE_ENTRY(widget) );
 400       break;
 401     case VIK_LAYER_WIDGET_HSCALE:
 402       if ( param->type == VIK_LAYER_PARAM_UINT )
 403         rv.u = (guint32) gtk_range_get_value ( GTK_RANGE(widget) );
 404       else if ( param->type == VIK_LAYER_PARAM_INT )
 405         rv.i = (gint32) gtk_range_get_value ( GTK_RANGE(widget) );
 406       else
 407         rv.d = gtk_range_get_value ( GTK_RANGE(widget) );
 408       break;
 409   }
 410   return rv;
 411 }
 412
 413 /* false if cancel, true if OK */
 414 /* some would claim this wasn't written to be human-readable. */
 415 static gboolean layer_properties_factory ( VikLayer *vl, gpointer vp )
 416 {
 417   VikLayerParam *params = vik_layer_interfaces[vl->type]->params;
 418   guint16 params_count = vik_layer_interfaces[vl->type]->params_count;
 419   guint16 i, j, widget_count = 0;
 420   gboolean must_redraw = FALSE;
 421
 422   if ( ! params )
 423     return TRUE; /* no params == no options, so all is good */
 424
 425   for ( i = 0; i < params_count; i++ )
 426     if ( params[i].group != VIK_LAYER_NOT_IN_PROPERTIES )
 427       widget_count++;
 428
 429   if ( widget_count == 0)
 430     return FALSE;
 431   else
 432   {
 433     /* create widgets and titles; place in table */
 434     GtkWidget *dialog = gtk_dialog_new_with_buttons ( "Layer Properties",
 435                             VIK_GTK_WINDOW_FROM_WIDGET(vp),
 436                             GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
 437                             GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT,
 438                             GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, NULL );
 439     gint resp;
 440
 441     gchar **groups = vik_layer_interfaces[vl->type]->params_groups;
 442     guint8 groups_count = vik_layer_interfaces[vl->type]->params_groups_count;
 443
 444     GtkWidget *table = NULL;
 445     GtkWidget **tables = NULL; /* for more than one group */
 446
 447     GtkWidget *notebook = NULL;
 448     GtkWidget **widgets = g_malloc ( sizeof(GtkWidget *) * widget_count );
 449
 450     if ( groups && groups_count )
 451     {
 452       guint8 current_group;
 453       guint16 tab_widget_count;
 454       notebook = gtk_notebook_new ();
 455       gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), notebook, FALSE, FALSE, 0);
 456       tables = g_malloc ( sizeof(GtkWidget *) * groups_count );
 457       for ( current_group = 0; current_group < groups_count; current_group++ )
 458       {
 459         tab_widget_count = 0;
 460         for ( j = 0; j < params_count; j ++ )
 461           if ( params[j].group == current_group )
 462             tab_widget_count++;
 463
 464         if ( tab_widget_count )
 465         {
 466           tables[current_group] = gtk_table_new ( tab_widget_count, 1, FALSE );
 467           gtk_notebook_append_page ( GTK_NOTEBOOK(notebook), tables[current_group], gtk_label_new(groups[current_group]) );
 468         }
 469       }
 470     }
 471     else
 472     {
 473       table = gtk_table_new( widget_count, 1, FALSE );
 474       gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), table, FALSE, FALSE, 0);
 475     }
 476
 477     for ( i = 0, j = 0; i < params_count; i++ )
 478     {
 479       if ( params[i].group != VIK_LAYER_NOT_IN_PROPERTIES )
 480       {
 481         if ( tables )
 482           table = tables[MAX(0, params[i].group)]; /* round up NOT_IN_GROUP, that's not reasonable here */
 483
 484         widgets[j] = properties_widget_new_widget ( &(params[i]),
 485                          vik_layer_interfaces[vl->type]->get_param ( vl, i ) );
 486
 487         g_assert ( widgets[j] != NULL );
 488
 489         gtk_table_attach ( GTK_TABLE(table), gtk_label_new(params[i].title), 0, 1, j, j+1, 0, 0, 0, 0 );
 490         gtk_table_attach ( GTK_TABLE(table), widgets[j], 1, 2, j, j+1, GTK_EXPAND | GTK_FILL, 0, 2, 2 );
 491         j++;
 492       }
 493     }
 494
 495     gtk_widget_show_all ( dialog );
 496
 497     resp = gtk_dialog_run (GTK_DIALOG (dialog));
 498     if ( resp == GTK_RESPONSE_ACCEPT )
 499     {
 500       for ( i = 0, j = 0; i < params_count; i++ )
 501       {
 502         if ( params[i].group != VIK_LAYER_NOT_IN_PROPERTIES )
 503         {
 504           if ( vik_layer_interfaces[vl->type]->set_param ( vl, i,
 505               properties_widget_get_value ( widgets[j], &(params[i]) ), vp ) )
 506             must_redraw = TRUE;
 507           j++;
 508         }
 509       }
 510       vik_layer_post_read ( vl, vp ); /* update any gc's */
 511
 512       gtk_widget_destroy ( dialog ); /* hide before redrawing. */
 513       g_free ( widgets );
 514
 515       if ( must_redraw )
 516         vik_layer_emit_update ( vl ); /* if this is a new layer, it won't redraw twice because no on'es listening to this signal. */
 517       return TRUE; /* user clicked OK */
 518     }
 519
 520     if ( tables )
 521       g_free ( tables );
 522     gtk_widget_destroy ( dialog );
 523     g_free ( widgets );
 524     return FALSE;
 525   }
 526 }