=================================================================== RCS file: /cvs/mandoc/mdoc_term.c,v retrieving revision 1.102 retrieving revision 1.147 diff -u -p -r1.102 -r1.147 --- mandoc/mdoc_term.c 2009/11/12 05:50:12 1.102 +++ mandoc/mdoc_term.c 2010/06/12 10:09:19 1.147 @@ -1,4 +1,4 @@ -/* $Id: mdoc_term.c,v 1.102 2009/11/12 05:50:12 kristaps Exp $ */ +/* $Id: mdoc_term.c,v 1.147 2010/06/12 10:09:19 kristaps Exp $ */ /* * Copyright (c) 2008, 2009 Kristaps Dzonsons * @@ -14,14 +14,20 @@ * 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 #include #include +#include #include #include #include +#include "mandoc.h" #include "out.h" #include "term.h" #include "mdoc.h" @@ -33,7 +39,6 @@ struct termpair { struct termpair *ppair; - int flag; int count; }; @@ -55,20 +60,16 @@ static int arg_hasattr(int, const struct mdoc_node * static int arg_getattrs(const int *, int *, size_t, const struct mdoc_node *); static int arg_getattr(int, const struct mdoc_node *); -static int arg_listtype(const struct mdoc_node *); static void print_bvspace(struct termp *, const struct mdoc_node *, const struct mdoc_node *); static void print_mdoc_node(DECL_ARGS); -static void print_mdoc_head(DECL_ARGS); static void print_mdoc_nodelist(DECL_ARGS); -static void print_foot(DECL_ARGS); +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 *); -#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); @@ -79,10 +80,8 @@ static void termp_brq_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); @@ -93,14 +92,13 @@ static void termp_qq_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); @@ -134,6 +132,7 @@ static int termp_sq_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); @@ -149,7 +148,7 @@ static const struct termact termacts[MDOC_MAX] = { { 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 */ @@ -162,10 +161,10 @@ static const struct termact termacts[MDOC_MAX] = { { 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 */ { termp_li_pre, NULL }, /* Li */ @@ -177,7 +176,7 @@ static const struct termact termacts[MDOC_MAX] = { { 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 */ @@ -188,7 +187,7 @@ static const struct termact termacts[MDOC_MAX] = { { 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 */ @@ -204,7 +203,7 @@ static const struct termact termacts[MDOC_MAX] = { { 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 */ @@ -259,6 +258,7 @@ static const struct termact termacts[MDOC_MAX] = { { termp_sp_pre, NULL }, /* br */ { termp_sp_pre, NULL }, /* sp */ { termp_under_pre, termp____post }, /* %U */ + { NULL, NULL }, /* Ta */ }; @@ -271,6 +271,10 @@ terminal_mdoc(void *arg, const struct mdoc *mdoc) p = (struct termp *)arg; + p->overstep = 0; + p->maxrmargin = p->defrmargin; + p->tabwidth = 5; + if (NULL == p->symtab) switch (p->enc) { case (TERMENC_ASCII): @@ -284,10 +288,12 @@ terminal_mdoc(void *arg, const struct mdoc *mdoc) n = mdoc_node(mdoc); m = mdoc_meta(mdoc); - print_mdoc_head(p, NULL, m, n); + term_begin(p, print_mdoc_head, print_mdoc_foot, m); + if (n->child) print_mdoc_nodelist(p, NULL, m, n->child); - print_foot(p, NULL, m, n); + + term_end(p); } @@ -333,17 +339,22 @@ print_mdoc_node(DECL_ARGS) 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], os[BUFSIZ]; + const struct mdoc_meta *m; + m = (const struct mdoc_meta *)arg; + term_fontrepl(p, TERMFONT_NONE); /* @@ -387,12 +398,14 @@ print_foot(DECL_ARGS) } -/* ARGSUSED */ static void -print_mdoc_head(DECL_ARGS) +print_mdoc_head(struct termp *p, const void *arg) { char buf[BUFSIZ], title[BUFSIZ]; + const struct mdoc_meta *m; + m = (const struct mdoc_meta *)arg; + p->rmargin = p->maxrmargin; p->offset = 0; @@ -418,7 +431,7 @@ print_mdoc_head(DECL_ARGS) strlcat(buf, ")", BUFSIZ); } - snprintf(title, BUFSIZ, "%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; @@ -471,52 +484,10 @@ a2width(const struct mdoc_argv *arg, int pos) 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)); } -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; - } - - return(-1); -} - - static size_t a2offs(const struct mdoc_argv *arg) { @@ -537,6 +508,10 @@ a2offs(const struct mdoc_argv *arg) } +/* + * 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) { @@ -545,6 +520,10 @@ 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) { @@ -554,6 +533,12 @@ 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) @@ -573,6 +558,11 @@ arg_getattrs(const int *keys, int *vals, } +/* + * 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, @@ -600,13 +590,13 @@ print_bvspace(struct termp *p, /* 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.list) 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.list) if (n->prev && MDOC_It == n->prev->tok) { assert(n->prev->body); if (NULL == n->prev->body->child) @@ -650,8 +640,9 @@ termp_it_pre(DECL_ARGS) { const struct mdoc_node *bl, *nn; char buf[7]; - int i, type, keys[3], vals[3]; - size_t width, offset; + int i, keys[3], vals[3]; + size_t width, offset, ncols, dcol; + enum mdoc_list type; if (MDOC_BLOCK == n->type) { print_bvspace(p, n->parent->parent, n); @@ -660,60 +651,83 @@ termp_it_pre(DECL_ARGS) bl = n->parent->parent->parent; - /* Save parent attributes. */ + /* Get list width, offset, and list type from argument list. */ - 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; - width = offset = 0; + arg_getattrs(keys, vals, 3, bl); - (void)arg_getattrs(keys, vals, 3, bl); + type = bl->data.list; - type = arg_listtype(bl); - assert(-1 != type); + /* + * 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. + */ - /* Calculate real width and offset. */ + width = offset = 0; + if (vals[1] >= 0) + offset = a2offs(&bl->args->argv[vals[1]]); + 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). + /* + * 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; + + /* + * 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->prev && 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; } @@ -724,25 +738,25 @@ termp_it_pre(DECL_ARGS) */ switch (type) { - case (MDOC_Bullet): + case (LIST_bullet): /* FALLTHROUGH */ - case (MDOC_Dash): + case (LIST_dash): /* FALLTHROUGH */ - case (MDOC_Hyphen): + case (LIST_hyphen): if (width < 4) width = 4; break; - case (MDOC_Enum): + case (LIST_enum): if (width < 5) width = 5; break; - case (MDOC_Hang): + case (LIST_hang): if (0 == width) width = 8; break; - case (MDOC_Column): + case (LIST_column): /* FALLTHROUGH */ - case (MDOC_Tag): + case (LIST_tag): if (0 == width) width = 10; break; @@ -758,11 +772,11 @@ termp_it_pre(DECL_ARGS) 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; @@ -773,7 +787,7 @@ termp_it_pre(DECL_ARGS) p->flags |= TERMP_NOSPACE; switch (type) { - case (MDOC_Diag): + case (LIST_diag): if (MDOC_HEAD == n->type) term_fontpush(p, TERMFONT_BOLD); break; @@ -782,27 +796,26 @@ termp_it_pre(DECL_ARGS) } /* - * 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 @@ -825,7 +838,7 @@ termp_it_pre(DECL_ARGS) } else p->flags |= TERMP_HANG; break; - case (MDOC_Tag): + case (LIST_tag): if (MDOC_HEAD == n->type) p->flags |= TERMP_NOBREAK | TERMP_TWOSPACE; else @@ -836,18 +849,21 @@ termp_it_pre(DECL_ARGS) 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; @@ -864,7 +880,7 @@ termp_it_pre(DECL_ARGS) 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 @@ -875,30 +891,31 @@ termp_it_pre(DECL_ARGS) 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: @@ -912,21 +929,21 @@ termp_it_pre(DECL_ARGS) if (MDOC_HEAD == n->type) switch (type) { - case (MDOC_Bullet): + case (LIST_bullet): term_fontpush(p, TERMFONT_BOLD); term_word(p, "\\[bu]"); term_fontpop(p); break; - case (MDOC_Dash): + case (LIST_dash): /* FALLTHROUGH */ - case (MDOC_Hyphen): + case (LIST_hyphen): term_fontpush(p, TERMFONT_BOLD); term_word(p, "\\(hy"); 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; @@ -939,20 +956,20 @@ termp_it_pre(DECL_ARGS) */ 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: @@ -967,33 +984,42 @@ termp_it_pre(DECL_ARGS) 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.list; 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; } @@ -1002,11 +1028,12 @@ static int termp_nm_pre(DECL_ARGS) { - if (SEC_SYNOPSIS == n->sec) - term_newln(p); + if (NULL == n->child && NULL == m->name) + return(1); - term_fontpush(p, TERMFONT_BOLD); + synopsis_pre(p, n); + term_fontpush(p, TERMFONT_BOLD); if (NULL == n->child) term_word(p, m->name); return(1); @@ -1020,7 +1047,12 @@ termp_fl_pre(DECL_ARGS) 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); } @@ -1072,7 +1104,7 @@ termp_an_post(DECL_ARGS) return; } - if (arg_getattr(MDOC_Split, n) > -1) { + if (arg_hasattr(MDOC_Split, n)) { p->flags &= ~TERMP_NOSPLIT; p->flags |= TERMP_SPLIT; } else { @@ -1128,7 +1160,7 @@ termp_rv_pre(DECL_ARGS) term_word(p, "()"); } - if (n->child->next) + if (n->child && n->child->next) term_word(p, "functions return"); else term_word(p, "function returns"); @@ -1141,6 +1173,7 @@ termp_rv_pre(DECL_ARGS) term_fontpop(p); term_word(p, "is set to indicate the error."); + p->flags |= TERMP_SENTENCE; return(0); } @@ -1167,12 +1200,13 @@ termp_ex_pre(DECL_ARGS) 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); } @@ -1196,6 +1230,15 @@ termp_nd_pre(DECL_ARGS) /* ARGSUSED */ +static int +termp_bl_pre(DECL_ARGS) +{ + + return(MDOC_HEAD != n->type); +} + + +/* ARGSUSED */ static void termp_bl_post(DECL_ARGS) { @@ -1223,7 +1266,10 @@ termp_xr_pre(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); @@ -1240,20 +1286,81 @@ termp_xr_pre(DECL_ARGS) } -/* 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)); +} + + /* ARGSUSED */ static int termp_bold_pre(DECL_ARGS) @@ -1265,16 +1372,12 @@ termp_bold_pre(DECL_ARGS) /* 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)); } @@ -1347,6 +1450,7 @@ termp_bt_pre(DECL_ARGS) { term_word(p, "is currently in beta test."); + p->flags |= TERMP_SENTENCE; return(0); } @@ -1356,7 +1460,7 @@ static void termp_lb_post(DECL_ARGS) { - if (SEC_LIBRARY == n->sec) + if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags) term_newln(p); } @@ -1367,6 +1471,7 @@ termp_ud_pre(DECL_ARGS) { term_word(p, "currently under development."); + p->flags |= TERMP_SENTENCE; return(0); } @@ -1425,31 +1530,21 @@ static int termp_ft_pre(DECL_ARGS) { - if (SEC_SYNOPSIS == n->sec) - if (n->prev && MDOC_Fo == n->prev->tok) - term_vspace(p); - + /* 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; + synopsis_pre(p, n); + term_fontpush(p, TERMFONT_BOLD); term_word(p, n->child->string); term_fontpop(p); @@ -1476,16 +1571,6 @@ termp_fn_pre(DECL_ARGS) /* 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) { @@ -1516,37 +1601,21 @@ termp_fa_pre(DECL_ARGS) static int termp_bd_pre(DECL_ARGS) { - int i, type; + size_t tabwidth; + int i; + 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); + } else if (MDOC_HEAD == n->type) + return(0); nn = n->parent; - 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 (-1 != (i = arg_getattr(MDOC_Offset, nn))) + p->offset += a2offs(&nn->args->argv[i]); /* * If -ragged or -filled are specified, the block does nothing @@ -1556,21 +1625,28 @@ termp_bd_pre(DECL_ARGS) * lines are allowed. */ - assert(type > -1); - if (MDOC_Literal != type && MDOC_Unfilled != type) + if (DISP_literal != n->data.disp && + DISP_unfilled != n->data.disp) return(1); + tabwidth = p->tabwidth; + p->tabwidth = 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_mdoc_node(p, pair, m, nn); - if (NULL == nn->next) - continue; - if (nn->prev && nn->prev->line < nn->line) + if (NULL == nn->prev || + nn->prev->line < nn->line || + NULL == nn->next) term_flushln(p); - else if (NULL == nn->prev) - term_flushln(p); } + p->tabwidth = tabwidth; + p->rmargin = rm; + p->maxrmargin = rmax; return(0); } @@ -1579,11 +1655,23 @@ termp_bd_pre(DECL_ARGS) 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.disp || + DISP_unfilled == n->data.disp) + p->rmargin = p->maxrmargin = TERM_MAXMARGIN; + p->flags |= TERMP_NOSPACE; - term_flushln(p); + term_newln(p); + + p->rmargin = rm; + p->maxrmargin = rmax; } @@ -1742,8 +1830,8 @@ static int termp_cd_pre(DECL_ARGS) { + synopsis_pre(p, n); term_fontpush(p, TERMFONT_BOLD); - term_newln(p); return(1); } @@ -1753,11 +1841,17 @@ static int termp_in_pre(DECL_ARGS) { - term_fontpush(p, TERMFONT_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); } @@ -1768,23 +1862,14 @@ static void termp_in_post(DECL_ARGS) { - term_fontpush(p, TERMFONT_BOLD); + if (SEC_SYNOPSIS == n->sec) + term_fontpush(p, TERMFONT_BOLD); + p->flags |= TERMP_NOSPACE; term_word(p, ">"); - term_fontpop(p); - 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 ; 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); } @@ -1893,23 +1978,23 @@ termp_pq_post(DECL_ARGS) 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); + } - term_fontpush(p, TERMFONT_BOLD); - for (nn = n->child; nn; nn = nn->next) { - assert(MDOC_TEXT == nn->type); - term_word(p, nn->string); - } - term_fontpop(p); + /* 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); } @@ -1919,13 +2004,16 @@ static void 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, ";"); + } } @@ -1969,10 +2057,9 @@ termp_sm_pre(DECL_ARGS) { 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); @@ -1999,14 +2086,6 @@ termp____post(DECL_ARGS) /* 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 ? "," : "."); } @@ -2054,16 +2133,5 @@ termp_under_pre(DECL_ARGS) { term_fontpush(p, TERMFONT_UNDER); - return(1); -} - - -/* ARGSUSED */ -static int -termp__t_pre(DECL_ARGS) -{ - - term_word(p, "\\(lq"); - p->flags |= TERMP_NOSPACE; return(1); }