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