]> git.cameronkatri.com Git - mandoc.git/blobdiff - man.c
When formatting man(7) documents that do not contain .SH macros
[mandoc.git] / man.c
diff --git a/man.c b/man.c
index f231f9b69377181191c97727970f047e3eeb89f8..7a2bcc96881893e8ee041829f5c4773a64a40e29 100644 (file)
--- a/man.c
+++ b/man.c
@@ -1,7 +1,7 @@
-/*     $Id: man.c,v 1.164 2015/09/04 21:25:00 schwarze Exp $ */
+/*     $Id: man.c,v 1.176 2017/06/28 12:52:45 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2013, 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
 #include "roff_int.h"
 #include "libman.h"
 
-const  char *const __man_macronames[MAN_MAX] = {
-       "br",           "TH",           "SH",           "SS",
-       "TP",           "LP",           "PP",           "P",
-       "IP",           "HP",           "SM",           "SB",
-       "BI",           "IB",           "BR",           "RB",
-       "R",            "B",            "I",            "IR",
-       "RI",           "sp",           "nf",
-       "fi",           "RE",           "RS",           "DT",
-       "UC",           "PD",           "AT",           "in",
-       "ft",           "OP",           "EX",           "EE",
-       "UR",           "UE",           "ll"
-       };
-
-const  char * const *man_macronames = __man_macronames;
-
 static void             man_descope(struct roff_man *, int, int);
 static int              man_ptext(struct roff_man *, int, char *, int);
 static int              man_pmacro(struct roff_man *, int, char *, int);
@@ -62,9 +47,9 @@ man_parseln(struct roff_man *man, int ln, char *buf, int offs)
        if (man->last->type != ROFFT_EQN || ln > man->last->line)
                man->flags |= MAN_NEWLINE;
 
-       return (roff_getcontrol(man->roff, buf, &offs) ?
+       return roff_getcontrol(man->roff, buf, &offs) ?
            man_pmacro(man, ln, buf, offs) :
-           man_ptext(man, ln, buf, offs));
+           man_ptext(man, ln, buf, offs);
 }
 
 static void
@@ -91,31 +76,52 @@ static int
 man_ptext(struct roff_man *man, int line, char *buf, int offs)
 {
        int              i;
+       const char      *cp, *sp;
+       char            *ep;
 
        /* Literal free-form text whitespace is preserved. */
 
        if (man->flags & MAN_LITERAL) {
                roff_word_alloc(man, line, offs, buf + offs);
                man_descope(man, line, offs);
-               return(1);
+               return 1;
        }
 
        for (i = offs; buf[i] == ' '; i++)
                /* Skip leading whitespace. */ ;
 
        /*
-        * Blank lines are ignored right after headings
+        * Blank lines are ignored in next line scope
+        * and right after headings and cancel preceding \c,
         * but add a single vertical space elsewhere.
         */
 
        if (buf[i] == '\0') {
-               /* Allocate a blank entry. */
-               if (man->last->tok != MAN_SH &&
-                   man->last->tok != MAN_SS) {
-                       roff_elem_alloc(man, line, offs, MAN_sp);
-                       man->next = ROFF_NEXT_SIBLING;
+               if (man->flags & (MAN_ELINE | MAN_BLINE)) {
+                       mandoc_msg(MANDOCERR_BLK_BLANK, man->parse,
+                           line, 0, NULL);
+                       return 1;
+               }
+               if (man->last->tok == MAN_SH || man->last->tok == MAN_SS)
+                       return 1;
+               switch (man->last->type) {
+               case ROFFT_TEXT:
+                       sp = man->last->string;
+                       cp = ep = strchr(sp, '\0') - 2;
+                       if (cp < sp || cp[0] != '\\' || cp[1] != 'c')
+                               break;
+                       while (cp > sp && cp[-1] == '\\')
+                               cp--;
+                       if ((ep - cp) % 2)
+                               break;
+                       *ep = '\0';
+                       return 1;
+               default:
+                       break;
                }
-               return(1);
+               roff_elem_alloc(man, line, offs, ROFF_sp);
+               man->next = ROFF_NEXT_SIBLING;
+               return 1;
        }
 
        /*
@@ -149,10 +155,10 @@ man_ptext(struct roff_man *man, int line, char *buf, int offs)
 
        assert(i);
        if (mandoc_eos(buf, (size_t)i))
-               man->last->flags |= MAN_EOS;
+               man->last->flags |= NODE_EOS;
 
        man_descope(man, line, offs);
-       return(1);
+       return 1;
 }
 
 static int
@@ -160,30 +166,23 @@ man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
 {
        struct roff_node *n;
        const char      *cp;
-       int              tok;
-       int              i, ppos;
+       size_t           sz;
+       enum roff_tok    tok;
+       int              ppos;
        int              bline;
-       char             mac[5];
-
-       ppos = offs;
-
-       /*
-        * Copy the first word into a nil-terminated buffer.
-        * Stop when a space, tab, escape, or eoln is encountered.
-        */
-
-       i = 0;
-       while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
-               mac[i++] = buf[offs++];
-
-       mac[i] = '\0';
 
-       tok = (i > 0 && i < 4) ? man_hash_find(mac) : TOKEN_NONE;
+       /* Determine the line macro. */
 
+       ppos = offs;
+       tok = TOKEN_NONE;
+       for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
+               offs++;
+       if (sz > 0 && sz < 4)
+               tok = roffhash_find(man->manmac, buf + ppos, sz);
        if (tok == TOKEN_NONE) {
                mandoc_msg(MANDOCERR_MACRO, man->parse,
                    ln, ppos, buf + ppos - 1);
-               return(1);
+               return 1;
        }
 
        /* Skip a leading escape sequence or tab. */
@@ -203,7 +202,7 @@ man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
 
        /* Jump to the next non-whitespace word. */
 
-       while (buf[offs] && buf[offs] == ' ')
+       while (buf[offs] == ' ')
                offs++;
 
        /*
@@ -223,6 +222,20 @@ man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
        man_breakscope(man, tok);
        bline = man->flags & MAN_BLINE;
 
+       /*
+        * If the line in next-line scope ends with \c, keep the
+        * next-line scope open for the subsequent input line.
+        * That is not at all portable, only groff >= 1.22.4
+        * does it, but *if* this weird idiom occurs in a manual
+        * page, that's very likely what the author intended.
+        */
+
+       if (bline) {
+               cp = strchr(buf + offs, '\0') - 2;
+               if (cp >= buf && cp[0] == '\\' && cp[1] == 'c')
+                       bline = 0;
+       }
+
        /* Call to handler... */
 
        assert(man_macros[tok].fp);
@@ -234,7 +247,7 @@ man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
                n = man->last;
                if (n->type == ROFFT_BODY &&
                    strcmp(n->prev->child->string, "NAME"))
-                       return(2);
+                       return 2;
        }
 
        /*
@@ -245,14 +258,14 @@ man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
 
        if ( ! bline || man->flags & MAN_ELINE ||
            man_macros[tok].flags & MAN_NSCOPED)
-               return(1);
+               return 1;
 
        assert(man->flags & MAN_BLINE);
        man->flags &= ~MAN_BLINE;
 
        man_unscope(man, man->last->parent);
        roff_body_alloc(man, ln, ppos, man->last->tok);
-       return(1);
+       return 1;
 }
 
 void
@@ -266,17 +279,18 @@ man_breakscope(struct roff_man *man, int tok)
         * Delete the element that is being broken.
         */
 
