8158325: [macosx] Memory leak in com.apple.laf.ScreenMenu

Reviewed-by: azvegint, alexsch

src/macosx/classes/com/apple/laf/ScreenMenu.java

@@ -109,6 +109,7 @@ final class ScreenMenu extends Menu
         final Component[] items = fInvoker.getMenuComponents();
         if (needsUpdate(items, childHashArray)) {
             removeAll();
+            fItems.clear();
             if (count <= 0) return;
 
             childHashArray = new int[count];
@@ -232,7 +233,7 @@ final class ScreenMenu extends Menu
         synchronized (getTreeLock()) {
             super.addNotify();
             if (fModelPtr == 0) {
-                fInvoker.addContainerListener(this);
+                fInvoker.getPopupMenu().addContainerListener(this);
                 fInvoker.addComponentListener(this);
                 fPropertyListener = new ScreenMenuPropertyListener(this);
                 fInvoker.addPropertyChangeListener(fPropertyListener);
@@ -266,7 +267,7 @@ final class ScreenMenu extends Menu
             if (fModelPtr != 0) {
                 removeMenuListeners(fModelPtr);
                 fModelPtr = 0;
-                fInvoker.removeContainerListener(this);
+                fInvoker.getPopupMenu().removeContainerListener(this);
                 fInvoker.removeComponentListener(this);
                 fInvoker.removePropertyChangeListener(fPropertyListener);
             }
@@ -287,11 +288,10 @@ final class ScreenMenu extends Menu
     @Override
     public void componentRemoved(final ContainerEvent e) {
         final Component child = e.getChild();
-        final MenuItem sm = fItems.get(child);
+        final MenuItem sm = fItems.remove(child);
         if (sm == null) return;
 
         remove(sm);
-        fItems.remove(sm);
     }
 
     /**

test/com/apple/laf/ScreenMenu/ScreenMenuMemoryLeakTest.java

+/*
+ * Copyright (c) 2016 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 2 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 2 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
+ * 2 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.
+ */
+/*
+ * @test
+ * @bug 8158325
+ * @summary Memory leak in com.apple.laf.ScreenMenu: removed JMenuItems are still referenced
+ * @requires (os.family == "mac")
+ * @run main/timeout=300/othervm -Xmx16m ScreenMenuMemoryLeakTest
+ */
+import java.awt.EventQueue;
+import java.lang.ref.WeakReference;
+import java.lang.reflect.InvocationTargetException;
+import java.util.Objects;
+
+import javax.swing.JFrame;
+import javax.swing.JLabel;
+import javax.swing.JMenu;
+import javax.swing.JMenuBar;
+import javax.swing.JMenuItem;
+import javax.swing.WindowConstants;
+
+public class ScreenMenuMemoryLeakTest {
+
+    private static byte[] sBytes;
+
+    private static WeakReference<JMenuItem> sMenuItem;
+    private static JFrame sFrame;
+    private static JMenu sMenu;
+
+    public static void main(String[] args) throws InvocationTargetException, InterruptedException {
+        EventQueue.invokeAndWait(new Runnable() {
+            @Override
+            public void run() {
+                System.setProperty("apple.laf.useScreenMenuBar", "true");
+                showUI();
+            }
+        });
+
+        EventQueue.invokeAndWait(new Runnable() {
+            @Override
+            public void run() {
+                removeMenuItemFromMenu();
+            }
+        });
+        System.gc();
+        System.runFinalization();
+        JMenuItem menuItem = sMenuItem.get();
+        EventQueue.invokeAndWait(new Runnable() {
+            @Override
+            public void run() {
+                sFrame.dispose();
+            }
+        });
+        if (menuItem != null) {
+            throw new RuntimeException("The menu item should have been GC-ed");
+        }
+    }
+
+    private static void showUI() {
+        sFrame = new JFrame();
+        sFrame.add(new JLabel("Some dummy content"));
+
+        JMenuBar menuBar = new JMenuBar();
+
+        sMenu = new JMenu("Menu");
+        JMenuItem item = new JMenuItem("Item");
+        sMenu.add(item);
+
+        sMenuItem = new WeakReference<>(item);
+
+        menuBar.add(sMenu);
+
+        sFrame.setJMenuBar(menuBar);
+
+        sFrame.setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE);
+        sFrame.pack();
+        sFrame.setVisible(true);
+    }
+
+    private static void removeMenuItemFromMenu() {
+        JMenuItem menuItem = sMenuItem.get();
+        Objects.requireNonNull(menuItem, "The menu item should still be available at this point");
+        sMenu.remove(menuItem);
+    }
+}
\ No newline at end of file