X-Git-Url: http://git.phpeclipse.com diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/php/PHPCodeScanner.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/php/PHPCodeScanner.java index 41cbee2..fd92df4 100644 --- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/php/PHPCodeScanner.java +++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/php/PHPCodeScanner.java @@ -1,64 +1,208 @@ /********************************************************************** -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 -**********************************************************************/ + 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 + www.phpeclipse.de + **********************************************************************/ package net.sourceforge.phpeclipse.phpeditor.php; import java.util.ArrayList; +import java.util.HashMap; import java.util.List; -import java.util.Vector; +import java.util.Map; import net.sourceforge.phpdt.internal.ui.text.AbstractJavaScanner; -import net.sourceforge.phpdt.internal.ui.text.JavaColorManager; import net.sourceforge.phpdt.ui.text.IColorManager; -import net.sourceforge.phpdt.ui.text.IJavaColorConstants; import net.sourceforge.phpeclipse.IPreferenceConstants; -import net.sourceforge.phpeclipse.PHPeclipsePlugin; import net.sourceforge.phpeclipse.phpeditor.PHPSyntaxRdr; import net.sourceforge.phpeclipse.phpeditor.util.PHPWhitespaceDetector; import net.sourceforge.phpeclipse.phpeditor.util.PHPWordDetector; import org.eclipse.jface.preference.IPreferenceStore; -import org.eclipse.jface.preference.PreferenceConverter; -import org.eclipse.jface.text.TextAttribute; -import org.eclipse.jface.text.rules.EndOfLineRule; +import org.eclipse.jface.text.Assert; import org.eclipse.jface.text.rules.ICharacterScanner; import org.eclipse.jface.text.rules.IRule; 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.SingleLineRule; import org.eclipse.jface.text.rules.Token; import org.eclipse.jface.text.rules.WhitespaceRule; import org.eclipse.jface.text.rules.WordRule; -import org.eclipse.swt.SWT; -import org.eclipse.swt.graphics.Color; /** * PHP Code Scanner */ -public class PHPCodeScanner - extends AbstractJavaScanner { - -// private static Token variable; -// private static Token keyword; -// private static Token type; -// private static Token constant; -// private static Token functionName; -// private static Token string; -// private static Token comment; -// private static Token multi_comment; -// private static Token other; +public class PHPCodeScanner extends AbstractJavaScanner { + + /** + * Rule to detect java operators. + * + * @since 3.0 + */ + protected class OperatorRule implements IRule { + + /** Java operators */ + private final char[] PHP_OPERATORS = { + ';', + '(', + ')', + '.', + '=', + '/', + '\\', + '+', + '-', + '*', + '[', + ']', + '<', + '>', + ':', + '?', + '!', + ',', + '|', + '&', + '^', + '%', + '~', + '@' }; + + /** Token to return for this rule */ + private final IToken fToken; + + /** Token to return for braces */ + private final IToken fTokenBraces; + + /** + * Creates a new operator rule. + * + * @param token + * Token to use for this rule + */ + public OperatorRule(IToken token, IToken tokenBraces) { + fToken = token; + fTokenBraces = tokenBraces; + + } + + /** + * Is this character an operator character? + * + * @param character + * Character to determine whether it is an operator character + * @return true iff the character is an operator, false otherwise. + */ + public boolean isOperator(char character) { + for (int index = 0; index < PHP_OPERATORS.length; index++) { + if (PHP_OPERATORS[index] == character) + return true; + } + return false; + } + + /* + * @see org.eclipse.jface.text.rules.IRule#evaluate(org.eclipse.jface.text.rules.ICharacterScanner) + */ + public IToken evaluate(ICharacterScanner scanner) { + + int character = scanner.read(); + if (character == '{' || character == '}') { + return fTokenBraces; + } + if (isOperator((char) character)) { + int lastCharacter = character; + character = scanner.read(); + if (!isOperator((char) character)) { + scanner.unread(); + return fToken; + } + if (checkPHPTag(scanner, lastCharacter, character)) { + return Token.UNDEFINED; + } + do { + lastCharacter = character; + character = scanner.read(); + if (checkPHPTag(scanner, lastCharacter, character)) { + return fToken; + } + } while (isOperator((char) character)); + scanner.unread(); + return fToken; + } else { + scanner.unread(); + return Token.UNDEFINED; + } + } + + /** + * Check if lastCharacter/character are a PHP start or end token ( <? ... ?> ) + * + * @param scanner + * @param lastCharacter + * @param character + * @return + */ + private boolean checkPHPTag(ICharacterScanner scanner, int lastCharacter, int character) { + if (lastCharacter == '<' && character == '?') { + scanner.unread(); + scanner.unread(); + return true; + } else if (lastCharacter == '?' && character == '>') { + scanner.unread(); + scanner.unread(); + return true; + } + return false; + } + } + + + protected class AccentStringRule implements IRule { + + /** Token to return for this rule */ + private final IToken fToken; + + public AccentStringRule(IToken token) { + fToken = token; + + } + + /* + * @see org.eclipse.jface.text.rules.IRule#evaluate(org.eclipse.jface.text.rules.ICharacterScanner) + */ + public IToken evaluate(ICharacterScanner scanner) { + + int character = scanner.read(); + + if (character == '`') { + + while (character != ICharacterScanner.EOF) { + character = scanner.read(); + if (character == '\\') { + character = scanner.read(); + } else if (character == '`') { + return fToken; + } + } + scanner.unread(); + return Token.UNDEFINED; + } else { + scanner.unread(); + return Token.UNDEFINED; + } + } + + } private class PHPWordRule extends WordRule { private StringBuffer fBuffer = new StringBuffer(); + protected Map fWordsIgnoreCase = new HashMap(); public PHPWordRule(IWordDetector detector) { super(detector, Token.UNDEFINED); @@ -68,9 +212,67 @@ public class PHPCodeScanner super(detector, defaultToken); } + /** + * Adds a word and the token to be returned if it is detected. + * + * @param word the word this rule will search for, may not be null + * @param token the token to be returned if the word has been found, may not be null + */ + public void addWordIgnoreCase(String word, IToken token) { + Assert.isNotNull(word); + Assert.isNotNull(token); + + fWordsIgnoreCase.put(word, token); + } + public IToken evaluate(ICharacterScanner scanner) { int c = scanner.read(); boolean isVariable = false; + boolean isUnderscore = false; + String word; + if (c == '<') { + c = scanner.read(); + if (c != '?') { + scanner.unread(); + scanner.unread(); + return Token.UNDEFINED; + } else { + c = scanner.read(); + if (c == '=') { // ') { + return getToken(IPreferenceConstants.PHP_TAG); + } + scanner.unread(); + scanner.unread(); + return Token.UNDEFINED; + } if (fDetector.isWordStart((char) c)) { if (c == '$') { isVariable = true; @@ -78,17 +280,29 @@ public class PHPCodeScanner if (fColumn == UNDEFINED || (fColumn == scanner.getColumn() - 1)) { fBuffer.setLength(0); - do { - fBuffer.append((char) c); + fBuffer.append((char) c); + c = scanner.read(); + if (c == '_') { + isUnderscore = true; + } + while (c != ICharacterScanner.EOF && fDetector.isWordPart((char) c)) { + fBuffer.append((char) c); c = scanner.read(); - } while ( - c != ICharacterScanner.EOF && fDetector.isWordPart((char) c)); + } scanner.unread(); if (isVariable) { - return getToken(IJavaColorConstants.PHP_VARIABLE); + if (isUnderscore) { + return getToken(IPreferenceConstants.PHP_VARIABLE_DOLLAR); + } + return getToken(IPreferenceConstants.PHP_VARIABLE); } - IToken token = (IToken) fWords.get(fBuffer.toString()); + word = fBuffer.toString(); + IToken token = (IToken) fWords.get(word); + if (token != null) + return token; + + token = (IToken) fWordsIgnoreCase.get(word.toLowerCase()); if (token != null) return token; @@ -107,197 +321,100 @@ public class PHPCodeScanner //private PHPColorProvider fColorProvider; private static String[] fgTokenProperties = { - IJavaColorConstants.PHP_MULTI_LINE_COMMENT, - IJavaColorConstants.PHP_SINGLE_LINE_COMMENT, - IJavaColorConstants.PHP_KEYWORD, - IJavaColorConstants.PHP_FUNCTIONNAME, - IJavaColorConstants.PHP_VARIABLE, - IJavaColorConstants.PHP_STRING, - IJavaColorConstants.PHP_TYPE, - IJavaColorConstants.PHP_CONSTANT, - IJavaColorConstants.PHP_DEFAULT }; + IPreferenceConstants.PHP_MULTILINE_COMMENT, + IPreferenceConstants.PHP_SINGLELINE_COMMENT, + IPreferenceConstants.PHP_TAG, + IPreferenceConstants.PHP_KEYWORD, + IPreferenceConstants.PHP_FUNCTIONNAME, + IPreferenceConstants.PHP_VARIABLE, + IPreferenceConstants.PHP_VARIABLE_DOLLAR, + IPreferenceConstants.PHP_STRING_DQ, + IPreferenceConstants.PHP_STRING_SQ, + IPreferenceConstants.PHP_TYPE, + IPreferenceConstants.PHP_CONSTANT, + IPreferenceConstants.PHP_DEFAULT, + IPreferenceConstants.PHP_OPERATOR, + IPreferenceConstants.PHP_BRACE_OPERATOR, + IPreferenceConstants.PHP_KEYWORD_RETURN }; + /** - * Creates a PHP code scanner - */ + * Creates a PHP code scanner + */ // public PHPCodeScanner(JavaColorManager provider, IPreferenceStore store) { public PHPCodeScanner(IColorManager manager, IPreferenceStore store) { super(manager, store); initialize(); - // // final IPreferenceStore store = PHPeclipsePlugin.getDefault().getPreferenceStore(); - // Color BackgroundColor = provider.getColor(PreferenceConverter.getColor(store, PHP_EDITOR_BACKGROUND)); - // variable = - // new Token( - // new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_VARIABLE)), - // BackgroundColor, - // (store.getBoolean(PHP_VARIABLE_BOLD) ? SWT.BOLD : SWT.NONE) - // + (store.getBoolean(PHP_VARIABLE_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // keyword = - // new Token(new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_KEYWORD)), - // BackgroundColor, - // //SWT.NONE)); - // (store.getBoolean(PHP_KEYWORD_BOLD) ? SWT.BOLD : SWT.NONE) + (store.getBoolean(PHP_KEYWORD_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // type = - // new Token(new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_TYPE)), - // BackgroundColor, - // //SWT.NONE)); - // (store.getBoolean(PHP_TYPE_BOLD) ? SWT.BOLD : SWT.NONE) + (store.getBoolean(PHP_TYPE_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // functionName = - // new Token(new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_FUNCTIONNAME)), - // BackgroundColor, - // //SWT.NONE)); - // (store.getBoolean(PHP_FUNCTIONNAME_BOLD) ? SWT.BOLD : SWT.NONE) - // + (store.getBoolean(PHP_FUNCTIONNAME_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // constant = - // new Token(new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_CONSTANT)), - // BackgroundColor, - // //SWT.NONE)); - // (store.getBoolean(PHP_CONSTANT_BOLD) ? SWT.BOLD : SWT.NONE) + (store.getBoolean(PHP_CONSTANT_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // string = - // new Token(new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_STRING)), - // BackgroundColor, - // //SWT.NONE)); - // (store.getBoolean(PHP_STRING_BOLD) ? SWT.BOLD : SWT.NONE ) + (store.getBoolean(PHP_STRING_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // comment = - // new Token(new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_SINGLELINE_COMMENT)), - // BackgroundColor, - // //SWT.NONE)); - // (store.getBoolean(PHP_SINGLELINE_COMMENT_BOLD) ? SWT.BOLD : SWT.NONE ) - // + (store.getBoolean(PHP_SINGLELINE_COMMENT_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // multi_comment = - // new Token(new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_MULTILINE_COMMENT)), - // BackgroundColor, - // //SWT.NONE)); - // (store.getBoolean(PHP_MULTILINE_COMMENT_BOLD) ? SWT.BOLD : SWT.NONE) - // + (store.getBoolean(PHP_MULTILINE_COMMENT_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // other = - // new Token(new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_DEFAULT)), - // BackgroundColor, - // //SWT.NONE)); - // (store.getBoolean(PHP_DEFAULT_BOLD) ? SWT.BOLD : SWT.NONE) + (store.getBoolean(PHP_DEFAULT_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // updateWordRules(); } - // public void updateToken(JavaColorManager provider) { - // final IPreferenceStore store = PHPeclipsePlugin.getDefault().getPreferenceStore(); - // - // Color BackgroundColor = provider.getColor(PreferenceConverter.getColor(store, PHP_EDITOR_BACKGROUND)); - // - // variable.setData( - // new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_VARIABLE)), - // BackgroundColor, - // (store.getBoolean(PHP_VARIABLE_BOLD) ? SWT.BOLD : SWT.NONE) - // + (store.getBoolean(PHP_VARIABLE_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // keyword.setData( - // new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_KEYWORD)), - // BackgroundColor, - // (store.getBoolean(PHP_KEYWORD_BOLD) ? SWT.BOLD : SWT.NONE) - // + (store.getBoolean(PHP_KEYWORD_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // type.setData( - // new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_TYPE)), - // BackgroundColor, - // (store.getBoolean(PHP_TYPE_BOLD) ? SWT.BOLD : SWT.NONE) + (store.getBoolean(PHP_TYPE_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // functionName.setData( - // new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_FUNCTIONNAME)), - // BackgroundColor, - // (store.getBoolean(PHP_FUNCTIONNAME_BOLD) ? SWT.BOLD : SWT.NONE) - // + (store.getBoolean(PHP_FUNCTIONNAME_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // constant.setData( - // new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_CONSTANT)), - // BackgroundColor, - // (store.getBoolean(PHP_CONSTANT_BOLD) ? SWT.BOLD : SWT.NONE) - // + (store.getBoolean(PHP_CONSTANT_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // string.setData( - // new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_STRING)), - // BackgroundColor, - // (store.getBoolean(PHP_STRING_BOLD) ? SWT.BOLD : SWT.NONE) + (store.getBoolean(PHP_STRING_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // comment.setData( - // new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_SINGLELINE_COMMENT)), - // BackgroundColor, - // (store.getBoolean(PHP_SINGLELINE_COMMENT_BOLD) ? SWT.BOLD : SWT.NONE) - // + (store.getBoolean(PHP_SINGLELINE_COMMENT_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // multi_comment.setData( - // new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_MULTILINE_COMMENT)), - // BackgroundColor, - // (store.getBoolean(PHP_MULTILINE_COMMENT_BOLD) ? SWT.BOLD : SWT.NONE) - // + (store.getBoolean(PHP_MULTILINE_COMMENT_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // other.setData( - // new TextAttribute( - // provider.getColor(PreferenceConverter.getColor(store, PHP_DEFAULT)), - // BackgroundColor, - // (store.getBoolean(PHP_DEFAULT_BOLD) ? SWT.BOLD : SWT.NONE) - // + (store.getBoolean(PHP_DEFAULT_ITALIC) ? SWT.ITALIC : SWT.NONE))); - // } - - // public void updateWordRules() { - /* * @see AbstractJavaScanner#getTokenProperties() */ protected String[] getTokenProperties() { return fgTokenProperties; } + /* * @see AbstractJavaScanner#createRules() */ protected List createRules() { List rules = new ArrayList(); - Token token= getToken(IJavaColorConstants.PHP_SINGLE_LINE_COMMENT); + Token token = getToken(IPreferenceConstants.PHP_SINGLELINE_COMMENT); // Add rule for single line comments. - rules.add(new EndOfLineRule("//", token)); //$NON-NLS-1$ - rules.add(new EndOfLineRule("#", token)); + // rules.add(new EndOfLineRule("//", token)); //$NON-NLS-1$ + // rules.add(new EndOfLineRule("#", token)); //$NON-NLS-1$ // Add rule for strings and character constants. - token= getToken(IJavaColorConstants.PHP_STRING); - rules.add(new MultiLineRule("\"", "\"", token, '\\')); //$NON-NLS-2$ //$NON-NLS-1$ - rules.add(new SingleLineRule("'", "'", token, '\\')); //$NON-NLS-2$ //$NON-NLS-1$ - token= getToken(IJavaColorConstants.PHP_MULTI_LINE_COMMENT); - rules.add(new MultiLineRule("/*", "*/", token)); + // token = getToken(IPreferenceConstants.PHP_STRING_SQ); + // rules.add(new SingleQuoteStringRule(token)); + // token = getToken(IPreferenceConstants.PHP_STRING_DQ); + // rules.add(new DoubleQuoteStringRule(token)); + rules.add(new AccentStringRule(token)); + + token = getToken(IPreferenceConstants.PHP_MULTILINE_COMMENT); + rules.add(new MultiLineRule("/*", "*/", token)); //$NON-NLS-2$ //$NON-NLS-1$ // Add generic whitespace rule. rules.add(new WhitespaceRule(new PHPWhitespaceDetector())); // Add word rule for keywords, types, and constants. - token= getToken(IJavaColorConstants.PHP_DEFAULT); + token = getToken(IPreferenceConstants.PHP_DEFAULT); PHPWordRule wordRule = new PHPWordRule(new PHPWordDetector(), token); - Token keyword= getToken(IJavaColorConstants.PHP_KEYWORD); - Token functionName= getToken(IJavaColorConstants.PHP_FUNCTIONNAME); - Token type= getToken(IJavaColorConstants.PHP_TYPE); - Token constant= getToken(IJavaColorConstants.PHP_CONSTANT); - PHPSyntaxRdr.readInSyntax(); - Vector buffer = PHPSyntaxRdr.getsyntaxdata(); - String strbuffer = null; + Token keyword = getToken(IPreferenceConstants.PHP_KEYWORD); + Token functionName = getToken(IPreferenceConstants.PHP_FUNCTIONNAME); + Token type = getToken(IPreferenceConstants.PHP_TYPE); + Token constant = getToken(IPreferenceConstants.PHP_CONSTANT); + + ArrayList buffer = PHPSyntaxRdr.getSyntaxData(); + // String strbuffer = null; unused PHPElement elbuffer = null; - while ((buffer != null) - && (!buffer.isEmpty() - && ((elbuffer = (PHPElement) buffer.remove(0)) != null))) { - if (elbuffer instanceof PHPKeyword) - wordRule.addWord(((PHPKeyword) elbuffer).getName(), keyword); - if (elbuffer instanceof PHPFunction) - wordRule.addWord(((PHPFunction) elbuffer).getName(), functionName); - if (elbuffer instanceof PHPType) + String name; + for (int i = 0; i < buffer.size(); i++) { + // while ((buffer != null) + // && (!buffer.isEmpty() + // && ((elbuffer = (PHPElement) buffer.remove(0)) != null))) { + elbuffer = (PHPElement) buffer.get(i); + if (elbuffer instanceof PHPKeyword) { + name = ((PHPKeyword) elbuffer).getName(); + if (!name.equals("return")) { + wordRule.addWord(name, keyword); + } + } else if (elbuffer instanceof PHPFunction) { + wordRule.addWordIgnoreCase(((PHPFunction) elbuffer).getName(), functionName); + } else if (elbuffer instanceof PHPType) { wordRule.addWord(elbuffer.getName(), type); - if (elbuffer instanceof PHPConstant) + } else if (elbuffer instanceof PHPConstant) { wordRule.addWord(elbuffer.getName(), constant); + } } + + // Add word rule for keyword 'return'. + token = getToken(IPreferenceConstants.PHP_KEYWORD_RETURN); + wordRule.addWord("return", token); + + // Add rule for operators and brackets (at the end !) + rules.add(new OperatorRule(getToken(IPreferenceConstants.PHP_OPERATOR), getToken(IPreferenceConstants.PHP_BRACE_OPERATOR))); + rules.add(wordRule); - IRule[] result = new IRule[rules.size()]; - // rules.toArray(result); - // setRules(result); + + setDefaultReturnToken(getToken(IPreferenceConstants.PHP_DEFAULT)); return rules; } -} +} \ No newline at end of file