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

   1 /* Copyright (c) 2006, 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
  30 #ifndef __MODEST_RUNTIME_H__
  31 #define __MODEST_RUNTIME_H__
  32
  33 #include <glib.h>
  34 #include <glib-object.h>
  35 #include <modest-conf.h>
  36 #include <modest-account-mgr.h>
  37 #include <modest-cache-mgr.h>
  38 #include <modest-email-clipboard.h>
  39 #include <modest-mail-operation-queue.h>
  40 #include <modest-tny-account-store.h>
  41 #include <modest-tny-send-queue.h>
  42 #include <modest-signal-mgr.h>
  43 #include <tny-platform-factory.h>
  44 #include "widgets/modest-window-mgr.h"
  45 <<<<<<< .working
  46 #include <tny-stream-cache.h>
  47 =======
  48 #include <modest-protocol-registry.h>
  49 #include <tny-stream-cache.h>
  50 #include <modest-plugin-factory.h>
  51 >>>>>>> .merge-right.r5668
  52
  53 G_BEGIN_DECLS
  54
  55 #define MODEST_DEBUG "MODEST_DEBUG"
  56
  57 typedef enum {
  58         MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING      = 1 << 0,
  59         MODEST_RUNTIME_DEBUG_LOG_ACTIONS           = 1 << 1, /* not in use atm */
  60         MODEST_RUNTIME_DEBUG_OBJECTS               = 1 << 2, /* for g_type_init */
  61         MODEST_RUNTIME_DEBUG_SIGNALS               = 1 << 3, /* for g_type_init */
  62         MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS      = 1 << 4, /* reset to factory defaults */
  63         MODEST_RUNTIME_DEBUG_CODE                  = 1 << 5  /* print various debugging messages */
  64 } ModestRuntimeDebugFlags;
  65
  66 /**
  67  * modest_runtime_init:
  68  *
  69  * initialize the modest runtime system (which sets up the
  70  * environment, instantiates singletons and so on)
  71  * modest_runtime_init should only be called once, and
  72  * when done with it, modest_runtime_uninit should be called
  73  *
  74  * TRUE if this succeeded, FALSE otherwise.
  75  */
  76 gboolean modest_runtime_init (void);
  77
  78
  79 /**
  80  * modest_runtime_uinit:
  81  *
  82  * uninitialize the modest runtime system; free all the
  83  * resources and so on.
  84  *
  85  * TRUE if this succeeded, FALSE otherwise
  86  */
  87 gboolean modest_runtime_uninit (void);
  88
  89
  90 /**
  91  * modest_runtime_get_debug_flags
  92  *
  93  * get the debug flags for modest; they are read from the MODEST_DEBUG
  94  * environment variable; the flags specified as strings, separated by ':'.
  95  * Possible values are:
  96  * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
  97  * useful when running in debugger
  98  * - "log-actions": log user actions (not in use atm)
  99  * - "debug-objects": track the use of (g)objects in the program. this option influences
 100  *  g_type_init_with_debug_flags
 101  *  - "debug-signals": track the use of (g)signals in the program. this option influences
 102  *  g_type_init_with_debug_flags
 103  * if you would want to track signals and log actions, you could do something like:
 104  *  MODEST_DEBUG="log-actions:track-signals" ./modest
 105  * NOTE that the flags will stay the same during the run of the program, even
 106  * if the environment variable changes.
 107  *
 108  * Returns: the bitwise OR of the debug flags
 109  */
 110 ModestRuntimeDebugFlags modest_runtime_get_debug_flags  (void) G_GNUC_CONST;
 111
 112 /**
 113  * modest_runtime_get_conf:
 114  *
 115  * get the ModestConf singleton instance
 116  *
 117  * Returns: the ModestConf singleton. This should NOT be unref'd.
 118  **/
 119 ModestConf*         modest_runtime_get_conf   (void);
 120
 121
 122 /**
 123  * modest_runtime_get_account_mgr:
 124  *
 125  * get the ModestAccountMgr singleton instance
 126  *
 127  * Returns: the ModestAccountMgr singleton. This should NOT be unref'd.
 128  **/
 129 ModestAccountMgr*         modest_runtime_get_account_mgr   (void);
 130
 131 /**
 132  * modest_runtime_get_images_cache:
 133  *
 134  * get the images #TnyStreamCache singleton instance
 135  *
 136  * Returns: the images #TnyStreamCache singleton. This should NOT be unref'd.
 137  **/
 138 TnyStreamCache*         modest_runtime_get_images_cache   (void);
 139
 140 /**
 141  * modest_runtime_get_email_clipboard:
 142  *
 143  * get the #ModestEmailClipboard singleton instance
 144  *
 145  * Returns: the #ModestEamilClipboard singleton. This should NOT be unref'd.
 146  **/
 147 ModestEmailClipboard*     modest_runtime_get_email_clipboard   (void);
 148
 149 /**
 150  * modest_runtime_get_account_store:
 151  *
 152  * get the ModestTnyAccountStore singleton instance
 153  *
 154  * Returns: the ModestTnyAccountStore singleton. This should NOT be unref'd.
 155  **/
 156 ModestTnyAccountStore*    modest_runtime_get_account_store (void);
 157
 158
 159 /**
 160  * modest_runtime_get_cache_mgr:
 161  *
 162  * get the ModestCacheMgr singleton instance
 163  *
 164  * Returns: the #ModestCacheMgr singleton. This should NOT be unref'd.
 165  **/
 166 ModestCacheMgr*           modest_runtime_get_cache_mgr     (void);
 167
 168
 169
 170 /**
 171  * modest_runtime_get_device:
 172  *
 173  * get the #TnyDevice singleton instance
 174  *
 175  * Returns: the #TnyDevice singleton. This should NOT be unref'd.
 176  **/
 177 TnyDevice*                    modest_runtime_get_device     (void);
 178
 179
 180 /**
 181  * modest_runtime_get_platform_factory:
 182  *
 183  * get the #TnyPlatformFactory singleton instance
 184  *
 185  * Returns: the #TnyPlatformFactory singleton. This should NOT be unref'd.
 186  **/
 187 TnyPlatformFactory*           modest_runtime_get_platform_factory     (void);
 188
 189
 190
 191
 192 /**
 193  * modest_runtime_get_mail_operation_queue:
 194  *
 195  * get the #ModestMailOperationQueue singleton instance
 196  *
 197  * Returns: the #ModestMailOperationQueue singleton. This should NOT be unref'd.
 198  **/
 199 ModestMailOperationQueue* modest_runtime_get_mail_operation_queue (void);
 200
 201
 202 /**
 203  * modest_runtime_get_send_queue:
 204  * @account: a valid TnyTransportAccount
 205  * @create: whether or not a new send queue should be created if it does not exist
 206  *
 207  * get the send queue for the given account
 208  *
 209  * Returns: the #ModestTnySendQueue singleton instance for this account
 210  * (ie., one singleton per account). This should NOT be unref'd.
 211  **/
 212 ModestTnySendQueue* modest_runtime_get_send_queue        (TnyTransportAccount *account,
 213                                                           gboolean create);
 214
 215 /**
 216  * modest_runtime_remove_send_queue:
 217  * @account: a #TnyTransportAccount
 218  *
 219  * Removes the send queue associated with the given transport account
 220  **/
 221 void modest_runtime_remove_send_queue (TnyTransportAccount *account);
 222
 223 /**
 224  * modest_runtime_remove_all_send_queues:
 225  *
 226  * Removes all send queues, ready for them to be recreated, for instance
 227  * with a new connection.
 228  **/
 229 void modest_runtime_remove_all_send_queues ();
 230
 231 /**
 232  * modest_runtime_get_window_mgr:
 233  *
 234  * get the #ModestWindowMgr singleton instance
 235  *
 236  * Returns: the #ModestWindowMgr singleton. This should NOT be unref'd.
 237  **/
 238 ModestWindowMgr* modest_runtime_get_window_mgr (void);
 239
 240 /**
 241  * modest_runtime_get_protocol_registry:
 242  *
 243  * get the #ModestProtocolRegistry singleton instance
 244  *
 245  * Returns: the #ModestProtocolRegistry singleton. This should NOT be unref'd.
 246  **/
 247 ModestProtocolRegistry* modest_runtime_get_protocol_registry (void);
 248
 249 /**
 250  * modest_runtime_get_plugin_factory:
 251  *
 252  * get the #ModestPluginFactory singleton instance
 253  *
 254  * Returns: the #ModestPluginFactory singleton. This should NOT be unref'd.
 255  **/
 256 ModestPluginFactory * modest_runtime_get_plugin_factory (void);
 257
 258
 259 G_END_DECLS
 260
 261 #endif /*__MODEST_RUNTIME_H__*/