=================================================================== RCS file: /cvs/mandoc/mdoc_term.c,v retrieving revision 1.132 retrieving revision 1.149 diff -u -p -r1.132 -r1.149 --- mandoc/mdoc_term.c 2010/05/29 18:47:54 1.132 +++ mandoc/mdoc_term.c 2010/06/12 11:58:22 1.149 @@ -1,4 +1,4 @@ -/* $Id: mdoc_term.c,v 1.132 2010/05/29 18:47:54 kristaps Exp $ */ +/* $Id: mdoc_term.c,v 1.149 2010/06/12 11:58:22 kristaps Exp $ */ /* * Copyright (c) 2008, 2009 Kristaps Dzonsons * @@ -54,20 +54,21 @@ struct termact { static size_t a2width(const struct mdoc_argv *, int); static size_t a2height(const struct mdoc_node *); -static size_t a2offs(const struct mdoc_argv *); +static size_t a2offs(const char *); 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 int arg_disptype(const struct mdoc_node *); static void print_bvspace(struct termp *, const struct mdoc_node *, const struct mdoc_node *); static void print_mdoc_node(DECL_ARGS); -static void print_mdoc_head(DECL_ARGS); static void print_mdoc_nodelist(DECL_ARGS); -static void print_foot(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); @@ -79,10 +80,8 @@ static void termp_brq_post(DECL_ARGS); static void termp_bx_post(DECL_ARGS); static void termp_d1_post(DECL_ARGS); static void termp_dq_post(DECL_ARGS); -static void termp_fd_post(DECL_ARGS); -static void termp_fn_post(DECL_ARGS); +static int termp_fd_pre(DECL_ARGS); static void termp_fo_post(DECL_ARGS); -static void termp_ft_post(DECL_ARGS); static void termp_in_post(DECL_ARGS); static void termp_it_post(DECL_ARGS); static void termp_lb_post(DECL_ARGS); @@ -93,7 +92,6 @@ static void termp_qq_post(DECL_ARGS); static void termp_sh_post(DECL_ARGS); static void termp_sq_post(DECL_ARGS); static void termp_ss_post(DECL_ARGS); -static void termp_vt_post(DECL_ARGS); static int termp_an_pre(DECL_ARGS); static int termp_ap_pre(DECL_ARGS); @@ -163,10 +161,10 @@ static const struct termact termacts[MDOC_MAX] = { { NULL, NULL }, /* Ev */ { termp_ex_pre, NULL }, /* Ex */ { termp_fa_pre, NULL }, /* Fa */ - { termp_bold_pre, termp_fd_post }, /* Fd */ + { termp_fd_pre, NULL }, /* Fd */ { termp_fl_pre, NULL }, /* Fl */ - { termp_fn_pre, termp_fn_post }, /* Fn */ - { termp_ft_pre, termp_ft_post }, /* Ft */ + { termp_fn_pre, NULL }, /* Fn */ + { termp_ft_pre, NULL }, /* Ft */ { termp_bold_pre, NULL }, /* Ic */ { termp_in_pre, termp_in_post }, /* In */ { termp_li_pre, NULL }, /* Li */ @@ -178,7 +176,7 @@ static const struct termact termacts[MDOC_MAX] = { { termp_rv_pre, NULL }, /* Rv */ { NULL, NULL }, /* St */ { termp_under_pre, NULL }, /* Va */ - { termp_vt_pre, termp_vt_post }, /* Vt */ + { termp_vt_pre, NULL }, /* Vt */ { termp_xr_pre, NULL }, /* Xr */ { NULL, termp____post }, /* %A */ { termp_under_pre, termp____post }, /* %B */ @@ -260,6 +258,7 @@ static const struct termact termacts[MDOC_MAX] = { { termp_sp_pre, NULL }, /* br */ { termp_sp_pre, NULL }, /* sp */ { termp_under_pre, termp____post }, /* %U */ + { NULL, NULL }, /* Ta */ }; @@ -289,10 +288,12 @@ terminal_mdoc(void *arg, const struct mdoc *mdoc) n = mdoc_node(mdoc); m = mdoc_meta(mdoc); - print_mdoc_head(p, NULL, m, n); + term_begin(p, print_mdoc_head, print_mdoc_foot, m); + if (n->child) print_mdoc_nodelist(p, NULL, m, n->child); - print_foot(p, NULL, m, n); + + term_end(p); } @@ -346,12 +347,14 @@ print_mdoc_node(DECL_ARGS) } -/* ARGSUSED */ static void -print_foot(DECL_ARGS) +print_mdoc_foot(struct termp *p, const void *arg) { char buf[DATESIZ], os[BUFSIZ]; + const struct mdoc_meta *m; + m = (const struct mdoc_meta *)arg; + term_fontrepl(p, TERMFONT_NONE); /* @@ -395,12 +398,14 @@ print_foot(DECL_ARGS) } -/* ARGSUSED */ static void -print_mdoc_head(DECL_ARGS) +print_mdoc_head(struct termp *p, const void *arg) { char buf[BUFSIZ], title[BUFSIZ]; + const struct mdoc_meta *m; + m = (const struct mdoc_meta *)arg; + p->rmargin = p->maxrmargin; p->offset = 0; @@ -483,50 +488,21 @@ a2width(const struct mdoc_argv *arg, int pos) } -static int -arg_disptype(const struct mdoc_node *n) -{ - int i, len; - - assert(MDOC_BLOCK == n->type); - - len = (int)(n->args ? n->args->argc : 0); - - for (i = 0; i < len; i++) - switch (n->args->argv[i].arg) { - case (MDOC_Centred): - /* FALLTHROUGH */ - case (MDOC_Ragged): - /* FALLTHROUGH */ - case (MDOC_Filled): - /* FALLTHROUGH */ - case (MDOC_Unfilled): - /* FALLTHROUGH */ - case (MDOC_Literal): - return(n->args->argv[i].arg); - default: - break; - } - - return(-1); -} - - static size_t -a2offs(const struct mdoc_argv *arg) +a2offs(const char *v) { struct roffsu su; - if ('\0' == arg->value[0][0]) + if ('\0' == *v) return(0); - else if (0 == strcmp(arg->value[0], "left")) + else if (0 == strcmp(v, "left")) return(0); - else if (0 == strcmp(arg->value[0], "indent")) + else if (0 == strcmp(v, "indent")) return(INDENT + 1); - else if (0 == strcmp(arg->value[0], "indent-two")) + else if (0 == strcmp(v, "indent-two")) return((INDENT + 1) * 2); - else if ( ! a2roffsu(arg->value[0], &su, SCALE_MAX)) - SCALE_HS_INIT(&su, strlen(arg->value[0])); + else if ( ! a2roffsu(v, &su, SCALE_MAX)) + SCALE_HS_INIT(&su, strlen(v)); return(term_hspan(&su)); } @@ -594,6 +570,7 @@ print_bvspace(struct termp *p, { const struct mdoc_node *nn; + /* FIXME: MDOC_Bd == bl->tok && bl->data.Bd.comp */ term_newln(p); if (arg_hasattr(MDOC_Compact, bl)) return; @@ -614,13 +591,13 @@ print_bvspace(struct termp *p, /* A `-column' does not assert vspace within the list. */ - if (MDOC_Bl == bl->tok && LIST_column == bl->data.list) + if (MDOC_Bl == bl->tok && LIST_column == bl->data.Bl.type) if (n->prev && MDOC_It == n->prev->tok) return; /* A `-diag' without body does not vspace. */ - if (MDOC_Bl == bl->tok && LIST_diag == bl->data.list) + if (MDOC_Bl == bl->tok && LIST_diag == bl->data.Bl.type) if (n->prev && MDOC_It == n->prev->tok) { assert(n->prev->body); if (NULL == n->prev->body->child) @@ -685,7 +662,7 @@ termp_it_pre(DECL_ARGS) arg_getattrs(keys, vals, 3, bl); - type = bl->data.list; + type = bl->data.Bl.type; /* * First calculate width and offset. This is pretty easy unless @@ -696,11 +673,11 @@ termp_it_pre(DECL_ARGS) width = offset = 0; if (vals[1] >= 0) - offset = a2offs(&bl->args->argv[vals[1]]); + offset = a2offs(bl->args->argv[vals[1]].value[0]); switch (type) { case (LIST_column): - if (MDOC_BODY == n->type) + if (MDOC_HEAD == n->type) break; /* * Imitate groff's column handling: @@ -715,8 +692,13 @@ termp_it_pre(DECL_ARGS) /* LINTED */ dcol = ncols < 5 ? 4 : ncols == 5 ? 3 : 1; + /* + * Calculate the offset by applying all prior MDOC_BODY, + * so we stop at the MDOC_HEAD (NULL == nn->prev). + */ + for (i = 0, nn = n->prev; - nn && i < (int)ncols; + nn->prev && i < (int)ncols; nn = nn->prev, i++) offset += dcol + a2width (&bl->args->argv[vals[2]], i); @@ -869,15 +851,18 @@ termp_it_pre(DECL_ARGS) p->flags |= TERMP_DANGLE; break; case (LIST_column): - if (MDOC_HEAD == n->type) { - assert(n->next); - if (MDOC_BODY == n->next->type) - p->flags &= ~TERMP_NOBREAK; - else - p->flags |= TERMP_NOBREAK; - if (n->prev) - p->flags |= TERMP_NOLPAD; - } + if (MDOC_HEAD == n->type) + break; + + if (NULL == n->next) + p->flags &= ~TERMP_NOBREAK; + else + p->flags |= TERMP_NOBREAK; + + assert(n->prev); + if (MDOC_BODY == n->prev->type) + p->flags |= TERMP_NOLPAD; + break; case (LIST_diag): if (MDOC_HEAD == n->type) @@ -929,9 +914,9 @@ termp_it_pre(DECL_ARGS) * XXX - this behaviour is not documented: the * right-most column is filled to the right margin. */ - if (MDOC_HEAD == n->type && - MDOC_BODY == n->next->type && - p->rmargin < p->maxrmargin) + if (MDOC_HEAD == n->type) + break; + if (NULL == n->next && p->rmargin < p->maxrmargin) p->rmargin = p->maxrmargin; break; default: @@ -985,7 +970,7 @@ termp_it_pre(DECL_ARGS) return(0); break; case (LIST_column): - if (MDOC_BODY == n->type) + if (MDOC_HEAD == n->type) return(0); break; default: @@ -1005,7 +990,7 @@ termp_it_post(DECL_ARGS) if (MDOC_BLOCK == n->type) return; - type = n->parent->parent->parent->data.list; + type = n->parent->parent->parent->data.Bl.type; switch (type) { case (LIST_item): @@ -1017,7 +1002,7 @@ termp_it_post(DECL_ARGS) term_newln(p); break; case (LIST_column): - if (MDOC_HEAD == n->type) + if (MDOC_BODY == n->type) term_flushln(p); break; default: @@ -1047,14 +1032,11 @@ termp_nm_pre(DECL_ARGS) if (NULL == n->child && NULL == m->name) return(1); - if (SEC_SYNOPSIS == n->sec && MDOC_LINE & n->flags) - term_newln(p); + synopsis_pre(p, n); term_fontpush(p, TERMFONT_BOLD); - if (NULL == n->child) term_word(p, m->name); - return(1); } @@ -1305,36 +1287,82 @@ termp_xr_pre(DECL_ARGS) } +/* + * 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 || SEC_SYNOPSIS != n->sec) + return; + + /* + * 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) { - if (MDOC_ELEM == n->type) + if (MDOC_ELEM == n->type) { + synopsis_pre(p, n); return(termp_under_pre(p, pair, m, n)); - else if (MDOC_HEAD == n->type) - return(0); - else if (MDOC_BLOCK == n->type) + } else if (MDOC_BLOCK == n->type) { + synopsis_pre(p, n); return(1); + } else if (MDOC_HEAD == n->type) + return(0); return(termp_under_pre(p, pair, m, n)); } /* ARGSUSED */ -static void -termp_vt_post(DECL_ARGS) -{ - - if (MDOC_BLOCK != n->type) - return; - if (n->next && MDOC_Vt == n->next->tok) - term_newln(p); - else if (n->next) - term_vspace(p); -} - - -/* ARGSUSED */ static int termp_bold_pre(DECL_ARGS) { @@ -1345,16 +1373,12 @@ termp_bold_pre(DECL_ARGS) /* ARGSUSED */ -static void -termp_fd_post(DECL_ARGS) +static int +termp_fd_pre(DECL_ARGS) { - if (n->sec != SEC_SYNOPSIS || ! (MDOC_LINE & n->flags)) - return; - - term_newln(p); - if (n->next && MDOC_Fd != n->next->tok) - term_vspace(p); + synopsis_pre(p, n); + return(termp_bold_pre(p, pair, m, n)); } @@ -1507,31 +1531,21 @@ static int termp_ft_pre(DECL_ARGS) { - if (SEC_SYNOPSIS == n->sec && MDOC_LINE & n->flags) - if (n->prev && MDOC_Fo == n->prev->tok) - term_vspace(p); - + /* NB: MDOC_LINE does not effect this! */ + synopsis_pre(p, n); term_fontpush(p, TERMFONT_UNDER); return(1); } /* ARGSUSED */ -static void -termp_ft_post(DECL_ARGS) -{ - - if (SEC_SYNOPSIS == n->sec && MDOC_LINE & n->flags) - term_newln(p); -} - - -/* ARGSUSED */ static int termp_fn_pre(DECL_ARGS) { const struct mdoc_node *nn; + synopsis_pre(p, n); + term_fontpush(p, TERMFONT_BOLD); term_word(p, n->child->string); term_fontpop(p); @@ -1558,16 +1572,6 @@ termp_fn_pre(DECL_ARGS) /* ARGSUSED */ -static void -termp_fn_post(DECL_ARGS) -{ - - if (n->sec == SEC_SYNOPSIS && n->next && MDOC_LINE & n->flags) - term_vspace(p); -} - - -/* ARGSUSED */ static int termp_fa_pre(DECL_ARGS) { @@ -1599,7 +1603,6 @@ static int termp_bd_pre(DECL_ARGS) { size_t tabwidth; - int i, type; size_t rm, rmax; const struct mdoc_node *nn; @@ -1609,14 +1612,9 @@ termp_bd_pre(DECL_ARGS) } else if (MDOC_HEAD == n->type) return(0); - nn = n->parent; + if (n->data.Bd.offs) + p->offset += a2offs(n->data.Bd.offs); - type = arg_disptype(nn); - assert(-1 != type); - - if (-1 != (i = arg_getattr(MDOC_Offset, nn))) - p->offset += a2offs(&nn->args->argv[i]); - /* * If -ragged or -filled are specified, the block does nothing * but change the indentation. If -unfilled or -literal are @@ -1625,7 +1623,8 @@ termp_bd_pre(DECL_ARGS) * lines are allowed. */ - if (MDOC_Literal != type && MDOC_Unfilled != type) + if (DISP_literal != n->data.Bd.type && + DISP_unfilled != n->data.Bd.type) return(1); tabwidth = p->tabwidth; @@ -1642,8 +1641,8 @@ termp_bd_pre(DECL_ARGS) NULL == nn->next) term_flushln(p); } - p->tabwidth = tabwidth; + p->tabwidth = tabwidth; p->rmargin = rm; p->maxrmargin = rmax; return(0); @@ -1654,19 +1653,16 @@ termp_bd_pre(DECL_ARGS) static void termp_bd_post(DECL_ARGS) { - int type; size_t rm, rmax; if (MDOC_BODY != n->type) return; - type = arg_disptype(n->parent); - assert(-1 != type); - rm = p->rmargin; rmax = p->maxrmargin; - if (MDOC_Literal == type || MDOC_Unfilled == type) + if (DISP_literal == n->data.Bd.type || + DISP_unfilled == n->data.Bd.type) p->rmargin = p->maxrmargin = TERM_MAXMARGIN; p->flags |= TERMP_NOSPACE; @@ -1832,8 +1828,8 @@ static int termp_cd_pre(DECL_ARGS) { + synopsis_pre(p, n); term_fontpush(p, TERMFONT_BOLD); - term_newln(p); return(1); } @@ -1843,11 +1839,17 @@ static int termp_in_pre(DECL_ARGS) { - term_fontpush(p, TERMFONT_BOLD); - if (SEC_SYNOPSIS == n->sec) + synopsis_pre(p, n); + + if (SEC_SYNOPSIS == n->sec && 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); } @@ -1858,23 +1860,14 @@ static void termp_in_post(DECL_ARGS) { - term_fontpush(p, TERMFONT_BOLD); + if (SEC_SYNOPSIS == n->sec) + term_fontpush(p, TERMFONT_BOLD); + p->flags |= TERMP_NOSPACE; term_word(p, ">"); - term_fontpop(p); - if (SEC_SYNOPSIS != n->sec && ! (MDOC_LINE & n->flags)) - 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 (n->next && MDOC_In != n->next->tok) - term_vspace(p); + if (SEC_SYNOPSIS == n->sec) + term_fontpop(p); } @@ -1983,23 +1976,23 @@ termp_pq_post(DECL_ARGS) static int termp_fo_pre(DECL_ARGS) { - const struct mdoc_node *nn; - if (MDOC_BODY == n->type) { + if (MDOC_BLOCK == n->type) { + synopsis_pre(p, n); + return(1); + } else if (MDOC_BODY == n->type) { p->flags |= TERMP_NOSPACE; term_word(p, "("); p->flags |= TERMP_NOSPACE; return(1); - } else if (MDOC_HEAD != n->type) - return(1); + } - term_fontpush(p, TERMFONT_BOLD); - for (nn = n->child; nn; nn = nn->next) { - assert(MDOC_TEXT == nn->type); - term_word(p, nn->string); - } - term_fontpop(p); + /* XXX: we drop non-initial arguments as per groff. */ + assert(n->child); + assert(n->child->string); + term_fontpush(p, TERMFONT_BOLD); + term_word(p, n->child->string); return(0); } @@ -2009,13 +2002,16 @@ static void termp_fo_post(DECL_ARGS) { - if (MDOC_BODY != n->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 (SEC_SYNOPSIS == n->sec) { + p->flags |= TERMP_NOSPACE; + term_word(p, ";"); + } } @@ -2098,8 +2094,6 @@ termp_li_pre(DECL_ARGS) { term_fontpush(p, TERMFONT_NONE); - if (NULL == n->child) - term_word(p, ""); return(1); }