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-mail-operation-queue.h>
39 #include <modest-tny-account-store.h>
40 #include <modest-tny-send-queue.h>
41 #include <tny-platform-factory.h>
45 #define MODEST_DEBUG "MODEST_DEBUG"
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;
56 * modest_runtime_init:
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
63 * TRUE if this succeeded, FALSE otherwise.
65 gboolean modest_runtime_init (void);
69 * modest_runtime_init_ui:
70 * @argc: the #argc argument to the main function
71 * @argv: the #argv argument to the main function
73 * initialize the modest UI; this replaces the call to
76 * TRUE if this succeeded, FALSE otherwise.
78 gboolean modest_runtime_init_ui (gint argc, gchar** argv);
81 * modest_runtime_uinit:
83 * uninitialize the modest runtime system; free all the
84 * resources and so on.
86 * TRUE if this succeeded, FALSE otherwise
88 gboolean modest_runtime_uninit (void);
92 * modest_runtime_get_debug_flags
94 * get the debug flags for modest; they are read from the MODEST_DEBUG
95 * environment variable; the flags specified as strings, separated by ':'.
96 * Possible values are:
97 * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
98 * useful when running in debugger
99 * - "log-actions": log user actions (not in use atm)
100 * - "debug-objects": track the use of (g)objects in the program. this option influences
101 * g_type_init_with_debug_flags
102 * - "debug-signals": track the use of (g)signals in the program. this option influences
103 * g_type_init_with_debug_flags
104 * if you would want to track signals and log actions, you could do something like:
105 * MODEST_DEBUG="log-actions:track-signals" ./modest
106 * NOTE that the flags will stay the same during the run of the program, even
107 * if the environment variable changes.
109 * Returns: the bitwise OR of the debug flags
111 ModestRuntimeDebugFlags modest_runtime_get_debug_flags (void) G_GNUC_CONST;
114 * modest_runtime_get_conf:
116 * get the ModestConf singleton instance
118 * Returns: the ModestConf singleton. This should NOT be unref'd.
120 ModestConf* modest_runtime_get_conf (void);
124 * modest_runtime_get_account_mgr:
126 * get the ModestAccountMgr singleton instance
128 * Returns: the ModestAccountMgr singleton. This should NOT be unref'd.
130 ModestAccountMgr* modest_runtime_get_account_mgr (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);
199 #endif /*__MODEST_RUNTIME_H__*/