Created time: 2016-08-16 Last updated time:2016-08-17

Develop Eclipse Plugin Breakpoint on Debuger

On developing the debugger of the Eclipse Plugin Project, breakpoint is the first entry point after writing launcher.

Making Debug Breakpoint

Making breakpoint is easy. Just define it on the "plugin.xml".

Eclipse plugin xml editor

Define the ID and markert Type, and The class of the debug breakpoint.

The class implements following actions.

Creating breakpoint by using DebugPlugin class
Getting model identifier of breakpoint defined in the "plugin.xml"
Getting the model of breakpoint (ServerBreakPoint class instance) via adaptor pattern


public class AlinousScriptBreakpoint extends LineBreakpoint {
	public static final String BREAKPOINT_TYPE = "org.alinous.plugin.ui.debug";
	public static final String ASSOCIATED_MARKER = "org.alinous.plugin.debug.alinousScriptLineBreakpointMarker";
	
	public AlinousScriptBreakpoint(IResource resource, int lineNumber)
	{
		createBreakpoint(resource, lineNumber);
	}
	
	private void createBreakpoint(final IResource resource, final int lineNumber)
	{
		IWorkspaceRunnable runnable = new IWorkspaceRunnable() {
			public void run(IProgressMonitor monitor) throws CoreException {
				IMarker marker = resource.createMarker(ASSOCIATED_MARKER);
				
				Map<String, Object> attributes = new HashMap<String, Object>();
				attributes.put(IBreakpoint.ENABLED, Boolean.TRUE);
				attributes.put(IMarker.LINE_NUMBER, new Integer(lineNumber));
			    attributes.put(IBreakpoint.ID, BREAKPOINT_TYPE);
			    attributes.put(IMarker.MESSAGE, "Alinous breakpoint [line: "+ lineNumber + "]");
			    
			    setMarker(marker);
			    ensureMarker().setAttributes(attributes);
				
				// register
				DebugPlugin.getDefault().getBreakpointManager().addBreakpoint(AlinousScriptBreakpoint.this);
			}
		};
		
		ISchedulingRule rule = getMarkerRule(resource);
		try {
			ResourcesPlugin.getWorkspace().run(runnable, rule, 0, null);
		} catch (CoreException e) {
			Status status = new Status(IStatus.ERROR, Activator.PLUGIN_ID,
					1, "Failed to delete Breakpoint", e);
			Activator.getDefault().getLog().log(status);	
		}
	}

	public String getModelIdentifier()
	{
		return BREAKPOINT_TYPE;
	}

	@SuppressWarnings({ "rawtypes", "unchecked" })
	@Override
	public Object getAdapter(Class adapter) {
		if(IResource.class.equals(adapter)){
			return this.getMarker().getResource();
		}
		
		if(ServerBreakPoint.class.equals(adapter)){
			int line = -1;
			try {
				line = getLineNumber();
			} catch (CoreException e) {
				Status status = new Status(IStatus.ERROR, Activator.PLUGIN_ID,
						1, "Failed to get Breakpoint's line number.", e);
				Activator.getDefault().getLog().log(status);
				
				return null;
			}
			IResource res = this.getMarker().getResource();
			
			IPath path = res.getProjectRelativePath().removeFirstSegments(1).makeAbsolute();
			
			return new ServerBreakPoint(path.toPortableString(), line);
		}
		
		return super.getAdapter(adapter);
	}

}

Contribute Breakpoint to the Editor

The Eclipse Editor has a gutter to toggle breakpoints on the side of it.

side part of eclipse editor

In order to contribute this part to the editor, just write following code on Editor class.


public class AlinousScriptEditor extends TextEditor {

	private ColorManager colorManager;

	public AlinousScriptEditor() {
		super();
		colorManager = new ColorManager();
		setSourceViewerConfiguration(new AlinousScriptConfiguration(colorManager));
		setDocumentProvider(new AlinousScriptDocumentProvider());
	}
	public void dispose() {
		colorManager.dispose();
		super.dispose();
	}
	@Override
	protected void createActions() {
		super.createActions();
		
		IAction action = null;
		
		IVerticalRulerInfo rulerInfo= (IVerticalRulerInfo) this.getAdapter(IVerticalRulerInfo.class);
		action = new AlinousScriptToggleBreakpointAction(this, rulerInfo);
		setAction(ITextEditorActionConstants.RULER_DOUBLE_CLICK, action);
	}
	
	@Override
	@SuppressWarnings("rawtypes")
	public Object getAdapter(Class adapter) {
		if(IResource.class.equals(adapter)){
			IEditorInput editorInput = getEditorInput();
			
			return editorInput.getAdapter(IResource.class);
		}
		
		return super.getAdapter(adapter);
	}

}

In the createActions() method, it create new action class, which is AlinousScriptToggleBreakpointAction class.

The source code is below.


public class AlinousScriptToggleBreakpointAction extends Action{
	//public static final String ACTION_ID = "org.alinous.plugin.editor.toggleBreakPoint";
	
	private IEditorPart part;
	private IVerticalRulerInfo rulerInfo;

	public AlinousScriptToggleBreakpointAction(IEditorPart part, IVerticalRulerInfo rulerInfo)
	{
		this.part = part;
		this.rulerInfo = rulerInfo;
	}

	public void run() {
		int line = this.rulerInfo.getLineOfLastMouseButtonActivity() + 1;
		
		IResource resource = (IResource)this.part.getAdapter(IResource.class);
		
		IBreakpoint breakpoint = findBreakPoint(line, resource.getFullPath().toPortableString());
		
		if(breakpoint != null){
			deleteBreakpoint(breakpoint);
			return;
		}
		
		createBreakPoint(resource, line);
	}
	
	private void createBreakPoint(IResource resource, int lineNumber)
	{
		new AlinousScriptBreakpoint(resource, lineNumber);
	}
	
	private void deleteBreakpoint(IBreakpoint breakpoint)
	{
		try {
			breakpoint.delete();
		} catch (CoreException e) {
			Status status = new Status(IStatus.ERROR, Activator.PLUGIN_ID,
								1, "Failed to delete Breakpoint", e);
			Activator.getDefault().getLog().log(status);								
		}
	}
	
	private IBreakpoint findBreakPoint(int line, String filePath)
	{
		IBreakpoint[] breakpoints 
			= DebugPlugin.getDefault().getBreakpointManager().getBreakpoints(AlinousScriptBreakpoint.BREAKPOINT_TYPE);
	
		for(int i = 0; i < breakpoints.length; i++){
			LineBreakpoint breakpoint = (LineBreakpoint) breakpoints[i];
			
			IResource res = (IResource) breakpoint.getAdapter(IResource.class);
			String breakPath = res.getFullPath().toPortableString();
			int lineNumber = -1;
			try {
				lineNumber = breakpoint.getLineNumber();
			} catch (CoreException e) {
				continue;
			}
			
			if(line == lineNumber && breakPath.equals(filePath)){
				return breakpoint;
			}
			
		}
		
		return null;
	}
	
	
	
}