Annotation of mandoc/man_validate.c, Revision 1.46
1.46 ! kristaps 1: /* $Id: man_validate.c,v 1.45 2010/06/28 14:39:17 kristaps Exp $ */
1.1 kristaps 2: /*
1.44 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.8 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.8 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.28 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.16 kristaps 25: #include <errno.h>
26: #include <limits.h>
1.1 kristaps 27: #include <stdarg.h>
28: #include <stdlib.h>
1.46 ! kristaps 29: #include <string.h>
1.1 kristaps 30:
1.41 kristaps 31: #include "mandoc.h"
1.1 kristaps 32: #include "libman.h"
1.15 kristaps 33: #include "libmandoc.h"
1.1 kristaps 34:
1.43 kristaps 35: #define CHKARGS struct man *m, struct man_node *n
1.1 kristaps 36:
1.17 kristaps 37: typedef int (*v_check)(CHKARGS);
1.1 kristaps 38:
39: struct man_valid {
1.17 kristaps 40: v_check *pres;
41: v_check *posts;
1.1 kristaps 42: };
43:
1.17 kristaps 44: static int check_bline(CHKARGS);
45: static int check_eq0(CHKARGS);
1.25 kristaps 46: static int check_le1(CHKARGS);
1.17 kristaps 47: static int check_ge2(CHKARGS);
48: static int check_le5(CHKARGS);
49: static int check_par(CHKARGS);
1.23 kristaps 50: static int check_part(CHKARGS);
1.17 kristaps 51: static int check_root(CHKARGS);
52: static int check_sec(CHKARGS);
53: static int check_text(CHKARGS);
1.32 kristaps 54: static int check_title(CHKARGS);
1.17 kristaps 55:
56: static v_check posts_eq0[] = { check_eq0, NULL };
1.32 kristaps 57: static v_check posts_th[] = { check_ge2, check_le5, check_title, NULL };
1.17 kristaps 58: static v_check posts_par[] = { check_par, NULL };
1.23 kristaps 59: static v_check posts_part[] = { check_part, NULL };
1.17 kristaps 60: static v_check posts_sec[] = { check_sec, NULL };
1.30 kristaps 61: static v_check posts_le1[] = { check_le1, NULL };
1.17 kristaps 62: static v_check pres_bline[] = { check_bline, NULL };
1.1 kristaps 63:
64: static const struct man_valid man_valids[MAN_MAX] = {
1.29 kristaps 65: { NULL, posts_eq0 }, /* br */
1.32 kristaps 66: { pres_bline, posts_th }, /* TH */
1.17 kristaps 67: { pres_bline, posts_sec }, /* SH */
68: { pres_bline, posts_sec }, /* SS */
69: { pres_bline, posts_par }, /* TP */
70: { pres_bline, posts_par }, /* LP */
71: { pres_bline, posts_par }, /* PP */
72: { pres_bline, posts_par }, /* P */
73: { pres_bline, posts_par }, /* IP */
74: { pres_bline, posts_par }, /* HP */
1.22 kristaps 75: { NULL, NULL }, /* SM */
76: { NULL, NULL }, /* SB */
1.17 kristaps 77: { NULL, NULL }, /* BI */
78: { NULL, NULL }, /* IB */
79: { NULL, NULL }, /* BR */
80: { NULL, NULL }, /* RB */
1.22 kristaps 81: { NULL, NULL }, /* R */
82: { NULL, NULL }, /* B */
83: { NULL, NULL }, /* I */
1.17 kristaps 84: { NULL, NULL }, /* IR */
85: { NULL, NULL }, /* RI */
1.29 kristaps 86: { NULL, posts_eq0 }, /* na */
1.17 kristaps 87: { NULL, NULL }, /* i */
1.30 kristaps 88: { NULL, posts_le1 }, /* sp */
1.17 kristaps 89: { pres_bline, posts_eq0 }, /* nf */
90: { pres_bline, posts_eq0 }, /* fi */
91: { NULL, NULL }, /* r */
1.19 kristaps 92: { NULL, NULL }, /* RE */
1.23 kristaps 93: { NULL, posts_part }, /* RS */
1.21 kristaps 94: { NULL, NULL }, /* DT */
1.24 kristaps 95: { NULL, NULL }, /* UC */
1.26 kristaps 96: { NULL, NULL }, /* PD */
1.36 kristaps 97: { NULL, posts_le1 }, /* Sp */
1.30 kristaps 98: { pres_bline, posts_le1 }, /* Vb */
99: { pres_bline, posts_eq0 }, /* Ve */
1.40 joerg 100: { NULL, NULL }, /* AT */
1.1 kristaps 101: };
102:
103:
104: int
1.43 kristaps 105: man_valid_pre(struct man *m, struct man_node *n)
1.17 kristaps 106: {
107: v_check *cp;
108:
109: if (MAN_TEXT == n->type)
110: return(1);
111: if (MAN_ROOT == n->type)
112: return(1);
113:
114: if (NULL == (cp = man_valids[n->tok].pres))
115: return(1);
116: for ( ; *cp; cp++)
117: if ( ! (*cp)(m, n))
118: return(0);
119: return(1);
120: }
121:
122:
123: int
1.1 kristaps 124: man_valid_post(struct man *m)
125: {
1.17 kristaps 126: v_check *cp;
1.1 kristaps 127:
128: if (MAN_VALID & m->last->flags)
129: return(1);
130: m->last->flags |= MAN_VALID;
131:
132: switch (m->last->type) {
133: case (MAN_TEXT):
1.11 kristaps 134: return(check_text(m, m->last));
1.1 kristaps 135: case (MAN_ROOT):
1.14 kristaps 136: return(check_root(m, m->last));
1.1 kristaps 137: default:
138: break;
139: }
140:
141: if (NULL == (cp = man_valids[m->last->tok].posts))
142: return(1);
143: for ( ; *cp; cp++)
144: if ( ! (*cp)(m, m->last))
145: return(0);
146:
147: return(1);
148: }
149:
150:
1.11 kristaps 151: static int
1.17 kristaps 152: check_root(CHKARGS)
1.14 kristaps 153: {
1.17 kristaps 154:
155: if (MAN_BLINE & m->flags)
1.41 kristaps 156: return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT));
1.17 kristaps 157: if (MAN_ELINE & m->flags)
1.41 kristaps 158: return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT));
1.22 kristaps 159:
160: m->flags &= ~MAN_BLINE;
161: m->flags &= ~MAN_ELINE;
1.17 kristaps 162:
1.41 kristaps 163: if (NULL == m->first->child) {
164: man_nmsg(m, n, MANDOCERR_NODOCBODY);
165: return(0);
166: } else if (NULL == m->meta.title) {
167: if ( ! man_nmsg(m, n, MANDOCERR_NOTITLE))
1.34 kristaps 168: return(0);
169: /*
170: * If a title hasn't been set, do so now (by
171: * implication, date and section also aren't set).
172: *
173: * FIXME: this should be in man_action.c.
174: */
175: m->meta.title = mandoc_strdup("unknown");
176: m->meta.date = time(NULL);
1.37 kristaps 177: m->meta.msec = mandoc_strdup("1");
1.34 kristaps 178: }
1.32 kristaps 179:
180: return(1);
181: }
182:
183:
184: static int
185: check_title(CHKARGS)
186: {
187: const char *p;
188:
189: assert(n->child);
1.41 kristaps 190: /* FIXME: is this sufficient? */
191: if ('\0' == *n->child->string) {
192: man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
193: return(0);
194: }
1.32 kristaps 195:
196: for (p = n->child->string; '\0' != *p; p++)
197: if (isalpha((u_char)*p) && ! isupper((u_char)*p))
1.41 kristaps 198: if ( ! man_nmsg(m, n, MANDOCERR_UPPERCASE))
1.32 kristaps 199: return(0);
1.14 kristaps 200:
201: return(1);
202: }
203:
204:
205: static int
1.17 kristaps 206: check_text(CHKARGS)
1.11 kristaps 207: {
1.43 kristaps 208: char *p;
1.15 kristaps 209: int pos, c;
1.46 ! kristaps 210: size_t sz;
1.11 kristaps 211:
1.46 ! kristaps 212: for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {
! 213: sz = strcspn(p, "\t\\");
! 214: p += (int)sz;
! 215:
! 216: if ('\0' == *p)
! 217: break;
! 218:
! 219: pos += (int)sz;
1.11 kristaps 220:
1.46 ! kristaps 221: if ('\t' == *p) {
! 222: if (MAN_LITERAL & m->flags)
! 223: continue;
! 224: if (man_pmsg(m, n->line, pos, MANDOCERR_BADTAB))
1.15 kristaps 225: continue;
1.46 ! kristaps 226: return(0);
1.15 kristaps 227: }
1.45 kristaps 228:
1.46 ! kristaps 229: /* Check the special character. */
1.15 kristaps 230:
1.46 ! kristaps 231: c = mandoc_special(p);
! 232: if (c) {
! 233: p += c - 1;
! 234: pos += c - 1;
1.11 kristaps 235: continue;
1.46 ! kristaps 236: }
! 237:
! 238: c = man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE);
! 239: if ( ! (MAN_IGN_ESCAPE & m->pflags) && ! c)
! 240: return(c);
1.11 kristaps 241: }
242:
243: return(1);
1.1 kristaps 244: }
245:
246:
247: #define INEQ_DEFINE(x, ineq, name) \
248: static int \
1.17 kristaps 249: check_##name(CHKARGS) \
1.1 kristaps 250: { \
1.11 kristaps 251: if (n->nchild ineq (x)) \
1.1 kristaps 252: return(1); \
1.41 kristaps 253: man_vmsg(m, MANDOCERR_SYNTARGCOUNT, n->line, n->pos, \
254: "line arguments %s %d (have %d)", \
255: #ineq, (x), n->nchild); \
256: return(0); \
1.1 kristaps 257: }
258:
259: INEQ_DEFINE(0, ==, eq0)
1.25 kristaps 260: INEQ_DEFINE(1, <=, le1)
1.1 kristaps 261: INEQ_DEFINE(2, >=, ge2)
262: INEQ_DEFINE(5, <=, le5)
263:
1.16 kristaps 264:
265: static int
1.17 kristaps 266: check_sec(CHKARGS)
267: {
1.16 kristaps 268:
1.41 kristaps 269: if (MAN_HEAD == n->type && 0 == n->nchild) {
270: man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
271: return(0);
272: } else if (MAN_BODY == n->type && 0 == n->nchild)
273: return(man_nmsg(m, n, MANDOCERR_NOBODY));
274:
1.16 kristaps 275: return(1);
276: }
1.17 kristaps 277:
278:
279: static int
1.23 kristaps 280: check_part(CHKARGS)
281: {
282:
283: if (MAN_BODY == n->type && 0 == n->nchild)
1.41 kristaps 284: return(man_nmsg(m, n, MANDOCERR_NOBODY));
1.23 kristaps 285: return(1);
286: }
287:
288:
289: static int
1.17 kristaps 290: check_par(CHKARGS)
291: {
292:
293: if (MAN_BODY == n->type)
294: switch (n->tok) {
295: case (MAN_IP):
296: /* FALLTHROUGH */
297: case (MAN_HP):
298: /* FALLTHROUGH */
299: case (MAN_TP):
300: /* Body-less lists are ok. */
301: break;
302: default:
303: if (n->nchild)
304: break;
1.41 kristaps 305: return(man_nmsg(m, n, MANDOCERR_NOBODY));
1.17 kristaps 306: }
307: if (MAN_HEAD == n->type)
308: switch (n->tok) {
309: case (MAN_PP):
310: /* FALLTHROUGH */
311: case (MAN_P):
312: /* FALLTHROUGH */
313: case (MAN_LP):
314: if (0 == n->nchild)
315: break;
1.41 kristaps 316: return(man_nmsg(m, n, MANDOCERR_ARGSLOST));
1.17 kristaps 317: default:
318: if (n->nchild)
319: break;
1.41 kristaps 320: return(man_nmsg(m, n, MANDOCERR_NOARGS));
1.17 kristaps 321: }
322:
323: return(1);
324: }
325:
326:
327: static int
328: check_bline(CHKARGS)
329: {
330:
1.22 kristaps 331: assert( ! (MAN_ELINE & m->flags));
1.41 kristaps 332: if (MAN_BLINE & m->flags) {
333: man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE);
334: return(0);
335: }
1.31 kristaps 336:
1.18 kristaps 337: return(1);
1.17 kristaps 338: }
339:
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to man_validate.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc