ConfigurableIssueSeveritiesProvider.java

/*
 * $Id$
 *
 * SARL is an general-purpose agent programming language.
 * More details on http://www.sarl.io
 *
 * Copyright (C) 2014-2017 the original authors or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.sarl.lang.validation;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import javax.inject.Inject;
import javax.inject.Singleton;

import com.google.common.base.Strings;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.xtext.diagnostics.Severity;
import org.eclipse.xtext.preferences.IPreferenceValues;
import org.eclipse.xtext.preferences.IPreferenceValuesProvider;
import org.eclipse.xtext.preferences.PreferenceKey;
import org.eclipse.xtext.validation.ConfigurableIssueCodesProvider;
import org.eclipse.xtext.validation.IssueSeveritiesProvider;
import org.eclipse.xtext.validation.SeverityConverter;

/** A configurable issue severity provider.
 *
 * <p>This issue severity provider provides a public API for dynamically
 * and programmatically changing the severity of the issues.
 * For the Eclipse implementation of the provider, the standard severity provider
 * gets the severity levels from the preferences.
 * But, this configurable issue severity provider should not change the preferences.
 * The contract is to have internal overriding of the preferences in this provider.
 *
 * @author $Author: sgalland$
 * @version $FullVersion$
 * @mavengroupid $GroupId$
 * @mavenartifactid $ArtifactId$
 * @since 0.5
 */
@Singleton
public class ConfigurableIssueSeveritiesProvider extends IssueSeveritiesProvider implements IConfigurableIssueSeveritiesProvider {

	private final Map<String, Severity> overridingSeverities = Collections.synchronizedMap(new HashMap<>());

	@Inject
	private ConfigurableIssueCodesProvider issueCodesProvider;

	@Override
	protected IPreferenceValuesProvider getValuesProvider() {
		final IPreferenceValuesProvider original = super.getValuesProvider();
		if (this.overridingSeverities.isEmpty()) {
			return original;
		}
		return new ConfigurableValueProvider(original, this.overridingSeverities);
	}

	@Override
	public void setSeverity(String code, Severity severity) {
		if (!Strings.isNullOrEmpty(code)) {
			final PreferenceKey key = this.issueCodesProvider.getConfigurableIssueCodes().get(code);
			if (key != null) {
				if (severity == null) {
					this.overridingSeverities.remove(key.getId());
				} else {
					this.overridingSeverities.put(key.getId(), severity);
				}
			}
		}
	}

	@Override
	public void setAllSeverities(Severity severity) {
		this.overridingSeverities.clear();
		if (severity != null) {
			for (final PreferenceKey key : this.issueCodesProvider.getConfigurableIssueCodes().values()) {
				if (key != null) {
					this.overridingSeverities.put(key.getId(), severity);
				}
			}
		}
	}

	/** Configurable value provider.
	 *
	 * @author $Author: sgalland$
	 * @version $FullVersion$
	 * @mavengroupid $GroupId$
	 * @mavenartifactid $ArtifactId$
	 * @since 0.5
	 */
	public static class ConfigurableValueProvider implements IPreferenceValuesProvider {

		private final IPreferenceValuesProvider original;

		private final Map<String, Severity> overridingSeverities;

		/** Constructor.
		 *
		 * @param original the original value provider.
		 * @param overridingSeverities the overridings.
		 */
		public ConfigurableValueProvider(IPreferenceValuesProvider original, Map<String, Severity> overridingSeverities) {
			this.original = original;
			this.overridingSeverities = overridingSeverities;
		}

		@Override
		public IPreferenceValues getPreferenceValues(Resource context) {
			final IPreferenceValues values = this.original.getPreferenceValues(context);
			return new ConfigurableValues(values, this.overridingSeverities);
		}

	}

	/** Configurable values.
	 *
	 * @author $Author: sgalland$
	 * @version $FullVersion$
	 * @mavengroupid $GroupId$
	 * @mavenartifactid $ArtifactId$
	 * @since 0.5
	 */
	public static class ConfigurableValues implements IPreferenceValues {

		private final IPreferenceValues original;

		private final Map<String, Severity> overridingSeverities;

		/** Constructor.
		 *
		 * @param original the original values.
		 * @param overridingSeverities the overridings.
		 */
		public ConfigurableValues(IPreferenceValues original, Map<String, Severity> overridingSeverities) {
			this.original = original;
			this.overridingSeverities = overridingSeverities;
		}

		@Override
		public String getPreference(PreferenceKey key) {
			if (key != null) {
				final Severity severity = this.overridingSeverities.get(key.getId());
				if (severity != null) {
					switch (severity) {
					case ERROR:
						return SeverityConverter.SEVERITY_ERROR;
					case IGNORE:
						return SeverityConverter.SEVERITY_IGNORE;
					case INFO:
						return SeverityConverter.SEVERITY_INFO;
					case WARNING:
						return SeverityConverter.SEVERITY_WARNING;
					default:
					}
				}
			}
			return this.original.getPreference(key);
		}

	}

}