[GR-30199] Make JavaGD based graphics the default.

PullRequest: fastr/2647

Author: Pavel Marek

.gitignore

@@ -164,3 +164,4 @@ lib.install.packages.gnur
 com.oracle.truffle.r.test.native/packages/*/*/src/*.so
 com.oracle.truffle.r.test.native/packages/*/*/src/*.o
 tags
+com.oracle.truffle.r.test.packages/r/fastr.functions.rdx

CHANGELOG.md

@@ -1,5 +1,11 @@
 # 22.1.0
 * Improved performance of the `order` and `rank` builtin functions
+* Use JavaGD as the default graphical subsystem.
+  * Deprecate `--R.UseInternalGridGraphics` option.
+  * The FastR's graphical subsystem is now mostly compatible with GNU-R's, i.e., most functions from `graphics`, `grid`, and `grDevices` base packages are now supported.
+  * Display lists are fully implemented.
+  * Supported devices: SVG, PNG, JPEG, BMP, AWT.
+  * See [graphics docs](./documentation/dev/graphics.md).
 
 # 22.0.0
 * Adopted [NodeLibrary](https://www.graalvm.org/truffle/javadoc/com/oracle/truffle/api/interop/NodeLibrary.html).

com.oracle.truffle.r.ffi.impl/src/com/oracle/truffle/r/ffi/impl/common/JavaUpCallsRFFIImpl.java

@@ -2901,8 +2901,9 @@ private static JavaGDContext getJavaGDContext(RContext ctx) {
 
     @Override
     @TruffleBoundary
-    public void gdOpen(int gdId, String deviceName, double w, double h, RContext ctx) {
-        JavaGDContext.getContext(ctx).newGD(gdId, deviceName).gdOpen(w, h);
+    public boolean gdOpen(int gdId, String deviceName, double w, double h, RContext ctx) {
+        boolean result = JavaGDContext.getContext(ctx).newGD(gdId, deviceName).gdOpen(w, h);
+        return result;
     }
 
     @Override

com.oracle.truffle.r.ffi.impl/src/com/oracle/truffle/r/ffi/impl/javaGD/AWTGraphicsContainer.java

@@ -0,0 +1,118 @@
+/*
+ * Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 3 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 3 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.oracle.truffle.r.ffi.impl.javaGD;
+
+import org.rosuda.javaGD.GDContainer;
+import org.rosuda.javaGD.GDObject;
+import org.rosuda.javaGD.GDState;
+import org.rosuda.javaGD.LocatorSync;
+
+import java.awt.*;
+import java.util.Collection;
+import java.util.LinkedList;
+import java.util.List;
+
+/**
+ * Implementation of {@link GDContainer} that wraps {@link Graphics}.
+ */
+public class AWTGraphicsContainer implements GDContainer {
+    private final GDState gdState;
+    private final List<GDObject> objects;
+    private final Dimension size;
+    private Graphics graphics;
+    private int deviceNumber;
+
+    public AWTGraphicsContainer(double width, double height) {
+        this.gdState = new GDState();
+        this.objects = new LinkedList<>();
+        this.size = new Dimension((int) width, (int) height);
+        this.deviceNumber = -1;
+    }
+
+    public void setGraphics(Graphics graphics) {
+        assert this.graphics == null : "graphics field should be set just once";
+        assert this.objects.size() == 0;
+        this.graphics = graphics;
+        // clearRect is necessary so that objects created with, e.g., `grid.rect` are visible
+        // on the graphics object.
+        this.graphics.clearRect(0, 0, size.width, size.height);
+    }
+
+    @Override
+    public void add(GDObject o) {
+        objects.add(o);
+        o.paint(null, gdState, graphics);
+    }
+
+    @Override
+    public Collection<GDObject> getGDObjects() {
+        return objects;
+    }
+
+    @Override
+    public void reset(int pageNumber) {
+        objects.clear();
+        graphics.clearRect(0, 0, size.width, size.height);
+    }
+
+    @Override
+    public GDState getGState() {
+        return gdState;
+    }
+
+    @Override
+    public Graphics getGraphics() {
+        return graphics;
+    }
+
+    @Override
+    public boolean prepareLocator(LocatorSync ls) {
+        return false;
+    }
+
+    @Override
+    public void syncDisplay(boolean finish) {
+        // nop
+    }
+
+    @Override
+    public void setDeviceNumber(int dn) {
+        this.deviceNumber = dn;
+    }
+
+    @Override
+    public void closeDisplay() {
+        objects.clear();
+    }
+
+    @Override
+    public int getDeviceNumber() {
+        return deviceNumber;
+    }
+
+    @Override
+    public Dimension getSize() {
+        return size;
+    }
+}

