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