statistics.c

   1 /* statistics.c */
   2 /* creates the UI for the Info & Stats page -
   3  * controlled through the following interfaces:
   4  *
   5  * void show_dive_stats(struct dive *dive)
   6  * void flush_dive_stats_changes(struct dive *dive)
   7  *
   8  * called from gtk-ui:
   9  * GtkWidget *stats_widget(void)
  10  */
  11 #include <stdio.h>
  12 #include <string.h>
  13 #include <stdlib.h>
  14 #include <stdarg.h>
  15 #include <time.h>
  16
  17 #include "dive.h"
  18 #include "display.h"
  19 #include "display-gtk.h"
  20 #include "divelist.h"
  21
  22 typedef struct {
  23         GtkWidget *date,
  24                 *dive_time,
  25                 *surf_intv,
  26                 *max_depth,
  27                 *avg_depth,
  28                 *water_temp,
  29                 *sac,
  30                 *otu,
  31                 *o2he,
  32                 *gas_used;
  33 } single_stat_widget_t;
  34
  35 static single_stat_widget_t single_w;
  36
  37 typedef struct {
  38         GtkWidget *total_time,
  39                 *avg_time,
  40                 *shortest_time,
  41                 *longest_time,
  42                 *max_overall_depth,
  43                 *min_overall_depth,
  44                 *avg_overall_depth,
  45                 *min_sac,
  46                 *avg_sac,
  47                 *max_sac,
  48                 *selection_size,
  49                 *max_temp,
  50                 *avg_temp,
  51                 *min_temp;
  52 } total_stats_widget_t;
  53
  54 static total_stats_widget_t stats_w;
  55
  56 typedef struct {
  57         duration_t total_time;
  58         /* avg_time is simply total_time / nr -- let's not keep this */
  59         duration_t shortest_time;
  60         duration_t longest_time;
  61         depth_t max_depth;
  62         depth_t min_depth;
  63         depth_t avg_depth;
  64         volume_t max_sac;
  65         volume_t min_sac;
  66         volume_t avg_sac;
  67         int max_temp;
  68         int min_temp;
  69         unsigned int combined_temp;
  70         unsigned int combined_count;
  71         unsigned int selection_size;
  72         unsigned int total_sac_time;
  73 } stats_t;
  74
  75 static stats_t stats;
  76 static stats_t stats_selection;
  77
  78
  79 static void process_dive(struct dive *dp, stats_t *stats)
  80 {
  81         int old_tt, sac_time = 0;
  82         const char *unit;
  83
  84         old_tt = stats->total_time.seconds;
  85         stats->total_time.seconds += dp->duration.seconds;
  86         if (dp->duration.seconds > stats->longest_time.seconds)
  87                 stats->longest_time.seconds = dp->duration.seconds;
  88         if (stats->shortest_time.seconds == 0 || dp->duration.seconds < stats->shortest_time.seconds)
  89                 stats->shortest_time.seconds = dp->duration.seconds;
  90         if (dp->maxdepth.mm > stats->max_depth.mm)
  91                 stats->max_depth.mm = dp->maxdepth.mm;
  92         if (stats->min_depth.mm == 0 || dp->maxdepth.mm < stats->min_depth.mm)
  93                 stats->min_depth.mm = dp->maxdepth.mm;
  94         if (dp->watertemp.mkelvin) {
  95                 if (stats->min_temp == 0 || dp->watertemp.mkelvin < stats->min_temp)
  96                         stats->min_temp = dp->watertemp.mkelvin;
  97                 if (dp->watertemp.mkelvin > stats->max_temp)
  98                         stats->max_temp = dp->watertemp.mkelvin;
  99                 stats->combined_temp += get_temp_units(dp->watertemp.mkelvin, &unit);
 100                 stats->combined_count++;
 101         }
 102
 103         /* Maybe we should drop zero-duration dives */
 104         if (!dp->duration.seconds)
 105                 return;
 106         stats->avg_depth.mm = (1.0 * old_tt * stats->avg_depth.mm +
 107                         dp->duration.seconds * dp->meandepth.mm) / stats->total_time.seconds;
 108         if (dp->sac > 2800) { /* less than .1 cuft/min (2800ml/min) is bogus */
 109                 sac_time = stats->total_sac_time + dp->duration.seconds;
 110                 stats->avg_sac.mliter = (1.0 * stats->total_sac_time * stats->avg_sac.mliter +
 111                                 dp->duration.seconds * dp->sac) / sac_time ;
 112                 if (dp->sac > stats->max_sac.mliter)
 113                         stats->max_sac.mliter = dp->sac;
 114                 if (stats->min_sac.mliter == 0 || dp->sac < stats->min_sac.mliter)
 115                         stats->min_sac.mliter = dp->sac;
 116                 stats->total_sac_time = sac_time;
 117         }
 118 }
 119
 120 static void process_all_dives(struct dive *dive, struct dive **prev_dive)
 121 {
 122         int idx;
 123         struct dive *dp;
 124
 125         *prev_dive = NULL;
 126         memset(&stats, 0, sizeof(stats));
 127         if (dive_table.nr > 0) {
 128                 stats.shortest_time.seconds = dive_table.dives[0]->duration.seconds;
 129                 stats.min_depth.mm = dive_table.dives[0]->maxdepth.mm;
 130                 stats.selection_size = dive_table.nr;
 131         }
 132         /* this relies on the fact that the dives in the dive_table
 133          * are in chronological order */
 134         for (idx = 0; idx < dive_table.nr; idx++) {
 135                 dp = dive_table.dives[idx];
 136                 if (dp->when == dive->when) {
 137                         /* that's the one we are showing */
 138                         if (idx > 0)
 139                                 *prev_dive = dive_table.dives[idx-1];
 140                 }
 141                 process_dive(dp, &stats);
 142         }
 143 }
 144
 145 /* make sure we skip the selected summary entries */
 146 void process_selected_dives(GList *selected_dives, int *selectiontracker, GtkTreeModel *model)
 147 {
 148         struct dive *dp;
 149         unsigned int i, j;
 150         int idx;
 151         GtkTreeIter iter;
 152         GtkTreePath *path;
 153
 154         memset(&stats_selection, 0, sizeof(stats_selection));
 155
 156         /* adjust amount_selected and remove negative index entries from list */
 157         for (i = 0, j = 0; j < amount_selected; ++i) {
 158                 GValue value = {0, };
 159                 path = g_list_nth_data(selected_dives, i);
 160                 if (gtk_tree_model_get_iter(model, &iter, path)) {
 161                         gtk_tree_model_get_value(model, &iter, 0, &value);
 162                         idx = g_value_get_int(&value);
 163                         if (idx > 0) {
 164                                 dp = get_dive(idx);
 165                                 if (dp) {
 166                                         selectiontracker[j] = idx;
 167                                         process_dive(dp, &stats_selection);
 168                                         j++;
 169                                         continue;
 170                                 }
 171                         }
 172                 }
 173                 /* we didn't process it, so shorten the list */
 174                 amount_selected--;
 175         }
 176         /* record the actual number of dives selected */
 177         stats_selection.selection_size = amount_selected;
 178 }
 179
 180 static void set_label(GtkWidget *w, const char *fmt, ...)
 181 {
 182         char buf[80];
 183         va_list args;
 184
 185         va_start(args, fmt);
 186         vsnprintf(buf, sizeof(buf), fmt, args);
 187         va_end(args);
 188         gtk_label_set_text(GTK_LABEL(w), buf);
 189 }
 190
 191 static char * get_time_string(int seconds, int maxdays)
 192 {
 193         static char buf[80];
 194         if (maxdays && seconds > 3600 * 24 * maxdays)
 195                 snprintf(buf, sizeof(buf), "more than %d days", maxdays);
 196         else {
 197                 int days = seconds / 3600 / 24;
 198                 int hours = (seconds - days * 3600 * 24) / 3600;
 199                 int minutes = (seconds - days * 3600 * 24 - hours * 3600) / 60;
 200                 if (days > 0)
 201                         snprintf(buf, sizeof(buf), "%dd %dh %dmin", days, hours, minutes);
 202                 else
 203                         snprintf(buf, sizeof(buf), "%dh %dmin", hours, minutes);
 204         }
 205         return buf;
 206 }
 207
 208 static void show_single_dive_stats(struct dive *dive)
 209 {
 210         char buf[80];
 211         double value;
 212         int decimals;
 213         const char *unit;
 214         int idx, offset, gas_used;
 215         struct dive *prev_dive;
 216         struct tm *tm;
 217
 218         process_all_dives(dive, &prev_dive);
 219
 220         tm = gmtime(&dive->when);
 221         snprintf(buf, sizeof(buf),
 222                 "%s, %s %d, %d %2d:%02d",
 223                 weekday(tm->tm_wday),
 224                 monthname(tm->tm_mon),
 225                 tm->tm_mday, tm->tm_year + 1900,
 226                 tm->tm_hour, tm->tm_min);
 227
 228         set_label(single_w.date, buf);
 229         set_label(single_w.dive_time, "%d min", (dive->duration.seconds + 30) / 60);
 230         if (prev_dive)
 231                 set_label(single_w.surf_intv,
 232                         get_time_string(dive->when - (prev_dive->when + prev_dive->duration.seconds), 4));
 233         else
 234                 set_label(single_w.surf_intv, "unknown");
 235         value = get_depth_units(dive->maxdepth.mm, &decimals, &unit);
 236         set_label(single_w.max_depth, "%.*f %s", decimals, value, unit);
 237         value = get_depth_units(dive->meandepth.mm, &decimals, &unit);
 238         set_label(single_w.avg_depth, "%.*f %s", decimals, value, unit);
 239         if (dive->watertemp.mkelvin) {
 240                 value = get_temp_units(dive->watertemp.mkelvin, &unit);
 241                 set_label(single_w.water_temp, "%.1f %s", value, unit);
 242         } else
 243                 set_label(single_w.water_temp, "");
 244         value = get_volume_units(dive->sac, &decimals, &unit);
 245         if (value > 0) {
 246                 set_label(single_w.sac, "%.*f %s/min", decimals, value, unit);
 247         } else
 248                 set_label(single_w.sac, "");
 249         set_label(single_w.otu, "%d", dive->otu);
 250         offset = 0;
 251         gas_used = 0;
 252         buf[0] = '\0';
 253         /* for the O2/He readings just create a list of them */
 254         for (idx = 0; idx < MAX_CYLINDERS; idx++) {
 255                 cylinder_t *cyl = &dive->cylinder[idx];
 256                 unsigned int start, end;
 257
 258                 start = cyl->start.mbar ? : cyl->sample_start.mbar;
 259                 end = cyl->end.mbar ? : cyl->sample_end.mbar;
 260                 if (!cylinder_none(cyl)) {
 261                         /* 0% O2 strangely means air, so 21% - I don't like that at all */
 262                         int o2 = cyl->gasmix.o2.permille ? : AIR_PERMILLE;
 263                         if (offset > 0) {
 264                                 snprintf(buf+offset, 80-offset, ", ");
 265                                 offset += 2;
 266                         }
 267                         snprintf(buf+offset, 80-offset, "%d/%d", (o2 + 5) / 10,
 268                                 (cyl->gasmix.he.permille + 5) / 10);
 269                         offset = strlen(buf);
 270                 }
 271                 /* and if we have size, start and end pressure, we can
 272                  * calculate the total gas used */
 273                 if (cyl->type.size.mliter && start && end)
 274                         gas_used += cyl->type.size.mliter / 1000.0 * (start - end);
 275         }
 276         set_label(single_w.o2he, buf);
 277         if (gas_used) {
 278                 value = get_volume_units(gas_used, &decimals, &unit);
 279                 set_label(single_w.gas_used, "%.*f %s", decimals, value, unit);
 280         } else
 281                 set_label(single_w.gas_used, "");
 282 }
 283
 284 static void show_total_dive_stats(struct dive *dive)
 285 {
 286         double value;
 287         int decimals, seconds;
 288         const char *unit;
 289         stats_t *stats_ptr;
 290
 291         if (amount_selected < 2)
 292                 stats_ptr = &stats;
 293         else
 294                 stats_ptr = &stats_selection;
 295
 296         set_label(stats_w.selection_size, "%d", stats_ptr->selection_size);
 297         if (stats_ptr->min_temp) {
 298                 value = get_temp_units(stats_ptr->min_temp, &unit);
 299                 set_label(stats_w.min_temp, "%.1f %s", value, unit);
 300         }
 301         if (stats_ptr->combined_temp && stats_ptr->combined_count)
 302                 set_label(stats_w.avg_temp, "%.1f %s", stats_ptr->combined_temp / (stats_ptr->combined_count * 1.0), unit);
 303         if (stats_ptr->max_temp) {
 304                 value = get_temp_units(stats_ptr->max_temp, &unit);
 305                 set_label(stats_w.max_temp, "%.1f %s", value, unit);
 306         }
 307         set_label(stats_w.total_time, get_time_string(stats_ptr->total_time.seconds, 0));
 308         seconds = stats_ptr->total_time.seconds;
 309         if (stats_ptr->selection_size)
 310                 seconds /= stats_ptr->selection_size;
 311         set_label(stats_w.avg_time, get_time_string(seconds, 0));
 312         set_label(stats_w.longest_time, get_time_string(stats_ptr->longest_time.seconds, 0));
 313         set_label(stats_w.shortest_time, get_time_string(stats_ptr->shortest_time.seconds, 0));
 314         value = get_depth_units(stats_ptr->max_depth.mm, &decimals, &unit);
 315         set_label(stats_w.max_overall_depth, "%.*f %s", decimals, value, unit);
 316         value = get_depth_units(stats_ptr->min_depth.mm, &decimals, &unit);
 317         set_label(stats_w.min_overall_depth, "%.*f %s", decimals, value, unit);
 318         value = get_depth_units(stats_ptr->avg_depth.mm, &decimals, &unit);
 319         set_label(stats_w.avg_overall_depth, "%.*f %s", decimals, value, unit);
 320         value = get_volume_units(stats_ptr->max_sac.mliter, &decimals, &unit);
 321         set_label(stats_w.max_sac, "%.*f %s/min", decimals, value, unit);
 322         value = get_volume_units(stats_ptr->min_sac.mliter, &decimals, &unit);
 323         set_label(stats_w.min_sac, "%.*f %s/min", decimals, value, unit);
 324         value = get_volume_units(stats_ptr->avg_sac.mliter, &decimals, &unit);
 325         set_label(stats_w.avg_sac, "%.*f %s/min", decimals, value, unit);
 326 }
 327
 328 void show_dive_stats(struct dive *dive)
 329 {
 330         /* they have to be called in this order, as 'total' depends on
 331          * calculations done in 'single' */
 332         show_single_dive_stats(dive);
 333         show_total_dive_stats(dive);
 334 }
 335
 336 void flush_dive_stats_changes(struct dive *dive)
 337 {
 338         /* We do nothing: we require the "Ok" button press */
 339 }
 340
 341 static GtkWidget *new_info_label_in_frame(GtkWidget *box, const char *label)
 342 {
 343         GtkWidget *label_widget;
 344         GtkWidget *frame;
 345
 346         frame = gtk_frame_new(label);
 347         label_widget = gtk_label_new(NULL);
 348         gtk_box_pack_start(GTK_BOX(box), frame, TRUE, TRUE, 3);
 349         gtk_container_add(GTK_CONTAINER(frame), label_widget);
 350
 351         return label_widget;
 352 }
 353
 354 GtkWidget *total_stats_widget(void)
 355 {
 356         GtkWidget *vbox, *hbox, *statsframe, *framebox;
 357
 358         vbox = gtk_vbox_new(FALSE, 3);
 359
 360         statsframe = gtk_frame_new("Statistics");
 361         gtk_box_pack_start(GTK_BOX(vbox), statsframe, TRUE, FALSE, 3);
 362         framebox = gtk_vbox_new(FALSE, 3);
 363         gtk_container_add(GTK_CONTAINER(statsframe), framebox);
 364
 365         /* first row */
 366         hbox = gtk_hbox_new(FALSE, 3);
 367         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 368         stats_w.selection_size = new_info_label_in_frame(hbox, "Dives");
 369         stats_w.max_temp = new_info_label_in_frame(hbox, "Max Temp");
 370         stats_w.min_temp = new_info_label_in_frame(hbox, "Min Temp");
 371         stats_w.avg_temp = new_info_label_in_frame(hbox, "Avg Temp");
 372
 373         /* second row */
 374         hbox = gtk_hbox_new(FALSE, 3);
 375         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 376
 377         stats_w.total_time = new_info_label_in_frame(hbox, "Total Time");
 378         stats_w.avg_time = new_info_label_in_frame(hbox, "Avg Time");
 379         stats_w.longest_time = new_info_label_in_frame(hbox, "Longest Dive");
 380         stats_w.shortest_time = new_info_label_in_frame(hbox, "Shortest Dive");
 381
 382         /* third row */
 383         hbox = gtk_hbox_new(FALSE, 3);
 384         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 385
 386         stats_w.max_overall_depth = new_info_label_in_frame(hbox, "Max Depth");
 387         stats_w.min_overall_depth = new_info_label_in_frame(hbox, "Min Depth");
 388         stats_w.avg_overall_depth = new_info_label_in_frame(hbox, "Avg Depth");
 389
 390         /* fourth row */
 391         hbox = gtk_hbox_new(FALSE, 3);
 392         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 393
 394         stats_w.max_sac = new_info_label_in_frame(hbox, "Max SAC");
 395         stats_w.min_sac = new_info_label_in_frame(hbox, "Min SAC");
 396         stats_w.avg_sac = new_info_label_in_frame(hbox, "Avg SAC");
 397
 398         return vbox;
 399 }
 400
 401 GtkWidget *single_stats_widget(void)
 402 {
 403         GtkWidget *vbox, *hbox, *infoframe, *framebox;
 404
 405         vbox = gtk_vbox_new(FALSE, 3);
 406
 407         infoframe = gtk_frame_new("Dive Info");
 408         gtk_box_pack_start(GTK_BOX(vbox), infoframe, TRUE, FALSE, 3);
 409         framebox = gtk_vbox_new(FALSE, 3);
 410         gtk_container_add(GTK_CONTAINER(infoframe), framebox);
 411
 412         /* first row */
 413         hbox = gtk_hbox_new(FALSE, 3);
 414         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 415
 416         single_w.date = new_info_label_in_frame(hbox, "Date");
 417         single_w.dive_time = new_info_label_in_frame(hbox, "Dive Time");
 418         single_w.surf_intv = new_info_label_in_frame(hbox, "Surf Intv");
 419
 420         /* second row */
 421         hbox = gtk_hbox_new(FALSE, 3);
 422         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 423
 424         single_w.max_depth = new_info_label_in_frame(hbox, "Max Depth");
 425         single_w.avg_depth = new_info_label_in_frame(hbox, "Avg Depth");
 426         single_w.water_temp = new_info_label_in_frame(hbox, "Water Temp");
 427
 428         /* third row */
 429         hbox = gtk_hbox_new(FALSE, 3);
 430         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 431
 432         single_w.sac = new_info_label_in_frame(hbox, "SAC");
 433         single_w.otu = new_info_label_in_frame(hbox, "OTU");
 434         single_w.o2he = new_info_label_in_frame(hbox, "O" UTF8_SUBSCRIPT_2 " / He");
 435         single_w.gas_used = new_info_label_in_frame(hbox, "Gas Used");
 436
 437         return vbox;
 438 }