path: root/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ErrorParserManager.java

/*******************************************************************************
 * 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
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Sergey Prigogin (Google)
 *******************************************************************************/
package org.eclipse.cdt.core;

import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Vector;

import org.eclipse.cdt.core.resources.ACBuilder;
import org.eclipse.cdt.utils.CygPath;
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.IWorkspaceRoot;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;

public class ErrorParserManager extends OutputStream {

	private int nOpens;

	private final static String OLD_PREF_ERROR_PARSER = "errorOutputParser"; //$NON-NLS-1$
	public final static String PREF_ERROR_PARSER = CCorePlugin.PLUGIN_ID + ".errorOutputParser"; //$NON-NLS-1$

	private IProject fProject;
	private IMarkerGenerator fMarkerGenerator;
	// Maps a file name without directory to a IFile object or a list of a IFile objects. 
	private Map<String, Object> fFilesInProject;	// Files or lists of files keyed by the file name

	private Map<String, IErrorParser[]> fErrorParsers;
	private ArrayList<ProblemMarkerInfo> fErrors;

	private Vector<IPath> fDirectoryStack;
	private IPath fBaseDirectory;

	private String previousLine;
	private OutputStream outputStream;
	private StringBuffer currentLine = new StringBuffer();

	private StringBuffer scratchBuffer = new StringBuffer();
	
	private boolean hasErrors = false;

	public ErrorParserManager(ACBuilder builder) {
		this(builder.getProject(), builder);
	}

	public ErrorParserManager(IProject project, IMarkerGenerator markerGenerator) {
		this(project, markerGenerator, null);
	}

	public ErrorParserManager(IProject project, IMarkerGenerator markerGenerator, String[] parsersIDs) {
		this(project, project.getLocation(), markerGenerator, parsersIDs);
	}

	public ErrorParserManager(IProject project, IPath workingDirectory, IMarkerGenerator markerGenerator, String[] parsersIDs) {
		fProject = project;
		if (parsersIDs == null) {
			enableAllParsers();
		} else {
			fErrorParsers = new LinkedHashMap<String, IErrorParser[]>(parsersIDs.length);
			for (String parsersID : parsersIDs) {
				IErrorParser[] parsers = CCorePlugin.getDefault().getErrorParser(parsersID);
				fErrorParsers.put(parsersID, parsers);
			}
		}
		fMarkerGenerator = markerGenerator;
		initErrorParserManager(workingDirectory);
	}

	private void initErrorParserManager(IPath workingDirectory) {
		fFilesInProject = new HashMap<String, Object>();
		fDirectoryStack = new Vector<IPath>();
		fErrors = new ArrayList<ProblemMarkerInfo>();

		List<IResource> collectedFiles = new ArrayList<IResource>();
		fBaseDirectory = (workingDirectory == null || workingDirectory.isEmpty()) ? fProject.getLocation() : workingDirectory;
		collectFiles(fProject, collectedFiles);

		for (int i = 0; i < collectedFiles.size(); i++) {
			IFile file = (IFile) collectedFiles.get(i);
			String filename = file.getName();
			Object existing = fFilesInProject.put(filename, file);
			if (existing != null) {
				Collection<IFile> files;
				if (existing instanceof IFile) {
					files = new ArrayList<IFile>();
					files.add((IFile) existing);
				} else {
					@SuppressWarnings("unchecked")
					final Collection<IFile> casted = (Collection<IFile>) existing;
					files = casted;
				}
				files.add(file);
				fFilesInProject.put(filename, files);
			}
		}
	}

	public IProject getProject() {
		return fProject;
	}
	
	public IPath getWorkingDirectory() {
		if (fDirectoryStack.size() != 0) {
			return fDirectoryStack.lastElement();
		}
		// Fall back to the Project Location
		return fBaseDirectory;
	}

	public void pushDirectory(IPath dir) {
		if (dir != null) {
			IPath pwd = null;
			if (fBaseDirectory.isPrefixOf(dir)) {
				int segments = fBaseDirectory.matchingFirstSegments(dir);
				pwd = dir.removeFirstSegments(segments);
			} else {
				pwd = dir;
			}
			fDirectoryStack.addElement(pwd);
		}
	}

