[emerillon/gtk3] Steal Totem plugin macro and use it in Search plugin

[Andreas Henriksson <ah src gnome org>]

commit df41b59bc761d650b39aad5720606291c69786c2
Author: Andreas Henriksson <andreas fatal se>
Date:   Tue Aug 9 17:16:13 2011 +0200

    Steal Totem plugin macro and use it in Search plugin
    
    The totem plugin macro cuts down on needed boilerplate and should
    fix some runtime warnings about "object" property not implemented.

 cut-paste/totem-plugin.h |  179 ++++++++++++++++++++++++++++++++++++++++++++++
 plugins/Makefile.am      |    1 -
 plugins/search/search.c  |   61 ++++------------
 plugins/search/search.h  |   57 ---------------
 4 files changed, 192 insertions(+), 106 deletions(-)
---
diff --git a/cut-paste/totem-plugin.h b/cut-paste/totem-plugin.h
new file mode 100644
index 0000000..d8663d9
--- /dev/null
+++ b/cut-paste/totem-plugin.h
@@ -0,0 +1,179 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
+ *
+ * Plugin engine for Totem, heavily based on the code from Rhythmbox,
+ * which is based heavily on the code from totem.
+ *
+ * Copyright (C) 2002-2005 Paolo Maggi
+ *               2006 James Livingston  <jrl ids org au>
+ *               2007 Bastien Nocera <hadess hadess net>
+ *
+ * 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 2 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301  USA.
+ *
+ * Sunday 13th May 2007: Bastien Nocera: Add exception clause.
+ * See license_change file for details.
+ *
+ */
+
+#ifndef __TOTEM_PLUGIN_H__
+#define __TOTEM_PLUGIN_H__
+
+#include <libpeas/peas-extension-base.h>
+#include <libpeas/peas-object-module.h>
+#include <libpeas/peas-activatable.h>
+#include <libpeas-gtk/peas-gtk-configurable.h>
+
+G_BEGIN_DECLS
+
+/**
+ * TOTEM_PLUGIN_REGISTER:
+ * @TYPE_NAME: the name of the plugin type, in UPPER_CASE
+ * @TypeName: the name of the plugin type, in CamelCase
+ * @type_name: the name of the plugin type, in lower_case
+ * @TYPE_CODE: code to go in the fifth parameter to %G_DEFINE_DYNAMIC_TYPE_EXTENDED
+ * @REGISTER_CODE: code to go in the peas_register_types() exported function
+ *
+ * Registers a plugin with the Totem plugin system, including registering the type specified in the parameters and declaring its activate and
+ * deactivate functions.
+ **/
+#define _TOTEM_PLUGIN_REGISTER(TYPE_NAME, TypeName, type_name, TYPE_CODE, REGISTER_CODE)	\
+	typedef struct {							\
+		PeasExtensionBaseClass parent_class;				\
+	} TypeName##Class;							\
+	typedef struct {							\
+		PeasExtensionBase parent;					\
+		TypeName##Private *priv;					\
+	} TypeName;								\
+	GType type_name##_get_type (void) G_GNUC_CONST;				\
+	static void impl_activate (PeasActivatable *plugin);			\
+	static void impl_deactivate (PeasActivatable *plugin);			\
+	G_MODULE_EXPORT void peas_register_types (PeasObjectModule *module);	\
+	static void peas_activatable_iface_init (PeasActivatableInterface *iface); \
+	enum {									\
+		PROP_0,								\
+		PROP_OBJECT							\
+	};									\
+	G_DEFINE_DYNAMIC_TYPE_EXTENDED (TypeName,				\
+					type_name,				\
+					PEAS_TYPE_EXTENSION_BASE,		\
+					0,					\
+					G_IMPLEMENT_INTERFACE_DYNAMIC (PEAS_TYPE_ACTIVATABLE, \
+								       peas_activatable_iface_init) \
+					TYPE_CODE)				\
+	static void								\
+	peas_activatable_iface_init (PeasActivatableInterface *iface)		\
+	{									\
+		iface->activate = impl_activate;				\
+		iface->deactivate = impl_deactivate;				\
+	}									\
+	static void								\
+	set_property (GObject      *object,					\
+		      guint         prop_id,					\
+		      const GValue *value,					\
+		      GParamSpec   *pspec)					\
+	{									\
+		switch (prop_id) {						\
+		case PROP_OBJECT:						\
+			g_object_set_data_full (object, "object",		\
+						g_value_dup_object (value),	\
+						g_object_unref);		\
+			break;							\
+		default:							\
+			G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); \
+			break;							\
+		}								\
+	}									\
+	static void								\
+	get_property (GObject    *object,					\
+		      guint       prop_id,					\
+		      GValue     *value,					\
+		      GParamSpec *pspec)					\
+	{									\
+		switch (prop_id) {						\
+		case PROP_OBJECT:						\
+			g_value_set_object (value, g_object_get_data (object, "object")); \
+			break;							\
+		default:							\
+			G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); \
+			break;							\
+		}								\
+	}									\
+	static void								\
+	type_name##_class_init (TypeName##Class *klass)				\
+	{									\
+		GObjectClass *object_class = G_OBJECT_CLASS (klass);		\
+										\
+		object_class->set_property = set_property;			\
+		object_class->get_property = get_property;			\
+										\
+		g_object_class_override_property (object_class, PROP_OBJECT, "object"); \
+		g_type_class_add_private (klass, sizeof (TypeName##Private));	\
+	}									\
+	static void								\
+	type_name##_class_finalize (TypeName##Class *klass)			\
+	{									\
+	}									\
+	static void								\
+	type_name##_init (TypeName *plugin)					\
+	{									\
+		plugin->priv = G_TYPE_INSTANCE_GET_PRIVATE (plugin, TYPE_NAME, TypeName##Private); \
+	}									\
+	G_MODULE_EXPORT void							\
+	peas_register_types (PeasObjectModule *module)				\
+	{									\
+		type_name##_register_type (G_TYPE_MODULE (module));		\
+		peas_object_module_register_extension_type (module,		\
+							    PEAS_TYPE_ACTIVATABLE, \
+							    TYPE_NAME);		\
+		REGISTER_CODE							\
+	}
+
+/**
+ * TOTEM_PLUGIN_REGISTER:
+ * @TYPE_NAME: the name of the plugin type, in UPPER_CASE
+ * @TypeName: the name of the plugin type, in CamelCase
+ * @type_name: the name of the plugin type, in lower_case
+ *
+ * Registers a plugin with the Totem plugin system, including registering the type specified in the parameters and declaring its activate and
+ * deactivate functions.
+ **/
+#define TOTEM_PLUGIN_REGISTER(TYPE_NAME, TypeName, type_name)			\
+	_TOTEM_PLUGIN_REGISTER(TYPE_NAME, TypeName, type_name,,)
+
+/**
+ * TOTEM_PLUGIN_REGISTER_CONFIGURABLE:
+ * @TYPE_NAME: the name of the plugin type, in UPPER_CASE
+ * @TypeName: the name of the plugin type, in CamelCase
+ * @type_name: the name of the plugin type, in lower_case
+ *
+ * Registers a configurable plugin with the Totem plugin system, including registering the type specified in the parameters and declaring its activate
+ * and deactivate and widget creation functions.
+ **/
+#define TOTEM_PLUGIN_REGISTER_CONFIGURABLE(TYPE_NAME, TypeName, type_name)	\
+	static GtkWidget *impl_create_configure_widget (PeasGtkConfigurable *configurable); \
+	static void peas_gtk_configurable_iface_init (PeasGtkConfigurableInterface *iface); \
+	_TOTEM_PLUGIN_REGISTER(TYPE_NAME, TypeName, type_name,			\
+		(G_IMPLEMENT_INTERFACE_DYNAMIC (PEAS_GTK_TYPE_CONFIGURABLE, peas_gtk_configurable_iface_init)), \
+		peas_object_module_register_extension_type (module, PEAS_GTK_TYPE_CONFIGURABLE, TYPE_NAME);) \
+	static void								\
+	peas_gtk_configurable_iface_init (PeasGtkConfigurableInterface *iface)	\
+	{									\
+		iface->create_configure_widget = impl_create_configure_widget;	\
+	}
+
+G_END_DECLS
+
+#endif  /* __TOTEM_PLUGIN_H__ */
+
diff --git a/plugins/Makefile.am b/plugins/Makefile.am
index cd4c7da..8dc985a 100755
--- a/plugins/Makefile.am
+++ b/plugins/Makefile.am
@@ -71,7 +71,6 @@ plugins_in_files += \
 	search/search.plugin.in
 
 search_libsearch_la_SOURCES = \
-	search/search.h  \
 	search/search.c
 
 search_libsearch_la_LIBADD = \
diff --git a/plugins/search/search.c b/plugins/search/search.c
index f3b3e1e..401fae1 100644
--- a/plugins/search/search.c
+++ b/plugins/search/search.c
@@ -18,7 +18,7 @@
  */
 
 #include "config.h"
-#include "search.h"
+#include "cut-paste/totem-plugin.h"
 #include "emerillon/emerillon.h"
 
 #include <locale.h>
@@ -27,13 +27,12 @@
 #include <rest/rest-proxy-call.h>
 #include <rest/rest-xml-parser.h>
 
-static void
-peas_activatable_iface_init (PeasActivatableInterface *iface);
-
-G_DEFINE_DYNAMIC_TYPE_EXTENDED (SearchPlugin, search_plugin, PEAS_TYPE_EXTENSION_BASE,
-                                0,
-                                G_IMPLEMENT_INTERFACE_DYNAMIC (PEAS_TYPE_ACTIVATABLE,
-                                                               peas_activatable_iface_init));
+#define SEARCH_TYPE_PLUGIN            (search_plugin_get_type())
+#define SEARCH_PLUGIN(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), SEARCH_TYPE_PLUGIN, SearchPlugin))
+#define SEARCH_PLUGIN_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),  SEARCH_TYPE_PLUGIN, SearchPluginClass))
+#define SEARCH_IS_PLUGIN(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SEARCH_TYPE_PLUGIN))
+#define SEARCH_IS_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass),  SEARCH_TYPE_PLUGIN))
+#define SEARCH_PLUGIN_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),  SEARCH_TYPE_PLUGIN, SearchPluginClass))
 
 enum {
   COL_ORDER,
@@ -46,7 +45,7 @@ enum {
   COL_COUNT
 };
 
-struct _SearchPluginPrivate
+typedef struct
 {
   GtkWidget *search_entry;
   GtkWidget *search_page;
@@ -59,7 +58,9 @@ struct _SearchPluginPrivate
 
   ChamplainView *map_view;
   ChamplainMarkerLayer *layer;
-};
+} SearchPluginPrivate;
+
+TOTEM_PLUGIN_REGISTER (SEARCH_TYPE_PLUGIN, SearchPlugin, search_plugin);
 
 static void
 present_sidebar (SearchPlugin *plugin)
@@ -368,7 +369,7 @@ select_function_cb (GtkTreeSelection *selection,
 }
 
 static void
-search_plugin_activate (PeasActivatable *plugin)
+impl_activate (PeasActivatable *plugin)
 {
   GtkWidget *window, *toolbar, *sidebar, *scrolled;
   gint count = 0;
@@ -489,7 +490,7 @@ search_plugin_activate (PeasActivatable *plugin)
 }
 
 static void
-search_plugin_deactivate (PeasActivatable *plugin)
+impl_deactivate (PeasActivatable *plugin)
 {
   GtkWidget *window, *toolbar, *sidebar;
   ChamplainView *view;
@@ -527,39 +528,3 @@ search_plugin_deactivate (PeasActivatable *plugin)
   g_object_unref (window);
 }
 
-static void
-search_plugin_class_init (SearchPluginClass *klass)
-{
-  g_type_class_add_private (klass, sizeof (SearchPluginPrivate));
-}
-
-static void
-search_plugin_class_finalize(SearchPluginClass *klass)
-{
-
-}
-
-static void
-search_plugin_init (SearchPlugin *plugin)
-{
-  plugin->priv = G_TYPE_INSTANCE_GET_PRIVATE (plugin,
-                                              SEARCH_TYPE_PLUGIN,
-                                              SearchPluginPrivate);
-}
-
-static void
-peas_activatable_iface_init (PeasActivatableInterface *iface)
-{
-  iface->activate = search_plugin_activate;
-  iface->deactivate = search_plugin_deactivate;
-}
-
-G_MODULE_EXPORT void
-peas_register_types (PeasObjectModule *module)
-{
-  search_plugin_register_type (G_TYPE_MODULE (module));
-
-  peas_object_module_register_extension_type (module,
-                                              PEAS_TYPE_ACTIVATABLE,
-                                              SEARCH_TYPE_PLUGIN);
-}