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"
45 #include <modest-protocol-registry.h>
46 #include <tny-stream-cache.h>
47 #include <modest-plugin-factory.h>
48 #include <widgets/modest-toolkit-factory.h>
52 #define MODEST_DEBUG "MODEST_DEBUG"
55 MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING = 1 << 0,
56 MODEST_RUNTIME_DEBUG_LOG_ACTIONS = 1 << 1, /* not in use atm */
57 MODEST_RUNTIME_DEBUG_OBJECTS = 1 << 2, /* for g_type_init */
58 MODEST_RUNTIME_DEBUG_SIGNALS = 1 << 3, /* for g_type_init */
59 MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS = 1 << 4, /* reset to factory defaults */
60 MODEST_RUNTIME_DEBUG_CODE = 1 << 5 /* print various debugging messages */
61 } ModestRuntimeDebugFlags;
64 * modest_runtime_init:
66 * initialize the modest runtime system (which sets up the
67 * environment, instantiates singletons and so on)
68 * modest_runtime_init should only be called once, and
69 * when done with it, modest_runtime_uninit should be called
71 * TRUE if this succeeded, FALSE otherwise.
73 gboolean modest_runtime_init (void);
77 * modest_runtime_uinit:
79 * uninitialize the modest runtime system; free all the
80 * resources and so on.
82 * TRUE if this succeeded, FALSE otherwise
84 gboolean modest_runtime_uninit (void);
88 * modest_runtime_get_debug_flags
90 * get the debug flags for modest; they are read from the MODEST_DEBUG
91 * environment variable; the flags specified as strings, separated by ':'.
92 * Possible values are:
93 * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
94 * useful when running in debugger
95 * - "log-actions": log user actions (not in use atm)
96 * - "debug-objects": track the use of (g)objects in the program. this option influences
97 * g_type_init_with_debug_flags
98 * - "debug-signals": track the use of (g)signals in the program. this option influences
99 * g_type_init_with_debug_flags
100 * if you would want to track signals and log actions, you could do something like:
101 * MODEST_DEBUG="log-actions:track-signals" ./modest
102 * NOTE that the flags will stay the same during the run of the program, even
103 * if the environment variable changes.
105 * Returns: the bitwise OR of the debug flags
107 ModestRuntimeDebugFlags modest_runtime_get_debug_flags (void) G_GNUC_CONST;
110 * modest_runtime_get_conf:
112 * get the ModestConf singleton instance
114 * Returns: the ModestConf singleton. This should NOT be unref'd.
116 ModestConf* modest_runtime_get_conf (void);
120 * modest_runtime_get_account_mgr:
122 * get the ModestAccountMgr singleton instance
124 * Returns: the ModestAccountMgr singleton. This should NOT be unref'd.
126 ModestAccountMgr* modest_runtime_get_account_mgr (void);
129 * modest_runtime_get_images_cache:
131 * get the images #TnyStreamCache singleton instance
133 * Returns: the images #TnyStreamCache singleton. This should NOT be unref'd.
135 TnyStreamCache* modest_runtime_get_images_cache (void);
138 * modest_runtime_get_email_clipboard:
140 * get the #ModestEmailClipboard singleton instance
142 * Returns: the #ModestEamilClipboard singleton. This should NOT be unref'd.
144 ModestEmailClipboard* modest_runtime_get_email_clipboard (void);
147 * modest_runtime_get_account_store:
149 * get the ModestTnyAccountStore singleton instance
151 * Returns: the ModestTnyAccountStore singleton. This should NOT be unref'd.
153 ModestTnyAccountStore* modest_runtime_get_account_store (void);
157 * modest_runtime_get_cache_mgr:
159 * get the ModestCacheMgr singleton instance
161 * Returns: the #ModestCacheMgr singleton. This should NOT be unref'd.
163 ModestCacheMgr* modest_runtime_get_cache_mgr (void);
168 * modest_runtime_get_device:
170 * get the #TnyDevice singleton instance
172 * Returns: the #TnyDevice singleton. This should NOT be unref'd.
174 TnyDevice* modest_runtime_get_device (void);
178 * modest_runtime_get_platform_factory:
180 * get the #TnyPlatformFactory singleton instance
182 * Returns: the #TnyPlatformFactory singleton. This should NOT be unref'd.
184 TnyPlatformFactory* modest_runtime_get_platform_factory (void);
187 * modest_runtime_get_toolkit_factory:
189 * get the #ModestToolkitFactory singleton instance
191 * Returns: the #ModestToolkitFactory singleton. This should NOT be unref'd.
193 ModestToolkitFactory* modest_runtime_get_toolkit_factory (void);
196 * modest_runtime_get_mail_operation_queue:
198 * get the #ModestMailOperationQueue singleton instance
200 * Returns: the #ModestMailOperationQueue singleton. This should NOT be unref'd.
202 ModestMailOperationQueue* modest_runtime_get_mail_operation_queue (void);
206 * modest_runtime_get_send_queue:
207 * @account: a valid TnyTransportAccount
208 * @create: whether or not a new send queue should be created if it does not exist
210 * get the send queue for the given account
212 * Returns: the #ModestTnySendQueue singleton instance for this account
213 * (ie., one singleton per account). This should NOT be unref'd.
215 ModestTnySendQueue* modest_runtime_get_send_queue (TnyTransportAccount *account,
219 * modest_runtime_remove_send_queue:
220 * @account: a #TnyTransportAccount
222 * Removes the send queue associated with the given transport account
224 void modest_runtime_remove_send_queue (TnyTransportAccount *account);
227 * modest_runtime_remove_all_send_queues:
229 * Removes all send queues, ready for them to be recreated, for instance
230 * with a new connection.
232 void modest_runtime_remove_all_send_queues ();
235 * modest_runtime_get_window_mgr:
237 * get the #ModestWindowMgr singleton instance
239 * Returns: the #ModestWindowMgr singleton. This should NOT be unref'd.
241 ModestWindowMgr* modest_runtime_get_window_mgr (void);
244 * modest_runtime_get_protocol_registry:
246 * get the #ModestProtocolRegistry singleton instance
248 * Returns: the #ModestProtocolRegistry singleton. This should NOT be unref'd.
250 ModestProtocolRegistry* modest_runtime_get_protocol_registry (void);
253 * modest_runtime_get_plugin_factory:
255 * get the #ModestPluginFactory singleton instance
257 * Returns: the #ModestPluginFactory singleton. This should NOT be unref'd.
259 ModestPluginFactory * modest_runtime_get_plugin_factory (void);
262 * modest_runtime_get_allow_shutdown:
264 * tell if Modest will shutdown when window list and mail op queue are empty
266 * Returns: %TRUE if modest shutdown is allowed, %FALSE otherwise
268 gboolean modest_runtime_get_allow_shutdown (void);
271 * modest_runtime_get_allow_shutdown:
272 * @allow: a #gboolean
274 * set if Modest will shutdown when window list and mail op queue are empty
277 void modest_runtime_set_allow_shutdown (gboolean allow);
281 #endif /*__MODEST_RUNTIME_H__*/