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