Annotation of src/usr.bin/mandoc/man_validate.c, Revision 1.15
1.15 ! schwarze 1: /* $Id: man_validate.c,v 1.14 2010/03/26 01:22:05 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.14 schwarze 45: static int check_roff(CHKARGS);
1.7 schwarze 46: static int check_root(CHKARGS);
47: static int check_sec(CHKARGS);
48: static int check_text(CHKARGS);
1.15 ! schwarze 49: static int check_title(CHKARGS);
1.7 schwarze 50:
51: static v_check posts_eq0[] = { check_eq0, NULL };
1.15 ! schwarze 52: static v_check posts_th[] = { check_ge2, check_le5, check_title, NULL };
1.7 schwarze 53: static v_check posts_par[] = { check_par, NULL };
1.8 schwarze 54: static v_check posts_part[] = { check_part, NULL };
1.7 schwarze 55: static v_check posts_sec[] = { check_sec, NULL };
1.13 schwarze 56: static v_check posts_le1[] = { check_le1, NULL };
1.7 schwarze 57: static v_check pres_bline[] = { check_bline, NULL };
1.14 schwarze 58: static v_check pres_roff[] = { check_bline, check_roff, 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.12 schwarze 82: { NULL, posts_eq0 }, /* na */
1.7 schwarze 83: { NULL, NULL }, /* i */
1.13 schwarze 84: { NULL, posts_le1 }, /* sp */
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.13 schwarze 93: { NULL, posts_le1 }, /* Sp */
94: { pres_bline, posts_le1 }, /* Vb */
95: { pres_bline, posts_eq0 }, /* Ve */
1.14 schwarze 96: { pres_roff, NULL }, /* de */
97: { pres_roff, NULL }, /* dei */
98: { pres_roff, NULL }, /* am */
99: { pres_roff, NULL }, /* ami */
100: { pres_roff, NULL }, /* ig */
101: { NULL, NULL }, /* . */
1.1 kristaps 102: };
103:
104:
105: int
1.7 schwarze 106: man_valid_pre(struct man *m, const struct man_node *n)
107: {
108: v_check *cp;
109:
110: if (MAN_TEXT == n->type)
111: return(1);
112: if (MAN_ROOT == n->type)
113: return(1);
114:
115: if (NULL == (cp = man_valids[n->tok].pres))
116: return(1);
117: for ( ; *cp; cp++)
118: if ( ! (*cp)(m, n))
119: return(0);
120: return(1);
121: }
122:
123:
124: int
1.1 kristaps 125: man_valid_post(struct man *m)
126: {
1.7 schwarze 127: v_check *cp;
1.1 kristaps 128:
129: if (MAN_VALID & m->last->flags)
130: return(1);
131: m->last->flags |= MAN_VALID;
132:
133: switch (m->last->type) {
134: case (MAN_TEXT):
1.4 schwarze 135: return(check_text(m, m->last));
1.1 kristaps 136: case (MAN_ROOT):
1.4 schwarze 137: return(check_root(m, m->last));
1.1 kristaps 138: default:
139: break;
140: }
141:
142: if (NULL == (cp = man_valids[m->last->tok].posts))
143: return(1);
144: for ( ; *cp; cp++)
145: if ( ! (*cp)(m, m->last))
146: return(0);
147:
148: return(1);
149: }
150:
151:
1.4 schwarze 152: static int
1.7 schwarze 153: check_root(CHKARGS)
1.4 schwarze 154: {
1.7 schwarze 155:
156: if (MAN_BLINE & m->flags)
1.8 schwarze 157: return(man_nwarn(m, n, WEXITSCOPE));
1.7 schwarze 158: if (MAN_ELINE & m->flags)
1.8 schwarze 159: return(man_nwarn(m, n, WEXITSCOPE));
160:
161: m->flags &= ~MAN_BLINE;
162: m->flags &= ~MAN_ELINE;
1.7 schwarze 163:
1.4 schwarze 164: if (NULL == m->first->child)
165: return(man_nerr(m, n, WNODATA));
166: if (NULL == m->meta.title)
167: return(man_nerr(m, n, WNOTITLE));
1.15 ! schwarze 168:
! 169: return(1);
! 170: }
! 171:
! 172:
! 173: static int
! 174: check_title(CHKARGS)
! 175: {
! 176: const char *p;
! 177:
! 178: assert(n->child);
! 179: if ('\0' == *n->child->string)
! 180: return(man_nerr(m, n, WNOTITLE));
! 181:
! 182: for (p = n->child->string; '\0' != *p; p++)
! 183: if (isalpha((u_char)*p) && ! isupper((u_char)*p))
! 184: if ( ! man_nwarn(m, n, WTITLECASE))
! 185: return(0);
1.4 schwarze 186:
187: return(1);
188: }
189:
190:
191: static int
1.7 schwarze 192: check_text(CHKARGS)
1.4 schwarze 193: {
194: const char *p;
1.5 schwarze 195: int pos, c;
1.4 schwarze 196:
197: assert(n->string);
198:
199: for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {
1.5 schwarze 200: if ('\\' == *p) {
201: c = mandoc_special(p);
202: if (c) {
203: p += c - 1;
204: pos += c - 1;
205: continue;
206: }
207: if ( ! (MAN_IGN_ESCAPE & m->pflags))
208: return(man_perr(m, n->line, pos, WESCAPE));
209: if ( ! man_pwarn(m, n->line, pos, WESCAPE))
210: return(0);
211: continue;
212: }
213:
214: if ('\t' == *p || isprint((u_char)*p))
1.4 schwarze 215: continue;
216:
217: if (MAN_IGN_CHARS & m->pflags)
218: return(man_pwarn(m, n->line, pos, WNPRINT));
219: return(man_perr(m, n->line, pos, WNPRINT));
220: }
221:
222: return(1);
1.1 kristaps 223: }
224:
225:
226: #define INEQ_DEFINE(x, ineq, name) \
227: static int \
1.7 schwarze 228: check_##name(CHKARGS) \
1.1 kristaps 229: { \
1.4 schwarze 230: if (n->nchild ineq (x)) \
1.1 kristaps 231: return(1); \
232: return(man_verr(m, n->line, n->pos, \
233: "expected line arguments %s %d, have %d", \
1.4 schwarze 234: #ineq, (x), n->nchild)); \
1.1 kristaps 235: }
236:
237: INEQ_DEFINE(0, ==, eq0)
1.10 schwarze 238: INEQ_DEFINE(1, <=, le1)
1.1 kristaps 239: INEQ_DEFINE(2, >=, ge2)
240: INEQ_DEFINE(5, <=, le5)
1.7 schwarze 241:
242:
243: static int
244: check_sec(CHKARGS)
245: {
1.6 schwarze 246:
1.7 schwarze 247: if (MAN_BODY == n->type && 0 == n->nchild)
248: return(man_nwarn(m, n, WBODYARGS));
249: if (MAN_HEAD == n->type && 0 == n->nchild)
250: return(man_nerr(m, n, WHEADARGS));
1.6 schwarze 251: return(1);
252: }
1.7 schwarze 253:
254:
255: static int
1.8 schwarze 256: check_part(CHKARGS)
257: {
258:
259: if (MAN_BODY == n->type && 0 == n->nchild)
260: return(man_nwarn(m, n, WBODYARGS));
261: return(1);
262: }
263:
264:
265: static int
1.7 schwarze 266: check_par(CHKARGS)
267: {
268:
269: if (MAN_BODY == n->type)
270: switch (n->tok) {
271: case (MAN_IP):
272: /* FALLTHROUGH */
273: case (MAN_HP):
274: /* FALLTHROUGH */
275: case (MAN_TP):
276: /* Body-less lists are ok. */
277: break;
278: default:
279: if (n->nchild)
280: break;
281: return(man_nwarn(m, n, WBODYARGS));
282: }
283: if (MAN_HEAD == n->type)
284: switch (n->tok) {
285: case (MAN_PP):
286: /* FALLTHROUGH */
287: case (MAN_P):
288: /* FALLTHROUGH */
289: case (MAN_LP):
290: if (0 == n->nchild)
291: break;
292: return(man_nwarn(m, n, WNHEADARGS));
293: default:
294: if (n->nchild)
295: break;
296: return(man_nwarn(m, n, WHEADARGS));
297: }
298:
299: return(1);
300: }
301:
302:
303: static int
304: check_bline(CHKARGS)
305: {
306:
1.8 schwarze 307: assert( ! (MAN_ELINE & m->flags));
1.7 schwarze 308: if (MAN_BLINE & m->flags)
309: return(man_nerr(m, n, WLNSCOPE));
1.14 schwarze 310:
1.7 schwarze 311: return(1);
312: }
313:
1.14 schwarze 314:
315: static int
316: check_roff(CHKARGS)
317: {
318:
319: if (MAN_BLOCK != n->type)
320: return(1);
321:
322: for (n = n->parent; n; n = n->parent)
323: if (MAN_de == n->tok || MAN_dei == n->tok ||
324: MAN_am == n->tok ||
325: MAN_ami == n->tok ||
326: MAN_ig == n->tok)
327: return(man_nerr(m, n, WROFFNEST));
328:
329: return(1);
330: }
![[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