debug/org.eclipse.ptp.debug.ui/src/org/eclipse/ptp/debug/internal/ui/actions/ToggleBreakpointRulerAction.java

/*******************************************************************************
 * Copyright (c) 2005 The Regents of the University of California. 
 * This material was produced under U.S. Government contract W-7405-ENG-36 
 * for Los Alamos National Laboratory, which is operated by the University 
 * of California for the U.S. Department of Energy. The U.S. Government has 
 * rights to use, reproduce, and distribute this software. NEITHER THE 
 * GOVERNMENT NOR THE UNIVERSITY MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR 
 * ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is modified 
 * to produce derivative works, such modified software should be clearly marked, 
 * so as not to confuse it with the version available from LANL.
 * 
 * Additionally, 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
 * 
 * LA-CC 04-115
 *******************************************************************************/
package org.eclipse.ptp.debug.internal.ui.actions;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.dialogs.ErrorDialog;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.TextSelection;
import org.eclipse.jface.text.source.IVerticalRulerInfo;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.ptp.debug.ui.IPTPDebugUIConstants;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.texteditor.IDocumentProvider;
import org.eclipse.ui.texteditor.ITextEditor;

/**
 * @author Clement chu
 *
 */
public class ToggleBreakpointRulerAction extends Action {
	private IVerticalRulerInfo ruler = null;
	private IWorkbenchPart targetPart = null;
	private ToggleBreakpointAdapter breakpointAdapter = null;
	
	private static final ISelection EMPTY_SELECTION = new ISelection() {
		public boolean isEmpty() {
			return true;
		}
	};
    
	/** Constructor
     * @param part
     * @param ruler
     */
    public ToggleBreakpointRulerAction(IWorkbenchPart part, IVerticalRulerInfo ruler) {
		super(ActionMessages.getString("ToggleBreakpointRulerAction.Toggle_Breakpoint"));
   		this.ruler = ruler;
   		setTargetPart(part);
   		breakpointAdapter = new ToggleBreakpointAdapter();
   		setId(IPTPDebugUIConstants.ACTION_SET_BREAKPOINT);
    }
	
    /** Dispose this action
     * 
     */
    public void dispose() {
    	setTargetPart(null);
    	ruler = null;
    }
    
    /* (non-Javadoc)
     * @see org.eclipse.jface.action.IAction#run()
     */
    public void run() {
		try {
			breakpointAdapter.toggleLineBreakpoints(getTargetPart(), getTargetSelection());
		} catch(CoreException e) {
			ErrorDialog.openError(getTargetPart().getSite().getShell(), ActionMessages.getString("ToggleBreakpointRulerAction.Error_1"), ActionMessages.getString("ToggleBreakpointRulerAction.Operation_failed_1"), e.getStatus());
		}
    }

	/** Get vertical ruler info
	 * @return
	 */
	protected IVerticalRulerInfo getVerticalRulerInfo() {
		return ruler;
	}

	/** Get target workbench part
	 * @return
	 */
	private IWorkbenchPart getTargetPart() {
		return targetPart;
	}

	/** Set target workbench part
	 * @param targetPart
	 */
	private void setTargetPart(IWorkbenchPart targetPart) {
		this.targetPart = targetPart;
	}

	/** Get target selection
	 * @return
	 */
	private ISelection getTargetSelection() {
		IDocument doc = getDocument();
		if (doc != null) {
			int line = getVerticalRulerInfo().getLineOfLastMouseButtonActivity();
			try {
				IRegion region = doc.getLineInformation(line);
				return new TextSelection(doc, region.getOffset(), region.getLength());
			}
			catch(BadLocationException e) {
				DebugPlugin.log(e);
			} 
		}
		return EMPTY_SELECTION;
	}
	
	/** Get document
	 * @return
	 */
	private IDocument getDocument() {
		IWorkbenchPart targetPart = getTargetPart();
		if (targetPart instanceof ITextEditor) {
			ITextEditor textEditor = (ITextEditor)targetPart; 
			IDocumentProvider provider = textEditor.getDocumentProvider();
			if (provider != null)
				return provider.getDocument(textEditor.getEditorInput());
		}
		//TODO DisassemblyView
		return null;
	}	
}