Merged the 3.1 compatibility patches from the eclipse3_1compat branch into the HEAD.
[phpeclipse.git] / 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  www.phpeclipse.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.ICharacterScanner;
26 import org.eclipse.jface.text.rules.IRule;
27 import org.eclipse.jface.text.rules.IToken;
28 import org.eclipse.jface.text.rules.IWordDetector;
29 import org.eclipse.jface.text.rules.MultiLineRule;
30 import org.eclipse.jface.text.rules.Token;
31 import org.eclipse.jface.text.rules.WhitespaceRule;
32 import org.eclipse.jface.text.rules.WordRule;
33
34 /**
35  * PHP Code Scanner
36  */
37 public class PHPCodeScanner extends AbstractJavaScanner {
38
39   /**
40    * Rule to detect java operators.
41    * 
42    * @since 3.0
43    */
44   protected class OperatorRule implements IRule {
45
46     /** Java operators */
47     private final char[] PHP_OPERATORS = {
48         ';',
49         '(',
50         ')',
51         '.',
52         '=',
53         '/',
54         '\\',
55         '+',
56         '-',
57         '*',
58         '[',
59         ']',
60         '<',
61         '>',
62         ':',
63         '?',
64         '!',
65         ',',
66         '|',
67         '&',
68         '^',
69         '%',
70         '~',
71         '@' };
72
73     /** Token to return for this rule */
74     private final IToken fToken;
75
76     /** Token to return for braces */
77     private final IToken fTokenBraces;
78
79     /**
80      * Creates a new operator rule.
81      * 
82      * @param token
83      *          Token to use for this rule
84      */
85     public OperatorRule(IToken token, IToken tokenBraces) {
86       fToken = token;
87       fTokenBraces = tokenBraces;
88
89     }
90
91     /**
92      * Is this character an operator character?
93      * 
94      * @param character
95      *          Character to determine whether it is an operator character
96      * @return <code>true</code> iff the character is an operator, <code>false</code> otherwise.
97      */
98     public boolean isOperator(char character) {
99       for (int index = 0; index < PHP_OPERATORS.length; index++) {
100         if (PHP_OPERATORS[index] == character)
101           return true;
102       }
103       return false;
104     }
105
106     /*
107      * @see org.eclipse.jface.text.rules.IRule#evaluate(org.eclipse.jface.text.rules.ICharacterScanner)
108      */
109     public IToken evaluate(ICharacterScanner scanner) {
110
111       int character = scanner.read();
112       if (character == '{' || character == '}') {
113         return fTokenBraces;
114       }
115       if (isOperator((char) character)) {
116         int lastCharacter = character;
117         character = scanner.read();
118         if (!isOperator((char) character)) {
119           scanner.unread();
120           return fToken;
121         }
122         if (checkPHPTag(scanner, lastCharacter, character)) {
123           return Token.UNDEFINED;
124         }
125         do {
126           lastCharacter = character;
127           character = scanner.read();
128           if (checkPHPTag(scanner, lastCharacter, character)) {
129             return fToken;
130           }
131         } while (isOperator((char) character));
132         scanner.unread();
133         return fToken;
134       } else {
135         scanner.unread();
136         return Token.UNDEFINED;
137       }
138     }
139
140     /**
141      * Check if lastCharacter/character are a PHP start or end token ( &lt;? ... ?&gt; )
142      * 
143      * @param scanner
144      * @param lastCharacter
145      * @param character
146      * @return
147      */
148     private boolean checkPHPTag(ICharacterScanner scanner, int lastCharacter, int character) {
149       if (lastCharacter == '<' && character == '?') {
150         scanner.unread();
151         scanner.unread();
152         return true;
153       } else if (lastCharacter == '?' && character == '>') {
154         scanner.unread();
155         scanner.unread();
156         return true;
157       }
158       return false;
159     }
160   }
161
162
163   protected class AccentStringRule implements IRule {
164
165     /** Token to return for this rule */
166     private final IToken fToken;
167
168     public AccentStringRule(IToken token) {
169       fToken = token;
170
171     }
172
173     /*
174      * @see org.eclipse.jface.text.rules.IRule#evaluate(org.eclipse.jface.text.rules.ICharacterScanner)
175      */
176     public IToken evaluate(ICharacterScanner scanner) {
177
178       int character = scanner.read();
179
180       if (character == '`') {
181
182         while (true) {
183           character = scanner.read();
184           if (character == '\\') {
185             character = scanner.read();
186           } else if (character == '`') {
187             return fToken;
188           }
189         }
190
191       } else {
192         scanner.unread();
193         return Token.UNDEFINED;
194       }
195     }
196
197   }
198
199   private class PHPWordRule extends WordRule {
200     private StringBuffer fBuffer = new StringBuffer();
201
202     public PHPWordRule(IWordDetector detector) {
203       super(detector, Token.UNDEFINED);
204     }
205
206     public PHPWordRule(IWordDetector detector, IToken defaultToken) {
207       super(detector, defaultToken);
208     }
209
210     public IToken evaluate(ICharacterScanner scanner) {
211       int c = scanner.read();
212       boolean isVariable = false;
213       if (c == '<') {
214         c = scanner.read();
215         if (c != '?') {
216           scanner.unread();
217           scanner.unread();
218           return Token.UNDEFINED;
219         } else {
220           c = scanner.read();
221           if (c == '=') { // <?=
222             return getToken(IPreferenceConstants.PHP_TAG);
223           }
224           if (c != 'p' && c != 'P') {
225             scanner.unread();
226             return getToken(IPreferenceConstants.PHP_TAG);
227           } else {
228             c = scanner.read();
229             if (c != 'h' && c != 'H') {
230               scanner.unread();
231               scanner.unread();
232               return getToken(IPreferenceConstants.PHP_TAG);
233             } else {
234               c = scanner.read();
235               if (c != 'p' && c != 'P') {
236                 scanner.unread();
237                 scanner.unread();
238                 scanner.unread();
239                 return getToken(IPreferenceConstants.PHP_TAG);
240               } else {
241                 return getToken(IPreferenceConstants.PHP_TAG);
242               }
243             }
244           }
245         }
246       }
247       if (c == '?') {
248         c = scanner.read();
249         if (c == '>') {
250           return getToken(IPreferenceConstants.PHP_TAG);
251         }
252         scanner.unread();
253         scanner.unread();
254         return Token.UNDEFINED;
255       }
256       if (fDetector.isWordStart((char) c)) {
257         if (c == '$') {
258           isVariable = true;
259         }
260         if (fColumn == UNDEFINED || (fColumn == scanner.getColumn() - 1)) {
261
262           fBuffer.setLength(0);
263           do {
264             fBuffer.append((char) c);
265             c = scanner.read();
266           } while (c != ICharacterScanner.EOF && fDetector.isWordPart((char) c));
267           scanner.unread();
268
269           if (isVariable) {
270             return getToken(IPreferenceConstants.PHP_VARIABLE);
271           }
272           IToken token = (IToken) fWords.get(fBuffer.toString());
273           if (token != null)
274             return token;
275
276           if (fDefaultToken.isUndefined())
277             unreadBuffer(scanner);
278
279           return fDefaultToken;
280         }
281       }
282
283       scanner.unread();
284       return Token.UNDEFINED;
285     }
286   }
287
288   //private PHPColorProvider fColorProvider;
289
290   private static String[] fgTokenProperties = {
291       IPreferenceConstants.PHP_MULTILINE_COMMENT,
292       IPreferenceConstants.PHP_SINGLELINE_COMMENT,
293       IPreferenceConstants.PHP_TAG,
294       IPreferenceConstants.PHP_KEYWORD,
295       IPreferenceConstants.PHP_FUNCTIONNAME,
296       IPreferenceConstants.PHP_VARIABLE,
297       IPreferenceConstants.PHP_STRING_DQ,
298       IPreferenceConstants.PHP_STRING_SQ,
299       IPreferenceConstants.PHP_TYPE,
300       IPreferenceConstants.PHP_CONSTANT,
301       IPreferenceConstants.PHP_DEFAULT,
302       IPreferenceConstants.PHP_OPERATOR,
303       IPreferenceConstants.PHP_BRACE_OPERATOR,
304       IPreferenceConstants.PHP_KEYWORD_RETURN };
305
306   /**
307    * Creates a PHP code scanner
308    */
309   // public PHPCodeScanner(JavaColorManager provider, IPreferenceStore store) {
310   public PHPCodeScanner(IColorManager manager, IPreferenceStore store) {
311     super(manager, store);
312     initialize();
313   }
314
315   /*
316    * @see AbstractJavaScanner#getTokenProperties()
317    */
318   protected String[] getTokenProperties() {
319     return fgTokenProperties;
320   }
321
322   /*
323    * @see AbstractJavaScanner#createRules()
324    */
325   protected List createRules() {
326     List rules = new ArrayList();
327     Token token = getToken(IPreferenceConstants.PHP_SINGLELINE_COMMENT);
328     // Add rule for single line comments.
329     //    rules.add(new EndOfLineRule("//", token)); //$NON-NLS-1$
330     //    rules.add(new EndOfLineRule("#", token)); //$NON-NLS-1$
331     // Add rule for strings and character constants.
332     //    token = getToken(IPreferenceConstants.PHP_STRING_SQ);
333     //    rules.add(new SingleQuoteStringRule(token));
334     //    token = getToken(IPreferenceConstants.PHP_STRING_DQ);
335     //    rules.add(new DoubleQuoteStringRule(token));
336     rules.add(new AccentStringRule(token));
337
338     token = getToken(IPreferenceConstants.PHP_MULTILINE_COMMENT);
339     rules.add(new MultiLineRule("/*", "*/", token)); //$NON-NLS-2$ //$NON-NLS-1$
340     // Add generic whitespace rule.
341     rules.add(new WhitespaceRule(new PHPWhitespaceDetector()));
342     // Add word rule for keywords, types, and constants.
343     token = getToken(IPreferenceConstants.PHP_DEFAULT);
344     PHPWordRule wordRule = new PHPWordRule(new PHPWordDetector(), token);
345
346     Token keyword = getToken(IPreferenceConstants.PHP_KEYWORD);
347     Token functionName = getToken(IPreferenceConstants.PHP_FUNCTIONNAME);
348     Token type = getToken(IPreferenceConstants.PHP_TYPE);
349     Token constant = getToken(IPreferenceConstants.PHP_CONSTANT);
350
351     ArrayList buffer = PHPSyntaxRdr.getSyntaxData();
352     //  String strbuffer = null; unused
353     PHPElement elbuffer = null;
354     String name;
355     for (int i = 0; i < buffer.size(); i++) {
356       //    while ((buffer != null)
357       //      && (!buffer.isEmpty()
358       //        && ((elbuffer = (PHPElement) buffer.remove(0)) != null))) {
359       elbuffer = (PHPElement) buffer.get(i);
360       if (elbuffer instanceof PHPKeyword) {
361         name = ((PHPKeyword) elbuffer).getName();
362         if (!name.equals("return")) {
363           wordRule.addWord(name, keyword);
364         }
365       } else if (elbuffer instanceof PHPFunction) {
366         wordRule.addWord(((PHPFunction) elbuffer).getName(), functionName);
367       } else if (elbuffer instanceof PHPType) {
368         wordRule.addWord(elbuffer.getName(), type);
369       } else if (elbuffer instanceof PHPConstant) {
370         wordRule.addWord(elbuffer.getName(), constant);
371       }
372     }
373
374     // Add word rule for keyword 'return'.
375     token = getToken(IPreferenceConstants.PHP_KEYWORD_RETURN);
376     wordRule.addWord("return", token);
377
378     //  Add rule for operators and brackets (at the end !)
379     rules.add(new OperatorRule(getToken(IPreferenceConstants.PHP_OPERATOR), getToken(IPreferenceConstants.PHP_BRACE_OPERATOR)));
380
381     rules.add(wordRule);
382
383     setDefaultReturnToken(getToken(IPreferenceConstants.PHP_DEFAULT));
384     return rules;
385   }
386 }