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

Diff for /mandoc/html.c between version 1.267 and 1.279

version 1.267, 2020/04/08 11:56:03 version 1.279, 2022/08/09 11:23:11
Line 1 
Line 1 
 /* $Id$ */  /* $Id$ */
 /*  /*
  * Copyright (c) 2011-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org>  
  * 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-2021 Ingo Schwarze <schwarze@openbsd.org>
    * Copyright (c) 2022 Anna Vyalkova <cyber@sysrq.in>
  *   *
  * 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 67  static const struct htmldata htmltags[TAG_MAX] = {
Line 68  static const struct htmldata htmltags[TAG_MAX] = {
         {"style",       HTML_NLALL | HTML_INDENT},          {"style",       HTML_NLALL | HTML_INDENT},
         {"title",       HTML_NLAROUND},          {"title",       HTML_NLAROUND},
         {"body",        HTML_NLALL},          {"body",        HTML_NLALL},
           {"main",        HTML_NLALL},
         {"div",         HTML_NLAROUND},          {"div",         HTML_NLAROUND},
         {"section",     HTML_NLALL},          {"section",     HTML_NLALL},
           {"nav",         HTML_NLALL},
         {"table",       HTML_NLALL | HTML_INDENT},          {"table",       HTML_NLALL | HTML_INDENT},
         {"tr",          HTML_NLALL | HTML_INDENT},          {"tr",          HTML_NLALL | HTML_INDENT},
         {"td",          HTML_NLAROUND},          {"td",          HTML_NLAROUND},
Line 78  static const struct htmldata htmltags[TAG_MAX] = {
Line 81  static const struct htmldata htmltags[TAG_MAX] = {
         {"dl",          HTML_NLALL | HTML_INDENT},          {"dl",          HTML_NLALL | HTML_INDENT},
         {"dt",          HTML_NLAROUND},          {"dt",          HTML_NLAROUND},
         {"dd",          HTML_NLAROUND | HTML_INDENT},          {"dd",          HTML_NLAROUND | HTML_INDENT},
         {"h1",          HTML_TOPHRASE | HTML_NLAROUND},  
         {"h2",          HTML_TOPHRASE | HTML_NLAROUND},          {"h2",          HTML_TOPHRASE | HTML_NLAROUND},
           {"h3",          HTML_TOPHRASE | HTML_NLAROUND},
         {"p",           HTML_TOPHRASE | HTML_NLAROUND | HTML_INDENT},          {"p",           HTML_TOPHRASE | HTML_NLAROUND | HTML_INDENT},
         {"pre",         HTML_TOPHRASE | HTML_NLALL | HTML_NOINDENT},          {"pre",         HTML_TOPHRASE | HTML_NLAROUND | HTML_NOINDENT},
         {"a",           HTML_INPHRASE | HTML_TOPHRASE},          {"a",           HTML_INPHRASE | HTML_TOPHRASE},
         {"b",           HTML_INPHRASE | HTML_TOPHRASE},          {"b",           HTML_INPHRASE | HTML_TOPHRASE},
         {"cite",        HTML_INPHRASE | HTML_TOPHRASE},          {"cite",        HTML_INPHRASE | HTML_TOPHRASE},
Line 91  static const struct htmldata htmltags[TAG_MAX] = {
Line 94  static const struct htmldata htmltags[TAG_MAX] = {
         {"span",        HTML_INPHRASE | HTML_TOPHRASE},          {"span",        HTML_INPHRASE | HTML_TOPHRASE},
         {"var",         HTML_INPHRASE | HTML_TOPHRASE},          {"var",         HTML_INPHRASE | HTML_TOPHRASE},
         {"br",          HTML_INPHRASE | HTML_NOSTACK | HTML_NLALL},          {"br",          HTML_INPHRASE | HTML_NOSTACK | HTML_NLALL},
           {"hr",          HTML_INPHRASE | HTML_NOSTACK},
         {"mark",        HTML_INPHRASE },          {"mark",        HTML_INPHRASE },
         {"math",        HTML_INPHRASE | HTML_NLALL | HTML_INDENT},          {"math",        HTML_INPHRASE | HTML_NLALL | HTML_INDENT},
         {"mrow",        0},          {"mrow",        0},
Line 112  static const struct htmldata htmltags[TAG_MAX] = {
Line 116  static const struct htmldata htmltags[TAG_MAX] = {
 };  };
   
 /* Avoid duplicate HTML id= attributes. */  /* Avoid duplicate HTML id= attributes. */
   
   struct  id_entry {
           int      ord;   /* Ordinal number of the latest occurrence. */
           char     id[];  /* The id= attribute without any ordinal suffix. */
   };
 static  struct ohash     id_unique;  static  struct ohash     id_unique;
   
 static  void     html_reset_internal(struct html *);  static  void     html_reset_internal(struct html *);
