Style message about legacy man(7) date format in mdoc(7) documents

[mandoc.git] / man_html.c

diff --git a/man_html.c b/man_html.c
index 804859f885942236c00594e0ed08ce5865747031..278f31a28f7cb7d8ba18669b9be5dc1873e8eb8c 100644 (file)
--- a/man_html.c
+++ b/man_html.c
@@ -1,4 +1,4 @@
-/*     $Id: man_html.c,v 1.130 2017/01/26 18:28:18 schwarze Exp $ */
+/*     $Id: man_html.c,v 1.143 2017/06/08 12:54:58 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>


@@ -38,13 +38,8 @@
 
 #define        MAN_ARGS          const struct roff_meta *man, \
                          const struct roff_node *n, \
 
 #define        MAN_ARGS          const struct roff_meta *man, \
                          const struct roff_node *n, \

-                         struct mhtml *mh, \

                          struct html *h
 
                          struct html *h
 

-struct mhtml {
-       struct tag       *nofill;
-};
-

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


@@ -55,6 +50,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);


@@ -69,15 +65,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_fill_pre(MAN_ARGS);

 static int               man_ign_pre(MAN_ARGS);
 static int               man_in_pre(MAN_ARGS);
 static void              man_root_post(MAN_ARGS);
 static void              man_root_pre(MAN_ARGS);
 
 static int               man_ign_pre(MAN_ARGS);
 static int               man_in_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 */


@@ -98,9 +91,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_fill_pre, NULL }, /* nf */
-       { man_fill_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 */


@@ -108,14 +100,13 @@ 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_fill_pre, NULL }, /* EX */
-       { man_fill_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 */

 };
 };

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

 
 
 /*
 
 
 /*


@@ -144,27 +135,25 @@ 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 tag      *t;
 
        struct html     *h;
        struct tag      *t;
 

-       mh.nofill = NULL;

        h = (struct html *)arg;
 
        if ((h->oflags & HTML_FRAGMENT) == 0) {
                print_gen_decls(h);
                print_otag(h, TAG_HTML, "");
                t = print_otag(h, TAG_HEAD, "");
        h = (struct html *)arg;
 
        if ((h->oflags & HTML_FRAGMENT) == 0) {
                print_gen_decls(h);
                print_otag(h, TAG_HTML, "");
                t = print_otag(h, TAG_HEAD, "");

-               print_man_head(&man->meta, man->first, &mh, h);
+               print_man_head(&man->meta, man->first, h);

                print_tagq(h, t);
                print_otag(h, TAG_BODY, "");
        }
 
                print_tagq(h, t);
                print_otag(h, TAG_BODY, "");
        }
 

-       man_root_pre(&man->meta, man->first, &mh, h);
+       man_root_pre(&man->meta, man->first, h);

        t = print_otag(h, TAG_DIV, "c", "manual-text");
        t = print_otag(h, TAG_DIV, "c", "manual-text");

-       print_man_nodelist(&man->meta, man->first->child, &mh, h);
+       print_man_nodelist(&man->meta, man->first->child, h);

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

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

        print_tagq(h, NULL);
 }
 
        print_tagq(h, NULL);
 }
 


@@ -185,7 +174,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,26 +182,96 @@ 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;
-       if (t == mh->nofill)
-               t = t->next;
+       /*
+        * 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_TEXT:
-               if ('\0' == *n->string) {
-                       print_paragraph(h);
-                       return;
+       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:
+                       fillmode(h, MAN_fi);
+                       break;
+               default:
+                       break;

                }
                }

-               if (mh->nofill == NULL &&
-                   n->flags & NODE_LINE && *n->string == ' ')
+               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:
+               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, "");

+               if (*n->string != '\0')
+                       break;
+               print_paragraph(h);
+               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:
                print_text(h, n->string);
                break;
        case ROFFT_EQN:

+               t = h->tag;

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


@@ -238,40 +297,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. */
 
        /* This will automatically close out any font scope. */

-       print_stagq(h, mh->nofill == NULL ? t : mh->nofill);
-
-       if (n->type != ROFFT_TEXT && n->type != ROFFT_EQN &&
-           mans[n->tok].post != NULL)
-               (*mans[n->tok].post)(man, n, mh, h);
+       print_stagq(h, t);

 
 

-       if (mh->nofill != NULL &&
-           (n->next == NULL || n->next->flags & NODE_LINE))
+       if (fillmode(h, 0) == MAN_nf &&
+           n->next != NULL && n->next->flags & NODE_LINE)

                print_endline(h);
 }
 
                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
 static int

-a2width(const struct roff_node *n, struct roffsu *su)
+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)
+{

        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


@@ -285,7 +374,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");


@@ -321,37 +409,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->nofill != NULL) {
-               print_tagq(h, mh->nofill);
-               mh->nofill = NULL;
-       } else if (n->type == ROFFT_HEAD)
-               print_otag(h, TAG_H1, "c", "Sh");
+       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;
 }
 


@@ -413,11 +482,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->nofill != NULL) {
-               print_tagq(h, mh->nofill);
-               mh->nofill = NULL;
-       } else if (n->type == ROFFT_HEAD)
-               print_otag(h, TAG_H2, "c", "Ss");
+       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;
 }
 


@@ -453,7 +526,7 @@ man_IP_pre(MAN_ARGS)
        /* 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. */
 


@@ -462,7 +535,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;
                }
        }


@@ -535,24 +608,6 @@ man_I_pre(MAN_ARGS)
        return 1;
 }
 
        return 1;
 }
 

-static int
-man_fill_pre(MAN_ARGS)
-{
-       if (MAN_fi == n->tok || MAN_EE == n->tok) {
-               if (mh->nofill != NULL) {
-                       print_tagq(h, mh->nofill);
-                       mh->nofill = NULL;
-               } else
-                       print_otag(h, TAG_BR, "");
-       } else {
-               if (mh->nofill == NULL)
-                       mh->nofill = print_otag(h, TAG_PRE, "");
-               else
-                       print_otag(h, TAG_BR, "");
-       }
-       return 0;
-}
-

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


@@ -592,14 +647,14 @@ man_UR_pre(MAN_ARGS)
        assert(n->type == ROFFT_HEAD);
        if (n->child != NULL) {
                assert(n->child->type == ROFFT_TEXT);
        assert(n->type == ROFFT_HEAD);
        if (n->child != NULL) {
                assert(n->child->type == ROFFT_TEXT);

-               print_otag(h, TAG_A, "ch", "Lk", n->child->string);
+               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;
 }