Merge lp:~tombeckmann/pantheon-plugs/gcc-get-toplevel-fix into lp:~elementary-apps/pantheon-plugs/dynamic-gcc-plug-freya

[Tom Beckmann]

Fix crash when cc_shell_get_toplevel is called from a panel.
Put embedded widgets in an actionbar.

This fixes https://bugs.launchpad.net/switchboard/+bug/1305618 by implementing a shell object properly. We should check if there is value in implementing cc_shell_embed_widget_in_header too, it is apparently called by panels, but I haven't checked yet what they try to embed.

[Tom Beckmann (tombeckmann)]

Checked it now, we should definitely implement it. There are two panels using the function. The network one provides its airplane mode via this function and the mouse one its test area.

[lp:~tombeckmann/pantheon-plugs/gcc-get-toplevel-fix]

45. By Tom Beckmann on 2014-07-06

make things work when a plug is opened a second time, implement embed_widget

46. By Tom Beckmann on 2014-07-07

some cleanup

47. By Tom Beckmann on 2014-07-07

put embedded widgets in an actionbar instead of the header

48. By Tom Beckmann on 2014-07-07

get toplevel via our panel instance

[Tom Beckmann (tombeckmann)]

This branch no longer requires API changes in switchboard, it gets all the necessary data itself and embeds widgets in an action bar at the bottom.
I hope it can be accepted now.

[Corentin Noël (tintou)]

This branch is really a nice fix!
While I'm not a C expert, all what I see here is fine. Great work!

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2014-04-24 22:26:52 +0000
+++ CMakeLists.txt	2014-07-07 22:24:10 +0000
@@ -34,6 +34,7 @@
 set (VALAC_MAIN_OPTIONS
     --thread
     --vapidir=${CMAKE_SOURCE_DIR}/vapi
+    --pkg SwitchboardShell
 )
 
 set (DEPS_PACKAGES
@@ -50,6 +51,7 @@
     granite
     gnome-desktop-3.0
     libgnome-control-center
+    switchboard-2.0
 )
 
 # Add all your dependencies to the list below
@@ -70,10 +72,11 @@
 install (FILES ${desktops} DESTINATION "${CMAKE_INSTALL_FULL_DATAROOTDIR}/applications")
 
 set (C_FILES
-    ${CMAKE_CURRENT_SOURCE_DIR}/libgnome-control-center/cc-gnome_cc-panel.c)
+    ${CMAKE_CURRENT_SOURCE_DIR}/libgnome-control-center/cc-gnome_cc-panel.c
+    ${CMAKE_CURRENT_SOURCE_DIR}/libgnome-control-center/switchboard-shell.c)
 
 # Traslation stuff
 add_subdirectory (po)
 
 # Plugs
-add_subdirectory(plugs)
\ No newline at end of file
+add_subdirectory(plugs)

=== modified file 'libgnome-control-center/cc-gnome_cc-panel.c'
--- libgnome-control-center/cc-gnome_cc-panel.c	2014-01-14 16:26:18 +0000
+++ libgnome-control-center/cc-gnome_cc-panel.c	2014-07-07 22:24:10 +0000
@@ -24,6 +24,7 @@
 #include <stdlib.h>
 #include <sys/wait.h>
 
+#include "switchboard-shell.h"
 #include "cc-gnome_cc-panel.h"
 #include <libgnome-control-center/cc-shell.h>
 
@@ -38,6 +39,8 @@
 struct _CcGnomeCCPanelPrivate
 {
     GIOExtensionPoint* extension_point;
+
+    SwitchboardShell *shell;
 };
 
 typedef struct
@@ -127,7 +130,10 @@
 static void
 cc_gnome_cc_panel_init (CcGnomeCCPanel *self)
 {
+  self->priv = GNOME_CC_PANEL_PRIVATE (self);
+  self->priv->shell = g_object_ref (switchboard_shell_new ());
 }
