* cleanup: moved init stuff to modest-init.[ch]
[modest] / src / modest-init.h
1 /* Copyright (c) 2006, 2007 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_INIT_H__
31 #define __MODEST_INIT_H__
32
33 #include <glib.h>
34 #include <glib-object.h>
35
36 G_BEGIN_DECLS
37
38 #define MODEST_DEBUG "MODEST_DEBUG"
39
40 typedef enum {
41         MODEST_INIT_DEBUG_ABORT_ON_WARNING      = 1 << 0,
42         MODEST_INIT_DEBUG_LOG_ACTIONS           = 1 << 1, /* not in use atm */
43         MODEST_INIT_DEBUG_DEBUG_OBJECTS         = 1 << 2, /* for g_type_init */
44         MODEST_INIT_DEBUG_DEBUG_SIGNALS         = 1 << 3, /* for g_type_init */
45         MODEST_INIT_DEBUG_FACTORY_SETTINGS      = 1 << 4  /* reset to factory defaults */
46 } ModestInitDebugFlags;
47
48 /**
49  * modest_init_init_core:
50  *
51  * initialize the modest runtime system (which sets up the
52  * environment, instantiates singletons and so on)
53  * modest_runtime_init should only be called once, and
54  * when done with it, modest_runtime_uninit should be called
55  *  
56  * TRUE if this succeeded, FALSE otherwise.
57  */
58 gboolean modest_init_init_core (void);
59
60
61 /**
62  * modest_init_init_ui:
63  * @argc: the #argc argument to the main function
64  * @argv: the #argv argument to the main function
65  * 
66  * initialize the modest UI; this replaces the call to
67  * gtk_init
68  *  
69  * TRUE if this succeeded, FALSE otherwise.
70  */
71 gboolean modest_init_init_ui (gint argc, gchar** argv);
72
73 /**
74  * modest_init_uninit:
75  *
76  * uninitialize the modest runtime system; free all the
77  * resources and so on.
78  *
79  * TRUE if this succeeded, FALSE otherwise
80  */
81 gboolean modest_init_uninit (void);
82
83 G_END_DECLS
84
85 #endif /*__MODEST_INIT_H__*/