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