Only sort the result array if it contains more than one element,

[mandoc.git] / tree.c

diff --git a/tree.c b/tree.c
index 4220ba7d472c47cbc2528159ce7ff9ef18de4b24..7c1c662d234c030a544c80d65134ec544aba691d 100644 (file)
--- a/tree.c
+++ b/tree.c
@@ -1,209 +1,540 @@
-/*     $Id: tree.c,v 1.17 2009/10/26 17:05:44 kristaps Exp $ */
+/* $Id: tree.c,v 1.92 2022/01/12 04:54:05 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2013-2015, 2017-2022 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
  * copyright notice and this permission notice appear in all copies.
  *
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *

- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES

  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR

  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * 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.
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * 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 <sys/types.h>
+

 #include <assert.h>
 #include <assert.h>

-#include <err.h>
+#include <limits.h>

 #include <stdio.h>
 #include <stdlib.h>
 #include <time.h>
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <time.h>
 

+#include "mandoc.h"
+#include "roff.h"

 #include "mdoc.h"
 #include "man.h"
 #include "mdoc.h"
 #include "man.h"

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

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

-static void    print_mdoc(const struct mdoc_node *, int);
-static void    print_man(const struct man_node *, int);
+static void    print_attr(const struct roff_node *);
+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_meta(const struct roff_meta *);
+static void    print_mdoc(const struct roff_node *, int);
+static void    print_span(const struct tbl_span *, int);

 
 
 
 

-/* ARGSUSED */

 void
 void

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

 {
 {

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

 }
 
 }
 

