=================================================================== RCS file: /cvs/mandoc/mdoc_man.c,v retrieving revision 1.22 retrieving revision 1.26 diff -u -p -r1.22 -r1.26 --- mandoc/mdoc_man.c 2012/07/08 16:52:20 1.22 +++ mandoc/mdoc_man.c 2012/07/09 17:53:01 1.26 @@ -1,4 +1,4 @@ -/* $Id: mdoc_man.c,v 1.22 2012/07/08 16:52:20 schwarze Exp $ */ +/* $Id: mdoc_man.c,v 1.26 2012/07/09 17:53:01 schwarze Exp $ */ /* * Copyright (c) 2011, 2012 Ingo Schwarze * @@ -41,13 +41,17 @@ struct manact { static int cond_body(DECL_ARGS); static int cond_head(DECL_ARGS); +static void font_push(char); +static void font_pop(void); static void post_bd(DECL_ARGS); static void post_bk(DECL_ARGS); static void post_dl(DECL_ARGS); static void post_enc(DECL_ARGS); static void post_fa(DECL_ARGS); +static void post_fl(DECL_ARGS); static void post_fn(DECL_ARGS); static void post_fo(DECL_ARGS); +static void post_font(DECL_ARGS); static void post_in(DECL_ARGS); static void post_lb(DECL_ARGS); static void post_nm(DECL_ARGS); @@ -64,17 +68,25 @@ static int pre_br(DECL_ARGS); static int pre_bx(DECL_ARGS); static int pre_dl(DECL_ARGS); static int pre_enc(DECL_ARGS); +static int pre_em(DECL_ARGS); static int pre_fa(DECL_ARGS); +static int pre_fl(DECL_ARGS); static int pre_fn(DECL_ARGS); static int pre_fo(DECL_ARGS); +static int pre_ft(DECL_ARGS); static int pre_in(DECL_ARGS); static int pre_it(DECL_ARGS); +static int pre_lk(DECL_ARGS); +static int pre_li(DECL_ARGS); static int pre_nm(DECL_ARGS); +static int pre_no(DECL_ARGS); static int pre_ns(DECL_ARGS); static int pre_pp(DECL_ARGS); static int pre_sm(DECL_ARGS); static int pre_sp(DECL_ARGS); static int pre_sect(DECL_ARGS); +static int pre_sy(DECL_ARGS); +static void pre_syn(const struct mdoc_node *); static int pre_vt(DECL_ARGS); static int pre_ux(DECL_ARGS); static int pre_xr(DECL_ARGS); @@ -97,37 +109,37 @@ static const struct manact manacts[MDOC_MAX + 1] = { { NULL, NULL, NULL, NULL, NULL }, /* Bl */ { NULL, NULL, NULL, NULL, NULL }, /* El */ { NULL, pre_it, NULL, NULL, NULL }, /* _It */ - { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* Ad */ + { NULL, pre_em, post_font, NULL, NULL }, /* Ad */ { NULL, pre_an, NULL, NULL, NULL }, /* An */ - { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* Ar */ - { NULL, pre_enc, post_enc, "\\fB", "\\fP" }, /* Cd */ - { NULL, pre_enc, post_enc, "\\fB", "\\fP" }, /* Cm */ - { NULL, pre_enc, post_enc, "\\fR", "\\fP" }, /* Dv */ - { NULL, pre_enc, post_enc, "\\fR", "\\fP" }, /* Er */ - { NULL, pre_enc, post_enc, "\\fR", "\\fP" }, /* Ev */ + { NULL, pre_em, post_font, NULL, NULL }, /* Ar */ + { NULL, pre_sy, post_font, NULL, NULL }, /* Cd */ + { NULL, pre_sy, post_font, NULL, NULL }, /* Cm */ + { NULL, pre_li, post_font, NULL, NULL }, /* Dv */ + { NULL, pre_li, post_font, NULL, NULL }, /* Er */ + { NULL, pre_li, post_font, NULL, NULL }, /* Ev */ { NULL, pre_enc, post_enc, "The \\fB", "\\fP\nutility exits 0 on success, and >0 if an error occurs." }, /* Ex */ { NULL, pre_fa, post_fa, NULL, NULL }, /* Fa */ { NULL, NULL, NULL, NULL, NULL }, /* _Fd */ - { NULL, pre_enc, post_enc, "\\fB-", "\\fP" }, /* Fl */ + { NULL, pre_fl, post_fl, NULL, NULL }, /* Fl */ { NULL, pre_fn, post_fn, NULL, NULL }, /* Fn */ - { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* Ft */ - { NULL, pre_enc, post_enc, "\\fB", "\\fP" }, /* Ic */ + { NULL, pre_ft, post_font, NULL, NULL }, /* Ft */ + { NULL, pre_sy, post_font, NULL, NULL }, /* Ic */ { NULL, pre_in, post_in, NULL, NULL }, /* In */ - { NULL, pre_enc, post_enc, "\\fR", "\\fP" }, /* Li */ + { NULL, pre_li, post_font, NULL, NULL }, /* Li */ { cond_head, pre_enc, NULL, "\\- ", NULL }, /* Nd */ { NULL, pre_nm, post_nm, NULL, NULL }, /* Nm */ { cond_body, pre_enc, post_enc, "[", "]" }, /* Op */ { NULL, NULL, NULL, NULL, NULL }, /* Ot */ - { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* Pa */ + { NULL, pre_em, post_font, NULL, NULL }, /* Pa */ { NULL, pre_enc, post_enc, "The \\fB", "\\fP\nfunction returns the value 0 if successful;\n" "otherwise the value -1 is returned and the global\n" "variable \\fIerrno\\fP is set to indicate the error." }, /* Rv */ { NULL, NULL, NULL, NULL, NULL }, /* St */ - { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* Va */ + { NULL, pre_em, post_font, NULL, NULL }, /* Va */ { NULL, pre_vt, post_vt, NULL, NULL }, /* Vt */ { NULL, pre_xr, NULL, NULL, NULL }, /* Xr */ { NULL, NULL, post_percent, NULL, NULL }, /* _%A */ @@ -157,11 +169,11 @@ static const struct manact manacts[MDOC_MAX + 1] = { { cond_body, pre_enc, post_enc, "``", "''" }, /* Dq */ { NULL, NULL, NULL, NULL, NULL }, /* _Ec */ { NULL, NULL, NULL, NULL, NULL }, /* _Ef */ - { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* Em */ + { NULL, pre_em, post_font, NULL, NULL }, /* Em */ { NULL, NULL, NULL, NULL, NULL }, /* _Eo */ { NULL, pre_ux, NULL, "FreeBSD", NULL }, /* Fx */ - { NULL, pre_enc, post_enc, "\\fB", "\\fP" }, /* Ms */ - { NULL, NULL, NULL, NULL, NULL }, /* No */ + { NULL, pre_sy, post_font, NULL, NULL }, /* Ms */ + { NULL, pre_no, NULL, NULL, NULL }, /* No */ { NULL, pre_ns, NULL, NULL, NULL }, /* Ns */ { NULL, pre_ux, NULL, "NetBSD", NULL }, /* Nx */ { NULL, pre_ux, NULL, "OpenBSD", NULL }, /* Ox */ @@ -179,9 +191,9 @@ static const struct manact manacts[MDOC_MAX + 1] = { { cond_body, pre_enc, post_enc, "`", "'" }, /* So */ { cond_body, pre_enc, post_enc, "`", "'" }, /* Sq */ { NULL, pre_sm, NULL, NULL, NULL }, /* Sm */ - { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* Sx */ - { NULL, pre_enc, post_enc, "\\fB", "\\fP" }, /* Sy */ - { NULL, pre_enc, post_enc, "\\fR", "\\fP" }, /* Tn */ + { NULL, pre_em, post_font, NULL, NULL }, /* Sx */ + { NULL, pre_sy, post_font, NULL, NULL }, /* Sy */ + { NULL, pre_li, post_font, NULL, NULL }, /* Tn */ { NULL, pre_ux, NULL, "UNIX", NULL }, /* Ux */ { NULL, NULL, NULL, NULL, NULL }, /* _Xc */ { NULL, NULL, NULL, NULL, NULL }, /* _Xo */ @@ -197,8 +209,8 @@ static const struct manact manacts[MDOC_MAX + 1] = { { NULL, pre_ux, NULL, "currently under development.", NULL }, /* Ud */ { NULL, NULL, post_lb, NULL, NULL }, /* Lb */ { NULL, pre_pp, NULL, NULL, NULL }, /* Lp */ - { NULL, NULL, NULL, NULL, NULL }, /* _Lk */ - { NULL, NULL, NULL, NULL, NULL }, /* _Mt */ + { NULL, pre_lk, NULL, NULL, NULL }, /* Lk */ + { NULL, pre_em, post_font, NULL, NULL }, /* Mt */ { cond_body, pre_enc, post_enc, "{", "}" }, /* Brq */ { cond_body, pre_enc, post_enc, "{", "}" }, /* Bro */ { NULL, NULL, NULL, NULL, NULL }, /* Brc */ @@ -216,15 +228,48 @@ static const struct manact manacts[MDOC_MAX + 1] = { static int outflags; #define MMAN_spc (1 << 0) -#define MMAN_nl (1 << 1) -#define MMAN_br (1 << 2) -#define MMAN_sp (1 << 3) -#define MMAN_Sm (1 << 4) -#define MMAN_Bk (1 << 5) -#define MMAN_An_split (1 << 6) -#define MMAN_An_nosplit (1 << 7) +#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) +static struct { + char *head; + char *tail; + size_t size; +} fontqueue; + static void +font_push(char newfont) +{ + + if (fontqueue.head + fontqueue.size <= ++fontqueue.tail) { + fontqueue.size += 8; + fontqueue.head = mandoc_realloc(fontqueue.head, + fontqueue.size); + } + *fontqueue.tail = newfont; + print_word("\\f"); + putchar(newfont); + outflags &= ~MMAN_spc; +} + +static void +font_pop(void) +{ + + if (fontqueue.tail > fontqueue.head) + fontqueue.tail--; + outflags &= ~MMAN_spc; + print_word("\\f"); + putchar(*fontqueue.tail); +} + +static void print_word(const char *s) { @@ -241,12 +286,13 @@ print_word(const char *s) outflags &= ~(MMAN_sp|MMAN_br|MMAN_nl|MMAN_spc); } else if (MMAN_spc & outflags && '\0' != s[0]) /* - * If we need a space, only print it before - * (1) a nonzero length word; - * (2) a word that is non-punctuation; and - * (3) if punctuation, non-terminating puncutation. + * 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 (NULL == strchr(".,:;)]?!", s[0]) || '\0' != s[1]) { + if (MMAN_spc_force & outflags || + NULL == strchr(".,:;)]?!", s[0]) || '\0' != s[1]) { if (MMAN_Bk & outflags) { putchar('\\'); putchar('~'); @@ -263,6 +309,7 @@ print_word(const char *s) outflags |= MMAN_spc; else outflags &= ~MMAN_spc; + outflags &= ~MMAN_spc_force; for ( ; *s; s++) { switch (*s) { @@ -328,6 +375,11 @@ man_mdoc(void *arg, const struct mdoc *mdoc) m->title, m->msec, m->date, m->os, m->vol); 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); putchar('\n'); } @@ -404,10 +456,6 @@ cond_body(DECL_ARGS) return(MDOC_BODY == n->type); } -/* - * Output a font encoding before a node, e.g., \fR. - * This obviously has no trailing space. - */ static int pre_enc(DECL_ARGS) { @@ -421,9 +469,6 @@ pre_enc(DECL_ARGS) return(1); } -/* - * Output a font encoding subsequent a node, e.g., \fP. - */ static void post_enc(DECL_ARGS) { @@ -434,10 +479,15 @@ post_enc(DECL_ARGS) return; outflags &= ~MMAN_spc; print_word(suffix); - if (MDOC_Fl == n->tok && 0 == n->nchild) - outflags &= ~MMAN_spc; } +static void +post_font(DECL_ARGS) +{ + + font_pop(); +} + /* * Used in listings (percent = %A, e.g.). * FIXME: this is incomplete. @@ -488,6 +538,46 @@ post_sect(DECL_ARGS) outflags &= ~(MMAN_An_split | MMAN_An_nosplit); } +/* See mdoc_term.c, synopsis_pre() for comments. */ +static void +pre_syn(const struct mdoc_node *n) +{ + + if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags)) + return; + + if (n->prev->tok == n->tok && + MDOC_Ft != n->tok && + MDOC_Fo != n->tok && + MDOC_Fn != n->tok) { + outflags |= MMAN_br; + return; + } + + switch (n->prev->tok) { + case (MDOC_Fd): + /* FALLTHROUGH */ + case (MDOC_Fn): + /* FALLTHROUGH */ + case (MDOC_Fo): + /* FALLTHROUGH */ + case (MDOC_In): + /* FALLTHROUGH */ + case (MDOC_Vt): + outflags |= MMAN_sp; + break; + case (MDOC_Ft): + if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) { + outflags |= MMAN_sp; + break; + } + /* FALLTHROUGH */ + default: + outflags |= MMAN_br; + break; + } +} + static int pre_an(DECL_ARGS) { @@ -624,6 +714,14 @@ post_dl(DECL_ARGS) } static int +pre_em(DECL_ARGS) +{ + + font_push('I'); + return(1); +} + +static int pre_fa(DECL_ARGS) { @@ -631,11 +729,9 @@ pre_fa(DECL_ARGS) n = n->child; while (NULL != n) { - print_word("\\fI"); - outflags &= ~MMAN_spc; + font_push('I'); print_node(m, n); - outflags &= ~MMAN_spc; - print_word("\\fP"); + font_pop(); if (NULL != (n = n->next)) print_word(","); } @@ -651,20 +747,39 @@ post_fa(DECL_ARGS) } static int +pre_fl(DECL_ARGS) +{ + + font_push('B'); + print_word("-"); + outflags &= ~MMAN_spc; + return(1); +} + +static void +post_fl(DECL_ARGS) +{ + + font_pop(); + if (0 == n->nchild) + outflags &= ~MMAN_spc; +} + +static int pre_fn(DECL_ARGS) { + pre_syn(n); + n = n->child; if (NULL == n) return(0); - if (MDOC_SYNPRETTY & n->flags) - outflags |= MMAN_br; - print_word("\\fB"); - outflags &= ~MMAN_spc; + font_push('B'); print_node(m, n); + font_pop(); outflags &= ~MMAN_spc; - print_word("\\fP("); + print_word("("); outflags &= ~MMAN_spc; return(pre_fa(m, n->next)); } @@ -685,11 +800,11 @@ pre_fo(DECL_ARGS) { switch (n->type) { + case (MDOC_BLOCK): + pre_syn(n); + break; case (MDOC_HEAD): - if (MDOC_SYNPRETTY & n->flags) - outflags |= MMAN_br; - print_word("\\fB"); - outflags &= ~MMAN_spc; + font_push('B'); break; case (MDOC_BODY): outflags &= ~MMAN_spc; @@ -708,8 +823,7 @@ post_fo(DECL_ARGS) switch (n->type) { case (MDOC_HEAD): - outflags &= ~MMAN_spc; - print_word("\\fP"); + font_pop(); break; case (MDOC_BODY): post_fn(m, n); @@ -720,15 +834,28 @@ post_fo(DECL_ARGS) } static int +pre_ft(DECL_ARGS) +{ + + pre_syn(n); + font_push('I'); + return(1); +} + +static int pre_in(DECL_ARGS) { if (MDOC_SYNPRETTY & n->flags) { - outflags |= MMAN_br; - print_word("\\fB#include <"); - } else - print_word("<\\fI"); - outflags &= ~MMAN_spc; + pre_syn(n); + font_push('B'); + print_word("#include <"); + outflags &= ~MMAN_spc; + } else { + print_word("<"); + outflags &= ~MMAN_spc; + font_push('I'); + } return(1); } @@ -736,12 +863,16 @@ static void post_in(DECL_ARGS) { - outflags &= ~MMAN_spc; if (MDOC_SYNPRETTY & n->flags) { - print_word(">\\fP"); + outflags &= ~MMAN_spc; + print_word(">"); + font_pop(); outflags |= MMAN_br; - } else - print_word("\\fP>"); + } else { + font_pop(); + outflags &= ~MMAN_spc; + print_word(">"); + } } static int @@ -778,15 +909,48 @@ post_lb(DECL_ARGS) } static int +pre_lk(DECL_ARGS) +{ + const struct mdoc_node *link, *descr; + + if (NULL == (link = n->child)) + return(0); + + if (NULL != (descr = link->next)) { + font_push('I'); + while (NULL != descr) { + print_word(descr->string); + descr = descr->next; + } + print_word(":"); + font_pop(); + } + + font_push('B'); + print_word(link->string); + font_pop(); + return(0); +} + +static int +pre_li(DECL_ARGS) +{ + + font_push('R'); + return(1); +} + +static int pre_nm(DECL_ARGS) { + if (MDOC_BLOCK == n->type) + pre_syn(n); if (MDOC_ELEM != n->type && MDOC_HEAD != n->type) return(1); - if (MDOC_SYNPRETTY & n->flags) - outflags |= MMAN_br; - print_word("\\fB"); - outflags &= ~MMAN_spc; + if (NULL == n->child && NULL == m->name) + return(0); + font_push('B'); if (NULL == n->child) print_word(m->name); return(1); @@ -798,11 +962,18 @@ post_nm(DECL_ARGS) if (MDOC_ELEM != n->type && MDOC_HEAD != n->type) return; - outflags &= ~MMAN_spc; - print_word("\\fP"); + font_pop(); } static int +pre_no(DECL_ARGS) +{ + + outflags |= MMAN_spc_force; + return(1); +} + +static int pre_ns(DECL_ARGS) { @@ -859,22 +1030,29 @@ post_sp(DECL_ARGS) } static int +pre_sy(DECL_ARGS) +{ + + font_push('B'); + return(1); +} + +static int pre_vt(DECL_ARGS) { if (MDOC_SYNPRETTY & n->flags) { switch (n->type) { case (MDOC_BLOCK): + pre_syn(n); return(1); case (MDOC_BODY): break; default: return(0); } - outflags |= MMAN_br; } - print_word("\\fI"); - outflags &= ~MMAN_spc; + font_push('I'); return(1); } @@ -884,11 +1062,7 @@ post_vt(DECL_ARGS) if (MDOC_SYNPRETTY & n->flags && MDOC_BODY != n->type) return; - - outflags &= ~MMAN_spc; - print_word("\\fP"); - if (MDOC_SYNPRETTY & n->flags) - outflags |= MMAN_br; + font_pop(); } static int