AWT Graphics: close the device when window is closed

(cherry picked from commit 52a899f)

Author: steve-s

com.oracle.truffle.r.library/src/com/oracle/truffle/r/library/fastrGrid/WindowDevice.java

@@ -24,9 +24,14 @@
 
 import com.oracle.truffle.r.library.fastrGrid.device.GridDevice;
 import com.oracle.truffle.r.library.fastrGrid.device.awt.JFrameDevice;
+import com.oracle.truffle.r.nodes.function.PromiseHelperNode;
+import com.oracle.truffle.r.runtime.RCaller;
 import com.oracle.truffle.r.runtime.RError;
 import com.oracle.truffle.r.runtime.RError.Message;
 import com.oracle.truffle.r.runtime.context.RContext;
+import com.oracle.truffle.r.runtime.data.RFunction;
+import com.oracle.truffle.r.runtime.data.RPromise;
+import com.oracle.truffle.r.runtime.env.REnvironment;
 
 /**
  * Contains code specific to FastR device that shows the graphical output interactively in a window.
@@ -45,6 +50,7 @@ public static GridDevice createWindowDevice(int width, int height) {
         RContext ctx = RContext.getInstance();
         if (ctx.hasExecutor()) {
             frameDevice.setResizeListener(() -> redrawAll(ctx));
+            frameDevice.setCloseListener(() -> devOff(ctx));
         } else {
             noSchedulingSupportWarning();
         }
@@ -56,14 +62,44 @@ public static RError awtNotSupported() {
     }
 
     private static void redrawAll(RContext ctx) {
-        if (ctx.hasExecutor()) {
+        if (!ctx.hasExecutor()) {
+            // to be robust we re-check the executor availability
+            return;
+        }
+        ctx.schedule(() -> {
+            Object prev = ctx.getEnv().getContext().enter();
+            GridContext.getContext(ctx).evalInternalRFunction("redrawAll");
+            ctx.getEnv().getContext().leave(prev);
+        });
+    }
+
+    private static void devOff(RContext ctx) {
+        if (!ctx.hasExecutor()) {
             // to be robust we re-check the executor availability
-            ctx.schedule(() -> {
-                Object prev = ctx.getEnv().getContext().enter();
-                GridContext.getContext(ctx).evalInternalRFunction("redrawAll");
-                ctx.getEnv().getContext().leave(prev);
-            });
+            return;
+        }
+        ctx.schedule(() -> {
+            Object prev = ctx.getEnv().getContext().enter();
+            RFunction devOffFun = getDevOffFunction(ctx);
+            if (devOffFun != null) {
+                RContext.getEngine().evalFunction(devOffFun, REnvironment.baseEnv(ctx).getFrame(), RCaller.topLevel, true, null);
+            } else {
+                RError.warning(RError.NO_CALLER, Message.GENERIC, "Could not locate grDevices::dev.off to close the window device.");
+            }
+            ctx.getEnv().getContext().leave(prev);
+        });
+    }
+
+    private static RFunction getDevOffFunction(RContext ctx) {
+        Object grDevices = ctx.stateREnvironment.getNamespaceRegistry().get("grDevices");
+        if (!(grDevices instanceof REnvironment)) {
+            return null;
+        }
+        Object devOff = ((REnvironment) grDevices).get("dev.off");
+        if (devOff instanceof RPromise) {
+            devOff = PromiseHelperNode.evaluateSlowPath((RPromise) devOff);
         }
+        return devOff instanceof RFunction ? (RFunction) devOff : null;
     }
 
     private static void noSchedulingSupportWarning() {

com.oracle.truffle.r.library/src/com/oracle/truffle/r/library/fastrGrid/device/awt/JFrameDevice.java

@@ -42,14 +42,15 @@
 import javax.imageio.ImageIO;
 import javax.swing.JFrame;
 import javax.swing.JPanel;
+import javax.swing.SwingUtilities;
 
 import com.oracle.truffle.r.library.fastrGrid.device.DrawingContext;
 import com.oracle.truffle.r.library.fastrGrid.device.GridDevice;
 import com.oracle.truffle.r.library.fastrGrid.device.ImageSaver;
 
 /**
  * This device paints everything into an image, which is painted into a AWT component in its
- * {@code paint} method.
+ * {@code paint} method. Note that this class is not thread safe.
  */
 public final class JFrameDevice implements GridDevice, ImageSaver {
 
@@ -64,14 +65,26 @@ public final class JFrameDevice implements GridDevice, ImageSaver {
     private Graphics2DDevice inner;
     private boolean isOnHold = false;
 
-    private FastRFrame currentFrame;
+    /**
+     * Value of this field is set from the AWT thread, any code using it in the main thread should
+     * first check if it is not {@code null}.
+     */
+    private volatile FastRFrame currentFrame;
+    /**
+     * The closing operation invokes {@code dev.off()} to close the device on the R side (remove it
+     * from {@code .Devices} etc.), but that eventually calls into {@link #close()} where we need to
+     * know that the AWT window is being closed by the user and so we do not need to close it.
+     */
+    private volatile boolean isClosing = false;
     private Runnable onResize;
     private Runnable onClose;
 
     public JFrameDevice(int width, int height) {
-        currentFrame = new FastRFrame(new FastRPanel(width, height));
-        openGraphics2DDevice(currentFrame.fastRComponent.getWidth(), currentFrame.fastRComponent.getHeight());
+        openGraphics2DDevice(width, height);
         componentImage = image;
+        SwingUtilities.invokeLater(() -> {
+            currentFrame = new FastRFrame(new FastRPanel(width, height));
+        });
     }
 
     @Override
@@ -110,7 +123,9 @@ public void flush() {
     @Override
     public void close() throws DeviceCloseException {
         disposeGraphics2DDevice();
-        currentFrame.dispose();
+        if (!isClosing && currentFrame != null) {
+            currentFrame.dispose();
+        }
         componentImage = null;
     }
 
@@ -231,17 +246,21 @@ private void resize(int newWidth, int newHeight) {
     }
 
     private void ensureOpen() {
-        if (!currentFrame.isVisible()) {
+        if (currentFrame != null && !currentFrame.isVisible()) {
             int width = inner.getWidthAwt();
             int height = inner.getHeightAwt();
-            currentFrame = new FastRFrame(new FastRPanel(width, height));
+            // Note: the assumption is that this class is single threaded
             disposeGraphics2DDevice();
             openGraphics2DDevice(width, height);
+            currentFrame = null;
+            SwingUtilities.invokeLater(() -> {
+                currentFrame = new FastRFrame(new FastRPanel(width, height));
+            });
         }
     }
 
     private void repaint() {
-        if (!isOnHold) {
+        if (!isOnHold && currentFrame != null) {
             currentFrame.repaint();
         }
     }
@@ -312,6 +331,7 @@ class FastRFrame extends JFrame {
         FastRFrame(FastRPanel fastRComponent) throws HeadlessException {
             super("FastR");
             this.fastRComponent = fastRComponent;
+            setDefaultCloseOperation(DISPOSE_ON_CLOSE);
             addListeners();
             getContentPane().add(fastRComponent);
             pack();
@@ -320,10 +340,12 @@ class FastRFrame extends JFrame {
         }
 
         private void addListeners() {
-            addWindowFocusListener(new WindowAdapter() {
+            addWindowListener(new WindowAdapter() {
                 @Override
                 public void windowClosing(WindowEvent e) {
-                    if (onClose != null) {
+                    super.windowClosing(e);
+                    if (!isClosing && onClose != null) {
+                        isClosing = true;
                         onClose.run();
                     }
                 }

com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/env/REnvironment.java

@@ -1062,7 +1062,7 @@ protected String getSearchName() {
     /**
      * When a function is invoked a {@link Function} environment may be created in response to the R
      * {@code environment()} base package function, and it will have an associated frame. We hide
-     * the creation of {@link Function} environments to ensure the <i>at most one>/i> invariant and
+     * the creation of {@link Function} environments to ensure the <i>at most one</i> invariant and
      * store the value in the frame immediately.
      */
     public static final class Function extends REnvironment {