Merge pull request #9417 from Adam-/tooltip-crash

Fix tooltip error handling

runelite-client/src/main/java/net/runelite/client/ui/overlay/OverlayRenderer.java

@@ -37,6 +37,7 @@ import java.util.List;
 import javax.inject.Inject;
 import javax.inject.Singleton;
 import javax.swing.SwingUtilities;
+import lombok.extern.slf4j.Slf4j;
 import net.runelite.api.Client;
 import net.runelite.api.GameState;
 import net.runelite.api.MenuAction;
@@ -56,6 +57,7 @@ import net.runelite.client.ui.JagexColors;
 import net.runelite.client.util.ColorUtil;
 
 @Singleton
+@Slf4j
 public class OverlayRenderer extends MouseAdapter implements KeyListener
 {
 	private static final int BORDER = 5;
@@ -458,8 +460,23 @@ public class OverlayRenderer extends MouseAdapter implements KeyListener
 		}
 
 		subGraphics.translate(point.x, point.y);
-		final Dimension dimension = MoreObjects.firstNonNull(overlay.render(subGraphics), new Dimension());
+
-		subGraphics.dispose();
+		final Dimension overlayDimension;
+		try
+		{
+			overlayDimension = overlay.render(subGraphics);
+		}
+		catch (Exception ex)
+		{
+			log.warn("Error during overlay rendering", ex);
+			return;
+		}
+		finally
+		{
+			subGraphics.dispose();
+		}
+
+		final Dimension dimension = MoreObjects.firstNonNull(overlayDimension, new Dimension());
 		overlay.setBounds(new Rectangle(point, dimension));
 	}
 

runelite-client/src/main/java/net/runelite/client/ui/overlay/components/TooltipComponent.java

@@ -24,6 +24,7 @@
  */
 package net.runelite.client.ui.overlay.components;
 
+import com.google.common.annotations.VisibleForTesting;
 import java.awt.Color;
 import java.awt.Dimension;
 import java.awt.FontMetrics;
@@ -96,6 +97,7 @@ public class TooltipComponent implements RenderableEntity
 			char[] chars = line.toCharArray();
 
 			int begin = 0;
+			boolean inTag = false;
 			for (int j = 0; j < chars.length; j++)
 			{
 				if (chars[j] == '<')
@@ -110,8 +112,9 @@ public class TooltipComponent implements RenderableEntity
 					lineX += metrics.stringWidth(text);
 
 					begin = j;
+					inTag = true;
 				}
-				else if (chars[j] == '>')
+				else if (chars[j] == '>' && inTag)
 				{
 					String subLine = line.substring(begin + 1, j);
 
@@ -148,6 +151,7 @@ public class TooltipComponent implements RenderableEntity
 					}
 
 					begin = j + 1;
+					inTag = false;
 				}
 			}
 
@@ -162,12 +166,14 @@ public class TooltipComponent implements RenderableEntity
 		return new Dimension(tooltipWidth + OFFSET * 2, tooltipHeight + OFFSET * 2);
 	}
 
-	private static int calculateTextWidth(FontMetrics metrics, String line)
+	@VisibleForTesting
+	static int calculateTextWidth(FontMetrics metrics, String line)
 	{
 		char[] chars = line.toCharArray();
 		int textWidth = 0;
 
 		int begin = 0;
+		boolean inTag = false;
 		for (int j = 0; j < chars.length; j++)
 		{
 			if (chars[j] == '<')
@@ -175,8 +181,9 @@ public class TooltipComponent implements RenderableEntity
 				textWidth += metrics.stringWidth(line.substring(begin, j));
 
 				begin = j;
+				inTag = true;
 			}
-			else if (chars[j] == '>')
+			else if (chars[j] == '>' && inTag)
 			{
 				String subLine = line.substring(begin + 1, j);
 
@@ -190,6 +197,7 @@ public class TooltipComponent implements RenderableEntity
 				}
 
 				begin = j + 1;
+				inTag = false;
 			}
 		}
 

runelite-client/src/main/java/net/runelite/client/ui/overlay/tooltip/TooltipOverlay.java

@@ -66,6 +66,19 @@ public class TooltipOverlay extends Overlay
 			return null;
 		}
 
+		try
+		{
+			return renderTooltips(graphics, tooltips);
+		}
+		finally
+		{
+			// Tooltips must always be cleared each frame
+			tooltipManager.clear();
+		}
+	}
+
+	private Dimension renderTooltips(Graphics2D graphics, List<Tooltip> tooltips)
+	{
 		final Rectangle clientCanvasBounds = new Rectangle(client.getRealDimensions());
 		final net.runelite.api.Point mouseCanvasPosition = client.getMouseCanvasPosition();
 		final Point mousePosition = new Point(mouseCanvasPosition.getX(), mouseCanvasPosition.getY() + OFFSET);
@@ -113,7 +126,6 @@ public class TooltipOverlay extends Overlay
 			newBounds.width = Math.max(newBounds.width, dimension.width);
 		}
 
-		tooltipManager.clear();
 		return newBounds.getSize();
 	}
 }

runelite-client/src/test/java/net/runelite/client/ui/overlay/components/TooltipComponentTest.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2019, Adam <Adam@sigterm.info>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package net.runelite.client.ui.overlay.components;
+
+import java.awt.FontMetrics;
+import static net.runelite.client.ui.overlay.components.TooltipComponent.calculateTextWidth;
+import static org.junit.Assert.assertEquals;
+import org.junit.Test;
+import static org.mockito.Matchers.anyString;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+public class TooltipComponentTest
+{
+	@Test
+	public void testCalculateTextWidth()
+	{
+		FontMetrics fontMetics = mock(FontMetrics.class);
+		when(fontMetics.stringWidth(anyString())).thenAnswer((invocation) -> ((String) invocation.getArguments()[0]).length());
+
+		assertEquals(11, calculateTextWidth(fontMetics, "line1<col=ff0000>>line2"));
+	}
+}