/
SystemApiDetector.java
413 lines (395 loc) · 14.5 KB
/
SystemApiDetector.java
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) 2008, 2018 IBM Corporation 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.pde.api.tools.internal.builder;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.SubMonitor;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.ISourceRange;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.Signature;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.Position;
import org.eclipse.osgi.service.resolver.BundleDescription;
import org.eclipse.osgi.service.resolver.ImportPackageSpecification;
import org.eclipse.pde.api.tools.internal.model.BundleComponent;
import org.eclipse.pde.api.tools.internal.model.ProjectComponent;
import org.eclipse.pde.api.tools.internal.provisional.ApiPlugin;
import org.eclipse.pde.api.tools.internal.provisional.ProfileModifiers;
import org.eclipse.pde.api.tools.internal.provisional.builder.IReference;
import org.eclipse.pde.api.tools.internal.provisional.descriptors.IElementDescriptor;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiBaseline;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiComponent;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiElement;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiField;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiMember;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiMethod;
import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem;
import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes;
import org.eclipse.pde.api.tools.internal.util.Signatures;
import org.eclipse.pde.api.tools.internal.util.Util;
/**
* Detects references to fields, methods and types that are not available for a
* specific EE.
*
* @since 1.1
*/
public class SystemApiDetector extends AbstractProblemDetector {
private Map<IReference, Integer> referenceEEs;
/**
* Constructor
*/
public SystemApiDetector() {
}
@Override
protected int getElementType(IReference reference) {
IApiMember member = reference.getMember();
return switch (member.getType())
{
case IApiElement.TYPE -> IElementDescriptor.TYPE;
case IApiElement.METHOD -> IElementDescriptor.METHOD;
case IApiElement.FIELD -> IElementDescriptor.FIELD;
default -> 0;
};
}
@Override
protected String[] getMessageArgs(IReference reference) throws CoreException {
IApiMember member = reference.getMember();
String eeValue = ProfileModifiers.getName(this.referenceEEs.get(reference).intValue());
String simpleTypeName = Signatures.getSimpleTypeName(reference.getReferencedTypeName());
if (simpleTypeName.indexOf('$') != -1) {
simpleTypeName = simpleTypeName.replace('$', '.');
}
return switch (reference.getReferenceType())
{
case IReference.T_TYPE_REFERENCE -> new String[] {
getDisplay(member, false), simpleTypeName, eeValue, };
case IReference.T_FIELD_REFERENCE -> new String[] {
getDisplay(member, false), simpleTypeName,
reference.getReferencedMemberName(), eeValue, };
case IReference.T_METHOD_REFERENCE -> {
String referenceMemberName = reference.getReferencedMemberName();
yield Util.isConstructor(referenceMemberName) ? new String[] {
getDisplay(member, false),
Signature.toString(reference.getReferencedSignature(), simpleTypeName, null, false, false),
eeValue, }
: new String[] {
getDisplay(member, false),
simpleTypeName,
Signature.toString(reference.getReferencedSignature(), referenceMemberName, null, false, false),
eeValue, };
}
default -> null;
};
}
/**
* Returns the signature to display for found problems
*
* @param member the member to get the signature from
* @param qualified if the returned signature should be type-qualified or
* not
* @return
* @throws CoreException
*/
private String getDisplay(IApiMember member, boolean qualified) throws CoreException {
String typeName = qualified ? getTypeName(member) : getSimpleTypeName(member);
if (typeName.indexOf('$') != -1) {
typeName = typeName.replace('$', '.');
}
return switch (member.getType())
{
case IApiElement.FIELD -> {
StringBuilder buffer = new StringBuilder();
IApiField field = (IApiField) member;
buffer.append(typeName).append('.').append(field.getName());
yield String.valueOf(buffer);
}
case IApiElement.METHOD -> {
// reference in a method declaration
IApiMethod method = (IApiMethod) member;
yield qualified ? Signatures.getMethodSignature(method)
: Signatures.getQualifiedMethodSignature(method);
}
default -> typeName;
};
}
@Override
protected int getProblemFlags(IReference reference) {
return switch (reference.getReferenceType())
{
case IReference.T_TYPE_REFERENCE -> IApiProblem.NO_FLAGS;
case IReference.T_METHOD_REFERENCE -> Util.isConstructor(reference.getReferencedMemberName())
? IApiProblem.CONSTRUCTOR_METHOD
: IApiProblem.METHOD;
case IReference.T_FIELD_REFERENCE -> IApiProblem.FIELD;
default -> IApiProblem.NO_FLAGS;
};
}
@Override
protected int getProblemKind() {
return IApiProblem.INVALID_REFERENCE_IN_SYSTEM_LIBRARIES;
}
@Override
protected String[] getQualifiedMessageArgs(IReference reference) throws CoreException {
IApiMember member = reference.getMember();
String eeValue = ProfileModifiers.getName(this.referenceEEs.get(reference).intValue());
String simpleTypeName = reference.getReferencedTypeName();
if (simpleTypeName.indexOf('$') != -1) {
simpleTypeName = simpleTypeName.replace('$', '.');
}
return switch (reference.getReferenceType()) {
case IReference.T_TYPE_REFERENCE -> {
yield new String[] {
getDisplay(member, false), simpleTypeName, eeValue, };
}
case IReference.T_FIELD_REFERENCE -> {
yield new String[] {
getDisplay(member, false), simpleTypeName,
reference.getReferencedMemberName(), eeValue, };
}
case IReference.T_METHOD_REFERENCE -> {
String referenceMemberName = reference.getReferencedMemberName();
if (Util.isConstructor(referenceMemberName)) {
yield new String[] {
getDisplay(member, false),
Signature.toString(reference.getReferencedSignature(), simpleTypeName, null, false, false),
eeValue, };
} else {
yield new String[] {
getDisplay(member, false),
simpleTypeName,
Signature.toString(reference.getReferencedSignature(), referenceMemberName, null, false, false),
eeValue, };
}
}
default -> null;
};
}
@Override
protected String getSeverityKey() {
return IApiProblemTypes.INVALID_REFERENCE_IN_SYSTEM_LIBRARIES;
}
@Override
protected Position getSourceRange(IType type, IDocument document, IReference reference) throws CoreException, BadLocationException {
return switch (reference.getReferenceType())
{
case IReference.T_TYPE_REFERENCE -> {
int linenumber = reference.getLineNumber();
if (linenumber > 0) {
// line number starts at 0 for the
linenumber--;
}
if (linenumber > 0) {
int offset = document.getLineOffset(linenumber);
String line = document.get(offset, document.getLineLength(linenumber));
String qname = reference.getReferencedTypeName().replace('$', '.');
int first = line.indexOf(qname);
if (first < 0) {
qname = Signatures.getSimpleTypeName(reference.getReferencedTypeName());
qname = qname.replace('$', '.');
first = line.indexOf(qname);
}
Position pos = null;
if (first > -1) {
pos = new Position(offset + first, qname.length());
} else {
// optimistically select the whole line since we can't
// find the correct variable name and we can't just
// select
// the first occurrence
pos = new Position(offset, line.length());
}
yield pos;
} else {
IApiMember apiMember = reference.getMember();
switch (apiMember.getType()) {
case IApiElement.FIELD -> {
IApiField field = (IApiField) reference.getMember();
yield getSourceRangeForField(type, reference, field);
}
case IApiElement.METHOD -> {
// reference in a method declaration
IApiMethod method = (IApiMethod) reference.getMember();
yield getSourceRangeForMethod(type, reference, method);
}
default -> { /**/ }
}
// reference in a type declaration
ISourceRange range = type.getNameRange();
Position pos = null;
if (range != null) {
pos = new Position(range.getOffset(), range.getLength());
}
if (pos == null) {
yield defaultSourcePosition(type, reference);
}
yield pos;
}
}
case IReference.T_FIELD_REFERENCE -> {
int linenumber = reference.getLineNumber();
if (linenumber > 0) {
yield getFieldNameRange(reference.getReferencedTypeName(), reference.getReferencedMemberName(),
document, reference);
}
// reference in a field declaration
IApiField field = (IApiField) reference.getMember();
yield getSourceRangeForField(type, reference, field);
}
case IReference.T_METHOD_REFERENCE -> {
if (reference.getLineNumber() >= 0) {
String referenceMemberName = reference.getReferencedMemberName();
String methodName = null;
boolean isConstructor = Util.isConstructor(referenceMemberName);
if (isConstructor) {
methodName = Signatures.getSimpleTypeName(reference.getReferencedTypeName().replace('$', '.'));
} else {
methodName = referenceMemberName;
}
Position pos = getMethodNameRange(isConstructor, methodName, document, reference);
if (pos == null) {
yield defaultSourcePosition(type, reference);
}
yield pos;
}
// reference in a method declaration
IApiMethod method = (IApiMethod) reference.getMember();
yield getSourceRangeForMethod(type, reference, method);
}
default -> null;
};
}
@Override
protected boolean isProblem(IReference reference, IProgressMonitor monitor) {
// the reference must be in the system library
try {
IApiMember member = reference.getMember();
IApiComponent apiComponent = member.getApiComponent();
String[] lowestEEs = apiComponent.getLowestEEs();
if (lowestEEs == null) {
// this should not be true for Eclipse bundle as they should
// always have a EE set
return false;
}
loop: for (String lowestEE : lowestEEs) {
int eeValue = ProfileModifiers.getValue(lowestEE);
if (eeValue == ProfileModifiers.NO_PROFILE_VALUE) {
return false;
}
if (!((Reference) reference).resolve(eeValue)) {
/*
* Make sure that the resolved reference doesn't below to
* one of the imported package of the current component
*/
if (apiComponent instanceof BundleComponent) {
BundleDescription bundle = ((BundleComponent) apiComponent).getBundleDescription();
ImportPackageSpecification[] importPackages = bundle.getImportPackages();
String referencedTypeName = reference.getReferencedTypeName();
int index = referencedTypeName.lastIndexOf('.');
String packageName = referencedTypeName.substring(0, index);
for (ImportPackageSpecification importPackageSpecification : importPackages) {
// get the IPackageDescriptor for the element
// descriptor
String importPackageName = importPackageSpecification.getName();
if (importPackageName.equals(packageName)) {
continue loop;
}
}
}
if (this.referenceEEs == null) {
this.referenceEEs = new HashMap<>(3);
}
this.referenceEEs.put(reference, Integer.valueOf(eeValue));
return true;
}
}
} catch (CoreException e) {
ApiPlugin.log(e);
checkIfDisposed(reference.getMember().getApiComponent(), monitor);
}
return false;
}
@Override
public boolean considerReference(IReference reference, IProgressMonitor monitor) {
try {
IApiComponent apiComponent = reference.getMember().getApiComponent();
IApiBaseline baseline = apiComponent.getBaseline();
if (baseline == null) {
return false;
}
String referencedTypeName = reference.getReferencedTypeName();
// extract the package name
int index = referencedTypeName.lastIndexOf('.');
if (index == -1) {
return false;
}
String substring = referencedTypeName.substring(0, index);
IApiComponent[] resolvePackages = baseline.resolvePackage(apiComponent, substring);
if (resolvePackages.length > 0) {
if (resolvePackages[0].isSystemComponent()) {
if (reference.getReferenceKind() == IReference.REF_OVERRIDE || reference.getReferenceKind() == IReference.REF_CONSTANTPOOL) {
return false;
}
((Reference) reference).setResolveStatus(false);
retainReference(reference);
return true;
}
}
} catch (CoreException e) {
ApiPlugin.log(e);
checkIfDisposed(reference.getMember().getApiComponent(), monitor);
}
return false;
}
@Override
public int getReferenceKinds() {
return IReference.MASK_REF_ALL & ~IReference.REF_OVERRIDE;
}
@Override
public List<IApiProblem> createProblems(IProgressMonitor monitor) {
List<IReference> references = getRetainedReferences();
List<IApiProblem> problems = new LinkedList<>();
SubMonitor loopMonitor = SubMonitor.convert(monitor, references.size());
for (IReference reference : references) {
if (monitor.isCanceled()) {
break;
}
loopMonitor.split(1);
if (isProblem(reference, monitor)) {
try {
IApiProblem problem = null;
IApiComponent component = reference.getMember().getApiComponent();
if (component instanceof ProjectComponent ppac) {
IJavaProject project = ppac.getJavaProject();
problem = createProblem(reference, project);
} else {
problem = createProblem(reference);
}
if (problem != null) {
problems.add(problem);
}
} catch (CoreException e) {
ApiPlugin.log(e.getStatus());
AbstractProblemDetector.checkIfDisposed(reference.getMember().getApiComponent(), monitor);
}
}
}
return problems;
}
}