Audit strlcpy(3)/strlcat(3) usage.

[mandoc.git] / man_macro.c

diff --git a/man_macro.c b/man_macro.c
index c644a2e1a6c418a96688f6a3a5c4994edc234468..9bfbfd3fd75864f42a14c227a961a0756dde86f5 100644 (file)
--- a/man_macro.c
+++ b/man_macro.c
@@ -1,6 +1,8 @@
-/*     $Id: man_macro.c,v 1.72 2012/06/02 20:16:23 schwarze Exp $ */
+/*     $Id: man_macro.c,v 1.82 2014/04/20 16:46:04 schwarze Exp $ */

 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 /*
  * 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


@@ -38,16 +40,16 @@ 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              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, 
+static int              man_args(struct man *, int,

                                int *, char *, char **);
 
                                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_node *);

-static void             rew_warn(struct man *, 
+static void             rew_warn(struct man *,

                                struct man_node *, enum mandocerr);
 
 const  struct man_macro __man_macros[MAN_MAX] = {
                                struct man_node *, enum mandocerr);
 
 const  struct man_macro __man_macros[MAN_MAX] = {


@@ -77,7 +79,7 @@ const struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, MAN_BSCOPE }, /* nf */
        { in_line_eoln, MAN_BSCOPE }, /* fi */
        { blk_close, 0 }, /* RE */
        { in_line_eoln, MAN_BSCOPE }, /* nf */
        { in_line_eoln, MAN_BSCOPE }, /* fi */
        { blk_close, 0 }, /* RE */

-       { blk_exp, 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 */


@@ -87,6 +89,9 @@ const struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, 0 }, /* OP */
        { in_line_eoln, MAN_BSCOPE }, /* EX */
        { in_line_eoln, MAN_BSCOPE }, /* EE */
        { 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;
 };
 
 const  struct man_macro * const man_macros = __man_macros;


@@ -96,7 +101,7 @@ const        struct man_macro * const man_macros = __man_macros;
  * Warn when "n" is an explicit non-roff macro.
  */
 static void
  * Warn when "n" is an explicit non-roff macro.
  */
 static void

-rew_warn(struct man *m, struct man_node *n, enum mandocerr er)
+rew_warn(struct man *man, struct man_node *n, enum mandocerr er)

 {
 
        if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
 {
 
        if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)


@@ -107,65 +112,61 @@ rew_warn(struct man *m, struct man_node *n, enum mandocerr er)
                return;
 
        assert(er < MANDOCERR_FATAL);
                return;
 
        assert(er < MANDOCERR_FATAL);

-       man_nmsg(m, n, er);
+       man_nmsg(man, n, er);

 }
 
 }
 

-

 /*
  * Rewind scope.  If a code "er" != MANDOCERR_MAX has been provided, it
  * will be used if an explicit block scope is being closed out.
  */
 int
 /*
  * Rewind scope.  If a code "er" != MANDOCERR_MAX has been provided, it
  * will be used if an explicit block scope is being closed out.
  */
 int

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

                enum mandocerr er)
 {
        struct man_node *n;
 
        assert(to);
 
                enum mandocerr er)
 {
        struct man_node *n;
 
        assert(to);
 

-       m->next = MAN_NEXT_SIBLING;
+       man->next = MAN_NEXT_SIBLING;

 
 

-       /* LINTED */
-       while (m->last != to) {
+       while (man->last != to) {

                /*
                 * Save the parent here, because we may delete the
                /*
                 * Save the parent here, because we may delete the

-                * m->last node in the post-validation phase and reset
-                * it to m->last->parent, causing a step in the closing
+                * man->last node in the post-validation phase and reset
+                * it to man->last->parent, causing a step in the closing

                 * out to be lost.
                 */
                 * out to be lost.
                 */

-               n = m->last->parent;
-               rew_warn(m, m->last, er);
-               if ( ! man_valid_post(m))
+               n = man->last->parent;
+               rew_warn(man, man->last, er);
+               if ( ! man_valid_post(man))

                        return(0);
                        return(0);

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

        }
 
        }
 

-       rew_warn(m, m->last, er);
-       if ( ! man_valid_post(m))
+       rew_warn(man, man->last, er);
+       if ( ! man_valid_post(man))

                return(0);
 
        return(1);
 }
 
                return(0);
 
        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;


@@ -185,23 +186,31 @@ rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
                return(REW_NOHALT);
 
        /* First: rewind to ourselves. */
                return(REW_NOHALT);
 
        /* First: rewind to ourselves. */

-       if (type == n->type && tok == n->tok)
-               return(REW_REWIND);
+       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) {
         * Next follow the implicit scope-smashings as defined by man.7:
         * section, sub-section, etc.
         */
 
        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);


