org.eclipse.wst.common.snippets/src/org/eclipse/wst/common/snippets/insertions/VariableInsertion.java

/*******************************************************************************
 * Copyright (c) 2004 IBM Corporation 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
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/


package org.eclipse.wst.common.snippets.insertions;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITextSelection;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.swt.dnd.DragSourceEvent;
import org.eclipse.swt.dnd.TextTransfer;
import org.eclipse.swt.dnd.Transfer;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.texteditor.ITextEditor;
import org.eclipse.wst.common.snippets.core.ISnippetItem;
import org.eclipse.wst.common.snippets.internal.ISnippetVariable;
import org.eclipse.wst.common.snippets.internal.Logger;
import org.eclipse.wst.common.snippets.internal.VariableItemHelper;
import org.eclipse.wst.common.snippets.internal.dnd.VariableTextTransfer;
import org.eclipse.wst.common.snippets.internal.ui.EntrySerializer;
import org.eclipse.wst.sse.core.util.StringUtils;
import org.eclipse.wst.sse.ui.extension.IExtendedSimpleEditor;

public class VariableInsertion extends AbstractInsertion {


	public VariableInsertion() {
		super();
	}

	protected Transfer[] createTransfers() {
		return new Transfer[]{VariableTextTransfer.getTransferInstance(), TextTransfer.getInstance()};
	}

	/**
	 * 
	 * @param part
	 * @param editor
	 * @throws BadLocationException
	 */
	protected void doInsert(IEditorPart part, IExtendedSimpleEditor editor) throws BadLocationException {
		String replacement = getInsertString(part.getEditorSite().getShell());
		if (replacement != null) {
			editor.getDocument().replace(editor.getSelectionRange().x, editor.getSelectionRange().y, replacement);
		}
	}

	public void dragSetData(DragSourceEvent event, ISnippetItem item) {
		boolean isSimpleText = TextTransfer.getInstance().isSupportedType(event.dataType);
		if (isSimpleText) {
			// set variable values to ""
			String content = item.getContentString();
			ISnippetVariable[] variables = item.getVariables();
			for (int i = 0; i < variables.length; i++) {
				content = StringUtils.replace(content, "${" + variables[i].getName() + '}', ""); //$NON-NLS-1$ //$NON-NLS-2$
			}
			event.data = content;
		}
		else {
			/*
			 * All complex insertions send an XML encoded version of the item
			 * itself as the data. The drop action must use this to prompt the
			 * user for the correct insertion data
			 */
			event.data = EntrySerializer.getInstance().toXML(item);
		}
	}

	public String getInsertString(Shell host) {
		if (getItem() == null)
			return ""; //$NON-NLS-1$
		String insertString = null;
		ISnippetItem item = getItem();
		if (item.getVariables().length > 0) {
			insertString = VariableItemHelper.getInsertString(host, item);
		}
		else {
			insertString = StringUtils.replace(item.getContentString(), "${cursor}", ""); //$NON-NLS-1$ //$NON-NLS-2$
		}
		return insertString;
	}

	public void insert(IEditorPart editorPart) {
		IEditorPart anEditorPart = editorPart;
		if (anEditorPart == null)
			return;
		if (anEditorPart instanceof ITextEditor) {
			super.insert(editorPart);
		}
		else if (anEditorPart instanceof IExtendedSimpleEditor) {
			/*
			 * The editor itself influences the insertion's actions, so we
			 * can't allow the active editor to be changed. Disabling the
			 * parent shell achieves psuedo-modal behavior without locking the
			 * whole UI under Linux
			 */
			editorPart.getSite().getShell().setEnabled(false);
			try {
				IExtendedSimpleEditor editor = (IExtendedSimpleEditor) anEditorPart;
				doInsert(anEditorPart, editor);
			}
			catch (Exception t) {
				Logger.logException("Could not insert " + getItem().getId(), t); //$NON-NLS-1$
				anEditorPart.getSite().getShell().getDisplay().beep();
			}
			finally {
				editorPart.getSite().getShell().setEnabled(true);
			}
		}
		else {
			// MultiPageEditorPart has no accessors for the source EditorPart
			ITextEditor textEditor = null;
			if (anEditorPart instanceof ITextEditor) {
				textEditor = (ITextEditor) anEditorPart;
			}
			else {
				textEditor = (ITextEditor) anEditorPart.getAdapter(ITextEditor.class);
			}
			if (textEditor != null) {
				if (textEditor.isEditable()) {
					IDocument document = textEditor.getDocumentProvider().getDocument(textEditor.getEditorInput());
					ISelection selection = textEditor.getSelectionProvider().getSelection();
					if (document != null && selection instanceof ITextSelection) {
						ITextSelection textSel = (ITextSelection) selection;
						try {
							doInsert(anEditorPart, textEditor, document, textSel);
						}
						catch (Exception t) {
							Logger.logException("Could not insert " + getItem().getId(), t); //$NON-NLS-1$
							textEditor.getSite().getShell().getDisplay().beep();
						}
					}
				}
			}
			else {
				// any errors here probably aren't really exceptional
				Method getTextEditor = null;
				try {
					getTextEditor = anEditorPart.getClass().getMethod("getTextEditor", new Class[0]); //$NON-NLS-1$
				}
				catch (NoSuchMethodException e) {
					// nothing, not unusual
				}
				Object editor = null;
				if (getTextEditor != null) {
					try {
						editor = getTextEditor.invoke(anEditorPart, new Object[0]);
					}
					catch (IllegalAccessException e) {
						// nothing, not unusual for a non-visible method
					}
					catch (InvocationTargetException e) {
						// nothing, not unusual for a protected implementation
					}
					if (editor instanceof IEditorPart && editor != anEditorPart)
						insert((IEditorPart) editor);
				}
			}
		}
	}

}