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