1 /* $Id: mdoc_validate.c,v 1.37 2009/10/21 19:13:51 schwarze 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/types.h>
28 #include "libmandoc.h"
30 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
31 /* TODO: ignoring Pp (it's superfluous in some invocations). */
33 #define PRE_ARGS struct mdoc *mdoc, const struct mdoc_node *n
34 #define POST_ARGS struct mdoc *mdoc
36 typedef int (*v_pre)(PRE_ARGS);
37 typedef int (*v_post)(POST_ARGS);
44 static int check_parent(PRE_ARGS, int, enum mdoc_type);
45 static int check_msec(PRE_ARGS, ...);
46 static int check_sec(PRE_ARGS, ...);
47 static int check_stdarg(PRE_ARGS);
48 static int check_text(struct mdoc *, int, int, const char *);
49 static int check_argv(struct mdoc *,
50 const struct mdoc_node *,
51 const struct mdoc_argv *);
52 static int check_args(struct mdoc *,
53 const struct mdoc_node *);
54 static int err_child_lt(struct mdoc *, const char *, int);
55 static int warn_child_lt(struct mdoc *, const char *, int);
56 static int err_child_gt(struct mdoc *, const char *, int);
57 static int warn_child_gt(struct mdoc *, const char *, int);
58 static int err_child_eq(struct mdoc *, const char *, int);
59 static int warn_child_eq(struct mdoc *, const char *, int);
60 static int warn_print(struct mdoc *, int, int);
61 static int warn_count(struct mdoc *, const char *,
62 int, const char *, int);
63 static int err_count(struct mdoc *, const char *,
64 int, const char *, int);
66 static int berr_ge1(POST_ARGS);
67 static int bwarn_ge1(POST_ARGS);
68 static int ebool(POST_ARGS);
69 static int eerr_eq0(POST_ARGS);
70 static int eerr_eq1(POST_ARGS);
71 static int eerr_ge1(POST_ARGS);
72 static int eerr_le2(POST_ARGS);
73 static int eerr_le1(POST_ARGS);
74 static int ewarn_ge1(POST_ARGS);
75 static int herr_eq0(POST_ARGS);
76 static int herr_ge1(POST_ARGS);
77 static int hwarn_eq1(POST_ARGS);
78 static int hwarn_le1(POST_ARGS);
80 static int post_an(POST_ARGS);
81 static int post_at(POST_ARGS);
82 static int post_bf(POST_ARGS);
83 static int post_bl(POST_ARGS);
84 static int post_bl_head(POST_ARGS);
85 static int post_it(POST_ARGS);
86 static int post_lb(POST_ARGS);
87 static int post_nm(POST_ARGS);
88 static int post_root(POST_ARGS);
89 static int post_rs(POST_ARGS);
90 static int post_sh(POST_ARGS);
91 static int post_sh_body(POST_ARGS);
92 static int post_sh_head(POST_ARGS);
93 static int post_st(POST_ARGS);
94 static int pre_an(PRE_ARGS);
95 static int pre_bd(PRE_ARGS);
96 static int pre_bl(PRE_ARGS);
97 static int pre_cd(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_er(PRE_ARGS);
102 static int pre_ex(PRE_ARGS);
103 static int pre_fd(PRE_ARGS);
104 static int pre_it(PRE_ARGS);
105 static int pre_lb(PRE_ARGS);
106 static int pre_os(PRE_ARGS);
107 static int pre_rv(PRE_ARGS);
108 static int pre_sh(PRE_ARGS);
109 static int pre_ss(PRE_ARGS);
111 static v_post posts_an[] = { post_an, NULL };
112 static v_post posts_at[] = { post_at, NULL };
113 static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
114 static v_post posts_bf[] = { hwarn_le1, post_bf, NULL };
115 static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL };
116 static v_post posts_bool[] = { eerr_eq1, ebool, NULL };
117 static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
118 static v_post posts_in[] = { eerr_eq1, NULL };
119 static v_post posts_it[] = { post_it, NULL };
120 static v_post posts_lb[] = { eerr_eq1, post_lb, NULL };
121 static v_post posts_nd[] = { berr_ge1, NULL };
122 static v_post posts_nm[] = { post_nm, NULL };
123 static v_post posts_notext[] = { eerr_eq0, NULL };
124 static v_post posts_pf[] = { eerr_eq1, NULL };
125 static v_post posts_rs[] = { berr_ge1, herr_eq0, post_rs, NULL };
126 static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
127 static v_post posts_sp[] = { eerr_le1, NULL };
128 static v_post posts_ss[] = { herr_ge1, NULL };
129 static v_post posts_st[] = { eerr_eq1, post_st, NULL };
130 static v_post posts_text[] = { eerr_ge1, NULL };
131 static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
132 static v_post posts_wtext[] = { ewarn_ge1, NULL };
133 static v_post posts_xr[] = { eerr_ge1, eerr_le2, NULL };
134 static v_pre pres_an[] = { pre_an, NULL };
135 static v_pre pres_bd[] = { pre_display, pre_bd, NULL };
136 static v_pre pres_bl[] = { pre_bl, NULL };
137 static v_pre pres_cd[] = { pre_cd, NULL };
138 static v_pre pres_d1[] = { pre_display, NULL };
139 static v_pre pres_dd[] = { pre_dd, NULL };
140 static v_pre pres_dt[] = { pre_dt, NULL };
141 static v_pre pres_er[] = { pre_er, NULL };
142 static v_pre pres_ex[] = { pre_ex, NULL };
143 static v_pre pres_fd[] = { pre_fd, NULL };
144 static v_pre pres_it[] = { pre_it, NULL };
145 static v_pre pres_lb[] = { pre_lb, NULL };
146 static v_pre pres_os[] = { pre_os, NULL };
147 static v_pre pres_rv[] = { pre_rv, NULL };
148 static v_pre pres_sh[] = { pre_sh, NULL };
149 static v_pre pres_ss[] = { pre_ss, NULL };
151 const struct valids mdoc_valids[MDOC_MAX] = {
152 { NULL, NULL }, /* Ap */
153 { pres_dd, posts_text }, /* Dd */
154 { pres_dt, NULL }, /* Dt */
155 { pres_os, NULL }, /* Os */
156 { pres_sh, posts_sh }, /* Sh */
157 { pres_ss, posts_ss }, /* Ss */
158 { NULL, posts_notext }, /* Pp */
159 { pres_d1, posts_wline }, /* D1 */
160 { pres_d1, posts_wline }, /* Dl */
161 { pres_bd, posts_bd }, /* Bd */
162 { NULL, NULL }, /* Ed */
163 { pres_bl, posts_bl }, /* Bl */
164 { NULL, NULL }, /* El */
165 { pres_it, posts_it }, /* It */
166 { NULL, posts_text }, /* Ad */
167 { pres_an, posts_an }, /* An */
168 { NULL, NULL }, /* Ar */
169 { pres_cd, posts_text }, /* Cd */
170 { NULL, NULL }, /* Cm */
171 { NULL, NULL }, /* Dv */
172 { pres_er, posts_text }, /* Er */
173 { NULL, NULL }, /* Ev */
174 { pres_ex, NULL }, /* Ex */
175 { NULL, NULL }, /* Fa */
176 { pres_fd, posts_wtext }, /* Fd */
177 { NULL, NULL }, /* Fl */
178 { NULL, posts_text }, /* Fn */
179 { NULL, posts_wtext }, /* Ft */
180 { NULL, posts_text }, /* Ic */
181 { NULL, posts_in }, /* In */
182 { NULL, NULL }, /* Li */
183 { NULL, posts_nd }, /* Nd */
184 { NULL, posts_nm }, /* Nm */
185 { NULL, posts_wline }, /* Op */
186 { NULL, NULL }, /* Ot */
187 { NULL, NULL }, /* Pa */
188 { pres_rv, NULL }, /* Rv */
189 { NULL, posts_st }, /* St */
190 { NULL, NULL }, /* Va */
191 { NULL, posts_text }, /* Vt */
192 { NULL, posts_xr }, /* Xr */
193 { NULL, posts_text }, /* %A */
194 { NULL, posts_text }, /* %B */ /* FIXME: can be used outside Rs/Re. */
195 { NULL, posts_text }, /* %D */
196 { NULL, posts_text }, /* %I */
197 { NULL, posts_text }, /* %J */
198 { NULL, posts_text }, /* %N */
199 { NULL, posts_text }, /* %O */
200 { NULL, posts_text }, /* %P */
201 { NULL, posts_text }, /* %R */
202 { NULL, posts_text }, /* %T */ /* FIXME: can be used outside Rs/Re. */
203 { NULL, posts_text }, /* %V */
204 { NULL, NULL }, /* Ac */
205 { NULL, NULL }, /* Ao */
206 { NULL, posts_wline }, /* Aq */
207 { NULL, posts_at }, /* At */
208 { NULL, NULL }, /* Bc */
209 { NULL, posts_bf }, /* Bf */
210 { NULL, NULL }, /* Bo */
211 { NULL, posts_wline }, /* Bq */
212 { NULL, NULL }, /* Bsx */
213 { NULL, NULL }, /* Bx */
214 { NULL, posts_bool }, /* Db */
215 { NULL, NULL }, /* Dc */
216 { NULL, NULL }, /* Do */
217 { NULL, posts_wline }, /* Dq */
218 { NULL, NULL }, /* Ec */
219 { NULL, NULL }, /* Ef */
220 { NULL, NULL }, /* Em */
221 { NULL, NULL }, /* Eo */
222 { NULL, NULL }, /* Fx */
223 { NULL, posts_text }, /* Ms */
224 { NULL, posts_notext }, /* No */
225 { NULL, posts_notext }, /* Ns */
226 { NULL, NULL }, /* Nx */
227 { NULL, NULL }, /* Ox */
228 { NULL, NULL }, /* Pc */
229 { NULL, posts_pf }, /* Pf */
230 { NULL, NULL }, /* Po */
231 { NULL, posts_wline }, /* Pq */
232 { NULL, NULL }, /* Qc */
233 { NULL, posts_wline }, /* Ql */
234 { NULL, NULL }, /* Qo */
235 { NULL, posts_wline }, /* Qq */
236 { NULL, NULL }, /* Re */
237 { NULL, posts_rs }, /* Rs */
238 { NULL, NULL }, /* Sc */
239 { NULL, NULL }, /* So */
240 { NULL, posts_wline }, /* Sq */
241 { NULL, posts_bool }, /* Sm */
242 { NULL, posts_text }, /* Sx */
243 { NULL, posts_text }, /* Sy */
244 { NULL, posts_text }, /* Tn */
245 { NULL, NULL }, /* Ux */
246 { NULL, NULL }, /* Xc */
247 { NULL, NULL }, /* Xo */
248 { NULL, posts_fo }, /* Fo */
249 { NULL, NULL }, /* Fc */
250 { NULL, NULL }, /* Oo */
251 { NULL, NULL }, /* Oc */
252 { NULL, posts_wline }, /* Bk */
253 { NULL, NULL }, /* Ek */
254 { NULL, posts_notext }, /* Bt */
255 { NULL, NULL }, /* Hf */
256 { NULL, NULL }, /* Fr */
257 { NULL, posts_notext }, /* Ud */
258 { pres_lb, posts_lb }, /* Lb */
259 { NULL, posts_notext }, /* Lp */
260 { NULL, NULL }, /* Lk */
261 { NULL, posts_text }, /* Mt */
262 { NULL, posts_wline }, /* Brq */
263 { NULL, NULL }, /* Bro */
264 { NULL, NULL }, /* Brc */
265 { NULL, posts_text }, /* %C */
266 { NULL, NULL }, /* Es */
267 { NULL, NULL }, /* En */
268 { NULL, NULL }, /* Dx */
269 { NULL, posts_text }, /* %Q */
270 { NULL, posts_notext }, /* br */
271 { NULL, posts_sp }, /* sp */
276 mdoc_valid_pre(struct mdoc *mdoc, const struct mdoc_node *n)
282 if (MDOC_TEXT == n->type) {
286 return(check_text(mdoc, line, pos, tp));
289 if ( ! check_args(mdoc, n))
291 if (NULL == mdoc_valids[n->tok].pre)
293 for (p = mdoc_valids[n->tok].pre; *p; p++)
294 if ( ! (*p)(mdoc, n))
301 mdoc_valid_post(struct mdoc *mdoc)
305 if (MDOC_VALID & mdoc->last->flags)
307 mdoc->last->flags |= MDOC_VALID;
309 if (MDOC_TEXT == mdoc->last->type)
311 if (MDOC_ROOT == mdoc->last->type)
312 return(post_root(mdoc));
314 if (NULL == mdoc_valids[mdoc->last->tok].post)
316 for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
325 warn_print(struct mdoc *m, int ln, int pos)
328 if (MDOC_IGN_CHARS & m->pflags)
329 return(mdoc_pwarn(m, ln, pos, EPRINT));
330 return(mdoc_perr(m, ln, pos, EPRINT));
335 warn_count(struct mdoc *m, const char *k,
336 int want, const char *v, int has)
339 return(mdoc_vwarn(m, m->last->line, m->last->pos,
340 "suggests %s %s %d (has %d)", v, k, want, has));
345 err_count(struct mdoc *m, const char *k,
346 int want, const char *v, int has)
349 return(mdoc_verr(m, m->last->line, m->last->pos,
350 "requires %s %s %d (has %d)", v, k, want, has));
355 * Build these up with macros because they're basically the same check
356 * for different inequalities. Yes, this could be done with functions,
357 * but this is reasonable for now.
360 #define CHECK_CHILD_DEFN(lvl, name, ineq) \
362 lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \
364 if (mdoc->last->nchild ineq sz) \
366 return(lvl##_count(mdoc, #ineq, sz, p, mdoc->last->nchild)); \
369 #define CHECK_BODY_DEFN(name, lvl, func, num) \
371 b##lvl##_##name(POST_ARGS) \
373 if (MDOC_BODY != mdoc->last->type) \
375 return(func(mdoc, "multi-line arguments", (num))); \
378 #define CHECK_ELEM_DEFN(name, lvl, func, num) \
380 e##lvl##_##name(POST_ARGS) \
382 assert(MDOC_ELEM == mdoc->last->type); \
383 return(func(mdoc, "line arguments", (num))); \
386 #define CHECK_HEAD_DEFN(name, lvl, func, num) \
388 h##lvl##_##name(POST_ARGS) \
390 if (MDOC_HEAD != mdoc->last->type) \
392 return(func(mdoc, "line arguments", (num))); \
396 CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */
397 CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */
398 CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */
399 CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */
400 CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */
401 CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */
402 CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */
403 CHECK_BODY_DEFN(ge1, err, err_child_gt, 0) /* berr_ge1() */
404 CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_gt1() */
405 CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */
406 CHECK_ELEM_DEFN(le2, err, err_child_lt, 3) /* eerr_le2() */
407 CHECK_ELEM_DEFN(le1, err, err_child_lt, 2) /* eerr_le1() */
408 CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */
409 CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */
410 CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */
411 CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2) /* hwarn_le1() */
412 CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */
413 CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1) /* hwarn_eq1() */
417 check_stdarg(PRE_ARGS)
420 if (n->args && 1 == n->args->argc)
421 if (MDOC_Std == n->args->argv[0].arg)
423 return(mdoc_nwarn(mdoc, n, EARGVAL));
428 check_sec(PRE_ARGS, ...)
437 sec = (enum mdoc_sec)va_arg(ap, int);
438 if (SEC_CUSTOM == sec)
440 if (sec != mdoc->lastsec)
447 return(mdoc_nwarn(mdoc, n, EBADSEC));
452 check_msec(PRE_ARGS, ...)
460 if (0 == (msec = va_arg(ap, int)))
462 if (msec != mdoc->meta.msec)
469 return(mdoc_nwarn(mdoc, n, EBADMSEC));
474 check_args(struct mdoc *m, const struct mdoc_node *n)
481 assert(n->args->argc);
482 for (i = 0; i < (int)n->args->argc; i++)
483 if ( ! check_argv(m, n, &n->args->argv[i]))
491 check_argv(struct mdoc *m, const struct mdoc_node *n,
492 const struct mdoc_argv *v)
496 for (i = 0; i < (int)v->sz; i++)
497 if ( ! check_text(m, v->line, v->pos, v->value[i]))
500 if (MDOC_Std == v->arg) {
501 /* `Nm' name must be set. */
502 if (v->sz || m->meta.name)
504 return(mdoc_nerr(m, n, ENAME));
512 check_text(struct mdoc *mdoc, int line, int pos, const char *p)
516 for ( ; *p; p++, pos++) {
518 if ( ! (MDOC_LITERAL & mdoc->flags))
519 if ( ! warn_print(mdoc, line, pos))
521 } else if ( ! isprint((u_char)*p))
522 if ( ! warn_print(mdoc, line, pos))
528 c = mandoc_special(p);
534 if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags))
535 return(mdoc_perr(mdoc, line, pos, EESCAPE));
536 if ( ! mdoc_pwarn(mdoc, line, pos, EESCAPE))
547 check_parent(PRE_ARGS, int tok, enum mdoc_type t)
551 if ((MDOC_ROOT == t || tok == n->parent->tok) &&
552 (t == n->parent->type))
555 return(mdoc_verr(mdoc, n->line, n->pos, "require parent %s",
556 MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
562 pre_display(PRE_ARGS)
564 struct mdoc_node *node;
566 /* Display elements (`Bd', `D1'...) cannot be nested. */
568 if (MDOC_BLOCK != n->type)
572 for (node = mdoc->last->parent; node; node = node->parent)
573 if (MDOC_BLOCK == node->type)
574 if (MDOC_Bd == node->tok)
579 return(mdoc_nerr(mdoc, n, ENESTDISP));
586 int pos, type, width, offset;
588 if (MDOC_BLOCK != n->type)
591 return(mdoc_nerr(mdoc, n, ELISTTYPE));
593 /* Make sure that only one type of list is specified. */
595 type = offset = width = -1;
598 for (pos = 0; pos < (int)n->args->argc; pos++)
599 switch (n->args->argv[pos].arg) {
622 return(mdoc_nerr(mdoc, n, EMULTILIST));
623 type = n->args->argv[pos].arg;
626 if (type < 0 && ! mdoc_nwarn(mdoc, n, ENOTYPE))
631 return(mdoc_nerr(mdoc, n, EARGREP));
632 if (type < 0 && ! mdoc_nwarn(mdoc, n, ENOTYPE))
634 width = n->args->argv[pos].arg;
638 return(mdoc_nerr(mdoc, n, EARGREP));
639 if (type < 0 && ! mdoc_nwarn(mdoc, n, ENOTYPE))
641 offset = n->args->argv[pos].arg;
648 return(mdoc_nerr(mdoc, n, ELISTTYPE));
651 * Validate the width field. Some list types don't need width
652 * types and should be warned about them. Others should have it
653 * and must also be warned.
658 if (width < 0 && ! mdoc_nwarn(mdoc, n, EMISSWIDTH))
668 if (width >= 0 && ! mdoc_nwarn(mdoc, n, ENOWIDTH))
684 if (MDOC_BLOCK != n->type)
687 return(mdoc_nerr(mdoc, n, EDISPTYPE));
689 /* Make sure that only one type of display is specified. */
692 for (i = 0, err = type = 0; ! err &&
693 i < (int)n->args->argc; i++)
694 switch (n->args->argv[i].arg) {
697 case (MDOC_Unfilled):
704 return(mdoc_nerr(mdoc, n, EMULTIDISP));
711 return(mdoc_nerr(mdoc, n, EDISPTYPE));
719 if (MDOC_BLOCK != n->type)
721 return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
729 if (MDOC_BLOCK != n->type)
731 return(check_parent(mdoc, n, -1, MDOC_ROOT));
739 if (MDOC_BLOCK != n->type)
741 return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
749 if (NULL == n->args || 1 == n->args->argc)
751 return(mdoc_verr(mdoc, n->line, n->pos,
752 "only one argument allowed"));
760 return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM));
768 if ( ! check_msec(mdoc, n, 2, 3, 0))
770 return(check_stdarg(mdoc, n));
778 if ( ! check_msec(mdoc, n, 1, 6, 8, 0))
780 return(check_stdarg(mdoc, n));
788 return(check_msec(mdoc, n, 2, 3, 9, 0));
796 return(check_msec(mdoc, n, 4, 0));
804 if (0 == mdoc->meta.date || mdoc->meta.os)
805 if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
807 if (mdoc->meta.title)
808 if ( ! mdoc_nwarn(mdoc, n, EPROLREP))
818 if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
819 if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
822 if ( ! mdoc_nwarn(mdoc, n, EPROLREP))
832 if (mdoc->meta.title || mdoc->meta.os)
833 if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
836 if ( ! mdoc_nwarn(mdoc, n, EPROLREP))
846 struct mdoc_node *head;
848 if (MDOC_BLOCK != mdoc->last->type)
851 head = mdoc->last->head;
853 if (mdoc->last->args && head->child)
854 return(mdoc_nerr(mdoc, mdoc->last, ELINE));
855 else if (mdoc->last->args)
858 if (NULL == head->child || MDOC_TEXT != head->child->type)
859 return(mdoc_nerr(mdoc, mdoc->last, ELINE));
861 p = head->child->string;
863 if (0 == strcmp(p, "Em"))
865 else if (0 == strcmp(p, "Li"))
867 else if (0 == strcmp(p, "Sy"))
870 return(mdoc_nerr(mdoc, head, EFONT));
878 if (mdoc_a2lib(mdoc->last->child->string))
880 return(mdoc_nwarn(mdoc, mdoc->last, ELIB));
888 if (mdoc->last->child)
892 return(mdoc_nerr(mdoc, mdoc->last, ENAME));
900 if (NULL == mdoc->last->child)
902 if (MDOC_TEXT != mdoc->last->child->type)
903 return(mdoc_nerr(mdoc, mdoc->last, EATT));
904 if (mdoc_a2att(mdoc->last->child->string))
906 return(mdoc_nerr(mdoc, mdoc->last, EATT));
914 if (mdoc->last->args) {
915 if (NULL == mdoc->last->child)
917 return(mdoc_nerr(mdoc, mdoc->last, ENOLINE));
920 if (mdoc->last->child)
922 return(mdoc_nerr(mdoc, mdoc->last, ELINE));
930 struct mdoc_node *n, *c;
932 if (MDOC_BLOCK != mdoc->last->type)
935 n = mdoc->last->parent->parent;
937 return(mdoc_nerr(mdoc, mdoc->last, ELISTTYPE));
939 /* Some types require block-head, some not. */
942 for (cols = type = -1, i = 0; -1 == type &&
943 i < (int)n->args->argc; i++)
944 switch (n->args->argv[i].arg) {
964 type = n->args->argv[i].arg;
967 type = n->args->argv[i].arg;
968 cols = (int)n->args->argv[i].sz;
975 return(mdoc_nerr(mdoc, mdoc->last, ELISTTYPE));
979 if (NULL == mdoc->last->head->child)
980 if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
990 if (NULL == mdoc->last->head->child)
991 if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
993 if (NULL == mdoc->last->body->child)
994 if ( ! mdoc_nwarn(mdoc, mdoc->last, EMULTILINE))
1006 if (mdoc->last->head->child)
1007 if ( ! mdoc_nwarn(mdoc, mdoc->last, ENOLINE))
1009 if (NULL == mdoc->last->body->child)
1010 if ( ! mdoc_nwarn(mdoc, mdoc->last, EMULTILINE))
1014 if (NULL == mdoc->last->head->child)
1015 if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
1017 if (mdoc->last->body->child)
1018 if ( ! mdoc_nwarn(mdoc, mdoc->last, ENOMULTILINE))
1020 c = mdoc->last->child;
1021 for (i = 0; c && MDOC_HEAD == c->type; c = c->next)
1024 if (i < cols || i == (cols + 1)) {
1025 if ( ! mdoc_vwarn(mdoc, mdoc->last->line,
1026 mdoc->last->pos, "column "
1027 "mismatch: have %d, want %d",
1031 } else if (i == cols)
1034 return(mdoc_verr(mdoc, mdoc->last->line,
1035 mdoc->last->pos, "column mismatch: "
1036 "have %d, want %d", i, cols));
1046 post_bl_head(POST_ARGS)
1049 const struct mdoc_node *n;
1051 n = mdoc->last->parent;
1054 for (i = 0; i < (int)n->args->argc; i++)
1055 if (n->args->argv[i].arg == MDOC_Column)
1058 if (i == (int)n->args->argc)
1061 if (n->args->argv[i].sz && mdoc->last->child)
1062 return(mdoc_nerr(mdoc, n, ECOLMIS));
1071 struct mdoc_node *n;
1073 if (MDOC_HEAD == mdoc->last->type)
1074 return(post_bl_head(mdoc));
1075 if (MDOC_BODY != mdoc->last->type)
1077 if (NULL == mdoc->last->child)
1081 for (n = mdoc->last->child; n; n = n->next) {
1082 if (MDOC_BLOCK == n->type)
1083 if (MDOC_It == n->tok)
1085 return(mdoc_nerr(mdoc, n, EBADCHILD));
1093 ebool(struct mdoc *mdoc)
1095 struct mdoc_node *n;
1098 for (n = mdoc->last->child; n; n = n->next) {
1099 if (MDOC_TEXT != n->type)
1101 if (0 == strcmp(n->string, "on"))
1103 if (0 == strcmp(n->string, "off"))
1110 return(mdoc_nerr(mdoc, n, EBOOL));
1115 post_root(POST_ARGS)
1118 if (NULL == mdoc->first->child)
1119 return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1120 if ( ! (MDOC_PBODY & mdoc->flags))
1121 return(mdoc_nerr(mdoc, mdoc->first, ENOPROLOGUE));
1123 if (MDOC_BLOCK != mdoc->first->child->type)
1124 return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1125 if (MDOC_Sh != mdoc->first->child->tok)
1126 return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1136 if (mdoc_a2st(mdoc->last->child->string))
1138 return(mdoc_nerr(mdoc, mdoc->last, EBADSTAND));
1145 struct mdoc_node *nn;
1147 if (MDOC_BODY != mdoc->last->type)
1150 for (nn = mdoc->last->child; nn; nn = nn->next)
1179 return(mdoc_nerr(mdoc, nn, EBADCHILD));
1190 if (MDOC_HEAD == mdoc->last->type)
1191 return(post_sh_head(mdoc));
1192 if (MDOC_BODY == mdoc->last->type)
1193 return(post_sh_body(mdoc));
1200 post_sh_body(POST_ARGS)
1202 struct mdoc_node *n;
1204 if (SEC_NAME != mdoc->lastsec)
1208 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1209 * macros (can have multiple `Nm' and one `Nd'). Note that the
1210 * children of the BODY declaration can also be "text".
1213 if (NULL == (n = mdoc->last->child))
1214 return(mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC));
1216 for ( ; n && n->next; n = n->next) {
1217 if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1219 if (MDOC_TEXT == n->type)
1221 if ( ! mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC))
1226 if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
1228 return(mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC));
1233 post_sh_head(POST_ARGS)
1237 const struct mdoc_node *n;
1240 * Process a new section. Sections are either "named" or
1241 * "custom"; custom sections are user-defined, while named ones
1242 * usually follow a conventional order and may only appear in
1243 * certain manual sections.
1248 for (n = mdoc->last->child; n; n = n->next) {
1249 /* XXX - copied from compact(). */
1250 assert(MDOC_TEXT == n->type);
1252 if (strlcat(buf, n->string, 64) >= 64)
1253 return(mdoc_nerr(mdoc, n, ETOOLONG));
1254 if (NULL == n->next)
1256 if (strlcat(buf, " ", 64) >= 64)
1257 return(mdoc_nerr(mdoc, n, ETOOLONG));
1260 sec = mdoc_atosec(buf);
1263 * Check: NAME should always be first, CUSTOM has no roles,
1264 * non-CUSTOM has a conventional order to be followed.
1267 if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
1268 return(mdoc_nerr(mdoc, mdoc->last, ESECNAME));
1269 if (SEC_CUSTOM == sec)
1271 if (sec == mdoc->lastnamed)
1272 if ( ! mdoc_nwarn(mdoc, mdoc->last, ESECREP))
1274 if (sec < mdoc->lastnamed)
1275 if ( ! mdoc_nwarn(mdoc, mdoc->last, ESECOOO))
1279 * Check particular section/manual conventions. LIBRARY can
1280 * only occur in msec 2, 3 (TODO: are there more of these?).
1285 switch (mdoc->meta.msec) {
1291 return(mdoc_nwarn(mdoc, mdoc->last, EWRONGMSEC));
1306 return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM));