freebsd-skq/contrib/mdocml/man_term.c

1206 lines
23 KiB
C
Raw Normal View History

2014-12-25 21:33:25 +00:00
/* $Id: man_term.c,v 1.159 2014/12/04 02:05:42 schwarze Exp $ */
/*
2014-01-31 19:59:03 +00:00
* Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
2014-11-22 18:08:25 +00:00
* Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include "config.h"
#include <sys/types.h>
#include <assert.h>
#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "mandoc.h"
2014-11-22 18:08:25 +00:00
#include "mandoc_aux.h"
#include "out.h"
#include "man.h"
#include "term.h"
#include "main.h"
#define MAXMARGINS 64 /* maximum number of indented scopes */
struct mtermp {
int fl;
#define MANT_LITERAL (1 << 0)
size_t lmargin[MAXMARGINS]; /* margins (incl. visible page) */
int lmargincur; /* index of current margin */
int lmarginsz; /* actual number of nested margins */
size_t offset; /* default offset to visible page */
2014-01-31 19:59:03 +00:00
int pardist; /* vert. space before par., unit: [v] */
};
2014-11-22 18:08:25 +00:00
#define DECL_ARGS struct termp *p, \
struct mtermp *mt, \
const struct man_node *n, \
2014-01-31 19:59:03 +00:00
const struct man_meta *meta
struct termact {
int (*pre)(DECL_ARGS);
void (*post)(DECL_ARGS);
int flags;
#define MAN_NOTEXT (1 << 0) /* Never has text children. */
};
static int a2width(const struct termp *, const char *);
static size_t a2height(const struct termp *, const char *);
static void print_man_nodelist(DECL_ARGS);
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 *);
2014-11-22 18:08:25 +00:00
static void print_bvspace(struct termp *,
2014-01-31 19:59:03 +00:00
const struct man_node *, int);
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);
2014-01-31 19:59:03 +00:00
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);
2014-01-31 19:59:03 +00:00
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);
2014-11-22 18:08:25 +00:00
static int pre_ll(DECL_ARGS);
static int pre_sp(DECL_ARGS);
static void post_IP(DECL_ARGS);
static void post_HP(DECL_ARGS);
static void post_RS(DECL_ARGS);
static void post_SH(DECL_ARGS);
static void post_SS(DECL_ARGS);
static void post_TP(DECL_ARGS);
2014-01-31 19:59:03 +00:00
static void post_UR(DECL_ARGS);
static const struct termact termacts[MAN_MAX] = {
{ pre_sp, NULL, MAN_NOTEXT }, /* br */
{ NULL, NULL, 0 }, /* TH */
{ pre_SH, post_SH, 0 }, /* SH */
{ pre_SS, post_SS, 0 }, /* SS */
{ pre_TP, post_TP, 0 }, /* TP */
{ pre_PP, NULL, 0 }, /* LP */
{ pre_PP, NULL, 0 }, /* PP */
{ pre_PP, NULL, 0 }, /* P */
{ pre_IP, post_IP, 0 }, /* IP */
2014-11-22 18:08:25 +00:00
{ pre_HP, post_HP, 0 }, /* HP */
{ NULL, NULL, 0 }, /* SM */
{ pre_B, NULL, 0 }, /* SB */
{ pre_alternate, NULL, 0 }, /* BI */
{ pre_alternate, NULL, 0 }, /* IB */
{ pre_alternate, NULL, 0 }, /* BR */
{ pre_alternate, NULL, 0 }, /* RB */
{ NULL, NULL, 0 }, /* R */
{ pre_B, NULL, 0 }, /* B */
{ pre_I, NULL, 0 }, /* I */
{ pre_alternate, NULL, 0 }, /* IR */
{ pre_alternate, NULL, 0 }, /* RI */
{ pre_ign, NULL, MAN_NOTEXT }, /* na */
{ pre_sp, NULL, MAN_NOTEXT }, /* sp */
{ pre_literal, NULL, 0 }, /* nf */
{ pre_literal, NULL, 0 }, /* fi */
{ NULL, NULL, 0 }, /* RE */
{ pre_RS, post_RS, 0 }, /* RS */
{ pre_ign, NULL, 0 }, /* DT */
2014-12-25 21:33:25 +00:00
{ pre_ign, NULL, MAN_NOTEXT }, /* UC */
2014-01-31 19:59:03 +00:00
{ 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 */
2014-01-31 19:59:03 +00:00
{ pre_literal, NULL, 0 }, /* EX */
{ pre_literal, NULL, 0 }, /* EE */
{ pre_UR, post_UR, 0 }, /* UR */
{ NULL, NULL, 0 }, /* UE */
2014-11-22 18:08:25 +00:00
{ pre_ll, NULL, MAN_NOTEXT }, /* ll */
};
void
terminal_man(void *arg, const struct man *man)
{
struct termp *p;
2014-01-31 19:59:03 +00:00
const struct man_meta *meta;
struct man_node *n;
struct mtermp mt;
p = (struct termp *)arg;
p->overstep = 0;
p->rmargin = p->maxrmargin = p->defrmargin;
p->tabwidth = term_len(p, 5);
n = man_node(man)->child;
2014-01-31 19:59:03 +00:00
meta = man_meta(man);
memset(&mt, 0, sizeof(struct mtermp));
mt.lmargin[mt.lmargincur] = term_len(p, p->defindent);
mt.offset = term_len(p, p->defindent);
2014-01-31 19:59:03 +00:00
mt.pardist = 1;
if (p->synopsisonly) {
while (n != NULL) {
if (n->tok == MAN_SH &&
n->child->child->type == MAN_TEXT &&
!strcmp(n->child->child->string, "SYNOPSIS")) {
if (n->child->next->child != NULL)
print_man_nodelist(p, &mt,
n->child->next->child, meta);
term_newln(p);
break;
}
n = n->next;
}
} else {
if (p->defindent == 0)
p->defindent = 7;
term_begin(p, print_man_head, print_man_foot, meta);
p->flags |= TERMP_NOSPACE;
if (n != NULL)
print_man_nodelist(p, &mt, n, meta);
term_end(p);
}
}
static size_t
a2height(const struct termp *p, const char *cp)
{
struct roffsu su;
if ( ! a2roffsu(cp, &su, SCALE_VS))
SCALE_VS_INIT(&su, atoi(cp));
return(term_vspan(p, &su));
}
static int
a2width(const struct termp *p, const char *cp)
{
struct roffsu su;
2014-12-25 21:33:25 +00:00
if ( ! a2roffsu(cp, &su, SCALE_EN))
return(-1);
return((int)term_hspan(p, &su));
}
/*
* Printing leading vertical space before a block.
* This is used for the paragraph macros.
* The rules are pretty simple, since there's very little nesting going
* on here. Basically, if we're the first within another block (SS/SH),
* then don't emit vertical space. If we are (RS), then do. If not the
* first, print it.
*/
static void
2014-01-31 19:59:03 +00:00
print_bvspace(struct termp *p, const struct man_node *n, int pardist)
{
2014-01-31 19:59:03 +00:00
int i;
term_newln(p);
if (n->body && n->body->child)
if (MAN_TBL == n->body->child->type)
return;
if (MAN_ROOT == n->parent->type || MAN_RS != n->parent->tok)
if (NULL == n->prev)
return;
2014-01-31 19:59:03 +00:00
for (i = 0; i < pardist; i++)
term_vspace(p);
}
2014-11-22 18:08:25 +00:00
static int
pre_ign(DECL_ARGS)
{
return(0);
}
2014-11-22 18:08:25 +00:00
static int
pre_ll(DECL_ARGS)
{
term_setwidth(p, n->nchild ? n->child->string : NULL);
return(0);
}
static int
pre_I(DECL_ARGS)
{
term_fontrepl(p, TERMFONT_UNDER);
return(1);
}
static int
pre_literal(DECL_ARGS)
{
term_newln(p);
2014-01-31 19:59:03 +00:00
if (MAN_nf == n->tok || MAN_EX == n->tok)
mt->fl |= MANT_LITERAL;
else
mt->fl &= ~MANT_LITERAL;
/*
* Unlike .IP and .TP, .HP does not have a HEAD.
* So in case a second call to term_flushln() is needed,
* indentation has to be set up explicitly.
*/
if (MAN_HP == n->parent->tok && p->rmargin < p->maxrmargin) {
p->offset = p->rmargin;
p->rmargin = p->maxrmargin;
2014-01-31 19:59:03 +00:00
p->trailspace = 0;
2014-11-22 18:08:25 +00:00
p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
p->flags |= TERMP_NOSPACE;
}
return(0);
}
2014-01-31 19:59:03 +00:00
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);
}
static int
pre_alternate(DECL_ARGS)
{
enum termfont font[2];
const struct man_node *nn;
int savelit, i;
switch (n->tok) {
2014-11-22 18:08:25 +00:00
case MAN_RB:
font[0] = TERMFONT_NONE;
font[1] = TERMFONT_BOLD;
break;
2014-11-22 18:08:25 +00:00
case MAN_RI:
font[0] = TERMFONT_NONE;
font[1] = TERMFONT_UNDER;
break;
2014-11-22 18:08:25 +00:00
case MAN_BR:
font[0] = TERMFONT_BOLD;
font[1] = TERMFONT_NONE;
break;
2014-11-22 18:08:25 +00:00
case MAN_BI:
font[0] = TERMFONT_BOLD;
font[1] = TERMFONT_UNDER;
break;
2014-11-22 18:08:25 +00:00
case MAN_IR:
font[0] = TERMFONT_UNDER;
font[1] = TERMFONT_NONE;
break;
2014-11-22 18:08:25 +00:00
case MAN_IB:
font[0] = TERMFONT_UNDER;
font[1] = TERMFONT_BOLD;
break;
default:
abort();
}
savelit = MANT_LITERAL & mt->fl;
mt->fl &= ~MANT_LITERAL;
for (i = 0, nn = n->child; nn; nn = nn->next, i = 1 - i) {
term_fontrepl(p, font[i]);
if (savelit && NULL == nn->next)
mt->fl |= MANT_LITERAL;
2014-01-31 19:59:03 +00:00
print_man_node(p, mt, nn, meta);
if (nn->next)
p->flags |= TERMP_NOSPACE;
}
return(0);
}
static int
pre_B(DECL_ARGS)
{
term_fontrepl(p, TERMFONT_BOLD);
return(1);
}
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);
}
static int
pre_ft(DECL_ARGS)
{
const char *cp;
if (NULL == n->child) {
term_fontlast(p);
return(0);
}
cp = n->child->string;
switch (*cp) {
2014-11-22 18:08:25 +00:00
case '4':
/* FALLTHROUGH */
2014-11-22 18:08:25 +00:00
case '3':
/* FALLTHROUGH */
2014-11-22 18:08:25 +00:00
case 'B':
term_fontrepl(p, TERMFONT_BOLD);
break;
2014-11-22 18:08:25 +00:00
case '2':
/* FALLTHROUGH */
2014-11-22 18:08:25 +00:00
case 'I':
term_fontrepl(p, TERMFONT_UNDER);
break;
2014-11-22 18:08:25 +00:00
case 'P':
term_fontlast(p);
break;
2014-11-22 18:08:25 +00:00
case '1':
/* FALLTHROUGH */
2014-11-22 18:08:25 +00:00
case 'C':
/* FALLTHROUGH */
2014-11-22 18:08:25 +00:00
case 'R':
term_fontrepl(p, TERMFONT_NONE);
break;
default:
break;
}
return(0);
}
static int
pre_in(DECL_ARGS)
{
int len, less;
size_t v;
const char *cp;
term_newln(p);
if (NULL == n->child) {
p->offset = mt->offset;
return(0);
}
cp = n->child->string;
less = 0;
if ('-' == *cp)
less = -1;
else if ('+' == *cp)
less = 1;
else
cp--;
if ((len = a2width(p, ++cp)) < 0)
return(0);
v = (size_t)len;
if (less < 0)
p->offset -= p->offset > v ? v : p->offset;
else if (less > 0)
p->offset += v;
2014-11-22 18:08:25 +00:00
else
p->offset = v;
return(0);
}
static int
pre_sp(DECL_ARGS)
{
2014-01-31 19:59:03 +00:00
char *s;
size_t i, len;
2014-01-31 19:59:03 +00:00
int neg;
if ((NULL == n->prev && n->parent)) {
2014-01-31 19:59:03 +00:00
switch (n->parent->tok) {
2014-11-22 18:08:25 +00:00
case MAN_SH:
2014-01-31 19:59:03 +00:00
/* FALLTHROUGH */
2014-11-22 18:08:25 +00:00
case MAN_SS:
2014-01-31 19:59:03 +00:00
/* FALLTHROUGH */
2014-11-22 18:08:25 +00:00
case MAN_PP:
2014-01-31 19:59:03 +00:00
/* FALLTHROUGH */
2014-11-22 18:08:25 +00:00
case MAN_LP:
2014-01-31 19:59:03 +00:00
/* FALLTHROUGH */
2014-11-22 18:08:25 +00:00
case MAN_P:
2014-01-31 19:59:03 +00:00
/* FALLTHROUGH */
return(0);
2014-01-31 19:59:03 +00:00
default:
break;
}
}
2014-01-31 19:59:03 +00:00
neg = 0;
switch (n->tok) {
2014-11-22 18:08:25 +00:00
case MAN_br:
len = 0;
break;
default:
2014-01-31 19:59:03 +00:00
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);
2014-01-31 19:59:03 +00:00
else if (neg)
p->skipvsp += len;
else
for (i = 0; i < len; i++)
term_vspace(p);
return(0);
}
static int
pre_HP(DECL_ARGS)
{
size_t len, one;
int ival;
const struct man_node *nn;
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_BLOCK:
2014-01-31 19:59:03 +00:00
print_bvspace(p, n, mt->pardist);
return(1);
2014-11-22 18:08:25 +00:00
case MAN_BODY:
break;
default:
return(0);
}
2014-01-31 19:59:03 +00:00
if ( ! (MANT_LITERAL & mt->fl)) {
2014-11-22 18:08:25 +00:00
p->flags |= TERMP_NOBREAK | TERMP_BRIND;
2014-01-31 19:59:03 +00:00
p->trailspace = 2;
}
len = mt->lmargin[mt->lmargincur];
ival = -1;
/* Calculate offset. */
if (NULL != (nn = n->parent->head->child))
if ((ival = a2width(p, nn->string)) >= 0)
len = (size_t)ival;
one = term_len(p, 1);
if (len < one)
len = one;
p->offset = mt->offset;
p->rmargin = mt->offset + len;
if (ival >= 0)
mt->lmargin[mt->lmargincur] = (size_t)ival;
return(1);
}
static void
post_HP(DECL_ARGS)
{
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_BODY:
2014-01-31 19:59:03 +00:00
term_newln(p);
2014-11-22 18:08:25 +00:00
p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
2014-01-31 19:59:03 +00:00
p->trailspace = 0;
p->offset = mt->offset;
p->rmargin = p->maxrmargin;
break;
default:
break;
}
}
static int
pre_PP(DECL_ARGS)
{
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_BLOCK:
mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
2014-01-31 19:59:03 +00:00
print_bvspace(p, n, mt->pardist);
break;
default:
p->offset = mt->offset;
break;
}
return(MAN_HEAD != n->type);
}
static int
pre_IP(DECL_ARGS)
{
const struct man_node *nn;
size_t len;
int savelit, ival;
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_BODY:
p->flags |= TERMP_NOSPACE;
break;
2014-11-22 18:08:25 +00:00
case MAN_HEAD:
p->flags |= TERMP_NOBREAK;
2014-01-31 19:59:03 +00:00
p->trailspace = 1;
break;
2014-11-22 18:08:25 +00:00
case MAN_BLOCK:
2014-01-31 19:59:03 +00:00
print_bvspace(p, n, mt->pardist);
/* FALLTHROUGH */
default:
return(1);
}
len = mt->lmargin[mt->lmargincur];
ival = -1;
/* Calculate the offset from the optional second argument. */
if (NULL != (nn = n->parent->head->child))
if (NULL != (nn = nn->next))
if ((ival = a2width(p, nn->string)) >= 0)
len = (size_t)ival;
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_HEAD:
/* Handle zero-width lengths. */
if (0 == len)
len = term_len(p, 1);
p->offset = mt->offset;
p->rmargin = mt->offset + len;
if (ival < 0)
break;
/* Set the saved left-margin. */
mt->lmargin[mt->lmargincur] = (size_t)ival;
savelit = MANT_LITERAL & mt->fl;
mt->fl &= ~MANT_LITERAL;
if (n->child)
2014-01-31 19:59:03 +00:00
print_man_node(p, mt, n->child, meta);
if (savelit)
mt->fl |= MANT_LITERAL;
return(0);
2014-11-22 18:08:25 +00:00
case MAN_BODY:
p->offset = mt->offset + len;
p->rmargin = p->maxrmargin;
break;
default:
break;
}
return(1);
}
static void
post_IP(DECL_ARGS)
{
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_HEAD:
term_flushln(p);
p->flags &= ~TERMP_NOBREAK;
2014-01-31 19:59:03 +00:00
p->trailspace = 0;
p->rmargin = p->maxrmargin;
break;
2014-11-22 18:08:25 +00:00
case MAN_BODY:
term_newln(p);
2014-01-31 19:59:03 +00:00
p->offset = mt->offset;
break;
default:
break;
}
}
static int
pre_TP(DECL_ARGS)
{
const struct man_node *nn;
size_t len;
int savelit, ival;
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_HEAD:
p->flags |= TERMP_NOBREAK;
2014-01-31 19:59:03 +00:00
p->trailspace = 1;
break;
2014-11-22 18:08:25 +00:00
case MAN_BODY:
p->flags |= TERMP_NOSPACE;
break;
2014-11-22 18:08:25 +00:00
case MAN_BLOCK:
2014-01-31 19:59:03 +00:00
print_bvspace(p, n, mt->pardist);
/* FALLTHROUGH */
default:
return(1);
}
len = (size_t)mt->lmargin[mt->lmargincur];
ival = -1;
/* Calculate offset. */
if (NULL != (nn = n->parent->head->child))
2014-11-22 18:08:25 +00:00
if (nn->string && 0 == (MAN_LINE & nn->flags))
if ((ival = a2width(p, nn->string)) >= 0)
len = (size_t)ival;
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_HEAD:
/* Handle zero-length properly. */
if (0 == len)
len = term_len(p, 1);
p->offset = mt->offset;
p->rmargin = mt->offset + len;
savelit = MANT_LITERAL & mt->fl;
mt->fl &= ~MANT_LITERAL;
/* Don't print same-line elements. */
2014-11-22 18:08:25 +00:00
nn = n->child;
while (NULL != nn && 0 == (MAN_LINE & nn->flags))
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)
mt->lmargin[mt->lmargincur] = (size_t)ival;
return(0);
2014-11-22 18:08:25 +00:00
case MAN_BODY:
p->offset = mt->offset + len;
p->rmargin = p->maxrmargin;
2014-01-31 19:59:03 +00:00
p->trailspace = 0;
p->flags &= ~TERMP_NOBREAK;
break;
default:
break;
}
return(1);
}
static void
post_TP(DECL_ARGS)
{
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_HEAD:
term_flushln(p);
break;
2014-11-22 18:08:25 +00:00
case MAN_BODY:
term_newln(p);
2014-01-31 19:59:03 +00:00
p->offset = mt->offset;
break;
default:
break;
}
}
static int
pre_SS(DECL_ARGS)
{
2014-01-31 19:59:03 +00:00
int i;
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_BLOCK:
mt->fl &= ~MANT_LITERAL;
mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
mt->offset = term_len(p, p->defindent);
2014-12-25 21:33:25 +00:00
/*
* No vertical space before the first subsection
* and after an empty subsection.
*/
do {
n = n->prev;
} while (n != NULL && termacts[n->tok].flags & MAN_NOTEXT);
if (n == NULL || (n->tok == MAN_SS && n->body->child == NULL))
break;
2014-12-25 21:33:25 +00:00
2014-01-31 19:59:03 +00:00
for (i = 0; i < mt->pardist; i++)
term_vspace(p);
break;
2014-11-22 18:08:25 +00:00
case MAN_HEAD:
term_fontrepl(p, TERMFONT_BOLD);
2014-01-31 19:59:03 +00:00
p->offset = term_len(p, 3);
break;
2014-11-22 18:08:25 +00:00
case MAN_BODY:
p->offset = mt->offset;
break;
default:
break;
}
return(1);
}
static void
post_SS(DECL_ARGS)
{
2014-11-22 18:08:25 +00:00
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_HEAD:
term_newln(p);
break;
2014-11-22 18:08:25 +00:00
case MAN_BODY:
term_newln(p);
break;
default:
break;
}
}
static int
pre_SH(DECL_ARGS)
{
2014-01-31 19:59:03 +00:00
int i;
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_BLOCK:
mt->fl &= ~MANT_LITERAL;
mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
mt->offset = term_len(p, p->defindent);
2014-12-25 21:33:25 +00:00
/*
* No vertical space before the first section
* and after an empty section.
*/
do {
n = n->prev;
} while (n != NULL && termacts[n->tok].flags & MAN_NOTEXT);
if (n == NULL || (n->tok == MAN_SH && n->body->child == NULL))
break;
2014-12-25 21:33:25 +00:00
2014-01-31 19:59:03 +00:00
for (i = 0; i < mt->pardist; i++)
term_vspace(p);
break;
2014-11-22 18:08:25 +00:00
case MAN_HEAD:
term_fontrepl(p, TERMFONT_BOLD);
p->offset = 0;
break;
2014-11-22 18:08:25 +00:00
case MAN_BODY:
p->offset = mt->offset;
break;
default:
break;
}
return(1);
}
static void
post_SH(DECL_ARGS)
{
2014-11-22 18:08:25 +00:00
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_HEAD:
term_newln(p);
break;
2014-11-22 18:08:25 +00:00
case MAN_BODY:
term_newln(p);
break;
default:
break;
}
}
static int
pre_RS(DECL_ARGS)
{
int ival;
size_t sz;
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_BLOCK:
term_newln(p);
return(1);
2014-11-22 18:08:25 +00:00
case MAN_HEAD:
return(0);
default:
break;
}
sz = term_len(p, p->defindent);
if (NULL != (n = n->parent->head->child))
2014-11-22 18:08:25 +00:00
if ((ival = a2width(p, n->string)) >= 0)
sz = (size_t)ival;
mt->offset += sz;
2014-11-22 18:08:25 +00:00
p->offset = mt->offset;
p->rmargin = p->maxrmargin;
if (++mt->lmarginsz < MAXMARGINS)
mt->lmargincur = mt->lmarginsz;
mt->lmargin[mt->lmargincur] = mt->lmargin[mt->lmargincur - 1];
return(1);
}
static void
post_RS(DECL_ARGS)
{
int ival;
size_t sz;
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_BLOCK:
return;
2014-11-22 18:08:25 +00:00
case MAN_HEAD:
return;
default:
term_newln(p);
break;
}
sz = term_len(p, p->defindent);
2014-11-22 18:08:25 +00:00
if (NULL != (n = n->parent->head->child))
if ((ival = a2width(p, n->string)) >= 0)
sz = (size_t)ival;
mt->offset = mt->offset < sz ? 0 : mt->offset - sz;
p->offset = mt->offset;
if (--mt->lmarginsz < MAXMARGINS)
mt->lmargincur = mt->lmarginsz;
}
2014-01-31 19:59:03 +00:00
static int
pre_UR(DECL_ARGS)
{
return (MAN_HEAD != n->type);
}
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;
int c;
switch (n->type) {
2014-11-22 18:08:25 +00:00
case MAN_TEXT:
/*
* If we have a blank line, output a vertical space.
* If we have a space as the first character, break
* before printing the line's data.
*/
if ('\0' == *n->string) {
term_vspace(p);
return;
} else if (' ' == *n->string && MAN_LINE & n->flags)
term_newln(p);
term_word(p, n->string);
2014-01-31 19:59:03 +00:00
goto out;
2014-11-22 18:08:25 +00:00
case MAN_EQN:
if ( ! (n->flags & MAN_LINE))
p->flags |= TERMP_NOSPACE;
term_eqn(p, n->eqn);
if (n->next != NULL && ! (n->next->flags & MAN_LINE))
p->flags |= TERMP_NOSPACE;
return;
2014-11-22 18:08:25 +00:00
case MAN_TBL:
/*
* Tables are preceded by a newline. Then process a
* table line, which will cause line termination,
*/
2014-11-22 18:08:25 +00:00
if (TBL_SPAN_FIRST & n->span->flags)
term_newln(p);
term_tbl(p, n->span);
return;
default:
break;
}
if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
term_fontrepl(p, TERMFONT_NONE);
c = 1;
if (termacts[n->tok].pre)
2014-01-31 19:59:03 +00:00
c = (*termacts[n->tok].pre)(p, mt, n, meta);
if (c && n->child)
2014-01-31 19:59:03 +00:00
print_man_nodelist(p, mt, n->child, meta);
if (termacts[n->tok].post)
2014-01-31 19:59:03 +00:00
(*termacts[n->tok].post)(p, mt, n, meta);
if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
term_fontrepl(p, TERMFONT_NONE);
2014-01-31 19:59:03 +00:00
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.
*/
2014-12-25 21:33:25 +00:00
if (mt->fl & MANT_LITERAL &&
! (p->flags & (TERMP_NOBREAK | TERMP_NONEWLINE)) &&
(n->next == NULL || n->next->flags & MAN_LINE)) {
2014-01-31 19:59:03 +00:00
rm = p->rmargin;
rmax = p->maxrmargin;
p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
p->flags |= TERMP_NOSPACE;
2014-12-25 21:33:25 +00:00
if (n->string != NULL && *n->string != '\0')
2014-01-31 19:59:03 +00:00
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;
}
static void
print_man_nodelist(DECL_ARGS)
{
2014-01-31 19:59:03 +00:00
print_man_node(p, mt, n, meta);
if ( ! n->next)
return;
2014-01-31 19:59:03 +00:00
print_man_nodelist(p, mt, n->next, meta);
}
static void
print_man_foot(struct termp *p, const void *arg)
{
2014-11-22 18:08:25 +00:00
const struct man_meta *meta;
char *title;
size_t datelen, titlen;
meta = (const struct man_meta *)arg;
assert(meta->title);
assert(meta->msec);
assert(meta->date);
term_fontrepl(p, TERMFONT_NONE);
2014-11-22 18:08:25 +00:00
if (meta->hasbody)
term_vspace(p);
/*
* Temporary, undocumented option to imitate mdoc(7) output.
* In the bottom right corner, use the source instead of
* the title.
*/
if ( ! p->mdocstyle) {
2014-11-22 18:08:25 +00:00
if (meta->hasbody) {
term_vspace(p);
term_vspace(p);
}
mandoc_asprintf(&title, "%s(%s)",
meta->title, meta->msec);
} else if (meta->source) {
2014-11-22 18:08:25 +00:00
title = mandoc_strdup(meta->source);
} else {
2014-11-22 18:08:25 +00:00
title = mandoc_strdup("");
}
datelen = term_strlen(p, meta->date);
/* Bottom left corner: manual source. */
p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
2014-01-31 19:59:03 +00:00
p->trailspace = 1;
p->offset = 0;
p->rmargin = p->maxrmargin > datelen ?
(p->maxrmargin + term_len(p, 1) - datelen) / 2 : 0;
if (meta->source)
term_word(p, meta->source);
term_flushln(p);
/* At the bottom in the middle: manual date. */
p->offset = p->rmargin;
titlen = term_strlen(p, title);
p->rmargin = p->maxrmargin > titlen ? p->maxrmargin - titlen : 0;
p->flags |= TERMP_NOSPACE;
term_word(p, meta->date);
term_flushln(p);
/* Bottom right corner: manual title and section. */
p->flags &= ~TERMP_NOBREAK;
p->flags |= TERMP_NOSPACE;
2014-01-31 19:59:03 +00:00
p->trailspace = 0;
p->offset = p->rmargin;
p->rmargin = p->maxrmargin;
term_word(p, title);
term_flushln(p);
2014-11-22 18:08:25 +00:00
free(title);
}
static void
print_man_head(struct termp *p, const void *arg)
{
2014-11-22 18:08:25 +00:00
const struct man_meta *meta;
const char *volume;
char *title;
size_t vollen, titlen;
2014-01-31 19:59:03 +00:00
meta = (const struct man_meta *)arg;
assert(meta->title);
assert(meta->msec);
2014-11-22 18:08:25 +00:00
volume = NULL == meta->vol ? "" : meta->vol;
vollen = term_strlen(p, volume);
/* Top left corner: manual title and section. */
2014-11-22 18:08:25 +00:00
mandoc_asprintf(&title, "%s(%s)", meta->title, meta->msec);
titlen = term_strlen(p, title);
p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
2014-01-31 19:59:03 +00:00
p->trailspace = 1;
p->offset = 0;
2014-11-22 18:08:25 +00:00
p->rmargin = 2 * (titlen+1) + vollen < p->maxrmargin ?
(p->maxrmargin - vollen + term_len(p, 1)) / 2 :
vollen < p->maxrmargin ? p->maxrmargin - vollen : 0;
term_word(p, title);
term_flushln(p);
/* At the top in the middle: manual volume. */
p->flags |= TERMP_NOSPACE;
p->offset = p->rmargin;
2014-11-22 18:08:25 +00:00
p->rmargin = p->offset + vollen + titlen < p->maxrmargin ?
p->maxrmargin - titlen : p->maxrmargin;
2014-11-22 18:08:25 +00:00
term_word(p, volume);
term_flushln(p);
/* Top right corner: title and section, again. */
p->flags &= ~TERMP_NOBREAK;
2014-01-31 19:59:03 +00:00
p->trailspace = 0;
if (p->rmargin + titlen <= p->maxrmargin) {
p->flags |= TERMP_NOSPACE;
p->offset = p->rmargin;
p->rmargin = p->maxrmargin;
term_word(p, title);
term_flushln(p);
}
p->flags &= ~TERMP_NOSPACE;
p->offset = 0;
p->rmargin = p->maxrmargin;
2014-11-22 18:08:25 +00:00
/*
* Groff prints three blank lines before the content.
* Do the same, except in the temporary, undocumented
* mode imitating mdoc(7) output.
*/
term_vspace(p);
if ( ! p->mdocstyle) {
term_vspace(p);
term_vspace(p);
}
2014-11-22 18:08:25 +00:00
free(title);
}