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