[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.143 and 1.163

version 1.143, 2017/06/08 12:54:58 version 1.163, 2019/01/05 09:14:44
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2013, 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2013-2015, 2017-2019 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 26 
Line 26 
 #include <string.h>  #include <string.h>
   
 #include "mandoc_aux.h"  #include "mandoc_aux.h"
   #include "mandoc.h"
 #include "roff.h"  #include "roff.h"
 #include "man.h"  #include "man.h"
 #include "out.h"  #include "out.h"
Line 34 
Line 35 
   
 /* FIXME: have PD set the default vspace width. */  /* FIXME: have PD set the default vspace width. */
   
 #define INDENT            5  
   
 #define MAN_ARGS          const struct roff_meta *man, \  #define MAN_ARGS          const struct roff_meta *man, \
                           const struct roff_node *n, \                            const struct roff_node *n, \
                           struct html *h                            struct html *h
   
 struct  htmlman {  struct  man_html_act {
         int             (*pre)(MAN_ARGS);          int             (*pre)(MAN_ARGS);
         int             (*post)(MAN_ARGS);          int             (*post)(MAN_ARGS);
 };  };
   
 static  void              print_bvspace(struct html *,  static  void              print_bvspace(struct html *,
                                 const struct roff_node *);                                  const struct roff_node *);
 static  void              print_man_head(MAN_ARGS);  static  void              print_man_head(const struct roff_meta *,
                                   struct html *);
 static  void              print_man_nodelist(MAN_ARGS);  static  void              print_man_nodelist(MAN_ARGS);
 static  void              print_man_node(MAN_ARGS);  static  void              print_man_node(MAN_ARGS);
 static  int               fillmode(struct html *, int);  
 static  int               a2width(const struct roff_node *,  
                                 struct roffsu *);  
 static  int               man_B_pre(MAN_ARGS);  static  int               man_B_pre(MAN_ARGS);
 static  int               man_HP_pre(MAN_ARGS);  static  int               man_HP_pre(MAN_ARGS);
 static  int               man_IP_pre(MAN_ARGS);  static  int               man_IP_pre(MAN_ARGS);
Line 63  static int    man_RS_pre(MAN_ARGS);
Line 60  static int    man_RS_pre(MAN_ARGS);
 static  int               man_SH_pre(MAN_ARGS);  static  int               man_SH_pre(MAN_ARGS);
 static  int               man_SM_pre(MAN_ARGS);  static  int               man_SM_pre(MAN_ARGS);
 static  int               man_SS_pre(MAN_ARGS);  static  int               man_SS_pre(MAN_ARGS);
   static  int               man_SY_pre(MAN_ARGS);
 static  int               man_UR_pre(MAN_ARGS);  static  int               man_UR_pre(MAN_ARGS);
   static  int               man_abort_pre(MAN_ARGS);
 static  int               man_alt_pre(MAN_ARGS);  static  int               man_alt_pre(MAN_ARGS);
 static  int               man_ign_pre(MAN_ARGS);  static  int               man_ign_pre(MAN_ARGS);
 static  int               man_in_pre(MAN_ARGS);  static  int               man_in_pre(MAN_ARGS);
 static  void              man_root_post(MAN_ARGS);  static  void              man_root_post(const struct roff_meta *,
 static  void              man_root_pre(MAN_ARGS);                                  struct html *);
   static  void              man_root_pre(const struct roff_meta *,
                                   struct html *);
   
 static  const struct htmlman __mans[MAN_MAX - MAN_TH] = {  static  const struct man_html_act man_html_acts[MAN_MAX - MAN_TH] = {
         { NULL, NULL }, /* TH */          { NULL, NULL }, /* TH */
         { man_SH_pre, NULL }, /* SH */          { man_SH_pre, NULL }, /* SH */
         { man_SS_pre, NULL }, /* SS */          { man_SS_pre, NULL }, /* SS */
         { man_IP_pre, NULL }, /* TP */          { man_IP_pre, NULL }, /* TP */
         { man_PP_pre, NULL }, /* LP */          { man_IP_pre, NULL }, /* TQ */
           { man_abort_pre, NULL }, /* LP */
         { man_PP_pre, NULL }, /* PP */          { man_PP_pre, NULL }, /* PP */
         { man_PP_pre, NULL }, /* P */          { man_abort_pre, NULL }, /* P */
         { man_IP_pre, NULL }, /* IP */          { man_IP_pre, NULL }, /* IP */
         { man_HP_pre, NULL }, /* HP */          { man_HP_pre, NULL }, /* HP */
         { man_SM_pre, NULL }, /* SM */          { man_SM_pre, NULL }, /* SM */
Line 91  static const struct htmlman __mans[MAN_MAX - MAN_TH] =
Line 93  static const struct htmlman __mans[MAN_MAX - MAN_TH] =
         { man_I_pre, NULL }, /* I */          { man_I_pre, NULL }, /* I */
         { man_alt_pre, NULL }, /* IR */          { man_alt_pre, NULL }, /* IR */
         { man_alt_pre, NULL }, /* RI */          { man_alt_pre, NULL }, /* RI */
         { NULL, NULL }, /* nf */  
         { NULL, NULL }, /* fi */  
         { NULL, NULL }, /* RE */          { NULL, NULL }, /* RE */
         { man_RS_pre, NULL }, /* RS */          { man_RS_pre, NULL }, /* RS */
         { man_ign_pre, NULL }, /* DT */          { man_ign_pre, NULL }, /* DT */
Line 100  static const struct htmlman __mans[MAN_MAX - MAN_TH] =
Line 100  static const struct htmlman __mans[MAN_MAX - MAN_TH] =
         { man_ign_pre, NULL }, /* PD */          { man_ign_pre, NULL }, /* PD */
         { man_ign_pre, NULL }, /* AT */          { man_ign_pre, NULL }, /* AT */
         { man_in_pre, NULL }, /* in */          { man_in_pre, NULL }, /* in */
           { man_SY_pre, NULL }, /* SY */
           { NULL, NULL }, /* YS */
         { man_OP_pre, NULL }, /* OP */          { man_OP_pre, NULL }, /* OP */
         { NULL, NULL }, /* EX */          { NULL, NULL }, /* EX */
         { NULL, NULL }, /* EE */          { NULL, NULL }, /* EE */
         { man_UR_pre, NULL }, /* UR */          { man_UR_pre, NULL }, /* UR */
         { NULL, NULL }, /* UE */          { NULL, NULL }, /* UE */
           { man_UR_pre, NULL }, /* MT */
           { NULL, NULL }, /* ME */
 };  };
 static  const struct htmlman *const mans = __mans - MAN_TH;  
   
   
 /*  /*
Line 133  print_bvspace(struct html *h, const struct roff_node *
Line 136  print_bvspace(struct html *h, const struct roff_node *
 }  }
   
 void  void
 html_man(void *arg, const struct roff_man *man)  html_man(void *arg, const struct roff_meta *man)
 {  {
         struct html     *h;          struct html             *h;
         struct tag      *t;          struct roff_node        *n;
           struct tag              *t;
   
         h = (struct html *)arg;          h = (struct html *)arg;
           n = man->first->child;
   
         if ((h->oflags & HTML_FRAGMENT) == 0) {          if ((h->oflags & HTML_FRAGMENT) == 0) {
                 print_gen_decls(h);                  print_gen_decls(h);
                 print_otag(h, TAG_HTML, "");                  print_otag(h, TAG_HTML, "");
                   if (n->type == ROFFT_COMMENT)
                           print_gen_comment(h, n);
                 t = print_otag(h, TAG_HEAD, "");                  t = print_otag(h, TAG_HEAD, "");
                 print_man_head(&man->meta, man->first, h);                  print_man_head(man, h);
                 print_tagq(h, t);                  print_tagq(h, t);
                 print_otag(h, TAG_BODY, "");                  print_otag(h, TAG_BODY, "");
         }          }
   
         man_root_pre(&man->meta, man->first, h);          man_root_pre(man, h);
         t = print_otag(h, TAG_DIV, "c", "manual-text");          t = print_otag(h, TAG_DIV, "c", "manual-text");
         print_man_nodelist(&man->meta, man->first->child, h);          print_man_nodelist(man, n, h);
         print_tagq(h, t);          print_tagq(h, t);
         man_root_post(&man->meta, man->first, h);          man_root_post(man, h);
         print_tagq(h, NULL);          print_tagq(h, NULL);
 }  }
   
 static void  static void
 print_man_head(MAN_ARGS)  print_man_head(const struct roff_meta *man, struct html *h)
 {  {
         char    *cp;          char    *cp;
   
Line 182  print_man_nodelist(MAN_ARGS)
Line 189  print_man_nodelist(MAN_ARGS)
 static void  static void
 print_man_node(MAN_ARGS)  print_man_node(MAN_ARGS)
 {  {
         static int       want_fillmode = MAN_fi;  
         static int       save_fillmode;  
   
         struct tag      *t;          struct tag      *t;
         int              child;          int              child;
   
         /*          html_fillmode(h, n->flags & NODE_NOFILL ? ROFF_nf : ROFF_fi);
          * Handle fill mode switch requests up front,  
          * they would just cause trouble in the subsequent code.  
          */  
   
         switch (n->tok) {  
         case MAN_nf:  
         case MAN_EX:  
                 want_fillmode = MAN_nf;  
                 return;  
         case MAN_fi:  
         case MAN_EE:  
                 want_fillmode = MAN_fi;  
                 if (fillmode(h, 0) == MAN_fi)  
                         print_otag(h, TAG_BR, "");  
                 return;  
         default:  
                 break;  
         }  
   
         /* Set up fill mode for the upcoming node. */  
   
         switch (n->type) {  
         case ROFFT_BLOCK:  
                 save_fillmode = 0;  
                 /* Some block macros suspend or cancel .nf. */  
                 switch (n->tok) {  
                 case MAN_TP:  /* Tagged paragraphs              */  
                 case MAN_IP:  /* temporarily disable .nf        */  
                 case MAN_HP:  /* for the head.                  */  
                         save_fillmode = want_fillmode;  
                         /* FALLTHROUGH */  
                 case MAN_SH:  /* Section headers                */  
                 case MAN_SS:  /* permanently cancel .nf.        */  
                         want_fillmode = MAN_fi;  
                         /* FALLTHROUGH */  
                 case MAN_PP:  /* These have no head.            */  
                 case MAN_LP:  /* They will simply               */  
                 case MAN_P:   /* reopen .nf in the body.        */  
                 case MAN_RS:  
                 case MAN_UR:  
                         fillmode(h, MAN_fi);  
                         break;  
                 default:  
                         break;  
                 }  
                 break;  
         case ROFFT_TBL:  
                 fillmode(h, MAN_fi);  
                 break;  
         case ROFFT_ELEM:  
                 /*  
                  * Some in-line macros produce tags and/or text  
                  * in the handler, so they require fill mode to be  
                  * configured up front just like for text nodes.  
                  * For the others, keep the traditional approach  
                  * of doing the same, for now.  
                  */  
                 fillmode(h, want_fillmode);  
                 break;  
         case ROFFT_TEXT:  
                 if (fillmode(h, want_fillmode) == MAN_fi &&  
                     want_fillmode == MAN_fi &&  
                     n->flags & NODE_LINE && *n->string == ' ' &&  
                     (h->flags & HTML_NONEWLINE) == 0)  
                         print_otag(h, TAG_BR, "");  
                 if (*n->string != '\0')  
                         break;  
                 print_paragraph(h);  
                 return;  
         default:  
                 break;  
         }  
   
         /* Produce output for this node. */  
   
         child = 1;          child = 1;
         switch (n->type) {          switch (n->type) {
         case ROFFT_TEXT:          case ROFFT_TEXT:
                   if (*n->string == '\0') {
                           print_endline(h);
                           return;
                   }
                 t = h->tag;                  t = h->tag;
                   if (*n->string == ' ' && n->flags & NODE_LINE &&
                       (h->flags & HTML_NONEWLINE) == 0)
                           print_endline(h);
                   else if (n->flags & NODE_DELIMC)
                           h->flags |= HTML_NOSPACE;
                 print_text(h, n->string);                  print_text(h, n->string);
                 break;                  break;
           case ROFFT_COMMENT:
                   return;
         case ROFFT_EQN:          case ROFFT_EQN:
                 t = h->tag;                  t = h->tag;
                 print_eqn(h, n->eqn);                  print_eqn(h, n->eqn);
Line 303  print_man_node(MAN_ARGS)
Line 244  print_man_node(MAN_ARGS)
                 t = h->tag;                  t = h->tag;
                 if (n->tok < ROFF_MAX) {                  if (n->tok < ROFF_MAX) {
                         roff_html_pre(h, n);                          roff_html_pre(h, n);
                         child = 0;                          print_stagq(h, t);
                         break;                          return;
                 }                  }
   
                 assert(n->tok >= MAN_TH && n->tok < MAN_MAX);                  assert(n->tok >= MAN_TH && n->tok < MAN_MAX);
                 if (mans[n->tok].pre)                  if (man_html_acts[n->tok - MAN_TH].pre != NULL)
                         child = (*mans[n->tok].pre)(man, n, h);                          child = (*man_html_acts[n->tok - MAN_TH].pre)(man,
                               n, h);
                 /* Some block macros resume .nf in the body. */  
                 if (save_fillmode && n->type == ROFFT_BODY)  
                         want_fillmode = save_fillmode;  
   
                 break;                  break;
         }          }
   
Line 324  print_man_node(MAN_ARGS)
Line 261  print_man_node(MAN_ARGS)
         /* This will automatically close out any font scope. */          /* This will automatically close out any font scope. */
         print_stagq(h, t);          print_stagq(h, t);
   
         if (fillmode(h, 0) == MAN_nf &&          if (n->flags & NODE_NOFILL &&
             n->next != NULL && n->next->flags & NODE_LINE)              (n->next == NULL || n->next->flags & NODE_LINE)) {
                   /* In .nf = <pre>, print even empty lines. */
                   h->col++;
                 print_endline(h);                  print_endline(h);
 }  
   
 /*  
  * MAN_nf switches to no-fill mode, MAN_fi to fill mode.  
  * Other arguments do not switch.  
  * The old mode is returned.  
  */  
 static int  
 fillmode(struct html *h, int want)  
 {  
         struct tag      *pre;  
         int              had;  
   
         for (pre = h->tag; pre != NULL; pre = pre->next)  
                 if (pre->tag == TAG_PRE)  
                         break;  
   
         had = pre == NULL ? MAN_fi : MAN_nf;  
   
         if (want && want != had) {  
                 if (want == MAN_nf)  
                         print_otag(h, TAG_PRE, "");  
                 else  
                         print_tagq(h, pre);  
         }          }
         return had;  
 }  }
   
 static int  
 a2width(const struct roff_node *n, struct roffsu *su)  
 {  
         if (n->type != ROFFT_TEXT)  
                 return 0;  
         return a2roffsu(n->string, su, SCALE_EN) != NULL;  
 }  
   
 static void  static void
 man_root_pre(MAN_ARGS)  man_root_pre(const struct roff_meta *man, struct html *h)
 {  {
         struct tag      *t, *tt;          struct tag      *t, *tt;
         char            *title;          char            *title;
Line 392  man_root_pre(MAN_ARGS)
Line 298  man_root_pre(MAN_ARGS)
 }  }
   
 static void  static void
 man_root_post(MAN_ARGS)  man_root_post(const struct roff_meta *man, struct html *h)
 {  {
         struct tag      *t, *tt;          struct tag      *t, *tt;
   
Line 415  man_SH_pre(MAN_ARGS)
Line 321  man_SH_pre(MAN_ARGS)
         char    *id;          char    *id;
   
         if (n->type == ROFFT_HEAD) {          if (n->type == ROFFT_HEAD) {
                 id = html_make_id(n);                  id = html_make_id(n, 1);
                 print_otag(h, TAG_H1, "cTi", "Sh", id);                  print_otag(h, TAG_H1, "cTi", "Sh", id);
                 if (id != NULL)                  if (id != NULL)
                         print_otag(h, TAG_A, "chR", "selflink", id);                          print_otag(h, TAG_A, "chR", "permalink", id);
                 free(id);  
         }          }
         return 1;          return 1;
 }  }
