CapturingDiagnosticListener.java

/*
 * Copyright (C) 2012-2013 The Project Lombok Authors.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package lombok.javac;

import java.io.File;
import java.util.Collection;
import java.util.Iterator;
import java.util.Locale;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import javax.tools.Diagnostic;
import javax.tools.Diagnostic.Kind;
import javax.tools.DiagnosticListener;
import javax.tools.JavaFileObject;

/**
 * This class stores any reported errors as {@code CompilerMessage} objects and supports removing some of these.
 * Currently this class is only used for testing purposes.
 */
public class CapturingDiagnosticListener implements DiagnosticListener<JavaFileObject> {
	private final File file;
	private final Collection<CompilerMessage> messages;
	
	public CapturingDiagnosticListener(File file, Collection<CompilerMessage> messages) {
		this.file = file;
		this.messages = messages;
	}
	
	@Override public void report(Diagnostic<? extends JavaFileObject> d) {
		String msg = d.getMessage(Locale.ENGLISH);
		Matcher m = Pattern.compile(
				"^" + Pattern.quote(file.getAbsolutePath()) +
				"\\s*:\\s*\\d+\\s*:\\s*(?:warning:\\s*)?(.*)$", Pattern.DOTALL).matcher(msg);
		if (m.matches()) msg = m.group(1);
		messages.add(new CompilerMessage(d.getLineNumber(), d.getStartPosition(), d.getKind() == Kind.ERROR, msg));
	}
	
	public void suppress(int start, int end) {
		Iterator<CompilerMessage> it = messages.iterator();
		while (it.hasNext()) {
			long pos = it.next().getPosition();
			if (pos >= start && pos < end) it.remove();
		}
	}
	
	public static final class CompilerMessage {
		/** Line Number (starting at 1) */
		private final long line;
		
		private final long position;
		private final boolean isError;
		private final String message;
		
		public CompilerMessage(long line, long position, boolean isError, String message) {
			this.line = line;
			this.position = position;
			this.isError = isError;
			this.message = message;
		}
		
		public long getLine() {
			return line;
		}
		
		public long getPosition() {
			return position;
		}
		
		public boolean isError() {
			return isError;
		}
		
		public String getMessage() {
			return message;
		}
		
		@Override public int hashCode() {
			final int prime = 31;
			int result = 1;
			result = prime * result + (isError ? 1231 : 1237);
			result = prime * result + (int) (line ^ (line >>> 32));
			result = prime * result + ((message == null) ? 0 : message.hashCode());
			return result;
		}
		
		@Override public boolean equals(Object obj) {
			if (this == obj) return true;
			if (obj == null) return false;
			if (getClass() != obj.getClass()) return false;
			CompilerMessage other = (CompilerMessage) obj;
			if (isError != other.isError) return false;
			if (line != other.line) return false;
			if (message == null) {
				if (other.message != null) return false;
			} else if (!message.equals(other.message)) return false;
			return true;
		}
		
		@Override public String toString() {
			return String.format("%d %s %s", line, isError ? "ERROR" : "WARNING", message);
		}
	}
}