added docs for some functions
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / php / HTMLCodeScanner.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.phpeclipse.phpeditor.util.HTMLWordDetector;
18 import net.sourceforge.phpeclipse.phpeditor.util.PHPColorProvider;
19 import net.sourceforge.phpeclipse.phpeditor.util.PHPWhitespaceDetector;
20
21 import org.eclipse.jface.text.TextAttribute;
22 import org.eclipse.jface.text.rules.ICharacterScanner;
23 import org.eclipse.jface.text.rules.IRule;
24 import org.eclipse.jface.text.rules.IToken;
25 import org.eclipse.jface.text.rules.IWordDetector;
26 import org.eclipse.jface.text.rules.RuleBasedScanner;
27 import org.eclipse.jface.text.rules.SingleLineRule;
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  * A HTML code scanner.
34  */
35 public class HTMLCodeScanner extends RuleBasedScanner {
36
37   private static String[] fgKeywords = {
38   };
39
40   private static String[] fgTypes = {
41   };
42
43   private IToken keyword;
44
45   private class HTMLWordRule extends WordRule {
46     private StringBuffer fBuffer = new StringBuffer();
47
48     public HTMLWordRule(IWordDetector detector) {
49       super(detector, Token.UNDEFINED);
50     }
51
52     public HTMLWordRule(IWordDetector detector, IToken defaultToken) {
53       super(detector, defaultToken);
54     }
55
56     public IToken evaluate(ICharacterScanner scanner) {
57       int c = scanner.read();
58       boolean tagBegin = false;
59       if (fDetector.isWordStart((char) c)) {
60         if (c == '<') {
61           tagBegin = true;
62         }
63         if (fColumn == UNDEFINED || (fColumn == scanner.getColumn() - 1)) {
64
65           fBuffer.setLength(0);
66           do {
67             fBuffer.append((char) c);
68             c = scanner.read();
69             if (c == '>') {
70               fBuffer.append((char) c);
71               c = scanner.read();
72               break;
73             }
74             if (c == '/' && (fBuffer.length() > 2) ) {
75               break;
76             }
77           } while (c != ICharacterScanner.EOF && fDetector.isWordPart((char) c));
78           scanner.unread();
79
80           if (tagBegin) {
81             return keyword;
82           }
83           IToken token = (IToken) fWords.get(fBuffer.toString());
84           if (token != null)
85             return token;
86
87           if (fDefaultToken.isUndefined())
88             unreadBuffer(scanner);
89
90           return fDefaultToken;
91         }
92       }
93
94       scanner.unread();
95       return Token.UNDEFINED;
96     }
97
98   }
99
100   //private static String[] fgConstants = { "__LINE__", "__FILE__", "true", "false" };
101   private TextAttribute fComment;
102   private TextAttribute fKeyword;
103   private TextAttribute fType;
104   private TextAttribute fString;
105   private PHPColorProvider fColorProvider;
106
107   /**
108    * Creates a Java code scanner
109    */
110   public HTMLCodeScanner(PHPColorProvider provider) {
111
112     keyword = new Token(new TextAttribute(provider.getColor(PHPColorProvider.KEYWORD)));
113     IToken type = new Token(new TextAttribute(provider.getColor(PHPColorProvider.FUNCTION_NAME)));
114     IToken string = new Token(new TextAttribute(provider.getColor(PHPColorProvider.STRING)));
115     IToken comment = new Token(new TextAttribute(provider.getColor(PHPColorProvider.SINGLE_LINE_COMMENT)));
116     IToken multi_comment = new Token(new TextAttribute(provider.getColor(PHPColorProvider.MULTI_LINE_COMMENT)));
117     IToken other = new Token(new TextAttribute(provider.getColor(PHPColorProvider.DEFAULT)));
118
119     //variable = new Token(new TextAttribute(provider.getColor(PHPColorProvider.VARIABLE)));
120
121     List rules = new ArrayList();
122
123     // Add rule for single line comments.
124     //rules.add(new EndOfLineRule("//", comment)); //$NON-NLS-1$
125     //rules.add(new EndOfLineRule("#", comment));
126
127     // Add rule for strings and character constants.
128     rules.add(new SingleLineRule("\"", "\"", string)); //$NON-NLS-2$ //$NON-NLS-1$
129     // rules.add(new SingleLineRule("'", "'", string, '\\')); //$NON-NLS-2$ //$NON-NLS-1$
130
131     // rules.add(new SingleLineRule("//", "//", php_comment));
132     // rules.add(new MultiLineRule("/*", "*/", multi_comment));
133
134     // Add generic whitespace rule.
135     rules.add(new WhitespaceRule(new PHPWhitespaceDetector()));
136
137     // Add word rule for keywords, types, and constants.
138     HTMLWordRule wordRule = new HTMLWordRule(new HTMLWordDetector(), other);
139     for (int i = 0; i < fgKeywords.length; i++)
140       wordRule.addWord(fgKeywords[i], keyword);
141     for (int i = 0; i < fgTypes.length; i++)
142       wordRule.addWord(fgTypes[i], type);
143     //   for (int i = 0; i < fgConstants.length; i++)
144     //     wordRule.addWord(fgConstants[i], type);
145     rules.add(wordRule);
146
147     IRule[] result = new IRule[rules.size()];
148     rules.toArray(result);
149     setRules(result);
150   }
151
152 }