Annotation of mandoc/mdoc_term.c, Revision 1.53
1.53 ! kristaps 1: /* $Id: mdoc_term.c,v 1.52 2009/07/21 13:45:04 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:
31: #define TTYPE_PROG 0
32: #define TTYPE_CMD_FLAG 1
33: #define TTYPE_CMD_ARG 2
34: #define TTYPE_SECTION 3
35: #define TTYPE_FUNC_DECL 4
36: #define TTYPE_VAR_DECL 5
37: #define TTYPE_FUNC_TYPE 6
38: #define TTYPE_FUNC_NAME 7
39: #define TTYPE_FUNC_ARG 8
40: #define TTYPE_LINK 9
41: #define TTYPE_SSECTION 10
42: #define TTYPE_FILE 11
43: #define TTYPE_EMPH 12
44: #define TTYPE_CONFIG 13
45: #define TTYPE_CMD 14
46: #define TTYPE_INCLUDE 15
47: #define TTYPE_SYMB 16
48: #define TTYPE_SYMBOL 17
49: #define TTYPE_DIAG 18
50: #define TTYPE_LINK_ANCHOR 19
51: #define TTYPE_LINK_TEXT 20
52: #define TTYPE_REF_JOURNAL 21
53: #define TTYPE_LIST 22
54: #define TTYPE_NMAX 23
55:
56: const int ttypes[TTYPE_NMAX] = {
57: TERMP_BOLD, /* TTYPE_PROG */
58: TERMP_BOLD, /* TTYPE_CMD_FLAG */
59: TERMP_UNDER, /* TTYPE_CMD_ARG */
60: TERMP_BOLD, /* TTYPE_SECTION */
61: TERMP_BOLD, /* TTYPE_FUNC_DECL */
62: TERMP_UNDER, /* TTYPE_VAR_DECL */
63: TERMP_UNDER, /* TTYPE_FUNC_TYPE */
64: TERMP_BOLD, /* TTYPE_FUNC_NAME */
65: TERMP_UNDER, /* TTYPE_FUNC_ARG */
66: TERMP_UNDER, /* TTYPE_LINK */
67: TERMP_BOLD, /* TTYPE_SSECTION */
1.52 kristaps 68: 0, /* TTYPE_FILE */
1.1 kristaps 69: TERMP_UNDER, /* TTYPE_EMPH */
70: TERMP_BOLD, /* TTYPE_CONFIG */
71: TERMP_BOLD, /* TTYPE_CMD */
72: TERMP_BOLD, /* TTYPE_INCLUDE */
73: TERMP_BOLD, /* TTYPE_SYMB */
74: TERMP_BOLD, /* TTYPE_SYMBOL */
75: TERMP_BOLD, /* TTYPE_DIAG */
76: TERMP_UNDER, /* TTYPE_LINK_ANCHOR */
77: TERMP_BOLD, /* TTYPE_LINK_TEXT */
78: TERMP_UNDER, /* TTYPE_REF_JOURNAL */
79: TERMP_BOLD /* TTYPE_LIST */
80: };
81:
82: struct termpair {
83: struct termpair *ppair;
1.31 kristaps 84: int flag;
85: int count;
1.1 kristaps 86: };
87:
1.31 kristaps 88: #define DECL_ARGS struct termp *p, \
89: struct termpair *pair, \
90: const struct mdoc_meta *meta, \
91: const struct mdoc_node *node
1.1 kristaps 92:
93: struct termact {
94: int (*pre)(DECL_ARGS);
95: void (*post)(DECL_ARGS);
96: };
97:
1.31 kristaps 98: static void termp____post(DECL_ARGS);
99: static void termp__t_post(DECL_ARGS);
100: static void termp_aq_post(DECL_ARGS);
101: static void termp_bd_post(DECL_ARGS);
102: static void termp_bl_post(DECL_ARGS);
103: static void termp_bq_post(DECL_ARGS);
104: static void termp_brq_post(DECL_ARGS);
105: static void termp_bx_post(DECL_ARGS);
106: static void termp_d1_post(DECL_ARGS);
107: static void termp_dq_post(DECL_ARGS);
108: static void termp_fd_post(DECL_ARGS);
109: static void termp_fn_post(DECL_ARGS);
110: static void termp_fo_post(DECL_ARGS);
111: static void termp_ft_post(DECL_ARGS);
112: static void termp_in_post(DECL_ARGS);
113: static void termp_it_post(DECL_ARGS);
114: static void termp_lb_post(DECL_ARGS);
115: static void termp_op_post(DECL_ARGS);
116: static void termp_pf_post(DECL_ARGS);
117: static void termp_pq_post(DECL_ARGS);
118: static void termp_qq_post(DECL_ARGS);
119: static void termp_sh_post(DECL_ARGS);
120: static void termp_sq_post(DECL_ARGS);
121: static void termp_ss_post(DECL_ARGS);
122: static void termp_vt_post(DECL_ARGS);
123:
124: static int termp__j_pre(DECL_ARGS);
125: static int termp__t_pre(DECL_ARGS);
126: static int termp_ap_pre(DECL_ARGS);
127: static int termp_aq_pre(DECL_ARGS);
128: static int termp_ar_pre(DECL_ARGS);
129: static int termp_bd_pre(DECL_ARGS);
130: static int termp_bf_pre(DECL_ARGS);
131: static int termp_bq_pre(DECL_ARGS);
1.44 kristaps 132: static int termp_br_pre(DECL_ARGS);
1.31 kristaps 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_pf_pre(DECL_ARGS);
158: static int termp_pp_pre(DECL_ARGS);
159: static int termp_pq_pre(DECL_ARGS);
160: static int termp_qq_pre(DECL_ARGS);
161: static int termp_rs_pre(DECL_ARGS);
162: static int termp_rv_pre(DECL_ARGS);
163: static int termp_sh_pre(DECL_ARGS);
164: static int termp_sm_pre(DECL_ARGS);
1.45 kristaps 165: static int termp_sp_pre(DECL_ARGS);
1.31 kristaps 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);
175:
1.1 kristaps 176: static const struct termact termacts[MDOC_MAX] = {
1.14 kristaps 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 */
1.52 kristaps 212: { NULL, NULL }, /* Pa */
1.1 kristaps 213: { termp_rv_pre, NULL }, /* Rv */
1.36 kristaps 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.35 kristaps 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 kristaps 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 kristaps 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 kristaps 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 kristaps 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.37 kristaps 283: { NULL, termp_lb_post }, /* Lb */
1.14 kristaps 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 kristaps 293: { termp_xx_pre, NULL }, /* Dx */
1.1 kristaps 294: { NULL, NULL }, /* %Q */
1.44 kristaps 295: { termp_br_pre, NULL }, /* br */
1.45 kristaps 296: { termp_sp_pre, NULL }, /* sp */
1.1 kristaps 297: };
298:
1.2 kristaps 299: #ifdef __linux__
1.9 kristaps 300: extern size_t strlcpy(char *, const char *, size_t);
301: extern size_t strlcat(char *, const char *, size_t);
1.2 kristaps 302: #endif
303:
1.1 kristaps 304: static int arg_hasattr(int, const struct mdoc_node *);
305: static int arg_getattrs(const int *, int *, size_t,
306: const struct mdoc_node *);
307: static int arg_getattr(int, const struct mdoc_node *);
308: static size_t arg_offset(const struct mdoc_argv *);
309: static size_t arg_width(const struct mdoc_argv *, int);
310: static int arg_listtype(const struct mdoc_node *);
311: static int fmt_block_vspace(struct termp *,
312: const struct mdoc_node *,
313: const struct mdoc_node *);
1.3 kristaps 314: static void print_node(DECL_ARGS);
315: static void print_head(struct termp *,
1.1 kristaps 316: const struct mdoc_meta *);
1.3 kristaps 317: static void print_body(DECL_ARGS);
318: static void print_foot(struct termp *,
1.1 kristaps 319: const struct mdoc_meta *);
320:
321:
322: int
323: mdoc_run(struct termp *p, const struct mdoc *m)
324: {
1.9 kristaps 325: /*
326: * Main output function. When this is called, assume that the
327: * tree is properly formed.
328: */
1.3 kristaps 329: print_head(p, mdoc_meta(m));
1.14 kristaps 330: assert(mdoc_node(m));
331: assert(MDOC_ROOT == mdoc_node(m)->type);
332: if (mdoc_node(m)->child)
333: print_body(p, NULL, mdoc_meta(m), mdoc_node(m)->child);
1.3 kristaps 334: print_foot(p, mdoc_meta(m));
335: return(1);
1.1 kristaps 336: }
337:
338:
1.3 kristaps 339: static void
1.1 kristaps 340: print_body(DECL_ARGS)
341: {
342:
1.3 kristaps 343: print_node(p, pair, meta, node);
1.1 kristaps 344: if ( ! node->next)
1.3 kristaps 345: return;
346: print_body(p, pair, meta, node->next);
1.1 kristaps 347: }
348:
349:
1.3 kristaps 350: static void
1.1 kristaps 351: print_node(DECL_ARGS)
352: {
353: int dochild;
354: struct termpair npair;
1.30 kristaps 355: size_t offset, rmargin;
1.1 kristaps 356:
357: dochild = 1;
1.29 kristaps 358: offset = p->offset;
1.30 kristaps 359: rmargin = p->rmargin;
1.29 kristaps 360:
1.1 kristaps 361: npair.ppair = pair;
362: npair.flag = 0;
363: npair.count = 0;
364:
1.46 kristaps 365: /*
366: * Note on termpair. This allows a pre function to set a termp
367: * flag that is automatically unset after the body, but before
368: * the post function. Thus, if a pre uses a termpair flag, it
369: * must be reapplied in the post for use.
370: */
371:
1.1 kristaps 372: if (MDOC_TEXT != node->type) {
373: if (termacts[node->tok].pre)
374: if ( ! (*termacts[node->tok].pre)(p, &npair, meta, node))
375: dochild = 0;
376: } else /* MDOC_TEXT == node->type */
377: term_word(p, node->string);
378:
379: /* Children. */
380:
1.28 kristaps 381: p->flags |= npair.flag;
1.1 kristaps 382:
383: if (dochild && node->child)
384: print_body(p, &npair, meta, node->child);
385:
1.46 kristaps 386: p->flags &= ~npair.flag;
387:
1.1 kristaps 388: /* Post-processing. */
389:
390: if (MDOC_TEXT != node->type)
391: if (termacts[node->tok].post)
392: (*termacts[node->tok].post)(p, &npair, meta, node);
1.29 kristaps 393:
394: p->offset = offset;
1.30 kristaps 395: p->rmargin = rmargin;
1.1 kristaps 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:
1.42 kristaps 420: if (0 == strftime(buf, p->rmargin, "%B %e, %Y", tm))
1.1 kristaps 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: int i, len;
1.40 kristaps 531: const char *p;
1.1 kristaps 532:
533: assert(pos < (int)arg->sz && pos >= 0);
534: assert(arg->value[pos]);
535:
1.40 kristaps 536: p = arg->value[pos];
537:
538: if (0 == (len = (int)strlen(p)))
1.1 kristaps 539: return(0);
540:
541: for (i = 0; i < len - 1; i++)
1.40 kristaps 542: if ( ! isdigit((u_char)p[i]))
1.1 kristaps 543: break;
544:
1.40 kristaps 545: if (i == len - 1)
546: if ('n' == p[len - 1] || 'm' == p[len - 1])
547: return((size_t)atoi(p) + 2);
1.1 kristaps 548:
1.40 kristaps 549: return((size_t)len + 2);
1.1 kristaps 550: }
551:
552:
553: static int
554: arg_listtype(const struct mdoc_node *n)
555: {
556: int i, len;
557:
558: assert(MDOC_BLOCK == n->type);
559:
560: len = (int)(n->args ? n->args->argc : 0);
561:
562: for (i = 0; i < len; i++)
563: switch (n->args->argv[i].arg) {
564: case (MDOC_Bullet):
565: /* FALLTHROUGH */
566: case (MDOC_Dash):
567: /* FALLTHROUGH */
568: case (MDOC_Enum):
569: /* FALLTHROUGH */
570: case (MDOC_Hyphen):
571: /* FALLTHROUGH */
572: case (MDOC_Tag):
573: /* FALLTHROUGH */
574: case (MDOC_Inset):
575: /* FALLTHROUGH */
576: case (MDOC_Diag):
577: /* FALLTHROUGH */
578: case (MDOC_Item):
579: /* FALLTHROUGH */
580: case (MDOC_Column):
581: /* FALLTHROUGH */
1.38 kristaps 582: case (MDOC_Hang):
583: /* FALLTHROUGH */
1.1 kristaps 584: case (MDOC_Ohang):
585: return(n->args->argv[i].arg);
586: default:
587: break;
588: }
589:
1.38 kristaps 590: return(-1);
1.1 kristaps 591: }
592:
593:
594: static size_t
595: arg_offset(const struct mdoc_argv *arg)
596: {
1.40 kristaps 597: int len, i;
598: const char *p;
1.1 kristaps 599:
600: assert(*arg->value);
1.40 kristaps 601: p = *arg->value;
602:
603: if (0 == strcmp(p, "left"))
1.19 kristaps 604: return(0);
1.40 kristaps 605: if (0 == strcmp(p, "indent"))
1.16 kristaps 606: return(INDENT + 1);
1.40 kristaps 607: if (0 == strcmp(p, "indent-two"))
1.20 kristaps 608: return((INDENT + 1) * 2);
1.10 kristaps 609:
1.40 kristaps 610: if (0 == (len = (int)strlen(p)))
611: return(0);
612:
613: for (i = 0; i < len - 1; i++)
614: if ( ! isdigit((u_char)p[i]))
615: break;
616:
617: if (i == len - 1)
618: if ('n' == p[len - 1] || 'm' == p[len - 1])
619: return((size_t)atoi(p));
1.11 kristaps 620:
1.40 kristaps 621: return((size_t)len);
1.1 kristaps 622: }
623:
624:
625: static int
626: arg_hasattr(int arg, const struct mdoc_node *n)
627: {
628:
629: return(-1 != arg_getattr(arg, n));
630: }
631:
632:
633: static int
634: arg_getattr(int v, const struct mdoc_node *n)
635: {
636: int val;
637:
638: return(arg_getattrs(&v, &val, 1, n) ? val : -1);
639: }
640:
641:
642: static int
643: arg_getattrs(const int *keys, int *vals,
644: size_t sz, const struct mdoc_node *n)
645: {
646: int i, j, k;
647:
648: if (NULL == n->args)
649: return(0);
650:
651: for (k = i = 0; i < (int)n->args->argc; i++)
652: for (j = 0; j < (int)sz; j++)
653: if (n->args->argv[i].arg == keys[j]) {
654: vals[j] = i;
655: k++;
656: }
657: return(k);
658: }
659:
660:
661: /* ARGSUSED */
662: static int
663: fmt_block_vspace(struct termp *p,
664: const struct mdoc_node *bl,
665: const struct mdoc_node *node)
666: {
667: const struct mdoc_node *n;
668:
669: term_newln(p);
670:
671: if (arg_hasattr(MDOC_Compact, bl))
672: return(1);
1.48 kristaps 673: /* XXX - not documented! */
674: else if (arg_hasattr(MDOC_Column, bl))
675: return(1);
1.1 kristaps 676:
677: for (n = node; n; n = n->parent) {
678: if (MDOC_BLOCK != n->type)
679: continue;
680: if (MDOC_Ss == n->tok)
681: break;
682: if (MDOC_Sh == n->tok)
683: break;
684: if (NULL == n->prev)
685: continue;
686: term_vspace(p);
687: break;
688: }
689:
690: return(1);
691: }
692:
693:
694: /* ARGSUSED */
695: static int
696: termp_dq_pre(DECL_ARGS)
697: {
698:
699: if (MDOC_BODY != node->type)
700: return(1);
701:
702: term_word(p, "\\(lq");
703: p->flags |= TERMP_NOSPACE;
704: return(1);
705: }
706:
707:
708: /* ARGSUSED */
709: static void
710: termp_dq_post(DECL_ARGS)
711: {
712:
713: if (MDOC_BODY != node->type)
714: return;
715:
716: p->flags |= TERMP_NOSPACE;
717: term_word(p, "\\(rq");
718: }
719:
720:
721: /* ARGSUSED */
722: static int
723: termp_it_pre(DECL_ARGS)
724: {
725: const struct mdoc_node *bl, *n;
726: char buf[7];
1.39 kristaps 727: int i, type, keys[3], vals[3];
1.1 kristaps 728: size_t width, offset;
729:
730: if (MDOC_BLOCK == node->type)
731: return(fmt_block_vspace(p, node->parent->parent, node));
732:
733: bl = node->parent->parent->parent;
734:
735: /* Save parent attributes. */
736:
737: pair->flag = p->flags;
738:
739: /* Get list width and offset. */
740:
741: keys[0] = MDOC_Width;
742: keys[1] = MDOC_Offset;
743: keys[2] = MDOC_Column;
744:
745: vals[0] = vals[1] = vals[2] = -1;
746:
747: width = offset = 0;
748:
749: (void)arg_getattrs(keys, vals, 3, bl);
750:
751: type = arg_listtype(bl);
1.38 kristaps 752: assert(-1 != type);
1.1 kristaps 753:
754: /* Calculate real width and offset. */
755:
756: switch (type) {
757: case (MDOC_Column):
758: if (MDOC_BODY == node->type)
759: break;
760: for (i = 0, n = node->prev; n; n = n->prev, i++)
761: offset += arg_width
762: (&bl->args->argv[vals[2]], i);
763: assert(i < (int)bl->args->argv[vals[2]].sz);
764: width = arg_width(&bl->args->argv[vals[2]], i);
765: if (vals[1] >= 0)
766: offset += arg_offset(&bl->args->argv[vals[1]]);
767: break;
768: default:
769: if (vals[0] >= 0)
770: width = arg_width(&bl->args->argv[vals[0]], 0);
771: if (vals[1] >= 0)
1.19 kristaps 772: offset += arg_offset(&bl->args->argv[vals[1]]);
1.1 kristaps 773: break;
774: }
775:
776: /*
777: * List-type can override the width in the case of fixed-head
778: * values (bullet, dash/hyphen, enum). Tags need a non-zero
1.38 kristaps 779: * offset. FIXME: double-check that correct.
1.1 kristaps 780: */
781:
782: switch (type) {
783: case (MDOC_Bullet):
784: /* FALLTHROUGH */
785: case (MDOC_Dash):
786: /* FALLTHROUGH */
787: case (MDOC_Hyphen):
788: if (width < 4)
789: width = 4;
790: break;
1.17 kristaps 791: case (MDOC_Enum):
792: if (width < 5)
793: width = 5;
794: break;
1.38 kristaps 795: case (MDOC_Hang):
1.39 kristaps 796: if (0 == width)
797: width = 8;
798: break;
1.49 kristaps 799: case (MDOC_Column):
800: /* FALLTHROUGH */
1.1 kristaps 801: case (MDOC_Tag):
802: if (0 == width)
803: width = 10;
804: break;
805: default:
806: break;
807: }
808:
809: /*
1.17 kristaps 810: * Whitespace control. Inset bodies need an initial space,
811: * while diagonal bodies need two.
1.1 kristaps 812: */
813:
1.51 kristaps 814: p->flags |= TERMP_NOSPACE;
815:
1.1 kristaps 816: switch (type) {
1.51 kristaps 817: case (MDOC_Diag):
818: term_word(p, "\\ \\ ");
819: break;
1.1 kristaps 820: case (MDOC_Inset):
821: if (MDOC_BODY == node->type)
1.51 kristaps 822: term_word(p, "\\ ");
1.1 kristaps 823: break;
824: default:
825: break;
826: }
827:
1.51 kristaps 828: p->flags |= TERMP_NOSPACE;
829:
1.1 kristaps 830: /*
831: * Style flags. Diagnostic heads need TTYPE_DIAG.
832: */
833:
834: switch (type) {
835: case (MDOC_Diag):
836: if (MDOC_HEAD == node->type)
837: p->flags |= ttypes[TTYPE_DIAG];
838: break;
839: default:
840: break;
841: }
842:
843: /*
844: * Pad and break control. This is the tricker part. Lists with
845: * set right-margins for the head get TERMP_NOBREAK because, if
846: * they overrun the margin, they wrap to the new margin.
847: * Correspondingly, the body for these types don't left-pad, as
848: * the head will pad out to to the right.
849: */
850:
851: switch (type) {
852: case (MDOC_Bullet):
853: /* FALLTHROUGH */
854: case (MDOC_Dash):
855: /* FALLTHROUGH */
856: case (MDOC_Enum):
857: /* FALLTHROUGH */
858: case (MDOC_Hyphen):
1.39 kristaps 859: if (MDOC_HEAD == node->type)
860: p->flags |= TERMP_NOBREAK;
861: else
862: p->flags |= TERMP_NOLPAD;
863: break;
1.38 kristaps 864: case (MDOC_Hang):
1.39 kristaps 865: if (MDOC_HEAD == node->type)
866: p->flags |= TERMP_NOBREAK;
867: else
868: p->flags |= TERMP_NOLPAD;
869:
870: if (MDOC_HEAD == node->type)
871: p->flags |= TERMP_HANG;
872: break;
1.1 kristaps 873: case (MDOC_Tag):
874: if (MDOC_HEAD == node->type)
1.51 kristaps 875: p->flags |= TERMP_NOBREAK | TERMP_TWOSPACE;
1.1 kristaps 876: else
877: p->flags |= TERMP_NOLPAD;
1.38 kristaps 878:
1.39 kristaps 879: if (MDOC_HEAD != node->type)
880: break;
881: if (NULL == node->next || NULL == node->next->child)
882: p->flags |= TERMP_DANGLE;
1.1 kristaps 883: break;
884: case (MDOC_Column):
885: if (MDOC_HEAD == node->type) {
886: assert(node->next);
887: if (MDOC_BODY == node->next->type)
888: p->flags &= ~TERMP_NOBREAK;
889: else
890: p->flags |= TERMP_NOBREAK;
891: if (node->prev)
892: p->flags |= TERMP_NOLPAD;
893: }
894: break;
895: case (MDOC_Diag):
896: if (MDOC_HEAD == node->type)
897: p->flags |= TERMP_NOBREAK;
898: break;
899: default:
900: break;
901: }
902:
903: /*
904: * Margin control. Set-head-width lists have their right
905: * margins shortened. The body for these lists has the offset
906: * necessarily lengthened. Everybody gets the offset.
907: */
908:
909: p->offset += offset;
910:
911: switch (type) {
912: case (MDOC_Bullet):
913: /* FALLTHROUGH */
914: case (MDOC_Dash):
915: /* FALLTHROUGH */
916: case (MDOC_Enum):
917: /* FALLTHROUGH */
918: case (MDOC_Hyphen):
919: /* FALLTHROUGH */
1.38 kristaps 920: case (MDOC_Hang):
921: /* FALLTHROUGH */
1.1 kristaps 922: case (MDOC_Tag):
1.49 kristaps 923: assert(width);
1.1 kristaps 924: if (MDOC_HEAD == node->type)
925: p->rmargin = p->offset + width;
926: else
927: p->offset += width;
928: break;
929: case (MDOC_Column):
1.49 kristaps 930: assert(width);
1.1 kristaps 931: p->rmargin = p->offset + width;
1.50 kristaps 932: /*
933: * XXX - this behaviour is not documented: the
934: * right-most column is filled to the right margin.
935: */
936: if (MDOC_HEAD == node->type &&
937: MDOC_BODY == node->next->type)
938: p->rmargin = p->maxrmargin;
1.1 kristaps 939: break;
940: default:
941: break;
942: }
943:
944: /*
945: * The dash, hyphen, bullet and enum lists all have a special
1.15 kristaps 946: * HEAD character (temporarily bold, in some cases).
1.1 kristaps 947: */
948:
949: if (MDOC_HEAD == node->type)
950: switch (type) {
951: case (MDOC_Bullet):
1.15 kristaps 952: p->flags |= TERMP_BOLD;
1.1 kristaps 953: term_word(p, "\\[bu]");
1.39 kristaps 954: p->flags &= ~TERMP_BOLD;
1.1 kristaps 955: break;
956: case (MDOC_Dash):
957: /* FALLTHROUGH */
958: case (MDOC_Hyphen):
1.15 kristaps 959: p->flags |= TERMP_BOLD;
1.27 kristaps 960: term_word(p, "\\(hy");
1.39 kristaps 961: p->flags &= ~TERMP_BOLD;
1.1 kristaps 962: break;
963: case (MDOC_Enum):
964: (pair->ppair->ppair->count)++;
965: (void)snprintf(buf, sizeof(buf), "%d.",
966: pair->ppair->ppair->count);
967: term_word(p, buf);
968: break;
969: default:
970: break;
971: }
972:
973: /*
974: * If we're not going to process our children, indicate so here.
975: */
976:
977: switch (type) {
978: case (MDOC_Bullet):
979: /* FALLTHROUGH */
980: case (MDOC_Item):
981: /* FALLTHROUGH */
982: case (MDOC_Dash):
983: /* FALLTHROUGH */
984: case (MDOC_Hyphen):
985: /* FALLTHROUGH */
986: case (MDOC_Enum):
987: if (MDOC_HEAD == node->type)
988: return(0);
989: break;
990: case (MDOC_Column):
991: if (MDOC_BODY == node->type)
992: return(0);
993: break;
994: default:
995: break;
996: }
997:
998: return(1);
999: }
1000:
1001:
1002: /* ARGSUSED */
1003: static void
1004: termp_it_post(DECL_ARGS)
1005: {
1006: int type;
1007:
1008: if (MDOC_BODY != node->type && MDOC_HEAD != node->type)
1009: return;
1010:
1011: type = arg_listtype(node->parent->parent->parent);
1.38 kristaps 1012: assert(-1 != type);
1.1 kristaps 1013:
1014: switch (type) {
1015: case (MDOC_Item):
1016: /* FALLTHROUGH */
1.53 ! kristaps 1017: case (MDOC_Diag):
! 1018: /* FALLTHROUGH */
1.1 kristaps 1019: case (MDOC_Inset):
1020: if (MDOC_BODY == node->type)
1021: term_flushln(p);
1022: break;
1023: case (MDOC_Column):
1024: if (MDOC_HEAD == node->type)
1025: term_flushln(p);
1026: break;
1027: default:
1028: term_flushln(p);
1029: break;
1030: }
1031:
1032: p->flags = pair->flag;
1033: }
1034:
1035:
1036: /* ARGSUSED */
1037: static int
1038: termp_nm_pre(DECL_ARGS)
1039: {
1040:
1041: if (SEC_SYNOPSIS == node->sec)
1042: term_newln(p);
1043:
1.28 kristaps 1044: pair->flag |= ttypes[TTYPE_PROG];
1045: p->flags |= ttypes[TTYPE_PROG];
1046:
1.1 kristaps 1047: if (NULL == node->child)
1048: term_word(p, meta->name);
1049:
1050: return(1);
1051: }
1052:
1053:
1054: /* ARGSUSED */
1055: static int
1056: termp_fl_pre(DECL_ARGS)
1057: {
1058:
1.28 kristaps 1059: pair->flag |= ttypes[TTYPE_CMD_FLAG];
1060: p->flags |= ttypes[TTYPE_CMD_FLAG];
1.1 kristaps 1061: term_word(p, "\\-");
1062: p->flags |= TERMP_NOSPACE;
1063: return(1);
1064: }
1065:
1066:
1067: /* ARGSUSED */
1068: static int
1069: termp_ar_pre(DECL_ARGS)
1070: {
1071:
1.28 kristaps 1072: pair->flag |= ttypes[TTYPE_CMD_ARG];
1.1 kristaps 1073: return(1);
1074: }
1075:
1076:
1077: /* ARGSUSED */
1078: static int
1079: termp_ns_pre(DECL_ARGS)
1080: {
1081:
1082: p->flags |= TERMP_NOSPACE;
1083: return(1);
1084: }
1085:
1086:
1087: /* ARGSUSED */
1088: static int
1089: termp_pp_pre(DECL_ARGS)
1090: {
1091:
1092: term_vspace(p);
1093: return(1);
1094: }
1095:
1096:
1097: /* ARGSUSED */
1098: static int
1099: termp_rs_pre(DECL_ARGS)
1100: {
1101:
1102: if (MDOC_BLOCK == node->type && node->prev)
1103: term_vspace(p);
1104: return(1);
1105: }
1106:
1107:
1108: /* ARGSUSED */
1109: static int
1110: termp_rv_pre(DECL_ARGS)
1111: {
1112: int i;
1113:
1.34 kristaps 1114: i = arg_getattr(MDOC_Std, node);
1115: assert(-1 != i);
1116: assert(node->args->argv[i].sz);
1.1 kristaps 1117:
1118: term_newln(p);
1119: term_word(p, "The");
1120:
1121: p->flags |= ttypes[TTYPE_FUNC_NAME];
1122: term_word(p, *node->args->argv[i].value);
1123: p->flags &= ~ttypes[TTYPE_FUNC_NAME];
1124: p->flags |= TERMP_NOSPACE;
1125:
1126: term_word(p, "() function returns the value 0 if successful;");
1127: term_word(p, "otherwise the value -1 is returned and the");
1128: term_word(p, "global variable");
1129:
1130: p->flags |= ttypes[TTYPE_VAR_DECL];
1131: term_word(p, "errno");
1132: p->flags &= ~ttypes[TTYPE_VAR_DECL];
1133:
1134: term_word(p, "is set to indicate the error.");
1135:
1136: return(1);
1137: }
1138:
1139:
1140: /* ARGSUSED */
1141: static int
1142: termp_ex_pre(DECL_ARGS)
1143: {
1144: int i;
1145:
1.34 kristaps 1146: i = arg_getattr(MDOC_Std, node);
1147: assert(-1 != i);
1148: assert(node->args->argv[i].sz);
1.1 kristaps 1149:
1150: term_word(p, "The");
1151: p->flags |= ttypes[TTYPE_PROG];
1152: term_word(p, *node->args->argv[i].value);
1153: p->flags &= ~ttypes[TTYPE_PROG];
1154: term_word(p, "utility exits 0 on success, and >0 if an error occurs.");
1155:
1156: return(1);
1157: }
1158:
1159:
1160: /* ARGSUSED */
1161: static int
1162: termp_nd_pre(DECL_ARGS)
1163: {
1.25 kristaps 1164:
1165: if (MDOC_BODY != node->type)
1166: return(1);
1.30 kristaps 1167:
1.27 kristaps 1168: #if defined(__OpenBSD__) || defined(__linux__)
1.41 kristaps 1169: term_word(p, "\\(en");
1.23 kristaps 1170: #else
1171: term_word(p, "\\(em");
1172: #endif
1.1 kristaps 1173: return(1);
1174: }
1175:
1176:
1177: /* ARGSUSED */
1178: static void
1179: termp_bl_post(DECL_ARGS)
1180: {
1181:
1182: if (MDOC_BLOCK == node->type)
1183: term_newln(p);
1184: }
1185:
1186:
1187: /* ARGSUSED */
1188: static void
1189: termp_op_post(DECL_ARGS)
1190: {
1191:
1192: if (MDOC_BODY != node->type)
1193: return;
1194: p->flags |= TERMP_NOSPACE;
1195: term_word(p, "\\(rB");
1196: }
1197:
1198:
1199: /* ARGSUSED */
1200: static int
1201: termp_xr_pre(DECL_ARGS)
1202: {
1203: const struct mdoc_node *n;
1204:
1.11 kristaps 1205: assert(node->child && MDOC_TEXT == node->child->type);
1206: n = node->child;
1207:
1.1 kristaps 1208: term_word(p, n->string);
1209: if (NULL == (n = n->next))
1210: return(0);
1211: p->flags |= TERMP_NOSPACE;
1212: term_word(p, "(");
1213: p->flags |= TERMP_NOSPACE;
1214: term_word(p, n->string);
1215: p->flags |= TERMP_NOSPACE;
1216: term_word(p, ")");
1217: return(0);
1218: }
1219:
1220:
1221: /* ARGSUSED */
1222: static int
1223: termp_vt_pre(DECL_ARGS)
1224: {
1225:
1226: /* FIXME: this can be "type name". */
1.29 kristaps 1227: pair->flag |= ttypes[TTYPE_VAR_DECL];
1.1 kristaps 1228: return(1);
1229: }
1230:
1231:
1232: /* ARGSUSED */
1233: static void
1234: termp_vt_post(DECL_ARGS)
1235: {
1236:
1.32 kristaps 1237: if (node->sec != SEC_SYNOPSIS)
1238: return;
1239: if (node->next && MDOC_Vt == node->next->tok)
1240: term_newln(p);
1241: else if (node->next)
1.1 kristaps 1242: term_vspace(p);
1243: }
1244:
1245:
1246: /* ARGSUSED */
1247: static int
1248: termp_fd_pre(DECL_ARGS)
1249: {
1250:
1.29 kristaps 1251: pair->flag |= ttypes[TTYPE_FUNC_DECL];
1.1 kristaps 1252: return(1);
1253: }
1254:
1255:
1256: /* ARGSUSED */
1257: static void
1258: termp_fd_post(DECL_ARGS)
1259: {
1260:
1261: if (node->sec != SEC_SYNOPSIS)
1262: return;
1.29 kristaps 1263:
1.1 kristaps 1264: term_newln(p);
1265: if (node->next && MDOC_Fd != node->next->tok)
1266: term_vspace(p);
1267: }
1268:
1269:
1270: /* ARGSUSED */
1271: static int
1272: termp_sh_pre(DECL_ARGS)
1273: {
1274:
1275: switch (node->type) {
1276: case (MDOC_HEAD):
1277: term_vspace(p);
1.28 kristaps 1278: pair->flag |= ttypes[TTYPE_SECTION];
1.1 kristaps 1279: break;
1280: case (MDOC_BODY):
1281: p->offset = INDENT;
1282: break;
1283: default:
1284: break;
1285: }
1286: return(1);
1287: }
1288:
1289:
1290: /* ARGSUSED */
1291: static void
1292: termp_sh_post(DECL_ARGS)
1293: {
1294:
1295: switch (node->type) {
1296: case (MDOC_HEAD):
1297: term_newln(p);
1298: break;
1299: case (MDOC_BODY):
1300: term_newln(p);
1301: p->offset = 0;
1302: break;
1303: default:
1304: break;
1305: }
1306: }
1307:
1308:
1309: /* ARGSUSED */
1310: static int
1311: termp_op_pre(DECL_ARGS)
1312: {
1313:
1314: switch (node->type) {
1315: case (MDOC_BODY):
1316: term_word(p, "\\(lB");
1317: p->flags |= TERMP_NOSPACE;
1318: break;
1319: default:
1320: break;
1321: }
1322: return(1);
1323: }
1324:
1325:
1326: /* ARGSUSED */
1327: static int
1328: termp_bt_pre(DECL_ARGS)
1329: {
1330:
1331: term_word(p, "is currently in beta test.");
1332: return(1);
1333: }
1334:
1335:
1336: /* ARGSUSED */
1337: static void
1338: termp_lb_post(DECL_ARGS)
1339: {
1340:
1341: term_newln(p);
1342: }
1343:
1344:
1345: /* ARGSUSED */
1346: static int
1347: termp_ud_pre(DECL_ARGS)
1348: {
1349:
1350: term_word(p, "currently under development.");
1351: return(1);
1352: }
1353:
1354:
1355: /* ARGSUSED */
1356: static int
1357: termp_d1_pre(DECL_ARGS)
1358: {
1359:
1.4 kristaps 1360: if (MDOC_BLOCK != node->type)
1.1 kristaps 1361: return(1);
1362: term_newln(p);
1.29 kristaps 1363: p->offset += (INDENT + 1);
1.1 kristaps 1364: return(1);
1365: }
1366:
1367:
1368: /* ARGSUSED */
1369: static void
1370: termp_d1_post(DECL_ARGS)
1371: {
1372:
1.4 kristaps 1373: if (MDOC_BLOCK != node->type)
1.1 kristaps 1374: return;
1375: term_newln(p);
1376: }
1377:
1378:
1379: /* ARGSUSED */
1380: static int
1381: termp_aq_pre(DECL_ARGS)
1382: {
1383:
1384: if (MDOC_BODY != node->type)
1385: return(1);
1386: term_word(p, "\\(la");
1387: p->flags |= TERMP_NOSPACE;
1388: return(1);
1389: }
1390:
1391:
1392: /* ARGSUSED */
1393: static void
1394: termp_aq_post(DECL_ARGS)
1395: {
1396:
1397: if (MDOC_BODY != node->type)
1398: return;
1399: p->flags |= TERMP_NOSPACE;
1400: term_word(p, "\\(ra");
1401: }
1402:
1403:
1404: /* ARGSUSED */
1405: static int
1406: termp_ft_pre(DECL_ARGS)
1407: {
1408:
1409: if (SEC_SYNOPSIS == node->sec)
1410: if (node->prev && MDOC_Fo == node->prev->tok)
1411: term_vspace(p);
1.28 kristaps 1412: pair->flag |= ttypes[TTYPE_FUNC_TYPE];
1.1 kristaps 1413: return(1);
1414: }
1415:
1416:
1417: /* ARGSUSED */
1418: static void
1419: termp_ft_post(DECL_ARGS)
1420: {
1421:
1422: if (SEC_SYNOPSIS == node->sec)
1423: term_newln(p);
1424: }
1425:
1426:
1427: /* ARGSUSED */
1428: static int
1429: termp_fn_pre(DECL_ARGS)
1430: {
1431: const struct mdoc_node *n;
1432:
1.11 kristaps 1433: assert(node->child && MDOC_TEXT == node->child->type);
1.1 kristaps 1434:
1435: /* FIXME: can be "type funcname" "type varname"... */
1436:
1437: p->flags |= ttypes[TTYPE_FUNC_NAME];
1438: term_word(p, node->child->string);
1439: p->flags &= ~ttypes[TTYPE_FUNC_NAME];
1440:
1441: p->flags |= TERMP_NOSPACE;
1442: term_word(p, "(");
1443:
1444: for (n = node->child->next; n; n = n->next) {
1445: p->flags |= ttypes[TTYPE_FUNC_ARG];
1446: term_word(p, n->string);
1447: p->flags &= ~ttypes[TTYPE_FUNC_ARG];
1448: if (n->next)
1449: term_word(p, ",");
1450: }
1451:
1452: term_word(p, ")");
1453:
1454: if (SEC_SYNOPSIS == node->sec)
1455: term_word(p, ";");
1456:
1457: return(0);
1458: }
1459:
1460:
1461: /* ARGSUSED */
1462: static void
1463: termp_fn_post(DECL_ARGS)
1464: {
1465:
1466: if (node->sec == SEC_SYNOPSIS && node->next)
1467: term_vspace(p);
1468: }
1469:
1470:
1471: /* ARGSUSED */
1472: static int
1473: termp_sx_pre(DECL_ARGS)
1474: {
1475:
1.28 kristaps 1476: pair->flag |= ttypes[TTYPE_LINK];
1.1 kristaps 1477: return(1);
1478: }
1479:
1480:
1481: /* ARGSUSED */
1482: static int
1483: termp_fa_pre(DECL_ARGS)
1484: {
1485: struct mdoc_node *n;
1486:
1487: if (node->parent->tok != MDOC_Fo) {
1.28 kristaps 1488: pair->flag |= ttypes[TTYPE_FUNC_ARG];
1.1 kristaps 1489: return(1);
1490: }
1491:
1492: for (n = node->child; n; n = n->next) {
1493: p->flags |= ttypes[TTYPE_FUNC_ARG];
1494: term_word(p, n->string);
1495: p->flags &= ~ttypes[TTYPE_FUNC_ARG];
1496: if (n->next)
1497: term_word(p, ",");
1498: }
1499:
1500: if (node->child && node->next && node->next->tok == MDOC_Fa)
1501: term_word(p, ",");
1502:
1503: return(0);
1504: }
1505:
1506:
1507: /* ARGSUSED */
1508: static int
1509: termp_va_pre(DECL_ARGS)
1510: {
1511:
1.28 kristaps 1512: pair->flag |= ttypes[TTYPE_VAR_DECL];
1.1 kristaps 1513: return(1);
1514: }
1515:
1516:
1517: /* ARGSUSED */
1518: static int
1519: termp_bd_pre(DECL_ARGS)
1520: {
1521: int i, type, ln;
1522:
1523: /*
1524: * This is fairly tricky due primarily to crappy documentation.
1525: * If -ragged or -filled are specified, the block does nothing
1526: * but change the indentation.
1527: *
1528: * If, on the other hand, -unfilled or -literal are specified,
1529: * then the game changes. Text is printed exactly as entered in
1530: * the display: if a macro line, a newline is appended to the
1531: * line. Blank lines are allowed.
1532: */
1533:
1534: if (MDOC_BLOCK == node->type)
1535: return(fmt_block_vspace(p, node, node));
1536: else if (MDOC_BODY != node->type)
1537: return(1);
1538:
1.11 kristaps 1539: /* FIXME: display type should be mandated by parser. */
1540:
1.1 kristaps 1541: if (NULL == node->parent->args)
1542: errx(1, "missing display type");
1543:
1544: for (type = -1, i = 0;
1545: i < (int)node->parent->args->argc; i++) {
1546: switch (node->parent->args->argv[i].arg) {
1547: case (MDOC_Ragged):
1548: /* FALLTHROUGH */
1549: case (MDOC_Filled):
1550: /* FALLTHROUGH */
1551: case (MDOC_Unfilled):
1552: /* FALLTHROUGH */
1553: case (MDOC_Literal):
1554: type = node->parent->args->argv[i].arg;
1555: i = (int)node->parent->args->argc;
1556: break;
1557: default:
1558: break;
1559: }
1560: }
1561:
1562: if (NULL == node->parent->args)
1563: errx(1, "missing display type");
1564:
1565: i = arg_getattr(MDOC_Offset, node->parent);
1566: if (-1 != i) {
1567: if (1 != node->parent->args->argv[i].sz)
1568: errx(1, "expected single value");
1569: p->offset += arg_offset(&node->parent->args->argv[i]);
1570: }
1571:
1572: switch (type) {
1573: case (MDOC_Literal):
1574: /* FALLTHROUGH */
1575: case (MDOC_Unfilled):
1576: break;
1577: default:
1578: return(1);
1579: }
1580:
1581: /*
1582: * Tricky. Iterate through all children. If we're on a
1583: * different parse line, append a newline and then the contents.
1584: * Ew.
1585: */
1586:
1587: ln = node->child ? node->child->line : 0;
1588:
1589: for (node = node->child; node; node = node->next) {
1590: if (ln < node->line) {
1591: term_flushln(p);
1592: p->flags |= TERMP_NOSPACE;
1593: }
1594: ln = node->line;
1595: print_node(p, pair, meta, node);
1596: }
1597:
1598: return(0);
1599: }
1600:
1601:
1602: /* ARGSUSED */
1603: static void
1604: termp_bd_post(DECL_ARGS)
1605: {
1606:
1607: if (MDOC_BODY != node->type)
1608: return;
1609: term_flushln(p);
1610: }
1611:
1612:
1613: /* ARGSUSED */
1614: static int
1615: termp_qq_pre(DECL_ARGS)
1616: {
1617:
1618: if (MDOC_BODY != node->type)
1619: return(1);
1620: term_word(p, "\"");
1621: p->flags |= TERMP_NOSPACE;
1622: return(1);
1623: }
1624:
1625:
1626: /* ARGSUSED */
1627: static void
1628: termp_qq_post(DECL_ARGS)
1629: {
1630:
1631: if (MDOC_BODY != node->type)
1632: return;
1633: p->flags |= TERMP_NOSPACE;
1634: term_word(p, "\"");
1635: }
1636:
1637:
1638: /* ARGSUSED */
1639: static void
1640: termp_bx_post(DECL_ARGS)
1641: {
1642:
1643: if (node->child)
1644: p->flags |= TERMP_NOSPACE;
1645: term_word(p, "BSD");
1646: }
1647:
1648:
1649: /* ARGSUSED */
1650: static int
1.26 kristaps 1651: termp_xx_pre(DECL_ARGS)
1.1 kristaps 1652: {
1.26 kristaps 1653: const char *pp;
1.1 kristaps 1654:
1.26 kristaps 1655: pp = NULL;
1656: switch (node->tok) {
1657: case (MDOC_Bsx):
1658: pp = "BSDI BSD/OS";
1659: break;
1660: case (MDOC_Dx):
1661: pp = "DragonFlyBSD";
1662: break;
1663: case (MDOC_Fx):
1664: pp = "FreeBSD";
1665: break;
1666: case (MDOC_Nx):
1667: pp = "NetBSD";
1668: break;
1669: case (MDOC_Ox):
1670: pp = "OpenBSD";
1671: break;
1672: case (MDOC_Ux):
1673: pp = "UNIX";
1674: break;
1675: default:
1676: break;
1677: }
1.1 kristaps 1678:
1.26 kristaps 1679: assert(pp);
1680: term_word(p, pp);
1.1 kristaps 1681: return(1);
1682: }
1683:
1684:
1685: /* ARGSUSED */
1686: static int
1687: termp_sq_pre(DECL_ARGS)
1688: {
1689:
1690: if (MDOC_BODY != node->type)
1691: return(1);
1692: term_word(p, "\\(oq");
1693: p->flags |= TERMP_NOSPACE;
1694: return(1);
1695: }
1696:
1697:
1698: /* ARGSUSED */
1699: static void
1700: termp_sq_post(DECL_ARGS)
1701: {
1702:
1703: if (MDOC_BODY != node->type)
1704: return;
1705: p->flags |= TERMP_NOSPACE;
1706: term_word(p, "\\(aq");
1707: }
1708:
1709:
1710: /* ARGSUSED */
1711: static int
1712: termp_pf_pre(DECL_ARGS)
1713: {
1714:
1715: p->flags |= TERMP_IGNDELIM;
1716: return(1);
1717: }
1718:
1719:
1720: /* ARGSUSED */
1721: static void
1722: termp_pf_post(DECL_ARGS)
1723: {
1724:
1725: p->flags &= ~TERMP_IGNDELIM;
1726: p->flags |= TERMP_NOSPACE;
1727: }
1728:
1729:
1730: /* ARGSUSED */
1731: static int
1732: termp_ss_pre(DECL_ARGS)
1733: {
1734:
1735: switch (node->type) {
1736: case (MDOC_BLOCK):
1737: term_newln(p);
1738: if (node->prev)
1739: term_vspace(p);
1740: break;
1741: case (MDOC_HEAD):
1.28 kristaps 1742: pair->flag |= ttypes[TTYPE_SSECTION];
1.5 kristaps 1743: p->offset = HALFINDENT;
1.1 kristaps 1744: break;
1745: default:
1746: break;
1747: }
1748:
1749: return(1);
1750: }
1751:
1752:
1753: /* ARGSUSED */
1754: static void
1755: termp_ss_post(DECL_ARGS)
1756: {
1757:
1.29 kristaps 1758: if (MDOC_HEAD == node->type)
1.1 kristaps 1759: term_newln(p);
1760: }
1761:
1762:
1763: /* ARGSUSED */
1764: static int
1765: termp_em_pre(DECL_ARGS)
1766: {
1767:
1.28 kristaps 1768: pair->flag |= ttypes[TTYPE_EMPH];
1.1 kristaps 1769: return(1);
1770: }
1771:
1772:
1773: /* ARGSUSED */
1774: static int
1775: termp_cd_pre(DECL_ARGS)
1776: {
1777:
1.28 kristaps 1778: pair->flag |= ttypes[TTYPE_CONFIG];
1.1 kristaps 1779: term_newln(p);
1780: return(1);
1781: }
1782:
1783:
1784: /* ARGSUSED */
1785: static int
1786: termp_cm_pre(DECL_ARGS)
1787: {
1788:
1.28 kristaps 1789: pair->flag |= ttypes[TTYPE_CMD_FLAG];
1.1 kristaps 1790: return(1);
1791: }
1792:
1793:
1794: /* ARGSUSED */
1795: static int
1796: termp_ic_pre(DECL_ARGS)
1797: {
1798:
1.28 kristaps 1799: pair->flag |= ttypes[TTYPE_CMD];
1.1 kristaps 1800: return(1);
1801: }
1802:
1803:
1804: /* ARGSUSED */
1805: static int
1806: termp_in_pre(DECL_ARGS)
1807: {
1808:
1.28 kristaps 1809: pair->flag |= ttypes[TTYPE_INCLUDE];
1810: p->flags |= ttypes[TTYPE_INCLUDE];
1.22 kristaps 1811:
1812: if (SEC_SYNOPSIS == node->sec)
1813: term_word(p, "#include");
1814:
1.1 kristaps 1815: term_word(p, "<");
1816: p->flags |= TERMP_NOSPACE;
1817: return(1);
1818: }
1819:
1820:
1821: /* ARGSUSED */
1822: static void
1823: termp_in_post(DECL_ARGS)
1824: {
1825:
1.46 kristaps 1826: p->flags |= TERMP_NOSPACE | ttypes[TTYPE_INCLUDE];
1.1 kristaps 1827: term_word(p, ">");
1.46 kristaps 1828: p->flags &= ~ttypes[TTYPE_INCLUDE];
1.1 kristaps 1829:
1830: if (SEC_SYNOPSIS != node->sec)
1831: return;
1.22 kristaps 1832:
1833: term_newln(p);
1834: /*
1835: * XXX Not entirely correct. If `.In foo bar' is specified in
1836: * the SYNOPSIS section, then it produces a single break after
1837: * the <foo>; mandoc asserts a vertical space. Since this
1838: * construction is rarely used, I think it's fine.
1839: */
1.1 kristaps 1840: if (node->next && MDOC_In != node->next->tok)
1841: term_vspace(p);
1842: }
1843:
1844:
1845: /* ARGSUSED */
1846: static int
1.45 kristaps 1847: termp_sp_pre(DECL_ARGS)
1848: {
1849: int i, len;
1850:
1851: if (NULL == node->child) {
1852: term_vspace(p);
1853: return(0);
1854: }
1855:
1856: len = atoi(node->child->string);
1857: if (0 == len)
1858: term_newln(p);
1859: for (i = 0; i < len; i++)
1860: term_vspace(p);
1861:
1862: return(0);
1863: }
1864:
1865:
1866: /* ARGSUSED */
1867: static int
1.44 kristaps 1868: termp_br_pre(DECL_ARGS)
1869: {
1870:
1871: term_newln(p);
1872: return(1);
1873: }
1874:
1875:
1876: /* ARGSUSED */
1877: static int
1.1 kristaps 1878: termp_brq_pre(DECL_ARGS)
1879: {
1880:
1881: if (MDOC_BODY != node->type)
1882: return(1);
1883: term_word(p, "\\(lC");
1884: p->flags |= TERMP_NOSPACE;
1885: return(1);
1886: }
1887:
1888:
1889: /* ARGSUSED */
1890: static void
1891: termp_brq_post(DECL_ARGS)
1892: {
1893:
1894: if (MDOC_BODY != node->type)
1895: return;
1896: p->flags |= TERMP_NOSPACE;
1897: term_word(p, "\\(rC");
1898: }
1899:
1900:
1901: /* ARGSUSED */
1902: static int
1903: termp_bq_pre(DECL_ARGS)
1904: {
1905:
1906: if (MDOC_BODY != node->type)
1907: return(1);
1908: term_word(p, "\\(lB");
1909: p->flags |= TERMP_NOSPACE;
1910: return(1);
1911: }
1912:
1913:
1914: /* ARGSUSED */
1915: static void
1916: termp_bq_post(DECL_ARGS)
1917: {
1918:
1919: if (MDOC_BODY != node->type)
1920: return;
1921: p->flags |= TERMP_NOSPACE;
1922: term_word(p, "\\(rB");
1923: }
1924:
1925:
1926: /* ARGSUSED */
1927: static int
1928: termp_pq_pre(DECL_ARGS)
1929: {
1930:
1931: if (MDOC_BODY != node->type)
1932: return(1);
1933: term_word(p, "\\&(");
1934: p->flags |= TERMP_NOSPACE;
1935: return(1);
1936: }
1937:
1938:
1939: /* ARGSUSED */
1940: static void
1941: termp_pq_post(DECL_ARGS)
1942: {
1943:
1944: if (MDOC_BODY != node->type)
1945: return;
1946: term_word(p, ")");
1947: }
1948:
1949:
1950: /* ARGSUSED */
1951: static int
1952: termp_fo_pre(DECL_ARGS)
1953: {
1954: const struct mdoc_node *n;
1955:
1956: if (MDOC_BODY == node->type) {
1.33 kristaps 1957: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1958: term_word(p, "(");
1959: p->flags |= TERMP_NOSPACE;
1960: return(1);
1961: } else if (MDOC_HEAD != node->type)
1962: return(1);
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:
1.28 kristaps 1996: if (MDOC_HEAD == node->type)
1.1 kristaps 1997: return(0);
1.28 kristaps 1998: else if (MDOC_BLOCK != node->type)
1.1 kristaps 1999: return(1);
2000:
2001: if (NULL == (n = node->head->child)) {
2002: if (arg_hasattr(MDOC_Emphasis, node))
1.28 kristaps 2003: pair->flag |= ttypes[TTYPE_EMPH];
1.1 kristaps 2004: else if (arg_hasattr(MDOC_Symbolic, node))
1.28 kristaps 2005: pair->flag |= ttypes[TTYPE_SYMB];
1.1 kristaps 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))
1.28 kristaps 2012: pair->flag |= ttypes[TTYPE_EMPH];
1.1 kristaps 2013: else if (0 == strcmp("Sy", n->string))
1.28 kristaps 2014: pair->flag |= ttypes[TTYPE_SYMB];
1.1 kristaps 2015:
2016: return(1);
2017: }
2018:
2019:
2020: /* ARGSUSED */
2021: static int
2022: termp_sy_pre(DECL_ARGS)
2023: {
2024:
1.28 kristaps 2025: pair->flag |= ttypes[TTYPE_SYMB];
1.1 kristaps 2026: return(1);
2027: }
2028:
2029:
2030: /* ARGSUSED */
2031: static int
2032: termp_ms_pre(DECL_ARGS)
2033: {
2034:
1.28 kristaps 2035: pair->flag |= ttypes[TTYPE_SYMBOL];
1.1 kristaps 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:
1.28 kristaps 2074: pair->flag |= ttypes[TTYPE_REF_JOURNAL];
1.1 kristaps 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) {
1.28 kristaps 2121: pair->flag |= ttypes[TTYPE_LINK_ANCHOR];
1.12 kristaps 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:
1.28 kristaps 2145: pair->flag |= ttypes[TTYPE_LINK_ANCHOR];
1.1 kristaps 2146: return(1);
2147: }
2148:
2149:
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mdoc_term.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc