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