]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_macro.c
do not break the line between Bsx/Bx/Fx/Nx/Ox/Dx and its arguments
[mandoc.git] / man_macro.c
index 0de6f7ee1084ca663245e36fec5a6f8c450e7913..22b2597d15c4a6f4526b8e48ac4505ef934c30a6 100644 (file)
@@ -1,7 +1,7 @@
-/*     $Id: man_macro.c,v 1.102 2015/04/02 22:48:17 schwarze Exp $ */
+/*     $Id: man_macro.c,v 1.120 2017/05/05 15:17:32 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2012, 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2012-2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
  *
  * Permission to use, copy, modify, and distribute this software for any
 #include "roff.h"
 #include "man.h"
 #include "libmandoc.h"
+#include "roff_int.h"
 #include "libman.h"
 
-enum   rew {
-       REW_REWIND,
-       REW_NOHALT,
-       REW_HALT
-};
-
 static void             blk_close(MACRO_PROT_ARGS);
 static void             blk_exp(MACRO_PROT_ARGS);
 static void             blk_imp(MACRO_PROT_ARGS);
 static void             in_line_eoln(MACRO_PROT_ARGS);
-static int              man_args(struct man *, int,
+static int              man_args(struct roff_man *, int,
                                int *, char *, char **);
+static void             rew_scope(struct roff_man *, enum roff_tok);
 
-static void             rew_scope(enum roff_type, struct man *, int);
-static enum rew         rew_dohalt(int, enum roff_type,
-                               const struct roff_node *);
-static enum rew         rew_block(int, enum roff_type,
-                               const struct roff_node *);
-
-const  struct man_macro __man_macros[MAN_MAX] = {
-       { in_line_eoln, MAN_NSCOPED }, /* br */
+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 */
@@ -72,9 +61,8 @@ const struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */
        { in_line_eoln, 0 }, /* IR */
        { in_line_eoln, 0 }, /* RI */
-       { in_line_eoln, MAN_NSCOPED }, /* sp */
-       { in_line_eoln, MAN_BSCOPE }, /* nf */
-       { in_line_eoln, MAN_BSCOPE }, /* fi */
+       { in_line_eoln, MAN_NSCOPED }, /* nf */
+       { in_line_eoln, MAN_NSCOPED }, /* fi */
        { blk_close, MAN_BSCOPE }, /* RE */
        { blk_exp, MAN_BSCOPE }, /* RS */
        { in_line_eoln, 0 }, /* DT */
@@ -82,20 +70,17 @@ const       struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, MAN_NSCOPED }, /* PD */
        { in_line_eoln, 0 }, /* AT */
        { in_line_eoln, 0 }, /* in */
-       { in_line_eoln, 0 }, /* ft */
        { 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, 0 }, /* ll */
 };
-
-const  struct man_macro * const man_macros = __man_macros;
+const  struct man_macro *const man_macros = __man_macros - MAN_TH;
 
 
 void
-man_unscope(struct man *man, const struct roff_node *to)
+man_unscope(struct roff_man *man, const struct roff_node *to)
 {
        struct roff_node *n;
 
@@ -105,13 +90,12 @@ man_unscope(struct man *man, const struct roff_node *to)
 
                /* Reached the end of the document? */
 
-               if (to == NULL && ! (n->flags & MAN_VALID)) {
+               if (to == NULL && ! (n->flags & NODE_VALID)) {
                        if (man->flags & (MAN_BLINE | MAN_ELINE) &&
                            man_macros[n->tok].flags & MAN_SCOPED) {
                                mandoc_vmsg(MANDOCERR_BLK_LINE,
                                    man->parse, n->line, n->pos,
-                                   "EOF breaks %s",
-                                   man_macronames[n->tok]);
+                                   "EOF breaks %s", roff_name[n->tok]);
                                if (man->flags & MAN_ELINE)
                                        man->flags &= ~MAN_ELINE;
                                else {
@@ -121,14 +105,14 @@ man_unscope(struct man *man, const struct roff_node *to)
                                }
                                man->last = n;
                                n = n->parent;
-                               man_node_delete(man, man->last);
+                               roff_node_delete(man, man->last);
                                continue;
                        }
                        if (n->type == ROFFT_BLOCK &&
                            man_macros[n->tok].fp == blk_exp)
                                mandoc_msg(MANDOCERR_BLK_NOEND,
                                    man->parse, n->line, n->pos,
-                                   man_macronames[n->tok]);
+                                   roff_name[n->tok]);
                }
 
                /*
@@ -140,7 +124,7 @@ man_unscope(struct man *man, const struct roff_node *to)
 
                man->last = n;
                n = n->parent;
-               man_valid_post(man);
+               man->last->flags |= NODE_VALID;
        }
 
        /*
@@ -151,90 +135,7 @@ man_unscope(struct man *man, const struct roff_node *to)
         */
 
        man->next = (man->last == to) ?
-           MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
-}
-
-static enum rew
-rew_block(int ntok, enum roff_type type, const struct roff_node *n)
-{
-
-       if (type == ROFFT_BLOCK && n->parent->tok == ntok &&
-           n->parent->type == ROFFT_BODY)
-               return(REW_REWIND);
-       return(ntok == n->tok ? REW_HALT : REW_NOHALT);
-}
-
-/*
- * There are three scope levels: scoped to the root (all), scoped to the
- * section (all less sections), and scoped to subsections (all less
- * sections and subsections).
- */
-static enum rew
-rew_dohalt(int tok, enum roff_type type, const struct roff_node *n)
-{
-       enum rew         c;
-
-       /* We cannot progress beyond the root ever. */
-       if (n->type == ROFFT_ROOT)
-               return(REW_HALT);
-
-       assert(n->parent);
-
-       /* Normal nodes shouldn't go to the level of the root. */
-       if (n->parent->type == ROFFT_ROOT)
-               return(REW_REWIND);
-
-       /* Already-validated nodes should be closed out. */
-       if (MAN_VALID & n->flags)
-               return(REW_NOHALT);
-
-       /* First: rewind to ourselves. */
-       if (type == n->type && tok == n->tok) {
-               if (man_macros[n->tok].fp == blk_exp)
-                       return(REW_HALT);
-               else
-                       return(REW_REWIND);
-       }
-
-       /*
-        * Next follow the implicit scope-smashings as defined by man.7:
-        * section, sub-section, etc.
-        */
-
-       switch (tok) {
-       case MAN_SH:
-               break;
-       case MAN_SS:
-               /* Rewind to a section, if a block. */
-               if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
-                       return(c);
-               break;
-       case MAN_RS:
-               /* Preserve empty paragraphs before RS. */
-               if (0 == n->nchild && (MAN_P == n->tok ||
-                   MAN_PP == n->tok || MAN_LP == n->tok))
-                       return(REW_HALT);
-               /* Rewind to a subsection, if a block. */
-               if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
-                       return(c);
-               /* Rewind to a section, if a block. */
-               if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
-                       return(c);
-               break;
-       default:
-               /* Rewind to an offsetter, if a block. */
-               if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
-                       return(c);
-               /* Rewind to a subsection, if a block. */
-               if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
-                       return(c);
-               /* Rewind to a section, if a block. */
-               if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
-                       return(c);
-               break;
-       }
-
-       return(REW_NOHALT);
+           ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
 }
 
 /*
@@ -243,30 +144,40 @@ rew_dohalt(int tok, enum roff_type type, const struct roff_node *n)
  * scopes.  When a scope is closed, it must be validated and actioned.
  */
 static void
