Fix two minibugs reported by Thomas Klausner <wiz at NetBSD>:

[mandoc.git] / mdoc_man.c

diff --git a/mdoc_man.c b/mdoc_man.c
index b6362f464062b1fa93bfa1590129aa9ae388bbc1..75b68e62d6dec171e98e2b0ff5056424c25f7e03 100644 (file)
--- a/mdoc_man.c
+++ b/mdoc_man.c
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_man.c,v 1.65 2014/07/02 19:55:10 schwarze Exp $ */
+/*     $Id: mdoc_man.c,v 1.74 2014/11/19 22:00:37 schwarze Exp $ */

 /*
  * Copyright (c) 2011, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
  *
 /*
  * Copyright (c) 2011, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
  *


@@ -14,9 +14,9 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */

-#ifdef HAVE_CONFIG_H

 #include "config.h"
 #include "config.h"

-#endif
+
+#include <sys/types.h>

 
 #include <assert.h>
 #include <stdio.h>
 
 #include <assert.h>
 #include <stdio.h>


@@ -46,6 +46,7 @@ static  void    font_push(char);
 static void      font_pop(void);
 static void      mid_it(void);
 static void      post__t(DECL_ARGS);
 static void      font_pop(void);
 static void      mid_it(void);
 static void      post__t(DECL_ARGS);

+static void      post_aq(DECL_ARGS);

 static void      post_bd(DECL_ARGS);
 static void      post_bf(DECL_ARGS);
 static void      post_bk(DECL_ARGS);
 static void      post_bd(DECL_ARGS);
 static void      post_bf(DECL_ARGS);
 static void      post_bk(DECL_ARGS);


@@ -72,6 +73,7 @@ static        void      post_vt(DECL_ARGS);
 static int       pre__t(DECL_ARGS);
 static int       pre_an(DECL_ARGS);
 static int       pre_ap(DECL_ARGS);
 static int       pre__t(DECL_ARGS);
 static int       pre_an(DECL_ARGS);
 static int       pre_ap(DECL_ARGS);

+static int       pre_aq(DECL_ARGS);

 static int       pre_bd(DECL_ARGS);
 static int       pre_bf(DECL_ARGS);
 static int       pre_bk(DECL_ARGS);
 static int       pre_bd(DECL_ARGS);
 static int       pre_bf(DECL_ARGS);
 static int       pre_bk(DECL_ARGS);


@@ -83,6 +85,7 @@ static        int       pre_en(DECL_ARGS);
 static int       pre_enc(DECL_ARGS);
 static int       pre_em(DECL_ARGS);
 static int       pre_es(DECL_ARGS);
 static int       pre_enc(DECL_ARGS);
 static int       pre_em(DECL_ARGS);
 static int       pre_es(DECL_ARGS);

+static int       pre_ex(DECL_ARGS);

 static int       pre_fa(DECL_ARGS);
 static int       pre_fd(DECL_ARGS);
 static int       pre_fl(DECL_ARGS);
 static int       pre_fa(DECL_ARGS);
 static int       pre_fd(DECL_ARGS);
 static int       pre_fl(DECL_ARGS);


@@ -99,6 +102,7 @@ static       int       pre_no(DECL_ARGS);
 static int       pre_ns(DECL_ARGS);
 static int       pre_pp(DECL_ARGS);
 static int       pre_rs(DECL_ARGS);
 static int       pre_ns(DECL_ARGS);
 static int       pre_pp(DECL_ARGS);
 static int       pre_rs(DECL_ARGS);

+static int       pre_rv(DECL_ARGS);

 static int       pre_sm(DECL_ARGS);
 static int       pre_sp(DECL_ARGS);
 static int       pre_sect(DECL_ARGS);
 static int       pre_sm(DECL_ARGS);
 static int       pre_sp(DECL_ARGS);
 static int       pre_sect(DECL_ARGS);


@@ -110,7 +114,7 @@ static      int       pre_xr(DECL_ARGS);
 static void      print_word(const char *);
 static void      print_line(const char *, int);
 static void      print_block(const char *, int);
 static void      print_word(const char *);
 static void      print_line(const char *, int);
 static void      print_block(const char *, int);

-static void      print_offs(const char *);
+static void      print_offs(const char *, int);

 static void      print_width(const char *,
                                const struct mdoc_node *, size_t);
 static void      print_count(int *);
 static void      print_width(const char *,
                                const struct mdoc_node *, size_t);
 static void      print_count(int *);


@@ -139,9 +143,7 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { NULL, pre_li, post_font, NULL, NULL }, /* Dv */
        { NULL, pre_li, post_font, NULL, NULL }, /* Er */
        { NULL, pre_li, post_font, NULL, NULL }, /* Ev */
        { NULL, pre_li, post_font, NULL, NULL }, /* Dv */
        { NULL, pre_li, post_font, NULL, NULL }, /* Er */
        { NULL, pre_li, post_font, NULL, NULL }, /* Ev */

-       { NULL, pre_enc, post_enc, "The \\fB",
-           "\\fP\nutility exits 0 on success, and >0 if an error occurs."
-           }, /* Ex */
+       { NULL, pre_ex, NULL, NULL, NULL }, /* Ex */

        { NULL, pre_fa, post_fa, NULL, NULL }, /* Fa */
        { NULL, pre_fd, post_fd, NULL, NULL }, /* Fd */
        { NULL, pre_fl, post_fl, NULL, NULL }, /* Fl */
        { NULL, pre_fa, post_fa, NULL, NULL }, /* Fa */
        { NULL, pre_fd, post_fd, NULL, NULL }, /* Fd */
        { NULL, pre_fl, post_fl, NULL, NULL }, /* Fl */


@@ -155,11 +157,7 @@ static     const struct manact manacts[MDOC_MAX + 1] = {
        { cond_body, pre_enc, post_enc, "[", "]" }, /* Op */
        { NULL, pre_ft, post_font, NULL, NULL }, /* Ot */
        { NULL, pre_em, post_font, NULL, NULL }, /* Pa */
        { cond_body, pre_enc, post_enc, "[", "]" }, /* Op */
        { NULL, pre_ft, post_font, NULL, NULL }, /* Ot */
        { NULL, pre_em, post_font, NULL, NULL }, /* Pa */

-       { NULL, pre_enc, post_enc, "The \\fB",
-               "\\fP\nfunction returns the value 0 if successful;\n"
-               "otherwise the value -1 is returned and the global\n"
-               "variable \\fIerrno\\fP is set to indicate the error."
-               }, /* Rv */
+       { NULL, pre_rv, NULL, NULL, NULL }, /* Rv */

        { NULL, NULL, NULL, NULL, NULL }, /* St */
        { NULL, pre_em, post_font, NULL, NULL }, /* Va */
        { NULL, pre_vt, post_vt, NULL, NULL }, /* Vt */
        { NULL, NULL, NULL, NULL, NULL }, /* St */
        { NULL, pre_em, post_font, NULL, NULL }, /* Va */
        { NULL, pre_vt, post_vt, NULL, NULL }, /* Vt */


@@ -176,8 +174,8 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { NULL, pre__t, post__t, NULL, NULL }, /* %T */
        { NULL, NULL, post_percent, NULL, NULL }, /* %V */
        { NULL, NULL, NULL, NULL, NULL }, /* Ac */
        { NULL, pre__t, post__t, NULL, NULL }, /* %T */
        { NULL, NULL, post_percent, NULL, NULL }, /* %V */
        { NULL, NULL, NULL, NULL, NULL }, /* Ac */

-       { cond_body, pre_enc, post_enc, "<", ">" }, /* Ao */
-       { cond_body, pre_enc, post_enc, "<", ">" }, /* Aq */
+       { cond_body, pre_aq, post_aq, NULL, NULL }, /* Ao */
+       { cond_body, pre_aq, post_aq, NULL, NULL }, /* Aq */

        { NULL, NULL, NULL, NULL, NULL }, /* At */
        { NULL, NULL, NULL, NULL, NULL }, /* Bc */
        { NULL, pre_bf, post_bf, NULL, NULL }, /* Bf */
        { NULL, NULL, NULL, NULL, NULL }, /* At */
        { NULL, NULL, NULL, NULL, NULL }, /* Bc */
        { NULL, pre_bf, post_bf, NULL, NULL }, /* Bf */


@@ -420,7 +418,7 @@ print_block(const char *s, int newflags)
 }
 
 static void
 }
 
 static void

-print_offs(const char *v)
+print_offs(const char *v, int keywords)

 {
        char              buf[24];
        struct roffsu     su;
 {
        char              buf[24];
        struct roffsu     su;


@@ -429,11 +427,11 @@ print_offs(const char *v)
        print_line(".RS", MMAN_Bk_susp);
 
        /* Convert v into a number (of characters). */
        print_line(".RS", MMAN_Bk_susp);
 
        /* Convert v into a number (of characters). */

-       if (NULL == v || '\0' == *v || 0 == strcmp(v, "left"))
+       if (NULL == v || '\0' == *v || (keywords && !strcmp(v, "left")))

                sz = 0;
                sz = 0;

-       else if (0 == strcmp(v, "indent"))
+       else if (keywords && !strcmp(v, "indent"))

                sz = 6;
                sz = 6;

-       else if (0 == strcmp(v, "indent-two"))
+       else if (keywords && !strcmp(v, "indent-two"))

                sz = 12;
        else if (a2roffsu(v, &su, SCALE_MAX)) {
                if (SCALE_EN == su.unit)
                sz = 12;
        else if (a2roffsu(v, &su, SCALE_MAX)) {
                if (SCALE_EN == su.unit)


@@ -552,8 +550,9 @@ man_mdoc(void *arg, const struct mdoc *mdoc)
        n = mdoc_node(mdoc);
 
        printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"\n",
        n = mdoc_node(mdoc);
 
        printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"\n",

-           meta->title, meta->msec, meta->date,
-           meta->os, meta->vol);
+           meta->title,
+           (meta->msec == NULL ? "" : meta->msec),
+           meta->date, meta->os, meta->vol);

 
        /* Disable hyphenation and if nroff, disable justification. */
        printf(".nh\n.if n .ad l");
 
        /* Disable hyphenation and if nroff, disable justification. */
        printf(".nh\n.if n .ad l");


@@ -597,7 +596,11 @@ print_node(DECL_ARGS)
                        printf("\\&");
                        outflags &= ~MMAN_spc;
                }
                        printf("\\&");
                        outflags &= ~MMAN_spc;
                }

+               if (outflags & MMAN_Sm && ! (n->flags & MDOC_DELIMC))
+                       outflags |= MMAN_spc_force;

                print_word(n->string);
                print_word(n->string);

+               if (outflags & MMAN_Sm && ! (n->flags & MDOC_DELIMO))
+                       outflags |= MMAN_spc;

        } else {
                /*
                 * Conditionally run the pre-node action handler for a
        } else {
                /*
                 * Conditionally run the pre-node action handler for a


@@ -673,6 +676,42 @@ post_enc(DECL_ARGS)
        print_word(suffix);
 }
 
        print_word(suffix);
 }
 

+static int
+pre_ex(DECL_ARGS)
+{
+       int      nchild;
+
+       outflags |= MMAN_br | MMAN_nl;
+
+       print_word("The");
+
+       nchild = n->nchild;
+       for (n = n->child; n; n = n->next) {
+               font_push('B');
+               print_word(n->string);
+               font_pop();
+
+               if (n->next == NULL)
+                       continue;
+
+               if (nchild > 2) {
+                       outflags &= ~MMAN_spc;
+                       print_word(",");
+               }
+               if (n->next->next == NULL)
+                       print_word("and");
+       }
+
+       if (nchild > 1)
+               print_word("utilities exit\\~0");
+       else
+               print_word("utility exits\\~0");
+
+       print_word("on success, and\\~>0 if an error occurs.");
+       outflags |= MMAN_nl;
+       return(0);
+}
+

 static void
 post_font(DECL_ARGS)
 {
 static void
 post_font(DECL_ARGS)
 {


@@ -832,6 +871,25 @@ pre_ap(DECL_ARGS)
        return(0);
 }
 
        return(0);
 }
 

+static int
+pre_aq(DECL_ARGS)
+{
+
+       print_word(n->parent->prev != NULL &&
+           n->parent->prev->tok == MDOC_An ?  "<" : "\\(la");
+       outflags &= ~MMAN_spc;
+       return(1);
+}
+
+static void
+post_aq(DECL_ARGS)
+{
+
+       outflags &= ~(MMAN_spc | MMAN_nl);
+       print_word(n->parent->prev != NULL &&
+           n->parent->prev->tok == MDOC_An ?  ">" : "\\(ra");
+}
+

 static int
 pre_bd(DECL_ARGS)
 {
 static int
 pre_bd(DECL_ARGS)
 {


@@ -843,7 +901,7 @@ pre_bd(DECL_ARGS)
                print_line(".nf", 0);
        if (0 == n->norm->Bd.comp && NULL != n->parent->prev)
                outflags |= MMAN_sp;
                print_line(".nf", 0);
        if (0 == n->norm->Bd.comp && NULL != n->parent->prev)
                outflags |= MMAN_sp;

-       print_offs(n->norm->Bd.offs);
+       print_offs(n->norm->Bd.offs, 1);

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


@@ -930,7 +988,7 @@ pre_bl(DECL_ARGS)
         * just nest and do not add up their indentation.
         */
        if (n->norm->Bl.offs) {
         * just nest and do not add up their indentation.
         */
        if (n->norm->Bl.offs) {

-               print_offs(n->norm->Bl.offs);
+               print_offs(n->norm->Bl.offs, 0);

                Bl_stack[Bl_stack_len++] = 0;
        }
 
                Bl_stack[Bl_stack_len++] = 0;
        }
 


@@ -1015,7 +1073,7 @@ static int
 pre_dl(DECL_ARGS)
 {
 
 pre_dl(DECL_ARGS)
 {
 

-       print_offs("6n");
+       print_offs("6n", 0);

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


@@ -1133,7 +1191,8 @@ pre_fl(DECL_ARGS)
 
        font_push('B');
        print_word("\\-");
 
        font_push('B');
        print_word("\\-");

-       outflags &= ~MMAN_spc;
+       if (n->nchild)
+               outflags &= ~MMAN_spc;

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


@@ -1142,8 +1201,10 @@ post_fl(DECL_ARGS)
 {
 
        font_pop();
 {
 
        font_pop();

-       if (0 == n->nchild && NULL != n->next &&
-                       n->next->line == n->line)
+       if ( ! (n->nchild ||
+           n->next == NULL ||
+           n->next->type == MDOC_TEXT ||
+           n->next->flags & MDOC_LINE))

                outflags &= ~MMAN_spc;
 }
 
                outflags &= ~MMAN_spc;
 }
 


@@ -1304,21 +1365,24 @@ pre_it(DECL_ARGS)
                        outflags |= MMAN_nl;
                        font_push('B');
                        if (LIST_bullet == bln->norm->Bl.type)
                        outflags |= MMAN_nl;
                        font_push('B');
                        if (LIST_bullet == bln->norm->Bl.type)

-                               print_word("o");
+                               print_word("\\(bu");

                        else
                                print_word("-");
                        font_pop();
                        else
                                print_word("-");
                        font_pop();

-                       break;
+                       outflags |= MMAN_nl;
+                       return(0);

                case LIST_enum:
                        print_width(bln->norm->Bl.width, NULL, 0);
                        TPremain = 0;
                        outflags |= MMAN_nl;
                        print_count(&bln->norm->Bl.count);
                case LIST_enum:
                        print_width(bln->norm->Bl.width, NULL, 0);
                        TPremain = 0;
                        outflags |= MMAN_nl;
                        print_count(&bln->norm->Bl.count);

-                       break;
+                       outflags |= MMAN_nl;
+                       return(0);

                case LIST_hang:
                        print_width(bln->norm->Bl.width, n->child, 6);
                        TPremain = 0;
                case LIST_hang:
                        print_width(bln->norm->Bl.width, n->child, 6);
                        TPremain = 0;

-                       break;
+                       outflags |= MMAN_nl;
+                       return(1);

                case LIST_tag:
                        print_width(bln->norm->Bl.width, n->child, 0);
                        putchar('\n');
                case LIST_tag:
                        print_width(bln->norm->Bl.width, n->child, 0);
                        putchar('\n');


@@ -1327,7 +1391,6 @@ pre_it(DECL_ARGS)
                default:
                        return(1);
                }
                default:
                        return(1);
                }

-               outflags |= MMAN_nl;

        default:
                break;
        }
        default:
                break;
        }


