![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mdoc_validate.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc|
Return to mdoc_validate.c CVS log | Up to [cvsweb.bsd.lv] / mandoc |
1.3 ! kristaps 1: /* $Id: mdoc_validate.c,v 1.2 2009/03/31 13:50:19 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the
7: * above copyright notice and this permission notice appear in all
8: * copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11: * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12: * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13: * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14: * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15: * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16: * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17: * PERFORMANCE OF THIS SOFTWARE.
18: */
19: #include <sys/types.h>
20:
21: #include <assert.h>
22: #include <ctype.h>
23: #include <stdarg.h>
24: #include <stdlib.h>
1.2 kristaps 25: #include <string.h>
1.1 kristaps 26:
27: #include "libmdoc.h"
28:
29: /* FIXME: .Bl -diag can't have non-text children in HEAD. */
30: /* TODO: ignoring Pp (it's superfluous in some invocations). */
31:
32: #define PRE_ARGS struct mdoc *mdoc, const struct mdoc_node *n
33: #define POST_ARGS struct mdoc *mdoc
34:
35: enum merr {
1.2 kristaps 36: ETOOLONG,
1.1 kristaps 37: EESCAPE,
38: EPRINT,
39: ENODATA,
40: ENOPROLOGUE,
41: ELINE,
42: EATT,
43: ENAME,
44: ELISTTYPE,
45: EDISPTYPE,
46: EMULTIDISP,
47: EMULTILIST,
48: EARGREP,
49: EBOOL,
50: ENESTDISP
51: };
52:
53: enum mwarn {
54: WESCAPE,
55: WWRONGMSEC,
56: WSECOOO,
57: WSECREP,
58: WBADSTAND,
59: WNAMESECINC,
60: WNOMULTILINE,
61: WMULTILINE,
62: WLINE,
63: WNOLINE,
64: WPROLOOO,
65: WPROLREP,
66: WARGVAL,
67: WBADSEC,
68: WBADMSEC
69: };
70:
71: typedef int (*v_pre)(PRE_ARGS);
72: typedef int (*v_post)(POST_ARGS);
73:
74: struct valids {
75: v_pre *pre;
76: v_post *post;
77: };
78:
79: static int pwarn(struct mdoc *, int, int, enum mwarn);
80: static int perr(struct mdoc *, int, int, enum merr);
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);
1.2 kristaps 97: static int count_child(struct mdoc *);
98: static int warn_count(struct mdoc *, const char *,
1.1 kristaps 99: int, const char *, int);
1.2 kristaps 100: static int err_count(struct mdoc *, const char *,
1.1 kristaps 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:
1.2 kristaps 145: #define vwarn(m, t) nwarn((m), (m)->last, (t))
146: #define verr(m, t) nerr((m), (m)->last, (t))
1.1 kristaps 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:
1.2 kristaps 313: #ifdef __linux__
314: extern size_t strlcat(char *, const char *, size_t);
315: #endif
316:
317:
1.1 kristaps 318: int
319: mdoc_valid_pre(struct mdoc *mdoc,
320: const struct mdoc_node *n)
321: {
322: v_pre *p;
323: int line, pos;
324: const char *tp;
325:
326: if (MDOC_TEXT == n->type) {
327: tp = n->string;
328: line = n->line;
329: pos = n->pos;
330: return(check_text(mdoc, line, pos, tp));
331: }
332:
333: if ( ! check_args(mdoc, n))
334: return(0);
335: if (NULL == mdoc_valids[n->tok].pre)
336: return(1);
337: for (p = mdoc_valids[n->tok].pre; *p; p++)
338: if ( ! (*p)(mdoc, n))
339: return(0);
340: return(1);
341: }
342:
343:
344: int
345: mdoc_valid_post(struct mdoc *mdoc)
346: {
347: v_post *p;
348:
349: /*
350: * This check occurs after the macro's children have been filled
351: * in: postfix validation. Since this happens when we're
352: * rewinding the scope tree, it's possible to have multiple
353: * invocations (as by design, for now), we set bit MDOC_VALID to
354: * indicate that we've validated.
355: */
356:
357: if (MDOC_VALID & mdoc->last->flags)
358: return(1);
359: mdoc->last->flags |= MDOC_VALID;
360:
361: if (MDOC_TEXT == mdoc->last->type)
362: return(1);
363: if (MDOC_ROOT == mdoc->last->type)
364: return(post_root(mdoc));
365:
366: if (NULL == mdoc_valids[mdoc->last->tok].post)
367: return(1);
368: for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
369: if ( ! (*p)(mdoc))
370: return(0);
371:
372: return(1);
373: }
374:
375:
376: static int
377: perr(struct mdoc *m, int line, int pos, enum merr type)
378: {
379: char *p;
380:
381: p = NULL;
382: switch (type) {
1.2 kristaps 383: case (ETOOLONG):
384: p = "text argument too long";
385: break;
1.1 kristaps 386: case (EESCAPE):
387: p = "invalid escape sequence";
388: break;
389: case (EPRINT):
390: p = "invalid character";
391: break;
392: case (ENESTDISP):
393: p = "displays may not be nested";
394: break;
395: case (EBOOL):
396: p = "expected boolean value";
397: break;
398: case (EARGREP):
399: p = "argument repeated";
400: break;
401: case (EMULTIDISP):
402: p = "multiple display types specified";
403: break;
404: case (EMULTILIST):
405: p = "multiple list types specified";
406: break;
407: case (ELISTTYPE):
408: p = "missing list type";
409: break;
410: case (EDISPTYPE):
411: p = "missing display type";
412: break;
413: case (ELINE):
414: p = "expected line arguments";
415: break;
416: case (ENOPROLOGUE):
417: p = "document has no prologue";
418: break;
419: case (ENODATA):
420: p = "document has no data";
421: break;
422: case (EATT):
423: p = "expected valid AT&T symbol";
424: break;
425: case (ENAME):
426: p = "default name not yet set";
427: break;
428: }
429: assert(p);
430: return(mdoc_perr(m, line, pos, p));
431: }
432:
433:
434: static int
435: pwarn(struct mdoc *m, int line, int pos, enum mwarn type)
436: {
437: char *p;
438: enum mdoc_warn c;
439:
440: c = WARN_SYNTAX;
441: p = NULL;
442: switch (type) {
443: case (WBADMSEC):
444: p = "inappropriate manual section";
445: c = WARN_COMPAT;
446: break;
447: case (WBADSEC):
448: p = "inappropriate document section";
449: c = WARN_COMPAT;
450: break;
451: case (WARGVAL):
452: p = "argument value suggested";
453: c = WARN_COMPAT;
454: break;
455: case (WPROLREP):
456: p = "prologue macros repeated";
457: c = WARN_COMPAT;
458: break;
459: case (WPROLOOO):
460: p = "prologue macros out-of-order";
461: c = WARN_COMPAT;
462: break;
463: case (WESCAPE):
464: p = "invalid escape sequence";
465: break;
466: case (WNOLINE):
467: p = "suggested no line arguments";
468: break;
469: case (WLINE):
470: p = "suggested line arguments";
471: break;
472: case (WMULTILINE):
473: p = "suggested multi-line arguments";
474: break;
475: case (WNOMULTILINE):
476: p = "suggested no multi-line arguments";
477: break;
478: case (WWRONGMSEC):
479: p = "document section in wrong manual section";
480: c = WARN_COMPAT;
481: break;
482: case (WSECOOO):
483: p = "document section out of conventional order";
484: break;
485: case (WSECREP):
486: p = "document section repeated";
487: break;
488: case (WBADSTAND):
489: p = "unknown standard";
490: break;
491: case (WNAMESECINC):
492: p = "NAME section contents incomplete/badly-ordered";
493: break;
494: }
495: assert(p);
496: return(mdoc_pwarn(m, line, pos, c, p));
497: }
498:
499:
500:
501: static inline int
502: warn_count(struct mdoc *m, const char *k,
503: int want, const char *v, int has)
504: {
505:
506: return(mdoc_warn(m, WARN_SYNTAX,
507: "suggests %s %s %d (has %d)", v, k, want, has));
508: }
509:
510:
511: static inline int
512: err_count(struct mdoc *m, const char *k,
513: int want, const char *v, int has)
514: {
515:
516: return(mdoc_err(m,
517: "requires %s %s %d (has %d)", v, k, want, has));
518: }
519:
520:
521: static inline int
522: count_child(struct mdoc *mdoc)
523: {
524: int i;
525: struct mdoc_node *n;
526:
527: for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
528: /* Do nothing */ ;
529:
530: return(i);
531: }
532:
533:
534: /*
535: * Build these up with macros because they're basically the same check
536: * for different inequalities. Yes, this could be done with functions,
537: * but this is reasonable for now.
538: */
539:
540: #define CHECK_CHILD_DEFN(lvl, name, ineq) \
541: static int \
542: lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \
543: { \
544: int i; \
545: if ((i = count_child(mdoc)) ineq sz) \
546: return(1); \
547: return(lvl##_count(mdoc, #ineq, sz, p, i)); \
548: }
549:
550: #define CHECK_BODY_DEFN(name, lvl, func, num) \
551: static int \
552: b##lvl##_##name(POST_ARGS) \
553: { \
554: if (MDOC_BODY != mdoc->last->type) \
555: return(1); \
556: return(func(mdoc, "multi-line arguments", (num))); \
557: }
558:
559: #define CHECK_ELEM_DEFN(name, lvl, func, num) \
560: static int \
561: e##lvl##_##name(POST_ARGS) \
562: { \
563: assert(MDOC_ELEM == mdoc->last->type); \
564: return(func(mdoc, "line arguments", (num))); \
565: }
566:
567: #define CHECK_HEAD_DEFN(name, lvl, func, num) \
568: static int \
569: h##lvl##_##name(POST_ARGS) \
570: { \
571: if (MDOC_HEAD != mdoc->last->type) \
572: return(1); \
573: return(func(mdoc, "line arguments", (num))); \
574: }
575:
576:
577: CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */
578: CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */
579: CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */
580: CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */
581: CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */
582: CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */
583: CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */
584: CHECK_ELEM_DEFN(eq1, warn, warn_child_eq, 1) /* ewarn_eq1() */
585: CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0) /* ewarn_eq0() */
586: CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_gt1() */
587: CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */
588: CHECK_ELEM_DEFN(le2, err, err_child_lt, 3) /* eerr_le2() */
589: CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */
590: CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */
591: CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */
592: CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2) /* hwarn_le1() */
593: CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */
594: CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1) /* hwarn_eq1() */
595:
596:
597: static int
598: check_stdarg(PRE_ARGS)
599: {
600:
601: if (n->args && 1 == n->args->argc)
602: if (MDOC_Std == n->args->argv[0].arg)
603: return(1);
604: return(nwarn(mdoc, n, WARGVAL));
605: }
606:
607:
608: static int
609: check_sec(PRE_ARGS, ...)
610: {
611: enum mdoc_sec sec;
612: va_list ap;
613:
614: va_start(ap, n);
615:
616: for (;;) {
617: /* LINTED */
618: sec = (enum mdoc_sec)va_arg(ap, int);
619: if (SEC_CUSTOM == sec)
620: break;
621: if (sec != mdoc->lastsec)
622: continue;
623: va_end(ap);
624: return(1);
625: }
626:
627: va_end(ap);
628: return(nwarn(mdoc, n, WBADSEC));
629: }
630:
631:
632: static int
633: check_msec(PRE_ARGS, ...)
634: {
635: va_list ap;
636: int msec;
637:
638: va_start(ap, n);
639: for (;;) {
640: /* LINTED */
641: if (0 == (msec = va_arg(ap, int)))
642: break;
643: if (msec != mdoc->meta.msec)
644: continue;
645: va_end(ap);
646: return(1);
647: }
648:
649: va_end(ap);
650: return(nwarn(mdoc, n, WBADMSEC));
651: }
652:
653:
654: static int
655: check_args(struct mdoc *m, const struct mdoc_node *n)
656: {
657: int i;
658:
659: if (NULL == n->args)
660: return(1);
661:
662: assert(n->args->argc);
663: for (i = 0; i < (int)n->args->argc; i++)
664: if ( ! check_argv(m, n, &n->args->argv[i]))
665: return(0);
666:
667: return(1);
668: }
669:
670:
671: static int
672: check_argv(struct mdoc *m, const struct mdoc_node *n,
673: const struct mdoc_argv *v)
674: {
675: int i;
676:
677: for (i = 0; i < (int)v->sz; i++)
678: if ( ! check_text(m, v->line, v->pos, v->value[i]))
679: return(0);
680:
681: if (MDOC_Std == v->arg) {
682: /* `Nm' name must be set. */
683: if (v->sz || m->meta.name)
684: return(1);
685: return(nerr(m, n, ENAME));
686: }
687:
688: return(1);
689: }
690:
691:
692: static int
693: check_text(struct mdoc *mdoc, int line, int pos, const char *p)
694: {
695: size_t c;
696:
697: /* FIXME: indicate deprecated escapes \*(xx and \*x. */
698:
699: for ( ; *p; p++) {
700: if ('\t' == *p) {
701: if ( ! (MDOC_LITERAL & mdoc->flags))
702: return(perr(mdoc, line, pos, EPRINT));
703: } else if ( ! isprint((u_char)*p))
704: return(perr(mdoc, line, pos, EPRINT));
705:
706: if ('\\' != *p)
707: continue;
708:
709: c = mdoc_isescape(p);
710: if (c) {
711: p += (int)c - 1;
712: continue;
713: }
714: if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags))
715: return(perr(mdoc, line, pos, EESCAPE));
716: if ( ! pwarn(mdoc, line, pos, WESCAPE))
717: return(0);
718: }
719:
720: return(1);
721: }
722:
723:
724:
725:
726: static int
727: check_parent(PRE_ARGS, int tok, enum mdoc_type t)
728: {
729:
730: assert(n->parent);
731: if ((MDOC_ROOT == t || tok == n->parent->tok) &&
732: (t == n->parent->type))
733: return(1);
734:
735: return(mdoc_nerr(mdoc, n, "require parent %s",
736: MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
737: }
738:
739:
740:
741: static int
742: pre_display(PRE_ARGS)
743: {
744: struct mdoc_node *node;
745:
746: /* Display elements (`Bd', `D1'...) cannot be nested. */
747:
748: if (MDOC_BLOCK != n->type)
749: return(1);
750:
751: /* LINTED */
752: for (node = mdoc->last->parent; node; node = node->parent)
753: if (MDOC_BLOCK == node->type)
754: if (MDOC_Bd == node->tok)
755: break;
756: if (NULL == node)
757: return(1);
758:
759: return(nerr(mdoc, n, ENESTDISP));
760: }
761:
762:
763: static int
764: pre_bl(PRE_ARGS)
765: {
766: int i, type, width, offset;
767:
768: if (MDOC_BLOCK != n->type)
769: return(1);
770: if (NULL == n->args)
771: return(nerr(mdoc, n, ELISTTYPE));
772:
773: /* Make sure that only one type of list is specified. */
774:
775: type = offset = width = -1;
776:
777: /* LINTED */
778: for (i = 0; i < (int)n->args->argc; i++)
779: switch (n->args->argv[i].arg) {
780: case (MDOC_Bullet):
781: /* FALLTHROUGH */
782: case (MDOC_Dash):
783: /* FALLTHROUGH */
784: case (MDOC_Enum):
785: /* FALLTHROUGH */
786: case (MDOC_Hyphen):
787: /* FALLTHROUGH */
788: case (MDOC_Item):
789: /* FALLTHROUGH */
790: case (MDOC_Tag):
791: /* FALLTHROUGH */
792: case (MDOC_Diag):
793: /* FALLTHROUGH */
794: case (MDOC_Hang):
795: /* FALLTHROUGH */
796: case (MDOC_Ohang):
797: /* FALLTHROUGH */
798: case (MDOC_Inset):
799: /* FALLTHROUGH */
800: case (MDOC_Column):
801: if (-1 == type) {
802: type = n->args->argv[i].arg;
803: break;
804: }
805: return(nerr(mdoc, n, EMULTILIST));
806: case (MDOC_Width):
807: if (-1 == width) {
808: width = n->args->argv[i].arg;
809: break;
810: }
811: return(nerr(mdoc, n, EARGREP));
812: case (MDOC_Offset):
813: if (-1 == offset) {
814: offset = n->args->argv[i].arg;
815: break;
816: }
817: return(nerr(mdoc, n, EARGREP));
818: default:
819: break;
820: }
821:
822: if (-1 == type)
823: return(nerr(mdoc, n, ELISTTYPE));
824:
825: switch (type) {
826: case (MDOC_Column):
827: /* FALLTHROUGH */
828: case (MDOC_Diag):
829: /* FALLTHROUGH */
830: case (MDOC_Inset):
831: /* FALLTHROUGH */
832: case (MDOC_Item):
833: if (-1 == width)
834: break;
835: return(mdoc_nwarn(mdoc, n, WARN_SYNTAX,
836: "superfluous %s argument",
837: mdoc_argnames[MDOC_Width]));
838: case (MDOC_Tag):
839: if (-1 != width)
840: break;
841: return(mdoc_nwarn(mdoc, n, WARN_SYNTAX,
842: "suggest %s argument",
843: mdoc_argnames[MDOC_Width]));
844: default:
845: break;
846: }
847:
848: return(1);
849: }
850:
851:
852: static int
853: pre_bd(PRE_ARGS)
854: {
855: int i, type, err;
856:
857: if (MDOC_BLOCK != n->type)
858: return(1);
859: if (NULL == n->args)
860: return(nerr(mdoc, n, EDISPTYPE));
861:
862: /* Make sure that only one type of display is specified. */
863:
864: /* LINTED */
865: for (i = 0, err = type = 0; ! err &&
866: i < (int)n->args->argc; i++)
867: switch (n->args->argv[i].arg) {
868: case (MDOC_Ragged):
869: /* FALLTHROUGH */
870: case (MDOC_Unfilled):
871: /* FALLTHROUGH */
872: case (MDOC_Filled):
873: /* FALLTHROUGH */
874: case (MDOC_Literal):
875: /* FALLTHROUGH */
876: case (MDOC_File):
877: if (0 == type++)
878: break;
879: return(nerr(mdoc, n, EMULTIDISP));
880: default:
881: break;
882: }
883:
884: if (type)
885: return(1);
886: return(nerr(mdoc, n, EDISPTYPE));
887: }
888:
889:
890: static int
891: pre_ss(PRE_ARGS)
892: {
893:
894: if (MDOC_BLOCK != n->type)
895: return(1);
896: return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
897: }
898:
899:
900: static int
901: pre_sh(PRE_ARGS)
902: {
903:
904: if (MDOC_BLOCK != n->type)
905: return(1);
906: return(check_parent(mdoc, n, -1, MDOC_ROOT));
907: }
908:
909:
910: static int
911: pre_it(PRE_ARGS)
912: {
913:
914: if (MDOC_BLOCK != n->type)
915: return(1);
916: return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
917: }
918:
919:
920: static int
921: pre_an(PRE_ARGS)
922: {
923:
924: if (NULL == n->args || 1 == n->args->argc)
925: return(1);
926: return(mdoc_nerr(mdoc, n, "only one argument allowed"));
927: }
928:
929:
930: static int
931: pre_lb(PRE_ARGS)
932: {
933:
934: return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM));
935: }
936:
937:
938: static int
939: pre_rv(PRE_ARGS)
940: {
941:
942: if ( ! check_msec(mdoc, n, 2, 3, 0))
943: return(0);
944: return(check_stdarg(mdoc, n));
945: }
946:
947:
948: static int
949: pre_ex(PRE_ARGS)
950: {
951:
952: if ( ! check_msec(mdoc, n, 1, 6, 8, 0))
953: return(0);
954: return(check_stdarg(mdoc, n));
955: }
956:
957:
958: static int
959: pre_er(PRE_ARGS)
960: {
961:
962: return(check_msec(mdoc, n, 2, 0));
963: }
964:
965:
966: static int
967: pre_cd(PRE_ARGS)
968: {
969:
970: return(check_msec(mdoc, n, 4, 0));
971: }
972:
973:
974: static int
975: pre_prologue(PRE_ARGS)
976: {
977:
978: return(check_sec(mdoc, n, SEC_PROLOGUE, SEC_CUSTOM));
979: }
980:
981:
982: static int
983: pre_dt(PRE_ARGS)
984: {
985:
986: if (0 == mdoc->meta.date || mdoc->meta.os)
987: if ( ! nwarn(mdoc, n, WPROLOOO))
988: return(0);
989: if (mdoc->meta.title)
990: if ( ! nwarn(mdoc, n, WPROLREP))
991: return(0);
992: return(1);
993: }
994:
995:
996: static int
997: pre_os(PRE_ARGS)
998: {
999:
1000: if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
1001: if ( ! nwarn(mdoc, n, WPROLOOO))
1002: return(0);
1003: if (mdoc->meta.os)
1004: if ( ! nwarn(mdoc, n, WPROLREP))
1005: return(0);
1006: return(1);
1007: }
1008:
1009:
1010: static int
1011: pre_dd(PRE_ARGS)
1012: {
1013:
1014: if (mdoc->meta.title || mdoc->meta.os)
1015: if ( ! nwarn(mdoc, n, WPROLOOO))
1016: return(0);
1017: if (mdoc->meta.date)
1018: if ( ! nwarn(mdoc, n, WPROLREP))
1019: return(0);
1020: return(1);
1021: }
1022:
1023:
1024: static int
1025: post_bf(POST_ARGS)
1026: {
1027: char *p;
1028: struct mdoc_node *head;
1029:
1030: if (MDOC_BLOCK != mdoc->last->type)
1031: return(1);
1032:
1033: head = mdoc->last->head;
1034:
1035: if (NULL == mdoc->last->args) {
1036: if (NULL == head->child ||
1037: MDOC_TEXT != head->child->type)
1038: return(mdoc_err(mdoc, "text argument expected"));
1039:
1040: p = head->child->string;
1.2 kristaps 1041: if (0 == strcmp(p, "Em"))
1.1 kristaps 1042: return(1);
1.2 kristaps 1043: else if (0 == strcmp(p, "Li"))
1.1 kristaps 1044: return(1);
1.2 kristaps 1045: else if (0 == strcmp(p, "Sm"))
1.1 kristaps 1046: return(1);
1047: return(mdoc_nerr(mdoc, head->child, "invalid font"));
1048: }
1049:
1050: if (head->child)
1051: return(mdoc_err(mdoc, "one argument expected"));
1052:
1053: return(1);
1054: }
1055:
1056:
1057: static int
1058: post_nm(POST_ARGS)
1059: {
1060:
1061: if (mdoc->last->child)
1062: return(1);
1063: if (mdoc->meta.name)
1064: return(1);
1.2 kristaps 1065: return(verr(mdoc, ENAME));
1.1 kristaps 1066: }
1067:
1068:
1069: static int
1070: post_at(POST_ARGS)
1071: {
1072:
1073: if (NULL == mdoc->last->child)
1074: return(1);
1075: if (MDOC_TEXT != mdoc->last->child->type)
1.2 kristaps 1076: return(verr(mdoc, EATT));
1.1 kristaps 1077: if (mdoc_a2att(mdoc->last->child->string))
1078: return(1);
1.2 kristaps 1079: return(verr(mdoc, EATT));
1.1 kristaps 1080: }
1081:
1082:
1083: static int
1084: post_an(POST_ARGS)
1085: {
1086:
1087: if (mdoc->last->args) {
1088: if (NULL == mdoc->last->child)
1089: return(1);
1.2 kristaps 1090: return(verr(mdoc, ELINE));
1.1 kristaps 1091: }
1092:
1093: if (mdoc->last->child)
1094: return(1);
1.2 kristaps 1095: return(verr(mdoc, ELINE));
1.1 kristaps 1096: }
1097:
1098:
1099: static int
1100: post_args(POST_ARGS)
1101: {
1102:
1103: if (mdoc->last->args)
1104: return(1);
1.2 kristaps 1105: return(verr(mdoc, ELINE));
1.1 kristaps 1106: }
1107:
1108:
1109: static int
1110: post_it(POST_ARGS)
1111: {
1112: int type, i, cols;
1113: struct mdoc_node *n, *c;
1114:
1115: if (MDOC_BLOCK != mdoc->last->type)
1116: return(1);
1117:
1118: n = mdoc->last->parent->parent;
1119: if (NULL == n->args)
1.2 kristaps 1120: return(verr(mdoc, ELISTTYPE));
1.1 kristaps 1121:
1122: /* Some types require block-head, some not. */
1123:
1124: /* LINTED */
1125: for (cols = type = -1, i = 0; -1 == type &&
1126: i < (int)n->args->argc; i++)
1127: switch (n->args->argv[i].arg) {
1128: case (MDOC_Tag):
1129: /* FALLTHROUGH */
1130: case (MDOC_Diag):
1131: /* FALLTHROUGH */
1132: case (MDOC_Hang):
1133: /* FALLTHROUGH */
1134: case (MDOC_Ohang):
1135: /* FALLTHROUGH */
1136: case (MDOC_Inset):
1137: /* FALLTHROUGH */
1138: case (MDOC_Bullet):
1139: /* FALLTHROUGH */
1140: case (MDOC_Dash):
1141: /* FALLTHROUGH */
1142: case (MDOC_Enum):
1143: /* FALLTHROUGH */
1144: case (MDOC_Hyphen):
1145: /* FALLTHROUGH */
1146: case (MDOC_Item):
1147: type = n->args->argv[i].arg;
1148: break;
1149: case (MDOC_Column):
1150: type = n->args->argv[i].arg;
1151: cols = (int)n->args->argv[i].sz;
1152: break;
1153: default:
1154: break;
1155: }
1156:
1157: if (-1 == type)
1.2 kristaps 1158: return(verr(mdoc, ELISTTYPE));
1.1 kristaps 1159:
1160: switch (type) {
1161: case (MDOC_Tag):
1162: if (NULL == mdoc->last->head->child)
1.2 kristaps 1163: if ( ! vwarn(mdoc, WLINE))
1.1 kristaps 1164: return(0);
1165: break;
1166: case (MDOC_Hang):
1167: /* FALLTHROUGH */
1168: case (MDOC_Ohang):
1169: /* FALLTHROUGH */
1170: case (MDOC_Inset):
1171: /* FALLTHROUGH */
1172: case (MDOC_Diag):
1173: if (NULL == mdoc->last->head->child)
1.2 kristaps 1174: if ( ! vwarn(mdoc, WLINE))
1.1 kristaps 1175: return(0);
1176: if (NULL == mdoc->last->body->child)
1.2 kristaps 1177: if ( ! vwarn(mdoc, WMULTILINE))
1.1 kristaps 1178: return(0);
1179: break;
1180: case (MDOC_Bullet):
1181: /* FALLTHROUGH */
1182: case (MDOC_Dash):
1183: /* FALLTHROUGH */
1184: case (MDOC_Enum):
1185: /* FALLTHROUGH */
1186: case (MDOC_Hyphen):
1187: /* FALLTHROUGH */
1188: case (MDOC_Item):
1189: if (mdoc->last->head->child)
1.2 kristaps 1190: if ( ! vwarn(mdoc, WNOLINE))
1.1 kristaps 1191: return(0);
1192: if (NULL == mdoc->last->body->child)
1.2 kristaps 1193: if ( ! vwarn(mdoc, WMULTILINE))
1.1 kristaps 1194: return(0);
1195: break;
1196: case (MDOC_Column):
1197: if (NULL == mdoc->last->head->child)
1.2 kristaps 1198: if ( ! vwarn(mdoc, WLINE))
1.1 kristaps 1199: return(0);
1200: if (mdoc->last->body->child)
1.2 kristaps 1201: if ( ! vwarn(mdoc, WNOMULTILINE))
1.1 kristaps 1202: return(0);
1203: c = mdoc->last->child;
1204: for (i = 0; c && MDOC_HEAD == c->type; c = c->next)
1205: i++;
1206: if (i == cols)
1207: break;
1208: return(mdoc_err(mdoc, "column mismatch (have "
1209: "%d, want %d)", i, cols));
1210: default:
1211: break;
1212: }
1213:
1214: return(1);
1215: }
1216:
1217:
1218: static int
1219: post_bl(POST_ARGS)
1220: {
1221: struct mdoc_node *n;
1222:
1223: if (MDOC_BODY != mdoc->last->type)
1224: return(1);
1225: if (NULL == mdoc->last->child)
1226: return(1);
1227:
1228: /* LINTED */
1229: for (n = mdoc->last->child; n; n = n->next) {
1230: if (MDOC_BLOCK == n->type)
1231: if (MDOC_It == n->tok)
1232: continue;
1233: return(mdoc_nerr(mdoc, n, "bad child of parent %s",
1234: mdoc_macronames[mdoc->last->tok]));
1235: }
1236:
1237: return(1);
1238: }
1239:
1240:
1241: static int
1242: ebool(struct mdoc *mdoc)
1243: {
1244: struct mdoc_node *n;
1245:
1246: /* LINTED */
1247: for (n = mdoc->last->child; n; n = n->next) {
1248: if (MDOC_TEXT != n->type)
1249: break;
1.2 kristaps 1250: if (0 == strcmp(n->string, "on"))
1.1 kristaps 1251: continue;
1.2 kristaps 1252: if (0 == strcmp(n->string, "off"))
1.1 kristaps 1253: continue;
1254: break;
1255: }
1256:
1257: if (NULL == n)
1258: return(1);
1259: return(nerr(mdoc, n, EBOOL));
1260: }
1261:
1262:
1263: static int
1264: post_root(POST_ARGS)
1265: {
1266:
1267: if (NULL == mdoc->first->child)
1.2 kristaps 1268: return(verr(mdoc, ENODATA));
1.1 kristaps 1269: if (SEC_PROLOGUE == mdoc->lastnamed)
1.2 kristaps 1270: return(verr(mdoc, ENOPROLOGUE));
1.1 kristaps 1271:
1272: if (MDOC_BLOCK != mdoc->first->child->type)
1.2 kristaps 1273: return(verr(mdoc, ENODATA));
1.1 kristaps 1274: if (MDOC_Sh != mdoc->first->child->tok)
1.2 kristaps 1275: return(verr(mdoc, ENODATA));
1.1 kristaps 1276:
1277: return(1);
1278: }
1279:
1280:
1281: static int
1282: post_st(POST_ARGS)
1283: {
1284:
1285: if (mdoc_a2st(mdoc->last->child->string))
1286: return(1);
1.2 kristaps 1287: return(vwarn(mdoc, WBADSTAND));
1.1 kristaps 1288: }
1289:
1290:
1291: static int
1292: post_sh(POST_ARGS)
1293: {
1294:
1295: if (MDOC_HEAD == mdoc->last->type)
1296: return(post_sh_head(mdoc));
1297: if (MDOC_BODY == mdoc->last->type)
1298: return(post_sh_body(mdoc));
1299:
1300: return(1);
1301: }
1302:
1303:
1304: static int
1305: post_sh_body(POST_ARGS)
1306: {
1307: struct mdoc_node *n;
1308:
1309: if (SEC_NAME != mdoc->lastnamed)
1310: return(1);
1311:
1312: /*
1313: * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1314: * macros (can have multiple `Nm' and one `Nd'). Note that the
1315: * children of the BODY declaration can also be "text".
1316: */
1317:
1318: if (NULL == (n = mdoc->last->child))
1.2 kristaps 1319: return(vwarn(mdoc, WNAMESECINC));
1.1 kristaps 1320:
1321: for ( ; n && n->next; n = n->next) {
1322: if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1323: continue;
1324: if (MDOC_TEXT == n->type)
1325: continue;
1.2 kristaps 1326: if ( ! vwarn(mdoc, WNAMESECINC))
1.1 kristaps 1327: return(0);
1328: }
1329:
1330: if (MDOC_ELEM == n->type && MDOC_Nd == n->tok)
1331: return(1);
1.2 kristaps 1332: return(vwarn(mdoc, WNAMESECINC));
1.1 kristaps 1333: }
1334:
1335:
1336: static int
1337: post_sh_head(POST_ARGS)
1338: {
1.2 kristaps 1339: char buf[64];
1340: enum mdoc_sec sec;
1341: const struct mdoc_node *n;
1.1 kristaps 1342:
1343: /*
1344: * Process a new section. Sections are either "named" or
1345: * "custom"; custom sections are user-defined, while named ones
1346: * usually follow a conventional order and may only appear in
1347: * certain manual sections.
1348: */
1349:
1350: assert(MDOC_Sh == mdoc->last->tok);
1351:
1.2 kristaps 1352: /* This is just concat() inlined, which is irritating. */
1353:
1.3 ! kristaps 1354: buf[0] = 0;
1.2 kristaps 1355: for (n = mdoc->last->child; n; n = n->next) {
1356: assert(MDOC_TEXT == n->type);
1357: if (strlcat(buf, n->string, 64) >= 64)
1358: return(nerr(mdoc, n, ETOOLONG));
1359: if (NULL == n->next)
1360: continue;
1361: if (strlcat(buf, " ", 64) >= 64)
1362: return(nerr(mdoc, n, ETOOLONG));
1363: }
1.1 kristaps 1364:
1365: sec = mdoc_atosec(buf);
1366:
1367: /* The NAME section should always be first. */
1368:
1369: if (SEC_BODY == mdoc->lastnamed && SEC_NAME != sec)
1.2 kristaps 1370: return(vwarn(mdoc, WSECOOO));
1.1 kristaps 1371: if (SEC_CUSTOM == sec)
1372: return(1);
1373:
1374: /* Check for repeated or out-of-order sections. */
1375:
1376: if (sec == mdoc->lastnamed)
1.2 kristaps 1377: return(vwarn(mdoc, WSECREP));
1.1 kristaps 1378: if (sec < mdoc->lastnamed)
1.2 kristaps 1379: return(vwarn(mdoc, WSECOOO));
1.1 kristaps 1380:
1381: /* Check particular section/manual section conventions. */
1382:
1383: switch (sec) {
1384: case (SEC_LIBRARY):
1385: switch (mdoc->meta.msec) {
1386: case (2):
1387: /* FALLTHROUGH */
1388: case (3):
1389: break;
1390: default:
1.2 kristaps 1391: return(vwarn(mdoc, WWRONGMSEC));
1.1 kristaps 1392: }
1393: break;
1394: default:
1395: break;
1396: }
1397:
1398: return(1);
1399: }
1400:
1401:
1402: static int
1403: pre_fd(PRE_ARGS)
1404: {
1405:
1406: return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM));
1407: }