]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_macro.c
Make HTML tags lower case for better stylistic agreement with what
[mandoc.git] / man_macro.c
index 1c204cb6e9255736505c06c081b3006c91aff228..d15335709ecaa8b5820d1ecbba249e05cad54ae1 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: man_macro.c,v 1.100 2015/03/20 14:47:52 schwarze Exp $ */
+/*     $Id: man_macro.c,v 1.114 2016/01/08 17:48:09 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2012, 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
@@ -8,9 +8,9 @@
  * 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
+ * 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 AUTHOR BE LIABLE FOR
+ * 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
 #include <stdlib.h>
 #include <string.h>
 
-#include "man.h"
 #include "mandoc.h"
+#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(enum man_type,
-                               struct man *, enum mant);
-static enum rew         rew_dohalt(enum mant, enum man_type,
-                               const struct man_node *);
-static enum rew         rew_block(enum mant, enum man_type,
-                               const struct man_node *);
+static void             rew_scope(struct roff_man *, int);
 
 const  struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, MAN_NSCOPED }, /* br */
@@ -73,8 +63,8 @@ const struct man_macro __man_macros[MAN_MAX] = {
        { 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 */
@@ -95,9 +85,9 @@ const struct man_macro * const man_macros = __man_macros;
 
 
 void
-man_unscope(struct man *man, const struct man_node *to)
+man_unscope(struct roff_man *man, const struct roff_node *to)
 {
-       struct man_node *n;
+       struct roff_node *n;
 
        to = to->parent;
        n = man->last;
@@ -115,16 +105,16 @@ man_unscope(struct man *man, const struct man_node *to)
                                if (man->flags & MAN_ELINE)
                                        man->flags &= ~MAN_ELINE;
                                else {
-                                       assert(n->type == MAN_HEAD);
+                                       assert(n->type == ROFFT_HEAD);
                                        n = n->parent;
                                        man->flags &= ~MAN_BLINE;
                                }
                                man->last = n;
                                n = n->parent;
-                               man_node_delete(man, man->last);
+                               roff_node_delete(man, man->last);
                                continue;
                        }
-                       if (n->type == MAN_BLOCK &&
+                       if (n->type == ROFFT_BLOCK &&
                            man_macros[n->tok].fp == blk_exp)
                                mandoc_msg(MANDOCERR_BLK_NOEND,
                                    man->parse, n->line, n->pos,
@@ -140,7 +130,7 @@ man_unscope(struct man *man, const struct man_node *to)
 
                man->last = n;
                n = n->parent;
-               man_valid_post(man);
+               man->last->flags |= MAN_VALID;
        }
 
        /*
@@ -151,90 +141,7 @@ man_unscope(struct man *man, const struct man_node *to)
         */
 
        man->next = (man->last == to) ?
-           MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
-}
-
-static enum rew
-rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
-{
-
-       if (type == MAN_BLOCK && ntok == n->parent->tok &&
-           n->parent->type == MAN_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(enum mant tok, enum man_type type, const struct man_node *n)
-{
-       enum rew         c;
-
-       /* We cannot progress beyond the root ever. */
-       if (MAN_ROOT == n->type)
-               return(REW_HALT);
-
-       assert(n->parent);
-
-       /* Normal nodes shouldn't go to the level of the root. */
-       if (MAN_ROOT == n->parent->type)
-               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 +150,40 @@ rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
  * scopes.  When a scope is closed, it must be validated and actioned.
  */
 static void
-rew_scope(enum man_type type, struct man *man, enum mant tok)
+rew_scope(struct roff_man *man, int tok)
 {
-       struct man_node *n;
-       enum rew         c;
+       struct roff_node *n;
 
-       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 & MAN_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,8 +193,8 @@ rew_scope(enum man_type type, struct man *man, enum mant tok)
 void
 blk_close(MACRO_PROT_ARGS)
 {
-       enum mant                ntok;
-       const struct man_node   *nn;
+       int                      ntok;
+       const struct roff_node  *nn;
        char                    *p;
        int                      nrew, target;
 
@@ -288,7 +205,7 @@ blk_close(MACRO_PROT_ARGS)
                if ( ! man_args(man, line, pos, buf, &p))
                        break;
                for (nn = man->last->parent; nn; nn = nn->parent)
-                       if (nn->tok == ntok && nn->type == MAN_BLOCK)
+                       if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
                                nrew++;
                target = strtol(p, &p, 10);
                if (*p != '\0')
@@ -308,17 +225,16 @@ blk_close(MACRO_PROT_ARGS)
                break;
        default:
                abort();
-               /* NOTREACHED */
        }
 
        for (nn = man->last->parent; nn; nn = nn->parent)
-               if (nn->tok == ntok && nn->type == MAN_BLOCK && ! --nrew)
+               if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
                        break;
 
        if (nn == NULL) {
                mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
                    line, ppos, man_macronames[tok]);
-               rew_scope(MAN_BLOCK, man, MAN_PP);
+               rew_scope(man, MAN_PP);
        } else {
                line = man->last->line;
                ppos = man->last->pos;
@@ -337,18 +253,17 @@ blk_close(MACRO_PROT_ARGS)
 void
 blk_exp(MACRO_PROT_ARGS)
 {
-       struct man_node *head;
+       struct roff_node *head;
        char            *p;
        int              la;
 
-       rew_scope(MAN_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,
@@ -356,12 +271,12 @@ blk_exp(MACRO_PROT_ARGS)
                    man_macronames[tok], buf + *pos);
 
        man_unscope(man, head);
-       man_body_alloc(man, line, ppos, tok);
+       roff_body_alloc(man, line, ppos, tok);
 }
 
 /*
- * Parse an implicit-block macro.  These contain a MAN_HEAD and a
- * MAN_BODY contained within a MAN_BLOCK.  Rules for closing out other
+ * Parse an implicit-block macro.  These contain a ROFFT_HEAD and a
+ * ROFFT_BODY contained within a ROFFT_BLOCK.  Rules for closing out other
  * scopes, such as `SH' closing out an `SS', are defined in the rew
  * routines.
  */
@@ -370,13 +285,13 @@ blk_imp(MACRO_PROT_ARGS)
 {
        int              la;
        char            *p;
-       struct man_node *n;
+       struct roff_node *n;
 
-       rew_scope(MAN_BODY, man, tok);
-       rew_scope(MAN_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 +299,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 +316,8 @@ blk_imp(MACRO_PROT_ARGS)
 
        /* Close out the head and open the body. */
 
-       rew_scope(MAN_HEAD, man, tok);
-       man_body_alloc(man, line, ppos, tok);
+       man_unscope(man, n);
+       roff_body_alloc(man, line, ppos, tok);
 }
 
 void
@@ -410,9 +325,9 @@ in_line_eoln(MACRO_PROT_ARGS)
 {
        int              la;
        char            *p;
-       struct man_node *n;
+       struct roff_node *n;
 
-       man_elem_alloc(man, line, ppos, tok);
+       roff_elem_alloc(man, line, ppos, tok);
        n = man->last;
 
        for (;;) {
@@ -434,10 +349,10 @@ in_line_eoln(MACRO_PROT_ARGS)
                if ( ! man_args(man, line, pos, buf, &p))
                        break;
                if (man_macros[tok].flags & MAN_JOIN &&
-                   man->last->type == MAN_TEXT)
-                       man_word_append(man, p);
+                   man->last->type == ROFFT_TEXT)
+                       roff_word_append(man, p);
                else
-                       man_word_alloc(man, line, la, p);
+                       roff_word_alloc(man, line, la, p);
        }
 
        /*
@@ -461,43 +376,28 @@ in_line_eoln(MACRO_PROT_ARGS)
                return;
        }
 
-       assert(man->last->type != MAN_ROOT);
-       man->next = MAN_NEXT_SIBLING;
+       assert(man->last->type != ROFFT_ROOT);
+       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 == MAN_ROOT)
-                       break;
-               man_valid_post(man);
        }
-
-       assert(man->last);
-
-       /*
-        * Same here regarding whether we're back at the root.
-        */
-
-       if (man->last->type != MAN_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 +406,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;
 }