@@ -225,21 +234,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).


@@ -251,86 +258,89 @@ rew_scope(enum man_type type, struct man *m, enum mant tok)
                        break;
        }
 
                        break;
        }
 

-       /* 
+       /*

         * Rewind until the current point.  Warn if we're a roff
         * instruction that's mowing over explicit scopes.
         */
        assert(n);
 
         * Rewind until the current point.  Warn if we're a roff
         * instruction that's mowing over explicit scopes.
         */
        assert(n);
 

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

 }
 
 
 /*
  * Close out a generic explicit macro.
  */
 }
 
 
 /*
  * Close out a generic explicit macro.
  */

-/* ARGSUSED */

 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)
-               man_pmsg(m, line, ppos, MANDOCERR_NOSCOPE);
-
-       if ( ! rew_scope(MAN_BODY, m, ntok))
-               return(0);
-       if ( ! rew_scope(MAN_BLOCK, m, ntok))
-               return(0);
+       if (NULL == nn) {
+               man_pmsg(man, line, ppos, MANDOCERR_NOSCOPE);
+               if ( ! rew_scope(MAN_BLOCK, man, MAN_PP))
+                       return(0);
+       } else
+               man_unscope(man, nn, MANDOCERR_MAX);

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

-
-/* ARGSUSED */

 int
 blk_exp(MACRO_PROT_ARGS)
 {
 int
 blk_exp(MACRO_PROT_ARGS)
 {

+       struct man_node *n;

        int              la;
        char            *p;
 
        int              la;
        char            *p;
 

-       /* 
-        * Close out prior scopes.  "Regular" explicit macros cannot be
-        * nested, but we allow roff macros to be placed just about
-        * anywhere.
-        */
+       /* Close out prior implicit scopes. */
+
+       if ( ! rew_scope(MAN_BLOCK, man, tok))
+               return(0);

 
 

-       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);
 
        for (;;) {
                la = *pos;
                return(0);
 
        for (;;) {
                la = *pos;

-               if ( ! man_args(m, line, pos, buf, &p))
+               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);
        }
 

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

        assert(tok != MAN_MAX);
 
        assert(tok != MAN_MAX);
 

-       if ( ! rew_scope(MAN_HEAD, m, tok))
-               return(0);
-       return(man_body_alloc(m, line, ppos, tok));
-}
-
+       for (n = man->last; n; n = n->parent) {
+               if (n->tok != tok)
+                       continue;
+               assert(MAN_HEAD == n->type);
+               man_unscope(man, n, MANDOCERR_MAX);
+               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


@@ -338,7 +348,6 @@ blk_exp(MACRO_PROT_ARGS)
  * scopes, such as `SH' closing out an `SS', are defined in the rew
  * routines.
  */
  * scopes, such as `SH' closing out an `SS', are defined in the rew
  * routines.
  */

-/* ARGSUSED */

 int
 blk_imp(MACRO_PROT_ARGS)
 {
 int
 blk_imp(MACRO_PROT_ARGS)
 {


@@ -348,27 +357,27 @@ blk_imp(MACRO_PROT_ARGS)
 
        /* Close out prior scopes. */
 
 
        /* 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;

-               if ( ! man_args(m, line, pos, buf, &p))
+               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);
        }
 


@@ -377,21 +386,19 @@ 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));

 }
 
 }
 

-
-/* ARGSUSED */

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


@@ -399,63 +406,72 @@ in_line_eoln(MACRO_PROT_ARGS)
        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;

-               if ( ! man_args(m, line, pos, buf, &p))
+               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 != m->last->type);
-       m->next = MAN_NEXT_SIBLING;
-       
+       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))
+               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))
+       if (man->last->type != MAN_ROOT && ! man_valid_post(man))

                return(0);
 
        return(1);
                return(0);
 
        return(1);


@@ -463,14 +479,14 @@ in_line_eoln(MACRO_PROT_ARGS)
 
 
 int
 
 
 int

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

 {
 
 {
 

-       return(man_unscope(m, m->first, MANDOCERR_SCOPEEXIT));
+       return(man_unscope(man, man->first, MANDOCERR_SCOPEEXIT));

 }
 
 static int
 }
 
 static int

-man_args(struct man *m, int line, int *pos, char *buf, char **v)
+man_args(struct man *man, int line, int *pos, char *buf, char **v)

 {
        char     *start;
 
 {
        char     *start;
 


@@ -481,6 +497,6 @@ man_args(struct man *m, int line, int *pos, char *buf, char **v)
        if ('\0' == *start)
                return(0);
 
        if ('\0' == *start)
                return(0);
 

-       *v = mandoc_getarg(m->parse, v, line, pos);
+       *v = mandoc_getarg(man->parse, v, line, pos);

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