]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_man.c
Do not report a page as arch=any merely because .Dt lacks the third argument.
[mandoc.git] / mdoc_man.c
index 29bede8fdc80a1faf40588bfd5003dc905b4791f..6fa424aea356dc60665c71dab44abcf41ed35b7a 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_man.c,v 1.63 2014/04/20 19:40:13 schwarze Exp $ */
+/*     $Id: mdoc_man.c,v 1.70 2014/08/21 12:57:17 schwarze Exp $ */
 /*
  * 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.
  */
-#ifdef HAVE_CONFIG_H
 #include "config.h"
-#endif
+
+#include <sys/types.h>
 
 #include <assert.h>
 #include <stdio.h>
@@ -51,6 +51,7 @@ static        void      post_bf(DECL_ARGS);
 static void      post_bk(DECL_ARGS);
 static void      post_bl(DECL_ARGS);
 static void      post_dl(DECL_ARGS);
+static void      post_en(DECL_ARGS);
 static void      post_enc(DECL_ARGS);
 static void      post_eo(DECL_ARGS);
 static void      post_fa(DECL_ARGS);
@@ -78,8 +79,11 @@ 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);
 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);
@@ -96,6 +100,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_rv(DECL_ARGS);
 static int       pre_sm(DECL_ARGS);
 static int       pre_sp(DECL_ARGS);
 static int       pre_sect(DECL_ARGS);
@@ -136,9 +141,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_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 */
@@ -150,13 +153,9 @@ static     const struct manact manacts[MDOC_MAX + 1] = {
        { cond_head, pre_enc, NULL, "\\- ", NULL }, /* Nd */
        { NULL, pre_nm, post_nm, NULL, NULL }, /* Nm */
        { cond_body, pre_enc, post_enc, "[", "]" }, /* Op */
-       { NULL, NULL, NULL, NULL, NULL }, /* Ot */
+       { 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 */
@@ -224,7 +223,7 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { NULL, NULL, NULL, NULL, NULL }, /* Ek */
        { NULL, pre_ux, NULL, "is currently in beta test.", NULL }, /* Bt */
        { NULL, NULL, NULL, NULL, NULL }, /* Hf */
-       { NULL, NULL, NULL, NULL, NULL }, /* Fr */
+       { NULL, pre_em, post_font, NULL, NULL }, /* Fr */
        { NULL, pre_ux, NULL, "currently under development.", NULL }, /* Ud */
        { NULL, NULL, post_lb, NULL, NULL }, /* Lb */
        { NULL, pre_pp, NULL, NULL, NULL }, /* Lp */
@@ -234,8 +233,8 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { cond_body, pre_enc, post_enc, "{", "}" }, /* Bro */
        { NULL, NULL, NULL, NULL, NULL }, /* Brc */
        { NULL, NULL, post_percent, NULL, NULL }, /* %C */
-       { NULL, NULL, NULL, NULL, NULL }, /* Es */
-       { NULL, NULL, NULL, NULL, NULL }, /* En */
+       { NULL, pre_es, NULL, NULL, NULL }, /* Es */
+       { cond_body, pre_en, post_en, NULL, NULL }, /* En */
        { NULL, pre_ux, NULL, "DragonFly", NULL }, /* Dx */
        { NULL, NULL, post_percent, NULL, NULL }, /* %Q */
        { NULL, pre_br, NULL, NULL, NULL }, /* br */
@@ -549,8 +548,9 @@ man_mdoc(void *arg, const struct mdoc *mdoc)
        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");
@@ -670,6 +670,42 @@ post_enc(DECL_ARGS)
        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)
 {
@@ -1035,6 +1071,33 @@ pre_em(DECL_ARGS)
        return(1);
 }
 
+static int
+pre_en(DECL_ARGS)
+{
+
+       if (NULL == n->norm->Es ||
+           NULL == n->norm->Es->child)
+               return(1);
+
+       print_word(n->norm->Es->child->string);
+       outflags &= ~MMAN_spc;
+       return(1);
+}
+
+static void
+post_en(DECL_ARGS)
+{
+
+       if (NULL == n->norm->Es ||
+           NULL == n->norm->Es->child ||
+           NULL == n->norm->Es->child->next)
+               return;
+
+       outflags &= ~MMAN_spc;
+       print_word(n->norm->Es->child->next->string);
+       return;
+}
+
 static void
 post_eo(DECL_ARGS)
 {
@@ -1043,6 +1106,13 @@ post_eo(DECL_ARGS)
                outflags &= ~MMAN_spc;
 }
 
+static int
+pre_es(DECL_ARGS)
+{
+
+       return(0);
+}
+
 static int
 pre_fa(DECL_ARGS)
 {
@@ -1096,7 +1166,8 @@ pre_fl(DECL_ARGS)
 
        font_push('B');
        print_word("\\-");
-       outflags &= ~MMAN_spc;
+       if (n->nchild)
+               outflags &= ~MMAN_spc;
        return(1);
 }
 
@@ -1105,8 +1176,10 @@ post_fl(DECL_ARGS)
 {
 
        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;
 }
 
@@ -1271,17 +1344,20 @@ pre_it(DECL_ARGS)
                        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);
-                       break;
+                       outflags |= MMAN_nl;
+                       return(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');
@@ -1290,7 +1366,6 @@ pre_it(DECL_ARGS)
                default:
                        return(1);
                }
-               outflags |= MMAN_nl;
        default:
                break;
        }
@@ -1472,7 +1547,8 @@ post_nm(DECL_ARGS)
        case MDOC_HEAD:
                /* FALLTHROUGH */
        case MDOC_ELEM:
-               font_pop();
+               if (n->child != NULL || meta->name != NULL)
+                       font_pop();
                break;
        default:
                break;
@@ -1524,15 +1600,72 @@ 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_sm(DECL_ARGS)
 {
 
-       assert(n->child && MDOC_TEXT == n->child->type);
-       if (0 == strcmp("on", n->child->string))
-               outflags |= MMAN_Sm | MMAN_spc;
+       if (NULL == n->child)
+               outflags ^= MMAN_Sm;
+       else if (0 == strcmp("on", n->child->string))
+               outflags |= MMAN_Sm;
        else
                outflags &= ~MMAN_Sm;
+
+       if (MMAN_Sm & outflags)
+               outflags |= MMAN_spc;
+
        return(0);
 }