mandoc/mdoc_term.c - diff

Return to mdoc_term.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc_term.c between version 1.91 and 1.105

version 1.91, 2009/10/18 13:34:17

version 1.105, 2010/01/01 14:27:59

Line 18

#include <assert.h>

#include <ctype.h>

#include <err.h>

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

#include "out.h"

#include "term.h"

#include "mdoc.h"

#include "chars.h"

Line 47 struct termact {

void (*post)(DECL_ARGS);

};

static size_t a2width(const struct mdoc_argv *, int);

static size_t a2height(const struct mdoc_node *);

static size_t a2offs(const struct mdoc_argv *);

static int arg_hasattr(int, const struct mdoc_node *);

static int arg_getattrs(const int *, int *, size_t,

const struct mdoc_node *);

static int arg_getattr(int, const struct mdoc_node *);

static int arg_listtype(const struct mdoc_node *);

static void print_bvspace(struct termp *,

const struct mdoc_node *,

const struct mdoc_node *);

static void print_mdoc_node(DECL_ARGS);

static void print_mdoc_head(DECL_ARGS);

static void print_mdoc_nodelist(DECL_ARGS);

static void print_foot(DECL_ARGS);

#ifdef __linux__

extern size_t strlcpy(char *, const char *, size_t);

extern size_t strlcat(char *, const char *, size_t);

#endif

static void termp____post(DECL_ARGS);

static void termp_an_post(DECL_ARGS);

static void termp_aq_post(DECL_ARGS);

Line 94 static int termp_fo_pre(DECL_ARGS);

Line 116 static int termp_fo_pre(DECL_ARGS);

static int termp_ft_pre(DECL_ARGS);

static int termp_in_pre(DECL_ARGS);

static int termp_it_pre(DECL_ARGS);

static int termp_li_pre(DECL_ARGS);

static int termp_lk_pre(DECL_ARGS);

static int termp_nd_pre(DECL_ARGS);

static int termp_nm_pre(DECL_ARGS);