@@ -1509,7 +1572,8 @@ post_nm(DECL_ARGS)
        case MDOC_HEAD:
                /* FALLTHROUGH */
        case MDOC_ELEM:
        case MDOC_HEAD:
                /* FALLTHROUGH */
        case MDOC_ELEM:

-               font_pop();
+               if (n->child != NULL || meta->name != NULL)
+                       font_pop();

                break;
        default:
                break;
                break;
        default:
                break;


@@ -1561,6 +1625,58 @@ pre_rs(DECL_ARGS)
        return(1);
 }
 
        return(1);
 }
 

+static int
+pre_rv(DECL_ARGS)
+{
+       int      nchild;
+
+       outflags |= MMAN_br | MMAN_nl;
+
+       nchild = n->nchild;
+       if (nchild > 0) {
+               print_word("The");
+
+               for (n = n->child; n; n = n->next) {
+                       font_push('B');
+                       print_word(n->string);
+                       font_pop();
+
+                       outflags &= ~MMAN_spc;
+                       print_word("()");
+
+                       if (n->next == NULL)
+                               continue;
+
+                       if (nchild > 2) {
+                               outflags &= ~MMAN_spc;
+                               print_word(",");
+                       }
+                       if (n->next->next == NULL)
+                               print_word("and");
+               }
+
+               if (nchild > 1)
+                       print_word("functions return");
+               else
+                       print_word("function returns");
+
+               print_word("the value\\~0 if successful;");
+       } else
+               print_word("Upon successful completion, "
+                   "the value\\~0 is returned;");
+
+       print_word("otherwise the value\\~\\-1 is returned"
+           " and the global variable");
+
+       font_push('I');
+       print_word("errno");
+       font_pop();
+
+       print_word("is set to indicate the error.");
+       outflags |= MMAN_nl;
+       return(0);
+}
+

 static int
 pre_sm(DECL_ARGS)
 {
 static int
 pre_sm(DECL_ARGS)
 {