/*******************************************************************************

 * Copyright (c) 2007, 2008 Ericsson and others.

 * All rights reserved. This program and the accompanying materials

 * are made available under the terms of the Eclipse Public License v1.0

 * which accompanies this distribution, and is available at

 * http://www.eclipse.org/legal/epl-v10.html

 *

 * Contributors:

 *     Ericsson - Initial API and implementation

 *******************************************************************************/

package org.eclipse.cdt.dsf.mi.service;

import java.util.HashMap;

import java.util.Hashtable;

import java.util.Map;

import org.eclipse.cdt.dsf.concurrent.CountingRequestMonitor;

import org.eclipse.cdt.dsf.concurrent.DataRequestMonitor;

import org.eclipse.cdt.dsf.concurrent.Immutable;

import org.eclipse.cdt.dsf.concurrent.RequestMonitor;

import org.eclipse.cdt.dsf.datamodel.AbstractDMContext;

import org.eclipse.cdt.dsf.datamodel.AbstractDMEvent;

import org.eclipse.cdt.dsf.datamodel.DMContexts;

import org.eclipse.cdt.dsf.datamodel.IDMContext;

import org.eclipse.cdt.dsf.debug.service.IBreakpoints;

import org.eclipse.cdt.dsf.debug.service.command.ICommandControl;

import org.eclipse.cdt.dsf.debug.service.command.ICommandControlService.ICommandControlShutdownDMEvent;

import org.eclipse.cdt.dsf.gdb.internal.GdbPlugin;

import org.eclipse.cdt.dsf.mi.service.command.commands.MIBreakAfter;

import org.eclipse.cdt.dsf.mi.service.command.commands.MIBreakCondition;

import org.eclipse.cdt.dsf.mi.service.command.commands.MIBreakDelete;

import org.eclipse.cdt.dsf.mi.service.command.commands.MIBreakDisable;

import org.eclipse.cdt.dsf.mi.service.command.commands.MIBreakEnable;

import org.eclipse.cdt.dsf.mi.service.command.commands.MIBreakInsert;

import org.eclipse.cdt.dsf.mi.service.command.commands.MIBreakList;

import org.eclipse.cdt.dsf.mi.service.command.commands.MIBreakWatch;

import org.eclipse.cdt.dsf.mi.service.command.events.MIWatchpointScopeEvent;

import org.eclipse.cdt.dsf.mi.service.command.output.MIBreakInsertInfo;

import org.eclipse.cdt.dsf.mi.service.command.output.MIBreakListInfo;

import org.eclipse.cdt.dsf.mi.service.command.output.MIBreakpoint;

import org.eclipse.cdt.dsf.mi.service.command.output.MIInfo;

import org.eclipse.cdt.dsf.service.AbstractDsfService;

import org.eclipse.cdt.dsf.service.DsfServiceEventHandler;

import org.eclipse.cdt.dsf.service.DsfSession;

import org.eclipse.core.runtime.IStatus;

import org.eclipse.core.runtime.Status;

import org.osgi.framework.BundleContext;

/**

 * Initial breakpoint service implementation.

 * Implements the IBreakpoints interface.

 */

public class MIBreakpoints extends AbstractDsfService implements IBreakpoints

{

    /**

     * Breakpoint attributes markers used in the map parameters of insert/updateBreakpoint().

     * All are optional with the possible exception of TYPE. It is the responsibility of the

     * service to ensure that the set of attributes provided is sufficient to create/update

     * a valid breakpoint on the back-end.

     */

    public static final String PREFIX   = "org.eclipse.cdt.dsf.debug.breakpoint"; //$NON-NLS-1$

    // General markers

    public static final String BREAKPOINT_TYPE = PREFIX + ".type";      //$NON-NLS-1$

    public static final String BREAKPOINT      = "breakpoint";          //$NON-NLS-1$

    public static final String WATCHPOINT      = "watchpoint";          //$NON-NLS-1$

    public static final String CATCHPOINT      = "catchpoint";          //$NON-NLS-1$

    // Basic set of breakpoint attribute markers

    public static final String FILE_NAME     = PREFIX + ".fileName";    //$NON-NLS-1$

