initial version of svg shape analyzer

Signed-off-by: Stefan Niederhauser <[email protected]>

Author: nidi3

graphviz-java/src/main/java/guru/nidi/graphviz/engine/EngineResult.java

@@ -18,9 +18,13 @@
 import javax.annotation.Nullable;
 import java.io.File;
 import java.io.IOException;
+import java.nio.file.Files;
 import java.util.Objects;
 import java.util.function.Consumer;
 import java.util.function.Function;
+import java.util.stream.Stream;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
 
 public final class EngineResult {
     @Nullable
@@ -60,6 +64,10 @@ public <T> T map(Function<File, T> fileMapper, Function<String, T> stringMapper)
         return res;
     }
 
+    public String asString() throws IOException {
+        return mapIO(EngineResult::readFile, string -> string);
+    }
+
     <T> T mapIO(IOFunction<File, T> fileMapper, IOFunction<String, T> stringMapper) throws IOException {
         final T res = string == null ? fileMapper.apply(file) : stringMapper.apply(string);
         close();
@@ -72,6 +80,14 @@ private void close() {
         }
     }
 
+    private static String readFile(File file) throws IOException {
+        final StringBuilder s = new StringBuilder();
+        try (Stream<String> stream = Files.lines(file.toPath(), UTF_8)) {
+            stream.forEach(line -> s.append(line).append("\n"));
+        }
+        return s.toString();
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {

graphviz-java/src/main/java/guru/nidi/graphviz/engine/SvgSizeAdjuster.java

@@ -15,6 +15,7 @@
  */
 package guru.nidi.graphviz.engine;
 
+import guru.nidi.graphviz.model.SvgSizeAnalyzer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -44,10 +45,10 @@ private static String withoutPrefix(String svg) {
 
     private static String pointsToPixels(String svg, double dpi, int width, int height, double scale) {
         try {
-            final SvgSizeAnalyzer analyzer = new SvgSizeAnalyzer(svg);
+            final SvgSizeAnalyzer analyzer = SvgSizeAnalyzer.svg(svg);
             setSize(analyzer, width, height, scale);
             setScale(analyzer, dpi);
-            return analyzer.adjusted();
+            return analyzer.getSvg();
         } catch (IllegalArgumentException e) {
             LOG.warn(e.getMessage());
             return svg;

graphviz-java/src/main/java/guru/nidi/graphviz/model/GraphElementFinder.java

@@ -20,6 +20,7 @@
 
 import java.util.List;
 import java.util.Map;
+import java.util.function.Consumer;
 
 import static java.util.stream.Collectors.toMap;
 
@@ -28,6 +29,12 @@ public class GraphElementFinder extends SvgElementFinder {
     private final Map<String, Link> links;
     private final Map<String, MutableGraph> graphs;
 
+    public static String use(String svg, Graph g, Consumer<GraphElementFinder> actions) {
+        final GraphElementFinder finder = new SvgElementFinder(svg).fromGraph(g);
+        actions.accept(finder);
+        return finder.getSvg();
+    }
+
     GraphElementFinder(SvgElementFinder finder, MutableGraph graph) {
         super(finder);
         nodes = graph.nodes().stream().collect(toMap(n -> name(n), n -> n));

graphviz-java/src/main/java/guru/nidi/graphviz/model/SvgElementFinder.java

@@ -46,7 +46,7 @@ public class SvgElementFinder {
             EXPR_NODE = pathExpression(X_PATH, "//g[contains(@class,'node')]"),
             EXPR_EDGE = pathExpression(X_PATH, "//g[contains(@class,'edge')]"),
             EXPR_CLUSTER = pathExpression(X_PATH, "//g[contains(@class,'cluster')]");
-    private final Document doc;
+    protected final Document doc;
     private final boolean hasHeader;
 
     public static String use(String svg, Consumer<SvgElementFinder> actions) {
@@ -120,7 +120,7 @@ public List<Element> findLinks() {
 
     public static List<String> linkedNodeNamesOf(Element e) {
         final String name = e.getElementsByTagName("title").item(0).getTextContent();
-        return asList(name.split("--"));
+        return asList(name.split(name.contains("--") ? "--" : "->"));
     }
 
     @Nullable

graphviz-java/src/main/java/guru/nidi/graphviz/model/SvgShapeAnalyzer.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright © 2015 Stefan Niederhauser ([email protected])
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package guru.nidi.graphviz.model;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.w3c.dom.Element;
+import org.w3c.dom.NodeList;
+
+import javax.annotation.Nullable;
+import java.awt.*;
+
+public class SvgShapeAnalyzer extends SvgElementFinder {
+    private static final Logger LOG = LoggerFactory.getLogger(SvgShapeAnalyzer.class);
+
+    private final double xFactor;
+    private final double yFactor;
+    private final SvgSizeAnalyzer transform;
+
+    public SvgShapeAnalyzer(SvgElementFinder finder, int width, int height) {
+        super(finder);
+        final String viewBox = finder.doc.getDocumentElement().getAttribute("viewBox");
+        final String[] viewBoxParts = viewBox.split(" ");
+        xFactor = width / Double.parseDouble(viewBoxParts[2]);
+        yFactor = height / Double.parseDouble(viewBoxParts[3]);
+        final Element g = (Element) finder.doc.getDocumentElement().getElementsByTagName("g").item(0);
+        transform = SvgSizeAnalyzer.transform(g.getAttribute("transform"));
+    }
+
+    @Nullable
+    public Rectangle getBoundingBox(Element e) {
+        if (!e.getAttribute("class").contains("node")) {
+            LOG.error("Currently only nodes are supported.");
+            return null;
+        }
+        final NodeList ellipses = e.getElementsByTagName("ellipse");
+        if (ellipses.getLength() == 0) {
+            LOG.error("Currently only nodes with shape ellipse supported.");
+            return null;
+        }
+        final Element ellipse = (Element) ellipses.item(0);
+        final double cx = xFactor * (numAttr(ellipse, "cx") + transform.getTranslateX());
+        final double cy = yFactor * (numAttr(ellipse, "cy") + transform.getTranslateY());
+        final double rx = xFactor * numAttr(ellipse, "rx");
+        final double ry = yFactor * numAttr(ellipse, "ry");
+        return new Rectangle((int) Math.round(cx - rx), (int) Math.round(cy - ry),
+                (int) Math.round(2 * rx), (int) Math.round(2 * ry));
+    }
+
+    private double numAttr(Element e, String attr) {
+        return Double.parseDouble(e.getAttribute(attr));
+    }
+}

graphviz-java/src/main/java/guru/nidi/graphviz/engine/SvgSizeAnalyzer.java renamed to graphviz-java/src/main/java/guru/nidi/graphviz/model/SvgSizeAnalyzer.java

@@ -13,21 +13,24 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package guru.nidi.graphviz.engine;
+package guru.nidi.graphviz.model;
 
 import javax.annotation.Nullable;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 import static java.util.regex.Pattern.DOTALL;
 
-class SvgSizeAnalyzer {
+public final class SvgSizeAnalyzer {
+    private static final Pattern TRANSFORM_PATTERN = Pattern.compile(
+            "scale\\((?<scaleX>[0-9.]+) (?<scaleY>[0-9.]+)\\) "
+                    + "rotate\\((?<rotate>[0-9.]+)\\) "
+                    + "translate\\((?<translateX>[0-9.]+) (?<translateY>[0-9.]+)\\)",
+            DOTALL);
     private static final Pattern SVG_PATTERN = Pattern.compile(
             "<svg width=\"(?<width>\\d+)(?<unit>p[tx])\" height=\"(?<height>\\d+)p[tx]\""
                     + "(?<between>.*?>\\R<g.*?)transform=\""
-                    + "scale\\((?<scaleX>[0-9.]+) (?<scaleY>[0-9.]+)\\) "
-                    + "rotate\\((?<rotate>[0-9.]+)\\) "
-                    + "translate\\((?<translateX>[0-9.]+) (?<translateY>[0-9.]+)\\)",
+                    + TRANSFORM_PATTERN.pattern(),
             DOTALL);
     private final Matcher matcher;
     @Nullable
@@ -38,26 +41,48 @@ class SvgSizeAnalyzer {
     private Double scaleX;
     @Nullable
     private Double scaleY;
+    @Nullable
+    private Double rotate;
+    @Nullable
+    private Double translateX;
+    @Nullable
+    private Double translateY;
+
+    public static SvgSizeAnalyzer svg(String svg) {
+        return new SvgSizeAnalyzer(SVG_PATTERN, svg);
+    }
+
+    public static SvgSizeAnalyzer transform(String transform) {
+        return new SvgSizeAnalyzer(TRANSFORM_PATTERN, transform);
+    }
 
-    SvgSizeAnalyzer(String svg) {
-        matcher = SVG_PATTERN.matcher(svg);
+    private SvgSizeAnalyzer(Pattern pattern, String input) {
+        matcher = pattern.matcher(input);
         if (!matcher.find()) {
             throw new IllegalArgumentException("Generated SVG has not the expected format. "
                     + "There might be image size problems.");
         }
     }
 
-    public String adjusted() {
+    public String getSvg() {
         final String size = width == null
                 ? "width=\"" + getWidth() + getUnit() + "\" height=\"" + getHeight() + getUnit() + "\""
                 : "width=\"" + width + "px\" height=\"" + height + "px\"";
+        return matcher.replaceFirst("<svg " + size + matcher.group("between")
+                + "transform=\"" + getTransform());
+    }
+
+    public String getTransform() {
         final String scale = scaleX == null
                 ? "scale(" + getScaleX() + " " + getScaleY() + ") "
                 : "scale(" + scaleX + " " + scaleY + ") ";
-        final String rotate = "rotate(" + getRotate() + ") ";
-        final String translate = "translate(" + getTranslateX() + " " + getTranslateY() + ")";
-        return matcher.replaceFirst("<svg " + size + matcher.group("between") +
-                "transform=\"" + scale + rotate + translate);
+        final String rot = rotate == null
+                ? "rotate(" + getRotate() + ") "
+                : "rotate(" + rotate + ") ";
+        final String translate = translateX == null
+                ? "translate(" + getTranslateX() + " " + getTranslateY() + ")"
+                : "translate(" + translateX + " " + translateY + ")";
+        return scale + rot + translate;
     }
 
     public int getWidth() {
@@ -101,4 +126,13 @@ public void setScale(double scaleX, double scaleY) {
         this.scaleX = scaleX;
         this.scaleY = scaleY;
     }
+
+    public void setRotate(double rotate) {
+        this.rotate = rotate;
+    }
+
+    public void setTranslate(double translateX, double translateY) {
+        this.translateX = translateX;
+        this.translateY = translateY;
+    }
 }

graphviz-java/src/test/java/guru/nidi/graphviz/CodeAnalysisTest.java

@@ -110,11 +110,11 @@ protected PmdResult analyzePmd() {
                 .because("it's ok here",
                         In.loc("Rasterizer#getDefault").ignore("CompareObjectsWithEquals"),
                         In.locs("Format", "AttributeConfigs").ignore("AvoidDuplicateLiterals"),
-                        In.locs("LabelTest", "RankTest", "*DatatypeTest", "AttributeValidatorTest", "ParserTest", "JavascriptEngineTest", "GraphvizServerTest", "SvgElementFinderTest")
+                        In.locs("LabelTest", "RankTest", "*DatatypeTest", "AttributeValidatorTest", "ParserTest", "JavascriptEngineTest", "GraphvizServerTest", "SvgElementFinderTest", "SvgSizeAnalyzerTest")
                                 .ignore("JUnitTestContainsTooManyAsserts"),
                         In.locs("DatatypeTest").ignore("TestClassWithoutTestCases"),
                         In.loc("SerializerImpl").ignore("AvoidStringBufferField", "CompareObjectsWithEquals"),
-                        In.locs("ThrowingFunction", "GraphvizLoader", "GraphvizServerTest").ignore("AvoidThrowingRawExceptionTypes", "AvoidCatchingGenericException"),
+                        In.locs("ThrowingFunction", "GraphvizLoader", "GraphvizServerTest", "GraphvizPanel").ignore("AvoidThrowingRawExceptionTypes", "AvoidCatchingGenericException"),
                         In.locs("GraphvizServer", "SerializerImpl").ignore("AvoidInstantiatingObjectsInLoops"),
                         In.clazz(Shape.class).ignore("AvoidFieldNameMatchingTypeName"),
                         In.locs("CommandRunnerTest", "EngineResultTest", "GraphvizServerTest").ignore("JUnitTestsShouldIncludeAssert"),
@@ -160,7 +160,7 @@ protected CpdResult analyzeCpd() {
     protected CheckstyleResult analyzeCheckstyle() {
         final StyleEventCollector collector = new StyleEventCollector()
                 .apply(CheckstyleConfigs.minimalCheckstyleIgnore())
-                .just(In.locs("Color", "Arrow", "Rank", "Shape", "Token", "Style", "Options", "Records", "SystemUtils", "GraphAttr").ignore("empty.line.separator"))
+                .just(In.locs("Color", "Arrow", "Rank", "Shape", "Token", "Style", "Options", "Records", "SystemUtils", "GraphAttr", "SvgElementFinder").ignore("empty.line.separator"))
                 .just(In.locs("EngineResult", "IOFunction").ignore("abbreviation.as.word"))
                 .just(In.clazz(Renderer.class).ignore("indentation.error"));
         final StyleChecks checks = CheckstyleConfigs.adjustedGoogleStyleChecks();

graphviz-java/src/test/java/guru/nidi/graphviz/GraphvizPanel.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright © 2015 Stefan Niederhauser ([email protected])
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package guru.nidi.graphviz;
+
+import guru.nidi.graphviz.engine.*;
+import guru.nidi.graphviz.model.*;
+
+import javax.swing.*;
+import java.awt.*;
+import java.awt.event.MouseEvent;
+import java.awt.image.BufferedImage;
+import java.io.IOException;
+import java.util.*;
+import java.util.List;
+
+import static guru.nidi.graphviz.engine.Format.PNG;
+import static java.util.stream.Collectors.toList;
+
+class GraphvizPanel extends JPanel {
+    private final Dimension size;
+    private final BufferedImage img;
+    private double scaleX = 1, scaleY = 1;
+    private List<Map.Entry<Rectangle, String>> boxes;
+
+    GraphvizPanel(Graph g, Dimension size) {
+        this.size = size;
+        img = Graphviz.fromGraph(g).postProcessor((EngineResult source, Options options, ProcessOptions processOptions) -> {
+            try {
+                final String svg = source.asString();
+                final GraphElementFinder finder = new SvgElementFinder(svg).fromGraph(g);
+                final SvgShapeAnalyzer analyzer = new SvgShapeAnalyzer(finder, size.width, size.height);
+                boxes = finder.findNodes().stream()
+                        .map(node -> {
+                            final String tooltip = (String) finder.nodeOf(node).attrs().get("tooltip");
+                            return tooltip == null ? null : new AbstractMap.SimpleEntry<>(analyzer.getBoundingBox(node), tooltip);
+                        })
+                        .filter(Objects::nonNull)
+                        .collect(toList());
+                return EngineResult.fromString(svg);
+            } catch (IOException e) {
+                throw new RuntimeException(e);
+            }
+        }).width(size.width).height(size.height).render(PNG).toImage();
+        ToolTipManager.sharedInstance().registerComponent(this);
+    }
+
+    @Override
+    public Dimension getPreferredSize() {
+        return size;
+    }
+
+    @Override
+    public String getToolTipText(MouseEvent e) {
+        for (final Map.Entry<Rectangle, String> box : boxes) {
+            if (box.getKey().contains(e.getX() / scaleX, e.getY() / scaleY)) {
+                return box.getValue();
+            }
+        }
+        return null;
+    }
+
+    @Override
+    protected void paintComponent(Graphics g) {
+        super.paintComponent(g);
+        final Rectangle c = g.getClipBounds();
+        scaleX = c.getWidth() / size.width;
+        scaleY = c.getHeight() / size.height;
+        g.drawImage(img, 0, 0, c.width, c.height, null);
+//        for (Map.Entry<Rectangle, String> box : boxes) {
+//            g.drawRect(box.getKey().x, box.getKey().y, box.getKey().width, box.getKey().height);
+//        }
+    }
+}