![[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.3 ! schwarze 1: /* $Id: mdoc_validate.c,v 1.2 2009/06/14 23:00:57 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"
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 check_parent(PRE_ARGS, int, enum mdoc_type);
81: static int check_msec(PRE_ARGS, ...);
82: static int check_sec(PRE_ARGS, ...);
83: static int check_stdarg(PRE_ARGS);
84: static int check_text(struct mdoc *, int, int, const char *);
85: static int check_argv(struct mdoc *,
86: const struct mdoc_node *,
87: const struct mdoc_argv *);
88: static int check_args(struct mdoc *,
89: const struct mdoc_node *);
90: static int err_child_lt(struct mdoc *, const char *, int);
91: static int warn_child_lt(struct mdoc *, const char *, int);
92: static int err_child_gt(struct mdoc *, const char *, int);
93: static int warn_child_gt(struct mdoc *, const char *, int);
94: static int err_child_eq(struct mdoc *, const char *, int);
95: static int warn_child_eq(struct mdoc *, const char *, int);
96: static int count_child(struct mdoc *);
1.3 ! schwarze 97: static int warn_print(struct mdoc *, int, int);
1.1 kristaps 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:
1.3 ! schwarze 498: static int
! 499: warn_print(struct mdoc *m, int ln, int pos)
! 500: {
! 501: if (MDOC_IGN_CHARS & m->pflags)
! 502: return(pwarn(m, ln, pos, WPRINT));
! 503: return(perr(m, ln, pos, EPRINT));
! 504: }
! 505:
1.1 kristaps 506:
507: static inline int
508: warn_count(struct mdoc *m, const char *k,
509: int want, const char *v, int has)
510: {
511:
512: return(mdoc_warn(m, WARN_SYNTAX,
513: "suggests %s %s %d (has %d)", v, k, want, has));
514: }
515:
516:
517: static inline int
518: err_count(struct mdoc *m, const char *k,
519: int want, const char *v, int has)
520: {
521:
522: return(mdoc_err(m,
523: "requires %s %s %d (has %d)", v, k, want, has));
524: }
525:
526:
527: static inline int
528: count_child(struct mdoc *mdoc)
529: {
530: int i;
531: struct mdoc_node *n;
532:
533: for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
534: /* Do nothing */ ;
535:
536: return(i);
537: }
538:
539:
540: /*
541: * Build these up with macros because they're basically the same check
542: * for different inequalities. Yes, this could be done with functions,
543: * but this is reasonable for now.
544: */
545:
546: #define CHECK_CHILD_DEFN(lvl, name, ineq) \
547: static int \
548: lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \
549: { \
550: int i; \
551: if ((i = count_child(mdoc)) ineq sz) \
552: return(1); \
553: return(lvl##_count(mdoc, #ineq, sz, p, i)); \
554: }
555:
556: #define CHECK_BODY_DEFN(name, lvl, func, num) \
557: static int \
558: b##lvl##_##name(POST_ARGS) \
559: { \
560: if (MDOC_BODY != mdoc->last->type) \
561: return(1); \
562: return(func(mdoc, "multi-line arguments", (num))); \
563: }
564:
565: #define CHECK_ELEM_DEFN(name, lvl, func, num) \
566: static int \
567: e##lvl##_##name(POST_ARGS) \
568: { \
569: assert(MDOC_ELEM == mdoc->last->type); \
570: return(func(mdoc, "line arguments", (num))); \
571: }
572:
573: #define CHECK_HEAD_DEFN(name, lvl, func, num) \
574: static int \
575: h##lvl##_##name(POST_ARGS) \
576: { \
577: if (MDOC_HEAD != mdoc->last->type) \
578: return(1); \
579: return(func(mdoc, "line arguments", (num))); \
580: }
581:
582:
583: CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */
584: CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */
585: CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */
586: CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */
587: CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */
588: CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */
589: CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */
590: CHECK_ELEM_DEFN(eq1, warn, warn_child_eq, 1) /* ewarn_eq1() */
591: CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0) /* ewarn_eq0() */
592: CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_gt1() */
593: CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */
594: CHECK_ELEM_DEFN(le2, err, err_child_lt, 3) /* eerr_le2() */
595: CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */
596: CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */
597: CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */
598: CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2) /* hwarn_le1() */
599: CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */
600: CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1) /* hwarn_eq1() */
601:
602:
603: static int
604: check_stdarg(PRE_ARGS)
605: {
606:
607: if (n->args && 1 == n->args->argc)
608: if (MDOC_Std == n->args->argv[0].arg)
609: return(1);
610: return(nwarn(mdoc, n, WARGVAL));
611: }
612:
613:
614: static int
615: check_sec(PRE_ARGS, ...)
616: {
617: enum mdoc_sec sec;
618: va_list ap;
619:
620: va_start(ap, n);
621:
622: for (;;) {
623: /* LINTED */
624: sec = (enum mdoc_sec)va_arg(ap, int);
625: if (SEC_CUSTOM == sec)
626: break;
627: if (sec != mdoc->lastsec)
628: continue;
629: va_end(ap);
630: return(1);
631: }
632:
633: va_end(ap);
634: return(nwarn(mdoc, n, WBADSEC));
635: }
636:
637:
638: static int
639: check_msec(PRE_ARGS, ...)
640: {
641: va_list ap;
642: int msec;
643:
644: va_start(ap, n);
645: for (;;) {
646: /* LINTED */
647: if (0 == (msec = va_arg(ap, int)))
648: break;
649: if (msec != mdoc->meta.msec)
650: continue;
651: va_end(ap);
652: return(1);
653: }
654:
655: va_end(ap);
656: return(nwarn(mdoc, n, WBADMSEC));
657: }
658:
659:
660: static int
661: check_args(struct mdoc *m, const struct mdoc_node *n)
662: {
663: int i;
664:
665: if (NULL == n->args)
666: return(1);
667:
668: assert(n->args->argc);
669: for (i = 0; i < (int)n->args->argc; i++)
670: if ( ! check_argv(m, n, &n->args->argv[i]))
671: return(0);
672:
673: return(1);
674: }
675:
676:
677: static int
678: check_argv(struct mdoc *m, const struct mdoc_node *n,
679: const struct mdoc_argv *v)
680: {
681: int i;
682:
683: for (i = 0; i < (int)v->sz; i++)
684: if ( ! check_text(m, v->line, v->pos, v->value[i]))
685: return(0);
686:
687: if (MDOC_Std == v->arg) {
688: /* `Nm' name must be set. */
689: if (v->sz || m->meta.name)
690: return(1);
691: return(nerr(m, n, ENAME));
692: }
693:
694: return(1);
695: }
696:
697:
698: static int
699: check_text(struct mdoc *mdoc, int line, int pos, const char *p)
700: {
701: size_t c;
702:
703: /* FIXME: indicate deprecated escapes \*(xx and \*x. */
704:
705: for ( ; *p; p++) {
706: if ('\t' == *p) {
707: if ( ! (MDOC_LITERAL & mdoc->flags))
1.3 ! schwarze 708: if ( ! warn_print(mdoc, line, pos))
1.1 kristaps 709: return(0);
710: } else if ( ! isprint((u_char)*p))
1.3 ! schwarze 711: if ( ! warn_print(mdoc, line, pos))
1.1 kristaps 712: return(0);
713:
714: if ('\\' != *p)
715: continue;
716:
717: c = mdoc_isescape(p);
718: if (c) {
719: p += (int)c - 1;
720: continue;
721: }
722: if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags))
723: return(perr(mdoc, line, pos, EESCAPE));
724: if ( ! pwarn(mdoc, line, pos, WESCAPE))
725: return(0);
726: }
727:
728: return(1);
729: }
730:
731:
732:
733:
734: static int
735: check_parent(PRE_ARGS, int tok, enum mdoc_type t)
736: {
737:
738: assert(n->parent);
739: if ((MDOC_ROOT == t || tok == n->parent->tok) &&
740: (t == n->parent->type))
741: return(1);
742:
743: return(mdoc_nerr(mdoc, n, "require parent %s",
744: MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
745: }
746:
747:
748:
749: static int
750: pre_display(PRE_ARGS)
751: {
752: struct mdoc_node *node;
753:
754: /* Display elements (`Bd', `D1'...) cannot be nested. */
755:
756: if (MDOC_BLOCK != n->type)
757: return(1);
758:
759: /* LINTED */
760: for (node = mdoc->last->parent; node; node = node->parent)
761: if (MDOC_BLOCK == node->type)
762: if (MDOC_Bd == node->tok)
763: break;
764: if (NULL == node)
765: return(1);
766:
767: return(nerr(mdoc, n, ENESTDISP));
768: }
769:
770:
771: static int
772: pre_bl(PRE_ARGS)
773: {
774: int i, type, width, offset;
775:
776: if (MDOC_BLOCK != n->type)
777: return(1);
778: if (NULL == n->args)
779: return(nerr(mdoc, n, ELISTTYPE));
780:
781: /* Make sure that only one type of list is specified. */
782:
783: type = offset = width = -1;
784:
785: /* LINTED */
786: for (i = 0; i < (int)n->args->argc; i++)
787: switch (n->args->argv[i].arg) {
788: case (MDOC_Bullet):
789: /* FALLTHROUGH */
790: case (MDOC_Dash):
791: /* FALLTHROUGH */
792: case (MDOC_Enum):
793: /* FALLTHROUGH */
794: case (MDOC_Hyphen):
795: /* FALLTHROUGH */
796: case (MDOC_Item):
797: /* FALLTHROUGH */
798: case (MDOC_Tag):
799: /* FALLTHROUGH */
800: case (MDOC_Diag):
801: /* FALLTHROUGH */
802: case (MDOC_Hang):
803: /* FALLTHROUGH */
804: case (MDOC_Ohang):
805: /* FALLTHROUGH */
806: case (MDOC_Inset):
807: /* FALLTHROUGH */
808: case (MDOC_Column):
809: if (-1 == type) {
810: type = n->args->argv[i].arg;
811: break;
812: }
813: return(nerr(mdoc, n, EMULTILIST));
814: case (MDOC_Width):
815: if (-1 == width) {
816: width = n->args->argv[i].arg;
817: break;
818: }
819: return(nerr(mdoc, n, EARGREP));
820: case (MDOC_Offset):
821: if (-1 == offset) {
822: offset = n->args->argv[i].arg;
823: break;
824: }
825: return(nerr(mdoc, n, EARGREP));
826: default:
827: break;
828: }
829:
830: if (-1 == type)
831: return(nerr(mdoc, n, ELISTTYPE));
832:
833: switch (type) {
834: case (MDOC_Column):
835: /* FALLTHROUGH */
836: case (MDOC_Diag):
837: /* FALLTHROUGH */
838: case (MDOC_Inset):
839: /* FALLTHROUGH */
840: case (MDOC_Item):
841: if (-1 == width)
842: break;
843: return(mdoc_nwarn(mdoc, n, WARN_SYNTAX,
844: "superfluous %s argument",
845: mdoc_argnames[MDOC_Width]));
846: case (MDOC_Tag):
847: if (-1 != width)
848: break;
849: return(mdoc_nwarn(mdoc, n, WARN_SYNTAX,
850: "suggest %s argument",
851: mdoc_argnames[MDOC_Width]));
852: default:
853: break;
854: }
855:
856: return(1);
857: }
858:
859:
860: static int
861: pre_bd(PRE_ARGS)
862: {
863: int i, type, err;
864:
865: if (MDOC_BLOCK != n->type)
866: return(1);
867: if (NULL == n->args)
868: return(nerr(mdoc, n, EDISPTYPE));
869:
870: /* Make sure that only one type of display is specified. */
871:
872: /* LINTED */
873: for (i = 0, err = type = 0; ! err &&
874: i < (int)n->args->argc; i++)
875: switch (n->args->argv[i].arg) {
876: case (MDOC_Ragged):
877: /* FALLTHROUGH */
878: case (MDOC_Unfilled):
879: /* FALLTHROUGH */
880: case (MDOC_Filled):
881: /* FALLTHROUGH */
882: case (MDOC_Literal):
883: /* FALLTHROUGH */
884: case (MDOC_File):
885: if (0 == type++)
886: break;
887: return(nerr(mdoc, n, EMULTIDISP));
888: default:
889: break;
890: }
891:
892: if (type)
893: return(1);
894: return(nerr(mdoc, n, EDISPTYPE));
895: }
896:
897:
898: static int
899: pre_ss(PRE_ARGS)
900: {
901:
902: if (MDOC_BLOCK != n->type)
903: return(1);
904: return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
905: }
906:
907:
908: static int
909: pre_sh(PRE_ARGS)
910: {
911:
912: if (MDOC_BLOCK != n->type)
913: return(1);
914: return(check_parent(mdoc, n, -1, MDOC_ROOT));
915: }
916:
917:
918: static int
919: pre_it(PRE_ARGS)
920: {
921:
922: if (MDOC_BLOCK != n->type)
923: return(1);
924: return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
925: }
926:
927:
928: static int
929: pre_an(PRE_ARGS)
930: {
931:
932: if (NULL == n->args || 1 == n->args->argc)
933: return(1);
934: return(mdoc_nerr(mdoc, n, "only one argument allowed"));
935: }
936:
937:
938: static int
939: pre_lb(PRE_ARGS)
940: {
941:
942: return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM));
943: }
944:
945:
946: static int
947: pre_rv(PRE_ARGS)
948: {
949:
950: if ( ! check_msec(mdoc, n, 2, 3, 0))
951: return(0);
952: return(check_stdarg(mdoc, n));
953: }
954:
955:
956: static int
957: pre_ex(PRE_ARGS)
958: {
959:
960: if ( ! check_msec(mdoc, n, 1, 6, 8, 0))
961: return(0);
962: return(check_stdarg(mdoc, n));
963: }
964:
965:
966: static int
967: pre_er(PRE_ARGS)
968: {
969:
970: return(check_msec(mdoc, n, 2, 0));
971: }
972:
973:
974: static int
975: pre_cd(PRE_ARGS)
976: {
977:
978: return(check_msec(mdoc, n, 4, 0));
979: }
980:
981:
982: static int
983: pre_prologue(PRE_ARGS)
984: {
985:
986: return(check_sec(mdoc, n, SEC_PROLOGUE, SEC_CUSTOM));
987: }
988:
989:
990: static int
991: pre_dt(PRE_ARGS)
992: {
993:
994: if (0 == mdoc->meta.date || mdoc->meta.os)
995: if ( ! nwarn(mdoc, n, WPROLOOO))
996: return(0);
997: if (mdoc->meta.title)
998: if ( ! nwarn(mdoc, n, WPROLREP))
999: return(0);
1000: return(1);
1001: }
1002:
1003:
1004: static int
1005: pre_os(PRE_ARGS)
1006: {
1007:
1008: if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
1009: if ( ! nwarn(mdoc, n, WPROLOOO))
1010: return(0);
1011: if (mdoc->meta.os)
1012: if ( ! nwarn(mdoc, n, WPROLREP))
1013: return(0);
1014: return(1);
1015: }
1016:
1017:
1018: static int
1019: pre_dd(PRE_ARGS)
1020: {
1021:
1022: if (mdoc->meta.title || mdoc->meta.os)
1023: if ( ! nwarn(mdoc, n, WPROLOOO))
1024: return(0);
1025: if (mdoc->meta.date)
1026: if ( ! nwarn(mdoc, n, WPROLREP))
1027: return(0);
1028: return(1);
1029: }
1030:
1031:
1032: static int
1033: post_bf(POST_ARGS)
1034: {
1035: char *p;
1036: struct mdoc_node *head;
1037:
1038: if (MDOC_BLOCK != mdoc->last->type)
1039: return(1);
1040:
1041: head = mdoc->last->head;
1042:
1043: if (NULL == mdoc->last->args) {
1044: if (NULL == head->child ||
1045: MDOC_TEXT != head->child->type)
1046: return(mdoc_err(mdoc, "text argument expected"));
1047:
1048: p = head->child->string;
1049: if (0 == strcmp(p, "Em"))
1050: return(1);
1051: else if (0 == strcmp(p, "Li"))
1052: return(1);
1053: else if (0 == strcmp(p, "Sm"))
1054: return(1);
1055: return(mdoc_nerr(mdoc, head->child, "invalid font"));
1056: }
1057:
1058: if (head->child)
1059: return(mdoc_err(mdoc, "one argument expected"));
1060:
1061: return(1);
1062: }
1063:
1064:
1065: static int
1066: post_nm(POST_ARGS)
1067: {
1068:
1069: if (mdoc->last->child)
1070: return(1);
1071: if (mdoc->meta.name)
1072: return(1);
1073: return(verr(mdoc, ENAME));
1074: }
1075:
1076:
1077: static int
1078: post_at(POST_ARGS)
1079: {
1080:
1081: if (NULL == mdoc->last->child)
1082: return(1);
1083: if (MDOC_TEXT != mdoc->last->child->type)
1084: return(verr(mdoc, EATT));
1085: if (mdoc_a2att(mdoc->last->child->string))
1086: return(1);
1087: return(verr(mdoc, EATT));
1088: }
1089:
1090:
1091: static int
1092: post_an(POST_ARGS)
1093: {
1094:
1095: if (mdoc->last->args) {
1096: if (NULL == mdoc->last->child)
1097: return(1);
1098: return(verr(mdoc, ELINE));
1099: }
1100:
1101: if (mdoc->last->child)
1102: return(1);
1103: return(verr(mdoc, ELINE));
1104: }
1105:
1106:
1107: static int
1108: post_args(POST_ARGS)
1109: {
1110:
1111: if (mdoc->last->args)
1112: return(1);
1113: return(verr(mdoc, ELINE));
1114: }
1115:
1116:
1117: static int
1118: post_it(POST_ARGS)
1119: {
1120: int type, i, cols;
1121: struct mdoc_node *n, *c;
1122:
1123: if (MDOC_BLOCK != mdoc->last->type)
1124: return(1);
1125:
1126: n = mdoc->last->parent->parent;
1127: if (NULL == n->args)
1128: return(verr(mdoc, ELISTTYPE));
1129:
1130: /* Some types require block-head, some not. */
1131:
1132: /* LINTED */
1133: for (cols = type = -1, i = 0; -1 == type &&
1134: i < (int)n->args->argc; i++)
1135: switch (n->args->argv[i].arg) {
1136: case (MDOC_Tag):
1137: /* FALLTHROUGH */
1138: case (MDOC_Diag):
1139: /* FALLTHROUGH */
1140: case (MDOC_Hang):
1141: /* FALLTHROUGH */
1142: case (MDOC_Ohang):
1143: /* FALLTHROUGH */
1144: case (MDOC_Inset):
1145: /* FALLTHROUGH */
1146: case (MDOC_Bullet):
1147: /* FALLTHROUGH */
1148: case (MDOC_Dash):
1149: /* FALLTHROUGH */
1150: case (MDOC_Enum):
1151: /* FALLTHROUGH */
1152: case (MDOC_Hyphen):
1153: /* FALLTHROUGH */
1154: case (MDOC_Item):
1155: type = n->args->argv[i].arg;
1156: break;
1157: case (MDOC_Column):
1158: type = n->args->argv[i].arg;
1159: cols = (int)n->args->argv[i].sz;
1160: break;
1161: default:
1162: break;
1163: }
1164:
1165: if (-1 == type)
1166: return(verr(mdoc, ELISTTYPE));
1167:
1168: switch (type) {
1169: case (MDOC_Tag):
1170: if (NULL == mdoc->last->head->child)
1171: if ( ! vwarn(mdoc, WLINE))
1172: return(0);
1173: break;
1174: case (MDOC_Hang):
1175: /* FALLTHROUGH */
1176: case (MDOC_Ohang):
1177: /* FALLTHROUGH */
1178: case (MDOC_Inset):
1179: /* FALLTHROUGH */
1180: case (MDOC_Diag):
1181: if (NULL == mdoc->last->head->child)
1182: if ( ! vwarn(mdoc, WLINE))
1183: return(0);
1184: if (NULL == mdoc->last->body->child)
1185: if ( ! vwarn(mdoc, WMULTILINE))
1186: return(0);
1187: break;
1188: case (MDOC_Bullet):
1189: /* FALLTHROUGH */
1190: case (MDOC_Dash):
1191: /* FALLTHROUGH */
1192: case (MDOC_Enum):
1193: /* FALLTHROUGH */
1194: case (MDOC_Hyphen):
1195: /* FALLTHROUGH */
1196: case (MDOC_Item):
1197: if (mdoc->last->head->child)
1198: if ( ! vwarn(mdoc, WNOLINE))
1199: return(0);
1200: if (NULL == mdoc->last->body->child)
1201: if ( ! vwarn(mdoc, WMULTILINE))
1202: return(0);
1203: break;
1204: case (MDOC_Column):
1205: if (NULL == mdoc->last->head->child)
1206: if ( ! vwarn(mdoc, WLINE))
1207: return(0);
1208: if (mdoc->last->body->child)
1209: if ( ! vwarn(mdoc, WNOMULTILINE))
1210: return(0);
1211: c = mdoc->last->child;
1212: for (i = 0; c && MDOC_HEAD == c->type; c = c->next)
1213: i++;
1214: if (i == cols)
1215: break;
1216: return(mdoc_err(mdoc, "column mismatch (have "
1217: "%d, want %d)", i, cols));
1218: default:
1219: break;
1220: }
1221:
1222: return(1);
1223: }
1224:
1225:
1226: static int
1227: post_bl(POST_ARGS)
1228: {
1229: struct mdoc_node *n;
1230:
1231: if (MDOC_BODY != mdoc->last->type)
1232: return(1);
1233: if (NULL == mdoc->last->child)
1234: return(1);
1235:
1236: /* LINTED */
1237: for (n = mdoc->last->child; n; n = n->next) {
1238: if (MDOC_BLOCK == n->type)
1239: if (MDOC_It == n->tok)
1240: continue;
1241: return(mdoc_nerr(mdoc, n, "bad child of parent %s",
1242: mdoc_macronames[mdoc->last->tok]));
1243: }
1244:
1245: return(1);
1246: }
1247:
1248:
1249: static int
1250: ebool(struct mdoc *mdoc)
1251: {
1252: struct mdoc_node *n;
1253:
1254: /* LINTED */
1255: for (n = mdoc->last->child; n; n = n->next) {
1256: if (MDOC_TEXT != n->type)
1257: break;
1258: if (0 == strcmp(n->string, "on"))
1259: continue;
1260: if (0 == strcmp(n->string, "off"))
1261: continue;
1262: break;
1263: }
1264:
1265: if (NULL == n)
1266: return(1);
1267: return(nerr(mdoc, n, EBOOL));
1268: }
1269:
1270:
1271: static int
1272: post_root(POST_ARGS)
1273: {
1274:
1275: if (NULL == mdoc->first->child)
1276: return(verr(mdoc, ENODATA));
1277: if (SEC_PROLOGUE == mdoc->lastnamed)
1278: return(verr(mdoc, ENOPROLOGUE));
1279:
1280: if (MDOC_BLOCK != mdoc->first->child->type)
1281: return(verr(mdoc, ENODATA));
1282: if (MDOC_Sh != mdoc->first->child->tok)
1283: return(verr(mdoc, ENODATA));
1284:
1285: return(1);
1286: }
1287:
1288:
1289: static int
1290: post_st(POST_ARGS)
1291: {
1292:
1293: if (mdoc_a2st(mdoc->last->child->string))
1294: return(1);
1295: return(vwarn(mdoc, WBADSTAND));
1296: }
1297:
1298:
1299: static int
1300: post_sh(POST_ARGS)
1301: {
1302:
1303: if (MDOC_HEAD == mdoc->last->type)
1304: return(post_sh_head(mdoc));
1305: if (MDOC_BODY == mdoc->last->type)
1306: return(post_sh_body(mdoc));
1307:
1308: return(1);
1309: }
1310:
1311:
1312: static int
1313: post_sh_body(POST_ARGS)
1314: {
1315: struct mdoc_node *n;
1316:
1317: if (SEC_NAME != mdoc->lastnamed)
1318: return(1);
1319:
1320: /*
1321: * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1322: * macros (can have multiple `Nm' and one `Nd'). Note that the
1323: * children of the BODY declaration can also be "text".
1324: */
1325:
1326: if (NULL == (n = mdoc->last->child))
1327: return(vwarn(mdoc, WNAMESECINC));
1328:
1329: for ( ; n && n->next; n = n->next) {
1330: if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1331: continue;
1332: if (MDOC_TEXT == n->type)
1333: continue;
1334: if ( ! vwarn(mdoc, WNAMESECINC))
1335: return(0);
1336: }
1337:
1338: if (MDOC_ELEM == n->type && MDOC_Nd == n->tok)
1339: return(1);
1340: return(vwarn(mdoc, WNAMESECINC));
1341: }
1342:
1343:
1344: static int
1345: post_sh_head(POST_ARGS)
1346: {
1347: char buf[64];
1348: enum mdoc_sec sec;
1349: const struct mdoc_node *n;
1350:
1351: /*
1352: * Process a new section. Sections are either "named" or
1353: * "custom"; custom sections are user-defined, while named ones
1354: * usually follow a conventional order and may only appear in
1355: * certain manual sections.
1356: */
1357:
1358: assert(MDOC_Sh == mdoc->last->tok);
1359:
1360: /* This is just concat() inlined, which is irritating. */
1361:
1362: buf[0] = 0;
1363: for (n = mdoc->last->child; n; n = n->next) {
1364: assert(MDOC_TEXT == n->type);
1365: if (strlcat(buf, n->string, 64) >= 64)
1366: return(nerr(mdoc, n, ETOOLONG));
1367: if (NULL == n->next)
1368: continue;
1369: if (strlcat(buf, " ", 64) >= 64)
1370: return(nerr(mdoc, n, ETOOLONG));
1371: }
1372:
1373: sec = mdoc_atosec(buf);
1374:
1375: /* The NAME section should always be first. */
1376:
1377: if (SEC_BODY == mdoc->lastnamed && SEC_NAME != sec)
1378: return(vwarn(mdoc, WSECOOO));
1379: if (SEC_CUSTOM == sec)
1380: return(1);
1381:
1382: /* Check for repeated or out-of-order sections. */
1383:
1384: if (sec == mdoc->lastnamed)
1385: return(vwarn(mdoc, WSECREP));
1386: if (sec < mdoc->lastnamed)
1387: return(vwarn(mdoc, WSECOOO));
1388:
1389: /* Check particular section/manual section conventions. */
1390:
1391: switch (sec) {
1392: case (SEC_LIBRARY):
1393: switch (mdoc->meta.msec) {
1394: case (2):
1395: /* FALLTHROUGH */
1396: case (3):
1397: break;
1398: default:
1399: return(vwarn(mdoc, WWRONGMSEC));
1400: }
1401: break;
1402: default:
1403: break;
1404: }
1405:
1406: return(1);
1407: }
1408:
1409:
1410: static int
1411: pre_fd(PRE_ARGS)
1412: {
1413:
1414: return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM));
1415: }