Annotation of src/usr.bin/mandoc/man_validate.c, Revision 1.22
1.22 ! schwarze 1: /* $Id: man_validate.c,v 1.21 2010/05/15 18:06:03 schwarze Exp $ */
1.1 kristaps 2: /*
1.2 schwarze 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
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>
25:
26: #include "libman.h"
1.5 schwarze 27: #include "libmandoc.h"
1.1 kristaps 28:
1.7 schwarze 29: #define CHKARGS struct man *m, const struct man_node *n
1.1 kristaps 30:
1.7 schwarze 31: typedef int (*v_check)(CHKARGS);
1.1 kristaps 32:
33: struct man_valid {
1.7 schwarze 34: v_check *pres;
35: v_check *posts;
1.1 kristaps 36: };
37:
1.7 schwarze 38: static int check_bline(CHKARGS);
39: static int check_eq0(CHKARGS);
1.10 schwarze 40: static int check_le1(CHKARGS);
1.7 schwarze 41: static int check_ge2(CHKARGS);
42: static int check_le5(CHKARGS);
43: static int check_par(CHKARGS);
1.8 schwarze 44: static int check_part(CHKARGS);
1.7 schwarze 45: static int check_root(CHKARGS);
46: static int check_sec(CHKARGS);
47: static int check_text(CHKARGS);
1.15 schwarze 48: static int check_title(CHKARGS);
1.7 schwarze 49:
50: static v_check posts_eq0[] = { check_eq0, NULL };
1.15 schwarze 51: static v_check posts_th[] = { check_ge2, check_le5, check_title, NULL };
1.7 schwarze 52: static v_check posts_par[] = { check_par, NULL };
1.8 schwarze 53: static v_check posts_part[] = { check_part, NULL };
1.7 schwarze 54: static v_check posts_sec[] = { check_sec, NULL };
1.13 schwarze 55: static v_check posts_le1[] = { check_le1, NULL };
1.7 schwarze 56: static v_check pres_bline[] = { check_bline, NULL };
1.1 kristaps 57:
58: static const struct man_valid man_valids[MAN_MAX] = {
1.12 schwarze 59: { NULL, posts_eq0 }, /* br */
1.15 schwarze 60: { pres_bline, posts_th }, /* TH */
1.7 schwarze 61: { pres_bline, posts_sec }, /* SH */
62: { pres_bline, posts_sec }, /* SS */
63: { pres_bline, posts_par }, /* TP */
64: { pres_bline, posts_par }, /* LP */
65: { pres_bline, posts_par }, /* PP */
66: { pres_bline, posts_par }, /* P */
67: { pres_bline, posts_par }, /* IP */
68: { pres_bline, posts_par }, /* HP */
1.8 schwarze 69: { NULL, NULL }, /* SM */
70: { NULL, NULL }, /* SB */
1.7 schwarze 71: { NULL, NULL }, /* BI */
72: { NULL, NULL }, /* IB */
73: { NULL, NULL }, /* BR */
74: { NULL, NULL }, /* RB */
1.8 schwarze 75: { NULL, NULL }, /* R */
76: { NULL, NULL }, /* B */
77: { NULL, NULL }, /* I */
1.7 schwarze 78: { NULL, NULL }, /* IR */
79: { NULL, NULL }, /* RI */
1.12 schwarze 80: { NULL, posts_eq0 }, /* na */
1.7 schwarze 81: { NULL, NULL }, /* i */
1.13 schwarze 82: { NULL, posts_le1 }, /* sp */
1.7 schwarze 83: { pres_bline, posts_eq0 }, /* nf */
84: { pres_bline, posts_eq0 }, /* fi */
85: { NULL, NULL }, /* r */
1.8 schwarze 86: { NULL, NULL }, /* RE */
87: { NULL, posts_part }, /* RS */
88: { NULL, NULL }, /* DT */
1.9 schwarze 89: { NULL, NULL }, /* UC */
1.11 schwarze 90: { NULL, NULL }, /* PD */
1.13 schwarze 91: { NULL, posts_le1 }, /* Sp */
92: { pres_bline, posts_le1 }, /* Vb */
93: { pres_bline, posts_eq0 }, /* Ve */
1.19 schwarze 94: { NULL, NULL }, /* if */
95: { NULL, NULL }, /* ie */
96: { NULL, NULL }, /* el */
1.1 kristaps 97: };
98:
99:
100: int
1.7 schwarze 101: man_valid_pre(struct man *m, const struct man_node *n)
102: {
103: v_check *cp;
104:
105: if (MAN_TEXT == n->type)
106: return(1);
107: if (MAN_ROOT == n->type)
108: return(1);
109:
110: if (NULL == (cp = man_valids[n->tok].pres))
111: return(1);
112: for ( ; *cp; cp++)
113: if ( ! (*cp)(m, n))
114: return(0);
115: return(1);
116: }
117:
118:
119: int
1.1 kristaps 120: man_valid_post(struct man *m)
121: {
1.7 schwarze 122: v_check *cp;
1.1 kristaps 123:
124: if (MAN_VALID & m->last->flags)
125: return(1);
126: m->last->flags |= MAN_VALID;
127:
128: switch (m->last->type) {
129: case (MAN_TEXT):
1.4 schwarze 130: return(check_text(m, m->last));
1.1 kristaps 131: case (MAN_ROOT):
1.4 schwarze 132: return(check_root(m, m->last));
1.1 kristaps 133: default:
134: break;
135: }
136:
137: if (NULL == (cp = man_valids[m->last->tok].posts))
138: return(1);
139: for ( ; *cp; cp++)
140: if ( ! (*cp)(m, m->last))
141: return(0);
142:
143: return(1);
144: }
145:
146:
1.4 schwarze 147: static int
1.7 schwarze 148: check_root(CHKARGS)
1.4 schwarze 149: {
1.7 schwarze 150:
151: if (MAN_BLINE & m->flags)
1.8 schwarze 152: return(man_nwarn(m, n, WEXITSCOPE));
1.7 schwarze 153: if (MAN_ELINE & m->flags)
1.8 schwarze 154: return(man_nwarn(m, n, WEXITSCOPE));
155:
156: m->flags &= ~MAN_BLINE;
157: m->flags &= ~MAN_ELINE;
1.7 schwarze 158:
1.4 schwarze 159: if (NULL == m->first->child)
160: return(man_nerr(m, n, WNODATA));
1.17 schwarze 161: if (NULL == m->meta.title) {
162: if ( ! man_nwarn(m, n, WNOTITLE))
163: return(0);
1.18 schwarze 164: /*
165: * If a title hasn't been set, do so now (by
166: * implication, date and section also aren't set).
167: *
168: * FIXME: this should be in man_action.c.
169: */
1.17 schwarze 170: m->meta.title = mandoc_strdup("unknown");
1.18 schwarze 171: m->meta.date = time(NULL);
1.21 schwarze 172: m->meta.msec = mandoc_strdup("1");
1.17 schwarze 173: }
1.15 schwarze 174:
175: return(1);
176: }
177:
178:
179: static int
180: check_title(CHKARGS)
181: {
182: const char *p;
183:
184: assert(n->child);
185: if ('\0' == *n->child->string)
186: return(man_nerr(m, n, WNOTITLE));
187:
188: for (p = n->child->string; '\0' != *p; p++)
189: if (isalpha((u_char)*p) && ! isupper((u_char)*p))
190: if ( ! man_nwarn(m, n, WTITLECASE))
191: return(0);
1.4 schwarze 192:
193: return(1);
194: }
195:
196:
197: static int
1.7 schwarze 198: check_text(CHKARGS)
1.4 schwarze 199: {
200: const char *p;
1.5 schwarze 201: int pos, c;
1.4 schwarze 202:
203: assert(n->string);
204:
205: for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {
1.5 schwarze 206: if ('\\' == *p) {
207: c = mandoc_special(p);
208: if (c) {
209: p += c - 1;
210: pos += c - 1;
211: continue;
212: }
213: if ( ! (MAN_IGN_ESCAPE & m->pflags))
214: return(man_perr(m, n->line, pos, WESCAPE));
215: if ( ! man_pwarn(m, n->line, pos, WESCAPE))
216: return(0);
217: continue;
218: }
219:
220: if ('\t' == *p || isprint((u_char)*p))
1.4 schwarze 221: continue;
222:
1.20 schwarze 223: return(man_pwarn(m, n->line, pos, WNPRINT));
1.4 schwarze 224: }
225:
226: return(1);
1.1 kristaps 227: }
228:
229:
230: #define INEQ_DEFINE(x, ineq, name) \
231: static int \
1.7 schwarze 232: check_##name(CHKARGS) \
1.1 kristaps 233: { \
1.4 schwarze 234: if (n->nchild ineq (x)) \
1.1 kristaps 235: return(1); \
236: return(man_verr(m, n->line, n->pos, \
237: "expected line arguments %s %d, have %d", \
1.4 schwarze 238: #ineq, (x), n->nchild)); \
1.1 kristaps 239: }
240:
241: INEQ_DEFINE(0, ==, eq0)
1.10 schwarze 242: INEQ_DEFINE(1, <=, le1)
1.1 kristaps 243: INEQ_DEFINE(2, >=, ge2)
244: INEQ_DEFINE(5, <=, le5)
1.7 schwarze 245:
246:
247: static int
248: check_sec(CHKARGS)
249: {
1.6 schwarze 250:
1.7 schwarze 251: if (MAN_BODY == n->type && 0 == n->nchild)
252: return(man_nwarn(m, n, WBODYARGS));
253: if (MAN_HEAD == n->type && 0 == n->nchild)
254: return(man_nerr(m, n, WHEADARGS));
1.6 schwarze 255: return(1);
256: }
1.7 schwarze 257:
258:
259: static int
1.8 schwarze 260: check_part(CHKARGS)
261: {
262:
263: if (MAN_BODY == n->type && 0 == n->nchild)
264: return(man_nwarn(m, n, WBODYARGS));
265: return(1);
266: }
267:
268:
269: static int
1.7 schwarze 270: check_par(CHKARGS)
271: {
272:
273: if (MAN_BODY == n->type)
274: switch (n->tok) {
275: case (MAN_IP):
276: /* FALLTHROUGH */
277: case (MAN_HP):
278: /* FALLTHROUGH */
279: case (MAN_TP):
280: /* Body-less lists are ok. */
281: break;
282: default:
283: if (n->nchild)
284: break;
285: return(man_nwarn(m, n, WBODYARGS));
286: }
287: if (MAN_HEAD == n->type)
288: switch (n->tok) {
289: case (MAN_PP):
290: /* FALLTHROUGH */
291: case (MAN_P):
292: /* FALLTHROUGH */
293: case (MAN_LP):
294: if (0 == n->nchild)
295: break;
296: return(man_nwarn(m, n, WNHEADARGS));
297: default:
298: if (n->nchild)
299: break;
300: return(man_nwarn(m, n, WHEADARGS));
301: }
302:
303: return(1);
304: }
305:
306:
307: static int
308: check_bline(CHKARGS)
309: {
310:
1.8 schwarze 311: assert( ! (MAN_ELINE & m->flags));
1.7 schwarze 312: if (MAN_BLINE & m->flags)
313: return(man_nerr(m, n, WLNSCOPE));
1.14 schwarze 314:
1.7 schwarze 315: return(1);
316: }
317:
![[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