/*******************************************************************************
 * Copyright (c) 2010, 2012 Wind River Systems and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     Wind River Systems - initial API and implementation
 *******************************************************************************/
package org.eclipse.cdt.dsf.debug.service;

import org.eclipse.cdt.dsf.concurrent.DataRequestMonitor;
import org.eclipse.cdt.dsf.debug.service.IRunControl.IExecutionDMContext;
import org.eclipse.cdt.dsf.debug.service.IRunControl.ISuspendedDMEvent;

/**
 * Extension to the Breakpoints service which adds support for correlating
 * breakpoints and execution contexts.
 * @since 2.1
 */
public interface IBreakpointsExtension extends IBreakpoints {

	/**
	 * Event indicating that a given thread or container was suspended
	 * by the given breakpoint(s).
	 */
	public interface IBreakpointHitDMEvent extends ISuspendedDMEvent {

		/**
		 * Returns the breakpoints that suspended the thread.
		 */
		IBreakpointDMContext[] getBreakpoints();
	}

	/**
	 * If a given execution context was suspended due to hitting a breakpoint,
	 * this method should return the breakpoints which caused the thread or
	 * container to suspend.
	 * <p>
	 * If the given thread is not suspended or is not suspended at a
	 * breakpoint, an empty array or an error with an INVALID_STATE code
	 * will be returned.
	 *
	 * @param ctx Thread or container to get breakpoints for.
	 * @param rm Breakpoints that the thread or container is suspended on.
	 */
	public void getExecutionContextBreakpoints(IExecutionDMContext ctx, DataRequestMonitor<IBreakpointDMContext[]> rm);
}
