mandoc/man_term.c - diff

Return to man_term.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man_term.c between version 1.125 and 1.142

version 1.125, 2011/12/04 00:44:12

version 1.142, 2014/03/08 16:22:04

Line 1

/* $Id$ */

* Permission to use, copy, modify, and distribute this software for any

* purpose with or without fee is hereby granted, provided that the above

Line 35

#define MAXMARGINS 64 /* maximum number of indented scopes */

/* FIXME: have PD set the default vspace width. */

struct mtermp {

int fl;

#define MANT_LITERAL (1 << 0)

Line 44 struct mtermp {

Line 42 struct mtermp {

int lmargincur; /* index of current margin */

int lmarginsz; /* actual number of nested margins */

size_t offset; /* default offset to visible page */

int pardist; /* vert. space before par., unit: [v] */

};

#define DECL_ARGS struct termp *p, \

struct mtermp *mt, \

const struct man_node *n, \

const struct man_meta *m

const struct man_meta *meta

struct termact {

int (*pre)(DECL_ARGS);

Line 66 static void print_man_node(DECL_ARGS);

Line 65 static void print_man_node(DECL_ARGS);

static void print_man_head(struct termp *, const void *);

static void print_man_foot(struct termp *, const void *);

static void print_bvspace(struct termp *,

const struct man_node *);

const struct man_node *, int);

static int pre_alternate(DECL_ARGS);

static int pre_B(DECL_ARGS);

static int pre_HP(DECL_ARGS);

static int pre_I(DECL_ARGS);

static int pre_IP(DECL_ARGS);

static int pre_OP(DECL_ARGS);

static int pre_PD(DECL_ARGS);

static int pre_PP(DECL_ARGS);

static int pre_RS(DECL_ARGS);

static int pre_SH(DECL_ARGS);

static int pre_SS(DECL_ARGS);

static int pre_TP(DECL_ARGS);

static int pre_UR(DECL_ARGS);

static int pre_alternate(DECL_ARGS);

static int pre_ft(DECL_ARGS);

static int pre_ign(DECL_ARGS);

static int pre_in(DECL_ARGS);

static int pre_literal(DECL_ARGS);

static int pre_sp(DECL_ARGS);

static int pre_ft(DECL_ARGS);

static void post_IP(DECL_ARGS);

static void post_HP(DECL_ARGS);

Line 90 static void post_RS(DECL_ARGS);

Line 92 static void post_RS(DECL_ARGS);

static void post_SH(DECL_ARGS);

static void post_SS(DECL_ARGS);

static void post_TP(DECL_ARGS);

static void post_UR(DECL_ARGS);

static const struct termact termacts[MAN_MAX] = {

{ pre_sp, NULL, MAN_NOTEXT }, /* br */

Line 121 static const struct termact termacts[MAN_MAX] = {

Line 124 static const struct termact termacts[MAN_MAX] = {

{ pre_RS, post_RS, 0 }, /* RS */

{ pre_ign, NULL, 0 }, /* DT */

{ pre_ign, NULL, 0 }, /* UC */

{ pre_ign, NULL, 0 }, /* PD */

{ pre_PD, NULL, MAN_NOTEXT }, /* PD */

{ pre_ign, NULL, 0 }, /* AT */

{ pre_in, NULL, MAN_NOTEXT }, /* in */

{ pre_ft, NULL, MAN_NOTEXT }, /* ft */

{ pre_OP, NULL, 0 }, /* OP */

{ pre_literal, NULL, 0 }, /* EX */

{ pre_literal, NULL, 0 }, /* EE */

{ pre_UR, post_UR, 0 }, /* UR */

{ NULL, NULL, 0 }, /* UE */

};

Line 134 terminal_man(void *arg, const struct man *man)

Line 142 terminal_man(void *arg, const struct man *man)

{

struct termp *p;

const struct man_node *n;

const struct man_meta *m;

const struct man_meta *meta;

struct mtermp mt;

p = (struct termp *)arg;

Line 150 terminal_man(void *arg, const struct man *man)

Line 158 terminal_man(void *arg, const struct man *man)

p->symtab = mchars_alloc();

n = man_node(man);

m = man_meta(man);

meta = man_meta(man);

term_begin(p, print_man_head, print_man_foot, m);

term_begin(p, print_man_head, print_man_foot, meta);

p->flags |= TERMP_NOSPACE;

memset(&mt, 0, sizeof(struct mtermp));

mt.lmargin[mt.lmargincur] = term_len(p, p->defindent);

mt.offset = term_len(p, p->defindent);

mt.pardist = 1;

if (n->child)

print_man_nodelist(p, &mt, n->child, m);

print_man_nodelist(p, &mt, n->child, meta);

term_end(p);

}

Line 199 a2width(const struct termp *p, const char *cp)

Line 208 a2width(const struct termp *p, const char *cp)

* first, print it.

static void

print_bvspace(struct termp *p, const struct man_node *n)

print_bvspace(struct termp *p, const struct man_node *n, int pardist)

{

int i;

term_newln(p);

Line 212 print_bvspace(struct termp *p, const struct man_node *

Line 222 print_bvspace(struct termp *p, const struct man_node *

if (NULL == n->prev)

return;

term_vspace(p);

for (i = 0; i < pardist; i++)

term_vspace(p);

}

/* ARGSUSED */

Line 241 pre_literal(DECL_ARGS)

Line 252 pre_literal(DECL_ARGS)

term_newln(p);

if (MAN_nf == n->tok)

if (MAN_nf == n->tok || MAN_EX == n->tok)

mt->fl |= MANT_LITERAL;

else

mt->fl &= ~MANT_LITERAL;

Line 254 pre_literal(DECL_ARGS)

Line 265 pre_literal(DECL_ARGS)

if (MAN_HP == n->parent->tok && p->rmargin < p->maxrmargin) {

p->offset = p->rmargin;

p->rmargin = p->maxrmargin;

p->flags &= ~(TERMP_NOBREAK | TERMP_TWOSPACE);

p->trailspace = 0;

p->flags &= ~TERMP_NOBREAK;

p->flags |= TERMP_NOSPACE;

}

Line 263 pre_literal(DECL_ARGS)

Line 275 pre_literal(DECL_ARGS)

/* ARGSUSED */

static int

pre_PD(DECL_ARGS)

{

n = n->child;

if (0 == n) {

mt->pardist = 1;

return(0);

}

assert(MAN_TEXT == n->type);

mt->pardist = atoi(n->string);

return(0);

}

/* ARGSUSED */

static int

pre_alternate(DECL_ARGS)

{

enum termfont font[2];

Line 305 pre_alternate(DECL_ARGS)

Line 332 pre_alternate(DECL_ARGS)

term_fontrepl(p, font[i]);

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

mt->fl |= MANT_LITERAL;

print_man_node(p, mt, nn, m);

print_man_node(p, mt, nn, meta);

if (nn->next)

p->flags |= TERMP_NOSPACE;

}

Line 324 pre_B(DECL_ARGS)

Line 351 pre_B(DECL_ARGS)

/* ARGSUSED */

static int

pre_OP(DECL_ARGS)

{

term_word(p, "[");

p->flags |= TERMP_NOSPACE;

if (NULL != (n = n->child)) {

term_fontrepl(p, TERMFONT_BOLD);

term_word(p, n->string);

}

if (NULL != n && NULL != n->next) {

term_fontrepl(p, TERMFONT_UNDER);

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

}

term_fontrepl(p, TERMFONT_NONE);

p->flags |= TERMP_NOSPACE;

term_word(p, "]");

return(0);

}

/* ARGSUSED */

static int

pre_ft(DECL_ARGS)

{

const char *cp;

Line 413 pre_in(DECL_ARGS)

Line 463 pre_in(DECL_ARGS)

static int

pre_sp(DECL_ARGS)

{

char *s;

size_t i, len;

int neg;

if ((NULL == n->prev && n->parent)) {

if (MAN_SS == n->parent->tok)

switch (n->parent->tok) {

case (MAN_SH):

/* FALLTHROUGH */

case (MAN_SS):

/* FALLTHROUGH */

case (MAN_PP):

/* FALLTHROUGH */

case (MAN_LP):

/* FALLTHROUGH */

case (MAN_P):

/* FALLTHROUGH */

return(0);

if (MAN_SH == n->parent->tok)

default:

return(0);

break;

}

neg = 0;

switch (n->tok) {

case (MAN_br):

len = 0;

break;

default:

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

if (NULL == n->child) {

len = 1;

break;

}

s = n->child->string;

if ('-' == *s) {

neg = 1;

s++;

}

len = a2height(p, s);

break;

}

if (0 == len)

term_newln(p);

for (i = 0; i < len; i++)

else if (neg)

term_vspace(p);

p->skipvsp += len;

else

for (i = 0; i < len; i++)

term_vspace(p);

return(0);

}

Line 450 pre_HP(DECL_ARGS)

Line 526 pre_HP(DECL_ARGS)

switch (n->type) {

case (MAN_BLOCK):

print_bvspace(p, n);

print_bvspace(p, n, mt->pardist);

return(1);

case (MAN_BODY):

p->flags |= TERMP_NOBREAK;

p->flags |= TERMP_TWOSPACE;

break;

default:

return(0);

}

if ( ! (MANT_LITERAL & mt->fl)) {

p->flags |= TERMP_NOBREAK;

p->trailspace = 2;

}

len = mt->lmargin[mt->lmargincur];

ival = -1;

Line 489 post_HP(DECL_ARGS)

Line 568 post_HP(DECL_ARGS)

{

switch (n->type) {

case (MAN_BLOCK):

term_flushln(p);

break;

case (MAN_BODY):

term_flushln(p);

term_newln(p);

p->flags &= ~TERMP_NOBREAK;

p->flags &= ~TERMP_TWOSPACE;

p->trailspace = 0;

p->offset = mt->offset;

p->rmargin = p->maxrmargin;

break;

Line 513 pre_PP(DECL_ARGS)

Line 589 pre_PP(DECL_ARGS)

switch (n->type) {

case (MAN_BLOCK):

mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);

print_bvspace(p, n);

print_bvspace(p, n, mt->pardist);

break;

default:

p->offset = mt->offset;

Line 538 pre_IP(DECL_ARGS)

Line 614 pre_IP(DECL_ARGS)

break;

case (MAN_HEAD):

p->flags |= TERMP_NOBREAK;

p->trailspace = 1;

break;

case (MAN_BLOCK):

print_bvspace(p, n);

print_bvspace(p, n, mt->pardist);

/* FALLTHROUGH */

default:

return(1);

Line 573 pre_IP(DECL_ARGS)

Line 650 pre_IP(DECL_ARGS)

mt->fl &= ~MANT_LITERAL;

if (n->child)

print_man_node(p, mt, n->child, m);

print_man_node(p, mt, n->child, meta);

if (savelit)

mt->fl |= MANT_LITERAL;

Line 581 pre_IP(DECL_ARGS)

Line 658 pre_IP(DECL_ARGS)

return(0);

case (MAN_BODY):

p->offset = mt->offset + len;

p->rmargin = p->maxrmargin;

p->rmargin = p->maxrmargin > p->offset ?

p->maxrmargin : p->offset;

break;

default:

break;

Line 600 post_IP(DECL_ARGS)

Line 678 post_IP(DECL_ARGS)

case (MAN_HEAD):

term_flushln(p);

p->flags &= ~TERMP_NOBREAK;

p->trailspace = 0;

p->rmargin = p->maxrmargin;

break;

case (MAN_BODY):

term_newln(p);

p->offset = mt->offset;

break;

default:

break;

Line 622 pre_TP(DECL_ARGS)

Line 702 pre_TP(DECL_ARGS)

switch (n->type) {

case (MAN_HEAD):

p->flags |= TERMP_NOBREAK;

p->trailspace = 1;

break;

case (MAN_BODY):

p->flags |= TERMP_NOSPACE;

break;

case (MAN_BLOCK):

print_bvspace(p, n);

print_bvspace(p, n, mt->pardist);

/* FALLTHROUGH */

default:

return(1);

Line 639 pre_TP(DECL_ARGS)

Line 720 pre_TP(DECL_ARGS)

/* Calculate offset. */

if (NULL != (nn = n->parent->head->child))

if (nn->string && nn->parent->line == nn->line)

if (nn->string && 0 == (MAN_LINE & nn->flags))

if ((ival = a2width(p, nn->string)) >= 0)

len = (size_t)ival;

Line 656 pre_TP(DECL_ARGS)

Line 737 pre_TP(DECL_ARGS)

mt->fl &= ~MANT_LITERAL;

/* Don't print same-line elements. */

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

nn = n->child;

if (nn->line > n->line)

while (NULL != nn && 0 == (MAN_LINE & nn->flags))

print_man_node(p, mt, nn, m);

nn = nn->next;

while (NULL != nn) {

print_man_node(p, mt, nn, meta);

nn = nn->next;

}

if (savelit)

mt->fl |= MANT_LITERAL;

if (ival >= 0)

Line 668 pre_TP(DECL_ARGS)

Line 754 pre_TP(DECL_ARGS)

return(0);

case (MAN_BODY):

p->offset = mt->offset + len;

p->rmargin = p->maxrmargin;

p->rmargin = p->maxrmargin > p->offset ?

p->maxrmargin : p->offset;

p->trailspace = 0;

p->flags &= ~TERMP_NOBREAK;

break;

default:

break;

Line 686 post_TP(DECL_ARGS)

Line 775 post_TP(DECL_ARGS)

switch (n->type) {

case (MAN_HEAD):

term_flushln(p);

p->flags &= ~TERMP_NOBREAK;

p->flags &= ~TERMP_TWOSPACE;

p->rmargin = p->maxrmargin;

break;

case (MAN_BODY):

term_newln(p);

p->offset = mt->offset;

break;

default:

break;

Line 703 post_TP(DECL_ARGS)

Line 790 post_TP(DECL_ARGS)

static int

pre_SS(DECL_ARGS)

{

int i;

switch (n->type) {

case (MAN_BLOCK):

Line 715 pre_SS(DECL_ARGS)

Line 803 pre_SS(DECL_ARGS)

break;

if (NULL == n->prev)

break;

term_vspace(p);

for (i = 0; i < mt->pardist; i++)

term_vspace(p);

break;

case (MAN_HEAD):

term_fontrepl(p, TERMFONT_BOLD);

p->offset = term_len(p, p->defindent/2);

p->offset = term_len(p, 3);

break;

case (MAN_BODY):

p->offset = mt->offset;

Line 754 post_SS(DECL_ARGS)

Line 843 post_SS(DECL_ARGS)

static int

pre_SH(DECL_ARGS)

{

int i;

switch (n->type) {

case (MAN_BLOCK):

Line 767 pre_SH(DECL_ARGS)

Line 857 pre_SH(DECL_ARGS)

/* If the first macro, no vspae. */

if (NULL == n->prev)

break;

term_vspace(p);

for (i = 0; i < mt->pardist; i++)

term_vspace(p);

break;

case (MAN_HEAD):

term_fontrepl(p, TERMFONT_BOLD);

Line 825 pre_RS(DECL_ARGS)

Line 916 pre_RS(DECL_ARGS)

sz = (size_t)ival;

mt->offset += sz;

p->rmargin = p->maxrmargin;

p->offset = mt->offset;

p->offset = mt->offset < p->rmargin ? mt->offset : p->rmargin;

p->rmargin = p->maxrmargin > p->offset ?

p->maxrmargin : p->offset;

if (++mt->lmarginsz < MAXMARGINS)

mt->lmargincur = mt->lmarginsz;

Line 865 post_RS(DECL_ARGS)

Line 957 post_RS(DECL_ARGS)

mt->lmargincur = mt->lmarginsz;

}

/* ARGSUSED */

static int

pre_UR(DECL_ARGS)

{

return (MAN_HEAD != n->type);

}

/* ARGSUSED */

static void

post_UR(DECL_ARGS)

{

if (MAN_BLOCK != n->type)

return;

term_word(p, "<");

p->flags |= TERMP_NOSPACE;

if (NULL != n->child->child)

print_man_node(p, mt, n->child->child, meta);

p->flags |= TERMP_NOSPACE;

term_word(p, ">");

}

static void

print_man_node(DECL_ARGS)

{

size_t rm, rmax;

Line 885 print_man_node(DECL_ARGS)

Line 1003 print_man_node(DECL_ARGS)

term_newln(p);

term_word(p, n->string);

goto out;

* If we're in a literal context, make sure that words

* togehter on the same line stay together. This is a

* POST-printing call, so we check the NEXT word. Since

* -man doesn't have nested macros, we don't need to be

* more specific than this.

if (MANT_LITERAL & mt->fl && ! (TERMP_NOBREAK & p->flags) &&

(NULL == n->next ||

n->next->line > n->line)) {

rm = p->rmargin;

rmax = p->maxrmargin;

p->rmargin = p->maxrmargin = TERM_MAXMARGIN;

p->flags |= TERMP_NOSPACE;

term_flushln(p);

p->rmargin = rm;

p->maxrmargin = rmax;

}

if (MAN_EOS & n->flags)

p->flags |= TERMP_SENTENCE;

return;

case (MAN_EQN):

term_eqn(p, n->eqn);

return;

Line 929 print_man_node(DECL_ARGS)

Line 1026 print_man_node(DECL_ARGS)

c = 1;

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

c = (*termacts[n->tok].pre)(p, mt, n, m);

c = (*termacts[n->tok].pre)(p, mt, n, meta);

if (c && n->child)

print_man_nodelist(p, mt, n->child, m);

print_man_nodelist(p, mt, n->child, meta);

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

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

(*termacts[n->tok].post)(p, mt, n, meta);

if ( ! (MAN_NOTEXT & termacts[n->tok].flags))

term_fontrepl(p, TERMFONT_NONE);

out:

* If we're in a literal context, make sure that words

* together on the same line stay together. This is a

* POST-printing call, so we check the NEXT word. Since

* -man doesn't have nested macros, we don't need to be

* more specific than this.

if (MANT_LITERAL & mt->fl && ! (TERMP_NOBREAK & p->flags) &&

(NULL == n->next || MAN_LINE & n->next->flags)) {

rm = p->rmargin;

rmax = p->maxrmargin;

p->rmargin = p->maxrmargin = TERM_MAXMARGIN;

p->flags |= TERMP_NOSPACE;

if (NULL != n->string && '\0' != *n->string)

term_flushln(p);

else

term_newln(p);

if (rm < rmax && n->parent->tok == MAN_HP) {

p->offset = rm;

p->rmargin = rmax;

} else

p->rmargin = rm;

p->maxrmargin = rmax;

}

if (MAN_EOS & n->flags)

p->flags |= TERMP_SENTENCE;

}

Line 948 static void

Line 1070 static void

print_man_nodelist(DECL_ARGS)

{

print_man_node(p, mt, n, m);

print_man_node(p, mt, n, meta);

if ( ! n->next)

return;

print_man_nodelist(p, mt, n->next, m);

print_man_nodelist(p, mt, n->next, meta);

}

Line 970 print_man_foot(struct termp *p, const void *arg)

Line 1092 print_man_foot(struct termp *p, const void *arg)

term_fontrepl(p, TERMFONT_NONE);

term_vspace(p);

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

* Temporary, undocumented option to imitate mdoc(7) output.

* In the bottom right corner, use the source instead of

* the title.

if ( ! p->mdocstyle) {

term_vspace(p);

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

} else if (meta->source) {

strlcpy(title, meta->source, BUFSIZ);

} else {

title[0] = '\0';

}

datelen = term_strlen(p, meta->date);

/* Bottom left corner: manual source. */

p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;

p->trailspace = 1;

p->offset = 0;

p->rmargin = (p->maxrmargin - datelen + term_len(p, 1)) / 2;

Line 983 print_man_foot(struct termp *p, const void *arg)

Line 1121 print_man_foot(struct termp *p, const void *arg)

term_word(p, meta->source);

term_flushln(p);

/* At the bottom in the middle: manual date. */

p->flags |= TERMP_NOSPACE;

p->offset = p->rmargin;

p->rmargin = p->maxrmargin - term_strlen(p, title);

Line 992 print_man_foot(struct termp *p, const void *arg)

Line 1132 print_man_foot(struct termp *p, const void *arg)

term_word(p, meta->date);

term_flushln(p);

/* Bottom right corner: manual title and section. */

p->flags &= ~TERMP_NOBREAK;

p->flags |= TERMP_NOSPACE;

p->trailspace = 0;

p->offset = p->rmargin;

p->rmargin = p->maxrmargin;

Line 1007 print_man_head(struct termp *p, const void *arg)

Line 1150 print_man_head(struct termp *p, const void *arg)

{

char buf[BUFSIZ], title[BUFSIZ];

size_t buflen, titlen;

const struct man_meta *m;

const struct man_meta *meta;

m = (const struct man_meta *)arg;

meta = (const struct man_meta *)arg;

assert(m->title);

assert(meta->title);

assert(m->msec);

assert(meta->msec);

if (meta->vol)

* Note that old groff would spit out some spaces before the

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

* header. We discontinue this strange behaviour, but at one

else

* point we did so here.

buf[0] = '\0';

p->offset = 0;

p->rmargin = p->maxrmargin;

buf[0] = title[0] = '\0';

if (m->vol)

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

buflen = term_strlen(p, buf);

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

/* Top left corner: manual title and section. */

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

titlen = term_strlen(p, title);

p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;

p->trailspace = 1;

p->offset = 0;

p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ?

(p->maxrmargin -

Line 1041 print_man_head(struct termp *p, const void *arg)

Line 1178 print_man_head(struct termp *p, const void *arg)

term_word(p, title);

term_flushln(p);

/* At the top in the middle: manual volume. */

p->flags |= TERMP_NOSPACE;

p->offset = p->rmargin;

p->rmargin = p->offset + buflen + titlen < p->maxrmargin ?

Line 1049 print_man_head(struct termp *p, const void *arg)

Line 1188 print_man_head(struct termp *p, const void *arg)

term_word(p, buf);

term_flushln(p);

/* Top right corner: title and section, again. */

p->flags &= ~TERMP_NOBREAK;

p->trailspace = 0;

if (p->rmargin + titlen <= p->maxrmargin) {

p->flags |= TERMP_NOSPACE;

p->offset = p->rmargin;

Line 1063 print_man_head(struct termp *p, const void *arg)

Line 1205 print_man_head(struct termp *p, const void *arg)

p->rmargin = p->maxrmargin;

* Groff likes to have some leading spaces before content. Well

* Groff prints three blank lines before the content.

* that's fine by me.

* Do the same, except in the temporary, undocumented

* mode imitating mdoc(7) output.

term_vspace(p);

if ( ! p->mdocstyle) {

term_vspace(p);

}

CVSweb