Annotation of mandoc/mdoc_validate.c, Revision 1.19
1.19 ! kristaps 1: /* $Id: mdoc_validate.c,v 1.18 2009/07/04 09:01:55 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"
1.18 kristaps 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 merr {
1.2 kristaps 35: ETOOLONG,
1.1 kristaps 36: EESCAPE,
37: EPRINT,
38: ENODATA,
39: ENOPROLOGUE,
40: ELINE,
41: EATT,
42: ENAME,
43: ELISTTYPE,
44: EDISPTYPE,
45: EMULTIDISP,
1.12 kristaps 46: ESECNAME,
1.1 kristaps 47: EMULTILIST,
48: EARGREP,
49: EBOOL,
1.14 kristaps 50: ECOLMIS,
1.1 kristaps 51: ENESTDISP
52: };
53:
54: enum mwarn {
1.4 kristaps 55: WPRINT,
1.8 kristaps 56: WNOWIDTH,
57: WMISSWIDTH,
1.1 kristaps 58: WESCAPE,
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 (WNOWIDTH):
473: p = "superfluous width argument";
474: break;
475: case (WMISSWIDTH):
476: p = "missing width argument";
477: break;
1.4 kristaps 478: case (WPRINT):
479: p = "invalid character";
480: break;
1.1 kristaps 481: case (WESCAPE):
482: p = "invalid escape sequence";
483: break;
484: case (WNOLINE):
485: p = "suggested no line arguments";
486: break;
487: case (WLINE):
488: p = "suggested line arguments";
489: break;
490: case (WMULTILINE):
491: p = "suggested multi-line arguments";
492: break;
493: case (WNOMULTILINE):
494: p = "suggested no multi-line arguments";
495: break;
496: case (WWRONGMSEC):
497: p = "document section in wrong manual section";
498: c = WARN_COMPAT;
499: break;
500: case (WSECOOO):
501: p = "document section out of conventional order";
502: break;
503: case (WSECREP):
504: p = "document section repeated";
505: break;
506: case (WBADSTAND):
507: p = "unknown standard";
508: break;
509: case (WNAMESECINC):
510: p = "NAME section contents incomplete/badly-ordered";
511: break;
512: }
513: assert(p);
514: return(mdoc_pwarn(m, line, pos, c, p));
515: }
516:
517:
1.4 kristaps 518: static int
519: warn_print(struct mdoc *m, int ln, int pos)
520: {
521: if (MDOC_IGN_CHARS & m->pflags)
522: return(pwarn(m, ln, pos, WPRINT));
523: return(perr(m, ln, pos, EPRINT));
524: }
525:
1.1 kristaps 526:
527: static inline int
528: warn_count(struct mdoc *m, const char *k,
529: int want, const char *v, int has)
530: {
531:
532: return(mdoc_warn(m, WARN_SYNTAX,
533: "suggests %s %s %d (has %d)", v, k, want, has));
534: }
535:
536:
537: static inline int
538: err_count(struct mdoc *m, const char *k,
539: int want, const char *v, int has)
540: {
541:
542: return(mdoc_err(m,
543: "requires %s %s %d (has %d)", v, k, want, has));
544: }
545:
546:
547: /*
548: * Build these up with macros because they're basically the same check
549: * for different inequalities. Yes, this could be done with functions,
550: * but this is reasonable for now.
551: */
552:
553: #define CHECK_CHILD_DEFN(lvl, name, ineq) \
554: static int \
555: lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \
556: { \
1.16 kristaps 557: if (mdoc->last->nchild ineq sz) \
1.1 kristaps 558: return(1); \
1.16 kristaps 559: return(lvl##_count(mdoc, #ineq, sz, p, mdoc->last->nchild)); \
1.1 kristaps 560: }
561:
562: #define CHECK_BODY_DEFN(name, lvl, func, num) \
563: static int \
564: b##lvl##_##name(POST_ARGS) \
565: { \
566: if (MDOC_BODY != mdoc->last->type) \
567: return(1); \
568: return(func(mdoc, "multi-line arguments", (num))); \
569: }
570:
571: #define CHECK_ELEM_DEFN(name, lvl, func, num) \
572: static int \
573: e##lvl##_##name(POST_ARGS) \
574: { \
575: assert(MDOC_ELEM == mdoc->last->type); \
576: return(func(mdoc, "line arguments", (num))); \
577: }
578:
579: #define CHECK_HEAD_DEFN(name, lvl, func, num) \
580: static int \
581: h##lvl##_##name(POST_ARGS) \
582: { \
583: if (MDOC_HEAD != mdoc->last->type) \
584: return(1); \
585: return(func(mdoc, "line arguments", (num))); \
586: }
587:
588:
589: CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */
590: CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */
591: CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */
592: CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */
593: CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */
594: CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */
595: CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */
596: CHECK_ELEM_DEFN(eq1, warn, warn_child_eq, 1) /* ewarn_eq1() */
597: CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0) /* ewarn_eq0() */
598: CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_gt1() */
599: CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */
600: CHECK_ELEM_DEFN(le2, err, err_child_lt, 3) /* eerr_le2() */
601: CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */
602: CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */
603: CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */
604: CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2) /* hwarn_le1() */
605: CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */
606: CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1) /* hwarn_eq1() */
607:
608:
609: static int
610: check_stdarg(PRE_ARGS)
611: {
612:
613: if (n->args && 1 == n->args->argc)
614: if (MDOC_Std == n->args->argv[0].arg)
615: return(1);
616: return(nwarn(mdoc, n, WARGVAL));
617: }
618:
619:
620: static int
621: check_sec(PRE_ARGS, ...)
622: {
623: enum mdoc_sec sec;
624: va_list ap;
625:
626: va_start(ap, n);
627:
628: for (;;) {
629: /* LINTED */
630: sec = (enum mdoc_sec)va_arg(ap, int);
631: if (SEC_CUSTOM == sec)
632: break;
633: if (sec != mdoc->lastsec)
634: continue;
635: va_end(ap);
636: return(1);
637: }
638:
639: va_end(ap);
640: return(nwarn(mdoc, n, WBADSEC));
641: }
642:
643:
644: static int
645: check_msec(PRE_ARGS, ...)
646: {
647: va_list ap;
648: int msec;
649:
650: va_start(ap, n);
651: for (;;) {
652: /* LINTED */
653: if (0 == (msec = va_arg(ap, int)))
654: break;
655: if (msec != mdoc->meta.msec)
656: continue;
657: va_end(ap);
658: return(1);
659: }
660:
661: va_end(ap);
662: return(nwarn(mdoc, n, WBADMSEC));
663: }
664:
665:
666: static int
667: check_args(struct mdoc *m, const struct mdoc_node *n)
668: {
669: int i;
670:
671: if (NULL == n->args)
672: return(1);
673:
674: assert(n->args->argc);
675: for (i = 0; i < (int)n->args->argc; i++)
676: if ( ! check_argv(m, n, &n->args->argv[i]))
677: return(0);
678:
679: return(1);
680: }
681:
682:
683: static int
684: check_argv(struct mdoc *m, const struct mdoc_node *n,
685: const struct mdoc_argv *v)
686: {
687: int i;
688:
689: for (i = 0; i < (int)v->sz; i++)
690: if ( ! check_text(m, v->line, v->pos, v->value[i]))
691: return(0);
692:
693: if (MDOC_Std == v->arg) {
694: /* `Nm' name must be set. */
695: if (v->sz || m->meta.name)
696: return(1);
697: return(nerr(m, n, ENAME));
698: }
699:
700: return(1);
701: }
702:
703:
704: static int
705: check_text(struct mdoc *mdoc, int line, int pos, const char *p)
706: {
1.18 kristaps 707: int c;
1.1 kristaps 708:
1.18 kristaps 709: for ( ; *p; p++, pos++) {
1.1 kristaps 710: if ('\t' == *p) {
711: if ( ! (MDOC_LITERAL & mdoc->flags))
1.4 kristaps 712: if ( ! warn_print(mdoc, line, pos))
713: return(0);
1.1 kristaps 714: } else if ( ! isprint((u_char)*p))
1.4 kristaps 715: if ( ! warn_print(mdoc, line, pos))
716: return(0);
1.1 kristaps 717:
718: if ('\\' != *p)
719: continue;
720:
1.18 kristaps 721: c = mandoc_special(p);
1.1 kristaps 722: if (c) {
1.18 kristaps 723: p += c - 1;
724: pos += c - 1;
1.1 kristaps 725: continue;
726: }
727: if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags))
728: return(perr(mdoc, line, pos, EESCAPE));
729: if ( ! pwarn(mdoc, line, pos, WESCAPE))
730: return(0);
731: }
732:
733: return(1);
734: }
735:
736:
737:
738:
739: static int
740: check_parent(PRE_ARGS, int tok, enum mdoc_type t)
741: {
742:
743: assert(n->parent);
744: if ((MDOC_ROOT == t || tok == n->parent->tok) &&
745: (t == n->parent->type))
746: return(1);
747:
748: return(mdoc_nerr(mdoc, n, "require parent %s",
749: MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
750: }
751:
752:
753:
754: static int
755: pre_display(PRE_ARGS)
756: {
757: struct mdoc_node *node;
758:
759: /* Display elements (`Bd', `D1'...) cannot be nested. */
760:
761: if (MDOC_BLOCK != n->type)
762: return(1);
763:
764: /* LINTED */
765: for (node = mdoc->last->parent; node; node = node->parent)
766: if (MDOC_BLOCK == node->type)
767: if (MDOC_Bd == node->tok)
768: break;
769: if (NULL == node)
770: return(1);
771:
772: return(nerr(mdoc, n, ENESTDISP));
773: }
774:
775:
776: static int
777: pre_bl(PRE_ARGS)
778: {
1.15 kristaps 779: int pos, type, width, offset;
1.1 kristaps 780:
781: if (MDOC_BLOCK != n->type)
782: return(1);
783: if (NULL == n->args)
784: return(nerr(mdoc, n, ELISTTYPE));
785:
786: /* Make sure that only one type of list is specified. */
787:
1.15 kristaps 788: type = offset = width = -1;
1.1 kristaps 789:
790: /* LINTED */
1.8 kristaps 791: for (pos = 0; pos < (int)n->args->argc; pos++)
792: switch (n->args->argv[pos].arg) {
1.1 kristaps 793: case (MDOC_Bullet):
794: /* FALLTHROUGH */
795: case (MDOC_Dash):
796: /* FALLTHROUGH */
797: case (MDOC_Enum):
798: /* FALLTHROUGH */
799: case (MDOC_Hyphen):
800: /* FALLTHROUGH */
801: case (MDOC_Item):
802: /* FALLTHROUGH */
803: case (MDOC_Tag):
804: /* FALLTHROUGH */
805: case (MDOC_Diag):
806: /* FALLTHROUGH */
807: case (MDOC_Hang):
808: /* FALLTHROUGH */
809: case (MDOC_Ohang):
810: /* FALLTHROUGH */
811: case (MDOC_Inset):
812: /* FALLTHROUGH */
813: case (MDOC_Column):
1.8 kristaps 814: if (-1 != type)
815: return(nerr(mdoc, n, EMULTILIST));
816: type = n->args->argv[pos].arg;
817: break;
1.1 kristaps 818: case (MDOC_Width):
1.8 kristaps 819: if (-1 != width)
820: return(nerr(mdoc, n, EARGREP));
821: width = n->args->argv[pos].arg;
822: break;
1.1 kristaps 823: case (MDOC_Offset):
1.8 kristaps 824: if (-1 != offset)
825: return(nerr(mdoc, n, EARGREP));
826: offset = n->args->argv[pos].arg;
827: break;
1.1 kristaps 828: default:
829: break;
830: }
831:
832: if (-1 == type)
833: return(nerr(mdoc, n, ELISTTYPE));
834:
1.8 kristaps 835: /*
836: * Validate the width field. Some list types don't need width
837: * types and should be warned about them. Others should have it
838: * and must also be warned.
839: */
840:
1.1 kristaps 841: switch (type) {
1.8 kristaps 842: case (MDOC_Tag):
843: if (-1 == width && ! nwarn(mdoc, n, WMISSWIDTH))
844: return(0);
845: break;
1.1 kristaps 846: case (MDOC_Column):
847: /* FALLTHROUGH */
848: case (MDOC_Diag):
849: /* FALLTHROUGH */
850: case (MDOC_Inset):
851: /* FALLTHROUGH */
852: case (MDOC_Item):
1.8 kristaps 853: if (-1 != width && ! nwarn(mdoc, n, WNOWIDTH))
854: return(0);
855: break;
856: default:
857: break;
858: }
859:
1.1 kristaps 860: return(1);
861: }
862:
863:
864: static int
865: pre_bd(PRE_ARGS)
866: {
867: int i, type, err;
868:
869: if (MDOC_BLOCK != n->type)
870: return(1);
871: if (NULL == n->args)
872: return(nerr(mdoc, n, EDISPTYPE));
873:
874: /* Make sure that only one type of display is specified. */
875:
876: /* LINTED */
877: for (i = 0, err = type = 0; ! err &&
878: i < (int)n->args->argc; i++)
879: switch (n->args->argv[i].arg) {
880: case (MDOC_Ragged):
881: /* FALLTHROUGH */
882: case (MDOC_Unfilled):
883: /* FALLTHROUGH */
884: case (MDOC_Filled):
885: /* FALLTHROUGH */
886: case (MDOC_Literal):
887: /* FALLTHROUGH */
888: case (MDOC_File):
889: if (0 == type++)
890: break;
891: return(nerr(mdoc, n, EMULTIDISP));
892: default:
893: break;
894: }
895:
896: if (type)
897: return(1);
898: return(nerr(mdoc, n, EDISPTYPE));
899: }
900:
901:
902: static int
903: pre_ss(PRE_ARGS)
904: {
905:
906: if (MDOC_BLOCK != n->type)
907: return(1);
908: return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
909: }
910:
911:
912: static int
913: pre_sh(PRE_ARGS)
914: {
915:
916: if (MDOC_BLOCK != n->type)
917: return(1);
918: return(check_parent(mdoc, n, -1, MDOC_ROOT));
919: }
920:
921:
922: static int
923: pre_it(PRE_ARGS)
924: {
925:
926: if (MDOC_BLOCK != n->type)
927: return(1);
928: return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
929: }
930:
931:
932: static int
933: pre_an(PRE_ARGS)
934: {
935:
936: if (NULL == n->args || 1 == n->args->argc)
937: return(1);
938: return(mdoc_nerr(mdoc, n, "only one argument allowed"));
939: }
940:
941:
942: static int
943: pre_lb(PRE_ARGS)
944: {
945:
946: return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM));
947: }
948:
949:
950: static int
951: pre_rv(PRE_ARGS)
952: {
953:
954: if ( ! check_msec(mdoc, n, 2, 3, 0))
955: return(0);
956: return(check_stdarg(mdoc, n));
957: }
958:
959:
960: static int
961: pre_ex(PRE_ARGS)
962: {
963:
964: if ( ! check_msec(mdoc, n, 1, 6, 8, 0))
965: return(0);
966: return(check_stdarg(mdoc, n));
967: }
968:
969:
970: static int
971: pre_er(PRE_ARGS)
972: {
973:
1.6 kristaps 974: return(check_msec(mdoc, n, 2, 3, 9, 0));
1.1 kristaps 975: }
976:
977:
978: static int
979: pre_cd(PRE_ARGS)
980: {
981:
982: return(check_msec(mdoc, n, 4, 0));
983: }
984:
985:
986: static int
987: pre_dt(PRE_ARGS)
988: {
989:
990: if (0 == mdoc->meta.date || mdoc->meta.os)
991: if ( ! nwarn(mdoc, n, WPROLOOO))
992: return(0);
993: if (mdoc->meta.title)
994: if ( ! nwarn(mdoc, n, WPROLREP))
995: return(0);
996: return(1);
997: }
998:
999:
1000: static int
1001: pre_os(PRE_ARGS)
1002: {
1003:
1004: if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
1005: if ( ! nwarn(mdoc, n, WPROLOOO))
1006: return(0);
1007: if (mdoc->meta.os)
1008: if ( ! nwarn(mdoc, n, WPROLREP))
1009: return(0);
1010: return(1);
1011: }
1012:
1013:
1014: static int
1015: pre_dd(PRE_ARGS)
1016: {
1017:
1018: if (mdoc->meta.title || mdoc->meta.os)
1019: if ( ! nwarn(mdoc, n, WPROLOOO))
1020: return(0);
1021: if (mdoc->meta.date)
1022: if ( ! nwarn(mdoc, n, WPROLREP))
1023: return(0);
1024: return(1);
1025: }
1026:
1027:
1028: static int
1029: post_bf(POST_ARGS)
1030: {
1031: char *p;
1032: struct mdoc_node *head;
1033:
1034: if (MDOC_BLOCK != mdoc->last->type)
1035: return(1);
1036:
1037: head = mdoc->last->head;
1038:
1.12 kristaps 1039: if (mdoc->last->args && head->child)
1.13 kristaps 1040: return(mdoc_err(mdoc, "one argument expected"));
1041: else if (mdoc->last->args)
1042: return(1);
1.12 kristaps 1043:
1.13 kristaps 1044: if (NULL == head->child || MDOC_TEXT != head->child->type)
1045: return(mdoc_err(mdoc, "text argument expected"));
1.1 kristaps 1046:
1.13 kristaps 1047: p = head->child->string;
1.1 kristaps 1048:
1.13 kristaps 1049: if (0 == strcmp(p, "Em"))
1050: return(1);
1051: else if (0 == strcmp(p, "Li"))
1052: return(1);
1053: else if (0 == strcmp(p, "Sm"))
1054: return(1);
1.1 kristaps 1055:
1.13 kristaps 1056: return(mdoc_nerr(mdoc, head->child, "invalid font mode"));
1.1 kristaps 1057: }
1058:
1059:
1060: static int
1061: post_nm(POST_ARGS)
1062: {
1063:
1064: if (mdoc->last->child)
1065: return(1);
1066: if (mdoc->meta.name)
1067: return(1);
1.2 kristaps 1068: return(verr(mdoc, ENAME));
1.1 kristaps 1069: }
1070:
1071:
1072: static int
1073: post_at(POST_ARGS)
1074: {
1075:
1076: if (NULL == mdoc->last->child)
1077: return(1);
1078: if (MDOC_TEXT != mdoc->last->child->type)
1.2 kristaps 1079: return(verr(mdoc, EATT));
1.1 kristaps 1080: if (mdoc_a2att(mdoc->last->child->string))
1081: return(1);
1.2 kristaps 1082: return(verr(mdoc, EATT));
1.1 kristaps 1083: }
1084:
1085:
1086: static int
1087: post_an(POST_ARGS)
1088: {
1089:
1090: if (mdoc->last->args) {
1091: if (NULL == mdoc->last->child)
1092: return(1);
1.2 kristaps 1093: return(verr(mdoc, ELINE));
1.1 kristaps 1094: }
1095:
1096: if (mdoc->last->child)
1097: return(1);
1.2 kristaps 1098: return(verr(mdoc, ELINE));
1.1 kristaps 1099: }
1100:
1101:
1102: static int
1103: post_args(POST_ARGS)
1104: {
1105:
1106: if (mdoc->last->args)
1107: return(1);
1.2 kristaps 1108: return(verr(mdoc, ELINE));
1.1 kristaps 1109: }
1110:
1111:
1112: static int
1113: post_it(POST_ARGS)
1114: {
1115: int type, i, cols;
1116: struct mdoc_node *n, *c;
1117:
1118: if (MDOC_BLOCK != mdoc->last->type)
1119: return(1);
1120:
1121: n = mdoc->last->parent->parent;
1122: if (NULL == n->args)
1.2 kristaps 1123: return(verr(mdoc, ELISTTYPE));
1.1 kristaps 1124:
1125: /* Some types require block-head, some not. */
1126:
1127: /* LINTED */
1128: for (cols = type = -1, i = 0; -1 == type &&
1129: i < (int)n->args->argc; i++)
1130: switch (n->args->argv[i].arg) {
1131: case (MDOC_Tag):
1132: /* FALLTHROUGH */
1133: case (MDOC_Diag):
1134: /* FALLTHROUGH */
1135: case (MDOC_Hang):
1136: /* FALLTHROUGH */
1137: case (MDOC_Ohang):
1138: /* FALLTHROUGH */
1139: case (MDOC_Inset):
1140: /* FALLTHROUGH */
1141: case (MDOC_Bullet):
1142: /* FALLTHROUGH */
1143: case (MDOC_Dash):
1144: /* FALLTHROUGH */
1145: case (MDOC_Enum):
1146: /* FALLTHROUGH */
1147: case (MDOC_Hyphen):
1148: /* FALLTHROUGH */
1149: case (MDOC_Item):
1150: type = n->args->argv[i].arg;
1151: break;
1152: case (MDOC_Column):
1153: type = n->args->argv[i].arg;
1154: cols = (int)n->args->argv[i].sz;
1155: break;
1156: default:
1157: break;
1158: }
1159:
1160: if (-1 == type)
1.2 kristaps 1161: return(verr(mdoc, ELISTTYPE));
1.1 kristaps 1162:
1163: switch (type) {
1164: case (MDOC_Tag):
1165: if (NULL == mdoc->last->head->child)
1.2 kristaps 1166: if ( ! vwarn(mdoc, WLINE))
1.1 kristaps 1167: return(0);
1168: break;
1169: case (MDOC_Hang):
1170: /* FALLTHROUGH */
1171: case (MDOC_Ohang):
1172: /* FALLTHROUGH */
1173: case (MDOC_Inset):
1174: /* FALLTHROUGH */
1175: case (MDOC_Diag):
1176: if (NULL == mdoc->last->head->child)
1.2 kristaps 1177: if ( ! vwarn(mdoc, WLINE))
1.1 kristaps 1178: return(0);
1179: if (NULL == mdoc->last->body->child)
1.2 kristaps 1180: if ( ! vwarn(mdoc, WMULTILINE))
1.1 kristaps 1181: return(0);
1182: break;
1183: case (MDOC_Bullet):
1184: /* FALLTHROUGH */
1185: case (MDOC_Dash):
1186: /* FALLTHROUGH */
1187: case (MDOC_Enum):
1188: /* FALLTHROUGH */
1189: case (MDOC_Hyphen):
1190: /* FALLTHROUGH */
1191: case (MDOC_Item):
1192: if (mdoc->last->head->child)
1.2 kristaps 1193: if ( ! vwarn(mdoc, WNOLINE))
1.1 kristaps 1194: return(0);
1195: if (NULL == mdoc->last->body->child)
1.2 kristaps 1196: if ( ! vwarn(mdoc, WMULTILINE))
1.1 kristaps 1197: return(0);
1198: break;
1199: case (MDOC_Column):
1200: if (NULL == mdoc->last->head->child)
1.2 kristaps 1201: if ( ! vwarn(mdoc, WLINE))
1.1 kristaps 1202: return(0);
1203: if (mdoc->last->body->child)
1.2 kristaps 1204: if ( ! vwarn(mdoc, WNOMULTILINE))
1.1 kristaps 1205: return(0);
1206: c = mdoc->last->child;
1207: for (i = 0; c && MDOC_HEAD == c->type; c = c->next)
1208: i++;
1209: if (i == cols)
1210: break;
1211: return(mdoc_err(mdoc, "column mismatch (have "
1212: "%d, want %d)", i, cols));
1213: default:
1214: break;
1215: }
1216:
1217: return(1);
1218: }
1219:
1220:
1221: static int
1.14 kristaps 1222: post_bl_head(POST_ARGS)
1223: {
1224: int i;
1225: const struct mdoc_node *n;
1226:
1227: n = mdoc->last->parent;
1228: assert(n->args);
1229:
1230: for (i = 0; i < (int)n->args->argc; i++)
1231: if (n->args->argv[i].arg == MDOC_Column)
1232: break;
1233:
1234: if (i == (int)n->args->argc)
1235: return(1);
1236:
1237: if (n->args->argv[i].sz && mdoc->last->child)
1238: return(nerr(mdoc, n, ECOLMIS));
1239:
1240: return(1);
1241: }
1242:
1243:
1244: static int
1.1 kristaps 1245: post_bl(POST_ARGS)
1246: {
1247: struct mdoc_node *n;
1248:
1.14 kristaps 1249: if (MDOC_HEAD == mdoc->last->type)
1250: return(post_bl_head(mdoc));
1.1 kristaps 1251: if (MDOC_BODY != mdoc->last->type)
1252: return(1);
1253: if (NULL == mdoc->last->child)
1254: return(1);
1255:
1256: /* LINTED */
1257: for (n = mdoc->last->child; n; n = n->next) {
1258: if (MDOC_BLOCK == n->type)
1259: if (MDOC_It == n->tok)
1260: continue;
1261: return(mdoc_nerr(mdoc, n, "bad child of parent %s",
1262: mdoc_macronames[mdoc->last->tok]));
1263: }
1264:
1265: return(1);
1266: }
1267:
1268:
1269: static int
1270: ebool(struct mdoc *mdoc)
1271: {
1272: struct mdoc_node *n;
1273:
1274: /* LINTED */
1275: for (n = mdoc->last->child; n; n = n->next) {
1276: if (MDOC_TEXT != n->type)
1277: break;
1.2 kristaps 1278: if (0 == strcmp(n->string, "on"))
1.1 kristaps 1279: continue;
1.2 kristaps 1280: if (0 == strcmp(n->string, "off"))
1.1 kristaps 1281: continue;
1282: break;
1283: }
1284:
1285: if (NULL == n)
1286: return(1);
1287: return(nerr(mdoc, n, EBOOL));
1288: }
1289:
1290:
1291: static int
1292: post_root(POST_ARGS)
1293: {
1294:
1295: if (NULL == mdoc->first->child)
1.2 kristaps 1296: return(verr(mdoc, ENODATA));
1.12 kristaps 1297: if ( ! (MDOC_PBODY & mdoc->flags))
1.2 kristaps 1298: return(verr(mdoc, ENOPROLOGUE));
1.1 kristaps 1299:
1300: if (MDOC_BLOCK != mdoc->first->child->type)
1.2 kristaps 1301: return(verr(mdoc, ENODATA));
1.1 kristaps 1302: if (MDOC_Sh != mdoc->first->child->tok)
1.2 kristaps 1303: return(verr(mdoc, ENODATA));
1.1 kristaps 1304:
1305: return(1);
1306: }
1307:
1308:
1309: static int
1310: post_st(POST_ARGS)
1311: {
1312:
1313: if (mdoc_a2st(mdoc->last->child->string))
1314: return(1);
1.2 kristaps 1315: return(vwarn(mdoc, WBADSTAND));
1.1 kristaps 1316: }
1317:
1318:
1319: static int
1320: post_sh(POST_ARGS)
1321: {
1322:
1323: if (MDOC_HEAD == mdoc->last->type)
1324: return(post_sh_head(mdoc));
1325: if (MDOC_BODY == mdoc->last->type)
1326: return(post_sh_body(mdoc));
1327:
1328: return(1);
1329: }
1330:
1331:
1332: static int
1333: post_sh_body(POST_ARGS)
1334: {
1335: struct mdoc_node *n;
1336:
1337: if (SEC_NAME != mdoc->lastnamed)
1338: return(1);
1339:
1340: /*
1341: * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1342: * macros (can have multiple `Nm' and one `Nd'). Note that the
1343: * children of the BODY declaration can also be "text".
1344: */
1345:
1346: if (NULL == (n = mdoc->last->child))
1.2 kristaps 1347: return(vwarn(mdoc, WNAMESECINC));
1.1 kristaps 1348:
1349: for ( ; n && n->next; n = n->next) {
1350: if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1351: continue;
1352: if (MDOC_TEXT == n->type)
1353: continue;
1.2 kristaps 1354: if ( ! vwarn(mdoc, WNAMESECINC))
1.1 kristaps 1355: return(0);
1356: }
1357:
1358: if (MDOC_ELEM == n->type && MDOC_Nd == n->tok)
1359: return(1);
1.2 kristaps 1360: return(vwarn(mdoc, WNAMESECINC));
1.1 kristaps 1361: }
1362:
1363:
1364: static int
1365: post_sh_head(POST_ARGS)
1366: {
1.2 kristaps 1367: char buf[64];
1368: enum mdoc_sec sec;
1369: const struct mdoc_node *n;
1.1 kristaps 1370:
1371: /*
1372: * Process a new section. Sections are either "named" or
1373: * "custom"; custom sections are user-defined, while named ones
1374: * usually follow a conventional order and may only appear in
1375: * certain manual sections.
1376: */
1377:
1.12 kristaps 1378: buf[0] = 0;
1.1 kristaps 1379:
1.2 kristaps 1380: for (n = mdoc->last->child; n; n = n->next) {
1.12 kristaps 1381: /* XXX - copied from compact(). */
1.2 kristaps 1382: assert(MDOC_TEXT == n->type);
1.12 kristaps 1383:
1.2 kristaps 1384: if (strlcat(buf, n->string, 64) >= 64)
1385: return(nerr(mdoc, n, ETOOLONG));
1386: if (NULL == n->next)
1387: continue;
1388: if (strlcat(buf, " ", 64) >= 64)
1389: return(nerr(mdoc, n, ETOOLONG));
1390: }
1.1 kristaps 1391:
1392: sec = mdoc_atosec(buf);
1393:
1.12 kristaps 1394: /*
1395: * Check: NAME should always be first, CUSTOM has no roles,
1396: * non-CUSTOM has a conventional order to be followed.
1397: */
1.1 kristaps 1398:
1.12 kristaps 1399: if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
1400: return(verr(mdoc, ESECNAME));
1.1 kristaps 1401: if (SEC_CUSTOM == sec)
1402: return(1);
1403: if (sec == mdoc->lastnamed)
1.2 kristaps 1404: return(vwarn(mdoc, WSECREP));
1.1 kristaps 1405: if (sec < mdoc->lastnamed)
1.2 kristaps 1406: return(vwarn(mdoc, WSECOOO));
1.1 kristaps 1407:
1.12 kristaps 1408: /*
1409: * Check particular section/manual conventions. LIBRARY can
1410: * only occur in msec 2, 3 (TODO: are there more of these?).
1411: */
1.1 kristaps 1412:
1413: switch (sec) {
1414: case (SEC_LIBRARY):
1415: switch (mdoc->meta.msec) {
1416: case (2):
1417: /* FALLTHROUGH */
1418: case (3):
1419: break;
1420: default:
1.2 kristaps 1421: return(vwarn(mdoc, WWRONGMSEC));
1.1 kristaps 1422: }
1423: break;
1424: default:
1425: break;
1426: }
1427:
1428: return(1);
1429: }
1430:
1431:
1432: static int
1433: pre_fd(PRE_ARGS)
1434: {
1435:
1436: return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM));
1437: }
CVSweb