In URIs in apropos(1) result tables,

[mandoc.git] / mdoc_man.c

diff --git a/mdoc_man.c b/mdoc_man.c
index b3d98f540090481ac243de0220596612e689ea10..bf6bc90932f37cc580986c7a780401c764e76d47 100644 (file)
--- a/mdoc_man.c
+++ b/mdoc_man.c
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_man.c,v 1.94 2015/10/06 18:32:19 schwarze Exp $ */
+/*     $Id: mdoc_man.c,v 1.105 2017/03/04 21:41:29 schwarze Exp $ */
 /*
- * Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011-2017 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -79,7 +79,6 @@ static        int       pre_bf(DECL_ARGS);
 static int       pre_bk(DECL_ARGS);
 static int       pre_bl(DECL_ARGS);
 static int       pre_br(DECL_ARGS);
-static int       pre_bx(DECL_ARGS);
 static int       pre_dl(DECL_ARGS);
 static int       pre_en(DECL_ARGS);
 static int       pre_enc(DECL_ARGS);
@@ -103,14 +102,12 @@ 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_rv(DECL_ARGS);
 static int       pre_sm(DECL_ARGS);
 static int       pre_sp(DECL_ARGS);
 static int       pre_sect(DECL_ARGS);
 static int       pre_sy(DECL_ARGS);
 static void      pre_syn(const struct roff_node *);
 static int       pre_vt(DECL_ARGS);
-static int       pre_ux(DECL_ARGS);
 static int       pre_xr(DECL_ARGS);
 static void      print_word(const char *);
 static void      print_line(const char *, int);
@@ -158,7 +155,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 */
-       { NULL, pre_rv, NULL, NULL, NULL }, /* Rv */
+       { NULL, pre_ex, 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 */
@@ -182,8 +179,8 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { NULL, pre_bf, post_bf, NULL, NULL }, /* Bf */
        { cond_body, pre_enc, post_enc, "[", "]" }, /* Bo */
        { cond_body, pre_enc, post_enc, "[", "]" }, /* Bq */
-       { NULL, pre_ux, NULL, "BSD/OS", NULL }, /* Bsx */
-       { NULL, pre_bx, NULL, NULL, NULL }, /* Bx */
+       { NULL, NULL, NULL, NULL, NULL }, /* Bsx */
+       { NULL, NULL, NULL, NULL, NULL }, /* Bx */
        { NULL, pre_skip, NULL, NULL, NULL }, /* Db */
        { NULL, NULL, NULL, NULL, NULL }, /* Dc */
        { cond_body, pre_enc, post_enc, "\\(Lq", "\\(Rq" }, /* Do */
@@ -192,12 +189,12 @@ static    const struct manact manacts[MDOC_MAX + 1] = {
        { NULL, NULL, NULL, NULL, NULL }, /* Ef */
        { NULL, pre_em, post_font, NULL, NULL }, /* Em */
        { cond_body, pre_eo, post_eo, NULL, NULL }, /* Eo */
-       { NULL, pre_ux, NULL, "FreeBSD", NULL }, /* Fx */
+       { NULL, NULL, NULL, NULL, NULL }, /* Fx */
        { NULL, pre_sy, post_font, NULL, NULL }, /* Ms */
        { NULL, pre_no, NULL, NULL, NULL }, /* No */
        { NULL, pre_ns, NULL, NULL, NULL }, /* Ns */
-       { NULL, pre_ux, NULL, "NetBSD", NULL }, /* Nx */
-       { NULL, pre_ux, NULL, "OpenBSD", NULL }, /* Ox */
+       { NULL, NULL, NULL, NULL, NULL }, /* Nx */
+       { NULL, NULL, NULL, NULL, NULL }, /* Ox */
        { NULL, NULL, NULL, NULL, NULL }, /* Pc */
        { NULL, NULL, post_pf, NULL, NULL }, /* Pf */
        { cond_body, pre_enc, post_enc, "(", ")" }, /* Po */
@@ -215,7 +212,7 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { NULL, pre_em, post_font, NULL, NULL }, /* Sx */
        { NULL, pre_sy, post_font, NULL, NULL }, /* Sy */
        { NULL, pre_li, post_font, NULL, NULL }, /* Tn */
-       { NULL, pre_ux, NULL, "UNIX", NULL }, /* Ux */
+       { NULL, NULL, NULL, NULL, NULL }, /* Ux */
        { NULL, NULL, NULL, NULL, NULL }, /* Xc */
        { NULL, NULL, NULL, NULL, NULL }, /* Xo */
        { NULL, pre_fo, post_fo, NULL, NULL }, /* Fo */
@@ -224,10 +221,10 @@ static    const struct manact manacts[MDOC_MAX + 1] = {
        { NULL, NULL, NULL, NULL, NULL }, /* Oc */
        { NULL, pre_bk, post_bk, NULL, NULL }, /* Bk */
        { NULL, NULL, NULL, NULL, NULL }, /* Ek */
-       { NULL, pre_ux, NULL, "is currently in beta test.", NULL }, /* Bt */
+       { NULL, NULL, NULL, NULL, NULL }, /* Bt */
        { NULL, NULL, NULL, NULL, NULL }, /* Hf */
        { NULL, pre_em, post_font, NULL, NULL }, /* Fr */
-       { NULL, pre_ux, NULL, "currently under development.", NULL }, /* Ud */
+       { NULL, NULL, NULL, NULL, NULL }, /* Ud */
        { NULL, NULL, post_lb, NULL, NULL }, /* Lb */
        { NULL, pre_pp, NULL, NULL, NULL }, /* Lp */
        { NULL, pre_lk, NULL, NULL, NULL }, /* Lk */
@@ -238,7 +235,7 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { NULL, NULL, post_percent, NULL, NULL }, /* %C */
        { NULL, pre_skip, NULL, NULL, NULL }, /* Es */
        { cond_body, pre_en, post_en, NULL, NULL }, /* En */
-       { NULL, pre_ux, NULL, "DragonFly", NULL }, /* Dx */
+       { NULL, NULL, NULL, NULL, NULL }, /* Dx */
        { NULL, NULL, post_percent, NULL, NULL }, /* %Q */
        { NULL, pre_br, NULL, NULL, NULL }, /* br */
        { NULL, pre_sp, post_sp, NULL, NULL }, /* sp */
@@ -575,17 +572,20 @@ print_node(DECL_ARGS)
        struct roff_node        *sub;
        int                      cond, do_sub;
 
+       if (n->flags & NODE_NOPRT)
+               return;
+
        /*
         * Break the line if we were parsed subsequent the current node.
         * This makes the page structure be more consistent.
         */
-       if (MMAN_spc & outflags && MDOC_LINE & n->flags)
+       if (MMAN_spc & outflags && NODE_LINE & n->flags)
                outflags |= MMAN_nl;
 
        act = NULL;
        cond = 0;
        do_sub = 1;
-       n->flags &= ~MDOC_ENDED;
+       n->flags &= ~NODE_ENDED;
 
        if (n->type == ROFFT_TEXT) {
                /*
@@ -598,10 +598,14 @@ print_node(DECL_ARGS)
                        printf("\\&");
                        outflags &= ~MMAN_spc;
                }
-               if (outflags & MMAN_Sm && ! (n->flags & MDOC_DELIMC))
+               if (n->flags & NODE_DELIMC)
+                       outflags &= ~(MMAN_spc | MMAN_spc_force);
+               else if (outflags & MMAN_Sm)
                        outflags |= MMAN_spc_force;
                print_word(n->string);
-               if (outflags & MMAN_Sm && ! (n->flags & MDOC_DELIMO))
+               if (n->flags & NODE_DELIMO)
+                       outflags &= ~(MMAN_spc | MMAN_spc_force);
+               else if (outflags & MMAN_Sm)
                        outflags |= MMAN_spc;
        } else {
                /*
@@ -610,7 +614,8 @@ print_node(DECL_ARGS)
                 */
                act = manacts + n->tok;
                cond = act->cond == NULL || (*act->cond)(meta, n);
-               if (cond && act->pre && (n->end == ENDBODY_NOT || n->nchild))
+               if (cond && act->pre != NULL &&
+                   (n->end == ENDBODY_NOT || n->child != NULL))
                        do_sub = (*act->pre)(meta, n);
        }
 
@@ -626,17 +631,14 @@ print_node(DECL_ARGS)
        /*
         * Lastly, conditionally run the post-node handler.
         */
-       if (MDOC_ENDED & n->flags)
+       if (NODE_ENDED & n->flags)
                return;
 
        if (cond && act->post)
                (*act->post)(meta, n);
 
        if (ENDBODY_NOT != n->end)
-               n->body->flags |= MDOC_ENDED;
-
-       if (ENDBODY_NOSPACE == n->end)
-               outflags &= ~(MMAN_spc | MMAN_nl);
+               n->body->flags |= NODE_ENDED;
 }
 
 static int
@@ -681,37 +683,8 @@ post_enc(DECL_ARGS)
 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;
+       return 1;
 }
 
 static void
@@ -742,10 +715,8 @@ static int
 pre__t(DECL_ARGS)
 {
 
-       if (n->parent && MDOC_Rs == n->parent->tok &&
-           n->parent->norm->Rs.quote_T) {
-               print_word("");
-               putchar('\"');
+       if (n->parent->tok == MDOC_Rs && n->parent->norm->Rs.quote_T) {
+               print_word("\\(lq");
                outflags &= ~MMAN_spc;
        } else
                font_push('I');
@@ -756,11 +727,9 @@ static void
 post__t(DECL_ARGS)
 {
 
-       if (n->parent && MDOC_Rs == n->parent->tok &&
-           n->parent->norm->Rs.quote_T) {
+       if (n->parent->tok  == MDOC_Rs && n->parent->norm->Rs.quote_T) {
                outflags &= ~MMAN_spc;
-               print_word("");
-               putchar('\"');
+               print_word("\\(rq");
        } else
                font_pop();
        post_percent(meta, n);
@@ -805,7 +774,7 @@ static void
 pre_syn(const struct roff_node *n)
 {
 
-       if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags))
+       if (NULL == n->prev || ! (NODE_SYNPRETTY & n->flags))
                return;
 
        if (n->prev->tok == n->tok &&
@@ -818,13 +787,9 @@ pre_syn(const struct roff_node *n)
 
        switch (n->prev->tok) {
        case MDOC_Fd:
-               /* FALLTHROUGH */
        case MDOC_Fn:
-               /* FALLTHROUGH */
        case MDOC_Fo:
-               /* FALLTHROUGH */
        case MDOC_In:
-               /* FALLTHROUGH */
        case MDOC_Vt:
                outflags |= MMAN_sp;
                break;
@@ -877,7 +842,7 @@ static int
 pre_aq(DECL_ARGS)
 {
 
-       print_word(n->nchild == 1 &&
+       print_word(n->child != NULL && n->child->next == NULL &&
            n->child->tok == MDOC_Mt ?  "<" : "\\(la");
        outflags &= ~MMAN_spc;
        return 1;
@@ -888,7 +853,7 @@ post_aq(DECL_ARGS)
 {
 
        outflags &= ~(MMAN_spc | MMAN_nl);
-       print_word(n->nchild == 1 &&
+       print_word(n->child != NULL && n->child->next == NULL &&
            n->child->tok == MDOC_Mt ?  ">" : "\\(ra");
 }
 
@@ -1004,7 +969,7 @@ pre_bl(DECL_ARGS)
                return 1;
        }
 
-       if (n->nchild) {
+       if (n->child != NULL) {
                print_line(".TS", MMAN_nl);
                for (icol = 0; icol < n->norm->Bl.ncols; icol++)
                        print_word("l");
@@ -1020,7 +985,7 @@ post_bl(DECL_ARGS)
 
        switch (n->norm->Bl.type) {
        case LIST_column:
-               if (n->nchild)
+               if (n->child != NULL)
                        print_line(".TE", 0);
                break;
        case LIST_enum:
@@ -1054,26 +1019,6 @@ pre_br(DECL_ARGS)
        return 0;
 }
 
-static int
-pre_bx(DECL_ARGS)
-{
-
-       n = n->child;
-       if (n) {
-               print_word(n->string);
-               outflags &= ~MMAN_spc;
-               n = n->next;
-       }
-       print_word("BSD");
-       if (NULL == n)
-               return 0;
-       outflags &= ~MMAN_spc;
-       print_word("-");
-       outflags &= ~MMAN_spc;
-       print_word(n->string);
-       return 0;
-}
-
 static int
 pre_dl(DECL_ARGS)
 {
@@ -1177,7 +1122,7 @@ pre_fa(DECL_ARGS)
 
        while (NULL != n) {
                font_push('I');
-               if (am_Fa || MDOC_SYNPRETTY & n->flags)
+               if (am_Fa || NODE_SYNPRETTY & n->flags)
                        outflags |= MMAN_nbrword;
                print_node(meta, n);
                font_pop();
@@ -1218,7 +1163,7 @@ pre_fl(DECL_ARGS)
 
        font_push('B');
        print_word("\\-");
-       if (n->nchild)
+       if (n->child != NULL)
                outflags &= ~MMAN_spc;
        return 1;
 }
@@ -1228,10 +1173,10 @@ post_fl(DECL_ARGS)
 {
 
        font_pop();
-       if ( ! (n->nchild ||
+       if (!(n->child != NULL ||
            n->next == NULL ||
            n->next->type == ROFFT_TEXT ||
-           n->next->flags & MDOC_LINE))
+           n->next->flags & NODE_LINE))
                outflags &= ~MMAN_spc;
 }
 
@@ -1245,7 +1190,7 @@ pre_fn(DECL_ARGS)
        if (NULL == n)
                return 0;
 
-       if (MDOC_SYNPRETTY & n->flags)
+       if (NODE_SYNPRETTY & n->flags)
                print_block(".HP 4n", MMAN_nl);
 
        font_push('B');
@@ -1266,7 +1211,7 @@ post_fn(DECL_ARGS)
 {
 
        print_word(")");
-       if (MDOC_SYNPRETTY & n->flags) {
+       if (NODE_SYNPRETTY & n->flags) {
                print_word(";");
                outflags |= MMAN_PP;
        }
@@ -1283,7 +1228,7 @@ pre_fo(DECL_ARGS)
        case ROFFT_HEAD:
                if (n->child == NULL)
                        return 0;
-               if (MDOC_SYNPRETTY & n->flags)
+               if (NODE_SYNPRETTY & n->flags)
                        print_block(".HP 4n", MMAN_nl);
                font_push('B');
                break;
@@ -1328,7 +1273,7 @@ static int
 pre_in(DECL_ARGS)
 {
 
-       if (MDOC_SYNPRETTY & n->flags) {
+       if (NODE_SYNPRETTY & n->flags) {
                pre_syn(n);
                font_push('B');
                print_word("#include <");
@@ -1345,7 +1290,7 @@ static void
 post_in(DECL_ARGS)
 {
 
-       if (MDOC_SYNPRETTY & n->flags) {
+       if (NODE_SYNPRETTY & n->flags) {
                outflags &= ~MMAN_spc;
                print_word(">");
                font_pop();
@@ -1375,9 +1320,7 @@ pre_it(DECL_ARGS)
                case LIST_item:
                        return 0;
                case LIST_inset:
-                       /* FALLTHROUGH */
                case LIST_diag:
-                       /* FALLTHROUGH */
                case LIST_ohang:
                        if (bln->norm->Bl.type == LIST_diag)
                                print_line(".B \"", 0);
@@ -1386,9 +1329,7 @@ pre_it(DECL_ARGS)
                        outflags &= ~MMAN_spc;
                        return 1;
                case LIST_bullet:
-                       /* FALLTHROUGH */
                case LIST_dash:
-                       /* FALLTHROUGH */
                case LIST_hyphen:
                        print_width(&bln->norm->Bl, NULL);
                        TPremain = 0;
@@ -1478,15 +1419,10 @@ post_it(DECL_ARGS)
        case ROFFT_BODY:
                switch (bln->norm->Bl.type) {
                case LIST_bullet:
-                       /* FALLTHROUGH */
                case LIST_dash:
-                       /* FALLTHROUGH */
                case LIST_hyphen:
-                       /* FALLTHROUGH */
                case LIST_enum:
-                       /* FALLTHROUGH */
                case LIST_hang:
-                       /* FALLTHROUGH */
                case LIST_tag:
                        assert(Bl_stack_len);
                        Bl_stack[--Bl_stack_len] = 0;
@@ -1575,7 +1511,7 @@ pre_nm(DECL_ARGS)
        }
        if (n->type != ROFFT_ELEM && n->type != ROFFT_HEAD)
                return 1;
-       name = n->child ? n->child->string : meta->name;
+       name = n->child == NULL ? NULL : n->child->string;
        if (NULL == name)
                return 0;
        if (n->type == ROFFT_HEAD) {
@@ -1586,8 +1522,6 @@ pre_nm(DECL_ARGS)
                outflags |= MMAN_nl;
        }
        font_push('B');
-       if (NULL == n->child)
-               print_word(meta->name);
        return 1;
 }
 
@@ -1600,9 +1534,8 @@ post_nm(DECL_ARGS)
                outflags &= ~MMAN_Bk;
                break;
        case ROFFT_HEAD:
-               /* FALLTHROUGH */
        case ROFFT_ELEM:
-               if (n->child != NULL || meta->name != NULL)
+               if (n->child != NULL && n->child->string != NULL)
                        font_pop();
                break;
        default:
@@ -1630,7 +1563,7 @@ static void
 post_pf(DECL_ARGS)
 {
 
-       if ( ! (n->next == NULL || n->next->flags & MDOC_LINE))
+       if ( ! (n->next == NULL || n->next->flags & NODE_LINE))
                outflags &= ~MMAN_spc;
 }
 
@@ -1656,58 +1589,6 @@ pre_rs(DECL_ARGS)
        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_skip(DECL_ARGS)
 {
@@ -1763,7 +1644,7 @@ static int
 pre_vt(DECL_ARGS)
 {
 
-       if (MDOC_SYNPRETTY & n->flags) {
+       if (NODE_SYNPRETTY & n->flags) {
                switch (n->type) {
                case ROFFT_BLOCK:
                        pre_syn(n);
@@ -1782,7 +1663,7 @@ static void
 post_vt(DECL_ARGS)
 {
 
-       if (n->flags & MDOC_SYNPRETTY && n->type != ROFFT_BODY)
+       if (n->flags & NODE_SYNPRETTY && n->type != ROFFT_BODY)
                return;
        font_pop();
 }
@@ -1804,16 +1685,3 @@ pre_xr(DECL_ARGS)
        print_word(")");
        return 0;
 }
-
-static int
-pre_ux(DECL_ARGS)
-{
-
-       print_word(manacts[n->tok].prefix);
-       if (NULL == n->child)
-               return 0;
-       outflags &= ~MMAN_spc;
-       print_word("\\ ");
-       outflags &= ~MMAN_spc;
-       return 1;
-}