]> git.tdb.fi Git - ext/subsurface.git/blobdiff - divelist.c
Fix selecting and unselecting summary items
[ext/subsurface.git] / divelist.c
index 137b8a148fe173aee07627e4fba2fd2767e99acf..112307a1c28fbc89d7d96f8899b99f0767d7fdfc 100644 (file)
@@ -24,7 +24,7 @@
 struct DiveList {
        GtkWidget    *tree_view;
        GtkWidget    *container_widget;
-       GtkTreeStore *model;
+       GtkTreeStore *model, *listmodel, *treemodel;
        GtkTreeViewColumn *nr, *date, *stars, *depth, *duration, *location;
        GtkTreeViewColumn *temperature, *cylinder, *nitrox, *sac, *otu;
        int changed;
@@ -79,8 +79,74 @@ static void dump_model(GtkListStore *store)
 #endif
 
 static GList *selected_dives;
+static int *selectiontracker;
 
-static void selection_cb(GtkTreeSelection *selection, GtkTreeModel *model)
+/* when subsurface starts we want to have the last dive selected. So we simply
+   walk to the first leaf (and skip the summary entries - which have negative
+   DIVE_INDEX) */
+static void first_leaf(GtkTreeModel *model, GtkTreeIter *iter, int *diveidx)
+{
+       GtkTreeIter parent;
+       GtkTreePath *tpath;
+
+       while (*diveidx < 0) {
+               memcpy(&parent, iter, sizeof(parent));
+               tpath = gtk_tree_model_get_path(model, &parent);
+               if (!gtk_tree_model_iter_children(model, iter, &parent))
+                       /* we should never have a parent without child */
+                       return;
+               if(!gtk_tree_view_row_expanded(GTK_TREE_VIEW(dive_list.tree_view), tpath))
+                       gtk_tree_view_expand_row(GTK_TREE_VIEW(dive_list.tree_view), tpath, FALSE);
+               gtk_tree_model_get(GTK_TREE_MODEL(model), iter, DIVE_INDEX, diveidx, -1);
+       }
+}
+
+/* if we click on a summary dive, we actually want to select / unselect
+   all the dives "below" it */
+static void select_children(GtkTreeModel *model, GtkTreeSelection * selection,
+                       GtkTreeIter *iter, gboolean was_selected)
+{
+       int i, nr_children;
+       GtkTreeIter parent;
+       GtkTreePath *tpath;
+
+       memcpy(&parent, iter, sizeof(parent));
+
+       tpath = gtk_tree_model_get_path(model, &parent);
+       if(!gtk_tree_view_row_expanded(GTK_TREE_VIEW(dive_list.tree_view), tpath))
+               gtk_tree_view_expand_row(GTK_TREE_VIEW(dive_list.tree_view), tpath, FALSE);
+
+       nr_children = gtk_tree_model_iter_n_children(model, &parent);
+       for (i = 0; i < nr_children; i++) {
+               gtk_tree_model_iter_nth_child(model, iter, &parent, i);
+               if (was_selected)
+                       gtk_tree_selection_unselect_iter(selection, iter);
+               else
+                       gtk_tree_selection_select_iter(selection, iter);
+       }
+}
+
+/* this is called _before_ the selection is changed, for every single entry;
+ * we simply have it call down the tree to make sure that summary items toggle
+ * their children */
+gboolean modify_selection_cb(GtkTreeSelection *selection, GtkTreeModel *model,
+                       GtkTreePath *path, gboolean was_selected, gpointer userdata)
+{
+       GtkTreeIter iter;
+       int dive_idx;
+
+       if (gtk_tree_model_get_iter(model, &iter, path)) {
+               gtk_tree_model_get(model, &iter, DIVE_INDEX, &dive_idx, -1);
+               if (dive_idx < 0) {
+                       select_children(model, selection, &iter, was_selected);
+               }
+       }
+       /* allow this selection to proceed */
+       return TRUE;
+}
+
+/* this is called when gtk thinks that the selection has changed */
+static void selection_cb(GtkTreeSelection *selection, gpointer userdata)
 {
        GtkTreeIter iter;
        GtkTreePath *path;
@@ -92,43 +158,36 @@ static void selection_cb(GtkTreeSelection *selection, GtkTreeModel *model)
                g_list_free (selected_dives);
        }
        selected_dives = gtk_tree_selection_get_selected_rows(selection, NULL);
+       selectiontracker = realloc(selectiontracker, nr_selected * sizeof(int));
 
        switch (nr_selected) {
-       case 0: /* keep showing the last selected dive */
+       case 0: /* there is no clear way to figure out which dive to show */
+               amount_selected = 0;
+               selected_dive = -1;
                return;
        case 1: 
                /* just pick that dive as selected */
                amount_selected = 1;
                path = g_list_nth_data(selected_dives, 0);
-               if (gtk_tree_model_get_iter(model, &iter, path)) {
-                       gtk_tree_model_get(model, &iter, DIVE_INDEX, &selected_dive, -1);
-                       /* a negative index means we picked a summary entry;
-                          expand that entry and use first real child instead */
-                       while (selected_dive < 0) {
-                               GtkTreeIter parent;
-                               GtkTreePath *tpath;
-                               memcpy(&parent, &iter, sizeof(parent));
-                               tpath = gtk_tree_model_get_path(model, &parent);
-                               if (!gtk_tree_model_iter_children(model, &iter, &parent))
-                                       /* we should never have a parent without child */
-                                       return;
-                               if(gtk_tree_view_row_expanded(GTK_TREE_VIEW(dive_list.tree_view), tpath))
-                                       gtk_tree_view_collapse_row(GTK_TREE_VIEW(dive_list.tree_view), tpath);
-                               else
-                                       gtk_tree_view_expand_row(GTK_TREE_VIEW(dive_list.tree_view), tpath, FALSE);
-                               gtk_tree_model_get(model, &iter, DIVE_INDEX, &selected_dive, -1);
+               if (gtk_tree_model_get_iter(GTK_TREE_MODEL(dive_list.model), &iter, path)) {
+                       gtk_tree_model_get(GTK_TREE_MODEL(dive_list.model), &iter, DIVE_INDEX, &selected_dive, -1);
+                       /* due to the way this callback gets invoked it is possible that
+                          in the process of unselecting a summary dive we get here with
+                          just one summary dive selected - ignore that case */
+                       if (selected_dive < 0) {
+                               amount_selected = 0;
+                               return;
                        }
+                       selectiontracker[0] = selected_dive;
                        repaint_dive();
                }
                return;
-       default: /* multiple selections - what now? At this point I
-                 * don't want to change the selected dive unless
-                 * there is exactly one dive selected; not sure this
+       default: /* multiple selections - what now?
+                 * We don't change the selected dive unless there is exactly one dive selected; not sure this
                  * is the most intuitive solution.
-                 * I do however want to keep around which dives have
-                 * been selected */
+                 * The dives that have been selected are processed */
                amount_selected = g_list_length(selected_dives);
-               process_selected_dives(selected_dives, model);
+               process_selected_dives(selected_dives, selectiontracker, GTK_TREE_MODEL(dive_list.model));
                repaint_dive();
                return;
        }
@@ -593,13 +652,21 @@ static void get_cylinder(struct dive *dive, char **str)
 
 /*
  * Set up anything that could have changed due to editing
- * of dive information
+ * of dive information; we need to do this for both models,
+ * so we simply call set_one_dive again with the non-current model
  */
+/* forward declaration for recursion */
+static gboolean set_one_dive(GtkTreeModel *model,
+                            GtkTreePath *path,
+                            GtkTreeIter *iter,
+                            gpointer data);
+
 static void fill_one_dive(struct dive *dive,
                          GtkTreeModel *model,
                          GtkTreeIter *iter)
 {
        char *location, *cylinder;
+       GtkTreeStore *othermodel;
 
        get_cylinder(dive, &cylinder);
        get_location(dive, &location);
@@ -612,6 +679,13 @@ static void fill_one_dive(struct dive *dive,
                DIVE_SAC, dive->sac,
                DIVE_OTU, dive->otu,
                -1);
+       if (model == GTK_TREE_MODEL(dive_list.treemodel))
+               othermodel = dive_list.listmodel;
+       else
+               othermodel = dive_list.treemodel;
+       if (othermodel != dive_list.model)
+               /* recursive call */
+               gtk_tree_model_foreach(GTK_TREE_MODEL(othermodel), set_one_dive, dive);
 }
 
 static gboolean set_one_dive(GtkTreeModel *model,
@@ -704,11 +778,12 @@ static void fill_dive_list(void)
 {
        int i, j;
        GtkTreeIter iter, parent_iter[NEW_YR + 2], *parents[NEW_YR + 2] = {NULL, };
-       GtkTreeStore *store;
+       GtkTreeStore *liststore, *treestore;
        struct dive *last_dive = NULL;
        time_t dive_date;
 
-       store = GTK_TREE_STORE(dive_list.model);
+       treestore = GTK_TREE_STORE(dive_list.treemodel);
+       liststore = GTK_TREE_STORE(dive_list.listmodel);
 
        i = dive_table.nr;
        while (--i >= 0) {
@@ -717,9 +792,9 @@ static void fill_dive_list(void)
                for (j = NEW_YR; j >= NEW_DAY; j--) {
                        if (new_date(dive, &last_dive, j, &dive_date))
                        {
-                               gtk_tree_store_append(store, &parent_iter[j], parents[j+1]);
+                               gtk_tree_store_append(treestore, &parent_iter[j], parents[j+1]);
                                parents[j] = &parent_iter[j];
-                               gtk_tree_store_set(store, parents[j],
+                               gtk_tree_store_set(treestore, parents[j],
                                                DIVE_INDEX, -j,
                                                DIVE_NR, -j,
                                                DIVE_DATE, dive_date,
@@ -730,8 +805,20 @@ static void fill_dive_list(void)
                        }
                }
                update_cylinder_related_info(dive);
-               gtk_tree_store_append(store, &iter, parents[NEW_DAY]);
-               gtk_tree_store_set(store, &iter,
+               gtk_tree_store_append(treestore, &iter, parents[NEW_DAY]);
+               gtk_tree_store_set(treestore, &iter,
+                       DIVE_INDEX, i,
+                       DIVE_NR, dive->number,
+                       DIVE_DATE, dive->when,
+                       DIVE_DEPTH, dive->maxdepth,
+                       DIVE_DURATION, dive->duration.seconds,
+                       DIVE_LOCATION, dive->location,
+                       DIVE_RATING, dive->rating,
+                       DIVE_TEMPERATURE, dive->watertemp.mkelvin,
+                       DIVE_SAC, 0,
+                       -1);
+               gtk_tree_store_append(liststore, &iter, NULL);
+               gtk_tree_store_set(liststore, &iter,
                        DIVE_INDEX, i,
                        DIVE_NR, dive->number,
                        DIVE_DATE, dive->when,
@@ -747,14 +834,21 @@ static void fill_dive_list(void)
        update_dive_list_units();
        if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(dive_list.model), &iter)) {
                GtkTreeSelection *selection;
+
+               /* select the last dive (and make sure it's an actual dive that is selected) */
+               gtk_tree_model_get(GTK_TREE_MODEL(dive_list.model), &iter, DIVE_INDEX, &selected_dive, -1);
+               first_leaf(GTK_TREE_MODEL(dive_list.model), &iter, &selected_dive);
                selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(dive_list.tree_view));
                gtk_tree_selection_select_iter(selection, &iter);
+               selectiontracker = realloc(selectiontracker, sizeof(int));
+               *selectiontracker = selected_dive;
        }
 }
 
 void dive_list_update_dives(void)
 {
-       gtk_tree_store_clear(GTK_TREE_STORE(dive_list.model));
+       gtk_tree_store_clear(GTK_TREE_STORE(dive_list.treemodel));
+       gtk_tree_store_clear(GTK_TREE_STORE(dive_list.listmodel));
        fill_dive_list();
        repaint_dive();
 }
@@ -789,14 +883,20 @@ static GtkTreeViewColumn *divelist_column(struct DiveList *dl, struct divelist_c
        unsigned int flags = col->flags;
        int *visible = col->visible;
        GtkWidget *tree_view = dl->tree_view;
-       GtkTreeStore *model = dl->model;
+       GtkTreeStore *treemodel = dl->treemodel;
+       GtkTreeStore *listmodel = dl->listmodel;
        GtkTreeViewColumn *ret;
 
        if (visible && !*visible)
                flags |= INVISIBLE;
        ret = tree_view_column(tree_view, index, title, data_func, flags);
-       if (sort_func)
-               gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(model), index, sort_func, NULL, NULL);
+       if (sort_func) {
+               /* the sort functions are needed in the corresponding models */
+               if (index == DIVE_DATE)
+                       gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(treemodel), index, sort_func, NULL, NULL);
+               else
+                       gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(listmodel), index, sort_func, NULL, NULL);
+       }
        return ret;
 }
 
@@ -812,14 +912,14 @@ static void realize_cb(GtkWidget *tree_view, gpointer userdata)
 static void row_activated_cb(GtkTreeView *tree_view,
                        GtkTreePath *path,
                        GtkTreeViewColumn *column,
-                       GtkTreeModel *model)
+                       gpointer userdata)
 {
        int index;
        GtkTreeIter iter;
 
-       if (!gtk_tree_model_get_iter(model, &iter, path))
+       if (!gtk_tree_model_get_iter(GTK_TREE_MODEL(dive_list.model), &iter, path))
                return;
-       gtk_tree_model_get(model, &iter, DIVE_INDEX, &index, -1);
+       gtk_tree_model_get(GTK_TREE_MODEL(dive_list.model), &iter, DIVE_INDEX, &index, -1);
        /* a negative index is special for the "group by date" entries */
        if (index >= 0)
                edit_dive_info(get_dive(index));
@@ -844,7 +944,7 @@ static void popup_divelist_menu(GtkTreeView *tree_view, GtkTreeModel *model, int
 
        menu = gtk_menu_new();
        menuitem = gtk_menu_item_new_with_label("Add dive");
-       g_signal_connect(menuitem, "activate", G_CALLBACK(add_dive_cb), model);
+       g_signal_connect(menuitem, "activate", G_CALLBACK(add_dive_cb), NULL);
        gtk_menu_shell_append(GTK_MENU_SHELL(menu), menuitem);
        gtk_widget_show_all(menu);
 
@@ -852,27 +952,141 @@ static void popup_divelist_menu(GtkTreeView *tree_view, GtkTreeModel *model, int
                button, gtk_get_current_event_time());
 }
 
-static void popup_menu_cb(GtkTreeView *tree_view,
-                       GtkTreeModel *model)
+static void popup_menu_cb(GtkTreeView *tree_view, gpointer userdata)
 {
-       popup_divelist_menu(tree_view, model, 0);
+       popup_divelist_menu(tree_view, GTK_TREE_MODEL(dive_list.model), 0);
 }
 
-static gboolean button_press_cb(GtkWidget *treeview, GdkEventButton *event, GtkTreeModel *model)
+static gboolean button_press_cb(GtkWidget *treeview, GdkEventButton *event, gpointer userdata)
 {
        /* Right-click? Bring up the menu */
        if (event->type == GDK_BUTTON_PRESS  &&  event->button == 3) {
-               popup_divelist_menu(GTK_TREE_VIEW(treeview), model, 3);
+               popup_divelist_menu(GTK_TREE_VIEW(treeview), GTK_TREE_MODEL(dive_list.model), 3);
                return TRUE;
        }
        return FALSE;
 }
 
+/* we need to have a temporary copy of the selected dives while
+   switching model as the selection_cb function keeps getting called
+   when gtk_tree_selection_select_path is called.  We also need to
+   keep copies of the sort order so we can restore that as well after
+   switching models. */
+static int *oldselection;
+static int old_nr_selected;
+static gboolean second_call = FALSE;
+static GtkSortType sortorder[] = { [0 ... DIVELIST_COLUMNS - 1] = GTK_SORT_DESCENDING, };
+static int lastcol = DIVE_DATE;
+
+/* Check if this dive was selected previously and select it again in the new model;
+ * This is used after we switch models to maintain consistent selections.
+ * We always return FALSE to iterate through all dives */
+static gboolean select_selected(GtkTreeModel *model, GtkTreePath *path,
+                               GtkTreeIter *iter, gpointer data)
+{
+       int i, idx;
+       GtkTreeSelection *selection = GTK_TREE_SELECTION(data);
+
+       gtk_tree_model_get(model, iter, DIVE_INDEX, &idx, -1);
+       for (i = 0; i < old_nr_selected; i++)
+               if (oldselection[i] == idx) {
+                       gtk_tree_view_expand_to_path(GTK_TREE_VIEW(dive_list.tree_view), path);
+                       gtk_tree_selection_select_path(selection, path);
+
+                       return FALSE;
+               }
+       return FALSE;
+
+}
+
+static void update_column_and_order(int colid)
+{
+       /* Careful: the index into treecolumns is off by one as we don't have a
+          tree_view column for DIVE_INDEX */
+       GtkTreeViewColumn **treecolumns = &dive_list.nr;
+
+       /* this will trigger a second call into sort_column_change_cb,
+          so make sure we don't start an infinite recursion... */
+       second_call = TRUE;
+       gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(dive_list.model), colid, sortorder[colid]);
+       gtk_tree_view_column_set_sort_order(treecolumns[colid - 1], sortorder[colid]);
+       second_call = FALSE;
+}
+
+/* If the sort column is date (default), show the tree model.
+   For every other sort column only show the list model.
+   If the model changed, inform the new model of the chosen sort column and make
+   sure the same dives are still selected.
+
+   The challenge with this function is that once we change the model
+   we also need to change the sort column again (as it was changed in
+   the other model) and that causes this function to be called
+   recursively - so we need to catch that.
+*/
+static void sort_column_change_cb(GtkTreeSortable *treeview, gpointer data)
+{
+       int colid;
+       GtkSortType order;
+       GtkTreeStore *currentmodel = dive_list.model;
+
+       if (second_call)
+               return;
+
+       gtk_tree_sortable_get_sort_column_id(treeview, &colid, &order);
+       if(colid == lastcol) {
+               /* we just changed sort order */
+               sortorder[colid] = order;
+               return;
+       } else {
+               lastcol = colid;
+       }
+       if(colid == DIVE_DATE)
+               dive_list.model = dive_list.treemodel;
+       else
+               dive_list.model = dive_list.listmodel;
+       if (dive_list.model != currentmodel) {
+               GtkTreeSelection *selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(dive_list.tree_view));
+
+               /* remember what is currently selected, switch models and reselect the selected rows */
+               old_nr_selected = amount_selected;
+               oldselection = malloc(old_nr_selected * sizeof(int));
+               if (amount_selected)
+                       memcpy(oldselection, selectiontracker, amount_selected * sizeof(int));
+               gtk_tree_view_set_model(GTK_TREE_VIEW(dive_list.tree_view), GTK_TREE_MODEL(dive_list.model));
+
+               update_column_and_order(colid);
+
+               if (old_nr_selected) {
+                       /* we need to select all the dives that were selected */
+                       /* this is fundamentally an n^2 algorithm as implemented - YUCK */
+                       gtk_tree_model_foreach(GTK_TREE_MODEL(dive_list.model), select_selected, selection);
+               }
+       } else {
+               if (order != sortorder[colid]) {
+                       update_column_and_order(colid);
+               }
+       }
+}
+
 GtkWidget *dive_list_create(void)
 {
        GtkTreeSelection  *selection;
 
-       dive_list.model = gtk_tree_store_new(DIVELIST_COLUMNS,
+       dive_list.listmodel = gtk_tree_store_new(DIVELIST_COLUMNS,
+                               G_TYPE_INT,                     /* index */
+                               G_TYPE_INT,                     /* nr */
+                               G_TYPE_INT,                     /* Date */
+                               G_TYPE_INT,                     /* Star rating */
+                               G_TYPE_INT,                     /* Depth */
+                               G_TYPE_INT,                     /* Duration */
+                               G_TYPE_INT,                     /* Temperature */
+                               G_TYPE_STRING,                  /* Cylinder */
+                               G_TYPE_INT,                     /* Nitrox */
+                               G_TYPE_INT,                     /* SAC */
+                               G_TYPE_INT,                     /* OTU */
+                               G_TYPE_STRING                   /* Location */
+                               );
+       dive_list.treemodel = gtk_tree_store_new(DIVELIST_COLUMNS,
                                G_TYPE_INT,                     /* index */
                                G_TYPE_INT,                     /* nr */
                                G_TYPE_INT,                     /* Date */
@@ -886,6 +1100,7 @@ GtkWidget *dive_list_create(void)
                                G_TYPE_INT,                     /* OTU */
                                G_TYPE_STRING                   /* Location */
                                );
+       dive_list.model = dive_list.treemodel;
        dive_list.tree_view = gtk_tree_view_new_with_model(GTK_TREE_MODEL(dive_list.model));
        set_divelist_font(divelist_font);
 
@@ -914,10 +1129,14 @@ GtkWidget *dive_list_create(void)
                                          NULL);
 
        g_signal_connect_after(dive_list.tree_view, "realize", G_CALLBACK(realize_cb), NULL);
-       g_signal_connect(dive_list.tree_view, "row-activated", G_CALLBACK(row_activated_cb), dive_list.model);
-       g_signal_connect(dive_list.tree_view, "button-press-event", G_CALLBACK(button_press_cb), dive_list.model);
-       g_signal_connect(dive_list.tree_view, "popup-menu", G_CALLBACK(popup_menu_cb), dive_list.model);
-       g_signal_connect(selection, "changed", G_CALLBACK(selection_cb), dive_list.model);
+       g_signal_connect(dive_list.tree_view, "row-activated", G_CALLBACK(row_activated_cb), NULL);
+       g_signal_connect(dive_list.tree_view, "button-press-event", G_CALLBACK(button_press_cb), NULL);
+       g_signal_connect(dive_list.tree_view, "popup-menu", G_CALLBACK(popup_menu_cb), NULL);
+       g_signal_connect(selection, "changed", G_CALLBACK(selection_cb), NULL);
+       g_signal_connect(dive_list.listmodel, "sort-column-changed", G_CALLBACK(sort_column_change_cb), NULL);
+       g_signal_connect(dive_list.treemodel, "sort-column-changed", G_CALLBACK(sort_column_change_cb), NULL);
+
+       gtk_tree_selection_set_select_function(selection, modify_selection_cb, NULL, NULL);
 
        dive_list.container_widget = gtk_scrolled_window_new(NULL, NULL);
        gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(dive_list.container_widget),