Annotation of src/usr.bin/mandoc/man_validate.c, Revision 1.32
1.32 ! schwarze 1: /* $Id: man_validate.c,v 1.31 2010/10/27 10:17:45 schwarze Exp $ */
1.1 kristaps 2: /*
1.28 schwarze 3: * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
1.32 ! schwarze 4: * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.2 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 17: */
18: #include <sys/types.h>
19:
20: #include <assert.h>
21: #include <ctype.h>
1.6 schwarze 22: #include <errno.h>
23: #include <limits.h>
1.1 kristaps 24: #include <stdarg.h>
25: #include <stdlib.h>
1.28 schwarze 26: #include <string.h>
1.1 kristaps 27:
1.25 schwarze 28: #include "mandoc.h"
1.1 kristaps 29: #include "libman.h"
1.5 schwarze 30: #include "libmandoc.h"
1.1 kristaps 31:
1.27 schwarze 32: #define CHKARGS struct man *m, struct man_node *n
1.1 kristaps 33:
1.7 schwarze 34: typedef int (*v_check)(CHKARGS);
1.1 kristaps 35:
36: struct man_valid {
1.7 schwarze 37: v_check *pres;
38: v_check *posts;
1.1 kristaps 39: };
40:
1.7 schwarze 41: static int check_bline(CHKARGS);
42: static int check_eq0(CHKARGS);
1.10 schwarze 43: static int check_le1(CHKARGS);
1.7 schwarze 44: static int check_ge2(CHKARGS);
45: static int check_le5(CHKARGS);
1.32 ! schwarze 46: static int check_ft(CHKARGS);
1.7 schwarze 47: static int check_par(CHKARGS);
1.8 schwarze 48: static int check_part(CHKARGS);
1.7 schwarze 49: static int check_root(CHKARGS);
50: static int check_sec(CHKARGS);
51: static int check_text(CHKARGS);
1.15 schwarze 52: static int check_title(CHKARGS);
1.7 schwarze 53:
54: static v_check posts_eq0[] = { check_eq0, NULL };
1.32 ! schwarze 55: static v_check posts_ft[] = { check_ft, NULL };
1.15 schwarze 56: static v_check posts_th[] = { check_ge2, check_le5, check_title, NULL };
1.7 schwarze 57: static v_check posts_par[] = { check_par, NULL };
1.8 schwarze 58: static v_check posts_part[] = { check_part, NULL };
1.7 schwarze 59: static v_check posts_sec[] = { check_sec, NULL };
1.13 schwarze 60: static v_check posts_le1[] = { check_le1, NULL };
1.7 schwarze 61: static v_check pres_bline[] = { check_bline, NULL };
1.1 kristaps 62:
63: static const struct man_valid man_valids[MAN_MAX] = {
1.12 schwarze 64: { NULL, posts_eq0 }, /* br */
1.15 schwarze 65: { pres_bline, posts_th }, /* TH */
1.7 schwarze 66: { pres_bline, posts_sec }, /* SH */
67: { pres_bline, posts_sec }, /* SS */
68: { pres_bline, posts_par }, /* TP */
69: { pres_bline, posts_par }, /* LP */
70: { pres_bline, posts_par }, /* PP */
71: { pres_bline, posts_par }, /* P */
72: { pres_bline, posts_par }, /* IP */
73: { pres_bline, posts_par }, /* HP */
1.8 schwarze 74: { NULL, NULL }, /* SM */
75: { NULL, NULL }, /* SB */
1.7 schwarze 76: { NULL, NULL }, /* BI */
77: { NULL, NULL }, /* IB */
78: { NULL, NULL }, /* BR */
79: { NULL, NULL }, /* RB */
1.8 schwarze 80: { NULL, NULL }, /* R */
81: { NULL, NULL }, /* B */
82: { NULL, NULL }, /* I */
1.7 schwarze 83: { NULL, NULL }, /* IR */
84: { NULL, NULL }, /* RI */
1.28 schwarze 85: { NULL, posts_eq0 }, /* na */ /* FIXME: should warn only. */
1.7 schwarze 86: { NULL, NULL }, /* i */
1.28 schwarze 87: { NULL, posts_le1 }, /* sp */ /* FIXME: should warn only. */
1.7 schwarze 88: { pres_bline, posts_eq0 }, /* nf */
89: { pres_bline, posts_eq0 }, /* fi */
90: { NULL, NULL }, /* r */
1.8 schwarze 91: { NULL, NULL }, /* RE */
92: { NULL, posts_part }, /* RS */
93: { NULL, NULL }, /* DT */
1.9 schwarze 94: { NULL, NULL }, /* UC */
1.11 schwarze 95: { NULL, NULL }, /* PD */
1.28 schwarze 96: { NULL, posts_le1 }, /* Sp */ /* FIXME: should warn only. */
97: { pres_bline, posts_le1 }, /* Vb */ /* FIXME: should warn only. */
1.13 schwarze 98: { pres_bline, posts_eq0 }, /* Ve */
1.24 schwarze 99: { NULL, NULL }, /* AT */
1.28 schwarze 100: { NULL, NULL }, /* in */
1.30 schwarze 101: { NULL, NULL }, /* TS */
102: { NULL, NULL }, /* TE */
1.32 ! schwarze 103: { NULL, posts_ft }, /* ft */
1.1 kristaps 104: };
105:
106:
107: int
1.27 schwarze 108: man_valid_pre(struct man *m, struct man_node *n)
1.7 schwarze 109: {
110: v_check *cp;
111:
112: if (MAN_TEXT == n->type)
113: return(1);
114: if (MAN_ROOT == n->type)
115: return(1);
116:
117: if (NULL == (cp = man_valids[n->tok].pres))
118: return(1);
119: for ( ; *cp; cp++)
120: if ( ! (*cp)(m, n))
121: return(0);
122: return(1);
123: }
124:
125:
126: int
1.1 kristaps 127: man_valid_post(struct man *m)
128: {
1.7 schwarze 129: v_check *cp;
1.1 kristaps 130:
131: if (MAN_VALID & m->last->flags)
132: return(1);
133: m->last->flags |= MAN_VALID;
134:
135: switch (m->last->type) {
136: case (MAN_TEXT):
1.4 schwarze 137: return(check_text(m, m->last));
1.1 kristaps 138: case (MAN_ROOT):
1.4 schwarze 139: return(check_root(m, m->last));
1.1 kristaps 140: default:
141: break;
142: }
143:
144: if (NULL == (cp = man_valids[m->last->tok].posts))
145: return(1);
146: for ( ; *cp; cp++)
147: if ( ! (*cp)(m, m->last))
148: return(0);
149:
150: return(1);
151: }
152:
153:
1.4 schwarze 154: static int
1.7 schwarze 155: check_root(CHKARGS)
1.4 schwarze 156: {
1.7 schwarze 157:
158: if (MAN_BLINE & m->flags)
1.25 schwarze 159: return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT));
1.7 schwarze 160: if (MAN_ELINE & m->flags)
1.25 schwarze 161: return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT));
1.8 schwarze 162:
163: m->flags &= ~MAN_BLINE;
164: m->flags &= ~MAN_ELINE;
1.7 schwarze 165:
1.25 schwarze 166: if (NULL == m->first->child) {
167: man_nmsg(m, n, MANDOCERR_NODOCBODY);
168: return(0);
169: } else if (NULL == m->meta.title) {
170: if ( ! man_nmsg(m, n, MANDOCERR_NOTITLE))
1.17 schwarze 171: return(0);
1.18 schwarze 172: /*
173: * If a title hasn't been set, do so now (by
174: * implication, date and section also aren't set).
175: *
176: * FIXME: this should be in man_action.c.
177: */
1.17 schwarze 178: m->meta.title = mandoc_strdup("unknown");
1.18 schwarze 179: m->meta.date = time(NULL);
1.21 schwarze 180: m->meta.msec = mandoc_strdup("1");
1.17 schwarze 181: }
1.15 schwarze 182:
183: return(1);
184: }
185:
186:
187: static int
188: check_title(CHKARGS)
189: {
190: const char *p;
191:
192: assert(n->child);
1.25 schwarze 193: /* FIXME: is this sufficient? */
194: if ('\0' == *n->child->string) {
195: man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
196: return(0);
197: }
1.15 schwarze 198:
199: for (p = n->child->string; '\0' != *p; p++)
200: if (isalpha((u_char)*p) && ! isupper((u_char)*p))
1.25 schwarze 201: if ( ! man_nmsg(m, n, MANDOCERR_UPPERCASE))
1.15 schwarze 202: return(0);
1.4 schwarze 203:
204: return(1);
205: }
206:
207:
208: static int
1.7 schwarze 209: check_text(CHKARGS)
1.4 schwarze 210: {
1.27 schwarze 211: char *p;
1.5 schwarze 212: int pos, c;
1.28 schwarze 213: size_t sz;
1.4 schwarze 214:
1.28 schwarze 215: for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {
216: sz = strcspn(p, "\t\\");
217: p += (int)sz;
218:
219: if ('\0' == *p)
220: break;
221:
222: pos += (int)sz;
1.4 schwarze 223:
1.28 schwarze 224: if ('\t' == *p) {
225: if (MAN_LITERAL & m->flags)
226: continue;
227: if (man_pmsg(m, n->line, pos, MANDOCERR_BADTAB))
1.5 schwarze 228: continue;
1.28 schwarze 229: return(0);
230: }
231:
232: /* Check the special character. */
1.25 schwarze 233:
1.28 schwarze 234: c = mandoc_special(p);
235: if (c) {
236: p += c - 1;
237: pos += c - 1;
1.29 schwarze 238: } else
239: man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE);
1.4 schwarze 240: }
241:
242: return(1);
1.1 kristaps 243: }
244:
245:
246: #define INEQ_DEFINE(x, ineq, name) \
247: static int \
1.7 schwarze 248: check_##name(CHKARGS) \
1.1 kristaps 249: { \
1.4 schwarze 250: if (n->nchild ineq (x)) \
1.1 kristaps 251: return(1); \
1.25 schwarze 252: man_vmsg(m, MANDOCERR_SYNTARGCOUNT, n->line, n->pos, \
253: "line arguments %s %d (have %d)", \
254: #ineq, (x), n->nchild); \
255: return(0); \
1.1 kristaps 256: }
257:
258: INEQ_DEFINE(0, ==, eq0)
1.10 schwarze 259: INEQ_DEFINE(1, <=, le1)
1.1 kristaps 260: INEQ_DEFINE(2, >=, ge2)
261: INEQ_DEFINE(5, <=, le5)
1.32 ! schwarze 262:
! 263:
! 264: static int
! 265: check_ft(CHKARGS)
! 266: {
! 267: char *cp;
! 268: int ok;
! 269:
! 270: if (0 == n->nchild)
! 271: return(1);
! 272:
! 273: ok = 0;
! 274: cp = n->child->string;
! 275: switch (*cp) {
! 276: case ('1'):
! 277: /* FALLTHROUGH */
! 278: case ('2'):
! 279: /* FALLTHROUGH */
! 280: case ('3'):
! 281: /* FALLTHROUGH */
! 282: case ('4'):
! 283: /* FALLTHROUGH */
! 284: case ('I'):
! 285: /* FALLTHROUGH */
! 286: case ('P'):
! 287: /* FALLTHROUGH */
! 288: case ('R'):
! 289: if ('\0' == cp[1])
! 290: ok = 1;
! 291: break;
! 292: case ('B'):
! 293: if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2]))
! 294: ok = 1;
! 295: break;
! 296: case ('C'):
! 297: if ('W' == cp[1] && '\0' == cp[2])
! 298: ok = 1;
! 299: break;
! 300: default:
! 301: break;
! 302: }
! 303:
! 304: if (0 == ok) {
! 305: man_vmsg(m, MANDOCERR_BADFONT, n->line, n->pos, "%s", cp);
! 306: *cp = '\0';
! 307: }
! 308:
! 309: if (1 < n->nchild)
! 310: man_vmsg(m, MANDOCERR_ARGCOUNT, n->line, n->pos,
! 311: "want one child (have %d)", n->nchild);
! 312:
! 313: return(1);
! 314: }
1.7 schwarze 315:
316:
317: static int
318: check_sec(CHKARGS)
319: {
1.6 schwarze 320:
1.25 schwarze 321: if (MAN_HEAD == n->type && 0 == n->nchild) {
322: man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
323: return(0);
324: } else if (MAN_BODY == n->type && 0 == n->nchild)
325: return(man_nmsg(m, n, MANDOCERR_NOBODY));
326:
1.6 schwarze 327: return(1);
328: }
1.7 schwarze 329:
330:
331: static int
1.8 schwarze 332: check_part(CHKARGS)
333: {
334:
335: if (MAN_BODY == n->type && 0 == n->nchild)
1.25 schwarze 336: return(man_nmsg(m, n, MANDOCERR_NOBODY));
1.8 schwarze 337: return(1);
338: }
339:
340:
341: static int
1.7 schwarze 342: check_par(CHKARGS)
343: {
344:
345: if (MAN_BODY == n->type)
346: switch (n->tok) {
347: case (MAN_IP):
348: /* FALLTHROUGH */
349: case (MAN_HP):
350: /* FALLTHROUGH */
351: case (MAN_TP):
352: /* Body-less lists are ok. */
353: break;
354: default:
355: if (n->nchild)
356: break;
1.25 schwarze 357: return(man_nmsg(m, n, MANDOCERR_NOBODY));
1.7 schwarze 358: }
359: if (MAN_HEAD == n->type)
360: switch (n->tok) {
361: case (MAN_PP):
362: /* FALLTHROUGH */
363: case (MAN_P):
364: /* FALLTHROUGH */
365: case (MAN_LP):
366: if (0 == n->nchild)
367: break;
1.25 schwarze 368: return(man_nmsg(m, n, MANDOCERR_ARGSLOST));
1.7 schwarze 369: default:
1.31 schwarze 370: break;
1.7 schwarze 371: }
372:
373: return(1);
374: }
375:
376:
377: static int
378: check_bline(CHKARGS)
379: {
380:
1.8 schwarze 381: assert( ! (MAN_ELINE & m->flags));
1.25 schwarze 382: if (MAN_BLINE & m->flags) {
383: man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE);
384: return(0);
385: }
1.14 schwarze 386:
1.7 schwarze 387: return(1);
388: }
389:
![[BACK]](/icons/back.gif){kind=icon}
Return to man_validate.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc