/
ScalaCodeScanner.scala
420 lines (353 loc) · 12.7 KB
/
ScalaCodeScanner.scala
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
/*
* Copyright 2005-2010 LAMP/EPFL
*/
// $Id$
package scala.tools.eclipse.lexical
import java.{ util => ju }
import org.eclipse.core.runtime.Assert
import org.eclipse.jdt.core.JavaCore
import org.eclipse.jdt.internal.ui.javaeditor.SemanticHighlightings
import org.eclipse.jdt.internal.ui.text.{ AbstractJavaScanner, CombinedWordRule, JavaWhitespaceDetector, JavaWordDetector, ISourceVersionDependent }
import org.eclipse.jdt.ui.PreferenceConstants
import org.eclipse.jdt.ui.text.{ IColorManager, IJavaColorConstants }
import org.eclipse.jface.preference.IPreferenceStore
import org.eclipse.jface.util.PropertyChangeEvent
import org.eclipse.jface.text.rules.{ ICharacterScanner, IRule, IToken, IWhitespaceDetector, IWordDetector, SingleLineRule, Token, WhitespaceRule }
object ScalaCodeScanner {
/**
* Rule to detect Scala operators.
*
* @since 3.0
*/
class OperatorRule(fToken : IToken) extends IRule {
/** Scala operators */
val JAVA_OPERATORS = Array(';', '.', '=', '/', '\\', '+', '-', '*', '<', '>', ':', '?', '!', ',', '|', '&', '^', '%', '~')
/**
* Is this character an operator character?
*
* @param character Character to determine whether it is an operator character
* @return <code>true</code> iff the character is an operator, <code>false</code> otherwise.
*/
def isOperator(character : Char) = JAVA_OPERATORS.contains(character)
/*
* @see org.eclipse.jface.text.rules.IRule#evaluate(org.eclipse.jface.text.rules.ICharacterScanner)
*/
override def evaluate(scanner : ICharacterScanner) : IToken = {
var character : Char = scanner.read.toChar
if (isOperator(character)) {
do {
character = scanner.read.toChar
} while (isOperator(character))
scanner.unread
fToken
} else {
scanner.unread
Token.UNDEFINED
}
}
}
/**
* Rule to detect java brackets.
*
* @since 3.3
*/
class BracketRule(fToken : IToken) extends IRule {
/** Java brackets */
val JAVA_BRACKETS = Array('(', ')', '{', '}', '[', ']')
/**
* Is this character a bracket character?
*
* @param character Character to determine whether it is a bracket character
* @return <code>true</code> iff the character is a bracket, <code>false</code> otherwise.
*/
def isBracket(character : Char) = JAVA_BRACKETS.contains(character)
/*
* @see org.eclipse.jface.text.rules.IRule#evaluate(org.eclipse.jface.text.rules.ICharacterScanner)
*/
override def evaluate(scanner : ICharacterScanner) : IToken = {
var character : Char = scanner.read.toChar
if (isBracket(character)) {
do {
character = scanner.read.toChar
} while (isBracket(character))
scanner.unread
fToken
} else {
scanner.unread
Token.UNDEFINED
}
}
}
class VersionedWordMatcher(fDefaultToken : IToken, fVersion : String, currentVersion : String) extends CombinedWordRule.WordMatcher with ISourceVersionDependent {
private var fIsVersionMatch : Boolean = _
setSourceVersion(currentVersion);
/*
* @see org.eclipse.jdt.internal.ui.text.ISourceVersionDependent#setSourceVersion(java.lang.String)
*/
override def setSourceVersion(version : String) {
fIsVersionMatch = fVersion.compareTo(version) <= 0
}
/*
* @see org.eclipse.jdt.internal.ui.text.CombinedWordRule.WordMatcher#evaluate(org.eclipse.jface.text.rules.ICharacterScanner, org.eclipse.jdt.internal.ui.text.CombinedWordRule.CharacterBuffer)
*/
override def evaluate(scanner : ICharacterScanner, word : CombinedWordRule.CharacterBuffer) : IToken = {
val token = super.evaluate(scanner, word)
if (fIsVersionMatch || token.isUndefined())
token
else
fDefaultToken
}
}
object AnnotationRule {
/**
* A resettable scanner supports marking a position in a scanner and
* unreading back to the marked position.
*/
class ResettableScanner(fDelegate : ICharacterScanner) extends ICharacterScanner {
private var fReadCount : Int = _
mark
def getColumn = fDelegate.getColumn
def getLegalLineDelimiters = fDelegate.getLegalLineDelimiters
def read : Int = {
var ch = fDelegate.read
if (ch != ICharacterScanner.EOF)
fReadCount += 1
ch
}
def unread {
if (fReadCount > 0)
fReadCount -= 1
fDelegate.unread
}
/**
* Marks an offset in the scanned content.
*/
def mark {
fReadCount = 0
}
/**
* Resets the scanner to the marked position.
*/
def reset {
while (fReadCount > 0)
unread
while (fReadCount < 0)
read
}
}
}
/**
* An annotation rule matches the '@' symbol, any following whitespace and
* optionally a following <code>interface</code> keyword.
*
* It does not match if there is a comment between the '@' symbol and
* the identifier. See https://bugs.eclipse.org/bugs/show_bug.cgi?id=82452
*
* @since 3.1
*/
class AnnotationRule(fInterfaceToken : IToken, fAtToken : Token, fVersion : String, currentVersion : String) extends IRule with ISourceVersionDependent {
import AnnotationRule._
private val fWhitespaceDetector= new JavaWhitespaceDetector
private val fWordDetector = new JavaWordDetector
private var fIsVersionMatch : Boolean = _
setSourceVersion(currentVersion)
/*
* @see org.eclipse.jface.text.rules.IRule#evaluate(org.eclipse.jface.text.rules.ICharacterScanner)
*/
def evaluate(scanner : ICharacterScanner) : IToken = {
if (!fIsVersionMatch)
Token.UNDEFINED
else {
val resettable= new ResettableScanner(scanner)
if (resettable.read == '@')
readAnnotation(resettable)
else {
resettable.reset
Token.UNDEFINED;
}
}
}
def readAnnotation(scanner : ResettableScanner) : IToken = {
scanner.mark
skipWhitespace(scanner)
if (readInterface(scanner)) {
fInterfaceToken
} else {
scanner.reset
fAtToken
}
}
def readInterface(scanner : ICharacterScanner) : Boolean = {
var ch = scanner.read.toChar
var i = 0
while (i < INTERFACE.length && INTERFACE.charAt(i) == ch) {
i += 1
ch = scanner.read.toChar
}
if (i < INTERFACE.length)
false
else if (fWordDetector.isWordPart(ch))
false
else {
if (ch != ICharacterScanner.EOF)
scanner.unread
true
}
}
def skipWhitespace(scanner : ICharacterScanner) : Boolean = {
while (fWhitespaceDetector.isWhitespace(scanner.read.toChar)) {
// do nothing
}
scanner.unread
true
}
/*
* @see org.eclipse.jdt.internal.ui.text.ISourceVersionDependent#setSourceVersion(java.lang.String)
*/
def setSourceVersion(version : String) {
fIsVersionMatch = fVersion.compareTo(version) <= 0
}
}
private val SOURCE_VERSION = "2.8.0"
private val fgKeywords = Array(
"abstract",
"case", "catch", "class",
"def", "do",
"else", "extends",
"final", "finally", "for", "forSome",
"if", "implicit", "import",
"lazy",
"match",
"new",
"object", "override",
"package", "private", "protected",
"requires",
"sealed", "super",
"this", "throw", "trait", "try", "type",
"val", "var",
"while", "with",
"yield"
)
private val INTERFACE = "interface"
private val RETURN = "return"
private val fgTypes = Array(
"Unit", "Boolean", "Char", "Byte", "Short", "Int", "Long", "Float", "Double",
"Array", "Any", "AnyRef", "AnyVal", "Nothing", "Null", "NotNull")
private val fgConstants = Array("false", "null", "true")
private val ANNOTATION_BASE_KEY = PreferenceConstants.EDITOR_SEMANTIC_HIGHLIGHTING_PREFIX + SemanticHighlightings.ANNOTATION
private val ANNOTATION_COLOR_KEY= ANNOTATION_BASE_KEY + PreferenceConstants.EDITOR_SEMANTIC_HIGHLIGHTING_COLOR_SUFFIX
private val fgTokenProperties = Array(
IJavaColorConstants.JAVA_KEYWORD,
IJavaColorConstants.JAVA_STRING,
IJavaColorConstants.JAVA_DEFAULT,
IJavaColorConstants.JAVA_KEYWORD_RETURN,
IJavaColorConstants.JAVA_OPERATOR,
IJavaColorConstants.JAVA_BRACKET,
ANNOTATION_COLOR_KEY
)
}
/**
* A Scala code scanner.
*/
class ScalaCodeScanner(manager : IColorManager, store : IPreferenceStore) extends AbstractJavaScanner(manager, store) {
import ScalaCodeScanner._
private def fVersionDependentRules = new ju.ArrayList[IRule with ISourceVersionDependent](3)
initialize
protected def getTokenProperties = fgTokenProperties
protected def createRules : ju.List[IRule] = {
val rules = new ju.ArrayList[IRule]
// Add generic whitespace rule.
rules.add(new WhitespaceRule(new JavaWhitespaceDetector))
val version = getPreferenceStore.getString(SOURCE_VERSION)
// Add JLS3 rule for /@\s*interface/ and /@\s*\w+/
var token = getToken(ANNOTATION_COLOR_KEY)
val atInterfaceRule = new AnnotationRule(getToken(IJavaColorConstants.JAVA_KEYWORD), token, JavaCore.VERSION_1_5, version)
rules.add(atInterfaceRule)
fVersionDependentRules.add(atInterfaceRule)
// Add word rule for new keywords, 4077
val wordDetector = new JavaWordDetector
token = getToken(IJavaColorConstants.JAVA_DEFAULT)
val combinedWordRule = new CombinedWordRule(wordDetector, token)
// Add rule for operators
token = getToken(IJavaColorConstants.JAVA_OPERATOR)
rules.add(new OperatorRule(token))
// Add rule for brackets
token = getToken(IJavaColorConstants.JAVA_BRACKET)
rules.add(new BracketRule(token))
// Must come before keyword rules
rules.add(new BackQuotedIdentRule(getToken(IJavaColorConstants.JAVA_DEFAULT)))
// Add word rule for keyword 'return'.
val returnWordRule = new CombinedWordRule.WordMatcher
token = getToken(IJavaColorConstants.JAVA_KEYWORD_RETURN)
returnWordRule.addWord(RETURN, token)
combinedWordRule.addWordMatcher(returnWordRule)
// Add word rule for keywords, types, and constants.
val wordRule = new CombinedWordRule.WordMatcher
token = getToken(IJavaColorConstants.JAVA_KEYWORD)
for (kwd <- fgKeywords)
wordRule.addWord(kwd, token)
for (typ <- fgTypes)
wordRule.addWord(typ, token)
for (cnst <- fgConstants)
wordRule.addWord(cnst, token)
combinedWordRule.addWordMatcher(wordRule)
rules.add(combinedWordRule)
setDefaultReturnToken(getToken(IJavaColorConstants.JAVA_DEFAULT))
rules
}
/*
* @see org.eclipse.jdt.internal.ui.text.AbstractJavaScanner#getBoldKey(java.lang.String)
*/
override protected def getBoldKey(colorKey : String) : String = {
if (ANNOTATION_COLOR_KEY == colorKey)
ANNOTATION_BASE_KEY + PreferenceConstants.EDITOR_SEMANTIC_HIGHLIGHTING_BOLD_SUFFIX
else
super.getBoldKey(colorKey)
}
/*
* @see org.eclipse.jdt.internal.ui.text.AbstractJavaScanner#getItalicKey(java.lang.String)
*/
override protected def getItalicKey(colorKey : String) : String = {
if (ANNOTATION_COLOR_KEY == colorKey)
ANNOTATION_BASE_KEY + PreferenceConstants.EDITOR_SEMANTIC_HIGHLIGHTING_ITALIC_SUFFIX
else
super.getItalicKey(colorKey)
}
/*
* @see org.eclipse.jdt.internal.ui.text.AbstractJavaScanner#getStrikethroughKey(java.lang.String)
*/
override protected def getStrikethroughKey(colorKey : String) : String = {
if (ANNOTATION_COLOR_KEY == colorKey)
ANNOTATION_BASE_KEY + PreferenceConstants.EDITOR_SEMANTIC_HIGHLIGHTING_STRIKETHROUGH_SUFFIX
else
super.getStrikethroughKey(colorKey)
}
/*
* @see org.eclipse.jdt.internal.ui.text.AbstractJavaScanner#getUnderlineKey(java.lang.String)
*/
override protected def getUnderlineKey(colorKey : String) : String = {
if (ANNOTATION_COLOR_KEY == colorKey)
ANNOTATION_BASE_KEY + PreferenceConstants.EDITOR_SEMANTIC_HIGHLIGHTING_UNDERLINE_SUFFIX
else
super.getUnderlineKey(colorKey)
}
/*
* @see AbstractJavaScanner#affectsBehavior(PropertyChangeEvent)
*/
override def affectsBehavior(event : PropertyChangeEvent) : Boolean =
event.getProperty == SOURCE_VERSION || super.affectsBehavior(event)
/*
* @see AbstractJavaScanner#adaptToPreferenceChange(PropertyChangeEvent)
*/
override def adaptToPreferenceChange(event : PropertyChangeEvent) {
import scala.collection.JavaConversions._
if (event.getProperty == SOURCE_VERSION) {
event.getNewValue match {
case s : String =>
for (dependent <- fVersionDependentRules)
dependent.setSourceVersion(s)
}
} else if (super.affectsBehavior(event))
super.adaptToPreferenceChange(event)
}
}