-rew_scope(enum roff_type type, struct man *man, int tok)
+rew_scope(struct roff_man *man, enum roff_tok tok)
 {
        struct roff_node *n;
-       enum rew         c;
 
-       for (n = man->last; n; n = n->parent) {
-               /*
-                * Whether we should stop immediately (REW_HALT), stop
-                * and rewind until this point (REW_REWIND), or keep
-                * rewinding (REW_NOHALT).
-                */
-               c = rew_dohalt(tok, type, n);
-               if (REW_HALT == c)
-                       return;
-               if (REW_REWIND == c)
-                       break;
-       }
+       /* Preserve empty paragraphs before RS. */
 
-       /*
-        * Rewind until the current point.  Warn if we're a roff
-        * instruction that's mowing over explicit scopes.
-        */
+       n = man->last;
+       if (tok == MAN_RS && n->child == NULL &&
+           (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP))
+               return;
 
-       man_unscope(man, n);
+       for (;;) {
+               if (n->type == ROFFT_ROOT)
+                       return;
+               if (n->flags & NODE_VALID) {
+                       n = n->parent;
+                       continue;
+               }
+               if (n->type != ROFFT_BLOCK) {
+                       if (n->parent->type == ROFFT_ROOT) {
+                               man_unscope(man, n);
+                               return;
+                       } else {
+                               n = n->parent;
+                               continue;
+                       }
+               }
+               if (tok != MAN_SH && (n->tok == MAN_SH ||
+                   (tok != MAN_SS && (n->tok == MAN_SS ||
+                    man_macros[n->tok].fp == blk_exp))))
+                       return;
+               man_unscope(man, n);
+               n = man->last;
+       }
 }
 
 
@@ -276,7 +187,7 @@ rew_scope(enum roff_type type, struct man *man, int tok)
 void
 blk_close(MACRO_PROT_ARGS)
 {
-       int                      ntok;
+       enum roff_tok            ntok;
        const struct roff_node  *nn;
        char                    *p;
        int                      nrew, target;
@@ -308,7 +219,6 @@ blk_close(MACRO_PROT_ARGS)
                break;
        default:
                abort();
-               /* NOTREACHED */
        }
 
        for (nn = man->last->parent; nn; nn = nn->parent)
@@ -317,8 +227,8 @@ blk_close(MACRO_PROT_ARGS)
 
        if (nn == NULL) {
                mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
-                   line, ppos, man_macronames[tok]);
-               rew_scope(ROFFT_BLOCK, man, MAN_PP);
+                   line, ppos, roff_name[tok]);
+               rew_scope(man, MAN_PP);
        } else {
                line = man->last->line;
                ppos = man->last->pos;
@@ -341,22 +251,20 @@ blk_exp(MACRO_PROT_ARGS)
        char            *p;
        int              la;
 
-       rew_scope(ROFFT_BLOCK, man, tok);
-       man_block_alloc(man, line, ppos, tok);
-       man_head_alloc(man, line, ppos, tok);
-       head = man->last;
+       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))
-               man_word_alloc(man, line, la, p);
+               roff_word_alloc(man, line, la, p);
 
        if (buf[*pos] != '\0')
-               mandoc_vmsg(MANDOCERR_ARG_EXCESS,
-                   man->parse, line, *pos, "%s ... %s",
-                   man_macronames[tok], buf + *pos);
+               mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, line,
+                   *pos, "%s ... %s", roff_name[tok], buf + *pos);
 
        man_unscope(man, head);
-       man_body_alloc(man, line, ppos, tok);
+       roff_body_alloc(man, line, ppos, tok);
 }
 
 /*
@@ -372,11 +280,11 @@ blk_imp(MACRO_PROT_ARGS)
        char            *p;
        struct roff_node *n;
 
-       rew_scope(ROFFT_BODY, man, tok);
-       rew_scope(ROFFT_BLOCK, man, tok);
-       man_block_alloc(man, line, ppos, tok);
-       man_head_alloc(man, line, ppos, tok);
-       n = man->last;
+       rew_scope(man, tok);
+       n = roff_block_alloc(man, line, ppos, tok);
+       if (n->tok == MAN_SH || n->tok == MAN_SS)
+               man->flags &= ~MAN_LITERAL;
+       n = roff_head_alloc(man, line, ppos, tok);
 
        /* Add line arguments. */
 
@@ -384,7 +292,7 @@ blk_imp(MACRO_PROT_ARGS)
                la = *pos;
                if ( ! man_args(man, line, pos, buf, &p))
                        break;
-               man_word_alloc(man, line, la, p);
+               roff_word_alloc(man, line, la, p);
        }
 
        /*
@@ -401,8 +309,8 @@ blk_imp(MACRO_PROT_ARGS)
 
        /* Close out the head and open the body. */
 