Line 485  man_SS_pre(MAN_ARGS)
Line 390  man_SS_pre(MAN_ARGS)
         char    *id;          char    *id;
   
         if (n->type == ROFFT_HEAD) {          if (n->type == ROFFT_HEAD) {
                 id = html_make_id(n);                  id = html_make_id(n, 1);
                 print_otag(h, TAG_H2, "cTi", "Ss", id);                  print_otag(h, TAG_H2, "cTi", "Ss", id);
                 if (id != NULL)                  if (id != NULL)
                         print_otag(h, TAG_A, "chR", "selflink", id);                          print_otag(h, TAG_A, "chR", "permalink", id);
                 free(id);  
         }          }
         return 1;          return 1;
 }  }
Line 512  man_IP_pre(MAN_ARGS)
Line 416  man_IP_pre(MAN_ARGS)
         const struct roff_node  *nn;          const struct roff_node  *nn;
   
         if (n->type == ROFFT_BODY) {          if (n->type == ROFFT_BODY) {
                 print_otag(h, TAG_DD, "c", "It-tag");                  print_otag(h, TAG_DD, "");
                 return 1;                  return 1;
         } else if (n->type != ROFFT_HEAD) {          } else if (n->type != ROFFT_HEAD) {
                 print_otag(h, TAG_DL, "c", "Bl-tag");                  print_otag(h, TAG_DL, "c", "Bl-tag");
                 return 1;                  return 1;
         }          }
   
         /* FIXME: width specification. */          print_otag(h, TAG_DT, "");
   
         print_otag(h, TAG_DT, "c", "It-tag");          switch(n->tok) {
           case MAN_IP:  /* Only print the first header element. */
         /* For IP, only print the first header element. */                  if (n->child != NULL)
                           print_man_node(man, n->child, h);
         if (MAN_IP == n->tok && n->child)                  break;
                 print_man_node(man, n->child, h);          case MAN_TP:  /* Only print next-line header elements. */
           case MAN_TQ:
         /* For TP, only print next-line header elements. */  
   
         if (MAN_TP == n->tok) {  
                 nn = n->child;                  nn = n->child;
                 while (NULL != nn && 0 == (NODE_LINE & nn->flags))                  while (nn != NULL && (NODE_LINE & nn->flags) == 0)
                         nn = nn->next;                          nn = nn->next;
                 while (NULL != nn) {                  while (nn != NULL) {
                         print_man_node(man, nn, h);                          print_man_node(man, nn, h);
                         nn = nn->next;                          nn = nn->next;
                 }                  }
                   break;
           default:
                   abort();
         }          }
   
         return 0;          return 0;
