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
|
/*******************************************************************************
* Copyright (c) 2006, 2015 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.text.source;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.source.projection.AnnotationBag;
/**
* Standard implementation of {@link org.eclipse.jface.text.source.IAnnotationHover}.
*
* @since 3.2
*/
public class DefaultAnnotationHover implements IAnnotationHover {
/**
* Tells whether the line number should be shown when no annotation is found
* under the cursor.
*
* @since 3.4
*/
private boolean fShowLineNumber;
/**
* Creates a new default annotation hover.
*
* @since 3.4
*/
public DefaultAnnotationHover() {
this(false);
}
/**
* Creates a new default annotation hover.
*
* @param showLineNumber <code>true</code> if the line number should be shown when no annotation is found
* @since 3.4
*/
public DefaultAnnotationHover(boolean showLineNumber) {
fShowLineNumber= showLineNumber;
}
@Override
public String getHoverInfo(ISourceViewer sourceViewer, int lineNumber) {
List<Annotation> javaAnnotations= getAnnotationsForLine(sourceViewer, lineNumber);
if (javaAnnotations != null) {
if (javaAnnotations.size() == 1) {
// optimization
Annotation annotation= javaAnnotations.get(0);
String message= annotation.getText();
if (message != null && message.trim().length() > 0)
return formatSingleMessage(message);
} else {
List<String> messages= new ArrayList<>();
Iterator<Annotation> e= javaAnnotations.iterator();
while (e.hasNext()) {
Annotation annotation= e.next();
String message= annotation.getText();
if (message != null && message.trim().length() > 0)
messages.add(message.trim());
}
if (messages.size() == 1)
return formatSingleMessage(messages.get(0));
if (messages.size() > 1)
return formatMultipleMessages(messages);
}
}
if (fShowLineNumber && lineNumber > -1)
return JFaceTextMessages.getFormattedString("DefaultAnnotationHover.lineNumber", new String[] { Integer.toString(lineNumber + 1) }); //$NON-NLS-1$
return null;
}
/**
* Tells whether the annotation should be included in
* the computation.
*
* @param annotation the annotation to test
* @return <code>true</code> if the annotation is included in the computation
*/
protected boolean isIncluded(Annotation annotation) {
return true;
}
/**
* Hook method to format the given single message.
* <p>
* Subclasses can change this to create a different
* format like HTML.
* </p>
*
* @param message the message to format
* @return the formatted message
*/
protected String formatSingleMessage(String message) {
return message;
}
/**
* Hook method to formats the given messages.
* <p>
* Subclasses can change this to create a different
* format like HTML.
* </p>
*
* @param messages the messages to format
* @return the formatted message
*/
protected String formatMultipleMessages(List<String> messages) {
StringBuffer buffer= new StringBuffer();
buffer.append(JFaceTextMessages.getString("DefaultAnnotationHover.multipleMarkers")); //$NON-NLS-1$
Iterator<String> e= messages.iterator();
while (e.hasNext()) {
buffer.append('\n');
String listItemText= e.next();
buffer.append(JFaceTextMessages.getFormattedString("DefaultAnnotationHover.listItem", new String[] { listItemText })); //$NON-NLS-1$
}
return buffer.toString();
}
private boolean isRulerLine(Position position, IDocument document, int line) {
if (position.getOffset() > -1 && position.getLength() > -1) {
try {
return line == document.getLineOfOffset(position.getOffset());
} catch (BadLocationException x) {
}
}
return false;
}
private IAnnotationModel getAnnotationModel(ISourceViewer viewer) {
if (viewer instanceof ISourceViewerExtension2) {
ISourceViewerExtension2 extension= (ISourceViewerExtension2) viewer;
return extension.getVisualAnnotationModel();
}
return viewer.getAnnotationModel();
}
private boolean isDuplicateAnnotation(Map<Position, Object> messagesAtPosition, Position position, String message) {
if (messagesAtPosition.containsKey(position)) {
Object value= messagesAtPosition.get(position);
if (message.equals(value))
return true;
if (value instanceof List) {
@SuppressWarnings("unchecked")
List<Object> messages= (List<Object>) value;
if (messages.contains(message))
return true;
messages.add(message);
} else {
ArrayList<Object> messages= new ArrayList<>();
messages.add(value);
messages.add(message);
messagesAtPosition.put(position, messages);
}
} else
messagesAtPosition.put(position, message);
return false;
}
private boolean includeAnnotation(Annotation annotation, Position position, HashMap<Position, Object> messagesAtPosition) {
if (!isIncluded(annotation))
return false;
String text= annotation.getText();
return (text != null && !isDuplicateAnnotation(messagesAtPosition, position, text));
}
private List<Annotation> getAnnotationsForLine(ISourceViewer viewer, int line) {
IAnnotationModel model= getAnnotationModel(viewer);
if (model == null)
return null;
IDocument document= viewer.getDocument();
List<Annotation> javaAnnotations= new ArrayList<>();
HashMap<Position, Object> messagesAtPosition= new HashMap<>();
Iterator<Annotation> iterator= model.getAnnotationIterator();
while (iterator.hasNext()) {
Annotation annotation= iterator.next();
Position position= model.getPosition(annotation);
if (position == null)
continue;
if (!isRulerLine(position, document, line))
continue;
if (annotation instanceof AnnotationBag) {
AnnotationBag bag= (AnnotationBag) annotation;
Iterator<Annotation> e= bag.iterator();
while (e.hasNext()) {
annotation= e.next();
position= model.getPosition(annotation);
if (position != null && includeAnnotation(annotation, position, messagesAtPosition))
javaAnnotations.add(annotation);
}
continue;
}
if (includeAnnotation(annotation, position, messagesAtPosition))
javaAnnotations.add(annotation);
}
return javaAnnotations;
}
}
|