-
-/* ARGSUSED */

 void
 void

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

 {
 {

-
-       print_man(man_node(man), 0);
+       print_meta(man);
+       if (man->hasbody == 0)
+               puts("body  = empty");
+       putchar('\n');
+       print_man(man->first->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

-print_mdoc(const struct mdoc_node *n, int indent)
+print_mdoc(const struct roff_node *n, int indent)

 {
        const char       *p, *t;
        int               i, j;
 {
        const char       *p, *t;
        int               i, j;

-       size_t            argc, sz;
-       char            **params;
+       size_t            argc;

        struct mdoc_argv *argv;
 
        struct mdoc_argv *argv;
 

+       if (n == NULL)
+               return;
+

        argv = NULL;
        argv = NULL;

-       argc = sz = 0;
-       params = NULL;
+       argc = 0;
+       t = p = NULL;

 
        switch (n->type) {
 
        switch (n->type) {

-       case (MDOC_ROOT):
+       case ROFFT_ROOT:

                t = "root";
                break;
                t = "root";
                break;

-       case (MDOC_BLOCK):
+       case ROFFT_BLOCK:

                t = "block";
                break;
                t = "block";
                break;

-       case (MDOC_HEAD):
-               t = "block-head";
+       case ROFFT_HEAD:
+               t = "head";

                break;
                break;

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

                break;
                break;

-       case (MDOC_TAIL):
-               t = "block-tail";
+       case ROFFT_TAIL:
+               t = "tail";

                break;
                break;

-       case (MDOC_ELEM):
+       case ROFFT_ELEM:

                t = "elem";
                break;
                t = "elem";
                break;

-       case (MDOC_TEXT):
+       case ROFFT_TEXT:

                t = "text";
                break;
                t = "text";
                break;

+       case ROFFT_COMMENT:
+               t = "comment";
+               break;
+       case ROFFT_TBL:
+               break;
+       case ROFFT_EQN:
+               t = "eqn";
+               break;

        default:
                abort();
        default:
                abort();

-               /* NOTREACHED */

        }
 
        switch (n->type) {
        }
 
        switch (n->type) {

-       case (MDOC_TEXT):
+       case ROFFT_TEXT:
+       case ROFFT_COMMENT:

                p = n->string;
                break;
                p = n->string;
                break;

-       case (MDOC_BODY):
-               p = mdoc_macronames[n->tok];
+       case ROFFT_BODY:
+               p = roff_name[n->tok];

                break;
                break;

-       case (MDOC_HEAD):
-               p = mdoc_macronames[n->tok];
+       case ROFFT_HEAD:
+               p = roff_name[n->tok];

                break;
                break;

-       case (MDOC_TAIL):
-               p = mdoc_macronames[n->tok];
+       case ROFFT_TAIL:
+               p = roff_name[n->tok];

                break;
                break;

-       case (MDOC_ELEM):
-               p = mdoc_macronames[n->tok];
+       case ROFFT_ELEM:
+               p = roff_name[n->tok];

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

-       case (MDOC_BLOCK):
-               p = mdoc_macronames[n->tok];
+       case ROFFT_BLOCK:
+               p = roff_name[n->tok];

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

-       case (MDOC_ROOT):
+       case ROFFT_TBL:
+               break;
+       case ROFFT_EQN:
+               p = "EQ";
+               break;
+       case ROFFT_ROOT:

                p = "root";
                break;
        default:
                abort();
                p = "root";
                break;
        default:
                abort();

-               /* NOTREACHED */
-       }
-
-       for (i = 0; i < indent; i++)
-               (void)printf("    ");
-       (void)printf("%s (%s)", p, t);
-
-       for (i = 0; i < (int)argc; i++) {
-               (void)printf(" -%s", mdoc_argnames[argv[i].arg]);
-               if (argv[i].sz > 0)
-                       (void)printf(" [");
-               for (j = 0; j < (int)argv[i].sz; j++)
-                       (void)printf(" [%s]", argv[i].value[j]);
-               if (argv[i].sz > 0)
-                       (void)printf(" ]");

        }
 
        }
 

-       for (i = 0; i < (int)sz; i++)
-               (void)printf(" [%s]", params[i]);
+       if (n->span) {
+               assert(NULL == p && NULL == t);
+               print_span(n->span, indent);
+       } else {
+               for (i = 0; i < indent; i++)
+                       putchar(' ');

 
 

-       (void)printf(" %d:%d\n", n->line, n->pos);
+               printf("%s (%s)", p, t);

 
 

+               for (i = 0; i < (int)argc; i++) {
+                       printf(" -%s", mdoc_argnames[argv[i].arg]);
+                       if (argv[i].sz > 0)
+                               printf(" [");
+                       for (j = 0; j < (int)argv[i].sz; j++)
+                               printf(" [%s]", argv[i].value[j]);
+                       if (argv[i].sz > 0)
+                               printf(" ]");
+               }
+               print_attr(n);
+       }
+       if (n->eqn)
+               print_box(n->eqn->first, indent + 4);

        if (n->child)
        if (n->child)

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

        if (n->next)
                print_mdoc(n->next, indent);
 }
 
        if (n->next)
                print_mdoc(n->next, indent);
 }
 

-

 static void
 static void

-print_man(const struct man_node *n, int indent)
+print_man(const struct roff_node *n, int indent)

 {
        const char       *p, *t;
        int               i;
 
 {
        const char       *p, *t;
        int               i;
 

+       if (n == NULL)
+               return;
+
+       t = p = NULL;
+

        switch (n->type) {
        switch (n->type) {

-       case (MAN_ROOT):
+       case ROFFT_ROOT:

                t = "root";
                break;
                t = "root";
                break;

-       case (MAN_ELEM):
+       case ROFFT_ELEM:

                t = "elem";
                break;
                t = "elem";
                break;

-       case (MAN_TEXT):
+       case ROFFT_TEXT:

                t = "text";
                break;
                t = "text";
                break;

-       case (MAN_BLOCK):
+       case ROFFT_COMMENT:
+               t = "comment";
+               break;
+       case ROFFT_BLOCK:

                t = "block";
                break;
                t = "block";
                break;

-       case (MAN_HEAD):
-               t = "block-head";
+       case ROFFT_HEAD:
+               t = "head";
+               break;
+       case ROFFT_BODY:
+               t = "body";
+               break;
+       case ROFFT_TBL:

                break;
                break;

-       case (MAN_BODY):
-               t = "block-body";
+       case ROFFT_EQN:
+               t = "eqn";

                break;
        default:
                abort();
                break;
        default:
                abort();

-               /* NOTREACHED */

        }
 
        switch (n->type) {
        }
 
        switch (n->type) {

-       case (MAN_TEXT):
+       case ROFFT_TEXT:
+       case ROFFT_COMMENT:

                p = n->string;
                break;
                p = n->string;
                break;

-       case (MAN_ELEM):
-               /* FALLTHROUGH */
-       case (MAN_BLOCK):
-               /* FALLTHROUGH */
-       case (MAN_HEAD):
-               /* FALLTHROUGH */
-       case (MAN_BODY):
-               p = man_macronames[n->tok];
+       case ROFFT_ELEM:
+       case ROFFT_BLOCK:
+       case ROFFT_HEAD:
+       case ROFFT_BODY:
+               p = roff_name[n->tok];

                break;
                break;

-       case (MAN_ROOT):
+       case ROFFT_ROOT:

                p = "root";
                break;
                p = "root";
                break;

+       case ROFFT_TBL:
+               break;
+       case ROFFT_EQN:
+               p = "EQ";
+               break;

        default:
                abort();
        default:
                abort();

-               /* NOTREACHED */

        }
 
        }
 

-       for (i = 0; i < indent; i++)
-               (void)printf("    ");
-       (void)printf("%s (%s) %d:%d\n", p, t, n->line, n->pos);
-
+       if (n->span) {
+               assert(NULL == p && NULL == t);
+               print_span(n->span, indent);
+       } else {
+               for (i = 0; i < indent; i++)
+                       putchar(' ');
+               printf("%s (%s)", p, t);
+               print_attr(n);
+       }
+       if (n->eqn)
+               print_box(n->eqn->first, indent + 4);

        if (n->child)
        if (n->child)

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

        if (n->next)
                print_man(n->next, indent);
 }
        if (n->next)
                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)
+{
+       int              i;
+       const char      *t;
+
+       static const char *posnames[] = {
+           NULL, "sup", "subsup", "sub",
+           "to", "from", "fromto",
+           "over", "sqrt", NULL };
+
+       if (NULL == ep)
+               return;
+       for (i = 0; i < indent; i++)
+               putchar(' ');
+
+       t = NULL;
+       switch (ep->type) {
+       case EQN_LIST:
+               t = "eqn-list";
+               break;
+       case EQN_SUBEXPR:
+               t = "eqn-expr";
+               break;
+       case EQN_TEXT:
+               t = "eqn-text";
+               break;
+       case EQN_PILE:
+               t = "eqn-pile";
+               break;
+       case EQN_MATRIX:
+               t = "eqn-matrix";
+               break;
+       }
+
+       fputs(t, stdout);
+       if (ep->pos)
+               printf(" pos=%s", posnames[ep->pos]);
+       if (ep->left)
+               printf(" left=\"%s\"", ep->left);
+       if (ep->right)
+               printf(" right=\"%s\"", ep->right);
+       if (ep->top)
+               printf(" top=\"%s\"", ep->top);
+       if (ep->bottom)
+               printf(" bottom=\"%s\"", ep->bottom);
+       if (ep->text)
+               printf(" text=\"%s\"", ep->text);
+       if (ep->font)
+               printf(" font=%d", ep->font);
+       if (ep->size != EQN_DEFSIZE)
+               printf(" size=%d", ep->size);
+       if (ep->expectargs != UINT_MAX && ep->expectargs != ep->args)
+               printf(" badargs=%zu(%zu)", ep->args, ep->expectargs);
+       else if (ep->args)
+               printf(" args=%zu", ep->args);
+       putchar('\n');
+
+       print_box(ep->first, indent + 4);
+       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;
+       const struct tbl_cell *cp;
+       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('-');
+               putchar(' ');
+               break;
+       case TBL_SPAN_DHORIZ:
+               putchar('=');
+               putchar(' ');
+               break;
+       default:
+               for (cp = sp->layout->first; cp != NULL; cp = cp->next)
+                       print_cellt(cp->pos);
+               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_NHORIZ:
+                               putchar('\\');
+                               /* FALLTHROUGH */
+                       case TBL_DATA_HORIZ:
+                               putchar('_');
+                               break;
+                       case TBL_DATA_NDHORIZ:
+                               putchar('\\');
+                               /* FALLTHROUGH */
+                       case TBL_DATA_DHORIZ:
+                               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);
+}