Fix modest_tny_msg_header_get_all_recipients_list (in case from is empty)
[modest] / 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-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
49 G_BEGIN_DECLS
50
51 #define MODEST_DEBUG "MODEST_DEBUG"
52
53 typedef enum {
54         MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING      = 1 << 0,
55         MODEST_RUNTIME_DEBUG_LOG_ACTIONS           = 1 << 1, /* not in use atm */
56         MODEST_RUNTIME_DEBUG_OBJECTS               = 1 << 2, /* for g_type_init */
57         MODEST_RUNTIME_DEBUG_SIGNALS               = 1 << 3, /* for g_type_init */
58         MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS      = 1 << 4, /* reset to factory defaults */
59         MODEST_RUNTIME_DEBUG_CODE                  = 1 << 5  /* print various debugging messages */
60 } ModestRuntimeDebugFlags;
61
62 /**
63  * modest_runtime_init:
64  *
65  * initialize the modest runtime system (which sets up the
66  * environment, instantiates singletons and so on)
67  * modest_runtime_init should only be called once, and
68  * when done with it, modest_runtime_uninit should be called
69  *
70  * TRUE if this succeeded, FALSE otherwise.
71  */
72 gboolean modest_runtime_init (void);
73
74
75 /**
76  * modest_runtime_uinit:
77  *
78  * uninitialize the modest runtime system; free all the
79  * resources and so on.
80  *
81  * TRUE if this succeeded, FALSE otherwise
82  */
83 gboolean modest_runtime_uninit (void);
84
85
86 /**
87  * modest_runtime_get_debug_flags
88  *
89  * get the debug flags for modest; they are read from the MODEST_DEBUG
90  * environment variable; the flags specified as strings, separated by ':'.
91  * Possible values are:
92  * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
93  * useful when running in debugger
94  * - "log-actions": log user actions (not in use atm)
95  * - "debug-objects": track the use of (g)objects in the program. this option influences
96  *  g_type_init_with_debug_flags
97  *  - "debug-signals": track the use of (g)signals in the program. this option influences
98  *  g_type_init_with_debug_flags
99  * if you would want to track signals and log actions, you could do something like:
100  *  MODEST_DEBUG="log-actions:track-signals" ./modest
101  * NOTE that the flags will stay the same during the run of the program, even
102  * if the environment variable changes.
103  * 
104  * Returns: the bitwise OR of the debug flags
105  */
106 ModestRuntimeDebugFlags modest_runtime_get_debug_flags  (void) G_GNUC_CONST;
107
108 /**
109  * modest_runtime_get_conf:
110  * 
111  * get the ModestConf singleton instance
112  * 
113  * Returns: the ModestConf singleton. This should NOT be unref'd.
114  **/
115 ModestConf*         modest_runtime_get_conf   (void);
116
117
118 /**
119  * modest_runtime_get_account_mgr:
120  * 
121  * get the ModestAccountMgr singleton instance
122  * 
123  * Returns: the ModestAccountMgr singleton. This should NOT be unref'd.
124  **/
125 ModestAccountMgr*         modest_runtime_get_account_mgr   (void);
126
127 /**
128  * modest_runtime_get_images_cache:
129  * 
130  * get the images #TnyStreamCache singleton instance
131  * 
132  * Returns: the images #TnyStreamCache singleton. This should NOT be unref'd.
133  **/
134 TnyStreamCache*         modest_runtime_get_images_cache   (void);
135
136 /**
137  * modest_runtime_get_email_clipboard:
138  * 
139  * get the #ModestEmailClipboard singleton instance
140  * 
141  * Returns: the #ModestEamilClipboard singleton. This should NOT be unref'd.
142  **/
143 ModestEmailClipboard*     modest_runtime_get_email_clipboard   (void);
144
145 /**
146  * modest_runtime_get_account_store:
147  * 
148  * get the ModestTnyAccountStore singleton instance
149  *
150  * Returns: the ModestTnyAccountStore singleton. This should NOT be unref'd.
151  **/
152 ModestTnyAccountStore*    modest_runtime_get_account_store (void);
153
154
155 /**
156  * modest_runtime_get_cache_mgr:
157  * 
158  * get the ModestCacheMgr singleton instance
159  *
160  * Returns: the #ModestCacheMgr singleton. This should NOT be unref'd.
161  **/
162 ModestCacheMgr*           modest_runtime_get_cache_mgr     (void);
163
164
165
166 /**
167  * modest_runtime_get_device:
168  * 
169  * get the #TnyDevice singleton instance
170  *
171  * Returns: the #TnyDevice singleton. This should NOT be unref'd.
172  **/
173 TnyDevice*                    modest_runtime_get_device     (void);
174
175
176 /**
177  * modest_runtime_get_platform_factory:
178  * 
179  * get the #TnyPlatformFactory singleton instance
180  *
181  * Returns: the #TnyPlatformFactory singleton. This should NOT be unref'd.
182  **/
183 TnyPlatformFactory*           modest_runtime_get_platform_factory     (void);
184
185
186
187
188 /**
189  * modest_runtime_get_mail_operation_queue:
190  * 
191  * get the #ModestMailOperationQueue singleton instance
192  *
193  * Returns: the #ModestMailOperationQueue singleton. This should NOT be unref'd.
194  **/
195 ModestMailOperationQueue* modest_runtime_get_mail_operation_queue (void);
196
197
198 /**
199  * modest_runtime_get_send_queue:
200  * @account: a valid TnyTransportAccount
201  * @create: whether or not a new send queue should be created if it does not exist
202  * 
203  * get the send queue for the given account
204  *
205  * Returns: the #ModestTnySendQueue singleton instance for this account
206  * (ie., one singleton per account). This should NOT be unref'd.
207  **/
208 ModestTnySendQueue* modest_runtime_get_send_queue        (TnyTransportAccount *account,
209                                                           gboolean create);
210
211 /**
212  * modest_runtime_remove_send_queue:
213  * @account: a #TnyTransportAccount
214  * 
215  * Removes the send queue associated with the given transport account
216  **/
217 void modest_runtime_remove_send_queue (TnyTransportAccount *account);
218
219 /**
220  * modest_runtime_remove_all_send_queues:
221  * 
222  * Removes all send queues, ready for them to be recreated, for instance 
223  * with a new connection.
224  **/
225 void modest_runtime_remove_all_send_queues ();
226
227 /**
228  * modest_runtime_get_window_mgr:
229  *
230  * get the #ModestWindowMgr singleton instance
231  *
232  * Returns: the #ModestWindowMgr singleton. This should NOT be unref'd.
233  **/
234 ModestWindowMgr* modest_runtime_get_window_mgr (void);
235
236 /**
237  * modest_runtime_get_protocol_registry:
238  *
239  * get the #ModestProtocolRegistry singleton instance
240  *
241  * Returns: the #ModestProtocolRegistry singleton. This should NOT be unref'd.
242  **/
243 ModestProtocolRegistry* modest_runtime_get_protocol_registry (void);
244
245 /**
246  * modest_runtime_get_plugin_factory:
247  *
248  * get the #ModestPluginFactory singleton instance
249  *
250  * Returns: the #ModestPluginFactory singleton. This should NOT be unref'd.
251  **/
252 ModestPluginFactory * modest_runtime_get_plugin_factory (void);
253
254 /**
255  * modest_runtime_get_allow_shutdown:
256  *
257  * tell if Modest will shutdown when window list and mail op queue are empty
258  *
259  * Returns: %TRUE if modest shutdown is allowed, %FALSE otherwise
260  */
261 gboolean modest_runtime_get_allow_shutdown (void);
262
263 /**
264  * modest_runtime_get_allow_shutdown:
265  * @allow: a #gboolean
266  *
267  * set if Modest will shutdown when window list and mail op queue are empty
268  *
269  */
270 void modest_runtime_set_allow_shutdown (gboolean allow);
271
272 G_END_DECLS
273
274 #endif /*__MODEST_RUNTIME_H__*/