Annotation of src/usr.bin/mandoc/man_html.c, Revision 1.123
1.123 ! schwarze 1: /* $OpenBSD: man_html.c,v 1.122 2019/01/11 16:35:39 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.122 schwarze 120: if (n != NULL && n->type == ROFFT_COMMENT)
1.100 schwarze 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.120 schwarze 163: if (n->type == ROFFT_COMMENT || n->flags & NODE_NOPRT)
164: return;
165:
1.116 schwarze 166: html_fillmode(h, n->flags & NODE_NOFILL ? ROFF_nf : ROFF_fi);
1.85 schwarze 167:
168: child = 1;
169: switch (n->type) {
170: case ROFFT_TEXT:
1.116 schwarze 171: if (*n->string == '\0') {
172: print_endline(h);
173: return;
174: }
175: if (*n->string == ' ' && n->flags & NODE_LINE &&
176: (h->flags & HTML_NONEWLINE) == 0)
177: print_endline(h);
178: else if (n->flags & NODE_DELIMC)
179: h->flags |= HTML_NOSPACE;
1.123 ! schwarze 180: t = h->tag;
! 181: t->refcnt++;
1.1 schwarze 182: print_text(h, n->string);
1.83 schwarze 183: break;
1.66 schwarze 184: case ROFFT_EQN:
1.123 ! schwarze 185: t = h->tag;
! 186: t->refcnt++;
1.41 schwarze 187: print_eqn(h, n->eqn);
1.37 schwarze 188: break;
1.66 schwarze 189: case ROFFT_TBL:
1.33 schwarze 190: /*
191: * This will take care of initialising all of the table
192: * state data for the first table, then tearing it down
193: * for the last one.
194: */
1.29 schwarze 195: print_tbl(h, n->span);
1.32 schwarze 196: return;
1.1 schwarze 197: default:
1.52 schwarze 198: /*
1.4 schwarze 199: * Close out scope of font prior to opening a macro
1.33 schwarze 200: * scope.
1.4 schwarze 201: */
1.27 schwarze 202: if (HTMLFONT_NONE != h->metac) {
203: h->metal = h->metac;
204: h->metac = HTMLFONT_NONE;
1.33 schwarze 205: }
206:
207: /*
208: * Close out the current table, if it's open, and unset
209: * the "meta" table state. This will be reopened on the
210: * next table element.
211: */
1.123 ! schwarze 212: if (h->tblt != NULL)
1.33 schwarze 213: print_tblclose(h);
1.123 ! schwarze 214: t = h->tag;
! 215: t->refcnt++;
1.90 schwarze 216: if (n->tok < ROFF_MAX) {
1.91 schwarze 217: roff_html_pre(h, n);
1.123 ! schwarze 218: t->refcnt--;
1.120 schwarze 219: print_stagq(h, t);
1.116 schwarze 220: return;
1.90 schwarze 221: }
222: assert(n->tok >= MAN_TH && n->tok < MAN_MAX);
1.108 schwarze 223: if (man_html_acts[n->tok - MAN_TH].pre != NULL)
224: child = (*man_html_acts[n->tok - MAN_TH].pre)(man,
225: n, h);
1.1 schwarze 226: break;
227: }
228:
1.117 schwarze 229: if (child && n->child != NULL)
1.85 schwarze 230: print_man_nodelist(man, n->child, h);
1.1 schwarze 231:
1.4 schwarze 232: /* This will automatically close out any font scope. */
1.123 ! schwarze 233: t->refcnt--;
1.85 schwarze 234: print_stagq(h, t);
235:
1.118 schwarze 236: if (n->flags & NODE_NOFILL && n->tok != MAN_YS &&
237: (n->next != NULL && n->next->flags & NODE_LINE)) {
1.110 schwarze 238: /* In .nf = <pre>, print even empty lines. */
239: h->col++;
1.85 schwarze 240: print_endline(h);
1.110 schwarze 241: }
1.1 schwarze 242: }
243:
1.38 schwarze 244: static void
1.100 schwarze 245: man_root_pre(const struct roff_meta *man, struct html *h)
1.1 schwarze 246: {
247: struct tag *t, *tt;
1.53 schwarze 248: char *title;
1.1 schwarze 249:
1.48 schwarze 250: assert(man->title);
251: assert(man->msec);
1.53 schwarze 252: mandoc_asprintf(&title, "%s(%s)", man->title, man->msec);
1.1 schwarze 253:
1.75 schwarze 254: t = print_otag(h, TAG_TABLE, "c", "head");
255: tt = print_otag(h, TAG_TR, "");
1.1 schwarze 256:
1.75 schwarze 257: print_otag(h, TAG_TD, "c", "head-ltitle");
1.1 schwarze 258: print_text(h, title);
259: print_stagq(h, tt);
260:
1.75 schwarze 261: print_otag(h, TAG_TD, "c", "head-vol");
1.117 schwarze 262: if (man->vol != NULL)
1.54 schwarze 263: print_text(h, man->vol);
1.1 schwarze 264: print_stagq(h, tt);
265:
1.75 schwarze 266: print_otag(h, TAG_TD, "c", "head-rtitle");
1.1 schwarze 267: print_text(h, title);
268: print_tagq(h, t);
1.53 schwarze 269: free(title);
1.1 schwarze 270: }
271:
272: static void
1.100 schwarze 273: man_root_post(const struct roff_meta *man, struct html *h)
1.1 schwarze 274: {
275: struct tag *t, *tt;
276:
1.75 schwarze 277: t = print_otag(h, TAG_TABLE, "c", "foot");
278: tt = print_otag(h, TAG_TR, "");
1.25 schwarze 279:
1.75 schwarze 280: print_otag(h, TAG_TD, "c", "foot-date");
1.48 schwarze 281: print_text(h, man->date);
1.1 schwarze 282: print_stagq(h, tt);
283:
1.75 schwarze 284: print_otag(h, TAG_TD, "c", "foot-os");
1.117 schwarze 285: if (man->os != NULL)
1.68 schwarze 286: print_text(h, man->os);
1.1 schwarze 287: print_tagq(h, t);
288: }
289:
290: static int
291: man_SH_pre(MAN_ARGS)
292: {
1.87 schwarze 293: char *id;
294:
1.119 schwarze 295: switch (n->type) {
296: case ROFFT_BLOCK:
297: html_close_paragraph(h);
298: break;
299: case ROFFT_HEAD:
1.103 schwarze 300: id = html_make_id(n, 1);
1.119 schwarze 301: if (n->tok == MAN_SH)
1.121 schwarze 302: print_otag(h, TAG_H1, "ci", "Sh", id);
1.119 schwarze 303: else
1.121 schwarze 304: print_otag(h, TAG_H2, "ci", "Ss", id);
1.88 schwarze 305: if (id != NULL)
1.101 schwarze 306: print_otag(h, TAG_A, "chR", "permalink", id);
1.119 schwarze 307: break;
308: case ROFFT_BODY:
309: break;
310: default:
311: abort();
1.87 schwarze 312: }
1.72 schwarze 313: return 1;
1.1 schwarze 314: }
315:
316: static int
317: man_alt_pre(MAN_ARGS)
318: {
1.67 schwarze 319: const struct roff_node *nn;
1.117 schwarze 320: struct tag *t;
1.83 schwarze 321: int i;
1.27 schwarze 322: enum htmltag fp;
1.1 schwarze 323:
1.117 schwarze 324: for (i = 0, nn = n->child; nn != NULL; nn = nn->next, i++) {
1.1 schwarze 325: switch (n->tok) {
1.52 schwarze 326: case MAN_BI:
1.27 schwarze 327: fp = i % 2 ? TAG_I : TAG_B;
1.1 schwarze 328: break;
1.52 schwarze 329: case MAN_IB:
1.27 schwarze 330: fp = i % 2 ? TAG_B : TAG_I;
1.1 schwarze 331: break;
1.52 schwarze 332: case MAN_RI:
1.27 schwarze 333: fp = i % 2 ? TAG_I : TAG_MAX;
1.1 schwarze 334: break;
1.52 schwarze 335: case MAN_IR:
1.27 schwarze 336: fp = i % 2 ? TAG_MAX : TAG_I;
1.1 schwarze 337: break;
1.52 schwarze 338: case MAN_BR:
1.27 schwarze 339: fp = i % 2 ? TAG_MAX : TAG_B;
1.1 schwarze 340: break;
1.52 schwarze 341: case MAN_RB:
1.27 schwarze 342: fp = i % 2 ? TAG_B : TAG_MAX;
1.1 schwarze 343: break;
344: default:
345: abort();
346: }
347:
348: if (i)
349: h->flags |= HTML_NOSPACE;
350:
1.83 schwarze 351: if (fp != TAG_MAX)
1.75 schwarze 352: t = print_otag(h, fp, "");
1.27 schwarze 353:
1.83 schwarze 354: print_text(h, nn->string);
1.27 schwarze 355:
1.83 schwarze 356: if (fp != TAG_MAX)
1.27 schwarze 357: print_tagq(h, t);
1.1 schwarze 358: }
1.72 schwarze 359: return 0;
1.1 schwarze 360: }
361:
362: static int
1.26 schwarze 363: man_SM_pre(MAN_ARGS)
1.1 schwarze 364: {
1.75 schwarze 365: print_otag(h, TAG_SMALL, "");
1.117 schwarze 366: if (n->tok == MAN_SB)
1.75 schwarze 367: print_otag(h, TAG_B, "");
1.72 schwarze 368: return 1;
1.1 schwarze 369: }
370:
371: static int
372: man_PP_pre(MAN_ARGS)
373: {
1.119 schwarze 374: switch (n->type) {
375: case ROFFT_BLOCK:
376: html_close_paragraph(h);
377: break;
378: case ROFFT_HEAD:
1.72 schwarze 379: return 0;
1.119 schwarze 380: case ROFFT_BODY:
381: if (n->child != NULL &&
382: (n->child->flags & NODE_NOFILL) == 0)
383: print_otag(h, TAG_P, "c",
384: n->tok == MAN_PP ? "Pp" : "Pp HP");
385: break;
386: default:
387: abort();
388: }
1.72 schwarze 389: return 1;
1.1 schwarze 390: }
391:
392: static int
393: man_IP_pre(MAN_ARGS)
394: {
1.67 schwarze 395: const struct roff_node *nn;
1.1 schwarze 396:
1.119 schwarze 397: switch (n->type) {
398: case ROFFT_BLOCK:
399: html_close_paragraph(h);
400: print_otag(h, TAG_DL, "c", "Bl-tag");
401: return 1;
402: case ROFFT_HEAD:
403: print_otag(h, TAG_DT, "");
404: break;
405: case ROFFT_BODY:
1.102 schwarze 406: print_otag(h, TAG_DD, "");
1.72 schwarze 407: return 1;
1.119 schwarze 408: default:
409: abort();
1.1 schwarze 410: }
411:
1.107 schwarze 412: switch(n->tok) {
413: case MAN_IP: /* Only print the first header element. */
414: if (n->child != NULL)
415: print_man_node(man, n->child, h);
416: break;
417: case MAN_TP: /* Only print next-line header elements. */
418: case MAN_TQ:
1.50 schwarze 419: nn = n->child;
1.107 schwarze 420: while (nn != NULL && (NODE_LINE & nn->flags) == 0)
1.50 schwarze 421: nn = nn->next;
1.107 schwarze 422: while (nn != NULL) {
1.85 schwarze 423: print_man_node(man, nn, h);
1.50 schwarze 424: nn = nn->next;
425: }
1.107 schwarze 426: break;
427: default:
428: abort();
1.50 schwarze 429: }
1.72 schwarze 430: return 0;
1.1 schwarze 431: }
432:
433: static int
1.46 schwarze 434: man_OP_pre(MAN_ARGS)
435: {
436: struct tag *tt;
437:
438: print_text(h, "[");
439: h->flags |= HTML_NOSPACE;
1.81 schwarze 440: tt = print_otag(h, TAG_SPAN, "c", "Op");
1.46 schwarze 441:
1.117 schwarze 442: if ((n = n->child) != NULL) {
1.75 schwarze 443: print_otag(h, TAG_B, "");
1.46 schwarze 444: print_text(h, n->string);
445: }
446:
447: print_stagq(h, tt);
448:
1.117 schwarze 449: if (n != NULL && n->next != NULL) {
1.75 schwarze 450: print_otag(h, TAG_I, "");
1.46 schwarze 451: print_text(h, n->next->string);
452: }
453:
454: print_stagq(h, tt);
455: h->flags |= HTML_NOSPACE;
456: print_text(h, "]");
1.72 schwarze 457: return 0;
1.46 schwarze 458: }
459:
1.1 schwarze 460: static int
461: man_B_pre(MAN_ARGS)
462: {
1.75 schwarze 463: print_otag(h, TAG_B, "");
1.72 schwarze 464: return 1;
1.1 schwarze 465: }
466:
467: static int
468: man_I_pre(MAN_ARGS)
469: {
1.75 schwarze 470: print_otag(h, TAG_I, "");
1.72 schwarze 471: return 1;
1.18 schwarze 472: }
473:
474: static int
475: man_in_pre(MAN_ARGS)
476: {
1.75 schwarze 477: print_otag(h, TAG_BR, "");
1.72 schwarze 478: return 0;
1.1 schwarze 479: }
480:
481: static int
482: man_ign_pre(MAN_ARGS)
483: {
1.72 schwarze 484: return 0;
1.1 schwarze 485: }
486:
487: static int
488: man_RS_pre(MAN_ARGS)
489: {
1.119 schwarze 490: switch (n->type) {
491: case ROFFT_BLOCK:
492: html_close_paragraph(h);
493: break;
494: case ROFFT_HEAD:
1.72 schwarze 495: return 0;
1.119 schwarze 496: case ROFFT_BODY:
1.105 schwarze 497: print_otag(h, TAG_DIV, "c", "Bd-indent");
1.119 schwarze 498: break;
499: default:
500: abort();
501: }
1.109 schwarze 502: return 1;
503: }
504:
505: static int
506: man_SY_pre(MAN_ARGS)
507: {
508: switch (n->type) {
509: case ROFFT_BLOCK:
1.119 schwarze 510: html_close_paragraph(h);
1.109 schwarze 511: print_otag(h, TAG_TABLE, "c", "Nm");
512: print_otag(h, TAG_TR, "");
513: break;
514: case ROFFT_HEAD:
515: print_otag(h, TAG_TD, "");
1.121 schwarze 516: print_otag(h, TAG_CODE, "c", "Nm");
1.109 schwarze 517: break;
518: case ROFFT_BODY:
519: print_otag(h, TAG_TD, "");
520: break;
521: default:
522: abort();
523: }
1.72 schwarze 524: return 1;
1.49 schwarze 525: }
526:
527: static int
528: man_UR_pre(MAN_ARGS)
529: {
1.98 bentley 530: char *cp;
1.117 schwarze 531:
1.49 schwarze 532: n = n->child;
1.66 schwarze 533: assert(n->type == ROFFT_HEAD);
1.73 schwarze 534: if (n->child != NULL) {
1.66 schwarze 535: assert(n->child->type == ROFFT_TEXT);
1.98 bentley 536: if (n->tok == MAN_MT) {
537: mandoc_asprintf(&cp, "mailto:%s", n->child->string);
1.121 schwarze 538: print_otag(h, TAG_A, "ch", "Mt", cp);
1.98 bentley 539: free(cp);
540: } else
1.121 schwarze 541: print_otag(h, TAG_A, "ch", "Lk", n->child->string);
1.49 schwarze 542: }
543:
1.66 schwarze 544: assert(n->next->type == ROFFT_BODY);
1.73 schwarze 545: if (n->next->child != NULL)
1.49 schwarze 546: n = n->next;
547:
1.85 schwarze 548: print_man_nodelist(man, n->child, h);
1.72 schwarze 549: return 0;
1.111 schwarze 550: }
551:
552: static int
553: man_abort_pre(MAN_ARGS)
554: {
555: abort();
1.1 schwarze 556: }
![[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