=================================================================== RCS file: /cvs/docbook2mdoc/docbook2mdoc.c,v retrieving revision 1.18 retrieving revision 1.36 diff -u -p -r1.18 -r1.36 --- docbook2mdoc/docbook2mdoc.c 2014/03/30 16:33:27 1.18 +++ docbook2mdoc/docbook2mdoc.c 2014/04/30 10:11:24 1.36 @@ -1,4 +1,4 @@ -/* $Id: docbook2mdoc.c,v 1.18 2014/03/30 16:33:27 kristaps Exp $ */ +/* $Id: docbook2mdoc.c,v 1.36 2014/04/30 10:11:24 kristaps Exp $ */ /* * Copyright (c) 2014 Kristaps Dzonsons * @@ -87,28 +87,45 @@ 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 }, { "command", 0 }, + { "constant", 0 }, + { "copyright", NODE_IGNTEXT }, { "date", 0 }, { "emphasis", 0 }, + { "entry", 0 }, + { "envar", 0 }, { "filename", 0 }, { "funcdef", 0 }, { "funcprototype", NODE_IGNTEXT }, { "funcsynopsis", NODE_IGNTEXT }, { "funcsynopsisinfo", 0 }, { "function", 0 }, + { "group", NODE_IGNTEXT }, + { "holder", NODE_IGNTEXT }, + { "info", NODE_IGNTEXT }, + { "informaltable", NODE_IGNTEXT }, { "itemizedlist", NODE_IGNTEXT }, { "link", 0 }, { "listitem", NODE_IGNTEXT }, + { "literal", 0 }, { "manvolnum", 0 }, + { "note", NODE_IGNTEXT }, { "option", 0 }, + { "orderedlist", NODE_IGNTEXT }, { "para", 0 }, { "paramdef", 0 }, { "parameter", 0 }, { "programlisting", 0 }, + { "prompt", 0 }, + { "quote", 0 }, { "refclass", NODE_IGNTEXT }, { "refdescriptor", NODE_IGNTEXT }, { "refentry", NODE_IGNTEXT }, @@ -119,17 +136,36 @@ static const struct node nodes[NODE__MAX] = { { "refname", 0 }, { "refnamediv", NODE_IGNTEXT }, { "refpurpose", 0 }, - { "refsect1", 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 }, { "ulink", 0 }, + { "userinput", 0 }, { "variablelist", NODE_IGNTEXT }, { "varlistentry", NODE_IGNTEXT }, + { "varname", 0 }, + { "warning", NODE_IGNTEXT }, + { "wordasword", 0 }, + { "year", NODE_IGNTEXT }, }; static void @@ -234,7 +270,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... */ @@ -246,6 +283,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; @@ -306,15 +344,17 @@ 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, + 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, + fprintf(stderr, "%s:%zu:%zu: warning: " + "bad attribute \"%s\"\n", + ps->fname, XML_GetCurrentLineNumber(ps->xml), XML_GetCurrentColumnNumber(ps->xml), *att); @@ -324,8 +364,9 @@ xml_elem_start(void *arg, const XML_Char *name, const 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, + fprintf(stderr, "%s:%zu:%zu: warning: " + "bad attribute value \"%s\"\n", + ps->fname, XML_GetCurrentLineNumber(ps->xml), XML_GetCurrentColumnNumber(ps->xml), *(att + 1)); @@ -351,8 +392,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) { @@ -468,8 +512,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. @@ -479,7 +543,7 @@ pnode_printmacrolinetext(struct parse *p, struct pnode { char *cp; - if (0 == p->newln) + if (0 == p->newln && ! (MACROLINE_NOWS & fl)) putchar(' '); bufclear(p); @@ -582,15 +646,46 @@ pnode_printrefsect(struct parse *p, struct pnode *pn) if (NODE_TITLE == pp->node) break; - fputs(".Sh", stdout); + switch (pn->node) { + case (NODE_REFSECT1): + fputs(".Sh", stdout); + 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; if (NULL != pp) { - pnode_printmacrolinetext(p, pp, MACROLINE_UPPER); + pnode_printmacrolinetext(p, pp, + NODE_REFSECT1 == pn->node ? + MACROLINE_UPPER : 0); pnode_printmclose(p, 1); pnode_unlink(pp); } else { - puts("UNKNOWN"); + puts(NODE_REFSECT1 == pn->node ? + "UNKNOWN" : "unknown"); p->newln = 1; } } @@ -604,16 +699,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 @@ -623,7 +714,7 @@ pnode_printciterefentry(struct parse *p, struct pnode puts(" 1"); p->newln = 1; } else - pnode_printmacroline(p, manvol); + pnode_printmacrolinepart(p, manvol); } static void @@ -702,7 +793,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(' '); } @@ -777,23 +868,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 @@ -823,6 +947,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); @@ -836,20 +961,65 @@ 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); - puts(".Bl -item"); + 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"); + else + puts(".Bl -item"); + TAILQ_FOREACH(pp, &pn->childq, child) { assert(p->newln); puts(".It"); @@ -891,7 +1061,8 @@ pnode_printvariablelist(struct parse *p, struct pnode /* * Print a parsed node (or ignore it--whatever). * This is a recursive function. - * FIXME: macro line continuation? + * FIXME: if we're in a literal context ( or or + * whatever), don't print inline macros. */ static void pnode_print(struct parse *p, struct pnode *pn) @@ -906,12 +1077,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; @@ -923,10 +1102,18 @@ 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); break; + case (NODE_ENVAR): + pnode_printmopen(p); + fputs("Ev", stdout); + break; case (NODE_FILENAME): pnode_printmopen(p); fputs("Pa", stdout); @@ -946,13 +1133,26 @@ pnode_print(struct parse *p, struct pnode *pn) break; case (NODE_ITEMIZEDLIST): 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_OPTION): pnode_printmopen(p); fputs("Fl", stdout); - /* FIXME: bogus leading '-'? */ 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 && @@ -964,11 +1164,17 @@ 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): assert(p->newln); puts(".Bd -literal"); break; @@ -1002,6 +1208,20 @@ pnode_print(struct parse *p, struct pnode *pn) puts(".Sh SYNOPSIS"); break; 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; @@ -1009,10 +1229,25 @@ pnode_print(struct parse *p, struct pnode *pn) pnode_printmopen(p); fputs("Ar", stdout); break; + case (NODE_SBR): + 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(' '); @@ -1025,7 +1260,17 @@ pnode_print(struct parse *p, struct pnode *pn) * Remember to escape control characters and escapes. */ assert(p->bsz); - for (last = '\n', cp = p->b; '\0' != *cp; ) { + cp = p->b; + /* + * There's often a superfluous "-" in its