AbstractBreakpointRulerAction.java

/**
 * This file Copyright (c) 2005-2008 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain other free and open source software ("FOSS") code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ide.debug.internal.ui.actions;

import java.util.ArrayList;
import java.util.Arrays;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.model.IBreakpoint;
import org.eclipse.debug.core.model.ILineBreakpoint;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.source.IAnnotationModel;
import org.eclipse.jface.text.source.IVerticalRulerInfo;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.texteditor.AbstractMarkerAnnotationModel;
import org.eclipse.ui.texteditor.IDocumentProvider;
import org.eclipse.ui.texteditor.ITextEditor;
import org.eclipse.ui.texteditor.IUpdate;

import com.aptana.ide.debug.core.IDebugConstants;
import com.aptana.ide.debug.core.model.IJSLineBreakpoint;
import com.aptana.ide.debug.ui.DebugUiPlugin;

/**
 * @author Max Stepanov
 */
public abstract class AbstractBreakpointRulerAction extends Action implements IUpdate
{
	private IVerticalRulerInfo fInfo;
	private ITextEditor fTextEditor;
	private IBreakpoint fBreakpoint;

	/**
	 * determineBreakpoint
	 * 
	 * @return IBreakpoint
	 */
	protected IBreakpoint determineBreakpoint()
	{
		IBreakpoint[] breakpoints = DebugPlugin.getDefault().getBreakpointManager().getBreakpoints(
				IDebugConstants.ID_DEBUG_MODEL);
		IBreakpoint[] phpBreakpoints=DebugPlugin.getDefault().getBreakpointManager().getBreakpoints(
				IDebugConstants.PHP_DEBUG_MODEL);
		ArrayList<IBreakpoint>allBreakPoints=new ArrayList<IBreakpoint>();
		allBreakPoints.addAll(Arrays.asList(breakpoints));
		allBreakPoints.addAll(Arrays.asList(phpBreakpoints));
		breakpoints=new IBreakpoint[allBreakPoints.size()];
		allBreakPoints.toArray(breakpoints);
		for (int i = 0; i < breakpoints.length; i++)
		{
			IBreakpoint breakpoint = breakpoints[i];
			if (breakpoint instanceof ILineBreakpoint)
			{
				ILineBreakpoint jBreakpoint = (ILineBreakpoint) breakpoint;
				try
				{
					if (breakpointAtRulerLine(jBreakpoint))
					{
						return jBreakpoint;
					}
				}
				catch (CoreException ce)
				{
					DebugUiPlugin.log(ce);
					continue;
				}
			}
		}
		return null;
	}

	/**
	 * getInfo
	 * 
	 * @return IVerticalRulerInfo
	 */
	protected IVerticalRulerInfo getInfo()
	{
		return fInfo;
	}

	/**
	 * setInfo
	 * 
	 * @param info
	 */
	protected void setInfo(IVerticalRulerInfo info)
	{
		fInfo = info;
	}

	/**
	 * getTextEditor
	 * 
	 * @return ITextEditor
	 */
	protected ITextEditor getTextEditor()
	{
		return fTextEditor;
	}

	/**
	 * setTextEditor
	 * 
	 * @param textEditor
	 */
	protected void setTextEditor(ITextEditor textEditor)
	{
		fTextEditor = textEditor;
	}

	/**
	 * Returns the resource for which to create the marker, or <code>null</code> if there is no applicable resource.
	 * 
	 * @return the resource for which to create the marker or <code>null</code>
	 */
	protected IResource getResource()
	{
		IEditorInput input = fTextEditor.getEditorInput();
		IResource resource = (IResource) input.getAdapter(IFile.class);
		if (resource == null)
		{
			resource = (IResource) input.getAdapter(IResource.class);
		}
		return resource;
	}

	/**
	 * breakpointAtRulerLine
	 * 
	 * @param jBreakpoint
	 * @return boolean
	 * @throws CoreException
	 */
	protected boolean breakpointAtRulerLine(ILineBreakpoint jBreakpoint) throws CoreException
	{
		AbstractMarkerAnnotationModel model = getAnnotationModel();
		if (model != null)
		{
			Position position = model.getMarkerPosition(jBreakpoint.getMarker());
			if (position != null)
			{
				IDocumentProvider provider = getTextEditor().getDocumentProvider();
				IDocument doc = provider.getDocument(getTextEditor().getEditorInput());
				try
				{
					int markerLineNumber = doc.getLineOfOffset(position.getOffset());
					int rulerLine = getInfo().getLineOfLastMouseButtonActivity();
					if (rulerLine == markerLineNumber)
					{
						if (getTextEditor().isDirty())
						{
							return jBreakpoint.getLineNumber() == markerLineNumber + 1;
						}
						return true;
					}
				}
				catch (BadLocationException x)
				{
				}
			}
		}

		return false;
	}

	/**
	 * getBreakpoint
	 * 
	 * @return IBreakpoint
	 */
	protected IBreakpoint getBreakpoint()
	{
		return fBreakpoint;
	}

	/**
	 * setBreakpoint
	 * 
	 * @param breakpoint
	 */
	protected void setBreakpoint(IBreakpoint breakpoint)
	{
		fBreakpoint = breakpoint;
	}

	/**
	 * Returns the <code>AbstractMarkerAnnotationModel</code> of the editor's input.
	 * 
	 * @return the marker annotation model
	 */
	protected AbstractMarkerAnnotationModel getAnnotationModel()
	{
		IDocumentProvider provider = fTextEditor.getDocumentProvider();
		IAnnotationModel model = provider.getAnnotationModel(getTextEditor().getEditorInput());
		if (model instanceof AbstractMarkerAnnotationModel)
		{
			return (AbstractMarkerAnnotationModel) model;
		}
		return null;
	}
}