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