=================================================================== RCS file: /cvs/docbook2mdoc/docbook2mdoc.c,v retrieving revision 1.12 retrieving revision 1.13 diff -u -p -r1.12 -r1.13 --- docbook2mdoc/docbook2mdoc.c 2014/03/29 22:44:06 1.12 +++ docbook2mdoc/docbook2mdoc.c 2014/03/30 11:48:10 1.13 @@ -1,4 +1,4 @@ -/* $Id: docbook2mdoc.c,v 1.12 2014/03/29 22:44:06 kristaps Exp $ */ +/* $Id: docbook2mdoc.c,v 1.13 2014/03/30 11:48:10 kristaps Exp $ */ /* * Copyright (c) 2014 Kristaps Dzonsons * @@ -26,72 +26,9 @@ #include #include -/* - * All recognised node types. - */ -enum nodeid { - NODE_ROOT = 0, /* Must comes first. */ - /* Alpha-ordered hereafter. */ - NODE_ARG, - NODE_CITEREFENTRY, - NODE_CMDSYNOPSIS, - NODE_CODE, - NODE_COMMAND, - NODE_FUNCDEF, - NODE_FUNCPROTOTYPE, - NODE_FUNCSYNOPSIS, - NODE_FUNCSYNOPSISINFO, - NODE_FUNCTION, - NODE_MANVOLNUM, - NODE_OPTION, - NODE_PARA, - NODE_PARAMDEF, - NODE_PARAMETER, - NODE_PROGRAMLISTING, - NODE_REFCLASS, - NODE_REFDESCRIPTOR, - NODE_REFENTRY, - NODE_REFENTRYTITLE, - NODE_REFMETA, - NODE_REFMISCINFO, - NODE_REFNAME, - NODE_REFNAMEDIV, - NODE_REFPURPOSE, - NODE_REFSECT1, - NODE_REFSYNOPSISDIV, - NODE_STRUCTNAME, - NODE_SYNOPSIS, - NODE_TEXT, - NODE_TITLE, - NODE__MAX -}; +#include "extern.h" /* - * All recognised attribute keys. - */ -enum attrkey { - /* Alpha-order... */ - ATTRKEY_CHOICE = 0, - ATTRKEY_ID, - ATTRKEY_REP, - ATTRKEY__MAX -}; - -/* - * All [explicitly] recognised attribute values. - * If an attribute has ATTRVAL__MAX, it could be a free-form. - */ -enum attrval { - /* Alpha-order... */ - ATTRVAL_NOREPEAT, - ATTRVAL_OPT, - ATTRVAL_PLAIN, - ATTRVAL_REPEAT, - ATTRVAL_REQ, - ATTRVAL__MAX -}; - -/* * Global parse state. * Keep this as simple and small as possible. */ @@ -155,11 +92,13 @@ static const struct node nodes[NODE__MAX] = { { "cmdsynopsis", NODE_IGNTEXT }, { "code", 0 }, { "command", 0 }, + { "emphasis", 0 }, { "funcdef", 0 }, { "funcprototype", NODE_IGNTEXT }, { "funcsynopsis", NODE_IGNTEXT }, { "funcsynopsisinfo", 0 }, { "function", 0 }, + { "listitem", NODE_IGNTEXT }, { "manvolnum", 0 }, { "option", 0 }, { "para", 0 }, @@ -177,309 +116,20 @@ static const struct node nodes[NODE__MAX] = { { "refpurpose", 0 }, { "refsect1", 0 }, { "refsynopsisdiv", NODE_IGNTEXT }, + { "replaceable", 0 }, { "structname", 0 }, { "synopsis", 0 }, + { "term", 0 }, { NULL, 0 }, { "title", 0 }, + { "variablelist", NODE_IGNTEXT }, + { "varlistentry", NODE_IGNTEXT }, }; static void pnode_print(struct parse *p, struct pnode *pn); -static int -isattrkey(enum nodeid node, enum attrkey key) -{ - - switch (key) { - case (ATTRKEY_CHOICE): - return(node == NODE_ARG); - case (ATTRKEY_ID): - /* Common to all. */ - return(1); - case (ATTRKEY_REP): - return(node == NODE_ARG); - default: - break; - } - abort(); - return(0); -} - -static int -isattrval(enum attrkey key, enum attrval val) -{ - - switch (val) { - case (ATTRVAL_OPT): - case (ATTRVAL_PLAIN): - case (ATTRVAL_REQ): - return(key == ATTRKEY_CHOICE); - case (ATTRVAL_REPEAT): - case (ATTRVAL_NOREPEAT): - return(key == ATTRKEY_REP); - default: - break; - } - abort(); - return(0); -} - /* - * Look up whether "parent" is a valid parent for "node". - * This is sucked directly from the DocBook specification: look at the - * "children" and "parent" sections of each node. - */ -static int -isparent(enum nodeid node, enum nodeid parent) -{ - - switch (node) { - case (NODE_ROOT): - return(0); - case (NODE_ARG): - switch (parent) { - case (NODE_ARG): - case (NODE_CMDSYNOPSIS): - return(1); - default: - break; - } - return(0); - case (NODE_CITEREFENTRY): - switch (parent) { - case (NODE_FUNCSYNOPSISINFO): - case (NODE_PARA): - case (NODE_PROGRAMLISTING): - case (NODE_REFDESCRIPTOR): - case (NODE_REFENTRYTITLE): - case (NODE_REFNAME): - case (NODE_REFPURPOSE): - case (NODE_SYNOPSIS): - case (NODE_TITLE): - return(1); - default: - break; - } - return(0); - case (NODE_CMDSYNOPSIS): - switch (parent) { - case (NODE_PARA): - case (NODE_REFSECT1): - case (NODE_REFSYNOPSISDIV): - return(1); - default: - break; - } - return(0); - case (NODE_CODE): - switch (parent) { - case (NODE_FUNCSYNOPSISINFO): - case (NODE_PARA): - case (NODE_PROGRAMLISTING): - case (NODE_REFDESCRIPTOR): - case (NODE_REFENTRYTITLE): - case (NODE_REFNAME): - case (NODE_REFPURPOSE): - case (NODE_SYNOPSIS): - case (NODE_TITLE): - return(1); - default: - break; - } - return(0); - case (NODE_COMMAND): - switch (parent) { - case (NODE_CMDSYNOPSIS): - case (NODE_FUNCSYNOPSISINFO): - case (NODE_PARA): - case (NODE_PROGRAMLISTING): - case (NODE_REFDESCRIPTOR): - case (NODE_REFENTRYTITLE): - case (NODE_REFNAME): - case (NODE_REFPURPOSE): - case (NODE_SYNOPSIS): - case (NODE_TITLE): - return(1); - default: - break; - } - return(0); - case (NODE_FUNCDEF): - return(NODE_FUNCPROTOTYPE == parent); - case (NODE_FUNCPROTOTYPE): - return(NODE_FUNCSYNOPSIS == parent); - case (NODE_FUNCSYNOPSIS): - switch (parent) { - case (NODE_PARA): - case (NODE_REFSECT1): - case (NODE_REFSYNOPSISDIV): - return(1); - default: - break; - } - return(0); - case (NODE_FUNCSYNOPSISINFO): - return(NODE_FUNCSYNOPSIS == parent); - case (NODE_FUNCTION): - switch (parent) { - case (NODE_CODE): - case (NODE_FUNCDEF): - case (NODE_FUNCSYNOPSISINFO): - case (NODE_PARA): - case (NODE_PROGRAMLISTING): - case (NODE_REFDESCRIPTOR): - case (NODE_REFENTRYTITLE): - case (NODE_REFNAME): - case (NODE_REFPURPOSE): - case (NODE_SYNOPSIS): - case (NODE_TITLE): - return(1); - default: - break; - } - return(0); - case (NODE_MANVOLNUM): - switch (parent) { - case (NODE_CITEREFENTRY): - case (NODE_REFMETA): - return(1); - default: - break; - } - return(0); - case (NODE_OPTION): - switch (parent) { - case (NODE_ARG): - case (NODE_FUNCSYNOPSISINFO): - case (NODE_PARA): - case (NODE_PROGRAMLISTING): - case (NODE_REFDESCRIPTOR): - case (NODE_REFENTRYTITLE): - case (NODE_REFNAME): - case (NODE_REFPURPOSE): - case (NODE_SYNOPSIS): - case (NODE_TITLE): - return(1); - default: - break; - } - return(0); - case (NODE_PARA): - switch (parent) { - case (NODE_REFSECT1): - case (NODE_REFSYNOPSISDIV): - return(1); - default: - break; - } - return(0); - case (NODE_PARAMDEF): - return(NODE_FUNCPROTOTYPE == parent); - case (NODE_PARAMETER): - switch (parent) { - case (NODE_CODE): - case (NODE_FUNCSYNOPSISINFO): - case (NODE_PARA): - case (NODE_PARAMDEF): - case (NODE_PROGRAMLISTING): - case (NODE_REFDESCRIPTOR): - case (NODE_REFENTRYTITLE): - case (NODE_REFNAME): - case (NODE_REFPURPOSE): - case (NODE_SYNOPSIS): - case (NODE_TITLE): - return(1); - default: - break; - } - return(0); - case (NODE_PROGRAMLISTING): - switch (parent) { - case (NODE_PARA): - case (NODE_REFSECT1): - case (NODE_REFSYNOPSISDIV): - return(1); - default: - break; - } - return(0); - case (NODE_REFCLASS): - return(parent == NODE_REFNAMEDIV); - case (NODE_REFDESCRIPTOR): - return(parent == NODE_REFNAMEDIV); - case (NODE_REFENTRY): - return(parent == NODE_ROOT); - case (NODE_REFENTRYTITLE): - switch (parent) { - case (NODE_CITEREFENTRY): - case (NODE_REFMETA): - return(1); - default: - break; - } - case (NODE_REFMETA): - return(parent == NODE_REFENTRY); - case (NODE_REFMISCINFO): - return(parent == NODE_REFMETA); - case (NODE_REFNAME): - return(parent == NODE_REFNAMEDIV); - case (NODE_REFNAMEDIV): - return(parent == NODE_REFENTRY); - case (NODE_REFPURPOSE): - return(parent == NODE_REFNAMEDIV); - case (NODE_REFSECT1): - return(parent == NODE_REFENTRY); - case (NODE_REFSYNOPSISDIV): - return(parent == NODE_REFENTRY); - case (NODE_STRUCTNAME): - switch (parent) { - case (NODE_CODE): - case (NODE_FUNCSYNOPSISINFO): - case (NODE_FUNCTION): - case (NODE_OPTION): - case (NODE_PARA): - case (NODE_PARAMETER): - case (NODE_PROGRAMLISTING): - case (NODE_REFDESCRIPTOR): - case (NODE_REFENTRYTITLE): - case (NODE_REFNAME): - case (NODE_REFPURPOSE): - case (NODE_SYNOPSIS): - case (NODE_TITLE): - return(1); - default: - break; - } - return(0); - case (NODE_SYNOPSIS): - switch (parent) { - case (NODE_REFSYNOPSISDIV): - case (NODE_REFSECT1): - return(1); - default: - break; - } - return(0); - case (NODE_TITLE): - switch (parent) { - case (NODE_REFSECT1): - case (NODE_REFSYNOPSISDIV): - return(1); - default: - break; - } - return(0); - case (NODE_TEXT): - return(1); - case (NODE__MAX): - break; - } - - abort(); - return(0); -} - -/* * Process a stream of characters. * We store text as nodes in and of themselves. * If a text node is already open, append to it. @@ -613,11 +263,14 @@ xml_elem_start(void *arg, const XML_Char *name, const } else if (NODE_ROOT == ps->node && NODE_REFENTRY != node) { return; } else if ( ! isparent(node, ps->node)) { - fprintf(stderr, "%s:%zu:%zu: bad parent \"%s\"\n", + fprintf(stderr, "%s:%zu:%zu: bad parent \"%s\" " + "of node \"%s\"\n", ps->fname, XML_GetCurrentLineNumber(ps->xml), XML_GetCurrentColumnNumber(ps->xml), NULL == nodes[ps->node].name ? - "(none)" : nodes[ps->node].name); + "(none)" : nodes[ps->node].name, + NULL == nodes[node].name ? + "(none)" : nodes[node].name); ps->stop = 1; return; } @@ -820,6 +473,9 @@ pnode_printmacrolinetext(struct parse *p, struct pnode { char *cp; + if (0 == p->newln) + putchar(' '); + bufclear(p); bufappend_r(p, pn); @@ -867,8 +523,10 @@ static void pnode_printmacroline(struct parse *p, struct pnode *pn) { + assert(0 == p->newln); pnode_printmacrolinetext(p, pn, 0); putchar('\n'); + p->newln = 1; } static void @@ -918,13 +576,16 @@ pnode_printrefsect(struct parse *p, struct pnode *pn) if (NODE_TITLE == pp->node) break; - fputs(".Sh ", stdout); + fputs(".Sh", stdout); + p->newln = 0; if (NULL != pp) { pnode_printmacroline(p, pp); pnode_unlink(pp); - } else + } else { puts("UNKNOWN"); + p->newln = 1; + } } /* @@ -936,24 +597,26 @@ 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); + fputs(".Xr", stdout); + p->newln = 0; if (NULL != title) { pnode_printmacrolinepart(p, title); - putchar(' '); } else - fputs("unknown ", stdout); + fputs(" unknown ", stdout); - if (NULL != manvol) + if (NULL == manvol) { + puts(" 1"); + p->newln = 1; + } else pnode_printmacroline(p, manvol); - else - puts("1"); } static void @@ -962,6 +625,7 @@ pnode_printrefmeta(struct parse *p, struct pnode *pn) struct pnode *pp, *title, *manvol; title = manvol = NULL; + assert(p->newln); TAILQ_FOREACH(pp, &pn->childq, child) if (NODE_MANVOLNUM == pp->node) manvol = pp; @@ -969,19 +633,19 @@ pnode_printrefmeta(struct parse *p, struct pnode *pn) title = pp; puts(".Dd $Mdocdate" "$"); - fputs(".Dt ", stdout); + fputs(".Dt", stdout); + p->newln = 0; - if (NULL != title) { - /* FIXME: uppercase. */ + if (NULL != title) pnode_printmacrolinetext(p, title, MACROLINE_UPPER); - putchar(' '); - } else - fputs("UNKNOWN ", stdout); + else + fputs(" UNKNOWN ", stdout); - if (NULL != manvol) + if (NULL == manvol) { + puts(" 1"); + p->newln = 1; + } else pnode_printmacroline(p, manvol); - else - puts("1"); puts(".Os"); } @@ -991,6 +655,7 @@ pnode_printfuncdef(struct parse *p, struct pnode *pn) { struct pnode *pp, *ftype, *func; + assert(p->newln); ftype = func = NULL; TAILQ_FOREACH(pp, &pn->childq, child) if (NODE_TEXT == pp->node) @@ -999,15 +664,19 @@ pnode_printfuncdef(struct parse *p, struct pnode *pn) func = pp; if (NULL != ftype) { - fputs(".Ft ", stdout); + fputs(".Ft", stdout); + p->newln = 0; pnode_printmacroline(p, ftype); } if (NULL != func) { - fputs(".Fo ", stdout); + fputs(".Fo", stdout); + p->newln = 0; pnode_printmacroline(p, func); - } else + } else { puts(".Fo UNKNOWN"); + p->newln = 1; + } } static void @@ -1015,6 +684,7 @@ pnode_printparamdef(struct parse *p, struct pnode *pn) { struct pnode *pp, *ptype, *param; + assert(p->newln); ptype = param = NULL; TAILQ_FOREACH(pp, &pn->childq, child) if (NODE_TEXT == pp->node) @@ -1023,6 +693,7 @@ pnode_printparamdef(struct parse *p, struct pnode *pn) param = pp; fputs(".Fa \"", stdout); + p->newln = 0; if (NULL != ptype) { pnode_printmacrolinepart(p, ptype); putchar(' '); @@ -1032,6 +703,7 @@ pnode_printparamdef(struct parse *p, struct pnode *pn) pnode_printmacrolinepart(p, param); puts("\""); + p->newln = 1; } static void @@ -1039,6 +711,7 @@ pnode_printfuncprototype(struct parse *p, struct pnode { struct pnode *pp, *fdef; + assert(p->newln); TAILQ_FOREACH(fdef, &pn->childq, child) if (NODE_FUNCDEF == fdef->node) break; @@ -1053,6 +726,7 @@ pnode_printfuncprototype(struct parse *p, struct pnode pnode_printparamdef(p, pp); puts(".Fc"); + p->newln = 1; } /* @@ -1082,13 +756,13 @@ pnode_printarg(struct parse *p, struct pnode *pn) if (isop) { pnode_printmopen(p); - fputs("Op ", stdout); + fputs("Op", stdout); } TAILQ_FOREACH(pp, &pn->childq, child) { if (NODE_TEXT == pp->node) { pnode_printmopen(p); - fputs("Ar ", stdout); + fputs("Ar", stdout); } pnode_print(p, pp); if (NODE_TEXT == pp->node && isrep) @@ -1134,6 +808,55 @@ pnode_printprologue(struct parse *p, struct pnode *pn) } } +static void +pnode_printvarlistentry(struct parse *p, struct pnode *pn) +{ + struct pnode *pp; + + assert(p->newln); + TAILQ_FOREACH(pp, &pn->childq, child) + if (NODE_TERM == pp->node) { + fputs(".It", stdout); + p->newln = 0; + pnode_print(p, pp); + pnode_unlink(pp); + putchar('\n'); + p->newln = 1; + return; + } + + puts(".It"); + p->newln = 1; +} + +static void +pnode_printvariablelist(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 -tag -width Ds"); + TAILQ_FOREACH(pp, &pn->childq, child) + if (NODE_VARLISTENTRY != pp->node) { + assert(p->newln); + fputs(".It", stdout); + pnode_printmacroline(p, pp); + } else { + assert(p->newln); + pnode_print(p, pp); + } + assert(p->newln); + puts(".El"); +} + /* * Print a parsed node (or ignore it--whatever). * This is a recursive function. @@ -1163,15 +886,19 @@ pnode_print(struct parse *p, struct pnode *pn) break; case (NODE_CODE): pnode_printmopen(p); - fputs("Li ", stdout); + fputs("Li", stdout); break; case (NODE_COMMAND): pnode_printmopen(p); - fputs("Nm ", stdout); + fputs("Nm", stdout); break; + case (NODE_EMPHASIS): + pnode_printmopen(p); + fputs("Em", stdout); + break; case (NODE_FUNCTION): pnode_printmopen(p); - fputs("Fn ", stdout); + fputs("Fn", stdout); break; case (NODE_FUNCPROTOTYPE): assert(p->newln); @@ -1180,14 +907,18 @@ pnode_print(struct parse *p, struct pnode *pn) break; case (NODE_FUNCSYNOPSISINFO): pnode_printmopen(p); - fputs("Fd ", stdout); + fputs("Fd", stdout); break; case (NODE_OPTION): pnode_printmopen(p); - fputs("Fl ", stdout); + fputs("Fl", stdout); + /* FIXME: bogus leading '-'? */ break; case (NODE_PARA): assert(p->newln); + if (NULL != pn->parent && + NODE_LISTITEM == pn->parent->node) + break; puts(".Pp"); break; case (NODE_PARAMETER): @@ -1208,7 +939,8 @@ pnode_print(struct parse *p, struct pnode *pn) case (NODE_REFNAME): /* Suppress non-text children... */ pnode_printmopen(p); - fputs("Nm ", stdout); + fputs("Nm", stdout); + p->newln = 0; pnode_printmacrolinepart(p, pn); pnode_unlinksub(pn); break; @@ -1218,7 +950,8 @@ pnode_print(struct parse *p, struct pnode *pn) break; case (NODE_REFPURPOSE): assert(p->newln); - fputs(".Nd ", stdout); + pnode_printmopen(p); + fputs("Nd", stdout); break; case (NODE_REFSYNOPSISDIV): assert(p->newln); @@ -1229,11 +962,17 @@ pnode_print(struct parse *p, struct pnode *pn) assert(p->newln); pnode_printrefsect(p, pn); break; + case (NODE_REPLACEABLE): + pnode_printmopen(p); + fputs("Ar", stdout); + break; case (NODE_STRUCTNAME): pnode_printmopen(p); - fputs("Vt ", stdout); + fputs("Vt", stdout); break; case (NODE_TEXT): + if (0 == p->newln) + putchar(' '); bufclear(p); bufappend(p, pn); /* @@ -1260,6 +999,15 @@ pnode_print(struct parse *p, struct pnode *pn) } p->newln = 0; break; + case (NODE_VARIABLELIST): + assert(p->newln); + pnode_printvariablelist(p, pn); + pnode_unlinksub(pn); + break; + case (NODE_VARLISTENTRY): + assert(p->newln); + pnode_printvarlistentry(p, pn); + break; default: break; } @@ -1271,10 +1019,13 @@ pnode_print(struct parse *p, struct pnode *pn) case (NODE_ARG): case (NODE_CODE): case (NODE_COMMAND): + case (NODE_EMPHASIS): case (NODE_FUNCTION): case (NODE_FUNCSYNOPSISINFO): case (NODE_OPTION): case (NODE_PARAMETER): + case (NODE_REPLACEABLE): + case (NODE_REFPURPOSE): case (NODE_STRUCTNAME): case (NODE_TEXT): pnode_printmclose(p, sv);