Line 145 static const struct termact termacts[MDOC_MAX] = {

Line 168 static const struct termact termacts[MDOC_MAX] = {

{ termp_ft_pre, termp_ft_post }, /* Ft */

{ termp_bold_pre, NULL }, /* Ic */

{ termp_in_pre, termp_in_post }, /* In */

{ NULL, NULL }, /* Li */

{ termp_li_pre, NULL }, /* Li */

{ termp_nd_pre, NULL }, /* Nd */

{ termp_nm_pre, NULL }, /* Nm */

{ termp_op_pre, termp_op_post }, /* Op */

Line 235 static const struct termact termacts[MDOC_MAX] = {

Line 258 static const struct termact termacts[MDOC_MAX] = {

{ NULL, termp____post }, /* %Q */

{ termp_sp_pre, NULL }, /* br */

{ termp_sp_pre, NULL }, /* sp */

{ termp_under_pre, termp____post }, /* %U */

};

#ifdef __linux__

extern size_t strlcpy(char *, const char *, size_t);

extern size_t strlcat(char *, const char *, size_t);

#endif

static size_t arg2width(const struct mdoc_argv *, int);

static size_t arg2height(const struct mdoc_node *);

static size_t arg2offs(const struct mdoc_argv *);

static int arg_hasattr(int, const struct mdoc_node *);

static int arg_getattrs(const int *, int *, size_t,

const struct mdoc_node *);

static int arg_getattr(int, const struct mdoc_node *);

static int arg_listtype(const struct mdoc_node *);

static void print_bvspace(struct termp *,

const struct mdoc_node *,

const struct mdoc_node *);

static void print_node(DECL_ARGS);

static void print_head(DECL_ARGS);

static void print_body(DECL_ARGS);

static void print_foot(DECL_ARGS);

void

terminal_mdoc(void *arg, const struct mdoc *mdoc)

{

Line 282 terminal_mdoc(void *arg, const struct mdoc *mdoc)

Line 284 terminal_mdoc(void *arg, const struct mdoc *mdoc)

n = mdoc_node(mdoc);

m = mdoc_meta(mdoc);

print_head(p, NULL, m, n);

print_mdoc_head(p, NULL, m, n);

if (n->child)

print_body(p, NULL, m, n->child);

print_mdoc_nodelist(p, NULL, m, n->child);

print_foot(p, NULL, m, n);

}

static void

print_body(DECL_ARGS)

print_mdoc_nodelist(DECL_ARGS)

{

print_node(p, pair, m, n);

print_mdoc_node(p, pair, m, n);

if (n->next)

print_body(p, pair, m, n->next);

print_mdoc_nodelist(p, pair, m, n->next);

}

/* ARGSUSED */

static void

print_node(DECL_ARGS)

print_mdoc_node(DECL_ARGS)

{

int chld, bold, under;

int chld;

const void *font;

struct termpair npair;

size_t offset, rmargin;

chld = 1;

offset = p->offset;

rmargin = p->rmargin;

bold = p->bold;

font = term_fontq(p);

under = p->under;

bzero(&npair, sizeof(struct termpair));

memset(&npair, 0, sizeof(struct termpair));

npair.ppair = pair;

if (MDOC_TEXT != n->type) {

Line 321 print_node(DECL_ARGS)

Line 323 print_node(DECL_ARGS)

chld = (*termacts[n->tok].pre)(p, &npair, m, n);

} else

term_word(p, n->string);

if (chld && n->child)

print_body(p, &npair, m, n->child);

print_mdoc_nodelist(p, &npair, m, n->child);

term_fontpopq(p, font);

* XXX - if bold/under were to span scopes, this wouldn't be

* possible, but because decoration is always in-scope, we can

* get away with this.

p->bold = bold;

p->under = under;

if (MDOC_TEXT != n->type)

if (termacts[n->tok].post)

(*termacts[n->tok].post)(p, &npair, m, n);

Line 346 print_node(DECL_ARGS)

Line 342 print_node(DECL_ARGS)

static void

print_foot(DECL_ARGS)

{

struct tm *tm;

char buf[DATESIZ], os[BUFSIZ];

char *buf, *os;

term_fontrepl(p, TERMFONT_NONE);

* Output the footer in new-groff style, that is, three columns

* with the middle being the manual date and flanking columns

Line 357 print_foot(DECL_ARGS)

Line 354 print_foot(DECL_ARGS)

* SYSTEM DATE SYSTEM

if (NULL == (buf = malloc(p->rmargin)))

time2a(m->date, buf, DATESIZ);

err(EXIT_FAILURE, "malloc");

strlcpy(os, m->os, BUFSIZ);

if (NULL == (os = malloc(p->rmargin)))

err(EXIT_FAILURE, "malloc");

tm = localtime(&m->date);

if (0 == strftime(buf, p->rmargin, "%B %e, %Y", tm))

err(EXIT_FAILURE, "strftime");

(void)strlcpy(os, m->os, p->rmargin);

term_vspace(p);

p->offset = 0;

Line 396 print_foot(DECL_ARGS)

Line 384 print_foot(DECL_ARGS)

p->offset = 0;

p->rmargin = p->maxrmargin;

p->flags = 0;

free(buf);

free(os);

}

/* FIXME: put in utility library. */

/* ARGSUSED */

static void

print_head(DECL_ARGS)

print_mdoc_head(DECL_ARGS)

{

char *buf, *title;

char buf[BUFSIZ], title[BUFSIZ];

p->rmargin = p->maxrmargin;

p->offset = 0;

if (NULL == (buf = malloc(p->rmargin)))

err(EXIT_FAILURE, "malloc");

if (NULL == (title = malloc(p->rmargin)))

err(EXIT_FAILURE, "malloc");

* The header is strange. It has three components, which are

* really two with the first duplicated. It goes like this:

Line 431 print_head(DECL_ARGS)

Line 410 print_head(DECL_ARGS)

assert(m->vol);

(void)strlcpy(buf, m->vol, p->rmargin);

strlcpy(buf, m->vol, BUFSIZ);

if (m->arch) {

(void)strlcat(buf, " (", p->rmargin);

strlcat(buf, " (", BUFSIZ);

(void)strlcat(buf, m->arch, p->rmargin);

strlcat(buf, m->arch, BUFSIZ);

(void)strlcat(buf, ")", p->rmargin);

strlcat(buf, ")", BUFSIZ);

}

snprintf(title, p->rmargin, "%s(%d)", m->title, m->msec);

snprintf(title, BUFSIZ, "%s(%d)", m->title, m->msec);

p->offset = 0;

p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2;

Line 466 print_head(DECL_ARGS)

Line 445 print_head(DECL_ARGS)

p->offset = 0;

p->rmargin = p->maxrmargin;

p->flags &= ~TERMP_NOSPACE;

free(title);

free(buf);

}

static size_t

arg2height(const struct mdoc_node *n)

a2height(const struct mdoc_node *n)

{

int r;

struct roffsu su;

assert(MDOC_TEXT == n->type);

assert(n->string);

if ( ! a2roffsu(n->string, &su, SCALE_VS))

SCALE_VS_INIT(&su, strlen(n->string));

if ((r = a2height(n->string)) < 0)

return(term_vspan(&su));

return(1);

return((size_t)r);

}

static size_t

arg2width(const struct mdoc_argv *arg, int pos)

a2width(const struct mdoc_argv *arg, int pos)

{

int r;

struct roffsu su;

assert(arg->value[pos]);

if ('\0' == arg->value[pos][0])

if ( ! a2roffsu(arg->value[pos], &su, SCALE_MAX))

return(2);

SCALE_HS_INIT(&su, strlen(arg->value[pos]));

if ((r = a2width(arg->value[pos])) >= 0)

/* XXX: pachemu? */

return((size_t)r);

return(term_hspan(&su) + 2);

return(strlen(arg->value[pos]) + 2);

}

/* FIXME: put in utility file for front-ends. */

static int

arg_listtype(const struct mdoc_node *n)

{

Line 546 arg_listtype(const struct mdoc_node *n)

Line 518 arg_listtype(const struct mdoc_node *n)

static size_t

arg2offs(const struct mdoc_argv *arg)

a2offs(const struct mdoc_argv *arg)

{

int r;

struct roffsu su;

if ('\0' == arg->value[0][0])

return(0);

Line 558 arg2offs(const struct mdoc_argv *arg)

Line 530 arg2offs(const struct mdoc_argv *arg)

return(INDENT + 1);

else if (0 == strcmp(arg->value[0], "indent-two"))

return((INDENT + 1) * 2);

else if ((r = a2width(arg->value[0])) >= 0)

else if ( ! a2roffsu(arg->value[0], &su, SCALE_MAX))

return((size_t)r);

SCALE_HS_INIT(&su, strlen(arg->value[0]));

return(strlen(arg->value[0]));

return(term_hspan(&su));

}

Line 679 termp_it_pre(DECL_ARGS)

Line 651 termp_it_pre(DECL_ARGS)

const struct mdoc_node *bl, *nn;

char buf[7];

int i, type, keys[3], vals[3];

size_t width, offset;

size_t width, offset, ncols, dcol;

if (MDOC_BLOCK == n->type) {

print_bvspace(p, n->parent->parent, n);

Line 707 termp_it_pre(DECL_ARGS)

Line 679 termp_it_pre(DECL_ARGS)

type = arg_listtype(bl);

assert(-1 != type);

if (vals[1] >= 0)

offset = a2offs(&bl->args->argv[vals[1]]);

/* Calculate real width and offset. */

switch (type) {

case (MDOC_Column):

if (MDOC_BODY == n->type)

break;

* Work around groff's column handling. The offset is

* equal to the sum of all widths leading to the current

* Imitate groff's column handling.

* column (plus the -offset value). If this column

* For each earlier column, add its width.

* exceeds the stated number of columns, the width is

* For less than 5 columns, add two more blanks per column.

* set as 0, else it's the stated column width (later

* For exactly 5 columns, add only one more blank per column.

* the 0 will be adjusted to default 10 or, if in the

* For more than 5 columns, add no blanks per column.

* last column case, set to stretch to the margin).

for (i = 0, nn = n->prev; nn &&

ncols = bl->args->argv[vals[2]].sz;

i < (int)bl->args->argv[vals[2]].sz;

/* LINTED */

nn = nn->prev, i++)

dcol = ncols < 5 ? 2 : ncols == 5 ? 1 : 0;

offset += arg2width

for (i=0, nn=n->prev; nn && i < (int)ncols; nn=nn->prev, i++)

(&bl->args->argv[vals[2]], i);

offset += a2width(&bl->args->argv[vals[2]], i) + dcol;

/* Whether exceeds maximum column. */

if (i < (int)bl->args->argv[vals[2]].sz)

* FIXME: newer groff only wants one space between

width = arg2width(&bl->args->argv[vals[2]], i);

* columns > 5; however, a2width will have min. two

else

* spaces. For now, let this slide.

width = 0;

if (vals[1] >= 0)

offset += arg2offs(&bl->args->argv[vals[1]]);

* Use the declared column widths,

* extended as explained in the preceding paragraph.

if (i < (int)ncols)

width = a2width(&bl->args->argv[vals[2]], i) + dcol;

* When exceeding the declared number of columns,

* leave the remaining widths at 0.

* This will later be adjusted to the default width of 10,

* or, for the last column, stretched to the right margin.

break;

default:

if (vals[0] >= 0)

width = arg2width(&bl->args->argv[vals[0]], 0);

width = a2width(&bl->args->argv[vals[0]], 0);

if (vals[1] >= 0)

offset += arg2offs(&bl->args->argv[vals[1]]);

break;

}

Line 803 termp_it_pre(DECL_ARGS)

Line 786 termp_it_pre(DECL_ARGS)

switch (type) {

case (MDOC_Diag):

if (MDOC_HEAD == n->type)

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

break;

default:

break;

Line 926 termp_it_pre(DECL_ARGS)

Line 909 termp_it_pre(DECL_ARGS)

* right-most column is filled to the right margin.

if (MDOC_HEAD == n->type &&

MDOC_BODY == n->next->type)

MDOC_BODY == n->next->type &&

p->rmargin < p->maxrmargin)

p->rmargin = p->maxrmargin;

break;

default:

Line 941 termp_it_pre(DECL_ARGS)

Line 925 termp_it_pre(DECL_ARGS)

if (MDOC_HEAD == n->type)

switch (type) {

case (MDOC_Bullet):

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

term_word(p, "\\[bu]");

p->bold--;

term_fontpop(p);

break;

case (MDOC_Dash):

/* FALLTHROUGH */

case (MDOC_Hyphen):

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

term_word(p, "\\(hy");

p->bold--;

term_fontpop(p);

break;

case (MDOC_Enum):

(pair->ppair->ppair->count)++;

Line 1032 termp_nm_pre(DECL_ARGS)

Line 1016 termp_nm_pre(DECL_ARGS)

if (SEC_SYNOPSIS == n->sec)

term_newln(p);

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

if (NULL == n->child)

term_word(p, m->name);

return(1);

Line 1044 static int

Line 1030 static int

termp_fl_pre(DECL_ARGS)

{

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

term_word(p, "\\-");

p->flags |= TERMP_NOSPACE;

/* A blank `Fl' should incur a subsequent space. */

if (n->child)

p->flags |= TERMP_NOSPACE;

return(1);

}

Line 1142 termp_rv_pre(DECL_ARGS)

Line 1133 termp_rv_pre(DECL_ARGS)

term_word(p, "The");

for (nn = n->child; nn; nn = nn->next) {

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

term_word(p, nn->string);

p->bold--;

term_fontpop(p);

p->flags |= TERMP_NOSPACE;

if (nn->next && NULL == nn->next->next)

term_word(p, "(), and");

Line 1162 termp_rv_pre(DECL_ARGS)

Line 1153 termp_rv_pre(DECL_ARGS)

term_word(p, "the value 0 if successful; otherwise the value "

"-1 is returned and the global variable");

p->under++;

term_fontpush(p, TERMFONT_UNDER);

term_word(p, "errno");

p->under--;

term_fontpop(p);

term_word(p, "is set to indicate the error.");

Line 1181 termp_ex_pre(DECL_ARGS)

Line 1172 termp_ex_pre(DECL_ARGS)

term_word(p, "The");

for (nn = n->child; nn; nn = nn->next) {

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

term_word(p, nn->string);

p->bold--;

term_fontpop(p);

p->flags |= TERMP_NOSPACE;

if (nn->next && NULL == nn->next->next)

term_word(p, ", and");

Line 1285 static int

Line 1276 static int

termp_bold_pre(DECL_ARGS)

{

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

return(1);

}

Line 1319 termp_sh_pre(DECL_ARGS)

Line 1310 termp_sh_pre(DECL_ARGS)

term_vspace(p);

break;

case (MDOC_HEAD):

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

break;

case (MDOC_BODY):

p->offset = INDENT;

Line 1454 termp_ft_pre(DECL_ARGS)

Line 1445 termp_ft_pre(DECL_ARGS)

if (SEC_SYNOPSIS == n->sec)

if (n->prev && MDOC_Fo == n->prev->tok)

term_vspace(p);

p->under++;

term_fontpush(p, TERMFONT_UNDER);

return(1);

}

Line 1475 termp_fn_pre(DECL_ARGS)

Line 1467 termp_fn_pre(DECL_ARGS)

{

const struct mdoc_node *nn;

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

term_word(p, n->child->string);

p->bold--;

term_fontpop(p);

p->flags |= TERMP_NOSPACE;

term_word(p, "(");

for (nn = n->child->next; nn; nn = nn->next) {

p->under++;

term_fontpush(p, TERMFONT_UNDER);

term_word(p, nn->string);

p->under--;

term_fontpop(p);

if (nn->next)

term_word(p, ",");

}

Line 1516 termp_fa_pre(DECL_ARGS)

Line 1509 termp_fa_pre(DECL_ARGS)

const struct mdoc_node *nn;

if (n->parent->tok != MDOC_Fo) {

p->under++;

term_fontpush(p, TERMFONT_UNDER);

return(1);

}

for (nn = n->child; nn; nn = nn->next) {

p->under++;

term_fontpush(p, TERMFONT_UNDER);

term_word(p, nn->string);

p->under--;

term_fontpop(p);

if (nn->next)

term_word(p, ",");

}

Line 1564 termp_bd_pre(DECL_ARGS)

Line 1558 termp_bd_pre(DECL_ARGS)

type = nn->args->argv[i].arg;

break;

case (MDOC_Offset):

p->offset += arg2offs(&nn->args->argv[i]);

p->offset += a2offs(&nn->args->argv[i]);

break;

default:

break;

Line 1585 termp_bd_pre(DECL_ARGS)

Line 1579 termp_bd_pre(DECL_ARGS)

for (nn = n->child; nn; nn = nn->next) {

p->flags |= TERMP_NOSPACE;

print_node(p, pair, m, nn);

print_mdoc_node(p, pair, m, nn);

if (NULL == nn->next)

continue;

if (nn->prev && nn->prev->line < nn->line)

Line 1658 termp_xx_pre(DECL_ARGS)

Line 1652 termp_xx_pre(DECL_ARGS)

pp = "BSDI BSD/OS";

break;

case (MDOC_Dx):

pp = "DragonFlyBSD";

pp = "DragonFly";

break;

case (MDOC_Fx):

pp = "FreeBSD";

Line 1739 termp_ss_pre(DECL_ARGS)

Line 1733 termp_ss_pre(DECL_ARGS)

term_vspace(p);

break;

case (MDOC_HEAD):

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

p->offset = HALFINDENT;

break;

default:

Line 1765 static int

Line 1759 static int

termp_cd_pre(DECL_ARGS)

{

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

term_newln(p);

return(1);

}

Line 1776 static int

Line 1770 static int

termp_in_pre(DECL_ARGS)

{

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

if (SEC_SYNOPSIS == n->sec)

term_word(p, "#include");

Line 1791 static void

Line 1785 static void

termp_in_post(DECL_ARGS)

{

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

p->flags |= TERMP_NOSPACE;

term_word(p, ">");

p->bold--;

term_fontpop(p);

if (SEC_SYNOPSIS != n->sec)

return;

Line 1819 termp_sp_pre(DECL_ARGS)

Line 1813 termp_sp_pre(DECL_ARGS)

switch (n->tok) {

case (MDOC_sp):

len = n->child ? arg2height(n->child) : 1;

len = n->child ? a2height(n->child) : 1;

break;

case (MDOC_br):

len = 0;

Line 1926 termp_fo_pre(DECL_ARGS)

Line 1920 termp_fo_pre(DECL_ARGS)

} else if (MDOC_HEAD != n->type)

return(1);

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

for (nn = n->child; nn; nn = nn->next) {

assert(MDOC_TEXT == nn->type);

term_word(p, nn->string);

}

p->bold--;

term_fontpop(p);

return(0);

}

Line 1965 termp_bf_pre(DECL_ARGS)

Line 1959 termp_bf_pre(DECL_ARGS)

if (NULL == (nn = n->head->child)) {

if (arg_hasattr(MDOC_Emphasis, n))

p->under++;

term_fontpush(p, TERMFONT_UNDER);

else if (arg_hasattr(MDOC_Symbolic, n))

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

else

term_fontpush(p, TERMFONT_NONE);

return(1);

}

assert(MDOC_TEXT == nn->type);

if (0 == strcmp("Em", nn->string))

p->under++;

term_fontpush(p, TERMFONT_UNDER);

else if (0 == strcmp("Sy", nn->string))

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

else

term_fontpush(p, TERMFONT_NONE);

return(1);

}

Line 2015 static void

Line 2013 static void

termp____post(DECL_ARGS)

{

/* TODO: %U. */

p->flags |= TERMP_NOSPACE;

switch (n->tok) {

case (MDOC__T):

Line 2030 termp____post(DECL_ARGS)

/* ARGSUSED */

static int

termp_li_pre(DECL_ARGS)

{

term_fontpush(p, TERMFONT_NONE);

return(1);

}

/* ARGSUSED */

static int

termp_lk_pre(DECL_ARGS)

{

const struct mdoc_node *nn;

if (NULL == (nn = n->child->next)) {

term_fontpush(p, TERMFONT_UNDER);

p->under++;

nn = n->child;

if (NULL == nn->next)

return(1);

}

p->under++;

term_word(p, nn->string);

term_fontpop(p);

p->flags |= TERMP_NOSPACE;

term_word(p, ":");

p->under--;

p->bold++;

term_fontpush(p, TERMFONT_BOLD);

for (nn = nn->next; nn; nn = nn->next)

term_word(p, nn->string);

p->bold--;

term_fontpop(p);

return(0);

}

Line 2059 static int

Line 2070 static int

termp_under_pre(DECL_ARGS)

{

p->under++;

term_fontpush(p, TERMFONT_UNDER);

return(1);

}

CVSweb