BindCommand.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.commandlist.CommandList;
import com.realtime.crossfire.jxclient.gui.commandlist.CommandListType;
import com.realtime.crossfire.jxclient.gui.commandlist.GUICommandFactory;
import com.realtime.crossfire.jxclient.gui.textinput.CommandCallback;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection;
import com.realtime.crossfire.jxclient.util.StringUtils;
import org.jetbrains.annotations.NotNull;
 
public class BindCommand extends AbstractCommand {
 
    @NotNull
    private final CommandCallback commandCallback;
 
    @NotNull
    private final GUICommandFactory guiCommandFactory;
 
    public BindCommand(@NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final CommandCallback commandCallback, @NotNull final GUICommandFactory guiCommandFactory) {
        super("bind", crossfireServerConnection);
        this.commandCallback = commandCallback;
        this.guiCommandFactory = guiCommandFactory;
    }
 
    @Override
    public boolean allArguments() {
        return true;
    }
 
    @Override
    public void execute(@NotNull final String args) {
        final String commandList;
        final boolean perCharacterBinding;
        if (args.equals("-c")) {
            perCharacterBinding = true;
            commandList = "";
        } else if (args.startsWith("-c ")) {
            perCharacterBinding = true;
            commandList = StringUtils.trimLeading(args.substring(3));
        } else {
            perCharacterBinding = false;
            commandList = args;
        }
 
        if (commandList.isEmpty()) {
            drawInfoError("Which command do you want to bind?");
            return;
        }
 
        final CommandList commandList2 = new CommandList(CommandListType.AND);
        commandList2.add(guiCommandFactory.createCommand(commandList));
        if (!commandCallback.createKeyBinding(perCharacterBinding, commandList2)) {
            drawInfoError("Cannot use bind -c since no character is logged in.");
            //noinspection UnnecessaryReturnStatement
            return;
        }
    }
 
    @NotNull
    @Override
    public String getHelp() {
        //noinspection StringBufferReplaceableByString
        final StringBuilder sb = new StringBuilder();
        sb.append("Binds a command to a key\n");
        sb.append("\n");
        sb.append("Usage: bind <command>\n");
        sb.append("Usage: bind -c <command>\n");
        sb.append("\n");
        sb.append("Asks the user for a key, then associates the given <command> with that key.\n");
        sb.append("If the option -c is used, the command is associated only with the current character. ");
        sb.append("Otherwise the command is associated with all characters on all Crossfire servers.\n");
        sb.append("The ESC key cannot be bound. Its fixed function is to cancel an action.\n");
        sb.append("Note: Unbind a key: unbind\n");
        return sb.toString();
    }
 
}