version 1.55, 2010/12/06 15:31:19 |
version 1.81, 2012/06/02 20:16:23 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 2010 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 <string.h> |
#include <string.h> |
#include <time.h> |
#include <time.h> |
|
|
|
#include "man.h" |
#include "mandoc.h" |
#include "mandoc.h" |
#include "libman.h" |
#include "libman.h" |
#include "libmandoc.h" |
#include "libmandoc.h" |
Line 42 struct man_valid { |
|
Line 44 struct man_valid { |
|
v_check *posts; |
v_check *posts; |
}; |
}; |
|
|
static int check_bline(CHKARGS); |
|
static int check_eq0(CHKARGS); |
static int check_eq0(CHKARGS); |
static int check_ft(CHKARGS); |
static int check_eq2(CHKARGS); |
static int check_le1(CHKARGS); |
static int check_le1(CHKARGS); |
static int check_ge2(CHKARGS); |
static int check_ge2(CHKARGS); |
static int check_le5(CHKARGS); |
static int check_le5(CHKARGS); |
static int check_par(CHKARGS); |
static int check_par(CHKARGS); |
static int check_part(CHKARGS); |
static int check_part(CHKARGS); |
static int check_root(CHKARGS); |
static int check_root(CHKARGS); |
static int check_sec(CHKARGS); |
static void check_text(CHKARGS); |
static int check_text(CHKARGS); |
|
static int check_title(CHKARGS); |
|
|
|
static int post_AT(CHKARGS); |
static int post_AT(CHKARGS); |
|
static int post_vs(CHKARGS); |
static int post_fi(CHKARGS); |
static int post_fi(CHKARGS); |
|
static int post_ft(CHKARGS); |
static int post_nf(CHKARGS); |
static int post_nf(CHKARGS); |
|
static int post_sec(CHKARGS); |
static int post_TH(CHKARGS); |
static int post_TH(CHKARGS); |
static int post_UC(CHKARGS); |
static int post_UC(CHKARGS); |
|
static int pre_sec(CHKARGS); |
|
|
static v_check posts_at[] = { post_AT, NULL }; |
static v_check posts_at[] = { post_AT, NULL }; |
|
static v_check posts_br[] = { post_vs, check_eq0, NULL }; |
static v_check posts_eq0[] = { check_eq0, NULL }; |
static v_check posts_eq0[] = { check_eq0, NULL }; |
|
static v_check posts_eq2[] = { check_eq2, NULL }; |
static v_check posts_fi[] = { check_eq0, post_fi, NULL }; |
static v_check posts_fi[] = { check_eq0, post_fi, NULL }; |
static v_check posts_le1[] = { check_le1, NULL }; |
static v_check posts_ft[] = { post_ft, NULL }; |
static v_check posts_ft[] = { check_ft, NULL }; |
|
static v_check posts_nf[] = { check_eq0, post_nf, NULL }; |
static v_check posts_nf[] = { check_eq0, post_nf, NULL }; |
static v_check posts_par[] = { check_par, NULL }; |
static v_check posts_par[] = { check_par, NULL }; |
static v_check posts_part[] = { check_part, NULL }; |
static v_check posts_part[] = { check_part, NULL }; |
static v_check posts_sec[] = { check_sec, NULL }; |
static v_check posts_sec[] = { post_sec, NULL }; |
static v_check posts_th[] = { check_ge2, check_le5, check_title, post_TH, NULL }; |
static v_check posts_sp[] = { post_vs, check_le1, NULL }; |
|
static v_check posts_th[] = { check_ge2, check_le5, post_TH, NULL }; |
static v_check posts_uc[] = { post_UC, NULL }; |
static v_check posts_uc[] = { post_UC, NULL }; |
static v_check pres_bline[] = { check_bline, NULL }; |
static v_check pres_sec[] = { pre_sec, NULL }; |
|
|
|
|
static const struct man_valid man_valids[MAN_MAX] = { |
static const struct man_valid man_valids[MAN_MAX] = { |
{ NULL, posts_eq0 }, /* br */ |
{ NULL, posts_br }, /* br */ |
{ pres_bline, posts_th }, /* TH */ |
{ NULL, posts_th }, /* TH */ |
{ pres_bline, posts_sec }, /* SH */ |
{ pres_sec, posts_sec }, /* SH */ |
{ pres_bline, posts_sec }, /* SS */ |
{ pres_sec, posts_sec }, /* SS */ |
{ pres_bline, posts_par }, /* TP */ |
{ NULL, NULL }, /* TP */ |
{ pres_bline, posts_par }, /* LP */ |
{ NULL, posts_par }, /* LP */ |
{ pres_bline, posts_par }, /* PP */ |
{ NULL, posts_par }, /* PP */ |
{ pres_bline, posts_par }, /* P */ |
{ NULL, posts_par }, /* P */ |
{ pres_bline, posts_par }, /* IP */ |
{ NULL, NULL }, /* IP */ |
{ pres_bline, posts_par }, /* HP */ |
{ NULL, NULL }, /* HP */ |
{ NULL, NULL }, /* SM */ |
{ NULL, NULL }, /* SM */ |
{ NULL, NULL }, /* SB */ |
{ NULL, NULL }, /* SB */ |
{ NULL, NULL }, /* BI */ |
{ NULL, NULL }, /* BI */ |
Line 97 static const struct man_valid man_valids[MAN_MAX] = { |
|
Line 101 static const struct man_valid man_valids[MAN_MAX] = { |
|
{ NULL, NULL }, /* I */ |
{ NULL, NULL }, /* I */ |
{ NULL, NULL }, /* IR */ |
{ NULL, NULL }, /* IR */ |
{ NULL, NULL }, /* RI */ |
{ NULL, NULL }, /* RI */ |
{ NULL, posts_eq0 }, /* na */ /* FIXME: should warn only. */ |
{ NULL, posts_eq0 }, /* na */ |
{ NULL, NULL }, /* i */ |
{ NULL, posts_sp }, /* sp */ |
{ NULL, posts_le1 }, /* sp */ /* FIXME: should warn only. */ |
{ NULL, posts_nf }, /* nf */ |
{ pres_bline, posts_nf }, /* nf */ |
{ NULL, posts_fi }, /* fi */ |
{ pres_bline, posts_fi }, /* fi */ |
|
{ NULL, NULL }, /* r */ |
|
{ NULL, NULL }, /* RE */ |
{ NULL, NULL }, /* RE */ |
{ NULL, posts_part }, /* RS */ |
{ NULL, posts_part }, /* RS */ |
{ NULL, NULL }, /* DT */ |
{ NULL, NULL }, /* DT */ |
Line 111 static const struct man_valid man_valids[MAN_MAX] = { |
|
Line 113 static const struct man_valid man_valids[MAN_MAX] = { |
|
{ NULL, posts_at }, /* AT */ |
{ NULL, posts_at }, /* AT */ |
{ NULL, NULL }, /* in */ |
{ NULL, NULL }, /* in */ |
{ NULL, posts_ft }, /* ft */ |
{ NULL, posts_ft }, /* ft */ |
|
{ NULL, posts_eq2 }, /* OP */ |
|
{ NULL, posts_nf }, /* EX */ |
|
{ NULL, posts_fi }, /* EE */ |
}; |
}; |
|
|
|
|
Line 119 man_valid_pre(struct man *m, struct man_node *n) |
|
Line 124 man_valid_pre(struct man *m, struct man_node *n) |
|
{ |
{ |
v_check *cp; |
v_check *cp; |
|
|
if (MAN_TEXT == n->type) |
switch (n->type) { |
|
case (MAN_TEXT): |
|
/* FALLTHROUGH */ |
|
case (MAN_ROOT): |
|
/* FALLTHROUGH */ |
|
case (MAN_EQN): |
|
/* FALLTHROUGH */ |
|
case (MAN_TBL): |
return(1); |
return(1); |
if (MAN_ROOT == n->type) |
default: |
return(1); |
break; |
|
} |
|
|
if (NULL == (cp = man_valids[n->tok].pres)) |
if (NULL == (cp = man_valids[n->tok].pres)) |
return(1); |
return(1); |
Line 144 man_valid_post(struct man *m) |
|
Line 157 man_valid_post(struct man *m) |
|
|
|
switch (m->last->type) { |
switch (m->last->type) { |
case (MAN_TEXT): |
case (MAN_TEXT): |
return(check_text(m, m->last)); |
check_text(m, m->last); |
|
return(1); |
case (MAN_ROOT): |
case (MAN_ROOT): |
return(check_root(m, m->last)); |
return(check_root(m, m->last)); |
|
case (MAN_EQN): |
|
/* FALLTHROUGH */ |
|
case (MAN_TBL): |
|
return(1); |
default: |
default: |
break; |
break; |
} |
} |
Line 185 check_root(CHKARGS) |
|
Line 203 check_root(CHKARGS) |
|
*/ |
*/ |
|
|
m->meta.title = mandoc_strdup("unknown"); |
m->meta.title = mandoc_strdup("unknown"); |
m->meta.date = time(NULL); |
|
m->meta.msec = mandoc_strdup("1"); |
m->meta.msec = mandoc_strdup("1"); |
|
m->meta.date = mandoc_normdate |
|
(m->parse, NULL, n->line, n->pos); |
} |
} |
|
|
return(1); |
return(1); |
} |
} |
|
|
|
static void |
static int |
check_text(CHKARGS) |
check_title(CHKARGS) |
|
{ |
{ |
const char *p; |
char *cp, *p; |
|
|
assert(n->child); |
if (MAN_LITERAL & m->flags) |
/* FIXME: is this sufficient? */ |
return; |
if ('\0' == *n->child->string) { |
|
man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT); |
|
return(0); |
|
} |
|
|
|
for (p = n->child->string; '\0' != *p; p++) |
cp = n->string; |
/* Only warn about this once... */ |
for (p = cp; NULL != (p = strchr(p, '\t')); p++) |
if (isalpha((u_char)*p) && ! isupper((u_char)*p)) { |
man_pmsg(m, n->line, (int)(p - cp), MANDOCERR_BADTAB); |
man_nmsg(m, n, MANDOCERR_UPPERCASE); |
|
break; |
|
} |
|
|
|
return(1); |
|
} |
} |
|
|
|
|
static int |
|
check_text(CHKARGS) |
|
{ |
|
char *p; |
|
int pos, c; |
|
size_t sz; |
|
|
|
for (p = n->string, pos = n->pos + 1; *p; p++, pos++) { |
|
sz = strcspn(p, "\t\\"); |
|
p += (int)sz; |
|
|
|
if ('\0' == *p) |
|
break; |
|
|
|
pos += (int)sz; |
|
|
|
if ('\t' == *p) { |
|
if (MAN_LITERAL & m->flags) |
|
continue; |
|
if (man_pmsg(m, n->line, pos, MANDOCERR_BADTAB)) |
|
continue; |
|
return(0); |
|
} |
|
|
|
/* Check the special character. */ |
|
|
|
c = mandoc_special(p); |
|
if (c) { |
|
p += c - 1; |
|
pos += c - 1; |
|
} else |
|
man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE); |
|
} |
|
|
|
return(1); |
|
} |
|
|
|
|
|
#define INEQ_DEFINE(x, ineq, name) \ |
#define INEQ_DEFINE(x, ineq, name) \ |
static int \ |
static int \ |
check_##name(CHKARGS) \ |
check_##name(CHKARGS) \ |
{ \ |
{ \ |
if (n->nchild ineq (x)) \ |
if (n->nchild ineq (x)) \ |
return(1); \ |
return(1); \ |
man_vmsg(m, MANDOCERR_SYNTARGCOUNT, n->line, n->pos, \ |
mandoc_vmsg(MANDOCERR_ARGCOUNT, m->parse, n->line, n->pos, \ |
"line arguments %s %d (have %d)", \ |
"line arguments %s %d (have %d)", \ |
#ineq, (x), n->nchild); \ |
#ineq, (x), n->nchild); \ |
return(0); \ |
return(1); \ |
} |
} |
|
|
INEQ_DEFINE(0, ==, eq0) |
INEQ_DEFINE(0, ==, eq0) |
|
INEQ_DEFINE(2, ==, eq2) |
INEQ_DEFINE(1, <=, le1) |
INEQ_DEFINE(1, <=, le1) |
INEQ_DEFINE(2, >=, ge2) |
INEQ_DEFINE(2, >=, ge2) |
INEQ_DEFINE(5, <=, le5) |
INEQ_DEFINE(5, <=, le5) |
|
|
static int |
static int |
check_ft(CHKARGS) |
post_ft(CHKARGS) |
{ |
{ |
char *cp; |
char *cp; |
int ok; |
int ok; |
Line 312 check_ft(CHKARGS) |
|
Line 283 check_ft(CHKARGS) |
|
} |
} |
|
|
if (0 == ok) { |
if (0 == ok) { |
man_vmsg(m, MANDOCERR_BADFONT, |
mandoc_vmsg |
n->line, n->pos, "%s", cp); |
(MANDOCERR_BADFONT, m->parse, |
|
n->line, n->pos, "%s", cp); |
*cp = '\0'; |
*cp = '\0'; |
} |
} |
|
|
if (1 < n->nchild) |
if (1 < n->nchild) |
man_vmsg(m, MANDOCERR_ARGCOUNT, n->line, n->pos, |
mandoc_vmsg |
"want one child (have %d)", n->nchild); |
(MANDOCERR_ARGCOUNT, m->parse, n->line, |
|
n->pos, "want one child (have %d)", |
|
n->nchild); |
|
|
return(1); |
return(1); |
} |
} |
|
|
static int |
static int |
check_sec(CHKARGS) |
pre_sec(CHKARGS) |
{ |
{ |
|
|
if (MAN_HEAD == n->type && 0 == n->nchild) { |
if (MAN_BLOCK == n->type) |
man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT); |
m->flags &= ~MAN_LITERAL; |
return(0); |
|
} else if (MAN_BODY == n->type && 0 == n->nchild) |
|
man_nmsg(m, n, MANDOCERR_NOBODY); |
|
|
|
return(1); |
return(1); |
} |
} |
|
|
|
|
static int |
static int |
check_part(CHKARGS) |
post_sec(CHKARGS) |
{ |
{ |
|
|
if (MAN_BODY == n->type && 0 == n->nchild) |
if ( ! (MAN_HEAD == n->type && 0 == n->nchild)) |
man_nmsg(m, n, MANDOCERR_NOBODY); |
return(1); |
|
|
return(1); |
man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT); |
|
return(0); |
} |
} |
|
|
|
|
static int |
static int |
check_par(CHKARGS) |
check_part(CHKARGS) |
{ |
{ |
|
|
if (MAN_BODY == n->type) |
if (MAN_BODY == n->type && 0 == n->nchild) |
switch (n->tok) { |
mandoc_msg(MANDOCERR_ARGCWARN, m->parse, n->line, |
case (MAN_IP): |
n->pos, "want children (have none)"); |
/* FALLTHROUGH */ |
|
case (MAN_HP): |
|
/* FALLTHROUGH */ |
|
case (MAN_TP): |
|
/* Body-less lists are ok. */ |
|
break; |
|
default: |
|
if (0 == n->nchild) |
|
man_nmsg(m, n, MANDOCERR_NOBODY); |
|
break; |
|
} |
|
if (MAN_HEAD == n->type) |
|
switch (n->tok) { |
|
case (MAN_PP): |
|
/* FALLTHROUGH */ |
|
case (MAN_P): |
|
/* FALLTHROUGH */ |
|
case (MAN_LP): |
|
if (n->nchild) |
|
man_nmsg(m, n, MANDOCERR_ARGSLOST); |
|
break; |
|
default: |
|
break; |
|
} |
|
|
|
return(1); |
return(1); |
} |
} |
|
|
|
|
static int |
static int |
check_bline(CHKARGS) |
check_par(CHKARGS) |
{ |
{ |
|
|
assert( ! (MAN_ELINE & m->flags)); |
switch (n->type) { |
if (MAN_BLINE & m->flags) { |
case (MAN_BLOCK): |
man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE); |
if (0 == n->body->nchild) |
return(0); |
man_node_delete(m, n); |
|
break; |
|
case (MAN_BODY): |
|
if (0 == n->nchild) |
|
man_nmsg(m, n, MANDOCERR_IGNPAR); |
|
break; |
|
case (MAN_HEAD): |
|
if (n->nchild) |
|
man_nmsg(m, n, MANDOCERR_ARGSLOST); |
|
break; |
|
default: |
|
break; |
} |
} |
|
|
return(1); |
return(1); |
} |
} |
|
|
|
|
static int |
static int |
post_TH(CHKARGS) |
post_TH(CHKARGS) |
{ |
{ |
|
const char *p; |
|
int line, pos; |
|
|
if (m->meta.title) |
if (m->meta.title) |
free(m->meta.title); |
free(m->meta.title); |
Line 410 post_TH(CHKARGS) |
|
Line 369 post_TH(CHKARGS) |
|
free(m->meta.source); |
free(m->meta.source); |
if (m->meta.msec) |
if (m->meta.msec) |
free(m->meta.msec); |
free(m->meta.msec); |
if (m->meta.rawdate) |
if (m->meta.date) |
free(m->meta.rawdate); |
free(m->meta.date); |
|
|
m->meta.title = m->meta.vol = m->meta.rawdate = |
line = n->line; |
|
pos = n->pos; |
|
m->meta.title = m->meta.vol = m->meta.date = |
m->meta.msec = m->meta.source = NULL; |
m->meta.msec = m->meta.source = NULL; |
m->meta.date = 0; |
|
|
|
/* ->TITLE<- MSEC DATE SOURCE VOL */ |
/* ->TITLE<- MSEC DATE SOURCE VOL */ |
|
|
n = n->child; |
n = n->child; |
assert(n); |
if (n && n->string) { |
m->meta.title = mandoc_strdup(n->string); |
for (p = n->string; '\0' != *p; p++) { |
|
/* Only warn about this once... */ |
|
if (isalpha((unsigned char)*p) && |
|
! isupper((unsigned char)*p)) { |
|
man_nmsg(m, n, MANDOCERR_UPPERCASE); |
|
break; |
|
} |
|
} |
|
m->meta.title = mandoc_strdup(n->string); |
|
} else |
|
m->meta.title = mandoc_strdup(""); |
|
|
/* TITLE ->MSEC<- DATE SOURCE VOL */ |
/* TITLE ->MSEC<- DATE SOURCE VOL */ |
|
|
n = n->next; |
if (n) |
assert(n); |
n = n->next; |
m->meta.msec = mandoc_strdup(n->string); |
if (n && n->string) |
|
m->meta.msec = mandoc_strdup(n->string); |
|
else |
|
m->meta.msec = mandoc_strdup(""); |
|
|
/* TITLE MSEC ->DATE<- SOURCE VOL */ |
/* TITLE MSEC ->DATE<- SOURCE VOL */ |
|
|
/* |
if (n) |
* Try to parse the date. If this works, stash the epoch (this |
n = n->next; |
* is optimal because we can reformat it in the canonical form). |
if (n && n->string && '\0' != n->string[0]) { |
* If it doesn't parse, isn't specified at all, or is an empty |
pos = n->pos; |
* string, then use the current date. |
m->meta.date = mandoc_normdate |
*/ |
(m->parse, n->string, line, pos); |
|
|
n = n->next; |
|
if (n && n->string && *n->string) { |
|
m->meta.date = mandoc_a2time |
|
(MTIME_ISO_8601, n->string); |
|
if (0 == m->meta.date) { |
|
man_nmsg(m, n, MANDOCERR_BADDATE); |
|
m->meta.rawdate = mandoc_strdup(n->string); |
|
} |
|
} else |
} else |
m->meta.date = time(NULL); |
m->meta.date = mandoc_strdup(""); |
|
|
/* TITLE MSEC DATE ->SOURCE<- VOL */ |
/* TITLE MSEC DATE ->SOURCE<- VOL */ |
|
|
Line 455 post_TH(CHKARGS) |
|
Line 419 post_TH(CHKARGS) |
|
m->meta.source = mandoc_strdup(n->string); |
m->meta.source = mandoc_strdup(n->string); |
|
|
/* TITLE MSEC DATE SOURCE ->VOL<- */ |
/* TITLE MSEC DATE SOURCE ->VOL<- */ |
|
/* If missing, use the default VOL name for MSEC. */ |
|
|
if (n && (n = n->next)) |
if (n && (n = n->next)) |
m->meta.vol = mandoc_strdup(n->string); |
m->meta.vol = mandoc_strdup(n->string); |
|
else if ('\0' != m->meta.msec[0] && |
|
(NULL != (p = mandoc_a2msec(m->meta.msec)))) |
|
m->meta.vol = mandoc_strdup(p); |
|
|
/* |
/* |
* Remove the `TH' node after we've processed it for our |
* Remove the `TH' node after we've processed it for our |
Line 483 post_fi(CHKARGS) |
|
Line 451 post_fi(CHKARGS) |
|
{ |
{ |
|
|
if ( ! (MAN_LITERAL & m->flags)) |
if ( ! (MAN_LITERAL & m->flags)) |
man_nmsg(m, n, MANDOCERR_NOSCOPE); |
man_nmsg(m, n, MANDOCERR_WNOSCOPE); |
|
|
m->flags &= ~MAN_LITERAL; |
m->flags &= ~MAN_LITERAL; |
return(1); |
return(1); |
Line 503 post_UC(CHKARGS) |
|
Line 471 post_UC(CHKARGS) |
|
const char *p, *s; |
const char *p, *s; |
|
|
n = n->child; |
n = n->child; |
n = m->last->child; |
|
|
|
if (NULL == n || MAN_TEXT != n->type) |
if (NULL == n || MAN_TEXT != n->type) |
p = bsd_versions[0]; |
p = bsd_versions[0]; |
Line 567 post_AT(CHKARGS) |
|
Line 534 post_AT(CHKARGS) |
|
free(m->meta.source); |
free(m->meta.source); |
|
|
m->meta.source = mandoc_strdup(p); |
m->meta.source = mandoc_strdup(p); |
|
return(1); |
|
} |
|
|
|
static int |
|
post_vs(CHKARGS) |
|
{ |
|
|
|
/* |
|
* Don't warn about this because it occurs in pod2man and would |
|
* cause considerable (unfixable) warnage. |
|
*/ |
|
if (NULL == n->prev && MAN_ROOT == n->parent->type) |
|
man_node_delete(m, n); |
|
|
return(1); |
return(1); |
} |
} |