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