Annotation of src/usr.bin/mandoc/mdoc_term.c, Revision 1.18
1.18 ! schwarze 1: /* $Id: mdoc_term.c,v 1.17 2009/06/27 12:04:45 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) {
1.15 schwarze 543: if ('n' == arg->value[pos][len - 1] ||
544: 'm' == arg->value[pos][len - 1]) {
1.1 kristaps 545: v = (size_t)atoi(arg->value[pos]);
1.18 ! schwarze 546: return(v + 2);
1.1 kristaps 547: }
548:
549: }
1.18 ! schwarze 550: return(strlen(arg->value[pos]) + 2);
1.1 kristaps 551: }
552:
553:
554: static int
555: arg_listtype(const struct mdoc_node *n)
556: {
557: int i, len;
558:
559: assert(MDOC_BLOCK == n->type);
560:
561: len = (int)(n->args ? n->args->argc : 0);
562:
563: for (i = 0; i < len; i++)
564: switch (n->args->argv[i].arg) {
565: case (MDOC_Bullet):
566: /* FALLTHROUGH */
567: case (MDOC_Dash):
568: /* FALLTHROUGH */
569: case (MDOC_Enum):
570: /* FALLTHROUGH */
571: case (MDOC_Hyphen):
572: /* FALLTHROUGH */
573: case (MDOC_Tag):
574: /* FALLTHROUGH */
575: case (MDOC_Inset):
576: /* FALLTHROUGH */
577: case (MDOC_Diag):
578: /* FALLTHROUGH */
579: case (MDOC_Item):
580: /* FALLTHROUGH */
581: case (MDOC_Column):
582: /* FALLTHROUGH */
583: case (MDOC_Ohang):
584: return(n->args->argv[i].arg);
585: default:
586: break;
587: }
588:
1.10 schwarze 589: /* FIXME: mandated by parser. */
590:
1.1 kristaps 591: errx(1, "list type not supported");
592: /* NOTREACHED */
593: }
594:
595:
596: static size_t
597: arg_offset(const struct mdoc_argv *arg)
598: {
599:
600: assert(*arg->value);
1.9 schwarze 601: if (0 == strcmp(*arg->value, "left"))
602: return(0);
1.1 kristaps 603: if (0 == strcmp(*arg->value, "indent"))
1.17 schwarze 604: return(INDENT + 1);
1.1 kristaps 605: if (0 == strcmp(*arg->value, "indent-two"))
606: return(INDENT * 2);
1.10 schwarze 607:
608: /* FIXME: needs to support field-widths (10n, etc.). */
609:
1.1 kristaps 610: return(strlen(*arg->value));
611: }
612:
613:
614: static int
615: arg_hasattr(int arg, const struct mdoc_node *n)
616: {
617:
618: return(-1 != arg_getattr(arg, n));
619: }
620:
621:
622: static int
623: arg_getattr(int v, const struct mdoc_node *n)
624: {
625: int val;
626:
627: return(arg_getattrs(&v, &val, 1, n) ? val : -1);
628: }
629:
630:
631: static int
632: arg_getattrs(const int *keys, int *vals,
633: size_t sz, const struct mdoc_node *n)
634: {
635: int i, j, k;
636:
637: if (NULL == n->args)
638: return(0);
639:
640: for (k = i = 0; i < (int)n->args->argc; i++)
641: for (j = 0; j < (int)sz; j++)
642: if (n->args->argv[i].arg == keys[j]) {
643: vals[j] = i;
644: k++;
645: }
646: return(k);
647: }
648:
649:
650: /* ARGSUSED */
651: static int
652: fmt_block_vspace(struct termp *p,
653: const struct mdoc_node *bl,
654: const struct mdoc_node *node)
655: {
656: const struct mdoc_node *n;
657:
658: term_newln(p);
659:
660: if (arg_hasattr(MDOC_Compact, bl))
661: return(1);
662:
663: for (n = node; n; n = n->parent) {
664: if (MDOC_BLOCK != n->type)
665: continue;
666: if (MDOC_Ss == n->tok)
667: break;
668: if (MDOC_Sh == n->tok)
669: break;
670: if (NULL == n->prev)
671: continue;
672: term_vspace(p);
673: break;
674: }
675:
676: return(1);
677: }
678:
679:
680: /* ARGSUSED */
681: static int
682: termp_dq_pre(DECL_ARGS)
683: {
684:
685: if (MDOC_BODY != node->type)
686: return(1);
687:
688: term_word(p, "\\(lq");
689: p->flags |= TERMP_NOSPACE;
690: return(1);
691: }
692:
693:
694: /* ARGSUSED */
695: static void
696: termp_dq_post(DECL_ARGS)
697: {
698:
699: if (MDOC_BODY != node->type)
700: return;
701:
702: p->flags |= TERMP_NOSPACE;
703: term_word(p, "\\(rq");
704: }
705:
706:
707: /* ARGSUSED */
708: static int
709: termp_it_pre(DECL_ARGS)
710: {
711: const struct mdoc_node *bl, *n;
712: char buf[7];
1.12 schwarze 713: int i, type, keys[3], vals[3], sv;
1.1 kristaps 714: size_t width, offset;
715:
716: if (MDOC_BLOCK == node->type)
717: return(fmt_block_vspace(p, node->parent->parent, node));
718:
719: bl = node->parent->parent->parent;
720:
721: /* Save parent attributes. */
722:
723: pair->offset = p->offset;
724: pair->rmargin = p->rmargin;
725: pair->flag = p->flags;
726:
727: /* Get list width and offset. */
728:
729: keys[0] = MDOC_Width;
730: keys[1] = MDOC_Offset;
731: keys[2] = MDOC_Column;
732:
733: vals[0] = vals[1] = vals[2] = -1;
734:
735: width = offset = 0;
736:
737: (void)arg_getattrs(keys, vals, 3, bl);
738:
739: type = arg_listtype(bl);
740:
741: /* Calculate real width and offset. */
742:
743: switch (type) {
744: case (MDOC_Column):
745: if (MDOC_BODY == node->type)
746: break;
747: for (i = 0, n = node->prev; n; n = n->prev, i++)
748: offset += arg_width
749: (&bl->args->argv[vals[2]], i);
750: assert(i < (int)bl->args->argv[vals[2]].sz);
751: width = arg_width(&bl->args->argv[vals[2]], i);
752: if (vals[1] >= 0)
753: offset += arg_offset(&bl->args->argv[vals[1]]);
754: break;
755: default:
756: if (vals[0] >= 0)
757: width = arg_width(&bl->args->argv[vals[0]], 0);
758: if (vals[1] >= 0)
759: offset = arg_offset(&bl->args->argv[vals[1]]);
760: break;
761: }
762:
763: /*
764: * List-type can override the width in the case of fixed-head
765: * values (bullet, dash/hyphen, enum). Tags need a non-zero
766: * offset.
767: */
768:
769: switch (type) {
770: case (MDOC_Bullet):
771: /* FALLTHROUGH */
772: case (MDOC_Dash):
773: /* FALLTHROUGH */
774: case (MDOC_Enum):
775: /* FALLTHROUGH */
776: case (MDOC_Hyphen):
777: if (width < 4)
778: width = 4;
779: break;
780: case (MDOC_Tag):
781: if (0 == width)
782: width = 10;
783: break;
784: default:
785: break;
786: }
787:
788: /*
1.16 schwarze 789: * Whitespace control. Inset bodies need an initial space,
790: * while diagonal bodies need two.
1.1 kristaps 791: */
792:
793: switch (type) {
794: case (MDOC_Diag):
1.16 schwarze 795: term_word(p, "\\ ");
1.1 kristaps 796: /* FALLTHROUGH */
797: case (MDOC_Inset):
798: if (MDOC_BODY == node->type)
799: p->flags &= ~TERMP_NOSPACE;
800: else
801: p->flags |= TERMP_NOSPACE;
802: break;
803: default:
804: p->flags |= TERMP_NOSPACE;
805: break;
806: }
807:
808: /*
809: * Style flags. Diagnostic heads need TTYPE_DIAG.
810: */
811:
812: switch (type) {
813: case (MDOC_Diag):
814: if (MDOC_HEAD == node->type)
815: p->flags |= ttypes[TTYPE_DIAG];
816: break;
817: default:
818: break;
819: }
820:
821: /*
822: * Pad and break control. This is the tricker part. Lists with
823: * set right-margins for the head get TERMP_NOBREAK because, if
824: * they overrun the margin, they wrap to the new margin.
825: * Correspondingly, the body for these types don't left-pad, as
826: * the head will pad out to to the right.
827: */
828:
829: switch (type) {
830: case (MDOC_Bullet):
831: /* FALLTHROUGH */
832: case (MDOC_Dash):
833: /* FALLTHROUGH */
834: case (MDOC_Enum):
835: /* FALLTHROUGH */
836: case (MDOC_Hyphen):
837: /* FALLTHROUGH */
838: case (MDOC_Tag):
839: if (MDOC_HEAD == node->type)
840: p->flags |= TERMP_NOBREAK;
841: else
842: p->flags |= TERMP_NOLPAD;
843: if (MDOC_HEAD == node->type && MDOC_Tag == type)
844: if (NULL == node->next ||
845: NULL == node->next->child)
846: p->flags |= TERMP_NONOBREAK;
847: break;
848: case (MDOC_Column):
849: if (MDOC_HEAD == node->type) {
850: assert(node->next);
851: if (MDOC_BODY == node->next->type)
852: p->flags &= ~TERMP_NOBREAK;
853: else
854: p->flags |= TERMP_NOBREAK;
855: if (node->prev)
856: p->flags |= TERMP_NOLPAD;
857: }
858: break;
859: case (MDOC_Diag):
860: if (MDOC_HEAD == node->type)
861: p->flags |= TERMP_NOBREAK;
862: break;
863: default:
864: break;
865: }
866:
867: /*
868: * Margin control. Set-head-width lists have their right
869: * margins shortened. The body for these lists has the offset
870: * necessarily lengthened. Everybody gets the offset.
871: */
872:
873: p->offset += offset;
874:
875: switch (type) {
876: case (MDOC_Bullet):
877: /* FALLTHROUGH */
878: case (MDOC_Dash):
879: /* FALLTHROUGH */
880: case (MDOC_Enum):
881: /* FALLTHROUGH */
882: case (MDOC_Hyphen):
883: /* FALLTHROUGH */
884: case (MDOC_Tag):
885: if (MDOC_HEAD == node->type)
886: p->rmargin = p->offset + width;
887: else
888: p->offset += width;
889: break;
890: case (MDOC_Column):
891: p->rmargin = p->offset + width;
892: break;
893: default:
894: break;
895: }
896:
897: /*
898: * The dash, hyphen, bullet and enum lists all have a special
1.12 schwarze 899: * HEAD character (temporarily bold, in some cases).
1.1 kristaps 900: */
901:
1.12 schwarze 902: sv = p->flags;
1.1 kristaps 903: if (MDOC_HEAD == node->type)
904: switch (type) {
905: case (MDOC_Bullet):
1.12 schwarze 906: p->flags |= TERMP_BOLD;
1.1 kristaps 907: term_word(p, "\\[bu]");
908: break;
909: case (MDOC_Dash):
910: /* FALLTHROUGH */
911: case (MDOC_Hyphen):
1.12 schwarze 912: p->flags |= TERMP_BOLD;
1.1 kristaps 913: term_word(p, "\\-");
914: break;
915: case (MDOC_Enum):
916: (pair->ppair->ppair->count)++;
917: (void)snprintf(buf, sizeof(buf), "%d.",
918: pair->ppair->ppair->count);
919: term_word(p, buf);
920: break;
921: default:
922: break;
923: }
1.12 schwarze 924:
925: p->flags = sv; /* Restore saved flags. */
1.1 kristaps 926:
927: /*
928: * If we're not going to process our children, indicate so here.
929: */
930:
931: switch (type) {
932: case (MDOC_Bullet):
933: /* FALLTHROUGH */
934: case (MDOC_Item):
935: /* FALLTHROUGH */
936: case (MDOC_Dash):
937: /* FALLTHROUGH */
938: case (MDOC_Hyphen):
939: /* FALLTHROUGH */
940: case (MDOC_Enum):
941: if (MDOC_HEAD == node->type)
942: return(0);
943: break;
944: case (MDOC_Column):
945: if (MDOC_BODY == node->type)
946: return(0);
947: break;
948: default:
949: break;
950: }
951:
952: return(1);
953: }
954:
955:
956: /* ARGSUSED */
957: static void
958: termp_it_post(DECL_ARGS)
959: {
960: int type;
961:
962: if (MDOC_BODY != node->type && MDOC_HEAD != node->type)
963: return;
964:
965: type = arg_listtype(node->parent->parent->parent);
966:
967: switch (type) {
968: case (MDOC_Diag):
969: /* FALLTHROUGH */
970: case (MDOC_Item):
971: /* FALLTHROUGH */
972: case (MDOC_Inset):
973: if (MDOC_BODY == node->type)
974: term_flushln(p);
975: break;
976: case (MDOC_Column):
977: if (MDOC_HEAD == node->type)
978: term_flushln(p);
979: break;
980: default:
981: term_flushln(p);
982: break;
983: }
984:
985: p->offset = pair->offset;
986: p->rmargin = pair->rmargin;
987: p->flags = pair->flag;
988: }
989:
990:
991: /* ARGSUSED */
992: static int
993: termp_nm_pre(DECL_ARGS)
994: {
995:
996: if (SEC_SYNOPSIS == node->sec)
997: term_newln(p);
998:
999: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_PROG]);
1000: if (NULL == node->child)
1001: term_word(p, meta->name);
1002:
1003: return(1);
1004: }
1005:
1006:
1007: /* ARGSUSED */
1008: static int
1009: termp_fl_pre(DECL_ARGS)
1010: {
1011:
1012: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD_FLAG]);
1013: term_word(p, "\\-");
1014: p->flags |= TERMP_NOSPACE;
1015: return(1);
1016: }
1017:
1018:
1019: /* ARGSUSED */
1020: static int
1021: termp_ar_pre(DECL_ARGS)
1022: {
1023:
1024: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD_ARG]);
1025: return(1);
1026: }
1027:
1028:
1029: /* ARGSUSED */
1030: static int
1031: termp_ns_pre(DECL_ARGS)
1032: {
1033:
1034: p->flags |= TERMP_NOSPACE;
1035: return(1);
1036: }
1037:
1038:
1039: /* ARGSUSED */
1040: static int
1041: termp_pp_pre(DECL_ARGS)
1042: {
1043:
1044: term_vspace(p);
1045: return(1);
1046: }
1047:
1048:
1049: /* ARGSUSED */
1050: static int
1051: termp_st_pre(DECL_ARGS)
1052: {
1053: const char *cp;
1054:
1055: if (node->child && (cp = mdoc_a2st(node->child->string)))
1056: term_word(p, cp);
1057: return(0);
1058: }
1059:
1060:
1061: /* ARGSUSED */
1062: static int
1063: termp_rs_pre(DECL_ARGS)
1064: {
1065:
1066: if (MDOC_BLOCK == node->type && node->prev)
1067: term_vspace(p);
1068: return(1);
1069: }
1070:
1071:
1072: /* ARGSUSED */
1073: static int
1074: termp_rv_pre(DECL_ARGS)
1075: {
1076: int i;
1077:
1.10 schwarze 1078: /* FIXME: mandated by parser. */
1079:
1.1 kristaps 1080: if (-1 == (i = arg_getattr(MDOC_Std, node)))
1081: errx(1, "expected -std argument");
1082: if (1 != node->args->argv[i].sz)
1083: errx(1, "expected -std argument");
1084:
1085: term_newln(p);
1086: term_word(p, "The");
1087:
1088: p->flags |= ttypes[TTYPE_FUNC_NAME];
1089: term_word(p, *node->args->argv[i].value);
1090: p->flags &= ~ttypes[TTYPE_FUNC_NAME];
1091: p->flags |= TERMP_NOSPACE;
1092:
1093: term_word(p, "() function returns the value 0 if successful;");
1094: term_word(p, "otherwise the value -1 is returned and the");
1095: term_word(p, "global variable");
1096:
1097: p->flags |= ttypes[TTYPE_VAR_DECL];
1098: term_word(p, "errno");
1099: p->flags &= ~ttypes[TTYPE_VAR_DECL];
1100:
1101: term_word(p, "is set to indicate the error.");
1102:
1103: return(1);
1104: }
1105:
1106:
1107: /* ARGSUSED */
1108: static int
1109: termp_ex_pre(DECL_ARGS)
1110: {
1111: int i;
1112:
1.10 schwarze 1113: /* FIXME: mandated by parser? */
1114:
1.1 kristaps 1115: if (-1 == (i = arg_getattr(MDOC_Std, node)))
1116: errx(1, "expected -std argument");
1117: if (1 != node->args->argv[i].sz)
1118: errx(1, "expected -std argument");
1119:
1120: term_word(p, "The");
1121: p->flags |= ttypes[TTYPE_PROG];
1122: term_word(p, *node->args->argv[i].value);
1123: p->flags &= ~ttypes[TTYPE_PROG];
1124: term_word(p, "utility exits 0 on success, and >0 if an error occurs.");
1125:
1126: return(1);
1127: }
1128:
1129:
1130: /* ARGSUSED */
1131: static int
1132: termp_nd_pre(DECL_ARGS)
1133: {
1134:
1135: term_word(p, "\\-");
1136: return(1);
1137: }
1138:
1139:
1140: /* ARGSUSED */
1141: static void
1142: termp_bl_post(DECL_ARGS)
1143: {
1144:
1145: if (MDOC_BLOCK == node->type)
1146: term_newln(p);
1147: }
1148:
1149:
1150: /* ARGSUSED */
1151: static void
1152: termp_op_post(DECL_ARGS)
1153: {
1154:
1155: if (MDOC_BODY != node->type)
1156: return;
1157: p->flags |= TERMP_NOSPACE;
1158: term_word(p, "\\(rB");
1159: }
1160:
1161:
1162: /* ARGSUSED */
1163: static int
1164: termp_xr_pre(DECL_ARGS)
1165: {
1166: const struct mdoc_node *n;
1167:
1.10 schwarze 1168: assert(node->child && MDOC_TEXT == node->child->type);
1169: n = node->child;
1170:
1.1 kristaps 1171: term_word(p, n->string);
1172: if (NULL == (n = n->next))
1173: return(0);
1174: p->flags |= TERMP_NOSPACE;
1175: term_word(p, "(");
1176: p->flags |= TERMP_NOSPACE;
1177: term_word(p, n->string);
1178: p->flags |= TERMP_NOSPACE;
1179: term_word(p, ")");
1180: return(0);
1181: }
1182:
1183:
1184: /* ARGSUSED */
1185: static int
1186: termp_vt_pre(DECL_ARGS)
1187: {
1188:
1189: /* FIXME: this can be "type name". */
1190: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_VAR_DECL]);
1191: return(1);
1192: }
1193:
1194:
1195: /* ARGSUSED */
1196: static void
1197: termp_vt_post(DECL_ARGS)
1198: {
1199:
1200: if (node->sec == SEC_SYNOPSIS)
1201: term_vspace(p);
1202: }
1203:
1204:
1205: /* ARGSUSED */
1206: static int
1207: termp_fd_pre(DECL_ARGS)
1208: {
1209:
1210: /*
1211: * FIXME: this naming is bad. This value is used, in general,
1212: * for the #include header or other preprocessor statement.
1213: */
1214: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FUNC_DECL]);
1215: return(1);
1216: }
1217:
1218:
1219: /* ARGSUSED */
1220: static void
1221: termp_fd_post(DECL_ARGS)
1222: {
1223:
1224: if (node->sec != SEC_SYNOPSIS)
1225: return;
1226: term_newln(p);
1227: if (node->next && MDOC_Fd != node->next->tok)
1228: term_vspace(p);
1229: }
1230:
1231:
1232: /* ARGSUSED */
1233: static int
1234: termp_sh_pre(DECL_ARGS)
1235: {
1236:
1237: switch (node->type) {
1238: case (MDOC_HEAD):
1239: term_vspace(p);
1240: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SECTION]);
1241: break;
1242: case (MDOC_BODY):
1243: p->offset = INDENT;
1244: break;
1245: default:
1246: break;
1247: }
1248: return(1);
1249: }
1250:
1251:
1252: /* ARGSUSED */
1253: static void
1254: termp_sh_post(DECL_ARGS)
1255: {
1256:
1257: switch (node->type) {
1258: case (MDOC_HEAD):
1259: term_newln(p);
1260: break;
1261: case (MDOC_BODY):
1262: term_newln(p);
1263: p->offset = 0;
1264: break;
1265: default:
1266: break;
1267: }
1268: }
1269:
1270:
1271: /* ARGSUSED */
1272: static int
1273: termp_op_pre(DECL_ARGS)
1274: {
1275:
1276: switch (node->type) {
1277: case (MDOC_BODY):
1278: term_word(p, "\\(lB");
1279: p->flags |= TERMP_NOSPACE;
1280: break;
1281: default:
1282: break;
1283: }
1284: return(1);
1285: }
1286:
1287:
1288: /* ARGSUSED */
1289: static int
1290: termp_bt_pre(DECL_ARGS)
1291: {
1292:
1293: term_word(p, "is currently in beta test.");
1294: return(1);
1295: }
1296:
1297:
1298: /* ARGSUSED */
1299: static int
1300: termp_lb_pre(DECL_ARGS)
1301: {
1302: const char *lb;
1303:
1.10 schwarze 1304: assert(node->child && MDOC_TEXT == node->child->type);
1.14 schwarze 1305: lb = mdoc_a2lib(node->child->string);
1306: if (lb) {
1.1 kristaps 1307: term_word(p, lb);
1308: return(0);
1309: }
1310: term_word(p, "library");
1311: return(1);
1312: }
1313:
1314:
1315: /* ARGSUSED */
1316: static void
1317: termp_lb_post(DECL_ARGS)
1318: {
1319:
1320: term_newln(p);
1321: }
1322:
1323:
1324: /* ARGSUSED */
1325: static int
1326: termp_ud_pre(DECL_ARGS)
1327: {
1328:
1329: term_word(p, "currently under development.");
1330: return(1);
1331: }
1332:
1333:
1334: /* ARGSUSED */
1335: static int
1336: termp_d1_pre(DECL_ARGS)
1337: {
1338:
1339: if (MDOC_BLOCK != node->type)
1340: return(1);
1341: term_newln(p);
1.14 schwarze 1342: pair->offset = INDENT + 1;
1343: p->offset += pair->offset;
1.1 kristaps 1344: return(1);
1345: }
1346:
1347:
1348: /* ARGSUSED */
1349: static void
1350: termp_d1_post(DECL_ARGS)
1351: {
1352:
1353: if (MDOC_BLOCK != node->type)
1354: return;
1355: term_newln(p);
1356: p->offset -= pair->offset;
1357: }
1358:
1359:
1360: /* ARGSUSED */
1361: static int
1362: termp_aq_pre(DECL_ARGS)
1363: {
1364:
1365: if (MDOC_BODY != node->type)
1366: return(1);
1367: term_word(p, "\\(la");
1368: p->flags |= TERMP_NOSPACE;
1369: return(1);
1370: }
1371:
1372:
1373: /* ARGSUSED */
1374: static void
1375: termp_aq_post(DECL_ARGS)
1376: {
1377:
1378: if (MDOC_BODY != node->type)
1379: return;
1380: p->flags |= TERMP_NOSPACE;
1381: term_word(p, "\\(ra");
1382: }
1383:
1384:
1385: /* ARGSUSED */
1386: static int
1387: termp_ft_pre(DECL_ARGS)
1388: {
1389:
1390: if (SEC_SYNOPSIS == node->sec)
1391: if (node->prev && MDOC_Fo == node->prev->tok)
1392: term_vspace(p);
1393: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FUNC_TYPE]);
1394: return(1);
1395: }
1396:
1397:
1398: /* ARGSUSED */
1399: static void
1400: termp_ft_post(DECL_ARGS)
1401: {
1402:
1403: if (SEC_SYNOPSIS == node->sec)
1404: term_newln(p);
1405: }
1406:
1407:
1408: /* ARGSUSED */
1409: static int
1410: termp_fn_pre(DECL_ARGS)
1411: {
1412: const struct mdoc_node *n;
1413:
1.10 schwarze 1414: assert(node->child && MDOC_TEXT == node->child->type);
1.1 kristaps 1415:
1416: /* FIXME: can be "type funcname" "type varname"... */
1417:
1418: p->flags |= ttypes[TTYPE_FUNC_NAME];
1419: term_word(p, node->child->string);
1420: p->flags &= ~ttypes[TTYPE_FUNC_NAME];
1421:
1422: p->flags |= TERMP_NOSPACE;
1423: term_word(p, "(");
1424:
1425: for (n = node->child->next; n; n = n->next) {
1426: p->flags |= ttypes[TTYPE_FUNC_ARG];
1427: term_word(p, n->string);
1428: p->flags &= ~ttypes[TTYPE_FUNC_ARG];
1429: if (n->next)
1430: term_word(p, ",");
1431: }
1432:
1433: term_word(p, ")");
1434:
1435: if (SEC_SYNOPSIS == node->sec)
1436: term_word(p, ";");
1437:
1438: return(0);
1439: }
1440:
1441:
1442: /* ARGSUSED */
1443: static void
1444: termp_fn_post(DECL_ARGS)
1445: {
1446:
1447: if (node->sec == SEC_SYNOPSIS && node->next)
1448: term_vspace(p);
1449:
1450: }
1451:
1452:
1453: /* ARGSUSED */
1454: static int
1455: termp_sx_pre(DECL_ARGS)
1456: {
1457:
1458: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_LINK]);
1459: return(1);
1460: }
1461:
1462:
1463: /* ARGSUSED */
1464: static int
1465: termp_fa_pre(DECL_ARGS)
1466: {
1467: struct mdoc_node *n;
1468:
1469: if (node->parent->tok != MDOC_Fo) {
1470: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FUNC_ARG]);
1471: return(1);
1472: }
1473:
1474: for (n = node->child; n; n = n->next) {
1475: p->flags |= ttypes[TTYPE_FUNC_ARG];
1476: term_word(p, n->string);
1477: p->flags &= ~ttypes[TTYPE_FUNC_ARG];
1478: if (n->next)
1479: term_word(p, ",");
1480: }
1481:
1482: if (node->child && node->next && node->next->tok == MDOC_Fa)
1483: term_word(p, ",");
1484:
1485: return(0);
1486: }
1487:
1488:
1489: /* ARGSUSED */
1490: static int
1491: termp_va_pre(DECL_ARGS)
1492: {
1493:
1494: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_VAR_DECL]);
1495: return(1);
1496: }
1497:
1498:
1499: /* ARGSUSED */
1500: static int
1501: termp_bd_pre(DECL_ARGS)
1502: {
1503: int i, type, ln;
1504:
1505: /*
1506: * This is fairly tricky due primarily to crappy documentation.
1507: * If -ragged or -filled are specified, the block does nothing
1508: * but change the indentation.
1509: *
1510: * If, on the other hand, -unfilled or -literal are specified,
1511: * then the game changes. Text is printed exactly as entered in
1512: * the display: if a macro line, a newline is appended to the
1513: * line. Blank lines are allowed.
1514: */
1515:
1516: if (MDOC_BLOCK == node->type)
1517: return(fmt_block_vspace(p, node, node));
1518: else if (MDOC_BODY != node->type)
1519: return(1);
1520:
1.10 schwarze 1521: /* FIXME: display type should be mandated by parser. */
1522:
1.1 kristaps 1523: if (NULL == node->parent->args)
1524: errx(1, "missing display type");
1525:
1526: pair->offset = p->offset;
1527:
1528: for (type = -1, i = 0;
1529: i < (int)node->parent->args->argc; i++) {
1530: switch (node->parent->args->argv[i].arg) {
1531: case (MDOC_Ragged):
1532: /* FALLTHROUGH */
1533: case (MDOC_Filled):
1534: /* FALLTHROUGH */
1535: case (MDOC_Unfilled):
1536: /* FALLTHROUGH */
1537: case (MDOC_Literal):
1538: type = node->parent->args->argv[i].arg;
1539: i = (int)node->parent->args->argc;
1540: break;
1541: default:
1542: break;
1543: }
1544: }
1545:
1546: if (NULL == node->parent->args)
1547: errx(1, "missing display type");
1548:
1549: i = arg_getattr(MDOC_Offset, node->parent);
1550: if (-1 != i) {
1551: if (1 != node->parent->args->argv[i].sz)
1552: errx(1, "expected single value");
1553: p->offset += arg_offset(&node->parent->args->argv[i]);
1554: }
1555:
1556: switch (type) {
1557: case (MDOC_Literal):
1558: /* FALLTHROUGH */
1559: case (MDOC_Unfilled):
1560: break;
1561: default:
1562: return(1);
1563: }
1564:
1565: /*
1566: * Tricky. Iterate through all children. If we're on a
1567: * different parse line, append a newline and then the contents.
1568: * Ew.
1569: */
1570:
1571: p->flags |= TERMP_LITERAL;
1572: ln = node->child ? node->child->line : 0;
1573:
1574: for (node = node->child; node; node = node->next) {
1575: if (ln < node->line) {
1576: term_flushln(p);
1577: p->flags |= TERMP_NOSPACE;
1578: }
1579: ln = node->line;
1580: print_node(p, pair, meta, node);
1581: }
1582:
1583: return(0);
1584: }
1585:
1586:
1587: /* ARGSUSED */
1588: static void
1589: termp_bd_post(DECL_ARGS)
1590: {
1591:
1592: if (MDOC_BODY != node->type)
1593: return;
1594:
1595: term_flushln(p);
1596: p->flags &= ~TERMP_LITERAL;
1597: p->offset = pair->offset;
1598: p->flags |= TERMP_NOSPACE;
1599: }
1600:
1601:
1602: /* ARGSUSED */
1603: static int
1604: termp_qq_pre(DECL_ARGS)
1605: {
1606:
1607: if (MDOC_BODY != node->type)
1608: return(1);
1609: term_word(p, "\"");
1610: p->flags |= TERMP_NOSPACE;
1611: return(1);
1612: }
1613:
1614:
1615: /* ARGSUSED */
1616: static void
1617: termp_qq_post(DECL_ARGS)
1618: {
1619:
1620: if (MDOC_BODY != node->type)
1621: return;
1622: p->flags |= TERMP_NOSPACE;
1623: term_word(p, "\"");
1624: }
1625:
1626:
1627: /* ARGSUSED */
1628: static int
1629: termp_bsx_pre(DECL_ARGS)
1630: {
1631:
1632: term_word(p, "BSDI BSD/OS");
1633: return(1);
1634: }
1635:
1636:
1637: /* ARGSUSED */
1638: static void
1639: termp_bx_post(DECL_ARGS)
1640: {
1641:
1642: if (node->child)
1643: p->flags |= TERMP_NOSPACE;
1644: term_word(p, "BSD");
1645: }
1646:
1647:
1648: /* ARGSUSED */
1649: static int
1650: termp_ox_pre(DECL_ARGS)
1651: {
1652:
1653: term_word(p, "OpenBSD");
1654: return(1);
1655: }
1656:
1657:
1658: /* ARGSUSED */
1659: static int
1660: termp_dx_pre(DECL_ARGS)
1661: {
1662:
1663: term_word(p, "DragonFly");
1664: return(1);
1665: }
1666:
1667:
1668: /* ARGSUSED */
1669: static int
1670: termp_ux_pre(DECL_ARGS)
1671: {
1672:
1673: term_word(p, "UNIX");
1674: return(1);
1675: }
1676:
1677:
1678: /* ARGSUSED */
1679: static int
1680: termp_fx_pre(DECL_ARGS)
1681: {
1682:
1683: term_word(p, "FreeBSD");
1684: return(1);
1685: }
1686:
1687:
1688: /* ARGSUSED */
1689: static int
1690: termp_nx_pre(DECL_ARGS)
1691: {
1692:
1693: term_word(p, "NetBSD");
1694: return(1);
1695: }
1696:
1697:
1698: /* ARGSUSED */
1699: static int
1700: termp_sq_pre(DECL_ARGS)
1701: {
1702:
1703: if (MDOC_BODY != node->type)
1704: return(1);
1705: term_word(p, "\\(oq");
1706: p->flags |= TERMP_NOSPACE;
1707: return(1);
1708: }
1709:
1710:
1711: /* ARGSUSED */
1712: static void
1713: termp_sq_post(DECL_ARGS)
1714: {
1715:
1716: if (MDOC_BODY != node->type)
1717: return;
1718: p->flags |= TERMP_NOSPACE;
1719: term_word(p, "\\(aq");
1720: }
1721:
1722:
1723: /* ARGSUSED */
1724: static int
1725: termp_pf_pre(DECL_ARGS)
1726: {
1727:
1728: p->flags |= TERMP_IGNDELIM;
1729: return(1);
1730: }
1731:
1732:
1733: /* ARGSUSED */
1734: static void
1735: termp_pf_post(DECL_ARGS)
1736: {
1737:
1738: p->flags &= ~TERMP_IGNDELIM;
1739: p->flags |= TERMP_NOSPACE;
1740: }
1741:
1742:
1743: /* ARGSUSED */
1744: static int
1745: termp_ss_pre(DECL_ARGS)
1746: {
1747:
1748: switch (node->type) {
1749: case (MDOC_BLOCK):
1750: term_newln(p);
1751: if (node->prev)
1752: term_vspace(p);
1753: break;
1754: case (MDOC_HEAD):
1755: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SSECTION]);
1.3 schwarze 1756: p->offset = HALFINDENT;
1.1 kristaps 1757: break;
1758: default:
1759: break;
1760: }
1761:
1762: return(1);
1763: }
1764:
1765:
1766: /* ARGSUSED */
1767: static void
1768: termp_ss_post(DECL_ARGS)
1769: {
1770:
1771: switch (node->type) {
1772: case (MDOC_HEAD):
1773: term_newln(p);
1774: p->offset = INDENT;
1775: break;
1776: default:
1777: break;
1778: }
1779: }
1780:
1781:
1782: /* ARGSUSED */
1783: static int
1784: termp_pa_pre(DECL_ARGS)
1785: {
1786:
1787: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FILE]);
1788: return(1);
1789: }
1790:
1791:
1792: /* ARGSUSED */
1793: static int
1794: termp_em_pre(DECL_ARGS)
1795: {
1796:
1797: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]);
1798: return(1);
1799: }
1800:
1801:
1802: /* ARGSUSED */
1803: static int
1804: termp_cd_pre(DECL_ARGS)
1805: {
1806:
1807: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CONFIG]);
1808: term_newln(p);
1809: return(1);
1810: }
1811:
1812:
1813: /* ARGSUSED */
1814: static int
1815: termp_cm_pre(DECL_ARGS)
1816: {
1817:
1818: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD_FLAG]);
1819: return(1);
1820: }
1821:
1822:
1823: /* ARGSUSED */
1824: static int
1825: termp_ic_pre(DECL_ARGS)
1826: {
1827:
1828: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD]);
1829: return(1);
1830: }
1831:
1832:
1833: /* ARGSUSED */
1834: static int
1835: termp_in_pre(DECL_ARGS)
1836: {
1837:
1838: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_INCLUDE]);
1839: term_word(p, "#include");
1840: term_word(p, "<");
1841: p->flags |= TERMP_NOSPACE;
1842: return(1);
1843: }
1844:
1845:
1846: /* ARGSUSED */
1847: static void
1848: termp_in_post(DECL_ARGS)
1849: {
1850:
1851: p->flags |= TERMP_NOSPACE;
1852: term_word(p, ">");
1853:
1854: term_newln(p);
1855: if (SEC_SYNOPSIS != node->sec)
1856: return;
1857: if (node->next && MDOC_In != node->next->tok)
1858: term_vspace(p);
1859: }
1860:
1861:
1862: /* ARGSUSED */
1863: static int
1864: termp_at_pre(DECL_ARGS)
1865: {
1866: const char *att;
1867:
1868: att = NULL;
1869:
1870: if (node->child)
1871: att = mdoc_a2att(node->child->string);
1872: if (NULL == att)
1873: att = "AT&T UNIX";
1874:
1875: term_word(p, att);
1876: return(0);
1877: }
1878:
1879:
1880: /* ARGSUSED */
1881: static int
1882: termp_brq_pre(DECL_ARGS)
1883: {
1884:
1885: if (MDOC_BODY != node->type)
1886: return(1);
1887: term_word(p, "\\(lC");
1888: p->flags |= TERMP_NOSPACE;
1889: return(1);
1890: }
1891:
1892:
1893: /* ARGSUSED */
1894: static void
1895: termp_brq_post(DECL_ARGS)
1896: {
1897:
1898: if (MDOC_BODY != node->type)
1899: return;
1900: p->flags |= TERMP_NOSPACE;
1901: term_word(p, "\\(rC");
1902: }
1903:
1904:
1905: /* ARGSUSED */
1906: static int
1907: termp_bq_pre(DECL_ARGS)
1908: {
1909:
1910: if (MDOC_BODY != node->type)
1911: return(1);
1912: term_word(p, "\\(lB");
1913: p->flags |= TERMP_NOSPACE;
1914: return(1);
1915: }
1916:
1917:
1918: /* ARGSUSED */
1919: static void
1920: termp_bq_post(DECL_ARGS)
1921: {
1922:
1923: if (MDOC_BODY != node->type)
1924: return;
1925: p->flags |= TERMP_NOSPACE;
1926: term_word(p, "\\(rB");
1927: }
1928:
1929:
1930: /* ARGSUSED */
1931: static int
1932: termp_pq_pre(DECL_ARGS)
1933: {
1934:
1935: if (MDOC_BODY != node->type)
1936: return(1);
1937: term_word(p, "\\&(");
1938: p->flags |= TERMP_NOSPACE;
1939: return(1);
1940: }
1941:
1942:
1943: /* ARGSUSED */
1944: static void
1945: termp_pq_post(DECL_ARGS)
1946: {
1947:
1948: if (MDOC_BODY != node->type)
1949: return;
1950: term_word(p, ")");
1951: }
1952:
1953:
1954: /* ARGSUSED */
1955: static int
1956: termp_fo_pre(DECL_ARGS)
1957: {
1958: const struct mdoc_node *n;
1959:
1960: if (MDOC_BODY == node->type) {
1961: term_word(p, "(");
1962: p->flags |= TERMP_NOSPACE;
1963: return(1);
1964: } else if (MDOC_HEAD != node->type)
1965: return(1);
1966:
1967: /* XXX - groff shows only first parameter */
1968:
1969: p->flags |= ttypes[TTYPE_FUNC_NAME];
1970: for (n = node->child; n; n = n->next) {
1.10 schwarze 1971: assert(MDOC_TEXT == n->type);
1.1 kristaps 1972: term_word(p, n->string);
1973: }
1974: p->flags &= ~ttypes[TTYPE_FUNC_NAME];
1975:
1976: return(0);
1977: }
1978:
1979:
1980: /* ARGSUSED */
1981: static void
1982: termp_fo_post(DECL_ARGS)
1983: {
1984:
1985: if (MDOC_BODY != node->type)
1986: return;
1987: p->flags |= TERMP_NOSPACE;
1988: term_word(p, ")");
1989: p->flags |= TERMP_NOSPACE;
1990: term_word(p, ";");
1991: term_newln(p);
1992: }
1993:
1994:
1995: /* ARGSUSED */
1996: static int
1997: termp_bf_pre(DECL_ARGS)
1998: {
1999: const struct mdoc_node *n;
2000:
2001: if (MDOC_HEAD == node->type) {
2002: return(0);
2003: } else if (MDOC_BLOCK != node->type)
2004: return(1);
2005:
2006: if (NULL == (n = node->head->child)) {
2007: if (arg_hasattr(MDOC_Emphasis, node))
2008: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]);
2009: else if (arg_hasattr(MDOC_Symbolic, node))
2010: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMB]);
2011:
2012: return(1);
2013: }
2014:
1.10 schwarze 2015: assert(MDOC_TEXT == n->type);
1.1 kristaps 2016: if (0 == strcmp("Em", n->string))
2017: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]);
2018: else if (0 == strcmp("Sy", n->string))
2019: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]);
2020:
2021: return(1);
2022: }
2023:
2024:
2025: /* ARGSUSED */
2026: static int
2027: termp_sy_pre(DECL_ARGS)
2028: {
2029:
2030: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMB]);
2031: return(1);
2032: }
2033:
2034:
2035: /* ARGSUSED */
2036: static int
2037: termp_ms_pre(DECL_ARGS)
2038: {
2039:
2040: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMBOL]);
2041: return(1);
2042: }
2043:
2044:
2045:
2046: /* ARGSUSED */
2047: static int
2048: termp_sm_pre(DECL_ARGS)
2049: {
2050:
1.10 schwarze 2051: assert(node->child && MDOC_TEXT == node->child->type);
1.1 kristaps 2052: if (0 == strcmp("on", node->child->string)) {
2053: p->flags &= ~TERMP_NONOSPACE;
2054: p->flags &= ~TERMP_NOSPACE;
2055: } else
2056: p->flags |= TERMP_NONOSPACE;
2057:
2058: return(0);
2059: }
2060:
2061:
2062: /* ARGSUSED */
2063: static int
2064: termp_ap_pre(DECL_ARGS)
2065: {
2066:
2067: p->flags |= TERMP_NOSPACE;
2068: term_word(p, "\\(aq");
2069: p->flags |= TERMP_NOSPACE;
2070: return(1);
2071: }
2072:
2073:
2074: /* ARGSUSED */
2075: static int
2076: termp__j_pre(DECL_ARGS)
2077: {
2078:
2079: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_REF_JOURNAL]);
2080: return(1);
2081: }
2082:
2083:
2084: /* ARGSUSED */
2085: static int
2086: termp__t_pre(DECL_ARGS)
2087: {
2088:
2089: term_word(p, "\"");
2090: p->flags |= TERMP_NOSPACE;
2091: return(1);
2092: }
2093:
2094:
2095: /* ARGSUSED */
2096: static void
2097: termp__t_post(DECL_ARGS)
2098: {
2099:
2100: p->flags |= TERMP_NOSPACE;
2101: term_word(p, "\"");
2102: termp____post(p, pair, meta, node);
2103: }
2104:
2105:
2106: /* ARGSUSED */
2107: static void
2108: termp____post(DECL_ARGS)
2109: {
2110:
2111: p->flags |= TERMP_NOSPACE;
2112: term_word(p, node->next ? "," : ".");
2113: }
2114:
2115:
2116: /* ARGSUSED */
2117: static int
2118: termp_lk_pre(DECL_ARGS)
2119: {
2120: const struct mdoc_node *n;
2121:
1.6 schwarze 2122: assert(node->child);
2123: n = node->child;
2124:
2125: if (NULL == n->next) {
2126: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_LINK_ANCHOR]);
2127: return(1);
2128: }
1.1 kristaps 2129:
2130: p->flags |= ttypes[TTYPE_LINK_ANCHOR];
2131: term_word(p, n->string);
2132: p->flags |= TERMP_NOSPACE;
2133: term_word(p, ":");
1.6 schwarze 2134: p->flags &= ~ttypes[TTYPE_LINK_ANCHOR];
1.1 kristaps 2135:
2136: p->flags |= ttypes[TTYPE_LINK_TEXT];
1.6 schwarze 2137: for (n = n->next; n; n = n->next)
1.1 kristaps 2138: term_word(p, n->string);
1.6 schwarze 2139:
1.1 kristaps 2140: p->flags &= ~ttypes[TTYPE_LINK_TEXT];
2141: return(0);
2142: }
2143:
2144:
2145: /* ARGSUSED */
2146: static int
2147: termp_mt_pre(DECL_ARGS)
2148: {
2149:
2150: TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_LINK_ANCHOR]);
2151: return(1);
2152: }
2153:
2154: