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