org.eclipse.xtext.scoping.IGlobalScopeProvider Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2009 itemis AG (http://www.itemis.eu) 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
 *******************************************************************************/
package org.eclipse.xtext.scoping;

import org.eclipse.emf.ecore.EReference;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.xtext.resource.IEObjectDescription;

import com.google.common.base.Predicate;

/**
 * Provides scopes for the world, that is things which are not local (i.e. within a resource).
 * 
 * Common scope providers (local ones) use them to delegate lookup for any elements, which are not
 * locally available.
 * 
 * @author Sven Efftinge - Initial contribution and API
 */
public interface IGlobalScopeProvider {

	/**
	 * Returns a global scope for the given context. The scope provides access to the
	 * {@link org.eclipse.xtext.resource.EObjectDescription} visible from the given {@link Resource}
	 * according to the definition of the global scope hierarchy (which is usually defined by 
	 * {@link org.eclipse.xtext.resource.IContainer.Manager}).
	 *
	 * @param context the resource from which the global scope is looked at.
	 * @param reference the reference for which to construct a global scope.
	 * @param filter a filter used to filter down the elements contained in each scope. Scopes will only contain elements for which the filter returned true.
	 * @return {@link IScope} representing the inner most {@link IScope} for the
	 *         passed context and reference. Note for implementors: The result may not be null.
	 *         Return IScope.NULLSCOPE instead.
	 */
	IScope getScope(Resource context, EReference reference, Predicate filter);
}