Commit | Line | Data |
---|---|---|
1dcdf455 RK |
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 | ||
f640bcb3 RK |
28 | struct sink; |
29 | ||
1dcdf455 RK |
30 | /** @brief One node in a macro expansion parse tree */ |
31 | struct mx_node { | |
32 | /** @brief Next element or NULL at end of list */ | |
33 | struct mx_node *next; | |
34 | ||
35 | /** @brief Node type, @ref MX_TEXT or @ref MX_EXPANSION. */ | |
36 | int type; | |
37 | ||
38 | /** @brief Filename containing this node */ | |
39 | const char *filename; | |
40 | ||
41 | /** @brief Line number at start of this node */ | |
42 | int line; | |
43 | ||
44 | /** @brief Plain text (if @p type is @ref MX_TEXT) */ | |
f5fdc06f | 45 | const char *text; |
1dcdf455 RK |
46 | |
47 | /** @brief Expansion name (if @p type is @ref MX_EXPANSION) */ | |
f5fdc06f | 48 | const char *name; |
1dcdf455 RK |
49 | |
50 | /** @brief Argument count (if @p type is @ref MX_EXPANSION) */ | |
51 | int nargs; | |
52 | ||
53 | /** @brief Argument values, parsed recursively (or NULL if @p nargs is 0) */ | |
54 | const struct mx_node **args; | |
55 | }; | |
56 | ||
57 | /** @brief Text node */ | |
58 | #define MX_TEXT 0 | |
59 | ||
60 | /** @brief Expansion node */ | |
61 | #define MX_EXPANSION 1 | |
62 | ||
63 | const struct mx_node *mx_parse(const char *filename, | |
64 | int line, | |
65 | const char *input, | |
66 | const char *end); | |
9dbb630e RK |
67 | char *mx_dump(const struct mx_node *m); |
68 | ||
f640bcb3 RK |
69 | |
70 | /** @brief Callback for simple expansions | |
71 | * @param nargs Number of arguments | |
72 | * @param args Pointer to array of arguments | |
73 | * @param output Where to send output | |
74 | * @param u User data | |
75 | * @return 0 on success, non-zero on error | |
76 | */ | |
77 | typedef int mx_simple_callback(int nargs, | |
78 | char **args, | |
79 | struct sink *output, | |
80 | void *u); | |
81 | ||
82 | /** @brief Callback for magic expansions | |
83 | * @param nargs Number of arguments | |
84 | * @param args Pointer to array of arguments | |
85 | * @param output Where to send output | |
86 | * @param u User data | |
87 | * @return 0 on success, non-zero on error | |
88 | */ | |
89 | typedef int mx_magic_callback(int nargs, | |
90 | const struct mx_node **args, | |
91 | struct sink *output, | |
92 | void *u); | |
93 | ||
94 | void mx_register(const char *name, | |
95 | int min, | |
96 | int max, | |
97 | mx_simple_callback *callback); | |
b36be3a1 | 98 | void mx_register_magic(const char *name, |
f640bcb3 RK |
99 | int min, |
100 | int max, | |
101 | mx_magic_callback *callback); | |
b36be3a1 RK |
102 | int mx_register_macro(const char *name, |
103 | int nargs, | |
104 | char **args, | |
105 | const struct mx_node *definition); | |
f640bcb3 RK |
106 | |
107 | void mx_register_builtin(void); | |
dd0f422a | 108 | void mx_search_path(const char *s); |
9faa7a88 | 109 | char *mx_find(const char *name); |
f640bcb3 RK |
110 | |
111 | int mx_expand_file(const char *path, | |
112 | struct sink *output, | |
113 | void *u); | |
114 | int mx_expand(const struct mx_node *m, | |
115 | struct sink *output, | |
116 | void *u); | |
117 | int mx_expandstr(const struct mx_node *m, | |
118 | char **sp, | |
b36be3a1 RK |
119 | void *u, |
120 | const char *what); | |
9faa7a88 RK |
121 | const struct mx_node *mx_rewrite(const struct mx_node *definition, |
122 | hash *h); | |
123 | const struct mx_node *mx_rewritel(const struct mx_node *m, | |
124 | ...); | |
f640bcb3 RK |
125 | |
126 | int mx_str2bool(const char *s); | |
127 | const char *mx_bool2str(int n); | |
71634563 | 128 | int mx_bool_result(struct sink *output, int result); |
f640bcb3 | 129 | |
1dcdf455 RK |
130 | #endif /* MACROS_H */ |
131 | ||
132 | ||
133 | /* | |
134 | Local Variables: | |
135 | c-basic-offset:2 | |
136 | comment-column:40 | |
137 | fill-column:79 | |
138 | indent-tabs-mode:nil | |
139 | End: | |
140 | */ |