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