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