Keystrokes.java

/*******************************************************************************
 * Copyright (c) 2009 Ketan Padegaonkar 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:
 *     Ketan Padegaonkar - initial API and implementation
 *******************************************************************************/
package org.eclipse.swtbot.swt.finder.keyboard;

import java.util.Arrays;
import java.util.LinkedHashSet;

import org.eclipse.jface.bindings.keys.IKeyLookup;
import org.eclipse.jface.bindings.keys.KeyLookupFactory;
import org.eclipse.jface.bindings.keys.KeyStroke;
import org.eclipse.swt.SWT;

/**
 * A factory to convert 'complex' keystrokes to a chain of simple keystrokes.
 * <p>
 * For e.g. on a US keyboard converts a character '$' to two keystrokes SHIFT and 4, and a 'T' to a SHIFT and 'T'.
 * </p>
 *
 * @author Ketan Padegaonkar <KetanPadegaonkar [at] gmail [dot] com>
 * @version $Id$
 */
public class Keystrokes {

	/** The SHIFT keystroke. */
	public static final KeyStroke	SHIFT					= KeyStroke.getInstance(SWT.SHIFT, 0);
	/** The CTRL keystroke. */
	public static final KeyStroke	CTRL					= KeyStroke.getInstance(SWT.CTRL, 0);
	/** The ALT keystroke. */
	public static final KeyStroke	ALT						= KeyStroke.getInstance(SWT.ALT, 0);
	/** The COMMAND keystroke. */
	public static final KeyStroke	COMMAND					= KeyStroke.getInstance(SWT.COMMAND, 0);

	/** The MOD1 keystroke. */
	public static final KeyStroke	MOD1					= KeyStroke.getInstance(SWT.MOD1, 0);
	/** The MOD2 keystroke. */
	public static final KeyStroke	MOD2					= KeyStroke.getInstance(SWT.MOD2, 0);
	/** The MOD3 keystroke. */
	public static final KeyStroke	MOD3					= KeyStroke.getInstance(SWT.MOD3, 0);
	/** The MOD4 keystroke. */
	public static final KeyStroke	MOD4					= KeyStroke.getInstance(SWT.MOD4, 0);

	/** The ESC keystroke. */
	public static final KeyStroke	ESC						= KeyStroke.getInstance(0, SWT.ESC);
	/** The backspace keystroke. */
	public static final KeyStroke	BS						= KeyStroke.getInstance(0, SWT.BS);
	/** The delete keystroke. */
	public static final KeyStroke	DELETE					= KeyStroke.getInstance(0, SWT.DEL);

	/** The CR keystroke. */
	public static final KeyStroke	CR						= KeyStroke.getInstance(0, SWT.CR);
	/** The LF keystroke. */
	public static final KeyStroke	LF						= KeyStroke.getInstance(0, SWT.LF);
	/** The TAB keystroke. */
	public static final KeyStroke	TAB						= KeyStroke.getInstance(0, SWT.TAB);
	/** The SPACE keystroke. */
	public static final KeyStroke	SPACE					= KeyStroke.getInstance(0, ' ');

	/** The F1 keystroke. */
	public static final KeyStroke	F1						= KeyStroke.getInstance(0, SWT.F1);
	/** The F2 keystroke. */
	public static final KeyStroke	F2						= KeyStroke.getInstance(0, SWT.F2);
	/** The F3 keystroke. */
	public static final KeyStroke	F3						= KeyStroke.getInstance(0, SWT.F3);
	/** The F4 keystroke. */
	public static final KeyStroke	F4						= KeyStroke.getInstance(0, SWT.F4);
	/** The F5 keystroke. */
	public static final KeyStroke	F5						= KeyStroke.getInstance(0, SWT.F5);
	/** The F6 keystroke. */
	public static final KeyStroke	F6						= KeyStroke.getInstance(0, SWT.F6);
	/** The F7 keystroke. */
	public static final KeyStroke	F7						= KeyStroke.getInstance(0, SWT.F7);
	/** The F8 keystroke. */
	public static final KeyStroke	F8						= KeyStroke.getInstance(0, SWT.F8);
	/** The F9 keystroke. */
	public static final KeyStroke	F9						= KeyStroke.getInstance(0, SWT.F9);
	/** The F10 keystroke. */
	public static final KeyStroke	F10						= KeyStroke.getInstance(0, SWT.F10);
	/** The F11 keystroke. */
	public static final KeyStroke	F11						= KeyStroke.getInstance(0, SWT.F11);
	/** The F12 keystroke. */
	public static final KeyStroke	F12						= KeyStroke.getInstance(0, SWT.F12);

