debug/org.eclipse.ptp.debug.core/src/org/eclipse/ptp/debug/internal/core/sourcelookup/PProjectSourceLocation.java - ptp/org.eclipse.ptp - Git at Google

 /*******************************************************************************
  * Copyright (c) 2005 The Regents of the University of California.
  * This material was produced under U.S. Government contract W-7405-ENG-36
  * for Los Alamos National Laboratory, which is operated by the University
  * of California for the U.S. Department of Energy. The U.S. Government has
  * rights to use, reproduce, and distribute this software. NEITHER THE
  * GOVERNMENT NOR THE UNIVERSITY MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR
  * ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is modified
  * to produce derivative works, such modified software should be clearly marked,
  * so as not to confuse it with the version available from LANL.
  *
  * Additionally, 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
  *
  * LA-CC 04-115
  *******************************************************************************/
 package org.eclipse.ptp.debug.internal.core.sourcelookup;

 import java.io.File;
 import java.io.IOException;
 import java.io.StringReader;
 import java.text.MessageFormat;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedList;

 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
 import javax.xml.transform.TransformerException;

 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.IResource;
 import org.eclipse.core.resources.IResourceProxy;
 import org.eclipse.core.resources.IResourceProxyVisitor;
 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.Status;
 import org.eclipse.ptp.debug.core.PDebugUtils;
 import org.eclipse.ptp.debug.core.PTPDebugCorePlugin;
 import org.eclipse.ptp.debug.core.sourcelookup.IPSourceLocation;
 import org.eclipse.ptp.debug.core.sourcelookup.IProjectSourceLocation;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;

 /**
  * @author Clement chu
  *
  */
 public class PProjectSourceLocation implements IProjectSourceLocation {
 	private static final String ELEMENT_NAME = "cProjectSourceLocation";
 	private static final String ATTR_PROJECT = "project";
 	private static final String ATTR_GENERIC = "generic";
 	private IProject fProject;
 	private IResource[] fFolders;
 	private HashMap<String, Object> fCache = new HashMap<String, Object>(20);
 	private HashSet<String> fNotFoundCache = new HashSet<String>(20);
 	private boolean fGenerated = true;
 	private boolean fSearchForDuplicateFiles = false;

 	public PProjectSourceLocation() {}
 	public PProjectSourceLocation(IProject project) {
 		setProject(project);
 		fGenerated = true;
 	}
 	public PProjectSourceLocation(IProject project, boolean generated) {
 		setProject(project);
 		fGenerated = generated;
 	}
 	public Object findSourceElement(String name) throws CoreException {
 		Object result = null;
 		if (!isEmpty(name) && getProject() != null && !notFoundCacheLookup(name)) {
 			result = cacheLookup(name);
 			if (result == null) {
 				result = doFindSourceElement(name);
 				if (result != null) {
 					cacheSourceElement(name, result);
 				}
 			}
 			if (result == null) {
 				cacheNotFound(name);
 			}
 		}
 		return result;
 	}
 	public Object getAdapter(Class adapter) {
 		if (adapter.equals(IPSourceLocation.class))
 			return this;
 		if (adapter.equals(PProjectSourceLocation.class))
 			return this;
 		if (adapter.equals(IProject.class))
 			return getProject();
 		return null;
 	}
 	private void setProject(IProject project) {
 		fProject = project;
 	}
 	public IProject getProject() {
 		return fProject;
 	}
 	private Object doFindSourceElement(String name) {
 		File file = new File(name);
 		return (file.isAbsolute()) ? findFileByAbsolutePath(file) : findFileByRelativePath(name);
 	}
 	private Object findFileByAbsolutePath(File file) {
 		LinkedList<IFile> list = new LinkedList<IFile>();
 		if (file.exists()) {
 			IPath path = new Path(file.getAbsolutePath());
 			IFile[] wsFiles = PTPDebugCorePlugin.getWorkspace().getRoot().findFilesForLocation(path);
 			for (int i = 0; i < wsFiles.length; ++i)
 				if (wsFiles[i].getProject().equals(getProject()) && wsFiles[i].exists()) {
 					if (!searchForDuplicateFiles())
 						return wsFiles[i];
 					list.add(wsFiles[i]);
 				}
 		}
 		return (list.size() > 0) ? ((list.size() == 1) ? list.getFirst() : list) : null;
 	}
 	private Object findFileByRelativePath(String fileName) {
 		IResource[] folders = getFolders();
 		LinkedList<IFile> list = new LinkedList<IFile>();
 		for (int i = 0; i < folders.length; ++i) {
 			if (list.size() > 0 && !searchForDuplicateFiles())
 				break;
 			IPath path = folders[i].getLocation();
 			if (path != null) {
 				path = path.append(fileName);
 				File file = new File(path.toOSString());
 				if (file.exists()) {
 					IFile[] wsFiles = PTPDebugCorePlugin.getWorkspace().getRoot().findFilesForLocation(path);
 					for (int j = 0; j < wsFiles.length; ++j)
 						if (wsFiles[j].exists()) {
 							if (!searchForDuplicateFiles())
 								return wsFiles[j];
 							list.add(wsFiles[j]);
 						}
 				}
 			}
 		}
 		return (list.size() > 0) ? ((list.size() == 1) ? list.getFirst() : list) : null;
 	}
 	private Object cacheLookup(String name) {
 		return fCache.get(name);
 	}
 	private boolean notFoundCacheLookup(String name) {
 		return fNotFoundCache.contains(name);
 	}
 	private void cacheSourceElement(String name, Object element) {
 		fCache.put(name, element);
 	}
 	private void cacheNotFound(String name) {
 		fNotFoundCache.add(name);
 	}
 	public void dispose() {
 		fCache.clear();
 		fNotFoundCache.clear();
 	}
 	public String getMemento() throws CoreException {
 		Document document = null;
 		Throwable ex = null;
 		try {
 			document = DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument();
 			Element node = document.createElement(ELEMENT_NAME);
 			document.appendChild(node);
 			node.setAttribute(ATTR_PROJECT, getProject().getName());
 			node.setAttribute(ATTR_GENERIC, new Boolean(isGeneric()).toString());
 			return PDebugUtils.serializeDocument(document);
 		} catch (ParserConfigurationException e) {
 			ex = e;
 		} catch (IOException e) {
 			ex = e;
 		} catch (TransformerException e) {
 			ex = e;
 		}
 		abort(MessageFormat.format(InternalSourceLookupMessages.getString("PProjectSourceLocation.0"), new Object[] { getProject().getName() }), ex);
 		// execution will not reach here
 		return null;
 	}
 	public void initializeFrom(String memento) throws CoreException {
 		Exception ex = null;
 		try {
 			Element root = null;
 			DocumentBuilder parser = DocumentBuilderFactory.newInstance().newDocumentBuilder();
 			StringReader reader = new StringReader(memento);
 			InputSource source = new InputSource(reader);
 			root = parser.parse(source).getDocumentElement();
 			String name = root.getAttribute(ATTR_PROJECT);
 			if (isEmpty(name)) {
 				abort(InternalSourceLookupMessages.getString("PProjectSourceLocation.1"), null);
 			} else {
 				IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(name);
 				setProject(project);
 			}
 			String isGeneric = root.getAttribute(ATTR_GENERIC);
 			if (isGeneric == null || isGeneric.trim().length() == 0)
 				isGeneric = Boolean.FALSE.toString();
 			setGenerated(isGeneric.equals(Boolean.TRUE.toString()));
 			return;
 		} catch (ParserConfigurationException e) {
 			ex = e;
 		} catch (SAXException e) {
 			ex = e;
 		} catch (IOException e) {
 			ex = e;
 		}
 		abort(InternalSourceLookupMessages.getString("PProjectSourceLocation.2"), ex);
 	}
 	private void abort(String message, Throwable e) throws CoreException {
 		IStatus s = new Status(IStatus.ERROR, PTPDebugCorePlugin.getUniqueIdentifier(), PTPDebugCorePlugin.INTERNAL_ERROR, message, e);
 		throw new CoreException(s);
 	}
 	private boolean isEmpty(String string) {
 		return string == null || string.length() == 0;
 	}
 	public boolean isGeneric() {
 		return fGenerated;
 	}
 	public void setGenerated(boolean b) {
 		fGenerated = b;
 	}
 	public boolean equals(Object obj) {
 		if (obj instanceof IProjectSourceLocation && getProject() != null)
 			return getProject().equals(((IProjectSourceLocation) obj).getProject());
 		return false;
 	}
 	private void initializeFolders() {
 		final LinkedList<IResource> list = new LinkedList<IResource>();
 		if (getProject() != null && getProject().exists()) {
 			list.add(getProject());
 			try {
 				getProject().accept(new IResourceProxyVisitor() {
 					public boolean visit(IResourceProxy proxy) throws CoreException {
 						switch (proxy.getType()) {
 						case IResource.FILE:
 							return false;
 						case IResource.FOLDER:
 							list.addLast(proxy.requestResource());
 							return true;
 						}
 						return true;
 					}
 				}, IResource.NONE);
 			} catch (CoreException e) {
 			}
 		}
 		synchronized (this) {
 			if (fFolders == null) {
 				fFolders = (IResource[]) list.toArray(new IResource[list.size()]);
 			}
 		}
 	}
 	protected IResource[] getFolders() {
 		if (fFolders == null)
 			initializeFolders();
 		return fFolders;
 	}
 	public boolean searchForDuplicateFiles() {
 		return fSearchForDuplicateFiles;
 	}
 	public void setSearchForDuplicateFiles(boolean search) {
 		fCache.clear();
 		fNotFoundCache.clear();
 		fSearchForDuplicateFiles = search;
 	}
 	public String toString() {
 		return (getProject() != null) ? fProject.toString() : "";
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2005 The Regents of the University of California.
	* This material was produced under U.S. Government contract W-7405-ENG-36
	* for Los Alamos National Laboratory, which is operated by the University
	* of California for the U.S. Department of Energy. The U.S. Government has
	* rights to use, reproduce, and distribute this software. NEITHER THE
	* GOVERNMENT NOR THE UNIVERSITY MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR
	* ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is modified
	* to produce derivative works, such modified software should be clearly marked,
	* so as not to confuse it with the version available from LANL.
	*
	* Additionally, 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
	*
	* LA-CC 04-115
	*******************************************************************************/
	package org.eclipse.ptp.debug.internal.core.sourcelookup;

	import java.io.File;
	import java.io.IOException;
	import java.io.StringReader;
	import java.text.MessageFormat;
	import java.util.HashMap;
	import java.util.HashSet;
	import java.util.LinkedList;

	import javax.xml.parsers.DocumentBuilder;
	import javax.xml.parsers.DocumentBuilderFactory;
	import javax.xml.parsers.ParserConfigurationException;
	import javax.xml.transform.TransformerException;

	import org.eclipse.core.resources.IFile;
	import org.eclipse.core.resources.IProject;
	import org.eclipse.core.resources.IResource;
	import org.eclipse.core.resources.IResourceProxy;
	import org.eclipse.core.resources.IResourceProxyVisitor;
	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.Status;
	import org.eclipse.ptp.debug.core.PDebugUtils;
	import org.eclipse.ptp.debug.core.PTPDebugCorePlugin;
	import org.eclipse.ptp.debug.core.sourcelookup.IPSourceLocation;
	import org.eclipse.ptp.debug.core.sourcelookup.IProjectSourceLocation;
	import org.w3c.dom.Document;
	import org.w3c.dom.Element;
	import org.xml.sax.InputSource;
	import org.xml.sax.SAXException;

	/**
	* @author Clement chu
	*
	*/
	public class PProjectSourceLocation implements IProjectSourceLocation {
	private static final String ELEMENT_NAME = "cProjectSourceLocation";
	private static final String ATTR_PROJECT = "project";
	private static final String ATTR_GENERIC = "generic";
	private IProject fProject;
	private IResource[] fFolders;
	private HashMap<String, Object> fCache = new HashMap<String, Object>(20);
	private HashSet<String> fNotFoundCache = new HashSet<String>(20);
	private boolean fGenerated = true;
	private boolean fSearchForDuplicateFiles = false;

	public PProjectSourceLocation() {}
	public PProjectSourceLocation(IProject project) {
	setProject(project);
	fGenerated = true;
	}
	public PProjectSourceLocation(IProject project, boolean generated) {
	setProject(project);
	fGenerated = generated;
	}
	public Object findSourceElement(String name) throws CoreException {
	Object result = null;
	if (!isEmpty(name) && getProject() != null && !notFoundCacheLookup(name)) {
	result = cacheLookup(name);
	if (result == null) {
	result = doFindSourceElement(name);
	if (result != null) {
	cacheSourceElement(name, result);
	}
	}
	if (result == null) {
	cacheNotFound(name);
	}
	}
	return result;
	}
	public Object getAdapter(Class adapter) {
	if (adapter.equals(IPSourceLocation.class))
	return this;
	if (adapter.equals(PProjectSourceLocation.class))
	return this;
	if (adapter.equals(IProject.class))
	return getProject();
	return null;
	}
	private void setProject(IProject project) {
	fProject = project;
	}
	public IProject getProject() {
	return fProject;
	}
	private Object doFindSourceElement(String name) {
	File file = new File(name);
	return (file.isAbsolute()) ? findFileByAbsolutePath(file) : findFileByRelativePath(name);
	}
	private Object findFileByAbsolutePath(File file) {
	LinkedList<IFile> list = new LinkedList<IFile>();
	if (file.exists()) {
	IPath path = new Path(file.getAbsolutePath());
	IFile[] wsFiles = PTPDebugCorePlugin.getWorkspace().getRoot().findFilesForLocation(path);
	for (int i = 0; i < wsFiles.length; ++i)
	if (wsFiles[i].getProject().equals(getProject()) && wsFiles[i].exists()) {
	if (!searchForDuplicateFiles())
	return wsFiles[i];
	list.add(wsFiles[i]);
	}
	}
	return (list.size() > 0) ? ((list.size() == 1) ? list.getFirst() : list) : null;
	}
	private Object findFileByRelativePath(String fileName) {
	IResource[] folders = getFolders();
	LinkedList<IFile> list = new LinkedList<IFile>();
	for (int i = 0; i < folders.length; ++i) {
	if (list.size() > 0 && !searchForDuplicateFiles())
	break;
	IPath path = folders[i].getLocation();
	if (path != null) {
	path = path.append(fileName);
	File file = new File(path.toOSString());
	if (file.exists()) {
	IFile[] wsFiles = PTPDebugCorePlugin.getWorkspace().getRoot().findFilesForLocation(path);
	for (int j = 0; j < wsFiles.length; ++j)
	if (wsFiles[j].exists()) {
	if (!searchForDuplicateFiles())
	return wsFiles[j];
	list.add(wsFiles[j]);
	}
	}
	}
	}
	return (list.size() > 0) ? ((list.size() == 1) ? list.getFirst() : list) : null;
	}
	private Object cacheLookup(String name) {
	return fCache.get(name);
	}
	private boolean notFoundCacheLookup(String name) {
	return fNotFoundCache.contains(name);
	}
	private void cacheSourceElement(String name, Object element) {
	fCache.put(name, element);
	}
	private void cacheNotFound(String name) {
	fNotFoundCache.add(name);
	}
	public void dispose() {
	fCache.clear();
	fNotFoundCache.clear();
	}
	public String getMemento() throws CoreException {
	Document document = null;
	Throwable ex = null;
	try {
	document = DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument();
	Element node = document.createElement(ELEMENT_NAME);
	document.appendChild(node);
	node.setAttribute(ATTR_PROJECT, getProject().getName());
	node.setAttribute(ATTR_GENERIC, new Boolean(isGeneric()).toString());
	return PDebugUtils.serializeDocument(document);
	} catch (ParserConfigurationException e) {
	ex = e;
	} catch (IOException e) {
	ex = e;
	} catch (TransformerException e) {
	ex = e;
	}
	abort(MessageFormat.format(InternalSourceLookupMessages.getString("PProjectSourceLocation.0"), new Object[] { getProject().getName() }), ex);
	// execution will not reach here
	return null;
	}
	public void initializeFrom(String memento) throws CoreException {
	Exception ex = null;
	try {
	Element root = null;
	DocumentBuilder parser = DocumentBuilderFactory.newInstance().newDocumentBuilder();
	StringReader reader = new StringReader(memento);
	InputSource source = new InputSource(reader);
	root = parser.parse(source).getDocumentElement();
	String name = root.getAttribute(ATTR_PROJECT);
	if (isEmpty(name)) {
	abort(InternalSourceLookupMessages.getString("PProjectSourceLocation.1"), null);
	} else {
	IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(name);
	setProject(project);
	}
	String isGeneric = root.getAttribute(ATTR_GENERIC);
	if (isGeneric == null \|\| isGeneric.trim().length() == 0)
	isGeneric = Boolean.FALSE.toString();
	setGenerated(isGeneric.equals(Boolean.TRUE.toString()));
	return;
	} catch (ParserConfigurationException e) {
	ex = e;
	} catch (SAXException e) {
	ex = e;
	} catch (IOException e) {
	ex = e;
	}
	abort(InternalSourceLookupMessages.getString("PProjectSourceLocation.2"), ex);
	}
	private void abort(String message, Throwable e) throws CoreException {
	IStatus s = new Status(IStatus.ERROR, PTPDebugCorePlugin.getUniqueIdentifier(), PTPDebugCorePlugin.INTERNAL_ERROR, message, e);
	throw new CoreException(s);
	}
	private boolean isEmpty(String string) {
	return string == null \|\| string.length() == 0;
	}
	public boolean isGeneric() {
	return fGenerated;
	}
	public void setGenerated(boolean b) {
	fGenerated = b;
	}
	public boolean equals(Object obj) {
	if (obj instanceof IProjectSourceLocation && getProject() != null)
	return getProject().equals(((IProjectSourceLocation) obj).getProject());
	return false;
	}
	private void initializeFolders() {
	final LinkedList<IResource> list = new LinkedList<IResource>();
	if (getProject() != null && getProject().exists()) {
	list.add(getProject());
	try {
	getProject().accept(new IResourceProxyVisitor() {
	public boolean visit(IResourceProxy proxy) throws CoreException {
	switch (proxy.getType()) {
	case IResource.FILE:
	return false;
	case IResource.FOLDER:
	list.addLast(proxy.requestResource());
	return true;
	}
	return true;
	}
	}, IResource.NONE);
	} catch (CoreException e) {
	}
	}
	synchronized (this) {
	if (fFolders == null) {
	fFolders = (IResource[]) list.toArray(new IResource[list.size()]);
	}
	}
	}
	protected IResource[] getFolders() {
	if (fFolders == null)
	initializeFolders();
	return fFolders;
	}
	public boolean searchForDuplicateFiles() {
	return fSearchForDuplicateFiles;
	}
	public void setSearchForDuplicateFiles(boolean search) {
	fCache.clear();
	fNotFoundCache.clear();
	fSearchForDuplicateFiles = search;
	}
	public String toString() {
	return (getProject() != null) ? fProject.toString() : "";
	}
	}