org.eclipse.xtext.resource.impl.ResourceDescriptionsProvider Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2010 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.resource.impl;

import java.util.Map;

import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.xtext.resource.IResourceDescriptions;

import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.name.Named;

/**
 * 
 * @author Sven Efftinge - Initial contribution and API
 */
public class ResourceDescriptionsProvider {

	public static final String NAMED_BUILDER_SCOPE = "org.eclipse.xtext.scoping.namespaces.DefaultGlobalScopeProvider.BUILDER_SCOPE";

	public static final String LIVE_SCOPE = "org.eclipse.xtext.scoping.LIVE_SCOPE";

	@Inject
	@Named(NAMED_BUILDER_SCOPE)
	private Provider builderScopeResourceDescriptions;

	@Inject
	@Named(LIVE_SCOPE)
	private Provider liveScopeResourceDescriptions;

	@Inject
	private Provider resourceDescriptions;
	
	public IResourceDescriptions getResourceDescriptions(Resource resource) {
		return getResourceDescriptions(resource.getResourceSet());
	}
	
	/**
	 * Provides the proper resource descriptions according to the context in which the
	 * resource set is used.
	 * 
	 * The context is indicated by the {@link ResourceSet#getLoadOptions() load options} of 
	 * the resource set. Supported options are:
	 * 
	 * 
	 * 	{@link #NAMED_BUILDER_SCOPE} if the resource set is used in the builder.
	 *  
{@link #LIVE_SCOPE} if the resource set contains resources that are going to be 
	 *  	modified locally and should definitely shadow the context of the persisted 
	 *  	resource descriptions.
	 *  If no such option is present the dirty editors are taken into account to contribute
	 *  	their contents to the index
	 * 
	 * 
	 * 
	 * The result is never null.
	 * 
	 * @param resourceSet the resource set that is currently used.
	 * @return the {@link IResourceDescriptions} according to the usage context.
	 * 
	 * @since 2.1
	 */
	@NonNull
	public IResourceDescriptions getResourceDescriptions(@NonNull ResourceSet resourceSet) {
		Map loadOptions = resourceSet.getLoadOptions();
		final IResourceDescriptions result;
		if (loadOptions.containsKey(NAMED_BUILDER_SCOPE)) {
			result = createBuilderScopeResourceDescriptions();
			if (loadOptions.containsKey(LIVE_SCOPE)) {
				throw new IllegalStateException("Ambiguous scope for the resource set: " + loadOptions);
			}
		} else if (loadOptions.containsKey(LIVE_SCOPE)) {
			result = createLiveScopeResourceDescriptions();
		} else {
			result = createResourceDescriptions();
		}
		if (result instanceof IResourceDescriptions.IContextAware) {
			((IResourceDescriptions.IContextAware) result).setContext(resourceSet);
		}
		return result;
	}

	public IResourceDescriptions createLiveScopeResourceDescriptions() {
		return liveScopeResourceDescriptions.get();
	}
	
	public IResourceDescriptions createBuilderScopeResourceDescriptions() {
		return builderScopeResourceDescriptions.get();
	}
	
	public IResourceDescriptions createResourceDescriptions() {
		return resourceDescriptions.get();
	}
	
	public void setBuilderScopeResourceDescriptions(Provider resourceDescriptions) {
		this.builderScopeResourceDescriptions = resourceDescriptions;
	}

	public void setResourceDescriptions(Provider resourceDescriptions) {
		this.resourceDescriptions = resourceDescriptions;
	}
}