version 1.122, 2016/01/08 17:48:09 |
version 1.149, 2019/06/27 15:07:30 |
|
|
/* $OpenBSD$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2010, 2012-2016 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2010, 2012-2018 Ingo Schwarze <schwarze@openbsd.org> |
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
* purpose with or without fee is hereby granted, provided that the above |
* purpose with or without fee is hereby granted, provided that the above |
|
|
#include <errno.h> |
#include <errno.h> |
#include <limits.h> |
#include <limits.h> |
#include <stdarg.h> |
#include <stdarg.h> |
|
#include <stdio.h> |
#include <stdlib.h> |
#include <stdlib.h> |
#include <string.h> |
#include <string.h> |
#include <time.h> |
#include <time.h> |
|
|
|
|
typedef void (*v_check)(CHKARGS); |
typedef void (*v_check)(CHKARGS); |
|
|
|
static void check_abort(CHKARGS) __attribute__((__noreturn__)); |
static void check_par(CHKARGS); |
static void check_par(CHKARGS); |
static void check_part(CHKARGS); |
static void check_part(CHKARGS); |
static void check_root(CHKARGS); |
static void check_root(CHKARGS); |
static void check_text(CHKARGS); |
static void check_text(CHKARGS); |
|
|
static void post_AT(CHKARGS); |
static void post_AT(CHKARGS); |
|
static void post_EE(CHKARGS); |
|
static void post_EX(CHKARGS); |
static void post_IP(CHKARGS); |
static void post_IP(CHKARGS); |
static void post_vs(CHKARGS); |
|
static void post_ft(CHKARGS); |
|
static void post_OP(CHKARGS); |
static void post_OP(CHKARGS); |
|
static void post_SH(CHKARGS); |
static void post_TH(CHKARGS); |
static void post_TH(CHKARGS); |
static void post_UC(CHKARGS); |
static void post_UC(CHKARGS); |
static void post_UR(CHKARGS); |
static void post_UR(CHKARGS); |
|
static void post_in(CHKARGS); |
|
|
static v_check man_valids[MAN_MAX] = { |
static const v_check man_valids[MAN_MAX - MAN_TH] = { |
post_vs, /* br */ |
|
post_TH, /* TH */ |
post_TH, /* TH */ |
NULL, /* SH */ |
post_SH, /* SH */ |
NULL, /* SS */ |
post_SH, /* SS */ |
NULL, /* TP */ |
NULL, /* TP */ |
check_par, /* LP */ |
NULL, /* TQ */ |
|
check_abort,/* LP */ |
check_par, /* PP */ |
check_par, /* PP */ |
check_par, /* P */ |
check_abort,/* P */ |
post_IP, /* IP */ |
post_IP, /* IP */ |
NULL, /* HP */ |
NULL, /* HP */ |
NULL, /* SM */ |
NULL, /* SM */ |
Line 76 static v_check man_valids[MAN_MAX] = { |
|
Line 80 static v_check man_valids[MAN_MAX] = { |
|
NULL, /* I */ |
NULL, /* I */ |
NULL, /* IR */ |
NULL, /* IR */ |
NULL, /* RI */ |
NULL, /* RI */ |
post_vs, /* sp */ |
|
NULL, /* nf */ |
|
NULL, /* fi */ |
|
NULL, /* RE */ |
NULL, /* RE */ |
check_part, /* RS */ |
check_part, /* RS */ |
NULL, /* DT */ |
NULL, /* DT */ |
post_UC, /* UC */ |
post_UC, /* UC */ |
NULL, /* PD */ |
NULL, /* PD */ |
post_AT, /* AT */ |
post_AT, /* AT */ |
NULL, /* in */ |
post_in, /* in */ |
post_ft, /* ft */ |
NULL, /* SY */ |
|
NULL, /* YS */ |
post_OP, /* OP */ |
post_OP, /* OP */ |
NULL, /* EX */ |
post_EX, /* EX */ |
NULL, /* EE */ |
post_EE, /* EE */ |
post_UR, /* UR */ |
post_UR, /* UR */ |
NULL, /* UE */ |
NULL, /* UE */ |
NULL, /* ll */ |
post_UR, /* MT */ |
|
NULL, /* ME */ |
}; |
}; |
|
|
|
|
|
/* Validate the subtree rooted at man->last. */ |
void |
void |
man_node_validate(struct roff_man *man) |
man_validate(struct roff_man *man) |
{ |
{ |
struct roff_node *n; |
struct roff_node *n; |
v_check *cp; |
const v_check *cp; |
|
|
|
/* |
|
* Translate obsolete macros such that later code |
|
* does not need to look for them. |
|
*/ |
|
|
n = man->last; |
n = man->last; |
|
switch (n->tok) { |
|
case MAN_LP: |
|
case MAN_P: |
|
n->tok = MAN_PP; |
|
break; |
|
default: |
|
break; |
|
} |
|
|
|
/* |
|
* Iterate over all children, recursing into each one |
|
* in turn, depth-first. |
|
*/ |
|
|
man->last = man->last->child; |
man->last = man->last->child; |
while (man->last != NULL) { |
while (man->last != NULL) { |
man_node_validate(man); |
man_validate(man); |
if (man->last == n) |
if (man->last == n) |
man->last = man->last->child; |
man->last = man->last->child; |
else |
else |
man->last = man->last->next; |
man->last = man->last->next; |
} |
} |
|
|
|
/* Finally validate the macro itself. */ |
|
|
man->last = n; |
man->last = n; |
man->next = ROFF_NEXT_SIBLING; |
man->next = ROFF_NEXT_SIBLING; |
switch (n->type) { |
switch (n->type) { |
Line 121 man_node_validate(struct roff_man *man) |
|
Line 146 man_node_validate(struct roff_man *man) |
|
case ROFFT_ROOT: |
case ROFFT_ROOT: |
check_root(man, n); |
check_root(man, n); |
break; |
break; |
|
case ROFFT_COMMENT: |
case ROFFT_EQN: |
case ROFFT_EQN: |
case ROFFT_TBL: |
case ROFFT_TBL: |
break; |
break; |
default: |
default: |
cp = man_valids + n->tok; |
if (n->tok < ROFF_MAX) { |
|
roff_validate(man); |
|
break; |
|
} |
|
assert(n->tok >= MAN_TH && n->tok < MAN_MAX); |
|
cp = man_valids + (n->tok - MAN_TH); |
if (*cp) |
if (*cp) |
(*cp)(man, n); |
(*cp)(man, n); |
if (man->last == n) |
if (man->last == n) |
man_state(man, n); |
n->flags |= NODE_VALID; |
break; |
break; |
} |
} |
} |
} |
Line 137 man_node_validate(struct roff_man *man) |
|
Line 168 man_node_validate(struct roff_man *man) |
|
static void |
static void |
check_root(CHKARGS) |
check_root(CHKARGS) |
{ |
{ |
|
|
assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0); |
assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0); |
|
|
if (NULL == man->first->child) |
if (n->last == NULL || n->last->type == ROFFT_COMMENT) |
mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse, |
mandoc_msg(MANDOCERR_DOC_EMPTY, n->line, n->pos, NULL); |
n->line, n->pos, NULL); |
|
else |
else |
man->meta.hasbody = 1; |
man->meta.hasbody = 1; |
|
|
if (NULL == man->meta.title) { |
if (NULL == man->meta.title) { |
mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse, |
mandoc_msg(MANDOCERR_TH_NOTITLE, n->line, n->pos, NULL); |
n->line, n->pos, NULL); |
|
|
|
/* |
/* |
* If a title hasn't been set, do so now (by |
* If a title hasn't been set, do so now (by |
Line 157 check_root(CHKARGS) |
|
Line 185 check_root(CHKARGS) |
|
|
|
man->meta.title = mandoc_strdup(""); |
man->meta.title = mandoc_strdup(""); |
man->meta.msec = mandoc_strdup(""); |
man->meta.msec = mandoc_strdup(""); |
man->meta.date = man->quick ? mandoc_strdup("") : |
man->meta.date = mandoc_normdate(man, NULL, n->line, n->pos); |
mandoc_normdate(man->parse, NULL, n->line, n->pos); |
|
} |
} |
|
|
|
if (man->meta.os_e && |
|
(man->meta.rcsids & (1 << man->meta.os_e)) == 0) |
|
mandoc_msg(MANDOCERR_RCS_MISSING, 0, 0, |
|
man->meta.os_e == MANDOC_OS_OPENBSD ? |
|
"(OpenBSD)" : "(NetBSD)"); |
} |
} |
|
|
static void |
static void |
|
check_abort(CHKARGS) |
|
{ |
|
abort(); |
|
} |
|
|
|
static void |
check_text(CHKARGS) |
check_text(CHKARGS) |
{ |
{ |
char *cp, *p; |
char *cp, *p; |
|
|
if (MAN_LITERAL & man->flags) |
if (n->flags & NODE_NOFILL) |
return; |
return; |
|
|
cp = n->string; |
cp = n->string; |
for (p = cp; NULL != (p = strchr(p, '\t')); p++) |
for (p = cp; NULL != (p = strchr(p, '\t')); p++) |
mandoc_msg(MANDOCERR_FI_TAB, man->parse, |
mandoc_msg(MANDOCERR_FI_TAB, |
n->line, n->pos + (p - cp), NULL); |
n->line, n->pos + (int)(p - cp), NULL); |
} |
} |
|
|
static void |
static void |
|
post_EE(CHKARGS) |
|
{ |
|
if ((n->flags & NODE_NOFILL) == 0) |
|
mandoc_msg(MANDOCERR_FI_SKIP, n->line, n->pos, "EE"); |
|
} |
|
|
|
static void |
|
post_EX(CHKARGS) |
|
{ |
|
if (n->flags & NODE_NOFILL) |
|
mandoc_msg(MANDOCERR_NF_SKIP, n->line, n->pos, "EX"); |
|
} |
|
|
|
static void |
post_OP(CHKARGS) |
post_OP(CHKARGS) |
{ |
{ |
|
|
if (n->child == NULL) |
if (n->child == NULL) |
mandoc_msg(MANDOCERR_OP_EMPTY, man->parse, |
mandoc_msg(MANDOCERR_OP_EMPTY, n->line, n->pos, "OP"); |
n->line, n->pos, "OP"); |
|
else if (n->child->next != NULL && n->child->next->next != NULL) { |
else if (n->child->next != NULL && n->child->next->next != NULL) { |
n = n->child->next->next; |
n = n->child->next->next; |
mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, |
mandoc_msg(MANDOCERR_ARG_EXCESS, |
n->line, n->pos, "OP ... %s", n->string); |
n->line, n->pos, "OP ... %s", n->string); |
} |
} |
} |
} |
|
|
static void |
static void |
post_UR(CHKARGS) |
post_SH(CHKARGS) |
{ |
{ |
|
struct roff_node *nc; |
|
|
if (n->type == ROFFT_HEAD && n->child == NULL) |
if (n->type != ROFFT_BODY || (nc = n->child) == NULL) |
mandoc_vmsg(MANDOCERR_UR_NOHEAD, man->parse, |
|
n->line, n->pos, "UR"); |
|
check_part(man, n); |
|
} |
|
|
|
static void |
|
post_ft(CHKARGS) |
|
{ |
|
char *cp; |
|
int ok; |
|
|
|
if (n->child == NULL) |
|
return; |
return; |
|
|
ok = 0; |
if (nc->tok == MAN_PP && nc->body->child != NULL) { |
cp = n->child->string; |
while (nc->body->last != NULL) { |
switch (*cp) { |
man->next = ROFF_NEXT_CHILD; |
case '1': |
roff_node_relink(man, nc->body->last); |
case '2': |
man->last = n; |
case '3': |
} |
case '4': |
|
case 'I': |
|
case 'P': |
|
case 'R': |
|
if ('\0' == cp[1]) |
|
ok = 1; |
|
break; |
|
case 'B': |
|
if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2])) |
|
ok = 1; |
|
break; |
|
case 'C': |
|
if ('W' == cp[1] && '\0' == cp[2]) |
|
ok = 1; |
|
break; |
|
default: |
|
break; |
|
} |
} |
|
|
if (0 == ok) { |
if (nc->tok == MAN_PP || nc->tok == ROFF_sp || nc->tok == ROFF_br) { |
mandoc_vmsg(MANDOCERR_FT_BAD, man->parse, |
mandoc_msg(MANDOCERR_PAR_SKIP, nc->line, nc->pos, |
n->line, n->pos, "ft %s", cp); |
"%s after %s", roff_name[nc->tok], roff_name[n->tok]); |
*cp = '\0'; |
roff_node_delete(man, nc); |
} |
} |
|
|
|
/* |
|
* Trailing PP is empty, so it is deleted by check_par(). |
|
* Trailing sp is significant. |
|
*/ |
|
|
|
if ((nc = n->last) != NULL && nc->tok == ROFF_br) { |
|
mandoc_msg(MANDOCERR_PAR_SKIP, |
|
nc->line, nc->pos, "%s at the end of %s", |
|
roff_name[nc->tok], roff_name[n->tok]); |
|
roff_node_delete(man, nc); |
|
} |
} |
} |
|
|
static void |
static void |
|
post_UR(CHKARGS) |
|
{ |
|
if (n->type == ROFFT_HEAD && n->child == NULL) |
|
mandoc_msg(MANDOCERR_UR_NOHEAD, n->line, n->pos, |
|
"%s", roff_name[n->tok]); |
|
check_part(man, n); |
|
} |
|
|
|
static void |
check_part(CHKARGS) |
check_part(CHKARGS) |
{ |
{ |
|
|
if (n->type == ROFFT_BODY && n->child == NULL) |
if (n->type == ROFFT_BODY && n->child == NULL) |
mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse, |
mandoc_msg(MANDOCERR_BLK_EMPTY, n->line, n->pos, |
n->line, n->pos, man_macronames[n->tok]); |
"%s", roff_name[n->tok]); |
} |
} |
|
|
static void |
static void |
Line 260 check_par(CHKARGS) |
|
Line 305 check_par(CHKARGS) |
|
roff_node_delete(man, n); |
roff_node_delete(man, n); |
break; |
break; |
case ROFFT_BODY: |
case ROFFT_BODY: |
|
if (n->child != NULL && |
|
(n->child->tok == ROFF_sp || n->child->tok == ROFF_br)) { |
|
mandoc_msg(MANDOCERR_PAR_SKIP, |
|
n->child->line, n->child->pos, |
|
"%s after %s", roff_name[n->child->tok], |
|
roff_name[n->tok]); |
|
roff_node_delete(man, n->child); |
|
} |
if (n->child == NULL) |
if (n->child == NULL) |
mandoc_vmsg(MANDOCERR_PAR_SKIP, |
mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos, |
man->parse, n->line, n->pos, |
"%s empty", roff_name[n->tok]); |
"%s empty", man_macronames[n->tok]); |
|
break; |
break; |
case ROFFT_HEAD: |
case ROFFT_HEAD: |
if (n->child != NULL) |
if (n->child != NULL) |
mandoc_vmsg(MANDOCERR_ARG_SKIP, |
mandoc_msg(MANDOCERR_ARG_SKIP, |
man->parse, n->line, n->pos, |
n->line, n->pos, "%s %s%s", |
"%s %s%s", man_macronames[n->tok], |
roff_name[n->tok], n->child->string, |
n->child->string, |
|
n->child->next != NULL ? " ..." : ""); |
n->child->next != NULL ? " ..." : ""); |
break; |
break; |
default: |
default: |
Line 289 post_IP(CHKARGS) |
|
Line 340 post_IP(CHKARGS) |
|
break; |
break; |
case ROFFT_BODY: |
case ROFFT_BODY: |
if (n->parent->head->child == NULL && n->child == NULL) |
if (n->parent->head->child == NULL && n->child == NULL) |
mandoc_vmsg(MANDOCERR_PAR_SKIP, |
mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos, |
man->parse, n->line, n->pos, |
"%s empty", roff_name[n->tok]); |
"%s empty", man_macronames[n->tok]); |
|
break; |
break; |
default: |
default: |
break; |
break; |
Line 318 post_TH(CHKARGS) |
|
Line 368 post_TH(CHKARGS) |
|
/* ->TITLE<- MSEC DATE OS VOL */ |
/* ->TITLE<- MSEC DATE OS VOL */ |
|
|
n = n->child; |
n = n->child; |
if (n && n->string) { |
if (n != NULL && n->string != NULL) { |
for (p = n->string; '\0' != *p; p++) { |
for (p = n->string; *p != '\0'; p++) { |
/* Only warn about this once... */ |
/* Only warn about this once... */ |
if (isalpha((unsigned char)*p) && |
if (isalpha((unsigned char)*p) && |
! isupper((unsigned char)*p)) { |
! isupper((unsigned char)*p)) { |
mandoc_vmsg(MANDOCERR_TITLE_CASE, |
mandoc_msg(MANDOCERR_TITLE_CASE, n->line, |
man->parse, n->line, |
n->pos + (int)(p - n->string), |
n->pos + (p - n->string), |
|
"TH %s", n->string); |
"TH %s", n->string); |
break; |
break; |
} |
} |
Line 333 post_TH(CHKARGS) |
|
Line 382 post_TH(CHKARGS) |
|
man->meta.title = mandoc_strdup(n->string); |
man->meta.title = mandoc_strdup(n->string); |
} else { |
} else { |
man->meta.title = mandoc_strdup(""); |
man->meta.title = mandoc_strdup(""); |
mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse, |
mandoc_msg(MANDOCERR_TH_NOTITLE, nb->line, nb->pos, "TH"); |
nb->line, nb->pos, "TH"); |
|
} |
} |
|
|
/* TITLE ->MSEC<- DATE OS VOL */ |
/* TITLE ->MSEC<- DATE OS VOL */ |
|
|
if (n) |
if (n != NULL) |
n = n->next; |
n = n->next; |
if (n && n->string) |
if (n != NULL && n->string != NULL) |
man->meta.msec = mandoc_strdup(n->string); |
man->meta.msec = mandoc_strdup(n->string); |
else { |
else { |
man->meta.msec = mandoc_strdup(""); |
man->meta.msec = mandoc_strdup(""); |
mandoc_vmsg(MANDOCERR_MSEC_MISSING, man->parse, |
mandoc_msg(MANDOCERR_MSEC_MISSING, |
nb->line, nb->pos, "TH %s", man->meta.title); |
nb->line, nb->pos, "TH %s", man->meta.title); |
} |
} |
|
|
/* TITLE MSEC ->DATE<- OS VOL */ |
/* TITLE MSEC ->DATE<- OS VOL */ |
|
|
if (n) |
if (n != NULL) |
n = n->next; |
n = n->next; |
if (n && n->string && '\0' != n->string[0]) { |
if (n != NULL && n->string != NULL && n->string[0] != '\0') |
man->meta.date = man->quick ? |
man->meta.date = mandoc_normdate(man, |
mandoc_strdup(n->string) : |
n->string, n->line, n->pos); |
mandoc_normdate(man->parse, n->string, |
else { |
n->line, n->pos); |
|
} else { |
|
man->meta.date = mandoc_strdup(""); |
man->meta.date = mandoc_strdup(""); |
mandoc_msg(MANDOCERR_DATE_MISSING, man->parse, |
mandoc_msg(MANDOCERR_DATE_MISSING, |
n ? n->line : nb->line, |
n == NULL ? nb->line : n->line, |
n ? n->pos : nb->pos, "TH"); |
n == NULL ? nb->pos : n->pos, "TH"); |
} |
} |
|
|
/* TITLE MSEC DATE ->OS<- VOL */ |
/* TITLE MSEC DATE ->OS<- VOL */ |
|
|
if (n && (n = n->next)) |
if (n && (n = n->next)) |
man->meta.os = mandoc_strdup(n->string); |
man->meta.os = mandoc_strdup(n->string); |
else if (man->defos != NULL) |
else if (man->os_s != NULL) |
man->meta.os = mandoc_strdup(man->defos); |
man->meta.os = mandoc_strdup(man->os_s); |
|
if (man->meta.os_e == MANDOC_OS_OTHER && man->meta.os != NULL) { |
|
if (strstr(man->meta.os, "OpenBSD") != NULL) |
|
man->meta.os_e = MANDOC_OS_OPENBSD; |
|
else if (strstr(man->meta.os, "NetBSD") != NULL) |
|
man->meta.os_e = MANDOC_OS_NETBSD; |
|
} |
|
|
/* TITLE MSEC DATE OS ->VOL<- */ |
/* TITLE MSEC DATE OS ->VOL<- */ |
/* If missing, use the default VOL name for MSEC. */ |
/* If missing, use the default VOL name for MSEC. */ |
Line 382 post_TH(CHKARGS) |
|
Line 434 post_TH(CHKARGS) |
|
man->meta.vol = mandoc_strdup(p); |
man->meta.vol = mandoc_strdup(p); |
|
|
if (n != NULL && (n = n->next) != NULL) |
if (n != NULL && (n = n->next) != NULL) |
mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, |
mandoc_msg(MANDOCERR_ARG_EXCESS, |
n->line, n->pos, "TH ... %s", n->string); |
n->line, n->pos, "TH ... %s", n->string); |
|
|
/* |
/* |
Line 469 post_AT(CHKARGS) |
|
Line 521 post_AT(CHKARGS) |
|
} |
} |
|
|
static void |
static void |
post_vs(CHKARGS) |
post_in(CHKARGS) |
{ |
{ |
|
char *s; |
|
|
if (NULL != n->prev) |
if (n->parent->tok != MAN_TP || |
|
n->parent->type != ROFFT_HEAD || |
|
n->child == NULL || |
|
*n->child->string == '+' || |
|
*n->child->string == '-') |
return; |
return; |
|
mandoc_asprintf(&s, "+%s", n->child->string); |
switch (n->parent->tok) { |
free(n->child->string); |
case MAN_SH: |
n->child->string = s; |
case MAN_SS: |
|
mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos, |
|
"%s after %s", man_macronames[n->tok], |
|
man_macronames[n->parent->tok]); |
|
/* FALLTHROUGH */ |
|
case TOKEN_NONE: |
|
/* |
|
* Don't warn about this because it occurs in pod2man |
|
* and would cause considerable (unfixable) warnage. |
|
*/ |
|
roff_node_delete(man, n); |
|
break; |
|
default: |
|
break; |
|
} |
|
} |
} |