Next: Evaluation Macros Prev: Conditional constructs Up: Programming in M4sugar
8.3.5 Looping constructs
The following macros are useful in implementing recursive algorithms in
M4, including loop operations. An M4 list is formed by quoting a list
of quoted elements; generally the lists are comma-separated, although
`m4_foreach_w' is whitespace-separated. For example, the list `[[a],
[b,c]]' contains two elements: `[a]' and `[b,c]'. It is common to see
lists with unquoted elements when those elements are not likely to be
macro names, as in `[fputc_unlocked, fgetc_unlocked]'.
-- Macro: m4_car (LIST)
Expands to the quoted first element of the comma-separated quoted
LIST. Often used with `m4_cdr' to recursively iterate through a
list. Generally, when using quoted lists of quoted elements,
`m4_car' should be called without any extra quotes.
-- Macro: m4_cdr (LIST)
Expands to a quoted list of all but the first element of the
comma-separated quoted LIST, or the empty string if LIST had only
one element. Generally, when using quoted lists of quoted
elements, `m4_cdr' should be called without any extra quotes.
For example, this is a simple implementation of `m4_map'; note how
each iteration checks for the end of recursion, then merely
applies the first argument to the first element of the list, then
repeats with the rest of the list. (The actual implementation in
M4sugar is a bit more involved, to gain some speed and share code
[m4_apply([$1], m4_car($2))$0([$1], m4_cdr($2))])])dnl
m4_map([ m4_eval], [[], [[1+1]], [,]])
=> 1 2 a
-- Macro: m4_for (VAR, FIRST, LAST, [STEP], EXPRESSION)
Loop over the numeric values between FIRST and LAST including
bounds by increments of STEP. For each iteration, expand
EXPRESSION with the numeric value assigned to VAR. If STEP is
omitted, it defaults to `1' or `-1' depending on the order of the
limits. If given, STEP has to match this order.
-- Macro: m4_foreach (VAR, LIST, EXPRESSION)
Loop over the comma-separated M4 list LIST, assigning each value
to VAR, and expand EXPRESSION. The following example outputs two
m4_foreach([myvar], [[foo], [bar, baz]],
=>echo bar, baz
-- Macro: m4_foreach_w (VAR, LIST, EXPRESSION)
Loop over the white-space-separated list LIST, assigning each value
to VAR, and expand EXPRESSION.
The deprecated macro `AC_FOREACH' is an alias of `m4_foreach_w'.
-- Macro: m4_map (MACRO, LIST)
-- Macro: m4_map_sep (MACRO, SEPARATOR, LIST)
Loop over the comma separated quoted list of argument descriptions
in LIST, and invoke MACRO with the arguments. An argument
description is in turn a comma-separated quoted list of quoted
elements, suitable for `m4_apply', making it possible to invoke
MACRO without arguments if an argument description is empty.
`m4_map_sep' additionally outputs SEPARATOR between macro
invocations, with no additional expansion of the separator.
m4_map([ m4_count], [,
=> 0 1 2
m4_map_sep([m4_eval], [,], [[[1+2]],
-- Macro: m4_shiftn (COUNT, ...)
-- Macro: m4_shift2 (...)
-- Macro: m4_shift3 (...)
`m4_shiftn' performs COUNT iterations of `m4_shift', along with
validation that enough arguments were passed in to match the shift
count, and that the count is positive. `m4_shift2' and
`m4_shift3' are specializations of `m4_shiftn', introduced in
Autoconf 2.62, and are more efficient for two and three shifts,
automatically generated by info2www