|
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
|
|
|
15 import dwt.dwthelper.utils;
|
|
|
16
|
|
|
17
|
|
|
18 /**
|
|
|
19 * Defines the interface of a character scanner used by rules.
|
|
|
20 * Rules may request the next character or ask the character
|
|
|
21 * scanner to unread the last read character.
|
|
|
22 */
|
|
|
23 public interface ICharacterScanner {
|
|
|
24
|
|
|
25 /**
|
|
|
26 * The value returned when this scanner has read EOF.
|
|
|
27 */
|
|
|
28 public static final int EOF= -1;
|
|
|
29
|
|
|
30 /**
|
|
|
31 * Provides rules access to the legal line delimiters. The returned
|
|
|
32 * object may not be modified by clients.
|
|
|
33 *
|
|
|
34 * @return the legal line delimiters
|
|
|
35 */
|
|
|
36 char[][] getLegalLineDelimiters();
|
|
|
37
|
|
|
38 /**
|
|
|
39 * Returns the column of the character scanner.
|
|
|
40 *
|
|
|
41 * @return the column of the character scanner
|
|
|
42 */
|
|
|
43 int getColumn();
|
|
|
44
|
|
|
45 /**
|
|
|
46 * Returns the next character or EOF if end of file has been reached
|
|
|
47 *
|
|
|
48 * @return the next character or EOF
|
|
|
49 */
|
|
|
50 int read();
|
|
|
51
|
|
|
52 /**
|
|
|
53 * Rewinds the scanner before the last read character.
|
|
|
54 */
|
|
|
55 void unread();
|
|
|
56 }
|
