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