-
Notifications
You must be signed in to change notification settings - Fork 78
/
PullUpRefactoringProcessor.java
2493 lines (2318 loc) · 120 KB
/
PullUpRefactoringProcessor.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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*******************************************************************************
* Copyright (c) 2006, 2023 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
* Benjamin Muskalla - 228950: [pull up] exception if target calls super with multiple parameters
* Jerome Cambon <jerome.cambon@oracle.com> - [code style] don't generate redundant modifiers "public static final abstract" for interface members - https://bugs.eclipse.org/71627
* Microsoft Corporation - read formatting options from the compilation unit
*******************************************************************************/
package org.eclipse.jdt.internal.corext.refactoring.structure;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
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.OperationCanceledException;
import org.eclipse.core.runtime.SubMonitor;
import org.eclipse.text.edits.MalformedTreeException;
import org.eclipse.text.edits.TextEdit;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.IDocument;
import org.eclipse.ltk.core.refactoring.Change;
import org.eclipse.ltk.core.refactoring.GroupCategory;
import org.eclipse.ltk.core.refactoring.GroupCategorySet;
import org.eclipse.ltk.core.refactoring.RefactoringDescriptor;
import org.eclipse.ltk.core.refactoring.RefactoringStatus;
import org.eclipse.ltk.core.refactoring.RefactoringStatusContext;
import org.eclipse.ltk.core.refactoring.TextChange;
import org.eclipse.ltk.core.refactoring.TextEditBasedChange;
import org.eclipse.ltk.core.refactoring.participants.CheckConditionsContext;
import org.eclipse.jdt.core.Flags;
import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IField;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.IMember;
import org.eclipse.jdt.core.IMethod;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.ITypeHierarchy;
import org.eclipse.jdt.core.ITypeParameter;
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.ASTRequestor;
import org.eclipse.jdt.core.dom.ASTVisitor;
import org.eclipse.jdt.core.dom.AbstractTypeDeclaration;
import org.eclipse.jdt.core.dom.AnonymousClassDeclaration;
import org.eclipse.jdt.core.dom.Block;
import org.eclipse.jdt.core.dom.BodyDeclaration;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.dom.Expression;
import org.eclipse.jdt.core.dom.FieldAccess;
import org.eclipse.jdt.core.dom.FieldDeclaration;
import org.eclipse.jdt.core.dom.IBinding;
import org.eclipse.jdt.core.dom.IMethodBinding;
import org.eclipse.jdt.core.dom.ITypeBinding;
import org.eclipse.jdt.core.dom.Javadoc;
import org.eclipse.jdt.core.dom.MethodDeclaration;
import org.eclipse.jdt.core.dom.MethodInvocation;
import org.eclipse.jdt.core.dom.Modifier;
import org.eclipse.jdt.core.dom.Name;
import org.eclipse.jdt.core.dom.NodeFinder;
import org.eclipse.jdt.core.dom.QualifiedName;
import org.eclipse.jdt.core.dom.QualifiedType;
import org.eclipse.jdt.core.dom.ReturnStatement;
import org.eclipse.jdt.core.dom.SimpleName;
import org.eclipse.jdt.core.dom.SimpleType;
import org.eclipse.jdt.core.dom.SingleVariableDeclaration;
import org.eclipse.jdt.core.dom.SuperFieldAccess;
import org.eclipse.jdt.core.dom.SuperMethodInvocation;
import org.eclipse.jdt.core.dom.ThisExpression;
import org.eclipse.jdt.core.dom.Type;
import org.eclipse.jdt.core.dom.TypeDeclarationStatement;
import org.eclipse.jdt.core.dom.VariableDeclarationFragment;
import org.eclipse.jdt.core.dom.rewrite.ASTRewrite;
import org.eclipse.jdt.core.dom.rewrite.ITrackedNodePosition;
import org.eclipse.jdt.core.dom.rewrite.ImportRewrite;
import org.eclipse.jdt.core.dom.rewrite.ImportRewrite.ImportRewriteContext;
import org.eclipse.jdt.core.dom.rewrite.ListRewrite;
import org.eclipse.jdt.core.manipulation.CodeGeneration;
import org.eclipse.jdt.core.refactoring.CompilationUnitChange;
import org.eclipse.jdt.core.refactoring.IJavaRefactorings;
import org.eclipse.jdt.core.refactoring.descriptors.JavaRefactoringDescriptor;
import org.eclipse.jdt.core.refactoring.descriptors.PullUpDescriptor;
import org.eclipse.jdt.core.search.IJavaSearchConstants;
import org.eclipse.jdt.core.search.MethodReferenceMatch;
import org.eclipse.jdt.core.search.SearchMatch;
import org.eclipse.jdt.core.search.SearchPattern;
import org.eclipse.jdt.internal.core.manipulation.JavaElementLabelsCore;
import org.eclipse.jdt.internal.core.manipulation.JavaManipulationPlugin;
import org.eclipse.jdt.internal.core.manipulation.StubUtility;
import org.eclipse.jdt.internal.core.manipulation.util.BasicElementLabels;
import org.eclipse.jdt.internal.core.manipulation.util.Strings;
import org.eclipse.jdt.internal.core.refactoring.descriptors.RefactoringSignatureDescriptorFactory;
import org.eclipse.jdt.internal.corext.codemanipulation.CodeGenerationSettings;
import org.eclipse.jdt.internal.corext.codemanipulation.ContextSensitiveImportRewriteContext;
import org.eclipse.jdt.internal.corext.codemanipulation.StubUtility2Core;
import org.eclipse.jdt.internal.corext.dom.ASTNodeFactory;
import org.eclipse.jdt.internal.corext.dom.ASTNodes;
import org.eclipse.jdt.internal.corext.dom.AbortSearchException;
import org.eclipse.jdt.internal.corext.dom.Bindings;
import org.eclipse.jdt.internal.corext.dom.BodyDeclarationRewrite;
import org.eclipse.jdt.internal.corext.dom.IASTSharedValues;
import org.eclipse.jdt.internal.corext.dom.InterruptibleVisitor;
import org.eclipse.jdt.internal.corext.dom.ModifierRewrite;
import org.eclipse.jdt.internal.corext.refactoring.Checks;
import org.eclipse.jdt.internal.corext.refactoring.JDTRefactoringDescriptorComment;
import org.eclipse.jdt.internal.corext.refactoring.JavaRefactoringArguments;
import org.eclipse.jdt.internal.corext.refactoring.JavaRefactoringDescriptorUtil;
import org.eclipse.jdt.internal.corext.refactoring.RefactoringAvailabilityTesterCore;
import org.eclipse.jdt.internal.corext.refactoring.RefactoringCoreMessages;
import org.eclipse.jdt.internal.corext.refactoring.RefactoringScopeFactory;
import org.eclipse.jdt.internal.corext.refactoring.RefactoringSearchEngine2;
import org.eclipse.jdt.internal.corext.refactoring.SearchResultGroup;
import org.eclipse.jdt.internal.corext.refactoring.changes.DynamicValidationRefactoringChange;
import org.eclipse.jdt.internal.corext.refactoring.rename.MethodChecks;
import org.eclipse.jdt.internal.corext.refactoring.reorg.SourceReferenceUtil;
import org.eclipse.jdt.internal.corext.refactoring.structure.MemberVisibilityAdjustor.IncomingMemberVisibilityAdjustment;
import org.eclipse.jdt.internal.corext.refactoring.structure.constraints.SuperTypeConstraintsSolver;
import org.eclipse.jdt.internal.corext.refactoring.typeconstraints.CompilationUnitRange;
import org.eclipse.jdt.internal.corext.refactoring.typeconstraints.types.TType;
import org.eclipse.jdt.internal.corext.refactoring.typeconstraints2.ITypeConstraintVariable;
import org.eclipse.jdt.internal.corext.refactoring.util.JavaElementUtil;
import org.eclipse.jdt.internal.corext.refactoring.util.JavaStatusContext;
import org.eclipse.jdt.internal.corext.refactoring.util.RefactoringASTParser;
import org.eclipse.jdt.internal.corext.refactoring.util.ResourceUtil;
import org.eclipse.jdt.internal.corext.refactoring.util.TextEditBasedChangeManager;
import org.eclipse.jdt.internal.corext.util.JavaModelUtil;
import org.eclipse.jdt.internal.corext.util.JdtFlags;
import org.eclipse.jdt.internal.corext.util.Messages;
import org.eclipse.jdt.internal.corext.util.SearchUtils;
import org.eclipse.jdt.internal.ui.preferences.JavaPreferencesSettings;
import org.eclipse.jdt.internal.ui.preferences.formatter.FormatterProfileManagerCore;
/**
* Refactoring processor for the pull up refactoring.
*
* @since 3.2
*/
public class PullUpRefactoringProcessor extends HierarchyProcessor {
/**
* AST node visitor which performs the actual mapping.
*/
private static class PullUpAstNodeMapper extends TypeVariableMapper {
/** Are we in an anonymous class declaration? */
private boolean fAnonymousClassDeclaration= false;
/** The source compilation unit rewrite to use */
private final CompilationUnitRewrite fSourceRewriter;
/** The super reference type */
private final IType fSuperReferenceType;
/** The target compilation unit rewrite to use */
private final CompilationUnitRewrite fTargetRewriter;
/** Are we in a type declaration statement? */
private boolean fTypeDeclarationStatement= false;
/** Enclosing method */
private final MethodDeclaration fEnclosingMethodDeclaration;
/** The binding of the enclosing method */
private final IMethodBinding fEnclosingMethod;
/** Members being moved */
private final IMember[] fMembersToMove;
/** New argument map */
private final Map<IMethod, String> fNewArgumentMap;
/**
* Creates a new pull up ast node mapper.
*
* @param sourceRewriter
* the source compilation unit rewrite to use
* @param targetRewriter
* the target compilation unit rewrite to use
* @param rewrite
* the AST rewrite to use
* @param type
* the super reference type
* @param mapping
* the type variable mapping
* @param enclosingMethodDecl the enclosing method declaration
* @param membersToMove
* the members that are being moved by this refactoring
* @param newArgumentMap
* map of IMethod to new argument required to handle this references
*/
public PullUpAstNodeMapper(final CompilationUnitRewrite sourceRewriter, final CompilationUnitRewrite targetRewriter, final ASTRewrite rewrite,
final IType type, final TypeVariableMaplet[] mapping, final MethodDeclaration enclosingMethodDecl,
final IMember[] membersToMove, final Map<IMethod, String> newArgumentMap) {
super(rewrite, mapping);
Assert.isNotNull(rewrite);
Assert.isNotNull(type);
fSourceRewriter= sourceRewriter;
fTargetRewriter= targetRewriter;
fSuperReferenceType= type;
fEnclosingMethodDeclaration= enclosingMethodDecl;
fEnclosingMethod= enclosingMethodDecl.resolveBinding();
fMembersToMove= membersToMove;
fNewArgumentMap= newArgumentMap;
}
@Override
public final void endVisit(final AnonymousClassDeclaration node) {
fAnonymousClassDeclaration= false;
super.endVisit(node);
}
@Override
public final void endVisit(final TypeDeclarationStatement node) {
fTypeDeclarationStatement= false;
super.endVisit(node);
}
@Override
public final boolean visit(final AnonymousClassDeclaration node) {
fAnonymousClassDeclaration= true;
return super.visit(node);
}
@Override
public final boolean visit(final ThisExpression node) {
if (!fAnonymousClassDeclaration && !fTypeDeclarationStatement) {
final AST ast= node.getAST();
List<SingleVariableDeclaration> parameters= fEnclosingMethodDeclaration.parameters();
List<String> prohibited= new ArrayList<>();
for (SingleVariableDeclaration svd : parameters) {
prohibited.add(svd.getName().getFullyQualifiedName());
}
IBinding binding= null;
if (node.getLocationInParent() == FieldAccess.EXPRESSION_PROPERTY) {
FieldAccess fieldAccess= (FieldAccess)node.getParent();
binding= fieldAccess.resolveFieldBinding();
} else if (node.getLocationInParent() == MethodInvocation.EXPRESSION_PROPERTY) {
MethodInvocation methodInvocation= (MethodInvocation)node.getParent();
binding= methodInvocation.resolveMethodBinding();
}
if (binding != null) {
IJavaElement element= binding.getJavaElement();
for (IMember member : fMembersToMove) {
if (member.equals(element)) {
if (!(member instanceof IMethod) || fNewArgumentMap.get(member) == null) {
return true;
}
MethodInvocation methodInvocation= (MethodInvocation)node.getParent();
MethodInvocation newMethodInvocation= ast.newMethodInvocation();
newMethodInvocation.setName(ast.newSimpleName(methodInvocation.getName().getIdentifier()));
final List<Expression> arguments= methodInvocation.arguments();
if (arguments != null && arguments.size() > 0) {
final ListRewrite rewriter= fRewrite.getListRewrite(newMethodInvocation, MethodInvocation.ARGUMENTS_PROPERTY);
ListRewrite oldRewriter= fRewrite.getListRewrite(methodInvocation, MethodInvocation.ARGUMENTS_PROPERTY);
ASTNode copyTarget= oldRewriter.createCopyTarget(arguments.get(0), arguments.get(arguments.size() - 1));
rewriter.insertLast(copyTarget, null);
}
newMethodInvocation.arguments().add(ast.newSimpleName(fNewArgumentMap.get(member)));
fRewrite.replace(methodInvocation, newMethodInvocation, null);
return true;
}
}
if (fEnclosingMethod != null) {
String newArgument= fNewArgumentMap.get(fEnclosingMethod.getJavaElement());
final SimpleName ref= ast.newSimpleName(newArgument);
fRewrite.replace(node, ref, null);
}
}
return true;
}
return false;
}
@Override
public final boolean visit(final MethodInvocation node) {
if (node.getExpression() instanceof ThisExpression) {
return true;
}
if (!fAnonymousClassDeclaration && !fTypeDeclarationStatement) {
final AST ast= node.getAST();
List<SingleVariableDeclaration> parameters= fEnclosingMethodDeclaration.parameters();
List<String> prohibited= new ArrayList<>();
for (SingleVariableDeclaration svd : parameters) {
prohibited.add(svd.getName().getFullyQualifiedName());
}
IMethodBinding binding= node.resolveMethodBinding();
if (binding != null) {
IJavaElement element= binding.getJavaElement();
for (IMember member : fMembersToMove) {
if (member.equals(element)) {
if (!(member instanceof IMethod) || fNewArgumentMap.get(member) == null) {
return true;
}
MethodInvocation methodInvocation= node;
MethodInvocation newMethodInvocation= ast.newMethodInvocation();
newMethodInvocation.setName(ast.newSimpleName(methodInvocation.getName().getIdentifier()));
final List<Expression> arguments= methodInvocation.arguments();
if (arguments != null && arguments.size() > 0) {
final ListRewrite rewriter= fRewrite.getListRewrite(newMethodInvocation, MethodInvocation.ARGUMENTS_PROPERTY);
ListRewrite oldRewriter= fRewrite.getListRewrite(methodInvocation, MethodInvocation.ARGUMENTS_PROPERTY);
ASTNode copyTarget= oldRewriter.createCopyTarget(arguments.get(0), arguments.get(arguments.size() - 1));
rewriter.insertLast(copyTarget, null);
}
newMethodInvocation.arguments().add(ast.newSimpleName(fNewArgumentMap.get(member)));
fRewrite.replace(methodInvocation, newMethodInvocation, null);
return true;
}
}
}
return true;
}
return false;
}
@Override
public final boolean visit(final SuperFieldAccess node) {
if (!fAnonymousClassDeclaration && !fTypeDeclarationStatement) {
final AST ast= node.getAST();
final FieldAccess access= ast.newFieldAccess();
access.setExpression(ast.newThisExpression());
access.setName(ast.newSimpleName(node.getName().getIdentifier()));
fRewrite.replace(node, access, null);
if (!fSourceRewriter.getCu().equals(fTargetRewriter.getCu()))
fSourceRewriter.getImportRemover().registerRemovedNode(node);
return true;
}
return false;
}
@Override
public final boolean visit(final SimpleType node) {
if (node.getName().isSimpleName()) {
ITypeBinding binding= node.resolveBinding();
if (binding == null) {
return false;
}
CheckTypeNameInTarget check= new CheckTypeNameInTarget(binding);
try {
fTargetRewriter.getRoot().accept(check);
} catch (AbortSearchException e) {
// do nothing
}
if (check.isQualificationRequired() && binding.getPackage() != null && !binding.getPackage().getName().isEmpty()) {
String newName= binding.getPackage().getName() + "." + node.getName().getFullyQualifiedName(); //$NON-NLS-1$
QualifiedType newQualifiedType= (QualifiedType)fRewrite.createStringPlaceholder(newName, ASTNode.QUALIFIED_TYPE);
fRewrite.replace(node, newQualifiedType, null);
return false;
}
}
return false;
}
@Override
public final boolean visit(final SuperMethodInvocation node) {
if (!fAnonymousClassDeclaration && !fTypeDeclarationStatement) {
final IBinding superBinding= node.getName().resolveBinding();
if (superBinding instanceof IMethodBinding) {
final IMethodBinding extended= (IMethodBinding) superBinding;
if (fEnclosingMethod != null && fEnclosingMethod.overrides(extended))
return true;
final ITypeBinding declaringBinding= extended.getDeclaringClass();
if (declaringBinding != null) {
final IType type= (IType) declaringBinding.getJavaElement();
if (!fSuperReferenceType.equals(type))
return true;
}
}
final AST ast= node.getAST();
final ThisExpression expression= ast.newThisExpression();
final MethodInvocation invocation= ast.newMethodInvocation();
final SimpleName simple= ast.newSimpleName(node.getName().getIdentifier());
invocation.setName(simple);
invocation.setExpression(expression);
final List<Expression> arguments= node.arguments();
if (arguments != null && arguments.size() > 0) {
final ListRewrite rewriter= fRewrite.getListRewrite(invocation, MethodInvocation.ARGUMENTS_PROPERTY);
ListRewrite superRewriter= fRewrite.getListRewrite(node, SuperMethodInvocation.ARGUMENTS_PROPERTY);
ASTNode copyTarget= superRewriter.createCopyTarget(arguments.get(0), arguments.get(arguments.size() - 1));
rewriter.insertLast(copyTarget, null);
}
fRewrite.replace(node, invocation, null);
if (!fSourceRewriter.getCu().equals(fTargetRewriter.getCu()))
fSourceRewriter.getImportRemover().registerRemovedNode(node);
return true;
}
return false;
}
@Override
public final boolean visit(final TypeDeclarationStatement node) {
fTypeDeclarationStatement= true;
return super.visit(node);
}
private class CheckTypeNameInTarget extends ASTVisitor {
private final ITypeBinding fBinding;
private boolean fQualificationRequired;
public CheckTypeNameInTarget(ITypeBinding binding) {
this.fBinding= binding;
}
@Override
public boolean visit(SimpleType node) {
if (!node.getName().isSimpleName() || !node.getName().getFullyQualifiedName().equals(fBinding.getName())) {
return false;
}
ITypeBinding binding= node.resolveBinding();
if (binding != null) {
if (!binding.isEqualTo(fBinding)) {
fQualificationRequired= true;
throw new AbortSearchException();
}
}
return false;
}
public boolean isQualificationRequired() {
return fQualificationRequired;
}
}
}
/**
* AST node visitor which performs the actual mapping.
*/
private static class NewArgumentMethodChecker extends InterruptibleVisitor {
private final Map<IMethod, String> fNewArgumentMap;
private final MethodDeclaration fEnclosingMethodDeclaration;
private final IMethodBinding fEnclosingMethod;
private final IMember[] fMembersToMove;
private final CompilationUnit fRoot;
private final Map<MethodDeclaration, Integer> fRangeMap;
private boolean fAnonymousClassDeclaration;
private boolean fTypeDeclarationStatement;
public NewArgumentMethodChecker(final Map<IMethod, String> argumentsMap, final MethodDeclaration enclosingMethodDeclaration,
IMember[] membersToMove, CompilationUnit root) {
this(argumentsMap, enclosingMethodDeclaration, membersToMove, root, null);
}
public NewArgumentMethodChecker(final Map<IMethod, String> argumentsMap, final MethodDeclaration enclosingMethodDeclaration,
IMember[] membersToMove, CompilationUnit root, Map<MethodDeclaration, Integer> rangeMap) {
fNewArgumentMap= argumentsMap;
fEnclosingMethodDeclaration= enclosingMethodDeclaration;
fEnclosingMethod= enclosingMethodDeclaration.resolveBinding();
fMembersToMove= membersToMove;
fRoot= root;
fRangeMap= rangeMap;
}
@Override
public final boolean visit(final AnonymousClassDeclaration node) {
fAnonymousClassDeclaration= true;
return super.visit(node);
}
@Override
public final void endVisit(final AnonymousClassDeclaration node) {
fAnonymousClassDeclaration= false;
super.endVisit(node);
}
@Override
public final boolean visit(final TypeDeclarationStatement node) {
fTypeDeclarationStatement= true;
return super.visit(node);
}
@Override
public final void endVisit(final TypeDeclarationStatement node) {
fTypeDeclarationStatement= false;
super.endVisit(node);
}
@Override
public final boolean visit(final ThisExpression node) {
if (fRangeMap != null) {
Integer limit= fRangeMap.get(fEnclosingMethodDeclaration);
if (limit != null) {
if (limit.intValue() >= (node.getStartPosition() + node.getLength())) {
return true;
}
}
}
if (!fAnonymousClassDeclaration && !fTypeDeclarationStatement) {
List<SingleVariableDeclaration> parameters= fEnclosingMethodDeclaration.parameters();
List<String> prohibited= new ArrayList<>();
for (SingleVariableDeclaration svd : parameters) {
prohibited.add(svd.getName().getFullyQualifiedName());
}
IBinding binding= null;
if (node.getLocationInParent() == FieldAccess.EXPRESSION_PROPERTY) {
FieldAccess fieldAccess= (FieldAccess)node.getParent();
binding= fieldAccess.resolveFieldBinding();
} else if (node.getLocationInParent() == MethodInvocation.EXPRESSION_PROPERTY) {
MethodInvocation methodInvocation= (MethodInvocation)node.getParent();
binding= methodInvocation.resolveMethodBinding();
}
if (binding != null) {
IJavaElement element= binding.getJavaElement();
for (IMember member : fMembersToMove) {
if (member.equals(element)) {
if (binding instanceof IMethodBinding && fNewArgumentMap.get(member) == null) {
MethodDeclaration method;
try {
method= ASTNodeSearchUtil.getMethodDeclarationNode((IMethod) member, fRoot);
Map<MethodDeclaration, Integer> rangeMap= fRangeMap;
if (rangeMap == null) {
rangeMap= new HashMap<>();
}
rangeMap.put(fEnclosingMethodDeclaration, Integer.valueOf(node.getStartPosition() + node.getLength()));
NewArgumentMethodChecker checker= new NewArgumentMethodChecker(fNewArgumentMap, method, fMembersToMove, fRoot, rangeMap);
checker.traverseNodeInterruptibly(method);
if (fNewArgumentMap.get(member) == null) {
return true;
}
} catch (JavaModelException e) {
// should never happen
throw new AbortSearchException();
}
}
}
}
} else if (node.getLocationInParent() == MethodInvocation.ARGUMENTS_PROPERTY) {
// we are calling a method with "this" as parameter, check what type it needs to be
MethodInvocation methodInvocation= (MethodInvocation)node.getParent();
IMethodBinding methodBinding= methodInvocation.resolveMethodBinding();
if (methodBinding != null) {
ITypeBinding[] parameterTypes= methodBinding.getParameterTypes();
List<Expression> args= methodInvocation.arguments();
int index= 0;
for (int i= 0; i < args.size(); ++i) {
if (args.get(i) == node) {
index= i;
break;
}
}
ITypeBinding thisRequiredType= parameterTypes[index];
if (!thisRequiredType.isEqualTo(node.resolveTypeBinding())) {
// we are required to call with super type or higher so we don't have to add parameter
return true;
}
}
}
if (fEnclosingMethod != null) {
IMethod method= (IMethod)fEnclosingMethod.getJavaElement();
if (method != null && fNewArgumentMap.get(method) == null) {
String[] varNames= StubUtility.getArgumentNameSuggestions(method.getJavaProject(), fEnclosingMethod.getDeclaringClass(), prohibited.toArray(new String[0]));
fNewArgumentMap.put(method, varNames[0]);
throw new AbortSearchException();
}
}
}
return false;
}
@Override
public final boolean visit(final MethodInvocation node) {
if (node.getExpression() instanceof ThisExpression) {
return true;
}
if (fRangeMap != null) {
Integer limit= fRangeMap.get(fEnclosingMethodDeclaration);
if (limit != null) {
if (limit.intValue() >= (node.getStartPosition() + node.getLength())) {
return true;
}
}
}
if (!fAnonymousClassDeclaration && !fTypeDeclarationStatement) {
List<SingleVariableDeclaration> parameters= fEnclosingMethodDeclaration.parameters();
List<String> prohibited= new ArrayList<>();
for (SingleVariableDeclaration svd : parameters) {
prohibited.add(svd.getName().getFullyQualifiedName());
}
IBinding binding= node.resolveMethodBinding();
if (binding != null) {
IJavaElement element= binding.getJavaElement();
for (IMember member : fMembersToMove) {
if (member.equals(element)) {
if (binding instanceof IMethodBinding && fNewArgumentMap.get(member) == null) {
MethodDeclaration method;
try {
method= ASTNodeSearchUtil.getMethodDeclarationNode((IMethod) member, fRoot);
Map<MethodDeclaration, Integer> rangeMap= fRangeMap;
if (rangeMap == null) {
rangeMap= new HashMap<>();
}
rangeMap.put(fEnclosingMethodDeclaration, Integer.valueOf(node.getStartPosition() + node.getLength()));
NewArgumentMethodChecker checker= new NewArgumentMethodChecker(fNewArgumentMap, method, fMembersToMove, fRoot, rangeMap);
checker.traverseNodeInterruptibly(method);
if (fNewArgumentMap.get(member) == null) {
return true;
}
} catch (JavaModelException e) {
// should never happen
throw new AbortSearchException();
}
}
if (fEnclosingMethod != null) {
IMethod enclosingMethod= (IMethod)fEnclosingMethod.getJavaElement();
if (enclosingMethod != null && fNewArgumentMap.get(enclosingMethod) == null) {
String[] varNames= StubUtility.getArgumentNameSuggestions(enclosingMethod.getJavaProject(), fEnclosingMethod.getDeclaringClass(), prohibited.toArray(new String[0]));
fNewArgumentMap.put(enclosingMethod, varNames[0]);
throw new AbortSearchException();
}
}
}
}
}
}
return true;
}
}
private class AddParameterVisitor extends ASTVisitor {
final CompilationUnitRewrite fRewrite;
final String fMethodName;
public AddParameterVisitor(CompilationUnitRewrite rewrite, String methodName) {
fRewrite= rewrite;
fMethodName= methodName;
}
@Override
public boolean visit(MethodInvocation node) {
if (node.getName().getFullyQualifiedName().equals(fMethodName)) {
ASTRewrite rewriter= fRewrite.getASTRewrite();
AST ast= fRewrite.getAST();
MethodInvocation newInvocation= ast.newMethodInvocation();
newInvocation.setName(ast.newSimpleName(fMethodName));
List<Expression> arguments= node.arguments();
for (Expression argument : arguments) {
Expression copyExpression= (Expression)rewriter.createCopyTarget(argument);
newInvocation.arguments().add(copyExpression);
}
if (node.getExpression() != null) {
boolean doNotCopyExpression= false;
if (node.getExpression() instanceof ThisExpression) {
IMember[] createdMembers= getCreatedDestinationMembers();
MethodDeclaration surroundDeclaration= ASTNodes.getFirstAncestorOrNull(node, MethodDeclaration.class);
if (surroundDeclaration != null) {
for (IMember createdMember : createdMembers) {
if (createdMember.getElementName().equals(surroundDeclaration.getName().getFullyQualifiedName())) {
doNotCopyExpression= true;
break;
}
}
}
}
if (!doNotCopyExpression) {
newInvocation.setExpression((Expression)rewriter.createCopyTarget(node.getExpression()));
newInvocation.arguments().add(rewriter.createCopyTarget(node.getExpression()));
}
}
List<Type> typeArguments= node.typeArguments();
newInvocation.typeArguments().addAll(typeArguments);
rewriter.replace(node, newInvocation, null);
}
return false;
}
}
protected static final String ATTRIBUTE_ABSTRACT= "abstract"; //$NON-NLS-1$
protected static final String ATTRIBUTE_DELETE= "delete"; //$NON-NLS-1$
protected static final String ATTRIBUTE_PULL= "pull"; //$NON-NLS-1$
protected static final String ATTRIBUTE_STUBS= "stubs"; //$NON-NLS-1$
private static final String IDENTIFIER= "org.eclipse.jdt.ui.pullUpProcessor"; //$NON-NLS-1$
/** The pull up group category set */
private static final GroupCategorySet SET_PULL_UP= new GroupCategorySet(new GroupCategory("org.eclipse.jdt.internal.corext.pullUp", //$NON-NLS-1$
RefactoringCoreMessages.PullUpRefactoring_category_name, RefactoringCoreMessages.PullUpRefactoring_category_description));
private static void addMatchingMember(final Map<IMember, Set<IMember>> mapping, final IMember key, final IMember matchingMember) {
Set<IMember> matchingSet;
if (mapping.containsKey(key)) {
matchingSet= mapping.get(key);
} else {
matchingSet= new HashSet<>();
mapping.put(key, matchingSet);
}
Assert.isTrue(!matchingSet.contains(matchingMember));
matchingSet.add(matchingMember);
}
private static Block createMethodStub(final MethodDeclaration method, final AST ast, ICompilationUnit cu, ASTRewrite rewrite, String targetTypeName) {
final Block body= ast.newBlock();
final Expression expression= ASTNodeFactory.newDefaultExpression(ast, method.getReturnType2(), method.getExtraDimensions());
try {
String delimiter= cu.findRecommendedLineSeparator();
String bodyStatement= ""; //$NON-NLS-1$
if (expression != null) {
final ReturnStatement returnStatement= ast.newReturnStatement();
returnStatement.setExpression(expression);
bodyStatement= ASTNodes.asFormattedString(returnStatement, 0, delimiter, FormatterProfileManagerCore.getProjectSettings(cu.getJavaProject()));
}
String placeHolder= CodeGeneration.getMethodBodyContent(cu, targetTypeName, method.getName().getIdentifier(), false, bodyStatement, delimiter);
if (placeHolder != null) {
ReturnStatement todoNode= (ReturnStatement) rewrite.createStringPlaceholder(placeHolder, ASTNode.RETURN_STATEMENT);
body.statements().add(todoNode);
}
} catch (CoreException e) {
// return empty body
}
return body;
}
private static Set<IType> getAffectedSubTypes(final ITypeHierarchy hierarchy, final IType type) throws JavaModelException {
IType[] types= null;
final boolean isInterface= type.isInterface();
if (isInterface) {
final Collection<IType> remove= new ArrayList<>();
final List<IType> list= new ArrayList<>(Arrays.asList(hierarchy.getSubtypes(type)));
for (IType element : list) {
if (element.isInterface())
remove.add(element);
}
list.removeAll(remove);
types= list.toArray(new IType[list.size()]);
} else
types= hierarchy.getSubclasses(type);
final Set<IType> result= new HashSet<>();
for (IType type2 : types) {
if (!isInterface && JdtFlags.isAbstract(type2))
result.addAll(getAffectedSubTypes(hierarchy, type2));
else
result.add(type2);
}
return result;
}
private static IMember[] getMembers(final IMember[] members, final int type) {
final List<IJavaElement> list= Arrays.asList(JavaElementUtil.getElementsOfType(members, type));
return list.toArray(new IMember[list.size()]);
}
private static void mergeMaps(final Map<IMember, Set<IMember>> result, final Map<IMember, Set<IMember>> map) {
for (final Entry<IMember, Set<IMember>> entry : result.entrySet()) {
final IMember key= entry.getKey();
if (map.containsKey(key)) {
final Set<IMember> resultSet= entry.getValue();
final Set<IMember> mapSet= map.get(key);
resultSet.addAll(mapSet);
}
}
}
private static void upgradeMap(final Map<IMember, Set<IMember>> result, final Map<IMember, Set<IMember>> map) {
for (final Entry<IMember, Set<IMember>> entry : map.entrySet()) {
final IMember key= entry.getKey();
if (!result.containsKey(key)) {
final Set<IMember> mapSet= entry.getValue();
final Set<IMember> resultSet= new HashSet<>(mapSet);
result.put(key, resultSet);
}
}
}
/** The methods to be declared abstract */
protected IMethod[] fAbstractMethods= new IMethod[0];
/** The cached supertype hierarchy of the declaring type */
private ITypeHierarchy fCachedDeclaringSuperTypeHierarchy;
/** The cached type hierarchy of the destination type */
private ITypeHierarchy fCachedDestinationTypeHierarchy;
/** The cached set of skipped supertypes */
private Set<IType> fCachedSkippedSuperTypes;
/** Whether an argument has been added to handle this references in pulled up methods */
private boolean fArgumentAddedToHandleThis;
/** The map of compilation units to compilation unit rewrites */
protected Map<ICompilationUnit, CompilationUnitRewrite> fCompilationUnitRewrites;
/** Should method stubs be generated in subtypes? */
protected boolean fCreateMethodStubs= true;
/** The methods to be deleted in subtypes */
protected IMethod[] fDeletedMethods= new IMethod[0];
/** The destination type */
protected IType fDestinationType;
/**
* Creates a new pull up refactoring processor.
*
* @param members
* the members to pull up
* @param settings
* the code generation settings
*/
public PullUpRefactoringProcessor(final IMember[] members, final CodeGenerationSettings settings) {
this(members, settings, false);
}
/**
* Creates a new pull up processor from refactoring arguments.
*
* @param arguments
* the refactoring arguments
* @param status
* the resulting status
*/
public PullUpRefactoringProcessor(JavaRefactoringArguments arguments, RefactoringStatus status) {
this(null, null, false);
RefactoringStatus initializeStatus= initialize(arguments);
status.merge(initializeStatus);
}
/**
* Creates a new pull up refactoring processor.
*
* @param members
* the members to pull up, or <code>null</code> if invoked by
* scripting
* @param settings
* the code generation settings, or <code>null</code> if
* invoked by scripting
* @param layer
* <code>true</code> to create a working copy layer,
* <code>false</code> otherwise
*/
protected PullUpRefactoringProcessor(final IMember[] members, final CodeGenerationSettings settings, final boolean layer) {
super(members, settings, layer);
if (members != null) {
final IType type= RefactoringAvailabilityTesterCore.getTopLevelType(fMembersToMove);
try {
if (type != null && RefactoringAvailabilityTesterCore.getPullUpMembers(type).length != 0) {
fCachedDeclaringType= RefactoringAvailabilityTesterCore.getTopLevelType(fMembersToMove);
fMembersToMove= new IMember[0];
}
} catch (JavaModelException exception) {
JavaManipulationPlugin.log(exception);
}
}
}
private void addAllRequiredPullableMembers(final List<IMember> queue, final IMember member, final IProgressMonitor monitor) throws JavaModelException {
Assert.isNotNull(queue);
Assert.isNotNull(member);
Assert.isNotNull(monitor);
{
SubMonitor subMonitor= SubMonitor.convert(monitor, RefactoringCoreMessages.PullUpRefactoring_calculating_required, 6);
final IMethod[] requiredMethods= ReferenceFinderUtil.getMethodsReferencedIn(new IJavaElement[] { member}, fOwner, subMonitor.newChild(1));
boolean isStatic= false;
{
SubMonitor sub= subMonitor.newChild(1);
sub.beginTask(RefactoringCoreMessages.PullUpRefactoring_calculating_required, requiredMethods.length);
isStatic= JdtFlags.isStatic(member);
for (IMethod requiredMethod : requiredMethods) {
if (isStatic && !JdtFlags.isStatic(requiredMethod))
continue;
if (isRequiredPullableMember(queue, requiredMethod)
&& (!MethodChecks.isVirtual(requiredMethod) || !isAvailableInDestination(requiredMethod, sub.newChild(1))))
queue.add(requiredMethod);
}
}
final IField[] requiredFields= ReferenceFinderUtil.getFieldsReferencedIn(new IJavaElement[] { member}, fOwner, subMonitor.newChild(1));
{
IProgressMonitor sub= subMonitor.newChild(1);
sub.beginTask(RefactoringCoreMessages.PullUpRefactoring_calculating_required, requiredFields.length);
isStatic= JdtFlags.isStatic(member);
for (final IField requiredField : requiredFields) {
if (isStatic && !JdtFlags.isStatic(requiredField))
continue;
if (isRequiredPullableMember(queue, requiredField))
queue.add(requiredField);
}
}
final IType[] requiredTypes= ReferenceFinderUtil.getTypesReferencedIn(new IJavaElement[] { member}, fOwner, subMonitor.newChild(1));
{
IProgressMonitor sub= subMonitor.newChild(1);
sub.beginTask(RefactoringCoreMessages.PullUpRefactoring_calculating_required, requiredMethods.length);
isStatic= JdtFlags.isStatic(member);
for (final IType requiredType : requiredTypes) {
if (isStatic && !JdtFlags.isStatic(requiredType))
continue;
if (isRequiredPullableMember(queue, requiredType))
queue.add(requiredType);
}
}
}
}
private void addMethodStubForAbstractMethod(final IMethod sourceMethod, final CompilationUnit declaringCuNode, final AbstractTypeDeclaration typeToCreateStubIn, final ICompilationUnit newCu, final CompilationUnitRewrite rewriter, final Map<IMember, IncomingMemberVisibilityAdjustment> adjustments, final IProgressMonitor monitor, final RefactoringStatus status) throws CoreException {
final MethodDeclaration methodToCreateStubFor= ASTNodeSearchUtil.getMethodDeclarationNode(sourceMethod, declaringCuNode);
final AST ast= rewriter.getRoot().getAST();
final MethodDeclaration newMethod= ast.newMethodDeclaration();
ASTRewrite astRewrite= rewriter.getASTRewrite();
newMethod.setBody(createMethodStub(methodToCreateStubFor, ast, newCu, astRewrite, Bindings.getFullyQualifiedName(typeToCreateStubIn.resolveBinding())));
newMethod.setConstructor(false);
copyExtraDimensions(methodToCreateStubFor, newMethod);
int modifiers= getModifiersWithUpdatedVisibility(sourceMethod, JdtFlags.clearFlag(Modifier.NATIVE | Modifier.ABSTRACT, methodToCreateStubFor.getModifiers()), adjustments,
monitor, false, status);
if (getDestinationType().isInterface()) {
modifiers= modifiers | Modifier.PUBLIC;
}
newMethod.modifiers().addAll(ASTNodeFactory.newModifiers(ast, modifiers));
newMethod.setName(((SimpleName) ASTNode.copySubtree(ast, methodToCreateStubFor.getName())));
final TypeVariableMaplet[] mapping= TypeVariableUtil.composeMappings(TypeVariableUtil.subTypeToSuperType(getDeclaringType(), getDestinationType()), TypeVariableUtil.superTypeToInheritedType(getDestinationType(), ((IType) typeToCreateStubIn.resolveBinding().getJavaElement())));
copyReturnType(astRewrite, getDeclaringType().getCompilationUnit(), methodToCreateStubFor, newMethod, mapping);
copyParameters(astRewrite, getDeclaringType().getCompilationUnit(), methodToCreateStubFor, newMethod, mapping);
copyThrownExceptions(methodToCreateStubFor, newMethod);
copyTypeParameters(methodToCreateStubFor, newMethod);
newMethod.setJavadoc(createJavadocForStub(typeToCreateStubIn.getName().getIdentifier(), methodToCreateStubFor, newMethod, newCu, astRewrite));
ImportRewrite importRewrite= rewriter.getImportRewrite();
ImportRewriteContext context= new ContextSensitiveImportRewriteContext(typeToCreateStubIn, importRewrite);
ImportRewriteUtil.addImports(rewriter, context, methodToCreateStubFor, new HashMap<>(), new HashMap<>(), true);
IJavaProject javaProject= newCu.getJavaProject();
CodeGenerationSettings codeGenerationSettings= JavaPreferencesSettings.getCodeGenerationSettings(javaProject);
StubUtility2Core.addOverrideAnnotation(codeGenerationSettings, javaProject, astRewrite, importRewrite, newMethod, getDeclaringType().isInterface(),
rewriter.createCategorizedGroupDescription(RefactoringCoreMessages.PullUpRefactoring_add_override_annotation, SET_PULL_UP));
astRewrite.getListRewrite(typeToCreateStubIn, typeToCreateStubIn.getBodyDeclarationsProperty()).insertAt(newMethod, BodyDeclarationRewrite.getInsertionIndex(newMethod, typeToCreateStubIn.bodyDeclarations()), rewriter.createCategorizedGroupDescription(RefactoringCoreMessages.PullUpRefactoring_add_method_stub, SET_PULL_UP));
}
private void addNecessaryMethodStubs(final List<IType> affected, final CompilationUnit root, final CompilationUnitRewrite unitRewriter, final Map<IMember, IncomingMemberVisibilityAdjustment> adjustments, final IProgressMonitor monitor, final RefactoringStatus status) throws CoreException {
final IType declaringType= getDeclaringType();
final IMethod[] methods= getAbstractMethods();
try {
SubMonitor subMonitor= SubMonitor.convert(monitor, RefactoringCoreMessages.PullUpRefactoring_checking, affected.size());
for (IType type : affected) {
if (type.equals(declaringType))
continue;
final AbstractTypeDeclaration declaration= ASTNodeSearchUtil.getAbstractTypeDeclarationNode(type, unitRewriter.getRoot());
final ICompilationUnit unit= type.getCompilationUnit();
final SubMonitor subsubMonitor= SubMonitor.convert(subMonitor.newChild(1), methods.length);
try {
for (final IMethod method : methods) {
if (null == JavaModelUtil.findMethod(method.getElementName(), method.getParameterTypes(), method.isConstructor(), type)) {
addMethodStubForAbstractMethod(method, root, declaration, unit, unitRewriter, adjustments, subsubMonitor.newChild(1), status);
}
}
} finally {
subsubMonitor.done();
}
}
} finally {
monitor.done();
}
}
@Override
protected boolean canBeAccessedFrom(final IMember member, final IType target, final ITypeHierarchy hierarchy) throws JavaModelException {
if (super.canBeAccessedFrom(member, target, hierarchy)) {
if (target.isInterface())
return true;
if (target.equals(member.getDeclaringType()))
return true;
if (target.equals(member))
return true;
if (member instanceof IMethod) {
final IMethod method= (IMethod) member;
final IMethod stub= target.getMethod(method.getElementName(), method.getParameterTypes());
if (stub.exists())
return true;
}
if (member.getDeclaringType() == null) {
if (!(member instanceof IType))
return false;
if (JdtFlags.isPublic(member))
return true;
if (!JdtFlags.isPackageVisible(member))