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

Diff for /mandoc/html.c between version 1.203 and 1.230

version 1.203, 2017/01/28 22:36:38 version 1.230, 2018/05/28 14:13:36
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2011-2015, 2017 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2011-2015, 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 22 
Line 22 
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  #include <ctype.h>
 #include <stdarg.h>  #include <stdarg.h>
   #include <stddef.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdint.h>  #include <stdint.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
 #include <unistd.h>  #include <unistd.h>
   
 #include "mandoc.h"  
 #include "mandoc_aux.h"  #include "mandoc_aux.h"
   #include "mandoc_ohash.h"
   #include "mandoc.h"
   #include "roff.h"
 #include "out.h"  #include "out.h"
 #include "html.h"  #include "html.h"
 #include "manconf.h"  #include "manconf.h"
Line 58  static const struct htmldata htmltags[TAG_MAX] = {
Line 61  static const struct htmldata htmltags[TAG_MAX] = {
         {"meta",        HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},          {"meta",        HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},
         {"title",       HTML_NLAROUND},          {"title",       HTML_NLAROUND},
         {"div",         HTML_NLAROUND},          {"div",         HTML_NLAROUND},
           {"div",         0},
         {"h1",          HTML_NLAROUND},          {"h1",          HTML_NLAROUND},
         {"h2",          HTML_NLAROUND},          {"h2",          HTML_NLAROUND},
         {"span",        0},          {"span",        0},
Line 65  static const struct htmldata htmltags[TAG_MAX] = {
Line 69  static const struct htmldata htmltags[TAG_MAX] = {
         {"br",          HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},          {"br",          HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},
         {"a",           0},          {"a",           0},
         {"table",       HTML_NLALL | HTML_INDENT},          {"table",       HTML_NLALL | HTML_INDENT},
         {"tbody",       HTML_NLALL | HTML_INDENT},          {"colgroup",    HTML_NLALL | HTML_INDENT},
         {"col",         HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},          {"col",         HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},
         {"tr",          HTML_NLALL | HTML_INDENT},          {"tr",          HTML_NLALL | HTML_INDENT},
         {"td",          HTML_NLAROUND},          {"td",          HTML_NLAROUND},
Line 76  static const struct htmldata htmltags[TAG_MAX] = {
Line 80  static const struct htmldata htmltags[TAG_MAX] = {
         {"dt",          HTML_NLAROUND},          {"dt",          HTML_NLAROUND},
         {"dd",          HTML_NLAROUND | HTML_INDENT},          {"dd",          HTML_NLAROUND | HTML_INDENT},
         {"pre",         HTML_NLALL | HTML_NOINDENT},          {"pre",         HTML_NLALL | HTML_NOINDENT},
           {"var",         0},
           {"cite",        0},
         {"b",           0},          {"b",           0},
         {"i",           0},          {"i",           0},
         {"code",        0},          {"code",        0},
Line 84  static const struct htmldata htmltags[TAG_MAX] = {
Line 90  static const struct htmldata htmltags[TAG_MAX] = {
         {"math",        HTML_NLALL | HTML_INDENT},          {"math",        HTML_NLALL | HTML_INDENT},
         {"mrow",        0},          {"mrow",        0},
         {"mi",          0},          {"mi",          0},
           {"mn",          0},
         {"mo",          0},          {"mo",          0},
         {"msup",        0},          {"msup",        0},
         {"msub",        0},          {"msub",        0},
Line 112  static const char *const roffscales[SCALE_MAX] = {
Line 119  static const char *const roffscales[SCALE_MAX] = {
         "ex", /* SCALE_FS */          "ex", /* SCALE_FS */
 };  };
   
   /* Avoid duplicate HTML id= attributes. */
   static  struct ohash     id_unique;
   
 static  void     a2width(const char *, struct roffsu *);  static  void     a2width(const char *, struct roffsu *);
 static  void     print_byte(struct html *, char);  static  void     print_byte(struct html *, char);
 static  void     print_endword(struct html *);  static  void     print_endword(struct html *);
Line 132  html_alloc(const struct manoutput *outopts)
Line 142  html_alloc(const struct manoutput *outopts)
   
         h = mandoc_calloc(1, sizeof(struct html));          h = mandoc_calloc(1, sizeof(struct html));
   
         h->tags.head = NULL;          h->tag = NULL;
         h->style = outopts->style;          h->style = outopts->style;
         h->base_man = outopts->man;          h->base_man = outopts->man;
         h->base_includes = outopts->includes;          h->base_includes = outopts->includes;
         if (outopts->fragment)          if (outopts->fragment)
                 h->oflags |= HTML_FRAGMENT;                  h->oflags |= HTML_FRAGMENT;
   
           mandoc_ohash_init(&id_unique, 4, 0);
   
         return h;          return h;
 }  }
   
Line 147  html_free(void *p)
Line 159  html_free(void *p)
 {  {
         struct tag      *tag;          struct tag      *tag;
         struct html     *h;          struct html     *h;
           char            *cp;
           unsigned int     slot;
   
         h = (struct html *)p;          h = (struct html *)p;
           while ((tag = h->tag) != NULL) {
         while ((tag = h->tags.head) != NULL) {                  h->tag = tag->next;
                 h->tags.head = tag->next;  
                 free(tag);                  free(tag);
         }          }
   
         free(h);          free(h);
   
           cp = ohash_first(&id_unique, &slot);
           while (cp != NULL) {
                   free(cp);
                   cp = ohash_next(&id_unique, &slot);
           }
           ohash_delete(&id_unique);
 }  }
   
 void  void
Line 164  print_gen_head(struct html *h)
Line 183  print_gen_head(struct html *h)
         struct tag      *t;          struct tag      *t;
   
         print_otag(h, TAG_META, "?", "charset", "utf-8");          print_otag(h, TAG_META, "?", "charset", "utf-8");
           if (h->style != NULL) {
                   print_otag(h, TAG_LINK, "?h??", "rel", "stylesheet",
                       h->style, "type", "text/css", "media", "all");
                   return;
           }
   
         /*          /*
          * Print a default style-sheet.           * Print a minimal embedded style sheet.
          */           */
   
         t = print_otag(h, TAG_STYLE, "");          t = print_otag(h, TAG_STYLE, "");
Line 177  print_gen_head(struct html *h)
Line 201  print_gen_head(struct html *h)
         print_text(h, "td.head-vol { text-align: center; }");          print_text(h, "td.head-vol { text-align: center; }");
         print_endline(h);          print_endline(h);
         print_text(h, "div.Pp { margin: 1ex 0ex; }");          print_text(h, "div.Pp { margin: 1ex 0ex; }");
           print_endline(h);
           print_text(h, "div.Nd, div.Bf, div.Op { display: inline; }");
           print_endline(h);
           print_text(h, "span.Pa, span.Ad { font-style: italic; }");
           print_endline(h);
           print_text(h, "span.Ms { font-weight: bold; }");
           print_endline(h);
           print_text(h, "dl.Bl-diag ");
           print_byte(h, '>');
           print_text(h, " dt { font-weight: bold; }");
           print_endline(h);
           print_text(h, "code.Nm, code.Fl, code.Cm, code.Ic, "
               "code.In, code.Fd, code.Fn,");
           print_endline(h);
           print_text(h, "code.Cd { font-weight: bold; "
               "font-family: inherit; }");
         print_tagq(h, t);          print_tagq(h, t);
   
         if (h->style)  
                 print_otag(h, TAG_LINK, "?h??", "rel", "stylesheet",  
                     h->style, "type", "text/css", "media", "all");  
 }  }
   
 static void  static void
Line 234  print_metaf(struct html *h, enum mandoc_esc deco)
Line 270  print_metaf(struct html *h, enum mandoc_esc deco)
         }          }
 }  }
   
   char *
   html_make_id(const struct roff_node *n, int unique)
   {
           const struct roff_node  *nch;
           char                    *buf, *bufs, *cp;
           unsigned int             slot;
           int                      suffix;
   
           for (nch = n->child; nch != NULL; nch = nch->next)
                   if (nch->type != ROFFT_TEXT)
                           return NULL;
   
           buf = NULL;
           deroff(&buf, n);
           if (buf == NULL)
                   return NULL;
   
           /*
            * In ID attributes, only use ASCII characters that are
            * permitted in URL-fragment strings according to the
            * explicit list at:
            * https://url.spec.whatwg.org/#url-fragment-string
            */
   
           for (cp = buf; *cp != '\0'; cp++)
                   if (isalnum((unsigned char)*cp) == 0 &&
                       strchr("!$&'()*+,-./:;=?@_~", *cp) == NULL)
                           *cp = '_';
   
           if (unique == 0)
                   return buf;
   
           /* Avoid duplicate HTML id= attributes. */
   
           bufs = NULL;
           suffix = 1;
           slot = ohash_qlookup(&id_unique, buf);
           cp = ohash_find(&id_unique, slot);
           if (cp != NULL) {
                   while (cp != NULL) {
                           free(bufs);
                           if (++suffix > 127) {
                                   free(buf);
                                   return NULL;
                           }
                           mandoc_asprintf(&bufs, "%s_%d", buf, suffix);
                           slot = ohash_qlookup(&id_unique, bufs);
                           cp = ohash_find(&id_unique, slot);
                   }
                   free(buf);
                   buf = bufs;
           }
           ohash_insert(&id_unique, slot, buf);
           return buf;
   }
   
 int  int
 html_strlen(const char *cp)  html_strlen(const char *cp)
 {  {
Line 320  static int
Line 412  static int
 print_encode(struct html *h, const char *p, const char *pend, int norecurse)  print_encode(struct html *h, const char *p, const char *pend, int norecurse)
 {  {
         char             numbuf[16];          char             numbuf[16];
         size_t           sz;          struct tag      *t;
         int              c, len, nospace;  
         const char      *seq;          const char      *seq;
           size_t           sz;
           int              c, len, breakline, nospace;
         enum mandoc_esc  esc;          enum mandoc_esc  esc;
         static const char rejs[9] = { '\\', '<', '>', '&', '"',          static const char rejs[10] = { ' ', '\\', '<', '>', '&', '"',
                 ASCII_NBRSP, ASCII_HYPH, ASCII_BREAK, '\0' };                  ASCII_NBRSP, ASCII_HYPH, ASCII_BREAK, '\0' };
   
         if (pend == NULL)          if (pend == NULL)
                 pend = strchr(p, '\0');                  pend = strchr(p, '\0');
   
           breakline = 0;
         nospace = 0;          nospace = 0;
   
         while (p < pend) {          while (p < pend) {
Line 340  print_encode(struct html *h, const char *p, const char
Line 434  print_encode(struct html *h, const char *p, const char
                 }                  }
   
                 for (sz = strcspn(p, rejs); sz-- && p < pend; p++)                  for (sz = strcspn(p, rejs); sz-- && p < pend; p++)
                         if (*p == ' ')                          print_byte(h, *p);
                                 print_endword(h);  
                         else  
                                 print_byte(h, *p);  
   
                   if (breakline &&
                       (p >= pend || *p == ' ' || *p == ASCII_NBRSP)) {
                           t = print_otag(h, TAG_DIV, "");
                           print_text(h, "\\~");
                           print_tagq(h, t);
                           breakline = 0;
                           while (p < pend && (*p == ' ' || *p == ASCII_NBRSP))
                                   p++;
                           continue;
                   }
   
                 if (p >= pend)                  if (p >= pend)
                         break;                          break;
   
                   if (*p == ' ') {
                           print_endword(h);
                           p++;
                           continue;
                   }
   
                 if (print_escape(h, *p++))                  if (print_escape(h, *p++))
                         continue;                          continue;
   
Line 392  print_encode(struct html *h, const char *p, const char
Line 500  print_encode(struct html *h, const char *p, const char
                         if (c <= 0)                          if (c <= 0)
                                 continue;                                  continue;
                         break;                          break;
                   case ESCAPE_BREAK:
                           breakline = 1;
                           continue;
                 case ESCAPE_NOSPACE:                  case ESCAPE_NOSPACE:
                         if ('\0' == *p)                          if ('\0' == *p)
                                 nospace = 1;                                  nospace = 1;
Line 408  print_encode(struct html *h, const char *p, const char
Line 519  print_encode(struct html *h, const char *p, const char
                     (c > 0x7E && c < 0xA0))                      (c > 0x7E && c < 0xA0))
                         c = 0xFFFD;                          c = 0xFFFD;
                 if (c > 0x7E) {                  if (c > 0x7E) {
                         (void)snprintf(numbuf, sizeof(numbuf), "&#%d;", c);                          (void)snprintf(numbuf, sizeof(numbuf), "&#x%.4X;", c);
                         print_word(h, numbuf);                          print_word(h, numbuf);
                 } else if (print_escape(h, c) == 0)                  } else if (print_escape(h, c) == 0)
                         print_byte(h, c);                          print_byte(h, c);
Line 455  print_otag(struct html *h, enum htmltag tag, const cha
Line 566  print_otag(struct html *h, enum htmltag tag, const cha
   
         tflags = htmltags[tag].flags;          tflags = htmltags[tag].flags;
   
         /* Push this tags onto the stack of open scopes. */          /* Push this tag onto the stack of open scopes. */
   
         if ((tflags & HTML_NOSTACK) == 0) {          if ((tflags & HTML_NOSTACK) == 0) {
                 t = mandoc_malloc(sizeof(struct tag));                  t = mandoc_malloc(sizeof(struct tag));
                 t->tag = tag;                  t->tag = tag;
                 t->next = h->tags.head;                  t->next = h->tag;
                 h->tags.head = t;                  h->tag = t;
         } else          } else
                 t = NULL;                  t = NULL;
   
Line 471  print_otag(struct html *h, enum htmltag tag, const cha
Line 582  print_otag(struct html *h, enum htmltag tag, const cha
                 print_indent(h);                  print_indent(h);
         else if ((h->flags & HTML_NOSPACE) == 0) {          else if ((h->flags & HTML_NOSPACE) == 0) {
                 if (h->flags & HTML_KEEP)                  if (h->flags & HTML_KEEP)
                         print_word(h, "&#160;");                          print_word(h, "&#x00A0;");
                 else {                  else {
                         if (h->flags & HTML_PREKEEP)                          if (h->flags & HTML_PREKEEP)
                                 h->flags |= HTML_KEEP;                                  h->flags |= HTML_KEEP;
Line 532  print_otag(struct html *h, enum htmltag tag, const cha
Line 643  print_otag(struct html *h, enum htmltag tag, const cha
                 print_byte(h, '=');                  print_byte(h, '=');
                 print_byte(h, '"');                  print_byte(h, '"');
                 switch (*fmt) {                  switch (*fmt) {
                 case 'M':  
                         print_href(h, arg1, arg2, 1);  
                         fmt++;  
                         break;  
                 case 'I':                  case 'I':
                         print_href(h, arg1, NULL, 0);                          print_href(h, arg1, NULL, 0);
                         fmt++;                          fmt++;
                         break;                          break;
                   case 'M':
                           print_href(h, arg1, arg2, 1);
                           fmt++;
                           break;
                 case 'R':                  case 'R':
                         print_byte(h, '#');                          print_byte(h, '#');
                           print_encode(h, arg1, NULL, 1);
                         fmt++;                          fmt++;
                         /* FALLTHROUGH */                          break;
                   case 'T':
                           print_encode(h, arg1, NULL, 1);
                           print_word(h, "\" title=\"");
                           print_encode(h, arg1, NULL, 1);
                           fmt++;
                           break;
                 default:                  default:
                         print_encode(h, arg1, NULL, 1);                          print_encode(h, arg1, NULL, 1);
                         break;                          break;
Line 571  print_otag(struct html *h, enum htmltag tag, const cha
Line 689  print_otag(struct html *h, enum htmltag tag, const cha
                 case 'u':                  case 'u':
                         su = va_arg(ap, struct roffsu *);                          su = va_arg(ap, struct roffsu *);
                         break;                          break;
                 case 'v':  
                         i = va_arg(ap, int);  
                         su = &mysu;  
                         SCALE_VS_INIT(su, i);  
                         break;  
                 case 'w':                  case 'w':
                 case 'W':                          if ((arg2 = va_arg(ap, char *)) != NULL) {
                         if ((arg2 = va_arg(ap, char *)) == NULL)                                  su = &mysu;
                                 break;                                  a2width(arg2, su);
                         su = &mysu;                          }
                         a2width(arg2, su);                          if (*fmt == '*') {
                         if (fmt[-1] == 'W')                                  if (su != NULL && su->unit == SCALE_EN &&
                                 su->scale *= -1.0;                                      su->scale > 5.9 && su->scale < 6.1)
                                           su = NULL;
                                   fmt++;
                           }
                           if (*fmt == '+') {
                                   if (su != NULL) {
                                           /* Make even bold text fit. */
                                           su->scale *= 1.2;
                                           /* Add padding. */
                                           su->scale += 3.0;
                                   }
                                   fmt++;
                           }
                           if (*fmt == '-') {
                                   if (su != NULL)
                                           su->scale *= -1.0;
                                   fmt++;
                           }
                         break;                          break;
                 default:                  default:
                         abort();                          abort();
Line 592  print_otag(struct html *h, enum htmltag tag, const cha
Line 722  print_otag(struct html *h, enum htmltag tag, const cha
                 /* Second letter: style name. */                  /* Second letter: style name. */
   
                 switch (*fmt++) {                  switch (*fmt++) {
                 case 'b':  
                         attr = "margin-bottom";  
                         break;  
                 case 'h':                  case 'h':
                         attr = "height";                          attr = "height";
                         break;                          break;
Line 604  print_otag(struct html *h, enum htmltag tag, const cha
Line 731  print_otag(struct html *h, enum htmltag tag, const cha
                 case 'l':                  case 'l':
                         attr = "margin-left";                          attr = "margin-left";
                         break;                          break;
                 case 't':  
                         attr = "margin-top";  
                         break;  
                 case 'w':                  case 'w':
                         attr = "width";                          attr = "width";
                         break;                          break;
Line 699  print_ctag(struct html *h, struct tag *tag)
Line 823  print_ctag(struct html *h, struct tag *tag)
         if (tflags & HTML_NLAFTER)          if (tflags & HTML_NLAFTER)
                 print_endline(h);                  print_endline(h);
   
         h->tags.head = tag->next;          h->tag = tag->next;
         free(tag);          free(tag);
 }  }
   
Line 711  print_gen_decls(struct html *h)
Line 835  print_gen_decls(struct html *h)
 }  }
   
 void  void
   print_gen_comment(struct html *h, struct roff_node *n)
   {
           int      wantblank;
   
           print_word(h, "<!-- This is an automatically generated file."
               "  Do not edit.");
           h->indent = 1;
           wantblank = 0;
           while (n != NULL && n->type == ROFFT_COMMENT) {
                   if (strstr(n->string, "-->") == NULL &&
                       (wantblank || *n->string != '\0')) {
                           print_endline(h);
                           print_indent(h);
                           print_word(h, n->string);
                           wantblank = *n->string != '\0';
                   }
                   n = n->next;
           }
           if (wantblank)
                   print_endline(h);
           print_word(h, " -->");
           print_endline(h);
           h->indent = 0;
   }
   
   void
 print_text(struct html *h, const char *word)  print_text(struct html *h, const char *word)
 {  {
         if (h->col && (h->flags & HTML_NOSPACE) == 0) {          if (h->col && (h->flags & HTML_NOSPACE) == 0) {
Line 719  print_text(struct html *h, const char *word)
Line 869  print_text(struct html *h, const char *word)
                                 h->flags |= HTML_KEEP;                                  h->flags |= HTML_KEEP;
                         print_endword(h);                          print_endword(h);
                 } else                  } else
                         print_word(h, "&#160;");                          print_word(h, "&#x00A0;");
         }          }
   
         assert(NULL == h->metaf);          assert(NULL == h->metaf);
Line 760  print_tagq(struct html *h, const struct tag *until)
Line 910  print_tagq(struct html *h, const struct tag *until)
 {  {
         struct tag      *tag;          struct tag      *tag;
   
         while ((tag = h->tags.head) != NULL) {          while ((tag = h->tag) != NULL) {
                 print_ctag(h, tag);                  print_ctag(h, tag);
                 if (until && tag == until)                  if (until && tag == until)
                         return;                          return;
Line 772  print_stagq(struct html *h, const struct tag *suntil)
Line 922  print_stagq(struct html *h, const struct tag *suntil)
 {  {
         struct tag      *tag;          struct tag      *tag;
   
         while ((tag = h->tags.head) != NULL) {          while ((tag = h->tag) != NULL) {
                 if (suntil && tag == suntil)                  if (suntil && tag == suntil)
                         return;                          return;
                 print_ctag(h, tag);                  print_ctag(h, tag);
Line 910  print_word(struct html *h, const char *cp)
Line 1060  print_word(struct html *h, const char *cp)
 static void  static void
 a2width(const char *p, struct roffsu *su)  a2width(const char *p, struct roffsu *su)
 {  {
         if (a2roffsu(p, su, SCALE_MAX) < 2) {          const char      *end;
   
           end = a2roffsu(p, su, SCALE_MAX);
           if (end == NULL || *end != '\0') {
                 su->unit = SCALE_EN;                  su->unit = SCALE_EN;
                 su->scale = html_strlen(p);                  su->scale = html_strlen(p);
         } else if (su->scale < 0.0)          } else if (su->scale < 0.0)

Legend:
Removed from v.1.203  
changed lines
  Added in v.1.230

CVSweb