In the validators, translate obsolete macro aliases (Lp, Ot, LP, P)

[mandoc.git] / man.c

diff --git a/man.c b/man.c
index ec894c808953e81c2a8687f82410bfd263264a7d..e36dc833ff9c1b54c961b675a6cd7931f3a72d58 100644 (file)
--- a/man.c
+++ b/man.c
@@ -1,368 +1,386 @@
-/* $Id: man.c,v 1.1 2009/03/23 14:22:11 kristaps Exp $ */
+/*     $Id: man.c,v 1.180 2018/08/26 16:21:23 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2013,2014,2015,2017,2018 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.org>

  *
  * Permission to use, copy, modify, and distribute this software for any
  *
  * Permission to use, copy, modify, and distribute this software for any

- * purpose with or without fee is hereby granted, provided that the
- * above copyright notice and this permission notice appear in all
- * copies.
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.

  *
  *

- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
- * DAMAGES OR ANY DAMAGES 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.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * 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.

  */
  */

+#include "config.h"
+
+#include <sys/types.h>
+

 #include <assert.h>
 #include <ctype.h>
 #include <assert.h>
 #include <ctype.h>

-#include <err.h>

 #include <stdarg.h>
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
 
 #include <stdarg.h>
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
 

+#include "mandoc_aux.h"
+#include "mandoc.h"
+#include "roff.h"
+#include "man.h"
+#include "libmandoc.h"
+#include "roff_int.h"

 #include "libman.h"
 
 #include "libman.h"
 

-const  char *const __man_macronames[MAN_MAX] = {                
-       "\\\"",         "TH",           "SH",           "SS",
-       "TP",           "LP",           "PP",           "P",
-       "IP",           "HP",           "SM",           "SB",
-       "BI",           "IB",           "BR",           "RB",
-       "R",            "B",            "I"
-       };
-
-const  char * const *man_macronames = __man_macronames;
-
-static struct man_node *man_node_alloc(int, int, enum man_type);
-static int              man_node_append(struct man *, 
-                               struct man_node *);
-static int              man_ptext(struct man *, int, char *);
-static int              man_pmacro(struct man *, int, char *);
+static char            *man_hasc(char *);
+static int              man_ptext(struct roff_man *, int, char *, int);
+static int              man_pmacro(struct roff_man *, int, char *, int);

 
 
 
 

-const struct man_node *
-man_node(const struct man *man)
+int
+man_parseln(struct roff_man *man, int ln, char *buf, int offs)

 {
 
 {
 

-       return(man->first);
-}
-
+       if (man->last->type != ROFFT_EQN || ln > man->last->line)
+               man->flags |= MAN_NEWLINE;

 
 

-const struct man_meta *
-man_meta(const struct man *man)
-{
-
-       return(&man->meta);
+       return roff_getcontrol(man->roff, buf, &offs) ?
+           man_pmacro(man, ln, buf, offs) :
+           man_ptext(man, ln, buf, offs);

 }
 
 }
 

-
-void
-man_reset(struct man *man)
+/*
+ * If the string ends with \c, return a pointer to the backslash.
+ * Otherwise, return NULL.
+ */
+static char *
+man_hasc(char *start)

 {
 {

+       char    *cp, *ep;

 
 

-       if (man->first)
-               man_node_freelist(man->first);
-       if (man->meta.title)
-               free(man->meta.title);
-       if (man->meta.os)
-               free(man->meta.os);
-       if (man->meta.vol)
-               free(man->meta.vol);
-
-       bzero(&man->meta, sizeof(struct man_meta));
-       man->flags = 0;
-       if (NULL == (man->last = calloc(1, sizeof(struct man_node))))
-               err(1, "malloc");
-       man->first = man->last;
-       man->last->type = MAN_ROOT;
-       man->next = MAN_NEXT_CHILD;
+       ep = strchr(start, '\0') - 2;
+       if (ep < start || ep[0] != '\\' || ep[1] != 'c')
+               return NULL;
+       for (cp = ep; cp > start; cp--)
+               if (cp[-1] != '\\')
+                       break;
+       return (ep - cp) % 2 ? NULL : ep;

 }
 
 }
 

-

 void
 void

