core/plugins/org.eclipse.dltk.ui/src/org/eclipse/dltk/ui/text/ScriptCorrectionContext.java

/*******************************************************************************
 * Copyright (c) 2008, 2018 xored software, Inc. and others.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 * 
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     xored software, Inc. - initial API and Implementation (Alex Panchenko)
 *******************************************************************************/
package org.eclipse.dltk.ui.text;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.eclipse.core.resources.IMarker;
import org.eclipse.dltk.core.IScriptProject;
import org.eclipse.dltk.core.ISourceModule;
import org.eclipse.dltk.ui.editor.IScriptAnnotation;
import org.eclipse.jface.text.contentassist.ICompletionProposal;
import org.eclipse.jface.text.quickassist.IQuickAssistInvocationContext;
import org.eclipse.ui.IMarkerResolution;
import org.eclipse.ui.texteditor.ITextEditor;

/**
 * Default implementation of the {@link IScriptCorrectionContext}.
 *
 *
 * XXX This class will be moved to the internal package
 *
 * @noinstantiate
 * @noextend
 */
public class ScriptCorrectionContext implements IScriptCorrectionContext {

	private List<ICompletionProposal> proposals = null;

	@Override
	public void addProposal(ICompletionProposal proposal) {
		if (proposals == null) {
			proposals = new ArrayList<>();
		}
		proposals.add(proposal);
	}

	@Override
	public void addResolution(IMarkerResolution resolution, IMarker marker) {
		addProposal(new MarkerResolutionProposal(resolution, marker));
	}

	@Override
	public void addResolution(IAnnotationResolution resolution,
			IScriptAnnotation annotation) {
		addProposal(new AnnotationResolutionProposal(resolution, annotation));
	}

	@Override
	public ICompletionProposal[] getProposals() {
		if (proposals != null) {
			return proposals.toArray(new ICompletionProposal[proposals.size()]);
		}
		return null;
	}

	private final IQuickAssistInvocationContext invocationContext;
	private final ITextEditor editor;
	private final ISourceModule module;

	/**
	 * @param invocationContext
	 * @param module
	 */
	public ScriptCorrectionContext(
			IQuickAssistInvocationContext invocationContext, ITextEditor editor,
			ISourceModule module) {
		this.invocationContext = invocationContext;
		this.editor = editor;
		this.module = module;
	}

	@Override
	public ITextEditor getEditor() {
		return editor;
	}

	@Override
	public ISourceModule getModule() {
		return module;
	}

	@Override
	public IScriptProject getProject() {
		return module.getScriptProject();
	}

	@Override
	public IQuickAssistInvocationContext getInvocationContext() {
		return invocationContext;
	}

	private Map<String, Object> attributes = null;

	@Override
	public Object getAttribute(String attributeName) {
		if (attributes == null) {
			return null;
		}
		return attributes.get(attributeName);
	}

	@Override
	public void setAttribute(String attributeName, Object value) {
		if (value != null) {
			if (attributes == null) {
				attributes = new HashMap<>();
			}
			attributes.put(attributeName, value);
		} else {
			if (attributes != null) {
				attributes.remove(attributeName);
			}
		}
	}

}