Annotation of mandoc/man_validate.c, Revision 1.110
1.107 schwarze 1: /* $OpenBSD$ */
1.1 kristaps 2: /*
1.63 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.88 schwarze 4: * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.8 kristaps 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.8 kristaps 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: */
1.28 kristaps 18: #include "config.h"
19:
1.1 kristaps 20: #include <sys/types.h>
21:
22: #include <assert.h>
23: #include <ctype.h>
1.16 kristaps 24: #include <errno.h>
25: #include <limits.h>
1.1 kristaps 26: #include <stdarg.h>
27: #include <stdlib.h>
1.46 kristaps 28: #include <string.h>
1.50 kristaps 29: #include <time.h>
1.1 kristaps 30:
1.66 kristaps 31: #include "man.h"
1.41 kristaps 32: #include "mandoc.h"
1.89 schwarze 33: #include "mandoc_aux.h"
1.1 kristaps 34: #include "libman.h"
1.15 kristaps 35: #include "libmandoc.h"
1.1 kristaps 36:
1.85 schwarze 37: #define CHKARGS struct man *man, struct man_node *n
1.1 kristaps 38:
1.107 schwarze 39: typedef void (*v_check)(CHKARGS);
1.1 kristaps 40:
1.107 schwarze 41: static void check_eq0(CHKARGS);
42: static void check_eq2(CHKARGS);
43: static void check_le1(CHKARGS);
44: static void check_le5(CHKARGS);
45: static void check_par(CHKARGS);
46: static void check_part(CHKARGS);
47: static void check_root(CHKARGS);
48: static void check_text(CHKARGS);
49:
50: static void post_AT(CHKARGS);
51: static void post_IP(CHKARGS);
52: static void post_vs(CHKARGS);
53: static void post_fi(CHKARGS);
54: static void post_ft(CHKARGS);
55: static void post_nf(CHKARGS);
56: static void post_TH(CHKARGS);
57: static void post_UC(CHKARGS);
58: static void post_UR(CHKARGS);
1.51 kristaps 59:
1.104 schwarze 60: static v_check man_valids[MAN_MAX] = {
61: post_vs, /* br */
62: post_TH, /* TH */
63: NULL, /* SH */
64: NULL, /* SS */
65: NULL, /* TP */
66: check_par, /* LP */
67: check_par, /* PP */
68: check_par, /* P */
69: post_IP, /* IP */
70: NULL, /* HP */
71: NULL, /* SM */
72: NULL, /* SB */
73: NULL, /* BI */
74: NULL, /* IB */
75: NULL, /* BR */
76: NULL, /* RB */
77: NULL, /* R */
78: NULL, /* B */
79: NULL, /* I */
80: NULL, /* IR */
81: NULL, /* RI */
82: post_vs, /* sp */
83: post_nf, /* nf */
84: post_fi, /* fi */
85: NULL, /* RE */
86: check_part, /* RS */
87: NULL, /* DT */
88: post_UC, /* UC */
89: check_le1, /* PD */
90: post_AT, /* AT */
91: NULL, /* in */
92: post_ft, /* ft */
93: check_eq2, /* OP */
94: post_nf, /* EX */
95: post_fi, /* EE */
96: post_UR, /* UR */
97: NULL, /* UE */
98: NULL, /* ll */
1.1 kristaps 99: };
100:
101:
1.107 schwarze 102: void
1.85 schwarze 103: man_valid_post(struct man *man)
1.1 kristaps 104: {
1.104 schwarze 105: struct man_node *n;
1.17 kristaps 106: v_check *cp;
1.1 kristaps 107:
1.104 schwarze 108: n = man->last;
109: if (n->flags & MAN_VALID)
1.107 schwarze 110: return;
1.104 schwarze 111: n->flags |= MAN_VALID;
1.1 kristaps 112:
1.104 schwarze 113: switch (n->type) {
1.91 schwarze 114: case MAN_TEXT:
1.107 schwarze 115: check_text(man, n);
116: break;
1.91 schwarze 117: case MAN_ROOT:
1.107 schwarze 118: check_root(man, n);
119: break;
1.91 schwarze 120: case MAN_EQN:
1.62 kristaps 121: /* FALLTHROUGH */
1.91 schwarze 122: case MAN_TBL:
1.107 schwarze 123: break;
1.1 kristaps 124: default:
1.104 schwarze 125: cp = man_valids + n->tok;
1.107 schwarze 126: if (*cp)
127: (*cp)(man, n);
128: break;
1.1 kristaps 129: }
130: }
131:
1.107 schwarze 132: static void
1.91 schwarze 133: check_root(CHKARGS)
1.14 kristaps 134: {
1.17 kristaps 135:
1.101 schwarze 136: assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
1.17 kristaps 137:
1.93 schwarze 138: if (NULL == man->first->child)
1.103 schwarze 139: mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,
140: n->line, n->pos, NULL);
1.93 schwarze 141: else
142: man->meta.hasbody = 1;
143:
144: if (NULL == man->meta.title) {
1.105 schwarze 145: mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
1.103 schwarze 146: n->line, n->pos, NULL);
1.54 kristaps 147:
1.34 kristaps 148: /*
149: * If a title hasn't been set, do so now (by
150: * implication, date and section also aren't set).
151: */
1.54 kristaps 152:
1.105 schwarze 153: man->meta.title = mandoc_strdup("");
154: man->meta.msec = mandoc_strdup("");
1.88 schwarze 155: man->meta.date = man->quick ? mandoc_strdup("") :
156: mandoc_normdate(man->parse, NULL, n->line, n->pos);
1.34 kristaps 157: }
1.75 kristaps 158: }
159:
1.107 schwarze 160: static void
1.75 kristaps 161: check_text(CHKARGS)
162: {
163: char *cp, *p;
164:
1.85 schwarze 165: if (MAN_LITERAL & man->flags)
1.107 schwarze 166: return;
1.76 schwarze 167:
168: cp = n->string;
169: for (p = cp; NULL != (p = strchr(p, '\t')); p++)
1.99 schwarze 170: mandoc_msg(MANDOCERR_FI_TAB, man->parse,
171: n->line, n->pos + (p - cp), NULL);
1.1 kristaps 172: }
173:
174: #define INEQ_DEFINE(x, ineq, name) \
1.107 schwarze 175: static void \
1.17 kristaps 176: check_##name(CHKARGS) \
1.1 kristaps 177: { \
1.11 kristaps 178: if (n->nchild ineq (x)) \
1.107 schwarze 179: return; \
1.85 schwarze 180: mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \
1.91 schwarze 181: "line arguments %s %d (have %d)", \
182: #ineq, (x), n->nchild); \
1.1 kristaps 183: }
184:
185: INEQ_DEFINE(0, ==, eq0)
1.80 kristaps 186: INEQ_DEFINE(2, ==, eq2)
1.25 kristaps 187: INEQ_DEFINE(1, <=, le1)
1.1 kristaps 188: INEQ_DEFINE(5, <=, le5)
1.86 schwarze 189:
1.107 schwarze 190: static void
1.104 schwarze 191: post_UR(CHKARGS)
1.86 schwarze 192: {
193:
194: if (MAN_HEAD == n->type && 1 != n->nchild)
195: mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line,
196: n->pos, "line arguments eq 1 (have %d)", n->nchild);
1.107 schwarze 197: check_part(man, n);
1.86 schwarze 198: }
1.1 kristaps 199:
1.107 schwarze 200: static void
1.73 kristaps 201: post_ft(CHKARGS)
1.55 kristaps 202: {
203: char *cp;
204: int ok;
205:
206: if (0 == n->nchild)
1.107 schwarze 207: return;
1.55 kristaps 208:
209: ok = 0;
210: cp = n->child->string;
211: switch (*cp) {
1.91 schwarze 212: case '1':
1.55 kristaps 213: /* FALLTHROUGH */
1.91 schwarze 214: case '2':
1.55 kristaps 215: /* FALLTHROUGH */
1.91 schwarze 216: case '3':
1.55 kristaps 217: /* FALLTHROUGH */
1.91 schwarze 218: case '4':
1.55 kristaps 219: /* FALLTHROUGH */
1.91 schwarze 220: case 'I':
1.55 kristaps 221: /* FALLTHROUGH */
1.91 schwarze 222: case 'P':
1.55 kristaps 223: /* FALLTHROUGH */
1.91 schwarze 224: case 'R':
1.55 kristaps 225: if ('\0' == cp[1])
226: ok = 1;
227: break;
1.91 schwarze 228: case 'B':
1.55 kristaps 229: if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2]))
230: ok = 1;
231: break;
1.91 schwarze 232: case 'C':
1.55 kristaps 233: if ('W' == cp[1] && '\0' == cp[2])
234: ok = 1;
235: break;
236: default:
237: break;
238: }
239:
240: if (0 == ok) {
1.98 schwarze 241: mandoc_vmsg(MANDOCERR_FT_BAD, man->parse,
242: n->line, n->pos, "ft %s", cp);
1.55 kristaps 243: *cp = '\0';
244: }
245:
246: if (1 < n->nchild)
1.91 schwarze 247: mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line,
248: n->pos, "want one child (have %d)", n->nchild);
1.55 kristaps 249: }
1.16 kristaps 250:
1.107 schwarze 251: static void
1.23 kristaps 252: check_part(CHKARGS)
253: {
254:
1.110 ! schwarze 255: if (n->type == MAN_BODY && n->child == NULL)
! 256: mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse,
! 257: n->line, n->pos, man_macronames[n->tok]);
1.23 kristaps 258: }
259:
1.107 schwarze 260: static void
1.17 kristaps 261: check_par(CHKARGS)
262: {
263:
1.59 kristaps 264: switch (n->type) {
1.91 schwarze 265: case MAN_BLOCK:
1.59 kristaps 266: if (0 == n->body->nchild)
1.85 schwarze 267: man_node_delete(man, n);
1.59 kristaps 268: break;
1.91 schwarze 269: case MAN_BODY:
1.59 kristaps 270: if (0 == n->nchild)
1.95 schwarze 271: mandoc_vmsg(MANDOCERR_PAR_SKIP,
272: man->parse, n->line, n->pos,
273: "%s empty", man_macronames[n->tok]);
1.59 kristaps 274: break;
1.91 schwarze 275: case MAN_HEAD:
1.59 kristaps 276: if (n->nchild)
1.97 schwarze 277: mandoc_vmsg(MANDOCERR_ARG_SKIP,
278: man->parse, n->line, n->pos,
279: "%s %s%s", man_macronames[n->tok],
280: n->child->string,
281: n->nchild > 1 ? " ..." : "");
1.59 kristaps 282: break;
283: default:
284: break;
285: }
1.17 kristaps 286: }
287:
1.107 schwarze 288: static void
1.83 schwarze 289: post_IP(CHKARGS)
290: {
291:
292: switch (n->type) {
1.91 schwarze 293: case MAN_BLOCK:
1.83 schwarze 294: if (0 == n->head->nchild && 0 == n->body->nchild)
1.85 schwarze 295: man_node_delete(man, n);
1.83 schwarze 296: break;
1.91 schwarze 297: case MAN_BODY:
1.83 schwarze 298: if (0 == n->parent->head->nchild && 0 == n->nchild)
1.95 schwarze 299: mandoc_vmsg(MANDOCERR_PAR_SKIP,
300: man->parse, n->line, n->pos,
301: "%s empty", man_macronames[n->tok]);
1.83 schwarze 302: break;
303: default:
304: break;
305: }
306: }
1.17 kristaps 307:
1.107 schwarze 308: static void
1.51 kristaps 309: post_TH(CHKARGS)
310: {
1.92 schwarze 311: struct man_node *nb;
1.60 schwarze 312: const char *p;
1.51 kristaps 313:
1.104 schwarze 314: check_le5(man, n);
315:
1.85 schwarze 316: free(man->meta.title);
317: free(man->meta.vol);
318: free(man->meta.source);
319: free(man->meta.msec);
320: free(man->meta.date);
1.51 kristaps 321:
1.85 schwarze 322: man->meta.title = man->meta.vol = man->meta.date =
1.91 schwarze 323: man->meta.msec = man->meta.source = NULL;
1.51 kristaps 324:
1.92 schwarze 325: nb = n;
326:
1.51 kristaps 327: /* ->TITLE<- MSEC DATE SOURCE VOL */
328:
329: n = n->child;
1.60 schwarze 330: if (n && n->string) {
331: for (p = n->string; '\0' != *p; p++) {
332: /* Only warn about this once... */
1.91 schwarze 333: if (isalpha((unsigned char)*p) &&
334: ! isupper((unsigned char)*p)) {
1.102 schwarze 335: mandoc_vmsg(MANDOCERR_TITLE_CASE,
1.94 schwarze 336: man->parse, n->line,
337: n->pos + (p - n->string),
1.102 schwarze 338: "TH %s", n->string);
1.60 schwarze 339: break;
340: }
341: }
1.85 schwarze 342: man->meta.title = mandoc_strdup(n->string);
1.105 schwarze 343: } else {
1.85 schwarze 344: man->meta.title = mandoc_strdup("");
1.105 schwarze 345: mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
346: nb->line, nb->pos, "TH");
347: }
1.51 kristaps 348:
349: /* TITLE ->MSEC<- DATE SOURCE VOL */
350:
1.60 schwarze 351: if (n)
352: n = n->next;
353: if (n && n->string)
1.85 schwarze 354: man->meta.msec = mandoc_strdup(n->string);
1.105 schwarze 355: else {
1.85 schwarze 356: man->meta.msec = mandoc_strdup("");
1.105 schwarze 357: mandoc_vmsg(MANDOCERR_MSEC_MISSING, man->parse,
358: nb->line, nb->pos, "TH %s", man->meta.title);
359: }
1.51 kristaps 360:
361: /* TITLE MSEC ->DATE<- SOURCE VOL */
362:
1.60 schwarze 363: if (n)
364: n = n->next;
1.77 schwarze 365: if (n && n->string && '\0' != n->string[0]) {
1.88 schwarze 366: man->meta.date = man->quick ?
367: mandoc_strdup(n->string) :
368: mandoc_normdate(man->parse, n->string,
369: n->line, n->pos);
1.92 schwarze 370: } else {
1.85 schwarze 371: man->meta.date = mandoc_strdup("");
1.102 schwarze 372: mandoc_msg(MANDOCERR_DATE_MISSING, man->parse,
373: n ? n->line : nb->line,
374: n ? n->pos : nb->pos, "TH");
1.92 schwarze 375: }
1.51 kristaps 376:
377: /* TITLE MSEC DATE ->SOURCE<- VOL */
378:
379: if (n && (n = n->next))
1.85 schwarze 380: man->meta.source = mandoc_strdup(n->string);
1.108 schwarze 381: else if (man->defos != NULL)
382: man->meta.source = mandoc_strdup(man->defos);
1.51 kristaps 383:
384: /* TITLE MSEC DATE SOURCE ->VOL<- */
1.79 schwarze 385: /* If missing, use the default VOL name for MSEC. */
1.51 kristaps 386:
387: if (n && (n = n->next))
1.85 schwarze 388: man->meta.vol = mandoc_strdup(n->string);
389: else if ('\0' != man->meta.msec[0] &&
390: (NULL != (p = mandoc_a2msec(man->meta.msec))))
391: man->meta.vol = mandoc_strdup(p);
1.51 kristaps 392:
393: /*
394: * Remove the `TH' node after we've processed it for our
395: * meta-data.
396: */
1.85 schwarze 397: man_node_delete(man, man->last);
1.51 kristaps 398: }
399:
1.107 schwarze 400: static void
1.51 kristaps 401: post_nf(CHKARGS)
402: {
403:
1.104 schwarze 404: check_eq0(man, n);
405:
1.85 schwarze 406: if (MAN_LITERAL & man->flags)
1.102 schwarze 407: mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
408: n->line, n->pos, "nf");
1.51 kristaps 409:
1.85 schwarze 410: man->flags |= MAN_LITERAL;
1.51 kristaps 411: }
412:
1.107 schwarze 413: static void
1.51 kristaps 414: post_fi(CHKARGS)
415: {
416:
1.104 schwarze 417: check_eq0(man, n);
418:
1.85 schwarze 419: if ( ! (MAN_LITERAL & man->flags))
1.102 schwarze 420: mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
421: n->line, n->pos, "fi");
1.51 kristaps 422:
1.85 schwarze 423: man->flags &= ~MAN_LITERAL;
1.51 kristaps 424: }
425:
1.107 schwarze 426: static void
1.51 kristaps 427: post_UC(CHKARGS)
428: {
429: static const char * const bsd_versions[] = {
430: "3rd Berkeley Distribution",
431: "4th Berkeley Distribution",
432: "4.2 Berkeley Distribution",
433: "4.3 Berkeley Distribution",
434: "4.4 Berkeley Distribution",
435: };
436:
437: const char *p, *s;
438:
439: n = n->child;
440:
441: if (NULL == n || MAN_TEXT != n->type)
442: p = bsd_versions[0];
443: else {
444: s = n->string;
445: if (0 == strcmp(s, "3"))
446: p = bsd_versions[0];
447: else if (0 == strcmp(s, "4"))
448: p = bsd_versions[1];
449: else if (0 == strcmp(s, "5"))
450: p = bsd_versions[2];
451: else if (0 == strcmp(s, "6"))
452: p = bsd_versions[3];
453: else if (0 == strcmp(s, "7"))
454: p = bsd_versions[4];
455: else
456: p = bsd_versions[0];
457: }
458:
1.85 schwarze 459: free(man->meta.source);
460: man->meta.source = mandoc_strdup(p);
1.51 kristaps 461: }
462:
1.107 schwarze 463: static void
1.51 kristaps 464: post_AT(CHKARGS)
465: {
466: static const char * const unix_versions[] = {
467: "7th Edition",
468: "System III",
469: "System V",
470: "System V Release 2",
471: };
472:
473: const char *p, *s;
474: struct man_node *nn;
475:
476: n = n->child;
477:
478: if (NULL == n || MAN_TEXT != n->type)
479: p = unix_versions[0];
480: else {
481: s = n->string;
482: if (0 == strcmp(s, "3"))
483: p = unix_versions[0];
484: else if (0 == strcmp(s, "4"))
485: p = unix_versions[1];
486: else if (0 == strcmp(s, "5")) {
487: nn = n->next;
488: if (nn && MAN_TEXT == nn->type && nn->string[0])
489: p = unix_versions[3];
490: else
491: p = unix_versions[2];
492: } else
493: p = unix_versions[0];
494: }
495:
1.85 schwarze 496: free(man->meta.source);
497: man->meta.source = mandoc_strdup(p);
1.70 kristaps 498: }
499:
1.107 schwarze 500: static void
1.70 kristaps 501: post_vs(CHKARGS)
502: {
1.104 schwarze 503:
504: if (n->tok == MAN_br)
505: check_eq0(man, n);
506: else
507: check_le1(man, n);
1.70 kristaps 508:
1.82 schwarze 509: if (NULL != n->prev)
1.107 schwarze 510: return;
1.82 schwarze 511:
512: switch (n->parent->tok) {
1.91 schwarze 513: case MAN_SH:
1.82 schwarze 514: /* FALLTHROUGH */
1.91 schwarze 515: case MAN_SS:
1.95 schwarze 516: mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,
517: "%s after %s", man_macronames[n->tok],
518: man_macronames[n->parent->tok]);
1.82 schwarze 519: /* FALLTHROUGH */
1.91 schwarze 520: case MAN_MAX:
521: /*
1.82 schwarze 522: * Don't warn about this because it occurs in pod2man
523: * and would cause considerable (unfixable) warnage.
524: */
1.85 schwarze 525: man_node_delete(man, n);
1.82 schwarze 526: break;
527: default:
528: break;
529: }
1.51 kristaps 530: }
CVSweb