|
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 module dwtx.jface.text.rules.ICharacterScanner;
|
|
|
14
|
|
131
|
15 import dwtx.jface.text.rules.FastPartitioner; // packageimport
|
|
|
16 import dwtx.jface.text.rules.ITokenScanner; // packageimport
|
|
|
17 import dwtx.jface.text.rules.Token; // packageimport
|
|
|
18 import dwtx.jface.text.rules.RuleBasedScanner; // packageimport
|
|
|
19 import dwtx.jface.text.rules.EndOfLineRule; // packageimport
|
|
|
20 import dwtx.jface.text.rules.WordRule; // packageimport
|
|
|
21 import dwtx.jface.text.rules.WhitespaceRule; // packageimport
|
|
|
22 import dwtx.jface.text.rules.WordPatternRule; // packageimport
|
|
|
23 import dwtx.jface.text.rules.IPredicateRule; // packageimport
|
|
|
24 import dwtx.jface.text.rules.DefaultPartitioner; // packageimport
|
|
|
25 import dwtx.jface.text.rules.NumberRule; // packageimport
|
|
|
26 import dwtx.jface.text.rules.SingleLineRule; // packageimport
|
|
|
27 import dwtx.jface.text.rules.PatternRule; // packageimport
|
|
|
28 import dwtx.jface.text.rules.RuleBasedDamagerRepairer; // packageimport
|
|
|
29 import dwtx.jface.text.rules.IRule; // packageimport
|
|
|
30 import dwtx.jface.text.rules.DefaultDamagerRepairer; // packageimport
|
|
|
31 import dwtx.jface.text.rules.IToken; // packageimport
|
|
|
32 import dwtx.jface.text.rules.IPartitionTokenScanner; // packageimport
|
|
|
33 import dwtx.jface.text.rules.MultiLineRule; // packageimport
|
|
|
34 import dwtx.jface.text.rules.RuleBasedPartitioner; // packageimport
|
|
|
35 import dwtx.jface.text.rules.RuleBasedPartitionScanner; // packageimport
|
|
|
36 import dwtx.jface.text.rules.BufferedRuleBasedScanner; // packageimport
|
|
|
37 import dwtx.jface.text.rules.IWhitespaceDetector; // packageimport
|
|
|
38
|
|
|
39
|
|
129
|
40 import dwt.dwthelper.utils;
|
|
|
41
|
|
|
42
|
|
|
43 /**
|
|
|
44 * Defines the interface of a character scanner used by rules.
|
|
|
45 * Rules may request the next character or ask the character
|
|
|
46 * scanner to unread the last read character.
|
|
|
47 */
|
|
|
48 public interface ICharacterScanner {
|
|
|
49
|
|
|
50 /**
|
|
|
51 * The value returned when this scanner has read EOF.
|
|
|
52 */
|
|
147
|
53 public static const int EOF= -1;
|
|
129
|
54
|
|
|
55 /**
|
|
|
56 * Provides rules access to the legal line delimiters. The returned
|
|
|
57 * object may not be modified by clients.
|
|
|
58 *
|
|
|
59 * @return the legal line delimiters
|
|
|
60 */
|
|
|
61 char[][] getLegalLineDelimiters();
|
|
|
62
|
|
|
63 /**
|
|
|
64 * Returns the column of the character scanner.
|
|
|
65 *
|
|
|
66 * @return the column of the character scanner
|
|
|
67 */
|
|
|
68 int getColumn();
|
|
|
69
|
|
|
70 /**
|
|
|
71 * Returns the next character or EOF if end of file has been reached
|
|
|
72 *
|
|
|
73 * @return the next character or EOF
|
|
|
74 */
|
|
|
75 int read();
|
|
|
76
|
|
|
77 /**
|
|
|
78 * Rewinds the scanner before the last read character.
|
|
|
79 */
|
|
|
80 void unread();
|
|
|
81 }
|