    public static final String LINE_NUMBER   = PREFIX + ".lineNumber";  //$NON-NLS-1$

    public static final String FUNCTION      = PREFIX + ".function";    //$NON-NLS-1$

    public static final String ADDRESS       = PREFIX + ".address";     //$NON-NLS-1$

    public static final String CONDITION     = PREFIX + ".condition";   //$NON-NLS-1$

    public static final String IGNORE_COUNT  = PREFIX + ".ignoreCount"; //$NON-NLS-1$

    public static final String IS_ENABLED    = PREFIX + ".isEnabled";   //$NON-NLS-1$

    // Basic set of watchpoint attribute markers

    public static final String EXPRESSION    = PREFIX + ".expression";  //$NON-NLS-1$

    public static final String READ          = PREFIX + ".read";        //$NON-NLS-1$

    public static final String WRITE         = PREFIX + ".write";       //$NON-NLS-1$

	// Services

	ICommandControl fConnection;

	// Service breakpoints tracking

	// The breakpoints are stored per context and keyed on the back-end breakpoint reference

	private Map<IBreakpointsTargetDMContext, Map<Integer, MIBreakpointDMData>> fBreakpoints =

		new HashMap<IBreakpointsTargetDMContext, Map<Integer, MIBreakpointDMData>>();

	// Error messages

	final String NULL_STRING = ""; //$NON-NLS-1$

	final String UNKNOWN_EXECUTION_CONTEXT    = "Unknown execution context";    //$NON-NLS-1$

	final String UNKNOWN_BREAKPOINT_CONTEXT   = "Unknown breakpoint context";   //$NON-NLS-1$

	final String UNKNOWN_BREAKPOINT_TYPE      = "Unknown breakpoint type";      //$NON-NLS-1$

	final String UNKNOWN_BREAKPOINT           = "Unknown breakpoint";           //$NON-NLS-1$

	final String BREAKPOINT_INSERTION_FAILURE = "Breakpoint insertion failure"; //$NON-NLS-1$

	final String WATCHPOINT_INSERTION_FAILURE = "Watchpoint insertion failure"; //$NON-NLS-1$

	final String INVALID_CONDITION            = "Invalid condition";            //$NON-NLS-1$

	///////////////////////////////////////////////////////////////////////////

	// Breakpoint Events

	///////////////////////////////////////////////////////////////////////////

    public class BreakpointsChangedEvent extends AbstractDMEvent<IBreakpointsTargetDMContext> implements IBreakpointsChangedEvent {

    	private IBreakpointDMContext[] fEventBreakpoints;

		public BreakpointsChangedEvent(IBreakpointDMContext bp) {

			super(DMContexts.getAncestorOfType(bp, IBreakpointsTargetDMContext.class));

			fEventBreakpoints = new IBreakpointDMContext[] { bp };

		}

		public IBreakpointDMContext[] getBreakpoints() {

			return fEventBreakpoints;

		}

    }

    public class BreakpointAddedEvent extends BreakpointsChangedEvent implements IBreakpointsAddedEvent {

    	public BreakpointAddedEvent(IBreakpointDMContext context) {

            super(context);

		}

    }

    public class BreakpointUpdatedEvent extends BreakpointsChangedEvent implements IBreakpointsUpdatedEvent {

        public BreakpointUpdatedEvent(IBreakpointDMContext context) {

            super(context);

        }

    }

    public class BreakpointRemovedEvent extends BreakpointsChangedEvent implements IBreakpointsRemovedEvent {

        public BreakpointRemovedEvent(IBreakpointDMContext context) {

            super(context);

        }

    }

	///////////////////////////////////////////////////////////////////////////

	// IBreakpointDMContext

	// Used to hold the back-end breakpoint references. The reference can then

	// be used to get the actual DsfMIBreakpoint.

	///////////////////////////////////////////////////////////////////////////

	@Immutable

    public static final class MIBreakpointDMContext extends AbstractDMContext implements IBreakpointDMContext {

    	// The breakpoint reference

    	private final Integer fReference;

    	/**

    	 * @param service       the Breakpoint service

    	 * @param parents       the parent contexts

    	 * @param reference     the DsfMIBreakpoint reference

    	 */

    	public MIBreakpointDMContext(MIBreakpoints service, IDMContext[] parents, int reference) {

            super(service.getSession().getId(), parents);

            fReference = reference;

        }

		/* (non-Javadoc)

    	 * @see org.eclipse.cdt.dsf.debug.service.IBreakpoints.IDsfBreakpointDMContext#getReference()

    	 */

    	public int getReference() {

    		return fReference;

    	}

        /* (non-Javadoc)

         * @see org.eclipse.cdt.dsf.datamodel.AbstractDMContext#equals(java.lang.Object)

         */

        @Override

        public boolean equals(Object obj) {

            return baseEquals(obj) && (fReference == ((MIBreakpointDMContext) obj).fReference);

        }

        /* (non-Javadoc)

         * @see org.eclipse.cdt.dsf.datamodel.AbstractDMContext#hashCode()

         */

        @Override

        public int hashCode() {

            return baseHashCode() + fReference.hashCode();

        }

        /* (non-Javadoc)

         * @see java.lang.Object#toString()

         */

        @Override

        public String toString() {

            return baseToString() + ".reference(" + fReference + ")";  //$NON-NLS-1$//$NON-NLS-2$*/

        }

    }

    ///////////////////////////////////////////////////////////////////////////

	// AbstractDsfService

	///////////////////////////////////////////////////////////////////////////

	/**

	 * The service constructor

	 * 

	 * @param session           The debugging session

	 */

	public MIBreakpoints(DsfSession session) {

		super(session);

	}

	/* (non-Javadoc)

	 * @see org.eclipse.cdt.dsf.service.AbstractDsfService#initialize(org.eclipse.cdt.dsf.concurrent.RequestMonitor)

	 */

	@Override

	public void initialize(final RequestMonitor rm) {

		super.initialize(new RequestMonitor(getExecutor(), rm) {

			@Override

			protected void handleSuccess() {

				doInitialize(rm);

			}

		});

	}

	/*

	 * Asynchronous service initialization

	 */

	private void doInitialize(final RequestMonitor rm) {

    	// Get the services references

		fConnection = getServicesTracker().getService(ICommandControl.class);

        // Register for the useful events

		getSession().addServiceEventListener(this, null);

		// Register this service

		register(new String[] { IBreakpoints.class.getName(), MIBreakpoints.class.getName() },

				new Hashtable<String, String>());

		rm.done();

	}

	/* (non-Javadoc)

	 * @see org.eclipse.cdt.dsf.service.AbstractDsfService#shutdown(org.eclipse.cdt.dsf.concurrent.RequestMonitor)

	 */

	@Override

	public void shutdown(final RequestMonitor rm) {

		unregister();

		getSession().removeServiceEventListener(this);

		rm.done();

	}

	/* (non-Javadoc)

	 * @see org.eclipse.cdt.dsf.service.AbstractDsfService#getBundleContext()

	 */

	@Override

	protected BundleContext getBundleContext() {

		return GdbPlugin.getBundleContext();

	}

	///////////////////////////////////////////////////////////////////////////

    // IServiceEventListener

    ///////////////////////////////////////////////////////////////////////////

    /**

     * This method is left for API compatibility only.

     * @nooverride This method is not intended to be re-implemented or extended by clients.

     * @noreference This method is not intended to be referenced by clients.

     */

	@DsfServiceEventHandler

	public void eventDispatched(MIWatchpointScopeEvent e) {

	    // When a watchpoint goes out of scope, it is automatically removed from

	    // the back-end. To keep our internal state synchronized, we have to

	    // remove it from our breakpoints map.

	    IBreakpointsTargetDMContext bpContext = DMContexts.getAncestorOfType(e.getDMContext(), IBreakpointsTargetDMContext.class);

	    if (bpContext != null) {

	        Map<Integer, MIBreakpointDMData> contextBps = fBreakpoints.get(bpContext);

	        if (contextBps != null) {

	            contextBps.remove(e.getNumber());

	        }

	    }

	}

    /**

     * @since 1.1

     * @nooverride This method is not intended to be re-implemented or extended by clients.

     * @noreference This method is not intended to be referenced by clients.

     */

    @DsfServiceEventHandler

    public void eventDispatched(ICommandControlShutdownDMEvent e) {

    }

	///////////////////////////////////////////////////////////////////////////

	// IBreakpoints interface

	///////////////////////////////////////////////////////////////////////////

	//-------------------------------------------------------------------------

	// getBreakpoints

	//-------------------------------------------------------------------------

	/* (non-Javadoc)

	 * @see org.eclipse.cdt.dsf.debug.service.IBreakpoints#getBreakpoints(org.eclipse.cdt.dsf.debug.service.IBreakpoints.IBreakpointsTargetDMContext, org.eclipse.cdt.dsf.concurrent.DataRequestMonitor)

	 */

	public void getBreakpoints(final IBreakpointsTargetDMContext context, final DataRequestMonitor<IBreakpointDMContext[]> drm)

	{

		// Validate the context

		if (context == null) {

       		drm.setStatus(new Status(IStatus.ERROR, GdbPlugin.PLUGIN_ID, REQUEST_FAILED, UNKNOWN_EXECUTION_CONTEXT, null));

       		drm.done();

			return;

		}

		// Select the breakpoints context map

		// If it doesn't exist then no breakpoint was ever inserted for this breakpoint space.

		// In that case, return an empty list.

		final Map<Integer, MIBreakpointDMData> breakpointContext = fBreakpoints.get(context);

		if (breakpointContext == null) {

       		drm.setData(new IBreakpointDMContext[0]);

       		drm.done();

			return;

		}

		// Execute the command

		fConnection.queueCommand(new MIBreakList(context),

			new DataRequestMonitor<MIBreakListInfo>(getExecutor(), drm) {

				@Override

				protected void handleSuccess() {

					// Refresh the breakpoints map and format the result

					breakpointContext.clear();

					MIBreakpoint[] breakpoints = getData().getMIBreakpoints();

					IBreakpointDMContext[] result = new IBreakpointDMContext[breakpoints.length];

					for (int i = 0; i < breakpoints.length; i++) {

						MIBreakpointDMData breakpoint = new MIBreakpointDMData(breakpoints[i]);

						int reference = breakpoint.getReference();

						result[i] = new MIBreakpointDMContext(MIBreakpoints.this, new IDMContext[] { context }, reference);

						breakpointContext.put(reference, breakpoint);

					}

					drm.setData(result);

					drm.done();

				}

			});

	}

	//-------------------------------------------------------------------------

	// getBreakpointDMData

	//-------------------------------------------------------------------------

	/* (non-Javadoc)

	 * @see org.eclipse.cdt.dsf.debug.service.IBreakpoints#getBreakpointDMData(org.eclipse.cdt.dsf.debug.service.IBreakpoints.IDsfBreakpointDMContext, org.eclipse.cdt.dsf.concurrent.DataRequestMonitor)

	 */

	public void getBreakpointDMData(IBreakpointDMContext dmc, DataRequestMonitor<IBreakpointDMData> drm)

	{

		// Validate the breakpoint context

		if (dmc == null) {

       		drm.setStatus(new Status(IStatus.ERROR, GdbPlugin.PLUGIN_ID, REQUEST_FAILED, UNKNOWN_BREAKPOINT_CONTEXT, null));

       		drm.done();

			return;

		}

		// Validate the breakpoint type

		MIBreakpointDMContext breakpoint;

		if (dmc instanceof MIBreakpointDMContext) {

			breakpoint = (MIBreakpointDMContext) dmc;

		}

		else {

       		drm.setStatus(new Status(IStatus.ERROR, GdbPlugin.PLUGIN_ID, REQUEST_FAILED, UNKNOWN_BREAKPOINT_TYPE, null));

       		drm.done();

			return;

		}

		// Validate the target context

		IBreakpointsTargetDMContext context = DMContexts.getAncestorOfType(breakpoint, IBreakpointsTargetDMContext.class);

		if (context == null) {

       		drm.setStatus(new Status(IStatus.ERROR, GdbPlugin.PLUGIN_ID, REQUEST_FAILED, UNKNOWN_EXECUTION_CONTEXT, null));

       		drm.done();

			return;

		}

		// Select the breakpoints context map

		Map<Integer, MIBreakpointDMData> contextBreakpoints = fBreakpoints.get(context);

		if (contextBreakpoints == null) {

       		drm.setStatus(new Status(IStatus.ERROR, GdbPlugin.PLUGIN_ID, REQUEST_FAILED, UNKNOWN_BREAKPOINT, null));

       		drm.done();

			return;

		}

		// No need to go to the back-end for this one

		IBreakpointDMData breakpointCopy = new MIBreakpointDMData(contextBreakpoints.get(breakpoint.getReference()));

		drm.setData(breakpointCopy);

		drm.done();

	}

	//-------------------------------------------------------------------------

	// insertBreakpoint

	//-------------------------------------------------------------------------

	/* (non-Javadoc)

	 * @see org.eclipse.cdt.dsf.debug.service.IBreakpoints#insertBreakpoint(org.eclipse.cdt.dsf.debug.service.IBreakpoints.IBreakpointsTargetDMContext, java.util.Map, org.eclipse.cdt.dsf.concurrent.DataRequestMonitor)

	 */

	public void insertBreakpoint(IBreakpointsTargetDMContext context, Map<String, Object> attributes, DataRequestMonitor<IBreakpointDMContext> drm) {

		// Validate the context

		if (context == null) {

       		drm.setStatus(new Status(IStatus.ERROR, GdbPlugin.PLUGIN_ID, REQUEST_FAILED, UNKNOWN_EXECUTION_CONTEXT, null));

       		drm.done();

			return;

		}

		// Select the breakpoints context map. If it doesn't exist, create it.

		Map<Integer, MIBreakpointDMData> breakpointContext = fBreakpoints.get(context);

		if (breakpointContext == null) {

			breakpointContext = new HashMap<Integer, MIBreakpointDMData>();

			fBreakpoints.put(context, breakpointContext);

		}

		// Validate the breakpoint type

		String type = (String) attributes.get(BREAKPOINT_TYPE);

		if (type == null) {

       		drm.setStatus(new Status(IStatus.ERROR, GdbPlugin.PLUGIN_ID, REQUEST_FAILED, UNKNOWN_BREAKPOINT_TYPE, null));

   			drm.done();

   			return;

		}

		// And go...

		if (type.equals(BREAKPOINT)) {

			addBreakpoint(context, attributes, drm);

		}

		else if (type.equals(WATCHPOINT)) {

			addWatchpoint(context, attributes, drm);

		}

		else {

       		drm.setStatus(new Status(IStatus.ERROR, GdbPlugin.PLUGIN_ID, REQUEST_FAILED, UNKNOWN_BREAKPOINT_TYPE, null));

   			drm.done();

		}

	}

	/**

	 * @param map

	 * @param key

	 * @param defaultValue

	 * @return

	 */

	public Object getProperty(Map<String, Object> map, String key, Object defaultValue) {

		return (map.containsKey(key) && (map.get(key) != null)) ? map.get(key) : defaultValue;

	}

	/**

	 * @param attributes

	 * @return

	 */

	private String formatLocation(Map<String, Object> attributes) {

		// Unlikely default location

		String location = (String)  getProperty(attributes, ADDRESS, NULL_STRING);

		// Get the relevant parameters

		String  fileName   = (String)  getProperty(attributes, FILE_NAME, NULL_STRING);

		Integer lineNumber = (Integer) getProperty(attributes, LINE_NUMBER, -1);

		String  function   = (String)  getProperty(attributes, FUNCTION,  NULL_STRING);

		// Fix for Bug264721

		if (fileName.contains(" ")) { //$NON-NLS-1$

			fileName = "\"" + fileName + "\"";  //$NON-NLS-1$//$NON-NLS-2$

		}

		if (!fileName.equals(NULL_STRING)) {

			if (lineNumber != -1) {

				location = fileName + ":" + lineNumber; //$NON-NLS-1$

			} else {

				location = fileName + ":" + function;   //$NON-NLS-1$

			}

		} else if (!function.equals(NULL_STRING)) {

			// function location without source

			location = function;

		} else if (location.length() > 0) {

			// address location