Fix the bug related to the empty version list
[bertos.git] / bertos / cfg / module.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2006 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief Debug macros for inter-module dependency checking.
34  *
35  * These macros expand to nothing in release builds.  In debug
36  * builds, they perform run-time dependency checks for modules.
37  *
38  * The usage pattern looks like this:
39  *
40  * \code
41  * MOD_DEFINE(phaser)
42  *
43  * void phaser_init(void)
44  * {
45  *     MOD_CHECK(computer);
46  *     MOD_CHECK(warp_core);
47  *
48  *    [...charge weapons...]
49  *
50  *    MOD_INIT(phaser);
51  * }
52  *
53  * void phaser_cleanup(void)
54  * {
55  *    MOD_CLEANUP(phaser);
56  *
57  *    [...disarm phaser...]
58  * }
59  * \endcode
60  *
61  * \version $Id$
62  * \author Bernie Innocenti <bernie@codewiz.org>
63  */
64 #ifndef CFG_MODULE_H
65 #define CFG_MODULE_H
66
67 #include <cfg/debug.h>
68
69 /**
70  * Declare a global variable for module dependency check.
71  *
72  * \see MOD_INIT(), MOD_CHECK()
73  */
74 #define MOD_DEFINE(module)   DB(extern bool module ## _initialized; bool module ## _initialized;)
75
76 /**
77  * Check that \a module was already initialized.
78  *
79  * Put this check just before accessing any facility
80  * provided by a module that requires prior initialization.
81  *
82  * \see MOD_INIT()
83  */
84
85 #define MOD_CHECK(module) \
86 do { \
87         DB(extern bool module ## _initialized;) \
88         ASSERT(module ## _initialized); \
89 } while (0)
90
91 /**
92  * Mark module as initialized.
93  *
94  * Marking initialization requires the global data
95  * previously defined by MOD_DEFINE().
96  *
97  * To prevent double initialization bugs, an initialized
98  * module must first be cleaned up with MOD_CLEANUP() before
99  * calling MOD_INIT() another time.
100  *
101  * \see MOD_CLEANUP(), MOD_CHECK(), MOD_DEFINE()
102  */
103 #define MOD_INIT(module) \
104 do { \
105         ASSERT(!module ## _initialized); \
106         DB(module ## _initialized = true;) \
107 } while (0)
108
109 /**
110  * Mark module as being no longer initialized.
111  *
112  * Marking initialization requires the global data
113  * previously defined by MOD_DEFINE().
114  *
115  * \see MOD_INIT(), MOD_CHECK(), MOD_DEFINE()
116  */
117 #define MOD_CLEANUP(module) \
118 do { \
119         ASSERT(module ## _initialized); \
120         DB(module ## _initialized = false;) \
121 } while (0)
122
123 #endif /* CFG_MODULE_H */
124