]> git.cameronkatri.com Git - mandoc.git/blobdiff - roff.c
Sevan Janiyan resigned from the NetBSD project and pkgsrc in 2020.
[mandoc.git] / roff.c
diff --git a/roff.c b/roff.c
index 017f28f9f75109a23b07a49be90f119e9ffa92cb..de75a260f5a769a571c5b077e14aea8ebe590b0f 100644 (file)
--- a/roff.c
+++ b/roff.c
@@ -1,7 +1,7 @@
-/*     $Id: roff.c,v 1.370 2020/02/27 01:43:52 schwarze Exp $ */
+/* $Id: roff.c,v 1.378 2021/08/10 12:55:04 schwarze Exp $ */
 /*
- * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -14,6 +14,8 @@
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *
+ * Implementation of the roff(7) parser for mandoc(1).
  */
 #include "config.h"
 
@@ -190,13 +192,14 @@ static    int              roff_cc(ROFF_ARGS);
 static int              roff_ccond(struct roff *, int, int);
 static int              roff_char(ROFF_ARGS);
 static int              roff_cond(ROFF_ARGS);
+static int              roff_cond_checkend(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_evalcond(struct roff *, int, char *, int *);
 static int              roff_evalnum(struct roff *, int,
                                const char *, int *, int *, int);
 static int              roff_evalpar(struct roff *, int,
@@ -1101,6 +1104,7 @@ roff_node_free(struct roff_node *n)
                free(n->norm);
        eqn_box_free(n->eqn);
        free(n->string);
+       free(n->tag);
        free(n);
 }
 
@@ -1121,7 +1125,13 @@ roff_node_transparent(struct roff_node *n)
                return 0;
        if (n->type == ROFFT_COMMENT || n->flags & NODE_NOPRT)
                return 1;
-       switch (n->tok) {
+       return roff_tok_transparent(n->tok);
+}
+
+int
+roff_tok_transparent(enum roff_tok tok)
+{
+       switch (tok) {
        case ROFF_ft:
        case ROFF_ll:
        case ROFF_mc:
@@ -1173,7 +1183,7 @@ deroff(char **dest, const struct roff_node *n)
        char    *cp;
        size_t   sz;
 
-       if (n->type != ROFFT_TEXT) {
+       if (n->string == NULL) {
                for (n = n->child; n != NULL; n = n->next)
                        deroff(dest, n);
                return;
@@ -1813,7 +1823,7 @@ roff_parsetext(struct roff *r, struct buf *buf, int pos, int *offs)
 }
 
 int
-roff_parseln(struct roff *r, int ln, struct buf *buf, int *offs)
+roff_parseln(struct roff *r, int ln, struct buf *buf, int *offs, size_t len)
 {
        enum roff_tok    t;
        int              e;
@@ -1824,6 +1834,14 @@ roff_parseln(struct roff *r, int ln, struct buf *buf, int *offs)
 
        ppos = pos = *offs;
 
+       if (len > 80 && r->tbl == NULL && r->eqn == NULL &&
+           (r->man->flags & ROFF_NOFILL) == 0 &&
+           strchr(" .\\", buf->buf[pos]) == NULL &&
+           buf->buf[pos] != r->control &&
+           strcspn(buf->buf, " ") < 80)
+               mandoc_msg(MANDOCERR_TEXT_LONG, ln, (int)len - 1,
+                   "%.20s...", buf->buf + pos);
+
        /* Handle in-line equation delimiters. */
 
        if (r->tbl == NULL &&
@@ -2025,14 +2043,13 @@ roff_parse(struct roff *r, char *buf, int *pos, int ln, int ppos)
 
 /* --- handling of request blocks ----------------------------------------- */
 
+/*
+ * Close a macro definition block or an "ignore" block.
+ */
 static int
 roff_cblock(ROFF_ARGS)
 {
-
-       /*
-        * A block-close `..' should only be invoked as a child of an
-        * ignore macro, otherwise raise a warning and just ignore it.
-        */
+       int      rr;
 
        if (r->last == NULL) {
                mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, ppos, "..");
@@ -2041,26 +2058,38 @@ roff_cblock(ROFF_ARGS)
 
        switch (r->last->tok) {
        case ROFF_am:
-               /* ROFF_am1 is remapped to ROFF_am in roff_block(). */
        case ROFF_ami:
        case ROFF_de:
-               /* ROFF_de1 is remapped to ROFF_de in roff_block(). */
        case ROFF_dei:
        case ROFF_ig:
                break;
+       case ROFF_am1:
+       case ROFF_de1:
+               /* Remapped in roff_block(). */
+               abort();
        default:
                mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, ppos, "..");
                return ROFF_IGN;
        }
 
+       roffnode_pop(r);
+       roffnode_cleanscope(r);
+
+       /*
+        * If a conditional block with braces is still open,
+        * check for "\}" block end markers.
+        */
+
+       if (r->last != NULL && r->last->endspan < 0) {
+               rr = 1;  /* If arguments follow "\}", warn about them. */
+               roff_cond_checkend(r, tok, buf, ln, ppos, pos, &rr);
+       }
+
        if (buf->buf[pos] != '\0')
                mandoc_msg(MANDOCERR_ARG_SKIP, ln, pos,
                    ".. %s", buf->buf + pos);
 
-       roffnode_pop(r);
-       roffnode_cleanscope(r);
        return ROFF_IGN;
-
 }
 
 /*
@@ -2073,7 +2102,7 @@ roffnode_cleanscope(struct roff *r)
        int inloop;
 
        inloop = 0;
-       while (r->last != NULL) {
+       while (r->last != NULL && r->last->endspan > 0) {
                if (--r->last->endspan != 0)
                        break;
                inloop += roffnode_pop(r);
@@ -2082,7 +2111,7 @@ roffnode_cleanscope(struct roff *r)
 }
 
 /*
- * Handle the closing \} of a conditional block.
+ * Handle the closing "\}" of a conditional block.
  * Apart from generating warnings, this only pops nodes.
  * Return the number of loops ended.
  */
@@ -2302,13 +2331,20 @@ roff_block_text(ROFF_ARGS)
        return ROFF_IGN;
 }
 
+/*
+ * Check for a closing "\}" and handle it.
+ * In this function, the final "int *offs" argument is used for
+ * different purposes than elsewhere:
+ * Input: *offs == 0: caller wants to discard arguments following \}
+ *        *offs == 1: caller wants to preserve text following \}
+ * Output: *offs = 0: tell caller to discard input line
+ *         *offs = 1: tell caller to use input line
+ */
 static int
-roff_cond_sub(ROFF_ARGS)
+roff_cond_checkend(ROFF_ARGS)
 {
-       struct roffnode *bl;
        char            *ep;
        int              endloop, irc, rr;
-       enum roff_tok    t;
 
        irc = ROFF_IGN;
        rr = r->last->rule;
@@ -2318,23 +2354,28 @@ roff_cond_sub(ROFF_ARGS)
                irc |= endloop;
 
        /*
-        * If `\}' occurs on a macro line without a preceding macro,
-        * drop the line completely.
+        * If "\}" occurs on a macro line without a preceding macro or
+        * a text line contains nothing else, drop the line completely.
         */
 
        ep = buf->buf + pos;
-       if (ep[0] == '\\' && ep[1] == '}')
+       if (ep[0] == '\\' && ep[1] == '}' && (ep[2] == '\0' || *offs == 0))
                rr = 0;
 
        /*
-        * The closing delimiter `\}' rewinds the conditional scope
+        * The closing delimiter "\}" rewinds the conditional scope
         * but is otherwise ignored when interpreting the line.
         */
 
        while ((ep = strchr(ep, '\\')) != NULL) {
                switch (ep[1]) {
                case '}':
-                       memmove(ep, ep + 2, strlen(ep + 2) + 1);
+                       if (ep[2] == '\0')
+                               ep[0] = '\0';
+                       else if (rr)
+                               ep[1] = '&';
+                       else
+                               memmove(ep, ep + 2, strlen(ep + 2) + 1);
                        if (roff_ccond(r, ln, ep - buf->buf))
                                irc |= endloop;
                        break;
@@ -2346,7 +2387,22 @@ roff_cond_sub(ROFF_ARGS)
                        break;
                }
        }
+       *offs = rr;
+       return irc;
+}
 
+/*
+ * Parse and process a request or macro line in conditional scope.
+ */
+static int
+roff_cond_sub(ROFF_ARGS)
+{
+       struct roffnode *bl;
+       int              irc, rr;
+       enum roff_tok    t;
+
+       rr = 0;  /* If arguments follow "\}", skip them. */
+       irc = roff_cond_checkend(r, tok, buf, ln, ppos, pos, &rr);
        t = roff_parse(r, buf->buf, &pos, ln, ppos);
 
        /* For now, let high level macros abort .ce mode. */
@@ -2383,48 +2439,16 @@ roff_cond_sub(ROFF_ARGS)
        return irc;
 }
 
+/*
+ * Parse and process a text line in conditional scope.
+ */
 static int
 roff_cond_text(ROFF_ARGS)
 {
-       char            *ep;
-       int              endloop, irc, rr;
-
-       irc = ROFF_IGN;
-       rr = r->last->rule;
-       endloop = tok != ROFF_while ? ROFF_IGN :
-           rr ? ROFF_LOOPCONT : ROFF_LOOPEXIT;
-       if (roffnode_cleanscope(r))
-               irc |= endloop;
-
-       /*
-        * If `\}' occurs on a text line with neither preceding
-        * nor following characters, drop the line completely.
-        */
-
-       ep = buf->buf + pos;
-       if (strcmp(ep, "\\}") == 0)
-               rr = 0;
-
-       /*
-        * The closing delimiter `\}' rewinds the conditional scope
-        * but is otherwise ignored when interpreting the line.
-        */
+       int      irc, rr;
 
-       while ((ep = strchr(ep, '\\')) != NULL) {
-               switch (ep[1]) {
-               case '}':
-                       memmove(ep, ep + 2, strlen(ep + 2) + 1);
-                       if (roff_ccond(r, ln, ep - buf->buf))
-                               irc |= endloop;
-                       break;
-               case '\0':
-                       ++ep;
-                       break;
-               default:
-                       ep += 2;
-                       break;
-               }
-       }
+       rr = 1;  /* If arguments follow "\}", preserve them. */
+       irc = roff_cond_checkend(r, tok, buf, ln, ppos, pos, &rr);
        if (rr)
                irc |= ROFF_CONT;
        return irc;
@@ -3643,7 +3667,9 @@ roff_char(ROFF_ARGS)
                case ESCAPE_FONTITALIC:
                case ESCAPE_FONTBOLD:
                case ESCAPE_FONTBI:
-               case ESCAPE_FONTCW:
+               case ESCAPE_FONTCR:
+               case ESCAPE_FONTCB:
+               case ESCAPE_FONTCI:
                case ESCAPE_FONTPREV:
                        font++;
                        break;