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