Skip to content

Commit

Permalink
8297923: java.awt.ScrollPane broken after multiple scroll up/down
Browse files Browse the repository at this point in the history
8310054: ScrollPane insets are incorrect
8311689: Wrong visible amount in Adjustable of ScrollPane

Backport-of: ea41907396a70933c4f6e6b0f247f7ba589a3a23
  • Loading branch information
GoeLin committed Jul 18, 2023
1 parent d79c2ef commit f18ecea
Show file tree
Hide file tree
Showing 5 changed files with 300 additions and 10 deletions.
@@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2018, 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
Expand All @@ -24,7 +24,13 @@
*/
package sun.awt.windows;

import java.awt.*;
import java.awt.Adjustable;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.Insets;
import java.awt.Point;
import java.awt.ScrollPane;
import java.awt.ScrollPaneAdjustable;
import java.awt.event.AdjustmentEvent;
import java.awt.peer.ScrollPanePeer;

Expand Down Expand Up @@ -105,7 +111,6 @@ public void childResized(int width, int height) {
ScrollPane sp = (ScrollPane)target;
Dimension vs = sp.getSize();
setSpans(vs.width, vs.height, width, height);
setInsets();
}

synchronized native void setSpans(int viewWidth, int viewHeight,
Expand Down
@@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2014, 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
Expand Down Expand Up @@ -524,6 +524,7 @@ void AwtScrollPane::_SetSpans(void *param)
DTRACE_PRINTLN5("%x: WScrollPanePeer.setSpans(%d, %d, %d, %d)", self,
parentWidth, parentHeight, childWidth, childHeight);
s->RecalcSizes(parentWidth, parentHeight, childWidth, childHeight);
s->SetInsets(env);
s->VerifyState();
}
ret:
Expand Down Expand Up @@ -701,7 +702,7 @@ Java_sun_awt_windows_WScrollPanePeer_getOffset(JNIEnv *env, jobject self,
gos->scrollpane = env->NewGlobalRef(self);
gos->orient = orient;

return static_cast<jint>(reinterpret_cast<INT_PTR>(AwtToolkit::GetInstance().SyncCall(
return static_cast<jint>(reinterpret_cast<INT_PTR>(AwtToolkit::GetInstance().InvokeFunction(
(void *(*)(void *))AwtScrollPane::_GetOffset, gos)));
// global ref and gos are deleted in _GetOffset()

Expand All @@ -718,7 +719,7 @@ Java_sun_awt_windows_WScrollPanePeer_setInsets(JNIEnv *env, jobject self)
{
TRY

AwtToolkit::GetInstance().SyncCall(AwtScrollPane::_SetInsets,
AwtToolkit::GetInstance().InvokeFunction(AwtScrollPane::_SetInsets,
env->NewGlobalRef(self));
// global ref is deleted in _SetInsets()

Expand All @@ -742,7 +743,7 @@ Java_sun_awt_windows_WScrollPanePeer_setScrollPosition(JNIEnv *env,
ssps->x = x;
ssps->y = y;

AwtToolkit::GetInstance().SyncCall(AwtScrollPane::_SetScrollPos, ssps);
AwtToolkit::GetInstance().InvokeFunctionLater(AwtScrollPane::_SetScrollPos, ssps);
// global ref and ssps are deleted in _SetScrollPos()

CATCH_BAD_ALLOC;
Expand Down Expand Up @@ -803,7 +804,7 @@ Java_sun_awt_windows_WScrollPanePeer_setSpans(JNIEnv *env, jobject self,
sss->childWidth = childWidth;
sss->childHeight = childHeight;

AwtToolkit::GetInstance().SyncCall(AwtScrollPane::_SetSpans, sss);
AwtToolkit::GetInstance().InvokeFunction(AwtScrollPane::_SetSpans, sss);
// global ref and sss are deleted in _SetSpans

CATCH_BAD_ALLOC;
Expand Down
4 changes: 2 additions & 2 deletions test/jdk/java/awt/ScrollPane/ScrollPaneExtraScrollBar.java
Expand Up @@ -23,7 +23,7 @@

/*
@test
@bug 4152524
@bug 4152524 8310054
@requires os.family=="windows"
@summary Test that scroll pane doesn't have scroll bars visible when it is
shown for the first time with SCROLLBARS_AS_NEEDED style
Expand Down Expand Up @@ -57,7 +57,7 @@ public void init() throws Exception {
sp = new ScrollPane(ScrollPane.SCROLLBARS_AS_NEEDED);
sp.add(new Button("TEST"));
f.add("Center", sp);
f.pack();
// Frame must not be packed, otherwise the bug isn't reproduced
f.setLocationRelativeTo(null);
f.setVisible(true);
});
Expand Down
189 changes: 189 additions & 0 deletions test/jdk/java/awt/ScrollPane/ScrollPaneLeakTest.java
@@ -0,0 +1,189 @@
/*
* 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.AWTException;
import java.awt.Canvas;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.Frame;
import java.awt.Graphics;
import java.awt.Point;
import java.awt.Rectangle;
import java.awt.Robot;
import java.awt.ScrollPane;
import java.awt.event.MouseEvent;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.lang.reflect.InvocationTargetException;
import java.util.concurrent.atomic.AtomicReference;

import static java.awt.EventQueue.invokeAndWait;

/*
* @test
* @bug 8297923
* @key headful
* @requires os.family=="windows"
* @summary Verifies no GDI objects are leaked after scrolling continuously
* @run main/othervm -Dsun.java2d.d3d=false ScrollPaneLeakTest
*/
public class ScrollPaneLeakTest {

/**
* The number of times the test repeats scrolling cycles.
*/
private static final int REPEATS = 1;

/**
* The number of times the robot moves the scroll bar thumb down and up
* per one cycle.
*/
private static final int UP_DOWN_CYCLES = 20;

private static final Color CANVAS_FOREGROUND = new Color(200, 240, 200);
private static final Color CANVAS_BACKGROUND = new Color(240, 200, 240);
private static final Color SCROLL_PANE_BACKGROUND = new Color(240, 240, 200);

private static final Dimension CANVAS_SIZE = new Dimension(400, 600);
private static final Dimension FRAME_SIZE = new Dimension(CANVAS_SIZE.width * 2,
3 * CANVAS_SIZE.height / 4);
private static final Dimension SCROLL_PANE_SIZE = new Dimension(CANVAS_SIZE.width,
CANVAS_SIZE.height / 2);

private static Frame frame;
private static ScrollPane scroll;

private static final AtomicReference<Rectangle> frameBounds = new AtomicReference<>();

private static final AtomicReference<Rectangle> scrollBounds = new AtomicReference<>();

private static final AtomicReference<Integer> vertBarWidth = new AtomicReference<>();
private static final AtomicReference<Integer> horzBarHeight = new AtomicReference<>();

public static void main(String[] args)
throws InterruptedException, InvocationTargetException, AWTException {
try {
invokeAndWait(ScrollPaneLeakTest::createUI);

final Robot robot = new Robot();
robot.waitForIdle();

invokeAndWait(() -> frame.setExtendedState(frame.getExtendedState()
| Frame.MAXIMIZED_BOTH));
robot.waitForIdle();

invokeAndWait(() -> {
scrollBounds.set(new Rectangle(scroll.getLocationOnScreen(),
scroll.getSize()));

vertBarWidth.set(scroll.getVScrollbarWidth());
horzBarHeight.set(scroll.getHScrollbarHeight());
});
robot.waitForIdle();

invokeAndWait(() -> scroll.setScrollPosition(0, 0));
robot.waitForIdle();
robot.delay(1000);

final Rectangle sb = scrollBounds.get();
final int vbar = vertBarWidth.get();
final int hbar = horzBarHeight.get() * 2;

final Point pos = new Point();
for (int no = 0; no < REPEATS; no++) {
pos.x = sb.x + sb.width - vbar / 3;
pos.y = sb.y + hbar;

robot.mouseMove(pos.x, pos.y);
robot.mousePress(MouseEvent.BUTTON1_DOWN_MASK);
for (int i = 0; i < UP_DOWN_CYCLES; i++) {
while (++pos.y < sb.y + sb.height - hbar) {
robot.mouseMove(pos.x, pos.y);
robot.delay(5);
}
while (--pos.y > sb.y + hbar) {
robot.mouseMove(pos.x, pos.y);
robot.delay(5);
}
}
robot.mouseRelease(MouseEvent.BUTTON1_DOWN_MASK);

invokeAndWait(() -> frame.setExtendedState(frame.getExtendedState()
| Frame.ICONIFIED));
robot.delay(500);
invokeAndWait(() -> frame.setExtendedState(frame.getExtendedState()
& ~Frame.ICONIFIED));
robot.delay(500);
}

invokeAndWait(() -> scroll.setScrollPosition(0, sb.height / 2));

invokeAndWait(() -> {
Rectangle bounds = frame.getBounds();
frameBounds.set(bounds);
});

// Throws OutOfMemoryError when the test fails
robot.createScreenCapture(frameBounds.get());

System.out.println("Robot created a screenshot: test passed");
} finally {
invokeAndWait(frame::dispose);
}
}

private static void createUI() {
frame = new Frame("Scroll Pane Leak Test");
frame.addWindowListener(new WindowAdapter() {
@Override
public void windowClosing(WindowEvent e) {
System.exit(0);
}
});

frame.setLayout(new FlowLayout(FlowLayout.CENTER));
frame.setLocation(0, 0);

Canvas canvas = new Canvas() {
@Override
public void paint(Graphics g) {
g.setColor(CANVAS_FOREGROUND);
g.fillRect(0, 0, getWidth(), getHeight());
}
};
canvas.setBackground(CANVAS_BACKGROUND);
canvas.setSize(CANVAS_SIZE);

scroll = new ScrollPane(ScrollPane.SCROLLBARS_ALWAYS);
scroll.add(canvas);
scroll.setSize(SCROLL_PANE_SIZE);
scroll.setBackground(SCROLL_PANE_BACKGROUND);

frame.add(scroll);
frame.setSize(FRAME_SIZE);

frame.setVisible(true);
}

}
95 changes: 95 additions & 0 deletions test/jdk/java/awt/ScrollPane/ScrollPaneScrollEnd.java
@@ -0,0 +1,95 @@
/*
* 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.Canvas;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Frame;
import java.awt.Graphics;
import java.awt.Point;
import java.awt.Robot;
import java.awt.ScrollPane;

/*
* @test
* @bug 8311689
* @key headful
* @requires os.family=="windows"
* @summary Verifies ScrollPane allows viewing the whole contents of its child
* @run main ScrollPaneScrollEnd
*/
public final class ScrollPaneScrollEnd {
private static final Color CANVAS_BACKGROUND = new Color(255, 200, 200);
private static final Color CANVAS_FOREGROUND = new Color(255, 255, 200);
private static final int OFFSET = 12;

private static final Dimension CANVAS_SIZE = new Dimension(900, 600);
private static final Dimension SCROLL_PANE_SIZE =
new Dimension(CANVAS_SIZE.width / 3, CANVAS_SIZE.height / 3);
private static final int SCROLL_OFFSET = 100;

private static final int DELAY = 200;

public static void main(String[] args) throws Exception {
Canvas canvas = new Canvas() {
@Override
public void paint(Graphics g) {
g.setColor(CANVAS_BACKGROUND);
g.fillRect(0, 0, getWidth(), getHeight());

g.setColor(CANVAS_FOREGROUND);
g.fillRect(OFFSET, OFFSET,
getWidth() - OFFSET * 2, getHeight() - OFFSET * 2);
}
};
canvas.setSize(CANVAS_SIZE);

ScrollPane scrollPane = new ScrollPane(ScrollPane.SCROLLBARS_AS_NEEDED);
scrollPane.add(canvas);
scrollPane.setSize(SCROLL_PANE_SIZE);

Frame frame = new Frame("ScrollPaneScrollEnd");
frame.add(scrollPane, "Center");
frame.setLocation(100, 100);
frame.pack();
frame.setVisible(true);

final Robot robot = new Robot();
robot.waitForIdle();
robot.delay(DELAY);

final Dimension vp = scrollPane.getViewportSize();
final Point expected = new Point(CANVAS_SIZE.width - vp.width,
CANVAS_SIZE.height - vp.height);

scrollPane.setScrollPosition(CANVAS_SIZE.width + SCROLL_OFFSET,
CANVAS_SIZE.height + SCROLL_OFFSET);
try {
if (!expected.equals(scrollPane.getScrollPosition())) {
throw new Error("Can't scroll to the end of the child component");
}
} finally {
frame.dispose();
}
}
}

3 comments on commit f18ecea

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GoeLin
Copy link
Member Author

@GoeLin GoeLin commented on f18ecea Jul 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/backport jdk11u-dev

@openjdk
Copy link

@openjdk openjdk bot commented on f18ecea Jul 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GoeLin the backport was successfully created on the branch GoeLin-backport-f18ecea5 in my personal fork of openjdk/jdk11u-dev. To create a pull request with this backport targeting openjdk/jdk11u-dev:master, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit f18ecea5 from the openjdk/jdk17u-dev repository.

The commit being backported was authored by Goetz Lindenmaier on 18 Jul 2023 and had no reviewers.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk11u-dev:

$ git fetch https://github.com/openjdk-bots/jdk11u-dev.git GoeLin-backport-f18ecea5:GoeLin-backport-f18ecea5
$ git checkout GoeLin-backport-f18ecea5
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk11u-dev.git GoeLin-backport-f18ecea5

Please sign in to comment.