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