|
129
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
|
|
|
3 * All rights reserved. This program and the accompanying materials
|
|
|
4 * are made available under the terms of the Eclipse Public License v1.0
|
|
|
5 * which accompanies this distribution, and is available at
|
|
|
6 * http://www.eclipse.org/legal/epl-v10.html
|
|
|
7 *
|
|
|
8 * Contributors:
|
|
|
9 * IBM Corporation - initial API and implementation
|
|
|
10 * Port to the D programming language:
|
|
|
11 * Frank Benoit <benoit@tionex.de>
|
|
|
12 *******************************************************************************/
|
|
|
13
|
|
131
|
14
|
|
151
|
15 module dwtx.jface.text.rules.ITokenScanner;
|
|
|
16
|
|
131
|
17 import dwtx.jface.text.rules.FastPartitioner; // packageimport
|
|
|
18 import dwtx.jface.text.rules.Token; // packageimport
|
|
|
19 import dwtx.jface.text.rules.RuleBasedScanner; // packageimport
|
|
|
20 import dwtx.jface.text.rules.EndOfLineRule; // packageimport
|
|
|
21 import dwtx.jface.text.rules.WordRule; // packageimport
|
|
|
22 import dwtx.jface.text.rules.WhitespaceRule; // packageimport
|
|
|
23 import dwtx.jface.text.rules.WordPatternRule; // packageimport
|
|
|
24 import dwtx.jface.text.rules.IPredicateRule; // packageimport
|
|
|
25 import dwtx.jface.text.rules.DefaultPartitioner; // packageimport
|
|
|
26 import dwtx.jface.text.rules.NumberRule; // packageimport
|
|
|
27 import dwtx.jface.text.rules.SingleLineRule; // packageimport
|
|
|
28 import dwtx.jface.text.rules.PatternRule; // packageimport
|
|
|
29 import dwtx.jface.text.rules.IWordDetector; // packageimport
|
|
|
30 import dwtx.jface.text.rules.RuleBasedDamagerRepairer; // packageimport
|
|
|
31 import dwtx.jface.text.rules.ICharacterScanner; // packageimport
|
|
|
32 import dwtx.jface.text.rules.IRule; // packageimport
|
|
|
33 import dwtx.jface.text.rules.DefaultDamagerRepairer; // packageimport
|
|
|
34 import dwtx.jface.text.rules.IToken; // packageimport
|
|
|
35 import dwtx.jface.text.rules.IPartitionTokenScanner; // packageimport
|
|
|
36 import dwtx.jface.text.rules.MultiLineRule; // packageimport
|
|
|
37 import dwtx.jface.text.rules.RuleBasedPartitioner; // packageimport
|
|
|
38 import dwtx.jface.text.rules.RuleBasedPartitionScanner; // packageimport
|
|
|
39 import dwtx.jface.text.rules.BufferedRuleBasedScanner; // packageimport
|
|
|
40 import dwtx.jface.text.rules.IWhitespaceDetector; // packageimport
|
|
|
41
|
|
129
|
42 import dwt.dwthelper.utils;
|
|
|
43
|
|
|
44
|
|
|
45 import dwtx.jface.text.IDocument;
|
|
|
46
|
|
|
47
|
|
|
48 /**
|
|
|
49 * A token scanner scans a range of a document and reports about the token it finds.
|
|
|
50 * A scanner has state. When asked, the scanner returns the offset and the length of the
|
|
|
51 * last found token.
|
|
|
52 *
|
|
|
53 * @see dwtx.jface.text.rules.IToken
|
|
|
54 * @since 2.0
|
|
|
55 */
|
|
|
56 public interface ITokenScanner {
|
|
|
57
|
|
|
58 /**
|
|
|
59 * Configures the scanner by providing access to the document range that should
|
|
|
60 * be scanned.
|
|
|
61 *
|
|
|
62 * @param document the document to scan
|
|
|
63 * @param offset the offset of the document range to scan
|
|
|
64 * @param length the length of the document range to scan
|
|
|
65 */
|
|
|
66 void setRange(IDocument document, int offset, int length);
|
|
|
67
|
|
|
68 /**
|
|
|
69 * Returns the next token in the document.
|
|
|
70 *
|
|
|
71 * @return the next token in the document
|
|
|
72 */
|
|
|
73 IToken nextToken();
|
|
|
74
|
|
|
75 /**
|
|
|
76 * Returns the offset of the last token read by this scanner.
|
|
|
77 *
|
|
|
78 * @return the offset of the last token read by this scanner
|
|
|
79 */
|
|
|
80 int getTokenOffset();
|
|
|
81
|
|
|
82 /**
|
|
|
83 * Returns the length of the last token read by this scanner.
|
|
|
84 *
|
|
|
85 * @return the length of the last token read by this scanner
|
|
|
86 */
|
|
|
87 int getTokenLength();
|
|
|
88 }
|
