1 /* $Id: man_validate.c,v 1.146 2018/12/31 10:04:39 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);
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 = man->quick ? mandoc_strdup("") :
189 mandoc_normdate(man, NULL, n->line, n->pos);
192 if (man->meta.os_e &&
193 (man->meta.rcsids & (1 << man->meta.os_e)) == 0)
194 mandoc_msg(MANDOCERR_RCS_MISSING, 0, 0,
195 man->meta.os_e == MANDOC_OS_OPENBSD ?
196 "(OpenBSD)" : "(NetBSD)");
210 if (n->flags & NODE_NOFILL)
214 for (p = cp; NULL != (p = strchr(p, '\t')); p++)
215 mandoc_msg(MANDOCERR_FI_TAB,
216 n->line, n->pos + (int)(p - cp), NULL);
222 if ((n->flags & NODE_NOFILL) == 0)
223 mandoc_msg(MANDOCERR_FI_SKIP, n->line, n->pos, "EE");
229 if (n->flags & NODE_NOFILL)
230 mandoc_msg(MANDOCERR_NF_SKIP, n->line, n->pos, "EX");
237 if (n->child == NULL)
238 mandoc_msg(MANDOCERR_OP_EMPTY, n->line, n->pos, "OP");
239 else if (n->child->next != NULL && n->child->next->next != NULL) {
240 n = n->child->next->next;
241 mandoc_msg(MANDOCERR_ARG_EXCESS,
242 n->line, n->pos, "OP ... %s", n->string);
249 struct roff_node *nc;
251 if (n->type != ROFFT_BODY || (nc = n->child) == NULL)
254 if (nc->tok == MAN_PP && nc->body->child != NULL) {
255 while (nc->body->last != NULL) {
256 man->next = ROFF_NEXT_CHILD;
257 roff_node_relink(man, nc->body->last);
262 if (nc->tok == MAN_PP || nc->tok == ROFF_sp || nc->tok == ROFF_br) {
263 mandoc_msg(MANDOCERR_PAR_SKIP, nc->line, nc->pos,
264 "%s after %s", roff_name[nc->tok], roff_name[n->tok]);
265 roff_node_delete(man, nc);
269 * Trailing PP is empty, so it is deleted by check_par().
270 * Trailing sp is significant.
273 if ((nc = n->last) != NULL && nc->tok == ROFF_br) {
274 mandoc_msg(MANDOCERR_PAR_SKIP,
275 nc->line, nc->pos, "%s at the end of %s",
276 roff_name[nc->tok], roff_name[n->tok]);
277 roff_node_delete(man, nc);
284 if (n->type == ROFFT_HEAD && n->child == NULL)
285 mandoc_msg(MANDOCERR_UR_NOHEAD, n->line, n->pos,
286 "%s", roff_name[n->tok]);
294 if (n->type == ROFFT_BODY && n->child == NULL)
295 mandoc_msg(MANDOCERR_BLK_EMPTY, n->line, n->pos,
296 "%s", roff_name[n->tok]);
305 if (n->body->child == NULL)
306 roff_node_delete(man, n);
309 if (n->child != NULL &&
310 (n->child->tok == ROFF_sp || n->child->tok == ROFF_br)) {
311 mandoc_msg(MANDOCERR_PAR_SKIP,
312 n->child->line, n->child->pos,
313 "%s after %s", roff_name[n->child->tok],
315 roff_node_delete(man, n->child);
317 if (n->child == NULL)
318 mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos,
319 "%s empty", roff_name[n->tok]);
322 if (n->child != NULL)
323 mandoc_msg(MANDOCERR_ARG_SKIP,
324 n->line, n->pos, "%s %s%s",
325 roff_name[n->tok], n->child->string,
326 n->child->next != NULL ? " ..." : "");
339 if (n->head->child == NULL && n->body->child == NULL)
340 roff_node_delete(man, n);
343 if (n->parent->head->child == NULL && n->child == NULL)
344 mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos,
345 "%s empty", roff_name[n->tok]);
355 struct roff_node *nb;
358 free(man->meta.title);
361 free(man->meta.msec);
362 free(man->meta.date);
364 man->meta.title = man->meta.vol = man->meta.date =
365 man->meta.msec = man->meta.os = NULL;
369 /* ->TITLE<- MSEC DATE OS VOL */
372 if (n && n->string) {
373 for (p = n->string; '\0' != *p; p++) {
374 /* Only warn about this once... */
375 if (isalpha((unsigned char)*p) &&
376 ! isupper((unsigned char)*p)) {
377 mandoc_msg(MANDOCERR_TITLE_CASE, n->line,
378 n->pos + (int)(p - n->string),
383 man->meta.title = mandoc_strdup(n->string);
385 man->meta.title = mandoc_strdup("");
386 mandoc_msg(MANDOCERR_TH_NOTITLE, nb->line, nb->pos, "TH");
389 /* TITLE ->MSEC<- DATE OS VOL */
394 man->meta.msec = mandoc_strdup(n->string);
396 man->meta.msec = mandoc_strdup("");
397 mandoc_msg(MANDOCERR_MSEC_MISSING,
398 nb->line, nb->pos, "TH %s", man->meta.title);
401 /* TITLE MSEC ->DATE<- OS VOL */
405 if (n && n->string && '\0' != n->string[0]) {
406 man->meta.date = man->quick ?
407 mandoc_strdup(n->string) :
408 mandoc_normdate(man, n->string, n->line, n->pos);
410 man->meta.date = mandoc_strdup("");
411 mandoc_msg(MANDOCERR_DATE_MISSING,
412 n ? n->line : nb->line,
413 n ? n->pos : nb->pos, "TH");
416 /* TITLE MSEC DATE ->OS<- VOL */
418 if (n && (n = n->next))
419 man->meta.os = mandoc_strdup(n->string);
420 else if (man->os_s != NULL)
421 man->meta.os = mandoc_strdup(man->os_s);
422 if (man->meta.os_e == MANDOC_OS_OTHER && man->meta.os != NULL) {
423 if (strstr(man->meta.os, "OpenBSD") != NULL)
424 man->meta.os_e = MANDOC_OS_OPENBSD;
425 else if (strstr(man->meta.os, "NetBSD") != NULL)
426 man->meta.os_e = MANDOC_OS_NETBSD;
429 /* TITLE MSEC DATE OS ->VOL<- */
430 /* If missing, use the default VOL name for MSEC. */
432 if (n && (n = n->next))
433 man->meta.vol = mandoc_strdup(n->string);
434 else if ('\0' != man->meta.msec[0] &&
435 (NULL != (p = mandoc_a2msec(man->meta.msec))))
436 man->meta.vol = mandoc_strdup(p);
438 if (n != NULL && (n = n->next) != NULL)
439 mandoc_msg(MANDOCERR_ARG_EXCESS,
440 n->line, n->pos, "TH ... %s", n->string);
443 * Remove the `TH' node after we've processed it for our
446 roff_node_delete(man, man->last);
452 static const char * const bsd_versions[] = {
453 "3rd Berkeley Distribution",
454 "4th Berkeley Distribution",
455 "4.2 Berkeley Distribution",
456 "4.3 Berkeley Distribution",
457 "4.4 Berkeley Distribution",
464 if (n == NULL || n->type != ROFFT_TEXT)
468 if (0 == strcmp(s, "3"))
470 else if (0 == strcmp(s, "4"))
472 else if (0 == strcmp(s, "5"))
474 else if (0 == strcmp(s, "6"))
476 else if (0 == strcmp(s, "7"))
483 man->meta.os = mandoc_strdup(p);
489 static const char * const unix_versions[] = {
493 "System V Release 2",
496 struct roff_node *nn;
501 if (n == NULL || n->type != ROFFT_TEXT)
502 p = unix_versions[0];
505 if (0 == strcmp(s, "3"))
506 p = unix_versions[0];
507 else if (0 == strcmp(s, "4"))
508 p = unix_versions[1];
509 else if (0 == strcmp(s, "5")) {
512 nn->type == ROFFT_TEXT &&
513 nn->string[0] != '\0')
514 p = unix_versions[3];
516 p = unix_versions[2];
518 p = unix_versions[0];
522 man->meta.os = mandoc_strdup(p);
530 if (n->parent->tok != MAN_TP ||
531 n->parent->type != ROFFT_HEAD ||
533 *n->child->string == '+' ||
534 *n->child->string == '-')
536 mandoc_asprintf(&s, "+%s", n->child->string);
537 free(n->child->string);
538 n->child->string = s;