1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/*******************************************************************************
* Copyright (c) 2008, 2012 Symbian Software Systems and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Andrew Ferguson (Symbian) - Initial implementation
*******************************************************************************/
package org.eclipse.cdt.ui.text.doctools.generic;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.cdt.internal.ui.text.TaskTagRule;
import org.eclipse.cdt.ui.PreferenceConstants;
import org.eclipse.cdt.ui.text.ICTokenScanner;
import org.eclipse.cdt.ui.text.ITokenStore;
import org.eclipse.cdt.ui.text.ITokenStoreFactory;
import org.eclipse.core.runtime.Assert;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.text.rules.BufferedRuleBasedScanner;
import org.eclipse.jface.text.rules.IRule;
import org.eclipse.jface.text.rules.IToken;
import org.eclipse.jface.text.rules.IWordDetector;
import org.eclipse.jface.text.rules.WordRule;
import org.eclipse.jface.util.PropertyChangeEvent;
/**
* ICTokenScanner which recognizes a specified set of tags, starting with a specified name.
* It is assumed this will be used within a single-line or multi-line comment context.
* @since 5.0
* @noextend This class is not intended to be subclassed by clients.
*/
public class GenericTagCommentScanner extends BufferedRuleBasedScanner implements ICTokenScanner {
protected TaskTagRule fTaskTagRule;
protected IPreferenceStore fCorePreferenceStore;
protected String fDefaultTokenProperty;
protected String fTagToken;
protected GenericDocTag[] fTags;
protected char[] fTagMarkers;
protected ITokenStore fTokenStore;
/**
* @param tags the tags to be recognized and highlighted by this scanner
* @param tagMarkers the character prefixes that denote the start of a tag
* @param tokenStoreFactory the token store factory used to store tokens
* @param docToken the token id associated with the enclosing comment
* @param tagToken the token id associated with highlighting any recognized tags
*/
public GenericTagCommentScanner(GenericDocTag[] tags, char[] tagMarkers, ITokenStoreFactory tokenStoreFactory,
String docToken, String tagToken) {
Assert.isNotNull(tags);
Assert.isNotNull(tagMarkers);
fTags = tags;
fTagMarkers = tagMarkers;
fTagToken = tagToken;
fTokenStore = tokenStoreFactory.createTokenStore(mkArray(docToken, tagToken));
fDefaultTokenProperty = docToken;
setRules(createRules());
}
/*
* @see org.eclipse.jface.text.rules.RuleBasedScanner#nextToken()
*/
@Override
public IToken nextToken() {
fTokenStore.ensureTokensInitialised();
return super.nextToken();
}
/**
* @return the rules to use in this scanner
*/
protected IRule[] createRules() {
List<IRule> result = new ArrayList<IRule>();
class TagDetector implements IWordDetector {
@Override
public boolean isWordStart(char c) {
for (int i = 0; i < fTagMarkers.length; i++)
if (fTagMarkers[i] == c)
return true;
return false;
}
@Override
public boolean isWordPart(char c) {
return c == '.' || Character.isJavaIdentifierPart(c);
}
}
setDefaultReturnToken(fTokenStore.getToken(fDefaultTokenProperty));
WordRule wr = new WordRule(new TagDetector(), fDefaultReturnToken);
for (int i = 0; i < fTags.length; i++) {
String wd = fTags[i].getTagName();
for (int j = 0; j < fTagMarkers.length; j++) {
wr.addWord(fTagMarkers[j] + wd, fTokenStore.getToken(fTagToken));
}
}
result.add(wr);
// Add rule for Task Tags.
fTaskTagRule = new TaskTagRule(fTokenStore.getToken(PreferenceConstants.EDITOR_TASK_TAG_COLOR),
fDefaultReturnToken, fTokenStore.getPreferenceStore(), fCorePreferenceStore);
result.add(fTaskTagRule);
return result.toArray(new IRule[result.size()]);
}
/*
* @see org.eclipse.cdt.internal.ui.text.AbstractJavaScanner#affectsBehavior(org.eclipse.jface.util.PropertyChangeEvent)
*/
@Override
public boolean affectsBehavior(PropertyChangeEvent event) {
return fTaskTagRule.affectsBehavior(event) || fTokenStore.affectsBehavior(event);
}
/*
* @see org.eclipse.cdt.internal.ui.text.AbstractJavaScanner#adaptToPreferenceChange(org.eclipse.jface.util.PropertyChangeEvent)
*/
@Override
public void adaptToPreferenceChange(PropertyChangeEvent event) {
if (fTokenStore.affectsBehavior(event)) {
fTokenStore.adaptToPreferenceChange(event);
}
fTaskTagRule.adaptToPreferenceChange(event);
}
private static String[] mkArray(String defaultTokenProperty, String tagToken) {
return new String[] { defaultTokenProperty, tagToken, PreferenceConstants.EDITOR_TASK_TAG_COLOR };
}
}
|
