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