blob: dd7ff43b77f9d20111254afb41a08a77d39313ad (
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
|
/*******************************************************************************
* Copyright (c) 2000, 2005 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.jface.text.rules;
import org.eclipse.jface.text.IDocument;
/**
* A token scanner scans a range of a document and reports about the token it finds.
* A scanner has state. When asked, the scanner returns the offset and the length of the
* last found token.
*
* @see org.eclipse.jface.text.rules.IToken
* @since 2.0
*/
public interface ITokenScanner {
/**
* Configures the scanner by providing access to the document range that should
* be scanned.
*
* @param document the document to scan
* @param offset the offset of the document range to scan
* @param length the length of the document range to scan
*/
void setRange(IDocument document, int offset, int length);
/**
* Returns the next token in the document.
*
* @return the next token in the document
*/
IToken nextToken();
/**
* Returns the offset of the last token read by this scanner.
*
* @return the offset of the last token read by this scanner
*/
int getTokenOffset();
/**
* Returns the length of the last token read by this scanner.
*
* @return the length of the last token read by this scanner
*/
int getTokenLength();
}
|
