=================================================================== RCS file: /cvs/mandoc/mdoc_man.c,v retrieving revision 1.35 retrieving revision 1.46 diff -u -p -r1.35 -r1.46 --- mandoc/mdoc_man.c 2012/07/12 08:55:48 1.35 +++ mandoc/mdoc_man.c 2012/11/19 02:14:45 1.46 @@ -1,4 +1,4 @@ -/* $Id: mdoc_man.c,v 1.35 2012/07/12 08:55:48 schwarze Exp $ */ +/* $Id: mdoc_man.c,v 1.46 2012/11/19 02:14:45 schwarze Exp $ */ /* * Copyright (c) 2011, 2012 Ingo Schwarze * @@ -28,7 +28,7 @@ #include "mdoc.h" #include "main.h" -#define DECL_ARGS const struct mdoc_meta *m, \ +#define DECL_ARGS const struct mdoc_meta *meta, \ const struct mdoc_node *n struct manact { @@ -102,6 +102,8 @@ static int pre_vt(DECL_ARGS); static int pre_ux(DECL_ARGS); static int pre_xr(DECL_ARGS); static void print_word(const char *); +static void print_line(const char *, int); +static void print_block(const char *, int); static void print_offs(const char *); static void print_width(const char *, const struct mdoc_node *, size_t); @@ -241,16 +243,26 @@ static const struct manact manacts[MDOC_MAX + 1] = { }; static int outflags; -#define MMAN_spc (1 << 0) -#define MMAN_spc_force (1 << 1) -#define MMAN_nl (1 << 2) -#define MMAN_br (1 << 3) -#define MMAN_sp (1 << 4) -#define MMAN_Sm (1 << 5) -#define MMAN_Bk (1 << 6) -#define MMAN_An_split (1 << 7) -#define MMAN_An_nosplit (1 << 8) +#define MMAN_spc (1 << 0) /* blank character before next word */ +#define MMAN_spc_force (1 << 1) /* even before trailing punctuation */ +#define MMAN_nl (1 << 2) /* break man(7) code line */ +#define MMAN_br (1 << 3) /* break output line */ +#define MMAN_sp (1 << 4) /* insert a blank output line */ +#define MMAN_PP (1 << 5) /* reset indentation etc. */ +#define MMAN_Sm (1 << 6) /* horizontal spacing mode */ +#define MMAN_Bk (1 << 7) /* word keep mode */ +#define MMAN_Bk_susp (1 << 8) /* suspend this (after a macro) */ +#define MMAN_An_split (1 << 9) /* author mode is "split" */ +#define MMAN_An_nosplit (1 << 10) /* author mode is "nosplit" */ +#define MMAN_PD (1 << 11) /* inter-paragraph spacing disabled */ +#define BL_STACK_MAX 32 + +static size_t Bl_stack[BL_STACK_MAX]; /* offsets [chars] */ +static int Bl_stack_post[BL_STACK_MAX]; /* add final .RE */ +static int Bl_stack_len; /* number of nested Bl blocks */ +static int TPremain; /* characters before tag is full */ + static struct { char *head; char *tail; @@ -267,7 +279,8 @@ font_push(char newfont) fontqueue.size); } *fontqueue.tail = newfont; - print_word("\\f"); + print_word(""); + printf("\\f"); putchar(newfont); outflags &= ~MMAN_spc; } @@ -279,7 +292,8 @@ font_pop(void) if (fontqueue.tail > fontqueue.head) fontqueue.tail--; outflags &= ~MMAN_spc; - print_word("\\f"); + print_word(""); + printf("\\f"); putchar(*fontqueue.tail); } @@ -287,48 +301,64 @@ static void print_word(const char *s) { - if ((MMAN_sp | MMAN_br | MMAN_nl) & outflags) { + if ((MMAN_PP | MMAN_sp | MMAN_br | MMAN_nl) & outflags) { /* * If we need a newline, print it now and start afresh. */ - if (MMAN_sp & outflags) + if (MMAN_PP & outflags) { + if (MMAN_sp & outflags) { + if (MMAN_PD & outflags) { + printf("\n.PD"); + outflags &= ~MMAN_PD; + } + } else if ( ! (MMAN_PD & outflags)) { + printf("\n.PD 0"); + outflags |= MMAN_PD; + } + printf("\n.PP\n"); + } else if (MMAN_sp & outflags) printf("\n.sp\n"); else if (MMAN_br & outflags) printf("\n.br\n"); else if (MMAN_nl & outflags) putchar('\n'); - outflags &= ~(MMAN_sp|MMAN_br|MMAN_nl|MMAN_spc); - } else if (MMAN_spc & outflags && '\0' != s[0]) + outflags &= ~(MMAN_PP|MMAN_sp|MMAN_br|MMAN_nl|MMAN_spc); + if (1 == TPremain) + printf(".br\n"); + TPremain = 0; + } else if (MMAN_spc & outflags) { /* * If we need a space, only print it if * (1) it is forced by `No' or * (2) what follows is not terminating punctuation or * (3) what follows is longer than one character. */ - if (MMAN_spc_force & outflags || + if (MMAN_spc_force & outflags || '\0' == s[0] || NULL == strchr(".,:;)]?!", s[0]) || '\0' != s[1]) { - if (MMAN_Bk & outflags) { + if (MMAN_Bk & outflags && + ! (MMAN_Bk_susp & outflags)) putchar('\\'); - putchar('~'); - } else - putchar(' '); + putchar(' '); + if (TPremain) + TPremain--; } + } /* * Reassign needing space if we're not following opening * punctuation. */ - if (MMAN_Sm & outflags && - (('(' != s[0] && '[' != s[0]) || '\0' != s[1])) + if (MMAN_Sm & outflags && ('\0' == s[0] || + (('(' != s[0] && '[' != s[0]) || '\0' != s[1]))) outflags |= MMAN_spc; else outflags &= ~MMAN_spc; - outflags &= ~MMAN_spc_force; + outflags &= ~(MMAN_spc_force | MMAN_Bk_susp); for ( ; *s; s++) { switch (*s) { case (ASCII_NBRSP): - printf("\\~"); + printf("\\ "); break; case (ASCII_HYPH): putchar('-'); @@ -337,16 +367,47 @@ print_word(const char *s) putchar((unsigned char)*s); break; } + if (TPremain) + TPremain--; } } static void +print_line(const char *s, int newflags) +{ + + outflags &= ~MMAN_br; + outflags |= MMAN_nl; + print_word(s); + outflags |= newflags; +} + +static void +print_block(const char *s, int newflags) +{ + + outflags &= ~MMAN_PP; + if (MMAN_sp & outflags) { + outflags &= ~(MMAN_sp | MMAN_br); + if (MMAN_PD & outflags) { + print_line(".PD", 0); + outflags &= ~MMAN_PD; + } + } else if (! (MMAN_PD & outflags)) + print_line(".PD 0", MMAN_PD); + outflags |= MMAN_nl; + print_word(s); + outflags |= MMAN_Bk_susp | newflags; +} + +static void print_offs(const char *v) { char buf[24]; struct roffsu su; size_t sz; + /* Convert v into a number (of characters). */ if (NULL == v || '\0' == *v || 0 == strcmp(v, "left")) sz = 0; else if (0 == strcmp(v, "indent")) @@ -354,11 +415,29 @@ print_offs(const char *v) else if (0 == strcmp(v, "indent-two")) sz = 12; else if (a2roffsu(v, &su, SCALE_MAX)) { - print_word(v); - return; + if (SCALE_EN == su.unit) + sz = su.scale; + else { + /* + * XXX + * If we are inside an enclosing list, + * there is no easy way to add the two + * indentations because they are provided + * in terms of different units. + */ + print_word(v); + return; + } } else sz = strlen(v); + /* + * We are inside an enclosing list. + * Add the two indentations. + */ + if (Bl_stack_len) + sz += Bl_stack[Bl_stack_len - 1]; + snprintf(buf, sizeof(buf), "%ldn", sz); print_word(buf); } @@ -369,33 +448,58 @@ print_width(const char *v, const struct mdoc_node *chi char buf[24]; struct roffsu su; size_t sz, chsz; + int numeric, remain; - /* XXX Rough estimation, might have multiple parts. */ - chsz = (NULL != child && MDOC_TEXT == child->type) ? - strlen(child->string) : 0; + numeric = 1; + remain = 0; + /* Convert v into a number (of characters). */ if (NULL == v) sz = defsz; else if (a2roffsu(v, &su, SCALE_MAX)) { if (SCALE_EN == su.unit) sz = su.scale; else { - if (chsz) - print_word(".HP"); - else - print_word(".TP"); - print_word(v); - return; + sz = 0; + numeric = 0; } } else sz = strlen(v); - if (chsz > sz) - print_word(".HP"); - else - print_word(".TP"); - snprintf(buf, sizeof(buf), "%ldn", sz + 2); - print_word(buf); + /* XXX Rough estimation, might have multiple parts. */ + chsz = (NULL != child && MDOC_TEXT == child->type) ? + strlen(child->string) : 0; + + /* + * If we are inside an enclosing list, + * preserve its indentation. + */ + if (Bl_stack_len && Bl_stack[Bl_stack_len - 1]) { + print_line(".RS", MMAN_Bk_susp); + snprintf(buf, sizeof(buf), "%ldn", + Bl_stack[Bl_stack_len - 1]); + print_word(buf); + } + + /* + * Save our own indentation, + * such that child lists can use it. + */ + Bl_stack[Bl_stack_len++] = sz + 2; + + /* Set up the current list. */ + if (defsz && chsz > sz) + print_block(".HP", 0); + else { + print_block(".TP", 0); + remain = sz + 2; + } + if (numeric) { + snprintf(buf, sizeof(buf), "%ldn", sz + 2); + print_word(buf); + } else + print_word(v); + TPremain = remain; } void @@ -423,22 +527,26 @@ man_man(void *arg, const struct man *man) void man_mdoc(void *arg, const struct mdoc *mdoc) { - const struct mdoc_meta *m; + const struct mdoc_meta *meta; const struct mdoc_node *n; - m = mdoc_meta(mdoc); + meta = mdoc_meta(mdoc); n = mdoc_node(mdoc); - printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"", - m->title, m->msec, m->date, m->os, m->vol); + printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"\n", + meta->title, meta->msec, meta->date, + meta->os, meta->vol); + /* Disable hyphenation and if nroff, disable justification. */ + printf(".nh\n.if n .ad l"); + outflags = MMAN_nl | MMAN_Sm; if (0 == fontqueue.size) { fontqueue.size = 8; fontqueue.head = fontqueue.tail = mandoc_malloc(8); *fontqueue.tail = 'R'; } - print_node(m, n); + print_node(meta, n); putchar('\n'); } @@ -448,7 +556,7 @@ print_node(DECL_ARGS) const struct mdoc_node *prev, *sub; const struct manact *act; int cond, do_sub; - + /* * Break the line if we were parsed subsequent the current node. * This makes the page structure be more consistent. @@ -468,7 +576,8 @@ print_node(DECL_ARGS) */ if (MMAN_nl & outflags && ('.' == *n->string || '\'' == *n->string)) { - print_word("\\&"); + print_word(""); + printf("\\&"); outflags &= ~MMAN_spc; } print_word(n->string); @@ -478,9 +587,9 @@ print_node(DECL_ARGS) * node. */ act = manacts + n->tok; - cond = NULL == act->cond || (*act->cond)(m, n); + cond = NULL == act->cond || (*act->cond)(meta, n); if (cond && act->pre) - do_sub = (*act->pre)(m, n); + do_sub = (*act->pre)(meta, n); } /* @@ -490,13 +599,13 @@ print_node(DECL_ARGS) */ if (do_sub) for (sub = n->child; sub; sub = sub->next) - print_node(m, sub); + print_node(meta, sub); /* * Lastly, conditionally run the post-node handler. */ if (cond && act->post) - (*act->post)(m, n); + (*act->post)(meta, n); } static int @@ -568,7 +677,8 @@ pre__t(DECL_ARGS) if (n->parent && MDOC_Rs == n->parent->tok && n->parent->norm->Rs.quote_T) { - print_word("\""); + print_word(""); + putchar('\"'); outflags &= ~MMAN_spc; } else font_push('I'); @@ -582,10 +692,11 @@ post__t(DECL_ARGS) if (n->parent && MDOC_Rs == n->parent->tok && n->parent->norm->Rs.quote_T) { outflags &= ~MMAN_spc; - print_word("\""); + print_word(""); + putchar('\"'); } else font_pop(); - post_percent(m, n); + post_percent(meta, n); } /* @@ -595,12 +706,25 @@ static int pre_sect(DECL_ARGS) { - if (MDOC_HEAD != n->type) - return(1); - outflags |= MMAN_nl; - print_word(manacts[n->tok].prefix); - print_word("\""); - outflags &= ~MMAN_spc; + switch (n->type) { + case (MDOC_HEAD): + outflags |= MMAN_sp; + print_block(manacts[n->tok].prefix, 0); + print_word(""); + putchar('\"'); + outflags &= ~MMAN_spc; + break; + case (MDOC_BODY): + if (MDOC_Sh == n->tok) { + if (MDOC_SYNPRETTY & n->flags) + outflags |= MMAN_Bk; + else + outflags &= ~MMAN_Bk; + } + break; + default: + break; + } return(1); } @@ -614,7 +738,8 @@ post_sect(DECL_ARGS) if (MDOC_HEAD != n->type) return; outflags &= ~MMAN_spc; - print_word("\""); + print_word(""); + putchar('\"'); outflags |= MMAN_nl; if (MDOC_Sh == n->tok && SEC_AUTHORS == n->sec) outflags &= ~(MMAN_An_split | MMAN_An_nosplit); @@ -697,15 +822,14 @@ static int pre_bd(DECL_ARGS) { - if (0 == n->norm->Bd.comp) - outflags |= MMAN_sp; + outflags &= ~(MMAN_PP | MMAN_sp | MMAN_br); + if (DISP_unfilled == n->norm->Bd.type || - DISP_literal == n->norm->Bd.type) { - outflags |= MMAN_nl; - print_word(".nf"); - } - outflags |= MMAN_nl; - print_word(".RS"); + DISP_literal == n->norm->Bd.type) + print_line(".nf", 0); + if (0 == n->norm->Bd.comp && NULL != n->parent->prev) + outflags |= MMAN_sp; + print_line(".RS", MMAN_Bk_susp); print_offs(n->norm->Bd.offs); outflags |= MMAN_nl; return(1); @@ -714,15 +838,28 @@ pre_bd(DECL_ARGS) static void post_bd(DECL_ARGS) { + char buf[24]; - outflags |= MMAN_nl; - print_word(".RE"); + /* Close out this display. */ + print_line(".RE", MMAN_nl); if (DISP_unfilled == n->norm->Bd.type || - DISP_literal == n->norm->Bd.type) { - outflags |= MMAN_nl; - print_word(".fi"); + DISP_literal == n->norm->Bd.type) + print_line(".fi", MMAN_nl); + + /* + * If we are inside an enclosing list and the current + * list item is not yet finished, restore the correct + * indentation for what remains of that item. + */ + if (NULL != n->parent->next && + Bl_stack_len && Bl_stack[Bl_stack_len - 1]) { + print_line(".RS", MMAN_Bk_susp); + snprintf(buf, sizeof(buf), "%ldn", + Bl_stack[Bl_stack_len - 1]); + print_word(buf); + /* Remeber to close out this .RS block later. */ + Bl_stack_post[Bl_stack_len - 1] = 1; } - outflags |= MMAN_nl; } static int @@ -797,12 +934,11 @@ pre_bl(DECL_ARGS) return(1); } - outflags |= MMAN_nl; - print_word(".TS"); - outflags |= MMAN_nl; + print_line(".TS", MMAN_nl); for (icol = 0; icol < n->norm->Bl.ncols; icol++) print_word("l"); print_word("."); + outflags |= MMAN_nl; return(1); } @@ -811,17 +947,17 @@ post_bl(DECL_ARGS) { switch (n->norm->Bl.type) { + case (LIST_column): + print_line(".TE", 0); + break; case (LIST_enum): n->norm->Bl.count = 0; break; - case (LIST_column): - outflags |= MMAN_nl; - print_word(".TE"); - break; default: break; } - outflags |= MMAN_br; + outflags |= MMAN_PP | MMAN_nl; + outflags &= ~(MMAN_sp | MMAN_br); } static int @@ -856,9 +992,7 @@ static int pre_dl(DECL_ARGS) { - outflags |= MMAN_nl; - print_word(".RS 6n"); - outflags |= MMAN_nl; + print_line(".RS 6n", MMAN_nl); return(1); } @@ -866,9 +1000,7 @@ static void post_dl(DECL_ARGS) { - outflags |= MMAN_nl; - print_word(".RE"); - outflags |= MMAN_nl; + print_line(".RE", MMAN_nl); } static int @@ -896,7 +1028,7 @@ pre_fa(DECL_ARGS) while (NULL != n) { font_push('I'); - print_node(m, n); + print_node(meta, n); font_pop(); if (NULL != (n = n->next)) print_word(","); @@ -934,7 +1066,7 @@ pre_fl(DECL_ARGS) { font_push('B'); - print_word("-"); + print_word("\\-"); outflags &= ~MMAN_spc; return(1); } @@ -960,7 +1092,7 @@ pre_fn(DECL_ARGS) return(0); font_push('B'); - print_node(m, n); + print_node(meta, n); font_pop(); outflags &= ~MMAN_spc; print_word("("); @@ -968,7 +1100,7 @@ pre_fn(DECL_ARGS) n = n->next; if (NULL != n) - pre_fa(m, n); + pre_fa(meta, n); return(0); } @@ -1014,7 +1146,7 @@ post_fo(DECL_ARGS) font_pop(); break; case (MDOC_BODY): - post_fn(m, n); + post_fn(meta, n); break; default: break; @@ -1070,28 +1202,25 @@ pre_it(DECL_ARGS) switch (n->type) { case (MDOC_HEAD): - outflags |= MMAN_nl; + outflags |= MMAN_PP | MMAN_nl; bln = n->parent->parent; + if (0 == bln->norm->Bl.comp || + (NULL == n->parent->prev && + NULL == bln->parent->prev)) + outflags |= MMAN_sp; + outflags &= ~MMAN_br; switch (bln->norm->Bl.type) { case (LIST_item): - if (bln->norm->Bl.comp) - outflags |= MMAN_br; - else - outflags |= MMAN_sp; return(0); case (LIST_inset): /* FALLTHROUGH */ case (LIST_diag): /* FALLTHROUGH */ case (LIST_ohang): - if (bln->norm->Bl.comp) - outflags |= MMAN_br; - else - outflags |= MMAN_sp; if (bln->norm->Bl.type == LIST_diag) - print_word(".B \""); + print_line(".B \"", 0); else - print_word(".R \""); + print_line(".R \"", 0); outflags &= ~MMAN_spc; return(1); case (LIST_bullet): @@ -1100,6 +1229,7 @@ pre_it(DECL_ARGS) /* FALLTHROUGH */ case (LIST_hyphen): print_width(bln->norm->Bl.width, NULL, 0); + TPremain = 0; outflags |= MMAN_nl; font_push('B'); if (LIST_bullet == bln->norm->Bl.type) @@ -1110,15 +1240,19 @@ pre_it(DECL_ARGS) break; case (LIST_enum): print_width(bln->norm->Bl.width, NULL, 0); + TPremain = 0; outflags |= MMAN_nl; print_count(&bln->norm->Bl.count); break; case (LIST_hang): print_width(bln->norm->Bl.width, n->child, 6); + TPremain = 0; break; case (LIST_tag): - print_width(bln->norm->Bl.width, NULL, 8); - break; + print_width(bln->norm->Bl.width, n->child, 0); + putchar('\n'); + outflags &= ~MMAN_spc; + return(1); default: return(1); } @@ -1151,10 +1285,46 @@ post_it(DECL_ARGS) } break; case (MDOC_BODY): - if (LIST_column == bln->norm->Bl.type && - NULL != n->next) { - putchar('\t'); - outflags &= ~MMAN_spc; + switch (bln->norm->Bl.type) { + case (LIST_bullet): + /* FALLTHROUGH */ + case (LIST_dash): + /* FALLTHROUGH */ + case (LIST_hyphen): + /* FALLTHROUGH */ + case (LIST_enum): + /* FALLTHROUGH */ + case (LIST_hang): + /* FALLTHROUGH */ + case (LIST_tag): + assert(Bl_stack_len); + Bl_stack[--Bl_stack_len] = 0; + + /* + * Our indentation had to be restored + * after a child display. + * Close out that indentation block now. + */ + if (Bl_stack_post[Bl_stack_len]) { + print_line(".RE", MMAN_nl); + Bl_stack_post[Bl_stack_len] = 0; + } + + /* + * We are inside an enclosing list. + * Restore the indentation of that list. + */ + if (Bl_stack_len && Bl_stack[Bl_stack_len - 1]) + print_line(".RE", MMAN_nl); + break; + case (LIST_column): + if (NULL != n->next) { + putchar('\t'); + outflags &= ~MMAN_spc; + } + break; + default: + break; } break; default: @@ -1205,16 +1375,25 @@ pre_li(DECL_ARGS) static int pre_nm(DECL_ARGS) { + char *name; if (MDOC_BLOCK == n->type) pre_syn(n); if (MDOC_ELEM != n->type && MDOC_HEAD != n->type) return(1); - if (NULL == n->child && NULL == m->name) + name = n->child ? n->child->string : meta->name; + if (NULL == name) return(0); + if (MDOC_HEAD == n->type) { + if (NULL == n->parent->prev) + outflags |= MMAN_sp; + print_block(".HP", 0); + printf(" %ldn", strlen(name) + 1); + outflags |= MMAN_nl; + } font_push('B'); if (NULL == n->child) - print_word(m->name); + print_word(meta->name); return(1); } @@ -1254,12 +1433,10 @@ static int pre_pp(DECL_ARGS) { - outflags |= MMAN_nl; - if (MDOC_It == n->parent->tok) - print_word(".sp"); - else - print_word(".PP"); - outflags |= MMAN_nl; + if (MDOC_It != n->parent->tok) + outflags |= MMAN_PP; + outflags |= MMAN_sp | MMAN_nl; + outflags &= ~MMAN_br; return(0); } @@ -1268,9 +1445,8 @@ pre_rs(DECL_ARGS) { if (SEC_SEE_ALSO == n->sec) { - outflags |= MMAN_nl; - print_word(".PP"); - outflags |= MMAN_nl; + outflags |= MMAN_PP | MMAN_sp | MMAN_nl; + outflags &= ~MMAN_br; } return(1); } @@ -1291,8 +1467,11 @@ static int pre_sp(DECL_ARGS) { - outflags |= MMAN_nl; - print_word(".sp"); + if (MMAN_PP & outflags) { + outflags &= ~MMAN_PP; + print_line(".PP", 0); + } else + print_line(".sp", 0); return(1); } @@ -1346,13 +1525,13 @@ pre_xr(DECL_ARGS) n = n->child; if (NULL == n) return(0); - print_node(m, n); + print_node(meta, n); n = n->next; if (NULL == n) return(0); outflags &= ~MMAN_spc; print_word("("); - print_node(m, n); + print_node(meta, n); print_word(")"); return(0); } @@ -1365,7 +1544,7 @@ pre_ux(DECL_ARGS) if (NULL == n->child) return(0); outflags &= ~MMAN_spc; - print_word("\\~"); + print_word("\\ "); outflags &= ~MMAN_spc; return(1); }