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