more bits for 1.14.2

[mandoc.git] / man_html.c

diff --git a/man_html.c b/man_html.c
index cb3040e211da3998dc13ed6583124919739c979a..a304b3e4d240bf67a2902f3cab892e73f7d0c000 100644 (file)
--- a/man_html.c
+++ b/man_html.c
@@ -1,4 +1,4 @@
-/*     $Id: man_html.c,v 1.124 2017/01/18 19:22:22 schwarze Exp $ */
+/*     $Id: man_html.c,v 1.145 2017/06/25 11:42:02 schwarze Exp $ */

 /*
  * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2013, 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
 /*
  * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2013, 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>


@@ -26,27 +26,21 @@
 #include <string.h>
 
 #include "mandoc_aux.h"
 #include <string.h>
 
 #include "mandoc_aux.h"

+#include "mandoc.h"

 #include "roff.h"
 #include "man.h"
 #include "out.h"
 #include "html.h"
 #include "main.h"
 
 #include "roff.h"
 #include "man.h"
 #include "out.h"
 #include "html.h"
 #include "main.h"
 

-/* TODO: preserve ident widths. */

 /* FIXME: have PD set the default vspace width. */
 
 #define        INDENT            5
 
 #define        MAN_ARGS          const struct roff_meta *man, \
                          const struct roff_node *n, \
 /* FIXME: have PD set the default vspace width. */
 
 #define        INDENT            5
 
 #define        MAN_ARGS          const struct roff_meta *man, \
                          const struct roff_node *n, \

-                         struct mhtml *mh, \

                          struct html *h
 
                          struct html *h
 

-struct mhtml {
-       int               fl;
-#define        MANH_LITERAL     (1 << 0) /* literal context */
-};
-

 struct htmlman {
        int             (*pre)(MAN_ARGS);
        int             (*post)(MAN_ARGS);
 struct htmlman {
        int             (*pre)(MAN_ARGS);
        int             (*post)(MAN_ARGS);


@@ -57,6 +51,7 @@ static        void              print_bvspace(struct html *,
 static void              print_man_head(MAN_ARGS);
 static void              print_man_nodelist(MAN_ARGS);
 static void              print_man_node(MAN_ARGS);
 static void              print_man_head(MAN_ARGS);
 static void              print_man_nodelist(MAN_ARGS);
 static void              print_man_node(MAN_ARGS);

+static int               fillmode(struct html *, int);

 static int               a2width(const struct roff_node *,
                                struct roffsu *);
 static int               man_B_pre(MAN_ARGS);
 static int               a2width(const struct roff_node *,
                                struct roffsu *);
 static int               man_B_pre(MAN_ARGS);


@@ -71,15 +66,12 @@ static      int               man_SM_pre(MAN_ARGS);
 static int               man_SS_pre(MAN_ARGS);
 static int               man_UR_pre(MAN_ARGS);
 static int               man_alt_pre(MAN_ARGS);
 static int               man_SS_pre(MAN_ARGS);
 static int               man_UR_pre(MAN_ARGS);
 static int               man_alt_pre(MAN_ARGS);

-static int               man_br_pre(MAN_ARGS);

 static int               man_ign_pre(MAN_ARGS);
 static int               man_in_pre(MAN_ARGS);
 static int               man_ign_pre(MAN_ARGS);
 static int               man_in_pre(MAN_ARGS);

-static int               man_literal_pre(MAN_ARGS);

 static void              man_root_post(MAN_ARGS);
 static void              man_root_pre(MAN_ARGS);
 
 static void              man_root_post(MAN_ARGS);
 static void              man_root_pre(MAN_ARGS);
 

-static const struct htmlman mans[MAN_MAX] = {
-       { man_br_pre, NULL }, /* br */
+static const struct htmlman __mans[MAN_MAX - MAN_TH] = {

        { NULL, NULL }, /* TH */
        { man_SH_pre, NULL }, /* SH */
        { man_SS_pre, NULL }, /* SS */
        { NULL, NULL }, /* TH */
        { man_SH_pre, NULL }, /* SH */
        { man_SS_pre, NULL }, /* SS */


@@ -100,9 +92,8 @@ static       const struct htmlman mans[MAN_MAX] = {
        { man_I_pre, NULL }, /* I */
        { man_alt_pre, NULL }, /* IR */
        { man_alt_pre, NULL }, /* RI */
        { man_I_pre, NULL }, /* I */
        { man_alt_pre, NULL }, /* IR */
        { man_alt_pre, NULL }, /* RI */

-       { man_br_pre, NULL }, /* sp */
-       { man_literal_pre, NULL }, /* nf */
-       { man_literal_pre, NULL }, /* fi */
+       { NULL, NULL }, /* nf */
+       { NULL, NULL }, /* fi */

        { NULL, NULL }, /* RE */
        { man_RS_pre, NULL }, /* RS */
        { man_ign_pre, NULL }, /* DT */
        { NULL, NULL }, /* RE */
        { man_RS_pre, NULL }, /* RS */
        { man_ign_pre, NULL }, /* DT */


@@ -110,14 +101,15 @@ static    const struct htmlman mans[MAN_MAX] = {
        { man_ign_pre, NULL }, /* PD */
        { man_ign_pre, NULL }, /* AT */
        { man_in_pre, NULL }, /* in */
        { man_ign_pre, NULL }, /* PD */
        { man_ign_pre, NULL }, /* AT */
        { man_in_pre, NULL }, /* in */

-       { man_ign_pre, NULL }, /* ft */

        { man_OP_pre, NULL }, /* OP */
        { man_OP_pre, NULL }, /* OP */

-       { man_literal_pre, NULL }, /* EX */
-       { man_literal_pre, NULL }, /* EE */
+       { NULL, NULL }, /* EX */
+       { NULL, NULL }, /* EE */

        { man_UR_pre, NULL }, /* UR */
        { NULL, NULL }, /* UE */
        { man_UR_pre, NULL }, /* UR */
        { NULL, NULL }, /* UE */

-       { man_ign_pre, NULL }, /* ll */
+       { man_UR_pre, NULL }, /* MT */
+       { NULL, NULL }, /* ME */

 };
 };

+static const struct htmlman *const mans = __mans - MAN_TH;

 
 
 /*
 
 
 /*


@@ -146,26 +138,26 @@ print_bvspace(struct html *h, const struct roff_node *n)
 void
 html_man(void *arg, const struct roff_man *man)
 {
 void
 html_man(void *arg, const struct roff_man *man)
 {

-       struct mhtml     mh;

        struct html     *h;
        struct html     *h;

-       struct tag      *t, *tt;
+       struct tag      *t;

 
 

-       memset(&mh, 0, sizeof(mh));

        h = (struct html *)arg;
 
        h = (struct html *)arg;
 

-       if ( ! (HTML_FRAGMENT & h->oflags)) {
+       if ((h->oflags & HTML_FRAGMENT) == 0) {

                print_gen_decls(h);
                print_gen_decls(h);

-               t = print_otag(h, TAG_HTML, "");
-               tt = print_otag(h, TAG_HEAD, "");
-               print_man_head(&man->meta, man->first, &mh, h);
-               print_tagq(h, tt);
+               print_otag(h, TAG_HTML, "");
+               t = print_otag(h, TAG_HEAD, "");
+               print_man_head(&man->meta, man->first, h);
+               print_tagq(h, t);

                print_otag(h, TAG_BODY, "");
                print_otag(h, TAG_BODY, "");

-               print_otag(h, TAG_DIV, "c", "mandoc");
-       } else
-               t = print_otag(h, TAG_DIV, "c", "mandoc");
+       }

 
 

-       print_man_nodelist(&man->meta, man->first, &mh, h);
+       man_root_pre(&man->meta, man->first, h);
+       t = print_otag(h, TAG_DIV, "c", "manual-text");
+       print_man_nodelist(&man->meta, man->first->child, h);

        print_tagq(h, t);
        print_tagq(h, t);

+       man_root_post(&man->meta, man->first, h);
+       print_tagq(h, NULL);

 }
 
 static void
 }
 
 static void


@@ -185,7 +177,7 @@ print_man_nodelist(MAN_ARGS)
 {
 
        while (n != NULL) {
 {
 
        while (n != NULL) {

-               print_man_node(man, n, mh, h);
+               print_man_node(man, n, h);

                n = n->next;
        }
 }
                n = n->next;
        }
 }


@@ -193,30 +185,97 @@ print_man_nodelist(MAN_ARGS)
 static void
 print_man_node(MAN_ARGS)
 {
 static void
 print_man_node(MAN_ARGS)
 {

-       int              child;
+       static int       want_fillmode = MAN_fi;
+       static int       save_fillmode;
+

        struct tag      *t;
        struct tag      *t;

+       int              child;

 
 

-       child = 1;
-       t = h->tags.head;
+       /*
+        * Handle fill mode switch requests up front,
+        * they would just cause trouble in the subsequent code.
+        */
+
+       switch (n->tok) {
+       case MAN_nf:
+       case MAN_EX:
+               want_fillmode = MAN_nf;
+               return;
+       case MAN_fi:
+       case MAN_EE:
+               want_fillmode = MAN_fi;
+               if (fillmode(h, 0) == MAN_fi)
+                       print_otag(h, TAG_BR, "");
+               return;
+       default:
+               break;
+       }
+
+       /* Set up fill mode for the upcoming node. */

 
        switch (n->type) {
 
        switch (n->type) {

-       case ROFFT_ROOT:
-               man_root_pre(man, n, mh, h);
+       case ROFFT_BLOCK:
+               save_fillmode = 0;
+               /* Some block macros suspend or cancel .nf. */
+               switch (n->tok) {
+               case MAN_TP:  /* Tagged paragraphs              */
+               case MAN_IP:  /* temporarily disable .nf        */
+               case MAN_HP:  /* for the head.                  */
+                       save_fillmode = want_fillmode;
+                       /* FALLTHROUGH */
+               case MAN_SH:  /* Section headers                */
+               case MAN_SS:  /* permanently cancel .nf.        */
+                       want_fillmode = MAN_fi;
+                       /* FALLTHROUGH */
+               case MAN_PP:  /* These have no head.            */
+               case MAN_LP:  /* They will simply               */
+               case MAN_P:   /* reopen .nf in the body.        */
+               case MAN_RS:
+               case MAN_UR:
+               case MAN_MT:
+                       fillmode(h, MAN_fi);
+                       break;
+               default:
+                       break;
+               }
+               break;
+       case ROFFT_TBL:
+               fillmode(h, MAN_fi);
+               break;
+       case ROFFT_ELEM:
+               /*
+                * Some in-line macros produce tags and/or text
+                * in the handler, so they require fill mode to be
+                * configured up front just like for text nodes.
+                * For the others, keep the traditional approach
+                * of doing the same, for now.
+                */
+               fillmode(h, want_fillmode);

                break;
        case ROFFT_TEXT:
                break;
        case ROFFT_TEXT:

-               if ('\0' == *n->string) {
-                       print_paragraph(h);
-                       return;
-               }
-               if (n->flags & NODE_LINE && (*n->string == ' ' ||
-                   (n->prev != NULL && mh->fl & MANH_LITERAL &&
-                    ! (h->flags & HTML_NONEWLINE))))
+               if (fillmode(h, want_fillmode) == MAN_fi &&
+                   want_fillmode == MAN_fi &&
+                   n->flags & NODE_LINE && *n->string == ' ' &&
+                   (h->flags & HTML_NONEWLINE) == 0)

                        print_otag(h, TAG_BR, "");
                        print_otag(h, TAG_BR, "");

-               print_text(h, n->string);
+               if (*n->string != '\0')
+                       break;
+               print_paragraph(h);

                return;
                return;

+       default:
+               break;
+       }
+
+       /* Produce output for this node. */
+
+       child = 1;
+       switch (n->type) {
+       case ROFFT_TEXT:
+               t = h->tag;
+               print_text(h, n->string);
+               break;

        case ROFFT_EQN:
        case ROFFT_EQN:

-               if (n->flags & NODE_LINE)
-                       putchar('\n');
+               t = h->tag;

                print_eqn(h, n->eqn);
                break;
        case ROFFT_TBL:
                print_eqn(h, n->eqn);
                break;
        case ROFFT_TBL:


@@ -242,44 +301,70 @@ print_man_node(MAN_ARGS)
                 * the "meta" table state.  This will be reopened on the
                 * next table element.
                 */
                 * the "meta" table state.  This will be reopened on the
                 * next table element.
                 */

-               if (h->tblt) {
+               if (h->tblt)

                        print_tblclose(h);
                        print_tblclose(h);

-                       t = h->tags.head;
+
+               t = h->tag;
+               if (n->tok < ROFF_MAX) {
+                       roff_html_pre(h, n);
+                       child = 0;
+                       break;

                }
                }

+
+               assert(n->tok >= MAN_TH && n->tok < MAN_MAX);

                if (mans[n->tok].pre)
                if (mans[n->tok].pre)

-                       child = (*mans[n->tok].pre)(man, n, mh, h);
+                       child = (*mans[n->tok].pre)(man, n, h);
+
+               /* Some block macros resume .nf in the body. */
+               if (save_fillmode && n->type == ROFFT_BODY)
+                       want_fillmode = save_fillmode;
+

                break;
        }
 
        if (child && n->child)
                break;
        }
 
        if (child && n->child)

-               print_man_nodelist(man, n->child, mh, h);
+               print_man_nodelist(man, n->child, h);

 
        /* This will automatically close out any font scope. */
        print_stagq(h, t);
 
 
        /* This will automatically close out any font scope. */
        print_stagq(h, t);
 

-       switch (n->type) {
-       case ROFFT_ROOT:
-               man_root_post(man, n, mh, h);
-               break;
-       case ROFFT_EQN:
-               break;
-       default:
-               if (mans[n->tok].post)
-                       (*mans[n->tok].post)(man, n, mh, h);
-               break;
+       if (fillmode(h, 0) == MAN_nf &&
+           n->next != NULL && n->next->flags & NODE_LINE)
+               print_endline(h);
+}
+
+/*
+ * MAN_nf switches to no-fill mode, MAN_fi to fill mode.
+ * Other arguments do not switch.
+ * The old mode is returned.
+ */
+static int
+fillmode(struct html *h, int want)
+{
+       struct tag      *pre;
+       int              had;
+
+       for (pre = h->tag; pre != NULL; pre = pre->next)
+               if (pre->tag == TAG_PRE)
+                       break;
+
+       had = pre == NULL ? MAN_fi : MAN_nf;
+
+       if (want && want != had) {
+               if (want == MAN_nf)
+                       print_otag(h, TAG_PRE, "");
+               else
+                       print_tagq(h, pre);

        }
        }

+       return had;

 }
 
 static int
 a2width(const struct roff_node *n, struct roffsu *su)
 {
 }
 
 static int
 a2width(const struct roff_node *n, struct roffsu *su)
 {

-

        if (n->type != ROFFT_TEXT)
                return 0;
        if (n->type != ROFFT_TEXT)
                return 0;

-       if (a2roffsu(n->string, su, SCALE_EN))
-               return 1;
-
-       return 0;
+       return a2roffsu(n->string, su, SCALE_EN) != NULL;

 }
 
 static void
 }
 
 static void


@@ -293,7 +378,6 @@ man_root_pre(MAN_ARGS)
        mandoc_asprintf(&title, "%s(%s)", man->title, man->msec);
 
        t = print_otag(h, TAG_TABLE, "c", "head");
        mandoc_asprintf(&title, "%s(%s)", man->title, man->msec);
 
        t = print_otag(h, TAG_TABLE, "c", "head");

-       print_otag(h, TAG_TBODY, "");

        tt = print_otag(h, TAG_TR, "");
 
        print_otag(h, TAG_TD, "c", "head-ltitle");
        tt = print_otag(h, TAG_TR, "");
 
        print_otag(h, TAG_TD, "c", "head-ltitle");


@@ -329,40 +413,18 @@ man_root_post(MAN_ARGS)
        print_tagq(h, t);
 }
 
        print_tagq(h, t);
 }
 

-
-static int
-man_br_pre(MAN_ARGS)
-{
-       struct roffsu    su;
-
-       SCALE_VS_INIT(&su, 1);
-
-       if (MAN_sp == n->tok) {
-               if (NULL != (n = n->child))
-                       if ( ! a2roffsu(n->string, &su, SCALE_VS))
-                               su.scale = 1.0;
-       } else
-               su.scale = 0.0;
-
-       print_otag(h, TAG_DIV, "suh", &su);
-
-       /* So the div isn't empty: */
-       print_text(h, "\\~");
-
-       return 0;
-}
-

 static int
 man_SH_pre(MAN_ARGS)
 {
 static int
 man_SH_pre(MAN_ARGS)
 {

-       if (n->type == ROFFT_BLOCK) {
-               mh->fl &= ~MANH_LITERAL;
-               print_otag(h, TAG_DIV, "c", "section");
-               return 1;
-       } else if (n->type == ROFFT_BODY)
-               return 1;
-
-       print_otag(h, TAG_H1, "");
+       char    *id;
+
+       if (n->type == ROFFT_HEAD) {
+               id = html_make_id(n);
+               print_otag(h, TAG_H1, "cTi", "Sh", id);
+               if (id != NULL)
+                       print_otag(h, TAG_A, "chR", "selflink", id);
+               free(id);
+       }

        return 1;
 }
 
        return 1;
 }
 


@@ -370,17 +432,11 @@ static int
 man_alt_pre(MAN_ARGS)
 {
        const struct roff_node  *nn;
 man_alt_pre(MAN_ARGS)
 {
        const struct roff_node  *nn;

-       int              i, savelit;
+       int              i;

        enum htmltag     fp;
        struct tag      *t;
 
        enum htmltag     fp;
        struct tag      *t;
 

-       if ((savelit = mh->fl & MANH_LITERAL))
-               print_otag(h, TAG_BR, "");
-
-       mh->fl &= ~MANH_LITERAL;
-

        for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
        for (i = 0, nn = n->child; nn; nn = nn->next, i++) {

-               t = NULL;

                switch (n->tok) {
                case MAN_BI:
                        fp = i % 2 ? TAG_I : TAG_B;
                switch (n->tok) {
                case MAN_BI:
                        fp = i % 2 ? TAG_I : TAG_B;


@@ -407,18 +463,14 @@ man_alt_pre(MAN_ARGS)
                if (i)
                        h->flags |= HTML_NOSPACE;
 
                if (i)
                        h->flags |= HTML_NOSPACE;
 

-               if (TAG_MAX != fp)
+               if (fp != TAG_MAX)

                        t = print_otag(h, fp, "");
 
                        t = print_otag(h, fp, "");
 

-               print_man_node(man, nn, mh, h);
+               print_text(h, nn->string);

 
 

-               if (t)
+               if (fp != TAG_MAX)

                        print_tagq(h, t);
        }
                        print_tagq(h, t);
        }

-
-       if (savelit)
-               mh->fl |= MANH_LITERAL;
-

        return 0;
 }
 
        return 0;
 }
 


@@ -434,14 +486,15 @@ man_SM_pre(MAN_ARGS)
 static int
 man_SS_pre(MAN_ARGS)
 {
 static int
 man_SS_pre(MAN_ARGS)
 {

-       if (n->type == ROFFT_BLOCK) {
-               mh->fl &= ~MANH_LITERAL;
-               print_otag(h, TAG_DIV, "c", "subsection");
-               return 1;
-       } else if (n->type == ROFFT_BODY)
-               return 1;
-
-       print_otag(h, TAG_H2, "");
+       char    *id;
+
+       if (n->type == ROFFT_HEAD) {
+               id = html_make_id(n);
+               print_otag(h, TAG_H2, "cTi", "Ss", id);
+               if (id != NULL)
+                       print_otag(h, TAG_A, "chR", "selflink", id);
+               free(id);
+       }

        return 1;
 }
 
        return 1;
 }
 


@@ -463,21 +516,21 @@ man_IP_pre(MAN_ARGS)
        const struct roff_node  *nn;
 
        if (n->type == ROFFT_BODY) {
        const struct roff_node  *nn;
 
        if (n->type == ROFFT_BODY) {

-               print_otag(h, TAG_DD, "");
+               print_otag(h, TAG_DD, "c", "It-tag");

                return 1;
        } else if (n->type != ROFFT_HEAD) {
                return 1;
        } else if (n->type != ROFFT_HEAD) {

-               print_otag(h, TAG_DL, "");
+               print_otag(h, TAG_DL, "c", "Bl-tag");

                return 1;
        }
 
        /* FIXME: width specification. */
 
                return 1;
        }
 
        /* FIXME: width specification. */
 

-       print_otag(h, TAG_DT, "");
+       print_otag(h, TAG_DT, "c", "It-tag");

 
        /* For IP, only print the first header element. */
 
        if (MAN_IP == n->tok && n->child)
 
        /* For IP, only print the first header element. */
 
        if (MAN_IP == n->tok && n->child)

-               print_man_node(man, n->child, mh, h);
+               print_man_node(man, n->child, h);

 
        /* For TP, only print next-line header elements. */
 
 
        /* For TP, only print next-line header elements. */
 


@@ -486,7 +539,7 @@ man_IP_pre(MAN_ARGS)
                while (NULL != nn && 0 == (NODE_LINE & nn->flags))
                        nn = nn->next;
                while (NULL != nn) {
                while (NULL != nn && 0 == (NODE_LINE & nn->flags))
                        nn = nn->next;
                while (NULL != nn) {

-                       print_man_node(man, nn, mh, h);
+                       print_man_node(man, nn, h);

                        nn = nn->next;
                }
        }
                        nn = nn->next;
                }
        }


@@ -514,7 +567,7 @@ man_HP_pre(MAN_ARGS)
        sui.scale = -sum.scale;
 
        print_bvspace(h, n);
        sui.scale = -sum.scale;
 
        print_bvspace(h, n);

-       print_otag(h, TAG_DIV, "csului", "spacer", &sum, &sui);
+       print_otag(h, TAG_DIV, "csului", "Pp", &sum, &sui);

        return 1;
 }
 
        return 1;
 }
 


@@ -525,7 +578,7 @@ man_OP_pre(MAN_ARGS)
 
        print_text(h, "[");
        h->flags |= HTML_NOSPACE;
 
        print_text(h, "[");
        h->flags |= HTML_NOSPACE;

-       tt = print_otag(h, TAG_SPAN, "c", "opt");
+       tt = print_otag(h, TAG_SPAN, "c", "Op");

 
        if (NULL != (n = n->child)) {
                print_otag(h, TAG_B, "");
 
        if (NULL != (n = n->child)) {
                print_otag(h, TAG_B, "");


@@ -559,19 +612,6 @@ man_I_pre(MAN_ARGS)
        return 1;
 }
 
        return 1;
 }
 

-static int
-man_literal_pre(MAN_ARGS)
-{
-
-       if (MAN_fi == n->tok || MAN_EE == n->tok) {
-               print_otag(h, TAG_BR, "");
-               mh->fl &= ~MANH_LITERAL;
-       } else
-               mh->fl |= MANH_LITERAL;
-
-       return 0;
-}
-

 static int
 man_in_pre(MAN_ARGS)
 {
 static int
 man_in_pre(MAN_ARGS)
 {


@@ -607,18 +647,24 @@ man_RS_pre(MAN_ARGS)
 static int
 man_UR_pre(MAN_ARGS)
 {
 static int
 man_UR_pre(MAN_ARGS)
 {

+       char *cp;

        n = n->child;
        assert(n->type == ROFFT_HEAD);
        if (n->child != NULL) {
                assert(n->child->type == ROFFT_TEXT);
        n = n->child;
        assert(n->type == ROFFT_HEAD);
        if (n->child != NULL) {
                assert(n->child->type == ROFFT_TEXT);

-               print_otag(h, TAG_A, "ch", "link-ext", n->child->string);
+               if (n->tok == MAN_MT) {
+                       mandoc_asprintf(&cp, "mailto:%s", n->child->string);
+                       print_otag(h, TAG_A, "cTh", "Mt", cp);
+                       free(cp);
+               } else
+                       print_otag(h, TAG_A, "cTh", "Lk", n->child->string);

        }
 
        assert(n->next->type == ROFFT_BODY);
        if (n->next->child != NULL)
                n = n->next;
 
        }
 
        assert(n->next->type == ROFFT_BODY);
        if (n->next->child != NULL)
                n = n->next;
 

-       print_man_nodelist(man, n->child, mh, h);
+       print_man_nodelist(man, n->child, h);

 
        return 0;
 }
 
        return 0;
 }