net.sourceforge.phpeclipse.debug.core/src/net/sourceforge/phpdt/internal/debug/core/breakpoints/PHPBreakpoint.java

   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
   7
   8 Contributors:
   9     IBM Corporation - Initial implementation
  10     Vicente Fernando - www.alfersoft.com.ar
  11 **********************************************************************/
  12 package net.sourceforge.phpdt.internal.debug.core.breakpoints;
  13
  14 import net.sourceforge.phpdt.internal.debug.core.PHPDebugCorePlugin;
  15
  16 import org.eclipse.core.resources.IMarker;
  17 import org.eclipse.core.resources.IWorkspaceRunnable;
  18 import org.eclipse.core.resources.ResourcesPlugin;
  19 import org.eclipse.core.runtime.CoreException;
  20 import org.eclipse.debug.core.DebugException;
  21 import org.eclipse.debug.core.DebugPlugin;
  22 import org.eclipse.debug.core.model.Breakpoint;
  23 import org.eclipse.debug.core.model.IBreakpoint;
  24
  25 /**
  26  * A breakpoint is capable of suspending the execution of a
  27  * program at a specific location when a program is running
  28  * in debug mode. Each breakpoint has an associated marker which
  29  * stores and persists all attributes associated with a breakpoint.
  30  * <p>
  31  * A breakpoint is defined in two parts:
  32  * <ol>
  33  * <li>By an extension of kind <code>"org.eclipse.debug.core.breakpoints"</code></li>
  34  * <li>By a marker definition that corresponds to the above breakpoint extension</li>
  35  * </ol>
  36  * <p>
  37  * For example, following is a definition of corresponding breakpoint
  38  * and breakpoint marker definitions. Note that the <code>markerType</code>
  39  * attribute defined by the breakpoint extension corresponds to the
  40  * type of the marker definition.
  41  * <pre>
  42  * &lt;extension point="org.eclipse.debug.core.breakpoints"&gt;
  43  *   &lt;breakpoint
  44  *      id="com.example.Breakpoint"
  45  *      class="com.example.Breakpoint"
  46  *      markerType="com.example.BreakpointMarker"&gt;
  47  *   &lt;/breakpoint&gt;
  48  * &lt;/extension&gt;
  49  * &lt;extension point="org.eclipse.core.resources.markers"&gt;
  50  *   &lt;marker
  51  *      id="com.example.BreakpointMarker"
  52  *      super type="org.eclipse.debug.core.breakpointMarker"
  53  *      attribute name ="exampleAttribute"&gt;
  54  *   &lt;/marker&gt;
  55  * &lt;/extension&gt;
  56  * </pre>
  57  * <p>
  58  * The breakpoint manager instantiates persisted breakpoints by
  59  * traversing all markers that are a subtype of
  60  * <code>"org.eclipse.debug.core.breakpointMarker"</code>, and
  61  * instantiating the class defined by the <code>class</code> attribute
  62  * on the associated breakpoint extension. The method <code>setMarker</code>
  63  * is then called to associate a marker with the breakpoint.
  64  * </p>
  65  * <p>
  66  * Breakpoints may or may not be registered with the breakpoint manager, and
  67  * are persisted and restored as such. Since marker definitions only allow
  68  * all or none of a specific marker type to be persisted, breakpoints define
  69  * a <code>PERSISTED</code> attribute for selective persistence of breakpoints
  70  * of the same type.
  71  * </p>
  72  *
  73  * @since 2.0
  74  */
  75
  76 public abstract class PHPBreakpoint extends Breakpoint implements IBreakpoint {
  77
  78         /**
  79          * Breakpoint attribute storing a breakpoint's hit count value
  80          * (value <code>"net.sourceforge.phpeclipse.debug.hitCount"</code>). This attribute is stored as an
  81          * <code>int</code>.
  82          */
  83         protected static final String HIT_COUNT = "net.sourceforge.phpeclipse.debug.hitCount"; //$NON-NLS-1$
  84
  85         /**
  86          * Breakpoint attribute storing the fully qualified name of the type
  87          * this breakpoint is located in.
  88          * (value <code>"net.sourceforge.phpeclipse.debug.typeName"</code>). This attribute is a <code>String</code>.
  89          */
  90         protected static final String TYPE_NAME = "net.sourceforge.phpeclipse.debug.typeName"; //$NON-NLS-1$
  91
  92         /**
  93          * Root breakpoint marker type
  94          * (value <code>"org.eclipse.debug.core.breakpoint"</code>).
  95          */
  96         public static final String BREAKPOINT_MARKER = DebugPlugin.getUniqueIdentifier() + ".breakpointMarker"; //$NON-NLS-1$
  97
  98         /**
  99          * Line breakpoint marker type
 100          * (value <code>"org.eclipse.debug.core.lineBreakpoint"</code>).
 101          */
 102         public static final String LINE_BREAKPOINT_MARKER = DebugPlugin.getUniqueIdentifier() + ".lineBreakpointMarker"; //$NON-NLS-1$
 103
 104         /**
 105          * Enabled breakpoint marker attribute (value <code>"org.eclipse.debug.core.enabled"</code>).
 106          * The attribute is a <code>boolean</code> corresponding to the
 107          * enabled state of a breakpoint.
 108          *
 109          * @see org.eclipse.core.resources.IMarker#getAttribute(String, boolean)
 110          */
 111         public static final String ENABLED= "org.eclipse.debug.core.enabled"; //$NON-NLS-1$
 112
 113         /**
 114          * Debug model identifier breakpoint marker attribute (value <code>"org.eclipse.debug.core.id"</code>).
 115          * The attribute is a <code>String</code> corresponding to the
 116          * identifier of the debug model a breakpoint is associated with.
 117          */
 118         public static final String ID= "org.eclipse.debug.core.id"; //$NON-NLS-1$
 119
 120         /**
 121          * Registered breakpoint marker attribute (value <code>"org.eclipse.debug.core.registered"</code>).
 122          * The attribute is a <code>boolean</code> corresponding to
 123          * whether a breakpoint has been registered with the breakpoint manager.
 124          *
 125          * @see org.eclipse.core.resources.IMarker#getAttribute(String, boolean)
 126          */
 127         public static final String REGISTERED= "org.eclipse.debug.core.registered"; //$NON-NLS-1$
 128
 129         /**
 130          * Persisted breakpoint marker attribute (value <code>"org.eclipse.debug.core.persisted"</code>).
 131          * The attribute is a <code>boolean</code> corresponding to
 132          * whether a breakpoint is to be persisted accross workspace
 133          * invocations.
 134          *
 135          * @see org.eclipse.core.resources.IMarker#getAttribute(String, boolean)
 136          */
 137         public static final String PERSISTED= "org.eclipse.debug.core.persisted"; //$NON-NLS-1$
 138
 139         private int DBGBpNo=0;
 140
 141         public PHPBreakpoint() {
 142         }
 143
 144         /**
 145          * @see IBreakpoint#setMarker(IMarker)
 146          */
 147         public void setMarker(IMarker marker) throws CoreException {
 148                 super.setMarker(marker);
 149         }
 150
 151         /**
 152          * Add this breakpoint to the breakpoint manager,
 153          * or sets it as unregistered.
 154          */
 155         protected void register(boolean register) throws CoreException {
 156                 if (register) {
 157                         DebugPlugin.getDefault().getBreakpointManager().addBreakpoint(this);
 158                 } else {
 159                         setRegistered(false);
 160                 }
 161         }
 162
 163         /**
 164          * Execute the given workspace runnable
 165          */
 166         protected void run(IWorkspaceRunnable wr) throws DebugException {
 167                 try {
 168                         ResourcesPlugin.getWorkspace().run(wr, null);
 169                 } catch (CoreException e) {
 170                         throw new DebugException(e.getStatus());
 171                 }
 172         }
 173
 174         /**
 175          * @see IBreakpoint#getModelIdentifier()
 176          */
 177         public String getModelIdentifier() {
 178                 return PHPDebugCorePlugin.getUniqueIdentifier();
 179         }
 180
 181         public void setDBGBpNo(int bpNo) {
 182                 this.DBGBpNo= bpNo;
 183         }
 184
 185         public int getDBGBpNo() {
 186                 return this.DBGBpNo;
 187         }
 188 }