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 fcc636388b7b7bd101a4c56493339e57d7ead799..1d80ccf7f85b5e3c174d65ef6f8f427ef2bab9de 100644 (file)
--- a/mdoc_markdown.c
+++ b/mdoc_markdown.c
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_markdown.c,v 1.28 2018/12/03 21:00:10 schwarze Exp $ */
+/* $Id: mdoc_markdown.c,v 1.36 2020/06/22 19:20:40 schwarze Exp $ */
 /*
- * Copyright (c) 2017, 2018 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,7 +13,11 @@
  * 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>
@@ -29,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 *);
@@ -226,6 +230,7 @@ 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 *md_act(enum roff_tok);
 
@@ -261,21 +266,21 @@ md_act(enum roff_tok tok)
 }
 
 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;
@@ -283,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');
 }
 
@@ -309,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;
@@ -589,6 +596,9 @@ 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;
@@ -783,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(".");
@@ -807,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) {
@@ -818,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:
@@ -1049,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(",");
 }
 
@@ -1071,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;
 }
 
@@ -1287,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.