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