man_html.c

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