two typos; patch from Raf Czlonka <rczlonka at gmail dot com>

[mandoc.git] / tree.c

diff --git a/tree.c b/tree.c
index d7cd037b3b87a296be3ba5dbbbf62c97a6653dd5..12e841a50b78dde81891c5289c05d18db16ec5e3 100644 (file)
--- a/tree.c
+++ b/tree.c
@@ -1,7 +1,7 @@
-/*     $Id: tree.c,v 1.64 2015/04/02 22:48:18 schwarze Exp $ */
+/* $Id: tree.c,v 1.91 2021/09/07 10:59:18 schwarze Exp $ */

 /*
  * Copyright (c) 2008, 2009, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
 /*
  * Copyright (c) 2008, 2009, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>

- * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2013-2015, 2017-2021 Ingo Schwarze <schwarze@openbsd.org>

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -14,6 +14,9 @@
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

+ *
+ * Formatting module to let mandoc(1) show
+ * a human readable representation of the syntax tree.

  */
 #include "config.h"
 
  */
 #include "config.h"
 


@@ -29,26 +32,54 @@
 #include "roff.h"
 #include "mdoc.h"
 #include "man.h"
 #include "roff.h"
 #include "mdoc.h"
 #include "man.h"

+#include "tbl.h"
+#include "eqn.h"

 #include "main.h"
 
 #include "main.h"
 

+static void    print_attr(const struct roff_node *);

 static void    print_box(const struct eqn_box *, int);
 static void    print_box(const struct eqn_box *, int);

+static void    print_cellt(enum tbl_cellt);

 static void    print_man(const struct roff_node *, int);
 static void    print_man(const struct roff_node *, int);

+static void    print_meta(const struct roff_meta *);

 static void    print_mdoc(const struct roff_node *, int);
 static void    print_span(const struct tbl_span *, int);
 
 
 void
 static void    print_mdoc(const struct roff_node *, int);
 static void    print_span(const struct tbl_span *, int);
 
 
 void

-tree_mdoc(void *arg, const struct mdoc *mdoc)
+tree_mdoc(void *arg, const struct roff_meta *mdoc)

 {
 {

-
-       print_mdoc(mdoc_node(mdoc)->child, 0);
+       print_meta(mdoc);
+       putchar('\n');
+       print_mdoc(mdoc->first->child, 0);

 }
 
 void
 }
 
 void

-tree_man(void *arg, const struct man *man)
+tree_man(void *arg, const struct roff_meta *man)

 {
 {

+       print_meta(man);
+       if (man->hasbody == 0)
+               puts("body  = empty");
+       putchar('\n');
+       print_man(man->first->child, 0);
+}

 
 

-       print_man(man_node(man)->child, 0);
+static void
+print_meta(const struct roff_meta *meta)
+{
+       if (meta->title != NULL)
+               printf("title = \"%s\"\n", meta->title);
+       if (meta->name != NULL)
+               printf("name  = \"%s\"\n", meta->name);
+       if (meta->msec != NULL)
+               printf("sec   = \"%s\"\n", meta->msec);
+       if (meta->vol != NULL)
+               printf("vol   = \"%s\"\n", meta->vol);
+       if (meta->arch != NULL)
+               printf("arch  = \"%s\"\n", meta->arch);
+       if (meta->os != NULL)
+               printf("os    = \"%s\"\n", meta->os);
+       if (meta->date != NULL)
+               printf("date  = \"%s\"\n", meta->date);

 }
 
 static void
 }
 
 static void


@@ -74,16 +105,16 @@ print_mdoc(const struct roff_node *n, int indent)
                t = "block";
                break;
        case ROFFT_HEAD:
                t = "block";
                break;
        case ROFFT_HEAD:

-               t = "block-head";
+               t = "head";

                break;
        case ROFFT_BODY:
                if (n->end)
                        t = "body-end";
                else
                break;
        case ROFFT_BODY:
                if (n->end)
                        t = "body-end";
                else

-                       t = "block-body";
+                       t = "body";

                break;
        case ROFFT_TAIL:
                break;
        case ROFFT_TAIL:

-               t = "block-tail";
+               t = "tail";

                break;
        case ROFFT_ELEM:
                t = "elem";
                break;
        case ROFFT_ELEM:
                t = "elem";


@@ -91,6 +122,9 @@ print_mdoc(const struct roff_node *n, int indent)
        case ROFFT_TEXT:
                t = "text";
                break;
        case ROFFT_TEXT:
                t = "text";
                break;

+       case ROFFT_COMMENT:
+               t = "comment";
+               break;

        case ROFFT_TBL:
                break;
        case ROFFT_EQN:
        case ROFFT_TBL:
                break;
        case ROFFT_EQN:


@@ -98,31 +132,31 @@ print_mdoc(const struct roff_node *n, int indent)
                break;
        default:
                abort();
                break;
        default:
                abort();

-               /* NOTREACHED */

        }
 
        switch (n->type) {
        case ROFFT_TEXT:
        }
 
        switch (n->type) {
        case ROFFT_TEXT:

+       case ROFFT_COMMENT:

                p = n->string;
                break;
        case ROFFT_BODY:
                p = n->string;
                break;
        case ROFFT_BODY:

-               p = mdoc_macronames[n->tok];
+               p = roff_name[n->tok];

                break;
        case ROFFT_HEAD:
                break;
        case ROFFT_HEAD:

-               p = mdoc_macronames[n->tok];
+               p = roff_name[n->tok];

                break;
        case ROFFT_TAIL:
                break;
        case ROFFT_TAIL:

-               p = mdoc_macronames[n->tok];
+               p = roff_name[n->tok];

                break;
        case ROFFT_ELEM:
                break;
        case ROFFT_ELEM:

-               p = mdoc_macronames[n->tok];
+               p = roff_name[n->tok];

                if (n->args) {
                        argv = n->args->argv;
                        argc = n->args->argc;
                }
                break;
        case ROFFT_BLOCK:
                if (n->args) {
                        argv = n->args->argv;
                        argc = n->args->argc;
                }
                break;
        case ROFFT_BLOCK:

-               p = mdoc_macronames[n->tok];
+               p = roff_name[n->tok];

                if (n->args) {
                        argv = n->args->argv;
                        argc = n->args->argc;
                if (n->args) {
                        argv = n->args->argv;
                        argc = n->args->argc;


@@ -138,7 +172,6 @@ print_mdoc(const struct roff_node *n, int indent)
                break;
        default:
                abort();
                break;
        default:
                abort();

-               /* NOTREACHED */

        }
 
        if (n->span) {
        }
 
        if (n->span) {


@@ -159,15 +192,10 @@ print_mdoc(const struct roff_node *n, int indent)
                        if (argv[i].sz > 0)
                                printf(" ]");
                }
                        if (argv[i].sz > 0)
                                printf(" ]");
                }

-
-               putchar(' ');
-               if (MDOC_LINE & n->flags)
-                       putchar('*');
-               printf("%d:%d\n", n->line, n->pos + 1);
+               print_attr(n);

        }
        }

-

        if (n->eqn)
        if (n->eqn)

-               print_box(n->eqn->root->first, indent + 4);
+               print_box(n->eqn->first, indent + 4);

        if (n->child)
                print_mdoc(n->child, indent +
                    (n->type == ROFFT_BLOCK ? 2 : 4));
        if (n->child)
                print_mdoc(n->child, indent +
                    (n->type == ROFFT_BLOCK ? 2 : 4));


@@ -196,14 +224,17 @@ print_man(const struct roff_node *n, int indent)
        case ROFFT_TEXT:
                t = "text";
                break;
        case ROFFT_TEXT:
                t = "text";
                break;

+       case ROFFT_COMMENT:
+               t = "comment";
+               break;

        case ROFFT_BLOCK:
                t = "block";
                break;
        case ROFFT_HEAD:
        case ROFFT_BLOCK:
                t = "block";
                break;
        case ROFFT_HEAD:

-               t = "block-head";
+               t = "head";

                break;
        case ROFFT_BODY:
                break;
        case ROFFT_BODY:

-               t = "block-body";
+               t = "body";

                break;
        case ROFFT_TBL:
                break;
                break;
        case ROFFT_TBL:
                break;


@@ -212,21 +243,18 @@ print_man(const struct roff_node *n, int indent)
                break;
        default:
                abort();
                break;
        default:
                abort();

-               /* NOTREACHED */

        }
 
        switch (n->type) {
        case ROFFT_TEXT:
        }
 
        switch (n->type) {
        case ROFFT_TEXT:

+       case ROFFT_COMMENT:

                p = n->string;
                break;
        case ROFFT_ELEM:
                p = n->string;
                break;
        case ROFFT_ELEM:

-               /* FALLTHROUGH */

        case ROFFT_BLOCK:
        case ROFFT_BLOCK:

-               /* FALLTHROUGH */

        case ROFFT_HEAD:
        case ROFFT_HEAD:

-               /* FALLTHROUGH */

        case ROFFT_BODY:
        case ROFFT_BODY:

-               p = man_macronames[n->tok];
+               p = roff_name[n->tok];

                break;
        case ROFFT_ROOT:
                p = "root";
                break;
        case ROFFT_ROOT:
                p = "root";


@@ -238,7 +266,6 @@ print_man(const struct roff_node *n, int indent)
                break;
        default:
                abort();
                break;
        default:
                abort();

-               /* NOTREACHED */

        }
 
        if (n->span) {
        }
 
        if (n->span) {


@@ -247,14 +274,11 @@ print_man(const struct roff_node *n, int indent)
        } else {
                for (i = 0; i < indent; i++)
                        putchar(' ');
        } else {
                for (i = 0; i < indent; i++)
                        putchar(' ');

-               printf("%s (%s) ", p, t);
-               if (MAN_LINE & n->flags)
-                       putchar('*');
-               printf("%d:%d\n", n->line, n->pos + 1);
+               printf("%s (%s)", p, t);
+               print_attr(n);

        }
        }

