]> git.cameronkatri.com Git - mandoc.git/blob - mdoc_validate.c
Added enum mdoc_disp (similar to enum mdoc_list). Display types are now
[mandoc.git] / mdoc_validate.c
1 /* $Id: mdoc_validate.c,v 1.93 2010/06/12 10:09:19 kristaps Exp $ */
2 /*
3 * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
4 *
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.
8 *
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.
16 */
17 #ifdef HAVE_CONFIG_H
18 #include "config.h"
19 #endif
20
21 #include <sys/types.h>
22
23 #include <assert.h>
24 #include <ctype.h>
25 #include <limits.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29
30 #include "mandoc.h"
31 #include "libmdoc.h"
32 #include "libmandoc.h"
33
34 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
35 /* TODO: ignoring Pp (it's superfluous in some invocations). */
36
37 #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n
38 #define POST_ARGS struct mdoc *mdoc
39
40 typedef int (*v_pre)(PRE_ARGS);
41 typedef int (*v_post)(POST_ARGS);
42
43 struct valids {
44 v_pre *pre;
45 v_post *post;
46 };
47
48 static int check_parent(PRE_ARGS, enum mdoct, enum mdoc_type);
49 static int check_stdarg(PRE_ARGS);
50 static int check_text(struct mdoc *, int, int, char *);
51 static int check_argv(struct mdoc *,
52 struct mdoc_node *, struct mdoc_argv *);
53 static int check_args(struct mdoc *, 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_count(struct mdoc *, const char *,
61 int, const char *, int);
62 static int err_count(struct mdoc *, const char *,
63 int, const char *, int);
64
65 static int berr_ge1(POST_ARGS);
66 static int bwarn_ge1(POST_ARGS);
67 static int ebool(POST_ARGS);
68 static int eerr_eq0(POST_ARGS);
69 static int eerr_eq1(POST_ARGS);
70 static int eerr_ge1(POST_ARGS);
71 static int eerr_le1(POST_ARGS);
72 static int ewarn_ge1(POST_ARGS);
73 static int herr_eq0(POST_ARGS);
74 static int herr_ge1(POST_ARGS);
75 static int hwarn_eq1(POST_ARGS);
76 static int hwarn_eq0(POST_ARGS);
77 static int hwarn_le1(POST_ARGS);
78
79 static int post_an(POST_ARGS);
80 static int post_at(POST_ARGS);
81 static int post_bf(POST_ARGS);
82 static int post_bl(POST_ARGS);
83 static int post_bl_head(POST_ARGS);
84 static int post_dt(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 post_eoln(POST_ARGS);
95 static int post_vt(POST_ARGS);
96 static int pre_an(PRE_ARGS);
97 static int pre_bd(PRE_ARGS);
98 static int pre_bl(PRE_ARGS);
99 static int pre_dd(PRE_ARGS);
100 static int pre_display(PRE_ARGS);
101 static int pre_dt(PRE_ARGS);
102 static int pre_it(PRE_ARGS);
103 static int pre_os(PRE_ARGS);
104 static int pre_rv(PRE_ARGS);
105 static int pre_sh(PRE_ARGS);
106 static int pre_ss(PRE_ARGS);
107
108 static v_post posts_an[] = { post_an, NULL };
109 static v_post posts_at[] = { post_at, NULL };
110 static v_post posts_bd[] = { 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[] = { eerr_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, NULL };
134 static v_pre pres_bl[] = { pre_bl, 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_rv[] = { pre_rv, NULL };
144 static v_pre pres_sh[] = { pre_sh, NULL };
145 static v_pre pres_ss[] = { pre_ss, NULL };
146
147 const struct valids mdoc_valids[MDOC_MAX] = {
148 { NULL, NULL }, /* Ap */
149 { pres_dd, posts_text }, /* Dd */
150 { pres_dt, posts_dt }, /* Dt */
151 { pres_os, NULL }, /* Os */
152 { pres_sh, posts_sh }, /* Sh */
153 { pres_ss, posts_ss }, /* Ss */
154 { NULL, posts_notext }, /* Pp */
155 { pres_d1, posts_wline }, /* D1 */
156 { pres_d1, posts_wline }, /* Dl */
157 { pres_bd, posts_bd }, /* Bd */
158 { NULL, NULL }, /* Ed */
159 { pres_bl, posts_bl }, /* Bl */
160 { NULL, NULL }, /* El */
161 { pres_it, posts_it }, /* It */
162 { NULL, posts_text }, /* Ad */
163 { pres_an, posts_an }, /* An */
164 { NULL, NULL }, /* Ar */
165 { NULL, posts_text }, /* Cd */
166 { NULL, NULL }, /* Cm */
167 { NULL, NULL }, /* Dv */
168 { pres_er, posts_text }, /* Er */
169 { NULL, NULL }, /* Ev */
170 { pres_ex, NULL }, /* Ex */
171 { NULL, NULL }, /* Fa */
172 { pres_fd, posts_wtext }, /* Fd */
173 { NULL, NULL }, /* Fl */
174 { NULL, posts_text }, /* Fn */
175 { NULL, posts_wtext }, /* Ft */
176 { NULL, posts_text }, /* Ic */
177 { NULL, posts_text1 }, /* In */
178 { NULL, NULL }, /* Li */
179 { NULL, posts_nd }, /* Nd */
180 { NULL, posts_nm }, /* Nm */
181 { NULL, posts_wline }, /* Op */
182 { NULL, NULL }, /* Ot */
183 { NULL, NULL }, /* Pa */
184 { pres_rv, NULL }, /* Rv */
185 { NULL, posts_st }, /* St */
186 { NULL, NULL }, /* Va */
187 { NULL, posts_vt }, /* Vt */
188 { NULL, posts_wtext }, /* Xr */
189 { NULL, posts_text }, /* %A */
190 { NULL, posts_text }, /* %B */ /* FIXME: can be used outside Rs/Re. */
191 { NULL, posts_text }, /* %D */ /* FIXME: check date with mandoc_a2time(). */
192 { NULL, posts_text }, /* %I */
193 { NULL, posts_text }, /* %J */
194 { NULL, posts_text }, /* %N */
195 { NULL, posts_text }, /* %O */
196 { NULL, posts_text }, /* %P */
197 { NULL, posts_text }, /* %R */
198 { NULL, posts_text }, /* %T */ /* FIXME: can be used outside Rs/Re. */
199 { NULL, posts_text }, /* %V */
200 { NULL, NULL }, /* Ac */
201 { NULL, NULL }, /* Ao */
202 { NULL, posts_wline }, /* Aq */
203 { NULL, posts_at }, /* At */
204 { NULL, NULL }, /* Bc */
205 { NULL, posts_bf }, /* Bf */
206 { NULL, NULL }, /* Bo */
207 { NULL, posts_wline }, /* Bq */
208 { NULL, NULL }, /* Bsx */
209 { NULL, NULL }, /* Bx */
210 { NULL, posts_bool }, /* Db */
211 { NULL, NULL }, /* Dc */
212 { NULL, NULL }, /* Do */
213 { NULL, posts_wline }, /* Dq */
214 { NULL, NULL }, /* Ec */
215 { NULL, NULL }, /* Ef */
216 { NULL, NULL }, /* Em */
217 { NULL, NULL }, /* Eo */
218 { NULL, NULL }, /* Fx */
219 { NULL, posts_text }, /* Ms */
220 { NULL, posts_notext }, /* No */
221 { NULL, posts_notext }, /* Ns */
222 { NULL, NULL }, /* Nx */
223 { NULL, NULL }, /* Ox */
224 { NULL, NULL }, /* Pc */
225 { NULL, posts_text1 }, /* Pf */
226 { NULL, NULL }, /* Po */
227 { NULL, posts_wline }, /* Pq */
228 { NULL, NULL }, /* Qc */
229 { NULL, posts_wline }, /* Ql */
230 { NULL, NULL }, /* Qo */
231 { NULL, posts_wline }, /* Qq */
232 { NULL, NULL }, /* Re */
233 { NULL, posts_rs }, /* Rs */
234 { NULL, NULL }, /* Sc */
235 { NULL, NULL }, /* So */
236 { NULL, posts_wline }, /* Sq */
237 { NULL, posts_bool }, /* Sm */
238 { NULL, posts_text }, /* Sx */
239 { NULL, posts_text }, /* Sy */
240 { NULL, posts_text }, /* Tn */
241 { NULL, NULL }, /* Ux */
242 { NULL, NULL }, /* Xc */
243 { NULL, NULL }, /* Xo */
244 { NULL, posts_fo }, /* Fo */
245 { NULL, NULL }, /* Fc */
246 { NULL, NULL }, /* Oo */
247 { NULL, NULL }, /* Oc */
248 { NULL, posts_wline }, /* Bk */
249 { NULL, NULL }, /* Ek */
250 { NULL, posts_eoln }, /* Bt */
251 { NULL, NULL }, /* Hf */
252 { NULL, NULL }, /* Fr */
253 { NULL, posts_eoln }, /* Ud */
254 { NULL, posts_lb }, /* Lb */
255 { NULL, posts_notext }, /* Lp */
256 { NULL, posts_text }, /* Lk */
257 { NULL, posts_text }, /* Mt */
258 { NULL, posts_wline }, /* Brq */
259 { NULL, NULL }, /* Bro */
260 { NULL, NULL }, /* Brc */
261 { NULL, posts_text }, /* %C */
262 { NULL, NULL }, /* Es */
263 { NULL, NULL }, /* En */
264 { NULL, NULL }, /* Dx */
265 { NULL, posts_text }, /* %Q */
266 { NULL, posts_notext }, /* br */
267 { NULL, posts_sp }, /* sp */
268 { NULL, posts_text1 }, /* %U */
269 { NULL, NULL }, /* Ta */
270 };
271
272
273 int
274 mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n)
275 {
276 v_pre *p;
277 int line, pos;
278 char *tp;
279
280 if (MDOC_TEXT == n->type) {
281 tp = n->string;
282 line = n->line;
283 pos = n->pos;
284 return(check_text(mdoc, line, pos, tp));
285 }
286
287 if ( ! check_args(mdoc, n))
288 return(0);
289 if (NULL == mdoc_valids[n->tok].pre)
290 return(1);
291 for (p = mdoc_valids[n->tok].pre; *p; p++)
292 if ( ! (*p)(mdoc, n))
293 return(0);
294 return(1);
295 }
296
297
298 int
299 mdoc_valid_post(struct mdoc *mdoc)
300 {
301 v_post *p;
302
303 if (MDOC_VALID & mdoc->last->flags)
304 return(1);
305 mdoc->last->flags |= MDOC_VALID;
306
307 if (MDOC_TEXT == mdoc->last->type)
308 return(1);
309 if (MDOC_ROOT == mdoc->last->type)
310 return(post_root(mdoc));
311
312 if (NULL == mdoc_valids[mdoc->last->tok].post)
313 return(1);
314 for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
315 if ( ! (*p)(mdoc))
316 return(0);
317
318 return(1);
319 }
320
321
322 static inline int
323 warn_count(struct mdoc *m, const char *k,
324 int want, const char *v, int has)
325 {
326
327 return(mdoc_vmsg(m, MANDOCERR_ARGCOUNT,
328 m->last->line, m->last->pos,
329 "%s %s %d (have %d)", v, k, want, has));
330 }
331
332
333 static inline int
334 err_count(struct mdoc *m, const char *k,
335 int want, const char *v, int has)
336 {
337
338 mdoc_vmsg(m, MANDOCERR_SYNTARGCOUNT,
339 m->last->line, m->last->pos,
340 "%s %s %d (have %d)",
341 v, k, want, has);
342 return(0);
343 }
344
345
346 /*
347 * Build these up with macros because they're basically the same check
348 * for different inequalities. Yes, this could be done with functions,
349 * but this is reasonable for now.
350 */
351
352 #define CHECK_CHILD_DEFN(lvl, name, ineq) \
353 static int \
354 lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \
355 { \
356 if (mdoc->last->nchild ineq sz) \
357 return(1); \
358 return(lvl##_count(mdoc, #ineq, sz, p, mdoc->last->nchild)); \
359 }
360
361 #define CHECK_BODY_DEFN(name, lvl, func, num) \
362 static int \
363 b##lvl##_##name(POST_ARGS) \
364 { \
365 if (MDOC_BODY != mdoc->last->type) \
366 return(1); \
367 return(func(mdoc, "multi-line arguments", (num))); \
368 }
369
370 #define CHECK_ELEM_DEFN(name, lvl, func, num) \
371 static int \
372 e##lvl##_##name(POST_ARGS) \
373 { \
374 assert(MDOC_ELEM == mdoc->last->type); \
375 return(func(mdoc, "line arguments", (num))); \
376 }
377
378 #define CHECK_HEAD_DEFN(name, lvl, func, num) \
379 static int \
380 h##lvl##_##name(POST_ARGS) \
381 { \
382 if (MDOC_HEAD != mdoc->last->type) \
383 return(1); \
384 return(func(mdoc, "line arguments", (num))); \
385 }
386
387
388 CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */
389 CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */
390 CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */
391 CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */
392 CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */
393 CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */
394 CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */
395 CHECK_BODY_DEFN(ge1, err, err_child_gt, 0) /* berr_ge1() */
396 CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_ge1() */
397 CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */
398 CHECK_ELEM_DEFN(le1, err, err_child_lt, 2) /* eerr_le1() */
399 CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */
400 CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */
401 CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */
402 CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2) /* hwarn_le1() */
403 CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */
404 CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1) /* hwarn_eq1() */
405 CHECK_HEAD_DEFN(eq0, warn, warn_child_eq, 0) /* hwarn_eq0() */
406
407
408 static int
409 check_stdarg(PRE_ARGS)
410 {
411
412 if (n->args && 1 == n->args->argc)
413 if (MDOC_Std == n->args->argv[0].arg)
414 return(1);
415 return(mdoc_nmsg(mdoc, n, MANDOCERR_NOARGV));
416 }
417
418
419 static int
420 check_args(struct mdoc *m, struct mdoc_node *n)
421 {
422 int i;
423
424 if (NULL == n->args)
425 return(1);
426
427 assert(n->args->argc);
428 for (i = 0; i < (int)n->args->argc; i++)
429 if ( ! check_argv(m, n, &n->args->argv[i]))
430 return(0);
431
432 return(1);
433 }
434
435
436 static int
437 check_argv(struct mdoc *m, struct mdoc_node *n, struct mdoc_argv *v)
438 {
439 int i;
440
441 for (i = 0; i < (int)v->sz; i++)
442 if ( ! check_text(m, v->line, v->pos, v->value[i]))
443 return(0);
444
445 if (MDOC_Std == v->arg) {
446 if (v->sz || m->meta.name)
447 return(1);
448 if ( ! mdoc_nmsg(m, n, MANDOCERR_NONAME))
449 return(0);
450 }
451
452 return(1);
453 }
454
455
456 static int
457 check_text(struct mdoc *mdoc, int line, int pos, char *p)
458 {
459 int c;
460
461 for ( ; *p; p++, pos++) {
462 if ('\t' == *p) {
463 if ( ! (MDOC_LITERAL & mdoc->flags))
464 if ( ! mdoc_pmsg(mdoc, line, pos, MANDOCERR_BADCHAR))
465 return(0);
466 } else if ( ! isprint((u_char)*p) && ASCII_HYPH != *p)
467 if ( ! mdoc_pmsg(mdoc, line, pos, MANDOCERR_BADCHAR))
468 return(0);
469
470 if ('\\' != *p)
471 continue;
472
473 c = mandoc_special(p);
474 if (c) {
475 p += c - 1;
476 pos += c - 1;
477 continue;
478 }
479
480 c = mdoc_pmsg(mdoc, line, pos, MANDOCERR_BADESCAPE);
481 if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags) && ! c)
482 return(c);
483 }
484
485 return(1);
486 }
487
488
489
490
491 static int
492 check_parent(PRE_ARGS, enum mdoct tok, enum mdoc_type t)
493 {
494
495 assert(n->parent);
496 if ((MDOC_ROOT == t || tok == n->parent->tok) &&
497 (t == n->parent->type))
498 return(1);
499
500 mdoc_vmsg(mdoc, MANDOCERR_SYNTCHILD,
501 n->line, n->pos, "want parent %s",
502 MDOC_ROOT == t ? "<root>" :
503 mdoc_macronames[tok]);
504 return(0);
505 }
506
507
508
509 static int
510 pre_display(PRE_ARGS)
511 {
512 struct mdoc_node *node;
513
514 /* Display elements (`Bd', `D1'...) cannot be nested. */
515
516 if (MDOC_BLOCK != n->type)
517 return(1);
518
519 /* LINTED */
520 for (node = mdoc->last->parent; node; node = node->parent)
521 if (MDOC_BLOCK == node->type)
522 if (MDOC_Bd == node->tok)
523 break;
524 if (NULL == node)
525 return(1);
526
527 mdoc_nmsg(mdoc, n, MANDOCERR_NESTEDDISP);
528 return(0);
529 }
530
531
532 static int
533 pre_bl(PRE_ARGS)
534 {
535 int i, width, offs, cmpt, dupl;
536 enum mdoc_list lt;
537
538 if (MDOC_BLOCK != n->type) {
539 assert(n->parent);
540 assert(MDOC_BLOCK == n->parent->type);
541 assert(MDOC_Bl == n->parent->tok);
542 assert(LIST__NONE != n->parent->data.list);
543 n->data.list = n->parent->data.list;
544 return(1);
545 }
546
547 /*
548 * First figure out which kind of list to use: bind ourselves to
549 * the first mentioned list type and warn about any remaining
550 * ones. If we find no list type, we default to LIST_item.
551 */
552
553 assert(LIST__NONE == n->data.list);
554 offs = width = cmpt = -1;
555
556 /* LINTED */
557 for (i = 0; n->args && i < (int)n->args->argc; i++) {
558 lt = LIST__NONE;
559 dupl = 0;
560 switch (n->args->argv[i].arg) {
561 /* Set list types. */
562 case (MDOC_Bullet):
563 lt = LIST_bullet;
564 break;
565 case (MDOC_Dash):
566 lt = LIST_dash;
567 break;
568 case (MDOC_Enum):
569 lt = LIST_enum;
570 break;
571 case (MDOC_Hyphen):
572 lt = LIST_hyphen;
573 break;
574 case (MDOC_Item):
575 lt = LIST_item;
576 break;
577 case (MDOC_Tag):
578 lt = LIST_tag;
579 break;
580 case (MDOC_Diag):
581 lt = LIST_diag;
582 break;
583 case (MDOC_Hang):
584 lt = LIST_hang;
585 break;
586 case (MDOC_Ohang):
587 lt = LIST_ohang;
588 break;
589 case (MDOC_Inset):
590 lt = LIST_inset;
591 break;
592 case (MDOC_Column):
593 lt = LIST_column;
594 break;
595 /* Set list arguments. */
596 case (MDOC_Compact):
597 if (cmpt >= 0)
598 dupl++;
599 cmpt = i;
600 break;
601 case (MDOC_Width):
602 if (width >= 0)
603 dupl++;
604 width = i;
605 break;
606 case (MDOC_Offset):
607 if (offs >= 0)
608 dupl++;
609 offs = i;
610 break;
611 }
612
613 /* Check: duplicate auxiliary arguments. */
614
615 if (dupl)
616 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP))
617 return(0);
618
619 /* Check: multiple list types. */
620
621 if (LIST__NONE != lt && n->data.list != LIST__NONE)
622 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP))
623 return(0);
624
625 /* Assign list type. */
626
627 if (LIST__NONE != lt && n->data.list == LIST__NONE)
628 n->data.list = lt;
629
630 /* The list type should come first. */
631
632 if (n->data.list == LIST__NONE)
633 if (width >= 0 || offs >= 0 || cmpt >= 0)
634 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST))
635 return(0);
636
637 continue;
638 }
639
640 /* Allow lists to default to LIST_item. */
641
642 if (LIST__NONE == n->data.list) {
643 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE))
644 return(0);
645 n->data.list = LIST_item;
646 }
647
648 /*
649 * Validate the width field. Some list types don't need width
650 * types and should be warned about them. Others should have it
651 * and must also be warned.
652 */
653
654 switch (n->data.list) {
655 case (LIST_tag):
656 if (width >= 0)
657 break;
658 if (mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG))
659 break;
660 return(0);
661 case (LIST_column):
662 /* FALLTHROUGH */
663 case (LIST_diag):
664 /* FALLTHROUGH */
665 case (LIST_ohang):
666 /* FALLTHROUGH */
667 case (LIST_inset):
668 /* FALLTHROUGH */
669 case (LIST_item):
670 if (width < 0)
671 break;
672 if (mdoc_nmsg(mdoc, n, MANDOCERR_WIDTHARG))
673 break;
674 return(0);
675 default:
676 break;
677 }
678
679 return(1);
680 }
681
682
683 static int
684 pre_bd(PRE_ARGS)
685 {
686 int i;
687 enum mdoc_disp dt;
688
689 if (MDOC_BLOCK != n->type) {
690 assert(n->parent);
691 assert(MDOC_BLOCK == n->parent->type);
692 assert(MDOC_Bd == n->parent->tok);
693 assert(DISP__NONE != n->parent->data.disp);
694 n->data.disp = n->parent->data.disp;
695 return(1);
696 }
697
698 assert(DISP__NONE == n->data.disp);
699
700 /* LINTED */
701 for (i = 0; n->args && i < (int)n->args->argc; i++) {
702 dt = DISP__NONE;
703 switch (n->args->argv[i].arg) {
704 case (MDOC_Centred):
705 dt = DISP_centred;
706 break;
707 case (MDOC_Ragged):
708 dt = DISP_ragged;
709 break;
710 case (MDOC_Unfilled):
711 dt = DISP_unfilled;
712 break;
713 case (MDOC_Filled):
714 dt = DISP_filled;
715 break;
716 case (MDOC_Literal):
717 dt = DISP_literal;
718 break;
719 case (MDOC_File):
720 mdoc_nmsg(mdoc, n, MANDOCERR_BADDISP);
721 return(0);
722 case (MDOC_Offset):
723 /* FALLTHROUGH */
724 case (MDOC_Compact):
725 /* FALLTHROUGH */
726 default:
727 break;
728 }
729
730 if (DISP__NONE != dt && n->data.disp != DISP__NONE)
731 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP))
732 return(0);
733
734 if (DISP__NONE != dt && n->data.disp == DISP__NONE)
735 n->data.disp = dt;
736 }
737
738 if (DISP__NONE == n->data.disp) {
739 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE))
740 return(0);
741 n->data.disp = DISP_ragged;
742 }
743
744 return(1);
745 }
746
747
748 static int
749 pre_ss(PRE_ARGS)
750 {
751
752 if (MDOC_BLOCK != n->type)
753 return(1);
754 return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
755 }
756
757
758 static int
759 pre_sh(PRE_ARGS)
760 {
761
762 if (MDOC_BLOCK != n->type)
763 return(1);
764 return(check_parent(mdoc, n, MDOC_MAX, MDOC_ROOT));
765 }
766
767
768 static int
769 pre_it(PRE_ARGS)
770 {
771
772 if (MDOC_BLOCK != n->type)
773 return(1);
774 /*
775 * FIXME: this can probably be lifted if we make the It into
776 * something else on-the-fly?
777 */
778 return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
779 }
780
781
782 static int
783 pre_an(PRE_ARGS)
784 {
785
786 if (NULL == n->args || 1 == n->args->argc)
787 return(1);
788 mdoc_vmsg(mdoc, MANDOCERR_SYNTARGCOUNT,
789 n->line, n->pos,
790 "line arguments == 1 (have %d)",
791 n->args->argc);
792 return(0);
793 }
794
795
796 static int
797 pre_rv(PRE_ARGS)
798 {
799
800 return(check_stdarg(mdoc, n));
801 }
802
803
804 static int
805 post_dt(POST_ARGS)
806 {
807 const struct mdoc_node *nn;
808 const char *p;
809
810 if (NULL != (nn = mdoc->last->child))
811 for (p = nn->string; *p; p++) {
812 if (toupper((u_char)*p) == *p)
813 continue;
814 if ( ! mdoc_nmsg(mdoc, nn, MANDOCERR_UPPERCASE))
815 return(0);
816 break;
817 }
818
819 return(1);
820 }
821
822
823 static int
824 pre_dt(PRE_ARGS)
825 {
826
827 if (0 == mdoc->meta.date || mdoc->meta.os)
828 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO))
829 return(0);
830 if (mdoc->meta.title)
831 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP))
832 return(0);
833 return(1);
834 }
835
836
837 static int
838 pre_os(PRE_ARGS)
839 {
840
841 if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
842 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO))
843 return(0);
844 if (mdoc->meta.os)
845 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP))
846 return(0);
847 return(1);
848 }
849
850
851 static int
852 pre_dd(PRE_ARGS)
853 {
854
855 if (mdoc->meta.title || mdoc->meta.os)
856 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO))
857 return(0);
858 if (mdoc->meta.date)
859 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP))
860 return(0);
861 return(1);
862 }
863
864
865 static int
866 post_bf(POST_ARGS)
867 {
868 char *p;
869 struct mdoc_node *head;
870
871 if (MDOC_BLOCK != mdoc->last->type)
872 return(1);
873
874 head = mdoc->last->head;
875
876 if (mdoc->last->args && head->child) {
877 /* FIXME: this should provide a default. */
878 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SYNTARGVCOUNT);
879 return(0);
880 } else if (mdoc->last->args)
881 return(1);
882
883 if (NULL == head->child || MDOC_TEXT != head->child->type) {
884 /* FIXME: this should provide a default. */
885 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SYNTARGVCOUNT);
886 return(0);
887 }
888
889 p = head->child->string;
890
891 if (0 == strcmp(p, "Em"))
892 return(1);
893 else if (0 == strcmp(p, "Li"))
894 return(1);
895 else if (0 == strcmp(p, "Sy"))
896 return(1);
897
898 mdoc_nmsg(mdoc, head, MANDOCERR_FONTTYPE);
899 return(0);
900 }
901
902
903 static int
904 post_lb(POST_ARGS)
905 {
906
907 if (mdoc_a2lib(mdoc->last->child->string))
908 return(1);
909 return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADLIB));
910 }
911
912
913 static int
914 post_eoln(POST_ARGS)
915 {
916
917 if (NULL == mdoc->last->child)
918 return(1);
919 return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST));
920 }
921
922
923 static int
924 post_vt(POST_ARGS)
925 {
926 const struct mdoc_node *n;
927
928 /*
929 * The Vt macro comes in both ELEM and BLOCK form, both of which
930 * have different syntaxes (yet more context-sensitive
931 * behaviour). ELEM types must have a child; BLOCK types,
932 * specifically the BODY, should only have TEXT children.
933 */
934
935 if (MDOC_ELEM == mdoc->last->type)
936 return(eerr_ge1(mdoc));
937 if (MDOC_BODY != mdoc->last->type)
938 return(1);
939
940 for (n = mdoc->last->child; n; n = n->next)
941 if (MDOC_TEXT != n->type)
942 if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_CHILD))
943 return(0);
944
945 return(1);
946 }
947
948
949 static int
950 post_nm(POST_ARGS)
951 {
952
953 if (mdoc->last->child)
954 return(1);
955 if (mdoc->meta.name)
956 return(1);
957 return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME));
958 }
959
960
961 static int
962 post_at(POST_ARGS)
963 {
964
965 if (NULL == mdoc->last->child)
966 return(1);
967 assert(MDOC_TEXT == mdoc->last->child->type);
968 if (mdoc_a2att(mdoc->last->child->string))
969 return(1);
970 return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADATT));
971 }
972
973
974 static int
975 post_an(POST_ARGS)
976 {
977
978 if (mdoc->last->args) {
979 if (NULL == mdoc->last->child)
980 return(1);
981 return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGCOUNT));
982 }
983
984 if (mdoc->last->child)
985 return(1);
986 return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS));
987 }
988
989
990 static int
991 post_it(POST_ARGS)
992 {
993 int i, cols, rc;
994 enum mdoc_list lt;
995 struct mdoc_node *n, *c;
996 enum mandocerr er;
997
998 if (MDOC_BLOCK != mdoc->last->type)
999 return(1);
1000
1001 n = mdoc->last->parent->parent;
1002 lt = n->data.list;
1003
1004 if (LIST__NONE == lt) {
1005 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE);
1006 return(0);
1007 }
1008
1009 switch (lt) {
1010 case (LIST_tag):
1011 if (mdoc->last->head->child)
1012 break;
1013 /* FIXME: give this a dummy value. */
1014 if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS))
1015 return(0);
1016 break;
1017 case (LIST_hang):
1018 /* FALLTHROUGH */
1019 case (LIST_ohang):
1020 /* FALLTHROUGH */
1021 case (LIST_inset):
1022 /* FALLTHROUGH */
1023 case (LIST_diag):
1024 if (NULL == mdoc->last->head->child)
1025 if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS))
1026 return(0);
1027 if (NULL == mdoc->last->body->child)
1028 if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY))
1029 return(0);
1030 break;
1031 case (LIST_bullet):
1032 /* FALLTHROUGH */
1033 case (LIST_dash):
1034 /* FALLTHROUGH */
1035 case (LIST_enum):
1036 /* FALLTHROUGH */
1037 case (LIST_hyphen):
1038 /* FALLTHROUGH */
1039 case (LIST_item):
1040 if (mdoc->last->head->child)
1041 if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST))
1042 return(0);
1043 if (NULL == mdoc->last->body->child)
1044 if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY))
1045 return(0);
1046 break;
1047 case (LIST_column):
1048 cols = -1;
1049 for (i = 0; i < (int)n->args->argc; i++)
1050 if (MDOC_Column == n->args->argv[i].arg) {
1051 cols = (int)n->args->argv[i].sz;
1052 break;
1053 }
1054
1055 assert(-1 != cols);
1056 assert(NULL == mdoc->last->head->child);
1057
1058 if (NULL == mdoc->last->body->child)
1059 if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY))
1060 return(0);
1061
1062 for (i = 0, c = mdoc->last->child; c; c = c->next)
1063 if (MDOC_BODY == c->type)
1064 i++;
1065
1066 if (i < cols)
1067 er = MANDOCERR_ARGCOUNT;
1068 else if (i == cols || i == cols + 1)
1069 break;
1070 else
1071 er = MANDOCERR_SYNTARGCOUNT;
1072
1073 rc = mdoc_vmsg(mdoc, er,
1074 mdoc->last->line, mdoc->last->pos,
1075 "columns == %d (have %d)", cols, i);
1076 return(rc);
1077 default:
1078 break;
1079 }
1080
1081 return(1);
1082 }
1083
1084
1085 static int
1086 post_bl_head(POST_ARGS)
1087 {
1088 int i;
1089 struct mdoc_node *n;
1090
1091 assert(mdoc->last->parent);
1092 n = mdoc->last->parent;
1093
1094 if (LIST_column == n->data.list) {
1095 for (i = 0; i < (int)n->args->argc; i++)
1096 if (MDOC_Column == n->args->argv[i].arg)
1097 break;
1098 assert(i < (int)n->args->argc);
1099
1100 if (n->args->argv[i].sz && mdoc->last->nchild) {
1101 mdoc_nmsg(mdoc, n, MANDOCERR_COLUMNS);
1102 return(0);
1103 }
1104 return(1);
1105 }
1106
1107 if (0 == (i = mdoc->last->nchild))
1108 return(1);
1109 return(warn_count(mdoc, "==", 0, "line arguments", i));
1110 }
1111
1112
1113 static int
1114 post_bl(POST_ARGS)
1115 {
1116 struct mdoc_node *n;
1117
1118 if (MDOC_HEAD == mdoc->last->type)
1119 return(post_bl_head(mdoc));
1120 if (MDOC_BODY != mdoc->last->type)
1121 return(1);
1122 if (NULL == mdoc->last->child)
1123 return(1);
1124
1125 /*
1126 * We only allow certain children of `Bl'. This is usually on
1127 * `It', but apparently `Sm' occurs here and there, so we let
1128 * that one through, too.
1129 */
1130
1131 /* LINTED */
1132 for (n = mdoc->last->child; n; n = n->next) {
1133 if (MDOC_BLOCK == n->type && MDOC_It == n->tok)
1134 continue;
1135 if (MDOC_Sm == n->tok)
1136 continue;
1137 mdoc_nmsg(mdoc, n, MANDOCERR_SYNTCHILD);
1138 return(0);
1139 }
1140
1141 return(1);
1142 }
1143
1144
1145 static int
1146 ebool(struct mdoc *mdoc)
1147 {
1148 struct mdoc_node *n;
1149
1150 /* LINTED */
1151 for (n = mdoc->last->child; n; n = n->next) {
1152 if (MDOC_TEXT != n->type)
1153 break;
1154 if (0 == strcmp(n->string, "on"))
1155 continue;
1156 if (0 == strcmp(n->string, "off"))
1157 continue;
1158 break;
1159 }
1160
1161 if (NULL == n)
1162 return(1);
1163 return(mdoc_nmsg(mdoc, n, MANDOCERR_BADBOOL));
1164 }
1165
1166
1167 static int
1168 post_root(POST_ARGS)
1169 {
1170
1171 if (NULL == mdoc->first->child)
1172 mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY);
1173 else if ( ! (MDOC_PBODY & mdoc->flags))
1174 mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCPROLOG);
1175 else if (MDOC_BLOCK != mdoc->first->child->type)
1176 mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY);
1177 else if (MDOC_Sh != mdoc->first->child->tok)
1178 mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY);
1179 else
1180 return(1);
1181
1182 return(0);
1183 }
1184
1185
1186 static int
1187 post_st(POST_ARGS)
1188 {
1189
1190 if (mdoc_a2st(mdoc->last->child->string))
1191 return(1);
1192 return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADSTANDARD));
1193 }
1194
1195
1196 static int
1197 post_rs(POST_ARGS)
1198 {
1199 struct mdoc_node *nn;
1200
1201 if (MDOC_BODY != mdoc->last->type)
1202 return(1);
1203
1204 for (nn = mdoc->last->child; nn; nn = nn->next)
1205 switch (nn->tok) {
1206 case(MDOC__U):
1207 /* FALLTHROUGH */
1208 case(MDOC__Q):
1209 /* FALLTHROUGH */
1210 case(MDOC__C):
1211 /* FALLTHROUGH */
1212 case(MDOC__A):
1213 /* FALLTHROUGH */
1214 case(MDOC__B):
1215 /* FALLTHROUGH */
1216 case(MDOC__D):
1217 /* FALLTHROUGH */
1218 case(MDOC__I):
1219 /* FALLTHROUGH */
1220 case(MDOC__J):
1221 /* FALLTHROUGH */
1222 case(MDOC__N):
1223 /* FALLTHROUGH */
1224 case(MDOC__O):
1225 /* FALLTHROUGH */
1226 case(MDOC__P):
1227 /* FALLTHROUGH */
1228 case(MDOC__R):
1229 /* FALLTHROUGH */
1230 case(MDOC__T):
1231 /* FALLTHROUGH */
1232 case(MDOC__V):
1233 break;
1234 default:
1235 mdoc_nmsg(mdoc, nn, MANDOCERR_SYNTCHILD);
1236 return(0);
1237 }
1238
1239 return(1);
1240 }
1241
1242
1243 static int
1244 post_sh(POST_ARGS)
1245 {
1246
1247 if (MDOC_HEAD == mdoc->last->type)
1248 return(post_sh_head(mdoc));
1249 if (MDOC_BODY == mdoc->last->type)
1250 return(post_sh_body(mdoc));
1251
1252 return(1);
1253 }
1254
1255
1256 static int
1257 post_sh_body(POST_ARGS)
1258 {
1259 struct mdoc_node *n;
1260
1261 if (SEC_NAME != mdoc->lastsec)
1262 return(1);
1263
1264 /*
1265 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1266 * macros (can have multiple `Nm' and one `Nd'). Note that the
1267 * children of the BODY declaration can also be "text".
1268 */
1269
1270 if (NULL == (n = mdoc->last->child))
1271 return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC));
1272
1273 for ( ; n && n->next; n = n->next) {
1274 if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1275 continue;
1276 if (MDOC_TEXT == n->type)
1277 continue;
1278 if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC))
1279 return(0);
1280 }
1281
1282 assert(n);
1283 if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
1284 return(1);
1285 return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC));
1286 }
1287
1288
1289 static int
1290 post_sh_head(POST_ARGS)
1291 {
1292 char buf[BUFSIZ];
1293 enum mdoc_sec sec;
1294 const struct mdoc_node *n;
1295
1296 /*
1297 * Process a new section. Sections are either "named" or
1298 * "custom"; custom sections are user-defined, while named ones
1299 * usually follow a conventional order and may only appear in
1300 * certain manual sections.
1301 */
1302
1303 buf[0] = '\0';
1304
1305 /*
1306 * FIXME: yes, these can use a dynamic buffer, but I don't do so
1307 * in the interests of simplicity.
1308 */
1309
1310 for (n = mdoc->last->child; n; n = n->next) {
1311 /* XXX - copied from compact(). */
1312 assert(MDOC_TEXT == n->type);
1313
1314 if (strlcat(buf, n->string, BUFSIZ) >= BUFSIZ) {
1315 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
1316 return(0);
1317 }
1318 if (NULL == n->next)
1319 continue;
1320 if (strlcat(buf, " ", BUFSIZ) >= BUFSIZ) {
1321 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
1322 return(0);
1323 }
1324 }
1325
1326 sec = mdoc_str2sec(buf);
1327
1328 /*
1329 * Check: NAME should always be first, CUSTOM has no roles,
1330 * non-CUSTOM has a conventional order to be followed.
1331 */
1332
1333 if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
1334 if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NAMESECFIRST))
1335 return(0);
1336
1337 if (SEC_CUSTOM == sec)
1338 return(1);
1339
1340 if (sec == mdoc->lastnamed)
1341 if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECREP))
1342 return(0);
1343
1344 if (sec < mdoc->lastnamed)
1345 if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECOOO))
1346 return(0);
1347
1348 /*
1349 * Check particular section/manual conventions. LIBRARY can
1350 * only occur in manual section 2, 3, and 9.
1351 */
1352
1353 switch (sec) {
1354 case (SEC_LIBRARY):
1355 assert(mdoc->meta.msec);
1356 if (*mdoc->meta.msec == '2')
1357 break;
1358 if (*mdoc->meta.msec == '3')
1359 break;
1360 if (*mdoc->meta.msec == '9')
1361 break;
1362 return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECMSEC));
1363 default:
1364 break;
1365 }
1366
1367 return(1);
1368 }