1 /* $Id: man_validate.c,v 1.149 2019/06/27 15:07:30 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2012-2018 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 AUTHORS DISCLAIM ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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.
20 #include <sys/types.h>
32 #include "mandoc_aux.h"
36 #include "libmandoc.h"
40 #define CHKARGS struct roff_man *man, struct roff_node *n
42 typedef void (*v_check)(CHKARGS);
44 static void check_abort(CHKARGS) __attribute__((__noreturn__));
45 static void check_par(CHKARGS);
46 static void check_part(CHKARGS);
47 static void check_root(CHKARGS);
48 static void check_text(CHKARGS);
50 static void post_AT(CHKARGS);
51 static void post_EE(CHKARGS);
52 static void post_EX(CHKARGS);
53 static void post_IP(CHKARGS);
54 static void post_OP(CHKARGS);
55 static void post_SH(CHKARGS);
56 static void post_TH(CHKARGS);
57 static void post_UC(CHKARGS);
58 static void post_UR(CHKARGS);
59 static void post_in(CHKARGS);
61 static const v_check man_valids[MAN_MAX - MAN_TH] = {
102 /* Validate the subtree rooted at man->last. */
104 man_validate(struct roff_man *man)
110 * Translate obsolete macros such that later code
111 * does not need to look for them.
125 * Iterate over all children, recursing into each one
126 * in turn, depth-first.
129 man->last = man->last->child;
130 while (man->last != NULL) {
133 man->last = man->last->child;
135 man->last = man->last->next;
138 /* Finally validate the macro itself. */
141 man->next = ROFF_NEXT_SIBLING;
154 if (n->tok < ROFF_MAX) {
158 assert(n->tok >= MAN_TH && n->tok < MAN_MAX);
159 cp = man_valids + (n->tok - MAN_TH);
163 n->flags |= NODE_VALID;
171 assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
173 if (n->last == NULL || n->last->type == ROFFT_COMMENT)
174 mandoc_msg(MANDOCERR_DOC_EMPTY, n->line, n->pos, NULL);
176 man->meta.hasbody = 1;
178 if (NULL == man->meta.title) {
179 mandoc_msg(MANDOCERR_TH_NOTITLE, n->line, n->pos, NULL);
182 * If a title hasn't been set, do so now (by
183 * implication, date and section also aren't set).
186 man->meta.title = mandoc_strdup("");
187 man->meta.msec = mandoc_strdup("");
188 man->meta.date = mandoc_normdate(man, NULL, n->line, n->pos);
191 if (man->meta.os_e &&
192 (man->meta.rcsids & (1 << man->meta.os_e)) == 0)
193 mandoc_msg(MANDOCERR_RCS_MISSING, 0, 0,
194 man->meta.os_e == MANDOC_OS_OPENBSD ?
195 "(OpenBSD)" : "(NetBSD)");
209 if (n->flags & NODE_NOFILL)
213 for (p = cp; NULL != (p = strchr(p, '\t')); p++)
214 mandoc_msg(MANDOCERR_FI_TAB,
215 n->line, n->pos + (int)(p - cp), NULL);
221 if ((n->flags & NODE_NOFILL) == 0)
222 mandoc_msg(MANDOCERR_FI_SKIP, n->line, n->pos, "EE");
228 if (n->flags & NODE_NOFILL)
229 mandoc_msg(MANDOCERR_NF_SKIP, n->line, n->pos, "EX");
236 if (n->child == NULL)
237 mandoc_msg(MANDOCERR_OP_EMPTY, n->line, n->pos, "OP");
238 else if (n->child->next != NULL && n->child->next->next != NULL) {
239 n = n->child->next->next;
240 mandoc_msg(MANDOCERR_ARG_EXCESS,
241 n->line, n->pos, "OP ... %s", n->string);
248 struct roff_node *nc;
250 if (n->type != ROFFT_BODY || (nc = n->child) == NULL)
253 if (nc->tok == MAN_PP && nc->body->child != NULL) {
254 while (nc->body->last != NULL) {
255 man->next = ROFF_NEXT_CHILD;
256 roff_node_relink(man, nc->body->last);
261 if (nc->tok == MAN_PP || nc->tok == ROFF_sp || nc->tok == ROFF_br) {
262 mandoc_msg(MANDOCERR_PAR_SKIP, nc->line, nc->pos,
263 "%s after %s", roff_name[nc->tok], roff_name[n->tok]);
264 roff_node_delete(man, nc);
268 * Trailing PP is empty, so it is deleted by check_par().
269 * Trailing sp is significant.
272 if ((nc = n->last) != NULL && nc->tok == ROFF_br) {
273 mandoc_msg(MANDOCERR_PAR_SKIP,
274 nc->line, nc->pos, "%s at the end of %s",
275 roff_name[nc->tok], roff_name[n->tok]);
276 roff_node_delete(man, nc);
283 if (n->type == ROFFT_HEAD && n->child == NULL)
284 mandoc_msg(MANDOCERR_UR_NOHEAD, n->line, n->pos,
285 "%s", roff_name[n->tok]);
293 if (n->type == ROFFT_BODY && n->child == NULL)
294 mandoc_msg(MANDOCERR_BLK_EMPTY, n->line, n->pos,
295 "%s", roff_name[n->tok]);
304 if (n->body->child == NULL)
305 roff_node_delete(man, n);
308 if (n->child != NULL &&
309 (n->child->tok == ROFF_sp || n->child->tok == ROFF_br)) {
310 mandoc_msg(MANDOCERR_PAR_SKIP,
311 n->child->line, n->child->pos,
312 "%s after %s", roff_name[n->child->tok],
314 roff_node_delete(man, n->child);
316 if (n->child == NULL)
317 mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos,
318 "%s empty", roff_name[n->tok]);
321 if (n->child != NULL)
322 mandoc_msg(MANDOCERR_ARG_SKIP,
323 n->line, n->pos, "%s %s%s",
324 roff_name[n->tok], n->child->string,
325 n->child->next != NULL ? " ..." : "");
338 if (n->head->child == NULL && n->body->child == NULL)
339 roff_node_delete(man, n);
342 if (n->parent->head->child == NULL && n->child == NULL)
343 mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos,
344 "%s empty", roff_name[n->tok]);
354 struct roff_node *nb;
357 free(man->meta.title);
360 free(man->meta.msec);
361 free(man->meta.date);
363 man->meta.title = man->meta.vol = man->meta.date =
364 man->meta.msec = man->meta.os = NULL;
368 /* ->TITLE<- MSEC DATE OS VOL */
371 if (n != NULL && n->string != NULL) {
372 for (p = n->string; *p != '\0'; p++) {
373 /* Only warn about this once... */
374 if (isalpha((unsigned char)*p) &&
375 ! isupper((unsigned char)*p)) {
376 mandoc_msg(MANDOCERR_TITLE_CASE, n->line,
377 n->pos + (int)(p - n->string),
382 man->meta.title = mandoc_strdup(n->string);
384 man->meta.title = mandoc_strdup("");
385 mandoc_msg(MANDOCERR_TH_NOTITLE, nb->line, nb->pos, "TH");
388 /* TITLE ->MSEC<- DATE OS VOL */
392 if (n != NULL && n->string != NULL)
393 man->meta.msec = mandoc_strdup(n->string);
395 man->meta.msec = mandoc_strdup("");
396 mandoc_msg(MANDOCERR_MSEC_MISSING,
397 nb->line, nb->pos, "TH %s", man->meta.title);
400 /* TITLE MSEC ->DATE<- OS VOL */
404 if (n != NULL && n->string != NULL && n->string[0] != '\0')
405 man->meta.date = mandoc_normdate(man,
406 n->string, n->line, n->pos);
408 man->meta.date = mandoc_strdup("");
409 mandoc_msg(MANDOCERR_DATE_MISSING,
410 n == NULL ? nb->line : n->line,
411 n == NULL ? nb->pos : n->pos, "TH");
414 /* TITLE MSEC DATE ->OS<- VOL */
416 if (n && (n = n->next))
417 man->meta.os = mandoc_strdup(n->string);
418 else if (man->os_s != NULL)
419 man->meta.os = mandoc_strdup(man->os_s);
420 if (man->meta.os_e == MANDOC_OS_OTHER && man->meta.os != NULL) {
421 if (strstr(man->meta.os, "OpenBSD") != NULL)
422 man->meta.os_e = MANDOC_OS_OPENBSD;
423 else if (strstr(man->meta.os, "NetBSD") != NULL)
424 man->meta.os_e = MANDOC_OS_NETBSD;
427 /* TITLE MSEC DATE OS ->VOL<- */
428 /* If missing, use the default VOL name for MSEC. */
430 if (n && (n = n->next))
431 man->meta.vol = mandoc_strdup(n->string);
432 else if ('\0' != man->meta.msec[0] &&
433 (NULL != (p = mandoc_a2msec(man->meta.msec))))
434 man->meta.vol = mandoc_strdup(p);
436 if (n != NULL && (n = n->next) != NULL)
437 mandoc_msg(MANDOCERR_ARG_EXCESS,
438 n->line, n->pos, "TH ... %s", n->string);
441 * Remove the `TH' node after we've processed it for our
444 roff_node_delete(man, man->last);
450 static const char * const bsd_versions[] = {
451 "3rd Berkeley Distribution",
452 "4th Berkeley Distribution",
453 "4.2 Berkeley Distribution",
454 "4.3 Berkeley Distribution",
455 "4.4 Berkeley Distribution",
462 if (n == NULL || n->type != ROFFT_TEXT)
466 if (0 == strcmp(s, "3"))
468 else if (0 == strcmp(s, "4"))
470 else if (0 == strcmp(s, "5"))
472 else if (0 == strcmp(s, "6"))
474 else if (0 == strcmp(s, "7"))
481 man->meta.os = mandoc_strdup(p);
487 static const char * const unix_versions[] = {
491 "System V Release 2",
494 struct roff_node *nn;
499 if (n == NULL || n->type != ROFFT_TEXT)
500 p = unix_versions[0];
503 if (0 == strcmp(s, "3"))
504 p = unix_versions[0];
505 else if (0 == strcmp(s, "4"))
506 p = unix_versions[1];
507 else if (0 == strcmp(s, "5")) {
510 nn->type == ROFFT_TEXT &&
511 nn->string[0] != '\0')
512 p = unix_versions[3];
514 p = unix_versions[2];
516 p = unix_versions[0];
520 man->meta.os = mandoc_strdup(p);
528 if (n->parent->tok != MAN_TP ||
529 n->parent->type != ROFFT_HEAD ||
531 *n->child->string == '+' ||
532 *n->child->string == '-')
534 mandoc_asprintf(&s, "+%s", n->child->string);
535 free(n->child->string);
536 n->child->string = s;