]> git.cameronkatri.com Git - mandoc.git/blobdiff - roff.c
If man(7) next-line scope is open and the line ends with \c,
[mandoc.git] / roff.c
diff --git a/roff.c b/roff.c
index 8eda99e817ba6248060f92277c990464337b8d67..57ad4d2f075a8d7d89c3cdb2c1814e500dbf0610 100644 (file)
--- a/roff.c
+++ b/roff.c
@@ -1,4 +1,4 @@
-/*     $Id: roff.c,v 1.331 2018/08/16 13:54:06 schwarze Exp $ */
+/*     $Id: roff.c,v 1.340 2018/08/24 23:12:33 schwarze Exp $ */
 /*
  * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
@@ -85,10 +85,21 @@ struct      roffreq {
        char             name[];
 };
 
+/*
+ * A macro processing context.
+ * More than one is needed when macro calls are nested.
+ */
+struct mctx {
+       char            **argv;
+       int              argc;
+       int              argsz;
+};
+
 struct roff {
        struct mparse   *parse; /* parse point */
        struct roff_man *man; /* mdoc or man parser */
        struct roffnode *last; /* leaf of stack */
+       struct mctx     *mstack; /* stack of macro contexts */
        int             *rstack; /* stack of inverted `ie' values */
        struct ohash    *reqtab; /* request lookup table */
        struct roffreg  *regtab; /* number registers */
@@ -104,10 +115,11 @@ struct    roff {
        struct eqn_node *eqn; /* active equation parser */
        int              eqn_inline; /* current equation is inline */
        int              options; /* parse options */
+       int              mstacksz; /* current size of mstack */
+       int              mstackpos; /* position in mstack */
        int              rstacksz; /* current size limit of rstack */
        int              rstackpos; /* position in rstack */
        int              format; /* current file in mdoc or man format */
-       int              argc; /* number of args of the last macro */
        char             control; /* control character */
        char             escape; /* escape character */
 };
@@ -131,7 +143,7 @@ struct      roffnode {
                         int pos, /* current pos in buffer */ \
                         int *offs /* reset offset of buffer data */
 
-typedef        enum rofferr (*roffproc)(ROFF_ARGS);
+typedef        int (*roffproc)(ROFF_ARGS);
 
 struct roffmac {
        roffproc         proc; /* process new macro */
@@ -151,26 +163,26 @@ struct    predef {
 
 /* --- function prototypes ------------------------------------------------ */
 
-static void             roffnode_cleanscope(struct roff *);
-static void             roffnode_pop(struct roff *);
+static int              roffnode_cleanscope(struct roff *);
+static int              roffnode_pop(struct roff *);
 static void             roffnode_push(struct roff *, enum roff_tok,
                                const char *, int, int);
 static void             roff_addtbl(struct roff_man *, struct tbl_node *);
-static enum rofferr     roff_als(ROFF_ARGS);
-static enum rofferr     roff_block(ROFF_ARGS);
-static enum rofferr     roff_block_text(ROFF_ARGS);
-static enum rofferr     roff_block_sub(ROFF_ARGS);
-static enum rofferr     roff_br(ROFF_ARGS);
-static enum rofferr     roff_cblock(ROFF_ARGS);
-static enum rofferr     roff_cc(ROFF_ARGS);
-static void             roff_ccond(struct roff *, int, int);
-static enum rofferr     roff_cond(ROFF_ARGS);
-static enum rofferr     roff_cond_text(ROFF_ARGS);
-static enum rofferr     roff_cond_sub(ROFF_ARGS);
-static enum rofferr     roff_ds(ROFF_ARGS);
-static enum rofferr     roff_ec(ROFF_ARGS);
-static enum rofferr     roff_eo(ROFF_ARGS);
-static enum rofferr     roff_eqndelim(struct roff *, struct buf *, int);
+static int              roff_als(ROFF_ARGS);
+static int              roff_block(ROFF_ARGS);
+static int              roff_block_text(ROFF_ARGS);
+static int              roff_block_sub(ROFF_ARGS);
+static int              roff_br(ROFF_ARGS);
+static int              roff_cblock(ROFF_ARGS);
+static int              roff_cc(ROFF_ARGS);
+static int              roff_ccond(struct roff *, int, int);
+static int              roff_cond(ROFF_ARGS);
+static int              roff_cond_text(ROFF_ARGS);
+static int              roff_cond_sub(ROFF_ARGS);
+static int              roff_ds(ROFF_ARGS);
+static int              roff_ec(ROFF_ARGS);
+static int              roff_eo(ROFF_ARGS);
+static int              roff_eqndelim(struct roff *, struct buf *, int);
 static int              roff_evalcond(struct roff *r, int, char *, int *);
 static int              roff_evalnum(struct roff *, int,
                                const char *, int *, int *, int);
@@ -191,40 +203,42 @@ static    const char      *roff_getstrn(struct roff *,
                                const char *, size_t, int *);
 static int              roff_hasregn(const struct roff *,
                                const char *, size_t);
-static enum rofferr     roff_insec(ROFF_ARGS);
-static enum rofferr     roff_it(ROFF_ARGS);
-static enum rofferr     roff_line_ignore(ROFF_ARGS);
+static int              roff_insec(ROFF_ARGS);
+static int              roff_it(ROFF_ARGS);
+static int              roff_line_ignore(ROFF_ARGS);
 static void             roff_man_alloc1(struct roff_man *);
 static void             roff_man_free1(struct roff_man *);
-static enum rofferr     roff_manyarg(ROFF_ARGS);
-static enum rofferr     roff_nop(ROFF_ARGS);
-static enum rofferr     roff_nr(ROFF_ARGS);
-static enum rofferr     roff_onearg(ROFF_ARGS);
+static int              roff_manyarg(ROFF_ARGS);
+static int              roff_nop(ROFF_ARGS);
+static int              roff_nr(ROFF_ARGS);
+static int              roff_onearg(ROFF_ARGS);
 static enum roff_tok    roff_parse(struct roff *, char *, int *,
                                int, int);
-static enum rofferr     roff_parsetext(struct roff *, struct buf *,
+static int              roff_parsetext(struct roff *, struct buf *,
                                int, int *);
-static enum rofferr     roff_renamed(ROFF_ARGS);
-static enum rofferr     roff_res(struct roff *, struct buf *, int, int);
-static enum rofferr     roff_rm(ROFF_ARGS);
-static enum rofferr     roff_rn(ROFF_ARGS);
-static enum rofferr     roff_rr(ROFF_ARGS);
+static int              roff_renamed(ROFF_ARGS);
+static int              roff_res(struct roff *, struct buf *, int, int);
+static int              roff_return(ROFF_ARGS);
+static int              roff_rm(ROFF_ARGS);
+static int              roff_rn(ROFF_ARGS);
+static int              roff_rr(ROFF_ARGS);
 static void             roff_setregn(struct roff *, const char *,
                                size_t, int, char, int);
 static void             roff_setstr(struct roff *,
                                const char *, const char *, int);
 static void             roff_setstrn(struct roffkv **, const char *,
                                size_t, const char *, size_t, int);
-static enum rofferr     roff_so(ROFF_ARGS);
-static enum rofferr     roff_tr(ROFF_ARGS);
-static enum rofferr     roff_Dd(ROFF_ARGS);
-static enum rofferr     roff_TE(ROFF_ARGS);
-static enum rofferr     roff_TS(ROFF_ARGS);
-static enum rofferr     roff_EQ(ROFF_ARGS);
-static enum rofferr     roff_EN(ROFF_ARGS);
-static enum rofferr     roff_T_(ROFF_ARGS);
-static enum rofferr     roff_unsupp(ROFF_ARGS);
-static enum rofferr     roff_userdef(ROFF_ARGS);
+static int              roff_shift(ROFF_ARGS);
+static int              roff_so(ROFF_ARGS);
+static int              roff_tr(ROFF_ARGS);
+static int              roff_Dd(ROFF_ARGS);
+static int              roff_TE(ROFF_ARGS);
+static int              roff_TS(ROFF_ARGS);
+static int              roff_EQ(ROFF_ARGS);
+static int              roff_EN(ROFF_ARGS);
+static int              roff_T_(ROFF_ARGS);
+static int              roff_unsupp(ROFF_ARGS);
+static int              roff_userdef(ROFF_ARGS);
 
 /* --- constant data ------------------------------------------------------ */
 
@@ -327,6 +341,7 @@ const char *__roff_name[MAN_MAX + 1] = {
        "Dx",           "%Q",           "%U",           "Ta",
        NULL,
        "TH",           "SH",           "SS",           "TP",
+       "TQ",
        "LP",           "PP",           "P",            "IP",
        "HP",           "SM",           "SB",           "BI",
        "IB",           "BR",           "RB",           "R",
@@ -334,7 +349,8 @@ const char *__roff_name[MAN_MAX + 1] = {
        "nf",           "fi",
        "RE",           "RS",           "DT",           "UC",
        "PD",           "AT",           "in",
-       "OP",           "EX",           "EE",           "UR",
+       "SY",           "YS",           "OP",
+       "EX",           "EE",           "UR",
        "UE",           "MT",           "ME",           NULL
 };
 const  char *const *roff_name = __roff_name;
@@ -520,7 +536,7 @@ static      struct roffmac   roffs[TOKEN_NONE] = {
        { roff_unsupp, NULL, NULL, 0 },  /* rchar */
        { roff_line_ignore, NULL, NULL, 0 },  /* rd */
        { roff_line_ignore, NULL, NULL, 0 },  /* recursionlimit */
-       { roff_unsupp, NULL, NULL, 0 },  /* return */
+       { roff_return, NULL, NULL, 0 },  /* return */
        { roff_unsupp, NULL, NULL, 0 },  /* rfschar */
        { roff_line_ignore, NULL, NULL, 0 },  /* rhang */
        { roff_rm, NULL, NULL, 0 },  /* rm */
@@ -532,7 +548,7 @@ static      struct roffmac   roffs[TOKEN_NONE] = {
        { roff_unsupp, NULL, NULL, 0 },  /* schar */
        { roff_line_ignore, NULL, NULL, 0 },  /* sentchar */
        { roff_line_ignore, NULL, NULL, 0 },  /* shc */
-       { roff_unsupp, NULL, NULL, 0 },  /* shift */
+       { roff_shift, NULL, NULL, 0 },  /* shift */
        { roff_line_ignore, NULL, NULL, 0 },  /* sizes */
        { roff_so, NULL, NULL, 0 },  /* so */
        { roff_line_ignore, NULL, NULL, 0 },  /* spacewidth */
@@ -574,7 +590,7 @@ static      struct roffmac   roffs[TOKEN_NONE] = {
        { roff_line_ignore, NULL, NULL, 0 },  /* watchlength */
        { roff_line_ignore, NULL, NULL, 0 },  /* watchn */
        { roff_unsupp, NULL, NULL, 0 },  /* wh */
-       { roff_unsupp, NULL, NULL, 0 },  /* while */
+       { roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT }, /*while*/
        { roff_insec, NULL, NULL, 0 },  /* write */
        { roff_insec, NULL, NULL, 0 },  /* writec */
        { roff_insec, NULL, NULL, 0 },  /* writem */
@@ -658,18 +674,19 @@ roffhash_find(struct ohash *htab, const char *name, size_t sz)
  * Pop the current node off of the stack of roff instructions currently
  * pending.
  */
-static void
+static int
 roffnode_pop(struct roff *r)
 {
        struct roffnode *p;
+       int              inloop;
 
-       assert(r->last);
        p = r->last;
-
-       r->last = r->last->parent;
+       inloop = p->tok == ROFF_while;
+       r->last = p->parent;
        free(p->name);
        free(p->end);
        free(p);
+       return inloop;
 }
 
 /*
@@ -712,6 +729,9 @@ roff_free1(struct roff *r)
                eqn_free(r->last_eqn);
        r->last_eqn = r->eqn = NULL;
 
+       while (r->mstackpos >= 0)
+               roff_userret(r);
+
        while (r->last)
                roffnode_pop(r);
 
@@ -751,7 +771,12 @@ roff_reset(struct roff *r)
 void
 roff_free(struct roff *r)
 {
+       int              i;
+
        roff_free1(r);
+       for (i = 0; i < r->mstacksz; i++)
+               free(r->mstack[i].argv);
+       free(r->mstack);
        roffhash_free(r->reqtab);
        free(r);
 }
@@ -766,6 +791,7 @@ roff_alloc(struct mparse *parse, int options)
        r->reqtab = roffhash_alloc(0, ROFF_RENAMED);
        r->options = options;
        r->format = options & (MPARSE_MDOC | MPARSE_MAN);
+       r->mstackpos = -1;
        r->rstackpos = -1;
        r->escape = '\\';
        return r;
@@ -1119,9 +1145,10 @@ deroff(char **dest, const struct roff_node *n)
  * used in numerical expressions and conditional requests.
  * Also check the syntax of the remaining escape sequences.
  */
-static enum rofferr
+static int
 roff_res(struct roff *r, struct buf *buf, int ln, int pos)
 {
+       struct mctx     *ctx;   /* current macro call context */
        char             ubuf[24]; /* buffer to print the number */
        struct roff_node *n;    /* used for header comments */
        const char      *start; /* start of the string to process */
@@ -1133,11 +1160,14 @@ roff_res(struct roff *r, struct buf *buf, int ln, int pos)
        char            *nbuf;  /* new buffer to copy buf->buf to */
        size_t           maxl;  /* expected length of the escape name */
        size_t           naml;  /* actual length of the escape name */
+       size_t           asz;   /* length of the replacement */
+       size_t           rsz;   /* length of the rest of the string */
        enum mandoc_esc  esc;   /* type of the escape sequence */
        int              inaml; /* length returned from mandoc_escape() */
        int              expand_count;  /* to avoid infinite loops */
        int              npos;  /* position in numeric expression */
        int              arg_complete; /* argument not interrupted by eol */
+       int              quote_args; /* true for \\$@, false for \\$* */
        int              done;  /* no more input available */
        int              deftype; /* type of definition to paste */
        int              rcsid; /* kind of RCS id seen */
@@ -1203,9 +1233,17 @@ roff_res(struct roff *r, struct buf *buf, int ln, int pos)
                        r->man->next = ROFF_NEXT_SIBLING;
                }
 
-               /* Discard comments. */
+               /* Line continuation with comment. */
+
+               if (stesc[1] == '#') {
+                       *stesc = '\0';
+                       return ROFF_IGN | ROFF_APPEND;
+               }
+
+               /* Discard normal comments. */
 
-               while (stesc > start && stesc[-1] == ' ')
+               while (stesc > start && stesc[-1] == ' ' &&
+                   (stesc == start + 1 || stesc[-2] != '\\'))
                        stesc--;
                *stesc = '\0';
                break;
@@ -1257,7 +1295,7 @@ roff_res(struct roff *r, struct buf *buf, int ln, int pos)
                        if (done)
                                continue;
                        else
-                               return ROFF_APPEND;
+                               return ROFF_IGN | ROFF_APPEND;
                }
 
                /* Decide whether to expand or to check only. */
@@ -1266,6 +1304,7 @@ roff_res(struct roff *r, struct buf *buf, int ln, int pos)
                cp = stesc + 1;
                switch (*cp) {
                case '*':
+               case '$':
                        res = NULL;
                        break;
                case 'B':
@@ -1382,6 +1421,62 @@ roff_res(struct roff *r, struct buf *buf, int ln, int pos)
                                }
                        }
                        break;
+               case '$':
+                       if (r->mstackpos < 0) {
+                               mandoc_vmsg(MANDOCERR_ARG_UNDEF,
+                                   r->parse, ln, (int)(stesc - buf->buf),
+                                   "%.3s", stesc);
+                               break;
+                       }
+                       ctx = r->mstack + r->mstackpos;
+                       npos = stesc[2] - '1';
+                       if (npos >= 0 && npos <= 8) {
+                               res = npos < ctx->argc ?
+                                   ctx->argv[npos] : "";
+                               break;
+                       }
+                       if (stesc[2] == '*')
+                               quote_args = 0;
+                       else if (stesc[2] == '@')
+                               quote_args = 1;
+                       else {
+                               mandoc_vmsg(MANDOCERR_ARG_NONUM,
+                                   r->parse, ln, (int)(stesc - buf->buf),
+                                   "%.3s", stesc);
+                               break;
+                       }
+                       asz = 0;
+                       for (npos = 0; npos < ctx->argc; npos++) {
+                               if (npos)
+                                       asz++;  /* blank */
+                               if (quote_args)
+                                       asz += 2;  /* quotes */
+                               asz += strlen(ctx->argv[npos]);
+                       }
+                       if (asz != 3) {
+                               rsz = buf->sz - (stesc - buf->buf) - 3;
+                               if (asz < 3)
+                                       memmove(stesc + asz, stesc + 3, rsz);
+                               buf->sz += asz - 3;
+                               nbuf = mandoc_realloc(buf->buf, buf->sz);
+                               start = nbuf + pos;
+                               stesc = nbuf + (stesc - buf->buf);
+                               buf->buf = nbuf;
+                               if (asz > 3)
+                                       memmove(stesc + asz, stesc + 3, rsz);
+                       }
+                       for (npos = 0; npos < ctx->argc; npos++) {
+                               if (npos)
+                                       *stesc++ = ' ';
+                               if (quote_args)
+                                       *stesc++ = '"';
+                               cp = ctx->argv[npos];
+                               while (*cp != '\0')
+                                       *stesc++ = *cp++;
+                               if (quote_args)
+                                       *stesc++ = '"';
+                       }
+                       continue;
                case 'B':
                        npos = 0;
                        ubuf[0] = arg_complete &&
@@ -1405,9 +1500,10 @@ roff_res(struct roff *r, struct buf *buf, int ln, int pos)
                }
 
                if (res == NULL) {
-                       mandoc_vmsg(MANDOCERR_STR_UNDEF,
-                           r->parse, ln, (int)(stesc - buf->buf),
-                           "%.*s", (int)naml, stnam);
+                       if (stesc[1] == '*')
+                               mandoc_vmsg(MANDOCERR_STR_UNDEF,
+                                   r->parse, ln, (int)(stesc - buf->buf),
+                                   "%.*s", (int)naml, stnam);
                        res = "";
                } else if (buf->sz + strlen(res) > SHRT_MAX) {
                        mandoc_msg(MANDOCERR_ROFFLOOP, r->parse,
@@ -1434,7 +1530,7 @@ roff_res(struct roff *r, struct buf *buf, int ln, int pos)
 /*
  * Process text streams.
  */
-static enum rofferr
+static int
 roff_parsetext(struct roff *r, struct buf *buf, int pos, int *offs)
 {
        size_t           sz;
@@ -1500,11 +1596,11 @@ roff_parsetext(struct roff *r, struct buf *buf, int pos, int *offs)
        return ROFF_CONT;
 }
 
-enum rofferr
+int
 roff_parseln(struct roff *r, int ln, struct buf *buf, int *offs)
 {
        enum roff_tok    t;
-       enum rofferr     e;
+       int              e;
        int              pos;   /* parse point */
        int              spos;  /* saved parse point for messages */
        int              ppos;  /* original offset in buf->buf */
@@ -1526,7 +1622,7 @@ roff_parseln(struct roff *r, int ln, struct buf *buf, int *offs)
        /* Expand some escape sequences. */
 
        e = roff_res(r, buf, ln, pos);
-       if (e == ROFF_IGN || e == ROFF_APPEND)
+       if ((e & ROFF_MASK) == ROFF_IGN)
                return e;
        assert(e == ROFF_CONT);
 
@@ -1543,21 +1639,22 @@ roff_parseln(struct roff *r, int ln, struct buf *buf, int *offs)
        if (r->last != NULL && ! ctl) {
                t = r->last->tok;
                e = (*roffs[t].text)(r, t, buf, ln, pos, pos, offs);
-               if (e == ROFF_IGN)
+               if ((e & ROFF_MASK) == ROFF_IGN)
                        return e;
-               assert(e == ROFF_CONT);
-       }
+               e &= ~ROFF_MASK;
+       } else
+               e = ROFF_IGN;
        if (r->eqn != NULL && strncmp(buf->buf + ppos, ".EN", 3)) {
                eqn_read(r->eqn, buf->buf + ppos);
-               return ROFF_IGN;
+               return e;
        }
        if (r->tbl != NULL && (ctl == 0 || buf->buf[pos] == '\0')) {
                tbl_read(r->tbl, ln, buf->buf, ppos);
                roff_addtbl(r->man, r->tbl);
-               return ROFF_IGN;
+               return e;
        }
        if ( ! ctl)
-               return roff_parsetext(r, buf, pos, offs);
+               return roff_parsetext(r, buf, pos, offs) | e;
 
        /* Skip empty request lines. */
 
@@ -1625,6 +1722,25 @@ roff_parseln(struct roff *r, int ln, struct buf *buf, int *offs)
        return (*roffs[t].proc)(r, t, buf, ln, spos, pos, offs);
 }
 
+/*
+ * Internal interface function to tell the roff parser that execution
+ * of the current macro ended.  This is required because macro
+ * definitions usually do not end with a .return request.
+ */
+void
+roff_userret(struct roff *r)
+{
+       struct mctx     *ctx;
+       int              i;
+
+       assert(r->mstackpos >= 0);
+       ctx = r->mstack + r->mstackpos;
+       for (i = 0; i < ctx->argc; i++)
+               free(ctx->argv[i]);
+       ctx->argc = 0;
+       r->mstackpos--;
+}
+
 void
 roff_endparse(struct roff *r)
 {
@@ -1694,7 +1810,7 @@ roff_parse(struct roff *r, char *buf, int *pos, int ln, int ppos)
 
 /* --- handling of request blocks ----------------------------------------- */
 
-static enum rofferr
+static int
 roff_cblock(ROFF_ARGS)
 {
 
@@ -1734,50 +1850,51 @@ roff_cblock(ROFF_ARGS)
 
 }
 
-static void
+static int
 roffnode_cleanscope(struct roff *r)
 {
+       int inloop;
 
-       while (r->last) {
+       inloop = 0;
+       while (r->last != NULL) {
                if (--r->last->endspan != 0)
                        break;
-               roffnode_pop(r);
+               inloop += roffnode_pop(r);
        }
+       return inloop;
 }
 
-static void
+static int
 roff_ccond(struct roff *r, int ln, int ppos)
 {
-
        if (NULL == r->last) {
                mandoc_msg(MANDOCERR_BLK_NOTOPEN, r->parse,
                    ln, ppos, "\\}");
-               return;
+               return 0;
        }
 
        switch (r->last->tok) {
        case ROFF_el:
        case ROFF_ie:
        case ROFF_if:
+       case ROFF_while:
                break;
        default:
                mandoc_msg(MANDOCERR_BLK_NOTOPEN, r->parse,
                    ln, ppos, "\\}");
-               return;
+               return 0;
        }
 
        if (r->last->endspan > -1) {
                mandoc_msg(MANDOCERR_BLK_NOTOPEN, r->parse,
                    ln, ppos, "\\}");
-               return;
+               return 0;
        }
 
-       roffnode_pop(r);
-       roffnode_cleanscope(r);
-       return;
+       return roffnode_pop(r) + roffnode_cleanscope(r);
 }
 
-static enum rofferr
+static int
 roff_block(ROFF_ARGS)
 {
        const char      *name, *value;
@@ -1902,7 +2019,7 @@ roff_block(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_block_sub(ROFF_ARGS)
 {
        enum roff_tok   t;
@@ -1956,7 +2073,7 @@ roff_block_sub(ROFF_ARGS)
        return (*roffs[t].proc)(r, t, buf, ln, ppos, pos, offs);
 }
 
-static enum rofferr
+static int
 roff_block_text(ROFF_ARGS)
 {
 
@@ -1966,15 +2083,19 @@ roff_block_text(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_cond_sub(ROFF_ARGS)
 {
-       enum roff_tok    t;
        char            *ep;
-       int              rr;
+       int              endloop, irc, rr;
+       enum roff_tok    t;
 
+       irc = ROFF_IGN;
        rr = r->last->rule;
-       roffnode_cleanscope(r);
+       endloop = tok != ROFF_while ? ROFF_IGN :
+           rr ? ROFF_LOOPCONT : ROFF_LOOPEXIT;
+       if (roffnode_cleanscope(r))
+               irc |= endloop;
 
        /*
         * If `\}' occurs on a macro line without a preceding macro,
@@ -1991,7 +2112,8 @@ roff_cond_sub(ROFF_ARGS)
                switch (ep[1]) {
                case '}':
                        memmove(ep, ep + 2, strlen(ep + 2) + 1);
-                       roff_ccond(r, ln, ep - buf->buf);
+                       if (roff_ccond(r, ln, ep - buf->buf))
+                               irc |= endloop;
                        break;
                case '\0':
                        ++ep;
@@ -2008,30 +2130,38 @@ roff_cond_sub(ROFF_ARGS)
         */
 
        t = roff_parse(r, buf->buf, &pos, ln, ppos);
-       return t != TOKEN_NONE && (rr || roffs[t].flags & ROFFMAC_STRUCT)
-           ? (*roffs[t].proc)(r, t, buf, ln, ppos, pos, offs) : rr
-           ? ROFF_CONT : ROFF_IGN;
+       irc |= t != TOKEN_NONE && (rr || roffs[t].flags & ROFFMAC_STRUCT) ?
+           (*roffs[t].proc)(r, t, buf, ln, ppos, pos, offs) :
+           rr ? ROFF_CONT : ROFF_IGN;
+       return irc;
 }
 
-static enum rofferr
+static int
 roff_cond_text(ROFF_ARGS)
 {
        char            *ep;
-       int              rr;
+       int              endloop, irc, rr;
 
+       irc = ROFF_IGN;
        rr = r->last->rule;
-       roffnode_cleanscope(r);
+       endloop = tok != ROFF_while ? ROFF_IGN :
+           rr ? ROFF_LOOPCONT : ROFF_LOOPEXIT;
+       if (roffnode_cleanscope(r))
+               irc |= endloop;
 
        ep = buf->buf + pos;
        while ((ep = strchr(ep, '\\')) != NULL) {
                if (*(++ep) == '}') {
                        *ep = '&';
-                       roff_ccond(r, ln, ep - buf->buf - 1);
+                       if (roff_ccond(r, ln, ep - buf->buf - 1))
+                               irc |= endloop;
                }
                if (*ep != '\0')
                        ++ep;
        }
-       return rr ? ROFF_CONT : ROFF_IGN;
+       if (rr)
+               irc |= ROFF_CONT;
+       return irc;
 }
 
 /* --- handling of numeric and conditional expressions -------------------- */
@@ -2158,9 +2288,10 @@ out:
 static int
 roff_evalcond(struct roff *r, int ln, char *v, int *pos)
 {
-       char    *cp, *name;
-       size_t   sz;
-       int      deftype, number, savepos, istrue, wanttrue;
+       const char      *start, *end;
+       char            *cp, *name;
+       size_t           sz;
+       int              deftype, len, number, savepos, istrue, wanttrue;
 
        if ('!' == v[*pos]) {
                wanttrue = 0;
@@ -2175,12 +2306,50 @@ roff_evalcond(struct roff *r, int ln, char *v, int *pos)
        case 'o':
                (*pos)++;
                return wanttrue;
-       case 'c':
        case 'e':
        case 't':
        case 'v':
                (*pos)++;
                return !wanttrue;
+       case 'c':
+               do {
+                       (*pos)++;
+               } while (v[*pos] == ' ');
+
+               /*
+                * Quirk for groff compatibility:
+                * The horizontal tab is neither available nor unavailable.
+                */
+
+               if (v[*pos] == '\t') {
+                       (*pos)++;
+                       return 0;
+               }
+
+               /* Printable ASCII characters are available. */
+
+               if (v[*pos] != '\\') {
+                       (*pos)++;
+                       return wanttrue;
+               }
+
+               end = v + ++*pos;
+               switch (mandoc_escape(&end, &start, &len)) {
+               case ESCAPE_SPECIAL:
+                       istrue = mchars_spec2cp(start, len) != -1;
+                       break;
+               case ESCAPE_UNICODE:
+                       istrue = 1;
+                       break;
+               case ESCAPE_NUMBERED:
+                       istrue = mchars_num2char(start, len) != -1;
+                       break;
+               default:
+                       istrue = !wanttrue;
+                       break;
+               }
+               *pos = end - v;
+               return istrue == wanttrue;
        case 'd':
        case 'r':
                cp = v + *pos + 1;
@@ -2212,14 +2381,14 @@ roff_evalcond(struct roff *r, int ln, char *v, int *pos)
                return 0;
 }
 
-static enum rofferr
+static int
 roff_line_ignore(ROFF_ARGS)
 {
 
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_insec(ROFF_ARGS)
 {
 
@@ -2228,7 +2397,7 @@ roff_insec(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_unsupp(ROFF_ARGS)
 {
 
@@ -2237,9 +2406,10 @@ roff_unsupp(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_cond(ROFF_ARGS)
 {
+       int      irc;
 
        roffnode_push(r, tok, NULL, ln, ppos);
 
@@ -2278,9 +2448,10 @@ roff_cond(ROFF_ARGS)
         * Determine scope.
         * If there is nothing on the line after the conditional,
         * not even whitespace, use next-line scope.
+        * Except that .while does not support next-line scope.
         */
 
-       if (buf->buf[pos] == '\0') {
+       if (buf->buf[pos] == '\0' && tok != ROFF_while) {
                r->last->endspan = 2;
                goto out;
        }
@@ -2312,10 +2483,13 @@ roff_cond(ROFF_ARGS)
 
 out:
        *offs = pos;
-       return ROFF_RERUN;
+       irc = ROFF_RERUN;
+       if (tok == ROFF_while)
+               irc |= ROFF_WHILE;
+       return irc;
 }
 
-static enum rofferr
+static int
 roff_ds(ROFF_ARGS)
 {
        char            *string;
@@ -2614,7 +2788,7 @@ roff_getregro(const struct roff *r, const char *name)
 
        switch (*name) {
        case '$':  /* Number of arguments of the last macro evaluated. */
-               return r->argc;
+               return r->mstackpos < 0 ? 0 : r->mstack[r->mstackpos].argc;
        case 'A':  /* ASCII approximation mode is always off. */
                return 0;
        case 'g':  /* Groff compatibility mode is always on. */
@@ -2704,7 +2878,7 @@ roff_freereg(struct roffreg *reg)
        }
 }
 
-static enum rofferr
+static int
 roff_nr(ROFF_ARGS)
 {
        char            *key, *val, *step;
@@ -2738,7 +2912,7 @@ roff_nr(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_rr(ROFF_ARGS)
 {
        struct roffreg  *reg, **prev;
@@ -2768,7 +2942,7 @@ roff_rr(ROFF_ARGS)
 
 /* --- handler functions for roff requests -------------------------------- */
 
-static enum rofferr
+static int
 roff_rm(ROFF_ARGS)
 {
        const char       *name;
@@ -2787,7 +2961,7 @@ roff_rm(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_it(ROFF_ARGS)
 {
        int              iv;
@@ -2816,7 +2990,7 @@ roff_it(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_Dd(ROFF_ARGS)
 {
        int              mask;
@@ -2846,7 +3020,7 @@ roff_Dd(ROFF_ARGS)
        return ROFF_CONT;
 }
 
-static enum rofferr
+static int
 roff_TE(ROFF_ARGS)
 {
        if (r->tbl == NULL) {
@@ -2866,7 +3040,7 @@ roff_TE(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_T_(ROFF_ARGS)
 {
 
@@ -2882,7 +3056,7 @@ roff_T_(ROFF_ARGS)
 /*
  * Handle in-line equation delimiters.
  */
-static enum rofferr
+static int
 roff_eqndelim(struct roff *r, struct buf *buf, int pos)
 {
        char            *cp1, *cp2;
@@ -2945,7 +3119,7 @@ roff_eqndelim(struct roff *r, struct buf *buf, int pos)
        return ROFF_REPARSE;
 }
 
-static enum rofferr
+static int
 roff_EQ(ROFF_ARGS)
 {
        struct roff_node        *n;
@@ -2975,7 +3149,7 @@ roff_EQ(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_EN(ROFF_ARGS)
 {
        if (r->eqn != NULL) {
@@ -2989,7 +3163,7 @@ roff_EN(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_TS(ROFF_ARGS)
 {
        if (r->tbl != NULL) {
@@ -3006,7 +3180,7 @@ roff_TS(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_onearg(ROFF_ARGS)
 {
        struct roff_node        *n;
@@ -3066,7 +3240,7 @@ roff_onearg(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_manyarg(ROFF_ARGS)
 {
        struct roff_node        *n;
@@ -3089,7 +3263,7 @@ roff_manyarg(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_als(ROFF_ARGS)
 {
        char            *oldn, *newn, *end, *value;
@@ -3108,7 +3282,7 @@ roff_als(ROFF_ARGS)
        if (oldsz == 0)
                return ROFF_IGN;
 
-       valsz = mandoc_asprintf(&value, ".%.*s \\$*\\\"\n",
+       valsz = mandoc_asprintf(&value, ".%.*s \\$@\\\"\n",
            (int)oldsz, oldn);
        roff_setstrn(&r->strtab, newn, newsz, value, valsz, 0);
        roff_setstrn(&r->rentab, newn, newsz, NULL, 0, 0);
@@ -3116,7 +3290,7 @@ roff_als(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_br(ROFF_ARGS)
 {
        if (r->man->flags & (MAN_BLINE | MAN_ELINE))
@@ -3130,7 +3304,7 @@ roff_br(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_cc(ROFF_ARGS)
 {
        const char      *p;
@@ -3147,7 +3321,7 @@ roff_cc(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_ec(ROFF_ARGS)
 {
        const char      *p;
@@ -3164,7 +3338,7 @@ roff_ec(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_eo(ROFF_ARGS)
 {
        r->escape = '\0';
@@ -3174,7 +3348,7 @@ roff_eo(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
 roff_nop(ROFF_ARGS)
 {
        while (buf->buf[pos] == ' ')
@@ -3183,7 +3357,7 @@ roff_nop(ROFF_ARGS)
        return ROFF_RERUN;
 }
 
-static enum rofferr
+static int
 roff_tr(ROFF_ARGS)
 {
        const char      *p, *first, *second;
@@ -3245,7 +3419,23 @@ roff_tr(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+/*
+ * Implementation of the .return request.
+ * There is no need to call roff_userret() from here.
+ * The read module will call that after rewinding the reader stack
+ * to the place from where the current macro was called.
+ */
+static int
+roff_return(ROFF_ARGS)
+{
+       if (r->mstackpos >= 0)
+               return ROFF_IGN | ROFF_USERRET;
+
+       mandoc_msg(MANDOCERR_REQ_NOMAC, r->parse, ln, ppos, "return");
+       return ROFF_IGN;
+}
+
+static int
 roff_rn(ROFF_ARGS)
 {
        const char      *value;
@@ -3295,7 +3485,40 @@ roff_rn(ROFF_ARGS)
        return ROFF_IGN;
 }
 
-static enum rofferr
+static int
+roff_shift(ROFF_ARGS)
+{
+       struct mctx     *ctx;
+       int              levels, i;
+
+       levels = 1;
+       if (buf->buf[pos] != '\0' &&
+           roff_evalnum(r, ln, buf->buf, &pos, &levels, 0) == 0) {
+               mandoc_vmsg(MANDOCERR_CE_NONUM, r->parse,
+                   ln, pos, "shift %s", buf->buf + pos);
+               levels = 1;
+       }
+       if (r->mstackpos < 0) {
+               mandoc_msg(MANDOCERR_REQ_NOMAC, r->parse, ln, ppos, "shift");
+               return ROFF_IGN;
+       }
+       ctx = r->mstack + r->mstackpos;
+       if (levels > ctx->argc) {
+               mandoc_vmsg(MANDOCERR_SHIFT, r->parse,
+                   ln, pos, "%d, but max is %d", levels, ctx->argc);
+               levels = ctx->argc;
+       }
+       if (levels == 0)
+               return ROFF_IGN;
+       for (i = 0; i < levels; i++)
+               free(ctx->argv[i]);
+       ctx->argc -= levels;
+       for (i = 0; i < ctx->argc; i++)
+               ctx->argv[i] = ctx->argv[i + levels];
+       return ROFF_IGN;
+}
+
+static int
 roff_so(ROFF_ARGS)
 {
        char *name, *cp;
@@ -3327,154 +3550,68 @@ roff_so(ROFF_ARGS)
 
 /* --- user defined strings and macros ------------------------------------ */
 
-static enum rofferr
+static int
 roff_userdef(ROFF_ARGS)
 {
-       const char       *arg[16], *ap;
-       char             *cp, *n1, *n2;
-       int               expand_count, i, ib, ie;
-       size_t            asz, rsz;
+       struct mctx      *ctx;
+       char             *arg, *ap, *dst, *src;
+       size_t            sz;
 
-       /*
-        * Collect pointers to macro argument strings
-        * and NUL-terminate them.
-        */
+       /* Initialize a new macro stack context. */
 
-       r->argc = 0;
-       cp = buf->buf + pos;
-       for (i = 0; i < 16; i++) {
-               if (*cp == '\0')
-                       arg[i] = "";
-               else {
-                       arg[i] = mandoc_getarg(r->parse, &cp, ln, &pos);
-                       r->argc = i + 1;
-               }
+       if (++r->mstackpos == r->mstacksz) {
+               r->mstack = mandoc_recallocarray(r->mstack,
+                   r->mstacksz, r->mstacksz + 8, sizeof(*r->mstack));
+               r->mstacksz += 8;
        }
+       ctx = r->mstack + r->mstackpos;
+       ctx->argsz = 0;
+       ctx->argc = 0;
+       ctx->argv = NULL;
 
        /*
-        * Expand macro arguments.
+        * Collect pointers to macro argument strings,
+        * NUL-terminating them and escaping quotes.
         */
 
-       buf->sz = strlen(r->current_string) + 1;
-       n1 = n2 = cp = mandoc_malloc(buf->sz);
-       memcpy(n1, r->current_string, buf->sz);
-       expand_count = 0;
-       while (*cp != '\0') {
-
-               /* Scan ahead for the next argument invocation. */
-
-               if (*cp++ != '\\')
-                       continue;
-               if (*cp++ != '$')
-                       continue;
-               if (*cp == '*') {  /* \\$* inserts all arguments */
-                       ib = 0;
-                       ie = r->argc - 1;
-               } else {  /* \\$1 .. \\$9 insert one argument */
-                       ib = ie = *cp - '1';
-                       if (ib < 0 || ib > 8)
-                               continue;
-               }
-               cp -= 2;
-
-               /*
-                * Prevent infinite recursion.
-                */
-
-               if (cp >= n2)
-                       expand_count = 1;
-               else if (++expand_count > EXPAND_LIMIT) {
-                       mandoc_msg(MANDOCERR_ROFFLOOP, r->parse,
-                           ln, (int)(cp - n1), NULL);
-                       free(buf->buf);
-                       buf->buf = n1;
-                       *offs = 0;
-                       return ROFF_IGN;
+       src = buf->buf + pos;
+       while (*src != '\0') {
+               if (ctx->argc == ctx->argsz) {
+                       ctx->argsz += 8;
+                       ctx->argv = mandoc_reallocarray(ctx->argv,
+                           ctx->argsz, sizeof(*ctx->argv));
                }
-
-               /*
-                * Determine the size of the expanded argument,
-                * taking escaping of quotes into account.
-                */
-
-               asz = ie > ib ? ie - ib : 0;  /* for blanks */
-               for (i = ib; i <= ie; i++) {
-                       for (ap = arg[i]; *ap != '\0'; ap++) {
-                               asz++;
-                               if (*ap == '"')
-                                       asz += 3;
-                       }
-               }
-               if (asz != 3) {
-
-                       /*
-                        * Determine the size of the rest of the
-                        * unexpanded macro, including the NUL.
-                        */
-
-                       rsz = buf->sz - (cp - n1) - 3;
-
-                       /*
-                        * When shrinking, move before
-                        * releasing the storage.
-                        */
-
-                       if (asz < 3)
-                               memmove(cp + asz, cp + 3, rsz);
-
-                       /*
-                        * Resize the storage for the macro
-                        * and readjust the parse pointer.
-                        */
-
-                       buf->sz += asz - 3;
-                       n2 = mandoc_realloc(n1, buf->sz);
-                       cp = n2 + (cp - n1);
-                       n1 = n2;
-
-                       /*
-                        * When growing, make room
-                        * for the expanded argument.
-                        */
-
-                       if (asz > 3)
-                               memmove(cp + asz, cp + 3, rsz);
-               }
-
-               /* Copy the expanded argument, escaping quotes. */
-
-               n2 = cp;
-               for (i = ib; i <= ie; i++) {
-                       for (ap = arg[i]; *ap != '\0'; ap++) {
-                               if (*ap == '"') {
-                                       memcpy(n2, "\\(dq", 4);
-                                       n2 += 4;
-                               } else
-                                       *n2++ = *ap;
-                       }
-                       if (i < ie)
-                               *n2++ = ' ';
+               arg = mandoc_getarg(r->parse, &src, ln, &pos);
+               sz = 1;  /* For the terminating NUL. */
+               for (ap = arg; *ap != '\0'; ap++)
+                       sz += *ap == '"' ? 4 : 1;
+               ctx->argv[ctx->argc++] = dst = mandoc_malloc(sz);
+               for (ap = arg; *ap != '\0'; ap++) {
+                       if (*ap == '"') {
+                               memcpy(dst, "\\(dq", 4);
+                               dst += 4;
+                       } else
+                               *dst++ = *ap;
                }
+               *dst = '\0';
        }
 
-       /*
-        * Replace the macro invocation
-        * by the expanded macro.
-        */
+       /* Replace the macro invocation by the macro definition. */
 
        free(buf->buf);
-       buf->buf = n1;
+       buf->buf = mandoc_strdup(r->current_string);
+       buf->sz = strlen(buf->buf) + 1;
        *offs = 0;
 
        return buf->sz > 1 && buf->buf[buf->sz - 2] == '\n' ?
-          ROFF_REPARSE : ROFF_APPEND;
+           ROFF_REPARSE | ROFF_USERCALL : ROFF_IGN | ROFF_APPEND;
 }
 
 /*
  * Calling a high-level macro that was renamed with .rn.
  * r->current_string has already been set up by roff_parse().
  */
-static enum rofferr
+static int
 roff_renamed(ROFF_ARGS)
 {
        char    *nbuf;