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