]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_markdown.c
If messages are shown and output is printed without a pager, display
[mandoc.git] / mdoc_markdown.c
index 94829aa7bc24e8082f2a8d252544bf268a09de36..88e37c0b188bd1dc38f9db7c9e5a8575b4547103 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_markdown.c,v 1.8 2017/03/07 15:31:24 schwarze Exp $ */
+/*     $Id: mdoc_markdown.c,v 1.31 2019/07/01 22:56:24 schwarze Exp $ */
 /*
- * Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2017, 2018 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
@@ -19,6 +19,7 @@
 #include <assert.h>
 #include <ctype.h>
 #include <stdio.h>
+#include <stdlib.h>
 #include <string.h>
 
 #include "mandoc_aux.h"
@@ -43,10 +44,12 @@ static      void     md_rawword(const char *);
 static void     md_word(const char *);
 static void     md_named(const char *);
 static void     md_char(unsigned char);
+static void     md_uri(const char *);
 
 static int      md_cond_head(struct roff_node *);
 static int      md_cond_body(struct roff_node *);
 
+static int      md_pre_abort(struct roff_node *);
 static int      md_pre_raw(struct roff_node *);
 static int      md_pre_word(struct roff_node *);
 static int      md_pre_skip(struct roff_node *);
@@ -67,6 +70,7 @@ static        int      md_pre_Fo(struct roff_node *);
 static int      md_pre_In(struct roff_node *);
 static int      md_pre_It(struct roff_node *);
 static int      md_pre_Lk(struct roff_node *);
+static int      md_pre_Mt(struct roff_node *);
 static int      md_pre_Nd(struct roff_node *);
 static int      md_pre_Nm(struct roff_node *);
 static int      md_pre_No(struct roff_node *);
@@ -101,8 +105,7 @@ static      void     md_post_Pf(struct roff_node *);
 static void     md_post_Vt(struct roff_node *);
 static void     md_post__T(struct roff_node *);
 
-static const struct md_act md_acts[MDOC_MAX + 1] = {
-       { NULL, md_pre_Ap, NULL, NULL, NULL }, /* Ap */
+static const struct md_act md_acts[MDOC_MAX - MDOC_Dd] = {
        { NULL, NULL, NULL, NULL, NULL }, /* Dd */
        { NULL, NULL, NULL, NULL, NULL }, /* Dt */
        { NULL, NULL, NULL, NULL, NULL }, /* Os */
@@ -118,6 +121,7 @@ static      const struct md_act md_acts[MDOC_MAX + 1] = {
        { NULL, md_pre_It, md_post_It, NULL, NULL }, /* It */
        { NULL, md_pre_raw, md_post_raw, "*", "*" }, /* Ad */
        { NULL, md_pre_An, NULL, NULL, NULL }, /* An */
+       { NULL, md_pre_Ap, NULL, NULL, NULL }, /* Ap */
        { NULL, md_pre_raw, md_post_raw, "*", "*" }, /* Ar */
        { NULL, md_pre_raw, md_post_raw, "**", "**" }, /* Cd */
        { NULL, md_pre_raw, md_post_raw, "**", "**" }, /* Cm */
@@ -136,7 +140,7 @@ static      const struct md_act md_acts[MDOC_MAX + 1] = {
        { md_cond_head, md_pre_Nd, NULL, NULL, NULL }, /* Nd */
        { NULL, md_pre_Nm, md_post_Nm, "**", "**" }, /* Nm */
        { md_cond_body, md_pre_word, md_post_word, "[", "]" }, /* Op */
-       { NULL, md_pre_Fd, md_post_raw, "*", "*" }, /* Ot */
+       { NULL, md_pre_abort, NULL, NULL, NULL }, /* Ot */
        { NULL, md_pre_raw, md_post_raw, "*", "*" }, /* Pa */
        { NULL, NULL, NULL, NULL, NULL }, /* Rv */
        { NULL, NULL, NULL, NULL, NULL }, /* St */
@@ -209,9 +213,9 @@ static      const struct md_act md_acts[MDOC_MAX + 1] = {
        { NULL, md_pre_raw, md_post_raw, "*", "*" }, /* Fr */
        { NULL, NULL, NULL, NULL, NULL }, /* Ud */
        { NULL, NULL, md_post_Lb, NULL, NULL }, /* Lb */
-       { NULL, md_pre_Pp, NULL, NULL, NULL }, /* Lp */
+       { NULL, md_pre_abort, NULL, NULL, NULL }, /* Lp */
        { NULL, md_pre_Lk, NULL, NULL, NULL }, /* Lk */
-       { NULL, md_pre_raw, md_post_raw, "<", ">" }, /* Mt */
+       { NULL, md_pre_Mt, NULL, NULL, NULL }, /* Mt */
        { md_cond_body, md_pre_word, md_post_word, "{", "}" }, /* Brq */
        { md_cond_body, md_pre_word, md_post_word, "{", "}" }, /* Bro */
        { NULL, NULL, NULL, NULL, NULL }, /* Brc */
@@ -220,13 +224,10 @@ static    const struct md_act md_acts[MDOC_MAX + 1] = {
        { md_cond_body, md_pre_En, md_post_En, NULL, NULL }, /* En */
        { NULL, NULL, NULL, NULL, NULL }, /* Dx */
        { NULL, NULL, md_post_pc, NULL, NULL }, /* %Q */
-       { NULL, md_pre_br, NULL, NULL, NULL }, /* br */
-       { NULL, md_pre_Pp, NULL, NULL, NULL }, /* sp */
        { NULL, md_pre_Lk, md_post_pc, NULL, NULL }, /* %U */
        { NULL, NULL, NULL, NULL, NULL }, /* Ta */
-       { NULL, NULL, NULL, NULL, NULL }, /* ll */
-       { NULL, NULL, NULL, NULL, NULL }, /* ROOT */
 };
+static const struct md_act *md_act(enum roff_tok);
 
 static int      outflags;
 #define        MD_spc           (1 << 0)  /* Blank character before next word. */
@@ -244,7 +245,6 @@ static      int      escflags; /* Escape in generated markdown code: */
 #define        ESC_BOL  (1 << 0)  /* "#*+-" near the beginning of a line. */
 #define        ESC_NUM  (1 << 1)  /* "." after a leading number. */
 #define        ESC_HYP  (1 << 2)  /* "(" immediately after "]". */
-#define        ESC_PAR  (1 << 3)  /* ")" when "(" is open. */
 #define        ESC_SQU  (1 << 4)  /* "]" when "[" is open. */
 #define        ESC_FON  (1 << 5)  /* "*" immediately after unrelated "*". */
 #define        ESC_EOL  (1 << 6)  /* " " at the and of a line. */
@@ -252,22 +252,30 @@ static    int      escflags; /* Escape in generated markdown code: */
 static int      code_blocks, quote_blocks, list_blocks;
 static int      outcount;
 
+
+static const struct md_act *
+md_act(enum roff_tok tok)
+{
+       assert(tok >= MDOC_Dd && tok <= MDOC_MAX);
+       return md_acts + (tok - MDOC_Dd);
+}
+
 void
-markdown_mdoc(void *arg, const struct roff_man *mdoc)
+markdown_mdoc(void *arg, const struct roff_meta *mdoc)
 {
        outflags = MD_Sm;
-       md_word(mdoc->meta.title);
-       if (mdoc->meta.msec != NULL) {
+       md_word(mdoc->title);
+       if (mdoc->msec != NULL) {
                outflags &= ~MD_spc;
                md_word("(");
-               md_word(mdoc->meta.msec);
+               md_word(mdoc->msec);
                md_word(")");
        }
        md_word("-");
-       md_word(mdoc->meta.vol);
-       if (mdoc->meta.arch != NULL) {
+       md_word(mdoc->vol);
+       if (mdoc->arch != NULL) {
                md_word("(");
-               md_word(mdoc->meta.arch);
+               md_word(mdoc->arch);
                md_word(")");
        }
        outflags |= MD_sp;
@@ -275,9 +283,9 @@ markdown_mdoc(void *arg, const struct roff_man *mdoc)
        md_nodelist(mdoc->first->child);
 
        outflags |= MD_sp;
-       md_word(mdoc->meta.os);
+       md_word(mdoc->os);
        md_word("-");
-       md_word(mdoc->meta.date);
+       md_word(mdoc->date);
        putchar('\n');
 }
 
@@ -296,7 +304,7 @@ md_node(struct roff_node *n)
        const struct md_act     *act;
        int                      cond, process_children;
 
-       if (n->flags & NODE_NOPRT)
+       if (n->type == ROFFT_COMMENT || n->flags & NODE_NOPRT)
                return;
 
        if (outflags & MD_nonl)
@@ -309,8 +317,7 @@ md_node(struct roff_node *n)
        process_children = 1;
        n->flags &= ~NODE_ENDED;
 
-       switch (n->type) {
-       case ROFFT_TEXT:
+       if (n->type == ROFFT_TEXT) {
                if (n->flags & NODE_DELIMC)
                        outflags &= ~(MD_spc | MD_spc_force);
                else if (outflags & MD_Sm)
@@ -320,14 +327,24 @@ md_node(struct roff_node *n)
                        outflags &= ~(MD_spc | MD_spc_force);
                else if (outflags & MD_Sm)
                        outflags |= MD_spc;
-               break;
-       default:
-               act = md_acts + n->tok;
+       } else if (n->tok < ROFF_MAX) {
+               switch (n->tok) {
+               case ROFF_br:
+                       process_children = md_pre_br(n);
+                       break;
+               case ROFF_sp:
+                       process_children = md_pre_Pp(n);
+                       break;
+               default:
+                       process_children = 0;
+                       break;
+               }
+       } else {
+               act = md_act(n->tok);
                cond = act->cond == NULL || (*act->cond)(n);
                if (cond && act->pre != NULL &&
                    (n->end == ENDBODY_NOT || n->child != NULL))
                        process_children = (*act->pre)(n);
-               break;
        }
 
        if (process_children && n->child != NULL)
@@ -375,6 +392,8 @@ md_stack(char c)
 static void
 md_preword(void)
 {
+       const char      *cp;
+
        /*
         * If a list block is nested inside a code block or a blockquote,
         * blank lines for paragraph breaks no longer work; instead,
@@ -405,7 +424,11 @@ md_preword(void)
 
        if (outflags & (MD_nl | MD_br | MD_sp)) {
                putchar('\n');
-               fputs(md_stack('\0'), stdout);
+               for (cp = md_stack('\0'); *cp != '\0'; cp++) {
+                       putchar(*cp);
+                       if (*cp == '>')
+                               putchar(' ');
+               }
                outflags &= ~(MD_nl | MD_br | MD_sp);
                escflags = ESC_BOL;
                outcount = 0;
@@ -449,12 +472,6 @@ md_rawword(const char *s)
 
        while (*s != '\0') {
                switch(*s) {
-               case '(':
-                       escflags |= ESC_PAR;
-                       break;
-               case ')':
-                       escflags |= ~ESC_PAR;
-                       break;
                case '*':
                        if (s[1] == '\0')
                                escflags |= ESC_FON;
@@ -485,7 +502,7 @@ md_word(const char *s)
 {
        const char      *seq, *prevfont, *currfont, *nextfont;
        char             c;
-       int              bs, sz, uc;
+       int              bs, sz, uc, breakline;
 
        /* No spacing before closing delimiters. */
        if (s[0] != '\0' && s[1] == '\0' &&
@@ -502,6 +519,7 @@ md_word(const char *s)
        if ((s[0] == '(' || s[0] == '[') && s[1] == '\0')
                outflags &= ~MD_spc;
 
+       breakline = 0;
        prevfont = currfont = "";
        while ((c = *s++) != '\0') {
                bs = 0;
@@ -529,7 +547,7 @@ md_word(const char *s)
                        bs = escflags & ESC_HYP && !code_blocks;
                        break;
                case ')':
-                       bs = escflags & ESC_PAR && !code_blocks;
+                       bs = escflags & ESC_NUM && !code_blocks;
                        break;
                case '*':
                case '[':
@@ -571,6 +589,12 @@ md_word(const char *s)
                        case ESCAPE_SPECIAL:
                                uc = mchars_spec2cp(seq, sz);
                                break;
+                       case ESCAPE_UNDEF:
+                               uc = *seq;
+                               break;
+                       case ESCAPE_DEVICE:
+                               md_rawword("markdown");
+                               continue;
                        case ESCAPE_FONTBOLD:
                                nextfont = "**";
                                break;
@@ -581,12 +605,16 @@ md_word(const char *s)
                                nextfont = "***";
                                break;
                        case ESCAPE_FONT:
+                       case ESCAPE_FONTCW:
                        case ESCAPE_FONTROMAN:
                                nextfont = "";
                                break;
                        case ESCAPE_FONTPREV:
                                nextfont = prevfont;
                                break;
+                       case ESCAPE_BREAK:
+                               breakline = 1;
+                               break;
                        case ESCAPE_NOSPACE:
                        case ESCAPE_SKIPCHAR:
                        case ESCAPE_OVERSTRIKE:
@@ -634,6 +662,13 @@ md_word(const char *s)
                if (bs)
                        putchar('\\');
                md_char(c);
+               if (breakline &&
+                   (*s == '\0' || *s == ' ' || *s == ASCII_NBRSP)) {
+                       printf("  \n");
+                       breakline = 0;
+                       while (*s == ' ' || *s == ASCII_NBRSP)
+                               s++;
+               }
        }
        if (*currfont != '\0') {
                outflags &= ~MD_spc;
@@ -692,14 +727,22 @@ md_cond_body(struct roff_node *n)
        return n->type == ROFFT_BODY;
 }
 
+static int
+md_pre_abort(struct roff_node *n)
+{
+       abort();
+}
+
 static int
 md_pre_raw(struct roff_node *n)
 {
        const char      *prefix;
 
-       if ((prefix = md_acts[n->tok].prefix) != NULL) {
+       if ((prefix = md_act(n->tok)->prefix) != NULL) {
                md_rawword(prefix);
                outflags &= ~MD_spc;
+               if (*prefix == '`')
+                       code_blocks++;
        }
        return 1;
 }
@@ -709,9 +752,11 @@ md_post_raw(struct roff_node *n)
 {
        const char      *suffix;
 
-       if ((suffix = md_acts[n->tok].suffix) != NULL) {
+       if ((suffix = md_act(n->tok)->suffix) != NULL) {
                outflags &= ~(MD_spc | MD_nl);
                md_rawword(suffix);
+               if (*suffix == '`')
+                       code_blocks--;
        }
 }
 
@@ -720,7 +765,7 @@ md_pre_word(struct roff_node *n)
 {
        const char      *prefix;
 
-       if ((prefix = md_acts[n->tok].prefix) != NULL) {
+       if ((prefix = md_act(n->tok)->prefix) != NULL) {
                md_word(prefix);
                outflags &= ~MD_spc;
        }
@@ -732,7 +777,7 @@ md_post_word(struct roff_node *n)
 {
        const char      *suffix;
 
-       if ((suffix = md_acts[n->tok].suffix) != NULL) {
+       if ((suffix = md_act(n->tok)->suffix) != NULL) {
                outflags &= ~(MD_spc | MD_nl);
                md_word(suffix);
        }
@@ -1145,7 +1190,8 @@ md_pre_It(struct roff_node *n)
 
        case ROFFT_HEAD:
                bln = n->parent->parent;
-               if (bln->norm->Bl.comp == 0)
+               if (bln->norm->Bl.comp == 0 &&
+                   bln->norm->Bl.type != LIST_column)
                        outflags |= MD_sp;
                outflags |= MD_nl;
 
@@ -1171,9 +1217,14 @@ md_pre_It(struct roff_node *n)
                        break;
                case LIST_enum:
                        md_preword();
-                       printf("%d.\t", ++bln->norm->Bl.count);
+                       if (bln->norm->Bl.count < 99)
+                               bln->norm->Bl.count++;
+                       printf("%d.\t", bln->norm->Bl.count);
                        escflags &= ~ESC_FON;
                        break;
+               case LIST_column:
+                       outflags |= MD_br;
+                       return 0;
                default:
                        return 0;
                }
@@ -1239,7 +1290,7 @@ md_post_It(struct roff_node *n)
                while ((n = n->prev) != NULL && n->type != ROFFT_HEAD)
                        i++;
 
-               /* 
+               /*
                 * If a width was specified for this column,
                 * subtract what printed, and
                 * add the same spacing as in mdoc_term.c.
@@ -1270,39 +1321,81 @@ md_post_Lb(struct roff_node *n)
                outflags |= MD_br;
 }
 
+static void
+md_uri(const char *s)
+{
+       while (*s != '\0') {
+               if (strchr("%()<>", *s) != NULL) {
+                       printf("%%%2.2hhX", *s);
+                       outcount += 3;
+               } else {
+                       putchar(*s);
+                       outcount++;
+               }
+               s++;
+       }
+}
+
 static int
 md_pre_Lk(struct roff_node *n)
 {
-       const struct roff_node *link, *descr;
-       const unsigned char *s;
+       const struct roff_node *link, *descr, *punct;
 
        if ((link = n->child) == NULL)
                return 0;
 
-       if ((descr = link->next) != NULL) {
-               md_rawword("[");
-               outflags &= ~MD_spc;
-               while (descr != NULL) {
-                       md_word(descr->string);
-                       descr = descr->next;
-               }
-               outflags &= ~MD_spc;
-               md_rawword("](");
-       } else
-               md_rawword("<");
+       /* Find beginning of trailing punctuation. */
+       punct = n->last;
+       while (punct != link && punct->flags & NODE_DELIMC)
+               punct = punct->prev;
+       punct = punct->next;
+
+       /* Link text. */
+       descr = link->next;
+       if (descr == punct)
+               descr = link;  /* no text */
+       md_rawword("[");
+       outflags &= ~MD_spc;
+       do {
+               md_word(descr->string);
+               descr = descr->next;
+       } while (descr != punct);
+       outflags &= ~MD_spc;
 
-       for (s = link->string; *s != '\0'; s++) {
-               if (strchr("%)<>", *s) != NULL) {
-                       printf("%%%2.2hhX", *s);
-                       outcount += 3;
-               } else {
-                       putchar(*s);
+       /* Link target. */
+       md_rawword("](");
+       md_uri(link->string);
+       outflags &= ~MD_spc;
+       md_rawword(")");
+
+       /* Trailing punctuation. */
+       while (punct != NULL) {
+               md_word(punct->string);
+               punct = punct->next;
+       }
+       return 0;
+}
+
+static int
+md_pre_Mt(struct roff_node *n)
+{
+       const struct roff_node *nch;
+
+       md_rawword("[");
+       outflags &= ~MD_spc;
+       for (nch = n->child; nch != NULL; nch = nch->next)
+               md_word(nch->string);
+       outflags &= ~MD_spc;
+       md_rawword("](mailto:");
+       for (nch = n->child; nch != NULL; nch = nch->next) {
+               md_uri(nch->string);
+               if (nch->next != NULL) {
+                       putchar(' ');
                        outcount++;
                }
        }
-
        outflags &= ~MD_spc;
-       md_rawword(link->next == NULL ? ">" : ")");
+       md_rawword(")");
        return 0;
 }