Annotation of src/usr.bin/mandoc/man_validate.c, Revision 1.52
1.52 ! schwarze 1: /* $Id: man_validate.c,v 1.51 2011/12/02 01:45:43 schwarze Exp $ */
1.1 kristaps 2: /*
1.38 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.32 schwarze 4: * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.2 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 17: */
18: #include <sys/types.h>
19:
20: #include <assert.h>
21: #include <ctype.h>
1.6 schwarze 22: #include <errno.h>
23: #include <limits.h>
1.1 kristaps 24: #include <stdarg.h>
25: #include <stdlib.h>
1.28 schwarze 26: #include <string.h>
1.36 schwarze 27: #include <time.h>
1.1 kristaps 28:
1.44 schwarze 29: #include "man.h"
1.25 schwarze 30: #include "mandoc.h"
1.1 kristaps 31: #include "libman.h"
1.5 schwarze 32: #include "libmandoc.h"
1.1 kristaps 33:
1.27 schwarze 34: #define CHKARGS struct man *m, struct man_node *n
1.1 kristaps 35:
1.7 schwarze 36: typedef int (*v_check)(CHKARGS);
1.1 kristaps 37:
38: struct man_valid {
1.7 schwarze 39: v_check *pres;
40: v_check *posts;
1.1 kristaps 41: };
42:
1.7 schwarze 43: static int check_eq0(CHKARGS);
1.52 ! schwarze 44: static int check_eq2(CHKARGS);
1.10 schwarze 45: static int check_le1(CHKARGS);
1.7 schwarze 46: static int check_ge2(CHKARGS);
47: static int check_le5(CHKARGS);
48: static int check_par(CHKARGS);
1.8 schwarze 49: static int check_part(CHKARGS);
1.7 schwarze 50: static int check_root(CHKARGS);
1.45 schwarze 51: static void check_text(CHKARGS);
1.7 schwarze 52:
1.34 schwarze 53: static int post_AT(CHKARGS);
1.46 schwarze 54: static int post_vs(CHKARGS);
1.34 schwarze 55: static int post_fi(CHKARGS);
1.47 schwarze 56: static int post_ft(CHKARGS);
1.34 schwarze 57: static int post_nf(CHKARGS);
1.47 schwarze 58: static int post_sec(CHKARGS);
1.34 schwarze 59: static int post_TH(CHKARGS);
60: static int post_UC(CHKARGS);
1.47 schwarze 61: static int pre_sec(CHKARGS);
1.34 schwarze 62:
63: static v_check posts_at[] = { post_AT, NULL };
1.46 schwarze 64: static v_check posts_br[] = { post_vs, check_eq0, NULL };
1.7 schwarze 65: static v_check posts_eq0[] = { check_eq0, NULL };
1.52 ! schwarze 66: static v_check posts_eq2[] = { check_eq2, NULL };
1.34 schwarze 67: static v_check posts_fi[] = { check_eq0, post_fi, NULL };
1.47 schwarze 68: static v_check posts_ft[] = { post_ft, NULL };
1.34 schwarze 69: static v_check posts_nf[] = { check_eq0, post_nf, NULL };
1.7 schwarze 70: static v_check posts_par[] = { check_par, NULL };
1.8 schwarze 71: static v_check posts_part[] = { check_part, NULL };
1.47 schwarze 72: static v_check posts_sec[] = { post_sec, NULL };
1.46 schwarze 73: static v_check posts_sp[] = { post_vs, check_le1, NULL };
1.40 schwarze 74: static v_check posts_th[] = { check_ge2, check_le5, post_TH, NULL };
1.34 schwarze 75: static v_check posts_uc[] = { post_UC, NULL };
1.50 schwarze 76: static v_check pres_sec[] = { pre_sec, NULL };
1.1 kristaps 77:
78: static const struct man_valid man_valids[MAN_MAX] = {
1.46 schwarze 79: { NULL, posts_br }, /* br */
1.50 schwarze 80: { NULL, posts_th }, /* TH */
1.47 schwarze 81: { pres_sec, posts_sec }, /* SH */
82: { pres_sec, posts_sec }, /* SS */
1.50 schwarze 83: { NULL, NULL }, /* TP */
84: { NULL, posts_par }, /* LP */
85: { NULL, posts_par }, /* PP */
86: { NULL, posts_par }, /* P */
87: { NULL, NULL }, /* IP */
88: { NULL, NULL }, /* HP */
1.8 schwarze 89: { NULL, NULL }, /* SM */
90: { NULL, NULL }, /* SB */
1.7 schwarze 91: { NULL, NULL }, /* BI */
92: { NULL, NULL }, /* IB */
93: { NULL, NULL }, /* BR */
94: { NULL, NULL }, /* RB */
1.8 schwarze 95: { NULL, NULL }, /* R */
96: { NULL, NULL }, /* B */
97: { NULL, NULL }, /* I */
1.7 schwarze 98: { NULL, NULL }, /* IR */
99: { NULL, NULL }, /* RI */
1.52 ! schwarze 100: { NULL, posts_eq0 }, /* na */
! 101: { NULL, posts_sp }, /* sp */
1.50 schwarze 102: { NULL, posts_nf }, /* nf */
103: { NULL, posts_fi }, /* fi */
1.8 schwarze 104: { NULL, NULL }, /* RE */
105: { NULL, posts_part }, /* RS */
106: { NULL, NULL }, /* DT */
1.34 schwarze 107: { NULL, posts_uc }, /* UC */
1.11 schwarze 108: { NULL, NULL }, /* PD */
1.34 schwarze 109: { NULL, posts_at }, /* AT */
1.28 schwarze 110: { NULL, NULL }, /* in */
1.32 schwarze 111: { NULL, posts_ft }, /* ft */
1.52 ! schwarze 112: { NULL, posts_eq2 }, /* OP */
1.1 kristaps 113: };
114:
115:
116: int
1.27 schwarze 117: man_valid_pre(struct man *m, struct man_node *n)
1.7 schwarze 118: {
119: v_check *cp;
120:
1.38 schwarze 121: switch (n->type) {
122: case (MAN_TEXT):
123: /* FALLTHROUGH */
124: case (MAN_ROOT):
125: /* FALLTHROUGH */
1.42 schwarze 126: case (MAN_EQN):
127: /* FALLTHROUGH */
1.38 schwarze 128: case (MAN_TBL):
1.7 schwarze 129: return(1);
1.38 schwarze 130: default:
131: break;
132: }
1.7 schwarze 133:
134: if (NULL == (cp = man_valids[n->tok].pres))
135: return(1);
136: for ( ; *cp; cp++)
137: if ( ! (*cp)(m, n))
138: return(0);
139: return(1);
140: }
141:
142:
143: int
1.1 kristaps 144: man_valid_post(struct man *m)
145: {
1.7 schwarze 146: v_check *cp;
1.1 kristaps 147:
148: if (MAN_VALID & m->last->flags)
149: return(1);
150: m->last->flags |= MAN_VALID;
151:
152: switch (m->last->type) {
153: case (MAN_TEXT):
1.45 schwarze 154: check_text(m, m->last);
155: return(1);
1.1 kristaps 156: case (MAN_ROOT):
1.4 schwarze 157: return(check_root(m, m->last));
1.42 schwarze 158: case (MAN_EQN):
159: /* FALLTHROUGH */
1.38 schwarze 160: case (MAN_TBL):
161: return(1);
1.1 kristaps 162: default:
163: break;
164: }
165:
166: if (NULL == (cp = man_valids[m->last->tok].posts))
167: return(1);
168: for ( ; *cp; cp++)
169: if ( ! (*cp)(m, m->last))
170: return(0);
171:
172: return(1);
173: }
174:
175:
1.4 schwarze 176: static int
1.7 schwarze 177: check_root(CHKARGS)
1.4 schwarze 178: {
1.7 schwarze 179:
180: if (MAN_BLINE & m->flags)
1.35 schwarze 181: man_nmsg(m, n, MANDOCERR_SCOPEEXIT);
182: else if (MAN_ELINE & m->flags)
183: man_nmsg(m, n, MANDOCERR_SCOPEEXIT);
1.8 schwarze 184:
185: m->flags &= ~MAN_BLINE;
186: m->flags &= ~MAN_ELINE;
1.7 schwarze 187:
1.25 schwarze 188: if (NULL == m->first->child) {
189: man_nmsg(m, n, MANDOCERR_NODOCBODY);
190: return(0);
191: } else if (NULL == m->meta.title) {
1.35 schwarze 192: man_nmsg(m, n, MANDOCERR_NOTITLE);
193:
1.18 schwarze 194: /*
195: * If a title hasn't been set, do so now (by
196: * implication, date and section also aren't set).
197: */
1.35 schwarze 198:
1.17 schwarze 199: m->meta.title = mandoc_strdup("unknown");
1.21 schwarze 200: m->meta.msec = mandoc_strdup("1");
1.44 schwarze 201: m->meta.date = mandoc_normdate
202: (m->parse, NULL, n->line, n->pos);
1.17 schwarze 203: }
1.15 schwarze 204:
205: return(1);
206: }
207:
1.45 schwarze 208: static void
1.47 schwarze 209: check_text(CHKARGS)
1.4 schwarze 210: {
1.47 schwarze 211: char *cp, *p;
212:
1.48 schwarze 213: if (MAN_LITERAL & m->flags)
214: return;
215:
216: cp = n->string;
217: for (p = cp; NULL != (p = strchr(p, '\t')); p++)
1.47 schwarze 218: man_pmsg(m, n->line, (int)(p - cp), MANDOCERR_BADTAB);
1.1 kristaps 219: }
220:
221: #define INEQ_DEFINE(x, ineq, name) \
222: static int \
1.7 schwarze 223: check_##name(CHKARGS) \
1.1 kristaps 224: { \
1.4 schwarze 225: if (n->nchild ineq (x)) \
1.1 kristaps 226: return(1); \
1.44 schwarze 227: mandoc_vmsg(MANDOCERR_ARGCOUNT, m->parse, n->line, n->pos, \
1.25 schwarze 228: "line arguments %s %d (have %d)", \
229: #ineq, (x), n->nchild); \
1.40 schwarze 230: return(1); \
1.1 kristaps 231: }
232:
233: INEQ_DEFINE(0, ==, eq0)
1.52 ! schwarze 234: INEQ_DEFINE(2, ==, eq2)
1.10 schwarze 235: INEQ_DEFINE(1, <=, le1)
1.1 kristaps 236: INEQ_DEFINE(2, >=, ge2)
237: INEQ_DEFINE(5, <=, le5)
1.32 schwarze 238:
239: static int
1.47 schwarze 240: post_ft(CHKARGS)
1.32 schwarze 241: {
242: char *cp;
243: int ok;
244:
245: if (0 == n->nchild)
246: return(1);
247:
248: ok = 0;
249: cp = n->child->string;
250: switch (*cp) {
251: case ('1'):
252: /* FALLTHROUGH */
253: case ('2'):
254: /* FALLTHROUGH */
255: case ('3'):
256: /* FALLTHROUGH */
257: case ('4'):
258: /* FALLTHROUGH */
259: case ('I'):
260: /* FALLTHROUGH */
261: case ('P'):
262: /* FALLTHROUGH */
263: case ('R'):
264: if ('\0' == cp[1])
265: ok = 1;
266: break;
267: case ('B'):
268: if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2]))
269: ok = 1;
270: break;
271: case ('C'):
272: if ('W' == cp[1] && '\0' == cp[2])
273: ok = 1;
274: break;
275: default:
276: break;
277: }
278:
279: if (0 == ok) {
1.44 schwarze 280: mandoc_vmsg
281: (MANDOCERR_BADFONT, m->parse,
282: n->line, n->pos, "%s", cp);
1.32 schwarze 283: *cp = '\0';
284: }
285:
286: if (1 < n->nchild)
1.44 schwarze 287: mandoc_vmsg
288: (MANDOCERR_ARGCOUNT, m->parse, n->line,
289: n->pos, "want one child (have %d)",
290: n->nchild);
1.32 schwarze 291:
292: return(1);
293: }
1.7 schwarze 294:
295: static int
1.47 schwarze 296: pre_sec(CHKARGS)
297: {
298:
299: if (MAN_BLOCK == n->type)
300: m->flags &= ~MAN_LITERAL;
301: return(1);
302: }
303:
304: static int
305: post_sec(CHKARGS)
1.7 schwarze 306: {
1.6 schwarze 307:
1.44 schwarze 308: if ( ! (MAN_HEAD == n->type && 0 == n->nchild))
309: return(1);
1.25 schwarze 310:
1.44 schwarze 311: man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
312: return(0);
1.6 schwarze 313: }
1.7 schwarze 314:
315: static int
1.8 schwarze 316: check_part(CHKARGS)
317: {
318:
319: if (MAN_BODY == n->type && 0 == n->nchild)
1.44 schwarze 320: mandoc_msg(MANDOCERR_ARGCWARN, m->parse, n->line,
321: n->pos, "want children (have none)");
1.35 schwarze 322:
1.8 schwarze 323: return(1);
324: }
325:
1.36 schwarze 326:
327: static int
328: check_par(CHKARGS)
329: {
330:
1.39 schwarze 331: switch (n->type) {
332: case (MAN_BLOCK):
333: if (0 == n->body->nchild)
334: man_node_delete(m, n);
335: break;
336: case (MAN_BODY):
337: if (0 == n->nchild)
338: man_nmsg(m, n, MANDOCERR_IGNPAR);
339: break;
340: case (MAN_HEAD):
341: if (n->nchild)
342: man_nmsg(m, n, MANDOCERR_ARGSLOST);
343: break;
344: default:
345: break;
346: }
1.36 schwarze 347:
348: return(1);
349: }
350:
351:
1.34 schwarze 352: static int
353: post_TH(CHKARGS)
354: {
1.40 schwarze 355: const char *p;
1.41 schwarze 356: int line, pos;
1.34 schwarze 357:
358: if (m->meta.title)
359: free(m->meta.title);
360: if (m->meta.vol)
361: free(m->meta.vol);
362: if (m->meta.source)
363: free(m->meta.source);
364: if (m->meta.msec)
365: free(m->meta.msec);
1.41 schwarze 366: if (m->meta.date)
367: free(m->meta.date);
1.34 schwarze 368:
1.41 schwarze 369: line = n->line;
370: pos = n->pos;
371: m->meta.title = m->meta.vol = m->meta.date =
1.34 schwarze 372: m->meta.msec = m->meta.source = NULL;
373:
374: /* ->TITLE<- MSEC DATE SOURCE VOL */
375:
376: n = n->child;
1.40 schwarze 377: if (n && n->string) {
378: for (p = n->string; '\0' != *p; p++) {
379: /* Only warn about this once... */
1.47 schwarze 380: if (isalpha((unsigned char)*p) &&
381: ! isupper((unsigned char)*p)) {
1.40 schwarze 382: man_nmsg(m, n, MANDOCERR_UPPERCASE);
383: break;
384: }
385: }
386: m->meta.title = mandoc_strdup(n->string);
387: } else
388: m->meta.title = mandoc_strdup("");
1.34 schwarze 389:
390: /* TITLE ->MSEC<- DATE SOURCE VOL */
391:
1.40 schwarze 392: if (n)
393: n = n->next;
394: if (n && n->string)
395: m->meta.msec = mandoc_strdup(n->string);
396: else
397: m->meta.msec = mandoc_strdup("");
1.34 schwarze 398:
399: /* TITLE MSEC ->DATE<- SOURCE VOL */
400:
1.40 schwarze 401: if (n)
402: n = n->next;
1.49 schwarze 403: if (n && n->string && '\0' != n->string[0]) {
1.41 schwarze 404: pos = n->pos;
1.49 schwarze 405: m->meta.date = mandoc_normdate
406: (m->parse, n->string, line, pos);
407: } else
408: m->meta.date = mandoc_strdup("");
1.34 schwarze 409:
410: /* TITLE MSEC DATE ->SOURCE<- VOL */
411:
412: if (n && (n = n->next))
413: m->meta.source = mandoc_strdup(n->string);
414:
415: /* TITLE MSEC DATE SOURCE ->VOL<- */
1.51 schwarze 416: /* If missing, use the default VOL name for MSEC. */
1.34 schwarze 417:
418: if (n && (n = n->next))
419: m->meta.vol = mandoc_strdup(n->string);
1.51 schwarze 420: else if ('\0' != m->meta.msec[0] &&
421: (NULL != (p = mandoc_a2msec(m->meta.msec))))
422: m->meta.vol = mandoc_strdup(p);
1.34 schwarze 423:
424: /*
425: * Remove the `TH' node after we've processed it for our
426: * meta-data.
427: */
428: man_node_delete(m, m->last);
429: return(1);
430: }
431:
432: static int
433: post_nf(CHKARGS)
434: {
435:
436: if (MAN_LITERAL & m->flags)
437: man_nmsg(m, n, MANDOCERR_SCOPEREP);
438:
439: m->flags |= MAN_LITERAL;
440: return(1);
441: }
442:
443: static int
444: post_fi(CHKARGS)
445: {
446:
447: if ( ! (MAN_LITERAL & m->flags))
1.39 schwarze 448: man_nmsg(m, n, MANDOCERR_WNOSCOPE);
1.34 schwarze 449:
450: m->flags &= ~MAN_LITERAL;
451: return(1);
452: }
453:
454: static int
455: post_UC(CHKARGS)
456: {
457: static const char * const bsd_versions[] = {
458: "3rd Berkeley Distribution",
459: "4th Berkeley Distribution",
460: "4.2 Berkeley Distribution",
461: "4.3 Berkeley Distribution",
462: "4.4 Berkeley Distribution",
463: };
464:
465: const char *p, *s;
466:
467: n = n->child;
468:
469: if (NULL == n || MAN_TEXT != n->type)
470: p = bsd_versions[0];
471: else {
472: s = n->string;
473: if (0 == strcmp(s, "3"))
474: p = bsd_versions[0];
475: else if (0 == strcmp(s, "4"))
476: p = bsd_versions[1];
477: else if (0 == strcmp(s, "5"))
478: p = bsd_versions[2];
479: else if (0 == strcmp(s, "6"))
480: p = bsd_versions[3];
481: else if (0 == strcmp(s, "7"))
482: p = bsd_versions[4];
483: else
484: p = bsd_versions[0];
485: }
486:
487: if (m->meta.source)
488: free(m->meta.source);
489:
490: m->meta.source = mandoc_strdup(p);
491: return(1);
492: }
493:
494: static int
495: post_AT(CHKARGS)
496: {
497: static const char * const unix_versions[] = {
498: "7th Edition",
499: "System III",
500: "System V",
501: "System V Release 2",
502: };
503:
504: const char *p, *s;
505: struct man_node *nn;
506:
507: n = n->child;
508:
509: if (NULL == n || MAN_TEXT != n->type)
510: p = unix_versions[0];
511: else {
512: s = n->string;
513: if (0 == strcmp(s, "3"))
514: p = unix_versions[0];
515: else if (0 == strcmp(s, "4"))
516: p = unix_versions[1];
517: else if (0 == strcmp(s, "5")) {
518: nn = n->next;
519: if (nn && MAN_TEXT == nn->type && nn->string[0])
520: p = unix_versions[3];
521: else
522: p = unix_versions[2];
523: } else
524: p = unix_versions[0];
525: }
526:
527: if (m->meta.source)
528: free(m->meta.source);
529:
530: m->meta.source = mandoc_strdup(p);
1.46 schwarze 531: return(1);
532: }
533:
534: static int
535: post_vs(CHKARGS)
536: {
537:
538: /*
539: * Don't warn about this because it occurs in pod2man and would
540: * cause considerable (unfixable) warnage.
541: */
542: if (NULL == n->prev && MAN_ROOT == n->parent->type)
543: man_node_delete(m, n);
544:
1.34 schwarze 545: return(1);
546: }
![[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