sysprof: add sidebar widget to display stack sections

src/sysprof/meson.build

@@ -6,6 +6,7 @@ sysprof_sources = [
   'sysprof-recording-pad.c',
   'sysprof-metadata-dialog.c',
   'sysprof-samples-section.c',
+  'sysprof-sidebar.c',
   'sysprof-section.c',
   'sysprof-window.c',
 ]

src/sysprof/sysprof-sidebar.c

@@ -0,0 +1,182 @@
+/* sysprof-sidebar.c
+ *
+ * Copyright 2023 Christian Hergert <chergert@redhat.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#include "config.h"
+
+#include "sysprof-section.h"
+#include "sysprof-sidebar.h"
+
+struct _SysprofSidebar
+{
+  GtkWidget     parent_instance;
+  GSignalGroup *stack_signals;
+  GtkListBox   *list_box;
+};
+
+enum {
+  PROP_0,
+  PROP_STACK,
+  N_PROPS
+};
+
+G_DEFINE_FINAL_TYPE (SysprofSidebar, sysprof_sidebar, GTK_TYPE_WIDGET)
+
+static GParamSpec *properties [N_PROPS];
+
+static GtkWidget *
+sysprof_sidebar_create_row (gpointer item,
+                            gpointer user_data)
+{
+  GtkStackPage *page = item;
+  SysprofSidebar *sidebar = user_data;
+  SysprofSection *section;
+
+  g_assert (GTK_IS_STACK_PAGE (page));
+  g_assert (SYSPROF_IS_SIDEBAR (sidebar));
+
+  section = SYSPROF_SECTION (gtk_stack_page_get_child (page));
+
+  return g_object_new (GTK_TYPE_LABEL,
+                       "xalign", .0f,
+                       "label", sysprof_section_get_title (section),
+                       NULL);
+}
+
+static void
+sysprof_sidebar_bind_cb (SysprofSidebar *self,
+                         GtkStack       *stack,
+                         GSignalGroup   *group)
+{
+  GtkSelectionModel *model;
+
+  g_assert (SYSPROF_IS_SIDEBAR (self));
+  g_assert (GTK_IS_STACK (stack));
+  g_assert (G_IS_SIGNAL_GROUP (group));
+
+  model = gtk_stack_get_pages (stack);
+
+  gtk_list_box_bind_model (self->list_box,
+                           G_LIST_MODEL (model),
+                           sysprof_sidebar_create_row,
+                           self,
+                           NULL);
+}
+
+static void
+sysprof_sidebar_unbind_cb (SysprofSidebar *self,
+                           GSignalGroup   *group)
+{
+  g_assert (SYSPROF_IS_SIDEBAR (self));
+  g_assert (G_IS_SIGNAL_GROUP (group));
+
+  gtk_list_box_bind_model (self->list_box, NULL, NULL, NULL, NULL);
+}
+
+static void
+sysprof_sidebar_dispose (GObject *object)
+{
+  SysprofSidebar *self = (SysprofSidebar *)object;
+  GtkWidget *child;
+
+  g_clear_object (&self->stack_signals);
+
+  while ((child = gtk_widget_get_first_child (GTK_WIDGET (self))))
+    gtk_widget_unparent (child);
+
+  G_OBJECT_CLASS (sysprof_sidebar_parent_class)->dispose (object);
+}
+
+static void
+sysprof_sidebar_get_property (GObject    *object,
+                              guint       prop_id,
+                              GValue     *value,
+                              GParamSpec *pspec)
+{
+  SysprofSidebar *self = SYSPROF_SIDEBAR (object);
+
+  switch (prop_id)
+    {
+    case PROP_STACK:
+      g_value_take_object (value, g_signal_group_dup_target (self->stack_signals));
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+sysprof_sidebar_set_property (GObject      *object,
+                              guint         prop_id,
+                              const GValue *value,
+                              GParamSpec   *pspec)
+{
+  SysprofSidebar *self = SYSPROF_SIDEBAR (object);
+
+  switch (prop_id)
+    {
+    case PROP_STACK:
+      g_signal_group_set_target (self->stack_signals, g_value_get_object (value));
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+sysprof_sidebar_class_init (SysprofSidebarClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
+
+  object_class->dispose = sysprof_sidebar_dispose;
+  object_class->get_property = sysprof_sidebar_get_property;
+  object_class->set_property = sysprof_sidebar_set_property;
+
+  properties[PROP_STACK] =
+    g_param_spec_object ("stack", NULL, NULL,
+                         GTK_TYPE_STACK,
+                         (G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS));
+
+  g_object_class_install_properties (object_class, N_PROPS, properties);
+
+  gtk_widget_class_set_template_from_resource (widget_class, "/org/gnome/sysprof/sysprof-sidebar.ui");
+  gtk_widget_class_set_layout_manager_type (widget_class, GTK_TYPE_BIN_LAYOUT);
+  gtk_widget_class_bind_template_child (widget_class, SysprofSidebar, list_box);
+}
+
+static void
+sysprof_sidebar_init (SysprofSidebar *self)
+{
+  self->stack_signals = g_signal_group_new (GTK_TYPE_STACK);
+  g_signal_connect_object (self->stack_signals,
+                           "bind",
+                           G_CALLBACK (sysprof_sidebar_bind_cb),
+                           self,
+                           G_CONNECT_SWAPPED);
+  g_signal_connect_object (self->stack_signals,
+                           "unbind",
+                           G_CALLBACK (sysprof_sidebar_unbind_cb),
+                           self,
+                           G_CONNECT_SWAPPED);
+
+  gtk_widget_init_template (GTK_WIDGET (self));
+}

src/sysprof/sysprof-sidebar.h

@@ -0,0 +1,31 @@
+/* sysprof-sidebar.h
+ *
+ * Copyright 2023 Christian Hergert <chergert@redhat.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#pragma once
+
+#include <gtk/gtk.h>
+
+G_BEGIN_DECLS
+
+#define SYSPROF_TYPE_SIDEBAR (sysprof_sidebar_get_type())
+
+G_DECLARE_FINAL_TYPE (SysprofSidebar, sysprof_sidebar, SYSPROF, SIDEBAR, GtkWidget)
+
+G_END_DECLS

src/sysprof/sysprof-sidebar.ui

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<interface>
+  <template class="SysprofSidebar" parent="GtkWidget">
+    <child>
+      <object class="GtkScrolledWindow">
+        <property name="hscrollbar-policy">never</property>
+        <child>
+          <object class="GtkListBox" id="list_box">
+            <style>
+              <class name="navigation-sidebar"/>
+            </style>
+          </object>
+        </child>
+      </object>
+    </child>
+  </template>
+</interface>

src/sysprof/sysprof-window.c

@@ -28,6 +28,7 @@
 #include "sysprof-greeter.h"
 #include "sysprof-metadata-dialog.h"
 #include "sysprof-samples-section.h"
+#include "sysprof-sidebar.h"
 #include "sysprof-window.h"
 
 struct _SysprofWindow
@@ -195,8 +196,9 @@ sysprof_window_class_init (SysprofWindowClass *klass)
   gtk_widget_class_install_action (widget_class, "capture.show-metadata", NULL, sysprof_window_show_metadata_action);
 
   g_type_ensure (SYSPROF_TYPE_DOCUMENT);
-  g_type_ensure (SYSPROF_TYPE_SESSION);
   g_type_ensure (SYSPROF_TYPE_SAMPLES_SECTION);
+  g_type_ensure (SYSPROF_TYPE_SESSION);
+  g_type_ensure (SYSPROF_TYPE_SIDEBAR);
 }
 
 static void

src/sysprof/sysprof-window.ui

@@ -40,16 +40,8 @@
                   </object>
                 </child>
                 <property name="content">
-                  <object class="GtkScrolledWindow">
-                    <property name="hscrollbar-policy">never</property>
-                    <property name="vexpand">true</property>
-                    <child>
-                      <object class="GtkListBox" id="list_box">
-                        <style>
-                          <class name="navigation-sidebar"/>
-                        </style>
-                      </object>
-                    </child>
+                  <object class="SysprofSidebar">
+                    <property name="stack">section_stack</property>
                   </object>
                 </property>
               </object>
@@ -94,7 +86,7 @@
                       </object>
                     </child>
                     <property name="content">
-                      <object class="GtkStack">
+                      <object class="GtkStack" id="section_stack">
                         <property name="vexpand">true</property>
                         <child>
                           <object class="SysprofSamplesSection">

src/sysprof/sysprof.gresource.xml

@@ -8,6 +8,7 @@
     <file preprocess="xml-stripblanks">sysprof-metadata-dialog.ui</file>
     <file preprocess="xml-stripblanks">sysprof-recording-pad.ui</file>
     <file preprocess="xml-stripblanks">sysprof-samples-section.ui</file>
+    <file preprocess="xml-stripblanks">sysprof-sidebar.ui</file>
     <file preprocess="xml-stripblanks">sysprof-window.ui</file>
   </gresource>
 </gresources>