=================================================================== RCS file: /cvs/docbook2mdoc/docbook2mdoc.c,v retrieving revision 1.69 retrieving revision 1.89 diff -u -p -r1.69 -r1.89 --- docbook2mdoc/docbook2mdoc.c 2019/03/24 16:45:46 1.69 +++ docbook2mdoc/docbook2mdoc.c 2019/04/03 16:52:51 1.89 @@ -1,4 +1,4 @@ -/* $Id: docbook2mdoc.c,v 1.69 2019/03/24 16:45:46 schwarze Exp $ */ +/* $Id: docbook2mdoc.c,v 1.89 2019/04/03 16:52:51 schwarze Exp $ */ /* * Copyright (c) 2014 Kristaps Dzonsons * Copyright (c) 2019 Ingo Schwarze @@ -15,706 +15,27 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -#include - #include #include -#include -#include -#include #include #include -#include -#include -#include "extern.h" +#include "node.h" +#include "macro.h" +#include "format.h" -enum linestate { - LINE_NEW = 0, - LINE_TEXT, - LINE_MACRO -}; - /* - * Global parse state. - * Keep this as simple and small as possible. + * The implementation of the mdoc(7) formatter. */ -struct parse { - XML_Parser xml; - enum nodeid node; /* current (NODE_ROOT if pre-tree) */ - const char *fname; /* filename */ - int stop; /* should we stop now? */ -#define PARSE_EQN 1 - unsigned int flags; /* document-wide flags */ - struct pnode *root; /* root of parse tree */ - struct pnode *cur; /* current node in tree */ - char *b; /* NUL-terminated buffer for pre-print */ - size_t bsz; /* current length of b */ - size_t mbsz; /* max bsz allocation */ - int level; /* header level, starting at 1 */ - enum linestate linestate; -}; -struct node { - const char *name; /* docbook element name */ - enum nodeid node; /* docbook element to generate */ -}; +static void pnode_print(struct format *, struct pnode *); -TAILQ_HEAD(pnodeq, pnode); -TAILQ_HEAD(pattrq, pattr); -struct pattr { - enum attrkey key; - enum attrval val; - char *rawval; - TAILQ_ENTRY(pattr) child; -}; - -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 */ - struct pattrq attrq; /* attributes of node */ - TAILQ_ENTRY(pnode) child; -}; - -static const char *attrkeys[ATTRKEY__MAX] = { - "choice", - "class", - "close", - "id", - "linkend", - "open", - "rep" -}; - -static const char *attrvals[ATTRVAL__MAX] = { - "monospaced", - "norepeat", - "opt", - "plain", - "repeat", - "req" -}; - -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 }, - { "email", NODE_EMAIL }, - { "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 }, - { "personname", NODE_PERSONNAME }, - { "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; - static void -pnode_print(struct parse *p, struct pnode *pn); - -/* - * Process a stream of characters. - * We store text as nodes in and of themselves. - * If a text node is already open, append to it. - * If it's not open, open one under the current context. - */ -static void -xml_char(void *arg, const XML_Char *p, int sz) +pnode_printpara(struct format *p, struct pnode *pn) { - struct parse *ps = arg; - struct pnode *dat; - int i; - - /* Stopped or no tree yet. */ - if (ps->stop || ps->node == NODE_ROOT) - return; - - assert(ps->cur != NULL); - - /* - * Are we in the midst of processing text? - * If we're not processing text right now, then create a text - * node for doing so. - * However, don't do so unless we have some non-whitespace to - * process: strip out all leading whitespace to be sure. - */ - if (ps->node != NODE_TEXT) { - for (i = 0; i < sz; i++) - if ( ! isspace((unsigned char)p[i])) - break; - if (i == sz) - return; - p += i; - sz -= i; - dat = calloc(1, sizeof(struct pnode)); - if (dat == NULL) { - perror(NULL); - exit(1); - } - - dat->node = ps->node = NODE_TEXT; - dat->parent = ps->cur; - TAILQ_INIT(&dat->childq); - TAILQ_INIT(&dat->attrq); - TAILQ_INSERT_TAIL(&ps->cur->childq, dat, child); - ps->cur = dat; - assert(ps->root != NULL); - } - - /* Append to current buffer. */ - assert(sz >= 0); - ps->cur->b = realloc(ps->cur->b, - ps->cur->bsz + (size_t)sz); - if (ps->cur->b == NULL) { - perror(NULL); - exit(1); - } - memcpy(ps->cur->b + ps->cur->bsz, p, sz); - ps->cur->bsz += (size_t)sz; - ps->cur->real = ps->cur->b; -} - -static void -pnode_trim(struct pnode *pn) -{ - assert(pn->node == NODE_TEXT); - for ( ; pn->bsz > 0; pn->bsz--) - if ( ! isspace((unsigned char)pn->b[pn->bsz - 1])) - break; -} - -/* - * Begin an element. - * First, look for the element. - * If we don't find it and we're not parsing, keep going. - * If we don't find it and we're parsing, puke and exit. - * If we find it but we're not parsing yet (i.e., it's not a refentry - * and thus out of context), keep going. - * If we find it and we're at the root and already have a tree, puke and - * exit (FIXME: I don't think this is right?). - * If we find it but we're parsing a text node, close out the text node, - * return to its parent, and keep going. - * Make sure that the element is in the right context. - * Lastly, put the node onto our parse tree and continue. - */ -static void -xml_elem_start(void *arg, const XML_Char *name, const XML_Char **atts) -{ - struct parse *ps = arg; - const struct node *node; - enum attrkey key; - enum attrval val; - struct pnode *dat; - struct pattr *pattr; - const XML_Char **att; - - /* FIXME: find a better way to ditch other namespaces. */ - if (ps->stop || strcmp(name, "xi:include") == 0) - return; - - /* Close out text node, if applicable... */ - if (ps->node == NODE_TEXT) { - pnode_trim(ps->cur); - ps->cur = ps->cur->parent; - ps->node = ps->cur->node; - } - - for (node = nodes; node->name != NULL; node++) - if (strcmp(node->name, name) == 0) - break; - - if (node->name == NULL) { - if (ps->node == NODE_ROOT) - return; - fprintf(stderr, "%s:%zu:%zu: unknown node \"%s\"\n", - ps->fname, XML_GetCurrentLineNumber(ps->xml), - XML_GetCurrentColumnNumber(ps->xml), name); - ps->stop = 1; - return; - } else if (ps->node == NODE_ROOT && ps->root != NULL) { - fprintf(stderr, "%s:%zu:%zu: multiple refentries\n", - ps->fname, XML_GetCurrentLineNumber(ps->xml), - XML_GetCurrentColumnNumber(ps->xml)); - ps->stop = 1; - return; - } - - if (node->node == NODE_INLINEEQUATION) - ps->flags |= PARSE_EQN; - - if ((dat = calloc(1, sizeof(struct pnode))) == NULL) { - perror(NULL); - exit(1); - } - - dat->node = ps->node = node->node; - dat->parent = ps->cur; - TAILQ_INIT(&dat->childq); - TAILQ_INIT(&dat->attrq); - - if (ps->cur != NULL) - TAILQ_INSERT_TAIL(&ps->cur->childq, dat, child); - - ps->cur = dat; - if (ps->root == NULL) - ps->root = dat; - - /* - * Process attributes. - */ - for (att = atts; *att != NULL; att += 2) { - for (key = 0; key < ATTRKEY__MAX; key++) - if (strcmp(*att, attrkeys[key]) == 0) - break; - if (key == ATTRKEY__MAX) { - if (warn) - fprintf(stderr, "%s:%zu:%zu: warning: " - "unknown attribute \"%s\"\n", - ps->fname, - XML_GetCurrentLineNumber(ps->xml), - XML_GetCurrentColumnNumber(ps->xml), - *att); - continue; - } - for (val = 0; val < ATTRVAL__MAX; val++) - if (strcmp(att[1], attrvals[val]) == 0) - break; - pattr = calloc(1, sizeof(struct pattr)); - pattr->key = key; - pattr->val = val; - if (val == ATTRVAL__MAX) - pattr->rawval = strdup(att[1]); - TAILQ_INSERT_TAIL(&dat->attrq, pattr, child); - } - -} - -/* - * Roll up the parse tree. - * If we're at a text node, roll that one up first. - * If we hit the root, then assign ourselves as the NODE_ROOT. - */ -static void -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 || ps->node == NODE_ROOT) - return; - else if (strcmp(name, "xi:include") == 0) - return; - - /* Close out text node, if applicable... */ - if (ps->node == NODE_TEXT) { - pnode_trim(ps->cur); - ps->cur = ps->cur->parent; - ps->node = ps->cur->node; - } - - if ((ps->cur = ps->cur->parent) == NULL) - ps->node = NODE_ROOT; - else - ps->node = ps->cur->node; -} - -/* - * Recursively free a node (NULL is ok). - */ -static void -pnode_free(struct pnode *pn) -{ struct pnode *pp; - struct pattr *ap; - if (pn == NULL) - return; - - while ((pp = TAILQ_FIRST(&pn->childq)) != NULL) { - TAILQ_REMOVE(&pn->childq, pp, child); - pnode_free(pp); - } - - while ((ap = TAILQ_FIRST(&pn->attrq)) != NULL) { - TAILQ_REMOVE(&pn->attrq, ap, child); - free(ap->rawval); - free(ap); - } - - free(pn->real); - free(pn); -} - -/* - * Unlink a node from its parent and pnode_free() it. - */ -static void -pnode_unlink(struct pnode *pn) -{ - if (pn->parent != NULL) - TAILQ_REMOVE(&pn->parent->childq, pn, child); - pnode_free(pn); -} - -/* - * Unlink all children of a node and pnode_free() them. - */ -static void -pnode_unlinksub(struct pnode *pn) -{ - - while ( ! TAILQ_EMPTY(&pn->childq)) - pnode_unlink(TAILQ_FIRST(&pn->childq)); -} - -/* - * 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 ap->val == ATTRVAL__MAX ? ap->rawval : - attrvals[ap->val]; - return defval; -} - -/* - * Reset the lookaside buffer. - */ -static void -bufclear(struct parse *p) -{ - - p->b[p->bsz = 0] = '\0'; -} - -/* - * Append NODE_TEXT contents to the current buffer, reallocating its - * size if necessary. - * The buffer is ALWAYS NUL-terminated. - */ -static void -bufappend(struct parse *p, struct pnode *pn) -{ - - assert(pn->node == NODE_TEXT); - if (p->bsz + pn->bsz + 1 > p->mbsz) { - p->mbsz = p->bsz + pn->bsz + 1; - if ((p->b = realloc(p->b, p->mbsz)) == NULL) { - perror(NULL); - exit(1); - } - } - memcpy(p->b + p->bsz, pn->b, pn->bsz); - p->bsz += pn->bsz; - p->b[p->bsz] = '\0'; -} - -/* - * Recursively append all NODE_TEXT nodes to the buffer. - * This descends into non-text nodes, but doesn't do anything beyond - * them. - * In other words, this is a recursive text grok. - */ -static void -bufappend_r(struct parse *p, struct pnode *pn) -{ - struct pnode *pp; - - if (pn->node == NODE_TEXT) - bufappend(p, pn); - TAILQ_FOREACH(pp, &pn->childq, child) - 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 (res != NULL) - break; - } - - return res; -} - -static void -macro_open(struct parse *p, const char *name) -{ - switch (p->linestate) { - case LINE_TEXT: - putchar('\n'); - /* FALLTHROUGH */ - case LINE_NEW: - putchar('.'); - p->linestate = LINE_MACRO; - break; - case LINE_MACRO: - putchar(' '); - break; - } - fputs(name, stdout); -} - -static void -macro_close(struct parse *p) -{ - assert(p->linestate == LINE_MACRO); - putchar('\n'); - p->linestate = LINE_NEW; -} - -static void -macro_line(struct parse *p, const char *name) -{ - macro_open(p, name); - macro_close(p); -} - -#define MACROLINE_UPPER 1 -#define MACROLINE_NOWS 2 -/* - * Print an argument string on a macro line, collapsing whitespace. - */ -static void -macro_addarg(struct parse *p, const char *arg, int fl) -{ - const char *cp; - int wantspace; - - assert(p->linestate == LINE_MACRO); - wantspace = !(fl & MACROLINE_NOWS); - for (cp = arg; *cp != '\0'; cp++) { - if (isspace((unsigned char)*cp)) { - wantspace = 1; - continue; - } else if (wantspace) { - putchar(' '); - wantspace = 0; - } - /* Escape us if we look like a macro. */ - if ((cp == arg || cp[-1] == ' ') && - isupper((unsigned char)cp[0]) && - islower((unsigned char)cp[1]) && - (cp[2] == '\0' || cp[2] == ' ' || - (islower((unsigned char)cp[2]) && - (cp[3] == '\0' || cp[3] == ' ')))) - fputs("\\&", stdout); - if (fl & MACROLINE_UPPER) - putchar(toupper((unsigned char)*cp)); - else - putchar(*cp); - if (*cp == '\\') - putchar('e'); - } -} - -static void -macro_argline(struct parse *p, const char *name, const char *arg) -{ - macro_open(p, name); - macro_addarg(p, arg, 0); - macro_close(p); -} - -/* - * Recurse nodes to print arguments on a macro line. - */ -static void -macro_addnode(struct parse *p, struct pnode *pn, int fl) -{ - bufclear(p); - bufappend_r(p, pn); - macro_addarg(p, p->b, fl); -} - -static void -macro_nodeline(struct parse *p, const char *name, struct pnode *pn) -{ - macro_open(p, name); - macro_addnode(p, pn, 0); - macro_close(p); -} - -/* - * If the next node is a text node starting with closing punctuation, - * emit the closing punctuation as a trailing macro argument. - */ -static void -macro_closepunct(struct parse *p, struct pnode *pn) -{ - if ((pn = TAILQ_NEXT(pn, child)) != NULL && - pn->node == NODE_TEXT && pn->bsz > 0 && - (pn->b[0] == ',' || pn->b[0] == '.') && - (pn->bsz == 1 || isspace((unsigned char)pn->b[1]))) { - putchar(' '); - putchar(pn->b[0]); - pn->b++; - pn->bsz--; - } - macro_close(p); -} - -static void -pnode_printpara(struct parse *p, struct pnode *pn) -{ - struct pnode *pp; - if ((pp = TAILQ_PREV(pn, pnodeq, child)) == NULL && (pp = pn->parent) == NULL) return; @@ -738,22 +59,22 @@ pnode_printpara(struct parse *p, struct pnode *pn) * If the SYNOPSIS macro has a superfluous title, kill it. */ static void -pnode_printrefsynopsisdiv(struct parse *p, struct pnode *pn) +pnode_printrefsynopsisdiv(struct format *p, struct pnode *pn) { - struct pnode *pp; + struct pnode *pp, *pq; - TAILQ_FOREACH(pp, &pn->childq, child) - if (pp->node == NODE_TITLE) { + TAILQ_FOREACH_SAFE(pp, &pn->childq, child, pq) + if (pp->node == NODE_TITLE) pnode_unlink(pp); - return; - } + + macro_line(p, "Sh SYNOPSIS"); } /* * Start a hopefully-named `Sh' section. */ static void -pnode_printrefsect(struct parse *p, struct pnode *pn) +pnode_printrefsect(struct format *p, struct pnode *pn) { struct pnode *pp; const char *title; @@ -763,7 +84,9 @@ pnode_printrefsect(struct parse *p, struct pnode *pn) return; level = ++p->level; - flags = level == 1 ? MACROLINE_UPPER : 0; + flags = ARG_SPACE; + if (level == 1) + flags |= ARG_UPPER; if (level < 3) { switch (pn->node) { case NODE_CAUTION: @@ -821,7 +144,7 @@ pnode_printrefsect(struct parse *p, struct pnode *pn) macro_addnode(p, pp, flags); pnode_unlink(pp); } else - macro_addarg(p, title, 0); + macro_addarg(p, title, ARG_SPACE | ARG_QUOTED); macro_close(p); } @@ -829,7 +152,7 @@ pnode_printrefsect(struct parse *p, struct pnode *pn) * Start a reference, extracting the title and volume. */ static void -pnode_printciterefentry(struct parse *p, struct pnode *pn) +pnode_printciterefentry(struct format *p, struct pnode *pn) { struct pnode *pp, *title, *manvol; @@ -842,18 +165,18 @@ pnode_printciterefentry(struct parse *p, struct pnode } macro_open(p, "Xr"); if (title == NULL) - macro_addarg(p, "unknown", 0); + macro_addarg(p, "unknown", ARG_SPACE); else - macro_addnode(p, title, 0); + macro_addnode(p, title, ARG_SPACE | ARG_SINGLE); if (manvol == NULL) - macro_addarg(p, "1", 0); + macro_addarg(p, "1", ARG_SPACE); else - macro_addnode(p, manvol, 0); - macro_close(p); + macro_addnode(p, manvol, ARG_SPACE | ARG_SINGLE); + pnode_unlinksub(pn); } static void -pnode_printrefmeta(struct parse *p, struct pnode *pn) +pnode_printrefmeta(struct format *p, struct pnode *pn) { struct pnode *pp, *title, *manvol; @@ -866,64 +189,31 @@ pnode_printrefmeta(struct parse *p, struct pnode *pn) } macro_open(p, "Dt"); if (title == NULL) - macro_addarg(p, "UNKNOWN", 0); + macro_addarg(p, "UNKNOWN", ARG_SPACE); else - macro_addnode(p, title, MACROLINE_UPPER); + macro_addnode(p, title, ARG_SPACE | ARG_SINGLE | ARG_UPPER); if (manvol == NULL) - macro_addarg(p, "1", 0); + macro_addarg(p, "1", ARG_SPACE); else - macro_addnode(p, manvol, 0); + macro_addnode(p, manvol, ARG_SPACE | ARG_SINGLE); macro_close(p); + pnode_unlink(pn); } static void -pnode_printfuncdef(struct parse *p, struct pnode *pn) +pnode_printfuncdef(struct format *f, struct pnode *n) { - struct pnode *pp, *ftype, *func; + struct pnode *nc; - ftype = func = NULL; - TAILQ_FOREACH(pp, &pn->childq, child) { - if (pp->node == NODE_TEXT) - ftype = pp; - else if (pp->node == NODE_FUNCTION) - func = pp; + nc = TAILQ_FIRST(&n->childq); + if (nc != NULL && nc->node == NODE_TEXT) { + macro_argline(f, "Ft", nc->b); + pnode_unlink(nc); } - if (ftype != NULL) - macro_nodeline(p, "Ft", ftype); - macro_open(p, "Fo"); - if (func == NULL) - macro_addarg(p, "UNKNOWN", 0); - else - macro_addnode(p, func, 0); - macro_close(p); + macro_nodeline(f, "Fo", n, ARG_SINGLE); + pnode_unlinksub(n); } -static void -pnode_printparamdef(struct parse *p, struct pnode *pn) -{ - struct pnode *pp, *ptype, *param; - int flags; - - ptype = param = NULL; - TAILQ_FOREACH(pp, &pn->childq, child) { - if (pp->node == NODE_TEXT) - ptype = pp; - else if (pp->node == NODE_PARAMETER) - param = pp; - } - macro_open(p, "Fa \""); - flags = MACROLINE_NOWS; - if (ptype != NULL) { - macro_addnode(p, ptype, flags); - flags = 0; - } - if (param != NULL) - macro_addnode(p, param, flags); - flags = MACROLINE_NOWS; - macro_addarg(p, "\"", flags); - macro_close(p); -} - /* * The node is a little peculiar. * First, it can have arbitrary open and closing tokens, which default @@ -931,7 +221,7 @@ pnode_printparamdef(struct parse *p, struct pnode *pn) * Second, >1 arguments are separated by commas. */ static void -pnode_printmathfenced(struct parse *p, struct pnode *pn) +pnode_printmathfenced(struct format *p, struct pnode *pn) { struct pnode *pp; @@ -944,8 +234,8 @@ pnode_printmathfenced(struct parse *p, struct pnode *p putchar(','); pnode_print(p, pp); } - printf("right %s ", pnode_getattr_raw(pn, ATTRKEY_CLOSE, ")")); + pnode_unlinksub(pn); } /* @@ -955,7 +245,7 @@ pnode_printmathfenced(struct parse *p, struct pnode *p * particular eqn(7) word. */ static void -pnode_printmath(struct parse *p, struct pnode *pn) +pnode_printmath(struct format *p, struct pnode *pn) { struct pnode *pp; @@ -978,10 +268,11 @@ pnode_printmath(struct parse *p, struct pnode *pn) pp = TAILQ_NEXT(pp, child); pnode_print(p, pp); + pnode_unlinksub(pn); } static void -pnode_printfuncprototype(struct parse *p, struct pnode *pn) +pnode_printfuncprototype(struct format *p, struct pnode *pn) { struct pnode *pp, *fdef; @@ -989,16 +280,17 @@ pnode_printfuncprototype(struct parse *p, struct pnode if (fdef->node == NODE_FUNCDEF) break; - if (fdef != NULL) + if (fdef != NULL) { pnode_printfuncdef(p, fdef); - else + pnode_unlink(fdef); + } else macro_line(p, "Fo UNKNOWN"); TAILQ_FOREACH(pp, &pn->childq, child) - if (pp->node == NODE_PARAMDEF) - pnode_printparamdef(p, pp); + macro_nodeline(p, "Fa", pp, ARG_SINGLE); macro_line(p, "Fc"); + pnode_unlinksub(pn); } /* @@ -1009,7 +301,7 @@ pnode_printfuncprototype(struct parse *p, struct pnode * ellipsis following an argument) and optionality. */ static void -pnode_printarg(struct parse *p, struct pnode *pn) +pnode_printarg(struct format *p, struct pnode *pn) { struct pnode *pp; struct pattr *ap; @@ -1032,12 +324,13 @@ pnode_printarg(struct parse *p, struct pnode *pn) macro_open(p, "Ar"); pnode_print(p, pp); if (isrep && pp->node == NODE_TEXT) - macro_addarg(p, "...", 0); + macro_addarg(p, "...", ARG_SPACE); } + pnode_unlinksub(pn); } static void -pnode_printgroup(struct parse *p, struct pnode *pn) +pnode_printgroup(struct format *p, struct pnode *pn) { struct pnode *pp, *np; struct pattr *ap; @@ -1076,40 +369,110 @@ pnode_printgroup(struct parse *p, struct pnode *pn) while (np != NULL) { if (pp->node != np->node) break; - macro_addarg(p, "|", 0); - macro_addnode(p, np, 0); + macro_addarg(p, "|", ARG_SPACE); + macro_addnode(p, np, ARG_SPACE); pp = np; np = TAILQ_NEXT(np, child); } } if (sv) macro_close(p); + pnode_unlinksub(pn); } static void -pnode_printprologue(struct parse *p, struct pnode *pn) +pnode_printauthor(struct format *f, struct pnode *n) { - struct pnode *pp; + struct pnode *nc, *ncn; + int have_contrib, have_name; - pp = p->root == NULL ? NULL : - pnode_findfirst(p->root, NODE_REFMETA); + /* + * Print children up front, before the .An scope, + * and figure out whether we a name of a person. + */ + have_contrib = have_name = 0; + TAILQ_FOREACH_SAFE(nc, &n->childq, child, ncn) { + switch (nc->node) { + case NODE_CONTRIB: + if (have_contrib) + print_text(f, ",", 0); + print_textnode(f, nc); + pnode_unlink(nc); + have_contrib = 1; + break; + case NODE_PERSONNAME: + have_name = 1; + break; + default: + break; + } + } + if (TAILQ_FIRST(&n->childq) == NULL) + return; + + if (have_contrib) + print_text(f, ":", 0); + + /* + * If we have a name, print it in the .An scope and leave + * all other content for child handlers, to print after the + * scope. Otherwise, print everything in the scope. + */ + + macro_open(f, "An"); + TAILQ_FOREACH_SAFE(nc, &n->childq, child, ncn) { + if (nc->node == NODE_PERSONNAME || have_name == 0) { + macro_addnode(f, nc, ARG_SPACE); + pnode_unlink(nc); + } + } + + /* + * If there is an email address, + * print it on the same macro line. + */ + + if ((nc = pnode_findfirst(n, NODE_EMAIL)) != NULL) { + pnode_print(f, nc); + pnode_unlink(nc); + } + + /* + * If there are still unprinted children, end the scope + * with a comma. Otherwise, leave the scope open in case + * a text node follows that starts with closing punctuation. + */ + + if (TAILQ_FIRST(&n->childq) != NULL) { + macro_addarg(f, ",", ARG_SPACE); + macro_close(f); + } +} + +static void +pnode_printprologue(struct format *p, struct ptree *tree) +{ + struct pnode *refmeta; + + refmeta = tree->root == NULL ? NULL : + pnode_findfirst(tree->root, NODE_REFMETA); + macro_line(p, "Dd $Mdocdate" "$"); - if (pp != NULL) { - pnode_printrefmeta(p, pp); - pnode_unlink(pp); - } else { + if (refmeta == NULL) { macro_open(p, "Dt"); macro_addarg(p, - pnode_getattr_raw(p->root, ATTRKEY_ID, "UNKNOWN"), 0); - macro_addarg(p, "1", 0); + pnode_getattr_raw(tree->root, ATTRKEY_ID, "UNKNOWN"), + ARG_SPACE | ARG_SINGLE | ARG_UPPER); + macro_addarg(p, "1", ARG_SPACE); macro_close(p); - } + } else + pnode_printrefmeta(p, refmeta); macro_line(p, "Os"); - if (p->flags & PARSE_EQN) { + if (tree->flags & TREE_EQN) { macro_line(p, "EQ"); - puts("delim $$"); + print_text(p, "delim $$", 0); macro_line(p, "EN"); } } @@ -1119,7 +482,7 @@ pnode_printprologue(struct parse *p, struct pnode *pn) * we should comma-separate as list headers. */ static void -pnode_printvarlistentry(struct parse *p, struct pnode *pn) +pnode_printvarlistentry(struct format *p, struct pnode *pn) { struct pnode *pp; int first = 1; @@ -1129,7 +492,7 @@ pnode_printvarlistentry(struct parse *p, struct pnode if (pp->node != NODE_TERM) continue; if ( ! first) - putchar(','); + macro_addarg(p, ",", 0); pnode_print(p, pp); first = 0; } @@ -1137,11 +500,26 @@ pnode_printvarlistentry(struct parse *p, struct pnode TAILQ_FOREACH(pp, &pn->childq, child) if (pp->node != NODE_TERM) pnode_print(p, pp); + pnode_unlinksub(pn); } static void -pnode_printrow(struct parse *p, struct pnode *pn) +pnode_printtitle(struct format *p, struct pnode *pn) { + struct pnode *pp, *pq; + + TAILQ_FOREACH_SAFE(pp, &pn->childq, child, pq) { + if (pp->node == NODE_TITLE) { + pnode_printpara(p, pp); + pnode_print(p, pp); + pnode_unlink(pp); + } + } +} + +static void +pnode_printrow(struct format *p, struct pnode *pn) +{ struct pnode *pp; macro_line(p, "Bl -dash -compact"); @@ -1150,41 +528,75 @@ pnode_printrow(struct parse *p, struct pnode *pn) pnode_print(p, pp); } macro_line(p, "El"); + pnode_unlink(pn); } static void -pnode_printtable(struct parse *p, struct pnode *pn) +pnode_printtgroup1(struct format *f, struct pnode *n) { - struct pnode *pp; + struct pnode *nc; - TAILQ_FOREACH(pp, &pn->childq, child) { - if (pp->node == NODE_TITLE) { - pnode_printpara(p, pp); - pnode_print(p, pp); - pnode_unlink(pp); - } + macro_line(f, "Bl -bullet -compact"); + while ((nc = pnode_findfirst(n, NODE_ENTRY)) != NULL) { + macro_line(f, "It"); + pnode_print(f, nc); + pnode_unlink(nc); } - macro_line(p, "Bl -ohang"); - while ((pp = pnode_findfirst(pn, NODE_ROW)) != NULL) { - macro_line(p, "It Table Row"); - pnode_printrow(p, pp); - pnode_unlink(pp); + macro_line(f, "El"); + pnode_unlinksub(n); +} + +static void +pnode_printtgroup2(struct format *f, struct pnode *n) +{ + struct pnode *nr, *ne; + + macro_line(f, "Bl -tag -width Ds"); + while ((nr = pnode_findfirst(n, NODE_ROW)) != NULL) { + if ((ne = pnode_findfirst(n, NODE_ENTRY)) == NULL) + break; + macro_open(f, "It"); + pnode_print(f, ne); + macro_close(f); + pnode_unlink(ne); + pnode_print(f, nr); + pnode_unlink(nr); } - macro_line(p, "El"); + macro_line(f, "El"); + pnode_unlinksub(n); } static void -pnode_printlist(struct parse *p, struct pnode *pn) +pnode_printtgroup(struct format *f, struct pnode *n) { - struct pnode *pp; + struct pnode *nc; - TAILQ_FOREACH(pp, &pn->childq, child) { - if (pp->node == NODE_TITLE) { - pnode_printpara(p, pp); - pnode_print(p, pp); - pnode_unlink(pp); - } + switch (atoi(pnode_getattr_raw(n, ATTRKEY_COLS, "0"))) { + case 1: + pnode_printtgroup1(f, n); + return; + case 2: + pnode_printtgroup2(f, n); + return; + default: + break; } + + macro_line(f, "Bl -ohang"); + while ((nc = pnode_findfirst(n, NODE_ROW)) != NULL) { + macro_line(f, "It Table Row"); + pnode_printrow(f, nc); + } + macro_line(f, "El"); + pnode_unlinksub(n); +} + +static void +pnode_printlist(struct format *p, struct pnode *pn) +{ + struct pnode *pp; + + pnode_printtitle(p, pn); macro_argline(p, "Bl", pn->node == NODE_ORDEREDLIST ? "-enum" : "-bullet"); TAILQ_FOREACH(pp, &pn->childq, child) { @@ -1192,28 +604,24 @@ pnode_printlist(struct parse *p, struct pnode *pn) pnode_print(p, pp); } macro_line(p, "El"); + pnode_unlinksub(pn); } static void -pnode_printvariablelist(struct parse *p, struct pnode *pn) +pnode_printvariablelist(struct format *p, struct pnode *pn) { struct pnode *pp; - TAILQ_FOREACH(pp, &pn->childq, child) { - if (pp->node == NODE_TITLE) { - pnode_printpara(p, pp); - pnode_print(p, pp); - pnode_unlink(pp); - } - } + pnode_printtitle(p, pn); macro_line(p, "Bl -tag -width Ds"); TAILQ_FOREACH(pp, &pn->childq, child) { if (pp->node == NODE_VARLISTENTRY) - pnode_print(p, pp); + pnode_printvarlistentry(p, pp); else - macro_nodeline(p, "It", pp); + macro_nodeline(p, "It", pp, 0); } macro_line(p, "El"); + pnode_unlinksub(pn); } /* @@ -1223,7 +631,7 @@ pnode_printvariablelist(struct parse *p, struct pnode * whatever), don't print inline macros. */ static void -pnode_print(struct parse *p, struct pnode *pn) +pnode_print(struct format *p, struct pnode *pn) { struct pnode *pp; const char *ccp; @@ -1240,15 +648,11 @@ pnode_print(struct parse *p, struct pnode *pn) case NODE_APPLICATION: macro_open(p, "Nm"); break; - case NODE_ANCHOR: - /* Don't print anything! */ - return; case NODE_ARG: pnode_printarg(p, pn); - pnode_unlinksub(pn); break; case NODE_AUTHOR: - macro_open(p, "An"); + pnode_printauthor(p, pn); break; case NODE_AUTHORGROUP: macro_line(p, "An -split"); @@ -1258,7 +662,6 @@ pnode_print(struct parse *p, struct pnode *pn) break; case NODE_CITEREFENTRY: pnode_printciterefentry(p, pn); - pnode_unlinksub(pn); break; case NODE_CITETITLE: macro_open(p, "%T"); @@ -1273,10 +676,7 @@ pnode_print(struct parse *p, struct pnode *pn) macro_open(p, "Dv"); break; case NODE_EDITOR: - if (p->linestate != LINE_NEW) - putchar('\n'); - puts("editor:"); - p->linestate = LINE_TEXT; + print_text(p, "editor:", ARG_SPACE); macro_open(p, "An"); break; case NODE_EMAIL: @@ -1289,6 +689,13 @@ pnode_print(struct parse *p, struct pnode *pn) case NODE_ENVAR: macro_open(p, "Ev"); break; + case NODE_ESCAPE: + if (p->linestate == LINE_NEW) + p->linestate = LINE_TEXT; + else + putchar(' '); + fputs(pn->b, stdout); + break; case NODE_FILENAME: macro_open(p, "Pa"); break; @@ -1297,13 +704,10 @@ pnode_print(struct parse *p, struct pnode *pn) break; case NODE_FUNCPROTOTYPE: pnode_printfuncprototype(p, pn); - pnode_unlinksub(pn); break; case NODE_FUNCSYNOPSISINFO: macro_open(p, "Fd"); break; - case NODE_INDEXTERM: - return; case NODE_INFORMALEQUATION: macro_line(p, "EQ"); break; @@ -1314,11 +718,9 @@ pnode_print(struct parse *p, struct pnode *pn) break; case NODE_ITEMIZEDLIST: pnode_printlist(p, pn); - pnode_unlinksub(pn); break; case NODE_GROUP: pnode_printgroup(p, pn); - pnode_unlinksub(pn); break; case NODE_KEYSYM: macro_open(p, "Sy"); @@ -1341,7 +743,6 @@ pnode_print(struct parse *p, struct pnode *pn) break; case NODE_MML_MFENCED: pnode_printmathfenced(p, pn); - pnode_unlinksub(pn); break; case NODE_MML_MROW: case NODE_MML_MI: @@ -1355,24 +756,19 @@ pnode_print(struct parse *p, struct pnode *pn) case NODE_MML_MSUB: case NODE_MML_MSUP: pnode_printmath(p, pn); - pnode_unlinksub(pn); break; case NODE_OPTION: macro_open(p, "Fl"); break; case NODE_ORDEREDLIST: pnode_printlist(p, pn); - pnode_unlinksub(pn); break; case NODE_PARA: pnode_printpara(p, pn); break; + case NODE_PARAMDEF: case NODE_PARAMETER: - /* Suppress non-text children... */ - macro_open(p, "Fa \""); - macro_addnode(p, pn, MACROLINE_NOWS); - macro_addarg(p, "\"", MACROLINE_NOWS); - macro_close(p); + macro_nodeline(p, "Fa", pn, ARG_SINGLE); pnode_unlinksub(pn); break; case NODE_QUOTE: @@ -1380,18 +776,17 @@ pnode_print(struct parse *p, struct pnode *pn) break; case NODE_PROGRAMLISTING: case NODE_SCREEN: + case NODE_SYNOPSIS: macro_line(p, "Bd -literal"); break; case NODE_REFENTRYINFO: /* Suppress. */ pnode_unlinksub(pn); break; - case NODE_REFMETA: - abort(); - break; case NODE_REFNAME: /* Suppress non-text children... */ - macro_nodeline(p, "Nm", pn); + macro_open(p, "Nm"); + macro_addnode(p, pn, ARG_SPACE | ARG_SINGLE); pnode_unlinksub(pn); break; case NODE_REFNAMEDIV: @@ -1402,7 +797,6 @@ pnode_print(struct parse *p, struct pnode *pn) break; case NODE_REFSYNOPSISDIV: pnode_printrefsynopsisdiv(p, pn); - macro_line(p, "Sh SYNOPSIS"); break; case NODE_PREFACE: case NODE_SECTION: @@ -1424,15 +818,8 @@ pnode_print(struct parse *p, struct pnode *pn) case NODE_STRUCTNAME: macro_open(p, "Vt"); break; - case NODE_TABLE: - case NODE_INFORMALTABLE: - pnode_printtable(p, pn); - pnode_unlinksub(pn); - break; case NODE_TEXT: - bufclear(p); - bufappend(p, pn); - if (p->bsz == 0) { + if (pn->bsz == 0) { assert(pn->real != pn->b); break; } @@ -1447,7 +834,7 @@ pnode_print(struct parse *p, struct pnode *pn) * XXX: all whitespace, including tabs (?). * Remember to escape control characters and escapes. */ - cp = p->b; + cp = pn->b; /* * There's often a superfluous "-" in its