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
  43 G_BEGIN_DECLS
  44
  45 #define MODEST_DEBUG "MODEST_DEBUG"
  46
  47 typedef enum {
  48         MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING      = 1 << 0,
  49         MODEST_RUNTIME_DEBUG_LOG_ACTIONS           = 1 << 1, /* not in use atm */
  50         MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS         = 1 << 2, /* for g_type_init */
  51         MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS         = 1 << 3, /* for g_type_init */
  52         MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS      = 1 << 4  /* reset to factory defaults */
  53 } ModestRuntimeDebugFlags;
  54
  55 /**
  56  * modest_runtime_init:
  57  *
  58  * initialize the modest runtime system (which sets up the
  59  * environment, instantiates singletons and so on)
  60  * modest_runtime_init should only be called once, and
  61  * when done with it, modest_runtime_uninit should be called
  62  *
  63  * TRUE if this succeeded, FALSE otherwise.
  64  */
  65 gboolean modest_runtime_init (void);
  66
  67
  68 /**
  69  * modest_runtime_init_ui:
  70  * @argc: the #argc argument to the main function
  71  * @argv: the #argv argument to the main function
  72  *
  73  * initialize the modest UI; this replaces the call to
  74  * gtk_init
  75  *
  76  * TRUE if this succeeded, FALSE otherwise.
  77  */
  78 gboolean modest_runtime_init_ui (gint argc, gchar** argv);
  79
  80 /**
  81  * modest_runtime_uinit:
  82  *
  83  * uninitialize the modest runtime system; free all the
  84  * resources and so on.
  85  *
  86  * TRUE if this succeeded, FALSE otherwise
  87  */
  88 gboolean modest_runtime_uninit (void);
  89
  90
  91
  92 /**
  93  * modest_runtime_get_debug_flags
  94  *
  95  * get the debug flags for modest; they are read from the MODEST_DEBUG
  96  * environment variable; the flags specified as strings, separated by ':'.
  97  * Possible values are:
  98  * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
  99  * useful when running in debugger
 100  * - "log-actions": log user actions (not in use atm)
 101  * - "debug-objects": track the use of (g)objects in the program. this option influences
 102  *  g_type_init_with_debug_flags
 103  *  - "debug-signals": track the use of (g)signals in the program. this option influences
 104  *  g_type_init_with_debug_flags
 105  * if you would want to track signals and log actions, you could do something like:
 106  *  MODEST_DEBUG="log-actions:track-signals" ./modest
 107  * NOTE that the flags will stay the same during the run of the program, even
 108  * if the environment variable changes.
 109  *
 110  * Returns: the bitwise OR of the debug flags
 111  */
 112 ModestRuntimeDebugFlags modest_runtime_get_debug_flags  (void) G_GNUC_CONST;
 113
 114 /**
 115  * modest_runtime_get_conf:
 116  *
 117  * get the ModestConf singleton instance
 118  *
 119  * Returns: the ModestConf singleton. This should NOT be unref'd.
 120  **/
 121 ModestConf*         modest_runtime_get_conf   (void);
 122
 123
 124 /**
 125  * modest_runtime_get_account_mgr:
 126  *
 127  * get the ModestAccountMgr singleton instance
 128  *
 129  * Returns: the ModestAccountMgr singleton. This should NOT be unref'd.
 130  **/
 131 ModestAccountMgr*         modest_runtime_get_account_mgr   (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  *
 190  * get the send queue for the given account
 191  *
 192  * Returns: the #ModestTnySendQueue singleton instance for this account
 193  * (ie., one singleton per account). This should NOT be unref'd.
 194  **/
 195 ModestTnySendQueue* modest_runtime_get_send_queue        (TnyTransportAccount *account);
 196
 197
 198
 199 /**
 200  * modest_runtime_verify_object_death
 201  * @OBJ: some (GObject) ptr
 202  * @NAME: name of @OBJ
 203  *
 204  * macro to check whether @obj is 'dead', ie, it is no longer a valid GObject. If
 205  * not, a g_warning will be issued on stderr. NOTE: this is only active
 206  * when MODEST_DEBUG contains "debug-objects".
 207  *
 208  ***/
 209 #define modest_runtime_verify_object_death(OBJ,name)                    \
 210         do {                                                            \
 211                 if (modest_runtime_get_debug_flags() & MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS) \
 212                         if (G_IS_OBJECT(OBJ))                           \
 213                                 g_warning ("%s:%d: %s ("        \
 214                                            #OBJ ") still holds a ref count of %d", \
 215                                            __FILE__,__LINE__,name, G_OBJECT(OBJ)->ref_count); \
 216         } while (0)
 217
 218
 219
 220 /**
 221  * modest_runtime_not_implemented
 222  * @WIN: the parent GtkWindow, or NULL
 223  *
 224  * give a not-implemented-yet warning popup or g_warning
 225  *
 226  ***/
 227 #define modest_runtime_not_implemented(WIN)    \
 228         do {                                   \
 229                 if (gtk_main_level() > 0) {    \
 230                         GtkWidget *popup;      \
 231                         popup = gtk_message_dialog_new (WIN,\
 232                                                         GTK_DIALOG_MODAL|GTK_DIALOG_DESTROY_WITH_PARENT,\
 233                                                         GTK_MESSAGE_WARNING, \
 234                                                         GTK_BUTTONS_OK, \
 235                                                         "Not yet implemented");\
 236                         gtk_dialog_run (GTK_DIALOG(popup));             \
 237                         gtk_widget_destroy (popup);                     \
 238                 } else                                                  \
 239                         g_warning ("%s:%d: Not yet implemented",__FILE__,__LINE__); \
 240         } while (0)                                                     \
 241
 242
 243 G_END_DECLS
 244
 245 #endif /*__MODEST_RUNTIME_H__*/