1 /* Copyright (c) 2008, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 #ifndef __MODEST_PLUGIN_H__
30 #define __MODEST_PLUGIN_H__
32 #include <glib-object.h>
33 #include <glib/gi18n.h>
34 #include <modest-account-mgr.h>
35 #include <modest-protocol-registry.h>
36 #include <modest-tny-account-store.h>
37 #include <modest-mail-operation-queue.h>
39 #define MODEST_API_VERSION_STR2_HELPER(x) #x
40 #define MODEST_API_VERSION_STR_HELPER(x) MODEST_API_VERSION_STR2_HELPER(x)
41 #define MODEST_API_VERSION_STR MODEST_API_VERSION_STR_HELPER(MODEST_API_VERSION)
45 /* convenience macros */
46 #define MODEST_TYPE_PLUGIN (modest_plugin_get_type())
47 #define MODEST_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_PLUGIN,ModestPlugin))
48 #define MODEST_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_PLUGIN,ModestPluginClass))
49 #define MODEST_IS_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_PLUGIN))
50 #define MODEST_IS_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_PLUGIN))
51 #define MODEST_PLUGIN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_PLUGIN,ModestPluginClass))
53 typedef struct _ModestPlugin ModestPlugin;
54 typedef struct _ModestPluginClass ModestPluginClass;
56 struct _ModestPlugin {
60 struct _ModestPluginClass {
61 GObjectClass parent_class;
62 const gchar * (*get_version) (void);
66 * modest_plugin_get_type:
68 * Returns: GType of the account store
70 GType modest_plugin_get_type (void) G_GNUC_CONST;
72 #define MODEST_PLUGIN_REGISTER_TYPE(PluginName, plugin_name) \
74 static GType plugin_name##_type = 0; \
77 plugin_name##_get_type (void) \
79 return plugin_name##_type; \
82 static void plugin_name##_init (PluginName *self); \
83 static void plugin_name##_class_init (PluginName##Class *klass); \
84 static gpointer plugin_name##_parent_class = NULL; \
85 static const gchar *plugin_name##_internal_get_version (void) \
87 return MODEST_API_VERSION_STR; \
89 static void plugin_name##_class_intern_init (gpointer klass) \
91 plugin_name##_parent_class = g_type_class_peek_parent (klass); \
92 plugin_name##_class_init ((PluginName##Class *) klass); \
93 ((ModestPluginClass *)klass)->get_version = plugin_name##_internal_get_version; \
96 G_MODULE_EXPORT GType \
97 register_modest_plugin (GTypeModule *module) \
99 static const GTypeInfo our_info = \
101 sizeof (PluginName##Class), \
102 NULL, /* base_init */ \
103 NULL, /* base_finalize */ \
104 (GClassInitFunc) plugin_name##_class_intern_init, \
106 NULL, /* class_data */ \
107 sizeof (PluginName), \
108 0, /* n_preallocs */ \
109 (GInstanceInitFunc) plugin_name##_init \
113 plugin_name##_type = g_type_module_register_type (module, \
114 MODEST_TYPE_PLUGIN, \
119 return plugin_name##_type; \
122 /* Global methods providing access to singletons without using modest runtime */
123 ModestAccountMgr *modest_plugin_get_account_mgr (void);
124 ModestProtocolRegistry *modest_plugin_get_protocol_registry (void);
125 ModestTnyAccountStore *modest_plugin_get_account_store (void);
126 ModestMailOperationQueue *modest_plugin_get_mail_operation_queue (void);
127 const gchar *modest_plugin_get_api_version (ModestPlugin *plugin);
130 #endif /* __MODEST_PLUGIN_H__ */