=================================================================== RCS file: /cvs/docbook2mdoc/docbook2mdoc.c,v retrieving revision 1.12 retrieving revision 1.40 diff -u -p -r1.12 -r1.40 --- docbook2mdoc/docbook2mdoc.c 2014/03/29 22:44:06 1.12 +++ docbook2mdoc/docbook2mdoc.c 2014/10/12 15:08:45 1.40 @@ -1,4 +1,4 @@ -/* $Id: docbook2mdoc.c,v 1.12 2014/03/29 22:44:06 kristaps Exp $ */ +/* $Id: docbook2mdoc.c,v 1.40 2014/10/12 15:08:45 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. */ @@ -127,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 */ @@ -150,336 +88,109 @@ 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 }, { "paramdef", 0 }, { "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", 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); -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. @@ -541,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 @@ -578,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... */ @@ -590,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; @@ -613,11 +327,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; } @@ -647,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)); @@ -692,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) { @@ -733,7 +459,7 @@ pnode_free(struct pnode *pn) free(ap); } - free(pn->b); + free(pn->real); free(pn); } @@ -809,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. @@ -820,6 +566,9 @@ pnode_printmacrolinetext(struct parse *p, struct pnode { char *cp; + if (0 == p->newln && ! (MACROLINE_NOWS & fl)) + putchar(' '); + bufclear(p); bufappend_r(p, pn); @@ -867,8 +616,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 @@ -892,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 @@ -918,13 +704,48 @@ 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_printmacroline(p, pp); + pnode_printmacrolinetext(p, pp, + NODE_REFSECT1 == pn->node ? + MACROLINE_UPPER : 0); + pnode_printmclose(p, 1); pnode_unlink(pp); - } else - puts("UNKNOWN"); + } else { + puts(NODE_REFSECT1 == pn->node ? + "UNKNOWN" : "unknown"); + p->newln = 1; + } } /* @@ -942,18 +763,16 @@ pnode_printciterefentry(struct parse *p, struct pnode else if (NODE_REFENTRYTITLE == pp->node) title = pp; - fputs(".Xr ", stdout); - if (NULL != title) { pnode_printmacrolinepart(p, title); - putchar(' '); } else - fputs("unknown ", stdout); + fputs(" unknown ", stdout); - if (NULL != manvol) - pnode_printmacroline(p, manvol); - else - puts("1"); + if (NULL == manvol) { + puts(" 1"); + p->newln = 1; + } else + pnode_printmacrolinepart(p, manvol); } static void @@ -962,6 +781,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 +789,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 +811,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 +820,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 +840,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,8 +849,9 @@ pnode_printparamdef(struct parse *p, struct pnode *pn) param = pp; fputs(".Fa \"", stdout); + p->newln = 0; if (NULL != ptype) { - pnode_printmacrolinepart(p, ptype); + pnode_printmacrolinetext(p, ptype, MACROLINE_NOWS); putchar(' '); } @@ -1032,13 +859,47 @@ pnode_printparamdef(struct parse *p, struct pnode *pn) pnode_printmacrolinepart(p, param); puts("\""); + 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; + assert(p->newln); TAILQ_FOREACH(fdef, &pn->childq, child) if (NODE_FUNCDEF == fdef->node) break; @@ -1053,6 +914,7 @@ pnode_printfuncprototype(struct parse *p, struct pnode pnode_printparamdef(p, pp); puts(".Fc"); + p->newln = 1; } /* @@ -1082,13 +944,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) @@ -1096,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 @@ -1134,10 +1029,130 @@ 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) { + assert(p->newln); + fputs(".It", stdout); + p->newln = 0; + pnode_print(p, pp); + pnode_unlink(pp); + pnode_printmclose(p, 1); + return; + } + + puts(".It"); + p->newln = 1; +} + +static void +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"); + else + puts(".Bl -item"); + + 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_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. - * 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) @@ -1152,26 +1167,50 @@ 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; 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_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); + break; case (NODE_FUNCTION): pnode_printmopen(p); - fputs("Fn ", stdout); + fputs("Fn", stdout); break; case (NODE_FUNCPROTOTYPE): assert(p->newln); @@ -1180,35 +1219,88 @@ pnode_print(struct parse *p, struct pnode *pn) break; case (NODE_FUNCSYNOPSISINFO): pnode_printmopen(p); - fputs("Fd ", stdout); + fputs("Fd", stdout); break; + case (NODE_ITEMIZEDLIST): + assert(p->newln); + 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); + 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 && + NODE_LISTITEM == pn->parent->node) + break; puts(".Pp"); break; case (NODE_PARAMETER): /* 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; + case (NODE_REFENTRYINFO): + /* Suppress. */ + pnode_unlinksub(pn); + break; case (NODE_REFMETA): abort(); break; 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 +1310,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); @@ -1226,16 +1319,58 @@ 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; + case (NODE_REPLACEABLE): + 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); + 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. @@ -1243,7 +1378,18 @@ 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