]> git.cameronkatri.com Git - mandoc.git/blobdiff - roff.c
clarify the difference between .Cm and .Ic;
[mandoc.git] / roff.c
diff --git a/roff.c b/roff.c
index 43a9d5ef5bf515214e05426251c9317a2577a1b4..a1d4fca374f9126c777f8dc67b08383b9b987443 100644 (file)
--- a/roff.c
+++ b/roff.c
@@ -1,7 +1,7 @@
-/*     $Id: roff.c,v 1.355 2018/12/21 17:15:19 schwarze Exp $ */
+/*     $Id: roff.c,v 1.365 2019/04/21 23:51:21 schwarze Exp $ */
 /*
  * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010-2015, 2017-2019 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -133,15 +133,18 @@ struct    roff {
        char             escape; /* escape character */
 };
 
+/*
+ * A macro definition, condition, or ignored block.
+ */
 struct roffnode {
        enum roff_tok    tok; /* type of node */
        struct roffnode *parent; /* up one in stack */
        int              line; /* parse line */
        int              col; /* parse col */
        char            *name; /* node name, e.g. macro name */
-       char            *end; /* end-rules: custom token */
-       int              endspan; /* end-rules: next-line or infty */
-       int              rule; /* current evaluation rule */
+       char            *end; /* custom end macro of the block */
+       int              endspan; /* scope to: 1=eol 2=next line -1=\} */
+       int              rule; /* content is: 1=evaluated 0=skipped */
 };
 
 #define        ROFF_ARGS        struct roff *r, /* parse ctx */ \
@@ -181,7 +184,7 @@ 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_break(ROFF_ARGS);
 static int              roff_cblock(ROFF_ARGS);
 static int              roff_cc(ROFF_ARGS);
 static int              roff_ccond(struct roff *, int, int);
@@ -221,6 +224,7 @@ static      int              roff_line_ignore(ROFF_ARGS);
 static void             roff_man_alloc1(struct roff_man *);
 static void             roff_man_free1(struct roff_man *);
 static int              roff_manyarg(ROFF_ARGS);
+static int              roff_noarg(ROFF_ARGS);
 static int              roff_nop(ROFF_ARGS);
 static int              roff_nr(ROFF_ARGS);
 static int              roff_onearg(ROFF_ARGS);
