KeybindingsManager.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 com.realtime.crossfire.jxclient.gui.commandlist.CommandList;
import com.realtime.crossfire.jxclient.gui.commandlist.GUICommandFactory;
import com.realtime.crossfire.jxclient.settings.Filenames;
import java.io.IOException;
import java.nio.file.Path;
import java.util.Map;
import java.util.TreeMap;
import java.util.function.Predicate;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class KeybindingsManager {
 
    @NotNull
    public static final String DEFAULT = "d";
 
    @NotNull
    public static final String GLOBAL = "g";
 
    @NotNull
    public static final String CHARACTER = "c";
 
    @NotNull
    private final GUICommandFactory guiCommandFactory;
 
    @NotNull
    private final KeyBindings globalKeyBindings;
 
    @Nullable
    private KeyBindings characterKeyBindings;
 
    @Nullable
    private KeyBindings defaultKeyBindings;
 
    @Nullable
    private KeyBindingState keyBindingState;
 
    public KeybindingsManager(@NotNull final Path keybindingsFileVersion2, @NotNull final Path keybindingsFileVersion1, @NotNull final GUICommandFactory guiCommandFactory) {
        this.guiCommandFactory = guiCommandFactory;
        globalKeyBindings = new KeyBindings(keybindingsFileVersion2, keybindingsFileVersion1, guiCommandFactory);
    }
 
    public void setDefaultKeyBindings(@NotNull final KeyBindings defaultKeyBindings) {
        this.defaultKeyBindings = defaultKeyBindings;
    }
 
    public boolean removeKeyBinding(final boolean perCharacter) {
        if (perCharacter && characterKeyBindings == null) {
            return false;
        }
 
        keyBindingState = new KeyBindingState(characterKeyBindings, perCharacter ? null : globalKeyBindings, null);
        return true;
    }
 
    public boolean windowClosing() {
        if (keyBindingState == null) {
            return false;
        }
 
        keyBindingState = null;
        return true;
    }
 
    public boolean createKeyBinding(final boolean perCharacter, @NotNull final CommandList cmdList) {
        final KeyBindings bindings = getKeyBindings(perCharacter);
        if (bindings == null) {
            return false;
        }
 
        keyBindingState = new KeyBindingState(bindings, null, cmdList);
        return true;
    }
 
    @Nullable
    private KeyBindings getKeyBindings(final boolean perCharacter) {
        return perCharacter ? characterKeyBindings : globalKeyBindings;
    }
 
    public void loadPerCharacterBindings(@NotNull final CharSequence hostname, @NotNull final CharSequence character) {
        try {
            characterKeyBindings = new KeyBindings(Filenames.getKeybindingsFileVersion2(hostname, character), Filenames.getKeybindingsFileVersion1(hostname, character), guiCommandFactory);
        } catch (final IOException ex) {
            characterKeyBindings = null;
            System.err.println("Cannot read keybindings file for "+character+" on "+hostname+": "+ex.getMessage());
            return;
        }
 
        characterKeyBindings.loadKeyBindings();
    }
 
    public void unloadPerCharacterBindings() {
        if (characterKeyBindings != null) {
            characterKeyBindings.saveKeyBindings();
            characterKeyBindings = null;
        }
    }
 
    public void saveGlobalKeybindings() {
        globalKeyBindings.saveKeyBindings();
    }
 
    public void loadGlobalKeybindings() {
        globalKeyBindings.loadKeyBindings();
    }
 
    public boolean keyReleased() {
        if (keyBindingState == null) {
            return false;
        }
 
        if (!keyBindingState.keyReleased()) {
            return false;
        }
 
        keyBindingState = null;
        return true;
    }
 
    public boolean keyPressed(@NotNull final KeyEvent2 keyEvent) {
        if (keyBindingState == null) {
            return false;
        }
 
        keyBindingState.keyPressed(keyEvent);
        return true;
    }
 
    public boolean escPressed() {
        if (keyBindingState == null) {
            return false;
        }
 
        keyBindingState = null;
        return true;
    }
 
    public boolean handleKeyPress(@NotNull final KeyEvent2 e) {
        if (characterKeyBindings != null && characterKeyBindings.handleKeyPress(e)) {
            return true;
        }
 
        if (globalKeyBindings.handleKeyPress(e)) {
            return true;
        }
 
        //noinspection RedundantIfStatement
        if (defaultKeyBindings != null && defaultKeyBindings.handleKeyPress(e)) {
            return true;
        }
 
        return false;
    }
 
    @NotNull
    public Map<KeyBinding, String> getBindings(@NotNull final Predicate<KeyBinding> predicate) {
        final Map<KeyBinding, String> matches = new TreeMap<>();
 
        /*
         * character-specific bindings override global ones, so need to check for
         * duplicates
         */
        if (characterKeyBindings != null) {
            for (final KeyBinding keyBinding : characterKeyBindings.getBindings(predicate)) {
                matches.put(keyBinding, CHARACTER);
            }
        }
        for (KeyBinding candidate : globalKeyBindings.getBindings(predicate)) {
            boolean used = false;
            for (KeyBinding check : matches.keySet()) {
                if (check.equals(candidate)) {
                    used = true;
                    break;
                }
            }
            if (!used) {
                matches.put(candidate, GLOBAL);
            }
        }
        if (defaultKeyBindings != null) {
            for (KeyBinding candidate : defaultKeyBindings.getBindings(predicate)) {
                boolean used = false;
                for (KeyBinding check : matches.keySet()) {
                    if (check.equals(candidate)) {
                        used = true;
                        break;
                    }
                }
                if (!used) {
                    matches.put(candidate, DEFAULT);
                }
            }
        }
 
        return matches;
    }
 
}