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