BindingsCommand.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.commands;
 
import com.realtime.crossfire.jxclient.gui.keybindings.KeyBinding;
import com.realtime.crossfire.jxclient.gui.keybindings.KeybindingsManager;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection;
import java.util.Map.Entry;
import org.jetbrains.annotations.NotNull;
 
public class BindingsCommand extends AbstractCommand {
 
    @NotNull
    private final KeybindingsManager keybindingsManager;
 
    public BindingsCommand(@NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final KeybindingsManager keybindingsManager) {
        super("bindings", crossfireServerConnection);
        this.keybindingsManager = keybindingsManager;
    }
 
    @Override
    public boolean allArguments() {
        return false;
    }
 
    @Override
    public void execute(@NotNull final String args) {
        final Iterable<Entry<KeyBinding, String>> bindings = keybindingsManager.getBindings(binding -> binding.getCommandString().contains(args)).entrySet();
        drawInfo("Keybindings:");
        for (Entry<KeyBinding, String> e : bindings) {
            final KeyBinding binding = e.getKey();
            drawInfo("<"+e.getValue()+"> "+binding.getBindingDescription()+": "+binding.getCommandString());
        }
    }
 
    @NotNull
    @Override
    public String getHelp() {
        //noinspection StringBufferReplaceableByString
        final StringBuilder sb = new StringBuilder();
        sb.append("Shows defined keybindings\n");
        sb.append("\n");
        sb.append("Usage: bindings\n");
        sb.append("Usage: bindings <command>\n");
        sb.append("\n");
        sb.append("The first form shows all currently active keybindings. ");
        sb.append("If <command> is given, shows only keybindings which include the given (partial) command.\n");
        sb.append("The first column shows where the key binding is defined: ");
        sb.append("<").append(KeybindingsManager.DEFAULT).append(">=default, ");
        sb.append("<").append(KeybindingsManager.GLOBAL).append(">=global (character-independent), ");
        sb.append("<").append(KeybindingsManager.CHARACTER).append(">=current character.\n");
        sb.append("Note: Bind a key: bind\n");
        sb.append("Note: Unbind a key: unbind\n");
        return sb.toString();
    }
 
}