1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_RUNTIME_H__
31 #define __MODEST_RUNTIME_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"
48 #define MODEST_DEBUG "MODEST_DEBUG"
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_DEBUG_OBJECTS = 1 << 2, /* for g_type_init */
54 MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS = 1 << 3, /* for g_type_init */
55 MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS = 1 << 4 /* reset to factory defaults */
56 } ModestRuntimeDebugFlags;
59 * modest_runtime_init:
61 * initialize the modest runtime system (which sets up the
62 * environment, instantiates singletons and so on)
63 * modest_runtime_init should only be called once, and
64 * when done with it, modest_runtime_uninit should be called
66 * TRUE if this succeeded, FALSE otherwise.
68 gboolean modest_runtime_init (void);
72 * modest_runtime_uinit:
74 * uninitialize the modest runtime system; free all the
75 * resources and so on.
77 * TRUE if this succeeded, FALSE otherwise
79 gboolean modest_runtime_uninit (void);
83 * modest_runtime_get_debug_flags
85 * get the debug flags for modest; they are read from the MODEST_DEBUG
86 * environment variable; the flags specified as strings, separated by ':'.
87 * Possible values are:
88 * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
89 * useful when running in debugger
90 * - "log-actions": log user actions (not in use atm)
91 * - "debug-objects": track the use of (g)objects in the program. this option influences
92 * g_type_init_with_debug_flags
93 * - "debug-signals": track the use of (g)signals in the program. this option influences
94 * g_type_init_with_debug_flags
95 * if you would want to track signals and log actions, you could do something like:
96 * MODEST_DEBUG="log-actions:track-signals" ./modest
97 * NOTE that the flags will stay the same during the run of the program, even
98 * if the environment variable changes.
100 * Returns: the bitwise OR of the debug flags
102 ModestRuntimeDebugFlags modest_runtime_get_debug_flags (void) G_GNUC_CONST;
105 * modest_runtime_get_conf:
107 * get the ModestConf singleton instance
109 * Returns: the ModestConf singleton. This should NOT be unref'd.
111 ModestConf* modest_runtime_get_conf (void);
115 * modest_runtime_get_account_mgr:
117 * get the ModestAccountMgr singleton instance
119 * Returns: the ModestAccountMgr singleton. This should NOT be unref'd.
121 ModestAccountMgr* modest_runtime_get_account_mgr (void);
124 * modest_runtime_get_email_clipboard:
126 * get the #ModestEmailClipboard singleton instance
128 * Returns: the #ModestEamilClipboard singleton. This should NOT be unref'd.
130 ModestEmailClipboard* modest_runtime_get_email_clipboard (void);
133 * modest_runtime_get_account_store:
135 * get the ModestTnyAccountStore singleton instance
137 * Returns: the ModestTnyAccountStore singleton. This should NOT be unref'd.
139 ModestTnyAccountStore* modest_runtime_get_account_store (void);
143 * modest_runtime_get_cache_mgr:
145 * get the ModestCacheMgr singleton instance
147 * Returns: the #ModestCacheMgr singleton. This should NOT be unref'd.
149 ModestCacheMgr* modest_runtime_get_cache_mgr (void);
154 * modest_runtime_get_device:
156 * get the #TnyDevice singleton instance
158 * Returns: the #TnyDevice singleton. This should NOT be unref'd.
160 TnyDevice* modest_runtime_get_device (void);
164 * modest_runtime_get_platform_factory:
166 * get the #TnyPlatformFactory singleton instance
168 * Returns: the #TnyPlatformFactory singleton. This should NOT be unref'd.
170 TnyPlatformFactory* modest_runtime_get_platform_factory (void);
176 * modest_runtime_get_mail_operation_queue:
178 * get the #ModestMailOperationQueue singleton instance
180 * Returns: the #ModestMailOperationQueue singleton. This should NOT be unref'd.
182 ModestMailOperationQueue* modest_runtime_get_mail_operation_queue (void);
186 * modest_runtime_get_send_queue:
187 * @account: a valid TnyTransportAccount
189 * get the send queue for the given account
191 * Returns: the #ModestTnySendQueue singleton instance for this account
192 * (ie., one singleton per account). This should NOT be unref'd.
194 ModestTnySendQueue* modest_runtime_get_send_queue (TnyTransportAccount *account);
197 * modest_runtime_remove_all_send_queues:
199 * Removes all send queues, ready for them to be recreated, for instance
200 * with a new connection.
202 void modest_runtime_remove_all_send_queues ();
205 * modest_runtime_get_window_mgr:
207 * get the #ModestWindowMgr singleton instance
209 * Returns: the #ModestWindowMgr singleton. This should NOT be unref'd.
211 ModestWindowMgr* modest_runtime_get_window_mgr (void);
214 * modest_runtime_verify_object_last_ref
215 * @OBJ: some (GObject) ptr
216 * @NAME: name of @OBJ
218 * macro to check whether @obj holds only one more ref (ie. after the
219 * next unref it will die)
221 * not, a g_warning will be issued on stderr. NOTE: this is only active
222 * when MODEST_DEBUG contains "debug-objects".
225 #define modest_runtime_verify_object_last_ref(OBJ,name) \
227 if (modest_runtime_get_debug_flags() & MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS) \
228 if (G_IS_OBJECT(OBJ) && G_OBJECT(OBJ)->ref_count != 1) \
229 g_warning ("%s:%d: %s (" \
230 #OBJ ") still holds a ref count of %d", \
231 __FILE__,__LINE__,name, G_OBJECT(OBJ)->ref_count); \
237 * modest_runtime_not_implemented
238 * @WIN: the parent GtkWindow, or NULL
240 * give a not-implemented-yet warning popup or g_warning
243 #define modest_runtime_not_implemented(WIN) \
245 if (gtk_main_level() > 0) { \
247 popup = gtk_message_dialog_new (WIN,\
248 GTK_DIALOG_MODAL|GTK_DIALOG_DESTROY_WITH_PARENT,\
249 GTK_MESSAGE_WARNING, \
251 "Not yet implemented");\
252 gtk_dialog_run (GTK_DIALOG(popup)); \
253 gtk_widget_destroy (popup); \
255 g_warning ("%s:%d: Not yet implemented",__FILE__,__LINE__); \
261 #endif /*__MODEST_RUNTIME_H__*/