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
 246         /* Stop. The entry is bigger than the new one */
 247         if (cmp > 0)
 248                 return TRUE;
 249
 250         /* Exact match */
 251         if (!cmp) {
 252                 found_string_entry = MATCH_EXACT;
 253                 return TRUE;
 254         }
 255
 256         string_entry_location = *iter;
 257         found_string_entry = MATCH_AFTER;
 258         return FALSE;
 259 }
 260
 261 static int match_list(GtkListStore *list, const char *string)
 262 {
 263         found_string_entry = MATCH_PREPEND;
 264         gtk_tree_model_foreach(GTK_TREE_MODEL(list), match_string_entry, (void *)string);
 265         return found_string_entry;
 266 }
 267
 268 static void add_string_list_entry(const char *string, GtkListStore *list)
 269 {
 270         GtkTreeIter *iter, loc;
 271
 272         if (!string || !*string)
 273                 return;
 274
 275         switch (match_list(list, string)) {
 276         case MATCH_EXACT:
 277                 return;
 278         case MATCH_PREPEND:
 279                 iter = NULL;
 280                 break;
 281         case MATCH_AFTER:
 282                 iter = &string_entry_location;
 283                 break;
 284         }
 285         gtk_list_store_insert_after(list, &loc, iter);
 286         gtk_list_store_set(list, &loc, 0, string, -1);
 287 }
 288
 289 void add_people(const char *string)
 290 {
 291         add_string_list_entry(string, people_list);
 292 }
 293
 294 void add_location(const char *string)
 295 {
 296         add_string_list_entry(string, location_list);
 297 }
 298
 299 static int get_rating(const char *string)
 300 {
 301         int rating_val = 0;
 302         int i;
 303
 304         for (i = 0; i <= 5; i++)
 305                 if (!strcmp(star_strings[i],string))
 306                         rating_val = i;
 307         return rating_val;
 308 }
 309
 310 struct dive_info {
 311         GtkComboBoxEntry *location, *divemaster, *buddy, *rating;
 312         GtkTextView *notes;
 313 };
 314
 315 static void save_dive_info_changes(struct dive *dive, struct dive_info *info)
 316 {
 317         char *old_text, *new_text;
 318         char *rating_string;
 319         int changed = 0;
 320
 321         new_text = get_combo_box_entry_text(info->location, &dive->location);
 322         if (new_text) {
 323                 add_location(new_text);
 324                 changed = 1;
 325         }
 326
 327         new_text = get_combo_box_entry_text(info->divemaster, &dive->divemaster);
 328         if (new_text) {
 329                 add_people(new_text);
 330                 changed = 1;
 331         }
 332
 333         new_text = get_combo_box_entry_text(info->buddy, &dive->buddy);
 334         if (new_text) {
 335                 add_people(new_text);
 336                 changed = 1;
 337         }
 338
 339         rating_string = strdup(star_strings[dive->rating]);
 340         new_text = get_combo_box_entry_text(info->rating, &rating_string);
 341         if (new_text) {
 342                 dive->rating = get_rating(rating_string);
 343                 free(rating_string);
 344                 changed =1;
 345         }
 346
 347         old_text = dive->notes;
 348         dive->notes = get_text(info->notes);
 349         if (text_changed(old_text,dive->notes))
 350                 changed = 1;
 351         if (old_text)
 352                 g_free(old_text);
 353
 354         if (changed) {
 355                 mark_divelist_changed(TRUE);
 356                 update_dive(dive);
 357         }
 358 }
 359
 360 static void dive_info_widget(GtkWidget *box, struct dive *dive, struct dive_info *info)
 361 {
 362         GtkWidget *hbox, *label, *cylinder, *frame;
 363         char buffer[80];
 364
 365         divename(buffer, sizeof(buffer), dive);
 366         label = gtk_label_new(buffer);
 367         gtk_box_pack_start(GTK_BOX(box), label, FALSE, TRUE, 0);
 368
 369         info->location = text_entry(box, "Location", location_list, dive->location);
 370
 371         hbox = gtk_hbox_new(FALSE, 3);
 372         gtk_box_pack_start(GTK_BOX(box), hbox, FALSE, TRUE, 0);
 373
 374         info->divemaster = text_entry(hbox, "Dive master", people_list, dive->divemaster);
 375         info->buddy = text_entry(hbox, "Buddy", people_list, dive->buddy);
 376
 377         hbox = gtk_hbox_new(FALSE, 3);
 378         gtk_box_pack_start(GTK_BOX(box), hbox, FALSE, TRUE, 0);
 379
 380         info->rating = text_entry(hbox, "Rating", star_list, star_strings[dive->rating]);
 381
 382         info->notes = text_view(box, "Notes", READ_WRITE);
 383         if (dive->notes && *dive->notes)
 384                 gtk_text_buffer_set_text(gtk_text_view_get_buffer(info->notes), dive->notes, -1);
 385
 386         hbox = gtk_hbox_new(FALSE, 3);
 387         gtk_box_pack_start(GTK_BOX(box), hbox, FALSE, TRUE, 0);
 388
 389         frame = gtk_frame_new("Cylinder");
 390         cylinder = cylinder_list_widget();
 391         gtk_container_add(GTK_CONTAINER(frame), cylinder);
 392         gtk_box_pack_start(GTK_BOX(hbox), frame, FALSE, TRUE, 0);
 393 }
 394
 395 int edit_dive_info(struct dive *dive)
 396 {
 397         int success;
 398         GtkWidget *dialog, *vbox;
 399         struct dive_info info;
 400
 401         if (!dive)
 402                 return 0;
 403
 404         dialog = gtk_dialog_new_with_buttons("Dive Info",
 405                 GTK_WINDOW(main_window),
 406                 GTK_DIALOG_DESTROY_WITH_PARENT,
 407                 GTK_STOCK_OK, GTK_RESPONSE_ACCEPT,
 408                 GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT,
 409                 NULL);
 410
 411         vbox = gtk_dialog_get_content_area(GTK_DIALOG(dialog));
 412         dive_info_widget(vbox, dive, &info);
 413
 414         gtk_widget_show_all(dialog);
 415         success = gtk_dialog_run(GTK_DIALOG(dialog)) == GTK_RESPONSE_ACCEPT;
 416         if (success)
 417                 save_dive_info_changes(dive, &info);
 418
 419         gtk_widget_destroy(dialog);
 420
 421         return success;
 422 }
 423
 424 static GtkWidget *frame_box(GtkWidget *vbox, const char *fmt, ...)
 425 {
 426         va_list ap;
 427         char buffer[64];
 428         GtkWidget *frame, *hbox;
 429
 430         va_start(ap, fmt);
 431         vsnprintf(buffer, sizeof(buffer), fmt, ap);
 432         va_end(ap);
 433
 434         frame = gtk_frame_new(buffer);
 435         gtk_box_pack_start(GTK_BOX(vbox), frame, FALSE, TRUE, 0);
 436         hbox = gtk_hbox_new(0, 3);
 437         gtk_container_add(GTK_CONTAINER(frame), hbox);
 438         return hbox;
 439 }
 440
 441 /* Fixme - should do at least depths too - a dive without a depth is kind of pointless */
 442 static time_t dive_time_widget(struct dive *dive)
 443 {
 444         GtkWidget *dialog;
 445         GtkWidget *cal, *hbox, *vbox, *box;
 446         GtkWidget *h, *m;
 447         GtkWidget *duration, *depth;
 448         GtkWidget *label;
 449         guint yval, mval, dval;
 450         struct tm tm, *tmp;
 451         struct timeval tv;
 452         time_t time;
 453         int success;
 454         double depthinterval, val;
 455
 456         dialog = gtk_dialog_new_with_buttons("Date and Time",
 457                 GTK_WINDOW(main_window),
 458                 GTK_DIALOG_DESTROY_WITH_PARENT,
 459                 GTK_STOCK_OK, GTK_RESPONSE_ACCEPT,
 460                 GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT,
 461                 NULL);
 462
 463         vbox = gtk_dialog_get_content_area(GTK_DIALOG(dialog));
 464
 465         /* Calendar hbox */
 466         hbox = frame_box(vbox, "Date:");
 467         cal = gtk_calendar_new();
 468         gtk_box_pack_start(GTK_BOX(hbox), cal, FALSE, TRUE, 0);
 469
 470         /* Time hbox */
 471         hbox = frame_box(vbox, "Time");
 472
 473         h = gtk_spin_button_new_with_range (0.0, 23.0, 1.0);
 474         m = gtk_spin_button_new_with_range (0.0, 59.0, 1.0);
 475
 476         gettimeofday(&tv, NULL);
 477         time = tv.tv_sec;
 478         tmp = localtime(&time);
 479         gtk_spin_button_set_value(GTK_SPIN_BUTTON(h), tmp->tm_hour);
 480         gtk_spin_button_set_value(GTK_SPIN_BUTTON(m), (tmp->tm_min / 5)*5);
 481
 482         gtk_spin_button_set_wrap(GTK_SPIN_BUTTON(h), TRUE);
 483         gtk_spin_button_set_wrap(GTK_SPIN_BUTTON(m), TRUE);
 484
 485         gtk_box_pack_end(GTK_BOX(hbox), m, FALSE, FALSE, 0);
 486         label = gtk_label_new(":");
 487         gtk_box_pack_end(GTK_BOX(hbox), label, FALSE, FALSE, 0);
 488         gtk_box_pack_end(GTK_BOX(hbox), h, FALSE, FALSE, 0);
 489
 490         hbox = gtk_hbox_new(TRUE, 3);
 491         gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
 492
 493         /* Duration hbox */
 494         box = frame_box(hbox, "Duration (min)");
 495         duration = gtk_spin_button_new_with_range (0.0, 1000.0, 1.0);
 496         gtk_box_pack_end(GTK_BOX(box), duration, FALSE, FALSE, 0);
 497
 498         /* Depth box */
 499         box = frame_box(hbox, "Depth (%s):", output_units.length == FEET ? "ft" : "m");
 500         if (output_units.length == FEET) {
 501                 depthinterval = 1.0;
 502         } else {
 503                 depthinterval = 0.1;
 504         }
 505         depth = gtk_spin_button_new_with_range (0.0, 1000.0, depthinterval);
 506         gtk_box_pack_end(GTK_BOX(box), depth, FALSE, FALSE, 0);
 507
 508         /* All done, show it and wait for editing */
 509         gtk_widget_show_all(dialog);
 510         success = gtk_dialog_run(GTK_DIALOG(dialog)) == GTK_RESPONSE_ACCEPT;
 511         if (!success) {
 512                 gtk_widget_destroy(dialog);
 513                 return 0;
 514         }
 515
 516         memset(&tm, 0, sizeof(tm));
 517         gtk_calendar_get_date(GTK_CALENDAR(cal), &yval, &mval, &dval);
 518         tm.tm_year = yval;
 519         tm.tm_mon = mval;
 520         tm.tm_mday = dval;
 521
 522         tm.tm_hour = gtk_spin_button_get_value(GTK_SPIN_BUTTON(h));
 523         tm.tm_min = gtk_spin_button_get_value(GTK_SPIN_BUTTON(m));
 524
 525         val = gtk_spin_button_get_value(GTK_SPIN_BUTTON(depth));
 526         if (output_units.length == FEET) {
 527                 dive->maxdepth.mm = feet_to_mm(val);
 528         } else {
 529                 dive->maxdepth.mm = val * 1000 + 0.5;
 530         }
 531
 532         dive->duration.seconds = gtk_spin_button_get_value(GTK_SPIN_BUTTON(duration))*60;
 533
 534         gtk_widget_destroy(dialog);
 535         dive->when = utc_mktime(&tm);
 536
 537         return 1;
 538 }
 539
 540 int add_new_dive(struct dive *dive)
 541 {
 542         if (!dive)
 543                 return 0;
 544
 545         if (!dive_time_widget(dive))
 546                 return 0;
 547
 548         return edit_dive_info(dive);
 549 }
 550
 551 GtkWidget *extended_dive_info_widget(void)
 552 {
 553         GtkWidget *vbox, *hbox;
 554         vbox = gtk_vbox_new(FALSE, 6);
 555
 556         people_list = gtk_list_store_new(1, G_TYPE_STRING);
 557         location_list = gtk_list_store_new(1, G_TYPE_STRING);
 558         star_list = gtk_list_store_new(1, G_TYPE_STRING);
 559         add_string_list_entry(ZERO_STARS, star_list);
 560         add_string_list_entry(ONE_STARS, star_list);
 561         add_string_list_entry(TWO_STARS, star_list);
 562         add_string_list_entry(THREE_STARS, star_list);
 563         add_string_list_entry(FOUR_STARS, star_list);
 564         add_string_list_entry(FIVE_STARS, star_list);
 565
 566         gtk_container_set_border_width(GTK_CONTAINER(vbox), 6);
 567         location = text_value(vbox, "Location");
 568
 569         hbox = gtk_hbox_new(FALSE, 3);
 570         gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, TRUE, 0);
 571
 572         divemaster = text_value(hbox, "Divemaster");
 573         buddy = text_value(hbox, "Buddy");
 574
 575         hbox = gtk_hbox_new(FALSE, 3);
 576         gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, TRUE, 0);
 577
 578         rating = text_value(hbox, "Rating");
 579
 580         notes = text_view(vbox, "Notes", READ_ONLY);
 581         return vbox;
 582 }