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
|
/*******************************************************************************
* Copyright (c) 2000, 2014 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.jdt.internal.debug.ui;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.debug.core.DebugException;
import org.eclipse.debug.core.model.IVariable;
import org.eclipse.debug.ui.DebugUITools;
import org.eclipse.debug.ui.IDebugUIConstants;
import org.eclipse.jdt.core.Flags;
import org.eclipse.jdt.core.IClassFile;
import org.eclipse.jdt.core.ICodeAssist;
import org.eclipse.jdt.core.IField;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.ILocalVariable;
import org.eclipse.jdt.core.IMethod;
import org.eclipse.jdt.core.ITypeRoot;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.Signature;
import org.eclipse.jdt.core.dom.AST;
import org.eclipse.jdt.core.dom.ASTNode;
import org.eclipse.jdt.core.dom.ASTParser;
import org.eclipse.jdt.core.dom.FieldAccess;
import org.eclipse.jdt.core.dom.NodeFinder;
import org.eclipse.jdt.core.dom.QualifiedName;
import org.eclipse.jdt.core.dom.StructuralPropertyDescriptor;
import org.eclipse.jdt.core.dom.ThisExpression;
import org.eclipse.jdt.debug.core.IJavaDebugTarget;
import org.eclipse.jdt.debug.core.IJavaReferenceType;
import org.eclipse.jdt.debug.core.IJavaStackFrame;
import org.eclipse.jdt.debug.core.IJavaThread;
import org.eclipse.jdt.debug.core.IJavaType;
import org.eclipse.jdt.debug.core.IJavaValue;
import org.eclipse.jdt.debug.core.IJavaVariable;
import org.eclipse.jdt.internal.debug.core.JDIDebugPlugin;
import org.eclipse.jdt.internal.debug.core.logicalstructures.JDIPlaceholderVariable;
import org.eclipse.jdt.ui.JavaUI;
import org.eclipse.jdt.ui.SharedASTProvider;
import org.eclipse.jdt.ui.text.java.hover.IJavaEditorTextHover;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IInformationControlCreator;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.ITextHoverExtension;
import org.eclipse.jface.text.ITextHoverExtension2;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorPart;
public class JavaDebugHover implements IJavaEditorTextHover, ITextHoverExtension, ITextHoverExtension2 {
private IEditorPart fEditor;
/* (non-Javadoc)
* @see org.eclipse.jdt.ui.text.java.hover.IJavaEditorTextHover#setEditor(org.eclipse.ui.IEditorPart)
*/
public void setEditor(IEditorPart editor) {
fEditor = editor;
}
/* (non-Javadoc)
* @see org.eclipse.jface.text.ITextHover#getHoverRegion(org.eclipse.jface.text.ITextViewer, int)
*/
public IRegion getHoverRegion(ITextViewer textViewer, int offset) {
return JavaWordFinder.findWord(textViewer.getDocument(), offset);
}
/**
* Returns the stack frame in which to search for variables, or <code>null</code>
* if none.
*
* @return the stack frame in which to search for variables, or <code>null</code>
* if none
*/
protected IJavaStackFrame getFrame() {
IAdaptable adaptable = DebugUITools.getDebugContext();
if (adaptable != null) {
return (IJavaStackFrame)adaptable.getAdapter(IJavaStackFrame.class);
}
return null;
}
/* (non-Javadoc)
* @see org.eclipse.jface.text.ITextHover#getHoverInfo(org.eclipse.jface.text.ITextViewer, org.eclipse.jface.text.IRegion)
*/
public String getHoverInfo(ITextViewer textViewer, IRegion hoverRegion) {
Object object = getHoverInfo2(textViewer, hoverRegion);
if (object instanceof IVariable) {
IVariable var = (IVariable) object;
return getVariableText(var);
}
return null;
}
/**
* Returns a local variable in the given frame based on the hover region
* or <code>null</code> if none.
*
* @return local variable or <code>null</code>
*/
private IVariable resolveLocalVariable(IJavaStackFrame frame, ITextViewer textViewer, IRegion hoverRegion) {
if (frame != null) {
try {
IDocument document= textViewer.getDocument();
if (document != null) {
String variableName= document.get(hoverRegion.getOffset(), hoverRegion.getLength());
return findLocalVariable(frame, variableName);
}
} catch (BadLocationException x) {
}
}
return null;
}
/**
* Returns a local variable in the given frame based on the the given name
* or <code>null</code> if none.
*
* @return local variable or <code>null</code>
*/
private IVariable findLocalVariable(IJavaStackFrame frame, String variableName) {
if (frame != null) {
try {
return frame.findVariable(variableName);
} catch (DebugException x) {
if (x.getStatus().getCode() != IJavaThread.ERR_THREAD_NOT_SUSPENDED) {
JDIDebugUIPlugin.log(x);
}
}
}
return null;
}
/**
* Returns HTML text for the given variable
*/
private static String getVariableText(IVariable variable) {
StringBuffer buffer= new StringBuffer();
JDIModelPresentation modelPresentation = getModelPresentation();
buffer.append("<p><pre>"); //$NON-NLS-1$
String variableText= modelPresentation.getVariableText((IJavaVariable) variable);
buffer.append(replaceHTMLChars(variableText));
buffer.append("</pre></p>"); //$NON-NLS-1$
modelPresentation.dispose();
if (buffer.length() > 0) {
return buffer.toString();
}
return null;
}
/**
* Replaces reserved HTML characters in the given string with
* their escaped equivalents. This is to ensure that variable
* values containing reserved characters are correctly displayed.
*/
private static String replaceHTMLChars(String variableText) {
StringBuffer buffer= new StringBuffer(variableText.length());
char[] characters = variableText.toCharArray();
for (int i = 0; i < characters.length; i++) {
char character= characters[i];
switch (character) {
case '<':
buffer.append("<"); //$NON-NLS-1$
break;
case '>':
buffer.append(">"); //$NON-NLS-1$
break;
case '&':
buffer.append("&"); //$NON-NLS-1$
break;
case '"':
buffer.append("""); //$NON-NLS-1$
break;
default:
buffer.append(character);
}
}
return buffer.toString();
}
/**
* Returns a configured model presentation for use displaying variables.
*/
private static JDIModelPresentation getModelPresentation() {
JDIModelPresentation presentation = new JDIModelPresentation();
String[][] booleanPrefs= {
{IJDIPreferencesConstants.PREF_SHOW_QUALIFIED_NAMES, JDIModelPresentation.DISPLAY_QUALIFIED_NAMES}};
String viewId= IDebugUIConstants.ID_VARIABLE_VIEW;
for (int i = 0; i < booleanPrefs.length; i++) {
boolean preferenceValue = getBooleanPreferenceValue(viewId, booleanPrefs[i][0]);
presentation.setAttribute(booleanPrefs[i][1], (preferenceValue ? Boolean.TRUE : Boolean.FALSE));
}
return presentation;
}
/**
* Returns the value of this filters preference (on/off) for the given
* view.
*
* @param part
* @return boolean
*/
public static boolean getBooleanPreferenceValue(String id, String preference) {
String compositeKey = id + "." + preference; //$NON-NLS-1$
IPreferenceStore store = JDIDebugUIPlugin.getDefault().getPreferenceStore();
boolean value = false;
if (store.contains(compositeKey)) {
value = store.getBoolean(compositeKey);
} else {
value = store.getBoolean(preference);
}
return value;
}
/* (non-Javadoc)
* @see org.eclipse.jface.text.ITextHoverExtension#getHoverControlCreator()
*/
public IInformationControlCreator getHoverControlCreator() {
return new ExpressionInformationControlCreator();
}
/* (non-Javadoc)
* @see org.eclipse.jface.text.ITextHoverExtension2#getHoverInfo2(org.eclipse.jface.text.ITextViewer, org.eclipse.jface.text.IRegion)
*/
public Object getHoverInfo2(ITextViewer textViewer, IRegion hoverRegion) {
IJavaStackFrame frame = getFrame();
if (frame != null) {
// first check for 'this' - code resolve does not resolve java elements for 'this'
IDocument document= textViewer.getDocument();
if (document != null) {
try {
String variableName= document.get(hoverRegion.getOffset(), hoverRegion.getLength());
if (variableName.equals("this")) { //$NON-NLS-1$
try {
IJavaVariable variable = frame.findVariable(variableName);
if (variable != null) {
return variable;
}
} catch (DebugException e) {
return null;
}
}
} catch (BadLocationException e) {
return null;
}
}
ICodeAssist codeAssist = null;
if (fEditor != null) {
IEditorInput input = fEditor.getEditorInput();
Object element = JavaUI.getWorkingCopyManager().getWorkingCopy(input);
if (element == null) {
element = input.getAdapter(IClassFile.class);
}
if (element instanceof ICodeAssist) {
codeAssist = ((ICodeAssist)element);
}
}
if (codeAssist == null) {
return resolveLocalVariable(frame, textViewer, hoverRegion);
}
IJavaElement[] resolve = null;
try {
resolve = codeAssist.codeSelect(hoverRegion.getOffset(), 0);
} catch (JavaModelException e1) {
resolve = new IJavaElement[0];
}
try {
for (int i = 0; i < resolve.length; i++) {
IJavaElement javaElement = resolve[i];
if (javaElement instanceof IField) {
IField field = (IField)javaElement;
IJavaVariable variable = null;
IJavaDebugTarget debugTarget = (IJavaDebugTarget)frame.getDebugTarget();
if (Flags.isStatic(field.getFlags())) {
IJavaType[] javaTypes = debugTarget.getJavaTypes(field.getDeclaringType().getFullyQualifiedName());
if (javaTypes != null) {
for (int j = 0; j < javaTypes.length; j++) {
IJavaType type = javaTypes[j];
if (type instanceof IJavaReferenceType) {
IJavaReferenceType referenceType = (IJavaReferenceType) type;
variable = referenceType.getField(field.getElementName());
}
if (variable != null) {
break;
}
}
}
if (variable == null) {
// the class is not loaded yet, but may be an in-lined primitive constant
Object constant = field.getConstant();
if (constant != null) {
IJavaValue value = null;
if (constant instanceof Integer) {
value = debugTarget.newValue(((Integer)constant).intValue());
} else if (constant instanceof Byte) {
value = debugTarget.newValue(((Byte)constant).byteValue());
} else if (constant instanceof Boolean) {
value = debugTarget.newValue(((Boolean)constant).booleanValue());
} else if (constant instanceof Character) {
value = debugTarget.newValue(((Character)constant).charValue());
} else if (constant instanceof Double) {
value = debugTarget.newValue(((Double)constant).doubleValue());
} else if (constant instanceof Float) {
value = debugTarget.newValue(((Float)constant).floatValue());
} else if (constant instanceof Long) {
value = debugTarget.newValue(((Long)constant).longValue());
} else if (constant instanceof Short) {
value = debugTarget.newValue(((Short)constant).shortValue());
} else if (constant instanceof String) {
value = debugTarget.newValue((String)constant);
}
if (value != null) {
variable = new JDIPlaceholderVariable(field.getElementName(), value);
}
}
if (variable == null) {
return null; // class not loaded yet and not a constant
}
}
} else {
if (!frame.isStatic()) {
// ensure that we only resolve a field access on 'this':
if (!(codeAssist instanceof ITypeRoot))
return null;
ITypeRoot typeRoot = (ITypeRoot) codeAssist;
ASTNode root= SharedASTProvider.getAST(typeRoot, SharedASTProvider.WAIT_NO, null);
if (root == null) {
ASTParser parser = ASTParser.newParser(AST.JLS4);
parser.setSource(typeRoot);
parser.setFocalPosition(hoverRegion.getOffset());
root = parser.createAST(null);
}
ASTNode node = NodeFinder.perform(root, hoverRegion.getOffset(), hoverRegion.getLength());
if (node == null)
return null;
StructuralPropertyDescriptor locationInParent = node.getLocationInParent();
if (locationInParent == FieldAccess.NAME_PROPERTY) {
FieldAccess fieldAccess = (FieldAccess) node.getParent();
if (!(fieldAccess.getExpression() instanceof ThisExpression)) {
return null;
}
} else if (locationInParent == QualifiedName.NAME_PROPERTY) {
return null;
}
String typeSignature = Signature.createTypeSignature(field.getDeclaringType().getFullyQualifiedName(), true);
typeSignature = typeSignature.replace('.', '/');
variable = frame.getThis().getField(field.getElementName(), typeSignature);
}
}
if (variable != null) {
return variable;
}
break;
}
if (javaElement instanceof ILocalVariable) {
ILocalVariable var = (ILocalVariable)javaElement;
IJavaElement parent = var.getParent();
while (!(parent instanceof IMethod) && parent != null) {
parent = parent.getParent();
}
if (parent instanceof IMethod) {
IMethod method = (IMethod) parent;
boolean equal = false;
if (method.isBinary()) {
// compare resolved signatures
if (method.getSignature().equals(frame.getSignature())) {
equal = true;
}
} else {
// compare unresolved signatures
if (((frame.isConstructor() && method.isConstructor()) || frame.getMethodName().equals(method.getElementName()))
&& frame.getDeclaringTypeName().endsWith(method.getDeclaringType().getElementName())
&& frame.getArgumentTypeNames().size() == method.getNumberOfParameters()) {
equal = true;
}
}
// find variable if equal or method is a Lambda Method
if (equal || method.isLambdaMethod()) {
return findLocalVariable(frame, var.getElementName());
}
}
break;
}
}
} catch (CoreException e) {
JDIDebugPlugin.log(e);
}
}
return null;
}
/* (non-Javadoc)
* @see org.eclipse.jface.text.ITextHoverExtension2#getInformationPresenterControlCreator()
*/
public IInformationControlCreator getInformationPresenterControlCreator() {
return new ExpressionInformationControlCreator();
}
}
|
