Shortcuts.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.shortcuts;

import com.realtime.crossfire.jxclient.queue.CommandQueue;
import com.realtime.crossfire.jxclient.spells.Spell;
import com.realtime.crossfire.jxclient.spells.SpellsManager;
import com.realtime.crossfire.jxclient.util.EventListenerList2;
import java.io.File;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class Shortcuts implements Iterable<Shortcut> {

    @NotNull
    private final List<Shortcut> shortcuts = new ArrayList<>();

    private boolean modified;

    @Nullable
    private File file;

    @NotNull
    private final EventListenerList2<ShortcutsListener> listeners = new EventListenerList2<>();

    @NotNull
    private final CommandQueue commandQueue;

    @NotNull
    private final SpellsManager spellsManager;

    public Shortcuts(@NotNull final CommandQueue commandQueue, @NotNull final SpellsManager spellsManager) {
        this.commandQueue = commandQueue;
        this.spellsManager = spellsManager;
    }

    public void clearShortcuts() {
        if (shortcuts.isEmpty()) {
            return;
        }

        for (int i = 0; i < shortcuts.size(); i++) {
            final Shortcut shortcut = shortcuts.get(i);
            if (shortcut != null) {
                for (final ShortcutsListener listener : listeners) {
                    listener.shortcutRemoved(i, shortcut);
                }
                shortcut.dispose();
            }
        }
        shortcuts.clear();
        modified = true;
    }

    @Nullable
    private Shortcut getShortcut(final int index) {
        try {
            return shortcuts.get(index);
        } catch (final IndexOutOfBoundsException ignored) {
            return null;
        }
    }

    public void setShortcut(final int index, @Nullable final Shortcut shortcut) {
        while (shortcuts.size() <= index) {
            shortcuts.add(null);
        }

        final Shortcut oldShortcut = shortcuts.get(index);
        if (oldShortcut != null) {
            for (final ShortcutsListener listener : listeners) {
                listener.shortcutRemoved(index, oldShortcut);
            }
            oldShortcut.dispose();
        }
        shortcuts.set(index, shortcut);
        modified = true;
        if (shortcut != null) {
            for (final ShortcutsListener listener : listeners) {
                listener.shortcutAdded(index, shortcut);
            }
        }
    }

    public void unsetShortcut(final int index) {
        setShortcut(index, null);
    }

    public void setSpellShortcut(final int index, @NotNull final String spellName, final boolean cast) {
        final Spell spell = spellsManager.getSpell(spellName);
        setSpellShortcut(index, spell, cast);
    }

    public void setSpellShortcut(final int index, @NotNull final Spell spell, final boolean cast) {
        final ShortcutSpell shortcutSpell = new ShortcutSpell(commandQueue, spell);
        shortcutSpell.setCast(cast);
        setShortcut(index, shortcutSpell);
    }

    public void setCommandShortcut(final int index, @NotNull final String command) {
        if (command.length() <= 0) {
            System.err.println("shortcut: ignoring empty command");
            return;
        }

        if (command.contains("\n")) {
            System.err.println("shortcut: ignoring multi-line command");
            return;
        }

        final Shortcut shortcutCommand = new ShortcutCommand(commandQueue, command);
        setShortcut(index, shortcutCommand);
    }

    public void executeShortcut(final int index) {
        final Shortcut shortcut = getShortcut(index);
        if (shortcut != null) {
            shortcut.execute();
        }
    }

    public void addShortcutsListener(@NotNull final ShortcutsListener listener) {
        listeners.add(listener);
    }

    public void removeShortcutsListener(@NotNull final ShortcutsListener listener) {
        listeners.remove(listener);
    }

    public boolean isModified() {
        return modified;
    }

    public void resetModified() {
        modified = false;
    }

    @Nullable
    public File getFile() {
        return file;
    }

    public void setFile(@Nullable final File file) {
        this.file = file;
    }

    @Override
    public Iterator<Shortcut> iterator() {
        return shortcuts.iterator();
    }

}