git.maemo.org Git - modest/blob - src/modest-plugin.h

   1 /* Copyright (c) 2008, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   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.
  16  *
  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.
  28  */
  29 #ifndef __MODEST_PLUGIN_H__
  30 #define __MODEST_PLUGIN_H__
  31
  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-mail-operation-queue.h>
  37
  38 #define MODEST_API_VERSION_STR2_HELPER(x) #x
  39 #define MODEST_API_VERSION_STR_HELPER(x) MODEST_API_VERSION_STR2_HELPER(x)
  40 #define MODEST_API_VERSION_STR MODEST_API_VERSION_STR_HELPER(MODEST_API_VERSION)
  41
  42 G_BEGIN_DECLS
  43
  44 /* convenience macros */
  45 #define MODEST_TYPE_PLUGIN             (modest_plugin_get_type())
  46 #define MODEST_PLUGIN(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_PLUGIN,ModestPlugin))
  47 #define MODEST_PLUGIN_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_PLUGIN,ModestPluginClass))
  48 #define MODEST_IS_PLUGIN(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_PLUGIN))
  49 #define MODEST_IS_PLUGIN_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_PLUGIN))
  50 #define MODEST_PLUGIN_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_PLUGIN,ModestPluginClass))
  51
  52 typedef struct _ModestPlugin      ModestPlugin;
  53 typedef struct _ModestPluginClass ModestPluginClass;
  54
  55 struct _ModestPlugin {
  56         GObject parent;
  57 };
  58
  59 struct _ModestPluginClass {
  60         GObjectClass parent_class;
  61         const gchar * (*get_version) (void);
  62 };
  63
  64 /**
  65  * modest_plugin_get_type:
  66  *
  67  * Returns: GType of the account store
  68  */
  69 GType  modest_plugin_get_type   (void) G_GNUC_CONST;
  70
  71 #define MODEST_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)                    \
  72                                                                                 \
  73 static GType plugin_name##_type = 0;                                            \
  74                                                                                 \
  75 GType                                                                           \
  76 plugin_name##_get_type (void)                                                   \
  77 {                                                                               \
  78         return plugin_name##_type;                                              \
  79 }                                                                               \
  80                                                                                 \
  81 static void     plugin_name##_init              (PluginName        *self);      \
  82 static void     plugin_name##_class_init        (PluginName##Class *klass);     \
  83 static gpointer plugin_name##_parent_class = NULL;                              \
  84 static const gchar *plugin_name##_internal_get_version (void)                   \
  85 {                                                                               \
  86         return MODEST_API_VERSION_STR;                                          \
  87 }                                                                               \
  88 static void     plugin_name##_class_intern_init (gpointer klass)                \
  89 {                                                                               \
  90         plugin_name##_parent_class = g_type_class_peek_parent (klass);          \
  91         plugin_name##_class_init ((PluginName##Class *) klass);                 \
  92         ((ModestPluginClass *)klass)->get_version = plugin_name##_internal_get_version; \
  93 }                                                                               \
  94                                                                                 \
  95 G_MODULE_EXPORT GType                                                           \
  96 register_modest_plugin (GTypeModule *module)                                    \
  97 {                                                                               \
  98         static const GTypeInfo our_info =                                       \
  99         {                                                                       \
 100                 sizeof (PluginName##Class),                                     \
 101                 NULL, /* base_init */                                           \
 102                 NULL, /* base_finalize */                                       \
 103                 (GClassInitFunc) plugin_name##_class_intern_init,               \
 104                 NULL,                                                           \
 105                 NULL, /* class_data */                                          \
 106                 sizeof (PluginName),                                            \
 107                 0, /* n_preallocs */                                            \
 108                 (GInstanceInitFunc) plugin_name##_init                          \
 109         };                                                                      \
 110                                                                                 \
 111                                                                                 \
 112         plugin_name##_type = g_type_module_register_type (module,               \
 113                                             MODEST_TYPE_PLUGIN,                 \
 114                                             #PluginName,                        \
 115                                             &our_info,                          \
 116                                             0);                                 \
 117                                                                                 \
 118         return plugin_name##_type;                                              \
 119 }
 120
 121 /* Global methods providing access to singletons without using modest runtime */
 122 ModestAccountMgr *modest_plugin_get_account_mgr (void);
 123 ModestProtocolRegistry *modest_plugin_get_protocol_registry (void);
 124 ModestMailOperationQueue *modest_plugin_get_mail_operation_queue (void);
 125 const gchar *modest_plugin_get_api_version (ModestPlugin *plugin);
 126 G_END_DECLS
 127
 128 #endif /* __MODEST_PLUGIN_H__ */