-/* $Id: mdoc_term.c,v 1.96 2009/10/26 04:09:46 kristaps Exp $ */
+/* $Id: mdoc_term.c,v 1.157 2010/06/25 18:53:14 kristaps Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* 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>
#include <ctype.h>
-#include <err.h>
+#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
+#include "mandoc.h"
#include "out.h"
#include "term.h"
#include "mdoc.h"
struct termpair {
struct termpair *ppair;
- int flag;
int count;
};
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 size_t a2width(const struct termp *, const char *);
+static size_t a2height(const struct termp *, const char *);
+static size_t a2offs(const struct termp *, const char *);
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);
-
-#ifdef __linux__
-extern size_t strlcpy(char *, const char *, size_t);
-extern size_t strlcat(char *, const char *, size_t);
-#endif
+static void print_mdoc_node(DECL_ARGS);
+static void print_mdoc_nodelist(DECL_ARGS);
+static void print_mdoc_head(struct termp *, const void *);
+static void print_mdoc_foot(struct termp *, const void *);
+static void synopsis_pre(struct termp *,
+ const struct mdoc_node *);
static void termp____post(DECL_ARGS);
static void termp_an_post(DECL_ARGS);
static void termp_bx_post(DECL_ARGS);
static void termp_d1_post(DECL_ARGS);
static void termp_dq_post(DECL_ARGS);
-static void termp_fd_post(DECL_ARGS);
-static void termp_fn_post(DECL_ARGS);
+static int termp_fd_pre(DECL_ARGS);
static void termp_fo_post(DECL_ARGS);
-static void termp_ft_post(DECL_ARGS);
static void termp_in_post(DECL_ARGS);
static void termp_it_post(DECL_ARGS);
static void termp_lb_post(DECL_ARGS);
static void termp_sh_post(DECL_ARGS);
static void termp_sq_post(DECL_ARGS);
static void termp_ss_post(DECL_ARGS);
-static void termp_vt_post(DECL_ARGS);
-static int termp__t_pre(DECL_ARGS);
static int termp_an_pre(DECL_ARGS);
static int termp_ap_pre(DECL_ARGS);
static int termp_aq_pre(DECL_ARGS);
static int termp_bd_pre(DECL_ARGS);
static int termp_bf_pre(DECL_ARGS);
+static int termp_bl_pre(DECL_ARGS);
static int termp_bold_pre(DECL_ARGS);
static int termp_bq_pre(DECL_ARGS);
static int termp_brq_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);
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_d1_pre, termp_d1_post }, /* Dl */
{ termp_bd_pre, termp_bd_post }, /* Bd */
{ NULL, NULL }, /* Ed */
- { NULL, termp_bl_post }, /* Bl */
+ { termp_bl_pre, termp_bl_post }, /* Bl */
{ NULL, NULL }, /* El */
{ termp_it_pre, termp_it_post }, /* It */
{ NULL, NULL }, /* Ad */
{ NULL, NULL }, /* Ev */
{ termp_ex_pre, NULL }, /* Ex */
{ termp_fa_pre, NULL }, /* Fa */
- { termp_bold_pre, termp_fd_post }, /* Fd */
+ { termp_fd_pre, NULL }, /* Fd */
{ termp_fl_pre, NULL }, /* Fl */
- { termp_fn_pre, termp_fn_post }, /* Fn */
- { termp_ft_pre, termp_ft_post }, /* Ft */
+ { termp_fn_pre, NULL }, /* Fn */
+ { termp_ft_pre, NULL }, /* 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, NULL }, /* Vt */
{ termp_xr_pre, NULL }, /* Xr */
{ NULL, termp____post }, /* %A */
{ termp_under_pre, termp____post }, /* %B */
{ NULL, termp____post }, /* %O */
{ NULL, termp____post }, /* %P */
{ NULL, termp____post }, /* %R */
- { termp__t_pre, termp____post }, /* %T */
+ { termp_under_pre, termp____post }, /* %T */
{ NULL, termp____post }, /* %V */
{ NULL, NULL }, /* Ac */
{ termp_aq_pre, termp_aq_post }, /* Ao */
{ NULL, NULL }, /* Dc */
{ termp_dq_pre, termp_dq_post }, /* Do */
{ termp_dq_pre, termp_dq_post }, /* Dq */
- { NULL, NULL }, /* Ec */
+ { NULL, NULL }, /* Ec */ /* FIXME: no space */
{ NULL, NULL }, /* Ef */
{ termp_under_pre, NULL }, /* Em */
{ NULL, NULL }, /* Eo */
{ termp_sp_pre, NULL }, /* br */
{ termp_sp_pre, NULL }, /* sp */
{ termp_under_pre, termp____post }, /* %U */
+ { NULL, NULL }, /* Ta */
};
p = (struct termp *)arg;
+ p->overstep = 0;
+ p->maxrmargin = p->defrmargin;
+ p->tabwidth = term_len(p, 5);
+
if (NULL == p->symtab)
switch (p->enc) {
case (TERMENC_ASCII):
n = mdoc_node(mdoc);
m = mdoc_meta(mdoc);
- print_head(p, NULL, m, n);
+ term_begin(p, print_mdoc_head, print_mdoc_foot, m);
+
if (n->child)
- print_body(p, NULL, m, n->child);
- print_foot(p, NULL, m, n);
+ print_mdoc_nodelist(p, NULL, m, n->child);
+
+ term_end(p);
}
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);
- bzero(&npair, sizeof(struct termpair));
+ memset(&npair, 0, sizeof(struct termpair));
npair.ppair = pair;
if (MDOC_TEXT != n->type) {
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)
(*termacts[n->tok].post)(p, &npair, m, n);
+ if (MDOC_EOS & n->flags)
+ p->flags |= TERMP_SENTENCE;
+
p->offset = offset;
p->rmargin = rmargin;
}
-/* ARGSUSED */
static void
-print_foot(DECL_ARGS)
+print_mdoc_foot(struct termp *p, const void *arg)
{
- char buf[DATESIZ];
- char *os;
+ char buf[DATESIZ], os[BUFSIZ];
+ const struct mdoc_meta *m;
+
+ m = (const struct mdoc_meta *)arg;
+
+ term_fontrepl(p, TERMFONT_NONE);
/*
* Output the footer in new-groff style, that is, three columns
* SYSTEM DATE SYSTEM
*/
- if (NULL == (os = malloc(p->rmargin)))
- err(EXIT_FAILURE, "malloc");
-
time2a(m->date, buf, DATESIZ);
-
- (void)strlcpy(os, m->os, p->rmargin);
+ strlcpy(os, m->os, BUFSIZ);
term_vspace(p);
p->offset = 0;
- p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2;
+ p->rmargin = (p->maxrmargin -
+ term_strlen(p, buf) + term_len(p, 1)) / 2;
p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
term_word(p, os);
term_flushln(p);
p->offset = p->rmargin;
- p->rmargin = p->maxrmargin - strlen(os);
+ p->rmargin = p->maxrmargin - term_strlen(p, os);
p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
term_word(p, buf);
p->offset = 0;
p->rmargin = p->maxrmargin;
p->flags = 0;
-
- free(os);
}
-/* FIXME: put in utility library. */
-/* ARGSUSED */
static void
-print_head(DECL_ARGS)
+print_mdoc_head(struct termp *p, const void *arg)
{
- char *buf, *title;
+ char buf[BUFSIZ], title[BUFSIZ];
+ const struct mdoc_meta *m;
+
+ m = (const struct mdoc_meta *)arg;
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:
*/
assert(m->vol);
- (void)strlcpy(buf, m->vol, p->rmargin);
+ strlcpy(buf, m->vol, BUFSIZ);
if (m->arch) {
- (void)strlcat(buf, " (", p->rmargin);
- (void)strlcat(buf, m->arch, p->rmargin);
- (void)strlcat(buf, ")", p->rmargin);
+ strlcat(buf, " (", BUFSIZ);
+ strlcat(buf, m->arch, BUFSIZ);
+ strlcat(buf, ")", BUFSIZ);
}
- snprintf(title, p->rmargin, "%s(%d)", m->title, m->msec);
+ snprintf(title, BUFSIZ, "%s(%s)", m->title, m->msec);
p->offset = 0;
- p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2;
+ p->rmargin = (p->maxrmargin -
+ term_strlen(p, buf) + term_len(p, 1)) / 2;
p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
term_word(p, title);
term_flushln(p);
p->offset = p->rmargin;
- p->rmargin = p->maxrmargin - strlen(title);
+ p->rmargin = p->maxrmargin - term_strlen(p, title);
p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
term_word(p, buf);
p->offset = 0;
p->rmargin = p->maxrmargin;
p->flags &= ~TERMP_NOSPACE;
-
- free(title);
- free(buf);
}
static size_t
-a2height(const struct mdoc_node *n)
+a2height(const struct termp *p, const char *v)
{
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));
+ assert(v);
+ if ( ! a2roffsu(v, &su, SCALE_VS))
+ SCALE_VS_INIT(&su, term_len(p, 1));
- return(term_vspan(&su));
+ return(term_vspan(p, &su));
}
static size_t
-a2width(const struct mdoc_argv *arg, int pos)
+a2width(const struct termp *p, const char *v)
{
struct roffsu su;
- assert(arg->value[pos]);
- if ( ! a2roffsu(arg->value[pos], &su, SCALE_MAX))
- SCALE_HS_INIT(&su, strlen(arg->value[pos]));
-
- /* XXX: pachemu? */
- return(term_hspan(&su) + 2);
-}
-
-
-static int
-arg_listtype(const struct mdoc_node *n)
-{
- int i, len;
-
- assert(MDOC_BLOCK == n->type);
-
- len = (int)(n->args ? n->args->argc : 0);
-
- for (i = 0; i < len; i++)
- switch (n->args->argv[i].arg) {
- case (MDOC_Bullet):
- /* FALLTHROUGH */
- case (MDOC_Dash):
- /* FALLTHROUGH */
- case (MDOC_Enum):
- /* FALLTHROUGH */
- case (MDOC_Hyphen):
- /* FALLTHROUGH */
- case (MDOC_Tag):
- /* FALLTHROUGH */
- case (MDOC_Inset):
- /* FALLTHROUGH */
- case (MDOC_Diag):
- /* FALLTHROUGH */
- case (MDOC_Item):
- /* FALLTHROUGH */
- case (MDOC_Column):
- /* FALLTHROUGH */
- case (MDOC_Hang):
- /* FALLTHROUGH */
- case (MDOC_Ohang):
- return(n->args->argv[i].arg);
- default:
- break;
- }
+ assert(v);
+ if ( ! a2roffsu(v, &su, SCALE_MAX))
+ SCALE_HS_INIT(&su, term_strlen(p, v));
- return(-1);
+ return(term_hspan(p, &su));
}
static size_t
-a2offs(const struct mdoc_argv *arg)
+a2offs(const struct termp *p, const char *v)
{
struct roffsu su;
- if ('\0' == arg->value[0][0])
+ if ('\0' == *v)
return(0);
- else if (0 == strcmp(arg->value[0], "left"))
+ else if (0 == strcmp(v, "left"))
return(0);
- else if (0 == strcmp(arg->value[0], "indent"))
- return(INDENT + 1);
- else if (0 == strcmp(arg->value[0], "indent-two"))
- return((INDENT + 1) * 2);
- else if ( ! a2roffsu(arg->value[0], &su, SCALE_MAX))
- SCALE_HS_INIT(&su, strlen(arg->value[0]));
+ else if (0 == strcmp(v, "indent"))
+ return(term_len(p, INDENT + 1));
+ else if (0 == strcmp(v, "indent-two"))
+ return(term_len(p, (INDENT + 1) * 2));
+ else if ( ! a2roffsu(v, &su, SCALE_MAX))
+ SCALE_HS_INIT(&su, term_strlen(p, v));
- return(term_hspan(&su));
+ return(term_hspan(p, &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.
+ */
static int
arg_getattr(int v, const struct mdoc_node *n)
{
- int val;
-
- return(arg_getattrs(&v, &val, 1, n) ? val : -1);
-}
-
-
-static int
-arg_getattrs(const int *keys, int *vals,
- size_t sz, const struct mdoc_node *n)
-{
- int i, j, k;
+ int i;
if (NULL == n->args)
return(0);
- for (k = i = 0; i < (int)n->args->argc; i++)
- for (j = 0; j < (int)sz; j++)
- if (n->args->argv[i].arg == keys[j]) {
- vals[j] = i;
- k++;
- }
- return(k);
+ for (i = 0; i < (int)n->args->argc; i++)
+ if (n->args->argv[i].arg == v)
+ return(i);
+
+ return(-1);
}
+/*
+ * 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 *nn;
term_newln(p);
- if (arg_hasattr(MDOC_Compact, bl))
+
+ if (MDOC_Bd == bl->tok && bl->data.Bd.comp)
+ return;
+ if (MDOC_Bl == bl->tok && bl->data.Bl.comp)
return;
/* Do not vspace directly after Ss/Sh. */
/* A `-column' does not assert vspace within the list. */
- if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Column, bl))
+ if (MDOC_Bl == bl->tok && LIST_column == bl->data.Bl.type)
if (n->prev && MDOC_It == n->prev->tok)
return;
/* A `-diag' without body does not vspace. */
- if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Diag, bl))
+ if (MDOC_Bl == bl->tok && LIST_diag == bl->data.Bl.type)
if (n->prev && MDOC_It == n->prev->tok) {
assert(n->prev->body);
if (NULL == n->prev->body->child)
{
const struct mdoc_node *bl, *nn;
char buf[7];
- int i, type, keys[3], vals[3];
- size_t width, offset;
+ int i, col;
+ size_t width, offset, ncols, dcol;
+ enum mdoc_list type;
if (MDOC_BLOCK == n->type) {
print_bvspace(p, n->parent->parent, n);
}
bl = n->parent->parent->parent;
+ type = bl->data.Bl.type;
- /* Save parent attributes. */
-
- pair->flag = p->flags;
-
- /* Get list width and offset. */
-
- keys[0] = MDOC_Width;
- keys[1] = MDOC_Offset;
- keys[2] = MDOC_Column;
-
- vals[0] = vals[1] = vals[2] = -1;
+ /*
+ * 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;
- (void)arg_getattrs(keys, vals, 3, bl);
-
- type = arg_listtype(bl);
- assert(-1 != type);
-
- /* Calculate real width and offset. */
+ if (bl->data.Bl.offs)
+ offset = a2offs(p, bl->data.Bl.offs);
switch (type) {
- case (MDOC_Column):
- if (MDOC_BODY == n->type)
+ case (LIST_column):
+ if (MDOC_HEAD == 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).
+
+ col = arg_getattr(MDOC_Column, bl);
+
+ /*
+ * 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.
+ */
+ ncols = bl->args->argv[col].sz;
+ /* LINTED */
+ dcol = ncols < 5 ? term_len(p, 4) :
+ ncols == 5 ? term_len(p, 3) : term_len(p, 1);
+
+ /*
+ * Calculate the offset by applying all prior MDOC_BODY,
+ * so we stop at the MDOC_HEAD (NULL == nn->prev).
*/
- for (i = 0, nn = n->prev; nn &&
- i < (int)bl->args->argv[vals[2]].sz;
+
+ for (i = 0, nn = n->prev;
+ nn->prev && i < (int)ncols;
nn = nn->prev, i++)
- offset += a2width
- (&bl->args->argv[vals[2]], i);
+ offset += dcol + a2width
+ (p, bl->args->argv[col].value[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;
+ /*
+ * 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;
- if (vals[1] >= 0)
- offset += a2offs(&bl->args->argv[vals[1]]);
+ /*
+ * Use the declared column widths, extended as explained
+ * in the preceding paragraph.
+ */
+ width = a2width(p, bl->args->argv[col].value[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 (NULL == bl->data.Bl.width)
+ 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.
+ */
+ assert(bl->data.Bl.width);
+ width = a2width(p, bl->data.Bl.width) + term_len(p, 2);
break;
}
*/
switch (type) {
- case (MDOC_Bullet):
+ case (LIST_bullet):
/* FALLTHROUGH */
- case (MDOC_Dash):
+ case (LIST_dash):
/* FALLTHROUGH */
- case (MDOC_Hyphen):
- if (width < 4)
- width = 4;
+ case (LIST_hyphen):
+ if (width < term_len(p, 4))
+ width = term_len(p, 4);
break;
- case (MDOC_Enum):
- if (width < 5)
- width = 5;
+ case (LIST_enum):
+ if (width < term_len(p, 5))
+ width = term_len(p, 5);
break;
- case (MDOC_Hang):
+ case (LIST_hang):
if (0 == width)
- width = 8;
+ width = term_len(p, 8);
break;
- case (MDOC_Column):
+ case (LIST_column):
/* FALLTHROUGH */
- case (MDOC_Tag):
+ case (LIST_tag):
if (0 == width)
- width = 10;
+ width = term_len(p, 10);
break;
default:
break;
p->flags |= TERMP_NOSPACE;
switch (type) {
- case (MDOC_Diag):
+ case (LIST_diag):
if (MDOC_BODY == n->type)
term_word(p, "\\ \\ ");
break;
- case (MDOC_Inset):
+ case (LIST_inset):
if (MDOC_BODY == n->type)
term_word(p, "\\ ");
break;
p->flags |= TERMP_NOSPACE;
switch (type) {
- case (MDOC_Diag):
+ case (LIST_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) {
- case (MDOC_Bullet):
+ case (LIST_bullet):
/* FALLTHROUGH */
- case (MDOC_Dash):
+ case (LIST_dash):
/* FALLTHROUGH */
- case (MDOC_Enum):
+ case (LIST_enum):
/* FALLTHROUGH */
- case (MDOC_Hyphen):
+ case (LIST_hyphen):
if (MDOC_HEAD == n->type)
p->flags |= TERMP_NOBREAK;
else
p->flags |= TERMP_NOLPAD;
break;
- case (MDOC_Hang):
+ case (LIST_hang):
if (MDOC_HEAD == n->type)
p->flags |= TERMP_NOBREAK;
else
} else
p->flags |= TERMP_HANG;
break;
- case (MDOC_Tag):
+ case (LIST_tag):
if (MDOC_HEAD == n->type)
p->flags |= TERMP_NOBREAK | TERMP_TWOSPACE;
else
if (NULL == n->next || NULL == n->next->child)
p->flags |= TERMP_DANGLE;
break;
- case (MDOC_Column):
- if (MDOC_HEAD == n->type) {
- assert(n->next);
- if (MDOC_BODY == n->next->type)
- p->flags &= ~TERMP_NOBREAK;
- else
- p->flags |= TERMP_NOBREAK;
- if (n->prev)
- p->flags |= TERMP_NOLPAD;
- }
+ case (LIST_column):
+ if (MDOC_HEAD == n->type)
+ break;
+
+ if (NULL == n->next)
+ p->flags &= ~TERMP_NOBREAK;
+ else
+ p->flags |= TERMP_NOBREAK;
+
+ assert(n->prev);
+ if (MDOC_BODY == n->prev->type)
+ p->flags |= TERMP_NOLPAD;
+
break;
- case (MDOC_Diag):
+ case (LIST_diag):
if (MDOC_HEAD == n->type)
p->flags |= TERMP_NOBREAK;
break;
p->offset += offset;
switch (type) {
- case (MDOC_Hang):
+ case (LIST_hang):
/*
* Same stipulation as above, regarding `-hang'. We
* don't want to recalculate rmargin and offsets when
MDOC_Bd == n->next->child->tok))
break;
/* FALLTHROUGH */
- case (MDOC_Bullet):
+ case (LIST_bullet):
/* FALLTHROUGH */
- case (MDOC_Dash):
+ case (LIST_dash):
/* FALLTHROUGH */
- case (MDOC_Enum):
+ case (LIST_enum):
/* FALLTHROUGH */
- case (MDOC_Hyphen):
+ case (LIST_hyphen):
/* FALLTHROUGH */
- case (MDOC_Tag):
+ case (LIST_tag):
assert(width);
if (MDOC_HEAD == n->type)
p->rmargin = p->offset + width;
else
p->offset += width;
break;
- case (MDOC_Column):
+ case (LIST_column):
assert(width);
p->rmargin = p->offset + width;
/*
* XXX - this behaviour is not documented: the
* right-most column is filled to the right margin.
*/
- if (MDOC_HEAD == n->type &&
- MDOC_BODY == n->next->type)
+ if (MDOC_HEAD == n->type)
+ break;
+ if (NULL == n->next && p->rmargin < p->maxrmargin)
p->rmargin = p->maxrmargin;
break;
default:
if (MDOC_HEAD == n->type)
switch (type) {
- case (MDOC_Bullet):
- p->bold++;
+ case (LIST_bullet):
+ term_fontpush(p, TERMFONT_BOLD);
term_word(p, "\\[bu]");
- p->bold--;
+ term_fontpop(p);
break;
- case (MDOC_Dash):
+ case (LIST_dash):
/* FALLTHROUGH */
- case (MDOC_Hyphen):
- p->bold++;
+ case (LIST_hyphen):
+ term_fontpush(p, TERMFONT_BOLD);
term_word(p, "\\(hy");
- p->bold--;
+ term_fontpop(p);
break;
- case (MDOC_Enum):
+ case (LIST_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;
*/
switch (type) {
- case (MDOC_Bullet):
+ case (LIST_bullet):
/* FALLTHROUGH */
- case (MDOC_Item):
+ case (LIST_item):
/* FALLTHROUGH */
- case (MDOC_Dash):
+ case (LIST_dash):
/* FALLTHROUGH */
- case (MDOC_Hyphen):
+ case (LIST_hyphen):
/* FALLTHROUGH */
- case (MDOC_Enum):
+ case (LIST_enum):
if (MDOC_HEAD == n->type)
return(0);
break;
- case (MDOC_Column):
- if (MDOC_BODY == n->type)
+ case (LIST_column):
+ if (MDOC_HEAD == n->type)
return(0);
break;
default:
static void
termp_it_post(DECL_ARGS)
{
- int type;
+ enum mdoc_list type;
- if (MDOC_BODY != n->type && MDOC_HEAD != n->type)
+ if (MDOC_BLOCK == n->type)
return;
- type = arg_listtype(n->parent->parent->parent);
- assert(-1 != type);
+ type = n->parent->parent->parent->data.Bl.type;
switch (type) {
- case (MDOC_Item):
+ case (LIST_item):
/* FALLTHROUGH */
- case (MDOC_Diag):
+ case (LIST_diag):
/* FALLTHROUGH */
- case (MDOC_Inset):
+ case (LIST_inset):
if (MDOC_BODY == n->type)
- term_flushln(p);
+ term_newln(p);
break;
- case (MDOC_Column):
- if (MDOC_HEAD == n->type)
+ case (LIST_column):
+ if (MDOC_BODY == n->type)
term_flushln(p);
break;
default:
- term_flushln(p);
+ term_newln(p);
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;
}
termp_nm_pre(DECL_ARGS)
{
- if (SEC_SYNOPSIS == n->sec)
- term_newln(p);
- p->bold++;
+ if (NULL == n->child && NULL == m->name)
+ return(1);
+
+ synopsis_pre(p, n);
+
+ 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;
+
+ if (n->child)
+ p->flags |= TERMP_NOSPACE;
+ else if (n->next && n->next->line == n->line)
+ p->flags |= TERMP_NOSPACE;
+
return(1);
}
return;
}
- if (arg_getattr(MDOC_Split, n) > -1) {
+ if (arg_hasattr(MDOC_Split, n)) {
p->flags &= ~TERMP_NOSPLIT;
p->flags |= TERMP_SPLIT;
} else {
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, "()");
}
- if (n->child->next)
+ if (n->child && n->child->next)
term_word(p, "functions return");
else
term_word(p, "function returns");
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.");
+ p->flags |= TERMP_SENTENCE;
return(0);
}
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");
p->flags &= ~TERMP_NOSPACE;
}
- if (n->child->next)
+ if (n->child && n->child->next)
term_word(p, "utilities exit");
else
term_word(p, "utility exits");
term_word(p, "0 on success, and >0 if an error occurs.");
+ p->flags |= TERMP_SENTENCE;
return(0);
}
}
+/* ARGSUSED */
+static int
+termp_bl_pre(DECL_ARGS)
+{
+
+ return(MDOC_HEAD != n->type);
+}
+
+
/* ARGSUSED */
static void
termp_bl_post(DECL_ARGS)
{
const struct mdoc_node *nn;
- assert(n->child && MDOC_TEXT == n->child->type);
+ if (NULL == n->child)
+ return(0);
+
+ assert(MDOC_TEXT == n->child->type);
nn = n->child;
term_word(p, nn->string);
}
-/* ARGSUSED */
+/*
+ * This decides how to assert whitespace before any of the SYNOPSIS set
+ * of macros (which, as in the case of Ft/Fo and Ft/Fn, may contain
+ * macro combos).
+ */
static void
-termp_vt_post(DECL_ARGS)
+synopsis_pre(struct termp *p, const struct mdoc_node *n)
{
-
- if (n->sec != SEC_SYNOPSIS)
+ /*
+ * Obviously, if we're not in a SYNOPSIS or no prior macros
+ * exist, do nothing.
+ */
+ if (NULL == n->prev || SEC_SYNOPSIS != n->sec)
return;
- if (n->next && MDOC_Vt == n->next->tok)
+
+ /*
+ * If we're the second in a pair of like elements, emit our
+ * newline and return. UNLESS we're `Fo', `Fn', `Fn', in which
+ * case we soldier on.
+ */
+ if (n->prev->tok == n->tok &&
+ MDOC_Ft != n->tok &&
+ MDOC_Fo != n->tok &&
+ MDOC_Fn != n->tok) {
term_newln(p);
- else if (n->next)
+ return;
+ }
+
+ /*
+ * If we're one of the SYNOPSIS set and non-like pair-wise after
+ * another (or Fn/Fo, which we've let slip through) then assert
+ * vertical space, else only newline and move on.
+ */
+ switch (n->prev->tok) {
+ case (MDOC_Fd):
+ /* FALLTHROUGH */
+ case (MDOC_Fn):
+ /* FALLTHROUGH */
+ case (MDOC_Fo):
+ /* FALLTHROUGH */
+ case (MDOC_In):
+ /* FALLTHROUGH */
+ case (MDOC_Vt):
term_vspace(p);
+ break;
+ case (MDOC_Ft):
+ if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
+ term_vspace(p);
+ break;
+ }
+ /* FALLTHROUGH */
+ default:
+ term_newln(p);
+ break;
+ }
+}
+
+
+static int
+termp_vt_pre(DECL_ARGS)
+{
+
+ if (MDOC_ELEM == n->type) {
+ synopsis_pre(p, n);
+ return(termp_under_pre(p, pair, m, n));
+ } else if (MDOC_BLOCK == n->type) {
+ synopsis_pre(p, n);
+ return(1);
+ } else if (MDOC_HEAD == n->type)
+ return(0);
+
+ return(termp_under_pre(p, pair, m, n));
}
termp_bold_pre(DECL_ARGS)
{
- p->bold++;
+ term_fontpush(p, TERMFONT_BOLD);
return(1);
}
/* ARGSUSED */
-static void
-termp_fd_post(DECL_ARGS)
+static int
+termp_fd_pre(DECL_ARGS)
{
- if (n->sec != SEC_SYNOPSIS)
- return;
-
- term_newln(p);
- if (n->next && MDOC_Fd != n->next->tok)
- term_vspace(p);
+ synopsis_pre(p, n);
+ return(termp_bold_pre(p, pair, m, n));
}
term_vspace(p);
break;
case (MDOC_HEAD):
- p->bold++;
+ term_fontpush(p, TERMFONT_BOLD);
break;
case (MDOC_BODY):
- p->offset = INDENT;
+ p->offset = term_len(p, INDENT);
break;
default:
break;
{
term_word(p, "is currently in beta test.");
+ p->flags |= TERMP_SENTENCE;
return(0);
}
termp_lb_post(DECL_ARGS)
{
- if (SEC_LIBRARY == n->sec)
+ if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags)
term_newln(p);
}
{
term_word(p, "currently under development.");
+ p->flags |= TERMP_SENTENCE;
return(0);
}
if (MDOC_BLOCK != n->type)
return(1);
term_newln(p);
- p->offset += (INDENT + 1);
+ p->offset += term_len(p, (INDENT + 1));
return(1);
}
termp_ft_pre(DECL_ARGS)
{
- if (SEC_SYNOPSIS == n->sec)
- if (n->prev && MDOC_Fo == n->prev->tok)
- term_vspace(p);
- p->under++;
+ /* NB: MDOC_LINE does not effect this! */
+ synopsis_pre(p, n);
+ term_fontpush(p, TERMFONT_UNDER);
return(1);
}
-/* ARGSUSED */
-static void
-termp_ft_post(DECL_ARGS)
-{
-
- if (SEC_SYNOPSIS == n->sec)
- term_newln(p);
-}
-
-
/* ARGSUSED */
static int
termp_fn_pre(DECL_ARGS)
{
const struct mdoc_node *nn;
- p->bold++;
+ synopsis_pre(p, n);
+
+ 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, ",");
}
}
-/* ARGSUSED */
-static void
-termp_fn_post(DECL_ARGS)
-{
-
- if (n->sec == SEC_SYNOPSIS && n->next)
- term_vspace(p);
-}
-
-
/* ARGSUSED */
static int
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, ",");
}
static int
termp_bd_pre(DECL_ARGS)
{
- int i, type;
+ size_t tabwidth;
+ size_t rm, rmax;
const struct mdoc_node *nn;
if (MDOC_BLOCK == n->type) {
print_bvspace(p, n, n);
return(1);
- } else if (MDOC_BODY != n->type)
- return(1);
-
- nn = n->parent;
+ } else if (MDOC_HEAD == n->type)
+ return(0);
- for (type = -1, i = 0; i < (int)nn->args->argc; i++) {
- switch (nn->args->argv[i].arg) {
- case (MDOC_Centred):
- /* FALLTHROUGH */
- case (MDOC_Ragged):
- /* FALLTHROUGH */
- case (MDOC_Filled):
- /* FALLTHROUGH */
- case (MDOC_Unfilled):
- /* FALLTHROUGH */
- case (MDOC_Literal):
- type = nn->args->argv[i].arg;
- break;
- case (MDOC_Offset):
- p->offset += a2offs(&nn->args->argv[i]);
- break;
- default:
- break;
- }
- }
+ if (n->data.Bd.offs)
+ p->offset += a2offs(p, n->data.Bd.offs);
/*
* If -ragged or -filled are specified, the block does nothing
* lines are allowed.
*/
- assert(type > -1);
- if (MDOC_Literal != type && MDOC_Unfilled != type)
+ if (DISP_literal != n->data.Bd.type &&
+ DISP_unfilled != n->data.Bd.type)
return(1);
+ tabwidth = p->tabwidth;
+ p->tabwidth = term_len(p, 8);
+ rm = p->rmargin;
+ rmax = p->maxrmargin;
+ p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
+
for (nn = n->child; nn; nn = nn->next) {
p->flags |= TERMP_NOSPACE;
- print_node(p, pair, m, nn);
- if (NULL == nn->next)
- continue;
- if (nn->prev && nn->prev->line < nn->line)
- term_flushln(p);
- else if (NULL == nn->prev)
+ print_mdoc_node(p, pair, m, nn);
+ if (NULL == nn->prev ||
+ nn->prev->line < nn->line ||
+ NULL == nn->next)
term_flushln(p);
}
+ p->tabwidth = tabwidth;
+ p->rmargin = rm;
+ p->maxrmargin = rmax;
return(0);
}
static void
termp_bd_post(DECL_ARGS)
{
+ size_t rm, rmax;
if (MDOC_BODY != n->type)
return;
+
+ rm = p->rmargin;
+ rmax = p->maxrmargin;
+
+ if (DISP_literal == n->data.Bd.type ||
+ DISP_unfilled == n->data.Bd.type)
+ p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
+
p->flags |= TERMP_NOSPACE;
- term_flushln(p);
+ term_newln(p);
+
+ p->rmargin = rm;
+ p->maxrmargin = rmax;
}
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++;
- p->offset = HALFINDENT;
+ term_fontpush(p, TERMFONT_BOLD);
+ p->offset = term_len(p, HALFINDENT);
break;
default:
break;
termp_cd_pre(DECL_ARGS)
{
- p->bold++;
- term_newln(p);
+ synopsis_pre(p, n);
+ term_fontpush(p, TERMFONT_BOLD);
return(1);
}
termp_in_pre(DECL_ARGS)
{
- p->bold++;
- if (SEC_SYNOPSIS == n->sec)
+ synopsis_pre(p, n);
+
+ if (SEC_SYNOPSIS == n->sec && MDOC_LINE & n->flags) {
+ term_fontpush(p, TERMFONT_BOLD);
term_word(p, "#include");
+ term_word(p, "<");
+ } else {
+ term_word(p, "<");
+ term_fontpush(p, TERMFONT_UNDER);
+ }
- term_word(p, "<");
p->flags |= TERMP_NOSPACE;
return(1);
}
termp_in_post(DECL_ARGS)
{
- p->bold++;
+ if (SEC_SYNOPSIS == n->sec)
+ term_fontpush(p, TERMFONT_BOLD);
+
p->flags |= TERMP_NOSPACE;
term_word(p, ">");
- p->bold--;
- if (SEC_SYNOPSIS != n->sec)
- return;
-
- term_newln(p);
- /*
- * XXX Not entirely correct. If `.In foo bar' is specified in
- * the SYNOPSIS section, then it produces a single break after
- * the <foo>; mandoc asserts a vertical space. Since this
- * construction is rarely used, I think it's fine.
- */
- if (n->next && MDOC_In != n->next->tok)
- term_vspace(p);
+ if (SEC_SYNOPSIS == n->sec)
+ term_fontpop(p);
}
switch (n->tok) {
case (MDOC_sp):
- len = n->child ? a2height(n->child) : 1;
+ len = n->child ? a2height(p, n->child->string) : 1;
break;
case (MDOC_br):
len = 0;
static int
termp_fo_pre(DECL_ARGS)
{
- const struct mdoc_node *nn;
- if (MDOC_BODY == n->type) {
+ if (MDOC_BLOCK == n->type) {
+ synopsis_pre(p, n);
+ return(1);
+ } else if (MDOC_BODY == n->type) {
p->flags |= TERMP_NOSPACE;
term_word(p, "(");
p->flags |= TERMP_NOSPACE;
return(1);
- } else if (MDOC_HEAD != n->type)
- return(1);
+ }
- p->bold++;
- for (nn = n->child; nn; nn = nn->next) {
- assert(MDOC_TEXT == nn->type);
- term_word(p, nn->string);
- }
- p->bold--;
+ /* XXX: we drop non-initial arguments as per groff. */
+ assert(n->child);
+ assert(n->child->string);
+ term_fontpush(p, TERMFONT_BOLD);
+ term_word(p, n->child->string);
return(0);
}
termp_fo_post(DECL_ARGS)
{
- if (MDOC_BODY != n->type)
+ if (MDOC_BODY != n->type)
return;
+
p->flags |= TERMP_NOSPACE;
term_word(p, ")");
- p->flags |= TERMP_NOSPACE;
- term_word(p, ";");
- term_newln(p);
+
+ if (SEC_SYNOPSIS == n->sec) {
+ p->flags |= TERMP_NOSPACE;
+ term_word(p, ";");
+ }
}
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);
/* TODO: %U. */
p->flags |= TERMP_NOSPACE;
- switch (n->tok) {
- case (MDOC__T):
- term_word(p, "\\(rq");
- p->flags |= TERMP_NOSPACE;
- break;
- default:
- break;
- }
term_word(p, n->next ? "," : ".");
}
+/* 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++;
- return(1);
-}
-
-
-/* ARGSUSED */
-static int
-termp__t_pre(DECL_ARGS)
-{
-
- term_word(p, "\\(lq");
- p->flags |= TERMP_NOSPACE;
+ term_fontpush(p, TERMFONT_UNDER);
return(1);
}
git.ckatri.com / mandoc.git / blobdiff