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