stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8311113: Remove invalid pointer cast and clean up setLabel() in awt_MenuItem.cpp

Browse Source 
Reviewed-by: aivanov, serb
This commit is contained in:
Harshitha Onkar 2023-09-19 17:37:49 +00:00
parent d2b2f6759f
commit 0c972468e7
4 changed files with 197 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/java.desktop/windows/classes/sun/awt/windows/WMenuItemPeer.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2021, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1996, 2023, 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
@ -75,9 +75,9 @@ class WMenuItemPeer extends WObjectPeer implements MenuItemPeer {
public void setLabel(String label) {
//Fix for 6288578: PIT. Windows: Shortcuts displayed for the menuitems in a popup menu
readShortcutLabel();
_setLabel(label);
_setLabel();
}
public native void _setLabel(String label);
public native void _setLabel();
// Toolkit & peer internals

69
src/java.desktop/windows/native/libawt/windows/awt_MenuItem.cpp
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1996, 2023, 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
@ -48,7 +48,6 @@
// struct for _SetLabel() method
struct SetLabelStruct {
jobject menuitem;
jstring label;
};
// struct for _SetEnable() method
struct SetEnableStruct {
@ -685,7 +684,7 @@ void AwtMenuItem::DoCommand()
}
}
void AwtMenuItem::SetLabel(LPCTSTR sb)
void AwtMenuItem::SetLabel()
{
AwtMenu* menu = GetMenuContainer();
/* Fix for bug 4257944 by ssi@sparc.spb.su
@ -704,12 +703,11 @@ void AwtMenuItem::SetLabel(LPCTSTR sb)
memset(&mii, 0, sizeof(MENUITEMINFO));
mii.cbSize = sizeof(MENUITEMINFO);
mii.fMask = MIIM_CHECKMARKS | MIIM_DATA | MIIM_ID
| MIIM_STATE | MIIM_SUBMENU | MIIM_TYPE;
| MIIM_STATE | MIIM_SUBMENU | MIIM_FTYPE;
::GetMenuItemInfo(hMenu, GetID(), FALSE, &mii);
mii.fType = MFT_OWNERDRAW;
mii.dwTypeData = (LPTSTR)(*sb);
// find index by menu item id
int nMenuItemCount = ::GetMenuItemCount(hMenu);
@ -784,7 +782,6 @@ void AwtMenuItem::_SetLabel(void *param) {
SetLabelStruct *sls = (SetLabelStruct *)param;
jobject self = sls->menuitem;
jstring label = sls->label;
int badAlloc = 0;
AwtMenuItem *m = NULL;
@ -792,64 +789,12 @@ void AwtMenuItem::_SetLabel(void *param) {
PDATA pData;
JNI_CHECK_PEER_GOTO(self, ret);
m = (AwtMenuItem *)pData;
// if (::IsWindow(m->GetOwnerHWnd()))
{
// fix for bug 4251036 MenuItem setLabel(null/"") behaves differently
// under Win32 and Solaris
jstring empty = NULL;
if (JNU_IsNull(env, label))
{
empty = JNU_NewStringPlatform(env, TEXT(""));
}
if (env->ExceptionCheck()) {
badAlloc = 1;
goto ret;
}
LPCTSTR labelPtr;
if (empty != NULL)
{
labelPtr = JNU_GetStringPlatformChars(env, empty, 0);
}
else
{
labelPtr = JNU_GetStringPlatformChars(env, label, 0);
}
if (labelPtr == NULL)
{
badAlloc = 1;
}
else
{
DASSERT(!IsBadStringPtr(labelPtr, 20));
m->SetLabel(labelPtr);
if (empty != NULL)
{
JNU_ReleaseStringPlatformChars(env, empty, labelPtr);
}
else
{
JNU_ReleaseStringPlatformChars(env, label, labelPtr);
}
}
if (empty != NULL)
{
env->DeleteLocalRef(empty);
}
}
m->SetLabel();
ret:
env->DeleteGlobalRef(self);
if (label != NULL)
{
env->DeleteGlobalRef(label);
}
delete sls;
if (badAlloc)
{
throw std::bad_alloc();
}
} else {
AwtToolkit::GetInstance().InvokeFunction(AwtMenuItem::_SetLabel, param);
}
@ -1031,17 +976,15 @@ Java_sun_awt_windows_WMenuItemPeer_initIDs(JNIEnv *env, jclass cls)
/*
* Class: sun_awt_windows_WMenuItemPeer
* Method: _setLabel
* Signature: (Ljava/lang/String;)V
* Signature: ()V
*/
JNIEXPORT void JNICALL
Java_sun_awt_windows_WMenuItemPeer__1setLabel(JNIEnv *env, jobject self,
jstring label)
Java_sun_awt_windows_WMenuItemPeer__1setLabel(JNIEnv *env, jobject self)
{
TRY;
SetLabelStruct *sls = new SetLabelStruct;
sls->menuitem = env->NewGlobalRef(self);
sls->label = (label == NULL) ? NULL : (jstring)env->NewGlobalRef(label);
AwtToolkit::GetInstance().SyncCall(AwtMenuItem::_SetLabel, sls);
// global refs and sls are deleted in _SetLabel

4
src/java.desktop/windows/native/libawt/windows/awt_MenuItem.h
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1996, 2023, 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
@ -133,7 +133,7 @@ public:
virtual BOOL IsTopMenu();
void DrawCheck(HDC hDC, RECT rect);
void SetLabel(LPCTSTR sb);
void SetLabel();
virtual void Enable(BOOL isEnabled);
virtual void UpdateContainerLayout();
virtual void RedrawMenuBar();

186
test/jdk/java/awt/MenuItem/SetLabelTest.java Normal file
View File

@ -0,0 +1,186 @@
/*
* Copyright (c) 2023, 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.
*/
import java.awt.EventQueue;
import java.awt.Frame;
import java.awt.Menu;
import java.awt.MenuBar;
import java.awt.MenuItem;
import java.awt.Point;
import java.awt.PopupMenu;
import java.awt.Robot;
import java.awt.event.InputEvent;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import javax.imageio.ImageIO;
/*
* @test
* @key headful
* @bug 4234266
* @summary To test setLabel functionality on Windows.
* @requires (os.family == "windows")
*/
public class SetLabelTest {
private static Robot robot;
private static Frame frame;
private static MenuBar mb;
private static PopupMenu pm;
private static Point frameLoc;
private static final StringBuffer errorLog = new StringBuffer();
public static void main(String[] args) throws Exception {
try {
robot = new Robot();
EventQueue.invokeAndWait(() -> createTestUI());
robot.delay(1000);
EventQueue.invokeAndWait(() -> frameLoc = frame.getLocationOnScreen());
checkMenu();
checkPopupMenu();
robot.delay(200);
if (!errorLog.isEmpty()) {
throw new RuntimeException("Before & After screenshots are same." +
" Test fails for the following case(s):\n" + errorLog);
}
} finally {
EventQueue.invokeAndWait(() -> {
if (frame != null) {
frame.dispose();
}
});
}
}
private static void createTestUI() {
frame = new Frame("Menu SetLabel Test");
frame.setUndecorated(true);
mb = new MenuBar();
//Menu 1
Menu menu1 = new Menu("Menu");
MenuItem mi1 = new MenuItem("Item-1");
menu1.add(mi1);
menu1.addSeparator();
MenuItem mi2 = new MenuItem("Item-2");
menu1.add(mi2);
mb.add(menu1);
//Popup menu
pm = new PopupMenu("Popup");
MenuItem pm1 = new MenuItem("Item-1");
pm.add(pm1);
pm.addSeparator();
MenuItem pm2 = new MenuItem("Item-2");
pm.add(pm2);
frame.add(pm);
frame.addMouseListener(new MouseAdapter() {
@Override
public void mousePressed(MouseEvent e) {
showPopup(e);
}
@Override
public void mouseReleased(MouseEvent e) {
showPopup(e);
}
private void showPopup(MouseEvent e) {
if (e.isPopupTrigger()) {
pm.show(e.getComponent(),
e.getX(), e.getY());
}
}
});
frame.setMenuBar(mb);
frame.setSize(300, 200);
frame.setLocation(500,500);
frame.setVisible(true);
}
private static void checkMenu() throws IOException {
robot.mouseMove(frameLoc.x + 8, frameLoc.y + 8);
robot.mousePress(InputEvent.BUTTON1_DOWN_MASK);
robot.mouseRelease(InputEvent.BUTTON1_DOWN_MASK);
robot.delay(200);
BufferedImage beforeImgMenu = robot.createScreenCapture(frame.getBounds());
//Change Menu & MenuItem label
Menu m1 = mb.getMenu(0);
m1.setLabel("New Menu");
m1.getItem(0).setLabel("New Item-1");
m1.getItem(2).setLabel("New Item-2");
robot.delay(200);
BufferedImage afterImgMenu = robot.createScreenCapture(frame.getBounds());
if (compareImages(beforeImgMenu, afterImgMenu)) {
errorLog.append("Menu case\n");
ImageIO.write(beforeImgMenu, "png", new File("MenuBefore.png"));
ImageIO.write(afterImgMenu, "png", new File("MenuAfter.png"));
}
}
private static void checkPopupMenu() throws IOException {
robot.mouseMove(frameLoc.x + (frame.getWidth() / 2),
frameLoc.y + (frame.getHeight() /2));
robot.mousePress(InputEvent.BUTTON3_DOWN_MASK);
robot.mouseRelease(InputEvent.BUTTON3_DOWN_MASK);
robot.delay(200);
BufferedImage beforeImgPopup = robot.createScreenCapture(frame.getBounds());
//Change popup menu label
pm.setLabel("Changed Popup");
pm.getItem(0).setLabel("New Item-1");
pm.getItem(2).setLabel("New Item-2");
robot.delay(200);
BufferedImage afterImgPopup = robot.createScreenCapture(frame.getBounds());
robot.mouseMove(frameLoc.x + (frame.getWidth() - 10),
frameLoc.y + (frame.getHeight() - 10));
robot.delay(100);
robot.mousePress(InputEvent.BUTTON1_DOWN_MASK);
robot.mouseRelease(InputEvent.BUTTON1_DOWN_MASK);
if (compareImages(beforeImgPopup, afterImgPopup)) {
errorLog.append("Popup case\n");
ImageIO.write(beforeImgPopup, "png", new File("PopupBefore.png"));
ImageIO.write(afterImgPopup, "png", new File("PopupAfter.png"));
}
}
private static boolean compareImages(BufferedImage beforeImg, BufferedImage afterImg) {
for (int x = 0; x < beforeImg.getWidth(); x++) {
for (int y = 0; y < beforeImg.getHeight(); y++) {
if (beforeImg.getRGB(x, y) != afterImg.getRGB(x, y)) {
return false;
}
}
}
return true;
}
}