@@ -257,8 +261,9 @@ static      int              roff_userdef(ROFF_ARGS);
 #define        ROFFNUM_WHITE   (1 << 1)  /* Skip whitespace in roff_evalnum(). */
 
 const char *__roff_name[MAN_MAX + 1] = {
-       "br",           "ce",           "ft",           "ll",
-       "mc",           "po",           "rj",           "sp",
+       "br",           "ce",           "fi",           "ft",
+       "ll",           "mc",           "nf",
+       "po",           "rj",           "sp",
        "ta",           "ti",           NULL,
        "ab",           "ad",           "af",           "aln",
        "als",          "am",           "am1",          "ami",
@@ -357,7 +362,6 @@ const char *__roff_name[MAN_MAX + 1] = {
        "HP",           "SM",           "SB",           "BI",
        "IB",           "BR",           "RB",           "R",
        "B",            "I",            "IR",           "RI",
-       "nf",           "fi",
        "RE",           "RS",           "DT",           "UC",
        "PD",           "AT",           "in",
        "SY",           "YS",           "OP",
@@ -367,11 +371,13 @@ const char *__roff_name[MAN_MAX + 1] = {
 const  char *const *roff_name = __roff_name;
 
 static struct roffmac   roffs[TOKEN_NONE] = {
-       { roff_br, NULL, NULL, 0 },  /* br */
+       { roff_noarg, NULL, NULL, 0 },  /* br */
        { roff_onearg, NULL, NULL, 0 },  /* ce */
+       { roff_noarg, NULL, NULL, 0 },  /* fi */
        { roff_onearg, NULL, NULL, 0 },  /* ft */
        { roff_onearg, NULL, NULL, 0 },  /* ll */
        { roff_onearg, NULL, NULL, 0 },  /* mc */
+       { roff_noarg, NULL, NULL, 0 },  /* nf */
        { roff_onearg, NULL, NULL, 0 },  /* po */
        { roff_onearg, NULL, NULL, 0 },  /* rj */
        { roff_onearg, NULL, NULL, 0 },  /* sp */
@@ -398,10 +404,10 @@ static    struct roffmac   roffs[TOKEN_NONE] = {
        { roff_unsupp, NULL, NULL, 0 },  /* boxa */
        { roff_line_ignore, NULL, NULL, 0 },  /* bp */
        { roff_unsupp, NULL, NULL, 0 },  /* BP */
-       { roff_unsupp, NULL, NULL, 0 },  /* break */
+       { roff_break, NULL, NULL, 0 },  /* break */
        { roff_line_ignore, NULL, NULL, 0 },  /* breakchar */
        { roff_line_ignore, NULL, NULL, 0 },  /* brnl */
-       { roff_br, NULL, NULL, 0 },  /* brp */
+       { roff_noarg, NULL, NULL, 0 },  /* brp */
        { roff_line_ignore, NULL, NULL, 0 },  /* brpnl */
        { roff_unsupp, NULL, NULL, 0 },  /* c2 */
        { roff_cc, NULL, NULL, 0 },  /* cc */
@@ -683,7 +689,7 @@ roffhash_find(struct ohash *htab, const char *name, size_t sz)
 
 /*
  * Pop the current node off of the stack of roff instructions currently
- * pending.
+ * pending.  Return 1 if it is a loop or 0 otherwise.
  */
 static int
 roffnode_pop(struct roff *r)
@@ -807,9 +813,8 @@ roff_alloc(int options)
 static void
 roff_man_free1(struct roff_man *man)
 {
-
-       if (man->first != NULL)
-               roff_node_delete(man, man->first);
+       if (man->meta.first != NULL)
+               roff_node_delete(man, man->meta.first);
        free(man->meta.msec);
        free(man->meta.vol);
        free(man->meta.os);
@@ -817,27 +822,33 @@ roff_man_free1(struct roff_man *man)
        free(man->meta.title);
        free(man->meta.name);
        free(man->meta.date);
+       free(man->meta.sodest);
 }
 
-static void
-roff_man_alloc1(struct roff_man *man)
+void
+roff_state_reset(struct roff_man *man)
 {
-
-       memset(&man->meta, 0, sizeof(man->meta));
-       man->first = mandoc_calloc(1, sizeof(*man->first));
-       man->first->type = ROFFT_ROOT;
-       man->last = man->first;
+       man->last = man->meta.first;
        man->last_es = NULL;
        man->flags = 0;
-       man->macroset = MACROSET_NONE;
        man->lastsec = man->lastnamed = SEC_NONE;
        man->next = ROFF_NEXT_CHILD;
+       roff_setreg(man->roff, "nS", 0, '=');
+}
+
+static void
+roff_man_alloc1(struct roff_man *man)
+{
+       memset(&man->meta, 0, sizeof(man->meta));
+       man->meta.first = mandoc_calloc(1, sizeof(*man->meta.first));
+       man->meta.first->type = ROFFT_ROOT;
+       man->meta.macroset = MACROSET_NONE;
+       roff_state_reset(man);
 }
 
 void
 roff_man_reset(struct roff_man *man)
 {
-
        roff_man_free1(man);
        roff_man_alloc1(man);
 }
@@ -845,7 +856,6 @@ roff_man_reset(struct roff_man *man)
 void
 roff_man_free(struct roff_man *man)
 {
-
        roff_man_free1(man);
        free(man);
 }
@@ -883,6 +893,10 @@ roff_node_alloc(struct roff_man *man, int line, int pos,
                n->flags |= NODE_SYNPRETTY;
        else
                n->flags &= ~NODE_SYNPRETTY;
+       if ((man->flags & (ROFF_NOFILL | ROFF_NONOFILL)) == ROFF_NOFILL)
+               n->flags |= NODE_NOFILL;
+       else
+               n->flags &= ~NODE_NOFILL;
        if (man->flags & MDOC_NEWLINE)
                n->flags |= NODE_LINE;
        man->flags &= ~MDOC_NEWLINE;
@@ -1020,7 +1034,7 @@ roff_addtbl(struct roff_man *man, int line, struct tbl_node *tbl)
        struct roff_node        *n;
        struct tbl_span         *span;
 
-       if (man->macroset == MACROSET_MAN)
+       if (man->meta.macroset == MACROSET_MAN)
                man_breakscope(man, ROFF_TS);
        while ((span = tbl_span(tbl)) != NULL) {
                n = roff_node_alloc(man, line, 0, ROFFT_TBL, TOKEN_NONE);
@@ -1064,8 +1078,8 @@ roff_node_unlink(struct roff_man *man, struct roff_node *n)
                        man->next = ROFF_NEXT_SIBLING;
                }
        }
-       if (man->first == n)
-               man->first = NULL;
+       if (man->meta.first == n)
+               man->meta.first = NULL;
 }
 
 void
@@ -1992,6 +2006,10 @@ roff_cblock(ROFF_ARGS)
 
 }
 
+/*
+ * Pop all nodes ending at the end of the current input line.
+ * Return the number of loops ended.
+ */
 static int
 roffnode_cleanscope(struct roff *r)
 {
@@ -2006,6 +2024,11 @@ roffnode_cleanscope(struct roff *r)
        return inloop;
 }
 
+/*
+ * Handle the closing \} of a conditional block.
+ * Apart from generating warnings, this only pops nodes.
+ * Return the number of loops ended.
+ */
 static int
 roff_ccond(struct roff *r, int ln, int ppos)
 {
@@ -2225,6 +2248,7 @@ roff_block_text(ROFF_ARGS)
 static int
 roff_cond_sub(ROFF_ARGS)
 {
+       struct roffnode *bl;
        char            *ep;
        int              endloop, irc, rr;
        enum roff_tok    t;
@@ -2272,9 +2296,21 @@ roff_cond_sub(ROFF_ARGS)
         */
 
        t = roff_parse(r, buf->buf, &pos, ln, ppos);
-       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;
+       if (t == ROFF_break) {
+               if (irc & ROFF_LOOPMASK)
+                       irc = ROFF_IGN | ROFF_LOOPEXIT;
+               else if (rr) {
+                       for (bl = r->last; bl != NULL; bl = bl->parent) {
+                               bl->rule = 0;
+                               if (bl->tok == ROFF_while)
+                                       break;
+                       }
+               }
+       } else if (t != TOKEN_NONE &&
+           (rr || roffs[t].flags & ROFFMAC_STRUCT))
+               irc |= (*roffs[t].proc)(r, t, buf, ln, ppos, pos, offs);
+       else
+               irc |= rr ? ROFF_CONT : ROFF_IGN;
        return irc;
 }
 
@@ -2527,7 +2563,7 @@ roff_evalcond(struct roff *r, int ln, char *v, int *pos)
                        roff_getstrn(r, name, sz, &deftype);
                        istrue = !!deftype;
                }
-               *pos = cp - v;
+               *pos = (name + sz) - v;
                return istrue == wanttrue;
        default:
                break;
@@ -2673,8 +2709,15 @@ roff_ds(ROFF_ARGS)
                return ROFF_IGN;
 
        namesz = roff_getname(r, &string, ln, pos);
-       if (name[namesz] == '\\')
+       switch (name[namesz]) {
+       case '\\':
                return ROFF_IGN;
+       case '\t':
+               string = buf->buf + pos + namesz;
+               break;
+       default:
+               break;
+       }
 
        /* Read past the initial double-quote, if any. */
        if (*string == '"')
@@ -3050,7 +3093,7 @@ roff_nr(ROFF_ARGS)
                return ROFF_IGN;
 
        keysz = roff_getname(r, &val, ln, pos);
-       if (key[keysz] == '\\')
+       if (key[keysz] == '\\' || key[keysz] == '\t')
                return ROFF_IGN;
 
        sign = *val;
@@ -3114,7 +3157,7 @@ roff_rm(ROFF_ARGS)
                namesz = roff_getname(r, &cp, ln, (int)(cp - buf->buf));
                roff_setstrn(&r->strtab, name, namesz, NULL, 0, 0);
                roff_setstrn(&r->rentab, name, namesz, NULL, 0, 0);
-               if (name[namesz] == '\\')
+               if (name[namesz] == '\\' || name[namesz] == '\t')
                        break;
        }
        return ROFF_IGN;
@@ -3182,6 +3225,7 @@ roff_Dd(ROFF_ARGS)
 static int
 roff_TE(ROFF_ARGS)
 {
+       r->man->flags &= ~ROFF_NONOFILL;
        if (r->tbl == NULL) {
                mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, ppos, "TE");
                return ROFF_IGN;
@@ -3281,7 +3325,7 @@ roff_EQ(ROFF_ARGS)
 {
        struct roff_node        *n;
 
-       if (r->man->macroset == MACROSET_MAN)
+       if (r->man->meta.macroset == MACROSET_MAN)
                man_breakscope(r->man, ROFF_EQ);
        n = roff_node_alloc(r->man, ln, ppos, ROFFT_EQN, TOKEN_NONE);
        if (ln > r->man->last->line)
@@ -3326,6 +3370,7 @@ roff_TS(ROFF_ARGS)
                mandoc_msg(MANDOCERR_BLK_BROKEN, ln, ppos, "TS breaks TS");
                tbl_end(r->tbl, 0);
        }
+       r->man->flags |= ROFF_NONOFILL;
        r->tbl = tbl_alloc(ppos, ln, r->last_tbl);
        if (r->last_tbl == NULL)
                r->first_tbl = r->tbl;
@@ -3333,6 +3378,26 @@ roff_TS(ROFF_ARGS)
        return ROFF_IGN;
 }
 
+static int
+roff_noarg(ROFF_ARGS)
+{
+       if (r->man->flags & (MAN_BLINE | MAN_ELINE))
+               man_breakscope(r->man, tok);
+       if (tok == ROFF_brp)
+               tok = ROFF_br;
+       roff_elem_alloc(r->man, ln, ppos, tok);
+       if (buf->buf[pos] != '\0')
+               mandoc_msg(MANDOCERR_ARG_SKIP, ln, pos,
+                  "%s %s", roff_name[tok], buf->buf + pos);
+       if (tok == ROFF_nf)
+               r->man->flags |= ROFF_NOFILL;
+       else if (tok == ROFF_fi)
+               r->man->flags &= ~ROFF_NOFILL;
+       r->man->last->flags |= NODE_LINE | NODE_VALID | NODE_ENDED;
+       r->man->next = ROFF_NEXT_SIBLING;
+       return ROFF_IGN;
+}
+
 static int
 roff_onearg(ROFF_ARGS)
 {
@@ -3427,7 +3492,7 @@ roff_als(ROFF_ARGS)
                return ROFF_IGN;
 
        newsz = roff_getname(r, &oldn, ln, pos);
-       if (newn[newsz] == '\\' || *oldn == '\0')
+       if (newn[newsz] == '\\' || newn[newsz] == '\t' || *oldn == '\0')
                return ROFF_IGN;
 
        end = oldn;
@@ -3443,17 +3508,14 @@ roff_als(ROFF_ARGS)
        return ROFF_IGN;
 }
 
+/*
+ * The .break request only makes sense inside conditionals,
+ * and that case is already handled in roff_cond_sub().
+ */
 static int
-roff_br(ROFF_ARGS)
+roff_break(ROFF_ARGS)
 {
-       if (r->man->flags & (MAN_BLINE | MAN_ELINE))
-               man_breakscope(r->man, ROFF_br);
-       roff_elem_alloc(r->man, ln, ppos, ROFF_br);
-       if (buf->buf[pos] != '\0')
-               mandoc_msg(MANDOCERR_ARG_SKIP, ln, pos,
-                   "%s %s", roff_name[tok], buf->buf + pos);
-       r->man->last->flags |= NODE_LINE | NODE_VALID | NODE_ENDED;
-       r->man->next = ROFF_NEXT_SIBLING;
+       mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, pos, "break");
        return ROFF_IGN;
 }
 
@@ -3671,7 +3733,7 @@ roff_rn(ROFF_ARGS)
                return ROFF_IGN;
 
        oldsz = roff_getname(r, &newn, ln, pos);
-       if (oldn[oldsz] == '\\' || *newn == '\0')
+       if (oldn[oldsz] == '\\' || oldn[oldsz] == '\t' || *newn == '\0')
                return ROFF_IGN;
 
        end = newn;
@@ -3779,6 +3841,11 @@ roff_userdef(ROFF_ARGS)
        char             *arg, *ap, *dst, *src;
        size_t            sz;
 
+       /* If the macro is empty, ignore it altogether. */
+
+       if (*r->current_string == '\0')
+               return ROFF_IGN;
+
        /* Initialize a new macro stack context. */
 
        if (++r->mstackpos == r->mstacksz) {
@@ -3826,7 +3893,7 @@ roff_userdef(ROFF_ARGS)
        buf->sz = strlen(buf->buf) + 1;
        *offs = 0;
 
-       return buf->sz > 1 && buf->buf[buf->sz - 2] == '\n' ?
+       return buf->buf[buf->sz - 2] == '\n' ?
            ROFF_REPARSE | ROFF_USERCALL : ROFF_IGN | ROFF_APPEND;
 }
 
@@ -3847,6 +3914,10 @@ roff_renamed(ROFF_ARGS)
        return ROFF_CONT;
 }
 
