views/agenda: Port to GListModel

This is a major rework of the Agenda view. It splits the view into
GcalAgendaViewDay, which represent a single day with events; and
GcalAgendaViewDayRow, which is the actual widget with a title label,
and a listbox with event widgets.

The Agenda view itself merely manages a list of GcalAgendaViewDays,
and updates them with the events model, and active dates.

This allows us to get rid of the custom listbox row, and the confusing
checks for event widgets, and all the bugs the came with it. It also
allows for removing the internal GcalRangeTree, and delegate all
event management to list models.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-calendar/-/merge_requests/742>
This commit is contained in:
Georges Basile Stavracas Neto
2026-05-03 16:57:54 +00:00
committed by Marge Bot
parent 5c39162f86
commit d065d4b9e8
11 changed files with 832 additions and 452 deletions
+82 -427
View File
@@ -19,6 +19,8 @@
#define G_LOG_DOMAIN "GcalAgendaView"
#include "gcal-agenda-view.h"
#include "gcal-agenda-view-day.h"
#include "gcal-agenda-view-day-row.h"
#include "gcal-debug.h"
#include "gcal-enums.h"
#include "gcal-event-widget.h"
@@ -28,7 +30,6 @@
#include "gcal-view-private.h"
#include <adwaita.h>
#include <glib/gi18n.h>
#include <math.h>
@@ -43,14 +44,13 @@ struct _GcalAgendaView
{
GtkBox parent;
GtkWidget *list_box;
GtkWidget *no_events_row;
GtkWidget *scrolled_window;
/* property */
GDateTime *date;
GListStore *days_model;
GtkFilterListModel *filtered_days;
GcalRangeTree *events;
guint scroll_grid_timeout_id;
gulong stack_page_changed_id;
@@ -82,132 +82,6 @@ G_DEFINE_TYPE_WITH_CODE (GcalAgendaView, gcal_agenda_view, GTK_TYPE_BOX,
* Auxiliary methods
*/
static ChildData*
child_data_new (GtkWidget *widget,
GcalEvent *event,
GcalAgendaView *self)
{
ChildData *data;
data = g_new (ChildData, 1);
data->widget = widget;
data->event = g_object_ref (event);
data->self = self;
return data;
}
static void
child_data_free (gpointer data)
{
ChildData *child_data = data;
if (!child_data)
return;
if (child_data->widget && child_data->self)
{
gtk_list_box_remove (GTK_LIST_BOX (child_data->self->list_box), child_data->widget);
child_data->widget = NULL;
child_data->self = NULL;
}
g_clear_object (&child_data->event);
g_free (child_data);
}
static GDateTime *
get_start_date_for_row (GcalAgendaView *self,
GtkListBoxRow *row)
{
GtkWidget *widget = gtk_list_box_row_get_child (row);
if (GCAL_IS_EVENT_WIDGET (widget))
{
GDateTime *date = gcal_event_widget_get_date_start (GCAL_EVENT_WIDGET (widget));
/* Pretend events start at least on the selected date */
if (gcal_date_time_compare_date (date, self->date) > 0)
return date;
else
return self->date;
}
return self->date;
}
static GDateTime *
get_end_date_for_row (GcalAgendaView *self,
GtkListBoxRow *row)
{
GtkWidget *widget = gtk_list_box_row_get_child (row);
if (GCAL_IS_EVENT_WIDGET (widget))
return gcal_event_widget_get_date_end (GCAL_EVENT_WIDGET (widget));
return self->date;
}
static gboolean
get_row_is_multiday (GtkListBoxRow *row)
{
GtkWidget *widget = gtk_list_box_row_get_child (row);
if (GCAL_IS_EVENT_WIDGET (widget))
{
GcalEvent *event = gcal_event_widget_get_event (GCAL_EVENT_WIDGET (widget));
return gcal_event_is_multiday (event);
}
return FALSE;
}
static gboolean
get_row_is_all_day (GtkListBoxRow *row)
{
GtkWidget *widget = gtk_list_box_row_get_child (row);
if (GCAL_IS_EVENT_WIDGET (widget))
{
GcalEvent *event = gcal_event_widget_get_event (GCAL_EVENT_WIDGET (widget));
return gcal_event_get_all_day (event);
}
return FALSE;
}
static gchar *
new_date_header_string (GDateTime *date)
{
g_autoptr (GDateTime) today = NULL;
g_autoptr (GDateTime) tomorrow = NULL;
g_autoptr (GDateTime) yesterday = NULL;
if (date == NULL)
return NULL;
today = g_date_time_new_now_local ();
tomorrow = g_date_time_add_days (today, 1);
yesterday = g_date_time_add_days (today, -1);
if (gcal_date_time_compare_date (date, today) == 0)
return g_strdup (_("Today"));
else if (gcal_date_time_compare_date (date, tomorrow) == 0)
return g_strdup (_("Tomorrow"));
else if (gcal_date_time_compare_date (date, yesterday) == 0)
return g_strdup (_("Yesterday"));
else
/*
* Translators: %A is the full day name, %B is the month name
* and %d is the day of the month as a number between 0 and 31.
* More formats can be found on the doc:
* https://docs.gtk.org/glib/method.DateTime.format.html
*/
return g_date_time_format (date, _("%A %B %d"));
}
/*
* Callbacks
@@ -226,20 +100,6 @@ stack_visible_child_changed_cb (AdwViewStack *stack,
g_clear_signal_handler (&self->stack_page_changed_id, stack);
}
/* Auxiliary methods */
static void
update_no_events_row (GcalAgendaView *self)
{
gboolean visible = !self->events_on_date;
gboolean was_visible = gtk_widget_get_visible (self->no_events_row);
if (visible != was_visible)
{
gtk_widget_set_visible (self->no_events_row, visible);
gtk_list_box_invalidate_headers (GTK_LIST_BOX (self->list_box));
}
}
static gboolean
update_grid_scroll_position (GcalAgendaView *self)
{
@@ -315,146 +175,30 @@ schedule_position_scroll (GcalAgendaView *self)
self);
}
static GDateTime*
all_day_to_local (GDateTime *dt)
static gboolean
n_items_and_date_to_boolean (GcalAgendaViewDay *day,
unsigned int n_items,
GDateTime *date,
gpointer user_data)
{
return g_date_time_new_local (g_date_time_get_year (dt),
g_date_time_get_month (dt),
g_date_time_get_day_of_month (dt),
0, 0, 0);
}
GcalAgendaView *self = (GcalAgendaView *) user_data;
g_autoptr (GcalRange) view_range = NULL;
static int
sort_func (GtkListBoxRow *row1,
GtkListBoxRow *row2,
gpointer user_data)
{
GcalAgendaView *self = GCAL_AGENDA_VIEW (user_data);
g_autoptr (GDateTime) start_date1 = get_start_date_for_row (self, row1);
g_autoptr (GDateTime) start_date2 = get_start_date_for_row (self, row2);
g_autoptr (GDateTime) end_date1 = NULL;
g_autoptr (GDateTime) end_date2 = NULL;
gboolean multiday1, multiday2;
gboolean all_day1, all_day2;
int result;
g_assert (GCAL_IS_AGENDA_VIEW (self));
g_assert (GCAL_IS_AGENDA_VIEW_DAY (day));
g_assert (self->date != NULL);
all_day1 = get_row_is_all_day (row1);
all_day2 = get_row_is_all_day (row2);
view_range = gcal_timeline_subscriber_get_range (GCAL_TIMELINE_SUBSCRIBER (self));
if (!gcal_range_contains_datetime (view_range, date))
return FALSE;
start_date1 = all_day1 ? all_day_to_local (start_date1) : g_date_time_to_local (start_date1);
start_date2 = all_day2 ? all_day_to_local (start_date2) : g_date_time_to_local (start_date2);
if (n_items > 0)
return TRUE;
result = g_date_time_compare (start_date1, start_date2);
if (gcal_date_time_compare_date (date, self->date) == 0)
return TRUE;
/* Sort multi day events before multi single day events of the same day. */
if (result != 0)
return result;
multiday1 = get_row_is_multiday (row1);
multiday2 = get_row_is_multiday (row2);
if (multiday1 != multiday2)
return multiday1 ? -1 : 1;
if (all_day1 != all_day2)
return all_day1 ? -1 : 1;
end_date1 = g_date_time_to_local (get_end_date_for_row (self, row1));
end_date2 = g_date_time_to_local (get_end_date_for_row (self, row2));
return g_date_time_compare (end_date1, end_date2);
}
static void
update_header (GtkListBoxRow *row,
GtkListBoxRow *before,
gpointer user_data)
{
GcalAgendaView *self = GCAL_AGENDA_VIEW (user_data);
GtkWidget *widget = gtk_list_box_row_get_child (row);
gboolean event_all_day = get_row_is_all_day (row);
g_autoptr (GDateTime) start = get_start_date_for_row (self, row);
g_autoptr (GDateTime) end = get_end_date_for_row (self, row);
g_autoptr (GDateTime) today = NULL;
g_autoptr (GDateTime) end_midnight = NULL;
GcalEvent *event = NULL;
g_autofree gchar *label = NULL;
GtkWidget *header;
start = event_all_day ? g_date_time_ref (start) : g_date_time_to_local (start);
end = event_all_day ? g_date_time_ref (end) : g_date_time_to_local (end);
if (GCAL_IS_EVENT_WIDGET (widget))
event = gcal_event_widget_get_event (GCAL_EVENT_WIDGET (widget));
today = g_date_time_new_now_local ();
if (before)
{
g_autoptr (GDateTime) before_start = get_start_date_for_row (self, before);
g_autoptr (GDateTime) before_end = get_end_date_for_row (self, before);
gboolean before_all_day = get_row_is_all_day (before);
before_start = before_all_day ? g_date_time_ref (before_start) : g_date_time_to_local (before_start);
before_end = before_all_day ? g_date_time_ref (before_end) : g_date_time_to_local (before_end);
if (get_row_is_multiday (row) &&
get_row_is_multiday (before) &&
gcal_date_time_compare_date (start, before_start) == 0 &&
gcal_date_time_compare_date (start, today) == 0)
{
gtk_list_box_row_set_header (row, NULL);
return;
}
end_midnight = event_all_day ? g_date_time_ref (end) : g_date_time_add_seconds (end, -1);
if (gcal_date_time_compare_date (start, before_start) == 0 &&
gcal_date_time_compare_date (end_midnight, before_end) == 0)
{
gtk_list_box_row_set_header (row, NULL);
return;
}
/* All day events don't need to check for end date */
if (event &&
(before_all_day || event_all_day) &&
!get_row_is_multiday (before) &&
gcal_date_time_compare_date (start, before_start) == 0)
{
gtk_list_box_row_set_header (row, NULL);
return;
}
}
if (get_row_is_multiday (row))
{
g_autofree gchar *start_label = NULL;
g_autofree gchar *end_label = NULL;
if (gcal_date_time_compare_date (start, today) == 0)
{
label = g_strdup (_("On-going"));
}
else
{
start_label = new_date_header_string (start);
end_label = new_date_header_string (end);
label = g_strdup_printf ("%s – %s", start_label, end_label);
}
}
else
{
label = new_date_header_string (start);
}
header = g_object_new (GTK_TYPE_LABEL,
"label", label,
"xalign", 0.0f,
NULL);
gtk_widget_add_css_class (header, "caption-heading");
gtk_list_box_row_set_header (row, header);
return FALSE;
}
@@ -470,23 +214,6 @@ gcal_agenda_view_get_date (GcalView *view)
return self->date;
}
static inline gboolean
count_events_on_data (GcalRange *range,
gpointer data,
gpointer user_data)
{
ChildData *child_data = data;
GcalAgendaView *self = user_data;
g_autoptr (GDateTime) event_date = gcal_event_get_date_start (child_data->event);
event_date = gcal_event_get_all_day (child_data->event) ? g_date_time_ref (event_date) : g_date_time_to_local (event_date);
if (gcal_date_time_compare_date (self->date, event_date) == 0)
self->events_on_date++;
return FALSE;
}
static void
gcal_agenda_view_set_date (GcalView *view,
GDateTime *date)
@@ -497,17 +224,21 @@ gcal_agenda_view_set_date (GcalView *view,
gcal_set_date_time (&self->date, date);
for (unsigned int i = 0; i < g_list_model_get_n_items (G_LIST_MODEL (self->days_model)); i++)
{
g_autoptr (GcalAgendaViewDay) day = NULL;
g_autoptr (GDateTime) next_date = NULL;
day = g_list_model_get_item (G_LIST_MODEL (self->days_model), i);
next_date = g_date_time_add_days (date, i);
gcal_agenda_view_day_set_date (day, next_date);
}
schedule_position_scroll (self);
self->events_on_date = 0;
gcal_range_tree_traverse (self->events, G_IN_ORDER, count_events_on_data, self);
update_no_events_row (self);
gcal_timeline_subscriber_range_changed (GCAL_TIMELINE_SUBSCRIBER (view));
if (self->events_on_date == 0)
gtk_list_box_invalidate_sort (GTK_LIST_BOX (self->list_box));
GCAL_EXIT;
}
@@ -565,24 +296,18 @@ gcal_view_interface_init (GcalViewInterface *iface)
*/
static void
on_event_widget_activated_cb (GcalEventWidget *event_widget,
GcalAgendaView *self)
on_day_row_event_activated_cb (GcalAgendaViewDayRow *day_row,
GcalEventWidget *event_widget,
gpointer user_data)
{
GcalAgendaView *self;
self = GCAL_AGENDA_VIEW (gtk_widget_get_ancestor (GTK_WIDGET (day_row), GCAL_TYPE_AGENDA_VIEW));
g_assert (GCAL_IS_AGENDA_VIEW (self));
gcal_view_event_activated (GCAL_VIEW (self), event_widget);
}
static void
on_list_box_row_activated_cb (GtkListBox *list_box,
GtkListBoxRow *row,
GcalAgendaView *self)
{
GtkWidget *child = gtk_list_box_row_get_child (row);
g_assert (GCAL_IS_EVENT_WIDGET (child));
gcal_view_event_activated (GCAL_VIEW (self), GCAL_EVENT_WIDGET (child));
}
static GcalRange*
gcal_agenda_view_get_range (GcalTimelineSubscriber *subscriber)
{
@@ -597,107 +322,12 @@ static void
gcal_agenda_view_add_event (GcalTimelineSubscriber *subscriber,
GcalEvent *event)
{
GcalAgendaView *self = GCAL_AGENDA_VIEW (subscriber);
g_autoptr (GDateTime) event_date = gcal_event_get_date_start (event);
GtkWidget *widget, *row;
GcalTimestampPolicy timestamp_policy;
GCAL_ENTRY;
/* FIXME Check gcal_event_is_multiday (event) and gcal_event_get_all_day (event) */
g_object_ref (event);
event_date = gcal_event_get_all_day (event) ? g_date_time_ref (event_date) : g_date_time_to_local (event_date);
if (gcal_date_time_compare_date (self->date, event_date) == 0)
{
self->events_on_date++;
update_no_events_row (self);
}
/* Create and add the new event widget */
if (gcal_event_get_all_day (event) || gcal_event_is_multiday (event))
timestamp_policy = GCAL_TIMESTAMP_POLICY_END;
else
timestamp_policy = GCAL_TIMESTAMP_POLICY_START;
widget = g_object_new (GCAL_TYPE_EVENT_WIDGET,
"event", event,
"orientation", GTK_ORIENTATION_VERTICAL,
"timestamp-policy", timestamp_policy,
"focusable", FALSE,
NULL);
row = g_object_new (GTK_TYPE_LIST_BOX_ROW,
"child", widget,
NULL);
gcal_range_tree_add_range (self->events,
gcal_event_get_range (event),
child_data_new (row, event, self));
gtk_accessible_update_property (GTK_ACCESSIBLE (row),
GTK_ACCESSIBLE_PROPERTY_HAS_POPUP, TRUE,
-1);
gtk_accessible_update_relation (GTK_ACCESSIBLE (row),
GTK_ACCESSIBLE_RELATION_LABELLED_BY, widget, NULL,
-1);
g_signal_connect (widget, "activate", G_CALLBACK (on_event_widget_activated_cb), self);
gtk_list_box_append (GTK_LIST_BOX (self->list_box), row);
gtk_list_box_invalidate_headers (GTK_LIST_BOX (self->list_box));
GCAL_EXIT;
}
static void
gcal_agenda_view_remove_event (GcalTimelineSubscriber *subscriber,
GcalEvent *event)
{
GcalAgendaView *self = GCAL_AGENDA_VIEW (subscriber);
const gchar *uid = gcal_event_get_uid (event);
g_autoptr (GDateTime) event_date = gcal_event_get_date_start (event);
GPtrArray *widgets;
guint i;
GCAL_ENTRY;
widgets = gcal_range_tree_get_all_data (self->events);
event_date = gcal_event_get_all_day (event) ? g_date_time_ref (event_date) : g_date_time_to_local (event_date);
if (gcal_date_time_compare_date (self->date, event_date) == 0)
{
self->events_on_date--;
update_no_events_row (self);
}
for (i = 0; widgets && i < widgets->len; i++)
{
ChildData *data;
GtkWidget *widget;
GcalEvent *event;
data = g_ptr_array_index (widgets, i);
widget = gtk_list_box_row_get_child (GTK_LIST_BOX_ROW (data->widget));
event = gcal_event_widget_get_event (GCAL_EVENT_WIDGET (widget));
if (g_strcmp0 (gcal_event_get_uid (event), uid) != 0)
continue;
gcal_range_tree_remove_range (self->events, gcal_event_get_range (event), data);
gtk_widget_queue_allocate (GTK_WIDGET (self));
}
g_clear_pointer (&widgets, g_ptr_array_unref);
gtk_list_box_invalidate_headers (GTK_LIST_BOX (self->list_box));
GCAL_EXIT;
}
static void
@@ -705,10 +335,24 @@ gcal_agenda_view_update_event (GcalTimelineSubscriber *subscriber,
GcalEvent *old_event,
GcalEvent *event)
{
}
static void
gcal_agenda_view_set_model (GcalTimelineSubscriber *subscriber,
GListModel *model)
{
GcalAgendaView *self;
GCAL_ENTRY;
gcal_agenda_view_remove_event (subscriber, old_event);
gcal_agenda_view_add_event (subscriber, event);
self = GCAL_AGENDA_VIEW (subscriber);
for (unsigned int i = 0; i < g_list_model_get_n_items (G_LIST_MODEL (self->days_model)); i++)
{
g_autoptr (GcalAgendaViewDay) day = g_list_model_get_item (G_LIST_MODEL (self->days_model), i);
gcal_agenda_view_day_set_model (day, model);
}
GCAL_EXIT;
}
@@ -720,6 +364,7 @@ gcal_timeline_subscriber_interface_init (GcalTimelineSubscriberInterface *iface)
iface->add_event = gcal_agenda_view_add_event;
iface->update_event = gcal_agenda_view_update_event;
iface->remove_event = gcal_agenda_view_remove_event;
iface->set_model = gcal_agenda_view_set_model;
}
@@ -730,22 +375,17 @@ gcal_timeline_subscriber_interface_init (GcalTimelineSubscriberInterface *iface)
static void
gcal_agenda_view_dispose (GObject *object)
{
GcalAgendaView *self;
GcalAgendaView *self = GCAL_AGENDA_VIEW (object);
self = GCAL_AGENDA_VIEW (object);
gtk_widget_dispose_template (GTK_WIDGET (self), GCAL_TYPE_AGENDA_VIEW);
g_clear_pointer (&self->events, gcal_range_tree_unref);
/* Chain up to parent's dispose() method. */
G_OBJECT_CLASS (gcal_agenda_view_parent_class)->dispose (object);
}
static void
gcal_agenda_view_finalize (GObject *object)
{
GcalAgendaView *self;
self = GCAL_AGENDA_VIEW (object);
GcalAgendaView *self = GCAL_AGENDA_VIEW (object);
g_clear_pointer (&self->date, g_date_time_unref);
@@ -804,6 +444,8 @@ gcal_agenda_view_class_init (GcalAgendaViewClass *klass)
GObjectClass *object_class = G_OBJECT_CLASS (klass);
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
g_type_ensure (GCAL_TYPE_AGENDA_VIEW_DAY_ROW);
object_class->dispose = gcal_agenda_view_dispose;
object_class->finalize = gcal_agenda_view_finalize;
object_class->set_property = gcal_agenda_view_set_property;
@@ -814,11 +456,11 @@ gcal_agenda_view_class_init (GcalAgendaViewClass *klass)
gtk_widget_class_set_template_from_resource (widget_class, "/org/gnome/calendar/ui/views/gcal-agenda-view.ui");
gtk_widget_class_bind_template_child (widget_class, GcalAgendaView, list_box);
gtk_widget_class_bind_template_child (widget_class, GcalAgendaView, no_events_row);
gtk_widget_class_bind_template_child (widget_class, GcalAgendaView, filtered_days);
gtk_widget_class_bind_template_child (widget_class, GcalAgendaView, scrolled_window);
gtk_widget_class_bind_template_callback (widget_class, on_list_box_row_activated_cb);
gtk_widget_class_bind_template_callback (widget_class, n_items_and_date_to_boolean);
gtk_widget_class_bind_template_callback (widget_class, on_day_row_event_activated_cb);
gtk_widget_class_set_css_name (widget_class, "agenda-view");
}
@@ -828,8 +470,21 @@ gcal_agenda_view_init (GcalAgendaView *self)
{
gtk_widget_init_template (GTK_WIDGET (self));
self->events = gcal_range_tree_new_with_free_func (child_data_free);
self->date = g_date_time_new_now_local ();
self->days_model = g_list_store_new (GCAL_TYPE_AGENDA_VIEW_DAY);
gtk_list_box_set_sort_func (GTK_LIST_BOX (self->list_box), sort_func, self, NULL);
gtk_list_box_set_header_func (GTK_LIST_BOX (self->list_box), update_header, self, NULL);
for (size_t i = 0; i < N_WEEKDAYS; i++)
{
g_autoptr (GcalAgendaViewDay) day = NULL;
g_autoptr (GDateTime) date = NULL;
date = g_date_time_add_days (self->date, i);
day = gcal_agenda_view_day_new ();
gcal_agenda_view_day_set_date (day, date);
g_list_store_append (self->days_model, day);
}
gtk_filter_list_model_set_model (self->filtered_days, G_LIST_MODEL (self->days_model));
}