-man_free(struct man *man)
-{
-
-       if (man->first)
-               man_node_freelist(man->first);
-       if (man->meta.title)
-               free(man->meta.title);
-       if (man->meta.os)
-               free(man->meta.os);
-       if (man->meta.vol)
-               free(man->meta.vol);
-       if (man->htab)
-               man_hash_free(man->htab);
-       free(man);
-}
-
-
-struct man *
-man_alloc(void)
-{
-       struct man      *p;
-
-       if (NULL == (p = calloc(1, sizeof(struct man))))
-               err(1, "malloc");
-       if (NULL == (p->last = calloc(1, sizeof(struct man_node))))
-               err(1, "malloc");
-
-       p->first = p->last;
-       p->last->type = MAN_ROOT;
-       p->next = MAN_NEXT_CHILD;
-       p->htab = man_hash_alloc();
-       return(p);
-}
-
-
-int
-man_endparse(struct man *m)
-{
-
-       return(1);
-}
-
-
-int
-man_parseln(struct man *m, int ln, char *buf)
+man_descope(struct roff_man *man, int line, int offs, char *start)

 {
 {

-
-       return('.' == *buf ? 
-                       man_pmacro(m, ln, buf) : 
-                       man_ptext(m, ln, buf));
+       /* Trailing \c keeps next-line scope open. */
+
+       if (start != NULL && man_hasc(start) != NULL)
+               return;
+
+       /*
+        * Co-ordinate what happens with having a next-line scope open:
+        * first close out the element scopes (if applicable),
+        * then close out the block scope (also if applicable).
+        */
+
+       if (man->flags & MAN_ELINE) {
+               while (man->last->parent->type != ROFFT_ROOT &&
+                   man_macro(man->last->parent->tok)->flags & MAN_ESCOPED)
+                       man_unscope(man, man->last->parent);
+               man->flags &= ~MAN_ELINE;
+       }
+       if ( ! (man->flags & MAN_BLINE))
+               return;
+       man->flags &= ~MAN_BLINE;
+       man_unscope(man, man->last->parent);
+       roff_body_alloc(man, line, offs, man->last->tok);

 }
 
 }
 

-

 static int
 static int

-man_node_append(struct man *man, struct man_node *p)
+man_ptext(struct roff_man *man, int line, char *buf, int offs)

 {
 {

+       int              i;
+       char            *ep;

 
 

-       assert(man->last);
-       assert(man->first);
-       assert(MAN_ROOT != p->type);
+       /* Literal free-form text whitespace is preserved. */

 
 

-       switch (man->next) {
-       case (MAN_NEXT_SIBLING):
-               man->last->next = p;
-               p->prev = man->last;
-               p->parent = man->last->parent;
-               break;
-       case (MAN_NEXT_CHILD):
-               man->last->child = p;
-               p->parent = man->last;
-               break;
-       default:
-               abort();
-               /* NOTREACHED */
+       if (man->flags & MAN_LITERAL) {
+               roff_word_alloc(man, line, offs, buf + offs);
+               man_descope(man, line, offs, buf + offs);
+               return 1;

        }
 
        }
 

-#if 0
-       if ( ! man_valid_pre(man, p))
-               return(0);
-       if ( ! man_action_pre(man, p))
-               return(0);
-#endif
-
-       switch (p->type) {
-       case (MAN_HEAD):
-               assert(MAN_BLOCK == p->parent->type);
-               p->parent->head = p;
-               break;
-       case (MAN_BODY):
-               assert(MAN_BLOCK == p->parent->type);
-               p->parent->body = p;
-               break;
-       default:
-               break;
+       for (i = offs; buf[i] == ' '; i++)
+               /* Skip leading whitespace. */ ;
+
+       /*
+        * 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') {
+               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;
+               if (man->last->type == ROFFT_TEXT &&
+                   ((ep = man_hasc(man->last->string)) != NULL)) {
+                       *ep = '\0';
+                       return 1;
+               }
+               roff_elem_alloc(man, line, offs, ROFF_sp);
+               man->next = ROFF_NEXT_SIBLING;
+               return 1;

        }
 
        }
 

-       man->last = p;
-       return(1);
-}
+       /*
+        * Warn if the last un-escaped character is whitespace. Then
+        * strip away the remaining spaces (tabs stay!).
+        */

 
 

+       i = (int)strlen(buf);
+       assert(i);

 
 

-static struct man_node *
-man_node_alloc(int line, int pos, enum man_type type)
-{
-       struct man_node *p;
+       if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
+               if (i > 1 && '\\' != buf[i - 2])
+                       mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
+                           line, i - 1, NULL);

 
 

-       if (NULL == (p = calloc(1, sizeof(struct man_node))))
-               err(1, "malloc");
-       p->line = line;
-       p->pos = pos;
-       p->type = type;
+               for (--i; i && ' ' == buf[i]; i--)
+                       /* Spin back to non-space. */ ;

 
 

-       return(p);
-}
+               /* Jump ahead of escaped whitespace. */
+               i += '\\' == buf[i] ? 2 : 1;

 
 

+               buf[i] = '\0';
+       }
+       roff_word_alloc(man, line, offs, buf + offs);

 
 

-int
-man_head_alloc(struct man *man, int line, int pos, int tok)
-{
-       struct man_node *p;
+       /*
+        * End-of-sentence check.  If the last character is an unescaped
+        * EOS character, then flag the node as being the end of a
+        * sentence.  The front-end will know how to interpret this.
+        */

 
 

-       p = man_node_alloc(line, pos, MAN_HEAD);
-       p->tok = tok;
+       assert(i);
+       if (mandoc_eos(buf, (size_t)i))
+               man->last->flags |= NODE_EOS;

 
 

-       return(man_node_append(man, p));
+       man_descope(man, line, offs, buf + offs);
+       return 1;

 }
 
 }
 

