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