/Users/parrt/antlr/code/antlr/main/runtime/Java/src/main/java/org/antlr/runtime/tree/DOTTreeGenerator.java

Go to the documentation of this file.

/*
 [The "BSD license"]
 Copyright (c) 2005-2009 Terence Parr
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.
 3. The name of the author may not be used to endorse or promote products
     derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.antlr.runtime.tree;

import org.stringtemplate.v4.ST;

import java.util.HashMap;

public class DOTTreeGenerator {

        public static ST _treeST =
                new ST(
                        "digraph {\n\n" +
                        "\tordering=out;\n" +
                        "\tranksep=.4;\n" +
                        "\tbgcolor=\"lightgrey\"; node [shape=box, fixedsize=false, fontsize=12, fontname=\"Helvetica-bold\", fontcolor=\"blue\"\n" +
                        "\t\twidth=.25, height=.25, color=\"black\", fillcolor=\"white\", style=\"filled, solid, bold\"];\n" +
                        "\tedge [arrowsize=.5, color=\"black\", style=\"bold\"]\n\n" +
                        "  <nodes>\n" +
                        "  <edges>\n" +
                        "}\n");

        public static ST _nodeST =
                        new ST("<name> [label=\"<text>\"];\n");

        public static ST _edgeST =
                        new ST("<parent> -> <child> // \"<parentText>\" -> \"<childText>\"\n");

        HashMap nodeToNumberMap = new HashMap();

        int nodeNumber = 0;

        public ST toDOT(Object tree,
                                        TreeAdaptor adaptor,
                                        ST _treeST,
                                        ST _edgeST)
        {
                ST treeST = new ST(_treeST); // dup
                nodeNumber = 0;
                toDOTDefineNodes(tree, adaptor, treeST);
                nodeNumber = 0;
                toDOTDefineEdges(tree, adaptor, treeST);
                return treeST;
        }

        public ST toDOT(Object tree,
                                                                TreeAdaptor adaptor)
        {
                return toDOT(tree, adaptor, _treeST, _edgeST);
        }

        public ST toDOT(Tree tree) {
                return toDOT(tree, new CommonTreeAdaptor());
        }

        protected void toDOTDefineNodes(Object tree,
                                                                        TreeAdaptor adaptor,
                                                                        ST treeST)
        {
                if ( tree==null ) {
                        return;
                }
                int n = adaptor.getChildCount(tree);
                if ( n==0 ) {
                        // must have already dumped as child from previous
                        // invocation; do nothing
                        return;
                }

                // define parent node
                ST parentNodeST = getNodeST(adaptor, tree);
                treeST.add("nodes", parentNodeST);

                // for each child, do a "<unique-name> [label=text]" node def
                for (int i = 0; i < n; i++) {
                        Object child = adaptor.getChild(tree, i);
                        ST nodeST = getNodeST(adaptor, child);
                        treeST.add("nodes", nodeST);
                        toDOTDefineNodes(child, adaptor, treeST);
                }
        }

        protected void toDOTDefineEdges(Object tree,
                                                                        TreeAdaptor adaptor,
                                                                        ST treeST)
        {
                if ( tree==null ) {
                        return;
                }
                int n = adaptor.getChildCount(tree);
                if ( n==0 ) {
                        // must have already dumped as child from previous
                        // invocation; do nothing
                        return;
                }

                String parentName = "n"+getNodeNumber(tree);

                // for each child, do a parent -> child edge using unique node names
                String parentText = adaptor.getText(tree);
                for (int i = 0; i < n; i++) {
                        Object child = adaptor.getChild(tree, i);
                        String childText = adaptor.getText(child);
                        String childName = "n"+getNodeNumber(child);
                        ST edgeST = new ST(_edgeST);
                        edgeST.add("parent", parentName);
                        edgeST.add("child", childName);
                        edgeST.add("parentText", fixString(parentText));
                        edgeST.add("childText", fixString(childText));
                        treeST.add("edges", edgeST);
                        toDOTDefineEdges(child, adaptor, treeST);
                }
        }

        protected ST getNodeST(TreeAdaptor adaptor, Object t) {
                String text = adaptor.getText(t);
                ST nodeST = new ST(_nodeST);
                String uniqueName = "n"+getNodeNumber(t);
                nodeST.add("name", uniqueName);

                nodeST.add("text", fixString(text));
                return nodeST;
        }

        protected int getNodeNumber(Object t) {
                Integer nI = (Integer)nodeToNumberMap.get(t);
                if ( nI!=null ) {
                        return nI.intValue();
                }
                else {
                        nodeToNumberMap.put(t, new Integer(nodeNumber));
                        nodeNumber++;
                        return nodeNumber-1;
                }
        }

    protected String fixString(String in)
    {
        String text = in;

        if (text!=null) {

            text = text.replaceAll("\"", "\\\\\"");
            text = text.replaceAll("\\t", "    ");
            text = text.replaceAll("\\n", "\\\\n");
            text = text.replaceAll("\\r", "\\\\r");
            if  (text.length() > 20)    {
                text = text.substring(0, 8) + "..." + text.substring(text.length()-8);
            }

        }

        return text;
    }
}

---