Annotation of mandoc/mdoc_validate.c, Revision 1.51
1.51 ! kristaps 1: /* $Id: mdoc_validate.c,v 1.50 2009/10/24 05:52:14 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 <errno.h>
22: #include <limits.h>
1.1 kristaps 23: #include <stdarg.h>
24: #include <stdlib.h>
1.2 kristaps 25: #include <string.h>
1.1 kristaps 26:
27: #include "libmdoc.h"
1.18 kristaps 28: #include "libmandoc.h"
1.1 kristaps 29:
30: /* FIXME: .Bl -diag can't have non-text children in HEAD. */
31: /* TODO: ignoring Pp (it's superfluous in some invocations). */
32:
1.32 kristaps 33: #define PRE_ARGS struct mdoc *mdoc, const struct mdoc_node *n
34: #define POST_ARGS struct mdoc *mdoc
1.1 kristaps 35:
36: typedef int (*v_pre)(PRE_ARGS);
37: typedef int (*v_post)(POST_ARGS);
38:
39: struct valids {
40: v_pre *pre;
41: v_post *post;
42: };
43:
1.32 kristaps 44: static int check_parent(PRE_ARGS, int, enum mdoc_type);
45: static int check_msec(PRE_ARGS, ...);
46: static int check_sec(PRE_ARGS, ...);
47: static int check_stdarg(PRE_ARGS);
48: static int check_text(struct mdoc *, int, int, const char *);
49: static int check_argv(struct mdoc *,
1.1 kristaps 50: const struct mdoc_node *,
51: const struct mdoc_argv *);
1.32 kristaps 52: static int check_args(struct mdoc *,
1.1 kristaps 53: const struct mdoc_node *);
1.32 kristaps 54: static int err_child_lt(struct mdoc *, const char *, int);
55: static int warn_child_lt(struct mdoc *, const char *, int);
56: static int err_child_gt(struct mdoc *, const char *, int);
57: static int warn_child_gt(struct mdoc *, const char *, int);
58: static int err_child_eq(struct mdoc *, const char *, int);
59: static int warn_child_eq(struct mdoc *, const char *, int);
60: static int warn_print(struct mdoc *, int, int);
61: static int warn_count(struct mdoc *, const char *,
1.1 kristaps 62: int, const char *, int);
1.32 kristaps 63: static int err_count(struct mdoc *, const char *,
1.1 kristaps 64: int, const char *, int);
1.32 kristaps 65:
66: #ifdef __linux__
67: extern size_t strlcat(char *, const char *, size_t);
68: #endif
69:
70: static int berr_ge1(POST_ARGS);
71: static int bwarn_ge1(POST_ARGS);
72: static int ebool(POST_ARGS);
73: static int eerr_eq0(POST_ARGS);
74: static int eerr_eq1(POST_ARGS);
75: static int eerr_ge1(POST_ARGS);
76: static int eerr_le2(POST_ARGS);
1.46 kristaps 77: static int eerr_le1(POST_ARGS);
1.32 kristaps 78: static int ewarn_ge1(POST_ARGS);
79: static int herr_eq0(POST_ARGS);
80: static int herr_ge1(POST_ARGS);
81: static int hwarn_eq1(POST_ARGS);
82: static int hwarn_le1(POST_ARGS);
83:
84: static int post_an(POST_ARGS);
85: static int post_at(POST_ARGS);
86: static int post_bf(POST_ARGS);
87: static int post_bl(POST_ARGS);
88: static int post_bl_head(POST_ARGS);
89: static int post_it(POST_ARGS);
90: static int post_lb(POST_ARGS);
91: static int post_nm(POST_ARGS);
92: static int post_root(POST_ARGS);
1.43 kristaps 93: static int post_rs(POST_ARGS);
1.32 kristaps 94: static int post_sh(POST_ARGS);
95: static int post_sh_body(POST_ARGS);
96: static int post_sh_head(POST_ARGS);
97: static int post_st(POST_ARGS);
98: static int pre_an(PRE_ARGS);
99: static int pre_bd(PRE_ARGS);
100: static int pre_bl(PRE_ARGS);
101: static int pre_cd(PRE_ARGS);
102: static int pre_dd(PRE_ARGS);
103: static int pre_display(PRE_ARGS);
104: static int pre_dt(PRE_ARGS);
105: static int pre_er(PRE_ARGS);
106: static int pre_ex(PRE_ARGS);
107: static int pre_fd(PRE_ARGS);
108: static int pre_it(PRE_ARGS);
109: static int pre_lb(PRE_ARGS);
110: static int pre_os(PRE_ARGS);
111: static int pre_rv(PRE_ARGS);
112: static int pre_sh(PRE_ARGS);
113: static int pre_ss(PRE_ARGS);
114:
115: static v_post posts_an[] = { post_an, NULL };
116: static v_post posts_at[] = { post_at, NULL };
117: static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
118: static v_post posts_bf[] = { hwarn_le1, post_bf, NULL };
119: static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL };
120: static v_post posts_bool[] = { eerr_eq1, ebool, NULL };
121: static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
122: static v_post posts_it[] = { post_it, NULL };
123: static v_post posts_lb[] = { eerr_eq1, post_lb, NULL };
124: static v_post posts_nd[] = { berr_ge1, NULL };
125: static v_post posts_nm[] = { post_nm, NULL };
126: static v_post posts_notext[] = { eerr_eq0, NULL };
1.44 kristaps 127: static v_post posts_rs[] = { berr_ge1, herr_eq0, post_rs, NULL };
1.32 kristaps 128: static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
1.46 kristaps 129: static v_post posts_sp[] = { eerr_le1, NULL };
1.32 kristaps 130: static v_post posts_ss[] = { herr_ge1, NULL };
131: static v_post posts_st[] = { eerr_eq1, post_st, NULL };
132: static v_post posts_text[] = { eerr_ge1, NULL };
1.51 ! kristaps 133: static v_post posts_text1[] = { eerr_eq1, NULL };
1.32 kristaps 134: static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
135: static v_post posts_wtext[] = { ewarn_ge1, NULL };
136: static v_post posts_xr[] = { eerr_ge1, eerr_le2, NULL };
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 */
194: { NULL, posts_text }, /* Vt */
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.1 kristaps 198: { NULL, posts_text }, /* %D */
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() */
410: CHECK_ELEM_DEFN(le2, err, err_child_lt, 3) /* eerr_le2() */
1.46 kristaps 411: CHECK_ELEM_DEFN(le1, err, err_child_lt, 2) /* eerr_le1() */
1.1 kristaps 412: CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */
413: CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */
414: CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */
415: CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2) /* hwarn_le1() */
416: CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */
417: CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1) /* hwarn_eq1() */
418:
419:
420: static int
421: check_stdarg(PRE_ARGS)
422: {
423:
424: if (n->args && 1 == n->args->argc)
425: if (MDOC_Std == n->args->argv[0].arg)
426: return(1);
1.23 kristaps 427: return(mdoc_nwarn(mdoc, n, EARGVAL));
1.1 kristaps 428: }
429:
430:
431: static int
432: check_sec(PRE_ARGS, ...)
433: {
434: enum mdoc_sec sec;
435: va_list ap;
436:
437: va_start(ap, n);
438:
439: for (;;) {
440: /* LINTED */
441: sec = (enum mdoc_sec)va_arg(ap, int);
442: if (SEC_CUSTOM == sec)
443: break;
444: if (sec != mdoc->lastsec)
445: continue;
446: va_end(ap);
447: return(1);
448: }
449:
450: va_end(ap);
1.23 kristaps 451: return(mdoc_nwarn(mdoc, n, EBADSEC));
1.1 kristaps 452: }
453:
454:
455: static int
456: check_msec(PRE_ARGS, ...)
457: {
458: va_list ap;
459: int msec;
460:
461: va_start(ap, n);
462: for (;;) {
463: /* LINTED */
464: if (0 == (msec = va_arg(ap, int)))
465: break;
466: if (msec != mdoc->meta.msec)
467: continue;
468: va_end(ap);
469: return(1);
470: }
471:
472: va_end(ap);
1.23 kristaps 473: return(mdoc_nwarn(mdoc, n, EBADMSEC));
1.1 kristaps 474: }
475:
476:
477: static int
478: check_args(struct mdoc *m, const struct mdoc_node *n)
479: {
480: int i;
481:
482: if (NULL == n->args)
483: return(1);
484:
485: assert(n->args->argc);
486: for (i = 0; i < (int)n->args->argc; i++)
487: if ( ! check_argv(m, n, &n->args->argv[i]))
488: return(0);
489:
490: return(1);
491: }
492:
493:
494: static int
495: check_argv(struct mdoc *m, const struct mdoc_node *n,
496: const struct mdoc_argv *v)
497: {
498: int i;
499:
500: for (i = 0; i < (int)v->sz; i++)
501: if ( ! check_text(m, v->line, v->pos, v->value[i]))
502: return(0);
503:
504: if (MDOC_Std == v->arg) {
505: /* `Nm' name must be set. */
506: if (v->sz || m->meta.name)
507: return(1);
1.23 kristaps 508: return(mdoc_nerr(m, n, ENAME));
1.1 kristaps 509: }
510:
511: return(1);
512: }
513:
514:
515: static int
516: check_text(struct mdoc *mdoc, int line, int pos, const char *p)
517: {
1.18 kristaps 518: int c;
1.1 kristaps 519:
1.18 kristaps 520: for ( ; *p; p++, pos++) {
1.1 kristaps 521: if ('\t' == *p) {
522: if ( ! (MDOC_LITERAL & mdoc->flags))
1.4 kristaps 523: if ( ! warn_print(mdoc, line, pos))
524: return(0);
1.1 kristaps 525: } else if ( ! isprint((u_char)*p))
1.4 kristaps 526: if ( ! warn_print(mdoc, line, pos))
527: return(0);
1.1 kristaps 528:
529: if ('\\' != *p)
530: continue;
531:
1.18 kristaps 532: c = mandoc_special(p);
1.1 kristaps 533: if (c) {
1.18 kristaps 534: p += c - 1;
535: pos += c - 1;
1.1 kristaps 536: continue;
537: }
538: if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags))
1.23 kristaps 539: return(mdoc_perr(mdoc, line, pos, EESCAPE));
1.32 kristaps 540: if ( ! mdoc_pwarn(mdoc, line, pos, EESCAPE))
1.1 kristaps 541: return(0);
542: }
543:
544: return(1);
545: }
546:
547:
548:
549:
550: static int
551: check_parent(PRE_ARGS, int tok, enum mdoc_type t)
552: {
553:
554: assert(n->parent);
555: if ((MDOC_ROOT == t || tok == n->parent->tok) &&
556: (t == n->parent->type))
557: return(1);
558:
1.23 kristaps 559: return(mdoc_verr(mdoc, n->line, n->pos, "require parent %s",
1.1 kristaps 560: MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
561: }
562:
563:
564:
565: static int
566: pre_display(PRE_ARGS)
567: {
568: struct mdoc_node *node;
569:
570: /* Display elements (`Bd', `D1'...) cannot be nested. */
571:
572: if (MDOC_BLOCK != n->type)
573: return(1);
574:
575: /* LINTED */
576: for (node = mdoc->last->parent; node; node = node->parent)
577: if (MDOC_BLOCK == node->type)
578: if (MDOC_Bd == node->tok)
579: break;
580: if (NULL == node)
581: return(1);
582:
1.23 kristaps 583: return(mdoc_nerr(mdoc, n, ENESTDISP));
1.1 kristaps 584: }
585:
586:
587: static int
588: pre_bl(PRE_ARGS)
589: {
1.15 kristaps 590: int pos, type, width, offset;
1.1 kristaps 591:
592: if (MDOC_BLOCK != n->type)
593: return(1);
594: if (NULL == n->args)
1.23 kristaps 595: return(mdoc_nerr(mdoc, n, ELISTTYPE));
1.1 kristaps 596:
597: /* Make sure that only one type of list is specified. */
598:
1.15 kristaps 599: type = offset = width = -1;
1.1 kristaps 600:
601: /* LINTED */
1.8 kristaps 602: for (pos = 0; pos < (int)n->args->argc; pos++)
603: switch (n->args->argv[pos].arg) {
1.1 kristaps 604: case (MDOC_Bullet):
605: /* FALLTHROUGH */
606: case (MDOC_Dash):
607: /* FALLTHROUGH */
608: case (MDOC_Enum):
609: /* FALLTHROUGH */
610: case (MDOC_Hyphen):
611: /* FALLTHROUGH */
612: case (MDOC_Item):
613: /* FALLTHROUGH */
614: case (MDOC_Tag):
615: /* FALLTHROUGH */
616: case (MDOC_Diag):
617: /* FALLTHROUGH */
618: case (MDOC_Hang):
619: /* FALLTHROUGH */
620: case (MDOC_Ohang):
621: /* FALLTHROUGH */
622: case (MDOC_Inset):
623: /* FALLTHROUGH */
624: case (MDOC_Column):
1.45 kristaps 625: if (type >= 0)
1.23 kristaps 626: return(mdoc_nerr(mdoc, n, EMULTILIST));
1.8 kristaps 627: type = n->args->argv[pos].arg;
628: break;
1.45 kristaps 629: case (MDOC_Compact):
630: if (type < 0 && ! mdoc_nwarn(mdoc, n, ENOTYPE))
631: return(0);
632: break;
1.1 kristaps 633: case (MDOC_Width):
1.45 kristaps 634: if (width >= 0)
1.23 kristaps 635: return(mdoc_nerr(mdoc, n, EARGREP));
1.45 kristaps 636: if (type < 0 && ! mdoc_nwarn(mdoc, n, ENOTYPE))
637: return(0);
1.8 kristaps 638: width = n->args->argv[pos].arg;
639: break;
1.1 kristaps 640: case (MDOC_Offset):
1.45 kristaps 641: if (offset >= 0)
1.23 kristaps 642: return(mdoc_nerr(mdoc, n, EARGREP));
1.45 kristaps 643: if (type < 0 && ! mdoc_nwarn(mdoc, n, ENOTYPE))
644: return(0);
1.8 kristaps 645: offset = n->args->argv[pos].arg;
646: break;
1.1 kristaps 647: default:
648: break;
649: }
650:
1.45 kristaps 651: if (type < 0)
1.23 kristaps 652: return(mdoc_nerr(mdoc, n, ELISTTYPE));
1.1 kristaps 653:
1.8 kristaps 654: /*
655: * Validate the width field. Some list types don't need width
656: * types and should be warned about them. Others should have it
657: * and must also be warned.
658: */
659:
1.1 kristaps 660: switch (type) {
1.8 kristaps 661: case (MDOC_Tag):
1.45 kristaps 662: if (width < 0 && ! mdoc_nwarn(mdoc, n, EMISSWIDTH))
1.8 kristaps 663: return(0);
664: break;
1.1 kristaps 665: case (MDOC_Column):
666: /* FALLTHROUGH */
667: case (MDOC_Diag):
668: /* FALLTHROUGH */
669: case (MDOC_Inset):
670: /* FALLTHROUGH */
671: case (MDOC_Item):
1.45 kristaps 672: if (width >= 0 && ! mdoc_nwarn(mdoc, n, ENOWIDTH))
1.8 kristaps 673: return(0);
674: break;
675: default:
676: break;
677: }
678:
1.1 kristaps 679: return(1);
680: }
681:
682:
683: static int
684: pre_bd(PRE_ARGS)
685: {
686: int i, type, err;
687:
688: if (MDOC_BLOCK != n->type)
689: return(1);
690: if (NULL == n->args)
1.23 kristaps 691: return(mdoc_nerr(mdoc, n, EDISPTYPE));
1.1 kristaps 692:
693: /* Make sure that only one type of display is specified. */
694:
695: /* LINTED */
696: for (i = 0, err = type = 0; ! err &&
697: i < (int)n->args->argc; i++)
698: switch (n->args->argv[i].arg) {
1.49 kristaps 699: case (MDOC_Centred):
700: /* FALLTHROUGH */
1.1 kristaps 701: case (MDOC_Ragged):
702: /* FALLTHROUGH */
703: case (MDOC_Unfilled):
704: /* FALLTHROUGH */
705: case (MDOC_Filled):
706: /* FALLTHROUGH */
707: case (MDOC_Literal):
708: if (0 == type++)
709: break;
1.23 kristaps 710: return(mdoc_nerr(mdoc, n, EMULTIDISP));
1.1 kristaps 711: default:
712: break;
713: }
714:
715: if (type)
716: return(1);
1.23 kristaps 717: return(mdoc_nerr(mdoc, n, EDISPTYPE));
1.1 kristaps 718: }
719:
720:
721: static int
722: pre_ss(PRE_ARGS)
723: {
724:
725: if (MDOC_BLOCK != n->type)
726: return(1);
727: return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
728: }
729:
730:
731: static int
732: pre_sh(PRE_ARGS)
733: {
734:
735: if (MDOC_BLOCK != n->type)
736: return(1);
737: return(check_parent(mdoc, n, -1, MDOC_ROOT));
738: }
739:
740:
741: static int
742: pre_it(PRE_ARGS)
743: {
744:
745: if (MDOC_BLOCK != n->type)
746: return(1);
747: return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
748: }
749:
750:
751: static int
752: pre_an(PRE_ARGS)
753: {
754:
755: if (NULL == n->args || 1 == n->args->argc)
756: return(1);
1.23 kristaps 757: return(mdoc_verr(mdoc, n->line, n->pos,
758: "only one argument allowed"));
1.1 kristaps 759: }
760:
761:
762: static int
763: pre_lb(PRE_ARGS)
764: {
765:
766: return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM));
767: }
768:
769:
770: static int
771: pre_rv(PRE_ARGS)
772: {
773:
774: if ( ! check_msec(mdoc, n, 2, 3, 0))
775: return(0);
776: return(check_stdarg(mdoc, n));
777: }
778:
779:
780: static int
781: pre_ex(PRE_ARGS)
782: {
783:
784: if ( ! check_msec(mdoc, n, 1, 6, 8, 0))
785: return(0);
786: return(check_stdarg(mdoc, n));
787: }
788:
789:
790: static int
791: pre_er(PRE_ARGS)
792: {
793:
1.6 kristaps 794: return(check_msec(mdoc, n, 2, 3, 9, 0));
1.1 kristaps 795: }
796:
797:
798: static int
799: pre_cd(PRE_ARGS)
800: {
801:
802: return(check_msec(mdoc, n, 4, 0));
803: }
804:
805:
806: static int
807: pre_dt(PRE_ARGS)
808: {
809:
810: if (0 == mdoc->meta.date || mdoc->meta.os)
1.23 kristaps 811: if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
1.1 kristaps 812: return(0);
813: if (mdoc->meta.title)
1.23 kristaps 814: if ( ! mdoc_nwarn(mdoc, n, EPROLREP))
1.1 kristaps 815: return(0);
816: return(1);
817: }
818:
819:
820: static int
821: pre_os(PRE_ARGS)
822: {
823:
824: if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
1.23 kristaps 825: if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
1.1 kristaps 826: return(0);
827: if (mdoc->meta.os)
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_dd(PRE_ARGS)
836: {
837:
838: if (mdoc->meta.title || mdoc->meta.os)
1.23 kristaps 839: if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
1.1 kristaps 840: return(0);
841: if (mdoc->meta.date)
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: post_bf(POST_ARGS)
850: {
851: char *p;
852: struct mdoc_node *head;
853:
854: if (MDOC_BLOCK != mdoc->last->type)
855: return(1);
856:
857: head = mdoc->last->head;
858:
1.12 kristaps 859: if (mdoc->last->args && head->child)
1.24 kristaps 860: return(mdoc_nerr(mdoc, mdoc->last, ELINE));
1.13 kristaps 861: else if (mdoc->last->args)
862: return(1);
1.12 kristaps 863:
1.13 kristaps 864: if (NULL == head->child || MDOC_TEXT != head->child->type)
1.24 kristaps 865: return(mdoc_nerr(mdoc, mdoc->last, ELINE));
1.1 kristaps 866:
1.13 kristaps 867: p = head->child->string;
1.1 kristaps 868:
1.13 kristaps 869: if (0 == strcmp(p, "Em"))
870: return(1);
871: else if (0 == strcmp(p, "Li"))
872: return(1);
1.37 kristaps 873: else if (0 == strcmp(p, "Sy"))
1.13 kristaps 874: return(1);
1.1 kristaps 875:
1.23 kristaps 876: return(mdoc_nerr(mdoc, head, EFONT));
1.1 kristaps 877: }
878:
879:
880: static int
1.31 kristaps 881: post_lb(POST_ARGS)
882: {
883:
884: if (mdoc_a2lib(mdoc->last->child->string))
885: return(1);
886: return(mdoc_nwarn(mdoc, mdoc->last, ELIB));
887: }
888:
889:
890: static int
1.1 kristaps 891: post_nm(POST_ARGS)
892: {
893:
894: if (mdoc->last->child)
895: return(1);
896: if (mdoc->meta.name)
897: return(1);
1.23 kristaps 898: return(mdoc_nerr(mdoc, mdoc->last, ENAME));
1.1 kristaps 899: }
900:
901:
902: static int
903: post_at(POST_ARGS)
904: {
905:
906: if (NULL == mdoc->last->child)
907: return(1);
908: if (MDOC_TEXT != mdoc->last->child->type)
1.23 kristaps 909: return(mdoc_nerr(mdoc, mdoc->last, EATT));
1.1 kristaps 910: if (mdoc_a2att(mdoc->last->child->string))
911: return(1);
1.23 kristaps 912: return(mdoc_nerr(mdoc, mdoc->last, EATT));
1.1 kristaps 913: }
914:
915:
916: static int
917: post_an(POST_ARGS)
918: {
919:
920: if (mdoc->last->args) {
921: if (NULL == mdoc->last->child)
922: return(1);
1.40 kristaps 923: return(mdoc_nerr(mdoc, mdoc->last, ENOLINE));
1.1 kristaps 924: }
925:
926: if (mdoc->last->child)
927: return(1);
1.23 kristaps 928: return(mdoc_nerr(mdoc, mdoc->last, ELINE));
1.1 kristaps 929: }
930:
931:
932: static int
933: post_it(POST_ARGS)
934: {
935: int type, i, cols;
936: struct mdoc_node *n, *c;
937:
938: if (MDOC_BLOCK != mdoc->last->type)
939: return(1);
940:
941: n = mdoc->last->parent->parent;
942: if (NULL == n->args)
1.23 kristaps 943: return(mdoc_nerr(mdoc, mdoc->last, ELISTTYPE));
1.1 kristaps 944:
945: /* Some types require block-head, some not. */
946:
947: /* LINTED */
948: for (cols = type = -1, i = 0; -1 == type &&
949: i < (int)n->args->argc; i++)
950: switch (n->args->argv[i].arg) {
951: case (MDOC_Tag):
952: /* FALLTHROUGH */
953: case (MDOC_Diag):
954: /* FALLTHROUGH */
955: case (MDOC_Hang):
956: /* FALLTHROUGH */
957: case (MDOC_Ohang):
958: /* FALLTHROUGH */
959: case (MDOC_Inset):
960: /* FALLTHROUGH */
961: case (MDOC_Bullet):
962: /* FALLTHROUGH */
963: case (MDOC_Dash):
964: /* FALLTHROUGH */
965: case (MDOC_Enum):
966: /* FALLTHROUGH */
967: case (MDOC_Hyphen):
968: /* FALLTHROUGH */
969: case (MDOC_Item):
970: type = n->args->argv[i].arg;
971: break;
972: case (MDOC_Column):
973: type = n->args->argv[i].arg;
974: cols = (int)n->args->argv[i].sz;
975: break;
976: default:
977: break;
978: }
979:
980: if (-1 == type)
1.23 kristaps 981: return(mdoc_nerr(mdoc, mdoc->last, ELISTTYPE));
1.1 kristaps 982:
983: switch (type) {
984: case (MDOC_Tag):
985: if (NULL == mdoc->last->head->child)
1.23 kristaps 986: if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
1.1 kristaps 987: return(0);
988: break;
989: case (MDOC_Hang):
990: /* FALLTHROUGH */
991: case (MDOC_Ohang):
992: /* FALLTHROUGH */
993: case (MDOC_Inset):
994: /* FALLTHROUGH */
995: case (MDOC_Diag):
996: if (NULL == mdoc->last->head->child)
1.23 kristaps 997: if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
1.1 kristaps 998: return(0);
999: if (NULL == mdoc->last->body->child)
1.23 kristaps 1000: if ( ! mdoc_nwarn(mdoc, mdoc->last, EMULTILINE))
1.1 kristaps 1001: return(0);
1002: break;
1003: case (MDOC_Bullet):
1004: /* FALLTHROUGH */
1005: case (MDOC_Dash):
1006: /* FALLTHROUGH */
1007: case (MDOC_Enum):
1008: /* FALLTHROUGH */
1009: case (MDOC_Hyphen):
1010: /* FALLTHROUGH */
1011: case (MDOC_Item):
1012: if (mdoc->last->head->child)
1.23 kristaps 1013: if ( ! mdoc_nwarn(mdoc, mdoc->last, ENOLINE))
1.1 kristaps 1014: return(0);
1015: if (NULL == mdoc->last->body->child)
1.23 kristaps 1016: if ( ! mdoc_nwarn(mdoc, mdoc->last, EMULTILINE))
1.1 kristaps 1017: return(0);
1018: break;
1019: case (MDOC_Column):
1020: if (NULL == mdoc->last->head->child)
1.23 kristaps 1021: if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
1.1 kristaps 1022: return(0);
1023: if (mdoc->last->body->child)
1.23 kristaps 1024: if ( ! mdoc_nwarn(mdoc, mdoc->last, ENOMULTILINE))
1.1 kristaps 1025: return(0);
1026: c = mdoc->last->child;
1027: for (i = 0; c && MDOC_HEAD == c->type; c = c->next)
1028: i++;
1.38 kristaps 1029:
1.39 kristaps 1030: if (i < cols || i == (cols + 1)) {
1.38 kristaps 1031: if ( ! mdoc_vwarn(mdoc, mdoc->last->line,
1032: mdoc->last->pos, "column "
1033: "mismatch: have %d, want %d",
1034: i, cols))
1035: return(0);
1.1 kristaps 1036: break;
1.38 kristaps 1037: } else if (i == cols)
1038: break;
1039:
1040: return(mdoc_verr(mdoc, mdoc->last->line,
1041: mdoc->last->pos, "column mismatch: "
1042: "have %d, want %d", i, cols));
1.1 kristaps 1043: default:
1044: break;
1045: }
1046:
1047: return(1);
1048: }
1049:
1050:
1051: static int
1.14 kristaps 1052: post_bl_head(POST_ARGS)
1053: {
1054: int i;
1055: const struct mdoc_node *n;
1056:
1057: n = mdoc->last->parent;
1058: assert(n->args);
1059:
1060: for (i = 0; i < (int)n->args->argc; i++)
1061: if (n->args->argv[i].arg == MDOC_Column)
1062: break;
1063:
1064: if (i == (int)n->args->argc)
1065: return(1);
1066:
1067: if (n->args->argv[i].sz && mdoc->last->child)
1.23 kristaps 1068: return(mdoc_nerr(mdoc, n, ECOLMIS));
1.14 kristaps 1069:
1070: return(1);
1071: }
1072:
1073:
1074: static int
1.1 kristaps 1075: post_bl(POST_ARGS)
1076: {
1077: struct mdoc_node *n;
1078:
1.14 kristaps 1079: if (MDOC_HEAD == mdoc->last->type)
1080: return(post_bl_head(mdoc));
1.1 kristaps 1081: if (MDOC_BODY != mdoc->last->type)
1082: return(1);
1083: if (NULL == mdoc->last->child)
1084: return(1);
1085:
1086: /* LINTED */
1087: for (n = mdoc->last->child; n; n = n->next) {
1088: if (MDOC_BLOCK == n->type)
1089: if (MDOC_It == n->tok)
1090: continue;
1.43 kristaps 1091: return(mdoc_nerr(mdoc, n, EBADCHILD));
1.1 kristaps 1092: }
1093:
1094: return(1);
1095: }
1096:
1097:
1098: static int
1099: ebool(struct mdoc *mdoc)
1100: {
1101: struct mdoc_node *n;
1102:
1103: /* LINTED */
1104: for (n = mdoc->last->child; n; n = n->next) {
1105: if (MDOC_TEXT != n->type)
1106: break;
1.2 kristaps 1107: if (0 == strcmp(n->string, "on"))
1.1 kristaps 1108: continue;
1.2 kristaps 1109: if (0 == strcmp(n->string, "off"))
1.1 kristaps 1110: continue;
1111: break;
1112: }
1113:
1114: if (NULL == n)
1115: return(1);
1.23 kristaps 1116: return(mdoc_nerr(mdoc, n, EBOOL));
1.1 kristaps 1117: }
1118:
1119:
1120: static int
1121: post_root(POST_ARGS)
1122: {
1123:
1124: if (NULL == mdoc->first->child)
1.23 kristaps 1125: return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1.12 kristaps 1126: if ( ! (MDOC_PBODY & mdoc->flags))
1.23 kristaps 1127: return(mdoc_nerr(mdoc, mdoc->first, ENOPROLOGUE));
1.1 kristaps 1128:
1129: if (MDOC_BLOCK != mdoc->first->child->type)
1.23 kristaps 1130: return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1.1 kristaps 1131: if (MDOC_Sh != mdoc->first->child->tok)
1.23 kristaps 1132: return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1.1 kristaps 1133:
1134: return(1);
1135: }
1136:
1137:
1138: static int
1139: post_st(POST_ARGS)
1140: {
1141:
1142: if (mdoc_a2st(mdoc->last->child->string))
1143: return(1);
1.30 kristaps 1144: return(mdoc_nerr(mdoc, mdoc->last, EBADSTAND));
1.1 kristaps 1145: }
1146:
1147:
1148: static int
1.43 kristaps 1149: post_rs(POST_ARGS)
1150: {
1151: struct mdoc_node *nn;
1152:
1153: if (MDOC_BODY != mdoc->last->type)
1154: return(1);
1155:
1156: for (nn = mdoc->last->child; nn; nn = nn->next)
1157: switch (nn->tok) {
1.50 kristaps 1158: case(MDOC__U):
1159: /* FALLTHROUGH */
1.43 kristaps 1160: case(MDOC__Q):
1161: /* FALLTHROUGH */
1162: case(MDOC__C):
1163: /* FALLTHROUGH */
1164: case(MDOC__A):
1165: /* FALLTHROUGH */
1166: case(MDOC__B):
1167: /* FALLTHROUGH */
1168: case(MDOC__D):
1169: /* FALLTHROUGH */
1170: case(MDOC__I):
1171: /* FALLTHROUGH */
1172: case(MDOC__J):
1173: /* FALLTHROUGH */
1174: case(MDOC__N):
1175: /* FALLTHROUGH */
1176: case(MDOC__O):
1177: /* FALLTHROUGH */
1178: case(MDOC__P):
1179: /* FALLTHROUGH */
1180: case(MDOC__R):
1181: /* FALLTHROUGH */
1182: case(MDOC__T):
1183: /* FALLTHROUGH */
1184: case(MDOC__V):
1185: break;
1186: default:
1187: return(mdoc_nerr(mdoc, nn, EBADCHILD));
1188: }
1189:
1190: return(1);
1191: }
1192:
1193:
1194: static int
1.1 kristaps 1195: post_sh(POST_ARGS)
1196: {
1197:
1198: if (MDOC_HEAD == mdoc->last->type)
1199: return(post_sh_head(mdoc));
1200: if (MDOC_BODY == mdoc->last->type)
1201: return(post_sh_body(mdoc));
1202:
1203: return(1);
1204: }
1205:
1206:
1207: static int
1208: post_sh_body(POST_ARGS)
1209: {
1210: struct mdoc_node *n;
1211:
1.29 kristaps 1212: if (SEC_NAME != mdoc->lastsec)
1.1 kristaps 1213: return(1);
1214:
1215: /*
1216: * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1217: * macros (can have multiple `Nm' and one `Nd'). Note that the
1218: * children of the BODY declaration can also be "text".
1219: */
1220:
1221: if (NULL == (n = mdoc->last->child))
1.23 kristaps 1222: return(mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC));
1.1 kristaps 1223:
1224: for ( ; n && n->next; n = n->next) {
1225: if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1226: continue;
1.28 kristaps 1227: if (MDOC_TEXT == n->type)
1228: continue;
1.23 kristaps 1229: if ( ! mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC))
1.1 kristaps 1230: return(0);
1231: }
1232:
1.41 kristaps 1233: assert(n);
1.27 kristaps 1234: if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
1.1 kristaps 1235: return(1);
1.23 kristaps 1236: return(mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC));
1.1 kristaps 1237: }
1238:
1239:
1240: static int
1241: post_sh_head(POST_ARGS)
1242: {
1.2 kristaps 1243: char buf[64];
1244: enum mdoc_sec sec;
1245: const struct mdoc_node *n;
1.1 kristaps 1246:
1247: /*
1248: * Process a new section. Sections are either "named" or
1249: * "custom"; custom sections are user-defined, while named ones
1250: * usually follow a conventional order and may only appear in
1251: * certain manual sections.
1252: */
1253:
1.12 kristaps 1254: buf[0] = 0;
1.1 kristaps 1255:
1.2 kristaps 1256: for (n = mdoc->last->child; n; n = n->next) {
1.12 kristaps 1257: /* XXX - copied from compact(). */
1.2 kristaps 1258: assert(MDOC_TEXT == n->type);
1.12 kristaps 1259:
1.2 kristaps 1260: if (strlcat(buf, n->string, 64) >= 64)
1.23 kristaps 1261: return(mdoc_nerr(mdoc, n, ETOOLONG));
1.2 kristaps 1262: if (NULL == n->next)
1263: continue;
1264: if (strlcat(buf, " ", 64) >= 64)
1.23 kristaps 1265: return(mdoc_nerr(mdoc, n, ETOOLONG));
1.2 kristaps 1266: }
1.1 kristaps 1267:
1268: sec = mdoc_atosec(buf);
1269:
1.12 kristaps 1270: /*
1271: * Check: NAME should always be first, CUSTOM has no roles,
1272: * non-CUSTOM has a conventional order to be followed.
1273: */
1.1 kristaps 1274:
1.12 kristaps 1275: if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
1.23 kristaps 1276: return(mdoc_nerr(mdoc, mdoc->last, ESECNAME));
1.1 kristaps 1277: if (SEC_CUSTOM == sec)
1278: return(1);
1279: if (sec == mdoc->lastnamed)
1.26 kristaps 1280: if ( ! mdoc_nwarn(mdoc, mdoc->last, ESECREP))
1281: return(0);
1.1 kristaps 1282: if (sec < mdoc->lastnamed)
1.26 kristaps 1283: if ( ! mdoc_nwarn(mdoc, mdoc->last, ESECOOO))
1284: return(0);
1.1 kristaps 1285:
1.12 kristaps 1286: /*
1287: * Check particular section/manual conventions. LIBRARY can
1288: * only occur in msec 2, 3 (TODO: are there more of these?).
1289: */
1.1 kristaps 1290:
1291: switch (sec) {
1292: case (SEC_LIBRARY):
1293: switch (mdoc->meta.msec) {
1294: case (2):
1295: /* FALLTHROUGH */
1296: case (3):
1297: break;
1298: default:
1.23 kristaps 1299: return(mdoc_nwarn(mdoc, mdoc->last, EWRONGMSEC));
1.1 kristaps 1300: }
1301: break;
1302: default:
1303: break;
1304: }
1305:
1306: return(1);
1307: }
1308:
1309:
1310: static int
1311: pre_fd(PRE_ARGS)
1312: {
1313:
1314: return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM));
1315: }
CVSweb