=================================================================== RCS file: /cvs/docbook2mdoc/docbook2mdoc.c,v retrieving revision 1.23 retrieving revision 1.40 diff -u -p -r1.23 -r1.40 --- docbook2mdoc/docbook2mdoc.c 2014/03/30 17:46:17 1.23 +++ docbook2mdoc/docbook2mdoc.c 2014/10/12 15:08:45 1.40 @@ -1,4 +1,4 @@ -/* $Id: docbook2mdoc.c,v 1.23 2014/03/30 17:46:17 kristaps Exp $ */ +/* $Id: docbook2mdoc.c,v 1.40 2014/10/12 15:08:45 kristaps Exp $ */ /* * Copyright (c) 2014 Kristaps Dzonsons * @@ -64,6 +64,7 @@ struct pattr { struct pnode { enum nodeid node; /* node type */ char *b; /* binary data buffer */ + char *real; /* store for "b" */ size_t bsz; /* data buffer size */ struct pnode *parent; /* parent (or NULL if top) */ struct pnodeq childq; /* queue of children */ @@ -88,25 +89,50 @@ static const char *attrvals[ATTRVAL__MAX] = { static const struct node nodes[NODE__MAX] = { { NULL, 0 }, { "acronym", 0 }, + { "anchor", NODE_IGNTEXT }, + { "application", 0 }, { "arg", 0 }, + { "caution", NODE_IGNTEXT }, { "citerefentry", NODE_IGNTEXT }, { "cmdsynopsis", NODE_IGNTEXT }, { "code", 0 }, + { "colspec", NODE_IGNTEXT }, { "command", 0 }, + { "constant", 0 }, + { "copyright", NODE_IGNTEXT }, { "date", 0 }, { "emphasis", 0 }, + { "entry", 0 }, { "envar", 0 }, + { "fieldsynopsis", NODE_IGNTEXT }, { "filename", 0 }, { "funcdef", 0 }, { "funcprototype", NODE_IGNTEXT }, { "funcsynopsis", NODE_IGNTEXT }, { "funcsynopsisinfo", 0 }, { "function", 0 }, + { "group", NODE_IGNTEXT }, + { "holder", NODE_IGNTEXT }, + { "info", NODE_IGNTEXT }, + { "informalequation", NODE_IGNTEXT }, + { "informaltable", NODE_IGNTEXT }, + { "inlineequation", NODE_IGNTEXT }, { "itemizedlist", NODE_IGNTEXT }, { "link", 0 }, { "listitem", NODE_IGNTEXT }, { "literal", 0 }, { "manvolnum", 0 }, + { "mml:math", NODE_IGNTEXT }, + { "mml:mfenced", 0 }, + { "mml:mfrac", 0 }, + { "mml:mi", 0 }, + { "mml:mn", 0 }, + { "mml:mo", 0 }, + { "mml:mrow", 0 }, + { "mml:msub", 0 }, + { "mml:msup", 0 }, + { "modifier", 0 }, + { "note", NODE_IGNTEXT }, { "option", 0 }, { "orderedlist", NODE_IGNTEXT }, { "para", 0 }, @@ -114,33 +140,53 @@ static const struct node nodes[NODE__MAX] = { { "parameter", 0 }, { "programlisting", 0 }, { "prompt", 0 }, + { "quote", 0 }, { "refclass", NODE_IGNTEXT }, { "refdescriptor", NODE_IGNTEXT }, { "refentry", NODE_IGNTEXT }, { "refentryinfo", NODE_IGNTEXT }, { "refentrytitle", 0 }, { "refmeta", NODE_IGNTEXT }, + { "refmetainfo", NODE_IGNTEXT }, { "refmiscinfo", NODE_IGNTEXT }, { "refname", 0 }, { "refnamediv", NODE_IGNTEXT }, { "refpurpose", 0 }, { "refsect1", NODE_IGNTEXT }, { "refsect2", NODE_IGNTEXT }, + { "refsect3", NODE_IGNTEXT }, + { "refsection", NODE_IGNTEXT }, { "refsynopsisdiv", NODE_IGNTEXT }, { "replaceable", 0 }, + { "row", NODE_IGNTEXT }, { "sbr", NODE_IGNTEXT }, { "screen", NODE_IGNTEXT }, + { "sgmltag", 0 }, { "structname", 0 }, { "synopsis", 0 }, + { "table", NODE_IGNTEXT }, + { "tbody", NODE_IGNTEXT }, { "term", 0 }, { NULL, 0 }, + { "tfoot", NODE_IGNTEXT }, + { "tgroup", NODE_IGNTEXT }, + { "thead", NODE_IGNTEXT }, + { "tip", NODE_IGNTEXT }, { "title", 0 }, + { "trademark", 0 }, + { "type", 0 }, { "ulink", 0 }, { "userinput", 0 }, { "variablelist", NODE_IGNTEXT }, { "varlistentry", NODE_IGNTEXT }, + { "varname", 0 }, + { "warning", NODE_IGNTEXT }, + { "wordasword", 0 }, + { "year", NODE_IGNTEXT }, }; +static int warn = 0; + static void pnode_print(struct parse *p, struct pnode *pn); @@ -206,6 +252,7 @@ xml_char(void *arg, const XML_Char *p, int sz) } memcpy(ps->cur->b + ps->cur->bsz, p, sz); ps->cur->bsz += (size_t)sz; + ps->cur->real = ps->cur->b; } static void @@ -243,7 +290,8 @@ xml_elem_start(void *arg, const XML_Char *name, const struct pattr *pattr; const XML_Char **att; - if (ps->stop) + /* FIXME: find a better way to ditch other namespaces. */ + if (ps->stop || 0 == strcmp(name, "xi:include")) return; /* Close out text node, if applicable... */ @@ -255,6 +303,7 @@ xml_elem_start(void *arg, const XML_Char *name, const ps->node = ps->cur->node; } + for (node = 0; node < NODE__MAX; node++) if (NULL == nodes[node].name) continue; @@ -315,29 +364,35 @@ xml_elem_start(void *arg, const XML_Char *name, const if (0 == strcmp(*att, attrkeys[key])) break; if (ATTRKEY__MAX == key) { - fprintf(stderr, "%s:%zu:%zu: unknown " - "attribute \"%s\"\n", ps->fname, - XML_GetCurrentLineNumber(ps->xml), - XML_GetCurrentColumnNumber(ps->xml), - *att); + if (warn) + fprintf(stderr, "%s:%zu:%zu: warning: " + "unknown attribute \"%s\"\n", + ps->fname, + XML_GetCurrentLineNumber(ps->xml), + XML_GetCurrentColumnNumber(ps->xml), + *att); continue; } else if ( ! isattrkey(node, key)) { - fprintf(stderr, "%s:%zu:%zu: bad " - "attribute \"%s\"\n", ps->fname, - XML_GetCurrentLineNumber(ps->xml), - XML_GetCurrentColumnNumber(ps->xml), - *att); + if (warn) + fprintf(stderr, "%s:%zu:%zu: warning: " + "bad attribute \"%s\"\n", + ps->fname, + XML_GetCurrentLineNumber(ps->xml), + XML_GetCurrentColumnNumber(ps->xml), + *att); continue; } for (val = 0; val < ATTRVAL__MAX; val++) if (0 == strcmp(*(att + 1), attrvals[val])) break; if (ATTRVAL__MAX != val && ! isattrval(key, val)) { - fprintf(stderr, "%s:%zu:%zu: bad " - "value \"%s\"\n", ps->fname, - XML_GetCurrentLineNumber(ps->xml), - XML_GetCurrentColumnNumber(ps->xml), - *(att + 1)); + if (warn) + fprintf(stderr, "%s:%zu:%zu: warning: " + "bad attribute value \"%s\"\n", + ps->fname, + XML_GetCurrentLineNumber(ps->xml), + XML_GetCurrentColumnNumber(ps->xml), + *(att + 1)); continue; } pattr = calloc(1, sizeof(struct pattr)); @@ -360,8 +415,11 @@ xml_elem_end(void *arg, const XML_Char *name) { struct parse *ps = arg; + /* FIXME: find a better way to ditch other namespaces. */ if (ps->stop || NODE_ROOT == ps->node) return; + else if (0 == strcmp(name, "xi:include")) + return; /* Close out text node, if applicable... */ if (NODE_TEXT == ps->node) { @@ -401,7 +459,7 @@ pnode_free(struct pnode *pn) free(ap); } - free(pn->b); + free(pn->real); free(pn); } @@ -477,8 +535,28 @@ bufappend_r(struct parse *p, struct pnode *pn) bufappend_r(p, pp); } +/* + * Recursively search and return the first instance of "node". + */ +static struct pnode * +pnode_findfirst(struct pnode *pn, enum nodeid node) +{ + struct pnode *pp, *res; + + res = NULL; + TAILQ_FOREACH(pp, &pn->childq, child) { + res = pp->node == node ? pp : + pnode_findfirst(pp, node); + if (NULL != res) + break; + } + + return(res); +} + #define MACROLINE_NORM 0 #define MACROLINE_UPPER 1 +#define MACROLINE_NOWS 2 /* * Recursively print text presumably on a macro line. * Convert all whitespace to regular spaces. @@ -488,7 +566,7 @@ pnode_printmacrolinetext(struct parse *p, struct pnode { char *cp; - if (0 == p->newln) + if (0 == p->newln && ! (MACROLINE_NOWS & fl)) putchar(' '); bufclear(p); @@ -565,6 +643,41 @@ pnode_printmclose(struct parse *p, int sv) } /* + * Like pnode_printmclose() except we look to the next node, and, if + * found, see if it starts with punctuation. + * If it does, then we print that punctuation before the newline. + */ +static void +pnode_printmclosepunct(struct parse *p, struct pnode *pn, int sv) +{ + /* We wouldn't have done anything anyway. */ + if ( ! (sv && ! p->newln)) + return; + + /* No next node or it's not text. */ + if (NULL == (pn = TAILQ_NEXT(pn, child))) { + pnode_printmclose(p, sv); + return; + } else if (NODE_TEXT != pn->node) { + pnode_printmclose(p, sv); + return; + } + + /* Only do this for the comma/period. */ + if (pn->bsz > 0 && + (',' == pn->b[0] || '.' == pn->b[0]) && + (1 == pn->bsz || isspace((int)pn->b[1]))) { + putchar(' '); + putchar(pn->b[0]); + pn->b++; + pn->bsz--; + } + + putchar('\n'); + p->newln = 1; +} + +/* * If the SYNOPSIS macro has a superfluous title, kill it. */ static void @@ -591,10 +704,34 @@ pnode_printrefsect(struct parse *p, struct pnode *pn) if (NODE_TITLE == pp->node) break; - if (NODE_REFSECT1 == pn->node) + switch (pn->node) { + case (NODE_REFSECT1): fputs(".Sh", stdout); - else + break; + case (NODE_REFSECT2): fputs(".Ss", stdout); + break; + case (NODE_REFSECT3): + puts(".Pp"); + fputs(".Sy", stdout); + break; + case (NODE_NOTE): + /* FALLTHROUGH */ + case (NODE_REFSECTION): + /* FALLTHROUGH */ + case (NODE_TIP): + /* FALLTHROUGH */ + case (NODE_CAUTION): + /* FALLTHROUGH */ + case (NODE_WARNING): + puts(".Pp"); + if (NULL == pp) + return; + fputs(".Em", stdout); + break; + default: + break; + } p->newln = 0; @@ -605,7 +742,8 @@ pnode_printrefsect(struct parse *p, struct pnode *pn) pnode_printmclose(p, 1); pnode_unlink(pp); } else { - puts("UNKNOWN"); + puts(NODE_REFSECT1 == pn->node ? + "UNKNOWN" : "unknown"); p->newln = 1; } } @@ -619,16 +757,12 @@ pnode_printciterefentry(struct parse *p, struct pnode struct pnode *pp, *title, *manvol; title = manvol = NULL; - assert(p->newln); TAILQ_FOREACH(pp, &pn->childq, child) if (NODE_MANVOLNUM == pp->node) manvol = pp; else if (NODE_REFENTRYTITLE == pp->node) title = pp; - fputs(".Xr", stdout); - p->newln = 0; - if (NULL != title) { pnode_printmacrolinepart(p, title); } else @@ -638,7 +772,7 @@ pnode_printciterefentry(struct parse *p, struct pnode puts(" 1"); p->newln = 1; } else - pnode_printmacroline(p, manvol); + pnode_printmacrolinepart(p, manvol); } static void @@ -717,7 +851,7 @@ pnode_printparamdef(struct parse *p, struct pnode *pn) fputs(".Fa \"", stdout); p->newln = 0; if (NULL != ptype) { - pnode_printmacrolinepart(p, ptype); + pnode_printmacrolinetext(p, ptype, MACROLINE_NOWS); putchar(' '); } @@ -728,7 +862,39 @@ pnode_printparamdef(struct parse *p, struct pnode *pn) p->newln = 1; } +/* + * These math nodes require special handling because they have infix + * syntax, instead of the usual prefix or prefix. + * So we need to break up the first and second child node with a + * particular eqn(7) word. + */ static void +pnode_printmath(struct parse *p, struct pnode *pn) +{ + struct pnode *pp; + + pp = TAILQ_FIRST(&pn->childq); + pnode_print(p, pp); + + switch (pn->node) { + case (NODE_MML_MSUP): + printf(" sup "); + break; + case (NODE_MML_MFRAC): + printf(" over "); + break; + case (NODE_MML_MSUB): + printf(" sub "); + break; + default: + break; + } + + pp = TAILQ_NEXT(pp, child); + pnode_print(p, pp); +} + +static void pnode_printfuncprototype(struct parse *p, struct pnode *pn) { struct pnode *pp, *fdef; @@ -792,23 +958,56 @@ pnode_printarg(struct parse *p, struct pnode *pn) } } -/* - * Recursively search and return the first instance of "node". - */ -static struct pnode * -pnode_findfirst(struct pnode *pn, enum nodeid node) +static void +pnode_printgroup(struct parse *p, struct pnode *pn) { - struct pnode *pp, *res; + struct pnode *pp, *np; + struct pattr *ap; + int isop, sv; - res = NULL; - TAILQ_FOREACH(pp, &pn->childq, child) { - res = pp->node == node ? pp : - pnode_findfirst(pp, node); - if (NULL != res) + isop = 1; + TAILQ_FOREACH(ap, &pn->attrq, child) + if (ATTRKEY_CHOICE == ap->key && + (ATTRVAL_PLAIN == ap->val || + ATTRVAL_REQ == ap->val)) { + isop = 0; break; + } + + /* + * Make sure we're on a macro line. + * This will prevent pnode_print() for putting us on a + * subsequent line. + */ + sv = p->newln; + pnode_printmopen(p); + if (isop) + fputs("Op", stdout); + else if (sv) + fputs("No", stdout); + + /* + * Keep on printing text separated by the vertical bar as long + * as we're within the same origin node as the group. + * This is kind of a nightmare. + * Eh, DocBook... + * FIXME: if there's a "Fl", we don't cut off the leading "-" + * like we do in pnode_print(). + */ + TAILQ_FOREACH(pp, &pn->childq, child) { + pnode_print(p, pp); + np = TAILQ_NEXT(pp, child); + while (NULL != np) { + if (pp->node != np->node) + break; + fputs(" |", stdout); + pnode_printmacrolinepart(p, np); + pp = np; + np = TAILQ_NEXT(np, child); + } } - return(res); + pnode_printmclose(p, sv); } static void @@ -838,6 +1037,7 @@ pnode_printvarlistentry(struct parse *p, struct pnode assert(p->newln); TAILQ_FOREACH(pp, &pn->childq, child) if (NODE_TERM == pp->node) { + assert(p->newln); fputs(".It", stdout); p->newln = 0; pnode_print(p, pp); @@ -851,19 +1051,59 @@ pnode_printvarlistentry(struct parse *p, struct pnode } static void -pnode_printitemizedlist(struct parse *p, struct pnode *pn) +pnode_printrow(struct parse *p, struct pnode *pn) { struct pnode *pp; + puts(".Bl -dash -compact"); + + TAILQ_FOREACH(pp, &pn->childq, child) { + assert(p->newln); + puts(".It"); + pnode_print(p, pp); + pnode_printmclose(p, 1); + } assert(p->newln); + puts(".El"); +} + +static void +pnode_printtable(struct parse *p, struct pnode *pn) +{ + struct pnode *pp; + + assert(p->newln); TAILQ_FOREACH(pp, &pn->childq, child) if (NODE_TITLE == pp->node) { puts(".Pp"); pnode_print(p, pp); pnode_unlink(pp); } + assert(p->newln); + puts(".Bl -ohang"); + while (NULL != (pp = pnode_findfirst(pn, NODE_ROW))) { + puts(".It Table Row"); + pnode_printrow(p, pp); + pnode_printmclose(p, 1); + pnode_unlink(pp); + } + assert(p->newln); + puts(".El"); +} +static void +pnode_printlist(struct parse *p, struct pnode *pn) +{ + struct pnode *pp; + assert(p->newln); + TAILQ_FOREACH(pp, &pn->childq, child) + if (NODE_TITLE == pp->node) { + puts(".Pp"); + pnode_print(p, pp); + pnode_unlink(pp); + } + assert(p->newln); if (NODE_ORDEREDLIST == pn->node) puts(".Bl -enum"); @@ -927,12 +1167,20 @@ pnode_print(struct parse *p, struct pnode *pn) sv = p->newln; switch (pn->node) { + case (NODE_APPLICATION): + pnode_printmopen(p); + fputs("Nm", stdout); + break; + case (NODE_ANCHOR): + /* Don't print anything! */ + return; case (NODE_ARG): pnode_printarg(p, pn); pnode_unlinksub(pn); break; case (NODE_CITEREFENTRY): - assert(p->newln); + pnode_printmopen(p); + fputs("Xr", stdout); pnode_printciterefentry(p, pn); pnode_unlinksub(pn); break; @@ -944,6 +1192,10 @@ pnode_print(struct parse *p, struct pnode *pn) pnode_printmopen(p); fputs("Nm", stdout); break; + case (NODE_CONSTANT): + pnode_printmopen(p); + fputs("Dv", stdout); + break; case (NODE_EMPHASIS): pnode_printmopen(p); fputs("Em", stdout); @@ -970,19 +1222,48 @@ pnode_print(struct parse *p, struct pnode *pn) fputs("Fd", stdout); break; case (NODE_ITEMIZEDLIST): - /* FALLTHROUGH */ - case (NODE_ORDEREDLIST): assert(p->newln); - pnode_printitemizedlist(p, pn); + pnode_printlist(p, pn); + pnode_unlinksub(pn); break; + case (NODE_GROUP): + pnode_printgroup(p, pn); + pnode_unlinksub(pn); + break; case (NODE_LITERAL): pnode_printmopen(p); fputs("Li", stdout); break; + case (NODE_MML_MATH): + if ( ! p->newln) + putchar('\n'); + puts(".EQ"); + p->newln = 0; + break; + case (NODE_MML_MFENCED): + printf("left {"); + break; + case (NODE_MML_MROW): + case (NODE_MML_MI): + case (NODE_MML_MN): + case (NODE_MML_MO): + putchar('{'); + break; + case (NODE_MML_MFRAC): + case (NODE_MML_MSUB): + case (NODE_MML_MSUP): + pnode_printmath(p, pn); + pnode_unlinksub(pn); + break; case (NODE_OPTION): pnode_printmopen(p); fputs("Fl", stdout); break; + case (NODE_ORDEREDLIST): + assert(p->newln); + pnode_printlist(p, pn); + pnode_unlinksub(pn); + break; case (NODE_PARA): assert(p->newln); if (NULL != pn->parent && @@ -994,10 +1275,14 @@ pnode_print(struct parse *p, struct pnode *pn) /* Suppress non-text children... */ pnode_printmopen(p); fputs("Fa \"", stdout); - pnode_printmacrolinepart(p, pn); - puts("\""); + pnode_printmacrolinetext(p, pn, MACROLINE_NOWS); + fputs("\"", stdout); pnode_unlinksub(pn); break; + case (NODE_QUOTE): + pnode_printmopen(p); + fputs("Qo", stdout); + break; case (NODE_PROGRAMLISTING): /* FALLTHROUGH */ case (NODE_SCREEN): @@ -1036,6 +1321,18 @@ pnode_print(struct parse *p, struct pnode *pn) case (NODE_REFSECT1): /* FALLTHROUGH */ case (NODE_REFSECT2): + /* FALLTHROUGH */ + case (NODE_REFSECT3): + /* FALLTHROUGH */ + case (NODE_REFSECTION): + /* FALLTHROUGH */ + case (NODE_NOTE): + /* FALLTHROUGH */ + case (NODE_TIP): + /* FALLTHROUGH */ + case (NODE_CAUTION): + /* FALLTHROUGH */ + case (NODE_WARNING): assert(p->newln); pnode_printrefsect(p, pn); break; @@ -1047,15 +1344,33 @@ pnode_print(struct parse *p, struct pnode *pn) assert(p->newln); puts(".br"); break; + case (NODE_SGMLTAG): + pnode_printmopen(p); + fputs("Li", stdout); + break; case (NODE_STRUCTNAME): pnode_printmopen(p); fputs("Vt", stdout); break; + case (NODE_TABLE): + /* FALLTHROUGH */ + case (NODE_INFORMALTABLE): + assert(p->newln); + pnode_printtable(p, pn); + pnode_unlinksub(pn); + break; case (NODE_TEXT): if (0 == p->newln) putchar(' '); + bufclear(p); bufappend(p, pn); + + if (0 == p->bsz) { + assert(pn->real != pn->b); + break; + } + /* * Output all characters, squeezing out whitespace * between newlines. @@ -1064,6 +1379,7 @@ pnode_print(struct parse *p, struct pnode *pn) */ assert(p->bsz); cp = p->b; + /* * There's often a superfluous "-" in its