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

Diff for /mandoc/man_html.c between version 1.3 and 1.93

version 1.3, 2009/10/03 19:57:53 version 1.93, 2014/04/20 16:46:04
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2013, 2014 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 14 
Line 15 
  * 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.
  */   */
   #ifdef HAVE_CONFIG_H
   #include "config.h"
   #endif
   
 #include <sys/types.h>  #include <sys/types.h>
 #include <sys/queue.h>  
   
   #include <assert.h>
   #include <ctype.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
   #include <string.h>
   
   #include "mandoc.h"
   #include "out.h"
 #include "html.h"  #include "html.h"
 #include "man.h"  #include "man.h"
   #include "main.h"
   
 #define MAN_ARGS          const struct man_meta *m, \  /* TODO: preserve ident widths. */
   /* FIXME: have PD set the default vspace width. */
   
   #define INDENT            5
   
   #define MAN_ARGS          const struct man_meta *man, \
                           const struct man_node *n, \                            const struct man_node *n, \
                             struct mhtml *mh, \
                           struct html *h                            struct html *h
   
   struct  mhtml {
           int               fl;
   #define MANH_LITERAL     (1 << 0) /* literal context */
   };
   
 struct  htmlman {  struct  htmlman {
         int             (*pre)(MAN_ARGS);          int             (*pre)(MAN_ARGS);
         int             (*post)(MAN_ARGS);          int             (*post)(MAN_ARGS);
 };  };
   
   static  void              print_bvspace(struct html *,
                                   const struct man_node *);
 static  void              print_man(MAN_ARGS);  static  void              print_man(MAN_ARGS);
 static  void              print_man_head(MAN_ARGS);  static  void              print_man_head(MAN_ARGS);
   static  void              print_man_nodelist(MAN_ARGS);
   static  void              print_man_node(MAN_ARGS);
   static  int               a2width(const struct man_node *,
                                   struct roffsu *);
   static  int               man_B_pre(MAN_ARGS);
   static  int               man_HP_pre(MAN_ARGS);
   static  int               man_IP_pre(MAN_ARGS);
   static  int               man_I_pre(MAN_ARGS);
   static  int               man_OP_pre(MAN_ARGS);
   static  int               man_PP_pre(MAN_ARGS);
   static  int               man_RS_pre(MAN_ARGS);
   static  int               man_SH_pre(MAN_ARGS);
   static  int               man_SM_pre(MAN_ARGS);
   static  int               man_SS_pre(MAN_ARGS);
   static  int               man_UR_pre(MAN_ARGS);
   static  int               man_alt_pre(MAN_ARGS);
   static  int               man_br_pre(MAN_ARGS);
   static  int               man_ign_pre(MAN_ARGS);
   static  int               man_in_pre(MAN_ARGS);
   static  int               man_literal_pre(MAN_ARGS);
   static  void              man_root_post(MAN_ARGS);
   static  void              man_root_pre(MAN_ARGS);
   
   
 static  const struct htmlman mans[MAN_MAX] = {  static  const struct htmlman mans[MAN_MAX] = {
         { NULL, NULL }, /* br */          { man_br_pre, NULL }, /* br */
         { NULL, NULL }, /* TH */          { NULL, NULL }, /* TH */
         { NULL, NULL }, /* SH */          { man_SH_pre, NULL }, /* SH */
         { NULL, NULL }, /* SS */          { man_SS_pre, NULL }, /* SS */
         { NULL, NULL }, /* TP */          { man_IP_pre, NULL }, /* TP */
         { NULL, NULL }, /* LP */          { man_PP_pre, NULL }, /* LP */
         { NULL, NULL }, /* PP */          { man_PP_pre, NULL }, /* PP */
         { NULL, NULL }, /* P */          { man_PP_pre, NULL }, /* P */
         { NULL, NULL }, /* IP */          { man_IP_pre, NULL }, /* IP */
         { NULL, NULL }, /* HP */          { man_HP_pre, NULL }, /* HP */
         { NULL, NULL }, /* SM */          { man_SM_pre, NULL }, /* SM */
         { NULL, NULL }, /* SB */          { man_SM_pre, NULL }, /* SB */
         { NULL, NULL }, /* BI */          { man_alt_pre, NULL }, /* BI */
         { NULL, NULL }, /* IB */          { man_alt_pre, NULL }, /* IB */
         { NULL, NULL }, /* BR */          { man_alt_pre, NULL }, /* BR */
         { NULL, NULL }, /* RB */          { man_alt_pre, NULL }, /* RB */
         { NULL, NULL }, /* R */          { NULL, NULL }, /* R */
         { NULL, NULL }, /* B */          { man_B_pre, NULL }, /* B */
         { NULL, NULL }, /* I */          { man_I_pre, NULL }, /* I */
         { NULL, NULL }, /* IR */          { man_alt_pre, NULL }, /* IR */
         { NULL, NULL }, /* RI */          { man_alt_pre, NULL }, /* RI */
         { NULL, NULL }, /* na */          { man_ign_pre, NULL }, /* na */
         { NULL, NULL }, /* i */          { man_br_pre, NULL }, /* sp */
         { NULL, NULL }, /* sp */          { man_literal_pre, NULL }, /* nf */
         { NULL, NULL }, /* nf */          { man_literal_pre, NULL }, /* fi */
         { NULL, NULL }, /* fi */  
         { NULL, NULL }, /* r */  
         { NULL, NULL }, /* RE */          { NULL, NULL }, /* RE */
         { NULL, NULL }, /* RS */          { man_RS_pre, NULL }, /* RS */
         { NULL, NULL }, /* DT */          { man_ign_pre, NULL }, /* DT */
         { NULL, NULL }, /* UC */          { man_ign_pre, NULL }, /* UC */
           { man_ign_pre, NULL }, /* PD */
           { man_ign_pre, NULL }, /* AT */
           { man_in_pre, NULL }, /* in */
           { man_ign_pre, NULL }, /* ft */
           { man_OP_pre, NULL }, /* OP */
           { man_literal_pre, NULL }, /* EX */
           { man_literal_pre, NULL }, /* EE */
           { man_UR_pre, NULL }, /* UR */
           { NULL, NULL }, /* UE */
           { man_ign_pre, NULL }, /* ll */
 };  };
   
   
   /*
    * Printing leading vertical space before a block.
    * This is used for the paragraph macros.
    * The rules are pretty simple, since there's very little nesting going
    * on here.  Basically, if we're the first within another block (SS/SH),
    * then don't emit vertical space.  If we are (RS), then do.  If not the
    * first, print it.
    */
   static void
   print_bvspace(struct html *h, const struct man_node *n)
   {
   
           if (n->body && n->body->child)
                   if (MAN_TBL == n->body->child->type)
                           return;
   
           if (MAN_ROOT == n->parent->type || MAN_RS != n->parent->tok)
                   if (NULL == n->prev)
                           return;
   
           print_otag(h, TAG_P, 0, NULL);
   }
   
 void  void
 html_man(void *arg, const struct man *m)  html_man(void *arg, const struct man *man)
 {  {
         struct html     *h;          struct mhtml     mh;
         struct tag      *t;  
   
         h = (struct html *)arg;          memset(&mh, 0, sizeof(struct mhtml));
           print_man(man_meta(man), man_node(man), &mh, (struct html *)arg);
           putchar('\n');
   }
   
         print_gen_doctype(h);  static void
   print_man(MAN_ARGS)
   {
           struct tag      *t, *tt;
           struct htmlpair  tag;
   
         t = print_otag(h, TAG_HTML, 0, NULL);          PAIR_CLASS_INIT(&tag, "mandoc");
         print_man(man_meta(m), man_node(m), h);  
           if ( ! (HTML_FRAGMENT & h->oflags)) {
                   print_gen_decls(h);
                   t = print_otag(h, TAG_HTML, 0, NULL);
                   tt = print_otag(h, TAG_HEAD, 0, NULL);
                   print_man_head(man, n, mh, h);
                   print_tagq(h, tt);
                   print_otag(h, TAG_BODY, 0, NULL);
                   print_otag(h, TAG_DIV, 1, &tag);
           } else
                   t = print_otag(h, TAG_DIV, 1, &tag);
   
           print_man_nodelist(man, n, mh, h);
         print_tagq(h, t);          print_tagq(h, t);
   }
   
         printf("\n");  static void
   print_man_head(MAN_ARGS)
   {
   
           print_gen_head(h);
           assert(man->title);
           assert(man->msec);
           bufcat_fmt(h, "%s(%s)", man->title, man->msec);
           print_otag(h, TAG_TITLE, 0, NULL);
           print_text(h, h->buf);
 }  }
   
   static void
   print_man_nodelist(MAN_ARGS)
   {
   
           print_man_node(man, n, mh, h);
           if (n->next)
                   print_man_nodelist(man, n->next, mh, h);
   }
   
 static void  static void
 print_man(MAN_ARGS)  print_man_node(MAN_ARGS)
 {  {
           int              child;
         struct tag      *t;          struct tag      *t;
         struct htmlpair  tag;  
   
         t = print_otag(h, TAG_HEAD, 0, NULL);          child = 1;
           t = h->tags.head;
   
         print_man_head(m, n, h);          switch (n->type) {
           case MAN_ROOT:
                   man_root_pre(man, n, mh, h);
                   break;
           case MAN_TEXT:
                   /*
                    * If we have a blank line, output a vertical space.
                    * If we have a space as the first character, break
                    * before printing the line's data.
                    */
                   if ('\0' == *n->string) {
                           print_otag(h, TAG_P, 0, NULL);
                           return;
                   }
   
                   if (' ' == *n->string && MAN_LINE & n->flags)
                           print_otag(h, TAG_BR, 0, NULL);
                   else if (MANH_LITERAL & mh->fl && n->prev)
                           print_otag(h, TAG_BR, 0, NULL);
   
                   print_text(h, n->string);
                   return;
           case MAN_EQN:
                   print_eqn(h, n->eqn);
                   break;
           case MAN_TBL:
                   /*
                    * This will take care of initialising all of the table
                    * state data for the first table, then tearing it down
                    * for the last one.
                    */
                   print_tbl(h, n->span);
                   return;
           default:
                   /*
                    * Close out scope of font prior to opening a macro
                    * scope.
                    */
                   if (HTMLFONT_NONE != h->metac) {
                           h->metal = h->metac;
                           h->metac = HTMLFONT_NONE;
                   }
   
                   /*
                    * Close out the current table, if it's open, and unset
                    * the "meta" table state.  This will be reopened on the
                    * next table element.
                    */
                   if (h->tblt) {
                           print_tblclose(h);
                           t = h->tags.head;
                   }
                   if (mans[n->tok].pre)
                           child = (*mans[n->tok].pre)(man, n, mh, h);
                   break;
           }
   
           if (child && n->child)
                   print_man_nodelist(man, n->child, mh, h);
   
           /* This will automatically close out any font scope. */
           print_stagq(h, t);
   
           switch (n->type) {
           case MAN_ROOT:
                   man_root_post(man, n, mh, h);
                   break;
           case MAN_EQN:
                   break;
           default:
                   if (mans[n->tok].post)
                           (*mans[n->tok].post)(man, n, mh, h);
                   break;
           }
   }
   
   static int
   a2width(const struct man_node *n, struct roffsu *su)
   {
   
           if (MAN_TEXT != n->type)
                   return(0);
           if (a2roffsu(n->string, su, SCALE_BU))
                   return(1);
   
           return(0);
   }
   
   static void
   man_root_pre(MAN_ARGS)
   {
           struct htmlpair  tag[3];
           struct tag      *t, *tt;
           char             b[BUFSIZ], title[BUFSIZ];
   
           b[0] = 0;
           if (man->vol)
                   (void)strlcat(b, man->vol, BUFSIZ);
   
           assert(man->title);
           assert(man->msec);
           snprintf(title, BUFSIZ - 1, "%s(%s)", man->title, man->msec);
   
           PAIR_SUMMARY_INIT(&tag[0], "Document Header");
           PAIR_CLASS_INIT(&tag[1], "head");
           PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
           t = print_otag(h, TAG_TABLE, 3, tag);
           PAIR_INIT(&tag[0], ATTR_WIDTH, "30%");
           print_otag(h, TAG_COL, 1, tag);
           print_otag(h, TAG_COL, 1, tag);
           print_otag(h, TAG_COL, 1, tag);
   
           print_otag(h, TAG_TBODY, 0, NULL);
   
           tt = print_otag(h, TAG_TR, 0, NULL);
   
           PAIR_CLASS_INIT(&tag[0], "head-ltitle");
           print_otag(h, TAG_TD, 1, tag);
           print_text(h, title);
           print_stagq(h, tt);
   
           PAIR_CLASS_INIT(&tag[0], "head-vol");
           PAIR_INIT(&tag[1], ATTR_ALIGN, "center");
           print_otag(h, TAG_TD, 2, tag);
           print_text(h, b);
           print_stagq(h, tt);
   
           PAIR_CLASS_INIT(&tag[0], "head-rtitle");
           PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
           print_otag(h, TAG_TD, 2, tag);
           print_text(h, title);
         print_tagq(h, t);          print_tagq(h, t);
         t = print_otag(h, TAG_BODY, 0, NULL);  }
   
         tag.key = ATTR_CLASS;  static void
         tag.val = "body";  man_root_post(MAN_ARGS)
         print_otag(h, TAG_DIV, 1, &tag);  {
           struct htmlpair  tag[3];
           struct tag      *t, *tt;
   
         /*print_man_nodelist(m, n, h);*/          PAIR_SUMMARY_INIT(&tag[0], "Document Footer");
           PAIR_CLASS_INIT(&tag[1], "foot");
           PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
           t = print_otag(h, TAG_TABLE, 3, tag);
           PAIR_INIT(&tag[0], ATTR_WIDTH, "50%");
           print_otag(h, TAG_COL, 1, tag);
           print_otag(h, TAG_COL, 1, tag);
   
           tt = print_otag(h, TAG_TR, 0, NULL);
   
           PAIR_CLASS_INIT(&tag[0], "foot-date");
           print_otag(h, TAG_TD, 1, tag);
   
           assert(man->date);
           print_text(h, man->date);
           print_stagq(h, tt);
   
           PAIR_CLASS_INIT(&tag[0], "foot-os");
           PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
           print_otag(h, TAG_TD, 2, tag);
   
           if (man->source)
                   print_text(h, man->source);
         print_tagq(h, t);          print_tagq(h, t);
 }  }
   
   
 /* ARGSUSED */  static int
 static void  man_br_pre(MAN_ARGS)
 print_man_head(MAN_ARGS)  
 {  {
           struct roffsu    su;
           struct htmlpair  tag;
   
         print_gen_head(h);          SCALE_VS_INIT(&su, 1);
   
           if (MAN_sp == n->tok) {
                   if (NULL != (n = n->child))
                           if ( ! a2roffsu(n->string, &su, SCALE_VS))
                                   SCALE_VS_INIT(&su, atoi(n->string));
           } else
                   su.scale = 0;
   
         bufinit(h);          bufinit(h);
         buffmt(h, "%s(%d)", m->title, m->msec);          bufcat_su(h, "height", &su);
           PAIR_STYLE_INIT(&tag, h);
           print_otag(h, TAG_DIV, 1, &tag);
   
         print_otag(h, TAG_TITLE, 0, NULL);          /* So the div isn't empty: */
         print_text(h, h->buf);          print_text(h, "\\~");
   
           return(0);
   }
   
   static int
   man_SH_pre(MAN_ARGS)
   {
           struct htmlpair  tag;
   
           if (MAN_BLOCK == n->type) {
                   mh->fl &= ~MANH_LITERAL;
                   PAIR_CLASS_INIT(&tag, "section");
                   print_otag(h, TAG_DIV, 1, &tag);
                   return(1);
           } else if (MAN_BODY == n->type)
                   return(1);
   
           print_otag(h, TAG_H1, 0, NULL);
           return(1);
   }
   
   static int
   man_alt_pre(MAN_ARGS)
   {
           const struct man_node   *nn;
           int              i, savelit;
           enum htmltag     fp;
           struct tag      *t;
   
           if ((savelit = mh->fl & MANH_LITERAL))
                   print_otag(h, TAG_BR, 0, NULL);
   
           mh->fl &= ~MANH_LITERAL;
   
           for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
                   t = NULL;
                   switch (n->tok) {
                   case MAN_BI:
                           fp = i % 2 ? TAG_I : TAG_B;
                           break;
                   case MAN_IB:
                           fp = i % 2 ? TAG_B : TAG_I;
                           break;
                   case MAN_RI:
                           fp = i % 2 ? TAG_I : TAG_MAX;
                           break;
                   case MAN_IR:
                           fp = i % 2 ? TAG_MAX : TAG_I;
                           break;
                   case MAN_BR:
                           fp = i % 2 ? TAG_MAX : TAG_B;
                           break;
                   case MAN_RB:
                           fp = i % 2 ? TAG_B : TAG_MAX;
                           break;
                   default:
                           abort();
                           /* NOTREACHED */
                   }
   
                   if (i)
                           h->flags |= HTML_NOSPACE;
   
                   if (TAG_MAX != fp)
                           t = print_otag(h, fp, 0, NULL);
   
                   print_man_node(man, nn, mh, h);
   
                   if (t)
                           print_tagq(h, t);
           }
   
           if (savelit)
                   mh->fl |= MANH_LITERAL;
   
           return(0);
   }
   
   static int
   man_SM_pre(MAN_ARGS)
   {
   
           print_otag(h, TAG_SMALL, 0, NULL);
           if (MAN_SB == n->tok)
                   print_otag(h, TAG_B, 0, NULL);
           return(1);
   }
   
   static int
   man_SS_pre(MAN_ARGS)
   {
           struct htmlpair  tag;
   
           if (MAN_BLOCK == n->type) {
                   mh->fl &= ~MANH_LITERAL;
                   PAIR_CLASS_INIT(&tag, "subsection");
                   print_otag(h, TAG_DIV, 1, &tag);
                   return(1);
           } else if (MAN_BODY == n->type)
                   return(1);
   
           print_otag(h, TAG_H2, 0, NULL);
           return(1);
   }
   
   static int
   man_PP_pre(MAN_ARGS)
   {
   
           if (MAN_HEAD == n->type)
                   return(0);
           else if (MAN_BLOCK == n->type)
                   print_bvspace(h, n);
   
           return(1);
   }
   
   static int
   man_IP_pre(MAN_ARGS)
   {
           const struct man_node   *nn;
   
           if (MAN_BODY == n->type) {
                   print_otag(h, TAG_DD, 0, NULL);
                   return(1);
           } else if (MAN_HEAD != n->type) {
                   print_otag(h, TAG_DL, 0, NULL);
                   return(1);
           }
   
           /* FIXME: width specification. */
   
           print_otag(h, TAG_DT, 0, NULL);
   
           /* For IP, only print the first header element. */
   
           if (MAN_IP == n->tok && n->child)
                   print_man_node(man, n->child, mh, h);
   
           /* For TP, only print next-line header elements. */
   
           if (MAN_TP == n->tok) {
                   nn = n->child;
                   while (NULL != nn && 0 == (MAN_LINE & nn->flags))
                           nn = nn->next;
                   while (NULL != nn) {
                           print_man_node(man, nn, mh, h);
                           nn = nn->next;
                   }
           }
   
           return(0);
   }
   
   static int
   man_HP_pre(MAN_ARGS)
   {
           struct htmlpair  tag;
           struct roffsu    su;
           const struct man_node *np;
   
           if (MAN_HEAD == n->type)
                   return(0);
           else if (MAN_BLOCK != n->type)
                   return(1);
   
           np = n->head->child;
   
           if (NULL == np || ! a2width(np, &su))
                   SCALE_HS_INIT(&su, INDENT);
   
           bufinit(h);
   
           print_bvspace(h, n);
           bufcat_su(h, "margin-left", &su);
           su.scale = -su.scale;
           bufcat_su(h, "text-indent", &su);
           PAIR_STYLE_INIT(&tag, h);
           print_otag(h, TAG_P, 1, &tag);
           return(1);
   }
   
   static int
   man_OP_pre(MAN_ARGS)
   {
           struct tag      *tt;
           struct htmlpair  tag;
   
           print_text(h, "[");
           h->flags |= HTML_NOSPACE;
           PAIR_CLASS_INIT(&tag, "opt");
           tt = print_otag(h, TAG_SPAN, 1, &tag);
   
           if (NULL != (n = n->child)) {
                   print_otag(h, TAG_B, 0, NULL);
                   print_text(h, n->string);
           }
   
           print_stagq(h, tt);
   
           if (NULL != n && NULL != n->next) {
                   print_otag(h, TAG_I, 0, NULL);
                   print_text(h, n->next->string);
           }
   
           print_stagq(h, tt);
           h->flags |= HTML_NOSPACE;
           print_text(h, "]");
           return(0);
   }
   
   static int
   man_B_pre(MAN_ARGS)
   {
   
           print_otag(h, TAG_B, 0, NULL);
           return(1);
   }
   
   static int
   man_I_pre(MAN_ARGS)
   {
   
           print_otag(h, TAG_I, 0, NULL);
           return(1);
   }
   
   static int
   man_literal_pre(MAN_ARGS)
   {
   
           if (MAN_fi == n->tok || MAN_EE == n->tok) {
                   print_otag(h, TAG_BR, 0, NULL);
                   mh->fl &= ~MANH_LITERAL;
           } else
                   mh->fl |= MANH_LITERAL;
   
           return(0);
   }
   
   static int
   man_in_pre(MAN_ARGS)
   {
   
           print_otag(h, TAG_BR, 0, NULL);
           return(0);
   }
   
   static int
   man_ign_pre(MAN_ARGS)
   {
   
           return(0);
   }
   
   static int
   man_RS_pre(MAN_ARGS)
   {
           struct htmlpair  tag;
           struct roffsu    su;
   
           if (MAN_HEAD == n->type)
                   return(0);
           else if (MAN_BODY == n->type)
                   return(1);
   
           SCALE_HS_INIT(&su, INDENT);
           if (n->head->child)
                   a2width(n->head->child, &su);
   
           bufinit(h);
           bufcat_su(h, "margin-left", &su);
           PAIR_STYLE_INIT(&tag, h);
           print_otag(h, TAG_DIV, 1, &tag);
           return(1);
   }
   
   static int
   man_UR_pre(MAN_ARGS)
   {
           struct htmlpair          tag[2];
   
           n = n->child;
           assert(MAN_HEAD == n->type);
           if (n->nchild) {
                   assert(MAN_TEXT == n->child->type);
                   PAIR_CLASS_INIT(&tag[0], "link-ext");
                   PAIR_HREF_INIT(&tag[1], n->child->string);
                   print_otag(h, TAG_A, 2, tag);
           }
   
           assert(MAN_BODY == n->next->type);
           if (n->next->nchild)
                   n = n->next;
   
           print_man_nodelist(man, n->child, mh, h);
   
           return(0);
 }  }
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.93
CVSweb