	public IPath popDirectory() {
		int i = fDirectoryStack.size();
		if (i != 0) {
			IPath dir = fDirectoryStack.lastElement();
			fDirectoryStack.removeElementAt(i - 1);
			return dir;
		}
		return new Path(""); //$NON-NLS-1$
	}

	public int getDirectoryLevel() {
		return fDirectoryStack.size();
	}

	private void enableAllParsers() {
		fErrorParsers = new LinkedHashMap<String, IErrorParser[]>();
		String[] parserIDs = CCorePlugin.getDefault().getAllErrorParsersIDs();
		for (String parserID : parserIDs) {
			IErrorParser[] parsers = CCorePlugin.getDefault().getErrorParser(parserID);
			fErrorParsers.put(parserID, parsers);
		}
		if (fErrorParsers.size() == 0) {
			initErrorParsersMap();
			CCorePlugin.getDefault().getPluginPreferences().setValue(OLD_PREF_ERROR_PARSER, ""); // remove old prefs //$NON-NLS-1$
		}
	}

	private void initErrorParsersMap() {
		String[] parserIDs = CCorePlugin.getDefault().getAllErrorParsersIDs();
		for (String parserID : parserIDs) {
			IErrorParser[] parsers = CCorePlugin.getDefault().getErrorParser(parserID);
			fErrorParsers.put(parserID, parsers);
		}
	}

	protected void collectFiles(IProject parent, final List<IResource> result) {
		try {
			parent.accept(new IResourceProxyVisitor() {
				public boolean visit(IResourceProxy proxy) {
					if (proxy.getType() == IResource.FILE) {
						result.add(proxy.requestResource());
						return false;
					}
					return true;
				}
			}, IResource.NONE);
		} catch (CoreException e) {
			CCorePlugin.log(e.getStatus());
		}
	}

	/**
	 * Parses the input and try to generate error or warning markers
	 */
	private void processLine(String line) {
		if (fErrorParsers.size() == 0)
			return;

		// If the line is too long, it is most likely a command line and not an error message
		// Don't process it since it'll probably be really slow and won't find an error anyway
		if (line.length() > 1000)
			return;
		
		String[] parserIDs = new String[fErrorParsers.size()];
		Iterator<String> items = fErrorParsers.keySet().iterator();
		for (int i = 0; items.hasNext(); i++) {
			parserIDs[i] = items.next();
		}

		for (int i = 0; i < parserIDs.length; ++i) {
			IErrorParser[] parsers = fErrorParsers.get(parserIDs[i]);
			for (IErrorParser curr : parsers) {
				if (curr.processLine(line, this)) {
					return;
				}
			}
		}
	}

	/**
	 * Returns the project file with the given name if that file can be uniquely identified.
	 * Otherwise returns <code>null</code>. 
	 */
    public IFile findFileName(String fileName) {
		IPath path = new Path(fileName);
		Object obj = fFilesInProject.get(path.lastSegment());
		if (obj == null) {
			return null;
		}
		if (obj instanceof IFile) {
			IFile file = (IFile) obj;
			if (isPossibleMatch(path, file)) {
				return file;
			}
			return null;
		}
        IFile matchingFile = null;
        @SuppressWarnings("unchecked")
		Collection<IFile> files = (Collection<IFile>) obj;
		for (IFile file : files) {
			if (isPossibleMatch(path, file)) {
				if (matchingFile != null) {
					return null;	// Ambiguous match
				}
				matchingFile = file;
			}
		}
		
		if(matchingFile == null) {
			// one more attempt... look for a file with that name in the project
			Object candidateFile = fFilesInProject.get(path.lastSegment());
			if (candidateFile instanceof IFile) {
				return (IFile) candidateFile;
			}
			// not found or getting list of files which is ambiguous 
			return null;
		}
		
		return matchingFile;
	}

	/**
	 * Checks if a file system path {@code location} may point to a workspace {@code resource}.
	 * @param location an absolute or relative file system path.
	 * @param resource a workspace resource.
	 * @return {@code true} if {@code location} may point to {@code resource}.
	 */
	private static boolean isPossibleMatch(IPath location, IResource resource) {
		IPath resourceLocation = resource.getLocation();
		if (resourceLocation == null) {
			// could be an EFS path
			URI locationURI = resource.getLocationURI();
			if(locationURI == null)
				return false;
			
			// Use the path information from the URI to see if the path as seen by the build
			// matches the path that the resource points to.
			
			// This relies on the assumption that the EFS filesystem being used stores path information in the path
			// portion of the URI.  This may not be in fact the case, but most filesystems adhere to such a format.
			String path = locationURI.getPath();
			
			if(path == null)
				return false;
			
			if(location.isAbsolute())
				return location.toString().equals(path);
			
			IPath uriPath = new Path(path);
			int prefixLen = uriPath.segmentCount() - location.segmentCount(); 
			return prefixLen >= 0 && uriPath.removeFirstSegments(prefixLen).equals(location);
			
		}
		if (location.getDevice()==null) {
			resourceLocation = resourceLocation.setDevice(null);
		}
		if (location.isAbsolute()) {
			return location.equals(resourceLocation);
		} else {
			int prefixLen = resourceLocation.segmentCount() - location.segmentCount(); 
			return prefixLen >= 0 && resourceLocation.removeFirstSegments(prefixLen).equals(location);
		}
	}

	protected IFile findFileInWorkspace(IPath path) {
		IFile file = null;
		if (path.isAbsolute()) {
			IWorkspaceRoot root = fProject.getWorkspace().getRoot();
			file =  root.getFileForLocation(path);
			// It may be a link resource so we must check it also.
			if (file == null) {
				IFile[] files = root.findFilesForLocation(path);
				for (IFile file2 : files) {
					if (file2.getProject().equals(fProject)) {
						file = file2;
						break;
					}
				}
			}

		} else {
			file = fProject.getFile(path);
		}
		return file;
	}

	/**
	 * Returns <code>true</code> if the project contains more than one file with the given name.
	 */
	public boolean isConflictingName(String fileName) {
		IPath path = new Path(fileName);
		Object obj = fFilesInProject.get(path.lastSegment());
		return obj != null && !(obj instanceof IFile);
	}

	/**
	 * Called by the error parsers.
	 */
	public IFile findFilePath(String filePath) {
		IPath path = null;
		IPath fp = new Path(filePath);
		if (fp.isAbsolute()) {
			if (fBaseDirectory.isPrefixOf(fp)) {
				int segments = fBaseDirectory.matchingFirstSegments(fp);
				path = fp.removeFirstSegments(segments);
			} else {
				path = fp;
			}
		} else {
			path = getWorkingDirectory().append(filePath);
		}

		IFile file = null;
		// The workspace may throw an IllegalArgumentException
		// Catch it and the parser should fallback to scan the entire project.
		try {
			file = findFileInWorkspace(path);
		} catch (Exception e) {
		}

		// That didn't work, see if it is a cygpath
		if (file == null) {
			CygPath cygpath = null;
			try {
				cygpath = new CygPath();
				fp = new Path(cygpath.getFileName(filePath));
				if (fBaseDirectory.isPrefixOf(fp)) {
					int segments = fBaseDirectory.matchingFirstSegments(fp);
					path = fp.removeFirstSegments(segments);
				} else {
					path = fp;
				}
				file = findFileInWorkspace(path);
			} catch (Exception e) {
			}
			finally {
				if (cygpath != null)
					cygpath.dispose();
			}
		}
		
		// We have to do another try, on Windows for cases like "TEST.C" vs "test.c"
		// We use the java.io.File canonical path.
		if (file == null || !file.exists()) {
			File f = path.toFile();
			try {
				String canon = f.getCanonicalPath();
				path = new Path(canon);
				file = findFileInWorkspace(path);
			} catch (IOException e1) {
			}
		}
		return (file != null && file.exists()) ? file : null;
	}

