=================================================================== RCS file: /cvs/mandoc/mdoc_term.c,v retrieving revision 1.68 retrieving revision 1.283 diff -u -p -r1.68 -r1.283 --- mandoc/mdoc_term.c 2009/08/20 13:22:48 1.68 +++ mandoc/mdoc_term.c 2014/10/13 22:00:47 1.283 @@ -1,6 +1,8 @@ -/* $Id: mdoc_term.c,v 1.68 2009/08/20 13:22:48 kristaps Exp $ */ +/* $Id: mdoc_term.c,v 1.283 2014/10/13 22:00:47 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze + * Copyright (c) 2013 Franco Fichtner * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -14,133 +16,83 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +#include "config.h" + #include #include #include -#include +#include #include #include #include +#include "mandoc.h" +#include "mandoc_aux.h" +#include "out.h" #include "term.h" #include "mdoc.h" +#include "main.h" -#define INDENT 5 -#define HALFINDENT 3 - -#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_REF_TITLE 22 -#define TTYPE_LIST 23 -#define TTYPE_NMAX 24 - -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_UNDER, /* TTYPE_REF_TITLE */ - TERMP_BOLD /* TTYPE_LIST */ -}; - 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 *meta, \ + 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 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__t_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 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_op_post(DECL_ARGS); +static void termp_nm_post(DECL_ARGS); static void termp_pf_post(DECL_ARGS); -static void termp_pq_post(DECL_ARGS); -static void termp_qq_post(DECL_ARGS); +static void termp_quote_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__j_pre(DECL_ARGS); +static int termp__a_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_bq_pre(DECL_ARGS); -static int termp_br_pre(DECL_ARGS); -static int termp_brq_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_bt_pre(DECL_ARGS); +static int termp_bx_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_es_pre(DECL_ARGS); static int termp_ex_pre(DECL_ARGS); static int termp_fa_pre(DECL_ARGS); static int termp_fd_pre(DECL_ARGS); @@ -148,266 +100,317 @@ 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_li_pre(DECL_ARGS); +static int termp_ll_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_quote_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_d1_pre, termp_d1_post }, /* D1 */ - { termp_d1_pre, termp_d1_post }, /* Dl */ + { termp_ss_pre, termp_ss_post }, /* Ss */ + { termp_sp_pre, NULL }, /* Pp */ + { termp_d1_pre, termp_bl_post }, /* D1 */ + { termp_d1_pre, termp_bl_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 */ - { termp_an_pre, termp_an_post }, /* An */ - { termp_ar_pre, NULL }, /* Ar */ + { termp_under_pre, NULL }, /* Ad */ + { termp_an_pre, NULL }, /* An */ + { termp_under_pre, NULL }, /* Ar */ { termp_cd_pre, NULL }, /* Cd */ - { termp_cm_pre, NULL }, /* Cm */ - { NULL, NULL }, /* Dv */ - { NULL, NULL }, /* Er */ - { NULL, NULL }, /* Ev */ + { 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_fa_pre, NULL }, /* Fa */ + { termp_fd_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_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_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 */ + { termp_nd_pre, NULL }, /* Nd */ + { termp_nm_pre, termp_nm_post }, /* Nm */ + { termp_quote_pre, termp_quote_post }, /* Op */ + { termp_ft_pre, NULL }, /* Ot */ + { 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 */ + { NULL, NULL }, /* St */ + { termp_under_pre, NULL }, /* Va */ + { termp_vt_pre, NULL }, /* Vt */ { termp_xr_pre, NULL }, /* Xr */ - { NULL, termp____post }, /* %A */ - { NULL, termp____post }, /* %B */ + { termp__a_pre, termp____post }, /* %A */ + { termp_under_pre, termp____post }, /* %B */ { NULL, termp____post }, /* %D */ - { NULL, termp____post }, /* %I */ - { termp__j_pre, termp____post }, /* %J */ + { termp_under_pre, termp____post }, /* %I */ + { 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____post }, /* %T */ + { termp__t_pre, termp__t_post }, /* %T */ { NULL, termp____post }, /* %V */ { NULL, NULL }, /* Ac */ - { termp_aq_pre, termp_aq_post }, /* Ao */ - { termp_aq_pre, termp_aq_post }, /* Aq */ + { termp_quote_pre, termp_quote_post }, /* Ao */ + { termp_quote_pre, termp_quote_post }, /* Aq */ { NULL, NULL }, /* At */ { NULL, NULL }, /* Bc */ - { termp_bf_pre, NULL }, /* Bf */ - { termp_bq_pre, termp_bq_post }, /* Bo */ - { termp_bq_pre, termp_bq_post }, /* Bq */ + { termp_bf_pre, NULL }, /* Bf */ + { termp_quote_pre, termp_quote_post }, /* Bo */ + { termp_quote_pre, termp_quote_post }, /* Bq */ { termp_xx_pre, NULL }, /* Bsx */ - { NULL, termp_bx_post }, /* Bx */ + { termp_bx_pre, NULL }, /* Bx */ { NULL, NULL }, /* Db */ { NULL, NULL }, /* Dc */ - { termp_dq_pre, termp_dq_post }, /* Do */ - { termp_dq_pre, termp_dq_post }, /* Dq */ - { NULL, NULL }, /* Ec */ + { termp_quote_pre, termp_quote_post }, /* Do */ + { termp_quote_pre, termp_quote_post }, /* Dq */ + { NULL, NULL }, /* Ec */ /* FIXME: no space */ { NULL, NULL }, /* Ef */ - { termp_em_pre, NULL }, /* Em */ - { NULL, NULL }, /* Eo */ + { termp_under_pre, NULL }, /* Em */ + { termp_quote_pre, termp_quote_post }, /* Eo */ { termp_xx_pre, NULL }, /* Fx */ - { termp_ms_pre, NULL }, /* Ms */ + { termp_bold_pre, NULL }, /* Ms */ { NULL, NULL }, /* No */ { termp_ns_pre, NULL }, /* Ns */ { termp_xx_pre, NULL }, /* Nx */ { termp_xx_pre, NULL }, /* Ox */ { NULL, NULL }, /* Pc */ - { termp_pf_pre, termp_pf_post }, /* Pf */ - { termp_pq_pre, termp_pq_post }, /* Po */ - { termp_pq_pre, termp_pq_post }, /* Pq */ + { NULL, termp_pf_post }, /* Pf */ + { termp_quote_pre, termp_quote_post }, /* Po */ + { termp_quote_pre, termp_quote_post }, /* Pq */ { NULL, NULL }, /* Qc */ - { termp_sq_pre, termp_sq_post }, /* Ql */ - { termp_qq_pre, termp_qq_post }, /* Qo */ - { termp_qq_pre, termp_qq_post }, /* Qq */ + { termp_quote_pre, termp_quote_post }, /* Ql */ + { termp_quote_pre, termp_quote_post }, /* Qo */ + { termp_quote_pre, termp_quote_post }, /* Qq */ { NULL, NULL }, /* Re */ { termp_rs_pre, NULL }, /* Rs */ { NULL, NULL }, /* Sc */ - { termp_sq_pre, termp_sq_post }, /* So */ - { termp_sq_pre, termp_sq_post }, /* Sq */ + { termp_quote_pre, termp_quote_post }, /* So */ + { termp_quote_pre, termp_quote_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 */ { NULL, NULL }, /* Xo */ - { termp_fo_pre, termp_fo_post }, /* Fo */ - { NULL, NULL }, /* Fc */ - { termp_op_pre, termp_op_post }, /* Oo */ + { termp_fo_pre, termp_fo_post }, /* Fo */ + { NULL, NULL }, /* Fc */ + { termp_quote_pre, termp_quote_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_under_pre, NULL }, /* Fr */ { termp_ud_pre, NULL }, /* Ud */ { NULL, termp_lb_post }, /* Lb */ - { termp_pp_pre, NULL }, /* Lp */ - { termp_lk_pre, NULL }, /* Lk */ - { termp_mt_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 */ - { termp_xx_pre, NULL }, /* Dx */ - { NULL, NULL }, /* %Q */ - { termp_br_pre, NULL }, /* br */ - { termp_sp_pre, NULL }, /* sp */ + { termp_sp_pre, NULL }, /* Lp */ + { termp_lk_pre, NULL }, /* Lk */ + { termp_under_pre, NULL }, /* Mt */ + { termp_quote_pre, termp_quote_post }, /* Brq */ + { termp_quote_pre, termp_quote_post }, /* Bro */ + { NULL, NULL }, /* Brc */ + { NULL, termp____post }, /* %C */ + { termp_es_pre, NULL }, /* Es */ + { termp_quote_pre, termp_quote_post }, /* En */ + { termp_xx_pre, NULL }, /* Dx */ + { NULL, termp____post }, /* %Q */ + { termp_sp_pre, NULL }, /* br */ + { termp_sp_pre, NULL }, /* sp */ + { NULL, termp____post }, /* %U */ + { NULL, NULL }, /* Ta */ + { termp_ll_pre, NULL }, /* ll */ }; -#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(struct termp *, - const struct mdoc_meta *); -static void print_body(DECL_ARGS); -static void print_foot(struct termp *, - const struct mdoc_meta *); +void +terminal_mdoc(void *arg, const struct mdoc *mdoc) +{ + const struct mdoc_meta *meta; + struct mdoc_node *n; + struct termp *p; + p = (struct termp *)arg; -int -mdoc_run(struct termp *p, const struct mdoc *m) -{ - /* - * 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); -} + p->overstep = 0; + p->rmargin = p->maxrmargin = p->defrmargin; + p->tabwidth = term_len(p, 5); + if (NULL == p->symtab) + p->symtab = mchars_alloc(); + n = mdoc_node(mdoc)->child; + meta = mdoc_meta(mdoc); + + if (p->synopsisonly) { + while (n != NULL) { + if (n->tok == MDOC_Sh && n->sec == SEC_SYNOPSIS) { + if (n->child->next->child != NULL) + print_mdoc_nodelist(p, NULL, + meta, n->child->next->child); + term_newln(p); + break; + } + n = n->next; + } + } else { + if (p->defindent == 0) + p->defindent = 5; + term_begin(p, print_mdoc_head, print_mdoc_foot, meta); + if (n != NULL) { + if (n->tok != MDOC_Sh) + term_vspace(p); + print_mdoc_nodelist(p, NULL, meta, n); + } + term_end(p); + } +} + static void -print_body(DECL_ARGS) +print_mdoc_nodelist(DECL_ARGS) { - print_node(p, pair, meta, node); - if ( ! node->next) - return; - print_body(p, pair, meta, node->next); + print_mdoc_node(p, pair, meta, n); + if (n->next) + print_mdoc_nodelist(p, pair, meta, n->next); } - static void -print_node(DECL_ARGS) +print_mdoc_node(DECL_ARGS) { - int dochild; + int chld; struct termpair npair; size_t offset, rmargin; - dochild = 1; + chld = 1; offset = p->offset; rmargin = p->rmargin; + n->prev_font = term_fontq(p); + memset(&npair, 0, sizeof(struct termpair)); npair.ppair = pair; - npair.flag = 0; - npair.count = 0; /* - * Note on termpair. This allows a pre function to set a termp - * flag that is automatically unset after the body, but before - * the post function. Thus, if a pre uses a termpair flag, it - * must be reapplied in the post for use. + * Keeps only work until the end of a line. If a keep was + * invoked in a prior line, revert it to PREKEEP. */ - 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 */ - term_word(p, node->string); + if (TERMP_KEEP & p->flags) { + if (n->prev ? (n->prev->lastline != n->line) : + (n->parent && n->parent->line != n->line)) { + p->flags &= ~TERMP_KEEP; + p->flags |= TERMP_PREKEEP; + } + } - /* Children. */ + /* + * After the keep flags have been set up, we may now + * produce output. Note that some pre-handlers do so. + */ - p->flags |= npair.flag; + switch (n->type) { + case MDOC_TEXT: + if (' ' == *n->string && MDOC_LINE & n->flags) + term_newln(p); + if (MDOC_DELIMC & n->flags) + p->flags |= TERMP_NOSPACE; + term_word(p, n->string); + if (MDOC_DELIMO & n->flags) + p->flags |= TERMP_NOSPACE; + break; + case MDOC_EQN: + term_eqn(p, n->eqn); + break; + case MDOC_TBL: + term_tbl(p, n->span); + break; + default: + if (termacts[n->tok].pre && ENDBODY_NOT == n->end) + chld = (*termacts[n->tok].pre) + (p, &npair, meta, n); + break; + } - if (dochild && node->child) - print_body(p, &npair, meta, node->child); + if (chld && n->child) + print_mdoc_nodelist(p, &npair, meta, n->child); - p->flags &= ~npair.flag; + term_fontpopq(p, + (ENDBODY_NOT == n->end ? n : n->pending)->prev_font); - /* Post-processing. */ + switch (n->type) { + case MDOC_TEXT: + break; + case MDOC_TBL: + break; + case MDOC_EQN: + break; + default: + if ( ! termacts[n->tok].post || MDOC_ENDED & n->flags) + break; + (void)(*termacts[n->tok].post)(p, &npair, meta, 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; - p->offset = offset; - p->rmargin = rmargin; -} + /* + * 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; + break; + } + if (MDOC_EOS & n->flags) + p->flags |= TERMP_SENTENCE; + if (MDOC_ll != n->tok) { + p->offset = offset; + p->rmargin = rmargin; + } +} + static void -print_foot(struct termp *p, const struct mdoc_meta *meta) +print_mdoc_foot(struct termp *p, const void *arg) { - struct tm *tm; - char *buf, *os; + const struct mdoc_meta *meta; - /* + meta = (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 * being the operating system: @@ -415,64 +418,47 @@ print_foot(struct termp *p, const struct mdoc_meta *me * SYSTEM DATE SYSTEM */ - if (NULL == (buf = malloc(p->rmargin))) - err(1, "malloc"); - if (NULL == (os = malloc(p->rmargin))) - err(1, "malloc"); - - tm = localtime(&meta->date); - - if (0 == strftime(buf, p->rmargin, "%B %e, %Y", tm)) - err(1, "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, meta->date) + term_len(p, 1)) / 2; + p->trailspace = 1; p->flags |= TERMP_NOSPACE | TERMP_NOBREAK; - term_word(p, os); + term_word(p, meta->os); term_flushln(p); p->offset = p->rmargin; - p->rmargin = p->maxrmargin - strlen(os); - p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + p->rmargin = p->maxrmargin - term_strlen(p, meta->os); + p->flags |= TERMP_NOSPACE; - term_word(p, buf); + term_word(p, meta->date); term_flushln(p); p->offset = p->rmargin; p->rmargin = p->maxrmargin; + p->trailspace = 0; p->flags &= ~TERMP_NOBREAK; - p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + p->flags |= TERMP_NOSPACE; - term_word(p, os); + term_word(p, meta->os); term_flushln(p); p->offset = 0; p->rmargin = p->maxrmargin; p->flags = 0; - - free(buf); - free(os); } - static void -print_head(struct termp *p, const struct mdoc_meta *meta) +print_mdoc_head(struct termp *p, const void *arg) { - char *buf, *title; + const struct mdoc_meta *meta; + char *volume, *title; + size_t vollen, titlen; - p->rmargin = p->maxrmargin; - p->offset = 0; + meta = (const struct mdoc_meta *)arg; - if (NULL == (buf = malloc(p->rmargin))) - err(1, "malloc"); - if (NULL == (title = malloc(p->rmargin))) - err(1, "malloc"); - /* * The header is strange. It has three components, which are * really two with the first duplicated. It goes like this: @@ -487,230 +473,150 @@ print_head(struct termp *p, const struct mdoc_meta *me */ assert(meta->vol); - (void)strlcpy(buf, meta->vol, p->rmargin); + if (NULL == meta->arch) + volume = mandoc_strdup(meta->vol); + else + mandoc_asprintf(&volume, "%s (%s)", + meta->vol, meta->arch); + vollen = term_strlen(p, volume); - if (meta->arch) { - (void)strlcat(buf, " (", p->rmargin); - (void)strlcat(buf, meta->arch, p->rmargin); - (void)strlcat(buf, ")", p->rmargin); - } + if (NULL == meta->msec) + title = mandoc_strdup(meta->title); + else + mandoc_asprintf(&title, "%s(%s)", + meta->title, meta->msec); + titlen = term_strlen(p, title); - (void)snprintf(title, p->rmargin, "%s(%d)", - meta->title, meta->msec); - - p->offset = 0; - p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2; p->flags |= TERMP_NOBREAK | TERMP_NOSPACE; + p->trailspace = 1; + p->offset = 0; + p->rmargin = 2 * (titlen+1) + vollen < p->maxrmargin ? + (p->maxrmargin - vollen + term_len(p, 1)) / 2 : + p->maxrmargin - vollen; term_word(p, title); term_flushln(p); + p->flags |= TERMP_NOSPACE; p->offset = p->rmargin; - p->rmargin = p->maxrmargin - strlen(title); - p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + p->rmargin = p->offset + vollen + titlen < p->maxrmargin ? + p->maxrmargin - titlen : p->maxrmargin; - term_word(p, buf); + term_word(p, volume); term_flushln(p); - p->offset = p->rmargin; - p->rmargin = p->maxrmargin; p->flags &= ~TERMP_NOBREAK; - p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + p->trailspace = 0; + if (p->rmargin + titlen <= p->maxrmargin) { + p->flags |= TERMP_NOSPACE; + p->offset = p->rmargin; + p->rmargin = p->maxrmargin; + term_word(p, title); + term_flushln(p); + } - term_word(p, title); - term_flushln(p); - + p->flags &= ~TERMP_NOSPACE; p->offset = 0; p->rmargin = p->maxrmargin; - p->flags &= ~TERMP_NOSPACE; - free(title); - free(buf); + free(volume); } - 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]); - p = arg->value[pos]; + assert(v); + if ( ! a2roffsu(v, &su, SCALE_VS)) + SCALE_VS_INIT(&su, atoi(v)); - 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)); } - -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)); + su.scale /= term_strlen(p, "0"); + } - 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)); } - 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, p->defindent + 1)); + else if (0 == strcmp(v, "indent-two")) + return(term_len(p, (p->defindent + 1) * 2)); + else if ( ! a2roffsu(v, &su, SCALE_MAX)) { + SCALE_HS_INIT(&su, term_strlen(p, v)); + su.scale /= term_strlen(p, "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)); - - return((size_t)len); + return(term_hspan(p, &su)); } - -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; - - 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); -} - - -/* 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, - const struct mdoc_node *bl, - const struct mdoc_node *node) +print_bvspace(struct termp *p, + const struct mdoc_node *bl, + const struct mdoc_node *n) { - const struct mdoc_node *n; + const struct mdoc_node *nn; + assert(n); + term_newln(p); - if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Compact, bl)) + if (MDOC_Bd == bl->tok && bl->norm->Bd.comp) return; - assert(node); + if (MDOC_Bl == bl->tok && bl->norm->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->norm->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->norm->Bl.type) + if (n->prev && MDOC_It == n->prev->tok) { + assert(n->prev->body); + if (NULL == n->prev->body->child) return; } @@ -718,140 +624,132 @@ fmt_block_vspace(struct termp *p, } -/* ARGSUSED */ static int -termp_dq_pre(DECL_ARGS) +termp_ll_pre(DECL_ARGS) { - if (MDOC_BODY != node->type) - return(1); - - term_word(p, "\\(lq"); - p->flags |= TERMP_NOSPACE; - return(1); + term_setwidth(p, n->nchild ? n->child->string : NULL); + return(0); } - -/* ARGSUSED */ -static void -termp_dq_post(DECL_ARGS) -{ - - if (MDOC_BODY != node->type) - return; - - p->flags |= TERMP_NOSPACE; - term_word(p, "\\(rq"); -} - - -/* ARGSUSED */ static int termp_it_pre(DECL_ARGS) { - const struct mdoc_node *bl, *n; - char buf[7]; - int i, type, keys[3], vals[3]; - size_t width, offset; + const struct mdoc_node *bl, *nn; + char buf[24]; + int i; + 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; + type = bl->norm->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; - - /* 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; - (void)arg_getattrs(keys, vals, 3, bl); + if (bl->norm->Bl.offs) + offset = a2offs(p, bl->norm->Bl.offs); - type = arg_listtype(bl); - assert(-1 != type); - - /* Calculate real width and offset. */ - switch (type) { - case (MDOC_Column): - if (MDOC_BODY == node->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, n = node->prev; n && n && - i < (int)bl->args[vals[2]].argv->sz; - n = n->prev, i++) - offset += arg_width - (&bl->args->argv[vals[2]], i); + ncols = bl->norm->Bl.ncols; + dcol = ncols < 5 ? term_len(p, 4) : + ncols == 5 ? term_len(p, 3) : term_len(p, 1); - /* 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; + /* + * Calculate the offset by applying all prior MDOC_BODY, + * so we stop at the MDOC_HEAD (NULL == nn->prev). + */ - if (vals[1] >= 0) - offset += arg_offset(&bl->args->argv[vals[1]]); + for (i = 0, nn = n->prev; + nn->prev && i < (int)ncols; + nn = nn->prev, i++) + offset += dcol + a2width(p, + bl->norm->Bl.cols[i]); + + /* + * 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(p, bl->norm->Bl.cols[i]) + dcol; 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]]); + if (NULL == bl->norm->Bl.width) + break; + + /* + * Note: buffer the width by 2, which is groff's magic + * number for buffering single arguments. See the above + * handling for column for how this changes. + */ + assert(bl->norm->Bl.width); + width = a2width(p, bl->norm->Bl.width) + term_len(p, 2); break; } - /* + /* * List-type can override the width in the case of fixed-head * values (bullet, dash/hyphen, enum). Tags need a non-zero * offset. */ 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: + /* FALLTHROUGH */ + case LIST_enum: + if (width < term_len(p, 2)) + width = term_len(p, 2); break; - case (MDOC_Enum): - if (width < 5) - width = 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; } - /* + /* * Whitespace control. Inset bodies need an initial space, * while diagonal bodies need two. */ @@ -859,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 && n->parent->head->nchild) term_word(p, "\\ "); break; default: @@ -873,47 +771,43 @@ termp_it_pre(DECL_ARGS) p->flags |= TERMP_NOSPACE; - /* - * Style flags. Diagnostic heads need TTYPE_DIAG. - */ - switch (type) { - case (MDOC_Diag): - if (MDOC_HEAD == node->type) - p->flags |= ttypes[TTYPE_DIAG]; + 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_enum: + /* + * Weird special case. + * Very narrow enum lists actually hang. + */ + if (width == term_len(p, 2)) + p->flags |= TERMP_HANG; /* FALLTHROUGH */ - case (MDOC_Dash): + case LIST_bullet: /* FALLTHROUGH */ - case (MDOC_Enum): + case LIST_dash: /* FALLTHROUGH */ - case (MDOC_Hyphen): - if (MDOC_HEAD == node->type) - p->flags |= TERMP_NOBREAK; - else - p->flags |= TERMP_NOLPAD; + case LIST_hyphen: + if (MDOC_HEAD != n->type) + break; + p->flags |= TERMP_NOBREAK; + p->trailspace = 1; break; - case (MDOC_Hang): - if (MDOC_HEAD == node->type) - p->flags |= TERMP_NOBREAK; - else - p->flags |= TERMP_NOLPAD; - - if (MDOC_HEAD != node->type) + case LIST_hang: + if (MDOC_HEAD != n->type) break; /* @@ -922,45 +816,49 @@ 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)) { - 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 | TERMP_TWOSPACE; - else - p->flags |= TERMP_NOLPAD; + if (NULL != n->next && + NULL != n->next->child && + (MDOC_Bl == n->next->child->tok || + MDOC_Bd == n->next->child->tok)) + break; - if (MDOC_HEAD != node->type) + p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG; + p->trailspace = 1; + break; + case LIST_tag: + if (MDOC_HEAD != n->type) break; - if (NULL == node->next || NULL == node->next->child) + + p->flags |= TERMP_NOBREAK | TERMP_BRIND; + p->trailspace = 2; + + 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; + p->trailspace = 0; + } else { + p->flags |= TERMP_NOBREAK; + p->trailspace = 1; } + break; - case (MDOC_Diag): - if (MDOC_HEAD == node->type) - p->flags |= TERMP_NOBREAK; + case LIST_diag: + if (MDOC_HEAD != n->type) + break; + p->flags |= TERMP_NOBREAK | TERMP_BRIND; + p->trailspace = 1; break; default: break; } - /* + /* * Margin control. Set-head-width lists have their right * margins shortened. The body for these lists has the offset * necessarily lengthened. Everybody gets the offset. @@ -969,95 +867,101 @@ 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 && + NULL != n->next && + NULL != 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 + else { p->offset += width; + if (p->rmargin < p->offset) + p->rmargin = p->offset; + } 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: break; } - /* + /* * The dash, hyphen, bullet and enum lists all have a special - * HEAD character (temporarily bold, in some cases). + * HEAD character (temporarily bold, in some cases). */ - if (MDOC_HEAD == node->type) + if (MDOC_HEAD == n->type) switch (type) { - case (MDOC_Bullet): - p->flags |= TERMP_BOLD; + case LIST_bullet: + term_fontpush(p, TERMFONT_BOLD); term_word(p, "\\[bu]"); - p->flags &= ~TERMP_BOLD; + term_fontpop(p); break; - case (MDOC_Dash): + case LIST_dash: /* FALLTHROUGH */ - case (MDOC_Hyphen): - p->flags |= TERMP_BOLD; + case LIST_hyphen: + term_fontpush(p, TERMFONT_BOLD); term_word(p, "\\(hy"); - p->flags &= ~TERMP_BOLD; + term_fontpop(p); break; - case (MDOC_Enum): + case LIST_enum: (pair->ppair->ppair->count)++; - (void)snprintf(buf, sizeof(buf), "%d.", - pair->ppair->ppair->count); + (void)snprintf(buf, sizeof(buf), "%d.", + pair->ppair->ppair->count); term_word(p, buf); break; default: break; } - /* + /* * If we're not going to process our children, indicate so here. */ 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: @@ -1067,254 +971,279 @@ termp_it_pre(DECL_ARGS) return(1); } - -/* ARGSUSED */ 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->norm->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_NOBREAK | TERMP_BRIND | + TERMP_DANGLE | TERMP_HANG); + p->trailspace = 0; } - -/* ARGSUSED */ static int termp_nm_pre(DECL_ARGS) { - if (SEC_SYNOPSIS == node->sec) - term_newln(p); + if (MDOC_BLOCK == n->type) { + p->flags |= TERMP_PREKEEP; + return(1); + } - pair->flag |= ttypes[TTYPE_PROG]; - p->flags |= ttypes[TTYPE_PROG]; + if (MDOC_BODY == n->type) { + if (NULL == n->child) + return(0); + p->flags |= TERMP_NOSPACE; + p->offset += term_len(p, 1) + + (NULL == n->prev->child ? + term_strlen(p, meta->name) : + MDOC_TEXT == n->prev->child->type ? + term_strlen(p, n->prev->child->string) : + term_len(p, 5)); + if (p->rmargin < p->offset) + p->rmargin = p->offset; + return(1); + } - if (NULL == node->child) - term_word(p, meta->name); + if (NULL == n->child && NULL == meta->name) + return(0); + if (MDOC_HEAD == n->type) + synopsis_pre(p, n->parent); + + if (MDOC_HEAD == n->type && + NULL != n->next && NULL != n->next->child) { + p->flags |= TERMP_NOSPACE | TERMP_NOBREAK | TERMP_BRIND; + p->trailspace = 1; + p->rmargin = p->offset + term_len(p, 1); + if (NULL == n->child) { + p->rmargin += term_strlen(p, meta->name); + } else if (MDOC_TEXT == n->child->type) { + p->rmargin += term_strlen(p, n->child->string); + if (n->child->next) + p->flags |= TERMP_HANG; + } else { + p->rmargin += term_len(p, 5); + p->flags |= TERMP_HANG; + } + } + + term_fontpush(p, TERMFONT_BOLD); + if (NULL == n->child) + term_word(p, meta->name); return(1); } +static void +termp_nm_post(DECL_ARGS) +{ -/* ARGSUSED */ + if (MDOC_BLOCK == n->type) { + p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP); + } else if (MDOC_HEAD == n->type && + NULL != n->next && NULL != n->next->child) { + term_flushln(p); + p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG); + p->trailspace = 0; + } else if (MDOC_BODY == n->type && n->child) + term_flushln(p); +} + static int termp_fl_pre(DECL_ARGS) { - pair->flag |= ttypes[TTYPE_CMD_FLAG]; - p->flags |= ttypes[TTYPE_CMD_FLAG]; + term_fontpush(p, TERMFONT_BOLD); term_word(p, "\\-"); - p->flags |= TERMP_NOSPACE; + + if ( ! (n->nchild == 0 && + (n->next == NULL || + n->next->type == MDOC_TEXT || + n->next->flags & MDOC_LINE))) + p->flags |= TERMP_NOSPACE; + return(1); } - -/* ARGSUSED */ static int -termp_an_pre(DECL_ARGS) +termp__a_pre(DECL_ARGS) { - if (NULL == node->child) - return(1); + if (n->prev && MDOC__A == n->prev->tok) + if (NULL == n->next || MDOC__A != n->next->tok) + term_word(p, "and"); - /* - * 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 void -termp_an_post(DECL_ARGS) +static int +termp_an_pre(DECL_ARGS) { - if (node->child) { - if (SEC_AUTHORS == node->sec) - p->flags |= TERMP_ANPREC; - return; - } - - if (arg_getattr(MDOC_Split, node) > -1) { + if (n->norm->An.auth == AUTH_split) { p->flags &= ~TERMP_NOSPLIT; p->flags |= TERMP_SPLIT; - } else { + return(0); + } + if (n->norm->An.auth == AUTH_nosplit) { p->flags &= ~TERMP_SPLIT; p->flags |= TERMP_NOSPLIT; + return(0); } -} + if (n->child == NULL) + return(0); + if (p->flags & TERMP_SPLIT) + term_newln(p); -/* ARGSUSED */ -static int -termp_ar_pre(DECL_ARGS) -{ + if (n->sec == SEC_AUTHORS && ! (p->flags & TERMP_NOSPLIT)) + p->flags |= TERMP_SPLIT; - pair->flag |= ttypes[TTYPE_CMD_ARG]; return(1); } - -/* ARGSUSED */ static int termp_ns_pre(DECL_ARGS) { - p->flags |= TERMP_NOSPACE; + if ( ! (MDOC_LINE & n->flags)) + p->flags |= TERMP_NOSPACE; return(1); } - -/* 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); } - -/* ARGSUSED */ static int termp_rv_pre(DECL_ARGS) { - const struct mdoc_node *nn; + int nchild; term_newln(p); - term_word(p, "The"); - nn = node->child; - assert(nn); - for ( ; nn; nn = nn->next) { - p->flags |= ttypes[TTYPE_FUNC_NAME]; - term_word(p, nn->string); - p->flags &= ~ttypes[TTYPE_FUNC_NAME]; - p->flags |= TERMP_NOSPACE; - if (nn->next && NULL == nn->next->next) - term_word(p, "(), and"); - else if (nn->next) - term_word(p, "(),"); - else + nchild = n->nchild; + if (nchild > 0) { + term_word(p, "The"); + + for (n = n->child; n; n = n->next) { + term_fontpush(p, TERMFONT_BOLD); + term_word(p, n->string); + term_fontpop(p); + + p->flags |= TERMP_NOSPACE; term_word(p, "()"); - } - if (node->child->next) - term_word(p, "functions return"); - else - term_word(p, "function returns"); + if (n->next == NULL) + continue; - term_word(p, "the value 0 if successful; otherwise the value " - "-1 is returned and the global variable"); + if (nchild > 2) { + p->flags |= TERMP_NOSPACE; + term_word(p, ","); + } + if (n->next->next == NULL) + term_word(p, "and"); + } - p->flags |= ttypes[TTYPE_VAR_DECL]; + if (nchild > 1) + term_word(p, "functions return"); + else + term_word(p, "function returns"); + + term_word(p, "the value\\~0 if successful;"); + } else + term_word(p, "Upon successful completion," + " the value\\~0 is returned;"); + + term_word(p, "otherwise the value\\~\\-1 is returned" + " and the global variable"); + + term_fontpush(p, TERMFONT_UNDER); term_word(p, "errno"); - p->flags &= ~ttypes[TTYPE_VAR_DECL]; + term_fontpop(p); - term_word(p, "is set to indicate the error."); + term_word(p, "is set to indicate the error."); + p->flags |= TERMP_SENTENCE; return(0); } - -/* ARGSUSED */ static int termp_ex_pre(DECL_ARGS) { - const struct mdoc_node *nn; + int nchild; + term_newln(p); term_word(p, "The"); - nn = node->child; - assert(nn); - for ( ; nn; nn = nn->next) { - p->flags |= ttypes[TTYPE_PROG]; - term_word(p, nn->string); - p->flags &= ~ttypes[TTYPE_PROG]; - p->flags |= TERMP_NOSPACE; - if (nn->next && NULL == nn->next->next) - term_word(p, ", and"); - else if (nn->next) + nchild = n->nchild; + for (n = n->child; n; n = n->next) { + term_fontpush(p, TERMFONT_BOLD); + term_word(p, n->string); + term_fontpop(p); + + if (nchild > 2 && n->next) { + p->flags |= TERMP_NOSPACE; term_word(p, ","); - else - p->flags &= ~TERMP_NOSPACE; + } + + if (n->next && NULL == n->next->next) + term_word(p, "and"); } - if (node->child->next) - term_word(p, "utilities exit"); + if (nchild > 1) + term_word(p, "utilities exit\\~0"); else - term_word(p, "utility exits"); + term_word(p, "utility exits\\~0"); - term_word(p, "0 on success, and >0 if an error occurs."); + term_word(p, "on success, and\\~>0 if an error occurs."); + p->flags |= TERMP_SENTENCE; return(0); } - -/* ARGSUSED */ static int termp_nd_pre(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return(1); #if defined(__OpenBSD__) || defined(__linux__) @@ -1325,120 +1254,163 @@ termp_nd_pre(DECL_ARGS) return(1); } - -/* ARGSUSED */ -static void -termp_bl_post(DECL_ARGS) +static int +termp_bl_pre(DECL_ARGS) { - if (MDOC_BLOCK == node->type) - term_newln(p); + return(MDOC_HEAD != n->type); } - -/* ARGSUSED */ static void -termp_op_post(DECL_ARGS) +termp_bl_post(DECL_ARGS) { - if (MDOC_BODY != node->type) - return; - p->flags |= TERMP_NOSPACE; - term_word(p, "\\(rB"); + if (MDOC_BLOCK == n->type) + term_newln(p); } - -/* ARGSUSED */ static int termp_xr_pre(DECL_ARGS) { - const struct mdoc_node *n; - assert(node->child && MDOC_TEXT == node->child->type); - n = node->child; + if (NULL == (n = n->child)) + return(0); + assert(MDOC_TEXT == n->type); term_word(p, n->string); - if (NULL == (n = n->next)) + + if (NULL == (n = n->next)) return(0); + p->flags |= TERMP_NOSPACE; term_word(p, "("); p->flags |= TERMP_NOSPACE; + + assert(MDOC_TEXT == n->type); term_word(p, n->string); + p->flags |= TERMP_NOSPACE; term_word(p, ")"); + return(0); } +/* + * 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 +synopsis_pre(struct termp *p, const struct mdoc_node *n) +{ + /* + * Obviously, if we're not in a SYNOPSIS or no prior macros + * exist, do nothing. + */ + if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags)) + return; -/* ARGSUSED */ + /* + * 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); + 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) { - /* FIXME: this can be "type name". */ - pair->flag |= ttypes[TTYPE_VAR_DECL]; - return(1); + if (MDOC_ELEM == n->type) { + synopsis_pre(p, n); + return(termp_under_pre(p, pair, meta, 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, meta, n)); } - -/* ARGSUSED */ -static void -termp_vt_post(DECL_ARGS) +static int +termp_bold_pre(DECL_ARGS) { - if (node->sec != SEC_SYNOPSIS) - return; - if (node->next && MDOC_Vt == node->next->tok) - term_newln(p); - else if (node->next) - term_vspace(p); + term_fontpush(p, TERMFONT_BOLD); + return(1); } - -/* ARGSUSED */ static int termp_fd_pre(DECL_ARGS) { - pair->flag |= ttypes[TTYPE_FUNC_DECL]; - return(1); + synopsis_pre(p, n); + return(termp_bold_pre(p, pair, meta, n)); } - -/* ARGSUSED */ static void termp_fd_post(DECL_ARGS) { - if (node->sec != SEC_SYNOPSIS) - return; - term_newln(p); - if (node->next && MDOC_Fd != node->next->tok) - term_vspace(p); } - -/* ARGSUSED */ 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_BLOCK): - if (node->prev && MDOC_Sh == node->prev->tok) - if (NULL == node->prev->body->child) + + /* No vspace between consecutive `Sh' calls. */ + + switch (n->type) { + case MDOC_BLOCK: + if (n->prev && MDOC_Sh == n->prev->tok) + if (NULL == n->prev->body->child) break; term_vspace(p); break; - case (MDOC_HEAD): - pair->flag |= ttypes[TTYPE_SECTION]; + case MDOC_HEAD: + term_fontpush(p, TERMFONT_BOLD); break; - case (MDOC_BODY): - p->offset = INDENT; + case MDOC_BODY: + p->offset = term_len(p, p->defindent); + if (SEC_AUTHORS == n->sec) + p->flags &= ~(TERMP_SPLIT|TERMP_NOSPLIT); break; default: break; @@ -1446,17 +1418,15 @@ termp_sh_pre(DECL_ARGS) return(1); } - -/* ARGSUSED */ static void termp_sh_post(DECL_ARGS) { - switch (node->type) { - case (MDOC_HEAD): + switch (n->type) { + case MDOC_HEAD: term_newln(p); break; - case (MDOC_BODY): + case MDOC_BODY: term_newln(p); p->offset = 0; break; @@ -1465,437 +1435,335 @@ termp_sh_post(DECL_ARGS) } } - -/* ARGSUSED */ static int -termp_op_pre(DECL_ARGS) -{ - - switch (node->type) { - case (MDOC_BODY): - term_word(p, "\\(lB"); - p->flags |= TERMP_NOSPACE; - break; - default: - break; - } - return(1); -} - - -/* ARGSUSED */ -static int termp_bt_pre(DECL_ARGS) { term_word(p, "is currently in beta test."); - return(1); + p->flags |= TERMP_SENTENCE; + return(0); } - -/* ARGSUSED */ static void termp_lb_post(DECL_ARGS) { - term_newln(p); + if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags) + term_newln(p); } - -/* ARGSUSED */ static int termp_ud_pre(DECL_ARGS) { term_word(p, "currently under development."); - return(1); + p->flags |= TERMP_SENTENCE; + return(0); } - -/* ARGSUSED */ 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, p->defindent + 1); return(1); } - -/* ARGSUSED */ -static void -termp_d1_post(DECL_ARGS) -{ - - if (MDOC_BLOCK != node->type) - return; - term_newln(p); -} - - -/* ARGSUSED */ static int -termp_aq_pre(DECL_ARGS) +termp_ft_pre(DECL_ARGS) { - if (MDOC_BODY != node->type) - return(1); - term_word(p, "\\(la"); - p->flags |= TERMP_NOSPACE; + /* NB: MDOC_LINE does not effect this! */ + synopsis_pre(p, n); + term_fontpush(p, TERMFONT_UNDER); return(1); } - -/* ARGSUSED */ -static void -termp_aq_post(DECL_ARGS) -{ - - if (MDOC_BODY != node->type) - return; - p->flags |= TERMP_NOSPACE; - term_word(p, "\\(ra"); -} - - -/* ARGSUSED */ static int -termp_ft_pre(DECL_ARGS) +termp_fn_pre(DECL_ARGS) { + size_t rmargin = 0; + int pretty; - if (SEC_SYNOPSIS == node->sec) - if (node->prev && MDOC_Fo == node->prev->tok) - term_vspace(p); - pair->flag |= ttypes[TTYPE_FUNC_TYPE]; - return(1); -} + pretty = MDOC_SYNPRETTY & n->flags; + synopsis_pre(p, n); -/* ARGSUSED */ -static void -termp_ft_post(DECL_ARGS) -{ + if (NULL == (n = n->child)) + return(0); - if (SEC_SYNOPSIS == node->sec) - term_newln(p); -} + if (pretty) { + rmargin = p->rmargin; + p->rmargin = p->offset + term_len(p, 4); + p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG; + } + assert(MDOC_TEXT == n->type); + term_fontpush(p, TERMFONT_BOLD); + term_word(p, n->string); + term_fontpop(p); -/* ARGSUSED */ -static int -termp_fn_pre(DECL_ARGS) -{ - const struct mdoc_node *n; + if (pretty) { + term_flushln(p); + p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG); + p->offset = p->rmargin; + p->rmargin = rmargin; + } - assert(node->child && MDOC_TEXT == node->child->type); - - /* FIXME: can be "type funcname" "type varname"... */ - - p->flags |= ttypes[TTYPE_FUNC_NAME]; - term_word(p, node->child->string); - p->flags &= ~ttypes[TTYPE_FUNC_NAME]; - p->flags |= TERMP_NOSPACE; term_word(p, "("); + p->flags |= TERMP_NOSPACE; - for (n = node->child->next; n; n = n->next) { - p->flags |= ttypes[TTYPE_FUNC_ARG]; + for (n = n->next; n; n = n->next) { + assert(MDOC_TEXT == n->type); + term_fontpush(p, TERMFONT_UNDER); + if (pretty) + p->flags |= TERMP_NBRWORD; term_word(p, n->string); - p->flags &= ~ttypes[TTYPE_FUNC_ARG]; - if (n->next) + term_fontpop(p); + + if (n->next) { + p->flags |= TERMP_NOSPACE; term_word(p, ","); + } } + p->flags |= TERMP_NOSPACE; term_word(p, ")"); - if (SEC_SYNOPSIS == node->sec) + if (pretty) { + p->flags |= TERMP_NOSPACE; term_word(p, ";"); + term_flushln(p); + } return(0); } - -/* ARGSUSED */ -static void -termp_fn_post(DECL_ARGS) -{ - - if (node->sec == SEC_SYNOPSIS && node->next) - term_vspace(p); -} - - -/* 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; + const struct mdoc_node *nn; - if (node->parent->tok != MDOC_Fo) { - pair->flag |= ttypes[TTYPE_FUNC_ARG]; + if (n->parent->tok != MDOC_Fo) { + term_fontpush(p, TERMFONT_UNDER); return(1); } - for (n = node->child; n; n = n->next) { - p->flags |= ttypes[TTYPE_FUNC_ARG]; - term_word(p, n->string); - p->flags &= ~ttypes[TTYPE_FUNC_ARG]; - if (n->next) + for (nn = n->child; nn; nn = nn->next) { + term_fontpush(p, TERMFONT_UNDER); + p->flags |= TERMP_NBRWORD; + term_word(p, nn->string); + term_fontpop(p); + + if (nn->next || (n->next && n->next->tok == MDOC_Fa)) { + p->flags |= TERMP_NOSPACE; term_word(p, ","); + } } - if (node->child && node->next && node->next->tok == MDOC_Fa) - term_word(p, ","); - return(0); } - -/* ARGSUSED */ static int -termp_va_pre(DECL_ARGS) +termp_bd_pre(DECL_ARGS) { + size_t tabwidth, lm, len, rm, rmax; + struct mdoc_node *nn; - pair->flag |= ttypes[TTYPE_VAR_DECL]; - return(1); -} + if (MDOC_BLOCK == n->type) { + print_bvspace(p, n, n); + return(1); + } else if (MDOC_HEAD == n->type) + return(0); + if (n->norm->Bd.offs) + p->offset += a2offs(p, n->norm->Bd.offs); -/* ARGSUSED */ -static int -termp_bd_pre(DECL_ARGS) -{ - int i, type; - /* - * 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. + * 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. */ - if (MDOC_BLOCK == node->type) { - fmt_block_vspace(p, node, node); + if (DISP_literal != n->norm->Bd.type && + DISP_unfilled != n->norm->Bd.type && + DISP_centered != n->norm->Bd.type) return(1); - } else if (MDOC_BODY != node->type) - return(1); - assert(node->parent->args); + tabwidth = p->tabwidth; + if (DISP_literal == n->norm->Bd.type) + p->tabwidth = term_len(p, 8); - for (type = -1, i = 0; -1 == type && - i < (int)node->parent->args->argc; i++) { - switch (node->parent->args->argv[i].arg) { - case (MDOC_Ragged): + lm = p->offset; + rm = p->rmargin; + rmax = p->maxrmargin; + p->rmargin = p->maxrmargin = TERM_MAXMARGIN; + + for (nn = n->child; nn; nn = nn->next) { + if (DISP_centered == n->norm->Bd.type) { + if (MDOC_TEXT == nn->type) { + len = term_strlen(p, nn->string); + p->offset = len >= rm ? 0 : + lm + len >= rm ? rm - len : + (lm + rm - len) / 2; + } else + p->offset = lm; + } + print_mdoc_node(p, pair, meta, nn); + /* + * If the printed node flushes its own line, then we + * needn't do it here as well. This is hacky, but the + * notion of selective eoln whitespace is pretty dumb + * anyway, so don't sweat it. + */ + switch (nn->tok) { + case MDOC_Sm: /* FALLTHROUGH */ - case (MDOC_Filled): + case MDOC_br: /* FALLTHROUGH */ - case (MDOC_Unfilled): + case MDOC_sp: /* FALLTHROUGH */ - case (MDOC_Literal): - type = node->parent->args->argv[i].arg; - break; + case MDOC_Bl: + /* FALLTHROUGH */ + case MDOC_D1: + /* FALLTHROUGH */ + case MDOC_Dl: + /* FALLTHROUGH */ + case MDOC_Lp: + /* FALLTHROUGH */ + case MDOC_Pp: + continue; default: break; } - } - - 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: - return(1); - } - - for (node = node->child; node; node = node->next) { + if (nn->next && nn->next->line == nn->line) + continue; + term_flushln(p); p->flags |= TERMP_NOSPACE; - print_node(p, pair, meta, node); - if (node->next) - term_flushln(p); } + p->tabwidth = tabwidth; + p->rmargin = rm; + p->maxrmargin = rmax; return(0); } - -/* ARGSUSED */ static void termp_bd_post(DECL_ARGS) { + size_t rm, rmax; - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type) return; - p->flags |= TERMP_NOSPACE; - term_flushln(p); -} + rm = p->rmargin; + rmax = p->maxrmargin; -/* ARGSUSED */ -static int -termp_qq_pre(DECL_ARGS) -{ + if (DISP_literal == n->norm->Bd.type || + DISP_unfilled == n->norm->Bd.type) + p->rmargin = p->maxrmargin = TERM_MAXMARGIN; - if (MDOC_BODY != node->type) - return(1); - term_word(p, "\""); p->flags |= TERMP_NOSPACE; - return(1); -} + term_newln(p); - -/* ARGSUSED */ -static void -termp_qq_post(DECL_ARGS) -{ - - if (MDOC_BODY != node->type) - return; - p->flags |= TERMP_NOSPACE; - term_word(p, "\""); + p->rmargin = rm; + p->maxrmargin = rmax; } - -/* ARGSUSED */ -static void -termp_bx_post(DECL_ARGS) +static int +termp_bx_pre(DECL_ARGS) { - if (node->child) + if (NULL != (n = n->child)) { + term_word(p, n->string); p->flags |= TERMP_NOSPACE; - term_word(p, "BSD"); -} + term_word(p, "BSD"); + } else { + term_word(p, "BSD"); + return(0); + } + if (NULL != (n = n->next)) { + p->flags |= TERMP_NOSPACE; + term_word(p, "-"); + p->flags |= TERMP_NOSPACE; + term_word(p, n->string); + } -/* ARGSUSED */ + return(0); +} + static int termp_xx_pre(DECL_ARGS) { const char *pp; + int flags; pp = NULL; - switch (node->tok) { - case (MDOC_Bsx): - pp = "BSDI BSD/OS"; + switch (n->tok) { + case MDOC_Bsx: + pp = "BSD/OS"; break; - case (MDOC_Dx): - pp = "DragonFlyBSD"; + case MDOC_Dx: + pp = "DragonFly"; break; - case (MDOC_Fx): + case MDOC_Fx: pp = "FreeBSD"; break; - case (MDOC_Nx): + case MDOC_Nx: pp = "NetBSD"; break; - case (MDOC_Ox): + case MDOC_Ox: pp = "OpenBSD"; break; - case (MDOC_Ux): + case MDOC_Ux: pp = "UNIX"; break; default: - break; + abort(); + /* NOTREACHED */ } - assert(pp); term_word(p, pp); - return(1); + if (n->child) { + flags = p->flags; + p->flags |= TERMP_KEEP; + term_word(p, n->child->string); + p->flags = flags; + } + return(0); } - -/* ARGSUSED */ -static int -termp_sq_pre(DECL_ARGS) -{ - - if (MDOC_BODY != node->type) - return(1); - term_word(p, "\\(oq"); - p->flags |= TERMP_NOSPACE; - return(1); -} - - -/* ARGSUSED */ static void -termp_sq_post(DECL_ARGS) -{ - - if (MDOC_BODY != node->type) - return; - p->flags |= TERMP_NOSPACE; - term_word(p, "\\(aq"); -} - - -/* ARGSUSED */ -static int -termp_pa_pre(DECL_ARGS) -{ - - pair->flag |= ttypes[TTYPE_FILE]; - return(1); -} - - -/* ARGSUSED */ -static int -termp_pf_pre(DECL_ARGS) -{ - - p->flags |= TERMP_IGNDELIM; - return(1); -} - - -/* ARGSUSED */ -static void termp_pf_post(DECL_ARGS) { - p->flags &= ~TERMP_IGNDELIM; p->flags |= TERMP_NOSPACE; } - -/* ARGSUSED */ static int termp_ss_pre(DECL_ARGS) { - switch (node->type) { - case (MDOC_BLOCK): + switch (n->type) { + case MDOC_BLOCK: term_newln(p); - if (node->prev) + if (n->prev) term_vspace(p); break; - case (MDOC_HEAD): - pair->flag |= ttypes[TTYPE_SSECTION]; - p->offset = HALFINDENT; + case MDOC_HEAD: + term_fontpush(p, TERMFONT_BOLD); + p->offset = term_len(p, (p->defindent+1)/2); break; + case MDOC_BODY: + p->offset = term_len(p, p->defindent); + break; default: break; } @@ -1903,111 +1771,73 @@ termp_ss_pre(DECL_ARGS) return(1); } - -/* ARGSUSED */ static void termp_ss_post(DECL_ARGS) { - if (MDOC_HEAD == node->type) + if (n->type == MDOC_HEAD || n->type == MDOC_BODY) term_newln(p); } - -/* 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]; - term_newln(p); + synopsis_pre(p, n); + term_fontpush(p, TERMFONT_BOLD); return(1); } - -/* 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]; + synopsis_pre(p, n); - if (SEC_SYNOPSIS == node->sec) + 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); } - -/* ARGSUSED */ static void termp_in_post(DECL_ARGS) { - p->flags |= TERMP_NOSPACE | ttypes[TTYPE_INCLUDE]; + if (MDOC_SYNPRETTY & n->flags) + term_fontpush(p, TERMFONT_BOLD); + + p->flags |= TERMP_NOSPACE; term_word(p, ">"); - p->flags &= ~ttypes[TTYPE_INCLUDE]; - 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); } - -/* ARGSUSED */ 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++) @@ -2016,276 +1846,381 @@ termp_sp_pre(DECL_ARGS) return(0); } - -/* ARGSUSED */ static int -termp_br_pre(DECL_ARGS) +termp_es_pre(DECL_ARGS) { - term_newln(p); - return(1); + return(0); } - -/* ARGSUSED */ static int -termp_brq_pre(DECL_ARGS) +termp_quote_pre(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type && MDOC_ELEM != n->type) return(1); - term_word(p, "\\(lC"); - p->flags |= TERMP_NOSPACE; - return(1); -} + switch (n->tok) { + case MDOC_Ao: + /* FALLTHROUGH */ + case MDOC_Aq: + term_word(p, "<"); + break; + case MDOC_Bro: + /* FALLTHROUGH */ + case MDOC_Brq: + term_word(p, "{"); + break; + case MDOC_Oo: + /* FALLTHROUGH */ + case MDOC_Op: + /* FALLTHROUGH */ + case MDOC_Bo: + /* FALLTHROUGH */ + case MDOC_Bq: + term_word(p, "["); + break; + case MDOC_Do: + /* FALLTHROUGH */ + case MDOC_Dq: + term_word(p, "\\(lq"); + break; + case MDOC_En: + if (NULL == n->norm->Es || + NULL == n->norm->Es->child) + return(1); + term_word(p, n->norm->Es->child->string); + break; + case MDOC_Eo: + break; + case MDOC_Po: + /* FALLTHROUGH */ + case MDOC_Pq: + term_word(p, "("); + break; + case MDOC__T: + /* FALLTHROUGH */ + case MDOC_Qo: + /* FALLTHROUGH */ + case MDOC_Qq: + term_word(p, "\""); + break; + case MDOC_Ql: + /* FALLTHROUGH */ + case MDOC_So: + /* FALLTHROUGH */ + case MDOC_Sq: + term_word(p, "\\(oq"); + break; + default: + abort(); + /* NOTREACHED */ + } -/* ARGSUSED */ -static void -termp_brq_post(DECL_ARGS) -{ - - if (MDOC_BODY != node->type) - return; p->flags |= TERMP_NOSPACE; - term_word(p, "\\(rC"); -} - - -/* ARGSUSED */ -static int -termp_bq_pre(DECL_ARGS) -{ - - if (MDOC_BODY != node->type) - return(1); - term_word(p, "\\(lB"); - p->flags |= TERMP_NOSPACE; return(1); } - -/* ARGSUSED */ static void -termp_bq_post(DECL_ARGS) +termp_quote_post(DECL_ARGS) { - if (MDOC_BODY != node->type) + if (MDOC_BODY != n->type && MDOC_ELEM != n->type) return; - p->flags |= TERMP_NOSPACE; - term_word(p, "\\(rB"); -} + if (MDOC_En != n->tok) + p->flags |= TERMP_NOSPACE; -/* ARGSUSED */ -static int -termp_pq_pre(DECL_ARGS) -{ - - if (MDOC_BODY != node->type) - return(1); - term_word(p, "\\&("); - p->flags |= TERMP_NOSPACE; - return(1); + switch (n->tok) { + case MDOC_Ao: + /* FALLTHROUGH */ + case MDOC_Aq: + term_word(p, ">"); + break; + case MDOC_Bro: + /* FALLTHROUGH */ + case MDOC_Brq: + term_word(p, "}"); + break; + case MDOC_Oo: + /* FALLTHROUGH */ + case MDOC_Op: + /* FALLTHROUGH */ + case MDOC_Bo: + /* FALLTHROUGH */ + case MDOC_Bq: + term_word(p, "]"); + break; + case MDOC_Do: + /* FALLTHROUGH */ + case MDOC_Dq: + term_word(p, "\\(rq"); + break; + case MDOC_En: + if (NULL != n->norm->Es && + NULL != n->norm->Es->child && + NULL != n->norm->Es->child->next) { + p->flags |= TERMP_NOSPACE; + term_word(p, n->norm->Es->child->next->string); + } + break; + case MDOC_Eo: + break; + case MDOC_Po: + /* FALLTHROUGH */ + case MDOC_Pq: + term_word(p, ")"); + break; + case MDOC__T: + /* FALLTHROUGH */ + case MDOC_Qo: + /* FALLTHROUGH */ + case MDOC_Qq: + term_word(p, "\""); + break; + case MDOC_Ql: + /* FALLTHROUGH */ + case MDOC_So: + /* FALLTHROUGH */ + case MDOC_Sq: + term_word(p, "\\(cq"); + break; + default: + abort(); + /* NOTREACHED */ + } } - -/* ARGSUSED */ -static void -termp_pq_post(DECL_ARGS) -{ - - if (MDOC_BODY != node->type) - return; - term_word(p, ")"); -} - - -/* ARGSUSED */ static int termp_fo_pre(DECL_ARGS) { - const struct mdoc_node *n; + size_t rmargin = 0; + int pretty; - if (MDOC_BODY == node->type) { + pretty = MDOC_SYNPRETTY & n->flags; + + if (MDOC_BLOCK == n->type) { + synopsis_pre(p, n); + return(1); + } else if (MDOC_BODY == n->type) { + if (pretty) { + rmargin = p->rmargin; + p->rmargin = p->offset + term_len(p, 4); + p->flags |= TERMP_NOBREAK | TERMP_BRIND | + TERMP_HANG; + } p->flags |= TERMP_NOSPACE; term_word(p, "("); p->flags |= TERMP_NOSPACE; + if (pretty) { + term_flushln(p); + p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | + TERMP_HANG); + p->offset = p->rmargin; + p->rmargin = rmargin; + } return(1); - } else if (MDOC_HEAD != node->type) - return(1); - - p->flags |= ttypes[TTYPE_FUNC_NAME]; - for (n = node->child; n; n = n->next) { - assert(MDOC_TEXT == n->type); - term_word(p, n->string); } - p->flags &= ~ttypes[TTYPE_FUNC_NAME]; + if (NULL == n->child) + return(0); + + /* XXX: we drop non-initial arguments as per groff. */ + + assert(n->child->string); + term_fontpush(p, TERMFONT_BOLD); + term_word(p, n->child->string); return(0); } - -/* ARGSUSED */ 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, ";"); + term_flushln(p); + } } - -/* ARGSUSED */ 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_BODY != n->type) return(1); - if (NULL == (n = node->head->child)) { - if (arg_hasattr(MDOC_Emphasis, node)) - pair->flag |= ttypes[TTYPE_EMPH]; - else if (arg_hasattr(MDOC_Symbolic, node)) - pair->flag |= ttypes[TTYPE_SYMB]; + if (FONT_Em == n->norm->Bf.font) + term_fontpush(p, TERMFONT_UNDER); + else if (FONT_Sy == n->norm->Bf.font) + term_fontpush(p, TERMFONT_BOLD); + else + term_fontpush(p, TERMFONT_NONE); - return(1); - } - - assert(MDOC_TEXT == n->type); - if (0 == strcmp("Em", n->string)) - pair->flag |= ttypes[TTYPE_EMPH]; - else if (0 == strcmp("Sy", n->string)) - pair->flag |= ttypes[TTYPE_SYMB]; - return(1); } - -/* ARGSUSED */ static int -termp_sy_pre(DECL_ARGS) +termp_sm_pre(DECL_ARGS) { - pair->flag |= ttypes[TTYPE_SYMB]; - return(1); -} + if (NULL == n->child) + p->flags ^= TERMP_NONOSPACE; + else if (0 == strcmp("on", n->child->string)) + p->flags &= ~TERMP_NONOSPACE; + else + p->flags |= TERMP_NONOSPACE; + if (p->col && ! (TERMP_NONOSPACE & p->flags)) + p->flags &= ~TERMP_NOSPACE; -/* ARGSUSED */ + return(0); +} + static int -termp_ms_pre(DECL_ARGS) +termp_ap_pre(DECL_ARGS) { - pair->flag |= ttypes[TTYPE_SYMBOL]; + p->flags |= TERMP_NOSPACE; + term_word(p, "'"); + p->flags |= TERMP_NOSPACE; return(1); } +static void +termp____post(DECL_ARGS) +{ + /* + * Handle lists of authors. In general, print each followed by + * a comma. Don't print the comma if there are only two + * authors. + */ + if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok) + if (NULL == n->next->next || MDOC__A != n->next->next->tok) + if (NULL == n->prev || MDOC__A != n->prev->tok) + return; -/* ARGSUSED */ -static int -termp_sm_pre(DECL_ARGS) -{ + /* TODO: %U. */ - assert(node->child && MDOC_TEXT == node->child->type); - if (0 == strcmp("on", node->child->string)) { - p->flags &= ~TERMP_NONOSPACE; - p->flags &= ~TERMP_NOSPACE; - } else - p->flags |= TERMP_NONOSPACE; + if (NULL == n->parent || MDOC_Rs != n->parent->tok) + return; - return(0); + p->flags |= TERMP_NOSPACE; + if (NULL == n->next) { + term_word(p, "."); + p->flags |= TERMP_SENTENCE; + } else + term_word(p, ","); } - -/* ARGSUSED */ static int -termp_ap_pre(DECL_ARGS) +termp_li_pre(DECL_ARGS) { - p->flags |= TERMP_NOSPACE; - term_word(p, "\\(aq"); - p->flags |= TERMP_NOSPACE; + term_fontpush(p, TERMFONT_NONE); return(1); } - -/* ARGSUSED */ static int -termp__j_pre(DECL_ARGS) +termp_lk_pre(DECL_ARGS) { + const struct mdoc_node *link, *descr; - pair->flag |= ttypes[TTYPE_REF_JOURNAL]; - return(1); -} + if (NULL == (link = n->child)) + return(0); + if (NULL != (descr = link->next)) { + term_fontpush(p, TERMFONT_UNDER); + while (NULL != descr) { + term_word(p, descr->string); + descr = descr->next; + } + p->flags |= TERMP_NOSPACE; + term_word(p, ":"); + term_fontpop(p); + } -/* ARGSUSED */ + term_fontpush(p, TERMFONT_BOLD); + term_word(p, link->string); + term_fontpop(p); + + return(0); +} + static int -termp__t_pre(DECL_ARGS) +termp_bk_pre(DECL_ARGS) { - pair->flag |= ttypes[TTYPE_REF_TITLE]; + switch (n->type) { + case MDOC_BLOCK: + break; + case MDOC_HEAD: + return(0); + case MDOC_BODY: + if (n->parent->args || 0 == n->prev->nchild) + p->flags |= TERMP_PREKEEP; + break; + default: + abort(); + /* NOTREACHED */ + } + return(1); } - -/* ARGSUSED */ static void -termp____post(DECL_ARGS) +termp_bk_post(DECL_ARGS) { - p->flags |= TERMP_NOSPACE; - term_word(p, node->next ? "," : "."); + if (MDOC_BODY == n->type) + p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP); } - -/* ARGSUSED */ -static int -termp_lk_pre(DECL_ARGS) +static void +termp__t_post(DECL_ARGS) { - const struct mdoc_node *n; - assert(node->child); - n = node->child; + /* + * If we're in an `Rs' and there's a journal present, then quote + * us instead of underlining us (for disambiguation). + */ + if (n->parent && MDOC_Rs == n->parent->tok && + n->parent->norm->Rs.quote_T) + termp_quote_post(p, pair, meta, n); - if (NULL == n->next) { - pair->flag |= ttypes[TTYPE_LINK_ANCHOR]; - return(1); - } + termp____post(p, pair, meta, n); +} - p->flags |= ttypes[TTYPE_LINK_ANCHOR]; - term_word(p, n->string); - p->flags |= TERMP_NOSPACE; - term_word(p, ":"); - p->flags &= ~ttypes[TTYPE_LINK_ANCHOR]; +static int +termp__t_pre(DECL_ARGS) +{ - p->flags |= ttypes[TTYPE_LINK_TEXT]; - for (n = n->next; n; n = n->next) - term_word(p, n->string); + /* + * If we're in an `Rs' and there's a journal present, then quote + * us instead of underlining us (for disambiguation). + */ + if (n->parent && MDOC_Rs == n->parent->tok && + n->parent->norm->Rs.quote_T) + return(termp_quote_pre(p, pair, meta, n)); - p->flags &= ~ttypes[TTYPE_LINK_TEXT]; - return(0); + term_fontpush(p, TERMFONT_UNDER); + return(1); } - -/* ARGSUSED */ static int -termp_mt_pre(DECL_ARGS) +termp_under_pre(DECL_ARGS) { - pair->flag |= ttypes[TTYPE_LINK_ANCHOR]; + term_fontpush(p, TERMFONT_UNDER); return(1); } - -