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