Added syntax highlighting for variables in double quoted strings
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / php / SmartyCodeScanner.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.util.PHPWhitespaceDetector;
21 import net.sourceforge.phpeclipse.phpeditor.util.PHPWordDetector;
22
23 import org.eclipse.jface.preference.IPreferenceStore;
24 import org.eclipse.jface.text.rules.ICharacterScanner;
25 import org.eclipse.jface.text.rules.IToken;
26 import org.eclipse.jface.text.rules.IWordDetector;
27 import org.eclipse.jface.text.rules.MultiLineRule;
28 import org.eclipse.jface.text.rules.Token;
29 import org.eclipse.jface.text.rules.WhitespaceRule;
30 import org.eclipse.jface.text.rules.WordRule;
31
32 /**
33  * PHP Code Scanner
34  */
35 public class SmartyCodeScanner extends AbstractJavaScanner {
36   public static String[] SMARTY_KEYWORDS =
37     {
38       "capture",
39       "config_load",
40       "else",
41       "elseif",
42       "foreach",
43       "foreachelse",
44       "if",
45       "include",
46       "insert",
47       "ldelim",
48       "literal",
49       "php",
50       "rdelim",
51       "section",
52       "sectionelse",
53       "strip" };
54   public static String[] SMARTY_FUNCTION_NAMES =
55     {
56       "assign",
57       "counter",
58       "cycle",
59       "debug",
60       "eval",
61       "fetch",
62       "html_checkboxes",
63       "html_image",
64       "html_options",
65       "html_radios",
66       "html_select_date",
67       "html_select_time",
68       "html_table",
69       "math",
70       "popup",
71       "popup_init",
72       "textformat" };
73   private class SmartyWordRule extends WordRule {
74     private StringBuffer fBuffer = new StringBuffer();
75
76     public SmartyWordRule(IWordDetector detector) {
77       super(detector, Token.UNDEFINED);
78     }
79
80     public SmartyWordRule(IWordDetector detector, IToken defaultToken) {
81       super(detector, defaultToken);
82     }
83
84     public IToken evaluate(ICharacterScanner scanner) {
85       int c = scanner.read();
86       boolean isVariable = false;
87       if (c == '{') {
88         c = scanner.read();
89         if (c != '/') {
90           scanner.unread();
91         }
92         return getToken(IPreferenceConstants.PHP_TAG);
93       }
94       if (c == '}') {
95         return getToken(IPreferenceConstants.PHP_TAG);
96       }
97       if (fDetector.isWordStart((char) c)) {
98         if (c == '$') {
99           isVariable = true;
100         }
101         if (fColumn == UNDEFINED || (fColumn == scanner.getColumn() - 1)) {
102
103           fBuffer.setLength(0);
104           do {
105             fBuffer.append((char) c);
106             c = scanner.read();
107           } while (c != ICharacterScanner.EOF && fDetector.isWordPart((char) c));
108           scanner.unread();
109
110           if (isVariable) {
111             return getToken(IPreferenceConstants.PHP_VARIABLE);
112           }
113           IToken token = (IToken) fWords.get(fBuffer.toString());
114           if (token != null)
115             return token;
116
117           if (fDefaultToken.isUndefined())
118             unreadBuffer(scanner);
119
120           return fDefaultToken;
121         }
122       }
123
124       scanner.unread();
125       return Token.UNDEFINED;
126     }
127   }
128
129   private static String[] fgTokenProperties =
130     {
131       IPreferenceConstants.PHP_MULTILINE_COMMENT,
132       IPreferenceConstants.PHP_SINGLELINE_COMMENT,
133           IPreferenceConstants.PHP_TAG,
134       IPreferenceConstants.PHP_KEYWORD,
135       IPreferenceConstants.PHP_FUNCTIONNAME,
136       IPreferenceConstants.PHP_VARIABLE,
137       IPreferenceConstants.PHP_STRING_DQ,
138       IPreferenceConstants.PHP_STRING_SQ,
139       IPreferenceConstants.PHP_TYPE,
140       IPreferenceConstants.PHP_CONSTANT,
141       IPreferenceConstants.PHP_DEFAULT };
142   /**
143         * Creates a PHP code scanner
144         */
145   // public PHPCodeScanner(JavaColorManager provider, IPreferenceStore store) {
146   public SmartyCodeScanner(IColorManager manager, IPreferenceStore store) {
147     super(manager, store);
148     initialize();
149   }
150
151   /*
152    * @see AbstractJavaScanner#getTokenProperties()
153    */
154   protected String[] getTokenProperties() {
155     return fgTokenProperties;
156   }
157   /*
158    * @see AbstractJavaScanner#createRules()
159    */
160   protected List createRules() {
161     List rules = new ArrayList();
162     // Add rule for strings and character constants.
163     Token token = getToken(IPreferenceConstants.PHP_STRING_DQ);
164     rules.add(new MultiLineRule("\"", "\"", token, '\\')); //$NON-NLS-2$ //$NON-NLS-1$
165
166     // Add generic whitespace rule.
167     rules.add(new WhitespaceRule(new PHPWhitespaceDetector()));
168     // Add word rule for keywords, types, and constants.
169     token = getToken(IPreferenceConstants.PHP_DEFAULT);
170
171     SmartyWordRule wordRule = new SmartyWordRule(new PHPWordDetector(), token);
172
173     Token keyword = getToken(IPreferenceConstants.PHP_KEYWORD);
174     Token functionName = getToken(IPreferenceConstants.PHP_FUNCTIONNAME);
175 //    Token type = getToken(IPreferenceConstants.PHP_TYPE);
176 //    Token constant = getToken(IPreferenceConstants.PHP_CONSTANT);
177
178     
179     for (int i = 0; i < SMARTY_KEYWORDS.length; i++) {
180       wordRule.addWord(SMARTY_KEYWORDS[i], keyword);
181     }
182
183     for (int i = 0; i < SMARTY_FUNCTION_NAMES.length; i++) {
184       wordRule.addWord(SMARTY_FUNCTION_NAMES[i], functionName);
185     }
186     
187 //      ArrayList buffer = PHPSyntaxRdr.getSyntaxData();
188 //    PHPElement elbuffer = null;
189 //    for (int i = 0; i < buffer.size(); i++) {
190 //
191 //      elbuffer = (PHPElement) buffer.get(i);
192 //      if (elbuffer instanceof PHPKeyword)
193 //        wordRule.addWord(((PHPKeyword) elbuffer).getName(), keyword);
194 //      //      if (elbuffer instanceof PHPFunction)
195 //      //        wordRule.addWord(((PHPFunction) elbuffer).getName(), functionName);
196 //      if (elbuffer instanceof PHPType)
197 //        wordRule.addWord(elbuffer.getName(), type);
198 //      if (elbuffer instanceof PHPConstant)
199 //        wordRule.addWord(elbuffer.getName(), constant);
200 //    }
201     rules.add(wordRule);
202     setDefaultReturnToken(getToken(IPreferenceConstants.PHP_DEFAULT));
203     return rules;
204   }
205 }