added code completion for HTML mode
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / php / PHPPartitionScanner.java
index bebcc1f..a797115 100644 (file)
@@ -32,16 +32,17 @@ 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 String PHP = "__php"; //$NON-NLS-1$
+  //public final static String HTML = "__html"; //$NON-NLS-1$
 
   public final static IToken php = new Token(PHP);
-//  public final static IToken html = new Token(HTML);
+  //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 {
@@ -64,48 +65,65 @@ public class PHPPartitionScanner extends RuleBasedPartitionScanner {
 
       char[][] delimiters = scanner.getLegalLineDelimiters();
       while ((c = scanner.read()) != ICharacterScanner.EOF) {
-        if (lineCommentMode && (c == '\n')) {
-          lineCommentMode = false;
-          // read until end of line
-        } else if ((!stringMode) && (c == '#')) {
+        if (c == '#') {
           // read until end of line
-          lineCommentMode = true;
-          continue;
-        } else if ((!stringMode) && (!multiLineCommentMode) && (c == '/')) {
-          c2 = scanner.read();
-          if (c2 == '/') {
-            lineCommentMode = true;
-            continue;
-          } else if (c2 == '*') {
-            multiLineCommentMode = true;
-            continue;
-          } else {
-            scanner.unread();
+          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;
+            }
           }
-        } else if (c == '*' && multiLineCommentMode) {
-          c2 = scanner.read();
-          if (c2 == '/') {
-            multiLineCommentMode = false;
+          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 {
-            scanner.unread();
-          }
-        } else if (c == '\\' && stringMode) {
-          c2 = scanner.read();
-          if (c2 == '"') {
+          } else if (c == '*') {
+            // multi-line comment
+            while ((c = scanner.read()) != ICharacterScanner.EOF) {
+              if (c == '*' && (c = scanner.read()) != ICharacterScanner.EOF) {
+                if (c == '/') {
+                  break;
+                }
+                scanner.unread();
+              }
+            }
+
             continue;
           } else {
             scanner.unread();
           }
-        } else if ((!lineCommentMode) && (!multiLineCommentMode) && (c == '"')) {
-          if (stringMode) {
-            stringMode = false;
-          } else {
-            stringMode = true;
+        } else if (c == '"') {
+          // string mode
+          while ((c = scanner.read()) != ICharacterScanner.EOF) {
+            if (c == '\\') {
+              c = scanner.read();
+            } else if (c == '"') {
+              break;
+            }
           }
           continue;
-        }
-        if (lineCommentMode || multiLineCommentMode || stringMode) {
+        } else if (c == '\'') {
+          // string mode
+          while ((c = scanner.read()) != ICharacterScanner.EOF) {
+            if (c == '\\') {
+              c = scanner.read();
+            } else if (c == '\'') {
+              break;
+            }
+          }
           continue;
         }
 
@@ -123,22 +141,203 @@ public class PHPPartitionScanner extends RuleBasedPartitionScanner {
               return true;
           }
         }
+      } 
+      boolean phpMode = false;
+      if (c == ICharacterScanner.EOF) {
+        phpMode = true;
       }
       scanner.unread();
-      return false;
+      return phpMode;
     }
   }
 
-//  public class HTMLMultiLineRule extends MultiLineRule {
+  //  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;
+//
+//    /** The token to be returned on success */
+//    protected IToken fToken;
+//
+//    /** 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;
+//
+//    /**
+//     * 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
+//     */
+//    public void setColumnConstraint(int column) {
+//      if (column < 0)
+//        column = UNDEFINED;
+//      fColumn = column;
+//    }
+//
+//    /**
+//     * Evaluates this rules without considering any column constraints.
+//     *
+//     * @param scanner the character scanner to be used
+//     * @return the token resulting from this evaluation
+//     */
+//    protected IToken doEvaluate(ICharacterScanner scanner) {
+//      return doEvaluate(scanner, false);
+//    }
+//
+//    /**
+//     * 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
+//     */
+//    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 HTMLMultiLineRule(String startSequence, String endSequence, IToken token) {
-//      super(startSequence, endSequence, token);
+//      scanner.unread();
+//      return Token.UNDEFINED;
 //    }
 //
-//    public HTMLMultiLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter) {
-//      super(startSequence, endSequence, token, escapeCharacter);
+//    /*
+//     * @see IRule#evaluate
+//     */
+//    public IToken evaluate(ICharacterScanner scanner) {
+//      return evaluate(scanner, false);
 //    }
 //
+//    /**
+//     * 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
+//     */
 //    protected boolean endSequenceDetected(ICharacterScanner scanner) {
 //      int c;
 //
