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