man_html.c

   1 /*      $Id: man_html.c,v 1.156 2018/08/18 02:08:27 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 (*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                 print_endline(h);
 343 }
 344
 345 /*
 346  * MAN_nf switches to no-fill mode, MAN_fi to fill mode.
 347  * Other arguments do not switch.
 348  * The old mode is returned.
 349  */
 350 static int
 351 fillmode(struct html *h, int want)
 352 {
 353         struct tag      *pre;
 354         int              had;
 355
 356         for (pre = h->tag; pre != NULL; pre = pre->next)
 357                 if (pre->tag == TAG_PRE)
 358                         break;
 359
 360         had = pre == NULL ? MAN_fi : MAN_nf;
 361
 362         if (want && want != had) {
 363                 if (want == MAN_nf)
 364                         print_otag(h, TAG_PRE, "");
 365                 else
 366                         print_tagq(h, pre);
 367         }
 368         return had;
 369 }
 370
 371 static void
 372 man_root_pre(const struct roff_meta *man, struct html *h)
 373 {
 374         struct tag      *t, *tt;
 375         char            *title;
 376
 377         assert(man->title);
 378         assert(man->msec);
 379         mandoc_asprintf(&title, "%s(%s)", man->title, man->msec);
 380
 381         t = print_otag(h, TAG_TABLE, "c", "head");
 382         tt = print_otag(h, TAG_TR, "");
 383
 384         print_otag(h, TAG_TD, "c", "head-ltitle");
 385         print_text(h, title);
 386         print_stagq(h, tt);
 387
 388         print_otag(h, TAG_TD, "c", "head-vol");
 389         if (NULL != man->vol)
 390                 print_text(h, man->vol);
 391         print_stagq(h, tt);
 392
 393         print_otag(h, TAG_TD, "c", "head-rtitle");
 394         print_text(h, title);
 395         print_tagq(h, t);
 396         free(title);
 397 }
 398
 399 static void
 400 man_root_post(const struct roff_meta *man, struct html *h)
 401 {
 402         struct tag      *t, *tt;
 403
 404         t = print_otag(h, TAG_TABLE, "c", "foot");
 405         tt = print_otag(h, TAG_TR, "");
 406
 407         print_otag(h, TAG_TD, "c", "foot-date");
 408         print_text(h, man->date);
 409         print_stagq(h, tt);
 410
 411         print_otag(h, TAG_TD, "c", "foot-os");
 412         if (man->os)
 413                 print_text(h, man->os);
 414         print_tagq(h, t);
 415 }
 416
 417 static int
 418 man_SH_pre(MAN_ARGS)
 419 {
 420         char    *id;
 421
 422         if (n->type == ROFFT_HEAD) {
 423                 id = html_make_id(n, 1);
 424                 print_otag(h, TAG_H1, "cTi", "Sh", id);
 425                 if (id != NULL)
 426                         print_otag(h, TAG_A, "chR", "permalink", id);
 427         }
 428         return 1;
 429 }
 430
 431 static int
 432 man_alt_pre(MAN_ARGS)
 433 {
 434         const struct roff_node  *nn;
 435         int              i;
 436         enum htmltag     fp;
 437         struct tag      *t;
 438
 439         for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
 440                 switch (n->tok) {
 441                 case MAN_BI:
 442                         fp = i % 2 ? TAG_I : TAG_B;
 443                         break;
 444                 case MAN_IB:
 445                         fp = i % 2 ? TAG_B : TAG_I;
 446                         break;
 447                 case MAN_RI:
 448                         fp = i % 2 ? TAG_I : TAG_MAX;
 449                         break;
 450                 case MAN_IR:
 451                         fp = i % 2 ? TAG_MAX : TAG_I;
 452                         break;
 453                 case MAN_BR:
 454                         fp = i % 2 ? TAG_MAX : TAG_B;
 455                         break;
 456                 case MAN_RB:
 457                         fp = i % 2 ? TAG_B : TAG_MAX;
 458                         break;
 459                 default:
 460                         abort();
 461                 }
 462
 463                 if (i)
 464                         h->flags |= HTML_NOSPACE;
 465
 466                 if (fp != TAG_MAX)
 467                         t = print_otag(h, fp, "");
 468
 469                 print_text(h, nn->string);
 470
 471                 if (fp != TAG_MAX)
 472                         print_tagq(h, t);
 473         }
 474         return 0;
 475 }
 476
 477 static int
 478 man_SM_pre(MAN_ARGS)
 479 {
 480         print_otag(h, TAG_SMALL, "");
 481         if (MAN_SB == n->tok)
 482                 print_otag(h, TAG_B, "");
 483         return 1;
 484 }
 485
 486 static int
 487 man_SS_pre(MAN_ARGS)
 488 {
 489         char    *id;
 490
 491         if (n->type == ROFFT_HEAD) {
 492                 id = html_make_id(n, 1);
 493                 print_otag(h, TAG_H2, "cTi", "Ss", id);
 494                 if (id != NULL)
 495                         print_otag(h, TAG_A, "chR", "permalink", id);
 496         }
 497         return 1;
 498 }
 499
 500 static int
 501 man_PP_pre(MAN_ARGS)
 502 {
 503
 504         if (n->type == ROFFT_HEAD)
 505                 return 0;
 506         else if (n->type == ROFFT_BLOCK)
 507                 print_bvspace(h, n);
 508
 509         return 1;
 510 }
 511
 512 static int
 513 man_IP_pre(MAN_ARGS)
 514 {
 515         const struct roff_node  *nn;
 516
 517         if (n->type == ROFFT_BODY) {
 518                 print_otag(h, TAG_DD, "");
 519                 return 1;
 520         } else if (n->type != ROFFT_HEAD) {
 521                 print_otag(h, TAG_DL, "c", "Bl-tag");
 522                 return 1;
 523         }
 524
 525         print_otag(h, TAG_DT, "");
 526
 527         switch(n->tok) {
 528         case MAN_IP:  /* Only print the first header element. */
 529                 if (n->child != NULL)
 530                         print_man_node(man, n->child, h);
 531                 break;
 532         case MAN_TP:  /* Only print next-line header elements. */
 533         case MAN_TQ:
 534                 nn = n->child;
 535                 while (nn != NULL && (NODE_LINE & nn->flags) == 0)
 536                         nn = nn->next;
 537                 while (nn != NULL) {
 538                         print_man_node(man, nn, h);
 539                         nn = nn->next;
 540                 }
 541                 break;
 542         default:
 543                 abort();
 544         }
 545
 546         return 0;
 547 }
 548
 549 static int
 550 man_HP_pre(MAN_ARGS)
 551 {
 552         if (n->type == ROFFT_HEAD)
 553                 return 0;
 554
 555         if (n->type == ROFFT_BLOCK) {
 556                 print_bvspace(h, n);
 557                 print_otag(h, TAG_DIV, "c", "HP");
 558         }
 559         return 1;
 560 }
 561
 562 static int
 563 man_OP_pre(MAN_ARGS)
 564 {
 565         struct tag      *tt;
 566
 567         print_text(h, "[");
 568         h->flags |= HTML_NOSPACE;
 569         tt = print_otag(h, TAG_SPAN, "c", "Op");
 570
 571         if (NULL != (n = n->child)) {
 572                 print_otag(h, TAG_B, "");
 573                 print_text(h, n->string);
 574         }
 575
 576         print_stagq(h, tt);
 577
 578         if (NULL != n && NULL != n->next) {
 579                 print_otag(h, TAG_I, "");
 580                 print_text(h, n->next->string);
 581         }
 582
 583         print_stagq(h, tt);
 584         h->flags |= HTML_NOSPACE;
 585         print_text(h, "]");
 586         return 0;
 587 }
 588
 589 static int
 590 man_B_pre(MAN_ARGS)
 591 {
 592         print_otag(h, TAG_B, "");
 593         return 1;
 594 }
 595
 596 static int
 597 man_I_pre(MAN_ARGS)
 598 {
 599         print_otag(h, TAG_I, "");
 600         return 1;
 601 }
 602
 603 static int
 604 man_in_pre(MAN_ARGS)
 605 {
 606         print_otag(h, TAG_BR, "");
 607         return 0;
 608 }
 609
 610 static int
 611 man_ign_pre(MAN_ARGS)
 612 {
 613
 614         return 0;
 615 }
 616
 617 static int
 618 man_RS_pre(MAN_ARGS)
 619 {
 620         if (n->type == ROFFT_HEAD)
 621                 return 0;
 622         if (n->type == ROFFT_BLOCK)
 623                 print_otag(h, TAG_DIV, "c", "Bd-indent");
 624         return 1;
 625 }
 626
 627 static int
 628 man_SY_pre(MAN_ARGS)
 629 {
 630         switch (n->type) {
 631         case ROFFT_BLOCK:
 632                 print_otag(h, TAG_TABLE, "c", "Nm");
 633                 print_otag(h, TAG_TR, "");
 634                 break;
 635         case ROFFT_HEAD:
 636                 print_otag(h, TAG_TD, "");
 637                 print_otag(h, TAG_CODE, "cT", "Nm");
 638                 break;
 639         case ROFFT_BODY:
 640                 print_otag(h, TAG_TD, "");
 641                 break;
 642         default:
 643                 abort();
 644         }
 645         return 1;
 646 }
 647
 648 static int
 649 man_UR_pre(MAN_ARGS)
 650 {
 651         char *cp;
 652         n = n->child;
 653         assert(n->type == ROFFT_HEAD);
 654         if (n->child != NULL) {
 655                 assert(n->child->type == ROFFT_TEXT);
 656                 if (n->tok == MAN_MT) {
 657                         mandoc_asprintf(&cp, "mailto:%s", n->child->string);
 658                         print_otag(h, TAG_A, "cTh", "Mt", cp);
 659                         free(cp);
 660                 } else
 661                         print_otag(h, TAG_A, "cTh", "Lk", n->child->string);
 662         }
 663
 664         assert(n->next->type == ROFFT_BODY);
 665         if (n->next->child != NULL)
 666                 n = n->next;
 667
 668         print_man_nodelist(man, n->child, h);
 669
 670         return 0;
 671 }