]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_validate.c
1 /* $Id: mdoc_validate.c,v 1.149 2010/12/25 23:25:53 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
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.
22 #include <sys/utsname.h>
25 #include <sys/types.h>
37 #include "libmandoc.h"
39 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
41 #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n
42 #define POST_ARGS struct mdoc *mdoc
59 typedef int (*v_pre
)(PRE_ARGS
);
60 typedef int (*v_post
)(POST_ARGS
);
67 static int check_count(struct mdoc
*, enum mdoc_type
,
68 enum check_lvl
, enum check_ineq
, int);
69 static int check_parent(PRE_ARGS
, enum mdoct
, enum mdoc_type
);
70 static void check_text(struct mdoc
*, int, int, char *);
71 static void check_argv(struct mdoc
*,
72 struct mdoc_node
*, struct mdoc_argv
*);
73 static void check_args(struct mdoc
*, struct mdoc_node
*);
75 static int concat(struct mdoc
*, char *,
76 const struct mdoc_node
*, size_t);
78 static int ebool(POST_ARGS
);
79 static int berr_ge1(POST_ARGS
);
80 static int bwarn_ge1(POST_ARGS
);
81 static int eerr_eq0(POST_ARGS
);
82 static int eerr_eq1(POST_ARGS
);
83 static int eerr_ge1(POST_ARGS
);
84 static int eerr_le1(POST_ARGS
);
85 static int ewarn_eq0(POST_ARGS
);
86 static int ewarn_ge1(POST_ARGS
);
87 static int herr_eq0(POST_ARGS
);
88 static int herr_ge1(POST_ARGS
);
89 static int hwarn_eq0(POST_ARGS
);
90 static int hwarn_eq1(POST_ARGS
);
91 static int hwarn_le1(POST_ARGS
);
93 static int post_an(POST_ARGS
);
94 static int post_at(POST_ARGS
);
95 static int post_bf(POST_ARGS
);
96 static int post_bl(POST_ARGS
);
97 static int post_bl_block(POST_ARGS
);
98 static int post_bl_block_width(POST_ARGS
);
99 static int post_bl_block_tag(POST_ARGS
);
100 static int post_bl_head(POST_ARGS
);
101 static int post_dd(POST_ARGS
);
102 static int post_dt(POST_ARGS
);
103 static int post_defaults(POST_ARGS
);
104 static int post_literal(POST_ARGS
);
105 static int post_eoln(POST_ARGS
);
106 static int post_it(POST_ARGS
);
107 static int post_lb(POST_ARGS
);
108 static int post_nm(POST_ARGS
);
109 static int post_os(POST_ARGS
);
110 static int post_ignpar(POST_ARGS
);
111 static int post_prol(POST_ARGS
);
112 static int post_root(POST_ARGS
);
113 static int post_rs(POST_ARGS
);
114 static int post_sh(POST_ARGS
);
115 static int post_sh_body(POST_ARGS
);
116 static int post_sh_head(POST_ARGS
);
117 static int post_st(POST_ARGS
);
118 static int post_std(POST_ARGS
);
119 static int post_vt(POST_ARGS
);
120 static int pre_an(PRE_ARGS
);
121 static int pre_bd(PRE_ARGS
);
122 static int pre_bl(PRE_ARGS
);
123 static int pre_dd(PRE_ARGS
);
124 static int pre_display(PRE_ARGS
);
125 static int pre_dt(PRE_ARGS
);
126 static int pre_it(PRE_ARGS
);
127 static int pre_literal(PRE_ARGS
);
128 static int pre_os(PRE_ARGS
);
129 static int pre_par(PRE_ARGS
);
130 static int pre_sh(PRE_ARGS
);
131 static int pre_ss(PRE_ARGS
);
132 static int pre_std(PRE_ARGS
);
134 static v_post posts_an
[] = { post_an
, NULL
};
135 static v_post posts_at
[] = { post_at
, post_defaults
, NULL
};
136 static v_post posts_bd
[] = { post_literal
, hwarn_eq0
, bwarn_ge1
, NULL
};
137 static v_post posts_bf
[] = { hwarn_le1
, post_bf
, NULL
};
138 static v_post posts_bk
[] = { hwarn_eq0
, bwarn_ge1
, NULL
};
139 static v_post posts_bl
[] = { bwarn_ge1
, post_bl
, NULL
};
140 static v_post posts_bool
[] = { eerr_eq1
, ebool
, NULL
};
141 static v_post posts_eoln
[] = { post_eoln
, NULL
};
142 static v_post posts_defaults
[] = { post_defaults
, NULL
};
143 static v_post posts_dd
[] = { ewarn_ge1
, post_dd
, post_prol
, NULL
};
144 static v_post posts_dl
[] = { post_literal
, bwarn_ge1
, herr_eq0
, NULL
};
145 static v_post posts_dt
[] = { post_dt
, post_prol
, NULL
};
146 static v_post posts_fo
[] = { hwarn_eq1
, bwarn_ge1
, NULL
};
147 static v_post posts_it
[] = { post_it
, NULL
};
148 static v_post posts_lb
[] = { eerr_eq1
, post_lb
, NULL
};
149 static v_post posts_nd
[] = { berr_ge1
, NULL
};
150 static v_post posts_nm
[] = { post_nm
, NULL
};
151 static v_post posts_notext
[] = { ewarn_eq0
, NULL
};
152 static v_post posts_os
[] = { post_os
, post_prol
, NULL
};
153 static v_post posts_rs
[] = { berr_ge1
, herr_eq0
, post_rs
, NULL
};
154 static v_post posts_sh
[] = { post_ignpar
, herr_ge1
, bwarn_ge1
, post_sh
, NULL
};
155 static v_post posts_sp
[] = { eerr_le1
, NULL
};
156 static v_post posts_ss
[] = { post_ignpar
, herr_ge1
, bwarn_ge1
, NULL
};
157 static v_post posts_st
[] = { eerr_eq1
, post_st
, NULL
};
158 static v_post posts_std
[] = { post_std
, NULL
};
159 static v_post posts_text
[] = { eerr_ge1
, NULL
};
160 static v_post posts_text1
[] = { eerr_eq1
, NULL
};
161 static v_post posts_vt
[] = { post_vt
, NULL
};
162 static v_post posts_wline
[] = { bwarn_ge1
, herr_eq0
, NULL
};
163 static v_post posts_wtext
[] = { ewarn_ge1
, NULL
};
164 static v_pre pres_an
[] = { pre_an
, NULL
};
165 static v_pre pres_bd
[] = { pre_display
, pre_bd
, pre_literal
, pre_par
, NULL
};
166 static v_pre pres_bl
[] = { pre_bl
, pre_par
, NULL
};
167 static v_pre pres_d1
[] = { pre_display
, NULL
};
168 static v_pre pres_dl
[] = { pre_literal
, pre_display
, NULL
};
169 static v_pre pres_dd
[] = { pre_dd
, NULL
};
170 static v_pre pres_dt
[] = { pre_dt
, NULL
};
171 static v_pre pres_er
[] = { NULL
, NULL
};
172 static v_pre pres_fd
[] = { NULL
, NULL
};
173 static v_pre pres_it
[] = { pre_it
, pre_par
, NULL
};
174 static v_pre pres_os
[] = { pre_os
, NULL
};
175 static v_pre pres_pp
[] = { pre_par
, NULL
};
176 static v_pre pres_sh
[] = { pre_sh
, NULL
};
177 static v_pre pres_ss
[] = { pre_ss
, NULL
};
178 static v_pre pres_std
[] = { pre_std
, NULL
};
180 const struct valids mdoc_valids
[MDOC_MAX
] = {
181 { NULL
, NULL
}, /* Ap */
182 { pres_dd
, posts_dd
}, /* Dd */
183 { pres_dt
, posts_dt
}, /* Dt */
184 { pres_os
, posts_os
}, /* Os */
185 { pres_sh
, posts_sh
}, /* Sh */
186 { pres_ss
, posts_ss
}, /* Ss */
187 { pres_pp
, posts_notext
}, /* Pp */
188 { pres_d1
, posts_wline
}, /* D1 */
189 { pres_dl
, posts_dl
}, /* Dl */
190 { pres_bd
, posts_bd
}, /* Bd */
191 { NULL
, NULL
}, /* Ed */
192 { pres_bl
, posts_bl
}, /* Bl */
193 { NULL
, NULL
}, /* El */
194 { pres_it
, posts_it
}, /* It */
195 { NULL
, posts_text
}, /* Ad */
196 { pres_an
, posts_an
}, /* An */
197 { NULL
, posts_defaults
}, /* Ar */
198 { NULL
, posts_text
}, /* Cd */
199 { NULL
, NULL
}, /* Cm */
200 { NULL
, NULL
}, /* Dv */
201 { pres_er
, posts_text
}, /* Er */
202 { NULL
, NULL
}, /* Ev */
203 { pres_std
, posts_std
}, /* Ex */
204 { NULL
, NULL
}, /* Fa */
205 { pres_fd
, posts_wtext
}, /* Fd */
206 { NULL
, NULL
}, /* Fl */
207 { NULL
, posts_text
}, /* Fn */
208 { NULL
, posts_wtext
}, /* Ft */
209 { NULL
, posts_text
}, /* Ic */
210 { NULL
, posts_text1
}, /* In */
211 { NULL
, posts_defaults
}, /* Li */
212 { NULL
, posts_nd
}, /* Nd */
213 { NULL
, posts_nm
}, /* Nm */
214 { NULL
, NULL
}, /* Op */
215 { NULL
, NULL
}, /* Ot */
216 { NULL
, posts_defaults
}, /* Pa */
217 { pres_std
, posts_std
}, /* Rv */
218 { NULL
, posts_st
}, /* St */
219 { NULL
, NULL
}, /* Va */
220 { NULL
, posts_vt
}, /* Vt */
221 { NULL
, posts_wtext
}, /* Xr */
222 { NULL
, posts_text
}, /* %A */
223 { NULL
, posts_text
}, /* %B */ /* FIXME: can be used outside Rs/Re. */
224 { NULL
, posts_text
}, /* %D */ /* FIXME: check date with mandoc_a2time(). */
225 { NULL
, posts_text
}, /* %I */
226 { NULL
, posts_text
}, /* %J */
227 { NULL
, posts_text
}, /* %N */
228 { NULL
, posts_text
}, /* %O */
229 { NULL
, posts_text
}, /* %P */
230 { NULL
, posts_text
}, /* %R */
231 { NULL
, posts_text
}, /* %T */ /* FIXME: can be used outside Rs/Re. */
232 { NULL
, posts_text
}, /* %V */
233 { NULL
, NULL
}, /* Ac */
234 { NULL
, NULL
}, /* Ao */
235 { NULL
, NULL
}, /* Aq */
236 { NULL
, posts_at
}, /* At */
237 { NULL
, NULL
}, /* Bc */
238 { NULL
, posts_bf
}, /* Bf */
239 { NULL
, NULL
}, /* Bo */
240 { NULL
, NULL
}, /* Bq */
241 { NULL
, NULL
}, /* Bsx */
242 { NULL
, NULL
}, /* Bx */
243 { NULL
, posts_bool
}, /* Db */
244 { NULL
, NULL
}, /* Dc */
245 { NULL
, NULL
}, /* Do */
246 { NULL
, NULL
}, /* Dq */
247 { NULL
, NULL
}, /* Ec */
248 { NULL
, NULL
}, /* Ef */
249 { NULL
, NULL
}, /* Em */
250 { NULL
, NULL
}, /* Eo */
251 { NULL
, NULL
}, /* Fx */
252 { NULL
, posts_text
}, /* Ms */
253 { NULL
, posts_notext
}, /* No */
254 { NULL
, posts_notext
}, /* Ns */
255 { NULL
, NULL
}, /* Nx */
256 { NULL
, NULL
}, /* Ox */
257 { NULL
, NULL
}, /* Pc */
258 { NULL
, posts_text1
}, /* Pf */
259 { NULL
, NULL
}, /* Po */
260 { NULL
, NULL
}, /* Pq */
261 { NULL
, NULL
}, /* Qc */
262 { NULL
, NULL
}, /* Ql */
263 { NULL
, NULL
}, /* Qo */
264 { NULL
, NULL
}, /* Qq */
265 { NULL
, NULL
}, /* Re */
266 { NULL
, posts_rs
}, /* Rs */
267 { NULL
, NULL
}, /* Sc */
268 { NULL
, NULL
}, /* So */
269 { NULL
, NULL
}, /* Sq */
270 { NULL
, posts_bool
}, /* Sm */
271 { NULL
, posts_text
}, /* Sx */
272 { NULL
, posts_text
}, /* Sy */
273 { NULL
, posts_text
}, /* Tn */
274 { NULL
, NULL
}, /* Ux */
275 { NULL
, NULL
}, /* Xc */
276 { NULL
, NULL
}, /* Xo */
277 { NULL
, posts_fo
}, /* Fo */
278 { NULL
, NULL
}, /* Fc */
279 { NULL
, NULL
}, /* Oo */
280 { NULL
, NULL
}, /* Oc */
281 { NULL
, posts_bk
}, /* Bk */
282 { NULL
, NULL
}, /* Ek */
283 { NULL
, posts_eoln
}, /* Bt */
284 { NULL
, NULL
}, /* Hf */
285 { NULL
, NULL
}, /* Fr */
286 { NULL
, posts_eoln
}, /* Ud */
287 { NULL
, posts_lb
}, /* Lb */
288 { NULL
, posts_notext
}, /* Lp */
289 { NULL
, posts_text
}, /* Lk */
290 { NULL
, posts_defaults
}, /* Mt */
291 { NULL
, NULL
}, /* Brq */
292 { NULL
, NULL
}, /* Bro */
293 { NULL
, NULL
}, /* Brc */
294 { NULL
, posts_text
}, /* %C */
295 { NULL
, NULL
}, /* Es */
296 { NULL
, NULL
}, /* En */
297 { NULL
, NULL
}, /* Dx */
298 { NULL
, posts_text
}, /* %Q */
299 { NULL
, posts_notext
}, /* br */
300 { pres_pp
, posts_sp
}, /* sp */
301 { NULL
, posts_text1
}, /* %U */
302 { NULL
, NULL
}, /* Ta */
305 #define RSORD_MAX 14 /* Number of `Rs' blocks. */
307 static const enum mdoct rsord
[RSORD_MAX
] = {
326 mdoc_valid_pre(struct mdoc
*mdoc
, struct mdoc_node
*n
)
332 if (MDOC_TEXT
== n
->type
) {
336 check_text(mdoc
, line
, pos
, tp
);
342 if (NULL
== mdoc_valids
[n
->tok
].pre
)
344 for (p
= mdoc_valids
[n
->tok
].pre
; *p
; p
++)
345 if ( ! (*p
)(mdoc
, n
))
352 mdoc_valid_post(struct mdoc
*mdoc
)
356 if (MDOC_VALID
& mdoc
->last
->flags
)
358 mdoc
->last
->flags
|= MDOC_VALID
;
360 if (MDOC_TEXT
== mdoc
->last
->type
)
362 if (MDOC_ROOT
== mdoc
->last
->type
)
363 return(post_root(mdoc
));
365 if (NULL
== mdoc_valids
[mdoc
->last
->tok
].post
)
367 for (p
= mdoc_valids
[mdoc
->last
->tok
].post
; *p
; p
++)
375 check_count(struct mdoc
*m
, enum mdoc_type type
,
376 enum check_lvl lvl
, enum check_ineq ineq
, int val
)
380 if (m
->last
->type
!= type
)
386 if (m
->last
->nchild
< val
)
391 if (m
->last
->nchild
> val
)
396 if (val
== m
->last
->nchild
)
404 if (CHECK_WARN
== lvl
) {
405 return(mdoc_vmsg(m
, MANDOCERR_ARGCOUNT
,
406 m
->last
->line
, m
->last
->pos
,
407 "want %s%d children (have %d)",
408 p
, val
, m
->last
->nchild
));
411 /* FIXME: THIS IS THE SAME AS THE ABOVE. */
413 return(mdoc_vmsg(m
, MANDOCERR_ARGCOUNT
,
414 m
->last
->line
, m
->last
->pos
,
415 "require %s%d children (have %d)",
416 p
, val
, m
->last
->nchild
));
423 return(check_count(mdoc
, MDOC_BODY
, CHECK_FATAL
, CHECK_GT
, 0));
429 return(check_count(mdoc
, MDOC_BODY
, CHECK_WARN
, CHECK_GT
, 0));
435 return(check_count(mdoc
, MDOC_ELEM
, CHECK_FATAL
, CHECK_EQ
, 0));
441 return(check_count(mdoc
, MDOC_ELEM
, CHECK_FATAL
, CHECK_EQ
, 1));
447 return(check_count(mdoc
, MDOC_ELEM
, CHECK_FATAL
, CHECK_GT
, 0));
453 return(check_count(mdoc
, MDOC_ELEM
, CHECK_FATAL
, CHECK_LT
, 2));
459 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 0));
465 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_GT
, 0));
471 return(check_count(mdoc
, MDOC_HEAD
, CHECK_FATAL
, CHECK_EQ
, 0));
477 return(check_count(mdoc
, MDOC_HEAD
, CHECK_FATAL
, CHECK_GT
, 0));
483 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 0));
489 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 1));
495 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_LT
, 2));
499 check_args(struct mdoc
*m
, struct mdoc_node
*n
)
506 assert(n
->args
->argc
);
507 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
508 check_argv(m
, n
, &n
->args
->argv
[i
]);
512 check_argv(struct mdoc
*m
, struct mdoc_node
*n
, struct mdoc_argv
*v
)
516 for (i
= 0; i
< (int)v
->sz
; i
++)
517 check_text(m
, v
->line
, v
->pos
, v
->value
[i
]);
519 /* FIXME: move to post_std(). */
521 if (MDOC_Std
== v
->arg
)
522 if ( ! (v
->sz
|| m
->meta
.name
))
523 mdoc_nmsg(m
, n
, MANDOCERR_NONAME
);
527 check_text(struct mdoc
*m
, int ln
, int pos
, char *p
)
532 for ( ; *p
; p
++, pos
++) {
533 sz
= strcspn(p
, "\t\\");
542 if ( ! (MDOC_LITERAL
& m
->flags
))
543 mdoc_pmsg(m
, ln
, pos
, MANDOCERR_BADTAB
);
547 if (0 == (c
= mandoc_special(p
))) {
548 mdoc_pmsg(m
, ln
, pos
, MANDOCERR_BADESCAPE
);
558 check_parent(PRE_ARGS
, enum mdoct tok
, enum mdoc_type t
)
562 if ((MDOC_ROOT
== t
|| tok
== n
->parent
->tok
) &&
563 (t
== n
->parent
->type
))
566 mdoc_vmsg(mdoc
, MANDOCERR_SYNTCHILD
,
567 n
->line
, n
->pos
, "want parent %s",
568 MDOC_ROOT
== t
? "<root>" :
569 mdoc_macronames
[tok
]);
575 pre_display(PRE_ARGS
)
577 struct mdoc_node
*node
;
579 if (MDOC_BLOCK
!= n
->type
)
582 for (node
= mdoc
->last
->parent
; node
; node
= node
->parent
)
583 if (MDOC_BLOCK
== node
->type
)
584 if (MDOC_Bd
== node
->tok
)
588 mdoc_nmsg(mdoc
, n
, MANDOCERR_NESTEDDISP
);
598 const char *offs
, *width
;
600 struct mdoc_node
*np
;
602 if (MDOC_BLOCK
!= n
->type
) {
603 if (ENDBODY_NOT
!= n
->end
) {
605 np
= n
->pending
->parent
;
610 assert(MDOC_BLOCK
== np
->type
);
611 assert(MDOC_Bl
== np
->tok
);
616 * First figure out which kind of list to use: bind ourselves to
617 * the first mentioned list type and warn about any remaining
618 * ones. If we find no list type, we default to LIST_item.
622 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
626 switch (n
->args
->argv
[i
].arg
) {
627 /* Set list types. */
661 /* Set list arguments. */
663 dup
= n
->norm
->Bl
.comp
;
667 dup
= (NULL
!= n
->norm
->Bl
.width
);
668 width
= n
->args
->argv
[i
].value
[0];
671 /* NB: this can be empty! */
672 if (n
->args
->argv
[i
].sz
) {
673 offs
= n
->args
->argv
[i
].value
[0];
674 dup
= (NULL
!= n
->norm
->Bl
.offs
);
677 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
683 /* Check: duplicate auxiliary arguments. */
686 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
689 n
->norm
->Bl
.comp
= comp
;
691 n
->norm
->Bl
.offs
= offs
;
693 n
->norm
->Bl
.width
= width
;
695 /* Check: multiple list types. */
697 if (LIST__NONE
!= lt
&& n
->norm
->Bl
.type
!= LIST__NONE
)
698 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTREP
);
700 /* Assign list type. */
702 if (LIST__NONE
!= lt
&& n
->norm
->Bl
.type
== LIST__NONE
) {
703 n
->norm
->Bl
.type
= lt
;
704 /* Set column information, too. */
705 if (LIST_column
== lt
) {
708 n
->norm
->Bl
.cols
= (const char **)
709 n
->args
->argv
[i
].value
;
713 /* The list type should come first. */
715 if (n
->norm
->Bl
.type
== LIST__NONE
)
716 if (n
->norm
->Bl
.width
||
719 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTFIRST
);
724 /* Allow lists to default to LIST_item. */
726 if (LIST__NONE
== n
->norm
->Bl
.type
) {
727 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTTYPE
);
728 n
->norm
->Bl
.type
= LIST_item
;
732 * Validate the width field. Some list types don't need width
733 * types and should be warned about them. Others should have it
734 * and must also be warned.
737 switch (n
->norm
->Bl
.type
) {
739 if (n
->norm
->Bl
.width
)
741 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOWIDTHARG
);
752 if (n
->norm
->Bl
.width
)
753 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
769 struct mdoc_node
*np
;
771 if (MDOC_BLOCK
!= n
->type
) {
772 if (ENDBODY_NOT
!= n
->end
) {
774 np
= n
->pending
->parent
;
779 assert(MDOC_BLOCK
== np
->type
);
780 assert(MDOC_Bd
== np
->tok
);
785 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
790 switch (n
->args
->argv
[i
].arg
) {
797 case (MDOC_Unfilled
):
807 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADDISP
);
810 /* NB: this can be empty! */
811 if (n
->args
->argv
[i
].sz
) {
812 offs
= n
->args
->argv
[i
].value
[0];
813 dup
= (NULL
!= n
->norm
->Bd
.offs
);
816 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
820 dup
= n
->norm
->Bd
.comp
;
827 /* Check whether we have duplicates. */
830 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
832 /* Make our auxiliary assignments. */
835 n
->norm
->Bd
.offs
= offs
;
837 n
->norm
->Bd
.comp
= comp
;
839 /* Check whether a type has already been assigned. */
841 if (DISP__NONE
!= dt
&& n
->norm
->Bd
.type
!= DISP__NONE
)
842 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPREP
);
844 /* Make our type assignment. */
846 if (DISP__NONE
!= dt
&& n
->norm
->Bd
.type
== DISP__NONE
)
847 n
->norm
->Bd
.type
= dt
;
850 if (DISP__NONE
== n
->norm
->Bd
.type
) {
851 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPTYPE
);
852 n
->norm
->Bd
.type
= DISP_ragged
;
863 if (MDOC_BLOCK
!= n
->type
)
865 return(check_parent(mdoc
, n
, MDOC_Sh
, MDOC_BODY
));
873 if (MDOC_BLOCK
!= n
->type
)
876 mdoc
->regs
->regs
[(int)REG_nS
].set
= 0;
877 return(check_parent(mdoc
, n
, MDOC_MAX
, MDOC_ROOT
));
885 if (MDOC_BLOCK
!= n
->type
)
888 return(check_parent(mdoc
, n
, MDOC_Bl
, MDOC_BODY
));
900 for (i
= 1; i
< (int)n
->args
->argc
; i
++)
901 mdoc_pmsg(mdoc
, n
->args
->argv
[i
].line
,
902 n
->args
->argv
[i
].pos
, MANDOCERR_IGNARGV
);
904 if (MDOC_Split
== n
->args
->argv
[0].arg
)
905 n
->norm
->An
.auth
= AUTH_split
;
906 else if (MDOC_Nosplit
== n
->args
->argv
[0].arg
)
907 n
->norm
->An
.auth
= AUTH_nosplit
;
918 if (n
->args
&& 1 == n
->args
->argc
)
919 if (MDOC_Std
== n
->args
->argv
[0].arg
)
922 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOARGV
);
930 if (0 == mdoc
->meta
.date
|| mdoc
->meta
.os
)
931 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
933 if (mdoc
->meta
.title
)
934 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
943 if (NULL
== mdoc
->meta
.title
|| 0 == mdoc
->meta
.date
)
944 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
947 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
956 if (mdoc
->meta
.title
|| mdoc
->meta
.os
)
957 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
960 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
969 struct mdoc_node
*np
;
973 * Unlike other data pointers, these are "housed" by the HEAD
974 * element, which contains the goods.
977 if (MDOC_HEAD
!= mdoc
->last
->type
) {
978 if (ENDBODY_NOT
!= mdoc
->last
->end
) {
979 assert(mdoc
->last
->pending
);
980 np
= mdoc
->last
->pending
->parent
->head
;
981 } else if (MDOC_BLOCK
!= mdoc
->last
->type
) {
982 np
= mdoc
->last
->parent
->head
;
984 np
= mdoc
->last
->head
;
987 assert(MDOC_HEAD
== np
->type
);
988 assert(MDOC_Bf
== np
->tok
);
993 assert(MDOC_BLOCK
== np
->parent
->type
);
994 assert(MDOC_Bf
== np
->parent
->tok
);
997 * Cannot have both argument and parameter.
998 * If neither is specified, let it through with a warning.
1001 if (np
->parent
->args
&& np
->child
) {
1002 mdoc_nmsg(mdoc
, np
, MANDOCERR_SYNTARGVCOUNT
);
1004 } else if (NULL
== np
->parent
->args
&& NULL
== np
->child
) {
1005 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1009 /* Extract argument into data. */
1011 if (np
->parent
->args
) {
1012 arg
= np
->parent
->args
->argv
[0].arg
;
1013 if (MDOC_Emphasis
== arg
)
1014 np
->norm
->Bf
.font
= FONT_Em
;
1015 else if (MDOC_Literal
== arg
)
1016 np
->norm
->Bf
.font
= FONT_Li
;
1017 else if (MDOC_Symbolic
== arg
)
1018 np
->norm
->Bf
.font
= FONT_Sy
;
1024 /* Extract parameter into data. */
1026 if (0 == strcmp(np
->child
->string
, "Em"))
1027 np
->norm
->Bf
.font
= FONT_Em
;
1028 else if (0 == strcmp(np
->child
->string
, "Li"))
1029 np
->norm
->Bf
.font
= FONT_Li
;
1030 else if (0 == strcmp(np
->child
->string
, "Sy"))
1031 np
->norm
->Bf
.font
= FONT_Sy
;
1033 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1045 assert(mdoc
->last
->child
);
1046 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1048 p
= mdoc_a2lib(mdoc
->last
->child
->string
);
1050 /* If lookup ok, replace with table value. */
1053 free(mdoc
->last
->child
->string
);
1054 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1058 /* If not, use "library ``xxxx''. */
1060 sz
= strlen(mdoc
->last
->child
->string
) +
1061 2 + strlen("\\(lqlibrary\\(rq");
1062 buf
= mandoc_malloc(sz
);
1063 snprintf(buf
, sz
, "library \\(lq%s\\(rq",
1064 mdoc
->last
->child
->string
);
1065 free(mdoc
->last
->child
->string
);
1066 mdoc
->last
->child
->string
= buf
;
1071 post_eoln(POST_ARGS
)
1074 if (mdoc
->last
->child
)
1075 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1083 const struct mdoc_node
*n
;
1086 * The Vt macro comes in both ELEM and BLOCK form, both of which
1087 * have different syntaxes (yet more context-sensitive
1088 * behaviour). ELEM types must have a child; BLOCK types,
1089 * specifically the BODY, should only have TEXT children.
1092 if (MDOC_ELEM
== mdoc
->last
->type
)
1093 return(eerr_ge1(mdoc
));
1094 if (MDOC_BODY
!= mdoc
->last
->type
)
1097 for (n
= mdoc
->last
->child
; n
; n
= n
->next
)
1098 if (MDOC_TEXT
!= n
->type
)
1099 mdoc_nmsg(mdoc
, n
, MANDOCERR_CHILD
);
1110 /* If no child specified, make sure we have the meta name. */
1112 if (NULL
== mdoc
->last
->child
&& NULL
== mdoc
->meta
.name
) {
1113 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NONAME
);
1115 } else if (mdoc
->meta
.name
)
1118 /* If no meta name, set it from the child. */
1120 if ( ! concat(mdoc
, buf
, mdoc
->last
->child
, BUFSIZ
))
1123 mdoc
->meta
.name
= mandoc_strdup(buf
);
1129 post_literal(POST_ARGS
)
1133 * The `Dl' (note "el" not "one") and `Bd' macros unset the
1134 * MDOC_LITERAL flag as they leave. Note that `Bd' only sets
1135 * this in literal mode, but it doesn't hurt to just switch it
1136 * off in general since displays can't be nested.
1139 if (MDOC_BODY
== mdoc
->last
->type
)
1140 mdoc
->flags
&= ~MDOC_LITERAL
;
1146 post_defaults(POST_ARGS
)
1148 struct mdoc_node
*nn
;
1151 * The `Ar' defaults to "file ..." if no value is provided as an
1152 * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
1153 * gets an empty string.
1156 if (mdoc
->last
->child
)
1160 mdoc
->next
= MDOC_NEXT_CHILD
;
1164 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "file"))
1166 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "..."))
1170 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "AT&T"))
1172 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "UNIX"))
1176 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, ""))
1182 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "~"))
1202 * If we have a child, look it up in the standard keys. If a
1203 * key exist, use that instead of the child; if it doesn't,
1204 * prefix "AT&T UNIX " to the existing data.
1207 if (NULL
== mdoc
->last
->child
)
1210 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1211 p
= mdoc_a2att(mdoc
->last
->child
->string
);
1214 free(mdoc
->last
->child
->string
);
1215 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1217 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADATT
);
1219 q
= mdoc
->last
->child
->string
;
1220 sz
= strlen(p
) + strlen(q
) + 1;
1221 buf
= mandoc_malloc(sz
);
1222 strlcpy(buf
, p
, sz
);
1223 strlcat(buf
, q
, sz
);
1224 free(mdoc
->last
->child
->string
);
1225 mdoc
->last
->child
->string
= buf
;
1234 struct mdoc_node
*np
;
1237 if (AUTH__NONE
!= np
->norm
->An
.auth
&& np
->child
)
1238 return(eerr_eq0(mdoc
));
1241 * FIXME: make this ewarn and make sure that the front-ends
1242 * don't print the arguments.
1244 if (AUTH__NONE
!= np
->norm
->An
.auth
|| np
->child
)
1247 mdoc_nmsg(mdoc
, np
, MANDOCERR_NOARGS
);
1257 struct mdoc_node
*n
, *c
;
1260 if (MDOC_BLOCK
!= mdoc
->last
->type
)
1263 n
= mdoc
->last
->parent
->parent
;
1264 lt
= n
->norm
->Bl
.type
;
1266 if (LIST__NONE
== lt
) {
1267 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_LISTTYPE
);
1273 if (mdoc
->last
->head
->child
)
1275 /* FIXME: give this a dummy value. */
1276 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1285 if (NULL
== mdoc
->last
->head
->child
)
1286 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1295 if (NULL
== mdoc
->last
->body
->child
)
1296 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1299 if (mdoc
->last
->head
->child
)
1300 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1303 cols
= (int)n
->norm
->Bl
.ncols
;
1305 assert(NULL
== mdoc
->last
->head
->child
);
1307 if (NULL
== mdoc
->last
->body
->child
)
1308 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1310 for (i
= 0, c
= mdoc
->last
->child
; c
; c
= c
->next
)
1311 if (MDOC_BODY
== c
->type
)
1315 er
= MANDOCERR_ARGCOUNT
;
1316 else if (i
== cols
|| i
== cols
+ 1)
1319 er
= MANDOCERR_SYNTARGCOUNT
;
1321 rc
= mdoc_vmsg(mdoc
, er
,
1322 mdoc
->last
->line
, mdoc
->last
->pos
,
1323 "columns == %d (have %d)", cols
, i
);
1333 post_bl_block(POST_ARGS
)
1335 struct mdoc_node
*n
;
1338 * These are fairly complicated, so we've broken them into two
1339 * functions. post_bl_block_tag() is called when a -tag is
1340 * specified, but no -width (it must be guessed). The second
1341 * when a -width is specified (macro indicators must be
1342 * rewritten into real lengths).
1347 if (LIST_tag
== n
->norm
->Bl
.type
&&
1348 NULL
== n
->norm
->Bl
.width
) {
1349 if ( ! post_bl_block_tag(mdoc
))
1351 } else if (NULL
!= n
->norm
->Bl
.width
) {
1352 if ( ! post_bl_block_width(mdoc
))
1357 assert(n
->norm
->Bl
.width
);
1362 post_bl_block_width(POST_ARGS
)
1367 struct mdoc_node
*n
;
1373 * Calculate the real width of a list from the -width string,
1374 * which may contain a macro (with a known default width), a
1375 * literal string, or a scaling width.
1377 * If the value to -width is a macro, then we re-write it to be
1378 * the macro's width as set in share/tmac/mdoc/doc-common.
1381 if (0 == strcmp(n
->norm
->Bl
.width
, "Ds"))
1383 else if (MDOC_MAX
== (tok
= mdoc_hash_find(n
->norm
->Bl
.width
)))
1385 else if (0 == (width
= mdoc_macro2len(tok
))) {
1386 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADWIDTH
);
1390 /* The value already exists: free and reallocate it. */
1394 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
1395 if (MDOC_Width
== n
->args
->argv
[i
].arg
)
1398 assert(i
< (int)n
->args
->argc
);
1400 snprintf(buf
, NUMSIZ
, "%zun", width
);
1401 free(n
->args
->argv
[i
].value
[0]);
1402 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1404 /* Set our width! */
1405 n
->norm
->Bl
.width
= n
->args
->argv
[i
].value
[0];
1410 post_bl_block_tag(POST_ARGS
)
1412 struct mdoc_node
*n
, *nn
;
1418 * Calculate the -width for a `Bl -tag' list if it hasn't been
1419 * provided. Uses the first head macro. NOTE AGAIN: this is
1420 * ONLY if the -width argument has NOT been provided. See
1421 * post_bl_block_width() for converting the -width string.
1427 for (nn
= n
->body
->child
; nn
; nn
= nn
->next
) {
1428 if (MDOC_It
!= nn
->tok
)
1431 assert(MDOC_BLOCK
== nn
->type
);
1432 nn
= nn
->head
->child
;
1437 if (MDOC_TEXT
== nn
->type
) {
1438 sz
= strlen(nn
->string
) + 1;
1442 if (0 != (ssz
= mdoc_macro2len(nn
->tok
)))
1448 /* Defaults to ten ens. */
1450 snprintf(buf
, NUMSIZ
, "%zun", sz
);
1453 * We have to dynamically add this to the macro's argument list.
1454 * We're guaranteed that a MDOC_Width doesn't already exist.
1458 i
= (int)(n
->args
->argc
)++;
1460 n
->args
->argv
= mandoc_realloc(n
->args
->argv
,
1461 n
->args
->argc
* sizeof(struct mdoc_argv
));
1463 n
->args
->argv
[i
].arg
= MDOC_Width
;
1464 n
->args
->argv
[i
].line
= n
->line
;
1465 n
->args
->argv
[i
].pos
= n
->pos
;
1466 n
->args
->argv
[i
].sz
= 1;
1467 n
->args
->argv
[i
].value
= mandoc_malloc(sizeof(char *));
1468 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1470 /* Set our width! */
1471 n
->norm
->Bl
.width
= n
->args
->argv
[i
].value
[0];
1477 post_bl_head(POST_ARGS
)
1479 struct mdoc_node
*np
, *nn
, *nnp
;
1482 if (LIST_column
!= mdoc
->last
->norm
->Bl
.type
)
1483 /* FIXME: this should be ERROR class... */
1484 return(hwarn_eq0(mdoc
));
1487 * Convert old-style lists, where the column width specifiers
1488 * trail as macro parameters, to the new-style ("normal-form")
1489 * lists where they're argument values following -column.
1492 /* First, disallow both types and allow normal-form. */
1495 * TODO: technically, we can accept both and just merge the two
1496 * lists, but I'll leave that for another day.
1499 if (mdoc
->last
->norm
->Bl
.ncols
&& mdoc
->last
->nchild
) {
1500 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_COLUMNS
);
1502 } else if (NULL
== mdoc
->last
->child
)
1505 np
= mdoc
->last
->parent
;
1508 for (j
= 0; j
< (int)np
->args
->argc
; j
++)
1509 if (MDOC_Column
== np
->args
->argv
[j
].arg
)
1512 assert(j
< (int)np
->args
->argc
);
1513 assert(0 == np
->args
->argv
[j
].sz
);
1516 * Accomodate for new-style groff column syntax. Shuffle the
1517 * child nodes, all of which must be TEXT, as arguments for the
1518 * column field. Then, delete the head children.
1521 np
->args
->argv
[j
].sz
= (size_t)mdoc
->last
->nchild
;
1522 np
->args
->argv
[j
].value
= mandoc_malloc
1523 ((size_t)mdoc
->last
->nchild
* sizeof(char *));
1525 mdoc
->last
->norm
->Bl
.ncols
= np
->args
->argv
[j
].sz
;
1526 mdoc
->last
->norm
->Bl
.cols
= (const char **)np
->args
->argv
[j
].value
;
1528 for (i
= 0, nn
= mdoc
->last
->child
; nn
; i
++) {
1529 np
->args
->argv
[j
].value
[i
] = nn
->string
;
1533 mdoc_node_delete(NULL
, nnp
);
1536 mdoc
->last
->nchild
= 0;
1537 mdoc
->last
->child
= NULL
;
1545 struct mdoc_node
*n
;
1547 if (MDOC_HEAD
== mdoc
->last
->type
)
1548 return(post_bl_head(mdoc
));
1549 if (MDOC_BLOCK
== mdoc
->last
->type
)
1550 return(post_bl_block(mdoc
));
1551 if (MDOC_BODY
!= mdoc
->last
->type
)
1554 for (n
= mdoc
->last
->child
; n
; n
= n
->next
) {
1559 mdoc_nmsg(mdoc
, n
, MANDOCERR_CHILD
);
1569 mdoc_nmsg(mdoc
, n
, MANDOCERR_SYNTCHILD
);
1577 ebool(struct mdoc
*mdoc
)
1580 if (NULL
== mdoc
->last
->child
)
1583 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1585 if (0 == strcmp(mdoc
->last
->child
->string
, "on"))
1587 if (0 == strcmp(mdoc
->last
->child
->string
, "off"))
1590 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADBOOL
);
1595 post_root(POST_ARGS
)
1598 struct mdoc_node
*n
;
1602 /* Check that we have a finished prologue. */
1604 if ( ! (MDOC_PBODY
& mdoc
->flags
)) {
1606 mdoc_nmsg(mdoc
, mdoc
->first
, MANDOCERR_NODOCPROLOG
);
1612 /* Check that we begin with a proper `Sh'. */
1614 if (NULL
== n
->child
) {
1616 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1617 } else if (MDOC_BLOCK
!= n
->child
->type
||
1618 MDOC_Sh
!= n
->child
->tok
) {
1620 /* Can this be lifted? See rxdebug.1 for example. */
1621 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1624 return(erc
? 0 : 1);
1632 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1634 p
= mdoc_a2st(mdoc
->last
->child
->string
);
1637 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADSTANDARD
);
1638 mdoc_node_delete(mdoc
, mdoc
->last
);
1640 free(mdoc
->last
->child
->string
);
1641 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1650 struct mdoc_node
*nn
, *next
, *prev
;
1653 if (MDOC_BODY
!= mdoc
->last
->type
)
1657 * Make sure only certain types of nodes are allowed within the
1658 * the `Rs' body. Delete offending nodes and raise a warning.
1659 * Do this before re-ordering for the sake of clarity.
1663 for (nn
= mdoc
->last
->child
; nn
; nn
= next
) {
1664 for (i
= 0; i
< RSORD_MAX
; i
++)
1665 if (nn
->tok
== rsord
[i
])
1668 if (i
< RSORD_MAX
) {
1669 if (MDOC__J
== rsord
[i
])
1670 mdoc
->last
->norm
->Rs
.child_J
= nn
;
1676 mdoc_nmsg(mdoc
, nn
, MANDOCERR_CHILD
);
1677 mdoc_node_delete(mdoc
, nn
);
1681 * The full `Rs' block needs special handling to order the
1682 * sub-elements according to `rsord'. Pick through each element
1683 * and correctly order it. This is a insertion sort.
1687 for (nn
= mdoc
->last
->child
->next
; nn
; nn
= next
) {
1688 /* Determine order of `nn'. */
1689 for (i
= 0; i
< RSORD_MAX
; i
++)
1690 if (rsord
[i
] == nn
->tok
)
1694 * Remove `nn' from the chain. This somewhat
1695 * repeats mdoc_node_unlink(), but since we're
1696 * just re-ordering, there's no need for the
1697 * full unlink process.
1700 if (NULL
!= (next
= nn
->next
))
1701 next
->prev
= nn
->prev
;
1703 if (NULL
!= (prev
= nn
->prev
))
1704 prev
->next
= nn
->next
;
1706 nn
->prev
= nn
->next
= NULL
;
1709 * Scan back until we reach a node that's
1710 * ordered before `nn'.
1713 for ( ; prev
; prev
= prev
->prev
) {
1714 /* Determine order of `prev'. */
1715 for (j
= 0; j
< RSORD_MAX
; j
++)
1716 if (rsord
[j
] == prev
->tok
)
1724 * Set `nn' back into its correct place in front
1725 * of the `prev' node.
1732 prev
->next
->prev
= nn
;
1733 nn
->next
= prev
->next
;
1736 mdoc
->last
->child
->prev
= nn
;
1737 nn
->next
= mdoc
->last
->child
;
1738 mdoc
->last
->child
= nn
;
1749 if (MDOC_HEAD
== mdoc
->last
->type
)
1750 return(post_sh_head(mdoc
));
1751 if (MDOC_BODY
== mdoc
->last
->type
)
1752 return(post_sh_body(mdoc
));
1758 post_sh_body(POST_ARGS
)
1760 struct mdoc_node
*n
;
1762 if (SEC_NAME
!= mdoc
->lastsec
)
1766 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1767 * macros (can have multiple `Nm' and one `Nd'). Note that the
1768 * children of the BODY declaration can also be "text".
1771 if (NULL
== (n
= mdoc
->last
->child
)) {
1772 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1776 for ( ; n
&& n
->next
; n
= n
->next
) {
1777 if (MDOC_ELEM
== n
->type
&& MDOC_Nm
== n
->tok
)
1779 if (MDOC_TEXT
== n
->type
)
1781 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1785 if (MDOC_BLOCK
== n
->type
&& MDOC_Nd
== n
->tok
)
1788 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1793 post_sh_head(POST_ARGS
)
1799 * Process a new section. Sections are either "named" or
1800 * "custom". Custom sections are user-defined, while named ones
1801 * follow a conventional order and may only appear in certain
1805 if ( ! concat(mdoc
, buf
, mdoc
->last
->child
, BUFSIZ
))
1808 sec
= mdoc_str2sec(buf
);
1810 /* The NAME should be first. */
1812 if (SEC_NAME
!= sec
&& SEC_NONE
== mdoc
->lastnamed
)
1813 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NAMESECFIRST
);
1815 /* The SYNOPSIS gets special attention in other areas. */
1817 if (SEC_SYNOPSIS
== sec
)
1818 mdoc
->flags
|= MDOC_SYNOPSIS
;
1820 mdoc
->flags
&= ~MDOC_SYNOPSIS
;
1822 /* Mark our last section. */
1824 mdoc
->lastsec
= sec
;
1826 /* We don't care about custom sections after this. */
1828 if (SEC_CUSTOM
== sec
)
1832 * Check whether our non-custom section is being repeated or is
1836 if (sec
== mdoc
->lastnamed
)
1837 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECREP
);
1839 if (sec
< mdoc
->lastnamed
)
1840 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECOOO
);
1842 /* Mark the last named section. */
1844 mdoc
->lastnamed
= sec
;
1846 /* Check particular section/manual conventions. */
1848 assert(mdoc
->meta
.msec
);
1851 case (SEC_RETURN_VALUES
):
1856 if (*mdoc
->meta
.msec
== '2')
1858 if (*mdoc
->meta
.msec
== '3')
1860 if (*mdoc
->meta
.msec
== '9')
1862 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECMSEC
);
1872 post_ignpar(POST_ARGS
)
1874 struct mdoc_node
*np
;
1876 if (MDOC_BODY
!= mdoc
->last
->type
)
1879 if (NULL
!= (np
= mdoc
->last
->child
))
1880 if (MDOC_Pp
== np
->tok
|| MDOC_Lp
== np
->tok
) {
1881 mdoc_nmsg(mdoc
, np
, MANDOCERR_IGNPAR
);
1882 mdoc_node_delete(mdoc
, np
);
1885 if (NULL
!= (np
= mdoc
->last
->last
))
1886 if (MDOC_Pp
== np
->tok
|| MDOC_Lp
== np
->tok
) {
1887 mdoc_nmsg(mdoc
, np
, MANDOCERR_IGNPAR
);
1888 mdoc_node_delete(mdoc
, np
);
1898 if (NULL
== mdoc
->last
)
1900 if (MDOC_ELEM
!= n
->type
&& MDOC_BLOCK
!= n
->type
)
1904 * Don't allow prior `Lp' or `Pp' prior to a paragraph-type
1905 * block: `Lp', `Pp', or non-compact `Bd' or `Bl'.
1908 if (MDOC_Pp
!= mdoc
->last
->tok
&& MDOC_Lp
!= mdoc
->last
->tok
)
1910 if (MDOC_Bl
== n
->tok
&& n
->norm
->Bl
.comp
)
1912 if (MDOC_Bd
== n
->tok
&& n
->norm
->Bd
.comp
)
1914 if (MDOC_It
== n
->tok
&& n
->parent
->norm
->Bl
.comp
)
1917 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNPAR
);
1918 mdoc_node_delete(mdoc
, mdoc
->last
);
1923 pre_literal(PRE_ARGS
)
1926 if (MDOC_BODY
!= n
->type
)
1930 * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd
1931 * -unfilled' macros set MDOC_LITERAL on entrance to the body.
1936 mdoc
->flags
|= MDOC_LITERAL
;
1939 if (DISP_literal
== n
->norm
->Bd
.type
)
1940 mdoc
->flags
|= MDOC_LITERAL
;
1941 if (DISP_unfilled
== n
->norm
->Bd
.type
)
1942 mdoc
->flags
|= MDOC_LITERAL
;
1956 struct mdoc_node
*n
;
1960 if (NULL
== n
->child
) {
1961 mdoc
->meta
.date
= time(NULL
);
1965 if ( ! concat(mdoc
, buf
, n
->child
, DATESIZE
))
1968 mdoc
->meta
.date
= mandoc_a2time
1969 (MTIME_MDOCDATE
| MTIME_CANONICAL
, buf
);
1971 if (0 == mdoc
->meta
.date
) {
1972 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADDATE
);
1973 mdoc
->meta
.date
= time(NULL
);
1982 struct mdoc_node
*nn
, *n
;
1988 if (mdoc
->meta
.title
)
1989 free(mdoc
->meta
.title
);
1991 free(mdoc
->meta
.vol
);
1992 if (mdoc
->meta
.arch
)
1993 free(mdoc
->meta
.arch
);
1995 mdoc
->meta
.title
= mdoc
->meta
.vol
= mdoc
->meta
.arch
= NULL
;
1997 /* First make all characters uppercase. */
1999 if (NULL
!= (nn
= n
->child
))
2000 for (p
= nn
->string
; *p
; p
++) {
2001 if (toupper((u_char
)*p
) == *p
)
2005 * FIXME: don't be lazy: have this make all
2006 * characters be uppercase and just warn once.
2008 mdoc_nmsg(mdoc
, nn
, MANDOCERR_UPPERCASE
);
2013 * --> title = unknown, volume = local, msec = 0, arch = NULL
2016 if (NULL
== (nn
= n
->child
)) {
2017 /* XXX: make these macro values. */
2018 /* FIXME: warn about missing values. */
2019 mdoc
->meta
.title
= mandoc_strdup("UNKNOWN");
2020 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2021 mdoc
->meta
.msec
= mandoc_strdup("1");
2025 /* Handles: `.Dt TITLE'
2026 * --> title = TITLE, volume = local, msec = 0, arch = NULL
2029 mdoc
->meta
.title
= mandoc_strdup
2030 ('\0' == nn
->string
[0] ? "UNKNOWN" : nn
->string
);
2032 if (NULL
== (nn
= nn
->next
)) {
2033 /* FIXME: warn about missing msec. */
2034 /* XXX: make this a macro value. */
2035 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2036 mdoc
->meta
.msec
= mandoc_strdup("1");
2040 /* Handles: `.Dt TITLE SEC'
2041 * --> title = TITLE, volume = SEC is msec ?
2042 * format(msec) : SEC,
2043 * msec = SEC is msec ? atoi(msec) : 0,
2047 cp
= mdoc_a2msec(nn
->string
);
2049 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2050 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2052 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADMSEC
);
2053 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2054 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2057 if (NULL
== (nn
= nn
->next
))
2060 /* Handles: `.Dt TITLE SEC VOL'
2061 * --> title = TITLE, volume = VOL is vol ?
2063 * VOL is arch ? format(arch) :
2067 cp
= mdoc_a2vol(nn
->string
);
2069 free(mdoc
->meta
.vol
);
2070 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2072 /* FIXME: warn about bad arch. */
2073 cp
= mdoc_a2arch(nn
->string
);
2075 free(mdoc
->meta
.vol
);
2076 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2078 mdoc
->meta
.arch
= mandoc_strdup(cp
);
2081 /* Ignore any subsequent parameters... */
2082 /* FIXME: warn about subsequent parameters. */
2088 post_prol(POST_ARGS
)
2091 * Remove prologue macros from the document after they're
2092 * processed. The final document uses mdoc_meta for these
2093 * values and discards the originals.
2096 mdoc_node_delete(mdoc
, mdoc
->last
);
2097 if (mdoc
->meta
.title
&& mdoc
->meta
.date
&& mdoc
->meta
.os
)
2098 mdoc
->flags
|= MDOC_PBODY
;
2106 struct mdoc_node
*n
;
2109 struct utsname utsname
;
2115 * Set the operating system by way of the `Os' macro. Note that
2116 * if an argument isn't provided and -DOSNAME="\"foo\"" is
2117 * provided during compilation, this value will be used instead
2118 * of filling in "sysname release" from uname().
2122 free(mdoc
->meta
.os
);
2124 if ( ! concat(mdoc
, buf
, n
->child
, BUFSIZ
))
2127 /* XXX: yes, these can all be dynamically-adjusted buffers, but
2128 * it's really not worth the extra hackery.
2131 if ('\0' == buf
[0]) {
2133 if (strlcat(buf
, OSNAME
, BUFSIZ
) >= BUFSIZ
) {
2134 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2138 if (uname(&utsname
)) {
2139 mdoc_nmsg(mdoc
, n
, MANDOCERR_UNAME
);
2140 mdoc
->meta
.os
= mandoc_strdup("UNKNOWN");
2141 return(post_prol(mdoc
));
2144 if (strlcat(buf
, utsname
.sysname
, BUFSIZ
) >= BUFSIZ
) {
2145 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2148 if (strlcat(buf
, " ", BUFSIZ
) >= BUFSIZ
) {
2149 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2152 if (strlcat(buf
, utsname
.release
, BUFSIZ
) >= BUFSIZ
) {
2153 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2159 mdoc
->meta
.os
= mandoc_strdup(buf
);
2166 struct mdoc_node
*nn
, *n
;
2171 * Macros accepting `-std' as an argument have the name of the
2172 * current document (`Nm') filled in as the argument if it's not
2179 if (NULL
== mdoc
->meta
.name
)
2183 mdoc
->next
= MDOC_NEXT_CHILD
;
2185 if ( ! mdoc_word_alloc(mdoc
, n
->line
, n
->pos
, mdoc
->meta
.name
))
2193 concat(struct mdoc
*m
, char *p
, const struct mdoc_node
*n
, size_t sz
)
2199 * Concatenate sibling nodes together. All siblings must be of
2200 * type MDOC_TEXT or an assertion is raised. Concatenation is
2201 * separated by a single whitespace. Returns 0 on fatal (string
2205 for ( ; n
; n
= n
->next
) {
2206 assert(MDOC_TEXT
== n
->type
);
2208 if (strlcat(p
, n
->string
, sz
) >= sz
) {
2209 mdoc_nmsg(m
, n
, MANDOCERR_MEM
);
2213 if (NULL
== n
->next
)
2216 if (strlcat(p
, " ", sz
) >= sz
) {
2217 mdoc_nmsg(m
, n
, MANDOCERR_MEM
);