JBR-9730 Wayland: to add a secondary expression in assertions

Author: mkartashev

src/java.desktop/unix/classes/sun/awt/wl/FullFrameDecorationHelper.java

@@ -164,7 +164,7 @@ public final void markRepaintNeeded(boolean value) {
 
     @Override
     public void paint(Graphics g) {
-        assert isRepaintNeeded();
+        assert isRepaintNeeded() : "paint() called when no repaint needed";
 
         int width = peer.getWidth();
         int height = peer.getHeight();
@@ -196,7 +196,7 @@ private static MouseEvent convertEvent(MouseEvent e, int newId) {
     }
 
     private boolean isSignificantDrag(Point p) {
-        assert EventQueue.isDispatchThread();
+        assert EventQueue.isDispatchThread() : "Method must only be invoked on EDT";
 
         Objects.requireNonNull(p);
         return pressedLocation != null && isSignificantDragDistance(pressedLocation, p);
@@ -208,7 +208,7 @@ private boolean isSignificantDrag(Point p) {
 
     @Override
     boolean processMouseEvent(MouseEvent e) {
-        assert EventQueue.isDispatchThread();
+        assert EventQueue.isDispatchThread() : "Method must only be invoked on EDT";
 
         if (super.processMouseEvent(e)) return true;
 
@@ -326,7 +326,7 @@ private boolean reset() {
         }
 
         private boolean processMouseEvent(MouseEvent e) {
-            assert EventQueue.isDispatchThread();
+            assert EventQueue.isDispatchThread() : "Method must only be invoked on EDT";
 
             Rectangle buttonBounds = bounds.get();
             boolean ourLocation = buttonBounds != null && e.getID() != MouseEvent.MOUSE_EXITED &&

src/java.desktop/unix/classes/sun/awt/wl/GtkFrameDecoration.java

@@ -68,7 +68,7 @@ public class GtkFrameDecoration extends FullFrameDecorationHelper {
     public GtkFrameDecoration(WLDecoratedPeer peer, boolean showMinimize, boolean showMaximize) {
         super(peer, showMinimize, showMaximize);
         nativePtr = nativeCreateDecoration(showMinimize, showMaximize, isDarkTheme());
-        assert nativePtr != 0;
+        assert nativePtr != 0 : "Failed to create the native part of the decoration";
         int t = nativeGetIntProperty(nativePtr, "gtk-dnd-drag-threshold");
         dndThreshold = t > 0 ? t : 4;
     }
@@ -87,8 +87,8 @@ protected void paintTitleBar(Graphics2D g2d) {
         int width = peer.getWidth();
         int height = titleBarHeight;
 
-        assert width >= titleBarMinWidth;
-        assert peer.getHeight() >= titleBarHeight;
+        assert width >= titleBarMinWidth : "The frame width is too small to display the title bar";
+        assert peer.getHeight() >= titleBarHeight : "The frame height is too small to display the title bar";
 
         double scale = ((WLGraphicsConfig) peer.getGraphicsConfiguration()).getEffectiveScale();
         g2d.setBackground(new Color(0, true));

src/java.desktop/unix/classes/sun/awt/wl/ServerSideFrameDecoration.java

@@ -96,7 +96,7 @@ public void notifyNativeWindowToBeHidden(long nativePtr) {
     @Override
     public void dispose() {
         // Native resources must have been already disposed when the window was hidden
-        assert nativeDecorPtr == 0;
+        assert nativeDecorPtr == 0 : "Native resources must have been already disposed";
     }
 
     private native long createToplevelDecorationImpl(long nativeFramePtr);

src/java.desktop/unix/classes/sun/awt/wl/WLComponentPeer.java

@@ -320,7 +320,7 @@ static void moveToOverlap(Rectangle what, Rectangle where) {
         if (what.getMinY() >= where.getMaxY()) {
             what.y -= what.getMinY() - where.getMaxY();
         }
-        assert what.intersects(where);
+        assert what.intersects(where) : String.format("Failed to move %s to overlap %s", what, where);
     }
 
     Point nativeLocationForPopup(Window popup, Component popupParent, Window toplevel) {
@@ -387,7 +387,7 @@ protected void wlSetVisible(boolean v) {
             boolean isUnconstrained = isPopupPositionUnconstrained();
 
             performLocked(() -> {
-                assert wlSurface == null;
+                assert wlSurface == null : "Invisible window already has a Wayland surface attached";
                 wlSurface = new WLMainSurface((WLWindowPeer) this);
                 long wlSurfacePtr = wlSurface.getWlSurfacePtr();
                 if (isWlPopup) {
@@ -477,7 +477,7 @@ public boolean isResizable() {
 
     @Override
     public void updateSurfaceSize() {
-        assert SunToolkit.isAWTLockHeldByCurrentThread();
+        assert SunToolkit.isAWTLockHeldByCurrentThread() : "This method must be invoked while holding the AWT lock";
         // Note: must be called after a buffer of proper size has been attached to the surface,
         // but the surface has not yet been committed. Otherwise, the sizes will get out of sync,
         // which may result in visual artifacts.
@@ -910,7 +910,7 @@ void showWindowMenu(long serial, int x, int y) {
         //  a button press, key press, or touch down event."
         // So 'serial' must appertain to such an event.
 
-        assert serial != 0;
+        assert serial != 0 : "The serial number of the event requesting the window menu must be non-zero";
 
         int xNative = javaUnitsToSurfaceUnits(x);
         int yNative = javaUnitsToSurfaceUnits(y);
@@ -970,7 +970,7 @@ public void dispose() {
         WLToolkit.targetDisposedPeer(target, this);
 
         performLocked(() -> {
-            assert !isVisible();
+            assert !isVisible() : "Disposed window must have been already hidden";
 
             nativeDisposeFrame(nativePtr);
             nativePtr = 0;
@@ -1373,7 +1373,8 @@ void dispatchPointerEventInContext(WLPointerEvent e, WLInputState oldInputState,
             }
 
             if (verticalMWERoundRotations != 0 || verticalMWEPreciseRotations != 0) {
-                assert(verticalMWEScrollAmount > 0);
+                assert verticalMWEScrollAmount > 0
+                        : String.format("Vertical scrolling event has negative scroll amount: %d", verticalMWEScrollAmount);
 
                 final MouseEvent mouseEvent = new MouseWheelEvent(getTarget(),
                         MouseEvent.MOUSE_WHEEL,
@@ -1392,7 +1393,8 @@ void dispatchPointerEventInContext(WLPointerEvent e, WLInputState oldInputState,
             }
 
             if (horizontalMWERoundRotations != 0 || horizontalMWEPreciseRotations != 0) {
-                assert(horizontalMWEScrollAmount > 0);
+                assert horizontalMWEScrollAmount > 0
+                        : String.format("Horizontal scrolling event has negative scroll amount: %d", horizontalMWEScrollAmount);;
 
                 final MouseEvent mouseEvent = new MouseWheelEvent(getTarget(),
                         MouseEvent.MOUSE_WHEEL,
@@ -1603,7 +1605,7 @@ void startDrag(long serial) {
         // "This request must be used in response to some sort of user action like a button press,
         //  key press, or touch down event. The passed serial is used to determine the type
         //  of interactive move (touch, pointer, etc)."
-        assert serial != 0;
+        assert serial != 0 : "The serial number of the event requesting the drag must be non-zero";
 
         performLocked(() -> nativeStartDrag(serial, nativePtr));
     }
@@ -1612,7 +1614,7 @@ void startResize(long serial, int edges) {
         // "This request must be used in response to some sort of user action like a button press,
         //  key press, or touch down event. The passed serial is used to determine the type
         //  of interactive resize (touch, pointer, etc)."
-        assert serial != 0;
+        assert serial != 0 : "The serial number of the event requesting the resize must be non-zero";
 
         performLocked(() -> nativeStartResize(serial, nativePtr, edges));
     }
@@ -1692,7 +1694,7 @@ Point convertPontFromDeviceSpace(int x, int y) {
 
     void notifyConfigured(int newSurfaceX, int newSurfaceY, int newSurfaceWidth, int newSurfaceHeight,
                           boolean active, boolean maximized, boolean fullscreen) {
-        assert SunToolkit.isAWTLockHeldByCurrentThread();
+        assert SunToolkit.isAWTLockHeldByCurrentThread() : "This method must be invoked while holding the AWT lock";
 
         // NB: The width and height, as well as X and Y arguments, specify the size and the location
         //     of the window in surface-local coordinates.
@@ -1773,12 +1775,12 @@ void notifyEnteredOutput(int wlOutputID) {
     }
 
     void notifyPopupDone() {
-        assert(targetIsWlPopup());
+        assert targetIsWlPopup() : "This method must be invoked only for popups";
         target.setVisible(false);
     }
 
     void checkIfOnNewScreen() {
-        assert SunToolkit.isAWTLockHeldByCurrentThread();
+        assert SunToolkit.isAWTLockHeldByCurrentThread() : "This method must be invoked while holding the AWT lock";
 
         if (wlSurface == null) return;
         final WLGraphicsDevice newDevice = wlSurface.getGraphicsDevice();
@@ -2023,7 +2025,7 @@ public int getSize() {
 
         @Override
         public void updateSurfaceSize() {
-            assert SunToolkit.isAWTLockHeldByCurrentThread();
+            assert SunToolkit.isAWTLockHeldByCurrentThread() : "This method must be invoked while holding the AWT lock";
 
             shadowSurface.updateSurfaceSize(shadowWlSize.getSurfaceWidth(), shadowWlSize.getSurfaceHeight());
         }
@@ -2035,22 +2037,22 @@ public void resizeToParentWindow() {
         }
 
         public void createSurface() {
-            assert shadowSurface == null;
-            assert SunToolkit.isAWTLockHeldByCurrentThread();
+            assert shadowSurface == null : "The shadow surface must not be created twice";
+            assert SunToolkit.isAWTLockHeldByCurrentThread() : "This method must be invoked while holding the AWT lock";
 
             int shadowOffset = -javaUnitsToSurfaceUnits(shadowSize);
             shadowSurface = new WLSubSurface(wlSurface, shadowOffset, shadowOffset);
         }
 
         public void commitSurface() {
             assert shadowSurface != null;
-            assert SunToolkit.isAWTLockHeldByCurrentThread();
+            assert SunToolkit.isAWTLockHeldByCurrentThread() : "This method must be invoked while holding the AWT lock";
 
             shadowSurface.commit();
         }
 
         public void dispose() {
-            assert SunToolkit.isAWTLockHeldByCurrentThread();
+            assert SunToolkit.isAWTLockHeldByCurrentThread() : "This method must be invoked while holding the AWT lock";
 
             if (shadowSurface != null) {
                 shadowSurface.dispose();
@@ -2065,7 +2067,7 @@ public void dispose() {
         }
 
         public void hide() {
-            assert SunToolkit.isAWTLockHeldByCurrentThread();
+            assert SunToolkit.isAWTLockHeldByCurrentThread() : "This method must be invoked while holding the AWT lock";
 
             if (shadowSurface != null) {
                 shadowSurface.dispose();
@@ -2074,15 +2076,15 @@ public void hide() {
         }
 
         public void updateSurfaceData() {
-            assert SunToolkit.isAWTLockHeldByCurrentThread();
+            assert SunToolkit.isAWTLockHeldByCurrentThread() : "This method must be invoked while holding the AWT lock";
 
             needsRepaint = true;
             SurfaceData.convertTo(WLSurfaceDataExt.class, shadowSurfaceData).revalidate(
                     getGraphicsConfiguration(), shadowWlSize.getPixelWidth(), shadowWlSize.getPixelHeight(), getDisplayScale());
         }
 
         public void paint() {
-            assert SunToolkit.isAWTLockHeldByCurrentThread();
+            assert SunToolkit.isAWTLockHeldByCurrentThread() : "This method must be invoked while holding the AWT lock";
 
             if (!needsRepaint) {
                 return;
@@ -2108,7 +2110,7 @@ public void commitSurfaceData() {
 
         public void notifyConfigured(boolean active, boolean maximized, boolean fullscreen) {
             assert shadowSurface != null;
-            assert SunToolkit.isAWTLockHeldByCurrentThread();
+            assert SunToolkit.isAWTLockHeldByCurrentThread() : "This method must be invoked while holding the AWT lock";
 
             needsRepaint |= active ^ isActive;
 

src/java.desktop/unix/classes/sun/awt/wl/WLDataOffer.java

@@ -77,7 +77,8 @@ public synchronized byte[] receiveData(String mime) throws IOException  {
 
         fd = openReceivePipe(nativePtr, mime);
 
-        assert(fd != -1); // Otherwise an exception should be thrown from native code
+        // Otherwise an exception should be thrown from native code
+        assert fd != -1 : "An invalid file descriptor received from the native code";
 
         FileDescriptor javaFD = new FileDescriptor();
         jdk.internal.access.SharedSecrets.getJavaIOFileDescriptorAccess().set(javaFD, fd);

src/java.desktop/unix/classes/sun/awt/wl/WLDataSource.java

@@ -53,7 +53,7 @@ public class WLDataSource {
         var wlDataTransferer = (WLDataTransferer) WLDataTransferer.getInstance();
 
         nativePtr = initNative(dataDevice.getNativePtr(), protocol);
-        assert nativePtr != 0; // should've already thrown in native
+        assert nativePtr != 0 : "Failed to initialize the native part of the source"; // should've already thrown in native
         this.data = data;
 
         try {

src/java.desktop/unix/classes/sun/awt/wl/WLGraphicsDevice.java

@@ -128,10 +128,10 @@ private WLGraphicsDevice(int id,
                              int widthLogical, int heightLogical,
                              int widthMm, int heightMm,
                              int displayScale) {
-        assert width > 0 && height > 0;
-        assert widthLogical > 0 && heightLogical > 0;
-        assert widthMm > 0 && heightMm > 0;
-        assert displayScale > 0;
+        assert width > 0 && height > 0 : String.format("Invalid device size: %dx%d", width, height);
+        assert widthLogical > 0 && heightLogical > 0 : String.format("Invalid logical device size: %dx%d", widthLogical, heightLogical);
+        assert widthMm > 0 && heightMm > 0 : String.format("Invalid physical device size: %dx%d", widthMm, heightMm);
+        assert displayScale > 0 : String.format("Invalid display scale: %d", displayScale);
 
         this.wlID = id;
         this.name = name;
@@ -176,10 +176,10 @@ void updateConfiguration(String name,
                              int widthLogical, int heightLogical,
                              int widthMm, int heightMm,
                              int scale) {
-        assert width > 0 && height > 0;
-        assert widthLogical > 0 && heightLogical > 0;
-        assert widthMm > 0 && heightMm > 0;
-        assert scale > 0;
+        assert width > 0 && height > 0 : String.format("Invalid device size: %dx%d", width, height);
+        assert widthLogical > 0 && heightLogical > 0 : String.format("Invalid logical device size: %dx%d", widthLogical, heightLogical);
+        assert widthMm > 0 && heightMm > 0 : String.format("Invalid physical device size: %dx%d", widthMm, heightMm);
+        assert scale > 0 : String.format("Invalid display scale: %d", scale);
 
         this.name = name;
         this.x = x;

src/java.desktop/unix/classes/sun/awt/wl/WLInputState.java

@@ -242,7 +242,9 @@ private PointerButtonEvent getNewPointerButtonEvent(WLPointerEvent pointerEvent,
                                                         WLPointerEvent newEventWithTimestamp,
                                                         WLPointerEvent newEventWithPosition) {
         if (pointerEvent.hasButtonEvent() && pointerEvent.getIsButtonPressed() && newEventWithSurface != null) {
-            assert newEventWithTimestamp != null && newEventWithPosition != null;
+            assert newEventWithTimestamp != null && newEventWithPosition != null
+                    : "Events with timestamp and position are both required to be present";
+
             int clickCount = 1;
             final boolean pressedSameButton = pointerButtonPressedEvent != null
                     && pointerEvent.getButtonCode() == pointerButtonPressedEvent.linuxCode;

src/java.desktop/unix/classes/sun/awt/wl/WLKeyboard.java

@@ -48,7 +48,7 @@ private class KeyRepeatManager {
         // called from native code
         void setRepeatInfo(int charsPerSecond, int delayMillis) {
             // this function receives (0, 0) when key repeat is disabled
-            assert EventQueue.isDispatchThread();
+            assert EventQueue.isDispatchThread() : "Method must only be invoked on EDT";
             this.delayBeforeRepeatMillis = delayMillis;
             if (charsPerSecond > 0) {
                 this.delayBetweenRepeatMillis = (int) (1000.0 / charsPerSecond);
@@ -64,7 +64,7 @@ boolean isRepeatEnabled() {
         }
 
         void cancelRepeat() {
-            assert EventQueue.isDispatchThread();
+            assert EventQueue.isDispatchThread() : "Method must only be invoked on EDT";
             if (currentRepeatTask != null) {
                 currentRepeatTask.cancel();
                 currentRepeatTask = null;
@@ -74,15 +74,15 @@ void cancelRepeat() {
 
         // called from native code
         void stopRepeat(int keycode) {
-            assert EventQueue.isDispatchThread();
+            assert EventQueue.isDispatchThread() : "Method must only be invoked on EDT";
             if (currentRepeatKeycode == keycode) {
                 cancelRepeat();
             }
         }
 
         // called from native code
         void startRepeat(long serial, long timestamp, int keycode) {
-            assert EventQueue.isDispatchThread();
+            assert EventQueue.isDispatchThread() : "Method must only be invoked on EDT";
             cancelRepeat();
             if (keycode == 0 || !isRepeatEnabled()) {
                 return;
@@ -123,7 +123,7 @@ public void run() {
     public native boolean isNumLockPressed();
 
     public void onLostFocus() {
-        assert EventQueue.isDispatchThread();
+        assert EventQueue.isDispatchThread() : "Method must only be invoked on EDT";
         keyRepeatManager.cancelRepeat();
         cancelCompose();
     }

src/java.desktop/unix/classes/sun/awt/wl/WLMainSurface.java

@@ -91,7 +91,7 @@ void notifyLeftOutput(int wlOutputID) {
     }
 
     public void activateByAnotherSurface(long serial, long activatingSurfacePtr) {
-        assert SunToolkit.isAWTLockHeldByCurrentThread();
+        assert SunToolkit.isAWTLockHeldByCurrentThread() : "This method must be invoked while holding the AWT lock";
         assertIsValid();
 
         nativeActivate(getNativePtr(), serial, activatingSurfacePtr);