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