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 #include <math.h>
  18
  19 #include "divelist.h"
  20 #include "dive.h"
  21 #include "display.h"
  22 #include "display-gtk.h"
  23
  24 struct DiveList {
  25         GtkWidget    *tree_view;
  26         GtkWidget    *container_widget;
  27         GtkListStore *model;
  28         GtkTreeViewColumn *nr, *date, *depth, *duration, *location;
  29         GtkTreeViewColumn *temperature, *cylinder, *nitrox, *sac, *otu;
  30         int changed;
  31 };
  32
  33 static struct DiveList dive_list;
  34
  35 /*
  36  * The dive list has the dive data in both string format (for showing)
  37  * and in "raw" format (for sorting purposes)
  38  */
  39 enum {
  40         DIVE_INDEX = 0,
  41         DIVE_NR,                /* int: dive->nr */
  42         DIVE_DATE,              /* time_t: dive->when */
  43         DIVE_DEPTH,             /* int: dive->maxdepth in mm */
  44         DIVE_DURATION,          /* int: in seconds */
  45         DIVE_TEMPERATURE,       /* int: in mkelvin */
  46         DIVE_CYLINDER,
  47         DIVE_NITROX,            /* int: in permille */
  48         DIVE_SAC,               /* int: in ml/min */
  49         DIVE_OTU,               /* int: in OTUs */
  50         DIVE_LOCATION,          /* "2nd Cathedral, Lanai" */
  51         DIVELIST_COLUMNS
  52 };
  53
  54 static GList *selected_dives;
  55
  56 static void selection_cb(GtkTreeSelection *selection, GtkTreeModel *model)
  57 {
  58         GtkTreeIter iter;
  59         GValue value = {0, };
  60         GtkTreePath *path;
  61
  62         int nr_selected = gtk_tree_selection_count_selected_rows(selection);
  63
  64         if (selected_dives) {
  65                 g_list_foreach (selected_dives, (GFunc) gtk_tree_path_free, NULL);
  66                 g_list_free (selected_dives);
  67         }
  68         selected_dives = gtk_tree_selection_get_selected_rows(selection, NULL);
  69
  70         switch (nr_selected) {
  71         case 0: /* keep showing the last selected dive */
  72                 return;
  73         case 1:
  74                 /* just pick that dive as selected */
  75                 path = g_list_nth_data(selected_dives, 0);
  76                 if (gtk_tree_model_get_iter(model, &iter, path)) {
  77                         gtk_tree_model_get_value(model, &iter, DIVE_INDEX, &value);
  78                         selected_dive = g_value_get_int(&value);
  79                         repaint_dive();
  80                 }
  81                 return;
  82         default: /* multiple selections - what now? At this point I
  83                   * don't want to change the selected dive unless
  84                   * there is exactly one dive selected; not sure this
  85                   * is the most intuitive solution.
  86                   * I do however want to keep around which dives have
  87                   * been selected */
  88                 return;
  89         }
  90 }
  91
  92 static void date_data_func(GtkTreeViewColumn *col,
  93                            GtkCellRenderer *renderer,
  94                            GtkTreeModel *model,
  95                            GtkTreeIter *iter,
  96                            gpointer data)
  97 {
  98         int val;
  99         struct tm *tm;
 100         time_t when;
 101         char buffer[40];
 102
 103         gtk_tree_model_get(model, iter, DIVE_DATE, &val, -1);
 104
 105         /* 2038 problem */
 106         when = val;
 107
 108         tm = gmtime(&when);
 109         snprintf(buffer, sizeof(buffer),
 110                 "%s, %s %d, %d %02d:%02d",
 111                 weekday(tm->tm_wday),
 112                 monthname(tm->tm_mon),
 113                 tm->tm_mday, tm->tm_year + 1900,
 114                 tm->tm_hour, tm->tm_min);
 115         g_object_set(renderer, "text", buffer, NULL);
 116 }
 117
 118 static void depth_data_func(GtkTreeViewColumn *col,
 119                             GtkCellRenderer *renderer,
 120                             GtkTreeModel *model,
 121                             GtkTreeIter *iter,
 122                             gpointer data)
 123 {
 124         int depth, integer, frac, len;
 125         char buffer[40];
 126
 127         gtk_tree_model_get(model, iter, DIVE_DEPTH, &depth, -1);
 128
 129         switch (output_units.length) {
 130         case METERS:
 131                 /* To tenths of meters */
 132                 depth = (depth + 49) / 100;
 133                 integer = depth / 10;
 134                 frac = depth % 10;
 135                 if (integer < 20)
 136                         break;
 137                 frac = -1;
 138                 /* Rounding? */
 139                 break;
 140         case FEET:
 141                 integer = mm_to_feet(depth) + 0.5;
 142                 frac = -1;
 143                 break;
 144         default:
 145                 return;
 146         }
 147         len = snprintf(buffer, sizeof(buffer), "%d", integer);
 148         if (frac >= 0)
 149                 len += snprintf(buffer+len, sizeof(buffer)-len, ".%d", frac);
 150
 151         g_object_set(renderer, "text", buffer, NULL);
 152 }
 153
 154 static void duration_data_func(GtkTreeViewColumn *col,
 155                                GtkCellRenderer *renderer,
 156                                GtkTreeModel *model,
 157                                GtkTreeIter *iter,
 158                                gpointer data)
 159 {
 160         unsigned int sec;
 161         char buffer[16];
 162
 163         gtk_tree_model_get(model, iter, DIVE_DURATION, &sec, -1);
 164         snprintf(buffer, sizeof(buffer), "%d:%02d", sec / 60, sec % 60);
 165
 166         g_object_set(renderer, "text", buffer, NULL);
 167 }
 168
 169 static void temperature_data_func(GtkTreeViewColumn *col,
 170                                   GtkCellRenderer *renderer,
 171                                   GtkTreeModel *model,
 172                                   GtkTreeIter *iter,
 173                                   gpointer data)
 174 {
 175         int value;
 176         char buffer[80];
 177
 178         gtk_tree_model_get(model, iter, DIVE_TEMPERATURE, &value, -1);
 179
 180         *buffer = 0;
 181         if (value) {
 182                 double deg;
 183                 switch (output_units.temperature) {
 184                 case CELSIUS:
 185                         deg = mkelvin_to_C(value);
 186                         break;
 187                 case FAHRENHEIT:
 188                         deg = mkelvin_to_F(value);
 189                         break;
 190                 default:
 191                         return;
 192                 }
 193                 snprintf(buffer, sizeof(buffer), "%.1f", deg);
 194         }
 195
 196         g_object_set(renderer, "text", buffer, NULL);
 197 }
 198
 199 static void nitrox_data_func(GtkTreeViewColumn *col,
 200                              GtkCellRenderer *renderer,
 201                              GtkTreeModel *model,
 202                              GtkTreeIter *iter,
 203                              gpointer data)
 204 {
 205         int value;
 206         char buffer[80];
 207
 208         gtk_tree_model_get(model, iter, DIVE_NITROX, &value, -1);
 209
 210         if (value)
 211                 snprintf(buffer, sizeof(buffer), "%.1f", value/10.0);
 212         else
 213                 strcpy(buffer, "air");
 214
 215         g_object_set(renderer, "text", buffer, NULL);
 216 }
 217
 218 /* Render the SAC data (integer value of "ml / min") */
 219 static void sac_data_func(GtkTreeViewColumn *col,
 220                           GtkCellRenderer *renderer,
 221                           GtkTreeModel *model,
 222                           GtkTreeIter *iter,
 223                           gpointer data)
 224 {
 225         int value;
 226         const char *fmt;
 227         char buffer[16];
 228         double sac;
 229
 230         gtk_tree_model_get(model, iter, DIVE_SAC, &value, -1);
 231
 232         if (!value) {
 233                 g_object_set(renderer, "text", "", NULL);
 234                 return;
 235         }
 236
 237         sac = value / 1000.0;
 238         switch (output_units.volume) {
 239         case LITER:
 240                 fmt = "%4.1f";
 241                 break;
 242         case CUFT:
 243                 fmt = "%4.2f";
 244                 sac = ml_to_cuft(sac * 1000);
 245                 break;
 246         }
 247         snprintf(buffer, sizeof(buffer), fmt, sac);
 248
 249         g_object_set(renderer, "text", buffer, NULL);
 250 }
 251
 252 /* Render the OTU data (integer value of "OTU") */
 253 static void otu_data_func(GtkTreeViewColumn *col,
 254                           GtkCellRenderer *renderer,
 255                           GtkTreeModel *model,
 256                           GtkTreeIter *iter,
 257                           gpointer data)
 258 {
 259         int value;
 260         char buffer[16];
 261
 262         gtk_tree_model_get(model, iter, DIVE_OTU, &value, -1);
 263
 264         if (!value) {
 265                 g_object_set(renderer, "text", "", NULL);
 266                 return;
 267         }
 268
 269         snprintf(buffer, sizeof(buffer), "%d", value);
 270
 271         g_object_set(renderer, "text", buffer, NULL);
 272 }
 273
 274 /* calculate OTU for a dive */
 275 static int calculate_otu(struct dive *dive)
 276 {
 277         int i;
 278         double otu = 0.0;
 279
 280         for (i = 1; i < dive->samples; i++) {
 281                 int t;
 282                 double po2;
 283                 struct sample *sample = dive->sample + i;
 284                 struct sample *psample = sample - 1;
 285                 t = sample->time.seconds - psample->time.seconds;
 286                 po2 = dive->cylinder[sample->cylinderindex].gasmix.o2.permille / 1000.0 *
 287                         (sample->depth.mm + 10000) / 10000.0;
 288                 if (po2 >= 0.5)
 289                         otu += pow(po2 - 0.5, 0.83) * t / 30.0;
 290         }
 291         return otu + 0.5;
 292 }
 293 /*
 294  * Return air usage (in liters).
 295  */
 296 static double calculate_airuse(struct dive *dive)
 297 {
 298         double airuse = 0;
 299         int i;
 300
 301         for (i = 0; i < MAX_CYLINDERS; i++) {
 302                 pressure_t start, end;
 303                 cylinder_t *cyl = dive->cylinder + i;
 304                 int size = cyl->type.size.mliter;
 305                 double kilo_atm;
 306
 307                 if (!size)
 308                         continue;
 309
 310                 start = cyl->start.mbar ? cyl->start : cyl->sample_start;
 311                 end = cyl->end.mbar ? cyl->end : cyl->sample_end;
 312                 kilo_atm = (to_ATM(start) - to_ATM(end)) / 1000.0;
 313
 314                 /* Liters of air at 1 atm == milliliters at 1k atm*/
 315                 airuse += kilo_atm * size;
 316         }
 317         return airuse;
 318 }
 319
 320 static int calculate_sac(struct dive *dive)
 321 {
 322         double airuse, pressure, sac;
 323         int duration, i;
 324
 325         airuse = calculate_airuse(dive);
 326         if (!airuse)
 327                 return 0;
 328         if (!dive->duration.seconds)
 329                 return 0;
 330
 331         /* find and eliminate long surface intervals */
 332         duration = dive->duration.seconds;
 333         for (i = 0; i < dive->samples; i++) {
 334                 if (dive->sample[i].depth.mm < 100) { /* less than 10cm */
 335                         int end = i + 1;
 336                         while (end < dive->samples && dive->sample[end].depth.mm < 100)
 337                                 end++;
 338                         /* we only want the actual surface time during a dive */
 339                         if (end < dive->samples) {
 340                                 end--;
 341                                 duration -= dive->sample[end].time.seconds -
 342                                                 dive->sample[i].time.seconds;
 343                                 i = end + 1;
 344                         }
 345                 }
 346         }
 347         /* Mean pressure in atm: 1 atm per 10m */
 348         pressure = 1 + (dive->meandepth.mm / 10000.0);
 349         sac = airuse / pressure * 60 / duration;
 350
 351         /* milliliters per minute.. */
 352         return sac * 1000;
 353 }
 354
 355 void update_cylinder_related_info(struct dive *dive)
 356 {
 357         if (dive != NULL) {
 358                 dive->sac = calculate_sac(dive);
 359                 dive->otu = calculate_otu(dive);
 360         }
 361 }
 362
 363 static void get_string(char **str, const char *s)
 364 {
 365         int len;
 366         char *n;
 367
 368         if (!s)
 369                 s = "";
 370         len = strlen(s);
 371         if (len > 60)
 372                 len = 60;
 373         n = malloc(len+1);
 374         memcpy(n, s, len);
 375         n[len] = 0;
 376         *str = n;
 377 }
 378
 379 static void get_location(struct dive *dive, char **str)
 380 {
 381         get_string(str, dive->location);
 382 }
 383
 384 static void get_cylinder(struct dive *dive, char **str)
 385 {
 386         get_string(str, dive->cylinder[0].type.description);
 387 }
 388
 389 static void fill_one_dive(struct dive *dive,
 390                           GtkTreeModel *model,
 391                           GtkTreeIter *iter)
 392 {
 393         char *location, *cylinder;
 394
 395         get_cylinder(dive, &cylinder);
 396         get_location(dive, &location);
 397
 398         /*
 399          * We only set the fields that changed: the strings.
 400          * The core data itself is unaffected by units
 401          */
 402         gtk_list_store_set(GTK_LIST_STORE(model), iter,
 403                 DIVE_NR, dive->number,
 404                 DIVE_LOCATION, location,
 405                 DIVE_CYLINDER, cylinder,
 406                 DIVE_SAC, dive->sac,
 407                 DIVE_OTU, dive->otu,
 408                 -1);
 409 }
 410
 411 static gboolean set_one_dive(GtkTreeModel *model,
 412                              GtkTreePath *path,
 413                              GtkTreeIter *iter,
 414                              gpointer data)
 415 {
 416         GValue value = {0, };
 417         struct dive *dive;
 418
 419         /* Get the dive number */
 420         gtk_tree_model_get_value(model, iter, DIVE_INDEX, &value);
 421         dive = get_dive(g_value_get_int(&value));
 422         if (!dive)
 423                 return TRUE;
 424         if (data && dive != data)
 425                 return FALSE;
 426
 427         fill_one_dive(dive, model, iter);
 428         return dive == data;
 429 }
 430
 431 void flush_divelist(struct dive *dive)
 432 {
 433         GtkTreeModel *model = GTK_TREE_MODEL(dive_list.model);
 434
 435         gtk_tree_model_foreach(model, set_one_dive, dive);
 436 }
 437
 438 void set_divelist_font(const char *font)
 439 {
 440         PangoFontDescription *font_desc = pango_font_description_from_string(font);
 441         gtk_widget_modify_font(dive_list.tree_view, font_desc);
 442         pango_font_description_free(font_desc);
 443 }
 444
 445 void update_dive_list_units(void)
 446 {
 447         const char *unit;
 448         GtkTreeModel *model = GTK_TREE_MODEL(dive_list.model);
 449
 450         (void) get_depth_units(0, NULL, &unit);
 451         gtk_tree_view_column_set_title(dive_list.depth, unit);
 452
 453         (void) get_temp_units(0, &unit);
 454         gtk_tree_view_column_set_title(dive_list.temperature, unit);
 455
 456         gtk_tree_model_foreach(model, set_one_dive, NULL);
 457 }
 458
 459 void update_dive_list_col_visibility(void)
 460 {
 461         gtk_tree_view_column_set_visible(dive_list.cylinder, visible_cols.cylinder);
 462         gtk_tree_view_column_set_visible(dive_list.temperature, visible_cols.temperature);
 463         gtk_tree_view_column_set_visible(dive_list.nitrox, visible_cols.nitrox);
 464         gtk_tree_view_column_set_visible(dive_list.sac, visible_cols.sac);
 465         gtk_tree_view_column_set_visible(dive_list.otu, visible_cols.otu);
 466         return;
 467 }
 468
 469 static void fill_dive_list(void)
 470 {
 471         int i;
 472         GtkTreeIter iter;
 473         GtkListStore *store;
 474
 475         store = GTK_LIST_STORE(dive_list.model);
 476
 477         i = dive_table.nr;
 478         while (--i >= 0) {
 479                 struct dive *dive = dive_table.dives[i];
 480
 481                 update_cylinder_related_info(dive);
 482                 gtk_list_store_append(store, &iter);
 483                 gtk_list_store_set(store, &iter,
 484                         DIVE_INDEX, i,
 485                         DIVE_NR, dive->number,
 486                         DIVE_DATE, dive->when,
 487                         DIVE_DEPTH, dive->maxdepth,
 488                         DIVE_DURATION, dive->duration.seconds,
 489                         DIVE_LOCATION, "location",
 490                         DIVE_TEMPERATURE, dive->watertemp.mkelvin,
 491                         DIVE_NITROX, dive->cylinder[0].gasmix.o2,
 492                         DIVE_SAC, 0,
 493                         -1);
 494         }
 495
 496         update_dive_list_units();
 497         if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(dive_list.model), &iter)) {
 498                 GtkTreeSelection *selection;
 499                 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(dive_list.tree_view));
 500                 gtk_tree_selection_select_iter(selection, &iter);
 501         }
 502 }
 503
 504 void dive_list_update_dives(void)
 505 {
 506         gtk_list_store_clear(GTK_LIST_STORE(dive_list.model));
 507         fill_dive_list();
 508         repaint_dive();
 509 }
 510
 511 static GtkTreeViewColumn *divelist_column(struct DiveList *dl, int index, const char *title,
 512                                 data_func_t data_func, PangoAlignment align, gboolean visible)
 513 {
 514         return tree_view_column(dl->tree_view, index, title, data_func, align, visible);
 515 }
 516
 517 /*
 518  * This is some crazy crap. The only way to get default focus seems
 519  * to be to grab focus as the widget is being shown the first time.
 520  */
 521 static void realize_cb(GtkWidget *tree_view, gpointer userdata)
 522 {
 523         gtk_widget_grab_focus(tree_view);
 524 }
 525
 526 static void row_activated_cb(GtkTreeView *tree_view,
 527                         GtkTreePath *path,
 528                         GtkTreeViewColumn *column,
 529                         GtkTreeModel *model)
 530 {
 531         int index;
 532         GtkTreeIter iter;
 533
 534         if (!gtk_tree_model_get_iter(model, &iter, path))
 535                 return;
 536         gtk_tree_model_get(model, &iter, DIVE_INDEX, &index, -1);
 537         edit_dive_info(get_dive(index));
 538 }
 539
 540 GtkWidget *dive_list_create(void)
 541 {
 542         GtkTreeSelection  *selection;
 543
 544         dive_list.model = gtk_list_store_new(DIVELIST_COLUMNS,
 545                                 G_TYPE_INT,                     /* index */
 546                                 G_TYPE_INT,                     /* nr */
 547                                 G_TYPE_INT,                     /* Date */
 548                                 G_TYPE_INT,                     /* Depth */
 549                                 G_TYPE_INT,                     /* Duration */
 550                                 G_TYPE_INT,                     /* Temperature */
 551                                 G_TYPE_STRING,                  /* Cylinder */
 552                                 G_TYPE_INT,                     /* Nitrox */
 553                                 G_TYPE_INT,                     /* SAC */
 554                                 G_TYPE_INT,                     /* OTU */
 555                                 G_TYPE_STRING                   /* Location */
 556                                 );
 557         dive_list.tree_view = gtk_tree_view_new_with_model(GTK_TREE_MODEL(dive_list.model));
 558         set_divelist_font(divelist_font);
 559
 560         selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(dive_list.tree_view));
 561
 562         gtk_tree_selection_set_mode(GTK_TREE_SELECTION(selection), GTK_SELECTION_MULTIPLE);
 563         gtk_widget_set_size_request(dive_list.tree_view, 200, 200);
 564
 565         dive_list.nr = divelist_column(&dive_list, DIVE_NR, "#", NULL, PANGO_ALIGN_RIGHT, TRUE);
 566         gtk_tree_view_column_set_sort_column_id(dive_list.nr, -1);
 567         dive_list.date = divelist_column(&dive_list, DIVE_DATE, "Date", date_data_func, PANGO_ALIGN_LEFT, TRUE);
 568         dive_list.depth = divelist_column(&dive_list, DIVE_DEPTH, "ft", depth_data_func, PANGO_ALIGN_RIGHT, TRUE);
 569         dive_list.duration = divelist_column(&dive_list, DIVE_DURATION, "min", duration_data_func, PANGO_ALIGN_RIGHT, TRUE);
 570         dive_list.temperature = divelist_column(&dive_list, DIVE_TEMPERATURE, UTF8_DEGREE "F", temperature_data_func, PANGO_ALIGN_RIGHT, visible_cols.temperature);
 571         dive_list.cylinder = divelist_column(&dive_list, DIVE_CYLINDER, "Cyl", NULL, PANGO_ALIGN_CENTER, visible_cols.cylinder);
 572         dive_list.nitrox = divelist_column(&dive_list, DIVE_NITROX, "O" UTF8_SUBSCRIPT_2 "%", nitrox_data_func, PANGO_ALIGN_CENTER, visible_cols.nitrox);
 573         dive_list.sac = divelist_column(&dive_list, DIVE_SAC, "SAC", sac_data_func, PANGO_ALIGN_CENTER, visible_cols.sac);
 574         dive_list.otu = divelist_column(&dive_list, DIVE_OTU, "OTU", otu_data_func, PANGO_ALIGN_CENTER, visible_cols.otu);
 575         dive_list.location = divelist_column(&dive_list, DIVE_LOCATION, "Location", NULL, PANGO_ALIGN_LEFT, TRUE);
 576
 577         fill_dive_list();
 578
 579         g_object_set(G_OBJECT(dive_list.tree_view), "headers-visible", TRUE,
 580                                           "search-column", DIVE_LOCATION,
 581                                           "rules-hint", TRUE,
 582                                           NULL);
 583
 584         g_signal_connect_after(dive_list.tree_view, "realize", G_CALLBACK(realize_cb), NULL);
 585         g_signal_connect(dive_list.tree_view, "row-activated", G_CALLBACK(row_activated_cb), dive_list.model);
 586         g_signal_connect(selection, "changed", G_CALLBACK(selection_cb), dive_list.model);
 587
 588         dive_list.container_widget = gtk_scrolled_window_new(NULL, NULL);
 589         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(dive_list.container_widget),
 590                                GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 591         gtk_container_add(GTK_CONTAINER(dive_list.container_widget), dive_list.tree_view);
 592
 593         dive_list.changed = 0;
 594
 595         return dive_list.container_widget;
 596 }
 597
 598 void mark_divelist_changed(int changed)
 599 {
 600         dive_list.changed = changed;
 601 }
 602
 603 int unsaved_changes()
 604 {
 605         return dive_list.changed;
 606 }