Annotation of mandoc/mdoc_validate.c, Revision 1.52
1.52 ! kristaps 1: /* $Id: mdoc_validate.c,v 1.51 2009/10/26 04:09:46 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: */
17: #include <sys/types.h>
18:
19: #include <assert.h>
20: #include <ctype.h>
1.35 kristaps 21: #include <limits.h>
1.1 kristaps 22: #include <stdarg.h>
23: #include <stdlib.h>
1.2 kristaps 24: #include <string.h>
1.1 kristaps 25:
26: #include "libmdoc.h"
1.18 kristaps 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.32 kristaps 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.32 kristaps 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.32 kristaps 51: static int check_args(struct mdoc *,
1.1 kristaps 52: const struct mdoc_node *);
1.32 kristaps 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.32 kristaps 62: static int err_count(struct mdoc *, const char *,
1.1 kristaps 63: int, const char *, int);
1.32 kristaps 64:
65: #ifdef __linux__
66: extern size_t strlcat(char *, const char *, size_t);
67: #endif
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);
75: static int eerr_le2(POST_ARGS);
1.46 kristaps 76: static int eerr_le1(POST_ARGS);
1.32 kristaps 77: static int ewarn_ge1(POST_ARGS);
78: static int herr_eq0(POST_ARGS);
79: static int herr_ge1(POST_ARGS);
80: static int hwarn_eq1(POST_ARGS);
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);
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.32 kristaps 133: static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
134: static v_post posts_wtext[] = { ewarn_ge1, NULL };
135: static v_post posts_xr[] = { eerr_ge1, eerr_le2, NULL };
136: static v_pre pres_an[] = { pre_an, NULL };
137: static v_pre pres_bd[] = { pre_display, pre_bd, NULL };
138: static v_pre pres_bl[] = { pre_bl, NULL };
139: static v_pre pres_cd[] = { pre_cd, NULL };
140: static v_pre pres_d1[] = { pre_display, NULL };
141: static v_pre pres_dd[] = { pre_dd, NULL };
142: static v_pre pres_dt[] = { pre_dt, NULL };
143: static v_pre pres_er[] = { pre_er, NULL };
144: static v_pre pres_ex[] = { pre_ex, NULL };
145: static v_pre pres_fd[] = { pre_fd, NULL };
146: static v_pre pres_it[] = { pre_it, NULL };
147: static v_pre pres_lb[] = { pre_lb, NULL };
148: static v_pre pres_os[] = { pre_os, NULL };
149: static v_pre pres_rv[] = { pre_rv, NULL };
150: static v_pre pres_sh[] = { pre_sh, NULL };
151: static v_pre pres_ss[] = { pre_ss, NULL };
1.1 kristaps 152:
153: const struct valids mdoc_valids[MDOC_MAX] = {
1.10 kristaps 154: { NULL, NULL }, /* Ap */
1.1 kristaps 155: { pres_dd, posts_text }, /* Dd */
156: { pres_dt, NULL }, /* Dt */
157: { pres_os, NULL }, /* Os */
158: { pres_sh, posts_sh }, /* Sh */
159: { pres_ss, posts_ss }, /* Ss */
1.34 kristaps 160: { NULL, posts_notext }, /* Pp */
1.1 kristaps 161: { pres_d1, posts_wline }, /* D1 */
162: { pres_d1, posts_wline }, /* Dl */
163: { pres_bd, posts_bd }, /* Bd */
164: { NULL, NULL }, /* Ed */
165: { pres_bl, posts_bl }, /* Bl */
166: { NULL, NULL }, /* El */
167: { pres_it, posts_it }, /* It */
168: { NULL, posts_text }, /* Ad */
169: { pres_an, posts_an }, /* An */
170: { NULL, NULL }, /* Ar */
171: { pres_cd, posts_text }, /* Cd */
172: { NULL, NULL }, /* Cm */
173: { NULL, NULL }, /* Dv */
174: { pres_er, posts_text }, /* Er */
175: { NULL, NULL }, /* Ev */
1.42 kristaps 176: { pres_ex, NULL }, /* Ex */
1.1 kristaps 177: { NULL, NULL }, /* Fa */
178: { pres_fd, posts_wtext }, /* Fd */
179: { NULL, NULL }, /* Fl */
180: { NULL, posts_text }, /* Fn */
181: { NULL, posts_wtext }, /* Ft */
182: { NULL, posts_text }, /* Ic */
1.51 kristaps 183: { NULL, posts_text1 }, /* In */
1.1 kristaps 184: { NULL, NULL }, /* Li */
1.27 kristaps 185: { NULL, posts_nd }, /* Nd */
1.1 kristaps 186: { NULL, posts_nm }, /* Nm */
187: { NULL, posts_wline }, /* Op */
188: { NULL, NULL }, /* Ot */
189: { NULL, NULL }, /* Pa */
1.42 kristaps 190: { pres_rv, NULL }, /* Rv */
1.1 kristaps 191: { NULL, posts_st }, /* St */
192: { NULL, NULL }, /* Va */
193: { NULL, posts_text }, /* Vt */
194: { NULL, posts_xr }, /* Xr */
195: { NULL, posts_text }, /* %A */
1.47 kristaps 196: { NULL, posts_text }, /* %B */ /* FIXME: can be used outside Rs/Re. */
1.1 kristaps 197: { NULL, posts_text }, /* %D */
198: { NULL, posts_text }, /* %I */
199: { NULL, posts_text }, /* %J */
200: { NULL, posts_text }, /* %N */
201: { NULL, posts_text }, /* %O */
202: { NULL, posts_text }, /* %P */
203: { NULL, posts_text }, /* %R */
1.47 kristaps 204: { NULL, posts_text }, /* %T */ /* FIXME: can be used outside Rs/Re. */
1.1 kristaps 205: { NULL, posts_text }, /* %V */
206: { NULL, NULL }, /* Ac */
207: { NULL, NULL }, /* Ao */
208: { NULL, posts_wline }, /* Aq */
209: { NULL, posts_at }, /* At */
210: { NULL, NULL }, /* Bc */
211: { NULL, posts_bf }, /* Bf */
212: { NULL, NULL }, /* Bo */
213: { NULL, posts_wline }, /* Bq */
214: { NULL, NULL }, /* Bsx */
215: { NULL, NULL }, /* Bx */
216: { NULL, posts_bool }, /* Db */
217: { NULL, NULL }, /* Dc */
218: { NULL, NULL }, /* Do */
219: { NULL, posts_wline }, /* Dq */
220: { NULL, NULL }, /* Ec */
221: { NULL, NULL }, /* Ef */
222: { NULL, NULL }, /* Em */
223: { NULL, NULL }, /* Eo */
224: { NULL, NULL }, /* Fx */
225: { NULL, posts_text }, /* Ms */
226: { NULL, posts_notext }, /* No */
227: { NULL, posts_notext }, /* Ns */
228: { NULL, NULL }, /* Nx */
229: { NULL, NULL }, /* Ox */
230: { NULL, NULL }, /* Pc */
1.51 kristaps 231: { NULL, posts_text1 }, /* Pf */
1.1 kristaps 232: { NULL, NULL }, /* Po */
233: { NULL, posts_wline }, /* Pq */
234: { NULL, NULL }, /* Qc */
235: { NULL, posts_wline }, /* Ql */
236: { NULL, NULL }, /* Qo */
237: { NULL, posts_wline }, /* Qq */
238: { NULL, NULL }, /* Re */
1.43 kristaps 239: { NULL, posts_rs }, /* Rs */
1.1 kristaps 240: { NULL, NULL }, /* Sc */
241: { NULL, NULL }, /* So */
242: { NULL, posts_wline }, /* Sq */
243: { NULL, posts_bool }, /* Sm */
244: { NULL, posts_text }, /* Sx */
245: { NULL, posts_text }, /* Sy */
246: { NULL, posts_text }, /* Tn */
247: { NULL, NULL }, /* Ux */
248: { NULL, NULL }, /* Xc */
249: { NULL, NULL }, /* Xo */
250: { NULL, posts_fo }, /* Fo */
251: { NULL, NULL }, /* Fc */
252: { NULL, NULL }, /* Oo */
253: { NULL, NULL }, /* Oc */
254: { NULL, posts_wline }, /* Bk */
255: { NULL, NULL }, /* Ek */
256: { NULL, posts_notext }, /* Bt */
257: { NULL, NULL }, /* Hf */
258: { NULL, NULL }, /* Fr */
259: { NULL, posts_notext }, /* Ud */
260: { pres_lb, posts_lb }, /* Lb */
1.34 kristaps 261: { NULL, posts_notext }, /* Lp */
1.51 kristaps 262: { NULL, posts_text }, /* Lk */
1.1 kristaps 263: { NULL, posts_text }, /* Mt */
264: { NULL, posts_wline }, /* Brq */
265: { NULL, NULL }, /* Bro */
266: { NULL, NULL }, /* Brc */
267: { NULL, posts_text }, /* %C */
268: { NULL, NULL }, /* Es */
269: { NULL, NULL }, /* En */
270: { NULL, NULL }, /* Dx */
271: { NULL, posts_text }, /* %Q */
1.33 kristaps 272: { NULL, posts_notext }, /* br */
1.35 kristaps 273: { NULL, posts_sp }, /* sp */
1.51 kristaps 274: { NULL, posts_text1 }, /* %U */
1.1 kristaps 275: };
276:
277:
278: int
1.32 kristaps 279: mdoc_valid_pre(struct mdoc *mdoc, const struct mdoc_node *n)
1.1 kristaps 280: {
281: v_pre *p;
282: int line, pos;
283: const char *tp;
284:
285: if (MDOC_TEXT == n->type) {
286: tp = n->string;
287: line = n->line;
288: pos = n->pos;
289: return(check_text(mdoc, line, pos, tp));
290: }
291:
292: if ( ! check_args(mdoc, n))
293: return(0);
294: if (NULL == mdoc_valids[n->tok].pre)
295: return(1);
296: for (p = mdoc_valids[n->tok].pre; *p; p++)
297: if ( ! (*p)(mdoc, n))
298: return(0);
299: return(1);
300: }
301:
302:
303: int
304: mdoc_valid_post(struct mdoc *mdoc)
305: {
306: v_post *p;
307:
308: if (MDOC_VALID & mdoc->last->flags)
309: return(1);
310: mdoc->last->flags |= MDOC_VALID;
311:
312: if (MDOC_TEXT == mdoc->last->type)
313: return(1);
314: if (MDOC_ROOT == mdoc->last->type)
315: return(post_root(mdoc));
316:
317: if (NULL == mdoc_valids[mdoc->last->tok].post)
318: return(1);
319: for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
320: if ( ! (*p)(mdoc))
321: return(0);
322:
323: return(1);
324: }
325:
326:
327: static int
1.4 kristaps 328: warn_print(struct mdoc *m, int ln, int pos)
329: {
1.21 kristaps 330:
1.23 kristaps 331: if (MDOC_IGN_CHARS & m->pflags)
332: return(mdoc_pwarn(m, ln, pos, EPRINT));
333: return(mdoc_perr(m, ln, pos, EPRINT));
1.4 kristaps 334: }
335:
1.1 kristaps 336:
337: static inline int
338: warn_count(struct mdoc *m, const char *k,
339: int want, const char *v, int has)
340: {
341:
1.23 kristaps 342: return(mdoc_vwarn(m, m->last->line, m->last->pos,
343: "suggests %s %s %d (has %d)", v, k, want, has));
1.1 kristaps 344: }
345:
346:
347: static inline int
348: err_count(struct mdoc *m, const char *k,
349: int want, const char *v, int has)
350: {
351:
1.23 kristaps 352: return(mdoc_verr(m, m->last->line, m->last->pos,
1.1 kristaps 353: "requires %s %s %d (has %d)", v, k, want, has));
354: }
355:
356:
357: /*
358: * Build these up with macros because they're basically the same check
359: * for different inequalities. Yes, this could be done with functions,
360: * but this is reasonable for now.
361: */
362:
363: #define CHECK_CHILD_DEFN(lvl, name, ineq) \
364: static int \
365: lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \
366: { \
1.16 kristaps 367: if (mdoc->last->nchild ineq sz) \
1.1 kristaps 368: return(1); \
1.16 kristaps 369: return(lvl##_count(mdoc, #ineq, sz, p, mdoc->last->nchild)); \
1.1 kristaps 370: }
371:
372: #define CHECK_BODY_DEFN(name, lvl, func, num) \
373: static int \
374: b##lvl##_##name(POST_ARGS) \
375: { \
376: if (MDOC_BODY != mdoc->last->type) \
377: return(1); \
378: return(func(mdoc, "multi-line arguments", (num))); \
379: }
380:
381: #define CHECK_ELEM_DEFN(name, lvl, func, num) \
382: static int \
383: e##lvl##_##name(POST_ARGS) \
384: { \
385: assert(MDOC_ELEM == mdoc->last->type); \
386: return(func(mdoc, "line arguments", (num))); \
387: }
388:
389: #define CHECK_HEAD_DEFN(name, lvl, func, num) \
390: static int \
391: h##lvl##_##name(POST_ARGS) \
392: { \
393: if (MDOC_HEAD != mdoc->last->type) \
394: return(1); \
395: return(func(mdoc, "line arguments", (num))); \
396: }
397:
398:
399: CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */
400: CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */
401: CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */
402: CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */
403: CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */
404: CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */
405: CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */
1.27 kristaps 406: CHECK_BODY_DEFN(ge1, err, err_child_gt, 0) /* berr_ge1() */
1.1 kristaps 407: CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_gt1() */
408: CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */
409: CHECK_ELEM_DEFN(le2, err, err_child_lt, 3) /* eerr_le2() */
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
550: check_parent(PRE_ARGS, int tok, enum mdoc_type t)
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.45 kristaps 624: if (type >= 0)
1.23 kristaps 625: return(mdoc_nerr(mdoc, n, EMULTILIST));
1.8 kristaps 626: type = n->args->argv[pos].arg;
627: break;
1.45 kristaps 628: case (MDOC_Compact):
629: if (type < 0 && ! mdoc_nwarn(mdoc, n, ENOTYPE))
630: return(0);
631: break;
1.1 kristaps 632: case (MDOC_Width):
1.45 kristaps 633: if (width >= 0)
1.23 kristaps 634: return(mdoc_nerr(mdoc, n, EARGREP));
1.45 kristaps 635: if (type < 0 && ! mdoc_nwarn(mdoc, n, ENOTYPE))
636: return(0);
1.8 kristaps 637: width = n->args->argv[pos].arg;
638: break;
1.1 kristaps 639: case (MDOC_Offset):
1.45 kristaps 640: if (offset >= 0)
1.23 kristaps 641: return(mdoc_nerr(mdoc, n, EARGREP));
1.45 kristaps 642: if (type < 0 && ! mdoc_nwarn(mdoc, n, ENOTYPE))
643: return(0);
1.8 kristaps 644: offset = n->args->argv[pos].arg;
645: break;
1.1 kristaps 646: default:
647: break;
648: }
649:
1.45 kristaps 650: if (type < 0)
1.23 kristaps 651: return(mdoc_nerr(mdoc, n, ELISTTYPE));
1.1 kristaps 652:
1.8 kristaps 653: /*
654: * Validate the width field. Some list types don't need width
655: * types and should be warned about them. Others should have it
656: * and must also be warned.
657: */
658:
1.1 kristaps 659: switch (type) {
1.8 kristaps 660: case (MDOC_Tag):
1.45 kristaps 661: if (width < 0 && ! mdoc_nwarn(mdoc, n, EMISSWIDTH))
1.8 kristaps 662: return(0);
663: break;
1.1 kristaps 664: case (MDOC_Column):
665: /* FALLTHROUGH */
666: case (MDOC_Diag):
667: /* FALLTHROUGH */
668: case (MDOC_Inset):
669: /* FALLTHROUGH */
670: case (MDOC_Item):
1.45 kristaps 671: if (width >= 0 && ! mdoc_nwarn(mdoc, n, ENOWIDTH))
1.8 kristaps 672: return(0);
673: break;
674: default:
675: break;
676: }
677:
1.1 kristaps 678: return(1);
679: }
680:
681:
682: static int
683: pre_bd(PRE_ARGS)
684: {
685: int i, type, err;
686:
687: if (MDOC_BLOCK != n->type)
688: return(1);
689: if (NULL == n->args)
1.23 kristaps 690: return(mdoc_nerr(mdoc, n, EDISPTYPE));
1.1 kristaps 691:
692: /* Make sure that only one type of display is specified. */
693:
694: /* LINTED */
695: for (i = 0, err = type = 0; ! err &&
696: i < (int)n->args->argc; i++)
697: switch (n->args->argv[i].arg) {
1.49 kristaps 698: case (MDOC_Centred):
699: /* FALLTHROUGH */
1.1 kristaps 700: case (MDOC_Ragged):
701: /* FALLTHROUGH */
702: case (MDOC_Unfilled):
703: /* FALLTHROUGH */
704: case (MDOC_Filled):
705: /* FALLTHROUGH */
706: case (MDOC_Literal):
707: if (0 == type++)
708: break;
1.23 kristaps 709: return(mdoc_nerr(mdoc, n, EMULTIDISP));
1.1 kristaps 710: default:
711: break;
712: }
713:
714: if (type)
715: return(1);
1.23 kristaps 716: return(mdoc_nerr(mdoc, n, EDISPTYPE));
1.1 kristaps 717: }
718:
719:
720: static int
721: pre_ss(PRE_ARGS)
722: {
723:
724: if (MDOC_BLOCK != n->type)
725: return(1);
726: return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
727: }
728:
729:
730: static int
731: pre_sh(PRE_ARGS)
732: {
733:
734: if (MDOC_BLOCK != n->type)
735: return(1);
736: return(check_parent(mdoc, n, -1, MDOC_ROOT));
737: }
738:
739:
740: static int
741: pre_it(PRE_ARGS)
742: {
743:
744: if (MDOC_BLOCK != n->type)
745: return(1);
746: return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
747: }
748:
749:
750: static int
751: pre_an(PRE_ARGS)
752: {
753:
754: if (NULL == n->args || 1 == n->args->argc)
755: return(1);
1.23 kristaps 756: return(mdoc_verr(mdoc, n->line, n->pos,
757: "only one argument allowed"));
1.1 kristaps 758: }
759:
760:
761: static int
762: pre_lb(PRE_ARGS)
763: {
764:
765: return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM));
766: }
767:
768:
769: static int
770: pre_rv(PRE_ARGS)
771: {
772:
773: if ( ! check_msec(mdoc, n, 2, 3, 0))
774: return(0);
775: return(check_stdarg(mdoc, n));
776: }
777:
778:
779: static int
780: pre_ex(PRE_ARGS)
781: {
782:
783: if ( ! check_msec(mdoc, n, 1, 6, 8, 0))
784: return(0);
785: return(check_stdarg(mdoc, n));
786: }
787:
788:
789: static int
790: pre_er(PRE_ARGS)
791: {
792:
1.6 kristaps 793: return(check_msec(mdoc, n, 2, 3, 9, 0));
1.1 kristaps 794: }
795:
796:
797: static int
798: pre_cd(PRE_ARGS)
799: {
800:
801: return(check_msec(mdoc, n, 4, 0));
802: }
803:
804:
805: static int
806: pre_dt(PRE_ARGS)
807: {
808:
809: if (0 == mdoc->meta.date || mdoc->meta.os)
1.23 kristaps 810: if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
1.1 kristaps 811: return(0);
812: if (mdoc->meta.title)
1.23 kristaps 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.23 kristaps 824: if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
1.1 kristaps 825: return(0);
826: if (mdoc->meta.os)
1.23 kristaps 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.23 kristaps 838: if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
1.1 kristaps 839: return(0);
840: if (mdoc->meta.date)
1.23 kristaps 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.12 kristaps 858: if (mdoc->last->args && head->child)
1.24 kristaps 859: return(mdoc_nerr(mdoc, mdoc->last, ELINE));
1.13 kristaps 860: else if (mdoc->last->args)
861: return(1);
1.12 kristaps 862:
1.13 kristaps 863: if (NULL == head->child || MDOC_TEXT != head->child->type)
1.24 kristaps 864: return(mdoc_nerr(mdoc, mdoc->last, ELINE));
1.1 kristaps 865:
1.13 kristaps 866: p = head->child->string;
1.1 kristaps 867:
1.13 kristaps 868: if (0 == strcmp(p, "Em"))
869: return(1);
870: else if (0 == strcmp(p, "Li"))
871: return(1);
1.37 kristaps 872: else if (0 == strcmp(p, "Sy"))
1.13 kristaps 873: return(1);
1.1 kristaps 874:
1.23 kristaps 875: return(mdoc_nerr(mdoc, head, EFONT));
1.1 kristaps 876: }
877:
878:
879: static int
1.31 kristaps 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));
886: }
887:
888:
889: static int
1.1 kristaps 890: post_nm(POST_ARGS)
891: {
892:
893: if (mdoc->last->child)
894: return(1);
895: if (mdoc->meta.name)
896: return(1);
1.23 kristaps 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.23 kristaps 908: return(mdoc_nerr(mdoc, mdoc->last, EATT));
1.1 kristaps 909: if (mdoc_a2att(mdoc->last->child->string))
910: return(1);
1.23 kristaps 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.40 kristaps 922: return(mdoc_nerr(mdoc, mdoc->last, ENOLINE));
1.1 kristaps 923: }
924:
925: if (mdoc->last->child)
926: return(1);
1.23 kristaps 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.23 kristaps 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.23 kristaps 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.23 kristaps 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.23 kristaps 996: if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
1.1 kristaps 997: return(0);
998: if (NULL == mdoc->last->body->child)
1.23 kristaps 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.23 kristaps 1012: if ( ! mdoc_nwarn(mdoc, mdoc->last, ENOLINE))
1.1 kristaps 1013: return(0);
1014: if (NULL == mdoc->last->body->child)
1.23 kristaps 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.23 kristaps 1020: if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
1.1 kristaps 1021: return(0);
1022: if (mdoc->last->body->child)
1.23 kristaps 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.38 kristaps 1028:
1.39 kristaps 1029: if (i < cols || i == (cols + 1)) {
1.38 kristaps 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.38 kristaps 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.14 kristaps 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.23 kristaps 1067: return(mdoc_nerr(mdoc, n, ECOLMIS));
1.14 kristaps 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.14 kristaps 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.43 kristaps 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;
1.2 kristaps 1106: if (0 == strcmp(n->string, "on"))
1.1 kristaps 1107: continue;
1.2 kristaps 1108: if (0 == strcmp(n->string, "off"))
1.1 kristaps 1109: continue;
1110: break;
1111: }
1112:
1113: if (NULL == n)
1114: return(1);
1.23 kristaps 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.23 kristaps 1124: return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1.12 kristaps 1125: if ( ! (MDOC_PBODY & mdoc->flags))
1.23 kristaps 1126: return(mdoc_nerr(mdoc, mdoc->first, ENOPROLOGUE));
1.1 kristaps 1127:
1128: if (MDOC_BLOCK != mdoc->first->child->type)
1.23 kristaps 1129: return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1.1 kristaps 1130: if (MDOC_Sh != mdoc->first->child->tok)
1.23 kristaps 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.30 kristaps 1143: return(mdoc_nerr(mdoc, mdoc->last, EBADSTAND));
1.1 kristaps 1144: }
1145:
1146:
1147: static int
1.43 kristaps 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.50 kristaps 1157: case(MDOC__U):
1158: /* FALLTHROUGH */
1.43 kristaps 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);
1190: }
1191:
1192:
1193: static int
1.1 kristaps 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.29 kristaps 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.23 kristaps 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;
1.28 kristaps 1226: if (MDOC_TEXT == n->type)
1227: continue;
1.23 kristaps 1228: if ( ! mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC))
1.1 kristaps 1229: return(0);
1230: }
1231:
1.41 kristaps 1232: assert(n);
1.27 kristaps 1233: if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
1.1 kristaps 1234: return(1);
1.23 kristaps 1235: return(mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC));
1.1 kristaps 1236: }
1237:
1238:
1239: static int
1240: post_sh_head(POST_ARGS)
1241: {
1.2 kristaps 1242: char buf[64];
1243: enum mdoc_sec sec;
1244: const struct mdoc_node *n;
1.1 kristaps 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.12 kristaps 1253: buf[0] = 0;
1.1 kristaps 1254:
1.2 kristaps 1255: for (n = mdoc->last->child; n; n = n->next) {
1.12 kristaps 1256: /* XXX - copied from compact(). */
1.2 kristaps 1257: assert(MDOC_TEXT == n->type);
1.12 kristaps 1258:
1.2 kristaps 1259: if (strlcat(buf, n->string, 64) >= 64)
1.23 kristaps 1260: return(mdoc_nerr(mdoc, n, ETOOLONG));
1.2 kristaps 1261: if (NULL == n->next)
1262: continue;
1263: if (strlcat(buf, " ", 64) >= 64)
1.23 kristaps 1264: return(mdoc_nerr(mdoc, n, ETOOLONG));
1.2 kristaps 1265: }
1.1 kristaps 1266:
1267: sec = mdoc_atosec(buf);
1268:
1.12 kristaps 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.12 kristaps 1274: if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
1.23 kristaps 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.26 kristaps 1279: if ( ! mdoc_nwarn(mdoc, mdoc->last, ESECREP))
1280: return(0);
1.1 kristaps 1281: if (sec < mdoc->lastnamed)
1.26 kristaps 1282: if ( ! mdoc_nwarn(mdoc, mdoc->last, ESECOOO))
1283: return(0);
1.1 kristaps 1284:
1.12 kristaps 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.23 kristaps 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: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mdoc_validate.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc