divelist.c

   1 /* divelist.c */
   2 /* this creates the UI for the dive list -
   3  * controlled through the following interfaces:
   4  *
   5  * void flush_divelist(struct dive *dive)
   6  * GtkWidget dive_list_create(void)
   7  * void dive_list_update_dives(void)
   8  * void update_dive_list_units(void)
   9  * void set_divelist_font(const char *font)
  10  * void mark_divelist_changed(int changed)
  11  * int unsaved_changes()
  12  */
  13 #include <stdio.h>
  14 #include <stdlib.h>
  15 #include <string.h>
  16 #include <time.h>
  17
  18 #include "divelist.h"
  19 #include "dive.h"
  20 #include "display.h"
  21 #include "display-gtk.h"
  22
  23 struct DiveList {
  24         GtkWidget    *tree_view;
  25         GtkWidget    *container_widget;
  26         GtkListStore *model;
  27         GtkTreeViewColumn *date, *depth, *duration, *location;
  28         GtkTreeViewColumn *temperature, *cylinder, *nitrox, *sac;
  29         int changed;
  30 };
  31
  32 static struct DiveList dive_list;
  33
  34 /*
  35  * The dive list has the dive data in both string format (for showing)
  36  * and in "raw" format (for sorting purposes)
  37  */
  38 enum {
  39         DIVE_INDEX = 0,
  40         DIVE_DATE,              /* time_t: dive->when */
  41         DIVE_DEPTH,             /* int: dive->maxdepth in mm */
  42         DIVE_DURATION,          /* int: in seconds */
  43         DIVE_TEMPERATURE,       /* int: in mkelvin */
  44         DIVE_CYLINDER,
  45         DIVE_NITROX,            /* int: in permille */
  46         DIVE_SAC,               /* int: in ml/min */
  47         DIVE_LOCATION,          /* "2nd Cathedral, Lanai" */
  48         DIVELIST_COLUMNS
  49 };
  50
  51 static void selection_cb(GtkTreeSelection *selection, GtkTreeModel *model)
  52 {
  53         GtkTreeIter iter;
  54         GValue value = {0, };
  55
  56         if (!gtk_tree_selection_get_selected(selection, NULL, &iter))
  57                 return;
  58
  59         gtk_tree_model_get_value(model, &iter, DIVE_INDEX, &value);
  60         selected_dive = g_value_get_int(&value);
  61         repaint_dive();
  62 }
  63
  64 static void date_data_func(GtkTreeViewColumn *col,
  65                            GtkCellRenderer *renderer,
  66                            GtkTreeModel *model,
  67                            GtkTreeIter *iter,
  68                            gpointer data)
  69 {
  70         int val;
  71         struct tm *tm;
  72         time_t when;
  73         char buffer[40];
  74
  75         gtk_tree_model_get(model, iter, DIVE_DATE, &val, -1);
  76
  77         /* 2038 problem */
  78         when = val;
  79
  80         tm = gmtime(&when);
  81         snprintf(buffer, sizeof(buffer),
  82                 "%s, %s %d, %d %02d:%02d",
  83                 weekday(tm->tm_wday),
  84                 monthname(tm->tm_mon),
  85                 tm->tm_mday, tm->tm_year + 1900,
  86                 tm->tm_hour, tm->tm_min);
  87         g_object_set(renderer, "text", buffer, NULL);
  88 }
  89
  90 static void depth_data_func(GtkTreeViewColumn *col,
  91                             GtkCellRenderer *renderer,
  92                             GtkTreeModel *model,
  93                             GtkTreeIter *iter,
  94                             gpointer data)
  95 {
  96         int depth, integer, frac, len;
  97         char buffer[40];
  98
  99         gtk_tree_model_get(model, iter, DIVE_DEPTH, &depth, -1);
 100
 101         switch (output_units.length) {
 102         case METERS:
 103                 /* To tenths of meters */
 104                 depth = (depth + 49) / 100;
 105                 integer = depth / 10;
 106                 frac = depth % 10;
 107                 if (integer < 20)
 108                         break;
 109                 frac = -1;
 110                 /* Rounding? */
 111                 break;
 112         case FEET:
 113                 integer = mm_to_feet(depth) + 0.5;
 114                 frac = -1;
 115                 break;
 116         default:
 117                 return;
 118         }
 119         len = snprintf(buffer, sizeof(buffer), "%d", integer);
 120         if (frac >= 0)
 121                 len += snprintf(buffer+len, sizeof(buffer)-len, ".%d", frac);
 122
 123         g_object_set(renderer, "text", buffer, NULL);
 124 }
 125
 126 static void duration_data_func(GtkTreeViewColumn *col,
 127                                GtkCellRenderer *renderer,
 128                                GtkTreeModel *model,
 129                                GtkTreeIter *iter,
 130                                gpointer data)
 131 {
 132         unsigned int sec;
 133         char buffer[16];
 134
 135         gtk_tree_model_get(model, iter, DIVE_DURATION, &sec, -1);
 136         snprintf(buffer, sizeof(buffer), "%d:%02d", sec / 60, sec % 60);
 137
 138         g_object_set(renderer, "text", buffer, NULL);
 139 }
 140
 141 static void temperature_data_func(GtkTreeViewColumn *col,
 142                                   GtkCellRenderer *renderer,
 143                                   GtkTreeModel *model,
 144                                   GtkTreeIter *iter,
 145                                   gpointer data)
 146 {
 147         int value;
 148         char buffer[80];
 149
 150         gtk_tree_model_get(model, iter, DIVE_TEMPERATURE, &value, -1);
 151
 152         *buffer = 0;
 153         if (value) {
 154                 double deg;
 155                 switch (output_units.temperature) {
 156                 case CELSIUS:
 157                         deg = mkelvin_to_C(value);
 158                         break;
 159                 case FAHRENHEIT:
 160                         deg = mkelvin_to_F(value);
 161                         break;
 162                 default:
 163                         return;
 164                 }
 165                 snprintf(buffer, sizeof(buffer), "%.1f", deg);
 166         }
 167
 168         g_object_set(renderer, "text", buffer, NULL);
 169 }
 170
 171 static void nitrox_data_func(GtkTreeViewColumn *col,
 172                              GtkCellRenderer *renderer,
 173                              GtkTreeModel *model,
 174                              GtkTreeIter *iter,
 175                              gpointer data)
 176 {
 177         int value;
 178         char buffer[80];
 179
 180         gtk_tree_model_get(model, iter, DIVE_NITROX, &value, -1);
 181
 182         if (value)
 183                 snprintf(buffer, sizeof(buffer), "%.1f", value/10.0);
 184         else
 185                 strcpy(buffer, "air");
 186
 187         g_object_set(renderer, "text", buffer, NULL);
 188 }
 189
 190 /* Render the SAC data (integer value of "ml / min") */
 191 static void sac_data_func(GtkTreeViewColumn *col,
 192                           GtkCellRenderer *renderer,
 193                           GtkTreeModel *model,
 194                           GtkTreeIter *iter,
 195                           gpointer data)
 196 {
 197         int value;
 198         const double liters_per_cuft = 28.317;
 199         const char *fmt;
 200         char buffer[16];
 201         double sac;
 202
 203         gtk_tree_model_get(model, iter, DIVE_SAC, &value, -1);
 204
 205         if (!value) {
 206                 g_object_set(renderer, "text", "", NULL);
 207                 return;
 208         }
 209
 210         sac = value / 1000.0;
 211         switch (output_units.volume) {
 212         case LITER:
 213                 fmt = "%4.1f";
 214                 break;
 215         case CUFT:
 216                 fmt = "%4.2f";
 217                 sac /= liters_per_cuft;
 218                 break;
 219         }
 220         snprintf(buffer, sizeof(buffer), fmt, sac);
 221
 222         g_object_set(renderer, "text", buffer, NULL);
 223 }
 224
 225 /*
 226  * Return air usage (in liters).
 227  */
 228 static double calculate_airuse(struct dive *dive)
 229 {
 230         double airuse = 0;
 231         int i;
 232
 233         for (i = 0; i < MAX_CYLINDERS; i++) {
 234                 cylinder_t *cyl = dive->cylinder + i;
 235                 int size = cyl->type.size.mliter;
 236                 double kilo_atm;
 237
 238                 if (!size)
 239                         continue;
 240
 241                 kilo_atm = (cyl->start.mbar - cyl->end.mbar) / 1013250.0;
 242
 243                 /* Liters of air at 1 atm == milliliters at 1k atm*/
 244                 airuse += kilo_atm * size;
 245         }
 246         return airuse;
 247 }
 248
 249 static void get_sac(struct dive *dive, int *val)
 250 {
 251         double airuse, pressure, sac;
 252
 253         *val = 0;
 254         airuse = calculate_airuse(dive);
 255         if (!airuse)
 256                 return;
 257         if (!dive->duration.seconds)
 258                 return;
 259
 260         /* Mean pressure in atm: 1 atm per 10m */
 261         pressure = 1 + (dive->meandepth.mm / 10000.0);
 262         sac = airuse / pressure * 60 / dive->duration.seconds;
 263
 264         /* milliliters per minute.. */
 265         *val = sac * 1000;
 266 }
 267
 268 static void get_string(char **str, const char *s)
 269 {
 270         int len;
 271         char *n;
 272
 273         if (!s)
 274                 s = "";
 275         len = strlen(s);
 276         if (len > 40)
 277                 len = 40;
 278         n = malloc(len+1);
 279         memcpy(n, s, len);
 280         n[len] = 0;
 281         *str = n;
 282 }
 283
 284 static void get_location(struct dive *dive, char **str)
 285 {
 286         get_string(str, dive->location);
 287 }
 288
 289 static void get_cylinder(struct dive *dive, char **str)
 290 {
 291         get_string(str, dive->cylinder[0].type.description);
 292 }
 293
 294 static void fill_one_dive(struct dive *dive,
 295                           GtkTreeModel *model,
 296                           GtkTreeIter *iter)
 297 {
 298         int sac;
 299         char *location, *cylinder;
 300
 301         get_cylinder(dive, &cylinder);
 302         get_location(dive, &location);
 303         get_sac(dive, &sac);
 304
 305         /*
 306          * We only set the fields that changed: the strings.
 307          * The core data itself is unaffected by units
 308          */
 309         gtk_list_store_set(GTK_LIST_STORE(model), iter,
 310                 DIVE_LOCATION, location,
 311                 DIVE_CYLINDER, cylinder,
 312                 DIVE_SAC, sac,
 313                 -1);
 314 }
 315
 316 static gboolean set_one_dive(GtkTreeModel *model,
 317                              GtkTreePath *path,
 318                              GtkTreeIter *iter,
 319                              gpointer data)
 320 {
 321         GValue value = {0, };
 322         struct dive *dive;
 323
 324         /* Get the dive number */
 325         gtk_tree_model_get_value(model, iter, DIVE_INDEX, &value);
 326         dive = get_dive(g_value_get_int(&value));
 327         if (!dive)
 328                 return TRUE;
 329         if (data && dive != data)
 330                 return FALSE;
 331
 332         fill_one_dive(dive, model, iter);
 333         return dive == data;
 334 }
 335
 336 void flush_divelist(struct dive *dive)
 337 {
 338         GtkTreeModel *model = GTK_TREE_MODEL(dive_list.model);
 339
 340         gtk_tree_model_foreach(model, set_one_dive, dive);
 341 }
 342
 343 void set_divelist_font(const char *font)
 344 {
 345         PangoFontDescription *font_desc = pango_font_description_from_string(font);
 346         gtk_widget_modify_font(dive_list.tree_view, font_desc);
 347         pango_font_description_free(font_desc);
 348 }
 349
 350 void update_dive_list_units(void)
 351 {
 352         const char *unit;
 353         GtkTreeModel *model = GTK_TREE_MODEL(dive_list.model);
 354
 355         switch (output_units.length) {
 356         case METERS:
 357                 unit = "m";
 358                 break;
 359         case FEET:
 360                 unit = "ft";
 361                 break;
 362         }
 363         gtk_tree_view_column_set_title(dive_list.depth, unit);
 364
 365         switch (output_units.temperature) {
 366         case CELSIUS:
 367                 unit = UTF8_DEGREE "C";
 368                 break;
 369         case FAHRENHEIT:
 370                 unit = UTF8_DEGREE "F";
 371                 break;
 372         case KELVIN:
 373                 unit = "Kelvin";
 374                 break;
 375         }
 376         gtk_tree_view_column_set_title(dive_list.temperature, unit);
 377
 378         gtk_tree_model_foreach(model, set_one_dive, NULL);
 379 }
 380
 381 static void fill_dive_list(void)
 382 {
 383         int i;
 384         GtkTreeIter iter;
 385         GtkListStore *store;
 386
 387         store = GTK_LIST_STORE(dive_list.model);
 388
 389         for (i = 0; i < dive_table.nr; i++) {
 390                 struct dive *dive = dive_table.dives[i];
 391
 392                 gtk_list_store_append(store, &iter);
 393                 gtk_list_store_set(store, &iter,
 394                         DIVE_INDEX, i,
 395                         DIVE_DATE, dive->when,
 396                         DIVE_DEPTH, dive->maxdepth,
 397                         DIVE_DURATION, dive->duration.seconds,
 398                         DIVE_LOCATION, "location",
 399                         DIVE_TEMPERATURE, dive->watertemp.mkelvin,
 400                         DIVE_NITROX, dive->cylinder[0].gasmix.o2,
 401                         DIVE_SAC, 0,
 402                         -1);
 403         }
 404
 405         update_dive_list_units();
 406         if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(dive_list.model), &iter)) {
 407                 GtkTreeSelection *selection;
 408                 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(dive_list.tree_view));
 409                 gtk_tree_selection_select_iter(selection, &iter);
 410         }
 411 }
 412
 413 void dive_list_update_dives(void)
 414 {
 415         gtk_list_store_clear(GTK_LIST_STORE(dive_list.model));
 416         fill_dive_list();
 417         repaint_dive();
 418 }
 419
 420 typedef void (*data_func_t)(GtkTreeViewColumn *col,
 421                             GtkCellRenderer *renderer,
 422                             GtkTreeModel *model,
 423                             GtkTreeIter *iter,
 424                             gpointer data);
 425
 426 static GtkTreeViewColumn *divelist_column(struct DiveList *dl, int index, const char *title,
 427                                         data_func_t data_func, PangoAlignment align)
 428 {
 429         GtkCellRenderer *renderer;
 430         GtkTreeViewColumn *col;
 431         double xalign = 0.0; /* left as default */
 432
 433         renderer = gtk_cell_renderer_text_new();
 434         col = gtk_tree_view_column_new();
 435
 436         gtk_tree_view_column_set_title(col, title);
 437         gtk_tree_view_column_set_sort_column_id(col, index);
 438         gtk_tree_view_column_set_resizable(col, TRUE);
 439         gtk_tree_view_column_pack_start(col, renderer, TRUE);
 440         if (data_func)
 441                 gtk_tree_view_column_set_cell_data_func(col, renderer, data_func, NULL, NULL);
 442         else
 443                 gtk_tree_view_column_add_attribute(col, renderer, "text", index);
 444         gtk_object_set(GTK_OBJECT(renderer), "alignment", align, NULL);
 445         switch (align) {
 446         case PANGO_ALIGN_LEFT:
 447                 xalign = 0.0;
 448                 break;
 449         case PANGO_ALIGN_CENTER:
 450                 xalign = 0.5;
 451                 break;
 452         case PANGO_ALIGN_RIGHT:
 453                 xalign = 1.0;
 454                 break;
 455         }
 456         gtk_cell_renderer_set_alignment(GTK_CELL_RENDERER(renderer), xalign, 0.5);
 457         gtk_tree_view_append_column(GTK_TREE_VIEW(dl->tree_view), col);
 458         return col;
 459 }
 460
 461 /*
 462  * This is some crazy crap. The only way to get default focus seems
 463  * to be to grab focus as the widget is being shown the first time.
 464  */
 465 static void realize_cb(GtkWidget *tree_view, gpointer userdata)
 466 {
 467         gtk_widget_grab_focus(tree_view);
 468 }
 469
 470 GtkWidget *dive_list_create(void)
 471 {
 472         GtkTreeSelection  *selection;
 473
 474         dive_list.model = gtk_list_store_new(DIVELIST_COLUMNS,
 475                                 G_TYPE_INT,                     /* index */
 476                                 G_TYPE_INT,                     /* Date */
 477                                 G_TYPE_INT,                     /* Depth */
 478                                 G_TYPE_INT,                     /* Duration */
 479                                 G_TYPE_INT,                     /* Temperature */
 480                                 G_TYPE_STRING,                  /* Cylinder */
 481                                 G_TYPE_INT,                     /* Nitrox */
 482                                 G_TYPE_INT,                     /* SAC */
 483                                 G_TYPE_STRING                   /* Location */
 484                                 );
 485         dive_list.tree_view = gtk_tree_view_new_with_model(GTK_TREE_MODEL(dive_list.model));
 486         set_divelist_font(divelist_font);
 487
 488         selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(dive_list.tree_view));
 489
 490         gtk_tree_selection_set_mode(GTK_TREE_SELECTION(selection), GTK_SELECTION_BROWSE);
 491         gtk_widget_set_size_request(dive_list.tree_view, 200, 200);
 492
 493         dive_list.date = divelist_column(&dive_list, DIVE_DATE, "Date", date_data_func, PANGO_ALIGN_LEFT);
 494         dive_list.depth = divelist_column(&dive_list, DIVE_DEPTH, "ft", depth_data_func, PANGO_ALIGN_RIGHT);
 495         dive_list.duration = divelist_column(&dive_list, DIVE_DURATION, "min", duration_data_func, PANGO_ALIGN_RIGHT);
 496         dive_list.temperature = divelist_column(&dive_list, DIVE_TEMPERATURE, UTF8_DEGREE "F", temperature_data_func, PANGO_ALIGN_RIGHT);
 497         dive_list.cylinder = divelist_column(&dive_list, DIVE_CYLINDER, "Cyl", NULL, PANGO_ALIGN_CENTER);
 498         dive_list.nitrox = divelist_column(&dive_list, DIVE_NITROX, "O" UTF8_SUBSCRIPT_2 "%", nitrox_data_func, PANGO_ALIGN_CENTER);
 499         dive_list.sac = divelist_column(&dive_list, DIVE_SAC, "SAC", sac_data_func, PANGO_ALIGN_CENTER);
 500         dive_list.location = divelist_column(&dive_list, DIVE_LOCATION, "Location", NULL, PANGO_ALIGN_LEFT);
 501
 502         fill_dive_list();
 503
 504         g_object_set(G_OBJECT(dive_list.tree_view), "headers-visible", TRUE,
 505                                           "search-column", DIVE_LOCATION,
 506                                           "rules-hint", TRUE,
 507                                           NULL);
 508
 509         g_signal_connect_after(dive_list.tree_view, "realize", G_CALLBACK(realize_cb), NULL);
 510         g_signal_connect(selection, "changed", G_CALLBACK(selection_cb), dive_list.model);
 511
 512         dive_list.container_widget = gtk_scrolled_window_new(NULL, NULL);
 513         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(dive_list.container_widget),
 514                                GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 515         gtk_container_add(GTK_CONTAINER(dive_list.container_widget), dive_list.tree_view);
 516
 517         dive_list.changed = 0;
 518
 519         return dive_list.container_widget;
 520 }
 521
 522 void mark_divelist_changed(int changed)
 523 {
 524         dive_list.changed = changed;
 525 }
 526
 527 int unsaved_changes()
 528 {
 529         return dive_list.changed;
 530 }