Annotation of src/usr.bin/mandoc/tree.c, Revision 1.50
1.50 ! schwarze 1: /* $OpenBSD: tree.c,v 1.49 2018/12/13 05:13:15 schwarze Exp $ */
1.1 kristaps 2: /*
1.24 schwarze 3: * Copyright (c) 2008, 2009, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.45 schwarze 4: * Copyright (c) 2013,2014,2015,2017,2018 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.30 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.2 schwarze 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.30 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.2 schwarze 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.
1.1 kristaps 17: */
1.24 schwarze 18: #include <sys/types.h>
19:
1.1 kristaps 20: #include <assert.h>
1.16 schwarze 21: #include <limits.h>
1.1 kristaps 22: #include <stdio.h>
23: #include <stdlib.h>
1.6 schwarze 24: #include <time.h>
1.1 kristaps 25:
1.7 schwarze 26: #include "mandoc.h"
1.30 schwarze 27: #include "roff.h"
1.1 kristaps 28: #include "mdoc.h"
29: #include "man.h"
1.48 schwarze 30: #include "tbl.h"
1.49 schwarze 31: #include "eqn.h"
1.5 schwarze 32: #include "main.h"
1.1 kristaps 33:
1.16 schwarze 34: static void print_box(const struct eqn_box *, int);
1.31 schwarze 35: static void print_man(const struct roff_node *, int);
1.39 schwarze 36: static void print_meta(const struct roff_meta *);
1.31 schwarze 37: static void print_mdoc(const struct roff_node *, int);
1.11 schwarze 38: static void print_span(const struct tbl_span *, int);
1.1 kristaps 39:
40:
1.4 schwarze 41: void
1.50 ! schwarze 42: tree_mdoc(void *arg, const struct roff_meta *mdoc)
1.1 kristaps 43: {
1.50 ! schwarze 44: print_meta(mdoc);
1.39 schwarze 45: putchar('\n');
1.33 schwarze 46: print_mdoc(mdoc->first->child, 0);
1.1 kristaps 47: }
48:
1.4 schwarze 49: void
1.50 ! schwarze 50: tree_man(void *arg, const struct roff_meta *man)
1.1 kristaps 51: {
1.50 ! schwarze 52: print_meta(man);
! 53: if (man->hasbody == 0)
1.39 schwarze 54: puts("body = empty");
55: putchar('\n');
56: print_man(man->first->child, 0);
57: }
1.1 kristaps 58:
1.39 schwarze 59: static void
60: print_meta(const struct roff_meta *meta)
61: {
62: if (meta->title != NULL)
63: printf("title = \"%s\"\n", meta->title);
64: if (meta->name != NULL)
65: printf("name = \"%s\"\n", meta->name);
66: if (meta->msec != NULL)
67: printf("sec = \"%s\"\n", meta->msec);
68: if (meta->vol != NULL)
69: printf("vol = \"%s\"\n", meta->vol);
70: if (meta->arch != NULL)
71: printf("arch = \"%s\"\n", meta->arch);
72: if (meta->os != NULL)
73: printf("os = \"%s\"\n", meta->os);
74: if (meta->date != NULL)
75: printf("date = \"%s\"\n", meta->date);
1.1 kristaps 76: }
77:
78: static void
1.31 schwarze 79: print_mdoc(const struct roff_node *n, int indent)
1.1 kristaps 80: {
81: const char *p, *t;
82: int i, j;
1.17 schwarze 83: size_t argc;
1.1 kristaps 84: struct mdoc_argv *argv;
85:
1.28 schwarze 86: if (n == NULL)
87: return;
88:
1.1 kristaps 89: argv = NULL;
1.17 schwarze 90: argc = 0;
1.16 schwarze 91: t = p = NULL;
1.1 kristaps 92:
93: switch (n->type) {
1.30 schwarze 94: case ROFFT_ROOT:
1.1 kristaps 95: t = "root";
96: break;
1.30 schwarze 97: case ROFFT_BLOCK:
1.1 kristaps 98: t = "block";
99: break;
1.30 schwarze 100: case ROFFT_HEAD:
1.35 schwarze 101: t = "head";
1.1 kristaps 102: break;
1.30 schwarze 103: case ROFFT_BODY:
1.9 schwarze 104: if (n->end)
105: t = "body-end";
106: else
1.35 schwarze 107: t = "body";
1.1 kristaps 108: break;
1.30 schwarze 109: case ROFFT_TAIL:
1.35 schwarze 110: t = "tail";
1.1 kristaps 111: break;
1.30 schwarze 112: case ROFFT_ELEM:
1.1 kristaps 113: t = "elem";
114: break;
1.30 schwarze 115: case ROFFT_TEXT:
1.1 kristaps 116: t = "text";
117: break;
1.45 schwarze 118: case ROFFT_COMMENT:
119: t = "comment";
120: break;
1.30 schwarze 121: case ROFFT_TBL:
1.26 schwarze 122: break;
1.30 schwarze 123: case ROFFT_EQN:
1.26 schwarze 124: t = "eqn";
1.14 schwarze 125: break;
1.1 kristaps 126: default:
127: abort();
128: }
129:
130: switch (n->type) {
1.30 schwarze 131: case ROFFT_TEXT:
1.45 schwarze 132: case ROFFT_COMMENT:
1.1 kristaps 133: p = n->string;
134: break;
1.30 schwarze 135: case ROFFT_BODY:
1.41 schwarze 136: p = roff_name[n->tok];
1.1 kristaps 137: break;
1.30 schwarze 138: case ROFFT_HEAD:
1.41 schwarze 139: p = roff_name[n->tok];
1.1 kristaps 140: break;
1.30 schwarze 141: case ROFFT_TAIL:
1.41 schwarze 142: p = roff_name[n->tok];
1.1 kristaps 143: break;
1.30 schwarze 144: case ROFFT_ELEM:
1.41 schwarze 145: p = roff_name[n->tok];
1.1 kristaps 146: if (n->args) {
147: argv = n->args->argv;
148: argc = n->args->argc;
149: }
150: break;
1.30 schwarze 151: case ROFFT_BLOCK:
1.41 schwarze 152: p = roff_name[n->tok];
1.1 kristaps 153: if (n->args) {
154: argv = n->args->argv;
155: argc = n->args->argc;
156: }
157: break;
1.30 schwarze 158: case ROFFT_TBL:
1.26 schwarze 159: break;
1.30 schwarze 160: case ROFFT_EQN:
1.26 schwarze 161: p = "EQ";
1.14 schwarze 162: break;
1.30 schwarze 163: case ROFFT_ROOT:
1.1 kristaps 164: p = "root";
165: break;
166: default:
167: abort();
168: }
169:
1.11 schwarze 170: if (n->span) {
1.16 schwarze 171: assert(NULL == p && NULL == t);
1.11 schwarze 172: print_span(n->span, indent);
173: } else {
174: for (i = 0; i < indent; i++)
1.28 schwarze 175: putchar(' ');
1.11 schwarze 176:
177: printf("%s (%s)", p, t);
178:
179: for (i = 0; i < (int)argc; i++) {
180: printf(" -%s", mdoc_argnames[argv[i].arg]);
181: if (argv[i].sz > 0)
182: printf(" [");
183: for (j = 0; j < (int)argv[i].sz; j++)
184: printf(" [%s]", argv[i].value[j]);
185: if (argv[i].sz > 0)
186: printf(" ]");
187: }
1.18 schwarze 188:
189: putchar(' ');
1.38 schwarze 190: if (NODE_DELIMO & n->flags)
1.35 schwarze 191: putchar('(');
1.38 schwarze 192: if (NODE_LINE & n->flags)
1.18 schwarze 193: putchar('*');
1.35 schwarze 194: printf("%d:%d", n->line, n->pos + 1);
1.38 schwarze 195: if (NODE_DELIMC & n->flags)
1.35 schwarze 196: putchar(')');
1.38 schwarze 197: if (NODE_EOS & n->flags)
1.35 schwarze 198: putchar('.');
1.40 schwarze 199: if (NODE_BROKEN & n->flags)
200: printf(" BROKEN");
1.37 schwarze 201: if (NODE_NOSRC & n->flags)
202: printf(" NOSRC");
203: if (NODE_NOPRT & n->flags)
204: printf(" NOPRT");
1.35 schwarze 205: putchar('\n');
1.1 kristaps 206: }
207:
1.26 schwarze 208: if (n->eqn)
1.44 schwarze 209: print_box(n->eqn->first, indent + 4);
1.1 kristaps 210: if (n->child)
1.28 schwarze 211: print_mdoc(n->child, indent +
1.30 schwarze 212: (n->type == ROFFT_BLOCK ? 2 : 4));
1.1 kristaps 213: if (n->next)
214: print_mdoc(n->next, indent);
215: }
216:
217: static void
1.31 schwarze 218: print_man(const struct roff_node *n, int indent)
1.1 kristaps 219: {
220: const char *p, *t;
221: int i;
222:
1.28 schwarze 223: if (n == NULL)
224: return;
225:
1.16 schwarze 226: t = p = NULL;
227:
1.1 kristaps 228: switch (n->type) {
1.30 schwarze 229: case ROFFT_ROOT:
1.1 kristaps 230: t = "root";
231: break;
1.30 schwarze 232: case ROFFT_ELEM:
1.1 kristaps 233: t = "elem";
234: break;
1.30 schwarze 235: case ROFFT_TEXT:
1.1 kristaps 236: t = "text";
237: break;
1.45 schwarze 238: case ROFFT_COMMENT:
239: t = "comment";
240: break;
1.30 schwarze 241: case ROFFT_BLOCK:
1.3 schwarze 242: t = "block";
243: break;
1.30 schwarze 244: case ROFFT_HEAD:
1.35 schwarze 245: t = "head";
1.3 schwarze 246: break;
1.30 schwarze 247: case ROFFT_BODY:
1.35 schwarze 248: t = "body";
1.3 schwarze 249: break;
1.30 schwarze 250: case ROFFT_TBL:
1.26 schwarze 251: break;
1.30 schwarze 252: case ROFFT_EQN:
1.26 schwarze 253: t = "eqn";
1.14 schwarze 254: break;
1.1 kristaps 255: default:
256: abort();
257: }
258:
259: switch (n->type) {
1.30 schwarze 260: case ROFFT_TEXT:
1.45 schwarze 261: case ROFFT_COMMENT:
1.1 kristaps 262: p = n->string;
263: break;
1.30 schwarze 264: case ROFFT_ELEM:
265: case ROFFT_BLOCK:
266: case ROFFT_HEAD:
267: case ROFFT_BODY:
1.41 schwarze 268: p = roff_name[n->tok];
1.1 kristaps 269: break;
1.30 schwarze 270: case ROFFT_ROOT:
1.1 kristaps 271: p = "root";
272: break;
1.30 schwarze 273: case ROFFT_TBL:
1.26 schwarze 274: break;
1.30 schwarze 275: case ROFFT_EQN:
1.26 schwarze 276: p = "EQ";
1.11 schwarze 277: break;
1.1 kristaps 278: default:
279: abort();
280: }
281:
1.11 schwarze 282: if (n->span) {
1.16 schwarze 283: assert(NULL == p && NULL == t);
1.11 schwarze 284: print_span(n->span, indent);
285: } else {
286: for (i = 0; i < indent; i++)
1.28 schwarze 287: putchar(' ');
1.20 schwarze 288: printf("%s (%s) ", p, t);
1.38 schwarze 289: if (NODE_LINE & n->flags)
1.20 schwarze 290: putchar('*');
1.35 schwarze 291: printf("%d:%d", n->line, n->pos + 1);
1.46 schwarze 292: if (NODE_DELIMC & n->flags)
293: putchar(')');
1.38 schwarze 294: if (NODE_EOS & n->flags)
1.35 schwarze 295: putchar('.');
296: putchar('\n');
1.11 schwarze 297: }
298:
1.26 schwarze 299: if (n->eqn)
1.44 schwarze 300: print_box(n->eqn->first, indent + 4);
1.1 kristaps 301: if (n->child)
1.28 schwarze 302: print_man(n->child, indent +
1.30 schwarze 303: (n->type == ROFFT_BLOCK ? 2 : 4));
1.1 kristaps 304: if (n->next)
305: print_man(n->next, indent);
1.11 schwarze 306: }
307:
308: static void
1.16 schwarze 309: print_box(const struct eqn_box *ep, int indent)
310: {
311: int i;
312: const char *t;
313:
1.24 schwarze 314: static const char *posnames[] = {
315: NULL, "sup", "subsup", "sub",
316: "to", "from", "fromto",
317: "over", "sqrt", NULL };
318:
1.16 schwarze 319: if (NULL == ep)
320: return;
321: for (i = 0; i < indent; i++)
1.28 schwarze 322: putchar(' ');
1.16 schwarze 323:
324: t = NULL;
325: switch (ep->type) {
1.21 schwarze 326: case EQN_LIST:
1.16 schwarze 327: t = "eqn-list";
328: break;
1.21 schwarze 329: case EQN_SUBEXPR:
1.16 schwarze 330: t = "eqn-expr";
331: break;
1.21 schwarze 332: case EQN_TEXT:
1.16 schwarze 333: t = "eqn-text";
334: break;
1.24 schwarze 335: case EQN_PILE:
336: t = "eqn-pile";
337: break;
1.21 schwarze 338: case EQN_MATRIX:
1.16 schwarze 339: t = "eqn-matrix";
340: break;
341: }
342:
1.24 schwarze 343: fputs(t, stdout);
344: if (ep->pos)
345: printf(" pos=%s", posnames[ep->pos]);
346: if (ep->left)
347: printf(" left=\"%s\"", ep->left);
348: if (ep->right)
349: printf(" right=\"%s\"", ep->right);
350: if (ep->top)
351: printf(" top=\"%s\"", ep->top);
352: if (ep->bottom)
353: printf(" bottom=\"%s\"", ep->bottom);
354: if (ep->text)
355: printf(" text=\"%s\"", ep->text);
356: if (ep->font)
357: printf(" font=%d", ep->font);
358: if (ep->size != EQN_DEFSIZE)
359: printf(" size=%d", ep->size);
360: if (ep->expectargs != UINT_MAX && ep->expectargs != ep->args)
361: printf(" badargs=%zu(%zu)", ep->args, ep->expectargs);
362: else if (ep->args)
363: printf(" args=%zu", ep->args);
364: putchar('\n');
1.16 schwarze 365:
1.28 schwarze 366: print_box(ep->first, indent + 4);
1.16 schwarze 367: print_box(ep->next, indent);
368: }
369:
370: static void
1.11 schwarze 371: print_span(const struct tbl_span *sp, int indent)
372: {
373: const struct tbl_dat *dp;
374: int i;
375:
376: for (i = 0; i < indent; i++)
1.28 schwarze 377: putchar(' ');
1.11 schwarze 378:
379: switch (sp->pos) {
1.21 schwarze 380: case TBL_SPAN_HORIZ:
1.11 schwarze 381: putchar('-');
1.47 schwarze 382: putchar(' ');
383: break;
1.21 schwarze 384: case TBL_SPAN_DHORIZ:
1.11 schwarze 385: putchar('=');
1.47 schwarze 386: putchar(' ');
387: break;
1.11 schwarze 388: default:
1.47 schwarze 389: for (dp = sp->first; dp; dp = dp->next) {
390: switch (dp->pos) {
391: case TBL_DATA_HORIZ:
392: case TBL_DATA_NHORIZ:
393: putchar('-');
394: putchar(' ');
395: continue;
396: case TBL_DATA_DHORIZ:
397: case TBL_DATA_NDHORIZ:
398: putchar('=');
399: putchar(' ');
400: continue;
401: default:
402: break;
403: }
404: printf("[\"%s\"", dp->string ? dp->string : "");
405: if (dp->hspans)
406: printf(">%d", dp->hspans);
407: if (dp->vspans)
408: printf("v%d", dp->vspans);
409: if (dp->layout == NULL)
410: putchar('*');
411: else if (dp->layout->pos == TBL_CELL_DOWN)
412: putchar('^');
413: putchar(']');
414: putchar(' ');
415: }
1.11 schwarze 416: break;
417: }
1.16 schwarze 418: printf("(tbl) %d:1\n", sp->line);
1.1 kristaps 419: }