[BACK]Return to tree.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/tree.c, Revision 1.87

1.87    ! schwarze    1: /* $Id$ */
1.1       kristaps    2: /*
1.87    ! schwarze    3:  * Copyright (c) 2013-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org>
1.58      schwarze    4:  * Copyright (c) 2008, 2009, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.1       kristaps    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
1.12      kristaps    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.63      schwarze   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.12      kristaps   11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.63      schwarze   12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.12      kristaps   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.87    ! schwarze   17:  *
        !            18:  * Formatting module to let mandoc(1) show
        !            19:  * a human readable representation of the syntax tree.
1.1       kristaps   20:  */
1.19      kristaps   21: #include "config.h"
1.54      schwarze   22:
                     23: #include <sys/types.h>
1.19      kristaps   24:
1.8       kristaps   25: #include <assert.h>
1.43      kristaps   26: #include <limits.h>
1.8       kristaps   27: #include <stdio.h>
1.1       kristaps   28: #include <stdlib.h>
1.17      kristaps   29: #include <time.h>
1.1       kristaps   30:
1.20      kristaps   31: #include "mandoc.h"
1.63      schwarze   32: #include "roff.h"
1.1       kristaps   33: #include "mdoc.h"
1.10      kristaps   34: #include "man.h"
1.81      schwarze   35: #include "tbl.h"
1.82      schwarze   36: #include "eqn.h"
1.16      kristaps   37: #include "main.h"
1.1       kristaps   38:
1.38      kristaps   39: static void    print_box(const struct eqn_box *, int);
1.85      schwarze   40: static void    print_cellt(enum tbl_cellt);
1.64      schwarze   41: static void    print_man(const struct roff_node *, int);
1.72      schwarze   42: static void    print_meta(const struct roff_meta *);
1.64      schwarze   43: static void    print_mdoc(const struct roff_node *, int);
1.30      kristaps   44: static void    print_span(const struct tbl_span *, int);
1.8       kristaps   45:
                     46:
1.15      kristaps   47: void
1.83      schwarze   48: tree_mdoc(void *arg, const struct roff_meta *mdoc)
1.8       kristaps   49: {
1.83      schwarze   50:        print_meta(mdoc);
1.72      schwarze   51:        putchar('\n');
1.66      schwarze   52:        print_mdoc(mdoc->first->child, 0);
1.11      kristaps   53: }
                     54:
1.15      kristaps   55: void
1.83      schwarze   56: tree_man(void *arg, const struct roff_meta *man)
1.11      kristaps   57: {
1.83      schwarze   58:        print_meta(man);
                     59:        if (man->hasbody == 0)
1.72      schwarze   60:                puts("body  = empty");
                     61:        putchar('\n');
                     62:        print_man(man->first->child, 0);
                     63: }
1.11      kristaps   64:
1.72      schwarze   65: static void
                     66: print_meta(const struct roff_meta *meta)
                     67: {
                     68:        if (meta->title != NULL)
                     69:                printf("title = \"%s\"\n", meta->title);
                     70:        if (meta->name != NULL)
                     71:                printf("name  = \"%s\"\n", meta->name);
                     72:        if (meta->msec != NULL)
                     73:                printf("sec   = \"%s\"\n", meta->msec);
                     74:        if (meta->vol != NULL)
                     75:                printf("vol   = \"%s\"\n", meta->vol);
                     76:        if (meta->arch != NULL)
                     77:                printf("arch  = \"%s\"\n", meta->arch);
                     78:        if (meta->os != NULL)
                     79:                printf("os    = \"%s\"\n", meta->os);
                     80:        if (meta->date != NULL)
                     81:                printf("date  = \"%s\"\n", meta->date);
1.8       kristaps   82: }
1.2       kristaps   83:
1.1       kristaps   84: static void
1.64      schwarze   85: print_mdoc(const struct roff_node *n, int indent)
1.1       kristaps   86: {
                     87:        const char       *p, *t;
                     88:        int               i, j;
1.48      schwarze   89:        size_t            argc;
1.8       kristaps   90:        struct mdoc_argv *argv;
1.1       kristaps   91:
1.61      schwarze   92:        if (n == NULL)
                     93:                return;
                     94:
1.1       kristaps   95:        argv = NULL;
1.48      schwarze   96:        argc = 0;
1.38      kristaps   97:        t = p = NULL;
1.1       kristaps   98:
1.2       kristaps   99:        switch (n->type) {
1.63      schwarze  100:        case ROFFT_ROOT:
1.2       kristaps  101:                t = "root";
                    102:                break;
1.63      schwarze  103:        case ROFFT_BLOCK:
1.2       kristaps  104:                t = "block";
                    105:                break;
1.63      schwarze  106:        case ROFFT_HEAD:
1.68      schwarze  107:                t = "head";
1.2       kristaps  108:                break;
1.63      schwarze  109:        case ROFFT_BODY:
1.23      schwarze  110:                if (n->end)
                    111:                        t = "body-end";
                    112:                else
1.68      schwarze  113:                        t = "body";
1.2       kristaps  114:                break;
1.63      schwarze  115:        case ROFFT_TAIL:
1.68      schwarze  116:                t = "tail";
1.2       kristaps  117:                break;
1.63      schwarze  118:        case ROFFT_ELEM:
1.2       kristaps  119:                t = "elem";
                    120:                break;
1.63      schwarze  121:        case ROFFT_TEXT:
1.2       kristaps  122:                t = "text";
                    123:                break;
1.78      schwarze  124:        case ROFFT_COMMENT:
                    125:                t = "comment";
                    126:                break;
1.63      schwarze  127:        case ROFFT_TBL:
1.59      schwarze  128:                break;
1.63      schwarze  129:        case ROFFT_EQN:
1.59      schwarze  130:                t = "eqn";
1.33      kristaps  131:                break;
1.2       kristaps  132:        default:
                    133:                abort();
                    134:        }
1.1       kristaps  135:
                    136:        switch (n->type) {
1.63      schwarze  137:        case ROFFT_TEXT:
1.78      schwarze  138:        case ROFFT_COMMENT:
1.8       kristaps  139:                p = n->string;
1.1       kristaps  140:                break;
1.63      schwarze  141:        case ROFFT_BODY:
1.74      schwarze  142:                p = roff_name[n->tok];
1.1       kristaps  143:                break;
1.63      schwarze  144:        case ROFFT_HEAD:
1.74      schwarze  145:                p = roff_name[n->tok];
1.1       kristaps  146:                break;
1.63      schwarze  147:        case ROFFT_TAIL:
1.74      schwarze  148:                p = roff_name[n->tok];
1.1       kristaps  149:                break;
1.63      schwarze  150:        case ROFFT_ELEM:
1.74      schwarze  151:                p = roff_name[n->tok];
1.8       kristaps  152:                if (n->args) {
                    153:                        argv = n->args->argv;
                    154:                        argc = n->args->argc;
                    155:                }
1.1       kristaps  156:                break;
1.63      schwarze  157:        case ROFFT_BLOCK:
1.74      schwarze  158:                p = roff_name[n->tok];
1.8       kristaps  159:                if (n->args) {
                    160:                        argv = n->args->argv;
                    161:                        argc = n->args->argc;
                    162:                }
1.1       kristaps  163:                break;
1.63      schwarze  164:        case ROFFT_TBL:
1.59      schwarze  165:                break;
1.63      schwarze  166:        case ROFFT_EQN:
1.59      schwarze  167:                p = "EQ";
1.33      kristaps  168:                break;
1.63      schwarze  169:        case ROFFT_ROOT:
1.1       kristaps  170:                p = "root";
                    171:                break;
                    172:        default:
                    173:                abort();
                    174:        }
                    175:
1.26      kristaps  176:        if (n->span) {
1.38      kristaps  177:                assert(NULL == p && NULL == t);
1.30      kristaps  178:                print_span(n->span, indent);
1.26      kristaps  179:        } else {
1.30      kristaps  180:                for (i = 0; i < indent; i++)
1.61      schwarze  181:                        putchar(' ');
1.30      kristaps  182:
1.26      kristaps  183:                printf("%s (%s)", p, t);
                    184:
                    185:                for (i = 0; i < (int)argc; i++) {
                    186:                        printf(" -%s", mdoc_argnames[argv[i].arg]);
                    187:                        if (argv[i].sz > 0)
                    188:                                printf(" [");
                    189:                        for (j = 0; j < (int)argv[i].sz; j++)
                    190:                                printf(" [%s]", argv[i].value[j]);
                    191:                        if (argv[i].sz > 0)
                    192:                                printf(" ]");
                    193:                }
1.49      schwarze  194:
                    195:                putchar(' ');
1.84      schwarze  196:                if (n->flags & NODE_DELIMO)
1.68      schwarze  197:                        putchar('(');
1.84      schwarze  198:                if (n->flags & NODE_LINE)
1.49      schwarze  199:                        putchar('*');
1.68      schwarze  200:                printf("%d:%d", n->line, n->pos + 1);
1.84      schwarze  201:                if (n->flags & NODE_DELIMC)
1.68      schwarze  202:                        putchar(')');
1.84      schwarze  203:                if (n->flags & NODE_EOS)
1.68      schwarze  204:                        putchar('.');
1.86      schwarze  205:                if (n->flags & NODE_ID) {
                    206:                        printf(" ID");
                    207:                        if (n->string != NULL)
                    208:                                printf("=%s", n->string);
                    209:                }
                    210:                if (n->flags & NODE_HREF)
                    211:                        printf(" HREF");
1.84      schwarze  212:                if (n->flags & NODE_BROKEN)
1.73      schwarze  213:                        printf(" BROKEN");
1.84      schwarze  214:                if (n->flags & NODE_NOFILL)
                    215:                        printf(" NOFILL");
                    216:                if (n->flags & NODE_NOSRC)
1.70      schwarze  217:                        printf(" NOSRC");
1.84      schwarze  218:                if (n->flags & NODE_NOPRT)
1.70      schwarze  219:                        printf(" NOPRT");
1.68      schwarze  220:                putchar('\n');
1.1       kristaps  221:        }
                    222:
1.59      schwarze  223:        if (n->eqn)
1.77      schwarze  224:                print_box(n->eqn->first, indent + 4);
1.1       kristaps  225:        if (n->child)
1.61      schwarze  226:                print_mdoc(n->child, indent +
1.63      schwarze  227:                    (n->type == ROFFT_BLOCK ? 2 : 4));
1.1       kristaps  228:        if (n->next)
1.11      kristaps  229:                print_mdoc(n->next, indent);
1.1       kristaps  230: }
1.2       kristaps  231:
1.10      kristaps  232: static void
1.64      schwarze  233: print_man(const struct roff_node *n, int indent)
1.10      kristaps  234: {
                    235:        const char       *p, *t;
                    236:        int               i;
                    237:
1.61      schwarze  238:        if (n == NULL)
                    239:                return;
                    240:
1.38      kristaps  241:        t = p = NULL;
                    242:
1.10      kristaps  243:        switch (n->type) {
1.63      schwarze  244:        case ROFFT_ROOT:
1.10      kristaps  245:                t = "root";
                    246:                break;
1.63      schwarze  247:        case ROFFT_ELEM:
1.10      kristaps  248:                t = "elem";
                    249:                break;
1.63      schwarze  250:        case ROFFT_TEXT:
1.10      kristaps  251:                t = "text";
                    252:                break;
1.78      schwarze  253:        case ROFFT_COMMENT:
                    254:                t = "comment";
                    255:                break;
1.63      schwarze  256:        case ROFFT_BLOCK:
1.14      kristaps  257:                t = "block";
                    258:                break;
1.63      schwarze  259:        case ROFFT_HEAD:
1.68      schwarze  260:                t = "head";
1.14      kristaps  261:                break;
1.63      schwarze  262:        case ROFFT_BODY:
1.68      schwarze  263:                t = "body";
1.14      kristaps  264:                break;
1.63      schwarze  265:        case ROFFT_TBL:
1.59      schwarze  266:                break;
1.63      schwarze  267:        case ROFFT_EQN:
1.59      schwarze  268:                t = "eqn";
1.33      kristaps  269:                break;
1.10      kristaps  270:        default:
                    271:                abort();
                    272:        }
                    273:
                    274:        switch (n->type) {
1.63      schwarze  275:        case ROFFT_TEXT:
1.78      schwarze  276:        case ROFFT_COMMENT:
1.10      kristaps  277:                p = n->string;
                    278:                break;
1.63      schwarze  279:        case ROFFT_ELEM:
                    280:        case ROFFT_BLOCK:
                    281:        case ROFFT_HEAD:
                    282:        case ROFFT_BODY:
1.74      schwarze  283:                p = roff_name[n->tok];
1.10      kristaps  284:                break;
1.63      schwarze  285:        case ROFFT_ROOT:
1.10      kristaps  286:                p = "root";
1.25      kristaps  287:                break;
1.63      schwarze  288:        case ROFFT_TBL:
1.59      schwarze  289:                break;
1.63      schwarze  290:        case ROFFT_EQN:
1.59      schwarze  291:                p = "EQ";
1.10      kristaps  292:                break;
                    293:        default:
                    294:                abort();
                    295:        }
                    296:
1.26      kristaps  297:        if (n->span) {
1.38      kristaps  298:                assert(NULL == p && NULL == t);
1.30      kristaps  299:                print_span(n->span, indent);
                    300:        } else {
                    301:                for (i = 0; i < indent; i++)
1.61      schwarze  302:                        putchar(' ');
1.51      schwarze  303:                printf("%s (%s) ", p, t);
1.84      schwarze  304:                if (n->flags & NODE_LINE)
1.51      schwarze  305:                        putchar('*');
1.68      schwarze  306:                printf("%d:%d", n->line, n->pos + 1);
1.84      schwarze  307:                if (n->flags & NODE_DELIMC)
1.79      schwarze  308:                        putchar(')');
1.84      schwarze  309:                if (n->flags & NODE_EOS)
1.68      schwarze  310:                        putchar('.');
1.87    ! schwarze  311:                if (n->flags & NODE_ID) {
        !           312:                        printf(" ID");
        !           313:                        if (n->string != NULL)
        !           314:                                printf("=%s", n->string);
        !           315:                }
1.84      schwarze  316:                if (n->flags & NODE_NOFILL)
                    317:                        printf(" NOFILL");
1.68      schwarze  318:                putchar('\n');
1.30      kristaps  319:        }
1.26      kristaps  320:
1.59      schwarze  321:        if (n->eqn)
1.77      schwarze  322:                print_box(n->eqn->first, indent + 4);
1.10      kristaps  323:        if (n->child)
1.61      schwarze  324:                print_man(n->child, indent +
1.63      schwarze  325:                    (n->type == ROFFT_BLOCK ? 2 : 4));
1.10      kristaps  326:        if (n->next)
1.11      kristaps  327:                print_man(n->next, indent);
1.28      kristaps  328: }
                    329:
                    330: static void
