version 1.146, 2014/12/28 14:42:27 |
version 1.152, 2015/04/02 23:48:19 |
|
|
/* $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) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.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 |
* 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 <stdio.h> |
#include <stdio.h> |
#include <string.h> |
#include <string.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 "libman.h" |
|
|
const char *const __man_macronames[MAN_MAX] = { |
const char *const __man_macronames[MAN_MAX] = { |
"br", "TH", "SH", "SS", |
"br", "TH", "SH", "SS", |
Line 39 const char *const __man_macronames[MAN_MAX] = { |
|
Line 40 const char *const __man_macronames[MAN_MAX] = { |
|
"IP", "HP", "SM", "SB", |
"IP", "HP", "SM", "SB", |
"BI", "IB", "BR", "RB", |
"BI", "IB", "BR", "RB", |
"R", "B", "I", "IR", |
"R", "B", "I", "IR", |
"RI", "na", "sp", "nf", |
"RI", "sp", "nf", |
"fi", "RE", "RS", "DT", |
"fi", "RE", "RS", "DT", |
"UC", "PD", "AT", "in", |
"UC", "PD", "AT", "in", |
"ft", "OP", "EX", "EE", |
"ft", "OP", "EX", "EE", |
Line 48 const char *const __man_macronames[MAN_MAX] = { |
|
Line 49 const char *const __man_macronames[MAN_MAX] = { |
|
|
|
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, |
|
enum man_type, enum mant); |
|
static void man_node_append(struct man *, struct man_node *); |
|
static void man_node_free(struct man_node *); |
|
static void man_node_unlink(struct man *, |
|
struct man_node *); |
|
static int man_ptext(struct man *, int, char *, int); |
|
static int man_pmacro(struct man *, int, char *, int); |
|
static void man_free1(struct man *); |
|
static void man_alloc1(struct man *); |
static void man_alloc1(struct man *); |
|
static void man_breakscope(struct man *, int); |
static void man_descope(struct man *, int, int); |
static void man_descope(struct man *, int, int); |
|
static void man_free1(struct man *); |
|
static struct roff_node *man_node_alloc(struct man *, int, int, |
|
enum roff_type, int); |
|
static void man_node_append(struct man *, struct roff_node *); |
|
static void man_node_free(struct roff_node *); |
|
static void man_node_unlink(struct man *, struct roff_node *); |
|
static int man_ptext(struct man *, int, char *, int); |
|
static int man_pmacro(struct man *, int, char *, int); |
|
|
|
|
const struct man_node * |
const struct roff_node * |
man_node(const struct man *man) |
man_node(const struct man *man) |
{ |
{ |
|
|
return(man->first); |
return(man->first); |
} |
} |
|
|
const struct man_meta * |
const struct roff_meta * |
man_meta(const struct man *man) |
man_meta(const struct man *man) |
{ |
{ |
|
|
Line 109 man_alloc(struct roff *roff, struct mparse *parse, |
|
Line 110 man_alloc(struct roff *roff, struct mparse *parse, |
|
return(p); |
return(p); |
} |
} |
|
|
int |
void |
man_endparse(struct man *man) |
man_endparse(struct man *man) |
{ |
{ |
|
|
man_macroend(man); |
man_macroend(man); |
return(1); |
|
} |
} |
|
|
int |
int |
man_parseln(struct man *man, int ln, char *buf, int offs) |
man_parseln(struct man *man, int ln, char *buf, int offs) |
{ |
{ |
|
|
if (man->last->type != MAN_EQN || ln > man->last->line) |
if (man->last->type != ROFFT_EQN || ln > man->last->line) |
man->flags |= MAN_NEWLINE; |
man->flags |= MAN_NEWLINE; |
|
|
return (roff_getcontrol(man->roff, buf, &offs) ? |
return (roff_getcontrol(man->roff, buf, &offs) ? |
Line 136 man_free1(struct man *man) |
|
Line 136 man_free1(struct man *man) |
|
if (man->first) |
if (man->first) |
man_node_delete(man, man->first); |
man_node_delete(man, man->first); |
free(man->meta.title); |
free(man->meta.title); |
free(man->meta.source); |
free(man->meta.os); |
free(man->meta.date); |
free(man->meta.date); |
free(man->meta.vol); |
free(man->meta.vol); |
free(man->meta.msec); |
free(man->meta.msec); |
|
|
man_alloc1(struct man *man) |
man_alloc1(struct man *man) |
{ |
{ |
|
|
memset(&man->meta, 0, sizeof(struct man_meta)); |
memset(&man->meta, 0, sizeof(man->meta)); |
man->flags = 0; |
man->flags = 0; |
man->last = mandoc_calloc(1, sizeof(struct man_node)); |
man->last = mandoc_calloc(1, sizeof(*man->last)); |
man->first = man->last; |
man->first = man->last; |
man->last->type = MAN_ROOT; |
man->last->type = ROFFT_ROOT; |
man->last->tok = MAN_MAX; |
man->last->tok = MAN_MAX; |
man->next = MAN_NEXT_CHILD; |
man->next = MAN_NEXT_CHILD; |
} |
} |
|
|
|
|
static void |
static void |
man_node_append(struct man *man, struct man_node *p) |
man_node_append(struct man *man, struct roff_node *p) |
{ |
{ |
|
|
assert(man->last); |
assert(man->last); |
assert(man->first); |
assert(man->first); |
assert(p->type != MAN_ROOT); |
assert(p->type != ROFFT_ROOT); |
|
|
switch (man->next) { |
switch (man->next) { |
case MAN_NEXT_SIBLING: |
case MAN_NEXT_SIBLING: |
Line 183 man_node_append(struct man *man, struct man_node *p) |
|
Line 183 man_node_append(struct man *man, struct man_node *p) |
|
p->parent->nchild++; |
p->parent->nchild++; |
|
|
switch (p->type) { |
switch (p->type) { |
case MAN_BLOCK: |
case ROFFT_BLOCK: |
if (p->tok == MAN_SH || p->tok == MAN_SS) |
if (p->tok == MAN_SH || p->tok == MAN_SS) |
man->flags &= ~MAN_LITERAL; |
man->flags &= ~MAN_LITERAL; |
break; |
break; |
case MAN_HEAD: |
case ROFFT_HEAD: |
assert(p->parent->type == MAN_BLOCK); |
assert(p->parent->type == ROFFT_BLOCK); |
p->parent->head = p; |
p->parent->head = p; |
break; |
break; |
case MAN_BODY: |
case ROFFT_BODY: |
assert(p->parent->type == MAN_BLOCK); |
assert(p->parent->type == ROFFT_BLOCK); |
p->parent->body = p; |
p->parent->body = p; |
break; |
break; |
default: |
default: |
Line 202 man_node_append(struct man *man, struct man_node *p) |
|
Line 202 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 ROFFT_TBL: |
/* FALLTHROUGH */ |
/* FALLTHROUGH */ |
case MAN_TEXT: |
case ROFFT_TEXT: |
man_valid_post(man); |
man_valid_post(man); |
break; |
break; |
default: |
default: |
Line 212 man_node_append(struct man *man, struct man_node *p) |
|
Line 212 man_node_append(struct man *man, struct man_node *p) |
|
} |
} |
} |
} |
|
|
static struct man_node * |
static struct roff_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 roff_type type, int tok) |
{ |
{ |
struct man_node *p; |
struct roff_node *p; |
|
|
p = mandoc_calloc(1, sizeof(struct man_node)); |
p = mandoc_calloc(1, sizeof(*p)); |
p->line = line; |
p->line = line; |
p->pos = pos; |
p->pos = pos; |
p->type = type; |
p->type = type; |
Line 231 man_node_alloc(struct man *man, int line, int pos, |
|
Line 231 man_node_alloc(struct man *man, int line, int pos, |
|
} |
} |
|
|
void |
void |
man_elem_alloc(struct man *man, int line, int pos, enum mant tok) |
man_elem_alloc(struct man *man, int line, int pos, int tok) |
{ |
{ |
struct man_node *p; |
struct roff_node *p; |
|
|
p = man_node_alloc(man, line, pos, MAN_ELEM, tok); |
p = man_node_alloc(man, line, pos, ROFFT_ELEM, tok); |
man_node_append(man, p); |
man_node_append(man, p); |
man->next = MAN_NEXT_CHILD; |
man->next = MAN_NEXT_CHILD; |
} |
} |
|
|
void |
void |
man_head_alloc(struct man *man, int line, int pos, enum mant tok) |
man_head_alloc(struct man *man, int line, int pos, int tok) |
{ |
{ |
struct man_node *p; |
struct roff_node *p; |
|
|
p = man_node_alloc(man, line, pos, MAN_HEAD, tok); |
p = man_node_alloc(man, line, pos, ROFFT_HEAD, tok); |
man_node_append(man, p); |
man_node_append(man, p); |
man->next = MAN_NEXT_CHILD; |
man->next = MAN_NEXT_CHILD; |
} |
} |
|
|
void |
void |
man_body_alloc(struct man *man, int line, int pos, enum mant tok) |
man_body_alloc(struct man *man, int line, int pos, int tok) |
{ |
{ |
struct man_node *p; |
struct roff_node *p; |
|
|
p = man_node_alloc(man, line, pos, MAN_BODY, tok); |
p = man_node_alloc(man, line, pos, ROFFT_BODY, tok); |
man_node_append(man, p); |
man_node_append(man, p); |
man->next = MAN_NEXT_CHILD; |
man->next = MAN_NEXT_CHILD; |
} |
} |
|
|
void |
void |
man_block_alloc(struct man *man, int line, int pos, enum mant tok) |
man_block_alloc(struct man *man, int line, int pos, int tok) |
{ |
{ |
struct man_node *p; |
struct roff_node *p; |
|
|
p = man_node_alloc(man, line, pos, MAN_BLOCK, tok); |
p = man_node_alloc(man, line, pos, ROFFT_BLOCK, tok); |
man_node_append(man, p); |
man_node_append(man, p); |
man->next = MAN_NEXT_CHILD; |
man->next = MAN_NEXT_CHILD; |
} |
} |
Line 273 man_block_alloc(struct man *man, int line, int pos, en |
|
Line 273 man_block_alloc(struct man *man, int line, int pos, en |
|
void |
void |
man_word_alloc(struct man *man, int line, int pos, const char *word) |
man_word_alloc(struct man *man, int line, int pos, const char *word) |
{ |
{ |
struct man_node *n; |
struct roff_node *n; |
|
|
n = man_node_alloc(man, line, pos, MAN_TEXT, MAN_MAX); |
n = man_node_alloc(man, line, pos, ROFFT_TEXT, MAN_MAX); |
n->string = roff_strdup(man->roff, word); |
n->string = roff_strdup(man->roff, word); |
man_node_append(man, n); |
man_node_append(man, n); |
man->next = MAN_NEXT_SIBLING; |
man->next = MAN_NEXT_SIBLING; |
Line 284 man_word_alloc(struct man *man, int line, int pos, con |
|
Line 284 man_word_alloc(struct man *man, int line, int pos, con |
|
void |
void |
man_word_append(struct man *man, const char *word) |
man_word_append(struct man *man, const char *word) |
{ |
{ |
struct man_node *n; |
struct roff_node *n; |
char *addstr, *newstr; |
char *addstr, *newstr; |
|
|
n = man->last; |
n = man->last; |
Line 301 man_word_append(struct man *man, const char *word) |
|
Line 301 man_word_append(struct man *man, const char *word) |
|
* node from its context; for that, see man_node_unlink(). |
* node from its context; for that, see man_node_unlink(). |
*/ |
*/ |
static void |
static void |
man_node_free(struct man_node *p) |
man_node_free(struct roff_node *p) |
{ |
{ |
|
|
free(p->string); |
free(p->string); |
Line 309 man_node_free(struct man_node *p) |
|
Line 309 man_node_free(struct man_node *p) |
|
} |
} |
|
|
void |
void |
man_node_delete(struct man *man, struct man_node *p) |
man_node_delete(struct man *man, struct roff_node *p) |
{ |
{ |
|
|
while (p->child) |
while (p->child) |
Line 322 man_node_delete(struct man *man, struct man_node *p) |
|
Line 322 man_node_delete(struct man *man, struct man_node *p) |
|
void |
void |
man_addeqn(struct man *man, const struct eqn *ep) |
man_addeqn(struct man *man, const struct eqn *ep) |
{ |
{ |
struct man_node *n; |
struct roff_node *n; |
|
|
n = man_node_alloc(man, ep->ln, ep->pos, MAN_EQN, MAN_MAX); |
n = man_node_alloc(man, ep->ln, ep->pos, ROFFT_EQN, MAN_MAX); |
n->eqn = ep; |
n->eqn = ep; |
if (ep->ln > man->last->line) |
if (ep->ln > man->last->line) |
n->flags |= MAN_LINE; |
n->flags |= MAN_LINE; |
Line 336 man_addeqn(struct man *man, const struct eqn *ep) |
|
Line 336 man_addeqn(struct man *man, const struct eqn *ep) |
|
void |
void |
man_addspan(struct man *man, const struct tbl_span *sp) |
man_addspan(struct man *man, const struct tbl_span *sp) |
{ |
{ |
struct man_node *n; |
struct roff_node *n; |
|
|
n = man_node_alloc(man, sp->line, 0, MAN_TBL, MAN_MAX); |
man_breakscope(man, MAN_MAX); |
|
n = man_node_alloc(man, sp->line, 0, ROFFT_TBL, MAN_MAX); |
n->span = sp; |
n->span = sp; |
man_node_append(man, n); |
man_node_append(man, n); |
man->next = MAN_NEXT_SIBLING; |
man->next = MAN_NEXT_SIBLING; |
Line 436 man_ptext(struct man *man, int line, char *buf, int of |
|
Line 437 man_ptext(struct man *man, int line, char *buf, int of |
|
static int |
static int |
man_pmacro(struct man *man, int ln, char *buf, int offs) |
man_pmacro(struct man *man, int ln, char *buf, int offs) |
{ |
{ |
struct man_node *n; |
struct roff_node *n; |
const char *cp; |
const char *cp; |
enum mant tok; |
int tok; |
int i, ppos; |
int i, ppos; |
int bline; |
int bline; |
char mac[5]; |
char mac[5]; |
Line 494 man_pmacro(struct man *man, int ln, char *buf, int off |
|
Line 495 man_pmacro(struct man *man, int ln, char *buf, int off |
|
ln, offs - 1, NULL); |
ln, offs - 1, NULL); |
|
|
/* |
/* |
* Remove prior ELINE macro, as it's being clobbered by a new |
* Some macros break next-line scopes; otherwise, remember |
* macro. Note that NSCOPED macros do not close out ELINE |
* whether we are in next-line scope for a block head. |
* macros---they don't print text---so we let those slip by. |
|
*/ |
*/ |
|
|
if ( ! (man_macros[tok].flags & MAN_NSCOPED) && |
man_breakscope(man, tok); |
man->flags & MAN_ELINE) { |
|
n = man->last; |
|
assert(MAN_TEXT != n->type); |
|
|
|
/* Remove repeated NSCOPED macros causing ELINE. */ |
|
|
|
if (man_macros[n->tok].flags & MAN_NSCOPED) |
|
n = n->parent; |
|
|
|
mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, n->line, |
|
n->pos, "%s breaks %s", man_macronames[tok], |
|
man_macronames[n->tok]); |
|
|
|
man_node_delete(man, n); |
|
man->flags &= ~MAN_ELINE; |
|
} |
|
|
|
/* |
|
* Remove prior BLINE macro that is being clobbered. |
|
*/ |
|
if ((man->flags & MAN_BLINE) && |
|
(man_macros[tok].flags & MAN_BSCOPE)) { |
|
n = man->last; |
|
|
|
/* Might be a text node like 8 in |
|
* .TP 8 |
|
* .SH foo |
|
*/ |
|
if (n->type == MAN_TEXT) |
|
n = n->parent; |
|
|
|
/* Remove element that didn't end BLINE, if any. */ |
|
if ( ! (man_macros[n->tok].flags & MAN_BSCOPE)) |
|
n = n->parent; |
|
|
|
assert(n->type == MAN_HEAD); |
|
n = n->parent; |
|
assert(n->type == MAN_BLOCK); |
|
assert(man_macros[n->tok].flags & MAN_SCOPED); |
|
|
|
mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, n->line, |
|
n->pos, "%s breaks %s", man_macronames[tok], |
|
man_macronames[n->tok]); |
|
|
|
man_node_delete(man, n); |
|
man->flags &= ~MAN_BLINE; |
|
} |
|
|
|
/* Remember whether we are in next-line scope for a block head. */ |
|
|
|
bline = man->flags & MAN_BLINE; |
bline = man->flags & MAN_BLINE; |
|
|
/* Call to handler... */ |
/* Call to handler... */ |
Line 561 man_pmacro(struct man *man, int ln, char *buf, int off |
|
Line 511 man_pmacro(struct man *man, int ln, char *buf, int off |
|
|
|
if (man->quick && tok == MAN_SH) { |
if (man->quick && tok == MAN_SH) { |
n = man->last; |
n = man->last; |
if (n->type == MAN_BODY && |
if (n->type == ROFFT_BODY && |
strcmp(n->prev->child->string, "NAME")) |
strcmp(n->prev->child->string, "NAME")) |
return(2); |
return(2); |
} |
} |
Line 584 man_pmacro(struct man *man, int ln, char *buf, int off |
|
Line 534 man_pmacro(struct man *man, int ln, char *buf, int off |
|
return(1); |
return(1); |
} |
} |
|
|
|
void |
|
man_breakscope(struct man *man, int tok) |
|
{ |
|
struct roff_node *n; |
|
|
|
/* |
|
* An element next line scope is open, |
|
* and the new macro is not allowed inside elements. |
|
* Delete the element that is being broken. |
|
*/ |
|
|
|
if (man->flags & MAN_ELINE && (tok == MAN_MAX || |
|
! (man_macros[tok].flags & MAN_NSCOPED))) { |
|
n = man->last; |
|
assert(n->type != ROFFT_TEXT); |
|
if (man_macros[n->tok].flags & MAN_NSCOPED) |
|
n = n->parent; |
|
|
|
mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, |
|
n->line, n->pos, "%s breaks %s", |
|
tok == MAN_MAX ? "TS" : man_macronames[tok], |
|
man_macronames[n->tok]); |
|
|
|
man_node_delete(man, n); |
|
man->flags &= ~MAN_ELINE; |
|
} |
|
|
|
/* |
|
* A block header next line scope is open, |
|
* and the new macro is not allowed inside block headers. |
|
* Delete the block that is being broken. |
|
*/ |
|
|
|
if (man->flags & MAN_BLINE && (tok == MAN_MAX || |
|
man_macros[tok].flags & MAN_BSCOPE)) { |
|
n = man->last; |
|
if (n->type == ROFFT_TEXT) |
|
n = n->parent; |
|
if ( ! (man_macros[n->tok].flags & MAN_BSCOPE)) |
|
n = n->parent; |
|
|
|
assert(n->type == ROFFT_HEAD); |
|
n = n->parent; |
|
assert(n->type == ROFFT_BLOCK); |
|
assert(man_macros[n->tok].flags & MAN_SCOPED); |
|
|
|
mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, |
|
n->line, n->pos, "%s breaks %s", |
|
tok == MAN_MAX ? "TS" : man_macronames[tok], |
|
man_macronames[n->tok]); |
|
|
|
man_node_delete(man, n); |
|
man->flags &= ~MAN_BLINE; |
|
} |
|
} |
|
|
/* |
/* |
* Unlink a node from its context. If "man" is provided, the last parse |
* Unlink a node from its context. If "man" is provided, the last parse |
* point will also be adjusted accordingly. |
* point will also be adjusted accordingly. |
*/ |
*/ |
static void |
static void |
man_node_unlink(struct man *man, struct man_node *n) |
man_node_unlink(struct man *man, struct roff_node *n) |
{ |
{ |
|
|
/* Adjust siblings. */ |
/* Adjust siblings. */ |
Line 634 man_mparse(const struct man *man) |
|
Line 640 man_mparse(const struct man *man) |
|
} |
} |
|
|
void |
void |
man_deroff(char **dest, const struct man_node *n) |
man_deroff(char **dest, const struct roff_node *n) |
{ |
{ |
char *cp; |
char *cp; |
size_t sz; |
size_t sz; |
|
|
if (n->type != MAN_TEXT) { |
if (n->type != ROFFT_TEXT) { |
for (n = n->child; n; n = n->next) |
for (n = n->child; n; n = n->next) |
man_deroff(dest, n); |
man_deroff(dest, n); |
return; |
return; |