gtk2/gtk/gtkmultiselection.c
Matthias Clasen 20c1fb0a0a docs: Tweak documentation for list widgets
Fix numerous cases of : vs :: for signal references,
add some more details here and there.
2020-08-03 18:43:25 -04:00

457 lines
13 KiB
C

/*
* Copyright © 2019 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Authors: Matthias Clasen <mclasen@redhat.com>
*/
#include "config.h"
#include "gtkmultiselection.h"
#include "gtkbitset.h"
#include "gtkintl.h"
#include "gtkselectionmodel.h"
/**
* SECTION:gtkmultiselection
* @Short_description: A selection model that allows selecting multiple items
* @Title: GtkMultiSelection
* @see_also: #GtkSelectionModel
*
* GtkMultiSelection is an implementation of the #GtkSelectionModel interface
* that allows selecting multiple elements.
*/
struct _GtkMultiSelection
{
GObject parent_instance;
GListModel *model;
GtkBitset *selected;
GHashTable *items; /* item => position */
};
struct _GtkMultiSelectionClass
{
GObjectClass parent_class;
};
enum {
PROP_0,
PROP_MODEL,
N_PROPS,
};
static GParamSpec *properties[N_PROPS] = { NULL, };
static GType
gtk_multi_selection_get_item_type (GListModel *list)
{
return G_TYPE_OBJECT;
}
static guint
gtk_multi_selection_get_n_items (GListModel *list)
{
GtkMultiSelection *self = GTK_MULTI_SELECTION (list);
if (self->model == NULL)
return 0;
return g_list_model_get_n_items (self->model);
}
static gpointer
gtk_multi_selection_get_item (GListModel *list,
guint position)
{
GtkMultiSelection *self = GTK_MULTI_SELECTION (list);
if (self->model == NULL)
return NULL;
return g_list_model_get_item (self->model, position);
}
static void
gtk_multi_selection_list_model_init (GListModelInterface *iface)
{
iface->get_item_type = gtk_multi_selection_get_item_type;
iface->get_n_items = gtk_multi_selection_get_n_items;
iface->get_item = gtk_multi_selection_get_item;
}
static gboolean
gtk_multi_selection_is_selected (GtkSelectionModel *model,
guint position)
{
GtkMultiSelection *self = GTK_MULTI_SELECTION (model);
return gtk_bitset_contains (self->selected, position);
}
static GtkBitset *
gtk_multi_selection_get_selection_in_range (GtkSelectionModel *model,
guint pos,
guint n_items)
{
GtkMultiSelection *self = GTK_MULTI_SELECTION (model);
return gtk_bitset_ref (self->selected);
}
static void
gtk_multi_selection_toggle_selection (GtkMultiSelection *self,
GtkBitset *changes)
{
GListModel *model = G_LIST_MODEL (self);
GtkBitsetIter change_iter, selected_iter;
GtkBitset *selected;
guint change_pos, selected_pos;
gboolean more;
gtk_bitset_difference (self->selected, changes);
selected = gtk_bitset_copy (changes);
gtk_bitset_intersect (selected, self->selected);
if (!gtk_bitset_iter_init_first (&selected_iter, selected, &selected_pos))
selected_pos = G_MAXUINT;
for (more = gtk_bitset_iter_init_first (&change_iter, changes, &change_pos);
more;
more = gtk_bitset_iter_next (&change_iter, &change_pos))
{
gpointer item = g_list_model_get_item (model, change_pos);
if (change_pos < selected_pos)
{
g_hash_table_remove (self->items, item);
g_object_unref (item);
}
else
{
g_assert (change_pos == selected_pos);
g_hash_table_insert (self->items, item, GUINT_TO_POINTER (change_pos));
if (!gtk_bitset_iter_next (&selected_iter, &selected_pos))
selected_pos = G_MAXUINT;
}
}
gtk_bitset_unref (selected);
}
static gboolean
gtk_multi_selection_set_selection (GtkSelectionModel *model,
GtkBitset *selected,
GtkBitset *mask)
{
GtkMultiSelection *self = GTK_MULTI_SELECTION (model);
GtkBitset *changes;
guint min, max, n_items;
/* changes = (self->selected XOR selected) AND mask
* But doing it this way avoids looking at all values outside the mask
*/
changes = gtk_bitset_copy (selected);
gtk_bitset_difference (changes, self->selected);
gtk_bitset_intersect (changes, mask);
min = gtk_bitset_get_minimum (changes);
max = gtk_bitset_get_maximum (changes);
/* sanity check */
n_items = self->model ? g_list_model_get_n_items (self->model) : 0;
if (max >= n_items)
{
gtk_bitset_remove_range_closed (changes, n_items, max);
max = gtk_bitset_get_maximum (changes);
}
/* actually do the change */
gtk_multi_selection_toggle_selection (self, changes);
gtk_bitset_unref (changes);
if (min <= max)
gtk_selection_model_selection_changed (model, min, max - min + 1);
return TRUE;
}
static void
gtk_multi_selection_selection_model_init (GtkSelectionModelInterface *iface)
{
iface->is_selected = gtk_multi_selection_is_selected;
iface->get_selection_in_range = gtk_multi_selection_get_selection_in_range;
iface->set_selection = gtk_multi_selection_set_selection;
}
G_DEFINE_TYPE_EXTENDED (GtkMultiSelection, gtk_multi_selection, G_TYPE_OBJECT, 0,
G_IMPLEMENT_INTERFACE (G_TYPE_LIST_MODEL,
gtk_multi_selection_list_model_init)
G_IMPLEMENT_INTERFACE (GTK_TYPE_SELECTION_MODEL,
gtk_multi_selection_selection_model_init))
static void
gtk_multi_selection_items_changed_cb (GListModel *model,
guint position,
guint removed,
guint added,
GtkMultiSelection *self)
{
GHashTableIter iter;
gpointer item, pos_pointer;
GHashTable *pending = NULL;
guint i;
gtk_bitset_splice (self->selected, position, removed, added);
g_hash_table_iter_init (&iter, self->items);
while (g_hash_table_iter_next (&iter, &item, &pos_pointer))
{
guint pos = GPOINTER_TO_UINT (pos_pointer);
if (pos < position)
continue;
else if (pos >= position + removed)
g_hash_table_iter_replace (&iter, GUINT_TO_POINTER (pos - removed + added));
else /* if pos is in the removed range */
{
if (added == 0)
{
g_hash_table_iter_remove (&iter);
}
else
{
g_hash_table_iter_steal (&iter);
if (pending == NULL)
pending = g_hash_table_new_full (NULL, NULL, g_object_unref, NULL);
g_hash_table_add (pending, item);
}
}
}
for (i = position; pending != NULL && i < position + added; i++)
{
item = g_list_model_get_item (model, i);
if (g_hash_table_contains (pending, item))
{
gtk_bitset_add (self->selected, i);
g_hash_table_insert (self->items, item, GUINT_TO_POINTER (i));
g_hash_table_remove (pending, item);
if (g_hash_table_size (pending) == 0)
g_clear_pointer (&pending, g_hash_table_unref);
}
else
{
g_object_unref (item);
}
}
g_clear_pointer (&pending, g_hash_table_unref);
g_list_model_items_changed (G_LIST_MODEL (self), position, removed, added);
}
static void
gtk_multi_selection_clear_model (GtkMultiSelection *self)
{
if (self->model == NULL)
return;
g_signal_handlers_disconnect_by_func (self->model,
gtk_multi_selection_items_changed_cb,
self);
g_clear_object (&self->model);
}
static void
gtk_multi_selection_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GtkMultiSelection *self = GTK_MULTI_SELECTION (object);
switch (prop_id)
{
case PROP_MODEL:
gtk_multi_selection_set_model (self, g_value_get_object (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gtk_multi_selection_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
GtkMultiSelection *self = GTK_MULTI_SELECTION (object);
switch (prop_id)
{
case PROP_MODEL:
g_value_set_object (value, self->model);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gtk_multi_selection_dispose (GObject *object)
{
GtkMultiSelection *self = GTK_MULTI_SELECTION (object);
gtk_multi_selection_clear_model (self);
g_clear_pointer (&self->selected, gtk_bitset_unref);
g_clear_pointer (&self->items, g_hash_table_unref);
G_OBJECT_CLASS (gtk_multi_selection_parent_class)->dispose (object);
}
static void
gtk_multi_selection_class_init (GtkMultiSelectionClass *klass)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
gobject_class->get_property = gtk_multi_selection_get_property;
gobject_class->set_property = gtk_multi_selection_set_property;
gobject_class->dispose = gtk_multi_selection_dispose;
/**
* GtkMultiSelection:model:
*
* The list managed by this selection
*/
properties[PROP_MODEL] =
g_param_spec_object ("model",
P_("Model"),
P_("List managed by this selection"),
G_TYPE_LIST_MODEL,
G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS);
g_object_class_install_properties (gobject_class, N_PROPS, properties);
}
static void
gtk_multi_selection_init (GtkMultiSelection *self)
{
self->selected = gtk_bitset_new_empty ();
self->items = g_hash_table_new_full (NULL, NULL, g_object_unref, NULL);
}
/**
* gtk_multi_selection_new:
* @model: (allow-none) (transfer full): the #GListModel to manage, or %NULL
*
* Creates a new selection to handle @model.
*
* Returns: (transfer full): a new #GtkMultiSelection
**/
GtkMultiSelection *
gtk_multi_selection_new (GListModel *model)
{
GtkMultiSelection *self;
g_return_val_if_fail (G_IS_LIST_MODEL (model), NULL);
self = g_object_new (GTK_TYPE_MULTI_SELECTION,
"model", model,
NULL);
/* consume the reference */
g_clear_object (&model);
return self;
}
/**
* gtk_multi_selection_get_model:
* @self: a #GtkMultiSelection
*
* Returns the underlying model of @self.
*
* Returns: (transfer none): the underlying model
*/
GListModel *
gtk_multi_selection_get_model (GtkMultiSelection *self)
{
g_return_val_if_fail (GTK_IS_MULTI_SELECTION (self), NULL);
return self->model;
}
/**
* gtk_multi_selection_set_model:
* @self: a #GtkMultiSelection
* @model: (allow-none): A #GListModel to wrap
*
* Sets the model that @self should wrap. If @model is %NULL, @self
* will be empty.
**/
void
gtk_multi_selection_set_model (GtkMultiSelection *self,
GListModel *model)
{
guint n_items_before;
g_return_if_fail (GTK_IS_MULTI_SELECTION (self));
g_return_if_fail (model == NULL || G_IS_LIST_MODEL (model));
if (self->model == model)
return;
n_items_before = self->model ? g_list_model_get_n_items (self->model) : 0;
gtk_multi_selection_clear_model (self);
if (model)
{
self->model = g_object_ref (model);
g_signal_connect (self->model,
"items-changed",
G_CALLBACK (gtk_multi_selection_items_changed_cb),
self);
gtk_multi_selection_items_changed_cb (self->model,
0,
n_items_before,
g_list_model_get_n_items (model),
self);
}
else
{
gtk_bitset_remove_all (self->selected);
g_hash_table_remove_all (self->items);
g_list_model_items_changed (G_LIST_MODEL (self), 0, n_items_before, 0);
}
g_object_notify_by_pspec (G_OBJECT (self), properties[PROP_MODEL]);
}