=================================================================== RCS file: /cvs/mandoc/mdoc_man.c,v retrieving revision 1.61 retrieving revision 1.70 diff -u -p -r1.61 -r1.70 --- mandoc/mdoc_man.c 2014/03/30 23:34:32 1.61 +++ mandoc/mdoc_man.c 2014/08/21 12:57:17 1.70 @@ -1,4 +1,4 @@ -/* $Id: mdoc_man.c,v 1.61 2014/03/30 23:34:32 schwarze Exp $ */ +/* $Id: mdoc_man.c,v 1.70 2014/08/21 12:57:17 schwarze Exp $ */ /* * Copyright (c) 2011, 2012, 2013, 2014 Ingo Schwarze * @@ -14,10 +14,10 @@ * 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 @@ -51,6 +51,7 @@ 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); @@ -78,8 +79,11 @@ 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); @@ -96,6 +100,7 @@ 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); @@ -136,9 +141,7 @@ 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, pre_fd, post_fd, NULL, NULL }, /* Fd */ { NULL, pre_fl, post_fl, NULL, NULL }, /* Fl */ @@ -150,13 +153,9 @@ 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 */ @@ -224,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 */ @@ -234,8 +233,8 @@ static const struct manact manacts[MDOC_MAX + 1] = { { cond_body, pre_enc, post_enc, "{", "}" }, /* Bro */ { NULL, NULL, NULL, NULL, NULL }, /* Brc */ { NULL, NULL, post_percent, NULL, NULL }, /* %C */ - { NULL, NULL, NULL, NULL, NULL }, /* Es */ - { NULL, NULL, NULL, NULL, NULL }, /* En */ + { 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, post_percent, NULL, NULL }, /* %Q */ { NULL, pre_br, NULL, NULL, NULL }, /* br */ @@ -274,6 +273,7 @@ static struct { size_t size; } fontqueue; + static void font_push(char newfont) { @@ -281,7 +281,7 @@ 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(""); @@ -307,7 +307,7 @@ print_word(const char *s) { if ((MMAN_PP | MMAN_sp | MMAN_br | MMAN_nl) & outflags) { - /* + /* * If we need a newline, print it now and start afresh. */ if (MMAN_PP & outflags) { @@ -362,16 +362,16 @@ print_word(const char *s) for ( ; *s; s++) { switch (*s) { - case (ASCII_NBRSP): + case ASCII_NBRSP: printf("\\ "); break; - case (ASCII_HYPH): + case ASCII_HYPH: putchar('-'); break; - case (ASCII_BREAK): + case ASCII_BREAK: printf("\\:"); break; - case (' '): + case ' ': if (MMAN_nbrword & outflags) { printf("\\ "); break; @@ -456,7 +456,7 @@ print_offs(const char *v) if (Bl_stack_len) sz += Bl_stack[Bl_stack_len - 1]; - snprintf(buf, sizeof(buf), "%zun", sz); + (void)snprintf(buf, sizeof(buf), "%zun", sz); print_word(buf); outflags |= MMAN_nl; } @@ -490,7 +490,7 @@ print_width(const char *v, const struct mdoc_node *chi /* XXX Rough estimation, might have multiple parts. */ chsz = (NULL != child && MDOC_TEXT == child->type) ? - strlen(child->string) : 0; + strlen(child->string) : 0; /* Maybe we are inside an enclosing list? */ mid_it(); @@ -509,7 +509,7 @@ print_width(const char *v, const struct mdoc_node *chi remain = sz + 2; } if (numeric) { - snprintf(buf, sizeof(buf), "%zun", sz + 2); + (void)snprintf(buf, sizeof(buf), "%zun", sz + 2); print_word(buf); } else print_word(v); @@ -519,9 +519,9 @@ print_width(const char *v, const struct mdoc_node *chi static void print_count(int *count) { - char buf[12]; + char buf[24]; - snprintf(buf, sizeof(buf), "%d.", ++*count); + (void)snprintf(buf, sizeof(buf), "%d.", ++*count); print_word(buf); } @@ -548,8 +548,9 @@ man_mdoc(void *arg, const struct mdoc *mdoc) n = mdoc_node(mdoc); printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"\n", - meta->title, meta->msec, meta->date, - meta->os, meta->vol); + 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"); @@ -587,8 +588,8 @@ 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)) { + if (MMAN_nl & outflags && + ('.' == *n->string || '\'' == *n->string)) { print_word(""); printf("\\&"); outflags &= ~MMAN_spc; @@ -605,7 +606,7 @@ print_node(DECL_ARGS) 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. @@ -669,6 +670,42 @@ post_enc(DECL_ARGS) 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) { @@ -697,8 +734,8 @@ static int pre__t(DECL_ARGS) { - if (n->parent && MDOC_Rs == n->parent->tok && - n->parent->norm->Rs.quote_T) { + if (n->parent && MDOC_Rs == n->parent->tok && + n->parent->norm->Rs.quote_T) { print_word(""); putchar('\"'); outflags &= ~MMAN_spc; @@ -711,8 +748,8 @@ static void post__t(DECL_ARGS) { - if (n->parent && MDOC_Rs == n->parent->tok && - n->parent->norm->Rs.quote_T) { + if (n->parent && MDOC_Rs == n->parent->tok && + n->parent->norm->Rs.quote_T) { outflags &= ~MMAN_spc; print_word(""); putchar('\"'); @@ -764,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; @@ -800,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); @@ -863,18 +900,18 @@ pre_bf(DECL_ARGS) { switch (n->type) { - case (MDOC_BLOCK): + case MDOC_BLOCK: return(1); - case (MDOC_BODY): + case MDOC_BODY: break; default: return(0); } switch (n->norm->Bf.font) { - case (FONT_Em): + case FONT_Em: font_push('I'); break; - case (FONT_Sy): + case FONT_Sy: font_push('B'); break; default: @@ -897,9 +934,9 @@ 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: @@ -931,10 +968,10 @@ pre_bl(DECL_ARGS) } switch (n->norm->Bl.type) { - case (LIST_enum): + case LIST_enum: n->norm->Bl.count = 0; return(1); - case (LIST_column): + case LIST_column: break; default: return(1); @@ -953,10 +990,10 @@ post_bl(DECL_ARGS) { switch (n->norm->Bl.type) { - case (LIST_column): + case LIST_column: print_line(".TE", 0); break; - case (LIST_enum): + case LIST_enum: n->norm->Bl.count = 0; break; default: @@ -1034,7 +1071,34 @@ pre_em(DECL_ARGS) return(1); } +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) { @@ -1043,6 +1107,13 @@ post_eo(DECL_ARGS) } static int +pre_es(DECL_ARGS) +{ + + return(0); +} + +static int pre_fa(DECL_ARGS) { int am_Fa; @@ -1095,7 +1166,8 @@ pre_fl(DECL_ARGS) font_push('B'); print_word("\\-"); - outflags &= ~MMAN_spc; + if (n->nchild) + outflags &= ~MMAN_spc; return(1); } @@ -1104,8 +1176,10 @@ post_fl(DECL_ARGS) { font_pop(); - if (0 == n->nchild && NULL != n->next && - n->next->line == n->line) + if ( ! (n->nchild || + n->next == NULL || + n->next->type == MDOC_TEXT || + n->next->flags & MDOC_LINE)) outflags &= ~MMAN_spc; } @@ -1151,15 +1225,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; @@ -1175,10 +1249,10 @@ post_fo(DECL_ARGS) { switch (n->type) { - case (MDOC_HEAD): + case MDOC_HEAD: font_pop(); break; - case (MDOC_BODY): + case MDOC_BODY: post_fn(meta, n); break; default: @@ -1234,7 +1308,7 @@ pre_it(DECL_ARGS) const struct mdoc_node *bln; switch (n->type) { - case (MDOC_HEAD): + case MDOC_HEAD: outflags |= MMAN_PP | MMAN_nl; bln = n->parent->parent; if (0 == bln->norm->Bl.comp || @@ -1243,24 +1317,24 @@ pre_it(DECL_ARGS) outflags |= MMAN_sp; outflags &= ~MMAN_br; switch (bln->norm->Bl.type) { - case (LIST_item): + case LIST_item: return(0); - case (LIST_inset): + case LIST_inset: /* FALLTHROUGH */ - case (LIST_diag): + case LIST_diag: /* FALLTHROUGH */ - case (LIST_ohang): + 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): + case LIST_bullet: /* FALLTHROUGH */ - case (LIST_dash): + case LIST_dash: /* FALLTHROUGH */ - case (LIST_hyphen): + case LIST_hyphen: print_width(bln->norm->Bl.width, NULL, 0); TPremain = 0; outflags |= MMAN_nl; @@ -1270,18 +1344,21 @@ pre_it(DECL_ARGS) else print_word("-"); font_pop(); - break; - case (LIST_enum): + 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); - break; - case (LIST_hang): + outflags |= MMAN_nl; + return(0); + case LIST_hang: print_width(bln->norm->Bl.width, n->child, 6); TPremain = 0; - break; - case (LIST_tag): + outflags |= MMAN_nl; + return(1); + case LIST_tag: print_width(bln->norm->Bl.width, n->child, 0); putchar('\n'); outflags &= ~MMAN_spc; @@ -1289,7 +1366,6 @@ pre_it(DECL_ARGS) default: return(1); } - outflags |= MMAN_nl; default: break; } @@ -1315,7 +1391,8 @@ mid_it(void) /* Restore the indentation of the enclosing list. */ print_line(".RS", MMAN_Bk_susp); - snprintf(buf, sizeof(buf), "%zun", Bl_stack[Bl_stack_len - 1]); + (void)snprintf(buf, sizeof(buf), "%zun", + Bl_stack[Bl_stack_len - 1]); print_word(buf); /* Remeber to close out this .RS block later. */ @@ -1330,32 +1407,32 @@ post_it(DECL_ARGS) bln = n->parent->parent; switch (n->type) { - case (MDOC_HEAD): + case MDOC_HEAD: switch (bln->norm->Bl.type) { - case (LIST_diag): + case LIST_diag: outflags &= ~MMAN_spc; print_word("\\ "); break; - case (LIST_ohang): + case LIST_ohang: outflags |= MMAN_br; break; default: break; } break; - case (MDOC_BODY): + case MDOC_BODY: switch (bln->norm->Bl.type) { - case (LIST_bullet): + case LIST_bullet: /* FALLTHROUGH */ - case (LIST_dash): + case LIST_dash: /* FALLTHROUGH */ - case (LIST_hyphen): + case LIST_hyphen: /* FALLTHROUGH */ - case (LIST_enum): + case LIST_enum: /* FALLTHROUGH */ - case (LIST_hang): + case LIST_hang: /* FALLTHROUGH */ - case (LIST_tag): + case LIST_tag: assert(Bl_stack_len); Bl_stack[--Bl_stack_len] = 0; @@ -1369,7 +1446,7 @@ post_it(DECL_ARGS) Bl_stack_post[Bl_stack_len] = 0; } break; - case (LIST_column): + case LIST_column: if (NULL != n->next) { putchar('\t'); outflags &= ~MMAN_spc; @@ -1464,13 +1541,14 @@ post_nm(DECL_ARGS) { switch (n->type) { - case (MDOC_BLOCK): + case MDOC_BLOCK: outflags &= ~MMAN_Bk; break; - case (MDOC_HEAD): + case MDOC_HEAD: /* FALLTHROUGH */ - case (MDOC_ELEM): - font_pop(); + case MDOC_ELEM: + if (n->child != NULL || meta->name != NULL) + font_pop(); break; default: break; @@ -1523,14 +1601,71 @@ pre_rs(DECL_ARGS) } 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; + return(0); +} + +static int pre_sm(DECL_ARGS) { - assert(n->child && MDOC_TEXT == n->child->type); - if (0 == strcmp("on", n->child->string)) - outflags |= MMAN_Sm | MMAN_spc; + 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); } @@ -1567,10 +1702,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);