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