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