[BACK]Return to mdoc_markdown.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc_markdown.c between version 1.13 and 1.30

version 1.13, 2017/03/08 18:17:21 version 1.30, 2018/12/30 00:49:55
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * 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   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 19 
Line 19 
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  #include <ctype.h>
 #include <stdio.h>  #include <stdio.h>
   #include <stdlib.h>
 #include <string.h>  #include <string.h>
   
 #include "mandoc_aux.h"  #include "mandoc_aux.h"
Line 43  static void  md_rawword(const char *);
Line 44  static void  md_rawword(const char *);
 static  void     md_word(const char *);  static  void     md_word(const char *);
 static  void     md_named(const char *);  static  void     md_named(const char *);
 static  void     md_char(unsigned 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_head(struct roff_node *);
 static  int      md_cond_body(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_raw(struct roff_node *);
 static  int      md_pre_word(struct roff_node *);  static  int      md_pre_word(struct roff_node *);
 static  int      md_pre_skip(struct roff_node *);  static  int      md_pre_skip(struct roff_node *);
Line 67  static int  md_pre_Fo(struct roff_node *);
Line 70  static int  md_pre_Fo(struct roff_node *);
 static  int      md_pre_In(struct roff_node *);  static  int      md_pre_In(struct roff_node *);
 static  int      md_pre_It(struct roff_node *);  static  int      md_pre_It(struct roff_node *);
 static  int      md_pre_Lk(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_Nd(struct roff_node *);
 static  int      md_pre_Nm(struct roff_node *);  static  int      md_pre_Nm(struct roff_node *);
 static  int      md_pre_No(struct roff_node *);  static  int      md_pre_No(struct roff_node *);
Line 101  static void  md_post_Pf(struct roff_node *);
Line 105  static void  md_post_Pf(struct roff_node *);
 static  void     md_post_Vt(struct roff_node *);  static  void     md_post_Vt(struct roff_node *);
 static  void     md_post__T(struct roff_node *);  static  void     md_post__T(struct roff_node *);
   
 static  const struct md_act md_acts[MDOC_MAX + 1] = {  static  const struct md_act md_acts[MDOC_MAX - MDOC_Dd] = {
         { NULL, md_pre_Ap, NULL, NULL, NULL }, /* Ap */  
         { NULL, NULL, NULL, NULL, NULL }, /* Dd */          { NULL, NULL, NULL, NULL, NULL }, /* Dd */
         { NULL, NULL, NULL, NULL, NULL }, /* Dt */          { NULL, NULL, NULL, NULL, NULL }, /* Dt */
         { NULL, NULL, NULL, NULL, NULL }, /* Os */          { NULL, NULL, NULL, NULL, NULL }, /* Os */
Line 118  static const struct md_act md_acts[MDOC_MAX + 1] = {
Line 121  static const struct md_act md_acts[MDOC_MAX + 1] = {
         { NULL, md_pre_It, md_post_It, NULL, NULL }, /* It */          { NULL, md_pre_It, md_post_It, NULL, NULL }, /* It */
         { NULL, md_pre_raw, md_post_raw, "*", "*" }, /* Ad */          { NULL, md_pre_raw, md_post_raw, "*", "*" }, /* Ad */
         { NULL, md_pre_An, NULL, NULL, NULL }, /* An */          { 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, "*", "*" }, /* Ar */
         { NULL, md_pre_raw, md_post_raw, "**", "**" }, /* Cd */          { NULL, md_pre_raw, md_post_raw, "**", "**" }, /* Cd */
         { NULL, md_pre_raw, md_post_raw, "**", "**" }, /* Cm */          { NULL, md_pre_raw, md_post_raw, "**", "**" }, /* Cm */
Line 136  static const struct md_act md_acts[MDOC_MAX + 1] = {
Line 140  static const struct md_act md_acts[MDOC_MAX + 1] = {
         { md_cond_head, md_pre_Nd, NULL, NULL, NULL }, /* Nd */          { md_cond_head, md_pre_Nd, NULL, NULL, NULL }, /* Nd */
         { NULL, md_pre_Nm, md_post_Nm, "**", "**" }, /* Nm */          { NULL, md_pre_Nm, md_post_Nm, "**", "**" }, /* Nm */
         { md_cond_body, md_pre_word, md_post_word, "[", "]" }, /* Op */          { 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, md_pre_raw, md_post_raw, "*", "*" }, /* Pa */
         { NULL, NULL, NULL, NULL, NULL }, /* Rv */          { NULL, NULL, NULL, NULL, NULL }, /* Rv */
         { NULL, NULL, NULL, NULL, NULL }, /* St */          { NULL, NULL, NULL, NULL, NULL }, /* St */
Line 209  static const struct md_act md_acts[MDOC_MAX + 1] = {
Line 213  static const struct md_act md_acts[MDOC_MAX + 1] = {
         { NULL, md_pre_raw, md_post_raw, "*", "*" }, /* Fr */          { NULL, md_pre_raw, md_post_raw, "*", "*" }, /* Fr */
         { NULL, NULL, NULL, NULL, NULL }, /* Ud */          { NULL, NULL, NULL, NULL, NULL }, /* Ud */
         { NULL, NULL, md_post_Lb, NULL, NULL }, /* Lb */          { 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_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, "{", "}" }, /* Brq */
         { md_cond_body, md_pre_word, md_post_word, "{", "}" }, /* Bro */          { md_cond_body, md_pre_word, md_post_word, "{", "}" }, /* Bro */
         { NULL, NULL, NULL, NULL, NULL }, /* Brc */          { NULL, NULL, NULL, NULL, NULL }, /* Brc */
Line 220  static const struct md_act md_acts[MDOC_MAX + 1] = {
Line 224  static const struct md_act md_acts[MDOC_MAX + 1] = {
         { md_cond_body, md_pre_En, md_post_En, NULL, NULL }, /* En */          { md_cond_body, md_pre_En, md_post_En, NULL, NULL }, /* En */
         { NULL, NULL, NULL, NULL, NULL }, /* Dx */          { NULL, NULL, NULL, NULL, NULL }, /* Dx */
         { NULL, NULL, md_post_pc, NULL, NULL }, /* %Q */          { 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, md_pre_Lk, md_post_pc, NULL, NULL }, /* %U */
         { NULL, NULL, NULL, NULL, NULL }, /* Ta */          { 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;  static  int      outflags;
 #define MD_spc           (1 << 0)  /* Blank character before next word. */  #define MD_spc           (1 << 0)  /* Blank character before next word. */
Line 244  static int  escflags; /* Escape in generated markdown 
Line 245  static int  escflags; /* Escape in generated markdown 
 #define ESC_BOL  (1 << 0)  /* "#*+-" near the beginning of a line. */  #define ESC_BOL  (1 << 0)  /* "#*+-" near the beginning of a line. */
 #define ESC_NUM  (1 << 1)  /* "." after a leading number. */  #define ESC_NUM  (1 << 1)  /* "." after a leading number. */
 #define ESC_HYP  (1 << 2)  /* "(" immediately after "]". */  #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_SQU  (1 << 4)  /* "]" when "[" is open. */
 #define ESC_FON  (1 << 5)  /* "*" immediately after unrelated "*". */  #define ESC_FON  (1 << 5)  /* "*" immediately after unrelated "*". */
 #define ESC_EOL  (1 << 6)  /* " " at the and of a line. */  #define ESC_EOL  (1 << 6)  /* " " at the and of a line. */
Line 252  static int  escflags; /* Escape in generated markdown 
Line 252  static int  escflags; /* Escape in generated markdown 
 static  int      code_blocks, quote_blocks, list_blocks;  static  int      code_blocks, quote_blocks, list_blocks;
 static  int      outcount;  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  void
 markdown_mdoc(void *arg, const struct roff_man *mdoc)  markdown_mdoc(void *arg, const struct roff_meta *mdoc)
 {  {
         outflags = MD_Sm;          outflags = MD_Sm;
         md_word(mdoc->meta.title);          md_word(mdoc->title);
         if (mdoc->meta.msec != NULL) {          if (mdoc->msec != NULL) {
                 outflags &= ~MD_spc;                  outflags &= ~MD_spc;
                 md_word("(");                  md_word("(");
                 md_word(mdoc->meta.msec);                  md_word(mdoc->msec);
                 md_word(")");                  md_word(")");
         }          }
         md_word("-");          md_word("-");
         md_word(mdoc->meta.vol);          md_word(mdoc->vol);
         if (mdoc->meta.arch != NULL) {          if (mdoc->arch != NULL) {
                 md_word("(");                  md_word("(");
                 md_word(mdoc->meta.arch);                  md_word(mdoc->arch);
                 md_word(")");                  md_word(")");
         }          }
         outflags |= MD_sp;          outflags |= MD_sp;
Line 275  markdown_mdoc(void *arg, const struct roff_man *mdoc)
Line 283  markdown_mdoc(void *arg, const struct roff_man *mdoc)
         md_nodelist(mdoc->first->child);          md_nodelist(mdoc->first->child);
   
         outflags |= MD_sp;          outflags |= MD_sp;
         md_word(mdoc->meta.os);          md_word(mdoc->os);
         md_word("-");          md_word("-");
         md_word(mdoc->meta.date);          md_word(mdoc->date);
         putchar('\n');          putchar('\n');
 }  }
   
Line 296  md_node(struct roff_node *n)
Line 304  md_node(struct roff_node *n)
         const struct md_act     *act;          const struct md_act     *act;
         int                      cond, process_children;          int                      cond, process_children;
   
         if (n->flags & NODE_NOPRT)          if (n->type == ROFFT_COMMENT || n->flags & NODE_NOPRT)
                 return;                  return;
   
         if (outflags & MD_nonl)          if (outflags & MD_nonl)
Line 309  md_node(struct roff_node *n)
Line 317  md_node(struct roff_node *n)
         process_children = 1;          process_children = 1;
         n->flags &= ~NODE_ENDED;          n->flags &= ~NODE_ENDED;
   
         switch (n->type) {          if (n->type == ROFFT_TEXT) {
         case ROFFT_TEXT:  
                 if (n->flags & NODE_DELIMC)                  if (n->flags & NODE_DELIMC)
                         outflags &= ~(MD_spc | MD_spc_force);                          outflags &= ~(MD_spc | MD_spc_force);
                 else if (outflags & MD_Sm)                  else if (outflags & MD_Sm)
Line 320  md_node(struct roff_node *n)
Line 327  md_node(struct roff_node *n)
                         outflags &= ~(MD_spc | MD_spc_force);                          outflags &= ~(MD_spc | MD_spc_force);
                 else if (outflags & MD_Sm)                  else if (outflags & MD_Sm)
                         outflags |= MD_spc;                          outflags |= MD_spc;
                 break;          } else if (n->tok < ROFF_MAX) {
         default:                  switch (n->tok) {
                 act = md_acts + 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);                  cond = act->cond == NULL || (*act->cond)(n);
                 if (cond && act->pre != NULL &&                  if (cond && act->pre != NULL &&
                     (n->end == ENDBODY_NOT || n->child != NULL))                      (n->end == ENDBODY_NOT || n->child != NULL))
                         process_children = (*act->pre)(n);                          process_children = (*act->pre)(n);
                 break;  
         }          }
   
         if (process_children && n->child != NULL)          if (process_children && n->child != NULL)
Line 455  md_rawword(const char *s)
Line 472  md_rawword(const char *s)
   
         while (*s != '\0') {          while (*s != '\0') {
                 switch(*s) {                  switch(*s) {
                 case '(':  
                         escflags |= ESC_PAR;  
                         break;  
                 case ')':  
                         escflags |= ~ESC_PAR;  
                         break;  
                 case '*':                  case '*':
                         if (s[1] == '\0')                          if (s[1] == '\0')
                                 escflags |= ESC_FON;                                  escflags |= ESC_FON;
Line 491  md_word(const char *s)
Line 502  md_word(const char *s)
 {  {
         const char      *seq, *prevfont, *currfont, *nextfont;          const char      *seq, *prevfont, *currfont, *nextfont;
         char             c;          char             c;
         int              bs, sz, uc;          int              bs, sz, uc, breakline;
   
         /* No spacing before closing delimiters. */          /* No spacing before closing delimiters. */
         if (s[0] != '\0' && s[1] == '\0' &&          if (s[0] != '\0' && s[1] == '\0' &&
Line 508  md_word(const char *s)
Line 519  md_word(const char *s)
         if ((s[0] == '(' || s[0] == '[') && s[1] == '\0')          if ((s[0] == '(' || s[0] == '[') && s[1] == '\0')
                 outflags &= ~MD_spc;                  outflags &= ~MD_spc;
   
           breakline = 0;
         prevfont = currfont = "";          prevfont = currfont = "";
         while ((c = *s++) != '\0') {          while ((c = *s++) != '\0') {
                 bs = 0;                  bs = 0;
Line 535  md_word(const char *s)
Line 547  md_word(const char *s)
                         bs = escflags & ESC_HYP && !code_blocks;                          bs = escflags & ESC_HYP && !code_blocks;
                         break;                          break;
                 case ')':                  case ')':
                         bs = escflags & (ESC_NUM | ESC_PAR) && !code_blocks;                          bs = escflags & ESC_NUM && !code_blocks;
                         break;                          break;
                 case '*':                  case '*':
                 case '[':                  case '[':
Line 577  md_word(const char *s)
Line 589  md_word(const char *s)
                         case ESCAPE_SPECIAL:                          case ESCAPE_SPECIAL:
                                 uc = mchars_spec2cp(seq, sz);                                  uc = mchars_spec2cp(seq, sz);
                                 break;                                  break;
                           case ESCAPE_UNDEF:
                                   uc = *seq;
                                   break;
                           case ESCAPE_DEVICE:
                                   md_rawword("markdown");
                                   continue;
                         case ESCAPE_FONTBOLD:                          case ESCAPE_FONTBOLD:
                                 nextfont = "**";                                  nextfont = "**";
                                 break;                                  break;
Line 587  md_word(const char *s)
Line 605  md_word(const char *s)
                                 nextfont = "***";                                  nextfont = "***";
                                 break;                                  break;
                         case ESCAPE_FONT:                          case ESCAPE_FONT:
                           case ESCAPE_FONTCW:
                         case ESCAPE_FONTROMAN:                          case ESCAPE_FONTROMAN:
                                 nextfont = "";                                  nextfont = "";
                                 break;                                  break;
                         case ESCAPE_FONTPREV:                          case ESCAPE_FONTPREV:
                                 nextfont = prevfont;                                  nextfont = prevfont;
                                 break;                                  break;
                           case ESCAPE_BREAK:
                                   breakline = 1;
                                   break;
                         case ESCAPE_NOSPACE:                          case ESCAPE_NOSPACE:
                         case ESCAPE_SKIPCHAR:                          case ESCAPE_SKIPCHAR:
                         case ESCAPE_OVERSTRIKE:                          case ESCAPE_OVERSTRIKE:
Line 640  md_word(const char *s)
Line 662  md_word(const char *s)
                 if (bs)                  if (bs)
                         putchar('\\');                          putchar('\\');
                 md_char(c);                  md_char(c);
                   if (breakline &&
                       (*s == '\0' || *s == ' ' || *s == ASCII_NBRSP)) {
                           printf("  \n");
                           breakline = 0;
                           while (*s == ' ' || *s == ASCII_NBRSP)
                                   s++;
                   }
         }          }
         if (*currfont != '\0') {          if (*currfont != '\0') {
                 outflags &= ~MD_spc;                  outflags &= ~MD_spc;
Line 699  md_cond_body(struct roff_node *n)
Line 728  md_cond_body(struct roff_node *n)
 }  }
   
 static int  static int
   md_pre_abort(struct roff_node *n)
   {
           abort();
   }
   
   static int
 md_pre_raw(struct roff_node *n)  md_pre_raw(struct roff_node *n)
 {  {
         const char      *prefix;          const char      *prefix;
   
         if ((prefix = md_acts[n->tok].prefix) != NULL) {          if ((prefix = md_act(n->tok)->prefix) != NULL) {
                 md_rawword(prefix);                  md_rawword(prefix);
                 outflags &= ~MD_spc;                  outflags &= ~MD_spc;
                 if (*prefix == '`')                  if (*prefix == '`')
Line 717  md_post_raw(struct roff_node *n)
Line 752  md_post_raw(struct roff_node *n)
 {  {
         const char      *suffix;          const char      *suffix;
   
         if ((suffix = md_acts[n->tok].suffix) != NULL) {          if ((suffix = md_act(n->tok)->suffix) != NULL) {
                 outflags &= ~(MD_spc | MD_nl);                  outflags &= ~(MD_spc | MD_nl);
                 md_rawword(suffix);                  md_rawword(suffix);
                 if (*suffix == '`')                  if (*suffix == '`')
Line 730  md_pre_word(struct roff_node *n)
Line 765  md_pre_word(struct roff_node *n)
 {  {
         const char      *prefix;          const char      *prefix;
   
         if ((prefix = md_acts[n->tok].prefix) != NULL) {          if ((prefix = md_act(n->tok)->prefix) != NULL) {
                 md_word(prefix);                  md_word(prefix);
                 outflags &= ~MD_spc;                  outflags &= ~MD_spc;
         }          }
Line 742  md_post_word(struct roff_node *n)
Line 777  md_post_word(struct roff_node *n)
 {  {
         const char      *suffix;          const char      *suffix;
   
         if ((suffix = md_acts[n->tok].suffix) != NULL) {          if ((suffix = md_act(n->tok)->suffix) != NULL) {
                 outflags &= ~(MD_spc | MD_nl);                  outflags &= ~(MD_spc | MD_nl);
                 md_word(suffix);                  md_word(suffix);
         }          }
Line 1286  md_post_Lb(struct roff_node *n)
Line 1321  md_post_Lb(struct roff_node *n)
                 outflags |= MD_br;                  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  static int
 md_pre_Lk(struct roff_node *n)  md_pre_Lk(struct roff_node *n)
 {  {
         const struct roff_node *link, *descr;          const struct roff_node *link, *descr, *punct;
         const unsigned char *s;  
   
         if ((link = n->child) == NULL)          if ((link = n->child) == NULL)
                 return 0;                  return 0;
   
         if ((descr = link->next) != NULL) {          /* Find beginning of trailing punctuation. */
                 md_rawword("[");          punct = n->last;
                 outflags &= ~MD_spc;          while (punct != link && punct->flags & NODE_DELIMC)
                 while (descr != NULL) {                  punct = punct->prev;
                         md_word(descr->string);          punct = punct->next;
                         descr = descr->next;  
                 }  
                 outflags &= ~MD_spc;  
                 md_rawword("](");  
         } else  
                 md_rawword("<");  
   
         for (s = link->string; *s != '\0'; s++) {          /* Link text. */
                 if (strchr("%)<>", *s) != NULL) {          descr = link->next;
                         printf("%%%2.2hhX", *s);          if (descr == punct)
                         outcount += 3;                  descr = link;  /* no text */
                 } else {          md_rawword("[");
                         putchar(*s);          outflags &= ~MD_spc;
           do {
                   md_word(descr->string);
                   descr = descr->next;
           } while (descr != punct);
           outflags &= ~MD_spc;
   
           /* 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++;                          outcount++;
                 }                  }
         }          }
   
         outflags &= ~MD_spc;          outflags &= ~MD_spc;
         md_rawword(link->next == NULL ? ">" : ")");          md_rawword(")");
         return 0;          return 0;
 }  }
   

Legend:
Removed from v.1.13  
changed lines
  Added in v.1.30

CVSweb