Annotation of src/usr.bin/mandoc/man_validate.c, Revision 1.42
1.42 ! schwarze 1: /* $Id: man_validate.c,v 1.41 2011/03/07 01:35:33 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 */
1.42 ! schwarze 121: case (MAN_EQN):
! 122: /* FALLTHROUGH */
1.38 schwarze 123: case (MAN_TBL):
1.7 schwarze 124: return(1);
1.38 schwarze 125: default:
126: break;
127: }
1.7 schwarze 128:
129: if (NULL == (cp = man_valids[n->tok].pres))
130: return(1);
131: for ( ; *cp; cp++)
132: if ( ! (*cp)(m, n))
133: return(0);
134: return(1);
135: }
136:
137:
138: int
1.1 kristaps 139: man_valid_post(struct man *m)
140: {
1.7 schwarze 141: v_check *cp;
1.1 kristaps 142:
143: if (MAN_VALID & m->last->flags)
144: return(1);
145: m->last->flags |= MAN_VALID;
146:
147: switch (m->last->type) {
148: case (MAN_TEXT):
1.4 schwarze 149: return(check_text(m, m->last));
1.1 kristaps 150: case (MAN_ROOT):
1.4 schwarze 151: return(check_root(m, m->last));
1.42 ! schwarze 152: case (MAN_EQN):
! 153: /* FALLTHROUGH */
1.38 schwarze 154: case (MAN_TBL):
155: return(1);
1.1 kristaps 156: default:
157: break;
158: }
159:
160: if (NULL == (cp = man_valids[m->last->tok].posts))
161: return(1);
162: for ( ; *cp; cp++)
163: if ( ! (*cp)(m, m->last))
164: return(0);
165:
166: return(1);
167: }
168:
169:
1.4 schwarze 170: static int
1.7 schwarze 171: check_root(CHKARGS)
1.4 schwarze 172: {
1.7 schwarze 173:
174: if (MAN_BLINE & m->flags)
1.35 schwarze 175: man_nmsg(m, n, MANDOCERR_SCOPEEXIT);
176: else if (MAN_ELINE & m->flags)
177: man_nmsg(m, n, MANDOCERR_SCOPEEXIT);
1.8 schwarze 178:
179: m->flags &= ~MAN_BLINE;
180: m->flags &= ~MAN_ELINE;
1.7 schwarze 181:
1.25 schwarze 182: if (NULL == m->first->child) {
183: man_nmsg(m, n, MANDOCERR_NODOCBODY);
184: return(0);
185: } else if (NULL == m->meta.title) {
1.35 schwarze 186: man_nmsg(m, n, MANDOCERR_NOTITLE);
187:
1.18 schwarze 188: /*
189: * If a title hasn't been set, do so now (by
190: * implication, date and section also aren't set).
191: */
1.35 schwarze 192:
1.17 schwarze 193: m->meta.title = mandoc_strdup("unknown");
1.21 schwarze 194: m->meta.msec = mandoc_strdup("1");
1.41 schwarze 195: m->meta.date = mandoc_normdate(NULL,
196: m->msg, m->data, n->line, n->pos);
1.17 schwarze 197: }
1.15 schwarze 198:
199: return(1);
200: }
201:
202:
203: static int
1.7 schwarze 204: check_text(CHKARGS)
1.4 schwarze 205: {
1.27 schwarze 206: char *p;
1.5 schwarze 207: int pos, c;
1.28 schwarze 208: size_t sz;
1.4 schwarze 209:
1.28 schwarze 210: for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {
211: sz = strcspn(p, "\t\\");
212: p += (int)sz;
213:
214: if ('\0' == *p)
215: break;
216:
217: pos += (int)sz;
1.4 schwarze 218:
1.28 schwarze 219: if ('\t' == *p) {
220: if (MAN_LITERAL & m->flags)
221: continue;
222: if (man_pmsg(m, n->line, pos, MANDOCERR_BADTAB))
1.5 schwarze 223: continue;
1.28 schwarze 224: return(0);
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.40 schwarze 247: man_vmsg(m, MANDOCERR_ARGCOUNT, 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.36 schwarze 299: man_vmsg(m, MANDOCERR_BADFONT,
300: n->line, n->pos, "%s", cp);
1.32 schwarze 301: *cp = '\0';
302: }
303:
304: if (1 < n->nchild)
305: man_vmsg(m, MANDOCERR_ARGCOUNT, n->line, n->pos,
1.36 schwarze 306: "want one child (have %d)", n->nchild);
1.32 schwarze 307:
308: return(1);
309: }
1.7 schwarze 310:
311: static int
312: check_sec(CHKARGS)
313: {
1.6 schwarze 314:
1.25 schwarze 315: if (MAN_HEAD == n->type && 0 == n->nchild) {
316: man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
317: return(0);
318: } else if (MAN_BODY == n->type && 0 == n->nchild)
1.35 schwarze 319: man_nmsg(m, n, MANDOCERR_NOBODY);
1.25 schwarze 320:
1.6 schwarze 321: return(1);
322: }
1.7 schwarze 323:
324:
325: static int
1.8 schwarze 326: check_part(CHKARGS)
327: {
328:
329: if (MAN_BODY == n->type && 0 == n->nchild)
1.35 schwarze 330: man_nmsg(m, n, MANDOCERR_NOBODY);
331:
1.8 schwarze 332: return(1);
333: }
334:
1.36 schwarze 335:
336: static int
337: check_par(CHKARGS)
338: {
339:
1.39 schwarze 340: switch (n->type) {
341: case (MAN_BLOCK):
342: if (0 == n->body->nchild)
343: man_node_delete(m, n);
344: break;
345: case (MAN_BODY):
346: if (0 == n->nchild)
347: man_nmsg(m, n, MANDOCERR_IGNPAR);
348: break;
349: case (MAN_HEAD):
350: if (n->nchild)
351: man_nmsg(m, n, MANDOCERR_ARGSLOST);
352: break;
353: default:
354: break;
355: }
1.36 schwarze 356:
357: return(1);
358: }
359:
360:
361: static int
362: check_bline(CHKARGS)
363: {
364:
365: assert( ! (MAN_ELINE & m->flags));
366: if (MAN_BLINE & m->flags) {
367: man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE);
368: return(0);
369: }
370:
371: return(1);
372: }
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... */
402: if (isalpha((u_char)*p) && ! isupper((u_char)*p)) {
403: man_nmsg(m, n, MANDOCERR_UPPERCASE);
404: break;
405: }
406: }
407: m->meta.title = mandoc_strdup(n->string);
408: } else
409: m->meta.title = mandoc_strdup("");
1.34 schwarze 410:
411: /* TITLE ->MSEC<- DATE SOURCE VOL */
412:
1.40 schwarze 413: if (n)
414: n = n->next;
415: if (n && n->string)
416: m->meta.msec = mandoc_strdup(n->string);
417: else
418: m->meta.msec = mandoc_strdup("");
1.34 schwarze 419:
420: /* TITLE MSEC ->DATE<- SOURCE VOL */
421:
1.40 schwarze 422: if (n)
423: n = n->next;
1.41 schwarze 424: if (n)
425: pos = n->pos;
426: m->meta.date = mandoc_normdate(n ? n->string : NULL,
427: m->msg, m->data, line, pos);
1.34 schwarze 428:
429: /* TITLE MSEC DATE ->SOURCE<- VOL */
430:
431: if (n && (n = n->next))
432: m->meta.source = mandoc_strdup(n->string);
433:
434: /* TITLE MSEC DATE SOURCE ->VOL<- */
435:
436: if (n && (n = n->next))
437: m->meta.vol = mandoc_strdup(n->string);
438:
439: /*
440: * Remove the `TH' node after we've processed it for our
441: * meta-data.
442: */
443: man_node_delete(m, m->last);
444: return(1);
445: }
446:
447: static int
448: post_nf(CHKARGS)
449: {
450:
451: if (MAN_LITERAL & m->flags)
452: man_nmsg(m, n, MANDOCERR_SCOPEREP);
453:
454: m->flags |= MAN_LITERAL;
455: return(1);
456: }
457:
458: static int
459: post_fi(CHKARGS)
460: {
461:
462: if ( ! (MAN_LITERAL & m->flags))
1.39 schwarze 463: man_nmsg(m, n, MANDOCERR_WNOSCOPE);
1.34 schwarze 464:
465: m->flags &= ~MAN_LITERAL;
466: return(1);
467: }
468:
469: static int
470: post_UC(CHKARGS)
471: {
472: static const char * const bsd_versions[] = {
473: "3rd Berkeley Distribution",
474: "4th Berkeley Distribution",
475: "4.2 Berkeley Distribution",
476: "4.3 Berkeley Distribution",
477: "4.4 Berkeley Distribution",
478: };
479:
480: const char *p, *s;
481:
482: n = n->child;
483: n = m->last->child;
484:
485: if (NULL == n || MAN_TEXT != n->type)
486: p = bsd_versions[0];
487: else {
488: s = n->string;
489: if (0 == strcmp(s, "3"))
490: p = bsd_versions[0];
491: else if (0 == strcmp(s, "4"))
492: p = bsd_versions[1];
493: else if (0 == strcmp(s, "5"))
494: p = bsd_versions[2];
495: else if (0 == strcmp(s, "6"))
496: p = bsd_versions[3];
497: else if (0 == strcmp(s, "7"))
498: p = bsd_versions[4];
499: else
500: p = bsd_versions[0];
501: }
502:
503: if (m->meta.source)
504: free(m->meta.source);
505:
506: m->meta.source = mandoc_strdup(p);
507: return(1);
508: }
509:
510: static int
511: post_AT(CHKARGS)
512: {
513: static const char * const unix_versions[] = {
514: "7th Edition",
515: "System III",
516: "System V",
517: "System V Release 2",
518: };
519:
520: const char *p, *s;
521: struct man_node *nn;
522:
523: n = n->child;
524:
525: if (NULL == n || MAN_TEXT != n->type)
526: p = unix_versions[0];
527: else {
528: s = n->string;
529: if (0 == strcmp(s, "3"))
530: p = unix_versions[0];
531: else if (0 == strcmp(s, "4"))
532: p = unix_versions[1];
533: else if (0 == strcmp(s, "5")) {
534: nn = n->next;
535: if (nn && MAN_TEXT == nn->type && nn->string[0])
536: p = unix_versions[3];
537: else
538: p = unix_versions[2];
539: } else
540: p = unix_versions[0];
541: }
542:
543: if (m->meta.source)
544: free(m->meta.source);
545:
546: m->meta.source = mandoc_strdup(p);
547: return(1);
548: }
![[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