ItemSet.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.items;
 
import com.realtime.crossfire.jxclient.faces.Face;
import com.realtime.crossfire.jxclient.protocol.UpdItem;
import com.realtime.crossfire.jxclient.util.EventListenerList2;
import com.realtime.crossfire.jxclient.util.HashedEventListenerList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.concurrent.CopyOnWriteArrayList;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class ItemSet {
 
    @NotNull
    private final Map<Integer, CfItem> allItems = new HashMap<>();
 
    @NotNull
    private final Map<Integer, List<CfItem>> items = new HashMap<>();
 
    @NotNull
    private final Object sync = new Object();
 
    @Nullable
    private CfItem player;
 
    private int openContainerFloor;
 
    @NotNull
    private final EventListenerList2<ItemSetListener> itemSetListeners = new EventListenerList2<>();
 
    @NotNull
    private final HashedEventListenerList<ItemListener> itemListeners = new HashedEventListenerList<>();
 
    public void addItemSetListener(@NotNull final ItemSetListener listener) {
        itemSetListeners.add(listener);
    }
 
    public void removeItemSetListener(@NotNull final ItemSetListener listener) {
        itemSetListeners.remove(listener);
    }
 
    public void addInventoryListener(final int tag, @NotNull final ItemListener listener) {
        itemListeners.add(tag, listener);
    }
 
    public void removeInventoryListener(final int tag, @NotNull final ItemListener listener) {
        itemListeners.remove(tag, listener);
    }
 
    @NotNull
    public List<CfItem> getItemsByLocation(final int location) {
        synchronized (sync) {
            final List<CfItem> result = items.get(location);
            if (result == null) {
                return Collections.emptyList();
            }
            return Collections.unmodifiableList(result);
        }
    }
 
    public int getNumberOfItemsByLocation(final int location) {
        synchronized (sync) {
            final Collection<CfItem> result = items.get(location);
            return result == null ? 0 : result.size();
        }
    }
 
    private int removeItemByTag(final int tag) {
        final int where;
        final int index;
        synchronized (sync) {
            final CfItem item = allItems.remove(tag);
            if (item == null) {
                return -1;
            }
 
            where = item.getLocation();
            final List<CfItem> list = items.get(where);
            if (list == null) {
                throw new AssertionError("cannot find item "+item.getTag());
            }
 
            index = list.indexOf(item);
            if (list.remove(index) == null) {
                throw new AssertionError("cannot find item "+item.getTag());
            }
 
            if (list.isEmpty() && items.remove(item.getLocation()) != list) {
                throw new AssertionError();
            }
        }
 
        for (ItemListener itemListener : itemListeners.getListeners(where)) {
            itemListener.inventoryRemoved(where, index);
        }
 
        for (ItemListener itemListener : itemListeners.getListeners(tag)) {
            itemListener.itemRemoved(tag);
        }
 
        return index;
    }
 
    public void removeItems(final int @NotNull [] tags) {
        for (int tag : tags) {
            if (removeItemByTag(tag) == -1) {
                System.err.println("removeItem3: item "+tag+" does not exist");
            }
        }
    }
 
    public void addItem(@NotNull final CfItem item) {
        removeItemByTag(item.getTag());
        final int index;
        final int where;
        synchronized (sync) {
            if (allItems.put(item.getTag(), item) != null) {
                throw new AssertionError("duplicate item "+item.getTag());
            }
 
            where = item.getLocation();
            List<CfItem> list = items.get(where);
            if (list == null) {
                list = new CopyOnWriteArrayList<>();
                if (items.put(where, list) != null) {
                    throw new AssertionError();
                }
            }
 
            list.add(item);
            index = list.size()-1;
        }
 
        for (ItemListener itemListener : itemListeners.getListeners(where)) {
            itemListener.inventoryAdded(where, index, item);
        }
    }
 
    @NotNull
    private List<CfItem> getInventoryByTag(final int tag) {
        synchronized (sync) {
            final List<CfItem> inventory = items.get(tag);
            if (inventory == null) {
                return Collections.emptyList();
            }
            return Collections.unmodifiableList(inventory);
        }
    }
 
    @Nullable
    public CfItem getItemByTag(final int tag) {
        synchronized (sync) {
            return allItems.get(tag);
        }
    }
 
    @Nullable
    public CfItem getPlayer() {
        synchronized (sync) {
            return player;
        }
    }
 
    public void setPlayer(@Nullable final CfItem player) {
        synchronized (sync) {
            if (this.player == player) {
                return;
            }
 
            this.player = player;
        }
 
        for (ItemSetListener listener : itemSetListeners) {
            listener.playerChanged(player);
        }
    }
 
    @NotNull
    public Iterable<CfItem> getPlayerInventory() {
        synchronized (sync) {
            return player == null ? Collections.emptyList() : getInventoryByTag(player.getTag());
        }
    }
 
    @Nullable
    private CfItem getItemOrPlayer(final int tag) {
        synchronized (sync) {
            if (player != null && player.getTag() == tag) {
                return player;
            }
 
            return allItems.get(tag);
        }
    }
 
    public void cleanInventory(final int tag) {
        final List<CfItem> inventoryItems = getItemsByLocation(tag);
        final ListIterator<CfItem> it = inventoryItems.listIterator(inventoryItems.size());
        while (it.hasPrevious()) {
            final CfItem item = it.previous();
            removeItemByTag(item.getTag());
        }
    }
 
    public void updateItem(final int flags, final int tag, final int valLocation, final int valFlags, final int valWeight, @NotNull final Face valFace, @NotNull final String valName, @NotNull final String valNamePl, final int valAnim, final int valAnimSpeed, final int valNrof) {
        final CfItem item = getItemOrPlayer(tag);
        if (item == null) {
            //System.err.println("updateItem: undefined item "+tag); // XXX: this is a server bug
            return;
        }
 
        final boolean wasOpen;
        final boolean clearMarked;
        synchronized (sync) {
            wasOpen = (flags&UpdItem.UPD_FLAGS) != 0 && openContainerFloor == item.getTag() && item.isOpen();
            clearMarked = (flags&UpdItem.UPD_LOCATION) != 0 && (player == null || valLocation != player.getTag());
        }
        item.update(flags, valFlags, valWeight, valFace, valName, valNamePl, valAnim, valAnimSpeed, valNrof, clearMarked);
        if ((flags&UpdItem.UPD_LOCATION) != 0 && item.getLocation() != valLocation) {
            removeItemByTag(item.getTag());
            item.setLocation(valLocation);
            addItem(item);
        }
 
        if ((flags&~UpdItem.UPD_LOCATION) != 0) {
            for (ItemListener itemListener : itemListeners.getListeners(tag)) {
                itemListener.itemChanged(tag);
            }
        }
        if ((flags&UpdItem.UPD_FLAGS) != 0) {
            if (item.isOpen()) {
                setOpenContainer(item.getTag());
            } else if (wasOpen) {
                setOpenContainer(0);
            }
        }
    }
 
    public void reset() {
        final int playerTag;
        synchronized (sync) {
            playerTag = player == null ? -1 : player.getTag();
        }
        if (playerTag != -1) {
            cleanInventory(playerTag);
        }
        final Iterable<CfItem> tmp;
        synchronized (sync) {
            tmp = new HashSet<>(allItems.values());
        }
        for (CfItem item : tmp) {
            removeItemByTag(item.getTag());
        }
        setOpenContainer(0);
        setPlayer(null);
    }
 
    private void setOpenContainer(final int openContainerFloor) {
        synchronized (sync) {
            if (this.openContainerFloor == openContainerFloor) {
                return;
            }
 
            this.openContainerFloor = openContainerFloor;
        }
 
        for (ItemSetListener listener : itemSetListeners) {
            listener.openContainerChanged(openContainerFloor);
        }
    }
 
    public int getOpenContainer() {
        synchronized (sync) {
            return openContainerFloor;
        }
    }
 
    @Nullable
    public CfItem getInventoryItem(final int tag, final int index) {
        final List<CfItem> inventoryItems = getInventoryByTag(tag);
        try {
            return 0 <= index && index < inventoryItems.size() ? inventoryItems.get(index) : null;
        } catch (final ArrayIndexOutOfBoundsException ignored) {
            return null;
        }
    }
 
    public void setMarkedItemTag(final int markedItemTag) {
        final List<CfItem> inventory;
        synchronized (sync) {
            if (player == null) {
                return;
            }
 
            inventory = items.get(player.getTag());
            if (inventory == null) {
                return;
            }
        }
 
        for (final CfItem item : inventory) {
            item.setMarked(item.getTag() == markedItemTag);
        }
    }
 
}