[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.2 and 1.125

version 1.2, 2009/10/03 15:08:09 version 1.125, 2017/01/19 01:00:14
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2013, 2014, 2015, 2017 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
  * 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.
  */   */
   #include "config.h"
   
 #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 "html.h"  #include "mandoc_aux.h"
   #include "roff.h"
 #include "man.h"  #include "man.h"
   #include "out.h"
   #include "html.h"
   #include "main.h"
   
   /* TODO: preserve ident widths. */
   /* FIXME: have PD set the default vspace width. */
   
 /* ARGSUSED */  #define INDENT            5
   
   #define MAN_ARGS          const struct roff_meta *man, \
                             const struct roff_node *n, \
                             struct mhtml *mh, \
                             struct html *h
   
   struct  mhtml {
           int               fl;
   #define MANH_LITERAL     (1 << 0) /* literal context */
   };
   
   struct  htmlman {
           int             (*pre)(MAN_ARGS);
           int             (*post)(MAN_ARGS);
   };
   
   static  void              print_bvspace(struct html *,
                                   const struct roff_node *);
   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 roff_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] = {
           { man_br_pre, NULL }, /* br */
           { NULL, NULL }, /* TH */
           { man_SH_pre, NULL }, /* SH */
           { man_SS_pre, NULL }, /* SS */
           { man_IP_pre, NULL }, /* TP */
           { man_PP_pre, NULL }, /* LP */
           { man_PP_pre, NULL }, /* PP */
           { man_PP_pre, NULL }, /* P */
           { man_IP_pre, NULL }, /* IP */
           { man_HP_pre, NULL }, /* HP */
           { man_SM_pre, NULL }, /* SM */
           { man_SM_pre, NULL }, /* SB */
           { man_alt_pre, NULL }, /* BI */
           { man_alt_pre, NULL }, /* IB */
           { man_alt_pre, NULL }, /* BR */
           { man_alt_pre, NULL }, /* RB */
           { NULL, NULL }, /* R */
           { man_B_pre, NULL }, /* B */
           { man_I_pre, NULL }, /* I */
           { man_alt_pre, NULL }, /* IR */
           { man_alt_pre, NULL }, /* RI */
           { man_br_pre, NULL }, /* sp */
           { man_literal_pre, NULL }, /* nf */
           { man_literal_pre, NULL }, /* fi */
           { NULL, NULL }, /* RE */
           { man_RS_pre, NULL }, /* RS */
           { man_ign_pre, NULL }, /* DT */
           { 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 roff_node *n)
   {
   
           if (n->body && n->body->child)
                   if (n->body->child->type == ROFFT_TBL)
                           return;
   
           if (n->parent->type == ROFFT_ROOT || n->parent->tok != MAN_RS)
                   if (NULL == n->prev)
                           return;
   
           print_paragraph(h);
   }
   
 void  void
 html_man(void *arg, const struct man *m)  html_man(void *arg, const struct roff_man *man)
 {  {
           struct mhtml     mh;
           struct html     *h;
           struct tag      *t, *tt;
   
           memset(&mh, 0, sizeof(mh));
           h = (struct html *)arg;
   
           if ( ! (HTML_FRAGMENT & h->oflags)) {
                   print_gen_decls(h);
                   t = print_otag(h, TAG_HTML, "");
                   tt = print_otag(h, TAG_HEAD, "");
                   print_man_head(&man->meta, man->first, &mh, h);
                   print_tagq(h, tt);
                   print_otag(h, TAG_BODY, "");
                   print_otag(h, TAG_DIV, "c", "mandoc");
           } else
                   t = print_otag(h, TAG_DIV, "c", "mandoc");
   
           print_man_nodelist(&man->meta, man->first, &mh, h);
           print_tagq(h, t);
   }
   
   static void
   print_man_head(MAN_ARGS)
   {
           char    *cp;
   
           print_gen_head(h);
           mandoc_asprintf(&cp, "%s(%s)", man->title, man->msec);
           print_otag(h, TAG_TITLE, "");
           print_text(h, cp);
           free(cp);
   }
   
   static void
   print_man_nodelist(MAN_ARGS)
   {
   
           while (n != NULL) {
                   print_man_node(man, n, mh, h);
                   n = n->next;
           }
   }
   
   static void
   print_man_node(MAN_ARGS)
   {
           int              child;
           struct tag      *t;
   
           child = 1;
           t = h->tags.head;
   
           switch (n->type) {
           case ROFFT_ROOT:
                   man_root_pre(man, n, mh, h);
                   break;
           case ROFFT_TEXT:
                   if ('\0' == *n->string) {
                           print_paragraph(h);
                           return;
                   }
                   if (n->flags & NODE_LINE && (*n->string == ' ' ||
                       (n->prev != NULL && mh->fl & MANH_LITERAL &&
                        ! (h->flags & HTML_NONEWLINE))))
                           print_otag(h, TAG_BR, "");
                   print_text(h, n->string);
                   return;
           case ROFFT_EQN:
                   print_eqn(h, n->eqn);
                   break;
           case ROFFT_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 ROFFT_ROOT:
                   man_root_post(man, n, mh, h);
                   break;
           case ROFFT_EQN:
                   break;
           default:
                   if (mans[n->tok].post)
                           (*mans[n->tok].post)(man, n, mh, h);
                   break;
           }
   }
   
   static int
   a2width(const struct roff_node *n, struct roffsu *su)
   {
   
           if (n->type != ROFFT_TEXT)
                   return 0;
           if (a2roffsu(n->string, su, SCALE_EN))
                   return 1;
   
           return 0;
   }
   
   static void
   man_root_pre(MAN_ARGS)
   {
           struct tag      *t, *tt;
           char            *title;
   
           assert(man->title);
           assert(man->msec);
           mandoc_asprintf(&title, "%s(%s)", man->title, man->msec);
   
           t = print_otag(h, TAG_TABLE, "c", "head");
           print_otag(h, TAG_TBODY, "");
           tt = print_otag(h, TAG_TR, "");
   
           print_otag(h, TAG_TD, "c", "head-ltitle");
           print_text(h, title);
           print_stagq(h, tt);
   
           print_otag(h, TAG_TD, "c", "head-vol");
           if (NULL != man->vol)
                   print_text(h, man->vol);
           print_stagq(h, tt);
   
           print_otag(h, TAG_TD, "c", "head-rtitle");
           print_text(h, title);
           print_tagq(h, t);
           free(title);
   }
   
   static void
   man_root_post(MAN_ARGS)
   {
           struct tag      *t, *tt;
   
           t = print_otag(h, TAG_TABLE, "c", "foot");
           tt = print_otag(h, TAG_TR, "");
   
           print_otag(h, TAG_TD, "c", "foot-date");
           print_text(h, man->date);
           print_stagq(h, tt);
   
           print_otag(h, TAG_TD, "c", "foot-os");
           if (man->os)
                   print_text(h, man->os);
           print_tagq(h, t);
   }
   
   
   static int
   man_br_pre(MAN_ARGS)
   {
           struct roffsu    su;
   
           SCALE_VS_INIT(&su, 1);
   
           if (MAN_sp == n->tok) {
                   if (NULL != (n = n->child))
                           if ( ! a2roffsu(n->string, &su, SCALE_VS))
                                   su.scale = 1.0;
           } else
                   su.scale = 0.0;
   
           print_otag(h, TAG_DIV, "suh", &su);
   
           /* So the div isn't empty: */
           print_text(h, "\\~");
   
           return 0;
   }
   
   static int
   man_SH_pre(MAN_ARGS)
   {
           if (n->type == ROFFT_BLOCK) {
                   mh->fl &= ~MANH_LITERAL;
                   print_otag(h, TAG_DIV, "c", "section");
                   return 1;
           } else if (n->type == ROFFT_BODY)
                   return 1;
   
           print_otag(h, TAG_H1, "");
           return 1;
   }
   
   static int
   man_alt_pre(MAN_ARGS)
   {
           const struct roff_node  *nn;
           int              i, savelit;
           enum htmltag     fp;
           struct tag      *t;
   
           if ((savelit = mh->fl & MANH_LITERAL))
                   print_otag(h, TAG_BR, "");
   
           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();
                   }
   
                   if (i)
                           h->flags |= HTML_NOSPACE;
   
                   if (TAG_MAX != fp)
                           t = print_otag(h, fp, "");
   
                   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, "");
           if (MAN_SB == n->tok)
                   print_otag(h, TAG_B, "");
           return 1;
   }
   
   static int
   man_SS_pre(MAN_ARGS)
   {
           if (n->type == ROFFT_BLOCK) {
                   mh->fl &= ~MANH_LITERAL;
                   print_otag(h, TAG_DIV, "c", "subsection");
                   return 1;
           } else if (n->type == ROFFT_BODY)
                   return 1;
   
           print_otag(h, TAG_H2, "");
           return 1;
   }
   
   static int
   man_PP_pre(MAN_ARGS)
   {
   
           if (n->type == ROFFT_HEAD)
                   return 0;
           else if (n->type == ROFFT_BLOCK)
                   print_bvspace(h, n);
   
           return 1;
   }
   
   static int
   man_IP_pre(MAN_ARGS)
   {
           const struct roff_node  *nn;
   
           if (n->type == ROFFT_BODY) {
                   print_otag(h, TAG_DD, "");
                   return 1;
           } else if (n->type != ROFFT_HEAD) {
                   print_otag(h, TAG_DL, "");
                   return 1;
           }
   
           /* FIXME: width specification. */
   
           print_otag(h, TAG_DT, "");
   
           /* 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 == (NODE_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 roffsu    sum, sui;
           const struct roff_node *np;
   
           if (n->type == ROFFT_HEAD)
                   return 0;
           else if (n->type != ROFFT_BLOCK)
                   return 1;
   
           np = n->head->child;
   
           if (np == NULL || !a2width(np, &sum))
                   SCALE_HS_INIT(&sum, INDENT);
   
           sui.unit = sum.unit;
           sui.scale = -sum.scale;
   
           print_bvspace(h, n);
           print_otag(h, TAG_DIV, "csului", "spacer", &sum, &sui);
           return 1;
   }
   
   static int
   man_OP_pre(MAN_ARGS)
   {
           struct tag      *tt;
   
           print_text(h, "[");
           h->flags |= HTML_NOSPACE;
           tt = print_otag(h, TAG_SPAN, "c", "opt");
   
           if (NULL != (n = n->child)) {
                   print_otag(h, TAG_B, "");
                   print_text(h, n->string);
           }
   
           print_stagq(h, tt);
   
           if (NULL != n && NULL != n->next) {
                   print_otag(h, TAG_I, "");
                   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, "");
           return 1;
   }
   
   static int
   man_I_pre(MAN_ARGS)
   {
           print_otag(h, TAG_I, "");
           return 1;
   }
   
   static int
   man_literal_pre(MAN_ARGS)
   {
   
           if (MAN_fi == n->tok || MAN_EE == n->tok) {
                   print_otag(h, TAG_BR, "");
                   mh->fl &= ~MANH_LITERAL;
           } else
                   mh->fl |= MANH_LITERAL;
   
           return 0;
   }
   
   static int
   man_in_pre(MAN_ARGS)
   {
           print_otag(h, TAG_BR, "");
           return 0;
   }
   
   static int
   man_ign_pre(MAN_ARGS)
   {
   
           return 0;
   }
   
   static int
   man_RS_pre(MAN_ARGS)
   {
           struct roffsu    su;
   
           if (n->type == ROFFT_HEAD)
                   return 0;
           else if (n->type == ROFFT_BODY)
                   return 1;
   
           SCALE_HS_INIT(&su, INDENT);
           if (n->head->child)
                   a2width(n->head->child, &su);
   
           print_otag(h, TAG_DIV, "sul", &su);
           return 1;
   }
   
   static int
   man_UR_pre(MAN_ARGS)
   {
           n = n->child;
           assert(n->type == ROFFT_HEAD);
           if (n->child != NULL) {
                   assert(n->child->type == ROFFT_TEXT);
                   print_otag(h, TAG_A, "ch", "link-ext", n->child->string);
           }
   
           assert(n->next->type == ROFFT_BODY);
           if (n->next->child != NULL)
                   n = n->next;
   
           print_man_nodelist(man, n->child, mh, h);
   
           return 0;
 }  }
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.125
CVSweb