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
9 IBM Corporation - Initial implementation
10 **********************************************************************/
11 package net.sourceforge.phpeclipse.phpeditor.php;
13 import java.util.ArrayList;
14 import java.util.List;
16 import net.sourceforge.phpdt.internal.ui.text.AbstractJavaScanner;
17 import net.sourceforge.phpdt.ui.text.IColorManager;
18 import net.sourceforge.phpeclipse.IPreferenceConstants;
19 import net.sourceforge.phpeclipse.phpeditor.util.PHPWhitespaceDetector;
21 import org.eclipse.jface.preference.IPreferenceStore;
22 import org.eclipse.jface.text.BadLocationException;
23 import org.eclipse.jface.text.IDocument;
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.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;
33 * A rule based SmartyDoc scanner.
35 public final class SmartyDocCodeScanner extends AbstractJavaScanner {
38 * A key word detector.
40 static class JavaDocKeywordDetector implements IWordDetector {
43 * @see IWordDetector#isWordStart
45 public boolean isWordStart(char c) {
50 * @see IWordDetector#isWordPart
52 public boolean isWordPart(char c) {
53 return Character.isLetter(c);
58 * Detector for HTML comment delimiters.
60 static class HTMLCommentDetector implements IWordDetector {
63 * @see IWordDetector#isWordStart
65 public boolean isWordStart(char c) {
66 return (c == '<' || c == '-');
70 * @see IWordDetector#isWordPart
72 public boolean isWordPart(char c) {
73 return (c == '-' || c == '!' || c == '>');
77 class TagRule extends SingleLineRule {
82 public TagRule(IToken token) {
83 super("<", ">", token, (char) 0); //$NON-NLS-2$ //$NON-NLS-1$
89 public TagRule(IToken token, char escapeCharacter) {
90 super("<", ">", token, escapeCharacter); //$NON-NLS-2$ //$NON-NLS-1$
93 private IToken checkForWhitespace(ICharacterScanner scanner) {
97 char c = getDocument().getChar(getTokenOffset() + 1);
98 if (!Character.isWhitespace(c))
101 } catch (BadLocationException x) {
104 return Token.UNDEFINED;
108 * @see PatternRule#evaluate(ICharacterScanner)
110 public IToken evaluate(ICharacterScanner scanner) {
111 IToken result = super.evaluate(scanner);
112 if (result == fToken)
113 return checkForWhitespace(scanner);
118 private static String[] fgKeywords = {
119 "@author", "@deprecated", "@exception", "@link", "@param", "@return", "@see", "@since", "@throws", "@value", "@version", "@license", "@abstract", "@access", "@category",
120 "@copyright", "@example", "@final", "@filesource", "@global", "@ignore", "@internal", "@link", "@method", "@name", "@package", "@param", "@property", "@static",
121 "@staticvar", "@subpackage", "@todo", "@tutorial", "@uses", "@var","@id", "inheritdoc", "@property-read", "@property-write", "@source" }; //$NON-NLS-12$ //$NON-NLS-11$ //$NON-NLS-10$ //$NON-NLS-7$ //$NON-NLS-9$ //$NON-NLS-8$ //$NON-NLS-6$ //$NON-NLS-5$ //$NON-NLS-4$ //$NON-NLS-3$ //$NON-NLS-2$ //$NON-NLS-1$
123 private static String[] fgTokenProperties = {
124 IPreferenceConstants.PHPDOC_KEYWORD,
125 IPreferenceConstants.PHPDOC_TAG, IPreferenceConstants.PHPDOC_LINK,
126 IPreferenceConstants.PHPDOC_DEFAULT };
128 public SmartyDocCodeScanner(IColorManager manager, IPreferenceStore store) {
129 super(manager, store);
133 public IDocument getDocument() {
138 * @see AbstractJavaScanner#getTokenProperties()
140 protected String[] getTokenProperties() {
141 return fgTokenProperties;
145 * @see AbstractJavaScanner#createRules()
147 protected List createRules() {
149 List list = new ArrayList();
151 // Add rule for tags.
152 Token token = getToken(IPreferenceConstants.PHPDOC_TAG);
153 list.add(new TagRule(token));
155 // Add rule for HTML comments
156 WordRule wordRule = new WordRule(new HTMLCommentDetector(), token);
157 wordRule.addWord("<!--", token); //$NON-NLS-1$
158 wordRule.addWord("--!>", token); //$NON-NLS-1$
161 // Add rule for links.
162 token = getToken(IPreferenceConstants.PHPDOC_LINK);
163 list.add(new SingleLineRule("{@link", "}", token)); //$NON-NLS-2$ //$NON-NLS-1$
165 // Add generic whitespace rule.
166 list.add(new WhitespaceRule(new PHPWhitespaceDetector()));
168 // Add word rule for keywords.
169 token = getToken(IPreferenceConstants.PHPDOC_DEFAULT);
170 wordRule = new WordRule(new JavaDocKeywordDetector(), token);
172 token = getToken(IPreferenceConstants.PHPDOC_KEYWORD);
173 for (int i = 0; i < fgKeywords.length; i++)
174 wordRule.addWord(fgKeywords[i], token);
177 setDefaultReturnToken(getToken(IPreferenceConstants.PHPDOC_DEFAULT));