Bug 531048: [GTK3] Large problems drawing ownerdraw tables

Invalidate the GtkStyleContext when sending out SWT.SetData events, as a
commit in GTK3.18 changed the way this happens internally in GTK:

https://gitlab.gnome.org/GNOME/gtk/commit/399df06d1931add5d5b0422f6f99fe4ff1a1faa7

Tested using the snippet attached. The IDE Tables/Trees seem to draw
without issue, no AllNonBrowser JUnit tests fail.

Change-Id: I43570b21f7d8c0f8880409d87198e178dd9e660c
Signed-off-by: Eric Williams <ericwill@redhat.com>

3 files changed, 149 insertions, 0 deletions

diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Table.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Table.java
index c0a979e66b..59f5b83eec 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Table.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Table.java
@@ -286,6 +286,15 @@ boolean checkData (TableItem item) {
 		OS.g_signal_handlers_unblock_matched (modelHandle, mask, signal_id, 0, 0, 0, handle);
 		if (item.isDisposed ()) return false;
 	}
+	/*
+	 * A commit in GTK3.18 caused bug 531048 due to internal changes in GtkStyleContext
+	 * invalidation. The fix is to invalidate the GtkStyleContext manually when changing
+	 * SWT.VIRTUAL Table content. Without it, the internal caching mechanism causes
+	 * the wrong cells to be rendered.
+	 */
+	if (!GTK.GTK4 && GTK.GTK_VERSION >= OS.VERSION(3, 18, 0)) {
+		GTK.gtk_style_context_invalidate(GTK.gtk_widget_get_style_context(handle));
+	}
 	return true;
 }
 
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Tree.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Tree.java
index f8b8648ed6..f7e2dfbe34 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Tree.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Tree.java
@@ -336,6 +336,15 @@ boolean checkData (TreeItem item) {
 		OS.g_signal_handlers_unblock_matched (modelHandle, mask, signal_id, 0, 0, 0, handle);
 		if (item.isDisposed ()) return false;
 	}
+	/*
+	 * A commit in GTK3.18 caused bug 531048 due to internal changes in GtkStyleContext
+	 * invalidation. The fix is to invalidate the GtkStyleContext manually when changing
+	 * SWT.VIRTUAL Table content. Without it, the internal caching mechanism causes
+	 * the wrong cells to be rendered.
+	 */
+	if (!GTK.GTK4 && GTK.GTK_VERSION >= OS.VERSION(3, 18, 0)) {
+		GTK.gtk_style_context_invalidate(GTK.gtk_widget_get_style_context(handle));
+	}
 	return true;
 }
 
