Annotation of mandoc/mdoc_validate.c, Revision 1.84
1.84 ! kristaps 1: /* $Id: mdoc_validate.c,v 1.83 2010/05/26 09:35:35 kristaps Exp $ */
1.1 kristaps 2: /*
1.77 kristaps 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
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: */
1.56 kristaps 17: #ifdef HAVE_CONFIG_H
18: #include "config.h"
19: #endif
20:
1.1 kristaps 21: #include <sys/types.h>
22:
23: #include <assert.h>
24: #include <ctype.h>
1.35 kristaps 25: #include <limits.h>
1.81 kristaps 26: #include <stdio.h>
1.1 kristaps 27: #include <stdlib.h>
1.2 kristaps 28: #include <string.h>
1.1 kristaps 29:
1.79 kristaps 30: #include "mandoc.h"
1.1 kristaps 31: #include "libmdoc.h"
1.18 kristaps 32: #include "libmandoc.h"
1.1 kristaps 33:
34: /* FIXME: .Bl -diag can't have non-text children in HEAD. */
35: /* TODO: ignoring Pp (it's superfluous in some invocations). */
36:
1.32 kristaps 37: #define PRE_ARGS struct mdoc *mdoc, const struct mdoc_node *n
38: #define POST_ARGS struct mdoc *mdoc
1.1 kristaps 39:
40: typedef int (*v_pre)(PRE_ARGS);
41: typedef int (*v_post)(POST_ARGS);
42:
43: struct valids {
44: v_pre *pre;
45: v_post *post;
46: };
47:
1.59 kristaps 48: static int check_parent(PRE_ARGS, enum mdoct, enum mdoc_type);
1.32 kristaps 49: static int check_stdarg(PRE_ARGS);
50: static int check_text(struct mdoc *, int, int, const char *);
51: static int check_argv(struct mdoc *,
1.1 kristaps 52: const struct mdoc_node *,
53: const struct mdoc_argv *);
1.32 kristaps 54: static int check_args(struct mdoc *,
1.1 kristaps 55: const struct mdoc_node *);
1.32 kristaps 56: static int err_child_lt(struct mdoc *, const char *, int);
57: static int warn_child_lt(struct mdoc *, const char *, int);
58: static int err_child_gt(struct mdoc *, const char *, int);
59: static int warn_child_gt(struct mdoc *, const char *, int);
60: static int err_child_eq(struct mdoc *, const char *, int);
61: static int warn_child_eq(struct mdoc *, const char *, int);
62: static int warn_count(struct mdoc *, const char *,
1.1 kristaps 63: int, const char *, int);
1.32 kristaps 64: static int err_count(struct mdoc *, const char *,
1.1 kristaps 65: int, const char *, int);
1.32 kristaps 66:
67: static int berr_ge1(POST_ARGS);
68: static int bwarn_ge1(POST_ARGS);
69: static int ebool(POST_ARGS);
70: static int eerr_eq0(POST_ARGS);
71: static int eerr_eq1(POST_ARGS);
72: static int eerr_ge1(POST_ARGS);
1.46 kristaps 73: static int eerr_le1(POST_ARGS);
1.32 kristaps 74: static int ewarn_ge1(POST_ARGS);
75: static int herr_eq0(POST_ARGS);
76: static int herr_ge1(POST_ARGS);
77: static int hwarn_eq1(POST_ARGS);
1.66 kristaps 78: static int hwarn_eq0(POST_ARGS);
1.32 kristaps 79: static int hwarn_le1(POST_ARGS);
80:
81: static int post_an(POST_ARGS);
82: static int post_at(POST_ARGS);
83: static int post_bf(POST_ARGS);
84: static int post_bl(POST_ARGS);
85: static int post_bl_head(POST_ARGS);
86: static int post_it(POST_ARGS);
87: static int post_lb(POST_ARGS);
88: static int post_nm(POST_ARGS);
89: static int post_root(POST_ARGS);
1.43 kristaps 90: static int post_rs(POST_ARGS);
1.32 kristaps 91: static int post_sh(POST_ARGS);
92: static int post_sh_body(POST_ARGS);
93: static int post_sh_head(POST_ARGS);
94: static int post_st(POST_ARGS);
1.84 ! kristaps 95: static int post_eoln(POST_ARGS);
1.57 kristaps 96: static int post_vt(POST_ARGS);
1.32 kristaps 97: static int pre_an(PRE_ARGS);
98: static int pre_bd(PRE_ARGS);
99: static int pre_bl(PRE_ARGS);
100: static int pre_dd(PRE_ARGS);
101: static int pre_display(PRE_ARGS);
102: static int pre_dt(PRE_ARGS);
103: static int pre_it(PRE_ARGS);
104: static int pre_os(PRE_ARGS);
105: static int pre_rv(PRE_ARGS);
106: static int pre_sh(PRE_ARGS);
107: static int pre_ss(PRE_ARGS);
108:
109: static v_post posts_an[] = { post_an, NULL };
110: static v_post posts_at[] = { post_at, NULL };
1.66 kristaps 111: static v_post posts_bd[] = { hwarn_eq0, bwarn_ge1, NULL };
1.32 kristaps 112: static v_post posts_bf[] = { hwarn_le1, post_bf, NULL };
113: static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL };
114: static v_post posts_bool[] = { eerr_eq1, ebool, NULL };
1.84 ! kristaps 115: static v_post posts_eoln[] = { post_eoln, NULL };
1.32 kristaps 116: static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
117: static v_post posts_it[] = { post_it, NULL };
118: static v_post posts_lb[] = { eerr_eq1, post_lb, NULL };
119: static v_post posts_nd[] = { berr_ge1, NULL };
120: static v_post posts_nm[] = { post_nm, NULL };
121: static v_post posts_notext[] = { eerr_eq0, NULL };
1.44 kristaps 122: static v_post posts_rs[] = { berr_ge1, herr_eq0, post_rs, NULL };
1.32 kristaps 123: static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
1.46 kristaps 124: static v_post posts_sp[] = { eerr_le1, NULL };
1.32 kristaps 125: static v_post posts_ss[] = { herr_ge1, NULL };
126: static v_post posts_st[] = { eerr_eq1, post_st, NULL };
127: static v_post posts_text[] = { eerr_ge1, NULL };
1.51 kristaps 128: static v_post posts_text1[] = { eerr_eq1, NULL };
1.57 kristaps 129: static v_post posts_vt[] = { post_vt, NULL };
1.32 kristaps 130: static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
131: static v_post posts_wtext[] = { ewarn_ge1, NULL };
132: static v_pre pres_an[] = { pre_an, NULL };
133: static v_pre pres_bd[] = { pre_display, pre_bd, NULL };
134: static v_pre pres_bl[] = { pre_bl, NULL };
135: static v_pre pres_d1[] = { pre_display, NULL };
136: static v_pre pres_dd[] = { pre_dd, NULL };
137: static v_pre pres_dt[] = { pre_dt, NULL };
1.67 kristaps 138: static v_pre pres_er[] = { NULL, NULL };
1.76 kristaps 139: static v_pre pres_ex[] = { NULL, NULL };
1.77 kristaps 140: static v_pre pres_fd[] = { NULL, NULL };
1.32 kristaps 141: static v_pre pres_it[] = { pre_it, NULL };
142: static v_pre pres_os[] = { pre_os, NULL };
143: static v_pre pres_rv[] = { pre_rv, NULL };
144: static v_pre pres_sh[] = { pre_sh, NULL };
145: static v_pre pres_ss[] = { pre_ss, NULL };
1.1 kristaps 146:
147: const struct valids mdoc_valids[MDOC_MAX] = {
1.10 kristaps 148: { NULL, NULL }, /* Ap */
1.1 kristaps 149: { pres_dd, posts_text }, /* Dd */
150: { pres_dt, NULL }, /* Dt */
151: { pres_os, NULL }, /* Os */
152: { pres_sh, posts_sh }, /* Sh */
153: { pres_ss, posts_ss }, /* Ss */
1.34 kristaps 154: { NULL, posts_notext }, /* Pp */
1.1 kristaps 155: { pres_d1, posts_wline }, /* D1 */
156: { pres_d1, posts_wline }, /* Dl */
157: { pres_bd, posts_bd }, /* Bd */
158: { NULL, NULL }, /* Ed */
159: { pres_bl, posts_bl }, /* Bl */
160: { NULL, NULL }, /* El */
161: { pres_it, posts_it }, /* It */
162: { NULL, posts_text }, /* Ad */
163: { pres_an, posts_an }, /* An */
164: { NULL, NULL }, /* Ar */
1.69 kristaps 165: { NULL, posts_text }, /* Cd */
1.1 kristaps 166: { NULL, NULL }, /* Cm */
167: { NULL, NULL }, /* Dv */
168: { pres_er, posts_text }, /* Er */
169: { NULL, NULL }, /* Ev */
1.42 kristaps 170: { pres_ex, NULL }, /* Ex */
1.1 kristaps 171: { NULL, NULL }, /* Fa */
172: { pres_fd, posts_wtext }, /* Fd */
173: { NULL, NULL }, /* Fl */
174: { NULL, posts_text }, /* Fn */
175: { NULL, posts_wtext }, /* Ft */
176: { NULL, posts_text }, /* Ic */
1.51 kristaps 177: { NULL, posts_text1 }, /* In */
1.1 kristaps 178: { NULL, NULL }, /* Li */
1.27 kristaps 179: { NULL, posts_nd }, /* Nd */
1.1 kristaps 180: { NULL, posts_nm }, /* Nm */
181: { NULL, posts_wline }, /* Op */
182: { NULL, NULL }, /* Ot */
183: { NULL, NULL }, /* Pa */
1.42 kristaps 184: { pres_rv, NULL }, /* Rv */
1.1 kristaps 185: { NULL, posts_st }, /* St */
186: { NULL, NULL }, /* Va */
1.57 kristaps 187: { NULL, posts_vt }, /* Vt */
1.84 ! kristaps 188: { NULL, posts_wtext }, /* Xr */
1.1 kristaps 189: { NULL, posts_text }, /* %A */
1.47 kristaps 190: { NULL, posts_text }, /* %B */ /* FIXME: can be used outside Rs/Re. */
1.54 kristaps 191: { NULL, posts_text }, /* %D */ /* FIXME: check date with mandoc_a2time(). */
1.1 kristaps 192: { NULL, posts_text }, /* %I */
193: { NULL, posts_text }, /* %J */
194: { NULL, posts_text }, /* %N */
195: { NULL, posts_text }, /* %O */
196: { NULL, posts_text }, /* %P */
197: { NULL, posts_text }, /* %R */
1.47 kristaps 198: { NULL, posts_text }, /* %T */ /* FIXME: can be used outside Rs/Re. */
1.1 kristaps 199: { NULL, posts_text }, /* %V */
200: { NULL, NULL }, /* Ac */
201: { NULL, NULL }, /* Ao */
202: { NULL, posts_wline }, /* Aq */
203: { NULL, posts_at }, /* At */
204: { NULL, NULL }, /* Bc */
205: { NULL, posts_bf }, /* Bf */
206: { NULL, NULL }, /* Bo */
207: { NULL, posts_wline }, /* Bq */
208: { NULL, NULL }, /* Bsx */
209: { NULL, NULL }, /* Bx */
210: { NULL, posts_bool }, /* Db */
211: { NULL, NULL }, /* Dc */
212: { NULL, NULL }, /* Do */
213: { NULL, posts_wline }, /* Dq */
214: { NULL, NULL }, /* Ec */
215: { NULL, NULL }, /* Ef */
216: { NULL, NULL }, /* Em */
217: { NULL, NULL }, /* Eo */
218: { NULL, NULL }, /* Fx */
219: { NULL, posts_text }, /* Ms */
220: { NULL, posts_notext }, /* No */
221: { NULL, posts_notext }, /* Ns */
222: { NULL, NULL }, /* Nx */
223: { NULL, NULL }, /* Ox */
224: { NULL, NULL }, /* Pc */
1.51 kristaps 225: { NULL, posts_text1 }, /* Pf */
1.1 kristaps 226: { NULL, NULL }, /* Po */
227: { NULL, posts_wline }, /* Pq */
228: { NULL, NULL }, /* Qc */
229: { NULL, posts_wline }, /* Ql */
230: { NULL, NULL }, /* Qo */
231: { NULL, posts_wline }, /* Qq */
232: { NULL, NULL }, /* Re */
1.43 kristaps 233: { NULL, posts_rs }, /* Rs */
1.1 kristaps 234: { NULL, NULL }, /* Sc */
235: { NULL, NULL }, /* So */
236: { NULL, posts_wline }, /* Sq */
237: { NULL, posts_bool }, /* Sm */
238: { NULL, posts_text }, /* Sx */
239: { NULL, posts_text }, /* Sy */
240: { NULL, posts_text }, /* Tn */
241: { NULL, NULL }, /* Ux */
242: { NULL, NULL }, /* Xc */
243: { NULL, NULL }, /* Xo */
244: { NULL, posts_fo }, /* Fo */
245: { NULL, NULL }, /* Fc */
246: { NULL, NULL }, /* Oo */
247: { NULL, NULL }, /* Oc */
248: { NULL, posts_wline }, /* Bk */
249: { NULL, NULL }, /* Ek */
1.84 ! kristaps 250: { NULL, posts_eoln }, /* Bt */
1.1 kristaps 251: { NULL, NULL }, /* Hf */
252: { NULL, NULL }, /* Fr */
1.84 ! kristaps 253: { NULL, posts_eoln }, /* Ud */
1.83 kristaps 254: { NULL, posts_lb }, /* Lb */
1.34 kristaps 255: { NULL, posts_notext }, /* Lp */
1.51 kristaps 256: { NULL, posts_text }, /* Lk */
1.1 kristaps 257: { NULL, posts_text }, /* Mt */
258: { NULL, posts_wline }, /* Brq */
259: { NULL, NULL }, /* Bro */
260: { NULL, NULL }, /* Brc */
261: { NULL, posts_text }, /* %C */
262: { NULL, NULL }, /* Es */
263: { NULL, NULL }, /* En */
264: { NULL, NULL }, /* Dx */
265: { NULL, posts_text }, /* %Q */
1.33 kristaps 266: { NULL, posts_notext }, /* br */
1.35 kristaps 267: { NULL, posts_sp }, /* sp */
1.51 kristaps 268: { NULL, posts_text1 }, /* %U */
1.1 kristaps 269: };
270:
271:
272: int
1.32 kristaps 273: mdoc_valid_pre(struct mdoc *mdoc, const struct mdoc_node *n)
1.1 kristaps 274: {
275: v_pre *p;
276: int line, pos;
277: const char *tp;
278:
279: if (MDOC_TEXT == n->type) {
280: tp = n->string;
281: line = n->line;
282: pos = n->pos;
283: return(check_text(mdoc, line, pos, tp));
284: }
285:
286: if ( ! check_args(mdoc, n))
287: return(0);
288: if (NULL == mdoc_valids[n->tok].pre)
289: return(1);
290: for (p = mdoc_valids[n->tok].pre; *p; p++)
291: if ( ! (*p)(mdoc, n))
292: return(0);
293: return(1);
294: }
295:
296:
297: int
298: mdoc_valid_post(struct mdoc *mdoc)
299: {
300: v_post *p;
301:
302: if (MDOC_VALID & mdoc->last->flags)
303: return(1);
304: mdoc->last->flags |= MDOC_VALID;
305:
306: if (MDOC_TEXT == mdoc->last->type)
307: return(1);
308: if (MDOC_ROOT == mdoc->last->type)
309: return(post_root(mdoc));
310:
311: if (NULL == mdoc_valids[mdoc->last->tok].post)
312: return(1);
313: for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
314: if ( ! (*p)(mdoc))
315: return(0);
316:
317: return(1);
318: }
319:
320:
321: static inline int
322: warn_count(struct mdoc *m, const char *k,
323: int want, const char *v, int has)
324: {
325:
1.79 kristaps 326: return(mdoc_vmsg(m, MANDOCERR_ARGCOUNT,
327: m->last->line, m->last->pos,
328: "%s %s %d (have %d)", v, k, want, has));
1.1 kristaps 329: }
330:
331:
332: static inline int
333: err_count(struct mdoc *m, const char *k,
334: int want, const char *v, int has)
335: {
336:
1.79 kristaps 337: mdoc_vmsg(m, MANDOCERR_SYNTARGCOUNT,
338: m->last->line, m->last->pos,
339: "%s %s %d (have %d)",
340: v, k, want, has);
341: return(0);
1.1 kristaps 342: }
343:
344:
345: /*
346: * Build these up with macros because they're basically the same check
347: * for different inequalities. Yes, this could be done with functions,
348: * but this is reasonable for now.
349: */
350:
351: #define CHECK_CHILD_DEFN(lvl, name, ineq) \
352: static int \
353: lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \
354: { \
1.16 kristaps 355: if (mdoc->last->nchild ineq sz) \
1.1 kristaps 356: return(1); \
1.16 kristaps 357: return(lvl##_count(mdoc, #ineq, sz, p, mdoc->last->nchild)); \
1.1 kristaps 358: }
359:
360: #define CHECK_BODY_DEFN(name, lvl, func, num) \
361: static int \
362: b##lvl##_##name(POST_ARGS) \
363: { \
364: if (MDOC_BODY != mdoc->last->type) \
365: return(1); \
366: return(func(mdoc, "multi-line arguments", (num))); \
367: }
368:
369: #define CHECK_ELEM_DEFN(name, lvl, func, num) \
370: static int \
371: e##lvl##_##name(POST_ARGS) \
372: { \
373: assert(MDOC_ELEM == mdoc->last->type); \
374: return(func(mdoc, "line arguments", (num))); \
375: }
376:
377: #define CHECK_HEAD_DEFN(name, lvl, func, num) \
378: static int \
379: h##lvl##_##name(POST_ARGS) \
380: { \
381: if (MDOC_HEAD != mdoc->last->type) \
382: return(1); \
383: return(func(mdoc, "line arguments", (num))); \
384: }
385:
386:
387: CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */
388: CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */
389: CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */
390: CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */
391: CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */
392: CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */
393: CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */
1.27 kristaps 394: CHECK_BODY_DEFN(ge1, err, err_child_gt, 0) /* berr_ge1() */
1.84 ! kristaps 395: CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_ge1() */
1.1 kristaps 396: CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */
1.46 kristaps 397: CHECK_ELEM_DEFN(le1, err, err_child_lt, 2) /* eerr_le1() */
1.1 kristaps 398: CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */
399: CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */
400: CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */
401: CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2) /* hwarn_le1() */
402: CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */
403: CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1) /* hwarn_eq1() */
1.66 kristaps 404: CHECK_HEAD_DEFN(eq0, warn, warn_child_eq, 0) /* hwarn_eq0() */
1.1 kristaps 405:
406:
407: static int
408: check_stdarg(PRE_ARGS)
409: {
410:
411: if (n->args && 1 == n->args->argc)
412: if (MDOC_Std == n->args->argv[0].arg)
413: return(1);
1.79 kristaps 414: return(mdoc_nmsg(mdoc, n, MANDOCERR_NOARGV));
1.1 kristaps 415: }
416:
417:
418: static int
419: check_args(struct mdoc *m, const struct mdoc_node *n)
420: {
421: int i;
422:
423: if (NULL == n->args)
424: return(1);
425:
426: assert(n->args->argc);
427: for (i = 0; i < (int)n->args->argc; i++)
428: if ( ! check_argv(m, n, &n->args->argv[i]))
429: return(0);
430:
431: return(1);
432: }
433:
434:
435: static int
436: check_argv(struct mdoc *m, const struct mdoc_node *n,
437: const struct mdoc_argv *v)
438: {
439: int i;
440:
441: for (i = 0; i < (int)v->sz; i++)
442: if ( ! check_text(m, v->line, v->pos, v->value[i]))
443: return(0);
444:
445: if (MDOC_Std == v->arg) {
446: if (v->sz || m->meta.name)
447: return(1);
1.79 kristaps 448: if ( ! mdoc_nmsg(m, n, MANDOCERR_NONAME))
449: return(0);
1.1 kristaps 450: }
451:
452: return(1);
453: }
454:
455:
456: static int
457: check_text(struct mdoc *mdoc, int line, int pos, const char *p)
458: {
1.18 kristaps 459: int c;
1.1 kristaps 460:
1.18 kristaps 461: for ( ; *p; p++, pos++) {
1.1 kristaps 462: if ('\t' == *p) {
463: if ( ! (MDOC_LITERAL & mdoc->flags))
1.79 kristaps 464: if ( ! mdoc_pmsg(mdoc, line, pos, MANDOCERR_BADCHAR))
1.4 kristaps 465: return(0);
1.82 kristaps 466: } else if ( ! isprint((u_char)*p) && ASCII_HYPH != *p)
1.79 kristaps 467: if ( ! mdoc_pmsg(mdoc, line, pos, MANDOCERR_BADCHAR))
1.4 kristaps 468: return(0);
1.1 kristaps 469:
470: if ('\\' != *p)
471: continue;
472:
1.18 kristaps 473: c = mandoc_special(p);
1.1 kristaps 474: if (c) {
1.18 kristaps 475: p += c - 1;
476: pos += c - 1;
1.1 kristaps 477: continue;
478: }
1.79 kristaps 479:
480: c = mdoc_pmsg(mdoc, line, pos, MANDOCERR_BADESCAPE);
481: if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags) && ! c)
482: return(c);
1.1 kristaps 483: }
484:
485: return(1);
486: }
487:
488:
489:
490:
491: static int
1.59 kristaps 492: check_parent(PRE_ARGS, enum mdoct tok, enum mdoc_type t)
1.1 kristaps 493: {
494:
495: assert(n->parent);
496: if ((MDOC_ROOT == t || tok == n->parent->tok) &&
497: (t == n->parent->type))
498: return(1);
499:
1.79 kristaps 500: mdoc_vmsg(mdoc, MANDOCERR_SYNTCHILD,
501: n->line, n->pos, "want parent %s",
502: MDOC_ROOT == t ? "<root>" :
503: mdoc_macronames[tok]);
504: return(0);
1.1 kristaps 505: }
506:
507:
508:
509: static int
510: pre_display(PRE_ARGS)
511: {
512: struct mdoc_node *node;
513:
514: /* Display elements (`Bd', `D1'...) cannot be nested. */
515:
516: if (MDOC_BLOCK != n->type)
517: return(1);
518:
519: /* LINTED */
520: for (node = mdoc->last->parent; node; node = node->parent)
521: if (MDOC_BLOCK == node->type)
522: if (MDOC_Bd == node->tok)
523: break;
524: if (NULL == node)
525: return(1);
526:
1.79 kristaps 527: mdoc_nmsg(mdoc, n, MANDOCERR_NESTEDDISP);
528: return(0);
1.1 kristaps 529: }
530:
531:
532: static int
533: pre_bl(PRE_ARGS)
534: {
1.15 kristaps 535: int pos, type, width, offset;
1.1 kristaps 536:
537: if (MDOC_BLOCK != n->type)
538: return(1);
1.79 kristaps 539: if (NULL == n->args) {
540: mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE);
541: return(0);
542: }
1.1 kristaps 543:
544: /* Make sure that only one type of list is specified. */
545:
1.15 kristaps 546: type = offset = width = -1;
1.1 kristaps 547:
548: /* LINTED */
1.8 kristaps 549: for (pos = 0; pos < (int)n->args->argc; pos++)
550: switch (n->args->argv[pos].arg) {
1.1 kristaps 551: case (MDOC_Bullet):
552: /* FALLTHROUGH */
553: case (MDOC_Dash):
554: /* FALLTHROUGH */
555: case (MDOC_Enum):
556: /* FALLTHROUGH */
557: case (MDOC_Hyphen):
558: /* FALLTHROUGH */
559: case (MDOC_Item):
560: /* FALLTHROUGH */
561: case (MDOC_Tag):
562: /* FALLTHROUGH */
563: case (MDOC_Diag):
564: /* FALLTHROUGH */
565: case (MDOC_Hang):
566: /* FALLTHROUGH */
567: case (MDOC_Ohang):
568: /* FALLTHROUGH */
569: case (MDOC_Inset):
570: /* FALLTHROUGH */
571: case (MDOC_Column):
1.80 kristaps 572: if (type < 0) {
573: type = n->args->argv[pos].arg;
1.61 kristaps 574: break;
575: }
1.80 kristaps 576: if (mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP))
577: break;
578: return(0);
1.45 kristaps 579: case (MDOC_Compact):
1.80 kristaps 580: if (type >= 0)
581: break;
582: if (mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST))
583: break;
584: return(0);
1.1 kristaps 585: case (MDOC_Width):
1.45 kristaps 586: if (width >= 0)
1.79 kristaps 587: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP))
588: return(0);
589: if (type < 0 && ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST))
1.45 kristaps 590: return(0);
1.8 kristaps 591: width = n->args->argv[pos].arg;
592: break;
1.1 kristaps 593: case (MDOC_Offset):
1.45 kristaps 594: if (offset >= 0)
1.79 kristaps 595: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP))
596: return(0);
597: if (type < 0 && ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST))
1.45 kristaps 598: return(0);
1.8 kristaps 599: offset = n->args->argv[pos].arg;
600: break;
1.1 kristaps 601: default:
602: break;
603: }
604:
1.79 kristaps 605: if (type < 0) {
606: mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE);
607: return(0);
608: }
1.1 kristaps 609:
1.8 kristaps 610: /*
611: * Validate the width field. Some list types don't need width
612: * types and should be warned about them. Others should have it
613: * and must also be warned.
614: */
615:
1.1 kristaps 616: switch (type) {
1.8 kristaps 617: case (MDOC_Tag):
1.79 kristaps 618: if (width < 0 && ! mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG))
1.8 kristaps 619: return(0);
620: break;
1.1 kristaps 621: case (MDOC_Column):
622: /* FALLTHROUGH */
623: case (MDOC_Diag):
624: /* FALLTHROUGH */
1.53 kristaps 625: case (MDOC_Ohang):
626: /* FALLTHROUGH */
1.1 kristaps 627: case (MDOC_Inset):
628: /* FALLTHROUGH */
629: case (MDOC_Item):
1.79 kristaps 630: if (width >= 0 && ! mdoc_nmsg(mdoc, n, MANDOCERR_WIDTHARG))
1.8 kristaps 631: return(0);
632: break;
633: default:
634: break;
635: }
636:
1.1 kristaps 637: return(1);
638: }
639:
640:
641: static int
642: pre_bd(PRE_ARGS)
643: {
644: int i, type, err;
645:
646: if (MDOC_BLOCK != n->type)
647: return(1);
1.79 kristaps 648: if (NULL == n->args) {
649: mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE);
650: return(0);
651: }
1.1 kristaps 652:
653: /* Make sure that only one type of display is specified. */
654:
655: /* LINTED */
656: for (i = 0, err = type = 0; ! err &&
657: i < (int)n->args->argc; i++)
658: switch (n->args->argv[i].arg) {
1.49 kristaps 659: case (MDOC_Centred):
660: /* FALLTHROUGH */
1.1 kristaps 661: case (MDOC_Ragged):
662: /* FALLTHROUGH */
663: case (MDOC_Unfilled):
664: /* FALLTHROUGH */
665: case (MDOC_Filled):
666: /* FALLTHROUGH */
667: case (MDOC_Literal):
668: if (0 == type++)
669: break;
1.79 kristaps 670: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP))
671: return(0);
672: break;
1.1 kristaps 673: default:
674: break;
675: }
676:
677: if (type)
678: return(1);
1.79 kristaps 679: mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE);
680: return(0);
1.1 kristaps 681: }
682:
683:
684: static int
685: pre_ss(PRE_ARGS)
686: {
687:
688: if (MDOC_BLOCK != n->type)
689: return(1);
690: return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
691: }
692:
693:
694: static int
695: pre_sh(PRE_ARGS)
696: {
697:
698: if (MDOC_BLOCK != n->type)
699: return(1);
1.70 kristaps 700: return(check_parent(mdoc, n, MDOC_MAX, MDOC_ROOT));
1.1 kristaps 701: }
702:
703:
704: static int
705: pre_it(PRE_ARGS)
706: {
707:
708: if (MDOC_BLOCK != n->type)
709: return(1);
1.79 kristaps 710: /*
711: * FIXME: this can probably be lifted if we make the It into
712: * something else on-the-fly?
713: */
1.1 kristaps 714: return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
715: }
716:
717:
718: static int
719: pre_an(PRE_ARGS)
720: {
721:
722: if (NULL == n->args || 1 == n->args->argc)
723: return(1);
1.79 kristaps 724: mdoc_vmsg(mdoc, MANDOCERR_SYNTARGCOUNT,
725: n->line, n->pos,
726: "line arguments == 1 (have %d)",
727: n->args->argc);
728: return(0);
1.1 kristaps 729: }
730:
731:
732: static int
733: pre_rv(PRE_ARGS)
734: {
735:
736: return(check_stdarg(mdoc, n));
737: }
738:
739:
740: static int
741: pre_dt(PRE_ARGS)
742: {
743:
1.54 kristaps 744: /* FIXME: make sure is capitalised. */
745:
1.1 kristaps 746: if (0 == mdoc->meta.date || mdoc->meta.os)
1.79 kristaps 747: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO))
1.1 kristaps 748: return(0);
749: if (mdoc->meta.title)
1.79 kristaps 750: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP))
1.1 kristaps 751: return(0);
752: return(1);
753: }
754:
755:
756: static int
757: pre_os(PRE_ARGS)
758: {
759:
760: if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
1.79 kristaps 761: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO))
1.1 kristaps 762: return(0);
763: if (mdoc->meta.os)
1.79 kristaps 764: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP))
1.1 kristaps 765: return(0);
766: return(1);
767: }
768:
769:
770: static int
771: pre_dd(PRE_ARGS)
772: {
773:
774: if (mdoc->meta.title || mdoc->meta.os)
1.79 kristaps 775: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO))
1.1 kristaps 776: return(0);
777: if (mdoc->meta.date)
1.79 kristaps 778: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP))
1.1 kristaps 779: return(0);
780: return(1);
781: }
782:
783:
784: static int
785: post_bf(POST_ARGS)
786: {
787: char *p;
788: struct mdoc_node *head;
789:
790: if (MDOC_BLOCK != mdoc->last->type)
791: return(1);
792:
793: head = mdoc->last->head;
794:
1.79 kristaps 795: if (mdoc->last->args && head->child) {
796: /* FIXME: this should provide a default. */
797: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SYNTARGVCOUNT);
798: return(0);
799: } else if (mdoc->last->args)
1.13 kristaps 800: return(1);
1.12 kristaps 801:
1.79 kristaps 802: if (NULL == head->child || MDOC_TEXT != head->child->type) {
803: /* FIXME: this should provide a default. */
804: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SYNTARGVCOUNT);
805: return(0);
806: }
1.1 kristaps 807:
1.13 kristaps 808: p = head->child->string;
1.1 kristaps 809:
1.13 kristaps 810: if (0 == strcmp(p, "Em"))
811: return(1);
812: else if (0 == strcmp(p, "Li"))
813: return(1);
1.37 kristaps 814: else if (0 == strcmp(p, "Sy"))
1.13 kristaps 815: return(1);
1.1 kristaps 816:
1.79 kristaps 817: mdoc_nmsg(mdoc, head, MANDOCERR_FONTTYPE);
818: return(0);
1.1 kristaps 819: }
820:
821:
822: static int
1.31 kristaps 823: post_lb(POST_ARGS)
824: {
825:
826: if (mdoc_a2lib(mdoc->last->child->string))
827: return(1);
1.79 kristaps 828: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADLIB));
1.84 ! kristaps 829: }
! 830:
! 831:
! 832: static int
! 833: post_eoln(POST_ARGS)
! 834: {
! 835:
! 836: if (NULL == mdoc->last->child)
! 837: return(1);
! 838: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST));
1.31 kristaps 839: }
840:
841:
842: static int
1.57 kristaps 843: post_vt(POST_ARGS)
844: {
845: const struct mdoc_node *n;
846:
847: /*
848: * The Vt macro comes in both ELEM and BLOCK form, both of which
849: * have different syntaxes (yet more context-sensitive
850: * behaviour). ELEM types must have a child; BLOCK types,
851: * specifically the BODY, should only have TEXT children.
852: */
853:
854: if (MDOC_ELEM == mdoc->last->type)
855: return(eerr_ge1(mdoc));
856: if (MDOC_BODY != mdoc->last->type)
857: return(1);
858:
859: for (n = mdoc->last->child; n; n = n->next)
860: if (MDOC_TEXT != n->type)
1.79 kristaps 861: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_CHILD))
1.57 kristaps 862: return(0);
863:
864: return(1);
865: }
866:
867:
868: static int
1.1 kristaps 869: post_nm(POST_ARGS)
870: {
871:
872: if (mdoc->last->child)
873: return(1);
874: if (mdoc->meta.name)
875: return(1);
1.79 kristaps 876: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME));
1.1 kristaps 877: }
878:
879:
880: static int
881: post_at(POST_ARGS)
882: {
883:
884: if (NULL == mdoc->last->child)
885: return(1);
1.79 kristaps 886: assert(MDOC_TEXT == mdoc->last->child->type);
1.1 kristaps 887: if (mdoc_a2att(mdoc->last->child->string))
888: return(1);
1.79 kristaps 889: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADATT));
1.1 kristaps 890: }
891:
892:
893: static int
894: post_an(POST_ARGS)
895: {
896:
897: if (mdoc->last->args) {
898: if (NULL == mdoc->last->child)
899: return(1);
1.79 kristaps 900: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGCOUNT));
1.1 kristaps 901: }
902:
903: if (mdoc->last->child)
904: return(1);
1.79 kristaps 905: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS));
1.1 kristaps 906: }
907:
908:
909: static int
910: post_it(POST_ARGS)
911: {
912: int type, i, cols;
913: struct mdoc_node *n, *c;
914:
915: if (MDOC_BLOCK != mdoc->last->type)
916: return(1);
917:
918: n = mdoc->last->parent->parent;
1.79 kristaps 919: if (NULL == n->args) {
920: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE);
921: return(0);
922: }
1.1 kristaps 923:
924: /* Some types require block-head, some not. */
925:
926: /* LINTED */
927: for (cols = type = -1, i = 0; -1 == type &&
928: i < (int)n->args->argc; i++)
929: switch (n->args->argv[i].arg) {
930: case (MDOC_Tag):
931: /* FALLTHROUGH */
932: case (MDOC_Diag):
933: /* FALLTHROUGH */
934: case (MDOC_Hang):
935: /* FALLTHROUGH */
936: case (MDOC_Ohang):
937: /* FALLTHROUGH */
938: case (MDOC_Inset):
939: /* FALLTHROUGH */
940: case (MDOC_Bullet):
941: /* FALLTHROUGH */
942: case (MDOC_Dash):
943: /* FALLTHROUGH */
944: case (MDOC_Enum):
945: /* FALLTHROUGH */
946: case (MDOC_Hyphen):
947: /* FALLTHROUGH */
948: case (MDOC_Item):
949: type = n->args->argv[i].arg;
950: break;
951: case (MDOC_Column):
952: type = n->args->argv[i].arg;
953: cols = (int)n->args->argv[i].sz;
954: break;
955: default:
956: break;
957: }
958:
1.79 kristaps 959: if (-1 == type) {
960: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE);
961: return(0);
962: }
1.1 kristaps 963:
964: switch (type) {
965: case (MDOC_Tag):
966: if (NULL == mdoc->last->head->child)
1.79 kristaps 967: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS))
1.1 kristaps 968: return(0);
969: break;
970: case (MDOC_Hang):
971: /* FALLTHROUGH */
972: case (MDOC_Ohang):
973: /* FALLTHROUGH */
974: case (MDOC_Inset):
975: /* FALLTHROUGH */
976: case (MDOC_Diag):
977: if (NULL == mdoc->last->head->child)
1.79 kristaps 978: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS))
1.1 kristaps 979: return(0);
980: if (NULL == mdoc->last->body->child)
1.79 kristaps 981: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY))
1.1 kristaps 982: return(0);
983: break;
984: case (MDOC_Bullet):
985: /* FALLTHROUGH */
986: case (MDOC_Dash):
987: /* FALLTHROUGH */
988: case (MDOC_Enum):
989: /* FALLTHROUGH */
990: case (MDOC_Hyphen):
991: /* FALLTHROUGH */
992: case (MDOC_Item):
993: if (mdoc->last->head->child)
1.79 kristaps 994: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST))
1.1 kristaps 995: return(0);
996: if (NULL == mdoc->last->body->child)
1.79 kristaps 997: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY))
1.1 kristaps 998: return(0);
999: break;
1000: case (MDOC_Column):
1001: if (NULL == mdoc->last->head->child)
1.79 kristaps 1002: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS))
1.1 kristaps 1003: return(0);
1004: if (mdoc->last->body->child)
1.79 kristaps 1005: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BODYLOST))
1.1 kristaps 1006: return(0);
1007: c = mdoc->last->child;
1008: for (i = 0; c && MDOC_HEAD == c->type; c = c->next)
1009: i++;
1.38 kristaps 1010:
1.73 kristaps 1011: if (i < cols) {
1.79 kristaps 1012: if ( ! mdoc_vmsg(mdoc, MANDOCERR_ARGCOUNT,
1013: mdoc->last->line,
1014: mdoc->last->pos,
1015: "columns == %d (have %d)",
1016: cols, i))
1.38 kristaps 1017: return(0);
1.1 kristaps 1018: break;
1.73 kristaps 1019: } else if (i == cols || i == cols + 1)
1.38 kristaps 1020: break;
1021:
1.79 kristaps 1022: mdoc_vmsg(mdoc, MANDOCERR_SYNTARGCOUNT,
1023: mdoc->last->line, mdoc->last->pos,
1024: "columns == %d (have %d)", cols, i);
1025: return(0);
1.1 kristaps 1026: default:
1027: break;
1028: }
1029:
1030: return(1);
1031: }
1032:
1033:
1034: static int
1.14 kristaps 1035: post_bl_head(POST_ARGS)
1036: {
1037: int i;
1038: const struct mdoc_node *n;
1.65 kristaps 1039: const struct mdoc_argv *a;
1.14 kristaps 1040:
1041: n = mdoc->last->parent;
1042: assert(n->args);
1043:
1.65 kristaps 1044: for (i = 0; i < (int)n->args->argc; i++) {
1045: a = &n->args->argv[i];
1046: if (a->arg == MDOC_Column) {
1047: if (a->sz && mdoc->last->nchild)
1.79 kristaps 1048: return(mdoc_nmsg(mdoc, n, MANDOCERR_COLUMNS));
1.65 kristaps 1049: return(1);
1050: }
1051: }
1.14 kristaps 1052:
1.65 kristaps 1053: if (0 == (i = mdoc->last->nchild))
1054: return(1);
1055: return(warn_count(mdoc, "==", 0, "line arguments", i));
1.14 kristaps 1056: }
1057:
1058:
1059: static int
1.1 kristaps 1060: post_bl(POST_ARGS)
1061: {
1062: struct mdoc_node *n;
1063:
1.14 kristaps 1064: if (MDOC_HEAD == mdoc->last->type)
1065: return(post_bl_head(mdoc));
1.1 kristaps 1066: if (MDOC_BODY != mdoc->last->type)
1067: return(1);
1068: if (NULL == mdoc->last->child)
1069: return(1);
1070:
1.55 kristaps 1071: /*
1072: * We only allow certain children of `Bl'. This is usually on
1073: * `It', but apparently `Sm' occurs here and there, so we let
1074: * that one through, too.
1075: */
1076:
1.1 kristaps 1077: /* LINTED */
1078: for (n = mdoc->last->child; n; n = n->next) {
1.55 kristaps 1079: if (MDOC_BLOCK == n->type && MDOC_It == n->tok)
1080: continue;
1081: if (MDOC_Sm == n->tok)
1082: continue;
1.79 kristaps 1083: mdoc_nmsg(mdoc, n, MANDOCERR_SYNTCHILD);
1084: return(0);
1.1 kristaps 1085: }
1086:
1087: return(1);
1088: }
1089:
1090:
1091: static int
1092: ebool(struct mdoc *mdoc)
1093: {
1094: struct mdoc_node *n;
1095:
1096: /* LINTED */
1097: for (n = mdoc->last->child; n; n = n->next) {
1098: if (MDOC_TEXT != n->type)
1099: break;
1.2 kristaps 1100: if (0 == strcmp(n->string, "on"))
1.1 kristaps 1101: continue;
1.2 kristaps 1102: if (0 == strcmp(n->string, "off"))
1.1 kristaps 1103: continue;
1104: break;
1105: }
1106:
1107: if (NULL == n)
1108: return(1);
1.79 kristaps 1109: return(mdoc_nmsg(mdoc, n, MANDOCERR_BADBOOL));
1.1 kristaps 1110: }
1111:
1112:
1113: static int
1114: post_root(POST_ARGS)
1115: {
1116:
1117: if (NULL == mdoc->first->child)
1.79 kristaps 1118: mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY);
1119: else if ( ! (MDOC_PBODY & mdoc->flags))
1120: mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCPROLOG);
1121: else if (MDOC_BLOCK != mdoc->first->child->type)
1122: mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY);
1123: else if (MDOC_Sh != mdoc->first->child->tok)
1124: mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY);
1125: else
1126: return(1);
1.1 kristaps 1127:
1.79 kristaps 1128: return(0);
1.1 kristaps 1129: }
1130:
1131:
1132: static int
1133: post_st(POST_ARGS)
1134: {
1135:
1136: if (mdoc_a2st(mdoc->last->child->string))
1137: return(1);
1.79 kristaps 1138: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADSTANDARD));
1.1 kristaps 1139: }
1140:
1141:
1142: static int
1.43 kristaps 1143: post_rs(POST_ARGS)
1144: {
1145: struct mdoc_node *nn;
1146:
1147: if (MDOC_BODY != mdoc->last->type)
1148: return(1);
1149:
1150: for (nn = mdoc->last->child; nn; nn = nn->next)
1151: switch (nn->tok) {
1.50 kristaps 1152: case(MDOC__U):
1153: /* FALLTHROUGH */
1.43 kristaps 1154: case(MDOC__Q):
1155: /* FALLTHROUGH */
1156: case(MDOC__C):
1157: /* FALLTHROUGH */
1158: case(MDOC__A):
1159: /* FALLTHROUGH */
1160: case(MDOC__B):
1161: /* FALLTHROUGH */
1162: case(MDOC__D):
1163: /* FALLTHROUGH */
1164: case(MDOC__I):
1165: /* FALLTHROUGH */
1166: case(MDOC__J):
1167: /* FALLTHROUGH */
1168: case(MDOC__N):
1169: /* FALLTHROUGH */
1170: case(MDOC__O):
1171: /* FALLTHROUGH */
1172: case(MDOC__P):
1173: /* FALLTHROUGH */
1174: case(MDOC__R):
1175: /* FALLTHROUGH */
1176: case(MDOC__T):
1177: /* FALLTHROUGH */
1178: case(MDOC__V):
1179: break;
1180: default:
1.79 kristaps 1181: mdoc_nmsg(mdoc, nn, MANDOCERR_SYNTCHILD);
1182: return(0);
1.43 kristaps 1183: }
1184:
1185: return(1);
1186: }
1187:
1188:
1189: static int
1.1 kristaps 1190: post_sh(POST_ARGS)
1191: {
1192:
1193: if (MDOC_HEAD == mdoc->last->type)
1194: return(post_sh_head(mdoc));
1195: if (MDOC_BODY == mdoc->last->type)
1196: return(post_sh_body(mdoc));
1197:
1198: return(1);
1199: }
1200:
1201:
1202: static int
1203: post_sh_body(POST_ARGS)
1204: {
1205: struct mdoc_node *n;
1206:
1.29 kristaps 1207: if (SEC_NAME != mdoc->lastsec)
1.1 kristaps 1208: return(1);
1209:
1210: /*
1211: * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1212: * macros (can have multiple `Nm' and one `Nd'). Note that the
1213: * children of the BODY declaration can also be "text".
1214: */
1215:
1216: if (NULL == (n = mdoc->last->child))
1.79 kristaps 1217: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC));
1.1 kristaps 1218:
1219: for ( ; n && n->next; n = n->next) {
1220: if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1221: continue;
1.28 kristaps 1222: if (MDOC_TEXT == n->type)
1223: continue;
1.79 kristaps 1224: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC))
1.1 kristaps 1225: return(0);
1226: }
1227:
1.41 kristaps 1228: assert(n);
1.27 kristaps 1229: if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
1.1 kristaps 1230: return(1);
1.79 kristaps 1231: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC));
1.1 kristaps 1232: }
1233:
1234:
1235: static int
1236: post_sh_head(POST_ARGS)
1237: {
1.81 kristaps 1238: char buf[BUFSIZ];
1.2 kristaps 1239: enum mdoc_sec sec;
1240: const struct mdoc_node *n;
1.1 kristaps 1241:
1242: /*
1243: * Process a new section. Sections are either "named" or
1244: * "custom"; custom sections are user-defined, while named ones
1245: * usually follow a conventional order and may only appear in
1246: * certain manual sections.
1247: */
1248:
1.79 kristaps 1249: buf[0] = '\0';
1250:
1251: /*
1252: * FIXME: yes, these can use a dynamic buffer, but I don't do so
1253: * in the interests of simplicity.
1254: */
1.1 kristaps 1255:
1.2 kristaps 1256: for (n = mdoc->last->child; n; n = n->next) {
1.12 kristaps 1257: /* XXX - copied from compact(). */
1.2 kristaps 1258: assert(MDOC_TEXT == n->type);
1.12 kristaps 1259:
1.81 kristaps 1260: if (strlcat(buf, n->string, BUFSIZ) >= BUFSIZ) {
1.79 kristaps 1261: mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
1262: return(0);
1263: }
1.2 kristaps 1264: if (NULL == n->next)
1265: continue;
1.81 kristaps 1266: if (strlcat(buf, " ", BUFSIZ) >= BUFSIZ) {
1.79 kristaps 1267: mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
1268: return(0);
1269: }
1.2 kristaps 1270: }
1.1 kristaps 1271:
1.72 kristaps 1272: sec = mdoc_str2sec(buf);
1.1 kristaps 1273:
1.12 kristaps 1274: /*
1275: * Check: NAME should always be first, CUSTOM has no roles,
1276: * non-CUSTOM has a conventional order to be followed.
1277: */
1.1 kristaps 1278:
1.72 kristaps 1279: if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
1.79 kristaps 1280: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NAMESECFIRST))
1.72 kristaps 1281: return(0);
1282:
1.1 kristaps 1283: if (SEC_CUSTOM == sec)
1284: return(1);
1.72 kristaps 1285:
1.1 kristaps 1286: if (sec == mdoc->lastnamed)
1.79 kristaps 1287: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECREP))
1.26 kristaps 1288: return(0);
1.72 kristaps 1289:
1.1 kristaps 1290: if (sec < mdoc->lastnamed)
1.79 kristaps 1291: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECOOO))
1.26 kristaps 1292: return(0);
1.1 kristaps 1293:
1.12 kristaps 1294: /*
1295: * Check particular section/manual conventions. LIBRARY can
1.78 kristaps 1296: * only occur in manual section 2, 3, and 9.
1.12 kristaps 1297: */
1.1 kristaps 1298:
1299: switch (sec) {
1300: case (SEC_LIBRARY):
1.78 kristaps 1301: assert(mdoc->meta.msec);
1302: if (*mdoc->meta.msec == '2')
1303: break;
1304: if (*mdoc->meta.msec == '3')
1305: break;
1306: if (*mdoc->meta.msec == '9')
1.1 kristaps 1307: break;
1.79 kristaps 1308: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECMSEC));
1.1 kristaps 1309: default:
1310: break;
1311: }
1312:
1313: return(1);
1314: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mdoc_validate.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc