debug/org.eclipse.ptp.debug.core/src/org/eclipse/ptp/debug/internal/core/sourcelookup/PDirectorySourceContainer.java

/*******************************************************************************
 * 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
 *******************************************************************************/
/*******************************************************************************
 * Copyright (c) 2004, 2005 QNX Software Systems 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:
 * QNX Software Systems - Initial API and implementation
 *******************************************************************************/
package org.eclipse.ptp.debug.internal.core.sourcelookup; 

import java.io.File;
import java.util.ArrayList;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.debug.core.sourcelookup.ISourceContainer;
import org.eclipse.debug.core.sourcelookup.ISourceContainerType;
import org.eclipse.debug.core.sourcelookup.containers.CompositeSourceContainer;
import org.eclipse.debug.core.sourcelookup.containers.LocalFileStorage;
import org.eclipse.ptp.debug.core.PTPDebugCorePlugin;
 
/**
 * It is not supposed to subclass DirectorySourceContainer, but we need to use 
 * the different browser.
 */
public class PDirectorySourceContainer extends CompositeSourceContainer {

	/**
	 * Unique identifier for the PTP directory source container type
	 * (value <code>org.eclipse.ptp.debug.core.containerType.directory</code>).
	 */
	public static final String TYPE_ID = PTPDebugCorePlugin.getUniqueIdentifier() + ".containerType.directory";

	// root directory
	private File fDirectory;
	// whether to search subfolders
	private boolean fSubfolders = false;

	/**
	 * Consutructs an external folder container for the
	 * directory identified by the given path.
	 * 
	 * @param dirPath path to a directory in the local file system
	 * @param subfolders whether folders within the root directory
	 *  should be searched for source elements
	 */
	public PDirectorySourceContainer( IPath dirPath, boolean subfolders ) {
		this( dirPath.toFile(), subfolders );
	}
	
	/**
	 * Consutructs an external folder container for the
	 * directory identified by the given file.
	 * 
	 * @param dir a directory in the local file system
	 * @param subfolders whether folders within the root directory
	 *  should be searched for source elements
	 */
	public PDirectorySourceContainer( File dir, boolean subfolders ) {
		fDirectory = dir;
		fSubfolders = subfolders;
	}	
		
	/* (non-Javadoc)
	 * @see org.eclipse.debug.internal.core.sourcelookup.ISourceContainer#getName()
	 */
	public String getName() {
		return fDirectory.getName();
	}	
	
	/**
	 * Returns the root directory in the local file system associated
	 * with this source container.
	 * 
	 * @return the root directory in the local file system associated
	 * with this source container
	 */
	public File getDirectory() {
		return fDirectory;
	}

	public boolean searchSubfolders() {
		return fSubfolders;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.debug.internal.core.sourcelookup.ISourceContainer#getType()
	 */
	public ISourceContainerType getType() {
		return getSourceContainerType( TYPE_ID );
	}

	/* (non-Javadoc)
	 * @see org.eclipse.debug.internal.core.sourcelookup.ISourceContainer#findSourceElements(java.lang.String)
	 */
	public Object[] findSourceElements( String name ) throws CoreException {
		ArrayList<Object> sources = new ArrayList<Object>();
		File directory = getDirectory();
		File file = new File( directory, name );
		if ( file.exists() && file.isFile() ) {
			sources.add( new LocalFileStorage( file ) );
		}
		// check subfolders
		if ( (isFindDuplicates() && fSubfolders) || (sources.isEmpty() && fSubfolders) ) {
			ISourceContainer[] containers = getSourceContainers();
			for( int i = 0; i < containers.length; i++ ) {
				Object[] objects = containers[i].findSourceElements( name );
				if ( objects == null || objects.length == 0 ) {
					continue;
				}
				if ( isFindDuplicates() ) {
					for( int j = 0; j < objects.length; j++ )
						sources.add( objects[j] );
				}
				else {
					sources.add( objects[0] );
					break;
				}
			}
		}
		if ( sources.isEmpty() )
			return EMPTY;
		return sources.toArray();
	}

	/* (non-Javadoc)
	 * @see org.eclipse.debug.internal.core.sourcelookup.ISourceContainer#isComposite()
	 */
	public boolean isComposite() {
		return fSubfolders;
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	public boolean equals( Object obj ) {
		if ( obj instanceof PDirectorySourceContainer ) {
			PDirectorySourceContainer container = (PDirectorySourceContainer)obj;
			return container.getDirectory().equals( getDirectory() );
		}
		return false;
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#hashCode()
	 */
	public int hashCode() {
		return getDirectory().hashCode();
	}

	/* (non-Javadoc)
	 * @see org.eclipse.debug.internal.core.sourcelookup.containers.CompositeSourceContainer#createSourceContainers()
	 */
	protected ISourceContainer[] createSourceContainers() throws CoreException {
		if ( isComposite() ) {
			String[] files = fDirectory.list();
			if ( files != null ) {
				List<ISourceContainer> dirs = new ArrayList<ISourceContainer>();
				for( int i = 0; i < files.length; i++ ) {
					String name = files[i];
					File file = new File( getDirectory(), name );
					if ( file.exists() && file.isDirectory() ) {
						dirs.add( new PDirectorySourceContainer( file, true ) );
					}
				}
				ISourceContainer[] containers = (ISourceContainer[])dirs.toArray( new ISourceContainer[dirs.size()] );
				for( int i = 0; i < containers.length; i++ ) {
					ISourceContainer container = containers[i];
					container.init( getDirector() );
				}
				return containers;
			}
		}
		return new ISourceContainer[0];
	}
}