=================================================================== RCS file: /cvs/mandoc/mdoc_term.c,v retrieving revision 1.44 retrieving revision 1.83 diff -u -p -r1.44 -r1.83 --- mandoc/mdoc_term.c 2009/07/17 10:56:57 1.44 +++ mandoc/mdoc_term.c 2009/09/24 15:01:06 1.83 @@ -1,4 +1,4 @@ -/* $Id: mdoc_term.c,v 1.44 2009/07/17 10:56:57 kristaps Exp $ */ +/* $Id: mdoc_term.c,v 1.83 2009/09/24 15:01:06 kristaps Exp $ */ /* * Copyright (c) 2008, 2009 Kristaps Dzonsons * @@ -26,60 +26,44 @@ #include "term.h" #include "mdoc.h" -/* FIXME: macro arguments can be escaped. */ -/* FIXME: support more offset/width tokens. */ +/* 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 TTYPE_PROG 0 -#define TTYPE_CMD_FLAG 1 -#define TTYPE_CMD_ARG 2 -#define TTYPE_SECTION 3 -#define TTYPE_FUNC_DECL 4 -#define TTYPE_VAR_DECL 5 -#define TTYPE_FUNC_TYPE 6 -#define TTYPE_FUNC_NAME 7 -#define TTYPE_FUNC_ARG 8 -#define TTYPE_LINK 9 -#define TTYPE_SSECTION 10 -#define TTYPE_FILE 11 -#define TTYPE_EMPH 12 -#define TTYPE_CONFIG 13 -#define TTYPE_CMD 14 -#define TTYPE_INCLUDE 15 -#define TTYPE_SYMB 16 -#define TTYPE_SYMBOL 17 -#define TTYPE_DIAG 18 -#define TTYPE_LINK_ANCHOR 19 -#define TTYPE_LINK_TEXT 20 -#define TTYPE_REF_JOURNAL 21 -#define TTYPE_LIST 22 -#define TTYPE_NMAX 23 +#define INDENT 5 +#define HALFINDENT 3 -const int ttypes[TTYPE_NMAX] = { - TERMP_BOLD, /* TTYPE_PROG */ - TERMP_BOLD, /* TTYPE_CMD_FLAG */ - TERMP_UNDER, /* TTYPE_CMD_ARG */ - TERMP_BOLD, /* TTYPE_SECTION */ - TERMP_BOLD, /* TTYPE_FUNC_DECL */ - TERMP_UNDER, /* TTYPE_VAR_DECL */ - TERMP_UNDER, /* TTYPE_FUNC_TYPE */ - TERMP_BOLD, /* TTYPE_FUNC_NAME */ - TERMP_UNDER, /* TTYPE_FUNC_ARG */ - TERMP_UNDER, /* TTYPE_LINK */ - TERMP_BOLD, /* TTYPE_SSECTION */ - TERMP_UNDER, /* TTYPE_FILE */ - TERMP_UNDER, /* TTYPE_EMPH */ - TERMP_BOLD, /* TTYPE_CONFIG */ - TERMP_BOLD, /* TTYPE_CMD */ - TERMP_BOLD, /* TTYPE_INCLUDE */ - TERMP_BOLD, /* TTYPE_SYMB */ - TERMP_BOLD, /* TTYPE_SYMBOL */ - TERMP_BOLD, /* TTYPE_DIAG */ - TERMP_UNDER, /* TTYPE_LINK_ANCHOR */ - TERMP_BOLD, /* TTYPE_LINK_TEXT */ - TERMP_UNDER, /* TTYPE_REF_JOURNAL */ - TERMP_BOLD /* TTYPE_LIST */ -}; - struct termpair { struct termpair *ppair; int flag; @@ -97,7 +81,7 @@ struct termact { }; static void termp____post(DECL_ARGS); -static void termp__t_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_bl_post(DECL_ARGS); @@ -122,66 +106,54 @@ static void termp_sq_post(DECL_ARGS); static void termp_ss_post(DECL_ARGS); static void termp_vt_post(DECL_ARGS); -static int termp__j_pre(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_ar_pre(DECL_ARGS); static int termp_bd_pre(DECL_ARGS); static int termp_bf_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); -static int termp_cm_pre(DECL_ARGS); static int termp_d1_pre(DECL_ARGS); static int termp_dq_pre(DECL_ARGS); -static int termp_em_pre(DECL_ARGS); static int termp_ex_pre(DECL_ARGS); static int termp_fa_pre(DECL_ARGS); -static int termp_fd_pre(DECL_ARGS); static int termp_fl_pre(DECL_ARGS); static int termp_fn_pre(DECL_ARGS); static int termp_fo_pre(DECL_ARGS); static int termp_ft_pre(DECL_ARGS); -static int termp_ic_pre(DECL_ARGS); static int termp_in_pre(DECL_ARGS); static int termp_it_pre(DECL_ARGS); static int termp_lk_pre(DECL_ARGS); -static int termp_ms_pre(DECL_ARGS); -static int termp_mt_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_pa_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); static int termp_rv_pre(DECL_ARGS); static int termp_sh_pre(DECL_ARGS); static int termp_sm_pre(DECL_ARGS); +static int termp_sp_pre(DECL_ARGS); static int termp_sq_pre(DECL_ARGS); static int termp_ss_pre(DECL_ARGS); -static int termp_sx_pre(DECL_ARGS); -static int termp_sy_pre(DECL_ARGS); +static int termp_under_pre(DECL_ARGS); static int termp_ud_pre(DECL_ARGS); -static int termp_va_pre(DECL_ARGS); -static int termp_vt_pre(DECL_ARGS); static int termp_xr_pre(DECL_ARGS); static int termp_xx_pre(DECL_ARGS); -static const struct termact termacts[MDOC_MAX] = { +static const struct termact termacts[MDOC_MAX] = { { termp_ap_pre, NULL }, /* Ap */ { NULL, NULL }, /* Dd */ { NULL, NULL }, /* Dt */ { 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 */ @@ -190,42 +162,42 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* El */ { termp_it_pre, termp_it_post }, /* It */ { NULL, NULL }, /* Ad */ - { NULL, NULL }, /* An */ - { termp_ar_pre, NULL }, /* Ar */ + { termp_an_pre, termp_an_post }, /* An */ + { termp_under_pre, NULL }, /* Ar */ { termp_cd_pre, NULL }, /* Cd */ - { termp_cm_pre, NULL }, /* Cm */ + { termp_bold_pre, NULL }, /* Cm */ { NULL, NULL }, /* Dv */ { NULL, NULL }, /* Er */ { NULL, NULL }, /* Ev */ { termp_ex_pre, NULL }, /* Ex */ { termp_fa_pre, NULL }, /* Fa */ - { termp_fd_pre, termp_fd_post }, /* Fd */ + { termp_bold_pre, termp_fd_post }, /* Fd */ { termp_fl_pre, NULL }, /* Fl */ { termp_fn_pre, termp_fn_post }, /* Fn */ { termp_ft_pre, termp_ft_post }, /* Ft */ - { termp_ic_pre, NULL }, /* Ic */ + { termp_bold_pre, NULL }, /* Ic */ { termp_in_pre, termp_in_post }, /* In */ { NULL, NULL }, /* Li */ { termp_nd_pre, NULL }, /* Nd */ { termp_nm_pre, NULL }, /* Nm */ { termp_op_pre, termp_op_post }, /* Op */ { NULL, NULL }, /* Ot */ - { termp_pa_pre, NULL }, /* Pa */ + { termp_under_pre, NULL }, /* Pa */ { termp_rv_pre, NULL }, /* Rv */ { NULL, NULL }, /* St */ - { termp_va_pre, NULL }, /* Va */ - { termp_vt_pre, termp_vt_post }, /* Vt */ + { termp_under_pre, NULL }, /* Va */ + { termp_under_pre, termp_vt_post }, /* Vt */ { termp_xr_pre, NULL }, /* Xr */ { NULL, termp____post }, /* %A */ { NULL, termp____post }, /* %B */ { NULL, termp____post }, /* %D */ { NULL, termp____post }, /* %I */ - { termp__j_pre, termp____post }, /* %J */ + { termp_under_pre, termp____post }, /* %J */ { NULL, termp____post }, /* %N */ { NULL, termp____post }, /* %O */ { NULL, termp____post }, /* %P */ { NULL, termp____post }, /* %R */ - { termp__t_pre, termp__t_post }, /* %T */ + { termp_under_pre, termp____post }, /* %T */ { NULL, termp____post }, /* %V */ { NULL, NULL }, /* Ac */ { termp_aq_pre, termp_aq_post }, /* Ao */ @@ -243,10 +215,10 @@ static const struct termact termacts[MDOC_MAX] = { { termp_dq_pre, termp_dq_post }, /* Dq */ { NULL, NULL }, /* Ec */ { NULL, NULL }, /* Ef */ - { termp_em_pre, NULL }, /* Em */ + { termp_under_pre, NULL }, /* Em */ { NULL, NULL }, /* Eo */ { termp_xx_pre, NULL }, /* Fx */ - { termp_ms_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 */ @@ -265,8 +237,8 @@ static const struct termact termacts[MDOC_MAX] = { { termp_sq_pre, termp_sq_post }, /* So */ { termp_sq_pre, termp_sq_post }, /* Sq */ { termp_sm_pre, NULL }, /* Sm */ - { termp_sx_pre, NULL }, /* Sx */ - { termp_sy_pre, NULL }, /* Sy */ + { termp_under_pre, NULL }, /* Sx */ + { termp_bold_pre, NULL }, /* Sy */ { NULL, NULL }, /* Tn */ { termp_xx_pre, NULL }, /* Ux */ { NULL, NULL }, /* Xc */ @@ -282,19 +254,19 @@ static const struct termact termacts[MDOC_MAX] = { { 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_mt_pre, NULL }, /* Mt */ + { 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, NULL }, /* sp */ + { NULL, termp____post }, /* %Q */ + { termp_sp_pre, NULL }, /* br */ + { termp_sp_pre, NULL }, /* sp */ }; #ifdef __linux__ @@ -309,31 +281,28 @@ 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 int fmt_block_vspace(struct termp *, +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(struct termp *, - const struct mdoc_meta *); +static void print_head(DECL_ARGS); static void print_body(DECL_ARGS); -static void print_foot(struct termp *, - const struct mdoc_meta *); +static void print_foot(DECL_ARGS); -int -mdoc_run(struct termp *p, const struct mdoc *m) +void +mdoc_run(struct termp *p, const struct mdoc *mdoc) { - /* - * Main output function. When this is called, assume that the - * tree is properly formed. - */ - print_head(p, mdoc_meta(m)); - assert(mdoc_node(m)); - assert(MDOC_ROOT == mdoc_node(m)->type); - if (mdoc_node(m)->child) - print_body(p, NULL, mdoc_meta(m), mdoc_node(m)->child); - print_foot(p, mdoc_meta(m)); - return(1); + const struct mdoc_node *n; + const struct mdoc_meta *m; + + n = mdoc_node(mdoc); + m = mdoc_meta(mdoc); + + print_head(p, NULL, m, n); + if (n->child) + print_body(p, NULL, m, n->child); + print_foot(p, NULL, m, n); } @@ -342,55 +311,60 @@ print_body(DECL_ARGS) { print_node(p, pair, meta, node); - if ( ! node->next) - return; - print_body(p, pair, meta, node->next); + if (node->next) + print_body(p, pair, meta, node->next); } +/* ARGSUSED */ static void print_node(DECL_ARGS) { - int dochild; + int chld, bold, under; struct termpair npair; size_t offset, rmargin; - dochild = 1; + chld = 1; offset = p->offset; rmargin = p->rmargin; + bold = p->bold; + under = p->under; + bzero(&npair, sizeof(struct termpair)); npair.ppair = pair; - npair.flag = 0; - npair.count = 0; if (MDOC_TEXT != node->type) { if (termacts[node->tok].pre) - if ( ! (*termacts[node->tok].pre)(p, &npair, meta, node)) - dochild = 0; - } else /* MDOC_TEXT == node->type */ + chld = (*termacts[node->tok].pre) + (p, &npair, meta, node); + } else term_word(p, node->string); - /* Children. */ - - p->flags |= npair.flag; - - if (dochild && node->child) + if (chld && node->child) print_body(p, &npair, meta, node->child); - /* Post-processing. */ + /* + * 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. + */ + p->bold = bold; + p->under = under; + if (MDOC_TEXT != node->type) if (termacts[node->tok].post) - (*termacts[node->tok].post)(p, &npair, meta, node); + (*termacts[node->tok].post) + (p, &npair, meta, node); p->offset = offset; p->rmargin = rmargin; - p->flags &= ~npair.flag; } +/* ARGSUSED */ static void -print_foot(struct termp *p, const struct mdoc_meta *meta) +print_foot(DECL_ARGS) { struct tm *tm; char *buf, *os; @@ -404,14 +378,14 @@ print_foot(struct termp *p, const struct mdoc_meta *me */ if (NULL == (buf = malloc(p->rmargin))) - err(1, "malloc"); + err(EXIT_FAILURE, "malloc"); if (NULL == (os = malloc(p->rmargin))) - err(1, "malloc"); + err(EXIT_FAILURE, "malloc"); tm = localtime(&meta->date); if (0 == strftime(buf, p->rmargin, "%B %e, %Y", tm)) - err(1, "strftime"); + err(EXIT_FAILURE, "strftime"); (void)strlcpy(os, meta->os, p->rmargin); @@ -448,8 +422,10 @@ print_foot(struct termp *p, const struct mdoc_meta *me } +/* FIXME: put in utility library. */ +/* ARGSUSED */ static void -print_head(struct termp *p, const struct mdoc_meta *meta) +print_head(DECL_ARGS) { char *buf, *title; @@ -457,9 +433,9 @@ print_head(struct termp *p, const struct mdoc_meta *me p->offset = 0; if (NULL == (buf = malloc(p->rmargin))) - err(1, "malloc"); + err(EXIT_FAILURE, "malloc"); if (NULL == (title = malloc(p->rmargin))) - err(1, "malloc"); + err(EXIT_FAILURE, "malloc"); /* * The header is strange. It has three components, which are @@ -483,8 +459,7 @@ print_head(struct termp *p, const struct mdoc_meta *me (void)strlcat(buf, ")", p->rmargin); } - (void)snprintf(title, p->rmargin, "%s(%d)", - meta->title, meta->msec); + snprintf(title, p->rmargin, "%s(%d)", meta->title, meta->msec); p->offset = 0; p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2; @@ -517,6 +492,7 @@ print_head(struct termp *p, const struct mdoc_meta *me } +/* FIXME: put in utility file for front-ends. */ static size_t arg_width(const struct mdoc_argv *arg, int pos) { @@ -543,6 +519,7 @@ arg_width(const struct mdoc_argv *arg, int pos) } +/* FIXME: put in utility file for front-ends. */ static int arg_listtype(const struct mdoc_node *n) { @@ -584,6 +561,7 @@ arg_listtype(const struct mdoc_node *n) } +/* FIXME: put in utility file for front-ends. */ static size_t arg_offset(const struct mdoc_argv *arg) { @@ -652,7 +630,7 @@ arg_getattrs(const int *keys, int *vals, /* ARGSUSED */ -static int +static void fmt_block_vspace(struct termp *p, const struct mdoc_node *bl, const struct mdoc_node *node) @@ -661,23 +639,48 @@ fmt_block_vspace(struct termp *p, term_newln(p); - if (arg_hasattr(MDOC_Compact, bl)) - return(1); + if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Compact, bl)) + return; + assert(node); + /* + * Search through our prior nodes. If we follow a `Ss' or `Sh', + * then don't vspace. + */ + for (n = node; n; n = n->parent) { if (MDOC_BLOCK != n->type) continue; if (MDOC_Ss == n->tok) - break; + return; if (MDOC_Sh == n->tok) - break; + return; if (NULL == n->prev) continue; - term_vspace(p); break; } - return(1); + /* + * XXX - not documented: a `-column' does not ever assert vspace + * within the list. + */ + + if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Column, bl)) + if (node->prev && MDOC_It == node->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) + return; + } + + term_vspace(p); } @@ -717,8 +720,10 @@ termp_it_pre(DECL_ARGS) int i, type, keys[3], vals[3]; size_t width, offset; - if (MDOC_BLOCK == node->type) - return(fmt_block_vspace(p, node->parent->parent, node)); + if (MDOC_BLOCK == node->type) { + fmt_block_vspace(p, node->parent->parent, node); + return(1); + } bl = node->parent->parent->parent; @@ -747,11 +752,27 @@ termp_it_pre(DECL_ARGS) case (MDOC_Column): if (MDOC_BODY == node->type) break; - for (i = 0, n = node->prev; n; n = n->prev, i++) + /* + * 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). + */ + for (i = 0, n = node->prev; n && + i < (int)bl->args->argv[vals[2]].sz; + n = n->prev, i++) offset += arg_width (&bl->args->argv[vals[2]], i); - assert(i < (int)bl->args->argv[vals[2]].sz); - width = arg_width(&bl->args->argv[vals[2]], i); + + /* Whether exceeds maximum column. */ + if (i < (int)bl->args->argv[vals[2]].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]]); break; @@ -766,7 +787,7 @@ termp_it_pre(DECL_ARGS) /* * List-type can override the width in the case of fixed-head * values (bullet, dash/hyphen, enum). Tags need a non-zero - * offset. FIXME: double-check that correct. + * offset. */ switch (type) { @@ -786,6 +807,8 @@ termp_it_pre(DECL_ARGS) if (0 == width) width = 8; break; + case (MDOC_Column): + /* FALLTHROUGH */ case (MDOC_Tag): if (0 == width) width = 10; @@ -799,26 +822,27 @@ termp_it_pre(DECL_ARGS) * while diagonal bodies need two. */ + p->flags |= TERMP_NOSPACE; + switch (type) { + case (MDOC_Diag): + if (MDOC_BODY == node->type) + term_word(p, "\\ \\ "); + break; case (MDOC_Inset): if (MDOC_BODY == node->type) - p->flags &= ~TERMP_NOSPACE; - else - p->flags |= TERMP_NOSPACE; + term_word(p, "\\ "); break; default: - p->flags |= TERMP_NOSPACE; break; } - /* - * Style flags. Diagnostic heads need TTYPE_DIAG. - */ + p->flags |= TERMP_NOSPACE; switch (type) { case (MDOC_Diag): if (MDOC_HEAD == node->type) - p->flags |= ttypes[TTYPE_DIAG]; + p->bold++; break; default: break; @@ -851,12 +875,26 @@ termp_it_pre(DECL_ARGS) else p->flags |= TERMP_NOLPAD; - if (MDOC_HEAD == node->type) + if (MDOC_HEAD != node->type) + break; + + /* + * This is ugly. If `-hang' is specified and the body + * is a `Bl' or `Bd', then we want basically to nullify + * 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)) { + p->flags &= ~TERMP_NOBREAK; + p->flags &= ~TERMP_NOLPAD; + } else p->flags |= TERMP_HANG; break; case (MDOC_Tag): if (MDOC_HEAD == node->type) - p->flags |= TERMP_NOBREAK; + p->flags |= TERMP_NOBREAK | TERMP_TWOSPACE; else p->flags |= TERMP_NOLPAD; @@ -893,6 +931,17 @@ termp_it_pre(DECL_ARGS) p->offset += offset; switch (type) { + case (MDOC_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)) + break; + /* FALLTHROUGH */ case (MDOC_Bullet): /* FALLTHROUGH */ case (MDOC_Dash): @@ -901,16 +950,23 @@ termp_it_pre(DECL_ARGS) /* FALLTHROUGH */ case (MDOC_Hyphen): /* FALLTHROUGH */ - case (MDOC_Hang): - /* FALLTHROUGH */ case (MDOC_Tag): + assert(width); if (MDOC_HEAD == node->type) p->rmargin = p->offset + width; else p->offset += width; break; case (MDOC_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) + p->rmargin = p->maxrmargin; break; default: break; @@ -924,16 +980,16 @@ termp_it_pre(DECL_ARGS) if (MDOC_HEAD == node->type) switch (type) { case (MDOC_Bullet): - p->flags |= TERMP_BOLD; + p->bold++; term_word(p, "\\[bu]"); - p->flags &= ~TERMP_BOLD; + p->bold--; break; case (MDOC_Dash): /* FALLTHROUGH */ case (MDOC_Hyphen): - p->flags |= TERMP_BOLD; + p->bold++; term_word(p, "\\(hy"); - p->flags &= ~TERMP_BOLD; + p->bold--; break; case (MDOC_Enum): (pair->ppair->ppair->count)++; @@ -987,11 +1043,10 @@ termp_it_post(DECL_ARGS) assert(-1 != type); switch (type) { - case (MDOC_Diag): - term_word(p, "\\ "); - /* FALLTHROUGH */ case (MDOC_Item): /* FALLTHROUGH */ + case (MDOC_Diag): + /* FALLTHROUGH */ case (MDOC_Inset): if (MDOC_BODY == node->type) term_flushln(p); @@ -1016,13 +1071,9 @@ termp_nm_pre(DECL_ARGS) if (SEC_SYNOPSIS == node->sec) term_newln(p); - - pair->flag |= ttypes[TTYPE_PROG]; - p->flags |= ttypes[TTYPE_PROG]; - + p->bold++; if (NULL == node->child) term_word(p, meta->name); - return(1); } @@ -1032,8 +1083,7 @@ static int termp_fl_pre(DECL_ARGS) { - pair->flag |= ttypes[TTYPE_CMD_FLAG]; - p->flags |= ttypes[TTYPE_CMD_FLAG]; + p->bold++; term_word(p, "\\-"); p->flags |= TERMP_NOSPACE; return(1); @@ -1042,30 +1092,69 @@ termp_fl_pre(DECL_ARGS) /* ARGSUSED */ static int -termp_ar_pre(DECL_ARGS) +termp_an_pre(DECL_ARGS) { - pair->flag |= ttypes[TTYPE_CMD_ARG]; + if (NULL == node->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 (node->sec == SEC_AUTHORS) { + if ( ! (TERMP_ANPREC & p->flags)) { + if (TERMP_SPLIT & p->flags) + term_newln(p); + return(1); + } + if (TERMP_NOSPLIT & p->flags) + return(1); + term_newln(p); + return(1); + } + + if (TERMP_SPLIT & p->flags) + term_newln(p); + return(1); } /* ARGSUSED */ -static int -termp_ns_pre(DECL_ARGS) +static void +termp_an_post(DECL_ARGS) { - p->flags |= TERMP_NOSPACE; - return(1); + if (node->child) { + if (SEC_AUTHORS == node->sec) + p->flags |= TERMP_ANPREC; + return; + } + + if (arg_getattr(MDOC_Split, node) > -1) { + p->flags &= ~TERMP_NOSPLIT; + p->flags |= TERMP_SPLIT; + } else { + p->flags &= ~TERMP_SPLIT; + p->flags |= TERMP_NOSPLIT; + } + } /* ARGSUSED */ static int -termp_pp_pre(DECL_ARGS) +termp_ns_pre(DECL_ARGS) { - term_vspace(p); + p->flags |= TERMP_NOSPACE; return(1); } @@ -1075,6 +1164,8 @@ static int termp_rs_pre(DECL_ARGS) { + if (SEC_SEE_ALSO != node->sec) + return(1); if (MDOC_BLOCK == node->type && node->prev) term_vspace(p); return(1); @@ -1085,31 +1176,41 @@ termp_rs_pre(DECL_ARGS) static int termp_rv_pre(DECL_ARGS) { - int i; + const struct mdoc_node *nn; - i = arg_getattr(MDOC_Std, node); - assert(-1 != i); - assert(node->args->argv[i].sz); - term_newln(p); term_word(p, "The"); - p->flags |= ttypes[TTYPE_FUNC_NAME]; - term_word(p, *node->args->argv[i].value); - p->flags &= ~ttypes[TTYPE_FUNC_NAME]; - p->flags |= TERMP_NOSPACE; + nn = node->child; + assert(nn); + for ( ; nn; nn = nn->next) { + p->bold++; + term_word(p, nn->string); + p->bold--; + p->flags |= TERMP_NOSPACE; + if (nn->next && NULL == nn->next->next) + term_word(p, "(), and"); + else if (nn->next) + term_word(p, "(),"); + else + term_word(p, "()"); + } - term_word(p, "() function returns the value 0 if successful;"); - term_word(p, "otherwise the value -1 is returned and the"); - term_word(p, "global variable"); + if (node->child->next) + term_word(p, "functions return"); + else + term_word(p, "function returns"); - p->flags |= ttypes[TTYPE_VAR_DECL]; + term_word(p, "the value 0 if successful; otherwise the value " + "-1 is returned and the global variable"); + + p->under++; term_word(p, "errno"); - p->flags &= ~ttypes[TTYPE_VAR_DECL]; + p->under--; term_word(p, "is set to indicate the error."); - return(1); + return(0); } @@ -1117,19 +1218,33 @@ termp_rv_pre(DECL_ARGS) static int termp_ex_pre(DECL_ARGS) { - int i; + const struct mdoc_node *nn; - i = arg_getattr(MDOC_Std, node); - assert(-1 != i); - assert(node->args->argv[i].sz); - term_word(p, "The"); - p->flags |= ttypes[TTYPE_PROG]; - term_word(p, *node->args->argv[i].value); - p->flags &= ~ttypes[TTYPE_PROG]; - term_word(p, "utility exits 0 on success, and >0 if an error occurs."); - return(1); + nn = node->child; + assert(nn); + for ( ; nn; nn = nn->next) { + p->bold++; + term_word(p, nn->string); + p->bold--; + p->flags |= TERMP_NOSPACE; + if (nn->next && NULL == nn->next->next) + term_word(p, ", and"); + else if (nn->next) + term_word(p, ","); + else + p->flags &= ~TERMP_NOSPACE; + } + + if (node->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."); + + return(0); } @@ -1195,17 +1310,6 @@ termp_xr_pre(DECL_ARGS) /* ARGSUSED */ -static int -termp_vt_pre(DECL_ARGS) -{ - - /* FIXME: this can be "type name". */ - pair->flag |= ttypes[TTYPE_VAR_DECL]; - return(1); -} - - -/* ARGSUSED */ static void termp_vt_post(DECL_ARGS) { @@ -1221,10 +1325,10 @@ termp_vt_post(DECL_ARGS) /* ARGSUSED */ static int -termp_fd_pre(DECL_ARGS) +termp_bold_pre(DECL_ARGS) { - pair->flag |= ttypes[TTYPE_FUNC_DECL]; + p->bold++; return(1); } @@ -1247,12 +1351,20 @@ 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) { - case (MDOC_HEAD): + case (MDOC_BLOCK): + if (node->prev && MDOC_Sh == node->prev->tok) + if (NULL == node->prev->body->child) + break; term_vspace(p); - pair->flag |= ttypes[TTYPE_SECTION]; break; + case (MDOC_HEAD): + p->bold++; + break; case (MDOC_BODY): p->offset = INDENT; break; @@ -1305,7 +1417,7 @@ termp_bt_pre(DECL_ARGS) { term_word(p, "is currently in beta test."); - return(1); + return(0); } @@ -1314,7 +1426,8 @@ static void termp_lb_post(DECL_ARGS) { - term_newln(p); + if (SEC_LIBRARY == node->sec) + term_newln(p); } @@ -1385,7 +1498,7 @@ termp_ft_pre(DECL_ARGS) if (SEC_SYNOPSIS == node->sec) if (node->prev && MDOC_Fo == node->prev->tok) term_vspace(p); - pair->flag |= ttypes[TTYPE_FUNC_TYPE]; + p->under++; return(1); } @@ -1406,21 +1519,17 @@ termp_fn_pre(DECL_ARGS) { const struct mdoc_node *n; - assert(node->child && MDOC_TEXT == node->child->type); - - /* FIXME: can be "type funcname" "type varname"... */ - - p->flags |= ttypes[TTYPE_FUNC_NAME]; + p->bold++; term_word(p, node->child->string); - p->flags &= ~ttypes[TTYPE_FUNC_NAME]; + p->bold--; p->flags |= TERMP_NOSPACE; term_word(p, "("); for (n = node->child->next; n; n = n->next) { - p->flags |= ttypes[TTYPE_FUNC_ARG]; + p->under++; term_word(p, n->string); - p->flags &= ~ttypes[TTYPE_FUNC_ARG]; + p->under--; if (n->next) term_word(p, ","); } @@ -1446,29 +1555,19 @@ termp_fn_post(DECL_ARGS) /* ARGSUSED */ static int -termp_sx_pre(DECL_ARGS) -{ - - pair->flag |= ttypes[TTYPE_LINK]; - return(1); -} - - -/* ARGSUSED */ -static int termp_fa_pre(DECL_ARGS) { struct mdoc_node *n; if (node->parent->tok != MDOC_Fo) { - pair->flag |= ttypes[TTYPE_FUNC_ARG]; + p->under++; return(1); } for (n = node->child; n; n = n->next) { - p->flags |= ttypes[TTYPE_FUNC_ARG]; + p->under++; term_word(p, n->string); - p->flags &= ~ttypes[TTYPE_FUNC_ARG]; + p->under--; if (n->next) term_word(p, ","); } @@ -1482,19 +1581,9 @@ termp_fa_pre(DECL_ARGS) /* ARGSUSED */ static int -termp_va_pre(DECL_ARGS) -{ - - pair->flag |= ttypes[TTYPE_VAR_DECL]; - return(1); -} - - -/* ARGSUSED */ -static int termp_bd_pre(DECL_ARGS) { - int i, type, ln; + int i, type; /* * This is fairly tricky due primarily to crappy documentation. @@ -1507,17 +1596,15 @@ termp_bd_pre(DECL_ARGS) * line. Blank lines are allowed. */ - if (MDOC_BLOCK == node->type) - return(fmt_block_vspace(p, node, node)); - else if (MDOC_BODY != node->type) + if (MDOC_BLOCK == node->type) { + fmt_block_vspace(p, node, node); return(1); + } else if (MDOC_BODY != node->type) + return(1); - /* FIXME: display type should be mandated by parser. */ + assert(node->parent->args); - if (NULL == node->parent->args) - errx(1, "missing display type"); - - for (type = -1, i = 0; + for (type = -1, i = 0; -1 == type && i < (int)node->parent->args->argc; i++) { switch (node->parent->args->argv[i].arg) { case (MDOC_Ragged): @@ -1528,22 +1615,17 @@ termp_bd_pre(DECL_ARGS) /* FALLTHROUGH */ case (MDOC_Literal): type = node->parent->args->argv[i].arg; - i = (int)node->parent->args->argc; break; default: break; } } + + assert(type > -1); - if (NULL == node->parent->args) - errx(1, "missing display type"); - i = arg_getattr(MDOC_Offset, node->parent); - if (-1 != i) { - if (1 != node->parent->args->argv[i].sz) - errx(1, "expected single value"); + if (-1 != i) p->offset += arg_offset(&node->parent->args->argv[i]); - } switch (type) { case (MDOC_Literal): @@ -1554,22 +1636,11 @@ termp_bd_pre(DECL_ARGS) return(1); } - /* - * Tricky. Iterate through all children. If we're on a - * different parse line, append a newline and then the contents. - * Ew. - */ - - p->flags |= TERMP_LITERAL; - ln = node->child ? node->child->line : 0; - for (node = node->child; node; node = node->next) { - if (ln < node->line) { - term_flushln(p); - p->flags |= TERMP_NOSPACE; - } - ln = node->line; + p->flags |= TERMP_NOSPACE; print_node(p, pair, meta, node); + if (node->next) + term_flushln(p); } return(0); @@ -1583,10 +1654,8 @@ termp_bd_post(DECL_ARGS) if (MDOC_BODY != node->type) return; - - term_flushln(p); - p->flags &= ~TERMP_LITERAL; p->flags |= TERMP_NOSPACE; + term_flushln(p); } @@ -1719,7 +1788,7 @@ termp_ss_pre(DECL_ARGS) term_vspace(p); break; case (MDOC_HEAD): - pair->flag |= ttypes[TTYPE_SSECTION]; + p->bold++; p->offset = HALFINDENT; break; default: @@ -1742,30 +1811,10 @@ termp_ss_post(DECL_ARGS) /* ARGSUSED */ static int -termp_pa_pre(DECL_ARGS) -{ - - pair->flag |= ttypes[TTYPE_FILE]; - return(1); -} - - -/* ARGSUSED */ -static int -termp_em_pre(DECL_ARGS) -{ - - pair->flag |= ttypes[TTYPE_EMPH]; - return(1); -} - - -/* ARGSUSED */ -static int termp_cd_pre(DECL_ARGS) { - pair->flag |= ttypes[TTYPE_CONFIG]; + p->bold++; term_newln(p); return(1); } @@ -1773,32 +1822,10 @@ termp_cd_pre(DECL_ARGS) /* ARGSUSED */ static int -termp_cm_pre(DECL_ARGS) -{ - - pair->flag |= ttypes[TTYPE_CMD_FLAG]; - return(1); -} - - -/* ARGSUSED */ -static int -termp_ic_pre(DECL_ARGS) -{ - - pair->flag |= ttypes[TTYPE_CMD]; - return(1); -} - - -/* ARGSUSED */ -static int termp_in_pre(DECL_ARGS) { - pair->flag |= ttypes[TTYPE_INCLUDE]; - p->flags |= ttypes[TTYPE_INCLUDE]; - + p->bold++; if (SEC_SYNOPSIS == node->sec) term_word(p, "#include"); @@ -1813,8 +1840,10 @@ static void termp_in_post(DECL_ARGS) { + p->bold++; p->flags |= TERMP_NOSPACE; term_word(p, ">"); + p->bold--; if (SEC_SYNOPSIS != node->sec) return; @@ -1833,11 +1862,28 @@ termp_in_post(DECL_ARGS) /* ARGSUSED */ static int -termp_br_pre(DECL_ARGS) +termp_sp_pre(DECL_ARGS) { + int i, len; - term_newln(p); - return(1); + switch (node->tok) { + case (MDOC_sp): + len = node->child ? atoi(node->child->string) : 1; + break; + case (MDOC_br): + len = 0; + break; + default: + len = 1; + break; + } + + if (0 == len) + term_newln(p); + for (i = 0; i < len; i++) + term_vspace(p); + + return(0); } @@ -1929,12 +1975,12 @@ termp_fo_pre(DECL_ARGS) } else if (MDOC_HEAD != node->type) return(1); - p->flags |= ttypes[TTYPE_FUNC_NAME]; + p->bold++; for (n = node->child; n; n = n->next) { assert(MDOC_TEXT == n->type); term_word(p, n->string); } - p->flags &= ~ttypes[TTYPE_FUNC_NAME]; + p->bold--; return(0); } @@ -1968,18 +2014,18 @@ termp_bf_pre(DECL_ARGS) if (NULL == (n = node->head->child)) { if (arg_hasattr(MDOC_Emphasis, node)) - pair->flag |= ttypes[TTYPE_EMPH]; + p->under++; else if (arg_hasattr(MDOC_Symbolic, node)) - pair->flag |= ttypes[TTYPE_SYMB]; + p->bold++; return(1); } assert(MDOC_TEXT == n->type); if (0 == strcmp("Em", n->string)) - pair->flag |= ttypes[TTYPE_EMPH]; + p->under++; else if (0 == strcmp("Sy", n->string)) - pair->flag |= ttypes[TTYPE_SYMB]; + p->bold++; return(1); } @@ -1987,27 +2033,6 @@ termp_bf_pre(DECL_ARGS) /* ARGSUSED */ static int -termp_sy_pre(DECL_ARGS) -{ - - pair->flag |= ttypes[TTYPE_SYMB]; - return(1); -} - - -/* ARGSUSED */ -static int -termp_ms_pre(DECL_ARGS) -{ - - pair->flag |= ttypes[TTYPE_SYMBOL]; - return(1); -} - - - -/* ARGSUSED */ -static int termp_sm_pre(DECL_ARGS) { @@ -2035,39 +2060,7 @@ termp_ap_pre(DECL_ARGS) /* ARGSUSED */ -static int -termp__j_pre(DECL_ARGS) -{ - - pair->flag |= ttypes[TTYPE_REF_JOURNAL]; - return(1); -} - - -/* ARGSUSED */ -static int -termp__t_pre(DECL_ARGS) -{ - - term_word(p, "\""); - p->flags |= TERMP_NOSPACE; - return(1); -} - - -/* ARGSUSED */ static void -termp__t_post(DECL_ARGS) -{ - - p->flags |= TERMP_NOSPACE; - term_word(p, "\""); - termp____post(p, pair, meta, node); -} - - -/* ARGSUSED */ -static void termp____post(DECL_ARGS) { @@ -2086,32 +2079,31 @@ termp_lk_pre(DECL_ARGS) n = node->child; if (NULL == n->next) { - pair->flag |= ttypes[TTYPE_LINK_ANCHOR]; + p->under++; return(1); } - p->flags |= ttypes[TTYPE_LINK_ANCHOR]; + p->under++; term_word(p, n->string); p->flags |= TERMP_NOSPACE; term_word(p, ":"); - p->flags &= ~ttypes[TTYPE_LINK_ANCHOR]; + p->under--; - p->flags |= ttypes[TTYPE_LINK_TEXT]; + p->bold++; for (n = n->next; n; n = n->next) term_word(p, n->string); + p->bold--; - p->flags &= ~ttypes[TTYPE_LINK_TEXT]; return(0); } /* ARGSUSED */ static int -termp_mt_pre(DECL_ARGS) +termp_under_pre(DECL_ARGS) { - pair->flag |= ttypes[TTYPE_LINK_ANCHOR]; + p->under++; return(1); } -