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-mail-operation-queue.h>
  39 #include <modest-tny-account-store.h>
  40 #include <modest-tny-send-queue.h>
  41 #include <tny-platform-factory.h>
  42 #include "widgets/modest-window-mgr.h"
  43
  44 G_BEGIN_DECLS
  45
  46 #define MODEST_DEBUG "MODEST_DEBUG"
  47
  48 typedef enum {
  49         MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING      = 1 << 0,
  50         MODEST_RUNTIME_DEBUG_LOG_ACTIONS           = 1 << 1, /* not in use atm */
  51         MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS         = 1 << 2, /* for g_type_init */
  52         MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS         = 1 << 3, /* for g_type_init */
  53         MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS      = 1 << 4  /* reset to factory defaults */
  54 } ModestRuntimeDebugFlags;
  55
  56 /**
  57  * modest_runtime_init:
  58  *
  59  * initialize the modest runtime system (which sets up the
  60  * environment, instantiates singletons and so on)
  61  * modest_runtime_init should only be called once, and
  62  * when done with it, modest_runtime_uninit should be called
  63  *
  64  * TRUE if this succeeded, FALSE otherwise.
  65  */
  66 gboolean modest_runtime_init (void);
  67
  68
  69 /**
  70  * modest_runtime_init_ui:
  71  * @argc: the #argc argument to the main function
  72  * @argv: the #argv argument to the main function
  73  *
  74  * initialize the modest UI; this replaces the call to
  75  * gtk_init
  76  *
  77  * TRUE if this succeeded, FALSE otherwise.
  78  */
  79 gboolean modest_runtime_init_ui (gint argc, gchar** argv);
  80
  81 /**
  82  * modest_runtime_uinit:
  83  *
  84  * uninitialize the modest runtime system; free all the
  85  * resources and so on.
  86  *
  87  * TRUE if this succeeded, FALSE otherwise
  88  */
  89 gboolean modest_runtime_uninit (void);
  90
  91
  92
  93 /**
  94  * modest_runtime_get_debug_flags
  95  *
  96  * get the debug flags for modest; they are read from the MODEST_DEBUG
  97  * environment variable; the flags specified as strings, separated by ':'.
  98  * Possible values are:
  99  * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
 100  * useful when running in debugger
 101  * - "log-actions": log user actions (not in use atm)
 102  * - "debug-objects": track the use of (g)objects in the program. this option influences
 103  *  g_type_init_with_debug_flags
 104  *  - "debug-signals": track the use of (g)signals in the program. this option influences
 105  *  g_type_init_with_debug_flags
 106  * if you would want to track signals and log actions, you could do something like:
 107  *  MODEST_DEBUG="log-actions:track-signals" ./modest
 108  * NOTE that the flags will stay the same during the run of the program, even
 109  * if the environment variable changes.
 110  *
 111  * Returns: the bitwise OR of the debug flags
 112  */
 113 ModestRuntimeDebugFlags modest_runtime_get_debug_flags  (void) G_GNUC_CONST;
 114
 115 /**
 116  * modest_runtime_get_conf:
 117  *
 118  * get the ModestConf singleton instance
 119  *
 120  * Returns: the ModestConf singleton. This should NOT be unref'd.
 121  **/
 122 ModestConf*         modest_runtime_get_conf   (void);
 123
 124
 125 /**
 126  * modest_runtime_get_account_mgr:
 127  *
 128  * get the ModestAccountMgr singleton instance
 129  *
 130  * Returns: the ModestAccountMgr singleton. This should NOT be unref'd.
 131  **/
 132 ModestAccountMgr*         modest_runtime_get_account_mgr   (void);
 133
 134 /**
 135  * modest_runtime_get_account_store:
 136  *
 137  * get the ModestTnyAccountStore singleton instance
 138  *
 139  * Returns: the ModestTnyAccountStore singleton. This should NOT be unref'd.
 140  **/
 141 ModestTnyAccountStore*    modest_runtime_get_account_store (void);
 142
 143
 144 /**
 145  * modest_runtime_get_cache_mgr:
 146  *
 147  * get the ModestCacheMgr singleton instance
 148  *
 149  * Returns: the #ModestCacheMgr singleton. This should NOT be unref'd.
 150  **/
 151 ModestCacheMgr*           modest_runtime_get_cache_mgr     (void);
 152
 153
 154
 155 /**
 156  * modest_runtime_get_device:
 157  *
 158  * get the #TnyDevice singleton instance
 159  *
 160  * Returns: the #TnyDevice singleton. This should NOT be unref'd.
 161  **/
 162 TnyDevice*                    modest_runtime_get_device     (void);
 163
 164
 165 /**
 166  * modest_runtime_get_platform_factory:
 167  *
 168  * get the #TnyPlatformFactory singleton instance
 169  *
 170  * Returns: the #TnyPlatformFactory singleton. This should NOT be unref'd.
 171  **/
 172 TnyPlatformFactory*           modest_runtime_get_platform_factory     (void);
 173
 174
 175
 176
 177 /**
 178  * modest_runtime_get_mail_operation_queue:
 179  *
 180  * get the #ModestMailOperationQueue singleton instance
 181  *
 182  * Returns: the #ModestMailOperationQueue singleton. This should NOT be unref'd.
 183  **/
 184 ModestMailOperationQueue* modest_runtime_get_mail_operation_queue (void);
 185
 186
 187 /**
 188  * modest_runtime_get_send_queue:
 189  * @account: a valid TnyTransportAccount
 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
 198 /**
 199  * modest_runtime_remove_all_send_queues:
 200  *
 201  * Removes all send queues, ready for them to be recreated, for instance
 202  * with a new connection.
 203  **/
 204 void modest_runtime_remove_all_send_queues ();
 205
 206 /**
 207  * modest_runtime_get_window_mgr:
 208  *
 209  * get the #ModestWindowMgr singleton instance
 210  *
 211  * Returns: the #ModestWindowMgr singleton. This should NOT be unref'd.
 212  **/
 213 ModestWindowMgr* modest_runtime_get_window_mgr (void);
 214
 215 /**
 216  * modest_runtime_verify_object_last_ref
 217  * @OBJ: some (GObject) ptr
 218  * @NAME: name of @OBJ
 219  *
 220  * macro to check whether @obj holds only one more ref (ie. after the
 221  * next unref it will die)
 222  *
 223  * not, a g_warning will be issued on stderr. NOTE: this is only active
 224  * when MODEST_DEBUG contains "debug-objects".
 225  *
 226  ***/
 227 #define modest_runtime_verify_object_last_ref(OBJ,name)                                                \
 228         do {                                                                                           \
 229                 if (modest_runtime_get_debug_flags() & MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS)             \
 230                         if (G_IS_OBJECT(OBJ) && G_OBJECT(OBJ)->ref_count != 1)                         \
 231                                 g_warning ("%s:%d: %s ("                                               \
 232                                            #OBJ ") still holds a ref count of %d",                     \
 233                                            __FILE__,__LINE__,name, G_OBJECT(OBJ)->ref_count);          \
 234         } while (0)
 235
 236
 237
 238 /**
 239  * modest_runtime_not_implemented
 240  * @WIN: the parent GtkWindow, or NULL
 241  *
 242  * give a not-implemented-yet warning popup or g_warning
 243  *
 244  ***/
 245 #define modest_runtime_not_implemented(WIN)    \
 246         do {                                   \
 247                 if (gtk_main_level() > 0) {    \
 248                         GtkWidget *popup;      \
 249                         popup = gtk_message_dialog_new (WIN,\
 250                                                         GTK_DIALOG_MODAL|GTK_DIALOG_DESTROY_WITH_PARENT,\
 251                                                         GTK_MESSAGE_WARNING, \
 252                                                         GTK_BUTTONS_OK, \
 253                                                         "Not yet implemented");\
 254                         gtk_dialog_run (GTK_DIALOG(popup));             \
 255                         gtk_widget_destroy (popup);                     \
 256                 } else                                                  \
 257                         g_warning ("%s:%d: Not yet implemented",__FILE__,__LINE__); \
 258         } while (0)                                                     \
 259
 260
 261 G_END_DECLS
 262
 263 #endif /*__MODEST_RUNTIME_H__*/