=================================================================== RCS file: /cvs/mandoc/mdoc_man.c,v retrieving revision 1.26 retrieving revision 1.69 diff -u -p -r1.26 -r1.69 --- mandoc/mdoc_man.c 2012/07/09 17:53:01 1.26 +++ mandoc/mdoc_man.c 2014/08/10 23:54:41 1.69 @@ -1,6 +1,6 @@ -/* $Id: mdoc_man.c,v 1.26 2012/07/09 17:53:01 schwarze Exp $ */ +/* $Id: mdoc_man.c,v 1.69 2014/08/10 23:54:41 schwarze Exp $ */ /* - * Copyright (c) 2011, 2012 Ingo Schwarze + * Copyright (c) 2011, 2012, 2013, 2014 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -14,21 +14,22 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -#ifdef HAVE_CONFIG_H #include "config.h" -#endif +#include + #include #include #include #include "mandoc.h" +#include "mandoc_aux.h" #include "out.h" #include "man.h" #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 { @@ -43,16 +44,24 @@ static int cond_body(DECL_ARGS); static int cond_head(DECL_ARGS); static void font_push(char); static void font_pop(void); +static void mid_it(void); +static void post__t(DECL_ARGS); static void post_bd(DECL_ARGS); +static void post_bf(DECL_ARGS); static void post_bk(DECL_ARGS); +static void post_bl(DECL_ARGS); static void post_dl(DECL_ARGS); +static void post_en(DECL_ARGS); static void post_enc(DECL_ARGS); +static void post_eo(DECL_ARGS); static void post_fa(DECL_ARGS); +static void post_fd(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_it(DECL_ARGS); static void post_lb(DECL_ARGS); static void post_nm(DECL_ARGS); static void post_percent(DECL_ARGS); @@ -60,16 +69,23 @@ static void post_pf(DECL_ARGS); static void post_sect(DECL_ARGS); static void post_sp(DECL_ARGS); static void post_vt(DECL_ARGS); +static int pre__t(DECL_ARGS); static int pre_an(DECL_ARGS); static int pre_ap(DECL_ARGS); static int pre_bd(DECL_ARGS); +static int pre_bf(DECL_ARGS); static int pre_bk(DECL_ARGS); +static int pre_bl(DECL_ARGS); static int pre_br(DECL_ARGS); static int pre_bx(DECL_ARGS); static int pre_dl(DECL_ARGS); +static int pre_en(DECL_ARGS); static int pre_enc(DECL_ARGS); static int pre_em(DECL_ARGS); +static int pre_es(DECL_ARGS); +static int pre_ex(DECL_ARGS); static int pre_fa(DECL_ARGS); +static int pre_fd(DECL_ARGS); static int pre_fl(DECL_ARGS); static int pre_fn(DECL_ARGS); static int pre_fo(DECL_ARGS); @@ -78,10 +94,13 @@ 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_ll(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_rs(DECL_ARGS); +static int pre_rv(DECL_ARGS); static int pre_sm(DECL_ARGS); static int pre_sp(DECL_ARGS); static int pre_sect(DECL_ARGS); @@ -91,7 +110,12 @@ 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); +static void print_count(int *); static void print_node(DECL_ARGS); static const struct manact manacts[MDOC_MAX + 1] = { @@ -106,9 +130,9 @@ static const struct manact manacts[MDOC_MAX + 1] = { { cond_body, pre_dl, post_dl, NULL, NULL }, /* Dl */ { cond_body, pre_bd, post_bd, NULL, NULL }, /* Bd */ { NULL, NULL, NULL, NULL, NULL }, /* Ed */ - { NULL, NULL, NULL, NULL, NULL }, /* Bl */ + { cond_body, pre_bl, post_bl, NULL, NULL }, /* Bl */ { NULL, NULL, NULL, NULL, NULL }, /* El */ - { NULL, pre_it, NULL, NULL, NULL }, /* _It */ + { NULL, pre_it, post_it, NULL, NULL }, /* It */ { NULL, pre_em, post_font, NULL, NULL }, /* Ad */ { NULL, pre_an, NULL, NULL, NULL }, /* An */ { NULL, pre_em, post_font, NULL, NULL }, /* Ar */ @@ -117,11 +141,9 @@ static const struct manact manacts[MDOC_MAX + 1] = { { 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_ex, NULL, NULL, NULL }, /* Ex */ { NULL, pre_fa, post_fa, NULL, NULL }, /* Fa */ - { NULL, NULL, NULL, NULL, NULL }, /* _Fd */ + { NULL, pre_fd, post_fd, NULL, NULL }, /* Fd */ { NULL, pre_fl, post_fl, NULL, NULL }, /* Fl */ { NULL, pre_fn, post_fn, NULL, NULL }, /* Fn */ { NULL, pre_ft, post_font, NULL, NULL }, /* Ft */ @@ -131,46 +153,42 @@ static const struct manact manacts[MDOC_MAX + 1] = { { 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_ft, post_font, NULL, NULL }, /* Ot */ { 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, pre_rv, NULL, NULL, NULL }, /* Rv */ { NULL, NULL, NULL, NULL, NULL }, /* St */ { 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 */ - { NULL, NULL, NULL, NULL, NULL }, /* _%B */ - { NULL, NULL, post_percent, NULL, NULL }, /* _%D */ - { NULL, NULL, NULL, NULL, NULL }, /* _%I */ - { NULL, pre_enc, post_percent, "\\fI", "\\fP" }, /* %J */ - { NULL, NULL, NULL, NULL, NULL }, /* _%N */ - { NULL, NULL, NULL, NULL, NULL }, /* _%O */ - { NULL, NULL, NULL, NULL, NULL }, /* _%P */ - { NULL, NULL, NULL, NULL, NULL }, /* _%R */ - { NULL, pre_enc, post_percent, "\"", "\"" }, /* %T */ - { NULL, NULL, NULL, NULL, NULL }, /* _%V */ + { NULL, NULL, post_percent, NULL, NULL }, /* %A */ + { NULL, pre_em, post_percent, NULL, NULL }, /* %B */ + { NULL, NULL, post_percent, NULL, NULL }, /* %D */ + { NULL, pre_em, post_percent, NULL, NULL }, /* %I */ + { NULL, pre_em, post_percent, NULL, NULL }, /* %J */ + { NULL, NULL, post_percent, NULL, NULL }, /* %N */ + { NULL, NULL, post_percent, NULL, NULL }, /* %O */ + { NULL, NULL, post_percent, NULL, NULL }, /* %P */ + { NULL, NULL, post_percent, NULL, NULL }, /* %R */ + { NULL, pre__t, post__t, NULL, NULL }, /* %T */ + { NULL, NULL, post_percent, NULL, NULL }, /* %V */ { NULL, NULL, NULL, NULL, NULL }, /* Ac */ { cond_body, pre_enc, post_enc, "<", ">" }, /* Ao */ { cond_body, pre_enc, post_enc, "<", ">" }, /* Aq */ { NULL, NULL, NULL, NULL, NULL }, /* At */ { NULL, NULL, NULL, NULL, NULL }, /* Bc */ - { NULL, NULL, NULL, NULL, NULL }, /* _Bf */ + { NULL, pre_bf, post_bf, NULL, NULL }, /* Bf */ { cond_body, pre_enc, post_enc, "[", "]" }, /* Bo */ { cond_body, pre_enc, post_enc, "[", "]" }, /* Bq */ { NULL, pre_ux, NULL, "BSD/OS", NULL }, /* Bsx */ { NULL, pre_bx, NULL, NULL, NULL }, /* Bx */ { NULL, NULL, NULL, NULL, NULL }, /* Db */ { NULL, NULL, NULL, NULL, NULL }, /* Dc */ - { cond_body, pre_enc, post_enc, "``", "''" }, /* Do */ - { cond_body, pre_enc, post_enc, "``", "''" }, /* Dq */ - { NULL, NULL, NULL, NULL, NULL }, /* _Ec */ - { NULL, NULL, NULL, NULL, NULL }, /* _Ef */ + { cond_body, pre_enc, post_enc, "\\(lq", "\\(rq" }, /* Do */ + { cond_body, pre_enc, post_enc, "\\(lq", "\\(rq" }, /* Dq */ + { NULL, NULL, NULL, NULL, NULL }, /* Ec */ + { NULL, NULL, NULL, NULL, NULL }, /* Ef */ { NULL, pre_em, post_font, NULL, NULL }, /* Em */ - { NULL, NULL, NULL, NULL, NULL }, /* _Eo */ + { NULL, NULL, post_eo, NULL, NULL }, /* Eo */ { NULL, pre_ux, NULL, "FreeBSD", NULL }, /* Fx */ { NULL, pre_sy, post_font, NULL, NULL }, /* Ms */ { NULL, pre_no, NULL, NULL, NULL }, /* No */ @@ -182,21 +200,21 @@ static const struct manact manacts[MDOC_MAX + 1] = { { cond_body, pre_enc, post_enc, "(", ")" }, /* Po */ { cond_body, pre_enc, post_enc, "(", ")" }, /* Pq */ { NULL, NULL, NULL, NULL, NULL }, /* Qc */ - { cond_body, pre_enc, post_enc, "`", "'" }, /* Ql */ + { cond_body, pre_enc, post_enc, "\\(oq", "\\(cq" }, /* Ql */ { cond_body, pre_enc, post_enc, "\"", "\"" }, /* Qo */ { cond_body, pre_enc, post_enc, "\"", "\"" }, /* Qq */ { NULL, NULL, NULL, NULL, NULL }, /* Re */ - { cond_body, pre_pp, NULL, NULL, NULL }, /* Rs */ + { cond_body, pre_rs, NULL, NULL, NULL }, /* Rs */ { NULL, NULL, NULL, NULL, NULL }, /* Sc */ - { cond_body, pre_enc, post_enc, "`", "'" }, /* So */ - { cond_body, pre_enc, post_enc, "`", "'" }, /* Sq */ + { cond_body, pre_enc, post_enc, "\\(oq", "\\(cq" }, /* So */ + { cond_body, pre_enc, post_enc, "\\(oq", "\\(cq" }, /* Sq */ { NULL, pre_sm, NULL, NULL, NULL }, /* Sm */ { 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 */ + { NULL, NULL, NULL, NULL, NULL }, /* Xc */ + { NULL, NULL, NULL, NULL, NULL }, /* Xo */ { NULL, pre_fo, post_fo, NULL, NULL }, /* Fo */ { NULL, NULL, NULL, NULL, NULL }, /* Fc */ { cond_body, pre_enc, post_enc, "[", "]" }, /* Oo */ @@ -205,7 +223,7 @@ static const struct manact manacts[MDOC_MAX + 1] = { { NULL, NULL, NULL, NULL, NULL }, /* Ek */ { NULL, pre_ux, NULL, "is currently in beta test.", NULL }, /* Bt */ { NULL, NULL, NULL, NULL, NULL }, /* Hf */ - { NULL, NULL, NULL, NULL, NULL }, /* Fr */ + { NULL, pre_em, post_font, NULL, NULL }, /* Fr */ { NULL, pre_ux, NULL, "currently under development.", NULL }, /* Ud */ { NULL, NULL, post_lb, NULL, NULL }, /* Lb */ { NULL, pre_pp, NULL, NULL, NULL }, /* Lp */ @@ -214,35 +232,48 @@ static const struct manact manacts[MDOC_MAX + 1] = { { cond_body, pre_enc, post_enc, "{", "}" }, /* Brq */ { cond_body, pre_enc, post_enc, "{", "}" }, /* Bro */ { NULL, NULL, NULL, NULL, NULL }, /* Brc */ - { NULL, NULL, NULL, NULL, NULL }, /* _%C */ - { NULL, NULL, NULL, NULL, NULL }, /* _Es */ - { NULL, NULL, NULL, NULL, NULL }, /* _En */ + { NULL, NULL, post_percent, NULL, NULL }, /* %C */ + { NULL, pre_es, NULL, NULL, NULL }, /* Es */ + { cond_body, pre_en, post_en, NULL, NULL }, /* En */ { NULL, pre_ux, NULL, "DragonFly", NULL }, /* Dx */ - { NULL, NULL, NULL, NULL, NULL }, /* _%Q */ + { NULL, NULL, post_percent, NULL, NULL }, /* %Q */ { NULL, pre_br, NULL, NULL, NULL }, /* br */ { NULL, pre_sp, post_sp, NULL, NULL }, /* sp */ - { NULL, NULL, NULL, NULL, NULL }, /* _%U */ - { NULL, NULL, NULL, NULL, NULL }, /* _Ta */ + { NULL, NULL, post_percent, NULL, NULL }, /* %U */ + { NULL, NULL, NULL, NULL, NULL }, /* Ta */ + { NULL, pre_ll, post_sp, NULL, NULL }, /* ll */ { NULL, NULL, NULL, NULL, NULL }, /* ROOT */ }; 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 MMAN_nbrword (1 << 12) /* do not break the next word */ +#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; size_t size; } fontqueue; + static void font_push(char newfont) { @@ -250,10 +281,11 @@ font_push(char newfont) if (fontqueue.head + fontqueue.size <= ++fontqueue.tail) { fontqueue.size += 8; fontqueue.head = mandoc_realloc(fontqueue.head, - fontqueue.size); + fontqueue.size); } *fontqueue.tail = newfont; - print_word("\\f"); + print_word(""); + printf("\\f"); putchar(newfont); outflags &= ~MMAN_spc; } @@ -265,7 +297,8 @@ font_pop(void) if (fontqueue.tail > fontqueue.head) fontqueue.tail--; outflags &= ~MMAN_spc; - print_word("\\f"); + print_word(""); + printf("\\f"); putchar(*fontqueue.tail); } @@ -273,66 +306,125 @@ 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("\\~"); + case ASCII_NBRSP: + printf("\\ "); break; - case (ASCII_HYPH): + case ASCII_HYPH: putchar('-'); break; + case ASCII_BREAK: + printf("\\:"); + break; + case ' ': + if (MMAN_nbrword & outflags) { + printf("\\ "); + break; + } + /* FALLTHROUGH */ default: putchar((unsigned char)*s); break; } + if (TPremain) + TPremain--; } + outflags &= ~MMAN_nbrword; } 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; + print_line(".RS", MMAN_Bk_susp); + + /* Convert v into a number (of characters). */ if (NULL == v || '\0' == *v || 0 == strcmp(v, "left")) sz = 0; else if (0 == strcmp(v, "indent")) @@ -340,15 +432,99 @@ 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); + outflags |= MMAN_nl; + return; + } } else sz = strlen(v); - snprintf(buf, sizeof(buf), "%ldn", sz); + /* + * We are inside an enclosing list. + * Add the two indentations. + */ + if (Bl_stack_len) + sz += Bl_stack[Bl_stack_len - 1]; + + (void)snprintf(buf, sizeof(buf), "%zun", sz); print_word(buf); + outflags |= MMAN_nl; } +/* + * Set up the indentation for a list item; used from pre_it(). + */ +static void +print_width(const char *v, const struct mdoc_node *child, size_t defsz) +{ + char buf[24]; + struct roffsu su; + size_t sz, chsz; + int numeric, remain; + + 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 { + sz = 0; + numeric = 0; + } + } else + sz = strlen(v); + + /* XXX Rough estimation, might have multiple parts. */ + chsz = (NULL != child && MDOC_TEXT == child->type) ? + strlen(child->string) : 0; + + /* Maybe we are inside an enclosing list? */ + mid_it(); + + /* + * 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) { + (void)snprintf(buf, sizeof(buf), "%zun", sz + 2); + print_word(buf); + } else + print_word(v); + TPremain = remain; +} + +static void +print_count(int *count) +{ + char buf[24]; + + (void)snprintf(buf, sizeof(buf), "%d.", ++*count); + print_word(buf); +} + void man_man(void *arg, const struct man *man) { @@ -365,39 +541,42 @@ 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 == NULL ? "" : 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'); } static void print_node(DECL_ARGS) { - const struct mdoc_node *prev, *sub; + const struct mdoc_node *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. */ - prev = n->prev ? n->prev : n->parent; - if (prev && prev->line < n->line && - MDOC_Fo != prev->tok && MDOC_Ns != prev->tok) + if (MMAN_spc & outflags && MDOC_LINE & n->flags) outflags |= MMAN_nl; act = NULL; @@ -409,9 +588,10 @@ print_node(DECL_ARGS) * Make sure that we don't happen to start with a * control character at the start of a line. */ - if (MMAN_nl & outflags && ('.' == *n->string || - '\'' == *n->string)) { - print_word("\\&"); + if (MMAN_nl & outflags && + ('.' == *n->string || '\'' == *n->string)) { + print_word(""); + printf("\\&"); outflags &= ~MMAN_spc; } print_word(n->string); @@ -421,25 +601,34 @@ print_node(DECL_ARGS) * node. */ act = manacts + n->tok; - cond = NULL == act->cond || (*act->cond)(m, n); - if (cond && act->pre) - do_sub = (*act->pre)(m, n); + cond = NULL == act->cond || (*act->cond)(meta, n); + if (cond && act->pre && ENDBODY_NOT == n->end) + do_sub = (*act->pre)(meta, n); } - /* + /* * Conditionally run all child nodes. * Note that this iterates over children instead of using * recursion. This prevents unnecessary depth in the stack. */ 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 (MDOC_ENDED & n->flags) + return; + if (cond && act->post) - (*act->post)(m, n); + (*act->post)(meta, n); + + if (ENDBODY_NOT != n->end) + n->pending->flags |= MDOC_ENDED; + + if (ENDBODY_NOSPACE == n->end) + outflags &= ~(MMAN_spc | MMAN_nl); } static int @@ -477,10 +666,46 @@ post_enc(DECL_ARGS) suffix = manacts[n->tok].suffix; if (NULL == suffix) return; - outflags &= ~MMAN_spc; + outflags &= ~(MMAN_spc | MMAN_nl); print_word(suffix); } +static int +pre_ex(DECL_ARGS) +{ + int nchild; + + outflags |= MMAN_br | MMAN_nl; + + print_word("The"); + + nchild = n->nchild; + for (n = n->child; n; n = n->next) { + font_push('B'); + print_word(n->string); + font_pop(); + + if (n->next == NULL) + continue; + + if (nchild > 2) { + outflags &= ~MMAN_spc; + print_word(","); + } + if (n->next->next == NULL) + print_word("and"); + } + + if (nchild > 1) + print_word("utilities exit\\~0"); + else + print_word("utility exits\\~0"); + + print_word("on success, and\\~>0 if an error occurs."); + outflags |= MMAN_nl; + return(0); +} + static void post_font(DECL_ARGS) { @@ -488,24 +713,51 @@ post_font(DECL_ARGS) font_pop(); } -/* - * Used in listings (percent = %A, e.g.). - * FIXME: this is incomplete. - * It doesn't print a nice ", and" for lists. - */ static void post_percent(DECL_ARGS) { - post_enc(m, n); - if (n->next) + if (pre_em == manacts[n->tok].pre) + font_pop(); + if (n->next) { print_word(","); - else { + if (n->prev && n->prev->tok == n->tok && + n->next->tok == n->tok) + print_word("and"); + } else { print_word("."); outflags |= MMAN_nl; } } +static int +pre__t(DECL_ARGS) +{ + + if (n->parent && MDOC_Rs == n->parent->tok && + n->parent->norm->Rs.quote_T) { + print_word(""); + putchar('\"'); + outflags &= ~MMAN_spc; + } else + font_push('I'); + return(1); +} + +static void +post__t(DECL_ARGS) +{ + + if (n->parent && MDOC_Rs == n->parent->tok && + n->parent->norm->Rs.quote_T) { + outflags &= ~MMAN_spc; + print_word(""); + putchar('\"'); + } else + font_pop(); + post_percent(meta, n); +} + /* * Print before a section header. */ @@ -513,12 +765,13 @@ 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; + if (MDOC_HEAD == n->type) { + outflags |= MMAN_sp; + print_block(manacts[n->tok].prefix, 0); + print_word(""); + putchar('\"'); + outflags &= ~MMAN_spc; + } return(1); } @@ -532,7 +785,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); @@ -547,26 +801,26 @@ pre_syn(const struct mdoc_node *n) return; if (n->prev->tok == n->tok && - MDOC_Ft != n->tok && - MDOC_Fo != n->tok && - MDOC_Fn != 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): + case MDOC_Fd: /* FALLTHROUGH */ - case (MDOC_Fn): + case MDOC_Fn: /* FALLTHROUGH */ - case (MDOC_Fo): + case MDOC_Fo: /* FALLTHROUGH */ - case (MDOC_In): + case MDOC_In: /* FALLTHROUGH */ - case (MDOC_Vt): + case MDOC_Vt: outflags |= MMAN_sp; break; - case (MDOC_Ft): + case MDOC_Ft: if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) { outflags |= MMAN_sp; break; @@ -583,11 +837,11 @@ pre_an(DECL_ARGS) { switch (n->norm->An.auth) { - case (AUTH_split): + case AUTH_split: outflags &= ~MMAN_An_nosplit; outflags |= MMAN_An_split; return(0); - case (AUTH_nosplit): + case AUTH_nosplit: outflags &= ~MMAN_An_split; outflags |= MMAN_An_nosplit; return(0); @@ -615,17 +869,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_offs(n->norm->Bd.offs); - outflags |= MMAN_nl; return(1); } @@ -633,24 +884,59 @@ static void post_bd(DECL_ARGS) { - 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); + + /* Maybe we are inside an enclosing list? */ + if (NULL != n->parent->next) + mid_it(); +} + +static int +pre_bf(DECL_ARGS) +{ + + switch (n->type) { + case MDOC_BLOCK: + return(1); + case MDOC_BODY: + break; + default: + return(0); } - outflags |= MMAN_nl; + switch (n->norm->Bf.font) { + case FONT_Em: + font_push('I'); + break; + case FONT_Sy: + font_push('B'); + break; + default: + font_push('R'); + break; + } + return(1); } +static void +post_bf(DECL_ARGS) +{ + + if (MDOC_BODY == n->type) + font_pop(); +} + static int pre_bk(DECL_ARGS) { switch (n->type) { - case (MDOC_BLOCK): + case MDOC_BLOCK: return(1); - case (MDOC_BODY): + case MDOC_BODY: outflags |= MMAN_Bk; return(1); default: @@ -667,6 +953,70 @@ post_bk(DECL_ARGS) } static int +pre_bl(DECL_ARGS) +{ + size_t icol; + + /* + * print_offs() will increase the -offset to account for + * a possible enclosing .It, but any enclosed .It blocks + * just nest and do not add up their indentation. + */ + if (n->norm->Bl.offs) { + print_offs(n->norm->Bl.offs); + Bl_stack[Bl_stack_len++] = 0; + } + + switch (n->norm->Bl.type) { + case LIST_enum: + n->norm->Bl.count = 0; + return(1); + case LIST_column: + break; + default: + return(1); + } + + print_line(".TS", MMAN_nl); + for (icol = 0; icol < n->norm->Bl.ncols; icol++) + print_word("l"); + print_word("."); + outflags |= MMAN_nl; + return(1); +} + +static void +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; + default: + break; + } + + if (n->norm->Bl.offs) { + print_line(".RE", MMAN_nl); + assert(Bl_stack_len); + Bl_stack_len--; + assert(0 == Bl_stack[Bl_stack_len]); + } else { + outflags |= MMAN_PP | MMAN_nl; + outflags &= ~(MMAN_sp | MMAN_br); + } + + /* Maybe we are inside an enclosing list? */ + if (NULL != n->parent->next) + mid_it(); + +} + +static int pre_br(DECL_ARGS) { @@ -698,9 +1048,7 @@ static int pre_dl(DECL_ARGS) { - outflags |= MMAN_nl; - print_word(".RS 6n"); - outflags |= MMAN_nl; + print_offs("6n"); return(1); } @@ -708,9 +1056,11 @@ static void post_dl(DECL_ARGS) { - outflags |= MMAN_nl; - print_word(".RE"); - outflags |= MMAN_nl; + print_line(".RE", MMAN_nl); + + /* Maybe we are inside an enclosing list? */ + if (NULL != n->parent->next) + mid_it(); } static int @@ -722,15 +1072,62 @@ pre_em(DECL_ARGS) } static int +pre_en(DECL_ARGS) +{ + + if (NULL == n->norm->Es || + NULL == n->norm->Es->child) + return(1); + + print_word(n->norm->Es->child->string); + outflags &= ~MMAN_spc; + return(1); +} + +static void +post_en(DECL_ARGS) +{ + + if (NULL == n->norm->Es || + NULL == n->norm->Es->child || + NULL == n->norm->Es->child->next) + return; + + outflags &= ~MMAN_spc; + print_word(n->norm->Es->child->next->string); + return; +} + +static void +post_eo(DECL_ARGS) +{ + + if (MDOC_HEAD == n->type || MDOC_BODY == n->type) + outflags &= ~MMAN_spc; +} + +static int +pre_es(DECL_ARGS) +{ + + return(0); +} + +static int pre_fa(DECL_ARGS) { + int am_Fa; - if (MDOC_Fa == n->tok) + am_Fa = MDOC_Fa == n->tok; + + if (am_Fa) n = n->child; while (NULL != n) { font_push('I'); - print_node(m, n); + if (am_Fa || MDOC_SYNPRETTY & n->flags) + outflags |= MMAN_nbrword; + print_node(meta, n); font_pop(); if (NULL != (n = n->next)) print_word(","); @@ -747,11 +1144,28 @@ post_fa(DECL_ARGS) } static int +pre_fd(DECL_ARGS) +{ + + pre_syn(n); + font_push('B'); + return(1); +} + +static void +post_fd(DECL_ARGS) +{ + + font_pop(); + outflags |= MMAN_br; +} + +static int pre_fl(DECL_ARGS) { font_push('B'); - print_word("-"); + print_word("\\-"); outflags &= ~MMAN_spc; return(1); } @@ -761,7 +1175,8 @@ post_fl(DECL_ARGS) { font_pop(); - if (0 == n->nchild) + if (0 == n->nchild && NULL != n->next && + n->next->line == n->line) outflags &= ~MMAN_spc; } @@ -775,13 +1190,20 @@ pre_fn(DECL_ARGS) if (NULL == n) return(0); + if (MDOC_SYNPRETTY & n->flags) + print_block(".HP 4n", MMAN_nl); + font_push('B'); - print_node(m, n); + print_node(meta, n); font_pop(); outflags &= ~MMAN_spc; print_word("("); outflags &= ~MMAN_spc; - return(pre_fa(m, n->next)); + + n = n->next; + if (NULL != n) + pre_fa(meta, n); + return(0); } static void @@ -791,7 +1213,7 @@ post_fn(DECL_ARGS) print_word(")"); if (MDOC_SYNPRETTY & n->flags) { print_word(";"); - outflags |= MMAN_br; + outflags |= MMAN_PP; } } @@ -800,13 +1222,15 @@ pre_fo(DECL_ARGS) { switch (n->type) { - case (MDOC_BLOCK): + case MDOC_BLOCK: pre_syn(n); break; - case (MDOC_HEAD): + case MDOC_HEAD: + if (MDOC_SYNPRETTY & n->flags) + print_block(".HP 4n", MMAN_nl); font_push('B'); break; - case (MDOC_BODY): + case MDOC_BODY: outflags &= ~MMAN_spc; print_word("("); outflags &= ~MMAN_spc; @@ -816,17 +1240,17 @@ pre_fo(DECL_ARGS) } return(1); } - + static void post_fo(DECL_ARGS) { switch (n->type) { - case (MDOC_HEAD): + case MDOC_HEAD: font_pop(); break; - case (MDOC_BODY): - post_fn(m, n); + case MDOC_BODY: + post_fn(meta, n); break; default: break; @@ -880,24 +1304,158 @@ pre_it(DECL_ARGS) { const struct mdoc_node *bln; - if (MDOC_HEAD == n->type) { - outflags |= MMAN_nl; - print_word(".TP"); - bln = n->parent->parent->prev; + switch (n->type) { + case MDOC_HEAD: + 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_bullet): - print_word("4n"); + case LIST_item: + return(0); + case LIST_inset: + /* FALLTHROUGH */ + case LIST_diag: + /* FALLTHROUGH */ + case LIST_ohang: + if (bln->norm->Bl.type == LIST_diag) + print_line(".B \"", 0); + else + print_line(".R \"", 0); + outflags &= ~MMAN_spc; + return(1); + case LIST_bullet: + /* FALLTHROUGH */ + case LIST_dash: + /* FALLTHROUGH */ + case LIST_hyphen: + print_width(bln->norm->Bl.width, NULL, 0); + TPremain = 0; outflags |= MMAN_nl; - print_word("\\fBo\\fP"); + font_push('B'); + if (LIST_bullet == bln->norm->Bl.type) + print_word("o"); + else + print_word("-"); + font_pop(); + outflags |= MMAN_nl; + return(0); + case LIST_enum: + print_width(bln->norm->Bl.width, NULL, 0); + TPremain = 0; + outflags |= MMAN_nl; + print_count(&bln->norm->Bl.count); + outflags |= MMAN_nl; + return(0); + case LIST_hang: + print_width(bln->norm->Bl.width, n->child, 6); + TPremain = 0; + outflags |= MMAN_nl; + return(1); + case LIST_tag: + print_width(bln->norm->Bl.width, n->child, 0); + putchar('\n'); + outflags &= ~MMAN_spc; + return(1); + default: + return(1); + } + default: + break; + } + return(1); +} + +/* + * This function is called after closing out an indented block. + * If we are inside an enclosing list, restore its indentation. + */ +static void +mid_it(void) +{ + char buf[24]; + + /* Nothing to do outside a list. */ + if (0 == Bl_stack_len || 0 == Bl_stack[Bl_stack_len - 1]) + return; + + /* The indentation has already been set up. */ + if (Bl_stack_post[Bl_stack_len - 1]) + return; + + /* Restore the indentation of the enclosing list. */ + print_line(".RS", MMAN_Bk_susp); + (void)snprintf(buf, sizeof(buf), "%zun", + 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; +} + +static void +post_it(DECL_ARGS) +{ + const struct mdoc_node *bln; + + bln = n->parent->parent; + + switch (n->type) { + case MDOC_HEAD: + switch (bln->norm->Bl.type) { + case LIST_diag: + outflags &= ~MMAN_spc; + print_word("\\ "); break; + case LIST_ohang: + outflags |= MMAN_br; + break; default: - if (bln->norm->Bl.width) - print_word(bln->norm->Bl.width); break; } - outflags |= MMAN_nl; + break; + case MDOC_BODY: + 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 or child list. + * 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; + } + break; + case LIST_column: + if (NULL != n->next) { + putchar('\t'); + outflags &= ~MMAN_spc; + } + break; + default: + break; + } + break; + default: + break; } - return(1); } static void @@ -933,6 +1491,14 @@ pre_lk(DECL_ARGS) } static int +pre_ll(DECL_ARGS) +{ + + print_line(".ll", 0); + return(1); +} + +static int pre_li(DECL_ARGS) { @@ -943,16 +1509,27 @@ pre_li(DECL_ARGS) static int pre_nm(DECL_ARGS) { + char *name; - if (MDOC_BLOCK == n->type) + if (MDOC_BLOCK == n->type) { + outflags |= MMAN_Bk; 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(" %zun", strlen(name) + 1); + outflags |= MMAN_nl; + } font_push('B'); if (NULL == n->child) - print_word(m->name); + print_word(meta->name); return(1); } @@ -960,9 +1537,19 @@ static void post_nm(DECL_ARGS) { - if (MDOC_ELEM != n->type && MDOC_HEAD != n->type) - return; - font_pop(); + switch (n->type) { + case MDOC_BLOCK: + outflags &= ~MMAN_Bk; + break; + case MDOC_HEAD: + /* FALLTHROUGH */ + case MDOC_ELEM: + if (n->child != NULL || meta->name != NULL) + font_pop(); + break; + default: + break; + } } static int @@ -992,24 +1579,90 @@ static int pre_pp(DECL_ARGS) { + if (MDOC_It != n->parent->tok) + outflags |= MMAN_PP; + outflags |= MMAN_sp | MMAN_nl; + outflags &= ~MMAN_br; + return(0); +} + +static int +pre_rs(DECL_ARGS) +{ + + if (SEC_SEE_ALSO == n->sec) { + outflags |= MMAN_PP | MMAN_sp | MMAN_nl; + outflags &= ~MMAN_br; + } + return(1); +} + +static int +pre_rv(DECL_ARGS) +{ + int nchild; + + outflags |= MMAN_br | MMAN_nl; + + nchild = n->nchild; + if (nchild > 0) { + print_word("The"); + + for (n = n->child; n; n = n->next) { + font_push('B'); + print_word(n->string); + font_pop(); + + outflags &= ~MMAN_spc; + print_word("()"); + + if (n->next == NULL) + continue; + + if (nchild > 2) { + outflags &= ~MMAN_spc; + print_word(","); + } + if (n->next->next == NULL) + print_word("and"); + } + + if (nchild > 1) + print_word("functions return"); + else + print_word("function returns"); + + print_word("the value\\~0 if successful;"); + } else + print_word("Upon successful completion, " + "the value\\~0 is returned;"); + + print_word("otherwise the value\\~\\-1 is returned" + " and the global variable"); + + font_push('I'); + print_word("errno"); + font_pop(); + + print_word("is set to indicate the error."); outflags |= MMAN_nl; - if (MDOC_It == n->parent->tok) - print_word(".sp"); - else - print_word(".PP"); - outflags |= MMAN_nl; - return(MDOC_Rs == n->tok); + return(0); } static int pre_sm(DECL_ARGS) { - assert(n->child && MDOC_TEXT == n->child->type); - if (0 == strcmp("on", n->child->string)) + if (NULL == n->child) + outflags ^= MMAN_Sm; + else if (0 == strcmp("on", n->child->string)) outflags |= MMAN_Sm; else outflags &= ~MMAN_Sm; + + if (MMAN_Sm & outflags) + outflags |= MMAN_spc; + return(0); } @@ -1017,8 +1670,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); } @@ -1043,10 +1699,10 @@ pre_vt(DECL_ARGS) if (MDOC_SYNPRETTY & n->flags) { switch (n->type) { - case (MDOC_BLOCK): + case MDOC_BLOCK: pre_syn(n); return(1); - case (MDOC_BODY): + case MDOC_BODY: break; default: return(0); @@ -1072,13 +1728,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); } @@ -1091,7 +1747,7 @@ pre_ux(DECL_ARGS) if (NULL == n->child) return(0); outflags &= ~MMAN_spc; - print_word("\\~"); + print_word("\\ "); outflags &= ~MMAN_spc; return(1); }