man_html.c

   1 /*      $Id: man_html.c,v 1.157 2018/10/23 17:18:01 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
   4  * Copyright (c) 2013,2014,2015,2017,2018 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 AUTHORS DISCLAIM ALL WARRANTIES
  11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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_aux.h"
  29 #include "mandoc.h"
  30 #include "roff.h"
  31 #include "man.h"
  32 #include "out.h"
  33 #include "html.h"
  34 #include "main.h"
  35
  36 /* FIXME: have PD set the default vspace width. */
  37
  38 #define MAN_ARGS          const struct roff_meta *man, \
  39                           const struct roff_node *n, \
  40                           struct html *h
  41
  42 struct  man_html_act {
  43         int             (*pre)(MAN_ARGS);
  44         int             (*post)(MAN_ARGS);
  45 };
  46
  47 static  void              print_bvspace(struct html *,
  48                                 const struct roff_node *);
  49 static  void              print_man_head(const struct roff_meta *,
  50                                 struct html *);
  51 static  void              print_man_nodelist(MAN_ARGS);
  52 static  void              print_man_node(MAN_ARGS);
  53 static  int               fillmode(struct html *, int);
  54 static  int               man_B_pre(MAN_ARGS);
  55 static  int               man_HP_pre(MAN_ARGS);
  56 static  int               man_IP_pre(MAN_ARGS);
  57 static  int               man_I_pre(MAN_ARGS);
  58 static  int               man_OP_pre(MAN_ARGS);
  59 static  int               man_PP_pre(MAN_ARGS);
  60 static  int               man_RS_pre(MAN_ARGS);
  61 static  int               man_SH_pre(MAN_ARGS);
  62 static  int               man_SM_pre(MAN_ARGS);
  63 static  int               man_SS_pre(MAN_ARGS);
  64 static  int               man_SY_pre(MAN_ARGS);
  65 static  int               man_UR_pre(MAN_ARGS);
  66 static  int               man_alt_pre(MAN_ARGS);
  67 static  int               man_ign_pre(MAN_ARGS);
  68 static  int               man_in_pre(MAN_ARGS);
  69 static  void              man_root_post(const struct roff_meta *,
  70                                 struct html *);
  71 static  void              man_root_pre(const struct roff_meta *,
  72                                 struct html *);
  73
  74 static  const struct man_html_act man_html_acts[MAN_MAX - MAN_TH] = {
  75         { NULL, NULL }, /* TH */
  76         { man_SH_pre, NULL }, /* SH */
  77         { man_SS_pre, NULL }, /* SS */
  78         { man_IP_pre, NULL }, /* TP */
  79         { man_IP_pre, NULL }, /* TQ */
  80         { man_PP_pre, NULL }, /* LP */
  81         { man_PP_pre, NULL }, /* PP */
  82         { man_PP_pre, NULL }, /* P */
  83         { man_IP_pre, NULL }, /* IP */
  84         { man_HP_pre, NULL }, /* HP */
  85         { man_SM_pre, NULL }, /* SM */
  86         { man_SM_pre, NULL }, /* SB */
  87         { man_alt_pre, NULL }, /* BI */
  88         { man_alt_pre, NULL }, /* IB */
  89         { man_alt_pre, NULL }, /* BR */
  90         { man_alt_pre, NULL }, /* RB */
  91         { NULL, NULL }, /* R */
  92         { man_B_pre, NULL }, /* B */
  93         { man_I_pre, NULL }, /* I */
  94         { man_alt_pre, NULL }, /* IR */
  95         { man_alt_pre, NULL }, /* RI */
  96         { NULL, NULL }, /* nf */
  97         { NULL, NULL }, /* fi */
  98         { NULL, NULL }, /* RE */
  99         { man_RS_pre, NULL }, /* RS */
 100         { man_ign_pre, NULL }, /* DT */
 101         { man_ign_pre, NULL }, /* UC */
 102         { man_ign_pre, NULL }, /* PD */
 103         { man_ign_pre, NULL }, /* AT */
 104         { man_in_pre, NULL }, /* in */
 105         { man_SY_pre, NULL }, /* SY */
 106         { NULL, NULL }, /* YS */
 107         { man_OP_pre, NULL }, /* OP */
 108         { NULL, NULL }, /* EX */
 109         { NULL, NULL }, /* EE */
 110         { man_UR_pre, NULL }, /* UR */
 111         { NULL, NULL }, /* UE */
 112         { man_UR_pre, NULL }, /* MT */
 113         { NULL, NULL }, /* ME */
 114 };
 115
 116
 117 /*
 118  * Printing leading vertical space before a block.
 119  * This is used for the paragraph macros.
 120  * The rules are pretty simple, since there's very little nesting going
 121  * on here.  Basically, if we're the first within another block (SS/SH),
 122  * then don't emit vertical space.  If we are (RS), then do.  If not the
 123  * first, print it.
 124  */
 125 static void
 126 print_bvspace(struct html *h, const struct roff_node *n)
 127 {
 128
 129         if (n->body && n->body->child)
 130                 if (n->body->child->type == ROFFT_TBL)
 131                         return;
 132
 133         if (n->parent->type == ROFFT_ROOT || n->parent->tok != MAN_RS)
 134                 if (NULL == n->prev)
 135                         return;
 136
 137         print_paragraph(h);
 138 }
 139
 140 void
 141 html_man(void *arg, const struct roff_man *man)
 142 {
 143         struct html             *h;
 144         struct roff_node        *n;
 145         struct tag              *t;
 146
 147         h = (struct html *)arg;
 148         n = man->first->child;
 149
 150         if ((h->oflags & HTML_FRAGMENT) == 0) {
 151                 print_gen_decls(h);
 152                 print_otag(h, TAG_HTML, "");
 153                 if (n->type == ROFFT_COMMENT)
 154                         print_gen_comment(h, n);
 155                 t = print_otag(h, TAG_HEAD, "");
 156                 print_man_head(&man->meta, h);
 157                 print_tagq(h, t);
 158                 print_otag(h, TAG_BODY, "");
 159         }
 160
 161         man_root_pre(&man->meta, h);
 162         t = print_otag(h, TAG_DIV, "c", "manual-text");
 163         print_man_nodelist(&man->meta, n, h);
 164         print_tagq(h, t);
 165         man_root_post(&man->meta, h);
 166         print_tagq(h, NULL);
 167 }
 168
 169 static void
 170 print_man_head(const struct roff_meta *man, struct html *h)
 171 {
 172         char    *cp;
 173
 174         print_gen_head(h);
 175         mandoc_asprintf(&cp, "%s(%s)", man->title, man->msec);
 176         print_otag(h, TAG_TITLE, "");
 177         print_text(h, cp);
 178         free(cp);
 179 }
 180
 181 static void
 182 print_man_nodelist(MAN_ARGS)
 183 {
 184
 185         while (n != NULL) {
 186                 print_man_node(man, n, h);
 187                 n = n->next;
 188         }
 189 }
 190
 191 static void
 192 print_man_node(MAN_ARGS)
 193 {
 194         static int       want_fillmode = MAN_fi;
 195         static int       save_fillmode;
 196
 197         struct tag      *t;
 198         int              child;
 199
 200         /*
 201          * Handle fill mode switch requests up front,
 202          * they would just cause trouble in the subsequent code.
 203          */
 204
 205         switch (n->tok) {
 206         case MAN_nf:
 207         case MAN_EX:
 208                 want_fillmode = MAN_nf;
 209                 return;
 210         case MAN_fi:
 211         case MAN_EE:
 212                 want_fillmode = MAN_fi;
 213                 if (fillmode(h, 0) == MAN_fi)
 214                         print_otag(h, TAG_BR, "");
 215                 return;
 216         default:
 217                 break;
 218         }
 219
 220         /* Set up fill mode for the upcoming node. */
 221
 222         switch (n->type) {
 223         case ROFFT_BLOCK:
 224                 save_fillmode = 0;
 225                 /* Some block macros suspend or cancel .nf. */
 226                 switch (n->tok) {
 227                 case MAN_TP:  /* Tagged paragraphs              */
 228                 case MAN_IP:  /* temporarily disable .nf        */
 229                 case MAN_HP:  /* for the head.                  */
 230                         save_fillmode = want_fillmode;
 231                         /* FALLTHROUGH */
 232                 case MAN_SH:  /* Section headers                */
 233                 case MAN_SS:  /* permanently cancel .nf.        */
 234                         want_fillmode = MAN_fi;
 235                         /* FALLTHROUGH */
 236                 case MAN_PP:  /* These have no head.            */
 237                 case MAN_LP:  /* They will simply               */
 238                 case MAN_P:   /* reopen .nf in the body.        */
 239                 case MAN_RS:
 240                 case MAN_UR:
 241                 case MAN_MT:
 242                         fillmode(h, MAN_fi);
 243                         break;
 244                 default:
 245                         break;
 246                 }
 247                 break;
 248         case ROFFT_TBL:
 249                 fillmode(h, MAN_fi);
 250                 break;
 251         case ROFFT_ELEM:
 252                 /*
 253                  * Some in-line macros produce tags and/or text
 254                  * in the handler, so they require fill mode to be
 255                  * configured up front just like for text nodes.
 256                  * For the others, keep the traditional approach
 257                  * of doing the same, for now.
 258                  */
 259                 fillmode(h, want_fillmode);
 260                 break;
 261         case ROFFT_TEXT:
 262                 if (fillmode(h, want_fillmode) == MAN_fi &&
 263                     want_fillmode == MAN_fi &&
 264                     n->flags & NODE_LINE && *n->string == ' ' &&
 265                     (h->flags & HTML_NONEWLINE) == 0)
 266                         print_otag(h, TAG_BR, "");
 267                 if (want_fillmode == MAN_nf || *n->string != '\0')
 268                         break;
 269                 print_paragraph(h);
 270                 return;
 271         case ROFFT_COMMENT:
 272                 return;
 273         default:
 274                 break;
 275         }
 276
 277         /* Produce output for this node. */
 278
 279         child = 1;
 280         switch (n->type) {
 281         case ROFFT_TEXT:
 282                 t = h->tag;
 283                 print_text(h, n->string);
 284                 break;
 285         case ROFFT_EQN:
 286                 t = h->tag;
 287                 print_eqn(h, n->eqn);
 288                 break;
 289         case ROFFT_TBL:
 290                 /*
 291                  * This will take care of initialising all of the table
 292                  * state data for the first table, then tearing it down
 293                  * for the last one.
 294                  */
 295                 print_tbl(h, n->span);
 296                 return;
 297         default:
 298                 /*
 299                  * Close out scope of font prior to opening a macro
 300                  * scope.
 301                  */
 302                 if (HTMLFONT_NONE != h->metac) {
 303                         h->metal = h->metac;
 304                         h->metac = HTMLFONT_NONE;
 305                 }
 306
 307                 /*
 308                  * Close out the current table, if it's open, and unset
 309                  * the "meta" table state.  This will be reopened on the
 310                  * next table element.
 311                  */
 312                 if (h->tblt)
 313                         print_tblclose(h);
 314
 315                 t = h->tag;
 316                 if (n->tok < ROFF_MAX) {
 317                         roff_html_pre(h, n);
 318                         child = 0;
 319                         break;
 320                 }
 321
 322                 assert(n->tok >= MAN_TH && n->tok < MAN_MAX);
 323                 if (man_html_acts[n->tok - MAN_TH].pre != NULL)
 324                         child = (*man_html_acts[n->tok - MAN_TH].pre)(man,
 325                             n, h);
 326
 327                 /* Some block macros resume .nf in the body. */
 328                 if (save_fillmode && n->type == ROFFT_BODY)
 329                         want_fillmode = save_fillmode;
 330
 331                 break;
 332         }
 333
 334         if (child && n->child)
 335                 print_man_nodelist(man, n->child, h);
 336
 337         /* This will automatically close out any font scope. */
 338         print_stagq(h, t);
 339
 340         if (fillmode(h, 0) == MAN_nf &&
 341             n->next != NULL && n->next->flags & NODE_LINE) {
 342                 /* In .nf = <pre>, print even empty lines. */
 343                 h->col++;
 344                 print_endline(h);
 345         }
 346 }
 347
 348 /*
 349  * MAN_nf switches to no-fill mode, MAN_fi to fill mode.
 350  * Other arguments do not switch.
 351  * The old mode is returned.
 352  */
 353 static int
 354 fillmode(struct html *h, int want)
 355 {
 356         struct tag      *pre;
 357         int              had;
 358
 359         for (pre = h->tag; pre != NULL; pre = pre->next)
 360                 if (pre->tag == TAG_PRE)
 361                         break;
 362
 363         had = pre == NULL ? MAN_fi : MAN_nf;
 364
 365         if (want && want != had) {
 366                 if (want == MAN_nf)
 367                         print_otag(h, TAG_PRE, "");
 368                 else
 369                         print_tagq(h, pre);
 370         }
 371         return had;
 372 }
 373
 374 static void
 375 man_root_pre(const struct roff_meta *man, struct html *h)
 376 {
 377         struct tag      *t, *tt;
 378         char            *title;
 379
 380         assert(man->title);
 381         assert(man->msec);
 382         mandoc_asprintf(&title, "%s(%s)", man->title, man->msec);
 383
 384         t = print_otag(h, TAG_TABLE, "c", "head");
 385         tt = print_otag(h, TAG_TR, "");
 386
 387         print_otag(h, TAG_TD, "c", "head-ltitle");
 388         print_text(h, title);
 389         print_stagq(h, tt);
 390
 391         print_otag(h, TAG_TD, "c", "head-vol");
 392         if (NULL != man->vol)
 393                 print_text(h, man->vol);
 394         print_stagq(h, tt);
 395
 396         print_otag(h, TAG_TD, "c", "head-rtitle");
 397         print_text(h, title);
 398         print_tagq(h, t);
 399         free(title);
 400 }
 401
 402 static void
 403 man_root_post(const struct roff_meta *man, struct html *h)
 404 {
 405         struct tag      *t, *tt;
 406
 407         t = print_otag(h, TAG_TABLE, "c", "foot");
 408         tt = print_otag(h, TAG_TR, "");
 409
 410         print_otag(h, TAG_TD, "c", "foot-date");
 411         print_text(h, man->date);
 412         print_stagq(h, tt);
 413
 414         print_otag(h, TAG_TD, "c", "foot-os");
 415         if (man->os)
 416                 print_text(h, man->os);
 417         print_tagq(h, t);
 418 }
 419
 420 static int
 421 man_SH_pre(MAN_ARGS)
 422 {
 423         char    *id;
 424
 425         if (n->type == ROFFT_HEAD) {
 426                 id = html_make_id(n, 1);
 427                 print_otag(h, TAG_H1, "cTi", "Sh", id);
 428                 if (id != NULL)
 429                         print_otag(h, TAG_A, "chR", "permalink", id);
 430         }
 431         return 1;
 432 }
 433
 434 static int
 435 man_alt_pre(MAN_ARGS)
 436 {
 437         const struct roff_node  *nn;
 438         int              i;
 439         enum htmltag     fp;
 440         struct tag      *t;
 441
 442         for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
 443                 switch (n->tok) {
 444                 case MAN_BI:
 445                         fp = i % 2 ? TAG_I : TAG_B;
 446                         break;
 447                 case MAN_IB:
 448                         fp = i % 2 ? TAG_B : TAG_I;
 449                         break;
 450                 case MAN_RI:
 451                         fp = i % 2 ? TAG_I : TAG_MAX;
 452                         break;
 453                 case MAN_IR:
 454                         fp = i % 2 ? TAG_MAX : TAG_I;
 455                         break;
 456                 case MAN_BR:
 457                         fp = i % 2 ? TAG_MAX : TAG_B;
 458                         break;
 459                 case MAN_RB:
 460                         fp = i % 2 ? TAG_B : TAG_MAX;
 461                         break;
 462                 default:
 463                         abort();
 464                 }
 465
 466                 if (i)
 467                         h->flags |= HTML_NOSPACE;
 468
 469                 if (fp != TAG_MAX)
 470                         t = print_otag(h, fp, "");
 471
 472                 print_text(h, nn->string);
 473
 474                 if (fp != TAG_MAX)
 475                         print_tagq(h, t);
 476         }
 477         return 0;
 478 }
 479
 480 static int
 481 man_SM_pre(MAN_ARGS)
 482 {
 483         print_otag(h, TAG_SMALL, "");
 484         if (MAN_SB == n->tok)
 485                 print_otag(h, TAG_B, "");
 486         return 1;
 487 }
 488
 489 static int
 490 man_SS_pre(MAN_ARGS)
 491 {
 492         char    *id;
 493
 494         if (n->type == ROFFT_HEAD) {
 495                 id = html_make_id(n, 1);
 496                 print_otag(h, TAG_H2, "cTi", "Ss", id);
 497                 if (id != NULL)
 498                         print_otag(h, TAG_A, "chR", "permalink", id);
 499         }
 500         return 1;
 501 }
 502
 503 static int
 504 man_PP_pre(MAN_ARGS)
 505 {
 506
 507         if (n->type == ROFFT_HEAD)
 508                 return 0;
 509         else if (n->type == ROFFT_BLOCK)
 510                 print_bvspace(h, n);
 511
 512         return 1;
 513 }
 514
 515 static int
 516 man_IP_pre(MAN_ARGS)
 517 {
 518         const struct roff_node  *nn;
 519
 520         if (n->type == ROFFT_BODY) {
 521                 print_otag(h, TAG_DD, "");
 522                 return 1;
 523         } else if (n->type != ROFFT_HEAD) {
 524                 print_otag(h, TAG_DL, "c", "Bl-tag");
 525                 return 1;
 526         }
 527
 528         print_otag(h, TAG_DT, "");
 529
 530         switch(n->tok) {
 531         case MAN_IP:  /* Only print the first header element. */
 532                 if (n->child != NULL)
 533                         print_man_node(man, n->child, h);
 534                 break;
 535         case MAN_TP:  /* Only print next-line header elements. */
 536         case MAN_TQ:
 537                 nn = n->child;
 538                 while (nn != NULL && (NODE_LINE & nn->flags) == 0)
 539                         nn = nn->next;
 540                 while (nn != NULL) {
 541                         print_man_node(man, nn, h);
 542                         nn = nn->next;
 543                 }
 544                 break;
 545         default:
 546                 abort();
 547         }
 548
 549         return 0;
 550 }
 551
 552 static int
 553 man_HP_pre(MAN_ARGS)
 554 {
 555         if (n->type == ROFFT_HEAD)
 556                 return 0;
 557
 558         if (n->type == ROFFT_BLOCK) {
 559                 print_bvspace(h, n);
 560                 print_otag(h, TAG_DIV, "c", "HP");
 561         }
 562         return 1;
 563 }
 564
 565 static int
 566 man_OP_pre(MAN_ARGS)
 567 {
 568         struct tag      *tt;
 569
 570         print_text(h, "[");
 571         h->flags |= HTML_NOSPACE;
 572         tt = print_otag(h, TAG_SPAN, "c", "Op");
 573
 574         if (NULL != (n = n->child)) {
 575                 print_otag(h, TAG_B, "");
 576                 print_text(h, n->string);
 577         }
 578
 579         print_stagq(h, tt);
 580
 581         if (NULL != n && NULL != n->next) {
 582                 print_otag(h, TAG_I, "");
 583                 print_text(h, n->next->string);
 584         }
 585
 586         print_stagq(h, tt);
 587         h->flags |= HTML_NOSPACE;
 588         print_text(h, "]");
 589         return 0;
 590 }
 591
 592 static int
 593 man_B_pre(MAN_ARGS)
 594 {
 595         print_otag(h, TAG_B, "");
 596         return 1;
 597 }
 598
 599 static int
 600 man_I_pre(MAN_ARGS)
 601 {
 602         print_otag(h, TAG_I, "");
 603         return 1;
 604 }
 605
 606 static int
 607 man_in_pre(MAN_ARGS)
 608 {
 609         print_otag(h, TAG_BR, "");
 610         return 0;
 611 }
 612
 613 static int
 614 man_ign_pre(MAN_ARGS)
 615 {
 616
 617         return 0;
 618 }
 619
 620 static int
 621 man_RS_pre(MAN_ARGS)
 622 {
 623         if (n->type == ROFFT_HEAD)
 624                 return 0;
 625         if (n->type == ROFFT_BLOCK)
 626                 print_otag(h, TAG_DIV, "c", "Bd-indent");
 627         return 1;
 628 }
 629
 630 static int
 631 man_SY_pre(MAN_ARGS)
 632 {
 633         switch (n->type) {
 634         case ROFFT_BLOCK:
 635                 print_otag(h, TAG_TABLE, "c", "Nm");
 636                 print_otag(h, TAG_TR, "");
 637                 break;
 638         case ROFFT_HEAD:
 639                 print_otag(h, TAG_TD, "");
 640                 print_otag(h, TAG_CODE, "cT", "Nm");
 641                 break;
 642         case ROFFT_BODY:
 643                 print_otag(h, TAG_TD, "");
 644                 break;
 645         default:
 646                 abort();
 647         }
 648         return 1;
 649 }
 650
 651 static int
 652 man_UR_pre(MAN_ARGS)
 653 {
 654         char *cp;
 655         n = n->child;
 656         assert(n->type == ROFFT_HEAD);
 657         if (n->child != NULL) {
 658                 assert(n->child->type == ROFFT_TEXT);
 659                 if (n->tok == MAN_MT) {
 660                         mandoc_asprintf(&cp, "mailto:%s", n->child->string);
 661                         print_otag(h, TAG_A, "cTh", "Mt", cp);
 662                         free(cp);
 663                 } else
 664                         print_otag(h, TAG_A, "cTh", "Lk", n->child->string);
 665         }
 666
 667         assert(n->next->type == ROFFT_BODY);
 668         if (n->next->child != NULL)
 669                 n = n->next;
 670
 671         print_man_nodelist(man, n->child, h);
 672
 673         return 0;
 674 }