Attachment #138256 for bug #133099

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Lines 2-8 Link Here

(-)META-INF/MANIFEST.MF (-1 / +1 lines)
2	Bundle-ManifestVersion: 2	2	Bundle-ManifestVersion: 2
3	Bundle-Name: %plugin.name	3	Bundle-Name: %plugin.name
4	Bundle-SymbolicName: org.eclipse.tptp.test.auto	4	Bundle-SymbolicName: org.eclipse.tptp.test.auto
5	Bundle-Version: 4.2.0.qualifier	5	Bundle-Version: 4.6.0.qualifier
6	Bundle-Vendor: %plugin.provider	6	Bundle-Vendor: %plugin.provider
7	Bundle-Localization: plugin	7	Bundle-Localization: plugin
8	Bundle-ActivationPolicy: lazy	8	Bundle-ActivationPolicy: lazy

Lines 2-8 Link Here

(-)META-INF/MANIFEST.MF (-1 / +1 lines)
2	Bundle-ManifestVersion: 2	2	Bundle-ManifestVersion: 2
3	Bundle-Name: Tests Plug-in	3	Bundle-Name: Tests Plug-in
4	Bundle-SymbolicName: org.eclipse.tptp.test.auto.gui.tests	4	Bundle-SymbolicName: org.eclipse.tptp.test.auto.gui.tests
5	Bundle-Version: 1.0.0	5	Bundle-Version: 4.5.3.qualifier
6	Bundle-Activator: org.eclipse.tptp.test.auto.gui.tests.TestsPlugin	6	Bundle-Activator: org.eclipse.tptp.test.auto.gui.tests.TestsPlugin
7	Require-Bundle: org.eclipse.ui,	7	Require-Bundle: org.eclipse.ui,
8	org.junit,	8	org.junit,




package org.eclipse.tptp.test.auto.gui.tests;

import org.eclipse.ui.plugin.*;
import org.eclipse.jface.resource.ImageDescriptor;
import org.osgi.framework.BundleContext;

/**
 * The main plugin class to be used in the desktop.
 */
public class TestsPlugin extends AbstractUIPlugin {

	//The shared instance.
	private static TestsPlugin plugin;
	
	/**
	 * The constructor.
	 */
	public TestsPlugin() {
		plugin = this;
	}

	/**
	 * This method is called upon plug-in activation
	 */
	public void start(BundleContext context) throws Exception {
		super.start(context);
	}

	/**
	 * This method is called when the plug-in is stopped
	 */
	public void stop(BundleContext context) throws Exception {
		super.stop(context);
		plugin = null;
	}

	/**
	 * Returns the shared instance.
	 */
	public static TestsPlugin getDefault() {
		return plugin;
	}

	/**
	 * Returns an image descriptor for the image file at the given
	 * plug-in relative path.
	 *
	 * @param path the path
	 * @return the image descriptor
	 */
	public static ImageDescriptor getImageDescriptor(String path) {
		return AbstractUIPlugin.imageDescriptorFromPlugin("org.eclipse.tptp.test.auto.gui.tests", path);
	}
}




package org.eclipse.tptp.test.auto.gui.tests.common.stubs;

import java.util.List;

import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

public class AutoGUINodeList implements NodeList
{
	private List children; 
	
	public AutoGUINodeList (List nodes)
	{
		this.children = nodes;
	}
		
	public int getLength()
	{
		return children.size();
	}

	public Node item(int index)
	{
		return (Node)children.get(index);
	}
	
	public AutoGUINode[] getNodes()
	{
		return children == null ? null : (AutoGUINode[])children.toArray(new AutoGUINode[children.size()]);
	}

}




/**********************************************************************
 * Copyright (c) 2006 IBM Corporation 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: 
 * IBM - Initial API and implementation
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.tests.common.stubs;

import org.w3c.dom.Attr;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.TypeInfo;
import org.w3c.dom.UserDataHandler;

public class AutoGUINode implements Node, Element
{
	private String name;
	private String value;
	private AutoGUINodeList children;
	private AutoGUINamedNodeMap attributes;	

	public AutoGUINode(String name, String value, AutoGUINodeList children, AutoGUINamedNodeMap attributes)
	{
		this.name = name;
		this.value = value;
		this.children = children;
		this.attributes = attributes;
	}
	
	
	public Node appendChild(Node newChild) throws DOMException
	{
		
		return null;
	}

	public Node cloneNode(boolean deep)
	{
		
		return null;
	}

	public NamedNodeMap getAttributes()
	{
		return attributes;
	}

	public NodeList getChildNodes()
	{
		return children;
	}

	public Node getFirstChild()
	{
		
		return null;
	}

	public Node getLastChild()
	{
		
		return null;
	}

	public String getLocalName()
	{
		
		return null;
	}

	public String getNamespaceURI()
	{
		
		return null;
	}

	public Node getNextSibling()
	{
		
		return null;
	}

	public String getNodeName()
	{		
		return name;
	}

	public short getNodeType()
	{
		
		return 0;
	}

	public String getNodeValue() throws DOMException
	{		
		return value;
	}

	public Document getOwnerDocument()
	{
		
		return null;
	}

	public Node getParentNode()
	{
		
		return null;
	}

	public String getPrefix()
	{
		
		return null;
	}

	public Node getPreviousSibling()
	{
		
		return null;
	}

	public boolean hasAttributes()
	{
		
		return false;
	}

	public boolean hasChildNodes()
	{
		
		return false;
	}

	public Node insertBefore(Node newChild, Node refChild) throws DOMException
	{
		
		return null;
	}

	public boolean isSupported(String feature, String version)
	{
		
		return false;
	}

	public void normalize()
	{
		

	}

	public Node removeChild(Node oldChild) throws DOMException
	{
		
		return null;
	}

	public Node replaceChild(Node newChild, Node oldChild) throws DOMException
	{
		
		return null;
	}

	public void setNodeValue(String nodeValue) throws DOMException
	{
		

	}

	public void setPrefix(String prefix) throws DOMException
	{
		

	}


	public String getAttribute(String name)
	{
		Node node = attributes.getNamedItem(name);
		return node == null ? null : node.getNodeValue();
	}


	public String getAttributeNS(String namespaceURI, String localName)
	{		
		return null;
	}


	public Attr getAttributeNode(String name)
	{
		return null;
	}


	public Attr getAttributeNodeNS(String namespaceURI, String localName)
	{
		return null;
	}


	public NodeList getElementsByTagName(String name)
	{
		
		return null;
	}


	public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
	{
		
		return null;
	}


	public String getTagName()
	{
		
		return null;
	}


	public boolean hasAttribute(String name)
	{
		
		return false;
	}


	public boolean hasAttributeNS(String namespaceURI, String localName)
	{
		
		return false;
	}


	public void removeAttribute(String name) throws DOMException
	{
		
		
	}


	public void removeAttributeNS(String namespaceURI, String localName) throws DOMException
	{
		
		
	}


	public Attr removeAttributeNode(Attr oldAttr) throws DOMException
	{
		
		return null;
	}


	public void setAttribute(String name, String value) throws DOMException
	{
		
		
	}


	public void setAttributeNS(String namespaceURI, String qualifiedName, String value) throws DOMException
	{
		
		
	}


	public Attr setAttributeNode(Attr newAttr) throws DOMException
	{
		
		return null;
	}


	public Attr setAttributeNodeNS(Attr newAttr) throws DOMException
	{
		
		return null;
	}


	public short compareDocumentPosition(Node other) throws DOMException
	{
		
		return 0;
	}


	public String getBaseURI()
	{
		
		return null;
	}


	public Object getFeature(String feature, String version)
	{
		
		return null;
	}


	public String getTextContent() throws DOMException
	{
		
		return null;
	}


	public Object getUserData(String key)
	{
		
		return null;
	}


	public boolean isDefaultNamespace(String namespaceURI)
	{
		
		return false;
	}


	public boolean isEqualNode(Node arg)
	{
		
		return false;
	}


	public boolean isSameNode(Node other)
	{
		
		return false;
	}


	public String lookupNamespaceURI(String prefix)
	{
		
		return null;
	}


	public String lookupPrefix(String namespaceURI)
	{
		
		return null;
	}


	public void setTextContent(String textContent) throws DOMException
	{
		
		
	}


	public Object setUserData(String key, Object data, UserDataHandler handler)
	{
		
		return null;
	}


	public TypeInfo getSchemaTypeInfo()
	{
		
		return null;
	}


	public void setIdAttribute(String name, boolean isId) throws DOMException
	{
		
		
	}


	public void setIdAttributeNS(String namespaceURI, String localName, boolean isId) throws DOMException
	{
		
		
	}


	public void setIdAttributeNode(Attr idAttr, boolean isId) throws DOMException
	{
		
		
	}

}




/**********************************************************************
 * Copyright (c) 2006 IBM Corporation 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: 
 * IBM - Initial API and implementation
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.tests.common.stubs;

import java.util.Map;

import org.w3c.dom.DOMException;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;

public class AutoGUINamedNodeMap implements NamedNodeMap
{
	private Map attributes;
	
	public AutoGUINamedNodeMap(Map attributes)
	{
		this.attributes = attributes;
	}
	
	public int getLength()
	{
		return attributes.size();
	}

	public Node getNamedItem(String name)
	{
		return (Node)attributes.get(name);
	}

	public Node getNamedItemNS(String namespaceURI, String localName)
	{
		
		return null;
	}

	public Node item(int index)
	{
		
		return null;
	}

	public Node removeNamedItem(String name) throws DOMException
	{
		
		return null;
	}

	public Node removeNamedItemNS(String namespaceURI, String localName)
			throws DOMException
	{
		
		return null;
	}

	public Node setNamedItem(Node arg) throws DOMException
	{
		
		return null;
	}

	public Node setNamedItemNS(Node arg) throws DOMException
	{
		
		return null;
	}

}




package org.eclipse.tptp.test.auto.gui.internal.junits;

import junit.framework.Test;

import org.eclipse.hyades.test.common.junit.DefaultTestArbiter;
import org.eclipse.hyades.test.common.junit.HyadesTestCase;
import org.eclipse.hyades.test.common.junit.HyadesTestSuite;

/**
 * Generated code for the test suite <b>AllTests</b> located at
 * <i>/org.eclipse.tptp.test.auto.gui.internal.tests/junit/AllTests.testsuite</i>.
 */
public class AllTests extends HyadesTestCase
{
	/**
	 * Constructor for AllTests.
	 * @param name
	 */
	public AllTests(String name)
	{
		super(name);
	}

	/**
	 * Returns the JUnit test suite that implements the <b>AllTests</b> definition.
	 */
	public static Test suite() {
		HyadesTestSuite allTests = new HyadesTestSuite("AllTests");
		allTests.setArbiter(DefaultTestArbiter.INSTANCE).setId(
				"DB15AFBA97E27DB4545A1C30429A11DB");
		allTests.addTest(((HyadesTestSuite) TestAutoGUIUtil.suite())
				.setTestInvocationId("FDADA7BD7A22D9AB3CF97DB9C8BD11DC"));
		return allTests;
	}

	/**
	 * @see junit.framework.TestCase#setUp()
	 */
	protected void setUp() throws Exception
	{
	}

	/**
	 * @see junit.framework.TestCase#tearDown()
	 */
	protected void tearDown() throws Exception
	{
	}

}




package org.eclipse.tptp.test.auto.gui.internal.junits;

import java.util.ArrayList;
import java.util.Hashtable;
import java.util.List;
import java.util.Map;

import junit.framework.Test;

import org.eclipse.hyades.test.common.junit.DefaultTestArbiter;
import org.eclipse.hyades.test.common.junit.HyadesTestCase;
import org.eclipse.hyades.test.common.junit.HyadesTestSuite;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.commands.ModifyCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.WaitCommand;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.tests.common.stubs.AutoGUINode;
import org.eclipse.tptp.test.auto.gui.internal.tests.common.stubs.AutoGUINodeList;
import org.eclipse.tptp.test.auto.gui.internal.tests.common.util.AutoGUINodeUtil;
import org.w3c.dom.Element;

/**
 * Generated code for the test suite <b>TestAutoGUIUtil</b> located at
 * <i>/org.eclipse
 * .tptp.test.auto.gui.internal.tests/junit/TestAutoGUIUtil
 * .testsuite</i>.
 * 
 * Tests AutoGUIUtil
 */
public class TestAutoGUIUtil extends HyadesTestCase {
	/**
	 * Constructor for TestAutoGUIUtil.
	 * 
	 * @param name
	 */
	public TestAutoGUIUtil(String name) {
		super(name);
	}

	/**
	 * Returns the JUnit test suite that implements the <b>TestAutoGUIUtil</b>
	 * definition.
	 */
	public static Test suite() {
		HyadesTestSuite testAutoGUIUtil = new HyadesTestSuite("TestAutoGUIUtil");
		testAutoGUIUtil.setArbiter(DefaultTestArbiter.INSTANCE).setId(
				"FB3DE203BEC63AE3983BDC00224111DB");

		testAutoGUIUtil.addTest(new TestAutoGUIUtil("testWalkDomTree").setId(
				"FB3DE203BEC63AE39B6D93F0224111DB").setTestInvocationId(
				"FB3DE203BEC63AE3A8C3BB60224111DB"));
		return testAutoGUIUtil;
	}

	/**
	 * @see junit.framework.TestCase#setUp()
	 */
	protected void setUp() throws Exception {
	}

	/**
	 * @see junit.framework.TestCase#tearDown()
	 */
	protected void tearDown() throws Exception {
	}

	/**
	 * testWalkDomTree
	 * 
	 * @throws Exception
	 */
	public void testWalkDomTree() throws Exception {
		Map modifiableFields = new Hashtable();
		List orderedModifiableFields = new ArrayList();

		final AutoGUINode WAIT_WITHOUT_TIME_TO_WAIT = AutoGUINodeUtil
				.constructNode(
						MacroConstants.COMMAND_ELEMENT,
						null,
						new String[][] { new String[] {
								MacroConstants.TYPE_ATTRIBUTE, WaitCommand.TYPE } });
		final AutoGUINode WAIT_WITH_TIME_TO_WAIT = AutoGUINodeUtil
				.constructNode(MacroConstants.COMMAND_ELEMENT, null,
						new String[][] {
								new String[] { MacroConstants.TYPE_ATTRIBUTE,
										WaitCommand.TYPE },
								new String[] {
										MacroConstants.TIME_TO_WAIT_ATTRIBUTE,
										"1000" } });
		final AutoGUINode MODIFY_NODE = AutoGUINodeUtil.constructNode(
				MacroConstants.COMMAND_ELEMENT, null,
				new String[][] { new String[] { MacroConstants.TYPE_ATTRIBUTE,
						ModifyCommand.TYPE } });

		/* Empty list */
		AutoGUINodeList nodeList = AutoGUINodeUtil
				.constructNodeList(new AutoGUINode[0]);
		AutoGUIUtil.walkDomTree(nodeList, modifiableFields,
				orderedModifiableFields);
		assertEquals("The map and the ordered list must have the same size",
				modifiableFields.size(), orderedModifiableFields.size());
		assertEquals("The map size is expected to be zero", 0, modifiableFields
				.size());

		/* One wait command without the time-to-wait attribute */
		nodeList = AutoGUINodeUtil
				.constructNodeList(new AutoGUINode[] { WAIT_WITHOUT_TIME_TO_WAIT });
		AutoGUIUtil.walkDomTree(nodeList, modifiableFields,
				orderedModifiableFields);
		assertEquals("The map and the ordered list must have the same size",
				modifiableFields.size(), orderedModifiableFields.size());
		assertEquals("The map size is expected to be zero", 0, modifiableFields
				.size());

		/*
		 * Modify | |___ Wait with time to wait | |___ Wait without time to wait
		 * Modify
		 */
		reset(modifiableFields, orderedModifiableFields);
		nodeList = AutoGUINodeUtil.constructNodeList(new AutoGUINode[] {
				AutoGUINodeUtil.constructNode(MacroConstants.COMMAND_ELEMENT,
						new AutoGUINode[] { WAIT_WITHOUT_TIME_TO_WAIT,
								WAIT_WITH_TIME_TO_WAIT },
						new String[][] { new String[] {
								MacroConstants.TYPE_ATTRIBUTE,
								ModifyCommand.TYPE } }), MODIFY_NODE });
		AutoGUIUtil.walkDomTree(nodeList, modifiableFields,
				orderedModifiableFields);
		assertEquals("The map size is expected to be zero", 2, modifiableFields
				.size());
		assertEquals("The map size is expected to be zero", 3,
				orderedModifiableFields.size());
		final String[] EXPECTED_ORDER = new String[] { ModifyCommand.TYPE,
				WaitCommand.TYPE, ModifyCommand.TYPE };
		for (int i = 0; i < EXPECTED_ORDER.length; i++) {
			Element element = (Element) orderedModifiableFields.get(i);
			assertEquals("The command ordering is incorrect",
					EXPECTED_ORDER[i], element
							.getAttribute(MacroConstants.TYPE_ATTRIBUTE));
		}
	}

	private void reset(Map modifiableFields, List orderedModifiableFields) {
		modifiableFields.clear();
		orderedModifiableFields.clear();
	}

}




/**********************************************************************
 * Copyright (c) 2006 IBM Corporation 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: 
 * IBM - Initial API and implementation
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.tests.common.util;

import java.util.ArrayList;
import java.util.Hashtable;
import java.util.Map;

import org.eclipse.tptp.test.auto.gui.tests.common.stubs.AutoGUINamedNodeMap;
import org.eclipse.tptp.test.auto.gui.tests.common.stubs.AutoGUINode;
import org.eclipse.tptp.test.auto.gui.tests.common.stubs.AutoGUINodeList;

public class AutoGUINodeUtil
{

	public static AutoGUINodeList constructNodeList(AutoGUINode[] nodeData)
	{
		ArrayList list = new ArrayList();
		for (int i = 0; i < nodeData.length; i++)
		{
			list.add(nodeData[i]);
		}
		return new AutoGUINodeList(list);
	}

//	private static void constructNodeList(AutoGUINode[] nodeData, ArrayList list)
//	{
//		for (int i = 0; i < nodeData.length; i++)
//		{
//			AutoGUINodeList children = null;
//			if (nodeData[i].getChildNodes() != null)
//			{
//				children = constructNodeList(((AutoGUINodeList)nodeData[i].getChildNodes()).getNodes());
//			}
//			String[][] atts = null;
//			Map attributeMap = null;
//			if ((atts = nodeData[i].getAttributes()) != null)
//			{
//				attributeMap = new Hashtable();
//				for (int j = 0; j < atts.length; j++)
//				{
//					String[] currentAttribute = atts[j];
//					attributeMap.put(currentAttribute[0], currentAttribute[1]);
//				}
//			}
//			
//			list.add(new AutoGUINode(children, attributeMap == null ? null : new AutoGUINamedNodeMap(attributeMap)));
//		}
//	}
	
	public static AutoGUINode constructNode (String name, AutoGUINode[] children, String[][] attributes)
	{
		Map attributeMap = new Hashtable();
		if (attributes != null)
		{
			for (int i = 0; i < attributes.length; i++)
			{
				String[] attribute = attributes[i];
				attributeMap.put(attribute[0], new AutoGUINode(attribute[0], attribute[1], null, null));
			}
		}
		
		return new AutoGUINode(name, null, children == null ? null : constructNodeList(children), new AutoGUINamedNodeMap(attributeMap));
	}

}

Lines 1-4 Link Here

(-)build.properties (-4 / +10 lines)
1	source.. = src/	1	source.. = src/
2	output.. = bin/	2	output.. = bin/
3	bin.includes = META-INF/,\	3	bin.includes = META-INF/,\
4	.	4	.,\
		5	gui/,\
		6	junit/,\
		7	junit-plugin/,\
		8	manual/,\
		9	src/,\
		10	bin/

Lines 1-3 Link Here

(-).settings/org.eclipse.core.resources.prefs (-3 / +4 lines)
1	#Wed Aug 02 12:11:46 EDT 2006	1	#Tue Jan 22 09:18:20 CET 2008
2	eclipse.preferences.version=1	2	eclipse.preferences.version=1
3	encoding//src/org/eclipse/tptp/test/auto/gui/internal/junits/TestAutoGUIUtil.java=UTF-8	3	encoding//src/org/eclipse/tptp/test/auto/gui/internal/junit_plugins/TestCommandsByMacroPlayback.java=UTF-8
		4	encoding//src/org/eclipse/tptp/test/auto/gui/internal/junits/TestAutoGUIUtil.java=UTF-8




package org.eclipse.tptp.test.auto.gui.internal.tests;

import org.eclipse.ui.plugin.*;
import org.eclipse.jface.resource.ImageDescriptor;
import org.osgi.framework.BundleContext;

/**
 * The main plugin class to be used in the desktop.
 */
public class TestsPlugin extends AbstractUIPlugin {

	//The shared instance.
	private static TestsPlugin plugin;
	
	/**
	 * The constructor.
	 */
	public TestsPlugin() {
		plugin = this;
	}

	/**
	 * This method is called upon plug-in activation
	 */
	public void start(BundleContext context) throws Exception {
		super.start(context);
	}

	/**
	 * This method is called when the plug-in is stopped
	 */
	public void stop(BundleContext context) throws Exception {
		super.stop(context);
		plugin = null;
	}

	/**
	 * Returns the shared instance.
	 */
	public static TestsPlugin getDefault() {
		return plugin;
	}

	/**
	 * Returns an image descriptor for the image file at the given
	 * plug-in relative path.
	 *
	 * @param path the path
	 * @return the image descriptor
	 */
	public static ImageDescriptor getImageDescriptor(String path) {
		return AbstractUIPlugin.imageDescriptorFromPlugin("org.eclipse.tptp.test.auto.gui.tests", path);
	}
}




<macro version="1.1">
	<shell descriptive="Plug-in Development - TestPluginProject/src/Test.t..." resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.ui.internal.WorkbenchWindow" return-code="-1">
		<command descriptive="Project..." type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="menus" widgetId="{{File-New&amp;#x9;Alt+Shift+N-Project...}}-{{1.0}}"/>
		<shell descriptive="New Project" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.jface.wizard.WizardDialog" return-code="0">
			<command descriptive="General" type="item-expand" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newWizardSelectionPage" widgetId="org.eclipse.swt.widgets.Tree#1" value="true">
				<item widgetId="{{org.eclipse.ui.Basic}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
			</command>
			<command descriptive="Project" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newWizardSelectionPage" widgetId="org.eclipse.swt.widgets.Tree#1">
				<item widgetId="{{org.eclipse.ui.wizards.new.project}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
			</command>
			<command descriptive="Next &amp;gt;" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="wizard" widgetId="{{15}}-{{1.0}}"/>
			<command descriptive="TestProject" type="modify" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/basicNewProjectPage" widgetId="Project name:">
			<![CDATA[TestProject]]>
			</command>
			<command descriptive="Finish" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="wizard" widgetId="{{16}}-{{1.0}}"/>
		</shell>
		<command type="wait"/>
		<command descriptive="TestProject" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}">
			<item widgetId="{{/TestProject}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
		</command>
		<command descriptive="Folder" type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="popup/view/org.eclipse.jdt.ui.PackageExplorer/{{/}}-{{1.0}}@@@org.eclipse.tptp.test.auto.gui.adaptive" widgetId="{{New-Folder}}-{{1.0}}"/>
		<shell descriptive="New Folder" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.jface.wizard.WizardDialog" return-code="0">
			<command descriptive="folder" type="modify" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newFolderPage1" widgetId="Folder name:">
			<![CDATA[folder]]>
			</command>
			<command descriptive="Finish" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="wizard" widgetId="{{16}}-{{1.0}}"/>
		</shell>
		<command descriptive="TestProject" type="item-expand" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}" value="true">
			<item widgetId="{{/TestProject}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
		</command>
		<command type="wait"/>
		<command descriptive="File" type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="popup/view/org.eclipse.jdt.ui.PackageExplorer/{{/}}-{{1.0}}@@@org.eclipse.tptp.test.auto.gui.adaptive" widgetId="{{New-File}}-{{1.0}}"/>
		<shell descriptive="New File" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.jface.wizard.WizardDialog" return-code="0">
			<command descriptive="test.txt" type="modify" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newFilePage1" widgetId="File name:">
			<![CDATA[test.txt]]>
			</command>
			<command descriptive="Finish" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="wizard" widgetId="{{16}}-{{1.0}}"/>
		</shell>
		<command descriptive="folder" type="item-expand" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}" value="true">
			<item widgetId="{{/TestProject/folder}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
		</command>
		<command descriptive="TestProject" type="item-expand" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}" value="true">
			<item widgetId="{{/TestProject}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
		</command>
		<command descriptive="test.txt" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}">
			<item widgetId="{{/TestProject/folder/test.txt}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
		</command>
		<command type="wait"/>
		<command descriptive="Test" type="modify" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="editor/org.eclipse.ui.DefaultTextEditor/test.txt" widgetId="org.eclipse.swt.custom.StyledText#1">
		<![CDATA[Test]]>
		</command>
		<command type="wait"/>
		<command descriptive="Test" type="focus" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="editor/org.eclipse.ui.DefaultTextEditor/test.txt" widgetId="org.eclipse.swt.custom.StyledText#1"/>
		<command descriptive="TestProject" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}">
			<item widgetId="{{/TestProject}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
		</command>
		<command type="focus" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="org.eclipse.swt.widgets.Composite#1"/>
		<command descriptive="Delete Delete" type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="popup/view/org.eclipse.jdt.ui.PackageExplorer/{{/}}-{{1.0}}" widgetId="{{Delete&amp;#x9;Delete}}-{{1.0}}"/>
		<shell descriptive="Delete Resources" widgetId="org.eclipse.ltk.internal.ui.refactoring.RefactoringWizardDialog2" return-code="0">
			<command descriptive="Delete project contents on disk (cannot be undone..." type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="shell" widgetId="{{Delete project contents on disk (cannot be undone)}}-{{0.3}}{{null}}-{{0.3}}{{1}}-{{0.3}}{{(484,16)}}-{{0.2}}{{(5,5)}}-{{0.1}}{{0}}-{{0.2}}" selection="true"/>
			<command descriptive="OK" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="shell" widgetId="{{0}}-{{1.0}}"/>
		</shell>		
	</shell>
</macro>




/**********************************************************************
 * Copyright (c) 2006 IBM Corporation 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: 
 * IBM - Initial API and implementation
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.tests.common.stubs;

import org.w3c.dom.Attr;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.TypeInfo;
import org.w3c.dom.UserDataHandler;

public class AutoGUINode implements Node, Element
{
	private String name;
	private String value;
	private AutoGUINodeList children;
	private AutoGUINamedNodeMap attributes;	

	public AutoGUINode(String name, String value, AutoGUINodeList children, AutoGUINamedNodeMap attributes)
	{
		this.name = name;
		this.value = value;
		this.children = children;
		this.attributes = attributes;
	}
	
	
	public Node appendChild(Node newChild) throws DOMException
	{
		
		return null;
	}

	public Node cloneNode(boolean deep)
	{
		
		return null;
	}

	public NamedNodeMap getAttributes()
	{
		return attributes;
	}

	public NodeList getChildNodes()
	{
		return children;
	}

	public Node getFirstChild()
	{
		
		return null;
	}

	public Node getLastChild()
	{
		
		return null;
	}

	public String getLocalName()
	{
		
		return null;
	}

	public String getNamespaceURI()
	{
		
		return null;
	}

	public Node getNextSibling()
	{
		
		return null;
	}

	public String getNodeName()
	{		
		return name;
	}

	public short getNodeType()
	{
		
		return 0;
	}

	public String getNodeValue() throws DOMException
	{		
		return value;
	}

	public Document getOwnerDocument()
	{
		
		return null;
	}

	public Node getParentNode()
	{
		
		return null;
	}

	public String getPrefix()
	{
		
		return null;
	}

	public Node getPreviousSibling()
	{
		
		return null;
	}

	public boolean hasAttributes()
	{
		
		return false;
	}

	public boolean hasChildNodes()
	{
		
		return false;
	}

	public Node insertBefore(Node newChild, Node refChild) throws DOMException
	{
		
		return null;
	}

	public boolean isSupported(String feature, String version)
	{
		
		return false;
	}

	public void normalize()
	{
		

	}

	public Node removeChild(Node oldChild) throws DOMException
	{
		
		return null;
	}

	public Node replaceChild(Node newChild, Node oldChild) throws DOMException
	{
		
		return null;
	}

	public void setNodeValue(String nodeValue) throws DOMException
	{
		

	}

	public void setPrefix(String prefix) throws DOMException
	{
		

	}


	public String getAttribute(String name)
	{
		Node node = attributes.getNamedItem(name);
		return node == null ? null : node.getNodeValue();
	}


	public String getAttributeNS(String namespaceURI, String localName)
	{		
		return null;
	}


	public Attr getAttributeNode(String name)
	{
		return null;
	}


	public Attr getAttributeNodeNS(String namespaceURI, String localName)
	{
		return null;
	}


	public NodeList getElementsByTagName(String name)
	{
		
		return null;
	}


	public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
	{
		
		return null;
	}


	public String getTagName()
	{
		
		return null;
	}


	public boolean hasAttribute(String name)
	{
		
		return false;
	}


	public boolean hasAttributeNS(String namespaceURI, String localName)
	{
		
		return false;
	}


	public void removeAttribute(String name) throws DOMException
	{
		
		
	}


	public void removeAttributeNS(String namespaceURI, String localName) throws DOMException
	{
		
		
	}


	public Attr removeAttributeNode(Attr oldAttr) throws DOMException
	{
		
		return null;
	}


	public void setAttribute(String name, String value) throws DOMException
	{
		
		
	}


	public void setAttributeNS(String namespaceURI, String qualifiedName, String value) throws DOMException
	{
		
		
	}


	public Attr setAttributeNode(Attr newAttr) throws DOMException
	{
		
		return null;
	}


	public Attr setAttributeNodeNS(Attr newAttr) throws DOMException
	{
		
		return null;
	}


	public short compareDocumentPosition(Node other) throws DOMException
	{
		
		return 0;
	}


	public String getBaseURI()
	{
		
		return null;
	}


	public Object getFeature(String feature, String version)
	{
		
		return null;
	}


	public String getTextContent() throws DOMException
	{
		
		return null;
	}


	public Object getUserData(String key)
	{
		
		return null;
	}


	public boolean isDefaultNamespace(String namespaceURI)
	{
		
		return false;
	}


	public boolean isEqualNode(Node arg)
	{
		
		return false;
	}


	public boolean isSameNode(Node other)
	{
		
		return false;
	}


	public String lookupNamespaceURI(String prefix)
	{
		
		return null;
	}


	public String lookupPrefix(String namespaceURI)
	{
		
		return null;
	}


	public void setTextContent(String textContent) throws DOMException
	{
		
		
	}


	public Object setUserData(String key, Object data, UserDataHandler handler)
	{
		
		return null;
	}


	public TypeInfo getSchemaTypeInfo()
	{
		
		return null;
	}


	public void setIdAttribute(String name, boolean isId) throws DOMException
	{
		
		
	}


	public void setIdAttributeNS(String namespaceURI, String localName, boolean isId) throws DOMException
	{
		
		
	}


	public void setIdAttributeNode(Attr idAttr, boolean isId) throws DOMException
	{
		
		
	}

}




package org.eclipse.tptp.test.auto.gui.internal.tests.common.stubs;

import java.util.List;

import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

public class AutoGUINodeList implements NodeList
{
	private List children; 
	
	public AutoGUINodeList (List nodes)
	{
		this.children = nodes;
	}
		
	public int getLength()
	{
		return children.size();
	}

	public Node item(int index)
	{
		return (Node)children.get(index);
	}
	
	public AutoGUINode[] getNodes()
	{
		return children == null ? null : (AutoGUINode[])children.toArray(new AutoGUINode[children.size()]);
	}

}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.hook;

import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.tptp.test.auto.gui.internal.runner.AutoGUIVerificationHook;

/**
 * Generated code for the test suite <b>TestUIObjectIdentifierDisambiguation</b>
 * located at
 * <i>/TestProject/src/TestUIObjectIdentifierDisambiguation.testsuite</i>.
 */
public class TestUIObjectIdentifierDisambiguation extends
		AutoGUIVerificationHook {

	/**
	 * Constructor for TestUIObjectIdentifierDisambiguation. An instance of this
	 * class is created to test a test method.
	 * 
	 * @param testMethodName
	 *            The test method to be tested.
	 * @param paramTypes
	 *            The parameter types of the test method
	 * @param args
	 *            The arguments of the test method
	 */
	public TestUIObjectIdentifierDisambiguation(String testMethodName,
			Class[] paramTypes, Object[] args) {
		super(testMethodName, paramTypes, args);
	}

	/**
	 * @see junit.framework.TestCase#setUp()
	 */
	protected void setUp() throws Exception {
	}

	/**
	 * @see junit.framework.TestCase#tearDown()
	 */
	protected void tearDown() throws Exception {
	}

	/**
	 * Verify item was selected
	 * 
	 * @throws Exception
	 */
	public void verifyItemWasSelected(org.eclipse.ui.IEditorPart arg0,
			org.eclipse.swt.widgets.Tree arg1) throws Exception {
		TreeItem manifestItem = arg1.getItem(3);
		assertTrue(manifestItem.getChecked());
	}

	/**
	 * Verfiy item was deselected
	 * 
	 * @throws Exception
	 */
	public void verifyItemWasDeselected(org.eclipse.ui.IEditorPart arg0,
			org.eclipse.swt.widgets.Tree arg1) throws Exception {
		TreeItem manifestItem = arg1.getItem(3);
		assertFalse(manifestItem.getChecked());
	}

}




/**********************************************************************
 * Copyright (c) 2006 IBM Corporation 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: 
 * IBM - Initial API and implementation
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.tests.common.util;

import java.util.ArrayList;
import java.util.Hashtable;
import java.util.Map;

import org.eclipse.tptp.test.auto.gui.internal.tests.common.stubs.AutoGUINamedNodeMap;
import org.eclipse.tptp.test.auto.gui.internal.tests.common.stubs.AutoGUINode;
import org.eclipse.tptp.test.auto.gui.internal.tests.common.stubs.AutoGUINodeList;

public class AutoGUINodeUtil
{

	public static AutoGUINodeList constructNodeList(AutoGUINode[] nodeData)
	{
		ArrayList list = new ArrayList();
		for (int i = 0; i < nodeData.length; i++)
		{
			list.add(nodeData[i]);
		}
		return new AutoGUINodeList(list);
	}

//	private static void constructNodeList(AutoGUINode[] nodeData, ArrayList list)
//	{
//		for (int i = 0; i < nodeData.length; i++)
//		{
//			AutoGUINodeList children = null;
//			if (nodeData[i].getChildNodes() != null)
//			{
//				children = constructNodeList(((AutoGUINodeList)nodeData[i].getChildNodes()).getNodes());
//			}
//			String[][] atts = null;
//			Map attributeMap = null;
//			if ((atts = nodeData[i].getAttributes()) != null)
//			{
//				attributeMap = new Hashtable();
//				for (int j = 0; j < atts.length; j++)
//				{
//					String[] currentAttribute = atts[j];
//					attributeMap.put(currentAttribute[0], currentAttribute[1]);
//				}
//			}
//			
//			list.add(new AutoGUINode(children, attributeMap == null ? null : new AutoGUINamedNodeMap(attributeMap)));
//		}
//	}
	
	public static AutoGUINode constructNode (String name, AutoGUINode[] children, String[][] attributes)
	{
		Map attributeMap = new Hashtable();
		if (attributes != null)
		{
			for (int i = 0; i < attributes.length; i++)
			{
				String[] attribute = attributes[i];
				attributeMap.put(attribute[0], new AutoGUINode(attribute[0], attribute[1], null, null));
			}
		}
		
		return new AutoGUINode(name, null, children == null ? null : constructNodeList(children), new AutoGUINamedNodeMap(attributeMap));
	}

}

Added Link Here

(-)junit-plugin/TestSelectToolbarItem.xml (+10 lines)
1	<macro version="1.1">
2	<shell descriptive="Plug-in Development - TestPluginProject/src/Test.t..." resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.ui.internal.WorkbenchWindow" return-code="-1">
3	<command type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="toolbar" widgetId="{{External Tools}}-{{0.7}}{{contribid/org.eclipse.ui.externaltools.ExternalToolMenuDelegateToolbar}}-{{0.7}}{{4}}-{{0.3}}" x-coord="152" y-coord="22" detail="4">
4	<selected-item widgetId="{{External Tools Configurations...}}-{{1.0}}"/>
5	</command>
6	<shell descriptive="External Tools" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.debug.internal.ui.launchConfigurations.LaunchConfigurationsDialog" return-code="1">
7	<command descriptive="Close" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="shell" widgetId="{{1026}}-{{1.0}}"/>
8	</shell>
9	</shell>
10	</macro>

Added Link Here

(-)deployment/eclipse-ganymede-tptp-all-in-one-AGR.location (+5 lines)
1	PK@ ú8ResourceContentsÛn@ï+õV{Ä®bË4rG*R5ª
2	aÛ=i±ýö]Bb'ØRá+`Ùù¿ùgF³³5gè´¡R$x`¢%UÜ,}ùøaJÎ¥øJ±¤ÓÄúýÓtq~I
3	ðëÆjBEkN§[Áa#èÂLýzkkÕ4V«U(yJ]E·Ï[A^Å@Á¨2ðWoH &â²f¢â1Ô_^-Æó8òá8Ï4Å£a>Ò,Y ü¤TDl8XeU@¨¤`~~Q-m÷3YÖ<b_#fJKÚnÎµtÊ¼îÐÞE¡©jÍÞÔÔ ª Z¿RD[Z8F4¢¾ÒDäò6eôSê?÷¾u5Â4IÏ¶vï®Ú)^%{%ØWu[áÆxhÁX) ;Am¨«¨hÍîìzµ·¬~úG¿ùâ5¦1z Ìùõlzçó«4áhA»÷µ£ÉX©àèÿRuSóÚru
4	ÎÀ6«%aÍSÊ¸K)Ý4Å(R@Fõa§]Øê
5	/ºé¥ÿ¹«_)}³Ì=Ä{mQÑvZ¾û-êåÄ:ÒÂÕó¬÷Ê`ÒÍÀÑZ{§[´Õ®ÉyáÃJWØÖ`á¯Ç=T;kéié!ueKXÇlkáBÐã5!?ÐæëÊqv7Õ½0.æá!¸åCüÝúóiÌû0ç'{#l kyõx£q¾ÿ!][Ð°.ée½þl6¿Ñ»ÿ7üî¿PKêkÅPK@ ú8êkÅResourceContentsPK>©




<macro version="1.1">
	<shell descriptive="Plug-in Development - TestPluginProject/src/Test.t..." widgetId="org.eclipse.ui.internal.WorkbenchWindow" return-code="-1">
		<command descriptive="Project..." type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="menus" widgetId="{{File-New&amp;#x9;Alt+Shift+N-Project...}}-{{1.0}}"/>
		<shell descriptive="New Project" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.jface.wizard.WizardDialog" return-code="0">
			<command descriptive="General" type="item-expand" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newWizardSelectionPage" widgetId="org.eclipse.swt.widgets.Tree#1" value="true">
				<item widgetId="{{org.eclipse.ui.Basic}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
			</command>
			<command descriptive="Project" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newWizardSelectionPage" widgetId="org.eclipse.swt.widgets.Tree#1">
				<item widgetId="{{org.eclipse.ui.wizards.new.project}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
			</command>
			<command type="focus" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newWizardSelectionPage" widgetId="org.eclipse.swt.widgets.Tree#1"/>
			<command descriptive="Next &amp;gt;" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="wizard" widgetId="{{15}}-{{1.0}}"/>
			<command descriptive="TestProject" type="modify" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/basicNewProjectPage" widgetId="Project name:">
			<![CDATA[TestProject]]>
			</command>
			<command descriptive="Finish" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="wizard" widgetId="{{16}}-{{1.0}}"/>
		</shell>
		<command type="wait"/>
		<command descriptive="TestProject" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}">
			<item widgetId="{{/TestProject}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
		</command>
		<command type="focus" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="org.eclipse.swt.widgets.Composite#1"/>
		<command descriptive="Delete Delete" type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="popup/view/org.eclipse.jdt.ui.PackageExplorer%%%{{/}}-{{1.0}}@@@org.eclipse.tptp.test.auto.gui.adaptive" widgetId="{{Delete&amp;#x9;Delete}}-{{1.0}}"/>
		<shell descriptive="Delete Resources" widgetId="org.eclipse.ltk.internal.ui.refactoring.RefactoringWizardDialog2" return-code="0">
			<command descriptive="Delete project contents on disk (cannot be undone..." type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="shell" widgetId="{{Delete project contents on disk (cannot be undone)}}-{{0.3}}{{null}}-{{0.3}}{{1}}-{{0.3}}{{(484,16)}}-{{0.2}}{{(5,5)}}-{{0.1}}{{0}}-{{0.2}}" selection="true"/>
			<command descriptive="OK" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="shell" widgetId="{{0}}-{{1.0}}"/>
		</shell>			
	</shell>
</macro>




<macro version="1.1">
	<shell descriptive="Plug-in Development - TestPluginProject/src/Test.t..." resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.ui.internal.WorkbenchWindow" return-code="-1">
		<command descriptive="Preferences" type="select" contextId="menus" widgetId="{{Window-Preferences}}-{{1.0}}"/>
		<shell descriptive="Preferences" widgetId="org.eclipse.ui.internal.dialogs.WorkbenchPreferenceDialog" return-code="1">
			<command descriptive="Team" type="item-select" contextId="shell" widgetId="org.eclipse.swt.widgets.Tree#1">
				<item widgetId="{{org.eclipse.team.ui.TeamPreferences}}-{{1.0}}"/>
			</command>
			<command descriptive="Resource" type="choice-select" contextId="shell" widgetId="org.eclipse.swt.widgets.Combo#1" choiceId="item#8"/>
			<command descriptive="Cancel" type="select" contextId="shell" widgetId="{{1}}-{{1.0}}"/>
		</shell>
	</shell>
</macro>

Added Link Here

(-)gui/TestUiObjectIdentifierDisambiguation.artifact (+5 lines)
1	PK×ö8ResourceContentsÅ]o0ï'í? ïº
2	«.R§EK*í.rà$ñ6²MÓüûÚÐ¥ÍnÝÕ$$ËÖ{Þó¼þ`\|ußÔÖI9Kk;ÈVò²mnÅE®>½7ÎxÓp¶Ê8ÛÐm'Òú8+®S¡èÊºoh\|ôñvf2Öë Ú)ÕÆï÷{7[-þþevÈSÉÞïã¸Zv³(wÐÊ¤"¬_UçNl ¬i+¡÷ÚH7¼Zâ²/ÕÃ³R[þf½©ZÁ7´3VO-ºy>
3	Ð+¦£ÈKiè¸×}?¸ôG~,FÝÈt½¥_×? T³
4	Þ_
5	"§4kMÛÃ"}$5Ö=Zêp-x×Ê]&ÑäL¢Y ãicöéöÇ¶R®;-(8(ep_KÝ¤Å<]~FÖ©;½Çx.¸I.ñ7@D¹ÃªUít¯¶]í¹ø)[R~Îm4µÚZ×!ËpÅEßëýÜ~&_ãÓ£+hk~ ëfoCZú-ÅêÐÜ8^Î3]tTég´°Imcý½ Îìj;g¾Ü4ùEÁôc1²I]¦Er'¿ôC×Í³>ßÿíï¢EPKùôªPK×ö8ùôªResourceContentsPK>2

Added Link Here

(-)deployment/eclipse-ganymede-tptp-all-in-one-AGR.deploy (+4 lines)
1	PK¡>÷8ResourceContentsåV]o0}´ÿè3lC(YEÀT-ÒioÈ¸°³4ÿ~MÚ®ÖmjªMxáâsÏÇ¯ÞÔõwJ4rbûÀ³-.ó¦²ØÔ!öé÷ïÆqS×Ì\é¶k¢â£Å<Mx[5ÛKmÝÔbt×îúÎRL}b¯´nG®»Ùl@S éJ÷Ëìüpäiï<¯D«xZmYÁ[7¯÷@Wß¡³-QLì4E0!ØDúb2Qxq2Ä¾Ä¶%YmöÝIc¤ànuë°ªrtÉèìm°¬qÇMÎ´±¨¬yØôåSJäx³Å\|1Ï07Ã ÚCNbDS#*ÄûIB¦q§áÀÉ4í¹ÿ
2	&;£é¾Lgiî«f!¦0 ¦q 4úqB¿&à§3ÿ}"Öi±d¹¾cëËæÃ¡Ó1Ùðïip¯×Rh§Ö¥îîzínng,ïyÅ¶W,ÿ
3	ÐÈ2 zÔ÷`ln§!
4	ÃààÕ}Þì_A¹½õKññêçú¼0ÛJ,ï¡X}%ÊuOò8ÀÔpÀÈ£Äó§>"høgpþ8ÏÝfBò§ 4!Nÿ8u¯Á<fß-óW°[ÜuBPtl¾¨8¶WÔöÚq>#íMsxKcGÚMc÷¥?sè;PKßT§0öPK¡>÷8ßT§0öResourceContentsPK>n




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.junit_plugins;

import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;

import junit.framework.Test;
import junit.framework.TestSuite;

import org.eclipse.core.runtime.FileLocator;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.hyades.test.common.junit.HyadesTestCase;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macro.ModeConstants;
import org.eclipse.tptp.test.auto.gui.internal.tests.TestsPlugin;
import org.eclipse.tptp.test.auto.gui.internal.util.XMLDefaultHandler;
import org.eclipse.ui.PlatformUI;

/**
 * Generated code for the test suite <b>TestCommandsByMacroPlayback</b> located
 * at <i>/org.eclipse.tptp.test.auto.gui.internal.tests/junit-plugin/
 * MacroPlaybackTests.testsuite</i>.
 */
public class TestCommandsByMacroPlayback extends HyadesTestCase {

	public static final String ENCODING = "UTF-8";

	/**
	 * Constructor for TestCommandsByMacroPlayback.
	 * 
	 * @param name
	 */
	public TestCommandsByMacroPlayback(String name) {
		super(name);
	}

	/**
	 * Returns the JUnit test suite that implements the
	 * <b>TestCommandsByMacroPlayback</b> definition.
	 */
	public static Test suite() {
		TestSuite testCommandsByMacroPlayback = new TestSuite(
				TestCommandsByMacroPlayback.class);
		return testCommandsByMacroPlayback;
	}

	/**
	 * @see junit.framework.TestCase#setUp()
	 */
	protected void setUp() throws Exception {
	}

	/**
	 * @see junit.framework.TestCase#tearDown()
	 */
	protected void tearDown() throws Exception {
	}

	/**
	 * testSingleSelectionCommands
	 * 
	 * Tests selection of boolean selection (type "select") for MenuItem and
	 * Button, as well as choice selection (type "choice-select") for button
	 * 
	 * @throws Exception
	 */
	public void testSingleSelectionCommands() {
		// StringBuffer s = new StringBuffer();
		// s.append("<macro version=\"1.0\">");
		// s.append("<shell descriptive=\"Plug-in Development -
		// TestPluginProject/src/TestUIObjectIdentifierDisambiguation.t...\"
		// resolverId=\"org.eclipse.tptp.test.auto.gui.internal.nontrivial\"
		// id=\"org.eclipse.ui.internal.WorkbenchWindow\" return-code=\"-1\">");
		// s.append("<command descriptive=\"Preferences...\" type=\"select\"
		// resolverId=\"org.eclipse.tptp.test.auto.gui.internal.nontrivial\"
		// contextId=\"menus\"
		// widgetId=\"{{Window-Preferences...}}-{{1.0}}\"/>");
		// s.append("<shell descriptive=\"Preferences\"
		// resolverId=\"org.eclipse.tptp.test.auto.gui.internal.nontrivial\"
		// id=\"org.eclipse.ui.internal.dialogs.WorkbenchPreferenceDialog\"
		// return-code=\"1\">");
		// s.append("<command descriptive=\"Team\" type=\"item-select\"
		// resolverId=\"org.eclipse.tptp.test.auto.gui.internal.nontrivial\"
		// contextId=\"shell\" widgetId=\"org.eclipse.swt.widgets.Tree#1\">");
		// s.append("<item
		// path=\"{{org.eclipse.team.ui.TeamPreferences}}-{{1.0}}\"
		// resolverId=\"org.eclipse.tptp.test.auto.gui.internal.adaptive\"/>");
		// s.append("</command>");
		// s.append("<command descriptive=\"Resource\" type=\"choice-select\"
		// resolverId=\"org.eclipse.tptp.test.auto.gui.internal.nontrivial\"
		// contextId=\"shell\"
		// widgetId=\"org.eclipse.swt.widgets.Combo#1/item#8\"/>");
		// s.append("<command descriptive=\"Cancel\" type=\"select\"
		// resolverId=\"org.eclipse.tptp.test.auto.gui.internal.adaptive\"
		// contextId=\"shell\" widgetId=\"{{1}}-{{1.0}}\"/>");
		// s.append("</shell>");
		// s.append("</shell>");
		// s.append("</macro>");
		// playbackMacro(s.toString());
		String macro = readMacro("TestSingleSelectionCommands.xml");
		assertNotNull(macro);
		playbackMacro(macro);
	}

	/**
	 * testSingleSelectionCommandsBackwardsCompatibility Tests the same as
	 * testSingleSelectionCommands, only that the macro has the old format using
	 * a separate choiceId for ChoiceSelectionCommand and does not provide
	 * resolver ids.
	 */
	public void testSingleSelectionCommandsBackwardsCompatibility() {
		playbackMacro(readMacro("TestSingleSelectionCommandsOldFormat.xml"));
	}

	/**
	 * testStructuredSelectionCommands TestUIObjectIdentifierDisambiguation
	 * structured selection (item expansion and item selection), menu selection,
	 * and popup menu item selection commands by creating a new SimpleProject
	 * and deleting it again via the context menu.
	 */
	public void testStructuredSelectionCommands() {
		playbackMacro(readMacro("TestStructuredSelectionCommands.xml"));
	}

	/**
	 * testToolbarItemSelectionCommand
	 * 
	 * @throws Exception
	 */
	public void testToolbarItemSelectionCommand() throws Exception {
		playbackMacro(readMacro("TestSelectToolbarItem.xml"));
	}

	protected String readMacro(String macroFileName) {
		StringBuffer sb = new StringBuffer();
		try {
			InputStream is = FileLocator.openStream(TestsPlugin.getDefault()
					.getBundle(), new Path("junit-plugin/" + macroFileName),
					false);
			BufferedReader br = new BufferedReader(new InputStreamReader(is));

			String currentLine = null;
			do {
				currentLine = br.readLine();
				if (currentLine != null) {
					sb.append(currentLine);
				}
			} while (currentLine != null);
		} catch (IOException e) {
			e.printStackTrace();
			return null;
		}
		return sb.toString();
	}

	protected final void playbackMacro(final String macroString) {
		// just to ensure that we can see something during playback
		PlatformUI.getWorkbench().getDisplay().syncExec(new Runnable() {
			public void run() {
				MacroUtil.closeWelcomePage();
			}
		});

		// playback the current macro
		try {
			PlatformUI.getWorkbench().getActiveWorkbenchWindow().run(true,
					false, new IRunnableWithProgress() {
						public void run(IProgressMonitor monitor) {
							try {
								XMLDefaultHandler handler = MacroManager
										.getInstance()
										.createMacroDocument(
												new ByteArrayInputStream(
														macroString
																.getBytes(ENCODING)));

								MacroManager.getInstance()
										.setCommandTimeoutThreshold(3000);
								MacroManager.getInstance().setGlobalState(
										ModeConstants.EXECUTION_RUN_MODE);
								MacroManager.getInstance().play(
										PlatformUI.getWorkbench().getDisplay(),
										null, "TestMacro", handler,
										Boolean.TRUE);
							} catch (Exception e) {
								e.printStackTrace();
								fail(e.getMessage());
							}
						}
					});
		} catch (Exception e) {
			e.printStackTrace();
			if (e.getCause() != null) {
				e.printStackTrace();
			}
			fail(e.getMessage());
		}
	}

}




<macro version="1.1">
	<shell descriptive="Plug-in Development - TestPluginProject/src/Test.t..." resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.ui.internal.WorkbenchWindow" return-code="-1">
				<command descriptive="Preferences" type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="menus" widgetId="{{Window-Preferences}}-{{1.0}}"/>
		<shell descriptive="Preferences" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.ui.internal.dialogs.WorkbenchPreferenceDialog" return-code="1">
			<command descriptive="Team" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="shell" widgetId="org.eclipse.swt.widgets.Tree#1">
				<item widgetId="{{org.eclipse.team.ui.TeamPreferences}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
			</command>
			<command descriptive="Resource" type="choice-select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="shell" widgetId="org.eclipse.swt.widgets.Combo#1" objectId="item#8"/>
			<command descriptive="Cancel" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="shell" widgetId="{{1}}-{{1.0}}"/>
		</shell>
	</shell>
</macro>

Added Link Here

(-)gui/TestUIObjectIdentifierViaObjectMine.artifact (+5 lines)
1	PKçö8ResourceContents½Qo0Çß'í; ï¹BH)
2	«.R«EK:í-ràÞÀF¶io?;tiÓ¤jö2 ÉòéÿûÝÙf\|ýØÔÖI9k;Èó²2B÷ì"@×?~'¼i8[&iÙ ¢´>L²X(º&¹²î}ÆG;3êx*¥ÚãÍfcó¦´¹(ñÏ»é^"%o§8«e·ó¼\P&a9üÍ:Et`yM[ ;¯jK
3	¸áÔç»T½¼Hµ5è+ëHÕ
4	¾¦5ü±zNìmi¡ØMS?p/K£aæLÇýâzçï]!F2Uï§ßV¿ WÓ/ñ>tG }"5Ö%Zj{#x×ÊSEÜã"IÓ4Bº}G}7¶á·§CÎÙ&J ºê´¤§xæ pÌ$Î&·ñ\|>_õ@êNGÒÏ7]Jü$WXµª]NñeÙÑåß²%9àÜFÓS¡xE²Q\D(Bø<Ü#û¸»\|zºÐÖ\|KV5L´ôS
5	Õ¶5¸Gw8\Ì2³wTéWT XGÈ¶±þÎ3S=ãröjSãÓÄ÷²Ì½ýxä»YdÃør88Ç¹nìÚã÷þ-ZôPKôR@»ñ¨PKçö8ôR@»ñ¨ResourceContentsPK>/




/**********************************************************************
 * Copyright (c) 2006 IBM Corporation 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: 
 * IBM - Initial API and implementation
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.tests.common.stubs;

import java.util.Map;

import org.w3c.dom.DOMException;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;

public class AutoGUINamedNodeMap implements NamedNodeMap
{
	private Map attributes;
	
	public AutoGUINamedNodeMap(Map attributes)
	{
		this.attributes = attributes;
	}
	
	public int getLength()
	{
		return attributes.size();
	}

	public Node getNamedItem(String name)
	{
		return (Node)attributes.get(name);
	}

	public Node getNamedItemNS(String namespaceURI, String localName)
	{
		
		return null;
	}

	public Node item(int index)
	{
		
		return null;
	}

	public Node removeNamedItem(String name) throws DOMException
	{
		
		return null;
	}

	public Node removeNamedItemNS(String namespaceURI, String localName)
			throws DOMException
	{
		
		return null;
	}

	public Node setNamedItem(Node arg) throws DOMException
	{
		
		return null;
	}

	public Node setNamedItemNS(Node arg) throws DOMException
	{
		
		return null;
	}

}




#Mon Jan 28 23:44:11 CET 2008
eclipse.preferences.version=1
org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.2
org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
org.eclipse.jdt.core.compiler.compliance=1.4
org.eclipse.jdt.core.compiler.debug.lineNumber=generate
org.eclipse.jdt.core.compiler.debug.localVariable=generate
org.eclipse.jdt.core.compiler.debug.sourceFile=generate
org.eclipse.jdt.core.compiler.problem.assertIdentifier=warning
org.eclipse.jdt.core.compiler.problem.enumIdentifier=warning
org.eclipse.jdt.core.compiler.source=1.3

Added Link Here

(-)junit-plugin/TestCommandsByMacroPlayback.artifact (+4 lines)
1	PK÷=÷8ResourceContentsÅKOã0÷#ñ"³&ÎCí (ÊT©]å:nâ!±-Û!äß@!Pæ±Uä«s¿ë_<5µóH¤¢%Àw=àyAY»Íâì\\|;ùg¼i8ÛfíiÙJ¤>Ê×©Ôt°vrcL=Ö"°ë:7¥Ëe ïoJºpPçÙÍW¤Ag)&/®cDk*²ªDÁ¤VVóycu
2	è»è
3	QZH¾§5ù·`ýjciÔÏóÙù×ôÊ»ò½ ó²Ü.0góY8ÏÃPc.²·ZÄ
4	uÙß",ùªFýá`&á8±DêþZòV¨cáþÇði'ÀÐ:»p-·;ý+èy¾.ÒZÒ]k$#Å+%GÏÌnÒõzn¾çÕ©ä\Iþ`à¢¸Zh±EæÛ²¥ÛË%&ð-·ÕÔVè!ÜQË4 Hü;Üð¿à'õt§£5ïÑ®&ËçPY¡H÷Ââ~x»Ñfµ°ÇuKµÙJýo_ÙÈdÅ§îÃ?m¿ýPKn2L©ÄJPK÷=÷8n2L©ÄJResourceContentsPK>




###############################################################################
# Copyright (c) 2005, 2008 IBM Corporation 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
# $Id: feature.properties,v 1.6 2008/04/10 01:18:10 paules Exp $
# 
# Contributors:
#     IBM Corporation - initial API and implementation
###############################################################################

# feature.properties
# contains externalized strings for feature.xml
# "%foo" in feature.xml corresponds to the key "foo" in this file
# java.io.Properties file (ISO 8859-1 with "\" escapes)
# This file should be translated.

# NLS_MESSAGEFORMAT_NONE
# NLS_ENCODING=UTF-8

# "featureName" property - name of the feature
featureName=TPTP Automated GUI Recorder (AGR)

# "licenseURL" property - URL of the "Feature License"
# do not translate value - just change to point to a locale-specific HTML page
licenseURL=license.html

# "description" property - description of the feature
description=TPTP Automated GUI Recorder (AGR) used to record and playback user interactions with an Eclipse application. 

# "providerName" property - name of the company that provides the feature
providerName=Eclipse.org

# "license" property - text of the "Feature Update License"
# should be plain text version of license agreement pointed to be "licenseURL"
license=\
Eclipse Foundation Software User Agreement\n\
January 28, 2005\n\
\n\
Usage Of Content\n\
THE ECLIPSE FOUNDATION MAKES AVAILABLE SOFTWARE, DOCUMENTATION, INFORMATION \n\
AND/OR OTHER MATERIALS FOR OPEN SOURCE PROJECTS (COLLECTIVELY "CONTENT"). USE \n\
OF THE CONTENT IS GOVERNED BY THE TERMS AND CONDITIONS OF THIS AGREEMENT AND/OR \n\
THE TERMS AND CONDITIONS OF LICENSE AGREEMENTS OR NOTICES INDICATED OR \n\
REFERENCED BELOW. BY USING THE CONTENT, YOU AGREE THAT YOUR USE OF THE CONTENT \n\
IS GOVERNED BY THIS AGREEMENT AND/OR THE TERMS AND CONDITIONS OF ANY APPLICABLE \n\
LICENSE AGREEMENTS OR NOTICES INDICATED OR REFERENCED BELOW. IF YOU DO NOT \n\
AGREE TO THE TERMS AND CONDITIONS OF THIS AGREEMENT AND THE TERMS AND \n\
CONDITIONS OF ANY APPLICABLE LICENSE AGREEMENTS OR NOTICES INDICATED OR \n\
REFERENCED BELOW, THEN YOU MAY NOT USE THE CONTENT.\n\
\n\
Applicable Licenses\n\
Unless otherwise indicated, all Content made available by the Eclipse \n\
Foundation is provided to you under the terms and conditions of the Eclipse \n\
Public License Version 1.0 ("EPL"). A copy of the EPL is provided with this \n\
Content and is also available at http://www.eclipse.org/legal/epl-v10.html. For \n\
purposes of the EPL, "Program" will mean the Content.\n\
\n\
Content includes, but is not limited to, source code, object code, \n\
documentation and other files maintained in the Eclipse.org CVS repository \n\
("Repository") in CVS modules ("Modules") and made available as downloadable \n\
archives ("Downloads").\n\
\n\
Content may be apportioned into plug-ins ("Plug-ins"), plug-in fragments \n\
("Fragments"), and features ("Features"). A Feature is a bundle of one or more \n\
Plug-ins and/or Fragments and associated material. Files named "feature.xml" \n\
may contain a list of the names and version numbers of the Plug-ins and/or \n\
Fragments associated with a Feature. Plug-ins and Fragments are located in \n\
directories named "plugins" and Features are located in directories named \n\
"features".\n\
\n\
Features may also include other Features ("Included Features"). Files named \n\
"feature.xml" may contain a list of the names and version numbers of Included \n\
Features.\n\
\n\
The terms and conditions governing Plug-ins and Fragments should be contained \n\
in files named "about.html" ("Abouts"). The terms and conditions governing \n\
Features and Included Features should be contained in files named \n\
"license.html" ("Feature Licenses"). Abouts and Feature Licenses may be located \n\
in any directory of a Download or Module including, but not limited to the \n\
following locations:\n\
\n\
The top-level (root) directory \n\
Plug-in and Fragment directories \n\
Subdirectories of the directory named "src" of certain Plug-ins \n\
Feature directories \n\
Note: if a Feature made available by the Eclipse Foundation is installed using \n\
the Eclipse Update Manager, you must agree to a license ("Feature Update \n\
License") during the installation process. If the Feature contains Included \n\
Features, the Feature Update License should either provide you with the terms \n\
and conditions governing the Included Features or inform you where you can \n\
locate them. Feature Update Licenses may be found in the "license" property of \n\
files named "feature.properties". Such Abouts, Feature Licenses and Feature \n\
Update Licenses contain the terms and conditions (or references to such terms \n\
and conditions) that govern your use of the associated Content in that \n\
directory.\n\
\n\
THE ABOUTS, FEATURE LICENSES AND FEATURE UPDATE LICENSES MAY REFER TO THE EPL \n\
OR OTHER LICENSE AGREEMENTS, NOTICES OR TERMS AND CONDITIONS. SOME OF THESE \n\
OTHER LICENSE AGREEMENTS MAY INCLUDE (BUT ARE NOT LIMITED TO):\n\
\n\
Common Public License Version 1.0 (available at http://www.eclipse.org/legal/cpl-v10.html) \n\
Apache Software License 1.1 (available at http://www.apache.org/licenses/LICENSE) \n\
Apache Software License 2.0 (available at http://www.apache.org/licenses/LICENSE-2.0) \n\
IBM Public License 1.0 (available at http://oss.software.ibm.com/developerworks/opensource/license10.html) \n\
Metro Link Public License 1.00 (available at http://www.opengroup.org/openmotif/supporters/metrolink/license.html) \n\
Mozilla Public License Version 1.1 (available at http://www.mozilla.org/MPL/MPL-1.1.html) \n\
\n\
IT IS YOUR OBLIGATION TO READ AND ACCEPT ALL SUCH TERMS AND CONDITIONS PRIOR TO \n\
USE OF THE CONTENT. If no About, Feature License or Feature Update License is \n\
provided, please contact the Eclipse Foundation to determine what terms and \n\
conditions govern that particular Content.\n\
\n\
Cryptography\n\
Content may contain encryption software. The country in which you are currently \n\
may have restrictions on the import, possession, and use, and/or re-export to \n\
another country, of encryption software. BEFORE using any encryption software, \n\
please check the country's laws, regulations and policies concerning the \n\
import, possession, or use, and re-export of encryption software, to see if \n\
this is permitted.\n
########### end of license property ##########################################

Lines 15-21 Link Here

(-)feature.xml (-1 / +1 lines)
15	<feature	15	<feature
16	id="org.eclipse.tptp.test.auto"	16	id="org.eclipse.tptp.test.auto"
17	label="%featureName"	17	label="%featureName"
18	version="4.2.0.qualifier"	18	version="4.6.0.qualifier"
19	provider-name="%providerName">	19	provider-name="%providerName">
20		20
21	<description>	21	<description>

Lines 1-4 Link Here

(-)build.properties (-4 / +3 lines)
1	bin.includes = feature.xml,\	1	bin.includes = feature.xml,\
2	epl-v10.html,\	2	epl-v10.html,\
3	feature.properties,\	3	license.html
4	license.html




<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
	<name>org.eclipse.tptp.test.auto-feature</name>
	<comment></comment>
	<projects>
	</projects>
	<buildSpec>
		<buildCommand>
			<name>org.eclipse.pde.ManifestBuilder</name>
			<arguments>
			</arguments>
		</buildCommand>
		<buildCommand>
			<name>org.eclipse.pde.SchemaBuilder</name>
			<arguments>
			</arguments>
		</buildCommand>
	</buildSpec>
	<natures>
		<nature>org.eclipse.pde.PluginNature</nature>
	</natures>
</projectDescription>




/*******************************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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
 * $Id: VerificationCommand.java,v 1.1 2006/07/10 14:49:05 amehregani Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.io.File;
import java.lang.reflect.Constructor;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Hashtable;
import java.util.StringTokenizer;
import java.util.Vector;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.hyades.test.common.junit.HyadesTestSuite;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macro.ModeConstants;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.resolver.MacroObjectResolver;
import org.eclipse.tptp.test.auto.gui.internal.runner.AutoGUIVerificationHook;
import org.eclipse.tptp.test.auto.gui.internal.util.VerificationHookClassLoader;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IViewPart;
import org.w3c.dom.Node;

/**
 * The following command is inserted for every verification hook that the user
 * inserts for a particular test case. An instance of this class can only be
 * created through constructInstance(Event). <br/> In order for clients to be
 * able to write or playback this command they must meet the following
 * pre-conditions.
 * 
 * <ul>
 * <li> test suite must be set using setTestSuite </li>
 * <li> verification hook must be set using setVerificationHook </li>
 * </ul>
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen (refactored to be a normal object based command and
 *         use the new resolving mechanism)
 */
public class VerificationCommand extends ObjectBasedCommand {

	/* The type of this command */
	public static final String TYPE = IMacroCommand.VERIFICATION;

	/* The possible types */
	public static final byte EDITOR = 0x01;
	public static final byte VIEW = 0x02;
	public static final byte SHELL = 0x03;

	/* The location is the plugin that contains the hook source code */
	private String location;

	/* The resource is the class name containing the hook */
	private String resource;

	/* The hook is the method name representing the verification point */
	private String hook;

	/* The focus type indicates whether the type of context being retrieved */
	private byte focusType;

	private Class contextClass;

	private Class widgetClass;

	private Class objectClass;

	/*
	 * flag to indicate if additionally to the context id, an object id should
	 * be used as verification hook target
	 */
	private boolean extendedScope = false;

	/**
	 * The constructor
	 * 
	 * @param metaData
	 *            The meta data that this verification command uses to write or
	 *            play back itself.
	 */
	public VerificationCommand(MacroCommandShell parent) {
		super(parent);
	}

	public String getType() {
		return TYPE;
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.tptp.test.auto.gui.internal.commands.IMacroCommand#processEvent(org.eclipse.swt.widgets.Event)
	 */
	public void doProcessEvent(Event event) {
		focusType = findFocusType(getMacroObjectIdentifier()
				.getContextIdentifier());
		contextClass = findContextClass(getMacroObjectIdentifier()
				.getContextIdentifier());
		widgetClass = macroObject.getUIObject().getWidget().getClass();
		if (macroObject.getUIObject().getObject() != null) {
			objectClass = macroObject.getUIObject().getObject().getClass();
		}
	}

	/**
	 * A chance to build the meta-data of this verification command
	 */
	public void load(Node node, Hashtable lineTable) throws CoreException {
		super.load(node, lineTable);

		// String contextId = MacroUtil.getAttribute(node,
		// "contextId");
		focusType = findFocusType(getMacroObjectIdentifier()
				.getContextIdentifier());
		contextClass = findContextClass(getMacroObjectIdentifier()
				.getContextIdentifier());
		location = MacroUtil.getAttribute(node, "location");
		resource = MacroUtil.getAttribute(node, "resource");
		hook = MacroUtil.getAttribute(node, "hook");
		// if the hook has more than one parameter, we are in extended scope
		// mode
		setExtendedScope(hook.indexOf(';') != hook.lastIndexOf(";"));
		// if we are in extended mode, we have to load the object class.
		if (isExtendedScope()) {
			widgetClass = findWidgetClass(hook);
			objectClass = findObjectClass(hook);
		}
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.tptp.test.auto.gui.internal.commands.ObjectBasedCommand#loadMacroObjectIdentifier(org.w3c.dom.Node,
	 *      java.util.Hashtable)
	 */
	protected void loadMacroObjectIdentifier(Node node, Hashtable lineTable)
			throws CoreException {
		// let the super implementation try (in case we are in extended mode,
		// this should build a valid descriptor)
		super.loadMacroObjectIdentifier(node, lineTable);

		// if we are not in extended mode, just set the context id
		if (getMacroObjectIdentifier() == null) {
			String cid = MacroUtil.getAttribute(node,
					MacroConstants.CONTEXT_ID_ATTRIBUTE);
			setMacroObjectIdentifier(new MacroObjectIdentifier(cid, null));
		}
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.tptp.test.auto.gui.internal.commands.ObjectBasedCommand#writeMacroObjectIdentifier(int,
	 *      java.lang.StringBuffer, boolean, boolean)
	 */
	protected void writeMacroObjectIdentifier(int indent, StringBuffer sb,
			boolean close, boolean end) {
		if (isExtendedScope()) {
			// write the normal triple (contextID, objectID, resolverID)
			super.writeMacroObjectIdentifier(indent, sb, close, end);
		} else {
			// only write the context id
			MacroUtil.addAttribute(sb,
					new String[] { MacroConstants.CONTEXT_ID_ATTRIBUTE },
					new String[] { getMacroObjectIdentifier()
							.getContextIdentifier() }, close, end);
		}
	}

	/**
	 * Invoked when this writable object is ready to be written to a print
	 * writer.
	 */
	public void write(int indent, StringBuffer sb) {
		// let the super implementation write the element, we will just add our
		// attributes
		super.write(indent, sb);
		/*
		 * If the default package is selected for a verification hook class, it
		 * is often prefixed with a '.' This needs to be taken out before
		 * written as part of the macro
		 */
		if (resource != null && resource.length() > 0
				&& resource.charAt(0) == '.')
			resource = resource.substring(1);

		MacroUtil.addAttribute(sb, new String[] {
		/*
		 * MacroConstants.TYPE_ATTRIBUTE, MacroConstants.CONTEXT_ID_ATTRIBUTE,
		 */
		MacroConstants.LOCATION_ATTRIBUTE, MacroConstants.RESOURCE_ATTRIBUTE,
				MacroConstants.HOOK_ATTRIBUTE }, new String[] {/*
																 * getType(),
																 * metaData.getContextId(),
																 */
		location, resource, hook }, true, true);

	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.tptp.test.auto.gui.internal.commands.ObjectBasedCommand#useObjectMine()
	 */
	protected boolean useObjectMine() {
		// verification commands do never use the object mine (why?)
		return false;
	}

	private Class findWidgetClass(String hook) {
		// parse the hook signature to retrieve the class name of the widget
		// class
		String className = hook.substring(hook.indexOf(";Q") + 2, hook.indexOf(
				";", hook.indexOf(";Q") + 2));
		try {
			return loadClass(className);
		} catch (Exception e) {
			return null;
		}
	}

	private Class findObjectClass(String hook) {
		// see if we have also an object parameter
		String className = hook.substring(hook.indexOf(";Q",
				hook.indexOf(";Q") + 2) + 2, hook.lastIndexOf(";"));
		try {
			return loadClass(className);
		} catch (Exception e) {
			return null;
		}
	}

	private Class loadClass(String className) throws MalformedURLException,
			CoreException, ClassNotFoundException {
		String classPath = System.getProperty("java.class.path");
		Vector reqPlugins = null;

		/*
		 * If we happen to run in the quick run mode, then we need to explicitly
		 * modify the class path ourself.
		 */
		if (MacroManager.getInstance().getGlobalState() == ModeConstants.QUICK_RUN_MODE) {
			/* The project is expected to be a java project */
			IJavaProject javaProject = AutoGUIUtil.findJavaProject(location);

			/*
			 * We need to add the output folder of all the java projects in our
			 * workspace to the classpath
			 */
			classPath += AutoGUIUtil.appendWSProjOutputFolder(classPath);

			if (javaProject != null && javaProject.exists()) {
				/* Add the classpath entries of the project */
				reqPlugins = new Vector(5);
				classPath += AutoGUIUtil.findDependencies(javaProject,
						reqPlugins, true);
			}
		}

		/*
		 * Otherwise we're running in execution mode. We'll still need to
		 * resolve the dependencies of the plugin containing the test suite. If
		 * any exists, then it would have been registerd with the MacroManager.
		 */
		else {
			reqPlugins = MacroManager.getInstance().getDependecies();
		}

		StringTokenizer st = new StringTokenizer(classPath, File.pathSeparator);
		Vector urlsVec = new Vector(10);

		/* https://bugs.eclipse.org/bugs/show_bug.cgi?id=136157 */
		final String PREFIX = "file:";

		while (st.hasMoreTokens()) {
			String curURL = st.nextToken();

			/*
			 * The URL class loader will require all directories to end with a
			 * forward slash
			 */
			if (!curURL.endsWith(".jar") && !curURL.endsWith("/"))
				curURL += "/";

			urlsVec.add(new URL(PREFIX + curURL));
		}

		/* Construct the urls */
		URL[] urls = new URL[urlsVec.size()];
		for (int i = 0; i < urls.length; i++) {
			urls[i] = (URL) urlsVec.get(i);
		}

		ClassLoader customClassLoader = new VerificationHookClassLoader(urls,
				this.getClass().getClassLoader(), reqPlugins);
		return Class.forName(className, true, customClassLoader);
	}

	/**
	 * This doesn't involve any UI actions. Playing back the verification
	 * command will simply run the verification hook.
	 * 
	 * @throws CoreException
	 */
	public boolean playback(Display display, Shell parent,
			IProgressMonitor monitor) throws CoreException {
		/*
		 * Phases: 1. Load the necessary class 2. Do the method look up on the
		 * hook entry 3. If valid: 4. Load its context (i.e. View/Editor/etc...)
		 * 5. Invoke the hook with the context
		 */
		try {
			Class verifyHookClass = loadClass(resource);

			if (isExtendedScope()) {
				macroObject = MacroObjectResolver.deresolve(getParent()
						.getShell(), getMacroObjectIdentifier());
			}

			Object[] args = isExtendedScope() ? (macroObject.getUIObject()
					.getObject() != null ? new Object[3] : new Object[2])
					: new Object[1];
			String contextId = new Path(getMacroObjectIdentifier()
					.getContextIdentifier()).segment(1);

			if (focusType == VIEW) {
				IViewPart view = MacroUtil.locateView(display.getActiveShell(),
						contextId);
				args[0] = view;
			} else if (focusType == EDITOR) {
				IEditorPart editor = MacroUtil.locateEditor(display
						.getActiveShell(), contextId, null);
				args[0] = editor;
			} else if (focusType == SHELL) {
				Shell shell = getParent().getShell();
				args[0] = shell;
			}

			if (isExtendedScope()) {
				args[1] = macroObject.getUIObject().getWidget();
				if (macroObject.getUIObject().getObject() != null) {
					args[2] = macroObject.getUIObject().getObject();
				}
			}

			/* Construct the test case */
			HyadesTestSuite testSuite = new HyadesTestSuite();
			Constructor constructor = verifyHookClass
					.getConstructor(new Class[] { String.class, Class[].class,
							Object[].class });

			String testMethodName = findMethodName(hook);

			Class[] testMethodParams = isExtendedScope() ? (macroObject
					.getUIObject().getObject() != null ? new Class[] {
					getContextClass(), getWidgetClass(), getObjectClass() }
					: new Class[] { getContextClass(), getWidgetClass() })
					: new Class[] { getContextClass() };
			AutoGUIVerificationHook verificationHook = (AutoGUIVerificationHook) constructor
					.newInstance(new Object[] { testMethodName,
							testMethodParams, args });
			verificationHook.setTestInvocationId("invocation-id-"
					+ System.currentTimeMillis());
			testSuite.addTest(verificationHook);

			/*
			 * If we are running in quick mode, then report verification test
			 * methods that are missing
			 */
			if (MacroManager.getInstance().getGlobalState() == ModeConstants.QUICK_RUN_MODE) {
				try {
					verificationHook.getClass().getMethod(testMethodName,
							testMethodParams);
				} catch (NoSuchMethodException e) {
					AutoGUIUtil
							.showMessage(
									AutoGUIMessages.AUTO_GUI_ERROR_VER_METHOD_NF_T,
									NLS
											.bind(
													AutoGUIMessages.AUTO_GUI_ERROR_VER_METHOD_NF,
													new String[] {
															testMethodName,
															String
																	.valueOf(getStartLine()) }),
									MessageDialog.WARNING);
				}
			}
			MacroManager.getInstance().getRunner().runVerificationHook(
					testSuite);

			return true;

		} catch (ClassNotFoundException e) {
			e.printStackTrace();
			/*
			 * The class was not found. The classpath should have been set by
			 * the deployment adapter (JavaExecutionDeploymentAdapter) and the
			 * file should have been transferred to the system's temporary
			 * directory. This is an internal error
			 */
			String[] args = { resource, hook };
			AutoGUIUtil.throwCoreException(NLS.bind(
					AutoGUIMessages.AUTO_GUI_ERROR_VER_CLASS_NOT_F, args),
					super.getStartLine(), e);			
		} catch (CoreException e) {
			e.printStackTrace();
			String[] args = {
					getMacroObjectIdentifier().getContextIdentifier(), hook };
			AutoGUIUtil.throwCoreException(NLS.bind(
					AutoGUIMessages.AUTO_GUI_ERROR_VER_CONTEXT, args), super
					.getStartLine());
		} catch (InstantiationException e) {
			e.printStackTrace();
			AutoGUIUtil.throwCoreException(NLS.bind(
					AutoGUIMessages.AUTO_GUI_ERROR_VER_INSTANTIATE, resource),
					super.getStartLine(), e);
		} catch (IllegalArgumentException e) {
			e.printStackTrace();
			AutoGUIUtil.throwCoreException(
					AutoGUIMessages.AUTO_GUI_ERROR_VER_ARG_EXCEPT, super
							.getStartLine());
		} catch (Exception e) {
			e.printStackTrace();
			AutoGUIUtil.throwCoreException(AutoGUIUtil.getOriginOfException(e),
					super.getStartLine(), e);
		}

		return false;
	}

	/**
	 * Given a context id, return the focus type.
	 * 
	 * @param contextId
	 *            The id of the context
	 * @return The type of the context (i.e. focus type). -1 is returned if the
	 *         focus type is not recognized.
	 */
	public static byte findFocusType(String contextId) {
		if (contextId.startsWith(MacroConstants.VIEW_VALUE + "/"))
			return VIEW;
		else if (contextId.startsWith(MacroConstants.EDITOR_VALUE + "/"))
			return EDITOR;
		else if (contextId.startsWith(MacroConstants.SHELL_VALUE + "/"))
			return SHELL;

		return -1;
	}

	/**
	 * Find the method name corresponding the verification hook
	 * 
	 * @param metaData
	 * @return
	 */
	public static String findMethodName(String hook) {
		String methodName = hook;

		if (methodName == null || methodName.length() <= 0)
			return null;

		int index = methodName.indexOf(':');
		if (index != -1)
			return methodName.substring(0, index);

		return methodName;
	}

	/**
	 * Find the parameter types of the verificaiton hook
	 * 
	 * @param metaData
	 * @return
	 */
	private Class findContextClass(String contextId) {
		Class param = null;
		byte focusType = findFocusType(contextId);
		if (focusType == EDITOR)
			param = IEditorPart.class;
		else if (focusType == VIEW)
			param = IViewPart.class;
		else if (focusType == SHELL)
			param = Shell.class;

		return param;
	}

	/**
	 * Return the class name containing the verification point that this meta
	 * data points to.
	 * 
	 * @param metaData
	 *            The verification point's meta data
	 * @return The class name. null is returned if it can't be determined
	 */
	public static String getClassName(String resource) {
		String className = resource;

		if (className == null || className.length() <= 0)
			return null;

		int index = className.lastIndexOf('.');
		if (index != -1)
			return className.substring(index + 1, className.length());
		return className;
	}

	public void setLocation(String location) {
		this.location = location;
	}

	public void setResource(String resource) {
		this.resource = resource;
	}

	public void setHook(String hook) {
		this.hook = hook;
	}

	public Class getObjectClass() {
		return objectClass;
	}

	public Class getWidgetClass() {
		return widgetClass;
	}

	public Class getContextClass() {
		return contextClass;
	}

	public String getLocation() {
		return location;
	}

	public String getResource() {
		return resource;
	}

	public String getHook() {
		return hook;
	}

	public boolean isExtendedScope() {
		return extendedScope;
	}

	public void setExtendedScope(boolean extendedScope) {
		this.extendedScope = extendedScope;
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.util.ArrayList;
import java.util.Hashtable;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.jobs.IJobChangeEvent;
import org.eclipse.core.runtime.jobs.IJobManager;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.core.runtime.jobs.JobChangeAdapter;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.w3c.dom.Node;

/**
 * <p>
 * The purpose of this command is to provide a waiting mechanism so as to avoid
 * racing conditions that may cause a test case to fail when the underlying
 * functionality works as expected.
 * </p>
 * 
 * <p>
 * The command has a dual behaviour depending on whether the waitTime field is
 * set or not. If this field is set, then this command will cause the caller
 * thread to wait 'waitTime' milliseconds. If the field is not set, then the
 * command will cause the caller thread to wait until all non-system Eclipse
 * jobs are completed.
 * </p>
 */
public class WaitCommand extends AbstractMacroCommand {

	public static final String TYPE = IMacroCommand.WAIT;

	/*
	 * The amount of waiting time. If this field is set, then this command
	 * behaves differently
	 */
	private long waitTime;

	private static class JobListener extends JobChangeAdapter {

		private int counter = 0;

		private IProgressMonitor monitor;

		private Thread t;

		public JobListener(IProgressMonitor monitor, Thread t, int number) {
			this.counter = number;
			this.monitor = monitor;
			this.t = t;
		}

		private synchronized void change(int increment) {
			this.counter += increment;
			if (counter == 0) {
				monitor.subTask("");
				synchronized (t) {
					t.interrupt();
				}
			}
		}

		public void running(IJobChangeEvent event) {
			Job job = event.getJob();
			if (!job.isSystem())
				change(1);
		}

		public void done(IJobChangeEvent event) {
			Job job = event.getJob();
			if (!job.isSystem())
				change(-1);
		}
	}

	/**
	 * A chance to build the meta-data of this verification command
	 */
	public void load(Node node, Hashtable lineTable) throws CoreException {
		super.load(node, lineTable);

		String waitTime = MacroUtil.getAttribute(node,
				MacroConstants.TIME_TO_WAIT_ATTRIBUTE);

		if (waitTime != null && waitTime.length() > 0) {
			try {
				long timeToWait = Long.parseLong(waitTime);
				if (timeToWait > 0)
					this.waitTime = timeToWait;
			} catch (NumberFormatException nfe) {
				nfe.printStackTrace();
			}
		}
	}

	public WaitCommand(MacroCommandShell parent) {
		super(parent);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.macro.MacroCommand#getType()
	 */
	public String getType() {
		return TYPE;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.macro.MacroCommand#processEvent(org.eclipse.swt.widgets.Event)
	 */
	public void processEvent(Event e) {
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.macro.IWritable#write(java.lang.String,
	 *      java.io.PrintWriter)
	 */
	public void write(int indent, StringBuffer sb) {
		/*
		 * Don't print out this wait command if it happens to be the last
		 * command in the macro shell OR the next command following it is a
		 * macro command shell
		 */
		ArrayList commands = getParent().getCommands();
		int commandSize = commands.size();
		if ((commandSize > 0 && this == commands.get(commandSize - 1))
				|| isNextCommandShell(commands))
			return;

		MacroUtil.addElement(sb, indent, MacroConstants.COMMAND_ELEMENT, false,
				false);
		MacroUtil.addAttribute(sb, new String[] {
				MacroConstants.DESCRIPTIVE_ATTRIBUTE,
				MacroConstants.TYPE_ATTRIBUTE,
				MacroConstants.TIME_TO_WAIT_ATTRIBUTE }, new String[] {
				MacroUtil.boundSize(getDescriptiveField(),
						AbstractMacroCommand.DESCRIPTIVE_FIELD_BOUND),
				getType(), waitTime > 0 ? String.valueOf(waitTime) : null },
				true, true);
	}

	private boolean isNextCommandShell(ArrayList commands) {
		int index = -1;

		int commandCount = commands.size();
		for (int i = 0; i < commandCount; i++) {
			if (this == commands.get(i)) {
				index = i;
				break;
			}
		}

		if (index + 1 < commandCount)
			return commands.get(index + 1) instanceof MacroCommandShell;
		return false;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.macro.IPlayable#playback(org.eclipse.swt.widgets.Composite)
	 */
	public boolean playback(Display display, Shell parent,
			IProgressMonitor monitor) throws CoreException {

		if (waitTime > 0) {
			try {
				Thread.sleep(waitTime);
			} catch (InterruptedException e) {
				/* Doesn't need to be handled */
			}
			return true;
		}

		IJobManager jobManager = Platform.getJobManager();
		int nrunning = getNumberOfRunningJobs(jobManager);
		if (nrunning == 0) {
			return true;
		}
		String message = AutoGUIMessages.AUTO_GUI_MACRO_WAITING;
		JobListener listener = new JobListener(monitor, Thread.currentThread(),
				nrunning);
		jobManager.addJobChangeListener(listener);
		monitor.subTask(message);

		final long INCREMENT_WAIT = 2000;
		final int MAX_INCREMENT_NUM = 5;
		try {
			int counter = 0;

			/*
			 * Let's wait in increments of INCREMENT_WAIT milliseconds for a
			 * maximum of INCREMENT_WAIT * MAX_INCREMENT_NUM milliseconds
			 */
			while (counter < MAX_INCREMENT_NUM) {
				Thread.sleep(INCREMENT_WAIT);
				if (getNumberOfRunningJobs(jobManager) == 0)
					break;
				counter++;
			}

		} catch (InterruptedException e) {
		}
		jobManager.removeJobChangeListener(listener);
		return true;
	}

	private int getNumberOfRunningJobs(IJobManager manager) {
		int count = 0;
		Job[] jobs = manager.find(null);
		for (int i = 0; i < jobs.length; i++) {
			if (!jobs[i].isSystem() && jobs[i].getState() == Job.RUNNING)
				count++;
		}
		return count;
	}

	public void setWaitTime(long difference) {
		this.waitTime = difference;
	}

	/**
	 * Overwrite this method so that a custom descriptive field can be
	 * specified. The format of the descriptive field is "<WAIT_TIME> seconds"
	 * 
	 * @return The descriptive field.
	 */
	public String getDescriptiveField() {
		if (waitTime > 0)
			return (((double) waitTime) / 1000.0) + " "
					+ AutoGUIMessages.TST_SUITE_AUTO_MACRO_SECONDS;

		return null;
	}
	}

	public void setWaitTime(long difference) 
	{
		this.waitTime = difference;
	}
	
	/**
	 * Overwrite this method so that a custom descriptive field can be specified.
	 * The format of the descriptive field is "<WAIT_TIME> seconds"
	 * 
	 * @return The descriptive field.
	 */
	public String getDescriptiveField()
	{
		if (waitTime > 0)
			return (((double)waitTime) / 1000.0)  + " " + AutoGUIMessages.TST_SUITE_AUTO_MACRO_SECONDS;
		
		return null;
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import org.eclipse.swt.widgets.Widget;
import org.eclipse.ui.IViewPart;
import org.eclipse.ui.IWorkbenchPage;

public class ViewCommandTarget extends CommandTarget {
	public ViewCommandTarget(Widget widget, IViewPart view) {
		super(widget, view);
	}
	
	public IViewPart getView() {
		return (IViewPart)getContext();
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.macro.CommandTarget#ensureVisible()
	 */
	public void ensureVisible() {
		IViewPart view = getView();
		IWorkbenchPage page = view.getViewSite().getPage();
		page.activate(view);
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;

public class FocusCommand extends ObjectBasedCommand {

	public static final String TYPE = IMacroCommand.FOCUS;

	public FocusCommand(MacroCommandShell parent) {
		super(parent);
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.commands.AbstractMacroCommand#mergeEvent(org.eclipse.swt.widgets.Event)
	 */
	public boolean mergeEvent(Event e) throws Exception {
		/* we can directly merge repeated focus requests on the same widget */
		return true;
	}

	/**
	 * @see org.eclipse.ui.macro.MacroCommand#getType()
	 */
	public String getType() {
		return TYPE;
	}

	/**
	 * @see org.eclipse.ui.macro.MacroCommand#processEvent(org.eclipse.swt.widgets.Event)
	 */
	public void doProcessEvent(Event e) {
		findDescriptiveField(e.widget);
	}

	/**
	 * @see org.eclipse.ui.macro.IPersistable#write(java.lang.String,
	 *      java.io.PrintWriter)
	 */
	public void write(int indent, StringBuffer sb) {
		/* Don't bother with the focus command if the id is invalid */
		if (getMacroObjectIdentifier() == null)
			return;

		super.write(indent, sb, true, true);
	}

	/**
	 * @see org.eclipse.ui.macro.IPlayable#playback(org.eclipse.swt.widgets.Composite)
	 */
	public boolean doPlayback(Display display, Shell parent,
			IProgressMonitor monitor) throws CoreException {
		if (parent.isDisposed())
			return false;
		if (macroObject != null)
			setFocus(macroObject);
		return true;
	}

	public boolean playback(Display display, Composite parent, IProgressMonitor monitor) throws CoreException
	{
		if (parent.isDisposed())
			return false;
		CommandTarget[] targets = MacroObjectLocator.locateCommandTarget(parent,getWidgetId(), getStartLine());
		if (targets !=null && targets.length > 0)
			targets[0].setFocus();
		return true;
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.util.ArrayList;
import java.util.Hashtable;
import java.util.Map;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.hyades.test.common.util.XMLUtil;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Item;
import org.eclipse.swt.widgets.List;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableItem;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptor;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.PrimitiveUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.UIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.UIObjectResolver;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.deresolvingsupport.UIObjectDeprecatedDeresolvingSupport;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * An abstract structured command that other commands can optionally extend.
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen
 */
public abstract class AbstractStructuredCommand extends ObjectBasedCommand {

	/**
	 * The items that are associated with the structured selection. The list
	 * contains Hashtable entries with the following content: KEY = XML
	 * attribute of the item VALUE = The value of the attribute
	 */
	protected ArrayList items;

	/**
	 * The constructor
	 * 
	 * @param parent
	 *            The parent macro command shell owning this command
	 * @param wid
	 *            The widget identifier
	 */
	public AbstractStructuredCommand(MacroCommandShell parent) {
		super(parent);
		items = new ArrayList();
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.commands.AbstractMacroCommand#mergeEvent(org.eclipse.swt.widgets.Event)
	 */
	public boolean mergeEvent(Event e) throws Exception {
		items.clear();
		doProcessEvent(e);
		return true;
	}

	/**
	 * Returns the items that are embedded in the event passed in
	 * 
	 * @param event
	 *            The event
	 * @return The items of the event
	 */
	protected Object[] getItemsForEvent(Event event) {
		Widget item = null;
		if (event.item != null)
			item = event.item;
		else if (event.widget instanceof Item)
			item = event.widget;
		if (item != null)
			return new Widget[] { item };
		return null;
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.commands.AbstractMacroCommand#processEvent(org.eclipse.swt.widgets.Event)
	 */
	public void doProcessEvent(Event event) {
		Object[] eventItems = getItemsForEvent(event);
		boolean isWidget = eventItems instanceof Widget[];
		boolean isString = false;

		if (!isWidget)
			isString = eventItems instanceof String[];

		/*
		 * Populate the items instance variable according to the items of the
		 * event
		 */
		if (eventItems != null) {
			/* For every embedded item */
			for (int i = 0; i < eventItems.length; i++) {
				Map attributeValuePairs = null;

				if (isWidget) {
					attributeValuePairs = getItemAttributes((Widget) eventItems[i]);
				} else if (isString) {
					attributeValuePairs = getItemAttributes(null,
							new PrimitiveUIObjectIdentifier(
									(String) eventItems[i]));
				}

				if (attributeValuePairs != null) {
					items.add(attributeValuePairs);
				}
			}
		}

		super.findDescriptiveField(eventItems);
	}

	/**
	 * Returns the item attributes that will be used to find and resolve the
	 * item that is associated with this structured command.
	 * 
	 * @param item
	 *            The item
	 * @return A map indicating the item attributes and values; null if the item
	 *         can't be resolved.
	 */
	protected Map getItemAttributes(Widget item) {
		IUIObjectIdentifier id = null;
		try {
			id = UIObjectResolver.resolve(null, new UIObject(item));
		} catch (CoreException e) {
			e.printStackTrace();
		}
		if (id == null) {
			id = getDefaultItemAttributes(item);
		}

		if (id != null) {
			return getItemAttributes(item, id);
		}

		return null;
	}

	/**
	 * Returns the item attributes that will be used to find and resolve the
	 * item that is associated with this structured command.
	 * 
	 * @param item
	 *            The item
	 * @param id
	 *            The item id
	 * @return A map indicating the item attributes and values; null if the item
	 *         can't be resolved.
	 */
	private Map getItemAttributes(Widget item, IUIObjectIdentifier id) {
		Hashtable attributeValuePair = new Hashtable();
		attributeValuePair.put(MacroConstants.WIDGET_ID_ATTRIBUTE, id);

		MacroObjectDescriptor uiObject = findItemInObjectMine(item, id);
		if (uiObject != null) {
			attributeValuePair.put(MacroConstants.REFERENCE_ID_ATTRIBUTE,
					uiObject.getReferenceId());
		}

		if (id.getResolverId() != null) {
			attributeValuePair.put(MacroConstants.RESOLVER_ID_ATTRIBUTE, id
					.getResolverId());
		}
		return attributeValuePair;
	}

	/**
	 * Attempts to find an item in the current object mine. If it's not found,
	 * then it is registered.
	 * 
	 * @param item
	 *            The item
	 * @param id
	 *            The item id
	 * @return The object or null if it cannot be found or registered.
	 */
	private MacroObjectDescriptor findItemInObjectMine(Widget item,
			IUIObjectIdentifier id) {
		if (useObjectMine()) {
			/* Determine if the item is already registered with the object mine */
			MacroObjectDescriptorMine objectMine = MacroManager.getInstance()
					.getObjectMine();
			MacroObjectDescriptor activeObject = getCorrespondingMacroObjectDescriptor();
			MacroObjectDescriptor objectItem = null;
			if (activeObject != null) {
				objectItem = objectMine.lookupMacroObjectDescriptor(
						activeObject, null, id.getWidgetId(), id.getObjectId());
				/* It's not registered, register the object */
				if (objectItem == null) {
					objectItem = new MacroObjectDescriptor(activeObject);
					((MacroObjectDescriptor) objectItem).setWidgetId(id
							.getWidgetId());
					((MacroObjectDescriptor) objectItem).setResolver(id
							.getResolverId());
					((MacroObjectDescriptor) objectItem).setObjectId(id
							.getObjectId());
					String descriptiveField = getObjectClassName(item);
					if (descriptiveField == null)
						descriptiveField = MacroConstants.EMPTY_STRING;
					String itemText = getText(item);
					descriptiveField += itemText == null ? MacroConstants.EMPTY_STRING
							: ": " + itemText;
					((MacroObjectDescriptor) objectItem).setDescriptive(XMLUtil
							.useXMLSymbols(MacroUtil
									.normalizeDescriptiveField(MacroUtil
											.boundSize(descriptiveField,
													DESCRIPTIVE_FIELD_BOUND))));
					((MacroObjectDescriptor) objectItem)
							.setParent(activeObject);
					try {
						objectMine
								.registerObject((MacroObjectDescriptor) objectItem);
					} catch (Exception e) {
						objectItem = null;

						/*
						 * We can't show an error message because it will
						 * distrupt the record session, instead print to error
						 * stream
						 */
						System.err
								.println(AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE_REG);
						e.printStackTrace();
					}
				}
			}

			return objectItem;
		} else {
			return null;
		}
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.macro.AbstractMacroInstruction#getCorrespondingMacroObjectDescriptor()
	 */
	public MacroObjectDescriptor getCorrespondingMacroObjectDescriptor() {
		if (super.getCorrespondingMacroObjectDescriptor() != null)
			return super.getCorrespondingMacroObjectDescriptor();

		MacroObjectDescriptorMine objectMine = MacroManager.getInstance()
				.getObjectMine();
		MacroObjectDescriptor activeObject = objectMine.getActiveObject();

		if (useObjectMine() && getMacroObjectIdentifier() != null) {
			String contextId = (getMacroObjectIdentifier()
					.getContextIdentifier() == null) ? null
					: getMacroObjectIdentifier().getContextIdentifier()
							.toString();
			super
					.setCorrespondingMacroObjectDescriptor(activeObject == null ? null
							: objectMine.lookupMacroObjectDescriptor(
									activeObject, contextId,
									getMacroObjectIdentifier()
											.getObjectIdentifier()
											.getWidgetId(),
									getMacroObjectIdentifier()
											.getObjectIdentifier()
											.getObjectId()));
		}

		return super.getCorrespondingMacroObjectDescriptor();
	}

	/**
	 * Returns the tree item index in the form of N1|N2|N2|...|Nn where Ni
	 * corresponds to the item index in the tree.
	 * 
	 * @param treeItem
	 *            The tree item
	 * @param currentInx
	 *            The current index
	 * @return A string representation of the index.
	 */
	private static String findTreeItemInx(TreeItem treeItem, String currentInx) {
		if (currentInx != null && currentInx.length() > 0)
			currentInx = "|" + currentInx;

		/* We're not the root */
		if (treeItem.getParentItem() != null) {
			TreeItem parentItem = treeItem.getParentItem();
			currentInx = parentItem.indexOf(treeItem) + "|" + currentInx;
			return findTreeItemInx(parentItem, currentInx);
		}
		/* Otherwise we are the root */
		int index = treeItem.getParent().indexOf(treeItem);
		return index + currentInx;
	}

	private static Item findItem(Item[] children, IUIObjectIdentifier widgetId) {
		for (int i = 0; i < children.length; i++) {
			IUIObjectIdentifier defaultAttributes = getDefaultItemAttributes(children[i]);
			if (UIObjectDeprecatedDeresolvingSupport.foundWidget(children[i],
					widgetId)
					|| defaultAttributes.getWidgetId().equals(
							widgetId.getWidgetId()))
				return children[i];

			/* We need to do a recursive search in the case of a tree */
			if (children instanceof TreeItem[]) {
				TreeItem treeItem = (TreeItem) children[i];
				int ccount = treeItem.getItemCount();
				if (ccount > 0) {
					/* Test the item's children */
					Item citem = findItem(treeItem.getItems(), widgetId);
					if (citem != null)
						return citem;
				}
			}
		}
		return null;
	}

	private static IUIObjectIdentifier getDefaultItemAttributes(Widget item) {
		Object data = item.getData();

		String idStr = MacroConstants.EMPTY_STRING;
		if (data != null)
			idStr = data.getClass().getName();

		/* Append index to id if it's a table or a tree item */
		if (item instanceof TreeItem) {
			TreeItem treeItem = (TreeItem) item;
			idStr = idStr
					+ findTreeItemInx(treeItem, MacroConstants.EMPTY_STRING);
		} else if (item instanceof TableItem) {
			TableItem tableItem = (TableItem) item;
			idStr = idStr + tableItem.getParent().indexOf(tableItem);
		}
		if (idStr.length() > 0)
			return new PrimitiveUIObjectIdentifier(idStr);

		return null;
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.commands.AbstractMacroCommand#load(org.w3c.dom.Node,
	 *      java.util.Hashtable)
	 */
	public void load(Node node, Hashtable lineTable) throws CoreException {
		super.load(node, lineTable);
		NodeList children = node.getChildNodes();
		for (int i = 0; i < children.getLength(); i++) {
			Node child = children.item(i);
			if (child.getNodeType() == Node.ELEMENT_NODE
					&& child.getNodeName().equals(MacroConstants.ITEM_ELEMENT)) {
				/* First check to see if a reference id is available */
				String attribute = MacroConstants.REFERENCE_ID_ATTRIBUTE;
				String attributeValue = MacroUtil
						.getAttribute(child, attribute);

				/*
				 * If a reference id is not available, then check the path
				 * attribute
				 */
				if (attributeValue == null) {
					attribute = MacroConstants.WIDGET_ID_ATTRIBUTE;
					attributeValue = MacroUtil.getAttribute(child, attribute);
				}

				if (attributeValue != null) {
					Hashtable itemData = new Hashtable();
					itemData.put(attribute, attributeValue);
					String resolverId = MacroUtil.getAttribute(child,
							MacroConstants.RESOLVER_ID_ATTRIBUTE);
					if (resolverId != null)
						itemData.put(MacroConstants.RESOLVER_ID_ATTRIBUTE,
								resolverId);
					items.add(itemData);
				}
			}
		}
	}

	/**
	 * Sub-classes can optionally overwrite this method to write additional
	 * attributes to command.
	 * 
	 * @param sb
	 *            The string buffer that the attributes should be written to.
	 */
	protected void writeAdditionalAttributes(StringBuffer sb) {
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.commands.AbstractMacroCommand#write(int,
	 *      java.lang.StringBuffer)
	 */
	public void write(int indent, StringBuffer sb) {
		super.write(indent, sb);
		writeAdditionalAttributes(sb);
		sb.append(MacroConstants.CLOSE_ANGLE_BRACKET);
		sb.append(GlobalConstants.LINE_SEPARATOR);

		int cindent = indent + 1;
		boolean isObjectMineOn = MacroManager.getInstance().isObjectMineOn();
		for (int i = 0; i < items.size(); i++) {
			Map itemData = (Map) items.get(i);
			if (itemData != null) {
				String referenceId = (String) itemData
						.get(MacroConstants.REFERENCE_ID_ATTRIBUTE);
				String itemId = itemData
						.get(MacroConstants.WIDGET_ID_ATTRIBUTE).toString();
				boolean useReferenceId = isObjectMineOn && referenceId != null;
				MacroUtil.addElement(sb, cindent, MacroConstants.ITEM_ELEMENT,
						false, false);
				MacroUtil.addAttribute(sb, new String[] {
						useReferenceId ? MacroConstants.REFERENCE_ID_ATTRIBUTE
								: MacroConstants.WIDGET_ID_ATTRIBUTE,
						MacroConstants.RESOLVER_ID_ATTRIBUTE }, new String[] {
						useReferenceId ? referenceId : itemId,
						useReferenceId ? null : (String) itemData
								.get(MacroConstants.RESOLVER_ID_ATTRIBUTE) },
						true, true);
			}
		}
		MacroUtil.addElement(sb, indent, MacroConstants.COMMAND_ELEMENT, true,
				true);
	}

	/**
	 * Used to play the structured command collectively for all the discovered
	 * matches.
	 * 
	 * @param widget
	 *            The widget
	 * @param matches
	 *            The matches discovered
	 */
	protected abstract void playStructuredCommand(Widget widget,
			Object[] matches);

	/**
	 * Some events require to be played as matches are discovered. (e.g. an
	 * expansion command requires to be played for each discovered item in order
	 * for successive children to be found) It's recommended that either
	 * playStructuredCommandForFoundMatch or playStructuredCommand be
	 * implemented by clients, eventhough both methods will be invoked.
	 * 
	 * @param widget
	 *            The widget
	 * @param matches
	 *            The match discovered
	 */
	protected abstract void playStructuredCommandForFoundMatch(Widget widget,
			Object match);

	public final boolean doPlayback(Display display, Shell parent,
			IProgressMonitor monitor) throws CoreException {
		if (macroObject == null)
			return false;

		// for (int i = 0; i < targets.length; i++) {
		setFocus(macroObject);

		/*
		 * https://bugs.eclipse.org/bugs/show_bug.cgi?id=147766: A process
		 * display event causes the target widget to sometimes be disposed.
		 * MacroUtil.processDisplayEvents(display);
		 */
		Widget widget = macroObject.getUIObject().getWidget();

		if (widget == null || widget.isDisposed())
			return false;// continue;

		Object[] matches = findMatches(widget);

		/* If we failed to locate the item, then continue */
		if (matches != null && items.size() != matches.length)
			return false;// continue;

		playStructuredCommand(widget, matches);
		return true;
		// }

		// return false;
	}

	protected Object[] findMatches(Widget widget) throws CoreException {
		if (widget instanceof Tree)
			return findMatches((Tree) widget);
		else if (widget instanceof Table)
			return findMatches((Table) widget);
		else if (widget instanceof List)
			return findMatches((List) widget);

		return null;
	}

	private String[] findMatches(List list) throws CoreException {
		String[] children = list.getItems();
		ArrayList matches = new ArrayList();
		for (int i = 0; i < items.size(); i++) {
			String itemId = findObjectId(i).toString();
			int itemInx = list.indexOf(itemId);
			if (itemInx >= 0 && itemInx < children.length) {
				playStructuredCommandForFoundMatch(list, children[itemInx]);
				matches.add(children[itemInx]);
			}
		}
		return (String[]) matches.toArray(new String[matches.size()]);
	}

	private TreeItem[] findMatches(Tree tree) throws CoreException {
		TreeItem[] children = tree.getItems();
		ArrayList matches = new ArrayList();
		for (int i = 0; i < items.size(); i++) {
			IUIObjectIdentifier currentWidgetId = findObjectId(i);
			Item item = findItem(children, currentWidgetId);
			if (item != null) {
				playStructuredCommandForFoundMatch(tree, item);
				matches.add(item);
			}
		}
		return (TreeItem[]) matches.toArray(new TreeItem[matches.size()]);
	}

	private TableItem[] findMatches(Table table) throws CoreException {
		TableItem[] elements = table.getItems();
		ArrayList matches = new ArrayList();

		for (int i = 0; i < items.size(); i++) {
			IUIObjectIdentifier currentWidgetId = findObjectId(i);
			Item item = findItem(elements, currentWidgetId);
			if (item != null) {
				playStructuredCommandForFoundMatch(table, item);
				matches.add(item);
			}
		}
		return (TableItem[]) matches.toArray(new TableItem[matches.size()]);
	}

	/**
	 * Returns the object id of the inx-th item associated with this structured
	 * command.
	 * 
	 * @param inx
	 *            The index of the item
	 * @return The object id
	 * 
	 * @throws CoreException
	 *             If an error occurrs while attempting to find the object
	 */
	protected IUIObjectIdentifier findObjectId(int inx) throws CoreException {
		Hashtable itemData = null;
		if (inx < 0 || inx >= items.size()
				|| (itemData = (Hashtable) items.get(inx)) == null)
			AutoGUIUtil.throwCoreException(
					AutoGUIMessages.AUTO_GUI_ERROR_MACRO_ITEM, getStartLine());

		Object itemObjectId = null;
		PrimitiveUIObjectIdentifier widgetId = null;
		if ((itemObjectId = itemData.get(MacroConstants.WIDGET_ID_ATTRIBUTE)) != null) {
			widgetId = new PrimitiveUIObjectIdentifier(itemObjectId.toString(),
					(String) itemData.get(MacroConstants.RESOLVER_ID_ATTRIBUTE));
			return widgetId;
		}

		String referenceId = (String) itemData
				.get(MacroConstants.REFERENCE_ID_ATTRIBUTE);
		if (referenceId == null)
			return new PrimitiveUIObjectIdentifier(MacroConstants.EMPTY_STRING);

		MacroObjectDescriptorMine objectMine = MacroManager.getInstance()
				.getObjectMine();
		if (objectMine == null)
			AutoGUIUtil.throwCoreException(
					AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE_T,
					getStartLine());

		MacroObjectDescriptor parentObject = getCorrespondingMacroObjectDescriptor();
		MacroObjectDescriptor itemObject = null;
		if (parentObject != null)
			itemObject = MacroManager.getInstance().getObjectMine()
					.lookupMacroObjectDescriptor(parentObject, referenceId);

		if (itemObject == null
				|| (itemObjectId = itemObject.getWidgetId()) == null)
			return new PrimitiveUIObjectIdentifier(MacroConstants.EMPTY_STRING);

		itemData.put(MacroConstants.WIDGET_ID_ATTRIBUTE, itemObjectId);
		widgetId = new PrimitiveUIObjectIdentifier(itemObjectId.toString(),
				itemObject.getResolverId());
		return widgetId;
	}

	/**
	 * Returns the items that this command must match
	 * 
	 * @return Matched items
	 */
	protected ArrayList getItems() {
		return items;
	}

	public boolean equals(Object obj) {
		boolean equalState = super.equals(obj);
		if (!equalState)
			return false;

		AbstractStructuredCommand compareWithObj = (AbstractStructuredCommand) obj;
		if (compareWithObj.getItems().size() != items.size())
			return false;

		/* For each item */
		for (int i = 0, objectCount = items.size(); i < objectCount; i++) {
			try {
				if (!compareWithObj.findObjectId(i).equals(findObjectId(i)))
					return false;
			} catch (CoreException e) {
				return false;
			}
		}

		return true;
	}

}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.util.Hashtable;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CCombo;
import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

public class ModifyCommand extends ObjectBasedCommand {

	public static final String TYPE = IMacroCommand.MODIFY;
	public static final String CDATA_OPEN = "<![CDATA[";
	public static final String CDATA_CLOSE = "]]>";

	private String text;

	public ModifyCommand(MacroCommandShell parent) {
		super(parent);
	}

	public String getType() {
		return TYPE;
	}

	public boolean mergeEvent(Event e) throws Exception {
		try {
			doProcessEvent(e);
			return true;
		} catch (Exception exception) {
			return false;
		}
	}

	public void load(Node node, Hashtable lineTable) throws CoreException {
		super.load(node, lineTable);

		NodeList children = node.getChildNodes();
		for (int i = 0; i < children.getLength(); i++) {
			Node child = children.item(i);
			if (child.getNodeType() == Node.TEXT_NODE) {
				text = child.getNodeValue().trim();
				break;
			}
		}

		/* If in case the text is null, then set it to an empty string */
		if (text == null)
			text = "";
		else
			text = convertHTMLCodeToChar(text);
	}

	protected void doProcessEvent(Event e) throws CoreException {
		findDescriptiveField(e.widget);
		String text = extractText(e.widget);
		if (text != null) {
			this.text = text;
		}
	}

	private String extractText(Widget widget) {
		String widgetText = null;
		if (widget instanceof Text)
			widgetText = ((Text) widget).getText();

		else if (widget instanceof Combo)
			widgetText = ((Combo) widget).getText();

		else if (widget instanceof CCombo)
			widgetText = ((CCombo) widget).getText();

		else if (widget instanceof StyledText)
			widgetText = ((StyledText) widget).getText();

		if (widgetText != null)
			return convertSpaces(widgetText);

		return null;
	}

	/**
	 * Convert leading and trailing spaces to their respective HTML code. This
	 * is so that the user inserted spaces are not lost after a trim operation.
	 */
	public String convertSpaces(String input) {
		String convertedString = "";
		char[] inputCharacters = input.toCharArray();

		/* Convert leading spaces */
		boolean validCharacterReached = false;
		String htmlCode;
		int i = 0;
		for (; i < inputCharacters.length && !validCharacterReached; i++) {
			htmlCode = convertCharacter(inputCharacters[i]);
			if (htmlCode == null)
				break;
			convertedString += htmlCode;
		}
		convertedString += input.substring(i).trim();

		/* Convert trailing spaces */
		String trailingSpaces = "";
		for (i = inputCharacters.length - 1; i >= 0; i--) {
			htmlCode = convertCharacter(inputCharacters[i]);
			if (htmlCode == null)
				break;
			trailingSpaces = htmlCode + trailingSpaces;
		}
		convertedString += trailingSpaces;
		return convertedString;
	}

	public String convertCharacter(char character) {
		switch (character) {
		case '\t':
			return "&#09;";
		case '\n':
			return "&#10;";
		case '\r':
			return "&#13;";
		case ' ':
			return "&#32;";
		default:
			return null;
		}
	}

	private String convertHTMLCodeToChar(String input) {
		String normalizedString = "";
		String inputCloned = input;
		int currentHTMLCodeInx;
		final int HTML_LENGTH_CODE = 5;

		while ((currentHTMLCodeInx = inputCloned.indexOf("&#")) != -1) {
			int totalHTMLCodeLen = currentHTMLCodeInx + HTML_LENGTH_CODE;
			if (totalHTMLCodeLen > inputCloned.length())
				break;

			String htmlCode = inputCloned.substring(currentHTMLCodeInx,
					totalHTMLCodeLen);
			String htmlChar = convertCodeToChar(htmlCode);
			normalizedString += inputCloned.substring(0, currentHTMLCodeInx)
					+ htmlChar;
			inputCloned = inputCloned.substring(totalHTMLCodeLen);
		}
		normalizedString += inputCloned;

		return normalizedString;
	}

	private String convertCodeToChar(String htmlCode) {
		if (htmlCode.equals("&#09;"))
			return "\t";
		else if (htmlCode.equals("&#10;"))
			return "\n";
		else if (htmlCode.equals("&#13;"))
			return "\r";
		else if (htmlCode.equals("&#32;"))
			return " ";
		else
			return htmlCode;
	}

	public void write(int indent, StringBuffer sb) {
		/* Ignore this command if it's corrupted */
		if (getMacroObjectIdentifier() == null || text == null
				|| text.length() <= 0)
			return;

		super.write(indent, sb, false, true);
		if (text != null) {
			MacroUtil.addIndent(sb, indent);
			sb.append(CDATA_OPEN);
			sb.append(text);
			sb.append(CDATA_CLOSE);
			sb.append(GlobalConstants.LINE_SEPARATOR);
		}
		MacroUtil.addElement(sb, indent, MacroConstants.COMMAND_ELEMENT, true,
				true);
	}

	public boolean doPlayback(Display display, Shell parent,
			IProgressMonitor monitor) throws CoreException {

		if (parent.isDisposed())
			return false;

		if (macroObject != null) {
			setFocus(macroObject);
			Widget widget = macroObject.getUIObject().getWidget();

			if (widget instanceof Text)
				((Text) widget).setText(text);
			else if (widget instanceof Combo)
				((Combo) widget).setText(text);
			else if (widget instanceof CCombo)
				((CCombo) widget).setText(text);
			else if (widget instanceof StyledText)
				((StyledText) widget).setText(text);

			/*
			 * Ali M.: Some classes explicitly listen for a selection before a
			 * modification is made
			 */
			Event event = new Event();
			event.display = display;
			event.widget = widget;
			event.type = SWT.Selection;
			widget.notifyListeners(SWT.Selection, event);
			MacroUtil.processDisplayEvents(display);

			/* Send out a modify command to notify modify listeners */
			event.type = SWT.Modify;
			widget.notifyListeners(SWT.Modify, event);
			MacroUtil.processDisplayEvents(display);

		}

		return true;
	}
			MacroUtil.processDisplayEvents(display);	
			
			/* Send out a modify command to notify modify listeners */
			event.type = SWT.Modify;			
			widget.notifyListeners(SWT.Modify, event);
			MacroUtil.processDisplayEvents(display);
			
		}		
		
		return true;
	}
}

Lines 13-27 Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/commands/AbstractMacroCommand.java (-142 / +153 lines)
13	import java.util.Hashtable;	13	import java.util.Hashtable;
14		14
15	import org.eclipse.core.runtime.CoreException;	15	import org.eclipse.core.runtime.CoreException;
16	import org.eclipse.core.runtime.Path;
17	import org.eclipse.hyades.test.common.util.XMLUtil;	16	import org.eclipse.hyades.test.common.util.XMLUtil;
		17	import org.eclipse.jface.window.Window;
		18	import org.eclipse.swt.widgets.Control;
		19	import org.eclipse.swt.widgets.Display;
18	import org.eclipse.swt.widgets.Event;	20	import org.eclipse.swt.widgets.Event;
19	import org.eclipse.swt.widgets.Widget;	21	import org.eclipse.swt.widgets.Widget;
20	import org.eclipse.tptp.test.auto.gui.internal.core.WidgetIdentifier;
21	import org.eclipse.tptp.test.auto.gui.internal.macro.AbstractMacroInstruction;	22	import org.eclipse.tptp.test.auto.gui.internal.macro.AbstractMacroInstruction;
		23	import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
22	import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;	24	import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
23	import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
24	import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;	25	import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
		26	import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObject;
		27	import org.eclipse.ui.IEditorPart;
		28	import org.eclipse.ui.IViewPart;
		29	import org.eclipse.ui.IWorkbenchPage;
25	import org.w3c.dom.Node;	30	import org.w3c.dom.Node;
26		31
27	/**	32	/**
Lines 31-36 Link Here
31	*	36	*
32	* @author Ali Mehregani	37	* @author Ali Mehregani
33	* @author Paul Slauenwhite	38	* @author Paul Slauenwhite
		39	* @author Alexander Nyssen
34	* @version May 22, 2009	40	* @version May 22, 2009
35	* @since July 10, 2006	41	* @since July 10, 2006
36	*/	42	*/
Lines 46-150 Link Here
46	private String descriptiveField;	52	private String descriptiveField;
47		53
48	/** Time difference between this command and the previous command (applicable when artificial wait time is enabled) */	54	/** Time difference between this command and the previous command (applicable when artificial wait time is enabled) */
49	private long timeDifference;	55	private long timeDifference;
50		56
51
52	/**	57	/**
53	* Constructor	58	* Constructor
54	*	59	*
55	* @param parent The parent command shell	60	* @param parent
56	* @param widgetId The associated widget id	61	* The parent command shell
		62	* @param widgetId
		63	* The associated widget id
57	*/	64	*/
58	public AbstractMacroCommand(MacroCommandShell parent, WidgetIdentifier widgetId)	65	public AbstractMacroCommand(MacroCommandShell parent) {
59	{
60	setWidgetId(widgetId);
61	this.parent = parent;	66	this.parent = parent;
62	}	67	}
63		68
64		69	public boolean mergeEvent(Event e) throws Exception {
65	public void load(Node node, Hashtable lineTable) throws CoreException
66	{
67	super.load(node, lineTable);
68	String cid = MacroUtil.getAttribute(node, MacroConstants.CONTEXT_ID_ATTRIBUTE);
69	String wid = MacroUtil.getAttribute(node, MacroConstants.WIDGET_ID_ATTRIBUTE);
70	String rid = MacroUtil.getAttribute(node, MacroConstants.RESOLVER_ATTRIBUTE);
71
72	if (cid != null && wid != null)
73	{
74	setWidgetId(new WidgetIdentifier(
75	cid == null ? new Path(MacroConstants.EMPTY_STRING) : new Path(cid),
76	wid == null ? new Path(MacroConstants.EMPTY_STRING) : new Path(wid),
77	rid));
78	}
79	}
80
81
82	public boolean mergeEvent(Event e)
83	{
84	return false;	70	return false;
85	}	71	}
		72
86		73
87		74
88	/**	75	/**
89	* Returns the descriptive field of this command.	76	* Returns the descriptive field of this command.
90	*	77	*
91	* @return The descriptive field of this command.	78	* @return The descriptive field of this command.
92	*/	79	*/
93	public String getDescriptiveField()	80	public String getDescriptiveField() {
94	{
95	return descriptiveField;	81	return descriptiveField;
96	}	82	}
97		83
98
99	/**	84	/**
100	* Set the descriptive field of this command. The descriptive field is used	85	* Set the descriptive field of this command. The descriptive field is used to more easily identify the semantics of a command.
101	* to more easily identify the semantics of a command.	86	*
102	*	87	* @param descriptiveField
103	* @param descriptiveField The descriptive field (can be a button's text, a tree	88	* The descriptive field (can be a button's text, a tree item label, or etc...)
104	* item label, or etc...)
105	*/	89	*/
106	public void setDescriptiveField(String descriptiveField)	90	public void setDescriptiveField(String descriptiveField) {
107	{	91	this.descriptiveField = XMLUtil.useXMLSymbols(MacroUtil.normalizeDescriptiveField(MacroUtil.boundSize(descriptiveField,
108	this.descriptiveField = XMLUtil.useXMLSymbols(MacroUtil.normalizeDescriptiveField(MacroUtil.boundSize(descriptiveField, DESCRIPTIVE_FIELD_BOUND)));	92	DESCRIPTIVE_FIELD_BOUND)));
109	}	93	}
110		94
111
112	/**	95	/**
113	* Initializes the descriptive field of this command based on the	96	* Initializes the descriptive field of this command based on the value returned by the getText() method of the widget (if it has one)
114	* value returned by the getText() method of the widget (if it has one)
115	*	97	*
116	* @param widget The widget	98	* @param widget
		99	* The widget
117	*/	100	*/
118	protected void findDescriptiveField(Widget widget)	101	protected void findDescriptiveField(Widget widget) {
119	{	102	setDescriptiveField(getText(widget));
120	setDescriptiveField(getText(widget));
121	}	103	}
122		104
123
124	/**	105	/**
125	* Similar to initializeDescriptiveField(Widget), but the descriptive field	106	* Similar to initializeDescriptiveField(Widget), but the descriptive field is a comma-separated string of all the descriptive fields that
126	* is a comma-separated string of all the descriptive fields that corresponds	107	* corresponds to the objects passed in.
127	* to the objects passed in.
128	*	108	*
129	* @param objects The objects	109	* @param objects
		110	* The objects
130	*/	111	*/
131	protected void findDescriptiveField(Object[] objects)	112	protected void findDescriptiveField(Object[] objects) {
132	{
133	String descriptive = "";	113	String descriptive = "";
134	for (int i = 0; i < objects.length; i++)	114	for (int i = 0; i < objects.length; i++) {
135	{
136	if (descriptive.length() > 0)	115	if (descriptive.length() > 0)
137	descriptive += ", ";	116	descriptive += ", ";
138	String textValue = getText(objects[i]);	117	String textValue = getText(objects[i]);
139	if (textValue != null && textValue.length() > 0)	118	if (textValue != null && textValue.length() > 0)
140	descriptive += textValue;	119	descriptive += textValue;
141	}	120	}
142		121
143	if (descriptive.length() > 0)	122	if (descriptive.length() > 0)
144	setDescriptiveField(descriptive);	123	setDescriptiveField(descriptive);
145	}	124	}
146		125
147
148	protected String getText(Object obj)	126	protected String getText(Object obj)
149	{	127	{
150	if (obj == null)	128	if (obj == null)
Lines 168-188 Link Here
168	return null;	146	return null;
169	}	147	}
170		148
171		149	public String toString() {
172	public String toString()
173	{
174	return "MacroCommand [" + getType() + ", line " + getStartLine() + "]";	150	return "MacroCommand [" + getType() + ", line " + getStartLine() + "]";
175	}	151	}
176		152
177	public boolean equals (Object obj)	153	public boolean equals(Object obj) {
178	{
179	if (!(obj instanceof IMacroCommand))	154	if (!(obj instanceof IMacroCommand))
180	return false;	155	return false;
181		156
182	IMacroCommand compareWithObj = (IMacroCommand)obj;	157	IMacroCommand compareWithObj = (IMacroCommand) obj;
183	if (compareWithObj.getType() == this.getType() && compareWithObj.getWidgetId() != null && compareWithObj.getWidgetId().equals(getWidgetId()))	158	if (compareWithObj.getType() == this.getType())
184	return true;	159	return true;
185		160
186	return false;	161	return false;
187	}	162	}
188		163
Lines 193-297 Link Here
193	public void setParent(MacroCommandShell parent) {	168	public void setParent(MacroCommandShell parent) {
194	this.parent = parent;	169	this.parent = parent;
195	}	170	}
196		171
197	/**	172	/**
198	* Should return false if executing this command just after it	173	* Should return false if executing this command just after it has already been executed will have a different output. (e.g. If two focus commands
199	* has already been executed will have a different output.	174	* that are identical are redundant but two button selections are not)
200	* (e.g. If two focus commands that are identical are redundant but	175	*/
201	* two button selections are not)	176	public boolean isRepeatRedundant() {
202	*/
203	public boolean isRepeatRedundant()
204	{
205	return true;	177	return true;
206	}	178	}
207		179
208	/**	180	/**
209	* This is our chance to write any artificial wait commands if the	181	* This is our chance to write any artificial wait commands if the option is enabled.
210	* option is enabled.
211	*	182	*
212	* @param indent The current indent that the command should be at	183	* @param indent
213	* @param writer The writer used to write the macro	184	* The current indent that the command should be at
		185	* @param writer
		186	* The writer used to write the macro
214	*/	187	*/
215	public void writeStart(int indent, StringBuffer writer)	188	public void writeStart(int indent, StringBuffer writer) {
216	{
217	if (timeDifference <= 0)	189	if (timeDifference <= 0)
218	return;	190	return;
219		191
220	WaitCommand waitCommand = new WaitCommand(parent);	192	WaitCommand waitCommand = new WaitCommand(parent);
221	waitCommand.setWaitTime(timeDifference);	193	waitCommand.setWaitTime(timeDifference);
222	waitCommand.write(indent, writer);	194	waitCommand.write(indent,
		195	writer);
223	}	196	}
224
225		197
226	/**	198	/**
		199	* {@inheritDoc}
		200	* @see org.eclipse.tptp.test.auto.gui.internal.macro.AbstractMacroInstruction#load(org.w3c.dom.Node, java.util.Hashtable)
		201	*/
		202	public void load(Node node, Hashtable lineTable) throws CoreException {
		203	super.load(node,
		204	lineTable);
		205	// load the descriptive field
		206	descriptiveField = MacroUtil.getAttribute(node, MacroConstants.DESCRIPTIVE_ATTRIBUTE);
		207
		208	}
		209
		210	/**
227	* Equivalent to write(indent, writer, false, false)	211	* Equivalent to write(indent, writer, false, false)
228	*/	212	*/
229	public void write(int indent, StringBuffer sb)	213	public void write(int indent, StringBuffer sb) {
230	{	214	write(indent,
231	write(indent, sb, false, false);	215	sb,
		216	false,
		217	false);
232	}	218	}
233		219
234
235	/**	220	/**
236	* Writes the common fiels of this command	221	* Writes the common fiels of this command
237	*	222	*
238	* @param indent The current indent that the command should be at	223	* @param indent
239	* @param writer The writer used to write the macro	224	* The current indent that the command should be at
240	* @param close A flag that indicates whether the command fragment should be closed (i.e.adding "/" to the end).	225	* @param writer
241	* @param end A flag that indicates whether the command fragment should end (i.e.adding "/" to the end).	226	* The writer used to write the macro
		227	* @param close
		228	* A flag that indicates whether the command fragment should be closed (i.e.adding "/" to the end).
		229	* @param end
		230	* A flag that indicates whether the command fragment should end (i.e.adding "/" to the end).
242	*/	231	*/
243	public void write(int indent, StringBuffer sb, boolean close, boolean end)	232	public void write(int indent, StringBuffer sb, boolean close, boolean end) {
244	{	233	MacroUtil.addElement(sb,
245	MacroUtil.addElement(sb, indent, MacroConstants.COMMAND_ELEMENT, false, false);	234	indent,
246	boolean noWidgetId = getWidgetId() == null;	235	MacroConstants.COMMAND_ELEMENT,
247	boolean objectMineInUse = MacroManager.getInstance().isObjectMineOn() && getWidgetId().getReferenceId() != null;	236	false,
248	MacroUtil.addAttribute(sb,	237	false);
249	new String[] {	238	MacroUtil.addAttribute(sb,
250	MacroConstants.DESCRIPTIVE_ATTRIBUTE,
251	MacroConstants.TYPE_ATTRIBUTE,
252	MacroConstants.RESOLVER_ATTRIBUTE,
253	MacroConstants.CONTEXT_ID_ATTRIBUTE,
254	MacroConstants.WIDGET_ID_ATTRIBUTE,
255	MacroConstants.REFERENCE_ID_ATTRIBUTE},
256	new String[] {	239	new String[] {
257	getDescriptiveField(),	240	MacroConstants.DESCRIPTIVE_ATTRIBUTE,
258	getType(),	241	MacroConstants.TYPE_ATTRIBUTE},
259	objectMineInUse \|\| noWidgetId ? null : getWidgetId().getResolverId(),	242	new String[] {getDescriptiveField(), getType()},
260	objectMineInUse \|\| noWidgetId ? null : getWidgetId().getContextId().toString(),	243	close,
261	objectMineInUse \|\| noWidgetId ? null : getWidgetId().getObjectId().toString(),	244	end);
262	objectMineInUse && !noWidgetId ? getWidgetId().getReferenceId() : null
263	}, close, end);
264
265	}	245	}
266		246
267		247	public void writeFinish(int indent, StringBuffer writer) {
268	public void writeFinish(int indent, StringBuffer writer)	248
269	{
270
271	}	249	}
272		250
273	public long getTimeDifference()	251	public long getTimeDifference() {
274	{
275	return timeDifference;	252	return timeDifference;
276	}	253	}
277		254
278	public void setTimeDifference(long timeDifference)	255	public void setTimeDifference(long timeDifference) {
279	{
280	this.timeDifference = timeDifference;	256	this.timeDifference = timeDifference;
281	}	257	}
282		258
283
284
285	/**	259	/**
286	* Returns the class name of the object passed in (excluding the package name)	260	* Added by ANy
287	* This is useful for adding a descriptive field to the command	261	*
		262	* @param macroObject
		263	*/
		264	protected void setFocus(IMacroObject macroObject) {
		265	ensureVisible(macroObject);
		266	Widget widget = macroObject.getUIObject().getWidget();
		267	Display display = widget.getDisplay();
		268	if (widget instanceof Control) {
		269	Control c = (Control) widget;
		270	if (!c.equals(display.getFocusControl()))
		271	c.setFocus();
		272	}
		273	}
		274
		275	/*
		276	* Added by ANy
		277	*/
		278	private void ensureVisible(IMacroObject macroObject) {
		279	if (macroObject.getContext() instanceof Window) {
		280	Window window = (Window) macroObject.getContext();
		281	window.getShell().setActive();
		282	}
		283	else if (macroObject.getContext() instanceof IEditorPart) {
		284	IEditorPart editor = (IEditorPart) macroObject.getContext();
		285	IWorkbenchPage page = editor.getEditorSite().getPage();
		286	page.activate(editor);
		287	}
		288	else if (macroObject.getContext() instanceof IViewPart) {
		289	IViewPart view = (IViewPart) macroObject.getContext();
		290	IWorkbenchPage page = view.getViewSite().getPage();
		291	page.activate(view);
		292	}
		293	}
		294
		295	/**
		296	* Returns the class name of the object passed in (excluding the package name) This is useful for adding a descriptive field to the command
288	*	297	*
289	* @param object The object	298	* @param object
		299	* The object
290	* @return The object class name	300	* @return The object class name
291	*/	301	*/
292	protected String getObjectClassName (Object object)	302	public String getObjectClassName(Object object) {
293	{	303	String className = object == null
294	String className = object == null ? "" : object.getClass().getName();	304	? ""
		305	: object.getClass().getName();
295	int lastDotInx = className.lastIndexOf('.');	306	int lastDotInx = className.lastIndexOf('.');
296	if (lastDotInx != -1 && lastDotInx + 1 < className.length())	307	if (lastDotInx != -1 && lastDotInx + 1 < className.length())
297	return className.substring(lastDotInx + 1);	308	return className.substring(lastDotInx + 1);




/*******************************************************************************
 * Copyright (c) 2000, 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.util.Hashtable;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CCombo;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.CTabItem;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Item;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.TabFolder;
import org.eclipse.swt.widgets.TabItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObject;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObject;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.resolver.MacroObjectResolver;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.PrimitiveUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.UIObject;
import org.w3c.dom.Node;

/**
 * A choice selection command represents a user selection of an item from a set
 * of items present. For example, selecting a specific tab from a tab group or
 * an item from a combo box.
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen (complete refactoring to use new widget resolving
 *         mechanism)
 */
public class ChoiceSelectionCommand extends SingleSelectionCommand {

	public static final String TYPE = IMacroCommand.CHOICE_SELECT;

	// ANy: this field is only needed for backwards compatibility issues
	private String choiceId = null;

	// /** Widget types */
	// private static final byte WIDGET_TYPE_TAB_FOLDER = 0x00;
	// private static final byte WIDGET_TYPE_CTAB_FOLDER = 0x01;
	// private static final byte WIDGET_TYPE_COMBO = 0x02;
	// private static final byte WIDGET_TYPE_CCOMBO = 0x03;

	public ChoiceSelectionCommand(MacroCommandShell parent) {
		super(parent);
	}

	public String getType() {
		return TYPE;
	}

	protected IMacroObject locateMacroObject(Event event) {
		// find the selected item
		boolean isCombo = event.widget instanceof Combo;
		boolean isCCombo = event.widget instanceof CCombo;

		Combo combo = isCombo ? (Combo) event.widget : null;
		CCombo ccombo = isCCombo ? (CCombo) event.widget : null;
		Object item = isCombo ? combo.getItem(combo.getSelectionIndex())
				: (isCCombo ? (Object) ccombo.getItem(ccombo
						.getSelectionIndex()) : event.item);

		// if the item is itself a widget it can be resolved without its parent
		// widget, e.g. in case of a TabItem or CTabItem
		if (item != null && item instanceof Widget) {
			return new MacroObject(new UIObject((Widget) item));
		} else {
			return new MacroObject(new UIObject(event.widget, item));
		}
	}

	// @Override
	// protected void writeMacroObject(int indent, StringBuffer sb, boolean
	// close,
	// boolean end) {
	//		
	// // remove the trailing path fragment and store it separately (for
	// // backwards compatibility)
	// MacroObjectIdentifier identifier = (MacroObjectIdentifier)
	// getMacroObjectIdentifier();
	// String originalContextId = identifier.getContextIdentifier();
	// String originalObjectId = identifier.getObjectIdentifier()
	// .getObjectId();
	// String resolverId = identifier.getObjectIdentifier().getResolverId();
	// String choiceId = new Path(originalObjectId).removeFirstSegments(1)
	// .toString();
	//		
	// setMacroObjectIdentifier(new MacroObjectIdentifier(originalContextId,
	// new PrimitiveUIObjectIdentifier(new Path(originalObjectId).segment(0)
	// .toString(), resolverId)));
	//		
	// super.writeMacroObject(indent, sb, false, false);
	//		
	// setMacroObjectIdentifier(identifier);
	//
	// MacroUtil.addAttribute(sb,
	// new String[] { MacroConstants.CHOICE_ID_ATTRIBUTE },
	// new String[] { choiceId == null || choiceId.equals("") ? null
	// : choiceId.toString() }, close, end);
	// }

	protected void loadMacroObjectIdentifier(Node node, Hashtable lineTable)
			throws CoreException {
		super.loadMacroObjectIdentifier(node, lineTable);

		// for backwards compatibility, the choice id is read (if present) and
		// appended to the macro object identifier
		MacroObjectIdentifier identifier = (MacroObjectIdentifier) getMacroObjectIdentifier();

		// ANy: added for backwards compatibility, in case we have a macro that
		// still has the choice id attribute stored
		choiceId = MacroUtil.getAttribute(node,
				MacroConstants.CHOICE_ID_ATTRIBUTE);
	}

	public void doProcessEvent(Event e) {
		if (e.widget instanceof Combo || e.widget instanceof CCombo) {
			setDescriptiveField(e.widget instanceof Combo ? ((Combo) e.widget)
					.getItem(((Combo) e.widget).getSelectionIndex())
					: ((CCombo) e.widget).getItem(((CCombo) e.widget)
							.getSelectionIndex()));
		} else {
			findDescriptiveField(e.item);
		}
	}

	// public void load(Node node, Hashtable lineTable) throws CoreException {
	// super.load(node, lineTable);
	// String choiceId = MacroUtil.getAttribute(node,
	// MacroConstants.CHOICE_ID_ATTRIBUTE);
	// }
	//

	// public void write(int indent, StringBuffer sb) {
	// super.write(indent, sb);
	// MacroUtil.addAttribute(sb,
	// new String[] { MacroConstants.CHOICE_ID_ATTRIBUTE },
	// new String[] { choiceId == null ? null : choiceId.toString() },
	// true, true);
	// }

	public boolean playback(Display display, Shell parent,
			IProgressMonitor monitor) throws CoreException {
		IMacroObjectIdentifier identifier = getMacroObjectIdentifier();
		// backwards compatibility issues
		if (choiceId != null && !choiceId.equals("")) {
			// we need to deresolve here to decide wether we have an identifier
			// for a Combo (CCombo) or a TabFolder (CTabFolder)
			IMacroObject macroObject = MacroObjectResolver.deresolve(
					getParent().getShell(), identifier);
			if (macroObject.getUIObject().getWidget() instanceof Combo
					|| macroObject.getUIObject().getWidget() instanceof CCombo) {
				// set the enhanced identifier that used the object id to denote
				// the String item on the Combo or CCombo
				setMacroObjectIdentifier(new MacroObjectIdentifier(identifier
						.getContextIdentifier(),
						new PrimitiveUIObjectIdentifier(identifier
								.getObjectIdentifier().getWidgetId(), choiceId,
								identifier.getObjectIdentifier()
										.getResolverId())));
			} else if (macroObject.getUIObject().getWidget() instanceof TabFolder
					|| macroObject.getUIObject().getWidget() instanceof CTabFolder) {
				// compute a new macro object identifier, the old one points to
				// the tabFolder
				String contextId = new Path(MacroConstants.TAB_VALUE).append(
						MacroObjectIdentifier
								.serializeMacroObjectIdentifier(identifier))
						.toString();
				String widgetId = choiceId;
				setMacroObjectIdentifier(new MacroObjectIdentifier(contextId,
						new PrimitiveUIObjectIdentifier(widgetId, identifier
								.getObjectIdentifier().getResolverId())));
			}
		}
		return super.playback(display, parent, monitor);
	}

	public boolean doPlayback(Display display, Shell parent,
			IProgressMonitor monitor) throws CoreException {

		// deresolve the macro object (using the old path format (the choice id
		// was kept separately before) -> locating a child with the given item
		// suffix does not work yet)
		// Path path = new Path(getMacroObjectIdentifier().getObjectIdentifier()
		// .getObjectId());
		// String oldObjectId = path.segmentCount() > 1 ?
		// path.removeLastSegments(
		// 1).toString() : path.toString();

		// IMacroObject target = MacroObjectResolver.deresolve(parent,
		// getMacroObjectIdentifier());
		// // new MacroObjectIdentifier(getMacroObjectIdentifier()
		// .getContextIdentifier(),
		// new PrimitiveUIObjectIdentifier(oldObjectId,
		// getMacroObjectIdentifier()
		// .getObjectIdentifier()
		// .getResolverId())));

		if (macroObject == null) {
			return false;
		}

		setFocus(macroObject);
		doSelect(macroObject);

		return true;
	}

	protected void doSelect(IMacroObject target) {
		Widget widget = target.getUIObject().getWidget();
		Object object = target.getUIObject().getObject();

		Widget parent = null;
		Item item = null;

		if (widget instanceof Combo) {
			Combo combo = (Combo) widget;
			combo.select(combo.indexOf((String) object));
			parent = combo;
		} else if (widget instanceof CCombo) {
			CCombo combo = (CCombo) widget;
			combo.select(combo.indexOf((String) object));
			parent = combo;
		}
		// TabItems and CTabItems are widgets themselves, so when selecting,
		// they have to be passed into the event as item
		else if (widget instanceof TabItem) {
			TabItem tabItem = (TabItem) widget;
			TabFolder tabFolder = tabItem.getParent();
			tabFolder.setSelection(tabItem);
			parent = tabFolder;
			item = tabItem;
		} else if (widget instanceof CTabItem) {
			CTabItem tabItem = (CTabItem) widget;
			CTabFolder tabFolder = tabItem.getParent();
			tabFolder.setSelection(tabItem);
			parent = tabFolder;
			item = tabItem;
		}

		/*
		 * Ali M.: A set selection is not enough for Eclipse forms. We have to
		 * send out a selection event
		 */
		Event selectionEvent = new Event();
		selectionEvent.type = SWT.Selection;
		selectionEvent.widget = parent;
		selectionEvent.display = parent.getDisplay();
		selectionEvent.item = item;
		widget.notifyListeners(SWT.Selection, selectionEvent);
		MacroUtil.processDisplayEvents(selectionEvent.display);
	}

	// private void doSelect(byte widgetType, Widget widget) {
	// Object[] items = null;
	// switch (widgetType) {
	// case WIDGET_TYPE_TAB_FOLDER:
	// items = ((TabFolder) widget).getItems();
	// break;
	// case WIDGET_TYPE_CTAB_FOLDER:
	// items = ((CTabFolder) widget).getItems();
	// break;
	// case WIDGET_TYPE_COMBO:
	// items = ((Combo) widget).getItems();
	// break;
	// case WIDGET_TYPE_CCOMBO:
	// items = ((CCombo) widget).getItems();
	// break;
	// }
	//
	// // tries to determine the item by querying all resolves
	// IUIObjectIdentifier widgetId = null;
	// boolean foundItem = false;
	// for (int i = 0; !foundItem && i < items.length; i++) {
	// while (!foundItem
	// && ((widgetId = MacroObjectResolver.resolve(new MacroObject(new
	// UIObject(widget, items[i]))).getObjectIdentifier()) != null)) {
	// foundItem = itemId != null
	// && itemId.equals(getMacroObjectIdentifier()
	// .getObjectIdentifier())
	//					
	// }
	//
	// if (foundItem)
	// break;
	// // foundItem = foundItem(widgetType, widget, items[i],
	// // computeDefaultChoiceId(widget, items[i]), i);
	// }
	// }

	public boolean mergeEvent(Event e) throws Exception {
		return false;
	}

	public void write(int indent, StringBuffer sb, boolean close, boolean end) {
		super.write(indent, sb, true, true);
	}

	/**
	 * Overwrite this method in order to indicate that two choice commands that
	 * have different choice ids are not the same
	 */
	public boolean equals(Object obj) {
		if (!(obj instanceof ChoiceSelectionCommand) || !super.equals(obj))
			return false;

		return true;
		// ChoiceSelectionCommand compareWithObj = (ChoiceSelectionCommand) obj;
		// if ((this.choiceId != null && this.choiceId
		// .equals(compareWithObj.choiceId))
		// || (this.choiceId == null && compareWithObj.choiceId == null))
		// return true;
		//
		// return false;
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import org.eclipse.swt.widgets.Widget;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IWorkbenchPage;

public class EditorCommandTarget extends CommandTarget {
	/**
	 * @param widget
	 * @param context
	 */
	public EditorCommandTarget(Widget widget, IEditorPart editor) {
		super(widget, editor);
	}
	
	public IEditorPart getEditor() {
		return (IEditorPart)getContext();
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.macro.CommandTarget#ensureVisible()
	 */
	public void ensureVisible() {
		IEditorPart editor = getEditor();
		IWorkbenchPage page = editor.getEditorSite().getPage();
		page.activate(editor);
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.util.ArrayList;
import java.util.Hashtable;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.w3c.dom.Node;

public abstract class ToggleStructuredCommand extends AbstractStructuredCommand {

	protected boolean itemState;

	/**
	 * @param wid
	 */
	public ToggleStructuredCommand(MacroCommandShell parent) {
		super(parent);
	}

	/**
	 * There are more incomming events, merge them appropriately
	 * 
	 * @param e
	 *            The event to be merged with this command
	 */
	public boolean mergeEvent(Event e) throws Exception {
		ArrayList itemMatches = super.getItems();

		if (e.item != null && itemState == getItemState(e.item)) {
			itemMatches.add(super.getItemAttributes(e.item));
			return true;
		}

		return false;
	}

	public void load(Node node, Hashtable lineTable) throws CoreException {
		super.load(node,
			lineTable);
		String att = MacroUtil.getAttribute(node,
			MacroConstants.VALUE_ATTRIBUTE);
		this.itemState = att != null && att.equals(MacroConstants.TRUE_VALUE);
	}

	protected void writeAdditionalAttributes(StringBuffer sb) {
		MacroUtil.addAttribute(sb,
			new String[] {MacroConstants.VALUE_ATTRIBUTE},
			new String[] {itemState
				? MacroConstants.TRUE_VALUE
				: MacroConstants.FALSE_VALUE},
			false,
			false);
	}

	public boolean getValue() {
		return itemState;
	}

	/**
	 * Overwirte this method to indicate that if there are two toggle commands with different values, then they are not the same.
	 * 
	 * @param obj
	 *            The object that this object will be comapred against
	 */
	public boolean equals(Object obj) {
		if (!(obj instanceof ToggleStructuredCommand) || !super.equals(obj))
			return false;

		ToggleStructuredCommand compareWithObj = (ToggleStructuredCommand) obj;
		if (compareWithObj.getValue() == this.getValue())
			return true;

		return false;
	}

	/**
	 * Returns the state of the item (e.g. whether it is check/unchecked, expanded/ collapsed, and etc...)
	 * 
	 * @param item
	 *            The item for which its state is being queried
	 * @return The state of the item
	 */
	public abstract boolean getItemState(Widget item);
}




/*******************************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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
 * $Id: MouseEventCommand.java,v 1.2 2006/10/27 14:39:12 amehregani Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.util.Hashtable;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.ui.PlatformUI;
import org.w3c.dom.Node;

/**
 * A concrete extension of PositionBasedCommand used to represent SWT.MouseUp
 * and SWT.MouseDown and SWT.MouseMove events.
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen (refactored and added mouse move event support)
 */
public class MouseEventCommand extends PositionBasedCommand {

	private Point coordinates; /* Keep track of the coordinates */

	private static Point lastCoordinates;

	public MouseEventCommand(MacroCommandShell parent) {
		super(parent);
	}

	public void processEvent(Event event) throws Exception {
		super.processEvent(event);
		coordinates = PlatformUI.getWorkbench().getDisplay()
				.getCursorLocation();
	}

	protected String determineType(Event e) {
		String type = null;
		if (e.type == SWT.MouseUp) {
			type = MOUSE_UP;
		} else if (e.type == SWT.MouseDown) {
			type = MOUSE_DOWN;
		} else if (e.type == SWT.MouseMove) {
			type = MOUSE_MOVE;
		}
		return type;
	}

	protected Integer determineDetail(Event e) {
		if (e.button > 0) {
			return new Integer(e.button);
		} else {
			return null;
		}
	}

	public boolean mergeEvent(Event e) throws Exception {
		/*
		 * Defect #: 110726 -- If the previous event was a mouse down event at
		 * the same exact location, then replace the two of them with the mouse
		 * click event (ANy: As merging of position based commands is now
		 * supported, this defect can be handled here more elegantly)
		 */
		if (e.type == SWT.MouseUp
				&& type != null
				&& type.equals(MOUSE_DOWN)
				&& coordinates != null
				&& coordinates.equals(PlatformUI.getWorkbench().getDisplay()
						.getCursorLocation())
				&& (detail == null || detail.intValue() == e.button)) {
			type = MOUSE_CLICK;
			return true;
		}
		// if the last command was a mouse move command, and this one as well,
		// the
		// last may be ignored.
		else if (e.type == SWT.MouseMove && type != null
				&& type.equals(MOUSE_MOVE)) {
			coordinates = PlatformUI.getWorkbench().getDisplay()
					.getCursorLocation();
			return true;
		} else {
			return super.mergeEvent(e);
		}
	}

	public Event[] constructSWTEvents() {
		Event[] mouseEvents;
		if (type.equals(MOUSE_CLICK))
			mouseEvents = new Event[2];
		else
			mouseEvents = new Event[1];

		if (type.equals(MOUSE_UP)) {
			mouseEvents[0] = new Event();
			mouseEvents[0].type = SWT.MouseUp;
			mouseEvents[0].button = detail.intValue();
		} else if (type.equals(MOUSE_DOWN)) {
			mouseEvents[0] = new Event();
			mouseEvents[0].type = SWT.MouseDown;
			mouseEvents[0].button = detail.intValue();
		} else if (type.equals(MOUSE_CLICK)) {
			mouseEvents[0] = new Event();
			mouseEvents[0].type = SWT.MouseDown;
			mouseEvents[0].button = detail.intValue();
			mouseEvents[1] = new Event();
			mouseEvents[1].type = SWT.MouseUp;
			mouseEvents[1].button = detail.intValue();
		} else if (type.equals(MOUSE_MOVE)) {
			mouseEvents[0] = new Event();
			mouseEvents[0].type = SWT.MouseMove;
			mouseEvents[0].x = coordinates.x;
			mouseEvents[0].y = coordinates.y;
		}

		return mouseEvents;
	}

	public void load(Node node, Hashtable lineTable) throws CoreException {
		super.load(node, lineTable);

		// load coordinates
		int x = Integer.parseInt(MacroUtil.getAttribute(node, "x-coord"));
		int y = Integer.parseInt(MacroUtil.getAttribute(node, "y-coord"));
		coordinates = new Point(x, y);
	}

	public void write(int indent, StringBuffer sb, boolean close, boolean end) {
		super.write(indent, sb, false, false);
		MacroUtil.addAttribute(sb, new String[] {
				MacroConstants.X_COORD_ATTRIBUTE,
				MacroConstants.Y_COORD_ATTRIBUTE, },
				new String[] { String.valueOf(coordinates.x),
						String.valueOf(coordinates.y), }, true, true);
	}

	/**
	 * Plays back this command
	 */
	public boolean playback(final Display display, Shell parent,
			IProgressMonitor monitor) throws CoreException {
		/*
		 * It's important not to move the cursor if the last command had the
		 * same cursor position as this one
		 */
		if (lastCoordinates == null || !lastCoordinates.equals(coordinates)) {
			display.setCursorLocation(coordinates.x, coordinates.y);
		}
		lastCoordinates = coordinates;
		return super.playback(display, parent, monitor);
	}

	public boolean equals(Object obj) {
		if (!(obj instanceof MouseEventCommand))
			return false;

		MouseEventCommand mouseEvent = (MouseEventCommand) obj;
		if (this.type.equals(mouseEvent.getType())
				&& this.detail == mouseEvent.getDetail()
				&& this.coordinates.equals(mouseEvent.getCoordinates()))
			return true;
		return false;
	}

	public Point getCoordinates() {
		return coordinates;
	}

	// TODO: This is ugly, it has to be removed
	public static void init() {
		lastCoordinates = null;
	}
}
		lastCoordinates = null;
	}
}




/*******************************************************************************
 * Copyright (c) 2006, 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import org.eclipse.swt.widgets.Event;
import org.eclipse.tptp.test.auto.gui.internal.macro.IMacroInstruction;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;

/**
 * Represents a macro command that can be included as part of the macro script
 * or played back to perform a UI interaction.
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen
 */
public interface IMacroCommand extends IMacroInstruction {
	/* command type constants */
	public static final String VERIFICATION = "verification";
	public static final String WAIT = "wait";
	public static final String MODIFY = "modify";
	public static final String SELECT = "select";
	public static final String ITEM_CHECK = "item-check";
	public static final String CHOICE_SELECT = "choice-select";
	public static final String CLOSE_WORKBENCHPART = "close-workbenchpart";
	public static final String ITEM_EXPAND = "item-expand";
	public static final String FOCUS = "focus";
	public static final String KEY_UP = "key-up";
	public static final String KEY_DOWN = "key-down";
	public static final String KEY_PRESS = "key-press";
	public static final String MOUSE_UP = "mouse-up";
	public static final String MOUSE_DOWN = "mouse-down";
	public static final String MOUSE_MOVE = "mouse-move";
	public static final String MOUSE_CLICK = "mouse-click";
	public static final String DEFAULT_SELECT = "default-select";
	public static final String ITEM_SELECT = "item-select";

	/** The bound for the value of descriptive fields */
	public static final int DESCRIPTIVE_FIELD_BOUND = 50;

	/**
	 * Returns the type of this command
	 * 
	 * @return The type
	 */
	public String getType();

	/**
	 * Allows this command to process the corresponding event.
	 * 
	 * @param event
	 *            The event that awaits processing
	 */
	public void processEvent(Event event) throws Exception;

	/**
	 * If this command occurs consecutively, then this method gives this command
	 * a chance to merge mutliple commands together to reduce the overhead.
	 * 
	 * @param event
	 *            The event that caused the creation of a consecutive command of
	 *            this type.
	 * 
	 * @return true if the command is merged; false otherwise.
	 * @throws Exception
	 *             TODO
	 */
	public boolean mergeEvent(Event e) throws Exception;

	/**
	 * Returns the descriptive field of this command. The descriptive field is a
	 * human readable label that allows users to easily identify the purpose of
	 * this command.
	 * 
	 * @return The descriptive field
	 */
	public String getDescriptiveField();

	/**
	 * Sets the descriptive field of this command. The descriptive field is a
	 * human readable label that allows users to easily identify the purpose of
	 * this command.
	 * 
	 * @param descriptiveField
	 *            The descriptive field
	 */
	public void setDescriptiveField(String descriptiveField);

	/**
	 * Returns the parent of this command.
	 * 
	 * @return The parent
	 */
	public MacroCommandShell getParent();

	/**
	 * Sets the parent of this command.
	 * 
	 * @param parent
	 *            The parent
	 */
	public void setParent(MacroCommandShell parent);

	/**
	 * Returns false if executing this command just after it has already been
	 * executed will have a different output. (e.g. Two focus commands that are
	 * identical are redundant but two button selections are not); otherwise
	 * true should be returned.
	 * 
	 * @return A flag indicating if repeats of this command are redundant.
	 */
	public boolean isRepeatRedundant();

}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableItem;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;

public class CheckCommand extends ToggleStructuredCommand {

	public static final String TYPE = IMacroCommand.ITEM_CHECK;

	/**
	 * @param wid
	 */
	public CheckCommand(MacroCommandShell parent) {
		super(parent);
	}

	public String getType() {
		return TYPE;
	}

	public void doProcessEvent(Event event) {
		super.doProcessEvent(event);
		
		Widget item = event.item;
		itemState = getItemState(item);
	}

	public boolean getItemState(Widget item) {
		if (item instanceof TreeItem)
			return ((TreeItem) item).getChecked();
		else if (item instanceof TableItem)
			return ((TableItem) item).getChecked();

		return false;
	}

	protected void playStructuredCommand(Widget widget, Object[] matches) {
		boolean isTree = widget instanceof Tree;
		boolean isTable = false;
		if (!isTree)
			isTable = widget instanceof Table;

		if (!isTree && !isTable)
			return;

		Event selectionEvent = null;

		for (int i = 0; i < matches.length; i++) {
			selectionEvent = constructSelectionEvent(widget);

			if ((widget.getStyle() & SWT.CHECK) != 0)
				selectionEvent.detail = SWT.CHECK;
			selectionEvent.item = (Widget) matches[i];

			if (isTree)
				((TreeItem) matches[i]).setChecked(getValue());
			else
				((TableItem) matches[i]).setChecked(getValue());

			/* Send the selection event */
			widget.notifyListeners(SWT.Selection,
				selectionEvent);
			MacroUtil.processDisplayEvents(widget.getDisplay());
		}

	}

	/**
	 * Clients will often expect a selection event to be sent. This helper method is used to construct a selection event.
	 * 
	 * @param widget
	 *            The widget that will be used to send out the event.
	 * @return The event.
	 */
	private Event constructSelectionEvent(Widget widget) {
		Event event = new Event();
		event.display = widget.getDisplay();
		event.widget = widget;
		event.type = SWT.Selection;
		return event;
	}

	protected void playStructuredCommandForFoundMatch(Widget widget, Object match) {
		/* Deosn't need to be implemented */
	}

		/* Deosn't need to be implemented */
	}

}




/*******************************************************************************
 * Copyright (c) 2000, 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.util.ArrayList;
import java.util.Hashtable;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.action.ActionContributionItem;
import org.eclipse.jface.action.ContributionItem;
import org.eclipse.jface.action.IMenuCreator;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObject;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptor;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.PrimitiveUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.UIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.UIObjectResolver;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.deresolvingsupport.UIObjectDeprecatedDeresolvingSupport;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * Represents the select command (e.g. button, check box, radio button, and
 * etc... selections)
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen
 */
public class BooleanSelectionCommand extends SingleSelectionCommand {

	public static final String TYPE = IMacroCommand.SELECT;

	private Boolean selection;

	/*
	 * Indicates the cursor location relative to the tool bar item (the value is
	 * non-zero if the toolbar item is dropped down
	 */
	private Point toolBarLocation;

	/* The detail of the event as described in the SWT class */
	private int detail;

	/*
	 * If an item is selected from a drop down menu, then this points to the id
	 * of the item
	 */
	private IUIObjectIdentifier itemSelectedIdentifier;

	/*
	 * The refrence id of the selected item that points to an object in an
	 * object mine
	 */
	private String itemSelectedRefId;

	/* This listener is used to get a reference to a drop-down menu */
	private DropDownMenuListener dropDownMenuListener;

	/* Reference to a drop-down menu */
	private Menu dropDownMenu;

	/* Indicates whether we're waiting for a drop down menu item */
	private boolean menuIsNeeded;

	public BooleanSelectionCommand(MacroCommandShell parent) {
		super(parent);
	}

	public String getType() {
		return TYPE;
	}

	public void doProcessEvent(Event event) {
		if (event.x != 0 || event.y != 0 || event.detail != 0) {
			this.toolBarLocation = new Point(event.x, event.y);
			this.detail = event.detail;
		} else {
			this.detail = -10;
		}

		selection = getSelection(event.widget);

		findDescriptiveField(event.widget);
	}

	private Boolean getSelection(Widget widget) {
		if ((widget.getStyle() & (SWT.CHECK | SWT.RADIO)) == 0)
			return null;
		if (widget instanceof Button)
			return new Boolean(((Button) widget).getSelection());
		if (widget instanceof ToolItem)
			return new Boolean(((ToolItem) widget).getSelection());
		if (widget instanceof MenuItem)
			return new Boolean(((MenuItem) widget).getSelection());
		return null;
	}

	public void load(Node node, Hashtable lineTable) throws CoreException {
		super.load(node, lineTable);
		String sel = MacroUtil.getAttribute(node,
				MacroConstants.SELECTION_ATTRIBUTE);
		String xCoordStr = MacroUtil.getAttribute(node,
				MacroConstants.X_COORD_ATTRIBUTE);
		String yCoordStr = MacroUtil.getAttribute(node,
				MacroConstants.Y_COORD_ATTRIBUTE);
		String detailStr = MacroUtil.getAttribute(node,
				MacroConstants.DETAIL_ATTRIBUTE);

		if (xCoordStr != null && yCoordStr != null)
			toolBarLocation = new Point(Integer.parseInt(xCoordStr), Integer
					.parseInt(yCoordStr));
		if (detailStr != null)
			detail = Integer.parseInt(detailStr);

		if (sel != null) {
			selection = sel.equals(MacroConstants.TRUE_VALUE) ? Boolean.TRUE
					: Boolean.FALSE;
		}
		NodeList children = node.getChildNodes();
		for (int i = 0; i < children.getLength(); i++) {
			Node child = children.item(i);
			if (!(child.getNodeType() == Node.ELEMENT_NODE))
				continue;

			if (child.getNodeName().equals(MacroConstants.SELECT_ITEM_ELEMENT)) {
				String pathOfItem = MacroUtil.getAttribute(child,
						MacroConstants.WIDGET_ID_ATTRIBUTE);
				if (pathOfItem == null) {
					String refId = MacroUtil.getAttribute(child,
							MacroConstants.REFERENCE_ID_ATTRIBUTE);
					if (refId == null) {
						itemSelectedIdentifier = null;
					} else {
						MacroObjectDescriptor uiObject = MacroManager
								.getInstance()
								.getObjectMine()
								.lookupMacroObjectDescriptor(
										getCorrespondingMacroObjectDescriptor(),
										refId);
						if (uiObject != null) {
							itemSelectedIdentifier = new PrimitiveUIObjectIdentifier(
									uiObject.getWidgetId(), uiObject
											.getResolverId());
						}
					}

				} else {
					itemSelectedIdentifier = new PrimitiveUIObjectIdentifier(
							pathOfItem);
				}

				dropDownMenuListener = new DropDownMenuListener();
			}
		}
	}

	public void write(int indent, StringBuffer sb) {
		super.write(indent, sb);
		boolean childElementPresent = itemSelectedIdentifier != null;
		MacroUtil
				.addAttribute(
						sb,
						new String[] { MacroConstants.X_COORD_ATTRIBUTE,
								MacroConstants.Y_COORD_ATTRIBUTE,
								MacroConstants.DETAIL_ATTRIBUTE,
								MacroConstants.SELECTION_ATTRIBUTE },

						new String[] {
								toolBarLocation == null ? null : String
										.valueOf(toolBarLocation.x),
								toolBarLocation == null ? null : String
										.valueOf(toolBarLocation.y),
								detail == -10 ? null : String.valueOf(detail),
								selection == null ? null
										: selection.equals(Boolean.TRUE) ? MacroConstants.TRUE_VALUE
												: MacroConstants.FALSE_VALUE },
						!childElementPresent, true);

		int pindent = childElementPresent ? indent + 1 : 0;

		if (itemSelectedIdentifier != null) {
			boolean useObjectMine = useObjectMine()
					&& itemSelectedRefId != null;
			MacroUtil.addElement(sb, pindent,
					MacroConstants.SELECT_ITEM_ELEMENT, false, false);
			MacroUtil
					.addAttribute(
							sb,
							new String[] { useObjectMine ? MacroConstants.REFERENCE_ID_ATTRIBUTE
									: MacroConstants.WIDGET_ID_ATTRIBUTE },
							new String[] { useObjectMine ? itemSelectedRefId
									: itemSelectedIdentifier.getWidgetId() },
							true, true);
			MacroUtil.addElement(sb, indent, MacroConstants.COMMAND_ELEMENT,
					true, true);
		}
	}

	public boolean doPlayback(Display display, Shell parent,
			IProgressMonitor monitor) throws CoreException {

		if (macroObject == null)
			return false;

		// boolean executeForFirstMatch = false;
		// for (int i = 0; i < targets.length && !executeForFirstMatch; i++) {
		setFocus(macroObject);
		Widget widget = macroObject.getUIObject().getWidget();

		// executeForFirstMatch = widget instanceof Button;
		Display currentDisplay = GuiPlugin.getDefault().getWorkbench()
				.getDisplay();
		ActionContributionItem contributionItem = null;
		if ((widget.getStyle() & (SWT.CHECK | SWT.RADIO)) == 0) {
			/*
			 * If in case we're dealing with a toolbar item that is a drop-down,
			 * then register appropriate listeners that will be used for getting
			 * a reference to the menu. We only need to do this if a menu
			 * creator is not provided
			 */
			if (widget instanceof ToolItem && /* Are we a tool item? */
			(widget.getStyle() & SWT.DROP_DOWN) != 0 && /* Are we a drop down? */
			itemSelectedIdentifier != null && /*
												 * Do we have a selected item
												 * from our menu (i.e. is the
												 * menu even needed)?
												 */
			widget.getData() instanceof ActionContributionItem)/*
																 * Are we
																 * dealing with
																 * a
																 * contribution
																 * item?
																 */
			{

				contributionItem = (ActionContributionItem) widget.getData();

				/* We don't have a menu creator. Register the listeners */
				if (contributionItem.getAction().getMenuCreator() == null) {
					currentDisplay.addFilter(SWT.Show, dropDownMenuListener);

				}
			}

			if (itemSelectedIdentifier == null
					|| (itemSelectedIdentifier != null
							&& contributionItem != null && contributionItem
							.getAction().getMenuCreator() == null))
				doClick(display, widget, false);
		}

		else if (selection != null) {
			doSelect(display, widget);
		}

		/* Select the item from the drop-down menu, if there is one set */
		if (itemSelectedIdentifier != null) {
			if (contributionItem == null) {
				currentDisplay.removeFilter(SWT.Show, dropDownMenuListener);
				return false; // continue; /* we weren't able to select the
				// item */
			}

			Menu menu = null;
			IMenuCreator menuCreator = contributionItem.getAction()
					.getMenuCreator();

			/* Attempt to create the menu */
			if (menuCreator != null)
				menu = menuCreator.getMenu(parent);
			/* Otherwise we wait until the menu is handed out to us */
			else {
				try {
					menuIsNeeded = true;
					/*
					 * Wait a maximum of INCREMENTS * COUNT in increments of
					 * INCREMENT
					 */
					final int INCREMENT = 200;
					final int COUNT = 15;
					synchronized (this) {
						int count = 0;
						while (dropDownMenu == null && count < COUNT) {
							wait(INCREMENT);
							count++;
						}
					}
				} catch (InterruptedException e) {
					/* doesn't need to be handled */
				}
				if (dropDownMenu != null)
					menu = dropDownMenu;
			}
			/* Bail out if we couldn't get the menu */
			if (menu == null) {
				currentDisplay.removeFilter(SWT.Show, dropDownMenuListener);
				return false; // continue; /* we weren't able to select the
				// item */
			}

			/* Unregister the listener */
			currentDisplay.removeFilter(SWT.Show, dropDownMenuListener);

			/* Find the menu item corresponding to the drop down menu */
			MenuItem[] menuItems = menu.getItems();
			MenuItem foundItem = null;
			for (int j = 0; j < menuItems.length; j++) {
				if (foundMenuItem(menuItems[j])) {
					foundItem = menuItems[j];
					break;
				}
			}

			if (foundItem == null)
				return false;// /continue;

			doClick(display, foundItem, true);

		}

		// }

		return true;
	}

	private boolean foundMenuItem(MenuItem menuItem) {
		/* Try the widget resolvers first */
		if (UIObjectDeprecatedDeresolvingSupport.foundItem(menuItem,
				itemSelectedIdentifier))
			return true;

		/* Give the old policy a try */
		Object menuItemIdObj = getDropDownItemTraditionalId(menuItem);
		if (menuItemIdObj.equals(itemSelectedIdentifier.getWidgetId()))
			return true;

		return false;
	}

	private Object getDropDownItemTraditionalId(MenuItem menuItem) {
		Object data = menuItem.getData();
		if (data instanceof ActionContributionItem) {
			return ((ActionContributionItem) data).getAction().getClass()
					.getName();
		} else if (data != null)
			return data.getClass().getName();

		/* As a last resort, index the menu item */
		return findMenuItemInx(menuItem, "");
	}

	private String findMenuItemInx(MenuItem menuItem, String index) {
		if (index != null && index.length() > 0)
			index = index + "|";

		Menu parentMenu = menuItem.getMenu();

		if (parentMenu == null)
			parentMenu = menuItem.getParent();

		if (parentMenu != null) {
			int currentInx = parentMenu.indexOf(menuItem);
			MenuItem parentItem = parentMenu.getParentItem();

			index = index + currentInx;
			if (parentItem != null)
				return index + findMenuItemInx(parentItem, index);
		}

		return index;
	}

	private void doClick(Display display, Widget widget, boolean isItemSelected)
			throws CoreException {

		checkEnableStatus(widget);
		Event e = new Event();
		e.type = SWT.Selection;
		e.widget = widget;
		e.display = display;

		boolean positionSet = false;
		boolean detailSet = false;
		if (!isItemSelected) {
			if (toolBarLocation != null) {
				e.x = toolBarLocation.x;
				e.y = toolBarLocation.y;
				positionSet = true;
			}

			if (detail != -10) {
				e.detail = detail;
				detailSet = true;
			}
		}

		boolean isWidgetNotified = false;

		/* We need to do an immediate notify if we're a drop down menu */
		if ((positionSet && detailSet) || menuIsNeeded) {
			isWidgetNotified = true;
			widget.notifyListeners(e.type, e);
		}

		/*
		 * If we're dealing with a drop down menu, then we have to send out this
		 * mouse down event. Otherwise the readAndDispatch will wait
		 * indefinitely. This is safe because we're only sending a mouse down
		 * event without a successive mouse up event.
		 */
		if (positionSet && detailSet) {
			/* Move the cursor to a safe position */
			Event mouseMoveEvent = new Event();
			mouseMoveEvent.type = SWT.MouseMove;
			mouseMoveEvent.x = 10;
			mouseMoveEvent.y = widget.getDisplay().getClientArea().height / 2;
			widget.getDisplay().post(mouseMoveEvent);

			Event mouseDownEvent = new Event();
			mouseDownEvent.type = SWT.MouseDown;
			mouseDownEvent.button = 1;
			widget.getDisplay().post(mouseDownEvent);
		}

		/* Run the events */
		MacroUtil.processDisplayEvents(display);

		/*
		 * Now notify the listeners of the widget if they haven't already been
		 * notified
		 */
		if (!isWidgetNotified) {
			widget.notifyListeners(e.type, e);
		}		
	}

	private void doSelect(Display display, Widget widget) throws CoreException {
		checkEnableStatus(widget);
		boolean shouldClick = false;
		if (widget instanceof Button) {
			((Button) widget).setSelection(selection.booleanValue());
			shouldClick = true;
		} else if (widget instanceof ToolItem) {
			((ToolItem) widget).setSelection(selection.booleanValue());
			shouldClick = true;
		} else if (widget instanceof MenuItem) {
			((MenuItem) widget).setSelection(selection.booleanValue());
			shouldClick = true;
		}

		/* Ali M.: We need to also send out a selection event */
		if (shouldClick)
			doClick(display, widget, selection.booleanValue());
	}

	/**
	 * Checks the enable status of the widget. If in case the widget happens to
	 * be disabled, then throw a core exception.
	 * 
	 * @param widget
	 *            The widget whose status is being checked.
	 * @throws CoreException
	 *             If widget is disabled
	 */
	public void checkEnableStatus(Widget widget) throws CoreException {
		Button button = null;
		if (widget instanceof Button
				&& !(button = ((Button) widget)).isEnabled())
			AutoGUIUtil.throwCoreException(NLS.bind(
					AutoGUIMessages.AUTO_GUI_ERROR_MACRO_DISABLE, button
							.getText()), getStartLine());
	}

	public int getDetail() {
		return detail;
	}

	public void setItemSelected(Event event) {
		if (!(event.widget instanceof MenuItem))
			return;

		// ANy: The formerly called determineItemId has moved into the
		// NonTrivialUIObjectResolverDelegate, which is the only contributor to
		// resolve/deresolve items,
		// so defect# 112668 is still handled properly here
		try {
			itemSelectedIdentifier = UIObjectResolver.resolve(new MacroObject(
					new UIObject(event.widget)).getContext(), new UIObject(
					(MenuItem) event.widget));
		} catch (Exception e) {
			e.printStackTrace();
		}

		/* Register the selected item with the object mine */
		MacroManager macroManager = MacroManager.getInstance();
		if (macroManager.isObjectMineOn()) {
			MacroObjectDescriptorMine objectMine = macroManager.getObjectMine();

			MacroObjectDescriptor parent = objectMine
					.lookupMacroObjectDescriptor(objectMine.getActiveObject(),
							getCorrespondingMacroObjectDescriptor()
									.getReferenceId());
			MacroObjectDescriptor macroObjectDescriptor = objectMine
					.lookupMacroObjectDescriptor(parent, null,
							itemSelectedIdentifier.getWidgetId(), itemSelectedIdentifier.getObjectId());

			if (macroObjectDescriptor == null) {
				macroObjectDescriptor = new MacroObjectDescriptor(parent);
				((MacroObjectDescriptor) macroObjectDescriptor)
						.setWidgetId(itemSelectedIdentifier.getWidgetId());
				((MacroObjectDescriptor) macroObjectDescriptor)
				.setObjectId(itemSelectedIdentifier.getObjectId());				
				((MacroObjectDescriptor) macroObjectDescriptor)
						.setResolver(itemSelectedIdentifier.getResolverId());
				((MacroObjectDescriptor) macroObjectDescriptor)
						.setDescriptive(getObjectClassName(event.widget));
				try {
					macroObjectDescriptor = objectMine
							.registerObject((MacroObjectDescriptor) macroObjectDescriptor);
				} catch (Exception e) {
					itemSelectedRefId = null;
				}
			}

			if (macroObjectDescriptor != null) {
				itemSelectedRefId = macroObjectDescriptor.getReferenceId();
			}
		}
	}

	public boolean isRepeatRedundant() {
		return false;
	}

	public class DropDownMenuListener implements Listener {

		public void handleEvent(Event event) {
			if (event.widget instanceof Menu) {
				dropDownMenu = (Menu) event.widget;
				synchronized (BooleanSelectionCommand.this) {
					BooleanSelectionCommand.this.notify();
				}
			}
		}

	}

	private static ArrayList getPath(MenuItem item) {
		ArrayList segments = new ArrayList();
		Object data = item.getData();

		if (data instanceof ContributionItem) {
			ContributionItem aitem = (ContributionItem) data;
			MenuManager manager = (MenuManager) aitem.getParent();
			while (manager != null) {
				String id = manager.getId();
				if (id == null)
					break;
				segments.add(0, id);
				manager = (MenuManager) manager.getParent();
			}
		}
		return segments.size() > 0 ? segments : null;
	}

		}
		
	}
}




/*******************************************************************************
 * Copyright (c) 2005, 2006 IBM Corporation 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
 * $Id: CloseWorkbenchPartCommand.java,v 1.1 2006/07/10 14:49:05 amehregani Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObjectIdentifier;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IEditorReference;
import org.eclipse.ui.IViewPart;
import org.eclipse.ui.IViewReference;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;

/**
 * The purpose of this class is to generate commands responsible for closing workbench parts.
 * 
 * @author Ali Mehregani
 */
public class CloseWorkbenchPartCommand extends ObjectBasedCommand {

	public static final String TYPE = IMacroCommand.CLOSE_WORKBENCHPART;

	public CloseWorkbenchPartCommand(MacroCommandShell parent) {
		super(parent);
	}

	public String getType() {
		return TYPE;
	}
	
	protected final void preProcessEvent(Event event) throws CoreException {
		IMacroObjectIdentifier macroObjectIdentifier = MacroUtil.getCustomEventIdentifier(event);
		if(macroObjectIdentifier == null){
			IWorkbenchPart part = (IWorkbenchPart) event.data;
			AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_OBJECT_RESOLVE, part));
		}
		setMacroObjectIdentifier(macroObjectIdentifier);
	}

	public void doProcessEvent(Event e) {
		setDescriptiveField(((IWorkbenchPart) e.data).getTitle());
	}

	public void write(int indent, StringBuffer sb) {
		super.write(indent,
			sb,
			true,
			true);
	}
	
	public boolean playback(Display display, Shell parent, IProgressMonitor monitor) throws CoreException {
		String partType = getMacroObjectIdentifier().getContextIdentifier().toString();
		String partId = getMacroObjectIdentifier().getObjectIdentifier().getWidgetId();

		boolean isView = partType.equals(MacroConstants.VIEW_VALUE);
		IEditorReference[] editorReferences = null;
		IViewReference[] viewReferences = null;

		IWorkbenchPage activePage = GuiPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getActivePage();
		String editorPartId = null;
		String editorInputName = null;

		/* Try to locate the part */
		if (isView) {
			viewReferences = activePage.getViewReferences();
		}
		else {
			editorReferences = activePage.getEditorReferences();
			Path partIdPath = new Path(partId);
			editorPartId = partIdPath.segment(0);
			editorInputName = partIdPath.segment(1);
		}

		IWorkbenchPart desiredPart = null;
		for (int i = 0; i < (isView
			? viewReferences.length
			: editorReferences.length); i++) {
			if (isView
				? viewReferences[i].getId().equals(partId)
				: (editorReferences[i].getId().equals(editorPartId) && editorReferences[i].getEditorInput().getName().equals(editorInputName))) {
				desiredPart = (isView
					? (IWorkbenchPart) viewReferences[i].getView(false)
					: (IWorkbenchPart) editorReferences[i].getEditor(false));
				break;
			}
		}

		/* Close the part if we found it */
		if (desiredPart != null) {
			if (isView)
				activePage.hideView((IViewPart) desiredPart);
			else
				activePage.closeEditor((IEditorPart) desiredPart,
					true);
		}

		return true;
	}

}




/*******************************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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
 * $Id: PositionBasedCommand.java,v 1.1 2006/07/10 14:49:05 amehregani Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.util.Hashtable;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.w3c.dom.Node;

/**
 * An abstract representation of position-based commands
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen (refactoring)
 */
public abstract class PositionBasedCommand extends AbstractMacroCommand {

	protected String type = null;
	protected Integer detail = null;
	
	public PositionBasedCommand(MacroCommandShell parent) {
		super(parent);
	}
	
	protected abstract String determineType(Event e);
	
	protected abstract Integer determineDetail(Event e);

	public void processEvent(Event event) throws Exception {
		this.type = determineType(event);
		this.detail = determineDetail(event);
	}
	
	public String getType() {
		return type;
	}
	
	public Integer getDetail() {
		return detail;
	}

	/**
	 * Constructs the SWT event that will be played back
	 * 
	 * @return The SWT event
	 */
	public abstract Event[] constructSWTEvents();

	/**
	 * String serialize this event
	 */
	public void write(int indent, StringBuffer sb, boolean close, boolean end) {
		MacroUtil.addElement(sb,
			indent,
			MacroConstants.COMMAND_ELEMENT,
			false,
			false);
		MacroUtil.addAttribute(sb,
			new String[] {MacroConstants.TYPE_ATTRIBUTE, MacroConstants.DETAIL_ATTRIBUTE},
			new String[] {getType(), detail != null ? String.valueOf(detail) : null},
			false,
			false);
	}
	
	public void load(Node node, Hashtable lineTable) throws CoreException {
		super.load(node, lineTable);

		type = MacroUtil.getAttribute(node, "type");
		if(MacroUtil.getAttribute(node, "detail") != null){
			detail = new Integer(MacroUtil.getAttribute(node, "detail"));
		}
	}

	/**
	 * Plays back this command
	 */
	public boolean playback(final Display display, final Shell parent, IProgressMonitor monitor) throws CoreException {
		Event[] events = constructSWTEvents();
		boolean success = true;

		for (int i = 0; i < events.length; i++) {
			success = success && display.post(events[i]);
		}
		
		MacroUtil.processDisplayEvents(display);
		return success;
	}

}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import org.eclipse.jface.window.Window;
import org.eclipse.jface.wizard.WizardDialog;
import org.eclipse.swt.widgets.Widget;

public class WizardCommandTarget extends WindowCommandTarget {
	/**
	 * @param widget
	 * @param window
	 */
	public WizardCommandTarget(Widget widget, Window window) {
		super(widget, window);
	}

	public WizardDialog getWizardDialog() {
		return (WizardDialog)getWindow();
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObjectIdentifier;

public class ExpansionCommand extends ToggleStructuredCommand {

	public static final String TYPE = IMacroCommand.ITEM_EXPAND;

	/**
	 * @param wid
	 */
	public ExpansionCommand(MacroCommandShell parent) {
		super(parent);
	}

	public ExpansionCommand(MacroCommandShell parent,
			IMacroObjectIdentifier identifier) {
		super(parent);
		setMacroObjectIdentifier(identifier);
	}

	public void doProcessEvent(Event event) {
		super.doProcessEvent(event);
		Widget item = event.item;
		itemState = getItemState(item);
	}

	/* Added for defect 164197 */

	public void doProcessEvent(Event event, boolean preferredState) {
		super.doProcessEvent(event);

		itemState = preferredState;
	}

	public void setItemState(boolean state) {
		this.itemState = state;
	}

	public boolean getItemState(Widget item) {
		if (item instanceof TreeItem)
			return !((TreeItem) item).getExpanded();

		return false;
	}

	protected void playStructuredCommand(Widget widget, Object[] matches) {
		/* Doesn't need to be implemented */
	}

	protected void playStructuredCommandForFoundMatch(Widget widget,
			Object match) {
		if (!(widget instanceof Tree))
			return;

		TreeItem treeItem = (TreeItem) match;
		treeItem.setExpanded(getValue());
		fireEvent(widget, treeItem);
	}

	private void fireEvent(Widget widget, Widget item) {
		Event event = new Event();
		event.type = getValue() ? SWT.Expand : SWT.Collapse;
		event.widget = widget;
		event.item = item;
		widget.notifyListeners(event.type, event);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.macro.SelectionCommand#getKind()
	 */
	public String getType() {
		return TYPE;
	}

}




/*******************************************************************************
 * Copyright (c) 2000, 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.util.ArrayList;
import java.util.Hashtable;
import java.util.Vector;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubProgressMonitor;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.window.Window;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.SWTException;
import org.eclipse.swt.custom.CCombo;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.List;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.TabFolder;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.core.IObjectMine;
import org.eclipse.tptp.test.auto.gui.internal.core.IPlayable;
import org.eclipse.tptp.test.auto.gui.internal.core.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.core.IWritable;
import org.eclipse.tptp.test.auto.gui.internal.core.VerificationMetaData;
import org.eclipse.tptp.test.auto.gui.internal.core.WidgetIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.macro.AbstractMacroInstruction;
import org.eclipse.tptp.test.auto.gui.internal.macro.Macro;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroObjectLocator;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macro.UIObject;
import org.eclipse.tptp.test.auto.gui.internal.macro.ObjectMine.IDCollisionException;
import org.eclipse.tptp.test.auto.gui.internal.macro.ObjectMine.UIObjectNotFound;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * <p>Keeps track of the macro commands while they are being captured.</p>
 * 
 * 
 * @author  Paul Slauenwhite
 * @version May 16, 2009
 * @since   July 10, 2006
 */
public class MacroCommandShell extends AbstractMacroInstruction
{
	/* The commands of this macro shell */
	private ArrayList commands;

	/* The expected return code */
	private int expectedReturnCode;

	/* The last event received */
	private transient Event lastEvent;

	/* The display object */
	private transient Display display;

	/* The shell that this macro command shell represents */
	private transient Shell shell;
	
	/* The reference id of the macro shell object */
	private String referenceId;
	
	/* The title of the shell that this macro command shell represents */
	private String shellTitle;

	private transient Window window;
	
	/* Indicates user interaction -- Set when a key up event is received */
	private transient boolean isKeyPressed;

	/* Indicates user interaction -- Set when a mouse up event is received */
	private transient boolean isMousePressed;
	
	/* Stores an event that is only acknowledged followed by user interaction. */
	private transient Event toBeAckEvent;
	
	/* Set when the stored event in toBeAckEvent is acknowledged */
	private transient boolean ackEvent;

	/* Set when there is a listener registered with this MacroCommandShell */
	private transient boolean isListenerRegistered;

	/* Stores the time for which a command was last created in */
	private long lastCommandCreationTime;
	
	/* A queue of nested shell waiting to be activated (this is used during playback) */ 
	private static Vector nestedShellQueue;
	
	/* Last index of the nested shell queue */ 
	private static int lastNestedShellInx;
	
	/* Stores the last command line executed */
	private static int lastCommandLineExecuted;
	
	/* Mutual lock used to block when a command is being executed.  This lock is used to forcefully wake up
	 * the thread that this object is running in if the command has caused a stall */
	private Boolean mutualLock;

	/* A mutual lock shared across multiple instances of this class -- It's general purpose is to lock shared static resources */
	private static Boolean mutualGlobalLock;
	
	/* The parent of this macro command shell.  This is null if this macro shell command is the root */
	private MacroCommandShell parent;

	/* The index of the command being executed -- this will correspond to the last command index if isComplete = true */
	private int currentCommandInx;

	/* Indicates if all the commands of this shell has been completed */
	private boolean isComplete;
	
	/* Indicates that the process needs to be interrupted -- due to an error */
	private static boolean interruptProcess;
	
	/* Set to true when process has been terminated */
	private static boolean processTerminated;

	/* The exception causing the interruption */
	private static Throwable interruptedException;
		
	/* A central container for all macro command operation being played */
	private static Vector macroCommandsBeingPlayed;
	
	/* A central container for all instances of this class */
	private static Vector macroCommandShellContainer;
	
	
	/* A central repository for all macro command shells */
	static
	{
		nestedShellQueue = new Vector();
		macroCommandsBeingPlayed = new Vector();
		macroCommandShellContainer = new Vector();
		mutualGlobalLock = new Boolean(true);
	}
	

	public MacroCommandShell(MacroCommandShell parent)
	{
		this(parent, null, null);
	}

	public MacroCommandShell(MacroCommandShell parent, Shell shell, WidgetIdentifier wid)
	{
		setWidgetId(wid);
		commands = new ArrayList();
		this.shell = shell;
		this.shellTitle = shell == null || shell.isDisposed() ? null : shell.getText();
		hookWindow(false);
		expectedReturnCode = -1;
		isListenerRegistered = false;
		mutualLock = new Boolean(true);
		this.parent = parent;
		isComplete = false;
		macroCommandShellContainer.add (this);		
	}

	private void hookWindow(boolean playback)
	{
		if (shell != null)
		{
			if (!playback)
				doHookWindow();
			else
				display.syncExec(new Runnable()
				{
					public void run()
					{
						doHookWindow();
					}
				});
		}
	}

	private void doHookWindow()
	{
		Object data = shell.getData();
		if (data != null && data instanceof Window)
			this.window = (Window) data;
	}

	
	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.macro.AbstractMacroInstruction#load(org.w3c.dom.Node, java.util.Hashtable)
	 */
	public void load(Node node, Hashtable lineTable) throws CoreException
	{
		super.load(node, lineTable);

		/* If the corresponding shell of this command is referenced then attempt to find
		 * the corresponding object in the object mine. */
		setCorrespondingObject(MacroObjectLocator.lookupReferenceId(null, node, lineTable));		
		boolean useObjectMine = getCorrespondingObject() != null;
		setWidgetId(new WidgetIdentifier(
				null,
				new Path(useObjectMine ? getCorrespondingObject().getObjectId() : MacroUtil.getAttribute(node, MacroConstants.ID_ATTRIBUTE)),
				useObjectMine ? getCorrespondingObject().getResolverId() : MacroUtil.getAttribute(node, MacroConstants.RESOLVER_ATTRIBUTE)));		
		String codeId = MacroUtil.getAttribute(node, MacroConstants.RETURN_CODE_ATTRIBUTE);
		if (codeId != null)
		{
			try
			{
				expectedReturnCode = new Integer(codeId).intValue();
			} catch (NumberFormatException e)
			{
			}
		}
		NodeList children = node.getChildNodes();
		for (int i = 0; i < children.getLength(); i++)
		{
			Node child = children.item(i);
			if (child.getNodeType() == Node.ELEMENT_NODE)
			{
				String name = child.getNodeName();
				if (name.equals(MacroConstants.COMMAND_ELEMENT))
					processCommand(child, lineTable);
				else if (name.equals(MacroConstants.SHELL_ELEMENT))
					processShell(child, lineTable);
			}
		}
	}

	/**
	 * Used to process the node that is passed in as argument, the lineTable hashtable indicates
	 * the range of line numbers that the node corresponds to in the macro script
	 *  
	 * @param node The node to be processed
	 * @param lineTable The line number range that the node corresponds to in the script.
	 */
	private void processCommand(Node node, Hashtable lineTable) throws CoreException
	{
		IUIObject commandObject = MacroObjectLocator.lookupReferenceId(getCorrespondingObject(), node, lineTable);
		boolean isObjectFound = commandObject != null;
		
		String cid = isObjectFound ? commandObject.getContextId() : MacroUtil.getAttribute(node, MacroConstants.CONTEXT_ID_ATTRIBUTE);
		String wid = isObjectFound ? commandObject.getObjectId() : MacroUtil.getAttribute(node, MacroConstants.WIDGET_ID_ATTRIBUTE);		
		String rid = isObjectFound ? commandObject.getResolverId() : MacroUtil.getAttribute(node, MacroConstants.RESOLVER_ATTRIBUTE);
		String type = MacroUtil.getAttribute(node, MacroConstants.TYPE_ATTRIBUTE);
		if (type == null)
			return;
		AbstractMacroCommand command = null;
		WidgetIdentifier wi = (wid != null && cid != null) ? new WidgetIdentifier(new Path(cid), new Path(wid), rid) : null;
		
		
		if (type.equals(ModifyCommand.TYPE))
			command = new ModifyCommand(this, wi);
		
		else if (type.equals(BooleanSelectionCommand.TYPE))
			command = new BooleanSelectionCommand(this, wi);
		
		else if (type.equals(StructuredSelectionCommand.ITEM_SELECT) || type.equals(StructuredSelectionCommand.DEFAULT_SELECT))
			command = new StructuredSelectionCommand(this, wi, type);
		
		else if (type.equals(ExpansionCommand.TYPE))
			command = new ExpansionCommand(this, wi);
		
		else if (type.equals(CheckCommand.TYPE))
			command = new CheckCommand(this, wi);
		
		else if (type.equals(FocusCommand.TYPE))
			command = new FocusCommand(this, wi);
		
		else if (type.equals(ChoiceSelectionCommand.TYPE))
			command = new ChoiceSelectionCommand(this, wi);
		
		else if (type.equals(WaitCommand.TYPE))
			command = new WaitCommand(this);
		
		/* The verification command */
		else if (type.equals(VerificationCommand.TYPE))
			command = new VerificationCommand(this, new VerificationMetaData());
		
		/* The close workbench part command */
		else if (type.equals(CloseWorkbenchPartCommand.TYPE))
			command = new CloseWorkbenchPartCommand(this, wi);
		
		/* Mouse events */
		else if (type.equals(MouseEventCommand.TYPE0) || type.equals(MouseEventCommand.TYPE1) || type.equals(MouseEventCommand.TYPE2))
			command = new MouseEventCommand (this);
		
		/* Key events */
		else if (type.equals(KeyEventCommand.TYPE0) || type.equals(KeyEventCommand.TYPE1) || type.equals(KeyEventCommand.TYPE2))
			command = new KeyEventCommand (this);
		
		if (command != null)
		{
			command.setCorrespondingObject(commandObject);		
			command.load(node, lineTable);			
			commands.add(command);
		}
	}


	private void processShell(Node node, Hashtable lineTable) throws CoreException
	{
		MacroCommandShell shell = new MacroCommandShell(this);
		shell.load(node, lineTable);
		commands.add(shell);
	}


	public void addCommandShell(MacroCommandShell cshell)
	{
		commands.add(cshell);
	}

	public void write(int indent, StringBuffer sb)
	{
		/* If this shell command doesn't have any commands, then exit */
		if (commands == null || commands.size() <= 0)
			return;
				
		/* <shell */
		MacroUtil.addElement(sb, indent, MacroConstants.SHELL_ELEMENT, false, false);
		boolean objectMineInUse = MacroManager.getInstance().isObjectMineOn() && getWidgetId().getReferenceId() != null;
		MacroUtil.addAttribute(sb, 
				new String[] {	MacroConstants.DESCRIPTIVE_ATTRIBUTE,
								MacroConstants.RESOLVER_ATTRIBUTE,
								MacroConstants.ID_ATTRIBUTE,
								MacroConstants.REFERENCE_ID_ATTRIBUTE,
								MacroConstants.RETURN_CODE_ATTRIBUTE},
				new String[] {	getDescriptiveField(),
								objectMineInUse ? null : getWidgetId().getResolverId(),
								objectMineInUse ? null : getWidgetId().getObjectId().toString(),
								objectMineInUse ? getWidgetId().getReferenceId() : null,
								String.valueOf(expectedReturnCode)}, false, true
		);
		int cindent = indent + 1;
		for (int i = 0; i < commands.size(); i++)
		{
			IWritable writable = (IWritable) commands.get(i);
			writable.writeStart(cindent, sb);
			writable.write(cindent, sb);
			writable.writeFinish(cindent, sb);
		}
		MacroUtil.addElement(sb, indent, MacroConstants.SHELL_ELEMENT, true, true);
	}
	
	public String getDescriptiveField()
	{
		return shellTitle == null ? null : MacroUtil.normalizeDescriptiveField(MacroUtil.boundSize(shellTitle, AbstractMacroCommand.DESCRIPTIVE_FIELD_BOUND));
	}

	public void addEvent(Event event)
	{
		if (event.widget instanceof Control)
		{
			if (((Control) event.widget).isVisible() == false)
				return;
		}
		
		AbstractMacroCommand command = null;
		if (event.detail == MacroManager.POSITION_BASED_EVENT)
			command = createPositionBasedCommand(event);
		else
			command = createCommand(event);
		
		if (command != null)
		{			
			AbstractMacroCommand lastCommand = getLastCommand();
			
			/* Take out the last command if it is a focus command and the command just passed in implicitly does a focus */ 
			if (lastCommand != null && 
					(lastCommand.getWidgetId() != null && lastCommand.getWidgetId().equals(command.getWidgetId()) && lastCommand.getType().equals(FocusCommand.TYPE) && isFocusCommand(command.getType())))
			{
				// focus followed by select or modify - focus implied
				commands.remove(lastCommand);
			}
			
			/* Modify the last event accordinggly */
			if (ackEvent)				
			{
				ackEvent = false;
				lastEvent = toBeAckEvent;
				toBeAckEvent = null;
			}
			else
			{
				lastEvent = event;
			}
			
			/* Add the artificial wait time if required */
			if (MacroManager.getInstance().isArtificialWaitOn() && lastCommandCreationTime > 0)
			{
				long currentTime = System.currentTimeMillis();
				long difference = currentTime - lastCommandCreationTime;
				command.setTimeDifference(difference);
			}
			
			lastCommandCreationTime = System.currentTimeMillis();
			
			/* Ali M.: The following block of code provides a workaround for a limitation that
			 * exists for CloseWorkbenchPartCommand.  We are only able to capture this event
			 * after the entire part has been disposed.  Things would be ideal if this event
			 * could be captured right after the user clicks on the close button of the part */			
			if (command instanceof CloseWorkbenchPartCommand)
			{
				int commandSize = commands.size();
				if (commandSize > 0)
				{
					/* If the last command corresponds to the message dialog that prompts the
					 * user to save an editor, then store it after the close command */
					Object lastCommandStored = commands.get(commandSize - 1);
					if (lastCommandStored instanceof MacroCommandShell &&													/* If the last stored command is a shell */ 
						((CloseWorkbenchPartCommand)command).getWidgetId().getContextId().equals(MacroConstants.EDITOR_VALUE) &&				/* If the part is an editor */
						((MacroCommandShell)lastCommandStored).getWidgetId().getObjectId().equals(MessageDialog.class.getName()))				/* If the shell is a MessageDialog */
						
					{						
						commands.add(commandSize - 1 , command);
						return;						
					}
				}
				
			}
			/* Added for defect 164197 in order to add an item-expansion to the parent whenever the 
			 * child is selected in a case where the parent has been pre-expanded.
			 * Liz D.
			 */
			if (command instanceof StructuredSelectionCommand && event.widget instanceof Tree){
				
				StructuredSelectionCommand s = (StructuredSelectionCommand)command;
				
				TreeItem[] items = (TreeItem [])s.getItemsForEvent(event);
				for (int i=0; i<items.length; i++)
				{
					TreeItem selectedItem = (TreeItem) items[i];
					
					while(selectedItem.getParentItem()!=null)
					{
						TreeItem parent = selectedItem.getParentItem();
						if (parent.getExpanded()== true)
						{//necessary so that we only apply this in the case where the parent is already expanded
							Event expansionEvent = new Event();
							expansionEvent.widget = parent;
							expansionEvent.item = parent;
							ExpansionCommand parentExpand = new ExpansionCommand(this, command.getWidgetId());
							parentExpand.processEvent(expansionEvent, true);
							commands.add(parentExpand);
						}
						selectedItem = parent;
					}// end while			
				}		
			}
						
			commands.add(command);}
		
	}

	
	/**
	 * Adds a wait command for as long as the last command is not already a wait (i.e.
	 * duplicate addition of wait commands are avoided through this method)
	 */
	public void addPause()
	{
		WaitCommand command = new WaitCommand(this);
		
		Object lastCommand = null;
		int commandSize = commands.size();
		boolean isLastCommandWait = false;
		
		if (commandSize <= 0)
			return;
		
		lastCommand = commands.get (commandSize - 1);
		int lastCmdInx = 2;
		
		/* Avoid MacroCommandShells that have no commands (since these will not be included 
		 * as part of the macro) */
		while (lastCommand instanceof MacroCommandShell && ((MacroCommandShell)lastCommand).getCommands().size() <= 0) 
		{
			if (commandSize - lastCmdInx >= 0)
				lastCommand = commands.get (commandSize - lastCmdInx);
			else
			{
				lastCommand = null;
				break;
			}
			
			lastCmdInx++;
		}
		
		AbstractMacroCommand lastMacroCommand = null;
		if (lastCommand instanceof AbstractMacroCommand)
			lastMacroCommand = (AbstractMacroCommand)lastCommand;
		
		isLastCommandWait = lastMacroCommand != null && lastMacroCommand.getType() == WaitCommand.TYPE;
		if (commands.size() > 0 && !isLastCommandWait)
		{
			commands.add(command);				
		}
	}

	public void addVerificationCommand (VerificationCommand command)
	{
		commands.add(command);
	}
	
	public void extractExpectedReturnCode()
	{
		if (window != null)
			expectedReturnCode = window.getReturnCode();
	}

	public boolean matchesReturnCode()
	{
		if (window != null)
		{
			return window.getReturnCode() == expectedReturnCode;
		}
		return true;
	}

	private boolean isFocusCommand(String type)
	{
		return type.equals(BooleanSelectionCommand.TYPE) || type.equals(StructuredSelectionCommand.ITEM_SELECT) || type.equals(StructuredSelectionCommand.DEFAULT_SELECT) || type.equals(ExpansionCommand.TYPE) || type.equals(CheckCommand.TYPE) || type.equals(ModifyCommand.TYPE);
	}

	/**
	 * Handles position-based events 
	 */
	protected AbstractMacroCommand createPositionBasedCommand (Event event)
	{
		AbstractMacroCommand command = null;
		
		switch (event.type)
		{
			case SWT.MouseUp:
			case SWT.MouseDown:
			case SWT.MouseDoubleClick:
				command = new MouseEventCommand (this);			
				break;
			
			case SWT.KeyUp:
			case SWT.KeyDown:
				command = new KeyEventCommand (this);
				break;
			
		}
		
		if (command != null)
			command.processEvent (event);
		return command;
	}
	
	
	/**
	 *  Handles object-based events
	 */
	protected AbstractMacroCommand createCommand(Event event)
	{	
		/* A quick way to get out if we're only getting key up or mouse events that have been detected before */
		if ((isKeyPressed && event.type == SWT.KeyUp) || (isMousePressed && event.type == SWT.MouseUp))
			return null;
		
		AbstractMacroCommand lastCommand = getLastCommand();
		if (lastEvent != null && lastEvent.widget != null && lastEvent.widget.equals(event.widget))
		{
			if (lastEvent.type == event.type || (lastEvent.type == SWT.Selection && event.type == SWT.DefaultSelection))
			{
				if (lastCommand != null && lastCommand.mergeEvent(event))
					return null;
			}
		}
				
		AbstractMacroCommand command = null;
		
		/* Check to see if we are a drop-down menu selection */
		if (lastCommand != null && lastCommand.getType() == BooleanSelectionCommand.TYPE && 
				((BooleanSelectionCommand)lastCommand).getDetail() == SWT.DROP_DOWN)
		{
			((BooleanSelectionCommand)lastCommand).setItemSelected (event);
			return null;
		}
				
		
		WidgetIdentifier wi = MacroUtil.getWidgetIdentifier(event.widget);		
		if (wi == null)
			wi = MacroUtil.getCustomEventIdentifier(event);				
		if (wi == null)
			return null;
		
		
		switch (event.type)
		{
			case SWT.Modify:				
				if (!isEditable(event.widget))
					return null;
				
				/* This block of code is used to avoid displaying the browse native dialog when the user clicks
				 * a browse button - it doesn't cover all cases */
				if (lastEvent != null && lastEvent.type == SWT.Selection && lastEvent.widget instanceof Button)
				{
					String text = ((Button)lastEvent.widget).getText();
					if (text != null)
					{
						text = text.replaceAll("\\&", "");
						text = text.toLowerCase();
						if (text.indexOf(AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_BROWSE) != -1)
						{
							ArrayList commands = this.getCommands();
							int size = 0;
							if (commands != null && (size = commands.size()) > 0)
							{
								commands.remove(size - 1);					
								command = new ModifyCommand(this, MacroUtil.getWidgetIdentifier(event.widget));
								break;
							}
						}
					}				
				}
				
				/* Only acknowledge modifies that are followed by a key up event */
				toBeAckEvent = event;								
				break;
			
			case SWT.Selection:
			case SWT.DefaultSelection:
				command = createSelectionCommand(wi, event);				
				break;
			
			case SWT.FocusIn:
				/**
				 * Ali M.: While recording, the SWT display listener has the tendency to report
				 * focus events on controls that are actually not visible to the user.  When the
				 * macro is played back, the control cannot be located.  To avoid this problem
				 * we only acknowledge focus events that are followed by a mouse up or key up event (i.e.
				 * The user explicitly focuses on the control).
				 */
				toBeAckEvent = event;
				break;
			
			case SWT.Expand:
			case SWT.Collapse:
				command = new ExpansionCommand(this, wi);
				
				break;
				
			case SWT.KeyUp:
				isKeyPressed = true;	
				if (toBeAckEvent != null && toBeAckEvent.type == SWT.Modify)
				{
					command = new ModifyCommand(this, MacroUtil.getWidgetIdentifier(toBeAckEvent.widget));
					ackEvent = true;
					break;
				}
				
			case SWT.MouseUp:
				isMousePressed = true;	
				if (toBeAckEvent != null && toBeAckEvent.type == SWT.FocusIn)
				{
					command = new FocusCommand(this, MacroUtil.getWidgetIdentifier(toBeAckEvent.widget));
					ackEvent = true;
				}
				break;
			case Macro.WORKBENCH_PART_CLOSED:
				/* 110810 -- Create the close workbench command only if there is only one frame
				 * in our shell stack */
				if (MacroManager.getInstance().getCurrentMacro().getShellStackSize() == 1)
					command = new CloseWorkbenchPartCommand (this, wi); 
				break;
		}
		
		if (event.type != SWT.KeyUp)
			isKeyPressed = false;
		else if (event.type != SWT.MouseUp)
			isMousePressed = false;
		
		
		if (command != null)
		{
			/* Lookup the widget of this command.  If it already exists in our object mine, then
			 * have it referenced by setting the reference id of the command. */
			IObjectMine objectMine = MacroManager.getInstance().getObjectMine();
			IUIObject uiObject = null;
			WidgetIdentifier commandWidgetIdentifier = command.getWidgetId();
			boolean needsDescriptiveField = false;
			try
			{
				IUIObject activeObject = objectMine.getActiveObject();
				uiObject = objectMine.lookupUIObject(activeObject, commandWidgetIdentifier.getContextId() == null ? null : commandWidgetIdentifier.getContextId().toString(), commandWidgetIdentifier.getObjectId().toString());
				
				/* The object is not registered with the object mine - register it */
				if (uiObject == null)
				{
					needsDescriptiveField = true;
					uiObject = UIObject.createInstance(objectMine, command, activeObject);
					objectMine.registerObject(uiObject);
				}
				commandWidgetIdentifier.setReferenceId(uiObject.getReferenceId());				
			} 
			
			/* We can't afford to show an error message in case of an unexpected error during 
			 * registeration.  We'll ignore the error and not make use of the object mine. */
			catch (UIObjectNotFound e)
			{
				/* Should not happen */
			} catch (IDCollisionException e)
			{
				/* Should not happen */
			} catch (CoreException e)
			{
				/* Should not happen */
			}
						
			command.processEvent(event);
			
			if (needsDescriptiveField && uiObject != null)
			{
				uiObject.setDescriptive(command.getObjectClassName(event.widget) + (command.getDescriptiveField() == null ? MacroConstants.EMPTY_STRING : ": " + command.getDescriptiveField()));
			}
		}
		
		/* Ensure that redundant commands are not created */
		if (lastCommand != null && command != null && command.isRepeatRedundant() && command.equals(lastCommand))
		{
			return null;
		}
		return command;
	}

	private boolean isEditable(Widget widget)
	{
		if (widget instanceof Control)
		{
			Control control = (Control) widget;
			if (!control.isEnabled())
				return false;
			if (control instanceof Text)
				return ((Text) control).getEditable();
			if (control instanceof Combo || control instanceof CCombo)
				return ((control.getStyle() & SWT.READ_ONLY) == 0);
			if (control instanceof StyledText)
				return ((StyledText) control).getEditable();
		}
		return true;
	}

	private AbstractMacroCommand createSelectionCommand(WidgetIdentifier wid, Event event)
	{				
		if (event.widget instanceof MenuItem || event.widget instanceof ToolItem || (event.widget instanceof Button
				/* A CCombo will cause a button selection followed by a combo selection.  
				 * We need to ignore the button selection */
				&& !(event.widget instanceof Control && ((Control)event.widget).getParent() instanceof CCombo)))
		{						
			if (event.x != 0 || event.y != 0 || event.detail != 0)
				return new BooleanSelectionCommand(this, wid, new Point (event.x, event.y), event.detail);
			return new BooleanSelectionCommand(this, wid);			
		}
		
		if (event.widget instanceof Tree || event.widget instanceof Table || event.widget instanceof List)
		{
			if (event.detail == SWT.CHECK)
				return new CheckCommand(this, wid);
			String type = event.type == SWT.DefaultSelection ? StructuredSelectionCommand.DEFAULT_SELECT : StructuredSelectionCommand.ITEM_SELECT;
			return new StructuredSelectionCommand(this, wid, type);
		}
		
		if (event.widget instanceof TabFolder || event.widget instanceof CTabFolder)
			return new ChoiceSelectionCommand(this, wid);
		
		if (event.widget instanceof Combo || event.widget instanceof CCombo)
			return new ChoiceSelectionCommand(this, wid);
		
		return null;
	}


	private AbstractMacroCommand getLastCommand()
	{
		if (commands.size() > 0)
		{
			Object item = commands.get(commands.size() - 1);
			if (item instanceof AbstractMacroCommand)
				return (AbstractMacroCommand) item;
		}
		return null;
	}

	public boolean isDisposed()
	{
		return this.shell != null && this.shell.isDisposed();
	}

	public void close()
	{
		if (this.shell != null && !this.shell.isDisposed())
			this.shell.close();
	}

	public boolean tracks(Shell shell)
	{
		if (this.shell != null && this.shell.equals(shell))
			return true;
		return false;
	}
	
	public boolean playback(final Display display, Composite parent, final IProgressMonitor monitor) throws CoreException
	{		
		if (parent instanceof Shell)
		{
			this.shell = (Shell) parent;
			this.display = display;
			hookWindow(true);
		}

		NestedShell nestedShell = null;
		int commandSize = commands.size();
		monitor.beginTask("", commandSize);
		final int commandTimeOut;
		
		int potentialTimeoutValue = MacroManager.getInstance().getCommandTimeoutThreshold();
		if (MacroManager.getInstance().getCommandTimeoutThreshold() > 0)
			commandTimeOut = potentialTimeoutValue;
		else
			commandTimeOut = GlobalConstants.DEFAULT_COMMAND_TIME_OUT_PERIOD;
			
		for (int i = 0; i < commandSize; i++)
		{
			currentCommandInx = i;
			checkForInterruptions();							
			Object c = commands.get(i);
			final IPlayable playable = (IPlayable) c;
			
			/* If this is the last command of this macro command shell, then take out its entry in the shell queue */	
			if (isLastCommand(i))
			{
				if (getNestedShellQueue() != null && getNestedShellQueue().size() > 0)
				{
					if (lastNestedShellInx > 0)
						lastNestedShellInx--;
					removeNestedShell(0);
				}
			}
			
			/* If this command is a nested shell, then we need to wait until it completes before proceeding to the next command. */
			if (c instanceof MacroCommandShell)
			{
				MacroCommandShell nestedCommandShell = (MacroCommandShell)c;
				//System.out.println("NESTED SHELL WAIT: " + nestedCommandShell.getId());
				Object lastNestedCommand = null;
				Object currentNestedCommand = null;
				synchronized (nestedCommandShell)
				{
					/* Give each command in the nested shell a maximum of commandTimeOut to execute */
					while (!nestedCommandShell.isComplete() && (currentNestedCommand == null || lastNestedCommand != currentNestedCommand) && !interruptProcess)
					{
						try 
						{
							nestedCommandShell.wait(commandTimeOut);
							lastNestedCommand = currentNestedCommand;
							currentNestedCommand = nestedCommandShell.getCommandBeingExecuted();
						} catch (InterruptedException e) 
						{
							/* Handled by next set of code */
						}
					}
					
					/* Indicate an error if the nested shell never completed */
					if (!nestedCommandShell.isComplete())
					{							
						synchronized (mutualGlobalLock)
						{
							interruptProcess = true;
							if (interruptedException == null)
								interruptedException = new CoreException (new Status(IStatus.ERROR, GuiPlugin.getID(), 0, 
										NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_NEST_TOUT, nestedCommandShell.getWidgetId().getObjectId().toString()), null));
						}
						
						continue;	/* Interrupt the normal flow */
					}
					//System.out.println("NESTED SHELL FINISH: " + nestedCommandShell.getId());
				}
			}
			
			if (i < commandSize - 1)
			{
				/* Ali M.: We need to iterate through all the shell commands and register listeners
				 * before it's too late.  It's not sufficient to just register a listener with the 
				 * next command */
				int counter = 1;
				IPlayable next = (IPlayable) commands.get(i + counter);
				while (next instanceof MacroCommandShell)
				{					
					/* This command will open a new shell.  Add a listener before it is too late */
					MacroCommandShell nestedCommand = (MacroCommandShell) next;
					
					if (!nestedCommand.isListenerRegistered())
					{
						nestedShell = new NestedShell(display, nestedCommand, new SubProgressMonitor(monitor, 1));
						final NestedShell fnestedShell = nestedShell;

						
						/* If this is a child of the previous shell, then it takes precedence.  If it's a sibling, then it
						 * should go to the end of the queue. */
						nestedCommand.setListenerRegistered(true);
						if (nestedShellQueue.size() > 0 && ((NestedShell)nestedShellQueue.get(0)).isParent(nestedCommand))
						{
							addNestedShell(0, fnestedShell);
							lastNestedShellInx = 0;
						}
						else
						{
							if (nestedShellQueue.size() > 0)
								addNestedShell(++lastNestedShellInx, fnestedShell);
							else
								addNestedShell(fnestedShell);							
						}
						
						display.syncExec(new Runnable()
								{
									public void run()
									{
										//System.out.println("ADDED");
										display.addFilter(SWT.Activate, fnestedShell);
									}
								});						
					}
					counter++;
					next = (i + counter <= commandSize - 1 ? (IPlayable) commands.get(i + counter) : null);					
				}
			}
			if (playable instanceof AbstractMacroCommand)
			{			
				final boolean last = i == commandSize - 1;	
				
				
				class WakeUpOperaion implements Runnable
				{
					private AbstractMacroCommand command;
					private boolean invalidate;
					
					public WakeUpOperaion (AbstractMacroCommand command)
					{
						this.command = command;
						invalidate = false;
					}
					
					public void run() 
					{
						if (!invalidate && MacroCommandShell.lastCommandLineExecuted == command.getStartLine())
						{
							/* Ali M.: A command just timed-out.  We need to indicate the error 
							 * and wakeup the thread */
							synchronized (mutualGlobalLock)
							{
								interruptProcess = true;								
								if (interruptedException == null)
									interruptedException = new CoreException (new Status(IStatus.ERROR, GuiPlugin.getID(), 0, 
										NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_TIME_OUT, command.toString()), null));
							}
							
							synchronized (mutualLock)
							{
								mutualLock.notify();
							}
						}
					}
					
					public void invalidate()
					{
						this.invalidate = true;
					}

				}					
				WakeUpOperaion wakeupOpt = null;
				if (i < commandSize - 1)
				{				
					wakeupOpt = new WakeUpOperaion ((AbstractMacroCommand)playable);
					final Runnable wakeupOperation = wakeupOpt;					
					display.asyncExec(
						new Runnable()
						{
							public void run() 
							{
								display.timerExec(commandTimeOut, wakeupOperation);
							};
							
						}	
					);
				}
					
				
				class RunCommandOperation implements Runnable
				{
					private boolean isComplete;
					
					public void run()
					{ 
						try 
						{						
							if (!macroCommandsBeingPlayed.contains(this))
								macroCommandsBeingPlayed.add(this);
							
							lastCommandLineExecuted = ((AbstractMacroCommand)playable).getStartLine();
							playInGUIThread(display, playable, last, monitor);	
							
							macroCommandsBeingPlayed.remove(this);
							isComplete = true;
							synchronized (mutualLock) 
							{
								mutualLock.notify();
							}
						}
						catch (Throwable e) 
						{					
							macroCommandsBeingPlayed.remove(this);
							synchronized (mutualGlobalLock)
							{
								interruptProcess = true;
								if (interruptedException == null)
									interruptedException = e;
							}
							isComplete = true;
							synchronized (mutualLock)
							{
								mutualLock.notify();
							}
						} 
					} 
					
					public boolean isComplete()
					{
						return isComplete;
					}

				}
				
				RunCommandOperation runCommandOpt = new RunCommandOperation();
				

				/* Run the command */
				synchronized (mutualLock)
				{					
					new Thread(runCommandOpt).start();
					long start = System.currentTimeMillis();
					long wakeUpTime = start;
					long timeToSleep = commandTimeOut;
					try 
					{
						while (!runCommandOpt.isComplete() && timeToSleep > 0 && !interruptProcess)
						{
							//System.out.println("WAITING on command: " + playable);
							mutualLock.wait(timeToSleep);
							wakeUpTime = System.currentTimeMillis();
							timeToSleep = timeToSleep - (wakeUpTime - start);
						}
					} catch (InterruptedException e) 
					{
						/* Doesn't need to be handled */
					}
					
					/* Indicate an error if command didn't complete */
					if (!runCommandOpt.isComplete())
					{	
						synchronized (mutualGlobalLock)
						{
							interruptProcess = true;
							if (interruptedException == null)
								interruptedException = new CoreException (new Status(IStatus.ERROR, GuiPlugin.getID(), 0, 
										NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_TIME_OUT, playable.toString()), null));							
						}
					}	
					/* Otherwise invalidate the wake up operation that was suppose to wake this
					command up */
					else if (wakeupOpt != null)
						wakeupOpt.invalidate();
					
					//System.out.println("FINISHED WAITING on command: " + playable);
				}
								
				monitor.worked(1);
			} 			
		}
		
		checkForInterruptions();
		shell = null;
		
		/* We made it out alive -- mark this as complete and wake any parents that are waiting upon our completion */
		isComplete = true;
		synchronized(this)
		{
			this.notify();
		}
		
		macroCommandShellContainer.remove(this);
		return true;
	}


	private boolean isComplete() 
	{	
		return isComplete;
	}

	private Object getCommandBeingExecuted() 
	{
		if (commands == null || currentCommandInx >= commands.size())
			return null;
		return commands.get(currentCommandInx);
	}

	private void checkForInterruptions() throws CoreException
	{
		if (interruptProcess)
		{	
			/* Wake up all threads in case they are asleep */
			if (!processTerminated)
			{
				processTerminated = true;
				interruptOperation();				
				MacroCommandShell.macroStopped();
				MacroUtil.closeSecondaryShells(display);			
			}
						
			for (int i = 0; i < macroCommandShellContainer.size(); i++)
			{
				synchronized (mutualLock)
				{
					mutualLock.notify();
				}
				
				synchronized (macroCommandShellContainer.get(i))
				{
					macroCommandShellContainer.get(i).notify();
				}
			}
			
			/* Try to close all nested shells */
			synchronized (mutualGlobalLock)
			{
				if (interruptedException instanceof CoreException)
					throw (CoreException)interruptedException;
				throw new CoreException (new Status(IStatus.ERROR, GuiPlugin.getID(), 0, interruptedException.getLocalizedMessage(), interruptedException));
			}
		}
		
	}

	/**
	 * A helper method that walks through all macro command shells and 
	 * interrupts their normal flow.
	 */
	private void interruptOperation() 
	{
		MacroCommandShell currentMacroShell = this;
		while (currentMacroShell != null)
		{
			Boolean lock = currentMacroShell.mutualLock;
			synchronized(lock)
			{
				lock.notify();
			}
			
			currentMacroShell = currentMacroShell.getParent();
		}
		
	}

	private boolean isLastCommand(int index) 
	{
		for (int i = index + 1; i < commands.size(); i++)
		{
			if (commands.get(i) instanceof AbstractMacroCommand)
				return false;
		}
		return true;
	}

	private void playInGUIThread(final Display display, final IPlayable playable, boolean last, final IProgressMonitor monitor) throws CoreException
	{
		final CoreException[] ex = new CoreException[1];

		Runnable runnable = new Runnable()
		{
			public void run()
			{
				try
				{						
					boolean status = playable.playback(display, MacroCommandShell.this.shell, monitor);
					
					/* Something went wrong playing this item */
					if (!status)
						ex[0] = createPlaybackException(playable, null);
					else
						MacroUtil.processDisplayEvents(display);
				} 
				catch (ClassCastException e)
				{
					ex[0] = createPlaybackException(playable, e);
				} 
				catch (CoreException e)
				{
					ex[0] = e;
				}
				catch (SWTException e)
				{
					/* Don't handle */
				}
				catch (Throwable error)
				{
					ex[0] = createPlaybackException(playable, error);
				}
			}
		};

		if (playable instanceof WaitCommand)
		{
			playable.playback(display, this.shell, monitor);
		} 
		else
		{
			display.syncExec(runnable);			
		}
					
		try
		{
			Thread.sleep(100);
		} catch (InterruptedException e)
		{
		}

		if (ex[0] != null)
			throw ex[0];
				
	}

	private CoreException createPlaybackException(IPlayable playable, Throwable th)
	{
		IStatus status = new Status(IStatus.ERROR, "org.eclipse.pde.ui.tests", IStatus.OK, NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_COMMAND, playable.toString()), th);
		return new CoreException(status);
	}
	
	
	public ArrayList getCommands()
	{
		return commands;
	}

	public boolean isListenerRegistered() {
		return isListenerRegistered;
	}

	public void setListenerRegistered(boolean isListenerRegistered) {
		this.isListenerRegistered = isListenerRegistered;
	}

	public static Vector getNestedShellQueue() 
	{
		return nestedShellQueue;
	}
	
	public static void addNestedShell(int inx, NestedShell nestedShell)
	{
		synchronized (nestedShellQueue)
		{
			if (inx >= 0)
				nestedShellQueue.add(inx, nestedShell);
			else
				nestedShellQueue.add(nestedShell);
		}
	}
	
	private static void addNestedShell(NestedShell fnestedShell) 
	{
		addNestedShell (-1, fnestedShell);		
	}
	
	
	public static void removeNestedShell(int inx)
	{
		synchronized (nestedShellQueue)
		{
			nestedShellQueue.remove(inx);
		}
	}
	
	
	public static void initializeForNewPlay()
	{
		nestedShellQueue.clear();
		lastNestedShellInx = 0;
		interruptProcess = false;
		processTerminated = false;
		interruptedException = null;
		MouseEventCommand.init();
		macroCommandsBeingPlayed.clear();
		macroCommandShellContainer.clear();
	}

	public Shell getShell() {
		return shell;
	}
	
	public void writeStart(int indent, StringBuffer sb)
	{
		/* Doesn't need to be implemented */		
	}

	public void writeFinish(int indent, StringBuffer sb)
	{
		/* Doesn't need to be implemented */	
	}

	public MacroCommandShell getParent() {
		return parent;
	}

	public void setParent(MacroCommandShell parent) {
		this.parent = parent;
	}

	public static void macroStopped() 
	{
		/* Walk through nested shell listeners and remove them if any exists */
		final Display display = GuiPlugin.getDefault().getWorkbench().getDisplay();
		display.syncExec(new Runnable(){

			public void run() {
				for (int i = 0, nestedShellListenerSize = nestedShellQueue.size(); i < nestedShellListenerSize; i++)
				{
					display.removeFilter(SWT.Activate, (NestedShell)nestedShellQueue.get(i));	
				}				
			}
		});					
	}

	public static Vector getMacroCommandsBeingPlayed() {
		return macroCommandsBeingPlayed;
	}
		
	public String getReferenceId()
	{
		return referenceId;
	}

	public void setReferenceId(String referenceId)
	{
		this.referenceId = referenceId;
	}
	
	
	private static class NestedShell implements Listener, Runnable
	{
		private MacroCommandShell cshell;

		private Display display;

		private Shell nshell;

		private IProgressMonitor monitor;

		private boolean served;		
				
		public NestedShell(Display display, MacroCommandShell cshell, IProgressMonitor monitor)
		{
			this.display = display;
			this.cshell = cshell;
			this.monitor = monitor;
		}

		public void handleEvent(Event e)
		{
			try
			{
				if (e.widget instanceof Shell)
				{
					// shell activated
					Shell shell = (Shell) e.widget;
					IPath path = new Path(MacroUtil.getShellId(shell, null).toString());
					String sid = path.toString();
					
					/* Debug */
					//System.out.println();
					//System.out.println(sid + " : " + cshell.getId());
					//if (MacroCommandShell.getNestedShellQueue() != null && MacroCommandShell.getNestedShellQueue().size() > 0)
						//System.out.println("Is Served: " + ((NestedShell)MacroCommandShell.getNestedShellQueue().get(0)).isServed());
					//System.out.println(this + " : " + MacroCommandShell.getNestedShellQueue().get(0));
					//System.out.println();  
					
					if (sid.equals(cshell.getWidgetId().getObjectId().toString()) && 
									(MacroCommandShell.getNestedShellQueue() == null || 
									MacroCommandShell.getNestedShellQueue().size() <= 0 || 
									(!((NestedShell)MacroCommandShell.getNestedShellQueue().get(0)).isServed() && this.equals(MacroCommandShell.getNestedShellQueue().get(0)))))
					{
						//System.out.println("REMOVED FILTER: " + cshell.getId());
						shell.getDisplay().removeFilter(SWT.Activate, this);
						this.nshell = shell;
						
						/* We need to start this in a separate thread.  MacroCommandShells should not be played in UI threads (otherwise wait commands
						 * will not work properly) */					
						this.setServed(true);
						new Thread(this).start();					
					}
				}
			}
			catch (Throwable t)
			{
				//System.out.println("REMOVED filter");
				/* Something unexpected has happened -- Remove this listener */
				e.display.removeFilter(SWT.Activate, this);
			}
		}

		public void setServed(boolean served) 
		{
			this.served = served;			
		}
		
		public boolean isServed()
		{
			return served;
		}

		public void run()
		{
			try
			{				
				cshell.playback(display, nshell, monitor);					
			} 
			catch (CoreException e)
			{
				synchronized (mutualGlobalLock)
				{
					interruptProcess = true;
					if (interruptedException == null)
						interruptedException = e;
				}
				
				synchronized (cshell.mutualLock)
				{
					cshell.mutualLock.notify();
				}
			}
		}

		public boolean isParent(MacroCommandShell macroCommandShell) 
		{
			return macroCommandShell.getParent().equals(cshell);			
		}
	}
	
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import org.eclipse.swt.widgets.*;
import org.eclipse.swt.widgets.Widget;

public class CommandTarget {
	private Widget widget;
	private Object context;
	
	public CommandTarget(Widget widget, Object context) {
		this.widget = widget;
		this.context = context;
	}

	public void ensureVisible() {
	}
	
	public Widget getWidget() {
		return widget;
	}
	public Object getContext() {
		return context;
	}
	public void setFocus() {
		ensureVisible();
		Display display = widget.getDisplay();
		if (widget instanceof Control) {
			Control c = (Control)widget;
			if (!c.equals(display.getFocusControl()))
				c.setFocus();
		}
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import org.eclipse.jface.window.Window;
import org.eclipse.swt.widgets.Widget;

public class WindowCommandTarget extends CommandTarget {
	/**
	 * @param widget
	 * @param context
	 */
	public WindowCommandTarget(Widget widget, Window window) {
		super(widget, window);
	}
	
	Window getWindow() {
		return (Window)getContext();
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.macro.CommandTarget#ensureVisible()
	 */
	public void ensureVisible() {
		Window window = getWindow();
		window.getShell().setActive();
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.Map;

import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.List;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableItem;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;

public class StructuredSelectionCommand extends AbstractStructuredCommand {

	private String type;
	
	public StructuredSelectionCommand(MacroCommandShell parent, String type) {
		super(parent);
		items = new ArrayList();
		this.type = type;
	}

	public boolean mergeEvent(Event e) throws Exception {
		if (e.detail == SWT.CHECK)
			return false;

		if (e.type == SWT.DefaultSelection) {
			this.type = DEFAULT_SELECT;
		}
		return super.mergeEvent(e);
	}

	public String getType() {
		return type;
	}

	public Object[] getItemsForEvent(Event event) {
		if (event.widget instanceof Tree) {
			return ((Tree) event.widget).getSelection();
		}
		else if (event.widget instanceof Table) {
			return ((Table) event.widget).getSelection();
		}
		else if (event.widget instanceof List) {
			return ((List) event.widget).getSelection();
		}
		return super.getItemsForEvent(event);
	}

	protected void playStructuredCommand(Widget widget, Object[] matches) {

		if (widget instanceof Tree)
			((Tree) widget).setSelection((TreeItem[]) matches);
		else if (widget instanceof Table)
			((Table) widget).setSelection((TableItem[]) matches);
		else if (widget instanceof List)
			((List) widget).setSelection((String[]) matches);

		fireEvent(widget,
			matches);
	}

	private void fireEvent(Widget widget, Object[] items) {
		Event e = new Event();
		e.widget = widget;
		e.type = type.equals(ITEM_SELECT)
			? SWT.Selection
			: SWT.DefaultSelection;
		e.item = (items.length > 0 && items instanceof Widget[]
			? (Widget) items[0]
			: null);
		widget.notifyListeners(e.type,
			e);
	}

	/**
	 * Overwrite this method in order to indicate that two item selection commands that have different items are not the same
	 */
	public boolean equals(Object obj) {
		if (!(obj instanceof ChoiceSelectionCommand) || !super.equals(obj))
			return false;

		StructuredSelectionCommand compareWithObj = (StructuredSelectionCommand) obj;
		if (compareWithObj.items.size() == this.items.size() && isSameList(compareWithObj.items,
			this.items))
			return true;

		return false;
	}

	private boolean isSameList(ArrayList listA, ArrayList listB) {
		if (listA.size() != listB.size())
			return false;

		for (int i = 0, listSize = listA.size(); i < listSize; i++) {
			Map itemDataA = (Map) listA.get(i);
			Map itemDataB = (Map) listB.get(i);

			if (itemDataA.size() != itemDataB.size())
				return false;

			for (Iterator keys = itemDataA.keySet().iterator(); keys.hasNext();) {
				Object currentKey = keys.next();
				if (!itemDataA.get(currentKey).equals(itemDataB.get(currentKey)))
					return false;
			}
		}

		return true;
	}

	protected void playStructuredCommandForFoundMatch(Widget widget, Object match) {
		/* Doesn't need to be implemented */
	}
			return true;
		
		return false;
	}

	private boolean isSameList(ArrayList listA, ArrayList listB) 
	{
		if (listA.size() != listB.size())
			return false;
		
		for (int i = 0, listSize = listA.size(); i < listSize; i++)
		{
			Map itemDataA = (Map)listA.get(i);
			Map itemDataB = (Map)listB.get(i);
			
			
			if (itemDataA.size() != itemDataB.size())
				return false;
			
			for(Iterator keys = itemDataA.keySet().iterator(); keys.hasNext();)
			{
				Object currentKey = keys.next();
				if (!itemDataA.get(currentKey).equals(itemDataB.get(currentKey)))
					return false;
			}
		}
		
		return true;
	}

	protected void playStructuredCommandForFoundMatch(Widget widget, Object match) 
	{
		/* Doesn't need to be implemented */
	}
}




/*******************************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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
 * $Id: KeyEventCommand.java,v 1.2 2006/10/27 14:39:12 amehregani Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.util.Hashtable;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Event;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.w3c.dom.Node;

/**
 * A concrete extension of PositionBasedCommand that is used to represent
 * SWT.KeyUp and SWT.KeyDown events.
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen (refactoring)
 */
public class KeyEventCommand extends PositionBasedCommand {

	private boolean isCharSet; /*
								 * Set when the character field of event is used
								 * as opposed to the keyCode
								 */

	public KeyEventCommand(MacroCommandShell parent) {
		super(parent);
	}

	public String getType() {
		return type;
	}

	public boolean mergeEvent(Event e) throws Exception {
		/*
		 * Defect #: 110726 -- Make the key events consistent with the mouse
		 * event and introduce a notion of key-press
		 */
		if (e.type == SWT.KeyUp && type != null && type.equals(KEY_DOWN)
				&& isCharSet(e) ? isCharSet && detail.intValue() == e.character
				: !isCharSet && detail.intValue() == e.keyCode) {

			type = KEY_PRESS;
			return true;
		}
		return false;
	}

	private boolean isCharSet(Event e) {
		return e.character > 0;
	}

	protected Integer determineDetail(Event e) {
		Integer detail = null;
		if (e.character > 0) {
			detail = new Integer(e.character);

		} else if (e.keyCode > 0) {
			detail = new Integer(e.keyCode);
		}
		return detail;
	}

	protected String determineType(Event e) {
		String type = null;
		if (e.type == SWT.KeyUp) {
			type = KEY_UP;
		} else if (e.type == SWT.KeyDown) {
			type = KEY_DOWN;
		}
		return type;
	}

	public void processEvent(Event e) throws Exception {
		super.processEvent(e);

		isCharSet = e.character > 0;
	}

	public void load(Node node, Hashtable lineTable) throws CoreException {
		super.load(node, lineTable);

		if (MacroConstants.TRUE_VALUE.equals(MacroUtil.getAttribute(node,
				"ischarset")))
			isCharSet = true;
	}

	public void write(int indent, StringBuffer sb, boolean close, boolean end) {
		super.write(indent, sb, false, false);
		MacroUtil.addAttribute(sb,
				new String[] { MacroConstants.IS_CHAR_SET_ATTRIBUTE },
				new String[] { String.valueOf(isCharSet) }, true, true);
	}

	public Event[] constructSWTEvents() {
		Event[] events;

		if (type.equals(KEY_PRESS))
			events = new Event[2];
		else
			events = new Event[1];

		Event keyUpEvent = new Event(), keyDownEvent = new Event();
		keyUpEvent.type = SWT.KeyUp;
		keyDownEvent.type = SWT.KeyDown;

		if (isCharSet) {
			keyUpEvent.character = (char) detail.intValue();
			keyDownEvent.character = (char) detail.intValue();
		} else {
			keyUpEvent.keyCode = detail.intValue();
			keyDownEvent.keyCode = detail.intValue();
		}

		if (type.equals(KEY_UP))
			events[0] = keyUpEvent;
		else if (type.equals(KEY_DOWN))
			events[0] = keyDownEvent;
		else if (type.equals(KEY_PRESS)) {
			events[0] = keyDownEvent;
			events[1] = keyUpEvent;
		}

		return events;
	}

	public boolean equals(Object obj) {
		if (!(obj instanceof KeyEventCommand))
			return false;

		KeyEventCommand keyEvent = (KeyEventCommand) obj;
		if (this.type.equals(keyEvent.getType())
				&& this.detail == keyEvent.getDetail())
			return true;
		return false;
	}

}
	public boolean equals (Object obj)
	{
		if (!(obj instanceof KeyEventCommand))
			return false;
		
		KeyEventCommand keyEvent = (KeyEventCommand)obj;
		if (this.type.equals(keyEvent.getType()) && this.button == keyEvent.getButton())
			return true;
		return false;
	}

	private int getButton() 
	{
		return button;
	}
	
	private boolean isCharSet()
	{
		return isCharSet;
	}

}




/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.core;

import java.util.LinkedList;
import java.util.Map;

import org.eclipse.core.runtime.CoreException;


/**
 * Represents a UI object such as a widget.
 * 
 * @author Ali Mehregani
 */
public interface IUIObject
{
	/**
	 * Returns the hierarchical relationshipt of this object relative to its parents.
	 * A linked list is returned whose first element is the child of the root UI object node and
	 * its last node is this UI object.  An object directly above a node is the parent of that
	 * node.
	 *  
	 * @return A linked list indicating the hierarchical relationship between this node and
	 * its parents.
	 */
	public LinkedList getHierarchicalRelation();

	
	/**
	 * Set the reference id of this object.
	 * 
	 * @param referenceId The reference id
	 */
	public void setReferenceId(String referenceId);
	
	
	/**
	 * Return the reference id of this object
	 * 
	 * @return reference id
	 */
	public String getReferenceId();

	
	/**
	 * Sets the context id of this object
	 * 
	 * @param contextId The context id of this object
	 */
	public void setContextId(String contextId);
	
	
	/**
	 * Returns the context id of this object
	 * 
	 * @return The context id
	 */
	public String getContextId();

	
	/**
	 * Sets the id of this object.  This is the id used by the playback operations to
	 * identify the UI object.
	 * 
	 * @param id The id of this UI object
	 */
	public void setObjectId(String objectId);
	
	
	/**
	 * Returns the id of this object.  This is the id used by the playback operations to
	 * identify the UI object.
	 * 
	 * @return object id
	 */
	public String getObjectId();

	
	/**
	 * Returns the descriptive field of this object.  The descriptive field is human readable
	 * label that is used to easily recognize the object.
	 * 
	 * @param descriptive field
	 */
	public void setDescriptive(String descriptive);

	
	/**
	 * Returns the descriptive field of this object.  The descriptive field is human readable
	 * label that is used to easily recognize the object.
	 * 
	 * @return descriptive field
	 */
	public String getDescriptive();
	
	
	/**
	 * Add a property to this UI object.
	 * 
	 * @param name The name of the property 
	 * @param value The value of the property
	 */
	public void addProperty (String name, String value);

	
	/**
	 * Returns the property of this object
	 * 
	 * @param name The name of the property.
	 * @return The value of the property with the name passed in.  null is returned if the
	 * property can't be found.
	 */
	public String getProperty (String name);
	
	
	/**
	 * Returns the properties of this UI object.
	 * 
	 * @return The properties of this UI object
	 */
	public Map getProperties ();
	
	
	/**
	 * Set the parent of this UI object 
	 * 
	 * @param parent The parent
	 */
	public void setParent(IUIObject parent);
	
	
	/**
	 * Returns the parent of this UI object
	 * 
	 * @return The parent
	 */
	public IUIObject getParent();


	/**
	 * Sets the resolver id for this object.
	 * 
	 * @param resolverId The resolver id.
	 */
	public void setResolver(String resolverId);
	
	
	/**
	 * Returns the resolver id that has resolved this object 
	 * 
	 * @return A resolver id
	 */
	public String getResolverId();
	
	
	/**
	 * Returns the number of children that this UI object has
	 * 
	 * @return the number of children of this object
	 */
	public int childCount();
	
	
	/**
	 * Returns the children of this UI object
	 * 
	 * @return The children of this UI object
	 */
	public IUIObject[] getChildren();
	
	
	/**
	 * Adds a child to this object.  Has no effects if child is already
	 * part of this object's children
	 * 
	 * @param child The child to add
	 * @throws CoreException In case of any unexpected error
	 */
	public void addChild(IUIObject child) throws CoreException;
	
	
	/**
	 * Removes a  child from this object
	 * 
	 * @param child The child to remove
	 * @return The child removed
	 */
	public IUIObject removeChild(IUIObject child);
	
	
	/**
	 * Returns the data associated with this object.
	 * 
	 * @return The associated data
	 */
	public Object getData();
	
	
	/**
	 * Can be used to associate a general data object with this object.
	 * 
	 * @param data The data
	 */
	public void setData(Object data);
	
	
	/**
	 * Returns the child with a matching reference id passed in; null if none is found
	 * 
	 * @param referenceId The reference id of the child
	 * @return A IUIObject with a matching referenceId or null if none is found.
	 */
	public IUIObject findChild(String referenceId);
	
}






/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.core;

import java.util.Hashtable;

import org.eclipse.core.runtime.CoreException;
import org.w3c.dom.Node;


/**
 * Represents a macro instruction.  The instruction is expected to  
 * both be writable and playable.  
 * 
 * @author Ali Mehregani
 */
public interface IMacroInstruction extends IWritable, IPlayable
{
	/**
	 * Invoked to load the macro instruction based on its corresponding
	 * XML node.
	 * 
	 * @param node The XML node representing this macro instruction
	 * @param lineTable Contains line level information
	 * 
	 * @throws CoreException In case of an unexpected error
	 */
	public void load(Node node, Hashtable lineTable) throws CoreException;
	
	
	/**
	 * Returns the corresponding widget id of this instruction
	 *  
	 * @return The widget id
	 */
	public WidgetIdentifier getWidgetId();
		
	
	/**
	 * Sets the widget identifier for this macro instruction
	 *  
	 * @return widgetIdentifier The widget identifier
	 */
	public void setWidgetId(WidgetIdentifier widgetIdentifier);
	
	
	/**
	 * Returns the corresponding IUIObject of this macro instruction.
	 * If an object is not supported then null will be returned.
	 * 
	 * @return The corresponding object of this instruction
	 */
	public IUIObject getCorrespondingObject();
	
	
	/**
	 * Sets the UI object for this macro instruction.
	 * 
	 * @param uiObject The corresponding object
	 */
	public void setCorrespondingObject(IUIObject uiObject);
	
	
	/**
	 * Returns the starting line number of this macro instruction in the
	 * macro script that it belongs to.
	 * 
	 * @return The starting line
	 */
	public int getStartLine();
	
		
	/**
	 * Returns the last line number of this macro instruction in the
	 * macro script that it belongs to.
	 * 
	 * @return The last line
	 */
	public int getStopLine();
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.core;


/**
 * A writable object is capable of serializing itself to string and writing the string
 * version to a PrintWriter that is passed to parameters to the methods that are described
 * below.
 * <br/>
 * The ideal order of the method invocations are:
 * <ul>
 * 	<li> writeStart(String indent, gPrintWriter writer) </li>
 * 	<li> write(String indent, PrintWriter writer) </li>
 * 	<li> writeFinish(String indent, PrintWriter writer) </li>
 * </ul>
 */
public interface IWritable 
{
	/**
	 * Invoked at start of the write of a writable object
	 * 
	 * @param indent The indents
	 * @param sb The buffer that the string serialization should be written to
	 */
	public void writeStart(int indent, StringBuffer sb);
	
	
	/**
	 * Invoked after writeStart
	 * 
	 * @param indent The indents
	 * @param sb The buffer that the string serialization should be written to
	 */
	public void write(int indent, StringBuffer sb);
	
	
	/**
	 * Invoked in the end of the write of a writable object
	 * 
	 * @param indent The indents
	 * @param sb The buffer that the string serialization should be written to
	 */
	public void writeFinish(int indent, StringBuffer sb);
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.core;

import org.eclipse.core.runtime.*;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.swt.widgets.*;
import org.eclipse.swt.widgets.Composite;

public interface IPlayable {
	boolean playback(Display display, Composite parent, IProgressMonitor monitor) throws CoreException;
}




/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.core;

import java.util.Hashtable;
import java.util.Vector;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.Platform;

/**
 * Represents each widgetResolver element that appears under a widgetResolver
 * extension
 * 
 * @author Ali Mehregani
 * @deprecated
 */
public class WidgetResolverLoader {
	private static final String EXTENSION_POINT = "widgetResolver";

	/** The id of the widget resolver */
	private String id;

	/** The widget resolver class */
	private IWidgetResolver widgetResolver;

	/** The priority of this widget resolver registeration */
	private int priority;

	/* Keeps an ordered list of the resolver ids */
	private static String[] resolverIds;

	/*
	 * The widget resolver: KEY = resolver id VALUE = A class of type
	 * WidgetResolverLoader
	 */
	private static Hashtable widgetResolvers = new Hashtable();

	/**
	 * Limit the visibility of the constructor
	 */
	private WidgetResolverLoader(String id, IWidgetResolver resolver,
			int priority) {
		this.id = id;
		this.widgetResolver = resolver;
		this.priority = priority;
	}

	/**
	 * Constructs an instance of this class based on the configuration element
	 * passed in
	 * 
	 * @param confiugrationElement
	 *            The configuration element to be loaded
	 * @return An instance of this class based on the configuration element
	 *         passed in. null will be returned if there is an error loading the
	 *         configuration element.
	 */
	public static WidgetResolverLoader constructInstance(
			IConfigurationElement configuraitonElement) {
		if (!EXTENSION_POINT.equals(configuraitonElement.getName()))
			return null;

		try {
			String id = configuraitonElement.getAttribute("id");
			IWidgetResolver widgetResolver = (IWidgetResolver) configuraitonElement
					.createExecutableExtension("class");
			int priority = Integer.parseInt(configuraitonElement
					.getAttribute("priority"));

			if (id == null || widgetResolver == null)
				return null;

			return new WidgetResolverLoader(id, widgetResolver, priority);

		} catch (CoreException e) {
		}

		return null;
	}

	/**
	 * @return the id
	 */
	public String getId() {
		return id;
	}

	/**
	 * @return the priority
	 */
	public int getPriority() {
		return priority;
	}

	/**
	 * @return the widgetResolver
	 */
	public IWidgetResolver getWidgetResolver() {
		return widgetResolver;
	}

	public static WidgetResolverLoader[] getWidgetResolverLoaders() {
		if (resolverIds == null) {
			loadWidgetResolvers();
		}

		WidgetResolverLoader[] resolvers = new WidgetResolverLoader[resolverIds.length];
		for (int i = 0; i < resolverIds.length; i++) {
			resolvers[i] = ((WidgetResolverLoader) widgetResolvers
					.get(resolverIds[i]));
		}
		return resolvers;
	}

	private static void loadWidgetResolvers() {
		IConfigurationElement[] elements = Platform.getExtensionRegistry()
				.getConfigurationElementsFor(
						"org.eclipse.tptp.test.auto.gui.widgetResolver");
		Vector tempContainer = new Vector(elements.length);

		for (int i = 0; i < elements.length; i++) {
			WidgetResolverLoader widgetResolverLoader = WidgetResolverLoader
					.constructInstance(elements[i]);
			if (widgetResolverLoader != null) {
				tempContainer.add(findIndex(widgetResolverLoader.getPriority(),
						tempContainer), widgetResolverLoader);
				widgetResolvers.put(widgetResolverLoader.getId(),
						widgetResolverLoader);
			}
		}

		resolverIds = new String[tempContainer.size()];
		for (int i = 0; i < resolverIds.length; i++) {
			resolverIds[i] = ((WidgetResolverLoader) tempContainer.get(i))
					.getId();
		}
	}

	private static int findIndex(int desiredPriority, Vector container,
			int startIntervalInx, int endIntervalInx, int length) {
		if (startIntervalInx == endIntervalInx
				|| startIntervalInx == endIntervalInx - 1) {
			if (length > 0) {
				WidgetResolverLoader widgetResolverReg = (WidgetResolverLoader) container
						.get(startIntervalInx);
				int priority = widgetResolverReg.getPriority();
				if (desiredPriority < priority)
					return startIntervalInx;
			}
			return endIntervalInx;
		}

		/* What's in the middle? */
		int middleInx = startIntervalInx
				+ (int) Math.ceil((endIntervalInx - startIntervalInx) / 2);
		WidgetResolverLoader widgetResolverReg = (WidgetResolverLoader) container
				.get(middleInx);
		int middleElementPriority = widgetResolverReg.getPriority();

		if (middleElementPriority > desiredPriority)
			endIntervalInx = middleInx;
		else if (middleElementPriority < desiredPriority)
			startIntervalInx = middleInx;
		else
			return middleInx;
		return findIndex(desiredPriority, container, startIntervalInx,
				endIntervalInx, length);
	}

	private static int findIndex(int priority, Vector container) {
		int length = container.size();
		return findIndex(priority, container, 0, length, length);
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.core;

import org.eclipse.swt.widgets.Widget;

/**
 * This interface is registered using extension point
 * <code>org.eclipse.tptp.test.auto.gui.widgetResolver</code> which is expected
 * to return a unique identifier from a provided widget. The identifier must be
 * reproducable between sessions so that it can be used to locate the widget on
 * playback.
 * 
 * @since 3.1
 * @deprecated
 */
public interface IWidgetResolver {
	/**
	 * Returns a unique identifier for the provided widget.
	 * 
	 * @param widget
	 *            The parent object. The value of this parameter can be null if
	 *            the parent of object cannot be resolved.
	 * @param object
	 *            The object whose id is suppose to be resolved. The type of
	 *            this object is <b>usually</b> a widget, but it can also be a
	 *            <code>java.lang.String</code> or any other arbitrary type
	 *            depending on the implementation of the widget. For example,
	 *            when attempting to resolve a combo box item, parent will point
	 *            to the combo box and object will point to a
	 *            <code>java.lang.String</code> item representing the item
	 *            selected.
	 * 
	 * @return unique identifier that can be used to locate the widget or
	 *         <code>null</code> if none can be found.
	 */
	public IWidgetId getUniqueId(Widget parent, Object object);

	/**
	 * Given an object and an id, this method should return true if and only if
	 * the id of object as determined by this resolver equals the 'id' passed
	 * in.
	 * 
	 * @param object
	 *            An object
	 * @param id
	 *            The being searched for
	 * @return true iff object's id is equalled to 'id'
	 */
	public boolean foundWidget(Object object, Object id);
}




/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.core;

import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.tptp.test.auto.gui.internal.macro.ObjectMine.IDCollisionException;
import org.eclipse.tptp.test.auto.gui.internal.macro.ObjectMine.UIObjectNotFound;
import org.w3c.dom.Node;


/**
 * Represents an object mine that belongs to a particular test suite.  The mine
 * keeps track of the objects that the test cases depends on.  Object mines
 * can be shared among multiple test suites, allowing users to centralize the objects
 * identified by test cases spanning multiple test suites.  The output source of an object 
 * mine can be different from the test suite that owns the mine.  
 * 
 * <p>
 * The inclusion and output source options introduce some ambiguities in registering a new 
 * object with an object mine.  The general contract when registering a new object is outlined below.
 * </p>
 * 
 * <p>
 * 	Assume object mine om1 includes om2 and outputs to om3:
 * </p>
 *    
 * <ul>
 * 	<li> If object o is infant, then it is registered with om3 </li>
 *  <li> If object o has a parent that belongs to om1, then it is registered with om1 </li>
 * 	<li> If object o has a parent that belongs to om2, then it is registered with om2 </li>
 *  <li> If object o has a parent that belongs to om3, then it is registered with om3 </li>
 * </ul>
 * 
 * Changing the output source of an object mine to an alternative test suite does not guarantee
 * that new objects will be written to the set test suite's object mine.
 * 
 * @author Ali Mehregani
 */
public interface IObjectMine 
{

	/**
	 * The test suite that owns this object mine.  The owner and the output source
	 * can be different.
	 * 
	 * @return The owner
	 */
	public ITestSuite getOwner();
	
	
	/**
	 * Sets the owner of this test suite.  The owner and the output source
	 * can be different.
	 * 
	 * @param testSuite The owner
	 */
	public void setOwner(ITestSuite testSuite);
	
	
	/**
	 * Set the output source to the object mine that is passed in.  If
	 * the user uses the test suite that is the owner of this mine to
	 * record a test case that results in finding a new object, then the
	 * object will be contributed to the object mine of the output source, not
	 * the owner of this object mine (some exceptions apply - see class comment).
	 * 
	 * @param objectMine The object mine that will act as the output source
	 * for this mine 
	 */
	public void setOutputSource(IObjectMine objectMine);

	
	/**
	 * Returns the output of this object mine
	 * 
	 * @return The output source
	 */
	public IObjectMine getOutputSource();
	
	
	/**
	 * Includes another object mine as part of this mine.  The lookup method for
	 * an object is required to walk through the registered objects of this object
	 * mine and the registered objects of included object mines.
	 * 
	 * @param objectMine The object mine to include
	 */
	public void addInclude(IObjectMine objectMine);

	
	/**
	 * Returns the external object mines that have been added to this 
	 * object mine
	 * 
	 * @return The added external object mines
	 */
	public List getIncludes();
	
	
	/**
	 * Looks up the UI object with the reference id passed in.  null should be 
	 * returned if the objct can't be found.  Time complexity = T(h) = h (where h is the height of the 
	 * object mine tree)
	 * 
	 * @param parent The parent of the object
	 * @param referenceId The reference id of the object
	 * 
	 * @return The object with the reference id passed in; or null if none is found.
	 * 
	 * @throws UIObjectNotFound If the parent object is not found
	 */
	public IUIObject lookupUIObject(IUIObject parent, String referenceId);
	
	
	/**
	 * Looks up the UI object based on the context id and the object id that is passed in.  This
	 * lookup operation is more expensive than lookup(parent, referenceId).  The latter should be
	 * used where possible.  Time complexity = T(h, n) = h + n (where h is the height of the 
	 * object mine tree and n is the number of nodes owned by the parent node)
	 * 
	 * @param parent The parent of the object
	 * @param contextId The context id of the object
	 * @param objectId The object id of the object
	 * 
	 * @return The object with the matching context and object id; or null if none is found.
	 * 
	 * @throws UIObjectNotFound If the parent object is not found
	 */
	public IUIObject lookupUIObject(IUIObject parent, String contextId, String objectId);
	
	
	/**
	 * Returns the direct children of the root object that this object mine points to
	 * 
	 * @return The children of the root object 
	 */
	public IUIObject[] getChildren();

	
	/**
	 * Register the object embedded in the node passed in.  The parent of the
	 * registered object should be set to the parent argument.  If the object is already
	 * registered, then this method will not have any effects.
	 * 
	 * @param parent The parent of the object to be registered
	 * @param node The node containing the object information to be registered
	 * 
	 * @return The object that gets registered.
	 * 
	 * @throws IDCollisionException If there is a reference id collision
	 * @throws UIObjectNotFound If the parent object is not found
	 * @throws CoreException Wraps any unexpected error 
	 */
	public IUIObject registerObject(IUIObject parent, Node currentNode) throws IDCollisionException, UIObjectNotFound, CoreException;


	/**
	 * Registers uiObject under the parent object passed in.  If the object is already
	 * registered, then this method will not have any effects.
	 * 
	 * @param uiObject The object to be registered
	 * @return The object that gets registered (i.e. uiObject).
	 * 
	 * @throws IDCollisionException If there is a reference id collision
	 * @throws UIObjectNotFound If the parent object of uiObject is not found
	 * @throws CoreException Wraps any unexpected error 
	 */
	public IUIObject registerObject(IUIObject uiObject) throws IDCollisionException, UIObjectNotFound, CoreException;
	
	
	/**
	 * Serializes this object mine to a string representation that can be stored
	 * and retrieved for later use.  This is often the result of <code>serializeHeaderToString()</code>
	 * appended to the result of <code>serializeObjetsToString()</code>.
	 * 
	 * @return The string representation of this object mine
	 */
	public String serializeToString();
	
	
	/**
	 * Serializes only the header of this object mine to a string representation that
	 * can be stored and retrieved for later use.
	 * 
	 * @return The string representation of the header of this object mine
	 */
	public String serializeHeaderToString();
	
	
	/**
	 * Serializes only the objects of this object mine to a string representation that
	 * can be stored and retrieved for later use.
	 * 
	 * @return The string representation of the object directly owned by this object mine
	 */
	public String serializeObjetsToString();
	
	
	/**
	 * Sets the active object of this object mine.  This is commonly used to determine the active
	 * object corresponding to the active shell.
	 * 
	 * @param activeObject The active object.
	 */
	public void setActiveObject(IUIObject activeObject);
	
	
	/**
	 * Returns the active object of this object mine.  This is commonly used to determine the active
	 * object corresponding to the active shell.
	 * 
	 * @return The active object.
	 */	
	public IUIObject getActiveObject();


	/**
	 * Returns the next available unique reference id that can be used.  The id's returned will be an
	 * integer even though the type is set to String.
	 * 
	 * @return The next available reference id.
	 */
	public String getUniqueReferenceId();
	
	
	/**
	 * Returns the roo object
	 * 
	 * @return The root object
	 */
	public IUIObject getRoot();

}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.core;

public interface IRecorderListener {
	int STOP = 1;
	int INDEX = 2;
	void recordingStarted();
	void recordingStopped();
/**
 * Called when the user pressed Ctrl+Shift+F10 (index)
 * or Ctrl+Shift+F11 (stop) to interrupt
 * the recording process. Clients may use this event
 * to insert named indexes, stop the recording etc.
 * @param type <code>STOP</code> or <code>INDEX</code>
 */
	void recordingInterrupted(int type);
}




/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.core;


/**
 * A widget resolver is expected to return a class that implements this interface
 * when the id of a passed widget is successfully resolved.  <b> **Note:</b> In addition to 
 * the methods of this interface, a contributor is also expected to implement {@link java.lang.Object#equals(Object)} 
 * and {@link java.lang.Object#toString()}.
 * 
 * @since 4.3
 * @deprecated 
 * @author Ali Mehregani
 */
public interface IWidgetId
{
	/**
	 * Returns the id of the widget resolver that resolved this widget id.
	 * 
	 * @return The id of the widget resolver that generated this widget id
	 */
	public String getResolverId ();
	
	
	/**
	 * Sets the id of the widget resolver that generated this widget
	 * id.
	 *
	 * @param resolverId The id of the widget resolver
	 */
	public void setResolverId(String resolverId);
}




/*******************************************************************************
 * Copyright (c) 2005, 2006 IBM Corporation 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
 * $Id: VerificationMetaData.java,v 1.2 2006/10/27 14:39:10 amehregani Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.core;


/**
 * A container class for the data that the verificaiton command will need 
 * 
 * @author Ali Mehregani
 */
public class VerificationMetaData
{
	/* The possible types */
	public static final byte EDITOR 	= 0x01;
	public static final byte VIEW 		= 0x02;
	public static final byte SHELL		= 0x03;
	
	
	/* The context id is the id of the editor, viewer, etc... that will be used to retrieve it */
	private String contextId;
	
	/* The location is the plugin that contains the hook source code */
	private String location;
	
	/* The resource is the class name containing the hook */
	private String resource;
	
	/* The hook is the method name representing the verification point */
	private String hook;
	
	/* The focus type indicates whether the type of context being retrieved */ 
	private byte focusType;

	public VerificationMetaData()
	{
		focusType = -1;
	}
			
	public String getContextId()
	{
		return contextId;
	}

	public void setContextId(String contextId)
	{
		this.contextId = contextId;
	}

	public byte getFocusType()
	{
		return focusType;
	}

	public void setFocusType(byte focusType)
	{
		this.focusType = focusType;
	}

	public String getHook()
	{
		return hook;
	}

	public void setHook(String hook)
	{
		this.hook = hook;
	}

	public String getLocation()
	{
		return location;
	}

	public void setLocation(String location)
	{
		this.location = location;
	}

	public String getResource()
	{
		return resource;
	}

	public void setResource(String resource)
	{
		this.resource = resource;
	}
	
	public boolean isComplete()
	{
		return contextId != null && location != null &&  resource != null && hook != null && focusType != -1; 
	}
	
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.core;

import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;


/**
 * Used as an identifier for widgets.  At a minimum, a context id and a widget id
 * is required as part of a widget identifier.
 * 
 * @author Ali Mehregani
 */
public class WidgetIdentifier
{
	/** A null identifier */
	public static final WidgetIdentifier NULL_IDENTIFIER = new WidgetIdentifier(new Path(""), new Path(""), null);
	
	/** The context id */
	private IPath contextId;

	/** The widget id */
	private IPath objectId;

	/** The id that is used to reference this widget in the object mine */
	private String referenceId;
	
	/** The resolver id that resovled this widget */
	private String resolverId;
	
	
	/**
	 * Constructor 
	 * 
	 * @param contextId The context id
	 * @param widgetId The widget id
	 */
	public WidgetIdentifier(IPath contextId, IPath widgetId, String resolverId)
	{
		this.contextId = contextId;
		this.objectId = widgetId;
		this.resolverId = resolverId;
	}

	
	/**
	 * Returns the fully qualified path of this widget id.  The fully qualified
	 * path is the context id/path appended with the widget path/id.
	 *  
	 * @return The fully qualified path of this identifier.
	 */
	public IPath getFullyQualifiedPath()
	{
		return contextId.append(objectId);
	}

	
	/**
	 * Equivalent to getFullyQualifiedPath().toString().
	 * 
	 * @return The fully qualified id
	 */
	public String getFullyQualifiedId()
	{
		return getFullyQualifiedPath().toString();
	}

	
	/**
	 * An object in question is equalled to this object iff the object is of the same type and
	 * the context and the widget ids are the same.
	 * 
	 * @param object The object in question
	 * 
	 * @return A boolean indicating whether object is equalled to this object or not.
	 */
	public boolean equals(Object object)
	{
		if (object == null)
			return false;
		if (object == this)
			return true;
		if (object instanceof WidgetIdentifier)
		{
			WidgetIdentifier wid = (WidgetIdentifier) object;
			return wid.contextId.equals(contextId) && wid.objectId.equals(objectId);
		}
		return false;
	}


	/**
	 * Returns the context id of this identifier
	 * 
	 * @return The context id
	 */
	public IPath getContextId()
	{
		return contextId;
	}
	
	

	/**
	 * @param contextId the contextId to set
	 */
	public void setContextId(IPath contextId)
	{
		this.contextId = contextId;
	}


	/**
	 * Returns the widget id of this identifier
	 * 
	 * @return The widget id
	 */
	public IPath getObjectId()
	{
		return objectId;
	}
	
	
	/**
	 * @param objectId the objectId to set
	 */
	public void setObjectId(IPath objectId)
	{
		this.objectId = objectId;
	}


	/**
	 * @return the referenceId
	 */
	public String getReferenceId()
	{
		return referenceId;
	}


	/**
	 * @param referenceId the referenceId to set
	 */
	public void setReferenceId(String referenceId)
	{
		this.referenceId = referenceId;
	}


	/**
	 * @return the resolverId
	 */
	public String getResolverId()
	{
		return resolverId;
	}


	/**
	 * @param resolverId the resolverId to set
	 */
	public void setResolverId(String resolverId)
	{
		this.resolverId = resolverId;
	}
	
}




/*******************************************************************************
 * Copyright (c) 2005, 2006 IBM Corporation 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
 * $Id: VerifHookClassLoader.java,v 1.2 2006/07/14 23:17:02 amehregani Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.core;

import java.net.URL;
import java.net.URLClassLoader;
import java.util.Vector;

import org.eclipse.core.runtime.Platform;
import org.eclipse.osgi.util.NLS;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;

/**
 * A custom class loader that is used to resolve a class that the verificaiton hook is in along
 * with any other classes that are imported by the verification class.
 * 
 * @author Ali Mehregani
 */
public class VerifHookClassLoader extends URLClassLoader
{
	/* The plugins that the verification plugin requires */
	private Vector reqPluginNames;
	
	public VerifHookClassLoader (URL[] urls, ClassLoader parent, Vector requiredPluginNames)
	{
		super (urls, parent);		
		reqPluginNames = requiredPluginNames;
	}
	
   
	/**
	 * Invoked when a class can't be resolved by the upper level class loaders associated with
	 * this class.
	 */
	protected Class findClass(final String name) 
	 throws ClassNotFoundException 			 
    {  	
		
    	/* Try and walk through the required plugins of the plugin
    	 * containing the test suite */
    	try
    	{			
    		Class classFile = loadFromReqPlugins(name, 0);
    		if (classFile != null)
    			return classFile;
    	}
    	catch (Throwable t)
    	{
    		/* Doesn't need to be handled */
    	}
    	
		
		try
		{
			Class classFile = super.findClass(name);
			if (classFile != null)
				return classFile;
		}
		catch (Throwable t)
		{
			/* Doesn't need to be handled */
		}
		
	    		    	
    	
    	throw new ClassNotFoundException (NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_VER_CLASS_NOT_FS, name));
    }


	/**
	 * Attempt to load the class from the required plugins.
	 * 
	 * @param name
	 * @param inx
	 * @return
	 */
	private Class loadFromReqPlugins(String name, int inx)
	{
		try
		{
			if (reqPluginNames == null || inx >= reqPluginNames.size())
				return null;
			
			Class classFile = Platform.getBundle(((String)reqPluginNames.get(inx))).loadClass(name);				
			if (classFile != null)
				return classFile;
		}
		catch (Throwable t)
		{
			/* Handled by next statement */
		}
		
		return loadFromReqPlugins(name, inx + 1);
	}
}




############################################################################### 
# Copyright (c) 2005, 2008 IBM Corporation 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
# $Id: plugin.properties,v 1.11 2008/04/16 14:58:24 jkubasta Exp $ 
# 
# Contributors: 
# IBM Corporation - initial API and implementation 
############################################################################### 
#
# plugin.properties
#
# This property file ONLY contains messages for the this plug-in's MANIFEST.MF and plugin.xml files.
#
# NOTE:  When using substitution parameters, all single quote characters (e.g. ') must be escaped with a preceding single quote character (e.g. ''text in single quotes'').
#
# NLS_MESSAGEFORMAT_VAR
# NLS_ENCODING=UTF-8

pluginName   = TPTP Automated GUI Recorder (AGR)
providerName = Eclipse.org


TST_SUITE_AUTO_GUI_NAME 		= TPTP Automated GUI Test
TST_SUITE_AUTO_GUI_DESC 		= Use this suite to create Automated GUI test cases in the Eclipse platform
TST_CASE_AUTO_GUI_NAME			= TPTP Automated GUI Test Case
TST_CASE_AUTO_GUI_DESC			= Test Case which can store events recorded on the UI and be used to play them back
widgetResolver = Widget Resolver Extension (Deprecated)
uiObjectResolverDelegate = UI Object Resolver Delegate Extension
macroCommandFactory = MacroCommandFactory Replacement Extension

Lines 14-19 Link Here

(-)plugin.xml (+2 lines)
14	-->	14	-->
15	<?eclipse version="3.0"?>	15	<?eclipse version="3.0"?>
16	<plugin>	16	<plugin>
		17	<extension-point id="uiObjectResolverDelegate" name="%uiObjectResolverDelegate" schema="schema/uiObjectResolverDelegate.exsd"/>
		18	<extension-point id="macroCommandFactory" name="%macroCommandFactory" schema="schema/macroCommandFactory.exsd"/>
17	<extension-point id="widgetResolver" name="%widgetResolver" schema="schema/widgetResolver.exsd"/>	19	<extension-point id="widgetResolver" name="%widgetResolver" schema="schema/widgetResolver.exsd"/>
18	<extension	20	<extension
19	point="org.eclipse.hyades.ui.typeDescriptions">	21	point="org.eclipse.hyades.ui.typeDescriptions">




<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
	<name>Copy of org.eclipse.tptp.test.auto.gui</name>
	<comment></comment>
	<projects>
	</projects>
	<buildSpec>
		<buildCommand>
			<name>org.eclipse.emf.codegen.JETBuilder</name>
			<arguments>
			</arguments>
		</buildCommand>
		<buildCommand>
			<name>org.eclipse.jdt.core.javabuilder</name>
			<arguments>
			</arguments>
		</buildCommand>
		<buildCommand>
			<name>org.eclipse.pde.ManifestBuilder</name>
			<arguments>
			</arguments>
		</buildCommand>
		<buildCommand>
			<name>org.eclipse.pde.SchemaBuilder</name>
			<arguments>
			</arguments>
		</buildCommand>
	</buildSpec>
	<natures>
		<nature>org.eclipse.emf.codegen.jet.IJETNature</nature>
		<nature>org.eclipse.pde.PluginNature</nature>
		<nature>org.eclipse.jdt.core.javanature</nature>
	</natures>
</projectDescription>




/**********************************************************************
 * Copyright (c) 2007, 2009 IBM Corporation 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: 
 * IBM Corporation - initial API and implementation
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.codegen;

import org.eclipse.hyades.test.tools.core.internal.common.codegen.Helper;




/**********************************************************************
 * Copyright (c) 2007, 2009 IBM Corporation 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: 
 * IBM Corporation - initial API and implementation
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.codegen;

import java.util.HashSet;




/**********************************************************************
 * Copyright (c) 2007, 2009 IBM Corporation 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: 
 * IBM Corporation - initial API and implementation
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.codegen;

import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;




/**********************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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
 * $Id: AutoGUIGenerator.java,v 1.9 2007/04/19 12:28:03 paules Exp $
 * 
 * Contributors: 
 * IBM - Initial API and implementation
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.codegen;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.SubProgressMonitor;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.hyades.test.core.internal.changes.CreateFileChange;
import org.eclipse.hyades.test.tools.core.internal.common.codegen.AutomaticDependencyUpdater;
import org.eclipse.hyades.test.tools.core.internal.common.codegen.Helper;
import org.eclipse.hyades.test.tools.core.internal.common.codegen.IProjectDependencyUpdater;
import org.eclipse.hyades.test.tools.core.internal.common.codegen.ImportManager;
import org.eclipse.hyades.test.tools.core.internal.common.codegen.JavaGenerator;
import org.eclipse.hyades.test.tools.core.internal.java.codegen.JUnitGenerator.JUnitProjectDependencyUpdater;
import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IMethod;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.ltk.core.refactoring.Change;
import org.eclipse.ltk.core.refactoring.NullChange;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;


/**
 * The code generator for auto gui test suites 
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen
 */
public class AutoGUIGenerator extends JavaGenerator
{
	private String superclassName;
	private String testCaseName, testCaseDescription;
	
	public AutoGUIGenerator (ITestSuite testSuite, String superClass)
	{
		super (testSuite, new AutoGUIProjectDependencyUpdater(new AutomaticDependencyUpdater(), !testSuite.getImplementor().isExternalImplementor()));
		this.superclassName = superClass;
	}
	
	public void setInput (String testCaseName, String testCaseDescription)
	{
		this.testCaseName = testCaseName;
		this.testCaseDescription = testCaseDescription;
	}
	
	protected Change createGenerateCodeChange(IFile file, IProgressMonitor monitor) throws CoreException {
		String code = generateCode(monitor);
		return new CreateFileChange(file, code, CHARSET_UTF8);
	}

	/**
	 * @see org.eclipse.hyades.test.common.internal.codegen.Generator#generateFile(org.eclipse.hyades.models.common.facades.behavioral.ITestSuite, org.eclipse.core.resources.IFile, org.eclipse.core.runtime.IProgressMonitor)
	 */
	private String generateCode(IProgressMonitor monitor)
	throws CoreException
	{
		CodeGeneratorHelper helper = new CodeGeneratorHelper();
		if (this.superclassName != null) 
		{
			helper.setSuperclassName(this.superclassName);
		}
		computeTestMethodNames(getTestSuite(), getTestSuite().getImplementor().isExternalImplementor(), helper);
		VerificationHookClassGenerator generator = new VerificationHookClassGenerator();
		return Helper.formatContent(generator.generate(getTestSuite(), helper));
	}
	
	protected Change createSourceUpdateChange(IFile file, SubProgressMonitor monitor) throws CoreException {
		return new NullChange();
	}

	/**
	 * Creates a method with name = "methodName" and argument = "argument".  
	 * <br/>
	 * Pre-condition(s):
	 * <ul>
	 * 	<li> Argument must either be org.eclipse.ui.IEditorPart or org.eclipse.ui.IViewPart. </li>
	 *  <li> methodName must be valid by the following standard:
	 *  	<ul>
	 *  		<li> Must begin with an alphabet </li>
	 *  		<li> Does not contain any special characters other than '$' '_'</li>
	 *  		<li> Must be less than 100 characters long </li>
	 *  	</ul>
	 *  </li> 	
	 * </ul>
	 * 
	 * @param testSuite The test suite
	 * @param methodName The name of the method to be created
	 * @param argument The argument of the method (see restriction above)
	 * @throws Exception 
	 */
	public void createMethod (String methodName, String[] arguments) throws Exception
	{
		IFile javaFile = getFileHandle(getTestSuite());
		ICompilationUnit cu = JavaCore.createCompilationUnitFrom(javaFile);
		IType mainClass = cu.findPrimaryType();
		
		/* The class is missing */
		if (mainClass == null)
		{
			createChange(new NullProgressMonitor()).perform(new NullProgressMonitor());
			cu = JavaCore.createCompilationUnitFrom(javaFile);
			mainClass = cu.findPrimaryType();
		}
		
		
		cu.becomeWorkingCopy(null, new NullProgressMonitor());
		IMethod method = mainClass.getMethod(methodName, arguments);
		
		try
		{
			/* Create the method if it doesn't exist */
			if (cu != null && !method.exists())
			{
				Helper helper = new Helper();
				String packageName = helper.getPackageName(getTestSuite());
				helper.setImportManager(new ImportManager(packageName));
				method = createTestMethod(mainClass, testCaseName, testCaseDescription, helper, methodName, arguments);
				
				helper.emitSortedImports(cu);

				cu.commitWorkingCopy(/*force*/false, new NullProgressMonitor());
			}
		}
		finally
		{
			cu.discardWorkingCopy();
		}
	}

	/**
	 * Creates a test method for the specified test case.
	 */
	protected IMethod createTestMethod(IType mainClass, String testCaseName, String testCaseDescription, Helper helper, String methodName, String[] args) throws JavaModelException {
		VerificationHookMethodGenerator generator = new VerificationHookMethodGenerator();
		String content;
		content = generator.generate(testCaseName, testCaseDescription, helper, methodName, args);
		return mainClass.createMethod(content, null, /*force*/false, new NullProgressMonitor());
	}
	
	public static class AutoGUIProjectDependencyUpdater extends JUnitProjectDependencyUpdater {

		public AutoGUIProjectDependencyUpdater(IProjectDependencyUpdater delegate, boolean modelBehavioring) {
			super(delegate, modelBehavioring);
			addRequiredPlugin(GuiPlugin.getID(), "autogui.jar"); //$NON-NLS-1$
		}

	}

}

	




/**********************************************************************
 * Copyright (c) 2005, 2007 IBM Corporation 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
 * $Id: AutoGUILaunchGenerator.java,v 1.11 2007/05/02 19:35:57 paules Exp $
 * 
 * Contributors: 
 * IBM - Initial API and implementation
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.codegen;

import java.util.Hashtable;
import java.util.List;
import java.util.Vector;

import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;
import org.eclipse.hyades.datapool.iterator.DatapoolIteratorSequentialPrivate;
import org.eclipse.hyades.execution.runtime.datapool.IDatapool;
import org.eclipse.hyades.execution.runtime.datapool.IDatapoolCell;
import org.eclipse.hyades.execution.runtime.datapool.IDatapoolFactory;
import org.eclipse.hyades.execution.runtime.datapool.IDatapoolIterator;
import org.eclipse.hyades.execution.runtime.datapool.IDatapoolRecord;
import org.eclipse.hyades.models.common.datapool.impl.Common_DatapoolFactoryImpl;
import org.eclipse.hyades.models.common.facades.behavioral.ILoop;
import org.eclipse.hyades.models.common.facades.behavioral.IProperty;
import org.eclipse.hyades.models.common.facades.behavioral.ITestInvocation;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.hyades.models.common.facades.behavioral.IVariable;
import org.eclipse.hyades.models.common.facades.behavioral.impl.HyadesFactory;
import org.eclipse.hyades.test.tools.core.internal.common.codegen.Helper;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMineManager;


/**
 * The code generator for serializing test suites into XML. 
 * 
 * @author Ali Mehregani
 */
public class AutoGUILaunchGenerator
{
	
	public static String generateScript(ITestSuite testSuite, Vector reqPlugins)
	{
		/* Stores the linkage information */
		Hashtable properties = new Hashtable(); 		
		walkThroughActions(properties, testSuite.getImplementor().getBlock().getActions());
		
		addTestSuiteProperties(testSuite, properties);
		
		TestSuiteToXMLConvertor genTestSuite = new TestSuiteToXMLConvertor(testSuite, reqPlugins, properties);
		String script = genTestSuite.generate(testSuite, new Helper());
		
		String extraChars = "\t\t" + genTestSuite.NL;
		if(script.startsWith(extraChars))
			script = script.substring(extraChars.length());
		
		return script;
	}

	
	private static void addTestSuiteProperties(ITestSuite testSuite, Hashtable properties) 
	{
		Vector testSuiteProperties = new Vector();
		
		/* Add all properties */
		List variables = testSuite.getVariables();
		Vector exclusionList = new Vector();
		exclusionList.add(GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE);
		
		for (int i = 0, variableSize = variables.size(); i < variableSize; i++)
		{
			IVariable currentVariable = (IVariable) variables.get(i);
			String name = currentVariable.getName();
			String value = currentVariable.getInitialValue();
			if (name != null && value != null && !exclusionList.contains(name))
			{
				addProperty (testSuiteProperties, name, value);
			}
		}
		
		
		/* We need to send out a property that can only be calculated at this level.  The variable used to
		 * refer to the location of the project of the test suite can only be calculated here */
		addProperty (testSuiteProperties, GlobalConstants.TEST_SUITE_PROPERTY_BASE + 0, AutoGUIUtil.getTestSuiteProjectLocation(testSuite));
				
		/* Add the object mine of the test suite */
		addProperty (testSuiteProperties, GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE, resolveObjectMine(testSuite));
						
		if (testSuiteProperties.size() > 0)
			properties.put(testSuite.getId(), testSuiteProperties);		
	}


	/**
	 * Serialize the object mine passed in.  The serialization inlines external object mines that have been included.  
	 * This is so as to avoid having to send a seperate property for each included object mine.
	 * 
	 * @param objectMine The object mine
	 * @param buffer The buffer that will be used to write the object mine to
	 */
	private static void serializeObjectMine(MacroObjectDescriptorMine objectMine, StringBuffer buffer)
	{
		/* Walk through each of the included object mines of the test suite */
		List includes = objectMine.getIncludes();
		for (int i = 0, includeCount = includes.size(); i < includeCount; i++)
		{
			serializeObjectMine((MacroObjectDescriptorMine)includes.get(i), buffer);
		}
		
		/* Add the object that have been directly registered with the object mine passed in */
		buffer.append(objectMine.serializeObjetsToString());
	}
	

	private static String resolveObjectMine(ITestSuite testSuite)
	{
		MacroObjectDescriptorMine objectMine = null;
		try
		{
			objectMine = MacroObjectDescriptorMineManager.getInstance().loadObjectMine(testSuite);
		} 
		catch (Exception e)
		{
			return MacroConstants.EMPTY_STRING;
		} 

		if (objectMine == null)
			return MacroConstants.EMPTY_STRING;
		
		StringBuffer buffer = new StringBuffer();
		
		/* Open the starting elements
		 * <object-mine> 
		 * 		<objects> */
		MacroUtil.addElement(buffer, 0, MacroConstants.OBJECT_MINE_ELEMENT, false, true);
		MacroUtil.addElement(buffer, 0, MacroConstants.OBJECTS_ELEMENT, false, true);
		serializeObjectMine (objectMine, buffer);
				
		/* Close the elements */
		MacroUtil.addElement(buffer, 0, MacroConstants.OBJECTS_ELEMENT, true, true);
		MacroUtil.addElement(buffer, 0, MacroConstants.OBJECT_MINE_ELEMENT, true, true);
		
		return buffer.toString();
	}
	
	
	private static void addProperty (Vector propertyContainer, String name, String value)
	{
		if (value == null)
			return;
		
		IProperty prop = HyadesFactory.INSTANCE.createProperty();
		prop.setName(name);
		prop.setValue(value);

		propertyContainer.add(prop);		
	}

	private static void walkThroughActions (Hashtable linkageOfProperties, List actions)
	{
		/* Walk throught the test invocations of the test suite and link the datapool entries accordingly
		 * just before we parse */
		for (int i = 0, actionsSize = actions.size(); i < actionsSize; i++)
		{
			/* If in case the item is a test invocation */
			if (actions.get(i) instanceof ITestInvocation)
				linkUserInput (linkageOfProperties, (ITestInvocation)actions.get(i));
			
			/* If in case the item is a loop */
			if (actions.get(i) instanceof ILoop)
			{
				ILoop loop = (ILoop)actions.get(i);
				walkThroughActions (linkageOfProperties, loop.getBlock().getActions());
			}
		}
	}
	private static void linkUserInput (Hashtable linkageOfProperties, ITestInvocation testInvocation)
	{
		Vector propertyList = new Vector();
		List properties = testInvocation.getActionProperties().getProperties();
		for (int j = 0; j < properties.size(); j++)
		{
			IProperty currentProperty = (IProperty)properties.get(j);
			
			if (currentProperty == null)
				continue;
			
			/* Datapool link */
			if (currentProperty.getName().startsWith(GlobalConstants.DATAPOOL_LINK_PROPERTY_BASE))
			{
				String propertyValue = currentProperty.getValue();
				
				/* Find the value in the datapool referenced by this field */
				Object[] fields = parsePropertyFields (propertyValue);
				
				/* We're expecting at least three fields here (Datapool path, datapool record index, datapool variable)*/
				if (fields.length < 3)
					continue;
				
				ResourceSet resourceSet = null;
				Resource res = null;
				try
				{
					resourceSet = new ResourceSetImpl();
					res = resourceSet.getResource(URI.createPlatformResourceURI((String)fields[0]), true);
					res.load(null); 
				}
				catch (Exception e1)
				{
					/* Don't link if we can't load the resource */
					continue;
				}
				
				IDatapoolFactory dpFactory = new Common_DatapoolFactoryImpl();
				IDatapool datapool = (IDatapool)res.getContents().get(0);
				IDatapoolIterator iter = dpFactory.open(datapool, DatapoolIteratorSequentialPrivate.class.getName());
				iter.dpInitialize(datapool, -1);

				int datapoolCellInx = Integer.parseInt((String)fields[1]);
				
				for (int k = 0; k < datapoolCellInx && !iter.dpDone(); k++)
					iter.dpNext();
				
				if (iter.dpDone())
					continue;
				
				IDatapoolRecord datapoolRecord = iter.dpCurrent();
				IDatapoolCell cell = datapoolRecord.getCell((String)fields[2]);
				if (cell == null)
					continue;
				
				IProperty linkage = HyadesFactory.INSTANCE.createProperty();
				linkage.setName(currentProperty.getName());
				linkage.setValue((String)cell.getCellValue());
				propertyList.add(linkage);
			}	
			
			/* Otherwise, just add the property */
			else
			{
				propertyList.add(currentProperty);
			}
		}
		
		if (!propertyList.isEmpty())
			linkageOfProperties.put (testInvocation.getId(), propertyList);
	}
	/**
	 *
	 * @param propertyValue
	 * @return
	 */
	public static Object[] parsePropertyFields(String propertyValue)
	{
		final String sepChar = "::";
		String currentField = propertyValue;
		Vector fields = new Vector (3);
		
		do
		{
			int inx = currentField.indexOf(sepChar);
			if (inx > 0 && currentField.length() > inx + 2)
			{
				fields.add (currentField.substring(0, inx));
				currentField = currentField.substring(inx + 2);
			}
			else if (currentField.length() > 0)
			{
				fields.add (currentField);
				currentField = null;
			}
		}while (currentField != null);
		
		return fields.toArray();
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;

import java.io.IOException;
import java.io.InputStream;
import java.util.Hashtable;

import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.hyades.test.common.util.XMLUtil;
import org.eclipse.jface.action.ContributionManager;
import org.eclipse.jface.action.CoolBarManager;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.action.ToolBarManager;
import org.eclipse.jface.window.ApplicationWindow;
import org.eclipse.jface.wizard.IWizardPage;
import org.eclipse.jface.wizard.WizardDialog;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.CoolBar;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.PrimitiveUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.NonTrivialUIObjectResolverDelegate;
import org.eclipse.tptp.test.auto.gui.internal.util.XMLDefaultHandler;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IEditorReference;
import org.eclipse.ui.IPartListener;
import org.eclipse.ui.IViewPart;
import org.eclipse.ui.IViewReference;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.intro.IIntroManager;
import org.eclipse.ui.intro.IIntroPart;
import org.eclipse.ui.testing.IWorkbenchPartTestable;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;

/**
 * A helper class that is used while recording a macro. <b>Important: </b> This class uses internal classes.
 * 
 * @author Alexander Nyssen (moved everything related to resolving/deresolving out of here
 */
public class MacroUtil {

	/** The parser used to parse XML fragments */
	private static SAXParser parser;

	private static Hashtable workbenchPartListeners = new Hashtable();
	private static IPartListener workbenchPartListener = new IPartListener() {

		public void partActivated(IWorkbenchPart part) {
			/* Doesn't need to be implemented */
		}

		public void partBroughtToTop(IWorkbenchPart part) {
			/* Doesn't need to be implemented */
		}

		/**
		 * This method will generate a close workbench part command. We can't determine for sure through events reported by a display of when a
		 * workbench part is closed. This part listener is a work around that allows us to capture close events on workbench parts.
		 * 
		 * @param part
		 *            The part is closed.
		 */
		public void partClosed(IWorkbenchPart part) {
			Macro currentMacro = MacroManager.getInstance().getCurrentMacro();
			Event event = new Event();

			event.type = EventConstants.EVENT_TYPE__WORKBENCH_PART_CLOSED;
			event.data = part;
			event.display = part.getSite().getShell().getDisplay();
			if (currentMacro != null) {
				try {
					currentMacro.addEvent(event);
				}
				catch (Exception e) {
					/* Ignore the error. It doesn't generate the command */
					e.printStackTrace();
				}
			}
		}

		public void partDeactivated(IWorkbenchPart part) {
			/* Doesn't need to be implemented */
		}

		public void partOpened(IWorkbenchPart part) {
			/* Doesn't need to be implemented */
		}
	};

	private static IWorkbenchWindow findHookTarget(Widget widget) {
		if (widget instanceof MenuItem) {
			MenuItem menuItem = (MenuItem) widget;
			IViewPart view = null;
			if ((view = onWorkbenchPartToolbar(menuItem)) != null) {
				// TODO: check if the toolbar manager has to be used to find the hook target...
				/* The context id should be the workbench part toolbar */
				IToolBarManager toolbarManager = view.getViewSite().getActionBars().getToolBarManager();
				if (toolbarManager == null || !(toolbarManager instanceof ToolBarManager))
					return null;

				// CHECK: setting the focus does not seem to be necessary to find a hook target
				// -> wihtout it, this method is side effect free
				// view.setFocus();
				return findHookTarget(((ToolBarManager) toolbarManager).getControl());
			}
			Control c = widget.getDisplay().getFocusControl();
			return findHookTarget(c);
		}
		else if (widget instanceof ToolItem) {
			ToolItem toolItem = (ToolItem) widget;

			/* Local toolbar somewhere - locate the parent first */
			ToolBar toolBar = toolItem.getParent();
			return findHookTarget(toolBar);
		}
		else if (widget instanceof Control) {
			Shell shell = ((Control) widget).getShell();
			Object data = shell.getData();
			if (data instanceof IWorkbenchWindow) {
				IWorkbenchWindow window = (IWorkbenchWindow) data;
				return window;
			}
			return null;
		}
		return null;
	}

	protected static void hookWorkbenchPartListener(Widget widget) {
		IWorkbenchWindow workbenchWindow = findHookTarget(widget);
		if (workbenchWindow != null) {
			IWorkbenchPage page = workbenchWindow.getActivePage();

			/**
			 * Ali M.: Under some situations, the part that is returned by the 'getActivePart' method is the old active part. Although the control
			 * object is coming from the newly active part, the part that is retrieved below will be from the old active part. This will cause
			 * MacroUtil.getControlIdentifier to return null when attempting to retrieve the widget id in the wrong context. One situation that this
			 * fails under is when: - Macro recorder start while the test suite editor is active - A hook is inserted - The package view is focused
			 * (not activated and focused but just focused)
			 * 
			 * To resolve this issue, I have registered a part listener when the client starts recording. When there is a new active part detected, an
			 * event is created and fired to the usual onEvent handler in MacroManager. See MacroManager.hookPartListener.
			 */
			IWorkbenchPart part = page.getActivePart();
			/*
			 * Ali M.: Register a dispose listener with this workbench part if we have not already done so. This is so that close commands can be
			 * generated.
			 */
			if (workbenchPartListeners.get(page) == null) {
				page.addPartListener(workbenchPartListener);
				workbenchPartListeners.put(page,
					workbenchPartListener);
			}
		}
	}

	public static int[] newCounter() {
		int[] inx = new int[1];
		inx[0] = 0;
		return inx;
	}

	public static boolean isInputControl(Control control) {
		return true;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.instrumentation.IDataProvider#getDefaultValue(org.eclipse.core.runtime.IPath)
	 */
	public Object getDefaultValue(IPath node) {
		return null;
	}

	private MenuItem getMenuItem(Menu menu, IPath menuPath) {
		if (menuPath.isEmpty()) {
			return null;
		}

		String toFind = menuPath.segment(0);
		MenuItem[] items = menu.getItems();

		for (int idx = 0; idx < items.length; idx++) {
			MenuItem item = items[idx];

			String itemName = removeChar(item.getText(),
				'&');

			if (itemName.equals(toFind)) {
				return getMenuItem(item,
					menuPath.removeFirstSegments(1));
			}
		}

		return null;
	}

	private MenuItem getMenuItem(MenuItem menu, IPath menuPath) {
		if (menuPath.isEmpty()) {
			return menu;
		}

		Menu subMenu = menu.getMenu();
		if (subMenu == null) {
			return null;
		}

		return getMenuItem(subMenu,
			menuPath);

	}

	public static void forceMenuClosed(Menu menu) {
		Event e = new Event();
		e.type = SWT.Hide;
		e.widget = menu;
	
		menu.notifyListeners(e.type, e);
		processDisplayEvents(menu.getDisplay());
	}

	public static void forceMenuOpen(Menu menu) {
		Event e = new Event();
		e.type = SWT.Show;
		e.widget = menu;
	
		menu.notifyListeners(e.type, e);
		processDisplayEvents(menu.getDisplay());
	}

	public static String getAttribute(Node node, String name) {
		Node value = node.getAttributes().getNamedItem(name);
		if (value != null)
			return value.getNodeValue();
		return null;
	}

	/**
	 * Adds an XML element to the string buffer passed in.
	 * 
	 * @param stringBuffer
	 *            The string buffer that the element will be written to
	 * @param indent
	 *            The number of indents that should be prefixed to the element written
	 * @param elementName
	 *            The element name
	 * @param close
	 *            Indicates whether this element should be closed or not. If set, a forward slash is added before theelement is ended.
	 * @param end
	 *            Indicates if the element should be ended with a closed angle bracket. For example elements requring attributes are not ended.
	 */
	public static void addElement(StringBuffer stringBuffer, int indent, String elementName, boolean close, boolean end) {
		addIndent(stringBuffer,
			indent);
		stringBuffer.append(MacroConstants.OPEN_ANGLE_BRACKET);
		stringBuffer.append(close
			? MacroConstants.FORWARD_SLASH
			: MacroConstants.EMPTY_STRING);
		stringBuffer.append(elementName);
		stringBuffer.append(end
			? MacroConstants.CLOSE_ANGLE_BRACKET + GlobalConstants.LINE_SEPARATOR
			: MacroConstants.EMPTY_STRING);
	}

	/**
	 * Adds XML attributes to the string buffer passed in. Attributes with a null value will not be written.
	 * 
	 * Pre-condition:
	 * <ul>
	 * <li> attributes and attributeValues must be valid (i.e. non-null) </li>
	 * <li> attributes and attributeValues length must be the same </li>
	 * </ul>
	 * 
	 * @param stringBuffer
	 *            The string buffer that the attributes will be written to
	 * @param attributeNames
	 *            The attribute names
	 * @param attributeValues
	 *            The attribute values
	 * @param close
	 *            If set, a forward slash is added after the attributes.
	 * @param end
	 *            If set, a closed angle bracket is added after the attributes
	 */
	public static void addAttribute(StringBuffer stringBuffer, String[] attributeNames, String[] attributeValues, boolean close, boolean end) {
		for (int i = 0; i < attributeValues.length; i++) {
			if (attributeValues[i] == null) {
				continue;
			}
			stringBuffer.append(MacroConstants.SINGLE_SPACE);
			stringBuffer.append(attributeNames[i]);
			stringBuffer.append(MacroConstants.EQUAL_SIGN);
			stringBuffer.append(MacroConstants.DOUBLE_QUOTE);
			stringBuffer.append(XMLUtil.useXMLSymbols(attributeValues[i]));
			stringBuffer.append(MacroConstants.DOUBLE_QUOTE);
		}

		stringBuffer.append(close
			? MacroConstants.FORWARD_SLASH
			: MacroConstants.EMPTY_STRING);
		stringBuffer.append(end
			? MacroConstants.CLOSE_ANGLE_BRACKET + GlobalConstants.LINE_SEPARATOR
			: MacroConstants.EMPTY_STRING);
	}

	public static void addIndent(StringBuffer stringBuffer, int indent) {
		for (int i = 0; i < indent; i++) {
			stringBuffer.append("\t");
		}
	}

	public static boolean isIgnorableEvent(Event e) {
		Shell shell = e.display.getActiveShell();
		if (shell != null) {
			Boolean ivalue = (Boolean) shell.getData(MacroManager.IGNORE);
			if (ivalue != null && ivalue.equals(Boolean.TRUE))
				return true;
		}
		return false;
	}

	public static Control getFirstChild(IWorkbenchPart part) {
		Composite partControl = getWorkbenchPartControl(part);
		return partControl.getChildren()[0];
	}

	/**
	 * We have to use internal APIs here to get the controls of a part
	 */
	public static Composite getWorkbenchPartControl(IWorkbenchPart part) {
		IWorkbenchPartTestable testable = (IWorkbenchPartTestable) part.getSite().getAdapter(IWorkbenchPartTestable.class);
		return testable.getControl().getParent();
	}

	/**
	 * If str.length() is greater than bound, then the first bound letters of str is returned followed by "..."; otherwise str is returned.
	 * 
	 * @param str
	 *            The string to bound
	 * @param bound
	 *            The bound
	 * @return A bounded version of str
	 */
	public static String boundSize(String str, int bound) {
		if (str == null || str.length() <= bound)
			return str;

		return str.substring(0,
			bound) + "...";
	}

	/**
	 * "Cleans" up the descriptive fields. For example, it removes the '&' sign that is usually included as part of button labels.
	 * 
	 * @param descriptiveField
	 *            The descriptive field
	 * @return A "cleaned" up version of the descriptive field.
	 */
	public static String normalizeDescriptiveField(String descriptiveField) {
		if (descriptiveField == null || descriptiveField.length() <= 0)
			return descriptiveField;

		/*
		 * This array holds character array that are of length two. The first item is the unwanted character and the second item is the replacement
		 * character.
		 */
		final char[][] UNWANTED_CHARACTERS =
			new char[][] {new char[] {'&', 0}, new char[] {'\t', ' '}, new char[] {'\n', ' '}, new char[] {'\r', ' '}};
		String cleanDescription = "";
		char currentCharacter;
		boolean isUnwantedChar;
		for (int i = 0, descriptionLength = descriptiveField.length(); i < descriptionLength; i++) {
			currentCharacter = descriptiveField.charAt(i);
			isUnwantedChar = false;

			for (int j = 0; j < UNWANTED_CHARACTERS.length; j++) {
				if (currentCharacter == UNWANTED_CHARACTERS[j][0]) {
					if (UNWANTED_CHARACTERS[j][1] > 0)
						cleanDescription += UNWANTED_CHARACTERS[j][1];

					isUnwantedChar = true;
					break;
				}
			}

			if (!isUnwantedChar)
				cleanDescription += currentCharacter;
		}

		return cleanDescription;
	}

	public static void closeWelcomePage() {
		IIntroManager introManager = GuiPlugin.getDefault().getWorkbench().getIntroManager();
		IIntroPart introPart = introManager.getIntro();
		if (introPart != null)
			introManager.closeIntro(introPart);
	}

	public static void maximizeWorkbench() {
		IWorkbench workbench = GuiPlugin.getDefault().getWorkbench();
		Shell workbenchShell = workbench.getActiveWorkbenchWindow().getShell();
		Rectangle clientArea = workbench.getDisplay().getClientArea();
		workbenchShell.setLocation(0,
			0);
		workbenchShell.setSize(new Point(clientArea.width, clientArea.height));
		workbenchShell.redraw();
	}

	public static void clearWorkbenchPartListeners() {
		workbenchPartListeners.clear();
	}

	public static IMacroObjectIdentifier getCustomEventIdentifier(Event event) {
		if (event.type == EventConstants.EVENT_TYPE__WORKBENCH_PART_CLOSED) {
			IWorkbenchPart part = (IWorkbenchPart) event.data;
			String partId = part.getSite().getId();

			/* The path to the context */
			IPath contextId = null;
			IPath partIdPath = null;
			if (part instanceof IViewPart) {
				contextId = new Path(MacroConstants.VIEW_VALUE);
				partIdPath = new Path(partId);
			}
			else if (part instanceof IEditorPart) {
				contextId = new Path(MacroConstants.EDITOR_VALUE);
				partIdPath = new Path(partId).append(((IEditorPart) part).getEditorInput().getName());
			}

			if (contextId != null && partId != null) {
				return new MacroObjectIdentifier(contextId.toString(), new PrimitiveUIObjectIdentifier(partIdPath.toString(), null));
			}
		}
		return null;
	}

	/**
	 * This method is provided to close any nested shells that a test case may have activated.
	 */
	public static void closeSecondaryShells(final Display display) {
		display.syncExec(new Runnable() {

			public void run() {
				Shell[] shells = display.getShells();
				for (int i = 0; i < shells.length; i++) {
					if (!shells[i].isDisposed() && shells[i].getData(GlobalConstants.OPENED_SHELL_INDICATOR) == null)
						shells[i].close();
				}
			}
		});
	}

	public static void processDisplayEvents(Display display) {
		for (int i = 0;; i++) {
			if (!display.readAndDispatch())
				break;
		}
	}

	public static XMLDefaultHandler createXMLDocument(InputStream is) throws CoreException, SAXException, IOException {
		XMLDefaultHandler handler = null;
		try {
			SAXParser parser = getParser();
			handler = new XMLDefaultHandler();
			parser.parse(is,
				handler);
		}
		finally {
			try {
				is.close();
			}
			catch (IOException e) {
			}
		}

		return handler;
	}

	private static SAXParser getParser() throws CoreException {
		if (parser == null) {
			try {
				return SAXParserFactory.newInstance().newSAXParser();
			}
			catch (ParserConfigurationException e) {
				AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_PARSING,
					e.getLocalizedMessage()),
					0,
					e);
			}
			catch (SAXException e) {
				AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_PARSING,
					e.getLocalizedMessage()),
					0,
					e);
			}
		}
		return parser;
	}

	public static String removeChar(String input, char toRemove) {
		StringBuffer buf = new StringBuffer(input.length());

		int last = 0;
		for (int pos = input.indexOf(toRemove); pos != -1; pos = input.indexOf(toRemove,
			last)) {
			buf.append(input.substring(last,
				pos));
			last = pos + 1;
		}

		buf.append(input.substring(last,
			input.length()));

		return buf.toString();
	}

	/**
	 * @param menuItem
	 * @return
	 */
	public static boolean onMenubar(MenuItem menuItem) {
		Menu parent = menuItem.getParent();
		MenuItem parentItem = parent.getParentItem();

		if (parentItem != null) {
			return onMenubar(parentItem);
		}

		Shell theShell = parent.getShell();
		return parent == theShell.getMenuBar();
	}

	public static ContributionManager onToolbar(ToolItem toolItem) {
		ToolBar toolBar = toolItem.getParent();
		Shell shell = toolBar.getShell();
		Object data = shell.getData();
		if (data instanceof ApplicationWindow) {
			ApplicationWindow window = (ApplicationWindow) data;
			ToolBarManager mng = window.getToolBarManager();
			if (mng != null) {
				if (mng.getControl() != null && mng.getControl() == toolBar)
					return mng;
			}
			CoolBarManager cmng = window.getCoolBarManager();
			if (cmng != null) {
				CoolBar cbar = cmng.getControl();
				Composite parent = toolBar.getParent();
				while (parent != null) {
					if (parent == cbar)
						return cmng;
					parent = parent.getParent();
				}
			}
		}
		return null;
	}

	public static IViewPart onWorkbenchPartToolbar(MenuItem menuItem) {
		IWorkbenchPage[] pages = GuiPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getPages();

		/* For evey page */
		for (int i = 0; i < pages.length; i++) {
			IViewReference[] viewReferences = pages[i].getViewReferences();

			/* For evey opened view */
			for (int j = 0; j < viewReferences.length; j++) {
				IViewPart viewPart = viewReferences[j].getView(false);
				if (viewPart == null)
					continue;

				IMenuManager menuManager = viewPart.getViewSite().getActionBars().getMenuManager();
				if (menuManager != null && menuManager instanceof MenuManager && searchForMenuItem(((MenuManager) menuManager).getMenu(),
					menuItem))
					return viewPart;
			}
		}

		return null;
	}

	private static boolean searchForMenuItem(Menu menu, MenuItem menuItem) {
		if (menu == null)
			return false;

		MenuItem[] items = menu.getItems();
		for (int i = 0; i < items.length; i++) {
			if (items[i] == menuItem)
				return true;
			Menu cascadeMenu = items[i].getMenu();
			if (cascadeMenu != null && searchForMenuItem(cascadeMenu,
				menuItem))
				return true;
		}

		return false;
	}
	
	/**
	 * @param wd
	 * @param control
	 * @return
	 */
	public static boolean onWizardDialog(WizardDialog wd, Button control) {
		// see if we have a button on the wizard page or on the wizard dialog (i.e. wizard)
		IWizardPage page = wd.getCurrentPage();
		Shell shell = control.getShell();
		Control pageControl = page.getControl();
		IUIObjectIdentifier relativePath = NonTrivialUIObjectResolverDelegate.computeRelativePath(
			(Composite) pageControl,
			null,
			control);
		if (relativePath != null) {
			return false;
		}
		// check for wizard buttons
		if (control instanceof Button) {
			relativePath = NonTrivialUIObjectResolverDelegate.computeRelativePath(
				shell,
				(Composite) pageControl,
				control);
			return true;
		}
		return false;

	}
	
	/**
	 * Used to located the editor part with the passed id.
	 * 
	 * @param shell
	 *            The current shell
	 * @param id
	 *            The id of the editor part
	 * @param line
	 *            The line number of the script (used to indicate the line number if we throw a core exception. Mark as -1 if a script is not being
	 *            used)
	 * @param input
	 *            If not null, then it attempts to match the input of the identified editor with the input that is passed it.
	 * 
	 * @return The editor part with the passed 'id'
	 * 
	 * @throws CoreException
	 *             If the editor part cannot be located.
	 */
	public static IEditorPart locateEditor(Shell shell, String id, String input) throws CoreException {
		Object data = shell.getData();
		IEditorPart editor = null;

		try {
			if (data instanceof IWorkbenchWindow) {
				IWorkbenchWindow window = (IWorkbenchWindow) data;
				IWorkbenchPage page = window.getActivePage();

				if (page != null) {
					IEditorReference[] erefs = page.getEditorReferences();

					for (int i = 0; i < erefs.length; i++) {
						IEditorReference eref = erefs[i];
						if (eref.getId().equals(id)) {
							// check the input
							IEditorPart part = eref.getEditor(true);
							if (input == null) {
								editor = part;
								break;
							}
							else if (part.getEditorInput().getName().equals(input)) {
								editor = part;
								break;
							}
						}
					}
				}
			}
		}
		catch (Throwable t) {

		}
		if (editor != null) {
			editor.getSite().getPage().activate(editor);
			return editor;
		}

		AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_EDITOR,
			id));
		return null;
	}
	
	/**
	 * Used to located the view part with the passed id.
	 * 
	 * @param shell
	 *            The current shell
	 * @param id
	 *            The id of the view part
	 * @param line
	 *            The line number of the script (used to indicate the line number if we throw a core exception. Mark as -1 if a script is not being
	 *            used)
	 * 
	 * @return The view part with the passed 'id'
	 * 
	 * @throws CoreException
	 *             If the view part cannot be located.
	 */
	public static IViewPart locateView(Shell shell, String id) throws CoreException {
		try {
			Object data = shell.getData();

			if (data instanceof IWorkbenchWindow) {
				IWorkbenchWindow window = (IWorkbenchWindow) data;
				IWorkbenchPage page = window.getActivePage();
				if (page != null) {
					IViewPart view = page.findView(id);

					if (view == null) {
						try {
							view = page.showView(id);

						}
						catch (PartInitException pie) {
							/* Do a thorough search */
							IWorkbenchWindow[] windows = GuiPlugin.getDefault().getWorkbench().getWorkbenchWindows();

							/* For every workbench window */
							for (int i = 0; i < windows.length && view == null; i++) {
								/* For every page of a workbench window */
								IWorkbenchPage[] pages = windows[i].getPages();
								for (int j = 0; j < pages.length && view == null; j++) {
									view = pages[j].findView(id);

								}
							}
							// need to mke sure that even if it is found in another page, we show it.

						}
					}
					// added for defcet 175320 in order to ensure the page is
					// given focus no matter where it is found
					page.showView(id);
					return view;
				}
			}
		}
		catch (Throwable t) {
			/* The next line will throw an exception */
		}
		AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_VIEW,
			id));
		return null;
	}

		
	/**
	 * Adds an XML element to the string buffer passed in.
	 * 
	 * @param stringBuffer The string buffer that the element will be written to
	 * @param indent The number of indents that should be prefixed to the element written
	 * @param elementName The element name
	 * @param close Indicates whether this element should be closed or not.  If set, 
	 * a forward slash is added before theelement is ended.  
	 * @param end Indicates if the element should be ended with a closed angle bracket.  
	 * For example elements requring attributes are not ended.
	 */
	public static void addElement (StringBuffer stringBuffer, int indent, String elementName, boolean close, boolean end)
	{
		addIndent(stringBuffer, indent);
		stringBuffer.append(MacroConstants.OPEN_ANGLE_BRACKET);
		stringBuffer.append(close ? MacroConstants.FORWARD_SLASH : MacroConstants.EMPTY_STRING);		
		stringBuffer.append(elementName);
		stringBuffer.append(end ? MacroConstants.CLOSE_ANGLE_BRACKET + GlobalConstants.LINE_SEPARATOR: MacroConstants.EMPTY_STRING);		
	}

	
	/**
	 * Adds XML attributes to the string buffer passed in.  Attributes with a null value will
	 * not be written.
	 * 
	 * Pre-condition:
	 * <ul>
	 * 	<li> attributes and attributeValues must be valid (i.e. non-null) </li>
	 * 	<li> attributes and attributeValues length must be the same </li>
	 * </ul>
	 *  
	 * @param stringBuffer The string buffer that the attributes will be written to
	 * @param attributeNames The attribute names
	 * @param attributeValues The attribute values
	 * @param close If set, a forward slash is added after the attributes.  
	 * @param end If set, a closed angle bracket is added after the attributes
	 */
	public static void addAttribute(StringBuffer stringBuffer, String[] attributeNames, String[] attributeValues, boolean close, boolean end)
	{
		for (int i = 0; i < attributeValues.length; i++)
		{
			if (attributeValues[i] == null)
			{
				continue;
			}
			stringBuffer.append(MacroConstants.SINGLE_SPACE);
			stringBuffer.append(attributeNames[i]);
			stringBuffer.append(MacroConstants.EQUAL_SIGN);
			stringBuffer.append(MacroConstants.DOUBLE_QUOTE);
			stringBuffer.append(XMLUtil.useXMLSymbols(attributeValues[i]));
			stringBuffer.append(MacroConstants.DOUBLE_QUOTE);
		}
		
		stringBuffer.append(close ? MacroConstants.FORWARD_SLASH : MacroConstants.EMPTY_STRING);
		stringBuffer.append(end ? MacroConstants.CLOSE_ANGLE_BRACKET + GlobalConstants.LINE_SEPARATOR : MacroConstants.EMPTY_STRING);
	}
	
	
	public static void addIndent (StringBuffer stringBuffer, int indent)
	{
		for (int i = 0; i < indent; i++)
		{
			stringBuffer.append("\t");
		}
	}
	
	
	public static boolean isIgnorableEvent(Event e)
	{
		Shell shell = e.display.getActiveShell();
		if (shell != null)
		{
			Boolean ivalue = (Boolean) shell.getData(MacroManager.IGNORE);
			if (ivalue != null && ivalue.equals(Boolean.TRUE))
				return true;
		}
		return false;
	}

	public static Control getFirstChild(IWorkbenchPart part)
	{
		Composite partControl = MacroObjectLocator.getWorkbenchPartControl(part);
		return partControl.getChildren()[0];
	}

	/**
	 * Given a context id, return the focus type.
	 * 
	 * @param contextId
	 *            The id of the context
	 * @return The type of the context (i.e. focus type). -1 is returned if the
	 *         focus type is not recognized.
	 */
	public static byte findFocusType(String contextId)
	{
		if (contextId.startsWith(MacroConstants.VIEW_VALUE + "/"))
			return VerificationMetaData.VIEW;
		else if (contextId.startsWith(MacroConstants.EDITOR_VALUE + "/"))
			return VerificationMetaData.EDITOR;
		else if (contextId.startsWith(MacroConstants.SHELL_VALUE + "/"))
			return VerificationMetaData.SHELL;

		return -1;
	}

	/**
	 * Return the class name containing the verification point that this meta
	 * data points to.
	 * 
	 * @param metaData
	 *            The verification point's meta data
	 * @return The class name. null is returned if it can't be determined
	 */
	public static String getClassName(VerificationMetaData metaData)
	{
		String className = metaData.getResource();

		if (className == null || className.length() <= 0)
			return null;

		int index = className.lastIndexOf('.');
		if (index != -1)
			return className.substring(index + 1, className.length());
		return className;
	}

	/**
	 * Find the method name corresponding the verification hook
	 * 
	 * @param metaData
	 * @return
	 */
	public static String findMethodName(VerificationMetaData metaData)
	{
		String methodName = metaData.getHook();

		if (methodName == null || methodName.length() <= 0)
			return null;

		int index = methodName.indexOf(':');
		if (index != -1)
			return methodName.substring(0, index);

		return methodName;
	}

	/**
	 * Find the parameter types of the verificaiton hook
	 * 
	 * @param metaData
	 * @return
	 */
	public static Class[] findParameterType(VerificationMetaData metaData)
	{
		Class param = null;
		if (metaData.getFocusType() == VerificationMetaData.EDITOR)
			param = IEditorPart.class;
		else if (metaData.getFocusType() == VerificationMetaData.VIEW)
			param = IViewPart.class;
		else if (metaData.getFocusType() == VerificationMetaData.SHELL)
			param = Shell.class;

		if (param != null)
			return new Class[] { param };

		return null;
	}

	
	/**
	 * If str.length() is greater than bound, then the first bound letters
	 * of str is returned followed by "..."; otherwise str is returned.
	 * 
	 * @param str The string to bound
	 * @param bound The bound
	 * @return A bounded version of str
	 */
	public static String boundSize(String str, int bound) 
	{					
		if (str == null || str.length() <= bound)
			return str;
		
		return str.substring(0, bound) + "...";
	}
	

	
	/**
	 * "Cleans" up the descriptive fields.  For example, it removes the '&' sign that is usually included
	 * as part of button labels.
	 * 
	 * @param descriptiveField The descriptive field
	 * @return A "cleaned" up version of the descriptive field.
	 */
	public static String normalizeDescriptiveField(String descriptiveField) 
	{
		if (descriptiveField == null || descriptiveField.length() <= 0)
			return descriptiveField;
		
		/* This array holds character array that are of length two.  The first item is the unwanted character and the second
		 * item is the replacement character. */
		final char[][] UNWANTED_CHARACTERS = new char[][] {new char[]{'&', 0}, new char[]{'\t', ' '}, new char[]{'\n', ' '}, new char[]{'\r', ' '}};
		String cleanDescription = "";
		char currentCharacter;
		boolean isUnwantedChar;
		for (int i = 0, descriptionLength = descriptiveField.length(); i < descriptionLength; i++)
		{
			currentCharacter = descriptiveField.charAt(i);
			isUnwantedChar = false;
			
			for (int j = 0; j < UNWANTED_CHARACTERS.length; j++)
			{
				if (currentCharacter == UNWANTED_CHARACTERS[j][0])
				{
					if (UNWANTED_CHARACTERS[j][1] > 0)
						cleanDescription += UNWANTED_CHARACTERS[j][1];
					
					isUnwantedChar = true;
					break;
				}
			}
			
			if (!isUnwantedChar)
				cleanDescription += currentCharacter;
		}
				
		return cleanDescription;
	}
	
	public static void closeWelcomePage()
	{		
		IIntroManager introManager = GuiPlugin.getDefault().getWorkbench().getIntroManager();
		IIntroPart introPart = introManager.getIntro();
		if (introPart != null)
			introManager.closeIntro(introPart);
	}

	
	public static void maximizeWorkbench()
	{
		IWorkbench workbench = GuiPlugin.getDefault().getWorkbench();
		Shell workbenchShell = workbench.getActiveWorkbenchWindow().getShell();
		Rectangle clientArea = workbench.getDisplay().getClientArea();
		workbenchShell.setLocation (0, 0);
		workbenchShell.setSize(new Point(clientArea.width, clientArea.height));
		workbenchShell.redraw();
	}
	public static void clearWorkbenchPartListeners()
	{
		workbenchPartListeners.clear();
	}
	
	
	private static class WorkbenchPartListener implements IPartListener
	{

		public void partActivated(IWorkbenchPart part) 
		{
			/* Doesn't need to be implemented */
		}

		public void partBroughtToTop(IWorkbenchPart part)
		{
			/* Doesn't need to be implemented */			
		}

		/**
		 * This method will generate a close workbench part command.  We can't determine for sure through
		 * events reported by a display of when a workbench part is closed.  This part listener is
		 * a work around that allows us to capture close events on workbench parts.
		 * 
		 * @param part The part is closed.
		 */
		public void partClosed(IWorkbenchPart part) 
		{
			Macro currentMacro = MacroManager.getInstance().getCurrentMacro(); 
			Event event = new Event();
			
			event.type = Macro.WORKBENCH_PART_CLOSED;
			event.data = part;
			event.display = part.getSite().getShell().getDisplay();
			if (currentMacro != null)
			{
				try 
				{
					currentMacro.addEvent(event);
				} 
				catch (Exception e) 
				{
					/* Ignore the error.  It doesn't generate the command */
					e.printStackTrace();
				}
			}			
		}

		public void partDeactivated(IWorkbenchPart part) 
		{
			/* Doesn't need to be implemented */
		}

		public void partOpened(IWorkbenchPart part) 
		{
			/* Doesn't need to be implemented */			
		}
		
	}

	public static WidgetIdentifier getCustomEventIdentifier(Event event) 
	{
		if (event.type == Macro.WORKBENCH_PART_CLOSED)
		{
			IWorkbenchPart part = (IWorkbenchPart)event.data;
			String partId = part.getSite().getId();
							
			/* The path to the context */
			IPath contextId = null;
			IPath partIdPath = null;
			if (part instanceof IViewPart)
			{
				contextId = new Path(MacroConstants.VIEW_VALUE);
				partIdPath = new Path(partId);
			}
			else if (part instanceof IEditorPart)
			{
				contextId = new Path(MacroConstants.EDITOR_VALUE);
				partIdPath = new Path(partId).append(((IEditorPart)part).getEditorInput().getName());
			}
			
			if (contextId != null && partId != null)
				return new WidgetIdentifier (contextId, partIdPath, null);			
		}
		return null;
	}

	
	/* Returns an identifier for the verification hook context */
	public static WidgetIdentifier getVerificationContextIdentifier(Event event) 
	{
		/* See if the context is an editor or a view */
		Control control = null;
		if (event.widget instanceof Control)
		{
			control = (Control)event.widget;
			WidgetIdentifier widgetId = getControlIdentifier(control);
			if (widgetId != null)
			{
				String firstSegment = new Path(widgetId.getContextId().toString()).segment(0);
				if (firstSegment.equals(MacroConstants.VIEW_VALUE) || firstSegment.equals(MacroConstants.EDITOR_VALUE))
					return widgetId;
			}
		}
		
		/* It's not an editor or a view.  See if it's a shell */
		Shell shellFound = null;
		if (event.widget instanceof Shell)
			shellFound = (Shell) event.widget;
		else if (control != null)
			shellFound = control.getShell();
		
		/* Make sure that the shell is not the workbench shell */
		if (shellFound == null || GuiPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getShell().equals(shellFound))
			return null;
		
		IWidgetId shellPath = getShellId(shellFound, null);
		if (shellPath.toString().length() <= 0)
			return null;
		
		return new WidgetIdentifier (new Path(MacroConstants.SHELL_VALUE).append(shellPath.toString()), null, shellPath.getResolverId());
	}
	
	
	/**
	 * This method is provided to close any nested shells that a test case may have
	 * activated. 
	 */
	public static void closeSecondaryShells(final Display display)
	{
		display.syncExec(new Runnable(){
			public void run() 
			{				
				Shell[] shells = display.getShells();
				for (int i = 0; i < shells.length; i++)
				{
					if (!shells[i].isDisposed() && shells[i].getData(GlobalConstants.OPENED_SHELL_INDICATOR) == null)
						shells[i].close();
				}				
			}
		});
	}
	
	public static void processDisplayEvents(Display display)
	{
		for (int i = 0;;i++)
		{			
			if (!display.readAndDispatch())
				break;
		}
	}
	
	
	public static XMLDefaultHandler createXMLDocument (InputStream is) throws CoreException, SAXException, IOException
	{
		XMLDefaultHandler handler = null;
		try
		{
			SAXParser parser = getParser();
			handler = new XMLDefaultHandler();
			parser.parse(is, handler);
		}
		finally
		{
			try
			{
				is.close();
			}
			catch (IOException e)
			{
			}
		}
		
		return handler;
	}
	
	private static SAXParser getParser() throws CoreException
	{
		if (parser == null)
		{
			try
			{
				return SAXParserFactory.newInstance().newSAXParser();
			}
			catch (ParserConfigurationException e)
			{
				AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_PARSING, e.getLocalizedMessage()), 0, e);
			}
			catch (SAXException e)
			{
				AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_PARSING, e.getLocalizedMessage()), 0, e);
			}
		}
		return parser;
	}

	
	private static PrimitiveWidgetId getActionId(IContributionItem contrib)
	{
		String id = null;
		PrimitiveWidgetId widgetId = new PrimitiveWidgetId();
		
		if (contrib instanceof IPluginContribution)
		{
			id = ((IPluginContribution) contrib).getLocalId();
		}
		id = id == null ? contrib.getId() : id;	
		if (id != null)
		{
			widgetId.setId("contribid/" + id); //$NON-NLS-1$
		}
		else
		{
			if (contrib instanceof ActionContributionItem)
			{
				ActionContributionItem actionItem = (ActionContributionItem) contrib;		
				id = actionItem.getId();		
				if (id != null)
				{
					widgetId.setId("actionid/" + id); //$NON-NLS-1$
				}
				else
				{		
					IAction action = actionItem.getAction();			
					id = action.getActionDefinitionId();			
					if (id != null)
					{
						widgetId.setId("defid/" + id); //$NON-NLS-1$
					}
					else
					{
						widgetId.setId("actionclass/" + action.getClass().getName()); //$NON-NLS-1$
					}
				}
			}
			else
			{
				widgetId.setId("contribclass/" + contrib.getClass().getName()); //$NON-NLS-1$				
			}
		}
		
		return widgetId;
	}


	/**
	 * @param widget
	 * @return
	 */
	public static IWidgetId getActionId(Widget widget)
	{
		Object data = widget.getData();
		PrimitiveWidgetId widgetId = new PrimitiveWidgetId();
		if (data != null && (data instanceof IContributionItem))
		{
			widgetId = getActionId((IContributionItem) data);
			if (!widgetId.toString().equals(MacroConstants.EMPTY_STRING))
			{
				if (widget instanceof MenuItem)
				{
					String menuInx = findMenuItemIndex((MenuItem)widget, "");
					widgetId.setId(widgetId.toString() + menuInx);
				}
			}
		}
		else
		{
			widgetId.setId("readablename/" + ((widget instanceof MenuItem) ? getDisplayName((MenuItem)widget) : getDisplayName((ToolItem)widget)));			//$NON-NLS-1$
		}
		
		return widgetId; 
	}
}




/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;

import java.util.ArrayList;
import java.util.Hashtable;
import java.util.LinkedList;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.osgi.util.NLS;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.core.IObjectMine;
import org.eclipse.tptp.test.auto.gui.internal.core.IUIObject;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;


/**
 * A concrete implementation of IObjectMine.
 * 
 * @author Ali Mehregani
 */
public class ObjectMine implements IObjectMine
{
	/** The root node of the tree structure that contains the objects */
	private IUIObject root;
	
	/** Included object mines */
	private ArrayList includes;
	
	/** The test suite that owns this object mine */
	private ITestSuite owner;
		
	/** The output object mine */
	private IObjectMine outputObjectMine;
	
	/** The active object */
	private IUIObject activeObject;

	/** Keeps track of the maximum reference id in use.  This is used to generate a unique
	 * reference id when requested */
	private int maximumRefId;

	/** The xml handler used to parse the object mine */
	private XMLDefaultHandler defaultXMLHandler;
	
	
	public ObjectMine (ITestSuite testSuite, XMLDefaultHandler defaultXMLHandler)
	{
		owner = testSuite;
		root = new UIObject(null);
		includes = new ArrayList();
		this.defaultXMLHandler = defaultXMLHandler;
	}
	
	public void addInclude(IObjectMine objectMine)
	{		
		includes.add(objectMine);		
		if (outputObjectMine != null)
		{
			IObjectMine foundObjectMine = findIncludedObjectMine(outputObjectMine);
			outputObjectMine = foundObjectMine == null ? outputObjectMine : foundObjectMine;
		}
	}

	public IUIObject lookupUIObject(IUIObject parent, String referenceId)
	{	
		IUIObject uiObject = lookupIncludes(parent, referenceId);
		if (uiObject != null)
			return uiObject;
				
		uiObject = lookupUIObject(parent);		
		if (uiObject == null)
			return null;

		uiObject = uiObject.findChild(referenceId);				
		return uiObject;
	}
	
	
	
	private IUIObject lookupUIObject(IUIObject object, boolean requiresPresence) throws UIObjectNotFound
	{
		if (object == null)
		{
			return root;
		}
		
		LinkedList relationship = object.getHierarchicalRelation();
		IUIObject currentNode = root;
		for (int i = 0, height=relationship.size(); currentNode != null && i < height; i++)
		{
			currentNode = currentNode.findChild(((IUIObject)relationship.get(i)).getReferenceId());
		}
		
		if (currentNode == null && requiresPresence)
			throw new UIObjectNotFound(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_OBJ_MINE_NF, object.getReferenceId()));
		
		return currentNode;
	}
	
	
	public IUIObject lookupUIObject(IUIObject parent, String contextId, String objectId)
	{
		IUIObject uiObject = lookupIncludes(parent, contextId, objectId);
		if (uiObject != null)
			return uiObject;
		
		IUIObject parentNode = lookupUIObject(parent);
		if (parentNode == null)
			return null;
		
		IUIObject[] children = parentNode.getChildren();
		for (int i = 0; i < children.length; i++)
		{
			if (((contextId == null && children[i].getContextId() == null) || (contextId != null && contextId.equals(children[i].getContextId()))) &&
				objectId.equals(children[i].getObjectId()))
			{
				return children[i];
			}
			
		}
		return null;
	}
	
	public IUIObject[] getChildren()
	{
		return root.getChildren();
	}
	
	
	
	private IUIObject lookupUIObject (IUIObject parent)
	{
		try
		{
			return lookupUIObject(parent, false);
		} 
		catch (UIObjectNotFound e)
		{
			return null;
		}
	}

	
	/**
	 * Looks up the included object mine to determine if they have a corresponding object
	 * with the reference id passed in.
	 * 
	 * @param parent The parent of the object
	 * @param referenceId The reference id of the object
	 * 
	 * @return The object with the reference id passed in; null if none is found. 
	 * @throws UIObjectNotFound In case the parent can't be found.
	 */
	private IUIObject lookupIncludes(IUIObject parent, String referenceId) 
	{
		IUIObject[] uiObject = lookupIncludes (parent, referenceId, null, null);
		return uiObject != null && uiObject.length > 0 ? uiObject[0] : null;
	}

	
	/**
	 * Looks up the included object mine to determine if they have a corresponding object
	 * with the contextId id and object id passed in.
	 * 
	 * @param parent The parent of the object
	 * @param contextId The context id of the object
	 * @param objectId The id of the object
	 * 
	 * @return The object with the matching context and object id passed in; null if none is found. 
	 * @throws UIObjectNotFound In case the parent can't be found.
	 */
	private IUIObject lookupIncludes(IUIObject parent, String contextId, String objectId) 
	{
		IUIObject[] uiObject = lookupIncludes (parent, null, contextId, objectId);
		return uiObject != null && uiObject.length > 0 ? uiObject[0] : null;
	}
	
	
	/**
	 * Looks up the included object mines to find an object that has been requested.
	 * If reference id happens to be null, then context/object id are used.
	 * 
	 * @param parent The parent of the object
	 * @param referenceId The reference id of the object. 
	 * @param contextId The context id of the object
	 * @param objectId The id of the object
	 *  
	 * @return The objects to look for
	 */
	private IUIObject[] lookupIncludes(IUIObject parent, String referenceId, String contextId, String objectId)
	{
		boolean useReferenceId = referenceId != null;
		boolean useObjectId = objectId != null;
		
		IUIObject objectRequested = null;
		IUIObject[] children = null; 
		for (int i = 0, includeCount = includes.size(); i < includeCount; i++)
		{
			IObjectMine objectMine = (IObjectMine)includes.get(i);
			if (useReferenceId)
			{
				objectRequested = objectMine.lookupUIObject(parent, referenceId);
			}
			else if (useObjectId)
			{
				objectRequested = objectMine.lookupUIObject(parent, contextId, objectId);
			}
		
			children = objectRequested == null ? children : new IUIObject[] {objectRequested};
			if (children != null)
			{
				return children;
			}
		}
		
		return null;
	}
	
	
	public IUIObject getRoot()
	{
		return root;
	}

	
	public IUIObject registerObject(IUIObject parent, Node objectNode) throws IDCollisionException, UIObjectNotFound, CoreException
	{
		NamedNodeMap attributes = objectNode.getAttributes();
		IUIObject uiObject = new UIObject(parent);

		IUIObject node = lookupUIObject(parent, true);		
		
		/* Set the attributes of the object */
		String referenceIdStr = getAttribute(attributes, MacroConstants.REFERENCE_ID_ATTRIBUTE);
		updateMaxReferenceId(referenceIdStr);
		
		Hashtable lineLevelDetail = null;
		if (defaultXMLHandler != null)
			lineLevelDetail = defaultXMLHandler.getLineTable();
		uiObject.setReferenceId(referenceIdStr);
		uiObject.setContextId(getAttribute(attributes, MacroConstants.CONTEXT_ID_ATTRIBUTE));
		uiObject.setObjectId(getAttribute(attributes, MacroConstants.ID_ATTRIBUTE));
		uiObject.setDescriptive(getAttribute(attributes, MacroConstants.DESCRIPTIVE_ATTRIBUTE));
		uiObject.setResolver(getAttribute(attributes, MacroConstants.RESOLVER_ATTRIBUTE));
		if (lineLevelDetail != null)
			uiObject.setData(((Integer[])lineLevelDetail.get(objectNode)));
		node.addChild(uiObject);
		
		return uiObject;
	}
	
	public IUIObject registerObject(IUIObject uiObject) throws IDCollisionException, UIObjectNotFound, CoreException
	{
		updateMaxReferenceId(uiObject.getReferenceId());
		
		IUIObject parentObject = uiObject.getParent();
		
		/* If the object that is about to be registered happens to be at the first level (i.e. 
		 * it is an infant), then it needs to be registered with the output destination of this object mine */
		if (parentObject == null && outputObjectMine != null)
		{
			outputObjectMine.registerObject(uiObject);
			includes.contains(outputObjectMine);
			return uiObject;
		}
		
		if (parentObject == null)
		{
			root.addChild(uiObject);
		}
		else
		{			
			parentObject.addChild(uiObject);	
		}
		
		
		return uiObject;
	}

	private void updateMaxReferenceId(String referenceIdStr)
	{
		try
		{
			int referenceId = Integer.parseInt(referenceIdStr);
			int maximumIncludedRefId = findMaximumIncludedRefId();
			maximumRefId = Math.max(Math.max(referenceId, maximumIncludedRefId), maximumRefId);
			
			if (referenceId == maximumRefId)
				maximumRefId++;
		}
		catch (NumberFormatException nfe)
		{
			/* Doesn't need to be handled */
		}
	}
	
	
	/**
	 * Walks through the included object mines of this object mine to determine the
	 * unique reference id.
	 * 
	 * @return A unique reference id that is global to all included object mines.
	 */
	private int findMaximumIncludedRefId()
	{
		int uniqueRefId = 0;

		for (int i = 0, includeCount = includes.size(); i < includeCount; i++)
		{
			IObjectMine currentObjectMine = (IObjectMine)includes.get(i);
			try
			{
				uniqueRefId = Math.max(Integer.parseInt(currentObjectMine.getUniqueReferenceId()), uniqueRefId);
			}
			catch (NumberFormatException nfe)
			{
				/* Ignore the exception */
			}
		}		
		return uniqueRefId;
	}

	private String getAttribute(NamedNodeMap attributes, String attributeName)
	{
		Node attr = attributes.getNamedItem(attributeName);
		return attr == null ? null : attr.getNodeValue();
	}

	public void setOutputSource(IObjectMine objectMine)
	{
		outputObjectMine = objectMine == null ? null : findIncludedObjectMine(objectMine);
		if (outputObjectMine == null)
			outputObjectMine = objectMine;		
	}


	public IObjectMine getOutputSource()
	{
		return outputObjectMine;
	}

	
	private IObjectMine findIncludedObjectMine(IObjectMine objectMine)
	{
		for (int i = 0, includeCount = includes.size(); i < includeCount; i++)
		{
			IObjectMine currentObjectMine = (IObjectMine)includes.get(i);
			if (currentObjectMine.equals(objectMine))
				return currentObjectMine;
		}
		
		return null;
	}
	
	public ITestSuite getOwner()
	{
		return owner;
	}
	
	
	public static class UIObjectNotFound extends Exception
	{
		static final long serialVersionUID = 4699726279267599112L;
		
		public UIObjectNotFound(String message)
		{
			super(message);
		}
	}
	
	
	public static class IDCollisionException extends Exception
	{
		static final long serialVersionUID = -6526030843455792891L;
		
		public IDCollisionException(String message)
		{
			super(message);
		}		
	}


	public String serializeToString()
	{
		StringBuffer objectMineSerialized = new StringBuffer();
		int indent = 0;
		
		/* <object-mine> */
		MacroUtil.addElement(objectMineSerialized, indent, MacroConstants.OBJECT_MINE_ELEMENT, false, true);
				
		serializeHeader(objectMineSerialized, indent + 1, true);
		serializeObjects(objectMineSerialized, indent + 1, true);
		
		/* </object-mine> */
		MacroUtil.addElement(objectMineSerialized, indent, MacroConstants.OBJECT_MINE_ELEMENT, true, true);
		
		return objectMineSerialized.toString();
	}


	private void serializeHeader(StringBuffer objectMineSerialized, int indent, boolean includeHeader)
	{
		/* Don't write anything if the header is empty */
		if (outputObjectMine == null && (includes == null || includes.size() <= 0))
			return;
		
		boolean outputElement = outputObjectMine != null;
		
		/* <header output="..."/>*/
		if (includeHeader)
		{
			MacroUtil.addElement(objectMineSerialized, indent, MacroConstants.HEADER_ELEMENT, false, !outputElement);
			if (outputElement)
				MacroUtil.addAttribute(objectMineSerialized, new String[] {MacroConstants.OUTPUT_ATTRIBUTE}, new String[] {AutoGUIUtil.resolveTestSuitePath(outputObjectMine.getOwner())}, false, true);
		}

		/* Add the <include .../> elements */
		for (int i = 0, includeCount = includes.size(); i < includeCount; i++)
		{
			IObjectMine currentInclude = (IObjectMine)includes.get(i);
			ITestSuite testSuite = currentInclude.getOwner();
			String path = AutoGUIUtil.resolveTestSuitePath(testSuite);
			
			if (path  != null)
			{
				MacroUtil.addElement(objectMineSerialized, indent + 1, MacroConstants.INCLUDE_ELEMENT, false, false);
				MacroUtil.addAttribute(objectMineSerialized, 
							new String[] {MacroConstants.PATH_ATTRIBUTE}, 
							new String[] {path}, 
							true, true);
			}
		}
		
		if (includeHeader)
		{
			MacroUtil.addElement(objectMineSerialized, indent, MacroConstants.HEADER_ELEMENT, true, true);
		}
	}

	
	private void serializeObjects(StringBuffer objectMineSerialized, int indent, boolean includeHeader)
	{	
		IUIObject[] rootChildren = root.getChildren();
		if (rootChildren == null || rootChildren.length <= 0)
			return;
		
		/* Add the objects */
		if (includeHeader)
		{
			MacroUtil.addElement(objectMineSerialized, indent, MacroConstants.OBJECTS_ELEMENT, false, true);
			addObject(objectMineSerialized, indent + 1, rootChildren);
			MacroUtil.addElement(objectMineSerialized, indent, MacroConstants.OBJECTS_ELEMENT, true, true);
			return;
		}
		
		addObject(objectMineSerialized, indent + 1, rootChildren);
	}
	
	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.core.IObjectMine#serializeHeaderToString()
	 */
	public String serializeHeaderToString()
	{
		StringBuffer sb = new StringBuffer();
		serializeHeader(sb, 0, false);
		return sb.toString();
	}

	
	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.core.IObjectMine#serializeObjetsToString()
	 */
	public String serializeObjetsToString()
	{
		StringBuffer sb = new StringBuffer();
		serializeObjects(sb, 0, false);
		return sb.toString();
	}
	
	private void addObject(StringBuffer objectMapSerialized, int indent, IUIObject[] rootChildren)
	{		
		if (rootChildren == null)
			return;
		
		for (int i = 0; i < rootChildren.length; i++)
		{
			IUIObject currentUIObject = rootChildren[i];			
			IUIObject[] children = rootChildren[i].getChildren();
			
			/* If the object is a shell without any children, then skip it */
			if (currentUIObject.getParent() == null && (children == null || children.length <= 0))
				continue;
			
			boolean hasChildren =  children!= null && children.length > 0;
			MacroUtil.addElement (objectMapSerialized, indent, MacroConstants.OBJECT_ELEMENT, false, false);
			MacroUtil.addAttribute(objectMapSerialized, 
					new String[] {MacroConstants.DESCRIPTIVE_ATTRIBUTE,
								  MacroConstants.REFERENCE_ID_ATTRIBUTE,
								  MacroConstants.CONTEXT_ID_ATTRIBUTE,
								  MacroConstants.RESOLVER_ATTRIBUTE,
								  MacroConstants.ID_ATTRIBUTE},
					new String[] {currentUIObject.getDescriptive(),
								  currentUIObject.getReferenceId(),
								  currentUIObject.getContextId(),
								  currentUIObject.getResolverId(),
								  currentUIObject.getObjectId()}
					, !hasChildren, true);
			if (hasChildren)
			{
				addObject(objectMapSerialized, indent + 1, rootChildren[i].getChildren());
				MacroUtil.addElement (objectMapSerialized, indent, MacroConstants.OBJECT_ELEMENT, true, true);
			}
		}
		
	}


	public IUIObject getActiveObject()
	{
		return activeObject;
	}

	public void setActiveObject(IUIObject activeObject)
	{
		this.activeObject = activeObject;
	}

	public String getUniqueReferenceId()
	{
		int maximumIncludedRefId = findMaximumIncludedRefId();
		maximumRefId = Math.max(maximumIncludedRefId, maximumRefId);
		
		/* Restart the reference id */
		if (maximumRefId >= Integer.MAX_VALUE - 10)
		{
			maximumRefId = 0;
		}
		return String.valueOf(maximumRefId);
	}

	public List getIncludes()
	{
		return includes;
	}
	
	public boolean equals(Object o)
	{
		return o instanceof IObjectMine ? getOwner().getId().equals(((IObjectMine)o).getOwner().getId()) : false;		
	}

	public void setOwner(ITestSuite testSuite)
	{
		this.owner = testSuite;		
	}

}




/*******************************************************************************
 * Copyright (c) 2003, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;

import java.util.Hashtable;
import java.util.Stack;

import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;

import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.Text;
import org.xml.sax.Attributes;
import org.xml.sax.Locator;
import org.xml.sax.helpers.DefaultHandler;

public class XMLDefaultHandler extends DefaultHandler
{

	private org.w3c.dom.Document fDocument;

	private Locator fLocator;

	private Hashtable fLineTable;

	private Element fRootElement;

	private Stack fElementStack = new Stack();
	
	/* Indicates whether a CDATA section is reached */
	private boolean cdataStarted;

	public XMLDefaultHandler()
	{
		fLineTable = new Hashtable();
	}

	public void startElement(String uri, String localName, String qName, Attributes attributes)
	{
		Element element = fDocument.createElement(qName);
		for (int i = 0; i < attributes.getLength(); i++)
		{
			element.setAttribute(attributes.getQName(i), attributes.getValue(i));
		}

		Integer lineNumber = new Integer(fLocator.getLineNumber());
		Integer[] range = new Integer[] { lineNumber, new Integer(-1) };
		fLineTable.put(element, range);
		if (fRootElement == null)
			fRootElement = element;
		else
			((Element) fElementStack.peek()).appendChild(element);
		fElementStack.push(element);
	}

	public void endElement(String uri, String localName, String qName)
	{
		Integer[] range = (Integer[]) fLineTable.get(fElementStack.pop());
		range[1] = new Integer(fLocator.getLineNumber());
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.xml.sax.helpers.DefaultHandler#setDocumentLocator(org.xml.sax.Locator)
	 */
	public void setDocumentLocator(Locator locator)
	{
		fLocator = locator;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.xml.sax.helpers.DefaultHandler#startDocument()
	 */
	public void startDocument()
	{
		DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
		try
		{
			fDocument = factory.newDocumentBuilder().newDocument();
		}
		catch (ParserConfigurationException e)
		{
		}
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.xml.sax.helpers.DefaultHandler#endDocument()
	 */
	public void endDocument()
	{
		fDocument.appendChild(fRootElement);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.xml.sax.helpers.DefaultHandler#processingInstruction(java.lang.String,
	 *      java.lang.String)
	 */
	public void processingInstruction(String target, String data)
	{
		fDocument.appendChild(fDocument.createProcessingInstruction(target, data));
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.xml.sax.helpers.DefaultHandler#characters(char[], int, int)
	 */
	public void characters(char[] characters, int start, int length)
	{
		StringBuffer buff = new StringBuffer();
		for (int i = 0; i < length; i++)
		{
			buff.append(characters[start + i]);
		}

		String buffValue = buff.toString();	
		boolean isBufferJustWhiteSpace = buffValue.trim().equals("");
		boolean isBufferEmpty = buffValue.length() <= 0;
		
		if ((cdataStarted && isBufferEmpty) || (!cdataStarted && isBufferJustWhiteSpace))
		{
			cdataStarted = false;
			return;
		}
				
		Text text = fDocument.createTextNode(buffValue);
		cdataStarted = true;
		if (fRootElement == null)
			fDocument.appendChild(text);
		else
			((Element) fElementStack.peek()).appendChild(text);
	}
	
	public Node getDocumentElement()
	{
		fDocument.getDocumentElement().normalize();
		return fDocument.getDocumentElement();
	}

	public org.w3c.dom.Document getDocument()
	{
		fDocument.getDocumentElement().normalize();
		return fDocument;
	}

	public Hashtable getLineTable()
	{
		return fLineTable;
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;

import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.InvocationTargetException;
import java.util.Vector;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.jobs.IJobChangeEvent;
import org.eclipse.core.runtime.jobs.IJobManager;
import org.eclipse.core.runtime.jobs.JobChangeAdapter;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.operation.IRunnableContext;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.commands.VerificationCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.factory.IMacroCommandFactory;
import org.eclipse.tptp.test.auto.gui.internal.commands.factory.MacroCommandFactoryLoader;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMineManager;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine.IDCollisionException;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine.UIObjectNotFound;
import org.eclipse.tptp.test.auto.gui.internal.runner.AutoGUIRunner;
import org.eclipse.tptp.test.auto.gui.internal.util.XMLDefaultHandler;
import org.eclipse.ui.IPartListener;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PlatformUI;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;

/**
 * A singleton class that manages the macro recording and playback. Clients
 * should always keep in mind that there is only one instance of a macro manager
 * always running. Proper synchronization and clean up is left to the client
 */
public class MacroManager {

	public static final String IGNORE = "__macro_ignore__";

	/*
	 * The state of jobs. This is used to listen for on going jobs and adding
	 * wait commands when there is a job running
	 */
	public static final int IDLE = 0;

	public static final int RUNNING = 1;

	public static final int DONE = 2;

	private Macro currentMacro;

	/* The instance that this singleton class holds */
	private static MacroManager macroManagerInstance;

	/*
	 * Keeps track of the global states that the macro manager is in. See the
	 * global state events for the possible states that this macro manager can
	 * be in. This variable must be locked when it is read/written from/to. Use
	 * globalStateLock to lock this field.
	 */
	private byte globalState;

	/* Global state lock */
	private Boolean globalStateLock;

	/* Verification hook listener */
	private VerificationHookListener verificationHooksListener;

	/* The active workbench page */
	private IWorkbenchPage activePage;

	/* The part listener */
	private IPartListener partListener;

	/*
	 * Global state listeners that will be invoked when the global state of this
	 * macro manager changes
	 */
	private Vector globalStateListeners;

	/* Stores the dependecies of the current test suite that is being executed */
	private Vector dependecies;

	/* Stores the runner that is running the current test suite */
	private AutoGUIRunner runner;

	/* Indicates whether artificial wait time is on/off */
	private boolean artificialWaitOn;

	/*
	 * Stores the allowable time-out threshold time for individual command
	 * execution
	 */
	private int commandTimeoutThreshold;

	/*
	 * Points to the object mine loaded for the operation (e.g. record/playback)
	 * that is in progress
	 */
	private MacroObjectDescriptorMine objectMine;

	private IMacroCommandFactory commandFactory;

	/* Points to the test suite that is being used to record a test case */
	private ITestSuite testSuite;

	/*
	 * Indicates whether object mines should be used for a recording session or
	 * not
	 */
	private boolean objectMineOn;

	/* The display listeners */
	private DisplayListener listener;

	/* The job listeners */
	private JobListener jobListener;

	class DisplayListener implements Listener {

		public void handleEvent(Event event) {
			/* Bail out if we are in the suspend mode */
			synchronized (globalStateLock) {
				if (globalState == ModeConstants.SUSPEND_MODE)
					return;
			}

			onEvent(event);
		}
	}

	class JobListener extends JobChangeAdapter {

		private int state = IDLE;

		public void running(IJobChangeEvent event) {
			if (!event.getJob().isSystem() && state == IDLE)
				state = RUNNING;
		}

		public void done(IJobChangeEvent event) {
			if (!event.getJob().isSystem() && state == RUNNING)
				state = DONE;
		}

		public void reset() {
			state = IDLE;
		}

		public int getState() {
			return state;
		}
	}

	/**
	 * Private constructor. Use getInstance()
	 */
	private MacroManager() {
		listener = new DisplayListener();
		jobListener = new JobListener();
		globalStateLock = new Boolean(false);
		globalState = ModeConstants.RECORDING_MODE; /*
													 * The initial global state
													 * is recording
													 */
	}

	/**
	 * Returns the instance that this singleton class holds
	 * 
	 * @return An instance of this class
	 */
	public static MacroManager getInstance() {
		if (macroManagerInstance == null)
			macroManagerInstance = new MacroManager();

		return macroManagerInstance;
	}

	public boolean isRecording() {
		return currentMacro != null;
	}

	/**
	 * Invoked to start a recording session
	 * 
	 * @param testSuite
	 *            The test suite
	 * @param objectMineOn
	 *            Indicates whether object mines should be used or not
	 * 
	 * @throws CoreException
	 *             In case of an unexpected error
	 * @throws UIObjectNotFound
	 *             If an expected UI object is not found
	 * @throws IDCollisionException
	 *             If there is a ID collision between UI objects
	 */
	public void startRecording(ITestSuite testSuite, boolean objectMineOn)
			throws CoreException, UIObjectNotFound, IDCollisionException {
		this.objectMineOn = objectMineOn;
		Display display = PlatformUI.getWorkbench().getDisplay();
		hookListeners(display);
		MacroUtil.clearWorkbenchPartListeners();
		currentMacro = new Macro();
		currentMacro.initializeForRecording(display);

		this.testSuite = testSuite;
		objectMine = MacroObjectDescriptorMineManager.getInstance()
				.loadObjectMine(testSuite);

		hookPartListener();
	}

	/**
	 * Stops the current macro that this macro manager maintains. The macro
	 * returned can be null, if a previous error has caused the current macro to
	 * be null
	 * 
	 * @param interrupted
	 *            true if it is interrupted and false if it is normally stopped.
	 * @return The macro to be stopped (null if a previous error has occurred in
	 *         macro manager)
	 */
	public Macro stopRecording(boolean interrupted) {
		removePartListener();

		/* Write the object mine to the test suite */
		if (testSuite != null && objectMine != null && objectMineOn) {
			if (!interrupted)
				MacroObjectDescriptorMineManager.getInstance().writeObjectMine(
						objectMine);
			testSuite = null;
			objectMine = null;
		}

		if (currentMacro != null)
			currentMacro.stopRecording();

		Macro newMacro = currentMacro;
		currentMacro = null;

		shutdown();
		return newMacro;
	}

	/**
	 * Register a part listener
	 */
	private void hookPartListener() {
		activePage = GuiPlugin.getDefault().getWorkbench()
				.getActiveWorkbenchWindow().getActivePage();
		partListener = new IPartListener() {

			public void partActivated(IWorkbenchPart part) {
				Event event = null;

				/* Simulate a focus in event */
				try {
					event = new Event();
					event.type = SWT.FocusIn;
					Shell shell = part.getSite().getPage().getWorkbenchWindow()
							.getShell();
					event.display = shell.getDisplay();
					event.widget = MacroUtil.getFirstChild(part);
				} catch (Exception e) {
					/* Don't report an event if there is an error */
					System.err.println(e.getMessage());
				}

				if (event != null) {
					listener.handleEvent(event);
				}
			}

			public void partBroughtToTop(IWorkbenchPart part) {
				/* Does not need to be implmented */
			}

			public void partClosed(IWorkbenchPart part) {
				/* Does not need to be implmented */
			}

			public void partDeactivated(IWorkbenchPart part) {
				/* Does not need to be implmented */
			}

			public void partOpened(IWorkbenchPart part) {
				/* Does not need to be implmented */
			}

		};

		activePage.addPartListener(partListener);
	}

	/**
	 * Remove the part listener
	 */
	private void removePartListener() {
		if (activePage == null)
			return;

		activePage.removePartListener(partListener);
		activePage = null;
		partListener = null;
	}

	public Macro getCurrentMacro() {
		return currentMacro;
	}

	public void hookListeners(Display display) {
		display.addFilter(SWT.MouseUp, listener);
		display.addFilter(SWT.KeyUp, listener);
		display.addFilter(SWT.KeyDown, listener);
		display.addFilter(SWT.Selection, listener);
		display.addFilter(SWT.DefaultSelection, listener);
		display.addFilter(SWT.Expand, listener);
		display.addFilter(SWT.Collapse, listener);
		display.addFilter(SWT.Modify, listener);
		display.addFilter(SWT.Activate, listener);
		display.addFilter(SWT.Close, listener);
		display.addFilter(SWT.FocusIn, listener);
		IJobManager jobManager = Platform.getJobManager();
		jobManager.addJobChangeListener(jobListener);
	}

	public void hookPositionBasedListeners(Display display) {
		display.addFilter(SWT.Activate, listener);
		display.addFilter(SWT.Close, listener);
		display.addFilter(SWT.MouseUp, listener);
		display.addFilter(SWT.MouseDown, listener);
		display.addFilter(SWT.MouseMove, listener);
		display.addFilter(SWT.KeyUp, listener);
		display.addFilter(SWT.KeyDown, listener);

		IJobManager jobManager = Platform.getJobManager();
		jobManager.addJobChangeListener(jobListener);
	}

	public void unhookListeners(Display display) {
		display.removeFilter(SWT.MouseUp, listener);
		display.removeFilter(SWT.KeyUp, listener);
		display.removeFilter(SWT.KeyDown, listener);
		display.removeFilter(SWT.Selection, listener);
		display.removeFilter(SWT.DefaultSelection, listener);
		display.removeFilter(SWT.Expand, listener);
		display.removeFilter(SWT.Collapse, listener);
		display.removeFilter(SWT.Modify, listener);
		display.removeFilter(SWT.Activate, listener);
		display.removeFilter(SWT.Close, listener);
		display.removeFilter(SWT.FocusIn, listener);
		IJobManager jobManager = Platform.getJobManager();
		jobManager.removeJobChangeListener(jobListener);
	}

	public void unhookPositionBasedListeners(Display display) {
		display.removeFilter(SWT.Activate, listener);
		display.removeFilter(SWT.Close, listener);
		display.removeFilter(SWT.MouseUp, listener);
		display.removeFilter(SWT.MouseDown, listener);
		display.removeFilter(SWT.MouseMove, listener);
		display.removeFilter(SWT.KeyUp, listener);
		display.removeFilter(SWT.KeyDown, listener);

		IJobManager jobManager = Platform.getJobManager();
		jobManager.removeJobChangeListener(jobListener);
	}

	public void shutdown() {
		Display display = PlatformUI.getWorkbench().getDisplay();
		unhookListeners(display);
		unhookPositionBasedListeners(display);
		if (currentMacro != null)
			currentMacro.stopRecording();
		currentMacro = null;
		artificialWaitOn = false;
	}

	/**
	 * Prepares this macro manager for playback of test cases. This method
	 * should be invoked to do the required one time initialization before a
	 * test suite's test cases are played back.
	 * 
	 * @param objectMineXML
	 *            The object mine XML
	 * @throws CoreException
	 *             In case of any unexpected error
	 */
	public void prepareForPlayBack(String objectMineXML) throws CoreException {
		try {
			setObjectMine(MacroObjectDescriptorMineManager.getInstance()
					.loadObjectMine(objectMineXML));
		} catch (Exception e) {
			AutoGUIUtil.throwCoreException(
					AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE, 0, e);
		}
	}

	/**
	 * Plays a provided macro stream. The method will close the input stream
	 * upon parsing.
	 * 
	 * @param is
	 * @throws CoreException
	 */
	public boolean play(final Display display, final IRunnableContext context,
			String scriptName, XMLDefaultHandler handler, Boolean shouldBlock)
			throws CoreException {
		Node root = handler.getDocumentElement();
		NodeList children = root.getChildNodes();
		MacroCommandShell.initializeForNewPlay();

		final Macro macro = new Macro(scriptName);
		for (int i = 0; i < children.getLength(); i++) {
			Node child = children.item(i);
			if (child.getNodeName().equals(MacroConstants.SHELL_ELEMENT)) {
				macro.load(child, handler.getLineTable());
			}
		}
		// discard the DOM
		handler = null;

		final boolean[] result = new boolean[1];

		class MacroOperationWrapper implements Runnable {

			private Exception exception;
			private Object objectToNotify;
			private boolean isDone;

			public MacroOperationWrapper(Object objectToNotify) {
				this.objectToNotify = objectToNotify;
				isDone = false;
			}

			public void run() {
				try {
					/*
					 * Ali M.: Unfortunately position-based commands don't work
					 * when the macro is played in an IRunnableContext with a
					 * progress bar. I had to sacrifice the progress bar for
					 * position-based commands to run correctly
					 */
					result[0] = runMacro(macro, display,
							new NullProgressMonitor());

					if (objectToNotify != null) {
						synchronized (objectToNotify) {
							objectToNotify.notify();
						}
					}
					isDone = true;
				} catch (Exception e) {
					exception = e;
					isDone = true;
				}
			}

			public void didErrorOccur() throws Exception {
				if (exception != null)
					throw exception;
			}

			public boolean isDone() {
				return isDone;
			}
		}

		try {
			/*
			 * Run the macro synchronously or asynchronously depending on the
			 * argument passed in
			 */
			if (shouldBlock.booleanValue()) {
				MacroOperationWrapper macroRunOperation = new MacroOperationWrapper(
						shouldBlock);
				Thread macroRunThread = new Thread(macroRunOperation);
				macroRunThread.start();

				while (!macroRunOperation.isDone()) {
					synchronized (shouldBlock) {
						shouldBlock.wait(500);
					}
				}

				macroRunOperation.didErrorOccur();
			} else
				new Thread(new MacroOperationWrapper(null)).start();
		} catch (Exception e) {
			/* The cause of this exception would give away the error */
			AutoGUIUtil.throwCoreException(
					AutoGUIMessages.AUTO_GUI_ERROR_MACRO_RUNNING_T, -1, e);
			result[0] = false;
		} finally {
			/* Indicate that we were done playing, if this is a blocking call */
			if (shouldBlock != null && shouldBlock.booleanValue())
				MacroCommandShell.macroStopped();
		}
		return result[0];
	}

	private boolean runMacro(final Macro macro, final Display display,
			IProgressMonitor monitor) throws InvocationTargetException {
		boolean success = false;
		try {
			// System.out.println("Start macro: "+macro.getName());
			success = macro.playback(display, null, monitor);
		} catch (CoreException e) {
			throw new InvocationTargetException(e);
		} catch (ClassCastException e) {
			throw new InvocationTargetException(e);
		} finally {
			monitor.done();
			// System.out.println("Stop macro: "+macro.getName());
		}
		return success;
	}

	public XMLDefaultHandler createMacroDocument(InputStream is)
			throws CoreException {
		XMLDefaultHandler handler = null;
		try {
			handler = MacroUtil.createXMLDocument(is);
		} catch (SAXException e) {
			AutoGUIUtil.throwCoreException(NLS.bind(
					AutoGUIMessages.AUTO_GUI_ERROR_MACRO_PARSING, e
							.getLocalizedMessage()), 0, e);
		} catch (IOException e) {
			AutoGUIUtil.throwCoreException(NLS.bind(
					AutoGUIMessages.AUTO_GUI_ERROR_MACRO_PARSING, e
							.getLocalizedMessage()), 0, e);
		}

		return handler;
	}

	private void onEvent(Event event) {
		try {
			/*
			 * If for any reason the current macro is null, then something has
			 * gone wrong. Shut the macro manager down
			 */
			if (currentMacro == null) {
				shutdown();
				return;
			}

			synchronized (globalStateLock) {
				if (globalState == ModeConstants.RECORDING_MODE
						&& (event.type == SWT.Close || event.type == SWT.Activate)
						&& !(event.widget instanceof Shell))
					return;
			}

			/*
			 * If there is an incomming event and there is already a job running
			 * in the background then insert a pause command
			 */
			if (jobListener.getState() == RUNNING
					|| jobListener.getState() == DONE) {
				currentMacro.addPause();
				jobListener.reset();
			}

			/*
			 * Check the global state here. If we're in the verification mode,
			 * then redirect the events to the verification command.
			 */
			synchronized (globalStateLock) {
				if (globalState == ModeConstants.RECORDING_MODE) {
					currentMacro.addEvent(event);
				} else if (globalState == ModeConstants.POSITION_BASED_REC_MODE) {
					/*
					 * We'll tag the event with a detail constant that will
					 * identify the event as position based
					 */
					event.detail = EventConstants.EVENT_DETAIL__POSITION_BASED_EVENT;
					currentMacro.addEvent(event);
				} else if (globalState == ModeConstants.VERIFICATION_MODE) {
					/*
					 * We'll tag the event with a detail constant that will
					 * identify the event as verification hook insertion related
					 * command
					 */
					event.detail = EventConstants.EVENT_DETAIL__VERIFICATION_HOOK_INSERTION_EVENT;
					currentMacro.addEvent(event);

					// see if the insertion was successful, notify the listener
					// about the result
					if (currentMacro.getTopShell() == null) {
						setGlobalState(ModeConstants.SUSPEND_MODE);
						showError(
								AutoGUIMessages.AUTO_GUI_ERROR_VER_TOP_SHELL_T,
								AutoGUIMessages.AUTO_GUI_ERROR_VER_TOP_SHELL);
						setGlobalState(ModeConstants.RECORDING_MODE);
					}
				}
			}

		} catch (Exception e) {
			AutoGUIUtil.openErrorWithDetail(
					AutoGUIMessages.AUTO_GUI_COMMON_UNKNOWN, e.getMessage(), e);
			e.printStackTrace();
			stopRecording(true);
		}
	}

	/**
	 * Show an error message
	 * 
	 * @param title
	 *            The title of the error message
	 * @param errorMsg
	 *            The actual error message
	 */
	public void showError(final String title, final String errorMsg) {
		final IWorkbench workbench = PlatformUI.getWorkbench();
		workbench.getDisplay().syncExec(new Runnable() {

			public void run() {
				IWorkbenchWindow window = workbench.getActiveWorkbenchWindow();
				if (window != null) {
					MessageDialog.openError(window.getShell(), title, errorMsg);
				}
			}
		});
	}

	protected void notifyVerificationListener(
			VerificationCommand verificationCommand) {
		if (verificationHooksListener != null)
			verificationHooksListener.instanceReady(verificationCommand);

	}

	protected void notifyVerificationListener(String error) {
		if (verificationHooksListener != null)
			verificationHooksListener.error(error);
	}

	/**
	 * Pre-condition:
	 * <ul>
	 * <li> To guarantee that this field is not changed while it is being used,
	 * it must be locked </li>
	 * </ul>
	 * 
	 * @return The global state of the macro manager.
	 */
	public byte getGlobalState() {
		return globalState;
	}

	public void setGlobalState(byte globalState) {
		synchronized (globalStateLock) {
			byte oldState = this.globalState;
			this.globalState = globalState;

			if (globalStateListeners != null && oldState != this.globalState) {
				for (int i = 0; i < globalStateListeners.size(); i++) {
					GlobalStateListener gsl = (GlobalStateListener) globalStateListeners
							.get(i);
					if (gsl.isListenerOn())
						gsl.globalStateChange(oldState, this.globalState);
				}

			}
		}
	}

	public void setGlobalStateWithoutLock(byte globalState) {
		byte oldState = this.globalState;
		this.globalState = globalState;

		if (globalStateListeners != null && oldState != this.globalState) {
			for (int i = 0; i < globalStateListeners.size(); i++) {
				GlobalStateListener gsl = (GlobalStateListener) globalStateListeners
						.get(i);
				if (gsl.isListenerOn())
					gsl.globalStateChange(oldState, this.globalState);
			}

		}
	}

	public void setVerListener(VerificationHookListener verHookListener) {
		verificationHooksListener = verHookListener;
	}

	public void removeVerListener() {
		verificationHooksListener = null;
	}

	public void registerGlobalStateListener(GlobalStateListener gsl) {
		if (this.globalStateListeners == null)
			this.globalStateListeners = new Vector(2);

		this.globalStateListeners.add(gsl);
	}

	public void removeGlobalStateListener(GlobalStateListener gsl) {
		if (this.globalStateListeners != null) {
			this.globalStateListeners.remove(gsl);
			if (this.globalStateListeners.size() == 0)
				this.globalStateListeners = null;
		}
	}

	public void setDependecies(Vector dependecies) {
		this.dependecies = dependecies;
	}

	public Vector getDependecies() {
		return this.dependecies;
	}

	public AutoGUIRunner getRunner() {
		return runner;
	}

	public void setRunner(AutoGUIRunner runner) {
		this.runner = runner;
	}

	/**
	 * This method is invoked to toggle the position based recording option on
	 * or off. Turning on position based recording will only record
	 * position-based commands. This is only recommended where object based
	 * recording cannot be used. (e.g. User clicking at a specific location of a
	 * canvas)
	 * 
	 * @param state
	 *            True indicates that position based recording should be turned
	 *            on and false indicates that it should be turned off
	 * 
	 * @return true if operation is successful; false otherwise
	 */
	public synchronized boolean togglePositionBasedRec(boolean state) {

		synchronized (globalStateLock) {
			Display currentDisplay = PlatformUI.getWorkbench().getDisplay();

			/* We're required to turn on position based recoridng */
			if (state) {
				if (currentDisplay != null) {
					unhookListeners(currentDisplay);
					hookPositionBasedListeners(currentDisplay);

					globalState = ModeConstants.POSITION_BASED_REC_MODE;
				} else
					return false;
			}
			/* Otherwise turn the option off */
			else if (!state) {
				if (currentDisplay != null) {
					unhookPositionBasedListeners(currentDisplay);
					hookListeners(currentDisplay);

					globalState = ModeConstants.RECORDING_MODE;
				} else
					return false;
			}

		}

		return true;

	}

	public boolean isArtificialWaitOn() {
		return artificialWaitOn;
	}

	public void setArtificialWaitOn(boolean artificialWaitOn) {
		this.artificialWaitOn = artificialWaitOn;
	}

	/**
	 * @return the objectMine
	 */
	public MacroObjectDescriptorMine getObjectMine() {
		return objectMine;
	}

	/**
	 * @param objectMine
	 *            the objectMine to set
	 */
	public void setObjectMine(MacroObjectDescriptorMine objectMine) {
		this.objectMine = objectMine;
	}

	/**
	 * Used to register classes as listeners that are awaiting the creation of a
	 * VerificationCommand from a focus command of an editor or a viewer.
	 * 
	 * @author Ali Mehregani
	 */
	public interface VerificationHookListener {

		/**
		 * Reports any error while attempting to construct object
		 * 
		 * @param error
		 *            A descriptive error message
		 */
		public void error(String error);

		/**
		 * Invoked when there is an instance ready
		 * 
		 * @param verificationCommand
		 *            The instance of verification command created as a result
		 *            of an event.
		 */
		public void instanceReady(VerificationCommand verificationCommand);
	}

	/**
	 * A gateway for client to determine the global state changes of the macro
	 * recorder.
	 * 
	 * @author amehregani
	 */
	public interface GlobalStateListener {

		/**
		 * Indicates whether the listener is interested in listening for a
		 * global state change.
		 * 
		 * @return True if the listener's globalStateChange method should be
		 *         invoke upon a global state change; false otherwise.
		 */
		public boolean isListenerOn();

		/**
		 * Invoked when the global state of the macro manager has changed
		 * 
		 * @param oldState
		 *            The old state
		 * @param newState
		 *            The new state
		 */
		public void globalStateChange(byte oldState, byte newState);
	}

	public int getCommandTimeoutThreshold() {
		return commandTimeoutThreshold;
	}

	public void setCommandTimeoutThreshold(int commandTimeoutThreshold) {
		this.commandTimeoutThreshold = commandTimeoutThreshold;
	}

	public int getOutstandShellCommands() {
		return MacroCommandShell.getMacroCommandsBeingPlayed().size();
	}

	/**
	 * @return the objectMineOn
	 */
	public boolean isObjectMineOn() {
		return objectMineOn;
	}

	/**
	 * @param objectMineOn
	 *            the objectMineOn to set
	 */
	public void setObjectMineOn(boolean objectMineOn) {
		this.objectMineOn = objectMineOn;
	}

	public IMacroCommandFactory getMacroCommandFactory() {
		if (commandFactory == null) {
			// see if we have a contribution via the macroCommandFactory
			// extension point
			return MacroCommandFactoryLoader.getHighestPriorityFactory();
		}
		return commandFactory;
	}

	
		if (globalStateListeners != null && oldState != this.globalState)
		{
			for (int i = 0; i < globalStateListeners.size(); i++)
			{
				GlobalStateListener gsl = (GlobalStateListener) globalStateListeners.get(i);
				if (gsl.isListenerOn())
					gsl.globalStateChange(oldState, this.globalState);
			}
	
		}
	}

	public void setVerListener(VerificationHookListener verHookListener)
	{
		verificationHooksListener = verHookListener;
	}

	public void removeVerListener()
	{
		verificationHooksListener = null;
	}

	public void registerGlobalStateListener(GlobalStateListener gsl)
	{
		if (this.globalStateListeners == null)
			this.globalStateListeners = new Vector(2);

		this.globalStateListeners.add(gsl);
	}

	public void removeGlobalStateListener(GlobalStateListener gsl)
	{
		if (this.globalStateListeners != null)
		{
			this.globalStateListeners.remove(gsl);
			if (this.globalStateListeners.size() == 0)
				this.globalStateListeners = null;
		}
	}

	public void setDependecies(Vector dependecies)
	{
		this.dependecies = dependecies;
	}

	public Vector getDependecies()
	{
		return this.dependecies;
	}

	public AutoGUIRunner getRunner()
	{
		return runner;
	}

	public void setRunner(AutoGUIRunner runner)
	{
		this.runner = runner;
	}
	
	
	/**
	 * This method is invoked to toggle the position based recording option on or off.
	 * Turning on position based recording will only record position-based commands. 
	 * This is only recommended where object based recording cannot be used. (e.g. User
	 * clicking at a specific location of a canvas)
	 * 
	 * @param state True indicates that position based recording should be turned on and false indicates
	 * that it should be turned off
	 * 
	 * @return true if operation is successful; false otherwise
	 */
	public synchronized boolean togglePositionBasedRec(boolean state) 
	{
	
		synchronized (globalStateLock)
		{
			Display currentDisplay = PlatformUI.getWorkbench().getDisplay();
			
			/* We're required to turn on position based recoridng */
			if (state)
			{
				if (currentDisplay != null)
				{
					unhookListeners(currentDisplay);
					hookPositionBasedListeners(currentDisplay);
					
					globalState = POSITION_BASED_REC_MODE;
				}
				else 
					return false;
			}
			/* Otherwise turn the option off */
			else if (!state)
			{
				if (currentDisplay != null)
				{
					unhookPositionBasedListeners(currentDisplay);
					hookListeners(currentDisplay);
					
					globalState = RECORDING_MODE;
				}
				else
					return false;
			}
				
		}
		
		return true;
		
	}
	
	public boolean isArtificialWaitOn() 
	{
		return artificialWaitOn;
	}

	public void setArtificialWaitOn(boolean artificialWaitOn) 
	{
		this.artificialWaitOn = artificialWaitOn;
	}
	
	
	/**
	 * @return the objectMine
	 */
	public IObjectMine getObjectMine()
	{
		return objectMine;
	}

	/**
	 * @param objectMine the objectMine to set
	 */
	public void setObjectMine(IObjectMine objectMine)
	{
		this.objectMine = objectMine;
	}
	
	
	/**
	 * Used to register classes as listeners that are awaiting the creation of a VerificationCommand
	 * from a focus command of an editor or a viewer.
	 * 
	 * @author Ali Mehregani
	 */
	public interface VerificationHookListener
	{
		/**
		 * Reports any error while attempting to construct object
		 * 
		 * @param error A descriptive error message 
		 */
		public void error(String error);

		/**
		 * Invoked when there is an instance ready
		 * 
		 * @param verificationCommand The instance of verification command created as a result of an event.
		 */
		public void instanceReady(VerificationCommand verificationCommand);
	}

	/**
	 * A gateway for client to determine the global state changes of the macro recorder.
	 * 
	 * @author amehregani
	 */
	public interface GlobalStateListener
	{
		/**
		 * Indicates whether the listener is interested in listening 
		 * for a global state change.
		 * 
		 * @return True if the listener's globalStateChange method should be
		 * invoke upon a global state change; false otherwise.
		 */
		public boolean isListenerOn();

		/**
		 * Invoked when the global state of the macro manager has changed
		 * 
		 * @param oldState The old state
		 * @param newState The new state
		 */
		public void globalStateChange(byte oldState, byte newState);
	}

	public int getCommandTimeoutThreshold() {
		return commandTimeoutThreshold;
	}

	public void setCommandTimeoutThreshold(int commandTimeoutThreshold) {
		this.commandTimeoutThreshold = commandTimeoutThreshold;
	}
	
	public int getOutstandShellCommands()
	{
		return MacroCommandShell.getMacroCommandsBeingPlayed().size();
	}

	/**
	 * @return the objectMineOn
	 */
	public boolean isObjectMineOn()
	{
		return objectMineOn;
	}

	/**
	 * @param objectMineOn the objectMineOn to set
	 */
	public void setObjectMineOn(boolean objectMineOn)
	{
		this.objectMineOn = objectMineOn;
	}


	
}




/*******************************************************************************
 * Copyright (c) 2007 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;

import java.util.ArrayList;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.Vector;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.jface.action.CoolBarManager;
import org.eclipse.jface.action.IContributionItem;
import org.eclipse.jface.action.ICoolBarManager;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.action.ToolBarContributionItem;
import org.eclipse.jface.action.ToolBarManager;
import org.eclipse.jface.window.ApplicationWindow;
import org.eclipse.jface.window.Window;
import org.eclipse.jface.wizard.IWizardPage;
import org.eclipse.jface.wizard.WizardDialog;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Decorations;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Item;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.commands.CommandTarget;
import org.eclipse.tptp.test.auto.gui.internal.commands.EditorCommandTarget;
import org.eclipse.tptp.test.auto.gui.internal.commands.ViewCommandTarget;
import org.eclipse.tptp.test.auto.gui.internal.commands.WindowCommandTarget;
import org.eclipse.tptp.test.auto.gui.internal.commands.WizardCommandTarget;
import org.eclipse.tptp.test.auto.gui.internal.core.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.core.WidgetIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.core.WidgetResolverLoader;
import org.eclipse.ui.IActionBars;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IEditorReference;
import org.eclipse.ui.IViewPart;
import org.eclipse.ui.IViewSite;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.testing.IWorkbenchPartTestable;
import org.w3c.dom.Node;

/**
 * A utility class used to locate different objects needed when playing back 
 * commands.
 * 
 * @author Ali Mehregani
 */
public class MacroObjectLocator
{

	public static CommandTarget[] locateCommandTarget(Composite parent, WidgetIdentifier wid, ArrayList parents, int line) throws CoreException
	{
		Shell shell = (Shell) parent;
		
		IPath contextId = wid.getContextId();
		
		String firstToken = contextId.segment(0);		
		Iterator iter = parents != null ? parents.iterator() : null;
		String id = contextId.segment(1);
		
		if (MacroConstants.MENUS_VALUE.equals(firstToken))
		{
			return new CommandTarget[]{locateMenuBarItem(shell, wid, iter, line)};
		}
		else if (MacroConstants.POPUP_VALUE.equals(firstToken))
		{
			return new CommandTarget[]{ locatePopupMenuItem(shell, wid, iter, line)};
		}
		else if (MacroConstants.TOOLBAR_VALUE.equals(firstToken))
		{
			return new CommandTarget[]{ locateToolItem(shell, wid, line)};
		}
		else if (MacroConstants.LOCAL_TOOLBAR_VALUE.equals(firstToken))
		{
			return new CommandTarget[]{ locateLocalToolItem(shell, wid, line)};
		}
		else if (MacroConstants.LOCAL_TOOLBAR_MENU_VALUE.equals(firstToken))
		{
			return new CommandTarget[] {locateToolBarMenuItem(shell, wid, line)};
		}
		else if (MacroConstants.WIZARD_VALUE.equals(firstToken))
		{
			return locateWizardControl(shell, wid, line);
		}
		else if (MacroConstants.SHELL_VALUE.equals(firstToken))
		{
			return locateShellControl(shell, wid, line);
		}		
		else if (MacroConstants.WIZARD_PAGE_VALUE.equals(firstToken))
		{
			return locateWizardPageControl(shell, id, wid, line);
		}
		else if (MacroConstants.VIEW_VALUE.equals(firstToken))
		{
			return locateViewControl(shell, id, wid, line);
		}
		else if (MacroConstants.EDITOR_VALUE.equals(firstToken))
		{
			String inputName = contextId.segment(2);
			return locateEditorControl(shell, id, inputName, wid, line);
		}
		
		
		return null;
	}

	public static CommandTarget[] locateCommandTarget(Composite parent, WidgetIdentifier wid, int line) throws CoreException
	{
		return locateCommandTarget(parent, wid, null, line);
	}

	/**
	 * Used to located the editor part with the passed id.
	 * 
	 * @param shell
	 *            The current shell
	 * @param id
	 *            The id of the editor part
	 * @param line
	 *            The line number of the script (used to indicate the line
	 *            number if we throw a core exception. Mark as -1 if a script is
	 *            not being used)
	 * @param input
	 *            If not null, then it attempts to match the input of the
	 *            identified editor with the input that is passed it.
	 * 
	 * @return The editor part with the passed 'id'
	 * 
	 * @throws CoreException
	 *             If the editor part cannot be located.
	 */
	public static IEditorPart locateEditor(Shell shell, String id, int line, String input) throws CoreException
	{
		Object data = shell.getData();
		IEditorPart editor = null;
	
		try
		{
			if (data instanceof IWorkbenchWindow)
			{
				IWorkbenchWindow window = (IWorkbenchWindow) data;
				IWorkbenchPage page = window.getActivePage();
	
				if (page != null)
				{
					IEditorReference[] erefs = page.getEditorReferences();
	
					for (int i = 0; i < erefs.length; i++)
					{
						IEditorReference eref = erefs[i];
						if (eref.getId().equals(id))
						{
							// check the input
							IEditorPart part = eref.getEditor(true);
							if (input == null)
							{
								editor = part;
								break;
							}
							else if (part.getEditorInput().getName().equals(input))
							{
								editor = part;
								break;
							}							
						}
					}
				}
			}
		}
		catch (Throwable t)
		{
			
		}
		if (editor != null)
		{			
			editor.getSite().getPage().activate(editor);
			return editor;
		}
	
		AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_EDITOR, id), line);
		return null;
	}

	private static EditorCommandTarget[] locateEditorControl(Shell shell, String id, String inputName, WidgetIdentifier wid, int line) throws CoreException
	{
		Control[] controls = null;
		
		try
		{			
			IEditorPart editor = locateEditor(shell, id, line, inputName);
	
			if (editor != null)
			{
				Composite c = getWorkbenchPartControl(editor);
				controls = locateVisibleChild(c, null, wid);
				if (controls != null)
				{
					EditorCommandTarget[] editorCommandTargets = new EditorCommandTarget[controls.length];
					for (int i = 0; i < controls.length; i++)
					{
						editorCommandTargets[i] = new EditorCommandTarget(controls[i], editor);
					}
					
					return editorCommandTargets;
				}
			}
		}
		catch (Throwable t)
		{
			t.printStackTrace();
		}
		if (controls == null)
			AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_EDITOR_CON, wid.getObjectId().toString()), line);
	
		return null;
	}

	private static CommandTarget locateLocalToolItem(Shell shell, WidgetIdentifier wid, int line) throws CoreException
	{
		try
		{			
			IPath wpath = wid.getContextId().removeFirstSegments(1);
			String firstToken = wpath.segment(0);
			IWorkbenchPart workbenchPart = null;
			Composite parent = null;
			CommandTarget target = null;
			
			if (MacroConstants.VIEW_VALUE.equals(firstToken))
			{
				String id = wpath.segment(1);
				workbenchPart = locateView(shell, id, line);
			}
			else if (MacroConstants.EDITOR_VALUE.equals(firstToken))
			{
				String id = wpath.segment(1);
				workbenchPart = locateEditor(shell, id, line, null);
			}
			else if (MacroConstants.SHELL_VALUE.equals(firstToken))
			{
				parent = shell;
			}
			
			if (workbenchPart != null)
			{
				Composite comp = getWorkbenchPartControl(workbenchPart);
				MacroUtil.processDisplayEvents(shell.getDisplay());
				parent = comp.getParent();
			}
			
			if (parent != null)
			{
				WidgetIdentifier widgetIdentifier = new WidgetIdentifier(wid.getContextId(), new Path(wid.getContextId().lastSegment()), wid.getResolverId());
				Control[] controls = locateVisibleChild(parent, null, widgetIdentifier);
				if (controls != null && controls.length > 0 && controls[0] instanceof ToolBar)
				{
					target = locateToolItem((ToolBar)controls[0], wid, line);
				}				
			}
			
			if (target != null)
				return target;
			
		}
		catch (Throwable t)
		{
			/* The next line will throw an exception */
			t.printStackTrace();
		}
		
		AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_TOOL_BAR, wid.getFullyQualifiedId().toString()), line);
		return null;
	}

	private static CommandTarget locateMenuBarItem(Shell shell, WidgetIdentifier wid, Iterator parents, int line) throws CoreException
	{
		try
		{
			MenuItem item = null;
			Object data = shell.getData();
			Menu menuBar = shell.getMenuBar();
	
			if (data instanceof ApplicationWindow && parents != null)
			{
				ApplicationWindow window = (ApplicationWindow) data;
				MenuManager manager = window.getMenuBarManager();
				item = locateMenuItem(manager, wid.getResolverId(), wid.getObjectId().toString(), parents, line);
			}
			else
			{
				item = locateMenuItem(menuBar, wid.getResolverId(), wid.getObjectId().toString(), line);
			}
			if (item != null)
				return new CommandTarget(item, menuBar);
			
		}
		catch (Throwable t)
		{
			/* The next line will throw exception */			
		}
		AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_MENU, wid.getObjectId().toString()), line);
		return null;
	}

	private static MenuItem locateMenuItem(Menu menu, String resolverId, String id, int line)
	{
		MenuItem[] items = menu.getItems();
	
		for (int i = 0; i < items.length; i++)
		{
			MenuItem item = items[i];
	
			Menu submenu = item.getMenu();
			if (submenu != null)
			{
				/* Ali M.: We have to force the menu to open, since its items may not have already been created */
				forceMenuOpen(null, submenu);
				MenuItem hit = locateMenuItem(submenu, resolverId, id, line);
				if (hit != null)
					return hit;
			}
			else
			{
				if (foundItem(item, resolverId, id))
					return item;
			}
		}
		return null;
	}

	
	private static MenuItem locateMenuItem(MenuManager mng, String resolverId, String id, Iterator parents, int line)
	{
		IContributionItem[] items = mng.getItems();
	
		String parentId = null;
		if (parents.hasNext())
			parentId = (String) parents.next();
	
		for (int i = 0; i < items.length; i++)
		{
			IContributionItem citem = items[i];
	
			if (citem instanceof MenuManager)
			{
				MenuManager submenu = (MenuManager) citem;
				String subId = submenu.getId();
	
				if (subId.equals(parentId))
				{
					// show this menu to force dynamic items
					// to show
					Menu menu = submenu.getMenu();
					forceMenuOpen(null, menu);
	
					MenuItem hit = locateMenuItem(submenu, resolverId, id, parents, line);
					forceMenuClosed(menu);
					if (hit != null)
						return hit;
				}
			}
			else
			{
				/* Ali M.: I believe that the first line and the following block were for optimization purposes only */
				//String itemId = getActionId(citem);
				//if (itemId != null && id.equals(itemId))
				//{
				MenuItem hit = locateMenuItem(mng.getMenu(), resolverId, id, line);
				if (hit != null)
					return hit;
				//}
			}
		}
		return null;
	}

	private static CommandTarget locatePopupMenuItem(Shell shell, WidgetIdentifier wid, Iterator parents, int line) throws CoreException
	{
		try
		{
			IPath contextPath = wid.getContextId().removeFirstSegments(1);
			IPath wpath = new Path(getLastSegment(contextPath));
			
			int widgetPathInx = contextPath.toString().indexOf(wpath.toString());
			if (widgetPathInx > 0)
				contextPath = new Path(contextPath.toString().substring(0, widgetPathInx - 1));
			CommandTarget[] targets = locateCommandTarget(shell, new WidgetIdentifier(contextPath, wpath, null), line);
			if (targets != null)
			{
				for (int i = 0; i < targets.length; i++)
				{
					Control control = (Control) targets[i].getWidget();
					Menu popupMenu = control.getMenu();
					if (popupMenu != null)
					{
						forceMenuOpen(control, popupMenu);
						MenuItem menuItem = locateMenuItem(popupMenu, wid.getResolverId(), wid.getObjectId().toString(), line);
						forceMenuClosed(popupMenu);
						if (menuItem != null)
						{
							return new CommandTarget(menuItem, control);
						}
					}
				}
			}
		}
		catch (Throwable t)
		{
			/* The next line will throw an exception */			
		}
		AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_MENU, wid.getObjectId().toString()), line);
		return null;
	}

	private static CommandTarget locateToolBarMenuItem(Shell shell, WidgetIdentifier wid, int line) throws CoreException
	{
		try
		{
			IPath contextPath = wid.getContextId().removeFirstSegments(1);
			
			/* The context is a menu */
			IViewPart viewPart = null;
			if (MacroConstants.VIEW_VALUE.equals(contextPath.segment(0)))
			{
				viewPart = locateView(shell, contextPath.segment(1), line);
			}

			
			IViewSite viewSite = viewPart == null ? null : viewPart.getViewSite();
			IMenuManager menuManager = null;
			if (viewSite != null)
			{
				IActionBars actionBar = viewSite.getActionBars();
				actionBar.updateActionBars();
				menuManager = actionBar.getMenuManager();
			}
			
			if (menuManager instanceof MenuManager)
			{
				
				Menu menu = ((MenuManager)menuManager).getMenu();
				if (menu == null)
				{
					menu = ((MenuManager)menuManager).createMenuBar((Decorations)shell);
				}
				if (menu != null)
				{
					forceMenuOpen(null, menu);
					MenuItem menuItem = locateMenuItem(menu, wid.getResolverId(), wid.getObjectId().toString(), line);
					forceMenuClosed(menu);
					if (menuItem != null)
					{
						return new CommandTarget(menuItem, null);
					}
				}
			}
		}
		catch (Throwable t)
		{
			/* The next line will throw an exception */			
		}
		AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_MENU, wid.getObjectId().toString()), line);
		return null;
	}
	private static String getLastSegment(IPath contextPath)
	{
		String[] segments = contextPath.segments();
		String candidate = "";
		for (int i = segments.length - 1; i >= 0; i--)
		{
			if (candidate.length() > 0)
				candidate = "/" + candidate;
			candidate = segments[i] + candidate;
			int openingBracesInx = candidate.indexOf('{');
			int closingBracesInx = candidate.indexOf('}');
			if ((openingBracesInx == -1 && closingBracesInx == -1) || (openingBracesInx >= 0 && openingBracesInx < closingBracesInx))
				return candidate;
		}
		
		return "";
	}
	
	private static WindowCommandTarget[] locateShellControl(Shell shell, WidgetIdentifier wid, int line) throws CoreException
	{
		Control[] controls = null;
		Window window = null;
		try
		{
			window = (Window) shell.getData();
			controls = locateVisibleChild(shell, null, wid);
		}
		catch (Throwable t)
		{
			
		}
		if (controls == null)
			AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_SHELL, wid.getObjectId().toString()), line);
		
		WindowCommandTarget[] windowCommandTarget = new WindowCommandTarget[controls.length];
		for (int i = 0; i < controls.length; i++)
		{
			if (controls[i].isDisposed())
				AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_SHELL_DIS, wid.getObjectId().toString()), line);
			windowCommandTarget[i] = new WindowCommandTarget(controls[i], window);
		}
			
		return windowCommandTarget;
	}

	private static CommandTarget locateToolItem(ICoolBarManager coolMng, WidgetIdentifier wid, int line)
	{
		IContributionItem[] items = coolMng.getItems();
		for (int i = 0; i < items.length; i++)
		{
			if (items[i] instanceof ToolBarContributionItem)
			{
				ToolBarContributionItem item = (ToolBarContributionItem) items[i];
				IToolBarManager toolMng = item.getToolBarManager();
				CommandTarget target = locateToolItem((ToolBarManager) toolMng, wid, line);
				if (target != null)
					return target;
			}
		}
		return null;
	}
	
	private static CommandTarget locateToolItem(ToolBarManager toolMng, WidgetIdentifier wid, int line)
	{
		return locateToolItem(toolMng.getControl(), wid, line);
	}
	

	private static CommandTarget locateToolItem(Shell shell, WidgetIdentifier wid, int line) throws CoreException
	{
		CommandTarget target = null;
		try
		{
			Object data = shell.getData();			
			if (data instanceof ApplicationWindow)
			{
				ApplicationWindow window = (ApplicationWindow) data;
				CoolBarManager coolMng = window.getCoolBarManager();
				if (coolMng != null)
				{
					target = locateToolItem(coolMng, wid, line);
				}
				ToolBarManager toolMng = window.getToolBarManager();
				if (toolMng != null)
				{
					target = locateToolItem(toolMng, wid, line);
				}
			}
		}
		catch (Throwable t)
		{
			/* The next line will throw an exception */
			target = null;
		}
		if (target == null)
			AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_TOOL, wid.getObjectId().toString()), line);
		return target;
	}

	private static CommandTarget locateToolItem(ToolBar toolBar, WidgetIdentifier wid, int line)
	{
		if (toolBar == null)
			return null;
		ToolItem[] items = toolBar.getItems();
		for (int i = 0; i < items.length; i++)
		{
			ToolItem item = items[i];
			if (foundItem(item, wid.getResolverId(), wid.getObjectId().toString()))
				return new CommandTarget(item, toolBar);
		}
		return null;
	}


	/**
	 * Used to located the view part with the passed id.
	 * 
	 * @param shell
	 *            The current shell
	 * @param id
	 *            The id of the view part
	 * @param line
	 *            The line number of the script (used to indicate the line
	 *            number if we throw a core exception. Mark as -1 if a script is
	 *            not being used)
	 * 
	 * @return The view part with the passed 'id'
	 * 
	 * @throws CoreException
	 *             If the view part cannot be located.
	 */
	public static IViewPart locateView(Shell shell, String id, int line) throws CoreException
	{
		try
		{
			Object data = shell.getData();
	
			if (data instanceof IWorkbenchWindow)
			{
				IWorkbenchWindow window = (IWorkbenchWindow) data;				
				IWorkbenchPage page = window.getActivePage();
				if (page != null)
				{
					IViewPart view = page.findView(id);
				
					if (view == null)
					{
						try
						{
							view = page.showView(id);
							
						}
						catch (PartInitException pie)
						{
							/* Do a thorough search */												
							IWorkbenchWindow[] windows = GuiPlugin.getDefault().getWorkbench().getWorkbenchWindows();
							
							/* For every workbench window */
							for (int i = 0; i < windows.length && view == null; i++)
							{
								/* For every page of a workbench window */
								IWorkbenchPage[] pages = windows[i].getPages();
								for (int j = 0; j < pages.length && view == null; j++)
								{
									view = pages[j].findView(id);
									
								}
							}
							//need to mke sure that even if it is found in another page, we show it.
							
						}
				}
					// added for defcet 175320 in order to ensure the page is 
					//given focus no matter where it is found
					page.showView(id);
					return view;
				}
		}
		}
		catch (Throwable t)
		{
			/* The next line will throw an exception */
		}
		AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_VIEW, id), line);
		return null;
	}

	private static ViewCommandTarget[] locateViewControl(Shell shell, String id, WidgetIdentifier wid, int line) throws CoreException
	{
		Control[] controls = null;
		try
		{
			IViewPart view = locateView(shell, id, line);
			if (view != null)
			{
				Composite c = getWorkbenchPartControl(view);
				controls = locateVisibleChild((Composite) c, null, wid);
				// controls will never be null but might be empty
				// This way the error is caught here and will reflect the view not found
				if (controls.length >0)
				{
					ViewCommandTarget[] viewCommandTarget = new ViewCommandTarget[controls.length];
					for (int i = 0; i < controls.length; i++)
					{
						viewCommandTarget[i] = new ViewCommandTarget(controls[i], view);
					}
					return viewCommandTarget;
				}
			}
		}
		catch (Throwable t)
		{
			
		}
		AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_VIEW_CON, wid.getObjectId().toString()), line);
		return null;
	}

	private static Control[] locateVisibleChild(Composite parent, Composite skip, WidgetIdentifier widgetId)
	{
		int[] counter = new int[1];
		counter[0] = 0;
		String wid = widgetId.getObjectId().toString();
		int sloc = wid.indexOf('#');
		String wclassName = null;
		if (sloc != -1)
			wclassName = wid.substring(0, sloc);
		
		/* https://bugs.eclipse.org/bugs/show_bug.cgi?id=147766: We need to return all possible matches */
		Vector matches = new Vector();
		Vector indices = new Vector();
		locateVisibleChild(parent, skip, widgetId, wclassName, counter, matches, indices);
		Control[] matchedControls = new Control[matches.size()];
		matches.toArray(matchedControls);
		return matchedControls;
	}

	private static Control locateVisibleChild(Composite parent, Composite skip, WidgetIdentifier id, String wclassName, int[] index, Vector matches, Vector indices)
	{
		return MacroUtil.recursiveSearch(parent, skip, null, id, wclassName, index, matches, indices);
	}

	private static WizardCommandTarget[] locateWizardControl(Shell shell, WidgetIdentifier wid, int line) throws CoreException
	{
		WizardDialog wdialog  = null;
		Control[] controls  = null;
		try
		{
			wdialog = (WizardDialog) shell.getData();
			IWizardPage page = wdialog.getCurrentPage();
			Composite pparent = (Composite) page.getControl();
			controls = locateVisibleChild(shell, pparent, wid);
		}
		catch (Throwable t)
		{
			
		}
		if (controls == null)
			AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_WIZARD, wid.getObjectId().toString()), line);
		
		WizardCommandTarget[] wizardCommandTarget = new WizardCommandTarget[controls.length];
		for (int i = 0; i < controls.length; i++)
		{
			if (controls[i].isDisposed())
				AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_SHELL_DIS, wid.getObjectId().toString()), line);
			wizardCommandTarget[i] = new WizardCommandTarget(controls[i], wdialog);
		}
			
		return wizardCommandTarget;		
	}

	private static WizardCommandTarget[] locateWizardPageControl(Shell shell, String id, WidgetIdentifier wid, int line) throws CoreException
	{
		Control[] controls = null;
		try
		{
			Object data = shell.getData();
			if (data instanceof WizardDialog)
			{
				WizardDialog wdialog = (WizardDialog) data;
				IWizardPage page = wdialog.getCurrentPage();
				// assert page
				// if (pname.equals(id)==false)
				// throwCoreException("Unexpected wizard page: "+pname+", expected
				// "+id, line);
				Composite pparent = (Composite) page.getControl();
				controls = locateVisibleChild(pparent, null, wid);
				if (controls != null)
				{
					WizardCommandTarget[] wizardCommandTarget = new WizardCommandTarget[controls.length];
					for (int i = 0; i < controls.length; i++)
					{
						wizardCommandTarget[i] = new WizardCommandTarget(controls[i], wdialog);
					}
					return wizardCommandTarget;
				}
			}
		}
		catch (Throwable t)
		{
			
		}
		if (controls == null)
			AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_WIZARD_CON, wid.getObjectId().toString()), line);
		return null;
	}
		
	private static void forceMenuOpen(Control c, Menu menu)
	{
		Event e = new Event();
		e.type = SWT.Show;
		e.widget = menu;

		menu.notifyListeners(e.type, e);
		MacroUtil.processDisplayEvents(menu.getDisplay());
	}

	private static void forceMenuClosed(Menu menu)
	{
		Event e = new Event();
		e.type = SWT.Hide;
		e.widget = menu;
		
		menu.notifyListeners(e.type, e);
		MacroUtil.processDisplayEvents(menu.getDisplay());
	}	
	
	
	/**
	 * If the node passed in has a reference id, then this method looks up the id in 
	 * the object mine and attempts to find the object that is referenced.
	 * 
	 * @param node Represents the XML node
	 * @param lineTable Contains line level information
	 * 
	 * @return A String[] of length 2, where String[0] = context id and String[1] = object
	 * id.  If the node does not have a reference id, then null is returned.
	 * 
	 * @throws CoreException If the node contains a reference id attribute but the 
	 * corresponding object mine does not have any such object.
	 */
	public static IUIObject lookupReferenceId(IUIObject parent, Node node, Hashtable lineTable) throws CoreException
	{
		String referenceId =  MacroUtil.getAttribute(node, MacroConstants.REFERENCE_ID_ATTRIBUTE);
		if (referenceId == null)
			return null;
		
		IUIObject correspondingObject = MacroManager.getInstance().getObjectMine().lookupUIObject(parent, referenceId);
		if (correspondingObject == null)
		{
			Integer[] lineLevelDetail = (Integer[]) lineTable.get(node);
			AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_OBJ_MINE_NF, referenceId), lineLevelDetail == null ? 0 : lineLevelDetail[0].intValue());
		}
		else
		{
			return correspondingObject;
		}
		
		/* Code not reached beyond this point */
		return null;
	}
	
	
	/**
	 * We have to use internal APIs here to get the controls of a part
	 */
	public static Composite getWorkbenchPartControl (IWorkbenchPart part)
	{
		IWorkbenchPartTestable testable = (IWorkbenchPartTestable)part.getSite().getAdapter(IWorkbenchPartTestable.class);
		return testable.getControl().getParent();
	}
	
	/**
	 * Returns true if the id computed for 'item' matches 'id'
	 * 
	 * @param item The tool item
	 * @param resolverId The resolver id -- can be null
	 * @param id The id that should be matched against
	 * @return true if there is a match, and false otherwise
	 */
	public static boolean foundItem(Item item, String resolverId, Object id) 
	{
		/* Try the widget resolvers first */
		if (foundWidget(item, resolverId, id))
			return true;
		
		/* Give the old policy a try */
		String toolItemIdStr = MacroUtil.getActionId(item).toString();
		if (toolItemIdStr != null && toolItemIdStr.equals(id))
			return true;
		
		return false;
	}

	/**
	 * Returns true iff the widget matches the id passed in.
	 * 
	 * @param widget The widget
	 * @param resolverId The resolver id -- can be null
	 * @param id The id
	 * @return true iff the widget matches the id passed in.
	 */
	public static boolean foundWidget(Widget widget, String resolverId, Object id)
	{			
		MacroManager macroManager = MacroManager.getInstance();
		Hashtable widgetResolvers = macroManager.getWidgetResolvers();
		
		if (resolverId != null)
		{
			WidgetResolverLoader loader = (WidgetResolverLoader)widgetResolvers.get(resolverId);
			if (loader != null)
				return loader.getWidgetResolver().foundWidget(widget, id);
			return false;
		}
		
		Enumeration keys = widgetResolvers.keys();
		while (keys.hasMoreElements())
		{
			if (((WidgetResolverLoader)widgetResolvers.get(keys.nextElement())).getWidgetResolver().foundWidget(widget, id))
				return true;
		}		
		return false;
	}

}




/*******************************************************************************
 * Copyright (c) 2006, 2008 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.util.Hashtable;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.hyades.models.common.facades.behavioral.impl.HyadesUtil;
import org.eclipse.hyades.test.core.util.EMFUtil;
import org.eclipse.osgi.util.NLS;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.core.IObjectMine;
import org.eclipse.tptp.test.auto.gui.internal.core.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.macro.ObjectMine.IDCollisionException;
import org.eclipse.tptp.test.auto.gui.internal.macro.ObjectMine.UIObjectNotFound;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;


/**
 * In addition to the macro of each test case, a test suite also contains an object
 * mine keeps a reference of all resolved objects.  The purpose of the object mine
 * is to resolve a widget once and use it many times. 
 * <p/>
 * This is a singleton class that can be accessed via <code>getInstance()</code>
 * <p/>
 * 
 * 
 * @author  Ali Mehregani
 * @author  Paul E. Slauenwhite
 * @version March 7, 2008
 * @since   July 10, 2006
 */
public class ObjectMineManager 
{	
	/** The instance of this class */
	private static ObjectMineManager instance = new ObjectMineManager();
		
	
	/** Cached object mines 
	 * KEY = Test suite id
	 * VALUE = An object of type IObjectMine that represents the object mine of the test suite */	
	private Hashtable cachedObjectMines;
	
	
	/** Indicates whether a test suite's object mine is dirty or not
	 * KEY = test suite id
	 * VALUE = Boolean.TRUE if object mine is dirty; Boolean.FALSE otherwise  
	 */
	private Hashtable dirtyStateTable;
	
	
	/**
	 * Restrict the visibility of the constructor
	 */
	private ObjectMineManager()
	{
		cachedObjectMines = new Hashtable();
		dirtyStateTable = new Hashtable();
	}
	
	
	/**
	 * Return the instance of this singleton class
	 * 
	 * @return The instance of this class
	 */
	public static ObjectMineManager getInstance()
	{
		return instance;
	}
	
	
	/**
	 * Load the object mine of the passed in test suite
	 * 
	 * @param testSuite The test suite whose object mine is requested
	 * @param useCache Uses the cached value if this is set to true; otherwise the
	 * object mine is reloaded and returned.
	 * 
	 * @return the object mine of the test suite that is passed in.
	 * 
	 * @throws UIObjectNotFound In case an expected object is not found
	 * @throws IDCollisionException  In case there is a collision id
	 * @throws CoreException In case of any unexpected error
	 */
	public IObjectMine loadObjectMine (ITestSuite testSuite, boolean useCache) throws UIObjectNotFound, IDCollisionException, CoreException
	{
		/* Is the object mine in cache? */
		String testSuiteId = testSuite.getId();
		IObjectMine objectMine = null;
		if (useCache && (objectMine = (IObjectMine)cachedObjectMines.get(testSuiteId)) != null)
		{
			objectMine.setOwner(testSuite);
			return objectMine;
		}
			
		
		/* Otherwise, it needs to be loaded.  We need:
		 * - Get the object mine XML fragment
		 * - Parse it and load it */
		String objectMineXML = HyadesUtil.getTestSuiteVariable(testSuite, GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE);
		if (objectMineXML == null || objectMineXML.length() <= 0)
		{
			/* Return a fresh object mine */
			objectMine = new ObjectMine(testSuite, null);			
		}
			
		if (objectMine == null)
		{
			objectMine = loadObjectMine (testSuite, objectMineXML);
		}
		
		if (objectMine != null)
		{
			cachedObjectMines.put(testSuiteId, objectMine);
		}
		
		return objectMine;
	}

	private IObjectMine loadObjectMine (ITestSuite testSuite, String objectMineXML) throws UIObjectNotFound, IDCollisionException, CoreException
	{
		if (objectMineXML == null || objectMineXML.length() <= 0)
			return new ObjectMine(testSuite, null);
		
		XMLDefaultHandler handler = null;

		try
		{
			handler = MacroUtil.createXMLDocument(new ByteArrayInputStream(objectMineXML.getBytes("UTF-8")));
		}
		catch (SAXException e)
		{
			AutoGUIUtil.throwCoreException(AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE, 0, e);
		}
		catch (IOException e)
		{
			AutoGUIUtil.throwCoreException(AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE, 0, e);
		}
			
		/* Walk through the elemets and parse the document */
		Node rootElement = handler.getDocumentElement();
		NodeList children = rootElement.getChildNodes();
		
		IObjectMine objectMine = new ObjectMine(testSuite, handler);
		for (int i = 0, childCount = children.getLength(); i < childCount; i++)
		{
			Node currentChild = children.item(i);
			String nodeName = currentChild.getNodeName();
			if (MacroConstants.HEADER_ELEMENT.equals(nodeName))
			{
				loadHeader(objectMine, currentChild);
			}
			else if (MacroConstants.OBJECTS_ELEMENT.equals(nodeName))
			{
				loadObjects (objectMine, currentChild);
			}
		}
		
		
		return objectMine;
	}
	
	
	/**
	 * This method should be used if the object mine will be loaded for reading purposes.
	 * Contributors will not be able to use this returned object mine to write any objects.
	 * 
	 * @param objectMineXML The XML string representing the object mine 
	 * 
	 * @return the object mine of the test suite that is passed in.
	 * 
	 * @throws UIObjectNotFound In case an expected object is not found
	 * @throws IDCollisionException  In case there is a collision id
	 * @throws CoreException In case of any unexpected error
	 */
	public IObjectMine loadObjectMine (String objectMineXML) throws UIObjectNotFound, IDCollisionException, CoreException
	{
		return loadObjectMine(null, objectMineXML);
	}
	
	
	private void loadHeader(IObjectMine objectMine, Node headerNode) throws CoreException, UIObjectNotFound, IDCollisionException
	{
		/* Let's first read in the contribute attribute */
		NamedNodeMap attributes = headerNode.getAttributes();
		Node contributeAtt = attributes.getNamedItem(MacroConstants.OUTPUT_ATTRIBUTE);
		if (contributeAtt != null)
		{
			ITestSuite testSuite = loadTestSuite(contributeAtt.getNodeValue());
			if (testSuite == null)
			{
				AutoGUIUtil.openErrorWithDetail(
						AutoGUIMessages.AUTO_GUI_COMMON_ERROR, 
						AutoGUIMessages.AUTO_GUI_ERROR_OBJ_MINE_OUT_NF, 
						null);
				
			}
			else
			{
				try
				{
					IObjectMine outputObjectMine = ObjectMineManager.getInstance().loadObjectMine(testSuite);
					objectMine.setOutputSource(outputObjectMine);
				} 
				catch (Exception e)
				{					
					objectMine.setOutputSource(null);
					AutoGUIUtil.openErrorWithDetail(
							AutoGUIMessages.AUTO_GUI_COMMON_ERROR, 
							NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_OBJ_MINE_OUTPUT, testSuite.getName()), 
							e);
				} 
			}			
		}
		
		/* Now load in all includes */
		NodeList children = headerNode.getChildNodes();
		for (int i = 0, childCount = children.getLength(); i < childCount; i++)
		{
			Node currentChild = children.item(i);
			String nodeName = currentChild.getNodeName();
			if (MacroConstants.INCLUDE_ELEMENT.equals(nodeName))
			{
				Node pathAttribute = currentChild.getAttributes().getNamedItem(MacroConstants.PATH_ATTRIBUTE);
				if (pathAttribute != null)
				{
					ITestSuite testSuite = loadTestSuite(pathAttribute.getNodeValue());
					IObjectMine includedObjectMine = loadObjectMine(testSuite);
					objectMine.addInclude(includedObjectMine);
				}
			}
		}
	}
	
	
	private void loadObjects(IObjectMine objectMine, Node objectsNode) throws CoreException, UIObjectNotFound, IDCollisionException 
	{
		NodeList children = objectsNode.getChildNodes();		
		registerObjects(objectMine, null, children);
	}
	
	
	private void registerObjects(IObjectMine objectMine, IUIObject parent, NodeList children) throws CoreException, UIObjectNotFound, IDCollisionException
	{
		/* For every object */
		for (int i = 0, childCount = children.getLength(); i < childCount; i++)
		{
			Node currentNode = children.item(i);	

			NamedNodeMap attributes = currentNode.getAttributes();
			Node referenceIdNode = attributes.getNamedItem(MacroConstants.REFERENCE_ID_ATTRIBUTE);
			String referenceId = null;
			if (referenceIdNode == null || (referenceId = referenceIdNode.getNodeValue()) == null)
			{
				Node idAttribute = attributes.getNamedItem(MacroConstants.ID_ATTRIBUTE);
				String objectId = idAttribute == null ? AutoGUIMessages.AUTO_GUI_COMMON_UNKNOWN : idAttribute.getNodeValue(); 
				AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE_REF, objectId), 0);
			}
				
			IUIObject guiObject = objectMine.lookupUIObject(parent, referenceId);
				
			/* Register the object if it's not yet registered */
			if (guiObject == null)
			{
				guiObject = objectMine.registerObject(parent, currentNode);
			}
			/* Otherwise throw an exception if there is an id collision */
			else
			{
				Node contextIdNode = attributes.getNamedItem(MacroConstants.CONTEXT_ID_ATTRIBUTE);
				Node objectIdNode = attributes.getNamedItem(MacroConstants.ID_ATTRIBUTE);
				String contextId = contextIdNode == null ? null : contextIdNode.getNodeValue();
				String objectId = objectIdNode.getNodeValue();
				
				if (((contextId == null && guiObject.getContextId() != null) || 
					(contextId != null && !contextId.equals(guiObject.getContextId()))) ||
					!objectId.equals(guiObject.getObjectId()))
				{
					throw new IDCollisionException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE_ID, referenceId));
				}
			}

			/* Load the children of this object */
			if (currentNode.getChildNodes().getLength() > 0)
				registerObjects(objectMine, guiObject, currentNode.getChildNodes());				
		}			
	}


	private ITestSuite loadTestSuite(String testSuitePath) throws CoreException
	{
		if (testSuitePath == null || testSuitePath.length() <= 0)
			return null;
		
		IPath path = new Path(testSuitePath);
		URI uri = URI.createPlatformResourceURI(path.toString());
		EObject[] eObjects = EMFUtil.getEObjects(uri, true);
		return eObjects != null && eObjects.length > 0 && eObjects[0] instanceof ITestSuite ? (ITestSuite)eObjects[0] : null;
	}
	
	
	public void writeObjectMine(IObjectMine objectMine)
	{
		writeObjectMine (objectMine, false);
	}
	
	private void writeObjectMine(IObjectMine objectMine, boolean autoSave)
	{
		ITestSuite testSuite = objectMine.getOwner();
		Resource testSuiteResource = ((EObject)testSuite).eResource();
		autoSave = autoSave && (testSuiteResource != null && !testSuiteResource.isModified());
		
		String xmlSerialization = objectMine.serializeToString();
		HyadesUtil.setTestSuiteVariable(testSuite, GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE, xmlSerialization);		
		
		if (autoSave)
		{			
			try
			{
				EMFUtil.save(testSuiteResource);
			} catch (Exception e)
			{
				/* Shouldn't happen */
				e.printStackTrace();
			}
		}
		
		/* We also need to update all object mines included by the object mine passed in */
		List includes = objectMine.getIncludes();
		for (int i = 0, includeCount = includes.size(); i < includeCount; i++)
		{
			IObjectMine currentObjectMine = (IObjectMine)includes.get(i);
			writeObjectMine (currentObjectMine, true);
		}
		
		
		dirtyStateTable.put(testSuite.getId(), Boolean.TRUE);
	}


	public IObjectMine loadObjectMine(ITestSuite testSuite) throws UIObjectNotFound, IDCollisionException, CoreException
	{
		Boolean dirtyState = (Boolean)dirtyStateTable.get(testSuite.getId());
		boolean isObjectMineDirty = dirtyState == null ? false : dirtyState.booleanValue();
		dirtyStateTable.put(testSuite.getId(), Boolean.FALSE);
		return loadObjectMine(testSuite, !isObjectMineDirty);
	}


	/**
	 * Marks the object mine of the passed in test suite as dirty
	 * 
	 * @param testSuite The test suite
	 */
	public void markObjectMineDirty(ITestSuite testSuite)
	{
		if (testSuite == null)
			return;
		
		dirtyStateTable.put(testSuite.getId(), Boolean.TRUE);	
	}
	
	
	/**
	 * Removes all entries in cache.
	 * This should be carefully used.
	 */
	public void clearCache()
	{
		cachedObjectMines.clear();
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;

import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.Hashtable;
import java.util.Stack;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.SubProgressMonitor;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.window.Window;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObject;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptor;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine.IDCollisionException;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine.UIObjectNotFound;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.resolver.MacroObjectResolver;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.UIObject;
import org.eclipse.ui.PlatformUI;
import org.w3c.dom.Node;

/**
 * Models a macro
 */
public class Macro implements IPersistable, IPlayable {

	public static final String SYNTAX_VERSION = "1.1";

	/* An array of shells */
	private ArrayList shells;

	/* The name of this macro */
	private String name;

	/* Keeps track of the stack of shells (This is used during recording) */
	private Stack shellStack;

	public Macro() {
		shells = new ArrayList();
	}

	public Macro(String name) {
		this();
		this.name = name;
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.tptp.test.auto.gui.internal.macro.IReadable#load(org.w3c.dom.Node,
	 *      java.util.Hashtable)
	 */
	public void load(Node node, Hashtable lineTable) throws CoreException {
		MacroCommandShell shell = new MacroCommandShell(null, null, null);
		shell.load(node, lineTable);
		shells.add(shell);
	}

	public void initializeForRecording(Display display) {
		shellStack = new Stack();
		shells.clear();
		Shell currentShell = display.getActiveShell();

		if (currentShell == null)
			return;

		/*
		 * In case we are suppose to ignore the shell, then don't add it to our
		 * stack
		 */
		Object data = currentShell.getData(MacroManager.IGNORE);

		if (data != null && data instanceof Boolean
				&& ((Boolean) data).booleanValue())
			return;

		// hook the workbench listener
		MacroUtil.hookWorkbenchPartListener(currentShell);

		pushStack(createCommandShell(currentShell));
	}

	private MacroCommandShell createCommandShell(Shell shell) {
		IMacroObjectIdentifier wi = null;
		try {
			wi = MacroObjectResolver.resolve(shell, new MacroObject(
					new UIObject(shell)));
		} catch (Exception e) {
			e.printStackTrace();
		}
		if (wi == null)
			return null;
		return new MacroCommandShell(null, shell, wi);
	}

	private boolean isCurrent(Shell shell) {
		if (shellStack.isEmpty())
			return false;
		MacroCommandShell cshell = (MacroCommandShell) shellStack.peek();
		return cshell.tracks(shell);
	}

	public void stopRecording() {
		reset();
	}

	public void addEvent(Event event) throws Exception {
		if (MacroUtil.isIgnorableEvent(event)) {
			return;
		}

		if (event.type != EventConstants.EVENT_TYPE__WORKBENCH_PART_CLOSED) {
			// hook the workbench listener, if not already registered at the
			// widget
			MacroUtil.hookWorkbenchPartListener(event.widget);
		}

		/*
		 * A new shell is in the picture now (i.e. a new shell is closed or
		 * activated). We need to modify the shell stack
		 */
		if (event.widget instanceof Shell) {
			switch (event.type) {
			case SWT.Activate:
				activateShell((Shell) event.widget);
				break;
			case SWT.Close:
				boolean stop = closeShell((Shell) event.widget);
				if (stop)
					return;
				break;
			}
		}

		// TODO: See if the following can be simplified
		/* Otherwise we have performed a command within the current shell */
		if (!(event.widget instanceof Shell)
				&& event.detail != EventConstants.EVENT_DETAIL__VERIFICATION_HOOK_INSERTION_EVENT) {
			/* Make sure that the command sent over belongs to the top shell */
			MacroCommandShell topCommandShell = getTopShell();
			if (topCommandShell != null) {
				Shell topShell = topCommandShell.getShell();
				Shell widgetShell = (!(event.widget instanceof Control) ? null
						: ((Control) event.widget).getShell());

				/*
				 * Add the event only if the widget shell could not be resolved
				 * or the widget shell is the same as the top shell
				 */
				if (widgetShell == null || topShell == widgetShell) {
					topCommandShell.addEvent(event);
				}
			}
		} else if (event.detail == EventConstants.EVENT_DETAIL__VERIFICATION_HOOK_INSERTION_EVENT) {
			MacroCommandShell topShell = getTopShell();
			/*
			 * There is a chance that the macro does not have a top shell. We'll
			 * attempt to resolve its top shell, if unsuccessful, then we'll
			 * prompt the user with an error.
			 */
			if (topShell == null && event.widget instanceof Control) {
				Event artificialEvent = new Event();
				artificialEvent.type = SWT.Activate;
				artificialEvent.display = event.widget.getDisplay();
				artificialEvent.widget = ((Control) event.widget).getShell();
				addEvent(artificialEvent);
				topShell = getTopShell();
			}
			if (topShell != null) {
				topShell.addEvent(event);
			}

		}
		return;
	}

	public void addPause() {
		MacroCommandShell topShell = getTopShell();
		if (topShell != null)
			topShell.addPause();
	}

	public MacroCommandShell getTopShell() {
		if (shellStack.isEmpty())
			return null;
		return (MacroCommandShell) shellStack.peek();
	}

	private void activateShell(Shell shell) {
		if (shell.isDisposed())
			return;

		Object data = shell.getData();
		if (data instanceof Dialog) {
			if (!isCurrent(shell)) {
				/*
				 * Before adding the shell to the stack, make sure that it is
				 * not a parent of the current shell
				 */
				MacroCommandShell parentOfCurrentShell = null;
				if (shellStack.size() - 2 >= 0) {
					parentOfCurrentShell = (MacroCommandShell) shellStack
							.get(shellStack.size() - 2);
				}

				/*
				 * If the new shell happens to be the parent of the current
				 * shell, then we just need to pop the stack
				 */
				if (parentOfCurrentShell != null
						&& parentOfCurrentShell.tracks(shell)) {
					popStack();
				} else {

					MacroCommandShell commandShell = createCommandShell(shell);

					/* Initialize for recording failed to find the top shell */
					if (getTopShell() == null) {
						pushStack(commandShell);
					} else {
						getTopShell().addCommandShell(commandShell);
						shellStack.push(commandShell);
						updateObjectMine(commandShell);
					}
				}
			}
		} else if (data instanceof Window) {
			updateStack();
			if (!isCurrent(shell)) {
				popStack();

				MacroCommandShell newCommandShell = createCommandShell(shell);
				MacroCommandShell topCommandShell = getTopShell();
				if (topCommandShell == null
						|| !topCommandShell.getMacroObjectIdentifier()
								.getObjectIdentifier().getWidgetId().equals(
										newCommandShell
												.getMacroObjectIdentifier()
												.getObjectIdentifier()
												.getWidgetId())) {
					pushStack(createCommandShell(shell));
				}
			}

		}
	}

	private void popStack() {
		if (shellStack.isEmpty())
			return;
		MacroCommandShell top = (MacroCommandShell) shellStack.pop();
		top.extractExpectedReturnCode();
		updateObjectMine(getTopShell());
	}

	private void pushStack(MacroCommandShell commandShell) {
		shellStack.push(commandShell);
		shells.add(commandShell);
		updateObjectMine(commandShell);
	}

	private void updateObjectMine(MacroCommandShell commandShell) {
		MacroObjectDescriptorMine objectMine = MacroManager.getInstance()
				.getObjectMine();
		MacroCommandShell macroCommandShell = getTopShell();
		final String SHELL = "Shell";
		MacroObjectDescriptor shellObject = null;
		if (objectMine != null && macroCommandShell != null) {
			try {
				IMacroObjectIdentifier macroShellObjectId = macroCommandShell
						.getMacroObjectIdentifier();
				shellObject = objectMine.lookupMacroObjectDescriptor(null,
						null, macroShellObjectId.getObjectIdentifier()
								.getWidgetId(), null);
				if (shellObject == null) {
					shellObject = new MacroObjectDescriptor(null);
					((MacroObjectDescriptor) shellObject)
							.setDescriptive(SHELL
									+ (macroCommandShell.getDescriptiveField() == null ? MacroConstants.EMPTY_STRING
											: ": "
													+ macroCommandShell
															.getDescriptiveField()));
					((MacroObjectDescriptor) shellObject)
							.setWidgetId(macroShellObjectId
									.getObjectIdentifier().getWidgetId());
					((MacroObjectDescriptor) shellObject)
					.setObjectId(macroShellObjectId
							.getObjectIdentifier().getObjectId());
					((MacroObjectDescriptor) shellObject)
							.setResolver(macroCommandShell
									.getMacroObjectIdentifier()
									.getObjectIdentifier().getResolverId());
					shellObject = objectMine
							.registerObject((MacroObjectDescriptor) shellObject);
				}
				objectMine.setActiveObject(shellObject);
			} catch (UIObjectNotFound e) {
				/* Shouldn't happen */
				e.printStackTrace();
			} catch (IDCollisionException e) {
				/* Shouldn't happen */
				e.printStackTrace();
			} catch (CoreException e) {
				/* Shouldn't happen */
				e.printStackTrace();
			}
		}

		/*
		 * Update the reference id of the widget identifier for the macro
		 * command shell
		 */
		if (shellObject != null) {
			// seems to be more appropriate to set the corrsponding object for
			// the shell
			commandShell.setCorrespondingMacroObjectDescriptor(shellObject);
			// CHANGED BY ANY:
			// commandShell.getWidgetId().setReferenceId(shellObject.getReferenceId());
		}
	}

	private boolean closeShell(Shell shell) {
		if (shellStack.isEmpty())
			return false;
		MacroCommandShell top = (MacroCommandShell) shellStack.peek();
		if (top.tracks(shell))
			popStack();
		return shellStack.isEmpty();
	}

	private void updateStack() {
		while (shellStack.size() > 0) {
			MacroCommandShell top = getTopShell();
			if (top.isDisposed())
				popStack();
			else
				break;
		}
	}

	public boolean playback(Display display, Shell parent,
			IProgressMonitor monitor) throws CoreException {
		reset();
		String mname = name != null ? name : "macro";
		monitor.beginTask(AutoGUIMessages.AUTO_GUI_MACRO_EXECUTING + mname
				+ " ...", shells.size());
		for (int i = 0; i < shells.size(); i++) {
			MacroCommandShell shell = (MacroCommandShell) shells.get(i);
			final Shell[] sh = new Shell[1];
			display.syncExec(new Runnable() {

				public void run() {
					sh[0] = PlatformUI.getWorkbench()
							.getActiveWorkbenchWindow().getShell();
				}
			});
			try {
				boolean result = shell.playback(display, sh[0],
						new SubProgressMonitor(monitor, 1));
				if (!result)
					return false;
			} catch (CoreException e) {
				throw e;
			}
		}
		return true;
	}

	private void reset() {
		shellStack = null;
	}

	public void write(int indent, PrintWriter writer) {
		StringBuffer sb = new StringBuffer();
		write(indent, sb);
		writer.write(sb.toString());
	}

	public void write(int indent, StringBuffer sb) {
		/* Add <macro version="..." */
		MacroUtil.addElement(sb, indent, MacroConstants.MACRO_ELEMENT, false,
				false);
		MacroUtil.addAttribute(sb,
				new String[] { MacroConstants.VERSION_ATTRIBUTE },
				new String[] { SYNTAX_VERSION }, false, true);

		int cindent = 1;
		/* For every macro command shell */
		for (int i = 0; i < shells.size(); i++) {
			MacroCommandShell cshell = (MacroCommandShell) shells.get(i);
			cshell.write(cindent, sb);
		}
		MacroUtil.addElement(sb, 0, MacroConstants.MACRO_ELEMENT, true, true);
	}

	public String getName() {
		return name;
	}

	public void writeStart(int indent, StringBuffer writer) {
		/* Doesn't need to be implemented */
	}

	public void writeFinish(int indent, StringBuffer writer) {
		/* Doesn't need to be implemented */
	}

	public int getShellStackSize() {
		return shellStack.size();
	}

}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;

import java.util.Hashtable;
import java.util.Map;

import org.eclipse.core.runtime.CoreException;
import org.w3c.dom.Node;

/**
 * Provides an abstract implementation of {@link IMacroInstruction}. Contributors can subclass {@link AbstractMacroInstruction} or provide a direct
 * implementaion of {@link IMacroInstruction}.
 * 
 * @author Ali Mehregani
 */
public abstract class AbstractMacroInstruction implements IMacroInstruction {

	/** The line range of this macro instruction relative to the macro script */
	private int[] range;

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.macro.IMacroInstruction#load(org.w3c.dom.Node, java.util.Hashtable)
	 */
	public void load(Node node, Hashtable lineTable) throws CoreException {
		bindSourceLocation(node,
			lineTable);
	}

	/**
	 * Binds the line details with this macro instruction
	 * 
	 * @param node
	 *            The node of this instruction
	 * @param lineTable
	 *            The line level information
	 */
	protected void bindSourceLocation(Node node, Map lineTable) {
		Integer[] lines = (Integer[]) lineTable.get(node);
		if (lines != null) {
			range = new int[2];
			range[0] = lines[0].intValue();
			range[1] = lines[1].intValue();
		}
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.macro.IMacroInstruction#getStartLine()
	 */
	public int getStartLine() {
		if (range == null)
			return -1;
		return range[0];
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.macro.IMacroInstruction#getStopLine()
	 */
	public int getStopLine() {
		if (range == null)
			return -1;
		return range[1];
	}

	
        return range[0];
    }
    
    
    /**
     * @see org.eclipse.tptp.test.auto.gui.internal.core.IMacroInstruction#getStopLine()
     */
    public int getStopLine() 
    {
        if (range == null)
            return -1;
        return range[1];
    }
 
    
    /**
     * @see org.eclipse.tptp.test.auto.gui.internal.core.IMacroInstruction#getCorrespondingObject()
     */
    public IUIObject getCorrespondingObject()
    {
    	return uiObject;
    }
    
    
    /**
     * @see org.eclipse.tptp.test.auto.gui.internal.core.IMacroInstruction#setCorrespondingObject(org.eclipse.tptp.test.auto.gui.internal.core.IUIObject)
     */
    public void setCorrespondingObject(IUIObject uiObject)
    {
    	this.uiObject = uiObject;
    }
    
    
    /**
     * @see org.eclipse.tptp.test.auto.gui.internal.core.IMacroInstruction#getWidgetId()
     */
	public WidgetIdentifier getWidgetId()
	{
		return widgetId;
	}
		
	
	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.core.IMacroInstruction#setWidgetId(org.eclipse.tptp.test.auto.gui.internal.core.WidgetIdentifier)
	 */
	public void setWidgetId(WidgetIdentifier widgetIdentifier)
	{
		this.widgetId = widgetIdentifier;
	}
}




/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;


/**
 * Defines macro constants used to construct the macro
 * 
 * @author Ali Mehregani
 */
public class MacroConstants 
{	
	/** Common constants */
	public static final String OPEN_ANGLE_BRACKET = "<";
	public static final String CLOSE_ANGLE_BRACKET = ">";
	public static final String FORWARD_SLASH = "/";
	public static final String EQUAL_SIGN = "=";
	public static final String EMPTY_STRING = "";
	public static final String SINGLE_SPACE = " ";
	public static final String DOUBLE_QUOTE = "\"";
	public static final String TRUE_VALUE = "true";
	public static final String FALSE_VALUE = "false";
	
	/** XML Elements */
	public static final String MACRO_ELEMENT = "macro";
	public static final String SHELL_ELEMENT = "shell";
	public static final String COMMAND_ELEMENT = "command";	
	public static final String OBJECT_MINE_ELEMENT = "object-mine";
	public static final String HEADER_ELEMENT = "header";
	public static final String INCLUDE_ELEMENT = "include";
	public static final String OBJECTS_ELEMENT = "objects";
	public static final String OBJECT_ELEMENT = "object";	
	public static final String ITEM_ELEMENT = "item";
	public static final String SELECT_ITEM_ELEMENT = "selected-item";
	//ANy: was never used: public static final String PARENT_ELEMENT = "parent";

	/** XML Attributes */
	public static final String DESCRIPTIVE_ATTRIBUTE = "descriptive";
	public static final String TYPE_ATTRIBUTE = "type";
	public static final String CONTEXT_ID_ATTRIBUTE = "contextId";
	public static final String WIDGET_ID_ATTRIBUTE = "widgetId";
	public static final String OBJECT_ID_ATTRIBUTE = "objectId";
	public static final String ID_ATTRIBUTE = "id";
	public static final String RETURN_CODE_ATTRIBUTE = "return-code";
	public static final String TIME_TO_WAIT_ATTRIBUTE = "time-to-wait";
	public static final String OUTPUT_ATTRIBUTE = "output";
	public static final String PATH_ATTRIBUTE = "path";
	public static final String REFERENCE_ID_ATTRIBUTE = "referenceId";
	public static final String RESOLVER_ID_ATTRIBUTE = "resolverId";	
	public static final String VERSION_ATTRIBUTE = "version";
	public static final String X_COORD_ATTRIBUTE = "x-coord";
	public static final String Y_COORD_ATTRIBUTE = "y-coord";
	public static final String DETAIL_ATTRIBUTE = "detail";
	public static final String SELECTION_ATTRIBUTE = "selection";
	public static final String VALUE_ATTRIBUTE = "value";
	public static final String CHOICE_ID_ATTRIBUTE = "choiceId";
	public static final String LOCATION_ATTRIBUTE = "location";
	public static final String RESOURCE_ATTRIBUTE = "resource";
	public static final String HOOK_ATTRIBUTE = "hook";
	public static final String IS_CHAR_SET_ATTRIBUTE = "ischarset";
	
	/** Values */
	public static final String VIEW_VALUE = "view";
	public static final String EDITOR_VALUE = "editor";
	public static final String SHELL_VALUE = "shell";
	public static final String MENUS_VALUE = "menus";
	public static final String POPUP_VALUE = "popup";
	public static final String LOCAL_TOOLBAR_MENU_VALUE = "local-toolbar-menu";
	public static final String TOOLBAR_VALUE = "toolbar";
	public static final String LOCAL_TOOLBAR_VALUE = "local-toolbar";
	public static final String TAB_VALUE = "tab"; // ANy: introduced for TabItems and CTabItems
	public static final String WIZARD_VALUE = "wizard";
	public static final String WIZARD_PAGE_VALUE = "wizard-page";
	
	
	public static final String RESOLVER_ID_SUFFIX_SEPARATOR = "@@@";
	public static final String WIDGET_ID_SUFFIX_SEPARATOR = "%%%";
	public static final String OBJECT_ID_SUFFIX_SEPARATOR = "$$$";
	public static final String WIDGET_ID_UNIQUENESS_INDEX_SEPARATOR = "!!!";
	
	
	
}




/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;

import java.util.ArrayList;
import java.util.Hashtable;
import java.util.LinkedList;
import java.util.Map;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.osgi.util.NLS;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.commands.AbstractMacroCommand;
import org.eclipse.tptp.test.auto.gui.internal.core.IObjectMine;
import org.eclipse.tptp.test.auto.gui.internal.core.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.core.WidgetIdentifier;

public class UIObject implements IUIObject
{
	/** The context id */
	private String contextId;
	
	/** The id of the object being resolved */
	private String objectId;
	
	/** The reference id of this UI object */
	private String referenceId;
	
	/** The descriptive attribute (a human readable identification) of this UI object */
	private String descriptive;
	
	/** Keeps track of the hierarchical relationship */
	private LinkedList hierarchicalRelation;
	
	/** The parent of this UI object */
	private IUIObject parent;
	
	/** The properties of this UI Object */
	private Hashtable properties;

	/** The id of the resolver that has resolved this object */
	private String resolverId;
	
	/** The children of this object */
	private ArrayList children;

	/** The associated data of this object */
	private Object data;
	
	/** Children indexed based on their reference id
	 * KEY = Reference id
	 * VALUE = IUIObject that is a child of this object
	 */
	private Hashtable idIndexedChildren;
	
	public UIObject(IUIObject parent)
	{
		this.parent = parent;
		properties = new Hashtable();
		children = new ArrayList();
		idIndexedChildren = new Hashtable();
	}
	
	
	/**
	 * Creates an instace of this class based on a command passed in.
	 * 
	 * @param objectMine The object mine that this object will be registered with
	 * @param command The command that this object will be based on
	 * @param parent The parent of this object
	 * 
	 * @return An instance of this class based on widgetIdentifier 
	 */
	public static IUIObject createInstance(IObjectMine objectMine, AbstractMacroCommand command, IUIObject parent)
	{
		WidgetIdentifier widgetIdentifier = command.getWidgetId();
		IUIObject uiObject = new UIObject (parent);
		uiObject.setContextId(widgetIdentifier.getContextId() != null ? widgetIdentifier.getContextId().toString() : MacroConstants.EMPTY_STRING);
		uiObject.setObjectId(widgetIdentifier.getObjectId().toString());
		uiObject.setReferenceId(objectMine.getUniqueReferenceId());
		uiObject.setDescriptive(command.getDescriptiveField());
		uiObject.setResolver(widgetIdentifier.getResolverId());
				
		return uiObject;
	}
	
	
	public String getContextId()
	{
		return contextId;
	}

	public String getDescriptive()
	{
		return descriptive;
	}

	public LinkedList getHierarchicalRelation()
	{
		if (hierarchicalRelation != null)
			return hierarchicalRelation;
		
		hierarchicalRelation = new LinkedList();
		findHierarchicalRelation(this);
		
		return hierarchicalRelation;
	}
	
	private void findHierarchicalRelation(IUIObject currentObject)
	{
		if (currentObject == null)
			return;
		hierarchicalRelation.addFirst(currentObject);
		findHierarchicalRelation(currentObject.getParent());
	}

	public String getObjectId()
	{
		return objectId;
	}

	public Map getProperties()
	{
		return properties;
	}

	public String getProperty(String name)
	{
		return (String)properties.get(name);
	}

	public String getReferenceId()
	{
		return referenceId;
	}

	public void setContextId(String contextId)
	{
		this.contextId = contextId;
	}

	public void setDescriptive(String descriptive)
	{
		this.descriptive = descriptive;
	}

	public void setObjectId(String id)
	{
		this.objectId = id;
	}

	public void addProperty(String name, String value)
	{
		properties.put(name, value);
	}

	public void setReferenceId(String referenceId)
	{
		this.referenceId = referenceId;
	}
	
	public IUIObject getParent()
	{
		return parent;
	}

	public void setParent(IUIObject parent)
	{
		this.parent = parent;
	}


	public String getResolverId()
	{		
		return resolverId;
	}


	public void setResolver(String resolverId)
	{
		this.resolverId = resolverId;
	}


	public void addChild(IUIObject child) throws CoreException
	{
		if (!children.contains(child))
		{
			try
			{
				/* If there is a collision, then try to resolve it */
				int referenceId = Integer.parseInt(child.getReferenceId());
				while (idIndexedChildren.get(child.getReferenceId()) != null)
				{
					referenceId++; 
				}
				child.setReferenceId(String.valueOf(referenceId));
			}
			catch (NumberFormatException nfe)
			{
				/* Ignore the error */
			}
			
			/* If there is still a collision, then throw an exception */
			if (idIndexedChildren.get(child.getReferenceId()) != null)
				AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE_ID, child.getReferenceId()));
			
			idIndexedChildren.put(child.getReferenceId(), child);
			children.add(child);
		}
	}


	public int childCount()
	{
		return children.size();
	}


	public IUIObject[] getChildren()
	{
		IUIObject[] objects = new IUIObject[children.size()];
		children.toArray(objects);
		return objects;
	}


	public IUIObject removeChild(IUIObject child)
	{
		children.remove(child);
		return child;
	}


	public Object getData()
	{
		return data;
	}


	public void setData(Object data)
	{
		this.data = data;
	}


	public IUIObject findChild(String referenceId)
	{
		return (IUIObject) idIndexedChildren.get(referenceId);
	}
}




/********************************************************************** 
 * Copyright (c) 2005, 2009 IBM Corporation 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         
 * $Id: AutoGUIMessages.java,v 1.24 2008/07/14 19:18:57 paules Exp $ 
 * 
 * Contributors: 
 * IBM - Initial API and implementation 
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal;

import org.eclipse.osgi.util.NLS;

/**
 * AGR resource bundle.
 * <p>
 * 
 * 
 * @author      Paul E. Slauenwhite
 * @author      Alexander Nyssen
 * @version     July 14, 2008
 * @since       August 19, 2005
 */
public class AutoGUIMessages extends NLS {

	private static final String BUNDLE_NAME = "org.eclipse.tptp.test.auto.gui.internal.messages";//$NON-NLS-1$
	
	private AutoGUIMessages() {
		// Do not instantiate
	}
	
	public static String AUTO_GUI_COMMON_UNKNOWN;
	
	public static String AUTO_GUI_WIZARD_SRC_PAGE_TITLE;
	public static String AUTO_GUI_WIZARD_SUITE_PG_TTL;
	public static String AUTO_GUI_WIZARD_LOC_PG_DSC;
	public static String AUTO_GUI_WIZARD_ATT_PG_DSC;

	public static String TST_SUITE_AUTO_GENERAL_TITLE;
	
	public static String TST_SUITE_AUTO_OVERVIEW_OPT;		
	public static String TST_SUITE_AUTO_OVERVIEW_CTX_WS;
	public static String TST_SUITE_AUTO_OVERVIEW_CTX;
	public static String TST_SUITE_AUTO_OVERVIEW_BROWSE; 
	public static String TST_SUITE_AUTO_OVERVIEW_OPEN;	
	public static String TST_SUITE_AUTO_OVERVIEW_SRC_LNK;
	public static String TST_SUITE_AUTO_OVERVIEW_CONFIG_T;
	public static String TST_SUITE_AUTO_OVERVIEW_WS_C;
	public static String TST_SUITE_AUTO_OVERVIEW_ECL_LOC;
	public static String TST_SUITE_AUTO_OVERVIEW_WS_LOC;
	public static String TST_SUITE_AUTO_OVERVIEW_WS_VAR;
	public static String TST_SUITE_AUTO_OVERVIEW_JVM_ARG;
		
	public static String TST_SUITE_AUTO_BEHAVIOR_UI;		
	public static String TST_SUITE_AUTO_BEHAVIOR_LTD;	
	public static String TST_SUITE_AUTO_BEHAVIOR_LTCI;
	public static String TST_SUITE_AUTO_BEHAVIOR_BL;
	public static String TST_SUITE_AUTO_BEHAVIOR_TIMEOUT;
	public static String TST_SUITE_AUTO_BEHAVIOR_TIME_T;
	public static String TST_SUITE_AUTO_BEHAVIOR_TIME;
	
	public static String TST_SUITE_AUTO_MACRO_TESTS;
	public static String TST_SUITE_AUTO_MACRO_MACRO;
	public static String TST_SUITE_AUTO_MACRO_LINE_NUM;
	public static String TST_SUITE_AUTO_MACRO_DELETE;
	public static String TST_SUITE_AUTO_MACRO_REFRESH;
	public static String TST_SUITE_AUTO_MACRO_SHELL;
	public static String TST_SUITE_AUTO_MACRO_SECONDS;
	public static String TST_SUITE_AUTO_MACRO_RECORD;
	public static String TST_SUITE_AUTO_MACRO_UP;
	public static String TST_SUITE_AUTO_MACRO_DOWN;
	public static String TST_SUITE_AUTO_MACRO_OBJ_MINE;
	public static String TST_SUITE_AUTO_MACRO_OBJ_OBJECT;
	public static String TST_SUITE_AUTO_MACRO_MESSAGE;
	public static String TST_SUITE_AUTO_MACRO_INSTRUCTION;
	public static String TST_SUITE_AUTO_MACRO_TEST_CASE;
	public static String TST_SUITE_AUTO_MACRO_UPDATE;
	public static String TST_SUITE_AUTO_MACRO_FIND;
	
	public static String AUTO_GUI_EDT_QUICK_RUN_TOOL_TIP; 

	public static String AUTO_GUI_TST_CASE_UPDATE_TITLE;
	public static String AUTO_GUI_TST_CASE_UPDATE;
	public static String AUTO_GUI_TST_CASE_NO_UPDATE;
	
	public static String AUTO_GUI_NEW_TEST_CASE;          
	public static String AUTO_GUI_NEW_DIALOG_NAME; 	
	public static String AUTO_GUI_NEW_DIALOG_DESC;		
	public static String AUTO_GUI_NEW_DIALOG_STPT;				
	public static String AUTO_GUI_NEW_DIALOG_DEFAULT_NAME;
	public static String AUTO_GUI_NEW_DIALOG_OPTIONS;
	public static String AUTO_GUI_NEW_DIALOG_USE_OM;
	public static String AUTO_GUI_NEW_DIALOG_USE_TC;
	
	public static String AUTO_GUI_COMMON_OK;			
	public static String AUTO_GUI_COMMON_CANCEL;
	public static String AUTO_GUI_COMMON_COPY;
	public static String AUTO_GUI_COMMON_ERROR;
	public static String AUTO_GUI_COMMON_INFORMATION;

	public static String AUTO_GUI_DP_DIALOG_DP_SHELL_T;	
	public static String AUTO_GUI_DP_DIALOG_DP_AVAIL_LBL; 
	public static String AUTO_GUI_DP_DIALOG_DP_NAME_COL;	
	public static String AUTO_GUI_DP_DIALOG_DPC_CONTENT;	
	public static String AUTO_GUI_DP_DIALOG_DPC_VAR_COL;	
	public static String AUTO_GUI_DP_DIALOG_DPC_VAR_N_COL;
	
	public static String AUTO_GUI_CILINK_DIALOG_SHELL_T;	
	public static String AUTO_GUI_CILINK_DIALOG_ADD_VAR;
	public static String AUTO_GUI_CILINK_VAR_CONTEXT_WS;
	public static String AUTO_GUI_CILINK_VAR_TS_PROJECT;
	
	public static String AUTO_GUI_TST_DIALOG_TREE_LABEL;
	public static String AUTO_GUI_TST_DIALOG_TREE_ITITLE;
	public static String AUTO_GUI_TST_DIALOG_TREE_INCL;
	public static String AUTO_GUI_TST_DIALOG_TREE_OUPUT;
	
	public static String AUTO_GUI_MACRO_EXECUTING;		
	public static String AUTO_GUI_MACRO_WAITING;			

	public static String AUTO_GUI_ERROR_DP_PROJ_NF;		
	public static String AUTO_GUI_ERROR_DP_DATAPOOL_LD_T;	
	public static String AUTO_GUI_ERROR_DP_DATAPOOL_LD;	
	public static String AUTO_GUI_ERROR_DP_NO_SELECT_T;	
	public static String AUTO_GUI_ERROR_DP_NO_SELECT;		
	public static String AUTO_GUI_ERROR_DP_DATAPOOL;		
	public static String AUTO_GUI_ERROR_DP_RECORD_NO;		
	public static String AUTO_GUI_ERROR_DP_VARIABLE_NAME; 
	public static String AUTO_GUI_ERROR_DP_NOT_FOUND;
	public static String AUTO_GUI_ERROR_DP_DATAPOOL_NF_T;
	public static String AUTO_GUI_ERROR_DP_DATAPOOL_NF;

	public static String AUTO_GUI_ERROR_DIALOG_TST_INCL;
	
	public static String AUTO_GUI_ERROR_NEW_NOT_PLUGIN;	
	public static String AUTO_GUI_ERROR_NEW_NOT_SRC;

	public static String AUTO_GUI_ERROR_PERS_SWITCH_TITLE;
	public static String AUTO_GUI_ERROR_PERS_SWITCH;		

	public static String AUTO_GUI_ERROR_MACRO_REC_TITLE;
	public static String AUTO_GUI_ERROR_MACRO_REC;
	public static String AUTO_GUI_ERROR_MACRO_STOP_TITLE; 
	public static String AUTO_GUI_ERROR_MACRO_STOP;		
	public static String AUTO_GUI_ERROR_MACRO_GENERATE_T;	
	public static String AUTO_GUI_ERROR_MACRO_GENERATE;	
	public static String AUTO_GUI_ERROR_MACRO_RUNNING_T;	
	public static String AUTO_GUI_ERROR_MACRO_RUNNING;	
	public static String AUTO_GUI_ERROR_MACRO_INITIALIZE;
	public static String AUTO_GUI_ERROR_MACRO_UNCAP_T;	
	public static String AUTO_GUI_ERROR_MACRO_UNCAP;		
	public static String AUTO_GUI_ERROR_MACRO_COMMAND;	
	public static String AUTO_GUI_ERROR_MACRO_MENU;		
	public static String AUTO_GUI_ERROR_MACRO_TOOL;		
	public static String AUTO_GUI_ERROR_MACRO_TOOL_BAR;	
	public static String AUTO_GUI_ERROR_MACRO_TAB;
	public static String AUTO_GUI_ERROR_MACRO_WIZARD;		
	public static String AUTO_GUI_ERROR_MACRO_WIZARD_CON; 
	public static String AUTO_GUI_ERROR_MACRO_SHELL;		
	public static String AUTO_GUI_ERROR_MACRO_SHELL_DIS;	
	public static String AUTO_GUI_ERROR_MACRO_VIEW;		
	public static String AUTO_GUI_ERROR_MACRO_VIEW_CON;	
	public static String AUTO_GUI_ERROR_MACRO_EDITOR;		
	public static String AUTO_GUI_ERROR_MACRO_EDITOR_CON; 
	public static String AUTO_GUI_ERROR_MACRO_GENERAL;	
	public static String AUTO_GUI_ERROR_MACRO_MISS_SP_T;	
	public static String AUTO_GUI_ERROR_MACRO_MISS_SP;	
	public static String AUTO_GUI_ERROR_MACRO_PARSING;	
	public static String AUTO_GUI_ERROR_MACRO_TIME_OUT;
	public static String AUTO_GUI_ERROR_MACRO_NEST_TOUT;
	public static String AUTO_GUI_ERROR_MACRO_DISABLE;
	public static String AUTO_GUI_ERROR_MACRO_ITEM;

	public static String AUTO_GUI_ERROR_OBJ_MINE_NF;
	public static String AUTO_GUI_ERROR_OBJ_MINE_OUTPUT;
	public static String AUTO_GUI_ERROR_OBJ_MINE_OUT_NF;
	
	public static String AUTO_GUI_ERROR_VER_NOT_SUPP_CON;
	public static String AUTO_GUI_ERROR_VER_WRONG_EVENT;	
	public static String AUTO_GUI_ERROR_VER_INVALID_NM_T; 
	public static String AUTO_GUI_ERROR_VER_INVALID_NM;	
	public static String AUTO_GUI_ERROR_VER_GEN_SRC_T;	
	public static String AUTO_GUI_ERROR_VER_GEN_SRC;	
	public static String AUTO_GUI_ERROR_VER_GEN_METHOD_T;	
	public static String AUTO_GUI_ERROR_VER_GEN_METHOD;	
	public static String AUTO_GUI_ERROR_VER_TOP_SHELL_T;	
	public static String AUTO_GUI_ERROR_VER_TOP_SHELL;	
	public static String AUTO_GUI_ERROR_VER_CONTEXT;		
	public static String AUTO_GUI_ERROR_VER_CLASS_NOT_F;	
	public static String AUTO_GUI_ERROR_VER_CLASS_NOT_FS;	
	public static String AUTO_GUI_ERROR_VER_ARG_EXCEPT;	
	public static String AUTO_GUI_ERROR_VER_INSTANTIATE;	
	public static String AUTO_GUI_ERROR_VER_DEPENDENCY_T; 
	public static String AUTO_GUI_ERROR_VER_DEPENDENCY;	
	public static String AUTO_GUI_ERROR_VER_DEPENDENCY_W; 
	public static String AUTO_GUI_ERROR_VER_METHOD_NF_T;	
	public static String AUTO_GUI_ERROR_VER_METHOD_NF;
	public static String AUTO_GUI_ERROR_VER_METHOD_NOT_F;
	public static String AUTO_GUI_ERROR_VER_METHOD_MODIF;

	public static String AUTO_GUI_ERROR_PLAYBACK_PROP_T;  
	public static String AUTO_GUI_ERROR_PLAYBACK_PROP;    
	public static String AUTO_GUI_ERROR_PLAYBACK_SCRIPT;	

	public static String AUTO_GUI_ERROR_WID_RESOLVER_T;	
	public static String AUTO_GUI_ERROR_WID_RESOLVER;		

	public static String AUTO_GUI_ERROR_TST_PATH_SEG;
	public static String AUTO_GUI_ERROR_TST_WRONG_PROJ;
	public static String AUTO_GUI_ERROR_TST_WRONG_SRC;
	public static String AUTO_GUI_ERROR_TST_OBJ_MINE_T;
	public static String AUTO_GUI_ERROR_TST_OBJ_MINE;
	public static String AUTO_GUI_ERROR_TST_OBJ_MINE_REF;
	public static String AUTO_GUI_ERROR_TST_OBJ_MINE_ID;
	public static String AUTO_GUI_ERROR_TST_OBJ_MINE_REG;
	
	public static String AUTO_GUI_ERROR_TST_MACRO_XML;
	
	public static String AUTO_GUI_CONTROL_DIALOG_TITLE; 
	public static String AUTO_GUI_CONTROL_VER_HOOK;		
	public static String AUTO_GUI_CONTROL_VER_INSERT;
	public static String AUTO_GUI_CONTROL_VER_INCLUDE_UI_OBJECT;	
	public static String AUTO_GUI_CONTROL_TERMINATE;		
	public static String AUTO_GUI_CONTROL_RESTART;
	public static String AUTO_GUI_CONTROL_POSITION_BASED;
	public static String AUTO_GUI_CONTROL_WAIT_TIME;
	public static String AUTO_GUI_CONTROL_RESTART_MSG_T;	
	public static String AUTO_GUI_CONTROL_RESTART_MSG;	
	public static String AUTO_GUI_CONTROL_CONT;			
	public static String AUTO_GUI_CONTROL_STATUS_BASE;	
	public static String AUTO_GUI_CONTROL_STATUS_REC;		
	public static String AUTO_GUI_CONTROL_STATUS_VER; 
	public static String AUTO_GUI_CONTROL_STATUS_INS;		
	public static String AUTO_GUI_CONTROL_STATUS_GEN;		
	public static String AUTO_GUI_CONTROL_STATUS_POS;
	public static String AUTO_GUI_CONTROL_STATUS_BROWSE;
	
	public static String AUTO_GUI_DETAILS_STARTPT;	
	
	public static String AUTO_GUI_UNDOABLE_TEXT_OPERATION_LABEL;
	
	public static String AUTO_GUI_ERROR_MACRO_OBJECT_RESOLVE;
	
	public static String AUTO_GUI_UI_OBJECT_IDENTIFIER_AMBIGUOUS;
	public static String AUTO_GUI_RESOLVER_IDENTIFIER_MISSING;
	
	static {
		NLS.initializeMessages(BUNDLE_NAME, AutoGUIMessages.class);
	}
}


Lines 226-228 Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/messages.properties (+7 lines)
226	AUTO_GUI_DETAILS_STARTPT = Starting Point:	226	AUTO_GUI_DETAILS_STARTPT = Starting Point:
227		227
228	AUTO_GUI_UNDOABLE_TEXT_OPERATION_LABEL = Undoable Text Operation	228	AUTO_GUI_UNDOABLE_TEXT_OPERATION_LABEL = Undoable Text Operation
		229
		230	AUTO_GUI_CONTROL_VER_INCLUDE_UI_OBJECT = Check this if you do not only want to have the context (Editor, View, Shell) but also the selected UI Object (Button, MenuItem, ...) passed as parameter to the verfication hook method.
		231	AUTO_GUI_ERROR_MACRO_TAB = Cannot locate tab item: {0}
		232	AUTO_GUI_ERROR_MACRO_OBJECT_RESOLVE = The macro object {0} could not be resolved.
		233	AUTO_GUI_UI_OBJECT_IDENTIFIER_AMBIGUOUS = The UI object with widget id {0} and object id {1} could not be unambigously identified.
		234	AUTO_GUI_RESOLVER_IDENTIFIER_MISSING = The resolver {0} did not set its id on the resolved UI object identifier.
		235




/**********************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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
 * $Id: AutoGUIUtil.java,v 1.10 2006/08/08 17:56:06 amehregani Exp $
 * 
 * Contributors: 
 * IBM - Initial API and implementation
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal;

import java.io.File;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Hashtable;
import java.util.List;
import java.util.Map;
import java.util.StringTokenizer;
import java.util.Vector;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IWorkspaceRoot;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.hyades.models.common.facades.behavioral.IImplementor;
import org.eclipse.hyades.models.common.facades.behavioral.IProperty;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.hyades.test.core.util.EMFUtil;
import org.eclipse.jdt.core.IClasspathContainer;
import org.eclipse.jdt.core.IClasspathEntry;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jface.dialogs.ErrorDialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.dnd.Clipboard;
import org.eclipse.swt.dnd.TextTransfer;
import org.eclipse.swt.dnd.Transfer;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.commands.ModifyCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.WaitCommand;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.PlatformUI;
import org.osgi.framework.Bundle;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * A primitive utility class that is commonly shared between the auto gui classes
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen
 */
public class AutoGUIUtil
{
	/**
	 * Find the plugin name from the path that is passed in
	 * 
	 * @param The classpath entry representing the plugin
	 * @return The bundle representing the plugin.  Null if it can't be
	 * recognized.
	 */
	public static String findPlugin (String path)
	{
		String currentToken;
		int inx = path.lastIndexOf('/');
		
		while (inx != -1)
		{
			currentToken = path.substring(inx + 1, path.length());
			if (currentToken.endsWith(".jar") && currentToken.length() > 4)
				currentToken = currentToken.substring(0, currentToken.length() - 4);
			int versionInx = currentToken.indexOf('_');
			if (versionInx != -1)
				currentToken = currentToken.substring(0, versionInx);
			
			Bundle bundle = Platform.getBundle(currentToken);
			if (bundle != null)
				return currentToken;
							
			path = path.substring(0, inx);
			inx = path.lastIndexOf('/');
		}
		
		return null;
	}
	
	
	/**
	 * A helper method with a dual purpose:  Used to return the classpath of the project containing the test suite
	 * and stores the required plugins of the project in 'reqPlugins'.
	 * 
	 * @param javaProject The project containing the test suite.
	 * @param reqPlugins A vector used to store the required plugins
	 * @param isClassPathReq returns the class if set; othewise null is returned.
	 * 
	 * @return The classpath of the project
	 * @throws CoreException if any errors occur in retrieving the classpath
	 */
	public static String findDependencies (IJavaProject javaProject, Vector reqPlugins, boolean isClassPathRes) throws CoreException
	{
		try
		{
			IClasspathEntry[] classpath = javaProject.getRawClasspath();
			String classPath = "";
			
			for (int i  = 0; i < classpath.length; i++)
			{
				if (classpath[i].getEntryKind() == IClasspathEntry.CPE_CONTAINER)
				{
					/* Find the required plugins of this container */
					if (classpath[i].getPath().toString().equalsIgnoreCase("org.eclipse.pde.core.requiredPlugins"))
					{
						IClasspathContainer container = JavaCore.getClasspathContainer(classpath[i].getPath(), javaProject);
						IClasspathEntry[] classEntries = container.getClasspathEntries();
						for (int j = 0; j < classEntries.length; j++)
						{
							String pluginName = AutoGUIUtil.findPlugin(classEntries[j].getPath().toString());
							if (pluginName != null)
								reqPlugins.add(pluginName);
						}																
					}
					
					/* Not interested in adding the container to our classpath */
					continue;
					
				}
				
				if (isClassPathRes)
				{
					if (i > 0 || (i == 0 && classpath[i].getPath().toString().length() > 0))
						classPath += File.pathSeparator;
					
					/* Resolve the classpath by replacing all variables with appropriate values */						
					classPath += JavaCore.getResolvedClasspathEntry(classpath[i]).getPath().toString();
				}				
			}						
			
			if (isClassPathRes)
				return classPath;
			return null;
		}
		catch (Throwable t)
		{
			Status s = new Status(IStatus.ERROR, GuiPlugin.getID(), IStatus.OK, NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_VER_DEPENDENCY, javaProject.getElementName()), t);
			throw new CoreException(s);			
		}		
	}
	
	
	public static String appendWSProjOutputFolder (String classPath) throws CoreException
	{		
		if (classPath == null)
			classPath = "";
		
		IProject[] workspaceProjects = ResourcesPlugin.getWorkspace().getRoot().getProjects();
		for (int i = 0; i < workspaceProjects.length; i++)
		{
			// fix for bug #206768 
			if (!workspaceProjects[i].isOpen())
				continue;
			
			if( workspaceProjects[i].getNature(JavaCore.NATURE_ID) == null)
				continue;
			
			IJavaProject javaProject = JavaCore.create(workspaceProjects[i]);
			
			if (javaProject == null || !javaProject.exists())
				continue;
			
			IPath classFileLocation = javaProject.getOutputLocation();
			if (classFileLocation != null)
			{
				if (classPath.length() > 0)
					classPath += File.pathSeparator; 
				classPath += ResourcesPlugin.getWorkspace().getRoot().getRawLocation() + classFileLocation.toString();
			}
		}
		
		return classPath;
	}
	
	/**
	 * Find the java project corresponding to the path.
	 *  
	 * @param path
	 */
	public static IJavaProject findJavaProject(String path)
	{
		if (path == null || path.length() <= 0)
			return null;
		
		/* Skip the first slash */
		path = path.substring(1);
		int index = path.indexOf('/');
		if (index != -1)
			path = path.substring(0, index);
		
		IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot();
		IProject location = root.getProject(path);
		
		/* The project is expected to be a java project */		
		return JavaCore.create (location);
	}
	
	
	/**
	 * Show an error message 
	 * @param title The title of the error message
	 * @param errorMsg The actual error message
	 * @param mode Can be MessageDialog.ERROR, MessageDialog.WARNING, or MessageDialog.INFORMATION
	 */
	public static void showMessage (final String title, final String errorMsg, final int mode)
	{
		final IWorkbench workbench = PlatformUI.getWorkbench();			
		workbench.getDisplay().syncExec(new Runnable() {
	    public void run() 
	    {
	    	class CustomMessageDialog extends MessageDialog
	    	{
	    		public CustomMessageDialog(Shell parentShell, String dialogTitle,
	    	            Image dialogTitleImage, String dialogMessage, int dialogImageType,
	    	            String[] dialogButtonLabels, int defaultIndex)
	    		{
	    			super (parentShell, dialogTitle, dialogTitleImage, dialogMessage, dialogImageType,
	    	            dialogButtonLabels, defaultIndex);
	    			setShellStyle(SWT.RESIZE|SWT.CLOSE);
	    		}
	    		
	    		
	    	    public void openMessageDialog(Shell parent, String title, String message, int messageType) 
	    	    {
	    	    	CustomMessageDialog dialog = new CustomMessageDialog(parent, title, null, 
	    	                message, messageType, new String[] { IDialogConstants.OK_LABEL }, 0);
	    	      
	    	        dialog.open();
	    	        return;
	    	    }	    
	    	    
	    	    /**
	    	     * We need to over-write this method in order to inject a data in that will cause the macro recorder to ignore it
	    	     */
	    		public void create() 
	    		{
	    			super.create();
	    			Shell shell = super.getShell();
	    	    	if (shell != null)
	    	    		shell.setData(MacroManager.IGNORE, Boolean.TRUE);	    			
	    		}	    	    
	    	}

    		CustomMessageDialog dummyInstance = new  CustomMessageDialog (null,null,null,null,0,null,0);	    	            
    		dummyInstance.openMessageDialog(workbench.getDisplay().getActiveShell(), title, errorMsg, mode);

	    }
	    });
	}
	
	/**
	 * Given an exception, the following method returns a string indicating the 
	 * class name, method name, and the line number that caused the exception along with
	 * the exception's message.  The values of these fields are set to 'unknown' if 
	 * this information cannot be determined.
	 * 
	 * @param throwable The Exception
	 * @return A string indicating the origin along with the message of the exception
	 */
	public static String getOriginOfException(Throwable throwable)
	{
		StackTraceElement[] stackTrace = throwable.getStackTrace();
		String className = "(unknown)", methodName = "(unknown)", lineNumber = "(unknown)";
		if (stackTrace.length > 0)
		{
			className = stackTrace[0].getClassName();
			methodName = stackTrace[0].getMethodName();
			lineNumber = String.valueOf(stackTrace[0].getLineNumber());
		}
		
		String space = "  ";
		String exceptionMessgae = (throwable.getLocalizedMessage() == null ? "" : throwable.getLocalizedMessage());
		String message = exceptionMessgae + space +
						"Class: " + className + space +
						"Method: " + methodName + space +
						"Line No.: " + lineNumber;
		return message;
	}
	
	/**
	 * Walk the dom tree and add all modifiable fields to the vector argument passed in
	 * 
	 * @param elementChildren A list of elements
	 * @param modifiableFields Stores the modifiable fields.  
	 * KEY = The command type (e.g. {@link WaitCommand#TYPE} or {@link ModifyCommand#TYPE})
	 * VALUE = An ordered list of the KEY commands that occur after elementChildren.
	 * @param orderedModifiableFields An list of the modifiable commands that occur after 
	 * elementChildren.  This is mainly used for display purposes.
	 */
	public static void walkDomTree(NodeList elementChildren, Map modifiableFields, List orderedModifiableFields) 
	{
		if (elementChildren == null)
			return;
		String waitTime = null;
		for (int i = 0, elementListSize = elementChildren.getLength(); i < elementListSize; i++)
		{
			Node node = elementChildren.item(i);			
			if (node instanceof Element)
			{
				Element commandElement= (Element)node;
				String commandType = commandElement.getAttribute(MacroConstants.TYPE_ATTRIBUTE);
				String commandTypeToAdd = null;
				
				if (ModifyCommand.TYPE.equals(commandType))
				{
					commandTypeToAdd = ModifyCommand.TYPE;
					
				}
				else if ((WaitCommand.TYPE.equals(commandType) && (waitTime = commandElement.getAttribute(MacroConstants.TIME_TO_WAIT_ATTRIBUTE)) != null && waitTime.length() > 0))
				{
					commandTypeToAdd = WaitCommand.TYPE;			
				}
				
				if (commandTypeToAdd != null)
				{
					addCommandEntry (modifiableFields, orderedModifiableFields, commandTypeToAdd, commandElement);					
				}
			}
			
			walkDomTree(node.getChildNodes(), modifiableFields, orderedModifiableFields);
		}
	}
	
	private static void addCommandEntry (Map modifiableFields, List orderedModifiableFields, String commandType, Element commandEntry)
	{
		List commandList = (List)modifiableFields.get(commandType);
		if (commandList == null)
		{
			commandList = new ArrayList();
			modifiableFields.put(commandType, commandList);
		}
		
		commandList.add(commandEntry);		
		orderedModifiableFields.add(commandEntry);
	}
	
	public static Hashtable indexProperties(List properties)
	{
		Hashtable retValue = new Hashtable();
		for (int i = 0; i < properties.size(); i++)
		{
			IProperty property = (IProperty)properties.get(i);
			if (property.getName() != null && property.getName().length() > 0)
				retValue.put(property.getName(), new Object[] {new Integer(i), property.getValue()});
		}
		return retValue;
	}
	
	
	public static Object[] parsePropertyFields(String propertyValue)
	{
		final String sepChar = "::";
		String currentField = propertyValue;
		Vector fields = new Vector (3);
		
		do
		{
			int inx = currentField.indexOf(sepChar);
			if (inx > 0 && currentField.length() > inx + 2)
			{
				fields.add (currentField.substring(0, inx));
				currentField = currentField.substring(inx + 2);
			}
			else if (currentField.length() > 0)
			{
				fields.add (currentField);
				currentField = null;
			}
		}while (currentField != null);
		
		return fields.toArray();
	}
	
	public static IProperty findProperty (List propertyList, String propertyName)
	{
		if (propertyList == null || propertyList.isEmpty())
			return null;
		
		for (int i = 0, propertyListCount = propertyList.size(); i < propertyListCount; i++)
		{
			IProperty property = (IProperty)propertyList.get(i);
			if (property.getName().equals(propertyName))
				return property;
		}
		return null;
	}
	
	public static void openErrorWithDetail(Shell parent, String title, String message, String cause)
	{
		
		class CustomErrorDialog extends ErrorDialog
		{
			private String cause;
			private static final int LIST_ITEM_COUNT = 7;
			private org.eclipse.swt.widgets.List list;
			private boolean isListDisplayed;
			private Clipboard clipboard;
			
			public CustomErrorDialog(Shell parentShell, int severity, String dialogTitle, String message, String cause) 
			{
				super (parentShell, dialogTitle, message, new Status(severity, GuiPlugin.getID(), severity, "", new Throwable(cause)), IStatus.OK | IStatus.INFO | IStatus.WARNING | IStatus.ERROR);
				this.cause = cause;
				isListDisplayed = false;
			}
			
			public void openErrorDialog()
			{
				this.open();
			}			
			
		    			
		    protected org.eclipse.swt.widgets.List createDropDownList(Composite parent) 
		    {
		    	if (isListDisplayed)
		    	{
		    		isListDisplayed = false;		    		
		    		list.dispose();
		    		return list;
		    	}
		    	
		    	isListDisplayed = true;
		    	
		    	// create the list
		    	list = new org.eclipse.swt.widgets.List(parent, SWT.BORDER | SWT.H_SCROLL | SWT.V_SCROLL | SWT.MULTI);

		    	// fill the list
		    	if (cause != null)
		    	{
			    	StringTokenizer st = new StringTokenizer (cause, "\n");
			    	String indents = "";
			    	boolean addedIndentation = false;
			    	while (st.hasMoreTokens())
			    	{
			    		String currentToken = st.nextToken();
			    		currentToken = currentToken.replace ('\r', ' ');
			    		currentToken = currentToken.trim();
			    		if (!addedIndentation && currentToken.startsWith("at"))
			    		{
			    			indents += "  ";
			    			addedIndentation = true;
			    		}
			    		else if (addedIndentation && !currentToken.startsWith("at"))
			    			addedIndentation = false;
			    		
			    		
			    		list.add(indents + currentToken);
			    	}
		    	}
		    	
		        GridData data = new GridData(GridData.HORIZONTAL_ALIGN_FILL
		                | GridData.GRAB_HORIZONTAL | GridData.VERTICAL_ALIGN_FILL
		                | GridData.GRAB_VERTICAL);
		        data.heightHint = list.getItemHeight() * LIST_ITEM_COUNT;
		        data.horizontalSpan = 2;
		        list.setLayoutData(data);
		        list.setFont(parent.getFont());
		        
		        Menu copyMenu = new Menu(list);
		        MenuItem copyItem = new MenuItem(copyMenu, SWT.NONE);
		        copyItem.addSelectionListener(new SelectionListener() {
		            /*
		             * @see SelectionListener.widgetSelected (SelectionEvent)
		             */
		            public void widgetSelected(SelectionEvent e) {
		                copyToClipboard();
		            }

		            /*
		             * @see SelectionListener.widgetDefaultSelected(SelectionEvent)
		             */
		            public void widgetDefaultSelected(SelectionEvent e) {
		                copyToClipboard();
		            }
		        });
		        copyItem.setText(AutoGUIMessages.AUTO_GUI_COMMON_COPY);
		        list.setMenu(copyMenu);
		    	
		        return list;
		    }
		    
		    private void copyToClipboard() {
		        if (clipboard != null)
		            clipboard.dispose();
		        StringBuffer clipBoardBuffer = new StringBuffer();		       
		        
		        String[] listEntrySelections = list.getSelection();
		        for (int i = 0; i < listEntrySelections.length; i++)
		        	clipBoardBuffer.append(listEntrySelections[i] + GlobalConstants.LINE_SEPARATOR);
		        clipboard = new Clipboard(list.getDisplay());
		        clipboard.setContents(new Object[] { clipBoardBuffer.toString() },
		                new Transfer[] { TextTransfer.getInstance() });
		    }


		}
				
		CustomErrorDialog errorDialog = new CustomErrorDialog (parent, IStatus.ERROR, title, message, cause);
		errorDialog.openErrorDialog();
	}
	
	public static void openErrorWithDetail(final String title, final String message, Throwable t)
	{		
		String stackTrace =getExceptionStackTrace(t);
		Throwable exceptionCause = (t.getCause() != null ? t.getCause() : t);
			
		final String cause = exceptionCause.getClass().getName() + "\n" + exceptionCause.getMessage() + "\n" + stackTrace;
		
		GuiPlugin.getDefault().getWorkbench().getDisplay().syncExec(new Runnable()
		{

			public void run() 
			{
				openErrorWithDetail(GuiPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getShell(), title, message, cause);
				
			}});
		
	}

	public static String getExceptionStackTrace(Throwable t)
	{
		Throwable throwable = findCause(t);
				
		StringWriter stackTrace = new StringWriter(); 
		throwable.printStackTrace(new PrintWriter(stackTrace));	
		
		return stackTrace.toString();
	}
	
	public static Throwable findCause (Throwable t)
	{
		Throwable cause = null;
		if (t instanceof InvocationTargetException)
			cause = ((InvocationTargetException)t).getTargetException();			
		else if (t instanceof CoreException)
			cause = ((CoreException)t).getStatus().getException();				
		
		if (cause == null)
			return t;
		return findCause(cause);
	}
	
	public static String getWorkspaceLocation ()
	{
		IPath rootpath = ResourcesPlugin.getWorkspace().getRoot().getLocation();
		String workspaceString = rootpath.toOSString();
				
		return workspaceString;
	}
	
	public static String getTestSuiteProjectLocation (ITestSuite testSuite)
	{
		String workspaceString = getWorkspaceLocation();
		
		/* Append a slash to the end if it doesn't have one */
		if (!(workspaceString.endsWith("\\") || workspaceString.endsWith("/")))
			workspaceString += File.separatorChar;
		
		IImplementor implementor = testSuite.getImplementor(); 
		String projectLocation = null;
		if (implementor != null && implementor.getLocation() != null)
		{
			IPath sourcePath = new Path(testSuite.getImplementor().getLocation());
			String projectName;
			if (sourcePath.segmentCount() > 0)
			{
				projectName = sourcePath.segment(0);
				projectLocation = workspaceString + projectName;
			}			
		}
		
		return projectLocation;
	}
	
	
	public static void throwCoreException(String message) throws CoreException
	{
		throwCoreException(message, 0, null);
	}
	
	public static void throwCoreException(String message, Throwable t) throws CoreException
	{
		throwCoreException(message, 0, t);
	}	
	
	public static void throwCoreException(String message, int line) throws CoreException
	{
		throwCoreException(message, line, null);
	}

	public static void throwCoreException(String message, int line, Throwable t) throws CoreException
	{
		if (line > 0)
			message = NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_GENERAL, new String[] {String.valueOf(line), message});
		Status s = new Status(IStatus.ERROR, GuiPlugin.getID(), IStatus.OK, message, t);
		CoreException coreException = new CoreException(s);
		if (t instanceof InvocationTargetException)
			coreException.initCause(t.getCause());
		else
			coreException.initCause(t);
		throw coreException;
	}
	
	
	/**
	 * Retuns the absolute workspace path of the test suite
	 * that is passed in
	 * 
	 * @param testSuite The test suite whose path is desired
	 * 
	 * @return the absolute workspace path of the testsuite
	 */
	public static String resolveTestSuitePath(ITestSuite testSuite)
	{
		if (testSuite == null)
			return MacroConstants.EMPTY_STRING;
		
		IFile file = EMFUtil.getWorkspaceFile((EObject)testSuite);
		return file == null ? MacroConstants.EMPTY_STRING : file.getFullPath().toString();		
	}
	
}




/*******************************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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
 * $Id: AutoGUIImages.java,v 1.14 2008/03/05 18:27:25 paules Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal;

import java.net.URL;

import org.eclipse.hyades.ui.internal.util.ImageManager;

/**
 * Auto GUI test tools image manager.
 * 
 * 
 * @author      Paul E. Slauenwhite
 * @author 		Alexander Nyssen
 * @version     March 5, 2008
 * @since       August 19, 2005
 */
public class AutoGUIImages extends ImageManager
{
	
	/**
	 * Singleton instance.
	 */
	private static AutoGUIImages instance = null;
	
	private AutoGUIImages(){
		//No-operation since a privatized constructor.
	}
	
	public static AutoGUIImages getInstance(){
		
		if(instance == null){
			
			instance = new AutoGUIImages();

			try	{
	            instance.initialize(new URL(GuiPlugin.getDefault().getBundle().getEntry("/"), "icons/full/"), GuiPlugin.getDefault().getImageRegistry()); //$NON-NLS-1$ //$NON-NLS-2$
			}
			catch(Exception e) {
				GuiPlugin.logError(e);
			}
		}
		
		return instance;
	}

	/* tool16 */
	public static final String IMG_NEW_AUTO_GUI					= "new_atestsuite.gif"; 
	public static final String OBJECT_MINE						= "object_mine.gif"; 	
	public static final String POSITION_BASED					= "position_based.gif"; 
	public static final String VERIFICATION_HOOK				= "verification_hook.gif";
	public static final String VARS								= "variables.gif"; 		
	public static final String VAR_ITEM							= "variable.gif"; 		
	public static final String TERMINATE						= "terminate.gif"; 	
	
	/* obj16 */			
	public static final String RESTART							= "restart.gif";
	public static final String DATAPOOL							= "datapool_obj.gif";
	public static final String ERROR							= "error.gif";
	public static final String WARNING							= "warning.gif";
	public static final String LINK								= "link.gif";
	public static final String SHELL							= "shell_obj.gif";
	public static final String COMMAND							= "command_obj.gif";		
	public static final String ECLIPSE_LOC						= "eclipse_loc.gif";	
	public static final String WAIT_TIME						= "wait.gif";
	public static final String ARGUMENTS						= "arguments.gif";
	public static final String USER_INPUT						= "user_input.gif";	
	public static final String WIDGET							= "widget.gif";	
	
	/* lcl16 */
	public static final String EXPAND							= "expand.gif";
	public static final String COLLAPSE							= "collapse.gif";
	public static final String RECORD							= "recording.gif";
	public static final String PLAY								= "resume_co.gif";
	public static final String DELETE							= "delete.gif";
	public static final String UP								= "up.gif";
	public static final String DOWN								= "down.gif";
	public static final String REFRESH							= "refresh.gif";
	public static final String INCLUDE							= "include.gif";
	public static final String OUTPUT							= "output.gif";
	public static final String FIND								= "find.gif";
	public static final String WORKSPACE_LOC					= "workspace.gif";	
	public static final String INVOCATION						= "invocation.gif";
	public static final String UPDATE							= "update.gif";	
	
	/* wizban */
	public static final String IMG_NEW_AUTO_GUI_WIZBAN			= "atestsuite_wiz.gif";
		
	protected void addImages() 
	{
		/* tool16 */
		add("e", T_TOOL, IMG_NEW_AUTO_GUI);		
		
		add("d", T_TOOL, POSITION_BASED);
		add("e", T_TOOL, POSITION_BASED);
		
		add("d", T_TOOL, VERIFICATION_HOOK);
		add("e", T_TOOL, VERIFICATION_HOOK);

		add("d", T_TOOL, TERMINATE);
		add("e", T_TOOL, TERMINATE);
		
		add("d", T_TOOL, VARS);
		add("e", T_TOOL, VARS);
		
		add("d", T_TOOL, VAR_ITEM);
		add("e", T_TOOL, VAR_ITEM);
		
		/* obj16 */		
		add(T_OBJ, RESTART);	
		add(T_OBJ, DATAPOOL);	
		add(T_OBJ, ERROR);
		add(T_OBJ, WARNING);
		add(T_OBJ, LINK);
		add(T_OBJ, SHELL);
		add(T_OBJ, COMMAND);		
		add(T_OBJ, WORKSPACE_LOC);
		add(T_OBJ, ECLIPSE_LOC);
		add(T_OBJ, WAIT_TIME);
		add(T_OBJ, ARGUMENTS);
		add(T_OBJ, OBJECT_MINE);
		add(T_OBJ, WIDGET);
		add(T_OBJ, USER_INPUT);
		
		/* lcl16 */
		add("c", T_LCL, EXPAND);
		add("c", T_LCL, COLLAPSE);
						
		add("d", T_LCL, RECORD);
		add("e", T_LCL, RECORD);
		
		add("d", T_LCL, UPDATE);
		add("e", T_LCL, UPDATE);
		
		add("c", T_LCL, PLAY);		
		add("d", T_LCL, PLAY);
		
		add("d", T_LCL, DELETE);		
		add("e", T_LCL, DELETE);
		
		add("d", T_LCL, UP);		
		add("e", T_LCL, UP);
		
		add("d", T_LCL, DOWN);		
		add("e", T_LCL, DOWN);
		
		add("c", T_LCL, REFRESH);				
		add("d", T_LCL, REFRESH);		
		
		add("d", T_LCL, INCLUDE);
		add("e", T_LCL, INCLUDE);
		
		add("d", T_LCL, OUTPUT);
		add("e", T_LCL, OUTPUT);
		
		add("d", T_LCL, FIND);
		add("e", T_LCL, FIND);
				
		add("d", T_LCL, INVOCATION);
		add("e", T_LCL, INVOCATION);
		
		/* wizban */
		add(T_WIZBAN, IMG_NEW_AUTO_GUI_WIZBAN);					
	}
}




/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.resolvers;

import org.eclipse.tptp.test.auto.gui.internal.core.IWidgetId;


/**
 * A primitive string widget id.  The string object must be an exact match
 * for the two given ids to equal.  Contributors can extend this class or 
 * provide a direct implementation of {@link IWidgetId}
 * 
 * @author Ali Mehregani
 */
public class PrimitiveWidgetId implements IWidgetId
{
	/** The resolver id */
	private String resolverId;
	
	/** The string id of the widget */
	private String id;
	
	
	public PrimitiveWidgetId()
	{
		
	}
	
	public PrimitiveWidgetId(String id)
	{
		this.id = id;
	}
	
	public String getResolverId()
	{
		return resolverId;
	}

	public void setResolverId(String resolverId)
	{
		this.resolverId = resolverId;
	}

	/**
	 * @return the id
	 */
	public String getId()
	{
		return id;
	}

	/**
	 * @param id the id to set
	 */
	public void setId(String id)
	{
		this.id = id;
	}
	
	public boolean equals(Object o)
	{
		if (id == null)
			return o == null;
		return id.equals(o);
	}
	
	public String toString()
	{
		return id;
	}

}




/*******************************************************************************
 * Copyright (c) 2005, 2008 IBM Corporation 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
 * $Id: NonTrivialWidgetResolver.java,v 1.7 2008/04/18 13:45:30 dmorris Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.resolvers;

import org.eclipse.hyades.models.hierarchy.TRCAgentProxy;
import org.eclipse.swt.custom.CTabItem;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Item;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.TabItem;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.core.IWidgetId;
import org.eclipse.tptp.test.auto.gui.internal.core.IWidgetResolver;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.trace.ui.internal.launcher.core.AnalysisType;
import org.eclipse.tptp.trace.ui.internal.launcher.core.DataCollectorTreeContentProvider.ParentChildNode;
import org.eclipse.ui.dialogs.FileSystemElement;
import org.eclipse.ui.model.IWorkbenchAdapter;
import org.eclipse.ui.views.IViewCategory;

/**
 * <p>
 * The purpose of this class is to resolve widgets that cannot be resolved using the 
 * AdaptiveWidgetResolver.  These widgets will likely require nested calls in order to
 * be determined.
 * </p>
 * <p>
 * Some of the properties used to resolve a widget are locale dependent (e.g. the name
 * of a button or the closest label to a text box)
 * </p>
 * 
 * @since 4.1
 * @author Ali Mehregani
 */
public class NonTrivialWidgetResolver implements IWidgetResolver
{
	/** 
	 * The id of this resolver -- must be in sync with the id registered with 
	 * the widgetResolver extension.
	 */
	private static final String ID = "org.eclipse.tptp.test.auto.gui.nontrivial";

	public IWidgetId getUniqueId(Widget parent, Object object)
	{
		if (!(object instanceof Widget))
			return null;
		
		Widget widget = (Widget) object;
		Object data = widget.getData();
		
		IWidgetId widgetId = null;
		
			
		/* Resolve the object based on the data type of the widget */
		/* An agent */
		if (data instanceof TRCAgentProxy)
		{
			widgetId = resolveAgentProxy (widget);
		}
		/* A file system element */
		else if (data instanceof FileSystemElement)
		{
			widgetId = resolveFileSystemElement (widget);
		}
		/* A view catgory */
		else if (data instanceof IViewCategory)
		{
			String id = ((IViewCategory)data).getId();
			if (id != null && id.length() > 0)
			{
				widgetId = new PrimitiveWidgetId();
				((PrimitiveWidgetId)widgetId).setId(id);
			}
		}
		/* Analysis type */
		else if (data instanceof ParentChildNode)
		{
			Object child = ((ParentChildNode)data).child;
			if (child instanceof AnalysisType)
			{
				widgetId = resolveAnalysisType((AnalysisType)child); 
			}
		}

		/* Resolve the object based on its widget type */
		/* A menu item or a tree item*/
		else if (widget instanceof MenuItem || widget instanceof TreeItem)
		{
			widgetId = resolveItem ((Item)widget);
		}
		/* A button */
		else if (widget instanceof Button)
		{
			widgetId = resolveButton (parent, (Button)widget, null);
		}
		/* A text box */
		else if (widget instanceof Text)
		{
			widgetId = resolveText ((Text)widget);
		}
		/* A CTab item */
		else if (widget instanceof CTabItem)
		{
			widgetId = validateText(((CTabItem)widget).getText());
		}		
		/* A tab item */
		else if (widget instanceof TabItem)
		{
			widgetId = validateText(((TabItem)widget).getText());
		}
		/* A toolbar */
		else if (widget instanceof ToolBar)
		{
			widgetId = resolveToolBar ((ToolBar)widget);
		}
		/* A tool item */
		else if (widget instanceof ToolItem)
		{
			widgetId = resolveToolbarItem ((ToolItem)widget);			
		}		
		

		if (widgetId != null)
		{
			widgetId.setResolverId(ID);
		}
		
		return widgetId;
	}



	private IWidgetId resolveAnalysisType(AnalysisType analysisType)
	{
		Object[] properties = 
		{
			new Object[] {analysisType.getId(), "1.0"},
		};
	
		return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
	}



	private IWidgetId resolveToolBar(ToolBar toolbar)
	{
		int itemCount = toolbar.getItemCount();
		String 	firstItem = itemCount > 1 ? limitText(toolbar.getItem(0).getToolTipText()) : null, 
				lastItem = itemCount > 2 ? limitText(toolbar.getItem(itemCount - 1).getToolTipText()) : null;
		int style = toolbar.getStyle();
		
		if (firstItem == null && lastItem == null)
			return null;
		
		Object[] properties = 
		{
			new Object[] {convertText(firstItem), "0.5"},
			new Object[] {convertText(lastItem), "0.5"},
			new Object[] {String.valueOf(itemCount), "0.3"},
			new Object[] {String.valueOf(style), "0.2"}
		};
	
		return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
	}



	private IWidgetId resolveToolbarItem(ToolItem item)
	{
		String text = convertText(limitText(item.getToolTipText()));
		String actionId = MacroUtil.getActionId(item).toString();
		String style = String.valueOf(item.getStyle());
		
		Object[] properties = 
		{
			new Object[] {text, "0.7"},
			new Object[] {actionId, "0.7"},
			new Object[] {style, "0.3"}
		};
	
		return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
	}



	private String limitText(String str)
	{
		final int MAX_HOVER_TEXT_SIZE = 20;
		if (str != null && str.length() > MAX_HOVER_TEXT_SIZE)
		{	
			return str.substring(0,MAX_HOVER_TEXT_SIZE) + "...";			
		}
		return str;
	}



	private IWidgetId resolveButton(Widget parent, Button button, Object id)
	{	
		String text = null, hoverText = null, size = null, location = null;
		if ((text = button.getText()) != null)
		{
			text = convertText(text.replaceAll("\\&", ""));
		}
		/* First 20 characters of the hover text */
		hoverText = convertText(limitText(button.getToolTipText()));
		Point sizePt = button.getSize();
		Point locationPt = button.getLocation();
		size = "(" + sizePt.x + "," + sizePt.y + ")";		
		location = "("  + locationPt.x + "," + locationPt.y + ")";		
		
		if (id != null && WeightedPropertyWidgetId.countTokens(id.toString())  == 3)
		{
			
			Object[] properties = 
				{
					new Object[] {text, "0.5"},
					new Object[] {hoverText, "0.5"},
					new Object[] {size, "0.5"}
				};
			
			return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
		}
		else
		{			
			if (parent instanceof Composite)
			{
				Control[] children = ((Composite)parent).getChildren();
				int buttonInx = 0;
				// if there are multiple buttons with the same text label
				int sameTextButtons = 0;
				String indexWeight = "0.2";
				String lengthWeight = "0.3";
				
				/* Find the index of the button */
				for (int i = 0; i < children.length; i++)
				{
					if (text != null && children[i] instanceof Button){
						String label = ((Button)children[i]).getText();
						if (label != null){
							label = convertText(label.replaceAll("\\&", ""));
							if (label.compareTo(text)  == 0)
								sameTextButtons++;
						}
					}
					if (button == children[i])
					{
						buttonInx = i;
						break;
					}
				}
				if (sameTextButtons > 0){
					// two or more buttons with the same label in the 
					// same child list under a composite parent
					// so shift the weighting to favor the button index
					// to get the right weighting
					indexWeight = "0.4";
					lengthWeight = "0.1";
				}
				
				Object[] properties = 
				{
						new Object[] {text, "0.3"},
						new Object[] {hoverText, "0.3"},
						new Object[] {String.valueOf(children.length), lengthWeight},
						new Object[] {size, "0.1"},
						new Object[] {location, "0.1"},
						new Object[] {String.valueOf(buttonInx), indexWeight},
				
				};
				
				float threshold = 0.7f;
				threshold += text != null ? 0.3 : 0;
				threshold += hoverText != null ? 0.3 : 0;
				
				if (threshold >= 1.0)
					return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
			}
		}
		
		return null;
	}


	/**
	 * Replace "#", "\n" and "\r" with space to avoid having "#" generated in the
	 * object id. The "#" is taken as the separator between widget Class name and
	 * rest of object id (see MacroObjectLocator.locateVisibleChild).
	 * 
	 * @param label
	 * @return
	 */
	private String convertText(String label) {
		return label == null ? null : label.replaceAll("#", " ").replaceAll("\n", " ").replaceAll("\r", " ");
	}


	/**
	 * The text of the closest label to a text box is used as a unique
	 * identifier of the text box.  The label must be in a limited
	 * vicinity of the text box for its text to be considered as an identifier.
	 * If the text box is owned by a group and the group only owns one text box, 
	 * then the group text is used to identify the widget.
	 * 
	 * @param text The text box
	 * @return The widget id for text
	 */
	private IWidgetId resolveText(Text text)
	{
		Composite parent = text.getParent();
		Control[] children = parent.getChildren();
		
		String groupText = null;
		if (parent instanceof Group && (groupText = ((Group)parent).getText()) != null && (groupText = groupText.replaceAll("\\&", "")).length() > 0)
		{
			int textBoxNum = 0;
			for (int i = 0; i < children.length && textBoxNum <= 1; i++)
			{
				if (children[i] instanceof Text)
					textBoxNum++;
			}
			
			if (textBoxNum <= 1)
				return new PrimitiveWidgetId(convertText(groupText));
		}
		
		Label closestLabel = null;
		Point textLocation = text.getLocation();
		Point currentDistance = new Point(0,0);
		Point tempDistance = new Point(0,0);
		for (int i = 0; i < children.length; i++)
		{
			Point childLocation = children[i].getLocation();
			if 	(children[i] instanceof Label && 
				(closestLabel == null || (tempDistance = isLabelCloser(childLocation, currentDistance, textLocation)) != null))
			{
				boolean firstLabel = closestLabel == null;
				closestLabel = (Label)children[i];;
				if (firstLabel)
				{
					currentDistance = new Point (Math.abs(childLocation.x - textLocation.x), Math.abs(childLocation.y - textLocation.y));
				}
				else
				{
					currentDistance = tempDistance;
				}
			}
		}
		
		String closestLabelText = null;
		if (closestLabel != null && currentDistance.x + currentDistance.y <= 100 &&  
			closestLabel.getText() != null && (closestLabelText = closestLabel.getText().replaceAll("\\&", "")).length() > 0)
			return new PrimitiveWidgetId(convertText(closestLabelText));
		return null;
	}


	private Point isLabelCloser(Point newlblLocation, Point currentDistance, Point textLocation)
	{
		Point tempLocation = new Point (Math.abs(newlblLocation.x - textLocation.x), Math.abs(newlblLocation.y - textLocation.y));
		if (tempLocation.x + tempLocation.y < currentDistance.x + currentDistance.y)
			return tempLocation;
		return null;
	}


	private IWidgetId validateText(String text)
	{
		if (text != null && (text = text.replaceAll("\\&", "")).length() > 0)
			return new PrimitiveWidgetId(convertText(text));		
		return null;
	}


	/**
	 * Computes the item id based on the following properties
	 * and weights.  The threshold is set to 1.0:
	 * 
	 * <ul>
	 * 	<li> (Descriptive name of the item, 1.0) </li>
	 * </ul>
	 * @param item The item
	 * @return The weighted id
	 */
	private IWidgetId resolveItem(Item item) 
	{		
		StringBuffer descriptiveText = new StringBuffer();
		findItemText(item, descriptiveText);			
		
		/* Remove the ampersands */
		String itemText = convertText(descriptiveText.toString().replaceAll("\\&", ""));
		
		Object[] properties = 
			{
				new Object[] {itemText, "1.0"},
			};
		
		return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
	}

	
	/**
	 * Walk through the item and return a descriptive text that corresponds
	 * to all item selections leading to the item. (e.g. File-New-Project)
	 * 
	 * @param item The item
	 * @param descriptiveText In the end, this buffer will contain a
	 * descriptive text of all items leading to the item that
	 * is passed in as argument
	 */
	private void findItemText(Item item, StringBuffer descriptiveText) 
	{
		if (item == null)
			return;
		
		String descriptiveTextStr = item.getText();
		if (descriptiveText.length() > 0)
			descriptiveTextStr += "-";
		
		descriptiveText.insert(0, descriptiveTextStr);
		
		Item parentItem = null;
		if (item instanceof MenuItem)
		{
			Menu menu = ((MenuItem)item).getParent();
			parentItem = (menu == null ? null : menu.getParentItem());
		}
		else if (item instanceof TreeItem)
		{
			parentItem = ((TreeItem)item).getParentItem();			
		}
				
		if (parentItem != null)
			findItemText(parentItem, descriptiveText);
	}


	private IWidgetId resolveFileSystemElement(Widget widget)
	{
			
		FileSystemElement fileSystemElement = (FileSystemElement) widget.getData();
		if (fileSystemElement.isDirectory())
			return null;
		
		Object[] properties = 
			{
				new Object[] {((IWorkbenchAdapter)fileSystemElement.getAdapter(IWorkbenchAdapter.class)).getLabel(null), "1.0"}
			};
		
		return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
	}

	private WeightedPropertyWidgetId resolveAgentProxy(Widget widget)
	{	
		StringBuffer treeIndex = new StringBuffer();
		if (widget instanceof TreeItem)
			findTreeItemIndex((TreeItem)widget, treeIndex);
		else
			return null;
		
		TRCAgentProxy proxy = (TRCAgentProxy) widget.getData();
		Object[] properties = 
			{
				new Object[] {treeIndex.toString(), "0.4"},
				new Object[] {proxy.getProcessProxy().getName(), "0.2"},
				new Object[] {proxy.getProcessProxy().getVmArguments(), "0.1"},
				new Object[] {proxy.getProcessProxy().getClasspath(), "0.1"},
				new Object[] {proxy.getProcessProxy().getLocation(), "0.1"},
				new Object[] {proxy.getProcessProxy().getParameters(), "0.1"},
				new Object[] {proxy.getProfileFile(), "0.1"},
				new Object[] {proxy.getName(), "0.1"},
				new Object[] {String.valueOf(proxy.isAttached()), "0.1"},
				new Object[] {String.valueOf(proxy.isMonitored()), "0.1"},
				new Object[] {String.valueOf(proxy.isToProfileFile()), "0.1"},
			};
		
		return WeightedPropertyWidgetId.constructId (properties, (float)0.7);
	}

			


	private void findTreeItemIndex(TreeItem treeItem, StringBuffer sb)
	{
		TreeItem parentItem = treeItem.getParentItem();
		if (parentItem != null)
		{
			int index = parentItem.indexOf(treeItem);
			if (index != -1)
				sb.append("|" + String.valueOf(index + 1));
						
			findTreeItemIndex (parentItem, sb);			
		}
		Tree tree = treeItem.getParent();
		int index = tree.indexOf(treeItem);
		if (index != -1)
			sb.append("|" + String.valueOf(index));
		
	}



	public boolean foundWidget(Object object, Object id)
	{
		Object objectId = null;
		if (object instanceof Button)
		{
			Button button = (Button) object;
			objectId = resolveButton(button.getParent(), button, id);
		}
		
		if (objectId == null)
			objectId = getUniqueId(object instanceof Control ? ((Control)object).getParent() : null, object);
		return id == null ? false : objectId == null ? false : objectId.equals(id);		
	}


}




/*******************************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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
 * $Id: AdaptiveWidgetResolver.java,v 1.7 2009/05/17 16:16:28 paules Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.resolvers;

import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Method;
import java.net.URL;
import java.util.Hashtable;
import java.util.Vector;

import org.eclipse.hyades.test.common.util.XMLUtil;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.core.IWidgetId;
import org.eclipse.tptp.test.auto.gui.internal.core.IWidgetResolver;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.osgi.framework.Bundle;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

/**
 * <p>The following widget resolver attempts to resolve widgets using a static
 * XML file stored under the auto-gui folder under this plug-in.</p>
 * 
 * 
 * @author  Ali Mehregani
 * @author  Paul Slauenwhite
 * @version May 16, 2009
 * @since   July 10, 2006
 */
public class AdaptiveWidgetResolver implements IWidgetResolver 
{
	/** 
	 * The id of this resolver -- must be in sync with the id registered with 
	 * the widgetResolver extension.
	 */
	private static final String ID = "org.eclipse.tptp.test.auto.gui.adaptive";
	
	/** The assumed file name relative to this plugin */
	public final static String WIDGET_REG_FILE = "auto-gui/widgetReg.xml";
	
	/** The widget registerations */
	private IWidgetRegistration widgetReg;
		

	public AdaptiveWidgetResolver()
	{		
		widgetReg = new WidgetRegistration (this, WIDGET_REG_FILE); 	
	}
	
	
	public IWidgetId getUniqueId(Widget parent, Object object)
	{
		if (!(object instanceof Widget))
			return null;
		
		widgetReg.load();
		IWidgetId widgetId = widgetReg.getWidgetId((Widget)object);
		if (widgetId != null)
			widgetId.setResolverId(ID);
		return widgetId;
	}

	/**
	 * Clients have the option of overwriting this in order to be able to locate
	 * the widget them self in the registeration entries that exist. 
	 */
	public WidgetRegValue findWidget (Hashtable registerations, Widget widget)
	{
		return null;
	}
	
	
	public class WidgetRegistration implements IWidgetRegistration
	{
		/* The file name */
		private String fileName;
		
		/* The last size of the file when it was properly read */
		private long lastModifiedDate;
		
		/* The file size (stored in case there was an error last time reading the file */
		private long lastModifiedDateDetected;
		
		/* Indicates if there was an error in parsing the file */
		private boolean errorOccurred;
		
		/* The data structures holding the registered widgets.
		 * Key = class name; Value =  WidgetRegValue */ 
		private Hashtable regWidgets;
			
		/* The global match threshold */
		private float globalMatchThreshold;
		
		/* The class name used for the default entry */
		public static final String DEFAULT_ENTYR = "0_DEFAULT_ENTRY";
		
		/* The adaptive widget resolver used as the driver for resolving widgets */
		private AdaptiveWidgetResolver adaptiveWidgetResolver; 
		
		public WidgetRegistration (AdaptiveWidgetResolver adaptiveWidgetResolver, String fileName)
		{
			this.fileName = fileName;
			this.lastModifiedDate = 0;
			this.lastModifiedDateDetected = 0;
			this.errorOccurred = false;
			this.regWidgets = new Hashtable();
			this.adaptiveWidgetResolver = adaptiveWidgetResolver;
		}
		
		
		public void load()
		{				
			InputStream regXMLInputStream = null;
			try
			{
				
			    
				Bundle guiBundle = GuiPlugin.getDefault().getBundle();
				long currentModifiedDate = guiBundle.getLastModified();// added for defect 169733 Liz Dancy
				
				/* Checking the file size doesn't guarantee to us that the file hasn't changed.  This is 
				 * the best we can do.  Replace this with last modified date if API is available. */
				if (currentModifiedDate > 0 && (currentModifiedDate == lastModifiedDate || (errorOccurred && lastModifiedDateDetected == currentModifiedDate)))
					return;
				
				URL regFileURL = GuiPlugin.getDefault().getBundle().getEntry(fileName);	
				lastModifiedDateDetected = currentModifiedDate;
				
				/* Parse the XML file */
				regXMLInputStream = regFileURL.openStream();
				Element rootElement = XMLUtil.loadDom(regXMLInputStream, "widgetResolverRule");
				if (rootElement == null)
				{
					lastModifiedDate = 0;
					errorOccurred = true;
					
					/* Display an error message if we are recording */
					if (MacroManager.getInstance().getGlobalState() == MacroManager.RECORDING_MODE)
					{
						AutoGUIUtil.showMessage(AutoGUIMessages.AUTO_GUI_ERROR_WID_RESOLVER_T, 
								AutoGUIMessages.AUTO_GUI_ERROR_WID_RESOLVER, MessageDialog.WARNING);
					}
					return;
				}
				this.regWidgets.clear();
				parseRegFile(rootElement);
				lastModifiedDate = currentModifiedDate;
			}
			catch (Throwable t)
			{
				/* Set the file size to zero to invalidate this widget resolver */
				lastModifiedDate = 0;
				errorOccurred = true;
				
				/* Display an error message if we are recording */
				if (MacroManager.getInstance().getGlobalState() == MacroManager.RECORDING_MODE)
				{
					AutoGUIUtil.showMessage(AutoGUIMessages.AUTO_GUI_ERROR_WID_RESOLVER_T, 
							AutoGUIMessages.AUTO_GUI_ERROR_WID_RESOLVER, MessageDialog.WARNING);
				}
			}
			finally
			{
				if (regXMLInputStream != null)
				{
					try
					{
						regXMLInputStream.close();
					} catch (IOException e)
					{
						/* Ignore the error */
					}
				}
			}
			
		}

		public float getGlobalThreshold()
		{
			return globalMatchThreshold;
		}
		
		/**
		 * parse the registation file that has already been loaded 
		 */
		private void parseRegFile(Element rootElement)
		{
			if (rootElement == null)
				return;
						
			NodeList classList = XMLUtil.getChildrenByName(rootElement, "class");
			parseClassElements (classList);
			globalMatchThreshold = Float.parseFloat(XMLUtil.getValue (rootElement, "globalMatchThreshold"));
			NodeList defaultList = XMLUtil.getChildrenByName(rootElement, "default");
			parseDefaultElements (defaultList);
		}


		private void parseDefaultElements(NodeList defaultList)
		{
			if (defaultList == null || defaultList.getLength() < 1)
				return;
			
			/* We only expect one default element */
			if(defaultList.item(0) instanceof Element)
			{
				Element defaultElement = (Element)defaultList.item(0);
				NodeList methodList = XMLUtil.getChildrenByName(defaultElement, "method");
				WidgetRegValue widgetReg = new WidgetRegValue();
					
				parseMethod (methodList, widgetReg);
				if (widgetReg != null)
					regWidgets.put(DEFAULT_ENTYR, widgetReg);
				
			}
		}


		/**
		 * Parse the class elements
		 */
		private void parseClassElements(NodeList classList)
		{
			if (classList == null || classList.getLength() <= 0)
				return;
			
			for(int i = 0; i < classList.getLength(); i++)
			{
				if(classList.item(i) instanceof Element)
				{
					
					Element classElement = (Element)classList.item(i);
					String className = XMLUtil.getValue(classElement, "name");
					NodeList methodList = XMLUtil.getChildrenByName(classElement, "method");
					WidgetRegValue widgetReg = new WidgetRegValue();
					String matchThreshold = XMLUtil.getValue(classElement, "matchThreshold");
					if (matchThreshold != null)
						widgetReg.setClassMatchThreshold(Float.parseFloat (matchThreshold));
					
					parseMethod (methodList, widgetReg);					
					if (widgetReg != null)
						regWidgets.put(className, widgetReg);
					
						
				}
			}
		}


		/**
		 * Parse the method element and return a widget registration entry
		 * 
		 * @param methodList The method list
		 * @param widgetReg the widget registration entry that will be augmented
		 * @return A widget registeration entry
		 */
		private void parseMethod(NodeList methodList, WidgetRegValue widgetReg)
		{
			if (methodList == null || methodList.getLength() <= 0)
				return;
			
			for(int i = 0; i < methodList.getLength(); i++)
			{
				if(methodList.item(i) instanceof Element)
				{
					Element methodElement = (Element)methodList.item(i);
					String methodName = XMLUtil.getValue(methodElement, "name");
					float weight = Float.parseFloat(XMLUtil.getValue(methodElement, "weight"));
					PropertyValue propertyVal = new PropertyValue();
					propertyVal.setWeight(weight);
					
					NodeList argumentList = XMLUtil.getChildrenByName(methodElement, "argument");
					if (argumentList != null)
						parseArguments(argumentList, propertyVal);
					
					widgetReg.addProperty(methodName, propertyVal);					
				}
			}			
		}


		/**
		 * Parse the arguments
		 * 
		 * @param argumentList The arugment list
		 * @param propertyVal The property value entry that will be augmented to.
		 */
		private void parseArguments(NodeList argumentList, PropertyValue propertyVal)
		{
			if (argumentList == null || argumentList.getLength() <= 0)
				return;
			
			Vector arguments = new Vector();
			for(int i = 0; i < argumentList.getLength(); i++)
			{
				if(argumentList.item(i) instanceof Element)
				{
					Element argumentElement = (Element)argumentList.item(i);
					String argumentValue = XMLUtil.getValue(argumentElement, "value");
					arguments.add(argumentValue);				
				}
			}	
			
			propertyVal.setArguments(arguments);			
		}


		public IWidgetId getWidgetId(Widget widget)
		{
			/* Use this resolver if we were able to successfully resolve parse the XML file */
			if (lastModifiedDate > 0)
			{
				/* First attempt the widget itself.  If that fails, then try its data attribute */
				Object data = widget;

				WidgetRegValue widgetValue = (WidgetRegValue)regWidgets.get(data.getClass().getName());
				if (widgetValue == null && widget.getData() != null)
				{
					data = widget.getData();
					widgetValue = (WidgetRegValue)regWidgets.get(data.getClass().getName());
					
					/* If that fails, then walk throught the class heirarchy (the interafaces and superclasses */
					if (widgetValue == null)
					{
						widgetValue = walkThroughClassHeirarchy (data.getClass());

					}					
				}
				
				/* As a final resolution, try and call the driver class to resolve the widget */
				if (widgetValue == null)
					widgetValue = adaptiveWidgetResolver.findWidget(regWidgets, widget);
				
				
				Vector propertyWeightPair = new Vector (5);
				WeightedPropertyWidgetId adaptiveWidgetId = new WeightedPropertyWidgetId();
				boolean specificValidEntry = false;
				boolean defaultValidEntry = false;
				
				if (widgetValue != null)
				{
					float threshold = widgetValue.getClassMatchThreshold();
					if (threshold == 0)
						threshold = globalMatchThreshold;
					adaptiveWidgetId.setThreshold(threshold);
					
					/* Specific properties associated with this type */
					specificValidEntry = appendProperties (data, propertyWeightPair, widgetValue);
				}
				
				/* Default properties */
				Vector defaultEntries = new Vector();
				defaultValidEntry = appendProperties (widget, defaultEntries, (WidgetRegValue)regWidgets.get(DEFAULT_ENTYR), true);
				if (defaultValidEntry)
					propertyWeightPair.addAll(propertyWeightPair);
				
				
				/* Return null if we weren't able to get any of the widgets properties */
				if (propertyWeightPair.size() <= 0)
					return null;
				
				adaptiveWidgetId.setPropertyWeightPair(propertyWeightPair.toArray());
				if (specificValidEntry || defaultValidEntry)
					return adaptiveWidgetId;
				return null;
			}
			
			return null;
		}

		
		private WidgetRegValue walkThroughClassHeirarchy(Class widgetClass) 
		{
			WidgetRegValue widgetValue = null;	
			
			widgetValue = (WidgetRegValue)regWidgets.get(widgetClass.getName());
			if (widgetValue != null)
				return widgetValue;
			
			Class[] interfaces = widgetClass.getInterfaces();
			
			/* Try the interfaces first */
			for (int i = 0; i < interfaces.length; i++)
			{
				widgetValue = (WidgetRegValue)regWidgets.get(interfaces[i].getName());
				widgetValue = (widgetValue == null ? walkThroughClassHeirarchy(interfaces[i]) : widgetValue);
				if (widgetValue != null)
					return widgetValue;
			}
			
			/* We failed with the interfaces, now try the super class */
			Class extendedClass = widgetClass.getSuperclass();
			if (extendedClass != null)
				widgetValue = walkThroughClassHeirarchy(extendedClass);
			
			return widgetValue;
		}
		
		
		private boolean appendProperties(Object data, Vector propertyWeightPair, WidgetRegValue widgetValue) 
		{
			return appendProperties(data, propertyWeightPair, widgetValue, false); 
		}
		
		private boolean appendProperties(Object data, Vector propertyWeightPair, WidgetRegValue widgetValue, boolean isDefault) 
		{
			boolean validEntry = false;
			if (widgetValue == null)
				return false;
			
			Vector properties = widgetValue.getProperties();
			for (int i = 0, propertySize = properties.size(); i < propertySize; i++)
			{
				String property = (String) properties.get(i);
				PropertyValue propertyValue = widgetValue.getPropertyValue(property);
				String retValue = invokeProperty (data, property, propertyValue);
				
				if ((retValue == null || retValue.length() <= 0) && isDefault)
					retValue = invokeProperty (((Widget)data).getData(), property, propertyValue);
				
				/* Don't add it if the return value is null or of zero length */
				if (retValue == null || retValue.length() <= 0)
					retValue = "null";				/* Set the value to the literal string 'null' */
				else
					validEntry = true;
				
				
				propertyWeightPair.add(new Object[] {retValue, String.valueOf(propertyValue.getWeight())});
			}
			return validEntry;
		}


		/**
		 * Invoke the appropriate method to get the property value
		 * 
		 * @param data The data corresponding to the widget or the data attribute of the widget
		 * @param theMethod The method corresponding to the property value 
		 * @param propertyValue The property information container
		 * 
		 * @return The returned value of the method corresponding to the argument
		 */
		private String invokeProperty(Object data, String theMethod, PropertyValue propertyValue)
		{
			try
			{
				Class theClass = data.getClass();
				int paramCount = 0;
				Vector args = propertyValue.getArguments(); 
				if (args != null && args.size() > 0)
					paramCount = args.size();
				
				/* We only support method with string parameters */
				Class[] params = new Class[paramCount];
				for (int i = 0; i < params.length; i++)
					params[i] = String.class;
				
				Method method = theClass.getMethod(theMethod, params);
				
				Object[] methodArgs = null;
				if (paramCount > 0)
					methodArgs = propertyValue.getArguments().toArray();
				
				Object retValue = method.invoke(data, methodArgs);
				return retValue.toString();
			}
			catch (Throwable t)
			{
				/* Return null if in case we can retrieve the property value */
				return null;	
			}
			
		}


		public WidgetRegValue getDefaultWidgetReg()
		{
			if (regWidgets == null)
				return null;
			return (WidgetRegValue)regWidgets.get(DEFAULT_ENTYR);
		}
		
	}
	
	
	/**
	 * Can be used to provide any alternative implementation of how the widget registration file 
	 * is loaded and queried.
	 * 
	 * @author Ali Mehregani
	 */
	public interface IWidgetRegistration
	{
		/**
		 * Used to load the necessary file and store the data in a datastructure that
		 * will later be used to query the registrations.
		 */
		public void load();
		
		/**
		 * Retrieve the widget id from the registrations
		 * 
		 * @param widget The widget in question
		 * @return The persistent identifier for the widget
		 */
		public IWidgetId getWidgetId (Widget widget);
	}
	
	
	/**
	 * A container class for the registration value of a widget
	 * 
	 * @author Ali Mehregani
	 */
	private class WidgetRegValue
	{
		/* Key = method names, value = propertyValue */
		private Hashtable properties;
		
		/* Class match treshold */
		private float classMatchThreshold;
		
		/* This vector is used to preserve the ordering of the properties inserted in the hashtable */
		private Vector hashKeys;
		
		public WidgetRegValue()
		{
			properties = new Hashtable();
			classMatchThreshold = 0;
			hashKeys = new Vector();
		}
		
		public Vector getProperties()
		{
			return hashKeys;
		}
		
		public PropertyValue getPropertyValue (String propertyValue)
		{
			return (PropertyValue) properties.get(propertyValue);
		}
		
		public void addProperty (String methodName, PropertyValue propertyValue)
		{
			hashKeys.add(methodName);
			properties.put (methodName, propertyValue);
		}

		public float getClassMatchThreshold()
		{
			return classMatchThreshold;
		}

		public void setClassMatchThreshold(float classMatchThreshold)
		{
			this.classMatchThreshold = classMatchThreshold;
		}
			
	}
	
	/**
	 * Container class for property values
	 * 
	 * @author Ali Mehregani
	 */
	private class PropertyValue
	{
		private Vector arguments;
		private float weight;
		
		public Vector getArguments()
		{
			return arguments;
		}
		public void setArguments(Vector arguments)
		{
			this.arguments = arguments;
		}
		public float getWeight()
		{
			return weight;
		}
		public void setWeight(float weight)
		{
			this.weight = weight;
		}			
	}

	public boolean foundWidget(Object object, Object id)
	{
		Object objectId = getUniqueId(object instanceof Control ? ((Control)object).getParent() : null, object);
		return id == null ? false : objectId == null ? false : objectId.equals(id);	
	}
}




/********************************************************************** 
 * Copyright (c) 2005, 2006 IBM Corporation 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         
 * $Id: WeightedPropertyWidgetId.java,v 1.3 2006/12/04 02:55:08 amehregani Exp $ 
 * 
 * Contributors: 
 * IBM - Initial API and implementation 
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.resolvers;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.eclipse.hyades.test.common.util.XMLUtil;

/**
 * Defines a widget Id by a set of properties that the widget must have.  Each
 * property is assigned a weight and if the total weight exceeds the threshold, then
 * the widget is identified as a match
 * 
 * @author Ali Mehregani
 */
public class WeightedPropertyWidgetId extends PrimitiveWidgetId
{
	/* Stored elements are of type Object[2], where the first element is the value returned by the
	 * method corresponding to the property and the second value is the weight associated with that
	 * property. */
	private Object[] propertyWeightPair;
	private float threshold;
	
	private final static Pattern pairPattern  = Pattern.compile(".*?\\{\\{([^\\}]+)\\}\\}-\\{\\{([^\\}]+)\\}\\}.*");
	
	public boolean equals(Object obj) 
	{
		String stringToCompare = null;
		boolean compare = false;
		
		/* The object is of our own kind */
		if (obj instanceof WeightedPropertyWidgetId)
		{
			WeightedPropertyWidgetId idToCompareWith = (WeightedPropertyWidgetId)obj;
			
			if (this == idToCompareWith)
				return true;
			
			compare = true;
			stringToCompare = idToCompareWith.toString();
		}
			
		/* The object is a string (most likely coming from a macro) */
		else if (obj instanceof String)
		{
			compare = true;
			stringToCompare = (String)obj;
		}
		
		if (!compare)
			return false;
		
		/* Use regular expression to distinguish the returned value of each method
		 * from the weight */	
		float accumMatchRate = 0;
		int loopIterationNo = -1;
		
		while (stringToCompare.length() > 0 && (loopIterationNo + 1) < propertyWeightPair.length)
		{
			loopIterationNo++;
			Matcher pairTokenMatcher = pairPattern.matcher(stringToCompare);
			
			/* Discontinue if there is no match */
			if (!pairTokenMatcher.matches() || pairTokenMatcher.groupCount() != 2)
				break;
			
			/* Otherwise walk through each token */
			String originalProperty = pairTokenMatcher.group(1);
			String prop = originalProperty;
			if (prop.length() > 0)
				prop = XMLUtil.removeXMLSymbols(prop);
			float weight = Float.parseFloat(pairTokenMatcher.group(2));
		
			/* The ordering of the tokens for the IDs being compared must be the same. */
			Object[] propertyWeightPair = (Object[])this.propertyWeightPair[loopIterationNo];
			if (!prop.equals("null") && 
				(prop.length() > 0 ? prop.charAt(0) == ((String)propertyWeightPair[0]).charAt(0) || prop.charAt(0) == '&' : true) &&  
				(prop.equals(propertyWeightPair[0]) || prop.replaceAll("\\&", "").equals(propertyWeightPair[0]) || prop.replace('/', '\\').equals(propertyWeightPair[0])))
				accumMatchRate += Float.parseFloat((String)propertyWeightPair[1]);
			
			String currentToken = "{{" + originalProperty + "}}-{{" + weight + "}}";
			if (currentToken.equals(stringToCompare))
				break;
			
			int inx = stringToCompare.indexOf(currentToken);
			if (inx != -1)
				stringToCompare = stringToCompare.substring(inx + currentToken.length(), stringToCompare.length());
			
			else
				break;				/* The control flow should never reach this block */
			
		}
		
		if (accumMatchRate >= threshold)
			return true;
		return false;
	}
	
	
	/**
	 * Return a string representation of this identifier.  The property, weight information
	 * is organized in this format:  {{property-value1}}-{{weight1}}{{property-value2}}:{{weight2}}
	 */
	public String toString() 
	{
		String retValue = "";
		for (int i = 0; i < this.propertyWeightPair.length; i++)
			retValue += "{{" + ((Object[])this.propertyWeightPair[i])[0] + "}}-{{" + ((Object[])this.propertyWeightPair[i])[1] + "}}";
		
		return XMLUtil.useXMLSymbols(retValue);
	}


	public float getThreshold()
	{
		return threshold;
	}


	public void setThreshold(float threshold)
	{
		this.threshold = threshold;
	}


	public Object[] getPropertyWeightPair()
	{
		return propertyWeightPair;
	}


	public void setPropertyWeightPair(Object[] propertyWeightPair)
	{
		this.propertyWeightPair = propertyWeightPair;
	}

	/**
	 * Walk through the properties and return true for as long as one of them is not null.
	 * 
	 * @return true if at least one property is not null; false otherwise
	 */
	public boolean noValidProperties()
	{
		if (propertyWeightPair == null)
			return true;
		
		for (int i = 0; i < propertyWeightPair.length; i++)
		{
			String property = (String)((Object[])propertyWeightPair[i])[0];
			if (property != null && !property.equals("null"))
				return false;
		}
		return true;
	}
	
	
	/**
	 * Convenient method available for clients to use in order to construct a 
	 * weighted property id
	 * 
	 * @param properties The (properties, weight) pairs of the item (weights should be a value between (0, 1])
	 * @param threshold The threshold that this property should meet (should be a value between (0-1])
	 * @return Returns an instance of this class with the appropriate fields set.  
	 */
	protected static WeightedPropertyWidgetId constructId(Object[] properties, float threshold)
	{
		/* Step through the properties and replace null values with the literal string null */
		for (int i = 0; i < properties.length; i++)
		{
			String property = (String)((Object[])properties[i])[0];
			if (property == null || property.length() <= 0)
				((Object[])properties[i])[0] = "null";
			
		}
		
		WeightedPropertyWidgetId widgetId = new WeightedPropertyWidgetId ();
		widgetId.setPropertyWeightPair(properties);
		widgetId.setThreshold(threshold);
		
		if (widgetId.noValidProperties())
			return null;
		return widgetId;
	}
	
	
	/**
	 * Given a string representation of the id, this method will return the number of tokens
	 * that it contains.  A token is a name, value pair in the format.
	 * 
	 * @param id The string representation of the id
	 * @return The number of tokens of the id
	 */
	protected static int countTokens(String id)
	{
		if (id == null)
			return 0;
		
		char[] characters = id.toCharArray();
		boolean braceInxHit = false;
		int tokenCount = 0;
		for (int i = 0; i < characters.length; i++)
		{
			if (characters[i] == '{')
			{
				if (braceInxHit)
				{
					tokenCount++;
				}
				else
				{
					braceInxHit = true;
					continue;
				}
			}
			braceInxHit = false;			
		}
		
		return tokenCount / 2;
	}
}




<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.hyades.test.tools.ui">
<annotation>
      <appInfo>
         <meta.schema plugin="org.eclipse.hyades.test.tools.ui" id="macroSupport" name="macroSupport"/>
      </appInfo>
      <documentation>
         Use this extension to define a class that is capable of resolving widgets.
      </documentation>
   </annotation>

   <element name="extension">
      <annotation>
         <appInfo>
            <meta.element deprecated="true" replacement="uiObjectResolverDelegate" />
         </appInfo>
         <documentation>
            The following internal extension provides the mean for defining custom widget resolvers.
         </documentation>
      </annotation>
      <complexType>
         <sequence>
            <element ref="widgetResolver" minOccurs="1" maxOccurs="unbounded"/>
         </sequence>
         <attribute name="point" type="string" use="required">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="id" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="name" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
               <appInfo>
                  <meta.attribute translatable="true"/>
               </appInfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="widgetResolver">
      <complexType>
         <attribute name="class" type="string" use="required">
            <annotation>
               <documentation>
                  The class that is invoked to resolve a widget.
Must implement the following interface: org.eclipse.tptp.test.auto.gui.internal.core.IWidgetResolver
               </documentation>
               <appInfo>
                  <meta.attribute kind="java" basedOn="org.eclipse.tptp.test.auto.gui.internal.core.IWidgetResolver"/>
               </appInfo>
            </annotation>
         </attribute>
         <attribute name="priority" type="string" use="required">
            <annotation>
               <documentation>
                  This attribute indicates the priority of the widget resolver relative to the other registered widget resolvers.  Widget resolvers are invoked in an descending order of their priority (e.g. The widget resolver with the highest priority attribute will be invoked first).
The value of this attribute is expected to be an integer
               </documentation>
            </annotation>
         </attribute>
         <attribute name="id" type="string" use="required">
            <annotation>
               <documentation>
                  The unique id of the resolver.  Keeps this id short as it is commonly used in a macro.  The suggested format is CONTRIBUTING_PLUGIN_ID.RESOLVER_NAME e.g. org.eclipse.tptp.test.auto.gui.adaptive.
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appInfo>
         <meta.section type="since"/>
      </appInfo>
      <documentation>
         Since TPTP v4.1
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="examples"/>
      </appInfo>
      <documentation>
         &lt;!-- Define a widget resolver with priority 10 --&gt; 
  &lt;extension
  point=&quot;org.eclipse.tptp.test.auto.gui.widgetResolver&quot;&gt;
     &lt;widgetResolver 
      id = &quot;org.eclipse.tptp.test.auto.gui.adaptive&quot;
      class=&quot;org.eclipse.tptp.test.auto.gui.internal.recorder.AdaptiveWidgetResolver&quot;
      priority=&quot;10&quot;
     /&gt;
  &lt;/extension&gt;
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="apiInfo"/>
      </appInfo>
      <documentation>
         [Enter API information here.]
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="implementation"/>
      </appInfo>
      <documentation>
         [Enter information about supplied implementation of this extension point.]
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="copyright"/>
      </appInfo>
      <documentation>
         Copyright (c) 2005, 2006 IBM Corporation 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 &lt;a href=&quot;http://www.eclipse.org/legal/epl-v10.html&quot;&gt;http://www.eclipse.org/legal/epl-v10.html&lt;/a&gt;
      </documentation>
   </annotation>

</schema>




/*******************************************************************************
 * Copyright (c) 2005, 2008 IBM Corporation 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
 * $Id: AutoGUITestCasesForm.java,v 1.23 2008/04/10 01:28:58 paules Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation

import org.eclipse.tptp.test.auto.gui.internal.actions.AutoGUIRefreshAction;
import org.eclipse.tptp.test.auto.gui.internal.actions.AutoGUITestCaseAction;
import org.eclipse.tptp.test.auto.gui.internal.actions.AutoGUIUpdateTestCaseAction;
import org.eclipse.tptp.test.auto.gui.internal.core.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.editor.AutoGUITestCaseTreeStructure.MacroUIInstruction;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptor;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMineManager;
import org.eclipse.ui.IActionBars;
import org.eclipse.ui.actions.ActionFactory;
import org.eclipse.ui.forms.IManagedForm;



/** 
 * This form provides the 'macro-examine' page that allows users to easily navigate through
 * a macro and make the appropriate adjustments.
 * 
 * 
 * @author      Ali Mehregani
 * @author      Paul E. Slauenwhite
 * @version     April 7, 2008
 * @since       August 19, 2006
 */
public class AutoGUITestCasesForm extends TestCasesEclipseForm implements ITextEditorExtension2

	private Text startingPttxt;
	
	/* The object mine tree */
	private AutoGUIMacroObjectDescriptorMineTreeStructure objectMineTree;

	/* The object mine listener */
	private ObjectMineTreeListener objectMineListener;

		lastTreeHierarchySelected = new LinkedList();
		logicalTreeRepresentaion = new AutoGUITestCaseTreeStructure (editor, Common_TestprofilePackage.eINSTANCE.getTPFTestSuite_TestCases());
		logicalRepresentationListener = new LogicalRepresentationListener();
		objectMineTree = new AutoGUIMacroObjectDescriptorMineTreeStructure(this, editor);		
		linearOperationHistory = new DefaultOperationHistory();		
		context = new Hashtable();
		isOperationHistory = true;

			{
				Object[] selectedItems = ((StructuredSelection)selectedEntity).toArray();
				Integer[] lineLevelDetail = null;
				if (selectedItems.length == 1 && selectedItems[0] instanceof MacroObjectDescriptor)
					lineLevelDetail = (Integer[])((MacroObjectDescriptor)selectedItems[0]).getData();
				
				/* Select the XML fragment if the line level information is available */
				if (lineLevelDetail != null)

				return;
								
			/* Update the offest that each tree item keeps track */
			MacroObjectDescriptorMineManager.getInstance().markObjectMineDirty (getTestSuite());
			if (isOperationHistory)
			{
				objectMineTree.updateOffsetRelation(AutoGUITestCasesForm.this, objectMineTree.getLineOffsetRelation(), event.length, event.replacedText.length());

		}
	}
	
	public AutoGUIMacroObjectDescriptorMineTreeStructure getObjectMineTreeStruct()
	{
		return objectMineTree;
	}




/*******************************************************************************
 * Copyright (c) 2006, 2008 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.editor;

import java.io.ByteArrayInputStream;
import java.util.ArrayList;
import java.util.Hashtable;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.hyades.models.common.facades.behavioral.ITestCase;
import org.eclipse.hyades.test.ui.adapter.TestWorkbenchAdapter;
import org.eclipse.hyades.test.ui.internal.editor.form.util.EObjectTreeContentProvider;
import org.eclipse.hyades.ui.editor.IEditorExtension;
import org.eclipse.hyades.ui.internal.provider.WorkbenchAdapterLabelProvider;
import org.eclipse.jface.viewers.IContentProvider;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIImages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.editor.AutoGUITestCasesForm.GUITestCaseProperties;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.util.XMLDefaultHandler;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * This class represents the test case tree
 * 
 * 
 * @author      Ali Mehregani
 * @author      Paul E. Slauenwhite
 * @version     March 5, 2008
 * @since       March 17, 2006
 */
public class AutoGUITestCaseTreeStructure extends AutoGUIAbstractTreeStructure implements ISelectionChangedListener
{
	/** Stores the cached parsed macro <br/>
	 * Key = Test case id <br/>
	 * Value = An array list containing the macro UI instructions that fall
	 * under it. <br/>
	 */
	private Hashtable cachedParsedMacro;
	
	
	/**
	 * Stores the line number and offset of a macro: <br/>
	 * Key = Test case object of type ITestCase <br/>
	 * Value = An array list with the following content:
	 * 		   Index of the array list = line number in the macro
	 * 		   Value of the array list element = offset in the
	 * 		   macro corresponding to the line number <br/>
	 */
	private Hashtable cachedLineOffsetIndicator;
	
	/** Allows for the retrieval of test case properties */
	private GUITestCaseProperties testCasePropertyManager;
	
	/** The currently selected test case */
	private ITestCase selectedTestCase;
	
	
	/**
	 * Constructor 
	 * @param editorPart The editor part
	 * @param eStructuralFeature The structural feature
	 */
	public AutoGUITestCaseTreeStructure(IEditorExtension editorPart, EStructuralFeature eStructuralFeature)
	{
		super(editorPart, eStructuralFeature);
		cachedParsedMacro = new Hashtable();
		cachedLineOffsetIndicator = new Hashtable();
		testCasePropertyManager = new GUITestCaseProperties();
	}
		
	/**
	 * Overwrite this method so that a custom content provider can be 
	 * registered with the tree
	 */
	protected IContentProvider createContentProvider()
	{
		getTreeViewer().addSelectionChangedListener(this);
		return new TestCaseTreeContentProvider(editorPart, getEStructuralFeature());
	}
		
	
	/**
	 * Overwrite this method so that a custom label provider can be 
	 * registered with the tree
	 */
	protected ILabelProvider createLabelProvider()
	{
		return new TestCaseTreeLabelProvider(TestWorkbenchAdapter.class);
	}
	
	
	/**
	 * Parses the test case and creates its associatreb
	 * 
	 * @param testCase The test case to be parsed
	 * @return An array list of the direct elements of test case  
	 */
	private ArrayList parseMacro(ITestCase testCase) 
	{	
		testCasePropertyManager.setTestCase(testCase);
		String macro = testCasePropertyManager.getProperty(GUITestCaseProperties.MACRO_FRAGMENT);
		
		try 
		{
			XMLDefaultHandler handler = MacroManager.getInstance().createMacroDocument(new ByteArrayInputStream(macro.getBytes("UTF-8")));
			ArrayList macroInstructions = new ArrayList();
			findMacroInstructions (macroInstructions, handler.getDocumentElement(), handler.getLineTable(), 0, 0);
			cachedParsedMacro.put(testCase.getId(), macroInstructions);
			return macroInstructions;
		} 
		catch (Throwable t)
		{
			/* There was an error parsing the XML.  Create an error element and return it */
			MessageUIElement element = new MessageUIElement(IStatus.ERROR, NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_TST_MACRO_XML, t.getMessage()));
			ArrayList error = new ArrayList();
			error.add(element);
			return error;
		}		
	}
	
	private void findMacroInstructions(ArrayList macroInstructions, Node node, Hashtable lineTable, int shellNumber, int commandNumber) 
	{
		/* Traverse the node and create the tree items for each shell or command element */
		NodeList nodeList = node.getChildNodes();
		Node currentNode;
		String currentNodeName;
		for (int i = 0, nodeListCount = nodeList.getLength(); i < nodeListCount; i++)
		{
			currentNode = nodeList.item(i);
			currentNodeName = currentNode.getNodeName();
			MacroUIInstruction uiInstruction = null;
			if (currentNodeName.equals(MacroConstants.SHELL_ELEMENT))
			{
				String textValue = getAttribute(currentNode, MacroConstants.DESCRIPTIVE_ATTRIBUTE, null);
				if (textValue == null)
					textValue = NLS.bind(AutoGUIMessages.TST_SUITE_AUTO_MACRO_SHELL, String.valueOf(shellNumber++)) +  getAttribute(currentNode, MacroConstants.ID_ATTRIBUTE, "");
				
				uiInstruction = new MacroUIInstruction(textValue, (Integer[])lineTable.get(currentNode));				
				findMacroInstructions (uiInstruction.getSubInstructions(), currentNode, lineTable, shellNumber, 0);
			}
			else if (currentNodeName.equals(MacroConstants.COMMAND_ELEMENT))
			{
				String textValue = getAttribute(currentNode, MacroConstants.TYPE_ATTRIBUTE, MacroConstants.COMMAND_ELEMENT);
				String descriptiveField = getAttribute(currentNode, MacroConstants.DESCRIPTIVE_ATTRIBUTE, null);
				if (descriptiveField != null)
					textValue += " \"" + descriptiveField + "\"";
				
				uiInstruction = new MacroUIInstruction(textValue, (Integer[])lineTable.get(currentNode));				
			}			
			
			if (uiInstruction != null)
				macroInstructions.add(uiInstruction);
		}
	}
	
	private String getAttribute(Node node, String attributeName, String defaultValue)
	{
		Node textNode = node.getAttributes().getNamedItem(attributeName);		
		String text = (textNode == null ? defaultValue : textNode.getNodeValue());
		
		return text;
	}
	
	
	/**
	 * Returns an array list that indicates the line offset relation of a macro
	 * for a test case.
	 * 
	 * @param testCase The test case whose line-offest relation will be returned.
	 * @return An array list (the index of the array list indicates the line number
	 * of the macro and the value of the array list indicates the offset value).
	 */
	public ArrayList getLineOffsetRelation(ITestCase testCase)
	{
		if (testCase == null)
			return null;
		
		ArrayList lineOffsetIndicator = (ArrayList)cachedLineOffsetIndicator.get(testCase);
		if (lineOffsetIndicator == null)
		{
			lineOffsetIndicator = findLineOffsetIndicator (testCase);
			if (lineOffsetIndicator == null)
				return null;
			
			cachedLineOffsetIndicator.put(testCase, lineOffsetIndicator);
		}
		
		return lineOffsetIndicator;
	}
	
	
	/**
	 * Looks up the current test case selected and returns its associated 
	 * line-offset relation
	 *  
	 * @return The line-offset relation.
	 */
	public ArrayList getLineOffsetRelation()
	{
		return getLineOffsetRelation(getSelectedTestCase());
	}
	
	
	/**
	 * Find line-offset relation
	 * 
	 * @param testCase The test case
	 * @return The line-offset relation for a test case macro.
	 */
	private ArrayList findLineOffsetIndicator(ITestCase testCase)
	{
		testCasePropertyManager.setTestCase(testCase);
		String macroStr = testCasePropertyManager.getProperty(GUITestCaseProperties.MACRO_FRAGMENT);
		
		return super.findLineOffsetIndicator(macroStr);
	}

	
	/**
	 * Detect the selection change and update the selection-dependent
	 * controls.
	 * 
	 * @param event The selection event
	 */	 
	public void selectionChanged(SelectionChangedEvent event)
	{
		TreeItem[] treeItems = this.getTreeViewer().getTree().getSelection();
		selectedTestCase = null;
		 
		for (int i = 0; i < treeItems.length; i++)
		{
			 ITestCase rootTestCase = findRootTestCase(treeItems[i]);
			 if (selectedTestCase != null && selectedTestCase != rootTestCase)
			 {
				 selectedTestCase = null;
				 return;
			 }
			 selectedTestCase = rootTestCase;
		}
	}


	public ITestCase findRootTestCase(TreeItem item)
	{
		TreeItem parentItem = item.getParentItem();
		if (parentItem == null)
		{
			Object data = item.getData();
			if (data instanceof ITestCase)
				return (ITestCase)data;
			return null;
		}
		else 
			return findRootTestCase(parentItem);		
	}

	
	/**
	 * Return the currently selected test case.  It can be null in the
	 * case of multiple selections or if no test case is selected
	 * 
	 * @return the currently selected test case
	 */
	public ITestCase getSelectedTestCase ()
	{
		return selectedTestCase;
	}
	
	
	/**
	 * Need to overwrite this method since there are no buttons whose status need
	 * to be updated.
	 */
	protected void updateActionsAndButtons(IStructuredSelection structuredSelection)
	{
		/* purposely left blank */
	}
	
	
	/**
	 * Need to overwrite this method since there are no buttons whose label
	 * need to be set.
	 */
	protected void adjustButtonLabels(String addLabel)
	{
		/* An empty set of button labels */
		setButtonLabels (new String[]{});
	}
	

	
	protected void adjustClient(Composite parent)
	{
		getTreeViewer().setContentProvider(createContentProvider());
		getTreeViewer().setLabelProvider(createLabelProvider());
		getTreeViewer().setAutoExpandLevel(0);
	}
	/**
	 * The content provider for the custom test case tree.
	 * This content provider will be used to add commands under the test cases
	 * 
	 * @author Ali Mehregani
	 */
	private class TestCaseTreeContentProvider extends EObjectTreeContentProvider
	{

		public TestCaseTreeContentProvider(IEditorExtension editorPart, EStructuralFeature eStructuralFeature)
		{
			super(editorPart, eStructuralFeature);
		}		
		
		/**
		 * @see org.eclipse.jface.viewers.ITreeContentProvider#getChildren(java.lang.Object)
		 */
		public Object[] getChildren(Object parentElement)
		{
			ArrayList children = new ArrayList();
			
			/* A test case */
			if (parentElement instanceof ITestCase)
			{
				ITestCase testCase = (ITestCase)parentElement;
				String testCaseId = testCase.getId();
				
				/* Is it in cache? */
				ArrayList testCaseCommands = (ArrayList) cachedParsedMacro.get(testCaseId);
				
				/* Didn't find it in the cache */
				if (testCaseCommands == null)
					testCaseCommands = parseMacro(testCase);					
								
				children.addAll(testCaseCommands);				
			}
			/* A macro UI instruction */
			else if (parentElement instanceof MacroUIInstruction)
			{
				children.addAll(((MacroUIInstruction)parentElement).getSubInstructions());
			}
			
			Object[] childrenArray = new Object[children.size()];
			children.toArray(childrenArray);
			return childrenArray;
		}
		
		
		public boolean hasChildren(Object element)
		{
			/* A test case */
			if (element instanceof ITestCase)
			{
				return true;
			}
			
			/* A macro UI instruction */
			else if (element instanceof MacroUIInstruction)
			{
				/* Does it have sub instrucitons */
				ArrayList subInstructions = ((MacroUIInstruction)element).getSubInstructions();
				return subInstructions != null && subInstructions.size() > 0;
			}
			
			return false;
		}
	}
	
	
	/**
	 * The label provider for the custom test case tree.
	 * This label provider will be used to add the required images and labels of each
	 * tree item.
	 * 
	 * @author Ali Mehregani
	 */
	private static class TestCaseTreeLabelProvider extends WorkbenchAdapterLabelProvider
	{

		public TestCaseTreeLabelProvider(Class cl) throws IllegalArgumentException
		{
			super(cl);
		}
		
	    public String getText(Object element)
	    {
	    	/* A test case */
	    	if (element instanceof ITestCase)
	    	{
	    		String testCaseName = ((ITestCase)element).getName();
	    		return testCaseName == null ? AutoGUIMessages.TST_SUITE_AUTO_MACRO_TEST_CASE : ((ITestCase)element).getName();
	    	}
	    	
	    	/* A macro instruction */
	    	else if (element instanceof MacroUIInstruction)
	    	{	    		
	    		String instructionText = ((MacroUIInstruction)element).getText();
	    		return instructionText == null ? AutoGUIMessages.TST_SUITE_AUTO_MACRO_INSTRUCTION : instructionText;
	    	}
	    	
	    	/* An error message */
	    	else if (element instanceof MessageUIElement)
	    	{
	    		String message = ((MessageUIElement)element).getText();	    		
	    		return message == null ? AutoGUIMessages.TST_SUITE_AUTO_MACRO_MESSAGE : message; 
	    	}
	    	
	    	return "";	    	
	    }
		
	    public Image getImage(Object element)
	    {
	    	/* A test case */
	    	if (element instanceof ITestCase)
	    		return AutoGUIImages.getInstance().getImage("e", AutoGUIImages.IMG_NEW_AUTO_GUI);
	    	
	    	/* A macro instruction */
	    	else if (element instanceof MacroUIInstruction)
	    	{
	    		MacroUIInstruction uiInstruction = (MacroUIInstruction)element;
	    		ArrayList subInstructions = uiInstruction.getSubInstructions();
	    		
	    		/* A shell */
	    		if (subInstructions != null && subInstructions.size() > 0)
	    			return AutoGUIImages.getInstance().getImage(AutoGUIImages.SHELL);
	    		
	    		/* A command */
	    		else 
	    			return AutoGUIImages.getInstance().getImage(AutoGUIImages.COMMAND);
	    	}
	    	
	    	/* An error message */
	    	else if (element instanceof MessageUIElement)
	    	{
	    		((MessageUIElement)element).getIcon();
	    	}
	    	
	    	return null;
	    }
	}
	
	/**
	 * The UI representation of a macro instruction
	 * 
	 * @author Ali Mehregani
	 */
	protected static class MacroUIInstruction
	{
		/** If a macro UI instruction is a shell, then it will have sub instructions */ 
		private ArrayList subInstructions;
		
		/** The text of the command */
		private String text;
		
		/** The line number.  This is expected to be of size 2 (indicating the start and
		 * end line number for the command */
		private Integer[] lineNumber;
				
		
		/**
		 * Constructor
		 * @param text The text of the UI element
		 * @param lineNumber The line number is epx
		 */
		public MacroUIInstruction(String text, Integer[] lineNumber)
		{
			subInstructions = new ArrayList();
			this.lineNumber = lineNumber;
			this.text = formatText(text);
		}


		/**
		 * @return the lineNumber
		 */
		public Integer[] getLineNumber()
		{
			return lineNumber;
		}


		/**
		 * @param lineNumber the lineNumber to set
		 */
		public void setLineNumber(Integer[] lineNumber)
		{
			this.lineNumber = lineNumber;
		}


		/**
		 * @return the subInstructions
		 */
		public ArrayList getSubInstructions()
		{
			return subInstructions;
		}


		/**
		 * @param subInstructions the subInstructions to set
		 */
		public void setSubInstructions(ArrayList subInstructions)
		{
			this.subInstructions = subInstructions;
		}

		
		/**
		 * Returns a formatted version of the text
		 * 
		 * @param text The text to be formatted
		 * @return The formatted text.
		 */
		protected String formatText (String text)
		{
			int start = lineNumber[0].intValue();
			int end = lineNumber[1].intValue();
			String lineNumber;
			
			if (start == end)
				lineNumber = String.valueOf(start);
			else
				lineNumber = start + "-" + end;
			
			return text + " (" + AutoGUIMessages.TST_SUITE_AUTO_MACRO_LINE_NUM + " " + lineNumber + ")";
		}

		/**
		 * @return the text
		 */
		public String getText()
		{
			return text;
		}


		/**
		 * @param text the text to set
		 */
		public void setText(String text)
		{
			this.text = text;
		}
		
		
	}
	
	
	/**
	 * Represents an element that only displays an error/warning
	 * message.
	 * 
	 * @author Ali Mehregani
	 *
	 */
	protected static class MessageUIElement
	{
		/** The severity of the message */
		private int severity;
		
		/** The actual message */
		private String text;
		
		public MessageUIElement(int severity, String text)
		{
			this.severity = severity;
			this.text = text;
		}

		/**
		 * @return the severity
		 */
		public int getSeverity()
		{
			return severity;
		}

		/**
		 * @param severity the severity to set
		 */
		public void setSeverity(int severity)
		{
			this.severity = severity;
		}

		/**
		 * @return the text
		 */
		public String getText()
		{
			return text;
		}

		/**
		 * @param text the text to set
		 */
		public void setText(String text)
		{
			this.text = text;
		}		
		
		
		public Image getIcon()
		{    		    		
    		/* An error */
    		if (severity == IStatus.ERROR)
    			return AutoGUIImages.getInstance().getImage(AutoGUIImages.ERROR);
    		/* A warning */
    		else if (severity == IStatus.WARNING)
    			return AutoGUIImages.getInstance().getImage(AutoGUIImages.WARNING);
    		
    		return null;
		}
	}


	public void refresh()
	{
		cachedParsedMacro.clear();
		cachedLineOffsetIndicator.clear();
		selectedTestCase = null;
		getTreeViewer().setSelection(null);
		getTreeViewer().refresh();
	}
	
	public int getTreeStryle()
	{
		return super.getTreeStryle() | SWT.BORDER;
	}
}




/*******************************************************************************
 * Copyright (c) 2006, 2008 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.editor;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.hyades.models.common.facades.behavioral.impl.HyadesUtil;
import org.eclipse.hyades.test.common.util.XMLUtil;
import org.eclipse.hyades.test.ui.adapter.TestWorkbenchAdapter;
import org.eclipse.hyades.test.ui.internal.editor.form.util.EObjectTreeContentProvider;
import org.eclipse.hyades.ui.editor.IEditorExtension;
import org.eclipse.hyades.ui.internal.provider.WorkbenchAdapterLabelProvider;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.viewers.IContentProvider;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIImages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.core.IObjectMine;
import org.eclipse.tptp.test.auto.gui.internal.core.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.dialogs.AutoGUITestSuiteDialog;
import org.eclipse.tptp.test.auto.gui.internal.editor.AutoGUITestCaseTreeStructure.MessageUIElement;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.ObjectMineManager;

/**
 * Represents the object mine tree that is displayed in the test
 * case page of the editor.
 * 
 * @author      Ali Mehregani
 * @author      Paul E. Slauenwhite
 * @version     March 7, 2008
 * @since       July 10, 2006
 */
public class AutoGUIObjectMineTreeStructure extends AutoGUIAbstractTreeStructure
{
	/** Represents the root element in the object mine tree */
	private static final RootUIObjectMineTreeNode ROOT_ELEMENT = new RootUIObjectMineTreeNode();

	/** The test case form */
	private AutoGUITestCasesForm testCaseForm;

	/** The content provider */
	private ObjectMineTreeContentProvider contentProvider;
	
	/** The label provider */
	private ObjectMineLabelProvider labelProvider;
	
	/** The line number and offset relation.  The index of the list represents the line
	 * number and the value is an object of type Integer[0] indicating the start
	 * and end offset */
	private List lineOffsetRelation;
	
	/** The include object mine menu item */
	private IncludeObjectMineAction includeObjectMineAction;
	
	/** Change output menu item */
	private ChangeOutputAction changeOutputAction;
			
	/** Keeps track of the test suite used as input */
	private ITestSuite testSuiteInput;
	
	/** Stores any error that occurred while loading the object mine */
	private Object[] error;
	
	public AutoGUIObjectMineTreeStructure(AutoGUITestCasesForm testCaseForm, IEditorExtension editorPart)
	{
		super(editorPart, null);
		this.testCaseForm = testCaseForm;
		lineOffsetRelation = new ArrayList();
		includeObjectMineAction = new IncludeObjectMineAction();
		changeOutputAction = new ChangeOutputAction();
	}
	
	/**
	 * Overwrite this method so that a custom content provider can be 
	 * registered with the tree
	 */
	protected IContentProvider createContentProvider()
	{
		if (contentProvider == null)
			contentProvider = new ObjectMineTreeContentProvider(editorPart, getEStructuralFeature());
		return contentProvider;
	}
		
	
	/**
	 * Overwrite this method so that a custom label provider can be 
	 * registered with the tree
	 * 
	 * @return The label provider for the object mine tree
	 */
	protected ILabelProvider createLabelProvider()
	{
		if (labelProvider == null)
			labelProvider = new ObjectMineLabelProvider(TestWorkbenchAdapter.class);
		return labelProvider;
	}

	
	
	/**
	 * Overwrite this method so that custom buttons can be added beside the 
	 * object mine tree.
	 */
	protected void adjustButtonLabels(String addLabel)
	{
		setButtonLabels (new String[0]);
	}
	
	
	/**
	 * Need to overwrite this method since there are no buttons whose status need
	 * to be updated.
	 */
	protected void updateActionsAndButtons(IStructuredSelection structuredSelection)
	{
		/* purposely left blank */
	}
	
	
	/**
	 * Refreshes the content of this tree by forcing the test suite to reload its
	 * object mine.
	 */
	public void refresh()
	{
		ObjectMineManager.getInstance().clearCache();
		loadObjectMine(testSuiteInput, false);
		getTreeViewer().refresh();
	}
	
	
	public List getLineOffsetRelation()
	{
		return lineOffsetRelation;
	}
	
	
	/**
	 * Needs to be overwritten to modify the default tree style 
	 */
	public int getTreeStryle()
	{
		return super.getTreeStryle() | SWT.BORDER;
	}
	
	
	private Object[] createErrorItem(String prefix, Exception e)
	{
		Throwable cause = AutoGUIUtil.findCause(e);
		prefix += prefix == null ? "": ": ";
		prefix += (cause.getMessage() == cause.getClass().getName() ? "" : " " + cause.getMessage());
		prefix += ": " + e.getStackTrace()[0].getClassName() + ":" + e.getStackTrace()[0].getLineNumber(); 
		return new Object[]{new MessageUIElement(IStatus.ERROR, prefix)};
	}
	
	
	/**
	 * Overwrite this method so that custom menu items can be added to the entries that are
	 * displayed in the object mine tree.
	 * 
	 * @param menuManager The menu manager
	 */
	protected void fillContextMenu(IMenuManager menuManager)
	{
		IStructuredSelection selection = getStructuredSelection();
		if (!selection.isEmpty() && selection.size() == 1 && selection.getFirstElement() instanceof RootUIObjectMineTreeNode)
		{
			menuManager.add(includeObjectMineAction);
			menuManager.add(changeOutputAction);
		}
	}
	
	
	private IObjectMine loadObjectMine(ITestSuite testSuite, boolean showError)
	{
		IObjectMine input = null;
		if (testSuite == null)
		{
			testSuiteInput = null;				
			return null;
		}
		
		try
		{				
			testSuiteInput =(ITestSuite)testSuite;
			input = ObjectMineManager.getInstance().loadObjectMine(testSuiteInput);
			String objectMineXML = HyadesUtil.getTestSuiteVariable(testSuiteInput, GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE);
			lineOffsetRelation = AutoGUIObjectMineTreeStructure.this.findLineOffsetIndicator(objectMineXML);
			error = null;
		}
		catch (Exception e)
		{	
			if (showError)
			{
				AutoGUIUtil.openErrorWithDetail(
						AutoGUIMessages.AUTO_GUI_COMMON_ERROR, 
						AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE + ": " + testSuite.getName(), 
						e);
			}
			else
			{
				error = createErrorItem(AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE, e);
			}
			
			input = null;
		}
		
		return input;
	}
	
	
	/**
	 * The content provider for the object mine tree.
	 * 
	 * @author Ali Mehregani
	 */
	private class ObjectMineTreeContentProvider extends EObjectTreeContentProvider
	{				
		public ObjectMineTreeContentProvider(IEditorExtension editorPart, EStructuralFeature eStructuralFeature)
		{
			super(editorPart, eStructuralFeature);
		}		

		public Object[] getElements(Object inputElement)
		{			
			return new Object[]{ROOT_ELEMENT};
		}

		
		/**
		 * @see org.eclipse.jface.viewers.ITreeContentProvider#getChildren(java.lang.Object)
		 */
		public Object[] getChildren(Object parentElement)
		{	
			IObjectMine input = loadObjectMine(testSuiteInput, false);
			if (input == null)
			{	
				if (parentElement == ROOT_ELEMENT && error != null)
					return error;		
			}
			
			/* If the test suite doesn't have an object mine then return an empty list */
			String objectMineXML = null;
			if (testSuiteInput == null || (objectMineXML = HyadesUtil.getTestSuiteVariable(testSuiteInput, GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE)) == null || objectMineXML.length() <= 0)
				return null;


			if (parentElement == ROOT_ELEMENT)
			{
				return input.getChildren();
			}
			else if (parentElement instanceof IUIObject)
			{
				return ((IUIObject)parentElement).getChildren();
			}
						
			return null;
		}
	

		public boolean hasChildren(Object parentElement)
		{
			IObjectMine input = loadObjectMine(testSuiteInput, false);
			if (parentElement == ROOT_ELEMENT)
			{
				return input == null ? error != null : input.getChildren().length > 0;
			}
			else if (parentElement instanceof IUIObject)
			{
				return ((IUIObject)parentElement).childCount() > 0;
			}
			
			return false;
		}
		
		/**
		 * @see org.eclipse.jface.viewers.ITreeContentProvider#getParent(java.lang.Object)
		 */
		public Object getParent(Object element)
		{
			if (element instanceof IUIObject)
			{
				IUIObject parent = ((IUIObject)element).getParent(); 
				return parent == null ? (Object)ROOT_ELEMENT : parent;
			}
			return null;
		}
		
		public void inputChanged(Viewer viewer, Object oldInput, Object newInput)
		{
			if (!(newInput instanceof ITestSuite))
				return;
			
			loadObjectMine((ITestSuite)newInput, false);

		}
	}
	
	
	private class ObjectMineLabelProvider extends WorkbenchAdapterLabelProvider
	{

		public ObjectMineLabelProvider(Class cl) throws IllegalArgumentException
		{
			super(cl);
		}
		
	    public String getText(Object element)
	    {
	    	if (element == ROOT_ELEMENT)
	    	{
	    		return AutoGUIMessages.TST_SUITE_AUTO_MACRO_OBJ_MINE;
	    	}
	    	else if (element instanceof IUIObject)
	    	{
	    		String descriptiveField = ((IUIObject)element).getDescriptive();
	    		return descriptiveField == null ? AutoGUIMessages.TST_SUITE_AUTO_MACRO_OBJ_OBJECT : XMLUtil.removeXMLSymbols(descriptiveField);
	    	}
	    	else if (element instanceof MessageUIElement)
	    	{
	    		String message = ((MessageUIElement)element).getText();	    		
	    		return message == null ? AutoGUIMessages.TST_SUITE_AUTO_MACRO_MESSAGE : message;
	    	}
	    	
	    	return MacroConstants.EMPTY_STRING;	    	
	    }
		
	    public Image getImage(Object element)
	    {	    	
	    	if (element == ROOT_ELEMENT)
	    	{
	    		return AutoGUIImages.getInstance().getImage(AutoGUIImages.OBJECT_MINE);
	    	}
	    	else if (element instanceof IUIObject)
	    	{
	    		IUIObject parent  = ((IUIObject)element).getParent();
	    		return parent == null ? AutoGUIImages.getInstance().getImage(AutoGUIImages.SHELL) : AutoGUIImages.getInstance().getImage(AutoGUIImages.WIDGET);
	    	}
	    	else if (element instanceof MessageUIElement)
	    	{
	    		return ((MessageUIElement)element).getIcon();
	    	}
	    	
	    	return null;
	    }
	}
	
	
	/**
	 * A dummy class that represents the root element in the object mine
	 * tree.
	 */
	private static class RootUIObjectMineTreeNode
	{	
	}
	
	
	/**
	 * The include object mine action.  The purpose of this action is to allow
	 * the user to include object mines under the test suite's object mine
	 * 
	 * @author Ali Mehregani
	 */
	private class IncludeObjectMineAction extends Action
	{
		/**
		 * Perform the action.
		 * 
		 */
		public void run() 
		{			
			/* Display the test suite list dialog */
			AutoGUITestSuiteDialog autoGUITestSuiteDialog = new AutoGUITestSuiteDialog(
					GuiPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getShell(), 
					testSuiteInput, 
					AutoGUIMessages.AUTO_GUI_TST_DIALOG_TREE_ITITLE, 
					false);
			
			if(autoGUITestSuiteDialog.open() == IDialogConstants.CANCEL_ID)
				return;
			
			
			/* Get the selected test suites and include them as part of this test suite's object mine */
			Collection tests = autoGUITestSuiteDialog.getTests();
			IObjectMine input = loadObjectMine(testSuiteInput, true);
			boolean markdirty = false;
			for (Iterator testIterator = tests.iterator(); testIterator.hasNext();)
			{
				Object currentTestSuite = testIterator.next();
				if (!(currentTestSuite instanceof ITestSuite))
					continue;
							
				ITestSuite testSuite = (ITestSuite)currentTestSuite;
				try
				{
					IObjectMine objectMine = ObjectMineManager.getInstance().loadObjectMine(testSuite);
					if (objectMine != null && !input.getIncludes().contains(objectMine))
					{
						markdirty = true;
						input.addInclude(objectMine);
					}						
				} 
				catch (Exception e)
				{
					/* Display an error */
					AutoGUIUtil.openErrorWithDetail(
							AutoGUIMessages.AUTO_GUI_COMMON_ERROR, 
							NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_DIALOG_TST_INCL, testSuite.getName()), 
							e);
				} 
			}
			
			if (markdirty)
			{
				testCaseForm.updateTestProperty(null, input.serializeToString(), true);
				getTreeViewer().setSelection(getTreeViewer().getSelection());
			}
		}
		
		
		public boolean isEnabled() 
		{
			return testSuiteInput != null;
		}
		
		public String getText() 
		{
			return AutoGUIMessages.AUTO_GUI_TST_DIALOG_TREE_INCL;
		}
		
		public ImageDescriptor getImageDescriptor() 
		{
			return AutoGUIImages.getInstance().getImageDescriptor("e", AutoGUIImages.INCLUDE);
		}
	}
	
	
	/**
	 * This action changes the output of the object mine to another test suite.
	 * 
	 * @author Ali Mehregani
	 */
	private class ChangeOutputAction extends Action
	{
		/**
		 * Perform the action.
		 */
		public void run() 
		{			
			/* Display the test suite list dialog */
			AutoGUITestSuiteDialog autoGUITestSuiteDialog = new AutoGUITestSuiteDialog(
					GuiPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getShell(), 
					testSuiteInput, 
					AutoGUIMessages.AUTO_GUI_TST_DIALOG_TREE_ITITLE, 
					true);
			
			if(autoGUITestSuiteDialog.open() == IDialogConstants.CANCEL_ID)
				return;
			
			
			/* Get the selected test suites and include them as part of this test suite's object mine */
			Collection tests = autoGUITestSuiteDialog.getTests();			
			if (tests == null)
				return;
			
			Object[] selectedTestContainer = tests.toArray();
			if (selectedTestContainer.length != 1 || !(selectedTestContainer[0] instanceof ITestSuite))
				return;
			
			IObjectMine input = loadObjectMine(testSuiteInput, true);
			IObjectMine oldOutputObjectMine = input.getOutputSource();
			ITestSuite oldOutput = oldOutputObjectMine == null ? null : oldOutputObjectMine.getOwner();
			ITestSuite newOutput = (ITestSuite)selectedTestContainer[0];			
			if (oldOutput == null || (!oldOutput.getId().equals(newOutput.getId())))
			{
				IObjectMine objectMine = null;
				try
				{
					objectMine = ObjectMineManager.getInstance().loadObjectMine(newOutput);
					input.setOutputSource(objectMine);
					testCaseForm.updateTestProperty(null, input.serializeToString(), true);
					getTreeViewer().setSelection(getTreeViewer().getSelection());
				} 
				catch (Exception e)
				{
					input.setOutputSource(null);
					AutoGUIUtil.openErrorWithDetail(
							AutoGUIMessages.AUTO_GUI_COMMON_ERROR, 
							NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_OBJ_MINE_OUTPUT, newOutput.getName()), 
							e);
				} 
			}						
		}
		
		
		public boolean isEnabled() 
		{
			return testSuiteInput != null;
		}
		
		public String getText() 
		{
			return AutoGUIMessages.AUTO_GUI_TST_DIALOG_TREE_OUPUT;
		}
		
		public ImageDescriptor getImageDescriptor() 
		{
			return AutoGUIImages.getInstance().getImageDescriptor("e", AutoGUIImages.OUTPUT);
		}
	}
}




/*******************************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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
 * $Id: AutoGUIRecordAction.java,v 1.9 2008/03/05 18:27:00 paules Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.actions;

import java.io.PrintWriter;
import java.io.StringWriter;

import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.hyades.models.common.facades.behavioral.ITestCase;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.hyades.test.tools.core.common.util.TestCommonUtil;
import org.eclipse.hyades.test.tools.ui.common.internal.editor.action.AddTestCase;
import org.eclipse.hyades.test.tools.ui.common.internal.util.IITestSuiteProvider;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIImages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.codegen.AutoGUIGenerator;
import org.eclipse.tptp.test.auto.gui.internal.codegen.CodeGeneratorHelper;
import org.eclipse.tptp.test.auto.gui.internal.commands.VerificationCommand;
import org.eclipse.tptp.test.auto.gui.internal.dialogs.AutoGUIInputCollectorDialog;
import org.eclipse.tptp.test.auto.gui.internal.dialogs.AutoGUITestControllerDialog;
import org.eclipse.tptp.test.auto.gui.internal.dialogs.AutoGUITestControllerDialog.AutoGUIControllerListener;
import org.eclipse.tptp.test.auto.gui.internal.editor.AutoGUITestCasesForm;
import org.eclipse.tptp.test.auto.gui.internal.editor.AutoGUITestCasesForm.GUITestCaseProperties;
import org.eclipse.tptp.test.auto.gui.internal.macro.Macro;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.macro.ModeConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager.GlobalStateListener;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager.VerificationHookListener;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMineManager;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.WorkbenchException;

/**
 * Handles the addition of auto gui test cases
 * 
 * 
 * @author      Ali Mehregani
 * @author      Paul E. Slauenwhite
 * @author      Alexander Nyssen
 * @version     March 5, 2008
 * @since       March 17, 2006
 */
public class AutoGUIRecordAction extends AddTestCase implements AutoGUIControllerListener {

	/* The test suite provider */
	private IITestSuiteProvider suiteProvider;

	/* The perspective the user was in before adding a test case */
	private String perspectiveId;

	/* Control center dialog */
	private AutoGUITestControllerDialog controllerDialog;

	/* A global state listener */
	private CustomGlobalStateListener globalStateListener;

	/* Start record dialog */
	private AutoGUIInputCollectorDialog inputCollectorDialog;

	/* Stores the user input collected from the input dialog */
	private AutoGUIInputCollectorDialog.AutoGUIInputContainer userInput;

	/* The test suite provider */
	private IITestSuiteProvider testSuiteProvider;

	/**
	 * The constructor
	 * 
	 * @param testSuiteProvider
	 *            The test suite provider used to get the test suite associated with this action
	 * @param baseName
	 *            The base name of the test case
	 */
	public AutoGUIRecordAction(IITestSuiteProvider testSuiteProvider, String baseName) {
		super(testSuiteProvider,
			GuiPlugin.getTestSuiteType(),
			baseName);
		this.suiteProvider = testSuiteProvider;
		this.testSuiteProvider = testSuiteProvider;
		setToolTipText(AutoGUIMessages.TST_SUITE_AUTO_MACRO_RECORD);
		setImageDescriptor(AutoGUIImages.getInstance().getImageDescriptor("e",
			AutoGUIImages.RECORD));

		IWorkbench workbench = GuiPlugin.getDefault().getWorkbench();
		IWorkbenchWindow activeWorkbenchWindow = workbench.getActiveWorkbenchWindow();
		Shell activeShell = activeWorkbenchWindow.getShell();
		inputCollectorDialog = new AutoGUIInputCollectorDialog(activeShell);
	}

	/**
	 * Invoked when this action is create
	 */
	public void run() {
		setActionPerformed(false);
		IWorkbench workbench = GuiPlugin.getDefault().getWorkbench();
		IWorkbenchWindow activeWorkbenchWindow = workbench.getActiveWorkbenchWindow();
		Shell activeShell = activeWorkbenchWindow.getShell();
		userInput = inputCollectorDialog.openDialog();

		/* We don't need to do anything if cancel is pressed */
		if (userInput == null || !userInput.isOkPressed()) {
			setActionPerformed(true);
			return;
		}

		/*
		 * Otherwise, we'll need to add the test case. Here are the phases: - Switch to the perspective that corresponds to the starting point of the
		 * test case - Display the control center dialog box - Begin recording user actions
		 */
		userInput.setDescription(userInput.getDescription() == null
			? ""
			: userInput.getDescription());

		/* Switch the perspecitve */
		try {
			/* Store the perspective that we're in before switching it */
			perspectiveId = activeWorkbenchWindow.getActivePage().getPerspective().getId();
			workbench.showPerspective(userInput.getStartingPoint(),
				activeWorkbenchWindow);
		}
		catch (WorkbenchException e) {
			/* Something wrong happened while chaning the perspective. Show an error */
			String[] errorArgs = {userInput.getStartingPoint(), e.getMessage()};
			AutoGUIUtil.openErrorWithDetail(AutoGUIMessages.AUTO_GUI_ERROR_PERS_SWITCH_TITLE,
				NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_PERS_SWITCH,
					errorArgs),
				e);
		}

		/* Display the control center dialog box asynchronously */
		controllerDialog = new AutoGUITestControllerDialog(activeShell);
		controllerDialog.registerListener(this);
		controllerDialog.openDialog();

		MacroManager macroManagerInstance = MacroManager.getInstance();
		globalStateListener = new CustomGlobalStateListener(false);
		macroManagerInstance.registerGlobalStateListener(globalStateListener);
		macroManagerInstance.setGlobalState(ModeConstants.RECORDING_MODE);
		controllerDialog.setStatus(AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_REC);

		startRecording(userInput.isObjectMineOn());
		setActionPerformed(true);
	}

	private void startRecording(boolean isObjectMineOn) {
		/* The control center is now open. Start recording the user's actions */
		try {
			MacroManager.getInstance().startRecording(suiteProvider.getTestSuite(),
				isObjectMineOn);
		}
		catch (Exception e) {
			MacroManager.getInstance().setObjectMine(null);
			;
			if (controllerDialog != null) {
				controllerDialog.terminate();
			}

			AutoGUIUtil.openErrorWithDetail(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_REC_TITLE,
				AutoGUIMessages.AUTO_GUI_ERROR_MACRO_REC,
				e);
		}
	}

	protected void adjusTestCase(ITestCase testCase) {
	}

	public void handleEvent(byte event, Object value) {
		MacroManager macroManager = MacroManager.getInstance();

		switch (event) {
			/*
			 * When user terminates, we have to take the macro and transfer it to the test suite. We'll also need to reset the perspective back to
			 * what it was
			 */
			case AutoGUITestControllerDialog.TERMINATE:
				try {
					/* Stop the macro */
					Macro macro = macroManager.stopRecording(false);

					/* Something went wrong in the macro manager */
					if (macro == null) {
						/* Display error message and switch to the original perspective of the user */
						IWorkbench workbench = GuiPlugin.getDefault().getWorkbench();
						MessageDialog.openError(workbench.getActiveWorkbenchWindow().getShell(),
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_GENERATE_T,
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_GENERATE);

						try {
							workbench.showPerspective(perspectiveId,
								workbench.getActiveWorkbenchWindow());
						}
						catch (WorkbenchException e) {
							/* Not a huge deal if we can't restore the perspective */
						}

						return;
					}

					StringWriter swriter = null;
					try {
						swriter = new StringWriter();
						PrintWriter pwriter = new PrintWriter(swriter);
						macro.write(0,
							pwriter);
						pwriter.close();
						swriter.close();
					}
					catch (Exception e) {
						String messageWithOrigin = AutoGUIUtil.getOriginOfException(e);
						String cause = messageWithOrigin + "\n" + AutoGUIUtil.getExceptionStackTrace(e);
						AutoGUIUtil.openErrorWithDetail(GuiPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getShell(),
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_STOP_TITLE,
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_STOP,
							cause);

						return;
					}

					/* Create the test case and add the required properties */
					ITestSuite testSuite = getTestSuite();
					boolean isExternalBehavior = testSuite.getImplementor().isExternalImplementor();
					ITestCase testcase = TestCommonUtil.createTestCase(testSuite,
						getType(),
						isExternalBehavior,
						userInput.getName());
					testcase.setDescription(userInput.getDescription());

					/* Add the starting point */
					((AutoGUITestCasesForm) suiteProvider).addProperty(testcase,
						GUITestCaseProperties.STARTING_PT,
						userInput.getStartingPoint());

					/* Add the macro */
					String contents = swriter.toString();

					/* Get rid of the last line break */
					int lastLineBreak = contents.lastIndexOf(GlobalConstants.LINE_SEPARATOR);
					if (lastLineBreak != -1 && contents.substring(lastLineBreak).trim().length() <= 0)
						contents = contents.substring(0,
							lastLineBreak);

					((AutoGUITestCasesForm) suiteProvider).addProperty(testcase,
						GUITestCaseProperties.MACRO_FRAGMENT,
						contents);

					/* Switch the perspective to where we were before */
					try {
						IWorkbench workbench = GuiPlugin.getDefault().getWorkbench();
						workbench.showPerspective(perspectiveId,
							workbench.getActiveWorkbenchWindow());
					}
					catch (WorkbenchException e) {
						/* Not a huge deal if we can't restore the perspective */
					}

					adjusTestCase(testcase);

					/* Cause a selection event */
					if (testSuiteProvider instanceof AutoGUITestCasesForm) {
						AutoGUITestCasesForm testCaseForm = (AutoGUITestCasesForm) testSuiteProvider;
						testCaseForm.getLogicalRepresentationListener().selectionChanged(null);
						testCaseForm.getLogicalTreeRepresentaion().selectionChanged(null);
						testCaseForm.getObjectMineTreeStruct().refresh();
					}
				}
				catch (Throwable t) {
					t.printStackTrace();
				}

				break;

			/* A verificaiton point is inserted */
			case AutoGUITestControllerDialog.VERIFICATION_HOOK_INSERT:

				/* Make sure the verification hook name conforms to the standard defined */
				String hookName = (String) value;
				boolean validName = hookName != null && !hookName.equals("") && hookName.length() < 100 && !containSpecialChars(hookName);
				if (!validName) {
					/* display an error */
					macroManager.setGlobalState(ModeConstants.SUSPEND_MODE);

					AutoGUIUtil.openErrorWithDetail(GuiPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getShell(),
						AutoGUIMessages.AUTO_GUI_ERROR_VER_INVALID_NM_T,
						AutoGUIMessages.AUTO_GUI_ERROR_VER_INVALID_NM,
						(String) null);

					macroManager.setGlobalState(ModeConstants.RECORDING_MODE);
					return;
				}

				macroManager.setGlobalState(ModeConstants.SUSPEND_MODE);
				controllerDialog.setStatus(AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_GEN);

				AutoGUIGenerator generator =
					new AutoGUIGenerator(((AutoGUITestCasesForm) suiteProvider).getTestSuite(), CodeGeneratorHelper.AUTO_GUI_VERIFICATION_HOOK_CLASS);
				try {
					generator.createChange(new NullProgressMonitor()).perform(new NullProgressMonitor());
				}
				catch (Exception e) {
					/* There was an error in generating the source code */
					AutoGUIUtil.openErrorWithDetail(AutoGUIMessages.AUTO_GUI_ERROR_VER_GEN_SRC_T,
						AutoGUIMessages.AUTO_GUI_ERROR_VER_GEN_SRC,
						e);

					return;
				}

				macroManager.setGlobalState(ModeConstants.RECORDING_MODE);
				controllerDialog.setStatus(AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_REC);

				/* Allow the user to select an editor or a view */
				controllerDialog.setStatus(AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_VER);
				macroManager.setVerListener(new CustomVerHookListener(generator, hookName, controllerDialog.isVerficationScopeExtended()));
				macroManager.setGlobalState(ModeConstants.VERIFICATION_MODE);

				if (globalStateListener != null)
					globalStateListener.turnOn(true);

				break;

			/* The restart button is pressed */
			case AutoGUITestControllerDialog.RESTART:
				/* Restart recording */
				macroManager.stopRecording(true);
				MacroObjectDescriptorMineManager.getInstance().clearCache();
				AutoGUIUtil.showMessage(AutoGUIMessages.AUTO_GUI_CONTROL_RESTART_MSG_T,
					AutoGUIMessages.AUTO_GUI_CONTROL_RESTART_MSG,
					MessageDialog.INFORMATION);
				startRecording(MacroManager.getInstance().isObjectMineOn());

				if (!controllerDialog.isPositionBasedOn())
					break;

				/* The position based recording option is turned on/off */
			case AutoGUITestControllerDialog.POSITION_BASED:
				boolean success = MacroManager.getInstance().togglePositionBasedRec(controllerDialog.isPositionBasedOn());

				if (success) {
					if (controllerDialog.isPositionBasedOn())
						controllerDialog.setStatus(AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_POS);
					else
						controllerDialog.setStatus(AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_REC);
				}

				break;

			/* Wait time recording is turned on/off */
			case AutoGUITestControllerDialog.WAIT_TIME:
				MacroManager.getInstance().setArtificialWaitOn(controllerDialog.isWaitTimeOn());

		}

	}

	private boolean containSpecialChars(String hookName) {
		boolean condition = false;

		char currentChar = hookName.charAt(0);
		condition = (currentChar < 65 || currentChar > 90) && (currentChar < 97 || currentChar > 122);

		if (condition)
			return condition;

		for (int i = 1; i < hookName.length(); i++) {
			currentChar = hookName.charAt(i);
			condition =
				(currentChar < 65 || currentChar > 90)
					&& (currentChar < 97 || currentChar > 122)
					&& (currentChar < 48 || currentChar > 57)
					&& currentChar != 36
					&& currentChar != 95;
			if (condition)
				return condition;
		}
		return false;
	}

	public class CustomVerHookListener implements VerificationHookListener {

		private String verHook;
		private boolean extendedScope;
		private AutoGUIGenerator generator;
		private boolean instanceReady;

		public CustomVerHookListener(AutoGUIGenerator generator, String verificationHook, boolean extendedScope) {
			this.verHook = verificationHook;
			this.extendedScope = extendedScope;
			this.generator = generator;
			this.instanceReady = false;
		}

		public synchronized void error(String error) {
			if (!instanceReady)
				controllerDialog.setStatus(error);
			else
				controllerDialog.setStatus(AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_REC);
		}

		public synchronized void instanceReady(VerificationCommand verificationCommand) {
			instanceReady = true;
			/* We no longer need this class after being notified of the instance construciton */
			MacroManager.getInstance().removeVerListener();

			controllerDialog.setStatus(AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_INS);

			/* Insert a method in the source file corresponding to the name of the verification hook */
			try {
				/*
				 * We got the instance that we were looking for. Time to generate the method in the source code that is associated with this test
				 * suite
				 */
				String contextArgument = "Q";
				contextArgument += verificationCommand.getContextClass().getName();
				contextArgument += ";";

				String[] args;
				if (!extendedScope) {
					args = new String[] {contextArgument};
				}
				else {
					// construct a second argument for the UI object being selected
					String widgetArgument = "Q";
					widgetArgument += verificationCommand.getWidgetClass().getName();
					widgetArgument += ";";
					
					String objectArgument = null;
					if(verificationCommand.getObjectClass() != null){
						objectArgument = "Q";
						objectArgument += verificationCommand.getObjectClass().getName();
						objectArgument += ";";						
					}

					args = objectArgument == null ? new String[2] : new String[3];
					args[0] = contextArgument;
					args[1] = widgetArgument;
					if(objectArgument != null){
						args[2] = objectArgument;
					}
				}

				/* This should never happen */
				if (contextArgument.length() <= 2)
					throw new Exception(AutoGUIMessages.AUTO_GUI_ERROR_VER_NOT_SUPP_CON);

				/* Complete the verification command's meta data */
				ITestSuite testSuite = ((AutoGUITestCasesForm) suiteProvider).getTestSuite();
				verificationCommand.setLocation(testSuite.getImplementor().getLocation());
				verificationCommand.setResource(testSuite.getImplementor().getResource());
				verificationCommand.setHook(verHook + ":" + (args.length > 1 ? (args.length > 2 ? args[0] + args[1] + args[2] : args[0] + args[1]) : args[0]));
				verificationCommand.setExtendedScope(extendedScope);

				generator.setInput(userInput.getName(),
					userInput.getDescription());
				generator.createMethod(verHook,
					args);
			}
			catch (Exception e) {
				MessageDialog.openWarning(GuiPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getShell(),
					AutoGUIMessages.AUTO_GUI_ERROR_VER_GEN_METHOD_T,
					NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_VER_GEN_METHOD,
						e.getLocalizedMessage()));
			}

			/* Change the state of the macro manager to recording */
			if (globalStateListener != null)
				globalStateListener.turnOn(false);
			MacroManager.getInstance().setGlobalState(ModeConstants.RECORDING_MODE);
			controllerDialog.setStatus(AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_REC);

		}

	}

	public class CustomGlobalStateListener implements GlobalStateListener {

		private boolean isOn;

		public CustomGlobalStateListener(boolean isOn) {
			this.isOn = isOn;
		}

		public void turnOn(boolean isOn) {
			this.isOn = isOn;
		}

		public boolean isListenerOn() {
			return isOn;
		}

		public void globalStateChange(byte oldState, byte newState) {
			/*
			 * We're only interested when we're in verification mode and we get interrupted
			 */
			if (oldState == ModeConstants.VERIFICATION_MODE && newState == ModeConstants.SUSPEND_MODE) {
				controllerDialog.setStatus(AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_REC);
			}
		}

	}
}
		}
		
	}
}




/*******************************************************************************
 * Copyright (c) 2006 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.actions;

import java.io.ByteArrayInputStream;
import java.lang.reflect.Method;
import java.util.Hashtable;
import java.util.Map;

import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.editor.AutoGUITestCasesForm;
import org.eclipse.tptp.test.auto.gui.internal.editor.AutoGUITestCasesForm.GUITestCaseProperties;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptor;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMineManager;
import org.eclipse.tptp.test.auto.gui.internal.util.XMLDefaultHandler;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * This action will update the macro of the selected test cases to use the
 * latest syntax of the macro.
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen
 */
public class AutoGUIUpdateTestCaseAction extends AutoGUITestCaseAction
{
	/** Versions */
	private static final String VERSION_1_0 = "1.0";
	private static final String VERSION_1_1 = "1.1";

	/**
	 * The updater table contains the method name that can update a particular
	 * version of a macro KEY = The macro version that can be updated VALUE =
	 * The method name that will do the update
	 */
	private Map updaterTable;

	/** The object mine that belongs to the test suite of this action */
	private MacroObjectDescriptorMine objectMine;

	public AutoGUIUpdateTestCaseAction(AutoGUITestCasesForm testCaseForm,
			String text, ImageDescriptor imageDescriptor) {
		super(testCaseForm, text, imageDescriptor);
		setEnabled(false);

		/* Initialize the updater table */
		updaterTable = new Hashtable();
		final String VERSION_0_1 = "0.1";
		final String UPDATER__0_1__1_0 = "Update_0_1_to_1_0";
		final String UPDATER__1_0__1_1 = "Update_1_0_to_1_1";
		updaterTable.put(VERSION_0_1, UPDATER__0_1__1_0);
		updaterTable.put(VERSION_1_0, UPDATER__1_0__1_1);
	}

	/**
	 * Invoked when the action is executed. Walk through each of the selected
	 * test cases and update their corresponding macro.
	 */
	public void run() {
		if (!MessageDialog.openQuestion(GuiPlugin.getDefault().getWorkbench()
				.getActiveWorkbenchWindow().getShell(),
				AutoGUIMessages.AUTO_GUI_TST_CASE_UPDATE_TITLE,
				AutoGUIMessages.AUTO_GUI_TST_CASE_UPDATE)) {
			return;
		}

		try {
			objectMine = MacroObjectDescriptorMineManager.getInstance()
					.loadObjectMine(testCaseForm.getTestSuite());
		} catch (Exception e) {
			AutoGUIUtil.openErrorWithDetail(
					AutoGUIMessages.AUTO_GUI_COMMON_ERROR,
					AutoGUIMessages.AUTO_GUI_ERROR_MACRO_REC, e);
			return;
		}

		/* For each selected test case */
		boolean updated = false;
		for (int i = 0; i < selectedTestCases.length; i++) {
			/* Parse the macro of the selected test case */
			String testCaseMacro = testCaseForm.getProperty(
					selectedTestCases[i], GUITestCaseProperties.MACRO_FRAGMENT);
			if (testCaseMacro == null || testCaseMacro.length() <= 0)
				continue;

			XMLDefaultHandler handler = null;
			Node rootElement = null;
			try {
				handler = MacroManager.getInstance().createMacroDocument(
						new ByteArrayInputStream(testCaseMacro
								.getBytes("UTF-8")));
				rootElement = handler.getDocumentElement();
			} catch (Exception e) {
				/* Handled by the next line */
			}

			if (rootElement == null
					&& !MacroConstants.MACRO_ELEMENT.equals(rootElement
							.getNodeName()))
				continue;

			/*
			 * Look up the current version of the macro and call its
			 * corresponding update method
			 */
			Node macroVersion = rootElement.getAttributes().getNamedItem(
					MacroConstants.VERSION_ATTRIBUTE);
			String currentVersion;
			if (macroVersion == null
					|| (currentVersion = macroVersion.getNodeValue()) == null)
				continue;

			/* For every sequential update required */
			String updater = null;
			boolean updateTestCaseMacro = false;
			while ((updater = (String) updaterTable.get(currentVersion)) != null) {
				try {
					Method method = this.getClass().getMethod(
							updater,
							new Class[] { XMLDefaultHandler.class,
									MacroObjectDescriptor.class, Node.class });
					if (method != null) {
						currentVersion = (String) (method.invoke(this,
								new Object[] { handler, null, rootElement }));
						updateTestCaseMacro = true;
					} else {
						break;
					}
				} catch (Exception e) {
					/* Should not happen */
					e.printStackTrace();
					break;
				}
			}

			/* Update the test case macro and the object mine */
			if (updateTestCaseMacro) {
				updated = true;
				StringBuffer buffer = new StringBuffer();
				serializeXMLToString(buffer, rootElement, 0);
				testCaseForm.updateTestProperty(null, buffer.toString(), false);

				MacroObjectDescriptorMineManager.getInstance().writeObjectMine(
						objectMine);
				testCaseForm.refresh();
			}
		}

		if (!updated) {
			MessageDialog.openInformation(GuiPlugin.getDefault().getWorkbench()
					.getActiveWorkbenchWindow().getShell(),
					AutoGUIMessages.AUTO_GUI_COMMON_INFORMATION,
					AutoGUIMessages.AUTO_GUI_TST_CASE_NO_UPDATE);
		}
	}

	private void serializeXMLToString(StringBuffer buffer, Node node, int indent) {
		/* Write the current element */
		boolean hasChildren = node.hasChildNodes();
		boolean hasAttributes = node.hasAttributes();
		String nodeName = node.getNodeName();
		final String TEXT_NODE_NAME = "#text";

		if (TEXT_NODE_NAME.equals(nodeName)) {
			String textContent = node.getNodeValue().trim();
			boolean isContentEmpty = textContent == null
					|| MacroConstants.EMPTY_STRING.equals(textContent);
			;
			if (!isContentEmpty) {
				MacroUtil.addIndent(buffer, indent);
				buffer.append(textContent);
				buffer.append(GlobalConstants.LINE_SEPARATOR);
			}

			return;
		}

		MacroUtil.addElement(buffer, indent, nodeName, !hasChildren
				&& !hasAttributes, !hasAttributes);

		/* Get the attributes */
		if (hasAttributes) {
			NamedNodeMap attributes = node.getAttributes();
			int attCount = attributes.getLength();
			String[] attributeNames = new String[attCount];
			String[] attributeValues = new String[attCount];
			for (int i = 0; i < attCount; i++) {
				Node currentAttribute = attributes.item(i);
				attributeNames[i] = currentAttribute.getNodeName();
				attributeValues[i] = currentAttribute.getNodeValue();
			}
			MacroUtil.addAttribute(buffer, attributeNames, attributeValues,
					!hasChildren, true);
		}

		/* For each child */
		NodeList nodeList = node.getChildNodes();
		for (int i = 0, nodeListCount = nodeList.getLength(); i < nodeListCount; i++) {
			serializeXMLToString(buffer, nodeList.item(i), indent + 1);
		}

		/* Close the XML node */
		if (hasChildren) {
			MacroUtil.addElement(buffer, indent, nodeName, true, true);
		}

	}

	/**
	 * Converts a prior 1.1 context id to the new 1.1. format (using separators
	 * instead of PATH.SEPARATOR)
	 * 
	 * @param oldContextId
	 * @return
	 */
	private String convertSerializedContextId(String oldContextId) {
		if (oldContextId != null
				&& (oldContextId.startsWith(MacroConstants.LOCAL_TOOLBAR_VALUE)
						|| oldContextId.startsWith(MacroConstants.POPUP_VALUE) || oldContextId
						.startsWith(MacroConstants.TAB_VALUE))
				&& oldContextId
						.indexOf(MacroConstants.WIDGET_ID_SUFFIX_SEPARATOR) < 0) {
			// may be old format (or the context id does not use a
			// nested serealized macro object id), have to convert
			IPath wpath = new Path(oldContextId);
			String widgetId = wpath.lastSegment();
			wpath = wpath.removeLastSegments(1);
			while (widgetId.startsWith("}}")) {
				widgetId = wpath.lastSegment() + IPath.SEPARATOR + widgetId;
				wpath = wpath.removeLastSegments(1);
			}
			String contextId = wpath.toString()
					+ MacroConstants.WIDGET_ID_SUFFIX_SEPARATOR + widgetId;
			return contextId;
		}
		return oldContextId;
	}

	/*
	 * Convert widget id where the object id was stored as suffix into distinct
	 * widget and object ids
	 */
	private String[] convertConcatWidgetId(String oldWidgetId) {
		if (oldWidgetId != null
				&& oldWidgetId
						.indexOf(MacroConstants.OBJECT_ID_SUFFIX_SEPARATOR) >= 0) {
			String[] uiObjectId = new String[2];
			uiObjectId[0] = oldWidgetId.substring(0, oldWidgetId
					.indexOf(MacroConstants.OBJECT_ID_SUFFIX_SEPARATOR));
			uiObjectId[1] = oldWidgetId.substring(oldWidgetId
					.indexOf(MacroConstants.OBJECT_ID_SUFFIX_SEPARATOR) + 3);
			return uiObjectId;
		}
		return new String[] { oldWidgetId };
	}

	public String Update_1_0_to_1_1(XMLDefaultHandler handler,
			MacroObjectDescriptor parent, Node rootNode) {
		NodeList nodeList = rootNode.getChildNodes();
		Node currentNode;

		/* Update the version of the macro */
		if (MacroConstants.MACRO_ELEMENT.equals(rootNode.getNodeName())) {
			NamedNodeMap rootAttributes = rootNode.getAttributes();
			Node versionAttribute = null;
			if (rootAttributes != null
					&& (versionAttribute = rootAttributes
							.getNamedItem(MacroConstants.VERSION_ATTRIBUTE)) != null) {
				versionAttribute.setNodeValue(VERSION_1_1);
			}
		}

		/* For each child */
		for (int i = 0, nodeListCount = nodeList.getLength(); i < nodeListCount; i++) {
			currentNode = nodeList.item(i);
			NamedNodeMap attributes = currentNode.getAttributes();
			if (attributes == null)
				continue;

			// Fix old context identifiers (serialized widget identifiers)
			if (attributes.getNamedItem(MacroConstants.CONTEXT_ID_ATTRIBUTE) != null) {
				Node contextIdAttributeNode = attributes
						.getNamedItem(MacroConstants.CONTEXT_ID_ATTRIBUTE);
				String oldContextId = contextIdAttributeNode.getNodeValue();
				String newContextId = convertSerializedContextId(oldContextId);
				if (!oldContextId.equals(newContextId)) {
					contextIdAttributeNode.setNodeValue(newContextId);
				}
			}

			// Replace old ID attribute of shell with WIDGET_ID (now used
			// globally)
			if (attributes.getNamedItem(MacroConstants.ID_ATTRIBUTE) != null) {
				Node idAttributeNode = attributes
						.getNamedItem(MacroConstants.ID_ATTRIBUTE);
				String widgetId = idAttributeNode.getNodeValue();
				attributes.removeNamedItem(MacroConstants.ID_ATTRIBUTE);
				Node widgetIdAttribute = handler.getDocument().createAttribute(
						MacroConstants.WIDGET_ID_ATTRIBUTE);
				widgetIdAttribute.setNodeValue(widgetId);
				attributes.setNamedItem(widgetIdAttribute);
			}

			// Fix old widget identifiers (that have the object id as suffix)
			if (attributes.getNamedItem(MacroConstants.WIDGET_ID_ATTRIBUTE) != null) {
				Node widgetIdAttributeNode = attributes
						.getNamedItem(MacroConstants.WIDGET_ID_ATTRIBUTE);
				String oldWidgetId = widgetIdAttributeNode.getNodeValue();
				String[] uiObjectId = convertConcatWidgetId(oldWidgetId);
				if (!oldWidgetId.equals(uiObjectId[0])) {
					widgetIdAttributeNode.setNodeValue(uiObjectId[0]);
					// we have an object id, add an object id
					if (uiObjectId.length > 1) {
						Node objectIdAttribute = handler.getDocument()
								.createAttribute(
										MacroConstants.OBJECT_ID_ATTRIBUTE);
						objectIdAttribute.setNodeValue(uiObjectId[1]);
						attributes.setNamedItem(objectIdAttribute);
					}
				}
			}

			// Replace old PATH attribute of item -> now also WIDGET_ID
			boolean isItem = MacroConstants.ITEM_ELEMENT.equals(currentNode
					.getNodeName())
					|| MacroConstants.SELECT_ITEM_ELEMENT.equals(currentNode
							.getNodeName());
			if (isItem
					&& attributes.getNamedItem(MacroConstants.PATH_ATTRIBUTE) != null) {
				Node idAttributeNode = attributes
						.getNamedItem(MacroConstants.PATH_ATTRIBUTE);
				String widgetId = idAttributeNode.getNodeValue();
				attributes.removeNamedItem(MacroConstants.PATH_ATTRIBUTE);
				Node widgetIdAttribute = handler.getDocument().createAttribute(
						MacroConstants.WIDGET_ID_ATTRIBUTE);
				widgetIdAttribute.setNodeValue(widgetId);
				attributes.setNamedItem(widgetIdAttribute);
			}

			// // replace the old CHOICE_ID attribute -> now the more general
			// OBJECT_ID can be used
			// if (attributes.getNamedItem(MacroConstants.CHOICE_ID_ATTRIBUTE)
			// != null) {
			// Node idAttributeNode = attributes
			// .getNamedItem(MacroConstants.CHOICE_ID_ATTRIBUTE);
			// String objectId = idAttributeNode.getNodeValue();
			// attributes.removeNamedItem(MacroConstants.CHOICE_ID_ATTRIBUTE);
			// Node objectIdAttribute = handler.getDocument().createAttribute(
			// MacroConstants.OBJECT_ID_ATTRIBUTE);
			// objectIdAttribute.setNodeValue(objectId);
			// attributes.setNamedItem(objectIdAttribute);
			// }

			// if the object is stored in the object mine, make sure the old
			// context id is converted
			Node refIdNode = attributes
					.getNamedItem(MacroConstants.REFERENCE_ID_ATTRIBUTE);
			String refId = refIdNode == null ? null : refIdNode.getNodeValue();
			boolean isShell = MacroConstants.SHELL_ELEMENT.equals(currentNode
					.getNodeName());

			MacroObjectDescriptor descriptor = null;
			if (refId != null) {
				descriptor = objectMine.lookupMacroObjectDescriptor(
						isShell ? null : parent, refId);
				// fix the context id
				if (descriptor != null) {
					descriptor
							.setContextId(convertSerializedContextId(descriptor
									.getContextId()));
				}

				// NOTE: the object id was not stored as suffix of the widget id up to now (due to a bug),
				// so we do not have to convert it here.
				
				// the ID -> WIDGET_ID conversion is done implicitly for the
				// stored descriptors when saving the object mine
			}

			if (currentNode.hasChildNodes())
				Update_1_0_to_1_1(handler, descriptor == null ? parent
						: descriptor, currentNode);

		}
		return VERSION_1_1;
	}

	public String Update_0_1_to_1_0(XMLDefaultHandler handler,
			MacroObjectDescriptor parent, Node rootNode) {
		NodeList nodeList = rootNode.getChildNodes();
		Node currentNode;

		/* Update the version of the macro */
		if (MacroConstants.MACRO_ELEMENT.equals(rootNode.getNodeName())) {
			NamedNodeMap rootAttributes = rootNode.getAttributes();
			Node versionAttribute = null;
			if (rootAttributes != null
					&& (versionAttribute = rootAttributes
							.getNamedItem(MacroConstants.VERSION_ATTRIBUTE)) != null) {
				versionAttribute.setNodeValue(VERSION_1_0);
			}
		}

		/* For each child */
		for (int i = 0, nodeListCount = nodeList.getLength(); i < nodeListCount; i++) {
			currentNode = nodeList.item(i);
			NamedNodeMap attributes = currentNode.getAttributes();
			if (attributes == null)
				continue;

			Node contextIdNode = attributes
					.getNamedItem(MacroConstants.CONTEXT_ID_ATTRIBUTE);
			boolean isShell = MacroConstants.SHELL_ELEMENT.equals(currentNode
					.getNodeName());
			boolean isItem = MacroConstants.ITEM_ELEMENT.equals(currentNode
					.getNodeName())
					|| MacroConstants.SELECT_ITEM_ELEMENT.equals(currentNode
							.getNodeName());
			String idAttributeName = isShell ? MacroConstants.ID_ATTRIBUTE
					: isItem ? MacroConstants.PATH_ATTRIBUTE
							: MacroConstants.WIDGET_ID_ATTRIBUTE;
			Node widgetIdNode = attributes.getNamedItem(idAttributeName);

			String contextId = contextIdNode == null ? null : contextIdNode
					.getNodeValue();
			String widgetId = widgetIdNode == null ? null : widgetIdNode
					.getNodeValue();

			MacroObjectDescriptor uiObject = null;
			if (widgetId != null) {
				uiObject = objectMine.lookupMacroObjectDescriptor(
						isShell ? null : parent, contextId, widgetId, null);
				if (uiObject == null) {
					try {
						uiObject = new MacroObjectDescriptor(parent);
						((MacroObjectDescriptor) uiObject)
								.setContextId(contextId);
						((MacroObjectDescriptor) uiObject)
								.setDescriptive(attributes
										.getNamedItem(MacroConstants.DESCRIPTIVE_ATTRIBUTE) == null ? MacroConstants.OBJECT_ELEMENT
										: attributes
												.getNamedItem(
														MacroConstants.DESCRIPTIVE_ATTRIBUTE)
												.getNodeValue());
						((MacroObjectDescriptor) uiObject)
								.setWidgetId(widgetId);
						((MacroObjectDescriptor) uiObject).setObjectId(null);
						((MacroObjectDescriptor) uiObject)
								.setParent(isShell ? null : parent);
						objectMine
								.registerObject((MacroObjectDescriptor) uiObject);
					} catch (Exception e) {
						/* Shouldn't happen */
						e.printStackTrace();
					}
				}

				if (uiObject != null) {
					if (contextId != null)
						attributes
								.removeNamedItem(MacroConstants.CONTEXT_ID_ATTRIBUTE);
					attributes.removeNamedItem(idAttributeName);
					Node refIdAttribute = handler.getDocument()
							.createAttribute(
									MacroConstants.REFERENCE_ID_ATTRIBUTE);
					refIdAttribute.setNodeValue(uiObject.getReferenceId());
					attributes.setNamedItem(refIdAttribute);
				}
			}

			if (currentNode.hasChildNodes())
				Update_0_1_to_1_0(handler,
						uiObject == null ? parent : uiObject, currentNode);
		}

		return VERSION_1_0;
	}

}




/*******************************************************************************
 * Copyright (c) 2006, 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.actions;

import org.eclipse.hyades.models.common.facades.behavioral.ITestCase;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIImages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.editor.AutoGUITestCasesForm;
import org.eclipse.tptp.test.auto.gui.internal.editor.AutoGUITestCasesForm.GUITestCaseProperties;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.macro.ModeConstants;
import org.eclipse.tptp.test.auto.gui.internal.runner.AutoGUIRunner;
import org.eclipse.tptp.test.auto.gui.internal.runner.ExtendedScriptParser;
import org.eclipse.tptp.test.auto.gui.internal.runner.AutoGUIRunner.ITestRunnerDelegator;
import org.eclipse.tptp.test.auto.gui.internal.runner.ExtendedScriptParser.ExtendedTestCase;
import org.eclipse.tptp.test.auto.gui.internal.runner.ExtendedScriptParser.ExtendedTestSuite;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.WorkbenchException;

/**
 * Represents the play action
 *
 * 
 * @author      Ali Mehregani
 * @author      Paul E. Slauenwhite
 * @author      Alexander Nyssen
 * @version     March 5, 2008
 * @since       March 17, 2006
 */
public class AutoGUIPlayAction extends AutoGUITestCaseAction implements ITestRunnerDelegator
{
	/** The perspective id */
	private String perspectiveId;
	
	/**
	 * Constructor
	 */
	public AutoGUIPlayAction(AutoGUITestCasesForm testCaseForm)
	{
		super(testCaseForm, AutoGUIMessages.AUTO_GUI_EDT_QUICK_RUN_TOOL_TIP, AutoGUIImages.getInstance().getImageDescriptor("c", AutoGUIImages.PLAY));
		setDisabledImageDescriptor(AutoGUIImages.getInstance().getImageDescriptor("d", AutoGUIImages.PLAY));
		setEnabled(false);
	}

	
	/**
	 * The quick launch button is been invoked
	 */
	public void run()
	{	
		/* Change the state of the macro manager */
		MacroManager.getInstance().setGlobalState(ModeConstants.QUICK_RUN_MODE);
		
		/* This handler attempts to closely simulate the environment set before the 
		 * auto gui runner is executed.  This is important in order to make the quick
		 * launch mode closely similar to a launch of a test suite when a proper launch
		 * configuration is used. */				
		if (selectedTestCases == null || selectedTestCases.length <= 0)
			return;
		
		/* Walk through each selected test case and create the appropriate environment */
		ExtendedScriptParser parser = new ExtendedScriptParser();
		ExtendedTestSuite root = parser.new ExtendedTestSuite();
		for (int i = 0; i < selectedTestCases.length; i++)
		{	
			ITestCase testCaseEObject = selectedTestCases[i];
			ExtendedTestCase testCase = parser.new ExtendedTestCase();
			
			/* Set the id, name, description, starting point, and macro fragment of the test case */
			testCase.setId(testCaseEObject.getId());
			testCase.setName(testCaseEObject.getName());
			testCase.setDescription(testCaseEObject.getDescription());
			
			testCase.addProperty(String.valueOf(GUITestCaseProperties.STARTING_PT), testCaseForm.getProperty(testCaseEObject, GUITestCaseProperties.STARTING_PT));
			testCase.addProperty(String.valueOf(GUITestCaseProperties.MACRO_FRAGMENT), testCaseForm.getProperty(testCaseEObject, GUITestCaseProperties.MACRO_FRAGMENT));
			testCase.setTestSuite(root);
		}
		
		/* Store the perspective that we're in before switching it */
		IWorkbench workbench = GuiPlugin.getDefault().getWorkbench();
		perspectiveId = workbench.getActiveWorkbenchWindow().getActivePage().getPerspective().getId();
		
		AutoGUIRunner artificialRunner = new AutoGUIRunner();
		artificialRunner.runTestInCurrentContext(testCaseForm.getTestSuite(), root, this);					
	}


	public void finishedTestRun() 
	{				
		GuiPlugin.getDefault().getWorkbench().getDisplay().syncExec(new Runnable(){
			public void run() 
			{			
				/* Change the state back to idle */
				MacroManager.getInstance().setGlobalState(ModeConstants.IDLE_MODE);
				
				/* Re-store perspective */
				try
				{
					IWorkbench workbench = GuiPlugin.getDefault().getWorkbench();
					workbench.showPerspective (perspectiveId, workbench.getActiveWorkbenchWindow());
				}
				catch (WorkbenchException e)
				{
					/* Not a big deal if we can't re-store the perspective */
				}						
			}
		});
	}
}

Lines 2-8 Link Here

(-)META-INF/MANIFEST.MF (-2 / +10 lines)
2	Bundle-ManifestVersion: 2	2	Bundle-ManifestVersion: 2
3	Bundle-Name: %pluginName	3	Bundle-Name: %pluginName
4	Bundle-SymbolicName: org.eclipse.tptp.test.auto.gui; singleton:=true	4	Bundle-SymbolicName: org.eclipse.tptp.test.auto.gui; singleton:=true
5	Bundle-Version: 4.4.0.qualifier	5	Bundle-Version: 4.5.0.qualifier
6	Bundle-ClassPath: autogui.jar	6	Bundle-ClassPath: autogui.jar
7	Bundle-Activator: org.eclipse.tptp.test.auto.gui.internal.GuiPlugin	7	Bundle-Activator: org.eclipse.tptp.test.auto.gui.internal.GuiPlugin
8	Bundle-Vendor: %providerName	8	Bundle-Vendor: %providerName
Lines 11-22 Link Here
11	org.eclipse.tptp.test.auto.gui.internal.actions,	11	org.eclipse.tptp.test.auto.gui.internal.actions,
12	org.eclipse.tptp.test.auto.gui.internal.codegen,	12	org.eclipse.tptp.test.auto.gui.internal.codegen,
13	org.eclipse.tptp.test.auto.gui.internal.commands,	13	org.eclipse.tptp.test.auto.gui.internal.commands,
		14	org.eclipse.tptp.test.auto.gui.internal.commands.factory,
14	org.eclipse.tptp.test.auto.gui.internal.core,	15	org.eclipse.tptp.test.auto.gui.internal.core,
15	org.eclipse.tptp.test.auto.gui.internal.dialogs,	16	org.eclipse.tptp.test.auto.gui.internal.dialogs,
16	org.eclipse.tptp.test.auto.gui.internal.editor,	17	org.eclipse.tptp.test.auto.gui.internal.editor,
17	org.eclipse.tptp.test.auto.gui.internal.macro,	18	org.eclipse.tptp.test.auto.gui.internal.macro,
18	org.eclipse.tptp.test.auto.gui.internal.resolvers,	19	org.eclipse.tptp.test.auto.gui.internal.macroobject,
		20	org.eclipse.tptp.test.auto.gui.internal.macroobject.mine,
		21	org.eclipse.tptp.test.auto.gui.internal.macroobject.resolver,
19	org.eclipse.tptp.test.auto.gui.internal.runner,	22	org.eclipse.tptp.test.auto.gui.internal.runner,
		23	org.eclipse.tptp.test.auto.gui.internal.uiobject,
		24	org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver,
		25	org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate,
		26	org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.deresolvingsupport,
		27	org.eclipse.tptp.test.auto.gui.internal.util,
20	org.eclipse.tptp.test.auto.gui.internal.wizard	28	org.eclipse.tptp.test.auto.gui.internal.wizard
21	Require-Bundle: org.eclipse.ui;bundle-version="[3.2.0,4.0.0)",	29	Require-Bundle: org.eclipse.ui;bundle-version="[3.2.0,4.0.0)",
22	org.junit;bundle-version="[3.2.0,4.0.0)",	30	org.junit;bundle-version="[3.2.0,4.0.0)",




/*******************************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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
 * $Id: AutoGUITestControllerDialog.java,v 1.7 2008/04/18 14:51:21 dmorris Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.dialogs;

import java.util.Vector;

import org.eclipse.hyades.ui.internal.util.GridDataUtil;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.events.KeyListener;
import org.eclipse.swt.events.MouseEvent;
import org.eclipse.swt.events.MouseListener;
import org.eclipse.swt.events.MouseMoveListener;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Dialog;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.List;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIImages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;

/**
 * This dialog is displayed while the user is recording their macro. It is used
 * to control the test case that is being recorded.
 * 
 * @author      Ali Mehregani
 * @author      Paul E. Slauenwhite
 * @author      Alexander Nyssen
 * @version     March 5, 2008
 * @since       July 10, 2006
 */
public class AutoGUITestControllerDialog extends Dialog implements
		SelectionListener, MouseListener, MouseMoveListener, KeyListener,
		DisposeListener {

	private Shell sShell; // @jve:decl-index=0:visual-constraint="10,10"
	private Composite toolbarComposite;
	private Group verificationGrp;
	private Group controlGrp;
	private ToolBar toolBar;

	/* verification group */
	private Label verficationHookNameLabel;
	private Text verificationHookNameText;
	private ToolBar verificationScopExtensionToolBar;
	private ToolItem verificationScopeExtensionToolItem;
	private Button verificationHookInsertionButton;

	private ToolItem terminate;
	private ToolItem restart;
	private ToolItem positionBasedRecording;
	private ToolItem recordWaitTime;

	private Composite statusComposite;
	private Label statuslbl;

	/* Listener container */
	private Vector listenerBucket;

	/*
	 * Global coordinates of the shell - everything else is defined relative to
	 * this
	 */
	private Point shellBounds;

	/* Indicates that the mouse button is pushed on the shell */
	private boolean isMouseDown;

	/* The dialog is moved relative to this position */
	private Point originalPosition;

	/* Indicates whether the control center shell is disposed or not */
	private boolean isShellDisposed;

	/*
	 * The real parent that the dialog is suppose to have. This may not
	 * necessarily be the actual parent of the shell if it is forced to go to
	 * the background
	 */
	private Shell realParent;

	/*
	 * The actual parent of the dialog. This should always return the same
	 * result as getParent()
	 */
	private Shell actualParent;

	/*
	 * The first control center dialog will have this set and the successive
	 * ones will not
	 */
	private boolean isRoot;

	/* The control root (set only if isRoot is false) */
	private AutoGUITestControllerDialog rootControl;

	/* The control delegator (maybe set only if isRoot is true) */
	private AutoGUITestControllerDialog delegator;

	/*
	 * The display listener that will be listening in for new active shells (set
	 * only if isRoot is true)
	 */
	private DisplayListener displayListener;

	/* The last status of the control center dialog */
	private String lastStatus;

	/* The last location of the control dialog box */
	private Point lastLocation;

	/*
	 * Indicates whether position based should be on (should be set before shell
	 * is created)
	 */
	private boolean positionBasedOn;

	/* Indicates whether wait times should be recorded */
	private boolean waitTimeOn;

	/*
	 * Indicates wether the generated verification hook method should contain a
	 * second parameter for the UI object that was selected inside the context
	 */
	private boolean verificationScopeExtended;

	/*
	 * Stores the root's parent. At any time this dialog will either have its
	 * parent set to the root's parent or the active shell
	 */
	private static Shell rootParent;

	/* Indicates whether this dialog has purposely been sent to back */
	private boolean forceToBack;

	/* Indicates whether the dialog is activated or not */
	private static boolean activated;

	/* Event types */
	public final static byte TERMINATE = 0x01;
	public final static byte RESTART = 0x02;
	public final static byte POSITION_BASED = 0x03;
	public final static byte WAIT_TIME = 0x04;
	public final static byte VERIFICATION_HOOK_INSERT = 0x05;

	private final static int DO_NOT_DISPOSE = 1020;

	/*
	 * At all times, there should only be one active dialog displayed to the
	 * user
	 */
	private static AutoGUITestControllerDialog activeControlDialog;

	/**
	 * This constructor is used to create dialogs that are opened when the
	 * active shell changes.
	 * 
	 * @param parentShell
	 *            The parent shell
	 * @param rootControl
	 *            The control center that all the tasks will be delegated to.
	 */
	public AutoGUITestControllerDialog(Shell parentShell,
			AutoGUITestControllerDialog rootControl) {
		super(parentShell);
		isShellDisposed = false;
		realParent = parentShell;
		actualParent = parentShell;
		isRoot = false;
		this.rootControl = rootControl;
		this.positionBasedOn = false;

	}

	public AutoGUITestControllerDialog(Shell parent) {
		super(parent);
		isShellDisposed = false;
		realParent = parent;
		actualParent = parent;
		isRoot = true;
		activated = true;
	}

	public void openDialog() {
		openDialog(null);
	}

	/**
	 * Equivalent to openDialog (true)
	 */
	public void openDialog(final Shell activeShell) {
		shellBounds = new Point(317, 105);
		originalPosition = new Point(0, 0);
		sShell = new Shell(getParent(), SWT.MODELESS);
		sShell.setText(AutoGUIMessages.AUTO_GUI_CONTROL_DIALOG_TITLE);
		sShell.setLayout(new GridLayout());
		sShell.setSize(shellBounds);
		if (lastLocation != null)
			sShell.setLocation(lastLocation);
		sShell.addMouseListener(this);
		sShell.addMouseMoveListener(this);
		sShell.addDisposeListener(this);

		/* We would like the macro recorder to ignore this shell */
		sShell.setData(MacroManager.IGNORE, Boolean.TRUE);

		sShell.setFocus();
		createToolbarComposite();
		createStatusComposite();

		ActivationListener activationListener = null;
		/* We need to always stay on top of every shell */
		if (isRoot) {
			rootParent = getParent();
			displayListener = new DisplayListener();
			Display.getCurrent().addFilter(SWT.Activate, displayListener);
		}

		else {
			/*
			 * Defect #113543: Under the RedHat linux environment, if a modeless
			 * dialog is opened with an application modal dialog as its parent,
			 * the modality of the opened dialog will be restricted to
			 * application modal (blocking the parent dialog). We'll need to
			 * dispose and open the control center dialog based on activation
			 * and deactivation events. This is very expensive and it is only
			 * performed on non-windows environments.
			 */
			final String WINDOWS_OS = "windows";
			String platformOS = System.getProperty("os.name");

			if (platformOS == null
					|| platformOS.toLowerCase().indexOf(WINDOWS_OS) == -1) {
				activationListener = new ActivationListener(false);
			}
		}

		/* Open the dialog */
		activeControlDialog = this;
		sShell.open();

		if (activationListener != null) {
			sShell.addListener(SWT.Activate, activationListener);
			sShell.addListener(SWT.Deactivate, activationListener);

			final ActivationListener finalActivationListener = activationListener;
			GuiPlugin.getDefault().getWorkbench().getDisplay().timerExec(100,
					new Runnable() {

						public void run() {
							if (activeShell != null
									&& !activeShell.isDisposed())
								activeShell.setActive();

							finalActivationListener.setEnable(true);

						}
					});
		}

	}

	/**
	 * This method initializes toolbarComposite
	 * 
	 */
	private void createToolbarComposite() {
		GridLayout gridLayout = new GridLayout();
		gridLayout.numColumns = 2;
		toolbarComposite = new Composite(sShell, SWT.NONE);
		createControlGrp();
		createVerificationGrp();
		toolbarComposite.setLayoutData(GridDataUtil.createHorizontalFill());
		toolbarComposite.addMouseListener(this);
		toolbarComposite.addMouseMoveListener(this);
		toolbarComposite.setLayout(gridLayout);
	}

	private void createStatusComposite() {
		GridData gd = new GridData();
		gd.horizontalAlignment = SWT.CENTER;

		GridLayout gridLayout = new GridLayout();
		statusComposite = new Composite(sShell, SWT.NONE);
		statusComposite.setLayout(gridLayout);
		statusComposite.setLayoutData(gd);
		statusComposite.addMouseListener(this);
		statusComposite.addMouseMoveListener(this);

		GridData gd2 = new GridData();
		gd2.horizontalAlignment = SWT.CENTER;
		gd2.grabExcessHorizontalSpace = true;
		gd2.widthHint = (int) (shellBounds.x * 0.8);
		statuslbl = new Label(statusComposite, SWT.NONE);
		statuslbl.setAlignment(SWT.CENTER);
		statuslbl.setLayoutData(gd2);
		statuslbl.addMouseListener(this);
		statuslbl.addMouseMoveListener(this);
	}

	/**
	 * This method initializes verificationGrp
	 * 
	 */
	private void createVerificationGrp() {
		GridLayout gridLayout1 = new GridLayout();
		gridLayout1.numColumns = 4;
		verificationGrp = new Group(toolbarComposite, SWT.NONE);
		verificationGrp.setText(AutoGUIMessages.AUTO_GUI_CONTROL_VER_HOOK);
		verificationGrp.setLayout(gridLayout1);
		verificationGrp.setLayoutData(GridDataUtil.createHorizontalFill());
		verificationGrp.addMouseListener(this);
		verificationGrp.addMouseMoveListener(this);

		verficationHookNameLabel = new Label(verificationGrp, SWT.NONE);
		verficationHookNameLabel
				.setText(AutoGUIMessages.AUTO_GUI_NEW_DIALOG_NAME);
		verficationHookNameLabel.addMouseListener(this);
		verficationHookNameLabel.addMouseMoveListener(this);

		verificationHookNameText = new Text(verificationGrp, SWT.BORDER);
		verificationHookNameText.setLayoutData(GridDataUtil
				.createHorizontalFill());
		verificationHookNameText.addKeyListener(this);

		verificationScopExtensionToolBar = new ToolBar(verificationGrp,
				SWT.NONE);
		verificationScopeExtensionToolItem = new ToolItem(
				verificationScopExtensionToolBar, SWT.CHECK);
		verificationScopeExtensionToolItem.setImage(AutoGUIImages.getInstance()
				.getImage("e", AutoGUIImages.VERIFICATION_HOOK));
		verificationScopeExtensionToolItem
				.setToolTipText(AutoGUIMessages.AUTO_GUI_CONTROL_VER_INCLUDE_UI_OBJECT);
		verificationScopeExtensionToolItem
				.setSelection(verificationScopeExtended);
		verificationScopeExtensionToolItem.addSelectionListener(this);
		verificationScopeExtensionToolItem.setEnabled(false);

		verificationHookInsertionButton = new Button(verificationGrp, SWT.NONE);
		verificationHookInsertionButton
				.setText(AutoGUIMessages.AUTO_GUI_CONTROL_VER_INSERT);
		verificationHookInsertionButton.addSelectionListener(this);
		verificationHookInsertionButton.setEnabled(false);
		sShell.setDefaultButton(verificationHookInsertionButton);
	}

	/**
	 * This method initializes controlGrp
	 * 
	 */
	private void createControlGrp() {
		controlGrp = new Group(toolbarComposite, SWT.NONE);
		controlGrp.setLayout(new GridLayout());
		controlGrp.addMouseListener(this);
		controlGrp.addMouseMoveListener(this);
		createToolBar();
		controlGrp.setText(AutoGUIMessages.AUTO_GUI_CONTROL_CONT);
	}

	/**
	 * This method initializes toolBar
	 * 
	 */
	private void createToolBar() {
		GridData gridData = new GridData();
		gridData.horizontalAlignment = SWT.CENTER;
		gridData.grabExcessHorizontalSpace = true;
		toolBar = new ToolBar(controlGrp, SWT.NONE);

		/* The terminate button */
		terminate = new ToolItem(toolBar, SWT.PUSH);
		terminate.setImage(AutoGUIImages.getInstance().getImage("e",
				AutoGUIImages.TERMINATE));
		terminate.setToolTipText(AutoGUIMessages.AUTO_GUI_CONTROL_TERMINATE);
		terminate.addSelectionListener(this);

		/* The restart button */
		restart = new ToolItem(toolBar, SWT.PUSH);
		restart
				.setImage(AutoGUIImages.getInstance()
						.getImage(AutoGUIImages.RESTART));
		restart.setToolTipText(AutoGUIMessages.AUTO_GUI_CONTROL_RESTART);
		restart.addSelectionListener(this);

		/* A separator */
		ToolItem sep = new ToolItem(toolBar, SWT.SEPARATOR);
		sep.setText("");

		/* The position-based recording button */
		positionBasedRecording = new ToolItem(toolBar, SWT.CHECK);
		positionBasedRecording.setImage(AutoGUIImages.getInstance().getImage("e",
				AutoGUIImages.POSITION_BASED));
		positionBasedRecording
				.setToolTipText(AutoGUIMessages.AUTO_GUI_CONTROL_POSITION_BASED);
		positionBasedRecording.setSelection(positionBasedOn);
		positionBasedRecording.addSelectionListener(this);

		/* The wait time toggle buttong */
		recordWaitTime = new ToolItem(toolBar, SWT.CHECK);
		recordWaitTime.setImage(AutoGUIImages.getInstance()
				.getImage(AutoGUIImages.WAIT_TIME));
		recordWaitTime
				.setToolTipText(AutoGUIMessages.AUTO_GUI_CONTROL_WAIT_TIME);
		recordWaitTime.setSelection(waitTimeOn);
		recordWaitTime.addSelectionListener(this);

		toolBar.setLayoutData(gridData);
	}

	/**
	 * Used to register listeners with the control dialog box See event types
	 * for the type of events that the listener will be invoked with.
	 */
	public void registerListener(AutoGUIControllerListener listener) {
		if (listenerBucket == null)
			listenerBucket = new Vector();
		if (listener != null && !listenerBucket.contains(listener))
			listenerBucket.add(listener);
	}

	public void terminate() {
		if (rootControl != null) {
			rootControl.terminate();
		} else if (isRoot) {
			Display.getCurrent().removeFilter(SWT.Activate, displayListener);
			activeControlDialog.dispose();
			notifyListeners(TERMINATE, null);
		}

	}

	public void widgetSelected(SelectionEvent e) {
		byte eventType = 0;

		/* Determine the type of event */
		if (e.widget == terminate) {
			eventType = TERMINATE;
			notifyListeners(eventType, null);

			if (e.detail != DO_NOT_DISPOSE)
				dispose();

			return;
		}
		/* This is the verification insertion event */
		else if (e.widget == verificationHookInsertionButton)
			eventType = VERIFICATION_HOOK_INSERT;
		else if (e.widget == verificationScopeExtensionToolItem) {
			verificationScopeExtended = ((ToolItem) e.widget).getSelection();
		} else if (e.widget == restart)
			eventType = RESTART;
		else if (e.widget == positionBasedRecording) {
			positionBasedOn = ((ToolItem) e.widget).getSelection();
			eventType = POSITION_BASED;
		} else if (e.widget == recordWaitTime) {
			waitTimeOn = ((ToolItem) e.widget).getSelection();
			eventType = WAIT_TIME;
		}

		if (eventType != 0)
			notifyListeners(eventType, verificationHookNameText.getText());
	}

	public void widgetDisposed(DisposeEvent e) {
		if (!isShellDisposed && isRoot) {
			isShellDisposed = true;

			/* The shell is been disposed. Simulate a termination */
			Event event = new Event();
			event.widget = terminate;
			event.detail = DO_NOT_DISPOSE;
			widgetSelected(new SelectionEvent(event));
		}

	}

	/**
	 * A helper method used to notify the registered listeners
	 * 
	 * @param eventType
	 *            The type of event that caused this invokation
	 */
	protected void notifyListeners(byte eventType, Object value) {

		/*
		 * If we're not the root control center, then we're expected to delegate
		 * the tasks
		 */
		if (!isRoot) {
			rootControl.notifyListeners(eventType, value);
		} else {
			/* Remove the listener if we were terminated */
			if (eventType == TERMINATE)
				Display.getCurrent()
						.removeFilter(SWT.Activate, displayListener);

			/*
			 * Update appropriate fields if delegator updated the position-based
			 * or wait-time-recording options
			 */
			if (delegator != null) {
				if (eventType == POSITION_BASED)
					positionBasedOn = delegator.isPositionBasedOn();
				else if (eventType == WAIT_TIME)
					waitTimeOn = delegator.isWaitTimeOn();
			}

			/* Start notifying the listeners */
			int size = listenerBucket.size();
			for (int i = 0; i < size; i++) {
				((AutoGUIControllerListener) listenerBucket.get(i))
						.handleEvent(eventType, value);
			}
		}
	}

	public void widgetDefaultSelected(SelectionEvent e) {
		/* Doesn't need to be implemented */
	}

	/**
	 * A chance to clean up after our self
	 */
	public void dispose() {
		isShellDisposed = true;
		if (sShell != null && !sShell.isDisposed()) {
			sShell.close();
			toolBar.dispose();
			verificationHookNameText.dispose();
			verificationScopeExtensionToolItem.dispose();
			verificationHookInsertionButton.dispose();
			verficationHookNameLabel.dispose();
			terminate.dispose();
			restart.dispose();
			positionBasedRecording.dispose();
			verificationGrp.dispose();
			controlGrp.dispose();
			toolbarComposite.dispose();
			sShell.dispose(); // @jve:decl-index=0:visual-constraint="10,10"
		}

		toolBar = null;
		verificationHookNameText = null;
		verificationScopeExtensionToolItem = null;
		verificationHookInsertionButton = null;
		verficationHookNameLabel = null;
		terminate = null;
		verificationGrp = null;
		controlGrp = null;
		toolbarComposite = null;
		sShell = null; // @jve:decl-index=0:visual-constraint="10,10"

		shellBounds = null;
		originalPosition = null;
	}

	public void mouseDoubleClick(MouseEvent e) {
		/* Doesn't need to be implemented */
	}

	public void mouseDown(MouseEvent e) {
		isMouseDown = true;
		originalPosition.x = e.x;
		originalPosition.y = e.y;
	}

	public void mouseUp(MouseEvent e) {
		isMouseDown = false;
	}

	/**
	 * Move the dialog box when the user clicks on the shell and moves the
	 * cursor
	 */
	public void mouseMove(MouseEvent e) {
		if (isMouseDown) {
			int xMove = e.x - originalPosition.x;
			int yMove = e.y - originalPosition.y;

			Point currentLocation = sShell.getLocation();
			sShell.setLocation(currentLocation.x + xMove, currentLocation.y
					+ yMove);
			lastLocation = sShell.getLocation();
		}
	}

	/**
	 * Updates the status of the control dialog center
	 * 
	 * @param status
	 *            The status to be printed
	 */
	public void setStatus(String status) {

		/* The delegator has to handle this (if one exists) */
		if (isRoot && delegator != null && !delegator.isShellDisposed) {
			delegator.setStatus(status);
			return;
		}
		// added for defect 173451 to ensure that in case where the widget is
		// disposed
		// we switch to the correct reference (for Linux platform)
		// Liz Dancy
		else if (statuslbl.isDisposed() && delegator.isShellDisposed) {

			this.updateDelegator(this.realParent, this.realParent);
			statuslbl = this.delegator.statuslbl;
		}
		if (status == null)
			return;

		lastStatus = status;
		String finalStatus = AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_BASE
				+ status;
		boolean toolong = false;
		if (finalStatus.length() > 30)
			toolong = true;

		statuslbl.setToolTipText(finalStatus);
		if (toolong)
			finalStatus = finalStatus.substring(0, 30) + "...";

		statuslbl.setText(finalStatus);
	}

	public String getLastStatus() {
		if (isRoot && delegator != null)
			return delegator.getLastStatus();
		return lastStatus;
	}

	/**
	 * A primitive listener class
	 */
	public interface AutoGUIControllerListener {
		/**
		 * Invoked when there is an event caused by the user interacting with
		 * the control center.
		 * 
		 * @param event
		 *            The event type
		 * @param value
		 *            The value associated with the event. It can be null if no
		 *            value is associated with the event type.
		 */
		public void handleEvent(byte event, Object value);
	}

	public void keyPressed(KeyEvent e) {
		keyReleased(null);
	}

	public void keyReleased(KeyEvent e) {
		if (verificationHookNameText.getText().trim().equals("")) {
			verificationHookInsertionButton.setEnabled(false);
			verificationScopeExtensionToolItem.setEnabled(false);
			return;
		}
		verificationHookInsertionButton.setEnabled(true);
		verificationScopeExtensionToolItem.setEnabled(true);
	}

	public Point getLastLocation() {
		if (isRoot && delegator != null)
			return delegator.getLastLocation();
		if (sShell != null && !sShell.isDisposed())
			return sShell.getLocation();

		return lastLocation;
	}

	public void setLocation(Point location) {
		lastLocation = location;
	}

	public void setPositionBasedOn(boolean isPositionBasedOn) {
		this.positionBasedOn = isPositionBasedOn;
	}

	public boolean isPositionBasedOn() {
		return positionBasedOn;
	}

	public boolean isVerficationScopeExtended() {
		return verificationScopeExtended;
	}

	public boolean isWaitTimeOn() {
		return waitTimeOn;
	}

	public void setWaitTimeOn(boolean waitTimeOn) {
		this.waitTimeOn = waitTimeOn;
	}

	public synchronized void updateDelegator(Shell guardian, Shell realParent) {
		updateDelegator(guardian, realParent, null);
	}

	public void updateDelegator(Shell guardian, Shell realParent,
			Shell activeShell) {
		if (guardian.isDisposed())
			return;

		Point location = getLastLocation();
		String lastStatus = getLastStatus();

		AutoGUITestControllerDialog rootControl = null;
		if (isRoot)
			rootControl = this;

		else
			rootControl = this.rootControl;

		AutoGUITestControllerDialog delegator = rootControl.getDelegator();
		/* Get rid of the last delegator */
		if (activeControlDialog != null) {
			activeControlDialog.dispose();

		}

		delegator = new AutoGUITestControllerDialog(guardian,
				AutoGUITestControllerDialog.this);
		delegator.setLocation(location);
		delegator.setPositionBasedOn(isPositionBasedOn());
		delegator.setWaitTimeOn(isWaitTimeOn());
		delegator.openDialog(activeShell);
		delegator.setStatus(lastStatus);
		delegator.actualParent = guardian;
		delegator.realParent = realParent;

		rootControl.setDelegator(delegator);
	}

	public AutoGUITestControllerDialog getDelegator() {
		return delegator;
	}

	public void setDelegator(AutoGUITestControllerDialog delegator) {
		this.delegator = delegator;
	}

	private class DisplayListener implements Listener {
		public void handleEvent(final Event event) {

			class ChangeDialogParentOp implements Runnable {
				private DisplayListener listener;

				public ChangeDialogParentOp(DisplayListener listener) {
					this.listener = listener;
				}

				public void run() {
					try {
						if (forceToBack)
							return;

						boolean isNewShellPresent = event.widget instanceof Shell
								&& /* The widget is a shell */
								!event.widget.isDisposed()
								&& /* It hasn't been disposed */
								event.widget.getData(MacroManager.IGNORE) == null
								&& /* It shouldn't be ignored */
								(realParent.isDisposed() || !event.widget
										.equals(realParent))
								&& /*
									 * It's not the current shell that we have
									 * as our parent
									 */
								!isComboBox(actualParent = (Shell) event.widget); /*
																					 * It's
																					 * not
																					 * a
																					 * combo
																					 * box
																					 */
						if (!isNewShellPresent)
							return;
						// need to check for activated
						// bugzilla_184767
						// Liz Dancy
						if (activated)
							updateDelegator(actualParent, actualParent,
									actualParent);

						if (actualParent != rootParent)
							activated = true;
						AutoGUITestControllerDialog.this.realParent = actualParent;
					}

					catch (Throwable t) {
						/*
						 * If at any point an error occurs, then de-register
						 * this listener
						 */
						Display.getCurrent().removeFilter(SWT.Activate,
								listener);
					}

				}

				private boolean isComboBox(Shell shell) {
					Control[] children = shell.getChildren();
					return children.length == 1 && children[0] instanceof List;
				}
			}
			;

			/*
			 * We need to run this as a timer operation because it may otherwise
			 * cause a widget disposed exeception. The exception is caused in
			 * cases where we get an activation event on shells that are
			 * activated only for short periods of time. Running this operation
			 * as a timer operation will guarantee that an activated shell is
			 * present and not disposed after 50 milliseconds. This ultimately
			 * avoids processing activated shells that have a very short life
			 * span.
			 */
			GuiPlugin.getDefault().getWorkbench().getDisplay().timerExec(50,
					new ChangeDialogParentOp(this));
		}
	}

	public class ActivationListener implements Listener {
		private boolean enable;

		public ActivationListener(boolean enable) {
			this.enable = enable;
		}

		public void handleEvent(Event event) {
			if (!enable)
				return;

			switch (event.type) {
			case SWT.Activate:
				controlCenterDialogActivated();
				break;
			case SWT.Deactivate:
				controlCenterDialogDeactivated();
				break;
			}

		}

		private void controlCenterDialogActivated() {
			/*
			 * If the parent of the control center dialog is a modal dialog but
			 * it was sent back, then we'll need to bring the control center
			 * dialog to the front
			 */
			if (isModalParent() && actualParent == rootParent && !activated) {
				activated = false;
				forceToBack = false;
				enable = false;
				updateDelegator(realParent, realParent);
				enable = true;

			}

		}

		private void controlCenterDialogDeactivated() {
			/*
			 * If the parent of the control center dialog is modal, then we need
			 * to send it back
			 */
			if (isModalParent() && actualParent == realParent && activated) {
				activated = false;
				forceToBack = true;
				enable = false;

				Shell realParent = null;
				if (delegator != null) {
					realParent = delegator.realParent;
				} else
					realParent = AutoGUITestControllerDialog.this.realParent;
				updateDelegator(rootParent, realParent, realParent);

				enable = true;
			}
		}

		private boolean isModalParent() {
			if (realParent == null || realParent.isDisposed())
				return false;

			int parentStyle = realParent.getStyle();
			return (parentStyle & SWT.SYSTEM_MODAL) != 0
					|| (parentStyle & SWT.PRIMARY_MODAL) != 0
					|| (parentStyle & SWT.APPLICATION_MODAL) != 0;
		}

		private void setEnable(boolean enable) {
			this.enable = enable;
		}

	}
}




/*******************************************************************************
 * Copyright (c) 2005, 2008 IBM Corporation 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
 * $Id: AutoGUIRunner.java,v 1.25 2008/07/14 19:18:57 paules Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.runner;

import java.io.ByteArrayInputStream;
import java.io.PrintStream;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Stack;
import java.util.Vector;

import junit.framework.AssertionFailedError;
import junit.framework.Test;
import junit.framework.TestResult;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.hyades.execution.core.IControlMessage;
import org.eclipse.hyades.internal.execution.local.common.CustomCommand;
import org.eclipse.hyades.internal.execution.remote.CustomCommandHandler;
import org.eclipse.hyades.internal.execution.remote.RemoteComponentSkeleton;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.hyades.models.common.facades.behavioral.impl.HyadesUtil;
import org.eclipse.hyades.test.common.event.ExecutionEvent;
import org.eclipse.hyades.test.common.event.InvocationEvent;
import org.eclipse.hyades.test.common.event.LoopEvent;
import org.eclipse.hyades.test.common.event.MessageEvent;
import org.eclipse.hyades.test.common.event.TypedEvent;
import org.eclipse.hyades.test.common.event.VerdictEvent;
import org.eclipse.hyades.test.common.junit.IHyadesTest;
import org.eclipse.hyades.test.common.runner.internal.util.AgentConsoleStream;
import org.eclipse.hyades.test.common.runner.model.Action;
import org.eclipse.hyades.test.common.runner.model.IActionOwner;
import org.eclipse.hyades.test.common.runner.model.Loop;
import org.eclipse.hyades.test.common.runner.model.NamedElement;
import org.eclipse.hyades.test.common.runner.model.TestInvocation;
import org.eclipse.hyades.test.common.runner.model.TestSuite;
import org.eclipse.hyades.test.common.runner.model.util.EventLogger;
import org.eclipse.hyades.test.common.runner.model.util.ModelUtil;
import org.eclipse.hyades.test.common.util.BaseString;
import org.eclipse.hyades.test.java.runner.HyadesJUnitRunner;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.commands.ModifyCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.WaitCommand;
import org.eclipse.tptp.test.auto.gui.internal.editor.AutoGUITestCasesForm.GUITestCaseProperties;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.runner.ExtendedScriptParser.ExtendedTestCase;
import org.eclipse.tptp.test.auto.gui.internal.runner.ExtendedScriptParser.ExtendedTestInvocation;
import org.eclipse.tptp.test.auto.gui.internal.runner.ExtendedScriptParser.ExtendedTestSuite;
import org.eclipse.tptp.test.auto.gui.internal.runner.ExtendedScriptParser.GeneralPropertyRetriever;
import org.eclipse.tptp.test.auto.gui.internal.runner.VariableSubstitution.Variable;
import org.eclipse.tptp.test.auto.gui.internal.util.XMLDefaultHandler;
import org.eclipse.ui.IStartup;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.WorkbenchException;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.Text;

/**
 * This is the runner for the automated GUI test suite.  It needs to be under this plug-in
 * as opposed to the tools.core plug-in because of the UI operations that it performs.
 * <p/>
 * 
 * 
 * @author  Ali Mehregani
 * @author  Paul E. Slauenwhite
 * @version July 14, 2008
 * @since   August 18, 2005
 */
public class AutoGUIRunner extends HyadesJUnitRunner implements IStartup
{
	/* The modes that the test cases can run in */
	private final static byte QUICK_RUN_MODE = 0x01;
	private final static byte EXECUTION_RUN_MODE = 0x02;
	
	/* The test script */
	private String testScript;
		
	/* Static copy of the script -- lock it before using it*/
	private static byte[] staticTestCase = new byte[0]; 
	
	/* Set when there is an error in the process of test execution */
	private boolean errorOccurred;
	
	
	/* Holds the mode that we're running in */
	private byte runningMode;
	
	/* The test case index that we're currently at when executing in quick mode */
	private int currentTestCaseInx;
	
	/* The last test invocation that was detected is stored here */
	private ExtendedTestInvocation lastAction; 
	
	/* Keeps track of the loops */
	private Stack loopStack;
	
	/* Stores the number of loops and test invocations detected so far seen */
	private int loopNumbersDetected, invocationNumbersDetected;
	
	/* Keeps a stack of the execution events.  Elements must be of type ExecutionEvent */
	private Stack executionEventStack;
	
	/* A reference to the ITestSuite EMF object - Available only in quick mode */
	private ITestSuite testSuiteEMF;
	
	/* Contains a stack of action iterators that need to be executed */
	private Stack actionIteratorStack;
		
	/* Indicates if the action iterator stack is been initialized */
	private boolean isActionIteratorStackInitialized;
	
	/* The extended test suite */
	private ExtendedTestSuite extendedTestSuite;
	
	
	/**
	 * Default constructor.
	 */
	public AutoGUIRunner()
	{
		super((RemoteComponentSkeleton)null);		
		init();
	}
	
	/**
	 * This constructor is used to create the appropriate agent.
	 * 
	 * @param args The last statement is assumed to be the resource id.
	 * @param commandListeners The command listeners
	 */
	public AutoGUIRunner(String[] args, Vector commandListeners)
	{
		super (args, commandListeners);
		init();
	}
	
	
	private void init()
	{
		/* Initialize the event logger here, eventhough nothing will be logged if this constructor is used.
		 * This is done to avoid an NPE when running in quick mode (all events will be ignored because there
		 * is no agent to send the events to) */
		ModelUtil.setEventLogger(new EventLogger ()
			{
			public void log(ExecutionEvent executionEvent)
			{
				writeEvent (executionEvent);			
			}});
		
		loopNumbersDetected= 0;
		executionEventStack = new Stack();
		loopStack = new Stack();
		actionIteratorStack = new Stack();
		isActionIteratorStackInitialized = false;
	}
	
	
	/**
	 * Invoked when the workbench starts
	 */
	public void earlyStartup()
	{
		String[] args = null;
		long startTime = 0;
		AutoGUIRunner runner = null;
		
		try
		{
			/* These first few steps need to be quick and painless - they will impact the workbench 
			 * startup time */
			final String isHeadlessModeOn = "tptp.automated.gui";
			if (System.getProperty(isHeadlessModeOn) == null)
				return;
			
			/* We're in the headless mode.  Get the resource id */
			final String executorProperty = "tptp.automated.gui.executor";
			final String executor = System.getProperty(executorProperty);
			
			if (executor == null)
				AutoGUIUtil.showMessage (
						AutoGUIMessages.AUTO_GUI_ERROR_PLAYBACK_PROP_T, 
						NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_PLAYBACK_PROP, executorProperty),
						MessageDialog.ERROR);
			
			/* Instantiate an instance of this class */
			args = new String[1];
			args[0] = executor;
			Vector commandListeners = new Vector();
			commandListeners.add(new CustomCommandHandler()
					{
				/* Start listening for the script */
				public void handleCommand(CustomCommand command)
				{
					if(command.getData().equals(IControlMessage.START))
					{
						/* Don't do anything */
					}
					else
					{
						synchronized(staticTestCase)
						{
							staticTestCase = command.getDataBinary();
						}
					}						
				}			
			}
			);
			
			runner = new AutoGUIRunner(args, commandListeners);
			
			/* Wait for the script.  The wait is for a maximum of 2 minutes */
			synchronized (this)
			{
				try
				{
					/* Check every second, and wait for a maximum of 2 minutes */				
					synchronized (staticTestCase)
					{
						int counter = 0;
						while (staticTestCase.length <= 0 && counter < 120)
						{
							counter++;
							wait (1000);
						}
						
						/* Notify the agent that something went wrong, if we still haven't go the script */
						if (staticTestCase.length <= 0)
						{
							/* Try and tell the client we are timing out */
							agent.sendMessageToAttachedClient("The test script was not set after two minutes.", 0);
	
							/* We have timed out.  exit */
							System.exit(-1);
						}
						else
						{
							runner.setTestScript(staticTestCase);
						}
					}
				}
				catch (InterruptedException e)
				{
					
				}
			}
		
			
		

			/* Get the agent */
			RemoteComponentSkeleton agent = runner.getAgent(null);		
			
			/* Do the initializations */
			runner.writeExecEvent("<EXECUTION>");
			TestSuite testSuiteObj = runner.parseTestScript();
			
			/* Redirect std out and err */
			System.setOut(new PrintStream(new AgentConsoleStream(agent, AgentConsoleStream.OUT, ModelUtil.getHierarchyId(testSuiteObj),_peekParentEventID())));
			System.setErr(new PrintStream(new AgentConsoleStream(agent, AgentConsoleStream.ERR, ModelUtil.getHierarchyId(testSuiteObj),_peekParentEventID())));
	
			/* Run the tests */			
			startTime = getCurrentTime();
			
			runner.runTest (testSuiteObj, EXECUTION_RUN_MODE);			
		}
		catch(Throwable e)
		{
			/* We could not find the class (or something else, report the error) */
			try
			{
				MessageEvent messageEvent = new MessageEvent();
				messageEvent.setText(BaseString.getStackTrace(e));
				messageEvent.setSeverity(MessageEvent.ERROR);
				messageEvent.setParentId("ROOT");
				ModelUtil.getEventLogger().log(messageEvent);
			}
			catch (Throwable t)
			{
				/* We weren't able to report the error */
			}
			
		}

		/* Exit */
		try
		{
			long endTime = getCurrentTime();
			runnerExit(true, (endTime - startTime));
			runner.writeExecEvent("</EXECUTION>");
		}
		catch (Throwable t)
		{
			/* Doesn't need to be handled */
		}
		
		/* Always make sure that the headless workbench quits (regardless of errors occurring while running the test runner */
		System.exit(0);
		
	}
	
	/**
	 * Runs the test cases of 'testSuite' using the current workbench as
	 * the context.
	 * 
	 * @param testSuite The testSuite to be tested.
	 */
	public void runTestInCurrentContext(ITestSuite testSuiteEMF, final TestSuite testSuite, final ITestRunnerDelegator delegator)
	{
		new Thread (new Runnable(){

			public void run() 
			{
				runTest(testSuite, QUICK_RUN_MODE);
				delegator.finishedTestRun();
			}
			
		}).start();
		
		this.testSuiteEMF = testSuiteEMF;		
	}
	
	
	/**
	 * Runs the actual test script in the mode that it is given.  
	 * 
	 * @param testSuite The test script 
	 * @param mode Can be QUICK_RUN_MODE (used when a quick run mode button of the test case form is
	 * pressed) or EXECUTION_RUN_MODE (used when a proper launch configuration is used)
	 */
	private void runTest(TestSuite testSuite, final byte mode)
	{
		runningMode = mode;
		currentTestCaseInx = 0;		
		
		if (!(testSuite instanceof ExtendedTestSuite))
			return;
		
		extendedTestSuite = (ExtendedTestSuite)testSuite;
		/* Before running the test cases, set the dependencies of the test suite (if any exist) */
		if (extendedTestSuite.getDependencies() != null && extendedTestSuite.getDependencies().size() > 0)
			MacroManager.getInstance().setDependecies(extendedTestSuite.getDependencies());
			
		/* Register this runner */
		MacroManager.getInstance().setRunner(this);
		
		if (mode == EXECUTION_RUN_MODE)
			/* Log the start of the test suite */
			sendTypeEvent(TypedEvent.START, null);
		
	
		/* Do all initializations required before the test run begins */
		Exception initializeState = null;
		try
		{
			initializeTestRun(mode);
		} 
		catch (CoreException e)
		{
			initializeState = e;
			
		}
		
		/* Holds the next executable action that is to be executed */
		Object nextExecution = null;
		/* Holds the test suite if we are executing a test suite reference, added for bugzilla_136186*/
		TestSuite nestedSuite = new TestSuite();
		/* To keep track of when we are in a reference to a test suite*/
		boolean inTestSuite =false;
		/* To keep track of whether we are in a Loop inside of a test suite reference*/
		boolean loopStarted = false;
		/* The index of test cases in a references Loop or test suite*/
		int index=0;
	
		/* Walk through every element that needs to be executed in our test suite */
		if (initializeState == null)
		{
			
			while (((inTestSuite)|| (nextExecution =nextExecution(mode, testSuite))!=null))
			{
				// Added for bugzilla_136186 to add the ability to step through test 
				//cases in a referenced test suite
				// Liz D.
				if (inTestSuite)
				{
					nextExecution = nestedSuite.getActions().get(index); 
					
					if (nextExecution instanceof org.eclipse.hyades.test.common.runner.model.Loop)
					{
						if (loopStarted)
						{
							nextExecution = ((Loop)nextExecution).getActions().get(index);
							loopStarted=false;
						}
						else
							loopStarted=true;
					}
					
				}
				
				try
				{
					errorOccurred = false;
					Object testCaseObject = null;
					lastAction = null;
					
					/* Flush out the system output and error stream if in case the previous test case stored anything in the buffer */
					System.out.flush();
					System.err.flush();
					
					/* Set the test case object of the item that is being executed next */
					if (mode == QUICK_RUN_MODE)
						testCaseObject = nextExecution;				
					else if (mode == EXECUTION_RUN_MODE)
					{
						/* End the last loop if the owner is either the root or from the parent of the last loop */
						Loop lastLoop = getLastLoop();					
						if (lastLoop != null)
						{
							IActionOwner parentOfLastLoop = lastLoop.getOwner();
							String parentOfLastLoopId = getActionId(parentOfLastLoop);
							String nextExecutionId = getActionId(nextExecution);
							
							/* Iterating through the same loop */
							if (lastLoop.getId().equals(nextExecutionId))
							{
								continue;
							}
							
							/* End of the last loop */
							else if (nextExecutionId.equals(parentOfLastLoopId))
							{
								sendLoopStop();
								continue;
							}
							
							else if (((Action)nextExecution).getOwner() instanceof TestSuite && !inTestSuite)
							{
								sendAllLoopStop ();
								
							}
						}
						
						/* If the action happens to be a loop, then simply send the loop start event */
						if (nextExecution instanceof Loop)
						{				
							sendLoopStart ((Loop)nextExecution);						
							continue;
						
						}
						
						/* If the action is a test invocation, then send the test invocation */
						 if (nextExecution instanceof ExtendedTestInvocation )
						{
							lastAction = (ExtendedTestInvocation)nextExecution;
							testCaseObject = lastAction.getTest();
							sendTestInvocation(lastAction, InvocationEvent.STATUS_SUCCESSFUL, lastAction.getName());
							
							if (testCaseObject instanceof TestSuite)
							{
								nestedSuite = ((TestSuite)testCaseObject);
								inTestSuite=true;
								index =0;
								continue;
							}
						}
						
						/* Otherwise continue with the main loop */
						else
						{
							continue;
						}
					}
					if (!((testCaseObject instanceof ExtendedTestCase)))
						continue;
					
					/* Switch to the perspective representing our starting point */
					final ExtendedTestCase testCase = (ExtendedTestCase)testCaseObject;	
					
					final String startingPoint = testCase.getProperty(String.valueOf(GUITestCaseProperties.STARTING_PT));
					
					
					/* This is a required field.  In case it is not set, then mark the test case with
					 * a verdict of error */
					if (startingPoint == null || startingPoint.length() <= 0)
					{
						/* Show an error if we're running in quick run mode */
						if (mode == QUICK_RUN_MODE)
						{
							AutoGUIUtil.showMessage(
									AutoGUIMessages.AUTO_GUI_ERROR_MACRO_MISS_SP_T, 
									AutoGUIMessages.AUTO_GUI_ERROR_MACRO_MISS_SP, 
									MessageDialog.ERROR);						
						}
						else if (mode == EXECUTION_RUN_MODE)
						{
							sendVerdict(lastAction, VerdictEvent.VERDICT_ERROR, 
									AutoGUIMessages.AUTO_GUI_ERROR_MACRO_MISS_SP_T);	
						}
											
						continue;
					}
						
					final IWorkbench workbench = PlatformUI.getWorkbench();	
					final TestInvocation constantTestInvocation = lastAction;
					workbench.getDisplay().syncExec(new Runnable() {
				    public void run() 
				    {
				    	IWorkbenchWindow window = workbench.getActiveWorkbenchWindow();
				    	if (window != null) 
				    	{
				    		try
							{
								/* If we are running in execution mode then we may need to close the welcome page and maximize the workbench*/
								if (mode == EXECUTION_RUN_MODE)
								{
									MacroUtil.closeWelcomePage();
									MacroUtil.maximizeWorkbench();
								}
									
								
								workbench.showPerspective(startingPoint, window);
							}
				    	
							catch (WorkbenchException e)
							{			
								errorOccurred = true;
								/* If we are running in quick mode, then display the correct error message */
								if (mode == QUICK_RUN_MODE)
								{
									AutoGUIUtil.showMessage(
											AutoGUIMessages.AUTO_GUI_ERROR_PERS_SWITCH_TITLE, 
											NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_PERS_SWITCH, new String[] {startingPoint, e.getLocalizedMessage()}), 
											MessageDialog.ERROR);
								}
								else if (mode == EXECUTION_RUN_MODE)
								{
									sendVerdict(constantTestInvocation, VerdictEvent.VERDICT_ERROR,
										NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_PERS_SWITCH, new String[] {startingPoint, e.getLocalizedMessage()}));
								}							
							}
				    	}
				    }
				    });
					
					if (errorOccurred)
						continue;
					
					
					/* Time to run the macro */
					final String macro = testCase.getProperty(String.valueOf(GUITestCaseProperties.MACRO_FRAGMENT));				
					
					class MacroPlayWrapper implements Runnable
					{
						private Object objectToNotify;
						private boolean isDone;
						
						public MacroPlayWrapper (Object objectToNotify)
						{
							this.objectToNotify = objectToNotify;
							isDone = false;
						}
						
						
					    public void run() 
					    {
				    		try
							{
				    			/* Not interested if there is no macro */
								if (macro == null || macro.length() <= 0)
									return;
								
								XMLDefaultHandler handler = MacroManager.getInstance().createMacroDocument(new ByteArrayInputStream(macro.getBytes("UTF-8")));
								int timeout = GlobalConstants.DEFAULT_COMMAND_TIME_OUT_PERIOD;
								if (mode == EXECUTION_RUN_MODE)
								{
									linkUserInput(handler);
									String timeoutStr = lastAction.getProperty(GlobalConstants.COMMAND_TIMEOUT_THRESHOLD); 
									if (timeoutStr != null)
									{
										try
										{
											timeout = Integer.parseInt(timeoutStr);
										}
										catch (Exception e)
										{
											/* Doesn't need to be handled -- timeout is already set to default */
										}
									}
								}
								/* We may need to do variable substitution if we're running in quick mode */
								else if (mode == QUICK_RUN_MODE)
								{
									doVariableSubstitution(handler);
								}
															
				    			MacroManager mng = MacroManager.getInstance();
				    			mng.setCommandTimeoutThreshold(timeout);
				    			mng.play(GuiPlugin.getDefault().getWorkbench().getDisplay(), null, testCase.getName(), handler, Boolean.TRUE);				    			
				    			handler = null;
				    			
				    			if (objectToNotify != null)
				    			{
				    				synchronized (objectToNotify)
				    				{
				    					objectToNotify.notify();
				    				}
				    			}
				    			
				    			isDone = true;
							}
							catch (Throwable t)
							{						
								/* If we are running in quick mode, then display the correct error message */
								if (mode == QUICK_RUN_MODE)
								{	
									AutoGUIUtil.openErrorWithDetail(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_RUNNING_T, 
											NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_RUNNING, testCase.getName()), t);
									
								}
								else if (mode == EXECUTION_RUN_MODE)
								{														
									sendVerdict(constantTestInvocation, VerdictEvent.VERDICT_FAIL,
											NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_RUNNING, testCase.getName()) + ".  " + AutoGUIUtil.getExceptionStackTrace(t));									
								}
								
								
								/* Give a chance for unfinished threads to exit */
								int outstandingShellCommandCount = MacroManager.getInstance().getOutstandShellCommands();		
								final int INCREMENT = 3000;
								final int MAX_COUNT = 3;
								int count = 0;
								while (outstandingShellCommandCount > 0 && count < MAX_COUNT)
								{
									MacroUtil.closeSecondaryShells(GuiPlugin.getDefault().getWorkbench().getDisplay());
									Thread.yield();
									synchronized(this)
									{
										try
										{
											wait(INCREMENT);
										}
										catch (Exception e)
										{
											
										}
									}
									
									count++;								
									outstandingShellCommandCount = MacroManager.getInstance().getOutstandShellCommands();
								}
													
								errorOccurred = true;
								isDone = true;
								
							}// end whlie						
					    }
					    	
					    public boolean isDone()
					    {
					    	return isDone;
					    }
					    
					    /**
					     * Used to link the user input to datapools, custom inputs, etc...
					     */
						private void linkUserInput(XMLDefaultHandler handler)
						{											
							Map modifiableFields = new Hashtable();
							getModifiableFields(handler, modifiableFields, new ArrayList());
							int modifyCounter = 0, waitCounter = 0;
							
							/* For every linkable command */
							for (Iterator linkableCommands = modifiableFields.keySet().iterator(); linkableCommands.hasNext();)
							{
								String currentCommandType = (String)linkableCommands.next();
								List commandList = (List)modifiableFields.get(currentCommandType);
								if (commandList == null)
									continue;
								
								for (int i = 0, commandCount = commandList.size(); i < commandCount; i++)
								{
									Element currentCommand = (Element)commandList.get(i);
									if (currentCommand == null)
										continue;
									
									String propertySuffix = "";
									if (ModifyCommand.TYPE.equals(currentCommandType))
									{
										modifyCounter++;
										propertySuffix += modifyCounter;
									}
									else if (WaitCommand.TYPE.equals(currentCommandType))
									{
										waitCounter++;
										propertySuffix = currentCommandType + waitCounter;
									}																	
															
									/* First attempt datapool link */
									String property = lastAction.getProperty(GlobalConstants.DATAPOOL_LINK_PROPERTY_BASE + propertySuffix);
									
									/* No datapool link present, give user input a try */
									if (property == null)
										property = lastAction.getProperty(GlobalConstants.CUSTOM_INPUT_LINK_PROPERTY_BASE + propertySuffix);
																									
									if (property != null)
									{
										String subsProperty = VariableSubstitution.getInstance().doSubstitutions(property);
										linkUserInput ((Element)currentCommand, subsProperty);
									}
									/* Otherwise we may need to do variable substitution */
									else
									{
										doVarSubstitutionForModifiedField (((Element)currentCommand).getChildNodes());
									}
								}
							}
						}
						
						private void doVariableSubstitution (XMLDefaultHandler handler)
						{						
							List modifiableFields = new ArrayList(5);
							getModifiableFields(handler, new Hashtable(), modifiableFields);
							
							/* Replace values accordingly */
							for (int i = 0, modifiableSize = modifiableFields.size(); i < modifiableSize; i++)
							{
								doVarSubstitutionForModifiedField (((Element)modifiableFields.get(i)).getChildNodes());
							}
							
						}
						
						
						private void doVarSubstitutionForModifiedField (NodeList modifyChildren)
						{							
							for (int j = 0, modifyChildCount = modifyChildren.getLength(); j < modifyChildCount; j++)
							{
								if (modifyChildren.item(j).getNodeType() == Node.TEXT_NODE)
								{
									Text textModifyElement = (Text)modifyChildren.item(j);
									String modifyCommandText = textModifyElement.getData();
									String modifyCommandTextSubs = VariableSubstitution.getInstance().doSubstitutions(modifyCommandText);
									
									if (!(modifyCommandText.equals(modifyCommandTextSubs)))
										textModifyElement.setData(modifyCommandTextSubs);
									break;
								}
							}
						}
						
						private void getModifiableFields (XMLDefaultHandler handler, Map modifiableFields, List orderedList)
						{
							Node root = handler.getDocumentElement();
							if (root == null)
								return;
							
							AutoGUIUtil.walkDomTree (root.getChildNodes(), modifiableFields, orderedList);
						}
						
						
						private void linkUserInput (Element element, String newModifiedField)
						{
							String elementType = element.getAttribute(MacroConstants.TYPE_ATTRIBUTE);
							
							/* Is the element a modify command */
							if (ModifyCommand.TYPE.equals(elementType))
							{
								NodeList modifyChildren = element.getChildNodes();
								boolean childChanged = false;
								for (int j = 0, modifyChildCount = modifyChildren.getLength(); j < modifyChildCount; j++)
								{
									if (childChanged && modifyChildren.item(j) instanceof Text)
										element.removeChild(modifyChildren.item(j));
									
									if (modifyChildren.item(j) instanceof Text)
									{				
										((Text)modifyChildren.item(j)).setData(newModifiedField);
										childChanged = true;
									}
								}
								
							}
							/* Is the element a wait command */
							else if (WaitCommand.TYPE.equals(elementType))
							{
								Node timeToWaitAttribute = element.getAttributeNode(MacroConstants.TIME_TO_WAIT_ATTRIBUTE);
								timeToWaitAttribute.setNodeValue(newModifiedField);
							}
						}
					}
					
					MacroPlayWrapper macroPlayWrapper = new MacroPlayWrapper (this.getClass());
					Thread macroPlayThread = new Thread(macroPlayWrapper);
					macroPlayThread.start();
					while (!macroPlayWrapper.isDone())
					{
						synchronized (this.getClass())
						{
							this.getClass().wait(500);
						}					
					}
					
				}
				
				/* An error occurred while attempting to run this test case */
				catch (Throwable t)
				{
					errorOccurred = true;
					String messageWithOrigin = AutoGUIUtil.getOriginOfException(t);
					
					/* If we are running in quick mode, then display the correct error message */
					if (mode == QUICK_RUN_MODE)
					{					
						String stackTrace = AutoGUIUtil.getExceptionStackTrace(t); 					
						String cause = messageWithOrigin + "\n" + stackTrace;
						
						AutoGUIUtil.openErrorWithDetail(
								Display.getDefault().getActiveShell(), 
								AutoGUIMessages.AUTO_GUI_ERROR_MACRO_UNCAP_T, 
								AutoGUIMessages.AUTO_GUI_ERROR_MACRO_UNCAP, 
								cause);
					}
					else if (mode == EXECUTION_RUN_MODE)
						sendVerdict (lastAction, VerdictEvent.VERDICT_ERROR, messageWithOrigin);
									
				}
				
				
				/* If we got to this point without any errors, then pass the test case */
				if (!errorOccurred && lastAction != null)
					sendVerdict(lastAction, VerdictEvent.VERDICT_PASS, null);
				
				/* Send out a stop event on the test case invocation */
				if (mode == EXECUTION_RUN_MODE)
					sendTypeEvent(TypedEvent.STOP, null);
				index ++;
				if (index >= (nestedSuite.getActions().size()) && inTestSuite)
				{
					sendSuiteStop();
					inTestSuite=false;
				}
					
			}// end while
		}// end if	
				
		if (mode == EXECUTION_RUN_MODE)
		{
			System.out.flush();
			System.err.flush();
			
			/* Close loops if they have already not been done so */
			while (loopStack.size() > 0)
			{
				sendTypeEvent(TypedEvent.STOP, null);
				loopStack.pop();
			}
				
			/* Send the verdict of the test suite */
			if (initializeState != null)
			{
				initializeState.printStackTrace();
			}
			
			VerdictEvent testSuiteVerdict = ModelUtil.DEFAULT_ARBITER.analyse();
			testSuiteVerdict.setParentId("ROOT");
			ModelUtil.getEventLogger().log(testSuiteVerdict);
			
			sendTypeEvent(TypedEvent.STOP, null);
		}
		else if (mode == QUICK_RUN_MODE && initializeState != null)
		{
			AutoGUIUtil.openErrorWithDetail(AutoGUIMessages.AUTO_GUI_COMMON_ERROR, AutoGUIMessages.AUTO_GUI_ERROR_MACRO_INITIALIZE, initializeState);
		}
	}

	
	private String getActionId(Object action) 
	{
		if (action instanceof NamedElement)
			return ((NamedElement)action).getId();
		
		return null;
	}

	private Loop getLastLoop() 
	{		
		if (loopStack.size() <= 0)
			return null;
		
		return (Loop)loopStack.peek();
	}

	
	/**
	 * Used to do the required initialization prior to the beginning
	 * of a test run.
	 * @throws CoreException 
	 */
	private void initializeTestRun(byte mode) throws CoreException 
	{
		/* A good time to initialize the variables declared in VariableSubstitution */
		initializeVariable(extendedTestSuite, mode);
		
		/* Tag the existing shells so that they don't accidently get closed when the macro playback
		 * closes nested shells in the case of an error */
		final Display currentDisplay = GuiPlugin.getDefault().getWorkbench().getDisplay(); 
		currentDisplay.syncExec(new Runnable(){

			public void run() 
			{
				Shell[] openedShells = currentDisplay.getShells();
				for (int i = 0; i < openedShells.length; i++)
				{
					openedShells[i].setData(GlobalConstants.OPENED_SHELL_INDICATOR, Boolean.TRUE);
				}
				
			}});
		
		/* Retrieve the object mine of the test suite */
		String objectMineXML = null;
		if (mode == QUICK_RUN_MODE && testSuiteEMF != null)
		{
			objectMineXML = HyadesUtil.getTestSuiteVariable(testSuiteEMF, GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE);
		}
		else if (mode == EXECUTION_RUN_MODE)
		{
			GeneralPropertyRetriever properties = extendedTestSuite.getProperties();
			objectMineXML = properties == null ? null : (String)properties.getProperty(GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE);
		}	
		
		if (objectMineXML != null)
		{
			MacroManager.getInstance().prepareForPlayBack(objectMineXML);
		}
		
	}
	/**
	 * Initialize the variables decalred in VariableSubstitution
	 */
	private void initializeVariable(ExtendedTestSuite testSuite, byte mode) 
	{
		Hashtable variableContainer = VariableSubstitution.getInstance().getVariableContainer();
		Variable contextWorkbenchVar = (Variable)variableContainer.get(VariableSubstitution.VAR_CONTEXT_WORKSPACE);
		contextWorkbenchVar.initialize(AutoGUIUtil.getWorkspaceLocation());
		
		Variable projectLocationVar = (Variable)variableContainer.get(VariableSubstitution.VAR_PROJECT_LOCATION);
		
		/* If we're running in standard mode, then the value of this variable is expected to be defined as
		 * a property of our test suite */
		String projectLocation = null;
		if (mode == EXECUTION_RUN_MODE)
		{
			GeneralPropertyRetriever properties = testSuite.getProperties();
			projectLocation = (String)properties.getProperty(GlobalConstants.TEST_SUITE_PROPERTY_BASE + "0");
		}
		/* In quick mode, we have to retrieve the value of the variable */
		else if (mode == QUICK_RUN_MODE && testSuiteEMF != null)
		{
			projectLocation =  AutoGUIUtil.getTestSuiteProjectLocation(testSuiteEMF);	
		}
		
		if (projectLocation != null)
			projectLocationVar.initialize(projectLocation);		
	}
	

	/**
	 * Returns the id of the last execution event detected
	 */
	private String lastExecutionEventId()
	{
		if (executionEventStack.size() <= 0)
			return "ROOT";
		return ((ExecutionEvent)executionEventStack.peek()).getId();
		
	}
	
	
	/**
	 * Returns the last container id according to what is stored in the
	 * execution event stack.  A container is either a loop or the ROOT. It could also be a nested test suite invocation
	 * 
	 * @return The last container id.
	 */
	private String lastContainerId()
	{
		/* Walk through the stack and find the container */
		Object[] stackItems = executionEventStack.toArray();
		for (int i = stackItems.length - 1; i >= 0 ; i--)
		{
			if (stackItems[i] instanceof LoopEvent)
				return ((LoopEvent)stackItems[i]).getId();
			else if (stackItems[i] instanceof InvocationEvent){
				return ((InvocationEvent)stackItems[i]).getId();
			}
		}
		return "ROOT";
	}
	
	
	/**
	 * Sends typed events representing start/stop events for the last event on
	 * the execution event stack.
	 */
	private void sendTypeEvent(int type, String text)
	{			
		TypedEvent event = new TypedEvent();
		String parentId = lastExecutionEventId();
                                                                                                          		if (executionEventStack.size() > 0)
			event.setOwnerId(((ExecutionEvent)executionEventStack.peek()).getOwnerId());
		event.setParentId(parentId);
		event.setType(type);
		
		ModelUtil.getEventLogger().log(event);
		
		if (type == TypedEvent.STOP && executionEventStack.size() > 0)
			executionEventStack.pop();
	}
	
	/**
	 * Added for bugzilla_136186 in order to send an additional Stop event for a test suite
	 */
	private void sendSuiteStop()
	{
		sendTypeEvent(TypedEvent.STOP, null);

	}
	/**
	 * Sends a loop event
	 */
	private void sendLoopStart (Loop loop)
	{	
		loopNumbersDetected++;		
		
		LoopEvent loopEvent = new LoopEvent();
		loopEvent.setIterations(loop.getIterations());
		associateEventIds(loop, loopEvent);
		
		ModelUtil.getEventLogger().log(loopEvent);
		sendTypeEvent (TypedEvent.START, null);
		loopStack.push(loop);
	}
	
	private void sendLoopStop ()
	{
		sendTypeEvent(TypedEvent.STOP, null);
		loopStack.pop();
	}
		
	
	private void sendAllLoopStop ()
	{
		while (loopStack.size() > 0)
		{
			sendLoopStop();
		}
	}

	/**
	 * Sends a test invocation event
	 * 
	 * @param testInvocation
	 * @param status
	 * @param text
	 */
	private void sendTestInvocation (TestInvocation testInvocation, int status, String text)
	{
		invocationNumbersDetected++;		
		
		InvocationEvent event = new InvocationEvent();
		associateEventIds(testInvocation, event);

		
		
		if(testInvocation.getTest() == null)
		{
			event.setStatus(InvocationEvent.STATUS_UNSUCCESSFUL);
			event.setReason(InvocationEvent.REASON_NO_BEHAVIOR);
			
		}
		else
		{
			event.setInvokedId(ModelUtil.appendHierarchyId(testInvocation.getTest(), event.getOwnerId()));
			event.setStatus(status);
			
			
		}	
		
		ModelUtil.getEventLogger().log(event);
		sendTypeEvent (TypedEvent.START, null);
	}
	

	/**
	 * Associates a verdict with a test test invocation.
	 * 
	 * @param testInvocation The test invocation
	 * @param verdict Can either be VerdictEvent.VERDICT_PASS, VerdictEvent.VERDICT_FAIL, 
	 * VerdictEvent.VERDICT_ERROR
	 * @param reason The reason for the verdict.  Can be null.
	 */
	private void sendVerdict (TestInvocation testInvocation, int verdict, String reason)
	{
		VerdictEvent verdictEvent = ModelUtil.createTestVerdictEvent(testInvocation);
				
		/* We're expected to have a test invocation on our stack */
		if (executionEventStack.size() <= 0 && !(executionEventStack.peek() instanceof InvocationEvent) && lastAction == null)
			return;			/* Should never happen */
		
		/* Determine the ids: 
		 * 	- The id is the same as the invocation id appended with '_verdict'
		 *  - The owner id is the id of the test from the test invocation
		 *  - The parent id is the id of the test invocation
		 */
		InvocationEvent invocationEvent = (InvocationEvent)executionEventStack.peek();
		verdictEvent.setId(invocationEvent.getId() + "_verdict");
		//verdictEvent.setOwnerId(ModelUtil.getHierarchyId(lastAction.getTest()));
		verdictEvent.setParentId(invocationEvent.getId());
		verdictEvent.setVerdict(verdict);				
		verdictEvent.setOwnerId(invocationEvent.getId());
		
		if(reason != null && reason.trim().length() > 0)
		{
			verdictEvent.setText(reason);
			verdictEvent.setReason(VerdictEvent.REASON_SEE_DESCRIPTION);
		}
		ModelUtil.getEventLogger().log(verdictEvent);
		testInvocation.setVerdictEvent(verdictEvent);
	}
	
	
	/**
	 * A helper method used to associate id, parentId, ownerId to the event.
	 * 
	 * @param event
	 * @param type 0 indicates loop, 1 indicates test invocation  
	 */
	private void associateEventIds(NamedElement namedElement, ExecutionEvent event)
	{
		String ownerId = namedElement.getId();
		String eventId = (namedElement instanceof Loop ? ownerId + "(" + loopNumbersDetected + ")" : ownerId + "(" + invocationNumbersDetected + ")");
		String parentId = lastContainerId();

		event.setOwnerId(ownerId);
		event.setId(eventId);
		event.setParentId(parentId);
	
		
		executionEventStack.push(event);
	}
	
	/**
	 * Returns the next execution based on the mode that we're running in. The first 
	 * execution in quick mode is the test case in the testSuite argument passed in 
	 * and in the execution mode, it is the next test invocation
	 * 
	 * @return The next element to be executed
	 */
	private Object nextExecution (byte mode, TestSuite testSuite)
	{
		Object nextExecution = null;
		
		if (mode == QUICK_RUN_MODE)
		{
			int testCaseSize = testSuite.getTestCases().size();
			if (currentTestCaseInx >= 0 && currentTestCaseInx < testCaseSize)
			{
				nextExecution = testSuite.getTestCases().get(currentTestCaseInx);
				currentTestCaseInx++;
			}			
		}			
		else if (mode == EXECUTION_RUN_MODE)
		{
			if (!isActionIteratorStackInitialized)
			{
				actionIteratorStack.push(ModelUtil.DEFAULT_EXECUTION_MANAGER.getRoot().getActions().iterator());
				isActionIteratorStackInitialized = true;
			}
			if (actionIteratorStack.size() > 0)
				nextExecution = getNextExecutableAction();
		}
		
		return nextExecution;
	}
	
	private Object getNextExecutableAction() 
	{
		if (actionIteratorStack.size() <= 0)
			return null;
		
		Iterator actionIterator = (Iterator)actionIteratorStack.peek();
		if (actionIterator.hasNext())
		{
			Object nextExecutableAction = actionIterator.next();
			if (nextExecutableAction instanceof Loop)
			{
				actionIteratorStack.push(((Loop)nextExecutableAction).getActions().iterator());
			}
					
			return nextExecutableAction;
		}
		else
		{
			actionIteratorStack.pop();
			return getNextExecutableAction();
		}
	}

	/**
	 * Runs a verification hook
	 * 
	 * @param verfHook The verification hook
	 */
	public void runVerificationHook(IHyadesTest verificationHook)
	{
		/* Set the root, if it hasn't already been set */
		if (super.getRoot() == null)
			super.setRoot (verificationHook);

		TestResult result = super.createTestResult();
		result.addListener(this);

		verificationHook.run(result);
	}
	
	
	/**
	 * Parses the test script and does the appropriate initializations
	 * 
	 * @throws Exception 
	 * @throws UnsupportedEncodingException 
	 */
	protected TestSuite parseTestScript() throws UnsupportedEncodingException, Exception
	{
		TestInvocation.addListener(ModelUtil.DEFAULT_EXECUTION_MANAGER);
		
		ExtendedScriptParser scriptParser = new ExtendedScriptParser();
		TestSuite testSuite = scriptParser.parse(testScript.getBytes("UTF-8"));
		
		if(testSuite == null)
		{
			System.err.println("\n" + testScript);
			throw new IllegalArgumentException(AutoGUIMessages.AUTO_GUI_ERROR_PLAYBACK_SCRIPT);
		}
		
		ModelUtil.DEFAULT_EXECUTION_MANAGER.setRoot(testSuite);
		ModelUtil.DEFAULT_EXECUTION_MANAGER.registerTestInvocations(scriptParser.getTestInvocations());
		ModelUtil.setVerdicts(scriptParser.getVerdicts());
	
		scriptParser.dispose();
		
		return testSuite;
	}
	
	
	/**
	 * Returns the test script
	 * 
	 * @return The test script
	 */
	protected String getTestScript()
	{
		return testScript;
	}
	
	
	/**
	 * Set the test script
	 * 
	 * @param data The data for the test script
	 */
	protected void setTestScript(byte[] data)
	{
		try
		{
			testScript = new String(data, "UTF-8");
		}
		catch (UnsupportedEncodingException e)
		{
		}
	}
	
	/**
	 * Overwrite the methods that are invoked when the verification hook result is being
	 * reported. 
	 */
	protected VerdictEvent getDefaultVerdictEvent(Test test)
	{
		/* We don't need to do anything here, because by default a verdict on the
		 * overall test case will be send. */
		return null;
	}

	
	public void addError(Test test, Throwable throwable)
	{
		if (runningMode == EXECUTION_RUN_MODE && lastAction != null)
		{
			errorOccurred = true;
			sendVerdict(lastAction, VerdictEvent.VERDICT_ERROR, BaseString.getStackTrace(throwable));
		}
	}
	
	
	public void addFailure(Test test, AssertionFailedError throwable)
	{
		if (runningMode == EXECUTION_RUN_MODE && lastAction != null)
		{
			errorOccurred = true;
			sendVerdict(lastAction, VerdictEvent.VERDICT_FAIL, BaseString.getStackTrace(throwable));
		}
	}
	
	
	/**
	 * These methods are over-written to diable the Junit runner from sending anything to
	 * our agent.
	 */
	protected void runnerExit(boolean runnerStopped, long elapsedTime) {}
	public void startTest(Test test) {}
	public void endTest(Test test) {}
	
	/**
	 * A primitive interface used to notify the status of the test runs to a caller that invokes
	 * this test runner.
	 * 
	 * @author Ali Mehregani
	 */
	public interface ITestRunnerDelegator
	{
		/**
		 * Invoked to indicate the end of a test suite run 
		 */
		public void finishedTestRun();
	}

}




package org.eclipse.tptp.test.auto.gui.internal.core;


import org.eclipse.core.runtime.CoreException;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.PrimitiveUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.IUIObjectResolverDelegate;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.deresolvingsupport.IUIObjectDeprecatedDeresolvingFacade;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.deresolvingsupport.UIObjectDeprecatedDeresolvingSupport;

public class WidgetResolverToUIObjectResolverDelegateAdapter implements
		IUIObjectResolverDelegate, IUIObjectDeprecatedDeresolvingFacade {

	private IWidgetResolver widgetResolver = null;

	public WidgetResolverToUIObjectResolverDelegateAdapter(IWidgetResolver widgetResolver) {
		super();
		this.widgetResolver = widgetResolver;
	}

	public boolean foundWidget(Widget object, IUIObjectIdentifier objectId) {
		return widgetResolver.foundWidget(object, objectId.getWidgetId());
	}

	public IUIObject deresolve(Object context,
			IUIObjectIdentifier uiObjectIdentifier) throws CoreException {
		return UIObjectDeprecatedDeresolvingSupport.deresolve(context,
				uiObjectIdentifier);
	}

	public IUIObjectIdentifier resolve(Object context, IUIObject uiObject)
			throws CoreException {
		
		IWidgetId widgetId = null;
		if(uiObject.getObject() == null){
			widgetId = widgetResolver.getUniqueId(uiObject.getWidget() instanceof Control ? ((Control)uiObject.getWidget()).getParent() : null, uiObject.getWidget());
		}
		else{
			widgetId = widgetResolver.getUniqueId(uiObject.getWidget(), uiObject.getObject());
		}
		return widgetId == null ? null : new PrimitiveUIObjectIdentifier(widgetId.toString(), widgetId.getResolverId());
	}

}




/*******************************************************************************
 * Copyright (c) 2005, 2006 IBM Corporation 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
 * $Id: VerificationHookClassLoader.java,v 1.2 2006/07/14 23:17:02 amehregani Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.util;

import java.net.URL;
import java.net.URLClassLoader;
import java.util.Vector;

import org.eclipse.core.runtime.Platform;
import org.eclipse.osgi.util.NLS;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;

/**
 * A custom class loader that is used to resolve a class that the verificaiton hook is in along
 * with any other classes that are imported by the verification class.
 * 
 * @author Ali Mehregani
 */
public class VerificationHookClassLoader extends URLClassLoader
{
	/* The plugins that the verification plugin requires */
	private Vector reqPluginNames;
	
	public VerificationHookClassLoader (URL[] urls, ClassLoader parent, Vector requiredPluginNames)
	{
		super (urls, parent);		
		reqPluginNames = requiredPluginNames;
	}
	
   
	/**
	 * Invoked when a class can't be resolved by the upper level class loaders associated with
	 * this class.
	 */
	protected Class findClass(final String name) 
	 throws ClassNotFoundException 			 
    {  	
		
    	/* Try and walk through the required plugins of the plugin
    	 * containing the test suite */
    	try
    	{			
    		Class classFile = loadFromReqPlugins(name, 0);
    		if (classFile != null)
    			return classFile;
    	}
    	catch (Throwable t)
    	{
    		/* Doesn't need to be handled */
    	}
    	
		
		try
		{
			Class classFile = super.findClass(name);
			if (classFile != null)
				return classFile;
		}
		catch (Throwable t)
		{
			/* Doesn't need to be handled */
		}
		
	    		    	
    	
    	throw new ClassNotFoundException (NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_VER_CLASS_NOT_FS, name));
    }


	/**
	 * Attempt to load the class from the required plugins.
	 * 
	 * @param name
	 * @param inx
	 * @return
	 */
	private Class loadFromReqPlugins(String name, int inx)
	{
		try
		{
			if (reqPluginNames == null || inx >= reqPluginNames.size())
				return null;
			
			Class classFile = Platform.getBundle(((String)reqPluginNames.get(inx))).loadClass(name);				
			if (classFile != null)
				return classFile;
		}
		catch (Throwable t)
		{
			/* Handled by next statement */
		}
		
		return loadFromReqPlugins(name, inx + 1);
	}
}




/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macroobject.mine;

import java.util.ArrayList;
import java.util.Hashtable;
import java.util.LinkedList;
import java.util.Map;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.osgi.util.NLS;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.commands.ObjectBasedCommand;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObjectIdentifier;

public class MacroObjectDescriptor {

	/** The context id */
	private String contextId;

	/** The widget id of the UI object being resolved */
	private String widgetId;
	
	/** The (optional) object id of the UI object to be resolved */
	private String objectId;

	/** The reference id of this object */
	private String referenceId;

	/** The descriptive attribute (a human readable identification) of this UI object */
	private String descriptive;

	/** Keeps track of the hierarchical relationship */
	private LinkedList hierarchicalRelation;

	/** The parent of this UI object */
	private MacroObjectDescriptor parent;

	/** The properties of this UI Object */
	private Hashtable properties;

	/** The id of the resolver that has resolved this object */
	private String resolverId;

	/** The children of this object */
	private ArrayList children;

	/** The associated data of this object */
	private Object data;

	/**
	 * Children indexed based on their reference id KEY = Reference id VALUE = MacroObjectDescriptor that is a child of this object
	 */
	private Hashtable idIndexedChildren;

	public MacroObjectDescriptor(MacroObjectDescriptor parent) {
		this.parent = parent;
		properties = new Hashtable();
		children = new ArrayList();
		idIndexedChildren = new Hashtable();
	}

	/**
	 * Creates an instace of this class based on a command passed in.
	 * 
	 * @param objectMine
	 *            The object mine that this object will be registered with
	 * @param command
	 *            The command that this object will be based on
	 * @param parent
	 *            The parent of this object
	 * 
	 * @return An instance of this class based on widgetIdentifier
	 */
	public static MacroObjectDescriptor createInstance(ObjectBasedCommand command, MacroObjectDescriptor parent) {
		IMacroObjectIdentifier macroObjectIdentifier = command.getMacroObjectIdentifier();
		MacroObjectDescriptor uiObject = new MacroObjectDescriptor(parent);
		uiObject.setContextId(macroObjectIdentifier.getContextIdentifier() != null
			? macroObjectIdentifier.getContextIdentifier().toString()
			: MacroConstants.EMPTY_STRING);
		uiObject.setWidgetId(macroObjectIdentifier.getObjectIdentifier().getWidgetId());
		uiObject.setObjectId(macroObjectIdentifier.getObjectIdentifier().getObjectId());
		uiObject.setDescriptive(command.getDescriptiveField());
		uiObject.setResolver(macroObjectIdentifier.getObjectIdentifier().getResolverId());

		return uiObject;
	}

	public String getContextId() {
		return contextId;
	}

	public String getDescriptive() {
		return descriptive;
	}

	public LinkedList getHierarchicalRelation() {
		if (hierarchicalRelation != null)
			return hierarchicalRelation;

		hierarchicalRelation = new LinkedList();
		findHierarchicalRelation(this);

		return hierarchicalRelation;
	}

	private void findHierarchicalRelation(MacroObjectDescriptor currentObject) {
		if (currentObject == null)
			return;
		hierarchicalRelation.addFirst(currentObject);
		findHierarchicalRelation(currentObject.getParent());
	}

	public String getObjectId(){
		return objectId;
	}
	
	public void setObjectId(String objectId){
		this.objectId = objectId;
	}
	
	public String getWidgetId() {
		return widgetId;
	}

	public Map getProperties() {
		return properties;
	}

	public String getProperty(String name) {
		return (String) properties.get(name);
	}

	public String getReferenceId() {
		return referenceId;
	}

	public void setContextId(String contextId) {
		this.contextId = contextId;
	}

	public void setDescriptive(String descriptive) {
		this.descriptive = descriptive;
	}

	public void setWidgetId(String id) {
		this.widgetId = id;
	}

	public void addProperty(String name, String value) {
		properties.put(name,
			value);
	}

	public void setReferenceId(String referenceId) {
		this.referenceId = referenceId;
	}

	public MacroObjectDescriptor getParent() {
		return parent;
	}

	public void setParent(MacroObjectDescriptor parent) {
		this.parent = parent;
	}

	public String getResolverId() {
		return resolverId;
	}

	public void setResolver(String resolverId) {
		this.resolverId = resolverId;
	}

	public void addChild(MacroObjectDescriptor child) throws CoreException {
		if (!children.contains(child)) {
			try {
				/* If there is a collision, then try to resolve it */
				int referenceId = Integer.parseInt(child.getReferenceId());
				while (idIndexedChildren.get(child.getReferenceId()) != null) {
					referenceId++;
				}
				child.setReferenceId(String.valueOf(referenceId));
			}
			catch (NumberFormatException nfe) {
				/* Ignore the error */
			}

			/* If there is still a collision, then throw an exception */
			if (idIndexedChildren.get(child.getReferenceId()) != null)
				AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE_ID,
					child.getReferenceId()));

			idIndexedChildren.put(child.getReferenceId(),
				child);
			children.add(child);
		}
	}

	public int childCount() {
		return children.size();
	}

	public MacroObjectDescriptor[] getChildren() {
		MacroObjectDescriptor[] objects = new MacroObjectDescriptor[children.size()];
		children.toArray(objects);
		return objects;
	}

	public MacroObjectDescriptor removeChild(MacroObjectDescriptor child) {
		children.remove(child);
		return child;
	}

	public Object getData() {
		return data;
	}

	public void setData(Object data) {
		this.data = data;
	}

	public MacroObjectDescriptor findChild(String referenceId) {
		return (MacroObjectDescriptor) idIndexedChildren.get(referenceId);
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;

public interface IPlayable {

	boolean playback(Display display, Shell parent, IProgressMonitor monitor) throws CoreException;
}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.commands;

import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;


/**
 * @author Alexander Nyssen
 *
 */
public abstract class SingleSelectionCommand extends ObjectBasedCommand {

	/**
	 * @param parent
	 * @param widgetId
	 */
	public SingleSelectionCommand(MacroCommandShell parent) {
		super(parent);
	}
}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.uiobject;

import org.eclipse.swt.widgets.Widget;


/**
 * @author Alexander Nyssen
 *
 */
public interface IUIObject {

	public abstract Widget getWidget();

	public abstract Object getObject();
}




package org.eclipse.tptp.test.auto.gui.internal.core;

import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.UIObjectResolverDelegateLoader;

public class WidgetResolverLoaderToUIObjectResolverDelegateLoaderAdapter extends UIObjectResolverDelegateLoader {

	public WidgetResolverLoaderToUIObjectResolverDelegateLoaderAdapter(WidgetResolverLoader widgetResolverLoader) {
		super(widgetResolverLoader.getId(), new WidgetResolverToUIObjectResolverDelegateAdapter(widgetResolverLoader.getWidgetResolver()), widgetResolverLoader.getPriority());
	}

	
}




<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.tptp.test.auto.gui">
<annotation>
      <appInfo>
         <meta.schema plugin="org.eclipse.tptp.test.auto.gui" id="macroCommandFactory" name="macroCommandFactory"/>
      </appInfo>
      <documentation>
         Extension point to replace the macro command factory with a custom implementation.
      </documentation>
   </annotation>

   <element name="extension">
      <complexType>
         <sequence>
            <element ref="macroCommandFactory"/>
         </sequence>
         <attribute name="point" type="string" use="required">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="id" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="name" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
               <appInfo>
                  <meta.attribute translatable="true"/>
               </appInfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="macroCommandFactory">
      <complexType>
         <attribute name="id" type="string" use="required">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="class" type="string" use="required">
            <annotation>
               <documentation>
                  
               </documentation>
               <appInfo>
                  <meta.attribute kind="java" basedOn=":org.eclipse.tptp.test.auto.gui.commands.factory.IMacroCommandFactory"/>
               </appInfo>
            </annotation>
         </attribute>
         <attribute name="priority" type="string" use="required">
            <annotation>
               <documentation>
                  The priority of the factory. The factory with the highest priority is loaded and used, all others are disregarded.
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appInfo>
         <meta.section type="since"/>
      </appInfo>
      <documentation>
         [Enter the first release in which this extension point appears.]
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="examples"/>
      </appInfo>
      <documentation>
         [Enter extension point usage example here.]
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="apiInfo"/>
      </appInfo>
      <documentation>
         [Enter API information here.]
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="implementation"/>
      </appInfo>
      <documentation>
         [Enter information about supplied implementation of this extension point.]
      </documentation>
   </annotation>


</schema>




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.macroobject;

import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;

/**
 * 
 * @author Alexander Nyssen
 * 
 */
public interface IMacroObjectIdentifier {

	public String getContextIdentifier();

	public IUIObjectIdentifier getObjectIdentifier();

}




/*******************************************************************************
 * Copyright (c) 2006, 2008 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.editor;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.hyades.models.common.facades.behavioral.impl.HyadesUtil;
import org.eclipse.hyades.test.common.util.XMLUtil;
import org.eclipse.hyades.test.ui.adapter.TestWorkbenchAdapter;
import org.eclipse.hyades.test.ui.internal.editor.form.util.EObjectTreeContentProvider;
import org.eclipse.hyades.ui.editor.IEditorExtension;
import org.eclipse.hyades.ui.internal.provider.WorkbenchAdapterLabelProvider;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.viewers.IContentProvider;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIImages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.dialogs.AutoGUITestSuiteDialog;
import org.eclipse.tptp.test.auto.gui.internal.editor.AutoGUITestCaseTreeStructure.MessageUIElement;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptor;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMineManager;

/**
 * Represents the object mine tree that is displayed in the test case page of
 * the editor.
 * 
 * @author Ali Mehregani
 * @author Paul E. Slauenwhite
 * @version March 7, 2008
 * @since July 10, 2006
 */
public class AutoGUIMacroObjectDescriptorMineTreeStructure extends
		AutoGUIAbstractTreeStructure {
	/** Represents the root element in the object mine tree */
	private static final RootUMacroObjectDescriptorMineTreeNode ROOT_ELEMENT = new RootUMacroObjectDescriptorMineTreeNode();

	/** The test case form */
	private AutoGUITestCasesForm testCaseForm;

	/** The content provider */
	private ObjectMineTreeContentProvider contentProvider;

	/** The label provider */
	private ObjectMineLabelProvider labelProvider;

	/**
	 * The line number and offset relation. The index of the list represents the
	 * line number and the value is an object of type Integer[0] indicating the
	 * start and end offset
	 */
	private List lineOffsetRelation;

	/** The include object mine menu item */
	private IncludeObjectMineAction includeObjectMineAction;

	/** Change output menu item */
	private ChangeOutputAction changeOutputAction;

	/** Keeps track of the test suite used as input */
	private ITestSuite testSuiteInput;

	/** Stores any error that occurred while loading the object mine */
	private Object[] error;

	public AutoGUIMacroObjectDescriptorMineTreeStructure(
			AutoGUITestCasesForm testCaseForm, IEditorExtension editorPart) {
		super(editorPart, null);
		this.testCaseForm = testCaseForm;
		lineOffsetRelation = new ArrayList();
		includeObjectMineAction = new IncludeObjectMineAction();
		changeOutputAction = new ChangeOutputAction();
	}

	/**
	 * Overwrite this method so that a custom content provider can be registered
	 * with the tree
	 */
	protected IContentProvider createContentProvider() {
		if (contentProvider == null)
			contentProvider = new ObjectMineTreeContentProvider(editorPart,
					getEStructuralFeature());
		return contentProvider;
	}

	/**
	 * Overwrite this method so that a custom label provider can be registered
	 * with the tree
	 * 
	 * @return The label provider for the object mine tree
	 */
	protected ILabelProvider createLabelProvider() {
		if (labelProvider == null)
			labelProvider = new ObjectMineLabelProvider(
					TestWorkbenchAdapter.class);
		return labelProvider;
	}

	/**
	 * Overwrite this method so that custom buttons can be added beside the
	 * object mine tree.
	 */
	protected void adjustButtonLabels(String addLabel) {
		setButtonLabels(new String[0]);
	}

	/**
	 * Need to overwrite this method since there are no buttons whose status
	 * need to be updated.
	 */
	protected void updateActionsAndButtons(
			IStructuredSelection structuredSelection) {
		/* purposely left blank */
	}

	/**
	 * Refreshes the content of this tree by forcing the test suite to reload
	 * its object mine.
	 */
	public void refresh() {
		MacroObjectDescriptorMineManager.getInstance().clearCache();
		loadObjectMine(testSuiteInput, false);
		getTreeViewer().refresh();
	}

	public List getLineOffsetRelation() {
		return lineOffsetRelation;
	}

	/**
	 * Needs to be overwritten to modify the default tree style
	 */
	public int getTreeStryle() {
		return super.getTreeStryle() | SWT.BORDER;
	}

	private Object[] createErrorItem(String prefix, Exception e) {
		Throwable cause = AutoGUIUtil.findCause(e);
		prefix += prefix == null ? "" : ": ";
		prefix += (cause.getMessage() == cause.getClass().getName() ? "" : " "
				+ cause.getMessage());
		prefix += ": " + e.getStackTrace()[0].getClassName() + ":"
				+ e.getStackTrace()[0].getLineNumber();
		return new Object[] { new MessageUIElement(IStatus.ERROR, prefix) };
	}

	/**
	 * Overwrite this method so that custom menu items can be added to the
	 * entries that are displayed in the object mine tree.
	 * 
	 * @param menuManager
	 *            The menu manager
	 */
	protected void fillContextMenu(IMenuManager menuManager) {
		IStructuredSelection selection = getStructuredSelection();
		if (!selection.isEmpty()
				&& selection.size() == 1
				&& selection.getFirstElement() instanceof RootUMacroObjectDescriptorMineTreeNode) {
			menuManager.add(includeObjectMineAction);
			menuManager.add(changeOutputAction);
		}
	}

	private MacroObjectDescriptorMine loadObjectMine(ITestSuite testSuite,
			boolean showError) {
		MacroObjectDescriptorMine input = null;
		if (testSuite == null) {
			testSuiteInput = null;
			return null;
		}

		try {
			testSuiteInput = (ITestSuite) testSuite;
			input = MacroObjectDescriptorMineManager.getInstance()
					.loadObjectMine(testSuiteInput);
			String objectMineXML = HyadesUtil.getTestSuiteVariable(
					testSuiteInput,
					GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE);
			lineOffsetRelation = AutoGUIMacroObjectDescriptorMineTreeStructure.this
					.findLineOffsetIndicator(objectMineXML);
			error = null;
		} catch (Exception e) {
			if (showError) {
				AutoGUIUtil.openErrorWithDetail(
						AutoGUIMessages.AUTO_GUI_COMMON_ERROR,
						AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE + ": "
								+ testSuite.getName(), e);
			} else {
				error = createErrorItem(
						AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE, e);
			}

			input = null;
		}

		return input;
	}

	/**
	 * The content provider for the object mine tree.
	 * 
	 * @author Ali Mehregani
	 */
	private class ObjectMineTreeContentProvider extends
			EObjectTreeContentProvider {
		public ObjectMineTreeContentProvider(IEditorExtension editorPart,
				EStructuralFeature eStructuralFeature) {
			super(editorPart, eStructuralFeature);
		}

		public Object[] getElements(Object inputElement) {
			return new Object[] { ROOT_ELEMENT };
		}

		/**
		 * @see org.eclipse.jface.viewers.ITreeContentProvider#getChildren(java.lang.Object)
		 */
		public Object[] getChildren(Object parentElement) {
			MacroObjectDescriptorMine input = loadObjectMine(testSuiteInput,
					false);
			if (input == null) {
				if (parentElement == ROOT_ELEMENT && error != null)
					return error;
			}

			/*
			 * If the test suite doesn't have an object mine then return an
			 * empty list
			 */
			String objectMineXML = null;
			if (testSuiteInput == null
					|| (objectMineXML = HyadesUtil.getTestSuiteVariable(
							testSuiteInput,
							GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE)) == null
					|| objectMineXML.length() <= 0)
				return null;

			if (parentElement == ROOT_ELEMENT) {
				return input.getChildren();
			} else if (parentElement instanceof MacroObjectDescriptor) {
				return ((MacroObjectDescriptor) parentElement).getChildren();
			}

			return null;
		}

		public boolean hasChildren(Object parentElement) {
			MacroObjectDescriptorMine input = loadObjectMine(testSuiteInput,
					false);
			if (parentElement == ROOT_ELEMENT) {
				return input == null ? error != null
						: input.getChildren().length > 0;
			} else if (parentElement instanceof MacroObjectDescriptor) {
				return ((MacroObjectDescriptor) parentElement).childCount() > 0;
			}

			return false;
		}

		/**
		 * @see org.eclipse.jface.viewers.ITreeContentProvider#getParent(java.lang.Object)
		 */
		public Object getParent(Object element) {
			if (element instanceof MacroObjectDescriptor) {
				MacroObjectDescriptor parent = ((MacroObjectDescriptor) element)
						.getParent();
				return parent == null ? (Object) ROOT_ELEMENT : parent;
			}
			return null;
		}

		public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {
			if (!(newInput instanceof ITestSuite))
				return;

			loadObjectMine((ITestSuite) newInput, false);

		}
	}

	private class ObjectMineLabelProvider extends WorkbenchAdapterLabelProvider {

		public ObjectMineLabelProvider(Class cl)
				throws IllegalArgumentException {
			super(cl);
		}

		public String getText(Object element) {
			if (element == ROOT_ELEMENT) {
				return AutoGUIMessages.TST_SUITE_AUTO_MACRO_OBJ_MINE;
			} else if (element instanceof MacroObjectDescriptor) {
				String descriptiveField = ((MacroObjectDescriptor) element)
						.getDescriptive();
				return descriptiveField == null ? AutoGUIMessages.TST_SUITE_AUTO_MACRO_OBJ_OBJECT
						: XMLUtil.removeXMLSymbols(descriptiveField);
			} else if (element instanceof MessageUIElement) {
				String message = ((MessageUIElement) element).getText();
				return message == null ? AutoGUIMessages.TST_SUITE_AUTO_MACRO_MESSAGE
						: message;
			}

			return MacroConstants.EMPTY_STRING;
		}

		public Image getImage(Object element) {
			if (element == ROOT_ELEMENT) {
				return AutoGUIImages.getInstance().getImage(
						AutoGUIImages.OBJECT_MINE);
			} else if (element instanceof MacroObjectDescriptor) {
				MacroObjectDescriptor parent = ((MacroObjectDescriptor) element)
						.getParent();
				return parent == null ? AutoGUIImages.getInstance().getImage(
						AutoGUIImages.SHELL) : AutoGUIImages.getInstance()
						.getImage(AutoGUIImages.WIDGET);
			} else if (element instanceof MessageUIElement) {
				return ((MessageUIElement) element).getIcon();
			}

			return null;
		}
	}

	/**
	 * A dummy class that represents the root element in the object mine tree.
	 */
	private static class RootUMacroObjectDescriptorMineTreeNode {
	}

	/**
	 * The include object mine action. The purpose of this action is to allow
	 * the user to include object mines under the test suite's object mine
	 * 
	 * @author Ali Mehregani
	 */
	private class IncludeObjectMineAction extends Action {
		/**
		 * Perform the action.
		 * 
		 */
		public void run() {
			/* Display the test suite list dialog */
			AutoGUITestSuiteDialog autoGUITestSuiteDialog = new AutoGUITestSuiteDialog(
					GuiPlugin.getDefault().getWorkbench()
							.getActiveWorkbenchWindow().getShell(),
					testSuiteInput,
					AutoGUIMessages.AUTO_GUI_TST_DIALOG_TREE_ITITLE, false);

			if (autoGUITestSuiteDialog.open() == IDialogConstants.CANCEL_ID)
				return;

			/*
			 * Get the selected test suites and include them as part of this
			 * test suite's object mine
			 */
			Collection tests = autoGUITestSuiteDialog.getTests();
			MacroObjectDescriptorMine input = loadObjectMine(testSuiteInput,
					true);
			boolean markdirty = false;
			for (Iterator testIterator = tests.iterator(); testIterator
					.hasNext();) {
				Object currentTestSuite = testIterator.next();
				if (!(currentTestSuite instanceof ITestSuite))
					continue;

				ITestSuite testSuite = (ITestSuite) currentTestSuite;
				try {
					MacroObjectDescriptorMine objectMine = MacroObjectDescriptorMineManager
							.getInstance().loadObjectMine(testSuite);
					if (objectMine != null
							&& !input.getIncludes().contains(objectMine)) {
						markdirty = true;
						input.addInclude(objectMine);
					}
				} catch (Exception e) {
					/* Display an error */
					AutoGUIUtil
							.openErrorWithDetail(
									AutoGUIMessages.AUTO_GUI_COMMON_ERROR,
									NLS
											.bind(
													AutoGUIMessages.AUTO_GUI_ERROR_DIALOG_TST_INCL,
													testSuite.getName()), e);
				}
			}

			if (markdirty) {
				testCaseForm.updateTestProperty(null,
						input.serializeToString(), true);
				getTreeViewer().setSelection(getTreeViewer().getSelection());
			}
		}

		public boolean isEnabled() {
			return testSuiteInput != null;
		}

		public String getText() {
			return AutoGUIMessages.AUTO_GUI_TST_DIALOG_TREE_INCL;
		}

		public ImageDescriptor getImageDescriptor() {
			return AutoGUIImages.getInstance().getImageDescriptor("e",
					AutoGUIImages.INCLUDE);
		}
	}

	/**
	 * This action changes the output of the object mine to another test suite.
	 * 
	 * @author Ali Mehregani
	 */
	private class ChangeOutputAction extends Action {
		/**
		 * Perform the action.
		 */
		public void run() {
			/* Display the test suite list dialog */
			AutoGUITestSuiteDialog autoGUITestSuiteDialog = new AutoGUITestSuiteDialog(
					GuiPlugin.getDefault().getWorkbench()
							.getActiveWorkbenchWindow().getShell(),
					testSuiteInput,
					AutoGUIMessages.AUTO_GUI_TST_DIALOG_TREE_ITITLE, true);

			if (autoGUITestSuiteDialog.open() == IDialogConstants.CANCEL_ID)
				return;

			/*
			 * Get the selected test suites and include them as part of this
			 * test suite's object mine
			 */
			Collection tests = autoGUITestSuiteDialog.getTests();
			if (tests == null)
				return;

			Object[] selectedTestContainer = tests.toArray();
			if (selectedTestContainer.length != 1
					|| !(selectedTestContainer[0] instanceof ITestSuite))
				return;

			MacroObjectDescriptorMine input = loadObjectMine(testSuiteInput,
					true);
			MacroObjectDescriptorMine oldOutputObjectMine = input
					.getOutputSource();
			ITestSuite oldOutput = oldOutputObjectMine == null ? null
					: oldOutputObjectMine.getOwner();
			ITestSuite newOutput = (ITestSuite) selectedTestContainer[0];
			if (oldOutput == null
					|| (!oldOutput.getId().equals(newOutput.getId()))) {
				MacroObjectDescriptorMine objectMine = null;
				try {
					objectMine = MacroObjectDescriptorMineManager.getInstance()
							.loadObjectMine(newOutput);
					input.setOutputSource(objectMine);
					testCaseForm.updateTestProperty(null, input
							.serializeToString(), true);
					getTreeViewer()
							.setSelection(getTreeViewer().getSelection());
				} catch (Exception e) {
					input.setOutputSource(null);
					AutoGUIUtil
							.openErrorWithDetail(
									AutoGUIMessages.AUTO_GUI_COMMON_ERROR,
									NLS
											.bind(
													AutoGUIMessages.AUTO_GUI_ERROR_OBJ_MINE_OUTPUT,
													newOutput.getName()), e);
				}
			}
		}

		public boolean isEnabled() {
			return testSuiteInput != null;
		}

		public String getText() {
			return AutoGUIMessages.AUTO_GUI_TST_DIALOG_TREE_OUPUT;
		}

		public ImageDescriptor getImageDescriptor() {
			return AutoGUIImages.getInstance().getImageDescriptor("e",
					AutoGUIImages.OUTPUT);
		}
	}
}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.deresolvingsupport;

import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;


/**
 * Used to migrate the old WidgetResolvers to the new IUIObjectResolverDelegate interface 
 * while preserving their implementation. 
 * @author ANy
 * @version $Revision$
 *
 */
public interface IUIObjectDeprecatedDeresolvingFacade {

	/**
	 * Given an object and an id, this method should return true if and only if the id of object as determined by this resolver equals the 'id' passed
	 * in.
	 * 
	 * @param object
	 *            An object
	 * @param objectId
	 *            The being searched for
	 * @return true iff object's id is equalled to 'id'
	 */
	public boolean foundWidget(Widget object, IUIObjectIdentifier objectId);
}




/*******************************************************************************
 * Copyright (c) 2000, 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;

import java.util.ArrayList;
import java.util.Hashtable;
import java.util.Vector;

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.SubProgressMonitor;
import org.eclipse.jface.window.Window;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.SWTException;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.commands.AbstractMacroCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.IMacroCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.MouseEventCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.VerificationCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.WaitCommand;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObject;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptor;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.resolver.MacroObjectResolver;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.PrimitiveUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.UIObject;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * Keeps track of the macro commands while they are being captured.
 * 
 * @author Alexander Nyssen (factored creation of commands out into respective
 *         factory)
 */
public class MacroCommandShell extends AbstractMacroInstruction implements
		IMacroInstruction {

	/** The widget id associated with this macro command shell */
	private IMacroObjectIdentifier macroObjectIdentifier;

	/** The corresponding UI object for this macro command shell */
	private MacroObjectDescriptor macroObjectDescriptor;

	/* The commands of this macro shell */
	private ArrayList commands;

	/* The expected return code */
	private int expectedReturnCode;

	/* The display object */
	private transient Display display;

	/* The shell that this macro command shell represents */
	private transient Shell shell;

	/* The reference id of the macro shell object */
	// private String referenceId;
	/* The title of the shell that this macro command shell represents */
	private String shellTitle;

	private transient Window window;

	/* Set when there is a listener registered with this MacroCommandShell */
	private transient boolean isListenerRegistered;

	/*
	 * A queue of nested shell waiting to be activated (this is used during
	 * playback)
	 */
	private static Vector nestedShellQueue;

	/* Last index of the nested shell queue */
	private static int lastNestedShellInx;

	/* Stores the last command line executed */
	private static int lastCommandLineExecuted;

	/*
	 * Mutual lock used to block when a command is being executed. This lock is
	 * used to forcefully wake up the thread that this object is running in if
	 * the command has caused a stall
	 */
	private Boolean mutualLock;

	/*
	 * A mutual lock shared across multiple instances of this class -- It's
	 * general purpose is to lock shared static resources
	 */
	private static Boolean mutualGlobalLock;

	/*
	 * The parent of this macro command shell. This is null if this macro shell
	 * command is the root
	 */
	private MacroCommandShell parent;

	/*
	 * The index of the command being executed -- this will correspond to the
	 * last command index if isComplete = true
	 */
	private int currentCommandInx;

	/* Indicates if all the commands of this shell has been completed */
	private boolean isComplete;

	/* Indicates that the process needs to be interrupted -- due to an error */
	private static boolean interruptProcess;

	/* Set to true when process has been terminated */
	private static boolean processTerminated;

	/* The exception causing the interruption */
	private static Throwable interruptedException;

	/* A central container for all macro command operation being played */
	private static Vector macroCommandsBeingPlayed;

	/* A central container for all instances of this class */
	private static Vector macroCommandShellContainer;

	/* A central repository for all macro command shells */
	static {
		nestedShellQueue = new Vector();
		macroCommandsBeingPlayed = new Vector();
		macroCommandShellContainer = new Vector();
		mutualGlobalLock = new Boolean(true);
	}

	public MacroCommandShell(MacroCommandShell parent) {
		this(parent, null, null);
	}

	public MacroCommandShell(MacroCommandShell parent, Shell shell,
			IMacroObjectIdentifier wid) {
		setMacroObjectIdentifier(wid);
		commands = new ArrayList();
		this.shell = shell;
		this.shellTitle = shell == null || shell.isDisposed() ? null : shell
				.getText();
		hookWindow(false);
		expectedReturnCode = -1;
		isListenerRegistered = false;
		mutualLock = new Boolean(true);
		this.parent = parent;
		isComplete = false;
		macroCommandShellContainer.add(this);
	}

	public IMacroObjectIdentifier getMacroObjectIdentifier() {
		return macroObjectIdentifier;
	}

	public void setMacroObjectIdentifier(IMacroObjectIdentifier objectIdentifier) {
		this.macroObjectIdentifier = objectIdentifier;
	}

	public MacroObjectDescriptor getCorrespondingMacroObjectDescriptor() {
		return macroObjectDescriptor;
	}

	public void setCorrespondingMacroObjectDescriptor(
			MacroObjectDescriptor uiObject) {
		this.macroObjectDescriptor = uiObject;
	}

	private void hookWindow(boolean playback) {
		if (shell != null) {
			if (!playback)
				doHookWindow();
			else
				display.syncExec(new Runnable() {

					public void run() {
						doHookWindow();
					}
				});
		}
	}

	private void doHookWindow() {
		Object data = shell.getData();
		if (data != null && data instanceof Window)
			this.window = (Window) data;
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.macro.AbstractMacroInstruction#load(org.w3c.dom.Node,
	 *      java.util.Hashtable)
	 */
	public void load(Node node, Hashtable lineTable) throws CoreException {
		super.load(node, lineTable);

		/*
		 * If the corresponding shell of this command is referenced then attempt
		 * to find the corresponding object in the object mine.
		 */
		if (MacroManager.getInstance().getObjectMine() != null) {
			MacroObjectDescriptor descriptor = MacroManager.getInstance()
					.getObjectMine().lookupReferenceId(null, node, lineTable);
			if (descriptor != null) {
				setCorrespondingMacroObjectDescriptor(descriptor);
			}
		}
		boolean useObjectMine = getCorrespondingMacroObjectDescriptor() != null;
		setMacroObjectIdentifier(new MacroObjectIdentifier(null,
				new PrimitiveUIObjectIdentifier(
						useObjectMine ? getCorrespondingMacroObjectDescriptor()
								.getWidgetId() : MacroUtil.getAttribute(node,
								MacroConstants.WIDGET_ID_ATTRIBUTE),
						useObjectMine ? getCorrespondingMacroObjectDescriptor()
								.getResolverId() : MacroUtil.getAttribute(node,
								MacroConstants.RESOLVER_ID_ATTRIBUTE))));
		String codeId = MacroUtil.getAttribute(node,
				MacroConstants.RETURN_CODE_ATTRIBUTE);
		if (codeId != null) {
			try {
				expectedReturnCode = new Integer(codeId).intValue();
			} catch (NumberFormatException e) {
			}
		}
		NodeList children = node.getChildNodes();
		for (int i = 0; i < children.getLength(); i++) {
			Node child = children.item(i);
			if (child.getNodeType() == Node.ELEMENT_NODE) {
				String name = child.getNodeName();
				if (name.equals(MacroConstants.COMMAND_ELEMENT))
					processCommand(child, lineTable);
				else if (name.equals(MacroConstants.SHELL_ELEMENT))
					processShell(child, lineTable);
			}
		}
	}

	/**
	 * Used to process the node that is passed in as argument, the lineTable
	 * hashtable indicates the range of line numbers that the node corresponds
	 * to in the macro script
	 * 
	 * @param node
	 *            The node to be processed
	 * @param lineTable
	 *            The line number range that the node corresponds to in the
	 *            script.
	 */
	private void processCommand(Node node, Hashtable lineTable)
			throws CoreException {

		String type = MacroUtil.getAttribute(node,
				MacroConstants.TYPE_ATTRIBUTE);
		if (type == null)
			return;

		IMacroCommand command = MacroManager.getInstance()
				.getMacroCommandFactory().createCommand(this, type);

		if (command != null) {
			command.load(node, lineTable);
			commands.add(command);
		}
	}

	private void processShell(Node node, Hashtable lineTable)
			throws CoreException {
		MacroCommandShell shell = new MacroCommandShell(this);
		shell.load(node, lineTable);
		commands.add(shell);
	}

	public void addCommandShell(MacroCommandShell cshell) {
		commands.add(cshell);
	}

	public void write(int indent, StringBuffer sb) {
		/* If this shell command doesn't have any commands, then exit */
		if (commands == null || commands.size() <= 0)
			return;

		/* <shell */
		MacroUtil.addElement(sb, indent, MacroConstants.SHELL_ELEMENT, false,
				false);
		boolean objectMineInUse = MacroManager.getInstance().isObjectMineOn();
		MacroUtil.addAttribute(sb, new String[] {
				MacroConstants.DESCRIPTIVE_ATTRIBUTE,
				MacroConstants.RESOLVER_ID_ATTRIBUTE,
				MacroConstants.WIDGET_ID_ATTRIBUTE,
				MacroConstants.REFERENCE_ID_ATTRIBUTE,
				MacroConstants.RETURN_CODE_ATTRIBUTE }, new String[] {
				getDescriptiveField(),
				objectMineInUse ? null : getMacroObjectIdentifier()
						.getObjectIdentifier().getResolverId(),
				objectMineInUse ? null : getMacroObjectIdentifier()
						.getObjectIdentifier().getWidgetId(),
				objectMineInUse ? getCorrespondingMacroObjectDescriptor()
						.getReferenceId() /*
											 * CHANGED BY ANY: use the ref id of
											 * the corresponing
											 * MacroObjectDescriptor rather than
											 * the id stored in the widgetId
											 */
				: null, String.valueOf(expectedReturnCode) }, false, true);
		int cindent = indent + 1;
		for (int i = 0; i < commands.size(); i++) {
			IPersistable persistable = (IPersistable) commands.get(i);
			persistable.writeStart(cindent, sb);
			persistable.write(cindent, sb);
			persistable.writeFinish(cindent, sb);
		}
		MacroUtil.addElement(sb, indent, MacroConstants.SHELL_ELEMENT, true,
				true);
	}

	public String getDescriptiveField() {
		return shellTitle == null ? null : MacroUtil
				.normalizeDescriptiveField(MacroUtil.boundSize(shellTitle,
						IMacroCommand.DESCRIPTIVE_FIELD_BOUND));
	}

	public void addEvent(Event event) {
		if (event.widget instanceof Control) {
			if (((Control) event.widget).isVisible() == false)
				return;
		}

		IMacroCommand command = null;
		try {
			command = MacroManager.getInstance().getMacroCommandFactory()
					.createCommand(this, commands, event);
		} catch (CoreException e) {
			// it may be the case we are waiting for a verification command to
			// be created, so notify a waiting listener (just in case)
			MacroManager.getInstance().notifyVerificationListener(
					e.getMessage());
		}

		// if we are waiting for a verification command, notify the listener
		// that is was correctly created
		if (command != null && command instanceof VerificationCommand) {
			MacroManager.getInstance().notifyVerificationListener(
					(VerificationCommand) command);
		}
	}

	/**
	 * Adds a wait command for as long as the last command is not already a wait
	 * (i.e. duplicate addition of wait commands are avoided through this
	 * method)
	 */
	public void addPause() {
		WaitCommand command = new WaitCommand(this);

		Object lastCommand = null;
		int commandSize = commands.size();
		boolean isLastCommandWait = false;

		if (commandSize <= 0)
			return;

		lastCommand = commands.get(commandSize - 1);
		int lastCmdInx = 2;

		/*
		 * Avoid MacroCommandShells that have no commands (since these will not
		 * be included as part of the macro)
		 */
		while (lastCommand instanceof MacroCommandShell
				&& ((MacroCommandShell) lastCommand).getCommands().size() <= 0) {
			if (commandSize - lastCmdInx >= 0)
				lastCommand = commands.get(commandSize - lastCmdInx);
			else {
				lastCommand = null;
				break;
			}

			lastCmdInx++;
		}

		AbstractMacroCommand lastMacroCommand = null;
		if (lastCommand instanceof AbstractMacroCommand)
			lastMacroCommand = (AbstractMacroCommand) lastCommand;

		isLastCommandWait = lastMacroCommand != null
				&& lastMacroCommand.getType() == WaitCommand.TYPE;
		if (commands.size() > 0 && !isLastCommandWait) {
			commands.add(command);
		}
	}

	public void extractExpectedReturnCode() {
		if (window != null)
			expectedReturnCode = window.getReturnCode();
	}

	public boolean matchesReturnCode() {
		if (window != null) {
			return window.getReturnCode() == expectedReturnCode;
		}
		return true;
	}

	public boolean isDisposed() {
		return this.shell != null && this.shell.isDisposed();
	}

	public void close() {
		if (this.shell != null && !this.shell.isDisposed())
			this.shell.close();
	}

	public boolean tracks(Shell shell) {
		if (this.shell != null && this.shell.equals(shell))
			return true;
		return false;
	}

	public boolean playback(final Display display, Shell parent,
			final IProgressMonitor monitor) throws CoreException {
		if (parent instanceof Shell) {
			this.shell = (Shell) parent;
			this.display = display;
			hookWindow(true);
		}

		NestedShell nestedShell = null;
		int commandSize = commands.size();
		monitor.beginTask("", commandSize);
		final int commandTimeOut;

		int potentialTimeoutValue = MacroManager.getInstance()
				.getCommandTimeoutThreshold();
		if (MacroManager.getInstance().getCommandTimeoutThreshold() > 0)
			commandTimeOut = potentialTimeoutValue;
		else
			commandTimeOut = GlobalConstants.DEFAULT_COMMAND_TIME_OUT_PERIOD;

		for (int i = 0; i < commandSize; i++) {
			currentCommandInx = i;
			checkForInterruptions();
			Object c = commands.get(i);
			final IPlayable playable = (IPlayable) c;

			/*
			 * If this is the last command of this macro command shell, then
			 * take out its entry in the shell queue
			 */
			if (isLastCommand(i)) {
				if (getNestedShellQueue() != null
						&& getNestedShellQueue().size() > 0) {
					if (lastNestedShellInx > 0)
						lastNestedShellInx--;
					removeNestedShell(0);
				}
			}

			/*
			 * If this command is a nested shell, then we need to wait until it
			 * completes before proceeding to the next command.
			 */
			if (c instanceof MacroCommandShell) {
				MacroCommandShell nestedCommandShell = (MacroCommandShell) c;
				// System.out.println("NESTED SHELL WAIT: " +
				// nestedCommandShell.getId());
				Object lastNestedCommand = null;
				Object currentNestedCommand = null;
				synchronized (nestedCommandShell) {
					/*
					 * Give each command in the nested shell a maximum of
					 * commandTimeOut to execute
					 */
					while (!nestedCommandShell.isComplete()
							&& (currentNestedCommand == null || lastNestedCommand != currentNestedCommand)
							&& !interruptProcess) {
						try {
							nestedCommandShell.wait(commandTimeOut);
							lastNestedCommand = currentNestedCommand;
							currentNestedCommand = nestedCommandShell
									.getCommandBeingExecuted();
						} catch (InterruptedException e) {
							/* Handled by next set of code */
						}
					}

					/* Indicate an error if the nested shell never completed */
					if (!nestedCommandShell.isComplete()) {
						synchronized (mutualGlobalLock) {
							interruptProcess = true;
							if (interruptedException == null)
								interruptedException = new CoreException(
										new Status(
												IStatus.ERROR,
												GuiPlugin.getID(),
												0,
												NLS
														.bind(
																AutoGUIMessages.AUTO_GUI_ERROR_MACRO_NEST_TOUT,
																nestedCommandShell
																		.getMacroObjectIdentifier()
																		.getObjectIdentifier()
																		.toString()),
												null));
						}

						continue; /* Interrupt the normal flow */
					}
					// System.out.println("NESTED SHELL FINISH: " +
					// nestedCommandShell.getId());
				}
			}

			if (i < commandSize - 1) {
				/*
				 * Ali M.: We need to iterate through all the shell commands and
				 * register listeners before it's too late. It's not sufficient
				 * to just register a listener with the next command
				 */
				int counter = 1;
				IPlayable next = (IPlayable) commands.get(i + counter);
				while (next instanceof MacroCommandShell) {
					/*
					 * This command will open a new shell. Add a listener before
					 * it is too late
					 */
					MacroCommandShell nestedCommand = (MacroCommandShell) next;

					if (!nestedCommand.isListenerRegistered()) {
						nestedShell = new NestedShell(display, nestedCommand,
								new SubProgressMonitor(monitor, 1));
						final NestedShell fnestedShell = nestedShell;

						/*
						 * If this is a child of the previous shell, then it
						 * takes precedence. If it's a sibling, then it should
						 * go to the end of the queue.
						 */
						nestedCommand.setListenerRegistered(true);
						if (nestedShellQueue.size() > 0
								&& ((NestedShell) nestedShellQueue.get(0))
										.isParent(nestedCommand)) {
							addNestedShell(0, fnestedShell);
							lastNestedShellInx = 0;
						} else {
							if (nestedShellQueue.size() > 0)
								addNestedShell(++lastNestedShellInx,
										fnestedShell);
							else
								addNestedShell(fnestedShell);
						}

						display.syncExec(new Runnable() {

							public void run() {
								// System.out.println("ADDED");
								display.addFilter(SWT.Activate, fnestedShell);
							}
						});
					}
					counter++;
					next = (i + counter <= commandSize - 1 ? (IPlayable) commands
							.get(i + counter)
							: null);
				}
			}
			if (playable instanceof AbstractMacroCommand) {
				final boolean last = i == commandSize - 1;

				class WakeUpOperaion implements Runnable {

					private AbstractMacroCommand command;
					private boolean invalidate;

					public WakeUpOperaion(AbstractMacroCommand command) {
						this.command = command;
						invalidate = false;
					}

					public void run() {
						if (!invalidate
								&& MacroCommandShell.lastCommandLineExecuted == command
										.getStartLine()) {
							/*
							 * Ali M.: A command just timed-out. We need to
							 * indicate the error and wakeup the thread
							 */
							synchronized (mutualGlobalLock) {
								interruptProcess = true;
								if (interruptedException == null)
									interruptedException = new CoreException(
											new Status(
													IStatus.ERROR,
													GuiPlugin.getID(),
													0,
													NLS
															.bind(
																	AutoGUIMessages.AUTO_GUI_ERROR_MACRO_TIME_OUT,
																	command
																			.toString()),
													null));
							}

							synchronized (mutualLock) {
								mutualLock.notify();
							}
						}
					}

					public void invalidate() {
						this.invalidate = true;
					}

				}
				WakeUpOperaion wakeupOpt = null;
				if (i < commandSize - 1) {
					wakeupOpt = new WakeUpOperaion(
							(AbstractMacroCommand) playable);
					final Runnable wakeupOperation = wakeupOpt;
					display.asyncExec(new Runnable() {

						public void run() {
							display.timerExec(commandTimeOut, wakeupOperation);
						};

					});
				}

				class RunCommandOperation implements Runnable {

					private boolean isComplete;

					public void run() {
						try {
							if (!macroCommandsBeingPlayed.contains(this))
								macroCommandsBeingPlayed.add(this);

							lastCommandLineExecuted = ((AbstractMacroCommand) playable)
									.getStartLine();
							playInGUIThread(display, playable, last, monitor);

							macroCommandsBeingPlayed.remove(this);
							isComplete = true;
							synchronized (mutualLock) {
								mutualLock.notify();
							}
						} catch (Throwable e) {
							macroCommandsBeingPlayed.remove(this);
							synchronized (mutualGlobalLock) {
								interruptProcess = true;
								if (interruptedException == null)
									interruptedException = e;
							}
							isComplete = true;
							synchronized (mutualLock) {
								mutualLock.notify();
							}
						}
					}

					public boolean isComplete() {
						return isComplete;
					}

				}

				RunCommandOperation runCommandOpt = new RunCommandOperation();

				/* Run the command */
				synchronized (mutualLock) {
					new Thread(runCommandOpt).start();
					long start = System.currentTimeMillis();
					long wakeUpTime = start;
					long timeToSleep = commandTimeOut;
					try {
						while (!runCommandOpt.isComplete() && timeToSleep > 0
								&& !interruptProcess) {
							// System.out.println("WAITING on command: " +
							// playable);
							mutualLock.wait(timeToSleep);
							wakeUpTime = System.currentTimeMillis();
							timeToSleep = timeToSleep - (wakeUpTime - start);
						}
					} catch (InterruptedException e) {
						/* Doesn't need to be handled */
					}

					/* Indicate an error if command didn't complete */
					if (!runCommandOpt.isComplete()) {
						synchronized (mutualGlobalLock) {
							interruptProcess = true;
							if (interruptedException == null)
								interruptedException = new CoreException(
										new Status(
												IStatus.ERROR,
												GuiPlugin.getID(),
												0,
												NLS
														.bind(
																AutoGUIMessages.AUTO_GUI_ERROR_MACRO_TIME_OUT,
																playable
																		.toString()),
												null));
						}
					}
					/*
					 * Otherwise invalidate the wake up operation that was
					 * suppose to wake this command up
					 */
					else if (wakeupOpt != null)
						wakeupOpt.invalidate();

					// System.out.println("FINISHED WAITING on command: " +
					// playable);
				}

				monitor.worked(1);
			}
		}

		checkForInterruptions();
		shell = null;

		/*
		 * We made it out alive -- mark this as complete and wake any parents
		 * that are waiting upon our completion
		 */
		isComplete = true;
		synchronized (this) {
			this.notify();
		}

		macroCommandShellContainer.remove(this);
		return true;
	}

	private boolean isComplete() {
		return isComplete;
	}

	private Object getCommandBeingExecuted() {
		if (commands == null || currentCommandInx >= commands.size())
			return null;
		return commands.get(currentCommandInx);
	}

	private void checkForInterruptions() throws CoreException {
		if (interruptProcess) {
			/* Wake up all threads in case they are asleep */
			if (!processTerminated) {
				processTerminated = true;
				interruptOperation();
				MacroCommandShell.macroStopped();
				MacroUtil.closeSecondaryShells(display);
			}

			for (int i = 0; i < macroCommandShellContainer.size(); i++) {
				synchronized (mutualLock) {
					mutualLock.notify();
				}

				synchronized (macroCommandShellContainer.get(i)) {
					macroCommandShellContainer.get(i).notify();
				}
			}

			/* Try to close all nested shells */
			synchronized (mutualGlobalLock) {
				if (interruptedException instanceof CoreException)
					throw (CoreException) interruptedException;
				throw new CoreException(new Status(IStatus.ERROR, GuiPlugin
						.getID(), 0,
						interruptedException.getLocalizedMessage(),
						interruptedException));
			}
		}

	}

	/**
	 * A helper method that walks through all macro command shells and
	 * interrupts their normal flow.
	 */
	private void interruptOperation() {
		MacroCommandShell currentMacroShell = this;
		while (currentMacroShell != null) {
			Boolean lock = currentMacroShell.mutualLock;
			synchronized (lock) {
				lock.notify();
			}

			currentMacroShell = currentMacroShell.getParent();
		}

	}

	private boolean isLastCommand(int index) {
		for (int i = index + 1; i < commands.size(); i++) {
			if (commands.get(i) instanceof AbstractMacroCommand)
				return false;
		}
		return true;
	}

	private void playInGUIThread(final Display display,
			final IPlayable playable, boolean last,
			final IProgressMonitor monitor) throws CoreException {
		final CoreException[] ex = new CoreException[1];

		Runnable runnable = new Runnable() {

			public void run() {
				try {
					boolean status = playable.playback(display,
							MacroCommandShell.this.shell, monitor);

					/* Something went wrong playing this item */
					if (!status)
						ex[0] = createPlaybackException(playable, null);
					else
						MacroUtil.processDisplayEvents(display);
				} catch (ClassCastException e) {
					ex[0] = createPlaybackException(playable, e);
				} catch (CoreException e) {
					ex[0] = e;
				} catch (SWTException e) {
					/* Don't handle */
				} catch (Throwable error) {
					ex[0] = createPlaybackException(playable, error);
				}
			}
		};

		if (playable instanceof WaitCommand) {
			playable.playback(display, this.shell, monitor);
		} else {
			display.syncExec(runnable);
		}

		try {
			Thread.sleep(100);
		} catch (InterruptedException e) {
		}

		if (ex[0] != null)
			throw ex[0];

	}

	private CoreException createPlaybackException(IPlayable playable,
			Throwable th) {
		IStatus status = new Status(IStatus.ERROR, "org.eclipse.pde.ui.tests",
				IStatus.OK, NLS.bind(
						AutoGUIMessages.AUTO_GUI_ERROR_MACRO_COMMAND, playable
								.toString()), th);
		return new CoreException(status);
	}

	public ArrayList getCommands() {
		return commands;
	}

	public boolean isListenerRegistered() {
		return isListenerRegistered;
	}

	public void setListenerRegistered(boolean isListenerRegistered) {
		this.isListenerRegistered = isListenerRegistered;
	}

	public static Vector getNestedShellQueue() {
		return nestedShellQueue;
	}

	public static void addNestedShell(int inx, NestedShell nestedShell) {
		synchronized (nestedShellQueue) {
			if (inx >= 0)
				nestedShellQueue.add(inx, nestedShell);
			else
				nestedShellQueue.add(nestedShell);
		}
	}

	private static void addNestedShell(NestedShell fnestedShell) {
		addNestedShell(-1, fnestedShell);
	}

	public static void removeNestedShell(int inx) {
		synchronized (nestedShellQueue) {
			nestedShellQueue.remove(inx);
		}
	}

	public static void initializeForNewPlay() {
		nestedShellQueue.clear();
		lastNestedShellInx = 0;
		interruptProcess = false;
		processTerminated = false;
		interruptedException = null;
		MouseEventCommand.init();
		macroCommandsBeingPlayed.clear();
		macroCommandShellContainer.clear();
	}

	public Shell getShell() {
		return shell;
	}

	public void writeStart(int indent, StringBuffer sb) {
		/* Doesn't need to be implemented */
	}

	public void writeFinish(int indent, StringBuffer sb) {
		/* Doesn't need to be implemented */
	}

	public MacroCommandShell getParent() {
		return parent;
	}

	public void setParent(MacroCommandShell parent) {
		this.parent = parent;
	}

	public static void macroStopped() {
		/* Walk through nested shell listeners and remove them if any exists */
		final Display display = GuiPlugin.getDefault().getWorkbench()
				.getDisplay();
		display.syncExec(new Runnable() {

			public void run() {
				for (int i = 0, nestedShellListenerSize = nestedShellQueue
						.size(); i < nestedShellListenerSize; i++) {
					display.removeFilter(SWT.Activate,
							(NestedShell) nestedShellQueue.get(i));
				}
			}
		});
	}

	public static Vector getMacroCommandsBeingPlayed() {
		return macroCommandsBeingPlayed;
	}

	private static class NestedShell implements Listener, Runnable {

		private MacroCommandShell cshell;

		private Display display;

		private Shell nshell;

		private boolean released;

		private CoreException exception;

		private IProgressMonitor monitor;

		private boolean served;

		public NestedShell(Display display, MacroCommandShell cshell,
				IProgressMonitor monitor) {
			this.display = display;
			this.cshell = cshell;
			this.monitor = monitor;
		}

		public void handleEvent(Event event) {
			try {
				if (event.widget instanceof Shell) {
					// shell activated
					Shell shell = (Shell) event.widget;
					// ANY: CHANGED: IPath path = new
					// Path(UIObjectResolverUtil.getShellId(shell,null).toString());
					// String sid = path.toString();
					String sid = MacroObjectResolver.resolve(shell,
							new MacroObject(new UIObject(shell)))
							.getObjectIdentifier().getWidgetId();

					/* Debug */
					// System.out.println();
					// System.out.println(sid + " : " + cshell.getId());
					// if (MacroCommandShell.getNestedShellQueue() != null &&
					// MacroCommandShell.getNestedShellQueue().size() > 0)
					// System.out.println("Is Served: " +
					// ((NestedShell)MacroCommandShell.getNestedShellQueue().get(0)).isServed());
					// System.out.println(this + " : " +
					// MacroCommandShell.getNestedShellQueue().get(0));
					// System.out.println();
					if (sid.equals(cshell.getMacroObjectIdentifier()
							.getObjectIdentifier().getWidgetId())
							&& (MacroCommandShell.getNestedShellQueue() == null
									|| MacroCommandShell.getNestedShellQueue()
											.size() <= 0 || (!((NestedShell) MacroCommandShell
									.getNestedShellQueue().get(0)).isServed() && this
									.equals(MacroCommandShell
											.getNestedShellQueue().get(0))))) {
						// System.out.println("REMOVED FILTER: " +
						// cshell.getId());
						shell.getDisplay().removeFilter(SWT.Activate, this);
						released = true;
						this.nshell = shell;

						/*
						 * We need to start this in a separate thread.
						 * MacroCommandShells should not be played in UI threads
						 * (otherwise wait commands will not work properly)
						 */
						this.setServed(true);
						new Thread(this).start();
					}
				}
			} catch (Throwable t) {
				// System.out.println("REMOVED filter");
				/* Something unexpected has happened -- Remove this listener */
				event.display.removeFilter(SWT.Activate, this);
			}
		}

		public void setServed(boolean served) {
			this.served = served;
		}

		public boolean isServed() {
			return served;
		}

		public boolean getResult() {
			return cshell.matchesReturnCode();
		}

		public boolean isReleased() {
			return released;
		}

		public void run() {
			try {
				cshell.playback(display, nshell, monitor);
			} catch (CoreException e) {
				synchronized (mutualGlobalLock) {
					interruptProcess = true;
					if (interruptedException == null)
						interruptedException = e;
				}

				synchronized (cshell.mutualLock) {
					cshell.mutualLock.notify();
				}
			}
		}

		public CoreException getException() {
			return exception;
		}

		public boolean isParent(MacroCommandShell macroCommandShell) {
			return macroCommandShell.getParent().equals(cshell);
		}
	}

}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;

/**
 * This interface is registered using extension point
 * <code>org.eclipse.tptp.test.auto.gui.internal.widgetResolver</code> which is
 * expected to return a unique identifier from a provided widget. The identifier
 * must be reproducable between sessions so that it can be used to locate the
 * widget on playback.
 * 
 * @since 3.1
 */
public interface IUIObjectResolverDelegate {

	/**
	 * Returns a unique identifier for the provided UI object.
	 * 
	 * @param context
	 *            The context of the UI object (usually retrieved from an
	 *            IMacroObject)
	 * @param uiObject
	 *            The object whose id is suppose to be resolved. The type of
	 *            this object is <b>usually</b> a widget, but it can also be a
	 *            <code>java.lang.String</code> or any other arbitrary type
	 *            depending on the implementation of the widget. For example,
	 *            when attempting to resolve a combo box item, parent will point
	 *            to the combo box and object will point to a
	 *            <code>java.lang.String</code> item representing the item
	 *            selected.
	 * 
	 * @return unique identifier that can be used to locate the UI object within
	 *         the context or <code>null</code> if none can be found.
	 */
	public IUIObjectIdentifier resolve(Object context, IUIObject uiObject)
			throws CoreException;

	public IUIObject deresolve(Object context,
			IUIObjectIdentifier uiObjectIdentifier) throws CoreException;

}




/*******************************************************************************
 * Copyright (c) 2006, 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate;

/**
 * Represents each widgetResolver element that appears under a widgetResolver
 * extension
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen
 */
public class UIObjectResolverDelegateLoader {

	/** The id of the widget resolver */
	private String id;

	/** The widget resolver class */
	private IUIObjectResolverDelegate uiObjectResolverDelegate;

	/** The priority of this widget resolver registeration */
	private int priority;

	/**
	 * Limit the visibility of the constructor
	 */
	protected UIObjectResolverDelegateLoader(String id,
			IUIObjectResolverDelegate resolver, int priority) {
		this.id = id;
		this.uiObjectResolverDelegate = resolver;
		this.priority = priority;
	}

	/**
	 * @return the id
	 */
	public String getId() {
		return id;
	}

	/**
	 * @return the priority
	 */
	public int getPriority() {
		return priority;
	}

	/**
	 * @return the widgetResolver
	 */
	public IUIObjectResolverDelegate getUIObjectResolverDelegate() {
		return uiObjectResolverDelegate;
	}
}




/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;


/**
 * Represents a macro instruction. The instruction is expected to both be writable and playable.
 * 
 * @author Ali Mehregani
 */
public interface IMacroInstruction extends IPersistable, IPlayable {

	/**
	 * Returns the starting line number of this macro instruction in the macro script that it belongs to.
	 * 
	 * @return The starting line
	 */
	public int getStartLine();

	/**
	 * Returns the last line number of this macro instruction in the macro script that it belongs to.
	 * 
	 * @return The last line
	 */
	public int getStopLine();
}




/*******************************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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
 * $Id: NonTrivialUIObjectResolverDelegate.java,v 1.4 2007/05/02 19:35:58 paules Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate;

import java.util.Vector;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.hyades.models.hierarchy.TRCAgentProxy;
import org.eclipse.jface.action.ActionContributionItem;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.action.IContributionItem;
import org.eclipse.jface.window.Window;
import org.eclipse.jface.wizard.IWizardPage;
import org.eclipse.jface.wizard.WizardDialog;
import org.eclipse.swt.custom.CCombo;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.CTabItem;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Item;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.TabFolder;
import org.eclipse.swt.widgets.TabItem;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.PrimitiveUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.UIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.WeightedPropertyUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.UIObjectResolver;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.deresolvingsupport.IUIObjectDeprecatedDeresolvingFacade;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.deresolvingsupport.UIObjectDeprecatedDeresolvingSupport;
import org.eclipse.tptp.trace.ui.internal.launcher.core.AnalysisType;
import org.eclipse.tptp.trace.ui.internal.launcher.core.DataCollectorTreeContentProvider.ParentChildNode;
import org.eclipse.ui.IPluginContribution;
import org.eclipse.ui.IViewPart;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.dialogs.FileSystemElement;
import org.eclipse.ui.model.IWorkbenchAdapter;
import org.eclipse.ui.views.IViewCategory;

/**
 * <p>
 * The purpose of this class is to resolve widgets that cannot be resolved using
 * the AdaptiveUIObjectResolverDelegate. These widgets will likely require
 * nested calls in order to be determined.
 * </p>
 * <p>
 * Some of the properties used to resolve a widget are locale dependent (e.g.
 * the name of a button or the closest label to a text box)
 * </p>
 * 
 * @since 4.1
 * @author Ali Mehregani
 * @author Alexander Nyssen
 */
public class NonTrivialUIObjectResolverDelegate implements
		IUIObjectResolverDelegate, IUIObjectDeprecatedDeresolvingFacade {

	/**
	 * The id of this resolver -- must be in sync with the id registered with
	 * the widgetResolver extension.
	 */
	public static final String ID = "org.eclipse.tptp.test.auto.gui.nontrivial";

	public IUIObjectIdentifier resolve(Object context, IUIObject uiObject)
			throws CoreException {
		Widget widget = uiObject.getWidget();
		Object object = uiObject.getObject();

		Object data = widget.getData();

		IUIObjectIdentifier widgetId = null;

		/* Resolve the object based on the data type of the widget */
		/* An agent */
		if (data instanceof TRCAgentProxy) {
			widgetId = resolveAgentProxy(widget);
		}
		/* A file system element */
		else if (data instanceof FileSystemElement) {
			widgetId = resolveFileSystemElement(widget);
		}
		/* A view catgory */
		else if (data instanceof IViewCategory) {
			String id = ((IViewCategory) data).getId();
			if (id != null && id.length() > 0) {
				widgetId = new PrimitiveUIObjectIdentifier(id, ID);
			}
		}
		/* Analysis type */
		else if (data instanceof ParentChildNode) {
			Object child = ((ParentChildNode) data).child;
			if (child instanceof AnalysisType) {
				widgetId = resolveAnalysisType((AnalysisType) child);
			}
		}
		/* A menu item or a tree item */
		else if (widget instanceof MenuItem || widget instanceof TreeItem) {
			widgetId = resolveItem((Item) widget);
		}
		/* A TabItem or CTabItem */
		else if (widget instanceof TabItem || widget instanceof CTabItem) {
			String itemText = validateText(widget instanceof TabItem ? ((TabItem) widget)
					.getText()
					: ((CTabItem) widget).getText());
			widgetId = itemText != null ? new PrimitiveUIObjectIdentifier(
					itemText, ID) : null;
		}
		/* A tool item */
		else if (widget instanceof ToolItem) {
			widgetId = resolveToolbarItem((ToolItem) widget);
		}
		/* A menu (added by ANy) */
		else if (widget instanceof Menu) {
			widgetId = getActionId((Menu) widget);
		}
		// controls
		else if (widget instanceof Control) {
			/* A button */
			if (widget instanceof Button) {
				widgetId = resolveButton((Button) widget);
			}
			/* A text box */
			else if (widget instanceof Text) {
				widgetId = resolveText((Text) widget);
			}
			/* A toolbar */
			else if (widget instanceof ToolBar) {
				widgetId = resolveToolBar((ToolBar) widget);
			}
			/* Resolve the object based on its widget type */
			/* A control (added by ANy) */
			else if (widget instanceof Shell) {
				widgetId = getShellId((Shell) widget);
			}

			if (widgetId == null) {
				Control control = (Control) widget;
				Shell shell = control.getShell();
				Object shellData = shell.getData();
				if (shellData instanceof WizardDialog) {
					// in wizard
					WizardDialog wd = (WizardDialog) shellData;
					IWizardPage page = wd.getCurrentPage();
					Control pageControl = page.getControl();
					widgetId = computeRelativePath((Composite) pageControl,
							null, control);
					if (widgetId == null) {
						// check for wizard buttons
						if (control instanceof Button) {
							widgetId = computeRelativePath(shell,
									(Composite) pageControl, control);
						}
					}
				} else if (shellData instanceof IWorkbenchWindow) {

					IWorkbenchWindow window = (IWorkbenchWindow) shellData;
					IWorkbenchPage page = window.getActivePage();
					IWorkbenchPart part = page.getActivePart();

					Composite paneComposite = MacroUtil
							.getWorkbenchPartControl(part);

					/*
					 * If the control we are looking for is a local tool bar, go
					 * up one level
					 */
					if (part instanceof IViewPart && control instanceof ToolBar) {
						paneComposite = paneComposite.getParent();
					}
					widgetId = computeRelativePath(paneComposite, null, control);					
				} else {
					/* unknown shell - fetch controls starting from the shell */
					widgetId = computeRelativePath(shell, null, control);
				}

				// ANy: in case we have items on a combo box or tab folder
				if (uiObject.getObject() != null && (widget instanceof Combo
						|| widget instanceof CCombo)) {

					widgetId = new PrimitiveUIObjectIdentifier(widgetId
							.getWidgetId(), computeDefaultChoiceId(widget,
							uiObject.getObject()).toString(), ID);
				}
			}
		}

		/*
		 * (added by ANy) Defect #: 112668: If we have to resolve an Item try
		 * the old policy before giving up
		 */
		if (widgetId == null && widget instanceof Item) {
			widgetId = determineItemId((Item) widget);
		}

		return widgetId;
	}

	public IUIObject deresolve(Object context,
			IUIObjectIdentifier uiObjectIdentifier) throws CoreException {
		return UIObjectDeprecatedDeresolvingSupport.deresolve(context,
				uiObjectIdentifier);
	}

	private IUIObjectIdentifier resolveAnalysisType(AnalysisType analysisType) {
		Object[] properties = { new Object[] { analysisType.getId(), "1.0" }, };

		return WeightedPropertyUIObjectIdentifier.constructId(properties,
				(float) 1.0, ID);
	}

	private IUIObjectIdentifier resolveToolBar(ToolBar toolbar) {
		int itemCount = toolbar.getItemCount();
		String firstItem = itemCount > 1 ? limitText(toolbar.getItem(0)
				.getToolTipText()) : null, lastItem = itemCount > 2 ? limitText(toolbar
				.getItem(itemCount - 1).getToolTipText())
				: null;
		int style = toolbar.getStyle();

		if (firstItem == null && lastItem == null)
			return null;

		Object[] properties = { new Object[] { firstItem, "0.5" },
				new Object[] { lastItem, "0.5" },
				new Object[] { String.valueOf(itemCount), "0.3" },
				new Object[] { String.valueOf(style), "0.2" } };

		return WeightedPropertyUIObjectIdentifier.constructId(properties,
				(float) 1.0, ID);
	}

	private IUIObjectIdentifier resolveToolbarItem(ToolItem item) {
		String text = limitText(item.getToolTipText());
		String actionId = getActionId(item).toString();
		String style = String.valueOf(item.getStyle());

		Object[] properties = { new Object[] { text, "0.7" },
				new Object[] { actionId, "0.7" }, new Object[] { style, "0.3" } };

		return WeightedPropertyUIObjectIdentifier.constructId(properties,
				(float) 1.0, ID);
	}

	private String limitText(String str) {
		final int MAX_HOVER_TEXT_SIZE = 20;
		if (str != null && str.length() > MAX_HOVER_TEXT_SIZE) {
			return str.substring(0, MAX_HOVER_TEXT_SIZE) + "...";
		}
		return str;
	}

	/*
	 * Needed to find buttons, which are identified by a deprecated identifier
	 * format
	 */
	private IUIObjectIdentifier resolveButtonDeprecated(Button button,
			IUIObjectIdentifier id) {
		String text = null, hoverText = null, size = null, location = null;
		if ((text = button.getText()) != null) {
			text = text.replaceAll("\\&", "");
		}
		/* First 20 characters of the hover text */
		hoverText = limitText(button.getToolTipText());
		Point sizePt = button.getSize();
		Point locationPt = button.getLocation();
		size = "(" + sizePt.x + "," + sizePt.y + ")";

		if (id != null && countTokens(id.toString()) == 3) {

			Object[] properties = { new Object[] { text, "0.5" },
					new Object[] { hoverText, "0.5" },
					new Object[] { size, "0.5" } };

			return WeightedPropertyUIObjectIdentifier.constructId(properties,
					(float) 1.0, ID);
		}
		return null;
	}

	private IUIObjectIdentifier resolveButton(Button button) {
		String text = null, hoverText = null, size = null, location = null;
		if ((text = button.getText()) != null) {
			text = text.replaceAll("\\&", "");
		}
		/* First 20 characters of the hover text */
		hoverText = limitText(button.getToolTipText());
		Point sizePt = button.getSize();
		Point locationPt = button.getLocation();
		size = "(" + sizePt.x + "," + sizePt.y + ")";
		location = "(" + locationPt.x + "," + locationPt.y + ")";

		if (button.getParent() != null) {
			// Control[] children = ((Composite)parent).getChildren();
			Control[] children = button.getParent().getChildren();
			int buttonInx = 0;

			/* Find the index of the button */
			for (int i = 0; i < children.length; i++) {
				if (button == children[i]) {
					buttonInx = i;
					break;
				}
			}

			Object[] properties = { new Object[] { text, "0.3" },
					new Object[] { hoverText, "0.3" },
					new Object[] { String.valueOf(children.length), "0.3" },
					new Object[] { size, "0.2" },
					new Object[] { location, "0.1" },
					new Object[] { String.valueOf(buttonInx), "0.2" }, };

			float threshold = 0.7f;
			threshold += text != null ? 0.3 : 0;
			threshold += hoverText != null ? 0.3 : 0;

			if (threshold >= 1.0)
				return WeightedPropertyUIObjectIdentifier.constructId(
						properties, (float) 1.0, ID);
		}

		return null;
	}

	/**
	 * The text of the closest label to a text box is used as a unique
	 * identifier of the text box. The label must be in a limited vicinity of
	 * the text box for its text to be considered as an identifier. If the text
	 * box is owned by a group and the group only owns one text box, then the
	 * group text is used to identify the widget.
	 * 
	 * @param text
	 *            The text box
	 * @return The widget id for text
	 */
	private IUIObjectIdentifier resolveText(Text text) {
		Composite parent = text.getParent();
		Control[] children = parent.getChildren();

		String groupText = null;
		if (parent instanceof Group
				&& (groupText = ((Group) parent).getText()) != null
				&& (groupText = groupText.replaceAll("\\&", "")).length() > 0) {
			int textBoxNum = 0;
			for (int i = 0; i < children.length && textBoxNum <= 1; i++) {
				if (children[i] instanceof Text)
					textBoxNum++;
			}

			if (textBoxNum <= 1)
				return new PrimitiveUIObjectIdentifier(groupText, ID);
		}

		Label closestLabel = null;
		Point textLocation = text.getLocation();
		Point currentDistance = new Point(0, 0);
		Point tempDistance = new Point(0, 0);
		for (int i = 0; i < children.length; i++) {
			Point childLocation = children[i].getLocation();
			if (children[i] instanceof Label
					&& (closestLabel == null || (tempDistance = isLabelCloser(
							childLocation, currentDistance, textLocation)) != null)) {
				boolean firstLabel = closestLabel == null;
				closestLabel = (Label) children[i];
				;
				if (firstLabel) {
					currentDistance = new Point(Math.abs(childLocation.x
							- textLocation.x), Math.abs(childLocation.y
							- textLocation.y));
				} else {
					currentDistance = tempDistance;
				}
			}
		}

		String closestLabelText = null;
		if (closestLabel != null
				&& currentDistance.x + currentDistance.y <= 100
				&& closestLabel.getText() != null
				&& (closestLabelText = closestLabel.getText().replaceAll("\\&",
						"")).length() > 0)
			return new PrimitiveUIObjectIdentifier(closestLabelText, ID);
		return null;
	}

	private Point isLabelCloser(Point newlblLocation, Point currentDistance,
			Point textLocation) {
		Point tempLocation = new Point(Math.abs(newlblLocation.x
				- textLocation.x), Math.abs(newlblLocation.y - textLocation.y));
		if (tempLocation.x + tempLocation.y < currentDistance.x
				+ currentDistance.y)
			return tempLocation;
		return null;
	}

	public static String validateText(String text) {
		if (text != null && (text = text.replaceAll("\\&", "")).length() > 0)
			return text;
		return null;
	}

	/**
	 * Computes the item id based on the following properties and weights. The
	 * threshold is set to 1.0:
	 * 
	 * <ul>
	 * <li> (Descriptive name of the item, 1.0) </li>
	 * </ul>
	 * 
	 * @param item
	 *            The item
	 * @return The weighted id
	 */
	private IUIObjectIdentifier resolveItem(Item item) {
		StringBuffer descriptiveText = new StringBuffer();
		findItemText(item, descriptiveText);

		/* Remove the ampersands */
		String itemText = descriptiveText.toString().replaceAll("\\&", "");

		Object[] properties = { new Object[] { itemText, "1.0" }, };

		return WeightedPropertyUIObjectIdentifier.constructId(properties,
				(float) 1.0, ID);
	}

	/**
	 * Walk through the item and return a descriptive text that corresponds to
	 * all item selections leading to the item. (e.g. File-New-Project)
	 * 
	 * @param item
	 *            The item
	 * @param descriptiveText
	 *            In the end, this buffer will contain a descriptive text of all
	 *            items leading to the item that is passed in as argument
	 */
	private void findItemText(Item item, StringBuffer descriptiveText) {
		if (item == null)
			return;

		String descriptiveTextStr = item.getText();
		if (descriptiveText.length() > 0)
			descriptiveTextStr += "-";

		descriptiveText.insert(0, descriptiveTextStr);

		Item parentItem = null;
		if (item instanceof MenuItem) {
			Menu menu = ((MenuItem) item).getParent();
			parentItem = (menu == null ? null : menu.getParentItem());
		} else if (item instanceof TreeItem) {
			parentItem = ((TreeItem) item).getParentItem();
		}

		if (parentItem != null)
			findItemText(parentItem, descriptiveText);
	}

	private IUIObjectIdentifier resolveFileSystemElement(Widget widget) {

		FileSystemElement fileSystemElement = (FileSystemElement) widget
				.getData();
		if (fileSystemElement.isDirectory())
			return null;

		Object[] properties = { new Object[] {
				((IWorkbenchAdapter) fileSystemElement
						.getAdapter(IWorkbenchAdapter.class)).getLabel(null),
				"1.0" } };

		return WeightedPropertyUIObjectIdentifier.constructId(properties,
				(float) 1.0, ID);
	}

	private WeightedPropertyUIObjectIdentifier resolveAgentProxy(Widget widget) {
		StringBuffer treeIndex = new StringBuffer();
		if (widget instanceof TreeItem)
			findTreeItemIndex((TreeItem) widget, treeIndex);
		else
			return null;

		TRCAgentProxy proxy = (TRCAgentProxy) widget.getData();
		Object[] properties = {
				new Object[] { treeIndex.toString(), "0.4" },
				new Object[] { proxy.getProcessProxy().getName(), "0.2" },
				new Object[] { proxy.getProcessProxy().getVmArguments(), "0.1" },
				new Object[] { proxy.getProcessProxy().getClasspath(), "0.1" },
				new Object[] { proxy.getProcessProxy().getLocation(), "0.1" },
				new Object[] { proxy.getProcessProxy().getParameters(), "0.1" },
				new Object[] { proxy.getProfileFile(), "0.1" },
				new Object[] { proxy.getName(), "0.1" },
				new Object[] { String.valueOf(proxy.isAttached()), "0.1" },
				new Object[] { String.valueOf(proxy.isMonitored()), "0.1" },
				new Object[] { String.valueOf(proxy.isToProfileFile()), "0.1" }, };

		return WeightedPropertyUIObjectIdentifier.constructId(properties,
				(float) 0.7, ID);
	}

	private void findTreeItemIndex(TreeItem treeItem, StringBuffer sb) {
		TreeItem parentItem = treeItem.getParentItem();
		if (parentItem != null) {
			int index = parentItem.indexOf(treeItem);
			if (index != -1)
				sb.append("|" + String.valueOf(index + 1));

			findTreeItemIndex(parentItem, sb);
		}
		Tree tree = treeItem.getParent();
		int index = tree.indexOf(treeItem);
		if (index != -1)
			sb.append("|" + String.valueOf(index));

	}

	/**
	 * @deprecated This can be removed the resolver does not longer depend on
	 *             the UIDeprecatedDeresolvingSupport to deresolve UI objects.
	 *             {@inheritDoc}
	 * @see org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.deresolvingsupport.internal.uiobject.resolver.delegate.IUIObjectDeprecatedDeresolvingFacade#foundWidget(org.eclipse.swt.widgets.Widget,
	 *      org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier)
	 */
	public boolean foundWidget(Widget widget, IUIObjectIdentifier widgetId) {
		IUIObjectIdentifier objectId = null;

		// ANy: It seems that the resolving for buttons was changed. For
		// backwards compatibility,
		// the foundWidget has to accept the old button identifier format as
		// well.
		if (widget instanceof Button) {
			Button button = (Button) widget;
			objectId = resolveButtonDeprecated(button, widgetId);
		}

		if (objectId == null)
			try {
				objectId = UIObjectResolver.resolve(new MacroObject(
						new UIObject(widget)).getContext(),
						new UIObject(widget));
			} catch (Exception e) {
				e.printStackTrace();
			}
		if (widgetId == null || widgetId.getWidgetId() == null) {
			return false;
		} else {
			if (objectId == null) {
				return false;
			} else {
				return objectId.equals(widgetId);
			}
		}
	}

	/**
	 * Given a string representation of the id, this method will return the
	 * number of tokens that it contains. A token is a name, value pair in the
	 * format.
	 * 
	 * @param id
	 *            The string representation of the id
	 * @return The number of tokens of the id
	 */
	public static int countTokens(String id) {
		if (id == null)
			return 0;

		char[] characters = id.toCharArray();
		boolean braceInxHit = false;
		int tokenCount = 0;
		for (int i = 0; i < characters.length; i++) {
			if (characters[i] == '{') {
				if (braceInxHit) {
					tokenCount++;
				} else {
					braceInxHit = true;
					continue;
				}
			}
			braceInxHit = false;
		}

		return tokenCount / 2;
	}

	/**
	 * Defect #: 112668 This method is invoked to retrieve the id of a menu
	 * item. Here's the policy that it employs:
	 * <ol>
	 * <li> Use the contributed widget resolvers </li>
	 * <li> If failed, default to what was being used before </li>
	 * </ol>
	 * 
	 * @param item
	 *            The menu item
	 * @return The id of the passed item.
	 */
	private IUIObjectIdentifier determineItemId(Item item) {
		if (item instanceof ToolItem) {
			return getActionId((ToolItem) item);
		} else if (item instanceof MenuItem) {
			return getActionId((MenuItem) item);
		} else if (item instanceof IContributionItem) {
			return getActionId((IContributionItem) item);
		}
		return null;
	}

	/**
	 * @param widget
	 * @return
	 */
	public static IUIObjectIdentifier getActionId(Widget widget) {
		Object data = widget.getData();
		PrimitiveUIObjectIdentifier widgetId = null;
		if (data != null && (data instanceof IContributionItem)) {
			widgetId = getActionId((IContributionItem) data);
			if (widgetId != null
					&& !widgetId.toString().equals(MacroConstants.EMPTY_STRING)) {
				if (widget instanceof MenuItem) {
					String menuInx = findMenuItemIndex((MenuItem) widget, "");
					widgetId = new PrimitiveUIObjectIdentifier(widgetId
							.toString()
							+ menuInx, ID);
				}
			}
		} else {
			widgetId = new PrimitiveUIObjectIdentifier(
					"readablename/" + ((widget instanceof MenuItem) ? getDisplayName((MenuItem) widget) : getDisplayName((ToolItem) widget)), ID); //$NON-NLS-1$
		}

		return widgetId;
	}

	public static PrimitiveUIObjectIdentifier getActionId(
			IContributionItem contrib) {
		String id = null;
		PrimitiveUIObjectIdentifier widgetId = null;

		if (contrib instanceof IPluginContribution) {
			id = ((IPluginContribution) contrib).getLocalId();
		}
		id = id == null ? contrib.getId() : id;
		if (id != null) {
			widgetId = new PrimitiveUIObjectIdentifier("contribid/" + id, ID); //$NON-NLS-1$
		} else {
			if (contrib instanceof ActionContributionItem) {
				ActionContributionItem actionItem = (ActionContributionItem) contrib;
				id = actionItem.getId();
				if (id != null) {
					widgetId = new PrimitiveUIObjectIdentifier(
							"actionid/" + id, ID); //$NON-NLS-1$
				} else {
					IAction action = actionItem.getAction();
					id = action.getActionDefinitionId();
					if (id != null) {
						widgetId = new PrimitiveUIObjectIdentifier(
								"defid/" + id, ID); //$NON-NLS-1$
					} else {
						widgetId = new PrimitiveUIObjectIdentifier(
								"actionclass/" + action.getClass().getName(), ID); //$NON-NLS-1$
					}
				}
			} else {
				widgetId = new PrimitiveUIObjectIdentifier(
						"contribclass/" + contrib.getClass().getName(), ID); //$NON-NLS-1$				
			}
		}

		return widgetId;
	}

	/**
	 * @deprecated Should not be done here, but in the delegators Walks through
	 *             all parent menus of the menuItem and returns an index of
	 *             format &lt;num&gt;|&lt;num&gt;|&lt;num&gt;|... For example
	 *             assuming menuItem is placed as follows:
	 * 
	 * item 1 |_item 2 | |_item 4 |_item 3 |_menuItem
	 * 
	 * then its respective index will be 1|2|1
	 * 
	 * @param menuItem
	 *            The menu item whose index will be determined
	 * @return The index of the menu item as described above.
	 */
	private static String findMenuItemIndex(MenuItem menuItem, String menuInx) {
		if (menuItem == null)
			return menuInx;

		if (menuInx.length() > 0)
			menuInx = "|" + menuInx;
		menuInx = menuItem.getParent().indexOf(menuItem) + menuInx;
		return findMenuItemIndex(menuItem.getParent().getParentItem(), menuInx);
	}

	/**
	 * Returns an identifier for the given Menu, based on its user-readable
	 * strings
	 * 
	 * @param menu
	 * @return
	 */
	private static String getDisplayName(Menu menu) {

		MenuItem parentItem = menu.getParentItem();

		if (parentItem == null) {
			return MacroConstants.EMPTY_STRING;
		}

		return getDisplayName(parentItem);
	}

	/**
	 * Returns an identifier for the given MenuItem, based on its user-readable
	 * strings
	 * 
	 * @param menuItem
	 * @return
	 */
	private static String getDisplayName(MenuItem menuItem) {
		if (menuItem.getParent() == null
				|| menuItem.getParent().getParentItem() == null) {
			return MacroUtil.removeChar(menuItem.getText(), '&');
		}

		return getDisplayName(menuItem.getParent()) + "/" //$NON-NLS-1$
				+ MacroUtil.removeChar(menuItem.getText(), '&');
	}

	/**
	 * @param toolItem
	 * @return
	 */
	private static String getDisplayName(ToolItem toolItem) {
		String name = toolItem.getText();

		if (name != null && !name.equals(MacroConstants.EMPTY_STRING)) {
			return name;
		}

		name = toolItem.getToolTipText();

		if (name != null) {
			return name;
		}

		return "unknown"; //$NON-NLS-1$
	}

	/**
	 * @deprecated Use resolveUIObject instead (move implementation there)
	 * @param context
	 * @param parent
	 * @param skip
	 * @param control
	 * @return
	 */
	public static IUIObjectIdentifier computeRelativePath(Composite parent,
			Composite skip, Control control) {
		int[] counter = MacroUtil.newCounter();
		Vector indices = new Vector();
		boolean result = computeControlIndex(parent, skip, control, counter,
				indices);
		if (!result && skip == null)
			return null;

		int index = result ? ((Integer) indices.get(0)).intValue() : 0;
		return computeDefaultControlId(control, index);
	}

	/**
	 * Determines the index of the desiredControl relative to the parent control
	 * sent in. The Index is stored in index[0].
	 * 
	 * @param parent
	 *            The parent control
	 * @param skip
	 *            Indicates whether a composite should be skipped
	 * @param desiredControl
	 *            The desired control
	 * @param index
	 *            The current index calculated thus far (stored in index[0]. The
	 *            type of this parameter is an int array because its value needs
	 *            to be preserved between recursive calls.
	 * 
	 * @return true if the index was found; false otherwise.
	 */
	private static boolean computeControlIndex(Composite parent,
			Composite skip, Control desiredControl, int[] index, Vector indices) {
		return UIObjectDeprecatedDeresolvingSupport.recursiveSearch(parent,
				skip, desiredControl, null, null, index, new Vector(), indices) != null;
	}

	public static IUIObjectIdentifier computeDefaultControlId(Control control,
			int controlIndex) {
		PrimitiveUIObjectIdentifier primitiveWidgetId = new PrimitiveUIObjectIdentifier(
				control.getClass().getName() + "#" + controlIndex, ID);
		return primitiveWidgetId;
	}

	/**
	 * Moved here from ChoiceCommand
	 * 
	 * @param widget
	 * @param item
	 * @return
	 */
	private IUIObjectIdentifier computeDefaultChoiceId(Widget widget,
			Object item) {
		int index = -1;
		boolean isCombo = widget instanceof Combo;
		boolean isCCombo = isCombo ? false : widget instanceof CCombo;
		if (isCombo || isCCombo) {
			Combo combo = isCombo ? ((Combo) widget) : null;
			CCombo ccombo = isCCombo ? ((CCombo) widget) : null;

			index = isCombo ? combo.indexOf((String) item) : ccombo
					.indexOf((String) item);
		} else {
			boolean isTabFolder = widget instanceof TabFolder;
			boolean isCTabFolder = isTabFolder ? false
					: widget instanceof CTabFolder;
			if (isTabFolder || isCTabFolder) {
				index = isTabFolder ? ((TabFolder) widget)
						.indexOf((TabItem) item) : ((CTabFolder) widget)
						.indexOf((CTabItem) item);
			}
		}

		if (index != -1)
			return new PrimitiveUIObjectIdentifier("item#" + index, ID);
		return null;
	}

	private static IUIObjectIdentifier getShellId(Shell shell) {
		return getDefaultShellId(shell);
	}

	private static IUIObjectIdentifier getDefaultShellId(Shell shell) {
		Object data = shell.getData();
		String id = "";
		if (data instanceof WizardDialog) {
			id = data.getClass().getName().toString();
		} else if (data instanceof Window) {
			id = data.getClass().getName().toString();
		}

		PrimitiveUIObjectIdentifier widgetId = new PrimitiveUIObjectIdentifier(
				id, ID);
		return widgetId;
	}
}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.commands.factory;

import java.util.ArrayList;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.Path;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CCombo;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.List;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.TabFolder;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.commands.AbstractMacroCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.BooleanSelectionCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.CheckCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.ChoiceSelectionCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.CloseWorkbenchPartCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.ExpansionCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.FocusCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.IMacroCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.KeyEventCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.ModifyCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.MouseEventCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.ObjectBasedCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.StructuredSelectionCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.VerificationCommand;
import org.eclipse.tptp.test.auto.gui.internal.commands.WaitCommand;
import org.eclipse.tptp.test.auto.gui.internal.macro.EventConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObject;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.resolver.MacroObjectResolver;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.UIObject;

/**
 * @author Alexander Nyssen
 * 
 */
public class MacroCommandFactory implements IMacroCommandFactory {

	/* The last event received */
	protected transient Event lastEvent;

	/* Indicates user interaction -- Set when a key up event is received */
	protected transient boolean isKeyPressed;

	/* Indicates user interaction -- Set when a mouse up event is received */
	protected transient boolean isMousePressed;

	/* Stores an event that is only acknowledged followed by user interaction. */
	protected transient Event toBeAckEvent;

	/* Set when the stored event in toBeAckEvent is acknowledged */
	protected transient boolean ackEvent;

	/* Stores the time for which a command was last created in */
	protected long lastCommandCreationTime;

	public IMacroCommand createCommand(MacroCommandShell commandShell,
			ArrayList commands, Event event) throws CoreException {

		// see if we can merge the event with the last created command
		AbstractMacroCommand lastCommand = getLastCommand(commands);
		if (lastEvent != null
				&& (lastEvent.detail == EventConstants.EVENT_DETAIL__POSITION_BASED_EVENT || (lastEvent.widget != null
						&& lastEvent.widget.equals(event.widget) && (lastEvent.type == event.type || (lastEvent.type == SWT.Selection && event.type == SWT.DefaultSelection))))) {
			try {
				if (lastCommand != null && lastCommand.mergeEvent(event)) {
					return null;
				}
			} catch (Exception e) {
				// simply continue (the last command could not merge the
				// event)
			}
		}

		AbstractMacroCommand command = null;
		if (event.detail == EventConstants.EVENT_DETAIL__POSITION_BASED_EVENT)
			command = createPositionBasedCommand(commandShell, event);
		else if (event.detail == EventConstants.EVENT_DETAIL__VERIFICATION_HOOK_INSERTION_EVENT) {
			command = createVerificationHookInsertionCommand(commandShell,
					event);
		} else {
			command = createObjectBasedCommand(commandShell, commands, event);
		}

		if (command != null) {
			/*
			 * Take out the last command if it is a focus command and the
			 * command just passed in implicitly does a focus
			 */
			if (lastCommand != null
					&& (lastCommand instanceof ObjectBasedCommand
							&& command instanceof ObjectBasedCommand
							&& ((ObjectBasedCommand) lastCommand)
									.getMacroObjectIdentifier()
									.equals(
											((ObjectBasedCommand) command)
													.getMacroObjectIdentifier())
							&& lastCommand.getType().equals(FocusCommand.TYPE) && isFocusCommand(command
							.getType()))) {
				// focus followed by select or modify - focus implied
				commands.remove(lastCommand);
			}

			/* Modify the last event accordinggly */
			if (ackEvent) {
				ackEvent = false;
				lastEvent = toBeAckEvent;
				toBeAckEvent = null;
			} else {
				lastEvent = event;
			}

			/* Add the artificial wait time if required */
			if (MacroManager.getInstance().isArtificialWaitOn()
					&& lastCommandCreationTime > 0) {
				long currentTime = System.currentTimeMillis();
				long difference = currentTime - lastCommandCreationTime;
				command.setTimeDifference(difference);
			}

			lastCommandCreationTime = System.currentTimeMillis();

			/*
			 * Ali M.: The following block of code provides a workaround for a
			 * limitation that exists for CloseWorkbenchPartCommand. We are only
			 * able to capture this event after the entire part has been
			 * disposed. Things would be ideal if this event could be captured
			 * right after the user clicks on the close button of the part
			 */
			if (command instanceof CloseWorkbenchPartCommand) {
				int commandSize = commands.size();
				if (commandSize > 0) {
					/*
					 * If the last command corresponds to the message dialog
					 * that prompts the user to save an editor, then store it
					 * after the close command
					 * 
					 * ANy: Since Eclipse 3.4 this does not seem to be a
					 * MessageDialog any more, but a private anonymous Dialog
					 * implementation in org.eclipse.ui.internal.SaveablesList,
					 * so I adopted this here.
					 */
					/* If the last stored command is a shell */
					Object lastCommandStored = commands.get(commandSize - 1);
					if (lastCommandStored instanceof MacroCommandShell
							&&
							/*
							 * If the part is an editor
							 */
							((CloseWorkbenchPartCommand) command)
									.getMacroObjectIdentifier()
									.getContextIdentifier().equals(
											MacroConstants.EDITOR_VALUE)
							&&
							/*
							 * If the shell is a MessageDialog or it is a
							 * private dialog inside the SaveablesList (Eclipse
							 * 3.4)
							 */
							(((MacroCommandShell) lastCommandStored)
									.getMacroObjectIdentifier()
									.getObjectIdentifier().getWidgetId()
									.startsWith("org.eclipse.ui.internal.SaveablesList"))
							|| ((MacroCommandShell) lastCommandStored)
									.getMacroObjectIdentifier()
									.getObjectIdentifier().getWidgetId()
									.equals(MessageDialog.class.getName()))

					{
						commands.add(commandSize - 1, command);
					}

				}

			} else {
				/*
				 * Added for defect 164197 in order to add an item-expansion to
				 * the parent whenever the child is selected in a case where the
				 * parent has been pre-expanded. Liz D.
				 */
				if (command instanceof StructuredSelectionCommand
						&& event.widget instanceof Tree) {
					StructuredSelectionCommand s = (StructuredSelectionCommand) command;

					TreeItem[] items = (TreeItem[]) s.getItemsForEvent(event);
					for (int i = 0; i < items.length; i++) {
						TreeItem selectedItem = (TreeItem) items[i];

						while (selectedItem.getParentItem() != null) {
							TreeItem parent = selectedItem.getParentItem();
							if (parent.getExpanded() == true) {// necessary so
								// that
								// we only apply
								// this in the case
								// where the parent
								// is already
								// expanded
								Event expansionEvent = new Event();
								expansionEvent.widget = parent;
								expansionEvent.item = parent;
								ExpansionCommand parentExpand = new ExpansionCommand(
										commandShell, s
												.getMacroObjectIdentifier());
								parentExpand.doProcessEvent(expansionEvent,
										true);
								commands.add(parentExpand);
							}
							selectedItem = parent;
						}// end while
					}
				}

				// add the command at the end of the list
				commands.add(command);
			}
		}
		return command;
	}

	/**
	 * Handles object-based events
	 */
	protected AbstractMacroCommand createObjectBasedCommand(
			MacroCommandShell commandShell, ArrayList commands, Event event) {
		/*
		 * A quick way to get out if we're only getting key up or mouse events
		 * that have been detected before
		 */
		if ((isKeyPressed && event.type == SWT.KeyUp)
				|| (isMousePressed && event.type == SWT.MouseUp))
			return null;

		ObjectBasedCommand command = null;

		/* Check to see if we are a drop-down menu selection */
		AbstractMacroCommand lastCommand = getLastCommand(commands);
		if (lastCommand != null
				&& lastCommand.getType() == BooleanSelectionCommand.TYPE
				&& ((BooleanSelectionCommand) lastCommand).getDetail() == SWT.DROP_DOWN) {
			((BooleanSelectionCommand) lastCommand).setItemSelected(event);
			return null;
		}

		if (event.type == EventConstants.EVENT_TYPE__WORKBENCH_PART_CLOSED) {
			/*
			 * 110810 -- Create the close workbench command only if there is
			 * only one frame in our shell stack
			 */
			if (MacroManager.getInstance().getCurrentMacro()
					.getShellStackSize() == 1) {
				command = new CloseWorkbenchPartCommand(commandShell);
			}
		} else {
			// process standard SWT event types
			switch (event.type) {
			case SWT.Modify:
				if (!isEditable(event.widget))
					return null;

				/*
				 * This block of code is used to avoid displaying the browse
				 * native dialog when the user clicks a browse button - it
				 * doesn't cover all cases
				 */
				// ANy: Added check that button is not disposed
				if (lastEvent != null && lastEvent.type == SWT.Selection
						&& lastEvent.widget instanceof Button
						&& !lastEvent.widget.isDisposed()) {
					String text = ((Button) lastEvent.widget).getText();
					if (text != null) {
						text = text.replaceAll("\\&", "");
						text = text.toLowerCase();
						if (text
								.indexOf(AutoGUIMessages.AUTO_GUI_CONTROL_STATUS_BROWSE) != -1) {
							int size = 0;
							if (commands != null
									&& (size = commands.size()) > 0) {
								commands.remove(size - 1);
								command = new ModifyCommand(commandShell);
								break;
							}
						}
					}
				}

				/* Only acknowledge modifies that are followed by a key up event */
				toBeAckEvent = event;
				break;

			case SWT.Selection:
			case SWT.DefaultSelection:
				command = createSelectionCommand(commandShell, event);
				break;

			case SWT.FocusIn:
				/**
				 * Ali M.: While recording, the SWT display listener has the
				 * tendency to report focus events on controls that are actually
				 * not visible to the user. When the macro is played back, the
				 * control cannot be located. To avoid this problem we only
				 * acknowledge focus events that are followed by a mouse up or
				 * key up event (i.e. The user explicitly focuses on the
				 * control).
				 */
				toBeAckEvent = event;
				break;

			case SWT.Expand:
			case SWT.Collapse:
				command = new ExpansionCommand(commandShell);
				break;

			case SWT.KeyUp:
				isKeyPressed = true;
				if (toBeAckEvent != null && toBeAckEvent.type == SWT.Modify) {
					command = new ModifyCommand(commandShell);
					ackEvent = true;
				} else if (toBeAckEvent != null
						&& toBeAckEvent.type == SWT.FocusIn) {
					command = new FocusCommand(commandShell);
					ackEvent = true;
				}
				break;

			case SWT.MouseUp:
				isMousePressed = true;
				if (toBeAckEvent != null && toBeAckEvent.type == SWT.FocusIn) {
					command = new FocusCommand(commandShell);
					ackEvent = true;
				}
				break;
			}
		}

		if (event.type != SWT.KeyUp)
			isKeyPressed = false;
		if (event.type != SWT.MouseUp)
			isMousePressed = false;

		if (command != null) {
			try {
				if (ackEvent) {
					command.processEvent(toBeAckEvent);
				} else {
					command.processEvent(event);
				}
			} catch (Exception e) {
				e.printStackTrace();
				command = null;
			}
		}

		/* Ensure that redundant commands are not created */
		if (lastCommand != null && command != null
				&& command.isRepeatRedundant() && command.equals(lastCommand)) {
			return null;
		}
		return command;
	}

	/**
	 * Handles position-based events
	 */
	protected AbstractMacroCommand createPositionBasedCommand(
			MacroCommandShell commandShell, Event event) {
		AbstractMacroCommand command = null;

		switch (event.type) {
		case SWT.MouseUp:
		case SWT.MouseDown:
		case SWT.MouseMove:
		case SWT.MouseDoubleClick:
			command = new MouseEventCommand(commandShell);
			break;

		case SWT.KeyUp:
		case SWT.KeyDown:
			command = new KeyEventCommand(commandShell);
			break;

		}

		if (command != null)
			try {
				command.processEvent(event);
			} catch (Exception e) {
				command = null;
			}
		return command;
	}

	protected ObjectBasedCommand createSelectionCommand(
			MacroCommandShell commandShell, Event event) {
		if (event.widget instanceof MenuItem
				|| event.widget instanceof ToolItem
				|| (event.widget instanceof Button
				/*
				 * A CCombo will cause a button selection followed by a combo
				 * selection. We need to ignore the button selection
				 */
				&& !(event.widget instanceof Control && ((Control) event.widget)
						.getParent() instanceof CCombo))) {
			ObjectBasedCommand selectionCommand = new BooleanSelectionCommand(
					commandShell);
			return selectionCommand;
		}

		if (event.widget instanceof Tree || event.widget instanceof Table
				|| event.widget instanceof List) {
			if (event.detail == SWT.CHECK) {
				ObjectBasedCommand selectionCommand = new CheckCommand(
						commandShell);
				return selectionCommand;
			} else {
				String type = event.type == SWT.DefaultSelection ? StructuredSelectionCommand.DEFAULT_SELECT
						: StructuredSelectionCommand.ITEM_SELECT;
				ObjectBasedCommand selectionCommand = new StructuredSelectionCommand(
						commandShell, type);
				return selectionCommand;
			}
		}

		if (event.widget instanceof TabFolder
				|| event.widget instanceof CTabFolder) {
			ObjectBasedCommand selectionCommand = new ChoiceSelectionCommand(
					commandShell);
			return selectionCommand;
		}
		if (event.widget instanceof Combo || event.widget instanceof CCombo) {
			ObjectBasedCommand selectionCommand = new ChoiceSelectionCommand(
					commandShell);
			return selectionCommand;
		}
		return null;
	}

	/**
	 * @param event
	 * @return
	 */
	protected AbstractMacroCommand createVerificationHookInsertionCommand(
			MacroCommandShell commandShell, Event event) throws CoreException {

		VerificationCommand command = null;

		String error = "";

		try {
			/* Ignore all command except for a focus in command */
			switch (event.type) {
			case SWT.Activate:
			case SWT.Selection:
			case SWT.FocusIn:

				IMacroObjectIdentifier widgetID = MacroObjectResolver.resolve(
						commandShell.getShell(), new MacroObject(new UIObject(
								event.widget)));
				String path = (widgetID == null ? "" : new Path(widgetID
						.getContextIdentifier() == null ? "" : widgetID
						.getContextIdentifier())
						.append(
								new Path(widgetID.getObjectIdentifier()
										.getWidgetId() == null ? "" : widgetID
										.getObjectIdentifier().getWidgetId()))
						.toString());

				if (VerificationCommand.findFocusType(path) == -1) {
					error = AutoGUIMessages.AUTO_GUI_ERROR_VER_NOT_SUPP_CON;
					break;
				}

				/* We only acknowledge after there is a mouse up event */
				toBeAckEvent = event;
				break;

			case SWT.MouseUp:

				if (toBeAckEvent == null)
					break;

				/* Create the verification command instance */
				command = new VerificationCommand(commandShell);
				command.processEvent(toBeAckEvent);

				ackEvent = true;
				break;

			default:
				toBeAckEvent = null;
				error = AutoGUIMessages.AUTO_GUI_ERROR_VER_WRONG_EVENT;
			}
		} catch (Exception e) {
			error = e.getMessage();
			e.printStackTrace();
		}

		if (error != null && !(error.equals(""))) {
			AutoGUIUtil.throwCoreException(error);
		}
		return command;
	}

	AbstractMacroCommand getLastCommand(ArrayList commands) {
		if (commands.size() > 0) {
			Object item = commands.get(commands.size() - 1);
			if (item instanceof AbstractMacroCommand)
				return (AbstractMacroCommand) item;
		}
		return null;
	}

	boolean isFocusCommand(String type) {
		return type.equals(BooleanSelectionCommand.TYPE)
				|| type.equals(StructuredSelectionCommand.ITEM_SELECT)
				|| type.equals(StructuredSelectionCommand.DEFAULT_SELECT)
				|| type.equals(ExpansionCommand.TYPE)
				|| type.equals(CheckCommand.TYPE)
				|| type.equals(ModifyCommand.TYPE);
	}

	private boolean isEditable(Widget widget) {
		if (widget instanceof Control) {
			Control control = (Control) widget;
			if (!control.isEnabled())
				return false;
			if (control instanceof Text)
				return ((Text) control).getEditable();
			if (control instanceof Combo || control instanceof CCombo)
				return ((control.getStyle() & SWT.READ_ONLY) == 0);
			if (control instanceof StyledText)
				return ((StyledText) control).getEditable();
		}
		return true;
	}

	public IMacroCommand createCommand(MacroCommandShell commandShell,
			String type) throws CoreException {
		// construct a new command dependent on the type
		AbstractMacroCommand command = null;

		if (type.equals(ModifyCommand.TYPE))
			command = new ModifyCommand(commandShell);

		else if (type.equals(BooleanSelectionCommand.TYPE))
			command = new BooleanSelectionCommand(commandShell);

		else if (type.equals(StructuredSelectionCommand.ITEM_SELECT)
				|| type.equals(StructuredSelectionCommand.DEFAULT_SELECT))
			command = new StructuredSelectionCommand(commandShell, type);

		else if (type.equals(ExpansionCommand.TYPE))
			command = new ExpansionCommand(commandShell);

		else if (type.equals(CheckCommand.TYPE))
			command = new CheckCommand(commandShell);

		else if (type.equals(FocusCommand.TYPE))
			command = new FocusCommand(commandShell);

		else if (type.equals(ChoiceSelectionCommand.TYPE))
			command = new ChoiceSelectionCommand(commandShell);

		else if (type.equals(WaitCommand.TYPE))
			command = new WaitCommand(commandShell);

		/* The verification command */
		else if (type.equals(VerificationCommand.TYPE))
			command = new VerificationCommand(commandShell);

		/* The close workbench part command */
		else if (type.equals(CloseWorkbenchPartCommand.TYPE))
			command = new CloseWorkbenchPartCommand(commandShell);

		/* Mouse events */
		else if (type.equals(MouseEventCommand.MOUSE_UP)
				|| type.equals(MouseEventCommand.MOUSE_DOWN)
				|| type.equals(MouseEventCommand.MOUSE_MOVE)
				|| type.equals(MouseEventCommand.MOUSE_CLICK))
			command = new MouseEventCommand(commandShell);

		/* Key events */
		else if (type.equals(KeyEventCommand.KEY_UP)
				|| type.equals(KeyEventCommand.KEY_DOWN)
				|| type.equals(KeyEventCommand.KEY_PRESS))
			command = new KeyEventCommand(commandShell);

		return command;
	}

}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macro;

import java.util.Hashtable;

import org.eclipse.core.runtime.CoreException;
import org.w3c.dom.Node;



/**
 * A writable object is capable of serializing itself to string and writing the string
 * version to a PrintWriter that is passed to parameters to the methods that are described
 * below. It is also capable of loading itself from a given node.
 * <br/>
 * The ideal order of the method invocations are:
 * <ul>
 * 	<li> writeStart(String indent, gPrintWriter writer) </li>
 * 	<li> write(String indent, PrintWriter writer) </li>
 * 	<li> writeFinish(String indent, PrintWriter writer) </li>
 * </ul>
 */
public interface IPersistable 
{
	/**
	 * Invoked at start of the write of a writable object
	 * 
	 * @param indent The indents
	 * @param sb The buffer that the string serialization should be written to
	 */
	public void writeStart(int indent, StringBuffer sb);
	
	
	/**
	 * Invoked after writeStart
	 * 
	 * @param indent The indents
	 * @param sb The buffer that the string serialization should be written to
	 */
	public void write(int indent, StringBuffer sb);
	
	
	/**
	 * Invoked in the end of the write of a writable object
	 * 
	 * @param indent The indents
	 * @param sb The buffer that the string serialization should be written to
	 */
	public void writeFinish(int indent, StringBuffer sb);
	
	/**
	 * Invoked to load the macro instruction based on its corresponding XML node.
	 * 
	 * @param node
	 *            The XML node representing this macro instruction
	 * @param lineTable
	 *            Contains line level information
	 * 
	 * @throws CoreException
	 *             In case of an unexpected error
	 */
	public void load(Node node, Hashtable lineTable) throws CoreException;
}




/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macroobject.mine;

import java.util.ArrayList;
import java.util.Hashtable;
import java.util.LinkedList;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.osgi.util.NLS;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.util.XMLDefaultHandler;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;

/**
 * 
 * @author Ali Mehregani
 */
public class MacroObjectDescriptorMine {
	/** The root node of the tree structure that contains the objects */
	private MacroObjectDescriptor root;

	/** Included object mines */
	private ArrayList includes;

	/** The test suite that owns this object mine */
	private ITestSuite owner;

	/** The output object mine */
	private MacroObjectDescriptorMine outputObjectMine;

	/** The active object */
	private MacroObjectDescriptor activeObject;

	/**
	 * Keeps track of the maximum reference id in use. This is used to generate
	 * a unique reference id when requested
	 */
	private int maximumRefId;

	/** The xml handler used to parse the object mine */
	private XMLDefaultHandler defaultXMLHandler;

	public MacroObjectDescriptorMine(ITestSuite testSuite,
			XMLDefaultHandler defaultXMLHandler) {
		owner = testSuite;
		root = new MacroObjectDescriptor(null);
		includes = new ArrayList();
		this.defaultXMLHandler = defaultXMLHandler;
	}

	public void addInclude(MacroObjectDescriptorMine objectMine) {
		includes.add(objectMine);
		if (outputObjectMine != null) {
			MacroObjectDescriptorMine foundObjectMine = findIncludedObjectMine(outputObjectMine);
			outputObjectMine = foundObjectMine == null ? outputObjectMine
					: foundObjectMine;
		}
	}

	public MacroObjectDescriptor lookupMacroObjectDescriptor(
			MacroObjectDescriptor parent, String referenceId) {
		MacroObjectDescriptor uiObject = lookupIncludes(parent, referenceId);
		if (uiObject != null)
			return uiObject;

		uiObject = lookupMacroObjectDescriptor(parent);
		if (uiObject == null)
			return null;

		uiObject = uiObject.findChild(referenceId);
		return uiObject;
	}

	private MacroObjectDescriptor lookupMacroObjectDescriptor(
			MacroObjectDescriptor object, boolean requiresPresence)
			throws UIObjectNotFound {
		if (object == null) {
			return root;
		}

		LinkedList relationship = object.getHierarchicalRelation();
		MacroObjectDescriptor currentNode = root;
		for (int i = 0, height = relationship.size(); currentNode != null
				&& i < height; i++) {
			currentNode = currentNode
					.findChild(((MacroObjectDescriptor) relationship.get(i))
							.getReferenceId());
		}

		if (currentNode == null && requiresPresence)
			throw new UIObjectNotFound(NLS.bind(
					AutoGUIMessages.AUTO_GUI_ERROR_OBJ_MINE_NF, object
							.getReferenceId()));

		return currentNode;
	}

	public MacroObjectDescriptor lookupMacroObjectDescriptor(
			MacroObjectDescriptor parent, String contextId, String widgetId,
			String objectId) {
		MacroObjectDescriptor uiObject = lookupIncludes(parent, contextId,
				widgetId, objectId);
		if (uiObject != null)
			return uiObject;

		MacroObjectDescriptor parentNode = lookupMacroObjectDescriptor(parent);
		if (parentNode == null)
			return null;

		MacroObjectDescriptor[] children = parentNode.getChildren();
		for (int i = 0; i < children.length; i++) {
			if (((contextId == null && children[i].getContextId() == null) || (contextId != null && contextId
					.equals(children[i].getContextId())))
					&& widgetId.equals(children[i].getWidgetId())
					&& ((objectId == null && children[i].getObjectId() == null) || (objectId != null && objectId
							.equals(children[i].getObjectId())))) {
				return children[i];
			}

		}
		return null;
	}

	public MacroObjectDescriptor[] getChildren() {
		return root.getChildren();
	}

	private MacroObjectDescriptor lookupMacroObjectDescriptor(
			MacroObjectDescriptor parent) {
		try {
			return lookupMacroObjectDescriptor(parent, false);
		} catch (UIObjectNotFound e) {
			return null;
		}
	}

	/**
	 * Looks up the included object mine to determine if they have a
	 * corresponding object with the reference id passed in.
	 * 
	 * @param parent
	 *            The parent of the object
	 * @param referenceId
	 *            The reference id of the object
	 * 
	 * @return The object with the reference id passed in; null if none is
	 *         found.
	 * @throws UIObjectNotFound
	 *             In case the parent can't be found.
	 */
	private MacroObjectDescriptor lookupIncludes(MacroObjectDescriptor parent,
			String referenceId) {
		MacroObjectDescriptor[] uiObject = lookupIncludes(parent, referenceId,
				null, null, null);
		return uiObject != null && uiObject.length > 0 ? uiObject[0] : null;
	}

	/**
	 * Looks up the included object mine to determine if they have a
	 * corresponding object with the contextId id and object id passed in.
	 * 
	 * @param parent
	 *            The parent of the object
	 * @param contextId
	 *            The context id of the object
	 * @param widgetId
	 *            The id of the object
	 * 
	 * @return The object with the matching context and object id passed in;
	 *         null if none is found.
	 * @throws UIObjectNotFound
	 *             In case the parent can't be found.
	 */
	private MacroObjectDescriptor lookupIncludes(MacroObjectDescriptor parent,
			String contextId, String widgetId, String objectId) {
		MacroObjectDescriptor[] uiObject = lookupIncludes(parent, null,
				contextId, widgetId, objectId);
		return uiObject != null && uiObject.length > 0 ? uiObject[0] : null;
	}

	/**
	 * Looks up the included object mines to find an object that has been
	 * requested. If reference id happens to be null, then context/object id are
	 * used.
	 * 
	 * @param parent
	 *            The parent of the object
	 * @param referenceId
	 *            The reference id of the object.
	 * @param contextId
	 *            The context id of the object
	 * @param widgetId
	 *            The id of the object
	 * 
	 * @return The objects to look for
	 */
	private MacroObjectDescriptor[] lookupIncludes(
			MacroObjectDescriptor parent, String referenceId, String contextId,
			String widgetId, String objectId) {
		boolean useReferenceId = referenceId != null;
		boolean useObjectId = widgetId != null;

		MacroObjectDescriptor objectRequested = null;
		MacroObjectDescriptor[] children = null;
		for (int i = 0, includeCount = includes.size(); i < includeCount; i++) {
			MacroObjectDescriptorMine objectMine = (MacroObjectDescriptorMine) includes
					.get(i);
			if (useReferenceId) {
				objectRequested = objectMine.lookupMacroObjectDescriptor(
						parent, referenceId);
			} else if (useObjectId) {
				objectRequested = objectMine.lookupMacroObjectDescriptor(
						parent, contextId, widgetId, objectId);
			}

			children = objectRequested == null ? children
					: new MacroObjectDescriptor[] { objectRequested };
			if (children != null) {
				return children;
			}
		}

		return null;
	}

	public MacroObjectDescriptor getRoot() {
		return root;
	}

	public MacroObjectDescriptor registerObject(MacroObjectDescriptor parent,
			Node objectNode) throws IDCollisionException, UIObjectNotFound,
			CoreException {
		NamedNodeMap attributes = objectNode.getAttributes();
		MacroObjectDescriptor macroObjectDescriptor = new MacroObjectDescriptor(
				parent);

		MacroObjectDescriptor node = lookupMacroObjectDescriptor(parent, true);

		/* Set the attributes of the object */
		String referenceIdStr = getAttribute(attributes,
				MacroConstants.REFERENCE_ID_ATTRIBUTE);
		updateMaxReferenceId(referenceIdStr);

		Hashtable lineLevelDetail = null;
		if (defaultXMLHandler != null)
			lineLevelDetail = defaultXMLHandler.getLineTable();
		macroObjectDescriptor.setReferenceId(referenceIdStr);
		macroObjectDescriptor.setContextId(getAttribute(attributes,
				MacroConstants.CONTEXT_ID_ATTRIBUTE));
		// for backwards compatibility, also search for an ID attribute (old
		// format). Otherwise read the widget and object id
		if (getAttribute(attributes, MacroConstants.ID_ATTRIBUTE) != null) {
			macroObjectDescriptor.setWidgetId(getAttribute(attributes,
					MacroConstants.ID_ATTRIBUTE));
		} else {
			macroObjectDescriptor.setWidgetId(getAttribute(attributes,
					MacroConstants.WIDGET_ID_ATTRIBUTE));
			macroObjectDescriptor.setObjectId(getAttribute(attributes,
					MacroConstants.OBJECT_ID_ATTRIBUTE));
		}
		macroObjectDescriptor.setDescriptive(getAttribute(attributes,
				MacroConstants.DESCRIPTIVE_ATTRIBUTE));
		macroObjectDescriptor.setResolver(getAttribute(attributes,
				MacroConstants.RESOLVER_ID_ATTRIBUTE));
		if (lineLevelDetail != null)
			macroObjectDescriptor.setData(((Integer[]) lineLevelDetail
					.get(objectNode)));
		node.addChild(macroObjectDescriptor);

		return macroObjectDescriptor;
	}

	public MacroObjectDescriptor registerObject(MacroObjectDescriptor uiObject)
			throws IDCollisionException, UIObjectNotFound, CoreException {
		// assign a new unique id to the MacroObjectDescriptor
		String uniqueId = getUniqueReferenceId();
		updateMaxReferenceId(uniqueId);
		uiObject.setReferenceId(uniqueId);

		MacroObjectDescriptor parentObject = uiObject.getParent();

		/*
		 * If the object that is about to be registered happens to be at the
		 * first level (i.e. it is an infant), then it needs to be registered
		 * with the output destination of this object mine
		 */
		if (parentObject == null && outputObjectMine != null) {
			outputObjectMine.registerObject(uiObject);
			includes.contains(outputObjectMine);
			return uiObject;
		}

		if (parentObject == null) {
			root.addChild(uiObject);
		} else {
			parentObject.addChild(uiObject);
		}

		return uiObject;
	}

	private void updateMaxReferenceId(String referenceIdStr) {
		try {
			int referenceId = Integer.parseInt(referenceIdStr);
			int maximumIncludedRefId = findMaximumIncludedRefId();
			maximumRefId = Math.max(
					Math.max(referenceId, maximumIncludedRefId), maximumRefId);

			if (referenceId == maximumRefId)
				maximumRefId++;
		} catch (NumberFormatException nfe) {
			/* Doesn't need to be handled */
		}
	}

	/**
	 * Walks through the included object mines of this object mine to determine
	 * the unique reference id.
	 * 
	 * @return A unique reference id that is global to all included object
	 *         mines.
	 */
	private int findMaximumIncludedRefId() {
		int uniqueRefId = 0;

		for (int i = 0, includeCount = includes.size(); i < includeCount; i++) {
			MacroObjectDescriptorMine currentObjectMine = (MacroObjectDescriptorMine) includes
					.get(i);
			try {
				uniqueRefId = Math.max(Integer.parseInt(currentObjectMine
						.getUniqueReferenceId()), uniqueRefId);
			} catch (NumberFormatException nfe) {
				/* Ignore the exception */
			}
		}
		return uniqueRefId;
	}

	private String getAttribute(NamedNodeMap attributes, String attributeName) {
		Node attr = attributes.getNamedItem(attributeName);
		return attr == null ? null : attr.getNodeValue();
	}

	public void setOutputSource(MacroObjectDescriptorMine objectMine) {
		outputObjectMine = objectMine == null ? null
				: findIncludedObjectMine(objectMine);
		if (outputObjectMine == null)
			outputObjectMine = objectMine;
	}

	public MacroObjectDescriptorMine getOutputSource() {
		return outputObjectMine;
	}

	private MacroObjectDescriptorMine findIncludedObjectMine(
			MacroObjectDescriptorMine objectMine) {
		for (int i = 0, includeCount = includes.size(); i < includeCount; i++) {
			MacroObjectDescriptorMine currentObjectMine = (MacroObjectDescriptorMine) includes
					.get(i);
			if (currentObjectMine.equals(objectMine))
				return currentObjectMine;
		}

		return null;
	}

	public ITestSuite getOwner() {
		return owner;
	}

	public static class UIObjectNotFound extends Exception {
		static final long serialVersionUID = 4699726279267599112L;

		public UIObjectNotFound(String message) {
			super(message);
		}
	}

	public static class IDCollisionException extends Exception {
		static final long serialVersionUID = -6526030843455792891L;

		public IDCollisionException(String message) {
			super(message);
		}
	}

	public String serializeToString() {
		StringBuffer objectMineSerialized = new StringBuffer();
		int indent = 0;

		/* <object-mine> */
		MacroUtil.addElement(objectMineSerialized, indent,
				MacroConstants.OBJECT_MINE_ELEMENT, false, true);

		serializeHeader(objectMineSerialized, indent + 1, true);
		serializeObjects(objectMineSerialized, indent + 1, true);

		/* </object-mine> */
		MacroUtil.addElement(objectMineSerialized, indent,
				MacroConstants.OBJECT_MINE_ELEMENT, true, true);

		return objectMineSerialized.toString();
	}

	private void serializeHeader(StringBuffer objectMineSerialized, int indent,
			boolean includeHeader) {
		/* Don't write anything if the header is empty */
		if (outputObjectMine == null
				&& (includes == null || includes.size() <= 0))
			return;

		boolean outputElement = outputObjectMine != null;

		/* <header output="..."/> */
		if (includeHeader) {
			MacroUtil.addElement(objectMineSerialized, indent,
					MacroConstants.HEADER_ELEMENT, false, !outputElement);
			if (outputElement)
				MacroUtil.addAttribute(objectMineSerialized,
						new String[] { MacroConstants.OUTPUT_ATTRIBUTE },
						new String[] { AutoGUIUtil
								.resolveTestSuitePath(outputObjectMine
										.getOwner()) }, false, true);
		}

		/* Add the <include .../> elements */
		for (int i = 0, includeCount = includes.size(); i < includeCount; i++) {
			MacroObjectDescriptorMine currentInclude = (MacroObjectDescriptorMine) includes
					.get(i);
			ITestSuite testSuite = currentInclude.getOwner();
			String path = AutoGUIUtil.resolveTestSuitePath(testSuite);

			if (path != null) {
				MacroUtil.addElement(objectMineSerialized, indent + 1,
						MacroConstants.INCLUDE_ELEMENT, false, false);
				MacroUtil.addAttribute(objectMineSerialized,
						new String[] { MacroConstants.PATH_ATTRIBUTE },
						new String[] { path }, true, true);
			}
		}

		if (includeHeader) {
			MacroUtil.addElement(objectMineSerialized, indent,
					MacroConstants.HEADER_ELEMENT, true, true);
		}
	}

	private void serializeObjects(StringBuffer objectMineSerialized,
			int indent, boolean includeHeader) {
		MacroObjectDescriptor[] rootChildren = root.getChildren();
		if (rootChildren == null || rootChildren.length <= 0)
			return;

		/* Add the objects */
		if (includeHeader) {
			MacroUtil.addElement(objectMineSerialized, indent,
					MacroConstants.OBJECTS_ELEMENT, false, true);
			addObject(objectMineSerialized, indent + 1, rootChildren);
			MacroUtil.addElement(objectMineSerialized, indent,
					MacroConstants.OBJECTS_ELEMENT, true, true);
			return;
		}

		addObject(objectMineSerialized, indent + 1, rootChildren);
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.util.MacroObjectDescriptorMine#serializeHeaderToString()
	 */
	public String serializeHeaderToString() {
		StringBuffer sb = new StringBuffer();
		serializeHeader(sb, 0, false);
		return sb.toString();
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.util.MacroObjectDescriptorMine#serializeObjetsToString()
	 */
	public String serializeObjetsToString() {
		StringBuffer sb = new StringBuffer();
		serializeObjects(sb, 0, false);
		return sb.toString();
	}

	private void addObject(StringBuffer objectMapSerialized, int indent,
			MacroObjectDescriptor[] rootChildren) {
		if (rootChildren == null)
			return;

		for (int i = 0; i < rootChildren.length; i++) {
			MacroObjectDescriptor currentMacroObjectDescriptor = rootChildren[i];
			MacroObjectDescriptor[] children = rootChildren[i].getChildren();

			/* If the object is a shell without any children, then skip it */
			if (currentMacroObjectDescriptor.getParent() == null
					&& (children == null || children.length <= 0))
				continue;

			boolean hasChildren = children != null && children.length > 0;
			MacroUtil.addElement(objectMapSerialized, indent,
					MacroConstants.OBJECT_ELEMENT, false, false);
			MacroUtil.addAttribute(objectMapSerialized, new String[] {
					MacroConstants.DESCRIPTIVE_ATTRIBUTE,
					MacroConstants.REFERENCE_ID_ATTRIBUTE,
					MacroConstants.CONTEXT_ID_ATTRIBUTE,
					MacroConstants.RESOLVER_ID_ATTRIBUTE,
					MacroConstants.WIDGET_ID_ATTRIBUTE,
					MacroConstants.OBJECT_ID_ATTRIBUTE }, new String[] {
					currentMacroObjectDescriptor.getDescriptive(),
					currentMacroObjectDescriptor.getReferenceId(),
					currentMacroObjectDescriptor.getContextId(),
					currentMacroObjectDescriptor.getResolverId(),
					currentMacroObjectDescriptor.getWidgetId(),
					currentMacroObjectDescriptor.getObjectId() }, !hasChildren,
					true);
			if (hasChildren) {
				addObject(objectMapSerialized, indent + 1, rootChildren[i]
						.getChildren());
				MacroUtil.addElement(objectMapSerialized, indent,
						MacroConstants.OBJECT_ELEMENT, true, true);
			}
		}

	}

	public MacroObjectDescriptor getActiveObject() {
		return activeObject;
	}

	public void setActiveObject(MacroObjectDescriptor activeObject) {
		this.activeObject = activeObject;
	}

	private String getUniqueReferenceId() {
		int maximumIncludedRefId = findMaximumIncludedRefId();
		maximumRefId = Math.max(maximumIncludedRefId, maximumRefId);

		/* Restart the reference id */
		if (maximumRefId >= Integer.MAX_VALUE - 10) {
			maximumRefId = 0;
		}
		return String.valueOf(maximumRefId);
	}

	public List getIncludes() {
		return includes;
	}

	public boolean equals(Object o) {
		return o instanceof MacroObjectDescriptorMine ? getOwner().getId()
				.equals(((MacroObjectDescriptorMine) o).getOwner().getId())
				: false;
	}

	public void setOwner(ITestSuite testSuite) {
		this.owner = testSuite;
	}

	/**
	 * If the node passed in has a reference id, then this method looks up the
	 * id in the object mine and attempts to find the object that is referenced.
	 * 
	 * @param node
	 *            Represents the XML node
	 * @param lineTable
	 *            Contains line level information
	 * 
	 * @return A String[] of length 2, where String[0] = context id and
	 *         String[1] = object id. If the node does not have a reference id,
	 *         then null is returned.
	 * 
	 * @throws CoreException
	 *             If the node contains a reference id attribute but the
	 *             corresponding object mine does not have any such object.
	 */
	public MacroObjectDescriptor lookupReferenceId(
			MacroObjectDescriptor parent, Node node, Hashtable lineTable)
			throws CoreException {
		String referenceId = MacroUtil.getAttribute(node,
				MacroConstants.REFERENCE_ID_ATTRIBUTE);
		if (referenceId == null)
			return null;

		MacroObjectDescriptor correspondingObject = lookupMacroObjectDescriptor(
				parent, referenceId);
		if (correspondingObject == null) {
			Integer[] lineLevelDetail = (Integer[]) lineTable.get(node);
			AutoGUIUtil
					.throwCoreException(NLS.bind(
							AutoGUIMessages.AUTO_GUI_ERROR_OBJ_MINE_NF,
							referenceId), lineLevelDetail == null ? 0
							: lineLevelDetail[0].intValue());
		} else {
			return correspondingObject;
		}

		/* Code not reached beyond this point */
		return null;
	}

}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.commands;

import java.util.Hashtable;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObject;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObject;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptor;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine.IDCollisionException;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine.UIObjectNotFound;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.resolver.MacroObjectResolver;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.PrimitiveUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.UIObject;
import org.w3c.dom.Node;

/**
 * @author Alexander Nyssen
 * 
 */
public abstract class ObjectBasedCommand extends AbstractMacroCommand {

	/** The macro object of interest to the command */
	protected IMacroObject macroObject;

	/** The macro object id associated with this command */
	protected IMacroObjectIdentifier macroObjectIdentifier;

	/** The corresponding macro object for this object-based macro command */
	protected MacroObjectDescriptor macroObjectDescriptor;

	// used to detect wether a descriptive field has to be detected
	boolean needsDescriptiveField = false;

	/**
	 * @param parent
	 * @param widgetId
	 */
	public ObjectBasedCommand(MacroCommandShell parent) {
		super(parent);
	}

	protected void preProcessEvent(Event event) throws CoreException {
		macroObject = locateMacroObject(event);

		// retrieve the macro object identifier
		IMacroObjectIdentifier identifier = MacroObjectResolver.resolve(
				getParent().getShell(), macroObject);
		if (identifier == null) {
			AutoGUIUtil
					.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_MACRO_OBJECT_RESOLVE, macroObject.getUIObject().getWidget()));
		}
		setMacroObjectIdentifier(identifier);

		// register with object mine if in use and not already done
		MacroObjectDescriptor uiObject = null;
		if (useObjectMine()) {
			/*
			 * Lookup the widget of this command. If it already exists in our
			 * object mine, then have it referenced by setting the reference id
			 * of the command.
			 */
			MacroObjectDescriptorMine objectMine = MacroManager.getInstance()
					.getObjectMine();

			try {
				MacroObjectDescriptor activeObject = objectMine
						.getActiveObject();
				uiObject = objectMine.lookupMacroObjectDescriptor(activeObject,
						identifier.getContextIdentifier() == null ? null
								: identifier.getContextIdentifier(), identifier
								.getObjectIdentifier().getWidgetId(), identifier.getObjectIdentifier().getObjectId());

				/*
				 * The object is not registered with the object mine - register
				 * it
				 */
				if (uiObject == null) {
					needsDescriptiveField = true;
					uiObject = MacroObjectDescriptor.createInstance(this,
							activeObject);
					objectMine.registerObject((MacroObjectDescriptor) uiObject);
				}
				setCorrespondingMacroObjectDescriptor(uiObject);
			}

			/*
			 * We can't afford to show an error message in case of an unexpected
			 * error during registeration. We'll ignore the error and not make
			 * use of the object mine.
			 */
			catch (UIObjectNotFound e) {
				/* Should not happen */
			} catch (IDCollisionException e) {
				/* Should not happen */
			} catch (CoreException e) {
				/* Should not happen */
				e.printStackTrace();
			}
		}
	}

	protected void doProcessEvent(Event event) throws CoreException {
		// nothing to do by default
	}

	protected final void postProcessEvent(Event event) throws CoreException {
		// initialize the descriptive field of the associated macro object
		// descriptor
		if (useObjectMine() && needsDescriptiveField
				&& getCorrespondingMacroObjectDescriptor() != null) {
			// may safely cast into MacroObjectDescriptor here, as
			// needsDescriptiveField is only true if we have created a new one.
			((MacroObjectDescriptor) getCorrespondingMacroObjectDescriptor())
					.setDescriptive(getObjectClassName(event.widget)
							+ (getDescriptiveField() == null ? MacroConstants.EMPTY_STRING
									: ": " + getDescriptiveField()));
		}
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.tptp.test.auto.gui.internal.commands.IMacroCommand#processEvent(org.eclipse.swt.widgets.Event)
	 */
	public final void processEvent(Event event) throws CoreException {
		preProcessEvent(event);

		// let the original implementation do its job (detect the descriptive
		// field, for example)
		doProcessEvent(event);

		postProcessEvent(event);
	}

	/**
	 * This can be changed by subclasses, if for example a String entry of a
	 * combo box has to be checked...
	 * 
	 * @param event
	 * @return
	 */
	protected IMacroObject locateMacroObject(Event event) {
		return new MacroObject(new UIObject(event.widget));
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.macro.IMacroInstruction#getCorrespondingMacroObjectDescriptor()
	 */
	public MacroObjectDescriptor getCorrespondingMacroObjectDescriptor() {
		return macroObjectDescriptor;
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.macro.IMacroInstruction#setCorrespondingMacroObjectDescriptor(org.eclipse.tptp.test.auto.gui.internal.util.MacroObjectDescriptor)
	 */
	protected void setCorrespondingMacroObjectDescriptor(
			MacroObjectDescriptor uiObject) {
		this.macroObjectDescriptor = uiObject;
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.macro.IMacroInstruction#getMacroObjectIdentifier()
	 */
	public IMacroObjectIdentifier getMacroObjectIdentifier() {
		return macroObjectIdentifier;
	}

	/**
	 * @see org.eclipse.tptp.test.auto.gui.internal.macro.IMacroInstruction#setMacroObjectIdentifier(IMacroObjectIdentifier)
	 */
	protected void setMacroObjectIdentifier(
			IMacroObjectIdentifier objectIdentifier) {
		this.macroObjectIdentifier = objectIdentifier;
	}

	public void load(Node node, Hashtable lineTable) throws CoreException {
		super.load(node, lineTable);

		loadMacroObjectIdentifier(node, lineTable);
	}

	protected void loadMacroObjectIdentifier(Node node, Hashtable lineTable)
			throws CoreException {
		MacroObjectDescriptor commandObject = null;
		if (MacroManager.getInstance().getObjectMine() != null) {
			commandObject = MacroManager.getInstance().getObjectMine().lookupReferenceId(
					getParent().getCorrespondingMacroObjectDescriptor(), node,
					lineTable);
		}
		boolean isObjectFound = commandObject != null;
		if (isObjectFound) {
			setCorrespondingMacroObjectDescriptor(commandObject);
		}
		
		String cid = isObjectFound ? commandObject.getContextId() : MacroUtil
				.getAttribute(node, MacroConstants.CONTEXT_ID_ATTRIBUTE);
		String wid = isObjectFound ? commandObject.getWidgetId() : MacroUtil
				.getAttribute(node, MacroConstants.WIDGET_ID_ATTRIBUTE);
		String obj = isObjectFound ? commandObject.getObjectId() : MacroUtil
				.getAttribute(node, MacroConstants.OBJECT_ID_ATTRIBUTE);
		String rid = isObjectFound ? commandObject.getResolverId() : MacroUtil
				.getAttribute(node, MacroConstants.RESOLVER_ID_ATTRIBUTE);

		if (cid != null && wid != null) {
			PrimitiveUIObjectIdentifier objectIdentifier = null;
			if (wid == null) {
				objectIdentifier = new PrimitiveUIObjectIdentifier(
						MacroConstants.EMPTY_STRING, rid);
			} else {
				objectIdentifier = new PrimitiveUIObjectIdentifier(wid,
						obj, rid);
			}
			setMacroObjectIdentifier(new MacroObjectIdentifier(
					cid == null ? MacroConstants.EMPTY_STRING : cid,
					objectIdentifier));
		}
	}

	public void write(int indent, StringBuffer sb, boolean close, boolean end) {
		// let the super implementation write the element, we will just add our
		// attributes
		super.write(indent, sb, false, false);

		writeMacroObjectIdentifier(indent, sb, close, end);
	}

	protected void writeMacroObjectIdentifier(int indent, StringBuffer sb,
			boolean close, boolean end) {
		boolean noWidgetId = getMacroObjectIdentifier() == null;
		boolean objectMineInUse = useObjectMine();
		MacroUtil
				.addAttribute(
						sb,
						new String[] { MacroConstants.RESOLVER_ID_ATTRIBUTE,
								MacroConstants.CONTEXT_ID_ATTRIBUTE,
								MacroConstants.WIDGET_ID_ATTRIBUTE,
								MacroConstants.OBJECT_ID_ATTRIBUTE,
								MacroConstants.REFERENCE_ID_ATTRIBUTE },
						new String[] {
								objectMineInUse || noWidgetId ? null
										: getMacroObjectIdentifier()
												.getObjectIdentifier()
												.getResolverId(),
								objectMineInUse || noWidgetId ? null
										: getMacroObjectIdentifier()
												.getContextIdentifier(),
								objectMineInUse || noWidgetId ? null
										: getMacroObjectIdentifier()
												.getObjectIdentifier()
												.getWidgetId(),
								objectMineInUse || noWidgetId ? null
										: getMacroObjectIdentifier()
												.getObjectIdentifier()
												.getObjectId(),
								objectMineInUse ? getCorrespondingMacroObjectDescriptor()
										.getReferenceId()
										: null }, close, end);
	}

	protected boolean useObjectMine() {
		return MacroManager.getInstance().isObjectMineOn();
	}

	public boolean playback(Display display, Shell parent,
			IProgressMonitor monitor) throws CoreException {
		if (getMacroObjectIdentifier() != null) {
			macroObject = MacroObjectResolver.deresolve(parent,
						getMacroObjectIdentifier());
		}
		return doPlayback(display, parent, monitor);
	}

	public boolean doPlayback(Display display, Shell parent,
			IProgressMonitor monitor) throws CoreException{
		// nothing to do by default
		return false;
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.tptp.test.auto.gui.internal.commands.AbstractMacroCommand#equals(java.lang.Object)
	 */
	public boolean equals(Object obj) {
		if (!super.equals(obj)) {
			return false;
		}
		if (!(obj instanceof ObjectBasedCommand)) {
			return false;
		}
		ObjectBasedCommand compareWithObj = (ObjectBasedCommand) obj;
		return compareWithObj.getMacroObjectIdentifier() != null
				&& compareWithObj.getMacroObjectIdentifier().equals(
						getMacroObjectIdentifier());
	}
}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.deresolvingsupport;

import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Vector;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.jface.action.IContributionItem;
import org.eclipse.jface.action.ICoolBarManager;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.action.ToolBarContributionItem;
import org.eclipse.jface.action.ToolBarManager;
import org.eclipse.jface.wizard.IWizardPage;
import org.eclipse.jface.wizard.WizardDialog;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.custom.CCombo;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.CTabItem;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Item;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.TabFolder;
import org.eclipse.swt.widgets.TabItem;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.PrimitiveUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.UIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.DeresolvingAmbiguityException;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.IUIObjectResolverDelegate;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.NonTrivialUIObjectResolverDelegate;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.UIObjectResolverDelegateRegistry;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.UIObjectResolverDelegateLoader;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IViewPart;

/**
 * This class was merely introduced to be able to migrate the already existing
 * WidgetResolvers to the newly introduced IUIObjectResolverDelegate interface
 * while preserving the old implementation to deresolve UI objects (via the
 * foundWidget method). New IUIObjectResolverDelegates should not build on this
 * class and this class should possibly be removed by implementing proper
 * deresolving mechanisms in the existing IUIObjectResolverDelegate
 * implementations in the future.
 * 
 * @author Alexander Nyssen
 * 
 */
public class UIObjectDeprecatedDeresolvingSupport {

	/**
	 * Preserves the deprecated algorithm for widget resolving that was used
	 * before. Both, the AdaptiveUIObjectResolverDelegate as well as the
	 * NonTrivialUIObjectResolverDelegate refer to this implementation of
	 * deresolving. All newly introduced resolvers should not reside on this.
	 */
	public static IUIObject deresolve(Object context,
			IUIObjectIdentifier identifier) throws CoreException {

		IUIObject uiObject = null;
		String errorMessage = null;
		Throwable cause = null;

		try {
			if (context instanceof Menu) {
				// normal menus and popup menus (in the latter case we have to
				// ensure the menu is visible
				Menu menuBar = (Menu) context;
				MacroUtil.forceMenuOpen(menuBar);
				uiObject = locateMenuItem(menuBar, identifier);
				MacroUtil.forceMenuClosed(menuBar);
				if (uiObject == null) {
					errorMessage = NLS.bind(
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_MENU,
							identifier.getWidgetId());
				}
			} else if (context instanceof ToolBar) {
				// deresolve tool item
				ToolBar toolbar = (ToolBar) context;
				uiObject = locateToolItem(toolbar, identifier);
				if (uiObject == null) {
					errorMessage = NLS.bind(
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_TOOL_BAR,
							identifier.getWidgetId());
				}
			} else if (context instanceof ToolBarManager
					|| context instanceof ICoolBarManager) {
				if (context instanceof ToolBarManager) {
					// Only ToolBarManager can be deresolved, not any
					// IToolBarManager implementation,
					// as the interface IToolBarManager interface does not allow
					// to obtain the control
					ToolBarManager toolBarManager = (ToolBarManager) context;
					uiObject = locateToolItem(toolBarManager, identifier);
				} else {
					ICoolBarManager coolBarManager = (ICoolBarManager) context;
					uiObject = locateToolItem(coolBarManager, identifier);
				}
				if (uiObject == null) {
					errorMessage = NLS.bind(
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_TOOL,
							identifier.getWidgetId());
				}
			} else if (context instanceof TabFolder
					|| context instanceof CTabFolder) {
				if (context instanceof TabFolder) {
					TabFolder tabFolder = (TabFolder) context;
					uiObject = locateTabItem(tabFolder, identifier);
				} else {
					CTabFolder tabFolder = (CTabFolder) context;
					uiObject = locateCTabItem(tabFolder, identifier);
				}
				if (uiObject == null) {
					errorMessage = NLS.bind(
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_TAB,
							identifier.getWidgetId());
				}
			} else if (context instanceof WizardDialog) {
				WizardDialog wd = (WizardDialog) context;

				IWizardPage page = wd.getCurrentPage();
				Composite pparent = (Composite) page.getControl();
				uiObject = UIObjectDeprecatedDeresolvingSupport
						.locateVisibleChild(wd.getShell(), pparent, identifier);

				if (uiObject == null) {
					errorMessage = NLS.bind(
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_WIZARD,
							identifier.getWidgetId());
				}
			} else if (context instanceof IWizardPage) {
				IWizardPage page = (IWizardPage) context;

				Composite pparent = (Composite) page.getControl();
				uiObject = UIObjectDeprecatedDeresolvingSupport
						.locateVisibleChild(pparent, null, identifier);

				if (uiObject == null) {
					errorMessage = NLS.bind(
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_WIZARD_CON,
							identifier.getWidgetId());
				}
			} else if (context instanceof IEditorPart) {
				IEditorPart editor = (IEditorPart) context;

				Composite c = MacroUtil.getWorkbenchPartControl(editor);
				uiObject = UIObjectDeprecatedDeresolvingSupport
						.locateVisibleChild(c, null, identifier);

				if (uiObject == null) {
					errorMessage = NLS.bind(
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_EDITOR_CON,
							identifier.getWidgetId());
				}
			} else if (context instanceof IViewPart) {
				IViewPart view = (IViewPart) context;

				Composite c = MacroUtil.getWorkbenchPartControl(view);
				uiObject = UIObjectDeprecatedDeresolvingSupport
						.locateVisibleChild((Composite) c, null, identifier);

				if (uiObject == null) {
					errorMessage = NLS.bind(
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_VIEW_CON,
							identifier.getWidgetId());
				}
			} else if (context instanceof Shell) {
				// locate a shell control
				Shell shell = (Shell) context;

				uiObject = UIObjectDeprecatedDeresolvingSupport
						.locateVisibleChild(shell, null, identifier);

				if (uiObject == null) {
					errorMessage = NLS.bind(
							AutoGUIMessages.AUTO_GUI_ERROR_MACRO_SHELL,
							identifier.getWidgetId());
				}
			}

		} catch (Throwable t) {
			t.printStackTrace();
			if (t.getCause() != null) {
				cause = t.getCause();
			} else {
				cause = t;
			}
			errorMessage = t.getMessage();
		}

		if (uiObject != null) {
			return uiObject;
		} else {
			AutoGUIUtil.throwCoreException(errorMessage, cause);
			return null;
		}
	}

	private static IUIObject locateCTabItem(CTabFolder tabFolder,
			IUIObjectIdentifier identifier) {
		CTabItem tabItem = null;
		for (int i = 0; i < tabFolder.getItemCount() && tabItem == null; i++) {
			CTabItem currentItem = tabFolder.getItem(i);
			String validatedCurrentItemText = NonTrivialUIObjectResolverDelegate
					.validateText(currentItem.getText());
			if (validatedCurrentItemText != null
					&& validatedCurrentItemText
							.equals(identifier.getWidgetId())) {
				tabItem = currentItem;
			}
		}
		return new UIObject(tabItem);
	}

	private static IUIObject locateTabItem(TabFolder tabFolder,
			IUIObjectIdentifier identifier) {
		TabItem tabItem = null;
		for (int i = 0; i < tabFolder.getItemCount() && tabItem == null; i++) {
			TabItem currentItem = tabFolder.getItem(i);
			String validatedCurrentItemText = NonTrivialUIObjectResolverDelegate
					.validateText(currentItem.getText());
			if (validatedCurrentItemText != null
					&& validatedCurrentItemText
							.equals(identifier.getWidgetId())) {
				tabItem = currentItem;
			}
		}
		return new UIObject(tabItem);
	}

	/**
	 * @deprecated This method should only be used internally Returns true iff
	 *             the widget matches the id passed in.
	 * 
	 * @param widget
	 *            The widget
	 * @param objectId
	 *            The resolver id -- can be null
	 * @return true iff the widget matches the id passed in.
	 */
	public static boolean foundWidget(Widget widget,
			IUIObjectIdentifier widgetId) {
		Hashtable widgetResolvers = UIObjectResolverDelegateRegistry
				.getDelegateResolverLoaders();

		if (widgetId != null && widgetId.getResolverId() != null) {
			UIObjectResolverDelegateLoader loader = (UIObjectResolverDelegateLoader) widgetResolvers
					.get(widgetId.getResolverId());
			if (loader != null
					&& loader.getUIObjectResolverDelegate() instanceof IUIObjectDeprecatedDeresolvingFacade)
				return ((IUIObjectDeprecatedDeresolvingFacade) loader
						.getUIObjectResolverDelegate()).foundWidget(widget,
						widgetId);
			return false;
		}

		Enumeration keys = widgetResolvers.keys();
		while (keys.hasMoreElements()) {
			IUIObjectResolverDelegate delegateResolver = ((UIObjectResolverDelegateLoader) widgetResolvers
					.get(keys.nextElement())).getUIObjectResolverDelegate();
			if (delegateResolver instanceof IUIObjectDeprecatedDeresolvingFacade) {
				if (((IUIObjectDeprecatedDeresolvingFacade) delegateResolver)
						.foundWidget(widget, widgetId)) {
					return true;
				}
			}
		}
		return false;
	}

	/**
	 * @deprecated This method should only be used internally. Returns true if
	 *             the id computed for 'item' matches 'id'
	 * 
	 * @param item
	 *            The tool item
	 * @param resolverId
	 *            The resolver id -- can be null
	 * @param id
	 *            The id that should be matched against
	 * @return true if there is a match, and false otherwise
	 */
	public static boolean foundItem(Item item, IUIObjectIdentifier objectId) {
		/* Try the widget resolvers first */
		if (foundWidget(item, objectId))
			return true;

		/* Give the old policy a try */
		String toolItemIdStr = NonTrivialUIObjectResolverDelegate.getActionId(
				item).toString();
		if (toolItemIdStr != null
				&& toolItemIdStr.equals(objectId.getWidgetId()))
			return true;

		return false;
	}

	public static Control recursiveSearch(Composite parent, Composite skip,
			Control desiredControl, IUIObjectIdentifier id,
			String widgetClassName, int[] index, Vector matches, Vector indices) {
		boolean searchForControl = id == null;
		Control[] children = parent.getChildren();
		boolean[] checkTypeAndEquality;
		Control searchResult;
		// boolean isTabFolder, isCTabFolder;

		for (int i = 0; i < children.length; i++) {
			Control child = children[i];

			if (!child.isVisible()) {
				/*
				 * If the control is of the same type, then we'll need to
				 * increment the index
				 */
				if ((widgetClassName != null && child.getClass().getName()
						.equals(widgetClassName))
						|| (desiredControl != null && desiredControl.getClass()
								.getName().equals(child.getClass().getName())))
					index[0]++;

				continue;
			}

			checkTypeAndEquality = searchForControl ? checkTypeAndEqual(
					desiredControl, child, index) : checkTypeAndId(child, id,
					widgetClassName, index);
			if (checkTypeAndEquality[0]) {
				if (checkTypeAndEquality[1]) {
					addMatch(matches, indices, child, index[0]);
				}

				// ANy: This code is now obsolete, as we have a new deresolving
				// policy for
				// TabItems and CTabItems (own context info) and the respective
				// choice command
				// converts existing macro entries to the new format.
				// /* Defect 111371 -- We need to step through the items of a
				// tab */
				// isTabFolder = child instanceof TabFolder;
				// isCTabFolder = child instanceof CTabFolder;
				// if (isTabFolder || isCTabFolder) {
				// Object[] tabItems = isTabFolder ? (Object[]) ((TabFolder)
				// child)
				// .getItems()
				// : ((CTabFolder) child).getItems();
				// if (tabItems != null) {
				// for (int j = 0; j < tabItems.length; j++) {
				// Control tabItemControl = isTabFolder ? ((TabItem)
				// tabItems[j])
				// .getControl()
				// : ((CTabItem) tabItems[j]).getControl();
				//
				// if (tabItemControl == null)
				// continue;
				//
				// checkTypeAndEquality = searchForControl ? checkTypeAndEqual(
				// tabItemControl, desiredControl, index)
				// : checkTypeAndId(tabItemControl, id,
				// widgetClassName, index);
				// if (checkTypeAndEquality[0]
				// && checkTypeAndEquality[1]) {
				// addMatch(matches, indices, tabItemControl,
				// index[0]);
				// }
				// if ((searchResult = recursiveSearch(tabItemControl,
				// skip, desiredControl, id, widgetClassName,
				// index, matches, indices)) != null) {
				// addMatch(matches, indices, searchResult,
				// index[0]);
				// }
				// }
				// }
				// }
				//
			}

			if ((searchResult = recursiveSearch(child, skip, desiredControl,
					id, widgetClassName, index, matches, indices)) != null) {
				addMatch(matches, indices, searchResult, index[0]);
			}
		}

		if (matches.size() > 0) {
			return (Control) matches.get(0);
		} else {
			return null;
		}
	}

	/**
	 * A helper method used to indicate whether expected is of the same type as
	 * actual. The return value also indicates if expected == actual.
	 * 
	 * @param expected
	 *            The expected control
	 * @param actual
	 *            The actual control that 'expected' is checked against
	 * @param counter
	 *            A counter that is used for indexing.
	 * 
	 * @return This method has the side affect of incrementing counter if the
	 *         class types of the two controls are the same. The return value
	 *         indicates type and whether expected == actual.
	 */
	private static boolean[] checkTypeAndEqual(Control expected,
			Control actual, int[] counter) {
		boolean[] typeAndEqualCheck = new boolean[2];
		if (expected.getClass().equals(actual.getClass())) {
			typeAndEqualCheck[0] = true;

			// same type - increment counter
			counter[0]++;
			if (expected.equals(actual)) {
				// bingo
				typeAndEqualCheck[1] = true;
			}
		}

		return typeAndEqualCheck;
	}

	private static Control recursiveSearch(Control currentSearchPoint,
			Composite skip, Control desiredControl,
			IUIObjectIdentifier desiredId, String desiredWidgetClassName,
			int[] index, Vector matches, Vector indices) {
		Control searchResult = null;
		if (currentSearchPoint instanceof Composite
				&& !(skip != null && currentSearchPoint.equals(skip))
				&& currentSearchPoint.isVisible()) {
			searchResult = recursiveSearch((Composite) currentSearchPoint,
					skip, desiredControl, desiredId, desiredWidgetClassName,
					index, matches, indices);
		}

		return searchResult;
	}

	private static void addMatch(Vector container, Vector indices, Object item,
			int index) {
		if (!container.contains(item)) {
			container.add(item);
			indices.add(new Integer(index));
		}
	}

	private static boolean[] checkTypeAndId(Control presentControl,
			IUIObjectIdentifier desiredId, String desiredWidgetClassName,
			int[] counter) {
		boolean[] checkTypeAndEqualId = new boolean[2];

		if (desiredWidgetClassName == null
				|| presentControl.getClass().getName().equals(
						desiredWidgetClassName)) {
			// same type - increment counter
			if (!presentControl.isVisible())
				return checkTypeAndEqualId;

			checkTypeAndEqualId[0] = true;
			counter[0]++;
			if (foundWidget(presentControl, desiredId)
					|| NonTrivialUIObjectResolverDelegate
							.computeDefaultControlId(presentControl, counter[0])
							.equals(desiredId.getWidgetId())) {
				checkTypeAndEqualId[1] = true;
			}
		}

		return checkTypeAndEqualId;
	}

	private static UIObject locateVisibleChild(Composite parent,
			Composite skip, IUIObjectIdentifier uiObjectIdentifier)
			throws CoreException {
		int[] counter = new int[1];
		counter[0] = 0;

		// see if an uniqueness identifier was added by the UIObjectResolver
		// because the identifier
		// that was computed is not unique (workaround for defect #147766)
		String widgetIdentifier = uiObjectIdentifier.getWidgetId();
		IUIObjectIdentifier adjustedUIObjectIdentifier = uiObjectIdentifier;
		int matchIndex = -1;
		if (widgetIdentifier
				.indexOf(MacroConstants.WIDGET_ID_UNIQUENESS_INDEX_SEPARATOR) > 0) {
			adjustedUIObjectIdentifier = new PrimitiveUIObjectIdentifier(
					widgetIdentifier
							.substring(
									0,
									widgetIdentifier
											.indexOf(MacroConstants.WIDGET_ID_UNIQUENESS_INDEX_SEPARATOR)),
					uiObjectIdentifier.getObjectId(), uiObjectIdentifier
							.getResolverId());
			matchIndex = new Integer(
					widgetIdentifier
							.substring(widgetIdentifier
									.indexOf(MacroConstants.WIDGET_ID_UNIQUENESS_INDEX_SEPARATOR) + 3))
					.intValue();
		}

		int sloc = widgetIdentifier.indexOf('#');
		String wclassName = null;
		if (sloc != -1)
			wclassName = widgetIdentifier.substring(0, sloc);

		/*
		 * https://bugs.eclipse.org/bugs/show_bug.cgi?id=147766: We need to
		 * return all possible matches -> ANy: this does not seem to be an
		 * adequate solution. It seems as if the resolving mechanism should
		 * compute a more appropriate identifier in such a case. We will
		 * therefore not tolerate such an anambiguity.
		 */
		Vector matches = new Vector();
		Vector indices = new Vector();
		// do not use the extended widget identifier but only the prefix to find
		// the widget
		locateVisibleChild(parent, skip, adjustedUIObjectIdentifier,
				wclassName, counter, matches, indices);

		// see if we have properly deresolved a control
		Control control = null;
		if (matches.size() > 0) {
			if (matches.size() > 1) {
				if (matchIndex != -1) {
					control = (Control) matches.get(matchIndex);
				} else {
					// we have found several matches and no uniqueness
					// identifier was added,
					// so we cannt unambiguously identify which one was
					// selected.
					AutoGUIUtil
							.throwCoreException(
									NLS
											.bind(
													AutoGUIMessages.AUTO_GUI_UI_OBJECT_IDENTIFIER_AMBIGUOUS,
													uiObjectIdentifier
															.getWidgetId(),
													uiObjectIdentifier
															.getObjectId()),
									new DeresolvingAmbiguityException(matches
											.size()));
					return null;
				}
			} else {
				control = (Control) matches.get(0);
			}
		}

		// we have located a control, see if we have to further deresolve a
		// nested object
		if (control != null) {
			// added by ANy to resolve beyond the widget level for combo and
			// ccombo controls (needed in choice command)
			if (adjustedUIObjectIdentifier.getObjectId() != null) {
				// find object located at the sub widget level
				if (control instanceof Combo || control instanceof CCombo) {
					String indexString = adjustedUIObjectIdentifier
							.getObjectId().substring(
									new String("item#").length());
					int index = new Integer(indexString).intValue();
					// find the item at the specified index
					if (control instanceof Combo) {
						String[] items = ((Combo) control).getItems();
						return new UIObject(control, items[index]);
					} else if (control instanceof CCombo) {
						String[] items = ((CCombo) control).getItems();
						return new UIObject(control, items[index]);
					}
					return null;
				} else {
					// anything else is ignored up to now
					return new UIObject(control);
				}
			} else {
				return new UIObject(control);
			}
		} else {
			return null;
		}
	}

	private static Control locateVisibleChild(Composite parent, Composite skip,
			IUIObjectIdentifier id, String wclassName, int[] index,
			Vector matches, Vector indices) {
		return recursiveSearch(parent, skip, null, id, wclassName, index,
				matches, indices);
	}

	private static IUIObject locateToolItem(ICoolBarManager coolMng,
			IUIObjectIdentifier wid) {
		IContributionItem[] items = coolMng.getItems();
		for (int i = 0; i < items.length; i++) {
			if (items[i] instanceof ToolBarContributionItem) {
				ToolBarContributionItem item = (ToolBarContributionItem) items[i];
				IToolBarManager toolMng = item.getToolBarManager();
				IUIObject target = locateToolItem((ToolBarManager) toolMng, wid);
				if (target != null)
					return target;
			}
		}
		return null;
	}

	private static IUIObject locateToolItem(ToolBarManager toolMng,
			IUIObjectIdentifier wid) {
		return locateToolItem(toolMng.getControl(), wid);
	}

	private static UIObject locateMenuItem(Menu menu,
			IUIObjectIdentifier widgetId) {
		MenuItem[] items = menu.getItems();

		for (int i = 0; i < items.length; i++) {
			MenuItem item = items[i];

			Menu submenu = item.getMenu();
			if (submenu != null) {
				/*
				 * Ali M.: We have to force the menu to open, since its items
				 * may not have already been created
				 */
				MacroUtil.forceMenuOpen(submenu);
				UIObject hit = locateMenuItem(submenu, widgetId);
				if (hit != null)
					return hit;
			} else {
				if (UIObjectDeprecatedDeresolvingSupport.foundItem(item,
						widgetId))
					return new UIObject(item);
			}
		}
		return null;
	}

	private static IUIObject locateToolItem(ToolBar toolBar,
			IUIObjectIdentifier wid) {
		if (toolBar == null)
			return null;
		ToolItem[] items = toolBar.getItems();
		for (int i = 0; i < items.length; i++) {
			ToolItem item = items[i];
			if (UIObjectDeprecatedDeresolvingSupport.foundItem(item, wid))
				return new UIObject(item);
		}
		return null;
	}
}




/********************************************************************** 
 * Copyright (c) 2005, 2006 IBM Corporation 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         
 * $Id: WeightedPropertyUIObjectIdentifier.java,v 1.3 2006/12/04 02:55:08 amehregani Exp $ 
 * 
 * Contributors: 
 * IBM - Initial API and implementation 
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.uiobject;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.eclipse.hyades.test.common.util.XMLUtil;

/**
 * Defines a widget Id by a set of properties that the widget must have. Each property is assigned a weight and if the total weight exceeds the
 * threshold, then the widget is identified as a match
 * 
 * @author Ali Mehregani
 */
public class WeightedPropertyUIObjectIdentifier implements IUIObjectIdentifier {

	private WeightedPropertyUIObjectIdentifier() {
	}

	public WeightedPropertyUIObjectIdentifier(Object[] propertyWeightPair, float threshold, String resolverId) {
		this.propertyWeightPair = propertyWeightPair;
		this.threshold = threshold;
		this.resolverId = resolverId;
	}

	private String resolverId;

	/*
	 * Stored elements are of type Object[2], where the first element is the value returned by the method corresponding to the property and the second
	 * value is the weight associated with that property.
	 */
	private Object[] propertyWeightPair;
	private float threshold;

	private final static Pattern pairPattern = Pattern.compile(".*?\\{\\{([^\\}]+)\\}\\}-\\{\\{([^\\}]+)\\}\\}.*");

	public boolean equals(Object obj) {
		String stringToCompare = null;
		boolean compare = false;

		/* The object is of our own kind */
		if (obj instanceof WeightedPropertyUIObjectIdentifier) {
			WeightedPropertyUIObjectIdentifier idToCompareWith = (WeightedPropertyUIObjectIdentifier) obj;

			if (this == idToCompareWith)
				return true;

			compare = true;
			stringToCompare = idToCompareWith.toString();
		}

		/* The object is a string (most likely coming from a macro) */
		else if (obj instanceof String) {
			compare = true;
			stringToCompare = (String) obj;
		}
		// ANy: equals has to be done on strings only, as a weigthed property id becomes a primitive one after loading (during playback)
		else if( obj instanceof IUIObjectIdentifier){
			compare = true;
			stringToCompare = ((IUIObjectIdentifier)obj).getWidgetId();
		}

		if (!compare)
			return false;

		/*
		 * Use regular expression to distinguish the returned value of each method from the weight
		 */
		float accumMatchRate = 0;
		int loopIterationNo = -1;

		while (stringToCompare.length() > 0 && (loopIterationNo + 1) < propertyWeightPair.length) {
			loopIterationNo++;
			Matcher pairTokenMatcher = pairPattern.matcher(stringToCompare);

			/* Discontinue if there is no match */
			if (!pairTokenMatcher.matches() || pairTokenMatcher.groupCount() != 2)
				break;

			/* Otherwise walk through each token */
			String originalProperty = pairTokenMatcher.group(1);
			String prop = originalProperty;
			if (prop.length() > 0)
				prop = XMLUtil.removeXMLSymbols(prop);
			float weight = Float.parseFloat(pairTokenMatcher.group(2));

			/* The ordering of the tokens for the IDs being compared must be the same. */
			Object[] propertyWeightPair = (Object[]) this.propertyWeightPair[loopIterationNo];
			if (!prop.equals("null") && (prop.length() > 0
				? prop.charAt(0) == ((String) propertyWeightPair[0]).charAt(0) || prop.charAt(0) == '&'
				: true) && (prop.equals(propertyWeightPair[0]) || prop.replaceAll("\\&",
				"").equals(propertyWeightPair[0]) || prop.replace('/',
				'\\').equals(propertyWeightPair[0])))
				accumMatchRate += Float.parseFloat((String) propertyWeightPair[1]);

			String currentToken = "{{" + originalProperty + "}}-{{" + weight + "}}";
			if (currentToken.equals(stringToCompare))
				break;

			int inx = stringToCompare.indexOf(currentToken);
			if (inx != -1)
				stringToCompare = stringToCompare.substring(inx + currentToken.length(),
					stringToCompare.length());

			else
				break; /* The control flow should never reach this block */

		}

		if (accumMatchRate >= threshold)
			return true;
		return false;
	}

	/**
	 * Return a string representation of this identifier. The property, weight information is organized in this format:
	 * {{property-value1}}-{{weight1}}{{property-value2}}:{{weight2}}
	 */
	public String getWidgetId() {
		String retValue = "";
		for (int i = 0; i < this.propertyWeightPair.length; i++)
			retValue += "{{" + ((Object[]) this.propertyWeightPair[i])[0] + "}}-{{" + ((Object[]) this.propertyWeightPair[i])[1] + "}}";

		return XMLUtil.useXMLSymbols(retValue);
	}

	public String toString() {
		return getWidgetId();
	}

	public float getThreshold() {
		return threshold;
	}

	// public void setThreshold(float threshold) {
	// this.threshold = threshold;
	// }

	public Object[] getPropertyWeightPair() {
		return propertyWeightPair;
	}

	// public void setPropertyWeightPair(Object[] propertyWeightPair) {
	// this.propertyWeightPair = propertyWeightPair;
	// }

	/**
	 * Walk through the properties and return true for as long as one of them is not null.
	 * 
	 * @return true if at least one property is not null; false otherwise
	 */
	public boolean noValidProperties() {
		if (propertyWeightPair == null)
			return true;

		for (int i = 0; i < propertyWeightPair.length; i++) {
			String property = (String) ((Object[]) propertyWeightPair[i])[0];
			if (property != null && !property.equals("null"))
				return false;
		}
		return true;
	}

	/**
	 * Convenient method available for clients to use in order to construct a weighted property id
	 * 
	 * @param properties
	 *            The (properties, weight) pairs of the item (weights should be a value between (0, 1])
	 * @param threshold
	 *            The threshold that this property should meet (should be a value between (0-1])
	 * @return Returns an instance of this class with the appropriate fields set.
	 */
	public static WeightedPropertyUIObjectIdentifier constructId(Object[] properties, float threshold, String resolverId) {
		/* Step through the properties and replace null values with the literal string null */
		for (int i = 0; i < properties.length; i++) {
			String property = (String) ((Object[]) properties[i])[0];
			if (property == null || property.length() <= 0)
				((Object[]) properties[i])[0] = "null";

		}

		WeightedPropertyUIObjectIdentifier widgetId = new WeightedPropertyUIObjectIdentifier(properties, threshold, resolverId);

		if (widgetId.noValidProperties())
			return null;
		return widgetId;
	}

	public String getResolverId() {
		return resolverId;
	}
	
	public String getObjectId(){
		// nested objects not supported by this resolver
		return null;
	}

	// public void setResolverId(String resolverId) {
	// this.resolverId = resolverId;
	// }
}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.macroobject;

import org.eclipse.jface.action.ContributionManager;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.wizard.IWizardPage;
import org.eclipse.jface.wizard.WizardDialog;
import org.eclipse.swt.custom.CTabItem;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Decorations;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.TabItem;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObject;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IViewPart;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.IWorkbenchWindow;

/**
 * 
 * @author Alexander Nyssen
 * 
 */
public class MacroObject implements IMacroObject {

	private Object context;
	private IUIObject uiObject;

	/**
	 * Constructor is used by MacroObjectResolver to instantiate a new
	 * MacroObject during deresolving of an IMacroObjectIdentifier
	 * 
	 * @param context
	 * @param uiObject
	 */
	public MacroObject(Object context, IUIObject uiObject) {
		this.uiObject = uiObject;
		this.context = context;
	}

	/**
	 * Constructor is used by clients when constructing a new MacroObject to
	 * pass it to the MacroObjectResolver to retrieve an IMacroObjectIdentifier.
	 * The context of the MacroObject is automatically detected based on the
	 * IUIObject passed in.
	 * 
	 * 
	 * @param uiObject
	 */
	public MacroObject(IUIObject uiObject) {
		this.uiObject = uiObject;
		this.context = retrieveContext(uiObject);
	}

	private Object retrieveContext(IUIObject uiObject) {
		Widget widget = uiObject.getWidget();
		if (widget instanceof MenuItem) {
			MenuItem menuItem = (MenuItem) widget;
			IViewPart view = null;
			if (MacroUtil.onMenubar(menuItem)) {
				// return the menu containing the item
				return menuItem.getParent().getShell().getMenuBar();
			} else if ((view = MacroUtil.onWorkbenchPartToolbar(menuItem)) != null) {
				// return the menu located on the action bar of the view
				// Note: formerly, the ToolBarManager was returned here,
				// however, this
				// was never used during resolving -> instead the MenuManager of
				// the action bar was used to find the menu.
				IMenuManager menuManager = view.getViewSite().getActionBars()
						.getMenuManager();
				if (menuManager != null && menuManager instanceof MenuManager) {
					Menu menu = ((MenuManager) menuManager).getMenu();
					if (menu == null) {
						// try to create menu
						((MenuManager) menuManager)
								.createMenuBar((Decorations) view.getSite()
										.getShell());
					}
					return menu;
				} else {
					return null;
				}
			} else {
				// popup menu item
				return widget.getDisplay().getFocusControl();
			}
		} else if (widget instanceof ToolItem) {
			ToolItem toolItem = (ToolItem) widget;
			ContributionManager contributionManager = null;
			if ((contributionManager = MacroUtil.onToolbar(toolItem)) != null) {
				// global toolbar
				return contributionManager;
			} else {
				// local toolbar
				return toolItem.getParent();
			}
		} else if (widget instanceof TabItem) {
			// ANy: Added to allow proper resolving of TabItems
			return ((TabItem) widget).getParent();
		} else if (widget instanceof CTabItem) {
			// ANy: Added to allow proper resolving of CTabItems
			return ((CTabItem) widget).getParent();
		}
		// else if (widget instanceof Shell) {
		// return ((Shell)widget).getData();
		// }
		else if (widget instanceof Control) {
			return retrieveControlContext(uiObject);
		}
		// ANy: it seems that Menus are actually never used as macro objects,
		// as the deresolver only has capability to deresolve menu items and not
		// menus,
		// so we will ignore this case here as well (the MacroObjectResolver
		// throws a CoreException if called with a MacroObject denoting a menu)

		// else if (widget instanceof Menu) {
		// return null;
		// }
		return null;
	}

	/**
	 * @param uiObject
	 */
	private Object retrieveControlContext(IUIObject uiObject) {
		if (uiObject.getWidget() instanceof Control) {
			Control control = (Control) uiObject.getWidget();
			Shell shell = control.getShell();
			Object data = shell.getData();
			if (data instanceof WizardDialog) {
				// in wizard
				WizardDialog wd = (WizardDialog) data;
				IWizardPage page = wd.getCurrentPage();
				if (page == null)
					return null;
				// check for wizard buttons
				if (control instanceof Button
						&& MacroUtil.onWizardDialog(wd, (Button) control)) {
					return wd;
				}
				// wizard page related
				else {
					return page;
				}
			} else if (data instanceof IWorkbenchWindow) {
				IWorkbenchWindow window = (IWorkbenchWindow) data;
				IWorkbenchPage page = window.getActivePage();

				/**
				 * Ali M.: Under some situations, the part that is returned by
				 * the 'getActivePart' method is the old active part. Although
				 * the control object is coming from the newly active part, the
				 * part that is retrieved below will be from the old active
				 * part. This will cause MacroUtil.getControlIdentifier to
				 * return null when attempting to retrieve the widget id in the
				 * wrong context. One situation that this fails under is when: -
				 * Macro recorder start while the test suite editor is active -
				 * A hook is inserted - The package view is focused (not
				 * activated and focused but just focused)
				 * 
				 * To resolve this issue, I have registered a part listener when
				 * the client starts recording. When there is a new active part
				 * detected, an event is created and fired to the usual onEvent
				 * handler in MacroManager. See MacroManager.hookPartListener.
				 */
				IWorkbenchPart part = page.getActivePart();
				if (part instanceof IViewPart || part instanceof IEditorPart) {
					return part;
				} else {
					return null;
				}
			} else {
				// an arbitrary control on a shell
				return shell;
			}
		}
		return null;
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObject#getUIObject()
	 */
	public IUIObject getUIObject() {
		return uiObject;
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObject#getContext()
	 */
	public Object getContext() {
		return context;
	}

}




1) Total refactoring of the widget resolving mechanism:
   	   	
   - The former widget resolving mechanism was totally revised. It now works as follows: IMacroObjects are resolved into IMacroObjectIdentifiers during recording in a two step process.
   	 First, the context of the IMacroObject is resolved into a contextId (by a newly introduced MacroObjectResolver), then the nested UIObject (widget with optional nested object) is 
   	 resolved into a IUIObjectIdentifier (by a newly introduced UIObjectResolver), which contains the info formerly captured in a WidgetIdentifier (widgetId, resolverId, optional objectId). 
   	 During playback the deresolving of IMacroObjectIdentifiers is done in the same two step process. The MacroObjectResolver locates (deresolves) the context, and the UIObjectResolver
   	 than locates the UIObject (under the given context). He delegates the resolving/deresolving of UIObjects/UIObjectIdentifiers to so called IUIObjectResolverDelegates, which are 
   	 loaded via a newly introduced extension point (which is a replacement of the former WigetResolver extension point).
   	
   - Different to the old WidgetResolvers, the newly introduced IUIObjectResolverDelegates are responsible not only to resolve a respective IUIObjectIdentifier
     for a given UIObject, but also to deresolve(i.e. relocating) a respective UIObject during playback (i.e. they take the second part of the two step deresolving mechanism). The old
     WidgetResolvers were migrated to the new IUIObjectResolverDelegate interface. A DeprecatedDeresolvingSupport class was introduced to preserve the old implementation that
     used the foundWidget method to relocated items. The WidgetIdentifier extension point was marked as deprecated. All extensions are loaded and adapterd dynamically to the new
     UIObjectResolverDelegate interface by using DeprecatedDeresolvingSupport
     
   - The new resolving/deresolving mechanism relies on that the computed IMacroObjectIdentifier are unique, i.e. the desired UIObject can be unambiguously identified in its context during playback. 
     An exception is now thrown, if a recorded id cannot be unambiguously resolved. The old implementation contained a hack for bug#147766, which played back commands for all found matches
     (or only the first one), which is not a valid solution. Consider the build.properties editor as an example. If checking an item of the SourceBuild-Tree during recording, the old 
     implementation would select the respectively named item in the BinaryBuild-Tree, as it plays the command for the first match. 
     I therefore propose to reopen bug#147766. It needs a proper fix that computes a unique IMacroObjectIdentifier for such tree items, so that during playback the single selected item 
     can be identified unambiguously. 
     
   - All commands that relied on resolving/deresolving widgets (and nested objects) where migrated to have a common superclass ObjectBasedCommand. All those object-based commands
   	 now rely on recording and playing back IMacroObjects. An IMacroObject (formerly CommandTarget) consists of a context and a UIObject, which is a widget or a nested object on 
   	 a widget (e.g. a String item on a ComboBox). 
     
   - The listener registration for Workbench closing events was extracted from the resolving mechanism (was located as a side effect in MacroUtil.getWidgetIdentifier()), the resolving/deresolving
     is now side-effect free.
     
2) Refactored ObjectMining. Renamed UIObject to MacroObjectDescriptor and ObjectMine into MacroObjectMine, UIObjectMineManager into MacroObjectManager to reflect what is actually stored in it. 
   - Refactored the identifier providing mechanism; a new MacroObjectDescriptor is now equipped with a unique id internally by the object mine when registering the object
   - Removed the unneeded abstraction interface IUIObject (which is now used to represent a UIObject, i.e. a widget and a respective nested object) and unneeded corresponding IUIObjectMine interface.

4) Refactored VerficationCommand to be handled as all other object-based commands 
   - moved static construction method out changed constructor signature of Verification command to be in line with other object-based commands
   - refactored loading/writing to rely on super implemenation where possible
   - Removed VerficationMetaData which is now not needed any more (as in case of other commands that do not have something like this as well)
   - Implemented enhancements to verification hook insertion (i.e. resolved bug #201248). It now supports an extented mode (that is also needed in case of Draw2d). In extended
   	 mode, verification does not rely on the context but also on a selected UIObject (i.e. widget and possibly nested object). 
   	 
5) Introduced a command factory that encapsulates creation of commands (factored respective code out of MacroCommandShell). Introduced a respective extension point
   to replace the command factory. This will be needed to add support for draw2d, as the commands are responsible of locating their respective macro objects in a respective event,
   and the default implementation of the commands do not pay any interest to nested objects beyond the widget level (e.g. Figures on a FigureCanvas).

6) Refactored MacroManager
   - moved event constants into EventConstants interface, which defines the custom event types and details
   - moved mode constants into own ModeConstants interface

7) Removed unneeded IRecorderListener interface (never used)
 
8) Fixed that in Eclispe Ganymede, when closing an unsaved editor, the workbench close command was created after the message dialog selection command.

9) Introduced mouse move commands to explitly capture mouse move events, as needed to test GEF-applications.

10) Several minor fixes and cleanups.

TODO:
 - Migrate BooleanSelectionCommand and AbstractStructuredCommand to fully use the new resolving/deresolving mechanisms for macro objects (they are still based on parts
   of the old resolving mechanism, respectively do resolving/deresolving on their own), which should be taken care of.




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.macro;


/**
 * @author Alexander Nyssen
 */
public interface ModeConstants {

	/* Global states */
	public static final byte RECORDING_MODE = 0x00; /* Recording mode */
	public static final byte VERIFICATION_MODE = 0x01; /* Verification mode */
	public static final byte SUSPEND_MODE = 0x02; /* Suspend mode */
	public static final byte QUICK_RUN_MODE = 0x03; /* Quick run mode (when current workbench is used as the context) */
	public static final byte EXECUTION_RUN_MODE = 0x04; /* Execution run mode (when proper launch configuration is used) */
	public static final byte IDLE_MODE = 0x05; /* Idle mode */
	public static final byte POSITION_BASED_REC_MODE = 0x06; /* Position based recording */
}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.commands.factory;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.Platform;

/**
 * Helper class to load a IMacroCommandFactory via the respective extension
 * point. Only the factory with the highest priority is used. All other
 * factories are disregarded.
 * 
 * @author Alexander Nyssen
 * 
 */
public class MacroCommandFactoryLoader {

	private static final String EXTENSION_POINT_NAME = "macroCommandFactory";
	private static final String EXTENSION_POINT_ID = "org.eclipse.tptp.test.auto.gui."
			+ EXTENSION_POINT_NAME;

	private static IMacroCommandFactory factory = null;

	/**
	 * Retrieves the factory with the highest priority, meaning the lowest
	 * priority number, i.e. a priority of 1 is greater than one of 2.
	 * 
	 * @return
	 */
	public static IMacroCommandFactory getHighestPriorityFactory() {
		if (factory == null) {
			factory = retrieveFactoryWithHighestPriority();
		}
		return factory;
	}

	private static IMacroCommandFactory retrieveFactoryWithHighestPriority() {
		IConfigurationElement[] elements = Platform.getExtensionRegistry()
				.getConfigurationElementsFor(EXTENSION_POINT_ID);

		IMacroCommandFactory factory = null;
		int priority = Integer.MAX_VALUE;
		for (int i = 0; i < elements.length; i++) {
			if (EXTENSION_POINT_NAME.equals(elements[i].getName())) {
				try {
					IMacroCommandFactory currentFactory = (IMacroCommandFactory) elements[i]
							.createExecutableExtension("class");
					int currentPriority = Integer.parseInt(elements[i]
							.getAttribute("priority"));

					if (currentFactory != null && currentPriority < priority) {
						factory = currentFactory;
						priority = currentPriority;
					}
				} catch (CoreException e) {
					e.printStackTrace();
				}
			}
		}
		return factory;
	}
}




/*******************************************************************************
 * Copyright (c) 2003, 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.util;

import java.util.Hashtable;
import java.util.Stack;

import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;

import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.Text;
import org.xml.sax.Attributes;
import org.xml.sax.Locator;
import org.xml.sax.helpers.DefaultHandler;

public class XMLDefaultHandler extends DefaultHandler
{

	private org.w3c.dom.Document fDocument;

	private Locator fLocator;

	private Hashtable fLineTable;

	private Element fRootElement;

	private Stack fElementStack = new Stack();
	
	/* Indicates whether a CDATA section is reached */
	private boolean cdataStarted;

	public XMLDefaultHandler()
	{
		fLineTable = new Hashtable();
	}

	public void startElement(String uri, String localName, String qName, Attributes attributes)
	{
		Element element = fDocument.createElement(qName);
		for (int i = 0; i < attributes.getLength(); i++)
		{
			element.setAttribute(attributes.getQName(i), attributes.getValue(i));
		}

		Integer lineNumber = new Integer(fLocator.getLineNumber());
		Integer[] range = new Integer[] { lineNumber, new Integer(-1) };
		fLineTable.put(element, range);
		if (fRootElement == null)
			fRootElement = element;
		else
			((Element) fElementStack.peek()).appendChild(element);
		fElementStack.push(element);
	}

	public void endElement(String uri, String localName, String qName)
	{
		Integer[] range = (Integer[]) fLineTable.get(fElementStack.pop());
		range[1] = new Integer(fLocator.getLineNumber());
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.xml.sax.helpers.DefaultHandler#setDocumentLocator(org.xml.sax.Locator)
	 */
	public void setDocumentLocator(Locator locator)
	{
		fLocator = locator;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.xml.sax.helpers.DefaultHandler#startDocument()
	 */
	public void startDocument()
	{
		DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
		try
		{
			fDocument = factory.newDocumentBuilder().newDocument();
		}
		catch (ParserConfigurationException e)
		{
		}
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.xml.sax.helpers.DefaultHandler#endDocument()
	 */
	public void endDocument()
	{
		fDocument.appendChild(fRootElement);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.xml.sax.helpers.DefaultHandler#processingInstruction(java.lang.String,
	 *      java.lang.String)
	 */
	public void processingInstruction(String target, String data)
	{
		fDocument.appendChild(fDocument.createProcessingInstruction(target, data));
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.xml.sax.helpers.DefaultHandler#characters(char[], int, int)
	 */
	public void characters(char[] characters, int start, int length)
	{
		StringBuffer buff = new StringBuffer();
		for (int i = 0; i < length; i++)
		{
			buff.append(characters[start + i]);
		}

		String buffValue = buff.toString();	
		boolean isBufferJustWhiteSpace = buffValue.trim().equals("");
		boolean isBufferEmpty = buffValue.length() <= 0;
		
		if ((cdataStarted && isBufferEmpty) || (!cdataStarted && isBufferJustWhiteSpace))
		{
			cdataStarted = false;
			return;
		}
				
		Text text = fDocument.createTextNode(buffValue);
		cdataStarted = true;
		if (fRootElement == null)
			fDocument.appendChild(text);
		else
			((Element) fElementStack.peek()).appendChild(text);
	}
	
	public Node getDocumentElement()
	{
		fDocument.getDocumentElement().normalize();
		return fDocument.getDocumentElement();
	}

	public org.w3c.dom.Document getDocument()
	{
		fDocument.getDocumentElement().normalize();
		return fDocument;
	}

	public Hashtable getLineTable()
	{
		return fLineTable;
	}
}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.uiobject;

import org.eclipse.swt.widgets.Widget;


/**
 * Represents a widget or a nested object on a widget (e.g. a String item on a ComboBox)
 * 
 * @author ANy
 * @version $Revision$
 *
 */
public class UIObject implements IUIObject {

	private Widget widget = null;
	private Object object = null;
	
	public UIObject(Widget widget, Object object) {
		super();
		this.widget = widget;
		this.object = object;
	}
	
	public UIObject(Widget widget) {
		super();
		this.widget = widget;
	}

	public Object getObject() {
		return object;
	}
	
	public Widget getWidget() {
		return widget;
	}	
}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.macroobject;

import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObject;

/**
 * @author Alexander Nyssen
 */
public interface IMacroObject {

	public abstract Object getContext();

	public abstract IUIObject getUIObject();

}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.macro;


/**
 * @author Alexander Nyssen
 */
public interface EventConstants {

	/* Custom event types */
	/* Indicates that a workbnech part has been closed */
	public static final int EVENT_TYPE__WORKBENCH_PART_CLOSED = -1;
	
	/* Custom event details */
	public static final int EVENT_DETAIL__POSITION_BASED_EVENT = Integer.MIN_VALUE;
	
	public static final int EVENT_DETAIL__VERIFICATION_HOOK_INSERTION_EVENT = Integer.MIN_VALUE + 1;
}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.commands.factory;

import java.util.ArrayList;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.swt.widgets.Event;
import org.eclipse.tptp.test.auto.gui.internal.commands.IMacroCommand;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;

/**
 * Factory to create commands to record certain events or to create respective commands during playback
 * 
 * @author Alexander Nyssen
 * 
 */
public interface IMacroCommandFactory {

	/**
	 * Factory method to create a new IMacroCommand during recording. This
	 * method is called by the command shell for every event it processes.
	 * Multiple calls to this method for succeeding events may be necessary,
	 * before an event is actually created and returned).
	 * 
	 * @param commandShell
	 * @param commands
	 * @param event
	 * @return
	 * @throws CoreException
	 */
	public IMacroCommand createCommand(MacroCommandShell commandShell,
			ArrayList commands, Event event) throws CoreException;
	
	
	/**
	 * Factory method to create a command instance for a certain command type. This
	 * method is called during playback to obtain a command that can then be played-back.
	 * 
	 * @param commandShell 
	 * @param type
	 * @return
	 * @throws CoreException
	 */
	public IMacroCommand createCommand(MacroCommandShell commandShell, String type) throws CoreException;

}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate;

import java.util.Hashtable;
import java.util.Vector;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.Platform;
import org.eclipse.tptp.test.auto.gui.internal.core.WidgetResolverLoader;
import org.eclipse.tptp.test.auto.gui.internal.core.WidgetResolverLoaderToUIObjectResolverDelegateLoaderAdapter;

/**
 * This class delivers utility methods to load UIObjectResolverDelegates via the
 * uiObjectResolverDelegate extension point. It also loads all extensions to the
 * deprecated widgetResolver extension point and adapts them to the new
 * interface.
 * 
 * @author Alexander Nyssen
 * 
 */
public class UIObjectResolverDelegateRegistry {

	private static final String EXTENSION_POINT_NAME = "uiObjectResolverDelegate";
	private static final String EXTENSION_POINT_ID = "org.eclipse.tptp.test.auto.gui." 
			+ EXTENSION_POINT_NAME;

	/* Keeps an ordered list of the primitive resolver ids */
	private static String[] resolverIds;

	/*
	 * The widget resolver: KEY = resolver id VALUE = A class of type
	 * UIObjectResolverDelegateLoader
	 */
	private static Hashtable uiObjectDelegateResolverLoaders = new Hashtable();

	/**
	 * Load the registered widget resolvers. The widget resolvers are ordered in
	 * the descending order of their priority
	 */
	private static void loadDelegateResolvers() {
		IConfigurationElement[] elements = Platform.getExtensionRegistry()
				.getConfigurationElementsFor(EXTENSION_POINT_ID);
		Vector tempContainer = new Vector(elements.length);

		for (int i = 0; i < elements.length; i++) {
			UIObjectResolverDelegateLoader uiObjectResolverDelegateLoader = constructUIObjectResolverLoaderInstance(elements[i]);
			if (uiObjectResolverDelegateLoader != null) {
				tempContainer.add(findIndex(uiObjectResolverDelegateLoader
						.getPriority(), tempContainer),
						uiObjectResolverDelegateLoader);
				uiObjectDelegateResolverLoaders.put(
						uiObjectResolverDelegateLoader.getId(),
						uiObjectResolverDelegateLoader);
			}
		}

		// Also add the implementors of the old widgetResolver extension point.
		// They are adapted to the new extension point using respective adapters
		WidgetResolverLoader[] widgetResolverLoaders = WidgetResolverLoader
				.getWidgetResolverLoaders();
		for (int i = 0; i < widgetResolverLoaders.length; i++) {
			UIObjectResolverDelegateLoader uiObjectResolverDelegateLoader = new WidgetResolverLoaderToUIObjectResolverDelegateLoaderAdapter(
					widgetResolverLoaders[i]);
			tempContainer.add(findIndex(widgetResolverLoaders[i].getPriority(),
					tempContainer), uiObjectResolverDelegateLoader);

			uiObjectDelegateResolverLoaders.put(uiObjectResolverDelegateLoader
					.getId(), uiObjectResolverDelegateLoader);
		}

		resolverIds = new String[tempContainer.size()];
		for (int i = 0; i < resolverIds.length; i++) {
			resolverIds[i] = ((UIObjectResolverDelegateLoader) tempContainer
					.get(i)).getId();
		}
	}

	private static int findIndex(int desiredPriority, Vector container,
			int startIntervalInx, int endIntervalInx, int length) {
		if (startIntervalInx == endIntervalInx
				|| startIntervalInx == endIntervalInx - 1) {
			if (length > 0) {
				UIObjectResolverDelegateLoader widgetResolverReg = (UIObjectResolverDelegateLoader) container
						.get(startIntervalInx);
				int priority = widgetResolverReg.getPriority();
				if (desiredPriority < priority)
					return startIntervalInx;
			}
			return endIntervalInx;
		}

		/* What's in the middle? */
		int middleInx = startIntervalInx
				+ (int) Math.ceil((endIntervalInx - startIntervalInx) / 2);
		UIObjectResolverDelegateLoader widgetResolverReg = (UIObjectResolverDelegateLoader) container
				.get(middleInx);
		int middleElementPriority = widgetResolverReg.getPriority();

		if (middleElementPriority > desiredPriority)
			endIntervalInx = middleInx;
		else if (middleElementPriority < desiredPriority)
			startIntervalInx = middleInx;
		else
			return middleInx;
		return findIndex(desiredPriority, container, startIntervalInx,
				endIntervalInx, length);
	}

	private static int findIndex(int priority, Vector container) {
		int length = container.size();
		return findIndex(priority, container, 0, length, length);
	}

	/**
	 * This method should not be called by clients. It is only used from 
	 * UIObjectDeprecatedDeresolvingSupport 
	 * 
	 * @return
	 */
	public static Hashtable getDelegateResolverLoaders() {
		if (resolverIds == null) {
			UIObjectResolverDelegateRegistry.loadDelegateResolvers();
		}
		return uiObjectDelegateResolverLoaders;
	}

	/**
	 * Returns the list of resolver delegates, sorted by priority
	 * 
	 * @return
	 */
	public static IUIObjectResolverDelegate[] getDelegateResolvers() {
		if (resolverIds == null) {
			UIObjectResolverDelegateRegistry.loadDelegateResolvers();
		}

		IUIObjectResolverDelegate[] resolvers = new IUIObjectResolverDelegate[resolverIds.length];
		for (int i = 0; i < resolverIds.length; i++) {
			resolvers[i] = ((UIObjectResolverDelegateLoader) uiObjectDelegateResolverLoaders
					.get(resolverIds[i])).getUIObjectResolverDelegate();
		}
		return resolvers;
	}

	public static final IUIObjectResolverDelegate getDelegateResolver(
			String resolverId) {
		if (resolverIds == null) {
			UIObjectResolverDelegateRegistry.loadDelegateResolvers();
		}

		UIObjectResolverDelegateLoader widgetResolverLoader = (UIObjectResolverDelegateLoader) uiObjectDelegateResolverLoaders
				.get(resolverId);
		return widgetResolverLoader.getUIObjectResolverDelegate();
	}

	/**
	 * Constructs an instance of this class based on the configuration element
	 * passed in
	 * 
	 * @param confiugrationElement
	 *            The configuration element to be loaded
	 * @return An instance of this class based on the configuration element
	 *         passed in. null will be returned if there is an error loading the
	 *         configuration element.
	 */
	private static UIObjectResolverDelegateLoader constructUIObjectResolverLoaderInstance(
			IConfigurationElement configurationElement) {
		String name = configurationElement.getName();
		if (!EXTENSION_POINT_NAME.equals(configurationElement.getName()))
			return null;

		try {
			String id = configurationElement.getAttribute("id");
			IUIObjectResolverDelegate uiObjectResolverDelegate = (IUIObjectResolverDelegate) configurationElement
					.createExecutableExtension("class");
			int priority = Integer.parseInt(configurationElement
					.getAttribute("priority"));

			if (id == null || uiObjectResolverDelegate == null)
				return null;

			return new UIObjectResolverDelegateLoader(id,
					uiObjectResolverDelegate, priority);

		} catch (CoreException e) {
			e.printStackTrace();
		}

		return null;
	}

}




/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macroobject.mine;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.util.Hashtable;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
import org.eclipse.hyades.models.common.facades.behavioral.impl.HyadesUtil;
import org.eclipse.hyades.test.core.util.EMFUtil;
import org.eclipse.hyades.test.tools.ui.common.internal.util.FormUtil;
import org.eclipse.osgi.util.NLS;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine.IDCollisionException;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.mine.MacroObjectDescriptorMine.UIObjectNotFound;
import org.eclipse.tptp.test.auto.gui.internal.util.XMLDefaultHandler;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;

/**
 * In addition to the macro of each test case, a test suite also contains an
 * object mine keeps a reference of all resolved objects. The purpose of the
 * object mine is to resolve a widget once and use it many times.
 * 
 * This is a singleton class that can be accessed via <code>getInstance()</code>
 * 
 * @author Ali Mehregani
 */
public class MacroObjectDescriptorMineManager {
	/** The instance of this class */
	private static MacroObjectDescriptorMineManager instance = new MacroObjectDescriptorMineManager();

	/**
	 * Cached object mines KEY = Test suite id VALUE = An object of type
	 * MacroObjectDescriptorMine that represents the object mine of the test
	 * suite
	 */
	private Hashtable cachedObjectMines;

	/**
	 * Indicates whether a test suite's object mine is dirty or not KEY = test
	 * suite id VALUE = Boolean.TRUE if object mine is dirty; Boolean.FALSE
	 * otherwise
	 */
	private Hashtable dirtyStateTable;

	/**
	 * Restrict the visibility of the constructor
	 */
	private MacroObjectDescriptorMineManager() {
		cachedObjectMines = new Hashtable();
		dirtyStateTable = new Hashtable();
	}

	/**
	 * Return the instance of this singleton class
	 * 
	 * @return The instance of this class
	 */
	public static MacroObjectDescriptorMineManager getInstance() {
		return instance;
	}

	/**
	 * Load the object mine of the passed in test suite
	 * 
	 * @param testSuite
	 *            The test suite whose object mine is requested
	 * @param useCache
	 *            Uses the cached value if this is set to true; otherwise the
	 *            object mine is reloaded and returned.
	 * 
	 * @return the object mine of the test suite that is passed in.
	 * 
	 * @throws UIObjectNotFound
	 *             In case an expected object is not found
	 * @throws IDCollisionException
	 *             In case there is a collision id
	 * @throws CoreException
	 *             In case of any unexpected error
	 */
	public MacroObjectDescriptorMine loadObjectMine(ITestSuite testSuite,
			boolean useCache) throws UIObjectNotFound, IDCollisionException,
			CoreException {
		/* Is the object mine in cache? */
		String testSuiteId = testSuite.getId();
		MacroObjectDescriptorMine objectMine = null;
		if (useCache
				&& (objectMine = (MacroObjectDescriptorMine) cachedObjectMines
						.get(testSuiteId)) != null) {
			objectMine.setOwner(testSuite);
			return objectMine;
		}

		/*
		 * Otherwise, it needs to be loaded. We need: - Get the object mine XML
		 * fragment - Parse it and load it
		 */
		String objectMineXML = HyadesUtil.getTestSuiteVariable(testSuite,
				GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE);
		if (objectMineXML == null || objectMineXML.length() <= 0) {
			/* Return a fresh object mine */
			objectMine = new MacroObjectDescriptorMine(testSuite, null);
		}

		if (objectMine == null) {
			objectMine = loadObjectMine(testSuite, objectMineXML);
		}

		if (objectMine != null) {
			cachedObjectMines.put(testSuiteId, objectMine);
		}

		return objectMine;
	}

	private MacroObjectDescriptorMine loadObjectMine(ITestSuite testSuite,
			String objectMineXML) throws UIObjectNotFound,
			IDCollisionException, CoreException {
		if (objectMineXML == null || objectMineXML.length() <= 0)
			return new MacroObjectDescriptorMine(testSuite, null);

		XMLDefaultHandler handler = null;

		try {
			handler = MacroUtil.createXMLDocument(new ByteArrayInputStream(
					objectMineXML.getBytes("UTF-8")));
		} catch (SAXException e) {
			AutoGUIUtil.throwCoreException(
					AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE, 0, e);
		} catch (IOException e) {
			AutoGUIUtil.throwCoreException(
					AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE, 0, e);
		}

		/* Walk through the elemets and parse the document */
		Node rootElement = handler.getDocumentElement();
		NodeList children = rootElement.getChildNodes();

		MacroObjectDescriptorMine objectMine = new MacroObjectDescriptorMine(
				testSuite, handler);
		for (int i = 0, childCount = children.getLength(); i < childCount; i++) {
			Node currentChild = children.item(i);
			String nodeName = currentChild.getNodeName();
			if (MacroConstants.HEADER_ELEMENT.equals(nodeName)) {
				loadHeader(objectMine, currentChild);
			} else if (MacroConstants.OBJECTS_ELEMENT.equals(nodeName)) {
				loadObjects(objectMine, currentChild);
			}
		}

		return objectMine;
	}

	/**
	 * This method should be used if the object mine will be loaded for reading
	 * purposes. Contributors will not be able to use this returned object mine
	 * to write any objects.
	 * 
	 * @param objectMineXML
	 *            The XML string representing the object mine
	 * 
	 * @return the object mine of the test suite that is passed in.
	 * 
	 * @throws UIObjectNotFound
	 *             In case an expected object is not found
	 * @throws IDCollisionException
	 *             In case there is a collision id
	 * @throws CoreException
	 *             In case of any unexpected error
	 */
	public MacroObjectDescriptorMine loadObjectMine(String objectMineXML)
			throws UIObjectNotFound, IDCollisionException, CoreException {
		return loadObjectMine(null, objectMineXML);
	}

	private void loadHeader(MacroObjectDescriptorMine objectMine,
			Node headerNode) throws CoreException, UIObjectNotFound,
			IDCollisionException {
		/* Let's first read in the contribute attribute */
		NamedNodeMap attributes = headerNode.getAttributes();
		Node contributeAtt = attributes
				.getNamedItem(MacroConstants.OUTPUT_ATTRIBUTE);
		if (contributeAtt != null) {
			ITestSuite testSuite = loadTestSuite(contributeAtt.getNodeValue());
			if (testSuite == null) {
				AutoGUIUtil.openErrorWithDetail(
						AutoGUIMessages.AUTO_GUI_COMMON_ERROR,
						AutoGUIMessages.AUTO_GUI_ERROR_OBJ_MINE_OUT_NF, null);

			} else {
				try {
					MacroObjectDescriptorMine outputObjectMine = MacroObjectDescriptorMineManager
							.getInstance().loadObjectMine(testSuite);
					objectMine.setOutputSource(outputObjectMine);
				} catch (Exception e) {
					objectMine.setOutputSource(null);
					AutoGUIUtil
							.openErrorWithDetail(
									AutoGUIMessages.AUTO_GUI_COMMON_ERROR,
									NLS
											.bind(
													AutoGUIMessages.AUTO_GUI_ERROR_OBJ_MINE_OUTPUT,
													testSuite.getName()), e);
				}
			}
		}

		/* Now load in all includes */
		NodeList children = headerNode.getChildNodes();
		for (int i = 0, childCount = children.getLength(); i < childCount; i++) {
			Node currentChild = children.item(i);
			String nodeName = currentChild.getNodeName();
			if (MacroConstants.INCLUDE_ELEMENT.equals(nodeName)) {
				Node pathAttribute = currentChild.getAttributes().getNamedItem(
						MacroConstants.PATH_ATTRIBUTE);
				if (pathAttribute != null) {
					ITestSuite testSuite = loadTestSuite(pathAttribute
							.getNodeValue());
					MacroObjectDescriptorMine includedObjectMine = loadObjectMine(testSuite);
					objectMine.addInclude(includedObjectMine);
				}
			}
		}
	}

	private void loadObjects(MacroObjectDescriptorMine objectMine,
			Node objectsNode) throws CoreException, UIObjectNotFound,
			IDCollisionException {
		NodeList children = objectsNode.getChildNodes();
		registerObjects(objectMine, null, children);
	}

	private void registerObjects(MacroObjectDescriptorMine objectMine,
			MacroObjectDescriptor parent, NodeList children)
			throws CoreException, UIObjectNotFound, IDCollisionException {
		/* For every object */
		for (int i = 0, childCount = children.getLength(); i < childCount; i++) {
			Node currentNode = children.item(i);

			NamedNodeMap attributes = currentNode.getAttributes();
			Node referenceIdNode = attributes
					.getNamedItem(MacroConstants.REFERENCE_ID_ATTRIBUTE);
			String referenceId = null;
			if (referenceIdNode == null
					|| (referenceId = referenceIdNode.getNodeValue()) == null) {
				Node widetIdAttribute = attributes
						.getNamedItem(MacroConstants.WIDGET_ID_ATTRIBUTE);
				Node objectIdAttribute = attributes
						.getNamedItem(MacroConstants.OBJECT_ID_ATTRIBUTE);
				String widgetId = widetIdAttribute == null ? AutoGUIMessages.AUTO_GUI_COMMON_UNKNOWN
						: widetIdAttribute.getNodeValue();
				String objectId = objectIdAttribute == null ? AutoGUIMessages.AUTO_GUI_COMMON_UNKNOWN
						: objectIdAttribute.getNodeValue();
				AutoGUIUtil.throwCoreException(NLS.bind(
						AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE_REF,
						widgetId, objectId), 0);
			}

			MacroObjectDescriptor guiObject = objectMine
					.lookupMacroObjectDescriptor(parent, referenceId);

			/* Register the object if it's not yet registered */
			if (guiObject == null) {
				guiObject = objectMine.registerObject(parent, currentNode);
			}
			/* Otherwise throw an exception if there is an id collision */
			else {
				Node contextIdNode = attributes
						.getNamedItem(MacroConstants.CONTEXT_ID_ATTRIBUTE);
				Node widgetIdNode = attributes
						.getNamedItem(MacroConstants.WIDGET_ID_ATTRIBUTE);
				Node objectIdNode = attributes
						.getNamedItem(MacroConstants.OBJECT_ID_ATTRIBUTE);
				String contextId = contextIdNode == null ? null : contextIdNode
						.getNodeValue();
				String widgetId = widgetIdNode == null ? null : widgetIdNode
						.getNodeValue();
				String objectId = objectIdNode == null ? null : objectIdNode
						.getNodeValue();

				if (((contextId == null && guiObject.getContextId() != null) || (contextId != null && !contextId
						.equals(guiObject.getContextId())))
						|| ((widgetId == null && guiObject.getWidgetId() != null) || (widgetId != null && !widgetId
								.equals(guiObject.getWidgetId())))
						|| ((objectId == null && guiObject.getObjectId() != null) || (objectId != null && !objectId
								.equals(guiObject.getObjectId())))) {
					throw new IDCollisionException(NLS.bind(
							AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE_ID,
							referenceId));
				}
			}

			/* Load the children of this object */
			if (currentNode.getChildNodes().getLength() > 0)
				registerObjects(objectMine, guiObject, currentNode
						.getChildNodes());
		}
	}

	private ITestSuite loadTestSuite(String testSuitePath) throws CoreException {
		if (testSuitePath == null || testSuitePath.length() <= 0)
			return null;

		IPath path = new Path(testSuitePath);
		URI uri = URI.createPlatformResourceURI(path.toString());
		EObject[] eObjects = EMFUtil.getEObjects(uri, true);
		return eObjects != null && eObjects.length > 0
				&& eObjects[0] instanceof ITestSuite ? (ITestSuite) eObjects[0]
				: null;
	}

	public void writeObjectMine(MacroObjectDescriptorMine objectMine) {
		writeObjectMine(objectMine, false);
	}

	private void writeObjectMine(MacroObjectDescriptorMine objectMine,
			boolean autoSave) {
		ITestSuite testSuite = objectMine.getOwner();
		Resource testSuiteResource = ((EObject) testSuite).eResource();
		autoSave = autoSave
				&& (testSuiteResource != null && !testSuiteResource
						.isModified());

		String xmlSerialization = objectMine.serializeToString();
		HyadesUtil.setTestSuiteVariable(testSuite,
				GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE,
				xmlSerialization);

		if (autoSave) {
			try {
				EMFUtil.save(testSuiteResource);
			} catch (Exception e) {
				/* Shouldn't happen */
				e.printStackTrace();
			}
		}

		/*
		 * We also need to update all object mines included by the object mine
		 * passed in
		 */
		List includes = objectMine.getIncludes();
		for (int i = 0, includeCount = includes.size(); i < includeCount; i++) {
			MacroObjectDescriptorMine currentObjectMine = (MacroObjectDescriptorMine) includes
					.get(i);
			writeObjectMine(currentObjectMine, true);
		}

		dirtyStateTable.put(testSuite.getId(), Boolean.TRUE);
	}

	public MacroObjectDescriptorMine loadObjectMine(ITestSuite testSuite)
			throws UIObjectNotFound, IDCollisionException, CoreException {
		Boolean dirtyState = (Boolean) dirtyStateTable.get(testSuite.getId());
		boolean isObjectMineDirty = dirtyState == null ? false : dirtyState
				.booleanValue();
		dirtyStateTable.put(testSuite.getId(), Boolean.FALSE);
		return loadObjectMine(testSuite, !isObjectMineDirty);
	}

	/**
	 * Marks the object mine of the passed in test suite as dirty
	 * 
	 * @param testSuite
	 *            The test suite
	 */
	public void markObjectMineDirty(ITestSuite testSuite) {
		if (testSuite == null)
			return;

		dirtyStateTable.put(testSuite.getId(), Boolean.TRUE);
	}

	/**
	 * Removes all entries in cache. This should be carefully used.
	 */
	public void clearCache() {
		cachedObjectMines.clear();
	}
}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.osgi.util.NLS;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.IUIObjectResolverDelegate;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.NonTrivialUIObjectResolverDelegate;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.UIObjectResolverDelegateRegistry;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.UIObjectResolverDelegateLoader;

/**
 * This is a facade that encapsulates resolving/deresolving of UI objects. It
 * delegates to the respective UIObjectDelegateResolvers that can be plugged in
 * via the respective extension point
 * <code>org.eclipse.tptp.auto.gui.uiObjectResolverDelegate</code>.
 * 
 * @author Alexander Nyssen
 * 
 */
public class UIObjectResolver {

	public static IUIObjectIdentifier resolve(Object context, IUIObject uiObject)
			throws CoreException {

		IUIObjectResolverDelegate[] delegateResolvers = UIObjectResolverDelegateRegistry
				.getDelegateResolvers();
		IUIObjectIdentifier identifier = null;
		for (int i = 0; i < delegateResolvers.length && identifier == null; i++) {
			identifier = delegateResolvers[i].resolve(context, uiObject);

			if (identifier != null) {
				// check if the resolver delegate has set its id into the
				// returned
				// identifier
				if (identifier.getResolverId() == null) {
					AutoGUIUtil
							.throwCoreException(NLS
									.bind(
											AutoGUIMessages.AUTO_GUI_RESOLVER_IDENTIFIER_MISSING,
											delegateResolvers[i]));
					return null;
				}
			}
		}

		return identifier;
	}

	public static IUIObject deresolve(Object context,
			IUIObjectIdentifier uiObjectIdentifier) throws CoreException {
		// we need to obtain the resolver id to be able to delegate to the
		// respective UIObjectResolverDelegate
		String resolverId = uiObjectIdentifier.getResolverId();
		if (resolverId == null) {
			// if we do not have a resolver id, use one of the old registered
			// ones, as they all
			// have the same deprecated deresolving mechanism
			return UIObjectResolverDelegateRegistry.getDelegateResolver(
					NonTrivialUIObjectResolverDelegate.ID).deresolve(context,
					uiObjectIdentifier);
		}
		return UIObjectResolverDelegateRegistry.getDelegateResolver(resolverId)
				.deresolve(context, uiObjectIdentifier);

	}

}




/*******************************************************************************
 * Copyright (c) 2006, 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.uiobject;

/**
 * A primitive string UI object identifier. The string object must be an exact
 * match for the two given ids to equal. Contributors can extend this class or
 * provide a direct implementation of {@link IUIObjectIdentifier}
 * 
 * @author Ali Mehregani
 * @author Alexander Nyssen
 */
public class PrimitiveUIObjectIdentifier implements IUIObjectIdentifier {

	/** The resolver objectId */
	private String resolverId;
	
	private String widgetId;

	/** The string objectId of the object */
	private String objectId;

	public PrimitiveUIObjectIdentifier(String widgetId) {
		this.widgetId = widgetId;
	}

	public PrimitiveUIObjectIdentifier(String widgetId, String resolverId) {
		this.widgetId = widgetId;
		this.resolverId = resolverId;
	}
	
	public PrimitiveUIObjectIdentifier(String widgetId, String objectId, String resolverId) {
		this.widgetId = widgetId;
		this.objectId = objectId;
		this.resolverId = resolverId;
	}

	public String getResolverId() {
		return resolverId;
	}

	public void setResolverId(String resolverId) {
		this.resolverId = resolverId;
	}

	public String getWidgetId() {
		return widgetId;
	}
	
	public String getObjectId(){
		return objectId;
	}

	public boolean equals(Object obj) {
		if (!(obj instanceof PrimitiveUIObjectIdentifier)) {
			return false;
		} else {
			PrimitiveUIObjectIdentifier other = (PrimitiveUIObjectIdentifier) obj;
			boolean equals = (widgetId == null) ? other.widgetId == null
					: widgetId.equals(other.widgetId);
			return equals;
		}
	}

	public String toString() {
		return widgetId;
	}
	

}




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.uiobject;


/**
 * @author Alexander Nyssen
 */
public interface IUIObjectIdentifier {

	/**
	 * Returns the id of the widget object to be identified
	 * 
	 * @return The widget id
	 */
	public String getWidgetId();
	
	/**
	 * Returns the id of the nested object to be identified on the respective widget,
	 * e.g. a String to name an item on a ComboBox.
	 * @return The id of the nested object
	 */
	public String getObjectId();
	
	/**
	 * Returns the id of the ui object resolver delegate that generated this identifier.
	 * 
	 * @return The id of the ui object resolver delegate that generated this identifier.
	 */
	public String getResolverId();

	
}




<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.tptp.test.auto.gui" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
      <appinfo>
         <meta.schema plugin="org.eclipse.tptp.test.auto.gui" id="uiObjectResolverDelegate" name="uiObjectResolverDelegate"/>
      </appinfo>
      <documentation>
         Use this extension to define a class that is capable of resolving widgets and nested objects on them.
      </documentation>
   </annotation>

   <element name="extension">
      <annotation>
         <appinfo>
            <meta.element />
         </appinfo>
         <documentation>
            The following internal extension provides the mean for defining custom widget resolvers.
         </documentation>
      </annotation>
      <complexType>
         <sequence>
            <element ref="uiObjectResolverDelegate" minOccurs="1" maxOccurs="unbounded"/>
         </sequence>
         <attribute name="point" type="string" use="required">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="id" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="name" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="uiObjectResolverDelegate">
      <complexType>
         <attribute name="class" type="string" use="required">
            <annotation>
               <documentation>
                  The class that is invoked to resolve a widget or a nested object on a widget.
Must implement the following interface: org.eclipse.tptp.test.auto.gui.uiObject.resolver.delegate.IUIObjectResolverDelegate
               </documentation>
               <appinfo>
                  <meta.attribute kind="java" basedOn="org.eclipse.tptp.test.auto.gui.uiObject.resolver.delegate.IUIObjectResolverDelegate"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="priority" type="string" use="required">
            <annotation>
               <documentation>
                  This attribute indicates the priority of the resolver delegate relative to the other registered widget resolvers. UIObjectResolverDelegats are invoked in an descending order of their priority (e.g. The resolver delegate with the highest priority attribute will be invoked first).
The value of this attribute is expected to be an integer
               </documentation>
            </annotation>
         </attribute>
         <attribute name="id" type="string" use="required">
            <annotation>
               <documentation>
                  The unique id of the resolver.  Keeps this id short as it is commonly used in a macro.  The suggested format is CONTRIBUTING_PLUGIN_ID.RESOLVER_NAME e.g. org.eclipse.tptp.test.auto.gui.adaptive.
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appinfo>
         <meta.section type="since"/>
      </appinfo>
      <documentation>
         Since TPTP v4.5
      </documentation>
   </annotation>

   <annotation>
      <appinfo>
         <meta.section type="examples"/>
      </appinfo>
      <documentation>
         &lt;!-- Define a UI object resolver delegate with priority 10 --&gt; 
  &lt;extension
  point=&quot;org.eclipse.tptp.test.auto.gui.uiObjectResolverDelegate&quot;&gt;
     &lt;widgetResolver 
      id = &quot;org.eclipse.tptp.test.auto.gui.adaptive&quot;
      class=&quot;org.eclipse.tptp.test.auto.gui.internal.recorder.AdaptiveWidgetResolver&quot;
      priority=&quot;10&quot;
     /&gt;
  &lt;/extension&gt;
      </documentation>
   </annotation>

   <annotation>
      <appinfo>
         <meta.section type="apiInfo"/>
      </appinfo>
      <documentation>
         [Enter API information here.]
      </documentation>
   </annotation>

   <annotation>
      <appinfo>
         <meta.section type="implementation"/>
      </appinfo>
      <documentation>
         [Enter information about supplied implementation of this extension point.]
      </documentation>
   </annotation>

   <annotation>
      <appinfo>
         <meta.section type="copyright"/>
      </appinfo>
      <documentation>
         Copyright (c) 2005, 2006 IBM Corporation 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 &lt;a href=&quot;http://www.eclipse.org/legal/epl-v10.html&quot;&gt;http://www.eclipse.org/legal/epl-v10.html&lt;/a&gt;
      </documentation>
   </annotation>

</schema>




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate;

/**
 * Exception to indicate that multiple MacroObjects are found while deresolving an IMacroObjectIdentifier
 * @author Alexander Nyssen
 *
 */
public class DeresolvingAmbiguityException extends Exception {

	private static final long serialVersionUID = 6617530463057206145L;

	private int numberOfMatches = 0;
	
	public DeresolvingAmbiguityException(int numberOfMatches) {
		this.numberOfMatches = numberOfMatches;
	}

	public int getNumberOfMatches(){
		return numberOfMatches;
	}
}




/*******************************************************************************
 * Copyright (c) 2005, 2009 IBM Corporation 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
 * $Id: AdaptiveUIObjectResolverDelegate.java,v 1.6 2007/04/26 20:03:22 paules Exp $
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate;

import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Method;
import java.net.URL;
import java.util.Hashtable;
import java.util.Vector;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.hyades.test.common.util.XMLUtil;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
import org.eclipse.tptp.test.auto.gui.internal.macro.ModeConstants;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.UIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.WeightedPropertyUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.UIObjectResolver;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.deresolvingsupport.IUIObjectDeprecatedDeresolvingFacade;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.deresolvingsupport.UIObjectDeprecatedDeresolvingSupport;
import org.osgi.framework.Bundle;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

/**
 * The following widget resolver attempts to resolve widgets using a static XML
 * file stored under the auto-gui folder under this plugin.
 * 
 * @since 4.1
 * @author Ali Mehregani
 */
public class AdaptiveUIObjectResolverDelegate implements
		IUIObjectResolverDelegate, IUIObjectDeprecatedDeresolvingFacade {

	/**
	 * The id of this resolver -- must be in sync with the id registered with
	 * the widgetResolver extension.
	 */
	private static final String ID = "org.eclipse.tptp.test.auto.gui.adaptive";

	/** The assumed file name relative to this plugin */
	public final static String WIDGET_REG_FILE = "auto-gui/widgetReg.xml";

	/** The widget registerations */
	private IWidgetRegistration widgetReg;

	public AdaptiveUIObjectResolverDelegate() {
		widgetReg = new WidgetRegistration(this, WIDGET_REG_FILE);
	}

	public IUIObjectIdentifier resolve(Object context, IUIObject object)
			throws CoreException {
		if (object.getObject() != null)
			return null;

		widgetReg.load();
		IUIObjectIdentifier widgetId = widgetReg
				.getWidgetId(object.getWidget());
		return widgetId;
	}

	public IUIObject deresolve(Object context,
			IUIObjectIdentifier uiObjectIdentifier) throws CoreException {
		return UIObjectDeprecatedDeresolvingSupport.deresolve(context,
				uiObjectIdentifier);
	}

	/**
	 * Clients have the option of overwriting this in order to be able to locate
	 * the widget them self in the registeration entries that exist.
	 */
	public WidgetRegValue findWidget(Hashtable registerations, Widget widget) {
		return null;
	}

	public class WidgetRegistration implements IWidgetRegistration {

		/* The file name */
		private String fileName;

		/* The last size of the file when it was properly read */
		private long lastModifiedDate;

		/*
		 * The file size (stored in case there was an error last time reading
		 * the file
		 */
		private long lastModifiedDateDetected;

		/* Indicates if there was an error in parsing the file */
		private boolean errorOccurred;

		/*
		 * The data structures holding the registered widgets. Key = class name;
		 * Value = WidgetRegValue
		 */
		private Hashtable regWidgets;

		/* The global match threshold */
		private float globalMatchThreshold;

		/* The class name used for the default entry */
		public static final String DEFAULT_ENTYR = "0_DEFAULT_ENTRY";

		/* The adaptive widget resolver used as the driver for resolving widgets */
		private AdaptiveUIObjectResolverDelegate adaptiveWidgetResolver;

		public WidgetRegistration(
				AdaptiveUIObjectResolverDelegate adaptiveWidgetResolver,
				String fileName) {
			this.fileName = fileName;
			this.lastModifiedDate = 0;
			this.lastModifiedDateDetected = 0;
			this.errorOccurred = false;
			this.regWidgets = new Hashtable();
			this.adaptiveWidgetResolver = adaptiveWidgetResolver;
		}

		public void load() {
			InputStream regXMLInputStream = null;
			try {

				Bundle guiBundle = GuiPlugin.getDefault().getBundle();
				long currentModifiedDate = guiBundle.getLastModified();// added
				// for
				// defect
				// 169733
				// Liz
				// Dancy

				/*
				 * Checking the file size doesn't guarantee to us that the file
				 * hasn't changed. This is the best we can do. Replace this with
				 * last modified date if API is available.
				 */
				if (currentModifiedDate > 0
						&& (currentModifiedDate == lastModifiedDate || (errorOccurred && lastModifiedDateDetected == currentModifiedDate)))
					return;

				URL regFileURL = GuiPlugin.getDefault().getBundle().getEntry(
						fileName);
				lastModifiedDateDetected = currentModifiedDate;

				/* Parse the XML file */
				regXMLInputStream = regFileURL.openStream();
				Element rootElement = XMLUtil.loadDom(regXMLInputStream,
						"widgetResolverRule");
				if (rootElement == null) {
					lastModifiedDate = 0;
					errorOccurred = true;

					/* Display an error message if we are recording */
					if (MacroManager.getInstance().getGlobalState() == ModeConstants.RECORDING_MODE) {
						AutoGUIUtil.showMessage(
								AutoGUIMessages.AUTO_GUI_ERROR_WID_RESOLVER_T,
								AutoGUIMessages.AUTO_GUI_ERROR_WID_RESOLVER,
								MessageDialog.WARNING);
					}
					return;
				}
				this.regWidgets.clear();
				parseRegFile(rootElement);
				lastModifiedDate = currentModifiedDate;
			} catch (Throwable t) {
				/* Set the file size to zero to invalidate this widget resolver */
				lastModifiedDate = 0;
				errorOccurred = true;

				/* Display an error message if we are recording */
				if (MacroManager.getInstance().getGlobalState() == ModeConstants.RECORDING_MODE) {
					AutoGUIUtil.showMessage(
							AutoGUIMessages.AUTO_GUI_ERROR_WID_RESOLVER_T,
							AutoGUIMessages.AUTO_GUI_ERROR_WID_RESOLVER,
							MessageDialog.WARNING);
				}
			} finally {
				if (regXMLInputStream != null) {
					try {
						regXMLInputStream.close();
					} catch (IOException e) {
						/* Ignore the error */
					}
				}
			}

		}

		public float getGlobalThreshold() {
			return globalMatchThreshold;
		}

		/**
		 * parse the registation file that has already been loaded
		 */
		private void parseRegFile(Element rootElement) {
			if (rootElement == null)
				return;

			NodeList classList = XMLUtil
					.getChildrenByName(rootElement, "class");
			parseClassElements(classList);
			globalMatchThreshold = Float.parseFloat(XMLUtil.getValue(
					rootElement, "globalMatchThreshold"));
			NodeList defaultList = XMLUtil.getChildrenByName(rootElement,
					"default");
			parseDefaultElements(defaultList);
		}

		private void parseDefaultElements(NodeList defaultList) {
			if (defaultList == null || defaultList.getLength() < 1)
				return;

			/* We only expect one default element */
			if (defaultList.item(0) instanceof Element) {
				Element defaultElement = (Element) defaultList.item(0);
				NodeList methodList = XMLUtil.getChildrenByName(defaultElement,
						"method");
				WidgetRegValue widgetReg = new WidgetRegValue();

				parseMethod(methodList, widgetReg);
				if (widgetReg != null)
					regWidgets.put(DEFAULT_ENTYR, widgetReg);

			}
		}

		/**
		 * Parse the class elements
		 */
		private void parseClassElements(NodeList classList) {
			if (classList == null || classList.getLength() <= 0)
				return;

			for (int i = 0; i < classList.getLength(); i++) {
				if (classList.item(i) instanceof Element) {

					Element classElement = (Element) classList.item(i);
					String className = XMLUtil.getValue(classElement, "name");
					NodeList methodList = XMLUtil.getChildrenByName(
							classElement, "method");
					WidgetRegValue widgetReg = new WidgetRegValue();
					String matchThreshold = XMLUtil.getValue(classElement,
							"matchThreshold");
					if (matchThreshold != null)
						widgetReg.setClassMatchThreshold(Float
								.parseFloat(matchThreshold));

					parseMethod(methodList, widgetReg);
					if (widgetReg != null)
						regWidgets.put(className, widgetReg);

				}
			}
		}

		/**
		 * Parse the method element and return a widget registration entry
		 * 
		 * @param methodList
		 *            The method list
		 * @param widgetReg
		 *            the widget registration entry that will be augmented
		 * @return A widget registeration entry
		 */
		private void parseMethod(NodeList methodList, WidgetRegValue widgetReg) {
			if (methodList == null || methodList.getLength() <= 0)
				return;

			for (int i = 0; i < methodList.getLength(); i++) {
				if (methodList.item(i) instanceof Element) {
					Element methodElement = (Element) methodList.item(i);
					String methodName = XMLUtil.getValue(methodElement, "name");
					float weight = Float.parseFloat(XMLUtil.getValue(
							methodElement, "weight"));
					PropertyValue propertyVal = new PropertyValue();
					propertyVal.setWeight(weight);

					NodeList argumentList = XMLUtil.getChildrenByName(
							methodElement, "argument");
					if (argumentList != null)
						parseArguments(argumentList, propertyVal);

					widgetReg.addProperty(methodName, propertyVal);
				}
			}
		}

		/**
		 * Parse the arguments
		 * 
		 * @param argumentList
		 *            The arugment list
		 * @param propertyVal
		 *            The property value entry that will be augmented to.
		 */
		private void parseArguments(NodeList argumentList,
				PropertyValue propertyVal) {
			if (argumentList == null || argumentList.getLength() <= 0)
				return;

			Vector arguments = new Vector();
			for (int i = 0; i < argumentList.getLength(); i++) {
				if (argumentList.item(i) instanceof Element) {
					Element argumentElement = (Element) argumentList.item(i);
					String argumentValue = XMLUtil.getValue(argumentElement,
							"value");
					arguments.add(argumentValue);
				}
			}

			propertyVal.setArguments(arguments);
		}

		public IUIObjectIdentifier getWidgetId(Widget widget) {
			/*
			 * Use this resolver if we were able to successfully resolve parse
			 * the XML file
			 */
			if (lastModifiedDate > 0) {
				/*
				 * First attempt the widget itself. If that fails, then try its
				 * data attribute
				 */
				Object data = widget;

				WidgetRegValue widgetValue = (WidgetRegValue) regWidgets
						.get(data.getClass().getName());
				if (widgetValue == null && widget.getData() != null) {
					data = widget.getData();
					widgetValue = (WidgetRegValue) regWidgets.get(data
							.getClass().getName());

					/*
					 * If that fails, then walk throught the class heirarchy
					 * (the interafaces and superclasses
					 */
					if (widgetValue == null) {
						widgetValue = walkThroughClassHeirarchy(data.getClass());

					}
				}

				/*
				 * As a final resolution, try and call the driver class to
				 * resolve the widget
				 */
				if (widgetValue == null)
					widgetValue = adaptiveWidgetResolver.findWidget(regWidgets,
							widget);

				Vector propertyWeightPair = new Vector(5);

				boolean specificValidEntry = false;
				boolean defaultValidEntry = false;

				float threshold = 0;
				if (widgetValue != null) {
					threshold = widgetValue.getClassMatchThreshold();
					if (threshold == 0)
						threshold = globalMatchThreshold;

					/* Specific properties associated with this type */
					specificValidEntry = appendProperties(data,
							propertyWeightPair, widgetValue);
				}

				/* Default properties */
				Vector defaultEntries = new Vector();
				defaultValidEntry = appendProperties(widget, defaultEntries,
						(WidgetRegValue) regWidgets.get(DEFAULT_ENTYR), true);
				if (defaultValidEntry)
					propertyWeightPair.addAll(propertyWeightPair);

				/*
				 * Return null if we weren't able to get any of the widgets
				 * properties
				 */
				if (propertyWeightPair.size() <= 0)
					return null;

				if (specificValidEntry || defaultValidEntry) {
					WeightedPropertyUIObjectIdentifier adaptiveWidgetId = new WeightedPropertyUIObjectIdentifier(
							propertyWeightPair.toArray(), threshold, ID);
					return adaptiveWidgetId;
				}
				return null;
			}

			return null;
		}

		private WidgetRegValue walkThroughClassHeirarchy(Class widgetClass) {
			WidgetRegValue widgetValue = null;

			widgetValue = (WidgetRegValue) regWidgets
					.get(widgetClass.getName());
			if (widgetValue != null)
				return widgetValue;

			Class[] interfaces = widgetClass.getInterfaces();

			/* Try the interfaces first */
			for (int i = 0; i < interfaces.length; i++) {
				widgetValue = (WidgetRegValue) regWidgets.get(interfaces[i]
						.getName());
				widgetValue = (widgetValue == null ? walkThroughClassHeirarchy(interfaces[i])
						: widgetValue);
				if (widgetValue != null)
					return widgetValue;
			}

			/* We failed with the interfaces, now try the super class */
			Class extendedClass = widgetClass.getSuperclass();
			if (extendedClass != null)
				widgetValue = walkThroughClassHeirarchy(extendedClass);

			return widgetValue;
		}

		private boolean appendProperties(Object data,
				Vector propertyWeightPair, WidgetRegValue widgetValue) {
			return appendProperties(data, propertyWeightPair, widgetValue,
					false);
		}

		private boolean appendProperties(Object data,
				Vector propertyWeightPair, WidgetRegValue widgetValue,
				boolean isDefault) {
			boolean validEntry = false;
			if (widgetValue == null)
				return false;

			Vector properties = widgetValue.getProperties();
			for (int i = 0, propertySize = properties.size(); i < propertySize; i++) {
				String property = (String) properties.get(i);
				PropertyValue propertyValue = widgetValue
						.getPropertyValue(property);
				String retValue = invokeProperty(data, property, propertyValue);

				if ((retValue == null || retValue.length() <= 0) && isDefault)
					retValue = invokeProperty(((Widget) data).getData(),
							property, propertyValue);

				/* Don't add it if the return value is null or of zero length */
				if (retValue == null || retValue.length() <= 0)
					retValue = "null"; /*
										 * Set the value to the literal string
										 * 'null'
										 */
				else
					validEntry = true;

				propertyWeightPair.add(new Object[] { retValue,
						String.valueOf(propertyValue.getWeight()) });
			}
			return validEntry;
		}

		/**
		 * Invoke the appropriate method to get the property value
		 * 
		 * @param data
		 *            The data corresponding to the widget or the data attribute
		 *            of the widget
		 * @param theMethod
		 *            The method corresponding to the property value
		 * @param propertyValue
		 *            The property information container
		 * 
		 * @return The returned value of the method corresponding to the
		 *         argument
		 */
		private String invokeProperty(Object data, String theMethod,
				PropertyValue propertyValue) {
			try {
				if (data == null) {
					return null;
				}

				Class theClass = data.getClass();
				int paramCount = 0;
				Vector args = propertyValue.getArguments();
				if (args != null && args.size() > 0)
					paramCount = args.size();

				/* We only support method with string parameters */
				Class[] params = new Class[paramCount];
				for (int i = 0; i < params.length; i++)
					params[i] = String.class;

				Method method = theClass.getMethod(theMethod, params);

				Object[] methodArgs = null;
				if (paramCount > 0)
					methodArgs = propertyValue.getArguments().toArray();

				Object retValue = method.invoke(data, methodArgs);
				if (retValue != null) {
					return retValue.toString();
				}
				return null;
			} catch (Throwable t) {
				/* Return null if in case we can retrieve the property value */
				return null;
			}

		}

		public WidgetRegValue getDefaultWidgetReg() {
			if (regWidgets == null)
				return null;
			return (WidgetRegValue) regWidgets.get(DEFAULT_ENTYR);
		}

	}

	/**
	 * Can be used to provide any alternative implementation of how the widget
	 * registration file is loaded and queried.
	 * 
	 * @author Ali Mehregani
	 */
	public interface IWidgetRegistration {

		/**
		 * Used to load the necessary file and store the data in a datastructure
		 * that will later be used to query the registrations.
		 */
		public void load();

		/**
		 * Retrieve the widget id from the registrations
		 * 
		 * @param widget
		 *            The widget in question
		 * @return The persistent identifier for the widget
		 */
		public IUIObjectIdentifier getWidgetId(Widget widget);
	}

	/**
	 * A container class for the registeration value of a widget
	 * 
	 * @author Ali Mehregani
	 */
	private class WidgetRegValue {

		/* Key = method names, value = propertyValue */
		private Hashtable properties;

		/* Class match treshold */
		private float classMatchThreshold;

		/*
		 * This vector is used to preserve the ordering of the properties
		 * inserted in the hashtable
		 */
		private Vector hashKeys;

		public WidgetRegValue() {
			properties = new Hashtable();
			classMatchThreshold = 0;
			hashKeys = new Vector();
		}

		public Vector getProperties() {
			return hashKeys;
		}

		public PropertyValue getPropertyValue(String propertyValue) {
			return (PropertyValue) properties.get(propertyValue);
		}

		public PropertyValue getPropertyValue(int inx) {
			if (inx >= hashKeys.size())
				return null;
			return (PropertyValue) properties.get(hashKeys.get(inx));
		}

		public void addProperty(String methodName, PropertyValue propertyValue) {
			hashKeys.add(methodName);
			properties.put(methodName, propertyValue);
		}

		public float getClassMatchThreshold() {
			return classMatchThreshold;
		}

		public void setClassMatchThreshold(float classMatchThreshold) {
			this.classMatchThreshold = classMatchThreshold;
		}

	}

	/**
	 * Container class for property values
	 * 
	 * @author Ali Mehregani
	 */
	private class PropertyValue {

		private Vector arguments;
		private float weight;

		public Vector getArguments() {
			return arguments;
		}

		public void setArguments(Vector arguments) {
			this.arguments = arguments;
		}

		public float getWeight() {
			return weight;
		}

		public void setWeight(float weight) {
			this.weight = weight;
		}
	}

	public boolean foundWidget(Widget widget, IUIObjectIdentifier widgetId) {
		try {
			IUIObjectIdentifier id = UIObjectResolver.resolve(new MacroObject(
					new UIObject(widget)).getContext(), new UIObject(widget));
			return id == null ? false : id == null ? false : id.getWidgetId()
					.equals(widgetId.getWidgetId());
		} catch (CoreException e) {
			e.printStackTrace();
		}
		return false;
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2009 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.tptp.test.auto.gui.internal.macroobject;

import org.eclipse.core.runtime.Path;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.PrimitiveUIObjectIdentifier;

/**
 * Used as an identifier for Macro objects.
 * 
 * @author Alexander Nyssen
 */
public class MacroObjectIdentifier implements IMacroObjectIdentifier {

	/** The context id */
	private String contextId;

	/** The ui object id */
	private IUIObjectIdentifier uiObjectIdentifier;

	/**
	 * Constructor
	 * 
	 * @param contextId
	 *            The context id
	 * @param uiObjectId
	 *            The widget id
	 */
	public MacroObjectIdentifier(String contextId,
			IUIObjectIdentifier uiObjectIdentifier) {
		this.contextId = contextId;
		this.uiObjectIdentifier = uiObjectIdentifier;
	}

	/**
	 * An object in question is equalled to this object iff the object is of the
	 * same type and the context and the widget ids are the same.
	 * 
	 * @param object
	 *            The object in question
	 * 
	 * @return A boolean indicating whether object is equalled to this object or
	 *         not.
	 */
	public boolean equals(Object object) {
		if (object == null)
			return false;
		if (object == this)
			return true;
		if (object instanceof MacroObjectIdentifier) {
			MacroObjectIdentifier wid = (MacroObjectIdentifier) object;
			return wid.contextId.equals(contextId)
					&& uiObjectIdentifier.getWidgetId().equals(
							wid.getObjectIdentifier().getWidgetId());
		}
		return false;
	}

	/**
	 * Returns the context id of this identifier
	 * 
	 * @return The context id
	 */
	public String getContextIdentifier() {
		return contextId.toString();
	}

	public IUIObjectIdentifier getObjectIdentifier() {
		return uiObjectIdentifier;
	}

	public static IMacroObjectIdentifier deserializeMacroObjectIdentifier(
			String macroObjectIdentifierString) {

		// 1) retrieve the context, object and resolver id
		// first retrieve the resolver id
		String resolverId = null;
		if (macroObjectIdentifierString
				.indexOf(MacroConstants.RESOLVER_ID_SUFFIX_SEPARATOR) >= 0) {
			resolverId = macroObjectIdentifierString
					.substring(macroObjectIdentifierString
							.lastIndexOf(MacroConstants.RESOLVER_ID_SUFFIX_SEPARATOR) + 3);
			macroObjectIdentifierString = macroObjectIdentifierString
					.substring(
							0,
							macroObjectIdentifierString
									.lastIndexOf(MacroConstants.RESOLVER_ID_SUFFIX_SEPARATOR));
		}

		// now the object id separator
		String objectId = null;
		if (macroObjectIdentifierString
				.indexOf(MacroConstants.OBJECT_ID_SUFFIX_SEPARATOR) >= 0) {
			objectId = macroObjectIdentifierString
					.substring(macroObjectIdentifierString
							.lastIndexOf(MacroConstants.OBJECT_ID_SUFFIX_SEPARATOR) + 3);
			macroObjectIdentifierString = macroObjectIdentifierString
					.substring(
							0,
							macroObjectIdentifierString
									.lastIndexOf(MacroConstants.OBJECT_ID_SUFFIX_SEPARATOR));
		}

		// now the widget id
		String widgetId = macroObjectIdentifierString
				.substring(macroObjectIdentifierString
						.lastIndexOf(MacroConstants.WIDGET_ID_SUFFIX_SEPARATOR) + 3);
		macroObjectIdentifierString = macroObjectIdentifierString
				.substring(0, macroObjectIdentifierString
						.lastIndexOf(MacroConstants.WIDGET_ID_SUFFIX_SEPARATOR));

		// now the context id
		String contextId = new Path(macroObjectIdentifierString).removeTrailingSeparator().toString();

		// 2) construct a new identifier and return it
		IMacroObjectIdentifier macroObjectIdentifier = new MacroObjectIdentifier(
				contextId,
				new PrimitiveUIObjectIdentifier(widgetId, objectId, resolverId));
		return macroObjectIdentifier;
	}

	public static String serializeMacroObjectIdentifier(
			IMacroObjectIdentifier macroObjectIdentifier) {
		return macroObjectIdentifier.getContextIdentifier()
				// concat widet id
				+ MacroConstants.WIDGET_ID_SUFFIX_SEPARATOR
				+ macroObjectIdentifier.getObjectIdentifier().getWidgetId()
				// concat object id
				+ (macroObjectIdentifier.getObjectIdentifier().getObjectId() != null ? MacroConstants.OBJECT_ID_SUFFIX_SEPARATOR
						+ macroObjectIdentifier.getObjectIdentifier()
								.getObjectId()
						: "")
				// concat resolver id
				+ (macroObjectIdentifier.getObjectIdentifier().getResolverId() != null ? MacroConstants.RESOLVER_ID_SUFFIX_SEPARATOR
						+ macroObjectIdentifier.getObjectIdentifier()
								.getResolverId()
						: "");
	}

}




#Tue Jan 22 16:24:58 CET 2008
eclipse.preferences.version=1
org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.2
org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
org.eclipse.jdt.core.compiler.compliance=1.4
org.eclipse.jdt.core.compiler.debug.lineNumber=generate
org.eclipse.jdt.core.compiler.debug.localVariable=generate
org.eclipse.jdt.core.compiler.debug.sourceFile=generate
org.eclipse.jdt.core.compiler.problem.assertIdentifier=warning
org.eclipse.jdt.core.compiler.problem.enumIdentifier=warning
org.eclipse.jdt.core.compiler.source=1.3




/**********************************************************************
 * Copyright (c) 2009 Alexander Nyssen and others.
 * All rights reserved. This content is 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        
 * $Id$
 *
 * Contributors:
 * Alexander Nyssen - Initial contribution
 **********************************************************************/ 
package org.eclipse.tptp.test.auto.gui.internal.macroobject.resolver;

import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.jface.action.CoolBarManager;
import org.eclipse.jface.action.ICoolBarManager;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.action.ToolBarManager;
import org.eclipse.jface.window.ApplicationWindow;
import org.eclipse.jface.wizard.IWizardPage;
import org.eclipse.jface.wizard.WizardDialog;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.CTabItem;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Decorations;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.TabFolder;
import org.eclipse.swt.widgets.TabItem;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObject;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.IMacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObject;
import org.eclipse.tptp.test.auto.gui.internal.macroobject.MacroObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.PrimitiveUIObjectIdentifier;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.UIObject;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.UIObjectResolver;
import org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate.DeresolvingAmbiguityException;
import org.eclipse.ui.IActionBars;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IViewPart;
import org.eclipse.ui.IViewSite;
import org.eclipse.ui.IWorkbenchPart;

/**
 * Provides functionality to resolve a IMacroObject into an
 * IMacroObjectIdentifier that can be persistently stored, and to deresolve an
 * IMacroObjectIdentifier back into an IMacroObject.
 * 
 * During resolving a context identifier for the context of the IMacroObject is
 * computed and the resolving of the IUIObject nested inside the IMacroObject is
 * delegated to the UIObjectResolver (the resulting IUIObjectIdentifier is then
 * be nested into the returned IMacroObjectIdentifier).
 * 
 * During deresolving the context object is first deresolved, then the IUIObject
 * nested inside the IMacroObject is deresolved by delegating to the
 * IUIObjectResolver again.
 * 
 * @author Alexander Nyssen
 * 
 */
public final class MacroObjectResolver {

	/**
	 * Resolve a IMacroObject into an IMacroObjectIdentifier representation,
	 * that can be persistently stored and that allows to deresolve the
	 * IMacroObject during playback. Delegates to UIObjectResolver's resolve()
	 * method to obtain the IUIObjectIdentifier part of the
	 * IMacroObjectIdentifier
	 * 
	 * @param macroObject
	 * @return
	 */
	public static IMacroObjectIdentifier resolve(Shell shell,
			IMacroObject macroObject) throws CoreException {
		// retrieve the context id of the UI object

		// compute a context identifier based on the context object of the
		// macroObject
		String contextIdentifier = resolveContextIdentifier(shell, macroObject);

		// compute the object id by delegating to the UIObjectResolver
		IUIObjectIdentifier uiObjectIdentifier = UIObjectResolver.resolve(
				macroObject.getContext(), macroObject.getUIObject());

		IMacroObjectIdentifier identifier = null;
		// compute the object id and build a new MacroObjectIdentifier from both
		if (contextIdentifier != null && uiObjectIdentifier != null) {
			// identifier = new MacroObjectIdentifier(contextIdentifier,
			// uiObjectIdentifier);
			identifier = checkAnfFixUnambiguousIdentifier(shell, macroObject,
					new MacroObjectIdentifier(contextIdentifier,
							uiObjectIdentifier));
		}
		return identifier;
	}

	/**
	 * This method implements a workaround for defect #147766. It checks whether
	 * the provided IMacroObject can be unambiguously deresolved by using the
	 * provided IMacroObjectIdentifier.
	 * 
	 * As detection of deresolving ambiguities is limited to Control instances,
	 * this method does only have an effect, if the passed in macro object
	 * contains a control as the widget of its nested UI object.
	 * 
	 * If the passed in IMacroObjectIdentifier is ambiguous, an index is added
	 * to the widget id of the nested UIObjectIdnentifier to ensure unambiguity
	 * during deresolving (the locateVisibleChild() method of the
	 * UIObjectDeprecatedDeresolvingSupport class handles this case). If the
	 * passed in IMacroObjectIdentifier is unambiguous or the deresolving did
	 * fail because of any other reason, this method does not have any effect
	 * and simply returns the passed in IMacroObjectIdentifier.
	 */
	private static IMacroObjectIdentifier checkAnfFixUnambiguousIdentifier(
			Shell shell, IMacroObject macroObject,
			IMacroObjectIdentifier macroObjectIdentifier) throws CoreException {
		try {
			// ANy: IMPORTANT: I observed that in case of MenuItems, deresolving
			// during recording causes the widget to get disposed as a
			// side-effect.
			// Also because of this, limiting the check to Control instances is
			// necessary.
			if (macroObject.getUIObject().getWidget() instanceof Control) {
				deresolve(shell, new MacroObjectIdentifier(
						macroObjectIdentifier.getContextIdentifier(),
						macroObjectIdentifier.getObjectIdentifier()));
			}
		} catch (Throwable t) {
			// ANy: IMPORTANT: In case we get a core exception we have to check
			// if
			// ambiguity of the passed in identifier was the reason.
			if (t instanceof CoreException
					&& ((CoreException) t).getCause() instanceof DeresolvingAmbiguityException) {
				// provide a workaround by adding a respective
				// identifier suffix to identify the desired match
				IUIObjectIdentifier unambiguousUIObjectIdentifier = computeUnambigousUIObjectIdentifier(
						macroObject.getContext(), macroObject.getUIObject(),
						macroObjectIdentifier.getObjectIdentifier(),
						((DeresolvingAmbiguityException) ((CoreException) t)
								.getCause()).getNumberOfMatches());
				if (unambiguousUIObjectIdentifier != null) {
					// if we were successful, return the new - now unambiguous -
					// identifier.
					return new MacroObjectIdentifier(macroObjectIdentifier
							.getContextIdentifier(),
							unambiguousUIObjectIdentifier);
				} else {
					// throw an exception to notify the user.
					AutoGUIUtil
							.throwCoreException(
									NLS
											.bind(
													AutoGUIMessages.AUTO_GUI_UI_OBJECT_IDENTIFIER_AMBIGUOUS,
													macroObjectIdentifier
															.getObjectIdentifier()
															.getWidgetId(),
													macroObjectIdentifier
															.getObjectIdentifier()
															.getObjectId()), t
											.getCause());
					return null;
				}
			} else {
				// All other reasons are ignored here, so return the passed in
				// macro object identifier.
				return macroObjectIdentifier;
			}
		}
		// if no exeption is thrown, the deresolving worked, so return the
		// passed in macro object identifier.
		return macroObjectIdentifier;
	}

	private static IUIObjectIdentifier computeUnambigousUIObjectIdentifier(
			Object context, IUIObject uiObject,
			IUIObjectIdentifier ambigousIdentifier, int numberOfMatches) {
		IUIObjectIdentifier unambigousIdentifier = null;
		// check each match to see which one is the desired target
		for (int i = 0; i < numberOfMatches && unambigousIdentifier == null; i++) {
			try {
				String uniqueWidgetId = ambigousIdentifier
						.getWidgetId()
						.concat(
								MacroConstants.WIDGET_ID_UNIQUENESS_INDEX_SEPARATOR
										+ new Integer(i).toString());
				IUIObjectIdentifier modifiedUIObjectIdentifier = new PrimitiveUIObjectIdentifier(
						uniqueWidgetId, ambigousIdentifier.getObjectId(),
						ambigousIdentifier.getResolverId());
				IUIObject deresolvedUIObject = UIObjectResolver.deresolve(
						context, modifiedUIObjectIdentifier);
				if (deresolvedUIObject != null
						&& deresolvedUIObject.getWidget() == uiObject
								.getWidget()) {
					unambigousIdentifier = modifiedUIObjectIdentifier;
				}
			} catch (Throwable t) {
			}
		}
		return unambigousIdentifier;
	}

	private static String resolveContextIdentifier(Shell shell,
			IMacroObject macroObject) throws CoreException {
		Widget widget = macroObject.getUIObject().getWidget();
		if (widget instanceof MenuItem) {
			if (macroObject.getContext() instanceof Menu) {
				IViewPart view = null;
				if (MacroUtil.onMenubar((MenuItem) widget)) {
					return new Path(MacroConstants.MENUS_VALUE).toString(); //$NON-NLS-1$
				} else if ((view = MacroUtil
						.onWorkbenchPartToolbar((MenuItem) widget)) != null) {
					return new Path(MacroConstants.LOCAL_TOOLBAR_MENU_VALUE)
							.append(
									new Path(MacroConstants.VIEW_VALUE)
											.append(view.getSite().getId()))
							.toString();
				}
				return null;

			} else if (macroObject.getContext() instanceof Control) {
				IMacroObjectIdentifier focusControlIdentifier = resolve(shell,
						new MacroObject(new UIObject((Control) macroObject
								.getContext())));
				if (focusControlIdentifier == null) {
					return null;
				} else {
					// the context id of a popup menu item is the concatenation
					// of the
					// MacroConstants.POPUP_VALUE keyword followed by the
					// IMacroObjectIdentifier
					// of the focus control
					return new Path(MacroConstants.POPUP_VALUE)
							.append(
									MacroObjectIdentifier
											.serializeMacroObjectIdentifier(focusControlIdentifier))
							.toString(); //$NON-NLS-1$
				}
			}
			return null;
		} else if (widget instanceof ToolItem) {
			/*
			 * Check to see if this toolbar belongs to the global toolbar of the
			 * workbench
			 */
			if (macroObject.getContext() instanceof IToolBarManager
					|| macroObject.getContext() instanceof ICoolBarManager) {
				// global toolbar of the workbench
				return new Path(MacroConstants.TOOLBAR_VALUE).toString(); //$NON-NLS-1$
			} else if (macroObject.getContext() instanceof ToolBar) {
				// Local toolbar somewhere - locate the parent first and use its
				// IMacroObjectIdentifier as
				// context, as in case of the LOCAL_TOOLBAR_MENU_VALUE
				ToolBar toolBar = (ToolBar) macroObject.getContext();
				IMacroObjectIdentifier toolBarIdentifier = resolve(shell,
						new MacroObject(new UIObject(toolBar)));
				if (toolBarIdentifier != null) {
					return new Path(MacroConstants.LOCAL_TOOLBAR_VALUE)
							.append(
									MacroObjectIdentifier
											.serializeMacroObjectIdentifier(toolBarIdentifier))
							.toString(); //$NON-NLS-1$
				} else {
					return null;
				}
			} else {
				return null;
			}
		} else if (widget instanceof TabItem || widget instanceof CTabItem) {
			IMacroObjectIdentifier tabFolderIdentifier = null;
			if (widget instanceof TabItem) {
				TabFolder tabFolder = (TabFolder) macroObject.getContext();
				tabFolderIdentifier = resolve(shell, new MacroObject(
						new UIObject(tabFolder)));
			} else {
				CTabFolder tabFolder = (CTabFolder) macroObject.getContext();
				tabFolderIdentifier = resolve(shell, new MacroObject(
						new UIObject(tabFolder)));
			}
			if (tabFolderIdentifier != null) {
				return new Path(MacroConstants.TAB_VALUE)
						.append(
								MacroObjectIdentifier
										.serializeMacroObjectIdentifier(tabFolderIdentifier))
						.toString();
			}

		} else if (widget instanceof Menu) {
			// it seems that menus are never resolved (as the deresolver does
			// not have any capability to deresolve them)
			AutoGUIUtil
					.throwCoreException("Menus are not suppported by current implementation");
			// return new Path(MacroConstants.MENUS_VALUE).toString();
		} else if (widget instanceof Control) {
			return resolveControlContextIdentifier(macroObject);
		}
		return null;
	}

	private static String resolveControlContextIdentifier(
			IMacroObject macroObject) {
		if (macroObject.getContext() instanceof WizardDialog) {
			return new Path(MacroConstants.WIZARD_VALUE).toString();
		} else if (macroObject.getContext() instanceof IWizardPage) {
			return new Path(MacroConstants.WIZARD_PAGE_VALUE).append(
					((IWizardPage) macroObject.getContext()).getName())
					.toString();
		} else if (macroObject.getContext() instanceof IWorkbenchPart) {
			IWorkbenchPart part = (IWorkbenchPart) macroObject.getContext();
			if (part instanceof IViewPart) {
				return new Path(MacroConstants.VIEW_VALUE).append(
						part.getSite().getId()).toString();
			} else if (part instanceof IEditorPart) {
				String inputName = ((IEditorPart) part).getEditorInput()
						.getName();
				return new Path(MacroConstants.EDITOR_VALUE).append(
						part.getSite().getId()).append(inputName).toString();
			} else {
				return null;
			}
		} else if (macroObject.getContext() instanceof Shell) {
			return new Path(MacroConstants.SHELL_VALUE).toString();
		} else {
			return null;
		}
	}

	/**
	 * TODO: split deresolving of context object from deresolving of UI object,
	 * which has to be done by UIObjectResolver....
	 * 
	 * @param shell
	 * @param macroObjectIdentifier
	 * @param parents
	 * @return
	 * @throws CoreException
	 */
	public static IMacroObject deresolve(Shell shell,
			IMacroObjectIdentifier macroObjectIdentifier) throws CoreException {
		String contextId = macroObjectIdentifier.getContextIdentifier();

		String firstToken = new Path(contextId).segment(0);
		String id = new Path(contextId).segment(1);

		Object context = null;

		if (MacroConstants.MENUS_VALUE.equals(firstToken)) {
			context = findMenuContext(shell, macroObjectIdentifier);
		} else if (MacroConstants.POPUP_VALUE.equals(firstToken)) {
			context = findPopupMenuItemContext(shell, macroObjectIdentifier);
		} else if (MacroConstants.TOOLBAR_VALUE.equals(firstToken)) {
			context = findToolItemContext(shell, macroObjectIdentifier);
		} else if (MacroConstants.LOCAL_TOOLBAR_VALUE.equals(firstToken)) {
			context = findLocalToolItemContext(shell, macroObjectIdentifier);
		} else if (MacroConstants.LOCAL_TOOLBAR_MENU_VALUE.equals(firstToken)) {
			context = findToolBarMenuItemContext(shell, macroObjectIdentifier);
		} else if (MacroConstants.TAB_VALUE.equals(firstToken)) {
			// ANy: added to properly deresolve TabItems and CTabItems (was done
			// locally by commands before)
			context = findTabItemContext(shell, macroObjectIdentifier);
		} else if (MacroConstants.WIZARD_VALUE.equals(firstToken)) {
			context = findWizardContext(shell, macroObjectIdentifier);
		} else if (MacroConstants.WIZARD_PAGE_VALUE.equals(firstToken)) {
			context = findWizardPageContext(shell, id, macroObjectIdentifier);
		} else if (MacroConstants.VIEW_VALUE.equals(firstToken)) {
			context = findViewContext(shell, id, macroObjectIdentifier);
		} else if (MacroConstants.EDITOR_VALUE.equals(firstToken)) {
			String inputName = new Path(contextId).segment(2);
			context = findEditorContext(shell, id, inputName,
					macroObjectIdentifier);
		} else if (MacroConstants.SHELL_VALUE.equals(firstToken)) {
			context = shell;
		}
		// else if (MacroConstants.LOCAL_SHELL_VALUE.equals(firstToken)) {
		// context = shell.getData();
		// }

		if (context != null) {
			IUIObject uiObject = UIObjectResolver.deresolve(context,
					macroObjectIdentifier.getObjectIdentifier());
			if (uiObject != null) {
				return new MacroObject(context, uiObject);
			} else {
				return null;
			}
		}
		return null;
	}

	private static Object findTabItemContext(Shell shell,
			IMacroObjectIdentifier macroObjectIdentifier) throws CoreException {
		IPath contextPath = new Path(macroObjectIdentifier
				.getContextIdentifier()).removeFirstSegments(1);

		IMacroObjectIdentifier tabFolderIdentifier = MacroObjectIdentifier
				.deserializeMacroObjectIdentifier(contextPath.toString());
		IMacroObject tabFolder = deresolve(shell, tabFolderIdentifier);

		if (tabFolder != null) {
			return tabFolder.getUIObject().getWidget();
		}
		return null;
	}

	private static Object findEditorContext(Shell shell, String id,
			String inputName, IMacroObjectIdentifier wid) throws CoreException {
		UIObject control = null;

		try {
			IEditorPart editor = MacroUtil.locateEditor(shell, id, inputName);
			return editor;
		} catch (Throwable t) {
			t.printStackTrace();
		}
		return null;
	}

	private static Object findLocalToolItemContext(Shell shell,
			IMacroObjectIdentifier wid) throws CoreException {
		// construct a IMacroObjectIdentifier for the toolbar
		// by splitting the context id.

		// 1) truncate the leading MacroConstants.LOCAL_TOOLBAR_MENU_VALUE
		// segment
		IPath wpath = new Path(wid.getContextIdentifier())
				.removeFirstSegments(1);

		IMacroObjectIdentifier toolBarIdentifier = MacroObjectIdentifier
				.deserializeMacroObjectIdentifier(wpath.toString());

		// now try to deresolve the toolbar with the given identifier
		ToolBar toolbar = null;
		try {
			IMacroObject toolbarObject = deresolve(shell, toolBarIdentifier);
			if (toolbarObject != null) {
				toolbar = (ToolBar) toolbarObject.getUIObject().getWidget();
			}
		} catch (Throwable t) {
			t.printStackTrace();
		}
		return toolbar;
		// try{
		// String firstToken = wpath.segment(0);
		// IWorkbenchPart workbenchPart = null;
		// Composite parent = null;
		// IMacroObject target = null;
		//
		// if (MacroConstants.VIEW_VALUE.equals(firstToken)) {
		// String id = wpath.segment(1);
		// workbenchPart = MacroUtil.locateView(shell, id);
		// } else if (MacroConstants.EDITOR_VALUE.equals(firstToken)) {
		// String id = wpath.segment(1);
		// workbenchPart = MacroUtil.locateEditor(shell, id, null);
		// } else if (MacroConstants.SHELL_VALUE.equals(firstToken)) {
		// parent = shell;
		// }
		//
		// if (workbenchPart != null) {
		// Composite comp = MacroUtil
		// .getWorkbenchPartControl(workbenchPart);
		// MacroUtil.processDisplayEvents(shell.getDisplay());
		// parent = comp.getParent();
		// }
		//
		// if (parent != null) {
		// IMacroObjectIdentifier widgetIdentifier = new MacroObjectIdentifier(
		// wid.getContextIdentifier(),
		// new PrimitiveUIObjectIdentifier(new Path(wid
		// .getContextIdentifier()).lastSegment(), wid
		// .getObjectIdentifier().getResolverId()));
		// UIObject control = UIObjectDeprecatedDeresolvingSupport
		// .locateVisibleChild(parent, null, widgetIdentifier);
		//
		// if (control != null && control.getWidget() instanceof ToolBar) {
		// target = locateToolItem((ToolBar) control.getWidget(), wid);
		// }
		// }
		//
		// if (target != null)
		// return target;
		//
		// } catch (Throwable t) {
		// /* The next line will throw an exception */
		// t.printStackTrace();
		// }
		//
		// AutoGUIUtil.throwCoreException(NLS.bind(
		// AutoGUIMessages.AUTO_GUI_ERROR_MACRO_TOOL_BAR, wid
		// .getContextIdentifier()
		// + wid.getObjectIdentifier().getObjectId()));
		// return null;
	}

	private static Object findMenuContext(Shell shell,
			IMacroObjectIdentifier wid) throws CoreException {
		Menu menuBar = shell.getMenuBar();
		return menuBar;
	}

	// private static MenuItem locateMenuItem(MenuManager mng,
	// IMacroObjectIdentifier widgetId) {
	// IContributionItem[] items = mng.getItems();
	//		
	// String lastSegment = getLastSegment(new
	// Path(widgetId.getObjectIdentifier().getObjectId()));
	// String parentId = null;
	//
	// for (int i = 0; i < items.length; i++) {
	// IContributionItem citem = items[i];
	//
	// if (citem instanceof MenuManager) {
	// MenuManager submenu = (MenuManager) citem;
	// String subId = submenu.getId();
	//				
	// if (subId.equals(parentId))
	// {
	//
	// // show this menu to force dynamic items
	// // to show
	// Menu menu = submenu.getMenu();
	// forceMenuOpen(null, menu);
	//
	// MenuItem hit = locateMenuItem(submenu, widgetId);
	// forceMenuClosed(menu);
	// if (hit != null)
	// return hit;
	// }
	//
	// } else {
	// /*
	// * Ali M.: I believe that the first line and the following block
	// * were for optimization purposes only
	// */
	// String itemId =
	// NonTrivialUIObjectResolverDelegate.getActionId(citem).getObjectId();
	// if (itemId != null &&
	// widgetId.getObjectIdentifier().getObjectId().equals(itemId)) {
	// MenuItem hit = locateMenuItem(mng.getMenu(), widgetId);
	// if (hit != null)
	// return hit;
	// }
	// }
	// }
	// return null;
	// }

	private static Object findPopupMenuItemContext(Shell shell,
			IMacroObjectIdentifier wid) throws CoreException {
		// try {

		IPath contextPath = new Path(wid.getContextIdentifier())
				.removeFirstSegments(1);

		IMacroObjectIdentifier focusControlIdentifier = MacroObjectIdentifier
				.deserializeMacroObjectIdentifier(contextPath.toString());
		IMacroObject focusControlObject = deresolve(shell,
				focusControlIdentifier);

		if (focusControlObject != null) {
			Control control = (Control) focusControlObject.getUIObject()
					.getWidget();
			Menu popupMenu = control.getMenu();
			return popupMenu;
		} else {
			return null;
		}

		// IPath wpath = new Path(getLastSegment(contextPath));
		//
		// int widgetPathInx = contextPath.toString()
		// .indexOf(wpath.toString());
		// if (widgetPathInx > 0)
		// contextPath = new Path(contextPath.toString().substring(0,
		// widgetPathInx - 1));
		// IMacroObject target = deresolve(shell, new MacroObjectIdentifier(
		// contextPath.toString(), new PrimitiveUIObjectIdentifier(
		// wpath.toString(), null)));
		// if (target != null) {
		// // for (int i = 0; i < targets.length; i++) {
		// Control control = (Control) target.getUIObject().getWidget();
		// Menu popupMenu = control.getMenu();
		// if (popupMenu != null) {
		// MacroUtil.forceMenuOpen(popupMenu);
		// UIObject menuItem = locateMenuItem(popupMenu, wid
		// .getObjectIdentifier());
		// MacroUtil.forceMenuClosed(popupMenu);
		// if (menuItem != null) {
		// return new MacroObject(control, menuItem);
		// }
		// }
		// // }
		// }
		// } catch (Throwable t) {
		// /* The next line will throw an exception */
		// t.printStackTrace();
		// }
		// AutoGUIUtil.throwCoreException(NLS.bind(
		// AutoGUIMessages.AUTO_GUI_ERROR_MACRO_MENU, wid
		// .getObjectIdentifier().getObjectId()));
		// return null;
	}

	private static Object findToolBarMenuItemContext(Shell shell,
			IMacroObjectIdentifier wid) throws CoreException {
		// try {
		IPath contextPath = new Path(wid.getContextIdentifier())
				.removeFirstSegments(1);

		/* The context is a menu */
		IViewPart view = null;
		if (MacroConstants.VIEW_VALUE.equals(contextPath.segment(0))) {
			view = MacroUtil.locateView(shell, contextPath.segment(1));
		}

		IViewSite viewSite = view == null ? null : view.getViewSite();
		IMenuManager menuManager = null;
		if (viewSite != null) {
			IActionBars actionBar = viewSite.getActionBars();
			actionBar.updateActionBars();
			menuManager = actionBar.getMenuManager();
		}

		if (menuManager != null && menuManager instanceof MenuManager) {
			Menu menu = ((MenuManager) menuManager).getMenu();
			if (menu == null) {
				// try to create menu
				((MenuManager) menuManager).createMenuBar((Decorations) view
						.getSite().getShell());
			}
			return menu;
		} else {
			return null;
		}
	}

	private static String getLastSegment(IPath contextPath) {
		String[] segments = contextPath.segments();
		String candidate = "";
		for (int i = segments.length - 1; i >= 0; i--) {
			if (candidate.length() > 0)
				candidate = "/" + candidate;
			candidate = segments[i] + candidate;
			int openingBracesInx = candidate.indexOf('{');
			int closingBracesInx = candidate.indexOf('}');
			if ((openingBracesInx == -1 && closingBracesInx == -1)
					|| (openingBracesInx >= 0 && openingBracesInx < closingBracesInx))
				return candidate;
		}

		return "";
	}

	// private static IMacroObject locateShellControl(Shell shell,
	// IMacroObjectIdentifier wid) throws CoreException {
	// UIObject control = null;
	// Window window = null;
	// boolean ambiguous = false;
	// try {
	// window = (Window) shell.getData();
	// control = UIObjectDeprecatedDeresolvingSupport.locateVisibleChild(
	// shell, null, wid);
	// } catch (Throwable t) {
	// if (t instanceof CoreException) {
	// AutoGUIUtil.throwCoreException(NLS.bind(
	// AutoGUIMessages.AUTO_GUI_MACRO_UI_OBJECT_AMBIGUOUS, wid
	// .getObjectIdentifier(), wid
	// .getContextIdentifier()));
	// }
	// }
	// if (control == null)
	// AutoGUIUtil.throwCoreException(NLS.bind(
	// AutoGUIMessages.AUTO_GUI_ERROR_MACRO_SHELL, wid
	// .getObjectIdentifier().getObjectId()));
	//
	// // IMacroObject[] windowCommandTarget = new
	// // IMacroObject[controls.length];
	// // for (int i = 0; i < controls.length; i++) {
	// // if (controls[i].isDisposed())
	// // AutoGUIUtil.throwCoreException(NLS.bind(
	// // AutoGUIMessages.AUTO_GUI_ERROR_MACRO_SHELL_DIS, wid
	// // .getObjectIdentifier().getObjectId()));
	// // windowCommandTarget[i] = new MacroObject(window, new UIObject(
	// // controls[i]));
	// // }
	// //
	// // return windowCommandTarget;
	// return new MacroObject(window, control);
	// }

	private static Object findToolItemContext(Shell shell,
			IMacroObjectIdentifier wid) throws CoreException {

		try {
			Object data = shell.getData();
			if (data instanceof ApplicationWindow) {
				ApplicationWindow window = (ApplicationWindow) data;
				CoolBarManager coolMng = window.getCoolBarManager();
				if (coolMng != null) {
					return coolMng;
				}
				ToolBarManager toolMng = window.getToolBarManager();
				if (toolMng != null) {
					return toolMng;
				}
			}
		} catch (Throwable t) {
			t.printStackTrace();
		}
		return null;
	}

	private static Object findViewContext(Shell shell, String id,
			IMacroObjectIdentifier wid) throws CoreException {
		try {
			IViewPart view = MacroUtil.locateView(shell, id);
			return view;
		} catch (Throwable t) {
			t.printStackTrace();
		}
		return null;
	}

	private static Object findWizardContext(Shell shell,
			IMacroObjectIdentifier wid) throws CoreException {
		WizardDialog wdialog = null;
		if (shell.getData() instanceof WizardDialog) {
			wdialog = (WizardDialog) shell.getData();
			Assert
					.isLegal(
							wdialog.getShell() == shell,
							"If the current shell is not the shell of the wizard, we have a deresolving problem");
		}
		return wdialog;
	}

	private static Object findWizardPageContext(Shell shell, String id,
			IMacroObjectIdentifier wid) throws CoreException {
		IWizardPage page = null;
		Object data = shell.getData();
		if (data instanceof WizardDialog) {
			WizardDialog wdialog = (WizardDialog) data;
			page = wdialog.getCurrentPage();
		}
		return page;

	}

}

Return to bug 133099

Removed Link Here

(-)src/org/eclipse/tptp/test/auto/gui/tests/TestsPlugin.java (-54 lines)
1	package org.eclipse.tptp.test.auto.gui.tests;
2
3	import org.eclipse.ui.plugin.*;
4	import org.eclipse.jface.resource.ImageDescriptor;
5	import org.osgi.framework.BundleContext;
6
7	/**
8	* The main plugin class to be used in the desktop.
9	*/
10	public class TestsPlugin extends AbstractUIPlugin {
11
12	//The shared instance.
13	private static TestsPlugin plugin;
14
15	/**
16	* The constructor.
17	*/
18	public TestsPlugin() {
19	plugin = this;
20	}
21
22	/**
23	* This method is called upon plug-in activation
24	*/
25	public void start(BundleContext context) throws Exception {
26	super.start(context);
27	}
28
29	/**
30	* This method is called when the plug-in is stopped
31	*/
32	public void stop(BundleContext context) throws Exception {
33	super.stop(context);
34	plugin = null;
35	}
36
37	/**
38	* Returns the shared instance.
39	*/
40	public static TestsPlugin getDefault() {
41	return plugin;
42	}
43
44	/**
45	* Returns an image descriptor for the image file at the given
46	* plug-in relative path.
47	*
48	* @param path the path
49	* @return the image descriptor
50	*/
51	public static ImageDescriptor getImageDescriptor(String path) {
52	return AbstractUIPlugin.imageDescriptorFromPlugin("org.eclipse.tptp.test.auto.gui.tests", path);
53	}
54	}

Removed Link Here

(-)src/org/eclipse/tptp/test/auto/gui/tests/common/stubs/AutoGUINodeList.java (-32 lines)
1	package org.eclipse.tptp.test.auto.gui.tests.common.stubs;
2
3	import java.util.List;
4
5	import org.w3c.dom.Node;
6	import org.w3c.dom.NodeList;
7
8	public class AutoGUINodeList implements NodeList
9	{
10	private List children;
11
12	public AutoGUINodeList (List nodes)
13	{
14	this.children = nodes;
15	}
16
17	public int getLength()
18	{
19	return children.size();
20	}
21
22	public Node item(int index)
23	{
24	return (Node)children.get(index);
25	}
26
27	public AutoGUINode[] getNodes()
28	{
29	return children == null ? null : (AutoGUINode[])children.toArray(new AutoGUINode[children.size()]);
30	}
31
32	}

Removed Link Here

(-)src/org/eclipse/tptp/test/auto/gui/tests/common/stubs/AutoGUINode.java (-406 lines)
1	/**********************************************************************
2	* Copyright (c) 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM - Initial API and implementation
10	**********************************************************************/
11	package org.eclipse.tptp.test.auto.gui.tests.common.stubs;
12
13	import org.w3c.dom.Attr;
14	import org.w3c.dom.DOMException;
15	import org.w3c.dom.Document;
16	import org.w3c.dom.Element;
17	import org.w3c.dom.NamedNodeMap;
18	import org.w3c.dom.Node;
19	import org.w3c.dom.NodeList;
20	import org.w3c.dom.TypeInfo;
21	import org.w3c.dom.UserDataHandler;
22
23	public class AutoGUINode implements Node, Element
24	{
25	private String name;
26	private String value;
27	private AutoGUINodeList children;
28	private AutoGUINamedNodeMap attributes;
29
30	public AutoGUINode(String name, String value, AutoGUINodeList children, AutoGUINamedNodeMap attributes)
31	{
32	this.name = name;
33	this.value = value;
34	this.children = children;
35	this.attributes = attributes;
36	}
37
38
39	public Node appendChild(Node newChild) throws DOMException
40	{
41
42	return null;
43	}
44
45	public Node cloneNode(boolean deep)
46	{
47
48	return null;
49	}
50
51	public NamedNodeMap getAttributes()
52	{
53	return attributes;
54	}
55
56	public NodeList getChildNodes()
57	{
58	return children;
59	}
60
61	public Node getFirstChild()
62	{
63
64	return null;
65	}
66
67	public Node getLastChild()
68	{
69
70	return null;
71	}
72
73	public String getLocalName()
74	{
75
76	return null;
77	}
78
79	public String getNamespaceURI()
80	{
81
82	return null;
83	}
84
85	public Node getNextSibling()
86	{
87
88	return null;
89	}
90
91	public String getNodeName()
92	{
93	return name;
94	}
95
96	public short getNodeType()
97	{
98
99	return 0;
100	}
101
102	public String getNodeValue() throws DOMException
103	{
104	return value;
105	}
106
107	public Document getOwnerDocument()
108	{
109
110	return null;
111	}
112
113	public Node getParentNode()
114	{
115
116	return null;
117	}
118
119	public String getPrefix()
120	{
121
122	return null;
123	}
124
125	public Node getPreviousSibling()
126	{
127
128	return null;
129	}
130
131	public boolean hasAttributes()
132	{
133
134	return false;
135	}
136
137	public boolean hasChildNodes()
138	{
139
140	return false;
141	}
142
143	public Node insertBefore(Node newChild, Node refChild) throws DOMException
144	{
145
146	return null;
147	}
148
149	public boolean isSupported(String feature, String version)
150	{
151
152	return false;
153	}
154
155	public void normalize()
156	{
157
158
159	}
160
161	public Node removeChild(Node oldChild) throws DOMException
162	{
163
164	return null;
165	}
166
167	public Node replaceChild(Node newChild, Node oldChild) throws DOMException
168	{
169
170	return null;
171	}
172
173	public void setNodeValue(String nodeValue) throws DOMException
174	{
175
176
177	}
178
179	public void setPrefix(String prefix) throws DOMException
180	{
181
182
183	}
184
185
186	public String getAttribute(String name)
187	{
188	Node node = attributes.getNamedItem(name);
189	return node == null ? null : node.getNodeValue();
190	}
191
192
193	public String getAttributeNS(String namespaceURI, String localName)
194	{
195	return null;
196	}
197
198
199	public Attr getAttributeNode(String name)
200	{
201	return null;
202	}
203
204
205	public Attr getAttributeNodeNS(String namespaceURI, String localName)
206	{
207	return null;
208	}
209
210
211	public NodeList getElementsByTagName(String name)
212	{
213
214	return null;
215	}
216
217
218	public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
219	{
220
221	return null;
222	}
223
224
225	public String getTagName()
226	{
227
228	return null;
229	}
230
231
232	public boolean hasAttribute(String name)
233	{
234
235	return false;
236	}
237
238
239	public boolean hasAttributeNS(String namespaceURI, String localName)
240	{
241
242	return false;
243	}
244
245
246	public void removeAttribute(String name) throws DOMException
247	{
248
249
250	}
251
252
253	public void removeAttributeNS(String namespaceURI, String localName) throws DOMException
254	{
255
256
257	}
258
259
260	public Attr removeAttributeNode(Attr oldAttr) throws DOMException
261	{
262
263	return null;
264	}
265
266
267	public void setAttribute(String name, String value) throws DOMException
268	{
269
270
271	}
272
273
274	public void setAttributeNS(String namespaceURI, String qualifiedName, String value) throws DOMException
275	{
276
277
278	}
279
280
281	public Attr setAttributeNode(Attr newAttr) throws DOMException
282	{
283
284	return null;
285	}
286
287
288	public Attr setAttributeNodeNS(Attr newAttr) throws DOMException
289	{
290
291	return null;
292	}
293
294
295	public short compareDocumentPosition(Node other) throws DOMException
296	{
297
298	return 0;
299	}
300
301
302	public String getBaseURI()
303	{
304
305	return null;
306	}
307
308
309	public Object getFeature(String feature, String version)
310	{
311
312	return null;
313	}
314
315
316	public String getTextContent() throws DOMException
317	{
318
319	return null;
320	}
321
322
323	public Object getUserData(String key)
324	{
325
326	return null;
327	}
328
329
330	public boolean isDefaultNamespace(String namespaceURI)
331	{
332
333	return false;
334	}
335
336
337	public boolean isEqualNode(Node arg)
338	{
339
340	return false;
341	}
342
343
344	public boolean isSameNode(Node other)
345	{
346
347	return false;
348	}
349
350
351	public String lookupNamespaceURI(String prefix)
352	{
353
354	return null;
355	}
356
357
358	public String lookupPrefix(String namespaceURI)
359	{
360
361	return null;
362	}
363
364
365	public void setTextContent(String textContent) throws DOMException
366	{
367
368
369	}
370
371
372	public Object setUserData(String key, Object data, UserDataHandler handler)
373	{
374
375	return null;
376	}
377
378
379	public TypeInfo getSchemaTypeInfo()
380	{
381
382	return null;
383	}
384
385
386	public void setIdAttribute(String name, boolean isId) throws DOMException
387	{
388
389
390	}
391
392
393	public void setIdAttributeNS(String namespaceURI, String localName, boolean isId) throws DOMException
394	{
395
396
397	}
398
399
400	public void setIdAttributeNode(Attr idAttr, boolean isId) throws DOMException
401	{
402
403
404	}
405
406	}

Lines 1-48 Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/junits/AllTests.java (-48 / +50 lines)
1	package org.eclipse.tptp.test.auto.gui.internal.junits;	1	package org.eclipse.tptp.test.auto.gui.internal.junits;
2		2
3	import junit.framework.Test;	3	import junit.framework.Test;
4		4
5	import org.eclipse.hyades.test.common.junit.DefaultTestArbiter;	5	import org.eclipse.hyades.test.common.junit.DefaultTestArbiter;
6	import org.eclipse.hyades.test.common.junit.HyadesTestCase;	6	import org.eclipse.hyades.test.common.junit.HyadesTestCase;
7	import org.eclipse.hyades.test.common.junit.HyadesTestSuite;	7	import org.eclipse.hyades.test.common.junit.HyadesTestSuite;
8		8
9	/**	9	/**
10	* Generated code for the test suite <b>AllTests</b> located at	10	* Generated code for the test suite <b>AllTests</b> located at
11	* <i>/org.eclipse.tptp.test.auto.gui.tests/junit/AllTests.testsuite</i>.	11	* <i>/org.eclipse.tptp.test.auto.gui.internal.tests/junit/AllTests.testsuite</i>.
12	*/	12	*/
13	public class AllTests extends HyadesTestCase	13	public class AllTests extends HyadesTestCase
14	{	14	{
15	/**	15	/**
16	* Constructor for AllTests.	16	* Constructor for AllTests.
17	* @param name	17	* @param name
18	*/	18	*/
19	public AllTests(String name)	19	public AllTests(String name)
20	{	20	{
21	super(name);	21	super(name);
22	}	22	}
23		23
24	/**	24	/**
25	* Returns the JUnit test suite that implements the <b>AllTests</b> definition.	25	* Returns the JUnit test suite that implements the <b>AllTests</b> definition.
26	*/	26	*/
27	public static Test suite() {	27	public static Test suite() {
28	HyadesTestSuite allTests = new HyadesTestSuite("AllTests");	28	HyadesTestSuite allTests = new HyadesTestSuite("AllTests");
29	allTests.setArbiter(DefaultTestArbiter.INSTANCE).setId(	29	allTests.setArbiter(DefaultTestArbiter.INSTANCE).setId(
30	"DB15AFBA97E27DB4545A1C30429A11DB");	30	"DB15AFBA97E27DB4545A1C30429A11DB");
31	return allTests;	31	allTests.addTest(((HyadesTestSuite) TestAutoGUIUtil.suite())
32	}	32	.setTestInvocationId("FDADA7BD7A22D9AB3CF97DB9C8BD11DC"));
33		33	return allTests;
34	/**	34	}
35	* @see junit.framework.TestCase#setUp()	35
36	*/	36	/**
37	protected void setUp() throws Exception	37	* @see junit.framework.TestCase#setUp()
38	{	38	*/
39	}	39	protected void setUp() throws Exception
40		40	{
41	/**	41	}
42	* @see junit.framework.TestCase#tearDown()	42
43	*/	43	/**
44	protected void tearDown() throws Exception	44	* @see junit.framework.TestCase#tearDown()
45	{	45	*/
46	}	46	protected void tearDown() throws Exception
47		47	{
48	}	48	}
		49
		50	}

Added Link Here

(-)junit-plugin/TestLocateEditorControl.xml (+64 lines)
1	<macro version="1.1">
2	<shell descriptive="Plug-in Development - TestPluginProject/src/Test.t..." resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.ui.internal.WorkbenchWindow" return-code="-1">
3	<command descriptive="Project..." type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="menus" widgetId="{{File-New&#x9;Alt+Shift+N-Project...}}-{{1.0}}"/>
4	<shell descriptive="New Project" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.jface.wizard.WizardDialog" return-code="0">
5	<command descriptive="General" type="item-expand" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newWizardSelectionPage" widgetId="org.eclipse.swt.widgets.Tree#1" value="true">
6	<item widgetId="{{org.eclipse.ui.Basic}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
7	</command>
8	<command descriptive="Project" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newWizardSelectionPage" widgetId="org.eclipse.swt.widgets.Tree#1">
9	<item widgetId="{{org.eclipse.ui.wizards.new.project}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
10	</command>
11	<command descriptive="Next &gt;" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="wizard" widgetId="{{15}}-{{1.0}}"/>
12	<command descriptive="TestProject" type="modify" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/basicNewProjectPage" widgetId="Project name:">
13	<![CDATA[TestProject]]>
14	</command>
15	<command descriptive="Finish" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="wizard" widgetId="{{16}}-{{1.0}}"/>
16	</shell>
17	<command type="wait"/>
18	<command descriptive="TestProject" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}">
19	<item widgetId="{{/TestProject}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
20	</command>
21	<command descriptive="Folder" type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="popup/view/org.eclipse.jdt.ui.PackageExplorer/{{/}}-{{1.0}}@@@org.eclipse.tptp.test.auto.gui.adaptive" widgetId="{{New-Folder}}-{{1.0}}"/>
22	<shell descriptive="New Folder" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.jface.wizard.WizardDialog" return-code="0">
23	<command descriptive="folder" type="modify" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newFolderPage1" widgetId="Folder name:">
24	<![CDATA[folder]]>
25	</command>
26	<command descriptive="Finish" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="wizard" widgetId="{{16}}-{{1.0}}"/>
27	</shell>
28	<command descriptive="TestProject" type="item-expand" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}" value="true">
29	<item widgetId="{{/TestProject}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
30	</command>
31	<command type="wait"/>
32	<command descriptive="File" type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="popup/view/org.eclipse.jdt.ui.PackageExplorer/{{/}}-{{1.0}}@@@org.eclipse.tptp.test.auto.gui.adaptive" widgetId="{{New-File}}-{{1.0}}"/>
33	<shell descriptive="New File" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.jface.wizard.WizardDialog" return-code="0">
34	<command descriptive="test.txt" type="modify" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newFilePage1" widgetId="File name:">
35	<![CDATA[test.txt]]>
36	</command>
37	<command descriptive="Finish" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="wizard" widgetId="{{16}}-{{1.0}}"/>
38	</shell>
39	<command descriptive="folder" type="item-expand" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}" value="true">
40	<item widgetId="{{/TestProject/folder}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
41	</command>
42	<command descriptive="TestProject" type="item-expand" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}" value="true">
43	<item widgetId="{{/TestProject}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
44	</command>
45	<command descriptive="test.txt" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}">
46	<item widgetId="{{/TestProject/folder/test.txt}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
47	</command>
48	<command type="wait"/>
49	<command descriptive="Test" type="modify" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="editor/org.eclipse.ui.DefaultTextEditor/test.txt" widgetId="org.eclipse.swt.custom.StyledText#1">
50	<![CDATA[Test]]>
51	</command>
52	<command type="wait"/>
53	<command descriptive="Test" type="focus" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="editor/org.eclipse.ui.DefaultTextEditor/test.txt" widgetId="org.eclipse.swt.custom.StyledText#1"/>
54	<command descriptive="TestProject" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}">
55	<item widgetId="{{/TestProject}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
56	</command>
57	<command type="focus" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="org.eclipse.swt.widgets.Composite#1"/>
58	<command descriptive="Delete Delete" type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="popup/view/org.eclipse.jdt.ui.PackageExplorer/{{/}}-{{1.0}}" widgetId="{{Delete&#x9;Delete}}-{{1.0}}"/>
59	<shell descriptive="Delete Resources" widgetId="org.eclipse.ltk.internal.ui.refactoring.RefactoringWizardDialog2" return-code="0">
60	<command descriptive="Delete project contents on disk (cannot be undone..." type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="shell" widgetId="{{Delete project contents on disk (cannot be undone)}}-{{0.3}}{{null}}-{{0.3}}{{1}}-{{0.3}}{{(484,16)}}-{{0.2}}{{(5,5)}}-{{0.1}}{{0}}-{{0.2}}" selection="true"/>
61	<command descriptive="OK" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="shell" widgetId="{{0}}-{{1.0}}"/>
62	</shell>
63	</shell>
64	</macro>

Added Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/hook/TestUIObjectIdentifierDisambiguation.java (+75 lines)
1	/**********************************************************************
2	* Copyright (c) 2009 Alexander Nyssen.
3	* All rights reserved. This content is made available under
4	* the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	* $Id$
8	*
9	* Contributors:
10	* Alexander Nyssen - Initial contribution
11	**********************************************************************/
12	package org.eclipse.tptp.test.auto.gui.internal.hook;
13
14	import org.eclipse.swt.widgets.TreeItem;
15	import org.eclipse.tptp.test.auto.gui.internal.runner.AutoGUIVerificationHook;
16
17	/**
18	* Generated code for the test suite <b>TestUIObjectIdentifierDisambiguation</b>
19	* located at
20	* <i>/TestProject/src/TestUIObjectIdentifierDisambiguation.testsuite</i>.
21	*/
22	public class TestUIObjectIdentifierDisambiguation extends
23	AutoGUIVerificationHook {
24
25	/**
26	* Constructor for TestUIObjectIdentifierDisambiguation. An instance of this
27	* class is created to test a test method.
28	*
29	* @param testMethodName
30	* The test method to be tested.
31	* @param paramTypes
32	* The parameter types of the test method
33	* @param args
34	* The arguments of the test method
35	*/
36	public TestUIObjectIdentifierDisambiguation(String testMethodName,
37	Class[] paramTypes, Object[] args) {
38	super(testMethodName, paramTypes, args);
39	}
40
41	/**
42	* @see junit.framework.TestCase#setUp()
43	*/
44	protected void setUp() throws Exception {
45	}
46
47	/**
48	* @see junit.framework.TestCase#tearDown()
49	*/
50	protected void tearDown() throws Exception {
51	}
52
53	/**
54	* Verify item was selected
55	*
56	* @throws Exception
57	*/
58	public void verifyItemWasSelected(org.eclipse.ui.IEditorPart arg0,
59	org.eclipse.swt.widgets.Tree arg1) throws Exception {
60	TreeItem manifestItem = arg1.getItem(3);
61	assertTrue(manifestItem.getChecked());
62	}
63
64	/**
65	* Verfiy item was deselected
66	*
67	* @throws Exception
68	*/
69	public void verifyItemWasDeselected(org.eclipse.ui.IEditorPart arg0,
70	org.eclipse.swt.widgets.Tree arg1) throws Exception {
71	TreeItem manifestItem = arg1.getItem(3);
72	assertFalse(manifestItem.getChecked());
73	}
74
75	}

Added Link Here

(-)junit-plugin/TestStructuredSelectionCommands.xml (+29 lines)
1	<macro version="1.1">
2	<shell descriptive="Plug-in Development - TestPluginProject/src/Test.t..." widgetId="org.eclipse.ui.internal.WorkbenchWindow" return-code="-1">
3	<command descriptive="Project..." type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="menus" widgetId="{{File-New&#x9;Alt+Shift+N-Project...}}-{{1.0}}"/>
4	<shell descriptive="New Project" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.jface.wizard.WizardDialog" return-code="0">
5	<command descriptive="General" type="item-expand" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newWizardSelectionPage" widgetId="org.eclipse.swt.widgets.Tree#1" value="true">
6	<item widgetId="{{org.eclipse.ui.Basic}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
7	</command>
8	<command descriptive="Project" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newWizardSelectionPage" widgetId="org.eclipse.swt.widgets.Tree#1">
9	<item widgetId="{{org.eclipse.ui.wizards.new.project}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
10	</command>
11	<command type="focus" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/newWizardSelectionPage" widgetId="org.eclipse.swt.widgets.Tree#1"/>
12	<command descriptive="Next &gt;" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="wizard" widgetId="{{15}}-{{1.0}}"/>
13	<command descriptive="TestProject" type="modify" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="wizard-page/basicNewProjectPage" widgetId="Project name:">
14	<![CDATA[TestProject]]>
15	</command>
16	<command descriptive="Finish" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="wizard" widgetId="{{16}}-{{1.0}}"/>
17	</shell>
18	<command type="wait"/>
19	<command descriptive="TestProject" type="item-select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="{{/}}-{{1.0}}">
20	<item widgetId="{{/TestProject}}-{{1.0}}" resolverId="org.eclipse.tptp.test.auto.gui.adaptive"/>
21	</command>
22	<command type="focus" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="view/org.eclipse.jdt.ui.PackageExplorer" widgetId="org.eclipse.swt.widgets.Composite#1"/>
23	<command descriptive="Delete Delete" type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="popup/view/org.eclipse.jdt.ui.PackageExplorer%%%{{/}}-{{1.0}}@@@org.eclipse.tptp.test.auto.gui.adaptive" widgetId="{{Delete&#x9;Delete}}-{{1.0}}"/>
24	<shell descriptive="Delete Resources" widgetId="org.eclipse.ltk.internal.ui.refactoring.RefactoringWizardDialog2" return-code="0">
25	<command descriptive="Delete project contents on disk (cannot be undone..." type="select" resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" contextId="shell" widgetId="{{Delete project contents on disk (cannot be undone)}}-{{0.3}}{{null}}-{{0.3}}{{1}}-{{0.3}}{{(484,16)}}-{{0.2}}{{(5,5)}}-{{0.1}}{{0}}-{{0.2}}" selection="true"/>
26	<command descriptive="OK" type="select" resolverId="org.eclipse.tptp.test.auto.gui.adaptive" contextId="shell" widgetId="{{0}}-{{1.0}}"/>
27	</shell>
28	</shell>
29	</macro>

Added Link Here

(-)junit-plugin/TestSingleSelectionCommandsOldFormat.xml (+12 lines)
1	<macro version="1.1">
2	<shell descriptive="Plug-in Development - TestPluginProject/src/Test.t..." resolverId="org.eclipse.tptp.test.auto.gui.nontrivial" widgetId="org.eclipse.ui.internal.WorkbenchWindow" return-code="-1">
3	<command descriptive="Preferences" type="select" contextId="menus" widgetId="{{Window-Preferences}}-{{1.0}}"/>
4	<shell descriptive="Preferences" widgetId="org.eclipse.ui.internal.dialogs.WorkbenchPreferenceDialog" return-code="1">
5	<command descriptive="Team" type="item-select" contextId="shell" widgetId="org.eclipse.swt.widgets.Tree#1">
6	<item widgetId="{{org.eclipse.team.ui.TeamPreferences}}-{{1.0}}"/>
7	</command>
8	<command descriptive="Resource" type="choice-select" contextId="shell" widgetId="org.eclipse.swt.widgets.Combo#1" choiceId="item#8"/>
9	<command descriptive="Cancel" type="select" contextId="shell" widgetId="{{1}}-{{1.0}}"/>
10	</shell>
11	</shell>
12	</macro>

Added Link Here

(-).settings/org.eclipse.jdt.core.prefs (+12 lines)
1	#Mon Jan 28 23:44:11 CET 2008
2	eclipse.preferences.version=1
3	org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
4	org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.2
5	org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
6	org.eclipse.jdt.core.compiler.compliance=1.4
7	org.eclipse.jdt.core.compiler.debug.lineNumber=generate
8	org.eclipse.jdt.core.compiler.debug.localVariable=generate
9	org.eclipse.jdt.core.compiler.debug.sourceFile=generate
10	org.eclipse.jdt.core.compiler.problem.assertIdentifier=warning
11	org.eclipse.jdt.core.compiler.problem.enumIdentifier=warning
12	org.eclipse.jdt.core.compiler.source=1.3

Removed Link Here

(-)feature.properties (-122 lines)
1	###############################################################################
2	# Copyright (c) 2005, 2008 IBM Corporation and others.
3	# All rights reserved. This program and the accompanying materials
4	# are made available under the terms of the Eclipse Public License v1.0
5	# which accompanies this distribution, and is available at
6	# http://www.eclipse.org/legal/epl-v10.html
7	# $Id: feature.properties,v 1.6 2008/04/10 01:18:10 paules Exp $
8	#
9	# Contributors:
10	# IBM Corporation - initial API and implementation
11	###############################################################################
12
13	# feature.properties
14	# contains externalized strings for feature.xml
15	# "%foo" in feature.xml corresponds to the key "foo" in this file
16	# java.io.Properties file (ISO 8859-1 with "\" escapes)
17	# This file should be translated.
18
19	# NLS_MESSAGEFORMAT_NONE
20	# NLS_ENCODING=UTF-8
21
22	# "featureName" property - name of the feature
23	featureName=TPTP Automated GUI Recorder (AGR)
24
25	# "licenseURL" property - URL of the "Feature License"
26	# do not translate value - just change to point to a locale-specific HTML page
27	licenseURL=license.html
28
29	# "description" property - description of the feature
30	description=TPTP Automated GUI Recorder (AGR) used to record and playback user interactions with an Eclipse application.
31
32	# "providerName" property - name of the company that provides the feature
33	providerName=Eclipse.org
34
35	# "license" property - text of the "Feature Update License"
36	# should be plain text version of license agreement pointed to be "licenseURL"
37	license=\
38	Eclipse Foundation Software User Agreement\n\
39	January 28, 2005\n\
40	\n\
41	Usage Of Content\n\
42	THE ECLIPSE FOUNDATION MAKES AVAILABLE SOFTWARE, DOCUMENTATION, INFORMATION \n\
43	AND/OR OTHER MATERIALS FOR OPEN SOURCE PROJECTS (COLLECTIVELY "CONTENT"). USE \n\
44	OF THE CONTENT IS GOVERNED BY THE TERMS AND CONDITIONS OF THIS AGREEMENT AND/OR \n\
45	THE TERMS AND CONDITIONS OF LICENSE AGREEMENTS OR NOTICES INDICATED OR \n\
46	REFERENCED BELOW. BY USING THE CONTENT, YOU AGREE THAT YOUR USE OF THE CONTENT \n\
47	IS GOVERNED BY THIS AGREEMENT AND/OR THE TERMS AND CONDITIONS OF ANY APPLICABLE \n\
48	LICENSE AGREEMENTS OR NOTICES INDICATED OR REFERENCED BELOW. IF YOU DO NOT \n\
49	AGREE TO THE TERMS AND CONDITIONS OF THIS AGREEMENT AND THE TERMS AND \n\
50	CONDITIONS OF ANY APPLICABLE LICENSE AGREEMENTS OR NOTICES INDICATED OR \n\
51	REFERENCED BELOW, THEN YOU MAY NOT USE THE CONTENT.\n\
52	\n\
53	Applicable Licenses\n\
54	Unless otherwise indicated, all Content made available by the Eclipse \n\
55	Foundation is provided to you under the terms and conditions of the Eclipse \n\
56	Public License Version 1.0 ("EPL"). A copy of the EPL is provided with this \n\
57	Content and is also available at http://www.eclipse.org/legal/epl-v10.html. For \n\
58	purposes of the EPL, "Program" will mean the Content.\n\
59	\n\
60	Content includes, but is not limited to, source code, object code, \n\
61	documentation and other files maintained in the Eclipse.org CVS repository \n\
62	("Repository") in CVS modules ("Modules") and made available as downloadable \n\
63	archives ("Downloads").\n\
64	\n\
65	Content may be apportioned into plug-ins ("Plug-ins"), plug-in fragments \n\
66	("Fragments"), and features ("Features"). A Feature is a bundle of one or more \n\
67	Plug-ins and/or Fragments and associated material. Files named "feature.xml" \n\
68	may contain a list of the names and version numbers of the Plug-ins and/or \n\
69	Fragments associated with a Feature. Plug-ins and Fragments are located in \n\
70	directories named "plugins" and Features are located in directories named \n\
71	"features".\n\
72	\n\
73	Features may also include other Features ("Included Features"). Files named \n\
74	"feature.xml" may contain a list of the names and version numbers of Included \n\
75	Features.\n\
76	\n\
77	The terms and conditions governing Plug-ins and Fragments should be contained \n\
78	in files named "about.html" ("Abouts"). The terms and conditions governing \n\
79	Features and Included Features should be contained in files named \n\
80	"license.html" ("Feature Licenses"). Abouts and Feature Licenses may be located \n\
81	in any directory of a Download or Module including, but not limited to the \n\
82	following locations:\n\
83	\n\
84	The top-level (root) directory \n\
85	Plug-in and Fragment directories \n\
86	Subdirectories of the directory named "src" of certain Plug-ins \n\
87	Feature directories \n\
88	Note: if a Feature made available by the Eclipse Foundation is installed using \n\
89	the Eclipse Update Manager, you must agree to a license ("Feature Update \n\
90	License") during the installation process. If the Feature contains Included \n\
91	Features, the Feature Update License should either provide you with the terms \n\
92	and conditions governing the Included Features or inform you where you can \n\
93	locate them. Feature Update Licenses may be found in the "license" property of \n\
94	files named "feature.properties". Such Abouts, Feature Licenses and Feature \n\
95	Update Licenses contain the terms and conditions (or references to such terms \n\
96	and conditions) that govern your use of the associated Content in that \n\
97	directory.\n\
98	\n\
99	THE ABOUTS, FEATURE LICENSES AND FEATURE UPDATE LICENSES MAY REFER TO THE EPL \n\
100	OR OTHER LICENSE AGREEMENTS, NOTICES OR TERMS AND CONDITIONS. SOME OF THESE \n\
101	OTHER LICENSE AGREEMENTS MAY INCLUDE (BUT ARE NOT LIMITED TO):\n\
102	\n\
103	Common Public License Version 1.0 (available at http://www.eclipse.org/legal/cpl-v10.html) \n\
104	Apache Software License 1.1 (available at http://www.apache.org/licenses/LICENSE) \n\
105	Apache Software License 2.0 (available at http://www.apache.org/licenses/LICENSE-2.0) \n\
106	IBM Public License 1.0 (available at http://oss.software.ibm.com/developerworks/opensource/license10.html) \n\
107	Metro Link Public License 1.00 (available at http://www.opengroup.org/openmotif/supporters/metrolink/license.html) \n\
108	Mozilla Public License Version 1.1 (available at http://www.mozilla.org/MPL/MPL-1.1.html) \n\
109	\n\
110	IT IS YOUR OBLIGATION TO READ AND ACCEPT ALL SUCH TERMS AND CONDITIONS PRIOR TO \n\
111	USE OF THE CONTENT. If no About, Feature License or Feature Update License is \n\
112	provided, please contact the Eclipse Foundation to determine what terms and \n\
113	conditions govern that particular Content.\n\
114	\n\
115	Cryptography\n\
116	Content may contain encryption software. The country in which you are currently \n\
117	may have restrictions on the import, possession, and use, and/or re-export to \n\
118	another country, of encryption software. BEFORE using any encryption software, \n\
119	please check the country's laws, regulations and policies concerning the \n\
120	import, possession, or use, and re-export of encryption software, to see if \n\
121	this is permitted.\n
122	########### end of license property ##########################################

Added Link Here

(-).project (+22 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<projectDescription>
3	<name>org.eclipse.tptp.test.auto-feature</name>
4	<comment></comment>
5	<projects>
6	</projects>
7	<buildSpec>
8	<buildCommand>
9	<name>org.eclipse.pde.ManifestBuilder</name>
10	<arguments>
11	</arguments>
12	</buildCommand>
13	<buildCommand>
14	<name>org.eclipse.pde.SchemaBuilder</name>
15	<arguments>
16	</arguments>
17	</buildCommand>
18	</buildSpec>
19	<natures>
20	<nature>org.eclipse.pde.PluginNature</nature>
21	</natures>
22	</projectDescription>

Removed Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/commands/ViewCommandTarget.java (-34 lines)
1	/*******************************************************************************
2	* Copyright (c) 2000, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.tptp.test.auto.gui.internal.commands;
12
13	import org.eclipse.swt.widgets.Widget;
14	import org.eclipse.ui.IViewPart;
15	import org.eclipse.ui.IWorkbenchPage;
16
17	public class ViewCommandTarget extends CommandTarget {
18	public ViewCommandTarget(Widget widget, IViewPart view) {
19	super(widget, view);
20	}
21
22	public IViewPart getView() {
23	return (IViewPart)getContext();
24	}
25
26	/* (non-Javadoc)
27	* @see org.eclipse.ui.macro.CommandTarget#ensureVisible()
28	*/
29	public void ensureVisible() {
30	IViewPart view = getView();
31	IWorkbenchPage page = view.getViewSite().getPage();
32	page.activate(view);
33	}
34	}

Removed Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/core/VerificationMetaData.java (-103 lines)
1	/*******************************************************************************
2	* Copyright (c) 2005, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	* $Id: VerificationMetaData.java,v 1.2 2006/10/27 14:39:10 amehregani Exp $
8	*
9	* Contributors:
10	* IBM Corporation - initial API and implementation
11	*******************************************************************************/
12	package org.eclipse.tptp.test.auto.gui.internal.core;
13
14
15	/**
16	* A container class for the data that the verificaiton command will need
17	*
18	* @author Ali Mehregani
19	*/
20	public class VerificationMetaData
21	{
22	/* The possible types */
23	public static final byte EDITOR = 0x01;
24	public static final byte VIEW = 0x02;
25	public static final byte SHELL = 0x03;
26
27
28	/* The context id is the id of the editor, viewer, etc... that will be used to retrieve it */
29	private String contextId;
30
31	/* The location is the plugin that contains the hook source code */
32	private String location;
33
34	/* The resource is the class name containing the hook */
35	private String resource;
36
37	/* The hook is the method name representing the verification point */
38	private String hook;
39
40	/* The focus type indicates whether the type of context being retrieved */
41	private byte focusType;
42
43	public VerificationMetaData()
44	{
45	focusType = -1;
46	}
47
48	public String getContextId()
49	{
50	return contextId;
51	}
52
53	public void setContextId(String contextId)
54	{
55	this.contextId = contextId;
56	}
57
58	public byte getFocusType()
59	{
60	return focusType;
61	}
62
63	public void setFocusType(byte focusType)
64	{
65	this.focusType = focusType;
66	}
67
68	public String getHook()
69	{
70	return hook;
71	}
72
73	public void setHook(String hook)
74	{
75	this.hook = hook;
76	}
77
78	public String getLocation()
79	{
80	return location;
81	}
82
83	public void setLocation(String location)
84	{
85	this.location = location;
86	}
87
88	public String getResource()
89	{
90	return resource;
91	}
92
93	public void setResource(String resource)
94	{
95	this.resource = resource;
96	}
97
98	public boolean isComplete()
99	{
100	return contextId != null && location != null && resource != null && hook != null && focusType != -1;
101	}
102
103	}

Lines 1-30 Link Here

(-)plugin.properties (-30 / +32 lines)
1	###############################################################################	1	###############################################################################
2	# Copyright (c) 2005, 2008 IBM Corporation and others.	2	# Copyright (c) 2005, 2008 IBM Corporation and others.
3	# All rights reserved. This program and the accompanying materials	3	# All rights reserved. This program and the accompanying materials
4	# are made available under the terms of the Eclipse Public License v1.0	4	# are made available under the terms of the Eclipse Public License v1.0
5	# which accompanies this distribution, and is available at	5	# which accompanies this distribution, and is available at
6	# http://www.eclipse.org/legal/epl-v10.html	6	# http://www.eclipse.org/legal/epl-v10.html
7	# $Id: plugin.properties,v 1.11 2008/04/16 14:58:24 jkubasta Exp $	7	# $Id: plugin.properties,v 1.11 2008/04/16 14:58:24 jkubasta Exp $
8	#	8	#
9	# Contributors:	9	# Contributors:
10	# IBM Corporation - initial API and implementation	10	# IBM Corporation - initial API and implementation
11	###############################################################################	11	###############################################################################
12	#	12	#
13	# plugin.properties	13	# plugin.properties
14	#	14	#
15	# This property file ONLY contains messages for the this plug-in's MANIFEST.MF and plugin.xml files.	15	# This property file ONLY contains messages for the this plug-in's MANIFEST.MF and plugin.xml files.
16	#	16	#
17	# NOTE: When using substitution parameters, all single quote characters (e.g. ') must be escaped with a preceding single quote character (e.g. ''text in single quotes'').	17	# NOTE: When using substitution parameters, all single quote characters (e.g. ') must be escaped with a preceding single quote character (e.g. ''text in single quotes'').
18	#	18	#
19	# NLS_MESSAGEFORMAT_VAR	19	# NLS_MESSAGEFORMAT_VAR
20	# NLS_ENCODING=UTF-8	20	# NLS_ENCODING=UTF-8
21		21
22	pluginName = TPTP Automated GUI Recorder (AGR)	22	pluginName = TPTP Automated GUI Recorder (AGR)
23	providerName = Eclipse.org	23	providerName = Eclipse.org
24		24
25		25
26	TST_SUITE_AUTO_GUI_NAME = TPTP Automated GUI Test	26	TST_SUITE_AUTO_GUI_NAME = TPTP Automated GUI Test
27	TST_SUITE_AUTO_GUI_DESC = Use this suite to create Automated GUI test cases in the Eclipse platform	27	TST_SUITE_AUTO_GUI_DESC = Use this suite to create Automated GUI test cases in the Eclipse platform
28	TST_CASE_AUTO_GUI_NAME = TPTP Automated GUI Test Case	28	TST_CASE_AUTO_GUI_NAME = TPTP Automated GUI Test Case
29	TST_CASE_AUTO_GUI_DESC = Test Case which can store events recorded on the UI and be used to play them back	29	TST_CASE_AUTO_GUI_DESC = Test Case which can store events recorded on the UI and be used to play them back
30	widgetResolver = Widget Resolver Extension	30	widgetResolver = Widget Resolver Extension (Deprecated)
		31	uiObjectResolverDelegate = UI Object Resolver Delegate Extension
		32	macroCommandFactory = MacroCommandFactory Replacement Extension

Lines 1-34 Link Here

(-).project (-34 / +34 lines)
1	<?xml version="1.0" encoding="UTF-8"?>	1	<?xml version="1.0" encoding="UTF-8"?>
2	<projectDescription>	2	<projectDescription>
3	<name>org.eclipse.tptp.test.auto.gui</name>	3	<name>Copy of org.eclipse.tptp.test.auto.gui</name>
4	<comment></comment>	4	<comment></comment>
5	<projects>	5	<projects>
6	</projects>	6	</projects>
7	<buildSpec>	7	<buildSpec>
8	<buildCommand>	8	<buildCommand>
9	<name>org.eclipse.emf.codegen.JETBuilder</name>	9	<name>org.eclipse.emf.codegen.JETBuilder</name>
10	<arguments>	10	<arguments>
11	</arguments>	11	</arguments>
12	</buildCommand>	12	</buildCommand>
13	<buildCommand>	13	<buildCommand>
14	<name>org.eclipse.jdt.core.javabuilder</name>	14	<name>org.eclipse.jdt.core.javabuilder</name>
15	<arguments>	15	<arguments>
16	</arguments>	16	</arguments>
17	</buildCommand>	17	</buildCommand>
18	<buildCommand>	18	<buildCommand>
19	<name>org.eclipse.pde.ManifestBuilder</name>	19	<name>org.eclipse.pde.ManifestBuilder</name>
20	<arguments>	20	<arguments>
21	</arguments>	21	</arguments>
22	</buildCommand>	22	</buildCommand>
23	<buildCommand>	23	<buildCommand>
24	<name>org.eclipse.pde.SchemaBuilder</name>	24	<name>org.eclipse.pde.SchemaBuilder</name>
25	<arguments>	25	<arguments>
26	</arguments>	26	</arguments>
27	</buildCommand>	27	</buildCommand>
28	</buildSpec>	28	</buildSpec>
29	<natures>	29	<natures>
30	<nature>org.eclipse.emf.codegen.jet.IJETNature</nature>	30	<nature>org.eclipse.emf.codegen.jet.IJETNature</nature>
31	<nature>org.eclipse.pde.PluginNature</nature>	31	<nature>org.eclipse.pde.PluginNature</nature>
32	<nature>org.eclipse.jdt.core.javanature</nature>	32	<nature>org.eclipse.jdt.core.javanature</nature>
33	</natures>	33	</natures>
34	</projectDescription>	34	</projectDescription>

Lines 1-13 Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/codegen/VerificationHookMethodGenerator.java (-10 lines)
1	/**********************************************************************
2	* Copyright (c) 2007, 2009 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	**********************************************************************/
11	package org.eclipse.tptp.test.auto.gui.internal.codegen;	1	package org.eclipse.tptp.test.auto.gui.internal.codegen;
12		2
13	import org.eclipse.hyades.test.tools.core.internal.common.codegen.Helper;	3	import org.eclipse.hyades.test.tools.core.internal.common.codegen.Helper;

Removed Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/macro/XMLDefaultHandler.java (-166 lines)
1	/*******************************************************************************
2	* Copyright (c) 2003, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.tptp.test.auto.gui.internal.macro;
12
13	import java.util.Hashtable;
14	import java.util.Stack;
15
16	import javax.xml.parsers.DocumentBuilderFactory;
17	import javax.xml.parsers.ParserConfigurationException;
18
19	import org.w3c.dom.Element;
20	import org.w3c.dom.Node;
21	import org.w3c.dom.Text;
22	import org.xml.sax.Attributes;
23	import org.xml.sax.Locator;
24	import org.xml.sax.helpers.DefaultHandler;
25
26	public class XMLDefaultHandler extends DefaultHandler
27	{
28
29	private org.w3c.dom.Document fDocument;
30
31	private Locator fLocator;
32
33	private Hashtable fLineTable;
34
35	private Element fRootElement;
36
37	private Stack fElementStack = new Stack();
38
39	/* Indicates whether a CDATA section is reached */
40	private boolean cdataStarted;
41
42	public XMLDefaultHandler()
43	{
44	fLineTable = new Hashtable();
45	}
46
47	public void startElement(String uri, String localName, String qName, Attributes attributes)
48	{
49	Element element = fDocument.createElement(qName);
50	for (int i = 0; i < attributes.getLength(); i++)
51	{
52	element.setAttribute(attributes.getQName(i), attributes.getValue(i));
53	}
54
55	Integer lineNumber = new Integer(fLocator.getLineNumber());
56	Integer[] range = new Integer[] { lineNumber, new Integer(-1) };
57	fLineTable.put(element, range);
58	if (fRootElement == null)
59	fRootElement = element;
60	else
61	((Element) fElementStack.peek()).appendChild(element);
62	fElementStack.push(element);
63	}
64
65	public void endElement(String uri, String localName, String qName)
66	{
67	Integer[] range = (Integer[]) fLineTable.get(fElementStack.pop());
68	range[1] = new Integer(fLocator.getLineNumber());
69	}
70
71	/*
72	* (non-Javadoc)
73	*
74	* @see org.xml.sax.helpers.DefaultHandler#setDocumentLocator(org.xml.sax.Locator)
75	*/
76	public void setDocumentLocator(Locator locator)
77	{
78	fLocator = locator;
79	}
80
81	/*
82	* (non-Javadoc)
83	*
84	* @see org.xml.sax.helpers.DefaultHandler#startDocument()
85	*/
86	public void startDocument()
87	{
88	DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
89	try
90	{
91	fDocument = factory.newDocumentBuilder().newDocument();
92	}
93	catch (ParserConfigurationException e)
94	{
95	}
96	}
97
98	/*
99	* (non-Javadoc)
100	*
101	* @see org.xml.sax.helpers.DefaultHandler#endDocument()
102	*/
103	public void endDocument()
104	{
105	fDocument.appendChild(fRootElement);
106	}
107
108	/*
109	* (non-Javadoc)
110	*
111	* @see org.xml.sax.helpers.DefaultHandler#processingInstruction(java.lang.String,
112	* java.lang.String)
113	*/
114	public void processingInstruction(String target, String data)
115	{
116	fDocument.appendChild(fDocument.createProcessingInstruction(target, data));
117	}
118
119	/*
120	* (non-Javadoc)
121	*
122	* @see org.xml.sax.helpers.DefaultHandler#characters(char[], int, int)
123	*/
124	public void characters(char[] characters, int start, int length)
125	{
126	StringBuffer buff = new StringBuffer();
127	for (int i = 0; i < length; i++)
128	{
129	buff.append(characters[start + i]);
130	}
131
132	String buffValue = buff.toString();
133	boolean isBufferJustWhiteSpace = buffValue.trim().equals("");
134	boolean isBufferEmpty = buffValue.length() <= 0;
135
136	if ((cdataStarted && isBufferEmpty) \|\| (!cdataStarted && isBufferJustWhiteSpace))
137	{
138	cdataStarted = false;
139	return;
140	}
141
142	Text text = fDocument.createTextNode(buffValue);
143	cdataStarted = true;
144	if (fRootElement == null)
145	fDocument.appendChild(text);
146	else
147	((Element) fElementStack.peek()).appendChild(text);
148	}
149
150	public Node getDocumentElement()
151	{
152	fDocument.getDocumentElement().normalize();
153	return fDocument.getDocumentElement();
154	}
155
156	public org.w3c.dom.Document getDocument()
157	{
158	fDocument.getDocumentElement().normalize();
159	return fDocument;
160	}
161
162	public Hashtable getLineTable()
163	{
164	return fLineTable;
165	}
166	}

Removed Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/macro/ObjectMineManager.java (-395 lines)
1	/*******************************************************************************
2	* Copyright (c) 2006, 2008 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.tptp.test.auto.gui.internal.macro;
12
13	import java.io.ByteArrayInputStream;
14	import java.io.IOException;
15	import java.util.Hashtable;
16	import java.util.List;
17
18	import org.eclipse.core.runtime.CoreException;
19	import org.eclipse.core.runtime.IPath;
20	import org.eclipse.core.runtime.Path;
21	import org.eclipse.emf.common.util.URI;
22	import org.eclipse.emf.ecore.EObject;
23	import org.eclipse.emf.ecore.resource.Resource;
24	import org.eclipse.hyades.models.common.facades.behavioral.ITestSuite;
25	import org.eclipse.hyades.models.common.facades.behavioral.impl.HyadesUtil;
26	import org.eclipse.hyades.test.core.util.EMFUtil;
27	import org.eclipse.osgi.util.NLS;
28	import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
29	import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
30	import org.eclipse.tptp.test.auto.gui.internal.GlobalConstants;
31	import org.eclipse.tptp.test.auto.gui.internal.core.IObjectMine;
32	import org.eclipse.tptp.test.auto.gui.internal.core.IUIObject;
33	import org.eclipse.tptp.test.auto.gui.internal.macro.ObjectMine.IDCollisionException;
34	import org.eclipse.tptp.test.auto.gui.internal.macro.ObjectMine.UIObjectNotFound;
35	import org.w3c.dom.NamedNodeMap;
36	import org.w3c.dom.Node;
37	import org.w3c.dom.NodeList;
38	import org.xml.sax.SAXException;
39
40
41	/**
42	* In addition to the macro of each test case, a test suite also contains an object
43	* mine keeps a reference of all resolved objects. The purpose of the object mine
44	* is to resolve a widget once and use it many times.
45	* <p/>
46	* This is a singleton class that can be accessed via <code>getInstance()</code>
47	* <p/>
48	*
49	*
50	* @author Ali Mehregani
51	* @author Paul E. Slauenwhite
52	* @version March 7, 2008
53	* @since July 10, 2006
54	*/
55	public class ObjectMineManager
56	{
57	/** The instance of this class */
58	private static ObjectMineManager instance = new ObjectMineManager();
59
60
61	/** Cached object mines
62	* KEY = Test suite id
63	* VALUE = An object of type IObjectMine that represents the object mine of the test suite */
64	private Hashtable cachedObjectMines;
65
66
67	/** Indicates whether a test suite's object mine is dirty or not
68	* KEY = test suite id
69	* VALUE = Boolean.TRUE if object mine is dirty; Boolean.FALSE otherwise
70	*/
71	private Hashtable dirtyStateTable;
72
73
74	/**
75	* Restrict the visibility of the constructor
76	*/
77	private ObjectMineManager()
78	{
79	cachedObjectMines = new Hashtable();
80	dirtyStateTable = new Hashtable();
81	}
82
83
84	/**
85	* Return the instance of this singleton class
86	*
87	* @return The instance of this class
88	*/
89	public static ObjectMineManager getInstance()
90	{
91	return instance;
92	}
93
94
95	/**
96	* Load the object mine of the passed in test suite
97	*
98	* @param testSuite The test suite whose object mine is requested
99	* @param useCache Uses the cached value if this is set to true; otherwise the
100	* object mine is reloaded and returned.
101	*
102	* @return the object mine of the test suite that is passed in.
103	*
104	* @throws UIObjectNotFound In case an expected object is not found
105	* @throws IDCollisionException In case there is a collision id
106	* @throws CoreException In case of any unexpected error
107	*/
108	public IObjectMine loadObjectMine (ITestSuite testSuite, boolean useCache) throws UIObjectNotFound, IDCollisionException, CoreException
109	{
110	/* Is the object mine in cache? */
111	String testSuiteId = testSuite.getId();
112	IObjectMine objectMine = null;
113	if (useCache && (objectMine = (IObjectMine)cachedObjectMines.get(testSuiteId)) != null)
114	{
115	objectMine.setOwner(testSuite);
116	return objectMine;
117	}
118
119
120	/* Otherwise, it needs to be loaded. We need:
121	* - Get the object mine XML fragment
122	* - Parse it and load it */
123	String objectMineXML = HyadesUtil.getTestSuiteVariable(testSuite, GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE);
124	if (objectMineXML == null \|\| objectMineXML.length() <= 0)
125	{
126	/* Return a fresh object mine */
127	objectMine = new ObjectMine(testSuite, null);
128	}
129
130	if (objectMine == null)
131	{
132	objectMine = loadObjectMine (testSuite, objectMineXML);
133	}
134
135	if (objectMine != null)
136	{
137	cachedObjectMines.put(testSuiteId, objectMine);
138	}
139
140	return objectMine;
141	}
142
143	private IObjectMine loadObjectMine (ITestSuite testSuite, String objectMineXML) throws UIObjectNotFound, IDCollisionException, CoreException
144	{
145	if (objectMineXML == null \|\| objectMineXML.length() <= 0)
146	return new ObjectMine(testSuite, null);
147
148	XMLDefaultHandler handler = null;
149
150	try
151	{
152	handler = MacroUtil.createXMLDocument(new ByteArrayInputStream(objectMineXML.getBytes("UTF-8")));
153	}
154	catch (SAXException e)
155	{
156	AutoGUIUtil.throwCoreException(AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE, 0, e);
157	}
158	catch (IOException e)
159	{
160	AutoGUIUtil.throwCoreException(AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE, 0, e);
161	}
162
163	/* Walk through the elemets and parse the document */
164	Node rootElement = handler.getDocumentElement();
165	NodeList children = rootElement.getChildNodes();
166
167	IObjectMine objectMine = new ObjectMine(testSuite, handler);
168	for (int i = 0, childCount = children.getLength(); i < childCount; i++)
169	{
170	Node currentChild = children.item(i);
171	String nodeName = currentChild.getNodeName();
172	if (MacroConstants.HEADER_ELEMENT.equals(nodeName))
173	{
174	loadHeader(objectMine, currentChild);
175	}
176	else if (MacroConstants.OBJECTS_ELEMENT.equals(nodeName))
177	{
178	loadObjects (objectMine, currentChild);
179	}
180	}
181
182
183	return objectMine;
184	}
185
186
187	/**
188	* This method should be used if the object mine will be loaded for reading purposes.
189	* Contributors will not be able to use this returned object mine to write any objects.
190	*
191	* @param objectMineXML The XML string representing the object mine
192	*
193	* @return the object mine of the test suite that is passed in.
194	*
195	* @throws UIObjectNotFound In case an expected object is not found
196	* @throws IDCollisionException In case there is a collision id
197	* @throws CoreException In case of any unexpected error
198	*/
199	public IObjectMine loadObjectMine (String objectMineXML) throws UIObjectNotFound, IDCollisionException, CoreException
200	{
201	return loadObjectMine(null, objectMineXML);
202	}
203
204
205	private void loadHeader(IObjectMine objectMine, Node headerNode) throws CoreException, UIObjectNotFound, IDCollisionException
206	{
207	/* Let's first read in the contribute attribute */
208	NamedNodeMap attributes = headerNode.getAttributes();
209	Node contributeAtt = attributes.getNamedItem(MacroConstants.OUTPUT_ATTRIBUTE);
210	if (contributeAtt != null)
211	{
212	ITestSuite testSuite = loadTestSuite(contributeAtt.getNodeValue());
213	if (testSuite == null)
214	{
215	AutoGUIUtil.openErrorWithDetail(
216	AutoGUIMessages.AUTO_GUI_COMMON_ERROR,
217	AutoGUIMessages.AUTO_GUI_ERROR_OBJ_MINE_OUT_NF,
218	null);
219
220	}
221	else
222	{
223	try
224	{
225	IObjectMine outputObjectMine = ObjectMineManager.getInstance().loadObjectMine(testSuite);
226	objectMine.setOutputSource(outputObjectMine);
227	}
228	catch (Exception e)
229	{
230	objectMine.setOutputSource(null);
231	AutoGUIUtil.openErrorWithDetail(
232	AutoGUIMessages.AUTO_GUI_COMMON_ERROR,
233	NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_OBJ_MINE_OUTPUT, testSuite.getName()),
234	e);
235	}
236	}
237	}
238
239	/* Now load in all includes */
240	NodeList children = headerNode.getChildNodes();
241	for (int i = 0, childCount = children.getLength(); i < childCount; i++)
242	{
243	Node currentChild = children.item(i);
244	String nodeName = currentChild.getNodeName();
245	if (MacroConstants.INCLUDE_ELEMENT.equals(nodeName))
246	{
247	Node pathAttribute = currentChild.getAttributes().getNamedItem(MacroConstants.PATH_ATTRIBUTE);
248	if (pathAttribute != null)
249	{
250	ITestSuite testSuite = loadTestSuite(pathAttribute.getNodeValue());
251	IObjectMine includedObjectMine = loadObjectMine(testSuite);
252	objectMine.addInclude(includedObjectMine);
253	}
254	}
255	}
256	}
257
258
259	private void loadObjects(IObjectMine objectMine, Node objectsNode) throws CoreException, UIObjectNotFound, IDCollisionException
260	{
261	NodeList children = objectsNode.getChildNodes();
262	registerObjects(objectMine, null, children);
263	}
264
265
266	private void registerObjects(IObjectMine objectMine, IUIObject parent, NodeList children) throws CoreException, UIObjectNotFound, IDCollisionException
267	{
268	/* For every object */
269	for (int i = 0, childCount = children.getLength(); i < childCount; i++)
270	{
271	Node currentNode = children.item(i);
272
273	NamedNodeMap attributes = currentNode.getAttributes();
274	Node referenceIdNode = attributes.getNamedItem(MacroConstants.REFERENCE_ID_ATTRIBUTE);
275	String referenceId = null;
276	if (referenceIdNode == null \|\| (referenceId = referenceIdNode.getNodeValue()) == null)
277	{
278	Node idAttribute = attributes.getNamedItem(MacroConstants.ID_ATTRIBUTE);
279	String objectId = idAttribute == null ? AutoGUIMessages.AUTO_GUI_COMMON_UNKNOWN : idAttribute.getNodeValue();
280	AutoGUIUtil.throwCoreException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE_REF, objectId), 0);
281	}
282
283	IUIObject guiObject = objectMine.lookupUIObject(parent, referenceId);
284
285	/* Register the object if it's not yet registered */
286	if (guiObject == null)
287	{
288	guiObject = objectMine.registerObject(parent, currentNode);
289	}
290	/* Otherwise throw an exception if there is an id collision */
291	else
292	{
293	Node contextIdNode = attributes.getNamedItem(MacroConstants.CONTEXT_ID_ATTRIBUTE);
294	Node objectIdNode = attributes.getNamedItem(MacroConstants.ID_ATTRIBUTE);
295	String contextId = contextIdNode == null ? null : contextIdNode.getNodeValue();
296	String objectId = objectIdNode.getNodeValue();
297
298	if (((contextId == null && guiObject.getContextId() != null) \|\|
299	(contextId != null && !contextId.equals(guiObject.getContextId()))) \|\|
300	!objectId.equals(guiObject.getObjectId()))
301	{
302	throw new IDCollisionException(NLS.bind(AutoGUIMessages.AUTO_GUI_ERROR_TST_OBJ_MINE_ID, referenceId));
303	}
304	}
305
306	/* Load the children of this object */
307	if (currentNode.getChildNodes().getLength() > 0)
308	registerObjects(objectMine, guiObject, currentNode.getChildNodes());
309	}
310	}
311
312
313	private ITestSuite loadTestSuite(String testSuitePath) throws CoreException
314	{
315	if (testSuitePath == null \|\| testSuitePath.length() <= 0)
316	return null;
317
318	IPath path = new Path(testSuitePath);
319	URI uri = URI.createPlatformResourceURI(path.toString());
320	EObject[] eObjects = EMFUtil.getEObjects(uri, true);
321	return eObjects != null && eObjects.length > 0 && eObjects[0] instanceof ITestSuite ? (ITestSuite)eObjects[0] : null;
322	}
323
324
325	public void writeObjectMine(IObjectMine objectMine)
326	{
327	writeObjectMine (objectMine, false);
328	}
329
330	private void writeObjectMine(IObjectMine objectMine, boolean autoSave)
331	{
332	ITestSuite testSuite = objectMine.getOwner();
333	Resource testSuiteResource = ((EObject)testSuite).eResource();
334	autoSave = autoSave && (testSuiteResource != null && !testSuiteResource.isModified());
335
336	String xmlSerialization = objectMine.serializeToString();
337	HyadesUtil.setTestSuiteVariable(testSuite, GlobalConstants.TEST_SUITE_PROPERTY_OBJECT_MINE, xmlSerialization);
338
339	if (autoSave)
340	{
341	try
342	{
343	EMFUtil.save(testSuiteResource);
344	} catch (Exception e)
345	{
346	/* Shouldn't happen */
347	e.printStackTrace();
348	}
349	}
350
351	/* We also need to update all object mines included by the object mine passed in */
352	List includes = objectMine.getIncludes();
353	for (int i = 0, includeCount = includes.size(); i < includeCount; i++)
354	{
355	IObjectMine currentObjectMine = (IObjectMine)includes.get(i);
356	writeObjectMine (currentObjectMine, true);
357	}
358
359
360	dirtyStateTable.put(testSuite.getId(), Boolean.TRUE);
361	}
362
363
364	public IObjectMine loadObjectMine(ITestSuite testSuite) throws UIObjectNotFound, IDCollisionException, CoreException
365	{
366	Boolean dirtyState = (Boolean)dirtyStateTable.get(testSuite.getId());
367	boolean isObjectMineDirty = dirtyState == null ? false : dirtyState.booleanValue();
368	dirtyStateTable.put(testSuite.getId(), Boolean.FALSE);
369	return loadObjectMine(testSuite, !isObjectMineDirty);
370	}
371
372
373	/**
374	* Marks the object mine of the passed in test suite as dirty
375	*
376	* @param testSuite The test suite
377	*/
378	public void markObjectMineDirty(ITestSuite testSuite)
379	{
380	if (testSuite == null)
381	return;
382
383	dirtyStateTable.put(testSuite.getId(), Boolean.TRUE);
384	}
385
386
387	/**
388	* Removes all entries in cache.
389	* This should be carefully used.
390	*/
391	public void clearCache()
392	{
393	cachedObjectMines.clear();
394	}
395	}

Removed Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/resolvers/NonTrivialWidgetResolver.java (-538 lines)
1	/*******************************************************************************
2	* Copyright (c) 2005, 2008 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	* $Id: NonTrivialWidgetResolver.java,v 1.7 2008/04/18 13:45:30 dmorris Exp $
8	*
9	* Contributors:
10	* IBM Corporation - initial API and implementation
11	*******************************************************************************/
12	package org.eclipse.tptp.test.auto.gui.internal.resolvers;
13
14	import org.eclipse.hyades.models.hierarchy.TRCAgentProxy;
15	import org.eclipse.swt.custom.CTabItem;
16	import org.eclipse.swt.graphics.Point;
17	import org.eclipse.swt.widgets.Button;
18	import org.eclipse.swt.widgets.Composite;
19	import org.eclipse.swt.widgets.Control;
20	import org.eclipse.swt.widgets.Group;
21	import org.eclipse.swt.widgets.Item;
22	import org.eclipse.swt.widgets.Label;
23	import org.eclipse.swt.widgets.Menu;
24	import org.eclipse.swt.widgets.MenuItem;
25	import org.eclipse.swt.widgets.TabItem;
26	import org.eclipse.swt.widgets.Text;
27	import org.eclipse.swt.widgets.ToolBar;
28	import org.eclipse.swt.widgets.ToolItem;
29	import org.eclipse.swt.widgets.Tree;
30	import org.eclipse.swt.widgets.TreeItem;
31	import org.eclipse.swt.widgets.Widget;
32	import org.eclipse.tptp.test.auto.gui.internal.core.IWidgetId;
33	import org.eclipse.tptp.test.auto.gui.internal.core.IWidgetResolver;
34	import org.eclipse.tptp.test.auto.gui.internal.macro.MacroUtil;
35	import org.eclipse.tptp.trace.ui.internal.launcher.core.AnalysisType;
36	import org.eclipse.tptp.trace.ui.internal.launcher.core.DataCollectorTreeContentProvider.ParentChildNode;
37	import org.eclipse.ui.dialogs.FileSystemElement;
38	import org.eclipse.ui.model.IWorkbenchAdapter;
39	import org.eclipse.ui.views.IViewCategory;
40
41	/**
42	* <p>
43	* The purpose of this class is to resolve widgets that cannot be resolved using the
44	* AdaptiveWidgetResolver. These widgets will likely require nested calls in order to
45	* be determined.
46	* </p>
47	* <p>
48	* Some of the properties used to resolve a widget are locale dependent (e.g. the name
49	* of a button or the closest label to a text box)
50	* </p>
51	*
52	* @since 4.1
53	* @author Ali Mehregani
54	*/
55	public class NonTrivialWidgetResolver implements IWidgetResolver
56	{
57	/**
58	* The id of this resolver -- must be in sync with the id registered with
59	* the widgetResolver extension.
60	*/
61	private static final String ID = "org.eclipse.tptp.test.auto.gui.nontrivial";
62
63	public IWidgetId getUniqueId(Widget parent, Object object)
64	{
65	if (!(object instanceof Widget))
66	return null;
67
68	Widget widget = (Widget) object;
69	Object data = widget.getData();
70
71	IWidgetId widgetId = null;
72
73
74	/* Resolve the object based on the data type of the widget */
75	/* An agent */
76	if (data instanceof TRCAgentProxy)
77	{
78	widgetId = resolveAgentProxy (widget);
79	}
80	/* A file system element */
81	else if (data instanceof FileSystemElement)
82	{
83	widgetId = resolveFileSystemElement (widget);
84	}
85	/* A view catgory */
86	else if (data instanceof IViewCategory)
87	{
88	String id = ((IViewCategory)data).getId();
89	if (id != null && id.length() > 0)
90	{
91	widgetId = new PrimitiveWidgetId();
92	((PrimitiveWidgetId)widgetId).setId(id);
93	}
94	}
95	/* Analysis type */
96	else if (data instanceof ParentChildNode)
97	{
98	Object child = ((ParentChildNode)data).child;
99	if (child instanceof AnalysisType)
100	{
101	widgetId = resolveAnalysisType((AnalysisType)child);
102	}
103	}
104
105	/* Resolve the object based on its widget type */
106	/* A menu item or a tree item*/
107	else if (widget instanceof MenuItem \|\| widget instanceof TreeItem)
108	{
109	widgetId = resolveItem ((Item)widget);
110	}
111	/* A button */
112	else if (widget instanceof Button)
113	{
114	widgetId = resolveButton (parent, (Button)widget, null);
115	}
116	/* A text box */
117	else if (widget instanceof Text)
118	{
119	widgetId = resolveText ((Text)widget);
120	}
121	/* A CTab item */
122	else if (widget instanceof CTabItem)
123	{
124	widgetId = validateText(((CTabItem)widget).getText());
125	}
126	/* A tab item */
127	else if (widget instanceof TabItem)
128	{
129	widgetId = validateText(((TabItem)widget).getText());
130	}
131	/* A toolbar */
132	else if (widget instanceof ToolBar)
133	{
134	widgetId = resolveToolBar ((ToolBar)widget);
135	}
136	/* A tool item */
137	else if (widget instanceof ToolItem)
138	{
139	widgetId = resolveToolbarItem ((ToolItem)widget);
140	}
141
142
143	if (widgetId != null)
144	{
145	widgetId.setResolverId(ID);
146	}
147
148	return widgetId;
149	}
150
151
152
153	private IWidgetId resolveAnalysisType(AnalysisType analysisType)
154	{
155	Object[] properties =
156	{
157	new Object[] {analysisType.getId(), "1.0"},
158	};
159
160	return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
161	}
162
163
164
165	private IWidgetId resolveToolBar(ToolBar toolbar)
166	{
167	int itemCount = toolbar.getItemCount();
168	String firstItem = itemCount > 1 ? limitText(toolbar.getItem(0).getToolTipText()) : null,
169	lastItem = itemCount > 2 ? limitText(toolbar.getItem(itemCount - 1).getToolTipText()) : null;
170	int style = toolbar.getStyle();
171
172	if (firstItem == null && lastItem == null)
173	return null;
174
175	Object[] properties =
176	{
177	new Object[] {convertText(firstItem), "0.5"},
178	new Object[] {convertText(lastItem), "0.5"},
179	new Object[] {String.valueOf(itemCount), "0.3"},
180	new Object[] {String.valueOf(style), "0.2"}
181	};
182
183	return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
184	}
185
186
187
188	private IWidgetId resolveToolbarItem(ToolItem item)
189	{
190	String text = convertText(limitText(item.getToolTipText()));
191	String actionId = MacroUtil.getActionId(item).toString();
192	String style = String.valueOf(item.getStyle());
193
194	Object[] properties =
195	{
196	new Object[] {text, "0.7"},
197	new Object[] {actionId, "0.7"},
198	new Object[] {style, "0.3"}
199	};
200
201	return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
202	}
203
204
205
206	private String limitText(String str)
207	{
208	final int MAX_HOVER_TEXT_SIZE = 20;
209	if (str != null && str.length() > MAX_HOVER_TEXT_SIZE)
210	{
211	return str.substring(0,MAX_HOVER_TEXT_SIZE) + "...";
212	}
213	return str;
214	}
215
216
217
218	private IWidgetId resolveButton(Widget parent, Button button, Object id)
219	{
220	String text = null, hoverText = null, size = null, location = null;
221	if ((text = button.getText()) != null)
222	{
223	text = convertText(text.replaceAll("\\&", ""));
224	}
225	/* First 20 characters of the hover text */
226	hoverText = convertText(limitText(button.getToolTipText()));
227	Point sizePt = button.getSize();
228	Point locationPt = button.getLocation();
229	size = "(" + sizePt.x + "," + sizePt.y + ")";
230	location = "(" + locationPt.x + "," + locationPt.y + ")";
231
232	if (id != null && WeightedPropertyWidgetId.countTokens(id.toString()) == 3)
233	{
234
235	Object[] properties =
236	{
237	new Object[] {text, "0.5"},
238	new Object[] {hoverText, "0.5"},
239	new Object[] {size, "0.5"}
240	};
241
242	return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
243	}
244	else
245	{
246	if (parent instanceof Composite)
247	{
248	Control[] children = ((Composite)parent).getChildren();
249	int buttonInx = 0;
250	// if there are multiple buttons with the same text label
251	int sameTextButtons = 0;
252	String indexWeight = "0.2";
253	String lengthWeight = "0.3";
254
255	/* Find the index of the button */
256	for (int i = 0; i < children.length; i++)
257	{
258	if (text != null && children[i] instanceof Button){
259	String label = ((Button)children[i]).getText();
260	if (label != null){
261	label = convertText(label.replaceAll("\\&", ""));
262	if (label.compareTo(text) == 0)
263	sameTextButtons++;
264	}
265	}
266	if (button == children[i])
267	{
268	buttonInx = i;
269	break;
270	}
271	}
272	if (sameTextButtons > 0){
273	// two or more buttons with the same label in the
274	// same child list under a composite parent
275	// so shift the weighting to favor the button index
276	// to get the right weighting
277	indexWeight = "0.4";
278	lengthWeight = "0.1";
279	}
280
281	Object[] properties =
282	{
283	new Object[] {text, "0.3"},
284	new Object[] {hoverText, "0.3"},
285	new Object[] {String.valueOf(children.length), lengthWeight},
286	new Object[] {size, "0.1"},
287	new Object[] {location, "0.1"},
288	new Object[] {String.valueOf(buttonInx), indexWeight},
289
290	};
291
292	float threshold = 0.7f;
293	threshold += text != null ? 0.3 : 0;
294	threshold += hoverText != null ? 0.3 : 0;
295
296	if (threshold >= 1.0)
297	return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
298	}
299	}
300
301	return null;
302	}
303
304
305	/**
306	* Replace "#", "\n" and "\r" with space to avoid having "#" generated in the
307	* object id. The "#" is taken as the separator between widget Class name and
308	* rest of object id (see MacroObjectLocator.locateVisibleChild).
309	*
310	* @param label
311	* @return
312	*/
313	private String convertText(String label) {
314	return label == null ? null : label.replaceAll("#", " ").replaceAll("\n", " ").replaceAll("\r", " ");
315	}
316
317
318	/**
319	* The text of the closest label to a text box is used as a unique
320	* identifier of the text box. The label must be in a limited
321	* vicinity of the text box for its text to be considered as an identifier.
322	* If the text box is owned by a group and the group only owns one text box,
323	* then the group text is used to identify the widget.
324	*
325	* @param text The text box
326	* @return The widget id for text
327	*/
328	private IWidgetId resolveText(Text text)
329	{
330	Composite parent = text.getParent();
331	Control[] children = parent.getChildren();
332
333	String groupText = null;
334	if (parent instanceof Group && (groupText = ((Group)parent).getText()) != null && (groupText = groupText.replaceAll("\\&", "")).length() > 0)
335	{
336	int textBoxNum = 0;
337	for (int i = 0; i < children.length && textBoxNum <= 1; i++)
338	{
339	if (children[i] instanceof Text)
340	textBoxNum++;
341	}
342
343	if (textBoxNum <= 1)
344	return new PrimitiveWidgetId(convertText(groupText));
345	}
346
347	Label closestLabel = null;
348	Point textLocation = text.getLocation();
349	Point currentDistance = new Point(0,0);
350	Point tempDistance = new Point(0,0);
351	for (int i = 0; i < children.length; i++)
352	{
353	Point childLocation = children[i].getLocation();
354	if (children[i] instanceof Label &&
355	(closestLabel == null \|\| (tempDistance = isLabelCloser(childLocation, currentDistance, textLocation)) != null))
356	{
357	boolean firstLabel = closestLabel == null;
358	closestLabel = (Label)children[i];;
359	if (firstLabel)
360	{
361	currentDistance = new Point (Math.abs(childLocation.x - textLocation.x), Math.abs(childLocation.y - textLocation.y));
362	}
363	else
364	{
365	currentDistance = tempDistance;
366	}
367	}
368	}
369
370	String closestLabelText = null;
371	if (closestLabel != null && currentDistance.x + currentDistance.y <= 100 &&
372	closestLabel.getText() != null && (closestLabelText = closestLabel.getText().replaceAll("\\&", "")).length() > 0)
373	return new PrimitiveWidgetId(convertText(closestLabelText));
374	return null;
375	}
376
377
378	private Point isLabelCloser(Point newlblLocation, Point currentDistance, Point textLocation)
379	{
380	Point tempLocation = new Point (Math.abs(newlblLocation.x - textLocation.x), Math.abs(newlblLocation.y - textLocation.y));
381	if (tempLocation.x + tempLocation.y < currentDistance.x + currentDistance.y)
382	return tempLocation;
383	return null;
384	}
385
386
387	private IWidgetId validateText(String text)
388	{
389	if (text != null && (text = text.replaceAll("\\&", "")).length() > 0)
390	return new PrimitiveWidgetId(convertText(text));
391	return null;
392	}
393
394
395	/**
396	* Computes the item id based on the following properties
397	* and weights. The threshold is set to 1.0:
398	*
399	* <ul>
400	* <li> (Descriptive name of the item, 1.0) </li>
401	* </ul>
402	* @param item The item
403	* @return The weighted id
404	*/
405	private IWidgetId resolveItem(Item item)
406	{
407	StringBuffer descriptiveText = new StringBuffer();
408	findItemText(item, descriptiveText);
409
410	/* Remove the ampersands */
411	String itemText = convertText(descriptiveText.toString().replaceAll("\\&", ""));
412
413	Object[] properties =
414	{
415	new Object[] {itemText, "1.0"},
416	};
417
418	return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
419	}
420
421
422	/**
423	* Walk through the item and return a descriptive text that corresponds
424	* to all item selections leading to the item. (e.g. File-New-Project)
425	*
426	* @param item The item
427	* @param descriptiveText In the end, this buffer will contain a
428	* descriptive text of all items leading to the item that
429	* is passed in as argument
430	*/
431	private void findItemText(Item item, StringBuffer descriptiveText)
432	{
433	if (item == null)
434	return;
435
436	String descriptiveTextStr = item.getText();
437	if (descriptiveText.length() > 0)
438	descriptiveTextStr += "-";
439
440	descriptiveText.insert(0, descriptiveTextStr);
441
442	Item parentItem = null;
443	if (item instanceof MenuItem)
444	{
445	Menu menu = ((MenuItem)item).getParent();
446	parentItem = (menu == null ? null : menu.getParentItem());
447	}
448	else if (item instanceof TreeItem)
449	{
450	parentItem = ((TreeItem)item).getParentItem();
451	}
452
453	if (parentItem != null)
454	findItemText(parentItem, descriptiveText);
455	}
456
457
458	private IWidgetId resolveFileSystemElement(Widget widget)
459	{
460
461	FileSystemElement fileSystemElement = (FileSystemElement) widget.getData();
462	if (fileSystemElement.isDirectory())
463	return null;
464
465	Object[] properties =
466	{
467	new Object[] {((IWorkbenchAdapter)fileSystemElement.getAdapter(IWorkbenchAdapter.class)).getLabel(null), "1.0"}
468	};
469
470	return WeightedPropertyWidgetId.constructId (properties, (float)1.0);
471	}
472
473	private WeightedPropertyWidgetId resolveAgentProxy(Widget widget)
474	{
475	StringBuffer treeIndex = new StringBuffer();
476	if (widget instanceof TreeItem)
477	findTreeItemIndex((TreeItem)widget, treeIndex);
478	else
479	return null;
480
481	TRCAgentProxy proxy = (TRCAgentProxy) widget.getData();
482	Object[] properties =
483	{
484	new Object[] {treeIndex.toString(), "0.4"},
485	new Object[] {proxy.getProcessProxy().getName(), "0.2"},
486	new Object[] {proxy.getProcessProxy().getVmArguments(), "0.1"},
487	new Object[] {proxy.getProcessProxy().getClasspath(), "0.1"},
488	new Object[] {proxy.getProcessProxy().getLocation(), "0.1"},
489	new Object[] {proxy.getProcessProxy().getParameters(), "0.1"},
490	new Object[] {proxy.getProfileFile(), "0.1"},
491	new Object[] {proxy.getName(), "0.1"},
492	new Object[] {String.valueOf(proxy.isAttached()), "0.1"},
493	new Object[] {String.valueOf(proxy.isMonitored()), "0.1"},
494	new Object[] {String.valueOf(proxy.isToProfileFile()), "0.1"},
495	};
496
497	return WeightedPropertyWidgetId.constructId (properties, (float)0.7);
498	}
499
500
501
502
503	private void findTreeItemIndex(TreeItem treeItem, StringBuffer sb)
504	{
505	TreeItem parentItem = treeItem.getParentItem();
506	if (parentItem != null)
507	{
508	int index = parentItem.indexOf(treeItem);
509	if (index != -1)
510	sb.append("\|" + String.valueOf(index + 1));
511
512	findTreeItemIndex (parentItem, sb);
513	}
514	Tree tree = treeItem.getParent();
515	int index = tree.indexOf(treeItem);
516	if (index != -1)
517	sb.append("\|" + String.valueOf(index));
518
519	}
520
521
522
523	public boolean foundWidget(Object object, Object id)
524	{
525	Object objectId = null;
526	if (object instanceof Button)
527	{
528	Button button = (Button) object;
529	objectId = resolveButton(button.getParent(), button, id);
530	}
531
532	if (objectId == null)
533	objectId = getUniqueId(object instanceof Control ? ((Control)object).getParent() : null, object);
534	return id == null ? false : objectId == null ? false : objectId.equals(id);
535	}
536
537
538	}

Removed Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/resolvers/AdaptiveWidgetResolver.java (-609 lines)
1	/*******************************************************************************
2	* Copyright (c) 2005, 2009 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	* $Id: AdaptiveWidgetResolver.java,v 1.7 2009/05/17 16:16:28 paules Exp $
8	*
9	* Contributors:
10	* IBM Corporation - initial API and implementation
11	*******************************************************************************/
12	package org.eclipse.tptp.test.auto.gui.internal.resolvers;
13
14	import java.io.IOException;
15	import java.io.InputStream;
16	import java.lang.reflect.Method;
17	import java.net.URL;
18	import java.util.Hashtable;
19	import java.util.Vector;
20
21	import org.eclipse.hyades.test.common.util.XMLUtil;
22	import org.eclipse.jface.dialogs.MessageDialog;
23	import org.eclipse.swt.widgets.Control;
24	import org.eclipse.swt.widgets.Widget;
25	import org.eclipse.tptp.test.auto.gui.internal.AutoGUIMessages;
26	import org.eclipse.tptp.test.auto.gui.internal.AutoGUIUtil;
27	import org.eclipse.tptp.test.auto.gui.internal.GuiPlugin;
28	import org.eclipse.tptp.test.auto.gui.internal.core.IWidgetId;
29	import org.eclipse.tptp.test.auto.gui.internal.core.IWidgetResolver;
30	import org.eclipse.tptp.test.auto.gui.internal.macro.MacroManager;
31	import org.osgi.framework.Bundle;
32	import org.w3c.dom.Element;
33	import org.w3c.dom.NodeList;
34
35	/**
36	* <p>The following widget resolver attempts to resolve widgets using a static
37	* XML file stored under the auto-gui folder under this plug-in.</p>
38	*
39	*
40	* @author Ali Mehregani
41	* @author Paul Slauenwhite
42	* @version May 16, 2009
43	* @since July 10, 2006
44	*/
45	public class AdaptiveWidgetResolver implements IWidgetResolver
46	{
47	/**
48	* The id of this resolver -- must be in sync with the id registered with
49	* the widgetResolver extension.
50	*/
51	private static final String ID = "org.eclipse.tptp.test.auto.gui.adaptive";
52
53	/** The assumed file name relative to this plugin */
54	public final static String WIDGET_REG_FILE = "auto-gui/widgetReg.xml";
55
56	/** The widget registerations */
57	private IWidgetRegistration widgetReg;
58
59
60	public AdaptiveWidgetResolver()
61	{
62	widgetReg = new WidgetRegistration (this, WIDGET_REG_FILE);
63	}
64
65
66	public IWidgetId getUniqueId(Widget parent, Object object)
67	{
68	if (!(object instanceof Widget))
69	return null;
70
71	widgetReg.load();
72	IWidgetId widgetId = widgetReg.getWidgetId((Widget)object);
73	if (widgetId != null)
74	widgetId.setResolverId(ID);
75	return widgetId;
76	}
77
78	/**
79	* Clients have the option of overwriting this in order to be able to locate
80	* the widget them self in the registeration entries that exist.
81	*/
82	public WidgetRegValue findWidget (Hashtable registerations, Widget widget)
83	{
84	return null;
85	}
86
87
88	public class WidgetRegistration implements IWidgetRegistration
89	{
90	/* The file name */
91	private String fileName;
92
93	/* The last size of the file when it was properly read */
94	private long lastModifiedDate;
95
96	/* The file size (stored in case there was an error last time reading the file */
97	private long lastModifiedDateDetected;
98
99	/* Indicates if there was an error in parsing the file */
100	private boolean errorOccurred;
101
102	/* The data structures holding the registered widgets.
103	* Key = class name; Value = WidgetRegValue */
104	private Hashtable regWidgets;
105
106	/* The global match threshold */
107	private float globalMatchThreshold;
108
109	/* The class name used for the default entry */
110	public static final String DEFAULT_ENTYR = "0_DEFAULT_ENTRY";
111
112	/* The adaptive widget resolver used as the driver for resolving widgets */
113	private AdaptiveWidgetResolver adaptiveWidgetResolver;
114
115	public WidgetRegistration (AdaptiveWidgetResolver adaptiveWidgetResolver, String fileName)
116	{
117	this.fileName = fileName;
118	this.lastModifiedDate = 0;
119	this.lastModifiedDateDetected = 0;
120	this.errorOccurred = false;
121	this.regWidgets = new Hashtable();
122	this.adaptiveWidgetResolver = adaptiveWidgetResolver;
123	}
124
125
126	public void load()
127	{
128	InputStream regXMLInputStream = null;
129	try
130	{
131
132
133	Bundle guiBundle = GuiPlugin.getDefault().getBundle();
134	long currentModifiedDate = guiBundle.getLastModified();// added for defect 169733 Liz Dancy
135
136	/* Checking the file size doesn't guarantee to us that the file hasn't changed. This is
137	* the best we can do. Replace this with last modified date if API is available. */
138	if (currentModifiedDate > 0 && (currentModifiedDate == lastModifiedDate \|\| (errorOccurred && lastModifiedDateDetected == currentModifiedDate)))
139	return;
140
141	URL regFileURL = GuiPlugin.getDefault().getBundle().getEntry(fileName);
142	lastModifiedDateDetected = currentModifiedDate;
143
144	/* Parse the XML file */
145	regXMLInputStream = regFileURL.openStream();
146	Element rootElement = XMLUtil.loadDom(regXMLInputStream, "widgetResolverRule");
147	if (rootElement == null)
148	{
149	lastModifiedDate = 0;
150	errorOccurred = true;
151
152	/* Display an error message if we are recording */
153	if (MacroManager.getInstance().getGlobalState() == MacroManager.RECORDING_MODE)
154	{
155	AutoGUIUtil.showMessage(AutoGUIMessages.AUTO_GUI_ERROR_WID_RESOLVER_T,
156	AutoGUIMessages.AUTO_GUI_ERROR_WID_RESOLVER, MessageDialog.WARNING);
157	}
158	return;
159	}
160	this.regWidgets.clear();
161	parseRegFile(rootElement);
162	lastModifiedDate = currentModifiedDate;
163	}
164	catch (Throwable t)
165	{
166	/* Set the file size to zero to invalidate this widget resolver */
167	lastModifiedDate = 0;
168	errorOccurred = true;
169
170	/* Display an error message if we are recording */
171	if (MacroManager.getInstance().getGlobalState() == MacroManager.RECORDING_MODE)
172	{
173	AutoGUIUtil.showMessage(AutoGUIMessages.AUTO_GUI_ERROR_WID_RESOLVER_T,
174	AutoGUIMessages.AUTO_GUI_ERROR_WID_RESOLVER, MessageDialog.WARNING);
175	}
176	}
177	finally
178	{
179	if (regXMLInputStream != null)
180	{
181	try
182	{
183	regXMLInputStream.close();
184	} catch (IOException e)
185	{
186	/* Ignore the error */
187	}
188	}
189	}
190
191	}
192
193	public float getGlobalThreshold()
194	{
195	return globalMatchThreshold;
196	}
197
198	/**
199	* parse the registation file that has already been loaded
200	*/
201	private void parseRegFile(Element rootElement)
202	{
203	if (rootElement == null)
204	return;
205
206	NodeList classList = XMLUtil.getChildrenByName(rootElement, "class");
207	parseClassElements (classList);
208	globalMatchThreshold = Float.parseFloat(XMLUtil.getValue (rootElement, "globalMatchThreshold"));
209	NodeList defaultList = XMLUtil.getChildrenByName(rootElement, "default");
210	parseDefaultElements (defaultList);
211	}
212
213
214	private void parseDefaultElements(NodeList defaultList)
215	{
216	if (defaultList == null \|\| defaultList.getLength() < 1)
217	return;
218
219	/* We only expect one default element */
220	if(defaultList.item(0) instanceof Element)
221	{
222	Element defaultElement = (Element)defaultList.item(0);
223	NodeList methodList = XMLUtil.getChildrenByName(defaultElement, "method");
224	WidgetRegValue widgetReg = new WidgetRegValue();
225
226	parseMethod (methodList, widgetReg);
227	if (widgetReg != null)
228	regWidgets.put(DEFAULT_ENTYR, widgetReg);
229
230	}
231	}
232
233
234	/**
235	* Parse the class elements
236	*/
237	private void parseClassElements(NodeList classList)
238	{
239	if (classList == null \|\| classList.getLength() <= 0)
240	return;
241
242	for(int i = 0; i < classList.getLength(); i++)
243	{
244	if(classList.item(i) instanceof Element)
245	{
246
247	Element classElement = (Element)classList.item(i);
248	String className = XMLUtil.getValue(classElement, "name");
249	NodeList methodList = XMLUtil.getChildrenByName(classElement, "method");
250	WidgetRegValue widgetReg = new WidgetRegValue();
251	String matchThreshold = XMLUtil.getValue(classElement, "matchThreshold");
252	if (matchThreshold != null)
253	widgetReg.setClassMatchThreshold(Float.parseFloat (matchThreshold));
254
255	parseMethod (methodList, widgetReg);
256	if (widgetReg != null)
257	regWidgets.put(className, widgetReg);
258
259
260	}
261	}
262	}
263
264
265	/**
266	* Parse the method element and return a widget registration entry
267	*
268	* @param methodList The method list
269	* @param widgetReg the widget registration entry that will be augmented
270	* @return A widget registeration entry
271	*/
272	private void parseMethod(NodeList methodList, WidgetRegValue widgetReg)
273	{
274	if (methodList == null \|\| methodList.getLength() <= 0)
275	return;
276
277	for(int i = 0; i < methodList.getLength(); i++)
278	{
279	if(methodList.item(i) instanceof Element)
280	{
281	Element methodElement = (Element)methodList.item(i);
282	String methodName = XMLUtil.getValue(methodElement, "name");
283	float weight = Float.parseFloat(XMLUtil.getValue(methodElement, "weight"));
284	PropertyValue propertyVal = new PropertyValue();
285	propertyVal.setWeight(weight);
286
287	NodeList argumentList = XMLUtil.getChildrenByName(methodElement, "argument");
288	if (argumentList != null)
289	parseArguments(argumentList, propertyVal);
290
291	widgetReg.addProperty(methodName, propertyVal);
292	}
293	}
294	}
295
296
297	/**
298	* Parse the arguments
299	*
300	* @param argumentList The arugment list
301	* @param propertyVal The property value entry that will be augmented to.
302	*/
303	private void parseArguments(NodeList argumentList, PropertyValue propertyVal)
304	{
305	if (argumentList == null \|\| argumentList.getLength() <= 0)
306	return;
307
308	Vector arguments = new Vector();
309	for(int i = 0; i < argumentList.getLength(); i++)
310	{
311	if(argumentList.item(i) instanceof Element)
312	{
313	Element argumentElement = (Element)argumentList.item(i);
314	String argumentValue = XMLUtil.getValue(argumentElement, "value");
315	arguments.add(argumentValue);
316	}
317	}
318
319	propertyVal.setArguments(arguments);
320	}
321
322
323	public IWidgetId getWidgetId(Widget widget)
324	{
325	/* Use this resolver if we were able to successfully resolve parse the XML file */
326	if (lastModifiedDate > 0)
327	{
328	/* First attempt the widget itself. If that fails, then try its data attribute */
329	Object data = widget;
330
331	WidgetRegValue widgetValue = (WidgetRegValue)regWidgets.get(data.getClass().getName());
332	if (widgetValue == null && widget.getData() != null)
333	{
334	data = widget.getData();
335	widgetValue = (WidgetRegValue)regWidgets.get(data.getClass().getName());
336
337	/* If that fails, then walk throught the class heirarchy (the interafaces and superclasses */
338	if (widgetValue == null)
339	{
340	widgetValue = walkThroughClassHeirarchy (data.getClass());
341
342	}
343	}
344
345	/* As a final resolution, try and call the driver class to resolve the widget */
346	if (widgetValue == null)
347	widgetValue = adaptiveWidgetResolver.findWidget(regWidgets, widget);
348
349
350	Vector propertyWeightPair = new Vector (5);
351	WeightedPropertyWidgetId adaptiveWidgetId = new WeightedPropertyWidgetId();
352	boolean specificValidEntry = false;
353	boolean defaultValidEntry = false;
354
355	if (widgetValue != null)
356	{
357	float threshold = widgetValue.getClassMatchThreshold();
358	if (threshold == 0)
359	threshold = globalMatchThreshold;
360	adaptiveWidgetId.setThreshold(threshold);
361
362	/* Specific properties associated with this type */
363	specificValidEntry = appendProperties (data, propertyWeightPair, widgetValue);
364	}
365
366	/* Default properties */
367	Vector defaultEntries = new Vector();
368	defaultValidEntry = appendProperties (widget, defaultEntries, (WidgetRegValue)regWidgets.get(DEFAULT_ENTYR), true);
369	if (defaultValidEntry)
370	propertyWeightPair.addAll(propertyWeightPair);
371
372
373	/* Return null if we weren't able to get any of the widgets properties */
374	if (propertyWeightPair.size() <= 0)
375	return null;
376
377	adaptiveWidgetId.setPropertyWeightPair(propertyWeightPair.toArray());
378	if (specificValidEntry \|\| defaultValidEntry)
379	return adaptiveWidgetId;
380	return null;
381	}
382
383	return null;
384	}
385
386
387	private WidgetRegValue walkThroughClassHeirarchy(Class widgetClass)
388	{
389	WidgetRegValue widgetValue = null;
390
391	widgetValue = (WidgetRegValue)regWidgets.get(widgetClass.getName());
392	if (widgetValue != null)
393	return widgetValue;
394
395	Class[] interfaces = widgetClass.getInterfaces();
396
397	/* Try the interfaces first */
398	for (int i = 0; i < interfaces.length; i++)
399	{
400	widgetValue = (WidgetRegValue)regWidgets.get(interfaces[i].getName());
401	widgetValue = (widgetValue == null ? walkThroughClassHeirarchy(interfaces[i]) : widgetValue);
402	if (widgetValue != null)
403	return widgetValue;
404	}
405
406	/* We failed with the interfaces, now try the super class */
407	Class extendedClass = widgetClass.getSuperclass();
408	if (extendedClass != null)
409	widgetValue = walkThroughClassHeirarchy(extendedClass);
410
411	return widgetValue;
412	}
413
414
415	private boolean appendProperties(Object data, Vector propertyWeightPair, WidgetRegValue widgetValue)
416	{
417	return appendProperties(data, propertyWeightPair, widgetValue, false);
418	}
419
420	private boolean appendProperties(Object data, Vector propertyWeightPair, WidgetRegValue widgetValue, boolean isDefault)
421	{
422	boolean validEntry = false;
423	if (widgetValue == null)
424	return false;
425
426	Vector properties = widgetValue.getProperties();
427	for (int i = 0, propertySize = properties.size(); i < propertySize; i++)
428	{
429	String property = (String) properties.get(i);
430	PropertyValue propertyValue = widgetValue.getPropertyValue(property);
431	String retValue = invokeProperty (data, property, propertyValue);
432
433	if ((retValue == null \|\| retValue.length() <= 0) && isDefault)
434	retValue = invokeProperty (((Widget)data).getData(), property, propertyValue);
435
436	/* Don't add it if the return value is null or of zero length */
437	if (retValue == null \|\| retValue.length() <= 0)
438	retValue = "null"; /* Set the value to the literal string 'null' */
439	else
440	validEntry = true;
441
442
443	propertyWeightPair.add(new Object[] {retValue, String.valueOf(propertyValue.getWeight())});
444	}
445	return validEntry;
446	}
447
448
449	/**
450	* Invoke the appropriate method to get the property value
451	*
452	* @param data The data corresponding to the widget or the data attribute of the widget
453	* @param theMethod The method corresponding to the property value
454	* @param propertyValue The property information container
455	*
456	* @return The returned value of the method corresponding to the argument
457	*/
458	private String invokeProperty(Object data, String theMethod, PropertyValue propertyValue)
459	{
460	try
461	{
462	Class theClass = data.getClass();
463	int paramCount = 0;
464	Vector args = propertyValue.getArguments();
465	if (args != null && args.size() > 0)
466	paramCount = args.size();
467
468	/* We only support method with string parameters */
469	Class[] params = new Class[paramCount];
470	for (int i = 0; i < params.length; i++)
471	params[i] = String.class;
472
473	Method method = theClass.getMethod(theMethod, params);
474
475	Object[] methodArgs = null;
476	if (paramCount > 0)
477	methodArgs = propertyValue.getArguments().toArray();
478
479	Object retValue = method.invoke(data, methodArgs);
480	return retValue.toString();
481	}
482	catch (Throwable t)
483	{
484	/* Return null if in case we can retrieve the property value */
485	return null;
486	}
487
488	}
489
490
491	public WidgetRegValue getDefaultWidgetReg()
492	{
493	if (regWidgets == null)
494	return null;
495	return (WidgetRegValue)regWidgets.get(DEFAULT_ENTYR);
496	}
497
498	}
499
500
501	/**
502	* Can be used to provide any alternative implementation of how the widget registration file
503	* is loaded and queried.
504	*
505	* @author Ali Mehregani
506	*/
507	public interface IWidgetRegistration
508	{
509	/**
510	* Used to load the necessary file and store the data in a datastructure that
511	* will later be used to query the registrations.
512	*/
513	public void load();
514
515	/**
516	* Retrieve the widget id from the registrations
517	*
518	* @param widget The widget in question
519	* @return The persistent identifier for the widget
520	*/
521	public IWidgetId getWidgetId (Widget widget);
522	}
523
524
525	/**
526	* A container class for the registration value of a widget
527	*
528	* @author Ali Mehregani
529	*/
530	private class WidgetRegValue
531	{
532	/* Key = method names, value = propertyValue */
533	private Hashtable properties;
534
535	/* Class match treshold */
536	private float classMatchThreshold;
537
538	/* This vector is used to preserve the ordering of the properties inserted in the hashtable */
539	private Vector hashKeys;
540
541	public WidgetRegValue()
542	{
543	properties = new Hashtable();
544	classMatchThreshold = 0;
545	hashKeys = new Vector();
546	}
547
548	public Vector getProperties()
549	{
550	return hashKeys;
551	}
552
553	public PropertyValue getPropertyValue (String propertyValue)
554	{
555	return (PropertyValue) properties.get(propertyValue);
556	}
557
558	public void addProperty (String methodName, PropertyValue propertyValue)
559	{
560	hashKeys.add(methodName);
561	properties.put (methodName, propertyValue);
562	}
563
564	public float getClassMatchThreshold()
565	{
566	return classMatchThreshold;
567	}
568
569	public void setClassMatchThreshold(float classMatchThreshold)
570	{
571	this.classMatchThreshold = classMatchThreshold;
572	}
573
574	}
575
576	/**
577	* Container class for property values
578	*
579	* @author Ali Mehregani
580	*/
581	private class PropertyValue
582	{
583	private Vector arguments;
584	private float weight;
585
586	public Vector getArguments()
587	{
588	return arguments;
589	}
590	public void setArguments(Vector arguments)
591	{
592	this.arguments = arguments;
593	}
594	public float getWeight()
595	{
596	return weight;
597	}
598	public void setWeight(float weight)
599	{
600	this.weight = weight;
601	}
602	}
603
604	public boolean foundWidget(Object object, Object id)
605	{
606	Object objectId = getUniqueId(object instanceof Control ? ((Control)object).getParent() : null, object);
607	return id == null ? false : objectId == null ? false : objectId.equals(id);
608	}
609	}

Lines 1-134 Link Here

(-)schema/widgetResolver.exsd (-134 / +137 lines)
1	<?xml version='1.0' encoding='UTF-8'?>	1	<?xml version='1.0' encoding='UTF-8'?>
2	<!-- Schema file written by PDE -->	2	<!-- Schema file written by PDE -->
3	<schema targetNamespace="org.eclipse.hyades.test.tools.ui">	3	<schema targetNamespace="org.eclipse.hyades.test.tools.ui">
4	<annotation>	4	<annotation>
5	<appInfo>	5	<appInfo>
6	<meta.schema plugin="org.eclipse.hyades.test.tools.ui" id="macroSupport" name="macroSupport"/>	6	<meta.schema plugin="org.eclipse.hyades.test.tools.ui" id="macroSupport" name="macroSupport"/>
7	</appInfo>	7	</appInfo>
8	<documentation>	8	<documentation>
9	Use this extension to define a class that is capable of resolving widgets.	9	Use this extension to define a class that is capable of resolving widgets.
10	</documentation>	10	</documentation>
11	</annotation>	11	</annotation>
12		12
13	<element name="extension">	13	<element name="extension">
14	<annotation>	14	<annotation>
15	<documentation>	15	<appInfo>
16	The following internal extension provides the mean for defining custom widget resolvers.	16	<meta.element deprecated="true" replacement="uiObjectResolverDelegate" />
17	</documentation>	17	</appInfo>
18	</annotation>	18	<documentation>
19	<complexType>	19	The following internal extension provides the mean for defining custom widget resolvers.
20	<sequence>	20	</documentation>
21	<element ref="widgetResolver" minOccurs="1" maxOccurs="unbounded"/>	21	</annotation>
22	</sequence>	22	<complexType>
23	<attribute name="point" type="string" use="required">	23	<sequence>
24	<annotation>	24	<element ref="widgetResolver" minOccurs="1" maxOccurs="unbounded"/>
25	<documentation>	25	</sequence>
26		26	<attribute name="point" type="string" use="required">
27	</documentation>	27	<annotation>
28	</annotation>	28	<documentation>
29	</attribute>	29
30	<attribute name="id" type="string">	30	</documentation>
31	<annotation>	31	</annotation>
32	<documentation>	32	</attribute>
33		33	<attribute name="id" type="string">
34	</documentation>	34	<annotation>
35	</annotation>	35	<documentation>
36	</attribute>	36
37	<attribute name="name" type="string">	37	</documentation>
38	<annotation>	38	</annotation>
39	<documentation>	39	</attribute>
40		40	<attribute name="name" type="string">
41	</documentation>	41	<annotation>
42	<appInfo>	42	<documentation>
43	<meta.attribute translatable="true"/>	43
44	</appInfo>	44	</documentation>
45	</annotation>	45	<appInfo>
46	</attribute>	46	<meta.attribute translatable="true"/>
47	</complexType>	47	</appInfo>
48	</element>	48	</annotation>
49		49	</attribute>
50	<element name="widgetResolver">	50	</complexType>
51	<complexType>	51	</element>
52	<attribute name="class" type="string" use="required">	52
53	<annotation>	53	<element name="widgetResolver">
54	<documentation>	54	<complexType>
55	The class that is invoked to resolve a widget.	55	<attribute name="class" type="string" use="required">
56	Must implement the following interface: org.eclipse.tptp.test.auto.gui.internal.core.IWidgetResolver	56	<annotation>
57	</documentation>	57	<documentation>
58	<appInfo>	58	The class that is invoked to resolve a widget.
59	<meta.attribute kind="java" basedOn="org.eclipse.tptp.test.auto.gui.internal.core.IWidgetResolver"/>	59	Must implement the following interface: org.eclipse.tptp.test.auto.gui.internal.core.IWidgetResolver
60	</appInfo>	60	</documentation>
61	</annotation>	61	<appInfo>
62	</attribute>	62	<meta.attribute kind="java" basedOn="org.eclipse.tptp.test.auto.gui.internal.core.IWidgetResolver"/>
63	<attribute name="priority" type="string" use="required">	63	</appInfo>
64	<annotation>	64	</annotation>
65	<documentation>	65	</attribute>
66	This attribute indicates the priority of the widget resolver relative to the other registered widget resolvers. Widget resolvers are invoked in an descending order of their priority (e.g. The widget resolver with the highest priority attribute will be invoked first).	66	<attribute name="priority" type="string" use="required">
67	The value of this attribute is expected to be an integer	67	<annotation>
68	</documentation>	68	<documentation>
69	</annotation>	69	This attribute indicates the priority of the widget resolver relative to the other registered widget resolvers. Widget resolvers are invoked in an descending order of their priority (e.g. The widget resolver with the highest priority attribute will be invoked first).
70	</attribute>	70	The value of this attribute is expected to be an integer
71	<attribute name="id" type="string" use="required">	71	</documentation>
72	<annotation>	72	</annotation>
73	<documentation>	73	</attribute>
74	The unique id of the resolver. Keeps this id short as it is commonly used in a macro. The suggested format is CONTRIBUTING_PLUGIN_ID.RESOLVER_NAME e.g. org.eclipse.tptp.test.auto.gui.adaptive.	74	<attribute name="id" type="string" use="required">
75	</documentation>	75	<annotation>
76	</annotation>	76	<documentation>
77	</attribute>	77	The unique id of the resolver. Keeps this id short as it is commonly used in a macro. The suggested format is CONTRIBUTING_PLUGIN_ID.RESOLVER_NAME e.g. org.eclipse.tptp.test.auto.gui.adaptive.
78	</complexType>	78	</documentation>
79	</element>	79	</annotation>
80		80	</attribute>
81	<annotation>	81	</complexType>
82	<appInfo>	82	</element>
83	<meta.section type="since"/>	83
84	</appInfo>	84	<annotation>
85	<documentation>	85	<appInfo>
86	Since TPTP v4.1	86	<meta.section type="since"/>
87	</documentation>	87	</appInfo>
88	</annotation>	88	<documentation>
89		89	Since TPTP v4.1
90	<annotation>	90	</documentation>
91	<appInfo>	91	</annotation>
92	<meta.section type="examples"/>	92
93	</appInfo>	93	<annotation>
94	<documentation>	94	<appInfo>
95	<!-- Define a widget resolver with priority 10 -->	95	<meta.section type="examples"/>
96	<extension	96	</appInfo>
97	point="org.eclipse.tptp.test.auto.gui.widgetResolver">	97	<documentation>
98	<widgetResolver	98	<!-- Define a widget resolver with priority 10 -->
99	id = "org.eclipse.tptp.test.auto.gui.adaptive"	99	<extension
100	class="org.eclipse.tptp.test.auto.gui.internal.recorder.AdaptiveWidgetResolver"	100	point="org.eclipse.tptp.test.auto.gui.widgetResolver">
101	priority="10"	101	<widgetResolver
102	/>	102	id = "org.eclipse.tptp.test.auto.gui.adaptive"
103	</extension>	103	class="org.eclipse.tptp.test.auto.gui.internal.recorder.AdaptiveWidgetResolver"
104	</documentation>	104	priority="10"
105	</annotation>	105	/>
106		106	</extension>
107	<annotation>	107	</documentation>
108	<appInfo>	108	</annotation>
109	<meta.section type="apiInfo"/>	109
110	</appInfo>	110	<annotation>
111	<documentation>	111	<appInfo>
112	[Enter API information here.]	112	<meta.section type="apiInfo"/>
113	</documentation>	113	</appInfo>
114	</annotation>	114	<documentation>
115		115	[Enter API information here.]
116	<annotation>	116	</documentation>
117	<appInfo>	117	</annotation>
118	<meta.section type="implementation"/>	118
119	</appInfo>	119	<annotation>
120	<documentation>	120	<appInfo>
121	[Enter information about supplied implementation of this extension point.]	121	<meta.section type="implementation"/>
122	</documentation>	122	</appInfo>
123	</annotation>	123	<documentation>
124		124	[Enter information about supplied implementation of this extension point.]
125	<annotation>	125	</documentation>
126	<appInfo>	126	</annotation>
127	<meta.section type="copyright"/>	127
128	</appInfo>	128	<annotation>
129	<documentation>	129	<appInfo>
130	Copyright (c) 2005, 2006 IBM Corporation 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 <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>	130	<meta.section type="copyright"/>
131	</documentation>	131	</appInfo>
132	</annotation>	132	<documentation>
133		133	Copyright (c) 2005, 2006 IBM Corporation 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 <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>
134	</schema>	134	</documentation>
		135	</annotation>
		136
		137	</schema>

Added Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/commands/SingleSelectionCommand.java (+30 lines)
1	/**********************************************************************
2	* Copyright (c) 2009 Alexander Nyssen and others.
3	* All rights reserved. This content is made available under
4	* the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	* $Id$
8	*
9	* Contributors:
10	* Alexander Nyssen - Initial contribution
11	**********************************************************************/
12	package org.eclipse.tptp.test.auto.gui.internal.commands;
13
14	import org.eclipse.tptp.test.auto.gui.internal.macro.MacroCommandShell;
15
16
17	/**
18	* @author Alexander Nyssen
19	*
20	*/
21	public abstract class SingleSelectionCommand extends ObjectBasedCommand {
22
23	/**
24	* @param parent
25	* @param widgetId
26	*/
27	public SingleSelectionCommand(MacroCommandShell parent) {
28	super(parent);
29	}
30	}

Added Link Here

(-)schema/macroCommandFactory.exsd (+111 lines)
1	<?xml version='1.0' encoding='UTF-8'?>
2	<!-- Schema file written by PDE -->
3	<schema targetNamespace="org.eclipse.tptp.test.auto.gui">
4	<annotation>
5	<appInfo>
6	<meta.schema plugin="org.eclipse.tptp.test.auto.gui" id="macroCommandFactory" name="macroCommandFactory"/>
7	</appInfo>
8	<documentation>
9	Extension point to replace the macro command factory with a custom implementation.
10	</documentation>
11	</annotation>
12
13	<element name="extension">
14	<complexType>
15	<sequence>
16	<element ref="macroCommandFactory"/>
17	</sequence>
18	<attribute name="point" type="string" use="required">
19	<annotation>
20	<documentation>
21
22	</documentation>
23	</annotation>
24	</attribute>
25	<attribute name="id" type="string">
26	<annotation>
27	<documentation>
28
29	</documentation>
30	</annotation>
31	</attribute>
32	<attribute name="name" type="string">
33	<annotation>
34	<documentation>
35
36	</documentation>
37	<appInfo>
38	<meta.attribute translatable="true"/>
39	</appInfo>
40	</annotation>
41	</attribute>
42	</complexType>
43	</element>
44
45	<element name="macroCommandFactory">
46	<complexType>
47	<attribute name="id" type="string" use="required">
48	<annotation>
49	<documentation>
50
51	</documentation>
52	</annotation>
53	</attribute>
54	<attribute name="class" type="string" use="required">
55	<annotation>
56	<documentation>
57
58	</documentation>
59	<appInfo>
60	<meta.attribute kind="java" basedOn=":org.eclipse.tptp.test.auto.gui.commands.factory.IMacroCommandFactory"/>
61	</appInfo>
62	</annotation>
63	</attribute>
64	<attribute name="priority" type="string" use="required">
65	<annotation>
66	<documentation>
67	The priority of the factory. The factory with the highest priority is loaded and used, all others are disregarded.
68	</documentation>
69	</annotation>
70	</attribute>
71	</complexType>
72	</element>
73
74	<annotation>
75	<appInfo>
76	<meta.section type="since"/>
77	</appInfo>
78	<documentation>
79	[Enter the first release in which this extension point appears.]
80	</documentation>
81	</annotation>
82
83	<annotation>
84	<appInfo>
85	<meta.section type="examples"/>
86	</appInfo>
87	<documentation>
88	[Enter extension point usage example here.]
89	</documentation>
90	</annotation>
91
92	<annotation>
93	<appInfo>
94	<meta.section type="apiInfo"/>
95	</appInfo>
96	<documentation>
97	[Enter API information here.]
98	</documentation>
99	</annotation>
100
101	<annotation>
102	<appInfo>
103	<meta.section type="implementation"/>
104	</appInfo>
105	<documentation>
106	[Enter information about supplied implementation of this extension point.]
107	</documentation>
108	</annotation>
109
110
111	</schema>

Added Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/uiobject/resolver/delegate/UIObjectResolverDelegateLoader.java (+61 lines)
1	/*******************************************************************************
2	* Copyright (c) 2006, 2009 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.tptp.test.auto.gui.internal.uiobject.resolver.delegate;
12
13	/**
14	* Represents each widgetResolver element that appears under a widgetResolver
15	* extension
16	*
17	* @author Ali Mehregani
18	* @author Alexander Nyssen
19	*/
20	public class UIObjectResolverDelegateLoader {
21
22	/** The id of the widget resolver */
23	private String id;
24
25	/** The widget resolver class */
26	private IUIObjectResolverDelegate uiObjectResolverDelegate;
27
28	/** The priority of this widget resolver registeration */
29	private int priority;
30
31	/**
32	* Limit the visibility of the constructor
33	*/
34	protected UIObjectResolverDelegateLoader(String id,
35	IUIObjectResolverDelegate resolver, int priority) {
36	this.id = id;
37	this.uiObjectResolverDelegate = resolver;
38	this.priority = priority;
39	}
40
41	/**
42	* @return the id
43	*/
44	public String getId() {
45	return id;
46	}
47
48	/**
49	* @return the priority
50	*/
51	public int getPriority() {
52	return priority;
53	}
54
55	/**
56	* @return the widgetResolver
57	*/
58	public IUIObjectResolverDelegate getUIObjectResolverDelegate() {
59	return uiObjectResolverDelegate;
60	}
61	}

Added Link Here

(-)CHANGES.txt (+59 lines)
1	1) Total refactoring of the widget resolving mechanism:
2
3	- The former widget resolving mechanism was totally revised. It now works as follows: IMacroObjects are resolved into IMacroObjectIdentifiers during recording in a two step process.
4	First, the context of the IMacroObject is resolved into a contextId (by a newly introduced MacroObjectResolver), then the nested UIObject (widget with optional nested object) is
5	resolved into a IUIObjectIdentifier (by a newly introduced UIObjectResolver), which contains the info formerly captured in a WidgetIdentifier (widgetId, resolverId, optional objectId).
6	During playback the deresolving of IMacroObjectIdentifiers is done in the same two step process. The MacroObjectResolver locates (deresolves) the context, and the UIObjectResolver
7	than locates the UIObject (under the given context). He delegates the resolving/deresolving of UIObjects/UIObjectIdentifiers to so called IUIObjectResolverDelegates, which are
8	loaded via a newly introduced extension point (which is a replacement of the former WigetResolver extension point).
9
10	- Different to the old WidgetResolvers, the newly introduced IUIObjectResolverDelegates are responsible not only to resolve a respective IUIObjectIdentifier
11	for a given UIObject, but also to deresolve(i.e. relocating) a respective UIObject during playback (i.e. they take the second part of the two step deresolving mechanism). The old
12	WidgetResolvers were migrated to the new IUIObjectResolverDelegate interface. A DeprecatedDeresolvingSupport class was introduced to preserve the old implementation that
13	used the foundWidget method to relocated items. The WidgetIdentifier extension point was marked as deprecated. All extensions are loaded and adapterd dynamically to the new
14	UIObjectResolverDelegate interface by using DeprecatedDeresolvingSupport
15
16	- The new resolving/deresolving mechanism relies on that the computed IMacroObjectIdentifier are unique, i.e. the desired UIObject can be unambiguously identified in its context during playback.
17	An exception is now thrown, if a recorded id cannot be unambiguously resolved. The old implementation contained a hack for bug#147766, which played back commands for all found matches
18	(or only the first one), which is not a valid solution. Consider the build.properties editor as an example. If checking an item of the SourceBuild-Tree during recording, the old
19	implementation would select the respectively named item in the BinaryBuild-Tree, as it plays the command for the first match.
20	I therefore propose to reopen bug#147766. It needs a proper fix that computes a unique IMacroObjectIdentifier for such tree items, so that during playback the single selected item
21	can be identified unambiguously.
22
23	- All commands that relied on resolving/deresolving widgets (and nested objects) where migrated to have a common superclass ObjectBasedCommand. All those object-based commands
24	now rely on recording and playing back IMacroObjects. An IMacroObject (formerly CommandTarget) consists of a context and a UIObject, which is a widget or a nested object on
25	a widget (e.g. a String item on a ComboBox).
26
27	- The listener registration for Workbench closing events was extracted from the resolving mechanism (was located as a side effect in MacroUtil.getWidgetIdentifier()), the resolving/deresolving
28	is now side-effect free.
29
30	2) Refactored ObjectMining. Renamed UIObject to MacroObjectDescriptor and ObjectMine into MacroObjectMine, UIObjectMineManager into MacroObjectManager to reflect what is actually stored in it.
31	- Refactored the identifier providing mechanism; a new MacroObjectDescriptor is now equipped with a unique id internally by the object mine when registering the object
32	- Removed the unneeded abstraction interface IUIObject (which is now used to represent a UIObject, i.e. a widget and a respective nested object) and unneeded corresponding IUIObjectMine interface.
33
34	4) Refactored VerficationCommand to be handled as all other object-based commands
35	- moved static construction method out changed constructor signature of Verification command to be in line with other object-based commands
36	- refactored loading/writing to rely on super implemenation where possible
37	- Removed VerficationMetaData which is now not needed any more (as in case of other commands that do not have something like this as well)
38	- Implemented enhancements to verification hook insertion (i.e. resolved bug #201248). It now supports an extented mode (that is also needed in case of Draw2d). In extended
39	mode, verification does not rely on the context but also on a selected UIObject (i.e. widget and possibly nested object).
40
41	5) Introduced a command factory that encapsulates creation of commands (factored respective code out of MacroCommandShell). Introduced a respective extension point
42	to replace the command factory. This will be needed to add support for draw2d, as the commands are responsible of locating their respective macro objects in a respective event,
43	and the default implementation of the commands do not pay any interest to nested objects beyond the widget level (e.g. Figures on a FigureCanvas).
44
45	6) Refactored MacroManager
46	- moved event constants into EventConstants interface, which defines the custom event types and details
47	- moved mode constants into own ModeConstants interface
48
49	7) Removed unneeded IRecorderListener interface (never used)
50
51	8) Fixed that in Eclispe Ganymede, when closing an unsaved editor, the workbench close command was created after the message dialog selection command.
52
53	9) Introduced mouse move commands to explitly capture mouse move events, as needed to test GEF-applications.
54
55	10) Several minor fixes and cleanups.
56
57	TODO:
58	- Migrate BooleanSelectionCommand and AbstractStructuredCommand to fully use the new resolving/deresolving mechanisms for macro objects (they are still based on parts
59	of the old resolving mechanism, respectively do resolving/deresolving on their own), which should be taken care of.

Added Link Here

(-)schema/uiObjectResolverDelegate.exsd (+137 lines)
1	<?xml version='1.0' encoding='UTF-8'?>
2	<!-- Schema file written by PDE -->
3	<schema targetNamespace="org.eclipse.tptp.test.auto.gui" xmlns="http://www.w3.org/2001/XMLSchema">
4	<annotation>
5	<appinfo>
6	<meta.schema plugin="org.eclipse.tptp.test.auto.gui" id="uiObjectResolverDelegate" name="uiObjectResolverDelegate"/>
7	</appinfo>
8	<documentation>
9	Use this extension to define a class that is capable of resolving widgets and nested objects on them.
10	</documentation>
11	</annotation>
12
13	<element name="extension">
14	<annotation>
15	<appinfo>
16	<meta.element />
17	</appinfo>
18	<documentation>
19	The following internal extension provides the mean for defining custom widget resolvers.
20	</documentation>
21	</annotation>
22	<complexType>
23	<sequence>
24	<element ref="uiObjectResolverDelegate" minOccurs="1" maxOccurs="unbounded"/>
25	</sequence>
26	<attribute name="point" type="string" use="required">
27	<annotation>
28	<documentation>
29
30	</documentation>
31	</annotation>
32	</attribute>
33	<attribute name="id" type="string">
34	<annotation>
35	<documentation>
36
37	</documentation>
38	</annotation>
39	</attribute>
40	<attribute name="name" type="string">
41	<annotation>
42	<documentation>
43
44	</documentation>
45	<appinfo>
46	<meta.attribute translatable="true"/>
47	</appinfo>
48	</annotation>
49	</attribute>
50	</complexType>
51	</element>
52
53	<element name="uiObjectResolverDelegate">
54	<complexType>
55	<attribute name="class" type="string" use="required">
56	<annotation>
57	<documentation>
58	The class that is invoked to resolve a widget or a nested object on a widget.
59	Must implement the following interface: org.eclipse.tptp.test.auto.gui.uiObject.resolver.delegate.IUIObjectResolverDelegate
60	</documentation>
61	<appinfo>
62	<meta.attribute kind="java" basedOn="org.eclipse.tptp.test.auto.gui.uiObject.resolver.delegate.IUIObjectResolverDelegate"/>
63	</appinfo>
64	</annotation>
65	</attribute>
66	<attribute name="priority" type="string" use="required">
67	<annotation>
68	<documentation>
69	This attribute indicates the priority of the resolver delegate relative to the other registered widget resolvers. UIObjectResolverDelegats are invoked in an descending order of their priority (e.g. The resolver delegate with the highest priority attribute will be invoked first).
70	The value of this attribute is expected to be an integer
71	</documentation>
72	</annotation>
73	</attribute>
74	<attribute name="id" type="string" use="required">
75	<annotation>
76	<documentation>
77	The unique id of the resolver. Keeps this id short as it is commonly used in a macro. The suggested format is CONTRIBUTING_PLUGIN_ID.RESOLVER_NAME e.g. org.eclipse.tptp.test.auto.gui.adaptive.
78	</documentation>
79	</annotation>
80	</attribute>
81	</complexType>
82	</element>
83
84	<annotation>
85	<appinfo>
86	<meta.section type="since"/>
87	</appinfo>
88	<documentation>
89	Since TPTP v4.5
90	</documentation>
91	</annotation>
92
93	<annotation>
94	<appinfo>
95	<meta.section type="examples"/>
96	</appinfo>
97	<documentation>
98	<!-- Define a UI object resolver delegate with priority 10 -->
99	<extension
100	point="org.eclipse.tptp.test.auto.gui.uiObjectResolverDelegate">
101	<widgetResolver
102	id = "org.eclipse.tptp.test.auto.gui.adaptive"
103	class="org.eclipse.tptp.test.auto.gui.internal.recorder.AdaptiveWidgetResolver"
104	priority="10"
105	/>
106	</extension>
107	</documentation>
108	</annotation>
109
110	<annotation>
111	<appinfo>
112	<meta.section type="apiInfo"/>
113	</appinfo>
114	<documentation>
115	[Enter API information here.]
116	</documentation>
117	</annotation>
118
119	<annotation>
120	<appinfo>
121	<meta.section type="implementation"/>
122	</appinfo>
123	<documentation>
124	[Enter information about supplied implementation of this extension point.]
125	</documentation>
126	</annotation>
127
128	<annotation>
129	<appinfo>
130	<meta.section type="copyright"/>
131	</appinfo>
132	<documentation>
133	Copyright (c) 2005, 2006 IBM Corporation 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 <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>
134	</documentation>
135	</annotation>
136
137	</schema>

Added Link Here

(-)src/org/eclipse/tptp/test/auto/gui/internal/macroobject/MacroObjectIdentifier.java (+150 lines)
1	/*******************************************************************************
2	* Copyright (c) 2000, 2009 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.tptp.test.auto.gui.internal.macroobject;
12
13	import org.eclipse.core.runtime.Path;
14	import org.eclipse.tptp.test.auto.gui.internal.macro.MacroConstants;
15	import org.eclipse.tptp.test.auto.gui.internal.uiobject.IUIObjectIdentifier;
16	import org.eclipse.tptp.test.auto.gui.internal.uiobject.PrimitiveUIObjectIdentifier;
17
18	/**
19	* Used as an identifier for Macro objects.
20	*
21	* @author Alexander Nyssen
22	*/
23	public class MacroObjectIdentifier implements IMacroObjectIdentifier {
24
25	/** The context id */
26	private String contextId;
27
28	/** The ui object id */
29	private IUIObjectIdentifier uiObjectIdentifier;
30
31	/**
32	* Constructor
33	*
34	* @param contextId
35	* The context id
36	* @param uiObjectId
37	* The widget id
38	*/
39	public MacroObjectIdentifier(String contextId,
40	IUIObjectIdentifier uiObjectIdentifier) {
41	this.contextId = contextId;
42	this.uiObjectIdentifier = uiObjectIdentifier;
43	}
44
45	/**
46	* An object in question is equalled to this object iff the object is of the
47	* same type and the context and the widget ids are the same.
48	*
49	* @param object
50	* The object in question
51	*
52	* @return A boolean indicating whether object is equalled to this object or
53	* not.
54	*/
55	public boolean equals(Object object) {
56	if (object == null)
57	return false;
58	if (object == this)
59	return true;
60	if (object instanceof MacroObjectIdentifier) {
61	MacroObjectIdentifier wid = (MacroObjectIdentifier) object;
62	return wid.contextId.equals(contextId)
63	&& uiObjectIdentifier.getWidgetId().equals(
64	wid.getObjectIdentifier().getWidgetId());
65	}
66	return false;
67	}
68
69	/**
70	* Returns the context id of this identifier
71	*
72	* @return The context id
73	*/
74	public String getContextIdentifier() {
75	return contextId.toString();
76	}
77
78	public IUIObjectIdentifier getObjectIdentifier() {
79	return uiObjectIdentifier;
80	}
81
82	public static IMacroObjectIdentifier deserializeMacroObjectIdentifier(
83	String macroObjectIdentifierString) {
84
85	// 1) retrieve the context, object and resolver id
86	// first retrieve the resolver id
87	String resolverId = null;
88	if (macroObjectIdentifierString
89	.indexOf(MacroConstants.RESOLVER_ID_SUFFIX_SEPARATOR) >= 0) {
90	resolverId = macroObjectIdentifierString
91	.substring(macroObjectIdentifierString
92	.lastIndexOf(MacroConstants.RESOLVER_ID_SUFFIX_SEPARATOR) + 3);
93	macroObjectIdentifierString = macroObjectIdentifierString
94	.substring(
95	0,
96	macroObjectIdentifierString
97	.lastIndexOf(MacroConstants.RESOLVER_ID_SUFFIX_SEPARATOR));
98	}
99
100	// now the object id separator
101	String objectId = null;
102	if (macroObjectIdentifierString
103	.indexOf(MacroConstants.OBJECT_ID_SUFFIX_SEPARATOR) >= 0) {
104	objectId = macroObjectIdentifierString
105	.substring(macroObjectIdentifierString
106	.lastIndexOf(MacroConstants.OBJECT_ID_SUFFIX_SEPARATOR) + 3);
107	macroObjectIdentifierString = macroObjectIdentifierString
108	.substring(
109	0,
110	macroObjectIdentifierString
111	.lastIndexOf(MacroConstants.OBJECT_ID_SUFFIX_SEPARATOR));
112	}
113
114	// now the widget id
115	String widgetId = macroObjectIdentifierString
116	.substring(macroObjectIdentifierString
117	.lastIndexOf(MacroConstants.WIDGET_ID_SUFFIX_SEPARATOR) + 3);
118	macroObjectIdentifierString = macroObjectIdentifierString
119	.substring(0, macroObjectIdentifierString
120	.lastIndexOf(MacroConstants.WIDGET_ID_SUFFIX_SEPARATOR));
121
122	// now the context id
123	String contextId = new Path(macroObjectIdentifierString).removeTrailingSeparator().toString();
124
125	// 2) construct a new identifier and return it
126	IMacroObjectIdentifier macroObjectIdentifier = new MacroObjectIdentifier(
127	contextId,
128	new PrimitiveUIObjectIdentifier(widgetId, objectId, resolverId));
129	return macroObjectIdentifier;
130	}
131
132	public static String serializeMacroObjectIdentifier(
133	IMacroObjectIdentifier macroObjectIdentifier) {
134	return macroObjectIdentifier.getContextIdentifier()
135	// concat widet id
136	+ MacroConstants.WIDGET_ID_SUFFIX_SEPARATOR
137	+ macroObjectIdentifier.getObjectIdentifier().getWidgetId()
138	// concat object id
139	+ (macroObjectIdentifier.getObjectIdentifier().getObjectId() != null ? MacroConstants.OBJECT_ID_SUFFIX_SEPARATOR
140	+ macroObjectIdentifier.getObjectIdentifier()
141	.getObjectId()
142	: "")
143	// concat resolver id
144	+ (macroObjectIdentifier.getObjectIdentifier().getResolverId() != null ? MacroConstants.RESOLVER_ID_SUFFIX_SEPARATOR
145	+ macroObjectIdentifier.getObjectIdentifier()
146	.getResolverId()
147	: "");
148	}
149
150	}

Added Link Here

(-).settings/org.eclipse.jdt.core.prefs (+12 lines)
1	#Tue Jan 22 16:24:58 CET 2008
2	eclipse.preferences.version=1
3	org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
4	org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.2
5	org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
6	org.eclipse.jdt.core.compiler.compliance=1.4
7	org.eclipse.jdt.core.compiler.debug.lineNumber=generate
8	org.eclipse.jdt.core.compiler.debug.localVariable=generate
9	org.eclipse.jdt.core.compiler.debug.sourceFile=generate
10	org.eclipse.jdt.core.compiler.problem.assertIdentifier=warning
11	org.eclipse.jdt.core.compiler.problem.enumIdentifier=warning
12	org.eclipse.jdt.core.compiler.source=1.3