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