Annotation of docbook2mdoc/docbook2mdoc.c, Revision 1.79
1.79 ! schwarze 1: /* $Id: docbook2mdoc.c,v 1.78 2019/03/28 20:41:33 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 <assert.h>
19: #include <ctype.h>
20: #include <stdio.h>
21: #include <stdlib.h>
22:
1.74 schwarze 23: #include "node.h"
1.75 schwarze 24: #include "macro.h"
1.74 schwarze 25: #include "format.h"
26:
27: /*
28: * The implementation of the mdoc(7) formatter.
29: */
1.12 kristaps 30:
1.74 schwarze 31: static void pnode_print(struct format *, struct pnode *);
1.25 kristaps 32:
1.37 kristaps 33:
1.54 schwarze 34: static void
1.74 schwarze 35: pnode_printpara(struct format *p, struct pnode *pn)
1.54 schwarze 36: {
37: struct pnode *pp;
38:
1.61 schwarze 39: if ((pp = TAILQ_PREV(pn, pnodeq, child)) == NULL &&
40: (pp = pn->parent) == NULL)
1.54 schwarze 41: return;
42:
1.61 schwarze 43: switch (pp->node) {
44: case NODE_ENTRY:
45: case NODE_LISTITEM:
46: return;
47: case NODE_PREFACE:
48: case NODE_SECTION:
49: if (p->level < 3)
50: return;
51: break;
52: default:
53: break;
54: }
1.69 schwarze 55: macro_line(p, "Pp");
1.54 schwarze 56: }
57:
1.37 kristaps 58: /*
1.10 kristaps 59: * If the SYNOPSIS macro has a superfluous title, kill it.
1.8 kristaps 60: */
1.1 kristaps 61: static void
1.74 schwarze 62: pnode_printrefsynopsisdiv(struct format *p, struct pnode *pn)
1.6 kristaps 63: {
1.71 schwarze 64: struct pnode *pp, *pq;
1.6 kristaps 65:
1.71 schwarze 66: TAILQ_FOREACH_SAFE(pp, &pn->childq, child, pq)
67: if (pp->node == NODE_TITLE)
1.6 kristaps 68: pnode_unlink(pp);
1.71 schwarze 69:
70: macro_line(p, "Sh SYNOPSIS");
1.6 kristaps 71: }
72:
1.8 kristaps 73: /*
74: * Start a hopefully-named `Sh' section.
75: */
1.6 kristaps 76: static void
1.74 schwarze 77: pnode_printrefsect(struct format *p, struct pnode *pn)
1.1 kristaps 78: {
79: struct pnode *pp;
1.52 schwarze 80: const char *title;
81: int flags, level;
82:
1.64 schwarze 83: if (pn->parent == NULL)
1.56 schwarze 84: return;
85:
1.52 schwarze 86: level = ++p->level;
1.72 schwarze 87: flags = ARG_SPACE;
88: if (level == 1)
89: flags |= ARG_UPPER;
1.64 schwarze 90: if (level < 3) {
1.52 schwarze 91: switch (pn->node) {
1.62 schwarze 92: case NODE_CAUTION:
93: case NODE_NOTE:
94: case NODE_TIP:
95: case NODE_WARNING:
1.52 schwarze 96: level = 3;
97: break;
98: default:
99: break;
100: }
101: }
1.1 kristaps 102:
103: TAILQ_FOREACH(pp, &pn->childq, child)
1.64 schwarze 104: if (pp->node == NODE_TITLE)
1.1 kristaps 105: break;
106:
1.64 schwarze 107: if (pp == NULL) {
1.52 schwarze 108: switch (pn->node) {
1.62 schwarze 109: case NODE_PREFACE:
1.52 schwarze 110: title = "Preface";
111: break;
1.62 schwarze 112: case NODE_CAUTION:
1.52 schwarze 113: title = "Caution";
114: break;
1.62 schwarze 115: case NODE_NOTE:
1.52 schwarze 116: title = "Note";
117: break;
1.62 schwarze 118: case NODE_TIP:
1.52 schwarze 119: title = "Tip";
120: break;
1.62 schwarze 121: case NODE_WARNING:
1.52 schwarze 122: title = "Warning";
123: break;
124: default:
125: title = "Unknown";
126: break;
127: }
128: }
129:
130: switch (level) {
1.62 schwarze 131: case 1:
1.69 schwarze 132: macro_open(p, "Sh");
1.29 kristaps 133: break;
1.62 schwarze 134: case 2:
1.69 schwarze 135: macro_open(p, "Ss");
1.29 kristaps 136: break;
1.52 schwarze 137: default:
1.54 schwarze 138: pnode_printpara(p, pn);
1.69 schwarze 139: macro_open(p, "Sy");
1.29 kristaps 140: break;
141: }
1.20 kristaps 142:
1.64 schwarze 143: if (pp != NULL) {
1.69 schwarze 144: macro_addnode(p, pp, flags);
1.5 kristaps 145: pnode_unlink(pp);
1.52 schwarze 146: } else
1.72 schwarze 147: macro_addarg(p, title, ARG_SPACE | ARG_QUOTED);
1.69 schwarze 148: macro_close(p);
1.1 kristaps 149: }
150:
1.8 kristaps 151: /*
152: * Start a reference, extracting the title and volume.
153: */
1.1 kristaps 154: static void
1.74 schwarze 155: pnode_printciterefentry(struct format *p, struct pnode *pn)
1.1 kristaps 156: {
157: struct pnode *pp, *title, *manvol;
158:
159: title = manvol = NULL;
1.69 schwarze 160: TAILQ_FOREACH(pp, &pn->childq, child) {
1.64 schwarze 161: if (pp->node == NODE_MANVOLNUM)
1.1 kristaps 162: manvol = pp;
1.64 schwarze 163: else if (pp->node == NODE_REFENTRYTITLE)
1.1 kristaps 164: title = pp;
1.69 schwarze 165: }
166: macro_open(p, "Xr");
167: if (title == NULL)
1.72 schwarze 168: macro_addarg(p, "unknown", ARG_SPACE);
1.69 schwarze 169: else
1.72 schwarze 170: macro_addnode(p, title, ARG_SPACE | ARG_SINGLE);
1.69 schwarze 171: if (manvol == NULL)
1.72 schwarze 172: macro_addarg(p, "1", ARG_SPACE);
1.64 schwarze 173: else
1.72 schwarze 174: macro_addnode(p, manvol, ARG_SPACE | ARG_SINGLE);
1.69 schwarze 175: macro_close(p);
1.71 schwarze 176: pnode_unlinksub(pn);
1.1 kristaps 177: }
178:
179: static void
1.74 schwarze 180: pnode_printrefmeta(struct format *p, struct pnode *pn)
1.1 kristaps 181: {
182: struct pnode *pp, *title, *manvol;
183:
184: title = manvol = NULL;
1.69 schwarze 185: TAILQ_FOREACH(pp, &pn->childq, child) {
1.64 schwarze 186: if (pp->node == NODE_MANVOLNUM)
1.1 kristaps 187: manvol = pp;
1.64 schwarze 188: else if (pp->node == NODE_REFENTRYTITLE)
1.1 kristaps 189: title = pp;
1.69 schwarze 190: }
191: macro_open(p, "Dt");
192: if (title == NULL)
1.72 schwarze 193: macro_addarg(p, "UNKNOWN", ARG_SPACE);
1.69 schwarze 194: else
1.72 schwarze 195: macro_addnode(p, title, ARG_SPACE | ARG_SINGLE | ARG_UPPER);
1.69 schwarze 196: if (manvol == NULL)
1.72 schwarze 197: macro_addarg(p, "1", ARG_SPACE);
1.13 kristaps 198: else
1.72 schwarze 199: macro_addnode(p, manvol, ARG_SPACE | ARG_SINGLE);
1.69 schwarze 200: macro_close(p);
1.71 schwarze 201: pnode_unlink(pn);
1.1 kristaps 202: }
203:
1.3 kristaps 204: static void
1.74 schwarze 205: pnode_printfuncdef(struct format *p, struct pnode *pn)
1.3 kristaps 206: {
207: struct pnode *pp, *ftype, *func;
208:
209: ftype = func = NULL;
1.69 schwarze 210: TAILQ_FOREACH(pp, &pn->childq, child) {
1.64 schwarze 211: if (pp->node == NODE_TEXT)
1.3 kristaps 212: ftype = pp;
1.64 schwarze 213: else if (pp->node == NODE_FUNCTION)
1.3 kristaps 214: func = pp;
1.13 kristaps 215: }
1.69 schwarze 216: if (ftype != NULL)
1.72 schwarze 217: macro_argline(p, "Ft", ftype->b);
1.69 schwarze 218: macro_open(p, "Fo");
219: if (func == NULL)
1.72 schwarze 220: macro_addarg(p, "UNKNOWN", ARG_SPACE);
1.69 schwarze 221: else
1.72 schwarze 222: macro_addnode(p, func, ARG_SPACE | ARG_SINGLE);
1.69 schwarze 223: macro_close(p);
1.3 kristaps 224: }
225:
1.40 kristaps 226: /*
1.41 kristaps 227: * The <mml:mfenced> node is a little peculiar.
228: * First, it can have arbitrary open and closing tokens, which default
229: * to parentheses.
230: * Second, >1 arguments are separated by commas.
231: */
232: static void
1.74 schwarze 233: pnode_printmathfenced(struct format *p, struct pnode *pn)
1.41 kristaps 234: {
235: struct pnode *pp;
236:
1.59 schwarze 237: printf("left %s ", pnode_getattr_raw(pn, ATTRKEY_OPEN, "("));
1.41 kristaps 238:
239: pp = TAILQ_FIRST(&pn->childq);
240: pnode_print(p, pp);
241:
1.64 schwarze 242: while ((pp = TAILQ_NEXT(pp, child)) != NULL) {
1.41 kristaps 243: putchar(',');
244: pnode_print(p, pp);
245: }
1.59 schwarze 246: printf("right %s ", pnode_getattr_raw(pn, ATTRKEY_CLOSE, ")"));
1.71 schwarze 247: pnode_unlinksub(pn);
1.41 kristaps 248: }
249:
250: /*
1.40 kristaps 251: * These math nodes require special handling because they have infix
252: * syntax, instead of the usual prefix or prefix.
253: * So we need to break up the first and second child node with a
254: * particular eqn(7) word.
255: */
256: static void
1.74 schwarze 257: pnode_printmath(struct format *p, struct pnode *pn)
1.40 kristaps 258: {
259: struct pnode *pp;
260:
261: pp = TAILQ_FIRST(&pn->childq);
262: pnode_print(p, pp);
263:
264: switch (pn->node) {
1.62 schwarze 265: case NODE_MML_MSUP:
1.42 kristaps 266: fputs(" sup ", stdout);
1.40 kristaps 267: break;
1.62 schwarze 268: case NODE_MML_MFRAC:
1.42 kristaps 269: fputs(" over ", stdout);
1.40 kristaps 270: break;
1.62 schwarze 271: case NODE_MML_MSUB:
1.42 kristaps 272: fputs(" sub ", stdout);
1.40 kristaps 273: break;
274: default:
275: break;
276: }
277:
278: pp = TAILQ_NEXT(pp, child);
279: pnode_print(p, pp);
1.71 schwarze 280: pnode_unlinksub(pn);
1.40 kristaps 281: }
282:
1.3 kristaps 283: static void
1.74 schwarze 284: pnode_printfuncprototype(struct format *p, struct pnode *pn)
1.3 kristaps 285: {
286: struct pnode *pp, *fdef;
287:
288: TAILQ_FOREACH(fdef, &pn->childq, child)
1.64 schwarze 289: if (fdef->node == NODE_FUNCDEF)
1.3 kristaps 290: break;
291:
1.64 schwarze 292: if (fdef != NULL)
1.3 kristaps 293: pnode_printfuncdef(p, fdef);
1.4 kristaps 294: else
1.69 schwarze 295: macro_line(p, "Fo UNKNOWN");
1.3 kristaps 296:
1.44 schwarze 297: TAILQ_FOREACH(pp, &pn->childq, child)
1.64 schwarze 298: if (pp->node == NODE_PARAMDEF)
1.72 schwarze 299: macro_nodeline(p, "Fa", pp, ARG_SINGLE);
1.3 kristaps 300:
1.69 schwarze 301: macro_line(p, "Fc");
1.71 schwarze 302: pnode_unlinksub(pn);
1.3 kristaps 303: }
304:
1.44 schwarze 305: /*
1.10 kristaps 306: * The <arg> element is more complicated than it should be because text
307: * nodes are treated like ".Ar foo", but non-text nodes need to be
308: * re-sent into the printer (i.e., without the preceding ".Ar").
1.12 kristaps 309: * This also handles the case of "repetition" (or in other words, the
310: * ellipsis following an argument) and optionality.
1.10 kristaps 311: */
1.4 kristaps 312: static void
1.74 schwarze 313: pnode_printarg(struct format *p, struct pnode *pn)
1.4 kristaps 314: {
315: struct pnode *pp;
1.12 kristaps 316: struct pattr *ap;
317: int isop, isrep;
318:
319: isop = 1;
320: isrep = 0;
1.69 schwarze 321: TAILQ_FOREACH(ap, &pn->attrq, child) {
1.64 schwarze 322: if (ap->key == ATTRKEY_CHOICE &&
323: (ap->val == ATTRVAL_PLAIN || ap->val == ATTRVAL_REQ))
1.12 kristaps 324: isop = 0;
1.64 schwarze 325: else if (ap->key == ATTRKEY_REP && ap->val == ATTRVAL_REPEAT)
1.12 kristaps 326: isrep = 1;
327: }
1.69 schwarze 328: if (isop)
329: macro_open(p, "Op");
1.4 kristaps 330:
1.10 kristaps 331: TAILQ_FOREACH(pp, &pn->childq, child) {
1.69 schwarze 332: if (pp->node == NODE_TEXT)
333: macro_open(p, "Ar");
1.10 kristaps 334: pnode_print(p, pp);
1.64 schwarze 335: if (isrep && pp->node == NODE_TEXT)
1.72 schwarze 336: macro_addarg(p, "...", ARG_SPACE);
1.10 kristaps 337: }
1.71 schwarze 338: pnode_unlinksub(pn);
1.4 kristaps 339: }
340:
1.24 kristaps 341: static void
1.74 schwarze 342: pnode_printgroup(struct format *p, struct pnode *pn)
1.24 kristaps 343: {
344: struct pnode *pp, *np;
345: struct pattr *ap;
346: int isop, sv;
347:
348: isop = 1;
1.44 schwarze 349: TAILQ_FOREACH(ap, &pn->attrq, child)
1.64 schwarze 350: if (ap->key == ATTRKEY_CHOICE &&
351: (ap->val == ATTRVAL_PLAIN || ap->val == ATTRVAL_REQ)) {
1.24 kristaps 352: isop = 0;
353: break;
354: }
355:
1.44 schwarze 356: /*
1.24 kristaps 357: * Make sure we're on a macro line.
358: * This will prevent pnode_print() for putting us on a
359: * subsequent line.
360: */
1.69 schwarze 361: sv = p->linestate == LINE_NEW;
1.44 schwarze 362: if (isop)
1.69 schwarze 363: macro_open(p, "Op");
1.24 kristaps 364: else if (sv)
1.69 schwarze 365: macro_open(p, "No");
1.24 kristaps 366:
367: /*
368: * Keep on printing text separated by the vertical bar as long
369: * as we're within the same origin node as the group.
370: * This is kind of a nightmare.
371: * Eh, DocBook...
372: * FIXME: if there's a "Fl", we don't cut off the leading "-"
373: * like we do in pnode_print().
374: */
375: TAILQ_FOREACH(pp, &pn->childq, child) {
376: pnode_print(p, pp);
377: np = TAILQ_NEXT(pp, child);
1.64 schwarze 378: while (np != NULL) {
1.24 kristaps 379: if (pp->node != np->node)
380: break;
1.72 schwarze 381: macro_addarg(p, "|", ARG_SPACE);
382: macro_addnode(p, np, ARG_SPACE);
1.24 kristaps 383: pp = np;
384: np = TAILQ_NEXT(np, child);
385: }
386: }
1.69 schwarze 387: if (sv)
388: macro_close(p);
1.71 schwarze 389: pnode_unlinksub(pn);
1.24 kristaps 390: }
391:
1.7 kristaps 392: static void
1.78 schwarze 393: pnode_printauthor(struct format *f, struct pnode *n)
394: {
395: struct pnode *nc, *ncn;
396: int have_contrib, have_name;
397:
398: /*
399: * Print <contrib> children up front, before the .An scope,
400: * and figure out whether we a name of a person.
401: */
402:
403: have_contrib = have_name = 0;
404: TAILQ_FOREACH_SAFE(nc, &n->childq, child, ncn) {
405: switch (nc->node) {
406: case NODE_CONTRIB:
407: if (have_contrib)
408: print_text(f, ",", 0);
409: print_textnode(f, nc);
410: pnode_unlink(nc);
411: have_contrib = 1;
412: break;
413: case NODE_PERSONNAME:
414: have_name = 1;
415: break;
416: default:
417: break;
418: }
419: }
420: if (TAILQ_FIRST(&n->childq) == NULL)
421: return;
422:
423: if (have_contrib)
424: print_text(f, ":", 0);
425:
426: /*
427: * If we have a name, print it in the .An scope and leave
428: * all other content for child handlers, to print after the
429: * scope. Otherwise, print everything in the scope.
430: */
431:
432: macro_open(f, "An");
433: TAILQ_FOREACH_SAFE(nc, &n->childq, child, ncn) {
434: if (nc->node == NODE_PERSONNAME || have_name == 0) {
435: macro_addnode(f, nc, ARG_SPACE);
436: pnode_unlink(nc);
437: }
438: }
439:
440: /*
441: * If there are still unprinted children, end the scope
442: * with a comma. Otherwise, leave the scope open in case
443: * a text node follows that starts with closing punctuation.
444: */
445:
446: if (TAILQ_FIRST(&n->childq) != NULL) {
447: macro_addarg(f, ",", ARG_SPACE);
448: macro_close(f);
449: }
450: }
451:
452: static void
1.74 schwarze 453: pnode_printprologue(struct format *p, struct ptree *tree)
1.7 kristaps 454: {
1.74 schwarze 455: struct pnode *refmeta;
1.7 kristaps 456:
1.74 schwarze 457: refmeta = tree->root == NULL ? NULL :
458: pnode_findfirst(tree->root, NODE_REFMETA);
1.9 kristaps 459:
1.69 schwarze 460: macro_line(p, "Dd $Mdocdate" "$");
1.74 schwarze 461: if (refmeta == NULL) {
1.69 schwarze 462: macro_open(p, "Dt");
463: macro_addarg(p,
1.74 schwarze 464: pnode_getattr_raw(tree->root, ATTRKEY_ID, "UNKNOWN"),
1.72 schwarze 465: ARG_SPACE | ARG_SINGLE | ARG_UPPER);
466: macro_addarg(p, "1", ARG_SPACE);
1.69 schwarze 467: macro_close(p);
1.74 schwarze 468: } else
469: pnode_printrefmeta(p, refmeta);
1.69 schwarze 470: macro_line(p, "Os");
1.43 kristaps 471:
1.74 schwarze 472: if (tree->flags & TREE_EQN) {
1.69 schwarze 473: macro_line(p, "EQ");
1.78 schwarze 474: print_text(p, "delim $$", 0);
1.69 schwarze 475: macro_line(p, "EN");
1.43 kristaps 476: }
1.7 kristaps 477: }
478:
1.42 kristaps 479: /*
480: * We can have multiple <term> elements within a <varlistentry>, which
481: * we should comma-separate as list headers.
482: */
1.13 kristaps 483: static void
1.74 schwarze 484: pnode_printvarlistentry(struct format *p, struct pnode *pn)
1.13 kristaps 485: {
486: struct pnode *pp;
1.42 kristaps 487: int first = 1;
1.13 kristaps 488:
1.69 schwarze 489: macro_open(p, "It");
490: TAILQ_FOREACH(pp, &pn->childq, child) {
491: if (pp->node != NODE_TERM)
492: continue;
493: if ( ! first)
1.72 schwarze 494: macro_addarg(p, ",", 0);
1.69 schwarze 495: pnode_print(p, pp);
496: first = 0;
497: }
498: macro_close(p);
1.13 kristaps 499: TAILQ_FOREACH(pp, &pn->childq, child)
1.69 schwarze 500: if (pp->node != NODE_TERM)
1.13 kristaps 501: pnode_print(p, pp);
1.71 schwarze 502: pnode_unlinksub(pn);
503: }
504:
505: static void
1.74 schwarze 506: pnode_printtitle(struct format *p, struct pnode *pn)
1.71 schwarze 507: {
508: struct pnode *pp, *pq;
509:
510: TAILQ_FOREACH_SAFE(pp, &pn->childq, child, pq) {
511: if (pp->node == NODE_TITLE) {
512: pnode_printpara(p, pp);
513: pnode_print(p, pp);
514: pnode_unlink(pp);
515: }
516: }
1.13 kristaps 517: }
518:
519: static void
1.74 schwarze 520: pnode_printrow(struct format *p, struct pnode *pn)
1.25 kristaps 521: {
522: struct pnode *pp;
523:
1.69 schwarze 524: macro_line(p, "Bl -dash -compact");
1.25 kristaps 525: TAILQ_FOREACH(pp, &pn->childq, child) {
1.69 schwarze 526: macro_line(p, "It");
1.25 kristaps 527: pnode_print(p, pp);
528: }
1.69 schwarze 529: macro_line(p, "El");
1.71 schwarze 530: pnode_unlink(pn);
1.25 kristaps 531: }
532:
533: static void
1.74 schwarze 534: pnode_printtable(struct format *p, struct pnode *pn)
1.16 kristaps 535: {
536: struct pnode *pp;
537:
1.71 schwarze 538: pnode_printtitle(p, pn);
1.69 schwarze 539: macro_line(p, "Bl -ohang");
1.64 schwarze 540: while ((pp = pnode_findfirst(pn, NODE_ROW)) != NULL) {
1.69 schwarze 541: macro_line(p, "It Table Row");
1.25 kristaps 542: pnode_printrow(p, pp);
543: }
1.69 schwarze 544: macro_line(p, "El");
1.71 schwarze 545: pnode_unlinksub(pn);
1.25 kristaps 546: }
547:
548: static void
1.74 schwarze 549: pnode_printlist(struct format *p, struct pnode *pn)
1.25 kristaps 550: {
551: struct pnode *pp;
1.16 kristaps 552:
1.71 schwarze 553: pnode_printtitle(p, pn);
1.69 schwarze 554: macro_argline(p, "Bl",
555: pn->node == NODE_ORDEREDLIST ? "-enum" : "-bullet");
1.16 kristaps 556: TAILQ_FOREACH(pp, &pn->childq, child) {
1.69 schwarze 557: macro_line(p, "It");
1.16 kristaps 558: pnode_print(p, pp);
559: }
1.69 schwarze 560: macro_line(p, "El");
1.71 schwarze 561: pnode_unlinksub(pn);
1.16 kristaps 562: }
563:
564: static void
1.74 schwarze 565: pnode_printvariablelist(struct format *p, struct pnode *pn)
1.13 kristaps 566: {
567: struct pnode *pp;
568:
1.71 schwarze 569: pnode_printtitle(p, pn);
1.69 schwarze 570: macro_line(p, "Bl -tag -width Ds");
571: TAILQ_FOREACH(pp, &pn->childq, child) {
572: if (pp->node == NODE_VARLISTENTRY)
1.13 kristaps 573: pnode_print(p, pp);
1.69 schwarze 574: else
1.72 schwarze 575: macro_nodeline(p, "It", pp, 0);
1.69 schwarze 576: }
577: macro_line(p, "El");
1.71 schwarze 578: pnode_unlinksub(pn);
1.13 kristaps 579: }
580:
1.1 kristaps 581: /*
582: * Print a parsed node (or ignore it--whatever).
583: * This is a recursive function.
1.23 kristaps 584: * FIXME: if we're in a literal context (<screen> or <programlisting> or
585: * whatever), don't print inline macros.
1.1 kristaps 586: */
587: static void
1.74 schwarze 588: pnode_print(struct format *p, struct pnode *pn)
1.1 kristaps 589: {
590: struct pnode *pp;
1.59 schwarze 591: const char *ccp;
1.1 kristaps 592: char *cp;
1.69 schwarze 593: int last;
594: enum linestate sv;
1.1 kristaps 595:
1.64 schwarze 596: if (pn == NULL)
1.1 kristaps 597: return;
598:
1.69 schwarze 599: sv = p->linestate;
1.1 kristaps 600:
601: switch (pn->node) {
1.62 schwarze 602: case NODE_APPLICATION:
1.69 schwarze 603: macro_open(p, "Nm");
1.27 kristaps 604: break;
1.62 schwarze 605: case NODE_ARG:
1.10 kristaps 606: pnode_printarg(p, pn);
1.4 kristaps 607: break;
1.62 schwarze 608: case NODE_AUTHOR:
1.78 schwarze 609: pnode_printauthor(p, pn);
1.50 schwarze 610: break;
1.62 schwarze 611: case NODE_AUTHORGROUP:
1.69 schwarze 612: macro_line(p, "An -split");
1.50 schwarze 613: break;
1.62 schwarze 614: case NODE_BOOKINFO:
1.69 schwarze 615: macro_line(p, "Sh NAME");
1.50 schwarze 616: break;
1.62 schwarze 617: case NODE_CITEREFENTRY:
1.1 kristaps 618: pnode_printciterefentry(p, pn);
619: break;
1.68 schwarze 620: case NODE_CITETITLE:
1.69 schwarze 621: macro_open(p, "%T");
1.68 schwarze 622: break;
1.62 schwarze 623: case NODE_CODE:
1.69 schwarze 624: macro_open(p, "Li");
1.4 kristaps 625: break;
1.62 schwarze 626: case NODE_COMMAND:
1.69 schwarze 627: macro_open(p, "Nm");
1.13 kristaps 628: break;
1.62 schwarze 629: case NODE_CONSTANT:
1.69 schwarze 630: macro_open(p, "Dv");
1.33 kristaps 631: break;
1.62 schwarze 632: case NODE_EDITOR:
1.78 schwarze 633: print_text(p, "editor:", ARG_SPACE);
1.69 schwarze 634: macro_open(p, "An");
1.50 schwarze 635: break;
1.65 schwarze 636: case NODE_EMAIL:
1.69 schwarze 637: macro_open(p, "Aq Mt");
1.65 schwarze 638: break;
1.62 schwarze 639: case NODE_EMPHASIS:
640: case NODE_FIRSTTERM:
1.69 schwarze 641: macro_open(p, "Em");
1.1 kristaps 642: break;
1.62 schwarze 643: case NODE_ENVAR:
1.69 schwarze 644: macro_open(p, "Ev");
1.79 ! schwarze 645: break;
! 646: case NODE_ESCAPE:
! 647: if (p->linestate == LINE_NEW)
! 648: p->linestate = LINE_TEXT;
! 649: else
! 650: putchar(' ');
! 651: fputs(pn->b, stdout);
1.21 kristaps 652: break;
1.62 schwarze 653: case NODE_FILENAME:
1.69 schwarze 654: macro_open(p, "Pa");
1.17 kristaps 655: break;
1.62 schwarze 656: case NODE_FUNCTION:
1.69 schwarze 657: macro_open(p, "Fn");
1.3 kristaps 658: break;
1.62 schwarze 659: case NODE_FUNCPROTOTYPE:
1.3 kristaps 660: pnode_printfuncprototype(p, pn);
661: break;
1.62 schwarze 662: case NODE_FUNCSYNOPSISINFO:
1.69 schwarze 663: macro_open(p, "Fd");
1.16 kristaps 664: break;
1.62 schwarze 665: case NODE_INFORMALEQUATION:
1.69 schwarze 666: macro_line(p, "EQ");
1.43 kristaps 667: break;
1.62 schwarze 668: case NODE_INLINEEQUATION:
1.69 schwarze 669: if (p->linestate == LINE_NEW)
670: p->linestate = LINE_TEXT;
671: putchar('$');
1.43 kristaps 672: break;
1.62 schwarze 673: case NODE_ITEMIZEDLIST:
1.25 kristaps 674: pnode_printlist(p, pn);
1.24 kristaps 675: break;
1.62 schwarze 676: case NODE_GROUP:
1.24 kristaps 677: pnode_printgroup(p, pn);
1.10 kristaps 678: break;
1.67 schwarze 679: case NODE_KEYSYM:
1.69 schwarze 680: macro_open(p, "Sy");
1.67 schwarze 681: break;
1.62 schwarze 682: case NODE_LEGALNOTICE:
1.69 schwarze 683: macro_line(p, "Sh LEGAL NOTICE");
1.50 schwarze 684: break;
1.62 schwarze 685: case NODE_LINK:
1.59 schwarze 686: ccp = pnode_getattr_raw(pn, ATTRKEY_LINKEND, NULL);
1.64 schwarze 687: if (ccp == NULL)
1.58 schwarze 688: break;
1.69 schwarze 689: macro_argline(p, "Sx", ccp);
1.58 schwarze 690: return;
1.62 schwarze 691: case NODE_LITERAL:
1.69 schwarze 692: macro_open(p, "Li");
1.19 kristaps 693: break;
1.62 schwarze 694: case NODE_LITERALLAYOUT:
1.69 schwarze 695: macro_argline(p, "Bd", pnode_getattr(pn, ATTRKEY_CLASS) ==
1.66 schwarze 696: ATTRVAL_MONOSPACED ? "-literal" : "-unfilled");
1.60 schwarze 697: break;
1.62 schwarze 698: case NODE_MML_MFENCED:
1.41 kristaps 699: pnode_printmathfenced(p, pn);
1.40 kristaps 700: break;
1.62 schwarze 701: case NODE_MML_MROW:
702: case NODE_MML_MI:
703: case NODE_MML_MN:
704: case NODE_MML_MO:
1.43 kristaps 705: if (TAILQ_EMPTY(&pn->childq))
706: break;
707: fputs(" { ", stdout);
1.40 kristaps 708: break;
1.62 schwarze 709: case NODE_MML_MFRAC:
710: case NODE_MML_MSUB:
711: case NODE_MML_MSUP:
1.40 kristaps 712: pnode_printmath(p, pn);
713: break;
1.62 schwarze 714: case NODE_OPTION:
1.69 schwarze 715: macro_open(p, "Fl");
1.1 kristaps 716: break;
1.62 schwarze 717: case NODE_ORDEREDLIST:
1.25 kristaps 718: pnode_printlist(p, pn);
719: break;
1.62 schwarze 720: case NODE_PARA:
1.54 schwarze 721: pnode_printpara(p, pn);
1.3 kristaps 722: break;
1.62 schwarze 723: case NODE_PARAMETER:
1.72 schwarze 724: macro_nodeline(p, "Fa", pn, ARG_SINGLE);
1.4 kristaps 725: pnode_unlinksub(pn);
1.1 kristaps 726: break;
1.62 schwarze 727: case NODE_QUOTE:
1.69 schwarze 728: macro_open(p, "Qo");
1.28 kristaps 729: break;
1.62 schwarze 730: case NODE_PROGRAMLISTING:
731: case NODE_SCREEN:
1.69 schwarze 732: macro_line(p, "Bd -literal");
1.15 kristaps 733: break;
1.62 schwarze 734: case NODE_REFENTRYINFO:
1.15 kristaps 735: /* Suppress. */
736: pnode_unlinksub(pn);
1.1 kristaps 737: break;
1.62 schwarze 738: case NODE_REFMETA:
1.7 kristaps 739: abort();
1.1 kristaps 740: break;
1.62 schwarze 741: case NODE_REFNAME:
1.10 kristaps 742: /* Suppress non-text children... */
1.70 schwarze 743: macro_open(p, "Nm");
1.72 schwarze 744: macro_addnode(p, pn, ARG_SPACE | ARG_SINGLE);
1.4 kristaps 745: pnode_unlinksub(pn);
1.10 kristaps 746: break;
1.62 schwarze 747: case NODE_REFNAMEDIV:
1.69 schwarze 748: macro_line(p, "Sh NAME");
1.1 kristaps 749: break;
1.62 schwarze 750: case NODE_REFPURPOSE:
1.69 schwarze 751: macro_open(p, "Nd");
1.10 kristaps 752: break;
1.62 schwarze 753: case NODE_REFSYNOPSISDIV:
1.6 kristaps 754: pnode_printrefsynopsisdiv(p, pn);
1.1 kristaps 755: break;
1.62 schwarze 756: case NODE_PREFACE:
757: case NODE_SECTION:
758: case NODE_NOTE:
759: case NODE_TIP:
760: case NODE_CAUTION:
761: case NODE_WARNING:
1.1 kristaps 762: pnode_printrefsect(p, pn);
763: break;
1.62 schwarze 764: case NODE_REPLACEABLE:
1.69 schwarze 765: macro_open(p, "Ar");
1.13 kristaps 766: break;
1.62 schwarze 767: case NODE_SBR:
1.69 schwarze 768: macro_line(p, "br");
1.19 kristaps 769: break;
1.62 schwarze 770: case NODE_SGMLTAG:
1.69 schwarze 771: macro_open(p, "Li");
1.30 kristaps 772: break;
1.62 schwarze 773: case NODE_STRUCTNAME:
1.69 schwarze 774: macro_open(p, "Vt");
1.25 kristaps 775: break;
1.62 schwarze 776: case NODE_TABLE:
777: case NODE_INFORMALTABLE:
1.25 kristaps 778: pnode_printtable(p, pn);
1.10 kristaps 779: break;
1.62 schwarze 780: case NODE_TEXT:
1.72 schwarze 781: if (pn->bsz == 0) {
1.37 kristaps 782: assert(pn->real != pn->b);
783: break;
784: }
1.69 schwarze 785: if (p->linestate == LINE_NEW)
786: p->linestate = LINE_TEXT;
787: else
788: putchar(' ');
1.37 kristaps 789:
1.1 kristaps 790: /*
791: * Output all characters, squeezing out whitespace
1.44 schwarze 792: * between newlines.
1.1 kristaps 793: * XXX: all whitespace, including tabs (?).
794: * Remember to escape control characters and escapes.
795: */
1.72 schwarze 796: cp = pn->b;
1.37 kristaps 797:
1.20 kristaps 798: /*
799: * There's often a superfluous "-" in its <option> tags
800: * before the actual flags themselves.
801: * "Fl" does this for us, so remove it.
802: */
1.64 schwarze 803: if (pn->parent != NULL &&
804: pn->parent->node == NODE_OPTION &&
805: *cp == '-')
1.20 kristaps 806: cp++;
1.64 schwarze 807: for (last = '\n'; *cp != '\0'; ) {
808: if (last == '\n') {
1.1 kristaps 809: /* Consume all whitespace. */
1.46 schwarze 810: if (isspace((unsigned char)*cp)) {
811: while (isspace((unsigned char)*cp))
1.1 kristaps 812: cp++;
813: continue;
1.64 schwarze 814: } else if (*cp == '\'' || *cp == '.')
1.1 kristaps 815: fputs("\\&", stdout);
816: }
817: putchar(last = *cp++);
818: /* If we're a character escape, escape us. */
1.64 schwarze 819: if (last == '\\')
1.1 kristaps 820: putchar('e');
821: }
822: break;
1.62 schwarze 823: case NODE_TITLE:
1.69 schwarze 824: if (pn->parent->node == NODE_BOOKINFO)
825: macro_open(p, "Nd");
1.50 schwarze 826: break;
1.62 schwarze 827: case NODE_TYPE:
1.69 schwarze 828: macro_open(p, "Vt");
1.39 kristaps 829: break;
1.62 schwarze 830: case NODE_USERINPUT:
1.69 schwarze 831: macro_open(p, "Li");
1.26 kristaps 832: break;
1.62 schwarze 833: case NODE_VARIABLELIST:
1.13 kristaps 834: pnode_printvariablelist(p, pn);
835: break;
1.62 schwarze 836: case NODE_VARLISTENTRY:
1.13 kristaps 837: pnode_printvarlistentry(p, pn);
838: break;
1.62 schwarze 839: case NODE_VARNAME:
1.69 schwarze 840: macro_open(p, "Va");
1.23 kristaps 841: break;
1.1 kristaps 842: default:
843: break;
844: }
845:
846: TAILQ_FOREACH(pp, &pn->childq, child)
847: pnode_print(p, pp);
848:
849: switch (pn->node) {
1.62 schwarze 850: case NODE_INFORMALEQUATION:
1.69 schwarze 851: macro_line(p, "EN");
1.40 kristaps 852: break;
1.62 schwarze 853: case NODE_INLINEEQUATION:
1.43 kristaps 854: fputs("$ ", stdout);
1.69 schwarze 855: p->linestate = sv;
1.43 kristaps 856: break;
1.62 schwarze 857: case NODE_MML_MROW:
858: case NODE_MML_MI:
859: case NODE_MML_MN:
860: case NODE_MML_MO:
1.43 kristaps 861: if (TAILQ_EMPTY(&pn->childq))
862: break;
863: fputs(" } ", stdout);
1.40 kristaps 864: break;
1.62 schwarze 865: case NODE_APPLICATION:
866: case NODE_ARG:
867: case NODE_AUTHOR:
868: case NODE_CITEREFENTRY:
1.68 schwarze 869: case NODE_CITETITLE:
1.62 schwarze 870: case NODE_CODE:
871: case NODE_COMMAND:
872: case NODE_CONSTANT:
873: case NODE_EDITOR:
1.65 schwarze 874: case NODE_EMAIL:
1.62 schwarze 875: case NODE_EMPHASIS:
876: case NODE_ENVAR:
877: case NODE_FILENAME:
878: case NODE_FIRSTTERM:
879: case NODE_FUNCTION:
880: case NODE_FUNCSYNOPSISINFO:
1.67 schwarze 881: case NODE_KEYSYM:
1.62 schwarze 882: case NODE_LITERAL:
883: case NODE_OPTION:
884: case NODE_PARAMETER:
885: case NODE_REPLACEABLE:
886: case NODE_REFPURPOSE:
887: case NODE_SGMLTAG:
888: case NODE_STRUCTNAME:
889: case NODE_TYPE:
890: case NODE_USERINPUT:
891: case NODE_VARNAME:
1.69 schwarze 892: if (sv != LINE_MACRO && p->linestate == LINE_MACRO)
893: macro_closepunct(p, pn);
1.28 kristaps 894: break;
1.62 schwarze 895: case NODE_QUOTE:
1.69 schwarze 896: if (sv == LINE_NEW)
897: macro_close(p);
898: sv = p->linestate;
899: macro_open(p, "Qc");
900: if (sv == LINE_NEW)
901: macro_close(p);
1.10 kristaps 902: break;
1.62 schwarze 903: case NODE_REFNAME:
1.12 kristaps 904: /*
905: * If we're in the NAME macro and we have multiple
906: * <refname> macros in sequence, then print out a
907: * trailing comma before the newline.
908: */
1.64 schwarze 909: if (pn->parent != NULL &&
910: pn->parent->node == NODE_REFNAMEDIV &&
911: TAILQ_NEXT(pn, child) != NULL &&
912: TAILQ_NEXT(pn, child)->node == NODE_REFNAME)
1.72 schwarze 913: macro_addarg(p, ",", ARG_SPACE);
1.69 schwarze 914: if (sv == LINE_NEW)
915: macro_close(p);
1.52 schwarze 916: break;
1.62 schwarze 917: case NODE_PREFACE:
918: case NODE_SECTION:
919: case NODE_NOTE:
920: case NODE_TIP:
921: case NODE_CAUTION:
922: case NODE_WARNING:
1.52 schwarze 923: p->level--;
1.12 kristaps 924: break;
1.62 schwarze 925: case NODE_LITERALLAYOUT:
926: case NODE_PROGRAMLISTING:
927: case NODE_SCREEN:
1.69 schwarze 928: macro_line(p, "Ed");
1.50 schwarze 929: break;
1.62 schwarze 930: case NODE_TITLE:
1.69 schwarze 931: if (pn->parent->node == NODE_BOOKINFO)
932: macro_line(p, "Sh AUTHORS");
1.1 kristaps 933: break;
934: default:
935: break;
936: }
937: }
938:
1.74 schwarze 939: void
940: ptree_print(struct ptree *tree)
941: {
942: struct format formatter;
1.1 kristaps 943:
1.74 schwarze 944: formatter.level = 0;
945: formatter.linestate = LINE_NEW;
946: pnode_printprologue(&formatter, tree);
947: pnode_print(&formatter, tree->root);
948: if (formatter.linestate != LINE_NEW)
949: putchar('\n');
1.1 kristaps 950: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to docbook2mdoc.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / docbook2mdoc