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