/*******************************************************************************
* Copyright (c) 2000, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.internal.ui.text.java.hover;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IResource;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.ToolBarManager;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.text.IInformationControl;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.contentassist.ICompletionProposal;
import org.eclipse.jface.text.source.Annotation;
import org.eclipse.jface.text.source.IAnnotationModel;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.dialogs.PreferencesUtil;
import org.eclipse.ui.texteditor.MarkerAnnotation;
import org.eclipse.ui.texteditor.spelling.SpellingAnnotation;
import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.compiler.IProblem;
import org.eclipse.jdt.internal.corext.util.Messages;
import org.eclipse.jdt.ui.JavaElementLabels;
import org.eclipse.jdt.ui.JavaUI;
import org.eclipse.jdt.ui.SharedASTProvider;
import org.eclipse.jdt.ui.text.java.CompletionProposalComparator;
import org.eclipse.jdt.ui.text.java.IInvocationContext;
import org.eclipse.jdt.ui.text.java.IJavaCompletionProposal;
import org.eclipse.jdt.ui.text.java.IProblemLocation;
import org.eclipse.jdt.internal.ui.JavaPluginImages;
import org.eclipse.jdt.internal.ui.dialogs.OptionalMessageDialog;
import org.eclipse.jdt.internal.ui.javaeditor.EditorUtility;
import org.eclipse.jdt.internal.ui.javaeditor.IJavaAnnotation;
import org.eclipse.jdt.internal.ui.preferences.JavadocProblemsConfigurationBlock;
import org.eclipse.jdt.internal.ui.preferences.JavadocProblemsPreferencePage;
import org.eclipse.jdt.internal.ui.preferences.OptionsConfigurationBlock;
import org.eclipse.jdt.internal.ui.preferences.OptionsConfigurationBlock.Key;
import org.eclipse.jdt.internal.ui.preferences.ProblemSeveritiesConfigurationBlock;
import org.eclipse.jdt.internal.ui.preferences.ProblemSeveritiesPreferencePage;
import org.eclipse.jdt.internal.ui.text.correction.AssistContext;
import org.eclipse.jdt.internal.ui.text.correction.JavaCorrectionProcessor;
import org.eclipse.jdt.internal.ui.text.correction.ProblemLocation;
/**
* This annotation hover shows the description of the
* selected java annotation.
*
* XXX: Currently this problem hover only works for Java and spelling problems,
* see https://bugs.eclipse.org/bugs/show_bug.cgi?id=62081
*
* @since 3.0
*/
public class ProblemHover extends AbstractAnnotationHover {
/**
* Action to configure the problem severity of a compiler option.
*
* @since 3.4
*/
private static final class ConfigureProblemSeverityAction extends Action {
private static final String CONFIGURE_PROBLEM_SEVERITY_DIALOG_ID= "configure_problem_severity_dialog_id"; //$NON-NLS-1$
private final IJavaProject fProject;
private final String fOptionId;
private final boolean fIsJavadocOption;
private final IInformationControl fInfoControl;
public ConfigureProblemSeverityAction(IJavaProject project, String optionId, boolean isJavadocOption, IInformationControl infoControl) {
super();
fProject= project;
fOptionId= optionId;
fIsJavadocOption= isJavadocOption;
fInfoControl= infoControl;
setImageDescriptor(JavaPluginImages.DESC_ELCL_CONFIGURE_PROBLEM_SEVERITIES);
setDisabledImageDescriptor(JavaPluginImages.DESC_DLCL_CONFIGURE_PROBLEM_SEVERITIES);
setToolTipText(JavaHoverMessages.ProblemHover_action_configureProblemSeverity);
}
/* (non-Javadoc)
* @see org.eclipse.jface.action.Action#run()
*/
@Override
public void run() {
boolean showPropertyPage;
Shell shell= PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell();
if (! hasProjectSpecificOptions()) {
String message= Messages.format(
JavaHoverMessages.ProblemHover_chooseSettingsTypeDialog_message,
new Object[] { JavaElementLabels.getElementLabel(fProject, JavaElementLabels.ALL_DEFAULT) });
String[] buttons= new String[] {
JavaHoverMessages.ProblemHover_chooseSettingsTypeDialog_button_project,
JavaHoverMessages.ProblemHover_chooseSettingsTypeDialog_button_workspace,
JavaHoverMessages.ProblemHover_chooseSettingsTypeDialog_button_cancel };
int result= OptionalMessageDialog.open(
CONFIGURE_PROBLEM_SEVERITY_DIALOG_ID, shell, JavaHoverMessages.ProblemHover_chooseSettingsTypeDialog_title, null, message, MessageDialog.QUESTION, buttons, 0,
JavaHoverMessages.ProblemHover_chooseSettingsTypeDialog_checkBox_dontShowAgain);
if (result == OptionalMessageDialog.NOT_SHOWN) {
showPropertyPage= false;
} else if (result == 2 || result == SWT.DEFAULT) {
return;
} else if (result == 0) {
showPropertyPage= true;
} else {
showPropertyPage= false;
}
} else {
showPropertyPage= true;
}
Map<String, Object> data= new HashMap<String, Object>();
String pageId;
if (fIsJavadocOption) {
if (showPropertyPage) {
pageId= JavadocProblemsPreferencePage.PROP_ID;
data.put(JavadocProblemsPreferencePage.DATA_USE_PROJECT_SPECIFIC_OPTIONS, Boolean.TRUE);
} else {
pageId= JavadocProblemsPreferencePage.PREF_ID;
}
data.put(JavadocProblemsPreferencePage.DATA_SELECT_OPTION_KEY, fOptionId);
data.put(JavadocProblemsPreferencePage.DATA_SELECT_OPTION_QUALIFIER, JavaCore.PLUGIN_ID);
} else {
if (showPropertyPage) {
pageId= ProblemSeveritiesPreferencePage.PROP_ID;
data.put(ProblemSeveritiesPreferencePage.USE_PROJECT_SPECIFIC_OPTIONS, Boolean.TRUE);
} else {
pageId= ProblemSeveritiesPreferencePage.PREF_ID;
}
data.put(ProblemSeveritiesPreferencePage.DATA_SELECT_OPTION_KEY, fOptionId);
data.put(ProblemSeveritiesPreferencePage.DATA_SELECT_OPTION_QUALIFIER, JavaCore.PLUGIN_ID);
}
fInfoControl.dispose(); //FIXME: should have protocol to hide, rather than dispose
if (showPropertyPage) {
PreferencesUtil.createPropertyDialogOn(shell, fProject, pageId, null, data).open();
} else {
PreferencesUtil.createPreferenceDialogOn(shell, pageId, null, data).open();
}
}
private boolean hasProjectSpecificOptions() {
Key[] keys= fIsJavadocOption ? JavadocProblemsConfigurationBlock.getKeys() : ProblemSeveritiesConfigurationBlock.getKeys();
return OptionsConfigurationBlock.hasProjectSpecificOptions(fProject.getProject(), keys, null);
}
}
protected static class ProblemInfo extends AnnotationInfo {
private static final ICompletionProposal[] NO_PROPOSALS= new ICompletionProposal[0];
public ProblemInfo(Annotation annotation, Position position, ITextViewer textViewer) {
super(annotation, position, textViewer);
}
/*
* @see org.eclipse.jdt.internal.ui.text.java.hover.AbstractAnnotationHover.AnnotationInfo#getCompletionProposals()
*/
@Override
public ICompletionProposal[] getCompletionProposals() {
if (annotation instanceof IJavaAnnotation) {
ICompletionProposal[] result= getJavaAnnotationFixes((IJavaAnnotation) annotation);
if (result.length > 0)
return result;
}
if (annotation instanceof MarkerAnnotation)
return getMarkerAnnotationFixes((MarkerAnnotation) annotation);
return NO_PROPOSALS;
}
private ICompletionProposal[] getJavaAnnotationFixes(IJavaAnnotation javaAnnotation) {
ProblemLocation location= new ProblemLocation(position.getOffset(), position.getLength(), javaAnnotation);
ICompilationUnit cu= javaAnnotation.getCompilationUnit();
if (cu == null)
return NO_PROPOSALS;
ISourceViewer sourceViewer= null;
if (viewer instanceof ISourceViewer)
sourceViewer= (ISourceViewer) viewer;
IInvocationContext context= new AssistContext(cu, sourceViewer, location.getOffset(), location.getLength(), SharedASTProvider.WAIT_ACTIVE_ONLY);
if (!SpellingAnnotation.TYPE.equals(javaAnnotation.getType()) && !hasProblem(context.getASTRoot().getProblems(), location))
return NO_PROPOSALS;
ArrayList<IJavaCompletionProposal> proposals= new ArrayList<IJavaCompletionProposal>();
JavaCorrectionProcessor.collectCorrections(context, new IProblemLocation[] { location }, proposals);
Collections.sort(proposals, new CompletionProposalComparator());
return proposals.toArray(new ICompletionProposal[proposals.size()]);
}
private static boolean hasProblem(IProblem[] problems, IProblemLocation location) {
for (int i= 0; i < problems.length; i++) {
IProblem problem= problems[i];
if (problem.getID() == location.getProblemId() && problem.getSourceStart() == location.getOffset())
return true;
}
return false;
}
private ICompletionProposal[] getMarkerAnnotationFixes(MarkerAnnotation markerAnnotation) {
if (markerAnnotation.isQuickFixableStateSet() && !markerAnnotation.isQuickFixable())
return NO_PROPOSALS;
IMarker marker= markerAnnotation.getMarker();
ICompilationUnit cu= getCompilationUnit(marker);
if (cu == null)
return NO_PROPOSALS;
IEditorInput input= EditorUtility.getEditorInput(cu);
if (input == null)
return NO_PROPOSALS;
IAnnotationModel model= JavaUI.getDocumentProvider().getAnnotationModel(input);
if (model == null)
return NO_PROPOSALS;
ISourceViewer sourceViewer= null;
if (viewer instanceof ISourceViewer)
sourceViewer= (ISourceViewer) viewer;
AssistContext context= new AssistContext(cu, sourceViewer, position.getOffset(), position.getLength());
ArrayList<IJavaCompletionProposal> proposals= new ArrayList<IJavaCompletionProposal>();
JavaCorrectionProcessor.collectProposals(context, model, new Annotation[] { markerAnnotation }, true, false, proposals);
return proposals.toArray(new ICompletionProposal[proposals.size()]);
}
private static ICompilationUnit getCompilationUnit(IMarker marker) {
IResource res= marker.getResource();
if (res instanceof IFile && res.isAccessible()) {
IJavaElement element= JavaCore.create((IFile) res);
if (element instanceof ICompilationUnit)
return (ICompilationUnit) element;
}
return null;
}
/*
* @see org.eclipse.jdt.internal.ui.text.java.hover.AbstractAnnotationHover.AnnotationInfo#fillToolBar(org.eclipse.jface.action.ToolBarManager)
*/
@Override
public void fillToolBar(ToolBarManager manager, IInformationControl infoControl) {
super.fillToolBar(manager, infoControl);
if (!(annotation instanceof IJavaAnnotation))
return;
IJavaAnnotation javaAnnotation= (IJavaAnnotation) annotation;
String optionId= JavaCore.getOptionForConfigurableSeverity(javaAnnotation.getId());
if (optionId != null) {
IJavaProject javaProject= javaAnnotation.getCompilationUnit().getJavaProject();
boolean isJavadocProblem= (javaAnnotation.getId() & IProblem.Javadoc) != 0;
ConfigureProblemSeverityAction problemSeverityAction= new ConfigureProblemSeverityAction(javaProject, optionId, isJavadocProblem, infoControl);
manager.add(problemSeverityAction);
}
}
}
public ProblemHover() {
super(false);
}
@Override
protected AnnotationInfo createAnnotationInfo(Annotation annotation, Position position, ITextViewer textViewer) {
return new ProblemInfo(annotation, position, textViewer);
}
}