-       rew_scope(ROFFT_HEAD, man, tok);
-       man_body_alloc(man, line, ppos, tok);
+       man_unscope(man, n);
+       roff_body_alloc(man, line, ppos, tok);
 }
 
 void
@@ -412,22 +320,20 @@ in_line_eoln(MACRO_PROT_ARGS)
        char            *p;
        struct roff_node *n;
 
-       man_elem_alloc(man, line, ppos, tok);
+       roff_elem_alloc(man, line, ppos, tok);
        n = man->last;
 
        for (;;) {
-               if (buf[*pos] != '\0' && (tok == MAN_br ||
-                   tok == MAN_fi || tok == MAN_nf)) {
+               if (buf[*pos] != '\0' && (tok == MAN_fi || tok == MAN_nf)) {
                        mandoc_vmsg(MANDOCERR_ARG_SKIP,
                            man->parse, line, *pos, "%s %s",
-                           man_macronames[tok], buf + *pos);
+                           roff_name[tok], buf + *pos);
                        break;
                }
-               if (buf[*pos] != '\0' && man->last != n &&
-                   (tok == MAN_PD || tok == MAN_ft || tok == MAN_sp)) {
+               if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) {
                        mandoc_vmsg(MANDOCERR_ARG_EXCESS,
                            man->parse, line, *pos, "%s ... %s",
-                           man_macronames[tok], buf + *pos);
+                           roff_name[tok], buf + *pos);
                        break;
                }
                la = *pos;
@@ -435,19 +341,19 @@ in_line_eoln(MACRO_PROT_ARGS)
                        break;
                if (man_macros[tok].flags & MAN_JOIN &&
                    man->last->type == ROFFT_TEXT)
-                       man_word_append(man, p);
+                       roff_word_append(man, p);
                else
-                       man_word_alloc(man, line, la, p);
+                       roff_word_alloc(man, line, la, p);
        }
 
        /*
-        * Append MAN_EOS in case the last snipped argument
+        * Append NODE_EOS in case the last snipped argument
         * ends with a dot, e.g. `.IR syslog (3).'
         */
 
        if (n != man->last &&
            mandoc_eos(man->last->string, strlen(man->last->string)))
-               man->last->flags |= MAN_EOS;
+               man->last->flags |= NODE_EOS;
 
        /*
         * If no arguments are specified and this is MAN_SCOPED (i.e.,
@@ -462,42 +368,27 @@ in_line_eoln(MACRO_PROT_ARGS)
        }
 
        assert(man->last->type != ROFFT_ROOT);
-       man->next = MAN_NEXT_SIBLING;
+       man->next = ROFF_NEXT_SIBLING;
 
-       /*
-        * Rewind our element scope.  Note that when TH is pruned, we'll
-        * be back at the root, so make sure that we don't clobber as
-        * its sibling.
-        */
+       /* Rewind our element scope. */
 
        for ( ; man->last; man->last = man->last->parent) {
+               man_state(man, man->last);
                if (man->last == n)
                        break;
-               if (man->last->type == ROFFT_ROOT)
-                       break;
-               man_valid_post(man);
        }
-
-       assert(man->last);
-
-       /*
-        * Same here regarding whether we're back at the root.
-        */
-
-       if (man->last->type != ROFFT_ROOT)
-               man_valid_post(man);
 }
 
-
 void
-man_macroend(struct man *man)
+man_endparse(struct roff_man *man)
 {
 
        man_unscope(man, man->first);
+       man->flags &= ~MAN_LITERAL;
 }
 
 static int
-man_args(struct man *man, int line, int *pos, char *buf, char **v)
+man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
 {
        char     *start;
 
@@ -506,8 +397,8 @@ man_args(struct man *man, int line, int *pos, char *buf, char **v)
        assert(' ' != *start);
 
        if ('\0' == *start)
-               return(0);
+               return 0;
 
        *v = mandoc_getarg(man->parse, v, line, pos);
-       return(1);
+       return 1;
 }