Set DEBUG=false; Set DEBUG=true only for developer tests
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / php / PHPPartitionScanner.java
index 85aa0d2..072f30b 100644 (file)
-/**********************************************************************
-Copyright (c) 2000, 2002 IBM Corp. and others.
-All rights reserved. This program and the accompanying materials
-are made available under the terms of the Common Public License v1.0
-which accompanies this distribution, and is available at
-http://www.eclipse.org/legal/cpl-v10.html
-
-Contributors:
-    IBM Corporation - Initial implementation
-    Klaus Hartlage - www.eclipseproject.de
-**********************************************************************/
+/**
+ * This program and the accompanying materials
+ * are made available under the terms of the Common Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
+ * Created on 05.03.2003
+ *
+ * @author Stefan Langer (musk)
+ * @version $Revision: 1.18 $
+ */
 package net.sourceforge.phpeclipse.phpeditor.php;
 
-import java.io.CharArrayWriter;
-import java.util.ArrayList;
-import java.util.List;
+import java.util.*;
 
-import org.eclipse.jface.text.rules.ICharacterScanner;
-import org.eclipse.jface.text.rules.IPredicateRule;
-import org.eclipse.jface.text.rules.IToken;
-import org.eclipse.jface.text.rules.IWordDetector;
-import org.eclipse.jface.text.rules.MultiLineRule;
-import org.eclipse.jface.text.rules.RuleBasedPartitionScanner;
-import org.eclipse.jface.text.rules.Token;
-import org.eclipse.jface.text.rules.WordRule;
+import org.eclipse.jface.text.*;
+import org.eclipse.jface.text.rules.*;
 
 /**
- * This scanner recognizes the JavaDoc comments and Java multi line comments.
+ * 
  */
