Make it more explicit that the statement "-O tag does not work with less(1)"

[mandoc.git] / mdoc_markdown.c

diff --git a/mdoc_markdown.c b/mdoc_markdown.c
index e73440a4e5cd5b757125c647412bd6dd1e2db998..1d80ccf7f85b5e3c174d65ef6f8f427ef2bab9de 100644 (file)
--- a/mdoc_markdown.c
+++ b/mdoc_markdown.c
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_markdown.c,v 1.24 2018/04/11 17:11:13 schwarze Exp $ */
+/* $Id: mdoc_markdown.c,v 1.36 2020/06/22 19:20:40 schwarze Exp $ */
 /*
- * Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2017, 2018, 2020 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
@@ -13,12 +13,17 @@
  * 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.
+ *
+ * Markdown formatter for mdoc(7) used by mandoc(1).
  */
+#include "config.h"
+
 #include <sys/types.h>
 
 #include <assert.h>
 #include <ctype.h>
 #include <stdio.h>
+#include <stdlib.h>
 #include <string.h>
 
 #include "mandoc_aux.h"
@@ -28,16 +33,16 @@
 #include "main.h"
 
 struct md_act {
-       int             (*cond)(struct roff_node *n);
-       int             (*pre)(struct roff_node *n);
-       void            (*post)(struct roff_node *n);
+       int             (*cond)(struct roff_node *);
+       int             (*pre)(struct roff_node *);
+       void            (*post)(struct roff_node *);
        const char       *prefix; /* pre-node string constant */
        const char       *suffix; /* post-node string constant */
 };
 
 static void     md_nodelist(struct roff_node *);
 static void     md_node(struct roff_node *);
-static const char *md_stack(char c);
+static const char *md_stack(char);
 static void     md_preword(void);
 static void     md_rawword(const char *);
 static void     md_word(const char *);
@@ -48,6 +53,7 @@ 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 *);
@@ -103,7 +109,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 - MDOC_Dd] = {
+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 */
@@ -138,7 +144,7 @@ static      const struct md_act __md_acts[MDOC_MAX - MDOC_Dd] = {
        { 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 */
@@ -211,7 +217,7 @@ static      const struct md_act __md_acts[MDOC_MAX - MDOC_Dd] = {
        { 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_Mt, NULL, NULL, NULL }, /* Mt */
        { md_cond_body, md_pre_word, md_post_word, "{", "}" }, /* Brq */
@@ -224,8 +230,9 @@ static      const struct md_act __md_acts[MDOC_MAX - MDOC_Dd] = {
        { NULL, NULL, md_post_pc, NULL, NULL }, /* %Q */
        { NULL, md_pre_Lk, md_post_pc, NULL, NULL }, /* %U */
        { NULL, NULL, NULL, NULL, NULL }, /* Ta */
+       { NULL, md_pre_skip, NULL, NULL, NULL }, /* Tg */
 };
-static const struct md_act *const md_acts = __md_acts - MDOC_Dd;
+static const struct md_act *md_act(enum roff_tok);
 
 static int      outflags;
 #define        MD_spc           (1 << 0)  /* Blank character before next word. */
@@ -250,22 +257,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;
@@ -273,9 +288,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');
 }
 
@@ -299,7 +314,9 @@ md_node(struct roff_node *n)
 
        if (outflags & MD_nonl)
                outflags &= ~(MD_nl | MD_sp);
-       else if (outflags & MD_spc && n->flags & NODE_LINE)
+       else if (outflags & MD_spc &&
+            n->flags & NODE_LINE &&
+            !roff_node_transparent(n))
                outflags |= MD_nl;
 
        act = NULL;
@@ -330,8 +347,7 @@ md_node(struct roff_node *n)
                        break;
                }
        } else {
-               assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX);
-               act = md_acts + n->tok;
+               act = md_act(n->tok);
                cond = act->cond == NULL || (*act->cond)(n);
                if (cond && act->pre != NULL &&
                    (n->end == ENDBODY_NOT || n->child != NULL))
@@ -580,6 +596,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;
@@ -590,6 +612,7 @@ md_word(const char *s)
                                nextfont = "***";
                                break;
                        case ESCAPE_FONT:
+                       case ESCAPE_FONTCW:
                        case ESCAPE_FONTROMAN:
                                nextfont = "";
                                break;
@@ -711,12 +734,18 @@ 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 == '`')
@@ -730,7 +759,7 @@ 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 == '`')
@@ -743,7 +772,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;
        }
@@ -755,7 +784,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);
        }
@@ -764,14 +793,17 @@ md_post_word(struct roff_node *n)
 static void
 md_post_pc(struct roff_node *n)
 {
+       struct roff_node *nn;
+
        md_post_raw(n);
        if (n->parent->tok != MDOC_Rs)
                return;
-       if (n->next != NULL) {
+
+       if ((nn = roff_node_next(n)) != NULL) {
                md_word(",");
-               if (n->prev != NULL &&
-                   n->prev->tok == n->tok &&
-                   n->next->tok == n->tok)
+               if (nn->tok == n->tok &&
+                   (nn = roff_node_prev(n)) != NULL &&
+                   nn->tok == n->tok)
                        md_word("and");
        } else {
                md_word(".");
@@ -788,10 +820,13 @@ md_pre_skip(struct roff_node *n)
 static void
 md_pre_syn(struct roff_node *n)
 {
-       if (n->prev == NULL || ! (n->flags & NODE_SYNPRETTY))
+       struct roff_node *np;
+
+       if ((n->flags & NODE_SYNPRETTY) == 0 ||
+           (np = roff_node_prev(n)) == NULL)
                return;
 
-       if (n->prev->tok == n->tok &&
+       if (np->tok == n->tok &&
            n->tok != MDOC_Ft &&
            n->tok != MDOC_Fo &&
            n->tok != MDOC_Fn) {
@@ -799,7 +834,7 @@ md_pre_syn(struct roff_node *n)
                return;
        }
 
-       switch (n->prev->tok) {
+       switch (np->tok) {
        case MDOC_Fd:
        case MDOC_Fn:
        case MDOC_Fo:
@@ -1030,7 +1065,9 @@ md_pre_Fa(struct roff_node *n)
 static void
 md_post_Fa(struct roff_node *n)
 {
-       if (n->next != NULL && n->next->tok == MDOC_Fa)
+       struct roff_node *nn;
+
+       if ((nn = roff_node_next(n)) != NULL && nn->tok == MDOC_Fa)
                md_word(",");
 }
 
@@ -1052,9 +1089,11 @@ md_post_Fd(struct roff_node *n)
 static void
 md_post_Fl(struct roff_node *n)
 {
+       struct roff_node *nn;
+
        md_post_raw(n);
-       if (n->child == NULL && n->next != NULL &&
-           n->next->type != ROFFT_TEXT && !(n->next->flags & NODE_LINE))
+       if (n->child == NULL && (nn = roff_node_next(n)) != NULL &&
+           nn->type != ROFFT_TEXT && (nn->flags & NODE_LINE) == 0)
                outflags &= ~MD_spc;
 }
 
@@ -1268,7 +1307,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.