2 * This file is part of DisOrder
3 * Copyright (C) 2008 Richard Kettlewell
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 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 /** @file lib/macros-builtin.c
20 * @brief Built-in expansions
22 * This is a grab-bag of non-domain-specific expansions. Documentation will be
23 * generated from the comments at the head of each function.
46 static struct vector include_path
;
48 /** @brief Return 1 if @p s is 'true' else 0 */
49 int mx_str2bool(const char *s
) {
50 return !strcmp(s
, "true");
53 /** @brief Return "true" if @p n is nonzero else "false" */
54 const char *mx_bool2str(int n
) {
55 return n ?
"true" : "false";
58 /** @brief Write a boolean result */
59 int mx_bool_result(struct sink
*output
, int result
) {
60 if(sink_writes(output
, mx_bool2str(result
)) < 0)
66 /** @brief Search the include path */
67 char *mx_find(const char *name
, int report
) {
72 if(access(name
, O_RDONLY
) < 0) {
74 error(errno
, "cannot read %s", name
);
79 /* Search the include path */
80 for(n
= 0; n
< include_path
.nvec
; ++n
) {
81 byte_xasprintf(&path
, "%s/%s", include_path
.vec
[n
], name
);
82 if(access(path
, O_RDONLY
) == 0)
85 if(n
>= include_path
.nvec
) {
87 error(0, "cannot find '%s' in search path", name
);
94 /*! @include{TEMPLATE}@
98 * TEMPLATE can be an absolute filename starting with a '/'; only the file with
99 * exactly this name will be included.
101 * Alternatively it can be a relative filename, not starting with a '/'. In
102 * this case the file will be searched for in the include path. When searching
103 * paths, unreadable files are treated as if they do not exist (rather than
104 * matching then producing an error).
106 * If the name chosen ends ".tmpl" then the file will be expanded as a
107 * template. Anything else is included byte-for-byte without further
110 * Only regular files are allowed (no devices, sockets or name pipes).
112 static int exp_include(int attribute((unused
)) nargs
,
121 if(!(path
= mx_find(args
[0], 1/*report*/))) {
122 if(sink_printf(output
, "[[cannot find '%s']]", args
[0]) < 0)
126 /* If it's a template expand it */
127 if(strlen(path
) >= 5 && !strncmp(path
+ strlen(path
) - 5, ".tmpl", 5))
128 return mx_expand_file(path
, output
, u
);
129 /* Read the raw file. As with mx_expand_file() we insist that the file is a
131 if((fd
= open(path
, O_RDONLY
)) < 0)
132 fatal(errno
, "error opening %s", path
);
133 if(fstat(fd
, &sb
) < 0)
134 fatal(errno
, "error statting %s", path
);
135 if(!S_ISREG(sb
.st_mode
))
136 fatal(0, "%s: not a regular file", path
);
137 while((n
= read(fd
, buffer
, sizeof buffer
)) > 0) {
138 if(sink_write(output
, buffer
, n
) < 0) {
144 fatal(errno
, "error reading %s", path
);
149 /*! @include{COMMAND}@
151 * Executes COMMAND via the shell (using "sh -c") and copies its
152 * standard output to the template output. The shell command output
153 * is not expanded or modified in any other way.
155 * The shell command's standard error is copied to the error log.
157 * If the shell exits nonzero then this is reported to the error log
158 * but otherwise no special action is taken.
160 static int exp_shell(int attribute((unused
)) nargs
,
163 void attribute((unused
)) *u
) {
169 if(!(pid
= xfork())) {
174 execlp("sh", "sh", "-c", args
[0], (char *)0);
175 fatal(errno
, "error executing sh");
178 while((n
= read(p
[0], buffer
, sizeof buffer
))) {
183 fatal(errno
, "error reading from pipe");
185 if(output
->write(output
, buffer
, n
) < 0)
189 while((n
= waitpid(pid
, &w
, 0)) < 0 && errno
== EINTR
)
192 fatal(errno
, "error calling waitpid");
194 error(0, "shell command '%s' %s", args
[0], wstat(w
));
198 /*! @if{CONDITION}{IF-TRUE}{IF-FALSE}@
200 * If CONDITION is "true" then evaluates to IF-TRUE. Otherwise
201 * evaluates to IF-FALSE. The IF-FALSE part is optional.
203 static int exp_if(int nargs
,
204 const struct mx_node
**args
,
210 if((rc
= mx_expandstr(args
[0], &s
, u
, "argument #0 (CONDITION)")))
213 return mx_expand(args
[1], output
, u
);
215 return mx_expand(args
[2], output
, u
);
220 /*! @and{BRANCH}{BRANCH}...@
222 * Expands to "true" if all the branches are "true" otherwise to "false". If
223 * there are no brances then the result is "true". Only as many branches as
224 * necessary to compute the answer are evaluated (starting from the first one),
225 * so if later branches have side effects they may not take place.
227 static int exp_and(int nargs
,
228 const struct mx_node
**args
,
231 int n
, result
= 1, rc
;
234 for(n
= 0; n
< nargs
; ++n
) {
235 byte_xasprintf(&argname
, "argument #%d", n
);
236 if((rc
= mx_expandstr(args
[n
], &s
, u
, argname
)))
238 if(!mx_str2bool(s
)) {
243 return mx_bool_result(output
, result
);
246 /*! @or{BRANCH}{BRANCH}...@
248 * Expands to "true" if any of the branches are "true" otherwise to "false".
249 * If there are no brances then the result is "false". Only as many branches
250 * as necessary to compute the answer are evaluated (starting from the first
251 * one), so if later branches have side effects they may not take place.
253 static int exp_or(int nargs
,
254 const struct mx_node
**args
,
257 int n
, result
= 0, rc
;
260 for(n
= 0; n
< nargs
; ++n
) {
261 byte_xasprintf(&argname
, "argument #%d", n
);
262 if((rc
= mx_expandstr(args
[n
], &s
, u
, argname
)))
269 return mx_bool_result(output
, result
);
274 * Expands to "true" unless CONDITION is "true" in which case "false".
276 static int exp_not(int attribute((unused
)) nargs
,
279 void attribute((unused
)) *u
) {
280 return mx_bool_result(output
, !mx_str2bool(args
[0]));
285 * Expands to nothing. The argument(s) are not fully evaluated, and no side
288 static int exp_comment(int attribute((unused
)) nargs
,
289 const struct mx_node
attribute((unused
)) **args
,
290 struct sink
attribute((unused
)) *output
,
291 void attribute((unused
)) *u
) {
295 /*! @urlquote{STRING}@
297 * URL-quotes a string, i.e. replaces any characters not safe to use unquoted
298 * in a URL with %-encoded form.
300 static int exp_urlquote(int attribute((unused
)) nargs
,
303 void attribute((unused
)) *u
) {
304 if(sink_writes(output
, urlencodestring(args
[0])) < 0)
312 * Expands to "true" if all the arguments are identical, otherwise to "false"
313 * (i.e. if any pair of arguments differs).
315 * If there are no arguments then expands to "true". Evaluates all arguments
316 * (with their side effects) even if that's not strictly necessary to discover
319 static int exp_eq(int nargs
,
322 void attribute((unused
)) *u
) {
325 for(n
= 1; n
< nargs
; ++n
) {
326 if(strcmp(args
[n
], args
[0])) {
331 return mx_bool_result(output
, result
);
336 * Expands to "true" if all of the arguments differ from one another, otherwise
337 * to "false" (i.e. if any value appears more than once).
339 * If there are no arguments then expands to "true". Evaluates all arguments
340 * (with their side effects) even if that's not strictly necessary to discover
343 static int exp_ne(int nargs
,
346 void attribute((unused
))*u
) {
347 hash
*h
= hash_new(sizeof (char *));
350 for(n
= 0; n
< nargs
; ++n
)
351 if(hash_add(h
, args
[n
], "", HASH_INSERT
)) {
355 return mx_bool_result(output
, result
);
360 * Expands to nothing. Unlike the comment expansion @#{...}, side effects of
361 * arguments are not suppressed. So this can be used to surround a collection
362 * of macro definitions with whitespace, free text commentary, etc.
364 static int exp_discard(int attribute((unused
)) nargs
,
365 char attribute((unused
)) **args
,
366 struct sink
attribute((unused
)) *output
,
367 void attribute((unused
)) *u
) {
371 /*! @define{NAME}{ARG1 ARG2...}{DEFINITION}@
373 * Define a macro. The macro will be called NAME and will act like an
374 * expansion. When it is expanded, the expansion is replaced by DEFINITION,
375 * with each occurence of @ARG1@ etc replaced by the parameters to the
378 static int exp_define(int attribute((unused
)) nargs
,
379 const struct mx_node
**args
,
380 struct sink
attribute((unused
)) *output
,
381 void attribute((unused
)) *u
) {
382 char **as
, *name
, *argnames
;
385 if((rc
= mx_expandstr(args
[0], &name
, u
, "argument #0 (NAME)")))
387 if((rc
= mx_expandstr(args
[1], &argnames
, u
, "argument #1 (ARGS)")))
389 as
= split(argnames
, &nas
, 0, 0, 0);
390 mx_register_macro(name
, nas
, as
, args
[2]);
396 * Expands to the UNQUOTED basename of PATH.
398 static int exp_basename(int attribute((unused
)) nargs
,
400 struct sink
attribute((unused
)) *output
,
401 void attribute((unused
)) *u
) {
402 return sink_writes(output
, d_basename(args
[0])) < 0 ?
-1 : 0;
407 * Expands to the UNQUOTED directory name of PATH.
409 static int exp_dirname(int attribute((unused
)) nargs
,
411 struct sink
attribute((unused
)) *output
,
412 void attribute((unused
)) *u
) {
413 return sink_writes(output
, d_dirname(args
[0])) < 0 ?
-1 : 0;
420 static int exp_q(int attribute((unused
)) nargs
,
422 struct sink
attribute((unused
)) *output
,
423 void attribute((unused
)) *u
) {
424 return sink_writes(output
, args
[0]) < 0 ?
-1 : 0;
427 /** @brief Register built-in expansions */
428 void mx_register_builtin(void) {
429 mx_register("basename", 1, 1, exp_basename
);
430 mx_register("dirname", 1, 1, exp_dirname
);
431 mx_register("discard", 0, INT_MAX
, exp_discard
);
432 mx_register("eq", 0, INT_MAX
, exp_eq
);
433 mx_register("include", 1, 1, exp_include
);
434 mx_register("ne", 0, INT_MAX
, exp_ne
);
435 mx_register("not", 1, 1, exp_not
);
436 mx_register("shell", 1, 1, exp_shell
);
437 mx_register("urlquote", 1, 1, exp_urlquote
);
438 mx_register("q", 1, 1, exp_q
);
439 mx_register_magic("#", 0, INT_MAX
, exp_comment
);
440 mx_register_magic("and", 0, INT_MAX
, exp_and
);
441 mx_register_magic("define", 3, 3, exp_define
);
442 mx_register_magic("if", 2, 3, exp_if
);
443 mx_register_magic("or", 0, INT_MAX
, exp_or
);
446 /** @brief Add a directory to the search path
447 * @param s Directory to add
449 void mx_search_path(const char *s
) {
450 vector_append(&include_path
, xstrdup(s
));