diff --git a/tests/org.eclipse.swt.tests.gtk/ManualTests/org/eclipse/swt/tests/gtk/snippets/Bug531048_VirtualTableCheese.java b/tests/org.eclipse.swt.tests.gtk/ManualTests/org/eclipse/swt/tests/gtk/snippets/Bug531048_VirtualTableCheese.java
new file mode 100644
index 0000000000..03a25e395b
--- /dev/null
+++ b/tests/org.eclipse.swt.tests.gtk/ManualTests/org/eclipse/swt/tests/gtk/snippets/Bug531048_VirtualTableCheese.java
@@ -0,0 +1,131 @@
+/*******************************************************************************
+ * Copyright (c) 2019 Red Hat and others. All rights reserved.
+ * The contents of this file are made available under the terms
+ * of the GNU Lesser General Public License (LGPL) Version 2.1 that
+ * accompanies this distribution (lgpl-v21.txt).  The LGPL is also
+ * available at http://www.gnu.org/licenses/lgpl.html.  If the version
+ * of the LGPL at http://www.gnu.org is different to the version of
+ * the LGPL accompanying this distribution and there is any conflict
+ * between the two license versions, the terms of the LGPL accompanying
+ * this distribution shall govern.
+ *
+ * Contributors:
+ *     Red Hat - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.swt.tests.gtk.snippets;
+
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.events.SelectionAdapter;
+import org.eclipse.swt.events.SelectionEvent;
+import org.eclipse.swt.graphics.Point;
+import org.eclipse.swt.graphics.Rectangle;
+import org.eclipse.swt.layout.FillLayout;
+import org.eclipse.swt.widgets.Button;
+import org.eclipse.swt.widgets.Display;
+import org.eclipse.swt.widgets.Listener;
+import org.eclipse.swt.widgets.Shell;
+import org.eclipse.swt.widgets.Table;
+import org.eclipse.swt.widgets.TableColumn;
+import org.eclipse.swt.widgets.TableItem;
+
+/**
+ * @author Thomas Singer
+ */
+public class Bug531048_VirtualTableCheese {
+
+	// Constants ==============================================================
+
+	static final int COUNT1 = 10000;
+	static final int COUNT2 = 100;
+
+	private static boolean packPending = true;
+
+	// Static =================================================================
+
+	public static void main(String[] args) {
+		final Display display = new Display();
+		final Shell shell = new Shell(display);
+		shell.setLayout(new FillLayout(SWT.VERTICAL));
+
+		final Button button = new Button(shell, SWT.NONE);
+		final Table table = new Table(shell, SWT.VIRTUAL | SWT.BORDER | SWT.FULL_SELECTION | SWT.H_SCROLL | SWT.V_SCROLL);
+		button.setText("Change content");
+		button.addSelectionListener(new SelectionAdapter() {
+			@Override
+			public void widgetSelected(SelectionEvent e) {
+				table.setItemCount(table.getItemCount() == COUNT1 ? COUNT2 : COUNT1);
+			}
+		});
+
+		table.setHeaderVisible(true);
+		final Listener listener = event -> {
+			final TableItem item = (TableItem)event.item;
+			if (event.type == SWT.EraseItem) {
+				if (event.index < 2) {
+					event.detail &= ~SWT.FOREGROUND;
+				}
+			}
+			else if (event.type == SWT.PaintItem) {
+				final String text1 = (String)item.getData();
+				if (event.index == 0) {
+					event.gc.drawText(text1, event.x, event.y, true);
+				}
+				else if (event.index == 1) {
+					final Point size = event.gc.textExtent(text1);
+					final Rectangle bounds = item.getBounds(event.index);
+					event.gc.drawText(text1, bounds.x + bounds.width - size.x, bounds.y + bounds.height - size.y, true);
+				}
+			}
+			else if (event.type == SWT.MeasureItem) {
+				final String text2 = (String)item.getData();
+				final Point point = event.gc.textExtent(text2);
+				event.height = point.y * 2;
+				event.width = Math.max(event.width, point.x);
+			}
+			else if (event.type == SWT.SetData) {
+				final int index = table.indexOf(item);
+				final String data = "Item " + index;
+				item.setText(2, data);
+				item.setData(data);
+
+				if (packPending) {
+					packPending = false;
+					display.asyncExec(() -> {
+						table.setRedraw(false);
+						for (TableColumn column : table.getColumns()) {
+							column.pack();
+						}
+						table.setRedraw(true);
+					});
+				}
+			}
+		};
+		table.addListener(SWT.EraseItem, listener);
+		table.addListener(SWT.SetData, listener);
+		table.addListener(SWT.MeasureItem, listener);
+		table.addListener(SWT.PaintItem, listener);
+
+		createColumn(SWT.LEFT, "OD Left", table);
+		createColumn(SWT.RIGHT, "OD Right", table);
+		createColumn(SWT.LEFT, "Primitive", table);
+
+		table.setItemCount(COUNT1);
+		table.setTopIndex(1000);
+
+		shell.setSize(400, 500);
+		shell.open();
+
+		while (!shell.isDisposed()) {
+			if (!display.readAndDispatch()) {
+				display.sleep();
+			}
+		}
+		display.dispose();
+	}
+
+	private static void createColumn(int style, String text, Table table) {
+		final TableColumn tableColumn = new TableColumn(table, style);
+		tableColumn.setText(text);
+		tableColumn.setMoveable(true);
+	}
+}