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
|
/*******************************************************************************
* Copyright (c) 2000, 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
* Mateusz Wenus <mateusz.wenus@gmail.com> - [override method] generate in declaration order [code generation] - https://bugs.eclipse.org/bugs/show_bug.cgi?id=140971
*******************************************************************************/
package org.eclipse.jdt.internal.corext.codemanipulation;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.SubProgressMonitor;
import org.eclipse.core.runtime.jobs.ISchedulingRule;
import org.eclipse.core.resources.IWorkspaceRunnable;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.text.edits.MultiTextEdit;
import org.eclipse.text.edits.TextEdit;
import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.dom.ASTNode;
import org.eclipse.jdt.core.dom.AbstractTypeDeclaration;
import org.eclipse.jdt.core.dom.AnonymousClassDeclaration;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.dom.IMethodBinding;
import org.eclipse.jdt.core.dom.ITypeBinding;
import org.eclipse.jdt.core.dom.IVariableBinding;
import org.eclipse.jdt.core.dom.MethodDeclaration;
import org.eclipse.jdt.core.dom.rewrite.ASTRewrite;
import org.eclipse.jdt.core.dom.rewrite.ImportRewrite;
import org.eclipse.jdt.core.dom.rewrite.ListRewrite;
import org.eclipse.jdt.internal.core.manipulation.StubUtility;
import org.eclipse.jdt.internal.corext.util.DelegateEntryComparator;
import org.eclipse.jdt.internal.corext.util.JavaModelUtil;
/**
* Workspace runnable to add delegate methods.
*
* @since 3.1
*/
public final class AddDelegateMethodsOperation implements IWorkspaceRunnable {
/**
* Represents a delegated method
*/
public static class DelegateEntry {
public DelegateEntry(IMethodBinding delegateMethod, IVariableBinding field) {
Assert.isNotNull(delegateMethod);
Assert.isNotNull(field);
this.delegateMethod= delegateMethod;
this.field= field;
}
public final IMethodBinding delegateMethod;
public final IVariableBinding field;
}
/** Should the resulting edit be applied? */
private boolean fApply= true;
/** The method binding keys for which a method was generated */
private final List<IMethodBinding> fCreated= new ArrayList<>();
/** The resulting text edit */
private TextEdit fResultingEdit= null;
/** The insertion point, or <code>null</code> */
private final IJavaElement fInsert;
/** Should the compilation unit content be saved? */
private final boolean fSave;
/** The code generation settings to use */
private final CodeGenerationSettings fSettings;
/** The compilation unit ast node */
private final CompilationUnit fASTRoot;
private final DelegateEntry[] fDelegatesToCreate;
/**
* Creates a new add delegate methods operation.
*
* @param astRoot the AST of the current compilation unit
* @param delegatesToCreate the delegates to create
* @param insert the insertion point, or <code>null</code>
* @param settings the code generation settings to use
* @param apply <code>true</code> if the resulting edit should be applied, <code>false</code> otherwise
* @param save <code>true</code> if the changed compilation unit should be saved, <code>false</code> otherwise
*/
public AddDelegateMethodsOperation(CompilationUnit astRoot, DelegateEntry[] delegatesToCreate, IJavaElement insert, CodeGenerationSettings settings, boolean apply, boolean save) {
Assert.isTrue(astRoot != null && astRoot.getTypeRoot() instanceof ICompilationUnit);
Assert.isTrue(delegatesToCreate != null && delegatesToCreate.length > 0);
Assert.isNotNull(settings);
fASTRoot= astRoot;
fInsert= insert;
fDelegatesToCreate= delegatesToCreate;
fSettings= settings;
fSave= save;
fApply= apply;
}
/**
* Returns the method binding keys for which a method has been generated.
*
* @return the method binding keys
*/
public final String[] getCreatedMethods() {
final String[] keys= new String[fCreated.size()];
fCreated.toArray(keys);
return keys;
}
/**
* Returns the resulting text edit.
*
* @return the resulting text edit
*/
public final TextEdit getResultingEdit() {
return fResultingEdit;
}
/**
* Returns the scheduling rule for this operation.
*
* @return the scheduling rule
*/
public final ISchedulingRule getSchedulingRule() {
return ResourcesPlugin.getWorkspace().getRoot();
}
/*
* @see org.eclipse.core.resources.IWorkspaceRunnable#run(org.eclipse.core.runtime.IProgressMonitor)
*/
@Override
public final void run(IProgressMonitor monitor) throws CoreException {
if (monitor == null)
monitor= new NullProgressMonitor();
try {
monitor.beginTask("", 1); //$NON-NLS-1$
monitor.setTaskName(CodeGenerationMessages.AddDelegateMethodsOperation_monitor_message);
fCreated.clear();
ICompilationUnit cu= (ICompilationUnit) fASTRoot.getTypeRoot();
ASTRewrite astRewrite= ASTRewrite.create(fASTRoot.getAST());
ImportRewrite importRewrite= StubUtility.createImportRewrite(fASTRoot, true);
ITypeBinding parentType= fDelegatesToCreate[0].field.getDeclaringClass();
ASTNode typeDecl= fASTRoot.findDeclaringNode(parentType);
ListRewrite listRewriter= null;
if (typeDecl instanceof AbstractTypeDeclaration) {
listRewriter= astRewrite.getListRewrite(typeDecl, ((AbstractTypeDeclaration) typeDecl).getBodyDeclarationsProperty());
} else if (typeDecl instanceof AnonymousClassDeclaration) {
listRewriter= astRewrite.getListRewrite(typeDecl, AnonymousClassDeclaration.BODY_DECLARATIONS_PROPERTY);
}
if (listRewriter != null) {
ASTNode insertion= StubUtility2Core.getNodeToInsertBefore(listRewriter, fInsert);
ContextSensitiveImportRewriteContext context= new ContextSensitiveImportRewriteContext(fASTRoot, typeDecl.getStartPosition(), importRewrite);
Arrays.sort(fDelegatesToCreate, new DelegateEntryComparator());
for (DelegateEntry delegateEntry : fDelegatesToCreate) {
IMethodBinding delegateMethod= delegateEntry.delegateMethod;
IVariableBinding field= delegateEntry.field;
MethodDeclaration newMethod= StubUtility2Core.createDelegationStub(cu, astRewrite, importRewrite, context, delegateMethod, field, fSettings);
if (newMethod != null) {
fCreated.add(delegateMethod);
if (insertion != null && insertion.getParent() == typeDecl)
listRewriter.insertBefore(newMethod, insertion, null);
else
listRewriter.insertLast(newMethod, null);
}
}
fResultingEdit= new MultiTextEdit();
fResultingEdit.addChild(astRewrite.rewriteAST());
fResultingEdit.addChild(importRewrite.rewriteImports(new SubProgressMonitor(monitor, 1)));
if (fApply) {
JavaModelUtil.applyEdit(cu, fResultingEdit, fSave, new SubProgressMonitor(monitor, 1));
}
}
} finally {
monitor.done();
}
}
}
|
