info.c

   1 /* info.c */
   2 /* creates the UI for the info frame -
   3  * controlled through the following interfaces:
   4  *
   5  * void show_dive_info(struct dive *dive)
   6  *
   7  * called from gtk-ui:
   8  * GtkWidget *extended_dive_info_widget(void)
   9  */
  10 #include <stdio.h>
  11 #include <string.h>
  12 #include <stdlib.h>
  13 #include <time.h>
  14 #include <ctype.h>
  15 #include <sys/time.h>
  16
  17 #include "dive.h"
  18 #include "display.h"
  19 #include "display-gtk.h"
  20 #include "divelist.h"
  21
  22 static GtkEntry *location, *buddy, *divemaster, *rating;
  23 static GtkTextView *notes;
  24 static GtkListStore *location_list, *people_list, *star_list;
  25
  26 static char *get_text(GtkTextView *view)
  27 {
  28         GtkTextBuffer *buffer;
  29         GtkTextIter start;
  30         GtkTextIter end;
  31
  32         buffer = gtk_text_view_get_buffer(view);
  33         gtk_text_buffer_get_start_iter(buffer, &start);
  34         gtk_text_buffer_get_end_iter(buffer, &end);
  35         return gtk_text_buffer_get_text(buffer, &start, &end, FALSE);
  36 }
  37
  38 /* old is NULL or a valid string, new is a valid string
  39  * NOTW: NULL and "" need to be treated as "unchanged" */
  40 static int text_changed(const char *old, const char *new)
  41 {
  42         return (old && strcmp(old,new)) ||
  43                 (!old && strcmp("",new));
  44 }
  45
  46 static char *get_combo_box_entry_text(GtkComboBoxEntry *combo_box, char **textp)
  47 {
  48         char *old = *textp;
  49         const gchar *new;
  50         GtkEntry *entry;
  51
  52         entry = GTK_ENTRY(gtk_bin_get_child(GTK_BIN(combo_box)));
  53         new = gtk_entry_get_text(entry);
  54         while (isspace(*new))
  55                 new++;
  56         if (!text_changed(old,new))
  57                 return NULL;
  58         free(old);
  59         *textp = strdup(new);
  60         return *textp;
  61 }
  62
  63 #define SET_TEXT_VALUE(x) \
  64         gtk_entry_set_text(x, dive && dive->x ? dive->x : "")
  65
  66 static int divename(char *buf, size_t size, struct dive *dive)
  67 {
  68         struct tm *tm = gmtime(&dive->when);
  69         return snprintf(buf, size, "Dive #%d - %s %02d/%02d/%04d at %d:%02d",
  70                 dive->number,
  71                 weekday(tm->tm_wday),
  72                 tm->tm_mon+1, tm->tm_mday,
  73                 tm->tm_year+1900,
  74                 tm->tm_hour, tm->tm_min);
  75 }
  76
  77 void show_dive_info(struct dive *dive)
  78 {
  79         const char *text;
  80         char buffer[80];
  81
  82         /* dive number and location (or lacking that, the date) go in the window title */
  83         text = dive->location;
  84         if (!text)
  85                 text = "";
  86         if (*text) {
  87                 snprintf(buffer, sizeof(buffer), "Dive #%d - %s", dive->number, text);
  88         } else {
  89                 divename(buffer, sizeof(buffer), dive);
  90         }
  91         text = buffer;
  92         if (!dive->number)
  93                 text += 10;     /* Skip the "Dive #0 - " part */
  94         gtk_window_set_title(GTK_WINDOW(main_window), text);
  95
  96         SET_TEXT_VALUE(divemaster);
  97         SET_TEXT_VALUE(buddy);
  98         SET_TEXT_VALUE(location);
  99         gtk_entry_set_text(rating, star_strings[dive->rating]);
 100         gtk_text_buffer_set_text(gtk_text_view_get_buffer(notes),
 101                 dive && dive->notes ? dive->notes : "", -1);
 102 }
 103
 104 static int delete_dive_info(struct dive *dive)
 105 {
 106         int success;
 107         GtkWidget *dialog;
 108
 109         if (!dive)
 110                 return 0;
 111
 112         dialog = gtk_dialog_new_with_buttons("Delete Dive",
 113                 GTK_WINDOW(main_window),
 114                 GTK_DIALOG_DESTROY_WITH_PARENT,
 115                 GTK_STOCK_OK, GTK_RESPONSE_ACCEPT,
 116                 GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT,
 117                 NULL);
 118
 119         gtk_widget_show_all(dialog);
 120         success = gtk_dialog_run(GTK_DIALOG(dialog)) == GTK_RESPONSE_ACCEPT;
 121         if (success) {
 122                 delete_dive(dive);
 123                 mark_divelist_changed(TRUE);
 124                 dive_list_update_dives();
 125         }
 126
 127         gtk_widget_destroy(dialog);
 128
 129         return success;
 130 }
 131
 132 static void info_menu_edit_cb(GtkMenuItem *menuitem, gpointer user_data)
 133 {
 134         edit_dive_info(current_dive);
 135 }
 136
 137 static void info_menu_delete_cb(GtkMenuItem *menuitem, gpointer user_data)
 138 {
 139         delete_dive_info(current_dive);
 140 }
 141
 142 static void add_menu_item(GtkMenu *menu, const char *label, void (*cb)(GtkMenuItem *, gpointer))
 143 {
 144         GtkWidget *item = gtk_menu_item_new_with_label(label);
 145         g_signal_connect(item, "activate", G_CALLBACK(cb), NULL);
 146         gtk_widget_show(item); /* Yes, really */
 147         gtk_menu_prepend(menu, item);
 148 }
 149
 150 static void populate_popup_cb(GtkTextView *entry, GtkMenu *menu, gpointer user_data)
 151 {
 152         add_menu_item(menu, "Delete", info_menu_delete_cb);
 153         add_menu_item(menu, "Edit", info_menu_edit_cb);
 154 }
 155
 156 static GtkEntry *text_value(GtkWidget *box, const char *label)
 157 {
 158         GtkWidget *widget;
 159         GtkWidget *frame = gtk_frame_new(label);
 160
 161         gtk_box_pack_start(GTK_BOX(box), frame, FALSE, TRUE, 0);
 162         widget = gtk_entry_new();
 163         gtk_widget_set_can_focus(widget, FALSE);
 164         gtk_editable_set_editable(GTK_EDITABLE(widget), FALSE);
 165         gtk_container_add(GTK_CONTAINER(frame), widget);
 166         g_signal_connect(widget, "populate-popup", G_CALLBACK(populate_popup_cb), NULL);
 167         return GTK_ENTRY(widget);
 168 }
 169
 170 static GtkComboBoxEntry *text_entry(GtkWidget *box, const char *label, GtkListStore *completions, const char *text)
 171 {
 172         GtkEntry *entry;
 173         GtkWidget *combo_box;
 174         GtkWidget *frame = gtk_frame_new(label);
 175         GtkEntryCompletion *completion;
 176
 177         gtk_box_pack_start(GTK_BOX(box), frame, FALSE, TRUE, 0);
 178
 179         combo_box = gtk_combo_box_entry_new_with_model(GTK_TREE_MODEL(completions), 0);
 180         gtk_container_add(GTK_CONTAINER(frame), combo_box);
 181
 182         entry = GTK_ENTRY(gtk_bin_get_child(GTK_BIN(combo_box)));
 183         if (text && *text)
 184                 gtk_entry_set_text(entry, text);
 185
 186         completion = gtk_entry_completion_new();
 187         gtk_entry_completion_set_text_column(completion, 0);
 188         gtk_entry_completion_set_model(completion, GTK_TREE_MODEL(completions));
 189         gtk_entry_completion_set_inline_completion(completion, TRUE);
 190         gtk_entry_completion_set_inline_selection(completion, TRUE);
 191         gtk_entry_completion_set_popup_single_match(completion, FALSE);
 192         gtk_entry_set_completion(entry, completion);
 193
 194         return GTK_COMBO_BOX_ENTRY(combo_box);
 195 }
 196
 197 enum writable {
 198         READ_ONLY,
 199         READ_WRITE
 200 };
 201
 202 static GtkTextView *text_view(GtkWidget *box, const char *label, enum writable writable)
 203 {
 204         GtkWidget *view, *vbox;
 205         GtkWidget *frame = gtk_frame_new(label);
 206
 207         gtk_box_pack_start(GTK_BOX(box), frame, TRUE, TRUE, 0);
 208         box = gtk_hbox_new(FALSE, 3);
 209         gtk_container_add(GTK_CONTAINER(frame), box);
 210         vbox = gtk_vbox_new(FALSE, 3);
 211         gtk_container_add(GTK_CONTAINER(box), vbox);
 212
 213         GtkWidget* scrolled_window = gtk_scrolled_window_new(0, 0);
 214         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled_window), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 215         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolled_window), GTK_SHADOW_IN);
 216
 217         view = gtk_text_view_new();
 218         if (writable == READ_ONLY) {
 219                 gtk_widget_set_can_focus(view, FALSE);
 220                 gtk_text_view_set_editable(GTK_TEXT_VIEW(view), FALSE);
 221                 gtk_text_view_set_cursor_visible(GTK_TEXT_VIEW(view), FALSE);
 222                 g_signal_connect(view, "populate-popup", G_CALLBACK(populate_popup_cb), NULL);
 223         }
 224         gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(view), GTK_WRAP_WORD);
 225         gtk_container_add(GTK_CONTAINER(scrolled_window), view);
 226         gtk_box_pack_start(GTK_BOX(vbox), scrolled_window, TRUE, TRUE, 0);
 227         return GTK_TEXT_VIEW(view);
 228 }
 229
 230 static enum {
 231         MATCH_EXACT,
 232         MATCH_PREPEND,
 233         MATCH_AFTER
 234 } found_string_entry;
 235 static GtkTreeIter string_entry_location;
 236
 237 static gboolean match_string_entry(GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data)
 238 {
 239         const char *string = data;
 240         char *entry;
 241         int cmp;
 242
 243         gtk_tree_model_get(model, iter, 0, &entry, -1);
 244         cmp = strcmp(entry, string);
 245         if (entry)
 246                 free(entry);
 247
 248         /* Stop. The entry is bigger than the new one */
 249         if (cmp > 0)
 250                 return TRUE;
 251
 252         /* Exact match */
 253         if (!cmp) {
 254                 found_string_entry = MATCH_EXACT;
 255                 return TRUE;
 256         }
 257
 258         string_entry_location = *iter;
 259         found_string_entry = MATCH_AFTER;
 260         return FALSE;
 261 }
 262
 263 static int match_list(GtkListStore *list, const char *string)
 264 {
 265         found_string_entry = MATCH_PREPEND;
 266         gtk_tree_model_foreach(GTK_TREE_MODEL(list), match_string_entry, (void *)string);
 267         return found_string_entry;
 268 }
 269
 270 static void add_string_list_entry(const char *string, GtkListStore *list)
 271 {
 272         GtkTreeIter *iter, loc;
 273
 274         if (!string || !*string)
 275                 return;
 276
 277         switch (match_list(list, string)) {
 278         case MATCH_EXACT:
 279                 return;
 280         case MATCH_PREPEND:
 281                 iter = NULL;
 282                 break;
 283         case MATCH_AFTER:
 284                 iter = &string_entry_location;
 285                 break;
 286         }
 287         gtk_list_store_insert_after(list, &loc, iter);
 288         gtk_list_store_set(list, &loc, 0, string, -1);
 289 }
 290
 291 void add_people(const char *string)
 292 {
 293         add_string_list_entry(string, people_list);
 294 }
 295
 296 void add_location(const char *string)
 297 {
 298         add_string_list_entry(string, location_list);
 299 }
 300
 301 static int get_rating(const char *string)
 302 {
 303         int rating_val = 0;
 304         int i;
 305
 306         for (i = 0; i <= 5; i++)
 307                 if (!strcmp(star_strings[i],string))
 308                         rating_val = i;
 309         return rating_val;
 310 }
 311
 312 struct dive_info {
 313         GtkComboBoxEntry *location, *divemaster, *buddy, *rating;
 314         GtkTextView *notes;
 315 };
 316
 317 static void save_dive_info_changes(struct dive *dive, struct dive_info *info)
 318 {
 319         char *old_text, *new_text;
 320         char *rating_string;
 321         int changed = 0;
 322
 323         new_text = get_combo_box_entry_text(info->location, &dive->location);
 324         if (new_text) {
 325                 add_location(new_text);
 326                 changed = 1;
 327         }
 328
 329         new_text = get_combo_box_entry_text(info->divemaster, &dive->divemaster);
 330         if (new_text) {
 331                 add_people(new_text);
 332                 changed = 1;
 333         }
 334
 335         new_text = get_combo_box_entry_text(info->buddy, &dive->buddy);
 336         if (new_text) {
 337                 add_people(new_text);
 338                 changed = 1;
 339         }
 340
 341         rating_string = strdup(star_strings[dive->rating]);
 342         new_text = get_combo_box_entry_text(info->rating, &rating_string);
 343         if (new_text) {
 344                 dive->rating = get_rating(rating_string);
 345                 free(rating_string);
 346                 changed =1;
 347         }
 348
 349         old_text = dive->notes;
 350         dive->notes = get_text(info->notes);
 351         if (text_changed(old_text,dive->notes))
 352                 changed = 1;
 353         if (old_text)
 354                 g_free(old_text);
 355
 356         if (changed) {
 357                 mark_divelist_changed(TRUE);
 358                 update_dive(dive);
 359         }
 360 }
 361
 362 static void dive_info_widget(GtkWidget *box, struct dive *dive, struct dive_info *info)
 363 {
 364         GtkWidget *hbox, *label, *cylinder, *frame;
 365         char buffer[80];
 366
 367         divename(buffer, sizeof(buffer), dive);
 368         label = gtk_label_new(buffer);
 369         gtk_box_pack_start(GTK_BOX(box), label, FALSE, TRUE, 0);
 370
 371         info->location = text_entry(box, "Location", location_list, dive->location);
 372
 373         hbox = gtk_hbox_new(FALSE, 3);
 374         gtk_box_pack_start(GTK_BOX(box), hbox, FALSE, TRUE, 0);
 375
 376         info->divemaster = text_entry(hbox, "Dive master", people_list, dive->divemaster);
 377         info->buddy = text_entry(hbox, "Buddy", people_list, dive->buddy);
 378
 379         hbox = gtk_hbox_new(FALSE, 3);
 380         gtk_box_pack_start(GTK_BOX(box), hbox, FALSE, TRUE, 0);
 381
 382         info->rating = text_entry(hbox, "Rating", star_list, star_strings[dive->rating]);
 383
 384         info->notes = text_view(box, "Notes", READ_WRITE);
 385         if (dive->notes && *dive->notes)
 386                 gtk_text_buffer_set_text(gtk_text_view_get_buffer(info->notes), dive->notes, -1);
 387
 388         hbox = gtk_hbox_new(FALSE, 3);
 389         gtk_box_pack_start(GTK_BOX(box), hbox, FALSE, TRUE, 0);
 390
 391         frame = gtk_frame_new("Cylinder");
 392         cylinder = cylinder_list_widget();
 393         gtk_container_add(GTK_CONTAINER(frame), cylinder);
 394         gtk_box_pack_start(GTK_BOX(hbox), frame, FALSE, TRUE, 0);
 395 }
 396
 397 int edit_dive_info(struct dive *dive)
 398 {
 399         int success;
 400         GtkWidget *dialog, *vbox;
 401         struct dive_info info;
 402
 403         if (!dive)
 404                 return 0;
 405
 406         dialog = gtk_dialog_new_with_buttons("Dive Info",
 407                 GTK_WINDOW(main_window),
 408                 GTK_DIALOG_DESTROY_WITH_PARENT,
 409                 GTK_STOCK_OK, GTK_RESPONSE_ACCEPT,
 410                 GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT,
 411                 NULL);
 412
 413         vbox = gtk_dialog_get_content_area(GTK_DIALOG(dialog));
 414         dive_info_widget(vbox, dive, &info);
 415
 416         gtk_widget_show_all(dialog);
 417         success = gtk_dialog_run(GTK_DIALOG(dialog)) == GTK_RESPONSE_ACCEPT;
 418         if (success)
 419                 save_dive_info_changes(dive, &info);
 420
 421         gtk_widget_destroy(dialog);
 422
 423         return success;
 424 }
 425
 426 static GtkWidget *frame_box(GtkWidget *vbox, const char *fmt, ...)
 427 {
 428         va_list ap;
 429         char buffer[64];
 430         GtkWidget *frame, *hbox;
 431
 432         va_start(ap, fmt);
 433         vsnprintf(buffer, sizeof(buffer), fmt, ap);
 434         va_end(ap);
 435
 436         frame = gtk_frame_new(buffer);
 437         gtk_box_pack_start(GTK_BOX(vbox), frame, FALSE, TRUE, 0);
 438         hbox = gtk_hbox_new(0, 3);
 439         gtk_container_add(GTK_CONTAINER(frame), hbox);
 440         return hbox;
 441 }
 442
 443 /* Fixme - should do at least depths too - a dive without a depth is kind of pointless */
 444 static time_t dive_time_widget(struct dive *dive)
 445 {
 446         GtkWidget *dialog;
 447         GtkWidget *cal, *hbox, *vbox, *box;
 448         GtkWidget *h, *m;
 449         GtkWidget *duration, *depth;
 450         GtkWidget *label;
 451         guint yval, mval, dval;
 452         struct tm tm, *tmp;
 453         struct timeval tv;
 454         time_t time;
 455         int success;
 456         double depthinterval, val;
 457
 458         dialog = gtk_dialog_new_with_buttons("Date and Time",
 459                 GTK_WINDOW(main_window),
 460                 GTK_DIALOG_DESTROY_WITH_PARENT,
 461                 GTK_STOCK_OK, GTK_RESPONSE_ACCEPT,
 462                 GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT,
 463                 NULL);
 464
 465         vbox = gtk_dialog_get_content_area(GTK_DIALOG(dialog));
 466
 467         /* Calendar hbox */
 468         hbox = frame_box(vbox, "Date:");
 469         cal = gtk_calendar_new();
 470         gtk_box_pack_start(GTK_BOX(hbox), cal, FALSE, TRUE, 0);
 471
 472         /* Time hbox */
 473         hbox = frame_box(vbox, "Time");
 474
 475         h = gtk_spin_button_new_with_range (0.0, 23.0, 1.0);
 476         m = gtk_spin_button_new_with_range (0.0, 59.0, 1.0);
 477
 478         gettimeofday(&tv, NULL);
 479         time = tv.tv_sec;
 480         tmp = localtime(&time);
 481         gtk_spin_button_set_value(GTK_SPIN_BUTTON(h), tmp->tm_hour);
 482         gtk_spin_button_set_value(GTK_SPIN_BUTTON(m), (tmp->tm_min / 5)*5);
 483
 484         gtk_spin_button_set_wrap(GTK_SPIN_BUTTON(h), TRUE);
 485         gtk_spin_button_set_wrap(GTK_SPIN_BUTTON(m), TRUE);
 486
 487         gtk_box_pack_end(GTK_BOX(hbox), m, FALSE, FALSE, 0);
 488         label = gtk_label_new(":");
 489         gtk_box_pack_end(GTK_BOX(hbox), label, FALSE, FALSE, 0);
 490         gtk_box_pack_end(GTK_BOX(hbox), h, FALSE, FALSE, 0);
 491
 492         hbox = gtk_hbox_new(TRUE, 3);
 493         gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
 494
 495         /* Duration hbox */
 496         box = frame_box(hbox, "Duration (min)");
 497         duration = gtk_spin_button_new_with_range (0.0, 1000.0, 1.0);
 498         gtk_box_pack_end(GTK_BOX(box), duration, FALSE, FALSE, 0);
 499
 500         /* Depth box */
 501         box = frame_box(hbox, "Depth (%s):", output_units.length == FEET ? "ft" : "m");
 502         if (output_units.length == FEET) {
 503                 depthinterval = 1.0;
 504         } else {
 505                 depthinterval = 0.1;
 506         }
 507         depth = gtk_spin_button_new_with_range (0.0, 1000.0, depthinterval);
 508         gtk_box_pack_end(GTK_BOX(box), depth, FALSE, FALSE, 0);
 509
 510         /* All done, show it and wait for editing */
 511         gtk_widget_show_all(dialog);
 512         success = gtk_dialog_run(GTK_DIALOG(dialog)) == GTK_RESPONSE_ACCEPT;
 513         if (!success) {
 514                 gtk_widget_destroy(dialog);
 515                 return 0;
 516         }
 517
 518         memset(&tm, 0, sizeof(tm));
 519         gtk_calendar_get_date(GTK_CALENDAR(cal), &yval, &mval, &dval);
 520         tm.tm_year = yval;
 521         tm.tm_mon = mval;
 522         tm.tm_mday = dval;
 523
 524         tm.tm_hour = gtk_spin_button_get_value(GTK_SPIN_BUTTON(h));
 525         tm.tm_min = gtk_spin_button_get_value(GTK_SPIN_BUTTON(m));
 526
 527         val = gtk_spin_button_get_value(GTK_SPIN_BUTTON(depth));
 528         if (output_units.length == FEET) {
 529                 dive->maxdepth.mm = feet_to_mm(val);
 530         } else {
 531                 dive->maxdepth.mm = val * 1000 + 0.5;
 532         }
 533
 534         dive->duration.seconds = gtk_spin_button_get_value(GTK_SPIN_BUTTON(duration))*60;
 535
 536         gtk_widget_destroy(dialog);
 537         dive->when = utc_mktime(&tm);
 538
 539         return 1;
 540 }
 541
 542 int add_new_dive(struct dive *dive)
 543 {
 544         if (!dive)
 545                 return 0;
 546
 547         if (!dive_time_widget(dive))
 548                 return 0;
 549
 550         return edit_dive_info(dive);
 551 }
 552
 553 GtkWidget *extended_dive_info_widget(void)
 554 {
 555         GtkWidget *vbox, *hbox;
 556         vbox = gtk_vbox_new(FALSE, 6);
 557
 558         people_list = gtk_list_store_new(1, G_TYPE_STRING);
 559         location_list = gtk_list_store_new(1, G_TYPE_STRING);
 560         star_list = gtk_list_store_new(1, G_TYPE_STRING);
 561         add_string_list_entry(ZERO_STARS, star_list);
 562         add_string_list_entry(ONE_STARS, star_list);
 563         add_string_list_entry(TWO_STARS, star_list);
 564         add_string_list_entry(THREE_STARS, star_list);
 565         add_string_list_entry(FOUR_STARS, star_list);
 566         add_string_list_entry(FIVE_STARS, star_list);
 567
 568         gtk_container_set_border_width(GTK_CONTAINER(vbox), 6);
 569         location = text_value(vbox, "Location");
 570
 571         hbox = gtk_hbox_new(FALSE, 3);
 572         gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, TRUE, 0);
 573
 574         divemaster = text_value(hbox, "Divemaster");
 575         buddy = text_value(hbox, "Buddy");
 576
 577         hbox = gtk_hbox_new(FALSE, 3);
 578         gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, TRUE, 0);
 579
 580         rating = text_value(hbox, "Rating");
 581
 582         notes = text_view(vbox, "Notes", READ_ONLY);
 583         return vbox;
 584 }