]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_html.c
fix a typo that prevented names from .Dt from getting priority
[mandoc.git] / man_html.c
index 9689cc261e5fbfb5784e22d8c2f330ca69a9570a..d71eb382379895b0846a33e41d306f40c7ec8823 100644 (file)
@@ -1,23 +1,21 @@
-/*     $Id: man_html.c,v 1.96 2014/08/01 19:25:52 schwarze Exp $ */
+/*     $Id: man_html.c,v 1.120 2016/01/08 17:48:09 schwarze Exp $ */
 /*
- * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2013, 2014, 2015 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
  * copyright notice and this permission notice appear in all copies.
  *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * 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 <stdlib.h>
 #include <string.h>
 
-#include "mandoc.h"
 #include "mandoc_aux.h"
+#include "roff.h"
+#include "man.h"
 #include "out.h"
 #include "html.h"
-#include "man.h"
 #include "main.h"
 
 /* TODO: preserve ident widths. */
@@ -39,8 +37,8 @@
 
 #define        INDENT            5
 
-#define        MAN_ARGS          const struct man_meta *man, \
-                         const struct man_node *n, \
+#define        MAN_ARGS          const struct roff_meta *man, \
+                         const struct roff_node *n, \
                          struct mhtml *mh, \
                          struct html *h
 
@@ -55,12 +53,11 @@ struct      htmlman {
 };
 
 static void              print_bvspace(struct html *,
-                               const struct man_node *);
-static void              print_man(MAN_ARGS);
+                               const struct roff_node *);
 static void              print_man_head(MAN_ARGS);
 static void              print_man_nodelist(MAN_ARGS);
 static void              print_man_node(MAN_ARGS);
-static int               a2width(const struct man_node *,
+static int               a2width(const struct roff_node *,
                                struct roffsu *);
 static int               man_B_pre(MAN_ARGS);
 static int               man_HP_pre(MAN_ARGS);
@@ -103,7 +100,6 @@ static      const struct htmlman mans[MAN_MAX] = {
        { man_I_pre, NULL }, /* I */
        { man_alt_pre, NULL }, /* IR */
        { man_alt_pre, NULL }, /* RI */
-       { man_ign_pre, NULL }, /* na */
        { man_br_pre, NULL }, /* sp */
        { man_literal_pre, NULL }, /* nf */
        { man_literal_pre, NULL }, /* fi */
@@ -133,51 +129,46 @@ static    const struct htmlman mans[MAN_MAX] = {
  * first, print it.
  */
 static void
-print_bvspace(struct html *h, const struct man_node *n)
+print_bvspace(struct html *h, const struct roff_node *n)
 {
 
        if (n->body && n->body->child)
-               if (MAN_TBL == n->body->child->type)
+               if (n->body->child->type == ROFFT_TBL)
                        return;
 
-       if (MAN_ROOT == n->parent->type || MAN_RS != n->parent->tok)
+       if (n->parent->type == ROFFT_ROOT || n->parent->tok != MAN_RS)
                if (NULL == n->prev)
                        return;
 
-       print_otag(h, TAG_P, 0, NULL);
+       print_paragraph(h);
 }
 
 void
-html_man(void *arg, const struct man *man)
+html_man(void *arg, const struct roff_man *man)
 {
        struct mhtml     mh;
-
-       memset(&mh, 0, sizeof(struct mhtml));
-       print_man(man_meta(man), man_node(man), &mh, (struct html *)arg);
-       putchar('\n');
-}
-
-static void
-print_man(MAN_ARGS)
-{
-       struct tag      *t, *tt;
        struct htmlpair  tag;
+       struct html     *h;
+       struct tag      *t, *tt;
 
+       memset(&mh, 0, sizeof(mh));
        PAIR_CLASS_INIT(&tag, "mandoc");
+       h = (struct html *)arg;
 
        if ( ! (HTML_FRAGMENT & h->oflags)) {
                print_gen_decls(h);
                t = print_otag(h, TAG_HTML, 0, NULL);
                tt = print_otag(h, TAG_HEAD, 0, NULL);
-               print_man_head(man, n, mh, h);
+               print_man_head(&man->meta, man->first, &mh, h);
                print_tagq(h, tt);
                print_otag(h, TAG_BODY, 0, NULL);
                print_otag(h, TAG_DIV, 1, &tag);
        } else
                t = print_otag(h, TAG_DIV, 1, &tag);
 
-       print_man_nodelist(man, n, mh, h);
+       print_man_nodelist(&man->meta, man->first, &mh, h);
        print_tagq(h, t);
+       putchar('\n');
 }
 
 static void
@@ -196,9 +187,10 @@ static void
 print_man_nodelist(MAN_ARGS)
 {
 
-       print_man_node(man, n, mh, h);
-       if (n->next)
-               print_man_nodelist(man, n->next, mh, h);
+       while (n != NULL) {
+               print_man_node(man, n, mh, h);
+               n = n->next;
+       }
 }
 
 static void
@@ -211,31 +203,26 @@ print_man_node(MAN_ARGS)
        t = h->tags.head;
 
        switch (n->type) {
-       case MAN_ROOT:
+       case ROFFT_ROOT:
                man_root_pre(man, n, mh, h);
                break;
-       case MAN_TEXT:
-               /*
-                * If we have a blank line, output a vertical space.
-                * If we have a space as the first character, break
-                * before printing the line's data.
-                */
+       case ROFFT_TEXT:
                if ('\0' == *n->string) {
-                       print_otag(h, TAG_P, 0, NULL);
+                       print_paragraph(h);
                        return;
                }
-
-               if (' ' == *n->string && MAN_LINE & n->flags)
-                       print_otag(h, TAG_BR, 0, NULL);
-               else if (MANH_LITERAL & mh->fl && n->prev)
+               if (n->flags & MAN_LINE && (*n->string == ' ' ||
+                   (n->prev != NULL && mh->fl & MANH_LITERAL &&
+                    ! (h->flags & HTML_NONEWLINE))))
                        print_otag(h, TAG_BR, 0, NULL);
-
                print_text(h, n->string);
                return;
-       case MAN_EQN:
+       case ROFFT_EQN:
+               if (n->flags & MAN_LINE)
+                       putchar('\n');
                print_eqn(h, n->eqn);
                break;
-       case MAN_TBL:
+       case ROFFT_TBL:
                /*
                 * This will take care of initialising all of the table
                 * state data for the first table, then tearing it down
@@ -274,10 +261,10 @@ print_man_node(MAN_ARGS)
        print_stagq(h, t);
 
        switch (n->type) {
-       case MAN_ROOT:
+       case ROFFT_ROOT:
                man_root_post(man, n, mh, h);
                break;
-       case MAN_EQN:
+       case ROFFT_EQN:
                break;
        default:
                if (mans[n->tok].post)
@@ -287,21 +274,21 @@ print_man_node(MAN_ARGS)
 }
 
 static int
-a2width(const struct man_node *n, struct roffsu *su)
+a2width(const struct roff_node *n, struct roffsu *su)
 {
 
-       if (MAN_TEXT != n->type)
-               return(0);
-       if (a2roffsu(n->string, su, SCALE_BU))
-               return(1);
+       if (n->type != ROFFT_TEXT)
+               return 0;
+       if (a2roffsu(n->string, su, SCALE_EN))
+               return 1;
 
-       return(0);
+       return 0;
 }
 
 static void
 man_root_pre(MAN_ARGS)
 {
-       struct htmlpair  tag[3];
+       struct htmlpair  tag;
        struct tag      *t, *tt;
        char            *title;
 
@@ -309,34 +296,26 @@ man_root_pre(MAN_ARGS)
        assert(man->msec);
        mandoc_asprintf(&title, "%s(%s)", man->title, man->msec);
 
-       PAIR_SUMMARY_INIT(&tag[0], "Document Header");
-       PAIR_CLASS_INIT(&tag[1], "head");
-       PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
-       t = print_otag(h, TAG_TABLE, 3, tag);
-       PAIR_INIT(&tag[0], ATTR_WIDTH, "30%");
-       print_otag(h, TAG_COL, 1, tag);
-       print_otag(h, TAG_COL, 1, tag);
-       print_otag(h, TAG_COL, 1, tag);
+       PAIR_CLASS_INIT(&tag, "head");
+       t = print_otag(h, TAG_TABLE, 1, &tag);
 
        print_otag(h, TAG_TBODY, 0, NULL);
 
        tt = print_otag(h, TAG_TR, 0, NULL);
 
-       PAIR_CLASS_INIT(&tag[0], "head-ltitle");
-       print_otag(h, TAG_TD, 1, tag);
+       PAIR_CLASS_INIT(&tag, "head-ltitle");
+       print_otag(h, TAG_TD, 1, &tag);
        print_text(h, title);
        print_stagq(h, tt);
 
-       PAIR_CLASS_INIT(&tag[0], "head-vol");
-       PAIR_INIT(&tag[1], ATTR_ALIGN, "center");
-       print_otag(h, TAG_TD, 2, tag);
+       PAIR_CLASS_INIT(&tag, "head-vol");
+       print_otag(h, TAG_TD, 1, &tag);
        if (NULL != man->vol)
                print_text(h, man->vol);
        print_stagq(h, tt);
 
-       PAIR_CLASS_INIT(&tag[0], "head-rtitle");
-       PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
-       print_otag(h, TAG_TD, 2, tag);
+       PAIR_CLASS_INIT(&tag, "head-rtitle");
+       print_otag(h, TAG_TD, 1, &tag);
        print_text(h, title);
        print_tagq(h, t);
        free(title);
@@ -345,32 +324,26 @@ man_root_pre(MAN_ARGS)
 static void
 man_root_post(MAN_ARGS)
 {
-       struct htmlpair  tag[3];
+       struct htmlpair  tag;
        struct tag      *t, *tt;
 
-       PAIR_SUMMARY_INIT(&tag[0], "Document Footer");
-       PAIR_CLASS_INIT(&tag[1], "foot");
-       PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
-       t = print_otag(h, TAG_TABLE, 3, tag);
-       PAIR_INIT(&tag[0], ATTR_WIDTH, "50%");
-       print_otag(h, TAG_COL, 1, tag);
-       print_otag(h, TAG_COL, 1, tag);
+       PAIR_CLASS_INIT(&tag, "foot");
+       t = print_otag(h, TAG_TABLE, 1, &tag);
 
        tt = print_otag(h, TAG_TR, 0, NULL);
 
-       PAIR_CLASS_INIT(&tag[0], "foot-date");
-       print_otag(h, TAG_TD, 1, tag);
+       PAIR_CLASS_INIT(&tag, "foot-date");
+       print_otag(h, TAG_TD, 1, &tag);
 
        assert(man->date);
        print_text(h, man->date);
        print_stagq(h, tt);
 
-       PAIR_CLASS_INIT(&tag[0], "foot-os");
-       PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
-       print_otag(h, TAG_TD, 2, tag);
+       PAIR_CLASS_INIT(&tag, "foot-os");
+       print_otag(h, TAG_TD, 1, &tag);
 
-       if (man->source)
-               print_text(h, man->source);
+       if (man->os)
+               print_text(h, man->os);
        print_tagq(h, t);
 }
 
@@ -386,7 +359,7 @@ man_br_pre(MAN_ARGS)
        if (MAN_sp == n->tok) {
                if (NULL != (n = n->child))
                        if ( ! a2roffsu(n->string, &su, SCALE_VS))
-                               SCALE_VS_INIT(&su, atoi(n->string));
+                               su.scale = 1.0;
        } else
                su.scale = 0.0;
 
@@ -398,7 +371,7 @@ man_br_pre(MAN_ARGS)
        /* So the div isn't empty: */
        print_text(h, "\\~");
 
-       return(0);
+       return 0;
 }
 
 static int
@@ -406,22 +379,22 @@ man_SH_pre(MAN_ARGS)
 {
        struct htmlpair  tag;
 
-       if (MAN_BLOCK == n->type) {
+       if (n->type == ROFFT_BLOCK) {
                mh->fl &= ~MANH_LITERAL;
                PAIR_CLASS_INIT(&tag, "section");
                print_otag(h, TAG_DIV, 1, &tag);
-               return(1);
-       } else if (MAN_BODY == n->type)
-               return(1);
+               return 1;
+       } else if (n->type == ROFFT_BODY)
+               return 1;
 
        print_otag(h, TAG_H1, 0, NULL);
-       return(1);
+       return 1;
 }
 
 static int
 man_alt_pre(MAN_ARGS)
 {
-       const struct man_node   *nn;
+       const struct roff_node  *nn;
        int              i, savelit;
        enum htmltag     fp;
        struct tag      *t;
@@ -454,7 +427,6 @@ man_alt_pre(MAN_ARGS)
                        break;
                default:
                        abort();
-                       /* NOTREACHED */
                }
 
                if (i)
@@ -472,7 +444,7 @@ man_alt_pre(MAN_ARGS)
        if (savelit)
                mh->fl |= MANH_LITERAL;
 
-       return(0);
+       return 0;
 }
 
 static int
@@ -482,7 +454,7 @@ man_SM_pre(MAN_ARGS)
        print_otag(h, TAG_SMALL, 0, NULL);
        if (MAN_SB == n->tok)
                print_otag(h, TAG_B, 0, NULL);
-       return(1);
+       return 1;
 }
 
 static int
@@ -490,41 +462,41 @@ man_SS_pre(MAN_ARGS)
 {
        struct htmlpair  tag;
 
-       if (MAN_BLOCK == n->type) {
+       if (n->type == ROFFT_BLOCK) {
                mh->fl &= ~MANH_LITERAL;
                PAIR_CLASS_INIT(&tag, "subsection");
                print_otag(h, TAG_DIV, 1, &tag);
-               return(1);
-       } else if (MAN_BODY == n->type)
-               return(1);
+               return 1;
+       } else if (n->type == ROFFT_BODY)
+               return 1;
 
        print_otag(h, TAG_H2, 0, NULL);
-       return(1);
+       return 1;
 }
 
 static int
 man_PP_pre(MAN_ARGS)
 {
 
-       if (MAN_HEAD == n->type)
-               return(0);
-       else if (MAN_BLOCK == n->type)
+       if (n->type == ROFFT_HEAD)
+               return 0;
+       else if (n->type == ROFFT_BLOCK)
                print_bvspace(h, n);
 
-       return(1);
+       return 1;
 }
 
 static int
 man_IP_pre(MAN_ARGS)
 {
-       const struct man_node   *nn;
+       const struct roff_node  *nn;
 
-       if (MAN_BODY == n->type) {
+       if (n->type == ROFFT_BODY) {
                print_otag(h, TAG_DD, 0, NULL);
-               return(1);
-       } else if (MAN_HEAD != n->type) {
+               return 1;
+       } else if (n->type != ROFFT_HEAD) {
                print_otag(h, TAG_DL, 0, NULL);
-               return(1);
+               return 1;
        }
 
        /* FIXME: width specification. */
@@ -548,20 +520,20 @@ man_IP_pre(MAN_ARGS)
                }
        }
 
-       return(0);
+       return 0;
 }
 
 static int
 man_HP_pre(MAN_ARGS)
 {
-       struct htmlpair  tag;
+       struct htmlpair  tag[2];
        struct roffsu    su;
-       const struct man_node *np;
+       const struct roff_node *np;
 
-       if (MAN_HEAD == n->type)
-               return(0);
-       else if (MAN_BLOCK != n->type)
-               return(1);
+       if (n->type == ROFFT_HEAD)
+               return 0;
+       else if (n->type != ROFFT_BLOCK)
+               return 1;
 
        np = n->head->child;
 
@@ -574,9 +546,10 @@ man_HP_pre(MAN_ARGS)
        bufcat_su(h, "margin-left", &su);
        su.scale = -su.scale;
        bufcat_su(h, "text-indent", &su);
-       PAIR_STYLE_INIT(&tag, h);
-       print_otag(h, TAG_P, 1, &tag);
-       return(1);
+       PAIR_STYLE_INIT(&tag[0], h);
+       PAIR_CLASS_INIT(&tag[1], "spacer");
+       print_otag(h, TAG_DIV, 2, tag);
+       return 1;
 }
 
 static int
@@ -605,7 +578,7 @@ man_OP_pre(MAN_ARGS)
        print_stagq(h, tt);
        h->flags |= HTML_NOSPACE;
        print_text(h, "]");
-       return(0);
+       return 0;
 }
 
 static int
@@ -613,7 +586,7 @@ man_B_pre(MAN_ARGS)
 {
 
        print_otag(h, TAG_B, 0, NULL);
-       return(1);
+       return 1;
 }
 
 static int
@@ -621,7 +594,7 @@ man_I_pre(MAN_ARGS)
 {
 
        print_otag(h, TAG_I, 0, NULL);
-       return(1);
+       return 1;
 }
 
 static int
@@ -634,7 +607,7 @@ man_literal_pre(MAN_ARGS)
        } else
                mh->fl |= MANH_LITERAL;
 
-       return(0);
+       return 0;
 }
 
 static int
@@ -642,14 +615,14 @@ man_in_pre(MAN_ARGS)
 {
 
        print_otag(h, TAG_BR, 0, NULL);
-       return(0);
+       return 0;
 }
 
 static int
 man_ign_pre(MAN_ARGS)
 {
 
-       return(0);
+       return 0;
 }
 
 static int
@@ -658,10 +631,10 @@ man_RS_pre(MAN_ARGS)
        struct htmlpair  tag;
        struct roffsu    su;
 
-       if (MAN_HEAD == n->type)
-               return(0);
-       else if (MAN_BODY == n->type)
-               return(1);
+       if (n->type == ROFFT_HEAD)
+               return 0;
+       else if (n->type == ROFFT_BODY)
+               return 1;
 
        SCALE_HS_INIT(&su, INDENT);
        if (n->head->child)
@@ -671,7 +644,7 @@ man_RS_pre(MAN_ARGS)
        bufcat_su(h, "margin-left", &su);
        PAIR_STYLE_INIT(&tag, h);
        print_otag(h, TAG_DIV, 1, &tag);
-       return(1);
+       return 1;
 }
 
 static int
@@ -680,19 +653,19 @@ man_UR_pre(MAN_ARGS)
        struct htmlpair          tag[2];
 
        n = n->child;
-       assert(MAN_HEAD == n->type);
-       if (n->nchild) {
-               assert(MAN_TEXT == n->child->type);
+       assert(n->type == ROFFT_HEAD);
+       if (n->child != NULL) {
+               assert(n->child->type == ROFFT_TEXT);
                PAIR_CLASS_INIT(&tag[0], "link-ext");
                PAIR_HREF_INIT(&tag[1], n->child->string);
                print_otag(h, TAG_A, 2, tag);
        }
 
-       assert(MAN_BODY == n->next->type);
-       if (n->next->nchild)
+       assert(n->next->type == ROFFT_BODY);
+       if (n->next->child != NULL)
                n = n->next;
 
        print_man_nodelist(man, n->child, mh, h);
 
-       return(0);
+       return 0;
 }