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>
44 #define MODEST_DEBUG "MODEST_DEBUG"
47 MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING = 1 << 0,
48 MODEST_RUNTIME_DEBUG_LOG_ACTIONS = 1 << 1, /* not in use atm */
49 MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS = 1 << 2, /* for g_type_init */
50 MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS = 1 << 3, /* for g_type_init */
51 MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS = 1 << 4, /* reset to factory defaults */
52 } ModestRuntimeDebugFlags;
55 * modest_runtime_init:
57 * initialize the modest runtime system (which sets up the
58 * environment, instantiates singletons and so on)
59 * modest_runtime_init should only be called once, and
60 * when done with it, modest_runtime_uninit should be called
62 * TRUE if this succeeded, FALSE otherwise.
64 gboolean modest_runtime_init (void);
68 * modest_runtime_init_ui:
69 * @argc: the #argc argument to the main function
70 * @argv: the #argv argument to the main function
72 * initialize the modest UI; this replaces the call to
75 * TRUE if this succeeded, FALSE otherwise.
77 gboolean modest_runtime_init_ui (gint argc, gchar** argv);
80 * modest_runtime_uinit:
82 * uninitialize the modest runtime system; free all the
83 * resources and so on.
85 * TRUE if this succeeded, FALSE otherwise
87 gboolean modest_runtime_uninit (void);
91 * modest_runtime_get_debug_flags
93 * get the debug flags for modest; they are read from the MODEST_DEBUG
94 * environment variable; the flags specified as strings, separated by ':'.
95 * Possible values are:
96 * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
97 * useful when running in debugger
98 * - "log-actions": log user actions (not in use atm)
99 * - "track-object": track the use of (g)objects in the program. this option influences
100 * g_type_init_with_debug_flags
101 * - "track-signals": track the use of (g)signals in the program. this option influences
102 * g_type_init_with_debug_flags
103 * - "disable-cache": disable caching of strings and pixbuf
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
120 ModestConf* modest_runtime_get_conf (void);
124 * modest_runtime_get_account_mgr:
126 * get the ModestAccountMgr singleton instance
128 * Returns: the ModestAccountMgr singleton
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
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
149 ModestCacheMgr* modest_runtime_get_cache_mgr (void);
153 * modest_runtime_get_mail_operation_queue:
155 * get the #ModestMailOperationQueue singleton instance
157 * Returns: the #ModestMailOperationQueue singleton
159 ModestMailOperationQueue* modest_runtime_get_mail_operation_queue (void);
163 * modest_runtime_get_send_queue:
164 * @account: a valid TnyTransportAccount
166 * get the send queue for the given account
168 * Returns: the #ModestTnySendQueue singleton instance for this account
169 * (ie., one singleton per account)
171 ModestTnySendQueue* modest_runtime_get_send_queue (TnyTransportAccount *account);
176 #endif /*__MODEST_RUNTIME_H__*/