Annotation of docbook2mdoc/docbook2mdoc.c, Revision 1.133
1.133 ! schwarze 1: /* $Id: docbook2mdoc.c,v 1.132 2019/04/21 14:48:11 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>
1.103 schwarze 22: #include <string.h>
1.1 kristaps 23:
1.74 schwarze 24: #include "node.h"
1.75 schwarze 25: #include "macro.h"
1.74 schwarze 26: #include "format.h"
27:
28: /*
29: * The implementation of the mdoc(7) formatter.
30: */
1.12 kristaps 31:
1.74 schwarze 32: static void pnode_print(struct format *, struct pnode *);
1.119 schwarze 33: static void pnode_printrefentry(struct format *, struct pnode *);
1.25 kristaps 34:
1.37 kristaps 35:
1.54 schwarze 36: static void
1.93 schwarze 37: pnode_printtext(struct format *f, struct pnode *n)
38: {
1.94 schwarze 39: struct pnode *nn;
1.93 schwarze 40: char *cp;
1.103 schwarze 41: int accept_arg;
1.93 schwarze 42:
1.103 schwarze 43: cp = n->b;
44: accept_arg = f->flags & FMT_ARG;
1.107 schwarze 45: if (f->linestate == LINE_MACRO && !n->spc && !accept_arg) {
1.103 schwarze 46: for (;;) {
47: if (*cp == '\0')
48: return;
49: if (strchr("!),.:;?]", *cp) == NULL)
50: break;
51: printf(" %c", *cp++);
52: }
53: if (isspace((unsigned char)*cp)) {
54: while (isspace((unsigned char)*cp))
55: cp++;
56: macro_close(f);
57: } else {
58: fputs(" Ns", stdout);
59: f->flags &= FMT_IMPL;
60: accept_arg = 1;
61: }
1.94 schwarze 62: }
1.103 schwarze 63: if (f->linestate == LINE_MACRO && !accept_arg &&
64: (f->flags & (FMT_CHILD | FMT_IMPL)) == 0)
65: macro_close(f);
1.94 schwarze 66:
67: /*
68: * Text preceding a macro without intervening whitespace
69: * requires a .Pf macro.
70: * Set the spacing flag to avoid a redundant .Ns macro.
71: */
72:
73: if (f->linestate != LINE_MACRO &&
1.113 schwarze 74: (nn = TAILQ_NEXT(n, child)) != NULL && nn->spc == 0) {
75: switch (pnode_class(nn->node)) {
76: case CLASS_LINE:
77: case CLASS_ENCL:
78: macro_open(f, "Pf");
79: accept_arg = 1;
80: f->flags |= FMT_CHILD;
81: nn->spc = 1;
82: break;
83: default:
84: break;
85: }
1.93 schwarze 86: }
87:
1.103 schwarze 88: switch (f->linestate) {
1.107 schwarze 89: case LINE_NEW:
90: break;
1.103 schwarze 91: case LINE_TEXT:
1.105 schwarze 92: if (n->spc) {
1.107 schwarze 93: if (n->node == NODE_TEXT)
94: macro_close(f);
95: else
96: putchar(' ');
1.105 schwarze 97: }
1.103 schwarze 98: break;
99: case LINE_MACRO:
1.107 schwarze 100: if (accept_arg)
1.93 schwarze 101: putchar(' ');
1.107 schwarze 102: else
103: macro_close(f);
1.103 schwarze 104: break;
1.93 schwarze 105: }
106:
107: if (n->node == NODE_ESCAPE) {
108: fputs(n->b, stdout);
1.107 schwarze 109: if (f->linestate == LINE_NEW)
110: f->linestate = LINE_TEXT;
1.93 schwarze 111: return;
112: }
113:
114: /*
115: * Remove the prefix '-' from <option> elements
116: * because the arguments of .Fl macros do not need it.
117: */
118:
119: if (n->parent != NULL && n->parent->node == NODE_OPTION && *cp == '-')
120: cp++;
121:
1.107 schwarze 122: if (f->linestate == LINE_MACRO)
123: macro_addarg(f, cp, 0);
124: else
125: print_text(f, cp, 0);
1.93 schwarze 126: }
127:
128: static void
1.126 schwarze 129: pnode_printimagedata(struct format *f, struct pnode *n)
130: {
131: const char *cp;
132:
133: if ((cp = pnode_getattr_raw(n, ATTRKEY_FILEREF, NULL)) == NULL)
134: cp = pnode_getattr_raw(n, ATTRKEY_ENTITYREF, NULL);
135: if (cp != NULL) {
136: print_text(f, "[image:", ARG_SPACE);
137: print_text(f, cp, ARG_SPACE);
138: print_text(f, "]", 0);
139: } else
140: print_text(f, "[image]", ARG_SPACE);
141: }
142:
143: static void
1.110 schwarze 144: pnode_printrefnamediv(struct format *f, struct pnode *n)
145: {
146: struct pnode *nc, *nn;
147: int comma;
148:
1.130 schwarze 149: f->parastate = PARA_HAVE;
1.110 schwarze 150: macro_line(f, "Sh NAME");
1.130 schwarze 151: f->parastate = PARA_HAVE;
1.110 schwarze 152: comma = 0;
153: TAILQ_FOREACH_SAFE(nc, &n->childq, child, nn) {
154: if (nc->node != NODE_REFNAME)
155: continue;
156: if (comma)
157: macro_addarg(f, ",", ARG_SPACE);
158: macro_open(f, "Nm");
159: macro_addnode(f, nc, ARG_SPACE);
160: pnode_unlink(nc);
161: comma = 1;
162: }
163: macro_close(f);
164: }
165:
1.37 kristaps 166: /*
1.10 kristaps 167: * If the SYNOPSIS macro has a superfluous title, kill it.
1.8 kristaps 168: */
1.1 kristaps 169: static void
1.101 schwarze 170: pnode_printrefsynopsisdiv(struct format *f, struct pnode *n)
1.6 kristaps 171: {
1.101 schwarze 172: struct pnode *nc, *nn;
1.6 kristaps 173:
1.101 schwarze 174: TAILQ_FOREACH_SAFE(nc, &n->childq, child, nn)
175: if (nc->node == NODE_TITLE)
176: pnode_unlink(nc);
1.71 schwarze 177:
1.130 schwarze 178: f->parastate = PARA_HAVE;
1.101 schwarze 179: macro_line(f, "Sh SYNOPSIS");
1.130 schwarze 180: f->parastate = PARA_HAVE;
1.6 kristaps 181: }
182:
1.8 kristaps 183: /*
184: * Start a hopefully-named `Sh' section.
185: */
1.6 kristaps 186: static void
1.119 schwarze 187: pnode_printsection(struct format *f, struct pnode *n)
1.1 kristaps 188: {
1.115 schwarze 189: struct pnode *nc, *ncc;
1.52 schwarze 190: const char *title;
191: int flags, level;
192:
1.119 schwarze 193: if (n->parent == NULL) {
194: pnode_printrefentry(f, n);
1.56 schwarze 195: return;
1.119 schwarze 196: }
1.56 schwarze 197:
1.101 schwarze 198: level = ++f->level;
1.72 schwarze 199: flags = ARG_SPACE;
1.121 schwarze 200: switch (n->node) {
201: case NODE_PREFACE:
202: case NODE_SECTION:
203: case NODE_APPENDIX:
204: if (level == 1)
205: flags |= ARG_UPPER;
206: break;
207: case NODE_SIMPLESECT:
208: case NODE_LEGALNOTICE:
209: if (level < 2)
210: level = 2;
211: break;
212: default:
213: if (level < 3)
1.52 schwarze 214: level = 3;
1.121 schwarze 215: break;
1.52 schwarze 216: }
1.1 kristaps 217:
1.101 schwarze 218: TAILQ_FOREACH(nc, &n->childq, child)
219: if (nc->node == NODE_TITLE)
1.1 kristaps 220: break;
221:
1.101 schwarze 222: if (nc == NULL) {
223: switch (n->node) {
1.62 schwarze 224: case NODE_PREFACE:
1.52 schwarze 225: title = "Preface";
226: break;
1.100 schwarze 227: case NODE_APPENDIX:
228: title = "Appendix";
229: break;
230: case NODE_LEGALNOTICE:
231: title = "Legal Notice";
232: break;
1.62 schwarze 233: case NODE_CAUTION:
1.52 schwarze 234: title = "Caution";
235: break;
1.62 schwarze 236: case NODE_NOTE:
1.52 schwarze 237: title = "Note";
238: break;
1.62 schwarze 239: case NODE_TIP:
1.52 schwarze 240: title = "Tip";
241: break;
1.62 schwarze 242: case NODE_WARNING:
1.52 schwarze 243: title = "Warning";
244: break;
245: default:
246: title = "Unknown";
247: break;
248: }
249: }
250:
251: switch (level) {
1.62 schwarze 252: case 1:
1.101 schwarze 253: macro_close(f);
1.130 schwarze 254: f->parastate = PARA_HAVE;
1.101 schwarze 255: macro_open(f, "Sh");
1.29 kristaps 256: break;
1.62 schwarze 257: case 2:
1.101 schwarze 258: macro_close(f);
1.130 schwarze 259: f->parastate = PARA_HAVE;
1.101 schwarze 260: macro_open(f, "Ss");
1.29 kristaps 261: break;
1.52 schwarze 262: default:
1.130 schwarze 263: if (f->parastate == PARA_MID)
264: f->parastate = PARA_WANT;
1.101 schwarze 265: macro_open(f, "Sy");
1.29 kristaps 266: break;
267: }
1.20 kristaps 268:
1.115 schwarze 269: if (nc != NULL)
1.101 schwarze 270: macro_addnode(f, nc, flags);
1.115 schwarze 271: else
1.101 schwarze 272: macro_addarg(f, title, flags | ARG_QUOTED);
273: macro_close(f);
1.115 schwarze 274:
275: /*
276: * DocBook has no equivalent for -split mode,
277: * so just switch the default in the AUTHORS section.
278: */
279:
280: if (nc != NULL) {
1.130 schwarze 281: if (level == 1 &&
282: (ncc = TAILQ_FIRST(&nc->childq)) != NULL &&
283: ncc->node == NODE_TEXT &&
1.115 schwarze 284: strcasecmp(ncc->b, "AUTHORS") == 0)
285: macro_line(f, "An -nosplit");
286: pnode_unlink(nc);
287: }
1.130 schwarze 288: f->parastate = level > 2 ? PARA_WANT : PARA_HAVE;
1.1 kristaps 289: }
290:
1.8 kristaps 291: /*
292: * Start a reference, extracting the title and volume.
293: */
1.1 kristaps 294: static void
1.101 schwarze 295: pnode_printciterefentry(struct format *f, struct pnode *n)
1.1 kristaps 296: {
1.101 schwarze 297: struct pnode *nc, *title, *manvol;
1.1 kristaps 298:
299: title = manvol = NULL;
1.101 schwarze 300: TAILQ_FOREACH(nc, &n->childq, child) {
301: if (nc->node == NODE_MANVOLNUM)
302: manvol = nc;
303: else if (nc->node == NODE_REFENTRYTITLE)
304: title = nc;
1.69 schwarze 305: }
1.101 schwarze 306: macro_open(f, "Xr");
1.69 schwarze 307: if (title == NULL)
1.101 schwarze 308: macro_addarg(f, "unknown", ARG_SPACE);
1.69 schwarze 309: else
1.101 schwarze 310: macro_addnode(f, title, ARG_SPACE | ARG_SINGLE);
1.69 schwarze 311: if (manvol == NULL)
1.101 schwarze 312: macro_addarg(f, "1", ARG_SPACE);
1.64 schwarze 313: else
1.101 schwarze 314: macro_addnode(f, manvol, ARG_SPACE | ARG_SINGLE);
315: pnode_unlinksub(n);
1.1 kristaps 316: }
317:
1.40 kristaps 318: /*
1.41 kristaps 319: * The <mml:mfenced> node is a little peculiar.
320: * First, it can have arbitrary open and closing tokens, which default
321: * to parentheses.
322: * Second, >1 arguments are separated by commas.
323: */
324: static void
1.101 schwarze 325: pnode_printmathfenced(struct format *f, struct pnode *n)
1.41 kristaps 326: {
1.101 schwarze 327: struct pnode *nc;
1.41 kristaps 328:
1.101 schwarze 329: printf("left %s ", pnode_getattr_raw(n, ATTRKEY_OPEN, "("));
1.41 kristaps 330:
1.101 schwarze 331: nc = TAILQ_FIRST(&n->childq);
332: pnode_print(f, nc);
1.41 kristaps 333:
1.101 schwarze 334: while ((nc = TAILQ_NEXT(nc, child)) != NULL) {
1.41 kristaps 335: putchar(',');
1.101 schwarze 336: pnode_print(f, nc);
1.41 kristaps 337: }
1.101 schwarze 338: printf("right %s ", pnode_getattr_raw(n, ATTRKEY_CLOSE, ")"));
339: pnode_unlinksub(n);
1.41 kristaps 340: }
341:
342: /*
1.40 kristaps 343: * These math nodes require special handling because they have infix
344: * syntax, instead of the usual prefix or prefix.
345: * So we need to break up the first and second child node with a
346: * particular eqn(7) word.
347: */
348: static void
1.101 schwarze 349: pnode_printmath(struct format *f, struct pnode *n)
1.40 kristaps 350: {
1.101 schwarze 351: struct pnode *nc;
1.40 kristaps 352:
1.101 schwarze 353: nc = TAILQ_FIRST(&n->childq);
354: pnode_print(f, nc);
1.40 kristaps 355:
1.101 schwarze 356: switch (n->node) {
1.62 schwarze 357: case NODE_MML_MSUP:
1.42 kristaps 358: fputs(" sup ", stdout);
1.40 kristaps 359: break;
1.62 schwarze 360: case NODE_MML_MFRAC:
1.42 kristaps 361: fputs(" over ", stdout);
1.40 kristaps 362: break;
1.62 schwarze 363: case NODE_MML_MSUB:
1.42 kristaps 364: fputs(" sub ", stdout);
1.40 kristaps 365: break;
366: default:
367: break;
368: }
369:
1.101 schwarze 370: nc = TAILQ_NEXT(nc, child);
371: pnode_print(f, nc);
372: pnode_unlinksub(n);
1.40 kristaps 373: }
374:
1.3 kristaps 375: static void
1.101 schwarze 376: pnode_printfuncprototype(struct format *f, struct pnode *n)
1.3 kristaps 377: {
1.132 schwarze 378: struct pnode *fdef, *ftype, *nc, *nn;
1.3 kristaps 379:
1.132 schwarze 380: /*
381: * Extract <funcdef> child and ignore <void> child.
382: * Leave other children in place, to be treated as parameters.
383: */
384:
385: fdef = NULL;
386: TAILQ_FOREACH_SAFE(nc, &n->childq, child, nn) {
387: switch (nc->node) {
388: case NODE_FUNCDEF:
389: if (fdef == NULL) {
390: fdef = nc;
391: TAILQ_REMOVE(&n->childq, nc, child);
392: nc->parent = NULL;
393: }
394: break;
395: case NODE_VOID:
396: pnode_unlink(nc);
1.3 kristaps 397: break;
1.132 schwarze 398: default:
399: break;
400: }
401: }
1.3 kristaps 402:
1.132 schwarze 403: /*
404: * If no children are left, the function is void; use .Fn.
405: * Otherwise, use .Fo.
406: */
407:
408: nc = TAILQ_FIRST(&n->childq);
1.86 schwarze 409: if (fdef != NULL) {
1.132 schwarze 410: ftype = TAILQ_FIRST(&fdef->childq);
411: if (ftype != NULL && ftype->node == NODE_TEXT) {
412: macro_argline(f, "Ft", ftype->b);
413: pnode_unlink(ftype);
414: }
415: if (nc == NULL) {
416: macro_open(f, "Fn");
417: macro_addnode(f, fdef, ARG_SPACE | ARG_SINGLE);
418: macro_addarg(f, "void", ARG_SPACE);
419: macro_close(f);
420: } else
421: macro_nodeline(f, "Fo", fdef, ARG_SINGLE);
1.86 schwarze 422: pnode_unlink(fdef);
1.132 schwarze 423: } else if (nc == NULL)
424: macro_line(f, "Fn UNKNOWN void");
425: else
1.101 schwarze 426: macro_line(f, "Fo UNKNOWN");
1.3 kristaps 427:
1.132 schwarze 428: if (nc == NULL)
429: return;
430:
431: while (nc != NULL) {
1.101 schwarze 432: macro_nodeline(f, "Fa", nc, ARG_SINGLE);
1.132 schwarze 433: pnode_unlink(nc);
434: nc = TAILQ_FIRST(&n->childq);
435: }
1.101 schwarze 436: macro_line(f, "Fc");
1.3 kristaps 437: }
438:
1.44 schwarze 439: /*
1.10 kristaps 440: * The <arg> element is more complicated than it should be because text
441: * nodes are treated like ".Ar foo", but non-text nodes need to be
442: * re-sent into the printer (i.e., without the preceding ".Ar").
1.12 kristaps 443: * This also handles the case of "repetition" (or in other words, the
444: * ellipsis following an argument) and optionality.
1.10 kristaps 445: */
1.4 kristaps 446: static void
1.101 schwarze 447: pnode_printarg(struct format *f, struct pnode *n)
1.4 kristaps 448: {
1.101 schwarze 449: struct pnode *nc;
450: struct pattr *a;
1.103 schwarze 451: int isop, isrep, was_impl;
1.12 kristaps 452:
453: isop = 1;
1.103 schwarze 454: isrep = was_impl = 0;
1.101 schwarze 455: TAILQ_FOREACH(a, &n->attrq, child) {
456: if (a->key == ATTRKEY_CHOICE &&
457: (a->val == ATTRVAL_PLAIN || a->val == ATTRVAL_REQ))
1.12 kristaps 458: isop = 0;
1.101 schwarze 459: else if (a->key == ATTRKEY_REP && a->val == ATTRVAL_REPEAT)
1.12 kristaps 460: isrep = 1;
461: }
1.103 schwarze 462: if (isop) {
463: if (f->flags & FMT_IMPL) {
464: was_impl = 1;
465: macro_open(f, "Oo");
466: } else {
467: macro_open(f, "Op");
468: f->flags |= FMT_IMPL;
469: }
470: }
1.101 schwarze 471: TAILQ_FOREACH(nc, &n->childq, child) {
472: if (nc->node == NODE_TEXT)
473: macro_open(f, "Ar");
474: pnode_print(f, nc);
1.10 kristaps 475: }
1.117 schwarze 476: if (isrep && f->linestate == LINE_MACRO)
477: macro_addarg(f, "...", ARG_SPACE);
1.103 schwarze 478: if (isop) {
479: if (was_impl)
480: macro_open(f, "Oc");
481: else
482: f->flags &= ~FMT_IMPL;
483: }
1.101 schwarze 484: pnode_unlinksub(n);
1.4 kristaps 485: }
486:
1.24 kristaps 487: static void
1.101 schwarze 488: pnode_printgroup(struct format *f, struct pnode *n)
1.24 kristaps 489: {
1.117 schwarze 490: struct pnode *nc;
1.101 schwarze 491: struct pattr *a;
1.117 schwarze 492: int bar, isop, isrep, was_impl;
1.24 kristaps 493:
494: isop = 1;
1.117 schwarze 495: isrep = was_impl = 0;
496: TAILQ_FOREACH(a, &n->attrq, child) {
1.101 schwarze 497: if (a->key == ATTRKEY_CHOICE &&
1.117 schwarze 498: (a->val == ATTRVAL_PLAIN || a->val == ATTRVAL_REQ))
1.24 kristaps 499: isop = 0;
1.117 schwarze 500: else if (a->key == ATTRKEY_REP && a->val == ATTRVAL_REPEAT)
501: isrep = 1;
502: }
503: if (isop) {
504: if (f->flags & FMT_IMPL) {
505: was_impl = 1;
506: macro_open(f, "Oo");
507: } else {
508: macro_open(f, "Op");
509: f->flags |= FMT_IMPL;
510: }
511: } else if (isrep) {
512: if (f->flags & FMT_IMPL) {
513: was_impl = 1;
514: macro_open(f, "Bro");
515: } else {
516: macro_open(f, "Brq");
517: f->flags |= FMT_IMPL;
1.24 kristaps 518: }
1.117 schwarze 519: }
520: bar = 0;
1.101 schwarze 521: TAILQ_FOREACH(nc, &n->childq, child) {
1.117 schwarze 522: if (bar && f->linestate == LINE_MACRO)
523: macro_addarg(f, "|", ARG_SPACE);
1.101 schwarze 524: pnode_print(f, nc);
1.117 schwarze 525: bar = 1;
526: }
527: if (isop) {
528: if (was_impl)
529: macro_open(f, "Oc");
530: else
531: f->flags &= ~FMT_IMPL;
532: } else if (isrep) {
533: if (was_impl)
534: macro_open(f, "Brc");
535: else
536: f->flags &= ~FMT_IMPL;
1.24 kristaps 537: }
1.117 schwarze 538: if (isrep && f->linestate == LINE_MACRO)
539: macro_addarg(f, "...", ARG_SPACE);
1.101 schwarze 540: pnode_unlinksub(n);
1.24 kristaps 541: }
542:
1.7 kristaps 543: static void
1.118 schwarze 544: pnode_printsystemitem(struct format *f, struct pnode *n)
545: {
546: switch (pnode_getattr(n, ATTRKEY_CLASS)) {
547: case ATTRVAL_IPADDRESS:
548: break;
549: case ATTRVAL_SYSTEMNAME:
550: macro_open(f, "Pa");
551: break;
552: case ATTRVAL_EVENT:
553: default:
554: macro_open(f, "Sy");
555: break;
556: }
557: }
558:
559: static void
1.78 schwarze 560: pnode_printauthor(struct format *f, struct pnode *n)
561: {
1.101 schwarze 562: struct pnode *nc, *nn;
1.78 schwarze 563: int have_contrib, have_name;
564:
565: /*
566: * Print <contrib> children up front, before the .An scope,
567: * and figure out whether we a name of a person.
568: */
569:
570: have_contrib = have_name = 0;
1.101 schwarze 571: TAILQ_FOREACH_SAFE(nc, &n->childq, child, nn) {
1.78 schwarze 572: switch (nc->node) {
573: case NODE_CONTRIB:
574: if (have_contrib)
575: print_text(f, ",", 0);
576: print_textnode(f, nc);
577: pnode_unlink(nc);
578: have_contrib = 1;
579: break;
580: case NODE_PERSONNAME:
581: have_name = 1;
582: break;
583: default:
584: break;
585: }
586: }
587: if (TAILQ_FIRST(&n->childq) == NULL)
588: return;
589:
590: if (have_contrib)
591: print_text(f, ":", 0);
592:
593: /*
594: * If we have a name, print it in the .An scope and leave
595: * all other content for child handlers, to print after the
596: * scope. Otherwise, print everything in the scope.
597: */
598:
599: macro_open(f, "An");
1.101 schwarze 600: TAILQ_FOREACH_SAFE(nc, &n->childq, child, nn) {
1.78 schwarze 601: if (nc->node == NODE_PERSONNAME || have_name == 0) {
602: macro_addnode(f, nc, ARG_SPACE);
603: pnode_unlink(nc);
604: }
1.80 schwarze 605: }
606:
607: /*
608: * If there is an email address,
609: * print it on the same macro line.
610: */
611:
612: if ((nc = pnode_findfirst(n, NODE_EMAIL)) != NULL) {
1.103 schwarze 613: f->flags |= FMT_CHILD;
1.115 schwarze 614: macro_open(f, "Aq Mt");
615: macro_addnode(f, nc, ARG_SPACE);
1.80 schwarze 616: pnode_unlink(nc);
1.78 schwarze 617: }
618:
619: /*
620: * If there are still unprinted children, end the scope
621: * with a comma. Otherwise, leave the scope open in case
622: * a text node follows that starts with closing punctuation.
623: */
624:
625: if (TAILQ_FIRST(&n->childq) != NULL) {
626: macro_addarg(f, ",", ARG_SPACE);
627: macro_close(f);
628: }
629: }
630:
631: static void
1.129 schwarze 632: pnode_printxref(struct format *f, struct pnode *n)
633: {
634: const char *linkend;
635:
636: linkend = pnode_getattr_raw(n, ATTRKEY_LINKEND, NULL);
637: if (linkend != NULL) {
638: macro_open(f, "Sx");
639: macro_addarg(f, linkend, ARG_SPACE);
640: }
641: }
642:
643: static void
1.96 schwarze 644: pnode_printlink(struct format *f, struct pnode *n)
645: {
1.109 schwarze 646: struct pnode *nc;
1.96 schwarze 647: const char *uri, *text;
648:
649: uri = pnode_getattr_raw(n, ATTRKEY_LINKEND, NULL);
650: if (uri != NULL) {
651: if (TAILQ_FIRST(&n->childq) != NULL) {
1.109 schwarze 652: TAILQ_FOREACH(nc, &n->childq, child)
653: pnode_print(f, nc);
1.96 schwarze 654: text = "";
1.109 schwarze 655: } else if ((text = pnode_getattr_raw(n,
656: ATTRKEY_ENDTERM, NULL)) != NULL) {
657: if (f->linestate == LINE_MACRO && f->flags & FMT_ARG)
658: macro_addarg(f, text, ARG_SPACE);
659: else
1.96 schwarze 660: print_text(f, text, ARG_SPACE);
661: }
1.103 schwarze 662: if (text != NULL) {
1.109 schwarze 663: if (f->flags & FMT_IMPL)
664: macro_open(f, "Po");
665: else {
666: macro_open(f, "Pq");
667: f->flags |= FMT_CHILD;
668: }
1.103 schwarze 669: }
1.96 schwarze 670: macro_open(f, "Sx");
671: macro_addarg(f, uri, ARG_SPACE);
1.109 schwarze 672: if (text != NULL && f->flags & FMT_IMPL)
673: macro_open(f, "Pc");
1.96 schwarze 674: pnode_unlinksub(n);
675: return;
676: }
677: uri = pnode_getattr_raw(n, ATTRKEY_XLINK_HREF, NULL);
678: if (uri == NULL)
679: uri = pnode_getattr_raw(n, ATTRKEY_URL, NULL);
680: if (uri != NULL) {
681: macro_open(f, "Lk");
682: macro_addarg(f, uri, ARG_SPACE | ARG_SINGLE);
683: if (TAILQ_FIRST(&n->childq) != NULL)
684: macro_addnode(f, n, ARG_SPACE | ARG_SINGLE);
685: pnode_unlinksub(n);
1.128 schwarze 686: }
687: }
688:
689: static void
690: pnode_printolink(struct format *f, struct pnode *n)
691: {
692: const char *uri, *ptr, *local;
693:
694: uri = pnode_getattr_raw(n, ATTRKEY_TARGETDOC, NULL);
695: ptr = pnode_getattr_raw(n, ATTRKEY_TARGETPTR, NULL);
696: local = pnode_getattr_raw(n, ATTRKEY_LOCALINFO, NULL);
697: if (uri == NULL) {
698: uri = ptr;
699: ptr = NULL;
700: }
701: if (uri == NULL) {
702: uri = local;
703: local = NULL;
704: }
705: if (uri == NULL)
1.96 schwarze 706: return;
1.128 schwarze 707:
708: macro_open(f, "Lk");
709: macro_addarg(f, uri, ARG_SPACE | ARG_SINGLE);
710: macro_addnode(f, n, ARG_SPACE | ARG_SINGLE);
711: if (ptr != NULL || local != NULL) {
712: macro_close(f);
713: macro_open(f, "Pq");
714: if (ptr != NULL)
715: macro_addarg(f, ptr, ARG_SPACE);
716: if (local != NULL)
717: macro_addarg(f, local, ARG_SPACE);
1.96 schwarze 718: }
1.128 schwarze 719: pnode_unlinksub(n);
1.96 schwarze 720: }
721:
722: static void
1.116 schwarze 723: pnode_printprologue(struct format *f, struct pnode *root)
1.7 kristaps 724: {
1.119 schwarze 725: struct pnode *date, *refmeta, *name, *vol, *descr, *nc, *nn;
1.116 schwarze 726: const char *sname;
1.7 kristaps 727:
1.116 schwarze 728: /* Collect information. */
1.9 kristaps 729:
1.116 schwarze 730: if ((date = pnode_takefirst(root, NODE_PUBDATE)) == NULL)
731: date = pnode_takefirst(root, NODE_DATE);
732:
733: name = vol = NULL;
1.119 schwarze 734: if ((refmeta = pnode_findfirst(root, NODE_REFMETA)) != NULL) {
735: TAILQ_FOREACH_SAFE(nc, &refmeta->childq, child, nn) {
1.116 schwarze 736: switch (nc->node) {
737: case NODE_REFENTRYTITLE:
738: name = nc;
739: break;
740: case NODE_MANVOLNUM:
741: vol = nc;
742: break;
743: default:
1.119 schwarze 744: continue;
1.116 schwarze 745: }
1.119 schwarze 746: TAILQ_REMOVE(&refmeta->childq, nc, child);
1.116 schwarze 747: }
748: }
749:
750: if (pnode_findfirst(root, NODE_REFNAMEDIV) == NULL &&
751: ((nc = pnode_findfirst(root, NODE_BOOKINFO)) != NULL ||
752: (nc = pnode_findfirst(root, NODE_REFENTRYINFO)) != NULL))
753: descr = pnode_takefirst(nc, NODE_TITLE);
754: else
755: descr = NULL;
756:
757: /* Print prologue. */
758:
759: if (date == NULL)
760: macro_line(f, "Dd $Mdocdate" "$");
761: else
762: macro_nodeline(f, "Dd", date, 0);
763:
764: macro_open(f, "Dt");
765: if (name == NULL) {
766: sname = pnode_getattr_raw(root, ATTRKEY_ID, "UNKNOWN");
767: macro_addarg(f, sname, ARG_SPACE | ARG_SINGLE | ARG_UPPER);
768: } else
769: macro_addnode(f, name, ARG_SPACE | ARG_SINGLE | ARG_UPPER);
770: if (vol == NULL)
1.101 schwarze 771: macro_addarg(f, "1", ARG_SPACE);
1.116 schwarze 772: else
773: macro_addnode(f, vol, ARG_SPACE | ARG_SINGLE);
774:
1.101 schwarze 775: macro_line(f, "Os");
1.116 schwarze 776:
777: if (descr != NULL) {
778: macro_line(f, "Sh NAME");
779: if (name == NULL)
780: macro_argline(f, "Nm", sname);
781: else
782: macro_nodeline(f, "Nm", name, ARG_SINGLE);
783: macro_nodeline(f, "Nd", descr, 0);
784: }
785:
786: /* Clean up. */
787:
788: pnode_unlink(date);
1.119 schwarze 789: pnode_unlink(name);
790: pnode_unlink(vol);
1.116 schwarze 791: pnode_unlink(descr);
1.130 schwarze 792: f->parastate = PARA_HAVE;
1.7 kristaps 793: }
794:
1.119 schwarze 795: static void
796: pnode_printrefentry(struct format *f, struct pnode *n)
797: {
798: struct pnode *info, *meta, *nc, *title;
799: struct pnode *match, *later;
800:
801: /* Collect nodes that remained behind when writing the prologue. */
802:
803: meta = NULL;
804: info = pnode_takefirst(n, NODE_BOOKINFO);
805: if (info != NULL && TAILQ_FIRST(&info->childq) == NULL) {
806: pnode_unlink(info);
807: info = NULL;
808: }
809: if (info == NULL) {
810: info = pnode_takefirst(n, NODE_REFENTRYINFO);
811: if (info != NULL && TAILQ_FIRST(&info->childq) == NULL) {
812: pnode_unlink(info);
813: info = NULL;
814: }
815: meta = pnode_takefirst(n, NODE_REFMETA);
816: if (meta != NULL && TAILQ_FIRST(&meta->childq) == NULL) {
817: pnode_unlink(meta);
818: meta = NULL;
819: }
820: }
821: if (info == NULL && meta == NULL)
822: return;
823:
824: /*
825: * Find the best place to put this information.
826: * Use the last existing AUTHORS node, if any.
827: * Otherwise, put it behind all standard sections that
828: * conventionally precede AUTHORS, and also behind any
829: * non-standard sections that follow the last of these,
830: * but before the next standard section.
831: */
832:
833: match = later = NULL;
834: TAILQ_FOREACH(nc, &n->childq, child) {
835: switch (nc->node) {
836: case NODE_REFENTRY:
837: case NODE_REFNAMEDIV:
838: case NODE_REFSYNOPSISDIV:
839: case NODE_PREFACE:
840: later = NULL;
841: continue;
842: case NODE_APPENDIX:
843: case NODE_INDEX:
844: if (later == NULL)
845: later = nc;
846: continue;
847: default:
848: break;
849: }
850: if ((title = pnode_findfirst(nc, NODE_TITLE)) == NULL ||
851: (title = TAILQ_FIRST(&title->childq)) == NULL ||
852: title->node != NODE_TEXT)
853: continue;
854: if (strcasecmp(title->b, "AUTHORS") == 0 ||
855: strcasecmp(title->b, "AUTHOR") == 0)
856: match = nc;
857: else if (strcasecmp(title->b, "NAME") == 0 ||
858: strcasecmp(title->b, "SYNOPSIS") == 0 ||
859: strcasecmp(title->b, "DESCRIPTION") == 0 ||
860: strcasecmp(title->b, "RETURN VALUES") == 0 ||
861: strcasecmp(title->b, "ENVIRONMENT") == 0 ||
862: strcasecmp(title->b, "FILES") == 0 ||
863: strcasecmp(title->b, "EXIT STATUS") == 0 ||
864: strcasecmp(title->b, "EXAMPLES") == 0 ||
865: strcasecmp(title->b, "DIAGNOSTICS") == 0 ||
866: strcasecmp(title->b, "ERRORS") == 0 ||
867: strcasecmp(title->b, "SEE ALSO") == 0 ||
868: strcasecmp(title->b, "STANDARDS") == 0 ||
869: strcasecmp(title->b, "HISTORY") == 0)
870: later = NULL;
871: else if ((strcasecmp(title->b, "CAVEATS") == 0 ||
872: strcasecmp(title->b, "BUGS") == 0) &&
873: later == NULL)
874: later = nc;
875: }
876:
877: /*
878: * If no AUTHORS section was found, create one from scratch,
879: * and insert that at the place selected earlier.
880: */
881:
882: if (match == NULL) {
883: if ((match = calloc(1, sizeof(*match))) == NULL) {
884: perror(NULL);
885: exit(1);
886: }
887: match->node = NODE_SECTION;
888: match->spc = 1;
889: match->parent = n;
890: TAILQ_INIT(&match->childq);
891: TAILQ_INIT(&match->attrq);
892: if ((nc = pnode_alloc(match)) == NULL) {
893: perror(NULL);
894: exit(1);
895: }
896: nc->node = NODE_TITLE;
897: nc->spc = 1;
898: if ((nc = pnode_alloc(nc)) == NULL) {
899: perror(NULL);
900: exit(1);
901: }
902: nc->node = NODE_TEXT;
903: if ((nc->b = strdup("AUTHORS")) == NULL) {
904: perror(NULL);
905: exit(1);
906: }
907: nc->spc = 1;
908: if (later == NULL)
909: TAILQ_INSERT_TAIL(&n->childq, match, child);
910: else
911: TAILQ_INSERT_BEFORE(later, match, child);
912: }
913:
914: /*
915: * Dump the stuff excised at the beginning
916: * into this AUTHORS section.
917: */
918:
919: if (info != NULL)
920: TAILQ_INSERT_TAIL(&match->childq, info, child);
921: if (meta != NULL)
922: TAILQ_INSERT_TAIL(&match->childq, meta, child);
923: }
924:
1.42 kristaps 925: /*
926: * We can have multiple <term> elements within a <varlistentry>, which
927: * we should comma-separate as list headers.
928: */
1.13 kristaps 929: static void
1.101 schwarze 930: pnode_printvarlistentry(struct format *f, struct pnode *n)
1.13 kristaps 931: {
1.133 ! schwarze 932: struct pnode *nc, *nn, *ncc;
! 933: int comma;
1.13 kristaps 934:
1.101 schwarze 935: macro_open(f, "It");
1.130 schwarze 936: f->parastate = PARA_HAVE;
1.103 schwarze 937: f->flags |= FMT_IMPL;
1.133 ! schwarze 938: comma = -1;
1.108 schwarze 939: TAILQ_FOREACH_SAFE(nc, &n->childq, child, nn) {
1.101 schwarze 940: if (nc->node != NODE_TERM && nc->node != NODE_GLOSSTERM)
1.69 schwarze 941: continue;
1.133 ! schwarze 942: if (comma != -1) {
1.108 schwarze 943: switch (f->linestate) {
944: case LINE_NEW:
945: break;
946: case LINE_TEXT:
947: print_text(f, ",", 0);
948: break;
949: case LINE_MACRO:
1.133 ! schwarze 950: macro_addarg(f, ",", comma);
1.108 schwarze 951: break;
952: }
953: }
1.130 schwarze 954: f->parastate = PARA_HAVE;
1.133 ! schwarze 955: comma = (ncc = TAILQ_FIRST(&nc->childq)) == NULL ||
! 956: pnode_class(ncc->node) == CLASS_TEXT ? 0 : ARG_SPACE;
1.101 schwarze 957: pnode_print(f, nc);
1.108 schwarze 958: pnode_unlink(nc);
1.69 schwarze 959: }
1.101 schwarze 960: macro_close(f);
1.130 schwarze 961: f->parastate = PARA_HAVE;
1.108 schwarze 962: while ((nc = TAILQ_FIRST(&n->childq)) != NULL) {
963: pnode_print(f, nc);
964: pnode_unlink(nc);
965: }
966: macro_close(f);
1.130 schwarze 967: f->parastate = PARA_HAVE;
1.71 schwarze 968: }
969:
970: static void
1.101 schwarze 971: pnode_printtitle(struct format *f, struct pnode *n)
1.71 schwarze 972: {
1.101 schwarze 973: struct pnode *nc, *nn;
1.71 schwarze 974:
1.101 schwarze 975: TAILQ_FOREACH_SAFE(nc, &n->childq, child, nn) {
976: if (nc->node == NODE_TITLE) {
1.130 schwarze 977: if (f->parastate == PARA_MID)
978: f->parastate = PARA_WANT;
979: macro_nodeline(f, "Sy", nc, 0);
1.101 schwarze 980: pnode_unlink(nc);
1.71 schwarze 981: }
982: }
1.13 kristaps 983: }
984:
985: static void
1.101 schwarze 986: pnode_printrow(struct format *f, struct pnode *n)
1.25 kristaps 987: {
1.101 schwarze 988: struct pnode *nc;
1.25 kristaps 989:
1.101 schwarze 990: macro_line(f, "Bl -dash -compact");
991: TAILQ_FOREACH(nc, &n->childq, child) {
992: macro_line(f, "It");
993: pnode_print(f, nc);
1.25 kristaps 994: }
1.101 schwarze 995: macro_line(f, "El");
996: pnode_unlink(n);
1.25 kristaps 997: }
998:
999: static void
1.83 schwarze 1000: pnode_printtgroup1(struct format *f, struct pnode *n)
1.16 kristaps 1001: {
1.82 schwarze 1002: struct pnode *nc;
1003:
1.83 schwarze 1004: macro_line(f, "Bl -bullet -compact");
1.82 schwarze 1005: while ((nc = pnode_findfirst(n, NODE_ENTRY)) != NULL) {
1.83 schwarze 1006: macro_line(f, "It");
1.130 schwarze 1007: f->parastate = PARA_HAVE;
1.83 schwarze 1008: pnode_print(f, nc);
1.130 schwarze 1009: f->parastate = PARA_HAVE;
1.82 schwarze 1010: pnode_unlink(nc);
1011: }
1.83 schwarze 1012: macro_line(f, "El");
1013: pnode_unlinksub(n);
1014: }
1015:
1016: static void
1017: pnode_printtgroup2(struct format *f, struct pnode *n)
1018: {
1019: struct pnode *nr, *ne;
1020:
1.130 schwarze 1021: f->parastate = PARA_HAVE;
1.83 schwarze 1022: macro_line(f, "Bl -tag -width Ds");
1023: while ((nr = pnode_findfirst(n, NODE_ROW)) != NULL) {
1024: if ((ne = pnode_findfirst(n, NODE_ENTRY)) == NULL)
1025: break;
1026: macro_open(f, "It");
1.103 schwarze 1027: f->flags |= FMT_IMPL;
1.130 schwarze 1028: f->parastate = PARA_HAVE;
1.83 schwarze 1029: pnode_print(f, ne);
1.84 schwarze 1030: macro_close(f);
1.83 schwarze 1031: pnode_unlink(ne);
1.130 schwarze 1032: f->parastate = PARA_HAVE;
1.83 schwarze 1033: pnode_print(f, nr);
1.130 schwarze 1034: f->parastate = PARA_HAVE;
1.83 schwarze 1035: pnode_unlink(nr);
1036: }
1037: macro_line(f, "El");
1.82 schwarze 1038: pnode_unlinksub(n);
1039: }
1040:
1041: static void
1.83 schwarze 1042: pnode_printtgroup(struct format *f, struct pnode *n)
1.82 schwarze 1043: {
1044: struct pnode *nc;
1045:
1046: switch (atoi(pnode_getattr_raw(n, ATTRKEY_COLS, "0"))) {
1047: case 1:
1.83 schwarze 1048: pnode_printtgroup1(f, n);
1049: return;
1050: case 2:
1051: pnode_printtgroup2(f, n);
1.82 schwarze 1052: return;
1053: default:
1054: break;
1055: }
1.16 kristaps 1056:
1.130 schwarze 1057: f->parastate = PARA_HAVE;
1.83 schwarze 1058: macro_line(f, "Bl -ohang");
1.82 schwarze 1059: while ((nc = pnode_findfirst(n, NODE_ROW)) != NULL) {
1.83 schwarze 1060: macro_line(f, "It Table Row");
1061: pnode_printrow(f, nc);
1.25 kristaps 1062: }
1.83 schwarze 1063: macro_line(f, "El");
1.82 schwarze 1064: pnode_unlinksub(n);
1.25 kristaps 1065: }
1066:
1067: static void
1.101 schwarze 1068: pnode_printlist(struct format *f, struct pnode *n)
1.25 kristaps 1069: {
1.101 schwarze 1070: struct pnode *nc;
1.16 kristaps 1071:
1.101 schwarze 1072: pnode_printtitle(f, n);
1.130 schwarze 1073: f->parastate = PARA_HAVE;
1.101 schwarze 1074: macro_argline(f, "Bl",
1075: n->node == NODE_ORDEREDLIST ? "-enum" : "-bullet");
1076: TAILQ_FOREACH(nc, &n->childq, child) {
1077: macro_line(f, "It");
1.130 schwarze 1078: f->parastate = PARA_HAVE;
1.101 schwarze 1079: pnode_print(f, nc);
1.130 schwarze 1080: f->parastate = PARA_HAVE;
1.16 kristaps 1081: }
1.101 schwarze 1082: macro_line(f, "El");
1083: pnode_unlinksub(n);
1.16 kristaps 1084: }
1085:
1086: static void
1.101 schwarze 1087: pnode_printvariablelist(struct format *f, struct pnode *n)
1.13 kristaps 1088: {
1.101 schwarze 1089: struct pnode *nc;
1.13 kristaps 1090:
1.101 schwarze 1091: pnode_printtitle(f, n);
1.130 schwarze 1092: f->parastate = PARA_HAVE;
1.101 schwarze 1093: macro_line(f, "Bl -tag -width Ds");
1094: TAILQ_FOREACH(nc, &n->childq, child) {
1095: if (nc->node == NODE_VARLISTENTRY)
1096: pnode_printvarlistentry(f, nc);
1.69 schwarze 1097: else
1.101 schwarze 1098: macro_nodeline(f, "It", nc, 0);
1.69 schwarze 1099: }
1.101 schwarze 1100: macro_line(f, "El");
1101: pnode_unlinksub(n);
1.13 kristaps 1102: }
1103:
1.1 kristaps 1104: /*
1105: * Print a parsed node (or ignore it--whatever).
1106: * This is a recursive function.
1.23 kristaps 1107: * FIXME: if we're in a literal context (<screen> or <programlisting> or
1108: * whatever), don't print inline macros.
1.1 kristaps 1109: */
1110: static void
1.101 schwarze 1111: pnode_print(struct format *f, struct pnode *n)
1.1 kristaps 1112: {
1.102 schwarze 1113: struct pnode *nc, *nn;
1.112 schwarze 1114: int was_impl;
1.1 kristaps 1115:
1.101 schwarze 1116: if (n == NULL)
1.1 kristaps 1117: return;
1118:
1.112 schwarze 1119: was_impl = f->flags & FMT_IMPL;
1.103 schwarze 1120: if (n->spc)
1121: f->flags &= ~FMT_NOSPC;
1122: else
1123: f->flags |= FMT_NOSPC;
1.1 kristaps 1124:
1.101 schwarze 1125: switch (n->node) {
1.62 schwarze 1126: case NODE_ARG:
1.101 schwarze 1127: pnode_printarg(f, n);
1.4 kristaps 1128: break;
1.62 schwarze 1129: case NODE_AUTHOR:
1.101 schwarze 1130: pnode_printauthor(f, n);
1.50 schwarze 1131: break;
1.62 schwarze 1132: case NODE_AUTHORGROUP:
1.101 schwarze 1133: macro_line(f, "An -split");
1.50 schwarze 1134: break;
1.98 schwarze 1135: case NODE_BLOCKQUOTE:
1.130 schwarze 1136: f->parastate = PARA_HAVE;
1.101 schwarze 1137: macro_line(f, "Bd -ragged -offset indent");
1.130 schwarze 1138: f->parastate = PARA_HAVE;
1.98 schwarze 1139: break;
1.62 schwarze 1140: case NODE_CITEREFENTRY:
1.101 schwarze 1141: pnode_printciterefentry(f, n);
1.1 kristaps 1142: break;
1.68 schwarze 1143: case NODE_CITETITLE:
1.101 schwarze 1144: macro_open(f, "%T");
1.68 schwarze 1145: break;
1.62 schwarze 1146: case NODE_COMMAND:
1.101 schwarze 1147: macro_open(f, "Nm");
1.13 kristaps 1148: break;
1.62 schwarze 1149: case NODE_CONSTANT:
1.101 schwarze 1150: macro_open(f, "Dv");
1.33 kristaps 1151: break;
1.121 schwarze 1152: case NODE_COPYRIGHT:
1153: print_text(f, "Copyright", ARG_SPACE);
1154: fputs(" \\(co", stdout);
1155: break;
1.62 schwarze 1156: case NODE_EDITOR:
1.101 schwarze 1157: print_text(f, "editor:", ARG_SPACE);
1.121 schwarze 1158: pnode_printauthor(f, n);
1.50 schwarze 1159: break;
1.65 schwarze 1160: case NODE_EMAIL:
1.115 schwarze 1161: if (was_impl)
1162: macro_open(f, "Ao Mt");
1163: else {
1164: macro_open(f, "Aq Mt");
1165: f->flags |= FMT_IMPL;
1166: }
1.65 schwarze 1167: break;
1.62 schwarze 1168: case NODE_EMPHASIS:
1169: case NODE_FIRSTTERM:
1.99 schwarze 1170: case NODE_GLOSSTERM:
1.123 schwarze 1171: if ((nc = TAILQ_FIRST(&n->childq)) != NULL &&
1172: pnode_class(nc->node) < CLASS_LINE)
1173: macro_open(f, "Em");
1.130 schwarze 1174: if (n->node == NODE_GLOSSTERM)
1175: f->parastate = PARA_HAVE;
1.1 kristaps 1176: break;
1.62 schwarze 1177: case NODE_ENVAR:
1.101 schwarze 1178: macro_open(f, "Ev");
1.79 schwarze 1179: break;
1.90 schwarze 1180: case NODE_ERRORNAME:
1.101 schwarze 1181: macro_open(f, "Er");
1.90 schwarze 1182: break;
1.62 schwarze 1183: case NODE_FILENAME:
1.101 schwarze 1184: macro_open(f, "Pa");
1.17 kristaps 1185: break;
1.125 schwarze 1186: case NODE_FOOTNOTE:
1187: macro_line(f, "Bo");
1.130 schwarze 1188: f->parastate = PARA_HAVE;
1.125 schwarze 1189: break;
1.62 schwarze 1190: case NODE_FUNCTION:
1.101 schwarze 1191: macro_open(f, "Fn");
1.3 kristaps 1192: break;
1.62 schwarze 1193: case NODE_FUNCPROTOTYPE:
1.101 schwarze 1194: pnode_printfuncprototype(f, n);
1.3 kristaps 1195: break;
1.62 schwarze 1196: case NODE_FUNCSYNOPSISINFO:
1.101 schwarze 1197: macro_open(f, "Fd");
1.126 schwarze 1198: break;
1199: case NODE_IMAGEDATA:
1200: pnode_printimagedata(f, n);
1.16 kristaps 1201: break;
1.62 schwarze 1202: case NODE_INFORMALEQUATION:
1.130 schwarze 1203: f->parastate = PARA_HAVE;
1.111 schwarze 1204: macro_line(f, "Bd -ragged -offset indent");
1.130 schwarze 1205: f->parastate = PARA_HAVE;
1.111 schwarze 1206: /* FALLTHROUGH */
1207: case NODE_INLINEEQUATION:
1.101 schwarze 1208: macro_line(f, "EQ");
1.43 kristaps 1209: break;
1.62 schwarze 1210: case NODE_ITEMIZEDLIST:
1.101 schwarze 1211: pnode_printlist(f, n);
1.24 kristaps 1212: break;
1.62 schwarze 1213: case NODE_GROUP:
1.101 schwarze 1214: pnode_printgroup(f, n);
1.10 kristaps 1215: break;
1.67 schwarze 1216: case NODE_KEYSYM:
1.131 schwarze 1217: case NODE_PRODUCTNAME:
1.101 schwarze 1218: macro_open(f, "Sy");
1.67 schwarze 1219: break;
1.62 schwarze 1220: case NODE_LINK:
1.101 schwarze 1221: pnode_printlink(f, n);
1.96 schwarze 1222: break;
1.62 schwarze 1223: case NODE_LITERAL:
1.122 schwarze 1224: if (n->parent != NULL && n->parent->node == NODE_QUOTE)
1225: macro_open(f, "Li");
1226: else if (was_impl)
1227: macro_open(f, "So Li");
1.112 schwarze 1228: else {
1229: macro_open(f, "Ql");
1230: f->flags |= FMT_IMPL;
1231: }
1.19 kristaps 1232: break;
1.62 schwarze 1233: case NODE_LITERALLAYOUT:
1.101 schwarze 1234: macro_close(f);
1.130 schwarze 1235: f->parastate = PARA_HAVE;
1.101 schwarze 1236: macro_argline(f, "Bd", pnode_getattr(n, ATTRKEY_CLASS) ==
1.66 schwarze 1237: ATTRVAL_MONOSPACED ? "-literal" : "-unfilled");
1.130 schwarze 1238: f->parastate = PARA_HAVE;
1.60 schwarze 1239: break;
1.106 schwarze 1240: case NODE_MARKUP:
1241: macro_open(f, "Ic");
1242: break;
1.62 schwarze 1243: case NODE_MML_MFENCED:
1.101 schwarze 1244: pnode_printmathfenced(f, n);
1.40 kristaps 1245: break;
1.62 schwarze 1246: case NODE_MML_MROW:
1247: case NODE_MML_MI:
1248: case NODE_MML_MN:
1249: case NODE_MML_MO:
1.101 schwarze 1250: if (TAILQ_EMPTY(&n->childq))
1.43 kristaps 1251: break;
1252: fputs(" { ", stdout);
1.40 kristaps 1253: break;
1.62 schwarze 1254: case NODE_MML_MFRAC:
1255: case NODE_MML_MSUB:
1256: case NODE_MML_MSUP:
1.101 schwarze 1257: pnode_printmath(f, n);
1.128 schwarze 1258: break;
1259: case NODE_OLINK:
1260: pnode_printolink(f, n);
1.40 kristaps 1261: break;
1.62 schwarze 1262: case NODE_OPTION:
1.123 schwarze 1263: if ((nc = TAILQ_FIRST(&n->childq)) != NULL &&
1264: pnode_class(nc->node) < CLASS_LINE)
1265: macro_open(f, "Fl");
1.1 kristaps 1266: break;
1.62 schwarze 1267: case NODE_ORDEREDLIST:
1.101 schwarze 1268: pnode_printlist(f, n);
1.25 kristaps 1269: break;
1.62 schwarze 1270: case NODE_PARA:
1.130 schwarze 1271: if (f->parastate == PARA_MID)
1272: f->parastate = PARA_WANT;
1.3 kristaps 1273: break;
1.87 schwarze 1274: case NODE_PARAMDEF:
1.62 schwarze 1275: case NODE_PARAMETER:
1.104 schwarze 1276: /* More often, these appear inside NODE_FUNCPROTOTYPE. */
1277: macro_open(f, "Fa");
1278: macro_addnode(f, n, ARG_SPACE | ARG_SINGLE);
1.101 schwarze 1279: pnode_unlinksub(n);
1.1 kristaps 1280: break;
1.62 schwarze 1281: case NODE_QUOTE:
1.127 schwarze 1282: if ((nc = TAILQ_FIRST(&n->childq)) != NULL &&
1283: nc->node == NODE_FILENAME &&
1284: TAILQ_NEXT(nc, child) == NULL) {
1285: if (n->spc)
1286: nc->spc = 1;
1287: } else if (was_impl)
1.112 schwarze 1288: macro_open(f, "Do");
1289: else {
1290: macro_open(f, "Dq");
1291: f->flags |= FMT_IMPL;
1292: }
1.28 kristaps 1293: break;
1.62 schwarze 1294: case NODE_PROGRAMLISTING:
1295: case NODE_SCREEN:
1.88 schwarze 1296: case NODE_SYNOPSIS:
1.130 schwarze 1297: f->parastate = PARA_HAVE;
1.101 schwarze 1298: macro_line(f, "Bd -literal");
1.130 schwarze 1299: f->parastate = PARA_HAVE;
1.118 schwarze 1300: break;
1301: case NODE_SYSTEMITEM:
1302: pnode_printsystemitem(f, n);
1.15 kristaps 1303: break;
1.119 schwarze 1304: case NODE_REFENTRY:
1305: pnode_printrefentry(f, n);
1.1 kristaps 1306: break;
1.62 schwarze 1307: case NODE_REFNAME:
1.110 schwarze 1308: /* More often, these appear inside NODE_REFNAMEDIV. */
1.101 schwarze 1309: macro_open(f, "Nm");
1.10 kristaps 1310: break;
1.62 schwarze 1311: case NODE_REFNAMEDIV:
1.110 schwarze 1312: pnode_printrefnamediv(f, n);
1.1 kristaps 1313: break;
1.62 schwarze 1314: case NODE_REFPURPOSE:
1.101 schwarze 1315: macro_open(f, "Nd");
1.10 kristaps 1316: break;
1.62 schwarze 1317: case NODE_REFSYNOPSISDIV:
1.101 schwarze 1318: pnode_printrefsynopsisdiv(f, n);
1.1 kristaps 1319: break;
1.62 schwarze 1320: case NODE_PREFACE:
1321: case NODE_SECTION:
1.121 schwarze 1322: case NODE_SIMPLESECT:
1.100 schwarze 1323: case NODE_APPENDIX:
1324: case NODE_LEGALNOTICE:
1.62 schwarze 1325: case NODE_NOTE:
1326: case NODE_TIP:
1327: case NODE_CAUTION:
1328: case NODE_WARNING:
1.119 schwarze 1329: pnode_printsection(f, n);
1.1 kristaps 1330: break;
1.62 schwarze 1331: case NODE_REPLACEABLE:
1.101 schwarze 1332: macro_open(f, "Ar");
1.13 kristaps 1333: break;
1.62 schwarze 1334: case NODE_SBR:
1.130 schwarze 1335: if (f->parastate == PARA_MID)
1336: macro_line(f, "br");
1.124 schwarze 1337: break;
1338: case NODE_SUBSCRIPT:
1339: if (f->linestate == LINE_MACRO)
1340: macro_addarg(f, "_", 0);
1341: else
1342: print_text(f, "_", 0);
1343: if ((nc = TAILQ_FIRST(&n->childq)) != NULL)
1344: nc->spc = 0;
1345: break;
1346: case NODE_SUPERSCRIPT:
1347: fputs("\\(ha", stdout);
1348: if ((nc = TAILQ_FIRST(&n->childq)) != NULL)
1349: nc->spc = 0;
1.25 kristaps 1350: break;
1.62 schwarze 1351: case NODE_TEXT:
1.93 schwarze 1352: case NODE_ESCAPE:
1.101 schwarze 1353: pnode_printtext(f, n);
1.1 kristaps 1354: break;
1.82 schwarze 1355: case NODE_TGROUP:
1.101 schwarze 1356: pnode_printtgroup(f, n);
1.82 schwarze 1357: break;
1.62 schwarze 1358: case NODE_TITLE:
1.121 schwarze 1359: case NODE_SUBTITLE:
1.130 schwarze 1360: if (f->parastate == PARA_MID)
1361: f->parastate = PARA_WANT;
1.101 schwarze 1362: macro_nodeline(f, "Sy", n, 0);
1363: pnode_unlinksub(n);
1.50 schwarze 1364: break;
1.62 schwarze 1365: case NODE_TYPE:
1.101 schwarze 1366: macro_open(f, "Vt");
1.39 kristaps 1367: break;
1.62 schwarze 1368: case NODE_VARIABLELIST:
1.101 schwarze 1369: pnode_printvariablelist(f, n);
1.13 kristaps 1370: break;
1.62 schwarze 1371: case NODE_VARNAME:
1.101 schwarze 1372: macro_open(f, "Va");
1.132 schwarze 1373: break;
1374: case NODE_VOID:
1375: print_text(f, "void", ARG_SPACE);
1.129 schwarze 1376: break;
1377: case NODE_XREF:
1378: pnode_printxref(f, n);
1.23 kristaps 1379: break;
1.1 kristaps 1380: default:
1381: break;
1382: }
1383:
1.102 schwarze 1384: TAILQ_FOREACH(nc, &n->childq, child)
1385: pnode_print(f, nc);
1.1 kristaps 1386:
1.101 schwarze 1387: switch (n->node) {
1.115 schwarze 1388: case NODE_EMAIL:
1389: if (was_impl) {
1390: f->flags &= ~FMT_NOSPC;
1391: macro_open(f, "Ac");
1392: } else
1393: f->flags &= ~FMT_IMPL;
1394: break;
1.103 schwarze 1395: case NODE_ESCAPE:
1396: case NODE_TERM:
1397: case NODE_TEXT:
1398: /* Accept more arguments to the previous macro. */
1399: return;
1.125 schwarze 1400: case NODE_FOOTNOTE:
1.130 schwarze 1401: f->parastate = PARA_HAVE;
1.125 schwarze 1402: macro_line(f, "Bc");
1403: break;
1.130 schwarze 1404: case NODE_GLOSSTERM:
1405: f->parastate = PARA_HAVE;
1406: break;
1.62 schwarze 1407: case NODE_INFORMALEQUATION:
1.101 schwarze 1408: macro_line(f, "EN");
1.111 schwarze 1409: macro_line(f, "Ed");
1.40 kristaps 1410: break;
1.62 schwarze 1411: case NODE_INLINEEQUATION:
1.111 schwarze 1412: macro_line(f, "EN");
1.43 kristaps 1413: break;
1.112 schwarze 1414: case NODE_LITERAL:
1.122 schwarze 1415: if (n->parent != NULL && n->parent->node == NODE_QUOTE)
1416: /* nothing */;
1417: else if (was_impl) {
1.115 schwarze 1418: f->flags &= ~FMT_NOSPC;
1.112 schwarze 1419: macro_open(f, "Sc");
1.115 schwarze 1420: } else
1.112 schwarze 1421: f->flags &= ~FMT_IMPL;
1422: break;
1.91 schwarze 1423: case NODE_MEMBER:
1.102 schwarze 1424: if ((nn = TAILQ_NEXT(n, child)) != NULL &&
1425: nn->node != NODE_MEMBER)
1426: nn = NULL;
1.101 schwarze 1427: switch (f->linestate) {
1.91 schwarze 1428: case LINE_TEXT:
1.102 schwarze 1429: if (nn != NULL)
1.101 schwarze 1430: print_text(f, ",", 0);
1.91 schwarze 1431: break;
1432: case LINE_MACRO:
1.102 schwarze 1433: if (nn != NULL)
1.101 schwarze 1434: macro_addarg(f, ",", ARG_SPACE);
1435: macro_close(f);
1.91 schwarze 1436: break;
1437: case LINE_NEW:
1438: break;
1439: }
1440: break;
1.62 schwarze 1441: case NODE_MML_MROW:
1442: case NODE_MML_MI:
1443: case NODE_MML_MN:
1444: case NODE_MML_MO:
1.101 schwarze 1445: if (TAILQ_EMPTY(&n->childq))
1.43 kristaps 1446: break;
1447: fputs(" } ", stdout);
1.40 kristaps 1448: break;
1.130 schwarze 1449: case NODE_PARA:
1450: if (f->parastate == PARA_MID)
1451: f->parastate = PARA_WANT;
1452: break;
1.62 schwarze 1453: case NODE_QUOTE:
1.127 schwarze 1454: if ((nc = TAILQ_FIRST(&n->childq)) != NULL &&
1455: nc->node == NODE_FILENAME &&
1456: TAILQ_NEXT(nc, child) == NULL)
1457: /* nothing */;
1458: else if (was_impl) {
1.115 schwarze 1459: f->flags &= ~FMT_NOSPC;
1.112 schwarze 1460: macro_open(f, "Dc");
1.115 schwarze 1461: } else
1.112 schwarze 1462: f->flags &= ~FMT_IMPL;
1.52 schwarze 1463: break;
1.62 schwarze 1464: case NODE_PREFACE:
1465: case NODE_SECTION:
1.100 schwarze 1466: case NODE_APPENDIX:
1467: case NODE_LEGALNOTICE:
1.62 schwarze 1468: case NODE_NOTE:
1469: case NODE_TIP:
1470: case NODE_CAUTION:
1471: case NODE_WARNING:
1.101 schwarze 1472: f->level--;
1.12 kristaps 1473: break;
1.98 schwarze 1474: case NODE_BLOCKQUOTE:
1.62 schwarze 1475: case NODE_LITERALLAYOUT:
1476: case NODE_PROGRAMLISTING:
1477: case NODE_SCREEN:
1.88 schwarze 1478: case NODE_SYNOPSIS:
1.130 schwarze 1479: f->parastate = PARA_HAVE;
1.101 schwarze 1480: macro_line(f, "Ed");
1.50 schwarze 1481: break;
1.130 schwarze 1482: case NODE_TITLE:
1483: case NODE_SUBTITLE:
1484: f->parastate = PARA_WANT;
1485: break;
1.1 kristaps 1486: default:
1487: break;
1488: }
1.103 schwarze 1489: f->flags &= ~FMT_ARG;
1.1 kristaps 1490: }
1491:
1.74 schwarze 1492: void
1.114 schwarze 1493: ptree_print_mdoc(struct ptree *tree)
1.74 schwarze 1494: {
1495: struct format formatter;
1.1 kristaps 1496:
1.74 schwarze 1497: formatter.level = 0;
1498: formatter.linestate = LINE_NEW;
1.130 schwarze 1499: formatter.parastate = PARA_HAVE;
1.116 schwarze 1500: pnode_printprologue(&formatter, tree->root);
1.74 schwarze 1501: pnode_print(&formatter, tree->root);
1502: if (formatter.linestate != LINE_NEW)
1503: putchar('\n');
1.1 kristaps 1504: }
CVSweb