Fixed some bugs in the syntax editor preference page
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / php / PHPPartitionScanner.java
index 92badac..52f8def 100644 (file)
@@ -6,14 +6,23 @@
  * Created on 05.03.2003
  *
  * @author Stefan Langer (musk)
- * @version $Revision: 1.11 $
+ * @version $Revision: 1.19 $
  */
 package net.sourceforge.phpeclipse.phpeditor.php;
 
-import java.util.*;
 
-import org.eclipse.jface.text.*;
-import org.eclipse.jface.text.rules.*;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Map;
+
+import org.eclipse.jface.text.Assert;
+import org.eclipse.jface.text.BadLocationException;
+import org.eclipse.jface.text.IDocument;
+import org.eclipse.jface.text.ITypedRegion;
+import org.eclipse.jface.text.rules.ICharacterScanner;
+import org.eclipse.jface.text.rules.IPartitionTokenScanner;
+import org.eclipse.jface.text.rules.IToken;
+import org.eclipse.jface.text.rules.Token;
 
 /**
  * 
@@ -21,15 +30,17 @@ import org.eclipse.jface.text.rules.*;
 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;
-
+    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()
@@ -53,7 +64,34 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
 
     private IToken getToken(String type)
     {
-        fLength = fOffset - fTokenOffset;
+        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)));
+                }
+            }
+            catch (BadLocationException e)
+            {  // should never happen
+                // TODO Write stacktrace to log
+                e.printStackTrace();
+            }
+        }
+        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)
@@ -62,7 +100,7 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
                 "Partition: fTokenOffset="
                     + fTokenOffset
                     + " fContentType="
-                    + fContentType
+                    + type
                     + " fLength="
                     + fLength);
         }
@@ -79,7 +117,6 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
         String contentType,
         int partitionOffset)
     {
-        this.setRange(document, offset, length);
         if (DEBUG)
         {
             System.out.println(
@@ -89,14 +126,32 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
                     + partitionOffset);
         }
 
-        if (this.tokens.containsKey(contentType))
-            fContentType = contentType;
-        // TODO Calculate previouse contenttype
-        if (partitionOffset > -1)
+        try
         {
-            partitionBorder = false;
-            fTokenOffset = partitionOffset;
+            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);
+
+        }
+        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());
         }
+
     }
 
     /* (non-Javadoc)
@@ -143,18 +198,20 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
             switch (c)
             {
                 case '<' :
-                    if (fContentType
-                        != IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT
+                    if (!isInString(IPHPPartitionScannerConstants.PHP)
+                        && fContentType
+                            != IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT
                         && checkPattern(new char[] { '?', 'p', 'h', 'p' }, true))
                     {
-                                               if (fContentType != IPHPPartitionScannerConstants.PHP
-                            && fOffset - 5 > 0)
+                        if (fContentType != IPHPPartitionScannerConstants.PHP
+                            && fCurrentLength > 5)
                         {
-                            fOffset -= 5;
+                            unread(5);
                             IToken token = getToken(fContentType);
                             // save previouse contenttype
-                                                       fPrevContentType = fContentType;
-                     
+                            //TODO build stack for previouse contenttype 
+                            fPrevContentType = fContentType;
+
                             fContentType = IPHPPartitionScannerConstants.PHP;
 
                             return token;
@@ -164,18 +221,42 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
 
                         // remember offset of this partition
                         fTokenOffset = fOffset - 5;
+                        fCurrentLength = 5;
                     }
-                    else if (checkPattern(new char[] { '!', '-', '-' }))
+                    else if (
+                        !isInString(IPHPPartitionScannerConstants.PHP)
+                            && fContentType
+                                != IPHPPartitionScannerConstants
+                                    .PHP_MULTILINE_COMMENT
+                            && checkPattern(new char[] { '?' }, false))
                     {
-                        // return previouse partition
+                        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
-                            && fOffset - 4 > 0)
+                            && fCurrentLength > 4)
                         {
-                            fOffset -= 4;
+                            unread(4);
                             IToken token = getToken(fContentType);
-
                             fContentType =
                                 IPHPPartitionScannerConstants
                                     .HTML_MULTILINE_COMMENT;
@@ -185,19 +266,22 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
                             fContentType =
                                 IPHPPartitionScannerConstants
                                     .HTML_MULTILINE_COMMENT;
-
+                                    
                         fTokenOffset = fOffset - 4;
+                        fCurrentLength = 4;
                     }
                     break;
                 case '?' :
-                    if (fContentType == IPHPPartitionScannerConstants.PHP)
+                    if (!isInString(IPHPPartitionScannerConstants.PHP)
+                        && fContentType == IPHPPartitionScannerConstants.PHP)
                     {
                         if ((c = read()) == '>')
-                        {      // TODO Actually calculate the previouse contenttype from the document
-                               if(fPrevContentType != null)
-                                       fContentType = fPrevContentType;
-                               else
-                               fContentType = IPHPPartitionScannerConstants.HTML;
+                        { 
+                            if (fPrevContentType != null)
+                                fContentType = fPrevContentType;
+                            else
+                                fContentType =
+                                    IPHPPartitionScannerConstants.HTML;
                             partitionBorder = true;
                             return getToken(IPHPPartitionScannerConstants.PHP);
                         }
@@ -206,8 +290,10 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
                     }
                     break;
                 case '-' :
-                    if (fContentType
-                        == IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT
+                    if (!isInString(IPHPPartitionScannerConstants.PHP)
+                        && fContentType
+                            == IPHPPartitionScannerConstants
+                                .HTML_MULTILINE_COMMENT
                         && checkPattern(new char[] { '-', '>' }))
                     {
                         fContentType = IPHPPartitionScannerConstants.HTML;
@@ -218,18 +304,16 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
                     }
                     break;
                 case '/' :
-                    if ((c = read()) == '*')
+                    if (!isInString(IPHPPartitionScannerConstants.PHP) && (c = read()) == '*')
                     { // MULTINE COMMENT JAVASCRIPT, CSS, PHP
                         if (fContentType == IPHPPartitionScannerConstants.PHP
-                            && fOffset - 2 > 0)
+                            && fCurrentLength > 2)
                         {
-                            fOffset -= 2;
+                            unread(2);
                             IToken token = getToken(fContentType);
-
                             fContentType =
                                 IPHPPartitionScannerConstants
                                     .PHP_MULTILINE_COMMENT;
-
                             return token;
                         }
                         else if (
@@ -239,14 +323,15 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
                         {
 
                             fTokenOffset = fOffset - 2;
+                            fCurrentLength = 2;
                         }
 
                     }
-                    else if (c != ICharacterScanner.EOF)
+                    else if (!isInString(IPHPPartitionScannerConstants.PHP) && c != ICharacterScanner.EOF)
                         unread();
                     break;
                 case '*' :
-                    if ((c = read()) == '/')
+                    if (!isInString(IPHPPartitionScannerConstants.PHP) && (c = read()) == '/')
                     {
                         if (fContentType
                             == IPHPPartitionScannerConstants
@@ -254,7 +339,6 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
                         {
                             fContentType = IPHPPartitionScannerConstants.PHP;
                             partitionBorder = true;
-
                             return getToken(
                                 IPHPPartitionScannerConstants
                                     .PHP_MULTILINE_COMMENT);
@@ -272,13 +356,20 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
                         {
                         }
                     }
-                    else if (c != ICharacterScanner.EOF)
+                    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
+        } // end of file reached but we have to return the
         // last partition.
         return getToken(fContentType);
     }
@@ -296,9 +387,13 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
         fDocument = document;
         fOffset = offset;
         fTokenOffset = offset;
+        fCurrentLength = 0;
         fLength = 0;
         fEnd = fOffset + length;
-        //partitionBorder = false;
+        fInString = false;
+        fInDoubString = false;
+        fContentType = IPHPPartitionScannerConstants.HTML;
+//        String[] prev = getPartitionStack(offset);
     }
 
     private int read()
@@ -307,6 +402,7 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
         {
             if (fOffset < fEnd)
             {
+               fCurrentLength++;
                 return fDocument.getChar(fOffset++);
             }
             return ICharacterScanner.EOF;
@@ -323,6 +419,13 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
     private void unread()
     {
         --fOffset;
+        --fCurrentLength;
+    }
+    
+    private void unread(int num)
+    {
+       fOffset -= num;
+       fCurrentLength -= num;
     }
 
     private boolean checkPattern(char[] pattern)
@@ -341,6 +444,7 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
     private boolean checkPattern(char[] pattern, boolean ignoreCase)
     {
         int prevOffset = fOffset;
+        int prevLength = fCurrentLength;
         for (int i = 0; i < pattern.length; i++)
         {
             int c = read();
@@ -349,6 +453,7 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
                 || !letterEquals(c, pattern[i], ignoreCase))
             {
                 fOffset = prevOffset;
+                fCurrentLength = prevLength;
                 return false;
             }
         }
@@ -373,5 +478,58 @@ public class PHPPartitionScanner implements IPartitionTokenScanner
 
         return false;
     }
-
+    
+    /**
+     * 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.
+     */
+    private  boolean isInString(String contentType)
+    {
+       if(fContentType == contentType)
+               return (fInString || fInDoubString);
+       else
+               return false;           
+    }
+    
+    /**
+     * 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.
+     */
+    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;
+    }
+    
 }