org.eclipse.jface.text.tests/src/org/eclipse/jface/text/tests/TextViewerTest.java - platform/eclipse.platform.text - Git at Google

 /*******************************************************************************
  * Copyright (c) 2014, 2019 Google, Inc and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
  * https://www.eclipse.org/legal/epl-2.0/
  *
  * SPDX-License-Identifier: EPL-2.0
  *
  * Contributors:
  * 	   Sergey Prigogin (Google) - initial API and implementation
  * 	   Mickael Istria (Red Hat Inc.) - [Bug 544708] Ctrl+Home
  * 	   Paul Pazderski - [Bug 545530] Test for TextViewer's default IDocumentAdapter implementation.
  *******************************************************************************/
 package org.eclipse.jface.text.tests;

 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 import static org.junit.Assume.assumeNotNull;

 import java.util.concurrent.atomic.AtomicBoolean;

 import org.junit.Assume;
 import org.junit.Rule;
 import org.junit.Test;

 import org.eclipse.swt.SWT;
 import org.eclipse.swt.custom.StyledTextContent;
 import org.eclipse.swt.layout.FillLayout;
 import org.eclipse.swt.widgets.Control;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Event;
 import org.eclipse.swt.widgets.Listener;
 import org.eclipse.swt.widgets.Shell;

 import org.eclipse.jface.util.Util;

 import org.eclipse.jface.text.Document;
 import org.eclipse.jface.text.IDocumentAdapter;
 import org.eclipse.jface.text.ITextViewer;
 import org.eclipse.jface.text.TextViewer;
 import org.eclipse.jface.text.source.SourceViewer;
 import org.eclipse.jface.text.tests.util.DisplayHelper;

 /**
  * Basic tests for TextViewer.
  */
 public class TextViewerTest {

 	@Rule public ScreenshotOnFailureRule screenshotRule = new ScreenshotOnFailureRule();

 	@Test
 	public void testSetRedraw_Bug441827() throws Exception {
 		Shell shell= new Shell();
 		try {
 			TextViewer textViewer= new TextViewer(shell, SWT.NONE);
 			Document document= new Document("abc");
 			textViewer.setDocument(document);
 			int len= document.getLength();
 			// Select the whole document with the caret at the beginning.
 			textViewer.setSelectedRange(len, -len);
 			assertEquals(0, textViewer.getSelectedRange().x);
 			assertEquals(len, textViewer.getSelectedRange().y);
 			assertEquals(0, textViewer.getTextWidget().getCaretOffset());
 			textViewer.setRedraw(false);
 			textViewer.setRedraw(true);
 			// Check that the selection and the caret position are preserved.
 			assertEquals(0, textViewer.getSelectedRange().x);
 			assertEquals(len, textViewer.getSelectedRange().y);
 			assertEquals(0, textViewer.getTextWidget().getCaretOffset());
 		} finally {
 			shell.dispose();
 		}
 	}

 	@Test
 	public void testCtrlHomeViewportListener() {
 		Assume.assumeFalse("See bug 541415. For whatever reason, this shortcut doesn't work on Mac", Util.isMac());
 		Shell shell= new Shell();
 		try {
 			shell.setLayout(new FillLayout());
 			shell.setSize(500, 200);
 			SourceViewer textViewer= new SourceViewer(shell, null, SWT.NONE);
 			textViewer.setDocument(new Document(generate5000Lines()));
 			shell.open();
 			textViewer.revealRange(4000, 1);
 			AtomicBoolean notifyHomeReached = new AtomicBoolean();
 			ctrlEnd(textViewer);
 			DisplayHelper.sleep(textViewer.getTextWidget().getDisplay(), 1000);
 			textViewer.addViewportListener(offset -> notifyHomeReached.set(offset == 0));
 			ctrlHome(textViewer);
 			assertTrue(new DisplayHelper() {
 				@Override
 				protected boolean condition() {
 					return notifyHomeReached.get();
 				}
 			}.waitForCondition(textViewer.getTextWidget().getDisplay(), 3000));
 		} finally {
 			shell.dispose();
 		}
 	}

 	@Test
 	public void testCtrlEndViewportListener() {
 		Assume.assumeFalse("See bug 541415. For whatever reason, this shortcut doesn't work on Mac", Util.isMac());
 		Shell shell= new Shell();
 		try {
 			shell.setLayout(new FillLayout());
 			shell.setSize(500, 200);
 			SourceViewer textViewer= new SourceViewer(shell, null, SWT.NONE);
 			Document document= new Document(generate5000Lines());
 			textViewer.setDocument(document);
 			shell.open();
 			AtomicBoolean notifyEndReached = new AtomicBoolean();
 			textViewer.addViewportListener(offset ->
 				notifyEndReached.set(offset > 4000));
 			ctrlEnd(textViewer);
 			assertTrue(new DisplayHelper() {
 				@Override
 				protected boolean condition() {
 					return notifyEndReached.get();
 				}
 			}.waitForCondition(textViewer.getControl().getDisplay(), 3000));
 		} finally {
 			shell.dispose();
 		}
 	}

 	/**
 	 * Test if {@link TextViewer}s default {@link IDocumentAdapter} implementation adhere to
 	 * {@link IDocumentAdapter}s JavaDoc.
 	 */
 	@Test
 	public void testDefaultContentImplementation() {
 		final Shell shell= new Shell();
 		try {
 			final StyledTextContent content;
 			try {
 				final TextViewer textViewer= new TextViewer(shell, SWT.NONE);
 				textViewer.setDocument(new Document());
 				content= textViewer.getTextWidget().getContent();
 			} catch (Exception ex) {
 				fail("Failed to obtain default instance of TextViewers document adapter. " + ex.getMessage());
 				return;
 			}
 			assumeNotNull(content);

 			final String line0= "Hello ";
 			final String line1= "";
 			final String line2= "World!";
 			final String text= line0 + "\n" + line1 + "\r\n" + line2;
 			content.setText(text);
 			assertEquals("Get text range failed.", "H", content.getTextRange(0, 1));
 			assertEquals("Get text range failed.", "ll", content.getTextRange(2, 2));
 			assertEquals("Adapter content length wrong.", text.length(), content.getCharCount());
 			assertEquals("Adapter returned wrong content.", line0, content.getLine(0));
 			assertEquals("Adapter returned wrong content.", line1, content.getLine(1));
 			assertEquals("Adapter returned wrong content.", line2, content.getLine(2));

 			content.setText("\r\n\r\n");
 			assertEquals("Wrong line for offset.", 0, content.getLineAtOffset(0));
 			assertEquals("Wrong line for offset.", 0, content.getLineAtOffset(1));
 			assertEquals("Wrong line for offset.", 1, content.getLineAtOffset(2));
 			assertEquals("Wrong line for offset.", 1, content.getLineAtOffset(3));
 			assertEquals("Wrong line for offset.", 2, content.getLineAtOffset(4));
 			assertEquals("Wrong line for offset.", content.getLineCount() - 1, content.getLineAtOffset(content.getCharCount()));

 			content.setText(null);
 			assertEquals("Adapter returned wrong line count.", 1, content.getLineCount());
 			content.setText("");
 			assertEquals("Adapter returned wrong line count.", 1, content.getLineCount());
 			content.setText("a\n");
 			assertEquals("Adapter returned wrong line count.", 2, content.getLineCount());
 			content.setText("\n\n");
 			assertEquals("Adapter returned wrong line count.", 3, content.getLineCount());

 			content.setText("\r\ntest\r\n");
 			assertEquals("Wrong offset for line.", 0, content.getOffsetAtLine(0));
 			assertEquals("Wrong offset for line.", 2, content.getOffsetAtLine(1));
 			assertEquals("Wrong offset for line.", 8, content.getOffsetAtLine(2));
 			content.setText("");
 			assertEquals("Wrong offset for line.", 0, content.getOffsetAtLine(0));
 		} finally {
 			shell.dispose();
 		}
 	}

 	public static void ctrlEnd(ITextViewer viewer) {
 		postKeyEvent(viewer.getTextWidget(), SWT.END, SWT.CTRL, SWT.KeyDown);
 	}

 	public static void ctrlHome(ITextViewer viewer) {
 		postKeyEvent(viewer.getTextWidget(), SWT.HOME, SWT.CTRL, SWT.KeyDown);
 	}

 	private static void postKeyEvent(Control widget, int keyCode, int stateMask, int type) {
 		Display display= widget.getDisplay();
 		widget.setFocus();
 		DisplayHelper.driveEventQueue(display);
 		Event event = new Event();
 		event.widget = widget;
 		event.keyCode = keyCode;
 		event.stateMask = stateMask;
 		event.type = type;
 		event.doit = true;
 		// display.post(event) seem not always work, see bug 541415
 		Listener[] listeners= widget.getListeners(type);
 		for (Listener listener : listeners) {
 			listener.handleEvent(event);
 		}
 		DisplayHelper.driveEventQueue(display);
 	}

 	public static String generate5000Lines() {
 		StringBuilder b = new StringBuilder("start");
 		for (int i = 0; i < 5000; i++) {
 			b.append('\n');
 		}
 		b.append("end");
 		return b.toString();
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2014, 2019 Google, Inc and others.
	*
	* This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License 2.0
	* which accompanies this distribution, and is available at
	* https://www.eclipse.org/legal/epl-2.0/
	*
	* SPDX-License-Identifier: EPL-2.0
	*
	* Contributors:
	* Sergey Prigogin (Google) - initial API and implementation
	* Mickael Istria (Red Hat Inc.) - [Bug 544708] Ctrl+Home
	* Paul Pazderski - [Bug 545530] Test for TextViewer's default IDocumentAdapter implementation.
	*******************************************************************************/
	package org.eclipse.jface.text.tests;

	import static org.junit.Assert.assertEquals;
	import static org.junit.Assert.assertTrue;
	import static org.junit.Assert.fail;
	import static org.junit.Assume.assumeNotNull;

	import java.util.concurrent.atomic.AtomicBoolean;

	import org.junit.Assume;
	import org.junit.Rule;
	import org.junit.Test;

	import org.eclipse.swt.SWT;
	import org.eclipse.swt.custom.StyledTextContent;
	import org.eclipse.swt.layout.FillLayout;
	import org.eclipse.swt.widgets.Control;
	import org.eclipse.swt.widgets.Display;
	import org.eclipse.swt.widgets.Event;
	import org.eclipse.swt.widgets.Listener;
	import org.eclipse.swt.widgets.Shell;

	import org.eclipse.jface.util.Util;

	import org.eclipse.jface.text.Document;
	import org.eclipse.jface.text.IDocumentAdapter;
	import org.eclipse.jface.text.ITextViewer;
	import org.eclipse.jface.text.TextViewer;
	import org.eclipse.jface.text.source.SourceViewer;
	import org.eclipse.jface.text.tests.util.DisplayHelper;

	/**
	* Basic tests for TextViewer.
	*/
	public class TextViewerTest {

	@Rule public ScreenshotOnFailureRule screenshotRule = new ScreenshotOnFailureRule();

	@Test
	public void testSetRedraw_Bug441827() throws Exception {
	Shell shell= new Shell();
	try {
	TextViewer textViewer= new TextViewer(shell, SWT.NONE);
	Document document= new Document("abc");
	textViewer.setDocument(document);
	int len= document.getLength();
	// Select the whole document with the caret at the beginning.
	textViewer.setSelectedRange(len, -len);
	assertEquals(0, textViewer.getSelectedRange().x);
	assertEquals(len, textViewer.getSelectedRange().y);
	assertEquals(0, textViewer.getTextWidget().getCaretOffset());
	textViewer.setRedraw(false);
	textViewer.setRedraw(true);
	// Check that the selection and the caret position are preserved.
	assertEquals(0, textViewer.getSelectedRange().x);
	assertEquals(len, textViewer.getSelectedRange().y);
	assertEquals(0, textViewer.getTextWidget().getCaretOffset());
	} finally {
	shell.dispose();
	}
	}

	@Test
	public void testCtrlHomeViewportListener() {
	Assume.assumeFalse("See bug 541415. For whatever reason, this shortcut doesn't work on Mac", Util.isMac());
	Shell shell= new Shell();
	try {
	shell.setLayout(new FillLayout());
	shell.setSize(500, 200);
	SourceViewer textViewer= new SourceViewer(shell, null, SWT.NONE);
	textViewer.setDocument(new Document(generate5000Lines()));
	shell.open();
	textViewer.revealRange(4000, 1);
	AtomicBoolean notifyHomeReached = new AtomicBoolean();
	ctrlEnd(textViewer);
	DisplayHelper.sleep(textViewer.getTextWidget().getDisplay(), 1000);
	textViewer.addViewportListener(offset -> notifyHomeReached.set(offset == 0));
	ctrlHome(textViewer);
	assertTrue(new DisplayHelper() {
	@Override
	protected boolean condition() {
	return notifyHomeReached.get();
	}
	}.waitForCondition(textViewer.getTextWidget().getDisplay(), 3000));
	} finally {
	shell.dispose();
	}
	}

	@Test
	public void testCtrlEndViewportListener() {
	Assume.assumeFalse("See bug 541415. For whatever reason, this shortcut doesn't work on Mac", Util.isMac());
	Shell shell= new Shell();
	try {
	shell.setLayout(new FillLayout());
	shell.setSize(500, 200);
	SourceViewer textViewer= new SourceViewer(shell, null, SWT.NONE);
	Document document= new Document(generate5000Lines());
	textViewer.setDocument(document);
	shell.open();
	AtomicBoolean notifyEndReached = new AtomicBoolean();
	textViewer.addViewportListener(offset ->
	notifyEndReached.set(offset > 4000));
	ctrlEnd(textViewer);
	assertTrue(new DisplayHelper() {
	@Override
	protected boolean condition() {
	return notifyEndReached.get();
	}
	}.waitForCondition(textViewer.getControl().getDisplay(), 3000));
	} finally {
	shell.dispose();
	}
	}

	/**
	* Test if {@link TextViewer}s default {@link IDocumentAdapter} implementation adhere to
	* {@link IDocumentAdapter}s JavaDoc.
	*/
	@Test
	public void testDefaultContentImplementation() {
	final Shell shell= new Shell();
	try {
	final StyledTextContent content;
	try {
	final TextViewer textViewer= new TextViewer(shell, SWT.NONE);
	textViewer.setDocument(new Document());
	content= textViewer.getTextWidget().getContent();
	} catch (Exception ex) {
	fail("Failed to obtain default instance of TextViewers document adapter. " + ex.getMessage());
	return;
	}
	assumeNotNull(content);

	final String line0= "Hello ";
	final String line1= "";
	final String line2= "World!";
	final String text= line0 + "\n" + line1 + "\r\n" + line2;
	content.setText(text);
	assertEquals("Get text range failed.", "H", content.getTextRange(0, 1));
	assertEquals("Get text range failed.", "ll", content.getTextRange(2, 2));
	assertEquals("Adapter content length wrong.", text.length(), content.getCharCount());
	assertEquals("Adapter returned wrong content.", line0, content.getLine(0));
	assertEquals("Adapter returned wrong content.", line1, content.getLine(1));
	assertEquals("Adapter returned wrong content.", line2, content.getLine(2));

	content.setText("\r\n\r\n");
	assertEquals("Wrong line for offset.", 0, content.getLineAtOffset(0));
	assertEquals("Wrong line for offset.", 0, content.getLineAtOffset(1));
	assertEquals("Wrong line for offset.", 1, content.getLineAtOffset(2));
	assertEquals("Wrong line for offset.", 1, content.getLineAtOffset(3));
	assertEquals("Wrong line for offset.", 2, content.getLineAtOffset(4));
	assertEquals("Wrong line for offset.", content.getLineCount() - 1, content.getLineAtOffset(content.getCharCount()));

	content.setText(null);
	assertEquals("Adapter returned wrong line count.", 1, content.getLineCount());
	content.setText("");
	assertEquals("Adapter returned wrong line count.", 1, content.getLineCount());
	content.setText("a\n");
	assertEquals("Adapter returned wrong line count.", 2, content.getLineCount());
	content.setText("\n\n");
	assertEquals("Adapter returned wrong line count.", 3, content.getLineCount());

	content.setText("\r\ntest\r\n");
	assertEquals("Wrong offset for line.", 0, content.getOffsetAtLine(0));
	assertEquals("Wrong offset for line.", 2, content.getOffsetAtLine(1));
	assertEquals("Wrong offset for line.", 8, content.getOffsetAtLine(2));
	content.setText("");
	assertEquals("Wrong offset for line.", 0, content.getOffsetAtLine(0));
	} finally {
	shell.dispose();
	}
	}

	public static void ctrlEnd(ITextViewer viewer) {
	postKeyEvent(viewer.getTextWidget(), SWT.END, SWT.CTRL, SWT.KeyDown);
	}

	public static void ctrlHome(ITextViewer viewer) {
	postKeyEvent(viewer.getTextWidget(), SWT.HOME, SWT.CTRL, SWT.KeyDown);
	}

	private static void postKeyEvent(Control widget, int keyCode, int stateMask, int type) {
	Display display= widget.getDisplay();
	widget.setFocus();
	DisplayHelper.driveEventQueue(display);
	Event event = new Event();
	event.widget = widget;
	event.keyCode = keyCode;
	event.stateMask = stateMask;
	event.type = type;
	event.doit = true;
	// display.post(event) seem not always work, see bug 541415
	Listener[] listeners= widget.getListeners(type);
	for (Listener listener : listeners) {
	listener.handleEvent(event);
	}
	DisplayHelper.driveEventQueue(display);
	}

	public static String generate5000Lines() {
	StringBuilder b = new StringBuilder("start");
	for (int i = 0; i < 5000; i++) {
	b.append('\n');
	}
	b.append("end");
	return b.toString();
	}
	}