Annotation of src/usr.bin/mandoc/mdoc_man.c, Revision 1.26
1.26 ! schwarze 1: /* $Id: mdoc_man.c,v 1.25 2012/07/09 18:55:40 schwarze Exp $ */
1.1 schwarze 2: /*
1.8 schwarze 3: * Copyright (c) 2011, 2012 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
8: *
9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: */
1.9 schwarze 17: #include <assert.h>
1.1 schwarze 18: #include <stdio.h>
19: #include <string.h>
20:
21: #include "mandoc.h"
1.8 schwarze 22: #include "out.h"
1.4 schwarze 23: #include "man.h"
1.1 schwarze 24: #include "mdoc.h"
25: #include "main.h"
26:
1.4 schwarze 27: #define DECL_ARGS const struct mdoc_meta *m, \
1.18 schwarze 28: const struct mdoc_node *n
1.1 schwarze 29:
30: struct manact {
1.4 schwarze 31: int (*cond)(DECL_ARGS); /* DON'T run actions */
32: int (*pre)(DECL_ARGS); /* pre-node action */
33: void (*post)(DECL_ARGS); /* post-node action */
34: const char *prefix; /* pre-node string constant */
35: const char *suffix; /* post-node string constant */
1.1 schwarze 36: };
37:
1.4 schwarze 38: static int cond_body(DECL_ARGS);
1.1 schwarze 39: static int cond_head(DECL_ARGS);
1.24 schwarze 40: static void font_push(char);
41: static void font_pop(void);
1.4 schwarze 42: static void post_bd(DECL_ARGS);
1.25 schwarze 43: static void post_bf(DECL_ARGS);
1.10 schwarze 44: static void post_bk(DECL_ARGS);
1.4 schwarze 45: static void post_dl(DECL_ARGS);
1.1 schwarze 46: static void post_enc(DECL_ARGS);
1.26 ! schwarze 47: static void post_eo(DECL_ARGS);
1.14 schwarze 48: static void post_fa(DECL_ARGS);
1.24 schwarze 49: static void post_fl(DECL_ARGS);
1.13 schwarze 50: static void post_fn(DECL_ARGS);
1.14 schwarze 51: static void post_fo(DECL_ARGS);
1.24 schwarze 52: static void post_font(DECL_ARGS);
1.12 schwarze 53: static void post_in(DECL_ARGS);
1.11 schwarze 54: static void post_lb(DECL_ARGS);
1.4 schwarze 55: static void post_nm(DECL_ARGS);
1.1 schwarze 56: static void post_percent(DECL_ARGS);
1.4 schwarze 57: static void post_pf(DECL_ARGS);
1.3 schwarze 58: static void post_sect(DECL_ARGS);
1.4 schwarze 59: static void post_sp(DECL_ARGS);
1.15 schwarze 60: static void post_vt(DECL_ARGS);
1.20 schwarze 61: static int pre_an(DECL_ARGS);
1.3 schwarze 62: static int pre_ap(DECL_ARGS);
63: static int pre_bd(DECL_ARGS);
1.25 schwarze 64: static int pre_bf(DECL_ARGS);
1.10 schwarze 65: static int pre_bk(DECL_ARGS);
1.3 schwarze 66: static int pre_br(DECL_ARGS);
1.5 schwarze 67: static int pre_bx(DECL_ARGS);
1.1 schwarze 68: static int pre_dl(DECL_ARGS);
1.4 schwarze 69: static int pre_enc(DECL_ARGS);
1.24 schwarze 70: static int pre_em(DECL_ARGS);
1.14 schwarze 71: static int pre_fa(DECL_ARGS);
1.24 schwarze 72: static int pre_fl(DECL_ARGS);
1.13 schwarze 73: static int pre_fn(DECL_ARGS);
1.14 schwarze 74: static int pre_fo(DECL_ARGS);
1.21 schwarze 75: static int pre_ft(DECL_ARGS);
1.12 schwarze 76: static int pre_in(DECL_ARGS);
1.1 schwarze 77: static int pre_it(DECL_ARGS);
1.22 schwarze 78: static int pre_lk(DECL_ARGS);
1.24 schwarze 79: static int pre_li(DECL_ARGS);
1.1 schwarze 80: static int pre_nm(DECL_ARGS);
1.23 schwarze 81: static int pre_no(DECL_ARGS);
1.1 schwarze 82: static int pre_ns(DECL_ARGS);
83: static int pre_pp(DECL_ARGS);
1.9 schwarze 84: static int pre_sm(DECL_ARGS);
1.3 schwarze 85: static int pre_sp(DECL_ARGS);
1.4 schwarze 86: static int pre_sect(DECL_ARGS);
1.24 schwarze 87: static int pre_sy(DECL_ARGS);
1.21 schwarze 88: static void pre_syn(const struct mdoc_node *);
1.15 schwarze 89: static int pre_vt(DECL_ARGS);
1.5 schwarze 90: static int pre_ux(DECL_ARGS);
1.1 schwarze 91: static int pre_xr(DECL_ARGS);
1.18 schwarze 92: static void print_word(const char *);
93: static void print_offs(const char *);
1.4 schwarze 94: static void print_node(DECL_ARGS);
1.1 schwarze 95:
1.3 schwarze 96: static const struct manact manacts[MDOC_MAX + 1] = {
97: { NULL, pre_ap, NULL, NULL, NULL }, /* Ap */
98: { NULL, NULL, NULL, NULL, NULL }, /* Dd */
99: { NULL, NULL, NULL, NULL, NULL }, /* Dt */
1.5 schwarze 100: { NULL, NULL, NULL, NULL, NULL }, /* Os */
1.3 schwarze 101: { NULL, pre_sect, post_sect, ".SH", NULL }, /* Sh */
102: { NULL, pre_sect, post_sect, ".SS", NULL }, /* Ss */
1.1 schwarze 103: { NULL, pre_pp, NULL, NULL, NULL }, /* Pp */
1.3 schwarze 104: { cond_body, pre_dl, post_dl, NULL, NULL }, /* D1 */
1.1 schwarze 105: { cond_body, pre_dl, post_dl, NULL, NULL }, /* Dl */
1.3 schwarze 106: { cond_body, pre_bd, post_bd, NULL, NULL }, /* Bd */
107: { NULL, NULL, NULL, NULL, NULL }, /* Ed */
108: { NULL, NULL, NULL, NULL, NULL }, /* Bl */
109: { NULL, NULL, NULL, NULL, NULL }, /* El */
1.1 schwarze 110: { NULL, pre_it, NULL, NULL, NULL }, /* _It */
1.24 schwarze 111: { NULL, pre_em, post_font, NULL, NULL }, /* Ad */
1.20 schwarze 112: { NULL, pre_an, NULL, NULL, NULL }, /* An */
1.24 schwarze 113: { NULL, pre_em, post_font, NULL, NULL }, /* Ar */
114: { NULL, pre_sy, post_font, NULL, NULL }, /* Cd */
115: { NULL, pre_sy, post_font, NULL, NULL }, /* Cm */
116: { NULL, pre_li, post_font, NULL, NULL }, /* Dv */
117: { NULL, pre_li, post_font, NULL, NULL }, /* Er */
118: { NULL, pre_li, post_font, NULL, NULL }, /* Ev */
1.1 schwarze 119: { NULL, pre_enc, post_enc, "The \\fB",
120: "\\fP\nutility exits 0 on success, and >0 if an error occurs."
121: }, /* Ex */
1.14 schwarze 122: { NULL, pre_fa, post_fa, NULL, NULL }, /* Fa */
1.1 schwarze 123: { NULL, NULL, NULL, NULL, NULL }, /* _Fd */
1.24 schwarze 124: { NULL, pre_fl, post_fl, NULL, NULL }, /* Fl */
1.13 schwarze 125: { NULL, pre_fn, post_fn, NULL, NULL }, /* Fn */
1.24 schwarze 126: { NULL, pre_ft, post_font, NULL, NULL }, /* Ft */
127: { NULL, pre_sy, post_font, NULL, NULL }, /* Ic */
1.12 schwarze 128: { NULL, pre_in, post_in, NULL, NULL }, /* In */
1.24 schwarze 129: { NULL, pre_li, post_font, NULL, NULL }, /* Li */
1.1 schwarze 130: { cond_head, pre_enc, NULL, "\\- ", NULL }, /* Nd */
131: { NULL, pre_nm, post_nm, NULL, NULL }, /* Nm */
132: { cond_body, pre_enc, post_enc, "[", "]" }, /* Op */
1.5 schwarze 133: { NULL, NULL, NULL, NULL, NULL }, /* Ot */
1.24 schwarze 134: { NULL, pre_em, post_font, NULL, NULL }, /* Pa */
1.4 schwarze 135: { NULL, pre_enc, post_enc, "The \\fB",
136: "\\fP\nfunction returns the value 0 if successful;\n"
137: "otherwise the value -1 is returned and the global\n"
138: "variable \\fIerrno\\fP is set to indicate the error."
139: }, /* Rv */
1.5 schwarze 140: { NULL, NULL, NULL, NULL, NULL }, /* St */
1.24 schwarze 141: { NULL, pre_em, post_font, NULL, NULL }, /* Va */
1.15 schwarze 142: { NULL, pre_vt, post_vt, NULL, NULL }, /* Vt */
1.5 schwarze 143: { NULL, pre_xr, NULL, NULL, NULL }, /* Xr */
1.1 schwarze 144: { NULL, NULL, post_percent, NULL, NULL }, /* _%A */
145: { NULL, NULL, NULL, NULL, NULL }, /* _%B */
146: { NULL, NULL, post_percent, NULL, NULL }, /* _%D */
147: { NULL, NULL, NULL, NULL, NULL }, /* _%I */
148: { NULL, pre_enc, post_percent, "\\fI", "\\fP" }, /* %J */
149: { NULL, NULL, NULL, NULL, NULL }, /* _%N */
150: { NULL, NULL, NULL, NULL, NULL }, /* _%O */
151: { NULL, NULL, NULL, NULL, NULL }, /* _%P */
152: { NULL, NULL, NULL, NULL, NULL }, /* _%R */
153: { NULL, pre_enc, post_percent, "\"", "\"" }, /* %T */
154: { NULL, NULL, NULL, NULL, NULL }, /* _%V */
1.6 schwarze 155: { NULL, NULL, NULL, NULL, NULL }, /* Ac */
156: { cond_body, pre_enc, post_enc, "<", ">" }, /* Ao */
1.1 schwarze 157: { cond_body, pre_enc, post_enc, "<", ">" }, /* Aq */
1.5 schwarze 158: { NULL, NULL, NULL, NULL, NULL }, /* At */
1.3 schwarze 159: { NULL, NULL, NULL, NULL, NULL }, /* Bc */
1.25 schwarze 160: { NULL, pre_bf, post_bf, NULL, NULL }, /* Bf */
1.3 schwarze 161: { cond_body, pre_enc, post_enc, "[", "]" }, /* Bo */
162: { cond_body, pre_enc, post_enc, "[", "]" }, /* Bq */
1.5 schwarze 163: { NULL, pre_ux, NULL, "BSD/OS", NULL }, /* Bsx */
164: { NULL, pre_bx, NULL, NULL, NULL }, /* Bx */
165: { NULL, NULL, NULL, NULL, NULL }, /* Db */
1.6 schwarze 166: { NULL, NULL, NULL, NULL, NULL }, /* Dc */
167: { cond_body, pre_enc, post_enc, "``", "''" }, /* Do */
1.1 schwarze 168: { cond_body, pre_enc, post_enc, "``", "''" }, /* Dq */
1.26 ! schwarze 169: { NULL, NULL, NULL, NULL, NULL }, /* Ec */
! 170: { NULL, NULL, NULL, NULL, NULL }, /* Ef */
1.24 schwarze 171: { NULL, pre_em, post_font, NULL, NULL }, /* Em */
1.26 ! schwarze 172: { NULL, NULL, post_eo, NULL, NULL }, /* Eo */
1.5 schwarze 173: { NULL, pre_ux, NULL, "FreeBSD", NULL }, /* Fx */
1.24 schwarze 174: { NULL, pre_sy, post_font, NULL, NULL }, /* Ms */
1.23 schwarze 175: { NULL, pre_no, NULL, NULL, NULL }, /* No */
1.1 schwarze 176: { NULL, pre_ns, NULL, NULL, NULL }, /* Ns */
1.5 schwarze 177: { NULL, pre_ux, NULL, "NetBSD", NULL }, /* Nx */
178: { NULL, pre_ux, NULL, "OpenBSD", NULL }, /* Ox */
1.3 schwarze 179: { NULL, NULL, NULL, NULL, NULL }, /* Pc */
180: { NULL, NULL, post_pf, NULL, NULL }, /* Pf */
181: { cond_body, pre_enc, post_enc, "(", ")" }, /* Po */
182: { cond_body, pre_enc, post_enc, "(", ")" }, /* Pq */
1.6 schwarze 183: { NULL, NULL, NULL, NULL, NULL }, /* Qc */
1.1 schwarze 184: { cond_body, pre_enc, post_enc, "`", "'" }, /* Ql */
1.6 schwarze 185: { cond_body, pre_enc, post_enc, "\"", "\"" }, /* Qo */
186: { cond_body, pre_enc, post_enc, "\"", "\"" }, /* Qq */
187: { NULL, NULL, NULL, NULL, NULL }, /* Re */
1.1 schwarze 188: { cond_body, pre_pp, NULL, NULL, NULL }, /* Rs */
1.6 schwarze 189: { NULL, NULL, NULL, NULL, NULL }, /* Sc */
190: { cond_body, pre_enc, post_enc, "`", "'" }, /* So */
1.1 schwarze 191: { cond_body, pre_enc, post_enc, "`", "'" }, /* Sq */
1.9 schwarze 192: { NULL, pre_sm, NULL, NULL, NULL }, /* Sm */
1.24 schwarze 193: { NULL, pre_em, post_font, NULL, NULL }, /* Sx */
194: { NULL, pre_sy, post_font, NULL, NULL }, /* Sy */
195: { NULL, pre_li, post_font, NULL, NULL }, /* Tn */
1.5 schwarze 196: { NULL, pre_ux, NULL, "UNIX", NULL }, /* Ux */
1.1 schwarze 197: { NULL, NULL, NULL, NULL, NULL }, /* _Xc */
198: { NULL, NULL, NULL, NULL, NULL }, /* _Xo */
1.14 schwarze 199: { NULL, pre_fo, post_fo, NULL, NULL }, /* Fo */
200: { NULL, NULL, NULL, NULL, NULL }, /* Fc */
1.3 schwarze 201: { cond_body, pre_enc, post_enc, "[", "]" }, /* Oo */
1.6 schwarze 202: { NULL, NULL, NULL, NULL, NULL }, /* Oc */
1.10 schwarze 203: { NULL, pre_bk, post_bk, NULL, NULL }, /* Bk */
204: { NULL, NULL, NULL, NULL, NULL }, /* Ek */
1.5 schwarze 205: { NULL, pre_ux, NULL, "is currently in beta test.", NULL }, /* Bt */
206: { NULL, NULL, NULL, NULL, NULL }, /* Hf */
207: { NULL, NULL, NULL, NULL, NULL }, /* Fr */
208: { NULL, pre_ux, NULL, "currently under development.", NULL }, /* Ud */
1.11 schwarze 209: { NULL, NULL, post_lb, NULL, NULL }, /* Lb */
1.3 schwarze 210: { NULL, pre_pp, NULL, NULL, NULL }, /* Lp */
1.22 schwarze 211: { NULL, pre_lk, NULL, NULL, NULL }, /* Lk */
1.24 schwarze 212: { NULL, pre_em, post_font, NULL, NULL }, /* Mt */
1.6 schwarze 213: { cond_body, pre_enc, post_enc, "{", "}" }, /* Brq */
214: { cond_body, pre_enc, post_enc, "{", "}" }, /* Bro */
215: { NULL, NULL, NULL, NULL, NULL }, /* Brc */
1.1 schwarze 216: { NULL, NULL, NULL, NULL, NULL }, /* _%C */
217: { NULL, NULL, NULL, NULL, NULL }, /* _Es */
218: { NULL, NULL, NULL, NULL, NULL }, /* _En */
1.5 schwarze 219: { NULL, pre_ux, NULL, "DragonFly", NULL }, /* Dx */
1.1 schwarze 220: { NULL, NULL, NULL, NULL, NULL }, /* _%Q */
1.3 schwarze 221: { NULL, pre_br, NULL, NULL, NULL }, /* br */
222: { NULL, pre_sp, post_sp, NULL, NULL }, /* sp */
1.1 schwarze 223: { NULL, NULL, NULL, NULL, NULL }, /* _%U */
224: { NULL, NULL, NULL, NULL, NULL }, /* _Ta */
1.3 schwarze 225: { NULL, NULL, NULL, NULL, NULL }, /* ROOT */
1.1 schwarze 226: };
227:
1.18 schwarze 228: static int outflags;
229: #define MMAN_spc (1 << 0)
1.23 schwarze 230: #define MMAN_spc_force (1 << 1)
231: #define MMAN_nl (1 << 2)
232: #define MMAN_br (1 << 3)
233: #define MMAN_sp (1 << 4)
234: #define MMAN_Sm (1 << 5)
235: #define MMAN_Bk (1 << 6)
236: #define MMAN_An_split (1 << 7)
237: #define MMAN_An_nosplit (1 << 8)
1.18 schwarze 238:
1.24 schwarze 239: static struct {
240: char *head;
241: char *tail;
242: size_t size;
243: } fontqueue;
244:
245: static void
246: font_push(char newfont)
247: {
248:
249: if (fontqueue.head + fontqueue.size <= ++fontqueue.tail) {
250: fontqueue.size += 8;
251: fontqueue.head = mandoc_realloc(fontqueue.head,
252: fontqueue.size);
253: }
254: *fontqueue.tail = newfont;
255: print_word("\\f");
256: putchar(newfont);
257: outflags &= ~MMAN_spc;
258: }
259:
260: static void
261: font_pop(void)
262: {
263:
264: if (fontqueue.tail > fontqueue.head)
265: fontqueue.tail--;
266: outflags &= ~MMAN_spc;
267: print_word("\\f");
268: putchar(*fontqueue.tail);
269: }
270:
1.1 schwarze 271: static void
1.18 schwarze 272: print_word(const char *s)
1.1 schwarze 273: {
1.4 schwarze 274:
1.19 schwarze 275: if ((MMAN_sp | MMAN_br | MMAN_nl) & outflags) {
1.4 schwarze 276: /*
277: * If we need a newline, print it now and start afresh.
278: */
1.19 schwarze 279: if (MMAN_sp & outflags)
280: printf("\n.sp\n");
281: else if (MMAN_br & outflags)
282: printf("\n.br\n");
283: else if (MMAN_nl & outflags)
284: putchar('\n');
285: outflags &= ~(MMAN_sp|MMAN_br|MMAN_nl|MMAN_spc);
1.18 schwarze 286: } else if (MMAN_spc & outflags && '\0' != s[0])
1.4 schwarze 287: /*
1.23 schwarze 288: * If we need a space, only print it if
289: * (1) it is forced by `No' or
290: * (2) what follows is not terminating punctuation or
291: * (3) what follows is longer than one character.
1.4 schwarze 292: */
1.23 schwarze 293: if (MMAN_spc_force & outflags ||
294: NULL == strchr(".,:;)]?!", s[0]) || '\0' != s[1]) {
1.18 schwarze 295: if (MMAN_Bk & outflags) {
1.10 schwarze 296: putchar('\\');
297: putchar('~');
298: } else
299: putchar(' ');
300: }
1.4 schwarze 301:
302: /*
303: * Reassign needing space if we're not following opening
304: * punctuation.
305: */
1.18 schwarze 306: if (MMAN_Sm & outflags &&
307: (('(' != s[0] && '[' != s[0]) || '\0' != s[1]))
308: outflags |= MMAN_spc;
309: else
310: outflags &= ~MMAN_spc;
1.23 schwarze 311: outflags &= ~MMAN_spc_force;
1.4 schwarze 312:
1.1 schwarze 313: for ( ; *s; s++) {
314: switch (*s) {
315: case (ASCII_NBRSP):
316: printf("\\~");
317: break;
318: case (ASCII_HYPH):
319: putchar('-');
320: break;
321: default:
1.4 schwarze 322: putchar((unsigned char)*s);
1.1 schwarze 323: break;
324: }
325: }
326: }
327:
1.8 schwarze 328: static void
1.18 schwarze 329: print_offs(const char *v)
1.8 schwarze 330: {
331: char buf[24];
332: struct roffsu su;
333: size_t sz;
334:
335: if (NULL == v || '\0' == *v || 0 == strcmp(v, "left"))
336: sz = 0;
337: else if (0 == strcmp(v, "indent"))
338: sz = 6;
339: else if (0 == strcmp(v, "indent-two"))
340: sz = 12;
341: else if (a2roffsu(v, &su, SCALE_MAX)) {
1.18 schwarze 342: print_word(v);
1.8 schwarze 343: return;
344: } else
345: sz = strlen(v);
346:
347: snprintf(buf, sizeof(buf), "%ldn", sz);
1.18 schwarze 348: print_word(buf);
1.8 schwarze 349: }
350:
1.1 schwarze 351: void
1.4 schwarze 352: man_man(void *arg, const struct man *man)
353: {
354:
355: /*
356: * Dump the keep buffer.
357: * We're guaranteed by now that this exists (is non-NULL).
358: * Flush stdout afterward, just in case.
359: */
360: fputs(mparse_getkeep(man_mparse(man)), stdout);
361: fflush(stdout);
362: }
363:
364: void
1.1 schwarze 365: man_mdoc(void *arg, const struct mdoc *mdoc)
366: {
367: const struct mdoc_meta *m;
368: const struct mdoc_node *n;
369:
370: m = mdoc_meta(mdoc);
371: n = mdoc_node(mdoc);
372:
1.3 schwarze 373: printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"",
1.4 schwarze 374: m->title, m->msec, m->date, m->os, m->vol);
1.1 schwarze 375:
1.18 schwarze 376: outflags = MMAN_nl | MMAN_Sm;
1.24 schwarze 377: if (0 == fontqueue.size) {
378: fontqueue.size = 8;
379: fontqueue.head = fontqueue.tail = mandoc_malloc(8);
380: *fontqueue.tail = 'R';
381: }
1.18 schwarze 382: print_node(m, n);
1.3 schwarze 383: putchar('\n');
1.1 schwarze 384: }
385:
386: static void
387: print_node(DECL_ARGS)
388: {
389: const struct mdoc_node *prev, *sub;
1.4 schwarze 390: const struct manact *act;
1.1 schwarze 391: int cond, do_sub;
1.4 schwarze 392:
393: /*
394: * Break the line if we were parsed subsequent the current node.
395: * This makes the page structure be more consistent.
396: */
1.1 schwarze 397: prev = n->prev ? n->prev : n->parent;
1.25 schwarze 398: if (MMAN_spc & outflags && prev && prev->line < n->line)
1.18 schwarze 399: outflags |= MMAN_nl;
1.1 schwarze 400:
1.4 schwarze 401: act = NULL;
1.1 schwarze 402: cond = 0;
403: do_sub = 1;
1.4 schwarze 404:
1.1 schwarze 405: if (MDOC_TEXT == n->type) {
1.4 schwarze 406: /*
407: * Make sure that we don't happen to start with a
408: * control character at the start of a line.
409: */
1.18 schwarze 410: if (MMAN_nl & outflags && ('.' == *n->string ||
1.4 schwarze 411: '\'' == *n->string)) {
1.18 schwarze 412: print_word("\\&");
413: outflags &= ~MMAN_spc;
1.3 schwarze 414: }
1.18 schwarze 415: print_word(n->string);
1.1 schwarze 416: } else {
1.4 schwarze 417: /*
418: * Conditionally run the pre-node action handler for a
419: * node.
420: */
1.1 schwarze 421: act = manacts + n->tok;
1.18 schwarze 422: cond = NULL == act->cond || (*act->cond)(m, n);
1.1 schwarze 423: if (cond && act->pre)
1.18 schwarze 424: do_sub = (*act->pre)(m, n);
1.1 schwarze 425: }
426:
1.4 schwarze 427: /*
428: * Conditionally run all child nodes.
429: * Note that this iterates over children instead of using
430: * recursion. This prevents unnecessary depth in the stack.
431: */
1.1 schwarze 432: if (do_sub)
433: for (sub = n->child; sub; sub = sub->next)
1.18 schwarze 434: print_node(m, sub);
1.1 schwarze 435:
1.4 schwarze 436: /*
437: * Lastly, conditionally run the post-node handler.
438: */
1.1 schwarze 439: if (cond && act->post)
1.18 schwarze 440: (*act->post)(m, n);
1.1 schwarze 441: }
442:
443: static int
444: cond_head(DECL_ARGS)
445: {
1.4 schwarze 446:
1.1 schwarze 447: return(MDOC_HEAD == n->type);
448: }
449:
450: static int
451: cond_body(DECL_ARGS)
452: {
1.4 schwarze 453:
1.1 schwarze 454: return(MDOC_BODY == n->type);
455: }
456:
457: static int
458: pre_enc(DECL_ARGS)
459: {
1.4 schwarze 460: const char *prefix;
1.1 schwarze 461:
462: prefix = manacts[n->tok].prefix;
463: if (NULL == prefix)
464: return(1);
1.18 schwarze 465: print_word(prefix);
466: outflags &= ~MMAN_spc;
1.1 schwarze 467: return(1);
468: }
469:
470: static void
471: post_enc(DECL_ARGS)
472: {
473: const char *suffix;
474:
475: suffix = manacts[n->tok].suffix;
476: if (NULL == suffix)
477: return;
1.18 schwarze 478: outflags &= ~MMAN_spc;
479: print_word(suffix);
1.24 schwarze 480: }
481:
482: static void
483: post_font(DECL_ARGS)
484: {
485:
486: font_pop();
1.1 schwarze 487: }
488:
1.4 schwarze 489: /*
490: * Used in listings (percent = %A, e.g.).
491: * FIXME: this is incomplete.
492: * It doesn't print a nice ", and" for lists.
493: */
1.1 schwarze 494: static void
495: post_percent(DECL_ARGS)
496: {
497:
1.18 schwarze 498: post_enc(m, n);
1.1 schwarze 499: if (n->next)
1.18 schwarze 500: print_word(",");
1.1 schwarze 501: else {
1.18 schwarze 502: print_word(".");
503: outflags |= MMAN_nl;
1.1 schwarze 504: }
505: }
506:
1.4 schwarze 507: /*
508: * Print before a section header.
509: */
1.1 schwarze 510: static int
1.3 schwarze 511: pre_sect(DECL_ARGS)
512: {
513:
514: if (MDOC_HEAD != n->type)
515: return(1);
1.18 schwarze 516: outflags |= MMAN_nl;
517: print_word(manacts[n->tok].prefix);
518: print_word("\"");
519: outflags &= ~MMAN_spc;
1.3 schwarze 520: return(1);
521: }
522:
1.4 schwarze 523: /*
524: * Print subsequent a section header.
525: */
1.3 schwarze 526: static void
527: post_sect(DECL_ARGS)
528: {
529:
530: if (MDOC_HEAD != n->type)
531: return;
1.18 schwarze 532: outflags &= ~MMAN_spc;
533: print_word("\"");
534: outflags |= MMAN_nl;
1.20 schwarze 535: if (MDOC_Sh == n->tok && SEC_AUTHORS == n->sec)
536: outflags &= ~(MMAN_An_split | MMAN_An_nosplit);
537: }
538:
1.21 schwarze 539: /* See mdoc_term.c, synopsis_pre() for comments. */
540: static void
541: pre_syn(const struct mdoc_node *n)
542: {
543:
544: if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags))
545: return;
546:
547: if (n->prev->tok == n->tok &&
548: MDOC_Ft != n->tok &&
549: MDOC_Fo != n->tok &&
550: MDOC_Fn != n->tok) {
551: outflags |= MMAN_br;
552: return;
553: }
554:
555: switch (n->prev->tok) {
556: case (MDOC_Fd):
557: /* FALLTHROUGH */
558: case (MDOC_Fn):
559: /* FALLTHROUGH */
560: case (MDOC_Fo):
561: /* FALLTHROUGH */
562: case (MDOC_In):
563: /* FALLTHROUGH */
564: case (MDOC_Vt):
565: outflags |= MMAN_sp;
566: break;
567: case (MDOC_Ft):
568: if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
569: outflags |= MMAN_sp;
570: break;
571: }
572: /* FALLTHROUGH */
573: default:
574: outflags |= MMAN_br;
575: break;
576: }
577: }
578:
1.20 schwarze 579: static int
580: pre_an(DECL_ARGS)
581: {
582:
583: switch (n->norm->An.auth) {
584: case (AUTH_split):
585: outflags &= ~MMAN_An_nosplit;
586: outflags |= MMAN_An_split;
587: return(0);
588: case (AUTH_nosplit):
589: outflags &= ~MMAN_An_split;
590: outflags |= MMAN_An_nosplit;
591: return(0);
592: default:
593: if (MMAN_An_split & outflags)
594: outflags |= MMAN_br;
595: else if (SEC_AUTHORS == n->sec &&
596: ! (MMAN_An_nosplit & outflags))
597: outflags |= MMAN_An_split;
598: return(1);
599: }
1.3 schwarze 600: }
601:
602: static int
603: pre_ap(DECL_ARGS)
604: {
605:
1.18 schwarze 606: outflags &= ~MMAN_spc;
607: print_word("'");
608: outflags &= ~MMAN_spc;
1.3 schwarze 609: return(0);
610: }
611:
612: static int
613: pre_bd(DECL_ARGS)
614: {
615:
1.19 schwarze 616: if (0 == n->norm->Bd.comp)
617: outflags |= MMAN_sp;
1.3 schwarze 618: if (DISP_unfilled == n->norm->Bd.type ||
619: DISP_literal == n->norm->Bd.type) {
1.18 schwarze 620: outflags |= MMAN_nl;
621: print_word(".nf");
1.3 schwarze 622: }
1.18 schwarze 623: outflags |= MMAN_nl;
624: print_word(".RS");
625: print_offs(n->norm->Bd.offs);
626: outflags |= MMAN_nl;
1.3 schwarze 627: return(1);
628: }
629:
630: static void
631: post_bd(DECL_ARGS)
632: {
633:
1.18 schwarze 634: outflags |= MMAN_nl;
635: print_word(".RE");
1.3 schwarze 636: if (DISP_unfilled == n->norm->Bd.type ||
637: DISP_literal == n->norm->Bd.type) {
1.18 schwarze 638: outflags |= MMAN_nl;
639: print_word(".fi");
1.3 schwarze 640: }
1.18 schwarze 641: outflags |= MMAN_nl;
1.10 schwarze 642: }
643:
644: static int
1.25 schwarze 645: pre_bf(DECL_ARGS)
646: {
647:
648: switch (n->type) {
649: case (MDOC_BLOCK):
650: return(1);
651: case (MDOC_BODY):
652: break;
653: default:
654: return(0);
655: }
656: switch (n->norm->Bf.font) {
657: case (FONT_Em):
658: font_push('I');
659: break;
660: case (FONT_Sy):
661: font_push('B');
662: break;
663: default:
664: font_push('R');
665: break;
666: }
667: return(1);
668: }
669:
670: static void
671: post_bf(DECL_ARGS)
672: {
673:
674: if (MDOC_BODY == n->type)
675: font_pop();
676: }
677:
678: static int
1.10 schwarze 679: pre_bk(DECL_ARGS)
680: {
681:
682: switch (n->type) {
683: case (MDOC_BLOCK):
684: return(1);
685: case (MDOC_BODY):
1.18 schwarze 686: outflags |= MMAN_Bk;
1.10 schwarze 687: return(1);
688: default:
689: return(0);
690: }
691: }
692:
693: static void
694: post_bk(DECL_ARGS)
695: {
696:
697: if (MDOC_BODY == n->type)
1.18 schwarze 698: outflags &= ~MMAN_Bk;
1.3 schwarze 699: }
700:
701: static int
702: pre_br(DECL_ARGS)
703: {
704:
1.19 schwarze 705: outflags |= MMAN_br;
1.3 schwarze 706: return(0);
707: }
708:
709: static int
1.5 schwarze 710: pre_bx(DECL_ARGS)
711: {
712:
713: n = n->child;
714: if (n) {
1.18 schwarze 715: print_word(n->string);
716: outflags &= ~MMAN_spc;
1.5 schwarze 717: n = n->next;
718: }
1.18 schwarze 719: print_word("BSD");
1.5 schwarze 720: if (NULL == n)
721: return(0);
1.18 schwarze 722: outflags &= ~MMAN_spc;
723: print_word("-");
724: outflags &= ~MMAN_spc;
725: print_word(n->string);
1.5 schwarze 726: return(0);
727: }
728:
729: static int
1.1 schwarze 730: pre_dl(DECL_ARGS)
731: {
732:
1.18 schwarze 733: outflags |= MMAN_nl;
734: print_word(".RS 6n");
735: outflags |= MMAN_nl;
1.1 schwarze 736: return(1);
737: }
738:
739: static void
740: post_dl(DECL_ARGS)
741: {
742:
1.18 schwarze 743: outflags |= MMAN_nl;
744: print_word(".RE");
745: outflags |= MMAN_nl;
1.13 schwarze 746: }
747:
748: static int
1.24 schwarze 749: pre_em(DECL_ARGS)
750: {
751:
752: font_push('I');
753: return(1);
1.26 ! schwarze 754: }
! 755:
! 756: static void
! 757: post_eo(DECL_ARGS)
! 758: {
! 759:
! 760: if (MDOC_HEAD == n->type || MDOC_BODY == n->type)
! 761: outflags &= ~MMAN_spc;
1.24 schwarze 762: }
763:
764: static int
1.14 schwarze 765: pre_fa(DECL_ARGS)
766: {
767:
768: if (MDOC_Fa == n->tok)
769: n = n->child;
770:
771: while (NULL != n) {
1.24 schwarze 772: font_push('I');
1.18 schwarze 773: print_node(m, n);
1.24 schwarze 774: font_pop();
1.14 schwarze 775: if (NULL != (n = n->next))
1.18 schwarze 776: print_word(",");
1.14 schwarze 777: }
778: return(0);
779: }
780:
781: static void
782: post_fa(DECL_ARGS)
783: {
784:
785: if (NULL != n->next && MDOC_Fa == n->next->tok)
1.18 schwarze 786: print_word(",");
1.14 schwarze 787: }
788:
789: static int
1.24 schwarze 790: pre_fl(DECL_ARGS)
791: {
792:
793: font_push('B');
794: print_word("-");
795: outflags &= ~MMAN_spc;
796: return(1);
797: }
798:
799: static void
800: post_fl(DECL_ARGS)
801: {
802:
803: font_pop();
1.25 schwarze 804: if (0 == n->nchild && NULL != n->next &&
805: n->next->line == n->line)
1.24 schwarze 806: outflags &= ~MMAN_spc;
807: }
808:
809: static int
1.13 schwarze 810: pre_fn(DECL_ARGS)
811: {
812:
1.21 schwarze 813: pre_syn(n);
814:
1.13 schwarze 815: n = n->child;
816: if (NULL == n)
817: return(0);
818:
1.24 schwarze 819: font_push('B');
1.18 schwarze 820: print_node(m, n);
1.24 schwarze 821: font_pop();
1.18 schwarze 822: outflags &= ~MMAN_spc;
1.24 schwarze 823: print_word("(");
1.18 schwarze 824: outflags &= ~MMAN_spc;
825: return(pre_fa(m, n->next));
1.13 schwarze 826: }
827:
828: static void
829: post_fn(DECL_ARGS)
830: {
831:
1.18 schwarze 832: print_word(")");
1.13 schwarze 833: if (MDOC_SYNPRETTY & n->flags) {
1.18 schwarze 834: print_word(";");
1.19 schwarze 835: outflags |= MMAN_br;
1.14 schwarze 836: }
837: }
838:
839: static int
840: pre_fo(DECL_ARGS)
841: {
842:
843: switch (n->type) {
1.21 schwarze 844: case (MDOC_BLOCK):
845: pre_syn(n);
846: break;
1.14 schwarze 847: case (MDOC_HEAD):
1.24 schwarze 848: font_push('B');
1.14 schwarze 849: break;
850: case (MDOC_BODY):
1.18 schwarze 851: outflags &= ~MMAN_spc;
852: print_word("(");
853: outflags &= ~MMAN_spc;
1.14 schwarze 854: break;
855: default:
856: break;
857: }
858: return(1);
859: }
860:
861: static void
862: post_fo(DECL_ARGS)
863: {
864:
865: switch (n->type) {
866: case (MDOC_HEAD):
1.24 schwarze 867: font_pop();
1.14 schwarze 868: break;
869: case (MDOC_BODY):
1.18 schwarze 870: post_fn(m, n);
1.14 schwarze 871: break;
872: default:
873: break;
1.13 schwarze 874: }
1.12 schwarze 875: }
876:
877: static int
1.21 schwarze 878: pre_ft(DECL_ARGS)
879: {
880:
881: pre_syn(n);
1.24 schwarze 882: font_push('I');
1.21 schwarze 883: return(1);
884: }
885:
886: static int
1.12 schwarze 887: pre_in(DECL_ARGS)
888: {
889:
890: if (MDOC_SYNPRETTY & n->flags) {
1.21 schwarze 891: pre_syn(n);
1.24 schwarze 892: font_push('B');
893: print_word("#include <");
894: outflags &= ~MMAN_spc;
895: } else {
896: print_word("<");
897: outflags &= ~MMAN_spc;
898: font_push('I');
899: }
1.12 schwarze 900: return(1);
901: }
902:
903: static void
904: post_in(DECL_ARGS)
905: {
906:
907: if (MDOC_SYNPRETTY & n->flags) {
1.24 schwarze 908: outflags &= ~MMAN_spc;
909: print_word(">");
910: font_pop();
1.19 schwarze 911: outflags |= MMAN_br;
1.24 schwarze 912: } else {
913: font_pop();
914: outflags &= ~MMAN_spc;
915: print_word(">");
916: }
1.1 schwarze 917: }
918:
919: static int
920: pre_it(DECL_ARGS)
921: {
922: const struct mdoc_node *bln;
923:
924: if (MDOC_HEAD == n->type) {
1.18 schwarze 925: outflags |= MMAN_nl;
926: print_word(".TP");
1.1 schwarze 927: bln = n->parent->parent->prev;
1.3 schwarze 928: switch (bln->norm->Bl.type) {
929: case (LIST_bullet):
1.18 schwarze 930: print_word("4n");
931: outflags |= MMAN_nl;
932: print_word("\\fBo\\fP");
1.3 schwarze 933: break;
934: default:
935: if (bln->norm->Bl.width)
1.18 schwarze 936: print_word(bln->norm->Bl.width);
1.3 schwarze 937: break;
938: }
1.18 schwarze 939: outflags |= MMAN_nl;
1.1 schwarze 940: }
941: return(1);
1.11 schwarze 942: }
943:
944: static void
945: post_lb(DECL_ARGS)
946: {
947:
1.19 schwarze 948: if (SEC_LIBRARY == n->sec)
949: outflags |= MMAN_br;
1.22 schwarze 950: }
951:
952: static int
953: pre_lk(DECL_ARGS)
954: {
955: const struct mdoc_node *link, *descr;
956:
957: if (NULL == (link = n->child))
958: return(0);
959:
960: if (NULL != (descr = link->next)) {
1.24 schwarze 961: font_push('I');
1.22 schwarze 962: while (NULL != descr) {
963: print_word(descr->string);
964: descr = descr->next;
965: }
966: print_word(":");
1.24 schwarze 967: font_pop();
1.22 schwarze 968: }
969:
1.24 schwarze 970: font_push('B');
1.22 schwarze 971: print_word(link->string);
1.24 schwarze 972: font_pop();
1.22 schwarze 973: return(0);
1.1 schwarze 974: }
975:
976: static int
1.24 schwarze 977: pre_li(DECL_ARGS)
978: {
979:
980: font_push('R');
981: return(1);
982: }
983:
984: static int
1.1 schwarze 985: pre_nm(DECL_ARGS)
986: {
987:
1.21 schwarze 988: if (MDOC_BLOCK == n->type)
989: pre_syn(n);
1.1 schwarze 990: if (MDOC_ELEM != n->type && MDOC_HEAD != n->type)
991: return(1);
1.21 schwarze 992: if (NULL == n->child && NULL == m->name)
993: return(0);
1.24 schwarze 994: font_push('B');
1.1 schwarze 995: if (NULL == n->child)
1.18 schwarze 996: print_word(m->name);
1.1 schwarze 997: return(1);
998: }
999:
1000: static void
1001: post_nm(DECL_ARGS)
1002: {
1003:
1004: if (MDOC_ELEM != n->type && MDOC_HEAD != n->type)
1005: return;
1.24 schwarze 1006: font_pop();
1.23 schwarze 1007: }
1008:
1009: static int
1010: pre_no(DECL_ARGS)
1011: {
1012:
1013: outflags |= MMAN_spc_force;
1014: return(1);
1.1 schwarze 1015: }
1016:
1017: static int
1018: pre_ns(DECL_ARGS)
1019: {
1020:
1.18 schwarze 1021: outflags &= ~MMAN_spc;
1.1 schwarze 1022: return(0);
1023: }
1024:
1.3 schwarze 1025: static void
1026: post_pf(DECL_ARGS)
1027: {
1028:
1.18 schwarze 1029: outflags &= ~MMAN_spc;
1.3 schwarze 1030: }
1031:
1.1 schwarze 1032: static int
1033: pre_pp(DECL_ARGS)
1034: {
1035:
1.18 schwarze 1036: outflags |= MMAN_nl;
1.1 schwarze 1037: if (MDOC_It == n->parent->tok)
1.18 schwarze 1038: print_word(".sp");
1.1 schwarze 1039: else
1.18 schwarze 1040: print_word(".PP");
1041: outflags |= MMAN_nl;
1.7 schwarze 1042: return(MDOC_Rs == n->tok);
1.9 schwarze 1043: }
1044:
1045: static int
1046: pre_sm(DECL_ARGS)
1047: {
1048:
1049: assert(n->child && MDOC_TEXT == n->child->type);
1050: if (0 == strcmp("on", n->child->string))
1.25 schwarze 1051: outflags |= MMAN_Sm | MMAN_spc;
1.9 schwarze 1052: else
1.18 schwarze 1053: outflags &= ~MMAN_Sm;
1.9 schwarze 1054: return(0);
1.1 schwarze 1055: }
1056:
1057: static int
1.3 schwarze 1058: pre_sp(DECL_ARGS)
1.1 schwarze 1059: {
1060:
1.18 schwarze 1061: outflags |= MMAN_nl;
1062: print_word(".sp");
1.1 schwarze 1063: return(1);
1064: }
1065:
1066: static void
1.3 schwarze 1067: post_sp(DECL_ARGS)
1.1 schwarze 1068: {
1069:
1.18 schwarze 1070: outflags |= MMAN_nl;
1.15 schwarze 1071: }
1072:
1073: static int
1.24 schwarze 1074: pre_sy(DECL_ARGS)
1075: {
1076:
1077: font_push('B');
1078: return(1);
1079: }
1080:
1081: static int
1.15 schwarze 1082: pre_vt(DECL_ARGS)
1083: {
1084:
1085: if (MDOC_SYNPRETTY & n->flags) {
1.16 schwarze 1086: switch (n->type) {
1087: case (MDOC_BLOCK):
1.21 schwarze 1088: pre_syn(n);
1.16 schwarze 1089: return(1);
1090: case (MDOC_BODY):
1091: break;
1092: default:
1093: return(0);
1094: }
1.15 schwarze 1095: }
1.24 schwarze 1096: font_push('I');
1.15 schwarze 1097: return(1);
1098: }
1099:
1100: static void
1101: post_vt(DECL_ARGS)
1102: {
1.16 schwarze 1103:
1.17 schwarze 1104: if (MDOC_SYNPRETTY & n->flags && MDOC_BODY != n->type)
1.16 schwarze 1105: return;
1.24 schwarze 1106: font_pop();
1.1 schwarze 1107: }
1108:
1109: static int
1110: pre_xr(DECL_ARGS)
1111: {
1112:
1113: n = n->child;
1114: if (NULL == n)
1115: return(0);
1.18 schwarze 1116: print_node(m, n);
1.1 schwarze 1117: n = n->next;
1118: if (NULL == n)
1119: return(0);
1.18 schwarze 1120: outflags &= ~MMAN_spc;
1121: print_word("(");
1122: print_node(m, n);
1123: print_word(")");
1.1 schwarze 1124: return(0);
1.5 schwarze 1125: }
1126:
1127: static int
1128: pre_ux(DECL_ARGS)
1129: {
1130:
1.18 schwarze 1131: print_word(manacts[n->tok].prefix);
1.5 schwarze 1132: if (NULL == n->child)
1133: return(0);
1.18 schwarze 1134: outflags &= ~MMAN_spc;
1135: print_word("\\~");
1136: outflags &= ~MMAN_spc;
1.5 schwarze 1137: return(1);
1.1 schwarze 1138: }
![[BACK]](/icons/back.gif){kind=icon}
Return to mdoc_man.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc