Annotation of src/usr.bin/mandoc/mdoc_term.c, Revision 1.14
1.14 ! schwarze 1: /* $Id: mdoc_term.c,v 1.13 2009/06/21 20:49:33 schwarze Exp $ */
1.1 kristaps 2: /*
1.2 schwarze 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.2 schwarze 9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 16: */
17: #include <sys/types.h>
18:
19: #include <assert.h>
20: #include <ctype.h>
21: #include <err.h>
22: #include <stdio.h>
23: #include <stdlib.h>
24: #include <string.h>
25:
26: #include "term.h"
27: #include "mdoc.h"
28:
29: /* FIXME: macro arguments can be escaped. */
30: /* FIXME: support more offset/width tokens. */
31:
32: #define TTYPE_PROG 0
33: #define TTYPE_CMD_FLAG 1
34: #define TTYPE_CMD_ARG 2
35: #define TTYPE_SECTION 3
36: #define TTYPE_FUNC_DECL 4
37: #define TTYPE_VAR_DECL 5
38: #define TTYPE_FUNC_TYPE 6
39: #define TTYPE_FUNC_NAME 7
40: #define TTYPE_FUNC_ARG 8
41: #define TTYPE_LINK 9
42: #define TTYPE_SSECTION 10
43: #define TTYPE_FILE 11
44: #define TTYPE_EMPH 12
45: #define TTYPE_CONFIG 13
46: #define TTYPE_CMD 14
47: #define TTYPE_INCLUDE 15
48: #define TTYPE_SYMB 16
49: #define TTYPE_SYMBOL 17
50: #define TTYPE_DIAG 18
51: #define TTYPE_LINK_ANCHOR 19
52: #define TTYPE_LINK_TEXT 20
53: #define TTYPE_REF_JOURNAL 21
54: #define TTYPE_LIST 22
55: #define TTYPE_NMAX 23
56:
57: const int ttypes[TTYPE_NMAX] = {
58: TERMP_BOLD, /* TTYPE_PROG */
59: TERMP_BOLD, /* TTYPE_CMD_FLAG */
60: TERMP_UNDER, /* TTYPE_CMD_ARG */
61: TERMP_BOLD, /* TTYPE_SECTION */
62: TERMP_BOLD, /* TTYPE_FUNC_DECL */
63: TERMP_UNDER, /* TTYPE_VAR_DECL */
64: TERMP_UNDER, /* TTYPE_FUNC_TYPE */
65: TERMP_BOLD, /* TTYPE_FUNC_NAME */
66: TERMP_UNDER, /* TTYPE_FUNC_ARG */
67: TERMP_UNDER, /* TTYPE_LINK */
68: TERMP_BOLD, /* TTYPE_SSECTION */
69: TERMP_UNDER, /* TTYPE_FILE */
70: TERMP_UNDER, /* TTYPE_EMPH */
71: TERMP_BOLD, /* TTYPE_CONFIG */
72: TERMP_BOLD, /* TTYPE_CMD */
73: TERMP_BOLD, /* TTYPE_INCLUDE */
74: TERMP_BOLD, /* TTYPE_SYMB */
75: TERMP_BOLD, /* TTYPE_SYMBOL */
76: TERMP_BOLD, /* TTYPE_DIAG */
77: TERMP_UNDER, /* TTYPE_LINK_ANCHOR */
78: TERMP_BOLD, /* TTYPE_LINK_TEXT */
79: TERMP_UNDER, /* TTYPE_REF_JOURNAL */
80: TERMP_BOLD /* TTYPE_LIST */
81: };
82:
83: /* XXX - clean this up. */
84:
85: struct termpair {
86: struct termpair *ppair;
87: int type;
88: #define TERMPAIR_FLAG (1 << 0)
1.2 schwarze 89: int flag; /* Whether being used. */
90: size_t offset; /* Left margin. */
91: size_t rmargin; /* Right margin. */
92: int count; /* Enum count. */
1.1 kristaps 93: };
94:
95: #define TERMPAIR_SETFLAG(termp, p, fl) \
96: do { \
97: assert(! (TERMPAIR_FLAG & (p)->type)); \
98: (termp)->flags |= (fl); \
99: (p)->flag = (fl); \
100: (p)->type |= TERMPAIR_FLAG; \
101: } while ( /* CONSTCOND */ 0)
102:
103: #define DECL_ARGS \
104: struct termp *p, struct termpair *pair, \
105: const struct mdoc_meta *meta, \
106: const struct mdoc_node *node
107:
108: #define DECL_PRE(name) \
109: static int name##_pre(DECL_ARGS)
110: #define DECL_POST(name) \
111: static void name##_post(DECL_ARGS)
112: #define DECL_PREPOST(name) \
113: DECL_PRE(name); \
114: DECL_POST(name);
115:
116: DECL_PREPOST(termp__t);
117: DECL_PREPOST(termp_aq);
118: DECL_PREPOST(termp_bd);
119: DECL_PREPOST(termp_bq);
120: DECL_PREPOST(termp_brq);
121: DECL_PREPOST(termp_d1);
122: DECL_PREPOST(termp_dq);
123: DECL_PREPOST(termp_fd);
124: DECL_PREPOST(termp_fn);
125: DECL_PREPOST(termp_fo);
126: DECL_PREPOST(termp_ft);
127: DECL_PREPOST(termp_in);
128: DECL_PREPOST(termp_it);
129: DECL_PREPOST(termp_lb);
130: DECL_PREPOST(termp_op);
131: DECL_PREPOST(termp_pf);
132: DECL_PREPOST(termp_pq);
133: DECL_PREPOST(termp_qq);
134: DECL_PREPOST(termp_sh);
135: DECL_PREPOST(termp_ss);
136: DECL_PREPOST(termp_sq);
137: DECL_PREPOST(termp_vt);
138:
139: DECL_PRE(termp__j);
140: DECL_PRE(termp_ap);
141: DECL_PRE(termp_ar);
142: DECL_PRE(termp_at);
143: DECL_PRE(termp_bf);
144: DECL_PRE(termp_bsx);
145: DECL_PRE(termp_bt);
146: DECL_PRE(termp_cd);
147: DECL_PRE(termp_cm);
148: DECL_PRE(termp_dx);
149: DECL_PRE(termp_em);
150: DECL_PRE(termp_ex);
151: DECL_PRE(termp_fa);
152: DECL_PRE(termp_fl);
153: DECL_PRE(termp_fx);
154: DECL_PRE(termp_ic);
155: DECL_PRE(termp_lk);
156: DECL_PRE(termp_ms);
157: DECL_PRE(termp_mt);
158: DECL_PRE(termp_nd);
159: DECL_PRE(termp_nm);
160: DECL_PRE(termp_ns);
161: DECL_PRE(termp_nx);
162: DECL_PRE(termp_ox);
163: DECL_PRE(termp_pa);
164: DECL_PRE(termp_pp);
165: DECL_PRE(termp_rs);
166: DECL_PRE(termp_rv);
167: DECL_PRE(termp_sm);
168: DECL_PRE(termp_st);
169: DECL_PRE(termp_sx);
170: DECL_PRE(termp_sy);
171: DECL_PRE(termp_ud);
172: DECL_PRE(termp_ux);
173: DECL_PRE(termp_va);
174: DECL_PRE(termp_xr);
175:
176: DECL_POST(termp___);
177: DECL_POST(termp_bl);
178: DECL_POST(termp_bx);
179:
180: struct termact {
181: int (*pre)(DECL_ARGS);
182: void (*post)(DECL_ARGS);
183: };
184:
185: static const struct termact termacts[MDOC_MAX] = {
1.11 schwarze 186: { termp_ap_pre, NULL }, /* Ap */
1.1 kristaps 187: { NULL, NULL }, /* Dd */
188: { NULL, NULL }, /* Dt */
189: { NULL, NULL }, /* Os */
190: { termp_sh_pre, termp_sh_post }, /* Sh */
191: { termp_ss_pre, termp_ss_post }, /* Ss */
192: { termp_pp_pre, NULL }, /* Pp */
193: { termp_d1_pre, termp_d1_post }, /* D1 */
194: { termp_d1_pre, termp_d1_post }, /* Dl */
195: { termp_bd_pre, termp_bd_post }, /* Bd */
196: { NULL, NULL }, /* Ed */
197: { NULL, termp_bl_post }, /* Bl */
198: { NULL, NULL }, /* El */
199: { termp_it_pre, termp_it_post }, /* It */
200: { NULL, NULL }, /* Ad */
201: { NULL, NULL }, /* An */
202: { termp_ar_pre, NULL }, /* Ar */
203: { termp_cd_pre, NULL }, /* Cd */
204: { termp_cm_pre, NULL }, /* Cm */
205: { NULL, NULL }, /* Dv */
206: { NULL, NULL }, /* Er */
207: { NULL, NULL }, /* Ev */
208: { termp_ex_pre, NULL }, /* Ex */
209: { termp_fa_pre, NULL }, /* Fa */
210: { termp_fd_pre, termp_fd_post }, /* Fd */
211: { termp_fl_pre, NULL }, /* Fl */
212: { termp_fn_pre, termp_fn_post }, /* Fn */
213: { termp_ft_pre, termp_ft_post }, /* Ft */
214: { termp_ic_pre, NULL }, /* Ic */
215: { termp_in_pre, termp_in_post }, /* In */
216: { NULL, NULL }, /* Li */
217: { termp_nd_pre, NULL }, /* Nd */
218: { termp_nm_pre, NULL }, /* Nm */
219: { termp_op_pre, termp_op_post }, /* Op */
220: { NULL, NULL }, /* Ot */
221: { termp_pa_pre, NULL }, /* Pa */
222: { termp_rv_pre, NULL }, /* Rv */
223: { termp_st_pre, NULL }, /* St */
224: { termp_va_pre, NULL }, /* Va */
225: { termp_vt_pre, termp_vt_post }, /* Vt */
226: { termp_xr_pre, NULL }, /* Xr */
227: { NULL, termp____post }, /* %A */
228: { NULL, termp____post }, /* %B */
229: { NULL, termp____post }, /* %D */
230: { NULL, termp____post }, /* %I */
231: { termp__j_pre, termp____post }, /* %J */
232: { NULL, termp____post }, /* %N */
233: { NULL, termp____post }, /* %O */
234: { NULL, termp____post }, /* %P */
235: { NULL, termp____post }, /* %R */
236: { termp__t_pre, termp__t_post }, /* %T */
237: { NULL, termp____post }, /* %V */
238: { NULL, NULL }, /* Ac */
239: { termp_aq_pre, termp_aq_post }, /* Ao */
240: { termp_aq_pre, termp_aq_post }, /* Aq */
241: { termp_at_pre, NULL }, /* At */
242: { NULL, NULL }, /* Bc */
243: { termp_bf_pre, NULL }, /* Bf */
244: { termp_bq_pre, termp_bq_post }, /* Bo */
245: { termp_bq_pre, termp_bq_post }, /* Bq */
246: { termp_bsx_pre, NULL }, /* Bsx */
247: { NULL, termp_bx_post }, /* Bx */
248: { NULL, NULL }, /* Db */
249: { NULL, NULL }, /* Dc */
250: { termp_dq_pre, termp_dq_post }, /* Do */
251: { termp_dq_pre, termp_dq_post }, /* Dq */
252: { NULL, NULL }, /* Ec */
253: { NULL, NULL }, /* Ef */
254: { termp_em_pre, NULL }, /* Em */
255: { NULL, NULL }, /* Eo */
256: { termp_fx_pre, NULL }, /* Fx */
257: { termp_ms_pre, NULL }, /* Ms */
258: { NULL, NULL }, /* No */
259: { termp_ns_pre, NULL }, /* Ns */
260: { termp_nx_pre, NULL }, /* Nx */
261: { termp_ox_pre, NULL }, /* Ox */
262: { NULL, NULL }, /* Pc */
263: { termp_pf_pre, termp_pf_post }, /* Pf */
264: { termp_pq_pre, termp_pq_post }, /* Po */
265: { termp_pq_pre, termp_pq_post }, /* Pq */
266: { NULL, NULL }, /* Qc */
267: { termp_sq_pre, termp_sq_post }, /* Ql */
268: { termp_qq_pre, termp_qq_post }, /* Qo */
269: { termp_qq_pre, termp_qq_post }, /* Qq */
270: { NULL, NULL }, /* Re */
271: { termp_rs_pre, NULL }, /* Rs */
272: { NULL, NULL }, /* Sc */
273: { termp_sq_pre, termp_sq_post }, /* So */
274: { termp_sq_pre, termp_sq_post }, /* Sq */
275: { termp_sm_pre, NULL }, /* Sm */
276: { termp_sx_pre, NULL }, /* Sx */
277: { termp_sy_pre, NULL }, /* Sy */
278: { NULL, NULL }, /* Tn */
279: { termp_ux_pre, NULL }, /* Ux */
280: { NULL, NULL }, /* Xc */
281: { NULL, NULL }, /* Xo */
282: { termp_fo_pre, termp_fo_post }, /* Fo */
283: { NULL, NULL }, /* Fc */
284: { termp_op_pre, termp_op_post }, /* Oo */
285: { NULL, NULL }, /* Oc */
286: { NULL, NULL }, /* Bk */
287: { NULL, NULL }, /* Ek */
288: { termp_bt_pre, NULL }, /* Bt */
289: { NULL, NULL }, /* Hf */
290: { NULL, NULL }, /* Fr */
291: { termp_ud_pre, NULL }, /* Ud */
292: { termp_lb_pre, termp_lb_post }, /* Lb */
1.13 schwarze 293: { termp_pp_pre, NULL }, /* Lp */
1.1 kristaps 294: { termp_lk_pre, NULL }, /* Lk */
295: { termp_mt_pre, NULL }, /* Mt */
296: { termp_brq_pre, termp_brq_post }, /* Brq */
297: { termp_brq_pre, termp_brq_post }, /* Bro */
298: { NULL, NULL }, /* Brc */
299: { NULL, NULL }, /* %C */
300: { NULL, NULL }, /* Es */
301: { NULL, NULL }, /* En */
302: { termp_dx_pre, NULL }, /* Dx */
303: { NULL, NULL }, /* %Q */
304: };
305:
306: static int arg_hasattr(int, const struct mdoc_node *);
307: static int arg_getattrs(const int *, int *, size_t,
308: const struct mdoc_node *);
309: static int arg_getattr(int, const struct mdoc_node *);
310: static size_t arg_offset(const struct mdoc_argv *);
311: static size_t arg_width(const struct mdoc_argv *, int);
312: static int arg_listtype(const struct mdoc_node *);
313: static int fmt_block_vspace(struct termp *,
314: const struct mdoc_node *,
315: const struct mdoc_node *);
316: static void print_node(DECL_ARGS);
317: static void print_head(struct termp *,
318: const struct mdoc_meta *);
319: static void print_body(DECL_ARGS);
320: static void print_foot(struct termp *,
321: const struct mdoc_meta *);
322:
323:
324: int
325: mdoc_run(struct termp *p, const struct mdoc *m)
326: {
1.4 schwarze 327: /*
328: * Main output function. When this is called, assume that the
329: * tree is properly formed.
330: */
1.1 kristaps 331:
332: print_head(p, mdoc_meta(m));
1.13 schwarze 333: assert(mdoc_node(m));
334: assert(MDOC_ROOT == mdoc_node(m)->type);
335: if (mdoc_node(m)->child)
336: print_body(p, NULL, mdoc_meta(m), mdoc_node(m)->child);
1.1 kristaps 337: print_foot(p, mdoc_meta(m));
338: return(1);
339: }
340:
341:
342: static void
343: print_body(DECL_ARGS)
344: {
345:
346: print_node(p, pair, meta, node);
347: if ( ! node->next)
348: return;
349: print_body(p, pair, meta, node->next);
350: }
351:
352:
353: static void
354: print_node(DECL_ARGS)
355: {
356: int dochild;
357: struct termpair npair;
358:
359: /* Pre-processing. */
360:
361: dochild = 1;
362: npair.ppair = pair;
363: npair.type = 0;
364: npair.offset = npair.rmargin = 0;
365: npair.flag = 0;
366: npair.count = 0;
367:
368: if (MDOC_TEXT != node->type) {
369: if (termacts[node->tok].pre)
370: if ( ! (*termacts[node->tok].pre)(p, &npair, meta, node))
371: dochild = 0;
372: } else /* MDOC_TEXT == node->type */
373: term_word(p, node->string);
374:
375: /* Children. */
376:
377: if (TERMPAIR_FLAG & npair.type)
378: p->flags |= npair.flag;
379:
380: if (dochild && node->child)
381: print_body(p, &npair, meta, node->child);
382:
383: if (TERMPAIR_FLAG & npair.type)
384: p->flags &= ~npair.flag;
385:
386: /* Post-processing. */
387:
388: if (MDOC_TEXT != node->type)
389: if (termacts[node->tok].post)
390: (*termacts[node->tok].post)(p, &npair, meta, node);
391: }
392:
393:
394: static void
395: print_foot(struct termp *p, const struct mdoc_meta *meta)
396: {
397: struct tm *tm;
398: char *buf, *os;
399:
1.7 schwarze 400: /*
401: * Output the footer in new-groff style, that is, three columns
402: * with the middle being the manual date and flanking columns
403: * being the operating system:
404: *
405: * SYSTEM DATE SYSTEM
406: */
407:
1.1 kristaps 408: if (NULL == (buf = malloc(p->rmargin)))
409: err(1, "malloc");
410: if (NULL == (os = malloc(p->rmargin)))
411: err(1, "malloc");
412:
413: tm = localtime(&meta->date);
414:
1.5 schwarze 415: if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm))
1.1 kristaps 416: err(1, "strftime");
417:
418: (void)strlcpy(os, meta->os, p->rmargin);
419:
420: term_vspace(p);
421:
1.7 schwarze 422: p->offset = 0;
423: p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2;
1.1 kristaps 424: p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
425:
426: term_word(p, os);
427: term_flushln(p);
428:
1.7 schwarze 429: p->offset = p->rmargin;
430: p->rmargin = p->maxrmargin - strlen(os);
1.1 kristaps 431: p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
1.7 schwarze 432:
433: term_word(p, buf);
434: term_flushln(p);
435:
1.1 kristaps 436: p->offset = p->rmargin;
437: p->rmargin = p->maxrmargin;
438: p->flags &= ~TERMP_NOBREAK;
1.7 schwarze 439: p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
1.1 kristaps 440:
1.7 schwarze 441: term_word(p, os);
1.1 kristaps 442: term_flushln(p);
1.7 schwarze 443:
444: p->offset = 0;
445: p->rmargin = p->maxrmargin;
446: p->flags = 0;
1.1 kristaps 447:
448: free(buf);
449: free(os);
450: }
451:
452:
453: static void
454: print_head(struct termp *p, const struct mdoc_meta *meta)
455: {
456: char *buf, *title;
457:
458: p->rmargin = p->maxrmargin;
459: p->offset = 0;
460:
461: if (NULL == (buf = malloc(p->rmargin)))
462: err(1, "malloc");
463: if (NULL == (title = malloc(p->rmargin)))
464: err(1, "malloc");
465:
466: /*
467: * The header is strange. It has three components, which are
468: * really two with the first duplicated. It goes like this:
469: *
470: * IDENTIFIER TITLE IDENTIFIER
471: *
472: * The IDENTIFIER is NAME(SECTION), which is the command-name
473: * (if given, or "unknown" if not) followed by the manual page
474: * section. These are given in `Dt'. The TITLE is a free-form
475: * string depending on the manual volume. If not specified, it
476: * switches on the manual section.
477: */
478:
479: assert(meta->vol);
480: (void)strlcpy(buf, meta->vol, p->rmargin);
481:
482: if (meta->arch) {
483: (void)strlcat(buf, " (", p->rmargin);
484: (void)strlcat(buf, meta->arch, p->rmargin);
485: (void)strlcat(buf, ")", p->rmargin);
486: }
487:
488: (void)snprintf(title, p->rmargin, "%s(%d)",
489: meta->title, meta->msec);
490:
491: p->offset = 0;
1.8 schwarze 492: p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2;
1.1 kristaps 493: p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
494:
495: term_word(p, title);
496: term_flushln(p);
497:
498: p->offset = p->rmargin;
499: p->rmargin = p->maxrmargin - strlen(title);
1.8 schwarze 500: p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
1.1 kristaps 501:
502: term_word(p, buf);
503: term_flushln(p);
504:
505: p->offset = p->rmargin;
506: p->rmargin = p->maxrmargin;
507: p->flags &= ~TERMP_NOBREAK;
508: p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
509:
510: term_word(p, title);
511: term_flushln(p);
512:
1.8 schwarze 513: p->offset = 0;
1.1 kristaps 514: p->rmargin = p->maxrmargin;
515: p->flags &= ~TERMP_NOSPACE;
516:
517: free(title);
518: free(buf);
519: }
520:
521:
522: static size_t
523: arg_width(const struct mdoc_argv *arg, int pos)
524: {
525: size_t v;
526: int i, len;
527:
528: assert(pos < (int)arg->sz && pos >= 0);
529: assert(arg->value[pos]);
530: if (0 == strcmp(arg->value[pos], "indent"))
531: return(INDENT);
532: if (0 == strcmp(arg->value[pos], "indent-two"))
533: return(INDENT * 2);
534:
535: if (0 == (len = (int)strlen(arg->value[pos])))
536: return(0);
537:
538: for (i = 0; i < len - 1; i++)
539: if ( ! isdigit((u_char)arg->value[pos][i]))
540: break;
541:
542: if (i == len - 1) {
543: if ('n' == arg->value[pos][len - 1]) {
544: v = (size_t)atoi(arg->value[pos]);
545: return(v);
546: }
547:
548: }
549: return(strlen(arg->value[pos]) + 1);
550: }
551:
552:
553: static int
554: arg_listtype(const struct mdoc_node *n)
555: {
556: int i, len;
557:
558: assert(MDOC_BLOCK == n->type);
559:
560: len = (int)(n->args ? n->args->argc : 0);
561:
562: for (i = 0; i < len; i++)
563: switch (n->args->argv[i].arg) {
564: case (MDOC_Bullet):
565: /* FALLTHROUGH */
566: case (MDOC_Dash):
567: /* FALLTHROUGH */
568: case (MDOC_Enum):
569: /* FALLTHROUGH */
570: case (MDOC_Hyphen):
571: /* FALLTHROUGH */
572: case (MDOC_Tag):
573: /* FALLTHROUGH */
574: case (MDOC_Inset):
575: /* FALLTHROUGH */
576: case (MDOC_Diag):
577: /* FALLTHROUGH */
578: case (MDOC_Item):
579: /* FALLTHROUGH */
580: case (MDOC_Column):
581: /* FALLTHROUGH */
582: case (MDOC_Ohang):
583: return(n->args->argv[i].arg);
584: default:
585: break;
586: }
587:
1.10 schwarze 588: /* FIXME: mandated by parser. */
589:
1.1 kristaps 590: errx(1, "list type not supported");
591: /* NOTREACHED */
592: }
593:
594:
595: static size_t
596: arg_offset(const struct mdoc_argv *arg)
597: {
598:
599: assert(*arg->value);
1.9 schwarze 600: if (0 == strcmp(*arg->value, "left"))
601: return(0);
1.1 kristaps 602: if (0 == strcmp(*arg->value, "indent"))
603: return(INDENT);
604: if (0 == strcmp(*arg->value, "indent-two"))
605: return(INDENT * 2);
1.10 schwarze 606:
607: /* FIXME: needs to support field-widths (10n, etc.). */
608:
1.1 kristaps 609: return(strlen(*arg->value));
610: }
611:
612:
613: static int
614: arg_hasattr(int arg, const struct mdoc_node *n)
615: {
616:
617: return(-1 != arg_getattr(arg, n));
618: }
619:
620:
621: static int
622: arg_getattr(int v, const struct mdoc_node *n)
623: {
624: int val;
625:
626: return(arg_getattrs(&v, &val, 1, n) ? val : -1);
627: }
628:
629:
630: static int
631: arg_getattrs(const int *keys, int *vals,
632: size_t sz, const struct mdoc_node *n)
633: {
634: int i, j, k;
635:
636: if (NULL == n->args)
637: return(0);
638:
639: for (k = i = 0; i < (int)n->args->argc; i++)
640: for (j = 0; j < (int)sz; j++)
641: if (n->args->argv[i].arg == keys[j]) {
642: vals[j] = i;
643: k++;
644: }
645: return(k);
646: }
647:
648:
649: /* ARGSUSED */
650: static int
651: fmt_block_vspace(struct termp *p,
652: const struct mdoc_node *bl,
653: const struct mdoc_node *node)
654: {
655: const struct mdoc_node *n;
656:
657: term_newln(p);
658:
659: if (arg_hasattr(MDOC_Compact, bl))
660: return(1);
661:
662: for (n = node; n; n = n->parent) {
663: if (MDOC_BLOCK != n->type)
664: continue;
665: if (MDOC_Ss == n->tok)
666: break;
667: if (MDOC_Sh == n->tok)
668: break;
669: if (NULL == n->prev)
670: continue;
671: term_vspace(p);
672: break;
673: }
674:
675: return(1);
676: }
677:
678:
679: /* ARGSUSED */
680: static int
681: termp_dq_pre(DECL_ARGS)
682: {
683:
684: if (MDOC_BODY != node->type)
685: return(1);
686:
687: term_word(p, "\\(lq");
688: p->flags |= TERMP_NOSPACE;
689: return(1);
690: }
691:
692:
693: /* ARGSUSED */
694: static void
695: termp_dq_post(DECL_ARGS)
696: {
697:
698: if (MDOC_BODY != node->type)
699: return;
700:
701: p->flags |= TERMP_NOSPACE;
702: term_word(p, "\\(rq");
703: }
704:
705:
706: /* ARGSUSED */
707: static int
708: termp_it_pre(DECL_ARGS)
709: {
710: const struct mdoc_node *bl, *n;
711: char buf[7];
1.12 schwarze 712: int i, type, keys[3], vals[3], sv;
1.1 kristaps 713: size_t width, offset;
714:
715: if (MDOC_BLOCK == node->type)
716: return(fmt_block_vspace(p, node->parent->parent, node));
717:
718: bl = node->parent->parent->parent;
719:
720: /* Save parent attributes. */
721:
722: pair->offset = p->offset;
723: pair->rmargin = p->rmargin;
724: pair->flag = p->flags;
725:
726: /* Get list width and offset. */
727:
728: keys[0] = MDOC_Width;
729: keys[1] = MDOC_Offset;
730: keys[2] = MDOC_Column;
731:
732: vals[0] = vals[1] = vals[2] = -1;
733:
734: width = offset = 0;
735:
736: (void)arg_getattrs(keys, vals, 3, bl);
737:
738: type = arg_listtype(bl);
739:
740: /* Calculate real width and offset. */
741:
742: switch (type) {
743: case (MDOC_Column):
744: if (MDOC_BODY == node->type)
745: break;
746: for (i = 0, n = node->prev; n; n = n->prev, i++)
747: offset += arg_width
748: (&bl->args->argv[vals[2]], i);
749: assert(i < (int)bl->args->argv[vals[2]].sz);
750: width = arg_width(&bl->args->argv[vals[2]], i);
751: if (vals[1] >= 0)
752: offset += arg_offset(&bl->args->argv[vals[1]]);
753: break;
754: default:
755: if (vals[0] >= 0)
756: width = arg_width(&bl->args->argv[vals[0]], 0);
757: if (vals[1] >= 0)
758: offset = arg_offset(&bl->args->argv[vals[1]]);
759: break;
760: }
761:
762: /*
763: * List-type can override the width in the case of fixed-head
764: * values (bullet, dash/hyphen, enum). Tags need a non-zero
765: * offset.
766: */
767:
768: switch (type) {
769: case (MDOC_Bullet):
770: /* FALLTHROUGH */
771: case (MDOC_Dash):
772: /* FALLTHROUGH */
773: case (MDOC_Enum):
774: /* FALLTHROUGH */
775: case (MDOC_Hyphen):
776: if (width < 4)
777: width = 4;
778: break;
779: case (MDOC_Tag):
780: if (0 == width)
781: width = 10;
782: break;
783: default:
784: break;
785: }
786:
787: /*
788: * Whitespace control. Inset bodies need an initial space.
789: */
790:
791: switch (type) {
792: case (MDOC_Diag):
793: /* FALLTHROUGH */
794: case (MDOC_Inset):
795: if (MDOC_BODY == node->type)
796: p->flags &= ~TERMP_NOSPACE;
797: else
798: p->flags |= TERMP_NOSPACE;
799: break;
800: default:
801: p->flags |= TERMP_NOSPACE;
802: break;
803: }
804:
805: /*
806: * Style flags. Diagnostic heads need TTYPE_DIAG.
807: */
808:
809: switch (type) {
810: case (MDOC_Diag):
811: if (MDOC_HEAD == node->type)
812: p->flags |= ttypes[TTYPE_DIAG];
813: break;
814: default:
815: break;
816: }
817:
818: /*
819: * Pad and break control. This is the tricker part. Lists with
820: * set right-margins for the head get TERMP_NOBREAK because, if
821: * they overrun the margin, they wrap to the new margin.
822: * Correspondingly, the body for these types don't left-pad, as
823: * the head will pad out to to the right.
824: */
825:
826: switch (type) {
827: case (MDOC_Bullet):
828: /* FALLTHROUGH */
829: case (MDOC_Dash):
830: /* FALLTHROUGH */
831: case (MDOC_Enum):
832: /* FALLTHROUGH */
833: case (MDOC_Hyphen):
834: /* FALLTHROUGH */
835: case (MDOC_Tag):
836: if (MDOC_HEAD == node->type)
837: p->flags |= TERMP_NOBREAK;
838: else
839: p->flags |= TERMP_NOLPAD;
840: if (MDOC_HEAD == node->type && MDOC_Tag == type)
841: if (NULL == node->next ||
842: NULL == node->next->child)
843: p->flags |= TERMP_NONOBREAK;
844: break;
845: case (MDOC_Column):
846: if (MDOC_HEAD == node->type) {
847: assert(node->next);
848: if (MDOC_BODY == node->next->type)
849: p->flags &= ~TERMP_NOBREAK;
850: else
851: p->flags |= TERMP_NOBREAK;
852: if (node->prev)
853: p->flags |= TERMP_NOLPAD;
854: }
855: break;
856: case (MDOC_Diag):
857: if (MDOC_HEAD == node->type)
858: p->flags |= TERMP_NOBREAK;
859: break;
860: default:
861: break;
862: }
863:
864: /*
865: * Margin control. Set-head-width lists have their right
866: * margins shortened. The body for these lists has the offset
867: * necessarily lengthened. Everybody gets the offset.
868: */
869:
870: p->offset += offset;
871:
872: switch (type) {
873: case (MDOC_Bullet):
874: /* FALLTHROUGH */
875: case (MDOC_Dash):
876: /* FALLTHROUGH */
877: case (MDOC_Enum):
878: /* FALLTHROUGH */
879: case (MDOC_Hyphen):
880: /* FALLTHROUGH */
881: case (MDOC_Tag):
882: if (MDOC_HEAD == node->type)
883: p->rmargin = p->offset + width;
884: else
885: p->offset += width;
886: break;
887: case (MDOC_Column):
888: p->rmargin = p->offset + width;
889: break;
890: default:
891: break;
892: }
893:
894: /*
895: * The dash, hyphen, bullet and enum lists all have a special
1.12 schwarze 896: * HEAD character (temporarily bold, in some cases).
1.1 kristaps 897: */
898:
1.12 schwarze 899: sv = p->flags;
1.1 kristaps 900: if (MDOC_HEAD == node->type)
901: switch (type) {
902: case (MDOC_Bullet):
1.12 schwarze 903: p->flags |= TERMP_BOLD;
1.1 kristaps 904: term_word(p, "\\[bu]");
905: break;
906: case (MDOC_Dash):
907: /* FALLTHROUGH */
908: case (MDOC_Hyphen):
1.12 schwarze 909: p->flags |= TERMP_BOLD;
1.1 kristaps 910: term_word(p, "\\-");
911: break;
912: case (MDOC_Enum):
913: (pair->ppair->ppair->count)++;
914: (void)snprintf(buf, sizeof(buf), "%d.",
915: pair->ppair->ppair->count);
916: term_word(p, buf);
917: break;
918: default:
919: break;
920: }
1.12 schwarze 921:
922: p->flags = sv; /* Restore saved flags. */
1.1 kristaps 923:
924: /*
925: * If we're not going to process our children, indicate so here.
926: */
927:
928: switch (type) {
929: case (MDOC_Bullet):
930: /* FALLTHROUGH */
931: case (MDOC_Item):
932: /* FALLTHROUGH */
933: case (MDOC_Dash):
934: /* FALLTHROUGH */
935: case (MDOC_Hyphen):
936: /* FALLTHROUGH */
937: case (MDOC_Enum):
938: if (MDOC_HEAD == node->type)
939: return(0);
940: break;
941: case (MDOC_Column):
942: if (MDOC_BODY == node->type)
943: return(0);
944: break;
945: default:
946: break;
947: }
948:
949: return(1);
950: }
951:
952:
953: /* ARGSUSED */
954: static void
955: termp_it_post(DECL_ARGS)
956: {
957: int type;
958:
959: if (MDOC_BODY != node->type && MDOC_HEAD != node->type)
960: return;
961:
962: type = arg_listtype(node->parent->parent->parent);
963:
964: switch (type) {
965: case (MDOC_Diag):
966: /* FALLTHROUGH */
967: case (MDOC_Item):
968: /* FALLTHROUGH */
969: case (MDOC_Inset):
970: if (MDOC_BODY == node->type)
971: term_flushln(p);
972: break;
973: case (MDOC_Column):
974: if (MDOC_HEAD == node->type)
975: term_flushln(p);
976: break;
977: default:
978: term_flushln(p);
979: break;
980: }
981:
982: p->offset = pair->offset;
983: p->rmargin = pair->rmargin;
984: p->flags = pair->flag;
985: }
986:
987:
988: /* ARGSUSED */
989: static int
990: termp_nm_pre(DECL_ARGS)
991: {
992:
993: if (SEC_SYNOPSIS == node->sec)
994: term_newln(p);
995:
996: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_PROG]);
997: if (NULL == node->child)
998: term_word(p, meta->name);
999:
1000: return(1);
1001: }
1002:
1003:
1004: /* ARGSUSED */
1005: static int
1006: termp_fl_pre(DECL_ARGS)
1007: {
1008:
1009: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD_FLAG]);
1010: term_word(p, "\\-");
1011: p->flags |= TERMP_NOSPACE;
1012: return(1);
1013: }
1014:
1015:
1016: /* ARGSUSED */
1017: static int
1018: termp_ar_pre(DECL_ARGS)
1019: {
1020:
1021: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD_ARG]);
1022: return(1);
1023: }
1024:
1025:
1026: /* ARGSUSED */
1027: static int
1028: termp_ns_pre(DECL_ARGS)
1029: {
1030:
1031: p->flags |= TERMP_NOSPACE;
1032: return(1);
1033: }
1034:
1035:
1036: /* ARGSUSED */
1037: static int
1038: termp_pp_pre(DECL_ARGS)
1039: {
1040:
1041: term_vspace(p);
1042: return(1);
1043: }
1044:
1045:
1046: /* ARGSUSED */
1047: static int
1048: termp_st_pre(DECL_ARGS)
1049: {
1050: const char *cp;
1051:
1052: if (node->child && (cp = mdoc_a2st(node->child->string)))
1053: term_word(p, cp);
1054: return(0);
1055: }
1056:
1057:
1058: /* ARGSUSED */
1059: static int
1060: termp_rs_pre(DECL_ARGS)
1061: {
1062:
1063: if (MDOC_BLOCK == node->type && node->prev)
1064: term_vspace(p);
1065: return(1);
1066: }
1067:
1068:
1069: /* ARGSUSED */
1070: static int
1071: termp_rv_pre(DECL_ARGS)
1072: {
1073: int i;
1074:
1.10 schwarze 1075: /* FIXME: mandated by parser. */
1076:
1.1 kristaps 1077: if (-1 == (i = arg_getattr(MDOC_Std, node)))
1078: errx(1, "expected -std argument");
1079: if (1 != node->args->argv[i].sz)
1080: errx(1, "expected -std argument");
1081:
1082: term_newln(p);
1083: term_word(p, "The");
1084:
1085: p->flags |= ttypes[TTYPE_FUNC_NAME];
1086: term_word(p, *node->args->argv[i].value);
1087: p->flags &= ~ttypes[TTYPE_FUNC_NAME];
1088: p->flags |= TERMP_NOSPACE;
1089:
1090: term_word(p, "() function returns the value 0 if successful;");
1091: term_word(p, "otherwise the value -1 is returned and the");
1092: term_word(p, "global variable");
1093:
1094: p->flags |= ttypes[TTYPE_VAR_DECL];
1095: term_word(p, "errno");
1096: p->flags &= ~ttypes[TTYPE_VAR_DECL];
1097:
1098: term_word(p, "is set to indicate the error.");
1099:
1100: return(1);
1101: }
1102:
1103:
1104: /* ARGSUSED */
1105: static int
1106: termp_ex_pre(DECL_ARGS)
1107: {
1108: int i;
1109:
1.10 schwarze 1110: /* FIXME: mandated by parser? */
1111:
1.1 kristaps 1112: if (-1 == (i = arg_getattr(MDOC_Std, node)))
1113: errx(1, "expected -std argument");
1114: if (1 != node->args->argv[i].sz)
1115: errx(1, "expected -std argument");
1116:
1117: term_word(p, "The");
1118: p->flags |= ttypes[TTYPE_PROG];
1119: term_word(p, *node->args->argv[i].value);
1120: p->flags &= ~ttypes[TTYPE_PROG];
1121: term_word(p, "utility exits 0 on success, and >0 if an error occurs.");
1122:
1123: return(1);
1124: }
1125:
1126:
1127: /* ARGSUSED */
1128: static int
1129: termp_nd_pre(DECL_ARGS)
1130: {
1131:
1132: term_word(p, "\\-");
1133: return(1);
1134: }
1135:
1136:
1137: /* ARGSUSED */
1138: static void
1139: termp_bl_post(DECL_ARGS)
1140: {
1141:
1142: if (MDOC_BLOCK == node->type)
1143: term_newln(p);
1144: }
1145:
1146:
1147: /* ARGSUSED */
1148: static void
1149: termp_op_post(DECL_ARGS)
1150: {
1151:
1152: if (MDOC_BODY != node->type)
1153: return;
1154: p->flags |= TERMP_NOSPACE;
1155: term_word(p, "\\(rB");
1156: }
1157:
1158:
1159: /* ARGSUSED */
1160: static int
1161: termp_xr_pre(DECL_ARGS)
1162: {
1163: const struct mdoc_node *n;
1164:
1.10 schwarze 1165: assert(node->child && MDOC_TEXT == node->child->type);
1166: n = node->child;
1167:
1.1 kristaps 1168: term_word(p, n->string);
1169: if (NULL == (n = n->next))
1170: return(0);
1171: p->flags |= TERMP_NOSPACE;
1172: term_word(p, "(");
1173: p->flags |= TERMP_NOSPACE;
1174: term_word(p, n->string);
1175: p->flags |= TERMP_NOSPACE;
1176: term_word(p, ")");
1177: return(0);
1178: }
1179:
1180:
1181: /* ARGSUSED */
1182: static int
1183: termp_vt_pre(DECL_ARGS)
1184: {
1185:
1186: /* FIXME: this can be "type name". */
1187: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_VAR_DECL]);
1188: return(1);
1189: }
1190:
1191:
1192: /* ARGSUSED */
1193: static void
1194: termp_vt_post(DECL_ARGS)
1195: {
1196:
1197: if (node->sec == SEC_SYNOPSIS)
1198: term_vspace(p);
1199: }
1200:
1201:
1202: /* ARGSUSED */
1203: static int
1204: termp_fd_pre(DECL_ARGS)
1205: {
1206:
1207: /*
1208: * FIXME: this naming is bad. This value is used, in general,
1209: * for the #include header or other preprocessor statement.
1210: */
1211: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FUNC_DECL]);
1212: return(1);
1213: }
1214:
1215:
1216: /* ARGSUSED */
1217: static void
1218: termp_fd_post(DECL_ARGS)
1219: {
1220:
1221: if (node->sec != SEC_SYNOPSIS)
1222: return;
1223: term_newln(p);
1224: if (node->next && MDOC_Fd != node->next->tok)
1225: term_vspace(p);
1226: }
1227:
1228:
1229: /* ARGSUSED */
1230: static int
1231: termp_sh_pre(DECL_ARGS)
1232: {
1233:
1234: switch (node->type) {
1235: case (MDOC_HEAD):
1236: term_vspace(p);
1237: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SECTION]);
1238: break;
1239: case (MDOC_BODY):
1240: p->offset = INDENT;
1241: break;
1242: default:
1243: break;
1244: }
1245: return(1);
1246: }
1247:
1248:
1249: /* ARGSUSED */
1250: static void
1251: termp_sh_post(DECL_ARGS)
1252: {
1253:
1254: switch (node->type) {
1255: case (MDOC_HEAD):
1256: term_newln(p);
1257: break;
1258: case (MDOC_BODY):
1259: term_newln(p);
1260: p->offset = 0;
1261: break;
1262: default:
1263: break;
1264: }
1265: }
1266:
1267:
1268: /* ARGSUSED */
1269: static int
1270: termp_op_pre(DECL_ARGS)
1271: {
1272:
1273: switch (node->type) {
1274: case (MDOC_BODY):
1275: term_word(p, "\\(lB");
1276: p->flags |= TERMP_NOSPACE;
1277: break;
1278: default:
1279: break;
1280: }
1281: return(1);
1282: }
1283:
1284:
1285: /* ARGSUSED */
1286: static int
1287: termp_bt_pre(DECL_ARGS)
1288: {
1289:
1290: term_word(p, "is currently in beta test.");
1291: return(1);
1292: }
1293:
1294:
1295: /* ARGSUSED */
1296: static int
1297: termp_lb_pre(DECL_ARGS)
1298: {
1299: const char *lb;
1300:
1.10 schwarze 1301: assert(node->child && MDOC_TEXT == node->child->type);
1.14 ! schwarze 1302: lb = mdoc_a2lib(node->child->string);
! 1303: if (lb) {
1.1 kristaps 1304: term_word(p, lb);
1305: return(0);
1306: }
1307: term_word(p, "library");
1308: return(1);
1309: }
1310:
1311:
1312: /* ARGSUSED */
1313: static void
1314: termp_lb_post(DECL_ARGS)
1315: {
1316:
1317: term_newln(p);
1318: }
1319:
1320:
1321: /* ARGSUSED */
1322: static int
1323: termp_ud_pre(DECL_ARGS)
1324: {
1325:
1326: term_word(p, "currently under development.");
1327: return(1);
1328: }
1329:
1330:
1331: /* ARGSUSED */
1332: static int
1333: termp_d1_pre(DECL_ARGS)
1334: {
1335:
1336: if (MDOC_BLOCK != node->type)
1337: return(1);
1338: term_newln(p);
1.14 ! schwarze 1339: pair->offset = INDENT + 1;
! 1340: p->offset += pair->offset;
1.1 kristaps 1341: return(1);
1342: }
1343:
1344:
1345: /* ARGSUSED */
1346: static void
1347: termp_d1_post(DECL_ARGS)
1348: {
1349:
1350: if (MDOC_BLOCK != node->type)
1351: return;
1352: term_newln(p);
1353: p->offset -= pair->offset;
1354: }
1355:
1356:
1357: /* ARGSUSED */
1358: static int
1359: termp_aq_pre(DECL_ARGS)
1360: {
1361:
1362: if (MDOC_BODY != node->type)
1363: return(1);
1364: term_word(p, "\\(la");
1365: p->flags |= TERMP_NOSPACE;
1366: return(1);
1367: }
1368:
1369:
1370: /* ARGSUSED */
1371: static void
1372: termp_aq_post(DECL_ARGS)
1373: {
1374:
1375: if (MDOC_BODY != node->type)
1376: return;
1377: p->flags |= TERMP_NOSPACE;
1378: term_word(p, "\\(ra");
1379: }
1380:
1381:
1382: /* ARGSUSED */
1383: static int
1384: termp_ft_pre(DECL_ARGS)
1385: {
1386:
1387: if (SEC_SYNOPSIS == node->sec)
1388: if (node->prev && MDOC_Fo == node->prev->tok)
1389: term_vspace(p);
1390: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FUNC_TYPE]);
1391: return(1);
1392: }
1393:
1394:
1395: /* ARGSUSED */
1396: static void
1397: termp_ft_post(DECL_ARGS)
1398: {
1399:
1400: if (SEC_SYNOPSIS == node->sec)
1401: term_newln(p);
1402: }
1403:
1404:
1405: /* ARGSUSED */
1406: static int
1407: termp_fn_pre(DECL_ARGS)
1408: {
1409: const struct mdoc_node *n;
1410:
1.10 schwarze 1411: assert(node->child && MDOC_TEXT == node->child->type);
1.1 kristaps 1412:
1413: /* FIXME: can be "type funcname" "type varname"... */
1414:
1415: p->flags |= ttypes[TTYPE_FUNC_NAME];
1416: term_word(p, node->child->string);
1417: p->flags &= ~ttypes[TTYPE_FUNC_NAME];
1418:
1419: p->flags |= TERMP_NOSPACE;
1420: term_word(p, "(");
1421:
1422: for (n = node->child->next; n; n = n->next) {
1423: p->flags |= ttypes[TTYPE_FUNC_ARG];
1424: term_word(p, n->string);
1425: p->flags &= ~ttypes[TTYPE_FUNC_ARG];
1426: if (n->next)
1427: term_word(p, ",");
1428: }
1429:
1430: term_word(p, ")");
1431:
1432: if (SEC_SYNOPSIS == node->sec)
1433: term_word(p, ";");
1434:
1435: return(0);
1436: }
1437:
1438:
1439: /* ARGSUSED */
1440: static void
1441: termp_fn_post(DECL_ARGS)
1442: {
1443:
1444: if (node->sec == SEC_SYNOPSIS && node->next)
1445: term_vspace(p);
1446:
1447: }
1448:
1449:
1450: /* ARGSUSED */
1451: static int
1452: termp_sx_pre(DECL_ARGS)
1453: {
1454:
1455: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_LINK]);
1456: return(1);
1457: }
1458:
1459:
1460: /* ARGSUSED */
1461: static int
1462: termp_fa_pre(DECL_ARGS)
1463: {
1464: struct mdoc_node *n;
1465:
1466: if (node->parent->tok != MDOC_Fo) {
1467: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FUNC_ARG]);
1468: return(1);
1469: }
1470:
1471: for (n = node->child; n; n = n->next) {
1472: p->flags |= ttypes[TTYPE_FUNC_ARG];
1473: term_word(p, n->string);
1474: p->flags &= ~ttypes[TTYPE_FUNC_ARG];
1475: if (n->next)
1476: term_word(p, ",");
1477: }
1478:
1479: if (node->child && node->next && node->next->tok == MDOC_Fa)
1480: term_word(p, ",");
1481:
1482: return(0);
1483: }
1484:
1485:
1486: /* ARGSUSED */
1487: static int
1488: termp_va_pre(DECL_ARGS)
1489: {
1490:
1491: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_VAR_DECL]);
1492: return(1);
1493: }
1494:
1495:
1496: /* ARGSUSED */
1497: static int
1498: termp_bd_pre(DECL_ARGS)
1499: {
1500: int i, type, ln;
1501:
1502: /*
1503: * This is fairly tricky due primarily to crappy documentation.
1504: * If -ragged or -filled are specified, the block does nothing
1505: * but change the indentation.
1506: *
1507: * If, on the other hand, -unfilled or -literal are specified,
1508: * then the game changes. Text is printed exactly as entered in
1509: * the display: if a macro line, a newline is appended to the
1510: * line. Blank lines are allowed.
1511: */
1512:
1513: if (MDOC_BLOCK == node->type)
1514: return(fmt_block_vspace(p, node, node));
1515: else if (MDOC_BODY != node->type)
1516: return(1);
1517:
1.10 schwarze 1518: /* FIXME: display type should be mandated by parser. */
1519:
1.1 kristaps 1520: if (NULL == node->parent->args)
1521: errx(1, "missing display type");
1522:
1523: pair->offset = p->offset;
1524:
1525: for (type = -1, i = 0;
1526: i < (int)node->parent->args->argc; i++) {
1527: switch (node->parent->args->argv[i].arg) {
1528: case (MDOC_Ragged):
1529: /* FALLTHROUGH */
1530: case (MDOC_Filled):
1531: /* FALLTHROUGH */
1532: case (MDOC_Unfilled):
1533: /* FALLTHROUGH */
1534: case (MDOC_Literal):
1535: type = node->parent->args->argv[i].arg;
1536: i = (int)node->parent->args->argc;
1537: break;
1538: default:
1539: break;
1540: }
1541: }
1542:
1543: if (NULL == node->parent->args)
1544: errx(1, "missing display type");
1545:
1546: i = arg_getattr(MDOC_Offset, node->parent);
1547: if (-1 != i) {
1548: if (1 != node->parent->args->argv[i].sz)
1549: errx(1, "expected single value");
1550: p->offset += arg_offset(&node->parent->args->argv[i]);
1551: }
1552:
1553: switch (type) {
1554: case (MDOC_Literal):
1555: /* FALLTHROUGH */
1556: case (MDOC_Unfilled):
1557: break;
1558: default:
1559: return(1);
1560: }
1561:
1562: /*
1563: * Tricky. Iterate through all children. If we're on a
1564: * different parse line, append a newline and then the contents.
1565: * Ew.
1566: */
1567:
1568: p->flags |= TERMP_LITERAL;
1569: ln = node->child ? node->child->line : 0;
1570:
1571: for (node = node->child; node; node = node->next) {
1572: if (ln < node->line) {
1573: term_flushln(p);
1574: p->flags |= TERMP_NOSPACE;
1575: }
1576: ln = node->line;
1577: print_node(p, pair, meta, node);
1578: }
1579:
1580: return(0);
1581: }
1582:
1583:
1584: /* ARGSUSED */
1585: static void
1586: termp_bd_post(DECL_ARGS)
1587: {
1588:
1589: if (MDOC_BODY != node->type)
1590: return;
1591:
1592: term_flushln(p);
1593: p->flags &= ~TERMP_LITERAL;
1594: p->offset = pair->offset;
1595: p->flags |= TERMP_NOSPACE;
1596: }
1597:
1598:
1599: /* ARGSUSED */
1600: static int
1601: termp_qq_pre(DECL_ARGS)
1602: {
1603:
1604: if (MDOC_BODY != node->type)
1605: return(1);
1606: term_word(p, "\"");
1607: p->flags |= TERMP_NOSPACE;
1608: return(1);
1609: }
1610:
1611:
1612: /* ARGSUSED */
1613: static void
1614: termp_qq_post(DECL_ARGS)
1615: {
1616:
1617: if (MDOC_BODY != node->type)
1618: return;
1619: p->flags |= TERMP_NOSPACE;
1620: term_word(p, "\"");
1621: }
1622:
1623:
1624: /* ARGSUSED */
1625: static int
1626: termp_bsx_pre(DECL_ARGS)
1627: {
1628:
1629: term_word(p, "BSDI BSD/OS");
1630: return(1);
1631: }
1632:
1633:
1634: /* ARGSUSED */
1635: static void
1636: termp_bx_post(DECL_ARGS)
1637: {
1638:
1639: if (node->child)
1640: p->flags |= TERMP_NOSPACE;
1641: term_word(p, "BSD");
1642: }
1643:
1644:
1645: /* ARGSUSED */
1646: static int
1647: termp_ox_pre(DECL_ARGS)
1648: {
1649:
1650: term_word(p, "OpenBSD");
1651: return(1);
1652: }
1653:
1654:
1655: /* ARGSUSED */
1656: static int
1657: termp_dx_pre(DECL_ARGS)
1658: {
1659:
1660: term_word(p, "DragonFly");
1661: return(1);
1662: }
1663:
1664:
1665: /* ARGSUSED */
1666: static int
1667: termp_ux_pre(DECL_ARGS)
1668: {
1669:
1670: term_word(p, "UNIX");
1671: return(1);
1672: }
1673:
1674:
1675: /* ARGSUSED */
1676: static int
1677: termp_fx_pre(DECL_ARGS)
1678: {
1679:
1680: term_word(p, "FreeBSD");
1681: return(1);
1682: }
1683:
1684:
1685: /* ARGSUSED */
1686: static int
1687: termp_nx_pre(DECL_ARGS)
1688: {
1689:
1690: term_word(p, "NetBSD");
1691: return(1);
1692: }
1693:
1694:
1695: /* ARGSUSED */
1696: static int
1697: termp_sq_pre(DECL_ARGS)
1698: {
1699:
1700: if (MDOC_BODY != node->type)
1701: return(1);
1702: term_word(p, "\\(oq");
1703: p->flags |= TERMP_NOSPACE;
1704: return(1);
1705: }
1706:
1707:
1708: /* ARGSUSED */
1709: static void
1710: termp_sq_post(DECL_ARGS)
1711: {
1712:
1713: if (MDOC_BODY != node->type)
1714: return;
1715: p->flags |= TERMP_NOSPACE;
1716: term_word(p, "\\(aq");
1717: }
1718:
1719:
1720: /* ARGSUSED */
1721: static int
1722: termp_pf_pre(DECL_ARGS)
1723: {
1724:
1725: p->flags |= TERMP_IGNDELIM;
1726: return(1);
1727: }
1728:
1729:
1730: /* ARGSUSED */
1731: static void
1732: termp_pf_post(DECL_ARGS)
1733: {
1734:
1735: p->flags &= ~TERMP_IGNDELIM;
1736: p->flags |= TERMP_NOSPACE;
1737: }
1738:
1739:
1740: /* ARGSUSED */
1741: static int
1742: termp_ss_pre(DECL_ARGS)
1743: {
1744:
1745: switch (node->type) {
1746: case (MDOC_BLOCK):
1747: term_newln(p);
1748: if (node->prev)
1749: term_vspace(p);
1750: break;
1751: case (MDOC_HEAD):
1752: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SSECTION]);
1.3 schwarze 1753: p->offset = HALFINDENT;
1.1 kristaps 1754: break;
1755: default:
1756: break;
1757: }
1758:
1759: return(1);
1760: }
1761:
1762:
1763: /* ARGSUSED */
1764: static void
1765: termp_ss_post(DECL_ARGS)
1766: {
1767:
1768: switch (node->type) {
1769: case (MDOC_HEAD):
1770: term_newln(p);
1771: p->offset = INDENT;
1772: break;
1773: default:
1774: break;
1775: }
1776: }
1777:
1778:
1779: /* ARGSUSED */
1780: static int
1781: termp_pa_pre(DECL_ARGS)
1782: {
1783:
1784: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FILE]);
1785: return(1);
1786: }
1787:
1788:
1789: /* ARGSUSED */
1790: static int
1791: termp_em_pre(DECL_ARGS)
1792: {
1793:
1794: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]);
1795: return(1);
1796: }
1797:
1798:
1799: /* ARGSUSED */
1800: static int
1801: termp_cd_pre(DECL_ARGS)
1802: {
1803:
1804: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CONFIG]);
1805: term_newln(p);
1806: return(1);
1807: }
1808:
1809:
1810: /* ARGSUSED */
1811: static int
1812: termp_cm_pre(DECL_ARGS)
1813: {
1814:
1815: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD_FLAG]);
1816: return(1);
1817: }
1818:
1819:
1820: /* ARGSUSED */
1821: static int
1822: termp_ic_pre(DECL_ARGS)
1823: {
1824:
1825: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD]);
1826: return(1);
1827: }
1828:
1829:
1830: /* ARGSUSED */
1831: static int
1832: termp_in_pre(DECL_ARGS)
1833: {
1834:
1835: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_INCLUDE]);
1836: term_word(p, "#include");
1837: term_word(p, "<");
1838: p->flags |= TERMP_NOSPACE;
1839: return(1);
1840: }
1841:
1842:
1843: /* ARGSUSED */
1844: static void
1845: termp_in_post(DECL_ARGS)
1846: {
1847:
1848: p->flags |= TERMP_NOSPACE;
1849: term_word(p, ">");
1850:
1851: term_newln(p);
1852: if (SEC_SYNOPSIS != node->sec)
1853: return;
1854: if (node->next && MDOC_In != node->next->tok)
1855: term_vspace(p);
1856: }
1857:
1858:
1859: /* ARGSUSED */
1860: static int
1861: termp_at_pre(DECL_ARGS)
1862: {
1863: const char *att;
1864:
1865: att = NULL;
1866:
1867: if (node->child)
1868: att = mdoc_a2att(node->child->string);
1869: if (NULL == att)
1870: att = "AT&T UNIX";
1871:
1872: term_word(p, att);
1873: return(0);
1874: }
1875:
1876:
1877: /* ARGSUSED */
1878: static int
1879: termp_brq_pre(DECL_ARGS)
1880: {
1881:
1882: if (MDOC_BODY != node->type)
1883: return(1);
1884: term_word(p, "\\(lC");
1885: p->flags |= TERMP_NOSPACE;
1886: return(1);
1887: }
1888:
1889:
1890: /* ARGSUSED */
1891: static void
1892: termp_brq_post(DECL_ARGS)
1893: {
1894:
1895: if (MDOC_BODY != node->type)
1896: return;
1897: p->flags |= TERMP_NOSPACE;
1898: term_word(p, "\\(rC");
1899: }
1900:
1901:
1902: /* ARGSUSED */
1903: static int
1904: termp_bq_pre(DECL_ARGS)
1905: {
1906:
1907: if (MDOC_BODY != node->type)
1908: return(1);
1909: term_word(p, "\\(lB");
1910: p->flags |= TERMP_NOSPACE;
1911: return(1);
1912: }
1913:
1914:
1915: /* ARGSUSED */
1916: static void
1917: termp_bq_post(DECL_ARGS)
1918: {
1919:
1920: if (MDOC_BODY != node->type)
1921: return;
1922: p->flags |= TERMP_NOSPACE;
1923: term_word(p, "\\(rB");
1924: }
1925:
1926:
1927: /* ARGSUSED */
1928: static int
1929: termp_pq_pre(DECL_ARGS)
1930: {
1931:
1932: if (MDOC_BODY != node->type)
1933: return(1);
1934: term_word(p, "\\&(");
1935: p->flags |= TERMP_NOSPACE;
1936: return(1);
1937: }
1938:
1939:
1940: /* ARGSUSED */
1941: static void
1942: termp_pq_post(DECL_ARGS)
1943: {
1944:
1945: if (MDOC_BODY != node->type)
1946: return;
1947: term_word(p, ")");
1948: }
1949:
1950:
1951: /* ARGSUSED */
1952: static int
1953: termp_fo_pre(DECL_ARGS)
1954: {
1955: const struct mdoc_node *n;
1956:
1957: if (MDOC_BODY == node->type) {
1958: term_word(p, "(");
1959: p->flags |= TERMP_NOSPACE;
1960: return(1);
1961: } else if (MDOC_HEAD != node->type)
1962: return(1);
1963:
1964: /* XXX - groff shows only first parameter */
1965:
1966: p->flags |= ttypes[TTYPE_FUNC_NAME];
1967: for (n = node->child; n; n = n->next) {
1.10 schwarze 1968: assert(MDOC_TEXT == n->type);
1.1 kristaps 1969: term_word(p, n->string);
1970: }
1971: p->flags &= ~ttypes[TTYPE_FUNC_NAME];
1972:
1973: return(0);
1974: }
1975:
1976:
1977: /* ARGSUSED */
1978: static void
1979: termp_fo_post(DECL_ARGS)
1980: {
1981:
1982: if (MDOC_BODY != node->type)
1983: return;
1984: p->flags |= TERMP_NOSPACE;
1985: term_word(p, ")");
1986: p->flags |= TERMP_NOSPACE;
1987: term_word(p, ";");
1988: term_newln(p);
1989: }
1990:
1991:
1992: /* ARGSUSED */
1993: static int
1994: termp_bf_pre(DECL_ARGS)
1995: {
1996: const struct mdoc_node *n;
1997:
1998: if (MDOC_HEAD == node->type) {
1999: return(0);
2000: } else if (MDOC_BLOCK != node->type)
2001: return(1);
2002:
2003: if (NULL == (n = node->head->child)) {
2004: if (arg_hasattr(MDOC_Emphasis, node))
2005: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]);
2006: else if (arg_hasattr(MDOC_Symbolic, node))
2007: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMB]);
2008:
2009: return(1);
2010: }
2011:
1.10 schwarze 2012: assert(MDOC_TEXT == n->type);
1.1 kristaps 2013: if (0 == strcmp("Em", n->string))
2014: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]);
2015: else if (0 == strcmp("Sy", n->string))
2016: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]);
2017:
2018: return(1);
2019: }
2020:
2021:
2022: /* ARGSUSED */
2023: static int
2024: termp_sy_pre(DECL_ARGS)
2025: {
2026:
2027: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMB]);
2028: return(1);
2029: }
2030:
2031:
2032: /* ARGSUSED */
2033: static int
2034: termp_ms_pre(DECL_ARGS)
2035: {
2036:
2037: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMBOL]);
2038: return(1);
2039: }
2040:
2041:
2042:
2043: /* ARGSUSED */
2044: static int
2045: termp_sm_pre(DECL_ARGS)
2046: {
2047:
1.10 schwarze 2048: assert(node->child && MDOC_TEXT == node->child->type);
1.1 kristaps 2049: if (0 == strcmp("on", node->child->string)) {
2050: p->flags &= ~TERMP_NONOSPACE;
2051: p->flags &= ~TERMP_NOSPACE;
2052: } else
2053: p->flags |= TERMP_NONOSPACE;
2054:
2055: return(0);
2056: }
2057:
2058:
2059: /* ARGSUSED */
2060: static int
2061: termp_ap_pre(DECL_ARGS)
2062: {
2063:
2064: p->flags |= TERMP_NOSPACE;
2065: term_word(p, "\\(aq");
2066: p->flags |= TERMP_NOSPACE;
2067: return(1);
2068: }
2069:
2070:
2071: /* ARGSUSED */
2072: static int
2073: termp__j_pre(DECL_ARGS)
2074: {
2075:
2076: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_REF_JOURNAL]);
2077: return(1);
2078: }
2079:
2080:
2081: /* ARGSUSED */
2082: static int
2083: termp__t_pre(DECL_ARGS)
2084: {
2085:
2086: term_word(p, "\"");
2087: p->flags |= TERMP_NOSPACE;
2088: return(1);
2089: }
2090:
2091:
2092: /* ARGSUSED */
2093: static void
2094: termp__t_post(DECL_ARGS)
2095: {
2096:
2097: p->flags |= TERMP_NOSPACE;
2098: term_word(p, "\"");
2099: termp____post(p, pair, meta, node);
2100: }
2101:
2102:
2103: /* ARGSUSED */
2104: static void
2105: termp____post(DECL_ARGS)
2106: {
2107:
2108: p->flags |= TERMP_NOSPACE;
2109: term_word(p, node->next ? "," : ".");
2110: }
2111:
2112:
2113: /* ARGSUSED */
2114: static int
2115: termp_lk_pre(DECL_ARGS)
2116: {
2117: const struct mdoc_node *n;
2118:
1.6 schwarze 2119: assert(node->child);
2120: n = node->child;
2121:
2122: if (NULL == n->next) {
2123: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_LINK_ANCHOR]);
2124: return(1);
2125: }
1.1 kristaps 2126:
2127: p->flags |= ttypes[TTYPE_LINK_ANCHOR];
2128: term_word(p, n->string);
2129: p->flags |= TERMP_NOSPACE;
2130: term_word(p, ":");
1.6 schwarze 2131: p->flags &= ~ttypes[TTYPE_LINK_ANCHOR];
1.1 kristaps 2132:
2133: p->flags |= ttypes[TTYPE_LINK_TEXT];
1.6 schwarze 2134: for (n = n->next; n; n = n->next)
1.1 kristaps 2135: term_word(p, n->string);
1.6 schwarze 2136:
1.1 kristaps 2137: p->flags &= ~ttypes[TTYPE_LINK_TEXT];
2138: return(0);
2139: }
2140:
2141:
2142: /* ARGSUSED */
2143: static int
2144: termp_mt_pre(DECL_ARGS)
2145: {
2146:
2147: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_LINK_ANCHOR]);
2148: return(1);
2149: }
2150:
2151: