Annotation of src/usr.bin/mandoc/mdoc_term.c, Revision 1.181
1.181 ! schwarze 1: /* $OpenBSD: mdoc_term.c,v 1.180 2014/09/03 05:17:08 schwarze Exp $ */
1.1 kristaps 2: /*
1.122 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.161 schwarze 4: * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
1.158 schwarze 5: * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
1.1 kristaps 6: *
7: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 8: * purpose with or without fee is hereby granted, provided that the above
9: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 10: *
1.2 schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 18: */
19: #include <sys/types.h>
20:
21: #include <assert.h>
22: #include <ctype.h>
1.77 schwarze 23: #include <stdint.h>
1.1 kristaps 24: #include <stdio.h>
25: #include <stdlib.h>
26: #include <string.h>
27:
1.81 schwarze 28: #include "mandoc.h"
1.168 schwarze 29: #include "mandoc_aux.h"
1.61 schwarze 30: #include "out.h"
1.1 kristaps 31: #include "term.h"
32: #include "mdoc.h"
1.61 schwarze 33: #include "main.h"
1.54 schwarze 34:
1.1 kristaps 35: struct termpair {
36: struct termpair *ppair;
1.27 schwarze 37: int count;
1.1 kristaps 38: };
39:
1.29 schwarze 40: #define DECL_ARGS struct termp *p, \
41: struct termpair *pair, \
1.166 schwarze 42: const struct mdoc_meta *meta, \
1.146 schwarze 43: struct mdoc_node *n
1.1 kristaps 44:
45: struct termact {
46: int (*pre)(DECL_ARGS);
47: void (*post)(DECL_ARGS);
48: };
1.29 schwarze 49:
1.89 schwarze 50: static size_t a2width(const struct termp *, const char *);
51: static size_t a2height(const struct termp *, const char *);
52: static size_t a2offs(const struct termp *, const char *);
1.62 schwarze 53:
54: static void print_bvspace(struct termp *,
55: const struct mdoc_node *,
56: const struct mdoc_node *);
1.166 schwarze 57: static void print_mdoc_node(DECL_ARGS);
1.65 schwarze 58: static void print_mdoc_nodelist(DECL_ARGS);
1.87 schwarze 59: static void print_mdoc_head(struct termp *, const void *);
60: static void print_mdoc_foot(struct termp *, const void *);
1.166 schwarze 61: static void synopsis_pre(struct termp *,
1.86 schwarze 62: const struct mdoc_node *);
1.62 schwarze 63:
1.29 schwarze 64: static void termp____post(DECL_ARGS);
1.120 schwarze 65: static void termp__t_post(DECL_ARGS);
1.29 schwarze 66: static void termp_bd_post(DECL_ARGS);
1.90 schwarze 67: static void termp_bk_post(DECL_ARGS);
1.29 schwarze 68: static void termp_bl_post(DECL_ARGS);
1.143 schwarze 69: static void termp_fd_post(DECL_ARGS);
1.29 schwarze 70: static void termp_fo_post(DECL_ARGS);
71: static void termp_in_post(DECL_ARGS);
72: static void termp_it_post(DECL_ARGS);
73: static void termp_lb_post(DECL_ARGS);
1.94 schwarze 74: static void termp_nm_post(DECL_ARGS);
1.29 schwarze 75: static void termp_pf_post(DECL_ARGS);
1.107 schwarze 76: static void termp_quote_post(DECL_ARGS);
1.29 schwarze 77: static void termp_sh_post(DECL_ARGS);
78: static void termp_ss_post(DECL_ARGS);
79:
1.104 schwarze 80: static int termp__a_pre(DECL_ARGS);
1.120 schwarze 81: static int termp__t_pre(DECL_ARGS);
1.49 schwarze 82: static int termp_an_pre(DECL_ARGS);
1.29 schwarze 83: static int termp_ap_pre(DECL_ARGS);
84: static int termp_bd_pre(DECL_ARGS);
85: static int termp_bf_pre(DECL_ARGS);
1.90 schwarze 86: static int termp_bk_pre(DECL_ARGS);
1.73 schwarze 87: static int termp_bl_pre(DECL_ARGS);
1.54 schwarze 88: static int termp_bold_pre(DECL_ARGS);
1.29 schwarze 89: static int termp_bt_pre(DECL_ARGS);
1.126 schwarze 90: static int termp_bx_pre(DECL_ARGS);
1.29 schwarze 91: static int termp_cd_pre(DECL_ARGS);
92: static int termp_d1_pre(DECL_ARGS);
1.170 schwarze 93: static int termp_es_pre(DECL_ARGS);
1.29 schwarze 94: static int termp_ex_pre(DECL_ARGS);
95: static int termp_fa_pre(DECL_ARGS);
1.107 schwarze 96: static int termp_fd_pre(DECL_ARGS);
1.29 schwarze 97: static int termp_fl_pre(DECL_ARGS);
98: static int termp_fn_pre(DECL_ARGS);
99: static int termp_fo_pre(DECL_ARGS);
100: static int termp_ft_pre(DECL_ARGS);
101: static int termp_in_pre(DECL_ARGS);
102: static int termp_it_pre(DECL_ARGS);
1.65 schwarze 103: static int termp_li_pre(DECL_ARGS);
1.162 schwarze 104: static int termp_ll_pre(DECL_ARGS);
1.29 schwarze 105: static int termp_lk_pre(DECL_ARGS);
106: static int termp_nd_pre(DECL_ARGS);
107: static int termp_nm_pre(DECL_ARGS);
108: static int termp_ns_pre(DECL_ARGS);
1.107 schwarze 109: static int termp_quote_pre(DECL_ARGS);
1.29 schwarze 110: static int termp_rs_pre(DECL_ARGS);
111: static int termp_rv_pre(DECL_ARGS);
112: static int termp_sh_pre(DECL_ARGS);
113: static int termp_sm_pre(DECL_ARGS);
1.38 schwarze 114: static int termp_sp_pre(DECL_ARGS);
1.29 schwarze 115: static int termp_ss_pre(DECL_ARGS);
1.54 schwarze 116: static int termp_under_pre(DECL_ARGS);
1.29 schwarze 117: static int termp_ud_pre(DECL_ARGS);
1.69 schwarze 118: static int termp_vt_pre(DECL_ARGS);
1.29 schwarze 119: static int termp_xr_pre(DECL_ARGS);
120: static int termp_xx_pre(DECL_ARGS);
1.1 kristaps 121:
1.54 schwarze 122: static const struct termact termacts[MDOC_MAX] = {
1.11 schwarze 123: { termp_ap_pre, NULL }, /* Ap */
1.1 kristaps 124: { NULL, NULL }, /* Dd */
125: { NULL, NULL }, /* Dt */
126: { NULL, NULL }, /* Os */
127: { termp_sh_pre, termp_sh_post }, /* Sh */
1.166 schwarze 128: { termp_ss_pre, termp_ss_post }, /* Ss */
129: { termp_sp_pre, NULL }, /* Pp */
1.143 schwarze 130: { termp_d1_pre, termp_bl_post }, /* D1 */
131: { termp_d1_pre, termp_bl_post }, /* Dl */
1.1 kristaps 132: { termp_bd_pre, termp_bd_post }, /* Bd */
133: { NULL, NULL }, /* Ed */
1.73 schwarze 134: { termp_bl_pre, termp_bl_post }, /* Bl */
1.1 kristaps 135: { NULL, NULL }, /* El */
136: { termp_it_pre, termp_it_post }, /* It */
1.166 schwarze 137: { termp_under_pre, NULL }, /* Ad */
1.181 ! schwarze 138: { termp_an_pre, NULL }, /* An */
1.54 schwarze 139: { termp_under_pre, NULL }, /* Ar */
1.1 kristaps 140: { termp_cd_pre, NULL }, /* Cd */
1.54 schwarze 141: { termp_bold_pre, NULL }, /* Cm */
1.166 schwarze 142: { NULL, NULL }, /* Dv */
143: { NULL, NULL }, /* Er */
144: { NULL, NULL }, /* Ev */
1.1 kristaps 145: { termp_ex_pre, NULL }, /* Ex */
1.166 schwarze 146: { termp_fa_pre, NULL }, /* Fa */
147: { termp_fd_pre, termp_fd_post }, /* Fd */
1.1 kristaps 148: { termp_fl_pre, NULL }, /* Fl */
1.166 schwarze 149: { termp_fn_pre, NULL }, /* Fn */
150: { termp_ft_pre, NULL }, /* Ft */
151: { termp_bold_pre, NULL }, /* Ic */
152: { termp_in_pre, termp_in_post }, /* In */
1.65 schwarze 153: { termp_li_pre, NULL }, /* Li */
1.166 schwarze 154: { termp_nd_pre, NULL }, /* Nd */
155: { termp_nm_pre, termp_nm_post }, /* Nm */
1.107 schwarze 156: { termp_quote_pre, termp_quote_post }, /* Op */
1.170 schwarze 157: { termp_ft_pre, NULL }, /* Ot */
1.54 schwarze 158: { termp_under_pre, NULL }, /* Pa */
1.1 kristaps 159: { termp_rv_pre, NULL }, /* Rv */
1.166 schwarze 160: { NULL, NULL }, /* St */
1.54 schwarze 161: { termp_under_pre, NULL }, /* Va */
1.86 schwarze 162: { termp_vt_pre, NULL }, /* Vt */
1.1 kristaps 163: { termp_xr_pre, NULL }, /* Xr */
1.104 schwarze 164: { termp__a_pre, termp____post }, /* %A */
1.58 schwarze 165: { termp_under_pre, termp____post }, /* %B */
1.1 kristaps 166: { NULL, termp____post }, /* %D */
1.58 schwarze 167: { termp_under_pre, termp____post }, /* %I */
1.54 schwarze 168: { termp_under_pre, termp____post }, /* %J */
1.1 kristaps 169: { NULL, termp____post }, /* %N */
170: { NULL, termp____post }, /* %O */
171: { NULL, termp____post }, /* %P */
172: { NULL, termp____post }, /* %R */
1.120 schwarze 173: { termp__t_pre, termp__t_post }, /* %T */
1.1 kristaps 174: { NULL, termp____post }, /* %V */
175: { NULL, NULL }, /* Ac */
1.107 schwarze 176: { termp_quote_pre, termp_quote_post }, /* Ao */
177: { termp_quote_pre, termp_quote_post }, /* Aq */
1.32 schwarze 178: { NULL, NULL }, /* At */
1.1 kristaps 179: { NULL, NULL }, /* Bc */
1.166 schwarze 180: { termp_bf_pre, NULL }, /* Bf */
1.107 schwarze 181: { termp_quote_pre, termp_quote_post }, /* Bo */
182: { termp_quote_pre, termp_quote_post }, /* Bq */
1.26 schwarze 183: { termp_xx_pre, NULL }, /* Bsx */
1.126 schwarze 184: { termp_bx_pre, NULL }, /* Bx */
1.1 kristaps 185: { NULL, NULL }, /* Db */
186: { NULL, NULL }, /* Dc */
1.107 schwarze 187: { termp_quote_pre, termp_quote_post }, /* Do */
188: { termp_quote_pre, termp_quote_post }, /* Dq */
1.73 schwarze 189: { NULL, NULL }, /* Ec */ /* FIXME: no space */
1.1 kristaps 190: { NULL, NULL }, /* Ef */
1.166 schwarze 191: { termp_under_pre, NULL }, /* Em */
1.139 schwarze 192: { termp_quote_pre, termp_quote_post }, /* Eo */
1.26 schwarze 193: { termp_xx_pre, NULL }, /* Fx */
1.98 schwarze 194: { termp_bold_pre, NULL }, /* Ms */
1.156 schwarze 195: { NULL, NULL }, /* No */
1.1 kristaps 196: { termp_ns_pre, NULL }, /* Ns */
1.26 schwarze 197: { termp_xx_pre, NULL }, /* Nx */
198: { termp_xx_pre, NULL }, /* Ox */
1.1 kristaps 199: { NULL, NULL }, /* Pc */
1.156 schwarze 200: { NULL, termp_pf_post }, /* Pf */
1.107 schwarze 201: { termp_quote_pre, termp_quote_post }, /* Po */
202: { termp_quote_pre, termp_quote_post }, /* Pq */
1.1 kristaps 203: { NULL, NULL }, /* Qc */
1.107 schwarze 204: { termp_quote_pre, termp_quote_post }, /* Ql */
205: { termp_quote_pre, termp_quote_post }, /* Qo */
206: { termp_quote_pre, termp_quote_post }, /* Qq */
1.1 kristaps 207: { NULL, NULL }, /* Re */
208: { termp_rs_pre, NULL }, /* Rs */
209: { NULL, NULL }, /* Sc */
1.107 schwarze 210: { termp_quote_pre, termp_quote_post }, /* So */
211: { termp_quote_pre, termp_quote_post }, /* Sq */
1.1 kristaps 212: { termp_sm_pre, NULL }, /* Sm */
1.54 schwarze 213: { termp_under_pre, NULL }, /* Sx */
214: { termp_bold_pre, NULL }, /* Sy */
1.1 kristaps 215: { NULL, NULL }, /* Tn */
1.26 schwarze 216: { termp_xx_pre, NULL }, /* Ux */
1.1 kristaps 217: { NULL, NULL }, /* Xc */
218: { NULL, NULL }, /* Xo */
1.166 schwarze 219: { termp_fo_pre, termp_fo_post }, /* Fo */
220: { NULL, NULL }, /* Fc */
1.107 schwarze 221: { termp_quote_pre, termp_quote_post }, /* Oo */
1.1 kristaps 222: { NULL, NULL }, /* Oc */
1.90 schwarze 223: { termp_bk_pre, termp_bk_post }, /* Bk */
1.1 kristaps 224: { NULL, NULL }, /* Ek */
225: { termp_bt_pre, NULL }, /* Bt */
226: { NULL, NULL }, /* Hf */
1.170 schwarze 227: { termp_under_pre, NULL }, /* Fr */
1.1 kristaps 228: { termp_ud_pre, NULL }, /* Ud */
1.32 schwarze 229: { NULL, termp_lb_post }, /* Lb */
1.166 schwarze 230: { termp_sp_pre, NULL }, /* Lp */
231: { termp_lk_pre, NULL }, /* Lk */
232: { termp_under_pre, NULL }, /* Mt */
233: { termp_quote_pre, termp_quote_post }, /* Brq */
234: { termp_quote_pre, termp_quote_post }, /* Bro */
235: { NULL, NULL }, /* Brc */
236: { NULL, termp____post }, /* %C */
1.170 schwarze 237: { termp_es_pre, NULL }, /* Es */
238: { termp_quote_pre, termp_quote_post }, /* En */
1.166 schwarze 239: { termp_xx_pre, NULL }, /* Dx */
240: { NULL, termp____post }, /* %Q */
1.54 schwarze 241: { termp_sp_pre, NULL }, /* br */
1.166 schwarze 242: { termp_sp_pre, NULL }, /* sp */
243: { NULL, termp____post }, /* %U */
244: { NULL, NULL }, /* Ta */
1.162 schwarze 245: { termp_ll_pre, NULL }, /* ll */
1.1 kristaps 246: };
247:
248:
1.55 schwarze 249: void
1.61 schwarze 250: terminal_mdoc(void *arg, const struct mdoc *mdoc)
1.1 kristaps 251: {
1.147 schwarze 252: const struct mdoc_meta *meta;
1.180 schwarze 253: struct mdoc_node *n;
1.61 schwarze 254: struct termp *p;
255:
256: p = (struct termp *)arg;
1.71 schwarze 257:
258: p->overstep = 0;
1.180 schwarze 259: p->rmargin = p->maxrmargin = p->defrmargin;
1.89 schwarze 260: p->tabwidth = term_len(p, 5);
1.61 schwarze 261:
262: if (NULL == p->symtab)
1.133 schwarze 263: p->symtab = mchars_alloc();
1.55 schwarze 264:
1.180 schwarze 265: n = mdoc_node(mdoc)->child;
1.147 schwarze 266: meta = mdoc_meta(mdoc);
1.55 schwarze 267:
1.180 schwarze 268: if (p->synopsisonly) {
269: while (n != NULL) {
270: if (n->tok == MDOC_Sh && n->sec == SEC_SYNOPSIS) {
271: if (n->child->next->child != NULL)
272: print_mdoc_nodelist(p, NULL,
273: meta, n->child->next->child);
274: term_newln(p);
275: break;
276: }
277: n = n->next;
278: }
279: } else {
280: if (p->defindent == 0)
281: p->defindent = 5;
282: term_begin(p, print_mdoc_head, print_mdoc_foot, meta);
283: if (n != NULL) {
284: if (n->tok != MDOC_Sh)
285: term_vspace(p);
286: print_mdoc_nodelist(p, NULL, meta, n);
287: }
288: term_end(p);
1.173 schwarze 289: }
1.1 kristaps 290: }
291:
292: static void
1.65 schwarze 293: print_mdoc_nodelist(DECL_ARGS)
1.1 kristaps 294: {
295:
1.147 schwarze 296: print_mdoc_node(p, pair, meta, n);
1.60 schwarze 297: if (n->next)
1.147 schwarze 298: print_mdoc_nodelist(p, pair, meta, n->next);
1.1 kristaps 299: }
300:
301: static void
1.65 schwarze 302: print_mdoc_node(DECL_ARGS)
1.1 kristaps 303: {
1.65 schwarze 304: int chld;
1.1 kristaps 305: struct termpair npair;
1.28 schwarze 306: size_t offset, rmargin;
1.1 kristaps 307:
1.54 schwarze 308: chld = 1;
1.28 schwarze 309: offset = p->offset;
310: rmargin = p->rmargin;
1.146 schwarze 311: n->prev_font = term_fontq(p);
1.1 kristaps 312:
1.63 schwarze 313: memset(&npair, 0, sizeof(struct termpair));
1.1 kristaps 314: npair.ppair = pair;
1.65 schwarze 315:
1.95 schwarze 316: /*
317: * Keeps only work until the end of a line. If a keep was
318: * invoked in a prior line, revert it to PREKEEP.
319: */
320:
1.155 schwarze 321: if (TERMP_KEEP & p->flags) {
1.154 schwarze 322: if (n->prev ? (n->prev->lastline != n->line) :
1.150 schwarze 323: (n->parent && n->parent->line != n->line)) {
1.95 schwarze 324: p->flags &= ~TERMP_KEEP;
325: p->flags |= TERMP_PREKEEP;
326: }
327: }
1.116 schwarze 328:
329: /*
1.128 schwarze 330: * After the keep flags have been set up, we may now
331: * produce output. Note that some pre-handlers do so.
332: */
333:
334: switch (n->type) {
1.166 schwarze 335: case MDOC_TEXT:
1.128 schwarze 336: if (' ' == *n->string && MDOC_LINE & n->flags)
337: term_newln(p);
1.132 schwarze 338: if (MDOC_DELIMC & n->flags)
339: p->flags |= TERMP_NOSPACE;
1.128 schwarze 340: term_word(p, n->string);
1.132 schwarze 341: if (MDOC_DELIMO & n->flags)
342: p->flags |= TERMP_NOSPACE;
1.128 schwarze 343: break;
1.166 schwarze 344: case MDOC_EQN:
1.135 schwarze 345: term_eqn(p, n->eqn);
1.131 schwarze 346: break;
1.166 schwarze 347: case MDOC_TBL:
1.128 schwarze 348: term_tbl(p, n->span);
349: break;
350: default:
351: if (termacts[n->tok].pre && ENDBODY_NOT == n->end)
352: chld = (*termacts[n->tok].pre)
1.147 schwarze 353: (p, &npair, meta, n);
1.128 schwarze 354: break;
355: }
1.95 schwarze 356:
1.60 schwarze 357: if (chld && n->child)
1.147 schwarze 358: print_mdoc_nodelist(p, &npair, meta, n->child);
1.1 kristaps 359:
1.146 schwarze 360: term_fontpopq(p,
361: (ENDBODY_NOT == n->end ? n : n->pending)->prev_font);
1.1 kristaps 362:
1.122 schwarze 363: switch (n->type) {
1.166 schwarze 364: case MDOC_TEXT:
1.122 schwarze 365: break;
1.166 schwarze 366: case MDOC_TBL:
1.131 schwarze 367: break;
1.166 schwarze 368: case MDOC_EQN:
1.122 schwarze 369: break;
370: default:
371: if ( ! termacts[n->tok].post || MDOC_ENDED & n->flags)
372: break;
1.147 schwarze 373: (void)(*termacts[n->tok].post)(p, &npair, meta, n);
1.93 schwarze 374:
375: /*
376: * Explicit end tokens not only call the post
377: * handler, but also tell the respective block
378: * that it must not call the post handler again.
379: */
1.95 schwarze 380: if (ENDBODY_NOT != n->end)
1.93 schwarze 381: n->pending->flags |= MDOC_ENDED;
382:
383: /*
384: * End of line terminating an implicit block
385: * while an explicit block is still open.
386: * Continue the explicit block without spacing.
387: */
388: if (ENDBODY_NOSPACE == n->end)
389: p->flags |= TERMP_NOSPACE;
1.122 schwarze 390: break;
1.93 schwarze 391: }
1.28 schwarze 392:
1.78 schwarze 393: if (MDOC_EOS & n->flags)
394: p->flags |= TERMP_SENTENCE;
395:
1.162 schwarze 396: if (MDOC_ll != n->tok) {
397: p->offset = offset;
398: p->rmargin = rmargin;
399: }
1.1 kristaps 400: }
401:
402: static void
1.87 schwarze 403: print_mdoc_foot(struct termp *p, const void *arg)
1.1 kristaps 404: {
1.147 schwarze 405: const struct mdoc_meta *meta;
1.87 schwarze 406:
1.147 schwarze 407: meta = (const struct mdoc_meta *)arg;
1.1 kristaps 408:
1.65 schwarze 409: term_fontrepl(p, TERMFONT_NONE);
410:
1.166 schwarze 411: /*
1.7 schwarze 412: * Output the footer in new-groff style, that is, three columns
413: * with the middle being the manual date and flanking columns
414: * being the operating system:
415: *
416: * SYSTEM DATE SYSTEM
417: */
418:
1.1 kristaps 419: term_vspace(p);
420:
1.7 schwarze 421: p->offset = 0;
1.166 schwarze 422: p->rmargin = (p->maxrmargin -
423: term_strlen(p, meta->date) + term_len(p, 1)) / 2;
1.152 schwarze 424: p->trailspace = 1;
1.1 kristaps 425: p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
426:
1.147 schwarze 427: term_word(p, meta->os);
1.1 kristaps 428: term_flushln(p);
429:
1.7 schwarze 430: p->offset = p->rmargin;
1.147 schwarze 431: p->rmargin = p->maxrmargin - term_strlen(p, meta->os);
1.136 schwarze 432: p->flags |= TERMP_NOSPACE;
1.7 schwarze 433:
1.147 schwarze 434: term_word(p, meta->date);
1.7 schwarze 435: term_flushln(p);
436:
1.1 kristaps 437: p->offset = p->rmargin;
438: p->rmargin = p->maxrmargin;
1.152 schwarze 439: p->trailspace = 0;
1.1 kristaps 440: p->flags &= ~TERMP_NOBREAK;
1.136 schwarze 441: p->flags |= TERMP_NOSPACE;
1.1 kristaps 442:
1.147 schwarze 443: term_word(p, meta->os);
1.1 kristaps 444: term_flushln(p);
1.7 schwarze 445:
446: p->offset = 0;
447: p->rmargin = p->maxrmargin;
448: p->flags = 0;
1.1 kristaps 449: }
450:
451: static void
1.87 schwarze 452: print_mdoc_head(struct termp *p, const void *arg)
1.1 kristaps 453: {
1.168 schwarze 454: const struct mdoc_meta *meta;
1.169 schwarze 455: char *volume, *title;
456: size_t vollen, titlen;
1.87 schwarze 457:
1.147 schwarze 458: meta = (const struct mdoc_meta *)arg;
1.1 kristaps 459:
460: /*
461: * The header is strange. It has three components, which are
462: * really two with the first duplicated. It goes like this:
463: *
464: * IDENTIFIER TITLE IDENTIFIER
465: *
466: * The IDENTIFIER is NAME(SECTION), which is the command-name
467: * (if given, or "unknown" if not) followed by the manual page
468: * section. These are given in `Dt'. The TITLE is a free-form
469: * string depending on the manual volume. If not specified, it
470: * switches on the manual section.
471: */
1.137 schwarze 472:
1.147 schwarze 473: assert(meta->vol);
1.169 schwarze 474: if (NULL == meta->arch)
475: volume = mandoc_strdup(meta->vol);
476: else
477: mandoc_asprintf(&volume, "%s (%s)",
478: meta->vol, meta->arch);
479: vollen = term_strlen(p, volume);
1.1 kristaps 480:
1.177 schwarze 481: if (NULL == meta->msec)
482: title = mandoc_strdup(meta->title);
483: else
484: mandoc_asprintf(&title, "%s(%s)",
485: meta->title, meta->msec);
1.137 schwarze 486: titlen = term_strlen(p, title);
1.1 kristaps 487:
1.137 schwarze 488: p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
1.152 schwarze 489: p->trailspace = 1;
1.1 kristaps 490: p->offset = 0;
1.169 schwarze 491: p->rmargin = 2 * (titlen+1) + vollen < p->maxrmargin ?
492: (p->maxrmargin - vollen + term_len(p, 1)) / 2 :
493: p->maxrmargin - vollen;
1.1 kristaps 494:
495: term_word(p, title);
496: term_flushln(p);
497:
1.137 schwarze 498: p->flags |= TERMP_NOSPACE;
1.1 kristaps 499: p->offset = p->rmargin;
1.169 schwarze 500: p->rmargin = p->offset + vollen + titlen < p->maxrmargin ?
1.137 schwarze 501: p->maxrmargin - titlen : p->maxrmargin;
1.1 kristaps 502:
1.169 schwarze 503: term_word(p, volume);
1.1 kristaps 504: term_flushln(p);
505:
506: p->flags &= ~TERMP_NOBREAK;
1.152 schwarze 507: p->trailspace = 0;
1.137 schwarze 508: if (p->rmargin + titlen <= p->maxrmargin) {
509: p->flags |= TERMP_NOSPACE;
510: p->offset = p->rmargin;
511: p->rmargin = p->maxrmargin;
512: term_word(p, title);
513: term_flushln(p);
514: }
1.1 kristaps 515:
1.137 schwarze 516: p->flags &= ~TERMP_NOSPACE;
1.8 schwarze 517: p->offset = 0;
1.1 kristaps 518: p->rmargin = p->maxrmargin;
1.168 schwarze 519: free(title);
1.169 schwarze 520: free(volume);
1.1 kristaps 521: }
522:
523: static size_t
1.89 schwarze 524: a2height(const struct termp *p, const char *v)
1.1 kristaps 525: {
1.61 schwarze 526: struct roffsu su;
1.1 kristaps 527:
1.134 schwarze 528:
1.89 schwarze 529: assert(v);
530: if ( ! a2roffsu(v, &su, SCALE_VS))
1.134 schwarze 531: SCALE_VS_INIT(&su, atoi(v));
1.1 kristaps 532:
1.89 schwarze 533: return(term_vspan(p, &su));
1.61 schwarze 534: }
1.34 schwarze 535:
1.61 schwarze 536: static size_t
1.89 schwarze 537: a2width(const struct termp *p, const char *v)
1.61 schwarze 538: {
539: struct roffsu su;
1.1 kristaps 540:
1.88 schwarze 541: assert(v);
542: if ( ! a2roffsu(v, &su, SCALE_MAX))
1.89 schwarze 543: SCALE_HS_INIT(&su, term_strlen(p, v));
1.1 kristaps 544:
1.89 schwarze 545: return(term_hspan(p, &su));
1.1 kristaps 546: }
547:
548: static size_t
1.89 schwarze 549: a2offs(const struct termp *p, const char *v)
1.1 kristaps 550: {
1.61 schwarze 551: struct roffsu su;
1.1 kristaps 552:
1.88 schwarze 553: if ('\0' == *v)
1.61 schwarze 554: return(0);
1.88 schwarze 555: else if (0 == strcmp(v, "left"))
1.9 schwarze 556: return(0);
1.88 schwarze 557: else if (0 == strcmp(v, "indent"))
1.140 schwarze 558: return(term_len(p, p->defindent + 1));
1.88 schwarze 559: else if (0 == strcmp(v, "indent-two"))
1.140 schwarze 560: return(term_len(p, (p->defindent + 1) * 2));
1.88 schwarze 561: else if ( ! a2roffsu(v, &su, SCALE_MAX))
1.89 schwarze 562: SCALE_HS_INIT(&su, term_strlen(p, v));
1.10 schwarze 563:
1.89 schwarze 564: return(term_hspan(p, &su));
1.1 kristaps 565: }
566:
1.68 schwarze 567: /*
568: * Determine how much space to print out before block elements of `It'
569: * (and thus `Bl') and `Bd'. And then go ahead and print that space,
570: * too.
571: */
1.45 schwarze 572: static void
1.166 schwarze 573: print_bvspace(struct termp *p,
574: const struct mdoc_node *bl,
575: const struct mdoc_node *n)
1.1 kristaps 576: {
1.60 schwarze 577: const struct mdoc_node *nn;
1.138 schwarze 578:
579: assert(n);
1.1 kristaps 580:
581: term_newln(p);
1.88 schwarze 582:
1.121 schwarze 583: if (MDOC_Bd == bl->tok && bl->norm->Bd.comp)
1.88 schwarze 584: return;
1.121 schwarze 585: if (MDOC_Bl == bl->tok && bl->norm->Bl.comp)
1.45 schwarze 586: return;
587:
1.60 schwarze 588: /* Do not vspace directly after Ss/Sh. */
1.1 kristaps 589:
1.60 schwarze 590: for (nn = n; nn; nn = nn->parent) {
591: if (MDOC_BLOCK != nn->type)
1.1 kristaps 592: continue;
1.60 schwarze 593: if (MDOC_Ss == nn->tok)
1.45 schwarze 594: return;
1.60 schwarze 595: if (MDOC_Sh == nn->tok)
1.45 schwarze 596: return;
1.60 schwarze 597: if (NULL == nn->prev)
1.1 kristaps 598: continue;
599: break;
600: }
601:
1.60 schwarze 602: /* A `-column' does not assert vspace within the list. */
1.45 schwarze 603:
1.121 schwarze 604: if (MDOC_Bl == bl->tok && LIST_column == bl->norm->Bl.type)
1.60 schwarze 605: if (n->prev && MDOC_It == n->prev->tok)
1.45 schwarze 606: return;
607:
1.60 schwarze 608: /* A `-diag' without body does not vspace. */
609:
1.121 schwarze 610: if (MDOC_Bl == bl->tok && LIST_diag == bl->norm->Bl.type)
1.60 schwarze 611: if (n->prev && MDOC_It == n->prev->tok) {
612: assert(n->prev->body);
613: if (NULL == n->prev->body->child)
1.45 schwarze 614: return;
615: }
616:
617: term_vspace(p);
1.162 schwarze 618: }
619:
620:
621: static int
622: termp_ll_pre(DECL_ARGS)
623: {
624:
1.163 schwarze 625: term_setwidth(p, n->nchild ? n->child->string : NULL);
1.162 schwarze 626: return(0);
1.1 kristaps 627: }
628:
629: static int
630: termp_it_pre(DECL_ARGS)
631: {
1.60 schwarze 632: const struct mdoc_node *bl, *nn;
1.167 schwarze 633: char buf[24];
1.166 schwarze 634: int i;
635: size_t width, offset, ncols, dcol;
1.82 schwarze 636: enum mdoc_list type;
1.1 kristaps 637:
1.60 schwarze 638: if (MDOC_BLOCK == n->type) {
1.61 schwarze 639: print_bvspace(p, n->parent->parent, n);
1.45 schwarze 640: return(1);
641: }
1.1 kristaps 642:
1.60 schwarze 643: bl = n->parent->parent->parent;
1.121 schwarze 644: type = bl->norm->Bl.type;
1.1 kristaps 645:
1.166 schwarze 646: /*
1.68 schwarze 647: * First calculate width and offset. This is pretty easy unless
648: * we're a -column list, in which case all prior columns must
649: * be accounted for.
650: */
651:
652: width = offset = 0;
653:
1.121 schwarze 654: if (bl->norm->Bl.offs)
655: offset = a2offs(p, bl->norm->Bl.offs);
1.66 schwarze 656:
1.1 kristaps 657: switch (type) {
1.166 schwarze 658: case LIST_column:
1.85 schwarze 659: if (MDOC_HEAD == n->type)
1.1 kristaps 660: break;
1.88 schwarze 661:
1.66 schwarze 662: /*
1.68 schwarze 663: * Imitate groff's column handling:
664: * - For each earlier column, add its width.
665: * - For less than 5 columns, add four more blanks per
666: * column.
667: * - For exactly 5 columns, add three more blank per
668: * column.
669: * - For more than 5 columns, add only one column.
1.66 schwarze 670: */
1.121 schwarze 671: ncols = bl->norm->Bl.ncols;
1.166 schwarze 672: dcol = ncols < 5 ? term_len(p, 4) :
673: ncols == 5 ? term_len(p, 3) : term_len(p, 1);
1.68 schwarze 674:
1.85 schwarze 675: /*
676: * Calculate the offset by applying all prior MDOC_BODY,
677: * so we stop at the MDOC_HEAD (NULL == nn->prev).
678: */
679:
1.166 schwarze 680: for (i = 0, nn = n->prev;
681: nn->prev && i < (int)ncols;
682: nn = nn->prev, i++)
683: offset += dcol + a2width(p,
684: bl->norm->Bl.cols[i]);
1.66 schwarze 685:
686: /*
1.68 schwarze 687: * When exceeding the declared number of columns, leave
688: * the remaining widths at 0. This will later be
689: * adjusted to the default width of 10, or, for the last
690: * column, stretched to the right margin.
1.46 schwarze 691: */
1.68 schwarze 692: if (i >= (int)ncols)
693: break;
1.46 schwarze 694:
1.66 schwarze 695: /*
1.68 schwarze 696: * Use the declared column widths, extended as explained
697: * in the preceding paragraph.
1.66 schwarze 698: */
1.121 schwarze 699: width = a2width(p, bl->norm->Bl.cols[i]) + dcol;
1.1 kristaps 700: break;
701: default:
1.121 schwarze 702: if (NULL == bl->norm->Bl.width)
1.68 schwarze 703: break;
704:
1.166 schwarze 705: /*
1.68 schwarze 706: * Note: buffer the width by 2, which is groff's magic
707: * number for buffering single arguments. See the above
708: * handling for column for how this changes.
709: */
1.121 schwarze 710: assert(bl->norm->Bl.width);
711: width = a2width(p, bl->norm->Bl.width) + term_len(p, 2);
1.1 kristaps 712: break;
713: }
714:
1.166 schwarze 715: /*
1.1 kristaps 716: * List-type can override the width in the case of fixed-head
717: * values (bullet, dash/hyphen, enum). Tags need a non-zero
1.53 schwarze 718: * offset.
1.1 kristaps 719: */
720:
721: switch (type) {
1.166 schwarze 722: case LIST_bullet:
1.1 kristaps 723: /* FALLTHROUGH */
1.166 schwarze 724: case LIST_dash:
1.1 kristaps 725: /* FALLTHROUGH */
1.166 schwarze 726: case LIST_hyphen:
1.144 schwarze 727: /* FALLTHROUGH */
1.166 schwarze 728: case LIST_enum:
1.144 schwarze 729: if (width < term_len(p, 2))
730: width = term_len(p, 2);
1.1 kristaps 731: break;
1.166 schwarze 732: case LIST_hang:
1.33 schwarze 733: if (0 == width)
1.89 schwarze 734: width = term_len(p, 8);
1.33 schwarze 735: break;
1.166 schwarze 736: case LIST_column:
1.41 schwarze 737: /* FALLTHROUGH */
1.166 schwarze 738: case LIST_tag:
1.1 kristaps 739: if (0 == width)
1.89 schwarze 740: width = term_len(p, 10);
1.1 kristaps 741: break;
742: default:
743: break;
744: }
745:
1.166 schwarze 746: /*
1.16 schwarze 747: * Whitespace control. Inset bodies need an initial space,
748: * while diagonal bodies need two.
1.1 kristaps 749: */
750:
1.42 schwarze 751: p->flags |= TERMP_NOSPACE;
752:
1.1 kristaps 753: switch (type) {
1.166 schwarze 754: case LIST_diag:
1.60 schwarze 755: if (MDOC_BODY == n->type)
1.48 schwarze 756: term_word(p, "\\ \\ ");
1.42 schwarze 757: break;
1.166 schwarze 758: case LIST_inset:
1.172 schwarze 759: if (MDOC_BODY == n->type && n->parent->head->nchild)
1.42 schwarze 760: term_word(p, "\\ ");
1.1 kristaps 761: break;
762: default:
763: break;
764: }
765:
1.42 schwarze 766: p->flags |= TERMP_NOSPACE;
767:
1.1 kristaps 768: switch (type) {
1.166 schwarze 769: case LIST_diag:
1.60 schwarze 770: if (MDOC_HEAD == n->type)
1.65 schwarze 771: term_fontpush(p, TERMFONT_BOLD);
1.1 kristaps 772: break;
773: default:
774: break;
775: }
776:
777: /*
1.68 schwarze 778: * Pad and break control. This is the tricky part. These flags
779: * are documented in term_flushln() in term.c. Note that we're
780: * going to unset all of these flags in termp_it_post() when we
781: * exit.
1.1 kristaps 782: */
783:
784: switch (type) {
1.166 schwarze 785: case LIST_enum:
1.144 schwarze 786: /*
787: * Weird special case.
788: * Very narrow enum lists actually hang.
789: */
790: if (width == term_len(p, 2))
791: p->flags |= TERMP_HANG;
792: /* FALLTHROUGH */
1.166 schwarze 793: case LIST_bullet:
1.1 kristaps 794: /* FALLTHROUGH */
1.166 schwarze 795: case LIST_dash:
1.1 kristaps 796: /* FALLTHROUGH */
1.166 schwarze 797: case LIST_hyphen:
1.152 schwarze 798: if (MDOC_HEAD != n->type)
799: break;
800: p->flags |= TERMP_NOBREAK;
801: p->trailspace = 1;
1.33 schwarze 802: break;
1.166 schwarze 803: case LIST_hang:
1.152 schwarze 804: if (MDOC_HEAD != n->type)
1.47 schwarze 805: break;
806:
807: /*
808: * This is ugly. If `-hang' is specified and the body
809: * is a `Bl' or `Bd', then we want basically to nullify
810: * the "overstep" effect in term_flushln() and treat
811: * this as a `-ohang' list instead.
812: */
1.178 schwarze 813: if (NULL != n->next &&
814: NULL != n->next->child &&
1.166 schwarze 815: (MDOC_Bl == n->next->child->tok ||
816: MDOC_Bd == n->next->child->tok))
1.152 schwarze 817: break;
818:
1.165 schwarze 819: p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG;
1.152 schwarze 820: p->trailspace = 1;
1.33 schwarze 821: break;
1.166 schwarze 822: case LIST_tag:
1.60 schwarze 823: if (MDOC_HEAD != n->type)
1.33 schwarze 824: break;
1.152 schwarze 825:
1.165 schwarze 826: p->flags |= TERMP_NOBREAK | TERMP_BRIND;
1.152 schwarze 827: p->trailspace = 2;
828:
1.60 schwarze 829: if (NULL == n->next || NULL == n->next->child)
1.33 schwarze 830: p->flags |= TERMP_DANGLE;
1.1 kristaps 831: break;
1.166 schwarze 832: case LIST_column:
1.85 schwarze 833: if (MDOC_HEAD == n->type)
834: break;
835:
1.152 schwarze 836: if (NULL == n->next) {
1.85 schwarze 837: p->flags &= ~TERMP_NOBREAK;
1.152 schwarze 838: p->trailspace = 0;
839: } else {
1.85 schwarze 840: p->flags |= TERMP_NOBREAK;
1.152 schwarze 841: p->trailspace = 1;
842: }
1.85 schwarze 843:
1.1 kristaps 844: break;
1.166 schwarze 845: case LIST_diag:
1.152 schwarze 846: if (MDOC_HEAD != n->type)
847: break;
1.165 schwarze 848: p->flags |= TERMP_NOBREAK | TERMP_BRIND;
1.152 schwarze 849: p->trailspace = 1;
1.1 kristaps 850: break;
851: default:
852: break;
853: }
854:
1.166 schwarze 855: /*
1.1 kristaps 856: * Margin control. Set-head-width lists have their right
857: * margins shortened. The body for these lists has the offset
858: * necessarily lengthened. Everybody gets the offset.
859: */
860:
861: p->offset += offset;
862:
863: switch (type) {
1.166 schwarze 864: case LIST_hang:
1.47 schwarze 865: /*
866: * Same stipulation as above, regarding `-hang'. We
867: * don't want to recalculate rmargin and offsets when
868: * using `Bd' or `Bl' within `-hang' overstep lists.
869: */
1.178 schwarze 870: if (MDOC_HEAD == n->type &&
871: NULL != n->next &&
872: NULL != n->next->child &&
1.166 schwarze 873: (MDOC_Bl == n->next->child->tok ||
874: MDOC_Bd == n->next->child->tok))
1.47 schwarze 875: break;
876: /* FALLTHROUGH */
1.166 schwarze 877: case LIST_bullet:
1.1 kristaps 878: /* FALLTHROUGH */
1.166 schwarze 879: case LIST_dash:
1.1 kristaps 880: /* FALLTHROUGH */
1.166 schwarze 881: case LIST_enum:
1.1 kristaps 882: /* FALLTHROUGH */
1.166 schwarze 883: case LIST_hyphen:
1.33 schwarze 884: /* FALLTHROUGH */
1.166 schwarze 885: case LIST_tag:
1.41 schwarze 886: assert(width);
1.60 schwarze 887: if (MDOC_HEAD == n->type)
1.1 kristaps 888: p->rmargin = p->offset + width;
1.161 schwarze 889: else {
1.1 kristaps 890: p->offset += width;
1.161 schwarze 891: if (p->rmargin < p->offset)
892: p->rmargin = p->offset;
893: }
1.1 kristaps 894: break;
1.166 schwarze 895: case LIST_column:
1.41 schwarze 896: assert(width);
1.1 kristaps 897: p->rmargin = p->offset + width;
1.166 schwarze 898: /*
1.43 schwarze 899: * XXX - this behaviour is not documented: the
900: * right-most column is filled to the right margin.
901: */
1.85 schwarze 902: if (MDOC_HEAD == n->type)
903: break;
904: if (NULL == n->next && p->rmargin < p->maxrmargin)
1.43 schwarze 905: p->rmargin = p->maxrmargin;
1.1 kristaps 906: break;
907: default:
908: break;
909: }
910:
1.166 schwarze 911: /*
1.1 kristaps 912: * The dash, hyphen, bullet and enum lists all have a special
1.166 schwarze 913: * HEAD character (temporarily bold, in some cases).
1.1 kristaps 914: */
915:
1.60 schwarze 916: if (MDOC_HEAD == n->type)
1.1 kristaps 917: switch (type) {
1.166 schwarze 918: case LIST_bullet:
1.65 schwarze 919: term_fontpush(p, TERMFONT_BOLD);
1.1 kristaps 920: term_word(p, "\\[bu]");
1.65 schwarze 921: term_fontpop(p);
1.1 kristaps 922: break;
1.166 schwarze 923: case LIST_dash:
1.1 kristaps 924: /* FALLTHROUGH */
1.166 schwarze 925: case LIST_hyphen:
1.65 schwarze 926: term_fontpush(p, TERMFONT_BOLD);
1.35 schwarze 927: term_word(p, "\\(hy");
1.65 schwarze 928: term_fontpop(p);
1.1 kristaps 929: break;
1.166 schwarze 930: case LIST_enum:
1.1 kristaps 931: (pair->ppair->ppair->count)++;
1.167 schwarze 932: (void)snprintf(buf, sizeof(buf), "%d.",
1.166 schwarze 933: pair->ppair->ppair->count);
1.1 kristaps 934: term_word(p, buf);
935: break;
936: default:
937: break;
938: }
1.12 schwarze 939:
1.166 schwarze 940: /*
1.1 kristaps 941: * If we're not going to process our children, indicate so here.
942: */
943:
944: switch (type) {
1.166 schwarze 945: case LIST_bullet:
1.1 kristaps 946: /* FALLTHROUGH */
1.166 schwarze 947: case LIST_item:
1.1 kristaps 948: /* FALLTHROUGH */
1.166 schwarze 949: case LIST_dash:
1.1 kristaps 950: /* FALLTHROUGH */
1.166 schwarze 951: case LIST_hyphen:
1.1 kristaps 952: /* FALLTHROUGH */
1.166 schwarze 953: case LIST_enum:
1.60 schwarze 954: if (MDOC_HEAD == n->type)
1.1 kristaps 955: return(0);
956: break;
1.166 schwarze 957: case LIST_column:
1.85 schwarze 958: if (MDOC_HEAD == n->type)
1.1 kristaps 959: return(0);
960: break;
961: default:
962: break;
963: }
964:
965: return(1);
966: }
967:
968: static void
969: termp_it_post(DECL_ARGS)
970: {
1.82 schwarze 971: enum mdoc_list type;
1.1 kristaps 972:
1.68 schwarze 973: if (MDOC_BLOCK == n->type)
1.1 kristaps 974: return;
975:
1.121 schwarze 976: type = n->parent->parent->parent->norm->Bl.type;
1.1 kristaps 977:
978: switch (type) {
1.166 schwarze 979: case LIST_item:
1.44 schwarze 980: /* FALLTHROUGH */
1.166 schwarze 981: case LIST_diag:
1.1 kristaps 982: /* FALLTHROUGH */
1.166 schwarze 983: case LIST_inset:
1.60 schwarze 984: if (MDOC_BODY == n->type)
1.74 schwarze 985: term_newln(p);
1.1 kristaps 986: break;
1.166 schwarze 987: case LIST_column:
1.85 schwarze 988: if (MDOC_BODY == n->type)
1.1 kristaps 989: term_flushln(p);
990: break;
991: default:
1.74 schwarze 992: term_newln(p);
1.1 kristaps 993: break;
994: }
995:
1.166 schwarze 996: /*
1.68 schwarze 997: * Now that our output is flushed, we can reset our tags. Since
998: * only `It' sets these flags, we're free to assume that nobody
999: * has munged them in the meanwhile.
1000: */
1001:
1.165 schwarze 1002: p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND |
1003: TERMP_DANGLE | TERMP_HANG);
1.152 schwarze 1004: p->trailspace = 0;
1.1 kristaps 1005: }
1006:
1007: static int
1008: termp_nm_pre(DECL_ARGS)
1009: {
1010:
1.155 schwarze 1011: if (MDOC_BLOCK == n->type) {
1012: p->flags |= TERMP_PREKEEP;
1.94 schwarze 1013: return(1);
1.155 schwarze 1014: }
1.94 schwarze 1015:
1016: if (MDOC_BODY == n->type) {
1017: if (NULL == n->child)
1018: return(0);
1.136 schwarze 1019: p->flags |= TERMP_NOSPACE;
1.94 schwarze 1020: p->offset += term_len(p, 1) +
1.147 schwarze 1021: (NULL == n->prev->child ?
1022: term_strlen(p, meta->name) :
1.94 schwarze 1023: MDOC_TEXT == n->prev->child->type ?
1.147 schwarze 1024: term_strlen(p, n->prev->child->string) :
1.94 schwarze 1025: term_len(p, 5));
1.164 schwarze 1026: if (p->rmargin < p->offset)
1027: p->rmargin = p->offset;
1.94 schwarze 1028: return(1);
1029: }
1030:
1.147 schwarze 1031: if (NULL == n->child && NULL == meta->name)
1.94 schwarze 1032: return(0);
1.81 schwarze 1033:
1.97 schwarze 1034: if (MDOC_HEAD == n->type)
1035: synopsis_pre(p, n->parent);
1.65 schwarze 1036:
1.178 schwarze 1037: if (MDOC_HEAD == n->type &&
1038: NULL != n->next && NULL != n->next->child) {
1.165 schwarze 1039: p->flags |= TERMP_NOSPACE | TERMP_NOBREAK | TERMP_BRIND;
1.152 schwarze 1040: p->trailspace = 1;
1.105 schwarze 1041: p->rmargin = p->offset + term_len(p, 1);
1042: if (NULL == n->child) {
1.147 schwarze 1043: p->rmargin += term_strlen(p, meta->name);
1.105 schwarze 1044: } else if (MDOC_TEXT == n->child->type) {
1045: p->rmargin += term_strlen(p, n->child->string);
1046: if (n->child->next)
1047: p->flags |= TERMP_HANG;
1048: } else {
1049: p->rmargin += term_len(p, 5);
1050: p->flags |= TERMP_HANG;
1051: }
1.94 schwarze 1052: }
1053:
1.65 schwarze 1054: term_fontpush(p, TERMFONT_BOLD);
1.60 schwarze 1055: if (NULL == n->child)
1.147 schwarze 1056: term_word(p, meta->name);
1.1 kristaps 1057: return(1);
1058: }
1059:
1.94 schwarze 1060: static void
1061: termp_nm_post(DECL_ARGS)
1062: {
1063:
1.155 schwarze 1064: if (MDOC_BLOCK == n->type) {
1065: p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
1.178 schwarze 1066: } else if (MDOC_HEAD == n->type &&
1067: NULL != n->next && NULL != n->next->child) {
1.94 schwarze 1068: term_flushln(p);
1.165 schwarze 1069: p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
1.152 schwarze 1070: p->trailspace = 0;
1.136 schwarze 1071: } else if (MDOC_BODY == n->type && n->child)
1.94 schwarze 1072: term_flushln(p);
1073: }
1074:
1.1 kristaps 1075: static int
1076: termp_fl_pre(DECL_ARGS)
1077: {
1078:
1.65 schwarze 1079: term_fontpush(p, TERMFONT_BOLD);
1.1 kristaps 1080: term_word(p, "\\-");
1.67 schwarze 1081:
1.179 schwarze 1082: if ( ! (n->nchild == 0 &&
1083: (n->next == NULL ||
1084: n->next->type == MDOC_TEXT ||
1085: n->next->flags & MDOC_LINE)))
1.73 schwarze 1086: p->flags |= TERMP_NOSPACE;
1.67 schwarze 1087:
1.1 kristaps 1088: return(1);
1.49 schwarze 1089: }
1090:
1091: static int
1.104 schwarze 1092: termp__a_pre(DECL_ARGS)
1093: {
1094:
1095: if (n->prev && MDOC__A == n->prev->tok)
1096: if (NULL == n->next || MDOC__A != n->next->tok)
1097: term_word(p, "and");
1098:
1099: return(1);
1100: }
1101:
1102: static int
1.49 schwarze 1103: termp_an_pre(DECL_ARGS)
1104: {
1105:
1.181 ! schwarze 1106: if (n->norm->An.auth == AUTH_split) {
! 1107: p->flags &= ~TERMP_NOSPLIT;
! 1108: p->flags |= TERMP_SPLIT;
! 1109: return(0);
! 1110: }
! 1111: if (n->norm->An.auth == AUTH_nosplit) {
! 1112: p->flags &= ~TERMP_SPLIT;
! 1113: p->flags |= TERMP_NOSPLIT;
! 1114: return(0);
! 1115: }
1.49 schwarze 1116:
1.181 ! schwarze 1117: if (n->child == NULL)
! 1118: return(0);
1.166 schwarze 1119:
1.181 ! schwarze 1120: if (p->flags & TERMP_SPLIT)
1.49 schwarze 1121: term_newln(p);
1122:
1.181 ! schwarze 1123: if (n->sec == SEC_AUTHORS && ! (p->flags & TERMP_NOSPLIT))
! 1124: p->flags |= TERMP_SPLIT;
1.49 schwarze 1125:
1126: return(1);
1.1 kristaps 1127: }
1128:
1129: static int
1130: termp_ns_pre(DECL_ARGS)
1131: {
1132:
1.127 schwarze 1133: if ( ! (MDOC_LINE & n->flags))
1134: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1135: return(1);
1136: }
1137:
1138: static int
1139: termp_rs_pre(DECL_ARGS)
1140: {
1141:
1.60 schwarze 1142: if (SEC_SEE_ALSO != n->sec)
1.57 schwarze 1143: return(1);
1.60 schwarze 1144: if (MDOC_BLOCK == n->type && n->prev)
1.1 kristaps 1145: term_vspace(p);
1146: return(1);
1147: }
1148:
1149: static int
1150: termp_rv_pre(DECL_ARGS)
1151: {
1.132 schwarze 1152: int nchild;
1.1 kristaps 1153:
1154: term_newln(p);
1155:
1.132 schwarze 1156: nchild = n->nchild;
1.175 schwarze 1157: if (nchild > 0) {
1158: term_word(p, "The");
1.132 schwarze 1159:
1.175 schwarze 1160: for (n = n->child; n; n = n->next) {
1161: term_fontpush(p, TERMFONT_BOLD);
1162: term_word(p, n->string);
1163: term_fontpop(p);
1.132 schwarze 1164:
1165: p->flags |= TERMP_NOSPACE;
1.175 schwarze 1166: term_word(p, "()");
1167:
1168: if (n->next == NULL)
1169: continue;
1170:
1171: if (nchild > 2) {
1172: p->flags |= TERMP_NOSPACE;
1173: term_word(p, ",");
1174: }
1175: if (n->next->next == NULL)
1176: term_word(p, "and");
1.132 schwarze 1177: }
1178:
1.175 schwarze 1179: if (nchild > 1)
1180: term_word(p, "functions return");
1181: else
1182: term_word(p, "function returns");
1183:
1184: term_word(p, "the value\\~0 if successful;");
1185: } else
1186: term_word(p, "Upon successful completion,"
1187: " the value\\~0 is returned;");
1.1 kristaps 1188:
1.175 schwarze 1189: term_word(p, "otherwise the value\\~\\-1 is returned"
1190: " and the global variable");
1.1 kristaps 1191:
1.65 schwarze 1192: term_fontpush(p, TERMFONT_UNDER);
1.1 kristaps 1193: term_word(p, "errno");
1.65 schwarze 1194: term_fontpop(p);
1.1 kristaps 1195:
1.166 schwarze 1196: term_word(p, "is set to indicate the error.");
1.84 schwarze 1197: p->flags |= TERMP_SENTENCE;
1.1 kristaps 1198:
1.53 schwarze 1199: return(0);
1.1 kristaps 1200: }
1201:
1202: static int
1203: termp_ex_pre(DECL_ARGS)
1204: {
1.132 schwarze 1205: int nchild;
1.1 kristaps 1206:
1.132 schwarze 1207: term_newln(p);
1.53 schwarze 1208: term_word(p, "The");
1.1 kristaps 1209:
1.132 schwarze 1210: nchild = n->nchild;
1211: for (n = n->child; n; n = n->next) {
1.65 schwarze 1212: term_fontpush(p, TERMFONT_BOLD);
1.132 schwarze 1213: term_word(p, n->string);
1.65 schwarze 1214: term_fontpop(p);
1.132 schwarze 1215:
1216: if (nchild > 2 && n->next) {
1217: p->flags |= TERMP_NOSPACE;
1.53 schwarze 1218: term_word(p, ",");
1.132 schwarze 1219: }
1220:
1221: if (n->next && NULL == n->next->next)
1222: term_word(p, "and");
1.53 schwarze 1223: }
1224:
1.132 schwarze 1225: if (nchild > 1)
1.175 schwarze 1226: term_word(p, "utilities exit\\~0");
1.53 schwarze 1227: else
1.175 schwarze 1228: term_word(p, "utility exits\\~0");
1.53 schwarze 1229:
1.175 schwarze 1230: term_word(p, "on success, and\\~>0 if an error occurs.");
1.132 schwarze 1231:
1.84 schwarze 1232: p->flags |= TERMP_SENTENCE;
1.53 schwarze 1233: return(0);
1.1 kristaps 1234: }
1235:
1236: static int
1237: termp_nd_pre(DECL_ARGS)
1238: {
1.25 schwarze 1239:
1.60 schwarze 1240: if (MDOC_BODY != n->type)
1.25 schwarze 1241: return(1);
1242:
1243: #if defined(__OpenBSD__) || defined(__linux__)
1244: term_word(p, "\\(en");
1.24 schwarze 1245: #else
1246: term_word(p, "\\(em");
1247: #endif
1.1 kristaps 1248: return(1);
1249: }
1250:
1.73 schwarze 1251: static int
1252: termp_bl_pre(DECL_ARGS)
1253: {
1254:
1255: return(MDOC_HEAD != n->type);
1256: }
1257:
1.1 kristaps 1258: static void
1259: termp_bl_post(DECL_ARGS)
1260: {
1261:
1.60 schwarze 1262: if (MDOC_BLOCK == n->type)
1.1 kristaps 1263: term_newln(p);
1264: }
1265:
1266: static int
1267: termp_xr_pre(DECL_ARGS)
1268: {
1269:
1.132 schwarze 1270: if (NULL == (n = n->child))
1.72 schwarze 1271: return(0);
1272:
1.132 schwarze 1273: assert(MDOC_TEXT == n->type);
1274: term_word(p, n->string);
1.10 schwarze 1275:
1.166 schwarze 1276: if (NULL == (n = n->next))
1.1 kristaps 1277: return(0);
1.132 schwarze 1278:
1.1 kristaps 1279: p->flags |= TERMP_NOSPACE;
1280: term_word(p, "(");
1.132 schwarze 1281: p->flags |= TERMP_NOSPACE;
1282:
1283: assert(MDOC_TEXT == n->type);
1284: term_word(p, n->string);
1285:
1286: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1287: term_word(p, ")");
1.60 schwarze 1288:
1.1 kristaps 1289: return(0);
1290: }
1291:
1.86 schwarze 1292: /*
1293: * This decides how to assert whitespace before any of the SYNOPSIS set
1294: * of macros (which, as in the case of Ft/Fo and Ft/Fn, may contain
1295: * macro combos).
1296: */
1297: static void
1298: synopsis_pre(struct termp *p, const struct mdoc_node *n)
1299: {
1.166 schwarze 1300: /*
1.86 schwarze 1301: * Obviously, if we're not in a SYNOPSIS or no prior macros
1302: * exist, do nothing.
1303: */
1.92 schwarze 1304: if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags))
1.86 schwarze 1305: return;
1306:
1307: /*
1308: * If we're the second in a pair of like elements, emit our
1309: * newline and return. UNLESS we're `Fo', `Fn', `Fn', in which
1310: * case we soldier on.
1311: */
1.166 schwarze 1312: if (n->prev->tok == n->tok &&
1313: MDOC_Ft != n->tok &&
1314: MDOC_Fo != n->tok &&
1315: MDOC_Fn != n->tok) {
1.86 schwarze 1316: term_newln(p);
1317: return;
1318: }
1319:
1320: /*
1321: * If we're one of the SYNOPSIS set and non-like pair-wise after
1322: * another (or Fn/Fo, which we've let slip through) then assert
1323: * vertical space, else only newline and move on.
1324: */
1325: switch (n->prev->tok) {
1.166 schwarze 1326: case MDOC_Fd:
1.86 schwarze 1327: /* FALLTHROUGH */
1.166 schwarze 1328: case MDOC_Fn:
1.86 schwarze 1329: /* FALLTHROUGH */
1.166 schwarze 1330: case MDOC_Fo:
1.86 schwarze 1331: /* FALLTHROUGH */
1.166 schwarze 1332: case MDOC_In:
1.86 schwarze 1333: /* FALLTHROUGH */
1.166 schwarze 1334: case MDOC_Vt:
1.86 schwarze 1335: term_vspace(p);
1336: break;
1.166 schwarze 1337: case MDOC_Ft:
1.86 schwarze 1338: if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
1339: term_vspace(p);
1340: break;
1341: }
1342: /* FALLTHROUGH */
1343: default:
1344: term_newln(p);
1345: break;
1346: }
1347: }
1348:
1.69 schwarze 1349: static int
1350: termp_vt_pre(DECL_ARGS)
1351: {
1352:
1.86 schwarze 1353: if (MDOC_ELEM == n->type) {
1354: synopsis_pre(p, n);
1.147 schwarze 1355: return(termp_under_pre(p, pair, meta, n));
1.86 schwarze 1356: } else if (MDOC_BLOCK == n->type) {
1357: synopsis_pre(p, n);
1358: return(1);
1359: } else if (MDOC_HEAD == n->type)
1.69 schwarze 1360: return(0);
1361:
1.147 schwarze 1362: return(termp_under_pre(p, pair, meta, n));
1.69 schwarze 1363: }
1364:
1.1 kristaps 1365: static int
1.54 schwarze 1366: termp_bold_pre(DECL_ARGS)
1.1 kristaps 1367: {
1368:
1.65 schwarze 1369: term_fontpush(p, TERMFONT_BOLD);
1.1 kristaps 1370: return(1);
1371: }
1372:
1.86 schwarze 1373: static int
1374: termp_fd_pre(DECL_ARGS)
1.1 kristaps 1375: {
1376:
1.86 schwarze 1377: synopsis_pre(p, n);
1.147 schwarze 1378: return(termp_bold_pre(p, pair, meta, n));
1.1 kristaps 1379: }
1380:
1.143 schwarze 1381: static void
1382: termp_fd_post(DECL_ARGS)
1383: {
1384:
1385: term_newln(p);
1386: }
1387:
1.1 kristaps 1388: static int
1389: termp_sh_pre(DECL_ARGS)
1390: {
1.60 schwarze 1391:
1392: /* No vspace between consecutive `Sh' calls. */
1393:
1394: switch (n->type) {
1.166 schwarze 1395: case MDOC_BLOCK:
1.60 schwarze 1396: if (n->prev && MDOC_Sh == n->prev->tok)
1397: if (NULL == n->prev->body->child)
1.52 schwarze 1398: break;
1399: term_vspace(p);
1400: break;
1.166 schwarze 1401: case MDOC_HEAD:
1.65 schwarze 1402: term_fontpush(p, TERMFONT_BOLD);
1.1 kristaps 1403: break;
1.166 schwarze 1404: case MDOC_BODY:
1.140 schwarze 1405: p->offset = term_len(p, p->defindent);
1.141 schwarze 1406: if (SEC_AUTHORS == n->sec)
1407: p->flags &= ~(TERMP_SPLIT|TERMP_NOSPLIT);
1.1 kristaps 1408: break;
1409: default:
1410: break;
1411: }
1412: return(1);
1413: }
1414:
1415: static void
1416: termp_sh_post(DECL_ARGS)
1417: {
1418:
1.60 schwarze 1419: switch (n->type) {
1.166 schwarze 1420: case MDOC_HEAD:
1.1 kristaps 1421: term_newln(p);
1422: break;
1.166 schwarze 1423: case MDOC_BODY:
1.1 kristaps 1424: term_newln(p);
1425: p->offset = 0;
1426: break;
1427: default:
1428: break;
1429: }
1430: }
1431:
1432: static int
1433: termp_bt_pre(DECL_ARGS)
1434: {
1435:
1436: term_word(p, "is currently in beta test.");
1.84 schwarze 1437: p->flags |= TERMP_SENTENCE;
1.59 schwarze 1438: return(0);
1.1 kristaps 1439: }
1440:
1441: static void
1442: termp_lb_post(DECL_ARGS)
1443: {
1444:
1.77 schwarze 1445: if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags)
1.57 schwarze 1446: term_newln(p);
1.1 kristaps 1447: }
1448:
1449: static int
1450: termp_ud_pre(DECL_ARGS)
1451: {
1452:
1453: term_word(p, "currently under development.");
1.84 schwarze 1454: p->flags |= TERMP_SENTENCE;
1.60 schwarze 1455: return(0);
1.1 kristaps 1456: }
1457:
1458: static int
1459: termp_d1_pre(DECL_ARGS)
1460: {
1461:
1.60 schwarze 1462: if (MDOC_BLOCK != n->type)
1.1 kristaps 1463: return(1);
1464: term_newln(p);
1.140 schwarze 1465: p->offset += term_len(p, p->defindent + 1);
1.1 kristaps 1466: return(1);
1467: }
1468:
1469: static int
1470: termp_ft_pre(DECL_ARGS)
1471: {
1472:
1.85 schwarze 1473: /* NB: MDOC_LINE does not effect this! */
1.86 schwarze 1474: synopsis_pre(p, n);
1.65 schwarze 1475: term_fontpush(p, TERMFONT_UNDER);
1.1 kristaps 1476: return(1);
1477: }
1478:
1479: static int
1480: termp_fn_pre(DECL_ARGS)
1481: {
1.159 schwarze 1482: size_t rmargin = 0;
1.132 schwarze 1483: int pretty;
1484:
1485: pretty = MDOC_SYNPRETTY & n->flags;
1.1 kristaps 1486:
1.86 schwarze 1487: synopsis_pre(p, n);
1.85 schwarze 1488:
1.132 schwarze 1489: if (NULL == (n = n->child))
1490: return(0);
1491:
1.153 schwarze 1492: if (pretty) {
1493: rmargin = p->rmargin;
1.159 schwarze 1494: p->rmargin = p->offset + term_len(p, 4);
1.165 schwarze 1495: p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG;
1.153 schwarze 1496: }
1497:
1.132 schwarze 1498: assert(MDOC_TEXT == n->type);
1.65 schwarze 1499: term_fontpush(p, TERMFONT_BOLD);
1.132 schwarze 1500: term_word(p, n->string);
1.65 schwarze 1501: term_fontpop(p);
1.1 kristaps 1502:
1.153 schwarze 1503: if (pretty) {
1504: term_flushln(p);
1.165 schwarze 1505: p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
1.153 schwarze 1506: p->offset = p->rmargin;
1507: p->rmargin = rmargin;
1508: }
1509:
1.1 kristaps 1510: p->flags |= TERMP_NOSPACE;
1511: term_word(p, "(");
1.132 schwarze 1512: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1513:
1.132 schwarze 1514: for (n = n->next; n; n = n->next) {
1515: assert(MDOC_TEXT == n->type);
1.65 schwarze 1516: term_fontpush(p, TERMFONT_UNDER);
1.157 schwarze 1517: if (pretty)
1518: p->flags |= TERMP_NBRWORD;
1.132 schwarze 1519: term_word(p, n->string);
1.65 schwarze 1520: term_fontpop(p);
1521:
1.132 schwarze 1522: if (n->next) {
1523: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1524: term_word(p, ",");
1.132 schwarze 1525: }
1.1 kristaps 1526: }
1527:
1.132 schwarze 1528: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1529: term_word(p, ")");
1530:
1.132 schwarze 1531: if (pretty) {
1532: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1533: term_word(p, ";");
1.153 schwarze 1534: term_flushln(p);
1.132 schwarze 1535: }
1.1 kristaps 1536:
1537: return(0);
1538: }
1539:
1540: static int
1541: termp_fa_pre(DECL_ARGS)
1542: {
1.60 schwarze 1543: const struct mdoc_node *nn;
1.1 kristaps 1544:
1.60 schwarze 1545: if (n->parent->tok != MDOC_Fo) {
1.65 schwarze 1546: term_fontpush(p, TERMFONT_UNDER);
1.1 kristaps 1547: return(1);
1548: }
1549:
1.60 schwarze 1550: for (nn = n->child; nn; nn = nn->next) {
1.65 schwarze 1551: term_fontpush(p, TERMFONT_UNDER);
1.160 schwarze 1552: p->flags |= TERMP_NBRWORD;
1.60 schwarze 1553: term_word(p, nn->string);
1.65 schwarze 1554: term_fontpop(p);
1555:
1.158 schwarze 1556: if (nn->next || (n->next && n->next->tok == MDOC_Fa)) {
1.132 schwarze 1557: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1558: term_word(p, ",");
1.132 schwarze 1559: }
1.1 kristaps 1560: }
1561:
1562: return(0);
1563: }
1564:
1565: static int
1566: termp_bd_pre(DECL_ARGS)
1567: {
1.174 schwarze 1568: size_t tabwidth, lm, len, rm, rmax;
1.146 schwarze 1569: struct mdoc_node *nn;
1.1 kristaps 1570:
1.60 schwarze 1571: if (MDOC_BLOCK == n->type) {
1.61 schwarze 1572: print_bvspace(p, n, n);
1.45 schwarze 1573: return(1);
1.73 schwarze 1574: } else if (MDOC_HEAD == n->type)
1575: return(0);
1.1 kristaps 1576:
1.121 schwarze 1577: if (n->norm->Bd.offs)
1578: p->offset += a2offs(p, n->norm->Bd.offs);
1.60 schwarze 1579:
1580: /*
1581: * If -ragged or -filled are specified, the block does nothing
1582: * but change the indentation. If -unfilled or -literal are
1583: * specified, text is printed exactly as entered in the display:
1584: * for macro lines, a newline is appended to the line. Blank
1585: * lines are allowed.
1586: */
1.166 schwarze 1587:
1588: if (DISP_literal != n->norm->Bd.type &&
1.174 schwarze 1589: DISP_unfilled != n->norm->Bd.type &&
1590: DISP_centered != n->norm->Bd.type)
1.1 kristaps 1591: return(1);
1592:
1.75 schwarze 1593: tabwidth = p->tabwidth;
1.123 schwarze 1594: if (DISP_literal == n->norm->Bd.type)
1595: p->tabwidth = term_len(p, 8);
1596:
1.174 schwarze 1597: lm = p->offset;
1.77 schwarze 1598: rm = p->rmargin;
1599: rmax = p->maxrmargin;
1600: p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1601:
1.60 schwarze 1602: for (nn = n->child; nn; nn = nn->next) {
1.174 schwarze 1603: if (DISP_centered == n->norm->Bd.type) {
1604: if (MDOC_TEXT == nn->type) {
1605: len = term_strlen(p, nn->string);
1606: p->offset = len >= rm ? 0 :
1607: lm + len >= rm ? rm - len :
1608: (lm + rm - len) / 2;
1609: } else
1610: p->offset = lm;
1611: }
1.147 schwarze 1612: print_mdoc_node(p, pair, meta, nn);
1.108 schwarze 1613: /*
1614: * If the printed node flushes its own line, then we
1615: * needn't do it here as well. This is hacky, but the
1616: * notion of selective eoln whitespace is pretty dumb
1617: * anyway, so don't sweat it.
1618: */
1619: switch (nn->tok) {
1.166 schwarze 1620: case MDOC_Sm:
1.112 schwarze 1621: /* FALLTHROUGH */
1.166 schwarze 1622: case MDOC_br:
1.108 schwarze 1623: /* FALLTHROUGH */
1.166 schwarze 1624: case MDOC_sp:
1.108 schwarze 1625: /* FALLTHROUGH */
1.166 schwarze 1626: case MDOC_Bl:
1.115 schwarze 1627: /* FALLTHROUGH */
1.166 schwarze 1628: case MDOC_D1:
1.115 schwarze 1629: /* FALLTHROUGH */
1.166 schwarze 1630: case MDOC_Dl:
1.108 schwarze 1631: /* FALLTHROUGH */
1.166 schwarze 1632: case MDOC_Lp:
1.108 schwarze 1633: /* FALLTHROUGH */
1.166 schwarze 1634: case MDOC_Pp:
1.108 schwarze 1635: continue;
1636: default:
1637: break;
1638: }
1.100 schwarze 1639: if (nn->next && nn->next->line == nn->line)
1640: continue;
1641: term_flushln(p);
1.48 schwarze 1642: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1643: }
1.88 schwarze 1644:
1.75 schwarze 1645: p->tabwidth = tabwidth;
1.77 schwarze 1646: p->rmargin = rm;
1647: p->maxrmargin = rmax;
1.1 kristaps 1648: return(0);
1649: }
1650:
1651: static void
1652: termp_bd_post(DECL_ARGS)
1653: {
1.77 schwarze 1654: size_t rm, rmax;
1.1 kristaps 1655:
1.166 schwarze 1656: if (MDOC_BODY != n->type)
1.1 kristaps 1657: return;
1.77 schwarze 1658:
1659: rm = p->rmargin;
1660: rmax = p->maxrmargin;
1661:
1.166 schwarze 1662: if (DISP_literal == n->norm->Bd.type ||
1663: DISP_unfilled == n->norm->Bd.type)
1.77 schwarze 1664: p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1665:
1.48 schwarze 1666: p->flags |= TERMP_NOSPACE;
1.75 schwarze 1667: term_newln(p);
1.77 schwarze 1668:
1669: p->rmargin = rm;
1670: p->maxrmargin = rmax;
1.1 kristaps 1671: }
1672:
1.126 schwarze 1673: static int
1674: termp_bx_pre(DECL_ARGS)
1.1 kristaps 1675: {
1676:
1.126 schwarze 1677: if (NULL != (n = n->child)) {
1678: term_word(p, n->string);
1679: p->flags |= TERMP_NOSPACE;
1680: term_word(p, "BSD");
1681: } else {
1682: term_word(p, "BSD");
1683: return(0);
1684: }
1685:
1686: if (NULL != (n = n->next)) {
1687: p->flags |= TERMP_NOSPACE;
1688: term_word(p, "-");
1.1 kristaps 1689: p->flags |= TERMP_NOSPACE;
1.126 schwarze 1690: term_word(p, n->string);
1691: }
1692:
1693: return(0);
1.1 kristaps 1694: }
1695:
1696: static int
1.26 schwarze 1697: termp_xx_pre(DECL_ARGS)
1.1 kristaps 1698: {
1.26 schwarze 1699: const char *pp;
1.129 schwarze 1700: int flags;
1.1 kristaps 1701:
1.26 schwarze 1702: pp = NULL;
1.60 schwarze 1703: switch (n->tok) {
1.166 schwarze 1704: case MDOC_Bsx:
1.113 schwarze 1705: pp = "BSD/OS";
1.26 schwarze 1706: break;
1.166 schwarze 1707: case MDOC_Dx:
1.64 schwarze 1708: pp = "DragonFly";
1.26 schwarze 1709: break;
1.166 schwarze 1710: case MDOC_Fx:
1.26 schwarze 1711: pp = "FreeBSD";
1712: break;
1.166 schwarze 1713: case MDOC_Nx:
1.26 schwarze 1714: pp = "NetBSD";
1715: break;
1.166 schwarze 1716: case MDOC_Ox:
1.26 schwarze 1717: pp = "OpenBSD";
1718: break;
1.166 schwarze 1719: case MDOC_Ux:
1.26 schwarze 1720: pp = "UNIX";
1721: break;
1722: default:
1.148 schwarze 1723: abort();
1724: /* NOTREACHED */
1.26 schwarze 1725: }
1.1 kristaps 1726:
1.26 schwarze 1727: term_word(p, pp);
1.129 schwarze 1728: if (n->child) {
1729: flags = p->flags;
1730: p->flags |= TERMP_KEEP;
1731: term_word(p, n->child->string);
1732: p->flags = flags;
1733: }
1734: return(0);
1.1 kristaps 1735: }
1736:
1737: static void
1738: termp_pf_post(DECL_ARGS)
1739: {
1740:
1741: p->flags |= TERMP_NOSPACE;
1742: }
1743:
1744: static int
1745: termp_ss_pre(DECL_ARGS)
1746: {
1747:
1.60 schwarze 1748: switch (n->type) {
1.166 schwarze 1749: case MDOC_BLOCK:
1.1 kristaps 1750: term_newln(p);
1.60 schwarze 1751: if (n->prev)
1.1 kristaps 1752: term_vspace(p);
1753: break;
1.166 schwarze 1754: case MDOC_HEAD:
1.65 schwarze 1755: term_fontpush(p, TERMFONT_BOLD);
1.140 schwarze 1756: p->offset = term_len(p, (p->defindent+1)/2);
1.1 kristaps 1757: break;
1.176 schwarze 1758: case MDOC_BODY:
1759: p->offset = term_len(p, p->defindent);
1760: break;
1.1 kristaps 1761: default:
1762: break;
1763: }
1764:
1765: return(1);
1766: }
1767:
1768: static void
1769: termp_ss_post(DECL_ARGS)
1770: {
1771:
1.176 schwarze 1772: if (n->type == MDOC_HEAD || n->type == MDOC_BODY)
1.1 kristaps 1773: term_newln(p);
1774: }
1775:
1776: static int
1777: termp_cd_pre(DECL_ARGS)
1778: {
1779:
1.86 schwarze 1780: synopsis_pre(p, n);
1.65 schwarze 1781: term_fontpush(p, TERMFONT_BOLD);
1.1 kristaps 1782: return(1);
1783: }
1784:
1785: static int
1786: termp_in_pre(DECL_ARGS)
1787: {
1788:
1.86 schwarze 1789: synopsis_pre(p, n);
1.85 schwarze 1790:
1.92 schwarze 1791: if (MDOC_SYNPRETTY & n->flags && MDOC_LINE & n->flags) {
1.85 schwarze 1792: term_fontpush(p, TERMFONT_BOLD);
1.23 schwarze 1793: term_word(p, "#include");
1.85 schwarze 1794: term_word(p, "<");
1795: } else {
1796: term_word(p, "<");
1797: term_fontpush(p, TERMFONT_UNDER);
1798: }
1.23 schwarze 1799:
1.1 kristaps 1800: p->flags |= TERMP_NOSPACE;
1801: return(1);
1802: }
1803:
1804: static void
1805: termp_in_post(DECL_ARGS)
1806: {
1807:
1.92 schwarze 1808: if (MDOC_SYNPRETTY & n->flags)
1.85 schwarze 1809: term_fontpush(p, TERMFONT_BOLD);
1810:
1.59 schwarze 1811: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1812: term_word(p, ">");
1813:
1.92 schwarze 1814: if (MDOC_SYNPRETTY & n->flags)
1.85 schwarze 1815: term_fontpop(p);
1.38 schwarze 1816: }
1817:
1818: static int
1819: termp_sp_pre(DECL_ARGS)
1820: {
1.61 schwarze 1821: size_t i, len;
1.38 schwarze 1822:
1.60 schwarze 1823: switch (n->tok) {
1.166 schwarze 1824: case MDOC_sp:
1.89 schwarze 1825: len = n->child ? a2height(p, n->child->string) : 1;
1.54 schwarze 1826: break;
1.166 schwarze 1827: case MDOC_br:
1.54 schwarze 1828: len = 0;
1829: break;
1830: default:
1831: len = 1;
1832: break;
1.38 schwarze 1833: }
1834:
1835: if (0 == len)
1836: term_newln(p);
1837: for (i = 0; i < len; i++)
1838: term_vspace(p);
1839:
1840: return(0);
1841: }
1842:
1843: static int
1.170 schwarze 1844: termp_es_pre(DECL_ARGS)
1845: {
1846:
1847: return(0);
1848: }
1849:
1850: static int
1.107 schwarze 1851: termp_quote_pre(DECL_ARGS)
1.1 kristaps 1852: {
1853:
1.120 schwarze 1854: if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1.1 kristaps 1855: return(1);
1856:
1.107 schwarze 1857: switch (n->tok) {
1.166 schwarze 1858: case MDOC_Ao:
1.107 schwarze 1859: /* FALLTHROUGH */
1.166 schwarze 1860: case MDOC_Aq:
1.107 schwarze 1861: term_word(p, "<");
1862: break;
1.166 schwarze 1863: case MDOC_Bro:
1.107 schwarze 1864: /* FALLTHROUGH */
1.166 schwarze 1865: case MDOC_Brq:
1.107 schwarze 1866: term_word(p, "{");
1867: break;
1.166 schwarze 1868: case MDOC_Oo:
1.107 schwarze 1869: /* FALLTHROUGH */
1.166 schwarze 1870: case MDOC_Op:
1.107 schwarze 1871: /* FALLTHROUGH */
1.166 schwarze 1872: case MDOC_Bo:
1.107 schwarze 1873: /* FALLTHROUGH */
1.166 schwarze 1874: case MDOC_Bq:
1.107 schwarze 1875: term_word(p, "[");
1876: break;
1.166 schwarze 1877: case MDOC_Do:
1.107 schwarze 1878: /* FALLTHROUGH */
1.166 schwarze 1879: case MDOC_Dq:
1.151 schwarze 1880: term_word(p, "\\(lq");
1.107 schwarze 1881: break;
1.170 schwarze 1882: case MDOC_En:
1883: if (NULL == n->norm->Es ||
1884: NULL == n->norm->Es->child)
1885: return(1);
1886: term_word(p, n->norm->Es->child->string);
1887: break;
1.166 schwarze 1888: case MDOC_Eo:
1.139 schwarze 1889: break;
1.166 schwarze 1890: case MDOC_Po:
1.107 schwarze 1891: /* FALLTHROUGH */
1.166 schwarze 1892: case MDOC_Pq:
1.107 schwarze 1893: term_word(p, "(");
1894: break;
1.166 schwarze 1895: case MDOC__T:
1.120 schwarze 1896: /* FALLTHROUGH */
1.166 schwarze 1897: case MDOC_Qo:
1.107 schwarze 1898: /* FALLTHROUGH */
1.166 schwarze 1899: case MDOC_Qq:
1.107 schwarze 1900: term_word(p, "\"");
1901: break;
1.166 schwarze 1902: case MDOC_Ql:
1.107 schwarze 1903: /* FALLTHROUGH */
1.166 schwarze 1904: case MDOC_So:
1.107 schwarze 1905: /* FALLTHROUGH */
1.166 schwarze 1906: case MDOC_Sq:
1.151 schwarze 1907: term_word(p, "\\(oq");
1.107 schwarze 1908: break;
1909: default:
1910: abort();
1911: /* NOTREACHED */
1912: }
1.1 kristaps 1913:
1914: p->flags |= TERMP_NOSPACE;
1915: return(1);
1916: }
1917:
1918: static void
1.107 schwarze 1919: termp_quote_post(DECL_ARGS)
1.1 kristaps 1920: {
1921:
1.120 schwarze 1922: if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1.1 kristaps 1923: return;
1924:
1.170 schwarze 1925: if (MDOC_En != n->tok)
1926: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1927:
1.107 schwarze 1928: switch (n->tok) {
1.166 schwarze 1929: case MDOC_Ao:
1.107 schwarze 1930: /* FALLTHROUGH */
1.166 schwarze 1931: case MDOC_Aq:
1.107 schwarze 1932: term_word(p, ">");
1933: break;
1.166 schwarze 1934: case MDOC_Bro:
1.107 schwarze 1935: /* FALLTHROUGH */
1.166 schwarze 1936: case MDOC_Brq:
1.107 schwarze 1937: term_word(p, "}");
1938: break;
1.166 schwarze 1939: case MDOC_Oo:
1.107 schwarze 1940: /* FALLTHROUGH */
1.166 schwarze 1941: case MDOC_Op:
1.107 schwarze 1942: /* FALLTHROUGH */
1.166 schwarze 1943: case MDOC_Bo:
1.107 schwarze 1944: /* FALLTHROUGH */
1.166 schwarze 1945: case MDOC_Bq:
1.107 schwarze 1946: term_word(p, "]");
1947: break;
1.166 schwarze 1948: case MDOC_Do:
1.107 schwarze 1949: /* FALLTHROUGH */
1.166 schwarze 1950: case MDOC_Dq:
1.151 schwarze 1951: term_word(p, "\\(rq");
1.170 schwarze 1952: break;
1953: case MDOC_En:
1954: if (NULL != n->norm->Es &&
1955: NULL != n->norm->Es->child &&
1956: NULL != n->norm->Es->child->next) {
1957: p->flags |= TERMP_NOSPACE;
1958: term_word(p, n->norm->Es->child->next->string);
1959: }
1.139 schwarze 1960: break;
1.166 schwarze 1961: case MDOC_Eo:
1.107 schwarze 1962: break;
1.166 schwarze 1963: case MDOC_Po:
1.107 schwarze 1964: /* FALLTHROUGH */
1.166 schwarze 1965: case MDOC_Pq:
1.107 schwarze 1966: term_word(p, ")");
1967: break;
1.166 schwarze 1968: case MDOC__T:
1.120 schwarze 1969: /* FALLTHROUGH */
1.166 schwarze 1970: case MDOC_Qo:
1.107 schwarze 1971: /* FALLTHROUGH */
1.166 schwarze 1972: case MDOC_Qq:
1.107 schwarze 1973: term_word(p, "\"");
1974: break;
1.166 schwarze 1975: case MDOC_Ql:
1.107 schwarze 1976: /* FALLTHROUGH */
1.166 schwarze 1977: case MDOC_So:
1.107 schwarze 1978: /* FALLTHROUGH */
1.166 schwarze 1979: case MDOC_Sq:
1.151 schwarze 1980: term_word(p, "\\(cq");
1.107 schwarze 1981: break;
1982: default:
1983: abort();
1984: /* NOTREACHED */
1985: }
1.1 kristaps 1986: }
1987:
1988: static int
1989: termp_fo_pre(DECL_ARGS)
1990: {
1.159 schwarze 1991: size_t rmargin = 0;
1.158 schwarze 1992: int pretty;
1993:
1994: pretty = MDOC_SYNPRETTY & n->flags;
1.1 kristaps 1995:
1.85 schwarze 1996: if (MDOC_BLOCK == n->type) {
1.86 schwarze 1997: synopsis_pre(p, n);
1.85 schwarze 1998: return(1);
1999: } else if (MDOC_BODY == n->type) {
1.158 schwarze 2000: if (pretty) {
2001: rmargin = p->rmargin;
1.159 schwarze 2002: p->rmargin = p->offset + term_len(p, 4);
1.165 schwarze 2003: p->flags |= TERMP_NOBREAK | TERMP_BRIND |
2004: TERMP_HANG;
1.158 schwarze 2005: }
1.31 schwarze 2006: p->flags |= TERMP_NOSPACE;
1.1 kristaps 2007: term_word(p, "(");
1.132 schwarze 2008: p->flags |= TERMP_NOSPACE;
1.158 schwarze 2009: if (pretty) {
2010: term_flushln(p);
1.165 schwarze 2011: p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND |
2012: TERMP_HANG);
1.158 schwarze 2013: p->offset = p->rmargin;
2014: p->rmargin = rmargin;
2015: }
1.1 kristaps 2016: return(1);
1.158 schwarze 2017: }
1.85 schwarze 2018:
1.95 schwarze 2019: if (NULL == n->child)
2020: return(0);
2021:
1.85 schwarze 2022: /* XXX: we drop non-initial arguments as per groff. */
1.1 kristaps 2023:
1.85 schwarze 2024: assert(n->child->string);
1.65 schwarze 2025: term_fontpush(p, TERMFONT_BOLD);
1.85 schwarze 2026: term_word(p, n->child->string);
1.1 kristaps 2027: return(0);
2028: }
2029:
2030: static void
2031: termp_fo_post(DECL_ARGS)
2032: {
2033:
1.166 schwarze 2034: if (MDOC_BODY != n->type)
1.86 schwarze 2035: return;
2036:
1.132 schwarze 2037: p->flags |= TERMP_NOSPACE;
1.86 schwarze 2038: term_word(p, ")");
2039:
1.132 schwarze 2040: if (MDOC_SYNPRETTY & n->flags) {
2041: p->flags |= TERMP_NOSPACE;
1.86 schwarze 2042: term_word(p, ";");
1.158 schwarze 2043: term_flushln(p);
1.132 schwarze 2044: }
1.1 kristaps 2045: }
2046:
2047: static int
2048: termp_bf_pre(DECL_ARGS)
2049: {
2050:
1.60 schwarze 2051: if (MDOC_HEAD == n->type)
1.1 kristaps 2052: return(0);
1.146 schwarze 2053: else if (MDOC_BODY != n->type)
1.1 kristaps 2054: return(1);
2055:
1.166 schwarze 2056: if (FONT_Em == n->norm->Bf.font)
1.65 schwarze 2057: term_fontpush(p, TERMFONT_UNDER);
1.166 schwarze 2058: else if (FONT_Sy == n->norm->Bf.font)
1.65 schwarze 2059: term_fontpush(p, TERMFONT_BOLD);
1.166 schwarze 2060: else
1.65 schwarze 2061: term_fontpush(p, TERMFONT_NONE);
1.1 kristaps 2062:
2063: return(1);
2064: }
2065:
2066: static int
2067: termp_sm_pre(DECL_ARGS)
2068: {
2069:
1.171 schwarze 2070: if (NULL == n->child)
2071: p->flags ^= TERMP_NONOSPACE;
2072: else if (0 == strcmp("on", n->child->string))
1.1 kristaps 2073: p->flags &= ~TERMP_NONOSPACE;
1.171 schwarze 2074: else
1.1 kristaps 2075: p->flags |= TERMP_NONOSPACE;
1.171 schwarze 2076:
2077: if (p->col && ! (TERMP_NONOSPACE & p->flags))
2078: p->flags &= ~TERMP_NOSPACE;
1.1 kristaps 2079:
2080: return(0);
2081: }
2082:
2083: static int
2084: termp_ap_pre(DECL_ARGS)
2085: {
2086:
2087: p->flags |= TERMP_NOSPACE;
1.107 schwarze 2088: term_word(p, "'");
1.1 kristaps 2089: p->flags |= TERMP_NOSPACE;
2090: return(1);
2091: }
2092:
2093: static void
2094: termp____post(DECL_ARGS)
2095: {
1.104 schwarze 2096:
2097: /*
2098: * Handle lists of authors. In general, print each followed by
2099: * a comma. Don't print the comma if there are only two
2100: * authors.
2101: */
2102: if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok)
2103: if (NULL == n->next->next || MDOC__A != n->next->next->tok)
2104: if (NULL == n->prev || MDOC__A != n->prev->tok)
2105: return;
1.1 kristaps 2106:
1.62 schwarze 2107: /* TODO: %U. */
2108:
1.106 schwarze 2109: if (NULL == n->parent || MDOC_Rs != n->parent->tok)
2110: return;
2111:
1.132 schwarze 2112: p->flags |= TERMP_NOSPACE;
1.106 schwarze 2113: if (NULL == n->next) {
2114: term_word(p, ".");
2115: p->flags |= TERMP_SENTENCE;
2116: } else
2117: term_word(p, ",");
1.1 kristaps 2118: }
2119:
2120: static int
1.65 schwarze 2121: termp_li_pre(DECL_ARGS)
2122: {
2123:
2124: term_fontpush(p, TERMFONT_NONE);
2125: return(1);
2126: }
2127:
2128: static int
1.1 kristaps 2129: termp_lk_pre(DECL_ARGS)
2130: {
1.142 schwarze 2131: const struct mdoc_node *link, *descr;
1.1 kristaps 2132:
1.142 schwarze 2133: if (NULL == (link = n->child))
2134: return(0);
1.101 schwarze 2135:
1.142 schwarze 2136: if (NULL != (descr = link->next)) {
2137: term_fontpush(p, TERMFONT_UNDER);
2138: while (NULL != descr) {
2139: term_word(p, descr->string);
2140: descr = descr->next;
2141: }
2142: p->flags |= TERMP_NOSPACE;
2143: term_word(p, ":");
2144: term_fontpop(p);
2145: }
1.1 kristaps 2146:
1.65 schwarze 2147: term_fontpush(p, TERMFONT_BOLD);
1.142 schwarze 2148: term_word(p, link->string);
1.65 schwarze 2149: term_fontpop(p);
1.6 schwarze 2150:
1.1 kristaps 2151: return(0);
2152: }
2153:
1.90 schwarze 2154: static int
2155: termp_bk_pre(DECL_ARGS)
2156: {
2157:
1.91 schwarze 2158: switch (n->type) {
1.166 schwarze 2159: case MDOC_BLOCK:
1.95 schwarze 2160: break;
1.166 schwarze 2161: case MDOC_HEAD:
1.91 schwarze 2162: return(0);
1.166 schwarze 2163: case MDOC_BODY:
1.117 schwarze 2164: if (n->parent->args || 0 == n->prev->nchild)
2165: p->flags |= TERMP_PREKEEP;
1.95 schwarze 2166: break;
1.91 schwarze 2167: default:
2168: abort();
1.95 schwarze 2169: /* NOTREACHED */
1.91 schwarze 2170: }
1.95 schwarze 2171:
2172: return(1);
1.90 schwarze 2173: }
2174:
2175: static void
2176: termp_bk_post(DECL_ARGS)
2177: {
2178:
1.155 schwarze 2179: if (MDOC_BODY == n->type)
1.91 schwarze 2180: p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
1.90 schwarze 2181: }
1.120 schwarze 2182:
2183: static void
2184: termp__t_post(DECL_ARGS)
2185: {
2186:
2187: /*
2188: * If we're in an `Rs' and there's a journal present, then quote
2189: * us instead of underlining us (for disambiguation).
2190: */
1.121 schwarze 2191: if (n->parent && MDOC_Rs == n->parent->tok &&
1.166 schwarze 2192: n->parent->norm->Rs.quote_T)
1.147 schwarze 2193: termp_quote_post(p, pair, meta, n);
1.120 schwarze 2194:
1.147 schwarze 2195: termp____post(p, pair, meta, n);
1.120 schwarze 2196: }
2197:
2198: static int
2199: termp__t_pre(DECL_ARGS)
2200: {
2201:
2202: /*
2203: * If we're in an `Rs' and there's a journal present, then quote
2204: * us instead of underlining us (for disambiguation).
2205: */
1.121 schwarze 2206: if (n->parent && MDOC_Rs == n->parent->tok &&
1.166 schwarze 2207: n->parent->norm->Rs.quote_T)
1.147 schwarze 2208: return(termp_quote_pre(p, pair, meta, n));
1.120 schwarze 2209:
2210: term_fontpush(p, TERMFONT_UNDER);
2211: return(1);
1.121 schwarze 2212: }
1.1 kristaps 2213:
2214: static int
1.54 schwarze 2215: termp_under_pre(DECL_ARGS)
1.1 kristaps 2216: {
2217:
1.65 schwarze 2218: term_fontpush(p, TERMFONT_UNDER);
1.1 kristaps 2219: return(1);
2220: }
![[BACK]](/icons/back.gif){kind=icon}
Return to mdoc_term.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc