]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_action.c
1 /* $Id: mdoc_action.c,v 1.5 2009/04/03 11:08:39 kristaps Exp $ */
3 * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the
7 * above copyright notice and this permission notice appear in all
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17 * PERFORMANCE OF THIS SOFTWARE.
19 #include <sys/utsname.h>
41 #define PRE_ARGS struct mdoc *m, const struct mdoc_node *n
42 #define POST_ARGS struct mdoc *m
46 int (*post
)(POST_ARGS
);
49 static int pwarn(struct mdoc
*, int, int, enum mwarn
);
50 static int perr(struct mdoc
*, int, int, enum merr
);
51 static int concat(struct mdoc
*, const struct mdoc_node
*,
54 static int post_ar(POST_ARGS
);
55 static int post_bl(POST_ARGS
);
56 static int post_bl_width(POST_ARGS
);
57 static int post_bl_tagwidth(POST_ARGS
);
58 static int post_dd(POST_ARGS
);
59 static int post_display(POST_ARGS
);
60 static int post_dt(POST_ARGS
);
61 static int post_nm(POST_ARGS
);
62 static int post_os(POST_ARGS
);
63 static int post_prol(POST_ARGS
);
64 static int post_sh(POST_ARGS
);
65 static int post_std(POST_ARGS
);
67 static int pre_bd(PRE_ARGS
);
68 static int pre_dl(PRE_ARGS
);
70 #define vwarn(m, t) pwarn((m), (m)->last->line, (m)->last->pos, (t))
71 #define verr(m, t) perr((m), (m)->last->line, (m)->last->pos, (t))
72 #define nerr(m, n, t) perr((m), (n)->line, (n)->pos, (t))
74 const struct actions mdoc_actions
[MDOC_MAX
] = {
75 { NULL
, NULL
}, /* \" */
76 { NULL
, post_dd
}, /* Dd */
77 { NULL
, post_dt
}, /* Dt */
78 { NULL
, post_os
}, /* Os */
79 { NULL
, post_sh
}, /* Sh */
80 { NULL
, NULL
}, /* Ss */
81 { NULL
, NULL
}, /* Pp */
82 { NULL
, NULL
}, /* D1 */
83 { pre_dl
, post_display
}, /* Dl */
84 { pre_bd
, post_display
}, /* Bd */
85 { NULL
, NULL
}, /* Ed */
86 { NULL
, post_bl
}, /* Bl */
87 { NULL
, NULL
}, /* El */
88 { NULL
, NULL
}, /* It */
89 { NULL
, NULL
}, /* Ad */
90 { NULL
, NULL
}, /* An */
91 { NULL
, post_ar
}, /* Ar */
92 { NULL
, NULL
}, /* Cd */
93 { NULL
, NULL
}, /* Cm */
94 { NULL
, NULL
}, /* Dv */
95 { NULL
, NULL
}, /* Er */
96 { NULL
, NULL
}, /* Ev */
97 { NULL
, post_std
}, /* Ex */
98 { NULL
, NULL
}, /* Fa */
99 { NULL
, NULL
}, /* Fd */
100 { NULL
, NULL
}, /* Fl */
101 { NULL
, NULL
}, /* Fn */
102 { NULL
, NULL
}, /* Ft */
103 { NULL
, NULL
}, /* Ic */
104 { NULL
, NULL
}, /* In */
105 { NULL
, NULL
}, /* Li */
106 { NULL
, NULL
}, /* Nd */
107 { NULL
, post_nm
}, /* Nm */
108 { NULL
, NULL
}, /* Op */
109 { NULL
, NULL
}, /* Ot */
110 { NULL
, NULL
}, /* Pa */
111 { NULL
, post_std
}, /* Rv */
112 { NULL
, NULL
}, /* St */
113 { NULL
, NULL
}, /* Va */
114 { NULL
, NULL
}, /* Vt */
115 { NULL
, NULL
}, /* Xr */
116 { NULL
, NULL
}, /* %A */
117 { NULL
, NULL
}, /* %B */
118 { NULL
, NULL
}, /* %D */
119 { NULL
, NULL
}, /* %I */
120 { NULL
, NULL
}, /* %J */
121 { NULL
, NULL
}, /* %N */
122 { NULL
, NULL
}, /* %O */
123 { NULL
, NULL
}, /* %P */
124 { NULL
, NULL
}, /* %R */
125 { NULL
, NULL
}, /* %T */
126 { NULL
, NULL
}, /* %V */
127 { NULL
, NULL
}, /* Ac */
128 { NULL
, NULL
}, /* Ao */
129 { NULL
, NULL
}, /* Aq */
130 { NULL
, NULL
}, /* At */
131 { NULL
, NULL
}, /* Bc */
132 { NULL
, NULL
}, /* Bf */
133 { NULL
, NULL
}, /* Bo */
134 { NULL
, NULL
}, /* Bq */
135 { NULL
, NULL
}, /* Bsx */
136 { NULL
, NULL
}, /* Bx */
137 { NULL
, NULL
}, /* Db */
138 { NULL
, NULL
}, /* Dc */
139 { NULL
, NULL
}, /* Do */
140 { NULL
, NULL
}, /* Dq */
141 { NULL
, NULL
}, /* Ec */
142 { NULL
, NULL
}, /* Ef */
143 { NULL
, NULL
}, /* Em */
144 { NULL
, NULL
}, /* Eo */
145 { NULL
, NULL
}, /* Fx */
146 { NULL
, NULL
}, /* Ms */
147 { NULL
, NULL
}, /* No */
148 { NULL
, NULL
}, /* Ns */
149 { NULL
, NULL
}, /* Nx */
150 { NULL
, NULL
}, /* Ox */
151 { NULL
, NULL
}, /* Pc */
152 { NULL
, NULL
}, /* Pf */
153 { NULL
, NULL
}, /* Po */
154 { NULL
, NULL
}, /* Pq */
155 { NULL
, NULL
}, /* Qc */
156 { NULL
, NULL
}, /* Ql */
157 { NULL
, NULL
}, /* Qo */
158 { NULL
, NULL
}, /* Qq */
159 { NULL
, NULL
}, /* Re */
160 { NULL
, NULL
}, /* Rs */
161 { NULL
, NULL
}, /* Sc */
162 { NULL
, NULL
}, /* So */
163 { NULL
, NULL
}, /* Sq */
164 { NULL
, NULL
}, /* Sm */
165 { NULL
, NULL
}, /* Sx */
166 { NULL
, NULL
}, /* Sy */
167 { NULL
, NULL
}, /* Tn */
168 { NULL
, NULL
}, /* Ux */
169 { NULL
, NULL
}, /* Xc */
170 { NULL
, NULL
}, /* Xo */
171 { NULL
, NULL
}, /* Fo */
172 { NULL
, NULL
}, /* Fc */
173 { NULL
, NULL
}, /* Oo */
174 { NULL
, NULL
}, /* Oc */
175 { NULL
, NULL
}, /* Bk */
176 { NULL
, NULL
}, /* Ek */
177 { NULL
, NULL
}, /* Bt */
178 { NULL
, NULL
}, /* Hf */
179 { NULL
, NULL
}, /* Fr */
180 { NULL
, NULL
}, /* Ud */
181 { NULL
, NULL
}, /* Lb */
182 { NULL
, NULL
}, /* Ap */
183 { NULL
, NULL
}, /* Lp */
184 { NULL
, NULL
}, /* Lk */
185 { NULL
, NULL
}, /* Mt */
186 { NULL
, NULL
}, /* Brq */
187 { NULL
, NULL
}, /* Bro */
188 { NULL
, NULL
}, /* Brc */
189 { NULL
, NULL
}, /* %C */
190 { NULL
, NULL
}, /* Es */
191 { NULL
, NULL
}, /* En */
192 { NULL
, NULL
}, /* Dx */
193 { NULL
, NULL
}, /* %Q */
198 extern size_t strlcat(char *, const char *, size_t);
203 mdoc_action_pre(struct mdoc
*m
, const struct mdoc_node
*n
)
215 if (NULL
== mdoc_actions
[m
->last
->tok
].pre
)
217 return((*mdoc_actions
[m
->last
->tok
].pre
)(m
, n
));
222 mdoc_action_post(struct mdoc
*m
)
225 if (MDOC_ACTED
& m
->last
->flags
)
227 m
->last
->flags
|= MDOC_ACTED
;
229 switch (m
->last
->type
) {
238 if (NULL
== mdoc_actions
[m
->last
->tok
].post
)
240 return((*mdoc_actions
[m
->last
->tok
].post
)(m
));
245 concat(struct mdoc
*m
, const struct mdoc_node
*n
,
246 char *buf
, size_t sz
)
249 for ( ; n
; n
= n
->next
) {
250 assert(MDOC_TEXT
== n
->type
);
251 if (strlcat(buf
, n
->string
, sz
) >= sz
)
252 return(nerr(m
, n
, ETOOLONG
));
255 if (strlcat(buf
, " ", sz
) >= sz
)
256 return(nerr(m
, n
, ETOOLONG
));
264 perr(struct mdoc
*m
, int line
, int pos
, enum merr type
)
271 p
= "bad number format";
274 p
= "argument text too long";
277 p
= "memory exhausted";
281 return(mdoc_perr(m
, line
, pos
, p
));
286 pwarn(struct mdoc
*m
, int line
, int pos
, enum mwarn type
)
295 p
= "inappropriate document section in manual section";
299 p
= "cannot determine default width";
302 p
= "malformed date syntax";
306 return(mdoc_pwarn(m
, line
, pos
, c
, p
));
315 * If '-std' is invoked without an argument, fill it in with our
316 * name (if it's been set).
319 if (NULL
== m
->last
->args
)
321 if (m
->last
->args
->argv
[0].sz
)
324 assert(m
->meta
.name
);
326 m
->last
->args
->argv
[0].value
= calloc(1, sizeof(char *));
327 if (NULL
== m
->last
->args
->argv
[0].value
)
328 return(verr(m
, EMALLOC
));
330 m
->last
->args
->argv
[0].sz
= 1;
331 m
->last
->args
->argv
[0].value
[0] = strdup(m
->meta
.name
);
332 if (NULL
== m
->last
->args
->argv
[0].value
[0])
333 return(verr(m
, EMALLOC
));
348 if ( ! concat(m
, m
->last
->child
, buf
, sizeof(buf
)))
350 if (NULL
== (m
->meta
.name
= strdup(buf
)))
351 return(verr(m
, EMALLOC
));
364 * We keep track of the current section /and/ the "named"
365 * section, which is one of the conventional ones, in order to
369 if (MDOC_HEAD
!= m
->last
->type
)
373 if ( ! concat(m
, m
->last
->child
, buf
, sizeof(buf
)))
375 if (SEC_CUSTOM
!= (sec
= mdoc_atosec(buf
)))
378 switch ((m
->lastsec
= sec
)) {
379 case (SEC_RETURN_VALUES
):
382 switch (m
->meta
.msec
) {
390 return(vwarn(m
, WBADSEC
));
415 m
->meta
.title
= m
->meta
.vol
= m
->meta
.arch
= NULL
;
419 * --> title = unknown, volume = local, msec = 0, arch = NULL
422 if (NULL
== (n
= m
->last
->child
)) {
423 if (NULL
== (m
->meta
.title
= strdup("unknown")))
424 return(verr(m
, EMALLOC
));
425 if (NULL
== (m
->meta
.vol
= strdup("local")))
426 return(verr(m
, EMALLOC
));
427 return(post_prol(m
));
430 /* Handles: `.Dt TITLE'
431 * --> title = TITLE, volume = local, msec = 0, arch = NULL
434 if (NULL
== (m
->meta
.title
= strdup(n
->string
)))
435 return(verr(m
, EMALLOC
));
437 if (NULL
== (n
= n
->next
)) {
438 if (NULL
== (m
->meta
.vol
= strdup("local")))
439 return(verr(m
, EMALLOC
));
440 return(post_prol(m
));
443 /* Handles: `.Dt TITLE SEC'
444 * --> title = TITLE, volume = SEC is msec ?
445 * format(msec) : SEC,
446 * msec = SEC is msec ? atoi(msec) : 0,
450 cp
= mdoc_a2msec(n
->string
);
452 if (NULL
== (m
->meta
.vol
= strdup(cp
)))
453 return(verr(m
, EMALLOC
));
455 lval
= strtol(n
->string
, &ep
, 10);
456 if (n
->string
[0] != '\0' && *ep
== '\0')
457 m
->meta
.msec
= (int)lval
;
458 } else if (NULL
== (m
->meta
.vol
= strdup(n
->string
)))
459 return(verr(m
, EMALLOC
));
461 if (NULL
== (n
= n
->next
))
462 return(post_prol(m
));
464 /* Handles: `.Dt TITLE SEC VOL'
465 * --> title = TITLE, volume = VOL is vol ?
467 * VOL is arch ? format(arch) :
471 cp
= mdoc_a2vol(n
->string
);
474 if (NULL
== (m
->meta
.vol
= strdup(cp
)))
475 return(verr(m
, EMALLOC
));
478 cp
= mdoc_a2arch(n
->string
);
481 if (NULL
== (m
->meta
.vol
= strdup(n
->string
)))
482 return(verr(m
, EMALLOC
));
483 } else if (NULL
== (m
->meta
.arch
= strdup(cp
)))
484 return(verr(m
, EMALLOC
));
487 /* Ignore any subsequent parameters... */
489 return(post_prol(m
));
497 struct utsname utsname
;
503 if ( ! concat(m
, m
->last
->child
, buf
, sizeof(buf
)))
507 if (-1 == uname(&utsname
))
508 return(mdoc_err(m
, "utsname"));
509 if (strlcat(buf
, utsname
.sysname
, 64) >= 64)
510 return(verr(m
, ETOOLONG
));
511 if (strlcat(buf
, " ", 64) >= 64)
512 return(verr(m
, ETOOLONG
));
513 if (strlcat(buf
, utsname
.release
, 64) >= 64)
514 return(verr(m
, ETOOLONG
));
517 if (NULL
== (m
->meta
.os
= strdup(buf
)))
518 return(verr(m
, EMALLOC
));
519 m
->lastnamed
= m
->lastsec
= SEC_BODY
;
521 return(post_prol(m
));
526 * Calculate the -width for a `Bl -tag' list if it hasn't been provided.
527 * Uses the first head macro.
530 post_bl_tagwidth(struct mdoc
*m
)
537 * Use the text width, if a text node, or the default macro
541 if ((n
= m
->last
->body
->child
)) {
542 assert(MDOC_BLOCK
== n
->type
);
543 assert(MDOC_It
== n
->tok
);
547 sz
= 10; /* Default size. */
550 if (MDOC_TEXT
!= n
->type
) {
551 if (0 == (sz
= (int)mdoc_macro2len(n
->tok
)))
552 if ( ! vwarn(m
, WNOWIDTH
))
555 sz
= (int)strlen(n
->string
) + 1;
558 if (-1 == snprintf(buf
, sizeof(buf
), "%dn", sz
))
559 return(verr(m
, ENUMFMT
));
562 * We have to dynamically add this to the macro's argument list.
563 * We're guaranteed that a MDOC_Width doesn't already exist.
568 sz
= (int)(n
->args
->argc
)++;
570 n
->args
->argv
= realloc(n
->args
->argv
,
571 n
->args
->argc
* sizeof(struct mdoc_argv
));
573 if (NULL
== n
->args
->argv
)
574 return(verr(m
, EMALLOC
));
576 n
->args
->argv
[sz
].arg
= MDOC_Width
;
577 n
->args
->argv
[sz
].line
= m
->last
->line
;
578 n
->args
->argv
[sz
].pos
= m
->last
->pos
;
579 n
->args
->argv
[sz
].sz
= 1;
580 n
->args
->argv
[sz
].value
= calloc(1, sizeof(char *));
582 if (NULL
== n
->args
->argv
[sz
].value
)
583 return(verr(m
, EMALLOC
));
584 if (NULL
== (n
->args
->argv
[sz
].value
[0] = strdup(buf
)))
585 return(verr(m
, EMALLOC
));
592 post_bl_width(struct mdoc
*m
)
599 if (NULL
== m
->last
->args
)
602 for (i
= 0; i
< (int)m
->last
->args
->argc
; i
++)
603 if (MDOC_Width
== m
->last
->args
->argv
[i
].arg
)
606 if (i
== (int)m
->last
->args
->argc
)
608 p
= m
->last
->args
->argv
[i
].value
[0];
611 * If the value to -width is a macro, then we re-write it to be
612 * the macro's width as set in share/tmac/mdoc/doc-common.
615 if (0 == strcmp(p
, "Ds"))
617 else if (MDOC_MAX
== (tok
= mdoc_hash_find(m
->htab
, p
)))
619 else if (0 == (width
= mdoc_macro2len(tok
)))
620 return(vwarn(m
, WNOWIDTH
));
622 /* The value already exists: free and reallocate it. */
624 if (-1 == snprintf(buf
, sizeof(buf
), "%zun", width
))
625 return(verr(m
, ENUMFMT
));
627 free(m
->last
->args
->argv
[i
].value
[0]);
628 m
->last
->args
->argv
[i
].value
[0] = strdup(buf
);
629 if (NULL
== m
->last
->args
->argv
[i
].value
[0])
630 return(verr(m
, EMALLOC
));
641 if (MDOC_BLOCK
!= m
->last
->type
)
645 * These are fairly complicated, so we've broken them into two
646 * functions. post_bl_tagwidth() is called when a -tag is
647 * specified, but no -width (it must be guessed). The second
648 * when a -width is specified (macro indicators must be
649 * rewritten into real lengths).
652 len
= (int)(m
->last
->args
? m
->last
->args
->argc
: 0);
654 for (r
= i
= 0; i
< len
; i
++) {
655 if (MDOC_Tag
== m
->last
->args
->argv
[i
].arg
)
657 if (MDOC_Width
== m
->last
->args
->argv
[i
].arg
)
661 if (r
& (1 << 0) && ! (r
& (1 << 1))) {
662 if ( ! post_bl_tagwidth(m
))
664 } else if (r
& (1 << 1))
665 if ( ! post_bl_width(m
))
681 m
->next
= MDOC_NEXT_CHILD
;
682 if ( ! mdoc_word_alloc(m
, m
->last
->line
,
683 m
->last
->pos
, "file"))
685 m
->next
= MDOC_NEXT_SIBLING
;
686 if ( ! mdoc_word_alloc(m
, m
->last
->line
,
687 m
->last
->pos
, "..."))
691 m
->next
= MDOC_NEXT_SIBLING
;
702 if ( ! concat(m
, m
->last
->child
, buf
, sizeof(buf
)))
705 if (0 == (m
->meta
.date
= mdoc_atotime(buf
))) {
706 if ( ! vwarn(m
, WBADDATE
))
708 m
->meta
.date
= time(NULL
);
711 return(post_prol(m
));
721 * The end document shouldn't have the prologue macros as part
722 * of the syntax tree (they encompass only meta-data).
725 if (m
->last
->parent
->child
== m
->last
)
726 m
->last
->parent
->child
= m
->last
->prev
;
728 m
->last
->prev
->next
= NULL
;
731 assert(NULL
== m
->last
->next
);
734 m
->last
= m
->last
->prev
;
735 m
->next
= MDOC_NEXT_SIBLING
;
737 m
->last
= m
->last
->parent
;
738 m
->next
= MDOC_NEXT_CHILD
;
741 mdoc_node_freelist(n
);
750 if (MDOC_BODY
!= n
->type
)
752 m
->flags
|= MDOC_LITERAL
;
762 if (MDOC_BODY
!= n
->type
)
765 /* Enter literal context if `Bd -literal' or * -unfilled'. */
767 for (n
= n
->parent
, i
= 0; i
< (int)n
->args
->argc
; i
++)
768 if (MDOC_Literal
== n
->args
->argv
[i
].arg
)
770 else if (MDOC_Unfilled
== n
->args
->argv
[i
].arg
)
773 if (i
< (int)n
->args
->argc
)
774 m
->flags
|= MDOC_LITERAL
;
781 post_display(POST_ARGS
)
784 if (MDOC_BODY
== m
->last
->type
)
785 m
->flags
&= ~MDOC_LITERAL
;