1.38      kristaps  331: print_box(const struct eqn_box *ep, int indent)
                    332: {
                    333:        int              i;
1.46      kristaps  334:        const char      *t;
1.38      kristaps  335:
1.57      schwarze  336:        static const char *posnames[] = {
                    337:            NULL, "sup", "subsup", "sub",
                    338:            "to", "from", "fromto",
                    339:            "over", "sqrt", NULL };
                    340:
1.38      kristaps  341:        if (NULL == ep)
                    342:                return;
                    343:        for (i = 0; i < indent; i++)
1.61      schwarze  344:                putchar(' ');
1.38      kristaps  345:
1.46      kristaps  346:        t = NULL;
1.38      kristaps  347:        switch (ep->type) {
1.52      schwarze  348:        case EQN_LIST:
1.46      kristaps  349:                t = "eqn-list";
1.39      kristaps  350:                break;
1.52      schwarze  351:        case EQN_SUBEXPR:
1.46      kristaps  352:                t = "eqn-expr";
1.39      kristaps  353:                break;
1.52      schwarze  354:        case EQN_TEXT:
1.46      kristaps  355:                t = "eqn-text";
1.39      kristaps  356:                break;
1.56      kristaps  357:        case EQN_PILE:
                    358:                t = "eqn-pile";
                    359:                break;
1.52      schwarze  360:        case EQN_MATRIX:
1.46      kristaps  361:                t = "eqn-matrix";
1.38      kristaps  362:                break;
                    363:        }
1.39      kristaps  364:
1.57      schwarze  365:        fputs(t, stdout);
                    366:        if (ep->pos)
                    367:                printf(" pos=%s", posnames[ep->pos]);
                    368:        if (ep->left)
                    369:                printf(" left=\"%s\"", ep->left);
                    370:        if (ep->right)
                    371:                printf(" right=\"%s\"", ep->right);
                    372:        if (ep->top)
                    373:                printf(" top=\"%s\"", ep->top);
                    374:        if (ep->bottom)
                    375:                printf(" bottom=\"%s\"", ep->bottom);
                    376:        if (ep->text)
                    377:                printf(" text=\"%s\"", ep->text);
                    378:        if (ep->font)
                    379:                printf(" font=%d", ep->font);
                    380:        if (ep->size != EQN_DEFSIZE)
                    381:                printf(" size=%d", ep->size);
                    382:        if (ep->expectargs != UINT_MAX && ep->expectargs != ep->args)
                    383:                printf(" badargs=%zu(%zu)", ep->args, ep->expectargs);
                    384:        else if (ep->args)
                    385:                printf(" args=%zu", ep->args);
                    386:        putchar('\n');
1.46      kristaps  387:
1.61      schwarze  388:        print_box(ep->first, indent + 4);
1.39      kristaps  389:        print_box(ep->next, indent);
1.38      kristaps  390: }
                    391:
                    392: static void
