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