--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dwtx/jface/text/rules/WordRule.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,185 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2006 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.WordRule;
+
+import dwt.dwthelper.utils;
+
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+
+import dwtx.core.runtime.Assert;
+
+
+
+/**
+ * An implementation of <code>IRule</code> capable of detecting words
+ * Word rules also allow for the association of tokens with specific words.
+ * That is, not only can the rule be used to provide tokens for exact matches,
+ * but also for the generalized notion of a word in the context in which it is used.
+ * A word rules uses a word detector to determine what a word is.
+ *
+ * @see IWordDetector
+ */
+public class WordRule : IRule {
+
+    /** Internal setting for the un-initialized column constraint. */
+    protected static final int UNDEFINED= -1;
+
+    /** The word detector used by this rule. */
+    protected IWordDetector fDetector;
+    /** The default token to be returned on success and if nothing else has been specified. */
+    protected IToken fDefaultToken;
+    /** The column constraint. */
+    protected int fColumn= UNDEFINED;
+    /** The table of predefined words and token for this rule. */
+    protected Map fWords= new HashMap();
+    /** Buffer used for pattern detection. */
+    private StringBuffer fBuffer= new StringBuffer();
+    /**
+     * Tells whether this rule is case sensitive.
+     * @since 3.3
+     */
+    private bool fIgnoreCase= false;
+
+    /**
+     * Creates a rule which, with the help of an word detector, will return the token
+     * associated with the detected word. If no token has been associated, the scanner
+     * will be rolled back and an undefined token will be returned in order to allow
+     * any subsequent rules to analyze the characters.
+     *
+     * @param detector the word detector to be used by this rule, may not be <code>null</code>
+     * @see #addWord(String, IToken)
+     */
+    public WordRule(IWordDetector detector) {
+        this(detector, Token.UNDEFINED, false);
+    }
+
+    /**
+     * Creates a rule which, with the help of a word detector, will return the token
+     * associated with the detected word. If no token has been associated, the
+     * specified default token will be returned.
+     *
+     * @param detector the word detector to be used by this rule, may not be <code>null</code>
+     * @param defaultToken the default token to be returned on success
+     *          if nothing else is specified, may not be <code>null</code>
+     * @see #addWord(String, IToken)
+     */
+    public WordRule(IWordDetector detector, IToken defaultToken) {
+        this(detector, defaultToken, false);
+    }
+
+    /**
+     * Creates a rule which, with the help of a word detector, will return the token
+     * associated with the detected word. If no token has been associated, the
+     * specified default token will be returned.
+     *
+     * @param detector the word detector to be used by this rule, may not be <code>null</code>
+     * @param defaultToken the default token to be returned on success
+     *          if nothing else is specified, may not be <code>null</code>
+     * @param ignoreCase the case sensitivity associated with this rule
+     * @see #addWord(String, IToken)
+     * @since 3.3
+     */
+    public WordRule(IWordDetector detector, IToken defaultToken, bool ignoreCase) {
+        Assert.isNotNull(detector);
+        Assert.isNotNull(defaultToken);
+
+        fDetector= detector;
+        fDefaultToken= defaultToken;
+        fIgnoreCase= ignoreCase;
+    }
+
+    /**
+     * Adds a word and the token to be returned if it is detected.
+     *
+     * @param word the word this rule will search for, may not be <code>null</code>
+     * @param token the token to be returned if the word has been found, may not be <code>null</code>
+     */
+    public void addWord(String word, IToken token) {
+        Assert.isNotNull(word);
+        Assert.isNotNull(token);
+
+        fWords.put(word, token);
+    }
+
+    /**
+     * Sets a column constraint for this rule. If set, the rule's token
+     * will only be returned if the pattern is detected starting at the
+     * specified column. If the column is smaller then 0, the column
+     * constraint is considered removed.
+     *
+     * @param column the column in which the pattern starts
+     */
+    public void setColumnConstraint(int column) {
+        if (column < 0)
+            column= UNDEFINED;
+        fColumn= column;
+    }
+
+    /*
+     * @see IRule#evaluate(ICharacterScanner)
+     */
+    public IToken evaluate(ICharacterScanner scanner) {
+        int c= scanner.read();
+        if (c !is ICharacterScanner.EOF && fDetector.isWordStart((char) c)) {
+            if (fColumn is UNDEFINED || (fColumn is scanner.getColumn() - 1)) {
+
+                fBuffer.setLength(0);
+                do {
+                    fBuffer.append((char) c);
+                    c= scanner.read();
+                } while (c !is ICharacterScanner.EOF && fDetector.isWordPart((char) c));
+                scanner.unread();
+
+                String buffer= fBuffer.toString();
+                IToken token= (IToken)fWords.get(buffer);
+                
+                if(fIgnoreCase) {
+                    Iterator iter= fWords.keySet().iterator();
+                    while (iter.hasNext()) {
+                        String key= (String)iter.next();
+                        if(buffer.equalsIgnoreCase(key)) {
+                            token= (IToken)fWords.get(key);
+                            break;
+                        }
+                    }
+                } else
+                    token= (IToken)fWords.get(buffer);
+                
+                if (token !is null)
+                    return token;
+
+                if (fDefaultToken.isUndefined())
+                    unreadBuffer(scanner);
+
+                return fDefaultToken;
+            }
+        }
+
+        scanner.unread();
+        return Token.UNDEFINED;
+    }
+
+    /**
+     * Returns the characters in the buffer to the scanner.
+     *
+     * @param scanner the scanner to be used
+     */
+    protected void unreadBuffer(ICharacterScanner scanner) {
+        for (int i= fBuffer.length() - 1; i >= 0; i--)
+            scanner.unread();
+    }
+
+}