@@ -178,28 +377,38 @@ public class PHPPartitionScanner extends RuleBasedPartitionScanner {
 //      return false;
 //    }
 //
-//    protected IToken doEvaluate(ICharacterScanner scanner, boolean resume) {
-//
-//      if (resume) {
-//
-//        if (endSequenceDetected(scanner))
-//          return fToken;
-//
-//      } else {
-//
+//    /**
+//     * 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 == fStartSequence[0]) {
-//        //       if (sequenceDetected(scanner, fStartSequence, false)) {
-//        if (endSequenceDetected(scanner))
-//          return fToken;
-//        //       }
-//        //     }
+//        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;
+//        }
 //      }
 //
-//      scanner.unread();
-//      return Token.UNDEFINED;
+//      return true;
 //    }
 //
+//    /*
+//     * @see IPredicateRule#evaluate(ICharacterScanner, boolean)
+//     * @since 2.0
+//     */
 //    public IToken evaluate(ICharacterScanner scanner, boolean resume) {
 //      if (fColumn == UNDEFINED)
 //        return doEvaluate(scanner, resume);
@@ -211,249 +420,62 @@ public class PHPPartitionScanner extends RuleBasedPartitionScanner {
 //      //    else
 //      //      return Token.UNDEFINED;
 //    }
+//
+//    /*
+//     * @see IPredicateRule#getSuccessToken()
+//     * @since 2.0
+//     */
+//    public IToken getSuccessToken() {
+//      return fToken;
+//    }
 //  }
-
-  public class HTMLPatternRule implements IPredicateRule {
-
-    protected static final int UNDEFINED = -1;
-
-    /** The token to be returned on success */
-    protected IToken fToken;
-
-    /** 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;
-
-    /**
-     * 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
-     */
-    public void setColumnConstraint(int column) {
-      if (column < 0)
-        column = UNDEFINED;
-      fColumn = column;
-    }
-
-    /**
-     * Evaluates this rules without considering any column constraints.
-     *
-     * @param scanner the character scanner to be used
-     * @return the token resulting from this evaluation
-     */
-    protected IToken doEvaluate(ICharacterScanner scanner) {
-      return doEvaluate(scanner, false);
-    }
-
-    /**
-     * 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
-     */
-    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;
-    }
-
-    /*
-     * @see IRule#evaluate
-     */
-    public IToken evaluate(ICharacterScanner scanner) {
-      return evaluate(scanner, false);
-    }
-
-    /**
-     * 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
-     */
-    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;
-    }
-
-    /**
-     * 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;
-        }
-      }
-
-      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;
-    }
-
-    /*
-     * @see IPredicateRule#getSuccessToken()
-     * @since 2.0
-     */
-    public IToken getSuccessToken() {
-      return fToken;
-    }
-  }
   /**
    * Detector for empty comments.
    */
-  static class EmptyCommentDetector implements IWordDetector {
-
-    /* (non-Javadoc)
-    * Method declared on IWordDetector
-       */
-    public boolean isWordStart(char c) {
-      return (c == '/');
-    }
-
-    /* (non-Javadoc)
-    * Method declared on IWordDetector
-       */
-    public boolean isWordPart(char c) {
-      return (c == '*' || c == '/');
-    }
-  };
+//  static class EmptyCommentDetector implements IWordDetector {
+//
+//    /* (non-Javadoc)
+//    * Method declared on IWordDetector
+//     */
+//    public boolean isWordStart(char c) {
+//      return (c == '/');
+//    }
+//
+//    /* (non-Javadoc)
+//    * Method declared on IWordDetector
+//     */
+//    public boolean isWordPart(char c) {
+//      return (c == '*' || c == '/');
+//    }
+//  };
 
   /**
    * 
    */
-  static class WordPredicateRule extends WordRule implements IPredicateRule {
-
-    private IToken fSuccessToken;
-
-    public WordPredicateRule(IToken successToken) {
-      super(new EmptyCommentDetector());
-      fSuccessToken = successToken;
-      addWord("/**/", fSuccessToken);
-    }
-
-    /*
-     * @see org.eclipse.jface.text.rules.IPredicateRule#evaluate(ICharacterScanner, boolean)
-     */
-    public IToken evaluate(ICharacterScanner scanner, boolean resume) {
-      return super.evaluate(scanner);
-    }
-
-    /*
-     * @see org.eclipse.jface.text.rules.IPredicateRule#getSuccessToken()
-     */
-    public IToken getSuccessToken() {
-      return fSuccessToken;
-    }
-  };
+//  static class WordPredicateRule extends WordRule implements IPredicateRule {
+//
+//    private IToken fSuccessToken;
+//
+//    public WordPredicateRule(IToken successToken) {
+//      super(new EmptyCommentDetector());
+//      fSuccessToken = successToken;
+//      addWord("/**/", fSuccessToken);
+//    }
+//
+//    /*
+//     * @see org.eclipse.jface.text.rules.IPredicateRule#evaluate(ICharacterScanner, boolean)
+//     */
+//    public IToken evaluate(ICharacterScanner scanner, boolean resume) {
+//      return super.evaluate(scanner);
+//    }
+//
+//    /*
+//     * @see org.eclipse.jface.text.rules.IPredicateRule#getSuccessToken()
+//     */
+//    public IToken getSuccessToken() {
+//      return fSuccessToken;
+//    }
+//  };
 
   /**
    * Creates the partitioner and sets up the appropriate rules.
@@ -475,7 +497,7 @@ public class PHPPartitionScanner extends RuleBasedPartitionScanner {
     // rules.add(new SingleLineRule("'", "'", Token.UNDEFINED, '\\')); 
 
     // Add special case word rule.
-//    rules.add(new WordPredicateRule(comment));
+    //    rules.add(new WordPredicateRule(comment));
 
     // Add rules for multi-line comments and javadoc.
     //rules.add(new MultiLineRule("/**", "*/", javaDoc));
@@ -489,13 +511,13 @@ public class PHPPartitionScanner extends RuleBasedPartitionScanner {
     rules.add(new PHPMultiLineRule("<?php", "?>", php));
     rules.add(new PHPMultiLineRule("<?PHP", "?>", php));
 
-//    rules.add(new HTMLPatternRule(html)); // "<", "<?",
+    //    rules.add(new HTMLPatternRule(html)); // "<", "<?",
     //Add rule for processing instructions
 
     IPredicateRule[] result = new IPredicateRule[rules.size()];
     rules.toArray(result);
     setPredicateRules(result);
-//    setDefaultReturnToken(html);
+   // setDefaultReturnToken(html);
   }
 
   //    public IToken nextToken() {