]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_macro.c
Major cleanup; may imply minor changes in edge cases of error reporting.
[mandoc.git] / man_macro.c
index 84e2b9c9ea5ed9f541f6d290ff7daeef1acfa65d..89b4e7259cadb0d381453b176e8a9bc6cb03a805 100644 (file)
@@ -1,7 +1,7 @@
-/*     $Id: man_macro.c,v 1.119 2017/05/05 13:17:54 schwarze Exp $ */
+/*     $Id: man_macro.c,v 1.134 2018/12/14 01:18:25 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2012-2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2012-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
  *
  * Permission to use, copy, modify, and distribute this software for any
@@ -22,6 +22,7 @@
 
 #include <assert.h>
 #include <ctype.h>
+#include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
@@ -40,46 +41,56 @@ static      int              man_args(struct roff_man *, int,
                                int *, char *, char **);
 static void             rew_scope(struct roff_man *, enum roff_tok);
 
-const  struct man_macro __man_macros[MAN_MAX - MAN_TH] = {
-       { in_line_eoln, MAN_BSCOPE }, /* TH */
-       { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
-       { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
-       { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* TP */
-       { blk_imp, MAN_BSCOPE }, /* LP */
-       { blk_imp, MAN_BSCOPE }, /* PP */
-       { blk_imp, MAN_BSCOPE }, /* P */
-       { blk_imp, MAN_BSCOPE }, /* IP */
-       { blk_imp, MAN_BSCOPE }, /* HP */
-       { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SM */
-       { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SB */
+static const struct man_macro man_macros[MAN_MAX - MAN_TH] = {
+       { in_line_eoln, MAN_XSCOPE }, /* TH */
+       { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SH */
+       { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SS */
+       { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TP */
+       { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TQ */
+       { blk_imp, MAN_XSCOPE }, /* LP */
+       { blk_imp, MAN_XSCOPE }, /* PP */
+       { blk_imp, MAN_XSCOPE }, /* P */
+       { blk_imp, MAN_XSCOPE }, /* IP */
+       { blk_imp, MAN_XSCOPE }, /* HP */
+       { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* SM */
+       { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* SB */
        { in_line_eoln, 0 }, /* BI */
        { in_line_eoln, 0 }, /* IB */
        { in_line_eoln, 0 }, /* BR */
        { in_line_eoln, 0 }, /* RB */
-       { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* R */
-       { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* B */
-       { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */
+       { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* R */
+       { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* B */
+       { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* I */
        { in_line_eoln, 0 }, /* IR */
        { in_line_eoln, 0 }, /* RI */
-       { in_line_eoln, MAN_NSCOPED }, /* sp */
        { in_line_eoln, MAN_NSCOPED }, /* nf */
        { in_line_eoln, MAN_NSCOPED }, /* fi */
-       { blk_close, MAN_BSCOPE }, /* RE */
-       { blk_exp, MAN_BSCOPE }, /* RS */
+       { blk_close, MAN_XSCOPE }, /* RE */
+       { blk_exp, MAN_XSCOPE }, /* RS */
        { in_line_eoln, 0 }, /* DT */
        { in_line_eoln, 0 }, /* UC */
        { in_line_eoln, MAN_NSCOPED }, /* PD */
        { in_line_eoln, 0 }, /* AT */
-       { in_line_eoln, 0 }, /* in */
+       { in_line_eoln, MAN_NSCOPED }, /* in */
+       { blk_imp, MAN_XSCOPE }, /* SY */
+       { blk_close, MAN_XSCOPE }, /* YS */
        { in_line_eoln, 0 }, /* OP */
-       { in_line_eoln, MAN_BSCOPE }, /* EX */
-       { in_line_eoln, MAN_BSCOPE }, /* EE */
-       { blk_exp, MAN_BSCOPE }, /* UR */
-       { blk_close, MAN_BSCOPE }, /* UE */
+       { in_line_eoln, MAN_XSCOPE }, /* EX */
+       { in_line_eoln, MAN_XSCOPE }, /* EE */
+       { blk_exp, MAN_XSCOPE }, /* UR */
+       { blk_close, MAN_XSCOPE }, /* UE */
+       { blk_exp, MAN_XSCOPE }, /* MT */
+       { blk_close, MAN_XSCOPE }, /* ME */
 };
-const  struct man_macro *const man_macros = __man_macros - MAN_TH;
 
 
+const struct man_macro *
+man_macro(enum roff_tok tok)
+{
+       assert(tok >= MAN_TH && tok <= MAN_MAX);
+       return man_macros + (tok - MAN_TH);
+}
+
 void
 man_unscope(struct roff_man *man, const struct roff_node *to)
 {
@@ -93,7 +104,8 @@ man_unscope(struct roff_man *man, const struct roff_node *to)
 
                if (to == NULL && ! (n->flags & NODE_VALID)) {
                        if (man->flags & (MAN_BLINE | MAN_ELINE) &&
-                           man_macros[n->tok].flags & MAN_SCOPED) {
+                           man_macro(n->tok)->flags &
+                            (MAN_BSCOPED | MAN_NSCOPED)) {
                                mandoc_vmsg(MANDOCERR_BLK_LINE,
                                    man->parse, n->line, n->pos,
                                    "EOF breaks %s", roff_name[n->tok]);
@@ -110,7 +122,7 @@ man_unscope(struct roff_man *man, const struct roff_node *to)
                                continue;
                        }
                        if (n->type == ROFFT_BLOCK &&
-                           man_macros[n->tok].fp == blk_exp)
+                           man_macro(n->tok)->fp == blk_exp)
                                mandoc_msg(MANDOCERR_BLK_NOEND,
                                    man->parse, n->line, n->pos,
                                    roff_name[n->tok]);
@@ -174,7 +186,7 @@ rew_scope(struct roff_man *man, enum roff_tok tok)
                }
                if (tok != MAN_SH && (n->tok == MAN_SH ||
                    (tok != MAN_SS && (n->tok == MAN_SS ||
-                    man_macros[n->tok].fp == blk_exp))))
+                    man_macro(n->tok)->fp == blk_exp))))
                        return;
                man_unscope(man, n);
                n = man->last;
@@ -188,10 +200,10 @@ rew_scope(struct roff_man *man, enum roff_tok tok)
 void
 blk_close(MACRO_PROT_ARGS)
 {
-       enum roff_tok            ntok;
+       enum roff_tok            ctok, ntok;
        const struct roff_node  *nn;
        char                    *p;
-       int                      nrew, target;
+       int                      cline, cpos, nrew, target;
 
        nrew = 1;
        switch (tok) {
@@ -215,9 +227,15 @@ blk_close(MACRO_PROT_ARGS)
                        return;
                }
                break;
+       case MAN_YS:
+               ntok = MAN_SY;
+               break;
        case MAN_UE:
                ntok = MAN_UR;
                break;
+       case MAN_ME:
+               ntok = MAN_MT;
+               break;
        default:
                abort();
        }
@@ -230,18 +248,44 @@ blk_close(MACRO_PROT_ARGS)
                mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
                    line, ppos, roff_name[tok]);
                rew_scope(man, MAN_PP);
-       } else {
-               line = man->last->line;
-               ppos = man->last->pos;
-               ntok = man->last->tok;
-               man_unscope(man, nn);
+               if (tok == MAN_RE) {
+                       roff_elem_alloc(man, line, ppos, ROFF_br);
+                       man->last->flags |= NODE_LINE |
+                           NODE_VALID | NODE_ENDED;
+                       man->next = ROFF_NEXT_SIBLING;
+               }
+               return;
+       }
 
-               /* Move a trailing paragraph behind the block. */
+       cline = man->last->line;
+       cpos = man->last->pos;
+       ctok = man->last->tok;
+       man_unscope(man, nn);
 
-               if (ntok == MAN_LP || ntok == MAN_PP || ntok == MAN_P) {
-                       *pos = strlen(buf);
-                       blk_imp(man, ntok, line, ppos, pos, buf);
-               }
+       if (tok == MAN_RE && nn->head->aux > 0)
+               roff_setreg(man->roff, "an-margin", nn->head->aux, '-');
+
+       /* Trailing text. */
+
+       if (buf[*pos] != '\0') {
+               roff_word_alloc(man, line, ppos, buf + *pos);
+               man->last->flags |= NODE_DELIMC;
+               if (mandoc_eos(man->last->string, strlen(man->last->string)))
+                       man->last->flags |= NODE_EOS;
+       }
+
+       /* Move a trailing paragraph behind the block. */
+
+       if (ctok == MAN_LP || ctok == MAN_PP || ctok == MAN_P) {
+               *pos = strlen(buf);
+               blk_imp(man, ctok, cline, cpos, pos, buf);
+       }
+
+       /* Synopsis blocks need an explicit end marker for spacing. */
+
+       if (tok == MAN_YS && man->last == nn) {
+               roff_elem_alloc(man, line, ppos, tok);
+               man_unscope(man, man->last);
        }
 }
 
@@ -252,13 +296,23 @@ blk_exp(MACRO_PROT_ARGS)
        char            *p;
        int              la;
 
-       rew_scope(man, tok);
+       if (tok == MAN_RS)
+               rew_scope(man, tok);
        roff_block_alloc(man, line, ppos, tok);
        head = roff_head_alloc(man, line, ppos, tok);
 
        la = *pos;
-       if (man_args(man, line, pos, buf, &p))
+       if (man_args(man, line, pos, buf, &p)) {
                roff_word_alloc(man, line, la, p);
+               if (tok == MAN_RS) {
+                       if (roff_getreg(man->roff, "an-margin") == 0)
+                               roff_setreg(man->roff, "an-margin",
+                                   7 * 24, '=');
+                       if ((head->aux = strtod(p, NULL) * 24.0) > 0)
+                               roff_setreg(man->roff, "an-margin",
+                                   head->aux, '+');
+               }
+       }
 
        if (buf[*pos] != '\0')
                mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, line,
@@ -299,11 +353,11 @@ blk_imp(MACRO_PROT_ARGS)
        /*
         * For macros having optional next-line scope,
         * keep the head open if there were no arguments.
-        * For `TP', always keep the head open.
+        * For `TP' and `TQ', always keep the head open.
         */
 
-       if (man_macros[tok].flags & MAN_SCOPED &&
-           (tok == MAN_TP || n == man->last)) {
+       if (man_macro(tok)->flags & MAN_BSCOPED &&
+           (tok == MAN_TP || tok == MAN_TQ || n == man->last)) {
                man->flags |= MAN_BLINE;
                return;
        }
@@ -331,8 +385,7 @@ in_line_eoln(MACRO_PROT_ARGS)
                            roff_name[tok], buf + *pos);
                        break;
                }
-               if (buf[*pos] != '\0' && man->last != n &&
-                   (tok == MAN_PD || tok == MAN_sp)) {
+               if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) {
                        mandoc_vmsg(MANDOCERR_ARG_EXCESS,
                            man->parse, line, *pos, "%s ... %s",
                            roff_name[tok], buf + *pos);
@@ -341,7 +394,7 @@ in_line_eoln(MACRO_PROT_ARGS)
                la = *pos;
                if ( ! man_args(man, line, pos, buf, &p))
                        break;
-               if (man_macros[tok].flags & MAN_JOIN &&
+               if (man_macro(tok)->flags & MAN_JOIN &&
                    man->last->type == ROFFT_TEXT)
                        roff_word_append(man, p);
                else
@@ -358,13 +411,12 @@ in_line_eoln(MACRO_PROT_ARGS)
                man->last->flags |= NODE_EOS;
 
        /*
-        * If no arguments are specified and this is MAN_SCOPED (i.e.,
+        * If no arguments are specified and this is MAN_ESCOPED (i.e.,
         * next-line scoped), then set our mode to indicate that we're
         * waiting for terms to load into our context.
         */
 
-       if (n == man->last && man_macros[tok].flags & MAN_SCOPED) {
-               assert( ! (man_macros[tok].flags & MAN_NSCOPED));
+       if (n == man->last && man_macro(tok)->flags & MAN_ESCOPED) {
                man->flags |= MAN_ELINE;
                return;
        }
@@ -379,6 +431,11 @@ in_line_eoln(MACRO_PROT_ARGS)
                if (man->last == n)
                        break;
        }
+
+       /* Rewind next-line scoped ancestors, if any. */
+
+       if (man_macro(tok)->flags & MAN_ESCOPED)
+               man_descope(man, line, ppos, NULL);
 }
 
 void