-       if (man->flags & MAN_ELINE && (tok == TOKEN_NONE ||
+       if (man->flags & MAN_ELINE && (tok < MAN_TH ||
            ! (man_macros[tok].flags & MAN_NSCOPED))) {
                n = man->last;
-               assert(n->type != ROFFT_TEXT);
-               if (man_macros[n->tok].flags & MAN_NSCOPED)
+               if (n->type == ROFFT_TEXT)
+                       n = n->parent;
+               if (n->tok < MAN_TH ||
+                   man_macros[n->tok].flags & MAN_NSCOPED)
                        n = n->parent;
 
                mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                    n->line, n->pos, "%s breaks %s",
-                   tok == TOKEN_NONE ? "TS" : man_macronames[tok],
-                   man_macronames[n->tok]);
+                   roff_name[tok], roff_name[n->tok]);
 
                roff_node_delete(man, n);
                man->flags &= ~MAN_ELINE;
@@ -302,12 +316,13 @@ man_breakscope(struct roff_man *man, int tok)
         * Delete the block that is being broken.
         */
 
-       if (man->flags & MAN_BLINE && (tok == TOKEN_NONE ||
+       if (man->flags & MAN_BLINE && (tok < MAN_TH ||
            man_macros[tok].flags & MAN_BSCOPE)) {
                n = man->last;
                if (n->type == ROFFT_TEXT)
                        n = n->parent;
-               if ( ! (man_macros[n->tok].flags & MAN_BSCOPE))
+               if (n->tok < MAN_TH ||
+                   (man_macros[n->tok].flags & MAN_BSCOPE) == 0)
                        n = n->parent;
 
                assert(n->type == ROFFT_HEAD);
@@ -317,8 +332,7 @@ man_breakscope(struct roff_man *man, int tok)
 
                mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                    n->line, n->pos, "%s breaks %s",
-                   tok == TOKEN_NONE ? "TS" : man_macronames[tok],
-                   man_macronames[n->tok]);
+                   roff_name[tok], roff_name[n->tok]);
 
                roff_node_delete(man, n);
                man->flags &= ~MAN_BLINE;
@@ -330,5 +344,40 @@ man_mparse(const struct roff_man *man)
 {
 
        assert(man && man->parse);
-       return(man->parse);
+       return man->parse;
+}
+
+void
+man_state(struct roff_man *man, struct roff_node *n)
+{
+
+       switch(n->tok) {
+       case MAN_nf:
+       case MAN_EX:
+               if (man->flags & MAN_LITERAL && ! (n->flags & NODE_VALID))
+                       mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
+                           n->line, n->pos, "nf");
+               man->flags |= MAN_LITERAL;
+               break;
+       case MAN_fi:
+       case MAN_EE:
+               if ( ! (man->flags & MAN_LITERAL) &&
+                    ! (n->flags & NODE_VALID))
+                       mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
+                           n->line, n->pos, "fi");
+               man->flags &= ~MAN_LITERAL;
+               break;
+       default:
+               break;
+       }
+       man->last->flags |= NODE_VALID;
+}
+
+void
+man_validate(struct roff_man *man)
+{
+
+       man->last = man->first;
+       man_node_validate(man);
+       man->flags &= ~MAN_LITERAL;
 }