summaryrefslogtreecommitdiff
path: root/tumbler/tumbler-provider-plugin.h
diff options
context:
space:
mode:
authorJannis Pohlmann <jannis@xfce.org>2009-06-08 20:31:41 +0200
committerJannis Pohlmann <jannis@xfce.org>2009-06-08 20:31:41 +0200
commit9d5f1b7b03bd0ad50365fa8186a0d9bce690f31d (patch)
tree9aed893b732fd3266c52fdbed77a1ac754199879 /tumbler/tumbler-provider-plugin.h
parent04bb883f2b53aea6f848672ee7dea42cf7a6af86 (diff)
downloadtumbler-9d5f1b7b03bd0ad50365fa8186a0d9bce690f31d.tar.gz
Add plugin interface for cache and thumbnailer implementations.
This is a major refactoring of the source code. Amongst others, the classes TumblerProviderFactory, TumblerThumbnailer, TumblerAbstractThumbnailer, TumblerThumbnailerProvider, TumblerCache, TumblerCacheProvider and TumblerFileInfo have been added. From now on tumbler supports different storage backends and thumbnailers as plugins. Storage backends have to implement TumblerCache, thumbnailers have to implement TumblerThumbnailer. Plugins have to implement three methods: tumbler_plugin_initialize(), tumbler_plugin_shutdown() and tumbler_plugin_get_types(). The latter is expected to return a list of provider types for cache or thumbnailer implementations. Two example plugins have been added, one for the XDG thumbnail cache and one for a GdkPixbuf based thumbnailer. The code of tumblerd was updated to reflect these changes in libtumbler.
Diffstat (limited to 'tumbler/tumbler-provider-plugin.h')
-rw-r--r--tumbler/tumbler-provider-plugin.h52
1 files changed, 52 insertions, 0 deletions
diff --git a/tumbler/tumbler-provider-plugin.h b/tumbler/tumbler-provider-plugin.h
new file mode 100644
index 0000000..a1b8519
--- /dev/null
+++ b/tumbler/tumbler-provider-plugin.h
@@ -0,0 +1,52 @@
+/* vi:set et ai sw=2 sts=2 ts=2: */
+/*-
+ * Copyright (c) 2009 Jannis Pohlmann <jannis@xfce.org>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library 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 Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General
+ * Public License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#if !defined (TUMBLER_INSIDE_TUMBLER_H) && !defined (TUMBLER_COMPILATION)
+#error "Only <tumbler/tumbler.h> may be included directly. This file might disappear or change contents."
+#endif
+
+#ifndef __TUMBLER_PROVIDER_PLUGIN_H__
+#define __TUMBLER_PROVIDER_PLUGIN_H__
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS;
+
+#define TUMBLER_TYPE_PROVIDER_PLUGIN (tumbler_provider_plugin_get_type ())
+#define TUMBLER_PROVIDER_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TUMBLER_TYPE_PROVIDER_PLUGIN, TumblerProviderPlugin))
+#define TUMBLER_PROVIDER_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), TUMBLER_TYPE_PROVIDER_PLUGIN, TumblerProviderPluginClass))
+#define TUMBLER_IS_PROVIDER_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TUMBLER_TYPE_PROVIDER_PLUGIN))
+#define TUMBLER_IS_PROVIDER_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), TUMBLER_TYPE_PROVIDER_PLUGIN)
+#define TUMBLER_PROVIDER_PLUGIN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), TUMBLER_TYPE_PROVIDER_PLUGIN, TumblerProviderPluginClass))
+
+typedef struct _TumblerProviderPluginPrivate TumblerProviderPluginPrivate;
+typedef struct _TumblerProviderPluginClass TumblerProviderPluginClass;
+typedef struct _TumblerProviderPlugin TumblerProviderPlugin;
+
+GType tumbler_provider_plugin_get_type (void) G_GNUC_CONST G_GNUC_INTERNAL;
+
+TumblerProviderPlugin *tumbler_provider_plugin_new (const gchar *filename) G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT G_GNUC_INTERNAL;
+void tumbler_provider_plugin_get_types (const TumblerProviderPlugin *plugin,
+ const GType **types,
+ gint *n_types) G_GNUC_INTERNAL;
+
+G_END_DECLS;
+
+#endif /* !__TUMBLER_PROVIDER_PLUGIN_H__ */