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