1 /**********************************************************************
2 Copyright (c) 2000, 2002 IBM Corp. and others.
3 All rights reserved. This program and the accompanying materials
4 are made available under the terms of the Common Public License v1.0
5 which accompanies this distribution, and is available at
6 http://www.eclipse.org/legal/cpl-v10.html
9 IBM Corporation - Initial implementation
10 Vicente Fernando - www.alfersoft.com.ar
11 **********************************************************************/
12 package net.sourceforge.phpdt.internal.debug.core.breakpoints;
14 import net.sourceforge.phpdt.internal.debug.core.PHPDebugCorePlugin;
15 import org.eclipse.core.resources.IWorkspaceRunnable;
16 import org.eclipse.core.resources.IMarker;
17 import org.eclipse.core.resources.ResourcesPlugin;
18 import org.eclipse.core.runtime.CoreException;
19 import org.eclipse.debug.core.DebugPlugin;
20 import org.eclipse.debug.core.DebugException;
21 import org.eclipse.debug.core.model.IBreakpoint;
22 import org.eclipse.debug.core.model.Breakpoint;
25 * A breakpoint is capable of suspending the execution of a
26 * program at a specific location when a program is running
27 * in debug mode. Each breakpoint has an associated marker which
28 * stores and persists all attributes associated with a breakpoint.
30 * A breakpoint is defined in two parts:
32 * <li>By an extension of kind <code>"org.eclipse.debug.core.breakpoints"</code></li>
33 * <li>By a marker definition that corresponds to the above breakpoint extension</li>
36 * For example, following is a definition of corresponding breakpoint
37 * and breakpoint marker definitions. Note that the <code>markerType</code>
38 * attribute defined by the breakpoint extension corresponds to the
39 * type of the marker definition.
41 * <extension point="org.eclipse.debug.core.breakpoints">
43 * id="com.example.Breakpoint"
44 * class="com.example.Breakpoint"
45 * markerType="com.example.BreakpointMarker">
48 * <extension point="org.eclipse.core.resources.markers">
50 * id="com.example.BreakpointMarker"
51 * super type="org.eclipse.debug.core.breakpointMarker"
52 * attribute name ="exampleAttribute">
57 * The breakpoint manager instantiates persisted breakpoints by
58 * traversing all markers that are a subtype of
59 * <code>"org.eclipse.debug.core.breakpointMarker"</code>, and
60 * instantiating the class defined by the <code>class</code> attribute
61 * on the associated breakpoint extension. The method <code>setMarker</code>
62 * is then called to associate a marker with the breakpoint.
65 * Breakpoints may or may not be registered with the breakpoint manager, and
66 * are persisted and restored as such. Since marker definitions only allow
67 * all or none of a specific marker type to be persisted, breakpoints define
68 * a <code>PERSISTED</code> attribute for selective persistence of breakpoints
75 public abstract class PHPBreakpoint extends Breakpoint implements IBreakpoint {
78 * Breakpoint attribute storing a breakpoint's hit count value
79 * (value <code>"net.sourceforge.phpeclipse.debug.hitCount"</code>). This attribute is stored as an
82 protected static final String HIT_COUNT = "net.sourceforge.phpeclipse.debug.hitCount"; //$NON-NLS-1$
85 * Breakpoint attribute storing the fully qualified name of the type
86 * this breakpoint is located in.
87 * (value <code>"net.sourceforge.phpeclipse.debug.typeName"</code>). This attribute is a <code>String</code>.
89 protected static final String TYPE_NAME = "net.sourceforge.phpeclipse.debug.typeName"; //$NON-NLS-1$
92 * Root breakpoint marker type
93 * (value <code>"org.eclipse.debug.core.breakpoint"</code>).
95 public static final String BREAKPOINT_MARKER = DebugPlugin.getUniqueIdentifier() + ".breakpointMarker"; //$NON-NLS-1$
98 * Line breakpoint marker type
99 * (value <code>"org.eclipse.debug.core.lineBreakpoint"</code>).
101 public static final String LINE_BREAKPOINT_MARKER = DebugPlugin.getUniqueIdentifier() + ".lineBreakpointMarker"; //$NON-NLS-1$
104 * Enabled breakpoint marker attribute (value <code>"org.eclipse.debug.core.enabled"</code>).
105 * The attribute is a <code>boolean</code> corresponding to the
106 * enabled state of a breakpoint.
108 * @see org.eclipse.core.resources.IMarker#getAttribute(String, boolean)
110 public static final String ENABLED= "org.eclipse.debug.core.enabled"; //$NON-NLS-1$
113 * Debug model identifier breakpoint marker attribute (value <code>"org.eclipse.debug.core.id"</code>).
114 * The attribute is a <code>String</code> corresponding to the
115 * identifier of the debug model a breakpoint is associated with.
117 public static final String ID= "org.eclipse.debug.core.id"; //$NON-NLS-1$
120 * Registered breakpoint marker attribute (value <code>"org.eclipse.debug.core.registered"</code>).
121 * The attribute is a <code>boolean</code> corresponding to
122 * whether a breakpoint has been registered with the breakpoint manager.
124 * @see org.eclipse.core.resources.IMarker#getAttribute(String, boolean)
126 public static final String REGISTERED= "org.eclipse.debug.core.registered"; //$NON-NLS-1$
129 * Persisted breakpoint marker attribute (value <code>"org.eclipse.debug.core.persisted"</code>).
130 * The attribute is a <code>boolean</code> corresponding to
131 * whether a breakpoint is to be persisted accross workspace
134 * @see org.eclipse.core.resources.IMarker#getAttribute(String, boolean)
136 public static final String PERSISTED= "org.eclipse.debug.core.persisted"; //$NON-NLS-1$
138 private int DBGBpNo=0;
140 public PHPBreakpoint() {
144 * @see IBreakpoint#setMarker(IMarker)
146 public void setMarker(IMarker marker) throws CoreException {
147 super.setMarker(marker);
151 * Add this breakpoint to the breakpoint manager,
152 * or sets it as unregistered.
154 protected void register(boolean register) throws CoreException {
156 DebugPlugin.getDefault().getBreakpointManager().addBreakpoint(this);
158 setRegistered(false);
163 * Execute the given workspace runnable
165 protected void run(IWorkspaceRunnable wr) throws DebugException {
167 ResourcesPlugin.getWorkspace().run(wr, null);
168 } catch (CoreException e) {
169 throw new DebugException(e.getStatus());
174 * @see IBreakpoint#getModelIdentifier()
176 public String getModelIdentifier() {
177 if (PHPDebugCorePlugin.getDefault() == null) {
178 // If the default instance is not yet initialized,
179 // return a static identifier. This identifier must
180 // match the plugin id defined in plugin.xml
181 return "net.sourceforge.phpeclipse.debug.core"; //$NON-NLS-1$
183 return PHPDebugCorePlugin.getDefault().getDescriptor().getUniqueIdentifier();
186 public void setDBGBpNo(int bpNo) {
190 public int getDBGBpNo() {