Line 546  man_IP_pre(MAN_ARGS)
Line 450  man_IP_pre(MAN_ARGS)
 static int  static int
 man_HP_pre(MAN_ARGS)  man_HP_pre(MAN_ARGS)
 {  {
         struct roffsu    sum, sui;  
         const struct roff_node *np;  
   
         if (n->type == ROFFT_HEAD)          if (n->type == ROFFT_HEAD)
                 return 0;                  return 0;
         else if (n->type != ROFFT_BLOCK)  
                 return 1;  
   
         np = n->head->child;          if (n->type == ROFFT_BLOCK) {
                   print_bvspace(h, n);
         if (np == NULL || !a2width(np, &sum))                  print_otag(h, TAG_DIV, "c", "HP");
                 SCALE_HS_INIT(&sum, INDENT);          }
   
         sui.unit = sum.unit;  
         sui.scale = -sum.scale;  
   
         print_bvspace(h, n);  
         print_otag(h, TAG_DIV, "csului", "Pp", &sum, &sui);  
         return 1;          return 1;
 }  }
   
Line 625  man_ign_pre(MAN_ARGS)
Line 518  man_ign_pre(MAN_ARGS)
 static int  static int
 man_RS_pre(MAN_ARGS)  man_RS_pre(MAN_ARGS)
 {  {
         struct roffsu    su;  
   
         if (n->type == ROFFT_HEAD)          if (n->type == ROFFT_HEAD)
                 return 0;                  return 0;
         else if (n->type == ROFFT_BODY)          if (n->type == ROFFT_BLOCK)
                 return 1;                  print_otag(h, TAG_DIV, "c", "Bd-indent");
           return 1;
   }
   
         SCALE_HS_INIT(&su, INDENT);  static int
         if (n->head->child)  man_SY_pre(MAN_ARGS)
                 a2width(n->head->child, &su);  {
           switch (n->type) {
         print_otag(h, TAG_DIV, "sul", &su);          case ROFFT_BLOCK:
                   print_otag(h, TAG_TABLE, "c", "Nm");
                   print_otag(h, TAG_TR, "");
                   break;
           case ROFFT_HEAD:
                   print_otag(h, TAG_TD, "");
                   print_otag(h, TAG_CODE, "cT", "Nm");
                   break;
           case ROFFT_BODY:
                   print_otag(h, TAG_TD, "");
                   break;
           default:
                   abort();
           }
         return 1;          return 1;
 }  }
   
 static int  static int
 man_UR_pre(MAN_ARGS)  man_UR_pre(MAN_ARGS)
 {  {
           char *cp;
         n = n->child;          n = n->child;
         assert(n->type == ROFFT_HEAD);          assert(n->type == ROFFT_HEAD);
         if (n->child != NULL) {          if (n->child != NULL) {
                 assert(n->child->type == ROFFT_TEXT);                  assert(n->child->type == ROFFT_TEXT);
                 print_otag(h, TAG_A, "cTh", "Lk", n->child->string);                  if (n->tok == MAN_MT) {
                           mandoc_asprintf(&cp, "mailto:%s", n->child->string);
                           print_otag(h, TAG_A, "cTh", "Mt", cp);
                           free(cp);
                   } else
                           print_otag(h, TAG_A, "cTh", "Lk", n->child->string);
         }          }
   
         assert(n->next->type == ROFFT_BODY);          assert(n->next->type == ROFFT_BODY);
Line 657  man_UR_pre(MAN_ARGS)
Line 569  man_UR_pre(MAN_ARGS)
         print_man_nodelist(man, n->child, h);          print_man_nodelist(man, n->child, h);
   
         return 0;          return 0;
   }
   
   static int
   man_abort_pre(MAN_ARGS)
   {
           abort();
 }  }

Legend:
Removed from v.1.143  
changed lines
  Added in v.1.163

CVSweb