fix the two manual links on the index page

[mandoc.git] / man_macro.c

diff --git a/man_macro.c b/man_macro.c
index 70c1ab5537906f3682ab25a8b1c4b51e15804601..9857379656ddcdfd82762e35bbc6069b3f129675 100644 (file)
--- a/man_macro.c
+++ b/man_macro.c
@@ -1,6 +1,8 @@
-/*     $Id: man_macro.c,v 1.34 2010/03/24 03:46:02 kristaps Exp $ */
+/*     $Id: man_macro.c,v 1.85 2014/07/09 11:28:26 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -23,36 +25,42 @@
 #include <stdlib.h>
 #include <string.h>
 
 #include <stdlib.h>
 #include <string.h>
 

+#include "man.h"
+#include "mandoc.h"
+#include "libmandoc.h"

 #include "libman.h"
 
 enum   rew {
        REW_REWIND,
        REW_NOHALT,
 #include "libman.h"
 
 enum   rew {
        REW_REWIND,
        REW_NOHALT,

-       REW_HALT,
+       REW_HALT

 };
 
 };
 

-static int              in_line_eoln(MACRO_PROT_ARGS);
-static int              blk_imp(MACRO_PROT_ARGS);

 static int              blk_close(MACRO_PROT_ARGS);
 static int              blk_close(MACRO_PROT_ARGS);

+static int              blk_exp(MACRO_PROT_ARGS);
+static int              blk_imp(MACRO_PROT_ARGS);
+static int              in_line_eoln(MACRO_PROT_ARGS);
+static int              man_args(struct man *, int,
+                               int *, char *, char **);

 
 

-static int              rew_scope(enum man_type, 
+static int              rew_scope(enum man_type,

                                struct man *, enum mant);
                                struct man *, enum mant);

-static enum rew         rew_dohalt(enum mant, enum man_type, 
+static enum rew         rew_dohalt(enum mant, enum man_type,

                                const struct man_node *);
                                const struct man_node *);

-static enum rew         rew_block(enum mant, enum man_type, 
+static enum rew         rew_block(enum mant, enum man_type,

                                const struct man_node *);
 
 const  struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, MAN_NSCOPED }, /* br */
                                const struct man_node *);
 
 const  struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, MAN_NSCOPED }, /* br */

-       { in_line_eoln, 0 }, /* TH */
-       { blk_imp, MAN_SCOPED }, /* SH */
-       { blk_imp, MAN_SCOPED }, /* SS */
-       { blk_imp, MAN_SCOPED | MAN_FSCOPED }, /* TP */
-       { blk_imp, 0 }, /* LP */
-       { blk_imp, 0 }, /* PP */
-       { blk_imp, 0 }, /* P */
-       { blk_imp, 0 }, /* IP */
-       { blk_imp, 0 }, /* HP */
+       { 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 | MAN_FSCOPED }, /* 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 }, /* SM */
        { in_line_eoln, MAN_SCOPED }, /* SB */
        { in_line_eoln, 0 }, /* BI */
        { in_line_eoln, MAN_SCOPED }, /* SM */
        { in_line_eoln, MAN_SCOPED }, /* SB */
        { in_line_eoln, 0 }, /* BI */


@@ -65,89 +73,118 @@ const      struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, 0 }, /* IR */
        { in_line_eoln, 0 }, /* RI */
        { in_line_eoln, MAN_NSCOPED }, /* na */
        { in_line_eoln, 0 }, /* IR */
        { in_line_eoln, 0 }, /* RI */
        { in_line_eoln, MAN_NSCOPED }, /* na */

-       { in_line_eoln, 0 }, /* i */

        { in_line_eoln, MAN_NSCOPED }, /* sp */
        { in_line_eoln, MAN_NSCOPED }, /* sp */

-       { in_line_eoln, 0 }, /* nf */
-       { in_line_eoln, 0 }, /* fi */
-       { in_line_eoln, 0 }, /* r */
+       { in_line_eoln, MAN_BSCOPE }, /* nf */
+       { in_line_eoln, MAN_BSCOPE }, /* fi */

        { blk_close, 0 }, /* RE */
        { blk_close, 0 }, /* RE */

-       { blk_imp, MAN_EXPLICIT }, /* RS */
+       { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */

        { in_line_eoln, 0 }, /* DT */
        { in_line_eoln, 0 }, /* UC */
        { in_line_eoln, 0 }, /* PD */
        { in_line_eoln, 0 }, /* DT */
        { in_line_eoln, 0 }, /* UC */
        { in_line_eoln, 0 }, /* PD */

-       { in_line_eoln, MAN_NSCOPED }, /* Sp */
-       { in_line_eoln, 0 }, /* Vb */
-       { in_line_eoln, 0 }, /* Ve */
+       { 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 | MAN_EXPLICIT }, /* UR */
+       { blk_close, 0 }, /* UE */
+       { in_line_eoln, 0 }, /* ll */

 };
 
 const  struct man_macro * const man_macros = __man_macros;
 
 
 int
 };
 
 const  struct man_macro * const man_macros = __man_macros;
 
 
 int

-man_unscope(struct man *m, const struct man_node *n)
+man_unscope(struct man *man, const struct man_node *to)

 {
 {

+       struct man_node *n;

 
 

-       assert(n);
-       m->next = MAN_NEXT_SIBLING;
-
-       /* LINTED */
-       while (m->last != n) {
-               if ( ! man_valid_post(m))
-                       return(0);
-               if ( ! man_action_post(m))
+       man->next = MAN_NEXT_SIBLING;
+       to = to->parent;
+       n = man->last;
+       while (n != to) {
+               if (NULL == to &&
+                   MAN_BLOCK == n->type &&
+                   0 == (MAN_VALID & n->flags) &&
+                   MAN_EXPLICIT & man_macros[n->tok].flags)
+                       mandoc_msg(MANDOCERR_BLK_NOEND,
+                           man->parse, n->line, n->pos,
+                           man_macronames[n->tok]);
+               /*
+                * We might delete the man->last node
+                * in the post-validation phase.
+                * Save a pointer to the parent such that
+                * we know where to continue the iteration.
+                */
+               man->last = n;
+               n = n->parent;
+               if ( ! man_valid_post(man))

                        return(0);
                        return(0);

-               m->last = m->last->parent;
-               assert(m->last);

        }
        }

-
-       if ( ! man_valid_post(m))
-               return(0);
-       return(man_action_post(m));
+       return(1);

 }
 
 }
 

-

 static enum rew
 rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
 {
 
 static enum rew
 rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
 {
 

-       if (MAN_BLOCK == type && ntok == n->parent->tok && 
-                       MAN_BODY == n->parent->type)
+       if (MAN_BLOCK == type && ntok == n->parent->tok &&
+           MAN_BODY == n->parent->type)

                return(REW_REWIND);
        return(ntok == n->tok ? REW_HALT : REW_NOHALT);
 }
 
                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).
  */
 /*
  * 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 
+static enum rew

 rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
 {
        enum rew         c;
 
 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);
        if (MAN_ROOT == n->type)
                return(REW_HALT);

+

        assert(n->parent);
        assert(n->parent);

+
+       /* Normal nodes shouldn't go to the level of the root. */

        if (MAN_ROOT == n->parent->type)
                return(REW_REWIND);
        if (MAN_ROOT == n->parent->type)
                return(REW_REWIND);

+
+       /* Already-validated nodes should be closed out. */

        if (MAN_VALID & n->flags)
                return(REW_NOHALT);
 
        if (MAN_VALID & n->flags)
                return(REW_NOHALT);
 

-       /* Rewind to ourselves, first. */
-       if (type == n->type && tok == n->tok)
-               return(REW_REWIND);
+       /* First: rewind to ourselves. */
+       if (type == n->type && tok == n->tok) {
+               if (MAN_EXPLICIT & man_macros[n->tok].flags)
+                       return(REW_HALT);
+               else
+                       return(REW_REWIND);
+       }
+
+       /*
+        * Next follow the implicit scope-smashings as defined by man.7:
+        * section, sub-section, etc.
+        */

 
        switch (tok) {
 
        switch (tok) {

-       case (MAN_SH):
+       case MAN_SH:

                break;
                break;

-       case (MAN_SS):
+       case MAN_SS:

                /* Rewind to a section, if a block. */
                if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                        return(c);
                break;
                /* Rewind to a section, if a block. */
                if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                        return(c);
                break;

-       case (MAN_RS):
+       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 subsection, if a block. */
                if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
                        return(c);


@@ -171,21 +208,19 @@ rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
        return(REW_NOHALT);
 }
 
        return(REW_NOHALT);
 }
 

-

 /*
  * Rewinding entails ascending the parse tree until a coherent point,
  * for example, the `SH' macro will close out any intervening `SS'
  * scopes.  When a scope is closed, it must be validated and actioned.
  */
 static int
 /*
  * Rewinding entails ascending the parse tree until a coherent point,
  * for example, the `SH' macro will close out any intervening `SS'
  * scopes.  When a scope is closed, it must be validated and actioned.
  */
 static int

-rew_scope(enum man_type type, struct man *m, enum mant tok)
+rew_scope(enum man_type type, struct man *man, enum mant tok)

 {
        struct man_node *n;
        enum rew         c;
 
 {
        struct man_node *n;
        enum rew         c;
 

-       /* LINTED */
-       for (n = m->last; n; n = n->parent) {
-               /* 
+       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).
                 * Whether we should stop immediately (REW_HALT), stop
                 * and rewind until this point (REW_REWIND), or keep
                 * rewinding (REW_NOHALT).


@@ -197,45 +232,90 @@ rew_scope(enum man_type type, struct man *m, enum mant tok)
                        break;
        }
 
                        break;
        }
 

-       /* Rewind until the current point. */
-
+       /*
+        * Rewind until the current point.  Warn if we're a roff
+        * instruction that's mowing over explicit scopes.
+        */

        assert(n);
        assert(n);

-       return(man_unscope(m, n));
+
+       return(man_unscope(man, n));

 }
 
 
 }
 
 

-/* ARGSUSED */
+/*
+ * Close out a generic explicit macro.
+ */

 int
 blk_close(MACRO_PROT_ARGS)
 {
 int
 blk_close(MACRO_PROT_ARGS)
 {

-       enum mant                ntok;
+       enum mant                ntok;

        const struct man_node   *nn;
 
        switch (tok) {
        const struct man_node   *nn;
 
        switch (tok) {

-       case (MAN_RE):
+       case MAN_RE:

                ntok = MAN_RS;
                break;
                ntok = MAN_RS;
                break;

+       case MAN_UE:
+               ntok = MAN_UR;
+               break;

        default:
                abort();
                /* NOTREACHED */
        }
 
        default:
                abort();
                /* NOTREACHED */
        }
 

-       for (nn = m->last->parent; nn; nn = nn->parent)
-               if (ntok == nn->tok)
+       for (nn = man->last->parent; nn; nn = nn->parent)
+               if (ntok == nn->tok && MAN_BLOCK == nn->type)

                        break;
 
                        break;
 

-       if (NULL == nn)
-               if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
+       if (NULL == nn) {
+               mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
+                   line, ppos, man_macronames[tok]);
+               if ( ! rew_scope(MAN_BLOCK, man, MAN_PP))

                        return(0);
                        return(0);

+       } else
+               man_unscope(man, nn);

 
 

-       if ( ! rew_scope(MAN_BODY, m, ntok))
-               return(0);
-       if ( ! rew_scope(MAN_BLOCK, m, ntok))
-               return(0);
-       m->next = MAN_NEXT_SIBLING;

        return(1);
 }
 
        return(1);
 }
 

