man_html.c

   1 /*      $Id: man_html.c,v 1.57 2010/12/24 00:46:49 kristaps Exp $ */
   2 /*
   3  * Copyright (c) 2008, 2009, 2010 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 #define HALFINDENT        3
  40
  41 #define MAN_ARGS          const struct man_meta *m, \
  42                           const struct man_node *n, \
  43                           struct mhtml *mh, \
  44                           struct html *h
  45
  46 struct  mhtml {
  47         int               fl;
  48 #define MANH_LITERAL     (1 << 0) /* literal context */
  49 };
  50
  51 struct  htmlman {
  52         int             (*pre)(MAN_ARGS);
  53         int             (*post)(MAN_ARGS);
  54 };
  55
  56 static  void              print_man(MAN_ARGS);
  57 static  void              print_man_head(MAN_ARGS);
  58 static  void              print_man_nodelist(MAN_ARGS);
  59 static  void              print_man_node(MAN_ARGS);
  60
  61 static  int               a2width(const struct man_node *,
  62                                 struct roffsu *);
  63
  64 static  int               man_alt_pre(MAN_ARGS);
  65 static  int               man_br_pre(MAN_ARGS);
  66 static  int               man_ign_pre(MAN_ARGS);
  67 static  int               man_in_pre(MAN_ARGS);
  68 static  int               man_literal_pre(MAN_ARGS);
  69 static  void              man_root_post(MAN_ARGS);
  70 static  int               man_root_pre(MAN_ARGS);
  71 static  int               man_B_pre(MAN_ARGS);
  72 static  int               man_HP_pre(MAN_ARGS);
  73 static  int               man_I_pre(MAN_ARGS);
  74 static  int               man_IP_pre(MAN_ARGS);
  75 static  int               man_PP_pre(MAN_ARGS);
  76 static  int               man_RS_pre(MAN_ARGS);
  77 static  int               man_SH_pre(MAN_ARGS);
  78 static  int               man_SM_pre(MAN_ARGS);
  79 static  int               man_SS_pre(MAN_ARGS);
  80
  81 static  const struct htmlman mans[MAN_MAX] = {
  82         { man_br_pre, NULL }, /* br */
  83         { NULL, NULL }, /* TH */
  84         { man_SH_pre, NULL }, /* SH */
  85         { man_SS_pre, NULL }, /* SS */
  86         { man_IP_pre, NULL }, /* TP */
  87         { man_PP_pre, NULL }, /* LP */
  88         { man_PP_pre, NULL }, /* PP */
  89         { man_PP_pre, NULL }, /* P */
  90         { man_IP_pre, NULL }, /* IP */
  91         { man_HP_pre, NULL }, /* HP */
  92         { man_SM_pre, NULL }, /* SM */
  93         { man_SM_pre, NULL }, /* SB */
  94         { man_alt_pre, NULL }, /* BI */
  95         { man_alt_pre, NULL }, /* IB */
  96         { man_alt_pre, NULL }, /* BR */
  97         { man_alt_pre, NULL }, /* RB */
  98         { NULL, NULL }, /* R */
  99         { man_B_pre, NULL }, /* B */
 100         { man_I_pre, NULL }, /* I */
 101         { man_alt_pre, NULL }, /* IR */
 102         { man_alt_pre, NULL }, /* RI */
 103         { NULL, NULL }, /* na */
 104         { man_br_pre, NULL }, /* sp */
 105         { man_literal_pre, NULL }, /* nf */
 106         { man_literal_pre, NULL }, /* fi */
 107         { NULL, NULL }, /* RE */
 108         { man_RS_pre, NULL }, /* RS */
 109         { man_ign_pre, NULL }, /* DT */
 110         { man_ign_pre, NULL }, /* UC */
 111         { man_ign_pre, NULL }, /* PD */
 112         { man_ign_pre, NULL }, /* AT */
 113         { man_in_pre, NULL }, /* in */
 114         { man_ign_pre, NULL }, /* ft */
 115 };
 116
 117
 118 void
 119 html_man(void *arg, const struct man *m)
 120 {
 121         struct html     *h;
 122         struct tag      *t;
 123         struct mhtml     mh;
 124
 125         h = (struct html *)arg;
 126
 127         print_gen_decls(h);
 128
 129         memset(&mh, 0, sizeof(struct mhtml));
 130
 131         t = print_otag(h, TAG_HTML, 0, NULL);
 132         print_man(man_meta(m), man_node(m), &mh, h);
 133         print_tagq(h, t);
 134
 135         printf("\n");
 136 }
 137
 138
 139 static void
 140 print_man(MAN_ARGS)
 141 {
 142         struct tag      *t;
 143
 144         t = print_otag(h, TAG_HEAD, 0, NULL);
 145         print_man_head(m, n, mh, h);
 146         print_tagq(h, t);
 147
 148         t = print_otag(h, TAG_BODY, 0, NULL);
 149         print_man_nodelist(m, n, mh, h);
 150         print_tagq(h, t);
 151 }
 152
 153
 154 /* ARGSUSED */
 155 static void
 156 print_man_head(MAN_ARGS)
 157 {
 158
 159         print_gen_head(h);
 160         bufinit(h);
 161         buffmt(h, "%s(%s)", m->title, m->msec);
 162
 163         print_otag(h, TAG_TITLE, 0, NULL);
 164         print_text(h, h->buf);
 165 }
 166
 167
 168 static void
 169 print_man_nodelist(MAN_ARGS)
 170 {
 171
 172         print_man_node(m, n, mh, h);
 173         if (n->next)
 174                 print_man_nodelist(m, n->next, mh, h);
 175 }
 176
 177
 178 static void
 179 print_man_node(MAN_ARGS)
 180 {
 181         int              child;
 182         struct tag      *t;
 183
 184         child = 1;
 185         t = h->tags.head;
 186
 187         bufinit(h);
 188
 189         /*
 190          * FIXME: embedded elements within next-line scopes (e.g., `br'
 191          * within an empty `B') will cause formatting to be forgotten
 192          * due to scope closing out.
 193          */
 194
 195         switch (n->type) {
 196         case (MAN_ROOT):
 197                 child = man_root_pre(m, n, mh, h);
 198                 break;
 199         case (MAN_TEXT):
 200                 print_text(h, n->string);
 201
 202                 if (MANH_LITERAL & mh->fl)
 203                         print_otag(h, TAG_BR, 0, NULL);
 204
 205                 return;
 206         default:
 207                 /*
 208                  * Close out scope of font prior to opening a macro
 209                  * scope.  Assert that the metafont is on the top of the
 210                  * stack (it's never nested).
 211                  */
 212                 if (HTMLFONT_NONE != h->metac) {
 213                         h->metal = h->metac;
 214                         h->metac = HTMLFONT_NONE;
 215                 }
 216                 if (mans[n->tok].pre)
 217                         child = (*mans[n->tok].pre)(m, n, mh, h);
 218                 break;
 219         }
 220
 221         if (child && n->child)
 222                 print_man_nodelist(m, n->child, mh, h);
 223
 224         /* This will automatically close out any font scope. */
 225         print_stagq(h, t);
 226
 227         bufinit(h);
 228
 229         switch (n->type) {
 230         case (MAN_ROOT):
 231                 man_root_post(m, n, mh, h);
 232                 break;
 233         case (MAN_TEXT):
 234                 break;
 235         default:
 236                 if (mans[n->tok].post)
 237                         (*mans[n->tok].post)(m, n, mh, h);
 238                 break;
 239         }
 240 }
 241
 242
 243 static int
 244 a2width(const struct man_node *n, struct roffsu *su)
 245 {
 246
 247         if (MAN_TEXT != n->type)
 248                 return(0);
 249         if (a2roffsu(n->string, su, SCALE_BU))
 250                 return(1);
 251
 252         return(0);
 253 }
 254
 255
 256 /* ARGSUSED */
 257 static int
 258 man_root_pre(MAN_ARGS)
 259 {
 260         struct htmlpair  tag[3];
 261         struct tag      *t, *tt;
 262         char             b[BUFSIZ], title[BUFSIZ];
 263
 264         b[0] = 0;
 265         if (m->vol)
 266                 (void)strlcat(b, m->vol, BUFSIZ);
 267
 268         snprintf(title, BUFSIZ - 1, "%s(%s)", m->title, m->msec);
 269
 270         PAIR_SUMMARY_INIT(&tag[0], "Document Header");
 271         PAIR_CLASS_INIT(&tag[1], "head");
 272         if (NULL == h->style) {
 273                 PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
 274                 t = print_otag(h, TAG_TABLE, 3, tag);
 275                 PAIR_INIT(&tag[0], ATTR_WIDTH, "30%");
 276                 print_otag(h, TAG_COL, 1, tag);
 277                 print_otag(h, TAG_COL, 1, tag);
 278                 print_otag(h, TAG_COL, 1, tag);
 279         } else
 280                 t = print_otag(h, TAG_TABLE, 2, tag);
 281
 282         print_otag(h, TAG_TBODY, 0, NULL);
 283
 284         tt = print_otag(h, TAG_TR, 0, NULL);
 285
 286         PAIR_CLASS_INIT(&tag[0], "head-ltitle");
 287         print_otag(h, TAG_TD, 1, tag);
 288
 289         print_text(h, title);
 290         print_stagq(h, tt);
 291
 292         PAIR_CLASS_INIT(&tag[0], "head-vol");
 293         if (NULL == h->style) {
 294                 PAIR_INIT(&tag[1], ATTR_ALIGN, "center");
 295                 print_otag(h, TAG_TD, 2, tag);
 296         } else
 297                 print_otag(h, TAG_TD, 1, tag);
 298
 299         print_text(h, b);
 300         print_stagq(h, tt);
 301
 302         PAIR_CLASS_INIT(&tag[0], "head-rtitle");
 303         if (NULL == h->style) {
 304                 PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
 305                 print_otag(h, TAG_TD, 2, tag);
 306         } else
 307                 print_otag(h, TAG_TD, 1, tag);
 308
 309         print_text(h, title);
 310         print_tagq(h, t);
 311         return(1);
 312 }
 313
 314
 315 /* ARGSUSED */
 316 static void
 317 man_root_post(MAN_ARGS)
 318 {
 319         struct htmlpair  tag[3];
 320         struct tag      *t, *tt;
 321         char             b[DATESIZ];
 322
 323         if (m->rawdate)
 324                 strlcpy(b, m->rawdate, DATESIZ);
 325         else
 326                 time2a(m->date, b, DATESIZ);
 327
 328         PAIR_SUMMARY_INIT(&tag[0], "Document Footer");
 329         PAIR_CLASS_INIT(&tag[1], "foot");
 330         if (NULL == h->style) {
 331                 PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
 332                 t = print_otag(h, TAG_TABLE, 3, tag);
 333                 PAIR_INIT(&tag[0], ATTR_WIDTH, "50%");
 334                 print_otag(h, TAG_COL, 1, tag);
 335                 print_otag(h, TAG_COL, 1, tag);
 336         } else
 337                 t = print_otag(h, TAG_TABLE, 2, tag);
 338
 339         tt = print_otag(h, TAG_TR, 0, NULL);
 340
 341         PAIR_CLASS_INIT(&tag[0], "foot-date");
 342         print_otag(h, TAG_TD, 1, tag);
 343
 344         print_text(h, b);
 345         print_stagq(h, tt);
 346
 347         PAIR_CLASS_INIT(&tag[0], "foot-os");
 348         if (NULL == h->style) {
 349                 PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
 350                 print_otag(h, TAG_TD, 2, tag);
 351         } else
 352                 print_otag(h, TAG_TD, 1, tag);
 353
 354         if (m->source)
 355                 print_text(h, m->source);
 356         print_tagq(h, t);
 357 }
 358
 359
 360
 361 /* ARGSUSED */
 362 static int
 363 man_br_pre(MAN_ARGS)
 364 {
 365         struct roffsu    su;
 366         struct htmlpair  tag;
 367
 368         SCALE_VS_INIT(&su, 1);
 369
 370         if (MAN_sp == n->tok) {
 371                 if (n->child)
 372                         a2roffsu(n->child->string, &su, SCALE_VS);
 373         } else
 374                 su.scale = 0;
 375
 376         bufcat_su(h, "height", &su);
 377         PAIR_STYLE_INIT(&tag, h);
 378         print_otag(h, TAG_DIV, 1, &tag);
 379
 380         /* So the div isn't empty: */
 381         print_text(h, "\\~");
 382
 383         return(0);
 384 }
 385
 386
 387 /* ARGSUSED */
 388 static int
 389 man_SH_pre(MAN_ARGS)
 390 {
 391         struct htmlpair  tag;
 392
 393         if (MAN_BLOCK == n->type) {
 394                 PAIR_CLASS_INIT(&tag, "section");
 395                 print_otag(h, TAG_DIV, 1, &tag);
 396                 return(1);
 397         } else if (MAN_BODY == n->type)
 398                 return(1);
 399
 400         print_otag(h, TAG_H1, 0, NULL);
 401         return(1);
 402 }
 403
 404
 405 /* ARGSUSED */
 406 static int
 407 man_alt_pre(MAN_ARGS)
 408 {
 409         const struct man_node   *nn;
 410         int              i;
 411         enum htmltag     fp;
 412         struct tag      *t;
 413
 414         for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
 415                 t = NULL;
 416                 switch (n->tok) {
 417                 case (MAN_BI):
 418                         fp = i % 2 ? TAG_I : TAG_B;
 419                         break;
 420                 case (MAN_IB):
 421                         fp = i % 2 ? TAG_B : TAG_I;
 422                         break;
 423                 case (MAN_RI):
 424                         fp = i % 2 ? TAG_I : TAG_MAX;
 425                         break;
 426                 case (MAN_IR):
 427                         fp = i % 2 ? TAG_MAX : TAG_I;
 428                         break;
 429                 case (MAN_BR):
 430                         fp = i % 2 ? TAG_MAX : TAG_B;
 431                         break;
 432                 case (MAN_RB):
 433                         fp = i % 2 ? TAG_B : TAG_MAX;
 434                         break;
 435                 default:
 436                         abort();
 437                         /* NOTREACHED */
 438                 }
 439
 440                 if (i)
 441                         h->flags |= HTML_NOSPACE;
 442
 443                 if (TAG_MAX != fp)
 444                         t = print_otag(h, fp, 0, NULL);
 445
 446                 print_man_node(m, nn, mh, h);
 447
 448                 if (t)
 449                         print_tagq(h, t);
 450         }
 451
 452         return(0);
 453 }
 454
 455
 456 /* ARGSUSED */
 457 static int
 458 man_SM_pre(MAN_ARGS)
 459 {
 460
 461         print_otag(h, TAG_SMALL, 0, NULL);
 462         if (MAN_SB == n->tok)
 463                 print_otag(h, TAG_B, 0, NULL);
 464         return(1);
 465 }
 466
 467
 468 /* ARGSUSED */
 469 static int
 470 man_SS_pre(MAN_ARGS)
 471 {
 472         struct htmlpair  tag;
 473
 474         if (MAN_BLOCK == n->type) {
 475                 PAIR_CLASS_INIT(&tag, "subsection");
 476                 print_otag(h, TAG_DIV, 1, &tag);
 477                 return(1);
 478         } else if (MAN_BODY == n->type)
 479                 return(1);
 480
 481         print_otag(h, TAG_H2, 0, NULL);
 482         return(1);
 483 }
 484
 485
 486 /* ARGSUSED */
 487 static int
 488 man_PP_pre(MAN_ARGS)
 489 {
 490
 491         if (MAN_HEAD == n->type)
 492                 return(0);
 493         else if (MAN_BODY == n->type && n->prev)
 494                 print_otag(h, TAG_P, 0, NULL);
 495
 496         return(1);
 497 }
 498
 499
 500 /* ARGSUSED */
 501 static int
 502 man_IP_pre(MAN_ARGS)
 503 {
 504         struct roffsu            su;
 505         struct htmlpair          tag;
 506         const struct man_node   *nn;
 507         int                      width;
 508
 509         /*
 510          * This scattering of 1-BU margins and pads is to make sure that
 511          * when text overruns its box, the subsequent text isn't flush
 512          * up against it.  However, the rest of the right-hand box must
 513          * also be adjusted in consideration of this 1-BU space.
 514          */
 515
 516         if (MAN_BODY == n->type) {
 517                 print_otag(h, TAG_TD, 0, NULL);
 518                 return(1);
 519         }
 520
 521         nn = MAN_BLOCK == n->type ?
 522                 n->head->child : n->parent->head->child;
 523
 524         SCALE_HS_INIT(&su, INDENT);
 525         width = 0;
 526
 527         /* Width is the last token. */
 528
 529         if (MAN_IP == n->tok && NULL != nn)
 530                 if (NULL != (nn = nn->next)) {
 531                         for ( ; nn->next; nn = nn->next)
 532                                 /* Do nothing. */ ;
 533                         width = a2width(nn, &su);
 534                 }
 535
 536         /* Width is the first token. */
 537
 538         if (MAN_TP == n->tok && NULL != nn) {
 539                 /* Skip past non-text children. */
 540                 while (nn && MAN_TEXT != nn->type)
 541                         nn = nn->next;
 542                 if (nn)
 543                         width = a2width(nn, &su);
 544         }
 545
 546         if (MAN_BLOCK == n->type) {
 547                 print_otag(h, TAG_P, 0, NULL);
 548                 print_otag(h, TAG_TABLE, 0, NULL);
 549                 bufcat_su(h, "width", &su);
 550                 PAIR_STYLE_INIT(&tag, h);
 551                 print_otag(h, TAG_COL, 1, &tag);
 552                 print_otag(h, TAG_COL, 0, NULL);
 553                 print_otag(h, TAG_TBODY, 0, NULL);
 554                 print_otag(h, TAG_TR, 0, NULL);
 555                 return(1);
 556         }
 557
 558         print_otag(h, TAG_TD, 0, NULL);
 559
 560         /*
 561          * Without a length string, we can print all of our children.
 562          */
 563
 564         if ( ! width)
 565                 return(1);
 566
 567         /*
 568          * When a length has been specified, we need to carefully print
 569          * our child context:  IP gets all children printed but the last
 570          * (the width), while TP gets all children printed but the first
 571          * (the width).
 572          */
 573
 574         if (MAN_IP == n->tok)
 575                 for (nn = n->child; nn->next; nn = nn->next)
 576                         print_man_node(m, nn, mh, h);
 577         if (MAN_TP == n->tok)
 578                 for (nn = n->child->next; nn; nn = nn->next)
 579                         print_man_node(m, nn, mh, h);
 580
 581         return(0);
 582 }
 583
 584
 585 /* ARGSUSED */
 586 static int
 587 man_HP_pre(MAN_ARGS)
 588 {
 589         struct htmlpair  tag;
 590         struct roffsu    su;
 591         const struct man_node *np;
 592
 593         np = MAN_BLOCK == n->type ?
 594                 n->head->child :
 595                 n->parent->head->child;
 596
 597         if (NULL == np || ! a2width(np, &su))
 598                 SCALE_HS_INIT(&su, INDENT);
 599
 600         if (MAN_HEAD == n->type) {
 601                 print_otag(h, TAG_TD, 0, NULL);
 602                 return(0);
 603         } else if (MAN_BLOCK == n->type) {
 604                 print_otag(h, TAG_P, 0, NULL);
 605                 print_otag(h, TAG_TABLE, 0, NULL);
 606                 bufcat_su(h, "width", &su);
 607                 PAIR_STYLE_INIT(&tag, h);
 608                 print_otag(h, TAG_COL, 1, &tag);
 609                 print_otag(h, TAG_COL, 0, NULL);
 610                 print_otag(h, TAG_TBODY, 0, NULL);
 611                 print_otag(h, TAG_TR, 0, NULL);
 612                 return(1);
 613         }
 614
 615         su.scale = -su.scale;
 616         bufcat_su(h, "text-indent", &su);
 617         PAIR_STYLE_INIT(&tag, h);
 618         print_otag(h, TAG_TD, 1, &tag);
 619         return(1);
 620 }
 621
 622
 623 /* ARGSUSED */
 624 static int
 625 man_B_pre(MAN_ARGS)
 626 {
 627
 628         print_otag(h, TAG_B, 0, NULL);
 629         return(1);
 630 }
 631
 632
 633 /* ARGSUSED */
 634 static int
 635 man_I_pre(MAN_ARGS)
 636 {
 637
 638         print_otag(h, TAG_I, 0, NULL);
 639         return(1);
 640 }
 641
 642
 643 /* ARGSUSED */
 644 static int
 645 man_literal_pre(MAN_ARGS)
 646 {
 647
 648         if (MAN_nf == n->tok) {
 649                 print_otag(h, TAG_BR, 0, NULL);
 650                 mh->fl |= MANH_LITERAL;
 651         } else
 652                 mh->fl &= ~MANH_LITERAL;
 653
 654         return(1);
 655 }
 656
 657
 658 /* ARGSUSED */
 659 static int
 660 man_in_pre(MAN_ARGS)
 661 {
 662
 663         print_otag(h, TAG_BR, 0, NULL);
 664         return(0);
 665 }
 666
 667
 668 /* ARGSUSED */
 669 static int
 670 man_ign_pre(MAN_ARGS)
 671 {
 672
 673         return(0);
 674 }
 675
 676
 677 /* ARGSUSED */
 678 static int
 679 man_RS_pre(MAN_ARGS)
 680 {
 681         struct htmlpair  tag;
 682         struct roffsu    su;
 683
 684         if (MAN_HEAD == n->type)
 685                 return(0);
 686         else if (MAN_BODY == n->type)
 687                 return(1);
 688
 689         SCALE_HS_INIT(&su, INDENT);
 690         if (n->head->child)
 691                 a2width(n->head->child, &su);
 692
 693         bufcat_su(h, "margin-left", &su);
 694         PAIR_STYLE_INIT(&tag, h);
 695         print_otag(h, TAG_DIV, 1, &tag);
 696         return(1);
 697 }