+/*
+ * Measure the length in bytes of the roff identifier at *cpp
+ * and advance the pointer to the next word.
+ */
 static size_t
 roff_getname(struct roff *r, char **cpp, int ln, int pos)
 {
@@ -3854,22 +3925,24 @@ roff_getname(struct roff *r, char **cpp, int ln, int pos)
        size_t    namesz;
 
        name = *cpp;
-       if ('\0' == *name)
+       if (*name == '\0')
                return 0;
 
-       /* Read until end of name and terminate it with NUL. */
+       /* Advance cp to the byte after the end of the name. */
+
        for (cp = name; 1; cp++) {
-               if ('\0' == *cp || ' ' == *cp) {
-                       namesz = cp - name;
+               namesz = cp - name;
+               if (*cp == '\0')
+                       break;
+               if (*cp == ' ' || *cp == '\t') {
+                       cp++;
                        break;
                }
-               if ('\\' != *cp)
+               if (*cp != '\\')
                        continue;
-               namesz = cp - name;
-               if ('{' == cp[1] || '}' == cp[1])
+               if (cp[1] == '{' || cp[1] == '}')
                        break;
-               cp++;
-               if ('\\' == *cp)
+               if (*++cp == '\\')
                        continue;
                mandoc_msg(MANDOCERR_NAMESC, ln, pos,
                    "%.*s", (int)(cp - name + 1), name);
@@ -3878,7 +3951,8 @@ roff_getname(struct roff *r, char **cpp, int ln, int pos)
        }
 
        /* Read past spaces. */
-       while (' ' == *cp)
+
+       while (*cp == ' ')
                cp++;
 
        *cpp = cp;
@@ -4021,7 +4095,7 @@ roff_getstrn(struct roff *r, const char *name, size_t len,
                        break;
                }
        }
-       if (r->man->macroset != MACROSET_MAN) {
+       if (r->man->meta.macroset != MACROSET_MAN) {
                for (tok = MDOC_Dd; tok < MDOC_MAX; tok++) {
                        if (strncmp(name, roff_name[tok], len) != 0 ||
                            roff_name[tok][len] != '\0')
@@ -4035,7 +4109,7 @@ roff_getstrn(struct roff *r, const char *name, size_t len,
                        }
                }
        }
-       if (r->man->macroset != MACROSET_MDOC) {
+       if (r->man->meta.macroset != MACROSET_MDOC) {
                for (tok = MAN_TH; tok < MAN_MAX; tok++) {
                        if (strncmp(name, roff_name[tok], len) != 0 ||
                            roff_name[tok][len] != '\0')