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

 * Copyright (c) 2007, 2008 Wind River 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:

 *     Wind River - Initial API and implementation

 *     Ericsson   - Low-level breakpoints integration  

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

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

import java.util.ArrayList;

import java.util.HashMap;

import java.util.HashSet;

import java.util.Hashtable;

import java.util.LinkedList;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.concurrent.RejectedExecutionException;

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

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

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

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

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

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

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

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

import org.eclipse.cdt.dsf.internal.DsfPlugin;

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

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

import org.eclipse.core.resources.IMarkerDelta;

import org.eclipse.core.runtime.CoreException;

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.core.runtime.IStatus;

import org.eclipse.core.runtime.Status;

import org.eclipse.core.runtime.jobs.Job;

import org.eclipse.debug.core.DebugPlugin;

import org.eclipse.debug.core.IBreakpointManager;

import org.eclipse.debug.core.IBreakpointManagerListener;

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

import org.osgi.framework.BundleContext;

/**

 * 

 */

{

    /**

     * The attribute translator that this service will use to map the platform

     * versa.

     */

    private IBreakpointAttributeTranslator fAttributeTranslator;

    /**

     * DSF Debug service for creating breakpoints.

     */

    IBreakpoints fBreakpoints;

    /**

     * Platform breakpoint manager

     */

    IBreakpointManager fBreakpointManager;

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

    // Breakpoints tracking

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

    /**

     * replicated for each execution context).

     * - Context entry added/removed on start/stopTrackingBreakpoints()

     * - Augmented on breakpointAdded()

     * - Modified on breakpointChanged()

     * - Diminished on breakpointRemoved()

     */

    /**

     * Due to the very asynchronous nature of DSF, a new breakpoint request can

     * pop up at any time before an ongoing one is completed. The following set

     * is used to store requests until the ongoing operation completes.

     */

	/**

	 * @see fPendingRequests

	 */

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

    // AbstractDsfService    

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

	/**

	 * The service constructor

	 * 

	 * @param session

	 * @param debugModelId

	 */

	public BreakpointsMediator(DsfSession session, IBreakpointAttributeTranslator attributeTranslator) {

        super(session);

        fAttributeTranslator = attributeTranslator;

	}

    @Override

    public void initialize(final RequestMonitor rm) {

        // - Collect references for the services we interact with

        // - Register to interesting events

        // - Obtain the list of platform breakpoints   

        // - Register the service for interested parties

        super.initialize(

            new RequestMonitor(getExecutor(), rm) { 

                @Override

                protected void handleSuccess() {

                    doInitialize(rm);

                }});

    }

    /**

     * Asynchronous service initialization 

     * 

     * @param requestMonitor

     */

    private void doInitialize(RequestMonitor rm) {

    	// Get the services references

        fBreakpoints  = getServicesTracker().getService(IBreakpoints.class);

        fBreakpointManager = DebugPlugin.getDefault().getBreakpointManager();

        fAttributeTranslator.initialize(this);

        // Register to the useful events

        fBreakpointManager.addBreakpointListener(this);

        fBreakpointManager.addBreakpointManagerListener( this );

        // Register this service

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

				 new Hashtable<String, String>());

        rm.done();

    }

    @Override

    public void shutdown(final RequestMonitor rm) {

        // - Un-register the service

        // - Stop listening to events

        // - Remove the breakpoints installed by this service

        // 

        //  Since we are shutting down, there is no overwhelming need

        //  to keep the maps coherent...

        // Stop accepting requests and events

    	unregister();

        fBreakpointManager.removeBreakpointListener(this);

        fBreakpointManager.removeBreakpointManagerListener( this );

        fAttributeTranslator.dispose();

        // Cleanup the breakpoints that are still installed by the service.

        // Use a counting monitor which will call mom to complete the shutdown

        // after the breakpoints are un-installed (successfully or not).

        CountingRequestMonitor countingRm = new CountingRequestMonitor(getExecutor(), rm) {

            @Override

            protected void handleCompleted() {

                BreakpointsMediator.super.shutdown(rm);

            }

        };

        // We have to make a copy of the fPlatformBPs keys because uninstallBreakpoints()

        // modifies the map as it walks through it.

        List<IBreakpointsTargetDMContext> platformBPKeysCopy = new ArrayList<IBreakpointsTargetDMContext>(fPlatformBPs.size());

        platformBPKeysCopy.addAll(0, fPlatformBPs.keySet());

        for (IBreakpointsTargetDMContext dmc : platformBPKeysCopy) {

            stopTrackingBreakpoints(dmc, countingRm);

        }

        countingRm.setDoneCount(platformBPKeysCopy.size());

    }

	@Override

    protected BundleContext getBundleContext() {

        return DsfPlugin.getBundleContext();

    }

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

    // IBreakpointsManager

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

	/**

     * Install and begin tracking breakpoints for given context.  The service 

     * will keep installing new breakpoints that appear in the IDE for this 

     * context until {@link #uninstallBreakpoints(IDMContext)} is called for that

     * context.

     * @param dmc Context to start tracking breakpoints for.

     * @param rm Completion callback.

     */

        // - Augment the maps with the new execution context

        // - Install the platform breakpoints on the selected target

        // Make sure a mapping for this execution context does not already exist

		if (platformBPs != null) {

            rm.setStatus(new Status(IStatus.ERROR, DsfPlugin.PLUGIN_ID, INTERNAL_ERROR, "Context already initialized", null)); //$NON-NLS-1$

            rm.done();            

            return;

		}

        // Create entries in the breakpoint tables for the new context. These entries should only

        // be removed when this service stops tracking breakpoints for the given context.

        // Install the platform breakpoints (stored in fPlatformBPs) on the target.

		// We need to use a background thread for this operation because we are 

		// accessing the resources system to retrieve the breakpoint attributes.

		// Accessing the resources system potentially requires using global locks.

		// Also we will be calling IBreakpointAttributeTranslator which is prohibited

		// from being called on the session executor thread.

            { setSystem(true); }

			// Get the stored breakpoints from the platform BreakpointManager

			// and install them on the target

        	@Override

            protected IStatus run(IProgressMonitor monitor) {

                return Status.OK_STATUS;

            }

        }.schedule();    

    }

    /**

     */

        }

    }

    }

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

    // Back-end interface functions

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

	/**

	 * Install a new platform breakpoint on the back-end. A platform breakpoint

	 * into account.

	 *  

	 * @param dmc

	 * @param breakpoint

	 * @param rm

	 */

	private void installBreakpoint(IBreakpointsTargetDMContext dmc, final IBreakpoint breakpoint,

	{

    	// Retrieve the set of breakpoints for this context

        assert platformBPs != null;

        }

        // Update the breakpoint status when all back-end breakpoints have been installed

    	final CountingRequestMonitor installRM = new CountingRequestMonitor(getExecutor(), rm) {

			@Override

		        rm.done();

			}

		};

        // A back-end breakpoint needs to be installed for each specified attributes map.

		installRM.setDoneCount(attrsList.size());

		// Install the back-end breakpoint(s)

            fBreakpoints.insertBreakpoint(

				new DataRequestMonitor<IBreakpointDMContext>(getExecutor(), installRM) {

				@Override

                protected void handleCompleted() {

                    if (isSuccess()) {

						// Add the breakpoint back-end mapping

					installRM.done();

                }

            });

		}

	}

    /**

     * Un-install an individual breakpoint on the back-end. For one platform

     * breakpoint, there could be multiple corresponding back-end breakpoints.

     * 

     * @param dmc

     * @param breakpoint

     */

    private void uninstallBreakpoint(final IBreakpointsTargetDMContext dmc, final IBreakpoint breakpoint, 

    {

  		// Remove completion monitor

			@Override

			protected void handleCompleted() {

			}

		};