VdmAnnotationHover.java

/*
 * #%~
 * org.overture.ide.ui
 * %%
 * Copyright (C) 2008 - 2014 Overture
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/gpl-3.0.html>.
 * #~%
 */
package org.overture.ide.ui.editor.core;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.eclipse.core.resources.IMarker;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.source.Annotation;
import org.eclipse.jface.text.source.DefaultAnnotationHover;
import org.eclipse.jface.text.source.IAnnotationModel;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.ui.texteditor.MarkerAnnotation;

public class VdmAnnotationHover extends DefaultAnnotationHover
{

	/**
	 * Creates a new HTML annotation hover.
	 * 
	 * @param showLineNumber
	 *            <code>true</code> if the line number should be shown when no annotation is found
	 * @since 3.4
	 */
	public VdmAnnotationHover(boolean showLineNumber)
	{
		super(showLineNumber);
	}

	// /*
	// * Formats a message as HTML text.
	// */
	// protected String formatSingleMessage(String message) {
	// StringBuffer buffer= new StringBuffer();
	// HTMLPrinter.addPageProlog(buffer);
	// HTMLPrinter.addParagraph(buffer, HTMLPrinter.convertToHTMLContent(message));
	// HTMLPrinter.addPageEpilog(buffer);
	// return buffer.toString();
	// }
	//
	// /*
	// * Formats several message as HTML text.
	// */
	// protected String formatMultipleMessages(List messages) {
	// StringBuffer buffer= new StringBuffer();
	// HTMLPrinter.addPageProlog(buffer);
	// HTMLPrinter.addParagraph(buffer, HTMLPrinter.convertToHTMLContent("Multiple markers found in this line"));
	//
	// HTMLPrinter.startBulletList(buffer);
	// Iterator e= messages.iterator();
	// while (e.hasNext())
	// HTMLPrinter.addBullet(buffer, HTMLPrinter.convertToHTMLContent((String) e.next()));
	// HTMLPrinter.endBulletList(buffer);
	//
	// HTMLPrinter.addPageEpilog(buffer);
	// return buffer.toString();
	// }

	private List<Annotation> getAnnotations(ISourceViewer viewer, int lineNumber)
	{
		IAnnotationModel model = viewer.getAnnotationModel();
		IDocument document = viewer.getDocument();
		return getAnnotationsAtLine(model, document, lineNumber);
	}

	private List<Annotation> getAnnotationsAtLine(IAnnotationModel model,
			IDocument document, int lineNumber)
	{
		List<Annotation> result = new ArrayList<Annotation>();
		@SuppressWarnings("unchecked")
		Iterator<Annotation> it = model.getAnnotationIterator();

		while (it.hasNext())
		{
			Annotation ann = it.next();

			Position pos = model.getPosition(ann);
			
			if(pos==null)
			{
				continue;
			}

			try
			{
				if (document.getLineOfOffset(pos.offset) == lineNumber)
				{
					result.add(ann);
				}
			} catch (BadLocationException e)
			{
				// TODO Auto-generated catch block
				e.printStackTrace();
			}
		}
		return result;
	}

	public String getHoverInfo(ISourceViewer viewer, int lineNumber)
	{
		List<Annotation> annotations = getAnnotations(viewer, lineNumber);
		return printAnnotations(annotations);
	}

	private String printAnnotations(List<Annotation> annotations)
	{

		List<String> hoverResult = new ArrayList<String>();

		for (Annotation ann : annotations)
		{
			if (ann instanceof MarkerAnnotation)
			{

				MarkerAnnotation mAnn = (MarkerAnnotation) ann;
				IMarker m = mAnn.getMarker();

				try
				{
					String a = (String) m.getAttribute(IMarker.MESSAGE);
					hoverResult.add(a + "  ");
				} catch (CoreException e)
				{
					// TODO Auto-generated catch block
					e.printStackTrace();
				}
			}
		}

		if (hoverResult.size() == 0)
		{
			return null;
		}

		if (hoverResult.size() == 1)
		{
			return hoverResult.get(0);
		} else
		{
			StringBuilder s = new StringBuilder();
			s.append("Multiple markers found on this line:\n");
			for (String string : hoverResult)
			{
				s.append("  - ");
				s.append(string);
				s.append("\n");
			}
			return s.toString();
		}

	}

}