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