Annotation of mandoc/man_validate.c, Revision 1.119
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_fi(CHKARGS);
52: static void post_ft(CHKARGS);
53: static void post_nf(CHKARGS);
1.113 schwarze 54: static void post_OP(CHKARGS);
1.107 schwarze 55: static void post_TH(CHKARGS);
56: static void post_UC(CHKARGS);
57: static void post_UR(CHKARGS);
1.51 kristaps 58:
1.104 schwarze 59: static v_check man_valids[MAN_MAX] = {
60: post_vs, /* br */
61: post_TH, /* TH */
62: NULL, /* SH */
63: NULL, /* SS */
64: NULL, /* TP */
65: check_par, /* LP */
66: check_par, /* PP */
67: check_par, /* P */
68: post_IP, /* IP */
69: NULL, /* HP */
70: NULL, /* SM */
71: NULL, /* SB */
72: NULL, /* BI */
73: NULL, /* IB */
74: NULL, /* BR */
75: NULL, /* RB */
76: NULL, /* R */
77: NULL, /* B */
78: NULL, /* I */
79: NULL, /* IR */
80: NULL, /* RI */
81: post_vs, /* sp */
82: post_nf, /* nf */
83: post_fi, /* fi */
84: NULL, /* RE */
85: check_part, /* RS */
86: NULL, /* DT */
87: post_UC, /* UC */
1.112 schwarze 88: NULL, /* PD */
1.104 schwarze 89: post_AT, /* AT */
90: NULL, /* in */
91: post_ft, /* ft */
1.113 schwarze 92: post_OP, /* OP */
1.104 schwarze 93: post_nf, /* EX */
94: post_fi, /* EE */
95: post_UR, /* UR */
96: NULL, /* UE */
97: NULL, /* ll */
1.1 kristaps 98: };
99:
100:
1.107 schwarze 101: void
1.117 schwarze 102: man_valid_post(struct roff_man *man)
1.1 kristaps 103: {
1.115 schwarze 104: struct roff_node *n;
1.17 kristaps 105: v_check *cp;
1.1 kristaps 106:
1.104 schwarze 107: n = man->last;
108: if (n->flags & MAN_VALID)
1.107 schwarze 109: return;
1.104 schwarze 110: n->flags |= MAN_VALID;
1.1 kristaps 111:
1.104 schwarze 112: switch (n->type) {
1.114 schwarze 113: case ROFFT_TEXT:
1.107 schwarze 114: check_text(man, n);
115: break;
1.114 schwarze 116: case ROFFT_ROOT:
1.107 schwarze 117: check_root(man, n);
118: break;
1.114 schwarze 119: case ROFFT_EQN:
1.62 kristaps 120: /* FALLTHROUGH */
1.114 schwarze 121: case ROFFT_TBL:
1.107 schwarze 122: break;
1.1 kristaps 123: default:
1.104 schwarze 124: cp = man_valids + n->tok;
1.107 schwarze 125: if (*cp)
126: (*cp)(man, n);
127: break;
1.1 kristaps 128: }
129: }
130:
1.107 schwarze 131: static void
1.91 schwarze 132: check_root(CHKARGS)
1.14 kristaps 133: {
1.17 kristaps 134:
1.101 schwarze 135: assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
1.17 kristaps 136:
1.93 schwarze 137: if (NULL == man->first->child)
1.103 schwarze 138: mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,
139: n->line, n->pos, NULL);
1.93 schwarze 140: else
141: man->meta.hasbody = 1;
142:
143: if (NULL == man->meta.title) {
1.105 schwarze 144: mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
1.103 schwarze 145: n->line, n->pos, NULL);
1.54 kristaps 146:
1.34 kristaps 147: /*
148: * If a title hasn't been set, do so now (by
149: * implication, date and section also aren't set).
150: */
1.54 kristaps 151:
1.105 schwarze 152: man->meta.title = mandoc_strdup("");
153: man->meta.msec = mandoc_strdup("");
1.88 schwarze 154: man->meta.date = man->quick ? mandoc_strdup("") :
155: mandoc_normdate(man->parse, NULL, n->line, n->pos);
1.34 kristaps 156: }
1.75 kristaps 157: }
158:
1.107 schwarze 159: static void
1.75 kristaps 160: check_text(CHKARGS)
161: {
162: char *cp, *p;
163:
1.85 schwarze 164: if (MAN_LITERAL & man->flags)
1.107 schwarze 165: return;
1.76 schwarze 166:
167: cp = n->string;
168: for (p = cp; NULL != (p = strchr(p, '\t')); p++)
1.99 schwarze 169: mandoc_msg(MANDOCERR_FI_TAB, man->parse,
170: n->line, n->pos + (p - cp), NULL);
1.1 kristaps 171: }
172:
1.113 schwarze 173: static void
174: post_OP(CHKARGS)
175: {
176:
177: if (n->nchild == 0)
178: mandoc_msg(MANDOCERR_OP_EMPTY, man->parse,
179: n->line, n->pos, "OP");
180: else if (n->nchild > 2) {
181: n = n->child->next->next;
182: mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
183: n->line, n->pos, "OP ... %s", n->string);
184: }
1.1 kristaps 185: }
186:
1.107 schwarze 187: static void
1.104 schwarze 188: post_UR(CHKARGS)
1.86 schwarze 189: {
190:
1.114 schwarze 191: if (n->type == ROFFT_HEAD && n->child == NULL)
1.113 schwarze 192: mandoc_vmsg(MANDOCERR_UR_NOHEAD, man->parse,
193: n->line, n->pos, "UR");
1.107 schwarze 194: check_part(man, n);
1.86 schwarze 195: }
1.1 kristaps 196:
1.107 schwarze 197: static void
1.73 kristaps 198: post_ft(CHKARGS)
1.55 kristaps 199: {
200: char *cp;
201: int ok;
202:
203: if (0 == n->nchild)
1.107 schwarze 204: return;
1.55 kristaps 205:
206: ok = 0;
207: cp = n->child->string;
208: switch (*cp) {
1.91 schwarze 209: case '1':
1.55 kristaps 210: /* FALLTHROUGH */
1.91 schwarze 211: case '2':
1.55 kristaps 212: /* FALLTHROUGH */
1.91 schwarze 213: case '3':
1.55 kristaps 214: /* FALLTHROUGH */
1.91 schwarze 215: case '4':
1.55 kristaps 216: /* FALLTHROUGH */
1.91 schwarze 217: case 'I':
1.55 kristaps 218: /* FALLTHROUGH */
1.91 schwarze 219: case 'P':
1.55 kristaps 220: /* FALLTHROUGH */
1.91 schwarze 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_nf(CHKARGS)
397: {
398:
1.111 schwarze 399: if (man->flags & MAN_LITERAL)
1.102 schwarze 400: mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
401: n->line, n->pos, "nf");
1.51 kristaps 402:
1.85 schwarze 403: man->flags |= MAN_LITERAL;
1.51 kristaps 404: }
405:
1.107 schwarze 406: static void
1.51 kristaps 407: post_fi(CHKARGS)
408: {
409:
1.85 schwarze 410: if ( ! (MAN_LITERAL & man->flags))
1.102 schwarze 411: mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
412: n->line, n->pos, "fi");
1.51 kristaps 413:
1.85 schwarze 414: man->flags &= ~MAN_LITERAL;
1.51 kristaps 415: }
416:
1.107 schwarze 417: static void
1.51 kristaps 418: post_UC(CHKARGS)
419: {
420: static const char * const bsd_versions[] = {
421: "3rd Berkeley Distribution",
422: "4th Berkeley Distribution",
423: "4.2 Berkeley Distribution",
424: "4.3 Berkeley Distribution",
425: "4.4 Berkeley Distribution",
426: };
427:
428: const char *p, *s;
429:
430: n = n->child;
431:
1.114 schwarze 432: if (n == NULL || n->type != ROFFT_TEXT)
1.51 kristaps 433: p = bsd_versions[0];
434: else {
435: s = n->string;
436: if (0 == strcmp(s, "3"))
437: p = bsd_versions[0];
438: else if (0 == strcmp(s, "4"))
439: p = bsd_versions[1];
440: else if (0 == strcmp(s, "5"))
441: p = bsd_versions[2];
442: else if (0 == strcmp(s, "6"))
443: p = bsd_versions[3];
444: else if (0 == strcmp(s, "7"))
445: p = bsd_versions[4];
446: else
447: p = bsd_versions[0];
448: }
449:
1.116 schwarze 450: free(man->meta.os);
451: man->meta.os = mandoc_strdup(p);
1.51 kristaps 452: }
453:
1.107 schwarze 454: static void
1.51 kristaps 455: post_AT(CHKARGS)
456: {
457: static const char * const unix_versions[] = {
458: "7th Edition",
459: "System III",
460: "System V",
461: "System V Release 2",
462: };
463:
1.115 schwarze 464: struct roff_node *nn;
1.51 kristaps 465: const char *p, *s;
466:
467: n = n->child;
468:
1.114 schwarze 469: if (n == NULL || n->type != ROFFT_TEXT)
1.51 kristaps 470: p = unix_versions[0];
471: else {
472: s = n->string;
473: if (0 == strcmp(s, "3"))
474: p = unix_versions[0];
475: else if (0 == strcmp(s, "4"))
476: p = unix_versions[1];
477: else if (0 == strcmp(s, "5")) {
478: nn = n->next;
1.114 schwarze 479: if (nn != NULL &&
480: nn->type == ROFFT_TEXT &&
481: nn->string[0] != '\0')
1.51 kristaps 482: p = unix_versions[3];
483: else
484: p = unix_versions[2];
485: } else
486: p = unix_versions[0];
487: }
488:
1.116 schwarze 489: free(man->meta.os);
490: man->meta.os = mandoc_strdup(p);
1.70 kristaps 491: }
492:
1.107 schwarze 493: static void
1.70 kristaps 494: post_vs(CHKARGS)
495: {
496:
1.82 schwarze 497: if (NULL != n->prev)
1.107 schwarze 498: return;
1.82 schwarze 499:
500: switch (n->parent->tok) {
1.91 schwarze 501: case MAN_SH:
1.82 schwarze 502: /* FALLTHROUGH */
1.91 schwarze 503: case MAN_SS:
1.95 schwarze 504: mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,
505: "%s after %s", man_macronames[n->tok],
506: man_macronames[n->parent->tok]);
1.82 schwarze 507: /* FALLTHROUGH */
1.119 ! schwarze 508: case TOKEN_NONE:
1.91 schwarze 509: /*
1.82 schwarze 510: * Don't warn about this because it occurs in pod2man
511: * and would cause considerable (unfixable) warnage.
512: */
1.118 schwarze 513: roff_node_delete(man, n);
1.82 schwarze 514: break;
515: default:
516: break;
517: }
1.51 kristaps 518: }
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