FOP-3135: Allow source and target resolution configuration by João André Gonçalves

Author: simonsteiner1984

Diff for: batik-bridge/pom.xml

@@ -106,6 +106,18 @@
       <version>${rhino.version}</version>
       <optional>true</optional>
     </dependency>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>${junit.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-core</artifactId>
+      <version>2.28.2</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

Diff for: batik-bridge/src/main/java/org/apache/batik/bridge/UserAgent.java

@@ -309,4 +309,12 @@ void checkLoadExternalResource(ParsedURL resourceURL,
 
     /** Returns the Font Family Resolver */
     FontFamilyResolver getFontFamilyResolver();
+
+    float getTargetResolution();
+
+    float getSourceResolution();
+
+    void setTargetResolution(float targetResolution);
+
+    void setSourceResolution(float sourceResolution);
 }

Diff for: batik-bridge/src/main/java/org/apache/batik/bridge/UserAgentAdapter.java

@@ -32,6 +32,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
 import org.apache.batik.util.SVGFeatureStrings;
 import org.apache.batik.util.XMLResourceDescriptor;
 
+import org.apache.xmlgraphics.util.UnitConv;
 import org.w3c.dom.Element;
 import org.w3c.dom.svg.SVGAElement;
 import org.w3c.dom.svg.SVGDocument;
@@ -52,6 +53,10 @@ public class UserAgentAdapter implements UserAgent {
      */
     protected BridgeContext ctx;
 
+    private float sourceResolution = 96;
+
+    private float targetResolution = UnitConv.IN2PT;
+
     /**
      * Sets the BridgeContext to be used for error information.
      */
@@ -125,7 +130,7 @@ public boolean showConfirm(String message) {
      * Returns the size of a px CSS unit in millimeters.
      */
     public float getPixelUnitToMillimeter() {
-        return 0.26458333333333333333333333333333f; // 96dpi
+        return UnitConv.IN2MM / getSourceResolution();
     }
 
     /**
@@ -149,8 +154,7 @@ public String getDefaultFontFamily() {
      * Returns the  medium font size. 
      */
     public float getMediumFontSize() {
-        // 9pt (72pt = 1in)
-        return 9f * 25.4f / (72f * getPixelUnitToMillimeter());
+        return 9f * UnitConv.IN2MM / (getTargetResolution() * getPixelUnitToMillimeter());
     }
 
     /**
@@ -464,4 +468,16 @@ public void loadDocument(String url) {
     public FontFamilyResolver getFontFamilyResolver() {
         return DefaultFontFamilyResolver.SINGLETON;
     }
+
+    public float getSourceResolution() { return sourceResolution; }
+
+    public float getTargetResolution() { return targetResolution; }
+
+    public void setSourceResolution(float sourceResolution) {
+        this.sourceResolution = sourceResolution;
+    }
+
+    public void setTargetResolution(float targetResolution) {
+        this.targetResolution = targetResolution;
+    }
 }

Diff for: batik-bridge/src/test/java/org/apache/batik/bridge/UserAgentAdapterTestCase.java

@@ -0,0 +1,82 @@
+/*
+
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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 org.apache.batik.bridge;
+
+import org.apache.xmlgraphics.util.UnitConv;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+
+public class UserAgentAdapterTestCase {
+
+    @Test
+    public void testEqualResolution_72() {
+        checkGetMediumFontSize(72f, 72f, 9f);
+    }
+
+    @Test
+    public void testEqualResolution_96() {
+        checkGetMediumFontSize(96f, 96f, 9f);
+    }
+
+    @Test
+    public void testDiffResolution_72_96() {
+        checkGetMediumFontSize(72f, 96f, 6.74f);
+    }
+
+    @Test
+    public void testDiffResolution_96_72() {
+        checkGetMediumFontSize(96f, 72f, 12f);
+    }
+
+    @Test
+    public void testPixelMM_72() {
+        checkGetPixelUnitToMillimeter(72f, 72f);
+    }
+
+    @Test
+    public void testPixelMM_96() { checkGetPixelUnitToMillimeter(96f, 96f); }
+
+    @Test
+    public void testPixelMM_72_96() { checkGetPixelUnitToMillimeter(72f, 96f); }
+
+    @Test
+    public void testPixelMM_96_72() {
+        checkGetPixelUnitToMillimeter(96f, 72f);
+    }
+
+    private void checkGetMediumFontSize(float sourceRes, float targetRes, float expectedSize) {
+        UserAgentAdapter adapter = new UserAgentAdapter();
+        adapter.setSourceResolution(sourceRes);
+        adapter.setTargetResolution(targetRes);
+
+        // Size must be calculated based on the dpi settings
+        assertEquals(expectedSize, adapter.getMediumFontSize(), 0.01);
+    }
+
+    private void checkGetPixelUnitToMillimeter(float sourceRes, float targetRes) {
+        UserAgentAdapter adapter = new UserAgentAdapter();
+        adapter.setSourceResolution(sourceRes);
+        adapter.setTargetResolution(targetRes);
+
+        // Pixel unit to mm must be calculated using the resolution set in the conf
+        // instead of assuming what the resolution is
+        assertEquals(UnitConv.IN2MM / sourceRes, adapter.getPixelUnitToMillimeter(), 0.01);
+    }
+}

Diff for: batik-svgbrowser/src/main/java/org/apache/batik/apps/svgbrowser/JSVGViewerFrame.java

@@ -145,6 +145,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
 import org.apache.batik.util.resources.ResourceManager;
 import org.apache.batik.xml.XMLUtilities;
 
+import org.apache.xmlgraphics.util.UnitConv;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
 import org.w3c.dom.css.ViewCSS;
@@ -2744,6 +2745,10 @@ public void updateFailed(UpdateManagerEvent e) {
      */
     protected class UserAgent implements SVGUserAgent {
 
+        private float sourceResolution = 96;
+
+        private float targetResolution = UnitConv.IN2PT;
+
         /**
          * Creates a new SVGUserAgent.
          */
@@ -2817,7 +2822,7 @@ public boolean showConfirm(String message) {
          * Returns the size of a px CSS unit in millimeters.
          */
         public float getPixelUnitToMillimeter() {
-            return 0.26458333333333333333333333333333f; // 96dpi
+            return UnitConv.IN2MM / getSourceResolution();
         }
 
         /**
@@ -2842,7 +2847,7 @@ public String getDefaultFontFamily() {
          */
         public float getMediumFontSize() {
             // 9pt (72pt == 1in)
-            return 9f * 25.4f / (72f * getPixelUnitToMillimeter());
+            return 9f * UnitConv.IN2MM / (getTargetResolution() * getPixelUnitToMillimeter());
         }
 
         /**
@@ -3078,6 +3083,26 @@ public void checkLoadScript(String scriptType,
                 s.checkLoadExternalResource();
             }
         }
+
+        @Override
+        public float getTargetResolution() {
+            return targetResolution;
+        }
+
+        @Override
+        public float getSourceResolution() {
+            return sourceResolution;
+        }
+
+        @Override
+        public void setTargetResolution(float targetResolution) {
+            this.targetResolution = targetResolution;
+        }
+
+        @Override
+        public void setSourceResolution(float sourceResolution) {
+            this.sourceResolution = sourceResolution;
+        }
     }
 
     /**

Diff for: batik-swing/pom.xml

@@ -95,6 +95,12 @@
       <artifactId>xml-apis-ext</artifactId>
       <version>${xmlapisext.version}</version>
     </dependency>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>${junit.version}</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

Diff for: batik-swing/src/main/java/org/apache/batik/swing/svg/JSVGComponent.java

@@ -3097,6 +3097,22 @@ public void loadDocument(String url) {
         public FontFamilyResolver getFontFamilyResolver() {
             return userAgent.getFontFamilyResolver();
         }
+
+        public float getSourceResolution() {
+            return userAgent.getSourceResolution();
+        }
+
+        public float getTargetResolution() {
+            return userAgent.getTargetResolution();
+        }
+
+        public void setSourceResolution(float sourceResolution) {
+            userAgent.setSourceResolution(sourceResolution);
+        }
+
+        public void setTargetResolution(float targetResolution) {
+            userAgent.setTargetResolution(targetResolution);
+        }
     }
 
     /**
@@ -3705,6 +3721,22 @@ public void loadDocument(String url) {
         public FontFamilyResolver getFontFamilyResolver() {
             return DefaultFontFamilyResolver.SINGLETON;
         }
+
+        public float getSourceResolution() {
+            return svgUserAgent.getSourceResolution();
+        }
+
+        public float getTargetResolution() {
+            return svgUserAgent.getTargetResolution();
+        }
+
+        public void setSourceResolution(float sourceResolution) {
+            svgUserAgent.setSourceResolution(sourceResolution);
+        }
+
+        public void setTargetResolution(float targetResolution) {
+            svgUserAgent.setTargetResolution(targetResolution);
+        }
     }
 
     protected static final Set FEATURES = new HashSet();

Diff for: batik-swing/src/main/java/org/apache/batik/swing/svg/SVGUserAgent.java

@@ -228,4 +228,11 @@ void checkLoadScript(String scriptType,
     void checkLoadExternalResource(ParsedURL resourceURL,
                                    ParsedURL docURL) throws SecurityException;
 
+    float getTargetResolution();
+
+    float getSourceResolution();
+
+    void setTargetResolution(float targetResolution);
+
+    void setSourceResolution(float sourceResolution);
 }

Diff for: batik-swing/src/main/java/org/apache/batik/swing/svg/SVGUserAgentAdapter.java

@@ -25,6 +25,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
 import org.apache.batik.bridge.RelaxedScriptSecurity;
 import org.apache.batik.bridge.ScriptSecurity;
 import org.apache.batik.util.ParsedURL;
+import org.apache.xmlgraphics.util.UnitConv;
 import org.w3c.dom.Element;
 
 /*
@@ -50,6 +51,11 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  * @version $Id$
  */
 public class SVGUserAgentAdapter implements SVGUserAgent {
+
+    private float sourceResolution = 96;
+
+    private float targetResolution = UnitConv.IN2PT;
+
     public SVGUserAgentAdapter() { }
 
     /**
@@ -106,7 +112,7 @@ public boolean showConfirm(String message) {
      * Returns the size of a px CSS unit in millimeters.
      */
     public float getPixelUnitToMillimeter() {
-        return 0.26458333333333333333333333333333f; // 96dpi
+        return UnitConv.IN2MM / getSourceResolution();
     }
 
     /**
@@ -130,8 +136,7 @@ public String getDefaultFontFamily() {
      * Returns the  medium font size.
      */
     public float getMediumFontSize() {
-        // 9pt (72pt == 1in)
-        return 9f * 25.4f / (72f * getPixelUnitToMillimeter());
+        return 9f * UnitConv.IN2MM / (getTargetResolution() * getPixelUnitToMillimeter());
     }
 
     /**
@@ -350,4 +355,20 @@ public void checkLoadScript(String scriptType,
             s.checkLoadExternalResource();
         }
     }
+
+    public float getSourceResolution() {
+        return sourceResolution;
+    }
+
+    public float getTargetResolution() {
+        return targetResolution;
+    }
+
+    public void setSourceResolution(float sourceResolution) {
+        this.sourceResolution = sourceResolution;
+    }
+
+    public void setTargetResolution(float targetResolution) {
+        this.targetResolution = targetResolution;
+    }
 }