EINA API BREAK: no more individual modules init/shutdown.
[profile/ivi/eina.git] / src / lib / eina_main.c
1 /* EINA - EFL data type library
2  * Copyright (C) 2008 Cedric Bail
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library;
16  * if not, see <http://www.gnu.org/licenses/>.
17  */
18
19 #include <stdio.h>
20
21 #ifdef HAVE_CONFIG_H
22 # include "config.h"
23 #endif
24
25 #include "eina_config.h"
26 #include "eina_private.h"
27 #include "eina_types.h"
28 #include "eina_main.h"
29 #include "eina_error.h"
30 #include "eina_log.h"
31 #include "eina_hash.h"
32 #include "eina_stringshare.h"
33 #include "eina_list.h"
34 #include "eina_matrixsparse.h"
35 #include "eina_array.h"
36 #include "eina_counter.h"
37 #include "eina_benchmark.h"
38 #include "eina_magic.h"
39 #include "eina_rectangle.h"
40 #include "eina_safety_checks.h"
41
42 /*============================================================================*
43  *                                  Local                                     *
44  *============================================================================*/
45
46 /**
47  * @cond LOCAL
48  */
49
50 static int _eina_main_count = 0;
51 static int _eina_log_dom = -1;
52 #define ERR(...) EINA_LOG_DOM_ERR(_eina_log_dom, __VA_ARGS__)
53 #define DBG(...) EINA_LOG_DOM_DBG(_eina_log_dom, __VA_ARGS__)
54
55
56 /* place module init/shutdown functions here to avoid other modules
57  * calling them by mistake.
58  */
59 #define S(x) extern Eina_Bool eina_##x##_init(void); extern Eina_Bool eina_##x##_shutdown(void)
60 S(log);
61 S(error);
62 S(safety_checks);
63 S(magic_string);
64 S(array);
65 S(module);
66 S(mempool);
67 S(list);
68 S(stringshare);
69 S(matrixsparse);
70 S(convert);
71 S(counter);
72 S(benchmark);
73 S(rectangle);
74 #undef S
75
76 struct eina_desc_setup
77 {
78    const char *name;
79    Eina_Bool (*init)(void);
80    Eina_Bool (*shutdown)(void);
81 };
82
83 static const struct eina_desc_setup _eina_desc_setup[] = {
84 #define S(x) {#x, eina_##x##_init, eina_##x##_shutdown}
85   /* log is a special case as it needs printf */
86   S(error),
87   S(safety_checks),
88   S(magic_string),
89   S(array),
90   S(module),
91   S(mempool),
92   S(list),
93   S(stringshare),
94   S(matrixsparse),
95   S(convert),
96   S(counter),
97   S(benchmark),
98   S(rectangle)
99 #undef S
100 };
101 static const size_t _eina_desc_setup_len = sizeof(_eina_desc_setup) / sizeof(_eina_desc_setup[0]);
102
103 static void
104 _eina_shutdown_from_desc(const struct eina_desc_setup *itr)
105 {
106    for (itr--; itr >= _eina_desc_setup; itr--)
107      {
108         if (!itr->shutdown())
109           ERR("Problems shutting down eina module '%s', ignored.", itr->name);
110      }
111
112    eina_log_domain_unregister(_eina_log_dom);
113    _eina_log_dom = -1;
114    eina_log_shutdown();
115 }
116
117 /**
118  * @endcond
119  */
120
121 /*============================================================================*
122  *                                 Global                                     *
123  *============================================================================*/
124
125 /*============================================================================*
126  *                                   API                                      *
127  *============================================================================*/
128
129 /**
130  * @addtogroup Eina_Main_Group Main
131  *
132  * @brief These functions provide general initialisation and shut down
133  * functions.
134  *
135  * @{
136  */
137
138 /**
139  * @brief Initialize the Eina library.
140  *
141  * @return 1 or greater on success, 0 on error.
142  *
143  * This function sets up all the eina modules. It returns 0 on
144  * failure (that is, when one of the module fails to initialize),
145  * otherwise it returns the number of times it has already been
146  * called.
147  *
148  * When Eina is not used anymore, call eina_shutdown() to shut down
149  * the Eina library.
150  */
151 EAPI int
152 eina_init(void)
153 {
154    const struct eina_desc_setup *itr, *itr_end;
155
156    if (EINA_LIKELY(_eina_main_count > 0))
157      return ++_eina_main_count;
158
159    if (!eina_log_init())
160      {
161         fprintf(stderr, "Could not initialize eina logging system.\n");
162         return 0;
163      }
164    _eina_log_dom = eina_log_domain_register("eina", EINA_LOG_COLOR_DEFAULT);
165    if (_eina_log_dom < 0)
166      {
167         EINA_LOG_ERR("Could not register log domain: eina");
168         eina_log_shutdown();
169         return 0;
170      }
171
172    itr = _eina_desc_setup;
173    itr_end = itr + _eina_desc_setup_len;
174    for (; itr < itr_end; itr++)
175      {
176         if (!itr->init())
177           {
178              ERR("Could not initialize eina module '%s'.", itr->name);
179              _eina_shutdown_from_desc(itr);
180              return 0;
181           }
182      }
183
184    _eina_main_count = 1;
185    return 1;
186 }
187
188 /**
189  * @brief Shut down the Eina library.
190  *
191  * @return 0 when all the modules is completely shut down, 1 or
192  * greater otherwise.
193  *
194  * This function shuts down the Eina library. It returns 0 when it has
195  * been called the same number of times than eina_init(). In that case
196  * it shut down all the Eina modules.
197  *
198  * Once this function succeeds (that is, @c 0 is returned), you must
199  * not call any of the Eina function anymore. You must call
200  * eina_init() again to use the Eina functions again.
201  */
202 EAPI int
203 eina_shutdown(void)
204 {
205    _eina_main_count--;
206    if (EINA_UNLIKELY(_eina_main_count == 0))
207      _eina_shutdown_from_desc(_eina_desc_setup + _eina_desc_setup_len);
208    return _eina_main_count;
209 }
210
211 /**
212  * @}
213  */