Line 135  html_alloc(const struct manoutput *outopts)
Line 144  html_alloc(const struct manoutput *outopts)
         h = mandoc_calloc(1, sizeof(struct html));          h = mandoc_calloc(1, sizeof(struct html));
   
         h->tag = NULL;          h->tag = NULL;
           h->metac = h->metal = ESCAPE_FONTROMAN;
         h->style = outopts->style;          h->style = outopts->style;
         if ((h->base_man1 = outopts->man) == NULL)          if ((h->base_man1 = outopts->man) == NULL)
                 h->base_man2 = NULL;                  h->base_man2 = NULL;
Line 146  html_alloc(const struct manoutput *outopts)
Line 156  html_alloc(const struct manoutput *outopts)
         if (outopts->toc)          if (outopts->toc)
                 h->oflags |= HTML_TOC;                  h->oflags |= HTML_TOC;
   
         mandoc_ohash_init(&id_unique, 4, 0);          mandoc_ohash_init(&id_unique, 4, offsetof(struct id_entry, id));
   
         return h;          return h;
 }  }
Line 155  static void
Line 165  static void
 html_reset_internal(struct html *h)  html_reset_internal(struct html *h)
 {  {
         struct tag      *tag;          struct tag      *tag;
         char            *cp;          struct id_entry *entry;
         unsigned int     slot;          unsigned int     slot;
   
         while ((tag = h->tag) != NULL) {          while ((tag = h->tag) != NULL) {
                 h->tag = tag->next;                  h->tag = tag->next;
                 free(tag);                  free(tag);
         }          }
         cp = ohash_first(&id_unique, &slot);          entry = ohash_first(&id_unique, &slot);
         while (cp != NULL) {          while (entry != NULL) {
                 free(cp);                  free(entry);
                 cp = ohash_next(&id_unique, &slot);                  entry = ohash_next(&id_unique, &slot);
         }          }
         ohash_delete(&id_unique);          ohash_delete(&id_unique);
 }  }
Line 174  void
Line 184  void
 html_reset(void *p)  html_reset(void *p)
 {  {
         html_reset_internal(p);          html_reset_internal(p);
         mandoc_ohash_init(&id_unique, 4, 0);          mandoc_ohash_init(&id_unique, 4, offsetof(struct id_entry, id));
 }  }
   
 void  void
Line 190  print_gen_head(struct html *h)
Line 200  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");
           print_otag(h, TAG_META, "??", "name", "viewport",
               "content", "width=device-width, initial-scale=1.0");
         if (h->style != NULL) {          if (h->style != NULL) {
                 print_otag(h, TAG_LINK, "?h??", "rel", "stylesheet",                  print_otag(h, TAG_LINK, "?h??", "rel", "stylesheet",
                     h->style, "type", "text/css", "media", "all");                      h->style, "type", "text/css", "media", "all");
Line 232  html_setfont(struct html *h, enum mandoc_esc font)
Line 244  html_setfont(struct html *h, enum mandoc_esc font)
         case ESCAPE_FONTITALIC:          case ESCAPE_FONTITALIC:
         case ESCAPE_FONTBOLD:          case ESCAPE_FONTBOLD:
         case ESCAPE_FONTBI:          case ESCAPE_FONTBI:
         case ESCAPE_FONTCW:  
         case ESCAPE_FONTROMAN:          case ESCAPE_FONTROMAN:
           case ESCAPE_FONTCR:
           case ESCAPE_FONTCB:
           case ESCAPE_FONTCI:
                 break;                  break;
         case ESCAPE_FONT:          case ESCAPE_FONT:
                 font = ESCAPE_FONTROMAN;                  font = ESCAPE_FONTROMAN;
Line 264  print_metaf(struct html *h)
Line 278  print_metaf(struct html *h)
                 h->metaf = print_otag(h, TAG_B, "");                  h->metaf = print_otag(h, TAG_B, "");
                 print_otag(h, TAG_I, "");                  print_otag(h, TAG_I, "");
                 break;                  break;
         case ESCAPE_FONTCW:          case ESCAPE_FONTCR:
                 h->metaf = print_otag(h, TAG_SPAN, "c", "Li");                  h->metaf = print_otag(h, TAG_SPAN, "c", "Li");
                 break;                  break;
           case ESCAPE_FONTCB:
                   h->metaf = print_otag(h, TAG_SPAN, "c", "Li");
                   print_otag(h, TAG_B, "");
                   break;
           case ESCAPE_FONTCI:
                   h->metaf = print_otag(h, TAG_SPAN, "c", "Li");
                   print_otag(h, TAG_I, "");
                   break;
         default:          default:
                 break;                  break;
         }          }
Line 329  html_fillmode(struct html *h, enum roff_tok want)
Line 351  html_fillmode(struct html *h, enum roff_tok want)
  * element and/or as a segment identifier for a URI in an <a> element.   * element and/or as a segment identifier for a URI in an <a> element.
  * The function may fail and return NULL if the node lacks text data   * The function may fail and return NULL if the node lacks text data
  * to create the attribute from.   * to create the attribute from.
  * If the "unique" argument is 0, the caller is responsible for   * The caller is responsible for free(3)ing the returned string.
  * free(3)ing the returned string after using it.   *
  * If the "unique" argument is non-zero, the "id_unique" ohash table   * If the "unique" argument is non-zero, the "id_unique" ohash table
  * is used for de-duplication and owns the returned string, so the   * is used for de-duplication.  If the "unique" argument is 1,
  * caller must not free(3) it.  In this case, it will be freed   * it is the first time the function is called for this tag and
  * automatically by html_reset() or html_free().   * location, so if an ordinal suffix is needed, it is incremented.
    * If the "unique" argument is 2, it is the second time the function
    * is called for this tag and location, so the ordinal suffix
    * remains unchanged.
  */   */
 char *  char *
 html_make_id(const struct roff_node *n, int unique)  html_make_id(const struct roff_node *n, int unique)
 {  {
         const struct roff_node  *nch;          const struct roff_node  *nch;
         char                    *buf, *bufs, *cp;          struct id_entry         *entry;
           char                    *buf, *cp;
           size_t                   len;
         unsigned int             slot;          unsigned int             slot;
         int                      suffix;  
   
         if (n->tag != NULL)          if (n->tag != NULL)
                 buf = mandoc_strdup(n->tag);                  buf = mandoc_strdup(n->tag);
Line 374  html_make_id(const struct roff_node *n, int unique)
Line 400  html_make_id(const struct roff_node *n, int unique)
          * permitted in URL-fragment strings according to the           * permitted in URL-fragment strings according to the
          * explicit list at:           * explicit list at:
          * https://url.spec.whatwg.org/#url-fragment-string           * https://url.spec.whatwg.org/#url-fragment-string
            * In addition, reserve '~' for ordinal suffixes.
          */           */
   
         for (cp = buf; *cp != '\0'; cp++)          for (cp = buf; *cp != '\0'; cp++) {
                 if (isalnum((unsigned char)*cp) == 0 &&                  if (*cp == ASCII_HYPH)
                     strchr("!$&'()*+,-./:;=?@_~", *cp) == NULL)                          *cp = '-';
                   else if (isalnum((unsigned char)*cp) == 0 &&
                       strchr("!$&'()*+,-./:;=?@_", *cp) == NULL)
                         *cp = '_';                          *cp = '_';
           }
   
         if (unique == 0)          if (unique == 0)
                 return buf;                  return buf;
   
         /* Avoid duplicate HTML id= attributes. */          /* Avoid duplicate HTML id= attributes. */
   
         bufs = NULL;  
         suffix = 1;  
         slot = ohash_qlookup(&id_unique, buf);          slot = ohash_qlookup(&id_unique, buf);
         cp = ohash_find(&id_unique, slot);          if ((entry = ohash_find(&id_unique, slot)) == NULL) {
         if (cp != NULL) {                  len = strlen(buf) + 1;
                 while (cp != NULL) {                  entry = mandoc_malloc(sizeof(*entry) + len);
                         free(bufs);                  entry->ord = 1;
                         if (++suffix > 127) {                  memcpy(entry->id, buf, len);
                                 free(buf);                  ohash_insert(&id_unique, slot, entry);
                                 return NULL;          } else if (unique == 1)
                         }                  entry->ord++;
                         mandoc_asprintf(&bufs, "%s_%d", buf, suffix);  
                         slot = ohash_qlookup(&id_unique, bufs);          if (entry->ord > 1) {
                         cp = ohash_find(&id_unique, slot);                  cp = buf;
                 }                  mandoc_asprintf(&buf, "%s~%d", cp, entry->ord);
                 free(buf);                  free(cp);
                 buf = bufs;  
         }          }
         ohash_insert(&id_unique, slot, buf);  
         return buf;          return buf;
 }  }
   