com.oracle.truffle.r.ffi.impl/src/com/oracle/truffle/r/ffi/impl/javaGD/AWTGraphicsGD.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 3 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 3 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.oracle.truffle.r.ffi.impl.javaGD;
+
+import org.rosuda.javaGD.GDInterface;
+
+import java.awt.*;
+
+public class AWTGraphicsGD extends GDInterface {
+    private Graphics graphics;
+
+    public void setGraphics(Graphics graphics) {
+        assert this.graphics == null : "graphics field should be initialized just once";
+        this.graphics = graphics;
+        ((AWTGraphicsContainer) c).setGraphics(graphics);
+    }
+
+    @Override
+    public boolean gdOpen(double w, double h) {
+        c = new AWTGraphicsContainer(w, h);
+        return true;
+    }
+}

com.oracle.truffle.r.ffi.impl/src/com/oracle/truffle/r/ffi/impl/javaGD/AbstractImageContainer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -29,6 +29,7 @@
 import java.awt.Graphics2D;
 import java.awt.RenderingHints;
 import java.io.IOException;
+import java.util.Collection;
 import java.util.LinkedList;
 import java.util.List;
 
@@ -59,6 +60,11 @@ public void add(GDObject o) {
         objects.add(o);
     }
 
+    @Override
+    public Collection<GDObject> getGDObjects() {
+        return objects;
+    }
+
     protected abstract void resetGraphics();
 
     @Override
@@ -78,7 +84,7 @@ public boolean prepareLocator(LocatorSync ls) {
     }
 
     @TruffleBoundary
-    protected void repaint() {
+    public void repaint() {
         Graphics graphics = getGraphics();
         graphics.clearRect(0, 0, size.width, size.height);
         for (GDObject o : objects) {
@@ -87,7 +93,7 @@ protected void repaint() {
     }
 
     @Override
-    protected final void saveImage(TruffleFile file) throws IOException {
+    public final void saveImage(TruffleFile file) throws IOException {
         repaint();
         dumpImage(file);
     }

com.oracle.truffle.r.ffi.impl/src/com/oracle/truffle/r/ffi/impl/javaGD/BufferedImageContainer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -47,7 +47,7 @@ public class BufferedImageContainer extends AbstractImageContainer {
     private final String fileType;
     private final float quality;
 
-    BufferedImageContainer(int width, int height, String fileType, String fileNameTemplate, float quality) {
+    public BufferedImageContainer(int width, int height, String fileType, String fileNameTemplate, float quality) {
         super(width, height, fileNameTemplate);
 
         if (!isSupportedFormat(fileType)) {

com.oracle.truffle.r.ffi.impl/src/com/oracle/truffle/r/ffi/impl/javaGD/BufferedImageGD.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -43,9 +43,10 @@ public BufferedImageGD(String fileType, String fileNameTemplate, String params)
     }
 
     @Override
-    public void gdOpen(double width, double height) {
+    public boolean gdOpen(double width, double height) {
         super.gdOpen(width, height);
         c = new BufferedImageContainer((int) width, (int) height, fileType, fileNameTemplate, quality);
+        return true;
     }
 
 }

com.oracle.truffle.r.ffi.impl/src/com/oracle/truffle/r/ffi/impl/javaGD/FileOutputContainer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -32,7 +32,7 @@
 
 public abstract class FileOutputContainer implements GDContainer {
 
-    protected final String fileNameTemplate;
+    protected String fileNameTemplate;
 
     private int pageNumber = 0;
 
@@ -44,6 +44,14 @@ protected int getPageNumber() {
         return pageNumber;
     }
 
+    public String getFileNameTemplate() {
+        return fileNameTemplate;
+    }
+
+    public void setFileNameTemplate(String fileNameTemplate) {
+        this.fileNameTemplate = fileNameTemplate;
+    }
+
     @Override
     public void reset(int explicitPageNumber) {
         saveImage();