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