man_html.c

   1 /*      $Id: man_html.c,v 1.84 2011/11/18 17:05:50 joerg Exp $ */
   2 /*
   3  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17 #ifdef HAVE_CONFIG_H
  18 #include "config.h"
  19 #endif
  20
  21 #include <sys/types.h>
  22
  23 #include <assert.h>
  24 #include <ctype.h>
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28
  29 #include "mandoc.h"
  30 #include "out.h"
  31 #include "html.h"
  32 #include "man.h"
  33 #include "main.h"
  34
  35 /* TODO: preserve ident widths. */
  36 /* FIXME: have PD set the default vspace width. */
  37
  38 #define INDENT            5
  39
  40 #define MAN_ARGS          const struct man_meta *m, \
  41                           const struct man_node *n, \
  42                           struct mhtml *mh, \
  43                           struct html *h
  44
  45 struct  mhtml {
  46         int               fl;
  47 #define MANH_LITERAL     (1 << 0) /* literal context */
  48 };
  49
  50 struct  htmlman {
  51         int             (*pre)(MAN_ARGS);
  52         int             (*post)(MAN_ARGS);
  53 };
  54
  55 static  void              print_bvspace(struct html *,
  56                                 const struct man_node *);
  57 static  void              print_man(MAN_ARGS);
  58 static  void              print_man_head(MAN_ARGS);
  59 static  void              print_man_nodelist(MAN_ARGS);
  60 static  void              print_man_node(MAN_ARGS);
  61
  62 static  int               a2width(const struct man_node *,
  63                                 struct roffsu *);
  64
  65 static  int               man_alt_pre(MAN_ARGS);
  66 static  int               man_br_pre(MAN_ARGS);
  67 static  int               man_ign_pre(MAN_ARGS);
  68 static  int               man_in_pre(MAN_ARGS);
  69 static  int               man_literal_pre(MAN_ARGS);
  70 static  void              man_root_post(MAN_ARGS);
  71 static  void              man_root_pre(MAN_ARGS);
  72 static  int               man_B_pre(MAN_ARGS);
  73 static  int               man_HP_pre(MAN_ARGS);
  74 static  int               man_I_pre(MAN_ARGS);
  75 static  int               man_IP_pre(MAN_ARGS);
  76 static  int               man_PP_pre(MAN_ARGS);
  77 static  int               man_RS_pre(MAN_ARGS);
  78 static  int               man_SH_pre(MAN_ARGS);
  79 static  int               man_SM_pre(MAN_ARGS);
  80 static  int               man_SS_pre(MAN_ARGS);
  81
  82 static  const struct htmlman mans[MAN_MAX] = {
  83         { man_br_pre, NULL }, /* br */
  84         { NULL, NULL }, /* TH */
  85         { man_SH_pre, NULL }, /* SH */
  86         { man_SS_pre, NULL }, /* SS */
  87         { man_IP_pre, NULL }, /* TP */
  88         { man_PP_pre, NULL }, /* LP */
  89         { man_PP_pre, NULL }, /* PP */
  90         { man_PP_pre, NULL }, /* P */
  91         { man_IP_pre, NULL }, /* IP */
  92         { man_HP_pre, NULL }, /* HP */
  93         { man_SM_pre, NULL }, /* SM */
  94         { man_SM_pre, NULL }, /* SB */
  95         { man_alt_pre, NULL }, /* BI */
  96         { man_alt_pre, NULL }, /* IB */
  97         { man_alt_pre, NULL }, /* BR */
  98         { man_alt_pre, NULL }, /* RB */
  99         { NULL, NULL }, /* R */
 100         { man_B_pre, NULL }, /* B */
 101         { man_I_pre, NULL }, /* I */
 102         { man_alt_pre, NULL }, /* IR */
 103         { man_alt_pre, NULL }, /* RI */
 104         { man_ign_pre, NULL }, /* na */
 105         { man_br_pre, NULL }, /* sp */
 106         { man_literal_pre, NULL }, /* nf */
 107         { man_literal_pre, NULL }, /* fi */
 108         { NULL, NULL }, /* RE */
 109         { man_RS_pre, NULL }, /* RS */
 110         { man_ign_pre, NULL }, /* DT */
 111         { man_ign_pre, NULL }, /* UC */
 112         { man_ign_pre, NULL }, /* PD */
 113         { man_ign_pre, NULL }, /* AT */
 114         { man_in_pre, NULL }, /* in */
 115         { man_ign_pre, NULL }, /* ft */
 116 };
 117
 118 /*
 119  * Printing leading vertical space before a block.
 120  * This is used for the paragraph macros.
 121  * The rules are pretty simple, since there's very little nesting going
 122  * on here.  Basically, if we're the first within another block (SS/SH),
 123  * then don't emit vertical space.  If we are (RS), then do.  If not the
 124  * first, print it.
 125  */
 126 static void
 127 print_bvspace(struct html *h, const struct man_node *n)
 128 {
 129
 130         if (n->body && n->body->child)
 131                 if (MAN_TBL == n->body->child->type)
 132                         return;
 133
 134         if (MAN_ROOT == n->parent->type || MAN_RS != n->parent->tok)
 135                 if (NULL == n->prev)
 136                         return;
 137
 138         print_otag(h, TAG_P, 0, NULL);
 139 }
 140
 141 void
 142 html_man(void *arg, const struct man *m)
 143 {
 144         struct mhtml     mh;
 145
 146         memset(&mh, 0, sizeof(struct mhtml));
 147         print_man(man_meta(m), man_node(m), &mh, (struct html *)arg);
 148         putchar('\n');
 149 }
 150
 151 static void
 152 print_man(MAN_ARGS)
 153 {
 154         struct tag      *t, *tt;
 155         struct htmlpair  tag;
 156
 157         PAIR_CLASS_INIT(&tag, "mandoc");
 158
 159         if ( ! (HTML_FRAGMENT & h->oflags)) {
 160                 print_gen_decls(h);
 161                 t = print_otag(h, TAG_HTML, 0, NULL);
 162                 tt = print_otag(h, TAG_HEAD, 0, NULL);
 163                 print_man_head(m, n, mh, h);
 164                 print_tagq(h, tt);
 165                 print_otag(h, TAG_BODY, 0, NULL);
 166                 print_otag(h, TAG_DIV, 1, &tag);
 167         } else
 168                 t = print_otag(h, TAG_DIV, 1, &tag);
 169
 170         print_man_nodelist(m, n, mh, h);
 171         print_tagq(h, t);
 172 }
 173
 174
 175 /* ARGSUSED */
 176 static void
 177 print_man_head(MAN_ARGS)
 178 {
 179
 180         print_gen_head(h);
 181         bufcat_fmt(h, "%s(%s)", m->title, m->msec);
 182         print_otag(h, TAG_TITLE, 0, NULL);
 183         print_text(h, h->buf);
 184 }
 185
 186
 187 static void
 188 print_man_nodelist(MAN_ARGS)
 189 {
 190
 191         print_man_node(m, n, mh, h);
 192         if (n->next)
 193                 print_man_nodelist(m, n->next, mh, h);
 194 }
 195
 196
 197 static void
 198 print_man_node(MAN_ARGS)
 199 {
 200         int              child;
 201         struct tag      *t;
 202
 203         child = 1;
 204         t = h->tags.head;
 205
 206         switch (n->type) {
 207         case (MAN_ROOT):
 208                 man_root_pre(m, n, mh, h);
 209                 break;
 210         case (MAN_TEXT):
 211                 /*
 212                  * If we have a blank line, output a vertical space.
 213                  * If we have a space as the first character, break
 214                  * before printing the line's data.
 215                  */
 216                 if ('\0' == *n->string) {
 217                         print_otag(h, TAG_P, 0, NULL);
 218                         return;
 219                 }
 220
 221                 if (' ' == *n->string && MAN_LINE & n->flags)
 222                         print_otag(h, TAG_BR, 0, NULL);
 223                 else if (MANH_LITERAL & mh->fl && n->prev)
 224                         print_otag(h, TAG_BR, 0, NULL);
 225
 226                 print_text(h, n->string);
 227                 return;
 228         case (MAN_EQN):
 229                 print_eqn(h, n->eqn);
 230                 break;
 231         case (MAN_TBL):
 232                 /*
 233                  * This will take care of initialising all of the table
 234                  * state data for the first table, then tearing it down
 235                  * for the last one.
 236                  */
 237                 print_tbl(h, n->span);
 238                 return;
 239         default:
 240                 /*
 241                  * Close out scope of font prior to opening a macro
 242                  * scope.
 243                  */
 244                 if (HTMLFONT_NONE != h->metac) {
 245                         h->metal = h->metac;
 246                         h->metac = HTMLFONT_NONE;
 247                 }
 248
 249                 /*
 250                  * Close out the current table, if it's open, and unset
 251                  * the "meta" table state.  This will be reopened on the
 252                  * next table element.
 253                  */
 254                 if (h->tblt) {
 255                         print_tblclose(h);
 256                         t = h->tags.head;
 257                 }
 258                 if (mans[n->tok].pre)
 259                         child = (*mans[n->tok].pre)(m, n, mh, h);
 260                 break;
 261         }
 262
 263         if (child && n->child)
 264                 print_man_nodelist(m, n->child, mh, h);
 265
 266         /* This will automatically close out any font scope. */
 267         print_stagq(h, t);
 268
 269         switch (n->type) {
 270         case (MAN_ROOT):
 271                 man_root_post(m, n, mh, h);
 272                 break;
 273         case (MAN_EQN):
 274                 break;
 275         default:
 276                 if (mans[n->tok].post)
 277                         (*mans[n->tok].post)(m, n, mh, h);
 278                 break;
 279         }
 280 }
 281
 282
 283 static int
 284 a2width(const struct man_node *n, struct roffsu *su)
 285 {
 286
 287         if (MAN_TEXT != n->type)
 288                 return(0);
 289         if (a2roffsu(n->string, su, SCALE_BU))
 290                 return(1);
 291
 292         return(0);
 293 }
 294
 295
 296 /* ARGSUSED */
 297 static void
 298 man_root_pre(MAN_ARGS)
 299 {
 300         struct htmlpair  tag[3];
 301         struct tag      *t, *tt;
 302         char             b[BUFSIZ], title[BUFSIZ];
 303
 304         b[0] = 0;
 305         if (m->vol)
 306                 (void)strlcat(b, m->vol, BUFSIZ);
 307
 308         snprintf(title, BUFSIZ - 1, "%s(%s)", m->title ? m->title : "",
 309             m->msec ? m->msec : "");
 310
 311         PAIR_SUMMARY_INIT(&tag[0], "Document Header");
 312         PAIR_CLASS_INIT(&tag[1], "head");
 313         PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
 314         t = print_otag(h, TAG_TABLE, 3, tag);
 315         PAIR_INIT(&tag[0], ATTR_WIDTH, "30%");
 316         print_otag(h, TAG_COL, 1, tag);
 317         print_otag(h, TAG_COL, 1, tag);
 318         print_otag(h, TAG_COL, 1, tag);
 319
 320         print_otag(h, TAG_TBODY, 0, NULL);
 321
 322         tt = print_otag(h, TAG_TR, 0, NULL);
 323
 324         PAIR_CLASS_INIT(&tag[0], "head-ltitle");
 325         print_otag(h, TAG_TD, 1, tag);
 326         print_text(h, title);
 327         print_stagq(h, tt);
 328
 329         PAIR_CLASS_INIT(&tag[0], "head-vol");
 330         PAIR_INIT(&tag[1], ATTR_ALIGN, "center");
 331         print_otag(h, TAG_TD, 2, tag);
 332         print_text(h, b);
 333         print_stagq(h, tt);
 334
 335         PAIR_CLASS_INIT(&tag[0], "head-rtitle");
 336         PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
 337         print_otag(h, TAG_TD, 2, tag);
 338         print_text(h, title);
 339         print_tagq(h, t);
 340 }
 341
 342
 343 /* ARGSUSED */
 344 static void
 345 man_root_post(MAN_ARGS)
 346 {
 347         struct htmlpair  tag[3];
 348         struct tag      *t, *tt;
 349
 350         PAIR_SUMMARY_INIT(&tag[0], "Document Footer");
 351         PAIR_CLASS_INIT(&tag[1], "foot");
 352         PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
 353         t = print_otag(h, TAG_TABLE, 3, tag);
 354         PAIR_INIT(&tag[0], ATTR_WIDTH, "50%");
 355         print_otag(h, TAG_COL, 1, tag);
 356         print_otag(h, TAG_COL, 1, tag);
 357
 358         tt = print_otag(h, TAG_TR, 0, NULL);
 359
 360         PAIR_CLASS_INIT(&tag[0], "foot-date");
 361         print_otag(h, TAG_TD, 1, tag);
 362
 363         if (m->date)
 364                 print_text(h, m->date);
 365         print_stagq(h, tt);
 366
 367         PAIR_CLASS_INIT(&tag[0], "foot-os");
 368         PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
 369         print_otag(h, TAG_TD, 2, tag);
 370
 371         if (m->source)
 372                 print_text(h, m->source);
 373         print_tagq(h, t);
 374 }
 375
 376
 377 /* ARGSUSED */
 378 static int
 379 man_br_pre(MAN_ARGS)
 380 {
 381         struct roffsu    su;
 382         struct htmlpair  tag;
 383
 384         SCALE_VS_INIT(&su, 1);
 385
 386         if (MAN_sp == n->tok) {
 387                 if (NULL != (n = n->child))
 388                         if ( ! a2roffsu(n->string, &su, SCALE_VS))
 389                                 SCALE_VS_INIT(&su, atoi(n->string));
 390         } else
 391                 su.scale = 0;
 392
 393         bufinit(h);
 394         bufcat_su(h, "height", &su);
 395         PAIR_STYLE_INIT(&tag, h);
 396         print_otag(h, TAG_DIV, 1, &tag);
 397
 398         /* So the div isn't empty: */
 399         print_text(h, "\\~");
 400
 401         return(0);
 402 }
 403
 404 /* ARGSUSED */
 405 static int
 406 man_SH_pre(MAN_ARGS)
 407 {
 408         struct htmlpair  tag;
 409
 410         if (MAN_BLOCK == n->type) {
 411                 mh->fl &= ~MANH_LITERAL;
 412                 PAIR_CLASS_INIT(&tag, "section");
 413                 print_otag(h, TAG_DIV, 1, &tag);
 414                 return(1);
 415         } else if (MAN_BODY == n->type)
 416                 return(1);
 417
 418         print_otag(h, TAG_H1, 0, NULL);
 419         return(1);
 420 }
 421
 422 /* ARGSUSED */
 423 static int
 424 man_alt_pre(MAN_ARGS)
 425 {
 426         const struct man_node   *nn;
 427         int              i, savelit;
 428         enum htmltag     fp;
 429         struct tag      *t;
 430
 431         if ((savelit = mh->fl & MANH_LITERAL))
 432                 print_otag(h, TAG_BR, 0, NULL);
 433
 434         mh->fl &= ~MANH_LITERAL;
 435
 436         for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
 437                 t = NULL;
 438                 switch (n->tok) {
 439                 case (MAN_BI):
 440                         fp = i % 2 ? TAG_I : TAG_B;
 441                         break;
 442                 case (MAN_IB):
 443                         fp = i % 2 ? TAG_B : TAG_I;
 444                         break;
 445                 case (MAN_RI):
 446                         fp = i % 2 ? TAG_I : TAG_MAX;
 447                         break;
 448                 case (MAN_IR):
 449                         fp = i % 2 ? TAG_MAX : TAG_I;
 450                         break;
 451                 case (MAN_BR):
 452                         fp = i % 2 ? TAG_MAX : TAG_B;
 453                         break;
 454                 case (MAN_RB):
 455                         fp = i % 2 ? TAG_B : TAG_MAX;
 456                         break;
 457                 default:
 458                         abort();
 459                         /* NOTREACHED */
 460                 }
 461
 462                 if (i)
 463                         h->flags |= HTML_NOSPACE;
 464
 465                 if (TAG_MAX != fp)
 466                         t = print_otag(h, fp, 0, NULL);
 467
 468                 print_man_node(m, nn, mh, h);
 469
 470                 if (t)
 471                         print_tagq(h, t);
 472         }
 473
 474         if (savelit)
 475                 mh->fl |= MANH_LITERAL;
 476
 477         return(0);
 478 }
 479
 480 /* ARGSUSED */
 481 static int
 482 man_SM_pre(MAN_ARGS)
 483 {
 484
 485         print_otag(h, TAG_SMALL, 0, NULL);
 486         if (MAN_SB == n->tok)
 487                 print_otag(h, TAG_B, 0, NULL);
 488         return(1);
 489 }
 490
 491 /* ARGSUSED */
 492 static int
 493 man_SS_pre(MAN_ARGS)
 494 {
 495         struct htmlpair  tag;
 496
 497         if (MAN_BLOCK == n->type) {
 498                 mh->fl &= ~MANH_LITERAL;
 499                 PAIR_CLASS_INIT(&tag, "subsection");
 500                 print_otag(h, TAG_DIV, 1, &tag);
 501                 return(1);
 502         } else if (MAN_BODY == n->type)
 503                 return(1);
 504
 505         print_otag(h, TAG_H2, 0, NULL);
 506         return(1);
 507 }
 508
 509 /* ARGSUSED */
 510 static int
 511 man_PP_pre(MAN_ARGS)
 512 {
 513
 514         if (MAN_HEAD == n->type)
 515                 return(0);
 516         else if (MAN_BLOCK == n->type)
 517                 print_bvspace(h, n);
 518
 519         return(1);
 520 }
 521
 522 /* ARGSUSED */
 523 static int
 524 man_IP_pre(MAN_ARGS)
 525 {
 526         const struct man_node   *nn;
 527
 528         if (MAN_BODY == n->type) {
 529                 print_otag(h, TAG_DD, 0, NULL);
 530                 return(1);
 531         } else if (MAN_HEAD != n->type) {
 532                 print_otag(h, TAG_DL, 0, NULL);
 533                 return(1);
 534         }
 535
 536         /* FIXME: width specification. */
 537
 538         print_otag(h, TAG_DT, 0, NULL);
 539
 540         /* For IP, only print the first header element. */
 541
 542         if (MAN_IP == n->tok && n->child)
 543                 print_man_node(m, n->child, mh, h);
 544
 545         /* For TP, only print next-line header elements. */
 546
 547         if (MAN_TP == n->tok)
 548                 for (nn = n->child; nn; nn = nn->next)
 549                         if (nn->line > n->line)
 550                                 print_man_node(m, nn, mh, h);
 551
 552         return(0);
 553 }
 554
 555 /* ARGSUSED */
 556 static int
 557 man_HP_pre(MAN_ARGS)
 558 {
 559         struct htmlpair  tag;
 560         struct roffsu    su;
 561         const struct man_node *np;
 562
 563         if (MAN_HEAD == n->type)
 564                 return(0);
 565         else if (MAN_BLOCK != n->type)
 566                 return(1);
 567
 568         np = n->head->child;
 569
 570         if (NULL == np || ! a2width(np, &su))
 571                 SCALE_HS_INIT(&su, INDENT);
 572
 573         bufinit(h);
 574
 575         print_bvspace(h, n);
 576         bufcat_su(h, "margin-left", &su);
 577         su.scale = -su.scale;
 578         bufcat_su(h, "text-indent", &su);
 579         PAIR_STYLE_INIT(&tag, h);
 580         print_otag(h, TAG_P, 1, &tag);
 581         return(1);
 582 }
 583
 584 /* ARGSUSED */
 585 static int
 586 man_B_pre(MAN_ARGS)
 587 {
 588
 589         print_otag(h, TAG_B, 0, NULL);
 590         return(1);
 591 }
 592
 593 /* ARGSUSED */
 594 static int
 595 man_I_pre(MAN_ARGS)
 596 {
 597
 598         print_otag(h, TAG_I, 0, NULL);
 599         return(1);
 600 }
 601
 602 /* ARGSUSED */
 603 static int
 604 man_literal_pre(MAN_ARGS)
 605 {
 606
 607         if (MAN_nf != n->tok) {
 608                 print_otag(h, TAG_BR, 0, NULL);
 609                 mh->fl &= ~MANH_LITERAL;
 610         } else
 611                 mh->fl |= MANH_LITERAL;
 612
 613         return(0);
 614 }
 615
 616 /* ARGSUSED */
 617 static int
 618 man_in_pre(MAN_ARGS)
 619 {
 620
 621         print_otag(h, TAG_BR, 0, NULL);
 622         return(0);
 623 }
 624
 625 /* ARGSUSED */
 626 static int
 627 man_ign_pre(MAN_ARGS)
 628 {
 629
 630         return(0);
 631 }
 632
 633 /* ARGSUSED */
 634 static int
 635 man_RS_pre(MAN_ARGS)
 636 {
 637         struct htmlpair  tag;
 638         struct roffsu    su;
 639
 640         if (MAN_HEAD == n->type)
 641                 return(0);
 642         else if (MAN_BODY == n->type)
 643                 return(1);
 644
 645         SCALE_HS_INIT(&su, INDENT);
 646         if (n->head->child)
 647                 a2width(n->head->child, &su);
 648
 649         bufinit(h);
 650         bufcat_su(h, "margin-left", &su);
 651         PAIR_STYLE_INIT(&tag, h);
 652         print_otag(h, TAG_DIV, 1, &tag);
 653         return(1);
 654 }