=================================================================== RCS file: /cvs/mandoc/mdoc_term.c,v retrieving revision 1.74 retrieving revision 1.168 diff -u -p -r1.74 -r1.168 --- mandoc/mdoc_term.c 2009/09/20 17:48:13 1.74 +++ mandoc/mdoc_term.c 2010/07/02 15:03:14 1.168 @@ -1,6 +1,6 @@ -/* $Id: mdoc_term.c,v 1.74 2009/09/20 17:48:13 kristaps Exp $ */ +/* $Id: mdoc_term.c,v 1.168 2010/07/02 15:03:14 kristaps Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -14,89 +14,77 @@ * 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 +#include "mandoc.h" +#include "out.h" #include "term.h" +#include "regs.h" #include "mdoc.h" +#include "chars.h" +#include "main.h" -/* FIXME: check HANG lists: they seem to be broken... : - * .Bl -hang -width Ds - * .It a - * b - * .It Fl f Ns Ar option... - * Override default compiler behaviour. See - * .Sx Compiler Options - * for details. - * Override default compiler behaviour. See - * .Sx Compiler Options - * for details. - * Override default compiler behaviour. See - * .Sx Compiler Options - * for details. - * Override default compiler behaviour. See - * .Sx Compiler Options - * for details. - * . - * .It a sasd fasd as afsd sfad sfds sadfs sd sfd ssfad asfd - * Override default compiler behaviour. See - * .Sx Compiler Options - * for details. - * Override default compiler behaviour. See - * .Sx Compiler Options - * for details. - * Override default compiler behaviour. See - * .Sx Compiler Options - * for details. - * Override default compiler behaviour. See - * .Sx Compiler Options - * for details. - * .El - * - */ - #define INDENT 5 #define HALFINDENT 3 struct termpair { struct termpair *ppair; - int flag; int count; }; #define DECL_ARGS struct termp *p, \ struct termpair *pair, \ - const struct mdoc_meta *meta, \ - const struct mdoc_node *node + const struct mdoc_meta *m, \ + const struct mdoc_node *n struct termact { int (*pre)(DECL_ARGS); void (*post)(DECL_ARGS); }; +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_getattr(int, 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_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_aq_post(DECL_ARGS); static void termp_bd_post(DECL_ARGS); +static void termp_bk_post(DECL_ARGS); static void termp_bl_post(DECL_ARGS); static void termp_bq_post(DECL_ARGS); 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); +static void termp_nm_post(DECL_ARGS); static void termp_op_post(DECL_ARGS); static void termp_pf_post(DECL_ARGS); static void termp_pq_post(DECL_ARGS); @@ -104,16 +92,16 @@ 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_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_bk_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_br_pre(DECL_ARGS); static int termp_brq_pre(DECL_ARGS); static int termp_bt_pre(DECL_ARGS); static int termp_cd_pre(DECL_ARGS); @@ -127,13 +115,13 @@ static int termp_fo_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_ns_pre(DECL_ARGS); static int termp_op_pre(DECL_ARGS); static int termp_pf_pre(DECL_ARGS); -static int termp_pp_pre(DECL_ARGS); static int termp_pq_pre(DECL_ARGS); static int termp_qq_pre(DECL_ARGS); static int termp_rs_pre(DECL_ARGS); @@ -145,6 +133,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); @@ -155,12 +144,12 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* Os */ { termp_sh_pre, termp_sh_post }, /* Sh */ { termp_ss_pre, termp_ss_post }, /* Ss */ - { termp_pp_pre, NULL }, /* Pp */ + { termp_sp_pre, NULL }, /* Pp */ { termp_d1_pre, termp_d1_post }, /* D1 */ { 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 */ @@ -173,27 +162,27 @@ 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 */ - { NULL, NULL }, /* Li */ + { termp_li_pre, NULL }, /* Li */ { termp_nd_pre, NULL }, /* Nd */ - { termp_nm_pre, NULL }, /* Nm */ + { termp_nm_pre, termp_nm_post }, /* Nm */ { termp_op_pre, termp_op_post }, /* Op */ { NULL, NULL }, /* Ot */ { termp_under_pre, NULL }, /* Pa */ { 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 */ - { NULL, termp____post }, /* %B */ + { termp_under_pre, termp____post }, /* %B */ { NULL, termp____post }, /* %D */ - { NULL, termp____post }, /* %I */ + { termp_under_pre, termp____post }, /* %I */ { termp_under_pre, termp____post }, /* %J */ { NULL, termp____post }, /* %N */ { NULL, termp____post }, /* %O */ @@ -215,12 +204,12 @@ 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 */ { termp_xx_pre, NULL }, /* Fx */ - { termp_bold_pre, NULL }, /* Ms */ + { termp_bold_pre, NULL }, /* Ms */ /* FIXME: convert to symbol? */ { NULL, NULL }, /* No */ { termp_ns_pre, NULL }, /* Ns */ { termp_xx_pre, NULL }, /* Nx */ @@ -249,128 +238,142 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* Fc */ { termp_op_pre, termp_op_post }, /* Oo */ { NULL, NULL }, /* Oc */ - { NULL, NULL }, /* Bk */ + { termp_bk_pre, termp_bk_post }, /* Bk */ { NULL, NULL }, /* Ek */ { termp_bt_pre, NULL }, /* Bt */ { NULL, NULL }, /* Hf */ { NULL, NULL }, /* Fr */ { termp_ud_pre, NULL }, /* Ud */ { NULL, termp_lb_post }, /* Lb */ - { termp_pp_pre, NULL }, /* Lp */ + { termp_sp_pre, NULL }, /* Lp */ { termp_lk_pre, NULL }, /* Lk */ { termp_under_pre, NULL }, /* Mt */ { termp_brq_pre, termp_brq_post }, /* Brq */ { termp_brq_pre, termp_brq_post }, /* Bro */ { NULL, NULL }, /* Brc */ - { NULL, NULL }, /* %C */ - { NULL, NULL }, /* Es */ - { NULL, NULL }, /* En */ + { NULL, termp____post }, /* %C */ + { NULL, NULL }, /* Es */ /* TODO */ + { NULL, NULL }, /* En */ /* TODO */ { termp_xx_pre, NULL }, /* Dx */ - { NULL, NULL }, /* %Q */ - { termp_br_pre, NULL }, /* br */ + { NULL, termp____post }, /* %Q */ + { termp_sp_pre, NULL }, /* br */ { termp_sp_pre, NULL }, /* sp */ + { termp_under_pre, termp____post }, /* %U */ + { NULL, NULL }, /* Ta */ }; -#ifdef __linux__ -extern size_t strlcpy(char *, const char *, size_t); -extern size_t strlcat(char *, const char *, size_t); -#endif -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 size_t arg_offset(const struct mdoc_argv *); -static size_t arg_width(const struct mdoc_argv *, int); -static int arg_listtype(const struct mdoc_node *); -static void fmt_block_vspace(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); - - void -mdoc_run(struct termp *p, const struct mdoc *mdoc) +terminal_mdoc(void *arg, const struct mdoc *mdoc) { const struct mdoc_node *n; const struct mdoc_meta *m; + struct termp *p; + 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): + p->symtab = chars_init(CHARS_ASCII); + break; + default: + abort(); + /* NOTREACHED */ + } + 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, meta, node); - if (node->next) - print_body(p, pair, meta, node->next); + print_mdoc_node(p, pair, m, n); + if (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 != node->type) { - if (termacts[node->tok].pre) - chld = (*termacts[node->tok].pre) - (p, &npair, meta, node); - } else - term_word(p, node->string); + if (MDOC_TEXT == n->type) + term_word(p, n->string); + else if (termacts[n->tok].pre && ENDBODY_NOT == n->end) + chld = (*termacts[n->tok].pre)(p, &npair, m, n); - if (chld && node->child) - print_body(p, &npair, meta, node->child); + if (chld && n->child) + print_mdoc_nodelist(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. - */ + term_fontpopq(p, font); - p->bold = bold; - p->under = under; + if (MDOC_TEXT != n->type && termacts[n->tok].post && + ! (MDOC_ENDED & n->flags)) { + (void)(*termacts[n->tok].post)(p, &npair, m, n); - if (MDOC_TEXT != node->type) - if (termacts[node->tok].post) - (*termacts[node->tok].post) - (p, &npair, meta, node); + /* + * Explicit end tokens not only call the post + * handler, but also tell the respective block + * that it must not call the post handler again. + */ + if (ENDBODY_NOT != n->end) + n->pending->flags |= MDOC_ENDED; + /* + * End of line terminating an implicit block + * while an explicit block is still open. + * Continue the explicit block without spacing. + */ + if (ENDBODY_NOSPACE == n->end) + p->flags |= TERMP_NOSPACE; + } + + 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) { - struct tm *tm; - char *buf, *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 * with the middle being the manual date and flanking columns @@ -379,29 +382,21 @@ print_foot(DECL_ARGS) * SYSTEM DATE SYSTEM */ - if (NULL == (buf = malloc(p->rmargin))) - err(EXIT_FAILURE, "malloc"); - if (NULL == (os = malloc(p->rmargin))) - err(EXIT_FAILURE, "malloc"); + time2a(m->date, buf, DATESIZ); + strlcpy(os, m->os, BUFSIZ); - tm = localtime(&meta->date); - - if (0 == strftime(buf, p->rmargin, "%B %e, %Y", tm)) - err(EXIT_FAILURE, "strftime"); - - (void)strlcpy(os, meta->os, p->rmargin); - 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); @@ -418,26 +413,20 @@ print_foot(DECL_ARGS) p->offset = 0; p->rmargin = p->maxrmargin; p->flags = 0; - - free(buf); - free(os); } -/* 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: @@ -451,26 +440,27 @@ print_head(DECL_ARGS) * switches on the manual section. */ - assert(meta->vol); - (void)strlcpy(buf, meta->vol, p->rmargin); + assert(m->vol); + strlcpy(buf, m->vol, BUFSIZ); - if (meta->arch) { - (void)strlcat(buf, " (", p->rmargin); - (void)strlcat(buf, meta->arch, p->rmargin); - (void)strlcat(buf, ")", p->rmargin); + if (m->arch) { + strlcat(buf, " (", BUFSIZ); + strlcat(buf, m->arch, BUFSIZ); + strlcat(buf, ")", BUFSIZ); } - snprintf(title, p->rmargin, "%s(%d)", meta->title, meta->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); @@ -487,197 +477,120 @@ print_head(DECL_ARGS) p->offset = 0; p->rmargin = p->maxrmargin; p->flags &= ~TERMP_NOSPACE; - - free(title); - free(buf); } -/* FIXME: put in utility file for front-ends. */ static size_t -arg_width(const struct mdoc_argv *arg, int pos) +a2height(const struct termp *p, const char *v) { - int i, len; - const char *p; + struct roffsu su; - assert(pos < (int)arg->sz && pos >= 0); - assert(arg->value[pos]); + assert(v); + if ( ! a2roffsu(v, &su, SCALE_VS)) + SCALE_VS_INIT(&su, term_len(p, 1)); - p = arg->value[pos]; - - if (0 == (len = (int)strlen(p))) - return(0); - - for (i = 0; i < len - 1; i++) - if ( ! isdigit((u_char)p[i])) - break; - - if (i == len - 1) - if ('n' == p[len - 1] || 'm' == p[len - 1]) - return((size_t)atoi(p) + 2); - - return((size_t)len + 2); + return(term_vspan(p, &su)); } -/* FIXME: put in utility file for front-ends. */ -static int -arg_listtype(const struct mdoc_node *n) +static size_t +a2width(const struct termp *p, const char *v) { - int i, len; + struct roffsu su; - assert(MDOC_BLOCK == n->type); + assert(v); + if ( ! a2roffsu(v, &su, SCALE_MAX)) + SCALE_HS_INIT(&su, term_strlen(p, v)); - 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); + return(term_hspan(p, &su)); } -/* FIXME: put in utility file for front-ends. */ static size_t -arg_offset(const struct mdoc_argv *arg) +a2offs(const struct termp *p, const char *v) { - int len, i; - const char *p; + struct roffsu su; - assert(*arg->value); - p = *arg->value; - - if (0 == strcmp(p, "left")) + if ('\0' == *v) return(0); - if (0 == strcmp(p, "indent")) - return(INDENT + 1); - if (0 == strcmp(p, "indent-two")) - return((INDENT + 1) * 2); - - if (0 == (len = (int)strlen(p))) + else if (0 == strcmp(v, "left")) return(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)); - for (i = 0; i < len - 1; i++) - if ( ! isdigit((u_char)p[i])) - break; - - if (i == len - 1) - if ('n' == p[len - 1] || 'm' == p[len - 1]) - return((size_t)atoi(p)); - - return((size_t)len); + return(term_hspan(p, &su)); } +/* + * Get the index of an argument in a node's argument list or -1 if it + * does not exist. + */ static int -arg_hasattr(int arg, const struct mdoc_node *n) -{ - - return(-1 != arg_getattr(arg, n)); -} - - -static int arg_getattr(int v, const struct mdoc_node *n) { - int val; + int i; - 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; - 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); } -/* ARGSUSED */ +/* + * 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 -fmt_block_vspace(struct termp *p, +print_bvspace(struct termp *p, const struct mdoc_node *bl, - const struct mdoc_node *node) + const struct mdoc_node *n) { - const struct mdoc_node *n; + const struct mdoc_node *nn; term_newln(p); - if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Compact, bl)) + if (MDOC_Bd == bl->tok && bl->data.Bd->comp) return; - assert(node); + if (MDOC_Bl == bl->tok && bl->data.Bl->comp) + return; - /* - * Search through our prior nodes. If we follow a `Ss' or `Sh', - * then don't vspace. - */ + /* Do not vspace directly after Ss/Sh. */ - for (n = node; n; n = n->parent) { - if (MDOC_BLOCK != n->type) + for (nn = n; nn; nn = nn->parent) { + if (MDOC_BLOCK != nn->type) continue; - if (MDOC_Ss == n->tok) + if (MDOC_Ss == nn->tok) return; - if (MDOC_Sh == n->tok) + if (MDOC_Sh == nn->tok) return; - if (NULL == n->prev) + if (NULL == nn->prev) continue; break; } - /* - * XXX - not documented: a `-column' does not ever assert vspace - * within the list. - */ + /* A `-column' does not assert vspace within the list. */ - if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Column, bl)) - if (node->prev && MDOC_It == node->prev->tok) + if (MDOC_Bl == bl->tok && LIST_column == bl->data.Bl->type) + if (n->prev && MDOC_It == n->prev->tok) return; - /* - * XXX - not documented: a `-diag' without a body does not - * assert a vspace prior to the next element. - */ - if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Diag, bl)) - if (node->prev && MDOC_It == node->prev->tok) { - assert(node->prev->body); - if (NULL == node->prev->body->child) + /* A `-diag' without body does not vspace. */ + + 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) return; } @@ -690,7 +603,7 @@ static int termp_dq_pre(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return(1); term_word(p, "\\(lq"); @@ -704,7 +617,7 @@ static void termp_dq_post(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return; p->flags |= TERMP_NOSPACE; @@ -716,73 +629,91 @@ termp_dq_post(DECL_ARGS) static int termp_it_pre(DECL_ARGS) { - const struct mdoc_node *bl, *n; + 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 == node->type) { - fmt_block_vspace(p, node->parent->parent, node); + if (MDOC_BLOCK == n->type) { + print_bvspace(p, n->parent->parent, n); return(1); } - bl = node->parent->parent->parent; + bl = n->parent->parent->parent; + assert(bl->data.Bl); + type = bl->data.Bl->type; - /* Save parent attributes. */ + /* + * 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. + */ - pair->flag = p->flags; + width = offset = 0; - /* Get list width and offset. */ + if (bl->data.Bl->offs) + offset = a2offs(p, bl->data.Bl->offs); - keys[0] = MDOC_Width; - keys[1] = MDOC_Offset; - keys[2] = MDOC_Column; + switch (type) { + case (LIST_column): + if (MDOC_HEAD == n->type) + break; - vals[0] = vals[1] = vals[2] = -1; + col = arg_getattr(MDOC_Column, bl); - width = offset = 0; + /* + * 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); - (void)arg_getattrs(keys, vals, 3, bl); + /* + * Calculate the offset by applying all prior MDOC_BODY, + * so we stop at the MDOC_HEAD (NULL == nn->prev). + */ - type = arg_listtype(bl); - assert(-1 != type); + for (i = 0, nn = n->prev; + nn->prev && i < (int)ncols; + nn = nn->prev, i++) + offset += dcol + a2width + (p, bl->args->argv[col].value[i]); - /* Calculate real width and offset. */ + /* + * 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; - switch (type) { - case (MDOC_Column): - if (MDOC_BODY == node->type) + /* + * 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 (NULL == bl->data.Bl->width) 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). + * 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. */ - for (i = 0, n = node->prev; n && - i < (int)bl->args[vals[2]].argv->sz; - n = n->prev, i++) - offset += arg_width - (&bl->args->argv[vals[2]], i); - - /* Whether exceeds maximum column. */ - if (i < (int)bl->args[vals[2]].argv->sz) - width = arg_width(&bl->args->argv[vals[2]], i); - else - width = 0; - - if (vals[1] >= 0) - offset += arg_offset(&bl->args->argv[vals[1]]); + assert(bl->data.Bl->width); + width = a2width(p, bl->data.Bl->width) + term_len(p, 2); break; - default: - if (vals[0] >= 0) - width = arg_width(&bl->args->argv[vals[0]], 0); - if (vals[1] >= 0) - offset += arg_offset(&bl->args->argv[vals[1]]); - break; } /* @@ -792,27 +723,27 @@ termp_it_pre(DECL_ARGS) */ 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; @@ -826,12 +757,12 @@ termp_it_pre(DECL_ARGS) p->flags |= TERMP_NOSPACE; switch (type) { - case (MDOC_Diag): - if (MDOC_BODY == node->type) + case (LIST_diag): + if (MDOC_BODY == n->type) term_word(p, "\\ \\ "); break; - case (MDOC_Inset): - if (MDOC_BODY == node->type) + case (LIST_inset): + if (MDOC_BODY == n->type) term_word(p, "\\ "); break; default: @@ -841,42 +772,41 @@ termp_it_pre(DECL_ARGS) p->flags |= TERMP_NOSPACE; switch (type) { - case (MDOC_Diag): - if (MDOC_HEAD == node->type) - p->bold++; + case (LIST_diag): + if (MDOC_HEAD == n->type) + 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): - if (MDOC_HEAD == node->type) + case (LIST_hyphen): + if (MDOC_HEAD == n->type) p->flags |= TERMP_NOBREAK; else p->flags |= TERMP_NOLPAD; break; - case (MDOC_Hang): - if (MDOC_HEAD == node->type) + case (LIST_hang): + if (MDOC_HEAD == n->type) p->flags |= TERMP_NOBREAK; else p->flags |= TERMP_NOLPAD; - if (MDOC_HEAD != node->type) + if (MDOC_HEAD != n->type) break; /* @@ -885,38 +815,41 @@ termp_it_pre(DECL_ARGS) * the "overstep" effect in term_flushln() and treat * this as a `-ohang' list instead. */ - if (node->next->child && - (MDOC_Bl == node->next->child->tok || - MDOC_Bd == node->next->child->tok)) { + if (n->next->child && + (MDOC_Bl == n->next->child->tok || + MDOC_Bd == n->next->child->tok)) { p->flags &= ~TERMP_NOBREAK; p->flags &= ~TERMP_NOLPAD; } else p->flags |= TERMP_HANG; break; - case (MDOC_Tag): - if (MDOC_HEAD == node->type) + case (LIST_tag): + if (MDOC_HEAD == n->type) p->flags |= TERMP_NOBREAK | TERMP_TWOSPACE; else p->flags |= TERMP_NOLPAD; - if (MDOC_HEAD != node->type) + if (MDOC_HEAD != n->type) break; - if (NULL == node->next || NULL == node->next->child) + if (NULL == n->next || NULL == n->next->child) p->flags |= TERMP_DANGLE; break; - case (MDOC_Column): - if (MDOC_HEAD == node->type) { - assert(node->next); - if (MDOC_BODY == node->next->type) - p->flags &= ~TERMP_NOBREAK; - else - p->flags |= TERMP_NOBREAK; - if (node->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): - if (MDOC_HEAD == node->type) + case (LIST_diag): + if (MDOC_HEAD == n->type) p->flags |= TERMP_NOBREAK; break; default: @@ -932,41 +865,42 @@ 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 * using `Bd' or `Bl' within `-hang' overstep lists. */ - if (MDOC_HEAD == node->type && node->next->child && - (MDOC_Bl == node->next->child->tok || - MDOC_Bd == node->next->child->tok)) + if (MDOC_HEAD == n->type && n->next->child && + (MDOC_Bl == n->next->child->tok || + 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 == node->type) + 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 == node->type && - MDOC_BODY == node->next->type) + if (MDOC_HEAD == n->type) + break; + if (NULL == n->next && p->rmargin < p->maxrmargin) p->rmargin = p->maxrmargin; break; default: @@ -978,23 +912,23 @@ termp_it_pre(DECL_ARGS) * HEAD character (temporarily bold, in some cases). */ - if (MDOC_HEAD == node->type) + 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; @@ -1007,20 +941,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): - if (MDOC_HEAD == node->type) + case (LIST_enum): + if (MDOC_HEAD == n->type) return(0); break; - case (MDOC_Column): - if (MDOC_BODY == node->type) + case (LIST_column): + if (MDOC_HEAD == n->type) return(0); break; default: @@ -1035,33 +969,42 @@ termp_it_pre(DECL_ARGS) static void termp_it_post(DECL_ARGS) { - int type; + enum mdoc_list type; - if (MDOC_BODY != node->type && MDOC_HEAD != node->type) + if (MDOC_BLOCK == n->type) return; - type = arg_listtype(node->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): - if (MDOC_BODY == node->type) - term_flushln(p); + case (LIST_inset): + if (MDOC_BODY == n->type) + term_newln(p); break; - case (MDOC_Column): - if (MDOC_HEAD == node->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; } @@ -1070,23 +1013,70 @@ static int termp_nm_pre(DECL_ARGS) { - if (SEC_SYNOPSIS == node->sec) - term_newln(p); - p->bold++; - if (NULL == node->child) - term_word(p, meta->name); + if (MDOC_BLOCK == n->type) + return(1); + + if (MDOC_BODY == n->type) { + if (NULL == n->child) + return(0); + p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + p->offset += term_len(p, 1) + + (NULL == n->prev->child ? term_strlen(p, m->name) : + MDOC_TEXT == n->prev->child->type ? + term_strlen(p, n->prev->child->string) : + term_len(p, 5)); + return(1); + } + + if (NULL == n->child && NULL == m->name) + return(0); + + synopsis_pre(p, n); + + if (MDOC_HEAD == n->type && n->next->child) { + p->flags |= TERMP_NOSPACE | TERMP_NOBREAK | TERMP_HANG; + p->rmargin = p->offset + term_len(p, 1) + + (NULL == n->child ? term_strlen(p, m->name) : + MDOC_TEXT == n->child->type ? + term_strlen(p, n->child->string) : + term_len(p, 5)); + } + + term_fontpush(p, TERMFONT_BOLD); + if (NULL == n->child) + term_word(p, m->name); return(1); } /* ARGSUSED */ +static void +termp_nm_post(DECL_ARGS) +{ + + if (MDOC_HEAD == n->type && n->next->child) { + term_flushln(p); + p->flags &= ~(TERMP_NOBREAK | TERMP_HANG); + } else if (MDOC_BODY == n->type && n->child) { + term_flushln(p); + p->flags &= ~TERMP_NOLPAD; + } +} + + +/* ARGSUSED */ static int 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); } @@ -1096,20 +1086,19 @@ static int termp_an_pre(DECL_ARGS) { - if (NULL == node->child) + if (NULL == n->child) return(1); /* - * XXX: this is poorly documented. If not in the AUTHORS - * section, `An -split' will cause newlines to occur before the - * author name. If in the AUTHORS section, by default, the - * first `An' invocation is nosplit, then all subsequent ones, - * regardless of whether interspersed with other macros/text, - * are split. -split, in this case, will override the condition - * of the implied first -nosplit. + * If not in the AUTHORS section, `An -split' will cause + * newlines to occur before the author name. If in the AUTHORS + * section, by default, the first `An' invocation is nosplit, + * then all subsequent ones, regardless of whether interspersed + * with other macros/text, are split. -split, in this case, + * will override the condition of the implied first -nosplit. */ - if (node->sec == SEC_AUTHORS) { + if (n->sec == SEC_AUTHORS) { if ( ! (TERMP_ANPREC & p->flags)) { if (TERMP_SPLIT & p->flags) term_newln(p); @@ -1133,16 +1122,16 @@ static void termp_an_post(DECL_ARGS) { - if (node->child) { - if (SEC_AUTHORS == node->sec) + if (n->child) { + if (SEC_AUTHORS == n->sec) p->flags |= TERMP_ANPREC; return; } - if (arg_getattr(MDOC_Split, node) > -1) { + if (AUTH_split == n->data.An.auth) { p->flags &= ~TERMP_NOSPLIT; p->flags |= TERMP_SPLIT; - } else { + } else if (AUTH_nosplit == n->data.An.auth) { p->flags &= ~TERMP_SPLIT; p->flags |= TERMP_NOSPLIT; } @@ -1162,20 +1151,12 @@ termp_ns_pre(DECL_ARGS) /* ARGSUSED */ static int -termp_pp_pre(DECL_ARGS) -{ - - term_vspace(p); - return(1); -} - - -/* ARGSUSED */ -static int termp_rs_pre(DECL_ARGS) { - if (MDOC_BLOCK == node->type && node->prev) + if (SEC_SEE_ALSO != n->sec) + return(1); + if (MDOC_BLOCK == n->type && n->prev) term_vspace(p); return(1); } @@ -1190,12 +1171,10 @@ termp_rv_pre(DECL_ARGS) term_newln(p); term_word(p, "The"); - nn = node->child; - assert(nn); - for ( ; nn; nn = nn->next) { - p->bold++; + for (nn = n->child; nn; nn = nn->next) { + 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"); @@ -1205,7 +1184,7 @@ termp_rv_pre(DECL_ARGS) term_word(p, "()"); } - if (node->child->next) + if (n->child && n->child->next) term_word(p, "functions return"); else term_word(p, "function returns"); @@ -1213,11 +1192,12 @@ termp_rv_pre(DECL_ARGS) 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); } @@ -1231,12 +1211,10 @@ termp_ex_pre(DECL_ARGS) term_word(p, "The"); - nn = node->child; - assert(nn); - for ( ; nn; nn = nn->next) { - p->bold++; + for (nn = n->child; nn; nn = nn->next) { + 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"); @@ -1246,12 +1224,13 @@ termp_ex_pre(DECL_ARGS) p->flags &= ~TERMP_NOSPACE; } - if (node->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); } @@ -1262,7 +1241,7 @@ static int termp_nd_pre(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return(1); #if defined(__OpenBSD__) || defined(__linux__) @@ -1275,11 +1254,20 @@ 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) { - if (MDOC_BLOCK == node->type) + if (MDOC_BLOCK == n->type) term_newln(p); } @@ -1289,7 +1277,7 @@ static void termp_op_post(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return; p->flags |= TERMP_NOSPACE; term_word(p, "\\(rB"); @@ -1300,59 +1288,120 @@ termp_op_post(DECL_ARGS) static int termp_xr_pre(DECL_ARGS) { - const struct mdoc_node *n; + const struct mdoc_node *nn; - assert(node->child && MDOC_TEXT == node->child->type); - n = node->child; + if (NULL == n->child) + return(0); - term_word(p, n->string); - if (NULL == (n = n->next)) + assert(MDOC_TEXT == n->child->type); + nn = n->child; + + term_word(p, nn->string); + if (NULL == (nn = nn->next)) return(0); p->flags |= TERMP_NOSPACE; term_word(p, "("); p->flags |= TERMP_NOSPACE; - term_word(p, n->string); + term_word(p, nn->string); p->flags |= TERMP_NOSPACE; term_word(p, ")"); + return(0); } -/* 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 (node->sec != SEC_SYNOPSIS) + /* + * Obviously, if we're not in a SYNOPSIS or no prior macros + * exist, do nothing. + */ + if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags)) return; - if (node->next && MDOC_Vt == node->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 (node->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) { - 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 (node->sec != SEC_SYNOPSIS) - return; - - term_newln(p); - if (node->next && MDOC_Fd != node->next->tok) - term_vspace(p); + synopsis_pre(p, n); + return(termp_bold_pre(p, pair, m, n)); } @@ -1360,22 +1409,21 @@ termp_fd_post(DECL_ARGS) static int termp_sh_pre(DECL_ARGS) { - /* - * XXX: undocumented: using two `Sh' macros in sequence has no - * vspace between calls, only a newline. - */ - switch (node->type) { + + /* No vspace between consecutive `Sh' calls. */ + + switch (n->type) { case (MDOC_BLOCK): - if (node->prev && MDOC_Sh == node->prev->tok) - if (NULL == node->prev->body->child) + if (n->prev && MDOC_Sh == n->prev->tok) + if (NULL == n->prev->body->child) break; 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; @@ -1389,7 +1437,7 @@ static void termp_sh_post(DECL_ARGS) { - switch (node->type) { + switch (n->type) { case (MDOC_HEAD): term_newln(p); break; @@ -1408,7 +1456,7 @@ static int termp_op_pre(DECL_ARGS) { - switch (node->type) { + switch (n->type) { case (MDOC_BODY): term_word(p, "\\(lB"); p->flags |= TERMP_NOSPACE; @@ -1426,7 +1474,8 @@ termp_bt_pre(DECL_ARGS) { term_word(p, "is currently in beta test."); - return(1); + p->flags |= TERMP_SENTENCE; + return(0); } @@ -1435,7 +1484,8 @@ static void termp_lb_post(DECL_ARGS) { - term_newln(p); + if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags) + term_newln(p); } @@ -1445,7 +1495,8 @@ termp_ud_pre(DECL_ARGS) { term_word(p, "currently under development."); - return(1); + p->flags |= TERMP_SENTENCE; + return(0); } @@ -1454,10 +1505,10 @@ static int termp_d1_pre(DECL_ARGS) { - if (MDOC_BLOCK != node->type) + if (MDOC_BLOCK != n->type) return(1); term_newln(p); - p->offset += (INDENT + 1); + p->offset += term_len(p, (INDENT + 1)); return(1); } @@ -1467,7 +1518,7 @@ static void termp_d1_post(DECL_ARGS) { - if (MDOC_BLOCK != node->type) + if (MDOC_BLOCK != n->type) return; term_newln(p); } @@ -1478,7 +1529,7 @@ static int termp_aq_pre(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return(1); term_word(p, "\\(la"); p->flags |= TERMP_NOSPACE; @@ -1491,7 +1542,7 @@ static void termp_aq_post(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return; p->flags |= TERMP_NOSPACE; term_word(p, "\\(ra"); @@ -1503,52 +1554,40 @@ static int termp_ft_pre(DECL_ARGS) { - if (SEC_SYNOPSIS == node->sec) - if (node->prev && MDOC_Fo == node->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 == node->sec) - term_newln(p); -} - - -/* ARGSUSED */ static int termp_fn_pre(DECL_ARGS) { - const struct mdoc_node *n; + const struct mdoc_node *nn; - assert(node->child && MDOC_TEXT == node->child->type); + synopsis_pre(p, n); - /* FIXME: can be "type funcname" "type varname"... */ + term_fontpush(p, TERMFONT_BOLD); + term_word(p, n->child->string); + term_fontpop(p); - p->bold++; - term_word(p, node->child->string); - p->bold--; - p->flags |= TERMP_NOSPACE; term_word(p, "("); - for (n = node->child->next; n; n = n->next) { - p->under++; - term_word(p, n->string); - p->under--; - if (n->next) + for (nn = n->child->next; nn; nn = nn->next) { + term_fontpush(p, TERMFONT_UNDER); + term_word(p, nn->string); + term_fontpop(p); + + if (nn->next) term_word(p, ","); } term_word(p, ")"); - if (SEC_SYNOPSIS == node->sec) + if (MDOC_SYNPRETTY & n->flags) term_word(p, ";"); return(0); @@ -1556,35 +1595,26 @@ termp_fn_pre(DECL_ARGS) /* ARGSUSED */ -static void -termp_fn_post(DECL_ARGS) -{ - - if (node->sec == SEC_SYNOPSIS && node->next) - term_vspace(p); -} - - -/* ARGSUSED */ static int termp_fa_pre(DECL_ARGS) { - struct mdoc_node *n; + const struct mdoc_node *nn; - if (node->parent->tok != MDOC_Fo) { - p->under++; + if (n->parent->tok != MDOC_Fo) { + term_fontpush(p, TERMFONT_UNDER); return(1); } - for (n = node->child; n; n = n->next) { - p->under++; - term_word(p, n->string); - p->under--; - if (n->next) + for (nn = n->child; nn; nn = nn->next) { + term_fontpush(p, TERMFONT_UNDER); + term_word(p, nn->string); + term_fontpop(p); + + if (nn->next) term_word(p, ","); } - if (node->child && node->next && node->next->tok == MDOC_Fa) + if (n->child && n->next && n->next->tok == MDOC_Fa) term_word(p, ","); return(0); @@ -1595,66 +1625,50 @@ termp_fa_pre(DECL_ARGS) static int termp_bd_pre(DECL_ARGS) { - int i, type; + size_t tabwidth; + size_t rm, rmax; + const struct mdoc_node *nn; - /* - * This is fairly tricky due primarily to crappy documentation. - * If -ragged or -filled are specified, the block does nothing - * but change the indentation. - * - * If, on the other hand, -unfilled or -literal are specified, - * then the game changes. Text is printed exactly as entered in - * the display: if a macro line, a newline is appended to the - * line. Blank lines are allowed. - */ - - if (MDOC_BLOCK == node->type) { - fmt_block_vspace(p, node, node); + if (MDOC_BLOCK == n->type) { + print_bvspace(p, n, n); return(1); - } else if (MDOC_BODY != node->type) - return(1); + } else if (MDOC_HEAD == n->type) + return(0); - assert(node->parent->args); + assert(n->data.Bd); + if (n->data.Bd->offs) + p->offset += a2offs(p, n->data.Bd->offs); - for (type = -1, i = 0; -1 == type && - i < (int)node->parent->args->argc; i++) { - switch (node->parent->args->argv[i].arg) { - case (MDOC_Ragged): - /* FALLTHROUGH */ - case (MDOC_Filled): - /* FALLTHROUGH */ - case (MDOC_Unfilled): - /* FALLTHROUGH */ - case (MDOC_Literal): - type = node->parent->args->argv[i].arg; - break; - default: - break; - } - } + /* + * If -ragged or -filled are specified, the block does nothing + * but change the indentation. If -unfilled or -literal are + * specified, text is printed exactly as entered in the display: + * for macro lines, a newline is appended to the line. Blank + * lines are allowed. + */ - assert(type > -1); - - i = arg_getattr(MDOC_Offset, node->parent); - if (-1 != i) - p->offset += arg_offset(&node->parent->args->argv[i]); - - switch (type) { - case (MDOC_Literal): - /* FALLTHROUGH */ - case (MDOC_Unfilled): - break; - default: + if (DISP_literal != n->data.Bd->type && + DISP_unfilled != n->data.Bd->type) return(1); - } - for (node = node->child; node; node = node->next) { + 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, meta, node); - if (node->next) + 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); } @@ -1663,11 +1677,24 @@ termp_bd_pre(DECL_ARGS) static void termp_bd_post(DECL_ARGS) { + size_t rm, rmax; - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return; + + rm = p->rmargin; + rmax = p->maxrmargin; + + assert(n->data.Bd); + 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; } @@ -1676,7 +1703,7 @@ static int termp_qq_pre(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return(1); term_word(p, "\""); p->flags |= TERMP_NOSPACE; @@ -1689,7 +1716,7 @@ static void termp_qq_post(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return; p->flags |= TERMP_NOSPACE; term_word(p, "\""); @@ -1701,7 +1728,7 @@ static void termp_bx_post(DECL_ARGS) { - if (node->child) + if (n->child) p->flags |= TERMP_NOSPACE; term_word(p, "BSD"); } @@ -1714,12 +1741,12 @@ termp_xx_pre(DECL_ARGS) const char *pp; pp = NULL; - switch (node->tok) { + switch (n->tok) { case (MDOC_Bsx): pp = "BSDI BSD/OS"; break; case (MDOC_Dx): - pp = "DragonFlyBSD"; + pp = "DragonFly"; break; case (MDOC_Fx): pp = "FreeBSD"; @@ -1748,7 +1775,7 @@ static int termp_sq_pre(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return(1); term_word(p, "\\(oq"); p->flags |= TERMP_NOSPACE; @@ -1761,7 +1788,7 @@ static void termp_sq_post(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return; p->flags |= TERMP_NOSPACE; term_word(p, "\\(aq"); @@ -1793,15 +1820,15 @@ static int termp_ss_pre(DECL_ARGS) { - switch (node->type) { + switch (n->type) { case (MDOC_BLOCK): term_newln(p); - if (node->prev) + if (n->prev) 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; @@ -1816,7 +1843,7 @@ static void termp_ss_post(DECL_ARGS) { - if (MDOC_HEAD == node->type) + if (MDOC_HEAD == n->type) term_newln(p); } @@ -1826,8 +1853,8 @@ static int termp_cd_pre(DECL_ARGS) { - p->bold++; - term_newln(p); + synopsis_pre(p, n); + term_fontpush(p, TERMFONT_BOLD); return(1); } @@ -1837,11 +1864,17 @@ static int termp_in_pre(DECL_ARGS) { - p->bold++; - if (SEC_SYNOPSIS == node->sec) + synopsis_pre(p, n); + + if (MDOC_SYNPRETTY & n->flags && 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); } @@ -1852,22 +1885,14 @@ static void termp_in_post(DECL_ARGS) { - p->bold++; + if (MDOC_SYNPRETTY & n->flags) + term_fontpush(p, TERMFONT_BOLD); + + p->flags |= TERMP_NOSPACE; term_word(p, ">"); - p->bold--; - if (SEC_SYNOPSIS != node->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 (node->next && MDOC_In != node->next->tok) - term_vspace(p); + if (MDOC_SYNPRETTY & n->flags) + term_fontpop(p); } @@ -1875,14 +1900,20 @@ termp_in_post(DECL_ARGS) static int termp_sp_pre(DECL_ARGS) { - int i, len; + size_t i, len; - if (NULL == node->child) { - term_vspace(p); - return(0); + switch (n->tok) { + case (MDOC_sp): + len = n->child ? a2height(p, n->child->string) : 1; + break; + case (MDOC_br): + len = 0; + break; + default: + len = 1; + break; } - len = atoi(node->child->string); if (0 == len) term_newln(p); for (i = 0; i < len; i++) @@ -1894,20 +1925,10 @@ termp_sp_pre(DECL_ARGS) /* ARGSUSED */ static int -termp_br_pre(DECL_ARGS) -{ - - term_newln(p); - return(1); -} - - -/* ARGSUSED */ -static int termp_brq_pre(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return(1); term_word(p, "\\(lC"); p->flags |= TERMP_NOSPACE; @@ -1920,7 +1941,7 @@ static void termp_brq_post(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return; p->flags |= TERMP_NOSPACE; term_word(p, "\\(rC"); @@ -1932,7 +1953,7 @@ static int termp_bq_pre(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return(1); term_word(p, "\\(lB"); p->flags |= TERMP_NOSPACE; @@ -1945,7 +1966,7 @@ static void termp_bq_post(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return; p->flags |= TERMP_NOSPACE; term_word(p, "\\(rB"); @@ -1957,7 +1978,7 @@ static int termp_pq_pre(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return(1); term_word(p, "\\&("); p->flags |= TERMP_NOSPACE; @@ -1970,7 +1991,7 @@ static void termp_pq_post(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return; term_word(p, ")"); } @@ -1980,23 +2001,23 @@ termp_pq_post(DECL_ARGS) static int termp_fo_pre(DECL_ARGS) { - const struct mdoc_node *n; - if (MDOC_BODY == node->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 != node->type) - return(1); + } - p->bold++; - for (n = node->child; n; n = n->next) { - assert(MDOC_TEXT == n->type); - term_word(p, n->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); } @@ -2006,13 +2027,16 @@ static void termp_fo_post(DECL_ARGS) { - if (MDOC_BODY != node->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 (MDOC_SYNPRETTY & n->flags) { + p->flags |= TERMP_NOSPACE; + term_word(p, ";"); + } } @@ -2020,28 +2044,21 @@ termp_fo_post(DECL_ARGS) static int termp_bf_pre(DECL_ARGS) { - const struct mdoc_node *n; - if (MDOC_HEAD == node->type) + if (MDOC_HEAD == n->type) return(0); - else if (MDOC_BLOCK != node->type) + else if (MDOC_BLOCK != n->type) return(1); - if (NULL == (n = node->head->child)) { - if (arg_hasattr(MDOC_Emphasis, node)) - p->under++; - else if (arg_hasattr(MDOC_Symbolic, node)) - p->bold++; + assert(n->data.Bf); - return(1); - } + if (FONT_Em == n->data.Bf->font) + term_fontpush(p, TERMFONT_UNDER); + else if (FONT_Sy == n->data.Bf->font) + term_fontpush(p, TERMFONT_BOLD); + else + term_fontpush(p, TERMFONT_NONE); - assert(MDOC_TEXT == n->type); - if (0 == strcmp("Em", n->string)) - p->under++; - else if (0 == strcmp("Sy", n->string)) - p->bold++; - return(1); } @@ -2051,11 +2068,10 @@ static int termp_sm_pre(DECL_ARGS) { - assert(node->child && MDOC_TEXT == node->child->type); - if (0 == strcmp("on", node->child->string)) { + assert(n->child && MDOC_TEXT == n->child->type); + if (0 == strcmp("on", n->child->string)) p->flags &= ~TERMP_NONOSPACE; - p->flags &= ~TERMP_NOSPACE; - } else + else p->flags |= TERMP_NONOSPACE; return(0); @@ -2079,35 +2095,45 @@ static void termp____post(DECL_ARGS) { + /* TODO: %U. */ + p->flags |= TERMP_NOSPACE; - term_word(p, node->next ? "," : "."); + 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 *n; + const struct mdoc_node *nn; - assert(node->child); - n = node->child; + term_fontpush(p, TERMFONT_UNDER); + nn = n->child; - if (NULL == n->next) { - p->under++; + if (NULL == nn->next) return(1); - } - p->under++; - term_word(p, n->string); + term_word(p, nn->string); + term_fontpop(p); + p->flags |= TERMP_NOSPACE; term_word(p, ":"); - p->under--; - p->bold++; - for (n = n->next; n; n = n->next) - term_word(p, n->string); - p->bold--; + term_fontpush(p, TERMFONT_BOLD); + for (nn = nn->next; nn; nn = nn->next) + term_word(p, nn->string); + term_fontpop(p); return(0); } @@ -2115,9 +2141,40 @@ termp_lk_pre(DECL_ARGS) /* ARGSUSED */ static int +termp_bk_pre(DECL_ARGS) +{ + + switch (n->type) { + case (MDOC_BLOCK): + break; + case (MDOC_HEAD): + return(0); + case (MDOC_BODY): + p->flags |= TERMP_PREKEEP; + break; + default: + abort(); + /* NOTREACHED */ + } + + return(1); +} + + +/* ARGSUSED */ +static void +termp_bk_post(DECL_ARGS) +{ + + if (MDOC_BODY == n->type) + p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP); +} + +/* ARGSUSED */ +static int termp_under_pre(DECL_ARGS) { - p->under++; + term_fontpush(p, TERMFONT_UNDER); return(1); }