* Created on 05.03.2003
*
* @author Stefan Langer (musk)
- * @version $Revision: 1.15 $
+ * @version $Revision: 1.24 $
*/
package net.sourceforge.phpeclipse.phpeditor.php;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Map;
-import org.eclipse.jface.text.*;
-import org.eclipse.jface.text.rules.*;
+import net.sourceforge.phpdt.internal.ui.text.*;
+
+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;
/**
*
*/
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 fContentType = IPHPPartitions.HTML;
+ private String fPrevContentType = IPHPPartitions.HTML;
private boolean partitionBorder = false;
private int fTokenOffset;
private int fEnd = -1;
private int fLength;
+ private int fCurrentLength;
+ private int fFileType;
private Map tokens = new HashMap();
public PHPPartitionScanner() {
+ this(IPHPPartitions.PHP_FILE);
+ }
+
+ public PHPPartitionScanner(int fileType) {
+ this.tokens.put(IPHPPartitions.PHP_PARTITIONING, new Token(IPHPPartitions.PHP_PARTITIONING));
+ this.tokens.put(IPHPPartitions.PHP_STRING_DQ, new Token(IPHPPartitions.PHP_STRING_DQ));
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));
+ IPHPPartitions.PHP_PHPDOC_COMMENT,
+ new Token(IPHPPartitions.PHP_PHPDOC_COMMENT));
+ this.tokens.put(IPHPPartitions.HTML, new Token(IPHPPartitions.HTML));
this.tokens.put(
- IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT,
- new Token(IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT));
+ IPHPPartitions.HTML_MULTILINE_COMMENT,
+ new Token(IPHPPartitions.HTML_MULTILINE_COMMENT));
+
+ this.tokens.put(IPHPPartitions.SMARTY, new Token(IPHPPartitions.SMARTY));
this.tokens.put(
- IDocument.DEFAULT_CONTENT_TYPE,
- new Token(IDocument.DEFAULT_CONTENT_TYPE));
+ IPHPPartitions.SMARTY_MULTILINE_COMMENT,
+ new Token(IPHPPartitions.SMARTY_MULTILINE_COMMENT));
+
+ this.tokens.put(IDocument.DEFAULT_CONTENT_TYPE, new Token(IDocument.DEFAULT_CONTENT_TYPE));
+ fFileType = fileType;
}
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) {
- System.out.println(
- "Partition: fTokenOffset="
- + fTokenOffset
- + " fContentType="
- + fContentType
- + " fLength="
- + fLength);
+ System.out.println("Partition: fTokenOffset=" + fTokenOffset + " fContentType=" + type + " fLength=" + fLength);
}
return token;
}
-/* (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)
-{
- this.setRange(document, offset, length);
- if (DEBUG)
- {
- System.out.println(
- "PartialRange: contentType="
- + contentType
- + " partitionOffset="
- + partitionOffset);
+ /* (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("*****");
+ System.out.println("PartialRange: contentType=" + contentType + " partitionOffset=" + partitionOffset);
}
-
- if(offset == partitionOffset)
- {
- try
- {
- fContentType = fDocument.getContentType(offset);
- }
- catch (BadLocationException e)
- {
- //should never happen
- }
- }
- else if (this.tokens.containsKey(contentType))
- fContentType = contentType;
- // TODO Calculate previouse contenttype
- if (partitionOffset > -1)
- {
+
+ try {
+ if (partitionOffset > -1) {
partitionBorder = false;
- fTokenOffset = partitionOffset;
+ // 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)
* @see org.eclipse.jface.text.rules.ITokenScanner#getTokenLength()
return fTokenOffset;
}
-/* (non-Javadoc)
- * @see org.eclipse.jface.text.rules.ITokenScanner#nextToken()
- */
-public IToken nextToken()
-{
+ /* (non-Javadoc)
+ * @see org.eclipse.jface.text.rules.ITokenScanner#nextToken()
+ */
+ 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();
+ if ((c = read()) == ICharacterScanner.EOF) {
+ partitionBorder = false;
+ return Token.EOF;
+ } else
+ unread();
- if (partitionBorder)
- {
- fTokenOffset = fOffset;
- partitionBorder = false;
+ if (partitionBorder) {
+ fTokenOffset = fOffset;
+ partitionBorder = false;
}
- while ((c = read()) != ICharacterScanner.EOF)
- {
- switch (c)
- {
- case '<' :
- if (fContentType
- != IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT
- && checkPattern(new char[] { '?', 'p', 'h', 'p' }, true))
- {
- if (fContentType != IPHPPartitionScannerConstants.PHP
- && fOffset - 5 > 0)
- {
- fOffset -= 5;
- 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 - 5;
- }
- else if (
- fContentType
- != IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT
- && checkPattern(new char[] { '?' }, false))
- {
- if (fContentType != IPHPPartitionScannerConstants.PHP
- && fOffset - 2 > 0)
- {
- fOffset -= 2;
- IToken token = getToken(fContentType);
- // save previouse contenttype
- fPrevContentType =
- fContentType;
- fContentType = IPHPPartitionScannerConstants.PHP;
- return token;
- }
- else
- fContentType = IPHPPartitionScannerConstants.PHP;
+ while ((c = read()) != ICharacterScanner.EOF) {
+ switch (c) {
+ case '<' :
+ if (!isInString(IPHPPartitions.PHP_PARTITIONING)
+ && fContentType != IPHPPartitions.PHP_PHPDOC_COMMENT
+ && checkPattern(new char[] { '?', 'p', 'h', 'p' }, true)) {
+ if (fContentType != IPHPPartitions.PHP_PARTITIONING && fCurrentLength > 5) {
+ unread(5);
+ IToken token = getToken(fContentType);
+ // save previouse contenttype
+ //TODO build stack for previouse contenttype
+ fPrevContentType = fContentType;
+
+ fContentType = IPHPPartitions.PHP_PARTITIONING;
+
+ return token;
+ } else
+ fContentType = IPHPPartitions.PHP_PARTITIONING;
+
// remember offset of this partition
- fTokenOffset = fOffset - 2;
- }
- else if (checkPattern(new char[] { '!', '-', '-' }))
- { // return previouse partition
- if (
- fContentType
- != IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT
- && fOffset - 4 > 0)
- {
- fOffset -= 4;
- IToken token = getToken(fContentType);
- fContentType =
- IPHPPartitionScannerConstants
- .HTML_MULTILINE_COMMENT;
- return token;
- }
- else
- fContentType =
- IPHPPartitionScannerConstants
- .HTML_MULTILINE_COMMENT;
- fTokenOffset = fOffset - 4;
- }
- break; case '?' :
- if (fContentType == IPHPPartitionScannerConstants.PHP)
- {
- if ((c = read()) == '>')
- { // TODO Actually calculate the previouse contenttype from the document
- if (
- fPrevContentType
- != null)
- fContentType = fPrevContentType; else
- fContentType =
- IPHPPartitionScannerConstants.HTML;
- partitionBorder = true;
- return getToken(
- IPHPPartitionScannerConstants.PHP);
- }
- else if (c != ICharacterScanner.EOF)
- unread(); }
- break; case '-' :
- if (fContentType
- == IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT
- && checkPattern(new char[] { '-', '>' }))
- {
- fContentType = IPHPPartitionScannerConstants.HTML;
- partitionBorder = true;
- return getToken(
- IPHPPartitionScannerConstants
- .HTML_MULTILINE_COMMENT);
- }
- break; case '/' :
- if ((c = read()) == '*')
- { // MULTINE COMMENT JAVASCRIPT, CSS, PHP
- if (
- fContentType == IPHPPartitionScannerConstants.PHP
- && fOffset - 2 > 0)
- {
- fOffset -= 2;
- IToken token = getToken(fContentType);
- fContentType =
- IPHPPartitionScannerConstants
- .PHP_MULTILINE_COMMENT;
- return token;
- }
- else if (
- fContentType
- == IPHPPartitionScannerConstants
- .PHP_MULTILINE_COMMENT)
- {
-
- fTokenOffset = fOffset - 2; }
-
- }
- else if (c != ICharacterScanner.EOF)
- unread(); break; case '*' :
- if ((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 (c != ICharacterScanner.EOF)
- unread(); break; }
+ fTokenOffset = fOffset - 5;
+ fCurrentLength = 5;
+ } else if (
+ !isInString(IPHPPartitions.PHP_PARTITIONING)
+ && fContentType != IPHPPartitions.PHP_PHPDOC_COMMENT
+ && checkPattern(new char[] { '?' }, false)) {
+ if (fContentType != IPHPPartitions.PHP_PARTITIONING && fCurrentLength > 2) {
+ unread(2);
+ IToken token = getToken(fContentType);
+ // save previouse contenttype
+ fPrevContentType = fContentType;
+ fContentType = IPHPPartitions.PHP_PARTITIONING;
+ return token;
+ } else
+ fContentType = IPHPPartitions.PHP_PARTITIONING;
+ // remember offset of this partition
+ fTokenOffset = fOffset - 2;
+ fCurrentLength = 2;
+ } else if (
+ !isInString(IPHPPartitions.PHP_PARTITIONING)
+ && (fContentType != IPHPPartitions.PHP_PARTITIONING) // BUG #769044
+ && (fContentType != IPHPPartitions.PHP_PHPDOC_COMMENT) // BUG #769044
+ && checkPattern(new char[] { '!', '-', '-' })) { // return previouse partition
+ if (fContentType != IPHPPartitions.HTML_MULTILINE_COMMENT && fCurrentLength > 4) {
+ unread(4);
+ IToken token = getToken(fContentType);
+ fContentType = IPHPPartitions.HTML_MULTILINE_COMMENT;
+ return token;
+ } else
+ fContentType = IPHPPartitions.HTML_MULTILINE_COMMENT;
+
+ fTokenOffset = fOffset - 4;
+ fCurrentLength = 4;
+ }
+ break;
+ case '?' :
+ if (!isInString(IPHPPartitions.PHP_PARTITIONING) && fContentType == IPHPPartitions.PHP_PARTITIONING) {
+ if ((c = read()) == '>') {
+ if (fPrevContentType != null)
+ fContentType = fPrevContentType;
+ else
+ fContentType = IPHPPartitions.HTML;
+ partitionBorder = true;
+ return getToken(IPHPPartitions.PHP_PARTITIONING);
+ } else if (c != ICharacterScanner.EOF)
+ unread();
+ }
+ break;
+ case '-' :
+ if (!isInString(IPHPPartitions.PHP_PARTITIONING)
+ && fContentType == IPHPPartitions.HTML_MULTILINE_COMMENT
+ && checkPattern(new char[] { '-', '>' })) {
+ fContentType = IPHPPartitions.HTML;
+ partitionBorder = true;
+ return getToken(IPHPPartitions.HTML_MULTILINE_COMMENT);
+ }
+ break;
+ case '{' : // SMARTY code starts here ?
+ if (fFileType == IPHPPartitions.SMARTY_FILE) {
+ if ((c = read()) == '*') {
+ if (DEBUG) {
+ System.out.println(
+ "SMARTYDOC_TOKEN start "
+ + fTokenOffset
+ + " fContentType="
+ + fContentType
+ + " fLength="
+ + fLength
+ + " fOffset="
+ + fOffset
+ + " fCurrentLength="
+ + fCurrentLength);
+ }
+ if (fContentType != IPHPPartitions.SMARTY_MULTILINE_COMMENT && fCurrentLength > 2) {
+ // SMARTY doc code starts here
+ unread(2);
+ IToken token = getToken(fContentType);
+ fContentType = IPHPPartitions.SMARTY_MULTILINE_COMMENT;
+ return token;
+ // } else if (fContentType == IPHPPartitionScannerConstants.HTML && fOffset == 2) {
+ // fContentType = IPHPPartitionScannerConstants.SMARTY_MULTILINE_COMMENT;
+ } else { // if (fContentType == IPHPPartitionScannerConstants.SMARTY_MULTILINE_COMMENT) {
+ fContentType = IPHPPartitions.SMARTY_MULTILINE_COMMENT;
+ fTokenOffset = fOffset - 2;
+ fCurrentLength = 2;
+ }
+ break;
+ }
+ if (DEBUG) {
+ System.out.println(
+ "SMARTY_TOKEN start "
+ + fTokenOffset
+ + " fContentType="
+ + fContentType
+ + " fLength="
+ + fLength
+ + " fOffset="
+ + fOffset);
+ }
+ if (c != ICharacterScanner.EOF) {
+ unread();
+ }
+ if (fContentType != IPHPPartitions.SMARTY && fCurrentLength > 1) {
+ unread(1);
+ IToken token = getToken(fContentType);
+ fContentType = IPHPPartitions.SMARTY;
+ return token;
+ // } else if (fContentType == IPHPPartitionScannerConstants.HTML && fOffset==1) {
+ // fContentType = IPHPPartitionScannerConstants.SMARTY;
+ } else {
+ fContentType = IPHPPartitions.SMARTY;
+ fTokenOffset = fOffset - 1;
+ fCurrentLength = 1;
+ }
+ }
+ break;
+ case '}' : // SMARTY code ends here ?
+ if (fFileType == IPHPPartitions.SMARTY_FILE && fContentType == IPHPPartitions.SMARTY) {
+ if (DEBUG) {
+ System.out.println(
+ "SMARTY_TOKEN end "
+ + fTokenOffset
+ + " fContentType="
+ + fContentType
+ + " fLength="
+ + fLength
+ + " fOffset="
+ + fOffset);
+ }
+ fContentType = IPHPPartitions.HTML;
+ partitionBorder = true;
+ return getToken(IPHPPartitions.SMARTY);
+ }
+ break;
+ case '/' :
+ if (!isInString(IPHPPartitions.PHP_PARTITIONING) && (c = read()) == '*') { // MULTINE COMMENT JAVASCRIPT, CSS, PHP
+ if (fContentType == IPHPPartitions.PHP_PARTITIONING && fCurrentLength > 2) {
+ unread(2);
+ IToken token = getToken(fContentType);
+ fContentType = IPHPPartitions.PHP_PHPDOC_COMMENT;
+ return token;
+ } else if (fContentType == IPHPPartitions.PHP_PHPDOC_COMMENT) {
+ fTokenOffset = fOffset - 2;
+ fCurrentLength = 2;
+ }
+
+ } else if (!isInString(IPHPPartitions.PHP_PARTITIONING) && c != ICharacterScanner.EOF)
+ unread();
+ break;
+ case '*' :
+ if (!isInString(IPHPPartitions.PHP_PARTITIONING) && (c = read()) == '/') {
+ if (fContentType == IPHPPartitions.PHP_PHPDOC_COMMENT) {
+ fContentType = IPHPPartitions.PHP_PARTITIONING;
+ partitionBorder = true;
+ return getToken(IPHPPartitions.PHP_PHPDOC_COMMENT);
+ } else if (fContentType == IPHPPartitions.CSS_MULTILINE_COMMENT) {
+ } else if (fContentType == IPHPPartitions.JS_MULTILINE_COMMENT) {
+ }
+ } else if (fFileType == IPHPPartitions.SMARTY_FILE && (c = read()) == '}') {
+ if (DEBUG) {
+ System.out.println(
+ "SMARTYDOC_TOKEN end "
+ + fTokenOffset
+ + " fContentType="
+ + fContentType
+ + " fLength="
+ + fLength
+ + " fOffset="
+ + fOffset);
+ }
+ if (fContentType == IPHPPartitions.SMARTY_MULTILINE_COMMENT) {
+ fContentType = IPHPPartitions.HTML;
+ partitionBorder = true;
+ return getToken(IPHPPartitions.SMARTY_MULTILINE_COMMENT);
+ }
+ } else if (!isInString(IPHPPartitions.PHP_PARTITIONING) && 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);
- }
+ }
/* (non-Javadoc)
* @see org.eclipse.jface.text.rules.ITokenScanner#setRange(org.eclipse.jface.text.IDocument, int, int)
*/
fDocument = document;
fOffset = offset;
fTokenOffset = offset;
+ fCurrentLength = 0;
fLength = 0;
fEnd = fOffset + length;
- //partitionBorder = false;
+ fInString = false;
+ fInDoubString = false;
+ fContentType = IPHPPartitions.HTML;
+ // String[] prev = getPartitionStack(offset);
}
private int read() {
try {
if (fOffset < fEnd) {
+ fCurrentLength++;
return fDocument.getChar(fOffset++);
}
return ICharacterScanner.EOF;
private void unread() {
--fOffset;
+ --fCurrentLength;
+ }
+
+ private void unread(int num) {
+ fOffset -= num;
+ fCurrentLength -= num;
}
private boolean checkPattern(char[] pattern) {
*/
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)) {
+ if (c == ICharacterScanner.EOF || !letterEquals(c, pattern[i], ignoreCase)) {
fOffset = prevOffset;
+ fCurrentLength = prevLength;
return false;
}
}
private boolean letterEquals(int test, char letter, boolean ignoreCase) {
if (test == letter)
return true;
- else if (
- ignoreCase
- && Character.isLowerCase(letter)
- && test == Character.toUpperCase(letter))
+ else if (ignoreCase && Character.isLowerCase(letter) && test == Character.toUpperCase(letter))
return true;
- else if (
- ignoreCase
- && Character.isUpperCase(letter)
- && test == Character.toLowerCase(letter))
+ else if (ignoreCase && Character.isUpperCase(letter) && test == Character.toLowerCase(letter))
return true;
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;
+ }
+
}
git://secure.phpeclipse.com / phpeclipse.git / blobdiff