Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 14a281858f4c204f575e51981a284682cef5b066 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/*******************************************************************************
 * Copyright (c) 2010 Mat Booth and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/
package org.eclipse.dltk.sh.ui.text.tests;

import org.eclipse.dltk.internal.ui.text.DLTKColorManager;
import org.eclipse.dltk.ui.text.IColorManager;
import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.rules.IToken;
import org.eclipse.jface.text.rules.RuleBasedScanner;
import org.junit.Before;

/**
 * Common base class for rules-based scanner tests.
 */
@SuppressWarnings("restriction")
public abstract class AbstractScannerTester {

	protected IColorManager cm = new DLTKColorManager();
	protected RuleBasedScanner scanner;

	/**
	 * Reset the scanner before every test.
	 */
	@Before
	public void setup() {
		scanner = getScanner();
		scanner.setRange(new Document(getText()), 0, getText().length());
	}

	/**
	 * To be implemented by the test.
	 * 
	 * @return an instance of the scanner under test
	 */
	protected abstract RuleBasedScanner getScanner();

	/**
	 * To be implemented by the test.
	 * 
	 * @return the text that will be used to test the scanner
	 */
	protected abstract String getText();

	/**
	 * Gets the nth token from the scanner's document.
	 * 
	 * @param n
	 *            1 for the very next token, 2 for the token after that, etc
	 * @return the nth token
	 */
	protected IToken getNthToken(int n) {
		for (int i = 0; i < n - 1; i++) {
			scanner.nextToken();
		}
		return scanner.nextToken();
	}

	/**
	 * Gets the very next token from the scanner's document.
	 * 
	 * @return the next token
	 */
	protected IToken getNextToken() {
		return getNthToken(1);
	}
}

Back to the top