diff dwtx/jface/text/rules/ICharacterScanner.d @ 129:eb30df5ca28b

Added JFace Text sources
author Frank Benoit <benoit@tionex.de>
date Sat, 23 Aug 2008 19:10:48 +0200
parents
children c4fb132a086c
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dwtx/jface/text/rules/ICharacterScanner.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,56 @@
+/*******************************************************************************
+ * 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
+ * Port to the D programming language:
+ *     Frank Benoit <benoit@tionex.de>
+ *******************************************************************************/
+module dwtx.jface.text.rules.ICharacterScanner;
+
+import dwt.dwthelper.utils;
+
+
+/**
+ * Defines the interface of a character scanner used by rules.
+ * Rules may request the next character or ask the character
+ * scanner to unread the last read character.
+ */
+public interface ICharacterScanner {
+
+    /**
+     * The value returned when this scanner has read EOF.
+     */
+    public static final int EOF= -1;
+
+    /**
+     * Provides rules access to the legal line delimiters. The returned
+     * object may not be modified by clients.
+     *
+     * @return the legal line delimiters
+     */
+    char[][] getLegalLineDelimiters();
+
+    /**
+     * Returns the column of the character scanner.
+     *
+     * @return the column of the character scanner
+     */
+    int getColumn();
+
+    /**
+     * Returns the next character or EOF if end of file has been reached
+     *
+     * @return the next character or EOF
+     */
+    int read();
+
+    /**
+     * Rewinds the scanner before the last read character.
+     */
+    void unread();
+}