ltk/org.eclipse.statet.ltk.ui/src/org/eclipse/statet/ltk/ui/sourceediting/EditorInformationProvider.java

/*=============================================================================#
 # Copyright (c) 2010, 2018 Stephan Wahlbrink and others.
 # 
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 # which is available at https://www.apache.org/licenses/LICENSE-2.0.
 # 
 # SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 # 
 # Contributors:
 #     Stephan Wahlbrink <sw@wahlbrink.eu> - initial API and implementation
 #=============================================================================*/

package org.eclipse.statet.ltk.ui.sourceediting;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubMonitor;
import org.eclipse.jface.text.IInformationControlCreator;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.TypedRegion;
import org.eclipse.jface.text.information.IInformationProvider;
import org.eclipse.jface.text.information.IInformationProviderExtension;
import org.eclipse.jface.text.information.IInformationProviderExtension2;
import org.eclipse.ui.statushandlers.StatusManager;

import org.eclipse.statet.ecommons.text.core.util.TextUtils;

import org.eclipse.statet.internal.ltk.ui.LTKUIPlugin;
import org.eclipse.statet.ltk.ui.sourceediting.assist.AssistInvocationContext;
import org.eclipse.statet.ltk.ui.sourceediting.assist.IInfoHover;


public abstract class EditorInformationProvider
		implements IInformationProvider, IInformationProviderExtension, IInformationProviderExtension2 {
	
	
	private final ISourceEditor editor;
	
	private final IInfoHover[] hovers;
	
	private IInfoHover bestHover;
	
	
	public EditorInformationProvider(final ISourceEditor editor, final IInfoHover[] hovers) {
		this.editor= editor;
		this.hovers= hovers;
	}
	
	
	public ISourceEditor getEditor() {
		return this.editor;
	}
	
	@Override
	public String getInformation(final ITextViewer textViewer, final IRegion region) {
		return null;
	}
	
	@Override
	public Object getInformation2(final ITextViewer textViewer, final IRegion region) {
		this.bestHover= null;
		final SubMonitor m= SubMonitor.convert(null);
		try {
			final String contentType= (region instanceof TypedRegion) ?
					((TypedRegion) region).getType() :
					TextUtils.getContentType(this.editor.getViewer().getDocument(),
							this.editor.getDocumentContentInfo(), region.getOffset(),
							region.getLength() == 0 );
			
			final AssistInvocationContext context= createContext(region, contentType, m);
			if (context != null) {
				for (int i= 0; i < this.hovers.length; i++) {
					final Object info= this.hovers[i].getHoverInfo(context);
					if (info != null) {
						this.bestHover= this.hovers[i];
						return info;
					}
				}
			}
		}
		catch (final Exception e) {
			StatusManager.getManager().handle(new Status(IStatus.ERROR, LTKUIPlugin.BUNDLE_ID,
					"An error occurred when preparing the information hover (command).", e ));
		}
		return null;
	}
	
	@Override
	public IInformationControlCreator getInformationPresenterControlCreator() {
		if (this.bestHover != null) {
			return this.bestHover.getHoverControlCreator();
		}
		return null;
	}
	
	protected abstract AssistInvocationContext createContext(IRegion region, String contentType,
			IProgressMonitor monitor );
	
}