IKeyboardState.java

/*
  IKeyboardState.java

  (c) 2011-2017 Edward Swartz

  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
 */
package v9t9.common.keyboard;

import java.util.Set;

import v9t9.common.client.ISettingsHandler;
import v9t9.common.settings.SettingSchema;

/**
 * @author ejs
 *
 */
public interface IKeyboardState {
	public static SettingSchema settingUseNumPadForJoystick = new SettingSchema(
			ISettingsHandler.MACHINE, 
			"UseNumPadForJoystick", Boolean.TRUE);

    
	boolean isAsciiDirectKey(char x);

	/**
	 * Fully reset keyboard state
	 */
	void resetKeyboard();
	/**
	 * Fully reset joystick
	 */
	void resetJoystick();
	

	/**
	 * Clear the state of all keys represented, before updating incrementally
	 */
	void incrClearKeyboard();

	/**
	 * Incrementally modify the state of the given key
	 * @param onoff
	 * @param key one of {@link KeyboardConstants#KEY_xxx}, including shifts
	 */
	void incrSetKey(boolean onoff, int key);

	/**
	 * Apply recent changes via {@link #incrSetKey(boolean, int)} 
	 * etc. to expose a unified keyboard state
	 */
	void applyIncrKeyState();

	public static final int JOY_B = 4; // set buttons
	public static final int JOY_X = 1;
	public static final int JOY_Y = 2;
	
	/**
	 * 
	 * @param joy 1 or 2
	 * @param mask JOY_X, JOY_Y, JOY_B
	 * @param x neg or pos or 0
	 * @param y neg or pos or 0
	 * @param fire boolean
	 */
	void setJoystick(int joy, int mask, int x, int y, boolean fire);
	int getJoystick(int joy, int mask);

	/** Get the low-level hardware bits for the keyboard column (8) */
	int getKeyboardRow(int column);

	boolean anyKeyPressed();

	boolean isSet(byte shift, int key);

	/** get shift, see {@link KeyboardConstants#MASK_...} */
	byte getShiftMask();

	/** get current locks, see {@link KeyboardConstants#MASK_...} */
	byte getLockMask();
	boolean isLock(byte locks);

	void addKeyboardListener(IKeyboardListener listener);
	void removeKeyboardListener(IKeyboardListener listener);

	/**
	 * Modify the lock state of the given bits in lock
	 * @param onoff true to enable, false to disable
	 * @param lock mask of {@link KeyboardConstants#MASK_xxx} bits to set or reset
	 */
	void changeLocks(boolean onoff, byte lock);

	/**
	 * @param vkey
	 * @param keys
	 */
	void registerMapping(int vkey, int... keys);

	/** Set hardware keys from the virtual keys
	 * @param keys currently set keys, modified to remove matches
	 *  */
	void setKeysFrom(Set<Integer> keys);

	/**
	 * @param keycode
	 * @param selection
	 */
	void stickyApplyKey(int keycode, boolean onoff);

	/**
	 * @return
	 */
	boolean isBufferEmpty();

}