version 1.121, 2013/11/10 22:54:40 |
version 1.133, 2014/07/07 21:36:20 |
|
|
/* $Id$ */ |
/* $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) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org> |
|
* Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.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 <sys/types.h> |
#include <sys/types.h> |
|
|
#include <assert.h> |
#include <assert.h> |
|
#include <ctype.h> |
#include <stdarg.h> |
#include <stdarg.h> |
#include <stdlib.h> |
#include <stdlib.h> |
#include <stdio.h> |
#include <stdio.h> |
|
|
|
|
#include "man.h" |
#include "man.h" |
#include "mandoc.h" |
#include "mandoc.h" |
|
#include "mandoc_aux.h" |
#include "libman.h" |
#include "libman.h" |
#include "libmandoc.h" |
#include "libmandoc.h" |
|
|
const char *const __man_macronames[MAN_MAX] = { |
const char *const __man_macronames[MAN_MAX] = { |
"br", "TH", "SH", "SS", |
"br", "TH", "SH", "SS", |
"TP", "LP", "PP", "P", |
"TP", "LP", "PP", "P", |
"IP", "HP", "SM", "SB", |
"IP", "HP", "SM", "SB", |
"BI", "IB", "BR", "RB", |
"BI", "IB", "BR", "RB", |
"R", "B", "I", "IR", |
"R", "B", "I", "IR", |
Line 41 const char *const __man_macronames[MAN_MAX] = { |
|
Line 45 const char *const __man_macronames[MAN_MAX] = { |
|
"fi", "RE", "RS", "DT", |
"fi", "RE", "RS", "DT", |
"UC", "PD", "AT", "in", |
"UC", "PD", "AT", "in", |
"ft", "OP", "EX", "EE", |
"ft", "OP", "EX", "EE", |
"UR", "UE" |
"UR", "UE", "ll" |
}; |
}; |
|
|
const char * const *man_macronames = __man_macronames; |
const char * const *man_macronames = __man_macronames; |
|
|
static struct man_node *man_node_alloc(struct man *, int, int, |
static struct man_node *man_node_alloc(struct man *, int, int, |
enum man_type, enum mant); |
enum man_type, enum mant); |
static int man_node_append(struct man *, |
static int man_node_append(struct man *, |
struct man_node *); |
struct man_node *); |
static void man_node_free(struct man_node *); |
static void man_node_free(struct man_node *); |
static void man_node_unlink(struct man *, |
static void man_node_unlink(struct man *, |
struct man_node *); |
struct man_node *); |
static int man_ptext(struct man *, int, char *, int); |
static int man_ptext(struct man *, int, char *, int); |
static int man_pmacro(struct man *, int, char *, int); |
static int man_pmacro(struct man *, int, char *, int); |
Line 68 man_node(const struct man *man) |
|
Line 72 man_node(const struct man *man) |
|
return(man->first); |
return(man->first); |
} |
} |
|
|
|
|
const struct man_meta * |
const struct man_meta * |
man_meta(const struct man *man) |
man_meta(const struct man *man) |
{ |
{ |
Line 77 man_meta(const struct man *man) |
|
Line 80 man_meta(const struct man *man) |
|
return(&man->meta); |
return(&man->meta); |
} |
} |
|
|
|
|
void |
void |
man_reset(struct man *man) |
man_reset(struct man *man) |
{ |
{ |
Line 86 man_reset(struct man *man) |
|
Line 88 man_reset(struct man *man) |
|
man_alloc1(man); |
man_alloc1(man); |
} |
} |
|
|
|
|
void |
void |
man_free(struct man *man) |
man_free(struct man *man) |
{ |
{ |
Line 95 man_free(struct man *man) |
|
Line 96 man_free(struct man *man) |
|
free(man); |
free(man); |
} |
} |
|
|
|
|
struct man * |
struct man * |
man_alloc(struct roff *roff, struct mparse *parse) |
man_alloc(struct roff *roff, struct mparse *parse, int quick) |
{ |
{ |
struct man *p; |
struct man *p; |
|
|
Line 105 man_alloc(struct roff *roff, struct mparse *parse) |
|
Line 105 man_alloc(struct roff *roff, struct mparse *parse) |
|
|
|
man_hash_init(); |
man_hash_init(); |
p->parse = parse; |
p->parse = parse; |
|
p->quick = quick; |
p->roff = roff; |
p->roff = roff; |
|
|
man_alloc1(p); |
man_alloc1(p); |
return(p); |
return(p); |
} |
} |
|
|
|
|
int |
int |
man_endparse(struct man *man) |
man_endparse(struct man *man) |
{ |
{ |
Line 123 man_endparse(struct man *man) |
|
Line 123 man_endparse(struct man *man) |
|
return(0); |
return(0); |
} |
} |
|
|
|
|
int |
int |
man_parseln(struct man *man, int ln, char *buf, int offs) |
man_parseln(struct man *man, int ln, char *buf, int offs) |
{ |
{ |
Line 133 man_parseln(struct man *man, int ln, char *buf, int of |
|
Line 132 man_parseln(struct man *man, int ln, char *buf, int of |
|
assert( ! (MAN_HALT & man->flags)); |
assert( ! (MAN_HALT & man->flags)); |
|
|
return (roff_getcontrol(man->roff, buf, &offs) ? |
return (roff_getcontrol(man->roff, buf, &offs) ? |
man_pmacro(man, ln, buf, offs) : |
man_pmacro(man, ln, buf, offs) : |
man_ptext(man, ln, buf, offs)); |
man_ptext(man, ln, buf, offs)); |
} |
} |
|
|
|
|
static void |
static void |
man_free1(struct man *man) |
man_free1(struct man *man) |
{ |
{ |
Line 156 man_free1(struct man *man) |
|
Line 154 man_free1(struct man *man) |
|
free(man->meta.msec); |
free(man->meta.msec); |
} |
} |
|
|
|
|
static void |
static void |
man_alloc1(struct man *man) |
man_alloc1(struct man *man) |
{ |
{ |
Line 180 man_node_append(struct man *man, struct man_node *p) |
|
Line 177 man_node_append(struct man *man, struct man_node *p) |
|
assert(MAN_ROOT != p->type); |
assert(MAN_ROOT != p->type); |
|
|
switch (man->next) { |
switch (man->next) { |
case (MAN_NEXT_SIBLING): |
case MAN_NEXT_SIBLING: |
man->last->next = p; |
man->last->next = p; |
p->prev = man->last; |
p->prev = man->last; |
p->parent = man->last->parent; |
p->parent = man->last->parent; |
break; |
break; |
case (MAN_NEXT_CHILD): |
case MAN_NEXT_CHILD: |
man->last->child = p; |
man->last->child = p; |
p->parent = man->last; |
p->parent = man->last; |
break; |
break; |
Line 193 man_node_append(struct man *man, struct man_node *p) |
|
Line 190 man_node_append(struct man *man, struct man_node *p) |
|
abort(); |
abort(); |
/* NOTREACHED */ |
/* NOTREACHED */ |
} |
} |
|
|
assert(p->parent); |
assert(p->parent); |
p->parent->nchild++; |
p->parent->nchild++; |
|
|
Line 201 man_node_append(struct man *man, struct man_node *p) |
|
Line 198 man_node_append(struct man *man, struct man_node *p) |
|
return(0); |
return(0); |
|
|
switch (p->type) { |
switch (p->type) { |
case (MAN_HEAD): |
case MAN_HEAD: |
assert(MAN_BLOCK == p->parent->type); |
assert(MAN_BLOCK == p->parent->type); |
p->parent->head = p; |
p->parent->head = p; |
break; |
break; |
case (MAN_TAIL): |
case MAN_TAIL: |
assert(MAN_BLOCK == p->parent->type); |
assert(MAN_BLOCK == p->parent->type); |
p->parent->tail = p; |
p->parent->tail = p; |
break; |
break; |
case (MAN_BODY): |
case MAN_BODY: |
assert(MAN_BLOCK == p->parent->type); |
assert(MAN_BLOCK == p->parent->type); |
p->parent->body = p; |
p->parent->body = p; |
break; |
break; |
Line 220 man_node_append(struct man *man, struct man_node *p) |
|
Line 217 man_node_append(struct man *man, struct man_node *p) |
|
man->last = p; |
man->last = p; |
|
|
switch (p->type) { |
switch (p->type) { |
case (MAN_TBL): |
case MAN_TBL: |
/* FALLTHROUGH */ |
/* FALLTHROUGH */ |
case (MAN_TEXT): |
case MAN_TEXT: |
if ( ! man_valid_post(man)) |
if ( ! man_valid_post(man)) |
return(0); |
return(0); |
break; |
break; |
Line 233 man_node_append(struct man *man, struct man_node *p) |
|
Line 230 man_node_append(struct man *man, struct man_node *p) |
|
return(1); |
return(1); |
} |
} |
|
|
|
|
static struct man_node * |
static struct man_node * |
man_node_alloc(struct man *man, int line, int pos, |
man_node_alloc(struct man *man, int line, int pos, |
enum man_type type, enum mant tok) |
enum man_type type, enum mant tok) |
{ |
{ |
struct man_node *p; |
struct man_node *p; |
Line 252 man_node_alloc(struct man *man, int line, int pos, |
|
Line 248 man_node_alloc(struct man *man, int line, int pos, |
|
return(p); |
return(p); |
} |
} |
|
|
|
|
int |
int |
man_elem_alloc(struct man *man, int line, int pos, enum mant tok) |
man_elem_alloc(struct man *man, int line, int pos, enum mant tok) |
{ |
{ |
Line 265 man_elem_alloc(struct man *man, int line, int pos, enu |
|
Line 260 man_elem_alloc(struct man *man, int line, int pos, enu |
|
return(1); |
return(1); |
} |
} |
|
|
|
|
int |
int |
man_tail_alloc(struct man *man, int line, int pos, enum mant tok) |
man_tail_alloc(struct man *man, int line, int pos, enum mant tok) |
{ |
{ |
Line 278 man_tail_alloc(struct man *man, int line, int pos, enu |
|
Line 272 man_tail_alloc(struct man *man, int line, int pos, enu |
|
return(1); |
return(1); |
} |
} |
|
|
|
|
int |
int |
man_head_alloc(struct man *man, int line, int pos, enum mant tok) |
man_head_alloc(struct man *man, int line, int pos, enum mant tok) |
{ |
{ |
Line 291 man_head_alloc(struct man *man, int line, int pos, enu |
|
Line 284 man_head_alloc(struct man *man, int line, int pos, enu |
|
return(1); |
return(1); |
} |
} |
|
|
|
|
int |
int |
man_body_alloc(struct man *man, int line, int pos, enum mant tok) |
man_body_alloc(struct man *man, int line, int pos, enum mant tok) |
{ |
{ |
Line 304 man_body_alloc(struct man *man, int line, int pos, enu |
|
Line 296 man_body_alloc(struct man *man, int line, int pos, enu |
|
return(1); |
return(1); |
} |
} |
|
|
|
|
int |
int |
man_block_alloc(struct man *man, int line, int pos, enum mant tok) |
man_block_alloc(struct man *man, int line, int pos, enum mant tok) |
{ |
{ |
Line 332 man_word_alloc(struct man *man, int line, int pos, con |
|
Line 323 man_word_alloc(struct man *man, int line, int pos, con |
|
return(1); |
return(1); |
} |
} |
|
|
|
|
/* |
/* |
* Free all of the resources held by a node. This does NOT unlink a |
* Free all of the resources held by a node. This does NOT unlink a |
* node from its context; for that, see man_node_unlink(). |
* node from its context; for that, see man_node_unlink(). |
Line 346 man_node_free(struct man_node *p) |
|
Line 336 man_node_free(struct man_node *p) |
|
free(p); |
free(p); |
} |
} |
|
|
|
|
void |
void |
man_node_delete(struct man *man, struct man_node *p) |
man_node_delete(struct man *man, struct man_node *p) |
{ |
{ |
Line 403 man_descope(struct man *man, int line, int offs) |
|
Line 392 man_descope(struct man *man, int line, int offs) |
|
|
|
if (MAN_ELINE & man->flags) { |
if (MAN_ELINE & man->flags) { |
man->flags &= ~MAN_ELINE; |
man->flags &= ~MAN_ELINE; |
if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX)) |
if ( ! man_unscope(man, man->last->parent)) |
return(0); |
return(0); |
} |
} |
|
|
Line 411 man_descope(struct man *man, int line, int offs) |
|
Line 400 man_descope(struct man *man, int line, int offs) |
|
return(1); |
return(1); |
man->flags &= ~MAN_BLINE; |
man->flags &= ~MAN_BLINE; |
|
|
if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX)) |
if ( ! man_unscope(man, man->last->parent)) |
return(0); |
return(0); |
return(man_body_alloc(man, line, offs, man->last->tok)); |
return(man_body_alloc(man, line, offs, man->last->tok)); |
} |
} |
Line 448 man_ptext(struct man *man, int line, char *buf, int of |
|
Line 437 man_ptext(struct man *man, int line, char *buf, int of |
|
return(1); |
return(1); |
} |
} |
|
|
/* |
/* |
* Warn if the last un-escaped character is whitespace. Then |
* Warn if the last un-escaped character is whitespace. Then |
* strip away the remaining spaces (tabs stay!). |
* strip away the remaining spaces (tabs stay!). |
*/ |
*/ |
|
|
i = (int)strlen(buf); |
i = (int)strlen(buf); |
Line 458 man_ptext(struct man *man, int line, char *buf, int of |
|
Line 447 man_ptext(struct man *man, int line, char *buf, int of |
|
|
|
if (' ' == buf[i - 1] || '\t' == buf[i - 1]) { |
if (' ' == buf[i - 1] || '\t' == buf[i - 1]) { |
if (i > 1 && '\\' != buf[i - 2]) |
if (i > 1 && '\\' != buf[i - 2]) |
man_pmsg(man, line, i - 1, MANDOCERR_EOLNSPACE); |
mandoc_msg(MANDOCERR_SPACE_EOL, man->parse, |
|
line, i - 1, NULL); |
|
|
for (--i; i && ' ' == buf[i]; i--) |
for (--i; i && ' ' == buf[i]; i--) |
/* Spin back to non-space. */ ; |
/* Spin back to non-space. */ ; |
Line 479 man_ptext(struct man *man, int line, char *buf, int of |
|
Line 469 man_ptext(struct man *man, int line, char *buf, int of |
|
*/ |
*/ |
|
|
assert(i); |
assert(i); |
if (mandoc_eos(buf, (size_t)i, 0)) |
if (mandoc_eos(buf, (size_t)i)) |
man->last->flags |= MAN_EOS; |
man->last->flags |= MAN_EOS; |
|
|
return(man_descope(man, line, offs)); |
return(man_descope(man, line, offs)); |
Line 494 man_pmacro(struct man *man, int ln, char *buf, int off |
|
Line 484 man_pmacro(struct man *man, int ln, char *buf, int off |
|
struct man_node *n; |
struct man_node *n; |
|
|
if ('"' == buf[offs]) { |
if ('"' == buf[offs]) { |
man_pmsg(man, ln, offs, MANDOCERR_BADCOMMENT); |
mandoc_msg(MANDOCERR_COMMENT_BAD, man->parse, |
|
ln, offs, NULL); |
return(1); |
return(1); |
} else if ('\0' == buf[offs]) |
} else if ('\0' == buf[offs]) |
return(1); |
return(1); |
Line 507 man_pmacro(struct man *man, int ln, char *buf, int off |
|
Line 498 man_pmacro(struct man *man, int ln, char *buf, int off |
|
*/ |
*/ |
|
|
i = 0; |
i = 0; |
while (i < 4 && '\0' != buf[offs] && |
while (i < 4 && '\0' != buf[offs] && ' ' != buf[offs] && |
' ' != buf[offs] && '\t' != buf[offs]) |
'\t' != buf[offs]) |
mac[i++] = buf[offs++]; |
mac[i++] = buf[offs++]; |
|
|
mac[i] = '\0'; |
mac[i] = '\0'; |
Line 516 man_pmacro(struct man *man, int ln, char *buf, int off |
|
Line 507 man_pmacro(struct man *man, int ln, char *buf, int off |
|
tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX; |
tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX; |
|
|
if (MAN_MAX == tok) { |
if (MAN_MAX == tok) { |
mandoc_vmsg(MANDOCERR_MACRO, man->parse, ln, |
mandoc_vmsg(MANDOCERR_MACRO, man->parse, ln, ppos, |
ppos, "%s", buf + ppos - 1); |
"%s", buf + ppos - 1); |
return(1); |
return(1); |
} |
} |
|
|
Line 526 man_pmacro(struct man *man, int ln, char *buf, int off |
|
Line 517 man_pmacro(struct man *man, int ln, char *buf, int off |
|
while (buf[offs] && ' ' == buf[offs]) |
while (buf[offs] && ' ' == buf[offs]) |
offs++; |
offs++; |
|
|
/* |
/* |
* Trailing whitespace. Note that tabs are allowed to be passed |
* Trailing whitespace. Note that tabs are allowed to be passed |
* into the parser as "text", so we only warn about spaces here. |
* into the parser as "text", so we only warn about spaces here. |
*/ |
*/ |
|
|
if ('\0' == buf[offs] && ' ' == buf[offs - 1]) |
if ('\0' == buf[offs] && ' ' == buf[offs - 1]) |
man_pmsg(man, ln, offs - 1, MANDOCERR_EOLNSPACE); |
mandoc_msg(MANDOCERR_SPACE_EOL, man->parse, |
|
ln, offs - 1, NULL); |
|
|
/* |
/* |
* Remove prior ELINE macro, as it's being clobbered by a new |
* Remove prior ELINE macro, as it's being clobbered by a new |
* macro. Note that NSCOPED macros do not close out ELINE |
* macro. Note that NSCOPED macros do not close out ELINE |
* macros---they don't print text---so we let those slip by. |
* macros---they don't print text---so we let those slip by. |
Line 550 man_pmacro(struct man *man, int ln, char *buf, int off |
|
Line 542 man_pmacro(struct man *man, int ln, char *buf, int off |
|
if (MAN_NSCOPED & man_macros[n->tok].flags) |
if (MAN_NSCOPED & man_macros[n->tok].flags) |
n = n->parent; |
n = n->parent; |
|
|
mandoc_vmsg(MANDOCERR_LINESCOPE, man->parse, n->line, |
mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, n->line, |
n->pos, "%s breaks %s", man_macronames[tok], |
n->pos, "%s breaks %s", man_macronames[tok], |
man_macronames[n->tok]); |
man_macronames[n->tok]); |
|
|
Line 581 man_pmacro(struct man *man, int ln, char *buf, int off |
|
Line 573 man_pmacro(struct man *man, int ln, char *buf, int off |
|
assert(MAN_BLOCK == n->type); |
assert(MAN_BLOCK == n->type); |
assert(MAN_SCOPED & man_macros[n->tok].flags); |
assert(MAN_SCOPED & man_macros[n->tok].flags); |
|
|
mandoc_vmsg(MANDOCERR_LINESCOPE, man->parse, n->line, |
mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, n->line, |
n->pos, "%s breaks %s", man_macronames[tok], |
n->pos, "%s breaks %s", man_macronames[tok], |
man_macronames[n->tok]); |
man_macronames[n->tok]); |
|
|
Line 604 man_pmacro(struct man *man, int ln, char *buf, int off |
|
Line 596 man_pmacro(struct man *man, int ln, char *buf, int off |
|
if ( ! (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf)) |
if ( ! (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf)) |
goto err; |
goto err; |
|
|
/* |
/* In quick mode (for mandocdb), abort after the NAME section. */ |
|
|
|
if (man->quick && MAN_SH == tok) { |
|
n = man->last; |
|
if (MAN_BODY == n->type && |
|
strcmp(n->prev->child->string, "NAME")) |
|
return(2); |
|
} |
|
|
|
/* |
* We weren't in a block-line scope when entering the |
* We weren't in a block-line scope when entering the |
* above-parsed macro, so return. |
* above-parsed macro, so return. |
*/ |
*/ |
|
|
if ( ! (MAN_BPLINE & man->flags)) { |
if ( ! (MAN_BPLINE & man->flags)) { |
man->flags &= ~MAN_ILINE; |
man->flags &= ~MAN_ILINE; |
return(1); |
return(1); |
} |
} |
man->flags &= ~MAN_BPLINE; |
man->flags &= ~MAN_BPLINE; |
Line 625 man_pmacro(struct man *man, int ln, char *buf, int off |
|
Line 626 man_pmacro(struct man *man, int ln, char *buf, int off |
|
return(1); |
return(1); |
} |
} |
|
|
/* |
/* |
* If we've opened a new next-line element scope, then return |
* If we've opened a new next-line element scope, then return |
* now, as the next line will close out the block scope. |
* now, as the next line will close out the block scope. |
*/ |
*/ |
Line 638 man_pmacro(struct man *man, int ln, char *buf, int off |
|
Line 639 man_pmacro(struct man *man, int ln, char *buf, int off |
|
assert(MAN_BLINE & man->flags); |
assert(MAN_BLINE & man->flags); |
man->flags &= ~MAN_BLINE; |
man->flags &= ~MAN_BLINE; |
|
|
if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX)) |
if ( ! man_unscope(man, man->last->parent)) |
return(0); |
return(0); |
return(man_body_alloc(man, ln, ppos, man->last->tok)); |
return(man_body_alloc(man, ln, ppos, man->last->tok)); |
|
|
Line 695 man_mparse(const struct man *man) |
|
Line 696 man_mparse(const struct man *man) |
|
|
|
assert(man && man->parse); |
assert(man && man->parse); |
return(man->parse); |
return(man->parse); |
|
} |
|
|
|
void |
|
man_deroff(char **dest, const struct man_node *n) |
|
{ |
|
char *cp; |
|
size_t sz; |
|
|
|
if (MAN_TEXT != n->type) { |
|
for (n = n->child; n; n = n->next) |
|
man_deroff(dest, n); |
|
return; |
|
} |
|
|
|
/* Skip leading whitespace and escape sequences. */ |
|
|
|
cp = n->string; |
|
while ('\0' != *cp) { |
|
if ('\\' == *cp) { |
|
cp++; |
|
mandoc_escape((const char **)&cp, NULL, NULL); |
|
} else if (isspace((unsigned char)*cp)) |
|
cp++; |
|
else |
|
break; |
|
} |
|
|
|
/* Skip trailing whitespace. */ |
|
|
|
for (sz = strlen(cp); sz; sz--) |
|
if (0 == isspace((unsigned char)cp[sz-1])) |
|
break; |
|
|
|
/* Skip empty strings. */ |
|
|
|
if (0 == sz) |
|
return; |
|
|
|
if (NULL == *dest) { |
|
*dest = mandoc_strndup(cp, sz); |
|
return; |
|
} |
|
|
|
mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp); |
|
free(*dest); |
|
*dest = cp; |
} |
} |