]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_validate.c
1 /* $Id: mdoc_validate.c,v 1.119 2010/09/27 23:03:44 schwarze 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.
21 #include <sys/types.h>
32 #include "libmandoc.h"
34 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
36 #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n
37 #define POST_ARGS struct mdoc *mdoc
39 typedef int (*v_pre
)(PRE_ARGS
);
40 typedef int (*v_post
)(POST_ARGS
);
47 static int check_parent(PRE_ARGS
, enum mdoct
, enum mdoc_type
);
48 static int check_stdarg(PRE_ARGS
);
49 static int check_text(struct mdoc
*, int, int, char *);
50 static int check_argv(struct mdoc
*,
51 struct mdoc_node
*, struct mdoc_argv
*);
52 static int check_args(struct mdoc
*, struct mdoc_node
*);
53 static int err_child_lt(struct mdoc
*, const char *, int);
54 static int warn_child_lt(struct mdoc
*, const char *, int);
55 static int err_child_gt(struct mdoc
*, const char *, int);
56 static int warn_child_gt(struct mdoc
*, const char *, int);
57 static int err_child_eq(struct mdoc
*, const char *, int);
58 static int warn_child_eq(struct mdoc
*, const char *, int);
59 static int warn_count(struct mdoc
*, const char *,
60 int, const char *, int);
61 static int err_count(struct mdoc
*, const char *,
62 int, const char *, int);
64 static int berr_ge1(POST_ARGS
);
65 static int bwarn_ge1(POST_ARGS
);
66 static int ebool(POST_ARGS
);
67 static int eerr_eq1(POST_ARGS
);
68 static int eerr_ge1(POST_ARGS
);
69 static int eerr_le1(POST_ARGS
);
70 static int ewarn_eq0(POST_ARGS
);
71 static int ewarn_ge1(POST_ARGS
);
72 static int herr_eq0(POST_ARGS
);
73 static int herr_ge1(POST_ARGS
);
74 static int hwarn_eq1(POST_ARGS
);
75 static int hwarn_eq0(POST_ARGS
);
76 static int hwarn_le1(POST_ARGS
);
78 static int post_an(POST_ARGS
);
79 static int post_at(POST_ARGS
);
80 static int post_bf(POST_ARGS
);
81 static int post_bl(POST_ARGS
);
82 static int post_bl_head(POST_ARGS
);
83 static int post_dt(POST_ARGS
);
84 static int post_it(POST_ARGS
);
85 static int post_lb(POST_ARGS
);
86 static int post_nm(POST_ARGS
);
87 static int post_root(POST_ARGS
);
88 static int post_rs(POST_ARGS
);
89 static int post_sh(POST_ARGS
);
90 static int post_sh_body(POST_ARGS
);
91 static int post_sh_head(POST_ARGS
);
92 static int post_st(POST_ARGS
);
93 static int post_eoln(POST_ARGS
);
94 static int post_vt(POST_ARGS
);
95 static int pre_an(PRE_ARGS
);
96 static int pre_bd(PRE_ARGS
);
97 static int pre_bl(PRE_ARGS
);
98 static int pre_dd(PRE_ARGS
);
99 static int pre_display(PRE_ARGS
);
100 static int pre_dt(PRE_ARGS
);
101 static int pre_it(PRE_ARGS
);
102 static int pre_os(PRE_ARGS
);
103 static int pre_pp(PRE_ARGS
);
104 static int pre_rv(PRE_ARGS
);
105 static int pre_sh(PRE_ARGS
);
106 static int pre_ss(PRE_ARGS
);
108 static v_post posts_an
[] = { post_an
, NULL
};
109 static v_post posts_at
[] = { post_at
, NULL
};
110 static v_post posts_bd_bk
[] = { hwarn_eq0
, bwarn_ge1
, NULL
};
111 static v_post posts_bf
[] = { hwarn_le1
, post_bf
, NULL
};
112 static v_post posts_bl
[] = { bwarn_ge1
, post_bl
, NULL
};
113 static v_post posts_bool
[] = { eerr_eq1
, ebool
, NULL
};
114 static v_post posts_eoln
[] = { post_eoln
, NULL
};
115 static v_post posts_dt
[] = { post_dt
, NULL
};
116 static v_post posts_fo
[] = { hwarn_eq1
, bwarn_ge1
, NULL
};
117 static v_post posts_it
[] = { post_it
, NULL
};
118 static v_post posts_lb
[] = { eerr_eq1
, post_lb
, NULL
};
119 static v_post posts_nd
[] = { berr_ge1
, NULL
};
120 static v_post posts_nm
[] = { post_nm
, NULL
};
121 static v_post posts_notext
[] = { ewarn_eq0
, NULL
};
122 static v_post posts_rs
[] = { berr_ge1
, herr_eq0
, post_rs
, NULL
};
123 static v_post posts_sh
[] = { herr_ge1
, bwarn_ge1
, post_sh
, NULL
};
124 static v_post posts_sp
[] = { eerr_le1
, NULL
};
125 static v_post posts_ss
[] = { herr_ge1
, NULL
};
126 static v_post posts_st
[] = { eerr_eq1
, post_st
, NULL
};
127 static v_post posts_text
[] = { eerr_ge1
, NULL
};
128 static v_post posts_text1
[] = { eerr_eq1
, NULL
};
129 static v_post posts_vt
[] = { post_vt
, NULL
};
130 static v_post posts_wline
[] = { bwarn_ge1
, herr_eq0
, NULL
};
131 static v_post posts_wtext
[] = { ewarn_ge1
, NULL
};
132 static v_pre pres_an
[] = { pre_an
, NULL
};
133 static v_pre pres_bd
[] = { pre_display
, pre_bd
, pre_pp
, NULL
};
134 static v_pre pres_bl
[] = { pre_bl
, pre_pp
, NULL
};
135 static v_pre pres_d1
[] = { pre_display
, NULL
};
136 static v_pre pres_dd
[] = { pre_dd
, NULL
};
137 static v_pre pres_dt
[] = { pre_dt
, NULL
};
138 static v_pre pres_er
[] = { NULL
, NULL
};
139 static v_pre pres_ex
[] = { NULL
, NULL
};
140 static v_pre pres_fd
[] = { NULL
, NULL
};
141 static v_pre pres_it
[] = { pre_it
, NULL
};
142 static v_pre pres_os
[] = { pre_os
, NULL
};
143 static v_pre pres_pp
[] = { pre_pp
, NULL
};
144 static v_pre pres_rv
[] = { pre_rv
, NULL
};
145 static v_pre pres_sh
[] = { pre_sh
, NULL
};
146 static v_pre pres_ss
[] = { pre_ss
, NULL
};
148 const struct valids mdoc_valids
[MDOC_MAX
] = {
149 { NULL
, NULL
}, /* Ap */
150 { pres_dd
, posts_wtext
}, /* Dd */
151 { pres_dt
, posts_dt
}, /* Dt */
152 { pres_os
, NULL
}, /* Os */
153 { pres_sh
, posts_sh
}, /* Sh */
154 { pres_ss
, posts_ss
}, /* Ss */
155 { pres_pp
, posts_notext
}, /* Pp */
156 { pres_d1
, posts_wline
}, /* D1 */
157 { pres_d1
, posts_wline
}, /* Dl */
158 { pres_bd
, posts_bd_bk
}, /* Bd */
159 { NULL
, NULL
}, /* Ed */
160 { pres_bl
, posts_bl
}, /* Bl */
161 { NULL
, NULL
}, /* El */
162 { pres_it
, posts_it
}, /* It */
163 { NULL
, posts_text
}, /* Ad */
164 { pres_an
, posts_an
}, /* An */
165 { NULL
, NULL
}, /* Ar */
166 { NULL
, posts_text
}, /* Cd */
167 { NULL
, NULL
}, /* Cm */
168 { NULL
, NULL
}, /* Dv */
169 { pres_er
, posts_text
}, /* Er */
170 { NULL
, NULL
}, /* Ev */
171 { pres_ex
, NULL
}, /* Ex */
172 { NULL
, NULL
}, /* Fa */
173 { pres_fd
, posts_wtext
}, /* Fd */
174 { NULL
, NULL
}, /* Fl */
175 { NULL
, posts_text
}, /* Fn */
176 { NULL
, posts_wtext
}, /* Ft */
177 { NULL
, posts_text
}, /* Ic */
178 { NULL
, posts_text1
}, /* In */
179 { NULL
, NULL
}, /* Li */
180 { NULL
, posts_nd
}, /* Nd */
181 { NULL
, posts_nm
}, /* Nm */
182 { NULL
, posts_wline
}, /* Op */
183 { NULL
, NULL
}, /* Ot */
184 { NULL
, NULL
}, /* Pa */
185 { pres_rv
, NULL
}, /* Rv */
186 { NULL
, posts_st
}, /* St */
187 { NULL
, NULL
}, /* Va */
188 { NULL
, posts_vt
}, /* Vt */
189 { NULL
, posts_wtext
}, /* Xr */
190 { NULL
, posts_text
}, /* %A */
191 { NULL
, posts_text
}, /* %B */ /* FIXME: can be used outside Rs/Re. */
192 { NULL
, posts_text
}, /* %D */ /* FIXME: check date with mandoc_a2time(). */
193 { NULL
, posts_text
}, /* %I */
194 { NULL
, posts_text
}, /* %J */
195 { NULL
, posts_text
}, /* %N */
196 { NULL
, posts_text
}, /* %O */
197 { NULL
, posts_text
}, /* %P */
198 { NULL
, posts_text
}, /* %R */
199 { NULL
, posts_text
}, /* %T */ /* FIXME: can be used outside Rs/Re. */
200 { NULL
, posts_text
}, /* %V */
201 { NULL
, NULL
}, /* Ac */
202 { NULL
, NULL
}, /* Ao */
203 { NULL
, posts_wline
}, /* Aq */
204 { NULL
, posts_at
}, /* At */
205 { NULL
, NULL
}, /* Bc */
206 { NULL
, posts_bf
}, /* Bf */
207 { NULL
, NULL
}, /* Bo */
208 { NULL
, posts_wline
}, /* Bq */
209 { NULL
, NULL
}, /* Bsx */
210 { NULL
, NULL
}, /* Bx */
211 { NULL
, posts_bool
}, /* Db */
212 { NULL
, NULL
}, /* Dc */
213 { NULL
, NULL
}, /* Do */
214 { NULL
, posts_wline
}, /* Dq */
215 { NULL
, NULL
}, /* Ec */
216 { NULL
, NULL
}, /* Ef */
217 { NULL
, NULL
}, /* Em */
218 { NULL
, NULL
}, /* Eo */
219 { NULL
, NULL
}, /* Fx */
220 { NULL
, posts_text
}, /* Ms */
221 { NULL
, posts_notext
}, /* No */
222 { NULL
, posts_notext
}, /* Ns */
223 { NULL
, NULL
}, /* Nx */
224 { NULL
, NULL
}, /* Ox */
225 { NULL
, NULL
}, /* Pc */
226 { NULL
, posts_text1
}, /* Pf */
227 { NULL
, NULL
}, /* Po */
228 { NULL
, posts_wline
}, /* Pq */
229 { NULL
, NULL
}, /* Qc */
230 { NULL
, posts_wline
}, /* Ql */
231 { NULL
, NULL
}, /* Qo */
232 { NULL
, posts_wline
}, /* Qq */
233 { NULL
, NULL
}, /* Re */
234 { NULL
, posts_rs
}, /* Rs */
235 { NULL
, NULL
}, /* Sc */
236 { NULL
, NULL
}, /* So */
237 { NULL
, posts_wline
}, /* Sq */
238 { NULL
, posts_bool
}, /* Sm */
239 { NULL
, posts_text
}, /* Sx */
240 { NULL
, posts_text
}, /* Sy */
241 { NULL
, posts_text
}, /* Tn */
242 { NULL
, NULL
}, /* Ux */
243 { NULL
, NULL
}, /* Xc */
244 { NULL
, NULL
}, /* Xo */
245 { NULL
, posts_fo
}, /* Fo */
246 { NULL
, NULL
}, /* Fc */
247 { NULL
, NULL
}, /* Oo */
248 { NULL
, NULL
}, /* Oc */
249 { NULL
, posts_bd_bk
}, /* Bk */
250 { NULL
, NULL
}, /* Ek */
251 { NULL
, posts_eoln
}, /* Bt */
252 { NULL
, NULL
}, /* Hf */
253 { NULL
, NULL
}, /* Fr */
254 { NULL
, posts_eoln
}, /* Ud */
255 { NULL
, posts_lb
}, /* Lb */
256 { NULL
, posts_notext
}, /* Lp */
257 { NULL
, posts_text
}, /* Lk */
258 { NULL
, posts_text
}, /* Mt */
259 { NULL
, posts_wline
}, /* Brq */
260 { NULL
, NULL
}, /* Bro */
261 { NULL
, NULL
}, /* Brc */
262 { NULL
, posts_text
}, /* %C */
263 { NULL
, NULL
}, /* Es */
264 { NULL
, NULL
}, /* En */
265 { NULL
, NULL
}, /* Dx */
266 { NULL
, posts_text
}, /* %Q */
267 { NULL
, posts_notext
}, /* br */
268 { pres_pp
, posts_sp
}, /* sp */
269 { NULL
, posts_text1
}, /* %U */
270 { NULL
, NULL
}, /* Ta */
275 mdoc_valid_pre(struct mdoc
*mdoc
, struct mdoc_node
*n
)
281 if (MDOC_TEXT
== n
->type
) {
285 return(check_text(mdoc
, line
, pos
, tp
));
288 if ( ! check_args(mdoc
, n
))
290 if (NULL
== mdoc_valids
[n
->tok
].pre
)
292 for (p
= mdoc_valids
[n
->tok
].pre
; *p
; p
++)
293 if ( ! (*p
)(mdoc
, n
))
300 mdoc_valid_post(struct mdoc
*mdoc
)
304 if (MDOC_VALID
& mdoc
->last
->flags
)
306 mdoc
->last
->flags
|= MDOC_VALID
;
308 if (MDOC_TEXT
== mdoc
->last
->type
)
310 if (MDOC_ROOT
== mdoc
->last
->type
)
311 return(post_root(mdoc
));
313 if (NULL
== mdoc_valids
[mdoc
->last
->tok
].post
)
315 for (p
= mdoc_valids
[mdoc
->last
->tok
].post
; *p
; p
++)
324 warn_count(struct mdoc
*m
, const char *k
,
325 int want
, const char *v
, int has
)
328 return(mdoc_vmsg(m
, MANDOCERR_ARGCOUNT
,
329 m
->last
->line
, m
->last
->pos
,
330 "%s %s %d (have %d)", v
, k
, want
, has
));
335 err_count(struct mdoc
*m
, const char *k
,
336 int want
, const char *v
, int has
)
339 mdoc_vmsg(m
, MANDOCERR_SYNTARGCOUNT
,
340 m
->last
->line
, m
->last
->pos
,
341 "%s %s %d (have %d)",
348 * Build these up with macros because they're basically the same check
349 * for different inequalities. Yes, this could be done with functions,
350 * but this is reasonable for now.
353 #define CHECK_CHILD_DEFN(lvl, name, ineq) \
355 lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \
357 if (mdoc->last->nchild ineq sz) \
359 return(lvl##_count(mdoc, #ineq, sz, p, mdoc->last->nchild)); \
362 #define CHECK_BODY_DEFN(name, lvl, func, num) \
364 b##lvl##_##name(POST_ARGS) \
366 if (MDOC_BODY != mdoc->last->type) \
368 return(func(mdoc, "multi-line arguments", (num))); \
371 #define CHECK_ELEM_DEFN(name, lvl, func, num) \
373 e##lvl##_##name(POST_ARGS) \
375 assert(MDOC_ELEM == mdoc->last->type); \
376 return(func(mdoc, "line arguments", (num))); \
379 #define CHECK_HEAD_DEFN(name, lvl, func, num) \
381 h##lvl##_##name(POST_ARGS) \
383 if (MDOC_HEAD != mdoc->last->type) \
385 return(func(mdoc, "line arguments", (num))); \
389 CHECK_CHILD_DEFN(warn
, gt
, >) /* warn_child_gt() */
390 CHECK_CHILD_DEFN(err
, gt
, >) /* err_child_gt() */
391 CHECK_CHILD_DEFN(warn
, eq
, ==) /* warn_child_eq() */
392 CHECK_CHILD_DEFN(err
, eq
, ==) /* err_child_eq() */
393 CHECK_CHILD_DEFN(err
, lt
, <) /* err_child_lt() */
394 CHECK_CHILD_DEFN(warn
, lt
, <) /* warn_child_lt() */
395 CHECK_BODY_DEFN(ge1
, warn
, warn_child_gt
, 0) /* bwarn_ge1() */
396 CHECK_BODY_DEFN(ge1
, err
, err_child_gt
, 0) /* berr_ge1() */
397 CHECK_ELEM_DEFN(eq0
, warn
, warn_child_eq
, 0) /* ewarn_eq0() */
398 CHECK_ELEM_DEFN(ge1
, warn
, warn_child_gt
, 0) /* ewarn_ge1() */
399 CHECK_ELEM_DEFN(eq1
, err
, err_child_eq
, 1) /* eerr_eq1() */
400 CHECK_ELEM_DEFN(le1
, err
, err_child_lt
, 2) /* eerr_le1() */
401 CHECK_ELEM_DEFN(ge1
, err
, err_child_gt
, 0) /* eerr_ge1() */
402 CHECK_HEAD_DEFN(eq0
, err
, err_child_eq
, 0) /* herr_eq0() */
403 CHECK_HEAD_DEFN(le1
, warn
, warn_child_lt
, 2) /* hwarn_le1() */
404 CHECK_HEAD_DEFN(ge1
, err
, err_child_gt
, 0) /* herr_ge1() */
405 CHECK_HEAD_DEFN(eq1
, warn
, warn_child_eq
, 1) /* hwarn_eq1() */
406 CHECK_HEAD_DEFN(eq0
, warn
, warn_child_eq
, 0) /* hwarn_eq0() */
410 check_stdarg(PRE_ARGS
)
413 if (n
->args
&& 1 == n
->args
->argc
)
414 if (MDOC_Std
== n
->args
->argv
[0].arg
)
416 return(mdoc_nmsg(mdoc
, n
, MANDOCERR_NOARGV
));
421 check_args(struct mdoc
*m
, struct mdoc_node
*n
)
428 assert(n
->args
->argc
);
429 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
430 if ( ! check_argv(m
, n
, &n
->args
->argv
[i
]))
438 check_argv(struct mdoc
*m
, struct mdoc_node
*n
, struct mdoc_argv
*v
)
442 for (i
= 0; i
< (int)v
->sz
; i
++)
443 if ( ! check_text(m
, v
->line
, v
->pos
, v
->value
[i
]))
446 if (MDOC_Std
== v
->arg
) {
447 if (v
->sz
|| m
->meta
.name
)
449 if ( ! mdoc_nmsg(m
, n
, MANDOCERR_NONAME
))
458 check_text(struct mdoc
*m
, int ln
, int pos
, char *p
)
463 for ( ; *p
; p
++, pos
++) {
464 sz
= strcspn(p
, "\t\\");
473 if (MDOC_LITERAL
& m
->flags
)
475 if (mdoc_pmsg(m
, ln
, pos
, MANDOCERR_BADTAB
))
480 /* Check the special character. */
482 c
= mandoc_special(p
);
487 mdoc_pmsg(m
, ln
, pos
, MANDOCERR_BADESCAPE
);
495 check_parent(PRE_ARGS
, enum mdoct tok
, enum mdoc_type t
)
499 if ((MDOC_ROOT
== t
|| tok
== n
->parent
->tok
) &&
500 (t
== n
->parent
->type
))
503 mdoc_vmsg(mdoc
, MANDOCERR_SYNTCHILD
,
504 n
->line
, n
->pos
, "want parent %s",
505 MDOC_ROOT
== t
? "<root>" :
506 mdoc_macronames
[tok
]);
512 pre_display(PRE_ARGS
)
514 struct mdoc_node
*node
;
516 /* Display elements (`Bd', `D1'...) cannot be nested. */
518 if (MDOC_BLOCK
!= n
->type
)
522 for (node
= mdoc
->last
->parent
; node
; node
= node
->parent
)
523 if (MDOC_BLOCK
== node
->type
)
524 if (MDOC_Bd
== node
->tok
)
529 mdoc_nmsg(mdoc
, n
, MANDOCERR_NESTEDDISP
);
538 const char *offs
, *width
;
540 struct mdoc_node
*np
;
542 if (MDOC_BLOCK
!= n
->type
) {
543 if (ENDBODY_NOT
!= n
->end
) {
545 np
= n
->pending
->parent
;
550 assert(MDOC_BLOCK
== np
->type
);
551 assert(MDOC_Bl
== np
->tok
);
553 n
->data
.Bl
= np
->data
.Bl
;
558 * First figure out which kind of list to use: bind ourselves to
559 * the first mentioned list type and warn about any remaining
560 * ones. If we find no list type, we default to LIST_item.
563 assert(NULL
== n
->data
.Bl
);
564 n
->data
.Bl
= mandoc_calloc(1, sizeof(struct mdoc_bl
));
567 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
571 switch (n
->args
->argv
[i
].arg
) {
572 /* Set list types. */
606 /* Set list arguments. */
608 dup
= n
->data
.Bl
->comp
;
612 dup
= (NULL
!= n
->data
.Bl
->width
);
613 width
= n
->args
->argv
[i
].value
[0];
616 /* NB: this can be empty! */
617 if (n
->args
->argv
[i
].sz
) {
618 offs
= n
->args
->argv
[i
].value
[0];
619 dup
= (NULL
!= n
->data
.Bl
->offs
);
622 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
))
629 /* Check: duplicate auxiliary arguments. */
631 if (dup
&& ! mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
))
635 n
->data
.Bl
->comp
= comp
;
637 n
->data
.Bl
->offs
= offs
;
639 n
->data
.Bl
->width
= width
;
641 /* Check: multiple list types. */
643 if (LIST__NONE
!= lt
&& n
->data
.Bl
->type
!= LIST__NONE
)
644 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTREP
))
647 /* Assign list type. */
649 if (LIST__NONE
!= lt
&& n
->data
.Bl
->type
== LIST__NONE
) {
650 n
->data
.Bl
->type
= lt
;
651 /* Set column information, too. */
652 if (LIST_column
== lt
) {
655 n
->data
.Bl
->cols
= (const char **)
656 n
->args
->argv
[i
].value
;
660 /* The list type should come first. */
662 if (n
->data
.Bl
->type
== LIST__NONE
)
663 if (n
->data
.Bl
->width
||
666 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTFIRST
))
672 /* Allow lists to default to LIST_item. */
674 if (LIST__NONE
== n
->data
.Bl
->type
) {
675 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTTYPE
))
677 n
->data
.Bl
->type
= LIST_item
;
681 * Validate the width field. Some list types don't need width
682 * types and should be warned about them. Others should have it
683 * and must also be warned.
686 switch (n
->data
.Bl
->type
) {
688 if (n
->data
.Bl
->width
)
690 if (mdoc_nmsg(mdoc
, n
, MANDOCERR_NOWIDTHARG
))
702 if (NULL
== n
->data
.Bl
->width
)
704 if (mdoc_nmsg(mdoc
, n
, MANDOCERR_WIDTHARG
))
721 struct mdoc_node
*np
;
723 if (MDOC_BLOCK
!= n
->type
) {
724 if (ENDBODY_NOT
!= n
->end
) {
726 np
= n
->pending
->parent
;
731 assert(MDOC_BLOCK
== np
->type
);
732 assert(MDOC_Bd
== np
->tok
);
734 n
->data
.Bd
= np
->data
.Bd
;
738 assert(NULL
== n
->data
.Bd
);
739 n
->data
.Bd
= mandoc_calloc(1, sizeof(struct mdoc_bd
));
742 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
747 switch (n
->args
->argv
[i
].arg
) {
754 case (MDOC_Unfilled
):
764 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADDISP
);
767 /* NB: this can be empty! */
768 if (n
->args
->argv
[i
].sz
) {
769 offs
= n
->args
->argv
[i
].value
[0];
770 dup
= (NULL
!= n
->data
.Bd
->offs
);
773 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
))
778 dup
= n
->data
.Bd
->comp
;
785 /* Check whether we have duplicates. */
787 if (dup
&& ! mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
))
790 /* Make our auxiliary assignments. */
793 n
->data
.Bd
->offs
= offs
;
795 n
->data
.Bd
->comp
= comp
;
797 /* Check whether a type has already been assigned. */
799 if (DISP__NONE
!= dt
&& n
->data
.Bd
->type
!= DISP__NONE
)
800 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPREP
))
803 /* Make our type assignment. */
805 if (DISP__NONE
!= dt
&& n
->data
.Bd
->type
== DISP__NONE
)
806 n
->data
.Bd
->type
= dt
;
809 if (DISP__NONE
== n
->data
.Bd
->type
) {
810 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPTYPE
))
812 n
->data
.Bd
->type
= DISP_ragged
;
823 if (MDOC_BLOCK
!= n
->type
)
825 return(check_parent(mdoc
, n
, MDOC_Sh
, MDOC_BODY
));
833 if (MDOC_BLOCK
!= n
->type
)
836 mdoc
->regs
->regs
[(int)REG_nS
].set
= 0;
837 return(check_parent(mdoc
, n
, MDOC_MAX
, MDOC_ROOT
));
845 if (MDOC_BLOCK
!= n
->type
)
848 * FIXME: this can probably be lifted if we make the It into
849 * something else on-the-fly?
851 return(check_parent(mdoc
, n
, MDOC_Bl
, MDOC_BODY
));
861 if (n
->args
->argc
> 1)
862 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGCOUNT
))
865 if (MDOC_Split
== n
->args
->argv
[0].arg
)
866 n
->data
.An
.auth
= AUTH_split
;
867 else if (MDOC_Nosplit
== n
->args
->argv
[0].arg
)
868 n
->data
.An
.auth
= AUTH_nosplit
;
880 return(check_stdarg(mdoc
, n
));
887 const struct mdoc_node
*nn
;
890 if (NULL
!= (nn
= mdoc
->last
->child
))
891 for (p
= nn
->string
; *p
; p
++) {
892 if (toupper((u_char
)*p
) == *p
)
894 if ( ! mdoc_nmsg(mdoc
, nn
, MANDOCERR_UPPERCASE
))
907 if (0 == mdoc
->meta
.date
|| mdoc
->meta
.os
)
908 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
))
910 if (mdoc
->meta
.title
)
911 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
))
921 if (NULL
== mdoc
->meta
.title
|| 0 == mdoc
->meta
.date
)
922 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
))
925 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
))
935 if (mdoc
->meta
.title
|| mdoc
->meta
.os
)
936 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
))
939 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
))
948 struct mdoc_node
*np
;
952 * Unlike other data pointers, these are "housed" by the HEAD
953 * element, which contains the goods.
956 if (MDOC_HEAD
!= mdoc
->last
->type
) {
957 if (ENDBODY_NOT
!= mdoc
->last
->end
) {
958 assert(mdoc
->last
->pending
);
959 np
= mdoc
->last
->pending
->parent
->head
;
960 } else if (MDOC_BLOCK
!= mdoc
->last
->type
) {
961 np
= mdoc
->last
->parent
->head
;
963 np
= mdoc
->last
->head
;
966 assert(MDOC_HEAD
== np
->type
);
967 assert(MDOC_Bf
== np
->tok
);
969 mdoc
->last
->data
.Bf
= np
->data
.Bf
;
974 assert(MDOC_BLOCK
== np
->parent
->type
);
975 assert(MDOC_Bf
== np
->parent
->tok
);
976 np
->data
.Bf
= mandoc_calloc(1, sizeof(struct mdoc_bf
));
979 * Cannot have both argument and parameter.
980 * If neither is specified, let it through with a warning.
983 if (np
->parent
->args
&& np
->child
) {
984 mdoc_nmsg(mdoc
, np
, MANDOCERR_SYNTARGVCOUNT
);
986 } else if (NULL
== np
->parent
->args
&& NULL
== np
->child
)
987 return(mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
));
989 /* Extract argument into data. */
991 if (np
->parent
->args
) {
992 arg
= np
->parent
->args
->argv
[0].arg
;
993 if (MDOC_Emphasis
== arg
)
994 np
->data
.Bf
->font
= FONT_Em
;
995 else if (MDOC_Literal
== arg
)
996 np
->data
.Bf
->font
= FONT_Li
;
997 else if (MDOC_Symbolic
== arg
)
998 np
->data
.Bf
->font
= FONT_Sy
;
1004 /* Extract parameter into data. */
1006 if (0 == strcmp(np
->child
->string
, "Em"))
1007 np
->data
.Bf
->font
= FONT_Em
;
1008 else if (0 == strcmp(np
->child
->string
, "Li"))
1009 np
->data
.Bf
->font
= FONT_Li
;
1010 else if (0 == strcmp(np
->child
->string
, "Sy"))
1011 np
->data
.Bf
->font
= FONT_Sy
;
1012 else if ( ! mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
))
1023 if (mdoc_a2lib(mdoc
->last
->child
->string
))
1025 return(mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADLIB
));
1030 post_eoln(POST_ARGS
)
1033 if (NULL
== mdoc
->last
->child
)
1035 return(mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
));
1042 const struct mdoc_node
*n
;
1045 * The Vt macro comes in both ELEM and BLOCK form, both of which
1046 * have different syntaxes (yet more context-sensitive
1047 * behaviour). ELEM types must have a child; BLOCK types,
1048 * specifically the BODY, should only have TEXT children.
1051 if (MDOC_ELEM
== mdoc
->last
->type
)
1052 return(eerr_ge1(mdoc
));
1053 if (MDOC_BODY
!= mdoc
->last
->type
)
1056 for (n
= mdoc
->last
->child
; n
; n
= n
->next
)
1057 if (MDOC_TEXT
!= n
->type
)
1058 if ( ! mdoc_nmsg(mdoc
, n
, MANDOCERR_CHILD
))
1069 if (mdoc
->last
->child
)
1071 if (mdoc
->meta
.name
)
1073 return(mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NONAME
));
1081 if (NULL
== mdoc
->last
->child
)
1083 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1084 if (mdoc_a2att(mdoc
->last
->child
->string
))
1086 return(mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADATT
));
1093 struct mdoc_node
*np
;
1096 if (AUTH__NONE
!= np
->data
.An
.auth
&& np
->child
)
1097 return(mdoc_nmsg(mdoc
, np
, MANDOCERR_ARGCOUNT
));
1098 if (AUTH__NONE
!= np
->data
.An
.auth
|| np
->child
)
1100 return(mdoc_nmsg(mdoc
, np
, MANDOCERR_NOARGS
));
1109 struct mdoc_node
*n
, *c
;
1112 if (MDOC_BLOCK
!= mdoc
->last
->type
)
1115 n
= mdoc
->last
->parent
->parent
;
1117 lt
= n
->data
.Bl
->type
;
1119 if (LIST__NONE
== lt
) {
1120 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_LISTTYPE
);
1126 if (mdoc
->last
->head
->child
)
1128 /* FIXME: give this a dummy value. */
1129 if ( ! mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
))
1139 if (NULL
== mdoc
->last
->head
->child
)
1140 if ( ! mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
))
1150 if (NULL
== mdoc
->last
->body
->child
)
1151 if ( ! mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
))
1155 if (mdoc
->last
->head
->child
)
1156 if ( ! mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
))
1160 cols
= (int)n
->data
.Bl
->ncols
;
1162 assert(NULL
== mdoc
->last
->head
->child
);
1164 if (NULL
== mdoc
->last
->body
->child
)
1165 if ( ! mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
))
1168 for (i
= 0, c
= mdoc
->last
->child
; c
; c
= c
->next
)
1169 if (MDOC_BODY
== c
->type
)
1173 er
= MANDOCERR_ARGCOUNT
;
1174 else if (i
== cols
|| i
== cols
+ 1)
1177 er
= MANDOCERR_SYNTARGCOUNT
;
1179 rc
= mdoc_vmsg(mdoc
, er
,
1180 mdoc
->last
->line
, mdoc
->last
->pos
,
1181 "columns == %d (have %d)", cols
, i
);
1192 post_bl_head(POST_ARGS
)
1195 struct mdoc_node
*n
;
1197 assert(mdoc
->last
->parent
);
1198 n
= mdoc
->last
->parent
;
1200 if (LIST_column
== n
->data
.Bl
->type
) {
1201 if (n
->data
.Bl
->ncols
&& mdoc
->last
->nchild
) {
1202 mdoc_nmsg(mdoc
, n
, MANDOCERR_COLUMNS
);
1208 if (0 == (i
= mdoc
->last
->nchild
))
1210 return(warn_count(mdoc
, "==", 0, "line arguments", i
));
1217 struct mdoc_node
*n
;
1219 if (MDOC_HEAD
== mdoc
->last
->type
)
1220 return(post_bl_head(mdoc
));
1221 if (MDOC_BODY
!= mdoc
->last
->type
)
1223 if (NULL
== mdoc
->last
->child
)
1227 * We only allow certain children of `Bl'. This is usually on
1228 * `It', but apparently `Sm' occurs here and there, so we let
1229 * that one through, too.
1233 for (n
= mdoc
->last
->child
; n
; n
= n
->next
) {
1234 if (MDOC_BLOCK
== n
->type
&& MDOC_It
== n
->tok
)
1236 if (MDOC_Sm
== n
->tok
)
1238 mdoc_nmsg(mdoc
, n
, MANDOCERR_SYNTCHILD
);
1247 ebool(struct mdoc
*mdoc
)
1249 struct mdoc_node
*n
;
1252 for (n
= mdoc
->last
->child
; n
; n
= n
->next
) {
1253 if (MDOC_TEXT
!= n
->type
)
1255 if (0 == strcmp(n
->string
, "on"))
1257 if (0 == strcmp(n
->string
, "off"))
1264 return(mdoc_nmsg(mdoc
, n
, MANDOCERR_BADBOOL
));
1269 post_root(POST_ARGS
)
1272 if (NULL
== mdoc
->first
->child
)
1273 mdoc_nmsg(mdoc
, mdoc
->first
, MANDOCERR_NODOCBODY
);
1274 else if ( ! (MDOC_PBODY
& mdoc
->flags
))
1275 mdoc_nmsg(mdoc
, mdoc
->first
, MANDOCERR_NODOCPROLOG
);
1276 else if (MDOC_BLOCK
!= mdoc
->first
->child
->type
)
1277 mdoc_nmsg(mdoc
, mdoc
->first
, MANDOCERR_NODOCBODY
);
1278 else if (MDOC_Sh
!= mdoc
->first
->child
->tok
)
1279 mdoc_nmsg(mdoc
, mdoc
->first
, MANDOCERR_NODOCBODY
);
1291 if (mdoc_a2st(mdoc
->last
->child
->string
))
1293 return(mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADSTANDARD
));
1300 struct mdoc_node
*nn
;
1302 if (MDOC_BODY
!= mdoc
->last
->type
)
1305 for (nn
= mdoc
->last
->child
; nn
; nn
= nn
->next
)
1336 mdoc_nmsg(mdoc
, nn
, MANDOCERR_SYNTCHILD
);
1348 if (MDOC_HEAD
== mdoc
->last
->type
)
1349 return(post_sh_head(mdoc
));
1350 if (MDOC_BODY
== mdoc
->last
->type
)
1351 return(post_sh_body(mdoc
));
1358 post_sh_body(POST_ARGS
)
1360 struct mdoc_node
*n
;
1362 if (SEC_NAME
!= mdoc
->lastsec
)
1366 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1367 * macros (can have multiple `Nm' and one `Nd'). Note that the
1368 * children of the BODY declaration can also be "text".
1371 if (NULL
== (n
= mdoc
->last
->child
))
1372 return(mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
));
1374 for ( ; n
&& n
->next
; n
= n
->next
) {
1375 if (MDOC_ELEM
== n
->type
&& MDOC_Nm
== n
->tok
)
1377 if (MDOC_TEXT
== n
->type
)
1379 if ( ! mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
))
1384 if (MDOC_BLOCK
== n
->type
&& MDOC_Nd
== n
->tok
)
1386 return(mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
));
1391 post_sh_head(POST_ARGS
)
1395 const struct mdoc_node
*n
;
1398 * Process a new section. Sections are either "named" or
1399 * "custom"; custom sections are user-defined, while named ones
1400 * usually follow a conventional order and may only appear in
1401 * certain manual sections.
1407 * FIXME: yes, these can use a dynamic buffer, but I don't do so
1408 * in the interests of simplicity.
1411 for (n
= mdoc
->last
->child
; n
; n
= n
->next
) {
1412 /* XXX - copied from compact(). */
1413 assert(MDOC_TEXT
== n
->type
);
1415 if (strlcat(buf
, n
->string
, BUFSIZ
) >= BUFSIZ
) {
1416 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
1419 if (NULL
== n
->next
)
1421 if (strlcat(buf
, " ", BUFSIZ
) >= BUFSIZ
) {
1422 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
1427 sec
= mdoc_str2sec(buf
);
1430 * Check: NAME should always be first, CUSTOM has no roles,
1431 * non-CUSTOM has a conventional order to be followed.
1434 if (SEC_NAME
!= sec
&& SEC_NONE
== mdoc
->lastnamed
)
1435 if ( ! mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NAMESECFIRST
))
1438 if (SEC_CUSTOM
== sec
)
1441 if (sec
== mdoc
->lastnamed
)
1442 if ( ! mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECREP
))
1445 if (sec
< mdoc
->lastnamed
)
1446 if ( ! mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECOOO
))
1450 * Check particular section/manual conventions. LIBRARY can
1451 * only occur in manual section 2, 3, and 9.
1456 assert(mdoc
->meta
.msec
);
1457 if (*mdoc
->meta
.msec
== '2')
1459 if (*mdoc
->meta
.msec
== '3')
1461 if (*mdoc
->meta
.msec
== '9')
1463 return(mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECMSEC
));
1476 if (NULL
== mdoc
->last
)
1479 /* Don't allow prior `Lp' or `Pp'. */
1481 if (MDOC_Pp
!= mdoc
->last
->tok
&& MDOC_Lp
!= mdoc
->last
->tok
)
1484 if (MDOC_Bl
== n
->tok
&& n
->data
.Bl
->comp
)
1486 if (MDOC_Bd
== n
->tok
&& n
->data
.Bd
->comp
)
1489 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNPAR
);
1490 mdoc_node_delete(mdoc
, mdoc
->last
);