Annotation of src/usr.bin/mandoc/man_html.c, Revision 1.119
1.119 ! schwarze 1: /* $OpenBSD: man_html.c,v 1.118 2019/01/05 21:52:57 schwarze Exp $ */
1.1 schwarze 2: /*
1.56 schwarze 3: * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.116 schwarze 4: * Copyright (c) 2013-2015, 2017-2019 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 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: *
1.66 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1 schwarze 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.66 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1 schwarze 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 <sys/types.h>
19:
20: #include <assert.h>
21: #include <ctype.h>
22: #include <stdio.h>
23: #include <stdlib.h>
24: #include <string.h>
25:
1.53 schwarze 26: #include "mandoc_aux.h"
1.113 schwarze 27: #include "mandoc.h"
1.66 schwarze 28: #include "roff.h"
1.58 schwarze 29: #include "man.h"
1.1 schwarze 30: #include "out.h"
31: #include "html.h"
32: #include "main.h"
33:
1.68 schwarze 34: #define MAN_ARGS const struct roff_meta *man, \
1.67 schwarze 35: const struct roff_node *n, \
1.1 schwarze 36: struct html *h
37:
1.108 schwarze 38: struct man_html_act {
1.1 schwarze 39: int (*pre)(MAN_ARGS);
40: int (*post)(MAN_ARGS);
41: };
42:
1.100 schwarze 43: static void print_man_head(const struct roff_meta *,
44: struct html *);
1.1 schwarze 45: static void print_man_nodelist(MAN_ARGS);
46: static void print_man_node(MAN_ARGS);
47: static int man_B_pre(MAN_ARGS);
1.46 schwarze 48: static int man_IP_pre(MAN_ARGS);
1.1 schwarze 49: static int man_I_pre(MAN_ARGS);
1.46 schwarze 50: static int man_OP_pre(MAN_ARGS);
1.1 schwarze 51: static int man_PP_pre(MAN_ARGS);
52: static int man_RS_pre(MAN_ARGS);
53: static int man_SH_pre(MAN_ARGS);
54: static int man_SM_pre(MAN_ARGS);
1.109 schwarze 55: static int man_SY_pre(MAN_ARGS);
1.49 schwarze 56: static int man_UR_pre(MAN_ARGS);
1.111 schwarze 57: static int man_abort_pre(MAN_ARGS);
1.46 schwarze 58: static int man_alt_pre(MAN_ARGS);
59: static int man_ign_pre(MAN_ARGS);
60: static int man_in_pre(MAN_ARGS);
1.100 schwarze 61: static void man_root_post(const struct roff_meta *,
62: struct html *);
63: static void man_root_pre(const struct roff_meta *,
64: struct html *);
1.1 schwarze 65:
1.108 schwarze 66: static const struct man_html_act man_html_acts[MAN_MAX - MAN_TH] = {
1.1 schwarze 67: { NULL, NULL }, /* TH */
68: { man_SH_pre, NULL }, /* SH */
1.119 ! schwarze 69: { man_SH_pre, NULL }, /* SS */
1.1 schwarze 70: { man_IP_pre, NULL }, /* TP */
1.107 schwarze 71: { man_IP_pre, NULL }, /* TQ */
1.111 schwarze 72: { man_abort_pre, NULL }, /* LP */
1.1 schwarze 73: { man_PP_pre, NULL }, /* PP */
1.111 schwarze 74: { man_abort_pre, NULL }, /* P */
1.1 schwarze 75: { man_IP_pre, NULL }, /* IP */
1.119 ! schwarze 76: { man_PP_pre, NULL }, /* HP */
1.1 schwarze 77: { man_SM_pre, NULL }, /* SM */
1.26 schwarze 78: { man_SM_pre, NULL }, /* SB */
1.1 schwarze 79: { man_alt_pre, NULL }, /* BI */
80: { man_alt_pre, NULL }, /* IB */
81: { man_alt_pre, NULL }, /* BR */
82: { man_alt_pre, NULL }, /* RB */
83: { NULL, NULL }, /* R */
84: { man_B_pre, NULL }, /* B */
85: { man_I_pre, NULL }, /* I */
86: { man_alt_pre, NULL }, /* IR */
87: { man_alt_pre, NULL }, /* RI */
88: { NULL, NULL }, /* RE */
89: { man_RS_pre, NULL }, /* RS */
90: { man_ign_pre, NULL }, /* DT */
91: { man_ign_pre, NULL }, /* UC */
1.2 schwarze 92: { man_ign_pre, NULL }, /* PD */
1.13 schwarze 93: { man_ign_pre, NULL }, /* AT */
1.18 schwarze 94: { man_in_pre, NULL }, /* in */
1.109 schwarze 95: { man_SY_pre, NULL }, /* SY */
96: { NULL, NULL }, /* YS */
1.46 schwarze 97: { man_OP_pre, NULL }, /* OP */
1.85 schwarze 98: { NULL, NULL }, /* EX */
99: { NULL, NULL }, /* EE */
1.49 schwarze 100: { man_UR_pre, NULL }, /* UR */
101: { NULL, NULL }, /* UE */
1.98 bentley 102: { man_UR_pre, NULL }, /* MT */
103: { NULL, NULL }, /* ME */
1.1 schwarze 104: };
105:
1.52 schwarze 106:
1.1 schwarze 107: void
1.114 schwarze 108: html_man(void *arg, const struct roff_meta *man)
1.1 schwarze 109: {
1.100 schwarze 110: struct html *h;
111: struct roff_node *n;
112: struct tag *t;
1.43 schwarze 113:
1.70 schwarze 114: h = (struct html *)arg;
1.100 schwarze 115: n = man->first->child;
1.1 schwarze 116:
1.79 schwarze 117: if ((h->oflags & HTML_FRAGMENT) == 0) {
1.43 schwarze 118: print_gen_decls(h);
1.79 schwarze 119: print_otag(h, TAG_HTML, "");
1.100 schwarze 120: if (n->type == ROFFT_COMMENT)
121: print_gen_comment(h, n);
1.79 schwarze 122: t = print_otag(h, TAG_HEAD, "");
1.114 schwarze 123: print_man_head(man, h);
1.79 schwarze 124: print_tagq(h, t);
1.75 schwarze 125: print_otag(h, TAG_BODY, "");
1.79 schwarze 126: }
1.25 schwarze 127:
1.114 schwarze 128: man_root_pre(man, h);
1.80 schwarze 129: t = print_otag(h, TAG_DIV, "c", "manual-text");
1.114 schwarze 130: print_man_nodelist(man, n, h);
1.80 schwarze 131: print_tagq(h, t);
1.114 schwarze 132: man_root_post(man, h);
1.79 schwarze 133: print_tagq(h, NULL);
1.1 schwarze 134: }
135:
136: static void
1.100 schwarze 137: print_man_head(const struct roff_meta *man, struct html *h)
1.1 schwarze 138: {
1.76 schwarze 139: char *cp;
1.1 schwarze 140:
141: print_gen_head(h);
1.76 schwarze 142: mandoc_asprintf(&cp, "%s(%s)", man->title, man->msec);
1.75 schwarze 143: print_otag(h, TAG_TITLE, "");
1.76 schwarze 144: print_text(h, cp);
145: free(cp);
1.1 schwarze 146: }
147:
148: static void
149: print_man_nodelist(MAN_ARGS)
150: {
1.63 schwarze 151: while (n != NULL) {
1.85 schwarze 152: print_man_node(man, n, h);
1.63 schwarze 153: n = n->next;
154: }
1.1 schwarze 155: }
156:
157: static void
158: print_man_node(MAN_ARGS)
159: {
1.85 schwarze 160: struct tag *t;
1.1 schwarze 161: int child;
162:
1.116 schwarze 163: html_fillmode(h, n->flags & NODE_NOFILL ? ROFF_nf : ROFF_fi);
1.85 schwarze 164:
165: child = 1;
166: switch (n->type) {
167: case ROFFT_TEXT:
1.116 schwarze 168: if (*n->string == '\0') {
169: print_endline(h);
170: return;
171: }
1.85 schwarze 172: t = h->tag;
1.116 schwarze 173: if (*n->string == ' ' && n->flags & NODE_LINE &&
174: (h->flags & HTML_NONEWLINE) == 0)
175: print_endline(h);
176: else if (n->flags & NODE_DELIMC)
177: h->flags |= HTML_NOSPACE;
1.1 schwarze 178: print_text(h, n->string);
1.83 schwarze 179: break;
1.116 schwarze 180: case ROFFT_COMMENT:
181: return;
1.66 schwarze 182: case ROFFT_EQN:
1.85 schwarze 183: t = h->tag;
1.41 schwarze 184: print_eqn(h, n->eqn);
1.37 schwarze 185: break;
1.66 schwarze 186: case ROFFT_TBL:
1.33 schwarze 187: /*
188: * This will take care of initialising all of the table
189: * state data for the first table, then tearing it down
190: * for the last one.
191: */
1.29 schwarze 192: print_tbl(h, n->span);
1.32 schwarze 193: return;
1.1 schwarze 194: default:
1.52 schwarze 195: /*
1.4 schwarze 196: * Close out scope of font prior to opening a macro
1.33 schwarze 197: * scope.
1.4 schwarze 198: */
1.27 schwarze 199: if (HTMLFONT_NONE != h->metac) {
200: h->metal = h->metac;
201: h->metac = HTMLFONT_NONE;
1.33 schwarze 202: }
203:
204: /*
205: * Close out the current table, if it's open, and unset
206: * the "meta" table state. This will be reopened on the
207: * next table element.
208: */
1.117 schwarze 209: if (h->tblt != NULL)
1.33 schwarze 210: print_tblclose(h);
1.85 schwarze 211:
212: t = h->tag;
1.90 schwarze 213: if (n->tok < ROFF_MAX) {
1.91 schwarze 214: roff_html_pre(h, n);
1.119 ! schwarze 215: if (n->tok != ROFF_sp)
! 216: print_stagq(h, t);
1.116 schwarze 217: return;
1.90 schwarze 218: }
219:
220: assert(n->tok >= MAN_TH && n->tok < MAN_MAX);
1.108 schwarze 221: if (man_html_acts[n->tok - MAN_TH].pre != NULL)
222: child = (*man_html_acts[n->tok - MAN_TH].pre)(man,
223: n, h);
1.1 schwarze 224: break;
225: }
226:
1.117 schwarze 227: if (child && n->child != NULL)
1.85 schwarze 228: print_man_nodelist(man, n->child, h);
1.1 schwarze 229:
1.4 schwarze 230: /* This will automatically close out any font scope. */
1.85 schwarze 231: print_stagq(h, t);
232:
1.118 schwarze 233: if (n->flags & NODE_NOFILL && n->tok != MAN_YS &&
234: (n->next != NULL && n->next->flags & NODE_LINE)) {
1.110 schwarze 235: /* In .nf = <pre>, print even empty lines. */
236: h->col++;
1.85 schwarze 237: print_endline(h);
1.110 schwarze 238: }
1.1 schwarze 239: }
240:
1.38 schwarze 241: static void
1.100 schwarze 242: man_root_pre(const struct roff_meta *man, struct html *h)
1.1 schwarze 243: {
244: struct tag *t, *tt;
1.53 schwarze 245: char *title;
1.1 schwarze 246:
1.48 schwarze 247: assert(man->title);
248: assert(man->msec);
1.53 schwarze 249: mandoc_asprintf(&title, "%s(%s)", man->title, man->msec);
1.1 schwarze 250:
1.75 schwarze 251: t = print_otag(h, TAG_TABLE, "c", "head");
252: tt = print_otag(h, TAG_TR, "");
1.1 schwarze 253:
1.75 schwarze 254: print_otag(h, TAG_TD, "c", "head-ltitle");
1.1 schwarze 255: print_text(h, title);
256: print_stagq(h, tt);
257:
1.75 schwarze 258: print_otag(h, TAG_TD, "c", "head-vol");
1.117 schwarze 259: if (man->vol != NULL)
1.54 schwarze 260: print_text(h, man->vol);
1.1 schwarze 261: print_stagq(h, tt);
262:
1.75 schwarze 263: print_otag(h, TAG_TD, "c", "head-rtitle");
1.1 schwarze 264: print_text(h, title);
265: print_tagq(h, t);
1.53 schwarze 266: free(title);
1.1 schwarze 267: }
268:
269: static void
1.100 schwarze 270: man_root_post(const struct roff_meta *man, struct html *h)
1.1 schwarze 271: {
272: struct tag *t, *tt;
273:
1.75 schwarze 274: t = print_otag(h, TAG_TABLE, "c", "foot");
275: tt = print_otag(h, TAG_TR, "");
1.25 schwarze 276:
1.75 schwarze 277: print_otag(h, TAG_TD, "c", "foot-date");
1.48 schwarze 278: print_text(h, man->date);
1.1 schwarze 279: print_stagq(h, tt);
280:
1.75 schwarze 281: print_otag(h, TAG_TD, "c", "foot-os");
1.117 schwarze 282: if (man->os != NULL)
1.68 schwarze 283: print_text(h, man->os);
1.1 schwarze 284: print_tagq(h, t);
285: }
286:
287: static int
288: man_SH_pre(MAN_ARGS)
289: {
1.87 schwarze 290: char *id;
291:
1.119 ! schwarze 292: switch (n->type) {
! 293: case ROFFT_BLOCK:
! 294: html_close_paragraph(h);
! 295: break;
! 296: case ROFFT_HEAD:
1.103 schwarze 297: id = html_make_id(n, 1);
1.119 ! schwarze 298: if (n->tok == MAN_SH)
! 299: print_otag(h, TAG_H1, "cTi", "Sh", id);
! 300: else
! 301: print_otag(h, TAG_H2, "cTi", "Ss", id);
1.88 schwarze 302: if (id != NULL)
1.101 schwarze 303: print_otag(h, TAG_A, "chR", "permalink", id);
1.119 ! schwarze 304: break;
! 305: case ROFFT_BODY:
! 306: break;
! 307: default:
! 308: abort();
1.87 schwarze 309: }
1.72 schwarze 310: return 1;
1.1 schwarze 311: }
312:
313: static int
314: man_alt_pre(MAN_ARGS)
315: {
1.67 schwarze 316: const struct roff_node *nn;
1.117 schwarze 317: struct tag *t;
1.83 schwarze 318: int i;
1.27 schwarze 319: enum htmltag fp;
1.1 schwarze 320:
1.117 schwarze 321: for (i = 0, nn = n->child; nn != NULL; nn = nn->next, i++) {
1.1 schwarze 322: switch (n->tok) {
1.52 schwarze 323: case MAN_BI:
1.27 schwarze 324: fp = i % 2 ? TAG_I : TAG_B;
1.1 schwarze 325: break;
1.52 schwarze 326: case MAN_IB:
1.27 schwarze 327: fp = i % 2 ? TAG_B : TAG_I;
1.1 schwarze 328: break;
1.52 schwarze 329: case MAN_RI:
1.27 schwarze 330: fp = i % 2 ? TAG_I : TAG_MAX;
1.1 schwarze 331: break;
1.52 schwarze 332: case MAN_IR:
1.27 schwarze 333: fp = i % 2 ? TAG_MAX : TAG_I;
1.1 schwarze 334: break;
1.52 schwarze 335: case MAN_BR:
1.27 schwarze 336: fp = i % 2 ? TAG_MAX : TAG_B;
1.1 schwarze 337: break;
1.52 schwarze 338: case MAN_RB:
1.27 schwarze 339: fp = i % 2 ? TAG_B : TAG_MAX;
1.1 schwarze 340: break;
341: default:
342: abort();
343: }
344:
345: if (i)
346: h->flags |= HTML_NOSPACE;
347:
1.83 schwarze 348: if (fp != TAG_MAX)
1.75 schwarze 349: t = print_otag(h, fp, "");
1.27 schwarze 350:
1.83 schwarze 351: print_text(h, nn->string);
1.27 schwarze 352:
1.83 schwarze 353: if (fp != TAG_MAX)
1.27 schwarze 354: print_tagq(h, t);
1.1 schwarze 355: }
1.72 schwarze 356: return 0;
1.1 schwarze 357: }
358:
359: static int
1.26 schwarze 360: man_SM_pre(MAN_ARGS)
1.1 schwarze 361: {
1.75 schwarze 362: print_otag(h, TAG_SMALL, "");
1.117 schwarze 363: if (n->tok == MAN_SB)
1.75 schwarze 364: print_otag(h, TAG_B, "");
1.72 schwarze 365: return 1;
1.1 schwarze 366: }
367:
368: static int
369: man_PP_pre(MAN_ARGS)
370: {
1.119 ! schwarze 371: switch (n->type) {
! 372: case ROFFT_BLOCK:
! 373: html_close_paragraph(h);
! 374: break;
! 375: case ROFFT_HEAD:
1.72 schwarze 376: return 0;
1.119 ! schwarze 377: case ROFFT_BODY:
! 378: if (n->child != NULL &&
! 379: (n->child->flags & NODE_NOFILL) == 0)
! 380: print_otag(h, TAG_P, "c",
! 381: n->tok == MAN_PP ? "Pp" : "Pp HP");
! 382: break;
! 383: default:
! 384: abort();
! 385: }
1.72 schwarze 386: return 1;
1.1 schwarze 387: }
388:
389: static int
390: man_IP_pre(MAN_ARGS)
391: {
1.67 schwarze 392: const struct roff_node *nn;
1.1 schwarze 393:
1.119 ! schwarze 394: switch (n->type) {
! 395: case ROFFT_BLOCK:
! 396: html_close_paragraph(h);
! 397: print_otag(h, TAG_DL, "c", "Bl-tag");
! 398: return 1;
! 399: case ROFFT_HEAD:
! 400: print_otag(h, TAG_DT, "");
! 401: break;
! 402: case ROFFT_BODY:
1.102 schwarze 403: print_otag(h, TAG_DD, "");
1.72 schwarze 404: return 1;
1.119 ! schwarze 405: default:
! 406: abort();
1.1 schwarze 407: }
408:
1.107 schwarze 409: switch(n->tok) {
410: case MAN_IP: /* Only print the first header element. */
411: if (n->child != NULL)
412: print_man_node(man, n->child, h);
413: break;
414: case MAN_TP: /* Only print next-line header elements. */
415: case MAN_TQ:
1.50 schwarze 416: nn = n->child;
1.107 schwarze 417: while (nn != NULL && (NODE_LINE & nn->flags) == 0)
1.50 schwarze 418: nn = nn->next;
1.107 schwarze 419: while (nn != NULL) {
1.85 schwarze 420: print_man_node(man, nn, h);
1.50 schwarze 421: nn = nn->next;
422: }
1.107 schwarze 423: break;
424: default:
425: abort();
1.50 schwarze 426: }
1.72 schwarze 427: return 0;
1.1 schwarze 428: }
429:
430: static int
1.46 schwarze 431: man_OP_pre(MAN_ARGS)
432: {
433: struct tag *tt;
434:
435: print_text(h, "[");
436: h->flags |= HTML_NOSPACE;
1.81 schwarze 437: tt = print_otag(h, TAG_SPAN, "c", "Op");
1.46 schwarze 438:
1.117 schwarze 439: if ((n = n->child) != NULL) {
1.75 schwarze 440: print_otag(h, TAG_B, "");
1.46 schwarze 441: print_text(h, n->string);
442: }
443:
444: print_stagq(h, tt);
445:
1.117 schwarze 446: if (n != NULL && n->next != NULL) {
1.75 schwarze 447: print_otag(h, TAG_I, "");
1.46 schwarze 448: print_text(h, n->next->string);
449: }
450:
451: print_stagq(h, tt);
452: h->flags |= HTML_NOSPACE;
453: print_text(h, "]");
1.72 schwarze 454: return 0;
1.46 schwarze 455: }
456:
1.1 schwarze 457: static int
458: man_B_pre(MAN_ARGS)
459: {
1.75 schwarze 460: print_otag(h, TAG_B, "");
1.72 schwarze 461: return 1;
1.1 schwarze 462: }
463:
464: static int
465: man_I_pre(MAN_ARGS)
466: {
1.75 schwarze 467: print_otag(h, TAG_I, "");
1.72 schwarze 468: return 1;
1.18 schwarze 469: }
470:
471: static int
472: man_in_pre(MAN_ARGS)
473: {
1.75 schwarze 474: print_otag(h, TAG_BR, "");
1.72 schwarze 475: return 0;
1.1 schwarze 476: }
477:
478: static int
479: man_ign_pre(MAN_ARGS)
480: {
1.72 schwarze 481: return 0;
1.1 schwarze 482: }
483:
484: static int
485: man_RS_pre(MAN_ARGS)
486: {
1.119 ! schwarze 487: switch (n->type) {
! 488: case ROFFT_BLOCK:
! 489: html_close_paragraph(h);
! 490: break;
! 491: case ROFFT_HEAD:
1.72 schwarze 492: return 0;
1.119 ! schwarze 493: case ROFFT_BODY:
1.105 schwarze 494: print_otag(h, TAG_DIV, "c", "Bd-indent");
1.119 ! schwarze 495: break;
! 496: default:
! 497: abort();
! 498: }
1.109 schwarze 499: return 1;
500: }
501:
502: static int
503: man_SY_pre(MAN_ARGS)
504: {
505: switch (n->type) {
506: case ROFFT_BLOCK:
1.119 ! schwarze 507: html_close_paragraph(h);
1.109 schwarze 508: print_otag(h, TAG_TABLE, "c", "Nm");
509: print_otag(h, TAG_TR, "");
510: break;
511: case ROFFT_HEAD:
512: print_otag(h, TAG_TD, "");
513: print_otag(h, TAG_CODE, "cT", "Nm");
514: break;
515: case ROFFT_BODY:
516: print_otag(h, TAG_TD, "");
517: break;
518: default:
519: abort();
520: }
1.72 schwarze 521: return 1;
1.49 schwarze 522: }
523:
524: static int
525: man_UR_pre(MAN_ARGS)
526: {
1.98 bentley 527: char *cp;
1.117 schwarze 528:
1.49 schwarze 529: n = n->child;
1.66 schwarze 530: assert(n->type == ROFFT_HEAD);
1.73 schwarze 531: if (n->child != NULL) {
1.66 schwarze 532: assert(n->child->type == ROFFT_TEXT);
1.98 bentley 533: if (n->tok == MAN_MT) {
534: mandoc_asprintf(&cp, "mailto:%s", n->child->string);
535: print_otag(h, TAG_A, "cTh", "Mt", cp);
536: free(cp);
537: } else
538: print_otag(h, TAG_A, "cTh", "Lk", n->child->string);
1.49 schwarze 539: }
540:
1.66 schwarze 541: assert(n->next->type == ROFFT_BODY);
1.73 schwarze 542: if (n->next->child != NULL)
1.49 schwarze 543: n = n->next;
544:
1.85 schwarze 545: print_man_nodelist(man, n->child, h);
1.72 schwarze 546: return 0;
1.111 schwarze 547: }
548:
549: static int
550: man_abort_pre(MAN_ARGS)
551: {
552: abort();
1.1 schwarze 553: }
![[BACK]](/icons/back.gif){kind=icon}
Return to man_html.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc