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