KeyEvent2.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient 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 2 of the License, or
 * (at your option) any later version.
 *
 * JXClient 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 JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.gui.keybindings;
 
import java.awt.event.InputEvent;
import java.awt.event.KeyEvent;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class KeyEvent2 implements Comparable<KeyEvent2> {
 
    public static final int NONE = 0;
 
    public static final int ALT = InputEvent.ALT_DOWN_MASK;
 
    public static final int ALT_GRAPH = InputEvent.ALT_GRAPH_DOWN_MASK;
 
    public static final int CTRL = InputEvent.CTRL_DOWN_MASK;
 
    public static final int META = InputEvent.META_DOWN_MASK;
 
    public static final int SHIFT = InputEvent.SHIFT_DOWN_MASK;
 
    public static final int MASK = ALT|ALT_GRAPH|CTRL|META|SHIFT;
 
    private final int keyCode;
 
    private final char keyChar;
 
    private final int modifiers;
 
    public KeyEvent2(final int keyCode, final char keyChar, final int modifiers) {
        this.keyCode = keyCode;
        this.keyChar = keyChar;
        this.modifiers = modifiers;
    }
 
    public int getKeyCode() {
        return keyCode;
    }
 
    public char getKeyChar() {
        return keyChar;
    }
 
    public int getModifiers() {
        return modifiers;
    }
 
    public boolean matchesKeyEvent(@NotNull final KeyEvent2 keyEvent) {
        if (keyCode == KeyEvent.VK_UNDEFINED) {
            return keyChar == keyEvent.keyChar;
        }
        return keyCode == keyEvent.keyCode && modifiers == keyEvent.modifiers;
    }
 
    @Override
    public boolean equals(@Nullable final Object obj) {
        if (obj == null || obj.getClass() != getClass()) {
            return false;
        }
        final KeyEvent2 keyEvent = (KeyEvent2)obj;
        if (keyCode != KeyEvent.VK_UNDEFINED && keyEvent.keyCode != KeyEvent.VK_UNDEFINED) {
            return keyCode == keyEvent.keyCode && modifiers == keyEvent.modifiers;
        }
        //noinspection SimplifiableIfStatement
        if (keyCode == KeyEvent.VK_UNDEFINED && keyEvent.keyCode == KeyEvent.VK_UNDEFINED) {
            return keyChar == keyEvent.keyChar;
        }
        return false;
    }
 
    @Override
    public int hashCode() {
        return keyCode == KeyEvent.VK_UNDEFINED ? keyChar : keyCode^modifiers;
    }
 
    @Override
    public int compareTo(@NotNull final KeyEvent2 o) {
        final int cmp1 = Integer.compare(keyCode, o.keyCode);
        if (cmp1 != 0) {
            return cmp1;
        }
        final int cmp2 = Integer.compare(keyChar, o.keyChar);
        if (cmp2 != 0) {
            return cmp2;
        }
        return Integer.compare(modifiers, o.modifiers);
    }
 
    @NotNull
    @Override
    public String toString() {
        return "code="+keyCode+", char="+(keyChar == KeyEvent.CHAR_UNDEFINED ? "undefined" : keyChar)+", modifiers="+modifiers;
    }
 
    @SuppressWarnings({"deprecation", "RedundantSuppression"}) // accesses deprecated constants like InputEvent.ALT_MASK
    public static int convertModifiers(final int modifiers) {
        int result = 0;
        if ((modifiers&InputEvent.ALT_MASK) != 0) {
            result |= InputEvent.ALT_DOWN_MASK;
        }
        if ((modifiers&InputEvent.ALT_GRAPH_MASK) != 0) {
            result |= modifiers&InputEvent.ALT_GRAPH_DOWN_MASK;
        }
        if ((modifiers&InputEvent.CTRL_MASK) != 0) {
            result |= InputEvent.CTRL_DOWN_MASK;
        }
        if ((modifiers&InputEvent.META_MASK) != 0) {
            result |= InputEvent.META_DOWN_MASK;
        }
        if ((modifiers&InputEvent.SHIFT_MASK) != 0) {
            result |= InputEvent.SHIFT_DOWN_MASK;
        }
        return result;
    }
 
    @NotNull
    public static String modifiersToString(final int modifiers) {
        final StringBuilder sb = new StringBuilder();
        if ((modifiers&ALT) != 0) {
            sb.append("|alt");
        }
        if ((modifiers&ALT_GRAPH) != 0) {
            sb.append("|alt_graph");
        }
        if ((modifiers&CTRL) != 0) {
            sb.append("|ctrl");
        }
        if ((modifiers&META) != 0) {
            sb.append("|meta");
        }
        if ((modifiers&SHIFT) != 0) {
            sb.append("|shift");
        }
        return sb.length() == 0 ? "none" : sb.substring(1);
    }
 
    public static int stringToModifiers(@NotNull final String modifiers) {
        if (modifiers.equals("none")) {
            return 0;
        }
 
        int result = 0;
        for (final String s : modifiers.split("\\|", -1)) {
            switch (s) {
            case "alt":
                result |= ALT;
                break;
 
            case "alt_graph":
                result |= ALT_GRAPH;
                break;
 
            case "ctrl":
                result |= CTRL;
                break;
 
            case "meta":
                result |= META;
                break;
 
            case "shift":
                result |= SHIFT;
                break;
 
            default:
                System.err.println("Warning: ignoring unknown modifier '"+s+"' in keybinding");
                break;
            }
        }
        return result;
    }
 
}