net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/php/PHPCodeScanner.java

   1 /**********************************************************************
   2 Copyright (c) 2000, 2002 IBM Corp. and others.
   3 All rights reserved. This program and the accompanying materials
   4 are made available under the terms of the Common Public License v1.0
   5 which accompanies this distribution, and is available at
   6 http://www.eclipse.org/legal/cpl-v10.html
   7
   8 Contributors:
   9     IBM Corporation - Initial implementation
  10     Klaus Hartlage - www.eclipseproject.de
  11 **********************************************************************/
  12 package net.sourceforge.phpeclipse.phpeditor.php;
  13
  14 import java.util.ArrayList;
  15 import java.util.List;
  16
  17 import net.sourceforge.phpdt.internal.ui.text.AbstractJavaScanner;
  18 import net.sourceforge.phpdt.ui.text.IColorManager;
  19 import net.sourceforge.phpeclipse.IPreferenceConstants;
  20 import net.sourceforge.phpeclipse.phpeditor.PHPSyntaxRdr;
  21 import net.sourceforge.phpeclipse.phpeditor.util.PHPWhitespaceDetector;
  22 import net.sourceforge.phpeclipse.phpeditor.util.PHPWordDetector;
  23
  24 import org.eclipse.jface.preference.IPreferenceStore;
  25 import org.eclipse.jface.text.rules.EndOfLineRule;
  26 import org.eclipse.jface.text.rules.ICharacterScanner;
  27 import org.eclipse.jface.text.rules.IRule;
  28 import org.eclipse.jface.text.rules.IToken;
  29 import org.eclipse.jface.text.rules.IWordDetector;
  30 import org.eclipse.jface.text.rules.MultiLineRule;
  31 import org.eclipse.jface.text.rules.Token;
  32 import org.eclipse.jface.text.rules.WhitespaceRule;
  33 import org.eclipse.jface.text.rules.WordRule;
  34
  35 /**
  36  * PHP Code Scanner
  37  */
  38 public class PHPCodeScanner extends AbstractJavaScanner {
  39
  40   /**
  41    * Rule to detect java operators.
  42    *
  43    * @since 3.0
  44    */
  45         protected class OperatorRule implements IRule {
  46
  47                 /** Java operators */
  48                 private final char[] JAVA_OPERATORS= { ';', '(', ')', '.', '=', '/', '\\', '+', '-', '*', '[', ']', '<', '>', ':', '?', '!', ',', '|', '&', '^', '%', '~', '@'};
  49                 /** Token to return for this rule */
  50                 private final IToken fToken;
  51                 /** Token to return for braces */
  52                 private final IToken fTokenBraces;
  53                 /**
  54      * Creates a new operator rule.
  55      *
  56      * @param token
  57      *          Token to use for this rule
  58      */
  59                 public OperatorRule(IToken token, IToken tokenBraces) {
  60                         fToken= token;
  61                         fTokenBraces= tokenBraces;
  62
  63                 }
  64
  65                 /**
  66      * Is this character an operator character?
  67      *
  68      * @param character
  69      *          Character to determine whether it is an operator character
  70      * @return <code>true</code> iff the character is an operator,
  71      *         <code>false</code> otherwise.
  72      */
  73                 public boolean isOperator(char character) {
  74                         for (int index= 0; index < JAVA_OPERATORS.length; index++) {
  75                                 if (JAVA_OPERATORS[index] == character)
  76                                         return true;
  77                         }
  78                         return false;
  79                 }
  80
  81                 /*
  82      * @see org.eclipse.jface.text.rules.IRule#evaluate(org.eclipse.jface.text.rules.ICharacterScanner)
  83      */
  84                 public IToken evaluate(ICharacterScanner scanner) {
  85
  86                         int character= scanner.read();
  87                         if (character=='{' || character=='}') {
  88                           return fTokenBraces;
  89                         }
  90                         if (isOperator((char) character)) {
  91                             int lastCharacter = character;
  92                             character= scanner.read();
  93                                 if (!isOperator((char) character)) {
  94                                   scanner.unread();
  95                               return fToken;
  96                                 }
  97                                 if (lastCharacter=='<' && character=='?') {
  98                                   scanner.unread();
  99                                   scanner.unread();
 100                           return Token.UNDEFINED;
 101                                 } else if (lastCharacter=='?' && character=='>') {
 102                                   scanner.unread();
 103                                   scanner.unread();
 104                           return Token.UNDEFINED;
 105                                 }
 106                                 do {
 107                                         character= scanner.read();
 108                                 } while (isOperator((char) character));
 109                                 scanner.unread();
 110                                 return fToken;
 111                         } else {
 112                                 scanner.unread();
 113                                 return Token.UNDEFINED;
 114                         }
 115                 }
 116         }
 117
 118   private class PHPWordRule extends WordRule {
 119     private StringBuffer fBuffer = new StringBuffer();
 120
 121     public PHPWordRule(IWordDetector detector) {
 122       super(detector, Token.UNDEFINED);
 123     }
 124
 125     public PHPWordRule(IWordDetector detector, IToken defaultToken) {
 126       super(detector, defaultToken);
 127     }
 128
 129     public IToken evaluate(ICharacterScanner scanner) {
 130       int c = scanner.read();
 131       boolean isVariable = false;
 132       if (c == '<') {
 133         c = scanner.read();
 134         if (c != '?') {
 135           scanner.unread();
 136           scanner.unread();
 137           return Token.UNDEFINED;
 138         } else {
 139           c = scanner.read();
 140           if (c != 'p' && c != 'P') {
 141             scanner.unread();
 142             return getToken(IPreferenceConstants.PHP_TAG);
 143           } else {
 144             c = scanner.read();
 145             if (c != 'h' && c != 'H') {
 146               scanner.unread();
 147               scanner.unread();
 148               return getToken(IPreferenceConstants.PHP_TAG);
 149             } else {
 150               c = scanner.read();
 151               if (c != 'p' && c != 'P') {
 152                 scanner.unread();
 153                 scanner.unread();
 154                 scanner.unread();
 155                 return getToken(IPreferenceConstants.PHP_TAG);
 156               } else {
 157                 return getToken(IPreferenceConstants.PHP_TAG);
 158               }
 159             }
 160           }
 161         }
 162       }
 163       if (c == '?') {
 164                 c = scanner.read();
 165         if (c == '>') {
 166           return getToken(IPreferenceConstants.PHP_TAG);
 167         }
 168         scanner.unread();
 169         scanner.unread();
 170         return Token.UNDEFINED;
 171       }
 172       if (fDetector.isWordStart((char) c)) {
 173         if (c == '$') {
 174           isVariable = true;
 175         }
 176         if (fColumn == UNDEFINED || (fColumn == scanner.getColumn() - 1)) {
 177
 178           fBuffer.setLength(0);
 179           do {
 180             fBuffer.append((char) c);
 181             c = scanner.read();
 182           } while (c != ICharacterScanner.EOF && fDetector.isWordPart((char) c));
 183           scanner.unread();
 184
 185           if (isVariable) {
 186             return getToken(IPreferenceConstants.PHP_VARIABLE);
 187           }
 188           IToken token = (IToken) fWords.get(fBuffer.toString());
 189           if (token != null)
 190             return token;
 191
 192           if (fDefaultToken.isUndefined())
 193             unreadBuffer(scanner);
 194
 195           return fDefaultToken;
 196         }
 197       }
 198
 199       scanner.unread();
 200       return Token.UNDEFINED;
 201     }
 202   }
 203
 204   //private PHPColorProvider fColorProvider;
 205
 206   private static String[] fgTokenProperties =
 207     {
 208       IPreferenceConstants.PHP_MULTILINE_COMMENT,
 209       IPreferenceConstants.PHP_SINGLELINE_COMMENT,
 210           IPreferenceConstants.PHP_TAG,
 211       IPreferenceConstants.PHP_KEYWORD,
 212       IPreferenceConstants.PHP_FUNCTIONNAME,
 213       IPreferenceConstants.PHP_VARIABLE,
 214       IPreferenceConstants.PHP_STRING,
 215       IPreferenceConstants.PHP_TYPE,
 216       IPreferenceConstants.PHP_CONSTANT,
 217       IPreferenceConstants.PHP_DEFAULT,
 218       IPreferenceConstants.PHP_OPERATOR,
 219       IPreferenceConstants.PHP_BRACE_OPERATOR,
 220       IPreferenceConstants.PHP_KEYWORD_RETURN};
 221   /**
 222    * Creates a PHP code scanner
 223    */
 224   // public PHPCodeScanner(JavaColorManager provider, IPreferenceStore store) {
 225   public PHPCodeScanner(IColorManager manager, IPreferenceStore store) {
 226     super(manager, store);
 227     initialize();
 228     //  // final IPreferenceStore store =
 229     // PHPeclipsePlugin.getDefault().getPreferenceStore();
 230     //   Color BackgroundColor =
 231     // provider.getColor(PreferenceConverter.getColor(store,
 232     // PHP_EDITOR_BACKGROUND));
 233     //    variable =
 234     //      new Token(
 235     //        new TextAttribute(
 236     //          provider.getColor(PreferenceConverter.getColor(store, PHP_VARIABLE)),
 237     //          BackgroundColor,
 238     //          (store.getBoolean(PHP_VARIABLE_BOLD) ? SWT.BOLD : SWT.NONE)
 239     //            + (store.getBoolean(PHP_VARIABLE_ITALIC) ? SWT.ITALIC : SWT.NONE)));
 240     //      keyword =
 241     //        new Token(new TextAttribute(
 242     //          provider.getColor(PreferenceConverter.getColor(store, PHP_KEYWORD)),
 243     //          BackgroundColor,
 244     //    //SWT.NONE));
 245     //   (store.getBoolean(PHP_KEYWORD_BOLD) ? SWT.BOLD : SWT.NONE) +
 246     // (store.getBoolean(PHP_KEYWORD_ITALIC) ? SWT.ITALIC : SWT.NONE)));
 247     //      type =
 248     //        new Token(new TextAttribute(
 249     //          provider.getColor(PreferenceConverter.getColor(store, PHP_TYPE)),
 250     //          BackgroundColor,
 251     //    //SWT.NONE));
 252     //   (store.getBoolean(PHP_TYPE_BOLD) ? SWT.BOLD : SWT.NONE) +
 253     // (store.getBoolean(PHP_TYPE_ITALIC) ? SWT.ITALIC : SWT.NONE)));
 254     //      functionName =
 255     //        new Token(new TextAttribute(
 256     //          provider.getColor(PreferenceConverter.getColor(store, PHP_FUNCTIONNAME)),
 257     //          BackgroundColor,
 258     //    //SWT.NONE));
 259     //  (store.getBoolean(PHP_FUNCTIONNAME_BOLD) ? SWT.BOLD : SWT.NONE)
 260     //    + (store.getBoolean(PHP_FUNCTIONNAME_ITALIC) ? SWT.ITALIC : SWT.NONE)));
 261     //      constant =
 262     //        new Token(new TextAttribute(
 263     //          provider.getColor(PreferenceConverter.getColor(store, PHP_CONSTANT)),
 264     //          BackgroundColor,
 265     //    //SWT.NONE));
 266     //   (store.getBoolean(PHP_CONSTANT_BOLD) ? SWT.BOLD : SWT.NONE) +
 267     // (store.getBoolean(PHP_CONSTANT_ITALIC) ? SWT.ITALIC : SWT.NONE)));
 268     //      string =
 269     //        new Token(new TextAttribute(
 270     //          provider.getColor(PreferenceConverter.getColor(store, PHP_STRING)),
 271     //          BackgroundColor,
 272     //    //SWT.NONE));
 273     //   (store.getBoolean(PHP_STRING_BOLD) ? SWT.BOLD : SWT.NONE ) +
 274     // (store.getBoolean(PHP_STRING_ITALIC) ? SWT.ITALIC : SWT.NONE)));
 275     //      comment =
 276     //        new Token(new TextAttribute(
 277     //          provider.getColor(PreferenceConverter.getColor(store,
 278     // PHP_SINGLELINE_COMMENT)),
 279     //          BackgroundColor,
 280     //    //SWT.NONE));
 281     //  (store.getBoolean(PHP_SINGLELINE_COMMENT_BOLD) ? SWT.BOLD : SWT.NONE )
 282     //    + (store.getBoolean(PHP_SINGLELINE_COMMENT_ITALIC) ? SWT.ITALIC :
 283     // SWT.NONE)));
 284     //      multi_comment =
 285     //        new Token(new TextAttribute(
 286     //          provider.getColor(PreferenceConverter.getColor(store,
 287     // PHP_MULTILINE_COMMENT)),
 288     //          BackgroundColor,
 289     //    //SWT.NONE));
 290     //  (store.getBoolean(PHP_MULTILINE_COMMENT_BOLD) ? SWT.BOLD : SWT.NONE)
 291     //    + (store.getBoolean(PHP_MULTILINE_COMMENT_ITALIC) ? SWT.ITALIC :
 292     // SWT.NONE)));
 293     //      other =
 294     //        new Token(new TextAttribute(
 295     //          provider.getColor(PreferenceConverter.getColor(store, PHP_DEFAULT)),
 296     //          BackgroundColor,
 297     //    //SWT.NONE));
 298     //   (store.getBoolean(PHP_DEFAULT_BOLD) ? SWT.BOLD : SWT.NONE) +
 299     // (store.getBoolean(PHP_DEFAULT_ITALIC) ? SWT.ITALIC : SWT.NONE)));
 300     //    updateWordRules();
 301   }
 302
 303   /*
 304    * @see AbstractJavaScanner#getTokenProperties()
 305    */
 306   protected String[] getTokenProperties() {
 307     return fgTokenProperties;
 308   }
 309
 310   /*
 311    * @see AbstractJavaScanner#createRules()
 312    */
 313   protected List createRules() {
 314     List rules = new ArrayList();
 315     Token token = getToken(IPreferenceConstants.PHP_SINGLELINE_COMMENT);
 316     // Add rule for single line comments.
 317     rules.add(new EndOfLineRule("//", token)); //$NON-NLS-1$
 318     rules.add(new EndOfLineRule("#", token)); //$NON-NLS-1$
 319     // Add rule for strings and character constants.
 320     token = getToken(IPreferenceConstants.PHP_STRING);
 321     rules.add(new MultiLineRule("\"", "\"", token, '\\')); //$NON-NLS-2$ //$NON-NLS-1$
 322     rules.add(new MultiLineRule("`", "`", token, '\\')); //$NON-NLS-2$ //$NON-NLS-1$
 323     rules.add(new MultiLineRule("'", "'", token, '\\')); //$NON-NLS-2$ //$NON-NLS-1$
 324
 325     token = getToken(IPreferenceConstants.PHP_MULTILINE_COMMENT);
 326     rules.add(new MultiLineRule("/*", "*/", token)); //$NON-NLS-2$ //$NON-NLS-1$
 327     // Add generic whitespace rule.
 328     rules.add(new WhitespaceRule(new PHPWhitespaceDetector()));
 329     // Add word rule for keywords, types, and constants.
 330     token = getToken(IPreferenceConstants.PHP_DEFAULT);
 331     PHPWordRule wordRule = new PHPWordRule(new PHPWordDetector(), token);
 332
 333     Token keyword = getToken(IPreferenceConstants.PHP_KEYWORD);
 334     Token functionName = getToken(IPreferenceConstants.PHP_FUNCTIONNAME);
 335     Token type = getToken(IPreferenceConstants.PHP_TYPE);
 336     Token constant = getToken(IPreferenceConstants.PHP_CONSTANT);
 337
 338     ArrayList buffer = PHPSyntaxRdr.getSyntaxData();
 339     //  String strbuffer = null; unused
 340     PHPElement elbuffer = null;
 341     String name;
 342     for (int i = 0; i < buffer.size(); i++) {
 343       //    while ((buffer != null)
 344       //      && (!buffer.isEmpty()
 345       //        && ((elbuffer = (PHPElement) buffer.remove(0)) != null))) {
 346       elbuffer = (PHPElement) buffer.get(i);
 347       if (elbuffer instanceof PHPKeyword) {
 348         name = ((PHPKeyword) elbuffer).getName();
 349         if (!name.equals("return")) {
 350           wordRule.addWord(name, keyword);
 351         }
 352       } else if (elbuffer instanceof PHPFunction) {
 353         wordRule.addWord(((PHPFunction) elbuffer).getName(), functionName);
 354       } else if (elbuffer instanceof PHPType) {
 355         wordRule.addWord(elbuffer.getName(), type);
 356       } else if (elbuffer instanceof PHPConstant) {
 357         wordRule.addWord(elbuffer.getName(), constant);
 358       }
 359     }
 360
 361 // Add word rule for keyword 'return'.
 362     token= getToken(IPreferenceConstants.PHP_KEYWORD_RETURN);
 363     wordRule.addWord("return", token);
 364
 365 //  Add rule for operators and brackets (at the end !)
 366         rules.add(new OperatorRule(getToken(IPreferenceConstants.PHP_OPERATOR), getToken(IPreferenceConstants.PHP_BRACE_OPERATOR)));
 367
 368     rules.add(wordRule);
 369
 370     setDefaultReturnToken(getToken(IPreferenceConstants.PHP_DEFAULT));
 371     return rules;
 372   }
 373 }