1.85      schwarze  393: print_cellt(enum tbl_cellt pos)
                    394: {
                    395:        switch(pos) {
                    396:        case TBL_CELL_LEFT:
                    397:                putchar('L');
                    398:                break;
                    399:        case TBL_CELL_LONG:
                    400:                putchar('a');
                    401:                break;
                    402:        case TBL_CELL_CENTRE:
                    403:                putchar('c');
                    404:                break;
                    405:        case TBL_CELL_RIGHT:
                    406:                putchar('r');
                    407:                break;
                    408:        case TBL_CELL_NUMBER:
                    409:                putchar('n');
                    410:                break;
                    411:        case TBL_CELL_SPAN:
                    412:                putchar('s');
                    413:                break;
                    414:        case TBL_CELL_DOWN:
                    415:                putchar('^');
                    416:                break;
                    417:        case TBL_CELL_HORIZ:
                    418:                putchar('-');
                    419:                break;
                    420:        case TBL_CELL_DHORIZ:
                    421:                putchar('=');
                    422:                break;
                    423:        case TBL_CELL_MAX:
                    424:                putchar('#');
                    425:                break;
                    426:        }
                    427: }
                    428:
                    429: static void
1.30      kristaps  430: print_span(const struct tbl_span *sp, int indent)
1.28      kristaps  431: {
                    432:        const struct tbl_dat *dp;
1.85      schwarze  433:        const struct tbl_cell *cp;
1.30      kristaps  434:        int              i;
                    435:
1.85      schwarze  436:        if (sp->prev == NULL) {
                    437:                for (i = 0; i < indent; i++)
                    438:                        putchar(' ');
                    439:                printf("%d", sp->opts->cols);
                    440:                if (sp->opts->opts & TBL_OPT_CENTRE)
                    441:                        fputs(" center", stdout);
                    442:                if (sp->opts->opts & TBL_OPT_EXPAND)
                    443:                        fputs(" expand", stdout);
                    444:                if (sp->opts->opts & TBL_OPT_ALLBOX)
                    445:                        fputs(" allbox", stdout);
                    446:                if (sp->opts->opts & TBL_OPT_BOX)
                    447:                        fputs(" box", stdout);
                    448:                if (sp->opts->opts & TBL_OPT_DBOX)
                    449:                        fputs(" doublebox", stdout);
                    450:                if (sp->opts->opts & TBL_OPT_NOKEEP)
                    451:                        fputs(" nokeep", stdout);
                    452:                if (sp->opts->opts & TBL_OPT_NOSPACE)
                    453:                        fputs(" nospaces", stdout);
                    454:                if (sp->opts->opts & TBL_OPT_NOWARN)
                    455:                        fputs(" nowarn", stdout);
                    456:                printf(" (tbl options) %d:1\n", sp->line);
                    457:        }
                    458:
1.30      kristaps  459:        for (i = 0; i < indent; i++)
1.61      schwarze  460:                putchar(' ');
1.28      kristaps  461:
                    462:        switch (sp->pos) {
1.52      schwarze  463:        case TBL_SPAN_HORIZ:
1.28      kristaps  464:                putchar('-');
1.80      schwarze  465:                putchar(' ');
                    466:                break;
1.52      schwarze  467:        case TBL_SPAN_DHORIZ:
1.28      kristaps  468:                putchar('=');
1.80      schwarze  469:                putchar(' ');
                    470:                break;
1.28      kristaps  471:        default:
1.85      schwarze  472:                for (cp = sp->layout->first; cp != NULL; cp = cp->next)
                    473:                        print_cellt(cp->pos);
                    474:                putchar(' ');
1.80      schwarze  475:                for (dp = sp->first; dp; dp = dp->next) {
1.85      schwarze  476:                        if ((cp = dp->layout) == NULL)
                    477:                                putchar('*');
                    478:                        else {
                    479:                                printf("%d", cp->col);
                    480:                                print_cellt(dp->layout->pos);
                    481:                                if (cp->flags & TBL_CELL_BOLD)
                    482:                                        putchar('b');
                    483:                                if (cp->flags & TBL_CELL_ITALIC)
                    484:                                        putchar('i');
                    485:                                if (cp->flags & TBL_CELL_TALIGN)
                    486:                                        putchar('t');
                    487:                                if (cp->flags & TBL_CELL_UP)
                    488:                                        putchar('u');
                    489:                                if (cp->flags & TBL_CELL_BALIGN)
                    490:                                        putchar('d');
                    491:                                if (cp->flags & TBL_CELL_WIGN)
                    492:                                        putchar('z');
                    493:                                if (cp->flags & TBL_CELL_EQUAL)
                    494:                                        putchar('e');
                    495:                                if (cp->flags & TBL_CELL_WMAX)
                    496:                                        putchar('x');
                    497:                        }
1.80      schwarze  498:                        switch (dp->pos) {
                    499:                        case TBL_DATA_HORIZ:
                    500:                        case TBL_DATA_NHORIZ:
                    501:                                putchar('-');
1.85      schwarze  502:                                break;
1.80      schwarze  503:                        case TBL_DATA_DHORIZ:
                    504:                        case TBL_DATA_NDHORIZ:
                    505:                                putchar('=');
1.85      schwarze  506:                                break;
1.80      schwarze  507:                        default:
1.85      schwarze  508:                                putchar(dp->block ? '{' : '[');
                    509:                                if (dp->string != NULL)
                    510:                                        fputs(dp->string, stdout);
                    511:                                putchar(dp->block ? '}' : ']');
1.80      schwarze  512:                                break;
                    513:                        }
                    514:                        if (dp->hspans)
                    515:                                printf(">%d", dp->hspans);
                    516:                        if (dp->vspans)
                    517:                                printf("v%d", dp->vspans);
                    518:                        putchar(' ');
                    519:                }
1.28      kristaps  520:                break;
                    521:        }
1.38      kristaps  522:        printf("(tbl) %d:1\n", sp->line);
1.10      kristaps  523: }

CVSweb