| /******************************************************************************* |
| * Copyright (c) 2000, 2004 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Common Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/cpl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.debug.core.model; |
| |
| |
| import org.eclipse.debug.core.DebugException; |
| |
| /** |
| * Provides the ability to step into, over, and return |
| * from the current execution location. Implementations |
| * must be non-blocking. |
| * <p> |
| * Implementations should honor step filter settings in their |
| * associated debug target, as defined by <code>IStepFilters</code>. |
| * </p> |
| * <p> |
| * Clients may implement this interface. |
| * </p> |
| * @see org.eclipse.debug.core.model.IStepFilters |
| */ |
| public interface IStep { |
| /** |
| * Returns whether this element can currently perform a step into. |
| * |
| * @return whether this element can currently perform a step into |
| */ |
| public boolean canStepInto(); |
| /** |
| * Returns whether this element can currently perform a step over. |
| * |
| * @return whether this element can currently perform a step over |
| */ |
| public boolean canStepOver(); |
| /** |
| * Returns whether this element can currently perform a step return. |
| * |
| * @return whether this element can currently perform a step return |
| */ |
| public boolean canStepReturn(); |
| /** |
| * Returns whether this element is currently stepping. |
| * <p> |
| * For example, a thread is considered to be stepping |
| * after the <code>stepOver</code> call until the step over is completed, |
| * a breakpoint is reached, an exception is thrown, or the thread or debug target is |
| * terminated. |
| * </p> |
| * |
| * @return whether this element is currently stepping |
| */ |
| public boolean isStepping(); |
| /** |
| * Steps into the current statement, generating <code>RESUME</code> |
| * and <code>SUSPEND</code> events for the associated thread. Can only be called |
| * when the associated thread is suspended. Implementations must implement |
| * stepping as non-blocking. |
| * |
| * @exception DebugException on failure. Reasons include:<ul> |
| * <li>TARGET_REQUEST_FAILED - The request failed in the target</li> |
| * <li>NOT_SUPPORTED - The capability is not supported by the target</li> |
| * </ul> |
| */ |
| public void stepInto() throws DebugException; |
| /** |
| * Steps over the current statement, generating <code>RESUME</code> |
| * and <code>SUSPEND</code> events for the associated thread. Can only be called |
| * when the associated thread is suspended. Implementations must implement |
| * stepping as non-blocking. |
| * |
| * @exception DebugException on failure. Reasons include:<ul> |
| * <li>TARGET_REQUEST_FAILED - The request failed in the target</li> |
| * <li>NOT_SUPPORTED - The capability is not supported by the target</li> |
| * </ul> |
| */ |
| public void stepOver() throws DebugException; |
| /** |
| * Steps to the next return statement in the current scope, |
| * generating <code>RESUME</code> and <code>SUSPEND</code> events for |
| * the associated thread. Can only be called when the associated thread is suspended. |
| * Implementations must implement stepping as non-blocking. |
| * |
| * @exception DebugException on failure. Reasons include:<ul> |
| * <li>TARGET_REQUEST_FAILED - The request failed in the target</li> |
| * <li>NOT_SUPPORTED - The capability is not supported by the target</li> |
| * </ul> |
| */ |
| public void stepReturn() throws DebugException; |
| } |