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