=================================================================== RCS file: /cvs/docbook2mdoc/docbook2mdoc.c,v retrieving revision 1.52 retrieving revision 1.61 diff -u -p -r1.52 -r1.61 --- docbook2mdoc/docbook2mdoc.c 2019/03/22 16:21:23 1.52 +++ docbook2mdoc/docbook2mdoc.c 2019/03/22 17:28:59 1.61 @@ -1,4 +1,4 @@ -/* $Id: docbook2mdoc.c,v 1.52 2019/03/22 16:21:23 schwarze Exp $ */ +/* $Id: docbook2mdoc.c,v 1.61 2019/03/22 17:28:59 schwarze Exp $ */ /* * Copyright (c) 2014 Kristaps Dzonsons * Copyright (c) 2019 Ingo Schwarze @@ -51,8 +51,7 @@ struct parse { struct node { const char *name; /* docbook element name */ - unsigned int flags; -#define NODE_IGNTEXT 1 /* ignore all contained text */ + enum nodeid node; /* docbook element to generate */ }; TAILQ_HEAD(pnodeq, pnode); @@ -78,13 +77,16 @@ struct pnode { static const char *attrkeys[ATTRKEY__MAX] = { "choice", + "class", "close", "id", + "linkend", "open", "rep" }; static const char *attrvals[ATTRVAL__MAX] = { + "monospaced", "norepeat", "opt", "plain", @@ -92,137 +94,136 @@ static const char *attrvals[ATTRVAL__MAX] = { "req" }; -static const struct node nodes[NODE__MAX] = { - { NULL, 0 }, - { "acronym", 0 }, - { "affiliation", NODE_IGNTEXT }, - { "anchor", NODE_IGNTEXT }, - { "application", 0 }, - { "arg", 0 }, - { "author", NODE_IGNTEXT }, - { "authorgroup", NODE_IGNTEXT }, - { "blockquote", NODE_IGNTEXT }, - { "book", NODE_IGNTEXT }, - { "bookinfo", NODE_IGNTEXT }, - { "caution", NODE_IGNTEXT }, - { "chapter", NODE_IGNTEXT }, - { "citerefentry", NODE_IGNTEXT }, - { "citetitle", 0 }, - { "cmdsynopsis", NODE_IGNTEXT }, - { "code", 0 }, - { "colspec", NODE_IGNTEXT }, - { "command", 0 }, - { "constant", 0 }, - { "copyright", NODE_IGNTEXT }, - { "date", 0 }, - { "editor", NODE_IGNTEXT }, - { "emphasis", 0 }, - { "entry", 0 }, - { "envar", 0 }, - { "fieldsynopsis", NODE_IGNTEXT }, - { "filename", 0 }, - { "firstname", 0 }, - { "firstterm", 0 }, - { "footnote", 0 }, - { "funcdef", 0 }, - { "funcprototype", NODE_IGNTEXT }, - { "funcsynopsis", NODE_IGNTEXT }, - { "funcsynopsisinfo", 0 }, - { "function", 0 }, - { "glossterm", 0 }, - { "group", NODE_IGNTEXT }, - { "holder", NODE_IGNTEXT }, - { "index", NODE_IGNTEXT }, - { "indexterm", NODE_IGNTEXT }, - { "info", NODE_IGNTEXT }, - { "informalequation", NODE_IGNTEXT }, - { "informaltable", NODE_IGNTEXT }, - { "inlineequation", NODE_IGNTEXT }, - { "itemizedlist", NODE_IGNTEXT }, - { "keysym", 0 }, - { "legalnotice", NODE_IGNTEXT }, - { "link", 0 }, - { "listitem", NODE_IGNTEXT }, - { "literal", 0 }, - { "literallayout", 0 }, - { "manvolnum", 0 }, - { "member", 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 }, - { "orgname", 0 }, - { "othername", 0 }, - { "para", 0 }, - { "paramdef", 0 }, - { "parameter", 0 }, - { "part", NODE_IGNTEXT }, - { "phrase", 0 }, - { "preface", NODE_IGNTEXT }, - { "primary", 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 }, - { "releaseinfo", 0 }, - { "replaceable", 0 }, - { "row", NODE_IGNTEXT }, - { "sbr", NODE_IGNTEXT }, - { "screen", NODE_IGNTEXT }, - { "secondary", 0 }, - { "sect1", NODE_IGNTEXT }, - { "sect2", NODE_IGNTEXT }, - { "section", NODE_IGNTEXT }, - { "sgmltag", 0 }, - { "simplelist", NODE_IGNTEXT }, - { "spanspec", NODE_IGNTEXT }, - { "structname", 0 }, - { "subtitle", 0 }, - { "surname", 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 const struct node nodes[] = { + { "acronym", NODE_ACRONYM }, + { "affiliation", NODE_AFFILIATION }, + { "anchor", NODE_ANCHOR }, + { "application", NODE_APPLICATION }, + { "arg", NODE_ARG }, + { "author", NODE_AUTHOR }, + { "authorgroup", NODE_AUTHORGROUP }, + { "blockquote", NODE_BLOCKQUOTE }, + { "book", NODE_BOOK }, + { "bookinfo", NODE_BOOKINFO }, + { "caution", NODE_CAUTION }, + { "chapter", NODE_SECTION }, + { "citerefentry", NODE_CITEREFENTRY }, + { "citetitle", NODE_CITETITLE }, + { "cmdsynopsis", NODE_CMDSYNOPSIS }, + { "code", NODE_CODE }, + { "colspec", NODE_COLSPEC }, + { "command", NODE_COMMAND }, + { "constant", NODE_CONSTANT }, + { "copyright", NODE_COPYRIGHT }, + { "date", NODE_DATE }, + { "editor", NODE_EDITOR }, + { "emphasis", NODE_EMPHASIS }, + { "entry", NODE_ENTRY }, + { "envar", NODE_ENVAR }, + { "fieldsynopsis", NODE_FIELDSYNOPSIS }, + { "filename", NODE_FILENAME }, + { "firstname", NODE_FIRSTNAME }, + { "firstterm", NODE_FIRSTTERM }, + { "footnote", NODE_FOOTNOTE }, + { "funcdef", NODE_FUNCDEF }, + { "funcprototype", NODE_FUNCPROTOTYPE }, + { "funcsynopsis", NODE_FUNCSYNOPSIS }, + { "funcsynopsisinfo", NODE_FUNCSYNOPSISINFO }, + { "function", NODE_FUNCTION }, + { "glossterm", NODE_GLOSSTERM }, + { "group", NODE_GROUP }, + { "holder", NODE_HOLDER }, + { "index", NODE_INDEX }, + { "indexterm", NODE_INDEXTERM }, + { "info", NODE_INFO }, + { "informalequation", NODE_INFORMALEQUATION }, + { "informaltable", NODE_INFORMALTABLE }, + { "inlineequation", NODE_INLINEEQUATION }, + { "itemizedlist", NODE_ITEMIZEDLIST }, + { "keysym", NODE_KEYSYM }, + { "legalnotice", NODE_LEGALNOTICE }, + { "link", NODE_LINK }, + { "listitem", NODE_LISTITEM }, + { "literal", NODE_LITERAL }, + { "literallayout", NODE_LITERALLAYOUT }, + { "manvolnum", NODE_MANVOLNUM }, + { "member", NODE_MEMBER }, + { "mml:math", NODE_MML_MATH }, + { "mml:mfenced", NODE_MML_MFENCED }, + { "mml:mfrac", NODE_MML_MFRAC }, + { "mml:mi", NODE_MML_MI }, + { "mml:mn", NODE_MML_MN }, + { "mml:mo", NODE_MML_MO }, + { "mml:mrow", NODE_MML_MROW }, + { "mml:msub", NODE_MML_MSUB }, + { "mml:msup", NODE_MML_MSUP }, + { "modifier", NODE_MODIFIER }, + { "note", NODE_NOTE }, + { "option", NODE_OPTION }, + { "orderedlist", NODE_ORDEREDLIST }, + { "orgname", NODE_ORGNAME }, + { "othername", NODE_OTHERNAME }, + { "para", NODE_PARA }, + { "paramdef", NODE_PARAMDEF }, + { "parameter", NODE_PARAMETER }, + { "part", NODE_SECTION }, + { "phrase", NODE_PHRASE }, + { "preface", NODE_PREFACE }, + { "primary", NODE_PRIMARY }, + { "programlisting", NODE_PROGRAMLISTING }, + { "prompt", NODE_PROMPT }, + { "quote", NODE_QUOTE }, + { "refclass", NODE_REFCLASS }, + { "refdescriptor", NODE_REFDESCRIPTOR }, + { "refentry", NODE_REFENTRY }, + { "refentryinfo", NODE_REFENTRYINFO }, + { "refentrytitle", NODE_REFENTRYTITLE }, + { "refmeta", NODE_REFMETA }, + { "refmetainfo", NODE_REFMETAINFO }, + { "refmiscinfo", NODE_REFMISCINFO }, + { "refname", NODE_REFNAME }, + { "refnamediv", NODE_REFNAMEDIV }, + { "refpurpose", NODE_REFPURPOSE }, + { "refsect1", NODE_SECTION }, + { "refsect2", NODE_SECTION }, + { "refsect3", NODE_SECTION }, + { "refsection", NODE_SECTION }, + { "refsynopsisdiv", NODE_REFSYNOPSISDIV }, + { "releaseinfo", NODE_RELEASEINFO }, + { "replaceable", NODE_REPLACEABLE }, + { "row", NODE_ROW }, + { "sbr", NODE_SBR }, + { "screen", NODE_SCREEN }, + { "secondary", NODE_SECONDARY }, + { "sect1", NODE_SECTION }, + { "sect2", NODE_SECTION }, + { "section", NODE_SECTION }, + { "sgmltag", NODE_SGMLTAG }, + { "simplelist", NODE_SIMPLELIST }, + { "spanspec", NODE_SPANSPEC }, + { "structname", NODE_STRUCTNAME }, + { "subtitle", NODE_SUBTITLE }, + { "surname", NODE_SURNAME }, + { "synopsis", NODE_SYNOPSIS }, + { "table", NODE_TABLE }, + { "tbody", NODE_TBODY }, + { "term", NODE_TERM }, + { "tfoot", NODE_TFOOT }, + { "tgroup", NODE_TGROUP }, + { "thead", NODE_THEAD }, + { "tip", NODE_TIP }, + { "title", NODE_TITLE }, + { "trademark", NODE_TRADEMARK }, + { "type", NODE_TYPE }, + { "ulink", NODE_ULINK }, + { "userinput", NODE_USERINPUT }, + { "variablelist", NODE_VARIABLELIST }, + { "varlistentry", NODE_VARLISTENTRY }, + { "varname", NODE_VARNAME }, + { "warning", NODE_WARNING }, + { "wordasword", NODE_WORDASWORD }, + { "year", NODE_YEAR }, + { NULL, NODE__MAX } }; static int warn = 0; @@ -247,10 +248,7 @@ xml_char(void *arg, const XML_Char *p, int sz) if (ps->stop || NODE_ROOT == ps->node) return; - /* Not supposed to be collecting text. */ assert(NULL != ps->cur); - if (NODE_IGNTEXT & nodes[ps->node].flags) - return; /* * Are we in the midst of processing text? @@ -323,7 +321,7 @@ static void xml_elem_start(void *arg, const XML_Char *name, const XML_Char **atts) { struct parse *ps = arg; - enum nodeid node; + const struct node *node; enum attrkey key; enum attrval val; struct pnode *dat; @@ -343,15 +341,13 @@ 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; - else if (0 == strcmp(nodes[node].name, name)) + for (node = nodes; NULL != node->name; node++) + if (0 == strcmp(node->name, name)) break; - if (NODE__MAX == node && NODE_ROOT == ps->node) { - return; - } else if (NODE__MAX == node) { + if (NULL == node->name) { + if (NODE_ROOT == ps->node) + return; fprintf(stderr, "%s:%zu:%zu: unknown node \"%s\"\n", ps->fname, XML_GetCurrentLineNumber(ps->xml), XML_GetCurrentColumnNumber(ps->xml), name); @@ -363,12 +359,9 @@ xml_elem_start(void *arg, const XML_Char *name, const XML_GetCurrentColumnNumber(ps->xml)); ps->stop = 1; return; - } else if (NODE_ROOT == ps->node && NODE_REFENTRY != node && - NODE_PART != node && NODE_BOOK != node) { - return; } - if (NODE_INLINEEQUATION == node) + if (NODE_INLINEEQUATION == node->node) ps->flags |= PARSE_EQN; if (NULL == (dat = calloc(1, sizeof(struct pnode)))) { @@ -376,7 +369,7 @@ xml_elem_start(void *arg, const XML_Char *name, const exit(EXIT_FAILURE); } - dat->node = ps->node = node; + dat->node = ps->node = node->node; dat->parent = ps->cur; TAILQ_INIT(&dat->childq); TAILQ_INIT(&dat->attrq); @@ -500,6 +493,37 @@ pnode_unlinksub(struct pnode *pn) } /* + * Retrieve an enumeration attribute from a node. + * Return ATTRVAL__MAX if the node has no such attribute. + */ +enum attrval +pnode_getattr(struct pnode *pn, enum attrkey key) +{ + struct pattr *ap; + + TAILQ_FOREACH(ap, &pn->attrq, child) + if (ap->key == key) + return ap->val; + return(ATTRVAL__MAX); +} + +/* + * Retrieve an attribute string from a node. + * Return defval if the node has no such attribute. + */ +const char * +pnode_getattr_raw(struct pnode *pn, enum attrkey key, const char *defval) +{ + struct pattr *ap; + + TAILQ_FOREACH(ap, &pn->attrq, child) + if (ap->key == key) + return ATTRVAL__MAX == ap->val ? ap->rawval : + attrvals[ap->val]; + return(defval); +} + +/* * Reset the lookaside buffer. */ static void @@ -690,6 +714,31 @@ pnode_printmclosepunct(struct parse *p, struct pnode * p->newln = 1; } +static void +pnode_printpara(struct parse *p, struct pnode *pn) +{ + struct pnode *pp; + + assert(p->newln); + if ((pp = TAILQ_PREV(pn, pnodeq, child)) == NULL && + (pp = pn->parent) == NULL) + return; + + switch (pp->node) { + case NODE_ENTRY: + case NODE_LISTITEM: + return; + case NODE_PREFACE: + case NODE_SECTION: + if (p->level < 3) + return; + break; + default: + break; + } + puts(".Pp"); +} + /* * If the SYNOPSIS macro has a superfluous title, kill it. */ @@ -715,6 +764,9 @@ pnode_printrefsect(struct parse *p, struct pnode *pn) const char *title; int flags, level; + if (NULL == pn->parent) + return; + level = ++p->level; flags = 1 == level ? MACROLINE_UPPER : 0; if (3 > level) { @@ -765,7 +817,7 @@ pnode_printrefsect(struct parse *p, struct pnode *pn) fputs(".Ss", stdout); break; default: - puts(".Pp"); + pnode_printpara(p, pn); fputs(".Sy", stdout); break; } @@ -900,15 +952,8 @@ static void pnode_printmathfenced(struct parse *p, struct pnode *pn) { struct pnode *pp; - struct pattr *ap; - TAILQ_FOREACH(ap, &pn->attrq, child) - if (ATTRKEY_OPEN == ap->key) { - printf("left %s ", ap->rawval); - break; - } - if (NULL == ap) - printf("left ( "); + printf("left %s ", pnode_getattr_raw(pn, ATTRKEY_OPEN, "(")); pp = TAILQ_FIRST(&pn->childq); pnode_print(p, pp); @@ -918,13 +963,7 @@ pnode_printmathfenced(struct parse *p, struct pnode *p pnode_print(p, pp); } - TAILQ_FOREACH(ap, &pn->attrq, child) - if (ATTRKEY_CLOSE == ap->key) { - printf("right %s ", ap->rawval); - break; - } - if (NULL == ap) - printf("right ) "); + printf("right %s ", pnode_getattr_raw(pn, ATTRKEY_CLOSE, ")")); } /* @@ -1079,8 +1118,6 @@ static void pnode_printprologue(struct parse *p, struct pnode *pn) { struct pnode *pp; - struct pattr *ap; - const char *name; pp = NULL == p->root ? NULL : pnode_findfirst(p->root, NODE_REFMETA); @@ -1089,16 +1126,9 @@ pnode_printprologue(struct parse *p, struct pnode *pn) if (NULL != pp) { pnode_printrefmeta(p, pp); pnode_unlink(pp); - } else { - name = "UNKNOWN"; - TAILQ_FOREACH(ap, &p->root->attrq, child) { - if (ATTRKEY_ID == ap->key) { - name = ap->rawval; - break; - } - } - printf(".Dt %s 1\n", name); - } + } else + printf(".Dt %s 1\n", + pnode_getattr_raw(p->root, ATTRKEY_ID, "UNKNOWN")); puts(".Os"); if (PARSE_EQN & p->flags) { @@ -1161,7 +1191,7 @@ pnode_printtable(struct parse *p, struct pnode *pn) assert(p->newln); TAILQ_FOREACH(pp, &pn->childq, child) if (NODE_TITLE == pp->node) { - puts(".Pp"); + pnode_printpara(p, pp); pnode_print(p, pp); pnode_unlink(pp); } @@ -1185,7 +1215,7 @@ pnode_printlist(struct parse *p, struct pnode *pn) assert(p->newln); TAILQ_FOREACH(pp, &pn->childq, child) if (NODE_TITLE == pp->node) { - puts(".Pp"); + pnode_printpara(p, pp); pnode_print(p, pp); pnode_unlink(pp); } @@ -1194,7 +1224,7 @@ pnode_printlist(struct parse *p, struct pnode *pn) if (NODE_ORDEREDLIST == pn->node) puts(".Bl -enum"); else - puts(".Bl -item"); + puts(".Bl -bullet"); TAILQ_FOREACH(pp, &pn->childq, child) { assert(p->newln); @@ -1214,7 +1244,7 @@ pnode_printvariablelist(struct parse *p, struct pnode assert(p->newln); TAILQ_FOREACH(pp, &pn->childq, child) if (NODE_TITLE == pp->node) { - puts(".Pp"); + pnode_printpara(p, pp); pnode_print(p, pp); pnode_unlink(pp); } @@ -1244,6 +1274,7 @@ static void pnode_print(struct parse *p, struct pnode *pn) { struct pnode *pp; + const char *ccp; char *cp; int last, sv; @@ -1301,6 +1332,7 @@ pnode_print(struct parse *p, struct pnode *pn) fputs("An", stdout); break; case (NODE_EMPHASIS): + case (NODE_FIRSTTERM): pnode_printmopen(p); fputs("Em", stdout); break; @@ -1325,6 +1357,8 @@ pnode_print(struct parse *p, struct pnode *pn) pnode_printmopen(p); fputs("Fd", stdout); break; + case (NODE_INDEXTERM): + return; case (NODE_INFORMALEQUATION): if ( ! p->newln) putchar('\n'); @@ -1348,10 +1382,22 @@ pnode_print(struct parse *p, struct pnode *pn) assert(p->newln); puts(".Sh LEGAL NOTICE"); break; + case (NODE_LINK): + ccp = pnode_getattr_raw(pn, ATTRKEY_LINKEND, NULL); + if (NULL == ccp) + break; + pnode_printmopen(p); + printf("Sx %s\n", ccp); + p->newln = 1; + return; case (NODE_LITERAL): pnode_printmopen(p); fputs("Li", stdout); break; + case (NODE_LITERALLAYOUT): + assert(p->newln); + puts(".Bd -literal"); + break; case (NODE_MML_MFENCED): pnode_printmathfenced(p, pn); pnode_unlinksub(pn); @@ -1380,11 +1426,7 @@ pnode_print(struct parse *p, struct pnode *pn) pnode_unlinksub(pn); break; case (NODE_PARA): - assert(p->newln); - if (NULL != pn->parent && - NODE_LISTITEM == pn->parent->node) - break; - puts(".Pp"); + pnode_printpara(p, pn); break; case (NODE_PARAMETER): /* Suppress non-text children... */ @@ -1398,13 +1440,12 @@ pnode_print(struct parse *p, struct pnode *pn) pnode_printmopen(p); fputs("Qo", stdout); break; - case (NODE_LITERALLAYOUT): - /* FALLTHROUGH */ case (NODE_PROGRAMLISTING): - /* FALLTHROUGH */ case (NODE_SCREEN): assert(p->newln); - puts(".Bd -literal"); + printf(".Bd %s\n", ATTRVAL_MONOSPACED == + pnode_getattr(pn, ATTRKEY_CLASS) ? + "-literal" : "-unfilled"); break; case (NODE_REFENTRYINFO): /* Suppress. */ @@ -1436,13 +1477,6 @@ pnode_print(struct parse *p, struct pnode *pn) puts(".Sh SYNOPSIS"); break; case (NODE_PREFACE): - case (NODE_REFSECT1): - case (NODE_REFSECT2): - case (NODE_REFSECT3): - case (NODE_REFSECTION): - case (NODE_CHAPTER): - case (NODE_SECT1): - case (NODE_SECT2): case (NODE_SECTION): case (NODE_NOTE): case (NODE_TIP): @@ -1585,6 +1619,7 @@ pnode_print(struct parse *p, struct pnode *pn) case (NODE_EMPHASIS): case (NODE_ENVAR): case (NODE_FILENAME): + case (NODE_FIRSTTERM): case (NODE_FUNCTION): case (NODE_FUNCSYNOPSISINFO): case (NODE_LITERAL): @@ -1621,13 +1656,6 @@ pnode_print(struct parse *p, struct pnode *pn) pnode_printmclose(p, sv); break; case (NODE_PREFACE): - case (NODE_REFSECT1): - case (NODE_REFSECT2): - case (NODE_REFSECT3): - case (NODE_REFSECTION): - case (NODE_CHAPTER): - case (NODE_SECT1): - case (NODE_SECT2): case (NODE_SECTION): case (NODE_NOTE): case (NODE_TIP):