+
 gchar* gccname;
 static GObject *
 cc_gnome_cc_panel_constructor (GType                  gtype,
@@ -136,7 +142,7 @@
 {
   GObjectClass* obj = G_OBJECT_CLASS (cc_gnome_cc_panel_parent_class)->constructor (gtype, n_properties, properties);
   CcGnomeCCPanel* self = CC_GNOME_CC_PANEL (obj);
-  self->priv = GNOME_CC_PANEL_PRIVATE (self);
+
     g_type_from_name ("CcPanel");
     self->priv->extension_point = g_io_extension_point_register (BUILD_CC_SHELL_PANEL_EXTENSION_POINT);
     GList* l;
@@ -166,7 +172,7 @@
           GtkWidget *panel;
 
           /* create the panel plugin */
-          panel = g_object_new (panel_type, NULL);//, "shell", self, NULL);
+          panel = g_object_new (panel_type, "shell", self->priv->shell, NULL);
           
           gtk_container_add(self, panel);
         }

=== added file 'libgnome-control-center/switchboard-shell.c'
--- libgnome-control-center/switchboard-shell.c	1970-01-01 00:00:00 +0000
+++ libgnome-control-center/switchboard-shell.c	2014-07-07 22:24:10 +0000
@@ -0,0 +1,136 @@
+//
+//  Copyright (C) 2014 Tom Beckmann
+//
+//  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/>.
+//
+
+#include "switchboard-shell.h"
+
+G_DEFINE_TYPE (SwitchboardShell, switchboard_shell, CC_TYPE_SHELL)
+
+static void
+_shell_set_active_panel_from_id (CcShell *shell, const gchar **start_id,
+	const gchar **argv, GError **error)
+{
+	// FIXME do we need this?
+}
+
+static void
+_shell_embed_widget_in_header (CcShell *shell, GtkWidget *widget)
+{
+	g_signal_emit_by_name (shell, "embed-widget-requested", widget);
+}
+
+static GtkWidget *
+_shell_get_toplevel (CcShell *shell)
+{
+	GtkWidget *toplevel;
+
+	g_signal_emit_by_name (shell, "get-toplevel-requested", &toplevel);
+	if (!toplevel)
+		g_critical ("plug did not connect to get-toplevel-requested signal, may cause a crash");
+
+	return toplevel;
+}
+
+static void
+switchboard_shell_get_property (GObject *object,
+                                guint property_id,
+                                GValue *value,
+                                GParamSpec *pspec)
+{
+	SwitchboardShellPrivate *priv = SWITCHBOARD_SHELL (object)->priv;
+
+	switch (property_id) {
+		default:
+			G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+	}
+}
+
+static void
+switchboard_shell_set_property (GObject      *object,
+                                guint         property_id,
+                                const GValue *value,
+                                GParamSpec   *pspec)
+{
+	SwitchboardShellPrivate *priv = SWITCHBOARD_SHELL (object)->priv;
+
+	switch (property_id) {
+		default:
+			G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+	}
+}
+
+static void
+switchboard_shell_dispose (GObject *object)
+{
+	SwitchboardShellPrivate *priv = SWITCHBOARD_SHELL (object)->priv;
+
+	G_OBJECT_CLASS (switchboard_shell_parent_class)->dispose (object);
+}
+
+static void
+switchboard_shell_finalize (GObject *object)
+{
+	SwitchboardShellPrivate *priv = SWITCHBOARD_SHELL (object)->priv;
+
+	G_OBJECT_CLASS (switchboard_shell_parent_class)->finalize (object);
+}
+
+
+static void
+switchboard_shell_class_init (SwitchboardShellClass *klass)
+{
+	GParamSpec *pspec;
+
+	GObjectClass *object_class = G_OBJECT_CLASS (klass);
+	CcShellClass *shell_class = CC_SHELL_CLASS (klass);
+
+	object_class->get_property = switchboard_shell_get_property;
+	object_class->set_property = switchboard_shell_set_property;
+	object_class->dispose = switchboard_shell_dispose;
+	object_class->finalize = switchboard_shell_finalize;
+
+	shell_class->set_active_panel_from_id = _shell_set_active_panel_from_id;
+	shell_class->embed_widget_in_header = _shell_embed_widget_in_header;
+	shell_class->get_toplevel = _shell_get_toplevel;
+
+	g_signal_new ("embed-widget-requested",
+	              G_TYPE_FROM_CLASS (klass),
+	              G_SIGNAL_RUN_LAST,
+	              0,
+	              NULL, NULL, NULL,
+	              G_TYPE_NONE,
+		      1, GTK_TYPE_WIDGET);
+
+	g_signal_new ("get-toplevel-requested",
+	              G_TYPE_FROM_CLASS (klass),
+	              G_SIGNAL_RUN_LAST,
+	              0,
+	              NULL, NULL, NULL,
+	              GTK_TYPE_WIDGET,
+		      0);
+}
+
+static void
+switchboard_shell_init (SwitchboardShell *self)
+{
+}
+
+SwitchboardShell *
+switchboard_shell_new ()
+{
+	return g_object_new (SWITCHBOARD_TYPE_SHELL, NULL);
+}
+

=== added file 'libgnome-control-center/switchboard-shell.h'
--- libgnome-control-center/switchboard-shell.h	1970-01-01 00:00:00 +0000
+++ libgnome-control-center/switchboard-shell.h	2014-07-07 22:24:10 +0000
@@ -0,0 +1,61 @@
+//
+//  Copyright (C) 2014 Tom Beckmann
+//
+//  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/>.
+//
+
+#ifndef __SWITCHBOARD_SHELL_H__
+#define __SWITCHBOARD_SHELL_H__
+
+#include <glib-object.h>
+#include <libgnome-control-center/cc-shell.h>
+#include <switchboard.h>
+
+G_BEGIN_DECLS
+
+#define SWITCHBOARD_TYPE_SHELL switchboard_shell_get_type()
+#define SWITCHBOARD_SHELL(obj) \
+	G_TYPE_CHECK_INSTANCE_CAST((obj), SWITCHBOARD_TYPE_SHELL, SwitchboardShell)
+#define SWITCHBOARD_IS_SHELL(obj) \
+	(G_TYPE_CHECK_INSTANCE_TYPE((obj), SWITCHBOARD_TYPE_SHELL))
+
+#define SWITCHBOARD_IS_SHELL_CLASS(klass) \
+	(G_TYPE_CHECK_CLASS_TYPE((klass), SWITCHBOARD_TYPE_SHELL))
+
+#define SWITCHBOARD_SHELL_GET_CLASS(obj) \
+	(G_TYPE_INSTANCE_GET_CLASS((obj), SWITCHBOARD_TYPE_SHELL, SwitchboardShellClass))
+
+typedef struct _SwitchboardShell SwitchboardShell;
+typedef struct _SwitchboardShellClass SwitchboardShellClass;
+typedef struct _SwitchboardShellPrivate SwitchboardShellPrivate;
+
+struct _SwitchboardShell
+{
+	CcShell parent;
+
+	SwitchboardShellPrivate *priv;
+};
+
+struct _SwitchboardShellClass
+{
+	CcShellClass parent_class;
+};
+
+GType switchboard_shell_get_type (void) G_GNUC_CONST;
+
+SwitchboardShell *switchboard_shell_new ();
+
+G_END_DECLS
+
+#endif // __SWITCHBOARD_SHELL_H__

=== modified file 'plugs/Mouse/MousePlug.vala'
--- plugs/Mouse/MousePlug.vala	2014-04-14 17:14:38 +0000
+++ plugs/Mouse/MousePlug.vala	2014-07-07 22:24:10 +0000
@@ -25,6 +25,9 @@
     private Cc.Panel panel;
     private Gtk.Grid main_grid;
     private Gtk.InfoBar infobar;
+    private Gtk.ActionBar action_bar;
+
+    SwitchboardShell shell;
 
     public Plug () {
         Object (category: Category.HARDWARE,
@@ -32,6 +35,9 @@
                 display_name: GLib.dgettext ("gnome-control-center-2.0", "Mouse & Touchpad"),
                 description: GLib.dgettext ("gnome-control-center-2.0", "Set your mouse and touchpad preferences"),
                 icon: "preferences-desktop-peripherals");
+
+        shell = new SwitchboardShell ();
+        shell.embed_widget_requested.connect (embed_widget);
     }
 
     public override Gtk.Widget get_widget () {
@@ -45,12 +51,16 @@
     public override void shown () {
         gccname = "mouse";
         GLib.Intl.textdomain ("gnome-control-center-2.0");
+
         if (GLib.Type.from_name ("CcMousePanel") == 0) {
             panel = Object.new(typeof(Cc.GnomeCCPanel)) as Cc.Panel;
+            var shell = ((Cc.Panel) panel.get_children ().data).get_shell () as SwitchboardShell;
+            shell.embed_widget_requested.connect (embed_widget);
         } else {
-            panel = Object.new(GLib.Type.from_name ("CcMousePanel")) as Cc.Panel;
+            panel = Object.new(GLib.Type.from_name ("CcMousePanel"), "shell", shell.@ref (), null) as Cc.Panel;
         }
         panel.expand = true;
+
         var permission = panel.get_permission();
         if(permission != null) {
             infobar = new Gtk.InfoBar ();
@@ -66,8 +76,18 @@
                 infobar.no_show_all = true;
             }
         }
+
+        action_bar = new Gtk.ActionBar ();
+
         main_grid.attach (panel, 0, 1, 1, 1);
         main_grid.show_all ();
+        main_grid.attach (action_bar, 0, 2, 1, 1);
+    }
+
+    void embed_widget (Gtk.Widget widget) {
+        widget.margin_top = widget.margin_bottom = 6;
+        action_bar.pack_end (widget);
+        action_bar.show_all ();
     }
 
     public override void hidden () {
@@ -92,4 +112,4 @@
     debug ("Activating Mouse plug");
     var plug = new GCC.Mouse.Plug ();
     return plug;
-}
\ No newline at end of file
+}

=== modified file 'plugs/Network/NetworkPlug.vala'
--- plugs/Network/NetworkPlug.vala	2014-04-14 17:14:38 +0000
+++ plugs/Network/NetworkPlug.vala	2014-07-07 22:24:10 +0000
@@ -25,6 +25,9 @@
     private Gtk.Grid main_grid;
     private Cc.Panel panel;
     private Gtk.InfoBar infobar;
+    private Gtk.ActionBar action_bar;
+
+    SwitchboardShell shell;
 
     public Plug () {
         Object (category: Category.NETWORK,
@@ -32,6 +35,10 @@
                 display_name: GLib.dgettext ("gnome-control-center-2.0", "Network"),
                 description: GLib.dgettext ("gnome-control-center-2.0", "Network settings"),
                 icon: "preferences-system-network");
+
+        shell = new SwitchboardShell ();
+        shell.embed_widget_requested.connect (embed_widget);
+        shell.get_toplevel_requested.connect (() => panel.get_toplevel ());
     }
 
     public override Gtk.Widget get_widget () {
@@ -45,12 +52,17 @@
     public override void shown () {
         gccname = "network";
         GLib.Intl.textdomain ("gnome-control-center-2.0");
+
         if (GLib.Type.from_name ("CcNetworkPanel") == 0) {
             panel = Object.new(typeof(Cc.GnomeCCPanel)) as Cc.Panel;
+            var shell = (SwitchboardShell) ((Cc.Panel) panel.get_children ().data).get_shell ();
+            shell.embed_widget_requested.connect (embed_widget);
+            shell.get_toplevel_requested.connect (() => panel.get_toplevel ());
         } else {
-            panel = Object.new(GLib.Type.from_name ("CcNetworkPanel")) as Cc.Panel;
+            panel = Object.new(GLib.Type.from_name ("CcNetworkPanel"), "shell", shell.@ref (), null) as Cc.Panel;
         }
         panel.expand = true;
+
         var permission = panel.get_permission();
         if(permission != null) {
             infobar = new Gtk.InfoBar ();
@@ -66,8 +78,18 @@
                 infobar.no_show_all = true;
             }
         }
+
+        action_bar = new Gtk.ActionBar ();
+
         main_grid.attach (panel, 0, 1, 1, 1);
         main_grid.show_all ();
+        main_grid.attach (action_bar, 0, 2, 1, 1);
+    }
+
+    void embed_widget (Gtk.Widget widget) {
+        widget.margin_top = widget.margin_bottom = 6;
+        action_bar.pack_end (widget);
+        action_bar.show_all ();
     }
 
     public override void hidden () {
@@ -92,4 +114,4 @@
     debug ("Activating Network plug");
     var plug = new GCC.Network.Plug ();
     return plug;
-}
\ No newline at end of file
+}

=== added file 'vapi/SwitchboardShell.vapi'
--- vapi/SwitchboardShell.vapi	1970-01-01 00:00:00 +0000
+++ vapi/SwitchboardShell.vapi	2014-07-07 22:24:10 +0000
@@ -0,0 +1,9 @@
+
+[CCode (cheader_filename = "switchboard-shell.h", type_id = "switchboard_shell_get_type ()")]
+public class SwitchboardShell : Cc.Shell
+{
+	public SwitchboardShell ();
+	public signal void embed_widget_requested (Gtk.Widget widget);
+	public signal void get_toplevel_requested ();
+}
+