-
-int
-man_body_alloc(struct man *man, int line, int pos, int tok)
+static int
+man_pmacro(struct roff_man *man, int ln, char *buf, int offs)

 {
 {

-       struct man_node *p;
-
-       p = man_node_alloc(line, pos, MAN_BODY);
-       p->tok = tok;
-
-       return(man_node_append(man, p));
-}
+       struct roff_node *n;
+       const char      *cp;
+       size_t           sz;
+       enum roff_tok    tok;
+       int              ppos;
+       int              bline;
+
+       /* 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;
+       }

 
 

+       /* Skip a leading escape sequence or tab. */

 
 

-int
-man_block_alloc(struct man *man, int line, int pos, int tok)
-{
-       struct man_node *p;
+       switch (buf[offs]) {
+       case '\\':
+               cp = buf + offs + 1;
+               mandoc_escape(&cp, NULL, NULL);
+               offs = cp - buf;
+               break;
+       case '\t':
+               offs++;
+               break;
+       default:
+               break;
+       }

 
 

-       p = man_node_alloc(line, pos, MAN_BLOCK);
-       p->tok = tok;
+       /* Jump to the next non-whitespace word. */

 
 

-       return(man_node_append(man, p));
-}
+       while (buf[offs] == ' ')
+               offs++;

 
 

+       /*
+        * Trailing whitespace.  Note that tabs are allowed to be passed
+        * into the parser as "text", so we only warn about spaces here.
+        */

 
 

-int
-man_elem_alloc(struct man *man, int line, int pos, int tok)
-{
-       struct man_node *p;
+       if (buf[offs] == '\0' && buf[offs - 1] == ' ')
+               mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
+                   ln, offs - 1, NULL);

 
 

-       p = man_node_alloc(line, pos, MAN_ELEM);
-       p->tok = tok;
+       /*
+        * Some macros break next-line scopes; otherwise, remember
+        * whether we are in next-line scope for a block head.
+        */

 
 

-       return(man_node_append(man, p));
-}
+       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.
+        */

 
 

-int
-man_word_alloc(struct man *man, 
-               int line, int pos, const char *word)
-{
-       struct man_node *p;
+       if (bline && man_hasc(buf + offs))
+               bline = 0;

 
 

-       p = man_node_alloc(line, pos, MAN_TEXT);
-       if (NULL == (p->string = strdup(word)))
-               err(1, "strdup");
+       /* Call to handler... */

 
 

-       return(man_node_append(man, p));
-}
+       (*man_macro(tok)->fp)(man, tok, ln, ppos, &offs, buf);

 
 

+       /* In quick mode (for mandocdb), abort after the NAME section. */

 
 

-void
-man_node_free(struct man_node *p)
-{
+       if (man->quick && tok == MAN_SH) {
+               n = man->last;
+               if (n->type == ROFFT_BODY &&
+                   strcmp(n->prev->child->string, "NAME"))
+                       return 2;
+       }

 
 

-       if (p->string)
-               free(p->string);
-       free(p);
+       /*
+        * If we are in a next-line scope for a block head,
+        * close it out now and switch to the body,
+        * unless the next-line scope is allowed to continue.
+        */
+
+       if (bline == 0 ||
+           (man->flags & MAN_BLINE) == 0 ||
+           man->flags & MAN_ELINE ||
+           man_macro(tok)->flags & MAN_NSCOPED)
+               return 1;
+
+       man->flags &= ~MAN_BLINE;
+       man_unscope(man, man->last->parent);
+       roff_body_alloc(man, ln, ppos, man->last->tok);
+       return 1;

 }
 
 }
 

-

 void
 void

