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-2011 Andreas Kirschbaum.
 */

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.File;
import java.io.IOException;
import java.util.Collection;
import java.util.HashSet;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class KeybindingsManager {

    @NotNull
    private final GUICommandFactory guiCommandFactory;

    @NotNull
    private final KeyBindings keyBindings;

    @Nullable
    private KeyBindings characterKeyBindings;

    @Nullable
    private KeyBindingState keyBindingState;

    public KeybindingsManager(@NotNull final File keybindingsFile, @NotNull final GUICommandFactory guiCommandFactory) {
        this.guiCommandFactory = guiCommandFactory;
        keyBindings = new KeyBindings(keybindingsFile, guiCommandFactory);
    }

    public boolean removeKeyBinding(final boolean perCharacter) {
        if (perCharacter && characterKeyBindings == null) {
            return false;
        }

        keyBindingState = new KeyBindingState(characterKeyBindings, perCharacter ? null : keyBindings, 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 : keyBindings;
    }

    public void loadPerCharacterBindings(@NotNull final CharSequence hostname, @NotNull final CharSequence character) {
        try {
            characterKeyBindings = new KeyBindings(Filenames.getKeybindingsFile(hostname, character), guiCommandFactory);
        } catch (final IOException ex) {
            characterKeyBindings = null;
            System.err.println("Cannot read keybindings file for "+character+" on "+hostname+": "+ex.getMessage());
            return;
        }

        try {
            characterKeyBindings.loadKeyBindings();
        } catch (final IOException ex) {
            assert characterKeyBindings != null;
            System.err.println("Cannot read keybindings file "+characterKeyBindings.getFile()+": "+ex.getMessage());
        }
    }

    public void unloadPerCharacterBindings() {
        if (characterKeyBindings != null) {
            try {
                characterKeyBindings.saveKeyBindings();
            } catch (final IOException ex) {
                assert characterKeyBindings != null;
                System.err.println("Cannot write keybindings file "+characterKeyBindings.getFile()+": "+ex.getMessage());
            }
            characterKeyBindings = null;
        }
    }

    public void saveKeybindings() {
        try {
            keyBindings.saveKeyBindings();
        } catch (final IOException ex) {
            System.err.println("Cannot write keybindings file "+keyBindings.getFile()+": "+ex.getMessage());
            //noinspection UnnecessaryReturnStatement
            return;
        }
    }

    public void loadKeybindings() {
        try {
            keyBindings.loadKeyBindings();
        } catch (final IOException ex) {
            System.err.println("Cannot read keybindings file "+keyBindings.getFile()+": "+ex.getMessage());
            //noinspection UnnecessaryReturnStatement
            return;
        }
    }

    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) {
        //noinspection SimplifiableIfStatement
        if (characterKeyBindings != null && characterKeyBindings.handleKeyPress(e)) {
            return true;
        }

        return keyBindings.handleKeyPress(e);
    }

    public Iterable<KeyBinding> getBindingsForPartialCommand(@NotNull final String command, final boolean startOnly) {
        final Collection<KeyBinding> matches = new HashSet<>();

        /*
         * character-specific bindings override global ones, so need to check for
         * duplicates
         */
        if (characterKeyBindings != null) {
            matches.addAll(characterKeyBindings.getBindingsForPartialCommand(command, startOnly));
        }
        final Iterable<KeyBinding> global = keyBindings.getBindingsForPartialCommand(command, startOnly);
        for (final KeyBinding candidate : global) {
            boolean used = false;
            for (final KeyBinding check : matches) {
                if (check.equals(candidate)) {
                    used = true;
                    break;
                }
            }
            if (!used) {
                matches.add(candidate);
            }
        }

        return matches;
    }

}