* check for a valid foldername
[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 <tny-platform-factory.h>
43 #include "widgets/modest-window-mgr.h"
44
45 G_BEGIN_DECLS
46
47 #define MODEST_DEBUG "MODEST_DEBUG"
48
49 typedef enum {
50         MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING      = 1 << 0,
51         MODEST_RUNTIME_DEBUG_LOG_ACTIONS           = 1 << 1, /* not in use atm */
52         MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS         = 1 << 2, /* for g_type_init */
53         MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS         = 1 << 3, /* for g_type_init */
54         MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS      = 1 << 4  /* reset to factory defaults */
55 } ModestRuntimeDebugFlags;
56
57 /**
58  * modest_runtime_init:
59  *
60  * initialize the modest runtime system (which sets up the
61  * environment, instantiates singletons and so on)
62  * modest_runtime_init should only be called once, and
63  * when done with it, modest_runtime_uninit should be called
64  *  
65  * TRUE if this succeeded, FALSE otherwise.
66  */
67 gboolean modest_runtime_init (void);
68
69
70 /**
71  * modest_runtime_uinit:
72  *
73  * uninitialize the modest runtime system; free all the
74  * resources and so on.
75  *
76  * TRUE if this succeeded, FALSE otherwise
77  */
78 gboolean modest_runtime_uninit (void);
79         
80
81 /**
82  * modest_runtime_get_debug_flags 
83  *
84  * get the debug flags for modest; they are read from the MODEST_DEBUG
85  * environment variable; the flags specified as strings, separated by ':'.
86  * Possible values are:
87  * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
88  * useful when running in debugger
89  * - "log-actions": log user actions (not in use atm)
90  * - "debug-objects": track the use of (g)objects in the program. this option influences
91  *  g_type_init_with_debug_flags
92  *  - "debug-signals": track the use of (g)signals in the program. this option influences
93  *  g_type_init_with_debug_flags
94  * if you would want to track signals and log actions, you could do something like:
95  *  MODEST_DEBUG="log-actions:track-signals" ./modest
96  * NOTE that the flags will stay the same during the run of the program, even
97  * if the environment variable changes.
98  * 
99  * Returns: the bitwise OR of the debug flags
100  */
101 ModestRuntimeDebugFlags modest_runtime_get_debug_flags  (void) G_GNUC_CONST;
102
103 /**
104  * modest_runtime_get_conf:
105  * 
106  * get the ModestConf singleton instance
107  * 
108  * Returns: the ModestConf singleton. This should NOT be unref'd.
109  **/
110 ModestConf*         modest_runtime_get_conf   (void);
111
112
113 /**
114  * modest_runtime_get_account_mgr:
115  * 
116  * get the ModestAccountMgr singleton instance
117  * 
118  * Returns: the ModestAccountMgr singleton. This should NOT be unref'd.
119  **/
120 ModestAccountMgr*         modest_runtime_get_account_mgr   (void);
121
122 /**
123  * modest_runtime_get_email_clipboard:
124  * 
125  * get the #ModestEmailClipboard singleton instance
126  * 
127  * Returns: the #ModestEamilClipboard singleton. This should NOT be unref'd.
128  **/
129 ModestEmailClipboard*     modest_runtime_get_email_clipboard   (void);
130
131 /**
132  * modest_runtime_get_account_store:
133  * 
134  * get the ModestTnyAccountStore singleton instance
135  *
136  * Returns: the ModestTnyAccountStore singleton. This should NOT be unref'd.
137  **/
138 ModestTnyAccountStore*    modest_runtime_get_account_store (void);
139
140
141 /**
142  * modest_runtime_get_cache_mgr:
143  * 
144  * get the ModestCacheMgr singleton instance
145  *
146  * Returns: the #ModestCacheMgr singleton. This should NOT be unref'd.
147  **/
148 ModestCacheMgr*           modest_runtime_get_cache_mgr     (void);
149
150
151
152 /**
153  * modest_runtime_get_device:
154  * 
155  * get the #TnyDevice singleton instance
156  *
157  * Returns: the #TnyDevice singleton. This should NOT be unref'd.
158  **/
159 TnyDevice*                    modest_runtime_get_device     (void);
160
161
162 /**
163  * modest_runtime_get_platform_factory:
164  * 
165  * get the #TnyPlatformFactory singleton instance
166  *
167  * Returns: the #TnyPlatformFactory singleton. This should NOT be unref'd.
168  **/
169 TnyPlatformFactory*           modest_runtime_get_platform_factory     (void);
170
171
172
173
174 /**
175  * modest_runtime_get_mail_operation_queue:
176  * 
177  * get the #ModestMailOperationQueue singleton instance
178  *
179  * Returns: the #ModestMailOperationQueue singleton. This should NOT be unref'd.
180  **/
181 ModestMailOperationQueue* modest_runtime_get_mail_operation_queue (void);
182
183
184 /**
185  * modest_runtime_get_send_queue:
186  * @account: a valid TnyTransportAccount
187  * 
188  * get the send queue for the given account
189  *
190  * Returns: the #ModestTnySendQueue singleton instance for this account
191  * (ie., one singleton per account). This should NOT be unref'd.
192  **/
193 ModestTnySendQueue* modest_runtime_get_send_queue        (TnyTransportAccount *account);
194
195 /**
196  * modest_runtime_remove_all_send_queues:
197  * 
198  * Removes all send queues, ready for them to be recreated, for instance 
199  * with a new connection.
200  **/
201 void modest_runtime_remove_all_send_queues ();
202
203 /**
204  * modest_runtime_get_window_mgr:
205  *
206  * get the #ModestWindowMgr singleton instance
207  *
208  * Returns: the #ModestWindowMgr singleton. This should NOT be unref'd.
209  **/
210 ModestWindowMgr* modest_runtime_get_window_mgr (void);
211
212 /**
213  * modest_runtime_verify_object_last_ref
214  * @OBJ: some (GObject) ptr
215  * @NAME: name of @OBJ
216  * 
217  * macro to check whether @obj holds only one more ref (ie. after the
218  * next unref it will die)
219  * 
220  * not, a g_warning will be issued on stderr. NOTE: this is only active
221  * when MODEST_DEBUG contains "debug-objects".
222  *
223  ***/
224 #define modest_runtime_verify_object_last_ref(OBJ,name)                                                \
225         do {                                                                                           \
226                 if (modest_runtime_get_debug_flags() & MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS)             \
227                         if (G_IS_OBJECT(OBJ) && G_OBJECT(OBJ)->ref_count != 1)                         \
228                                 g_warning ("%s:%d: %s ("                                               \
229                                            #OBJ ") still holds a ref count of %d",                     \
230                                            __FILE__,__LINE__,name, G_OBJECT(OBJ)->ref_count);          \
231         } while (0)
232
233
234
235 /**
236  * modest_runtime_not_implemented
237  * @WIN: the parent GtkWindow, or NULL
238  *
239  * give a not-implemented-yet warning popup or g_warning
240  *
241  ***/
242 #define modest_runtime_not_implemented(WIN)    \
243         do {                                   \
244                 if (gtk_main_level() > 0) {    \
245                         GtkWidget *popup;      \
246                         popup = gtk_message_dialog_new (WIN,\
247                                                         GTK_DIALOG_MODAL|GTK_DIALOG_DESTROY_WITH_PARENT,\
248                                                         GTK_MESSAGE_WARNING, \
249                                                         GTK_BUTTONS_OK, \
250                                                         "Not yet implemented");\
251                         gtk_dialog_run (GTK_DIALOG(popup));             \
252                         gtk_widget_destroy (popup);                     \
253                 } else                                                  \
254                         g_warning ("%s:%d: Not yet implemented",__FILE__,__LINE__); \
255         } while (0)                                                     \
256
257
258 G_END_DECLS
259
260 #endif /*__MODEST_RUNTIME_H__*/