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

Diff for /mandoc/html.c between version 1.82 and 1.271

version 1.82, 2009/11/09 05:11:46 version 1.271, 2020/10/16 17:22:43
Line 1 
Line 1 
 /*      $Id$ */  /* $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2011-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org>
    * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  *   *
  * 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
  * copyright notice and this permission notice appear in all copies.   * copyright notice and this permission notice appear in all copies.
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
    *
    * Common functions for mandoc(1) HTML formatters.
    * For use by individual formatters and by the main program.
  */   */
   #include "config.h"
   
 #include <sys/types.h>  #include <sys/types.h>
   #include <sys/stat.h>
   
 #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_aux.h"
   #include "mandoc_ohash.h"
   #include "mandoc.h"
   #include "roff.h"
 #include "out.h"  #include "out.h"
 #include "chars.h"  
 #include "html.h"  #include "html.h"
   #include "manconf.h"
 #include "main.h"  #include "main.h"
   
 #define UNCONST(a)      ((void *)(uintptr_t)(const void *)(a))  
   
 #define DOCTYPE         "-//W3C//DTD HTML 4.01//EN"  
 #define DTD             "http://www.w3.org/TR/html4/strict.dtd"  
   
 struct  htmldata {  struct  htmldata {
         const char       *name;          const char       *name;
         int               flags;          int               flags;
 #define HTML_CLRLINE     (1 << 0)  #define HTML_INPHRASE    (1 << 0)  /* Can appear in phrasing context. */
 #define HTML_NOSTACK     (1 << 1)  #define HTML_TOPHRASE    (1 << 1)  /* Establishes phrasing context. */
   #define HTML_NOSTACK     (1 << 2)  /* Does not have an end tag. */
   #define HTML_NLBEFORE    (1 << 3)  /* Output line break before opening. */
   #define HTML_NLBEGIN     (1 << 4)  /* Output line break after opening. */
   #define HTML_NLEND       (1 << 5)  /* Output line break before closing. */
   #define HTML_NLAFTER     (1 << 6)  /* Output line break after closing. */
   #define HTML_NLAROUND    (HTML_NLBEFORE | HTML_NLAFTER)
   #define HTML_NLINSIDE    (HTML_NLBEGIN | HTML_NLEND)
   #define HTML_NLALL       (HTML_NLAROUND | HTML_NLINSIDE)
   #define HTML_INDENT      (1 << 7)  /* Indent content by two spaces. */
   #define HTML_NOINDENT    (1 << 8)  /* Exception: never indent content. */
 };  };
   
 static  const struct htmldata htmltags[TAG_MAX] = {  static  const struct htmldata htmltags[TAG_MAX] = {
         {"html",        HTML_CLRLINE}, /* TAG_HTML */          {"html",        HTML_NLALL},
         {"head",        HTML_CLRLINE}, /* TAG_HEAD */          {"head",        HTML_NLALL | HTML_INDENT},
         {"body",        HTML_CLRLINE}, /* TAG_BODY */          {"meta",        HTML_NOSTACK | HTML_NLALL},
         {"meta",        HTML_CLRLINE | HTML_NOSTACK}, /* TAG_META */          {"link",        HTML_NOSTACK | HTML_NLALL},
         {"title",       HTML_CLRLINE}, /* TAG_TITLE */          {"style",       HTML_NLALL | HTML_INDENT},
         {"div",         HTML_CLRLINE}, /* TAG_DIV */          {"title",       HTML_NLAROUND},
         {"h1",          0}, /* TAG_H1 */          {"body",        HTML_NLALL},
         {"h2",          0}, /* TAG_H2 */          {"div",         HTML_NLAROUND},
         {"p",           HTML_CLRLINE}, /* TAG_P */          {"section",     HTML_NLALL},
         {"span",        0}, /* TAG_SPAN */          {"table",       HTML_NLALL | HTML_INDENT},
         {"link",        HTML_CLRLINE | HTML_NOSTACK}, /* TAG_LINK */          {"tr",          HTML_NLALL | HTML_INDENT},
         {"br",          HTML_CLRLINE | HTML_NOSTACK}, /* TAG_LINK */          {"td",          HTML_NLAROUND},
         {"a",           0}, /* TAG_A */          {"li",          HTML_NLAROUND | HTML_INDENT},
         {"table",       HTML_CLRLINE}, /* TAG_TABLE */          {"ul",          HTML_NLALL | HTML_INDENT},
         {"col",         HTML_CLRLINE | HTML_NOSTACK}, /* TAG_COL */          {"ol",          HTML_NLALL | HTML_INDENT},
         {"tr",          HTML_CLRLINE}, /* TAG_TR */          {"dl",          HTML_NLALL | HTML_INDENT},
         {"td",          HTML_CLRLINE}, /* TAG_TD */          {"dt",          HTML_NLAROUND},
         {"li",          HTML_CLRLINE}, /* TAG_LI */          {"dd",          HTML_NLAROUND | HTML_INDENT},
         {"ul",          HTML_CLRLINE}, /* TAG_UL */          {"h1",          HTML_TOPHRASE | HTML_NLAROUND},
         {"ol",          HTML_CLRLINE}, /* TAG_OL */          {"h2",          HTML_TOPHRASE | HTML_NLAROUND},
         {"base",        HTML_CLRLINE | HTML_NOSTACK}, /* TAG_BASE */          {"p",           HTML_TOPHRASE | HTML_NLAROUND | HTML_INDENT},
           {"pre",         HTML_TOPHRASE | HTML_NLAROUND | HTML_NOINDENT},
           {"a",           HTML_INPHRASE | HTML_TOPHRASE},
           {"b",           HTML_INPHRASE | HTML_TOPHRASE},
           {"cite",        HTML_INPHRASE | HTML_TOPHRASE},
           {"code",        HTML_INPHRASE | HTML_TOPHRASE},
           {"i",           HTML_INPHRASE | HTML_TOPHRASE},
           {"small",       HTML_INPHRASE | HTML_TOPHRASE},
           {"span",        HTML_INPHRASE | HTML_TOPHRASE},
           {"var",         HTML_INPHRASE | HTML_TOPHRASE},
           {"br",          HTML_INPHRASE | HTML_NOSTACK | HTML_NLALL},
           {"mark",        HTML_INPHRASE },
           {"math",        HTML_INPHRASE | HTML_NLALL | HTML_INDENT},
           {"mrow",        0},
           {"mi",          0},
           {"mn",          0},
           {"mo",          0},
           {"msup",        0},
           {"msub",        0},
           {"msubsup",     0},
           {"mfrac",       0},
           {"msqrt",       0},
           {"mfenced",     0},
           {"mtable",      0},
           {"mtr",         0},
           {"mtd",         0},
           {"munderover",  0},
           {"munder",      0},
           {"mover",       0},
 };  };
   
 static  const char      *const htmlattrs[ATTR_MAX] = {  /* Avoid duplicate HTML id= attributes. */
         "http-equiv",  
         "content",  struct  id_entry {
         "name",          int      ord;   /* Ordinal number of the latest occurrence. */
         "rel",          char     id[];  /* The id= attribute without any ordinal suffix. */
         "href",  
         "type",  
         "media",  
         "class",  
         "style",  
         "width",  
         "valign",  
         "target",  
         "id",  
         "summary",  
 };  };
   static  struct ohash     id_unique;
   
 #ifdef __linux__  static  void     html_reset_internal(struct html *);
 extern  int               getsubopt(char **, char * const *, char **);  static  void     print_byte(struct html *, char);
 #endif  static  void     print_endword(struct html *);
   static  void     print_indent(struct html *);
   static  void     print_word(struct html *, const char *);
   
   static  void     print_ctag(struct html *, struct tag *);
   static  int      print_escape(struct html *, char);
   static  int      print_encode(struct html *, const char *, const char *, int);
   static  void     print_href(struct html *, const char *, const char *, int);
   static  void     print_metaf(struct html *);
   
 static  void              print_spec(struct html *, const char *, int);  
 static  void              print_res(struct html *, const char *, int);  
 static  void              print_ctag(struct html *, enum htmltag);  
 static  void              print_encode(struct html *, const char *);  
   
   
 void *  void *
 html_alloc(char *outopts)  html_alloc(const struct manoutput *outopts)
 {  {
         struct html     *h;          struct html     *h;
         const char      *toks[4];  
         char            *v;  
   
         toks[0] = "style";          h = mandoc_calloc(1, sizeof(struct html));
         toks[1] = "man";  
         toks[2] = "includes";  
         toks[3] = NULL;  
   
         h = calloc(1, sizeof(struct html));          h->tag = NULL;
         if (NULL == h) {          h->style = outopts->style;
                 perror(NULL);          if ((h->base_man1 = outopts->man) == NULL)
                 exit(EXIT_FAILURE);                  h->base_man2 = NULL;
         }          else if ((h->base_man2 = strchr(h->base_man1, ';')) != NULL)
                   *h->base_man2++ = '\0';
           h->base_includes = outopts->includes;
           if (outopts->fragment)
                   h->oflags |= HTML_FRAGMENT;
           if (outopts->toc)
                   h->oflags |= HTML_TOC;
   
         h->tags.head = NULL;          mandoc_ohash_init(&id_unique, 4, offsetof(struct id_entry, id));
         h->ords.head = NULL;  
         h->symtab = chars_init(CHARS_HTML);  
   
         while (outopts && *outopts)          return h;
                 switch (getsubopt(&outopts, UNCONST(toks), &v)) {  
                 case (0):  
                         h->style = v;  
                         break;  
                 case (1):  
                         h->base_man = v;  
                         break;  
                 case (2):  
                         h->base_includes = v;  
                         break;  
                 default:  
                         break;  
                 }  
   
         return(h);  
 }  }
   
   static void
 void  html_reset_internal(struct html *h)
 html_free(void *p)  
 {  {
         struct tag      *tag;          struct tag      *tag;
         struct ord      *ord;          struct id_entry *entry;
         struct html     *h;          unsigned int     slot;
   
         h = (struct html *)p;          while ((tag = h->tag) != NULL) {
                   h->tag = tag->next;
         while ((ord = h->ords.head) != NULL) {  
                 h->ords.head = ord->next;  
                 free(ord);  
         }  
   
         while ((tag = h->tags.head) != NULL) {  
                 h->tags.head = tag->next;  
                 free(tag);                  free(tag);
         }          }
           entry = ohash_first(&id_unique, &slot);
         if (h->symtab)          while (entry != NULL) {
                 chars_free(h->symtab);                  free(entry);
                   entry = ohash_next(&id_unique, &slot);
           }
           ohash_delete(&id_unique);
   }
   
         free(h);  void
   html_reset(void *p)
   {
           html_reset_internal(p);
           mandoc_ohash_init(&id_unique, 4, offsetof(struct id_entry, id));
 }  }
   
   void
   html_free(void *p)
   {
           html_reset_internal(p);
           free(p);
   }
   
 void  void
 print_gen_head(struct html *h)  print_gen_head(struct html *h)
 {  {
         struct htmlpair  tag[4];          struct tag      *t;
   
         tag[0].key = ATTR_HTTPEQUIV;          print_otag(h, TAG_META, "?", "charset", "utf-8");
         tag[0].val = "Content-Type";          if (h->style != NULL) {
         tag[1].key = ATTR_CONTENT;                  print_otag(h, TAG_LINK, "?h??", "rel", "stylesheet",
         tag[1].val = "text/html; charset=utf-8";                      h->style, "type", "text/css", "media", "all");
         print_otag(h, TAG_META, 2, tag);                  return;
           }
   
         tag[0].key = ATTR_NAME;          /*
         tag[0].val = "resource-type";           * Print a minimal embedded style sheet.
         tag[1].key = ATTR_CONTENT;           */
         tag[1].val = "document";  
         print_otag(h, TAG_META, 2, tag);  
   
         if (h->style) {          t = print_otag(h, TAG_STYLE, "");
                 tag[0].key = ATTR_REL;          print_text(h, "table.head, table.foot { width: 100%; }");
                 tag[0].val = "stylesheet";          print_endline(h);
                 tag[1].key = ATTR_HREF;          print_text(h, "td.head-rtitle, td.foot-os { text-align: right; }");
                 tag[1].val = h->style;          print_endline(h);
                 tag[2].key = ATTR_TYPE;          print_text(h, "td.head-vol { text-align: center; }");
                 tag[2].val = "text/css";          print_endline(h);
                 tag[3].key = ATTR_MEDIA;          print_text(h, ".Nd, .Bf, .Op { display: inline; }");
                 tag[3].val = "all";          print_endline(h);
                 print_otag(h, TAG_LINK, 4, tag);          print_text(h, ".Pa, .Ad { font-style: italic; }");
           print_endline(h);
           print_text(h, ".Ms { font-weight: bold; }");
           print_endline(h);
           print_text(h, ".Bl-diag ");
           print_byte(h, '>');
           print_text(h, " dt { font-weight: bold; }");
           print_endline(h);
           print_text(h, "code.Nm, .Fl, .Cm, .Ic, code.In, .Fd, .Fn, .Cd "
               "{ font-weight: bold; font-family: inherit; }");
           print_tagq(h, t);
   }
   
   int
   html_setfont(struct html *h, enum mandoc_esc font)
   {
           switch (font) {
           case ESCAPE_FONTPREV:
                   font = h->metal;
                   break;
           case ESCAPE_FONTITALIC:
           case ESCAPE_FONTBOLD:
           case ESCAPE_FONTBI:
           case ESCAPE_FONTCW:
           case ESCAPE_FONTROMAN:
                   break;
           case ESCAPE_FONT:
                   font = ESCAPE_FONTROMAN;
                   break;
           default:
                   return 0;
         }          }
           h->metal = h->metac;
           h->metac = font;
           return 1;
 }  }
   
   
 static void  static void
 print_spec(struct html *h, const char *p, int len)  print_metaf(struct html *h)
 {  {
         const char      *rhs;          if (h->metaf) {
         size_t           sz;                  print_tagq(h, h->metaf);
                   h->metaf = NULL;
           }
           switch (h->metac) {
           case ESCAPE_FONTITALIC:
                   h->metaf = print_otag(h, TAG_I, "");
                   break;
           case ESCAPE_FONTBOLD:
                   h->metaf = print_otag(h, TAG_B, "");
                   break;
           case ESCAPE_FONTBI:
                   h->metaf = print_otag(h, TAG_B, "");
                   print_otag(h, TAG_I, "");
                   break;
           case ESCAPE_FONTCW:
                   h->metaf = print_otag(h, TAG_SPAN, "c", "Li");
                   break;
           default:
                   break;
           }
   }
   
         rhs = chars_a2ascii(h->symtab, p, (size_t)len, &sz);  void
   html_close_paragraph(struct html *h)
   {
           struct tag      *this, *next;
           int              flags;
   
         if (NULL == rhs)          this = h->tag;
                 return;          for (;;) {
         fwrite(rhs, 1, sz, stdout);                  next = this->next;
                   flags = htmltags[this->tag].flags;
                   if (flags & (HTML_INPHRASE | HTML_TOPHRASE))
                           print_ctag(h, this);
                   if ((flags & HTML_INPHRASE) == 0)
                           break;
                   this = next;
           }
 }  }
   
   /*
    * ROFF_nf switches to no-fill mode, ROFF_fi to fill mode.
    * TOKEN_NONE does not switch.  The old mode is returned.
    */
   enum roff_tok
   html_fillmode(struct html *h, enum roff_tok want)
   {
           struct tag      *t;
           enum roff_tok    had;
   
 static void          for (t = h->tag; t != NULL; t = t->next)
 print_res(struct html *h, const char *p, int len)                  if (t->tag == TAG_PRE)
                           break;
   
           had = t == NULL ? ROFF_fi : ROFF_nf;
   
           if (want != had) {
                   switch (want) {
                   case ROFF_fi:
                           print_tagq(h, t);
                           break;
                   case ROFF_nf:
                           html_close_paragraph(h);
                           print_otag(h, TAG_PRE, "");
                           break;
                   case TOKEN_NONE:
                           break;
                   default:
                           abort();
                   }
           }
           return had;
   }
   
   /*
    * Allocate a string to be used for the "id=" attribute of an HTML
    * 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
    * to create the attribute from.
    * The caller is responsible for free(3)ing the returned string.
    *
    * If the "unique" argument is non-zero, the "id_unique" ohash table
    * is used for de-duplication.  If the "unique" argument is 1,
    * it is the first time the function is called for this tag and
    * 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 *
   html_make_id(const struct roff_node *n, int unique)
 {  {
         const char      *rhs;          const struct roff_node  *nch;
         size_t           sz;          struct id_entry         *entry;
           char                    *buf, *cp;
           size_t                   len;
           unsigned int             slot;
   
         rhs = chars_a2res(h->symtab, p, (size_t)len, &sz);          if (n->tag != NULL)
                   buf = mandoc_strdup(n->tag);
           else {
                   switch (n->tok) {
                   case MDOC_Sh:
                   case MDOC_Ss:
                   case MDOC_Sx:
                   case MAN_SH:
                   case MAN_SS:
                           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;
                           break;
                   default:
                           if (n->child == NULL || n->child->type != ROFFT_TEXT)
                                   return NULL;
                           buf = mandoc_strdup(n->child->string);
                           break;
                   }
           }
   
         if (NULL == rhs)          /*
                 return;           * In ID attributes, only use ASCII characters that are
         fwrite(rhs, 1, sz, stdout);           * permitted in URL-fragment strings according to the
            * explicit list at:
            * https://url.spec.whatwg.org/#url-fragment-string
            * In addition, reserve '~' for ordinal suffixes.
            */
   
           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. */
   
           slot = ohash_qlookup(&id_unique, buf);
           if ((entry = ohash_find(&id_unique, slot)) == NULL) {
                   len = strlen(buf) + 1;
                   entry = mandoc_malloc(sizeof(*entry) + len);
                   entry->ord = 1;
                   memcpy(entry->id, buf, len);
                   ohash_insert(&id_unique, slot, entry);
           } else if (unique == 1)
                   entry->ord++;
   
           if (entry->ord > 1) {
                   cp = buf;
                   mandoc_asprintf(&buf, "%s~%d", cp, entry->ord);
                   free(cp);
           }
           return buf;
 }  }
   
   static int
   print_escape(struct html *h, char c)
   {
   
 static void          switch (c) {
 print_encode(struct html *h, const char *p)          case '<':
                   print_word(h, "&lt;");
                   break;
           case '>':
                   print_word(h, "&gt;");
                   break;
           case '&':
                   print_word(h, "&amp;");
                   break;
           case '"':
                   print_word(h, "&quot;");
                   break;
           case ASCII_NBRSP:
                   print_word(h, "&nbsp;");
                   break;
           case ASCII_HYPH:
                   print_byte(h, '-');
                   break;
           case ASCII_BREAK:
                   break;
           default:
                   return 0;
           }
           return 1;
   }
   
   static int
   print_encode(struct html *h, const char *p, const char *pend, int norecurse)
 {  {
         size_t           sz;          char             numbuf[16];
         int              len;  
         const char      *seq;          const char      *seq;
         enum roffdeco    deco;          size_t           sz;
           int              c, len, breakline, nospace;
           enum mandoc_esc  esc;
           static const char rejs[10] = { ' ', '\\', '<', '>', '&', '"',
                   ASCII_NBRSP, ASCII_HYPH, ASCII_BREAK, '\0' };
   
         for (; *p; p++) {          if (pend == NULL)
                 sz = strcspn(p, "\\<>&");                  pend = strchr(p, '\0');
   
                 fwrite(p, 1, sz, stdout);          breakline = 0;
                 p += /* LINTED */          nospace = 0;
                         sz;  
   
                 if ('<' == *p) {          while (p < pend) {
                         printf("&lt;");                  if (HTML_SKIPCHAR & h->flags && '\\' != *p) {
                           h->flags &= ~HTML_SKIPCHAR;
                           p++;
                         continue;                          continue;
                 } else if ('>' == *p) {                  }
                         printf("&gt;");  
                   for (sz = strcspn(p, rejs); sz-- && p < pend; p++)
                           print_byte(h, *p);
   
                   if (breakline &&
                       (p >= pend || *p == ' ' || *p == ASCII_NBRSP)) {
                           print_otag(h, TAG_BR, "");
                           breakline = 0;
                           while (p < pend && (*p == ' ' || *p == ASCII_NBRSP))
                                   p++;
                         continue;                          continue;
                 } else if ('&' == *p) {                  }
                         printf("&amp;");  
                   if (p >= pend)
                           break;
   
                   if (*p == ' ') {
                           print_endword(h);
                           p++;
                         continue;                          continue;
                 } else if ('\0' == *p)                  }
   
                   if (print_escape(h, *p++))
                           continue;
   
                   esc = mandoc_escape(&p, &seq, &len);
                   switch (esc) {
                   case ESCAPE_FONT:
                   case ESCAPE_FONTPREV:
                   case ESCAPE_FONTBOLD:
                   case ESCAPE_FONTITALIC:
                   case ESCAPE_FONTBI:
                   case ESCAPE_FONTCW:
                   case ESCAPE_FONTROMAN:
                           if (0 == norecurse) {
                                   h->flags |= HTML_NOSPACE;
                                   if (html_setfont(h, esc))
                                           print_metaf(h);
                                   h->flags &= ~HTML_NOSPACE;
                           }
                           continue;
                   case ESCAPE_SKIPCHAR:
                           h->flags |= HTML_SKIPCHAR;
                           continue;
                   case ESCAPE_ERROR:
                           continue;
                   default:
                         break;                          break;
                   }
   
                 seq = ++p;                  if (h->flags & HTML_SKIPCHAR) {
                 len = a2roffdeco(&deco, &seq, &sz);                          h->flags &= ~HTML_SKIPCHAR;
                           continue;
                   }
   
                 switch (deco) {                  switch (esc) {
                 case (DECO_RESERVED):                  case ESCAPE_UNICODE:
                         print_res(h, seq, sz);                          /* Skip past "u" header. */
                           c = mchars_num2uc(seq + 1, len - 1);
                         break;                          break;
                 case (DECO_SPECIAL):                  case ESCAPE_NUMBERED:
                         print_spec(h, seq, sz);                          c = mchars_num2char(seq, len);
                           if (c < 0)
                                   continue;
                         break;                          break;
                 default:                  case ESCAPE_SPECIAL:
                           c = mchars_spec2cp(seq, len);
                           if (c <= 0)
                                   continue;
                         break;                          break;
                   case ESCAPE_UNDEF:
                           c = *seq;
                           break;
                   case ESCAPE_DEVICE:
                           print_word(h, "html");
                           continue;
                   case ESCAPE_BREAK:
                           breakline = 1;
                           continue;
                   case ESCAPE_NOSPACE:
                           if ('\0' == *p)
                                   nospace = 1;
                           continue;
                   case ESCAPE_OVERSTRIKE:
                           if (len == 0)
                                   continue;
                           c = seq[len - 1];
                           break;
                   default:
                           continue;
                 }                  }
                   if ((c < 0x20 && c != 0x09) ||
                 p += len - 1;                      (c > 0x7E && c < 0xA0))
                           c = 0xFFFD;
                   if (c > 0x7E) {
                           (void)snprintf(numbuf, sizeof(numbuf), "&#x%.4X;", c);
                           print_word(h, numbuf);
                   } else if (print_escape(h, c) == 0)
                           print_byte(h, c);
         }          }
   
           return nospace;
 }  }
   
   static void
   print_href(struct html *h, const char *name, const char *sec, int man)
   {
           struct stat      sb;
           const char      *p, *pp;
           char            *filename;
   
           if (man) {
                   pp = h->base_man1;
                   if (h->base_man2 != NULL) {
                           mandoc_asprintf(&filename, "%s.%s", name, sec);
                           if (stat(filename, &sb) == -1)
                                   pp = h->base_man2;
                           free(filename);
                   }
           } else
                   pp = h->base_includes;
   
           while ((p = strchr(pp, '%')) != NULL) {
                   print_encode(h, pp, p, 1);
                   if (man && p[1] == 'S') {
                           if (sec == NULL)
                                   print_byte(h, '1');
                           else
                                   print_encode(h, sec, NULL, 1);
                   } else if ((man && p[1] == 'N') ||
                       (man == 0 && p[1] == 'I'))
                           print_encode(h, name, NULL, 1);
                   else
                           print_encode(h, p, p + 2, 1);
                   pp = p + 2;
           }
           if (*pp != '\0')
                   print_encode(h, pp, NULL, 1);
   }
   
 struct tag *  struct tag *
 print_otag(struct html *h, enum htmltag tag,  print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
                 int sz, const struct htmlpair *p)  
 {  {
         int              i;          va_list          ap;
         struct tag      *t;          struct tag      *t;
           const char      *attr;
           char            *arg1, *arg2;
           int              style_written, tflags;
   
         if ( ! (HTML_NOSTACK & htmltags[tag].flags)) {          tflags = htmltags[tag].flags;
                 t = malloc(sizeof(struct tag));  
                 if (NULL == t) {          /* Flow content is not allowed in phrasing context. */
                         perror(NULL);  
                         exit(EXIT_FAILURE);          if ((tflags & HTML_INPHRASE) == 0) {
                   for (t = h->tag; t != NULL; t = t->next) {
                           if (t->closed)
                                   continue;
                           assert((htmltags[t->tag].flags & HTML_TOPHRASE) == 0);
                           break;
                 }                  }
   
           /*
            * Always wrap phrasing elements in a paragraph
            * unless already contained in some flow container;
            * never put them directly into a section.
            */
   
           } else if (tflags & HTML_TOPHRASE && h->tag->tag == TAG_SECTION)
                   print_otag(h, TAG_P, "c", "Pp");
   
           /* Push this tag onto the stack of open scopes. */
   
           if ((tflags & HTML_NOSTACK) == 0) {
                   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;                  t->refcnt = 0;
                   t->closed = 0;
                   h->tag = t;
         } else          } else
                 t = NULL;                  t = NULL;
   
         if ( ! (HTML_NOSPACE & h->flags))          if (tflags & HTML_NLBEFORE)
                 if ( ! (HTML_CLRLINE & htmltags[tag].flags))                  print_endline(h);
                         putchar(' ');          if (h->col == 0)
                   print_indent(h);
         printf("<%s", htmltags[tag].name);          else if ((h->flags & HTML_NOSPACE) == 0) {
         for (i = 0; i < sz; i++) {                  if (h->flags & HTML_KEEP)
                 printf(" %s=\"", htmlattrs[p[i].key]);                          print_word(h, "&#x00A0;");
                 assert(p->val);                  else {
                 print_encode(h, p[i].val);                          if (h->flags & HTML_PREKEEP)
                 putchar('\"');                                  h->flags |= HTML_KEEP;
                           print_endword(h);
                   }
         }          }
         putchar('>');  
   
         h->flags |= HTML_NOSPACE;          if ( ! (h->flags & HTML_NONOSPACE))
         if (HTML_CLRLINE & htmltags[tag].flags)                  h->flags &= ~HTML_NOSPACE;
                 h->flags |= HTML_NEWLINE;  
         else          else
                 h->flags &= ~HTML_NEWLINE;                  h->flags |= HTML_NOSPACE;
   
         return(t);          /* Print out the tag name and attributes. */
 }  
   
           print_byte(h, '<');
           print_word(h, htmltags[tag].name);
   
 /* ARGSUSED */          va_start(ap, fmt);
 static void  
 print_ctag(struct html *h, enum htmltag tag)  
 {  
   
         printf("</%s>", htmltags[tag].name);  
         if (HTML_CLRLINE & htmltags[tag].flags) {  
                 h->flags |= HTML_NOSPACE;  
                 h->flags |= HTML_NEWLINE;  
                 putchar('\n');  
         } else  
                 h->flags &= ~HTML_NEWLINE;  
 }  
   
           while (*fmt != '\0' && *fmt != 's') {
   
 /* ARGSUSED */                  /* Parse attributes and arguments. */
 void  
 print_gen_doctype(struct html *h)  
 {  
   
         printf("<!DOCTYPE HTML PUBLIC \"%s\" \"%s\">", DOCTYPE, DTD);  
 }  
   
                   arg1 = va_arg(ap, char *);
                   arg2 = NULL;
                   switch (*fmt++) {
                   case 'c':
                           attr = "class";
                           break;
                   case 'h':
                           attr = "href";
                           break;
                   case 'i':
                           attr = "id";
                           break;
                   case '?':
                           attr = arg1;
                           arg1 = va_arg(ap, char *);
                           break;
                   default:
                           abort();
                   }
                   if (*fmt == 'M')
                           arg2 = va_arg(ap, char *);
                   if (arg1 == NULL)
                           continue;
   
 void                  /* Print the attributes. */
 print_text(struct html *h, const char *p)  
 {  
   
         if (*p && 0 == *(p + 1))                  print_byte(h, ' ');
                 switch (*p) {                  print_word(h, attr);
                 case('.'):                  print_byte(h, '=');
                         /* FALLTHROUGH */                  print_byte(h, '"');
                 case(','):                  switch (*fmt) {
                         /* FALLTHROUGH */                  case 'I':
                 case(';'):                          print_href(h, arg1, NULL, 0);
                         /* FALLTHROUGH */                          fmt++;
                 case(':'):  
                         /* FALLTHROUGH */  
                 case('?'):  
                         /* FALLTHROUGH */  
                 case('!'):  
                         /* FALLTHROUGH */  
                 case(')'):  
                         /* FALLTHROUGH */  
                 case(']'):  
                         /* FALLTHROUGH */  
                 case('}'):  
                         if ( ! (HTML_IGNDELIM & h->flags))  
                                 h->flags |= HTML_NOSPACE;  
                         break;                          break;
                   case 'M':
                           print_href(h, arg1, arg2, 1);
                           fmt++;
                           break;
                   case 'R':
                           print_byte(h, '#');
                           print_encode(h, arg1, NULL, 1);
                           fmt++;
                           break;
                 default:                  default:
                           print_encode(h, arg1, NULL, 1);
                         break;                          break;
                 }                  }
                   print_byte(h, '"');
           }
   
         if ( ! (h->flags & HTML_NOSPACE))          style_written = 0;
                 putchar(' ');          while (*fmt++ == 's') {
                   arg1 = va_arg(ap, char *);
                   arg2 = va_arg(ap, char *);
                   if (arg2 == NULL)
                           continue;
                   print_byte(h, ' ');
                   if (style_written == 0) {
                           print_word(h, "style=\"");
                           style_written = 1;
                   }
                   print_word(h, arg1);
                   print_byte(h, ':');
                   print_byte(h, ' ');
                   print_word(h, arg2);
                   print_byte(h, ';');
           }
           if (style_written)
                   print_byte(h, '"');
   
         h->flags &= ~HTML_NOSPACE;          va_end(ap);
         h->flags &= ~HTML_NEWLINE;  
   
         if (p)          /* Accommodate for "well-formed" singleton escaping. */
                 print_encode(h, p);  
   
         if (*p && 0 == *(p + 1))          if (htmltags[tag].flags & HTML_NOSTACK)
                 switch (*p) {                  print_byte(h, '/');
                 case('('):  
                         /* FALLTHROUGH */  
                 case('['):  
                         /* FALLTHROUGH */  
                 case('{'):  
                         h->flags |= HTML_NOSPACE;  
                         break;  
                 default:  
                         break;  
                 }  
 }  
   
           print_byte(h, '>');
   
 void          if (tflags & HTML_NLBEGIN)
 print_tagq(struct html *h, const struct tag *until)                  print_endline(h);
           else
                   h->flags |= HTML_NOSPACE;
   
           if (tflags & HTML_INDENT)
                   h->indent++;
           if (tflags & HTML_NOINDENT)
                   h->noindent++;
   
           return t;
   }
   
   /*
    * Print an element with an optional "id=" attribute.
    * If the element has phrasing content and an "id=" attribute,
    * also add a permalink: outside if it can be in phrasing context,
    * inside otherwise.
    */
   struct tag *
   print_otag_id(struct html *h, enum htmltag elemtype, const char *cattr,
       struct roff_node *n)
 {  {
         struct tag      *tag;          struct roff_node *nch;
           struct tag      *ret, *t;
           char            *id, *href;
   
         while ((tag = h->tags.head) != NULL) {          ret = NULL;
                 print_ctag(h, tag->tag);          id = href = NULL;
                 h->tags.head = tag->next;          if (n->flags & NODE_ID)
                 free(tag);                  id = html_make_id(n, 1);
                 if (until && tag == until)          if (n->flags & NODE_HREF)
                         return;                  href = id == NULL ? html_make_id(n, 2) : id;
           if (href != NULL && htmltags[elemtype].flags & HTML_INPHRASE)
                   ret = print_otag(h, TAG_A, "chR", "permalink", href);
           t = print_otag(h, elemtype, "ci", cattr, id);
           if (ret == NULL) {
                   ret = t;
                   if (href != NULL && (nch = n->child) != NULL) {
                           /* man(7) is safe, it tags phrasing content only. */
                           if (n->tok > MDOC_MAX ||
                               htmltags[elemtype].flags & HTML_TOPHRASE)
                                   nch = NULL;
                           else  /* For mdoc(7), beware of nested blocks. */
                                   while (nch != NULL && nch->type == ROFFT_TEXT)
                                           nch = nch->next;
                           if (nch == NULL)
                                   print_otag(h, TAG_A, "chR", "permalink", href);
                   }
         }          }
           free(id);
           if (id == NULL)
                   free(href);
           return ret;
 }  }
   
   static void
 void  print_ctag(struct html *h, struct tag *tag)
 print_stagq(struct html *h, const struct tag *suntil)  
 {  {
         struct tag      *tag;          int      tflags;
   
         while ((tag = h->tags.head) != NULL) {          if (tag->closed == 0) {
                 if (suntil && tag == suntil)                  tag->closed = 1;
                         return;                  if (tag == h->metaf)
                 print_ctag(h, tag->tag);                          h->metaf = NULL;
                 h->tags.head = tag->next;                  if (tag == h->tblt)
                           h->tblt = NULL;
   
                   tflags = htmltags[tag->tag].flags;
                   if (tflags & HTML_INDENT)
                           h->indent--;
                   if (tflags & HTML_NOINDENT)
                           h->noindent--;
                   if (tflags & HTML_NLEND)
                           print_endline(h);
                   print_indent(h);
                   print_byte(h, '<');
                   print_byte(h, '/');
                   print_word(h, htmltags[tag->tag].name);
                   print_byte(h, '>');
                   if (tflags & HTML_NLAFTER)
                           print_endline(h);
           }
           if (tag->refcnt == 0) {
                   h->tag = tag->next;
                 free(tag);                  free(tag);
         }          }
 }  }
   
   
 void  void
 bufinit(struct html *h)  print_gen_decls(struct html *h)
 {  {
           print_word(h, "<!DOCTYPE html>");
         h->buf[0] = '\0';          print_endline(h);
         h->buflen = 0;  
 }  }
   
   
 void  void
 bufcat_style(struct html *h, const char *key, const char *val)  print_gen_comment(struct html *h, struct roff_node *n)
 {  {
           int      wantblank;
   
         bufcat(h, key);          print_word(h, "<!-- This is an automatically generated file."
         bufncat(h, ":", 1);              "  Do not edit.");
         bufcat(h, val);          h->indent = 1;
         bufncat(h, ";", 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  void
 bufcat(struct html *h, const char *p)  print_text(struct html *h, const char *word)
 {  {
           print_tagged_text(h, word, NULL);
         bufncat(h, p, strlen(p));  
 }  }
   
   
 void  void
 buffmt(struct html *h, const char *fmt, ...)  print_tagged_text(struct html *h, const char *word, struct roff_node *n)
 {  {
         va_list          ap;          struct tag      *t;
           char            *href;
   
         va_start(ap, fmt);          /*
         (void)vsnprintf(h->buf + (int)h->buflen,           * Always wrap text in a paragraph unless already contained in
                         BUFSIZ - h->buflen - 1, fmt, ap);           * some flow container; never put it directly into a section.
         va_end(ap);           */
         h->buflen = strlen(h->buf);  
 }  
   
           if (h->tag->tag == TAG_SECTION)
                   print_otag(h, TAG_P, "c", "Pp");
   
 void          /* Output whitespace before this text? */
 bufncat(struct html *h, const char *p, size_t sz)  
 {  
   
         if (h->buflen + sz > BUFSIZ - 1)          if (h->col && (h->flags & HTML_NOSPACE) == 0) {
                 sz = BUFSIZ - 1 - h->buflen;                  if ( ! (HTML_KEEP & h->flags)) {
                           if (HTML_PREKEEP & h->flags)
                                   h->flags |= HTML_KEEP;
                           print_endword(h);
                   } else
                           print_word(h, "&#x00A0;");
           }
   
         (void)strncat(h->buf, p, sz);          /*
         h->buflen += sz;           * Optionally switch fonts, optionally write a permalink, then
 }           * print the text, optionally surrounded by HTML whitespace.
            */
   
           assert(h->metaf == NULL);
           print_metaf(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 ( ! (h->flags & HTML_NONOSPACE))
                           h->flags &= ~HTML_NOSPACE;
                   h->flags &= ~HTML_NONEWLINE;
           } else
                   h->flags |= HTML_NOSPACE | HTML_NONEWLINE;
   
           if (h->metaf != NULL) {
                   print_tagq(h, h->metaf);
                   h->metaf = NULL;
           } else if (t != NULL)
                   print_tagq(h, t);
   
           h->flags &= ~HTML_IGNDELIM;
   }
   
 void  void
 buffmt_includes(struct html *h, const char *name)  print_tagq(struct html *h, const struct tag *until)
 {  {
         const char      *p, *pp;          struct tag      *this, *next;
   
         pp = h->base_includes;          for (this = h->tag; this != NULL; this = next) {
                   next = this == until ? NULL : this->next;
         while (NULL != (p = strchr(pp, '%'))) {                  print_ctag(h, this);
                 bufncat(h, pp, (size_t)(p - pp));  
                 switch (*(p + 1)) {  
                 case('I'):  
                         bufcat(h, name);  
                         break;  
                 default:  
                         bufncat(h, p, 2);  
                         break;  
                 }  
                 pp = p + 2;  
         }          }
         if (pp)  
                 bufcat(h, pp);  
 }  }
   
   /*
    * Close out all open elements up to but excluding suntil.
    * Note that a paragraph just inside stays open together with it
    * because paragraphs include subsequent phrasing content.
    */
 void  void
 buffmt_man(struct html *h,  print_stagq(struct html *h, const struct tag *suntil)
                 const char *name, const char *sec)  
 {  {
         const char      *p, *pp;          struct tag      *this, *next;
   
         pp = h->base_man;          for (this = h->tag; this != NULL; this = next) {
                   next = this->next;
         /* LINTED */                  if (this == suntil || (next == suntil &&
         while (NULL != (p = strchr(pp, '%'))) {                      (this->tag == TAG_P || this->tag == TAG_PRE)))
                 bufncat(h, pp, (size_t)(p - pp));  
                 switch (*(p + 1)) {  
                 case('S'):  
                         bufcat(h, sec ? sec : "1");  
                         break;                          break;
                 case('N'):                  print_ctag(h, this);
                         buffmt(h, name);  
                         break;  
                 default:  
                         bufncat(h, p, 2);  
                         break;  
                 }  
                 pp = p + 2;  
         }          }
         if (pp)  
                 bufcat(h, pp);  
 }  }
   
   
 void  /***********************************************************************
 bufcat_su(struct html *h, const char *p, const struct roffsu *su)   * Low level output functions.
    * They implement line breaking using a short static buffer.
    ***********************************************************************/
   
   /*
    * Buffer one HTML output byte.
    * If the buffer is full, flush and deactivate it and start a new line.
    * If the buffer is inactive, print directly.
    */
   static void
   print_byte(struct html *h, char c)
 {  {
         double           v;          if ((h->flags & HTML_BUFFER) == 0) {
         const char      *u;                  putchar(c);
                   h->col++;
                   return;
           }
   
         v = su->scale;          if (h->col + h->bufcol < sizeof(h->buf)) {
                   h->buf[h->bufcol++] = c;
         switch (su->unit) {                  return;
         case (SCALE_CM):  
                 u = "cm";  
                 break;  
         case (SCALE_IN):  
                 u = "in";  
                 break;  
         case (SCALE_PC):  
                 u = "pc";  
                 break;  
         case (SCALE_PT):  
                 u = "pt";  
                 break;  
         case (SCALE_EM):  
                 u = "em";  
                 break;  
         case (SCALE_MM):  
                 if (0 == (v /= 100))  
                         v = 1;  
                 u = "em";  
                 break;  
         case (SCALE_EN):  
                 u = "ex";  
                 break;  
         case (SCALE_BU):  
                 u = "ex";  
                 break;  
         case (SCALE_VS):  
                 u = "em";  
                 break;  
         default:  
                 u = "ex";  
                 break;  
         }          }
   
         if (su->pt)          putchar('\n');
                 buffmt(h, "%s: %f%s;", p, v, u);          h->col = 0;
         else          print_indent(h);
                 /* LINTED */          putchar(' ');
                 buffmt(h, "%s: %d%s;", p, (int)v, u);          putchar(' ');
           fwrite(h->buf, h->bufcol, 1, stdout);
           putchar(c);
           h->col = (h->indent + 1) * 2 + h->bufcol + 1;
           h->bufcol = 0;
           h->flags &= ~HTML_BUFFER;
 }  }
   
   /*
    * If something was printed on the current output line, end it.
    * Not to be called right after print_indent().
    */
 void  void
 html_idcat(char *dst, const char *src, int sz)  print_endline(struct html *h)
 {  {
         int              ssz;          if (h->col == 0)
                   return;
   
         assert(sz);          if (h->bufcol) {
                   putchar(' ');
                   fwrite(h->buf, h->bufcol, 1, stdout);
                   h->bufcol = 0;
           }
           putchar('\n');
           h->col = 0;
           h->flags |= HTML_NOSPACE;
           h->flags &= ~HTML_BUFFER;
   }
   
         /* Cf. <http://www.w3.org/TR/html4/types.html#h-6.2>. */  /*
    * Flush the HTML output buffer.
    * If it is inactive, activate it.
    */
   static void
   print_endword(struct html *h)
   {
           if (h->noindent) {
                   print_byte(h, ' ');
                   return;
           }
   
         for ( ; *dst != '\0' && sz; dst++, sz--)          if ((h->flags & HTML_BUFFER) == 0) {
                 /* Jump to end. */ ;                  h->col++;
                   h->flags |= HTML_BUFFER;
           } else if (h->bufcol) {
                   putchar(' ');
                   fwrite(h->buf, h->bufcol, 1, stdout);
                   h->col += h->bufcol + 1;
           }
           h->bufcol = 0;
   }
   
         assert(sz > 2);  /*
    * If at the beginning of a new output line,
    * perform indentation and mark the line as containing output.
    * Make sure to really produce some output right afterwards,
    * but do not use print_otag() for producing it.
    */
   static void
   print_indent(struct html *h)
   {
           size_t   i;
   
         /* We can't start with a number (bah). */          if (h->col || h->noindent)
                   return;
   
         *dst++ = 'x';          h->col = h->indent * 2;
         *dst = '\0';          for (i = 0; i < h->col; i++)
         sz--;                  putchar(' ');
   }
   
         for ( ; *src != '\0' && sz > 1; src++) {  /*
                 ssz = snprintf(dst, (size_t)sz, "%.2x", *src);   * Print or buffer some characters
                 sz -= ssz;   * depending on the current HTML output buffer state.
                 dst += ssz;   */
         }  static void
   print_word(struct html *h, const char *cp)
   {
           while (*cp != '\0')
                   print_byte(h, *cp++);
 }  }
Legend:
Removed from v.1.82  
changed lines
  Added in v.1.271
CVSweb