]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_action.c
1 /* $Id: mdoc_action.c,v 1.30 2009/07/17 10:56:57 kristaps Exp $ */
3 * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
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.
17 #include <sys/utsname.h>
27 #define PRE_ARGS struct mdoc *m, const struct mdoc_node *n
28 #define POST_ARGS struct mdoc *m
32 int (*post
)(POST_ARGS
);
35 static int post_ar(POST_ARGS
);
36 static int post_at(POST_ARGS
);
37 static int post_bl(POST_ARGS
);
38 static int post_bl_head(POST_ARGS
);
39 static int post_bl_tagwidth(POST_ARGS
);
40 static int post_bl_width(POST_ARGS
);
41 static int post_dd(POST_ARGS
);
42 static int post_display(POST_ARGS
);
43 static int post_dt(POST_ARGS
);
44 static int post_lb(POST_ARGS
);
45 static int post_lk(POST_ARGS
);
46 static int post_nm(POST_ARGS
);
47 static int post_os(POST_ARGS
);
48 static int post_prol(POST_ARGS
);
49 static int post_sh(POST_ARGS
);
50 static int post_st(POST_ARGS
);
51 static int post_std(POST_ARGS
);
53 static int pre_bd(PRE_ARGS
);
54 static int pre_dl(PRE_ARGS
);
56 const struct actions mdoc_actions
[MDOC_MAX
] = {
57 { NULL
, NULL
}, /* Ap */
58 { NULL
, post_dd
}, /* Dd */
59 { NULL
, post_dt
}, /* Dt */
60 { NULL
, post_os
}, /* Os */
61 { NULL
, post_sh
}, /* Sh */
62 { NULL
, NULL
}, /* Ss */
63 { NULL
, NULL
}, /* Pp */
64 { NULL
, NULL
}, /* D1 */
65 { pre_dl
, post_display
}, /* Dl */
66 { pre_bd
, post_display
}, /* Bd */
67 { NULL
, NULL
}, /* Ed */
68 { NULL
, post_bl
}, /* Bl */
69 { NULL
, NULL
}, /* El */
70 { NULL
, NULL
}, /* It */
71 { NULL
, NULL
}, /* Ad */
72 { NULL
, NULL
}, /* An */
73 { NULL
, post_ar
}, /* Ar */
74 { NULL
, NULL
}, /* Cd */ /* FIXME: tabs are accepted! */
75 { NULL
, NULL
}, /* Cm */
76 { NULL
, NULL
}, /* Dv */
77 { NULL
, NULL
}, /* Er */
78 { NULL
, NULL
}, /* Ev */
79 { NULL
, post_std
}, /* Ex */
80 { NULL
, NULL
}, /* Fa */
81 { NULL
, NULL
}, /* Fd */
82 { NULL
, NULL
}, /* Fl */
83 { NULL
, NULL
}, /* Fn */
84 { NULL
, NULL
}, /* Ft */
85 { NULL
, NULL
}, /* Ic */
86 { NULL
, NULL
}, /* In */
87 { NULL
, NULL
}, /* Li */
88 { NULL
, NULL
}, /* Nd */
89 { NULL
, post_nm
}, /* Nm */
90 { NULL
, NULL
}, /* Op */
91 { NULL
, NULL
}, /* Ot */
92 { NULL
, NULL
}, /* Pa */
93 { NULL
, post_std
}, /* Rv */
94 { NULL
, post_st
}, /* St */
95 { NULL
, NULL
}, /* Va */
96 { NULL
, NULL
}, /* Vt */
97 { NULL
, NULL
}, /* Xr */
98 { NULL
, NULL
}, /* %A */
99 { NULL
, NULL
}, /* %B */
100 { NULL
, NULL
}, /* %D */
101 { NULL
, NULL
}, /* %I */
102 { NULL
, NULL
}, /* %J */
103 { NULL
, NULL
}, /* %N */
104 { NULL
, NULL
}, /* %O */
105 { NULL
, NULL
}, /* %P */
106 { NULL
, NULL
}, /* %R */
107 { NULL
, NULL
}, /* %T */
108 { NULL
, NULL
}, /* %V */
109 { NULL
, NULL
}, /* Ac */
110 { NULL
, NULL
}, /* Ao */
111 { NULL
, NULL
}, /* Aq */
112 { NULL
, post_at
}, /* At */
113 { NULL
, NULL
}, /* Bc */
114 { NULL
, NULL
}, /* Bf */
115 { NULL
, NULL
}, /* Bo */
116 { NULL
, NULL
}, /* Bq */
117 { NULL
, NULL
}, /* Bsx */
118 { NULL
, NULL
}, /* Bx */
119 { NULL
, NULL
}, /* Db */
120 { NULL
, NULL
}, /* Dc */
121 { NULL
, NULL
}, /* Do */
122 { NULL
, NULL
}, /* Dq */
123 { NULL
, NULL
}, /* Ec */
124 { NULL
, NULL
}, /* Ef */
125 { NULL
, NULL
}, /* Em */
126 { NULL
, NULL
}, /* Eo */
127 { NULL
, NULL
}, /* Fx */
128 { NULL
, NULL
}, /* Ms */
129 { NULL
, NULL
}, /* No */
130 { NULL
, NULL
}, /* Ns */
131 { NULL
, NULL
}, /* Nx */
132 { NULL
, NULL
}, /* Ox */
133 { NULL
, NULL
}, /* Pc */
134 { NULL
, NULL
}, /* Pf */
135 { NULL
, NULL
}, /* Po */
136 { NULL
, NULL
}, /* Pq */
137 { NULL
, NULL
}, /* Qc */
138 { NULL
, NULL
}, /* Ql */
139 { NULL
, NULL
}, /* Qo */
140 { NULL
, NULL
}, /* Qq */
141 { NULL
, NULL
}, /* Re */
142 { NULL
, NULL
}, /* Rs */
143 { NULL
, NULL
}, /* Sc */
144 { NULL
, NULL
}, /* So */
145 { NULL
, NULL
}, /* Sq */
146 { NULL
, NULL
}, /* Sm */
147 { NULL
, NULL
}, /* Sx */
148 { NULL
, NULL
}, /* Sy */
149 { NULL
, NULL
}, /* Tn */
150 { NULL
, NULL
}, /* Ux */
151 { NULL
, NULL
}, /* Xc */
152 { NULL
, NULL
}, /* Xo */
153 { NULL
, NULL
}, /* Fo */
154 { NULL
, NULL
}, /* Fc */
155 { NULL
, NULL
}, /* Oo */
156 { NULL
, NULL
}, /* Oc */
157 { NULL
, NULL
}, /* Bk */
158 { NULL
, NULL
}, /* Ek */
159 { NULL
, NULL
}, /* Bt */
160 { NULL
, NULL
}, /* Hf */
161 { NULL
, NULL
}, /* Fr */
162 { NULL
, NULL
}, /* Ud */
163 { NULL
, post_lb
}, /* Lb */
164 { NULL
, NULL
}, /* Lp */
165 { NULL
, post_lk
}, /* Lk */
166 { NULL
, NULL
}, /* Mt */
167 { NULL
, NULL
}, /* Brq */
168 { NULL
, NULL
}, /* Bro */
169 { NULL
, NULL
}, /* Brc */
170 { NULL
, NULL
}, /* %C */
171 { NULL
, NULL
}, /* Es */
172 { NULL
, NULL
}, /* En */
173 { NULL
, NULL
}, /* Dx */
174 { NULL
, NULL
}, /* %Q */
175 { NULL
, NULL
}, /* br */
176 { NULL
, NULL
}, /* sp */
179 static int concat(struct mdoc
*, const struct mdoc_node
*,
183 extern size_t strlcat(char *, const char *, size_t);
188 mdoc_action_pre(struct mdoc
*m
, const struct mdoc_node
*n
)
200 if (NULL
== mdoc_actions
[n
->tok
].pre
)
202 return((*mdoc_actions
[n
->tok
].pre
)(m
, n
));
207 mdoc_action_post(struct mdoc
*m
)
210 if (MDOC_ACTED
& m
->last
->flags
)
212 m
->last
->flags
|= MDOC_ACTED
;
214 switch (m
->last
->type
) {
223 if (NULL
== mdoc_actions
[m
->last
->tok
].post
)
225 return((*mdoc_actions
[m
->last
->tok
].post
)(m
));
230 concat(struct mdoc
*m
, const struct mdoc_node
*n
,
231 char *buf
, size_t sz
)
234 for ( ; n
; n
= n
->next
) {
235 assert(MDOC_TEXT
== n
->type
);
236 if (strlcat(buf
, n
->string
, sz
) >= sz
)
237 return(mdoc_nerr(m
, n
, ETOOLONG
));
240 if (strlcat(buf
, " ", sz
) >= sz
)
241 return(mdoc_nerr(m
, n
, ETOOLONG
));
253 * If '-std' is invoked without an argument, fill it in with our
254 * name (if it's been set).
257 if (NULL
== m
->last
->args
)
259 if (m
->last
->args
->argv
[0].sz
)
262 assert(m
->meta
.name
);
264 m
->last
->args
->argv
[0].value
= calloc(1, sizeof(char *));
265 if (NULL
== m
->last
->args
->argv
[0].value
)
266 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
268 m
->last
->args
->argv
[0].sz
= 1;
269 m
->last
->args
->argv
[0].value
[0] = strdup(m
->meta
.name
);
270 if (NULL
== m
->last
->args
->argv
[0].value
[0])
271 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
286 if ( ! concat(m
, m
->last
->child
, buf
, sizeof(buf
)))
289 if (NULL
== (m
->meta
.name
= strdup(buf
)))
290 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
303 assert(MDOC_TEXT
== m
->last
->child
->type
);
304 p
= mdoc_a2lib(m
->last
->child
->string
);
306 sz
= strlen(m
->last
->child
->string
) +
307 2 + strlen("\\(lqlibrary\\(rq");
310 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
311 (void)snprintf(buf
, sz
, "library \\(lq%s\\(rq",
312 m
->last
->child
->string
);
313 free(m
->last
->child
->string
);
314 m
->last
->child
->string
= buf
;
318 free(m
->last
->child
->string
);
319 m
->last
->child
->string
= strdup(p
);
320 if (NULL
== m
->last
->child
->string
)
321 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
331 assert(MDOC_TEXT
== m
->last
->child
->type
);
332 p
= mdoc_a2st(m
->last
->child
->string
);
334 free(m
->last
->child
->string
);
335 m
->last
->child
->string
= strdup(p
);
336 if (NULL
== m
->last
->child
->string
)
337 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
348 if (m
->last
->child
) {
349 assert(MDOC_TEXT
== m
->last
->child
->type
);
350 p
= mdoc_a2att(m
->last
->child
->string
);
352 free(m
->last
->child
->string
);
353 m
->last
->child
->string
= strdup(p
);
354 if (NULL
== m
->last
->child
->string
)
355 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
360 m
->next
= MDOC_NEXT_CHILD
;
362 if ( ! mdoc_word_alloc(m
, n
->line
, n
->pos
, "AT&T UNIX"))
366 m
->next
= MDOC_NEXT_SIBLING
;
378 * We keep track of the current section /and/ the "named"
379 * section, which is one of the conventional ones, in order to
383 if (MDOC_HEAD
!= m
->last
->type
)
387 if ( ! concat(m
, m
->last
->child
, buf
, sizeof(buf
)))
389 if (SEC_CUSTOM
!= (sec
= mdoc_atosec(buf
)))
392 switch ((m
->lastsec
= sec
)) {
393 case (SEC_RETURN_VALUES
):
396 switch (m
->meta
.msec
) {
404 return(mdoc_nwarn(m
, m
->last
, EBADSEC
));
429 m
->meta
.title
= m
->meta
.vol
= m
->meta
.arch
= NULL
;
433 * --> title = unknown, volume = local, msec = 0, arch = NULL
436 if (NULL
== (n
= m
->last
->child
)) {
437 if (NULL
== (m
->meta
.title
= strdup("unknown")))
438 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
439 if (NULL
== (m
->meta
.vol
= strdup("local")))
440 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
441 return(post_prol(m
));
444 /* Handles: `.Dt TITLE'
445 * --> title = TITLE, volume = local, msec = 0, arch = NULL
448 if (NULL
== (m
->meta
.title
= strdup(n
->string
)))
449 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
451 if (NULL
== (n
= n
->next
)) {
452 if (NULL
== (m
->meta
.vol
= strdup("local")))
453 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
454 return(post_prol(m
));
457 /* Handles: `.Dt TITLE SEC'
458 * --> title = TITLE, volume = SEC is msec ?
459 * format(msec) : SEC,
460 * msec = SEC is msec ? atoi(msec) : 0,
464 cp
= mdoc_a2msec(n
->string
);
466 if (NULL
== (m
->meta
.vol
= strdup(cp
)))
467 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
469 lval
= strtol(n
->string
, &ep
, 10);
470 if (n
->string
[0] != '\0' && *ep
== '\0')
471 m
->meta
.msec
= (int)lval
;
472 } else if (NULL
== (m
->meta
.vol
= strdup(n
->string
)))
473 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
475 if (NULL
== (n
= n
->next
))
476 return(post_prol(m
));
478 /* Handles: `.Dt TITLE SEC VOL'
479 * --> title = TITLE, volume = VOL is vol ?
481 * VOL is arch ? format(arch) :
485 cp
= mdoc_a2vol(n
->string
);
488 if (NULL
== (m
->meta
.vol
= strdup(cp
)))
489 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
492 cp
= mdoc_a2arch(n
->string
);
495 if (NULL
== (m
->meta
.vol
= strdup(n
->string
)))
496 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
497 } else if (NULL
== (m
->meta
.arch
= strdup(cp
)))
498 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
501 /* Ignore any subsequent parameters... */
503 return(post_prol(m
));
511 struct utsname utsname
;
517 if ( ! concat(m
, m
->last
->child
, buf
, sizeof(buf
)))
521 if (-1 == uname(&utsname
))
522 return(mdoc_nerr(m
, m
->last
, EUTSNAME
));
523 if (strlcat(buf
, utsname
.sysname
, 64) >= 64)
524 return(mdoc_nerr(m
, m
->last
, ETOOLONG
));
525 if (strlcat(buf
, " ", 64) >= 64)
526 return(mdoc_nerr(m
, m
->last
, ETOOLONG
));
527 if (strlcat(buf
, utsname
.release
, 64) >= 64)
528 return(mdoc_nerr(m
, m
->last
, ETOOLONG
));
531 if (NULL
== (m
->meta
.os
= strdup(buf
)))
532 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
534 m
->flags
|= MDOC_PBODY
;
535 return(post_prol(m
));
540 * Calculate the -width for a `Bl -tag' list if it hasn't been provided.
541 * Uses the first head macro.
544 post_bl_tagwidth(struct mdoc
*m
)
551 * Use the text width, if a text node, or the default macro
555 n
= m
->last
->body
->child
;
557 assert(MDOC_BLOCK
== n
->type
);
558 assert(MDOC_It
== n
->tok
);
562 sz
= 10; /* Default size. */
565 if (MDOC_TEXT
!= n
->type
) {
566 if (0 == (sz
= (int)mdoc_macro2len(n
->tok
)))
567 if ( ! mdoc_nwarn(m
, m
->last
, ENOWIDTH
))
570 sz
= (int)strlen(n
->string
) + 1;
573 if (-1 == snprintf(buf
, sizeof(buf
), "%dn", sz
))
574 return(mdoc_nerr(m
, m
->last
, ENUMFMT
));
577 * We have to dynamically add this to the macro's argument list.
578 * We're guaranteed that a MDOC_Width doesn't already exist.
583 sz
= (int)(n
->args
->argc
)++;
585 n
->args
->argv
= realloc(n
->args
->argv
,
586 n
->args
->argc
* sizeof(struct mdoc_argv
));
588 if (NULL
== n
->args
->argv
)
589 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
591 n
->args
->argv
[sz
].arg
= MDOC_Width
;
592 n
->args
->argv
[sz
].line
= m
->last
->line
;
593 n
->args
->argv
[sz
].pos
= m
->last
->pos
;
594 n
->args
->argv
[sz
].sz
= 1;
595 n
->args
->argv
[sz
].value
= calloc(1, sizeof(char *));
597 if (NULL
== n
->args
->argv
[sz
].value
)
598 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
599 if (NULL
== (n
->args
->argv
[sz
].value
[0] = strdup(buf
)))
600 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
607 post_bl_width(struct mdoc
*m
)
614 if (NULL
== m
->last
->args
)
617 for (i
= 0; i
< (int)m
->last
->args
->argc
; i
++)
618 if (MDOC_Width
== m
->last
->args
->argv
[i
].arg
)
621 if (i
== (int)m
->last
->args
->argc
)
623 p
= m
->last
->args
->argv
[i
].value
[0];
626 * If the value to -width is a macro, then we re-write it to be
627 * the macro's width as set in share/tmac/mdoc/doc-common.
630 if (0 == strcmp(p
, "Ds"))
632 else if (MDOC_MAX
== (tok
= mdoc_hash_find(m
->htab
, p
)))
634 else if (0 == (width
= mdoc_macro2len(tok
)))
635 return(mdoc_nwarn(m
, m
->last
, ENOWIDTH
));
637 /* The value already exists: free and reallocate it. */
639 if (-1 == snprintf(buf
, sizeof(buf
), "%zun", width
))
640 return(mdoc_nerr(m
, m
->last
, ENUMFMT
));
642 free(m
->last
->args
->argv
[i
].value
[0]);
643 m
->last
->args
->argv
[i
].value
[0] = strdup(buf
);
644 if (NULL
== m
->last
->args
->argv
[i
].value
[0])
645 return(mdoc_nerr(m
, m
->last
, EMALLOC
));
652 post_bl_head(POST_ARGS
)
655 struct mdoc_node
*n
, *nn
, *nnp
;
657 if (NULL
== m
->last
->child
)
663 for (c
= 0; c
< (int)n
->args
->argc
; c
++)
664 if (MDOC_Column
== n
->args
->argv
[c
].arg
)
667 /* Only process -column. */
669 if (c
== (int)n
->args
->argc
)
672 assert(0 == n
->args
->argv
[c
].sz
);
675 * Accomodate for new-style groff column syntax. Shuffle the
676 * child nodes, all of which must be TEXT, as arguments for the
677 * column field. Then, delete the head children.
680 n
->args
->argv
[c
].sz
= (size_t)m
->last
->nchild
;
681 n
->args
->argv
[c
].value
= malloc
682 ((size_t)m
->last
->nchild
* sizeof(char *));
684 for (i
= 0, nn
= m
->last
->child
; nn
; i
++) {
685 n
->args
->argv
[c
].value
[i
] = nn
->string
;
693 m
->last
->child
= NULL
;
704 if (MDOC_HEAD
== m
->last
->type
)
705 return(post_bl_head(m
));
706 if (MDOC_BLOCK
!= m
->last
->type
)
710 * These are fairly complicated, so we've broken them into two
711 * functions. post_bl_tagwidth() is called when a -tag is
712 * specified, but no -width (it must be guessed). The second
713 * when a -width is specified (macro indicators must be
714 * rewritten into real lengths).
717 len
= (int)(m
->last
->args
? m
->last
->args
->argc
: 0);
719 for (r
= i
= 0; i
< len
; i
++) {
720 if (MDOC_Tag
== m
->last
->args
->argv
[i
].arg
)
722 if (MDOC_Width
== m
->last
->args
->argv
[i
].arg
)
726 if (r
& (1 << 0) && ! (r
& (1 << 1))) {
727 if ( ! post_bl_tagwidth(m
))
729 } else if (r
& (1 << 1))
730 if ( ! post_bl_width(m
))
746 m
->next
= MDOC_NEXT_CHILD
;
748 /* XXX: this isn't documented anywhere! */
749 if ( ! mdoc_word_alloc(m
, m
->last
->line
, m
->last
->pos
, "~"))
753 m
->next
= MDOC_NEXT_SIBLING
;
767 m
->next
= MDOC_NEXT_CHILD
;
768 if ( ! mdoc_word_alloc(m
, m
->last
->line
, m
->last
->pos
, "file"))
770 m
->next
= MDOC_NEXT_SIBLING
;
771 if ( ! mdoc_word_alloc(m
, m
->last
->line
, m
->last
->pos
, "..."))
775 m
->next
= MDOC_NEXT_SIBLING
;
786 if ( ! concat(m
, m
->last
->child
, buf
, sizeof(buf
)))
789 if (0 == (m
->meta
.date
= mdoc_atotime(buf
))) {
790 if ( ! mdoc_nwarn(m
, m
->last
, EBADDATE
))
792 m
->meta
.date
= time(NULL
);
795 return(post_prol(m
));
805 * The end document shouldn't have the prologue macros as part
806 * of the syntax tree (they encompass only meta-data).
809 if (m
->last
->parent
->child
== m
->last
)
810 m
->last
->parent
->child
= m
->last
->prev
;
812 m
->last
->prev
->next
= NULL
;
815 assert(NULL
== m
->last
->next
);
818 m
->last
= m
->last
->prev
;
819 m
->next
= MDOC_NEXT_SIBLING
;
821 m
->last
= m
->last
->parent
;
822 m
->next
= MDOC_NEXT_CHILD
;
825 mdoc_node_freelist(n
);
834 if (MDOC_BODY
== n
->type
)
835 m
->flags
|= MDOC_LITERAL
;
845 if (MDOC_BODY
!= n
->type
)
848 /* Enter literal context if `Bd -literal' or * -unfilled'. */
850 for (n
= n
->parent
, i
= 0; i
< (int)n
->args
->argc
; i
++)
851 if (MDOC_Literal
== n
->args
->argv
[i
].arg
)
853 else if (MDOC_Unfilled
== n
->args
->argv
[i
].arg
)
856 if (i
< (int)n
->args
->argc
)
857 m
->flags
|= MDOC_LITERAL
;
864 post_display(POST_ARGS
)
867 if (MDOC_BODY
== m
->last
->type
)
868 m
->flags
&= ~MDOC_LITERAL
;