Add initial stubs to support the com.canonical.Unity.LauncherEntry DBus API in Unity

(bzr r798.5.1)

4 files changed, 242 insertions, 0 deletions

diff --git a/src/LauncherEntryRemote.cpp b/src/LauncherEntryRemote.cpp
new file mode 100644
index 000000000..db92ea840
--- /dev/null
+++ b/src/LauncherEntryRemote.cpp
@@ -0,0 +1,30 @@
+// -*- Mode: C++; indent-tabs-mode: nil; tab-width: 2 -*-
+/*
+ * Copyright (C) 2011 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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/>.
+ *
+ * Authored by: Mikkel Kamstrup Erlandsen <mikkel.kamstrup@canonical.com>
+ */
+
+#include "LauncherEntryRemote.h"
+
+LauncherEntryRemote::LauncherEntryRemote()
+{
+ 
+}
+
+LauncherEntryRemote::~LauncherEntryRemote()
+{
+ 
+}
diff --git a/src/LauncherEntryRemote.h b/src/LauncherEntryRemote.h
new file mode 100644
index 000000000..5f8663fa5
--- /dev/null
+++ b/src/LauncherEntryRemote.h
@@ -0,0 +1,40 @@
+// -*- Mode: C++; indent-tabs-mode: nil; tab-width: 2 -*-
+/*
+ * Copyright (C) 2011 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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/>.
+ *
+ * Authored by: Mikkel Kamstrup Erlandsen <mikkel.kamstrup@canonical.com>
+ */
+
+#ifndef LAUNCHER_ENTRY_REMOTE_H
+#define LAUNCHER_ENTRY_REMOTE_H
+
+#include <glib.h>
+#include <sigc++/sigc++.h>
+
+class LauncherEntryRemote : public sigc::trackable
+{
+
+public:
+ LauncherEntryRemote();
+ ~LauncherEntryRemote();
+
+private:
+ GDBusConnection *conn;
+ guint launcher_entry_dbus_signal_id;
+
+ void OnUpdateReceived (GVariant *params);
+};
+
+#endif // LAUNCHER_ENTRY_REMOTE_H
diff --git a/src/LauncherEntryRemoteController.cpp b/src/LauncherEntryRemoteController.cpp
new file mode 100644
index 000000000..6460f73b8
--- /dev/null
+++ b/src/LauncherEntryRemoteController.cpp
@@ -0,0 +1,132 @@
+// -*- Mode: C++; indent-tabs-mode: nil; tab-width: 2 -*-
+/*
+ * Copyright (C) 2011 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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/>.
+ *
+ * Authored by: Mikkel Kamstrup Erlandsen <mikkel.kamstrup@canonical.com>
+ */
+
+#include "LauncherEntryRemoteController.h"
+
+static void on_launcher_entry_signal_received (GDBusConnection *connection,
+ const gchar *sender_name,
+ const gchar *object_path,
+ const gchar *interface_name,
+ const gchar *signal_name,
+ GVariant *parameters,
+ gpointer user_data);
+
+/**
+ * Helper class implementing the remote API to control the icons in the
+ * launcher. Also known as the com.canonical.Unity.LauncherEntry DBus API.
+ * It enables clients to dynamically control their launcher icons by
+ * adding a counter, progress indicator, or emblem to it. It also supports
+ * adding a quicklist menu by means of the dbusmenu library.
+ *
+ * We take care to print out any client side errors or oddities in detail,
+ * in order to help third party developers as much as possible when integrating
+ * with Unity.
+ */
+LauncherEntryRemoteController::LauncherEntryRemoteController()
+{
+ GError *error;
+
+ if (controller == NULL)
+ {
+ controller = new auncherEntryRemoteController();
+ }
+
+ launcher_entry_dbus_signal_id = 0;
+
+ error = NULL;
+ conn = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, &error);
+ if (error)
+ {
+ g_warning ("Unable to connect to session bus: %s", error->message);
+ g_error_free (error);
+ return;
+ }
+ 
+ /* Listen for *all* signals on the "com.canonical.Unity.LauncherEntry"
+ * interface, no matter who the sender is */
+ launcher_entry_dbus_signal_id =
+ g_dbus_connection_signal_subscribe (conn,
+ NULL, // sender
+ "com.canonical.Unity.LauncherEntry",
+ NULL, // member
+ NULL, // path
+ NULL, // arg0
+ G_DBUS_SIGNAL_FLAGS_NONE,
+ on_launcher_entry_signal_received,
+ this,
+ NULL);
+}
+
+LauncherEntryRemoteController::~LauncherEntryRemoteController()
+{
+ if (launcher_entry_dbus_signal_id && conn)
+ g_dbus_connection_signal_unsubscribe (conn, launcher_entry_dbus_signal_id);
+ 
+ if (conn)
+ g_object_unref (conn);
+}
+
+/* Called with raw DBus params when the signal
+ * "com.canonical.Unity.LauncherEntry.Update" is received.
+ * The GVariant params should not be unreffed */
+LauncherEntryRemoteController::OnUpdateReceived (GVariant *params)
+{
+ g_return_if_fail (params != NULL);
+
+ if (!g_variant_is_of_type (params, G_VARIANT_TYPE ("(sa{sv})")))
+ {
+ g_warning ("Received 'com.canonical.Unity.LauncherEntry.Update' with"
+ " illegal payload signature '%s'. Expected '(sa{sv})'.",
+ g_variant_get_type_string (params));
+ return;
+ }
+
+
+}
+
+static void
+on_launcher_entry_signal_received (GDBusConnection *connection,
+ const gchar *sender_name,
+ const gchar *object_path,
+ const gchar *interface_name,
+ const gchar *signal_name,
+ GVariant *parameters,
+ gpointer user_data)
+{
+ LauncherEntryRemote *self;
+
+ self = static_cast<LauncherEntryRemoteController *> (user_data);
+
+ if (params == NULL)
+ {
+ g_warning ("Received DBus signal '%.%s' with empty payload from %s",
+ interface_name, signal_name, sender_name);
+ return;
+ }
+
+ if (g_strcmp0 (signal_name, "Update") == 0)
+ {
+ self->OnUpdateReceived (paramters);
+ }
+
+ /* It's an undocumented fact that GDBus passes a full ref on the
+ * paramters back to the signal handler. So free the params */
+ if (parameters != NULL)
+ g_variant_unref (parameters);
+}
diff --git a/src/LauncherEntryRemoteController.h b/src/LauncherEntryRemoteController.h
new file mode 100644
index 000000000..a5194a4ef
--- /dev/null
+++ b/src/LauncherEntryRemoteController.h
@@ -0,0 +1,40 @@
+// -*- Mode: C++; indent-tabs-mode: nil; tab-width: 2 -*-
+/*
+ * Copyright (C) 2011 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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/>.
+ *
+ * Authored by: Mikkel Kamstrup Erlandsen <mikkel.kamstrup@canonical.com>
+ */
+
+#ifndef LAUNCHER_ENTRY_REMOTE_CONTROLLER_H
+#define LAUNCHER_ENTRY_REMOTE_CONTROLLER_H
+
+#include <glib.h>
+#include <sigc++/sigc++.h>
+
+class LauncherEntryRemote : public sigc::trackable
+{
+
+public:
+ LauncherEntryRemoteController();
+ ~LauncherEntryRemoteController();
+
+private:
+ GDBusConnection *conn;
+ guint launcher_entry_dbus_signal_id;
+
+ void OnUpdateReceived (GVariant *params);
+};
+
+#endif // LAUNCHER_ENTRY_REMOTE_CONTROLLER_H