-/* $Id: mdoc_term.c,v 1.99 2009/10/30 18:53:09 kristaps Exp $ */
+/* $Id: mdoc_term.c,v 1.111 2010/03/23 12:42:22 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
#include <sys/types.h>
#include <assert.h>
struct termpair {
struct termpair *ppair;
- int flag;
int count;
};
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_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);
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);
static int termp_ss_pre(DECL_ARGS);
static int termp_under_pre(DECL_ARGS);
static int termp_ud_pre(DECL_ARGS);
+static int termp_vt_pre(DECL_ARGS);
static int termp_xr_pre(DECL_ARGS);
static int termp_xx_pre(DECL_ARGS);
{ 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 */
{ termp_rv_pre, NULL }, /* Rv */
{ NULL, NULL }, /* St */
{ termp_under_pre, NULL }, /* Va */
- { termp_under_pre, termp_vt_post }, /* Vt */
+ { termp_vt_pre, termp_vt_post }, /* Vt */
{ termp_xr_pre, NULL }, /* Xr */
{ NULL, termp____post }, /* %A */
{ termp_under_pre, termp____post }, /* %B */
p = (struct termp *)arg;
+ p->overstep = 0;
+ p->maxrmargin = 78;
+
if (NULL == p->symtab)
switch (p->enc) {
case (TERMENC_ASCII):
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;
- under = p->under;
+ font = term_fontq(p);
memset(&npair, 0, sizeof(struct termpair));
npair.ppair = pair;
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);
- /*
- * 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.
- */
+ if (chld && n->child)
+ print_mdoc_nodelist(p, &npair, m, n->child);
- p->bold = bold;
- p->under = under;
+ term_fontpopq(p, font);
if (MDOC_TEXT != n->type)
if (termacts[n->tok].post)
{
char buf[DATESIZ], os[BUFSIZ];
+ 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
}
-/* FIXME: put in utility library. */
/* ARGSUSED */
static void
-print_head(DECL_ARGS)
+print_mdoc_head(DECL_ARGS)
{
char buf[BUFSIZ], title[BUFSIZ];
if ( ! a2roffsu(arg->value[pos], &su, SCALE_MAX))
SCALE_HS_INIT(&su, strlen(arg->value[pos]));
- /* XXX: pachemu? */
- return(term_hspan(&su) + 2);
+ return(term_hspan(&su));
}
}
+/*
+ * Return 1 if an argument has a particular argument value or 0 if it
+ * does not. See arg_getattr().
+ */
static int
arg_hasattr(int arg, const struct mdoc_node *n)
{
}
+/*
+ * Get the index of an argument in a node's argument list or -1 if it
+ * does not exist. See arg_getattrs().
+ */
static int
arg_getattr(int v, const struct mdoc_node *n)
{
}
+/*
+ * Walk through the argument list for a node and fill an array "vals"
+ * with the positions of the argument structures listed in "keys".
+ * Return the number of elements that were written into "vals", which
+ * can be zero.
+ */
static int
arg_getattrs(const int *keys, int *vals,
size_t sz, const struct mdoc_node *n)
}
+/*
+ * Determine how much space to print out before block elements of `It'
+ * (and thus `Bl') and `Bd'. And then go ahead and print that space,
+ * too.
+ */
static void
print_bvspace(struct termp *p,
const struct mdoc_node *bl,
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);
bl = n->parent->parent->parent;
- /* Save parent attributes. */
-
- pair->flag = p->flags;
-
- /* Get list width and offset. */
+ /* Get list width, offset, and list type from argument list. */
keys[0] = MDOC_Width;
keys[1] = MDOC_Offset;
vals[0] = vals[1] = vals[2] = -1;
- width = offset = 0;
-
- (void)arg_getattrs(keys, vals, 3, bl);
+ arg_getattrs(keys, vals, 3, bl);
type = arg_listtype(bl);
assert(-1 != type);
- /* Calculate real width and offset. */
+ /*
+ * First calculate width and offset. This is pretty easy unless
+ * we're a -column list, in which case all prior columns must
+ * be accounted for.
+ */
+
+ width = offset = 0;
+
+ if (vals[1] >= 0)
+ offset = a2offs(&bl->args->argv[vals[1]]);
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
- * column (plus the -offset value). If this column
- * exceeds the stated number of columns, the width is
- * set as 0, else it's the stated column width (later
- * the 0 will be adjusted to default 10 or, if in the
- * last column case, set to stretch to the margin).
+ /*
+ * Imitate groff's column handling:
+ * - For each earlier column, add its width.
+ * - For less than 5 columns, add four more blanks per
+ * column.
+ * - For exactly 5 columns, add three more blank per
+ * column.
+ * - For more than 5 columns, add only one column.
*/
- for (i = 0, nn = n->prev; nn &&
- i < (int)bl->args->argv[vals[2]].sz;
+ ncols = bl->args->argv[vals[2]].sz;
+ /* LINTED */
+ dcol = ncols < 5 ? 4 : ncols == 5 ? 3 : 1;
+
+ for (i = 0, nn = n->prev;
+ nn && i < (int)ncols;
nn = nn->prev, i++)
- offset += a2width
+ offset += dcol + a2width
(&bl->args->argv[vals[2]], i);
- /* Whether exceeds maximum column. */
- if (i < (int)bl->args->argv[vals[2]].sz)
- width = a2width(&bl->args->argv[vals[2]], i);
- else
- width = 0;
- if (vals[1] >= 0)
- offset += a2offs(&bl->args->argv[vals[1]]);
+ /*
+ * 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.
+ */
+ if (i >= (int)ncols)
+ break;
+
+ /*
+ * Use the declared column widths, extended as explained
+ * in the preceding paragraph.
+ */
+ width = a2width(&bl->args->argv[vals[2]], i) + dcol;
break;
default:
- if (vals[0] >= 0)
- width = a2width(&bl->args->argv[vals[0]], 0);
- if (vals[1] >= 0)
- offset += a2offs(&bl->args->argv[vals[1]]);
+ if (vals[0] < 0)
+ break;
+
+ /*
+ * Note: buffer the width by 2, which is groff's magic
+ * number for buffering single arguments. See the above
+ * handling for column for how this changes.
+ */
+ width = a2width(&bl->args->argv[vals[0]], 0) + 2;
break;
}
switch (type) {
case (MDOC_Diag):
if (MDOC_HEAD == n->type)
- p->bold++;
+ term_fontpush(p, TERMFONT_BOLD);
break;
default:
break;
}
/*
- * Pad and break control. This is the tricker part. Lists with
- * set right-margins for the head get TERMP_NOBREAK because, if
- * they overrun the margin, they wrap to the new margin.
- * Correspondingly, the body for these types don't left-pad, as
- * the head will pad out to to the right.
+ * Pad and break control. This is the tricky part. These flags
+ * are documented in term_flushln() in term.c. Note that we're
+ * going to unset all of these flags in termp_it_post() when we
+ * exit.
*/
switch (type) {
* 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:
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)++;
- (void)snprintf(buf, sizeof(buf), "%d.",
+ snprintf(buf, sizeof(buf), "%d.",
pair->ppair->ppair->count);
term_word(p, buf);
break;
{
int type;
- if (MDOC_BODY != n->type && MDOC_HEAD != n->type)
+ if (MDOC_BLOCK == n->type)
return;
type = arg_listtype(n->parent->parent->parent);
break;
}
- p->flags = pair->flag;
+ /*
+ * Now that our output is flushed, we can reset our tags. Since
+ * only `It' sets these flags, we're free to assume that nobody
+ * has munged them in the meanwhile.
+ */
+
+ p->flags &= ~TERMP_DANGLE;
+ p->flags &= ~TERMP_NOBREAK;
+ p->flags &= ~TERMP_TWOSPACE;
+ p->flags &= ~TERMP_NOLPAD;
+ p->flags &= ~TERMP_HANG;
}
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);
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);
}
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");
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.");
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");
}
+static int
+termp_vt_pre(DECL_ARGS)
+{
+
+ if (MDOC_ELEM == n->type)
+ return(termp_under_pre(p, pair, m, n));
+ else if (MDOC_HEAD == n->type)
+ return(0);
+ else if (MDOC_BLOCK == n->type)
+ return(1);
+
+ return(termp_under_pre(p, pair, m, n));
+}
+
+
/* ARGSUSED */
static void
termp_vt_post(DECL_ARGS)
{
- if (n->sec != SEC_SYNOPSIS)
+ if (MDOC_BLOCK != n->type)
return;
if (n->next && MDOC_Vt == n->next->tok)
term_newln(p);
termp_bold_pre(DECL_ARGS)
{
- p->bold++;
+ term_fontpush(p, TERMFONT_BOLD);
return(1);
}
term_vspace(p);
break;
case (MDOC_HEAD):
- p->bold++;
+ term_fontpush(p, TERMFONT_BOLD);
break;
case (MDOC_BODY):
p->offset = INDENT;
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);
}
{
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, ",");
}
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, ",");
}
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)
pp = "BSDI BSD/OS";
break;
case (MDOC_Dx):
- pp = "DragonFlyBSD";
+ pp = "DragonFly";
break;
case (MDOC_Fx):
pp = "FreeBSD";
term_vspace(p);
break;
case (MDOC_HEAD):
- p->bold++;
+ term_fontpush(p, TERMFONT_BOLD);
p->offset = HALFINDENT;
break;
default:
termp_cd_pre(DECL_ARGS)
{
- p->bold++;
+ term_fontpush(p, TERMFONT_BOLD);
term_newln(p);
return(1);
}
termp_in_pre(DECL_ARGS)
{
- p->bold++;
+ term_fontpush(p, TERMFONT_BOLD);
if (SEC_SYNOPSIS == n->sec)
term_word(p, "#include");
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;
} 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);
}
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);
}
{
assert(n->child && MDOC_TEXT == n->child->type);
- if (0 == strcmp("on", n->child->string)) {
+ if (0 == strcmp("on", n->child->string))
p->flags &= ~TERMP_NONOSPACE;
- p->flags &= ~TERMP_NOSPACE;
- } else
+ else
p->flags |= TERMP_NONOSPACE;
return(0);
}
+/* 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;
- p->under++;
+ term_fontpush(p, TERMFONT_UNDER);
nn = n->child;
if (NULL == nn->next)
return(1);
term_word(p, nn->string);
- p->under--;
+ term_fontpop(p);
p->flags |= TERMP_NOSPACE;
term_word(p, ":");
- 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);
}
termp_under_pre(DECL_ARGS)
{
- p->under++;
+ term_fontpush(p, TERMFONT_UNDER);
return(1);
}
git.ckatri.com / mandoc.git / blobdiff