=================================================================== RCS file: /cvs/mandoc/mdoc_term.c,v retrieving revision 1.25 retrieving revision 1.64 diff -u -p -r1.25 -r1.64 --- mandoc/mdoc_term.c 2009/07/12 16:34:16 1.25 +++ mandoc/mdoc_term.c 2009/07/29 08:46:06 1.64 @@ -1,4 +1,4 @@ -/* $Id: mdoc_term.c,v 1.25 2009/07/12 16:34:16 kristaps Exp $ */ +/* $Id: mdoc_term.c,v 1.64 2009/07/29 08:46:06 kristaps Exp $ */ /* * Copyright (c) 2008, 2009 Kristaps Dzonsons * @@ -27,7 +27,6 @@ #include "mdoc.h" /* FIXME: macro arguments can be escaped. */ -/* FIXME: support more offset/width tokens. */ #define TTYPE_PROG 0 #define TTYPE_CMD_FLAG 1 @@ -51,8 +50,9 @@ #define TTYPE_LINK_ANCHOR 19 #define TTYPE_LINK_TEXT 20 #define TTYPE_REF_JOURNAL 21 -#define TTYPE_LIST 22 -#define TTYPE_NMAX 23 +#define TTYPE_REF_TITLE 22 +#define TTYPE_LIST 23 +#define TTYPE_NMAX 24 const int ttypes[TTYPE_NMAX] = { TERMP_BOLD, /* TTYPE_PROG */ @@ -66,7 +66,7 @@ const int ttypes[TTYPE_NMAX] = { TERMP_UNDER, /* TTYPE_FUNC_ARG */ TERMP_UNDER, /* TTYPE_LINK */ TERMP_BOLD, /* TTYPE_SSECTION */ - TERMP_UNDER, /* TTYPE_FILE */ + TERMP_UNDER, /* TTYPE_FILE */ TERMP_UNDER, /* TTYPE_EMPH */ TERMP_BOLD, /* TTYPE_CONFIG */ TERMP_BOLD, /* TTYPE_CMD */ @@ -77,111 +77,106 @@ const int ttypes[TTYPE_NMAX] = { TERMP_UNDER, /* TTYPE_LINK_ANCHOR */ TERMP_BOLD, /* TTYPE_LINK_TEXT */ TERMP_UNDER, /* TTYPE_REF_JOURNAL */ + TERMP_UNDER, /* TTYPE_REF_TITLE */ TERMP_BOLD /* TTYPE_LIST */ }; -/* XXX - clean this up. */ - struct termpair { struct termpair *ppair; - int type; -#define TERMPAIR_FLAG (1 << 0) - int flag; /* Whether being used. */ - size_t offset; /* Left margin. */ - size_t rmargin; /* Right margin. */ - int count; /* Enum count. */ + int flag; + int count; }; -#define TERMPAIR_SETFLAG(termp, p, fl) \ - do { \ - assert(! (TERMPAIR_FLAG & (p)->type)); \ - (termp)->flags |= (fl); \ - (p)->flag = (fl); \ - (p)->type |= TERMPAIR_FLAG; \ - } while ( /* CONSTCOND */ 0) +#define DECL_ARGS struct termp *p, \ + struct termpair *pair, \ + const struct mdoc_meta *meta, \ + const struct mdoc_node *node -#define DECL_ARGS \ - struct termp *p, struct termpair *pair, \ - const struct mdoc_meta *meta, \ - const struct mdoc_node *node - -#define DECL_PRE(name) \ -static int name##_pre(DECL_ARGS) -#define DECL_POST(name) \ -static void name##_post(DECL_ARGS) -#define DECL_PREPOST(name) \ -DECL_PRE(name); \ -DECL_POST(name); - -DECL_PREPOST(termp__t); -DECL_PREPOST(termp_aq); -DECL_PREPOST(termp_bd); -DECL_PREPOST(termp_bq); -DECL_PREPOST(termp_brq); -DECL_PREPOST(termp_d1); -DECL_PREPOST(termp_dq); -DECL_PREPOST(termp_fd); -DECL_PREPOST(termp_fn); -DECL_PREPOST(termp_fo); -DECL_PREPOST(termp_ft); -DECL_PREPOST(termp_in); -DECL_PREPOST(termp_it); -DECL_PREPOST(termp_lb); -DECL_PREPOST(termp_op); -DECL_PREPOST(termp_pf); -DECL_PREPOST(termp_pq); -DECL_PREPOST(termp_qq); -DECL_PREPOST(termp_sh); -DECL_PREPOST(termp_ss); -DECL_PREPOST(termp_sq); -DECL_PREPOST(termp_vt); - -DECL_PRE(termp__j); -DECL_PRE(termp_ap); -DECL_PRE(termp_ar); -DECL_PRE(termp_at); -DECL_PRE(termp_bf); -DECL_PRE(termp_bsx); -DECL_PRE(termp_bt); -DECL_PRE(termp_cd); -DECL_PRE(termp_cm); -DECL_PRE(termp_dx); -DECL_PRE(termp_em); -DECL_PRE(termp_ex); -DECL_PRE(termp_fa); -DECL_PRE(termp_fl); -DECL_PRE(termp_fx); -DECL_PRE(termp_ic); -DECL_PRE(termp_lk); -DECL_PRE(termp_ms); -DECL_PRE(termp_mt); -DECL_PRE(termp_nd); -DECL_PRE(termp_nm); -DECL_PRE(termp_ns); -DECL_PRE(termp_nx); -DECL_PRE(termp_ox); -DECL_PRE(termp_pa); -DECL_PRE(termp_pp); -DECL_PRE(termp_rs); -DECL_PRE(termp_rv); -DECL_PRE(termp_sm); -DECL_PRE(termp_st); -DECL_PRE(termp_sx); -DECL_PRE(termp_sy); -DECL_PRE(termp_ud); -DECL_PRE(termp_ux); -DECL_PRE(termp_va); -DECL_PRE(termp_xr); - -DECL_POST(termp___); -DECL_POST(termp_bl); -DECL_POST(termp_bx); - struct termact { int (*pre)(DECL_ARGS); void (*post)(DECL_ARGS); }; +static void termp____post(DECL_ARGS); +static void termp_an_post(DECL_ARGS); +static void termp_aq_post(DECL_ARGS); +static void termp_bd_post(DECL_ARGS); +static void termp_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_pf_post(DECL_ARGS); +static void termp_pq_post(DECL_ARGS); +static void termp_qq_post(DECL_ARGS); +static void termp_sh_post(DECL_ARGS); +static void termp_sq_post(DECL_ARGS); +static void termp_ss_post(DECL_ARGS); +static void termp_vt_post(DECL_ARGS); + +static int termp__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_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_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] = { { termp_ap_pre, NULL }, /* Ap */ { NULL, NULL }, /* Dd */ @@ -198,7 +193,7 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* El */ { termp_it_pre, termp_it_post }, /* It */ { NULL, NULL }, /* Ad */ - { NULL, NULL }, /* An */ + { termp_an_pre, termp_an_post }, /* An */ { termp_ar_pre, NULL }, /* Ar */ { termp_cd_pre, NULL }, /* Cd */ { termp_cm_pre, NULL }, /* Cm */ @@ -220,7 +215,7 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* Ot */ { termp_pa_pre, NULL }, /* Pa */ { termp_rv_pre, NULL }, /* Rv */ - { termp_st_pre, NULL }, /* St */ + { NULL, NULL }, /* St */ { termp_va_pre, NULL }, /* Va */ { termp_vt_pre, termp_vt_post }, /* Vt */ { termp_xr_pre, NULL }, /* Xr */ @@ -233,17 +228,17 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, termp____post }, /* %O */ { NULL, termp____post }, /* %P */ { NULL, termp____post }, /* %R */ - { termp__t_pre, termp__t_post }, /* %T */ + { termp__t_pre, termp____post }, /* %T */ { NULL, termp____post }, /* %V */ { NULL, NULL }, /* Ac */ { termp_aq_pre, termp_aq_post }, /* Ao */ { termp_aq_pre, termp_aq_post }, /* Aq */ - { termp_at_pre, NULL }, /* At */ + { 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_bsx_pre, NULL }, /* Bsx */ + { termp_xx_pre, NULL }, /* Bsx */ { NULL, termp_bx_post }, /* Bx */ { NULL, NULL }, /* Db */ { NULL, NULL }, /* Dc */ @@ -253,12 +248,12 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* Ef */ { termp_em_pre, NULL }, /* Em */ { NULL, NULL }, /* Eo */ - { termp_fx_pre, NULL }, /* Fx */ + { termp_xx_pre, NULL }, /* Fx */ { termp_ms_pre, NULL }, /* Ms */ { NULL, NULL }, /* No */ { termp_ns_pre, NULL }, /* Ns */ - { termp_nx_pre, NULL }, /* Nx */ - { termp_ox_pre, NULL }, /* Ox */ + { 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 */ @@ -276,7 +271,7 @@ static const struct termact termacts[MDOC_MAX] = { { termp_sx_pre, NULL }, /* Sx */ { termp_sy_pre, NULL }, /* Sy */ { NULL, NULL }, /* Tn */ - { termp_ux_pre, NULL }, /* Ux */ + { termp_xx_pre, NULL }, /* Ux */ { NULL, NULL }, /* Xc */ { NULL, NULL }, /* Xo */ { termp_fo_pre, termp_fo_post }, /* Fo */ @@ -289,7 +284,7 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* Hf */ { NULL, NULL }, /* Fr */ { termp_ud_pre, NULL }, /* Ud */ - { termp_lb_pre, termp_lb_post }, /* Lb */ + { NULL, termp_lb_post }, /* Lb */ { termp_pp_pre, NULL }, /* Lp */ { termp_lk_pre, NULL }, /* Lk */ { termp_mt_pre, NULL }, /* Mt */ @@ -299,8 +294,10 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* %C */ { NULL, NULL }, /* Es */ { NULL, NULL }, /* En */ - { termp_dx_pre, NULL }, /* Dx */ + { termp_xx_pre, NULL }, /* Dx */ { NULL, NULL }, /* %Q */ + { termp_br_pre, NULL }, /* br */ + { termp_sp_pre, NULL }, /* sp */ }; #ifdef __linux__ @@ -315,7 +312,7 @@ 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); @@ -333,7 +330,6 @@ 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); @@ -360,16 +356,23 @@ print_node(DECL_ARGS) { int dochild; struct termpair npair; + size_t offset, rmargin; - /* Pre-processing. */ - dochild = 1; + offset = p->offset; + rmargin = p->rmargin; + npair.ppair = pair; - npair.type = 0; - npair.offset = npair.rmargin = 0; 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. + */ + if (MDOC_TEXT != node->type) { if (termacts[node->tok].pre) if ( ! (*termacts[node->tok].pre)(p, &npair, meta, node)) @@ -379,20 +382,21 @@ print_node(DECL_ARGS) /* Children. */ - if (TERMPAIR_FLAG & npair.type) - p->flags |= npair.flag; + p->flags |= npair.flag; if (dochild && node->child) print_body(p, &npair, meta, node->child); - if (TERMPAIR_FLAG & npair.type) - p->flags &= ~npair.flag; + p->flags &= ~npair.flag; /* Post-processing. */ if (MDOC_TEXT != node->type) if (termacts[node->tok].post) (*termacts[node->tok].post)(p, &npair, meta, node); + + p->offset = offset; + p->rmargin = rmargin; } @@ -417,7 +421,7 @@ print_foot(struct termp *p, const struct mdoc_meta *me tm = localtime(&meta->date); - if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm)) + if (0 == strftime(buf, p->rmargin, "%B %e, %Y", tm)) err(1, "strftime"); (void)strlcpy(os, meta->os, p->rmargin); @@ -527,28 +531,26 @@ print_head(struct termp *p, const struct mdoc_meta *me static size_t arg_width(const struct mdoc_argv *arg, int pos) { - size_t v; int i, len; + const char *p; assert(pos < (int)arg->sz && pos >= 0); assert(arg->value[pos]); - if (0 == (len = (int)strlen(arg->value[pos]))) + p = arg->value[pos]; + + if (0 == (len = (int)strlen(p))) return(0); for (i = 0; i < len - 1; i++) - if ( ! isdigit((u_char)arg->value[pos][i])) + if ( ! isdigit((u_char)p[i])) break; - if (i == len - 1) { - if ('n' == arg->value[pos][len - 1] || - 'm' == arg->value[pos][len - 1]) { - v = (size_t)atoi(arg->value[pos]); - return(v + 2); - } + if (i == len - 1) + if ('n' == p[len - 1] || 'm' == p[len - 1]) + return((size_t)atoi(p) + 2); - } - return(strlen(arg->value[pos]) + 2); + return((size_t)len + 2); } @@ -581,34 +583,46 @@ arg_listtype(const struct mdoc_node *n) /* FALLTHROUGH */ case (MDOC_Column): /* FALLTHROUGH */ + case (MDOC_Hang): + /* FALLTHROUGH */ case (MDOC_Ohang): return(n->args->argv[i].arg); default: break; } - /* FIXME: mandated by parser. */ - - errx(1, "list type not supported"); - /* NOTREACHED */ + return(-1); } static size_t arg_offset(const struct mdoc_argv *arg) { + int len, i; + const char *p; assert(*arg->value); - if (0 == strcmp(*arg->value, "left")) + p = *arg->value; + + if (0 == strcmp(p, "left")) return(0); - if (0 == strcmp(*arg->value, "indent")) + if (0 == strcmp(p, "indent")) return(INDENT + 1); - if (0 == strcmp(*arg->value, "indent-two")) + if (0 == strcmp(p, "indent-two")) return((INDENT + 1) * 2); - /* FIXME: needs to support field-widths (10n, etc.). */ + if (0 == (len = (int)strlen(p))) + return(0); - return(strlen(*arg->value)); + 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); } @@ -649,7 +663,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) @@ -658,23 +672,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); } @@ -711,18 +750,18 @@ termp_it_pre(DECL_ARGS) { const struct mdoc_node *bl, *n; char buf[7]; - int i, type, keys[3], vals[3], sv; + 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; /* Save parent attributes. */ - pair->offset = p->offset; - pair->rmargin = p->rmargin; pair->flag = p->flags; /* Get list width and offset. */ @@ -738,6 +777,7 @@ termp_it_pre(DECL_ARGS) (void)arg_getattrs(keys, vals, 3, bl); type = arg_listtype(bl); + assert(-1 != type); /* Calculate real width and offset. */ @@ -745,11 +785,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 && n && + i < (int)bl->args[vals[2]].argv->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[vals[2]].argv->sz) + width = arg_width(&bl->args->argv[vals[2]], i); + else + width = 0; + if (vals[1] >= 0) offset += arg_offset(&bl->args->argv[vals[1]]); break; @@ -764,7 +820,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. + * offset. FIXME: double-check that correct. */ switch (type) { @@ -780,6 +836,12 @@ termp_it_pre(DECL_ARGS) if (width < 5) width = 5; break; + case (MDOC_Hang): + if (0 == width) + width = 8; + break; + case (MDOC_Column): + /* FALLTHROUGH */ case (MDOC_Tag): if (0 == width) width = 10; @@ -793,21 +855,23 @@ termp_it_pre(DECL_ARGS) * while diagonal bodies need two. */ + p->flags |= TERMP_NOSPACE; + switch (type) { case (MDOC_Diag): - term_word(p, "\\ "); - /* FALLTHROUGH */ + 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; } + p->flags |= TERMP_NOSPACE; + /* * Style flags. Diagnostic heads need TTYPE_DIAG. */ @@ -837,17 +901,45 @@ termp_it_pre(DECL_ARGS) case (MDOC_Enum): /* FALLTHROUGH */ case (MDOC_Hyphen): - /* FALLTHROUGH */ - case (MDOC_Tag): if (MDOC_HEAD == node->type) p->flags |= TERMP_NOBREAK; else p->flags |= TERMP_NOLPAD; - if (MDOC_HEAD == node->type && MDOC_Tag == type) - if (NULL == node->next || - NULL == node->next->child) - p->flags |= TERMP_NONOBREAK; break; + case (MDOC_Hang): + if (MDOC_HEAD == node->type) + p->flags |= TERMP_NOBREAK; + else + p->flags |= TERMP_NOLPAD; + + 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 | TERMP_TWOSPACE; + else + p->flags |= TERMP_NOLPAD; + + if (MDOC_HEAD != node->type) + break; + if (NULL == node->next || NULL == node->next->child) + p->flags |= TERMP_DANGLE; + break; case (MDOC_Column): if (MDOC_HEAD == node->type) { assert(node->next); @@ -876,6 +968,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): @@ -885,13 +988,22 @@ termp_it_pre(DECL_ARGS) case (MDOC_Hyphen): /* 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; @@ -902,18 +1014,19 @@ termp_it_pre(DECL_ARGS) * HEAD character (temporarily bold, in some cases). */ - sv = p->flags; if (MDOC_HEAD == node->type) switch (type) { case (MDOC_Bullet): p->flags |= TERMP_BOLD; term_word(p, "\\[bu]"); + p->flags &= ~TERMP_BOLD; break; case (MDOC_Dash): /* FALLTHROUGH */ case (MDOC_Hyphen): p->flags |= TERMP_BOLD; - term_word(p, "\\-"); + term_word(p, "\\(hy"); + p->flags &= ~TERMP_BOLD; break; case (MDOC_Enum): (pair->ppair->ppair->count)++; @@ -925,8 +1038,6 @@ termp_it_pre(DECL_ARGS) break; } - p->flags = sv; /* Restore saved flags. */ - /* * If we're not going to process our children, indicate so here. */ @@ -966,12 +1077,13 @@ termp_it_post(DECL_ARGS) return; type = arg_listtype(node->parent->parent->parent); + assert(-1 != type); switch (type) { - case (MDOC_Diag): - /* FALLTHROUGH */ case (MDOC_Item): /* FALLTHROUGH */ + case (MDOC_Diag): + /* FALLTHROUGH */ case (MDOC_Inset): if (MDOC_BODY == node->type) term_flushln(p); @@ -985,8 +1097,6 @@ termp_it_post(DECL_ARGS) break; } - p->offset = pair->offset; - p->rmargin = pair->rmargin; p->flags = pair->flag; } @@ -999,7 +1109,9 @@ termp_nm_pre(DECL_ARGS) if (SEC_SYNOPSIS == node->sec) term_newln(p); - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_PROG]); + pair->flag |= ttypes[TTYPE_PROG]; + p->flags |= ttypes[TTYPE_PROG]; + if (NULL == node->child) term_word(p, meta->name); @@ -1012,7 +1124,8 @@ static int termp_fl_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD_FLAG]); + pair->flag |= ttypes[TTYPE_CMD_FLAG]; + p->flags |= ttypes[TTYPE_CMD_FLAG]; term_word(p, "\\-"); p->flags |= TERMP_NOSPACE; return(1); @@ -1021,43 +1134,90 @@ termp_fl_pre(DECL_ARGS) /* ARGSUSED */ static int -termp_ar_pre(DECL_ARGS) +termp_an_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(p, pair, 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 void +termp_an_post(DECL_ARGS) +{ + + 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_ns_pre(DECL_ARGS) +termp_ar_pre(DECL_ARGS) { - p->flags |= TERMP_NOSPACE; + pair->flag |= ttypes[TTYPE_CMD_ARG]; return(1); } /* ARGSUSED */ static int -termp_pp_pre(DECL_ARGS) +termp_ns_pre(DECL_ARGS) { - term_vspace(p); + p->flags |= TERMP_NOSPACE; return(1); } /* ARGSUSED */ static int -termp_st_pre(DECL_ARGS) +termp_pp_pre(DECL_ARGS) { - const char *cp; - if (node->child && (cp = mdoc_a2st(node->child->string))) - term_word(p, cp); - return(0); + term_vspace(p); + return(1); } @@ -1078,13 +1238,10 @@ termp_rv_pre(DECL_ARGS) { int i; - /* FIXME: mandated by parser. */ + i = arg_getattr(MDOC_Std, node); + assert(-1 != i); + assert(node->args->argv[i].sz); - if (-1 == (i = arg_getattr(MDOC_Std, node))) - errx(1, "expected -std argument"); - if (1 != node->args->argv[i].sz) - errx(1, "expected -std argument"); - term_newln(p); term_word(p, "The"); @@ -1113,13 +1270,10 @@ termp_ex_pre(DECL_ARGS) { int i; - /* FIXME: mandated by parser? */ + i = arg_getattr(MDOC_Std, node); + assert(-1 != i); + assert(node->args->argv[i].sz); - if (-1 == (i = arg_getattr(MDOC_Std, node))) - errx(1, "expected -std argument"); - if (1 != node->args->argv[i].sz) - errx(1, "expected -std argument"); - term_word(p, "The"); p->flags |= ttypes[TTYPE_PROG]; term_word(p, *node->args->argv[i].value); @@ -1137,13 +1291,9 @@ termp_nd_pre(DECL_ARGS) if (MDOC_BODY != node->type) return(1); - /* - * XXX: signed off by jmc@openbsd.org. This technically - * produces a minus sign after the Nd, which is wrong, but is - * consistent with the historic OpenBSD tmac file. - */ -#ifdef __OpenBSD__ - term_word(p, "\\-"); + +#if defined(__OpenBSD__) || defined(__linux__) + term_word(p, "\\(en"); #else term_word(p, "\\(em"); #endif @@ -1201,7 +1351,7 @@ termp_vt_pre(DECL_ARGS) { /* FIXME: this can be "type name". */ - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_VAR_DECL]); + pair->flag |= ttypes[TTYPE_VAR_DECL]; return(1); } @@ -1211,7 +1361,11 @@ static void termp_vt_post(DECL_ARGS) { - if (node->sec == SEC_SYNOPSIS) + if (node->sec != SEC_SYNOPSIS) + return; + if (node->next && MDOC_Vt == node->next->tok) + term_newln(p); + else if (node->next) term_vspace(p); } @@ -1221,11 +1375,7 @@ static int termp_fd_pre(DECL_ARGS) { - /* - * FIXME: this naming is bad. This value is used, in general, - * for the #include header or other preprocessor statement. - */ - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FUNC_DECL]); + pair->flag |= ttypes[TTYPE_FUNC_DECL]; return(1); } @@ -1237,6 +1387,7 @@ 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); @@ -1247,11 +1398,14 @@ termp_fd_post(DECL_ARGS) static int termp_sh_pre(DECL_ARGS) { - + /* + * FIXME: using two `Sh' macros in sequence has no vspace + * between calls, only a newline. + */ switch (node->type) { case (MDOC_HEAD): term_vspace(p); - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SECTION]); + pair->flag |= ttypes[TTYPE_SECTION]; break; case (MDOC_BODY): p->offset = INDENT; @@ -1310,23 +1464,6 @@ termp_bt_pre(DECL_ARGS) /* ARGSUSED */ -static int -termp_lb_pre(DECL_ARGS) -{ - const char *lb; - - assert(node->child && MDOC_TEXT == node->child->type); - lb = mdoc_a2lib(node->child->string); - if (lb) { - term_word(p, lb); - return(0); - } - term_word(p, "library"); - return(1); -} - - -/* ARGSUSED */ static void termp_lb_post(DECL_ARGS) { @@ -1353,8 +1490,7 @@ termp_d1_pre(DECL_ARGS) if (MDOC_BLOCK != node->type) return(1); term_newln(p); - pair->offset = INDENT + 1; - p->offset += pair->offset; + p->offset += (INDENT + 1); return(1); } @@ -1367,7 +1503,6 @@ termp_d1_post(DECL_ARGS) if (MDOC_BLOCK != node->type) return; term_newln(p); - p->offset -= pair->offset; } @@ -1404,7 +1539,7 @@ termp_ft_pre(DECL_ARGS) if (SEC_SYNOPSIS == node->sec) if (node->prev && MDOC_Fo == node->prev->tok) term_vspace(p); - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FUNC_TYPE]); + pair->flag |= ttypes[TTYPE_FUNC_TYPE]; return(1); } @@ -1460,7 +1595,6 @@ termp_fn_post(DECL_ARGS) if (node->sec == SEC_SYNOPSIS && node->next) term_vspace(p); - } @@ -1469,7 +1603,7 @@ static int termp_sx_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_LINK]); + pair->flag |= ttypes[TTYPE_LINK]; return(1); } @@ -1481,7 +1615,7 @@ termp_fa_pre(DECL_ARGS) struct mdoc_node *n; if (node->parent->tok != MDOC_Fo) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FUNC_ARG]); + pair->flag |= ttypes[TTYPE_FUNC_ARG]; return(1); } @@ -1505,7 +1639,7 @@ static int termp_va_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_VAR_DECL]); + pair->flag |= ttypes[TTYPE_VAR_DECL]; return(1); } @@ -1514,7 +1648,7 @@ termp_va_pre(DECL_ARGS) static int termp_bd_pre(DECL_ARGS) { - int i, type, ln; + int i, type; /* * This is fairly tricky due primarily to crappy documentation. @@ -1527,19 +1661,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"); - - pair->offset = p->offset; - - 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): @@ -1550,22 +1680,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): @@ -1576,22 +1701,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); @@ -1605,11 +1719,8 @@ termp_bd_post(DECL_ARGS) if (MDOC_BODY != node->type) return; - - term_flushln(p); - p->flags &= ~TERMP_LITERAL; - p->offset = pair->offset; p->flags |= TERMP_NOSPACE; + term_flushln(p); } @@ -1639,16 +1750,6 @@ termp_qq_post(DECL_ARGS) /* ARGSUSED */ -static int -termp_bsx_pre(DECL_ARGS) -{ - - term_word(p, "BSDI BSD/OS"); - return(1); -} - - -/* ARGSUSED */ static void termp_bx_post(DECL_ARGS) { @@ -1661,56 +1762,42 @@ termp_bx_post(DECL_ARGS) /* ARGSUSED */ static int -termp_ox_pre(DECL_ARGS) +termp_xx_pre(DECL_ARGS) { + const char *pp; - term_word(p, "OpenBSD"); - return(1); -} + pp = NULL; + switch (node->tok) { + case (MDOC_Bsx): + pp = "BSDI BSD/OS"; + break; + case (MDOC_Dx): + pp = "DragonFlyBSD"; + break; + case (MDOC_Fx): + pp = "FreeBSD"; + break; + case (MDOC_Nx): + pp = "NetBSD"; + break; + case (MDOC_Ox): + pp = "OpenBSD"; + break; + case (MDOC_Ux): + pp = "UNIX"; + break; + default: + break; + } - -/* ARGSUSED */ -static int -termp_dx_pre(DECL_ARGS) -{ - - term_word(p, "DragonFly"); + assert(pp); + term_word(p, pp); return(1); } /* ARGSUSED */ static int -termp_ux_pre(DECL_ARGS) -{ - - term_word(p, "UNIX"); - return(1); -} - - -/* ARGSUSED */ -static int -termp_fx_pre(DECL_ARGS) -{ - - term_word(p, "FreeBSD"); - return(1); -} - - -/* ARGSUSED */ -static int -termp_nx_pre(DECL_ARGS) -{ - - term_word(p, "NetBSD"); - return(1); -} - - -/* ARGSUSED */ -static int termp_sq_pre(DECL_ARGS) { @@ -1736,6 +1823,16 @@ termp_sq_post(DECL_ARGS) /* ARGSUSED */ static int +termp_pa_pre(DECL_ARGS) +{ + + pair->flag |= ttypes[TTYPE_FILE]; + return(1); +} + + +/* ARGSUSED */ +static int termp_pf_pre(DECL_ARGS) { @@ -1766,7 +1863,7 @@ termp_ss_pre(DECL_ARGS) term_vspace(p); break; case (MDOC_HEAD): - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SSECTION]); + pair->flag |= ttypes[TTYPE_SSECTION]; p->offset = HALFINDENT; break; default: @@ -1782,33 +1879,17 @@ static void termp_ss_post(DECL_ARGS) { - switch (node->type) { - case (MDOC_HEAD): + if (MDOC_HEAD == node->type) term_newln(p); - p->offset = INDENT; - break; - default: - break; - } } /* ARGSUSED */ static int -termp_pa_pre(DECL_ARGS) -{ - - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_FILE]); - return(1); -} - - -/* ARGSUSED */ -static int termp_em_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]); + pair->flag |= ttypes[TTYPE_EMPH]; return(1); } @@ -1818,7 +1899,7 @@ static int termp_cd_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CONFIG]); + pair->flag |= ttypes[TTYPE_CONFIG]; term_newln(p); return(1); } @@ -1829,7 +1910,7 @@ static int termp_cm_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD_FLAG]); + pair->flag |= ttypes[TTYPE_CMD_FLAG]; return(1); } @@ -1839,7 +1920,7 @@ static int termp_ic_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_CMD]); + pair->flag |= ttypes[TTYPE_CMD]; return(1); } @@ -1849,8 +1930,8 @@ static int termp_in_pre(DECL_ARGS) { - /* XXX This conforms to new-groff style. */ - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_INCLUDE]); + pair->flag |= ttypes[TTYPE_INCLUDE]; + p->flags |= ttypes[TTYPE_INCLUDE]; if (SEC_SYNOPSIS == node->sec) term_word(p, "#include"); @@ -1866,8 +1947,9 @@ static void termp_in_post(DECL_ARGS) { - p->flags |= TERMP_NOSPACE; + p->flags |= TERMP_NOSPACE | ttypes[TTYPE_INCLUDE]; term_word(p, ">"); + p->flags &= ~ttypes[TTYPE_INCLUDE]; if (SEC_SYNOPSIS != node->sec) return; @@ -1886,24 +1968,37 @@ termp_in_post(DECL_ARGS) /* ARGSUSED */ static int -termp_at_pre(DECL_ARGS) +termp_sp_pre(DECL_ARGS) { - const char *att; + int i, len; - att = NULL; + if (NULL == node->child) { + term_vspace(p); + return(0); + } - if (node->child) - att = mdoc_a2att(node->child->string); - if (NULL == att) - att = "AT&T UNIX"; + len = atoi(node->child->string); + if (0 == len) + term_newln(p); + for (i = 0; i < len; i++) + term_vspace(p); - term_word(p, att); return(0); } /* ARGSUSED */ static int +termp_br_pre(DECL_ARGS) +{ + + term_newln(p); + return(1); +} + + +/* ARGSUSED */ +static int termp_brq_pre(DECL_ARGS) { @@ -1983,14 +2078,13 @@ termp_fo_pre(DECL_ARGS) const struct mdoc_node *n; if (MDOC_BODY == node->type) { + p->flags |= TERMP_NOSPACE; term_word(p, "("); p->flags |= TERMP_NOSPACE; return(1); } else if (MDOC_HEAD != node->type) return(1); - /* XXX - groff shows only first parameter */ - p->flags |= ttypes[TTYPE_FUNC_NAME]; for (n = node->child; n; n = n->next) { assert(MDOC_TEXT == n->type); @@ -2023,25 +2117,25 @@ termp_bf_pre(DECL_ARGS) { const struct mdoc_node *n; - if (MDOC_HEAD == node->type) { + if (MDOC_HEAD == node->type) return(0); - } else if (MDOC_BLOCK != node->type) + else if (MDOC_BLOCK != node->type) return(1); if (NULL == (n = node->head->child)) { if (arg_hasattr(MDOC_Emphasis, node)) - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]); + pair->flag |= ttypes[TTYPE_EMPH]; else if (arg_hasattr(MDOC_Symbolic, node)) - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMB]); + pair->flag |= ttypes[TTYPE_SYMB]; return(1); } assert(MDOC_TEXT == n->type); if (0 == strcmp("Em", n->string)) - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]); + pair->flag |= ttypes[TTYPE_EMPH]; else if (0 == strcmp("Sy", n->string)) - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_EMPH]); + pair->flag |= ttypes[TTYPE_SYMB]; return(1); } @@ -2052,7 +2146,7 @@ static int termp_sy_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMB]); + pair->flag |= ttypes[TTYPE_SYMB]; return(1); } @@ -2062,7 +2156,7 @@ static int termp_ms_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_SYMBOL]); + pair->flag |= ttypes[TTYPE_SYMBOL]; return(1); } @@ -2101,7 +2195,7 @@ static int termp__j_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_REF_JOURNAL]); + pair->flag |= ttypes[TTYPE_REF_JOURNAL]; return(1); } @@ -2111,25 +2205,13 @@ static int termp__t_pre(DECL_ARGS) { - term_word(p, "\""); - p->flags |= TERMP_NOSPACE; + pair->flag |= ttypes[TTYPE_REF_TITLE]; 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) { @@ -2148,7 +2230,7 @@ termp_lk_pre(DECL_ARGS) n = node->child; if (NULL == n->next) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_LINK_ANCHOR]); + pair->flag |= ttypes[TTYPE_LINK_ANCHOR]; return(1); } @@ -2172,7 +2254,7 @@ static int termp_mt_pre(DECL_ARGS) { - TERMPAIR_SETFLAG(p, pair, ttypes[TTYPE_LINK_ANCHOR]); + pair->flag |= ttypes[TTYPE_LINK_ANCHOR]; return(1); }