=================================================================== RCS file: /cvs/mandoc/mdoc_term.c,v retrieving revision 1.32 retrieving revision 1.51 diff -u -p -r1.32 -r1.51 --- mandoc/mdoc_term.c 2009/07/12 19:28:46 1.32 +++ mandoc/mdoc_term.c 2009/07/21 13:34:13 1.51 @@ -1,4 +1,4 @@ -/* $Id: mdoc_term.c,v 1.32 2009/07/12 19:28:46 kristaps Exp $ */ +/* $Id: mdoc_term.c,v 1.51 2009/07/21 13:34:13 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 @@ -127,10 +126,10 @@ static int termp__t_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_at_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); @@ -148,7 +147,6 @@ 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_lb_pre(DECL_ARGS); static int termp_lk_pre(DECL_ARGS); static int termp_ms_pre(DECL_ARGS); static int termp_mt_pre(DECL_ARGS); @@ -165,9 +163,9 @@ 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_st_pre(DECL_ARGS); static int termp_sx_pre(DECL_ARGS); static int termp_sy_pre(DECL_ARGS); static int termp_ud_pre(DECL_ARGS); @@ -214,7 +212,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 */ @@ -232,7 +230,7 @@ static const struct termact termacts[MDOC_MAX] = { { 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 */ @@ -283,7 +281,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 */ @@ -295,6 +293,8 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* En */ { termp_xx_pre, NULL }, /* Dx */ { NULL, NULL }, /* %Q */ + { termp_br_pre, NULL }, /* br */ + { termp_sp_pre, NULL }, /* sp */ }; #ifdef __linux__ @@ -363,6 +363,13 @@ print_node(DECL_ARGS) 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)) @@ -377,6 +384,8 @@ print_node(DECL_ARGS) if (dochild && node->child) print_body(p, &npair, meta, node->child); + p->flags &= ~npair.flag; + /* Post-processing. */ if (MDOC_TEXT != node->type) @@ -385,7 +394,6 @@ print_node(DECL_ARGS) p->offset = offset; p->rmargin = rmargin; - p->flags &= ~npair.flag; } @@ -410,7 +418,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); @@ -520,28 +528,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); } @@ -574,34 +580,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); } @@ -653,6 +671,9 @@ fmt_block_vspace(struct termp *p, if (arg_hasattr(MDOC_Compact, bl)) return(1); + /* XXX - not documented! */ + else if (arg_hasattr(MDOC_Column, bl)) + return(1); for (n = node; n; n = n->parent) { if (MDOC_BLOCK != n->type) @@ -704,7 +725,7 @@ 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) @@ -729,6 +750,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. */ @@ -755,7 +777,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) { @@ -771,6 +793,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; @@ -784,21 +812,22 @@ termp_it_pre(DECL_ARGS) * while diagonal bodies need two. */ + p->flags |= TERMP_NOSPACE; + switch (type) { case (MDOC_Diag): - term_word(p, "\\ "); - /* FALLTHROUGH */ + 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. */ @@ -828,17 +857,31 @@ 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) + 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); @@ -875,14 +918,25 @@ termp_it_pre(DECL_ARGS) /* FALLTHROUGH */ case (MDOC_Hyphen): /* FALLTHROUGH */ + case (MDOC_Hang): + /* FALLTHROUGH */ case (MDOC_Tag): + assert(width); if (MDOC_HEAD == node->type) p->rmargin = p->offset + width; else p->offset += width; break; case (MDOC_Column): + assert(width); p->rmargin = p->offset + width; + /* + * XXX - this behaviour is not documented: the + * right-most column is filled to the right margin. + */ + if (MDOC_HEAD == node->type && + MDOC_BODY == node->next->type) + p->rmargin = p->maxrmargin; break; default: break; @@ -893,18 +947,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, "\\(hy"); + p->flags &= ~TERMP_BOLD; break; case (MDOC_Enum): (pair->ppair->ppair->count)++; @@ -916,8 +971,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. */ @@ -957,10 +1010,9 @@ 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_Inset): @@ -1043,18 +1095,6 @@ termp_pp_pre(DECL_ARGS) /* ARGSUSED */ static int -termp_st_pre(DECL_ARGS) -{ - const char *cp; - - if (node->child && (cp = mdoc_a2st(node->child->string))) - term_word(p, cp); - return(0); -} - - -/* ARGSUSED */ -static int termp_rs_pre(DECL_ARGS) { @@ -1070,13 +1110,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"); @@ -1105,13 +1142,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); @@ -1130,13 +1164,8 @@ 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. - */ #if defined(__OpenBSD__) || defined(__linux__) - term_word(p, "\\-"); + term_word(p, "\\(en"); #else term_word(p, "\\(em"); #endif @@ -1304,23 +1333,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) { @@ -1571,7 +1583,6 @@ termp_bd_pre(DECL_ARGS) * Ew. */ - p->flags |= TERMP_LITERAL; ln = node->child ? node->child->line : 0; for (node = node->child; node; node = node->next) { @@ -1594,10 +1605,7 @@ termp_bd_post(DECL_ARGS) if (MDOC_BODY != node->type) return; - term_flushln(p); - p->flags &= ~TERMP_LITERAL; - p->flags |= TERMP_NOSPACE; } @@ -1824,8 +1832,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; @@ -1844,24 +1853,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) { @@ -1941,13 +1963,12 @@ 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) {