version 1.146, 2018/12/31 10:04:39 |
version 1.153, 2020/04/18 20:40:10 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
|
* Copyright (c) 2010, 2012-2020 Ingo Schwarze <schwarze@openbsd.org> |
* 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-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 |
|
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
* |
|
* Validation module for man(7) syntax trees used by mandoc(1). |
*/ |
*/ |
#include "config.h" |
#include "config.h" |
|
|
|
|
#include "libmandoc.h" |
#include "libmandoc.h" |
#include "roff_int.h" |
#include "roff_int.h" |
#include "libman.h" |
#include "libman.h" |
|
#include "tag.h" |
|
|
#define CHKARGS struct roff_man *man, struct roff_node *n |
#define CHKARGS struct roff_man *man, struct roff_node *n |
|
|
typedef void (*v_check)(CHKARGS); |
typedef void (*v_check)(CHKARGS); |
|
|
static void check_abort(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_tag(struct roff_node *, struct roff_node *); |
static void check_text(CHKARGS); |
static void check_text(CHKARGS); |
|
|
static void post_AT(CHKARGS); |
static void post_AT(CHKARGS); |
Line 54 static void post_IP(CHKARGS); |
|
Line 58 static void post_IP(CHKARGS); |
|
static void post_OP(CHKARGS); |
static void post_OP(CHKARGS); |
static void post_SH(CHKARGS); |
static void post_SH(CHKARGS); |
static void post_TH(CHKARGS); |
static void post_TH(CHKARGS); |
|
static void post_TP(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 void post_in(CHKARGS); |
Line 62 static const v_check man_valids[MAN_MAX - MAN_TH] = { |
|
Line 67 static const v_check man_valids[MAN_MAX - MAN_TH] = { |
|
post_TH, /* TH */ |
post_TH, /* TH */ |
post_SH, /* SH */ |
post_SH, /* SH */ |
post_SH, /* SS */ |
post_SH, /* SS */ |
NULL, /* TP */ |
post_TP, /* TP */ |
NULL, /* TQ */ |
post_TP, /* TQ */ |
check_abort,/* LP */ |
check_abort,/* LP */ |
check_par, /* PP */ |
check_par, /* PP */ |
check_abort,/* P */ |
check_abort,/* P */ |
Line 185 check_root(CHKARGS) |
|
Line 190 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(NULL, NULL); |
mandoc_normdate(man, NULL, n->line, n->pos); |
|
} |
} |
|
|
if (man->meta.os_e && |
if (man->meta.os_e && |
Line 202 check_abort(CHKARGS) |
|
Line 206 check_abort(CHKARGS) |
|
abort(); |
abort(); |
} |
} |
|
|
|
/* |
|
* Skip leading whitespace, dashes, backslashes, and font escapes, |
|
* then create a tag if the first following byte is a letter. |
|
* Priority is high unless whitespace is present. |
|
*/ |
static void |
static void |
|
check_tag(struct roff_node *n, struct roff_node *nt) |
|
{ |
|
const char *cp, *arg; |
|
int prio, sz; |
|
|
|
if (nt == NULL || nt->type != ROFFT_TEXT) |
|
return; |
|
|
|
cp = nt->string; |
|
prio = TAG_STRONG; |
|
for (;;) { |
|
switch (*cp) { |
|
case ' ': |
|
case '\t': |
|
prio = TAG_WEAK; |
|
/* FALLTHROUGH */ |
|
case '-': |
|
cp++; |
|
break; |
|
case '\\': |
|
cp++; |
|
switch (mandoc_escape(&cp, &arg, &sz)) { |
|
case ESCAPE_FONT: |
|
case ESCAPE_FONTBOLD: |
|
case ESCAPE_FONTITALIC: |
|
case ESCAPE_FONTBI: |
|
case ESCAPE_FONTROMAN: |
|
case ESCAPE_FONTCW: |
|
case ESCAPE_FONTPREV: |
|
case ESCAPE_IGNORE: |
|
break; |
|
case ESCAPE_SPECIAL: |
|
if (sz != 1) |
|
return; |
|
switch (*arg) { |
|
case '-': |
|
case 'e': |
|
break; |
|
default: |
|
return; |
|
} |
|
break; |
|
default: |
|
return; |
|
} |
|
break; |
|
default: |
|
if (isalpha((unsigned char)*cp)) |
|
tag_put(cp, prio, n); |
|
return; |
|
} |
|
} |
|
} |
|
|
|
static void |
check_text(CHKARGS) |
check_text(CHKARGS) |
{ |
{ |
char *cp, *p; |
char *cp, *p; |
|
|
post_SH(CHKARGS) |
post_SH(CHKARGS) |
{ |
{ |
struct roff_node *nc; |
struct roff_node *nc; |
|
char *cp, *tag; |
|
|
if (n->type != ROFFT_BODY || (nc = n->child) == NULL) |
nc = n->child; |
|
switch (n->type) { |
|
case ROFFT_HEAD: |
|
tag = NULL; |
|
deroff(&tag, n); |
|
if (tag != NULL) { |
|
for (cp = tag; *cp != '\0'; cp++) |
|
if (*cp == ' ') |
|
*cp = '_'; |
|
if (nc != NULL && nc->type == ROFFT_TEXT && |
|
strcmp(nc->string, tag) == 0) |
|
tag_put(NULL, TAG_WEAK, n); |
|
else |
|
tag_put(tag, TAG_FALLBACK, n); |
|
free(tag); |
|
} |
return; |
return; |
|
case ROFFT_BODY: |
|
if (nc != NULL) |
|
break; |
|
return; |
|
default: |
|
return; |
|
} |
|
|
if (nc->tok == MAN_PP && nc->body->child != NULL) { |
if (nc->tok == MAN_PP && nc->body->child != NULL) { |
while (nc->body->last != NULL) { |
while (nc->body->last != NULL) { |
Line 333 check_par(CHKARGS) |
|
Line 420 check_par(CHKARGS) |
|
static void |
static void |
post_IP(CHKARGS) |
post_IP(CHKARGS) |
{ |
{ |
|
|
switch (n->type) { |
switch (n->type) { |
case ROFFT_BLOCK: |
case ROFFT_BLOCK: |
if (n->head->child == NULL && n->body->child == NULL) |
if (n->head->child == NULL && n->body->child == NULL) |
roff_node_delete(man, n); |
roff_node_delete(man, n); |
break; |
break; |
|
case ROFFT_HEAD: |
|
check_tag(n, n->child); |
|
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_msg(MANDOCERR_PAR_SKIP, n->line, n->pos, |
mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos, |
Line 349 post_IP(CHKARGS) |
|
Line 438 post_IP(CHKARGS) |
|
} |
} |
} |
} |
|
|
|
/* |
|
* The first next-line element in the head is the tag. |
|
* If that's a font macro, use its first child instead. |
|
*/ |
static void |
static void |
|
post_TP(CHKARGS) |
|
{ |
|
struct roff_node *nt; |
|
|
|
if (n->type != ROFFT_HEAD || (nt = n->child) == NULL) |
|
return; |
|
|
|
while ((nt->flags & NODE_LINE) == 0) |
|
if ((nt = nt->next) == NULL) |
|
return; |
|
|
|
switch (nt->tok) { |
|
case MAN_B: |
|
case MAN_BI: |
|
case MAN_BR: |
|
case MAN_I: |
|
case MAN_IB: |
|
case MAN_IR: |
|
nt = nt->child; |
|
break; |
|
default: |
|
break; |
|
} |
|
check_tag(n, nt); |
|
} |
|
|
|
static void |
post_TH(CHKARGS) |
post_TH(CHKARGS) |
{ |
{ |
struct roff_node *nb; |
struct roff_node *nb; |
Line 369 post_TH(CHKARGS) |
|
Line 489 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)) { |
Line 388 post_TH(CHKARGS) |
|
Line 508 post_TH(CHKARGS) |
|
|
|
/* 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(""); |
Line 400 post_TH(CHKARGS) |
|
Line 520 post_TH(CHKARGS) |
|
|
|
/* 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 (man->quick && n != NULL) |
man->meta.date = man->quick ? |
|
mandoc_strdup(n->string) : |
|
mandoc_normdate(man, n->string, n->line, n->pos); |
|
} else { |
|
man->meta.date = mandoc_strdup(""); |
man->meta.date = mandoc_strdup(""); |
mandoc_msg(MANDOCERR_DATE_MISSING, |
else |
n ? n->line : nb->line, |
man->meta.date = mandoc_normdate(n, nb); |
n ? n->pos : nb->pos, "TH"); |
|
} |
|
|
|
/* TITLE MSEC DATE ->OS<- VOL */ |
/* TITLE MSEC DATE ->OS<- VOL */ |
|
|