Change some comments in doxygen format. Reformat. Fix some comments.
[bertos.git] / app / triface / cmd_ctor.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  * \brief Macro for defining command for protocol.
33  *
34  *
35  * \version $Id$
36  *
37  * \author Marco Benelli <marco@develer.com>
38  */
39 #ifndef CMD_CTOR_H
40 #define CMD_CTOR_H
41
42 #include <mware/parser.h>
43
44 #define REGISTER_FUNCTION parser_register_cmd
45
46 #define REGISTER_CMD(NAME) REGISTER_FUNCTION(&cmd_ ## NAME ## _template)
47
48 #define MAKE_TEMPLATE(NAME, ARGS, RES)                                  \
49 const struct CmdTemplate cmd_ ## NAME ## _template =                    \
50 {                                                                       \
51         #NAME, ARGS, RES, cmd_ ## NAME, 0                               \
52 };
53
54 #define MAKE_CMD(NAME, ARGS, RES, BODY)                                 \
55 static ResultCode cmd_ ## NAME (parms *args)                            \
56 {                                                                       \
57         return (ResultCode)BODY;                                        \
58 }                                                                       \
59 MAKE_TEMPLATE(NAME, ARGS, RES)
60
61 #endif // CMD_CTOR_H