]> 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
Let `Bl' accept arguments on the head line with a warning (these are ignored in the...
[mandoc.git] / mdoc_validate.c
1 /* $Id: mdoc_validate.c,v 1.64 2010/04/06 11:28:17 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, enum mdoct, 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[] = { ewarn_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, enum mdoct 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 /*
625 * Note that if a duplicate is detected, we
626 * remove the duplicate instead of passing it
627 * over. If we don't do this, mdoc_action will
628 * become confused when it scans over multiple
629 * types whilst setting its bitmasks.
630 *
631 * FIXME: this should occur in mdoc_action.c.
632 */
633 if (type >= 0) {
634 if ( ! mdoc_nwarn(mdoc, n, EMULTILIST))
635 return(0);
636 mdoc_argn_free(n->args, pos);
637 break;
638 }
639 type = n->args->argv[pos].arg;
640 break;
641 case (MDOC_Compact):
642 if (type < 0 && ! mdoc_nwarn(mdoc, n, ENOTYPE))
643 return(0);
644 break;
645 case (MDOC_Width):
646 if (width >= 0)
647 return(mdoc_nerr(mdoc, n, EARGREP));
648 if (type < 0 && ! mdoc_nwarn(mdoc, n, ENOTYPE))
649 return(0);
650 width = n->args->argv[pos].arg;
651 break;
652 case (MDOC_Offset):
653 if (offset >= 0)
654 return(mdoc_nerr(mdoc, n, EARGREP));
655 if (type < 0 && ! mdoc_nwarn(mdoc, n, ENOTYPE))
656 return(0);
657 offset = n->args->argv[pos].arg;
658 break;
659 default:
660 break;
661 }
662
663 if (type < 0)
664 return(mdoc_nerr(mdoc, n, ELISTTYPE));
665
666 /*
667 * Validate the width field. Some list types don't need width
668 * types and should be warned about them. Others should have it
669 * and must also be warned.
670 */
671
672 switch (type) {
673 case (MDOC_Tag):
674 if (width < 0 && ! mdoc_nwarn(mdoc, n, EMISSWIDTH))
675 return(0);
676 break;
677 case (MDOC_Column):
678 /* FALLTHROUGH */
679 case (MDOC_Diag):
680 /* FALLTHROUGH */
681 case (MDOC_Ohang):
682 /* FALLTHROUGH */
683 case (MDOC_Inset):
684 /* FALLTHROUGH */
685 case (MDOC_Item):
686 if (width >= 0 && ! mdoc_nwarn(mdoc, n, ENOWIDTH))
687 return(0);
688 break;
689 default:
690 break;
691 }
692
693 return(1);
694 }
695
696
697 static int
698 pre_bd(PRE_ARGS)
699 {
700 int i, type, err;
701
702 if (MDOC_BLOCK != n->type)
703 return(1);
704 if (NULL == n->args)
705 return(mdoc_nerr(mdoc, n, EDISPTYPE));
706
707 /* Make sure that only one type of display is specified. */
708
709 /* LINTED */
710 for (i = 0, err = type = 0; ! err &&
711 i < (int)n->args->argc; i++)
712 switch (n->args->argv[i].arg) {
713 case (MDOC_Centred):
714 /* FALLTHROUGH */
715 case (MDOC_Ragged):
716 /* FALLTHROUGH */
717 case (MDOC_Unfilled):
718 /* FALLTHROUGH */
719 case (MDOC_Filled):
720 /* FALLTHROUGH */
721 case (MDOC_Literal):
722 if (0 == type++)
723 break;
724 return(mdoc_nerr(mdoc, n, EMULTIDISP));
725 default:
726 break;
727 }
728
729 if (type)
730 return(1);
731 return(mdoc_nerr(mdoc, n, EDISPTYPE));
732 }
733
734
735 static int
736 pre_ss(PRE_ARGS)
737 {
738
739 if (MDOC_BLOCK != n->type)
740 return(1);
741 return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
742 }
743
744
745 static int
746 pre_sh(PRE_ARGS)
747 {
748
749 if (MDOC_BLOCK != n->type)
750 return(1);
751 return(check_parent(mdoc, n, -1, MDOC_ROOT));
752 }
753
754
755 static int
756 pre_it(PRE_ARGS)
757 {
758
759 if (MDOC_BLOCK != n->type)
760 return(1);
761 return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
762 }
763
764
765 static int
766 pre_an(PRE_ARGS)
767 {
768
769 if (NULL == n->args || 1 == n->args->argc)
770 return(1);
771 return(mdoc_verr(mdoc, n->line, n->pos,
772 "only one argument allowed"));
773 }
774
775
776 static int
777 pre_lb(PRE_ARGS)
778 {
779
780 return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM));
781 }
782
783
784 static int
785 pre_rv(PRE_ARGS)
786 {
787
788 if ( ! check_msec(mdoc, n, 2, 3, 0))
789 return(0);
790 return(check_stdarg(mdoc, n));
791 }
792
793
794 static int
795 pre_ex(PRE_ARGS)
796 {
797
798 if ( ! check_msec(mdoc, n, 1, 6, 8, 0))
799 return(0);
800 return(check_stdarg(mdoc, n));
801 }
802
803
804 static int
805 pre_er(PRE_ARGS)
806 {
807
808 return(check_msec(mdoc, n, 2, 3, 9, 0));
809 }
810
811
812 static int
813 pre_cd(PRE_ARGS)
814 {
815
816 return(check_msec(mdoc, n, 4, 0));
817 }
818
819
820 static int
821 pre_dt(PRE_ARGS)
822 {
823
824 /* FIXME: make sure is capitalised. */
825
826 if (0 == mdoc->meta.date || mdoc->meta.os)
827 if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
828 return(0);
829 if (mdoc->meta.title)
830 if ( ! mdoc_nwarn(mdoc, n, EPROLREP))
831 return(0);
832 return(1);
833 }
834
835
836 static int
837 pre_os(PRE_ARGS)
838 {
839
840 if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
841 if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
842 return(0);
843 if (mdoc->meta.os)
844 if ( ! mdoc_nwarn(mdoc, n, EPROLREP))
845 return(0);
846 return(1);
847 }
848
849
850 static int
851 pre_dd(PRE_ARGS)
852 {
853
854 if (mdoc->meta.title || mdoc->meta.os)
855 if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
856 return(0);
857 if (mdoc->meta.date)
858 if ( ! mdoc_nwarn(mdoc, n, EPROLREP))
859 return(0);
860 return(1);
861 }
862
863
864 static int
865 post_bf(POST_ARGS)
866 {
867 char *p;
868 struct mdoc_node *head;
869
870 if (MDOC_BLOCK != mdoc->last->type)
871 return(1);
872
873 head = mdoc->last->head;
874
875 if (mdoc->last->args && head->child)
876 return(mdoc_nerr(mdoc, mdoc->last, ELINE));
877 else if (mdoc->last->args)
878 return(1);
879
880 if (NULL == head->child || MDOC_TEXT != head->child->type)
881 return(mdoc_nerr(mdoc, mdoc->last, ELINE));
882
883 p = head->child->string;
884
885 if (0 == strcmp(p, "Em"))
886 return(1);
887 else if (0 == strcmp(p, "Li"))
888 return(1);
889 else if (0 == strcmp(p, "Sy"))
890 return(1);
891
892 return(mdoc_nerr(mdoc, head, EFONT));
893 }
894
895
896 static int
897 post_lb(POST_ARGS)
898 {
899
900 if (mdoc_a2lib(mdoc->last->child->string))
901 return(1);
902 return(mdoc_nwarn(mdoc, mdoc->last, ELIB));
903 }
904
905
906 static int
907 post_vt(POST_ARGS)
908 {
909 const struct mdoc_node *n;
910
911 /*
912 * The Vt macro comes in both ELEM and BLOCK form, both of which
913 * have different syntaxes (yet more context-sensitive
914 * behaviour). ELEM types must have a child; BLOCK types,
915 * specifically the BODY, should only have TEXT children.
916 */
917
918 if (MDOC_ELEM == mdoc->last->type)
919 return(eerr_ge1(mdoc));
920 if (MDOC_BODY != mdoc->last->type)
921 return(1);
922
923 for (n = mdoc->last->child; n; n = n->next)
924 if (MDOC_TEXT != n->type)
925 if ( ! mdoc_nwarn(mdoc, n, EBADCHILD))
926 return(0);
927
928 return(1);
929 }
930
931
932 static int
933 post_nm(POST_ARGS)
934 {
935
936 if (mdoc->last->child)
937 return(1);
938 if (mdoc->meta.name)
939 return(1);
940 return(mdoc_nerr(mdoc, mdoc->last, ENAME));
941 }
942
943
944 static int
945 post_at(POST_ARGS)
946 {
947
948 if (NULL == mdoc->last->child)
949 return(1);
950 if (MDOC_TEXT != mdoc->last->child->type)
951 return(mdoc_nerr(mdoc, mdoc->last, EATT));
952 if (mdoc_a2att(mdoc->last->child->string))
953 return(1);
954 return(mdoc_nerr(mdoc, mdoc->last, EATT));
955 }
956
957
958 static int
959 post_an(POST_ARGS)
960 {
961
962 if (mdoc->last->args) {
963 if (NULL == mdoc->last->child)
964 return(1);
965 return(mdoc_nerr(mdoc, mdoc->last, ENOLINE));
966 }
967
968 if (mdoc->last->child)
969 return(1);
970 return(mdoc_nerr(mdoc, mdoc->last, ELINE));
971 }
972
973
974 static int
975 post_it(POST_ARGS)
976 {
977 int type, i, cols;
978 struct mdoc_node *n, *c;
979
980 if (MDOC_BLOCK != mdoc->last->type)
981 return(1);
982
983 n = mdoc->last->parent->parent;
984 if (NULL == n->args)
985 return(mdoc_nerr(mdoc, mdoc->last, ELISTTYPE));
986
987 /* Some types require block-head, some not. */
988
989 /* LINTED */
990 for (cols = type = -1, i = 0; -1 == type &&
991 i < (int)n->args->argc; i++)
992 switch (n->args->argv[i].arg) {
993 case (MDOC_Tag):
994 /* FALLTHROUGH */
995 case (MDOC_Diag):
996 /* FALLTHROUGH */
997 case (MDOC_Hang):
998 /* FALLTHROUGH */
999 case (MDOC_Ohang):
1000 /* FALLTHROUGH */
1001 case (MDOC_Inset):
1002 /* FALLTHROUGH */
1003 case (MDOC_Bullet):
1004 /* FALLTHROUGH */
1005 case (MDOC_Dash):
1006 /* FALLTHROUGH */
1007 case (MDOC_Enum):
1008 /* FALLTHROUGH */
1009 case (MDOC_Hyphen):
1010 /* FALLTHROUGH */
1011 case (MDOC_Item):
1012 type = n->args->argv[i].arg;
1013 break;
1014 case (MDOC_Column):
1015 type = n->args->argv[i].arg;
1016 cols = (int)n->args->argv[i].sz;
1017 break;
1018 default:
1019 break;
1020 }
1021
1022 if (-1 == type)
1023 return(mdoc_nerr(mdoc, mdoc->last, ELISTTYPE));
1024
1025 switch (type) {
1026 case (MDOC_Tag):
1027 if (NULL == mdoc->last->head->child)
1028 if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
1029 return(0);
1030 break;
1031 case (MDOC_Hang):
1032 /* FALLTHROUGH */
1033 case (MDOC_Ohang):
1034 /* FALLTHROUGH */
1035 case (MDOC_Inset):
1036 /* FALLTHROUGH */
1037 case (MDOC_Diag):
1038 if (NULL == mdoc->last->head->child)
1039 if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
1040 return(0);
1041 if (NULL == mdoc->last->body->child)
1042 if ( ! mdoc_nwarn(mdoc, mdoc->last, EMULTILINE))
1043 return(0);
1044 break;
1045 case (MDOC_Bullet):
1046 /* FALLTHROUGH */
1047 case (MDOC_Dash):
1048 /* FALLTHROUGH */
1049 case (MDOC_Enum):
1050 /* FALLTHROUGH */
1051 case (MDOC_Hyphen):
1052 /* FALLTHROUGH */
1053 case (MDOC_Item):
1054 if (mdoc->last->head->child)
1055 if ( ! mdoc_nwarn(mdoc, mdoc->last, ENOLINE))
1056 return(0);
1057 if (NULL == mdoc->last->body->child)
1058 if ( ! mdoc_nwarn(mdoc, mdoc->last, EMULTILINE))
1059 return(0);
1060 break;
1061 case (MDOC_Column):
1062 if (NULL == mdoc->last->head->child)
1063 if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
1064 return(0);
1065 if (mdoc->last->body->child)
1066 if ( ! mdoc_nwarn(mdoc, mdoc->last, ENOMULTILINE))
1067 return(0);
1068 c = mdoc->last->child;
1069 for (i = 0; c && MDOC_HEAD == c->type; c = c->next)
1070 i++;
1071
1072 if (i < cols || i == (cols + 1)) {
1073 if ( ! mdoc_vwarn(mdoc, mdoc->last->line,
1074 mdoc->last->pos, "column "
1075 "mismatch: have %d, want %d",
1076 i, cols))
1077 return(0);
1078 break;
1079 } else if (i == cols)
1080 break;
1081
1082 return(mdoc_verr(mdoc, mdoc->last->line,
1083 mdoc->last->pos, "column mismatch: "
1084 "have %d, want %d", i, cols));
1085 default:
1086 break;
1087 }
1088
1089 return(1);
1090 }
1091
1092
1093 static int
1094 post_bl_head(POST_ARGS)
1095 {
1096 int i;
1097 const struct mdoc_node *n;
1098
1099 n = mdoc->last->parent;
1100 assert(n->args);
1101
1102 for (i = 0; i < (int)n->args->argc; i++)
1103 if (n->args->argv[i].arg == MDOC_Column)
1104 break;
1105
1106 if (i == (int)n->args->argc && n->nchild)
1107 return(warn_count(mdoc, "==", 0,
1108 "line arguments", n->nchild));
1109
1110 if (n->args->argv[i].sz && mdoc->last->child)
1111 return(mdoc_nerr(mdoc, n, ECOLMIS));
1112
1113 return(1);
1114 }
1115
1116
1117 static int
1118 post_bl(POST_ARGS)
1119 {
1120 struct mdoc_node *n;
1121
1122 if (MDOC_HEAD == mdoc->last->type)
1123 return(post_bl_head(mdoc));
1124 if (MDOC_BODY != mdoc->last->type)
1125 return(1);
1126 if (NULL == mdoc->last->child)
1127 return(1);
1128
1129 /*
1130 * We only allow certain children of `Bl'. This is usually on
1131 * `It', but apparently `Sm' occurs here and there, so we let
1132 * that one through, too.
1133 */
1134
1135 /* LINTED */
1136 for (n = mdoc->last->child; n; n = n->next) {
1137 if (MDOC_BLOCK == n->type && MDOC_It == n->tok)
1138 continue;
1139 if (MDOC_Sm == n->tok)
1140 continue;
1141 return(mdoc_nerr(mdoc, n, EBADCHILD));
1142 }
1143
1144 return(1);
1145 }
1146
1147
1148 static int
1149 ebool(struct mdoc *mdoc)
1150 {
1151 struct mdoc_node *n;
1152
1153 /* LINTED */
1154 for (n = mdoc->last->child; n; n = n->next) {
1155 if (MDOC_TEXT != n->type)
1156 break;
1157 if (0 == strcmp(n->string, "on"))
1158 continue;
1159 if (0 == strcmp(n->string, "off"))
1160 continue;
1161 break;
1162 }
1163
1164 if (NULL == n)
1165 return(1);
1166 return(mdoc_nerr(mdoc, n, EBOOL));
1167 }
1168
1169
1170 static int
1171 post_root(POST_ARGS)
1172 {
1173
1174 if (NULL == mdoc->first->child)
1175 return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1176 if ( ! (MDOC_PBODY & mdoc->flags))
1177 return(mdoc_nerr(mdoc, mdoc->first, ENOPROLOGUE));
1178
1179 if (MDOC_BLOCK != mdoc->first->child->type)
1180 return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1181 if (MDOC_Sh != mdoc->first->child->tok)
1182 return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1183
1184 return(1);
1185 }
1186
1187
1188 static int
1189 post_st(POST_ARGS)
1190 {
1191
1192 if (mdoc_a2st(mdoc->last->child->string))
1193 return(1);
1194 return(mdoc_nerr(mdoc, mdoc->last, EBADSTAND));
1195 }
1196
1197
1198 static int
1199 post_rs(POST_ARGS)
1200 {
1201 struct mdoc_node *nn;
1202
1203 if (MDOC_BODY != mdoc->last->type)
1204 return(1);
1205
1206 for (nn = mdoc->last->child; nn; nn = nn->next)
1207 switch (nn->tok) {
1208 case(MDOC__U):
1209 /* FALLTHROUGH */
1210 case(MDOC__Q):
1211 /* FALLTHROUGH */
1212 case(MDOC__C):
1213 /* FALLTHROUGH */
1214 case(MDOC__A):
1215 /* FALLTHROUGH */
1216 case(MDOC__B):
1217 /* FALLTHROUGH */
1218 case(MDOC__D):
1219 /* FALLTHROUGH */
1220 case(MDOC__I):
1221 /* FALLTHROUGH */
1222 case(MDOC__J):
1223 /* FALLTHROUGH */
1224 case(MDOC__N):
1225 /* FALLTHROUGH */
1226 case(MDOC__O):
1227 /* FALLTHROUGH */
1228 case(MDOC__P):
1229 /* FALLTHROUGH */
1230 case(MDOC__R):
1231 /* FALLTHROUGH */
1232 case(MDOC__T):
1233 /* FALLTHROUGH */
1234 case(MDOC__V):
1235 break;
1236 default:
1237 return(mdoc_nerr(mdoc, nn, EBADCHILD));
1238 }
1239
1240 return(1);
1241 }
1242
1243
1244 static int
1245 post_sh(POST_ARGS)
1246 {
1247
1248 if (MDOC_HEAD == mdoc->last->type)
1249 return(post_sh_head(mdoc));
1250 if (MDOC_BODY == mdoc->last->type)
1251 return(post_sh_body(mdoc));
1252
1253 return(1);
1254 }
1255
1256
1257 static int
1258 post_sh_body(POST_ARGS)
1259 {
1260 struct mdoc_node *n;
1261
1262 if (SEC_NAME != mdoc->lastsec)
1263 return(1);
1264
1265 /*
1266 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1267 * macros (can have multiple `Nm' and one `Nd'). Note that the
1268 * children of the BODY declaration can also be "text".
1269 */
1270
1271 if (NULL == (n = mdoc->last->child))
1272 return(mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC));
1273
1274 for ( ; n && n->next; n = n->next) {
1275 if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1276 continue;
1277 if (MDOC_TEXT == n->type)
1278 continue;
1279 if ( ! mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC))
1280 return(0);
1281 }
1282
1283 assert(n);
1284 if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
1285 return(1);
1286 return(mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC));
1287 }
1288
1289
1290 static int
1291 post_sh_head(POST_ARGS)
1292 {
1293 char buf[64];
1294 enum mdoc_sec sec;
1295 const struct mdoc_node *n;
1296
1297 /*
1298 * Process a new section. Sections are either "named" or
1299 * "custom"; custom sections are user-defined, while named ones
1300 * usually follow a conventional order and may only appear in
1301 * certain manual sections.
1302 */
1303
1304 buf[0] = 0;
1305
1306 for (n = mdoc->last->child; n; n = n->next) {
1307 /* XXX - copied from compact(). */
1308 assert(MDOC_TEXT == n->type);
1309
1310 if (strlcat(buf, n->string, 64) >= 64)
1311 return(mdoc_nerr(mdoc, n, ETOOLONG));
1312 if (NULL == n->next)
1313 continue;
1314 if (strlcat(buf, " ", 64) >= 64)
1315 return(mdoc_nerr(mdoc, n, ETOOLONG));
1316 }
1317
1318 sec = mdoc_atosec(buf);
1319
1320 /*
1321 * Check: NAME should always be first, CUSTOM has no roles,
1322 * non-CUSTOM has a conventional order to be followed.
1323 */
1324
1325 if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed &&
1326 ! mdoc_nwarn(mdoc, mdoc->last, ESECNAME))
1327 return(0);
1328 if (SEC_CUSTOM == sec)
1329 return(1);
1330 if (sec == mdoc->lastnamed)
1331 if ( ! mdoc_nwarn(mdoc, mdoc->last, ESECREP))
1332 return(0);
1333 if (sec < mdoc->lastnamed)
1334 if ( ! mdoc_nwarn(mdoc, mdoc->last, ESECOOO))
1335 return(0);
1336
1337 /*
1338 * Check particular section/manual conventions. LIBRARY can
1339 * only occur in msec 2, 3 (TODO: are there more of these?).
1340 */
1341
1342 switch (sec) {
1343 case (SEC_LIBRARY):
1344 switch (mdoc->meta.msec) {
1345 case (2):
1346 /* FALLTHROUGH */
1347 case (3):
1348 break;
1349 default:
1350 return(mdoc_nwarn(mdoc, mdoc->last, EWRONGMSEC));
1351 }
1352 break;
1353 default:
1354 break;
1355 }
1356
1357 return(1);
1358 }
1359
1360
1361 static int
1362 pre_fd(PRE_ARGS)
1363 {
1364
1365 return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM));
1366 }
A git conversion mirror of mandoc.bsd.lv