	/** The up keystroke. */
	public static final KeyStroke	UP						= KeyStroke.getInstance(0, SWT.ARROW_UP);
	/** The down keystroke. */
	public static final KeyStroke	DOWN					= KeyStroke.getInstance(0, SWT.ARROW_DOWN);
	/** The left keystroke. */
	public static final KeyStroke	LEFT					= KeyStroke.getInstance(0, SWT.ARROW_LEFT);
	/** The right keystroke. */
	public static final KeyStroke	RIGHT					= KeyStroke.getInstance(0, SWT.ARROW_RIGHT);

	/** The END keystroke. */
	public static final KeyStroke	END						= KeyStroke.getInstance(0, SWT.END);
	/** The HOME keystroke. */
	public static final KeyStroke	HOME					= KeyStroke.getInstance(0, SWT.HOME);
	/** The PAGE_UP keystroke. */
	public static final KeyStroke	PAGE_UP					= KeyStroke.getInstance(0, SWT.PAGE_UP);
	/** The PAGE_DOWN keystroke. */
	public static final KeyStroke	PAGE_DOWN				= KeyStroke.getInstance(0, SWT.PAGE_DOWN);

	/** The keyboard layout to use for mapping characters. */
	private static KeyboardLayout	defaultKeyboardLayout	= KeyboardLayout.getDefaultKeyboardLayout();

	/**
	 * @param ch the character to convert to {@link KeyStroke}s.
	 * @return the {@link KeyStroke}s corresponding to the character.
	 */
	public static KeyStroke[] create(char ch) {
		KeyStroke keyStroke = defaultKeyboardLayout.keyStrokeFor(ch);
		if (keyStroke.getModifierKeys() == KeyStroke.NO_KEY)
			return new KeyStroke[] { keyStroke };
		KeyStroke modifier = KeyStroke.getInstance(keyStroke.getModifierKeys(), 0);
		KeyStroke key = KeyStroke.getInstance(0, keyStroke.getNaturalKey());
		return new KeyStroke[] { modifier, key };
	}

	static char toCharacter(KeyStroke... keys) {
		int modifierKeys = 0;
		int ch = 0;
		for (KeyStroke keyStroke : keys) {
			modifierKeys |= keyStroke.getModifierKeys();
			ch |= keyStroke.getNaturalKey();
		}

		return defaultKeyboardLayout.toCharacter(KeyStroke.getInstance(modifierKeys, ch));
	}

	/**
	 * @param modificationKeys a combination of.
	 * @param c the character to type.
	 * @return the keystrokes corresponding to the modification keys and character.
	 */
	public static KeyStroke[] toKeys(int modificationKeys, char c) {
		LinkedHashSet<KeyStroke> keys = new LinkedHashSet<KeyStroke>();
		if (modificationKeys != 0) {
			int[] sortModifierKeys = sortModifierKeys(modificationKeys);
			for (int modifierKey : sortModifierKeys) {
				if (modifierKey != KeyStroke.NO_KEY)
					keys.add(KeyStroke.getInstance(modifierKey, 0));
			}
		}
		if (c != 0)
			keys.addAll(Arrays.asList(Keystrokes.create(c)));
		return keys.toArray(new KeyStroke[keys.size()]);
	}

	// FIXME: performance improvement: put in a hash of input and output values.
	private static int[] sortModifierKeys(final int modifierKeys) {
		final IKeyLookup lookup = KeyLookupFactory.getDefault();
		final int[] sortedKeys = new int[4];
		int index = 0;

		if ((modifierKeys & lookup.getAlt()) != 0) {
			sortedKeys[index++] = lookup.getAlt();
		}
		if ((modifierKeys & lookup.getCommand()) != 0) {
			sortedKeys[index++] = lookup.getCommand();
		}
		if ((modifierKeys & lookup.getCtrl()) != 0) {
			sortedKeys[index++] = lookup.getCtrl();
		}
		if ((modifierKeys & lookup.getShift()) != 0) {
			sortedKeys[index++] = lookup.getShift();
		}

		return sortedKeys;
	}

}