Line 494  print_encode(struct html *h, const char *p, const char
Line 520  print_encode(struct html *h, const char *p, const char
                 case ESCAPE_FONTBOLD:                  case ESCAPE_FONTBOLD:
                 case ESCAPE_FONTITALIC:                  case ESCAPE_FONTITALIC:
                 case ESCAPE_FONTBI:                  case ESCAPE_FONTBI:
                 case ESCAPE_FONTCW:  
                 case ESCAPE_FONTROMAN:                  case ESCAPE_FONTROMAN:
                   case ESCAPE_FONTCR:
                   case ESCAPE_FONTCB:
                   case ESCAPE_FONTCI:
                         if (0 == norecurse) {                          if (0 == norecurse) {
                                 h->flags |= HTML_NOSPACE;                                  h->flags |= HTML_NOSPACE;
                                 if (html_setfont(h, esc))                                  if (html_setfont(h, esc))
Line 686  print_otag(struct html *h, enum htmltag tag, const cha
Line 714  print_otag(struct html *h, enum htmltag tag, const cha
                 case 'i':                  case 'i':
                         attr = "id";                          attr = "id";
                         break;                          break;
                   case 'r':
                           attr = "role";
                           break;
                 case '?':                  case '?':
                         attr = arg1;                          attr = arg1;
                         arg1 = va_arg(ap, char *);                          arg1 = va_arg(ap, char *);
Line 786  print_otag_id(struct html *h, enum htmltag elemtype, c
Line 817  print_otag_id(struct html *h, enum htmltag elemtype, c
         if (n->flags & NODE_ID)          if (n->flags & NODE_ID)
                 id = html_make_id(n, 1);                  id = html_make_id(n, 1);
         if (n->flags & NODE_HREF)          if (n->flags & NODE_HREF)
                 href = id == NULL ? html_make_id(n, 0) : id;                  href = id == NULL ? html_make_id(n, 2) : id;
         if (href != NULL && htmltags[elemtype].flags & HTML_INPHRASE)          if (href != NULL && htmltags[elemtype].flags & HTML_INPHRASE)
                 ret = print_otag(h, TAG_A, "chR", "permalink", href);                  ret = print_otag(h, TAG_A, "chR", "permalink", href);
         t = print_otag(h, elemtype, "ci", cattr, id);          t = print_otag(h, elemtype, "ci", cattr, id);
Line 804  print_otag_id(struct html *h, enum htmltag elemtype, c
Line 835  print_otag_id(struct html *h, enum htmltag elemtype, c
                                 print_otag(h, TAG_A, "chR", "permalink", href);                                  print_otag(h, TAG_A, "chR", "permalink", href);
                 }                  }
         }          }
           free(id);
         if (id == NULL)          if (id == NULL)
                 free(href);                  free(href);
         return ret;          return ret;
Line 878  print_gen_comment(struct html *h, struct roff_node *n)
Line 910  print_gen_comment(struct html *h, struct roff_node *n)
 void  void
 print_text(struct html *h, const char *word)  print_text(struct html *h, const char *word)
 {  {
           print_tagged_text(h, word, NULL);
   }
   
   void
   print_tagged_text(struct html *h, const char *word, struct roff_node *n)
   {
           struct tag      *t;
           char            *href;
   
         /*          /*
          * Always wrap text in a paragraph unless already contained in           * Always wrap text in a paragraph unless already contained in
          * some flow container; never put it directly into a section.           * some flow container; never put it directly into a section.
Line 898  print_text(struct html *h, const char *word)
Line 939  print_text(struct html *h, const char *word)
         }          }
   
         /*          /*
          * Print the text, optionally surrounded by HTML whitespace,           * Optionally switch fonts, optionally write a permalink, then
          * optionally manually switching fonts before and after.           * print the text, optionally surrounded by HTML whitespace.
          */           */
   
         assert(h->metaf == NULL);          assert(h->metaf == NULL);
         print_metaf(h);          print_metaf(h);
         print_indent(h);          print_indent(h);
   
           if (n != NULL && (href = html_make_id(n, 2)) != NULL) {
                   t = print_otag(h, TAG_A, "chR", "permalink", href);
                   free(href);
           } else
                   t = NULL;
   
         if ( ! print_encode(h, word, NULL, 0)) {          if ( ! print_encode(h, word, NULL, 0)) {
                 if ( ! (h->flags & HTML_NONOSPACE))                  if ( ! (h->flags & HTML_NONOSPACE))
                         h->flags &= ~HTML_NOSPACE;                          h->flags &= ~HTML_NOSPACE;
Line 915  print_text(struct html *h, const char *word)
Line 963  print_text(struct html *h, const char *word)
         if (h->metaf != NULL) {          if (h->metaf != NULL) {
                 print_tagq(h, h->metaf);                  print_tagq(h, h->metaf);
                 h->metaf = NULL;                  h->metaf = NULL;
         }          } else if (t != NULL)
                   print_tagq(h, t);
   
         h->flags &= ~HTML_IGNDELIM;          h->flags &= ~HTML_IGNDELIM;
 }  }
Legend:
Removed from v.1.267  
changed lines
  Added in v.1.279
CVSweb