Annotation of src/usr.bin/mandoc/man_validate.c, Revision 1.30
1.30 ! schwarze 1: /* $Id: man_validate.c,v 1.29 2010/08/20 00:53:35 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.30 ! schwarze 98: { NULL, NULL }, /* TS */
! 99: { NULL, NULL }, /* TE */
1.1 kristaps 100: };
101:
102:
103: int
1.27 schwarze 104: man_valid_pre(struct man *m, struct man_node *n)
1.7 schwarze 105: {
106: v_check *cp;
107:
108: if (MAN_TEXT == n->type)
109: return(1);
110: if (MAN_ROOT == n->type)
111: return(1);
112:
113: if (NULL == (cp = man_valids[n->tok].pres))
114: return(1);
115: for ( ; *cp; cp++)
116: if ( ! (*cp)(m, n))
117: return(0);
118: return(1);
119: }
120:
121:
122: int
1.1 kristaps 123: man_valid_post(struct man *m)
124: {
1.7 schwarze 125: v_check *cp;
1.1 kristaps 126:
127: if (MAN_VALID & m->last->flags)
128: return(1);
129: m->last->flags |= MAN_VALID;
130:
131: switch (m->last->type) {
132: case (MAN_TEXT):
1.4 schwarze 133: return(check_text(m, m->last));
1.1 kristaps 134: case (MAN_ROOT):
1.4 schwarze 135: return(check_root(m, m->last));
1.1 kristaps 136: default:
137: break;
138: }
139:
140: if (NULL == (cp = man_valids[m->last->tok].posts))
141: return(1);
142: for ( ; *cp; cp++)
143: if ( ! (*cp)(m, m->last))
144: return(0);
145:
146: return(1);
147: }
148:
149:
1.4 schwarze 150: static int
1.7 schwarze 151: check_root(CHKARGS)
1.4 schwarze 152: {
1.7 schwarze 153:
154: if (MAN_BLINE & m->flags)
1.25 schwarze 155: return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT));
1.7 schwarze 156: if (MAN_ELINE & m->flags)
1.25 schwarze 157: return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT));
1.8 schwarze 158:
159: m->flags &= ~MAN_BLINE;
160: m->flags &= ~MAN_ELINE;
1.7 schwarze 161:
1.25 schwarze 162: if (NULL == m->first->child) {
163: man_nmsg(m, n, MANDOCERR_NODOCBODY);
164: return(0);
165: } else if (NULL == m->meta.title) {
166: if ( ! man_nmsg(m, n, MANDOCERR_NOTITLE))
1.17 schwarze 167: return(0);
1.18 schwarze 168: /*
169: * If a title hasn't been set, do so now (by
170: * implication, date and section also aren't set).
171: *
172: * FIXME: this should be in man_action.c.
173: */
1.17 schwarze 174: m->meta.title = mandoc_strdup("unknown");
1.18 schwarze 175: m->meta.date = time(NULL);
1.21 schwarze 176: m->meta.msec = mandoc_strdup("1");
1.17 schwarze 177: }
1.15 schwarze 178:
179: return(1);
180: }
181:
182:
183: static int
184: check_title(CHKARGS)
185: {
186: const char *p;
187:
188: assert(n->child);
1.25 schwarze 189: /* FIXME: is this sufficient? */
190: if ('\0' == *n->child->string) {
191: man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
192: return(0);
193: }
1.15 schwarze 194:
195: for (p = n->child->string; '\0' != *p; p++)
196: if (isalpha((u_char)*p) && ! isupper((u_char)*p))
1.25 schwarze 197: if ( ! man_nmsg(m, n, MANDOCERR_UPPERCASE))
1.15 schwarze 198: return(0);
1.4 schwarze 199:
200: return(1);
201: }
202:
203:
204: static int
1.7 schwarze 205: check_text(CHKARGS)
1.4 schwarze 206: {
1.27 schwarze 207: char *p;
1.5 schwarze 208: int pos, c;
1.28 schwarze 209: size_t sz;
1.4 schwarze 210:
1.28 schwarze 211: for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {
212: sz = strcspn(p, "\t\\");
213: p += (int)sz;
214:
215: if ('\0' == *p)
216: break;
217:
218: pos += (int)sz;
1.4 schwarze 219:
1.28 schwarze 220: if ('\t' == *p) {
221: if (MAN_LITERAL & m->flags)
222: continue;
223: if (man_pmsg(m, n->line, pos, MANDOCERR_BADTAB))
1.5 schwarze 224: continue;
1.28 schwarze 225: return(0);
226: }
227:
228: /* Check the special character. */
1.25 schwarze 229:
1.28 schwarze 230: c = mandoc_special(p);
231: if (c) {
232: p += c - 1;
233: pos += c - 1;
1.29 schwarze 234: } else
235: man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE);
1.4 schwarze 236: }
237:
238: return(1);
1.1 kristaps 239: }
240:
241:
242: #define INEQ_DEFINE(x, ineq, name) \
243: static int \
1.7 schwarze 244: check_##name(CHKARGS) \
1.1 kristaps 245: { \
1.4 schwarze 246: if (n->nchild ineq (x)) \
1.1 kristaps 247: return(1); \
1.25 schwarze 248: man_vmsg(m, MANDOCERR_SYNTARGCOUNT, n->line, n->pos, \
249: "line arguments %s %d (have %d)", \
250: #ineq, (x), n->nchild); \
251: return(0); \
1.1 kristaps 252: }
253:
254: INEQ_DEFINE(0, ==, eq0)
1.10 schwarze 255: INEQ_DEFINE(1, <=, le1)
1.1 kristaps 256: INEQ_DEFINE(2, >=, ge2)
257: INEQ_DEFINE(5, <=, le5)
1.7 schwarze 258:
259:
260: static int
261: check_sec(CHKARGS)
262: {
1.6 schwarze 263:
1.25 schwarze 264: if (MAN_HEAD == n->type && 0 == n->nchild) {
265: man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
266: return(0);
267: } else if (MAN_BODY == n->type && 0 == n->nchild)
268: return(man_nmsg(m, n, MANDOCERR_NOBODY));
269:
1.6 schwarze 270: return(1);
271: }
1.7 schwarze 272:
273:
274: static int
1.8 schwarze 275: check_part(CHKARGS)
276: {
277:
278: if (MAN_BODY == n->type && 0 == n->nchild)
1.25 schwarze 279: return(man_nmsg(m, n, MANDOCERR_NOBODY));
1.8 schwarze 280: return(1);
281: }
282:
283:
284: static int
1.7 schwarze 285: check_par(CHKARGS)
286: {
287:
288: if (MAN_BODY == n->type)
289: switch (n->tok) {
290: case (MAN_IP):
291: /* FALLTHROUGH */
292: case (MAN_HP):
293: /* FALLTHROUGH */
294: case (MAN_TP):
295: /* Body-less lists are ok. */
296: break;
297: default:
298: if (n->nchild)
299: break;
1.25 schwarze 300: return(man_nmsg(m, n, MANDOCERR_NOBODY));
1.7 schwarze 301: }
302: if (MAN_HEAD == n->type)
303: switch (n->tok) {
304: case (MAN_PP):
305: /* FALLTHROUGH */
306: case (MAN_P):
307: /* FALLTHROUGH */
308: case (MAN_LP):
309: if (0 == n->nchild)
310: break;
1.25 schwarze 311: return(man_nmsg(m, n, MANDOCERR_ARGSLOST));
1.7 schwarze 312: default:
313: if (n->nchild)
314: break;
1.25 schwarze 315: return(man_nmsg(m, n, MANDOCERR_NOARGS));
1.7 schwarze 316: }
317:
318: return(1);
319: }
320:
321:
322: static int
323: check_bline(CHKARGS)
324: {
325:
1.8 schwarze 326: assert( ! (MAN_ELINE & m->flags));
1.25 schwarze 327: if (MAN_BLINE & m->flags) {
328: man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE);
329: return(0);
330: }
1.14 schwarze 331:
1.7 schwarze 332: return(1);
333: }
334:
![[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