version 1.112, 2015/02/06 09:38:43 |
version 1.128, 2017/06/11 19:37:01 |
|
|
/* $OpenBSD$ */ |
/* $OpenBSD$ */ |
/* |
/* |
* 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, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2010, 2012-2017 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 |
* copyright notice and this permission notice appear in all copies. |
* copyright notice and this permission notice appear in all copies. |
* |
* |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* 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 |
|
|
#include <string.h> |
#include <string.h> |
#include <time.h> |
#include <time.h> |
|
|
#include "man.h" |
|
#include "mandoc.h" |
|
#include "mandoc_aux.h" |
#include "mandoc_aux.h" |
#include "libman.h" |
#include "mandoc.h" |
|
#include "roff.h" |
|
#include "man.h" |
#include "libmandoc.h" |
#include "libmandoc.h" |
|
#include "roff_int.h" |
|
#include "libman.h" |
|
|
#define CHKARGS struct man *man, struct man_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_eq2(CHKARGS); |
|
static void check_le5(CHKARGS); |
|
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); |
Line 48 static void check_text(CHKARGS); |
|
Line 48 static void check_text(CHKARGS); |
|
static void post_AT(CHKARGS); |
static void post_AT(CHKARGS); |
static void post_IP(CHKARGS); |
static void post_IP(CHKARGS); |
static void post_vs(CHKARGS); |
static void post_vs(CHKARGS); |
static void post_fi(CHKARGS); |
static void post_OP(CHKARGS); |
static void post_ft(CHKARGS); |
|
static void post_nf(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 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 */ |
NULL, /* SH */ |
NULL, /* SS */ |
NULL, /* SS */ |
Line 77 static v_check man_valids[MAN_MAX] = { |
|
Line 74 static v_check man_valids[MAN_MAX] = { |
|
NULL, /* I */ |
NULL, /* I */ |
NULL, /* IR */ |
NULL, /* IR */ |
NULL, /* RI */ |
NULL, /* RI */ |
post_vs, /* sp */ |
NULL, /* nf */ |
post_nf, /* nf */ |
NULL, /* fi */ |
post_fi, /* fi */ |
|
NULL, /* RE */ |
NULL, /* RE */ |
check_part, /* RS */ |
check_part, /* RS */ |
NULL, /* DT */ |
NULL, /* DT */ |
Line 87 static v_check man_valids[MAN_MAX] = { |
|
Line 83 static v_check man_valids[MAN_MAX] = { |
|
NULL, /* PD */ |
NULL, /* PD */ |
post_AT, /* AT */ |
post_AT, /* AT */ |
NULL, /* in */ |
NULL, /* in */ |
post_ft, /* ft */ |
post_OP, /* OP */ |
check_eq2, /* OP */ |
NULL, /* EX */ |
post_nf, /* EX */ |
NULL, /* EE */ |
post_fi, /* EE */ |
|
post_UR, /* UR */ |
post_UR, /* UR */ |
NULL, /* UE */ |
NULL, /* UE */ |
NULL, /* ll */ |
|
}; |
}; |
|
static const v_check *man_valids = __man_valids - MAN_TH; |
|
|
|
|
void |
void |
man_valid_post(struct man *man) |
man_node_validate(struct roff_man *man) |
{ |
{ |
struct man_node *n; |
struct roff_node *n; |
v_check *cp; |
const v_check *cp; |
|
|
n = man->last; |
n = man->last; |
if (n->flags & MAN_VALID) |
man->last = man->last->child; |
return; |
while (man->last != NULL) { |
n->flags |= MAN_VALID; |
man_node_validate(man); |
|
if (man->last == n) |
|
man->last = man->last->child; |
|
else |
|
man->last = man->last->next; |
|
} |
|
|
|
man->last = n; |
|
man->next = ROFF_NEXT_SIBLING; |
switch (n->type) { |
switch (n->type) { |
case MAN_TEXT: |
case ROFFT_TEXT: |
check_text(man, n); |
check_text(man, n); |
break; |
break; |
case MAN_ROOT: |
case ROFFT_ROOT: |
check_root(man, n); |
check_root(man, n); |
break; |
break; |
case MAN_EQN: |
case ROFFT_EQN: |
/* FALLTHROUGH */ |
case ROFFT_TBL: |
case MAN_TBL: |
|
break; |
break; |
default: |
default: |
|
if (n->tok < ROFF_MAX) { |
|
switch (n->tok) { |
|
case ROFF_br: |
|
case ROFF_sp: |
|
post_vs(man, n); |
|
break; |
|
default: |
|
roff_validate(man); |
|
break; |
|
} |
|
break; |
|
} |
|
assert(n->tok >= MAN_TH && n->tok < MAN_MAX); |
cp = man_valids + n->tok; |
cp = man_valids + n->tok; |
if (*cp) |
if (*cp) |
(*cp)(man, n); |
(*cp)(man, n); |
|
if (man->last == n) |
|
man_state(man, n); |
break; |
break; |
} |
} |
} |
} |
Line 151 check_root(CHKARGS) |
|
Line 167 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 = man->quick ? mandoc_strdup("") : |
mandoc_normdate(man->parse, NULL, n->line, n->pos); |
mandoc_normdate(man, NULL, n->line, n->pos); |
} |
} |
} |
} |
|
|
Line 169 check_text(CHKARGS) |
|
Line 185 check_text(CHKARGS) |
|
n->line, n->pos + (p - cp), NULL); |
n->line, n->pos + (p - cp), NULL); |
} |
} |
|
|
#define INEQ_DEFINE(x, ineq, name) \ |
|
static void \ |
|
check_##name(CHKARGS) \ |
|
{ \ |
|
if (n->nchild ineq (x)) \ |
|
return; \ |
|
mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \ |
|
"line arguments %s %d (have %d)", \ |
|
#ineq, (x), n->nchild); \ |
|
} |
|
|
|
INEQ_DEFINE(2, ==, eq2) |
|
INEQ_DEFINE(5, <=, le5) |
|
|
|
static void |
static void |
post_UR(CHKARGS) |
post_OP(CHKARGS) |
{ |
{ |
|
|
if (MAN_HEAD == n->type && 1 != n->nchild) |
if (n->child == NULL) |
mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, |
mandoc_msg(MANDOCERR_OP_EMPTY, man->parse, |
n->pos, "line arguments eq 1 (have %d)", n->nchild); |
n->line, n->pos, "OP"); |
check_part(man, n); |
else if (n->child->next != NULL && n->child->next->next != NULL) { |
|
n = n->child->next->next; |
|
mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, |
|
n->line, n->pos, "OP ... %s", n->string); |
|
} |
} |
} |
|
|
static void |
static void |
post_ft(CHKARGS) |
post_UR(CHKARGS) |
{ |
{ |
char *cp; |
|
int ok; |
|
|
|
if (0 == n->nchild) |
if (n->type == ROFFT_HEAD && n->child == NULL) |
return; |
mandoc_vmsg(MANDOCERR_UR_NOHEAD, man->parse, |
|
n->line, n->pos, "UR"); |
ok = 0; |
check_part(man, n); |
cp = n->child->string; |
|
switch (*cp) { |
|
case '1': |
|
/* FALLTHROUGH */ |
|
case '2': |
|
/* FALLTHROUGH */ |
|
case '3': |
|
/* FALLTHROUGH */ |
|
case '4': |
|
/* FALLTHROUGH */ |
|
case 'I': |
|
/* FALLTHROUGH */ |
|
case 'P': |
|
/* FALLTHROUGH */ |
|
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) { |
|
mandoc_vmsg(MANDOCERR_FT_BAD, man->parse, |
|
n->line, n->pos, "ft %s", cp); |
|
*cp = '\0'; |
|
} |
|
} |
} |
|
|
static void |
static void |
check_part(CHKARGS) |
check_part(CHKARGS) |
{ |
{ |
|
|
if (n->type == MAN_BODY && n->child == NULL) |
if (n->type == ROFFT_BODY && n->child == NULL) |
mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse, |
mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse, |
n->line, n->pos, man_macronames[n->tok]); |
n->line, n->pos, roff_name[n->tok]); |
} |
} |
|
|
static void |
static void |
Line 254 check_par(CHKARGS) |
|
Line 223 check_par(CHKARGS) |
|
{ |
{ |
|
|
switch (n->type) { |
switch (n->type) { |
case MAN_BLOCK: |
case ROFFT_BLOCK: |
if (0 == n->body->nchild) |
if (n->body->child == NULL) |
man_node_delete(man, n); |
roff_node_delete(man, n); |
break; |
break; |
case MAN_BODY: |
case ROFFT_BODY: |
if (0 == n->nchild) |
if (n->child == NULL) |
mandoc_vmsg(MANDOCERR_PAR_SKIP, |
mandoc_vmsg(MANDOCERR_PAR_SKIP, |
man->parse, n->line, n->pos, |
man->parse, n->line, n->pos, |
"%s empty", man_macronames[n->tok]); |
"%s empty", roff_name[n->tok]); |
break; |
break; |
case MAN_HEAD: |
case ROFFT_HEAD: |
if (n->nchild) |
if (n->child != NULL) |
mandoc_vmsg(MANDOCERR_ARG_SKIP, |
mandoc_vmsg(MANDOCERR_ARG_SKIP, |
man->parse, n->line, n->pos, |
man->parse, 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->nchild > 1 ? " ..." : ""); |
|
break; |
break; |
default: |
default: |
break; |
break; |
Line 282 post_IP(CHKARGS) |
|
Line 250 post_IP(CHKARGS) |
|
{ |
{ |
|
|
switch (n->type) { |
switch (n->type) { |
case MAN_BLOCK: |
case ROFFT_BLOCK: |
if (0 == n->head->nchild && 0 == n->body->nchild) |
if (n->head->child == NULL && n->body->child == NULL) |
man_node_delete(man, n); |
roff_node_delete(man, n); |
break; |
break; |
case MAN_BODY: |
case ROFFT_BODY: |
if (0 == n->parent->head->nchild && 0 == n->nchild) |
if (n->parent->head->child == NULL && n->child == NULL) |
mandoc_vmsg(MANDOCERR_PAR_SKIP, |
mandoc_vmsg(MANDOCERR_PAR_SKIP, |
man->parse, n->line, n->pos, |
man->parse, n->line, n->pos, |
"%s empty", man_macronames[n->tok]); |
"%s empty", roff_name[n->tok]); |
break; |
break; |
default: |
default: |
break; |
break; |
Line 300 post_IP(CHKARGS) |
|
Line 268 post_IP(CHKARGS) |
|
static void |
static void |
post_TH(CHKARGS) |
post_TH(CHKARGS) |
{ |
{ |
struct man_node *nb; |
struct roff_node *nb; |
const char *p; |
const char *p; |
|
|
check_le5(man, n); |
|
|
|
free(man->meta.title); |
free(man->meta.title); |
free(man->meta.vol); |
free(man->meta.vol); |
free(man->meta.source); |
free(man->meta.os); |
free(man->meta.msec); |
free(man->meta.msec); |
free(man->meta.date); |
free(man->meta.date); |
|
|
man->meta.title = man->meta.vol = man->meta.date = |
man->meta.title = man->meta.vol = man->meta.date = |
man->meta.msec = man->meta.source = NULL; |
man->meta.msec = man->meta.os = NULL; |
|
|
nb = n; |
nb = n; |
|
|
/* ->TITLE<- MSEC DATE SOURCE VOL */ |
/* ->TITLE<- MSEC DATE OS VOL */ |
|
|
n = n->child; |
n = n->child; |
if (n && n->string) { |
if (n && n->string) { |
Line 338 post_TH(CHKARGS) |
|
Line 304 post_TH(CHKARGS) |
|
nb->line, nb->pos, "TH"); |
nb->line, nb->pos, "TH"); |
} |
} |
|
|
/* TITLE ->MSEC<- DATE SOURCE VOL */ |
/* TITLE ->MSEC<- DATE OS VOL */ |
|
|
if (n) |
if (n) |
n = n->next; |
n = n->next; |
Line 350 post_TH(CHKARGS) |
|
Line 316 post_TH(CHKARGS) |
|
nb->line, nb->pos, "TH %s", man->meta.title); |
nb->line, nb->pos, "TH %s", man->meta.title); |
} |
} |
|
|
/* TITLE MSEC ->DATE<- SOURCE VOL */ |
/* TITLE MSEC ->DATE<- OS VOL */ |
|
|
if (n) |
if (n) |
n = n->next; |
n = n->next; |
if (n && n->string && '\0' != n->string[0]) { |
if (n && n->string && '\0' != n->string[0]) { |
man->meta.date = man->quick ? |
man->meta.date = man->quick ? |
mandoc_strdup(n->string) : |
mandoc_strdup(n->string) : |
mandoc_normdate(man->parse, n->string, |
mandoc_normdate(man, n->string, n->line, n->pos); |
n->line, n->pos); |
|
} else { |
} else { |
man->meta.date = mandoc_strdup(""); |
man->meta.date = mandoc_strdup(""); |
mandoc_msg(MANDOCERR_DATE_MISSING, man->parse, |
mandoc_msg(MANDOCERR_DATE_MISSING, man->parse, |
Line 366 post_TH(CHKARGS) |
|
Line 331 post_TH(CHKARGS) |
|
n ? n->pos : nb->pos, "TH"); |
n ? n->pos : nb->pos, "TH"); |
} |
} |
|
|
/* TITLE MSEC DATE ->SOURCE<- VOL */ |
/* TITLE MSEC DATE ->OS<- VOL */ |
|
|
if (n && (n = n->next)) |
if (n && (n = n->next)) |
man->meta.source = mandoc_strdup(n->string); |
man->meta.os = mandoc_strdup(n->string); |
else if (man->defos != NULL) |
else if (man->defos != NULL) |
man->meta.source = mandoc_strdup(man->defos); |
man->meta.os = mandoc_strdup(man->defos); |
|
|
/* TITLE MSEC DATE SOURCE ->VOL<- */ |
/* TITLE MSEC DATE OS ->VOL<- */ |
/* If missing, use the default VOL name for MSEC. */ |
/* If missing, use the default VOL name for MSEC. */ |
|
|
if (n && (n = n->next)) |
if (n && (n = n->next)) |
Line 382 post_TH(CHKARGS) |
|
Line 347 post_TH(CHKARGS) |
|
(NULL != (p = mandoc_a2msec(man->meta.msec)))) |
(NULL != (p = mandoc_a2msec(man->meta.msec)))) |
man->meta.vol = mandoc_strdup(p); |
man->meta.vol = mandoc_strdup(p); |
|
|
|
if (n != NULL && (n = n->next) != NULL) |
|
mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, |
|
n->line, n->pos, "TH ... %s", n->string); |
|
|
/* |
/* |
* Remove the `TH' node after we've processed it for our |
* Remove the `TH' node after we've processed it for our |
* meta-data. |
* meta-data. |
*/ |
*/ |
man_node_delete(man, man->last); |
roff_node_delete(man, man->last); |
} |
} |
|
|
static void |
static void |
post_nf(CHKARGS) |
|
{ |
|
|
|
if (man->flags & MAN_LITERAL) |
|
mandoc_msg(MANDOCERR_NF_SKIP, man->parse, |
|
n->line, n->pos, "nf"); |
|
|
|
man->flags |= MAN_LITERAL; |
|
} |
|
|
|
static void |
|
post_fi(CHKARGS) |
|
{ |
|
|
|
if ( ! (MAN_LITERAL & man->flags)) |
|
mandoc_msg(MANDOCERR_FI_SKIP, man->parse, |
|
n->line, n->pos, "fi"); |
|
|
|
man->flags &= ~MAN_LITERAL; |
|
} |
|
|
|
static void |
|
post_UC(CHKARGS) |
post_UC(CHKARGS) |
{ |
{ |
static const char * const bsd_versions[] = { |
static const char * const bsd_versions[] = { |
Line 426 post_UC(CHKARGS) |
|
Line 373 post_UC(CHKARGS) |
|
|
|
n = n->child; |
n = n->child; |
|
|
if (NULL == n || MAN_TEXT != n->type) |
if (n == NULL || n->type != ROFFT_TEXT) |
p = bsd_versions[0]; |
p = bsd_versions[0]; |
else { |
else { |
s = n->string; |
s = n->string; |
Line 444 post_UC(CHKARGS) |
|
Line 391 post_UC(CHKARGS) |
|
p = bsd_versions[0]; |
p = bsd_versions[0]; |
} |
} |
|
|
free(man->meta.source); |
free(man->meta.os); |
man->meta.source = mandoc_strdup(p); |
man->meta.os = mandoc_strdup(p); |
} |
} |
|
|
static void |
static void |
Line 458 post_AT(CHKARGS) |
|
Line 405 post_AT(CHKARGS) |
|
"System V Release 2", |
"System V Release 2", |
}; |
}; |
|
|
|
struct roff_node *nn; |
const char *p, *s; |
const char *p, *s; |
struct man_node *nn; |
|
|
|
n = n->child; |
n = n->child; |
|
|
if (NULL == n || MAN_TEXT != n->type) |
if (n == NULL || n->type != ROFFT_TEXT) |
p = unix_versions[0]; |
p = unix_versions[0]; |
else { |
else { |
s = n->string; |
s = n->string; |
Line 473 post_AT(CHKARGS) |
|
Line 420 post_AT(CHKARGS) |
|
p = unix_versions[1]; |
p = unix_versions[1]; |
else if (0 == strcmp(s, "5")) { |
else if (0 == strcmp(s, "5")) { |
nn = n->next; |
nn = n->next; |
if (nn && MAN_TEXT == nn->type && nn->string[0]) |
if (nn != NULL && |
|
nn->type == ROFFT_TEXT && |
|
nn->string[0] != '\0') |
p = unix_versions[3]; |
p = unix_versions[3]; |
else |
else |
p = unix_versions[2]; |
p = unix_versions[2]; |
Line 481 post_AT(CHKARGS) |
|
Line 430 post_AT(CHKARGS) |
|
p = unix_versions[0]; |
p = unix_versions[0]; |
} |
} |
|
|
free(man->meta.source); |
free(man->meta.os); |
man->meta.source = mandoc_strdup(p); |
man->meta.os = mandoc_strdup(p); |
} |
} |
|
|
static void |
static void |
Line 494 post_vs(CHKARGS) |
|
Line 443 post_vs(CHKARGS) |
|
|
|
switch (n->parent->tok) { |
switch (n->parent->tok) { |
case MAN_SH: |
case MAN_SH: |
/* FALLTHROUGH */ |
|
case MAN_SS: |
case MAN_SS: |
|
case MAN_PP: |
|
case MAN_LP: |
|
case MAN_P: |
mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos, |
mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos, |
"%s after %s", man_macronames[n->tok], |
"%s after %s", roff_name[n->tok], |
man_macronames[n->parent->tok]); |
roff_name[n->parent->tok]); |
/* FALLTHROUGH */ |
/* FALLTHROUGH */ |
case MAN_MAX: |
case TOKEN_NONE: |
/* |
/* |
* Don't warn about this because it occurs in pod2man |
* Don't warn about this because it occurs in pod2man |
* and would cause considerable (unfixable) warnage. |
* and would cause considerable (unfixable) warnage. |
*/ |
*/ |
man_node_delete(man, n); |
roff_node_delete(man, n); |
break; |
break; |
default: |
default: |
break; |
break; |