1 /* $Id: man_validate.c,v 1.69 2011/04/13 09:57:08 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010 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 *m, struct man_node *n
40 typedef int (*v_check)(CHKARGS);
47 static int check_bline(CHKARGS);
48 static int check_eq0(CHKARGS);
49 static int check_ft(CHKARGS);
50 static int check_le1(CHKARGS);
51 static int check_ge2(CHKARGS);
52 static int check_le5(CHKARGS);
53 static int check_par(CHKARGS);
54 static int check_part(CHKARGS);
55 static int check_root(CHKARGS);
56 static int check_sec(CHKARGS);
57 static void check_text(CHKARGS);
59 static int post_AT(CHKARGS);
60 static int post_fi(CHKARGS);
61 static int post_nf(CHKARGS);
62 static int post_TH(CHKARGS);
63 static int post_UC(CHKARGS);
65 static v_check posts_at[] = { post_AT, NULL };
66 static v_check posts_eq0[] = { check_eq0, NULL };
67 static v_check posts_fi[] = { check_eq0, post_fi, NULL };
68 static v_check posts_le1[] = { check_le1, NULL };
69 static v_check posts_ft[] = { check_ft, NULL };
70 static v_check posts_nf[] = { check_eq0, post_nf, NULL };
71 static v_check posts_par[] = { check_par, NULL };
72 static v_check posts_part[] = { check_part, NULL };
73 static v_check posts_sec[] = { check_sec, NULL };
74 static v_check posts_th[] = { check_ge2, check_le5, post_TH, NULL };
75 static v_check posts_uc[] = { post_UC, NULL };
76 static v_check pres_bline[] = { check_bline, NULL };
79 static const struct man_valid man_valids[MAN_MAX] = {
80 { NULL, posts_eq0 }, /* br */
81 { pres_bline, posts_th }, /* TH */
82 { pres_bline, posts_sec }, /* SH */
83 { pres_bline, posts_sec }, /* SS */
84 { pres_bline, NULL }, /* TP */
85 { pres_bline, posts_par }, /* LP */
86 { pres_bline, posts_par }, /* PP */
87 { pres_bline, posts_par }, /* P */
88 { pres_bline, NULL }, /* IP */
89 { pres_bline, NULL }, /* HP */
90 { NULL, NULL }, /* SM */
91 { NULL, NULL }, /* SB */
92 { NULL, NULL }, /* BI */
93 { NULL, NULL }, /* IB */
94 { NULL, NULL }, /* BR */
95 { NULL, NULL }, /* RB */
96 { NULL, NULL }, /* R */
97 { NULL, NULL }, /* B */
98 { NULL, NULL }, /* I */
99 { NULL, NULL }, /* IR */
100 { NULL, NULL }, /* RI */
101 { NULL, posts_eq0 }, /* na */ /* FIXME: should warn only. */
102 { NULL, posts_le1 }, /* sp */ /* FIXME: should warn only. */
103 { pres_bline, posts_nf }, /* nf */
104 { pres_bline, posts_fi }, /* fi */
105 { NULL, NULL }, /* RE */
106 { NULL, posts_part }, /* RS */
107 { NULL, NULL }, /* DT */
108 { NULL, posts_uc }, /* UC */
109 { NULL, NULL }, /* PD */
110 { NULL, posts_at }, /* AT */
111 { NULL, NULL }, /* in */
112 { NULL, posts_ft }, /* ft */
117 man_valid_pre(struct man *m, struct man_node *n)
134 if (NULL == (cp = man_valids[n->tok].pres))
144 man_valid_post(struct man *m)
148 if (MAN_VALID & m->last->flags)
150 m->last->flags |= MAN_VALID;
152 switch (m->last->type) {
154 check_text(m, m->last);
157 return(check_root(m, m->last));
166 if (NULL == (cp = man_valids[m->last->tok].posts))
169 if ( ! (*cp)(m, m->last))
180 if (MAN_BLINE & m->flags)
181 man_nmsg(m, n, MANDOCERR_SCOPEEXIT);
182 else if (MAN_ELINE & m->flags)
183 man_nmsg(m, n, MANDOCERR_SCOPEEXIT);
185 m->flags &= ~MAN_BLINE;
186 m->flags &= ~MAN_ELINE;
188 if (NULL == m->first->child) {
189 man_nmsg(m, n, MANDOCERR_NODOCBODY);
191 } else if (NULL == m->meta.title) {
192 man_nmsg(m, n, MANDOCERR_NOTITLE);
195 * If a title hasn't been set, do so now (by
196 * implication, date and section also aren't set).
199 m->meta.title = mandoc_strdup("unknown");
200 m->meta.msec = mandoc_strdup("1");
201 m->meta.date = mandoc_normdate
202 (m->parse, NULL, n->line, n->pos);
219 sz = strcspn(p, "\t\\");
225 if ( ! (MAN_LITERAL & m->flags))
226 man_pmsg(m, n->line, pos, MANDOCERR_BADTAB);
230 } else if ('\0' == *p)
236 if (ESCAPE_ERROR == mandoc_escape
237 ((const char **)&pp, NULL, NULL)) {
238 man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE);
243 while (NULL != (cpp = memchr(cpp, ASCII_HYPH, pp - cpp)))
251 #define INEQ_DEFINE(x, ineq, name) \
253 check_##name(CHKARGS) \
255 if (n->nchild ineq (x)) \
257 mandoc_vmsg(MANDOCERR_ARGCOUNT, m->parse, n->line, n->pos, \
258 "line arguments %s %d (have %d)", \
259 #ineq, (x), n->nchild); \
263 INEQ_DEFINE(0, ==, eq0)
264 INEQ_DEFINE(1, <=, le1)
265 INEQ_DEFINE(2, >=, ge2)
266 INEQ_DEFINE(5, <=, le5)
278 cp = n->child->string;
297 if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2]))
301 if ('W' == cp[1] && '\0' == cp[2])
310 (MANDOCERR_BADFONT, m->parse,
311 n->line, n->pos, "%s", cp);
317 (MANDOCERR_ARGCOUNT, m->parse, n->line,
318 n->pos, "want one child (have %d)",
328 if ( ! (MAN_HEAD == n->type && 0 == n->nchild))
331 man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
340 if (MAN_BODY == n->type && 0 == n->nchild)
341 mandoc_msg(MANDOCERR_ARGCWARN, m->parse, n->line,
342 n->pos, "want children (have none)");
354 if (0 == n->body->nchild)
355 man_node_delete(m, n);
359 man_nmsg(m, n, MANDOCERR_IGNPAR);
363 man_nmsg(m, n, MANDOCERR_ARGSLOST);
377 assert( ! (MAN_ELINE & m->flags));
378 if (MAN_BLINE & m->flags) {
379 man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE);
397 free(m->meta.source);
405 m->meta.title = m->meta.vol = m->meta.date =
406 m->meta.msec = m->meta.source = NULL;
408 /* ->TITLE<- MSEC DATE SOURCE VOL */
411 if (n && n->string) {
412 for (p = n->string; '\0' != *p; p++) {
413 /* Only warn about this once... */
414 if (isalpha((u_char)*p) && ! isupper((u_char)*p)) {
415 man_nmsg(m, n, MANDOCERR_UPPERCASE);
419 m->meta.title = mandoc_strdup(n->string);
421 m->meta.title = mandoc_strdup("");
423 /* TITLE ->MSEC<- DATE SOURCE VOL */
428 m->meta.msec = mandoc_strdup(n->string);
430 m->meta.msec = mandoc_strdup("");
432 /* TITLE MSEC ->DATE<- SOURCE VOL */
438 m->meta.date = mandoc_normdate
439 (m->parse, n ? n->string : NULL, line, pos);
441 /* TITLE MSEC DATE ->SOURCE<- VOL */
443 if (n && (n = n->next))
444 m->meta.source = mandoc_strdup(n->string);
446 /* TITLE MSEC DATE SOURCE ->VOL<- */
448 if (n && (n = n->next))
449 m->meta.vol = mandoc_strdup(n->string);
452 * Remove the `TH' node after we've processed it for our
455 man_node_delete(m, m->last);
463 if (MAN_LITERAL & m->flags)
464 man_nmsg(m, n, MANDOCERR_SCOPEREP);
466 m->flags |= MAN_LITERAL;
474 if ( ! (MAN_LITERAL & m->flags))
475 man_nmsg(m, n, MANDOCERR_WNOSCOPE);
477 m->flags &= ~MAN_LITERAL;
484 static const char * const bsd_versions[] = {
485 "3rd Berkeley Distribution",
486 "4th Berkeley Distribution",
487 "4.2 Berkeley Distribution",
488 "4.3 Berkeley Distribution",
489 "4.4 Berkeley Distribution",
497 if (NULL == n || MAN_TEXT != n->type)
501 if (0 == strcmp(s, "3"))
503 else if (0 == strcmp(s, "4"))
505 else if (0 == strcmp(s, "5"))
507 else if (0 == strcmp(s, "6"))
509 else if (0 == strcmp(s, "7"))
516 free(m->meta.source);
518 m->meta.source = mandoc_strdup(p);
525 static const char * const unix_versions[] = {
529 "System V Release 2",
537 if (NULL == n || MAN_TEXT != n->type)
538 p = unix_versions[0];
541 if (0 == strcmp(s, "3"))
542 p = unix_versions[0];
543 else if (0 == strcmp(s, "4"))
544 p = unix_versions[1];
545 else if (0 == strcmp(s, "5")) {
547 if (nn && MAN_TEXT == nn->type && nn->string[0])
548 p = unix_versions[3];
550 p = unix_versions[2];
552 p = unix_versions[0];
556 free(m->meta.source);
558 m->meta.source = mandoc_strdup(p);