blob: 97c0d726c389128fcf705dbfc8c85d9f2eadb613 (
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
|
/*******************************************************************************
* Copyright (c) 2000, 2011 IBM Corporation 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
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.compare.contentmergeviewer;
import org.eclipse.compare.rangedifferencer.IRangeComparator;
/**
* For performing a so-called "token compare" on a line of text.
* This interface extends the <code>IRangeComparator</code> interface
* so that it can be used by the <code>TextMergeViewer</code>.
* <p>
* <code>TextMergeViewer</code> activates the token compare when navigating into
* a range of differing lines. At first the lines are selected as a block.
* When navigating into this block the token compare shows for every line
* the differing token by selecting them.
* <p>
* <code>TextMergeViewer</code>'s default token comparator works on characters separated
* by whitespace. If a different strategy is needed (for example, to use Java tokens in
* a Java-aware merge viewer), clients may create their own token
* comparators by implementing this interface (and overriding the
* <code>TextMergeViewer.createTokenComparator</code> factory method).
* </p>
*
* @see TextMergeViewer
*/
public interface ITokenComparator extends IRangeComparator {
/**
* Returns the start character position of the token with the given index.
* If the index is out of range (but not negative) the character position
* behind the last character (the length of the input string) is returned.
*
* @param index index of the token for which to return the start position
* @return the start position of the token with the given index
* @throws java.lang.IndexOutOfBoundsException if index is negative
*/
int getTokenStart(int index);
/**
* Returns the character length of the token with the given index.
* If the index is out of range (but not negative) the value 0 is returned.
*
* @param index index of the token for which to return the start position
* @return the character length of the token with the given index
* @throws java.lang.IndexOutOfBoundsException if index is negative
*/
int getTokenLength(int index);
}
|
