Annotation of docbook2mdoc/docbook2mdoc.c, Revision 1.53
1.53 ! schwarze 1: /* $Id: docbook2mdoc.c,v 1.52 2019/03/22 16:21:23 schwarze Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.50 schwarze 4: * Copyright (c) 2019 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
18: #include <sys/queue.h>
19:
20: #include <assert.h>
21: #include <ctype.h>
22: #include <expat.h>
23: #include <fcntl.h>
24: #include <getopt.h>
25: #include <stdio.h>
26: #include <stdlib.h>
27: #include <string.h>
1.7 kristaps 28: #include <unistd.h>
1.1 kristaps 29:
1.13 kristaps 30: #include "extern.h"
1.12 kristaps 31:
32: /*
1.1 kristaps 33: * Global parse state.
34: * Keep this as simple and small as possible.
35: */
36: struct parse {
1.12 kristaps 37: XML_Parser xml;
1.1 kristaps 38: enum nodeid node; /* current (NODE_ROOT if pre-tree) */
1.12 kristaps 39: const char *fname; /* filename */
1.1 kristaps 40: int stop; /* should we stop now? */
1.43 kristaps 41: #define PARSE_EQN 1
42: unsigned int flags; /* document-wide flags */
1.1 kristaps 43: struct pnode *root; /* root of parse tree */
44: struct pnode *cur; /* current node in tree */
1.47 schwarze 45: char *b; /* NUL-terminated buffer for pre-print */
1.8 kristaps 46: size_t bsz; /* current length of b */
47: size_t mbsz; /* max bsz allocation */
1.52 schwarze 48: int level; /* header level, starting at 1 */
1.10 kristaps 49: int newln; /* output: are we on a fresh line */
1.1 kristaps 50: };
51:
52: struct node {
1.8 kristaps 53: const char *name; /* docbook element name */
1.1 kristaps 54: unsigned int flags;
55: #define NODE_IGNTEXT 1 /* ignore all contained text */
56: };
57:
58: TAILQ_HEAD(pnodeq, pnode);
1.12 kristaps 59: TAILQ_HEAD(pattrq, pattr);
60:
61: struct pattr {
62: enum attrkey key;
63: enum attrval val;
64: char *rawval;
65: TAILQ_ENTRY(pattr) child;
66: };
1.1 kristaps 67:
68: struct pnode {
69: enum nodeid node; /* node type */
70: char *b; /* binary data buffer */
1.37 kristaps 71: char *real; /* store for "b" */
1.1 kristaps 72: size_t bsz; /* data buffer size */
73: struct pnode *parent; /* parent (or NULL if top) */
74: struct pnodeq childq; /* queue of children */
1.12 kristaps 75: struct pattrq attrq; /* attributes of node */
1.1 kristaps 76: TAILQ_ENTRY(pnode) child;
77: };
78:
1.12 kristaps 79: static const char *attrkeys[ATTRKEY__MAX] = {
80: "choice",
1.41 kristaps 81: "close",
1.12 kristaps 82: "id",
1.41 kristaps 83: "open",
1.12 kristaps 84: "rep"
85: };
86:
87: static const char *attrvals[ATTRVAL__MAX] = {
88: "norepeat",
89: "opt",
90: "plain",
91: "repeat",
92: "req"
93: };
94:
1.1 kristaps 95: static const struct node nodes[NODE__MAX] = {
1.44 schwarze 96: { NULL, 0 },
97: { "acronym", 0 },
1.50 schwarze 98: { "affiliation", NODE_IGNTEXT },
1.44 schwarze 99: { "anchor", NODE_IGNTEXT },
100: { "application", 0 },
101: { "arg", 0 },
1.50 schwarze 102: { "author", NODE_IGNTEXT },
103: { "authorgroup", NODE_IGNTEXT },
104: { "blockquote", NODE_IGNTEXT },
105: { "book", NODE_IGNTEXT },
106: { "bookinfo", NODE_IGNTEXT },
1.44 schwarze 107: { "caution", NODE_IGNTEXT },
1.50 schwarze 108: { "chapter", NODE_IGNTEXT },
1.44 schwarze 109: { "citerefentry", NODE_IGNTEXT },
1.50 schwarze 110: { "citetitle", 0 },
1.44 schwarze 111: { "cmdsynopsis", NODE_IGNTEXT },
112: { "code", 0 },
1.39 kristaps 113: { "colspec", NODE_IGNTEXT },
1.44 schwarze 114: { "command", 0 },
115: { "constant", 0 },
116: { "copyright", NODE_IGNTEXT },
117: { "date", 0 },
1.50 schwarze 118: { "editor", NODE_IGNTEXT },
1.13 kristaps 119: { "emphasis", 0 },
1.25 kristaps 120: { "entry", 0 },
1.21 kristaps 121: { "envar", 0 },
1.39 kristaps 122: { "fieldsynopsis", NODE_IGNTEXT },
1.17 kristaps 123: { "filename", 0 },
1.50 schwarze 124: { "firstname", 0 },
125: { "firstterm", 0 },
126: { "footnote", 0 },
1.3 kristaps 127: { "funcdef", 0 },
1.44 schwarze 128: { "funcprototype", NODE_IGNTEXT },
129: { "funcsynopsis", NODE_IGNTEXT },
130: { "funcsynopsisinfo", 0 },
131: { "function", 0 },
1.50 schwarze 132: { "glossterm", 0 },
1.44 schwarze 133: { "group", NODE_IGNTEXT },
1.32 kristaps 134: { "holder", NODE_IGNTEXT },
1.50 schwarze 135: { "index", NODE_IGNTEXT },
136: { "indexterm", NODE_IGNTEXT },
1.32 kristaps 137: { "info", NODE_IGNTEXT },
1.44 schwarze 138: { "informalequation", NODE_IGNTEXT },
139: { "informaltable", NODE_IGNTEXT },
140: { "inlineequation", NODE_IGNTEXT },
141: { "itemizedlist", NODE_IGNTEXT },
1.50 schwarze 142: { "keysym", 0 },
143: { "legalnotice", NODE_IGNTEXT },
1.44 schwarze 144: { "link", 0 },
145: { "listitem", NODE_IGNTEXT },
146: { "literal", 0 },
1.50 schwarze 147: { "literallayout", 0 },
1.44 schwarze 148: { "manvolnum", 0 },
1.50 schwarze 149: { "member", 0 },
1.44 schwarze 150: { "mml:math", NODE_IGNTEXT },
151: { "mml:mfenced", 0 },
152: { "mml:mfrac", 0 },
153: { "mml:mi", 0 },
154: { "mml:mn", 0 },
155: { "mml:mo", 0 },
156: { "mml:mrow", 0 },
157: { "mml:msub", 0 },
158: { "mml:msup", 0 },
159: { "modifier", 0 },
160: { "note", NODE_IGNTEXT },
161: { "option", 0 },
162: { "orderedlist", NODE_IGNTEXT },
1.50 schwarze 163: { "orgname", 0 },
164: { "othername", 0 },
1.44 schwarze 165: { "para", 0 },
1.3 kristaps 166: { "paramdef", 0 },
1.44 schwarze 167: { "parameter", 0 },
1.50 schwarze 168: { "part", NODE_IGNTEXT },
169: { "phrase", 0 },
170: { "preface", NODE_IGNTEXT },
171: { "primary", 0 },
1.44 schwarze 172: { "programlisting", 0 },
173: { "prompt", 0 },
174: { "quote", 0 },
175: { "refclass", NODE_IGNTEXT },
176: { "refdescriptor", NODE_IGNTEXT },
177: { "refentry", NODE_IGNTEXT },
178: { "refentryinfo", NODE_IGNTEXT },
179: { "refentrytitle", 0 },
180: { "refmeta", NODE_IGNTEXT },
181: { "refmetainfo", NODE_IGNTEXT },
182: { "refmiscinfo", NODE_IGNTEXT },
183: { "refname", 0 },
184: { "refnamediv", NODE_IGNTEXT },
185: { "refpurpose", 0 },
186: { "refsect1", NODE_IGNTEXT },
187: { "refsect2", NODE_IGNTEXT },
188: { "refsect3", NODE_IGNTEXT },
189: { "refsection", NODE_IGNTEXT },
190: { "refsynopsisdiv", NODE_IGNTEXT },
1.50 schwarze 191: { "releaseinfo", 0 },
1.44 schwarze 192: { "replaceable", 0 },
193: { "row", NODE_IGNTEXT },
194: { "sbr", NODE_IGNTEXT },
195: { "screen", NODE_IGNTEXT },
1.50 schwarze 196: { "secondary", 0 },
197: { "sect1", NODE_IGNTEXT },
198: { "sect2", NODE_IGNTEXT },
199: { "section", NODE_IGNTEXT },
1.44 schwarze 200: { "sgmltag", 0 },
1.50 schwarze 201: { "simplelist", NODE_IGNTEXT },
202: { "spanspec", NODE_IGNTEXT },
1.44 schwarze 203: { "structname", 0 },
1.50 schwarze 204: { "subtitle", 0 },
205: { "surname", 0 },
1.44 schwarze 206: { "synopsis", 0 },
207: { "table", NODE_IGNTEXT },
208: { "tbody", NODE_IGNTEXT },
209: { "term", 0 },
210: { NULL, 0 },
211: { "tfoot", NODE_IGNTEXT },
212: { "tgroup", NODE_IGNTEXT },
213: { "thead", NODE_IGNTEXT },
214: { "tip", NODE_IGNTEXT },
215: { "title", 0 },
216: { "trademark", 0 },
217: { "type", 0 },
218: { "ulink", 0 },
219: { "userinput", 0 },
220: { "variablelist", NODE_IGNTEXT },
221: { "varlistentry", NODE_IGNTEXT },
222: { "varname", 0 },
223: { "warning", NODE_IGNTEXT },
224: { "wordasword", 0 },
225: { "year", NODE_IGNTEXT },
1.1 kristaps 226: };
227:
1.38 kristaps 228: static int warn = 0;
229:
1.10 kristaps 230: static void
231: pnode_print(struct parse *p, struct pnode *pn);
232:
1.8 kristaps 233: /*
234: * Process a stream of characters.
235: * We store text as nodes in and of themselves.
236: * If a text node is already open, append to it.
237: * If it's not open, open one under the current context.
238: */
1.1 kristaps 239: static void
240: xml_char(void *arg, const XML_Char *p, int sz)
241: {
242: struct parse *ps = arg;
243: struct pnode *dat;
1.4 kristaps 244: int i;
1.1 kristaps 245:
246: /* Stopped or no tree yet. */
247: if (ps->stop || NODE_ROOT == ps->node)
248: return;
249:
250: /* Not supposed to be collecting text. */
251: assert(NULL != ps->cur);
252: if (NODE_IGNTEXT & nodes[ps->node].flags)
253: return;
254:
255: /*
256: * Are we in the midst of processing text?
257: * If we're not processing text right now, then create a text
258: * node for doing so.
1.4 kristaps 259: * However, don't do so unless we have some non-whitespace to
1.10 kristaps 260: * process: strip out all leading whitespace to be sure.
1.1 kristaps 261: */
262: if (NODE_TEXT != ps->node) {
1.4 kristaps 263: for (i = 0; i < sz; i++)
1.46 schwarze 264: if ( ! isspace((unsigned char)p[i]))
1.4 kristaps 265: break;
266: if (i == sz)
267: return;
1.10 kristaps 268: p += i;
269: sz -= i;
1.1 kristaps 270: dat = calloc(1, sizeof(struct pnode));
271: if (NULL == dat) {
272: perror(NULL);
273: exit(EXIT_FAILURE);
274: }
275:
276: dat->node = ps->node = NODE_TEXT;
277: dat->parent = ps->cur;
278: TAILQ_INIT(&dat->childq);
1.12 kristaps 279: TAILQ_INIT(&dat->attrq);
1.1 kristaps 280: TAILQ_INSERT_TAIL(&ps->cur->childq, dat, child);
281: ps->cur = dat;
282: assert(NULL != ps->root);
283: }
284:
285: /* Append to current buffer. */
286: assert(sz >= 0);
1.44 schwarze 287: ps->cur->b = realloc(ps->cur->b,
1.1 kristaps 288: ps->cur->bsz + (size_t)sz);
289: if (NULL == ps->cur->b) {
290: perror(NULL);
291: exit(EXIT_FAILURE);
292: }
293: memcpy(ps->cur->b + ps->cur->bsz, p, sz);
294: ps->cur->bsz += (size_t)sz;
1.37 kristaps 295: ps->cur->real = ps->cur->b;
1.1 kristaps 296: }
297:
1.10 kristaps 298: static void
299: pnode_trim(struct pnode *pn)
300: {
301:
302: assert(NODE_TEXT == pn->node);
303: for ( ; pn->bsz > 0; pn->bsz--)
1.46 schwarze 304: if ( ! isspace((unsigned char)pn->b[pn->bsz - 1]))
1.10 kristaps 305: break;
306: }
307:
1.1 kristaps 308: /*
309: * Begin an element.
310: * First, look for the element.
311: * If we don't find it and we're not parsing, keep going.
1.8 kristaps 312: * If we don't find it and we're parsing, puke and exit.
1.1 kristaps 313: * If we find it but we're not parsing yet (i.e., it's not a refentry
314: * and thus out of context), keep going.
1.8 kristaps 315: * If we find it and we're at the root and already have a tree, puke and
316: * exit (FIXME: I don't think this is right?).
317: * If we find it but we're parsing a text node, close out the text node,
318: * return to its parent, and keep going.
1.1 kristaps 319: * Make sure that the element is in the right context.
320: * Lastly, put the node onto our parse tree and continue.
321: */
322: static void
323: xml_elem_start(void *arg, const XML_Char *name, const XML_Char **atts)
324: {
1.12 kristaps 325: struct parse *ps = arg;
326: enum nodeid node;
327: enum attrkey key;
328: enum attrval val;
329: struct pnode *dat;
330: struct pattr *pattr;
331: const XML_Char **att;
1.1 kristaps 332:
1.36 kristaps 333: /* FIXME: find a better way to ditch other namespaces. */
334: if (ps->stop || 0 == strcmp(name, "xi:include"))
1.1 kristaps 335: return;
336:
337: /* Close out text node, if applicable... */
338: if (NODE_TEXT == ps->node) {
339: assert(NULL != ps->cur);
1.10 kristaps 340: pnode_trim(ps->cur);
1.1 kristaps 341: ps->cur = ps->cur->parent;
342: assert(NULL != ps->cur);
343: ps->node = ps->cur->node;
344: }
345:
346: for (node = 0; node < NODE__MAX; node++)
347: if (NULL == nodes[node].name)
348: continue;
349: else if (0 == strcmp(nodes[node].name, name))
350: break;
351:
352: if (NODE__MAX == node && NODE_ROOT == ps->node) {
353: return;
354: } else if (NODE__MAX == node) {
1.44 schwarze 355: fprintf(stderr, "%s:%zu:%zu: unknown node \"%s\"\n",
1.12 kristaps 356: ps->fname, XML_GetCurrentLineNumber(ps->xml),
357: XML_GetCurrentColumnNumber(ps->xml), name);
1.1 kristaps 358: ps->stop = 1;
359: return;
360: } else if (NODE_ROOT == ps->node && NULL != ps->root) {
1.12 kristaps 361: fprintf(stderr, "%s:%zu:%zu: multiple refentries\n",
362: ps->fname, XML_GetCurrentLineNumber(ps->xml),
363: XML_GetCurrentColumnNumber(ps->xml));
1.1 kristaps 364: ps->stop = 1;
365: return;
1.50 schwarze 366: } else if (NODE_ROOT == ps->node && NODE_REFENTRY != node &&
367: NODE_PART != node && NODE_BOOK != node) {
1.1 kristaps 368: return;
1.50 schwarze 369: }
1.1 kristaps 370:
1.43 kristaps 371: if (NODE_INLINEEQUATION == node)
372: ps->flags |= PARSE_EQN;
373:
1.1 kristaps 374: if (NULL == (dat = calloc(1, sizeof(struct pnode)))) {
375: perror(NULL);
376: exit(EXIT_FAILURE);
377: }
378:
379: dat->node = ps->node = node;
380: dat->parent = ps->cur;
381: TAILQ_INIT(&dat->childq);
1.12 kristaps 382: TAILQ_INIT(&dat->attrq);
1.1 kristaps 383:
384: if (NULL != ps->cur)
385: TAILQ_INSERT_TAIL(&ps->cur->childq, dat, child);
386:
387: ps->cur = dat;
388: if (NULL == ps->root)
389: ps->root = dat;
1.12 kristaps 390:
391: /*
392: * Process attributes.
393: */
394: for (att = atts; NULL != *att; att += 2) {
395: for (key = 0; key < ATTRKEY__MAX; key++)
396: if (0 == strcmp(*att, attrkeys[key]))
397: break;
398: if (ATTRKEY__MAX == key) {
1.44 schwarze 399: if (warn)
1.38 kristaps 400: fprintf(stderr, "%s:%zu:%zu: warning: "
1.44 schwarze 401: "unknown attribute \"%s\"\n",
402: ps->fname,
1.38 kristaps 403: XML_GetCurrentLineNumber(ps->xml),
1.44 schwarze 404: XML_GetCurrentColumnNumber(ps->xml),
1.38 kristaps 405: *att);
1.12 kristaps 406: continue;
407: }
408: for (val = 0; val < ATTRVAL__MAX; val++)
409: if (0 == strcmp(*(att + 1), attrvals[val]))
410: break;
411: pattr = calloc(1, sizeof(struct pattr));
412: pattr->key = key;
413: pattr->val = val;
414: if (ATTRVAL__MAX == val)
415: pattr->rawval = strdup(*(att + 1));
416: TAILQ_INSERT_TAIL(&dat->attrq, pattr, child);
417: }
418:
1.1 kristaps 419: }
420:
421: /*
422: * Roll up the parse tree.
1.8 kristaps 423: * If we're at a text node, roll that one up first.
1.1 kristaps 424: * If we hit the root, then assign ourselves as the NODE_ROOT.
425: */
426: static void
427: xml_elem_end(void *arg, const XML_Char *name)
428: {
429: struct parse *ps = arg;
430:
1.36 kristaps 431: /* FIXME: find a better way to ditch other namespaces. */
1.1 kristaps 432: if (ps->stop || NODE_ROOT == ps->node)
1.36 kristaps 433: return;
434: else if (0 == strcmp(name, "xi:include"))
1.1 kristaps 435: return;
436:
437: /* Close out text node, if applicable... */
438: if (NODE_TEXT == ps->node) {
439: assert(NULL != ps->cur);
1.10 kristaps 440: pnode_trim(ps->cur);
1.1 kristaps 441: ps->cur = ps->cur->parent;
442: assert(NULL != ps->cur);
443: ps->node = ps->cur->node;
444: }
445:
446: if (NULL == (ps->cur = ps->cur->parent))
447: ps->node = NODE_ROOT;
448: else
449: ps->node = ps->cur->node;
450: }
451:
1.8 kristaps 452: /*
453: * Recursively free a node (NULL is ok).
454: */
1.1 kristaps 455: static void
456: pnode_free(struct pnode *pn)
457: {
458: struct pnode *pp;
1.12 kristaps 459: struct pattr *ap;
1.1 kristaps 460:
461: if (NULL == pn)
462: return;
463:
464: while (NULL != (pp = TAILQ_FIRST(&pn->childq))) {
465: TAILQ_REMOVE(&pn->childq, pp, child);
466: pnode_free(pp);
467: }
468:
1.12 kristaps 469: while (NULL != (ap = TAILQ_FIRST(&pn->attrq))) {
470: TAILQ_REMOVE(&pn->attrq, ap, child);
471: free(ap->rawval);
472: free(ap);
473: }
474:
1.37 kristaps 475: free(pn->real);
1.1 kristaps 476: free(pn);
477: }
478:
1.8 kristaps 479: /*
480: * Unlink a node from its parent and pnode_free() it.
481: */
1.1 kristaps 482: static void
483: pnode_unlink(struct pnode *pn)
484: {
485:
486: if (NULL != pn->parent)
487: TAILQ_REMOVE(&pn->parent->childq, pn, child);
488: pnode_free(pn);
489: }
490:
1.8 kristaps 491: /*
492: * Unlink all children of a node and pnode_free() them.
493: */
1.1 kristaps 494: static void
1.4 kristaps 495: pnode_unlinksub(struct pnode *pn)
496: {
497:
498: while ( ! TAILQ_EMPTY(&pn->childq))
499: pnode_unlink(TAILQ_FIRST(&pn->childq));
500: }
501:
1.8 kristaps 502: /*
503: * Reset the lookaside buffer.
504: */
1.4 kristaps 505: static void
1.1 kristaps 506: bufclear(struct parse *p)
507: {
508:
509: p->b[p->bsz = 0] = '\0';
510: }
511:
1.8 kristaps 512: /*
513: * Append NODE_TEXT contents to the current buffer, reallocating its
514: * size if necessary.
1.47 schwarze 515: * The buffer is ALWAYS NUL-terminated.
1.8 kristaps 516: */
1.1 kristaps 517: static void
518: bufappend(struct parse *p, struct pnode *pn)
519: {
520:
521: assert(NODE_TEXT == pn->node);
522: if (p->bsz + pn->bsz + 1 > p->mbsz) {
523: p->mbsz = p->bsz + pn->bsz + 1;
524: if (NULL == (p->b = realloc(p->b, p->mbsz))) {
525: perror(NULL);
526: exit(EXIT_FAILURE);
527: }
528: }
529: memcpy(p->b + p->bsz, pn->b, pn->bsz);
530: p->bsz += pn->bsz;
531: p->b[p->bsz] = '\0';
532: }
533:
1.8 kristaps 534: /*
535: * Recursively append all NODE_TEXT nodes to the buffer.
536: * This descends into non-text nodes, but doesn't do anything beyond
537: * them.
538: * In other words, this is a recursive text grok.
539: */
1.3 kristaps 540: static void
541: bufappend_r(struct parse *p, struct pnode *pn)
542: {
543: struct pnode *pp;
544:
545: if (NODE_TEXT == pn->node)
546: bufappend(p, pn);
547: TAILQ_FOREACH(pp, &pn->childq, child)
548: bufappend_r(p, pp);
549: }
550:
1.44 schwarze 551: /*
1.25 kristaps 552: * Recursively search and return the first instance of "node".
553: */
554: static struct pnode *
555: pnode_findfirst(struct pnode *pn, enum nodeid node)
556: {
557: struct pnode *pp, *res;
558:
559: res = NULL;
560: TAILQ_FOREACH(pp, &pn->childq, child) {
561: res = pp->node == node ? pp :
562: pnode_findfirst(pp, node);
563: if (NULL != res)
564: break;
565: }
566:
567: return(res);
568: }
569:
1.12 kristaps 570: #define MACROLINE_NORM 0
571: #define MACROLINE_UPPER 1
1.32 kristaps 572: #define MACROLINE_NOWS 2
1.1 kristaps 573: /*
1.8 kristaps 574: * Recursively print text presumably on a macro line.
1.1 kristaps 575: * Convert all whitespace to regular spaces.
576: */
577: static void
1.12 kristaps 578: pnode_printmacrolinetext(struct parse *p, struct pnode *pn, int fl)
1.1 kristaps 579: {
580: char *cp;
581:
1.32 kristaps 582: if (0 == p->newln && ! (MACROLINE_NOWS & fl))
1.13 kristaps 583: putchar(' ');
584:
1.1 kristaps 585: bufclear(p);
1.3 kristaps 586: bufappend_r(p, pn);
1.1 kristaps 587:
588: /* Convert all space to spaces. */
589: for (cp = p->b; '\0' != *cp; cp++)
1.46 schwarze 590: if (isspace((unsigned char)*cp))
1.1 kristaps 591: *cp = ' ';
592:
1.46 schwarze 593: for (cp = p->b; isspace((unsigned char)*cp); cp++)
1.4 kristaps 594: /* Spin past whitespace (XXX: necessary?) */ ;
1.1 kristaps 595: for ( ; '\0' != *cp; cp++) {
596: /* Escape us if we look like a macro. */
597: if ((cp == p->b || ' ' == *(cp - 1)) &&
1.46 schwarze 598: isupper((unsigned char)*cp) &&
1.44 schwarze 599: '\0' != *(cp + 1) &&
1.46 schwarze 600: islower((unsigned char)*(cp + 1)) &&
1.44 schwarze 601: ('\0' == *(cp + 2) ||
1.1 kristaps 602: ' ' == *(cp + 2) ||
1.46 schwarze 603: (islower((unsigned char)*(cp + 2)) &&
1.44 schwarze 604: ('\0' == *(cp + 3) ||
1.1 kristaps 605: ' ' == *(cp + 3)))))
606: fputs("\\&", stdout);
1.12 kristaps 607: if (MACROLINE_UPPER & fl)
1.46 schwarze 608: putchar(toupper((unsigned char)*cp));
1.12 kristaps 609: else
1.46 schwarze 610: putchar(*cp);
1.1 kristaps 611: /* If we're a character escape, escape us. */
612: if ('\\' == *cp)
613: putchar('e');
614: }
615: }
616:
1.12 kristaps 617: static void
618: pnode_printmacrolinepart(struct parse *p, struct pnode *pn)
619: {
620:
621: pnode_printmacrolinetext(p, pn, 0);
622: }
623:
1.1 kristaps 624: /*
625: * Just pnode_printmacrolinepart() but with a newline.
626: * If no text, just the newline.
627: */
628: static void
629: pnode_printmacroline(struct parse *p, struct pnode *pn)
630: {
631:
1.13 kristaps 632: assert(0 == p->newln);
1.12 kristaps 633: pnode_printmacrolinetext(p, pn, 0);
1.1 kristaps 634: putchar('\n');
1.13 kristaps 635: p->newln = 1;
1.1 kristaps 636: }
637:
1.10 kristaps 638: static void
639: pnode_printmopen(struct parse *p)
640: {
641: if (p->newln) {
642: putchar('.');
643: p->newln = 0;
644: } else
645: putchar(' ');
646: }
647:
648: static void
649: pnode_printmclose(struct parse *p, int sv)
650: {
651:
652: if (sv && ! p->newln) {
653: putchar('\n');
654: p->newln = 1;
655: }
656: }
657:
1.8 kristaps 658: /*
1.37 kristaps 659: * Like pnode_printmclose() except we look to the next node, and, if
660: * found, see if it starts with punctuation.
661: * If it does, then we print that punctuation before the newline.
662: */
663: static void
664: pnode_printmclosepunct(struct parse *p, struct pnode *pn, int sv)
665: {
666: /* We wouldn't have done anything anyway. */
1.44 schwarze 667: if ( ! (sv && ! p->newln))
1.37 kristaps 668: return;
669:
670: /* No next node or it's not text. */
671: if (NULL == (pn = TAILQ_NEXT(pn, child))) {
672: pnode_printmclose(p, sv);
673: return;
674: } else if (NODE_TEXT != pn->node) {
675: pnode_printmclose(p, sv);
676: return;
1.44 schwarze 677: }
1.37 kristaps 678:
679: /* Only do this for the comma/period. */
680: if (pn->bsz > 0 &&
681: (',' == pn->b[0] || '.' == pn->b[0]) &&
1.46 schwarze 682: (1 == pn->bsz || isspace((unsigned char)pn->b[1]))) {
1.37 kristaps 683: putchar(' ');
684: putchar(pn->b[0]);
685: pn->b++;
686: pn->bsz--;
1.44 schwarze 687: }
1.37 kristaps 688:
689: putchar('\n');
690: p->newln = 1;
691: }
692:
693: /*
1.10 kristaps 694: * If the SYNOPSIS macro has a superfluous title, kill it.
1.8 kristaps 695: */
1.1 kristaps 696: static void
1.6 kristaps 697: pnode_printrefsynopsisdiv(struct parse *p, struct pnode *pn)
698: {
699: struct pnode *pp;
700:
1.44 schwarze 701: TAILQ_FOREACH(pp, &pn->childq, child)
1.6 kristaps 702: if (NODE_TITLE == pp->node) {
703: pnode_unlink(pp);
1.10 kristaps 704: return;
1.6 kristaps 705: }
706: }
707:
1.8 kristaps 708: /*
709: * Start a hopefully-named `Sh' section.
710: */
1.6 kristaps 711: static void
1.1 kristaps 712: pnode_printrefsect(struct parse *p, struct pnode *pn)
713: {
714: struct pnode *pp;
1.52 schwarze 715: const char *title;
716: int flags, level;
717:
718: level = ++p->level;
719: flags = 1 == level ? MACROLINE_UPPER : 0;
720: if (3 > level) {
721: switch (pn->node) {
722: case (NODE_CAUTION):
723: case (NODE_NOTE):
724: case (NODE_TIP):
725: case (NODE_WARNING):
726: level = 3;
727: break;
728: default:
729: break;
730: }
731: }
1.1 kristaps 732:
733: TAILQ_FOREACH(pp, &pn->childq, child)
734: if (NODE_TITLE == pp->node)
735: break;
736:
1.52 schwarze 737: if (NULL == pp) {
738: switch (pn->node) {
739: case (NODE_PREFACE):
740: title = "Preface";
741: break;
742: case (NODE_CAUTION):
743: title = "Caution";
744: break;
745: case (NODE_NOTE):
746: title = "Note";
747: break;
748: case (NODE_TIP):
749: title = "Tip";
750: break;
751: case (NODE_WARNING):
752: title = "Warning";
753: break;
754: default:
755: title = "Unknown";
756: break;
757: }
758: }
759:
760: switch (level) {
761: case (1):
1.20 kristaps 762: fputs(".Sh", stdout);
1.29 kristaps 763: break;
1.52 schwarze 764: case (2):
1.20 kristaps 765: fputs(".Ss", stdout);
1.29 kristaps 766: break;
1.52 schwarze 767: default:
1.29 kristaps 768: puts(".Pp");
769: fputs(".Sy", stdout);
770: break;
771: }
1.20 kristaps 772:
1.5 kristaps 773: if (NULL != pp) {
1.52 schwarze 774: p->newln = 0;
775: pnode_printmacrolinetext(p, pp, flags);
1.18 kristaps 776: pnode_printmclose(p, 1);
1.5 kristaps 777: pnode_unlink(pp);
1.52 schwarze 778: } else
779: printf(" %s\n", title);
1.1 kristaps 780: }
781:
1.8 kristaps 782: /*
783: * Start a reference, extracting the title and volume.
784: */
1.1 kristaps 785: static void
786: pnode_printciterefentry(struct parse *p, struct pnode *pn)
787: {
788: struct pnode *pp, *title, *manvol;
789:
790: title = manvol = NULL;
791: TAILQ_FOREACH(pp, &pn->childq, child)
792: if (NODE_MANVOLNUM == pp->node)
793: manvol = pp;
794: else if (NODE_REFENTRYTITLE == pp->node)
795: title = pp;
796:
797: if (NULL != title) {
798: pnode_printmacrolinepart(p, title);
799: } else
1.13 kristaps 800: fputs(" unknown ", stdout);
1.4 kristaps 801:
1.13 kristaps 802: if (NULL == manvol) {
803: puts(" 1");
804: p->newln = 1;
805: } else
1.34 kristaps 806: pnode_printmacrolinepart(p, manvol);
1.1 kristaps 807: }
808:
809: static void
810: pnode_printrefmeta(struct parse *p, struct pnode *pn)
811: {
812: struct pnode *pp, *title, *manvol;
813:
814: title = manvol = NULL;
1.13 kristaps 815: assert(p->newln);
1.1 kristaps 816: TAILQ_FOREACH(pp, &pn->childq, child)
817: if (NODE_MANVOLNUM == pp->node)
818: manvol = pp;
819: else if (NODE_REFENTRYTITLE == pp->node)
820: title = pp;
821:
1.13 kristaps 822: fputs(".Dt", stdout);
823: p->newln = 0;
1.1 kristaps 824:
1.13 kristaps 825: if (NULL != title)
1.12 kristaps 826: pnode_printmacrolinetext(p, title, MACROLINE_UPPER);
1.13 kristaps 827: else
828: fputs(" UNKNOWN ", stdout);
829:
830: if (NULL == manvol) {
831: puts(" 1");
832: p->newln = 1;
1.1 kristaps 833: } else
834: pnode_printmacroline(p, manvol);
835: }
836:
1.3 kristaps 837: static void
838: pnode_printfuncdef(struct parse *p, struct pnode *pn)
839: {
840: struct pnode *pp, *ftype, *func;
841:
1.13 kristaps 842: assert(p->newln);
1.3 kristaps 843: ftype = func = NULL;
844: TAILQ_FOREACH(pp, &pn->childq, child)
845: if (NODE_TEXT == pp->node)
846: ftype = pp;
847: else if (NODE_FUNCTION == pp->node)
848: func = pp;
849:
850: if (NULL != ftype) {
1.13 kristaps 851: fputs(".Ft", stdout);
852: p->newln = 0;
1.3 kristaps 853: pnode_printmacroline(p, ftype);
854: }
855:
856: if (NULL != func) {
1.13 kristaps 857: fputs(".Fo", stdout);
858: p->newln = 0;
1.3 kristaps 859: pnode_printmacroline(p, func);
1.13 kristaps 860: } else {
1.3 kristaps 861: puts(".Fo UNKNOWN");
1.13 kristaps 862: p->newln = 1;
863: }
1.3 kristaps 864: }
865:
866: static void
867: pnode_printparamdef(struct parse *p, struct pnode *pn)
868: {
869: struct pnode *pp, *ptype, *param;
870:
1.13 kristaps 871: assert(p->newln);
1.3 kristaps 872: ptype = param = NULL;
873: TAILQ_FOREACH(pp, &pn->childq, child)
874: if (NODE_TEXT == pp->node)
875: ptype = pp;
876: else if (NODE_PARAMETER == pp->node)
877: param = pp;
878:
879: fputs(".Fa \"", stdout);
1.13 kristaps 880: p->newln = 0;
1.3 kristaps 881: if (NULL != ptype) {
1.32 kristaps 882: pnode_printmacrolinetext(p, ptype, MACROLINE_NOWS);
1.3 kristaps 883: putchar(' ');
884: }
885:
886: if (NULL != param)
887: pnode_printmacrolinepart(p, param);
888:
889: puts("\"");
1.13 kristaps 890: p->newln = 1;
1.3 kristaps 891: }
892:
1.40 kristaps 893: /*
1.41 kristaps 894: * The <mml:mfenced> node is a little peculiar.
895: * First, it can have arbitrary open and closing tokens, which default
896: * to parentheses.
897: * Second, >1 arguments are separated by commas.
898: */
899: static void
900: pnode_printmathfenced(struct parse *p, struct pnode *pn)
901: {
902: struct pnode *pp;
903: struct pattr *ap;
904:
905: TAILQ_FOREACH(ap, &pn->attrq, child)
906: if (ATTRKEY_OPEN == ap->key) {
907: printf("left %s ", ap->rawval);
908: break;
909: }
910: if (NULL == ap)
911: printf("left ( ");
912:
913: pp = TAILQ_FIRST(&pn->childq);
914: pnode_print(p, pp);
915:
916: while (NULL != (pp = TAILQ_NEXT(pp, child))) {
917: putchar(',');
918: pnode_print(p, pp);
919: }
920:
921: TAILQ_FOREACH(ap, &pn->attrq, child)
922: if (ATTRKEY_CLOSE == ap->key) {
923: printf("right %s ", ap->rawval);
924: break;
925: }
926: if (NULL == ap)
927: printf("right ) ");
928: }
929:
930: /*
1.40 kristaps 931: * These math nodes require special handling because they have infix
932: * syntax, instead of the usual prefix or prefix.
933: * So we need to break up the first and second child node with a
934: * particular eqn(7) word.
935: */
936: static void
937: pnode_printmath(struct parse *p, struct pnode *pn)
938: {
939: struct pnode *pp;
940:
941: pp = TAILQ_FIRST(&pn->childq);
942: pnode_print(p, pp);
943:
944: switch (pn->node) {
945: case (NODE_MML_MSUP):
1.42 kristaps 946: fputs(" sup ", stdout);
1.40 kristaps 947: break;
948: case (NODE_MML_MFRAC):
1.42 kristaps 949: fputs(" over ", stdout);
1.40 kristaps 950: break;
951: case (NODE_MML_MSUB):
1.42 kristaps 952: fputs(" sub ", stdout);
1.40 kristaps 953: break;
954: default:
955: break;
956: }
957:
958: pp = TAILQ_NEXT(pp, child);
959: pnode_print(p, pp);
960: }
961:
1.3 kristaps 962: static void
963: pnode_printfuncprototype(struct parse *p, struct pnode *pn)
964: {
965: struct pnode *pp, *fdef;
966:
1.13 kristaps 967: assert(p->newln);
1.3 kristaps 968: TAILQ_FOREACH(fdef, &pn->childq, child)
1.44 schwarze 969: if (NODE_FUNCDEF == fdef->node)
1.3 kristaps 970: break;
971:
1.4 kristaps 972: if (NULL != fdef)
1.3 kristaps 973: pnode_printfuncdef(p, fdef);
1.4 kristaps 974: else
1.3 kristaps 975: puts(".Fo UNKNOWN");
976:
1.44 schwarze 977: TAILQ_FOREACH(pp, &pn->childq, child)
1.3 kristaps 978: if (NODE_PARAMDEF == pp->node)
979: pnode_printparamdef(p, pp);
980:
981: puts(".Fc");
1.13 kristaps 982: p->newln = 1;
1.3 kristaps 983: }
984:
1.44 schwarze 985: /*
1.10 kristaps 986: * The <arg> element is more complicated than it should be because text
987: * nodes are treated like ".Ar foo", but non-text nodes need to be
988: * re-sent into the printer (i.e., without the preceding ".Ar").
1.12 kristaps 989: * This also handles the case of "repetition" (or in other words, the
990: * ellipsis following an argument) and optionality.
1.10 kristaps 991: */
1.4 kristaps 992: static void
1.10 kristaps 993: pnode_printarg(struct parse *p, struct pnode *pn)
1.4 kristaps 994: {
995: struct pnode *pp;
1.12 kristaps 996: struct pattr *ap;
997: int isop, isrep;
998:
999: isop = 1;
1000: isrep = 0;
1.44 schwarze 1001: TAILQ_FOREACH(ap, &pn->attrq, child)
1.12 kristaps 1002: if (ATTRKEY_CHOICE == ap->key &&
1003: (ATTRVAL_PLAIN == ap->val ||
1.44 schwarze 1004: ATTRVAL_REQ == ap->val))
1.12 kristaps 1005: isop = 0;
1006: else if (ATTRKEY_REP == ap->key &&
1007: (ATTRVAL_REPEAT == ap->val))
1008: isrep = 1;
1009:
1010: if (isop) {
1011: pnode_printmopen(p);
1.13 kristaps 1012: fputs("Op", stdout);
1.12 kristaps 1013: }
1.4 kristaps 1014:
1.10 kristaps 1015: TAILQ_FOREACH(pp, &pn->childq, child) {
1016: if (NODE_TEXT == pp->node) {
1017: pnode_printmopen(p);
1.13 kristaps 1018: fputs("Ar", stdout);
1.44 schwarze 1019: }
1.10 kristaps 1020: pnode_print(p, pp);
1.44 schwarze 1021: if (NODE_TEXT == pp->node && isrep)
1.12 kristaps 1022: fputs("...", stdout);
1.10 kristaps 1023: }
1.4 kristaps 1024: }
1025:
1.24 kristaps 1026: static void
1027: pnode_printgroup(struct parse *p, struct pnode *pn)
1028: {
1029: struct pnode *pp, *np;
1030: struct pattr *ap;
1031: int isop, sv;
1032:
1033: isop = 1;
1.44 schwarze 1034: TAILQ_FOREACH(ap, &pn->attrq, child)
1.24 kristaps 1035: if (ATTRKEY_CHOICE == ap->key &&
1036: (ATTRVAL_PLAIN == ap->val ||
1037: ATTRVAL_REQ == ap->val)) {
1038: isop = 0;
1039: break;
1040: }
1041:
1.44 schwarze 1042: /*
1.24 kristaps 1043: * Make sure we're on a macro line.
1044: * This will prevent pnode_print() for putting us on a
1045: * subsequent line.
1046: */
1047: sv = p->newln;
1048: pnode_printmopen(p);
1.44 schwarze 1049: if (isop)
1.24 kristaps 1050: fputs("Op", stdout);
1051: else if (sv)
1052: fputs("No", stdout);
1053:
1054: /*
1055: * Keep on printing text separated by the vertical bar as long
1056: * as we're within the same origin node as the group.
1057: * This is kind of a nightmare.
1058: * Eh, DocBook...
1059: * FIXME: if there's a "Fl", we don't cut off the leading "-"
1060: * like we do in pnode_print().
1061: */
1062: TAILQ_FOREACH(pp, &pn->childq, child) {
1063: pnode_print(p, pp);
1064: np = TAILQ_NEXT(pp, child);
1065: while (NULL != np) {
1066: if (pp->node != np->node)
1067: break;
1068: fputs(" |", stdout);
1069: pnode_printmacrolinepart(p, np);
1070: pp = np;
1071: np = TAILQ_NEXT(np, child);
1072: }
1073: }
1074:
1075: pnode_printmclose(p, sv);
1076: }
1077:
1.7 kristaps 1078: static void
1079: pnode_printprologue(struct parse *p, struct pnode *pn)
1080: {
1081: struct pnode *pp;
1.51 schwarze 1082: struct pattr *ap;
1083: const char *name;
1.7 kristaps 1084:
1.9 kristaps 1085: pp = NULL == p->root ? NULL :
1086: pnode_findfirst(p->root, NODE_REFMETA);
1087:
1.51 schwarze 1088: puts(".Dd $Mdocdate" "$");
1.9 kristaps 1089: if (NULL != pp) {
1.7 kristaps 1090: pnode_printrefmeta(p, pp);
1091: pnode_unlink(pp);
1092: } else {
1.51 schwarze 1093: name = "UNKNOWN";
1094: TAILQ_FOREACH(ap, &p->root->attrq, child) {
1095: if (ATTRKEY_ID == ap->key) {
1096: name = ap->rawval;
1097: break;
1098: }
1099: }
1100: printf(".Dt %s 1\n", name);
1.7 kristaps 1101: }
1.51 schwarze 1102: puts(".Os");
1.43 kristaps 1103:
1104: if (PARSE_EQN & p->flags) {
1105: puts(".EQ");
1106: puts("delim $$");
1107: puts(".EN");
1108: }
1.7 kristaps 1109: }
1110:
1.42 kristaps 1111: /*
1112: * We can have multiple <term> elements within a <varlistentry>, which
1113: * we should comma-separate as list headers.
1114: */
1.13 kristaps 1115: static void
1116: pnode_printvarlistentry(struct parse *p, struct pnode *pn)
1117: {
1118: struct pnode *pp;
1.42 kristaps 1119: int first = 1;
1.13 kristaps 1120:
1121: assert(p->newln);
1.42 kristaps 1122: fputs(".It", stdout);
1123: p->newln = 0;
1124:
1.13 kristaps 1125: TAILQ_FOREACH(pp, &pn->childq, child)
1126: if (NODE_TERM == pp->node) {
1.42 kristaps 1127: if ( ! first)
1128: putchar(',');
1.13 kristaps 1129: pnode_print(p, pp);
1130: pnode_unlink(pp);
1.42 kristaps 1131: first = 0;
1132: } else
1133: break;
1.13 kristaps 1134:
1.42 kristaps 1135: putchar('\n');
1.13 kristaps 1136: p->newln = 1;
1137: }
1138:
1139: static void
1.25 kristaps 1140: pnode_printrow(struct parse *p, struct pnode *pn)
1141: {
1142: struct pnode *pp;
1143:
1144: puts(".Bl -dash -compact");
1145:
1146: TAILQ_FOREACH(pp, &pn->childq, child) {
1147: assert(p->newln);
1148: puts(".It");
1149: pnode_print(p, pp);
1150: pnode_printmclose(p, 1);
1151: }
1152: assert(p->newln);
1153: puts(".El");
1154: }
1155:
1156: static void
1157: pnode_printtable(struct parse *p, struct pnode *pn)
1.16 kristaps 1158: {
1159: struct pnode *pp;
1160:
1161: assert(p->newln);
1162: TAILQ_FOREACH(pp, &pn->childq, child)
1163: if (NODE_TITLE == pp->node) {
1164: puts(".Pp");
1165: pnode_print(p, pp);
1166: pnode_unlink(pp);
1167: }
1.25 kristaps 1168: assert(p->newln);
1169: puts(".Bl -ohang");
1170: while (NULL != (pp = pnode_findfirst(pn, NODE_ROW))) {
1171: puts(".It Table Row");
1172: pnode_printrow(p, pp);
1173: pnode_printmclose(p, 1);
1174: pnode_unlink(pp);
1175: }
1176: assert(p->newln);
1177: puts(".El");
1178: }
1179:
1180: static void
1181: pnode_printlist(struct parse *p, struct pnode *pn)
1182: {
1183: struct pnode *pp;
1.16 kristaps 1184:
1185: assert(p->newln);
1.25 kristaps 1186: TAILQ_FOREACH(pp, &pn->childq, child)
1187: if (NODE_TITLE == pp->node) {
1188: puts(".Pp");
1189: pnode_print(p, pp);
1190: pnode_unlink(pp);
1191: }
1192: assert(p->newln);
1.21 kristaps 1193:
1194: if (NODE_ORDEREDLIST == pn->node)
1195: puts(".Bl -enum");
1196: else
1.53 ! schwarze 1197: puts(".Bl -bullet");
1.21 kristaps 1198:
1.16 kristaps 1199: TAILQ_FOREACH(pp, &pn->childq, child) {
1200: assert(p->newln);
1201: puts(".It");
1202: pnode_print(p, pp);
1203: pnode_printmclose(p, 1);
1204: }
1205: assert(p->newln);
1206: puts(".El");
1207: }
1208:
1209: static void
1.13 kristaps 1210: pnode_printvariablelist(struct parse *p, struct pnode *pn)
1211: {
1212: struct pnode *pp;
1213:
1214: assert(p->newln);
1215: TAILQ_FOREACH(pp, &pn->childq, child)
1216: if (NODE_TITLE == pp->node) {
1217: puts(".Pp");
1218: pnode_print(p, pp);
1219: pnode_unlink(pp);
1220: }
1221:
1222: assert(p->newln);
1223: puts(".Bl -tag -width Ds");
1224: TAILQ_FOREACH(pp, &pn->childq, child)
1225: if (NODE_VARLISTENTRY != pp->node) {
1226: assert(p->newln);
1227: fputs(".It", stdout);
1228: pnode_printmacroline(p, pp);
1229: } else {
1230: assert(p->newln);
1231: pnode_print(p, pp);
1232: }
1233: assert(p->newln);
1234: puts(".El");
1235: }
1236:
1.1 kristaps 1237: /*
1238: * Print a parsed node (or ignore it--whatever).
1239: * This is a recursive function.
1.23 kristaps 1240: * FIXME: if we're in a literal context (<screen> or <programlisting> or
1241: * whatever), don't print inline macros.
1.1 kristaps 1242: */
1243: static void
1244: pnode_print(struct parse *p, struct pnode *pn)
1245: {
1246: struct pnode *pp;
1247: char *cp;
1.10 kristaps 1248: int last, sv;
1.1 kristaps 1249:
1250: if (NULL == pn)
1251: return;
1252:
1.10 kristaps 1253: sv = p->newln;
1.1 kristaps 1254:
1.50 schwarze 1255: /* XXX fprintf(stderr, "NODE %s\n", nodes[pn->node].name); */
1.1 kristaps 1256: switch (pn->node) {
1.27 kristaps 1257: case (NODE_APPLICATION):
1258: pnode_printmopen(p);
1259: fputs("Nm", stdout);
1260: break;
1.30 kristaps 1261: case (NODE_ANCHOR):
1262: /* Don't print anything! */
1263: return;
1.4 kristaps 1264: case (NODE_ARG):
1.10 kristaps 1265: pnode_printarg(p, pn);
1.4 kristaps 1266: pnode_unlinksub(pn);
1267: break;
1.50 schwarze 1268: case (NODE_AUTHOR):
1269: pnode_printmopen(p);
1270: fputs("An", stdout);
1271: break;
1272: case (NODE_AUTHORGROUP):
1273: assert(p->newln);
1274: puts(".An -split");
1275: break;
1276: case (NODE_BOOKINFO):
1277: assert(p->newln);
1278: puts(".Sh NAME");
1279: break;
1.1 kristaps 1280: case (NODE_CITEREFENTRY):
1.34 kristaps 1281: pnode_printmopen(p);
1282: fputs("Xr", stdout);
1.1 kristaps 1283: pnode_printciterefentry(p, pn);
1.4 kristaps 1284: pnode_unlinksub(pn);
1.1 kristaps 1285: break;
1286: case (NODE_CODE):
1.10 kristaps 1287: pnode_printmopen(p);
1.13 kristaps 1288: fputs("Li", stdout);
1.4 kristaps 1289: break;
1290: case (NODE_COMMAND):
1.10 kristaps 1291: pnode_printmopen(p);
1.13 kristaps 1292: fputs("Nm", stdout);
1293: break;
1.33 kristaps 1294: case (NODE_CONSTANT):
1295: pnode_printmopen(p);
1296: fputs("Dv", stdout);
1297: break;
1.50 schwarze 1298: case (NODE_EDITOR):
1299: puts("editor: ");
1300: pnode_printmopen(p);
1301: fputs("An", stdout);
1302: break;
1.13 kristaps 1303: case (NODE_EMPHASIS):
1304: pnode_printmopen(p);
1305: fputs("Em", stdout);
1.1 kristaps 1306: break;
1.21 kristaps 1307: case (NODE_ENVAR):
1308: pnode_printmopen(p);
1309: fputs("Ev", stdout);
1310: break;
1.17 kristaps 1311: case (NODE_FILENAME):
1312: pnode_printmopen(p);
1313: fputs("Pa", stdout);
1314: break;
1.3 kristaps 1315: case (NODE_FUNCTION):
1.10 kristaps 1316: pnode_printmopen(p);
1.13 kristaps 1317: fputs("Fn", stdout);
1.3 kristaps 1318: break;
1319: case (NODE_FUNCPROTOTYPE):
1.10 kristaps 1320: assert(p->newln);
1.3 kristaps 1321: pnode_printfuncprototype(p, pn);
1.4 kristaps 1322: pnode_unlinksub(pn);
1.3 kristaps 1323: break;
1.1 kristaps 1324: case (NODE_FUNCSYNOPSISINFO):
1.10 kristaps 1325: pnode_printmopen(p);
1.13 kristaps 1326: fputs("Fd", stdout);
1.16 kristaps 1327: break;
1.43 kristaps 1328: case (NODE_INFORMALEQUATION):
1329: if ( ! p->newln)
1330: putchar('\n');
1331: puts(".EQ");
1332: p->newln = 0;
1333: break;
1334: case (NODE_INLINEEQUATION):
1335: fputc('$', stdout);
1336: p->newln = 0;
1337: break;
1.16 kristaps 1338: case (NODE_ITEMIZEDLIST):
1339: assert(p->newln);
1.25 kristaps 1340: pnode_printlist(p, pn);
1341: pnode_unlinksub(pn);
1.24 kristaps 1342: break;
1343: case (NODE_GROUP):
1344: pnode_printgroup(p, pn);
1345: pnode_unlinksub(pn);
1.10 kristaps 1346: break;
1.50 schwarze 1347: case (NODE_LEGALNOTICE):
1348: assert(p->newln);
1349: puts(".Sh LEGAL NOTICE");
1350: break;
1.19 kristaps 1351: case (NODE_LITERAL):
1352: pnode_printmopen(p);
1353: fputs("Li", stdout);
1354: break;
1.40 kristaps 1355: case (NODE_MML_MFENCED):
1.41 kristaps 1356: pnode_printmathfenced(p, pn);
1357: pnode_unlinksub(pn);
1.40 kristaps 1358: break;
1359: case (NODE_MML_MROW):
1360: case (NODE_MML_MI):
1361: case (NODE_MML_MN):
1362: case (NODE_MML_MO):
1.43 kristaps 1363: if (TAILQ_EMPTY(&pn->childq))
1364: break;
1365: fputs(" { ", stdout);
1.40 kristaps 1366: break;
1367: case (NODE_MML_MFRAC):
1368: case (NODE_MML_MSUB):
1369: case (NODE_MML_MSUP):
1370: pnode_printmath(p, pn);
1371: pnode_unlinksub(pn);
1372: break;
1.10 kristaps 1373: case (NODE_OPTION):
1374: pnode_printmopen(p);
1.13 kristaps 1375: fputs("Fl", stdout);
1.1 kristaps 1376: break;
1.25 kristaps 1377: case (NODE_ORDEREDLIST):
1378: assert(p->newln);
1379: pnode_printlist(p, pn);
1380: pnode_unlinksub(pn);
1381: break;
1.1 kristaps 1382: case (NODE_PARA):
1.10 kristaps 1383: assert(p->newln);
1.44 schwarze 1384: if (NULL != pn->parent &&
1385: NODE_LISTITEM == pn->parent->node)
1.13 kristaps 1386: break;
1.1 kristaps 1387: puts(".Pp");
1.3 kristaps 1388: break;
1389: case (NODE_PARAMETER):
1.10 kristaps 1390: /* Suppress non-text children... */
1391: pnode_printmopen(p);
1392: fputs("Fa \"", stdout);
1.32 kristaps 1393: pnode_printmacrolinetext(p, pn, MACROLINE_NOWS);
1394: fputs("\"", stdout);
1.4 kristaps 1395: pnode_unlinksub(pn);
1.1 kristaps 1396: break;
1.28 kristaps 1397: case (NODE_QUOTE):
1398: pnode_printmopen(p);
1399: fputs("Qo", stdout);
1400: break;
1.50 schwarze 1401: case (NODE_LITERALLAYOUT):
1402: /* FALLTHROUGH */
1.1 kristaps 1403: case (NODE_PROGRAMLISTING):
1.22 kristaps 1404: /* FALLTHROUGH */
1405: case (NODE_SCREEN):
1.10 kristaps 1406: assert(p->newln);
1.1 kristaps 1407: puts(".Bd -literal");
1.15 kristaps 1408: break;
1409: case (NODE_REFENTRYINFO):
1410: /* Suppress. */
1411: pnode_unlinksub(pn);
1.1 kristaps 1412: break;
1413: case (NODE_REFMETA):
1.7 kristaps 1414: abort();
1.1 kristaps 1415: break;
1416: case (NODE_REFNAME):
1.10 kristaps 1417: /* Suppress non-text children... */
1418: pnode_printmopen(p);
1.13 kristaps 1419: fputs("Nm", stdout);
1420: p->newln = 0;
1.10 kristaps 1421: pnode_printmacrolinepart(p, pn);
1.4 kristaps 1422: pnode_unlinksub(pn);
1.10 kristaps 1423: break;
1.1 kristaps 1424: case (NODE_REFNAMEDIV):
1.10 kristaps 1425: assert(p->newln);
1.1 kristaps 1426: puts(".Sh NAME");
1427: break;
1428: case (NODE_REFPURPOSE):
1.10 kristaps 1429: assert(p->newln);
1.13 kristaps 1430: pnode_printmopen(p);
1431: fputs("Nd", stdout);
1.10 kristaps 1432: break;
1.1 kristaps 1433: case (NODE_REFSYNOPSISDIV):
1.10 kristaps 1434: assert(p->newln);
1.6 kristaps 1435: pnode_printrefsynopsisdiv(p, pn);
1.10 kristaps 1436: puts(".Sh SYNOPSIS");
1.1 kristaps 1437: break;
1.52 schwarze 1438: case (NODE_PREFACE):
1.1 kristaps 1439: case (NODE_REFSECT1):
1.20 kristaps 1440: case (NODE_REFSECT2):
1.29 kristaps 1441: case (NODE_REFSECT3):
1442: case (NODE_REFSECTION):
1.50 schwarze 1443: case (NODE_CHAPTER):
1444: case (NODE_SECT1):
1445: case (NODE_SECT2):
1.52 schwarze 1446: case (NODE_SECTION):
1.29 kristaps 1447: case (NODE_NOTE):
1448: case (NODE_TIP):
1449: case (NODE_CAUTION):
1450: case (NODE_WARNING):
1.10 kristaps 1451: assert(p->newln);
1.1 kristaps 1452: pnode_printrefsect(p, pn);
1453: break;
1.13 kristaps 1454: case (NODE_REPLACEABLE):
1455: pnode_printmopen(p);
1456: fputs("Ar", stdout);
1457: break;
1.19 kristaps 1458: case (NODE_SBR):
1459: assert(p->newln);
1460: puts(".br");
1461: break;
1.30 kristaps 1462: case (NODE_SGMLTAG):
1463: pnode_printmopen(p);
1464: fputs("Li", stdout);
1465: break;
1.8 kristaps 1466: case (NODE_STRUCTNAME):
1.10 kristaps 1467: pnode_printmopen(p);
1.13 kristaps 1468: fputs("Vt", stdout);
1.25 kristaps 1469: break;
1470: case (NODE_TABLE):
1.35 kristaps 1471: /* FALLTHROUGH */
1472: case (NODE_INFORMALTABLE):
1.25 kristaps 1473: assert(p->newln);
1474: pnode_printtable(p, pn);
1475: pnode_unlinksub(pn);
1.10 kristaps 1476: break;
1.1 kristaps 1477: case (NODE_TEXT):
1.13 kristaps 1478: if (0 == p->newln)
1479: putchar(' ');
1.37 kristaps 1480:
1.1 kristaps 1481: bufclear(p);
1482: bufappend(p, pn);
1.37 kristaps 1483:
1484: if (0 == p->bsz) {
1485: assert(pn->real != pn->b);
1486: break;
1487: }
1488:
1.1 kristaps 1489: /*
1490: * Output all characters, squeezing out whitespace
1.44 schwarze 1491: * between newlines.
1.1 kristaps 1492: * XXX: all whitespace, including tabs (?).
1493: * Remember to escape control characters and escapes.
1494: */
1.10 kristaps 1495: assert(p->bsz);
1.20 kristaps 1496: cp = p->b;
1.37 kristaps 1497:
1.20 kristaps 1498: /*
1499: * There's often a superfluous "-" in its <option> tags
1500: * before the actual flags themselves.
1501: * "Fl" does this for us, so remove it.
1502: */
1503: if (NULL != pn->parent &&
1504: NODE_OPTION == pn->parent->node &&
1505: '-' == *cp)
1506: cp++;
1507: for (last = '\n'; '\0' != *cp; ) {
1.1 kristaps 1508: if ('\n' == last) {
1509: /* Consume all whitespace. */
1.46 schwarze 1510: if (isspace((unsigned char)*cp)) {
1511: while (isspace((unsigned char)*cp))
1.1 kristaps 1512: cp++;
1513: continue;
1514: } else if ('\'' == *cp || '.' == *cp)
1515: fputs("\\&", stdout);
1516: }
1517: putchar(last = *cp++);
1518: /* If we're a character escape, escape us. */
1519: if ('\\' == last)
1520: putchar('e');
1521: }
1.10 kristaps 1522: p->newln = 0;
1.1 kristaps 1523: break;
1.50 schwarze 1524: case (NODE_TITLE):
1525: if (pn->parent->node == NODE_BOOKINFO) {
1526: pnode_printmopen(p);
1527: fputs("Nd", stdout);
1528: }
1529: break;
1.39 kristaps 1530: case (NODE_TYPE):
1531: pnode_printmopen(p);
1532: fputs("Vt", stdout);
1533: break;
1.26 kristaps 1534: case (NODE_USERINPUT):
1535: pnode_printmopen(p);
1536: fputs("Li", stdout);
1537: break;
1.13 kristaps 1538: case (NODE_VARIABLELIST):
1539: assert(p->newln);
1540: pnode_printvariablelist(p, pn);
1541: pnode_unlinksub(pn);
1542: break;
1543: case (NODE_VARLISTENTRY):
1544: assert(p->newln);
1545: pnode_printvarlistentry(p, pn);
1546: break;
1.26 kristaps 1547: case (NODE_VARNAME):
1.23 kristaps 1548: pnode_printmopen(p);
1.26 kristaps 1549: fputs("Va", stdout);
1.23 kristaps 1550: break;
1.1 kristaps 1551: default:
1552: break;
1553: }
1554:
1555: TAILQ_FOREACH(pp, &pn->childq, child)
1556: pnode_print(p, pp);
1557:
1558: switch (pn->node) {
1.43 kristaps 1559: case (NODE_INFORMALEQUATION):
1.40 kristaps 1560: if ( ! p->newln)
1561: putchar('\n');
1562: puts(".EN");
1563: p->newln = 1;
1564: break;
1.43 kristaps 1565: case (NODE_INLINEEQUATION):
1566: fputs("$ ", stdout);
1567: p->newln = sv;
1568: break;
1.40 kristaps 1569: case (NODE_MML_MROW):
1570: case (NODE_MML_MI):
1571: case (NODE_MML_MN):
1572: case (NODE_MML_MO):
1.43 kristaps 1573: if (TAILQ_EMPTY(&pn->childq))
1574: break;
1575: fputs(" } ", stdout);
1.40 kristaps 1576: break;
1.27 kristaps 1577: case (NODE_APPLICATION):
1.10 kristaps 1578: case (NODE_ARG):
1.50 schwarze 1579: case (NODE_AUTHOR):
1.34 kristaps 1580: case (NODE_CITEREFENTRY):
1.10 kristaps 1581: case (NODE_CODE):
1582: case (NODE_COMMAND):
1.33 kristaps 1583: case (NODE_CONSTANT):
1.50 schwarze 1584: case (NODE_EDITOR):
1.13 kristaps 1585: case (NODE_EMPHASIS):
1.21 kristaps 1586: case (NODE_ENVAR):
1.17 kristaps 1587: case (NODE_FILENAME):
1.10 kristaps 1588: case (NODE_FUNCTION):
1589: case (NODE_FUNCSYNOPSISINFO):
1.19 kristaps 1590: case (NODE_LITERAL):
1.10 kristaps 1591: case (NODE_OPTION):
1592: case (NODE_PARAMETER):
1.13 kristaps 1593: case (NODE_REPLACEABLE):
1594: case (NODE_REFPURPOSE):
1.30 kristaps 1595: case (NODE_SGMLTAG):
1.10 kristaps 1596: case (NODE_STRUCTNAME):
1597: case (NODE_TEXT):
1.39 kristaps 1598: case (NODE_TYPE):
1.23 kristaps 1599: case (NODE_USERINPUT):
1.26 kristaps 1600: case (NODE_VARNAME):
1.37 kristaps 1601: pnode_printmclosepunct(p, pn, sv);
1.28 kristaps 1602: break;
1603: case (NODE_QUOTE):
1604: pnode_printmclose(p, sv);
1605: sv = p->newln;
1606: pnode_printmopen(p);
1607: fputs("Qc", stdout);
1.10 kristaps 1608: pnode_printmclose(p, sv);
1609: break;
1.12 kristaps 1610: case (NODE_REFNAME):
1611: /*
1612: * If we're in the NAME macro and we have multiple
1613: * <refname> macros in sequence, then print out a
1614: * trailing comma before the newline.
1615: */
1.44 schwarze 1616: if (NULL != pn->parent &&
1.12 kristaps 1617: NODE_REFNAMEDIV == pn->parent->node &&
1618: NULL != TAILQ_NEXT(pn, child) &&
1.44 schwarze 1619: NODE_REFNAME == TAILQ_NEXT(pn, child)->node)
1.12 kristaps 1620: fputs(" ,", stdout);
1621: pnode_printmclose(p, sv);
1.52 schwarze 1622: break;
1623: case (NODE_PREFACE):
1624: case (NODE_REFSECT1):
1625: case (NODE_REFSECT2):
1626: case (NODE_REFSECT3):
1627: case (NODE_REFSECTION):
1628: case (NODE_CHAPTER):
1629: case (NODE_SECT1):
1630: case (NODE_SECT2):
1631: case (NODE_SECTION):
1632: case (NODE_NOTE):
1633: case (NODE_TIP):
1634: case (NODE_CAUTION):
1635: case (NODE_WARNING):
1636: p->level--;
1.12 kristaps 1637: break;
1.50 schwarze 1638: case (NODE_LITERALLAYOUT):
1639: /* FALLTHROUGH */
1.1 kristaps 1640: case (NODE_PROGRAMLISTING):
1.22 kristaps 1641: /* FALLTHROUGH */
1642: case (NODE_SCREEN):
1.10 kristaps 1643: assert(p->newln);
1.1 kristaps 1644: puts(".Ed");
1.10 kristaps 1645: p->newln = 1;
1.50 schwarze 1646: break;
1647: case (NODE_TITLE):
1648: if (pn->parent->node == NODE_BOOKINFO) {
1649: pnode_printmclose(p, 1);
1650: puts(".Sh AUTHORS");
1651: }
1.1 kristaps 1652: break;
1653: default:
1654: break;
1655: }
1656: }
1657:
1658: /*
1659: * Loop around the read buffer until we've drained it of all data.
1660: * Invoke the parser context with each buffer fill.
1661: */
1662: static int
1.44 schwarze 1663: readfile(XML_Parser xp, int fd,
1.1 kristaps 1664: char *b, size_t bsz, const char *fn)
1665: {
1666: struct parse p;
1667: int rc;
1668: ssize_t ssz;
1669:
1670: memset(&p, 0, sizeof(struct parse));
1671:
1672: p.b = malloc(p.bsz = p.mbsz = 1024);
1.12 kristaps 1673: p.fname = fn;
1674: p.xml = xp;
1.1 kristaps 1675:
1676: XML_SetCharacterDataHandler(xp, xml_char);
1677: XML_SetElementHandler(xp, xml_elem_start, xml_elem_end);
1678: XML_SetUserData(xp, &p);
1679:
1680: while ((ssz = read(fd, b, bsz)) >= 0) {
1681: if (0 == (rc = XML_Parse(xp, b, ssz, 0 == ssz)))
1.30 kristaps 1682: fprintf(stderr, "%s:%zu:%zu: %s\n", fn,
1683: XML_GetCurrentLineNumber(xp),
1.44 schwarze 1684: XML_GetCurrentColumnNumber(xp),
1.1 kristaps 1685: XML_ErrorString
1686: (XML_GetErrorCode(xp)));
1687: else if ( ! p.stop && ssz > 0)
1688: continue;
1.44 schwarze 1689: /*
1.1 kristaps 1690: * Exit when we've read all or errors have occured
1691: * during the parse sequence.
1692: */
1.10 kristaps 1693: p.newln = 1;
1.7 kristaps 1694: pnode_printprologue(&p, p.root);
1.1 kristaps 1695: pnode_print(&p, p.root);
1696: pnode_free(p.root);
1697: free(p.b);
1698: return(0 != rc && ! p.stop);
1699: }
1700:
1701: /* Read error has occured. */
1702: perror(fn);
1703: pnode_free(p.root);
1704: free(p.b);
1705: return(0);
1706: }
1707:
1708: int
1709: main(int argc, char *argv[])
1710: {
1711: XML_Parser xp;
1712: const char *fname;
1713: char *buf;
1.38 kristaps 1714: int fd, rc, ch;
1715: const char *progname;
1716:
1717: progname = strrchr(argv[0], '/');
1718: if (progname == NULL)
1719: progname = argv[0];
1720: else
1721: ++progname;
1.1 kristaps 1722:
1723: fname = "-";
1724: xp = NULL;
1725: buf = NULL;
1726: rc = 0;
1727:
1.38 kristaps 1728: while (-1 != (ch = getopt(argc, argv, "W")))
1729: switch (ch) {
1730: case ('W'):
1731: warn = 1;
1732: break;
1733: default:
1734: goto usage;
1735: }
1.1 kristaps 1736:
1737: argc -= optind;
1738: argv += optind;
1739:
1.45 schwarze 1740: if (argc > 1) {
1741: fprintf(stderr, "%s: Too many arguments\n", argv[1]);
1742: goto usage;
1743: } else if (argc > 0)
1.1 kristaps 1744: fname = argv[0];
1745:
1746: /* Read from stdin or a file. */
1.44 schwarze 1747: fd = 0 == strcmp(fname, "-") ?
1.1 kristaps 1748: STDIN_FILENO : open(fname, O_RDONLY, 0);
1749:
1750: /*
1751: * Open file for reading.
1752: * Allocate a read buffer.
1753: * Create the parser context.
1754: * Dive directly into the parse.
1755: */
1756: if (-1 == fd)
1757: perror(fname);
1758: else if (NULL == (buf = malloc(4096)))
1759: perror(NULL);
1760: else if (NULL == (xp = XML_ParserCreate(NULL)))
1761: perror(NULL);
1762: else if ( ! readfile(xp, fd, buf, 4096, fname))
1763: rc = 1;
1764:
1765: XML_ParserFree(xp);
1766: free(buf);
1767: if (STDIN_FILENO != fd)
1768: close(fd);
1769: return(rc ? EXIT_SUCCESS : EXIT_FAILURE);
1.38 kristaps 1770:
1771: usage:
1.45 schwarze 1772: fprintf(stderr, "usage: %s [-W] [input_filename]\n", progname);
1.38 kristaps 1773: return(EXIT_FAILURE);
1.1 kristaps 1774: }
CVSweb