-

        if (n->eqn)
        if (n->eqn)

-               print_box(n->eqn->root->first, indent + 4);
+               print_box(n->eqn->first, indent + 4);

        if (n->child)
                print_man(n->child, indent +
                    (n->type == ROFFT_BLOCK ? 2 : 4));
        if (n->child)
                print_man(n->child, indent +
                    (n->type == ROFFT_BLOCK ? 2 : 4));


@@ -262,6 +286,40 @@ print_man(const struct roff_node *n, int indent)
                print_man(n->next, indent);
 }
 
                print_man(n->next, indent);
 }
 

+static void
+print_attr(const struct roff_node *n)
+{
+       putchar(' ');
+       if (n->flags & NODE_DELIMO)
+               putchar('(');
+       if (n->flags & NODE_LINE)
+               putchar('*');
+       printf("%d:%d", n->line, n->pos + 1);
+       if (n->flags & NODE_DELIMC)
+               putchar(')');
+       if (n->flags & NODE_EOS)
+               putchar('.');
+       if (n->flags & NODE_ID) {
+               printf(" ID");
+               if (n->flags & NODE_HREF)
+                       printf("=HREF");
+       } else if (n->flags & NODE_HREF)
+               printf(" HREF");
+       else if (n->tag != NULL)
+               printf(" STRAYTAG");
+       if (n->tag != NULL)
+               printf("=%s", n->tag);
+       if (n->flags & NODE_BROKEN)
+               printf(" BROKEN");
+       if (n->flags & NODE_NOFILL)
+               printf(" NOFILL");
+       if (n->flags & NODE_NOSRC)
+               printf(" NOSRC");
+       if (n->flags & NODE_NOPRT)
+               printf(" NOPRT");
+       putchar('\n');
+}
+

 static void
 print_box(const struct eqn_box *ep, int indent)
 {
 static void
 print_box(const struct eqn_box *ep, int indent)
 {


@@ -280,10 +338,6 @@ print_box(const struct eqn_box *ep, int indent)
 
        t = NULL;
        switch (ep->type) {
 
        t = NULL;
        switch (ep->type) {

-       case EQN_ROOT:
-               t = "eqn-root";
-               break;
-       case EQN_LISTONE:

        case EQN_LIST:
                t = "eqn-list";
                break;
        case EQN_LIST:
                t = "eqn-list";
                break;


@@ -328,49 +382,155 @@ print_box(const struct eqn_box *ep, int indent)
        print_box(ep->next, indent);
 }
 
        print_box(ep->next, indent);
 }
 

+static void
+print_cellt(enum tbl_cellt pos)
+{
+       switch(pos) {
+       case TBL_CELL_LEFT:
+               putchar('L');
+               break;
+       case TBL_CELL_LONG:
+               putchar('a');
+               break;
+       case TBL_CELL_CENTRE:
+               putchar('c');
+               break;
+       case TBL_CELL_RIGHT:
+               putchar('r');
+               break;
+       case TBL_CELL_NUMBER:
+               putchar('n');
+               break;
+       case TBL_CELL_SPAN:
+               putchar('s');
+               break;
+       case TBL_CELL_DOWN:
+               putchar('^');
+               break;
+       case TBL_CELL_HORIZ:
+               putchar('-');
+               break;
+       case TBL_CELL_DHORIZ:
+               putchar('=');
+               break;
+       case TBL_CELL_MAX:
+               putchar('#');
+               break;
+       }
+}
+

 static void
 print_span(const struct tbl_span *sp, int indent)
 {
        const struct tbl_dat *dp;
 static void
 print_span(const struct tbl_span *sp, int indent)
 {
        const struct tbl_dat *dp;

+       const struct tbl_cell *cp;

        int              i;
 
        int              i;
 

+       if (sp->prev == NULL) {
+               for (i = 0; i < indent; i++)
+                       putchar(' ');
+               printf("%d", sp->opts->cols);
+               if (sp->opts->opts & TBL_OPT_CENTRE)
+                       fputs(" center", stdout);
+               if (sp->opts->opts & TBL_OPT_EXPAND)
+                       fputs(" expand", stdout);
+               if (sp->opts->opts & TBL_OPT_ALLBOX)
+                       fputs(" allbox", stdout);
+               if (sp->opts->opts & TBL_OPT_BOX)
+                       fputs(" box", stdout);
+               if (sp->opts->opts & TBL_OPT_DBOX)
+                       fputs(" doublebox", stdout);
+               if (sp->opts->opts & TBL_OPT_NOKEEP)
+                       fputs(" nokeep", stdout);
+               if (sp->opts->opts & TBL_OPT_NOSPACE)
+                       fputs(" nospaces", stdout);
+               if (sp->opts->opts & TBL_OPT_NOWARN)
+                       fputs(" nowarn", stdout);
+               printf(" (tbl options) %d:1\n", sp->line);
+       }
+

        for (i = 0; i < indent; i++)
                putchar(' ');
 
        switch (sp->pos) {
        case TBL_SPAN_HORIZ:
                putchar('-');
        for (i = 0; i < indent; i++)
                putchar(' ');
 
        switch (sp->pos) {
        case TBL_SPAN_HORIZ:
                putchar('-');

-               return;
+               putchar(' ');
+               break;

        case TBL_SPAN_DHORIZ:
                putchar('=');
        case TBL_SPAN_DHORIZ:
                putchar('=');

-               return;
-       default:
+               putchar(' ');

                break;
                break;

-       }
-
-       for (dp = sp->first; dp; dp = dp->next) {
-               switch (dp->pos) {
-               case TBL_DATA_HORIZ:
-                       /* FALLTHROUGH */
-               case TBL_DATA_NHORIZ:
-                       putchar('-');
-                       continue;
-               case TBL_DATA_DHORIZ:
-                       /* FALLTHROUGH */
-               case TBL_DATA_NDHORIZ:
-                       putchar('=');
-                       continue;
-               default:
-                       break;
-               }
-               printf("[\"%s\"", dp->string ? dp->string : "");
-               if (dp->spans)
-                       printf("(%d)", dp->spans);
-               if (NULL == dp->layout)
-                       putchar('*');
-               putchar(']');
+       default:
+               for (cp = sp->layout->first; cp != NULL; cp = cp->next)
+                       print_cellt(cp->pos);

                putchar(' ');
                putchar(' ');

+               for (dp = sp->first; dp; dp = dp->next) {
+                       if ((cp = dp->layout) == NULL)
+                               putchar('*');
+                       else {
+                               printf("%d", cp->col);
+                               print_cellt(dp->layout->pos);
+                               switch (cp->font) {
+                               case ESCAPE_FONTROMAN:
+                                       break;
+                               case ESCAPE_FONTBOLD:
+                                       putchar('b');
+                                       break;
+                               case ESCAPE_FONTITALIC:
+                                       putchar('i');
+                                       break;
+                               case ESCAPE_FONTBI:
+                                       fputs("bi", stdout);
+                                       break;
+                               case ESCAPE_FONTCR:
+                                       putchar('c');
+                                       break;
+                               case ESCAPE_FONTCB:
+                                       fputs("cb", stdout);
+                                       break;
+                               case ESCAPE_FONTCI:
+                                       fputs("ci", stdout);
+                                       break;
+                               default:
+                                       abort();
+                               }
+                               if (cp->flags & TBL_CELL_TALIGN)
+                                       putchar('t');
+                               if (cp->flags & TBL_CELL_UP)
+                                       putchar('u');
+                               if (cp->flags & TBL_CELL_BALIGN)
+                                       putchar('d');
+                               if (cp->flags & TBL_CELL_WIGN)
+                                       putchar('z');
+                               if (cp->flags & TBL_CELL_EQUAL)
+                                       putchar('e');
+                               if (cp->flags & TBL_CELL_WMAX)
+                                       putchar('x');
+                       }
+                       switch (dp->pos) {
+                       case TBL_DATA_HORIZ:
+                       case TBL_DATA_NHORIZ:
+                               putchar('-');
+                               break;
+                       case TBL_DATA_DHORIZ:
+                       case TBL_DATA_NDHORIZ:
+                               putchar('=');
+                               break;
+                       default:
+                               putchar(dp->block ? '{' : '[');
+                               if (dp->string != NULL)
+                                       fputs(dp->string, stdout);
+                               putchar(dp->block ? '}' : ']');
+                               break;
+                       }
+                       if (dp->hspans)
+                               printf(">%d", dp->hspans);
+                       if (dp->vspans)
+                               printf("v%d", dp->vspans);
+                       putchar(' ');
+               }
+               break;

        }
        }

-

        printf("(tbl) %d:1\n", sp->line);
 }
        printf("(tbl) %d:1\n", sp->line);
 }