diff options
author | Matthew Barnes <mbarnes@redhat.com> | 2011-09-10 23:47:15 +0800 |
---|---|---|
committer | Matthew Barnes <mbarnes@redhat.com> | 2011-09-26 21:45:55 +0800 |
commit | 53bc6ffc531d7a7188e15be245a31f301090ee15 (patch) | |
tree | 20787089c9f1cc09986ca0ea8f23ba0cad81462b /e-util | |
parent | 6aa953cdf3ce6dbdb38be3942213d015eb01d4b0 (diff) | |
download | gsoc2013-evolution-53bc6ffc531d7a7188e15be245a31f301090ee15.tar.gz gsoc2013-evolution-53bc6ffc531d7a7188e15be245a31f301090ee15.tar.zst gsoc2013-evolution-53bc6ffc531d7a7188e15be245a31f301090ee15.zip |
The EExtension framework is now in libebackend.
The EModule, EExtensible and EExtension classes as well as the
e_type_traverse() function have been moved to Evolution-Data-Server's
libebackend library to replace e-data-server-module.c.
Now Evolution-Data-Server modules use the same framework as Evolution.
Diffstat (limited to 'e-util')
-rw-r--r-- | e-util/Makefile.am | 6 | ||||
-rw-r--r-- | e-util/e-extensible.c | 186 | ||||
-rw-r--r-- | e-util/e-extensible.h | 59 | ||||
-rw-r--r-- | e-util/e-extension.c | 186 | ||||
-rw-r--r-- | e-util/e-extension.h | 72 | ||||
-rw-r--r-- | e-util/e-module.c | 320 | ||||
-rw-r--r-- | e-util/e-module.h | 75 | ||||
-rw-r--r-- | e-util/e-plugin.c | 2 | ||||
-rw-r--r-- | e-util/e-util.c | 41 | ||||
-rw-r--r-- | e-util/e-util.h | 3 |
10 files changed, 1 insertions, 949 deletions
diff --git a/e-util/Makefile.am b/e-util/Makefile.am index 53614e3b06..42fda2d9dd 100644 --- a/e-util/Makefile.am +++ b/e-util/Makefile.am @@ -31,15 +31,12 @@ eutilinclude_HEADERS = \ e-dialog-utils.h \ e-dialog-widgets.h \ e-event.h \ - e-extensible.h \ - e-extension.h \ e-file-utils.h \ e-html-utils.h \ e-icon-factory.h \ e-import.h \ e-marshal.h \ e-mktemp.h \ - e-module.h \ e-poolv.h \ e-print.h \ e-plugin.h \ @@ -106,15 +103,12 @@ libeutil_la_SOURCES = \ e-dialog-utils.c \ e-dialog-widgets.c \ e-event.c \ - e-extensible.c \ - e-extension.c \ e-file-utils.c \ e-html-utils.c \ e-icon-factory.c \ e-import.c \ e-marshal.c \ e-mktemp.c \ - e-module.c \ e-poolv.c \ e-plugin.c \ e-plugin-ui.c \ diff --git a/e-util/e-extensible.c b/e-util/e-extensible.c deleted file mode 100644 index a7523deb21..0000000000 --- a/e-util/e-extensible.c +++ /dev/null @@ -1,186 +0,0 @@ -/* - * e-extensible.c - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2 of the License, or (at your option) version 3. - * - * 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with the program; if not, see <http://www.gnu.org/licenses/> - * - */ - -/** - * SECTION: e-extensible - * @short_description: an interface for extending objects - * @include: e-util/e-extensible.h - * - * #EExtension objects can be tacked on to any #GObject instance that - * implements the #EExtensible interface. A #GObject type can be made - * extensible in two steps: - * - * 1. Add the #EExtensible interface when registering the #GType. - * There are no methods to implement. - * - * <informalexample> - * <programlisting> - * #include <e-util/e-extensible.h> - * - * G_DEFINE_TYPE_WITH_CODE ( - * ECustomWidget, e_custom_widget, GTK_TYPE_WIDGET, - * G_IMPLEMENT_INTERFACE (E_TYPE_EXTENSIBLE, NULL)) - * </programlisting> - * </informalexample> - * - * 2. Load extensions for the class at some point during #GObject - * initialization. Generally this should be done toward the end of - * the initialization code, so extensions get a fully initialized - * object to work with. - * - * <informalexample> - * <programlisting> - * static void - * e_custom_widget_init (ECustomWidget *widget) - * { - * Initialization code goes here... - * - * e_extensible_load_extensions (E_EXTENSIBLE (widget)); - * } - * </programlisting> - * </informalexample> - **/ - -#ifdef HAVE_CONFIG_H -#include <config.h> -#endif - -#include "e-extensible.h" - -#include <e-util/e-util.h> -#include <e-util/e-extension.h> - -#define IS_AN_EXTENSION_TYPE(type) \ - (g_type_is_a ((type), E_TYPE_EXTENSION)) - -static GQuark extensible_quark; - -G_DEFINE_INTERFACE ( - EExtensible, - e_extensible, - G_TYPE_OBJECT) - -static GPtrArray * -extensible_get_extensions (EExtensible *extensible) -{ - return g_object_get_qdata (G_OBJECT (extensible), extensible_quark); -} - -static void -extensible_load_extension (GType extension_type, - EExtensible *extensible) -{ - EExtensionClass *extension_class; - GType extensible_type; - GPtrArray *extensions; - EExtension *extension; - - extensible_type = G_OBJECT_TYPE (extensible); - extension_class = g_type_class_ref (extension_type); - - /* Only load extensions that extend the given extensible object. */ - if (!g_type_is_a (extensible_type, extension_class->extensible_type)) - goto exit; - - extension = g_object_new ( - extension_type, "extensible", extensible, NULL); - - extensions = extensible_get_extensions (extensible); - g_ptr_array_add (extensions, extension); - -exit: - g_type_class_unref (extension_class); -} - -static void -e_extensible_default_init (EExtensibleInterface *interface) -{ - extensible_quark = g_quark_from_static_string ("e-extensible-quark"); -} - -/** - * e_extensible_load_extensions: - * @extensible: an #EExtensible - * - * Creates an instance of all instantiable subtypes of #EExtension which - * target the class of @extensible. The lifetimes of these newly created - * #EExtension objects are bound to @extensible such that they are finalized - * when @extensible is finalized. - **/ -void -e_extensible_load_extensions (EExtensible *extensible) -{ - GPtrArray *extensions; - - g_return_if_fail (E_IS_EXTENSIBLE (extensible)); - - if (extensible_get_extensions (extensible) != NULL) - return; - - extensions = g_ptr_array_new_with_free_func ( - (GDestroyNotify) g_object_unref); - - g_object_set_qdata_full ( - G_OBJECT (extensible), extensible_quark, - extensions, (GDestroyNotify) g_ptr_array_unref); - - e_type_traverse ( - E_TYPE_EXTENSION, (ETypeFunc) - extensible_load_extension, extensible); -} - -/** - * e_extensible_list_extensions: - * @extensible: an #EExtensible - * @extension_type: the type of extensions to list - * - * Returns a list of #EExtension objects bound to @extensible whose - * types are ancestors of @extension_type. For a complete list of - * extension objects bound to @extensible, pass %E_TYPE_EXTENSION. - * - * The list itself should be freed with g_list_free(). The extension - * objects are owned by @extensible and should not be unreferenced. - * - * Returns: a list of extension objects derived from @extension_type - **/ -GList * -e_extensible_list_extensions (EExtensible *extensible, - GType extension_type) -{ - GPtrArray *extensions; - GList *list = NULL; - guint ii; - - g_return_val_if_fail (E_IS_EXTENSIBLE (extensible), NULL); - g_return_val_if_fail (IS_AN_EXTENSION_TYPE (extension_type), NULL); - - e_extensible_load_extensions (extensible); - - extensions = extensible_get_extensions (extensible); - g_return_val_if_fail (extensions != NULL, NULL); - - for (ii = 0; ii < extensions->len; ii++) { - GObject *object; - - object = g_ptr_array_index (extensions, ii); - if (g_type_is_a (G_OBJECT_TYPE (object), extension_type)) - list = g_list_prepend (list, object); - } - - return g_list_reverse (list); -} diff --git a/e-util/e-extensible.h b/e-util/e-extensible.h deleted file mode 100644 index 6dd6294212..0000000000 --- a/e-util/e-extensible.h +++ /dev/null @@ -1,59 +0,0 @@ -/* - * e-extensible.h - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2 of the License, or (at your option) version 3. - * - * 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with the program; if not, see <http://www.gnu.org/licenses/> - * - */ - -#ifndef E_EXTENSIBLE_H -#define E_EXTENSIBLE_H - -#include <glib-object.h> - -/* Standard GObject macros */ -#define E_TYPE_EXTENSIBLE \ - (e_extensible_get_type ()) -#define E_EXTENSIBLE(obj) \ - (G_TYPE_CHECK_INSTANCE_CAST \ - ((obj), E_TYPE_EXTENSIBLE, EExtensible)) -#define E_EXTENSIBLE_INTERFACE(cls) \ - (G_TYPE_CHECK_CLASS_CAST \ - ((cls), E_TYPE_EXTENSIBLE, EExtensibleInterface)) -#define E_IS_EXTENSIBLE(obj) \ - (G_TYPE_CHECK_INSTANCE_TYPE \ - ((obj), E_TYPE_EXTENSIBLE)) -#define E_IS_EXTENSIBLE_INTERFACE(cls) \ - (G_TYPE_CHECK_CLASS_TYPE \ - ((cls), E_TYPE_EXTENSIBLE)) -#define E_EXTENSIBLE_GET_INTERFACE(obj) \ - (G_TYPE_INSTANCE_GET_INTERFACE \ - ((obj), E_TYPE_EXTENSIBLE, EExtensibleInterface)) - -G_BEGIN_DECLS - -typedef struct _EExtensible EExtensible; -typedef struct _EExtensibleInterface EExtensibleInterface; - -struct _EExtensibleInterface { - GTypeInterface parent_interface; -}; - -GType e_extensible_get_type (void); -void e_extensible_load_extensions (EExtensible *extensible); -GList * e_extensible_list_extensions (EExtensible *extensible, - GType extension_type); - -G_END_DECLS - -#endif /* E_EXTENSIBLE_H */ diff --git a/e-util/e-extension.c b/e-util/e-extension.c deleted file mode 100644 index 88912bc8dd..0000000000 --- a/e-util/e-extension.c +++ /dev/null @@ -1,186 +0,0 @@ -/* - * e-extension.c - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2 of the License, or (at your option) version 3. - * - * 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with the program; if not, see <http://www.gnu.org/licenses/> - * - */ - -/** - * SECTION: e-extension - * @short_description: abstract base class for extensions - * @include: e-util/e-extension.h - * - * #EExtension provides a way to extend the functionality of objects - * that implement the #EExtensible interface. #EExtension subclasses - * can target a particular extensible object type. New instances of - * an extensible object type get paired with a new instance of each - * #EExtension subclass that targets the extensible object type. - * - * The first steps of writing a new extension are as follows: - * - * 1. Subclass #EExtension. - * - * 2. In the class initialization function, specify the #GType being - * extended. The #GType must implement the #EExtensible interface. - * - * 3. Register the extension's own #GType. If the extension is to - * be loaded dynamically using #GTypeModule, the type should be - * registered in the library module's e_module_load() function. - **/ - -#ifdef HAVE_CONFIG_H -#include <config.h> -#endif - -#include "e-extension.h" - -struct _EExtensionPrivate { - gpointer extensible; /* weak pointer */ -}; - -enum { - PROP_0, - PROP_EXTENSIBLE -}; - -G_DEFINE_ABSTRACT_TYPE ( - EExtension, - e_extension, - G_TYPE_OBJECT) - -static void -extension_set_extensible (EExtension *extension, - EExtensible *extensible) -{ - EExtensionClass *class; - GType extensible_type; - - g_return_if_fail (E_IS_EXTENSIBLE (extensible)); - g_return_if_fail (extension->priv->extensible == NULL); - - class = E_EXTENSION_GET_CLASS (extension); - extensible_type = G_OBJECT_TYPE (extensible); - - /* Verify the EExtensible object is the type we want. */ - if (!g_type_is_a (extensible_type, class->extensible_type)) { - g_warning ("%s is meant to extend %s but was given an %s", - G_OBJECT_TYPE_NAME (extension), - g_type_name (class->extensible_type), - g_type_name (extensible_type)); - return; - } - - extension->priv->extensible = extensible; - - g_object_add_weak_pointer ( - G_OBJECT (extensible), &extension->priv->extensible); -} - -static void -extension_set_property (GObject *object, - guint property_id, - const GValue *value, - GParamSpec *pspec) -{ - switch (property_id) { - case PROP_EXTENSIBLE: - extension_set_extensible ( - E_EXTENSION (object), - g_value_get_object (value)); - return; - } - - G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); -} - -static void -extension_get_property (GObject *object, - guint property_id, - GValue *value, - GParamSpec *pspec) -{ - switch (property_id) { - case PROP_EXTENSIBLE: - g_value_set_object ( - value, e_extension_get_extensible ( - E_EXTENSION (object))); - return; - } - - G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); -} - -static void -extension_dispose (GObject *object) -{ - EExtensionPrivate *priv; - - priv = E_EXTENSION (object)->priv; - - if (priv->extensible != NULL) { - g_object_remove_weak_pointer ( - G_OBJECT (priv->extensible), &priv->extensible); - priv->extensible = NULL; - } - - /* Chain up to parent's dispose() method. */ - G_OBJECT_CLASS (e_extension_parent_class)->dispose (object); -} - -static void -e_extension_class_init (EExtensionClass *class) -{ - GObjectClass *object_class; - - g_type_class_add_private (class, sizeof (EExtensionPrivate)); - - object_class = G_OBJECT_CLASS (class); - object_class->set_property = extension_set_property; - object_class->get_property = extension_get_property; - object_class->dispose = extension_dispose; - - g_object_class_install_property ( - object_class, - PROP_EXTENSIBLE, - g_param_spec_object ( - "extensible", - "Extensible Object", - "The object being extended", - E_TYPE_EXTENSIBLE, - G_PARAM_READWRITE | - G_PARAM_CONSTRUCT_ONLY)); -} - -static void -e_extension_init (EExtension *extension) -{ - extension->priv = G_TYPE_INSTANCE_GET_PRIVATE ( - extension, E_TYPE_EXTENSION, EExtensionPrivate); -} - -/** - * e_extension_get_extensible: - * @extension: an #EExtension - * - * Returns the object that @extension extends. - * - * Returns: the object being extended - **/ -EExtensible * -e_extension_get_extensible (EExtension *extension) -{ - g_return_val_if_fail (E_IS_EXTENSION (extension), NULL); - - return E_EXTENSIBLE (extension->priv->extensible); -} diff --git a/e-util/e-extension.h b/e-util/e-extension.h deleted file mode 100644 index bce2980e0e..0000000000 --- a/e-util/e-extension.h +++ /dev/null @@ -1,72 +0,0 @@ -/* - * e-extension.h - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2 of the License, or (at your option) version 3. - * - * 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with the program; if not, see <http://www.gnu.org/licenses/> - * - */ - -#ifndef E_EXTENSION_H -#define E_EXTENSION_H - -#include <e-util/e-extensible.h> - -/* Standard GObject macros */ -#define E_TYPE_EXTENSION \ - (e_extension_get_type ()) -#define E_EXTENSION(obj) \ - (G_TYPE_CHECK_INSTANCE_CAST \ - ((obj), E_TYPE_EXTENSION, EExtension)) -#define E_EXTENSION_CLASS(cls) \ - (G_TYPE_CHECK_CLASS_CAST \ - ((cls), E_TYPE_EXTENSION, EExtensionClass)) -#define E_IS_EXTENSION(obj) \ - (G_TYPE_CHECK_INSTANCE_TYPE \ - ((obj), E_TYPE_EXTENSION)) -#define E_IS_EXTENSION_CLASS(cls) \ - (G_TYPE_CHECK_CLASS_TYPE \ - ((cls), E_TYPE_EXTENSION)) -#define E_EXTENSION_GET_CLASS(obj) \ - (G_TYPE_INSTANCE_GET_CLASS \ - ((obj), E_TYPE_EXTENSION, EExtensionClass)) - -G_BEGIN_DECLS - -typedef struct _EExtension EExtension; -typedef struct _EExtensionClass EExtensionClass; -typedef struct _EExtensionPrivate EExtensionPrivate; - -/** - * EExtension: - * - * Contains only private data that should be read and manipulated using the - * functions below. - **/ -struct _EExtension { - GObject parent; - EExtensionPrivate *priv; -}; - -struct _EExtensionClass { - GObjectClass parent_class; - - /* The type to extend. */ - GType extensible_type; -}; - -GType e_extension_get_type (void); -EExtensible * e_extension_get_extensible (EExtension *extension); - -G_END_DECLS - -#endif /* E_EXTENSION_H */ diff --git a/e-util/e-module.c b/e-util/e-module.c deleted file mode 100644 index 46486080d6..0000000000 --- a/e-util/e-module.c +++ /dev/null @@ -1,320 +0,0 @@ -/* - * e-module.c - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2 of the License, or (at your option) version 3. - * - * 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with the program; if not, see <http://www.gnu.org/licenses/> - * - * - * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com) - * - */ - -/** - * SECTION: e-module - * @short_description: a module loader - * @include: e-util/e-module.h - **/ - -#ifdef HAVE_CONFIG_H -#include <config.h> -#endif - -#include "e-module.h" - -#include <glib/gi18n.h> - -/* This is the symbol we call when loading a module. */ -#define LOAD_SYMBOL "e_module_load" - -/* This is the symbol we call when unloading a module. */ -#define UNLOAD_SYMBOL "e_module_unload" - -struct _EModulePrivate { - GModule *module; - gchar *filename; - - void (*load) (GTypeModule *type_module); - void (*unload) (GTypeModule *type_module); -}; - -enum { - PROP_0, - PROP_FILENAME -}; - -G_DEFINE_TYPE ( - EModule, - e_module, - G_TYPE_TYPE_MODULE) - -static void -module_set_filename (EModule *module, - const gchar *filename) -{ - g_return_if_fail (module->priv->filename == NULL); - - module->priv->filename = g_strdup (filename); -} - -static void -module_set_property (GObject *object, - guint property_id, - const GValue *value, - GParamSpec *pspec) -{ - switch (property_id) { - case PROP_FILENAME: - module_set_filename ( - E_MODULE (object), - g_value_get_string (value)); - return; - } - - G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); -} - -static void -module_get_property (GObject *object, - guint property_id, - GValue *value, - GParamSpec *pspec) -{ - switch (property_id) { - case PROP_FILENAME: - g_value_set_string ( - value, e_module_get_filename ( - E_MODULE (object))); - return; - } - - G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); -} - -static void -module_finalize (GObject *object) -{ - EModulePrivate *priv; - - priv = E_MODULE (object)->priv; - - g_free (priv->filename); - - /* Chain up to parent's finalize() method. */ - G_OBJECT_CLASS (e_module_parent_class)->finalize (object); -} - -static gboolean -module_load (GTypeModule *type_module) -{ - EModulePrivate *priv; - gpointer symbol; - - priv = E_MODULE (type_module)->priv; - - g_return_val_if_fail (priv->filename != NULL, FALSE); - priv->module = g_module_open (priv->filename, 0); - - if (priv->module == NULL) - goto fail; - - if (!g_module_symbol (priv->module, LOAD_SYMBOL, &symbol)) - goto fail; - - priv->load = symbol; - - if (!g_module_symbol (priv->module, UNLOAD_SYMBOL, &symbol)) - goto fail; - - priv->unload = symbol; - - priv->load (type_module); - - /* XXX This is a Band-Aid for a design flaw in EExtension. If the - * "extensible_type" member of EExtensionClass is set to a GType - * that hasn't already been registered, then when the extension's - * module is unloaded the GType registration that was triggered - * by setting "extensible_type" will be invalidated and cause - * Evolution to malfunction when the module is loaded again. - * - * Extension modules get loaded and unloaded repeatedly by - * e_extensible_load_extensions(), which temporarily references - * all extension classes and picks out the ones it needs for a - * given EExtensible instance based on the "extensible_type" - * class member. - * - * Making the module resident prevents the aforementioned GType - * registration from being invalidated when the extension class - * is unreferenced. - */ - g_module_make_resident (priv->module); - - return TRUE; - -fail: - g_warning ("%s", g_module_error ()); - - if (priv->module != NULL) - g_module_close (priv->module); - - return FALSE; -} - -static void -module_unload (GTypeModule *type_module) -{ - EModulePrivate *priv; - - priv = E_MODULE (type_module)->priv; - - priv->unload (type_module); - - g_module_close (priv->module); - priv->module = NULL; - - priv->load = NULL; - priv->unload = NULL; -} - -static void -e_module_class_init (EModuleClass *class) -{ - GObjectClass *object_class; - GTypeModuleClass *type_module_class; - - g_type_class_add_private (class, sizeof (EModulePrivate)); - - object_class = G_OBJECT_CLASS (class); - object_class->set_property = module_set_property; - object_class->get_property = module_get_property; - object_class->finalize = module_finalize; - - type_module_class = G_TYPE_MODULE_CLASS (class); - type_module_class->load = module_load; - type_module_class->unload = module_unload; - - /** - * EModule:filename - * - * The filename of the module. - **/ - g_object_class_install_property ( - object_class, - PROP_FILENAME, - g_param_spec_string ( - "filename", - "Filename", - "The filename of the module", - NULL, - G_PARAM_READWRITE | - G_PARAM_CONSTRUCT_ONLY)); -} - -static void -e_module_init (EModule *module) -{ - module->priv = G_TYPE_INSTANCE_GET_PRIVATE ( - module, E_TYPE_MODULE, EModulePrivate); -} - -/** - * e_module_new: - * @filename: filename of the shared library module - * - * Creates a new #EModule that will load the specific shared library - * when in use. - * - * Returns: a new #EModule for @filename - **/ -EModule * -e_module_new (const gchar *filename) -{ - g_return_val_if_fail (filename != NULL, NULL); - - return g_object_new (E_TYPE_MODULE, "filename", filename, NULL); -} - -/** - * e_module_get_filename: - * @module: an #EModule - * - * Returns the filename of the shared library for @module. The - * string is owned by @module and should not be modified or freed. - * - * Returns: the filename for @module - **/ -const gchar * -e_module_get_filename (EModule *module) -{ - g_return_val_if_fail (E_IS_MODULE (module), NULL); - - return module->priv->filename; -} - -/** - * e_module_load_all_in_directory: - * @dirname: pathname for a directory containing modules to load - * - * Loads all the modules in the specified directory into memory. If - * you want to unload them (enabling on-demand loading) you must call - * g_type_module_unuse() on all the modules. Free the returned list - * with g_list_free(). - * - * Returns: a list of #EModules loaded from @dirname - **/ -GList * -e_module_load_all_in_directory (const gchar *dirname) -{ - GDir *dir; - const gchar *basename; - GList *loaded_modules = NULL; - GError *error = NULL; - - g_return_val_if_fail (dirname != NULL, NULL); - - if (!g_module_supported ()) - return NULL; - - dir = g_dir_open (dirname, 0, &error); - if (dir == NULL) { - g_warning ("%s", error->message); - g_error_free (error); - return NULL; - } - - while ((basename = g_dir_read_name (dir)) != NULL) { - EModule *module; - gchar *filename; - - if (!g_str_has_suffix (basename, "." G_MODULE_SUFFIX)) - continue; - - filename = g_build_filename (dirname, basename, NULL); - - module = e_module_new (filename); - - if (!g_type_module_use (G_TYPE_MODULE (module))) { - g_printerr ("Failed to load module: %s\n", filename); - g_object_unref (module); - g_free (filename); - continue; - } - - g_free (filename); - - loaded_modules = g_list_prepend (loaded_modules, module); - } - - g_dir_close (dir); - - return loaded_modules; -} diff --git a/e-util/e-module.h b/e-util/e-module.h deleted file mode 100644 index dc96bb34d9..0000000000 --- a/e-util/e-module.h +++ /dev/null @@ -1,75 +0,0 @@ -/* - * e-module.h - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2 of the License, or (at your option) version 3. - * - * 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with the program; if not, see <http://www.gnu.org/licenses/> - * - * - * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com) - * - */ - -#ifndef E_MODULE_H -#define E_MODULE_H - -#include <gmodule.h> -#include <glib-object.h> - -/* Standard GObject macros */ -#define E_TYPE_MODULE \ - (e_module_get_type ()) -#define E_MODULE(obj) \ - (G_TYPE_CHECK_INSTANCE_CAST \ - ((obj), E_TYPE_MODULE, EModule)) -#define E_MODULE_CLASS(cls) \ - (G_TYPE_CHECK_CLASS_CAST \ - ((cls), E_TYPE_MODULE, EModuleClass)) -#define E_IS_MODULE(obj) \ - (G_TYPE_CHECK_INSTANCE_TYPE \ - ((obj), E_TYPE_MODULE)) -#define E_IS_MODULE_CLASS(cls) \ - (G_TYPE_CHECK_CLASS_TYPE \ - ((cls), E_TYPE_MODULE)) -#define E_MODULE_GET_CLASS(obj) \ - (G_TYPE_INSTANCE_GET_CLASS \ - ((obj), E_TYPE_MODULE, EModuleClass)) - -G_BEGIN_DECLS - -typedef struct _EModule EModule; -typedef struct _EModuleClass EModuleClass; -typedef struct _EModulePrivate EModulePrivate; - -/** - * EModule: - * - * Contains only private data that should be read and manipulated using the - * functions below. - **/ -struct _EModule { - GTypeModule parent; - EModulePrivate *priv; -}; - -struct _EModuleClass { - GTypeModuleClass parent_class; -}; - -GType e_module_get_type (void); -EModule * e_module_new (const gchar *filename); -const gchar * e_module_get_filename (EModule *module); -GList * e_module_load_all_in_directory (const gchar *dirname); - -G_END_DECLS - -#endif /* E_MODULE_H */ diff --git a/e-util/e-plugin.c b/e-util/e-plugin.c index 17650f045a..a19dc879b3 100644 --- a/e-util/e-plugin.c +++ b/e-util/e-plugin.c @@ -27,12 +27,12 @@ #include <gconf/gconf-client.h> +#include <libebackend/e-module.h> #include <libedataserver/e-data-server-util.h> #include <libedataserver/e-xml-utils.h> #include "e-plugin.h" #include "e-util-private.h" -#include "e-util.h" /* plugin debug */ #define pd(x) diff --git a/e-util/e-util.c b/e-util/e-util.c index 8ededeeb9d..cd489849e4 100644 --- a/e-util/e-util.c +++ b/e-util/e-util.c @@ -489,47 +489,6 @@ e_categories_add_change_hook (GHookFunc func, } /** - * e_type_traverse: - * @parent_type: the root #GType to traverse from - * @func: the function to call for each visited #GType - * @user_data: user data to pass to the function - * - * Calls @func for all instantiable subtypes of @parent_type. - * - * This is often useful for extending functionality by way of #EModule. - * A module may register a subtype of @parent_type in its e_module_load() - * function. Then later on the application will call e_type_traverse() - * to instantiate all registered subtypes of @parent_type. - **/ -void -e_type_traverse (GType parent_type, - ETypeFunc func, - gpointer user_data) -{ - GType *children; - guint n_children, ii; - - g_return_if_fail (func != NULL); - - children = g_type_children (parent_type, &n_children); - - for (ii = 0; ii < n_children; ii++) { - GType type = children[ii]; - - /* Recurse over the child's children. */ - e_type_traverse (type, func, user_data); - - /* Skip abstract types. */ - if (G_TYPE_IS_ABSTRACT (type)) - continue; - - func (type, user_data); - } - - g_free (children); -} - -/** * e_str_without_underscores: * @string: the string to strip underscores from * diff --git a/e-util/e-util.h b/e-util/e-util.h index 8463fd4a7b..cb88a90644 100644 --- a/e-util/e-util.h +++ b/e-util/e-util.h @@ -69,9 +69,6 @@ GtkRadioAction *e_radio_action_get_current_action (GtkRadioAction *radio_action); void e_categories_add_change_hook (GHookFunc func, gpointer object); -void e_type_traverse (GType parent_type, - ETypeFunc func, - gpointer user_data); gchar * e_str_without_underscores (const gchar *string); gint e_str_compare (gconstpointer x, |