/*
* Copyright (c) 2005,2006 PMD for Eclipse Development Team
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * The end-user documentation included with the redistribution, if
* any, must include the following acknowledgement:
* "This product includes software developed in part by support from
* the Defense Advanced Research Project Agency (DARPA)"
* * Neither the name of "PMD for Eclipse Development Team" nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.sourceforge.pmd.eclipse.ui.actions;
import java.util.Iterator;
import net.sourceforge.pmd.eclipse.runtime.builder.MarkerUtil;
import net.sourceforge.pmd.eclipse.ui.model.AbstractPMDRecord;
import net.sourceforge.pmd.eclipse.ui.nls.StringKeys;
import net.sourceforge.pmd.eclipse.ui.views.ViolationOverview;
import org.apache.log4j.Logger;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IWorkspaceRoot;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IFileEditorInput;
import org.eclipse.ui.IViewActionDelegate;
import org.eclipse.ui.IViewPart;
/**
* Process "Delete PMD Markers" action menu
*
* @author phherlin
*
*/
public class PMDRemoveMarkersAction extends AbstractUIAction implements IViewActionDelegate {
private static final String VIEW_ACTION = "net.sourceforge.pmd.eclipse.ui.pmdRemoveAllMarkersAction";
private static final String OBJECT_ACTION = "net.sourceforge.pmd.eclipse.ui.pmdRemoveMarkersAction";
private static final Logger log = Logger.getLogger(PMDRemoveMarkersAction.class);
/**
* @see org.eclipse.ui.IViewActionDelegate#init(IViewPart)
*/
public void init(IViewPart view) {
// no initialization for now
}
/**
* @see org.eclipse.ui.IActionDelegate#run(IAction)
*/
public void run(IAction action) {
log.info("Remove Markers action requested");
try {
if (action.getId().equals(VIEW_ACTION)) {
final IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot();
MarkerUtil.deleteAllMarkersIn(root);
log.debug("Remove markers over the whole workspace");
} else if (action.getId().equals(OBJECT_ACTION)) {
processResource();
} else { // else action id not supported
log.warn("Cannot remove markers, action ID is not supported");
}
} catch (CoreException e) {
showErrorById(StringKeys.ERROR_CORE_EXCEPTION, e);
}
}
/**
* @see org.eclipse.ui.IActionDelegate#selectionChanged(IAction, ISelection)
*/
public void selectionChanged(IAction action, ISelection selection) {
// nothing to do
}
/**
* Process removing of makers on a resource selection (project or file)
*/
private void processResource() {
log.debug("Processing a resource");
try {
if (isViewPart()) {
// if action is run from a view, process the selected resources
final ISelection sel = targetSelection();
if (sel instanceof IStructuredSelection) {
final IStructuredSelection structuredSel = (IStructuredSelection) sel;
for (final Iterator<?> i = structuredSel.iterator(); i.hasNext();) {
final Object element = i.next();
processElement(element);
}
} else {
log.warn("The view part selection is not a structured selection !");
}
}
// if action is run from an editor, process the file currently edited
else if (isEditorPart()) {
final IEditorInput editorInput = ((IEditorPart) targetPart()).getEditorInput();
if (editorInput instanceof IFileEditorInput) {
MarkerUtil.deleteAllMarkersIn(((IFileEditorInput) editorInput).getFile());
log.debug("Remove markers on currently edited file " + ((IFileEditorInput) editorInput).getFile().getName());
} else {
log.debug("The kind of editor input is not supported. The editor input type: " + editorInput.getClass().getName());
}
}
// else, this is not supported
else {
log.debug("This action is not supported on that part. This part type is: " + targetPartClassName());
}
} catch (CoreException e) {
showErrorById(StringKeys.ERROR_CORE_EXCEPTION, e);
}
}
private void processElement(Object element) throws CoreException {
if (element instanceof AbstractPMDRecord) {
final AbstractPMDRecord record = (AbstractPMDRecord) element;
final IResource resource = record.getResource();
if (isViolationOverview()) {
((ViolationOverview)targetPart()).deleteMarkers(record);
}
log.debug("Remove markers on resource " + resource.getName());
} else if (element instanceof IAdaptable) {
final IAdaptable adaptable = (IAdaptable) element;
final IResource resource = (IResource) adaptable.getAdapter(IResource.class);
if (resource == null) {
log.warn("The selected object cannot adapt to a resource");
log.debug(" -> selected object : " + element);
} else {
MarkerUtil.deleteAllMarkersIn(resource);
log.debug("Remove markers on resrouce " + resource.getName());
}
} else {
log.warn("The selected object is not adaptable");
log.debug(" -> selected object : " + element);
}
}
}