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