case-study/jdt-after/ui/org/eclipse/jdt/internal/ui/text/correction/VarargsWarningsSubProcessor.java

   1 /*******************************************************************************
   2  * Copyright (c) 2011, 2012 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11
  12 package org.eclipse.jdt.internal.ui.text.correction;
  13
  14 import java.util.Collection;
  15 import java.util.Iterator;
  16 import java.util.List;
  17
  18 import org.eclipse.swt.graphics.Image;
  19
  20 import org.eclipse.core.runtime.CoreException;
  21
  22 import org.eclipse.ui.ISharedImages;
  23
  24 import org.eclipse.jdt.core.ICompilationUnit;
  25 import org.eclipse.jdt.core.JavaModelException;
  26 import org.eclipse.jdt.core.dom.AST;
  27 import org.eclipse.jdt.core.dom.ASTNode;
  28 import org.eclipse.jdt.core.dom.ClassInstanceCreation;
  29 import org.eclipse.jdt.core.dom.CompilationUnit;
  30 import org.eclipse.jdt.core.dom.IMethodBinding;
  31 import org.eclipse.jdt.core.dom.ITypeBinding;
  32 import org.eclipse.jdt.core.dom.MarkerAnnotation;
  33 import org.eclipse.jdt.core.dom.MethodDeclaration;
  34 import org.eclipse.jdt.core.dom.MethodInvocation;
  35 import org.eclipse.jdt.core.dom.Modifier;
  36 import org.eclipse.jdt.core.dom.rewrite.ASTRewrite;
  37 import org.eclipse.jdt.core.dom.rewrite.ListRewrite;
  38
  39 import org.eclipse.jdt.internal.corext.util.JavaModelUtil;
  40 import org.eclipse.jdt.internal.corext.util.Messages;
  41
  42 import org.eclipse.jdt.ui.text.java.IInvocationContext;
  43 import org.eclipse.jdt.ui.text.java.IProblemLocation;
  44 import org.eclipse.jdt.ui.text.java.correction.ASTRewriteCorrectionProposal;
  45 import org.eclipse.jdt.ui.text.java.correction.ICommandAccess;
  46
  47 import org.eclipse.jdt.internal.ui.JavaPlugin;
  48 import org.eclipse.jdt.internal.ui.JavaPluginImages;
  49 import org.eclipse.jdt.internal.ui.text.correction.proposals.LinkedCorrectionProposal;
  50
  51 public class VarargsWarningsSubProcessor {
  52
  53         private static class AddSafeVarargsProposal extends LinkedCorrectionProposal {
  54
  55                 private IMethodBinding fMethodBinding;
  56
  57                 private MethodDeclaration fMethodDeclaration;
  58
  59                 public AddSafeVarargsProposal(String label, ICompilationUnit cu, MethodDeclaration methodDeclaration, IMethodBinding methodBinding, int relevance) {
  60                         super(label, cu, null, relevance, JavaPluginImages.get(JavaPluginImages.IMG_OBJS_JAVADOCTAG));
  61                         fMethodDeclaration= methodDeclaration;
  62                         fMethodBinding= methodBinding;
  63                 }
  64
  65                 /* (non-Javadoc)
  66                  * @see org.eclipse.jdt.internal.ui.text.correction.ASTRewriteCorrectionProposal#getRewrite()
  67                  */
  68                 @Override
  69                 protected ASTRewrite getRewrite() throws CoreException {
  70                         if (fMethodDeclaration == null) {
  71                                 CompilationUnit astRoot= ASTResolving.createQuickFixAST(getCompilationUnit(), null);
  72                                 fMethodDeclaration= (MethodDeclaration) astRoot.findDeclaringNode(fMethodBinding.getKey());
  73                         }
  74                         AST ast= fMethodDeclaration.getAST();
  75                         ASTRewrite rewrite= ASTRewrite.create(ast);
  76                         ListRewrite listRewrite= rewrite.getListRewrite(fMethodDeclaration, MethodDeclaration.MODIFIERS2_PROPERTY);
  77
  78                         MarkerAnnotation annotation= ast.newMarkerAnnotation();
  79                         String importString= createImportRewrite((CompilationUnit) fMethodDeclaration.getRoot()).addImport("java.lang.SafeVarargs"); //$NON-NLS-1$
  80                         annotation.setTypeName(ast.newName(importString));
  81                         listRewrite.insertFirst(annotation, null);
  82
  83                         // set up linked mode
  84                         addLinkedPosition(rewrite.track(annotation), true, "annotation"); //$NON-NLS-1$
  85
  86                         return rewrite;
  87                 }
  88
  89         }
  90
  91         public static void addAddSafeVarargsProposals(IInvocationContext context, IProblemLocation problem, Collection<ICommandAccess> proposals) {
  92                 ASTNode coveringNode= problem.getCoveringNode(context.getASTRoot());
  93
  94                 MethodDeclaration methodDeclaration= ASTResolving.findParentMethodDeclaration(coveringNode);
  95                 if (methodDeclaration == null)
  96                         return;
  97
  98                 IMethodBinding methodBinding= methodDeclaration.resolveBinding();
  99                 if (methodBinding == null)
 100                         return;
 101
 102                 int modifiers= methodBinding.getModifiers();
 103                 if (!Modifier.isStatic(modifiers) && !Modifier.isFinal(modifiers) && ! methodBinding.isConstructor())
 104                         return;
 105
 106                 String label= CorrectionMessages.VarargsWarningsSubProcessor_add_safevarargs_label;
 107                 AddSafeVarargsProposal proposal= new AddSafeVarargsProposal(label, context.getCompilationUnit(), methodDeclaration, null, -2);
 108                 proposals.add(proposal);
 109         }
 110
 111         public static void addAddSafeVarargsToDeclarationProposals(IInvocationContext context, IProblemLocation problem, Collection<ICommandAccess> proposals) {
 112                 if (!JavaModelUtil.is17OrHigher(context.getCompilationUnit().getJavaProject()))
 113                         return;
 114
 115                 ASTNode coveringNode= problem.getCoveringNode(context.getASTRoot());
 116                 IMethodBinding methodBinding;
 117                 if (coveringNode instanceof MethodInvocation) {
 118                         methodBinding= ((MethodInvocation) coveringNode).resolveMethodBinding();
 119                 } else if (coveringNode instanceof ClassInstanceCreation) {
 120                         methodBinding= ((ClassInstanceCreation) coveringNode).resolveConstructorBinding();
 121                 } else {
 122                         return;
 123                 }
 124                 if (methodBinding == null)
 125                         return;
 126
 127                 String label= Messages.format(CorrectionMessages.VarargsWarningsSubProcessor_add_safevarargs_to_method_label, methodBinding.getName());
 128
 129                 ITypeBinding declaringType= methodBinding.getDeclaringClass();
 130                 CompilationUnit astRoot= (CompilationUnit) coveringNode.getRoot();
 131                 if (declaringType != null && declaringType.isFromSource()) {
 132                         try {
 133                                 ICompilationUnit targetCu= ASTResolving.findCompilationUnitForBinding(context.getCompilationUnit(), astRoot, declaringType);
 134                                 if (targetCu != null) {
 135                                         AddSafeVarargsProposal proposal= new AddSafeVarargsProposal(label, targetCu, null, methodBinding.getMethodDeclaration(), -2);
 136                                         proposals.add(proposal);
 137                                 }
 138                         } catch (JavaModelException e) {
 139                                 return;
 140                         }
 141                 }
 142         }
 143
 144         public static void addRemoveSafeVarargsProposals(IInvocationContext context, IProblemLocation problem, Collection<ICommandAccess> proposals) {
 145                 ASTNode coveringNode= problem.getCoveringNode(context.getASTRoot());
 146                 if (!(coveringNode instanceof MethodDeclaration))
 147                         return;
 148
 149                 MethodDeclaration methodDeclaration= (MethodDeclaration) coveringNode;
 150                 MarkerAnnotation annotation= null;
 151
 152                 List<? extends ASTNode> modifiers= methodDeclaration.modifiers();
 153                 for (Iterator<? extends ASTNode> iterator= modifiers.iterator(); iterator.hasNext();) {
 154                         ASTNode node= iterator.next();
 155                         if (node instanceof MarkerAnnotation) {
 156                                 annotation= (MarkerAnnotation) node;
 157                                 if ("SafeVarargs".equals(annotation.resolveAnnotationBinding().getName())) { //$NON-NLS-1$
 158                                         break;
 159                                 }
 160                         }
 161                 }
 162
 163                 if (annotation == null)
 164                         return;
 165
 166                 ASTRewrite rewrite= ASTRewrite.create(coveringNode.getAST());
 167                 rewrite.remove(annotation, null);
 168
 169                 String label= CorrectionMessages.VarargsWarningsSubProcessor_remove_safevarargs_label;
 170                 Image image= JavaPlugin.getDefault().getWorkbench().getSharedImages().getImage(ISharedImages.IMG_TOOL_DELETE);
 171                 ASTRewriteCorrectionProposal proposal= new ASTRewriteCorrectionProposal(label, context.getCompilationUnit(), rewrite, 5, image);
 172                 proposals.add(proposal);
 173         }
 174
 175 }