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