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