Yet further macros.c testing
[disorder] / lib / macros.h
1 /*
2 * This file is part of DisOrder
3 * Copyright (C) 2008 Richard Kettlewell
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
18 * USA
19 */
20
21 /** @file lib/macros.h
22 * @brief Macro expansion
23 */
24
25 #ifndef MACROS_H
26 #define MACROS_H
27
28 /** @brief One node in a macro expansion parse tree */
29 struct mx_node {
30 /** @brief Next element or NULL at end of list */
31 struct mx_node *next;
32
33 /** @brief Node type, @ref MX_TEXT or @ref MX_EXPANSION. */
34 int type;
35
36 /** @brief Filename containing this node */
37 const char *filename;
38
39 /** @brief Line number at start of this node */
40 int line;
41
42 /** @brief Plain text (if @p type is @ref MX_TEXT) */
43 char *text;
44
45 /** @brief Expansion name (if @p type is @ref MX_EXPANSION) */
46 char *name;
47
48 /** @brief Argument count (if @p type is @ref MX_EXPANSION) */
49 int nargs;
50
51 /** @brief Argument values, parsed recursively (or NULL if @p nargs is 0) */
52 const struct mx_node **args;
53 };
54
55 /** @brief Text node */
56 #define MX_TEXT 0
57
58 /** @brief Expansion node */
59 #define MX_EXPANSION 1
60
61 const struct mx_node *mx_parse(const char *filename,
62 int line,
63 const char *input,
64 const char *end);
65
66 char *mx_dump(const struct mx_node *m);
67
68 #endif /* MACROS_H */
69
70
71 /*
72 Local Variables:
73 c-basic-offset:2
74 comment-column:40
75 fill-column:79
76 indent-tabs-mode:nil
77 End:
78 */