1 /* $Id: man_validate.c,v 1.86 2013/10/17 20:54:58 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
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.
22 #include <sys/types.h>
36 #include "libmandoc.h"
38 #define CHKARGS struct man *man, struct man_node *n
40 typedef int (*v_check)(CHKARGS);
47 static int check_eq0(CHKARGS);
48 static int check_eq2(CHKARGS);
49 static int check_le1(CHKARGS);
50 static int check_ge2(CHKARGS);
51 static int check_le5(CHKARGS);
52 static int check_head1(CHKARGS);
53 static int check_par(CHKARGS);
54 static int check_part(CHKARGS);
55 static int check_root(CHKARGS);
56 static void check_text(CHKARGS);
58 static int post_AT(CHKARGS);
59 static int post_IP(CHKARGS);
60 static int post_vs(CHKARGS);
61 static int post_fi(CHKARGS);
62 static int post_ft(CHKARGS);
63 static int post_nf(CHKARGS);
64 static int post_sec(CHKARGS);
65 static int post_TH(CHKARGS);
66 static int post_UC(CHKARGS);
67 static int pre_sec(CHKARGS);
69 static v_check posts_at[] = { post_AT, NULL };
70 static v_check posts_br[] = { post_vs, check_eq0, NULL };
71 static v_check posts_eq0[] = { check_eq0, NULL };
72 static v_check posts_eq2[] = { check_eq2, NULL };
73 static v_check posts_fi[] = { check_eq0, post_fi, NULL };
74 static v_check posts_ft[] = { post_ft, NULL };
75 static v_check posts_ip[] = { post_IP, NULL };
76 static v_check posts_le1[] = { check_le1, NULL };
77 static v_check posts_nf[] = { check_eq0, post_nf, NULL };
78 static v_check posts_par[] = { check_par, NULL };
79 static v_check posts_part[] = { check_part, NULL };
80 static v_check posts_sec[] = { post_sec, NULL };
81 static v_check posts_sp[] = { post_vs, check_le1, NULL };
82 static v_check posts_th[] = { check_ge2, check_le5, post_TH, NULL };
83 static v_check posts_uc[] = { post_UC, NULL };
84 static v_check posts_ur[] = { check_head1, check_part, NULL };
85 static v_check pres_sec[] = { pre_sec, NULL };
87 static const struct man_valid man_valids[MAN_MAX] = {
88 { NULL, posts_br }, /* br */
89 { NULL, posts_th }, /* TH */
90 { pres_sec, posts_sec }, /* SH */
91 { pres_sec, posts_sec }, /* SS */
92 { NULL, NULL }, /* TP */
93 { NULL, posts_par }, /* LP */
94 { NULL, posts_par }, /* PP */
95 { NULL, posts_par }, /* P */
96 { NULL, posts_ip }, /* IP */
97 { NULL, NULL }, /* HP */
98 { NULL, NULL }, /* SM */
99 { NULL, NULL }, /* SB */
100 { NULL, NULL }, /* BI */
101 { NULL, NULL }, /* IB */
102 { NULL, NULL }, /* BR */
103 { NULL, NULL }, /* RB */
104 { NULL, NULL }, /* R */
105 { NULL, NULL }, /* B */
106 { NULL, NULL }, /* I */
107 { NULL, NULL }, /* IR */
108 { NULL, NULL }, /* RI */
109 { NULL, posts_eq0 }, /* na */
110 { NULL, posts_sp }, /* sp */
111 { NULL, posts_nf }, /* nf */
112 { NULL, posts_fi }, /* fi */
113 { NULL, NULL }, /* RE */
114 { NULL, posts_part }, /* RS */
115 { NULL, NULL }, /* DT */
116 { NULL, posts_uc }, /* UC */
117 { NULL, posts_le1 }, /* PD */
118 { NULL, posts_at }, /* AT */
119 { NULL, NULL }, /* in */
120 { NULL, posts_ft }, /* ft */
121 { NULL, posts_eq2 }, /* OP */
122 { NULL, posts_nf }, /* EX */
123 { NULL, posts_fi }, /* EE */
124 { NULL, posts_ur }, /* UR */
125 { NULL, NULL }, /* UE */
130 man_valid_pre(struct man *man, struct man_node *n)
147 if (NULL == (cp = man_valids[n->tok].pres))
150 if ( ! (*cp)(man, n))
157 man_valid_post(struct man *man)
161 if (MAN_VALID & man->last->flags)
163 man->last->flags |= MAN_VALID;
165 switch (man->last->type) {
167 check_text(man, man->last);
170 return(check_root(man, man->last));
179 if (NULL == (cp = man_valids[man->last->tok].posts))
182 if ( ! (*cp)(man, man->last))
193 if (MAN_BLINE & man->flags)
194 man_nmsg(man, n, MANDOCERR_SCOPEEXIT);
195 else if (MAN_ELINE & man->flags)
196 man_nmsg(man, n, MANDOCERR_SCOPEEXIT);
198 man->flags &= ~MAN_BLINE;
199 man->flags &= ~MAN_ELINE;
201 if (NULL == man->first->child) {
202 man_nmsg(man, n, MANDOCERR_NODOCBODY);
204 } else if (NULL == man->meta.title) {
205 man_nmsg(man, n, MANDOCERR_NOTITLE);
208 * If a title hasn't been set, do so now (by
209 * implication, date and section also aren't set).
212 man->meta.title = mandoc_strdup("unknown");
213 man->meta.msec = mandoc_strdup("1");
214 man->meta.date = mandoc_normdate
215 (man->parse, NULL, n->line, n->pos);
226 if (MAN_LITERAL & man->flags)
230 for (p = cp; NULL != (p = strchr(p, '\t')); p++)
231 man_pmsg(man, n->line, (int)(p - cp), MANDOCERR_BADTAB);
234 #define INEQ_DEFINE(x, ineq, name) \
236 check_##name(CHKARGS) \
238 if (n->nchild ineq (x)) \
240 mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \
241 "line arguments %s %d (have %d)", \
242 #ineq, (x), n->nchild); \
246 INEQ_DEFINE(0, ==, eq0)
247 INEQ_DEFINE(2, ==, eq2)
248 INEQ_DEFINE(1, <=, le1)
249 INEQ_DEFINE(2, >=, ge2)
250 INEQ_DEFINE(5, <=, le5)
256 if (MAN_HEAD == n->type && 1 != n->nchild)
257 mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line,
258 n->pos, "line arguments eq 1 (have %d)", n->nchild);
273 cp = n->child->string;
292 if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2]))
296 if ('W' == cp[1] && '\0' == cp[2])
305 (MANDOCERR_BADFONT, man->parse,
306 n->line, n->pos, "%s", cp);
312 (MANDOCERR_ARGCOUNT, man->parse, n->line,
313 n->pos, "want one child (have %d)",
323 if (MAN_BLOCK == n->type)
324 man->flags &= ~MAN_LITERAL;
332 if ( ! (MAN_HEAD == n->type && 0 == n->nchild))
335 man_nmsg(man, n, MANDOCERR_SYNTARGCOUNT);
343 if (MAN_BODY == n->type && 0 == n->nchild)
344 mandoc_msg(MANDOCERR_ARGCWARN, man->parse, n->line,
345 n->pos, "want children (have none)");
357 if (0 == n->body->nchild)
358 man_node_delete(man, n);
362 man_nmsg(man, n, MANDOCERR_IGNPAR);
366 man_nmsg(man, n, MANDOCERR_ARGSLOST);
381 if (0 == n->head->nchild && 0 == n->body->nchild)
382 man_node_delete(man, n);
385 if (0 == n->parent->head->nchild && 0 == n->nchild)
386 man_nmsg(man, n, MANDOCERR_IGNPAR);
400 free(man->meta.title);
402 free(man->meta.source);
403 free(man->meta.msec);
404 free(man->meta.date);
408 man->meta.title = man->meta.vol = man->meta.date =
409 man->meta.msec = man->meta.source = NULL;
411 /* ->TITLE<- MSEC DATE SOURCE VOL */
414 if (n && n->string) {
415 for (p = n->string; '\0' != *p; p++) {
416 /* Only warn about this once... */
417 if (isalpha((unsigned char)*p) &&
418 ! isupper((unsigned char)*p)) {
419 man_nmsg(man, n, MANDOCERR_UPPERCASE);
423 man->meta.title = mandoc_strdup(n->string);
425 man->meta.title = mandoc_strdup("");
427 /* TITLE ->MSEC<- DATE SOURCE VOL */
432 man->meta.msec = mandoc_strdup(n->string);
434 man->meta.msec = mandoc_strdup("");
436 /* TITLE MSEC ->DATE<- SOURCE VOL */
440 if (n && n->string && '\0' != n->string[0]) {
442 man->meta.date = mandoc_normdate
443 (man->parse, n->string, line, pos);
445 man->meta.date = mandoc_strdup("");
447 /* TITLE MSEC DATE ->SOURCE<- VOL */
449 if (n && (n = n->next))
450 man->meta.source = mandoc_strdup(n->string);
452 /* TITLE MSEC DATE SOURCE ->VOL<- */
453 /* If missing, use the default VOL name for MSEC. */
455 if (n && (n = n->next))
456 man->meta.vol = mandoc_strdup(n->string);
457 else if ('\0' != man->meta.msec[0] &&
458 (NULL != (p = mandoc_a2msec(man->meta.msec))))
459 man->meta.vol = mandoc_strdup(p);
462 * Remove the `TH' node after we've processed it for our
465 man_node_delete(man, man->last);
473 if (MAN_LITERAL & man->flags)
474 man_nmsg(man, n, MANDOCERR_SCOPEREP);
476 man->flags |= MAN_LITERAL;
484 if ( ! (MAN_LITERAL & man->flags))
485 man_nmsg(man, n, MANDOCERR_WNOSCOPE);
487 man->flags &= ~MAN_LITERAL;
494 static const char * const bsd_versions[] = {
495 "3rd Berkeley Distribution",
496 "4th Berkeley Distribution",
497 "4.2 Berkeley Distribution",
498 "4.3 Berkeley Distribution",
499 "4.4 Berkeley Distribution",
506 if (NULL == n || MAN_TEXT != n->type)
510 if (0 == strcmp(s, "3"))
512 else if (0 == strcmp(s, "4"))
514 else if (0 == strcmp(s, "5"))
516 else if (0 == strcmp(s, "6"))
518 else if (0 == strcmp(s, "7"))
524 free(man->meta.source);
525 man->meta.source = mandoc_strdup(p);
532 static const char * const unix_versions[] = {
536 "System V Release 2",
544 if (NULL == n || MAN_TEXT != n->type)
545 p = unix_versions[0];
548 if (0 == strcmp(s, "3"))
549 p = unix_versions[0];
550 else if (0 == strcmp(s, "4"))
551 p = unix_versions[1];
552 else if (0 == strcmp(s, "5")) {
554 if (nn && MAN_TEXT == nn->type && nn->string[0])
555 p = unix_versions[3];
557 p = unix_versions[2];
559 p = unix_versions[0];
562 free(man->meta.source);
563 man->meta.source = mandoc_strdup(p);
574 switch (n->parent->tok) {
578 man_nmsg(man, n, MANDOCERR_IGNPAR);
582 * Don't warn about this because it occurs in pod2man
583 * and would cause considerable (unfixable) warnage.
585 man_node_delete(man, n);