Annotation of src/usr.bin/mandoc/mdoc_term.c, Revision 1.182
1.182 ! schwarze 1: /* $OpenBSD: mdoc_term.c,v 1.181 2014/09/17 20:17:55 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);
1.182 ! schwarze 542: if ( ! a2roffsu(v, &su, SCALE_MAX)) {
1.89 schwarze 543: SCALE_HS_INIT(&su, term_strlen(p, v));
1.182 ! schwarze 544: su.scale /= term_strlen(p, "0");
! 545: }
1.1 kristaps 546:
1.89 schwarze 547: return(term_hspan(p, &su));
1.1 kristaps 548: }
549:
550: static size_t
1.89 schwarze 551: a2offs(const struct termp *p, const char *v)
1.1 kristaps 552: {
1.61 schwarze 553: struct roffsu su;
1.1 kristaps 554:
1.88 schwarze 555: if ('\0' == *v)
1.61 schwarze 556: return(0);
1.88 schwarze 557: else if (0 == strcmp(v, "left"))
1.9 schwarze 558: return(0);
1.88 schwarze 559: else if (0 == strcmp(v, "indent"))
1.140 schwarze 560: return(term_len(p, p->defindent + 1));
1.88 schwarze 561: else if (0 == strcmp(v, "indent-two"))
1.140 schwarze 562: return(term_len(p, (p->defindent + 1) * 2));
1.182 ! schwarze 563: else if ( ! a2roffsu(v, &su, SCALE_MAX)) {
1.89 schwarze 564: SCALE_HS_INIT(&su, term_strlen(p, v));
1.182 ! schwarze 565: su.scale /= term_strlen(p, "0");
! 566: }
1.10 schwarze 567:
1.89 schwarze 568: return(term_hspan(p, &su));
1.1 kristaps 569: }
570:
1.68 schwarze 571: /*
572: * Determine how much space to print out before block elements of `It'
573: * (and thus `Bl') and `Bd'. And then go ahead and print that space,
574: * too.
575: */
1.45 schwarze 576: static void
1.166 schwarze 577: print_bvspace(struct termp *p,
578: const struct mdoc_node *bl,
579: const struct mdoc_node *n)
1.1 kristaps 580: {
1.60 schwarze 581: const struct mdoc_node *nn;
1.138 schwarze 582:
583: assert(n);
1.1 kristaps 584:
585: term_newln(p);
1.88 schwarze 586:
1.121 schwarze 587: if (MDOC_Bd == bl->tok && bl->norm->Bd.comp)
1.88 schwarze 588: return;
1.121 schwarze 589: if (MDOC_Bl == bl->tok && bl->norm->Bl.comp)
1.45 schwarze 590: return;
591:
1.60 schwarze 592: /* Do not vspace directly after Ss/Sh. */
1.1 kristaps 593:
1.60 schwarze 594: for (nn = n; nn; nn = nn->parent) {
595: if (MDOC_BLOCK != nn->type)
1.1 kristaps 596: continue;
1.60 schwarze 597: if (MDOC_Ss == nn->tok)
1.45 schwarze 598: return;
1.60 schwarze 599: if (MDOC_Sh == nn->tok)
1.45 schwarze 600: return;
1.60 schwarze 601: if (NULL == nn->prev)
1.1 kristaps 602: continue;
603: break;
604: }
605:
1.60 schwarze 606: /* A `-column' does not assert vspace within the list. */
1.45 schwarze 607:
1.121 schwarze 608: if (MDOC_Bl == bl->tok && LIST_column == bl->norm->Bl.type)
1.60 schwarze 609: if (n->prev && MDOC_It == n->prev->tok)
1.45 schwarze 610: return;
611:
1.60 schwarze 612: /* A `-diag' without body does not vspace. */
613:
1.121 schwarze 614: if (MDOC_Bl == bl->tok && LIST_diag == bl->norm->Bl.type)
1.60 schwarze 615: if (n->prev && MDOC_It == n->prev->tok) {
616: assert(n->prev->body);
617: if (NULL == n->prev->body->child)
1.45 schwarze 618: return;
619: }
620:
621: term_vspace(p);
1.162 schwarze 622: }
623:
624:
625: static int
626: termp_ll_pre(DECL_ARGS)
627: {
628:
1.163 schwarze 629: term_setwidth(p, n->nchild ? n->child->string : NULL);
1.162 schwarze 630: return(0);
1.1 kristaps 631: }
632:
633: static int
634: termp_it_pre(DECL_ARGS)
635: {
1.60 schwarze 636: const struct mdoc_node *bl, *nn;
1.167 schwarze 637: char buf[24];
1.166 schwarze 638: int i;
639: size_t width, offset, ncols, dcol;
1.82 schwarze 640: enum mdoc_list type;
1.1 kristaps 641:
1.60 schwarze 642: if (MDOC_BLOCK == n->type) {
1.61 schwarze 643: print_bvspace(p, n->parent->parent, n);
1.45 schwarze 644: return(1);
645: }
1.1 kristaps 646:
1.60 schwarze 647: bl = n->parent->parent->parent;
1.121 schwarze 648: type = bl->norm->Bl.type;
1.1 kristaps 649:
1.166 schwarze 650: /*
1.68 schwarze 651: * First calculate width and offset. This is pretty easy unless
652: * we're a -column list, in which case all prior columns must
653: * be accounted for.
654: */
655:
656: width = offset = 0;
657:
1.121 schwarze 658: if (bl->norm->Bl.offs)
659: offset = a2offs(p, bl->norm->Bl.offs);
1.66 schwarze 660:
1.1 kristaps 661: switch (type) {
1.166 schwarze 662: case LIST_column:
1.85 schwarze 663: if (MDOC_HEAD == n->type)
1.1 kristaps 664: break;
1.88 schwarze 665:
1.66 schwarze 666: /*
1.68 schwarze 667: * Imitate groff's column handling:
668: * - For each earlier column, add its width.
669: * - For less than 5 columns, add four more blanks per
670: * column.
671: * - For exactly 5 columns, add three more blank per
672: * column.
673: * - For more than 5 columns, add only one column.
1.66 schwarze 674: */
1.121 schwarze 675: ncols = bl->norm->Bl.ncols;
1.166 schwarze 676: dcol = ncols < 5 ? term_len(p, 4) :
677: ncols == 5 ? term_len(p, 3) : term_len(p, 1);
1.68 schwarze 678:
1.85 schwarze 679: /*
680: * Calculate the offset by applying all prior MDOC_BODY,
681: * so we stop at the MDOC_HEAD (NULL == nn->prev).
682: */
683:
1.166 schwarze 684: for (i = 0, nn = n->prev;
685: nn->prev && i < (int)ncols;
686: nn = nn->prev, i++)
687: offset += dcol + a2width(p,
688: bl->norm->Bl.cols[i]);
1.66 schwarze 689:
690: /*
1.68 schwarze 691: * When exceeding the declared number of columns, leave
692: * the remaining widths at 0. This will later be
693: * adjusted to the default width of 10, or, for the last
694: * column, stretched to the right margin.
1.46 schwarze 695: */
1.68 schwarze 696: if (i >= (int)ncols)
697: break;
1.46 schwarze 698:
1.66 schwarze 699: /*
1.68 schwarze 700: * Use the declared column widths, extended as explained
701: * in the preceding paragraph.
1.66 schwarze 702: */
1.121 schwarze 703: width = a2width(p, bl->norm->Bl.cols[i]) + dcol;
1.1 kristaps 704: break;
705: default:
1.121 schwarze 706: if (NULL == bl->norm->Bl.width)
1.68 schwarze 707: break;
708:
1.166 schwarze 709: /*
1.68 schwarze 710: * Note: buffer the width by 2, which is groff's magic
711: * number for buffering single arguments. See the above
712: * handling for column for how this changes.
713: */
1.121 schwarze 714: assert(bl->norm->Bl.width);
715: width = a2width(p, bl->norm->Bl.width) + term_len(p, 2);
1.1 kristaps 716: break;
717: }
718:
1.166 schwarze 719: /*
1.1 kristaps 720: * List-type can override the width in the case of fixed-head
721: * values (bullet, dash/hyphen, enum). Tags need a non-zero
1.53 schwarze 722: * offset.
1.1 kristaps 723: */
724:
725: switch (type) {
1.166 schwarze 726: case LIST_bullet:
1.1 kristaps 727: /* FALLTHROUGH */
1.166 schwarze 728: case LIST_dash:
1.1 kristaps 729: /* FALLTHROUGH */
1.166 schwarze 730: case LIST_hyphen:
1.144 schwarze 731: /* FALLTHROUGH */
1.166 schwarze 732: case LIST_enum:
1.144 schwarze 733: if (width < term_len(p, 2))
734: width = term_len(p, 2);
1.1 kristaps 735: break;
1.166 schwarze 736: case LIST_hang:
1.33 schwarze 737: if (0 == width)
1.89 schwarze 738: width = term_len(p, 8);
1.33 schwarze 739: break;
1.166 schwarze 740: case LIST_column:
1.41 schwarze 741: /* FALLTHROUGH */
1.166 schwarze 742: case LIST_tag:
1.1 kristaps 743: if (0 == width)
1.89 schwarze 744: width = term_len(p, 10);
1.1 kristaps 745: break;
746: default:
747: break;
748: }
749:
1.166 schwarze 750: /*
1.16 schwarze 751: * Whitespace control. Inset bodies need an initial space,
752: * while diagonal bodies need two.
1.1 kristaps 753: */
754:
1.42 schwarze 755: p->flags |= TERMP_NOSPACE;
756:
1.1 kristaps 757: switch (type) {
1.166 schwarze 758: case LIST_diag:
1.60 schwarze 759: if (MDOC_BODY == n->type)
1.48 schwarze 760: term_word(p, "\\ \\ ");
1.42 schwarze 761: break;
1.166 schwarze 762: case LIST_inset:
1.172 schwarze 763: if (MDOC_BODY == n->type && n->parent->head->nchild)
1.42 schwarze 764: term_word(p, "\\ ");
1.1 kristaps 765: break;
766: default:
767: break;
768: }
769:
1.42 schwarze 770: p->flags |= TERMP_NOSPACE;
771:
1.1 kristaps 772: switch (type) {
1.166 schwarze 773: case LIST_diag:
1.60 schwarze 774: if (MDOC_HEAD == n->type)
1.65 schwarze 775: term_fontpush(p, TERMFONT_BOLD);
1.1 kristaps 776: break;
777: default:
778: break;
779: }
780:
781: /*
1.68 schwarze 782: * Pad and break control. This is the tricky part. These flags
783: * are documented in term_flushln() in term.c. Note that we're
784: * going to unset all of these flags in termp_it_post() when we
785: * exit.
1.1 kristaps 786: */
787:
788: switch (type) {
1.166 schwarze 789: case LIST_enum:
1.144 schwarze 790: /*
791: * Weird special case.
792: * Very narrow enum lists actually hang.
793: */
794: if (width == term_len(p, 2))
795: p->flags |= TERMP_HANG;
796: /* FALLTHROUGH */
1.166 schwarze 797: case LIST_bullet:
1.1 kristaps 798: /* FALLTHROUGH */
1.166 schwarze 799: case LIST_dash:
1.1 kristaps 800: /* FALLTHROUGH */
1.166 schwarze 801: case LIST_hyphen:
1.152 schwarze 802: if (MDOC_HEAD != n->type)
803: break;
804: p->flags |= TERMP_NOBREAK;
805: p->trailspace = 1;
1.33 schwarze 806: break;
1.166 schwarze 807: case LIST_hang:
1.152 schwarze 808: if (MDOC_HEAD != n->type)
1.47 schwarze 809: break;
810:
811: /*
812: * This is ugly. If `-hang' is specified and the body
813: * is a `Bl' or `Bd', then we want basically to nullify
814: * the "overstep" effect in term_flushln() and treat
815: * this as a `-ohang' list instead.
816: */
1.178 schwarze 817: if (NULL != n->next &&
818: NULL != n->next->child &&
1.166 schwarze 819: (MDOC_Bl == n->next->child->tok ||
820: MDOC_Bd == n->next->child->tok))
1.152 schwarze 821: break;
822:
1.165 schwarze 823: p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG;
1.152 schwarze 824: p->trailspace = 1;
1.33 schwarze 825: break;
1.166 schwarze 826: case LIST_tag:
1.60 schwarze 827: if (MDOC_HEAD != n->type)
1.33 schwarze 828: break;
1.152 schwarze 829:
1.165 schwarze 830: p->flags |= TERMP_NOBREAK | TERMP_BRIND;
1.152 schwarze 831: p->trailspace = 2;
832:
1.60 schwarze 833: if (NULL == n->next || NULL == n->next->child)
1.33 schwarze 834: p->flags |= TERMP_DANGLE;
1.1 kristaps 835: break;
1.166 schwarze 836: case LIST_column:
1.85 schwarze 837: if (MDOC_HEAD == n->type)
838: break;
839:
1.152 schwarze 840: if (NULL == n->next) {
1.85 schwarze 841: p->flags &= ~TERMP_NOBREAK;
1.152 schwarze 842: p->trailspace = 0;
843: } else {
1.85 schwarze 844: p->flags |= TERMP_NOBREAK;
1.152 schwarze 845: p->trailspace = 1;
846: }
1.85 schwarze 847:
1.1 kristaps 848: break;
1.166 schwarze 849: case LIST_diag:
1.152 schwarze 850: if (MDOC_HEAD != n->type)
851: break;
1.165 schwarze 852: p->flags |= TERMP_NOBREAK | TERMP_BRIND;
1.152 schwarze 853: p->trailspace = 1;
1.1 kristaps 854: break;
855: default:
856: break;
857: }
858:
1.166 schwarze 859: /*
1.1 kristaps 860: * Margin control. Set-head-width lists have their right
861: * margins shortened. The body for these lists has the offset
862: * necessarily lengthened. Everybody gets the offset.
863: */
864:
865: p->offset += offset;
866:
867: switch (type) {
1.166 schwarze 868: case LIST_hang:
1.47 schwarze 869: /*
870: * Same stipulation as above, regarding `-hang'. We
871: * don't want to recalculate rmargin and offsets when
872: * using `Bd' or `Bl' within `-hang' overstep lists.
873: */
1.178 schwarze 874: if (MDOC_HEAD == n->type &&
875: NULL != n->next &&
876: NULL != n->next->child &&
1.166 schwarze 877: (MDOC_Bl == n->next->child->tok ||
878: MDOC_Bd == n->next->child->tok))
1.47 schwarze 879: break;
880: /* FALLTHROUGH */
1.166 schwarze 881: case LIST_bullet:
1.1 kristaps 882: /* FALLTHROUGH */
1.166 schwarze 883: case LIST_dash:
1.1 kristaps 884: /* FALLTHROUGH */
1.166 schwarze 885: case LIST_enum:
1.1 kristaps 886: /* FALLTHROUGH */
1.166 schwarze 887: case LIST_hyphen:
1.33 schwarze 888: /* FALLTHROUGH */
1.166 schwarze 889: case LIST_tag:
1.41 schwarze 890: assert(width);
1.60 schwarze 891: if (MDOC_HEAD == n->type)
1.1 kristaps 892: p->rmargin = p->offset + width;
1.161 schwarze 893: else {
1.1 kristaps 894: p->offset += width;
1.161 schwarze 895: if (p->rmargin < p->offset)
896: p->rmargin = p->offset;
897: }
1.1 kristaps 898: break;
1.166 schwarze 899: case LIST_column:
1.41 schwarze 900: assert(width);
1.1 kristaps 901: p->rmargin = p->offset + width;
1.166 schwarze 902: /*
1.43 schwarze 903: * XXX - this behaviour is not documented: the
904: * right-most column is filled to the right margin.
905: */
1.85 schwarze 906: if (MDOC_HEAD == n->type)
907: break;
908: if (NULL == n->next && p->rmargin < p->maxrmargin)
1.43 schwarze 909: p->rmargin = p->maxrmargin;
1.1 kristaps 910: break;
911: default:
912: break;
913: }
914:
1.166 schwarze 915: /*
1.1 kristaps 916: * The dash, hyphen, bullet and enum lists all have a special
1.166 schwarze 917: * HEAD character (temporarily bold, in some cases).
1.1 kristaps 918: */
919:
1.60 schwarze 920: if (MDOC_HEAD == n->type)
1.1 kristaps 921: switch (type) {
1.166 schwarze 922: case LIST_bullet:
1.65 schwarze 923: term_fontpush(p, TERMFONT_BOLD);
1.1 kristaps 924: term_word(p, "\\[bu]");
1.65 schwarze 925: term_fontpop(p);
1.1 kristaps 926: break;
1.166 schwarze 927: case LIST_dash:
1.1 kristaps 928: /* FALLTHROUGH */
1.166 schwarze 929: case LIST_hyphen:
1.65 schwarze 930: term_fontpush(p, TERMFONT_BOLD);
1.35 schwarze 931: term_word(p, "\\(hy");
1.65 schwarze 932: term_fontpop(p);
1.1 kristaps 933: break;
1.166 schwarze 934: case LIST_enum:
1.1 kristaps 935: (pair->ppair->ppair->count)++;
1.167 schwarze 936: (void)snprintf(buf, sizeof(buf), "%d.",
1.166 schwarze 937: pair->ppair->ppair->count);
1.1 kristaps 938: term_word(p, buf);
939: break;
940: default:
941: break;
942: }
1.12 schwarze 943:
1.166 schwarze 944: /*
1.1 kristaps 945: * If we're not going to process our children, indicate so here.
946: */
947:
948: switch (type) {
1.166 schwarze 949: case LIST_bullet:
1.1 kristaps 950: /* FALLTHROUGH */
1.166 schwarze 951: case LIST_item:
1.1 kristaps 952: /* FALLTHROUGH */
1.166 schwarze 953: case LIST_dash:
1.1 kristaps 954: /* FALLTHROUGH */
1.166 schwarze 955: case LIST_hyphen:
1.1 kristaps 956: /* FALLTHROUGH */
1.166 schwarze 957: case LIST_enum:
1.60 schwarze 958: if (MDOC_HEAD == n->type)
1.1 kristaps 959: return(0);
960: break;
1.166 schwarze 961: case LIST_column:
1.85 schwarze 962: if (MDOC_HEAD == n->type)
1.1 kristaps 963: return(0);
964: break;
965: default:
966: break;
967: }
968:
969: return(1);
970: }
971:
972: static void
973: termp_it_post(DECL_ARGS)
974: {
1.82 schwarze 975: enum mdoc_list type;
1.1 kristaps 976:
1.68 schwarze 977: if (MDOC_BLOCK == n->type)
1.1 kristaps 978: return;
979:
1.121 schwarze 980: type = n->parent->parent->parent->norm->Bl.type;
1.1 kristaps 981:
982: switch (type) {
1.166 schwarze 983: case LIST_item:
1.44 schwarze 984: /* FALLTHROUGH */
1.166 schwarze 985: case LIST_diag:
1.1 kristaps 986: /* FALLTHROUGH */
1.166 schwarze 987: case LIST_inset:
1.60 schwarze 988: if (MDOC_BODY == n->type)
1.74 schwarze 989: term_newln(p);
1.1 kristaps 990: break;
1.166 schwarze 991: case LIST_column:
1.85 schwarze 992: if (MDOC_BODY == n->type)
1.1 kristaps 993: term_flushln(p);
994: break;
995: default:
1.74 schwarze 996: term_newln(p);
1.1 kristaps 997: break;
998: }
999:
1.166 schwarze 1000: /*
1.68 schwarze 1001: * Now that our output is flushed, we can reset our tags. Since
1002: * only `It' sets these flags, we're free to assume that nobody
1003: * has munged them in the meanwhile.
1004: */
1005:
1.165 schwarze 1006: p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND |
1007: TERMP_DANGLE | TERMP_HANG);
1.152 schwarze 1008: p->trailspace = 0;
1.1 kristaps 1009: }
1010:
1011: static int
1012: termp_nm_pre(DECL_ARGS)
1013: {
1014:
1.155 schwarze 1015: if (MDOC_BLOCK == n->type) {
1016: p->flags |= TERMP_PREKEEP;
1.94 schwarze 1017: return(1);
1.155 schwarze 1018: }
1.94 schwarze 1019:
1020: if (MDOC_BODY == n->type) {
1021: if (NULL == n->child)
1022: return(0);
1.136 schwarze 1023: p->flags |= TERMP_NOSPACE;
1.94 schwarze 1024: p->offset += term_len(p, 1) +
1.147 schwarze 1025: (NULL == n->prev->child ?
1026: term_strlen(p, meta->name) :
1.94 schwarze 1027: MDOC_TEXT == n->prev->child->type ?
1.147 schwarze 1028: term_strlen(p, n->prev->child->string) :
1.94 schwarze 1029: term_len(p, 5));
1.164 schwarze 1030: if (p->rmargin < p->offset)
1031: p->rmargin = p->offset;
1.94 schwarze 1032: return(1);
1033: }
1034:
1.147 schwarze 1035: if (NULL == n->child && NULL == meta->name)
1.94 schwarze 1036: return(0);
1.81 schwarze 1037:
1.97 schwarze 1038: if (MDOC_HEAD == n->type)
1039: synopsis_pre(p, n->parent);
1.65 schwarze 1040:
1.178 schwarze 1041: if (MDOC_HEAD == n->type &&
1042: NULL != n->next && NULL != n->next->child) {
1.165 schwarze 1043: p->flags |= TERMP_NOSPACE | TERMP_NOBREAK | TERMP_BRIND;
1.152 schwarze 1044: p->trailspace = 1;
1.105 schwarze 1045: p->rmargin = p->offset + term_len(p, 1);
1046: if (NULL == n->child) {
1.147 schwarze 1047: p->rmargin += term_strlen(p, meta->name);
1.105 schwarze 1048: } else if (MDOC_TEXT == n->child->type) {
1049: p->rmargin += term_strlen(p, n->child->string);
1050: if (n->child->next)
1051: p->flags |= TERMP_HANG;
1052: } else {
1053: p->rmargin += term_len(p, 5);
1054: p->flags |= TERMP_HANG;
1055: }
1.94 schwarze 1056: }
1057:
1.65 schwarze 1058: term_fontpush(p, TERMFONT_BOLD);
1.60 schwarze 1059: if (NULL == n->child)
1.147 schwarze 1060: term_word(p, meta->name);
1.1 kristaps 1061: return(1);
1062: }
1063:
1.94 schwarze 1064: static void
1065: termp_nm_post(DECL_ARGS)
1066: {
1067:
1.155 schwarze 1068: if (MDOC_BLOCK == n->type) {
1069: p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
1.178 schwarze 1070: } else if (MDOC_HEAD == n->type &&
1071: NULL != n->next && NULL != n->next->child) {
1.94 schwarze 1072: term_flushln(p);
1.165 schwarze 1073: p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
1.152 schwarze 1074: p->trailspace = 0;
1.136 schwarze 1075: } else if (MDOC_BODY == n->type && n->child)
1.94 schwarze 1076: term_flushln(p);
1077: }
1078:
1.1 kristaps 1079: static int
1080: termp_fl_pre(DECL_ARGS)
1081: {
1082:
1.65 schwarze 1083: term_fontpush(p, TERMFONT_BOLD);
1.1 kristaps 1084: term_word(p, "\\-");
1.67 schwarze 1085:
1.179 schwarze 1086: if ( ! (n->nchild == 0 &&
1087: (n->next == NULL ||
1088: n->next->type == MDOC_TEXT ||
1089: n->next->flags & MDOC_LINE)))
1.73 schwarze 1090: p->flags |= TERMP_NOSPACE;
1.67 schwarze 1091:
1.1 kristaps 1092: return(1);
1.49 schwarze 1093: }
1094:
1095: static int
1.104 schwarze 1096: termp__a_pre(DECL_ARGS)
1097: {
1098:
1099: if (n->prev && MDOC__A == n->prev->tok)
1100: if (NULL == n->next || MDOC__A != n->next->tok)
1101: term_word(p, "and");
1102:
1103: return(1);
1104: }
1105:
1106: static int
1.49 schwarze 1107: termp_an_pre(DECL_ARGS)
1108: {
1109:
1.181 schwarze 1110: if (n->norm->An.auth == AUTH_split) {
1111: p->flags &= ~TERMP_NOSPLIT;
1112: p->flags |= TERMP_SPLIT;
1113: return(0);
1114: }
1115: if (n->norm->An.auth == AUTH_nosplit) {
1116: p->flags &= ~TERMP_SPLIT;
1117: p->flags |= TERMP_NOSPLIT;
1118: return(0);
1119: }
1.49 schwarze 1120:
1.181 schwarze 1121: if (n->child == NULL)
1122: return(0);
1.166 schwarze 1123:
1.181 schwarze 1124: if (p->flags & TERMP_SPLIT)
1.49 schwarze 1125: term_newln(p);
1126:
1.181 schwarze 1127: if (n->sec == SEC_AUTHORS && ! (p->flags & TERMP_NOSPLIT))
1128: p->flags |= TERMP_SPLIT;
1.49 schwarze 1129:
1130: return(1);
1.1 kristaps 1131: }
1132:
1133: static int
1134: termp_ns_pre(DECL_ARGS)
1135: {
1136:
1.127 schwarze 1137: if ( ! (MDOC_LINE & n->flags))
1138: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1139: return(1);
1140: }
1141:
1142: static int
1143: termp_rs_pre(DECL_ARGS)
1144: {
1145:
1.60 schwarze 1146: if (SEC_SEE_ALSO != n->sec)
1.57 schwarze 1147: return(1);
1.60 schwarze 1148: if (MDOC_BLOCK == n->type && n->prev)
1.1 kristaps 1149: term_vspace(p);
1150: return(1);
1151: }
1152:
1153: static int
1154: termp_rv_pre(DECL_ARGS)
1155: {
1.132 schwarze 1156: int nchild;
1.1 kristaps 1157:
1158: term_newln(p);
1159:
1.132 schwarze 1160: nchild = n->nchild;
1.175 schwarze 1161: if (nchild > 0) {
1162: term_word(p, "The");
1.132 schwarze 1163:
1.175 schwarze 1164: for (n = n->child; n; n = n->next) {
1165: term_fontpush(p, TERMFONT_BOLD);
1166: term_word(p, n->string);
1167: term_fontpop(p);
1.132 schwarze 1168:
1169: p->flags |= TERMP_NOSPACE;
1.175 schwarze 1170: term_word(p, "()");
1171:
1172: if (n->next == NULL)
1173: continue;
1174:
1175: if (nchild > 2) {
1176: p->flags |= TERMP_NOSPACE;
1177: term_word(p, ",");
1178: }
1179: if (n->next->next == NULL)
1180: term_word(p, "and");
1.132 schwarze 1181: }
1182:
1.175 schwarze 1183: if (nchild > 1)
1184: term_word(p, "functions return");
1185: else
1186: term_word(p, "function returns");
1187:
1188: term_word(p, "the value\\~0 if successful;");
1189: } else
1190: term_word(p, "Upon successful completion,"
1191: " the value\\~0 is returned;");
1.1 kristaps 1192:
1.175 schwarze 1193: term_word(p, "otherwise the value\\~\\-1 is returned"
1194: " and the global variable");
1.1 kristaps 1195:
1.65 schwarze 1196: term_fontpush(p, TERMFONT_UNDER);
1.1 kristaps 1197: term_word(p, "errno");
1.65 schwarze 1198: term_fontpop(p);
1.1 kristaps 1199:
1.166 schwarze 1200: term_word(p, "is set to indicate the error.");
1.84 schwarze 1201: p->flags |= TERMP_SENTENCE;
1.1 kristaps 1202:
1.53 schwarze 1203: return(0);
1.1 kristaps 1204: }
1205:
1206: static int
1207: termp_ex_pre(DECL_ARGS)
1208: {
1.132 schwarze 1209: int nchild;
1.1 kristaps 1210:
1.132 schwarze 1211: term_newln(p);
1.53 schwarze 1212: term_word(p, "The");
1.1 kristaps 1213:
1.132 schwarze 1214: nchild = n->nchild;
1215: for (n = n->child; n; n = n->next) {
1.65 schwarze 1216: term_fontpush(p, TERMFONT_BOLD);
1.132 schwarze 1217: term_word(p, n->string);
1.65 schwarze 1218: term_fontpop(p);
1.132 schwarze 1219:
1220: if (nchild > 2 && n->next) {
1221: p->flags |= TERMP_NOSPACE;
1.53 schwarze 1222: term_word(p, ",");
1.132 schwarze 1223: }
1224:
1225: if (n->next && NULL == n->next->next)
1226: term_word(p, "and");
1.53 schwarze 1227: }
1228:
1.132 schwarze 1229: if (nchild > 1)
1.175 schwarze 1230: term_word(p, "utilities exit\\~0");
1.53 schwarze 1231: else
1.175 schwarze 1232: term_word(p, "utility exits\\~0");
1.53 schwarze 1233:
1.175 schwarze 1234: term_word(p, "on success, and\\~>0 if an error occurs.");
1.132 schwarze 1235:
1.84 schwarze 1236: p->flags |= TERMP_SENTENCE;
1.53 schwarze 1237: return(0);
1.1 kristaps 1238: }
1239:
1240: static int
1241: termp_nd_pre(DECL_ARGS)
1242: {
1.25 schwarze 1243:
1.60 schwarze 1244: if (MDOC_BODY != n->type)
1.25 schwarze 1245: return(1);
1246:
1247: #if defined(__OpenBSD__) || defined(__linux__)
1248: term_word(p, "\\(en");
1.24 schwarze 1249: #else
1250: term_word(p, "\\(em");
1251: #endif
1.1 kristaps 1252: return(1);
1253: }
1254:
1.73 schwarze 1255: static int
1256: termp_bl_pre(DECL_ARGS)
1257: {
1258:
1259: return(MDOC_HEAD != n->type);
1260: }
1261:
1.1 kristaps 1262: static void
1263: termp_bl_post(DECL_ARGS)
1264: {
1265:
1.60 schwarze 1266: if (MDOC_BLOCK == n->type)
1.1 kristaps 1267: term_newln(p);
1268: }
1269:
1270: static int
1271: termp_xr_pre(DECL_ARGS)
1272: {
1273:
1.132 schwarze 1274: if (NULL == (n = n->child))
1.72 schwarze 1275: return(0);
1276:
1.132 schwarze 1277: assert(MDOC_TEXT == n->type);
1278: term_word(p, n->string);
1.10 schwarze 1279:
1.166 schwarze 1280: if (NULL == (n = n->next))
1.1 kristaps 1281: return(0);
1.132 schwarze 1282:
1.1 kristaps 1283: p->flags |= TERMP_NOSPACE;
1284: term_word(p, "(");
1.132 schwarze 1285: p->flags |= TERMP_NOSPACE;
1286:
1287: assert(MDOC_TEXT == n->type);
1288: term_word(p, n->string);
1289:
1290: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1291: term_word(p, ")");
1.60 schwarze 1292:
1.1 kristaps 1293: return(0);
1294: }
1295:
1.86 schwarze 1296: /*
1297: * This decides how to assert whitespace before any of the SYNOPSIS set
1298: * of macros (which, as in the case of Ft/Fo and Ft/Fn, may contain
1299: * macro combos).
1300: */
1301: static void
1302: synopsis_pre(struct termp *p, const struct mdoc_node *n)
1303: {
1.166 schwarze 1304: /*
1.86 schwarze 1305: * Obviously, if we're not in a SYNOPSIS or no prior macros
1306: * exist, do nothing.
1307: */
1.92 schwarze 1308: if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags))
1.86 schwarze 1309: return;
1310:
1311: /*
1312: * If we're the second in a pair of like elements, emit our
1313: * newline and return. UNLESS we're `Fo', `Fn', `Fn', in which
1314: * case we soldier on.
1315: */
1.166 schwarze 1316: if (n->prev->tok == n->tok &&
1317: MDOC_Ft != n->tok &&
1318: MDOC_Fo != n->tok &&
1319: MDOC_Fn != n->tok) {
1.86 schwarze 1320: term_newln(p);
1321: return;
1322: }
1323:
1324: /*
1325: * If we're one of the SYNOPSIS set and non-like pair-wise after
1326: * another (or Fn/Fo, which we've let slip through) then assert
1327: * vertical space, else only newline and move on.
1328: */
1329: switch (n->prev->tok) {
1.166 schwarze 1330: case MDOC_Fd:
1.86 schwarze 1331: /* FALLTHROUGH */
1.166 schwarze 1332: case MDOC_Fn:
1.86 schwarze 1333: /* FALLTHROUGH */
1.166 schwarze 1334: case MDOC_Fo:
1.86 schwarze 1335: /* FALLTHROUGH */
1.166 schwarze 1336: case MDOC_In:
1.86 schwarze 1337: /* FALLTHROUGH */
1.166 schwarze 1338: case MDOC_Vt:
1.86 schwarze 1339: term_vspace(p);
1340: break;
1.166 schwarze 1341: case MDOC_Ft:
1.86 schwarze 1342: if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
1343: term_vspace(p);
1344: break;
1345: }
1346: /* FALLTHROUGH */
1347: default:
1348: term_newln(p);
1349: break;
1350: }
1351: }
1352:
1.69 schwarze 1353: static int
1354: termp_vt_pre(DECL_ARGS)
1355: {
1356:
1.86 schwarze 1357: if (MDOC_ELEM == n->type) {
1358: synopsis_pre(p, n);
1.147 schwarze 1359: return(termp_under_pre(p, pair, meta, n));
1.86 schwarze 1360: } else if (MDOC_BLOCK == n->type) {
1361: synopsis_pre(p, n);
1362: return(1);
1363: } else if (MDOC_HEAD == n->type)
1.69 schwarze 1364: return(0);
1365:
1.147 schwarze 1366: return(termp_under_pre(p, pair, meta, n));
1.69 schwarze 1367: }
1368:
1.1 kristaps 1369: static int
1.54 schwarze 1370: termp_bold_pre(DECL_ARGS)
1.1 kristaps 1371: {
1372:
1.65 schwarze 1373: term_fontpush(p, TERMFONT_BOLD);
1.1 kristaps 1374: return(1);
1375: }
1376:
1.86 schwarze 1377: static int
1378: termp_fd_pre(DECL_ARGS)
1.1 kristaps 1379: {
1380:
1.86 schwarze 1381: synopsis_pre(p, n);
1.147 schwarze 1382: return(termp_bold_pre(p, pair, meta, n));
1.1 kristaps 1383: }
1384:
1.143 schwarze 1385: static void
1386: termp_fd_post(DECL_ARGS)
1387: {
1388:
1389: term_newln(p);
1390: }
1391:
1.1 kristaps 1392: static int
1393: termp_sh_pre(DECL_ARGS)
1394: {
1.60 schwarze 1395:
1396: /* No vspace between consecutive `Sh' calls. */
1397:
1398: switch (n->type) {
1.166 schwarze 1399: case MDOC_BLOCK:
1.60 schwarze 1400: if (n->prev && MDOC_Sh == n->prev->tok)
1401: if (NULL == n->prev->body->child)
1.52 schwarze 1402: break;
1403: term_vspace(p);
1404: break;
1.166 schwarze 1405: case MDOC_HEAD:
1.65 schwarze 1406: term_fontpush(p, TERMFONT_BOLD);
1.1 kristaps 1407: break;
1.166 schwarze 1408: case MDOC_BODY:
1.140 schwarze 1409: p->offset = term_len(p, p->defindent);
1.141 schwarze 1410: if (SEC_AUTHORS == n->sec)
1411: p->flags &= ~(TERMP_SPLIT|TERMP_NOSPLIT);
1.1 kristaps 1412: break;
1413: default:
1414: break;
1415: }
1416: return(1);
1417: }
1418:
1419: static void
1420: termp_sh_post(DECL_ARGS)
1421: {
1422:
1.60 schwarze 1423: switch (n->type) {
1.166 schwarze 1424: case MDOC_HEAD:
1.1 kristaps 1425: term_newln(p);
1426: break;
1.166 schwarze 1427: case MDOC_BODY:
1.1 kristaps 1428: term_newln(p);
1429: p->offset = 0;
1430: break;
1431: default:
1432: break;
1433: }
1434: }
1435:
1436: static int
1437: termp_bt_pre(DECL_ARGS)
1438: {
1439:
1440: term_word(p, "is currently in beta test.");
1.84 schwarze 1441: p->flags |= TERMP_SENTENCE;
1.59 schwarze 1442: return(0);
1.1 kristaps 1443: }
1444:
1445: static void
1446: termp_lb_post(DECL_ARGS)
1447: {
1448:
1.77 schwarze 1449: if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags)
1.57 schwarze 1450: term_newln(p);
1.1 kristaps 1451: }
1452:
1453: static int
1454: termp_ud_pre(DECL_ARGS)
1455: {
1456:
1457: term_word(p, "currently under development.");
1.84 schwarze 1458: p->flags |= TERMP_SENTENCE;
1.60 schwarze 1459: return(0);
1.1 kristaps 1460: }
1461:
1462: static int
1463: termp_d1_pre(DECL_ARGS)
1464: {
1465:
1.60 schwarze 1466: if (MDOC_BLOCK != n->type)
1.1 kristaps 1467: return(1);
1468: term_newln(p);
1.140 schwarze 1469: p->offset += term_len(p, p->defindent + 1);
1.1 kristaps 1470: return(1);
1471: }
1472:
1473: static int
1474: termp_ft_pre(DECL_ARGS)
1475: {
1476:
1.85 schwarze 1477: /* NB: MDOC_LINE does not effect this! */
1.86 schwarze 1478: synopsis_pre(p, n);
1.65 schwarze 1479: term_fontpush(p, TERMFONT_UNDER);
1.1 kristaps 1480: return(1);
1481: }
1482:
1483: static int
1484: termp_fn_pre(DECL_ARGS)
1485: {
1.159 schwarze 1486: size_t rmargin = 0;
1.132 schwarze 1487: int pretty;
1488:
1489: pretty = MDOC_SYNPRETTY & n->flags;
1.1 kristaps 1490:
1.86 schwarze 1491: synopsis_pre(p, n);
1.85 schwarze 1492:
1.132 schwarze 1493: if (NULL == (n = n->child))
1494: return(0);
1495:
1.153 schwarze 1496: if (pretty) {
1497: rmargin = p->rmargin;
1.159 schwarze 1498: p->rmargin = p->offset + term_len(p, 4);
1.165 schwarze 1499: p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG;
1.153 schwarze 1500: }
1501:
1.132 schwarze 1502: assert(MDOC_TEXT == n->type);
1.65 schwarze 1503: term_fontpush(p, TERMFONT_BOLD);
1.132 schwarze 1504: term_word(p, n->string);
1.65 schwarze 1505: term_fontpop(p);
1.1 kristaps 1506:
1.153 schwarze 1507: if (pretty) {
1508: term_flushln(p);
1.165 schwarze 1509: p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
1.153 schwarze 1510: p->offset = p->rmargin;
1511: p->rmargin = rmargin;
1512: }
1513:
1.1 kristaps 1514: p->flags |= TERMP_NOSPACE;
1515: term_word(p, "(");
1.132 schwarze 1516: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1517:
1.132 schwarze 1518: for (n = n->next; n; n = n->next) {
1519: assert(MDOC_TEXT == n->type);
1.65 schwarze 1520: term_fontpush(p, TERMFONT_UNDER);
1.157 schwarze 1521: if (pretty)
1522: p->flags |= TERMP_NBRWORD;
1.132 schwarze 1523: term_word(p, n->string);
1.65 schwarze 1524: term_fontpop(p);
1525:
1.132 schwarze 1526: if (n->next) {
1527: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1528: term_word(p, ",");
1.132 schwarze 1529: }
1.1 kristaps 1530: }
1531:
1.132 schwarze 1532: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1533: term_word(p, ")");
1534:
1.132 schwarze 1535: if (pretty) {
1536: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1537: term_word(p, ";");
1.153 schwarze 1538: term_flushln(p);
1.132 schwarze 1539: }
1.1 kristaps 1540:
1541: return(0);
1542: }
1543:
1544: static int
1545: termp_fa_pre(DECL_ARGS)
1546: {
1.60 schwarze 1547: const struct mdoc_node *nn;
1.1 kristaps 1548:
1.60 schwarze 1549: if (n->parent->tok != MDOC_Fo) {
1.65 schwarze 1550: term_fontpush(p, TERMFONT_UNDER);
1.1 kristaps 1551: return(1);
1552: }
1553:
1.60 schwarze 1554: for (nn = n->child; nn; nn = nn->next) {
1.65 schwarze 1555: term_fontpush(p, TERMFONT_UNDER);
1.160 schwarze 1556: p->flags |= TERMP_NBRWORD;
1.60 schwarze 1557: term_word(p, nn->string);
1.65 schwarze 1558: term_fontpop(p);
1559:
1.158 schwarze 1560: if (nn->next || (n->next && n->next->tok == MDOC_Fa)) {
1.132 schwarze 1561: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1562: term_word(p, ",");
1.132 schwarze 1563: }
1.1 kristaps 1564: }
1565:
1566: return(0);
1567: }
1568:
1569: static int
1570: termp_bd_pre(DECL_ARGS)
1571: {
1.174 schwarze 1572: size_t tabwidth, lm, len, rm, rmax;
1.146 schwarze 1573: struct mdoc_node *nn;
1.1 kristaps 1574:
1.60 schwarze 1575: if (MDOC_BLOCK == n->type) {
1.61 schwarze 1576: print_bvspace(p, n, n);
1.45 schwarze 1577: return(1);
1.73 schwarze 1578: } else if (MDOC_HEAD == n->type)
1579: return(0);
1.1 kristaps 1580:
1.121 schwarze 1581: if (n->norm->Bd.offs)
1582: p->offset += a2offs(p, n->norm->Bd.offs);
1.60 schwarze 1583:
1584: /*
1585: * If -ragged or -filled are specified, the block does nothing
1586: * but change the indentation. If -unfilled or -literal are
1587: * specified, text is printed exactly as entered in the display:
1588: * for macro lines, a newline is appended to the line. Blank
1589: * lines are allowed.
1590: */
1.166 schwarze 1591:
1592: if (DISP_literal != n->norm->Bd.type &&
1.174 schwarze 1593: DISP_unfilled != n->norm->Bd.type &&
1594: DISP_centered != n->norm->Bd.type)
1.1 kristaps 1595: return(1);
1596:
1.75 schwarze 1597: tabwidth = p->tabwidth;
1.123 schwarze 1598: if (DISP_literal == n->norm->Bd.type)
1599: p->tabwidth = term_len(p, 8);
1600:
1.174 schwarze 1601: lm = p->offset;
1.77 schwarze 1602: rm = p->rmargin;
1603: rmax = p->maxrmargin;
1604: p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1605:
1.60 schwarze 1606: for (nn = n->child; nn; nn = nn->next) {
1.174 schwarze 1607: if (DISP_centered == n->norm->Bd.type) {
1608: if (MDOC_TEXT == nn->type) {
1609: len = term_strlen(p, nn->string);
1610: p->offset = len >= rm ? 0 :
1611: lm + len >= rm ? rm - len :
1612: (lm + rm - len) / 2;
1613: } else
1614: p->offset = lm;
1615: }
1.147 schwarze 1616: print_mdoc_node(p, pair, meta, nn);
1.108 schwarze 1617: /*
1618: * If the printed node flushes its own line, then we
1619: * needn't do it here as well. This is hacky, but the
1620: * notion of selective eoln whitespace is pretty dumb
1621: * anyway, so don't sweat it.
1622: */
1623: switch (nn->tok) {
1.166 schwarze 1624: case MDOC_Sm:
1.112 schwarze 1625: /* FALLTHROUGH */
1.166 schwarze 1626: case MDOC_br:
1.108 schwarze 1627: /* FALLTHROUGH */
1.166 schwarze 1628: case MDOC_sp:
1.108 schwarze 1629: /* FALLTHROUGH */
1.166 schwarze 1630: case MDOC_Bl:
1.115 schwarze 1631: /* FALLTHROUGH */
1.166 schwarze 1632: case MDOC_D1:
1.115 schwarze 1633: /* FALLTHROUGH */
1.166 schwarze 1634: case MDOC_Dl:
1.108 schwarze 1635: /* FALLTHROUGH */
1.166 schwarze 1636: case MDOC_Lp:
1.108 schwarze 1637: /* FALLTHROUGH */
1.166 schwarze 1638: case MDOC_Pp:
1.108 schwarze 1639: continue;
1640: default:
1641: break;
1642: }
1.100 schwarze 1643: if (nn->next && nn->next->line == nn->line)
1644: continue;
1645: term_flushln(p);
1.48 schwarze 1646: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1647: }
1.88 schwarze 1648:
1.75 schwarze 1649: p->tabwidth = tabwidth;
1.77 schwarze 1650: p->rmargin = rm;
1651: p->maxrmargin = rmax;
1.1 kristaps 1652: return(0);
1653: }
1654:
1655: static void
1656: termp_bd_post(DECL_ARGS)
1657: {
1.77 schwarze 1658: size_t rm, rmax;
1.1 kristaps 1659:
1.166 schwarze 1660: if (MDOC_BODY != n->type)
1.1 kristaps 1661: return;
1.77 schwarze 1662:
1663: rm = p->rmargin;
1664: rmax = p->maxrmargin;
1665:
1.166 schwarze 1666: if (DISP_literal == n->norm->Bd.type ||
1667: DISP_unfilled == n->norm->Bd.type)
1.77 schwarze 1668: p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1669:
1.48 schwarze 1670: p->flags |= TERMP_NOSPACE;
1.75 schwarze 1671: term_newln(p);
1.77 schwarze 1672:
1673: p->rmargin = rm;
1674: p->maxrmargin = rmax;
1.1 kristaps 1675: }
1676:
1.126 schwarze 1677: static int
1678: termp_bx_pre(DECL_ARGS)
1.1 kristaps 1679: {
1680:
1.126 schwarze 1681: if (NULL != (n = n->child)) {
1682: term_word(p, n->string);
1683: p->flags |= TERMP_NOSPACE;
1684: term_word(p, "BSD");
1685: } else {
1686: term_word(p, "BSD");
1687: return(0);
1688: }
1689:
1690: if (NULL != (n = n->next)) {
1691: p->flags |= TERMP_NOSPACE;
1692: term_word(p, "-");
1.1 kristaps 1693: p->flags |= TERMP_NOSPACE;
1.126 schwarze 1694: term_word(p, n->string);
1695: }
1696:
1697: return(0);
1.1 kristaps 1698: }
1699:
1700: static int
1.26 schwarze 1701: termp_xx_pre(DECL_ARGS)
1.1 kristaps 1702: {
1.26 schwarze 1703: const char *pp;
1.129 schwarze 1704: int flags;
1.1 kristaps 1705:
1.26 schwarze 1706: pp = NULL;
1.60 schwarze 1707: switch (n->tok) {
1.166 schwarze 1708: case MDOC_Bsx:
1.113 schwarze 1709: pp = "BSD/OS";
1.26 schwarze 1710: break;
1.166 schwarze 1711: case MDOC_Dx:
1.64 schwarze 1712: pp = "DragonFly";
1.26 schwarze 1713: break;
1.166 schwarze 1714: case MDOC_Fx:
1.26 schwarze 1715: pp = "FreeBSD";
1716: break;
1.166 schwarze 1717: case MDOC_Nx:
1.26 schwarze 1718: pp = "NetBSD";
1719: break;
1.166 schwarze 1720: case MDOC_Ox:
1.26 schwarze 1721: pp = "OpenBSD";
1722: break;
1.166 schwarze 1723: case MDOC_Ux:
1.26 schwarze 1724: pp = "UNIX";
1725: break;
1726: default:
1.148 schwarze 1727: abort();
1728: /* NOTREACHED */
1.26 schwarze 1729: }
1.1 kristaps 1730:
1.26 schwarze 1731: term_word(p, pp);
1.129 schwarze 1732: if (n->child) {
1733: flags = p->flags;
1734: p->flags |= TERMP_KEEP;
1735: term_word(p, n->child->string);
1736: p->flags = flags;
1737: }
1738: return(0);
1.1 kristaps 1739: }
1740:
1741: static void
1742: termp_pf_post(DECL_ARGS)
1743: {
1744:
1745: p->flags |= TERMP_NOSPACE;
1746: }
1747:
1748: static int
1749: termp_ss_pre(DECL_ARGS)
1750: {
1751:
1.60 schwarze 1752: switch (n->type) {
1.166 schwarze 1753: case MDOC_BLOCK:
1.1 kristaps 1754: term_newln(p);
1.60 schwarze 1755: if (n->prev)
1.1 kristaps 1756: term_vspace(p);
1757: break;
1.166 schwarze 1758: case MDOC_HEAD:
1.65 schwarze 1759: term_fontpush(p, TERMFONT_BOLD);
1.140 schwarze 1760: p->offset = term_len(p, (p->defindent+1)/2);
1.1 kristaps 1761: break;
1.176 schwarze 1762: case MDOC_BODY:
1763: p->offset = term_len(p, p->defindent);
1764: break;
1.1 kristaps 1765: default:
1766: break;
1767: }
1768:
1769: return(1);
1770: }
1771:
1772: static void
1773: termp_ss_post(DECL_ARGS)
1774: {
1775:
1.176 schwarze 1776: if (n->type == MDOC_HEAD || n->type == MDOC_BODY)
1.1 kristaps 1777: term_newln(p);
1778: }
1779:
1780: static int
1781: termp_cd_pre(DECL_ARGS)
1782: {
1783:
1.86 schwarze 1784: synopsis_pre(p, n);
1.65 schwarze 1785: term_fontpush(p, TERMFONT_BOLD);
1.1 kristaps 1786: return(1);
1787: }
1788:
1789: static int
1790: termp_in_pre(DECL_ARGS)
1791: {
1792:
1.86 schwarze 1793: synopsis_pre(p, n);
1.85 schwarze 1794:
1.92 schwarze 1795: if (MDOC_SYNPRETTY & n->flags && MDOC_LINE & n->flags) {
1.85 schwarze 1796: term_fontpush(p, TERMFONT_BOLD);
1.23 schwarze 1797: term_word(p, "#include");
1.85 schwarze 1798: term_word(p, "<");
1799: } else {
1800: term_word(p, "<");
1801: term_fontpush(p, TERMFONT_UNDER);
1802: }
1.23 schwarze 1803:
1.1 kristaps 1804: p->flags |= TERMP_NOSPACE;
1805: return(1);
1806: }
1807:
1808: static void
1809: termp_in_post(DECL_ARGS)
1810: {
1811:
1.92 schwarze 1812: if (MDOC_SYNPRETTY & n->flags)
1.85 schwarze 1813: term_fontpush(p, TERMFONT_BOLD);
1814:
1.59 schwarze 1815: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1816: term_word(p, ">");
1817:
1.92 schwarze 1818: if (MDOC_SYNPRETTY & n->flags)
1.85 schwarze 1819: term_fontpop(p);
1.38 schwarze 1820: }
1821:
1822: static int
1823: termp_sp_pre(DECL_ARGS)
1824: {
1.61 schwarze 1825: size_t i, len;
1.38 schwarze 1826:
1.60 schwarze 1827: switch (n->tok) {
1.166 schwarze 1828: case MDOC_sp:
1.89 schwarze 1829: len = n->child ? a2height(p, n->child->string) : 1;
1.54 schwarze 1830: break;
1.166 schwarze 1831: case MDOC_br:
1.54 schwarze 1832: len = 0;
1833: break;
1834: default:
1835: len = 1;
1836: break;
1.38 schwarze 1837: }
1838:
1839: if (0 == len)
1840: term_newln(p);
1841: for (i = 0; i < len; i++)
1842: term_vspace(p);
1843:
1844: return(0);
1845: }
1846:
1847: static int
1.170 schwarze 1848: termp_es_pre(DECL_ARGS)
1849: {
1850:
1851: return(0);
1852: }
1853:
1854: static int
1.107 schwarze 1855: termp_quote_pre(DECL_ARGS)
1.1 kristaps 1856: {
1857:
1.120 schwarze 1858: if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1.1 kristaps 1859: return(1);
1860:
1.107 schwarze 1861: switch (n->tok) {
1.166 schwarze 1862: case MDOC_Ao:
1.107 schwarze 1863: /* FALLTHROUGH */
1.166 schwarze 1864: case MDOC_Aq:
1.107 schwarze 1865: term_word(p, "<");
1866: break;
1.166 schwarze 1867: case MDOC_Bro:
1.107 schwarze 1868: /* FALLTHROUGH */
1.166 schwarze 1869: case MDOC_Brq:
1.107 schwarze 1870: term_word(p, "{");
1871: break;
1.166 schwarze 1872: case MDOC_Oo:
1.107 schwarze 1873: /* FALLTHROUGH */
1.166 schwarze 1874: case MDOC_Op:
1.107 schwarze 1875: /* FALLTHROUGH */
1.166 schwarze 1876: case MDOC_Bo:
1.107 schwarze 1877: /* FALLTHROUGH */
1.166 schwarze 1878: case MDOC_Bq:
1.107 schwarze 1879: term_word(p, "[");
1880: break;
1.166 schwarze 1881: case MDOC_Do:
1.107 schwarze 1882: /* FALLTHROUGH */
1.166 schwarze 1883: case MDOC_Dq:
1.151 schwarze 1884: term_word(p, "\\(lq");
1.107 schwarze 1885: break;
1.170 schwarze 1886: case MDOC_En:
1887: if (NULL == n->norm->Es ||
1888: NULL == n->norm->Es->child)
1889: return(1);
1890: term_word(p, n->norm->Es->child->string);
1891: break;
1.166 schwarze 1892: case MDOC_Eo:
1.139 schwarze 1893: break;
1.166 schwarze 1894: case MDOC_Po:
1.107 schwarze 1895: /* FALLTHROUGH */
1.166 schwarze 1896: case MDOC_Pq:
1.107 schwarze 1897: term_word(p, "(");
1898: break;
1.166 schwarze 1899: case MDOC__T:
1.120 schwarze 1900: /* FALLTHROUGH */
1.166 schwarze 1901: case MDOC_Qo:
1.107 schwarze 1902: /* FALLTHROUGH */
1.166 schwarze 1903: case MDOC_Qq:
1.107 schwarze 1904: term_word(p, "\"");
1905: break;
1.166 schwarze 1906: case MDOC_Ql:
1.107 schwarze 1907: /* FALLTHROUGH */
1.166 schwarze 1908: case MDOC_So:
1.107 schwarze 1909: /* FALLTHROUGH */
1.166 schwarze 1910: case MDOC_Sq:
1.151 schwarze 1911: term_word(p, "\\(oq");
1.107 schwarze 1912: break;
1913: default:
1914: abort();
1915: /* NOTREACHED */
1916: }
1.1 kristaps 1917:
1918: p->flags |= TERMP_NOSPACE;
1919: return(1);
1920: }
1921:
1922: static void
1.107 schwarze 1923: termp_quote_post(DECL_ARGS)
1.1 kristaps 1924: {
1925:
1.120 schwarze 1926: if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1.1 kristaps 1927: return;
1928:
1.170 schwarze 1929: if (MDOC_En != n->tok)
1930: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1931:
1.107 schwarze 1932: switch (n->tok) {
1.166 schwarze 1933: case MDOC_Ao:
1.107 schwarze 1934: /* FALLTHROUGH */
1.166 schwarze 1935: case MDOC_Aq:
1.107 schwarze 1936: term_word(p, ">");
1937: break;
1.166 schwarze 1938: case MDOC_Bro:
1.107 schwarze 1939: /* FALLTHROUGH */
1.166 schwarze 1940: case MDOC_Brq:
1.107 schwarze 1941: term_word(p, "}");
1942: break;
1.166 schwarze 1943: case MDOC_Oo:
1.107 schwarze 1944: /* FALLTHROUGH */
1.166 schwarze 1945: case MDOC_Op:
1.107 schwarze 1946: /* FALLTHROUGH */
1.166 schwarze 1947: case MDOC_Bo:
1.107 schwarze 1948: /* FALLTHROUGH */
1.166 schwarze 1949: case MDOC_Bq:
1.107 schwarze 1950: term_word(p, "]");
1951: break;
1.166 schwarze 1952: case MDOC_Do:
1.107 schwarze 1953: /* FALLTHROUGH */
1.166 schwarze 1954: case MDOC_Dq:
1.151 schwarze 1955: term_word(p, "\\(rq");
1.170 schwarze 1956: break;
1957: case MDOC_En:
1958: if (NULL != n->norm->Es &&
1959: NULL != n->norm->Es->child &&
1960: NULL != n->norm->Es->child->next) {
1961: p->flags |= TERMP_NOSPACE;
1962: term_word(p, n->norm->Es->child->next->string);
1963: }
1.139 schwarze 1964: break;
1.166 schwarze 1965: case MDOC_Eo:
1.107 schwarze 1966: break;
1.166 schwarze 1967: case MDOC_Po:
1.107 schwarze 1968: /* FALLTHROUGH */
1.166 schwarze 1969: case MDOC_Pq:
1.107 schwarze 1970: term_word(p, ")");
1971: break;
1.166 schwarze 1972: case MDOC__T:
1.120 schwarze 1973: /* FALLTHROUGH */
1.166 schwarze 1974: case MDOC_Qo:
1.107 schwarze 1975: /* FALLTHROUGH */
1.166 schwarze 1976: case MDOC_Qq:
1.107 schwarze 1977: term_word(p, "\"");
1978: break;
1.166 schwarze 1979: case MDOC_Ql:
1.107 schwarze 1980: /* FALLTHROUGH */
1.166 schwarze 1981: case MDOC_So:
1.107 schwarze 1982: /* FALLTHROUGH */
1.166 schwarze 1983: case MDOC_Sq:
1.151 schwarze 1984: term_word(p, "\\(cq");
1.107 schwarze 1985: break;
1986: default:
1987: abort();
1988: /* NOTREACHED */
1989: }
1.1 kristaps 1990: }
1991:
1992: static int
1993: termp_fo_pre(DECL_ARGS)
1994: {
1.159 schwarze 1995: size_t rmargin = 0;
1.158 schwarze 1996: int pretty;
1997:
1998: pretty = MDOC_SYNPRETTY & n->flags;
1.1 kristaps 1999:
1.85 schwarze 2000: if (MDOC_BLOCK == n->type) {
1.86 schwarze 2001: synopsis_pre(p, n);
1.85 schwarze 2002: return(1);
2003: } else if (MDOC_BODY == n->type) {
1.158 schwarze 2004: if (pretty) {
2005: rmargin = p->rmargin;
1.159 schwarze 2006: p->rmargin = p->offset + term_len(p, 4);
1.165 schwarze 2007: p->flags |= TERMP_NOBREAK | TERMP_BRIND |
2008: TERMP_HANG;
1.158 schwarze 2009: }
1.31 schwarze 2010: p->flags |= TERMP_NOSPACE;
1.1 kristaps 2011: term_word(p, "(");
1.132 schwarze 2012: p->flags |= TERMP_NOSPACE;
1.158 schwarze 2013: if (pretty) {
2014: term_flushln(p);
1.165 schwarze 2015: p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND |
2016: TERMP_HANG);
1.158 schwarze 2017: p->offset = p->rmargin;
2018: p->rmargin = rmargin;
2019: }
1.1 kristaps 2020: return(1);
1.158 schwarze 2021: }
1.85 schwarze 2022:
1.95 schwarze 2023: if (NULL == n->child)
2024: return(0);
2025:
1.85 schwarze 2026: /* XXX: we drop non-initial arguments as per groff. */
1.1 kristaps 2027:
1.85 schwarze 2028: assert(n->child->string);
1.65 schwarze 2029: term_fontpush(p, TERMFONT_BOLD);
1.85 schwarze 2030: term_word(p, n->child->string);
1.1 kristaps 2031: return(0);
2032: }
2033:
2034: static void
2035: termp_fo_post(DECL_ARGS)
2036: {
2037:
1.166 schwarze 2038: if (MDOC_BODY != n->type)
1.86 schwarze 2039: return;
2040:
1.132 schwarze 2041: p->flags |= TERMP_NOSPACE;
1.86 schwarze 2042: term_word(p, ")");
2043:
1.132 schwarze 2044: if (MDOC_SYNPRETTY & n->flags) {
2045: p->flags |= TERMP_NOSPACE;
1.86 schwarze 2046: term_word(p, ";");
1.158 schwarze 2047: term_flushln(p);
1.132 schwarze 2048: }
1.1 kristaps 2049: }
2050:
2051: static int
2052: termp_bf_pre(DECL_ARGS)
2053: {
2054:
1.60 schwarze 2055: if (MDOC_HEAD == n->type)
1.1 kristaps 2056: return(0);
1.146 schwarze 2057: else if (MDOC_BODY != n->type)
1.1 kristaps 2058: return(1);
2059:
1.166 schwarze 2060: if (FONT_Em == n->norm->Bf.font)
1.65 schwarze 2061: term_fontpush(p, TERMFONT_UNDER);
1.166 schwarze 2062: else if (FONT_Sy == n->norm->Bf.font)
1.65 schwarze 2063: term_fontpush(p, TERMFONT_BOLD);
1.166 schwarze 2064: else
1.65 schwarze 2065: term_fontpush(p, TERMFONT_NONE);
1.1 kristaps 2066:
2067: return(1);
2068: }
2069:
2070: static int
2071: termp_sm_pre(DECL_ARGS)
2072: {
2073:
1.171 schwarze 2074: if (NULL == n->child)
2075: p->flags ^= TERMP_NONOSPACE;
2076: else if (0 == strcmp("on", n->child->string))
1.1 kristaps 2077: p->flags &= ~TERMP_NONOSPACE;
1.171 schwarze 2078: else
1.1 kristaps 2079: p->flags |= TERMP_NONOSPACE;
1.171 schwarze 2080:
2081: if (p->col && ! (TERMP_NONOSPACE & p->flags))
2082: p->flags &= ~TERMP_NOSPACE;
1.1 kristaps 2083:
2084: return(0);
2085: }
2086:
2087: static int
2088: termp_ap_pre(DECL_ARGS)
2089: {
2090:
2091: p->flags |= TERMP_NOSPACE;
1.107 schwarze 2092: term_word(p, "'");
1.1 kristaps 2093: p->flags |= TERMP_NOSPACE;
2094: return(1);
2095: }
2096:
2097: static void
2098: termp____post(DECL_ARGS)
2099: {
1.104 schwarze 2100:
2101: /*
2102: * Handle lists of authors. In general, print each followed by
2103: * a comma. Don't print the comma if there are only two
2104: * authors.
2105: */
2106: if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok)
2107: if (NULL == n->next->next || MDOC__A != n->next->next->tok)
2108: if (NULL == n->prev || MDOC__A != n->prev->tok)
2109: return;
1.1 kristaps 2110:
1.62 schwarze 2111: /* TODO: %U. */
2112:
1.106 schwarze 2113: if (NULL == n->parent || MDOC_Rs != n->parent->tok)
2114: return;
2115:
1.132 schwarze 2116: p->flags |= TERMP_NOSPACE;
1.106 schwarze 2117: if (NULL == n->next) {
2118: term_word(p, ".");
2119: p->flags |= TERMP_SENTENCE;
2120: } else
2121: term_word(p, ",");
1.1 kristaps 2122: }
2123:
2124: static int
1.65 schwarze 2125: termp_li_pre(DECL_ARGS)
2126: {
2127:
2128: term_fontpush(p, TERMFONT_NONE);
2129: return(1);
2130: }
2131:
2132: static int
1.1 kristaps 2133: termp_lk_pre(DECL_ARGS)
2134: {
1.142 schwarze 2135: const struct mdoc_node *link, *descr;
1.1 kristaps 2136:
1.142 schwarze 2137: if (NULL == (link = n->child))
2138: return(0);
1.101 schwarze 2139:
1.142 schwarze 2140: if (NULL != (descr = link->next)) {
2141: term_fontpush(p, TERMFONT_UNDER);
2142: while (NULL != descr) {
2143: term_word(p, descr->string);
2144: descr = descr->next;
2145: }
2146: p->flags |= TERMP_NOSPACE;
2147: term_word(p, ":");
2148: term_fontpop(p);
2149: }
1.1 kristaps 2150:
1.65 schwarze 2151: term_fontpush(p, TERMFONT_BOLD);
1.142 schwarze 2152: term_word(p, link->string);
1.65 schwarze 2153: term_fontpop(p);
1.6 schwarze 2154:
1.1 kristaps 2155: return(0);
2156: }
2157:
1.90 schwarze 2158: static int
2159: termp_bk_pre(DECL_ARGS)
2160: {
2161:
1.91 schwarze 2162: switch (n->type) {
1.166 schwarze 2163: case MDOC_BLOCK:
1.95 schwarze 2164: break;
1.166 schwarze 2165: case MDOC_HEAD:
1.91 schwarze 2166: return(0);
1.166 schwarze 2167: case MDOC_BODY:
1.117 schwarze 2168: if (n->parent->args || 0 == n->prev->nchild)
2169: p->flags |= TERMP_PREKEEP;
1.95 schwarze 2170: break;
1.91 schwarze 2171: default:
2172: abort();
1.95 schwarze 2173: /* NOTREACHED */
1.91 schwarze 2174: }
1.95 schwarze 2175:
2176: return(1);
1.90 schwarze 2177: }
2178:
2179: static void
2180: termp_bk_post(DECL_ARGS)
2181: {
2182:
1.155 schwarze 2183: if (MDOC_BODY == n->type)
1.91 schwarze 2184: p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
1.90 schwarze 2185: }
1.120 schwarze 2186:
2187: static void
2188: termp__t_post(DECL_ARGS)
2189: {
2190:
2191: /*
2192: * If we're in an `Rs' and there's a journal present, then quote
2193: * us instead of underlining us (for disambiguation).
2194: */
1.121 schwarze 2195: if (n->parent && MDOC_Rs == n->parent->tok &&
1.166 schwarze 2196: n->parent->norm->Rs.quote_T)
1.147 schwarze 2197: termp_quote_post(p, pair, meta, n);
1.120 schwarze 2198:
1.147 schwarze 2199: termp____post(p, pair, meta, n);
1.120 schwarze 2200: }
2201:
2202: static int
2203: termp__t_pre(DECL_ARGS)
2204: {
2205:
2206: /*
2207: * If we're in an `Rs' and there's a journal present, then quote
2208: * us instead of underlining us (for disambiguation).
2209: */
1.121 schwarze 2210: if (n->parent && MDOC_Rs == n->parent->tok &&
1.166 schwarze 2211: n->parent->norm->Rs.quote_T)
1.147 schwarze 2212: return(termp_quote_pre(p, pair, meta, n));
1.120 schwarze 2213:
2214: term_fontpush(p, TERMFONT_UNDER);
2215: return(1);
1.121 schwarze 2216: }
1.1 kristaps 2217:
2218: static int
1.54 schwarze 2219: termp_under_pre(DECL_ARGS)
1.1 kristaps 2220: {
2221:
1.65 schwarze 2222: term_fontpush(p, TERMFONT_UNDER);
1.1 kristaps 2223: return(1);
2224: }
![[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