version 1.97, 2015/02/06 09:38:43 |
version 1.104, 2015/04/03 23:19:15 |
|
|
* 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 <stdlib.h> |
#include <stdlib.h> |
#include <string.h> |
#include <string.h> |
|
|
#include "man.h" |
|
#include "mandoc.h" |
#include "mandoc.h" |
|
#include "roff.h" |
|
#include "man.h" |
#include "libmandoc.h" |
#include "libmandoc.h" |
#include "libman.h" |
#include "libman.h" |
|
|
enum rew { |
|
REW_REWIND, |
|
REW_NOHALT, |
|
REW_HALT |
|
}; |
|
|
|
static void blk_close(MACRO_PROT_ARGS); |
static void blk_close(MACRO_PROT_ARGS); |
static void blk_exp(MACRO_PROT_ARGS); |
static void blk_exp(MACRO_PROT_ARGS); |
static void blk_imp(MACRO_PROT_ARGS); |
static void blk_imp(MACRO_PROT_ARGS); |
static void in_line_eoln(MACRO_PROT_ARGS); |
static void in_line_eoln(MACRO_PROT_ARGS); |
static int man_args(struct man *, int, |
static int man_args(struct man *, int, |
int *, char *, char **); |
int *, char *, char **); |
|
static void rew_scope(struct man *, int); |
|
|
static void rew_scope(enum man_type, |
|
struct man *, enum mant); |
|
static enum rew rew_dohalt(enum mant, enum man_type, |
|
const struct man_node *); |
|
static enum rew rew_block(enum mant, enum man_type, |
|
const struct man_node *); |
|
|
|
const struct man_macro __man_macros[MAN_MAX] = { |
const struct man_macro __man_macros[MAN_MAX] = { |
{ in_line_eoln, MAN_NSCOPED }, /* br */ |
{ in_line_eoln, MAN_NSCOPED }, /* br */ |
{ in_line_eoln, MAN_BSCOPE }, /* TH */ |
{ in_line_eoln, MAN_BSCOPE }, /* TH */ |
{ blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */ |
{ blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */ |
{ blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */ |
{ blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */ |
{ blk_imp, MAN_BSCOPE | MAN_SCOPED | MAN_FSCOPED }, /* TP */ |
{ blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* TP */ |
{ blk_imp, MAN_BSCOPE }, /* LP */ |
{ blk_imp, MAN_BSCOPE }, /* LP */ |
{ blk_imp, MAN_BSCOPE }, /* PP */ |
{ blk_imp, MAN_BSCOPE }, /* PP */ |
{ blk_imp, MAN_BSCOPE }, /* P */ |
{ blk_imp, MAN_BSCOPE }, /* P */ |
Line 76 const struct man_macro __man_macros[MAN_MAX] = { |
|
Line 65 const struct man_macro __man_macros[MAN_MAX] = { |
|
{ in_line_eoln, MAN_BSCOPE }, /* nf */ |
{ in_line_eoln, MAN_BSCOPE }, /* nf */ |
{ in_line_eoln, MAN_BSCOPE }, /* fi */ |
{ in_line_eoln, MAN_BSCOPE }, /* fi */ |
{ blk_close, MAN_BSCOPE }, /* RE */ |
{ blk_close, MAN_BSCOPE }, /* RE */ |
{ blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */ |
{ blk_exp, MAN_BSCOPE }, /* RS */ |
{ in_line_eoln, 0 }, /* DT */ |
{ in_line_eoln, 0 }, /* DT */ |
{ in_line_eoln, 0 }, /* UC */ |
{ in_line_eoln, 0 }, /* UC */ |
{ in_line_eoln, 0 }, /* PD */ |
{ in_line_eoln, MAN_NSCOPED }, /* PD */ |
{ in_line_eoln, 0 }, /* AT */ |
{ in_line_eoln, 0 }, /* AT */ |
{ in_line_eoln, 0 }, /* in */ |
{ in_line_eoln, 0 }, /* in */ |
{ in_line_eoln, 0 }, /* ft */ |
{ in_line_eoln, 0 }, /* ft */ |
{ in_line_eoln, 0 }, /* OP */ |
{ in_line_eoln, 0 }, /* OP */ |
{ in_line_eoln, MAN_BSCOPE }, /* EX */ |
{ in_line_eoln, MAN_BSCOPE }, /* EX */ |
{ in_line_eoln, MAN_BSCOPE }, /* EE */ |
{ in_line_eoln, MAN_BSCOPE }, /* EE */ |
{ blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* UR */ |
{ blk_exp, MAN_BSCOPE }, /* UR */ |
{ blk_close, MAN_BSCOPE }, /* UE */ |
{ blk_close, MAN_BSCOPE }, /* UE */ |
{ in_line_eoln, 0 }, /* ll */ |
{ in_line_eoln, 0 }, /* ll */ |
}; |
}; |
Line 95 const struct man_macro * const man_macros = __man_macr |
|
Line 84 const struct man_macro * const man_macros = __man_macr |
|
|
|
|
|
void |
void |
man_unscope(struct man *man, const struct man_node *to) |
man_unscope(struct man *man, const struct roff_node *to) |
{ |
{ |
struct man_node *n; |
struct roff_node *n; |
|
|
to = to->parent; |
to = to->parent; |
n = man->last; |
n = man->last; |
Line 115 man_unscope(struct man *man, const struct man_node *to |
|
Line 104 man_unscope(struct man *man, const struct man_node *to |
|
if (man->flags & MAN_ELINE) |
if (man->flags & MAN_ELINE) |
man->flags &= ~MAN_ELINE; |
man->flags &= ~MAN_ELINE; |
else { |
else { |
assert(n->type == MAN_HEAD); |
assert(n->type == ROFFT_HEAD); |
n = n->parent; |
n = n->parent; |
man->flags &= ~MAN_BLINE; |
man->flags &= ~MAN_BLINE; |
} |
} |
Line 124 man_unscope(struct man *man, const struct man_node *to |
|
Line 113 man_unscope(struct man *man, const struct man_node *to |
|
man_node_delete(man, man->last); |
man_node_delete(man, man->last); |
continue; |
continue; |
} |
} |
if (n->type == MAN_BLOCK && |
if (n->type == ROFFT_BLOCK && |
man_macros[n->tok].flags & MAN_EXPLICIT) |
man_macros[n->tok].fp == blk_exp) |
mandoc_msg(MANDOCERR_BLK_NOEND, |
mandoc_msg(MANDOCERR_BLK_NOEND, |
man->parse, n->line, n->pos, |
man->parse, n->line, n->pos, |
man_macronames[n->tok]); |
man_macronames[n->tok]); |
Line 154 man_unscope(struct man *man, const struct man_node *to |
|
Line 143 man_unscope(struct man *man, const struct man_node *to |
|
MAN_NEXT_CHILD : MAN_NEXT_SIBLING; |
MAN_NEXT_CHILD : MAN_NEXT_SIBLING; |
} |
} |
|
|
static enum rew |
|
rew_block(enum mant ntok, enum man_type type, const struct man_node *n) |
|
{ |
|
|
|
if (type == MAN_BLOCK && ntok == n->parent->tok && |
|
n->parent->type == MAN_BODY) |
|
return(REW_REWIND); |
|
return(ntok == n->tok ? REW_HALT : REW_NOHALT); |
|
} |
|
|
|
/* |
/* |
* There are three scope levels: scoped to the root (all), scoped to the |
|
* section (all less sections), and scoped to subsections (all less |
|
* sections and subsections). |
|
*/ |
|
static enum rew |
|
rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n) |
|
{ |
|
enum rew c; |
|
|
|
/* We cannot progress beyond the root ever. */ |
|
if (MAN_ROOT == n->type) |
|
return(REW_HALT); |
|
|
|
assert(n->parent); |
|
|
|
/* Normal nodes shouldn't go to the level of the root. */ |
|
if (MAN_ROOT == n->parent->type) |
|
return(REW_REWIND); |
|
|
|
/* Already-validated nodes should be closed out. */ |
|
if (MAN_VALID & n->flags) |
|
return(REW_NOHALT); |
|
|
|
/* First: rewind to ourselves. */ |
|
if (type == n->type && tok == n->tok) { |
|
if (MAN_EXPLICIT & man_macros[n->tok].flags) |
|
return(REW_HALT); |
|
else |
|
return(REW_REWIND); |
|
} |
|
|
|
/* |
|
* Next follow the implicit scope-smashings as defined by man.7: |
|
* section, sub-section, etc. |
|
*/ |
|
|
|
switch (tok) { |
|
case MAN_SH: |
|
break; |
|
case MAN_SS: |
|
/* Rewind to a section, if a block. */ |
|
if (REW_NOHALT != (c = rew_block(MAN_SH, type, n))) |
|
return(c); |
|
break; |
|
case MAN_RS: |
|
/* Preserve empty paragraphs before RS. */ |
|
if (0 == n->nchild && (MAN_P == n->tok || |
|
MAN_PP == n->tok || MAN_LP == n->tok)) |
|
return(REW_HALT); |
|
/* Rewind to a subsection, if a block. */ |
|
if (REW_NOHALT != (c = rew_block(MAN_SS, type, n))) |
|
return(c); |
|
/* Rewind to a section, if a block. */ |
|
if (REW_NOHALT != (c = rew_block(MAN_SH, type, n))) |
|
return(c); |
|
break; |
|
default: |
|
/* Rewind to an offsetter, if a block. */ |
|
if (REW_NOHALT != (c = rew_block(MAN_RS, type, n))) |
|
return(c); |
|
/* Rewind to a subsection, if a block. */ |
|
if (REW_NOHALT != (c = rew_block(MAN_SS, type, n))) |
|
return(c); |
|
/* Rewind to a section, if a block. */ |
|
if (REW_NOHALT != (c = rew_block(MAN_SH, type, n))) |
|
return(c); |
|
break; |
|
} |
|
|
|
return(REW_NOHALT); |
|
} |
|
|
|
/* |
|
* Rewinding entails ascending the parse tree until a coherent point, |
* Rewinding entails ascending the parse tree until a coherent point, |
* for example, the `SH' macro will close out any intervening `SS' |
* for example, the `SH' macro will close out any intervening `SS' |
* scopes. When a scope is closed, it must be validated and actioned. |
* scopes. When a scope is closed, it must be validated and actioned. |
*/ |
*/ |
static void |
static void |
rew_scope(enum man_type type, struct man *man, enum mant tok) |
rew_scope(struct man *man, int tok) |
{ |
{ |
struct man_node *n; |
struct roff_node *n; |
enum rew c; |
|
|
|
for (n = man->last; n; n = n->parent) { |
/* Preserve empty paragraphs before RS. */ |
/* |
|
* Whether we should stop immediately (REW_HALT), stop |
|
* and rewind until this point (REW_REWIND), or keep |
|
* rewinding (REW_NOHALT). |
|
*/ |
|
c = rew_dohalt(tok, type, n); |
|
if (REW_HALT == c) |
|
return; |
|
if (REW_REWIND == c) |
|
break; |
|
} |
|
|
|
/* |
n = man->last; |
* Rewind until the current point. Warn if we're a roff |
if (tok == MAN_RS && n->nchild == 0 && |
* instruction that's mowing over explicit scopes. |
(n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP)) |
*/ |
return; |
|
|
man_unscope(man, n); |
for (;;) { |
|
if (n->type == ROFFT_ROOT) |
|
return; |
|
if (n->flags & MAN_VALID) { |
|
n = n->parent; |
|
continue; |
|
} |
|
if (n->type != ROFFT_BLOCK) { |
|
if (n->parent->type == ROFFT_ROOT) { |
|
man_unscope(man, n); |
|
return; |
|
} else { |
|
n = n->parent; |
|
continue; |
|
} |
|
} |
|
if (tok != MAN_SH && (n->tok == MAN_SH || |
|
(tok != MAN_SS && (n->tok == MAN_SS || |
|
man_macros[n->tok].fp == blk_exp)))) |
|
return; |
|
man_unscope(man, n); |
|
n = man->last; |
|
} |
} |
} |
|
|
|
|
Line 276 rew_scope(enum man_type type, struct man *man, enum ma |
|
Line 192 rew_scope(enum man_type type, struct man *man, enum ma |
|
void |
void |
blk_close(MACRO_PROT_ARGS) |
blk_close(MACRO_PROT_ARGS) |
{ |
{ |
enum mant ntok; |
int ntok; |
const struct man_node *nn; |
const struct roff_node *nn; |
char *p; |
char *p; |
int nrew, target; |
int nrew, target; |
|
|
Line 288 blk_close(MACRO_PROT_ARGS) |
|
Line 204 blk_close(MACRO_PROT_ARGS) |
|
if ( ! man_args(man, line, pos, buf, &p)) |
if ( ! man_args(man, line, pos, buf, &p)) |
break; |
break; |
for (nn = man->last->parent; nn; nn = nn->parent) |
for (nn = man->last->parent; nn; nn = nn->parent) |
if (nn->tok == ntok && nn->type == MAN_BLOCK) |
if (nn->tok == ntok && nn->type == ROFFT_BLOCK) |
nrew++; |
nrew++; |
target = strtol(p, &p, 10); |
target = strtol(p, &p, 10); |
if (*p != '\0') |
if (*p != '\0') |
Line 312 blk_close(MACRO_PROT_ARGS) |
|
Line 228 blk_close(MACRO_PROT_ARGS) |
|
} |
} |
|
|
for (nn = man->last->parent; nn; nn = nn->parent) |
for (nn = man->last->parent; nn; nn = nn->parent) |
if (nn->tok == ntok && nn->type == MAN_BLOCK && ! --nrew) |
if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew) |
break; |
break; |
|
|
if (nn == NULL) { |
if (nn == NULL) { |
mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse, |
mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse, |
line, ppos, man_macronames[tok]); |
line, ppos, man_macronames[tok]); |
rew_scope(MAN_BLOCK, man, MAN_PP); |
rew_scope(man, MAN_PP); |
} else { |
} else { |
line = man->last->line; |
line = man->last->line; |
ppos = man->last->pos; |
ppos = man->last->pos; |
Line 337 blk_close(MACRO_PROT_ARGS) |
|
Line 253 blk_close(MACRO_PROT_ARGS) |
|
void |
void |
blk_exp(MACRO_PROT_ARGS) |
blk_exp(MACRO_PROT_ARGS) |
{ |
{ |
struct man_node *n; |
struct roff_node *head; |
int la; |
|
char *p; |
char *p; |
|
int la; |
|
|
rew_scope(MAN_BLOCK, man, tok); |
rew_scope(man, tok); |
man_block_alloc(man, line, ppos, tok); |
man_block_alloc(man, line, ppos, tok); |
man_head_alloc(man, line, ppos, tok); |
man_head_alloc(man, line, ppos, tok); |
|
head = man->last; |
|
|
for (;;) { |
la = *pos; |
la = *pos; |
if (man_args(man, line, pos, buf, &p)) |
if ( ! man_args(man, line, pos, buf, &p)) |
|
break; |
|
man_word_alloc(man, line, la, p); |
man_word_alloc(man, line, la, p); |
} |
|
|
|
assert(man); |
if (buf[*pos] != '\0') |
assert(tok != MAN_MAX); |
mandoc_vmsg(MANDOCERR_ARG_EXCESS, |
|
man->parse, line, *pos, "%s ... %s", |
|
man_macronames[tok], buf + *pos); |
|
|
for (n = man->last; n; n = n->parent) |
man_unscope(man, head); |
if (n->tok == tok) { |
|
assert(n->type == MAN_HEAD); |
|
man_unscope(man, n); |
|
break; |
|
} |
|
|
|
man_body_alloc(man, line, ppos, tok); |
man_body_alloc(man, line, ppos, tok); |
} |
} |
|
|
/* |
/* |
* Parse an implicit-block macro. These contain a MAN_HEAD and a |
* Parse an implicit-block macro. These contain a ROFFT_HEAD and a |
* MAN_BODY contained within a MAN_BLOCK. Rules for closing out other |
* ROFFT_BODY contained within a ROFFT_BLOCK. Rules for closing out other |
* scopes, such as `SH' closing out an `SS', are defined in the rew |
* scopes, such as `SH' closing out an `SS', are defined in the rew |
* routines. |
* routines. |
*/ |
*/ |
Line 376 blk_imp(MACRO_PROT_ARGS) |
|
Line 286 blk_imp(MACRO_PROT_ARGS) |
|
{ |
{ |
int la; |
int la; |
char *p; |
char *p; |
struct man_node *n; |
struct roff_node *n; |
|
|
rew_scope(MAN_BODY, man, tok); |
rew_scope(man, tok); |
rew_scope(MAN_BLOCK, man, tok); |
|
man_block_alloc(man, line, ppos, tok); |
man_block_alloc(man, line, ppos, tok); |
man_head_alloc(man, line, ppos, tok); |
man_head_alloc(man, line, ppos, tok); |
n = man->last; |
n = man->last; |
Line 393 blk_imp(MACRO_PROT_ARGS) |
|
Line 302 blk_imp(MACRO_PROT_ARGS) |
|
man_word_alloc(man, line, la, p); |
man_word_alloc(man, line, la, p); |
} |
} |
|
|
/* Close out head and open body (unless MAN_SCOPE). */ |
/* |
|
* For macros having optional next-line scope, |
|
* keep the head open if there were no arguments. |
|
* For `TP', always keep the head open. |
|
*/ |
|
|
if (man_macros[tok].flags & MAN_SCOPED) { |
if (man_macros[tok].flags & MAN_SCOPED && |
/* If we're forcing scope (`TP'), keep it open. */ |
(tok == MAN_TP || n == man->last)) { |
if (man_macros[tok].flags & MAN_FSCOPED) { |
man->flags |= MAN_BLINE; |
man->flags |= MAN_BLINE; |
return; |
return; |
|
} else if (n == man->last) { |
|
man->flags |= MAN_BLINE; |
|
return; |
|
} |
|
} |
} |
rew_scope(MAN_HEAD, man, tok); |
|
|
/* Close out the head and open the body. */ |
|
|
|
man_unscope(man, n); |
man_body_alloc(man, line, ppos, tok); |
man_body_alloc(man, line, ppos, tok); |
} |
} |
|
|
Line 414 in_line_eoln(MACRO_PROT_ARGS) |
|
Line 325 in_line_eoln(MACRO_PROT_ARGS) |
|
{ |
{ |
int la; |
int la; |
char *p; |
char *p; |
struct man_node *n; |
struct roff_node *n; |
|
|
man_elem_alloc(man, line, ppos, tok); |
man_elem_alloc(man, line, ppos, tok); |
n = man->last; |
n = man->last; |
Line 438 in_line_eoln(MACRO_PROT_ARGS) |
|
Line 349 in_line_eoln(MACRO_PROT_ARGS) |
|
if ( ! man_args(man, line, pos, buf, &p)) |
if ( ! man_args(man, line, pos, buf, &p)) |
break; |
break; |
if (man_macros[tok].flags & MAN_JOIN && |
if (man_macros[tok].flags & MAN_JOIN && |
man->last->type == MAN_TEXT) |
man->last->type == ROFFT_TEXT) |
man_word_append(man, p); |
man_word_append(man, p); |
else |
else |
man_word_alloc(man, line, la, p); |
man_word_alloc(man, line, la, p); |
Line 465 in_line_eoln(MACRO_PROT_ARGS) |
|
Line 376 in_line_eoln(MACRO_PROT_ARGS) |
|
return; |
return; |
} |
} |
|
|
assert(man->last->type != MAN_ROOT); |
assert(man->last->type != ROFFT_ROOT); |
man->next = MAN_NEXT_SIBLING; |
man->next = MAN_NEXT_SIBLING; |
|
|
/* |
/* |
Line 477 in_line_eoln(MACRO_PROT_ARGS) |
|
Line 388 in_line_eoln(MACRO_PROT_ARGS) |
|
for ( ; man->last; man->last = man->last->parent) { |
for ( ; man->last; man->last = man->last->parent) { |
if (man->last == n) |
if (man->last == n) |
break; |
break; |
if (man->last->type == MAN_ROOT) |
if (man->last->type == ROFFT_ROOT) |
break; |
break; |
man_valid_post(man); |
man_valid_post(man); |
} |
} |
Line 488 in_line_eoln(MACRO_PROT_ARGS) |
|
Line 399 in_line_eoln(MACRO_PROT_ARGS) |
|
* Same here regarding whether we're back at the root. |
* Same here regarding whether we're back at the root. |
*/ |
*/ |
|
|
if (man->last->type != MAN_ROOT) |
if (man->last->type != ROFFT_ROOT) |
man_valid_post(man); |
man_valid_post(man); |
} |
} |
|
|