Annotation of mandoc/mdoc_validate.c, Revision 1.92
1.92 ! kristaps 1: /* $Id: mdoc_validate.c,v 1.91 2010/06/03 13:44:36 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.91 kristaps 37: #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n
1.32 kristaps 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);
1.92 ! kristaps 50: static int check_text(struct mdoc *, int, int, char *);
1.32 kristaps 51: static int check_argv(struct mdoc *,
1.92 ! kristaps 52: struct mdoc_node *, struct mdoc_argv *);
! 53: static int check_args(struct mdoc *, struct mdoc_node *);
1.32 kristaps 54: static int err_child_lt(struct mdoc *, const char *, int);
55: static int warn_child_lt(struct mdoc *, const char *, int);
56: static int err_child_gt(struct mdoc *, const char *, int);
57: static int warn_child_gt(struct mdoc *, const char *, int);
58: static int err_child_eq(struct mdoc *, const char *, int);
59: static int warn_child_eq(struct mdoc *, const char *, int);
60: static int warn_count(struct mdoc *, const char *,
1.1 kristaps 61: int, const char *, int);
1.32 kristaps 62: static int err_count(struct mdoc *, const char *,
1.1 kristaps 63: int, const char *, int);
1.32 kristaps 64:
65: static int berr_ge1(POST_ARGS);
66: static int bwarn_ge1(POST_ARGS);
67: static int ebool(POST_ARGS);
68: static int eerr_eq0(POST_ARGS);
69: static int eerr_eq1(POST_ARGS);
70: static int eerr_ge1(POST_ARGS);
1.46 kristaps 71: static int eerr_le1(POST_ARGS);
1.32 kristaps 72: static int ewarn_ge1(POST_ARGS);
73: static int herr_eq0(POST_ARGS);
74: static int herr_ge1(POST_ARGS);
75: static int hwarn_eq1(POST_ARGS);
1.66 kristaps 76: static int hwarn_eq0(POST_ARGS);
1.32 kristaps 77: static int hwarn_le1(POST_ARGS);
78:
79: static int post_an(POST_ARGS);
80: static int post_at(POST_ARGS);
81: static int post_bf(POST_ARGS);
82: static int post_bl(POST_ARGS);
83: static int post_bl_head(POST_ARGS);
1.85 kristaps 84: static int post_dt(POST_ARGS);
1.32 kristaps 85: static int post_it(POST_ARGS);
86: static int post_lb(POST_ARGS);
87: static int post_nm(POST_ARGS);
88: static int post_root(POST_ARGS);
1.43 kristaps 89: static int post_rs(POST_ARGS);
1.32 kristaps 90: static int post_sh(POST_ARGS);
91: static int post_sh_body(POST_ARGS);
92: static int post_sh_head(POST_ARGS);
93: static int post_st(POST_ARGS);
1.84 kristaps 94: static int post_eoln(POST_ARGS);
1.57 kristaps 95: static int post_vt(POST_ARGS);
1.32 kristaps 96: static int pre_an(PRE_ARGS);
97: static int pre_bd(PRE_ARGS);
98: static int pre_bl(PRE_ARGS);
99: static int pre_dd(PRE_ARGS);
100: static int pre_display(PRE_ARGS);
101: static int pre_dt(PRE_ARGS);
102: static int pre_it(PRE_ARGS);
103: static int pre_os(PRE_ARGS);
104: static int pre_rv(PRE_ARGS);
105: static int pre_sh(PRE_ARGS);
106: static int pre_ss(PRE_ARGS);
107:
108: static v_post posts_an[] = { post_an, NULL };
109: static v_post posts_at[] = { post_at, NULL };
1.66 kristaps 110: static v_post posts_bd[] = { hwarn_eq0, bwarn_ge1, NULL };
1.32 kristaps 111: static v_post posts_bf[] = { hwarn_le1, post_bf, NULL };
112: static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL };
113: static v_post posts_bool[] = { eerr_eq1, ebool, NULL };
1.84 kristaps 114: static v_post posts_eoln[] = { post_eoln, NULL };
1.85 kristaps 115: static v_post posts_dt[] = { post_dt, 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 */
1.85 kristaps 150: { pres_dt, posts_dt }, /* Dt */
1.1 kristaps 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.88 kristaps 269: { NULL, NULL }, /* Ta */
1.1 kristaps 270: };
271:
272:
273: int
1.91 kristaps 274: mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n)
1.1 kristaps 275: {
276: v_pre *p;
277: int line, pos;
1.92 ! kristaps 278: char *tp;
1.1 kristaps 279:
280: if (MDOC_TEXT == n->type) {
281: tp = n->string;
282: line = n->line;
283: pos = n->pos;
284: return(check_text(mdoc, line, pos, tp));
285: }
286:
287: if ( ! check_args(mdoc, n))
288: return(0);
289: if (NULL == mdoc_valids[n->tok].pre)
290: return(1);
291: for (p = mdoc_valids[n->tok].pre; *p; p++)
292: if ( ! (*p)(mdoc, n))
293: return(0);
294: return(1);
295: }
296:
297:
298: int
299: mdoc_valid_post(struct mdoc *mdoc)
300: {
301: v_post *p;
302:
303: if (MDOC_VALID & mdoc->last->flags)
304: return(1);
305: mdoc->last->flags |= MDOC_VALID;
306:
307: if (MDOC_TEXT == mdoc->last->type)
308: return(1);
309: if (MDOC_ROOT == mdoc->last->type)
310: return(post_root(mdoc));
311:
312: if (NULL == mdoc_valids[mdoc->last->tok].post)
313: return(1);
314: for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
315: if ( ! (*p)(mdoc))
316: return(0);
317:
318: return(1);
319: }
320:
321:
322: static inline int
323: warn_count(struct mdoc *m, const char *k,
324: int want, const char *v, int has)
325: {
326:
1.79 kristaps 327: return(mdoc_vmsg(m, MANDOCERR_ARGCOUNT,
328: m->last->line, m->last->pos,
329: "%s %s %d (have %d)", v, k, want, has));
1.1 kristaps 330: }
331:
332:
333: static inline int
334: err_count(struct mdoc *m, const char *k,
335: int want, const char *v, int has)
336: {
337:
1.79 kristaps 338: mdoc_vmsg(m, MANDOCERR_SYNTARGCOUNT,
339: m->last->line, m->last->pos,
340: "%s %s %d (have %d)",
341: v, k, want, has);
342: return(0);
1.1 kristaps 343: }
344:
345:
346: /*
347: * Build these up with macros because they're basically the same check
348: * for different inequalities. Yes, this could be done with functions,
349: * but this is reasonable for now.
350: */
351:
352: #define CHECK_CHILD_DEFN(lvl, name, ineq) \
353: static int \
354: lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \
355: { \
1.16 kristaps 356: if (mdoc->last->nchild ineq sz) \
1.1 kristaps 357: return(1); \
1.16 kristaps 358: return(lvl##_count(mdoc, #ineq, sz, p, mdoc->last->nchild)); \
1.1 kristaps 359: }
360:
361: #define CHECK_BODY_DEFN(name, lvl, func, num) \
362: static int \
363: b##lvl##_##name(POST_ARGS) \
364: { \
365: if (MDOC_BODY != mdoc->last->type) \
366: return(1); \
367: return(func(mdoc, "multi-line arguments", (num))); \
368: }
369:
370: #define CHECK_ELEM_DEFN(name, lvl, func, num) \
371: static int \
372: e##lvl##_##name(POST_ARGS) \
373: { \
374: assert(MDOC_ELEM == mdoc->last->type); \
375: return(func(mdoc, "line arguments", (num))); \
376: }
377:
378: #define CHECK_HEAD_DEFN(name, lvl, func, num) \
379: static int \
380: h##lvl##_##name(POST_ARGS) \
381: { \
382: if (MDOC_HEAD != mdoc->last->type) \
383: return(1); \
384: return(func(mdoc, "line arguments", (num))); \
385: }
386:
387:
388: CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */
389: CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */
390: CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */
391: CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */
392: CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */
393: CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */
394: CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */
1.27 kristaps 395: CHECK_BODY_DEFN(ge1, err, err_child_gt, 0) /* berr_ge1() */
1.84 kristaps 396: CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_ge1() */
1.1 kristaps 397: CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */
1.46 kristaps 398: CHECK_ELEM_DEFN(le1, err, err_child_lt, 2) /* eerr_le1() */
1.1 kristaps 399: CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */
400: CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */
401: CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */
402: CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2) /* hwarn_le1() */
403: CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */
404: CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1) /* hwarn_eq1() */
1.66 kristaps 405: CHECK_HEAD_DEFN(eq0, warn, warn_child_eq, 0) /* hwarn_eq0() */
1.1 kristaps 406:
407:
408: static int
409: check_stdarg(PRE_ARGS)
410: {
411:
412: if (n->args && 1 == n->args->argc)
413: if (MDOC_Std == n->args->argv[0].arg)
414: return(1);
1.79 kristaps 415: return(mdoc_nmsg(mdoc, n, MANDOCERR_NOARGV));
1.1 kristaps 416: }
417:
418:
419: static int
1.92 ! kristaps 420: check_args(struct mdoc *m, struct mdoc_node *n)
1.1 kristaps 421: {
422: int i;
423:
424: if (NULL == n->args)
425: return(1);
426:
427: assert(n->args->argc);
428: for (i = 0; i < (int)n->args->argc; i++)
429: if ( ! check_argv(m, n, &n->args->argv[i]))
430: return(0);
431:
432: return(1);
433: }
434:
435:
436: static int
1.92 ! kristaps 437: check_argv(struct mdoc *m, struct mdoc_node *n, struct mdoc_argv *v)
1.1 kristaps 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
1.92 ! kristaps 457: check_text(struct mdoc *mdoc, int line, int pos, char *p)
1.1 kristaps 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.91 kristaps 535: int i, width, offs, cmpt, dupl;
536: enum mdoc_list lt;
1.1 kristaps 537:
1.91 kristaps 538: if (MDOC_BLOCK != n->type) {
539: assert(n->parent);
540: assert(MDOC_BLOCK == n->parent->type);
541: assert(MDOC_Bl == n->parent->tok);
542: assert(LIST__NONE != n->parent->data.list);
543: n->data.list = n->parent->data.list;
1.1 kristaps 544: return(1);
1.79 kristaps 545: }
1.1 kristaps 546:
1.91 kristaps 547: /*
548: * First figure out which kind of list to use: bind ourselves to
549: * the first mentioned list type and warn about any remaining
550: * ones. If we find no list type, we default to LIST_item.
551: */
1.1 kristaps 552:
1.91 kristaps 553: assert(LIST__NONE == n->data.list);
554: offs = width = cmpt = -1;
1.1 kristaps 555:
556: /* LINTED */
1.91 kristaps 557: for (i = 0; n->args && i < (int)n->args->argc; i++) {
558: lt = LIST__NONE;
559: dupl = 0;
560: switch (n->args->argv[i].arg) {
561: /* Set list types. */
1.1 kristaps 562: case (MDOC_Bullet):
1.91 kristaps 563: lt = LIST_bullet;
564: break;
1.1 kristaps 565: case (MDOC_Dash):
1.91 kristaps 566: lt = LIST_dash;
567: break;
1.1 kristaps 568: case (MDOC_Enum):
1.91 kristaps 569: lt = LIST_enum;
570: break;
1.1 kristaps 571: case (MDOC_Hyphen):
1.91 kristaps 572: lt = LIST_hyphen;
573: break;
1.1 kristaps 574: case (MDOC_Item):
1.91 kristaps 575: lt = LIST_item;
576: break;
1.1 kristaps 577: case (MDOC_Tag):
1.91 kristaps 578: lt = LIST_tag;
579: break;
1.1 kristaps 580: case (MDOC_Diag):
1.91 kristaps 581: lt = LIST_diag;
582: break;
1.1 kristaps 583: case (MDOC_Hang):
1.91 kristaps 584: lt = LIST_hang;
585: break;
1.1 kristaps 586: case (MDOC_Ohang):
1.91 kristaps 587: lt = LIST_ohang;
588: break;
1.1 kristaps 589: case (MDOC_Inset):
1.91 kristaps 590: lt = LIST_inset;
591: break;
1.1 kristaps 592: case (MDOC_Column):
1.91 kristaps 593: lt = LIST_column;
594: break;
595: /* Set list arguments. */
1.45 kristaps 596: case (MDOC_Compact):
1.91 kristaps 597: if (cmpt >= 0)
598: dupl++;
599: cmpt = i;
600: break;
1.1 kristaps 601: case (MDOC_Width):
1.45 kristaps 602: if (width >= 0)
1.91 kristaps 603: dupl++;
604: width = i;
1.8 kristaps 605: break;
1.1 kristaps 606: case (MDOC_Offset):
1.91 kristaps 607: if (offs >= 0)
608: dupl++;
609: offs = i;
1.1 kristaps 610: break;
611: }
612:
1.91 kristaps 613: /* Check: duplicate auxiliary arguments. */
614:
615: if (dupl)
616: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP))
617: return(0);
618:
619: /* Check: multiple list types. */
620:
621: if (LIST__NONE != lt && n->data.list != LIST__NONE)
622: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP))
623: return(0);
624:
625: /* Assign list type. */
626:
627: if (LIST__NONE != lt && n->data.list == LIST__NONE)
628: n->data.list = lt;
629:
630: /* The list type should come first. */
631:
632: if (n->data.list == LIST__NONE)
633: if (width >= 0 || offs >= 0 || cmpt >= 0)
634: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST))
635: return(0);
636:
637: continue;
638: }
639:
640: /* Allow lists to default to LIST_item. */
641:
642: if (LIST__NONE == n->data.list) {
643: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE))
644: return(0);
645: n->data.list = LIST_item;
1.79 kristaps 646: }
1.1 kristaps 647:
1.8 kristaps 648: /*
649: * Validate the width field. Some list types don't need width
650: * types and should be warned about them. Others should have it
651: * and must also be warned.
652: */
653:
1.91 kristaps 654: switch (n->data.list) {
655: case (LIST_tag):
656: if (width >= 0)
657: break;
658: if (mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG))
659: break;
660: return(0);
661: case (LIST_column):
1.1 kristaps 662: /* FALLTHROUGH */
1.91 kristaps 663: case (LIST_diag):
1.1 kristaps 664: /* FALLTHROUGH */
1.91 kristaps 665: case (LIST_ohang):
1.53 kristaps 666: /* FALLTHROUGH */
1.91 kristaps 667: case (LIST_inset):
1.1 kristaps 668: /* FALLTHROUGH */
1.91 kristaps 669: case (LIST_item):
670: if (width < 0)
671: break;
672: if (mdoc_nmsg(mdoc, n, MANDOCERR_WIDTHARG))
673: break;
674: return(0);
1.8 kristaps 675: default:
676: break;
677: }
678:
1.1 kristaps 679: return(1);
680: }
681:
682:
683: static int
684: pre_bd(PRE_ARGS)
685: {
686: int i, type, err;
687:
688: if (MDOC_BLOCK != n->type)
689: return(1);
1.79 kristaps 690: if (NULL == n->args) {
691: mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE);
692: return(0);
693: }
1.1 kristaps 694:
695: /* Make sure that only one type of display is specified. */
696:
697: /* LINTED */
698: for (i = 0, err = type = 0; ! err &&
699: i < (int)n->args->argc; i++)
700: switch (n->args->argv[i].arg) {
1.49 kristaps 701: case (MDOC_Centred):
702: /* FALLTHROUGH */
1.1 kristaps 703: case (MDOC_Ragged):
704: /* FALLTHROUGH */
705: case (MDOC_Unfilled):
706: /* FALLTHROUGH */
707: case (MDOC_Filled):
708: /* FALLTHROUGH */
709: case (MDOC_Literal):
710: if (0 == type++)
711: break;
1.79 kristaps 712: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP))
713: return(0);
714: break;
1.1 kristaps 715: default:
716: break;
717: }
718:
719: if (type)
720: return(1);
1.79 kristaps 721: mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE);
722: return(0);
1.1 kristaps 723: }
724:
725:
726: static int
727: pre_ss(PRE_ARGS)
728: {
729:
730: if (MDOC_BLOCK != n->type)
731: return(1);
732: return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
733: }
734:
735:
736: static int
737: pre_sh(PRE_ARGS)
738: {
739:
740: if (MDOC_BLOCK != n->type)
741: return(1);
1.70 kristaps 742: return(check_parent(mdoc, n, MDOC_MAX, MDOC_ROOT));
1.1 kristaps 743: }
744:
745:
746: static int
747: pre_it(PRE_ARGS)
748: {
749:
750: if (MDOC_BLOCK != n->type)
751: return(1);
1.79 kristaps 752: /*
753: * FIXME: this can probably be lifted if we make the It into
754: * something else on-the-fly?
755: */
1.1 kristaps 756: return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
757: }
758:
759:
760: static int
761: pre_an(PRE_ARGS)
762: {
763:
764: if (NULL == n->args || 1 == n->args->argc)
765: return(1);
1.79 kristaps 766: mdoc_vmsg(mdoc, MANDOCERR_SYNTARGCOUNT,
767: n->line, n->pos,
768: "line arguments == 1 (have %d)",
769: n->args->argc);
770: return(0);
1.1 kristaps 771: }
772:
773:
774: static int
775: pre_rv(PRE_ARGS)
776: {
777:
778: return(check_stdarg(mdoc, n));
779: }
780:
781:
782: static int
1.85 kristaps 783: post_dt(POST_ARGS)
784: {
785: const struct mdoc_node *nn;
786: const char *p;
787:
788: if (NULL != (nn = mdoc->last->child))
789: for (p = nn->string; *p; p++) {
1.86 kristaps 790: if (toupper((u_char)*p) == *p)
1.85 kristaps 791: continue;
792: if ( ! mdoc_nmsg(mdoc, nn, MANDOCERR_UPPERCASE))
793: return(0);
794: break;
795: }
796:
797: return(1);
798: }
799:
800:
801: static int
1.1 kristaps 802: pre_dt(PRE_ARGS)
803: {
1.54 kristaps 804:
1.1 kristaps 805: if (0 == mdoc->meta.date || mdoc->meta.os)
1.79 kristaps 806: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO))
1.1 kristaps 807: return(0);
808: if (mdoc->meta.title)
1.79 kristaps 809: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP))
1.1 kristaps 810: return(0);
811: return(1);
812: }
813:
814:
815: static int
816: pre_os(PRE_ARGS)
817: {
818:
819: if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
1.79 kristaps 820: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO))
1.1 kristaps 821: return(0);
822: if (mdoc->meta.os)
1.79 kristaps 823: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP))
1.1 kristaps 824: return(0);
825: return(1);
826: }
827:
828:
829: static int
830: pre_dd(PRE_ARGS)
831: {
832:
833: if (mdoc->meta.title || mdoc->meta.os)
1.79 kristaps 834: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO))
1.1 kristaps 835: return(0);
836: if (mdoc->meta.date)
1.79 kristaps 837: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP))
1.1 kristaps 838: return(0);
839: return(1);
840: }
841:
842:
843: static int
844: post_bf(POST_ARGS)
845: {
846: char *p;
847: struct mdoc_node *head;
848:
849: if (MDOC_BLOCK != mdoc->last->type)
850: return(1);
851:
852: head = mdoc->last->head;
853:
1.79 kristaps 854: if (mdoc->last->args && head->child) {
855: /* FIXME: this should provide a default. */
856: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SYNTARGVCOUNT);
857: return(0);
858: } else if (mdoc->last->args)
1.13 kristaps 859: return(1);
1.12 kristaps 860:
1.79 kristaps 861: if (NULL == head->child || MDOC_TEXT != head->child->type) {
862: /* FIXME: this should provide a default. */
863: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SYNTARGVCOUNT);
864: return(0);
865: }
1.1 kristaps 866:
1.13 kristaps 867: p = head->child->string;
1.1 kristaps 868:
1.13 kristaps 869: if (0 == strcmp(p, "Em"))
870: return(1);
871: else if (0 == strcmp(p, "Li"))
872: return(1);
1.37 kristaps 873: else if (0 == strcmp(p, "Sy"))
1.13 kristaps 874: return(1);
1.1 kristaps 875:
1.79 kristaps 876: mdoc_nmsg(mdoc, head, MANDOCERR_FONTTYPE);
877: return(0);
1.1 kristaps 878: }
879:
880:
881: static int
1.31 kristaps 882: post_lb(POST_ARGS)
883: {
884:
885: if (mdoc_a2lib(mdoc->last->child->string))
886: return(1);
1.79 kristaps 887: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADLIB));
1.84 kristaps 888: }
889:
890:
891: static int
892: post_eoln(POST_ARGS)
893: {
894:
895: if (NULL == mdoc->last->child)
896: return(1);
897: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST));
1.31 kristaps 898: }
899:
900:
901: static int
1.57 kristaps 902: post_vt(POST_ARGS)
903: {
904: const struct mdoc_node *n;
905:
906: /*
907: * The Vt macro comes in both ELEM and BLOCK form, both of which
908: * have different syntaxes (yet more context-sensitive
909: * behaviour). ELEM types must have a child; BLOCK types,
910: * specifically the BODY, should only have TEXT children.
911: */
912:
913: if (MDOC_ELEM == mdoc->last->type)
914: return(eerr_ge1(mdoc));
915: if (MDOC_BODY != mdoc->last->type)
916: return(1);
917:
918: for (n = mdoc->last->child; n; n = n->next)
919: if (MDOC_TEXT != n->type)
1.79 kristaps 920: if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_CHILD))
1.57 kristaps 921: return(0);
922:
923: return(1);
924: }
925:
926:
927: static int
1.1 kristaps 928: post_nm(POST_ARGS)
929: {
930:
931: if (mdoc->last->child)
932: return(1);
933: if (mdoc->meta.name)
934: return(1);
1.79 kristaps 935: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME));
1.1 kristaps 936: }
937:
938:
939: static int
940: post_at(POST_ARGS)
941: {
942:
943: if (NULL == mdoc->last->child)
944: return(1);
1.79 kristaps 945: assert(MDOC_TEXT == mdoc->last->child->type);
1.1 kristaps 946: if (mdoc_a2att(mdoc->last->child->string))
947: return(1);
1.79 kristaps 948: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADATT));
1.1 kristaps 949: }
950:
951:
952: static int
953: post_an(POST_ARGS)
954: {
955:
956: if (mdoc->last->args) {
957: if (NULL == mdoc->last->child)
958: return(1);
1.79 kristaps 959: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGCOUNT));
1.1 kristaps 960: }
961:
962: if (mdoc->last->child)
963: return(1);
1.79 kristaps 964: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS));
1.1 kristaps 965: }
966:
967:
968: static int
969: post_it(POST_ARGS)
970: {
1.89 kristaps 971: int i, cols, rc;
972: enum mdoc_list lt;
1.1 kristaps 973: struct mdoc_node *n, *c;
1.89 kristaps 974: enum mandocerr er;
1.1 kristaps 975:
976: if (MDOC_BLOCK != mdoc->last->type)
977: return(1);
978:
979: n = mdoc->last->parent->parent;
1.89 kristaps 980: lt = n->data.list;
981:
982: if (LIST__NONE == lt) {
1.79 kristaps 983: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE);
984: return(0);
985: }
1.1 kristaps 986:
1.89 kristaps 987: switch (lt) {
988: case (LIST_tag):
989: if (mdoc->last->head->child)
1.1 kristaps 990: break;
1.89 kristaps 991: /* FIXME: give this a dummy value. */
992: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS))
993: return(0);
1.1 kristaps 994: break;
1.89 kristaps 995: case (LIST_hang):
1.1 kristaps 996: /* FALLTHROUGH */
1.89 kristaps 997: case (LIST_ohang):
1.1 kristaps 998: /* FALLTHROUGH */
1.89 kristaps 999: case (LIST_inset):
1.1 kristaps 1000: /* FALLTHROUGH */
1.89 kristaps 1001: case (LIST_diag):
1.1 kristaps 1002: if (NULL == mdoc->last->head->child)
1.79 kristaps 1003: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS))
1.1 kristaps 1004: return(0);
1005: if (NULL == mdoc->last->body->child)
1.79 kristaps 1006: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY))
1.1 kristaps 1007: return(0);
1008: break;
1.89 kristaps 1009: case (LIST_bullet):
1.1 kristaps 1010: /* FALLTHROUGH */
1.89 kristaps 1011: case (LIST_dash):
1.1 kristaps 1012: /* FALLTHROUGH */
1.89 kristaps 1013: case (LIST_enum):
1.1 kristaps 1014: /* FALLTHROUGH */
1.89 kristaps 1015: case (LIST_hyphen):
1.1 kristaps 1016: /* FALLTHROUGH */
1.89 kristaps 1017: case (LIST_item):
1.1 kristaps 1018: if (mdoc->last->head->child)
1.79 kristaps 1019: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST))
1.1 kristaps 1020: return(0);
1021: if (NULL == mdoc->last->body->child)
1.79 kristaps 1022: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY))
1.1 kristaps 1023: return(0);
1024: break;
1.89 kristaps 1025: case (LIST_column):
1026: cols = -1;
1027: for (i = 0; i < (int)n->args->argc; i++)
1028: if (MDOC_Column == n->args->argv[i].arg) {
1029: cols = (int)n->args->argv[i].sz;
1030: break;
1031: }
1032:
1033: assert(-1 != cols);
1.87 kristaps 1034: assert(NULL == mdoc->last->head->child);
1.89 kristaps 1035:
1.87 kristaps 1036: if (NULL == mdoc->last->body->child)
1037: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY))
1.1 kristaps 1038: return(0);
1.87 kristaps 1039:
1.89 kristaps 1040: for (i = 0, c = mdoc->last->child; c; c = c->next)
1.87 kristaps 1041: if (MDOC_BODY == c->type)
1042: i++;
1.38 kristaps 1043:
1.89 kristaps 1044: if (i < cols)
1045: er = MANDOCERR_ARGCOUNT;
1046: else if (i == cols || i == cols + 1)
1.38 kristaps 1047: break;
1.89 kristaps 1048: else
1049: er = MANDOCERR_SYNTARGCOUNT;
1.38 kristaps 1050:
1.89 kristaps 1051: rc = mdoc_vmsg(mdoc, er,
1.79 kristaps 1052: mdoc->last->line, mdoc->last->pos,
1053: "columns == %d (have %d)", cols, i);
1.89 kristaps 1054: return(rc);
1.1 kristaps 1055: default:
1056: break;
1057: }
1058:
1059: return(1);
1060: }
1061:
1062:
1063: static int
1.14 kristaps 1064: post_bl_head(POST_ARGS)
1065: {
1.90 kristaps 1066: int i;
1067: struct mdoc_node *n;
1.14 kristaps 1068:
1.90 kristaps 1069: assert(mdoc->last->parent);
1.14 kristaps 1070: n = mdoc->last->parent;
1071:
1.90 kristaps 1072: if (LIST_column == n->data.list) {
1073: for (i = 0; i < (int)n->args->argc; i++)
1074: if (MDOC_Column == n->args->argv[i].arg)
1075: break;
1076: assert(i < (int)n->args->argc);
1077:
1078: if (n->args->argv[i].sz && mdoc->last->nchild) {
1079: mdoc_nmsg(mdoc, n, MANDOCERR_COLUMNS);
1080: return(0);
1.65 kristaps 1081: }
1.90 kristaps 1082: return(1);
1.65 kristaps 1083: }
1.14 kristaps 1084:
1.65 kristaps 1085: if (0 == (i = mdoc->last->nchild))
1086: return(1);
1087: return(warn_count(mdoc, "==", 0, "line arguments", i));
1.14 kristaps 1088: }
1089:
1090:
1091: static int
1.1 kristaps 1092: post_bl(POST_ARGS)
1093: {
1094: struct mdoc_node *n;
1095:
1.14 kristaps 1096: if (MDOC_HEAD == mdoc->last->type)
1097: return(post_bl_head(mdoc));
1.1 kristaps 1098: if (MDOC_BODY != mdoc->last->type)
1099: return(1);
1100: if (NULL == mdoc->last->child)
1101: return(1);
1102:
1.55 kristaps 1103: /*
1104: * We only allow certain children of `Bl'. This is usually on
1105: * `It', but apparently `Sm' occurs here and there, so we let
1106: * that one through, too.
1107: */
1108:
1.1 kristaps 1109: /* LINTED */
1110: for (n = mdoc->last->child; n; n = n->next) {
1.55 kristaps 1111: if (MDOC_BLOCK == n->type && MDOC_It == n->tok)
1112: continue;
1113: if (MDOC_Sm == n->tok)
1114: continue;
1.79 kristaps 1115: mdoc_nmsg(mdoc, n, MANDOCERR_SYNTCHILD);
1116: return(0);
1.1 kristaps 1117: }
1118:
1119: return(1);
1120: }
1121:
1122:
1123: static int
1124: ebool(struct mdoc *mdoc)
1125: {
1126: struct mdoc_node *n;
1127:
1128: /* LINTED */
1129: for (n = mdoc->last->child; n; n = n->next) {
1130: if (MDOC_TEXT != n->type)
1131: break;
1.2 kristaps 1132: if (0 == strcmp(n->string, "on"))
1.1 kristaps 1133: continue;
1.2 kristaps 1134: if (0 == strcmp(n->string, "off"))
1.1 kristaps 1135: continue;
1136: break;
1137: }
1138:
1139: if (NULL == n)
1140: return(1);
1.79 kristaps 1141: return(mdoc_nmsg(mdoc, n, MANDOCERR_BADBOOL));
1.1 kristaps 1142: }
1143:
1144:
1145: static int
1146: post_root(POST_ARGS)
1147: {
1148:
1149: if (NULL == mdoc->first->child)
1.79 kristaps 1150: mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY);
1151: else if ( ! (MDOC_PBODY & mdoc->flags))
1152: mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCPROLOG);
1153: else if (MDOC_BLOCK != mdoc->first->child->type)
1154: mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY);
1155: else if (MDOC_Sh != mdoc->first->child->tok)
1156: mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY);
1157: else
1158: return(1);
1.1 kristaps 1159:
1.79 kristaps 1160: return(0);
1.1 kristaps 1161: }
1162:
1163:
1164: static int
1165: post_st(POST_ARGS)
1166: {
1167:
1168: if (mdoc_a2st(mdoc->last->child->string))
1169: return(1);
1.79 kristaps 1170: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADSTANDARD));
1.1 kristaps 1171: }
1172:
1173:
1174: static int
1.43 kristaps 1175: post_rs(POST_ARGS)
1176: {
1177: struct mdoc_node *nn;
1178:
1179: if (MDOC_BODY != mdoc->last->type)
1180: return(1);
1181:
1182: for (nn = mdoc->last->child; nn; nn = nn->next)
1183: switch (nn->tok) {
1.50 kristaps 1184: case(MDOC__U):
1185: /* FALLTHROUGH */
1.43 kristaps 1186: case(MDOC__Q):
1187: /* FALLTHROUGH */
1188: case(MDOC__C):
1189: /* FALLTHROUGH */
1190: case(MDOC__A):
1191: /* FALLTHROUGH */
1192: case(MDOC__B):
1193: /* FALLTHROUGH */
1194: case(MDOC__D):
1195: /* FALLTHROUGH */
1196: case(MDOC__I):
1197: /* FALLTHROUGH */
1198: case(MDOC__J):
1199: /* FALLTHROUGH */
1200: case(MDOC__N):
1201: /* FALLTHROUGH */
1202: case(MDOC__O):
1203: /* FALLTHROUGH */
1204: case(MDOC__P):
1205: /* FALLTHROUGH */
1206: case(MDOC__R):
1207: /* FALLTHROUGH */
1208: case(MDOC__T):
1209: /* FALLTHROUGH */
1210: case(MDOC__V):
1211: break;
1212: default:
1.79 kristaps 1213: mdoc_nmsg(mdoc, nn, MANDOCERR_SYNTCHILD);
1214: return(0);
1.43 kristaps 1215: }
1216:
1217: return(1);
1218: }
1219:
1220:
1221: static int
1.1 kristaps 1222: post_sh(POST_ARGS)
1223: {
1224:
1225: if (MDOC_HEAD == mdoc->last->type)
1226: return(post_sh_head(mdoc));
1227: if (MDOC_BODY == mdoc->last->type)
1228: return(post_sh_body(mdoc));
1229:
1230: return(1);
1231: }
1232:
1233:
1234: static int
1235: post_sh_body(POST_ARGS)
1236: {
1237: struct mdoc_node *n;
1238:
1.29 kristaps 1239: if (SEC_NAME != mdoc->lastsec)
1.1 kristaps 1240: return(1);
1241:
1242: /*
1243: * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1244: * macros (can have multiple `Nm' and one `Nd'). Note that the
1245: * children of the BODY declaration can also be "text".
1246: */
1247:
1248: if (NULL == (n = mdoc->last->child))
1.79 kristaps 1249: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC));
1.1 kristaps 1250:
1251: for ( ; n && n->next; n = n->next) {
1252: if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1253: continue;
1.28 kristaps 1254: if (MDOC_TEXT == n->type)
1255: continue;
1.79 kristaps 1256: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC))
1.1 kristaps 1257: return(0);
1258: }
1259:
1.41 kristaps 1260: assert(n);
1.27 kristaps 1261: if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
1.1 kristaps 1262: return(1);
1.79 kristaps 1263: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC));
1.1 kristaps 1264: }
1265:
1266:
1267: static int
1268: post_sh_head(POST_ARGS)
1269: {
1.81 kristaps 1270: char buf[BUFSIZ];
1.2 kristaps 1271: enum mdoc_sec sec;
1272: const struct mdoc_node *n;
1.1 kristaps 1273:
1274: /*
1275: * Process a new section. Sections are either "named" or
1276: * "custom"; custom sections are user-defined, while named ones
1277: * usually follow a conventional order and may only appear in
1278: * certain manual sections.
1279: */
1280:
1.79 kristaps 1281: buf[0] = '\0';
1282:
1283: /*
1284: * FIXME: yes, these can use a dynamic buffer, but I don't do so
1285: * in the interests of simplicity.
1286: */
1.1 kristaps 1287:
1.2 kristaps 1288: for (n = mdoc->last->child; n; n = n->next) {
1.12 kristaps 1289: /* XXX - copied from compact(). */
1.2 kristaps 1290: assert(MDOC_TEXT == n->type);
1.12 kristaps 1291:
1.81 kristaps 1292: if (strlcat(buf, n->string, BUFSIZ) >= BUFSIZ) {
1.79 kristaps 1293: mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
1294: return(0);
1295: }
1.2 kristaps 1296: if (NULL == n->next)
1297: continue;
1.81 kristaps 1298: if (strlcat(buf, " ", BUFSIZ) >= BUFSIZ) {
1.79 kristaps 1299: mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
1300: return(0);
1301: }
1.2 kristaps 1302: }
1.1 kristaps 1303:
1.72 kristaps 1304: sec = mdoc_str2sec(buf);
1.1 kristaps 1305:
1.12 kristaps 1306: /*
1307: * Check: NAME should always be first, CUSTOM has no roles,
1308: * non-CUSTOM has a conventional order to be followed.
1309: */
1.1 kristaps 1310:
1.72 kristaps 1311: if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
1.79 kristaps 1312: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NAMESECFIRST))
1.72 kristaps 1313: return(0);
1314:
1.1 kristaps 1315: if (SEC_CUSTOM == sec)
1316: return(1);
1.72 kristaps 1317:
1.1 kristaps 1318: if (sec == mdoc->lastnamed)
1.79 kristaps 1319: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECREP))
1.26 kristaps 1320: return(0);
1.72 kristaps 1321:
1.1 kristaps 1322: if (sec < mdoc->lastnamed)
1.79 kristaps 1323: if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECOOO))
1.26 kristaps 1324: return(0);
1.1 kristaps 1325:
1.12 kristaps 1326: /*
1327: * Check particular section/manual conventions. LIBRARY can
1.78 kristaps 1328: * only occur in manual section 2, 3, and 9.
1.12 kristaps 1329: */
1.1 kristaps 1330:
1331: switch (sec) {
1332: case (SEC_LIBRARY):
1.78 kristaps 1333: assert(mdoc->meta.msec);
1334: if (*mdoc->meta.msec == '2')
1335: break;
1336: if (*mdoc->meta.msec == '3')
1337: break;
1338: if (*mdoc->meta.msec == '9')
1.1 kristaps 1339: break;
1.79 kristaps 1340: return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECMSEC));
1.1 kristaps 1341: default:
1342: break;
1343: }
1344:
1345: return(1);
1346: }
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