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