	/**
	 * Called by the error parsers.
	 */
	public void generateMarker(IResource file, int lineNumber, String desc, int severity, String varName) {
		generateExternalMarker(file, lineNumber, desc, severity, varName, null);
	}

	/**
	 * Called by the error parsers for external problem markers
	 */
	public void generateExternalMarker(IResource file, int lineNumber, String desc, int severity, String varName, IPath externalPath) {
		ProblemMarkerInfo problemMarkerInfo = new ProblemMarkerInfo(file, lineNumber, desc, severity, varName, externalPath);
		fErrors.add(problemMarkerInfo);
		if (severity == IMarkerGenerator.SEVERITY_ERROR_RESOURCE)
			hasErrors = true;
	}

	/**
	 * Called by the error parsers.  Return the previous line, save in the working buffer.
	 */
	public String getPreviousLine() {
		return new String((previousLine) == null ? "" : previousLine); //$NON-NLS-1$
	}

	/**
	 * Method setOutputStream.
	 * @param os
	 */
	public void setOutputStream(OutputStream os) {
		outputStream = os;
	}

	/**
	 * Method getOutputStream. It has a reference count
	 * the stream must be close the same number of time this method was call.
	 * @return OutputStream
	 */
	public OutputStream getOutputStream() {
		nOpens++;
		return this;
	}

	/**
	 * @see java.io.OutputStream#close()
	 */
	@Override
	public void close() throws IOException {
		if (nOpens > 0 && --nOpens == 0) {
			checkLine(true);
			fDirectoryStack.removeAllElements();
			fBaseDirectory = null;
			if (outputStream != null)
				outputStream.close();
		}
	}

	/**
	 * @see java.io.OutputStream#flush()
	 */
	@Override
	public void flush() throws IOException {
		if (outputStream != null)
			outputStream.flush();
	}

	/**
	 * @see java.io.OutputStream#write(int)
	 */
	@Override
	public synchronized void write(int b) throws IOException {
		currentLine.append((char) b);
		checkLine(false);
		if (outputStream != null)
			outputStream.write(b);
	}

	@Override
	public synchronized void write(byte[] b, int off, int len) throws IOException {
		if (b == null) {
			throw new NullPointerException();
		} else if (off != 0 || (len < 0) || (len > b.length)) {
			throw new IndexOutOfBoundsException();
		} else if (len == 0) {
			return;
		}
		currentLine.append(new String(b, 0, len));
		checkLine(false);
		if (outputStream != null)
			outputStream.write(b, off, len);
	}

	private void checkLine(boolean flush) {
		String buffer = currentLine.toString();
		int i = 0;
		while ((i = buffer.indexOf('\n')) != -1) {
			String line = buffer.substring(0, i).trim(); // get rid of any trailing \r
			processLine(line);
			previousLine = line;
			buffer = buffer.substring(i + 1); // skip the \n and advance
		}
		currentLine.setLength(0);
		if (flush) {
			if (buffer.length() > 0) {
				processLine(buffer);
				previousLine = buffer;
			}
		} else {
			currentLine.append(buffer);
		}
	}

	public boolean reportProblems() {
		boolean reset = false;
		if (nOpens == 0) {
			Iterator<ProblemMarkerInfo> iter = fErrors.iterator();
			while (iter.hasNext()) {
				ProblemMarkerInfo problemMarkerInfo = iter.next();
				if (problemMarkerInfo.severity == IMarkerGenerator.SEVERITY_ERROR_BUILD) {
					reset = true;
				}
				fMarkerGenerator.addMarker(problemMarkerInfo);
			}
			fErrors.clear();
		}
		return reset;
	}

	/**
	 * 
	 */
	public String getScratchBuffer() {
		return scratchBuffer.toString();
	}

	/**
	 * @param line
	 */
	public void appendToScratchBuffer(String line) {
		scratchBuffer.append(line);
	}

	/**
	 * 
	 */
	public void clearScratchBuffer() {
		scratchBuffer.setLength(0);
	}
	
	public boolean hasErrors() {
		return hasErrors;
	}
}