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