-public class PHPPartitionScanner extends RuleBasedPartitionScanner {
-
-  private final static String SKIP = "__skip"; //$NON-NLS-1$
-  public final static String HTML_MULTILINE_COMMENT = "__html_multiline_comment"; //$NON-NLS-1$
-  //   public final static String JAVA_DOC= "__java_javadoc"; //$NON-NLS-1$
-  public final static String PHP = "__php";
-  //  public final static String HTML = "__html";
-
-  public final static IToken php = new Token(PHP);
-  //  public final static IToken html = new Token(HTML);
-  public final static IToken comment = new Token(HTML_MULTILINE_COMMENT);
-
-  protected final static char[] php0EndSequence = { '<', '?' };
-  protected final static char[] php1EndSequence = { '<', '?', 'p', 'h', 'p' };
-  protected final static char[] php2EndSequence = { '<', '?', 'P', 'H', 'P' };
-
-  private StringBuffer test;
-
-  public class PHPMultiLineRule extends MultiLineRule {
-
-    public PHPMultiLineRule(String startSequence, String endSequence, IToken token) {
-      super(startSequence, endSequence, token);
+public class PHPPartitionScanner implements IPartitionTokenScanner
+{
+    private static final boolean DEBUG = false;
+    private boolean fInString = false;
+    private boolean fInDoubString = false;
+    private IDocument fDocument = null;
+    private int fOffset = -1;
+    private String fContentType = IPHPPartitionScannerConstants.HTML;
+    private String fPrevContentType = IPHPPartitionScannerConstants.HTML;
+    private boolean partitionBorder = false;
+    private int fTokenOffset;
+    private int fEnd = -1;
+    private int fLength;
+    private int fCurrentLength;
+    private Map tokens = new HashMap();
+
+    public PHPPartitionScanner()
+    {
+        this.tokens.put(
+            IPHPPartitionScannerConstants.PHP,
+            new Token(IPHPPartitionScannerConstants.PHP));
+        this.tokens.put(
+            IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT,
+            new Token(IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT));
+        this.tokens.put(
+            IPHPPartitionScannerConstants.HTML,
+            new Token(IPHPPartitionScannerConstants.HTML));
+        this.tokens.put(
+            IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT,
+            new Token(IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT));
+        this.tokens.put(
+            IDocument.DEFAULT_CONTENT_TYPE,
+            new Token(IDocument.DEFAULT_CONTENT_TYPE));
     }
 
-    public PHPMultiLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter) {
-      super(startSequence, endSequence, token, escapeCharacter);
-    }
-
-    protected boolean endSequenceDetected(ICharacterScanner scanner) {
-      int c;
-      int c2;
-
-      boolean lineCommentMode = false;
-      boolean multiLineCommentMode = false;
-      boolean stringMode = false;
-
-      char[][] delimiters = scanner.getLegalLineDelimiters();
-      while ((c = scanner.read()) != ICharacterScanner.EOF) {
-        if (c == '#') {
-          // read until end of line
-          while ((c = scanner.read()) != ICharacterScanner.EOF) {
-            if (fEndSequence.length > 0 && c == fEndSequence[0]) {
-              // Check if the specified end sequence has been found.
-              if (sequenceDetected(scanner, fEndSequence, true))
-                return true;
-            } else if (c == '\n') {
-              break;
-            }
-          }
-          continue;
-        } else if (c == '/' && (c = scanner.read()) != ICharacterScanner.EOF) {
-          if (c == '/') {
-            // read until end of line
-            while ((c = scanner.read()) != ICharacterScanner.EOF) {
-              if (fEndSequence.length > 0 && c == fEndSequence[0]) {
-                // Check if the specified end sequence has been found.
-                if (sequenceDetected(scanner, fEndSequence, true))
-                  return true;
-              } else if (c == '\n') {
-                break;
-              }
-            }
-            continue;
-          } else if (c == '*') {
-            // multi-line comment
-            while ((c = scanner.read()) != ICharacterScanner.EOF) {
-              if (c == '*' && (c = scanner.read()) != ICharacterScanner.EOF) {
-                if (c == '/') {
-                  break;
+    private IToken getToken(String type)
+    {
+        fLength = fCurrentLength;
+        if (DEBUG)
+        {
+
+            try
+            {
+                if (fLength <= 0)
+                {
+                    int line = fDocument.getLineOfOffset(fOffset);
+                    System.err.println(
+                        "Error at "
+                            + line
+                            + " offset:"
+                            + String.valueOf(
+                                fOffset - fDocument.getLineOffset(line)));
                 }
-                scanner.unread();
-              }
             }
-
-            continue;
-          } else {
-            scanner.unread();
-          }
-        } else if (c == '"') {
-          // string mode
-          while ((c = scanner.read()) != ICharacterScanner.EOF) {
-            if (c == '\\') {
-              c = scanner.read();
-            } else if (c == '"') {
-              break;
-            }
-          }
-          continue;
-        } else if (c == '\'') {
-          // string mode
-          while ((c = scanner.read()) != ICharacterScanner.EOF) {
-            if (c == '\\') {
-              c = scanner.read();
-            } else if (c == '\'') {
-              break;
+            catch (BadLocationException e)
+            {  // should never happen
+                // TODO Write stacktrace to log
+                e.printStackTrace();
             }
-          }
-          continue;
         }
-
-        if (c == fEscapeCharacter) {
-          // Skip the escaped character.
-          scanner.read();
-        } else if (fEndSequence.length > 0 && c == fEndSequence[0]) {
-          // Check if the specified end sequence has been found.
-          if (sequenceDetected(scanner, fEndSequence, true))
-            return true;
-        } else if (fBreaksOnEOL) {
-          // Check for end of line since it can be used to terminate the pattern.
-          for (int i = 0; i < delimiters.length; i++) {
-            if (c == delimiters[i][0] && sequenceDetected(scanner, delimiters[i], false))
-              return true;
-          }
+        Assert.isTrue(fLength > 0, "Partition length <= 0!");
+        fCurrentLength = 0;
+        // String can never cross partition borders so reset string detection
+        fInString = false;
+        fInDoubString = false;
+        IToken token = (IToken) this.tokens.get(type);
+        Assert.isNotNull(token, "Token for type \"" + type + "\" not found!");
+        if (DEBUG)
+        {
+            System.out.println(
+                "Partition: fTokenOffset="
+                    + fTokenOffset
+                    + " fContentType="
+                    + type
+                    + " fLength="
+                    + fLength);
         }
-      } 
-      boolean phpMode = false;
-      if (c == ICharacterScanner.EOF) {
-        phpMode = true;
-      }
-      scanner.unread();
-      return phpMode;
+        return token;
     }
-  }
-
-  //  public class HTMLMultiLineRule extends MultiLineRule {
-  //
-  //    public HTMLMultiLineRule(String startSequence, String endSequence, IToken token) {
-  //      super(startSequence, endSequence, token);
-  //    }
-  //
-  //    public HTMLMultiLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter) {
-  //      super(startSequence, endSequence, token, escapeCharacter);
-  //    }
-  //
-  //    protected boolean endSequenceDetected(ICharacterScanner scanner) {
-  //      int c;
-  //
-  //      char[][] delimiters = scanner.getLegalLineDelimiters();
-  //      while ((c = scanner.read()) != ICharacterScanner.EOF) {
-  //        if (c == '<') {
-  //          //       scanner.unread();
-  //          if (sequenceDetected(scanner, php2EndSequence, true)) {
-  //            // <?PHP
-  //            scanner.unread();
-  //            scanner.unread();
-  //            scanner.unread();
-  //            scanner.unread();
-  //            scanner.unread();
-  //            return true;
-  //          }
-  //          if (sequenceDetected(scanner, php1EndSequence, true)) {
-  //            // <?php
-  //            scanner.unread();
-  //            scanner.unread();
-  //            scanner.unread();
-  //            scanner.unread();
-  //            scanner.unread();
-  //            return true;
-  //          }
-  //          if (sequenceDetected(scanner, php0EndSequence, true)) {
-  //            // <?
-  //            scanner.unread();
-  //            scanner.unread();
-  //            return true;
-  //          }
-  //          //      scanner.read();
-  //        }
-  //
-  //      }
-  //      scanner.unread();
-  //      return false;
-  //    }
-  //
-  //    protected IToken doEvaluate(ICharacterScanner scanner, boolean resume) {
-  //
-  //      if (resume) {
-  //
-  //        if (endSequenceDetected(scanner))
-  //          return fToken;
-  //
-  //      } else {
-  //
-  //        int c = scanner.read();
-  //        //     if (c == fStartSequence[0]) {
-  //        //       if (sequenceDetected(scanner, fStartSequence, false)) {
-  //        if (endSequenceDetected(scanner))
-  //          return fToken;
-  //        //       }
-  //        //     }
-  //      }
-  //
-  //      scanner.unread();
-  //      return Token.UNDEFINED;
-  //    }
-  //
-  //    public IToken evaluate(ICharacterScanner scanner, boolean resume) {
-  //      if (fColumn == UNDEFINED)
-  //        return doEvaluate(scanner, resume);
-  //
-  //      int c = scanner.read();
-  //      scanner.unread();
-  //      //    if (c == fStartSequence[0])
-  //      return (fColumn == scanner.getColumn() ? doEvaluate(scanner, resume) : Token.UNDEFINED);
-  //      //    else
-  //      //      return Token.UNDEFINED;
-  //    }
-  //  }
-
-  public class HTMLPatternRule implements IPredicateRule {
 
-    protected static final int UNDEFINED = -1;
+    /* (non-Javadoc)
+     * @see org.eclipse.jface.text.rules.IPartitionTokenScanner#setPartialRange(org.eclipse.jface.text.IDocument, int, int, java.lang.String, int)
+     */
+    public void setPartialRange(
+        IDocument document,
+        int offset,
+        int length,
+        String contentType,
+        int partitionOffset)
+    {
+        if (DEBUG)
+        {
+            System.out.println(
+                "PartialRange: contentType="
+                    + contentType
+                    + " partitionOffset="
+                    + partitionOffset);
+        }
 
-    /** The token to be returned on success */
-    protected IToken fToken;
+        try
+        {
+            if (partitionOffset > -1)
+            {
+                partitionBorder = false;
+                // because of strings we have to parse the whole partition
+                this.setRange(
+                    document,
+                    partitionOffset,
+                    offset - partitionOffset + length);
+                // sometimes we get a wrong partition so we retrieve the partition
+                // directly from the document
+                fContentType = fDocument.getContentType(partitionOffset);
+            }
+            else
+                this.setRange(document, offset, length);
 
-    /** The pattern's column constrain */
-    protected int fColumn = UNDEFINED;
-    /** The pattern's escape character */
-    protected char fEscapeCharacter;
-    /** Indicates whether end of line termines the pattern */
-    protected boolean fBreaksOnEOL;
+        }
+        catch (BadLocationException e)
+        {
+            // should never happen
+            // TODO print stack trace to log
+            // fall back just scan the whole document again
+            this.setRange(document, 0, fDocument.getLength());
+        }
 
-    /**
-     * Creates a rule for the given starting and ending sequence.
-     * When these sequences are detected the rule will return the specified token.
-     * Alternatively, the sequence can also be ended by the end of the line.
-     * Any character which follows the given escapeCharacter will be ignored.
-     *
-     * @param startSequence the pattern's start sequence
-     * @param endSequence the pattern's end sequence, <code>null</code> is a legal value
-     * @param token the token which will be returned on success
-     * @param escapeCharacter any character following this one will be ignored
-     * @param indicates whether the end of the line also termines the pattern
-     */
-    public HTMLPatternRule(IToken token) {
-      fToken = token;
-      fEscapeCharacter = (char) 0;
-      fBreaksOnEOL = false;
     }
 
-    /**
-     * 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
+    /* (non-Javadoc)
+     * @see org.eclipse.jface.text.rules.ITokenScanner#getTokenLength()
      */
-    public void setColumnConstraint(int column) {
-      if (column < 0)
-        column = UNDEFINED;
-      fColumn = column;
+    public int getTokenLength()
+    {
+        return fLength;
     }
 
-    /**
-     * Evaluates this rules without considering any column constraints.
-     *
-     * @param scanner the character scanner to be used
-     * @return the token resulting from this evaluation
+    /* (non-Javadoc)
+     * @see org.eclipse.jface.text.rules.ITokenScanner#getTokenOffset()
      */
-    protected IToken doEvaluate(ICharacterScanner scanner) {
-      return doEvaluate(scanner, false);
+    public int getTokenOffset()
+    {
+        return fTokenOffset;
     }
 
-    /**
-     * Evaluates this rules without considering any column constraints. Resumes
-     * detection, i.e. look sonly for the end sequence required by this rule if the
-     * <code>resume</code> flag is set.
-     *
-     * @param scanner the character scanner to be used
-     * @param resume <code>true</code> if detection should be resumed, <code>false</code> otherwise
-     * @return the token resulting from this evaluation
-     * @since 2.0
+    /* (non-Javadoc)
+     * @see org.eclipse.jface.text.rules.ITokenScanner#nextToken()
      */
-    protected IToken doEvaluate(ICharacterScanner scanner, boolean resume) {
-
-      if (resume) {
-
-        if (endSequenceDetected(scanner))
-          return fToken;
-
-      } else {
-
-        int c = scanner.read();
-        //      if (c == fStartSequence[0]) {
-        //        if (sequenceDetected(scanner, fStartSequence, false)) {
-        if (endSequenceDetected(scanner))
-          return fToken;
-        //        }
-        //      }
-      }
+    public IToken nextToken()
+    {
+        int c;
+
+        // check if we are not allready at the end of the
+        // file
+        if ((c = read()) == ICharacterScanner.EOF)
+        {
+            partitionBorder = false;
+            return Token.EOF;
+        }
+        else
+            unread();
 
-      scanner.unread();
-      return Token.UNDEFINED;
-    }
+        if (partitionBorder)
+        {
+            fTokenOffset = fOffset;
+            partitionBorder = false;
+        }
 
-    /*
-     * @see IRule#evaluate
-     */
-    public IToken evaluate(ICharacterScanner scanner) {
-      return evaluate(scanner, false);
+        while ((c = read()) != ICharacterScanner.EOF)
+        {
+            switch (c)
+            {
+                case '<' :
+                    if (!isInString(IPHPPartitionScannerConstants.PHP)
+                        && fContentType
+                            != IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT
+                        && checkPattern(new char[] { '?', 'p', 'h', 'p' }, true))
+                    {
+                        if (fContentType != IPHPPartitionScannerConstants.PHP
+                            && fCurrentLength > 5)
+                        {
+                            unread(5);
+                            IToken token = getToken(fContentType);
+                            // save previouse contenttype
+                            //TODO build stack for previouse contenttype 
+                            fPrevContentType = fContentType;
+
+                            fContentType = IPHPPartitionScannerConstants.PHP;
+
+                            return token;
+                        }
+                        else
+                            fContentType = IPHPPartitionScannerConstants.PHP;
+
+                        // remember offset of this partition
+                        fTokenOffset = fOffset - 5;
+                        fCurrentLength = 5;
+                    }
+                    else if (
+                        !isInString(IPHPPartitionScannerConstants.PHP)
+                            && fContentType
+                                != IPHPPartitionScannerConstants
+                                    .PHP_MULTILINE_COMMENT
+                            && checkPattern(new char[] { '?' }, false))
+                    {
+                        if (fContentType != IPHPPartitionScannerConstants.PHP
+                            && fCurrentLength > 2)
+                        {
+                            unread(2);
+                            IToken token = getToken(fContentType);
+                            // save previouse contenttype
+                            fPrevContentType = fContentType;
+                            fContentType = IPHPPartitionScannerConstants.PHP;
+                            return token;
+                        }
+                        else
+                            fContentType = IPHPPartitionScannerConstants.PHP;
+                        // remember offset of this partition
+                        fTokenOffset = fOffset - 2;
+                        fCurrentLength = 2;
+                    }
+                    else if (
+                        !isInString(IPHPPartitionScannerConstants.PHP)
+                            && checkPattern(new char[] { '!', '-', '-' }))
+                    { // return previouse partition
+                        if (fContentType
+                            != IPHPPartitionScannerConstants
+                                .HTML_MULTILINE_COMMENT
+                            && fCurrentLength > 4)
+                        {
+                            unread(4);
+                            IToken token = getToken(fContentType);
+                            fContentType =
+                                IPHPPartitionScannerConstants
+                                    .HTML_MULTILINE_COMMENT;
+                            return token;
+                        }
+                        else
+                            fContentType =
+                                IPHPPartitionScannerConstants
+                                    .HTML_MULTILINE_COMMENT;
+                                    
+                        fTokenOffset = fOffset - 4;
+                        fCurrentLength = 4;
+                    }
+                    break;
+                case '?' :
+                    if (!isInString(IPHPPartitionScannerConstants.PHP)
+                        && fContentType == IPHPPartitionScannerConstants.PHP)
+                    {
+                        if ((c = read()) == '>')
+                        { 
+                            if (fPrevContentType != null)
+                                fContentType = fPrevContentType;
+                            else
+                                fContentType =
+                                    IPHPPartitionScannerConstants.HTML;
+                            partitionBorder = true;
+                            return getToken(IPHPPartitionScannerConstants.PHP);
+                        }
+                        else if (c != ICharacterScanner.EOF)
+                            unread();
+                    }
+                    break;
+                case '-' :
+                    if (!isInString(IPHPPartitionScannerConstants.PHP)
+                        && fContentType
+                            == IPHPPartitionScannerConstants
+                                .HTML_MULTILINE_COMMENT
+                        && checkPattern(new char[] { '-', '>' }))
+                    {
+                        fContentType = IPHPPartitionScannerConstants.HTML;
+                        partitionBorder = true;
+                        return getToken(
+                            IPHPPartitionScannerConstants
+                                .HTML_MULTILINE_COMMENT);
+                    }
+                    break;
+                case '/' :
+                    if (!isInString(IPHPPartitionScannerConstants.PHP) && (c = read()) == '*')
+                    { // MULTINE COMMENT JAVASCRIPT, CSS, PHP
+                        if (fContentType == IPHPPartitionScannerConstants.PHP
+                            && fCurrentLength > 2)
+                        {
+                            unread(2);
+                            IToken token = getToken(fContentType);
+                            fContentType =
+                                IPHPPartitionScannerConstants
+                                    .PHP_MULTILINE_COMMENT;
+                            return token;
+                        }
+                        else if (
+                            fContentType
+                                == IPHPPartitionScannerConstants
+                                    .PHP_MULTILINE_COMMENT)
+                        {
+
+                            fTokenOffset = fOffset - 2;
+                            fCurrentLength = 2;
+                        }
+
+                    }
+                    else if (!isInString(IPHPPartitionScannerConstants.PHP) && c != ICharacterScanner.EOF)
+                        unread();
+                    break;
+                case '*' :
+                    if (!isInString(IPHPPartitionScannerConstants.PHP) && (c = read()) == '/')
+                    {
+                        if (fContentType
+                            == IPHPPartitionScannerConstants
+                                .PHP_MULTILINE_COMMENT)
+                        {
+                            fContentType = IPHPPartitionScannerConstants.PHP;
+                            partitionBorder = true;
+                            return getToken(
+                                IPHPPartitionScannerConstants
+                                    .PHP_MULTILINE_COMMENT);
+                        }
+                        else if (
+                            fContentType
+                                == IPHPPartitionScannerConstants
+                                    .CSS_MULTILINE_COMMENT)
+                        {
+                        }
+                        else if (
+                            fContentType
+                                == IPHPPartitionScannerConstants
+                                    .JS_MULTILINE_COMMENT)
+                        {
+                        }
+                    }
+                    else if (!isInString(IPHPPartitionScannerConstants.PHP) && c != ICharacterScanner.EOF)
+                        unread();
+                    break;
+                case '\'' :
+                    if (!fInDoubString)
+                        fInString = !fInString;
+                    break;
+                case '"' :
+                    // toggle String mode
+                    if (!fInString)
+                        fInDoubString = !fInDoubString;
+                    break;
+            }
+        } // end of file reached but we have to return the
+        // last partition.
+        return getToken(fContentType);
     }
-
-    /**
-     * Returns whether the end sequence was detected. As the pattern can be considered 
-     * ended by a line delimiter, the result of this method is <code>true</code> if the 
-     * rule breaks on the end  of the line, or if the EOF character is read.
-     *
-     * @param scanner the character scanner to be used
-     * @return <code>true</code> if the end sequence has been detected
+    /* (non-Javadoc)
+     * @see org.eclipse.jface.text.rules.ITokenScanner#setRange(org.eclipse.jface.text.IDocument, int, int)
      */
-    protected boolean endSequenceDetected(ICharacterScanner scanner) {
-      int c;
-
-      char[][] delimiters = scanner.getLegalLineDelimiters();
-      while ((c = scanner.read()) != ICharacterScanner.EOF) {
-        if (c == '<') {
-          //       scanner.unread();
-          if (sequenceDetected(scanner, php2EndSequence, true)) {
-            // <?PHP
-            scanner.unread();
-            scanner.unread();
-            scanner.unread();
-            scanner.unread();
-            scanner.unread();
-            return true;
-          }
-          if (sequenceDetected(scanner, php1EndSequence, true)) {
-            // <?php
-            scanner.unread();
-            scanner.unread();
-            scanner.unread();
-            scanner.unread();
-            scanner.unread();
-            return true;
-          }
-          if (sequenceDetected(scanner, php0EndSequence, true)) {
-            // <?
-            scanner.unread();
-            scanner.unread();
-            return true;
-          }
-          //      scanner.read();
+    public void setRange(IDocument document, int offset, int length)
+    {
+        if (DEBUG)
+        {
+            System.out.println(
+                "SET RANGE: offset=" + offset + " length=" + length);
         }
 
-      }
-      scanner.unread();
-      return false;
+        fDocument = document;
+        fOffset = offset;
+        fTokenOffset = offset;
+        fCurrentLength = 0;
+        fLength = 0;
+        fEnd = fOffset + length;
+        fInString = false;
+        fInDoubString = false;
+        fContentType = IPHPPartitionScannerConstants.HTML;
+//        String[] prev = getPartitionStack(offset);
     }
 
-    /**
-     * Returns whether the next characters to be read by the character scanner
-     * are an exact match with the given sequence. No escape characters are allowed 
-     * within the sequence. If specified the sequence is considered to be found
-     * when reading the EOF character.
-     *
-     * @param scanner the character scanner to be used
-     * @param sequence the sequence to be detected
-     * @param eofAllowed indicated whether EOF terminates the pattern
-     * @return <code>true</code> if the given sequence has been detected
-     */
-    protected boolean sequenceDetected(ICharacterScanner scanner, char[] sequence, boolean eofAllowed) {
-      for (int i = 1; i < sequence.length; i++) {
-        int c = scanner.read();
-        if (c == ICharacterScanner.EOF && eofAllowed) {
-          return true;
-        } else if (c != sequence[i]) {
-          // Non-matching character detected, rewind the scanner back to the start.
-          scanner.unread();
-          for (int j = i - 1; j > 0; j--)
-            scanner.unread();
-          return false;
+    private int read()
+    {
+        try
+        {
+            if (fOffset < fEnd)
+            {
+               fCurrentLength++;
+                return fDocument.getChar(fOffset++);
+            }
+            return ICharacterScanner.EOF;
+        }
+        catch (BadLocationException e)
+        {
+            // should never happen
+            // TODO write stacktrace to log
+            fOffset = fEnd;
+            return ICharacterScanner.EOF;
         }
-      }
-
-      return true;
     }
 
-    /*
-     * @see IPredicateRule#evaluate(ICharacterScanner, boolean)
-     * @since 2.0
-     */
-    public IToken evaluate(ICharacterScanner scanner, boolean resume) {
-      if (fColumn == UNDEFINED)
-        return doEvaluate(scanner, resume);
-
-      int c = scanner.read();
-      scanner.unread();
-      //    if (c == fStartSequence[0])
-      return (fColumn == scanner.getColumn() ? doEvaluate(scanner, resume) : Token.UNDEFINED);
-      //    else
-      //      return Token.UNDEFINED;
+    private void unread()
+    {
+        --fOffset;
+        --fCurrentLength;
     }
-
-    /*
-     * @see IPredicateRule#getSuccessToken()
-     * @since 2.0
-     */
-    public IToken getSuccessToken() {
-      return fToken;
+    
+    private void unread(int num)
+    {
+       fOffset -= num;
+       fCurrentLength -= num;
     }
-  }
-  /**
-   * Detector for empty comments.
-   */
-  static class EmptyCommentDetector implements IWordDetector {
 
-    /* (non-Javadoc)
-    * Method declared on IWordDetector
-       */
-    public boolean isWordStart(char c) {
-      return (c == '/');
+    private boolean checkPattern(char[] pattern)
+    {
+        return checkPattern(pattern, false);
     }
 
-    /* (non-Javadoc)
-    * Method declared on IWordDetector
-       */
-    public boolean isWordPart(char c) {
-      return (c == '*' || c == '/');
-    }
-  };
+    /**
+     * Check if next character sequence read from document is equals to 
+     * the provided pattern. Pattern is read from left to right until the 
+     * first character read doesn't match. If this happens all read characters are
+     * unread.
+     * @param pattern The pattern to check.
+     * @return <code>true</code> if pattern is equals else returns <code>false</code>.
+     */
+    private boolean checkPattern(char[] pattern, boolean ignoreCase)
+    {
+        int prevOffset = fOffset;
+        int prevLength = fCurrentLength;
+        for (int i = 0; i < pattern.length; i++)
+        {
+            int c = read();
+
+            if (c == ICharacterScanner.EOF
+                || !letterEquals(c, pattern[i], ignoreCase))
+            {
+                fOffset = prevOffset;
+                fCurrentLength = prevLength;
+                return false;
+            }
+        }
 
-  /**
-   * 
-   */
-  static class WordPredicateRule extends WordRule implements IPredicateRule {
+        return true;
+    }
 
-    private IToken fSuccessToken;
+    private boolean letterEquals(int test, char letter, boolean ignoreCase)
+    {
+        if (test == letter)
+            return true;
+        else if (
+            ignoreCase
+                && Character.isLowerCase(letter)
+                && test == Character.toUpperCase(letter))
+            return true;
+        else if (
+            ignoreCase
+                && Character.isUpperCase(letter)
+                && test == Character.toLowerCase(letter))
+            return true;
 
-    public WordPredicateRule(IToken successToken) {
-      super(new EmptyCommentDetector());
-      fSuccessToken = successToken;
-      addWord("/**/", fSuccessToken);
+        return false;
     }
-
-    /*
-     * @see org.eclipse.jface.text.rules.IPredicateRule#evaluate(ICharacterScanner, boolean)
+    
+    /**
+     * Checks wether the offset is in a <code>String</code> and the specified 
+     * contenttype is the current content type.
+     * Strings are delimited, mutual exclusive, by a " or by a '.
+     * 
+     * @param contentType The contenttype to check.
+     * @return <code>true</code> if the current offset is in a string else 
+     *                         returns false.
      */
-    public IToken evaluate(ICharacterScanner scanner, boolean resume) {
-      return super.evaluate(scanner);
+    private  boolean isInString(String contentType)
+    {
+       if(fContentType == contentType)
+               return (fInString || fInDoubString);
+       else
+               return false;           
     }
-
-    /*
-     * @see org.eclipse.jface.text.rules.IPredicateRule#getSuccessToken()
+    
+    /**
+     * Returns the previouse partition stack for the given offset.
+     * 
+     * @param offset The offset to return the previouse partitionstack for.
+     * 
+     * @return The stack as a string array.
      */
-    public IToken getSuccessToken() {
-      return fSuccessToken;
+    private String[] getPartitionStack(int offset)
+    {
+       ArrayList types = new ArrayList();
+       int tmpOffset = 0;
+       try
+        {
+            ITypedRegion region = fDocument.getPartition(offset);
+            tmpOffset = region.getOffset();
+            while(tmpOffset-1 > 0)
+            {
+               region = fDocument.getPartition(tmpOffset-1);
+               tmpOffset = region.getOffset();
+               types.add(0, region.getType());
+            }
+        }
+        catch (BadLocationException e)
+        {
+           if(DEBUG)
+           {
+                       e.printStackTrace();
+           }
+        }
+       
+               String[] retVal = new String[types.size()];
+       
+       retVal = (String[])types.toArray(retVal);
+       return retVal;
     }
-  };
-
-  /**
-   * Creates the partitioner and sets up the appropriate rules.
-   */
-  public PHPPartitionScanner() {
-    super();
-
-    //    IToken php = new Token(PHP);
-    //    IToken html = new Token(HTML);
-    //    IToken comment = new Token(HTML_MULTILINE_COMMENT);
-
-    List rules = new ArrayList();
-
-    // Add rule for single line comments.
-    // rules.add(new EndOfLineRule("//", Token.UNDEFINED));
-
-    // Add rule for strings and character constants.
-    //         rules.add(new SingleLineRule("\"", "\"", Token.UNDEFINED, '\\'));
-    // rules.add(new SingleLineRule("'", "'", Token.UNDEFINED, '\\')); 
-
-    // Add special case word rule.
-    //    rules.add(new WordPredicateRule(comment));
-
-    // Add rules for multi-line comments and javadoc.
-    //rules.add(new MultiLineRule("/**", "*/", javaDoc));
-    //  rules.add(new HTMLMultiLineRule("<", "<?", html));
-
-    rules.add(new MultiLineRule("<!--", "-->", comment));
-    rules.add(new PHPMultiLineRule("<?\r", "?>", php));
-    rules.add(new PHPMultiLineRule("<?\n", "?>", php));
-    rules.add(new PHPMultiLineRule("<?\t", "?>", php));
-    rules.add(new PHPMultiLineRule("<? ", "?>", php));
-    rules.add(new PHPMultiLineRule("<?php", "?>", php));
-    rules.add(new PHPMultiLineRule("<?PHP", "?>", php));
-
-    //    rules.add(new HTMLPatternRule(html)); // "<", "<?",
-    //Add rule for processing instructions
-
-    IPredicateRule[] result = new IPredicateRule[rules.size()];
-    rules.toArray(result);
-    setPredicateRules(result);
-    //    setDefaultReturnToken(html);
-  }
-
-  //    public IToken nextToken() {
-  //      
-  //      if (fContentType == null || fRules == null)
-  //        return getNextToken();
-  //      
-  //      fTokenOffset= fOffset;
-  //      fColumn= UNDEFINED;
-  //      boolean resume= (fPartitionOffset < fOffset);
-  //          
-  //      IPredicateRule rule;
-  //      IToken token;
-  //      
-  //      for (int i= 0; i < fRules.length; i++) {
-  //        rule= (IPredicateRule) fRules[i];
-  //        token= rule.getSuccessToken();
-  //        if (fContentType.equals(token.getData())) {
-  //          if (resume)
-  //            fTokenOffset= fPartitionOffset;
-  //          token= rule.evaluate(this, resume);
-  //          if (!token.isUndefined()) {
-  //            fContentType= null;
-  //            return token;
-  //          }
-  //        }
-  //      }
-  //      
-  //      fContentType= null;
-  //      return getNextToken();
-  //    }
-  //    
-  //    public IToken getNextToken() {
-  //      
-  //      IToken token;
-  //      
-  //      while (true) {
-  //        
-  //        fTokenOffset= fOffset;
-  //        fColumn= UNDEFINED;
-  //        
-  //        if (fRules != null) {
-  //          for (int i= 0; i < fRules.length; i++) {
-  //            token= (fRules[i].evaluate(this));
-  //            if (!token.isUndefined())
-  //              return token;
-  //          }
-  //        }
-  //        
-  //        if (read() == EOF)
-  //          return Token.EOF;
-  //        else
-  //          return fDefaultReturnToken;
-  //      }
-  //    }
+    
 }