version 1.9, 2009/03/19 16:20:37 |
version 1.92, 2022/01/12 04:54:05 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
* Copyright (c) 2008, 2009, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 2013-2015, 2017-2022 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 |
* purpose with or without fee is hereby granted, provided that the above |
* above copyright notice and this permission notice appear in all |
* copyright notice and this permission notice appear in all copies. |
* copies. |
|
* |
* |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES |
* WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR |
* AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* PERFORMANCE OF THIS SOFTWARE. |
* |
|
* Formatting module to let mandoc(1) show |
|
* a human readable representation of the syntax tree. |
*/ |
*/ |
|
#include "config.h" |
|
|
|
#include <sys/types.h> |
|
|
#include <assert.h> |
#include <assert.h> |
#include <err.h> |
#include <limits.h> |
#include <stdio.h> |
#include <stdio.h> |
#include <stdlib.h> |
#include <stdlib.h> |
|
#include <time.h> |
|
|
|
#include "mandoc.h" |
|
#include "roff.h" |
#include "mdoc.h" |
#include "mdoc.h" |
|
#include "man.h" |
|
#include "tbl.h" |
|
#include "eqn.h" |
|
#include "main.h" |
|
|
static void tree_body(const struct mdoc_node *, int); |
static void print_attr(const struct roff_node *); |
|
static void print_box(const struct eqn_box *, int); |
|
static void print_cellt(enum tbl_cellt); |
|
static void print_man(const struct roff_node *, int); |
|
static void print_meta(const struct roff_meta *); |
|
static void print_mdoc(const struct roff_node *, int); |
|
static void print_span(const struct tbl_span *, int); |
|
|
|
|
/* ARGSUSED */ |
void |
int |
tree_mdoc(void *arg, const struct roff_meta *mdoc) |
tree_run(void *arg, const struct mdoc *mdoc) |
|
{ |
{ |
|
print_meta(mdoc); |
|
putchar('\n'); |
|
print_mdoc(mdoc->first->child, 0); |
|
} |
|
|
tree_body(mdoc_node(mdoc), 0); |
void |
return(1); |
tree_man(void *arg, const struct roff_meta *man) |
|
{ |
|
print_meta(man); |
|
if (man->hasbody == 0) |
|
puts("body = empty"); |
|
putchar('\n'); |
|
print_man(man->first->child, 0); |
} |
} |
|
|
|
static void |
|
print_meta(const struct roff_meta *meta) |
|
{ |
|
if (meta->title != NULL) |
|
printf("title = \"%s\"\n", meta->title); |
|
if (meta->name != NULL) |
|
printf("name = \"%s\"\n", meta->name); |
|
if (meta->msec != NULL) |
|
printf("sec = \"%s\"\n", meta->msec); |
|
if (meta->vol != NULL) |
|
printf("vol = \"%s\"\n", meta->vol); |
|
if (meta->arch != NULL) |
|
printf("arch = \"%s\"\n", meta->arch); |
|
if (meta->os != NULL) |
|
printf("os = \"%s\"\n", meta->os); |
|
if (meta->date != NULL) |
|
printf("date = \"%s\"\n", meta->date); |
|
} |
|
|
static void |
static void |
tree_body(const struct mdoc_node *n, int indent) |
print_mdoc(const struct roff_node *n, int indent) |
{ |
{ |
const char *p, *t; |
const char *p, *t; |
int i, j; |
int i, j; |
size_t argc, sz; |
size_t argc; |
char **params; |
|
struct mdoc_argv *argv; |
struct mdoc_argv *argv; |
|
|
|
if (n == NULL) |
|
return; |
|
|
argv = NULL; |
argv = NULL; |
argc = sz = 0; |
argc = 0; |
params = NULL; |
t = p = NULL; |
|
|
switch (n->type) { |
switch (n->type) { |
case (MDOC_ROOT): |
case ROFFT_ROOT: |
t = "root"; |
t = "root"; |
break; |
break; |
case (MDOC_BLOCK): |
case ROFFT_BLOCK: |
t = "block"; |
t = "block"; |
break; |
break; |
case (MDOC_HEAD): |
case ROFFT_HEAD: |
t = "block-head"; |
t = "head"; |
break; |
break; |
case (MDOC_BODY): |
case ROFFT_BODY: |
t = "block-body"; |
if (n->end) |
|
t = "body-end"; |
|
else |
|
t = "body"; |
break; |
break; |
case (MDOC_TAIL): |
case ROFFT_TAIL: |
t = "block-tail"; |
t = "tail"; |
break; |
break; |
case (MDOC_ELEM): |
case ROFFT_ELEM: |
t = "elem"; |
t = "elem"; |
break; |
break; |
case (MDOC_TEXT): |
case ROFFT_TEXT: |
t = "text"; |
t = "text"; |
break; |
break; |
|
case ROFFT_COMMENT: |
|
t = "comment"; |
|
break; |
|
case ROFFT_TBL: |
|
break; |
|
case ROFFT_EQN: |
|
t = "eqn"; |
|
break; |
default: |
default: |
abort(); |
abort(); |
/* NOTREACHED */ |
|
} |
} |
|
|
switch (n->type) { |
switch (n->type) { |
case (MDOC_TEXT): |
case ROFFT_TEXT: |
|
case ROFFT_COMMENT: |
p = n->string; |
p = n->string; |
break; |
break; |
case (MDOC_BODY): |
case ROFFT_BODY: |
p = mdoc_macronames[n->tok]; |
p = roff_name[n->tok]; |
break; |
break; |
case (MDOC_HEAD): |
case ROFFT_HEAD: |
p = mdoc_macronames[n->tok]; |
p = roff_name[n->tok]; |
break; |
break; |
case (MDOC_TAIL): |
case ROFFT_TAIL: |
p = mdoc_macronames[n->tok]; |
p = roff_name[n->tok]; |
break; |
break; |
case (MDOC_ELEM): |
case ROFFT_ELEM: |
p = mdoc_macronames[n->tok]; |
p = roff_name[n->tok]; |
if (n->args) { |
if (n->args) { |
argv = n->args->argv; |
argv = n->args->argv; |
argc = n->args->argc; |
argc = n->args->argc; |
} |
} |
break; |
break; |
case (MDOC_BLOCK): |
case ROFFT_BLOCK: |
p = mdoc_macronames[n->tok]; |
p = roff_name[n->tok]; |
if (n->args) { |
if (n->args) { |
argv = n->args->argv; |
argv = n->args->argv; |
argc = n->args->argc; |
argc = n->args->argc; |
} |
} |
break; |
break; |
case (MDOC_ROOT): |
case ROFFT_TBL: |
|
break; |
|
case ROFFT_EQN: |
|
p = "EQ"; |
|
break; |
|
case ROFFT_ROOT: |
p = "root"; |
p = "root"; |
break; |
break; |
default: |
default: |
abort(); |
abort(); |
/* NOTREACHED */ |
|
} |
} |
|
|
for (i = 0; i < indent; i++) |
if (n->span) { |
(void)printf(" "); |
assert(NULL == p && NULL == t); |
(void)printf("%s (%s)", p, t); |
print_span(n->span, indent); |
|
} else { |
|
for (i = 0; i < indent; i++) |
|
putchar(' '); |
|
|
for (i = 0; i < (int)argc; i++) { |
printf("%s (%s)", p, t); |
(void)printf(" -%s", mdoc_argnames[argv[i].arg]); |
|
if (argv[i].sz > 0) |
for (i = 0; i < (int)argc; i++) { |
(void)printf(" ["); |
printf(" -%s", mdoc_argnames[argv[i].arg]); |
for (j = 0; j < (int)argv[i].sz; j++) |
if (argv[i].sz > 0) |
(void)printf(" [%s]", argv[i].value[j]); |
printf(" ["); |
if (argv[i].sz > 0) |
for (j = 0; j < (int)argv[i].sz; j++) |
(void)printf(" ]"); |
printf(" [%s]", argv[i].value[j]); |
|
if (argv[i].sz > 0) |
|
printf(" ]"); |
|
} |
|
print_attr(n); |
} |
} |
|
if (n->eqn) |
|
print_box(n->eqn->first, indent + 4); |
|
if (n->child) |
|
print_mdoc(n->child, indent + |
|
(n->type == ROFFT_BLOCK ? 2 : 4)); |
|
if (n->next) |
|
print_mdoc(n->next, indent); |
|
} |
|
|
for (i = 0; i < (int)sz; i++) |
static void |
(void)printf(" [%s]", params[i]); |
print_man(const struct roff_node *n, int indent) |
|
{ |
|
const char *p, *t; |
|
int i; |
|
|
(void)printf(" %d:%d\n", n->line, n->pos); |
if (n == NULL) |
|
return; |
|
|
|
t = p = NULL; |
|
|
|
switch (n->type) { |
|
case ROFFT_ROOT: |
|
t = "root"; |
|
break; |
|
case ROFFT_ELEM: |
|
t = "elem"; |
|
break; |
|
case ROFFT_TEXT: |
|
t = "text"; |
|
break; |
|
case ROFFT_COMMENT: |
|
t = "comment"; |
|
break; |
|
case ROFFT_BLOCK: |
|
t = "block"; |
|
break; |
|
case ROFFT_HEAD: |
|
t = "head"; |
|
break; |
|
case ROFFT_BODY: |
|
t = "body"; |
|
break; |
|
case ROFFT_TBL: |
|
break; |
|
case ROFFT_EQN: |
|
t = "eqn"; |
|
break; |
|
default: |
|
abort(); |
|
} |
|
|
|
switch (n->type) { |
|
case ROFFT_TEXT: |
|
case ROFFT_COMMENT: |
|
p = n->string; |
|
break; |
|
case ROFFT_ELEM: |
|
case ROFFT_BLOCK: |
|
case ROFFT_HEAD: |
|
case ROFFT_BODY: |
|
p = roff_name[n->tok]; |
|
break; |
|
case ROFFT_ROOT: |
|
p = "root"; |
|
break; |
|
case ROFFT_TBL: |
|
break; |
|
case ROFFT_EQN: |
|
p = "EQ"; |
|
break; |
|
default: |
|
abort(); |
|
} |
|
|
|
if (n->span) { |
|
assert(NULL == p && NULL == t); |
|
print_span(n->span, indent); |
|
} else { |
|
for (i = 0; i < indent; i++) |
|
putchar(' '); |
|
printf("%s (%s)", p, t); |
|
print_attr(n); |
|
} |
|
if (n->eqn) |
|
print_box(n->eqn->first, indent + 4); |
if (n->child) |
if (n->child) |
tree_body(n->child, indent + 1); |
print_man(n->child, indent + |
|
(n->type == ROFFT_BLOCK ? 2 : 4)); |
if (n->next) |
if (n->next) |
tree_body(n->next, indent); |
print_man(n->next, indent); |
} |
} |
|
|
|
static void |
|
print_attr(const struct roff_node *n) |
|
{ |
|
putchar(' '); |
|
if (n->flags & NODE_DELIMO) |
|
putchar('('); |
|
if (n->flags & NODE_LINE) |
|
putchar('*'); |
|
printf("%d:%d", n->line, n->pos + 1); |
|
if (n->flags & NODE_DELIMC) |
|
putchar(')'); |
|
if (n->flags & NODE_EOS) |
|
putchar('.'); |
|
if (n->flags & NODE_ID) { |
|
printf(" ID"); |
|
if (n->flags & NODE_HREF) |
|
printf("=HREF"); |
|
} else if (n->flags & NODE_HREF) |
|
printf(" HREF"); |
|
else if (n->tag != NULL) |
|
printf(" STRAYTAG"); |
|
if (n->tag != NULL) |
|
printf("=%s", n->tag); |
|
if (n->flags & NODE_BROKEN) |
|
printf(" BROKEN"); |
|
if (n->flags & NODE_NOFILL) |
|
printf(" NOFILL"); |
|
if (n->flags & NODE_NOSRC) |
|
printf(" NOSRC"); |
|
if (n->flags & NODE_NOPRT) |
|
printf(" NOPRT"); |
|
putchar('\n'); |
|
} |
|
|
|
static void |
|
print_box(const struct eqn_box *ep, int indent) |
|
{ |
|
int i; |
|
const char *t; |
|
|
|
static const char *posnames[] = { |
|
NULL, "sup", "subsup", "sub", |
|
"to", "from", "fromto", |
|
"over", "sqrt", NULL }; |
|
|
|
if (NULL == ep) |
|
return; |
|
for (i = 0; i < indent; i++) |
|
putchar(' '); |
|
|
|
t = NULL; |
|
switch (ep->type) { |
|
case EQN_LIST: |
|
t = "eqn-list"; |
|
break; |
|
case EQN_SUBEXPR: |
|
t = "eqn-expr"; |
|
break; |
|
case EQN_TEXT: |
|
t = "eqn-text"; |
|
break; |
|
case EQN_PILE: |
|
t = "eqn-pile"; |
|
break; |
|
case EQN_MATRIX: |
|
t = "eqn-matrix"; |
|
break; |
|
} |
|
|
|
fputs(t, stdout); |
|
if (ep->pos) |
|
printf(" pos=%s", posnames[ep->pos]); |
|
if (ep->left) |
|
printf(" left=\"%s\"", ep->left); |
|
if (ep->right) |
|
printf(" right=\"%s\"", ep->right); |
|
if (ep->top) |
|
printf(" top=\"%s\"", ep->top); |
|
if (ep->bottom) |
|
printf(" bottom=\"%s\"", ep->bottom); |
|
if (ep->text) |
|
printf(" text=\"%s\"", ep->text); |
|
if (ep->font) |
|
printf(" font=%d", ep->font); |
|
if (ep->size != EQN_DEFSIZE) |
|
printf(" size=%d", ep->size); |
|
if (ep->expectargs != UINT_MAX && ep->expectargs != ep->args) |
|
printf(" badargs=%zu(%zu)", ep->args, ep->expectargs); |
|
else if (ep->args) |
|
printf(" args=%zu", ep->args); |
|
putchar('\n'); |
|
|
|
print_box(ep->first, indent + 4); |
|
print_box(ep->next, indent); |
|
} |
|
|
|
static void |
|
print_cellt(enum tbl_cellt pos) |
|
{ |
|
switch(pos) { |
|
case TBL_CELL_LEFT: |
|
putchar('L'); |
|
break; |
|
case TBL_CELL_LONG: |
|
putchar('a'); |
|
break; |
|
case TBL_CELL_CENTRE: |
|
putchar('c'); |
|
break; |
|
case TBL_CELL_RIGHT: |
|
putchar('r'); |
|
break; |
|
case TBL_CELL_NUMBER: |
|
putchar('n'); |
|
break; |
|
case TBL_CELL_SPAN: |
|
putchar('s'); |
|
break; |
|
case TBL_CELL_DOWN: |
|
putchar('^'); |
|
break; |
|
case TBL_CELL_HORIZ: |
|
putchar('-'); |
|
break; |
|
case TBL_CELL_DHORIZ: |
|
putchar('='); |
|
break; |
|
case TBL_CELL_MAX: |
|
putchar('#'); |
|
break; |
|
} |
|
} |
|
|
|
static void |
|
print_span(const struct tbl_span *sp, int indent) |
|
{ |
|
const struct tbl_dat *dp; |
|
const struct tbl_cell *cp; |
|
int i; |
|
|
|
if (sp->prev == NULL) { |
|
for (i = 0; i < indent; i++) |
|
putchar(' '); |
|
printf("%d", sp->opts->cols); |
|
if (sp->opts->opts & TBL_OPT_CENTRE) |
|
fputs(" center", stdout); |
|
if (sp->opts->opts & TBL_OPT_EXPAND) |
|
fputs(" expand", stdout); |
|
if (sp->opts->opts & TBL_OPT_ALLBOX) |
|
fputs(" allbox", stdout); |
|
if (sp->opts->opts & TBL_OPT_BOX) |
|
fputs(" box", stdout); |
|
if (sp->opts->opts & TBL_OPT_DBOX) |
|
fputs(" doublebox", stdout); |
|
if (sp->opts->opts & TBL_OPT_NOKEEP) |
|
fputs(" nokeep", stdout); |
|
if (sp->opts->opts & TBL_OPT_NOSPACE) |
|
fputs(" nospaces", stdout); |
|
if (sp->opts->opts & TBL_OPT_NOWARN) |
|
fputs(" nowarn", stdout); |
|
printf(" (tbl options) %d:1\n", sp->line); |
|
} |
|
|
|
for (i = 0; i < indent; i++) |
|
putchar(' '); |
|
|
|
switch (sp->pos) { |
|
case TBL_SPAN_HORIZ: |
|
putchar('-'); |
|
putchar(' '); |
|
break; |
|
case TBL_SPAN_DHORIZ: |
|
putchar('='); |
|
putchar(' '); |
|
break; |
|
default: |
|
for (cp = sp->layout->first; cp != NULL; cp = cp->next) |
|
print_cellt(cp->pos); |
|
putchar(' '); |
|
for (dp = sp->first; dp; dp = dp->next) { |
|
if ((cp = dp->layout) == NULL) |
|
putchar('*'); |
|
else { |
|
printf("%d", cp->col); |
|
print_cellt(dp->layout->pos); |
|
switch (cp->font) { |
|
case ESCAPE_FONTROMAN: |
|
break; |
|
case ESCAPE_FONTBOLD: |
|
putchar('b'); |
|
break; |
|
case ESCAPE_FONTITALIC: |
|
putchar('i'); |
|
break; |
|
case ESCAPE_FONTBI: |
|
fputs("bi", stdout); |
|
break; |
|
case ESCAPE_FONTCR: |
|
putchar('c'); |
|
break; |
|
case ESCAPE_FONTCB: |
|
fputs("cb", stdout); |
|
break; |
|
case ESCAPE_FONTCI: |
|
fputs("ci", stdout); |
|
break; |
|
default: |
|
abort(); |
|
} |
|
if (cp->flags & TBL_CELL_TALIGN) |
|
putchar('t'); |
|
if (cp->flags & TBL_CELL_UP) |
|
putchar('u'); |
|
if (cp->flags & TBL_CELL_BALIGN) |
|
putchar('d'); |
|
if (cp->flags & TBL_CELL_WIGN) |
|
putchar('z'); |
|
if (cp->flags & TBL_CELL_EQUAL) |
|
putchar('e'); |
|
if (cp->flags & TBL_CELL_WMAX) |
|
putchar('x'); |
|
} |
|
switch (dp->pos) { |
|
case TBL_DATA_NHORIZ: |
|
putchar('\\'); |
|
/* FALLTHROUGH */ |
|
case TBL_DATA_HORIZ: |
|
putchar('_'); |
|
break; |
|
case TBL_DATA_NDHORIZ: |
|
putchar('\\'); |
|
/* FALLTHROUGH */ |
|
case TBL_DATA_DHORIZ: |
|
putchar('='); |
|
break; |
|
default: |
|
putchar(dp->block ? '{' : '['); |
|
if (dp->string != NULL) |
|
fputs(dp->string, stdout); |
|
putchar(dp->block ? '}' : ']'); |
|
break; |
|
} |
|
if (dp->hspans) |
|
printf(">%d", dp->hspans); |
|
if (dp->vspans) |
|
printf("v%d", dp->vspans); |
|
putchar(' '); |
|
} |
|
break; |
|
} |
|
printf("(tbl) %d:1\n", sp->line); |
|
} |