| /******************************************************************************* |
| * Copyright (c) 2007, 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.jdt.internal.ui.fix; |
| |
| import java.util.HashSet; |
| import java.util.Map; |
| |
| import org.eclipse.core.runtime.CoreException; |
| |
| import org.eclipse.jface.text.BadLocationException; |
| import org.eclipse.jface.text.templates.Template; |
| import org.eclipse.jface.text.templates.TemplateBuffer; |
| import org.eclipse.jface.text.templates.TemplateException; |
| |
| import org.eclipse.jdt.core.ICompilationUnit; |
| import org.eclipse.jdt.core.compiler.IProblem; |
| import org.eclipse.jdt.core.dom.ASTNode; |
| import org.eclipse.jdt.core.dom.CompilationUnit; |
| |
| import org.eclipse.jdt.internal.core.manipulation.CodeTemplateContext; |
| import org.eclipse.jdt.internal.core.manipulation.CodeTemplateContextType; |
| import org.eclipse.jdt.internal.corext.fix.CleanUpConstants; |
| import org.eclipse.jdt.internal.corext.fix.UnimplementedCodeFix; |
| |
| import org.eclipse.jdt.ui.PreferenceConstants; |
| import org.eclipse.jdt.ui.cleanup.CleanUpRequirements; |
| import org.eclipse.jdt.ui.cleanup.ICleanUpFix; |
| import org.eclipse.jdt.ui.text.java.IProblemLocation; |
| |
| import org.eclipse.jdt.internal.ui.JavaPlugin; |
| |
| public class UnimplementedCodeCleanUp extends AbstractMultiFix { |
| |
| public static final String MAKE_TYPE_ABSTRACT= "cleanup.make_type_abstract_if_missing_method"; //$NON-NLS-1$ |
| |
| public UnimplementedCodeCleanUp() { |
| super(); |
| } |
| |
| public UnimplementedCodeCleanUp(Map<String, String> settings) { |
| super(settings); |
| } |
| |
| @Override |
| public String[] getStepDescriptions() { |
| if (isEnabled(CleanUpConstants.ADD_MISSING_METHODES)) |
| return new String[] { MultiFixMessages.UnimplementedCodeCleanUp_AddUnimplementedMethods_description }; |
| |
| if (isEnabled(MAKE_TYPE_ABSTRACT)) |
| return new String[] { MultiFixMessages.UnimplementedCodeCleanUp_MakeAbstract_description }; |
| |
| return null; |
| } |
| |
| @Override |
| public String getPreview() { |
| StringBuilder buf= new StringBuilder(); |
| |
| if (isEnabled(MAKE_TYPE_ABSTRACT)) { |
| buf.append("public abstract class Face implements IFace {\n"); //$NON-NLS-1$ |
| } else { |
| buf.append("public class Face implements IFace {\n"); //$NON-NLS-1$ |
| } |
| if (isEnabled(CleanUpConstants.ADD_MISSING_METHODES)) { |
| boolean createComments= Boolean.valueOf(PreferenceConstants.getPreference(PreferenceConstants.CODEGEN_ADD_COMMENTS, null)).booleanValue(); |
| if (createComments) |
| buf.append(indent(getOverridingMethodComment(), " ")); //$NON-NLS-1$ |
| |
| buf.append(" @Override\n"); //$NON-NLS-1$ |
| buf.append(" public void method() {\n"); //$NON-NLS-1$ |
| buf.append(indent(getMethodBody(), " ")); //$NON-NLS-1$ |
| buf.append(" }\n"); //$NON-NLS-1$ |
| } |
| buf.append("}\n"); //$NON-NLS-1$ |
| |
| return buf.toString(); |
| } |
| |
| @Override |
| public CleanUpRequirements getRequirements() { |
| if (!isEnabled(CleanUpConstants.ADD_MISSING_METHODES) && !isEnabled(MAKE_TYPE_ABSTRACT)) |
| return super.getRequirements(); |
| |
| return new CleanUpRequirements(true, false, false, null); |
| } |
| |
| @Override |
| protected ICleanUpFix createFix(CompilationUnit unit) throws CoreException { |
| IProblemLocation[] problemLocations= convertProblems(unit.getProblems()); |
| problemLocations= filter(problemLocations, new int[] { IProblem.AbstractMethodMustBeImplemented, IProblem.EnumConstantMustImplementAbstractMethod }); |
| |
| return UnimplementedCodeFix.createCleanUp(unit, isEnabled(CleanUpConstants.ADD_MISSING_METHODES), isEnabled(MAKE_TYPE_ABSTRACT), problemLocations); |
| } |
| |
| @Override |
| protected ICleanUpFix createFix(CompilationUnit unit, IProblemLocation[] problems) throws CoreException { |
| IProblemLocation[] problemLocations= filter(problems, new int[] { IProblem.AbstractMethodMustBeImplemented, IProblem.EnumConstantMustImplementAbstractMethod }); |
| return UnimplementedCodeFix.createCleanUp(unit, isEnabled(CleanUpConstants.ADD_MISSING_METHODES), isEnabled(MAKE_TYPE_ABSTRACT), problemLocations); |
| } |
| |
| @Override |
| public boolean canFix(ICompilationUnit compilationUnit, IProblemLocation problem) { |
| int id= problem.getProblemId(); |
| if (id == IProblem.AbstractMethodMustBeImplemented || id == IProblem.EnumConstantMustImplementAbstractMethod) |
| return isEnabled(CleanUpConstants.ADD_MISSING_METHODES) || isEnabled(MAKE_TYPE_ABSTRACT); |
| |
| return false; |
| } |
| |
| @Override |
| public int computeNumberOfFixes(CompilationUnit compilationUnit) { |
| if (!isEnabled(CleanUpConstants.ADD_MISSING_METHODES) && !isEnabled(MAKE_TYPE_ABSTRACT)) |
| return 0; |
| |
| IProblemLocation[] locations= filter(convertProblems(compilationUnit.getProblems()), new int[] { IProblem.AbstractMethodMustBeImplemented, IProblem.EnumConstantMustImplementAbstractMethod }); |
| |
| HashSet<ASTNode> types= new HashSet<>(); |
| for (IProblemLocation location : locations) { |
| ASTNode type= UnimplementedCodeFix.getSelectedTypeNode(compilationUnit, location); |
| if (type != null) { |
| types.add(type); |
| } |
| } |
| |
| return types.size(); |
| } |
| |
| private String getOverridingMethodComment() { |
| String templateName= CodeTemplateContextType.OVERRIDECOMMENT_ID; |
| |
| Template template= getCodeTemplate(templateName); |
| if (template == null) |
| return ""; //$NON-NLS-1$ |
| |
| CodeTemplateContext context= new CodeTemplateContext(template.getContextTypeId(), null, "\n"); //$NON-NLS-1$ |
| |
| context.setVariable(CodeTemplateContextType.FILENAME, "Face.java"); //$NON-NLS-1$ |
| context.setVariable(CodeTemplateContextType.PACKAGENAME, "test"); //$NON-NLS-1$ |
| context.setVariable(CodeTemplateContextType.PROJECTNAME, "TestProject"); //$NON-NLS-1$ |
| context.setVariable(CodeTemplateContextType.ENCLOSING_TYPE, "Face"); //$NON-NLS-1$ |
| context.setVariable(CodeTemplateContextType.ENCLOSING_METHOD, "method"); //$NON-NLS-1$ |
| context.setVariable(CodeTemplateContextType.RETURN_TYPE, "void"); //$NON-NLS-1$ |
| context.setVariable(CodeTemplateContextType.SEE_TO_OVERRIDDEN_TAG, "test.IFace#foo()"); //$NON-NLS-1$ |
| |
| return evaluateTemplate(template, context); |
| } |
| |
| private String getMethodBody() { |
| String templateName= CodeTemplateContextType.METHODSTUB_ID; |
| Template template= getCodeTemplate(templateName); |
| if (template == null) |
| return ""; //$NON-NLS-1$ |
| |
| CodeTemplateContext context= new CodeTemplateContext(template.getContextTypeId(), null, "\n"); //$NON-NLS-1$ |
| context.setVariable(CodeTemplateContextType.ENCLOSING_METHOD, "method"); //$NON-NLS-1$ |
| context.setVariable(CodeTemplateContextType.ENCLOSING_TYPE, "Face"); //$NON-NLS-1$ |
| context.setVariable(CodeTemplateContextType.BODY_STATEMENT, ""); //$NON-NLS-1$ |
| return evaluateTemplate(template, context); |
| } |
| |
| private static Template getCodeTemplate(String id) { |
| return JavaPlugin.getDefault().getCodeTemplateStore().findTemplateById(id); |
| } |
| |
| private String evaluateTemplate(Template template, CodeTemplateContext context) { |
| TemplateBuffer buffer; |
| try { |
| buffer= context.evaluate(template); |
| } catch (BadLocationException e) { |
| JavaPlugin.log(e); |
| return ""; //$NON-NLS-1$ |
| } catch (TemplateException e) { |
| JavaPlugin.log(e); |
| return ""; //$NON-NLS-1$ |
| } |
| if (buffer == null) |
| return ""; //$NON-NLS-1$ |
| |
| return buffer.getString(); |
| } |
| |
| private String indent(String code, String indent) { |
| if (code.length() == 0) |
| return code; |
| |
| StringBuilder buf= new StringBuilder(); |
| buf.append(indent); |
| char[] codeArray= code.toCharArray(); |
| for (char element : codeArray) { |
| buf.append(element); |
| if (element == '\n') |
| buf.append(indent); |
| } |
| buf.append("\n"); //$NON-NLS-1$ |
| |
| return buf.toString(); |
| } |
| |
| } |