=================================================================== RCS file: /cvs/mandoc/mdoc_man.c,v retrieving revision 1.11 retrieving revision 1.21 diff -u -p -r1.11 -r1.21 --- mandoc/mdoc_man.c 2012/07/07 13:46:59 1.11 +++ mandoc/mdoc_man.c 2012/07/08 15:48:13 1.21 @@ -1,4 +1,4 @@ -/* $Id: mdoc_man.c,v 1.11 2012/07/07 13:46:59 schwarze Exp $ */ +/* $Id: mdoc_man.c,v 1.21 2012/07/08 15:48:13 schwarze Exp $ */ /* * Copyright (c) 2011, 2012 Ingo Schwarze * @@ -18,6 +18,7 @@ #include "config.h" #endif +#include #include #include @@ -28,14 +29,8 @@ #include "main.h" #define DECL_ARGS const struct mdoc_meta *m, \ - const struct mdoc_node *n, \ - struct mman *mm + const struct mdoc_node *n -struct mman { - int need_space; /* next word needs prior ws */ - int need_nl; /* next word needs prior nl */ -}; - struct manact { int (*cond)(DECL_ARGS); /* DON'T run actions */ int (*pre)(DECL_ARGS); /* pre-node action */ @@ -47,29 +42,43 @@ struct manact { static int cond_body(DECL_ARGS); static int cond_head(DECL_ARGS); 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_fn(DECL_ARGS); +static void post_fo(DECL_ARGS); +static void post_in(DECL_ARGS); +static void post_lb(DECL_ARGS); static void post_nm(DECL_ARGS); static void post_percent(DECL_ARGS); 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_ap(DECL_ARGS); static int pre_bd(DECL_ARGS); +static int pre_bk(DECL_ARGS); 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_fa(DECL_ARGS); +static int pre_fn(DECL_ARGS); +static int pre_fo(DECL_ARGS); +static int pre_in(DECL_ARGS); static int pre_it(DECL_ARGS); static int pre_nm(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_vt(DECL_ARGS); static int pre_ux(DECL_ARGS); static int pre_xr(DECL_ARGS); -static void print_word(struct mman *, const char *); -static void print_offs(struct mman *, const char *); +static void print_word(const char *); +static void print_offs(const char *); static void print_node(DECL_ARGS); static const struct manact manacts[MDOC_MAX + 1] = { @@ -98,13 +107,13 @@ static const struct manact manacts[MDOC_MAX + 1] = { { NULL, pre_enc, post_enc, "The \\fB", "\\fP\nutility exits 0 on success, and >0 if an error occurs." }, /* Ex */ - { NULL, NULL, NULL, NULL, NULL }, /* _Fa */ + { NULL, pre_fa, post_fa, NULL, NULL }, /* Fa */ { NULL, NULL, NULL, NULL, NULL }, /* _Fd */ { NULL, pre_enc, post_enc, "\\fB-", "\\fP" }, /* Fl */ - { NULL, NULL, NULL, NULL, NULL }, /* _Fn */ - { NULL, NULL, NULL, NULL, NULL }, /* _Ft */ + { 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, NULL, NULL, NULL, NULL }, /* _In */ + { NULL, pre_in, post_in, NULL, NULL }, /* In */ { NULL, pre_enc, post_enc, "\\fR", "\\fP" }, /* Li */ { cond_head, pre_enc, NULL, "\\- ", NULL }, /* Nd */ { NULL, pre_nm, post_nm, NULL, NULL }, /* Nm */ @@ -117,8 +126,8 @@ static const struct manact manacts[MDOC_MAX + 1] = { "variable \\fIerrno\\fP is set to indicate the error." }, /* Rv */ { NULL, NULL, NULL, NULL, NULL }, /* St */ - { NULL, NULL, NULL, NULL, NULL }, /* _Va */ - { NULL, NULL, NULL, NULL, NULL }, /* _Vt */ + { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* 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 */ @@ -168,24 +177,24 @@ static const struct manact manacts[MDOC_MAX + 1] = { { NULL, NULL, NULL, NULL, NULL }, /* Sc */ { cond_body, pre_enc, post_enc, "`", "'" }, /* So */ { cond_body, pre_enc, post_enc, "`", "'" }, /* Sq */ - { NULL, NULL, NULL, NULL, NULL }, /* _Sm */ + { 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_ux, NULL, "UNIX", NULL }, /* Ux */ { NULL, NULL, NULL, NULL, NULL }, /* _Xc */ { NULL, NULL, NULL, NULL, NULL }, /* _Xo */ - { NULL, NULL, NULL, NULL, NULL }, /* _Fo */ - { NULL, NULL, NULL, NULL, NULL }, /* _Fc */ + { NULL, pre_fo, post_fo, NULL, NULL }, /* Fo */ + { NULL, NULL, NULL, NULL, NULL }, /* Fc */ { cond_body, pre_enc, post_enc, "[", "]" }, /* Oo */ { NULL, NULL, NULL, NULL, NULL }, /* Oc */ - { NULL, NULL, NULL, NULL, NULL }, /* _Bk */ - { NULL, NULL, NULL, NULL, NULL }, /* _Ek */ + { NULL, pre_bk, post_bk, NULL, NULL }, /* Bk */ + { 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_ux, NULL, "currently under development.", NULL }, /* Ud */ - { NULL, NULL, NULL, NULL, NULL }, /* _Lb */ + { 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 */ @@ -204,33 +213,53 @@ static const struct manact manacts[MDOC_MAX + 1] = { { NULL, NULL, NULL, NULL, NULL }, /* ROOT */ }; +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) + static void -print_word(struct mman *mm, const char *s) +print_word(const char *s) { - if (mm->need_nl) { + if ((MMAN_sp | MMAN_br | MMAN_nl) & outflags) { /* * If we need a newline, print it now and start afresh. */ - putchar('\n'); - mm->need_space = 0; - mm->need_nl = 0; - } else if (mm->need_space && '\0' != s[0]) + 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]) /* * 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 (NULL == strchr(".,:;)]?!", s[0]) || '\0' != s[1]) - putchar(' '); + if (NULL == strchr(".,:;)]?!", s[0]) || '\0' != s[1]) { + if (MMAN_Bk & outflags) { + putchar('\\'); + putchar('~'); + } else + putchar(' '); + } /* * Reassign needing space if we're not following opening * punctuation. */ - mm->need_space = - ('(' != s[0] && '[' != s[0]) || '\0' != s[1]; + if (MMAN_Sm & outflags && + (('(' != s[0] && '[' != s[0]) || '\0' != s[1])) + outflags |= MMAN_spc; + else + outflags &= ~MMAN_spc; for ( ; *s; s++) { switch (*s) { @@ -248,7 +277,7 @@ print_word(struct mman *mm, const char *s) } static void -print_offs(struct mman *mm, const char *v) +print_offs(const char *v) { char buf[24]; struct roffsu su; @@ -261,13 +290,13 @@ print_offs(struct mman *mm, const char *v) else if (0 == strcmp(v, "indent-two")) sz = 12; else if (a2roffsu(v, &su, SCALE_MAX)) { - print_word(mm, v); + print_word(v); return; } else sz = strlen(v); snprintf(buf, sizeof(buf), "%ldn", sz); - print_word(mm, buf); + print_word(buf); } void @@ -288,7 +317,6 @@ man_mdoc(void *arg, const struct mdoc *mdoc) { const struct mdoc_meta *m; const struct mdoc_node *n; - struct mman mm; m = mdoc_meta(mdoc); n = mdoc_node(mdoc); @@ -296,10 +324,8 @@ man_mdoc(void *arg, const struct mdoc *mdoc) printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"", m->title, m->msec, m->date, m->os, m->vol); - memset(&mm, 0, sizeof(struct mman)); - - mm.need_nl = 1; - print_node(m, n, &mm); + outflags = MMAN_nl | MMAN_Sm; + print_node(m, n); putchar('\n'); } @@ -315,8 +341,9 @@ print_node(DECL_ARGS) * This makes the page structure be more consistent. */ prev = n->prev ? n->prev : n->parent; - if (prev && prev->line < n->line && MDOC_Ns != prev->tok) - mm->need_nl = 1; + if (prev && prev->line < n->line && + MDOC_Fo != prev->tok && MDOC_Ns != prev->tok) + outflags |= MMAN_nl; act = NULL; cond = 0; @@ -327,21 +354,21 @@ print_node(DECL_ARGS) * Make sure that we don't happen to start with a * control character at the start of a line. */ - if (mm->need_nl && ('.' == *n->string || + if (MMAN_nl & outflags && ('.' == *n->string || '\'' == *n->string)) { - print_word(mm, "\\&"); - mm->need_space = 0; + print_word("\\&"); + outflags &= ~MMAN_spc; } - print_word(mm, n->string); + print_word(n->string); } else { /* * Conditionally run the pre-node action handler for a * node. */ act = manacts + n->tok; - cond = NULL == act->cond || (*act->cond)(m, n, mm); + cond = NULL == act->cond || (*act->cond)(m, n); if (cond && act->pre) - do_sub = (*act->pre)(m, n, mm); + do_sub = (*act->pre)(m, n); } /* @@ -351,13 +378,13 @@ print_node(DECL_ARGS) */ if (do_sub) for (sub = n->child; sub; sub = sub->next) - print_node(m, sub, mm); + print_node(m, sub); /* * Lastly, conditionally run the post-node handler. */ if (cond && act->post) - (*act->post)(m, n, mm); + (*act->post)(m, n); } static int @@ -386,8 +413,8 @@ pre_enc(DECL_ARGS) prefix = manacts[n->tok].prefix; if (NULL == prefix) return(1); - print_word(mm, prefix); - mm->need_space = 0; + print_word(prefix); + outflags &= ~MMAN_spc; return(1); } @@ -402,10 +429,10 @@ post_enc(DECL_ARGS) suffix = manacts[n->tok].suffix; if (NULL == suffix) return; - mm->need_space = 0; - print_word(mm, suffix); + outflags &= ~MMAN_spc; + print_word(suffix); if (MDOC_Fl == n->tok && 0 == n->nchild) - mm->need_space = 0; + outflags &= ~MMAN_spc; } /* @@ -417,12 +444,12 @@ static void post_percent(DECL_ARGS) { - post_enc(m, n, mm); + post_enc(m, n); if (n->next) - print_word(mm, ","); + print_word(","); else { - print_word(mm, "."); - mm->need_nl = 1; + print_word("."); + outflags |= MMAN_nl; } } @@ -435,10 +462,10 @@ pre_sect(DECL_ARGS) if (MDOC_HEAD != n->type) return(1); - mm->need_nl = 1; - print_word(mm, manacts[n->tok].prefix); - print_word(mm, "\""); - mm->need_space = 0; + outflags |= MMAN_nl; + print_word(manacts[n->tok].prefix); + print_word("\""); + outflags &= ~MMAN_spc; return(1); } @@ -451,18 +478,18 @@ post_sect(DECL_ARGS) if (MDOC_HEAD != n->type) return; - mm->need_space = 0; - print_word(mm, "\""); - mm->need_nl = 1; + outflags &= ~MMAN_spc; + print_word("\""); + outflags |= MMAN_nl; } static int pre_ap(DECL_ARGS) { - mm->need_space = 0; - print_word(mm, "'"); - mm->need_space = 0; + outflags &= ~MMAN_spc; + print_word("'"); + outflags &= ~MMAN_spc; return(0); } @@ -470,19 +497,17 @@ static int pre_bd(DECL_ARGS) { - if (0 == n->norm->Bd.comp) { - mm->need_nl = 1; - print_word(mm, ".sp"); - } + if (0 == n->norm->Bd.comp) + outflags |= MMAN_sp; if (DISP_unfilled == n->norm->Bd.type || DISP_literal == n->norm->Bd.type) { - mm->need_nl = 1; - print_word(mm, ".nf"); + outflags |= MMAN_nl; + print_word(".nf"); } - mm->need_nl = 1; - print_word(mm, ".RS"); - print_offs(mm, n->norm->Bd.offs); - mm->need_nl = 1; + outflags |= MMAN_nl; + print_word(".RS"); + print_offs(n->norm->Bd.offs); + outflags |= MMAN_nl; return(1); } @@ -490,23 +515,44 @@ static void post_bd(DECL_ARGS) { - mm->need_nl = 1; - print_word(mm, ".RE"); + outflags |= MMAN_nl; + print_word(".RE"); if (DISP_unfilled == n->norm->Bd.type || DISP_literal == n->norm->Bd.type) { - mm->need_nl = 1; - print_word(mm, ".fi"); + outflags |= MMAN_nl; + print_word(".fi"); } - mm->need_nl = 1; + outflags |= MMAN_nl; } static int +pre_bk(DECL_ARGS) +{ + + switch (n->type) { + case (MDOC_BLOCK): + return(1); + case (MDOC_BODY): + outflags |= MMAN_Bk; + return(1); + default: + return(0); + } +} + +static void +post_bk(DECL_ARGS) +{ + + if (MDOC_BODY == n->type) + outflags &= ~MMAN_Bk; +} + +static int pre_br(DECL_ARGS) { - mm->need_nl = 1; - print_word(mm, ".br"); - mm->need_nl = 1; + outflags |= MMAN_br; return(0); } @@ -516,17 +562,17 @@ pre_bx(DECL_ARGS) n = n->child; if (n) { - print_word(mm, n->string); - mm->need_space = 0; + print_word(n->string); + outflags &= ~MMAN_spc; n = n->next; } - print_word(mm, "BSD"); + print_word("BSD"); if (NULL == n) return(0); - mm->need_space = 0; - print_word(mm, "-"); - mm->need_space = 0; - print_word(mm, n->string); + outflags &= ~MMAN_spc; + print_word("-"); + outflags &= ~MMAN_spc; + print_word(n->string); return(0); } @@ -534,9 +580,9 @@ static int pre_dl(DECL_ARGS) { - mm->need_nl = 1; - print_word(mm, ".RS 6n"); - mm->need_nl = 1; + outflags |= MMAN_nl; + print_word(".RS 6n"); + outflags |= MMAN_nl; return(1); } @@ -544,51 +590,177 @@ static void post_dl(DECL_ARGS) { - mm->need_nl = 1; - print_word(mm, ".RE"); - mm->need_nl = 1; + outflags |= MMAN_nl; + print_word(".RE"); + outflags |= MMAN_nl; } static int +pre_fa(DECL_ARGS) +{ + + if (MDOC_Fa == n->tok) + n = n->child; + + while (NULL != n) { + print_word("\\fI"); + outflags &= ~MMAN_spc; + print_node(m, n); + outflags &= ~MMAN_spc; + print_word("\\fP"); + if (NULL != (n = n->next)) + print_word(","); + } + return(0); +} + +static void +post_fa(DECL_ARGS) +{ + + if (NULL != n->next && MDOC_Fa == n->next->tok) + print_word(","); +} + +static int +pre_fn(DECL_ARGS) +{ + + n = n->child; + if (NULL == n) + return(0); + + if (MDOC_SYNPRETTY & n->flags) + outflags |= MMAN_br; + print_word("\\fB"); + outflags &= ~MMAN_spc; + print_node(m, n); + outflags &= ~MMAN_spc; + print_word("\\fP("); + outflags &= ~MMAN_spc; + return(pre_fa(m, n->next)); +} + +static void +post_fn(DECL_ARGS) +{ + + print_word(")"); + if (MDOC_SYNPRETTY & n->flags) { + print_word(";"); + outflags |= MMAN_br; + } +} + +static int +pre_fo(DECL_ARGS) +{ + + switch (n->type) { + case (MDOC_HEAD): + if (MDOC_SYNPRETTY & n->flags) + outflags |= MMAN_br; + print_word("\\fB"); + outflags &= ~MMAN_spc; + break; + case (MDOC_BODY): + outflags &= ~MMAN_spc; + print_word("("); + outflags &= ~MMAN_spc; + break; + default: + break; + } + return(1); +} + +static void +post_fo(DECL_ARGS) +{ + + switch (n->type) { + case (MDOC_HEAD): + outflags &= ~MMAN_spc; + print_word("\\fP"); + break; + case (MDOC_BODY): + post_fn(m, n); + break; + default: + break; + } +} + +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; + return(1); +} + +static void +post_in(DECL_ARGS) +{ + + outflags &= ~MMAN_spc; + if (MDOC_SYNPRETTY & n->flags) { + print_word(">\\fP"); + outflags |= MMAN_br; + } else + print_word("\\fP>"); +} + +static int pre_it(DECL_ARGS) { const struct mdoc_node *bln; if (MDOC_HEAD == n->type) { - mm->need_nl = 1; - print_word(mm, ".TP"); + outflags |= MMAN_nl; + print_word(".TP"); bln = n->parent->parent->prev; switch (bln->norm->Bl.type) { case (LIST_bullet): - print_word(mm, "4n"); - mm->need_nl = 1; - print_word(mm, "\\fBo\\fP"); + print_word("4n"); + outflags |= MMAN_nl; + print_word("\\fBo\\fP"); break; default: if (bln->norm->Bl.width) - print_word(mm, bln->norm->Bl.width); + print_word(bln->norm->Bl.width); break; } - mm->need_nl = 1; + outflags |= MMAN_nl; } return(1); } +static void +post_lb(DECL_ARGS) +{ + + if (SEC_LIBRARY == n->sec) + outflags |= MMAN_br; +} + static int pre_nm(DECL_ARGS) { if (MDOC_ELEM != n->type && MDOC_HEAD != n->type) return(1); - if (MDOC_SYNPRETTY & n->flags) { - mm->need_nl = 1; - print_word(mm, ".br"); - mm->need_nl = 1; - } - print_word(mm, "\\fB"); - mm->need_space = 0; + if (MDOC_SYNPRETTY & n->flags) + outflags |= MMAN_br; + print_word("\\fB"); + outflags &= ~MMAN_spc; if (NULL == n->child) - print_word(mm, m->name); + print_word(m->name); return(1); } @@ -598,15 +770,15 @@ post_nm(DECL_ARGS) if (MDOC_ELEM != n->type && MDOC_HEAD != n->type) return; - mm->need_space = 0; - print_word(mm, "\\fP"); + outflags &= ~MMAN_spc; + print_word("\\fP"); } static int pre_ns(DECL_ARGS) { - mm->need_space = 0; + outflags &= ~MMAN_spc; return(0); } @@ -614,28 +786,40 @@ static void post_pf(DECL_ARGS) { - mm->need_space = 0; + outflags &= ~MMAN_spc; } static int pre_pp(DECL_ARGS) { - mm->need_nl = 1; + outflags |= MMAN_nl; if (MDOC_It == n->parent->tok) - print_word(mm, ".sp"); + print_word(".sp"); else - print_word(mm, ".PP"); - mm->need_nl = 1; + print_word(".PP"); + outflags |= MMAN_nl; return(MDOC_Rs == n->tok); } static int +pre_sm(DECL_ARGS) +{ + + assert(n->child && MDOC_TEXT == n->child->type); + if (0 == strcmp("on", n->child->string)) + outflags |= MMAN_Sm; + else + outflags &= ~MMAN_Sm; + return(0); +} + +static int pre_sp(DECL_ARGS) { - mm->need_nl = 1; - print_word(mm, ".sp"); + outflags |= MMAN_nl; + print_word(".sp"); return(1); } @@ -643,24 +827,57 @@ static void post_sp(DECL_ARGS) { - mm->need_nl = 1; + outflags |= MMAN_nl; } static int +pre_vt(DECL_ARGS) +{ + + if (MDOC_SYNPRETTY & n->flags) { + switch (n->type) { + case (MDOC_BLOCK): + return(1); + case (MDOC_BODY): + break; + default: + return(0); + } + outflags |= MMAN_br; + } + print_word("\\fI"); + outflags &= ~MMAN_spc; + return(1); +} + +static void +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; +} + +static int pre_xr(DECL_ARGS) { n = n->child; if (NULL == n) return(0); - print_node(m, n, mm); + print_node(m, n); n = n->next; if (NULL == n) return(0); - mm->need_space = 0; - print_word(mm, "("); - print_node(m, n, mm); - print_word(mm, ")"); + outflags &= ~MMAN_spc; + print_word("("); + print_node(m, n); + print_word(")"); return(0); } @@ -668,11 +885,11 @@ static int pre_ux(DECL_ARGS) { - print_word(mm, manacts[n->tok].prefix); + print_word(manacts[n->tok].prefix); if (NULL == n->child) return(0); - mm->need_space = 0; - print_word(mm, "\\~"); - mm->need_space = 0; + outflags &= ~MMAN_spc; + print_word("\\~"); + outflags &= ~MMAN_spc; return(1); }