-man_node_freelist(struct man_node *p)
+man_breakscope(struct roff_man *man, int tok)

 {
 {

+       struct roff_node *n;
+
+       /*
+        * An element next line scope is open,
+        * and the new macro is not allowed inside elements.
+        * Delete the element that is being broken.
+        */
+
+       if (man->flags & MAN_ELINE && (tok < MAN_TH ||
+           (man_macro(tok)->flags & MAN_NSCOPED) == 0)) {
+               n = man->last;
+               if (n->type == ROFFT_TEXT)
+                       n = n->parent;
+               if (n->tok < MAN_TH ||
+                   (man_macro(n->tok)->flags & (MAN_NSCOPED | MAN_ESCOPED))
+                    == MAN_NSCOPED)
+                       n = n->parent;
+
+               mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
+                   n->line, n->pos, "%s breaks %s",
+                   roff_name[tok], roff_name[n->tok]);
+
+               roff_node_delete(man, n);
+               man->flags &= ~MAN_ELINE;
+       }

 
 

-       if (p->child)
-               man_node_freelist(p->child);
-       if (p->next)
-               man_node_freelist(p->next);
+       /*
+        * Weird special case:
+        * Switching fill mode closes section headers.
+        */
+
+       if (man->flags & MAN_BLINE &&
+           (tok == MAN_nf || tok == MAN_fi) &&
+           (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
+               n = man->last;
+               man_unscope(man, n);
+               roff_body_alloc(man, n->line, n->pos, n->tok);
+               man->flags &= ~MAN_BLINE;
+       }

 
 

-       man_node_free(p);
+       /*
+        * A block header next line scope is open,
+        * and the new macro is not allowed inside block headers.
+        * Delete the block that is being broken.
+        */
+
+       if (man->flags & MAN_BLINE && (tok < MAN_TH ||
+           man_macro(tok)->flags & MAN_XSCOPE)) {
+               n = man->last;
+               if (n->type == ROFFT_TEXT)
+                       n = n->parent;
+               if (n->tok < MAN_TH ||
+                   (man_macro(n->tok)->flags & MAN_XSCOPE) == 0)
+                       n = n->parent;
+
+               assert(n->type == ROFFT_HEAD);
+               n = n->parent;
+               assert(n->type == ROFFT_BLOCK);
+               assert(man_macro(n->tok)->flags & MAN_BSCOPED);
+
+               mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
+                   n->line, n->pos, "%s breaks %s",
+                   roff_name[tok], roff_name[n->tok]);
+
+               roff_node_delete(man, n);
+               man->flags &= ~MAN_BLINE;
+       }

 }
 
 }
 

-
-static int
-man_ptext(struct man *m, int line, char *buf)
+void
+man_state(struct roff_man *man, struct roff_node *n)

 {
 
 {
 

-       if (0 == buf[0]) {
-               warnx("blank line!");
-               return(1);
+       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;

        }
        }

-
-       if ( ! man_word_alloc(m, line, 0, buf))
-               return(0);
-
-       m->next = MAN_NEXT_SIBLING;
-       return(1);
+       man->last->flags |= NODE_VALID;

 }
 
 }
 

-
-int
-man_pmacro(struct man *m, int ln, char *buf)
+void
+man_validate(struct roff_man *man)

 {
 {

-       int               i, c;
-       char              mac[5];
-
-       /* Comments and empties are quickly ignored. */
-
-       if (0 == buf[1])
-               return(1);
-
-       if (' ' == buf[1]) {
-               i = 2;
-               while (buf[i] && ' ' == buf[i])
-                       i++;
-               if (0 == buf[i])
-                       return(1);
-               warnx("invalid syntax");
-               return(0);
-       }
-
-       if (buf[1] && '\\' == buf[1])
-               if (buf[2] && '\"' == buf[2])
-                       return(1);
-
-       /* Copy the first word into a nil-terminated buffer. */
-
-       for (i = 1; i < 5; i++) {
-               if (0 == (mac[i - 1] = buf[i]))
-                       break;
-               else if (' ' == buf[i])
-                       break;
-       }
-
-       mac[i - 1] = 0;
-
-       if (i == 5 || i <= 1) {
-               warnx("unknown macro: %s", mac);
-               goto err;
-       } 
-       
-       if (MAN_MAX == (c = man_hash_find(m->htab, mac))) {
-               warnx("unknown macro: %s", mac);
-               goto err;
-       }
-
-       /* The macro is sane.  Jump to the next word. */
-
-       while (buf[i] && ' ' == buf[i])
-               i++;
-
-       /* Begin recursive parse sequence. */
-
-       if ( ! (*man_macros[c].fp)(m, c, ln, 1, &i, buf))
-               goto err;
-
-       return(1);
-
-err:   /* Error out. */

 
 

-#if 0
-       m->flags |= MDOC_HALT;
-#endif
-       return(0);
+       man->last = man->first;
+       man_node_validate(man);
+       man->flags &= ~MAN_LITERAL;

 }
 }