+int
+blk_exp(MACRO_PROT_ARGS)
+{
+       struct man_node *n;
+       int              la;
+       char            *p;
+
+       /* Close out prior implicit scopes. */
+
+       if ( ! rew_scope(MAN_BLOCK, man, tok))
+               return(0);
+
+       if ( ! man_block_alloc(man, line, ppos, tok))
+               return(0);
+       if ( ! man_head_alloc(man, line, ppos, tok))
+               return(0);
+
+       for (;;) {
+               la = *pos;
+               if ( ! man_args(man, line, pos, buf, &p))
+                       break;
+               if ( ! man_word_alloc(man, line, la, p))
+                       return(0);
+       }
+
+       assert(man);
+       assert(tok != MAN_MAX);
+
+       for (n = man->last; n; n = n->parent) {
+               if (n->tok != tok)
+                       continue;
+               assert(MAN_HEAD == n->type);
+               man_unscope(man, n);
+               break;
+       }
+
+       return(man_body_alloc(man, line, ppos, tok));
+}

 
 /*
  * Parse an implicit-block macro.  These contain a MAN_HEAD and a
 
 /*
  * Parse an implicit-block macro.  These contain a MAN_HEAD and a


@@ -246,38 +326,33 @@ blk_close(MACRO_PROT_ARGS)
 int
 blk_imp(MACRO_PROT_ARGS)
 {
 int
 blk_imp(MACRO_PROT_ARGS)
 {

-       int              w, la;
+       int              la;

        char            *p;
        struct man_node *n;
 
        /* Close out prior scopes. */
 
        char            *p;
        struct man_node *n;
 
        /* Close out prior scopes. */
 

-       if ( ! rew_scope(MAN_BODY, m, tok))
+       if ( ! rew_scope(MAN_BODY, man, tok))

                return(0);
                return(0);

-       if ( ! rew_scope(MAN_BLOCK, m, tok))
+       if ( ! rew_scope(MAN_BLOCK, man, tok))

                return(0);
 
        /* Allocate new block & head scope. */
 
                return(0);
 
        /* Allocate new block & head scope. */
 

-       if ( ! man_block_alloc(m, line, ppos, tok))
+       if ( ! man_block_alloc(man, line, ppos, tok))

                return(0);
                return(0);

-       if ( ! man_head_alloc(m, line, ppos, tok))
+       if ( ! man_head_alloc(man, line, ppos, tok))

                return(0);
 
                return(0);
 

-       n = m->last;
+       n = man->last;

 
        /* Add line arguments. */
 
        for (;;) {
                la = *pos;
 
        /* Add line arguments. */
 
        for (;;) {
                la = *pos;

-               w = man_args(m, line, pos, buf, &p);
-
-               if (-1 == w)
-                       return(0);
-               if (0 == w)
+               if ( ! man_args(man, line, pos, buf, &p))

                        break;
                        break;

-
-               if ( ! man_word_alloc(m, line, la, p))
+               if ( ! man_word_alloc(man, line, la, p))

                        return(0);
        }
 
                        return(0);
        }
 


@@ -286,115 +361,117 @@ blk_imp(MACRO_PROT_ARGS)
        if (MAN_SCOPED & man_macros[tok].flags) {
                /* If we're forcing scope (`TP'), keep it open. */
                if (MAN_FSCOPED & man_macros[tok].flags) {
        if (MAN_SCOPED & man_macros[tok].flags) {
                /* If we're forcing scope (`TP'), keep it open. */
                if (MAN_FSCOPED & man_macros[tok].flags) {

-                       m->flags |= MAN_BLINE;
+                       man->flags |= MAN_BLINE;

                        return(1);
                        return(1);

-               } else if (n == m->last) {
-                       m->flags |= MAN_BLINE;
+               } else if (n == man->last) {
+                       man->flags |= MAN_BLINE;

                        return(1);
                }
        }
 
                        return(1);
                }
        }
 

-       if ( ! rew_scope(MAN_HEAD, m, tok))
+       if ( ! rew_scope(MAN_HEAD, man, tok))

                return(0);
                return(0);

-
-       return(man_body_alloc(m, line, ppos, tok));
+       return(man_body_alloc(man, line, ppos, tok));

 }
 
 }
 

-

 int
 in_line_eoln(MACRO_PROT_ARGS)
 {
 int
 in_line_eoln(MACRO_PROT_ARGS)
 {

-       int              w, la;
+       int              la;

        char            *p;
        struct man_node *n;
 
        char            *p;
        struct man_node *n;
 

-       if ( ! man_elem_alloc(m, line, ppos, tok))
+       if ( ! man_elem_alloc(man, line, ppos, tok))

                return(0);
 
                return(0);
 

-       n = m->last;
+       n = man->last;

 
        for (;;) {
                la = *pos;
 
        for (;;) {
                la = *pos;

-               w = man_args(m, line, pos, buf, &p);
-
-               if (-1 == w)
-                       return(0);
-               if (0 == w)
+               if ( ! man_args(man, line, pos, buf, &p))

                        break;
                        break;

-               if ( ! man_word_alloc(m, line, la, p))
+               if ( ! man_word_alloc(man, line, la, p))

                        return(0);
        }
 
                        return(0);
        }
 

+       /*
+        * Append MAN_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;
+

        /*
         * If no arguments are specified and this is MAN_SCOPED (i.e.,
         * next-line scoped), then set our mode to indicate that we're
         * waiting for terms to load into our context.
         */
 
        /*
         * If no arguments are specified and this is MAN_SCOPED (i.e.,
         * next-line scoped), then set our mode to indicate that we're
         * waiting for terms to load into our context.
         */
 

-       if (n == m->last && MAN_SCOPED & man_macros[tok].flags) {
+       if (n == man->last && MAN_SCOPED & man_macros[tok].flags) {

                assert( ! (MAN_NSCOPED & man_macros[tok].flags));
                assert( ! (MAN_NSCOPED & man_macros[tok].flags));

-               m->flags |= MAN_ELINE;
+               man->flags |= MAN_ELINE;

                return(1);
                return(1);

-       } 
+       }

 
        /* Set ignorable context, if applicable. */
 
        if (MAN_NSCOPED & man_macros[tok].flags) {
                assert( ! (MAN_SCOPED & man_macros[tok].flags));
 
        /* Set ignorable context, if applicable. */
 
        if (MAN_NSCOPED & man_macros[tok].flags) {
                assert( ! (MAN_SCOPED & man_macros[tok].flags));

-               m->flags |= MAN_ILINE;
+               man->flags |= MAN_ILINE;

        }
        }

-       
+
+       assert(MAN_ROOT != man->last->type);
+       man->next = MAN_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.  Note that when TH is pruned, we'll
         * be back at the root, so make sure that we don't clobber as
         * its sibling.
         */
 

-       for ( ; m->last; m->last = m->last->parent) {
-               if (m->last == n)
+       for ( ; man->last; man->last = man->last->parent) {
+               if (man->last == n)

                        break;
                        break;

-               if (m->last->type == MAN_ROOT)
+               if (man->last->type == MAN_ROOT)

                        break;
                        break;

-               if ( ! man_valid_post(m))
-                       return(0);
-               if ( ! man_action_post(m))
+               if ( ! man_valid_post(man))

                        return(0);
        }
 
                        return(0);
        }
 

-       assert(m->last);
+       assert(man->last);

 
        /*
 
        /*

-        * Same here regarding whether we're back at the root. 
+        * Same here regarding whether we're back at the root.

         */
 
         */
 

-       if (m->last->type != MAN_ROOT && ! man_valid_post(m))
-               return(0);
-       if (m->last->type != MAN_ROOT && ! man_action_post(m))
+       if (man->last->type != MAN_ROOT && ! man_valid_post(man))

                return(0);
                return(0);

-       if (m->last->type != MAN_ROOT)
-               m->next = MAN_NEXT_SIBLING;

 
        return(1);
 }
 
 
 int
 
        return(1);
 }
 
 
 int

-man_macroend(struct man *m)
+man_macroend(struct man *man)

 {
 {

-       struct man_node *n;

 
 

-       n = MAN_VALID & m->last->flags ?
-               m->last->parent : m->last;
+       return(man_unscope(man, man->first));
+}

 
 

-       for ( ; n; n = n->parent) {
-               if (MAN_BLOCK != n->type)
-                       continue;
-               if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
-                       continue;
-               if ( ! man_nwarn(m, n, WEXITSCOPE))
-                       return(0);
-       }
+static int
+man_args(struct man *man, int line, int *pos, char *buf, char **v)
+{
+       char     *start;

 
 

-       return(man_unscope(m, m->first));
-}
+       assert(*pos);
+       *v = start = buf + *pos;
+       assert(' ' != *start);
+
+       if ('\0' == *start)
+               return(0);

 
 

+       *v = mandoc_getarg(man->parse, v, line, pos);
+       return(1);
+}