/*******************************************************************************
 * Copyright (c) 2004, 2011 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ant.internal.launching.debug;

import org.eclipse.debug.core.model.IBreakpoint;

public interface IAntDebugController {

	/**
	 * Resume the Ant build
	 */
	public void resume();

	/**
	 * Suspend the Ant build
	 */
	public void suspend();

	/**
	 * Step into the current Ant task
	 */
	public void stepInto();

	/**
	 * Step over the current Ant task
	 */
	public void stepOver();

	/**
	 * The debugging session has terminated
	 * 
	 * @since 1.0.1
	 */
	public void terminate();

	/**
	 * The provided breakpoint has been added or removed depending on the <code>added</code> parameter. Updates the controller for this change.
	 * 
	 * @param breakpoint
	 *            the breakpoint that has been added or removed
	 * @param added
	 *            whether or not the breakpoint has been added
	 */
	public void handleBreakpoint(IBreakpoint breakpoint, boolean added);

	/**
	 * Retrieve the properties of the Ant build. May occur asynchronously depending on implementation.
	 */
	public void getProperties();

	/**
	 * Retrieve the stack frames of the Ant build. May occur asynchronously depending on implementation.
	 */
	public void getStackFrames();

	/**
	 * Some strings are escaped when marshalled for socket communication. The Ant debug controller will properly unescape these Strings if required.
	 * 
	 * @param value
	 *            The buffer of the string to unescape
	 * @return The unescaped string
	 */
	public StringBuffer unescapeString(StringBuffer value);
}