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