diff dwtx/jface/text/rules/ITokenScanner.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/ITokenScanner.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,62 @@
+/*******************************************************************************
+ * 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.ITokenScanner;
+
+import dwt.dwthelper.utils;
+
+
+import dwtx.jface.text.IDocument;
+
+
+/**
+ * A token scanner scans a range of a document and reports about the token it finds.
+ * A scanner has state. When asked, the scanner returns the offset and the length of the
+ * last found token.
+ *
+ * @see dwtx.jface.text.rules.IToken
+ * @since 2.0
+ */
+public interface ITokenScanner {
+
+    /**
+     * Configures the scanner by providing access to the document range that should
+     * be scanned.
+     *
+     * @param document the document to scan
+     * @param offset the offset of the document range to scan
+     * @param length the length of the document range to scan
+     */
+    void setRange(IDocument document, int offset, int length);
+
+    /**
+     * Returns the next token in the document.
+     *
+     * @return the next token in the document
+     */
+    IToken nextToken();
+
+    /**
+     * Returns the offset of the last token read by this scanner.
+     *
+     * @return the offset of the last token read by this scanner
+     */
+    int getTokenOffset();
+
+    /**
+     * Returns the length of the last token read by this scanner.
+     *
+     * @return the length of the last token read by this scanner
+     */
+    int getTokenLength();
+}