core/tests/org.eclipse.dltk.core.tests/src/org/eclipse/dltk/core/tests/model/TestSearchResults.java

/*******************************************************************************
 * Copyright (c) 2008, 2017 xored software, Inc. 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:
 *     xored software, Inc. - initial API and Implementation (Alex Panchenko)
 *******************************************************************************/
package org.eclipse.dltk.core.tests.model;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.dltk.core.IMethod;
import org.eclipse.dltk.core.IModelElement;
import org.eclipse.dltk.core.ISourceModule;
import org.eclipse.dltk.core.IType;
import org.eclipse.dltk.core.search.SearchMatch;
import org.eclipse.dltk.core.search.SearchRequestor;
import org.junit.Assert;

public class TestSearchResults extends SearchRequestor {

	@Override
	public void acceptSearchMatch(SearchMatch match) throws CoreException {
		matches.add(match);
	}

	private List<SearchMatch> matches = new ArrayList<>();

	public int size() {
		return matches.size();
	}

	public SearchMatch getMatch(int index) {
		return matches.get(index);
	}

	public IModelElement get(int index) {
		return (IModelElement) matches.get(index).getElement();
	}

	public void assertSourceModule(String name) {
		if (locate(ISourceModule.class, name, true) == null) {
			Assert.fail(
					"Not found " + name + ":" + ISourceModule.class.getName());
		}
	}

	public void assertType(String name) {
		assertExists(IType.class, name);
	}

	public void assertMethod(String name) {
		assertExists(IMethod.class, name);
	}

	public void assertExists(Class<? extends IModelElement> modelElementClass,
			String modelElementName) {
		if (locate(modelElementClass, modelElementName) == null) {
			Assert.fail("Not found " + modelElementName + ":"
					+ modelElementClass.getName());
		}
	}

	public IModelElement locate(
			Class<? extends IModelElement> modelElementClass,
			String modelElementName) {
		return locate(modelElementClass, modelElementName, false);
	}

	public IModelElement locate(
			Class<? extends IModelElement> modelElementClass,
			String modelElementName, boolean allowAncestorCheck) {
		Assert.assertNotNull(modelElementClass);
		Assert.assertTrue(
				IModelElement.class.isAssignableFrom(modelElementClass));
		for (final SearchMatch match : matches) {
			final IModelElement element;
			if (modelElementClass.isInstance(match.getElement())) {
				element = (IModelElement) match.getElement();
			} else if (allowAncestorCheck
					&& match.getElement() instanceof IModelElement) {
				element = ((IModelElement) match.getElement())
						.getAncestor(modelElementClass);
				if (element == null) {
					continue;
				}
			} else {
				continue;
			}
			final String matchName;
			if (element instanceof IType) {
				final IType type = (IType) element;
				// TODO use separator defined for the target language
				matchName = type.getTypeQualifiedName("::");
			} else {
				matchName = element.getElementName();
			}
			if (modelElementName.equals(matchName)) {
				return element;
			}
		}
		return null;
	}

	@Override
	public String toString() {
		return matches.toString();
	}

	public void sortByOffset() {
		Collections.sort(matches, (o1, o2) -> o1.getOffset() - o2.getOffset());
	}
}