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