/*
    * Created on 06.12.2004
    *
    */
   package org.apache.commons.jelly.eclipse.ui;
   
   
   import org.eclipse.core.resources.IFile;
   import org.eclipse.core.resources.IProject;
  import org.eclipse.core.runtime.CoreException;
  import org.eclipse.debug.core.DebugPlugin;
  import org.eclipse.debug.core.ILaunchConfiguration;
  import org.eclipse.debug.core.ILaunchConfigurationType;
  import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy;
  import org.eclipse.debug.core.ILaunchManager;
  import org.eclipse.debug.ui.ILaunchShortcut;
  import org.eclipse.jface.viewers.ISelection;
  import org.eclipse.jface.viewers.IStructuredSelection;
  import org.eclipse.ui.IEditorPart;
  
  
  /***
   * Launcher shortcut implementation for the Eclipse 3 platform
   * @author Juergen Mayrbaeurl
   * @since 0.9
   */
  public class JellyLauncherShortcutImpl implements ILaunchShortcut 
  {
  	/***
  	 * Default constructor
  	 */
  	public JellyLauncherShortcutImpl() {
  		super();
  	}
  
  	// ILaunchshortcut Interface implementation
  	/* (non-Javadoc)
  	 * @see org.eclipse.debug.ui.ILaunchShortcut#launch(org.eclipse.jface.viewers.ISelection, java.lang.String)
  	 */
  	public void launch(ISelection selection, String mode) 
  	{		
  		// Only structured selections are supported
  		if (selection instanceof IStructuredSelection) {
  			searchAndLaunch(((IStructuredSelection)selection).toArray(), mode);
  		} 
  	}
  	
  	// IMPLEMENTATION
  	/***
  	 * Launches the first entry in the <code>search</code> array of IFile entries
  	 * @param search array of IFile entries (selected project Jelly script file)
  	 * @param mode run or debug (selected by user)
  	 */
  	protected void searchAndLaunch(Object[] search, String mode) 
  	{
  		if (search != null) 
  		{
  			// We'll launch the first IFile entry, if it exists
  			if (search.length == 0) {
  				return;
  			}	
  			
  			// Get the first entry in the array and check if it's a file resource
  			Object object = search[0];
  		    if (object instanceof IFile) 
  		    {
  		         IFile file = (IFile) object;
  		         this.launch(file, mode);
  		    }
  		}
  	}
  
  	/* (non-Javadoc)
  	 * @see org.eclipse.debug.ui.ILaunchShortcut#launch(org.eclipse.ui.IEditorPart, java.lang.String)
  	 */
  	public void launch(IEditorPart arg0, String arg1) 
  	{
  		// Launching from the editor is currently not supported
  		JellyLauncherPlugin.getDefault().showNotImplemented();
  	}
  
  	/***
  	 * Launches Jelly with the specified Jelly script file and user selected mode
  	 * @param script Jelly script file
  	 * @param mode run or debug mode, selected by the user
  	 */
  	private void launch(IFile script, String mode)
  	{
  		try {
  			// Find or create launch configuration for the Jelly script file
  			ILaunchConfiguration config = this.findLaunchConfiguration(script, mode);
  			if(config != null)
  				config.launch(mode, null);
  		} catch (CoreException e) {
  			// Log and show error message
  			JellyLauncherPlugin.getDefault().showErrorForException(JellyLaunchConfigurationConstants.ERR_LAUNCHING_SHORTCUT, e);
  		}
  	}
  	
 	/***
 	 * Finds the launch configuration for the Jelly script file. If no launch configuration
 	 * exists, a new launch configuration will be created and added to the launch
 	 * configuration types list.
 	 * @param script Jelly script file
 	 * @param mode run or debug
 	 * @return the Eclipse launch configuration for the Jelly script
 	 * @throws CoreException Eclipse platform exception
 	 */
 	private ILaunchConfiguration findLaunchConfiguration(IFile script, String mode)
 		throws CoreException
 	{
 		// Get the launch manager from the Debug plugin of Eclipse
 		ILaunchManager manager = DebugPlugin.getDefault().getLaunchManager();
 		// Get the launch configuration type for Jelly
 		ILaunchConfigurationType type = manager.getLaunchConfigurationType(JellyLauncherPlugin.getResourceString("jelly.launchConfigurationType"));
 		
 		// Create the absolute file path for the Jelly script file
 		String loc = script.getLocation().toOSString();
 		
 		// Now check, if there's already a launch configuration for the Jelly script
 		// This is done, by comparing the absolute file path of the Jelly script
 		ILaunchConfiguration[] configurations = manager.getLaunchConfigurations(type);
 		for(int i = 0; i < configurations.length; i++)
 		{
 			ILaunchConfiguration config = configurations[i];
 			if(config.getAttribute(JellyLaunchConfigurationConstants.ATTR_JELLYSCRIPT_PATH, "").equals(loc))
 			{
 				return config;
 			}
 		} 
 		
 		// It seems, there's no existing launch configuration for the Jelly script
 		// Therefore we'll create a new one for the Jelly script
 		ILaunchConfigurationWorkingCopy workingCopy = type.newInstance(null, this.createLaunchConfigurationname(script, mode));
 		
 		// Set the defaults for the launch configuration of the Jelly script
 		JellyLaunchUtils.setDefaults(workingCopy, script);
 		// Store the absolute file path of the Jelly script in the appropriate attribute of the launch configuration
 		workingCopy.setAttribute(JellyLaunchConfigurationConstants.ATTR_JELLYSCRIPT_PATH, loc);
 
 		// Save the new launch configuration for the Jelly script
 		return workingCopy.doSave();
 	}
 	
 	/***
 	 * Creates a name/title for the launch configuration of the Jelly script, that
 	 * gets displayed in the launch configuration dialog and various menus. The name
 	 * is created by taking the project name and appending the Jelly script file
 	 * name, separated by a dot.
 	 * @param script Jelly script file
 	 * @param mode run or debug
 	 * @return name of the launch configuration
 	 */
 	private String createLaunchConfigurationname(IFile script, String mode)
 	{
 		String result = script.getFullPath().toString();
 		
 		// If the Jelly script file doesn't belong to a project, simply use the full path
 		IProject proj = script.getProject();
 		if(proj != null)
 			result = proj.getName() + "." + script.getName();
 		
 		return result;
 	}
 }