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-widget-factory.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 } ModestRuntimeDebugFlags;
54 * modest_runtime_init:
56 * initialize the modest runtime system (which sets up the
57 * environment, instantiates singletons and so on)
58 * modest_runtime_init should only be called once, and
59 * when done with it, modest_runtime_uninit should be called
61 * TRUE if this succeeded, FALSE otherwise.
63 gboolean modest_runtime_init (void);
67 * modest_runtime_uinit:
69 * uninitialize the modest runtime system; free all the
70 * resources and so on.
72 * TRUE if this succeeded, FALSE otherwise
74 gboolean modest_runtime_uninit (void);
78 * modest_runtime_get_debug_flags
80 * get the debug flags for modest; they are read from the MODEST_DEBUG
81 * environment variable; the flags specified as strings, separated by ':'.
82 * Possible values are:
83 * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
84 * useful when running in debugger
85 * - "log-actions": log user actions (not in use atm)
86 * - "track-object": track the use of (g)objects in the program. this option influences
87 * g_type_init_with_debug_flags
88 * - "track-signals": track the use of (g)signals in the program. this option influences
89 * g_type_init_with_debug_flags
90 * - "disable-cache": disable caching of strings and pixbuf
91 * if you would want to track signals and log actions, you could do something like:
92 * MODEST_DEBUG="log-actions:track-signals" ./modest
93 * NOTE that the flags will stay the same during the run of the program, even
94 * if the environment variable changes.
96 * Returns: the bitwise OR of the debug flags
98 ModestRuntimeDebugFlags modest_runtime_get_debug_flags (void) G_GNUC_CONST;
101 * modest_runtime_get_conf:
103 * get the ModestConf singleton instance
105 * Returns: the ModestConf singleton
107 ModestConf* modest_runtime_get_conf (void);
111 * modest_runtime_get_account_mgr:
113 * get the ModestAccountMgr singleton instance
115 * Returns: the ModestAccountMgr singleton
117 ModestAccountMgr* modest_runtime_get_account_mgr (void);
120 * modest_runtime_get_account_store:
122 * get the ModestTnyAccountStore singleton instance
124 * Returns: the ModestTnyAccountStore singleton
126 ModestTnyAccountStore* modest_runtime_get_account_store (void);
130 * modest_runtime_get_cache_mgr:
132 * get the ModestCacheMgr singleton instance
134 * Returns: the ModestCacheMgr singleton
136 ModestCacheMgr* modest_runtime_get_cache_mgr (void);
140 * modest_runtime_get_mail_operation_queue:
142 * get the ModestMailOperationQueue singleton instance
144 * Returns: the ModestMailOperationQueue singleton
146 ModestMailOperationQueue* modest_runtime_get_mail_operation_queue (void);
150 * modest_runtime_get_widget_factory
152 * get the ModestWidgetFactory singleton instance
154 * Returns: the ModestCacheMgr singleton
156 ModestWidgetFactory* modest_runtime_get_widget_factory (void);
161 #endif /*__MODEST_RUNTIME_H__*/