Generic ICellInventoryHandler (#3624)

Allows addons who register a custom IStorageChannel to use the IStorageCell interface without registering a cell handler. Also adds some helpers (poweredInsert/poweredExtract).
This breaks API!

src/api/java/appeng/api/IAppEngApi.java

@@ -30,6 +30,7 @@ import appeng.api.networking.IGridHelper;
 import appeng.api.networking.IGridNode;
 import appeng.api.parts.IPartHelper;
 import appeng.api.storage.IStorageHelper;
+import appeng.api.util.IClientHelper;
 
 
 @AEInjectable
@@ -60,4 +61,9 @@ public interface IAppEngApi
 	 */
 	IDefinitions definitions();
 
+	/**
+	 * @return Utility methods primarily useful for client side stuff
+	 */
+	IClientHelper client();
+
 }

src/api/java/appeng/api/storage/ICellGuiHandler.java

@@ -0,0 +1,47 @@
+
+package appeng.api.storage;
+
+
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.item.ItemStack;
+
+import appeng.api.implementations.tiles.IChestOrDrive;
+import appeng.api.storage.data.IAEStack;
+
+
+public interface ICellGuiHandler
+{
+	/**
+	 * Return true if this handler can show GUI for this channel.
+	 * 
+	 * @param channel Storage channel
+	 * @return True if handled, else false.
+	 */
+	<T extends IAEStack<T>> boolean isHandlerFor( IStorageChannel<T> channel );
+
+	/**
+	 * Return true to prioritize this handler for the provided {@link ItemStack}.
+	 * 
+	 * @param is Cell ItemStack
+	 * @return True, if specialized else false.
+	 */
+	default boolean isSpecializedFor( ItemStack is )
+	{
+		return false;
+	}
+
+	/**
+	 * Called when the storage cell is placed in an ME Chest and the user tries to open the terminal side, if your item
+	 * is not available via ME Chests simply tell the user they can't use it, or something, other wise you should open
+	 * your gui and display the cell to the user.
+	 *
+	 * @param player player opening chest gui
+	 * @param chest to be opened chest
+	 * @param cellHandler cell handler
+	 * @param inv inventory handler
+	 * @param is item
+	 * @param chan storage channel
+	 */
+	<T extends IAEStack<T>> void openChestGui( EntityPlayer player, IChestOrDrive chest, ICellHandler cellHandler, IMEInventoryHandler<T> inv, ItemStack is, IStorageChannel<T> chan );
+
+}

src/api/java/appeng/api/storage/ICellHandler.java

@@ -24,10 +24,8 @@
 package appeng.api.storage;
 
 
-import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.item.ItemStack;
 
-import appeng.api.implementations.tiles.IChestOrDrive;
 import appeng.api.storage.data.IAEStack;
 
 
@@ -59,20 +57,6 @@ public interface ICellHandler
 	 */
 	<T extends IAEStack<T>> ICellInventoryHandler<T> getCellInventory( ItemStack is, ISaveProvider host, IStorageChannel<T> channel );
 
-	/**
-	 * Called when the storage cell is planed in an ME Chest and the user tries to open the terminal side, if your item
-	 * is not available via ME Chests simply tell the user they can't use it, or something, other wise you should open
-	 * your gui and display the cell to the user.
-	 *
-	 * @param player player opening chest gui
-	 * @param chest to be opened chest
-	 * @param cellHandler cell handler
-	 * @param inv inventory handler
-	 * @param is item
-	 * @param chan storage channel
-	 */
-	<T extends IAEStack<T>> void openChestGui( EntityPlayer player, IChestOrDrive chest, ICellHandler cellHandler, IMEInventoryHandler<T> inv, ItemStack is, IStorageChannel<T> chan );
-
 	/**
 	 * 0 - cell is missing.
 	 *
@@ -87,10 +71,31 @@ public interface ICellHandler
 	 *
 	 * @return get the status of the cell based on its contents.
 	 */
-	<T extends IAEStack<T>> int getStatusForCell( ItemStack is, IMEInventory<T> handler );
+	default <T extends IAEStack<T>> int getStatusForCell( ItemStack is, ICellInventoryHandler<T> handler )
+	{
+		if( handler.getCellInv() != null )
+		{
+			int val = handler.getCellInv().getStatusForCell();
+
+			if( val == 1 && handler.isPreformatted() )
+			{
+				val = 2;
+			}
+
+			return val;
+		}
+		return 0;
+	}
 
 	/**
 	 * @return the ae/t to drain for this storage cell inside a chest/drive.
 	 */
-	<T extends IAEStack<T>> double cellIdleDrain( ItemStack is, IMEInventory<T> handler );
+	default <T extends IAEStack<T>> double cellIdleDrain( ItemStack is, ICellInventoryHandler<T> handler )
+	{
+		if( handler.getCellInv() != null )
+		{
+			return handler.getCellInv().getIdleDrain();
+		}
+		return 1.0;
+	}
 }

src/api/java/appeng/api/storage/ICellInventory.java

@@ -40,7 +40,7 @@ public interface ICellInventory<T extends IAEStack<T>> extends IMEInventory<T>
 	ItemStack getItemStack();
 
 	/**
-	 * @return idle cost for this Storage Cell
+	 * @return the ae/t to drain for this storage cell inside a chest/drive.
 	 */
 	double getIdleDrain();
 
@@ -115,7 +115,15 @@ public interface ICellInventory<T extends IAEStack<T>> extends IMEInventory<T>
 	int getUnusedItemCount();
 
 	/**
-	 * @return the status number for this drive.
+	 * 0 - cell is missing.
+	 *
+	 * 1 - green, ( usually means available room for types or items. )
+	 *
+	 * 2 - orange, ( usually means available room for items, but not types. )
+	 *
+	 * 3 - red, ( usually means the cell is 100% full )
+	 *
+	 * @return get the status of the cell based on its contents.
 	 */
 	int getStatusForCell();
 

src/api/java/appeng/api/storage/ICellInventoryHandler.java

@@ -24,6 +24,8 @@
 package appeng.api.storage;
 
 
+import javax.annotation.Nullable;
+
 import appeng.api.config.IncludeExclude;
 import appeng.api.storage.data.IAEStack;
 
@@ -32,8 +34,11 @@ public interface ICellInventoryHandler<T extends IAEStack<T>> extends IMEInvento
 {
 
 	/**
+	 * Get access to the ICellInventory. Can be null for custom cells.
+	 * 
 	 * @return get access to the Cell Inventory.
 	 */
+	@Nullable
 	ICellInventory<T> getCellInv();
 
 	boolean isPreformatted();

src/api/java/appeng/api/storage/ICellRegistry.java

@@ -53,6 +53,13 @@ public interface ICellRegistry
 	 */
 	void addCellHandler( @Nonnull ICellHandler handler );
 
+	/**
+	 * Register a new handler
+	 * 
+	 * @param handler cell gui handler
+	 */
+	void addCellGuiHandler( @Nonnull ICellGuiHandler handler );
+
 	/**
 	 * return true, if you can get a InventoryHandler for the item passed.
 	 *
@@ -64,7 +71,7 @@ public interface ICellRegistry
 	boolean isCellHandled( ItemStack is );
 
 	/**
-	 * get the handler, for the requested type.
+	 * get the handler, for the requested item.
 	 *
 	 * @param is to be checked item
 	 *
@@ -74,13 +81,23 @@ public interface ICellRegistry
 	ICellHandler getHandler( ItemStack is );
 
 	/**
-	 * returns an IMEInventoryHandler for the provided item.
+	 * get the handler, for the requested channel.
+	 *
+	 * @param channel requested channel
+	 * @param Cell ItemStack
+	 * @return the handler registered for this channel.
+	 */
+	@Nullable
+	<T extends IAEStack<T>> ICellGuiHandler getGuiHandler( IStorageChannel<T> channel, ItemStack is );
+
+	/**
+	 * returns an ICellInventoryHandler for the provided item by querying all registered handlers.
 	 *
 	 * @param is item with inventory handler
 	 * @param host can be null. If provided, the host is responsible for persisting the cell content.
 	 * @param chan the storage channel to request the handler for.
 	 *
-	 * @return new IMEInventoryHandler, or null if there isn't one.
+	 * @return new ICellInventoryHandler, or null if there isn't one.
 	 */
 	@Nullable
 	<T extends IAEStack<T>> ICellInventoryHandler<T> getCellInventory( ItemStack is, ISaveProvider host, IStorageChannel<T> chan );

src/api/java/appeng/api/storage/ISaveProvider.java

@@ -24,11 +24,19 @@
 package appeng.api.storage;
 
 
+import javax.annotation.Nullable;
+
+
 /**
  * Tells the cell provider that changes have been made an the cell must be persisted
  *
  */
 public interface ISaveProvider
 {
-	void saveChanges( ICellInventory<?> cellInventory );
+	/**
+	 * Cell has changed and needs to be changed.
+	 * 
+	 * @param cellInventory can be null for custom cells.
+	 */
+	void saveChanges( @Nullable ICellInventory<?> cellInventory );
 }

src/api/java/appeng/api/storage/IStorageChannel.java

@@ -32,10 +32,9 @@ import javax.annotation.Nullable;
 import io.netty.buffer.ByteBuf;
 
 import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraftforge.fluids.FluidStack;
 
-import appeng.api.networking.energy.IEnergySource;
-import appeng.api.networking.security.IActionSource;
-import appeng.api.storage.data.IAEItemStack;
 import appeng.api.storage.data.IAEStack;
 import appeng.api.storage.data.IItemList;
 
@@ -56,6 +55,17 @@ public interface IStorageChannel<T extends IAEStack<T>>
 		return 1;
 	}
 
+	/**
+	 * The number of units (eg item count, or millibuckets) that can be stored per byte in a storage cell.
+	 * Standard value for items is 8, and for fluids it's 8000
+	 *
+	 * @return number of units
+	 */
+	default int getUnitsPerByte()
+	{
+		return 8;
+	}
+
 	/**
 	 * Create a new {@link IItemList} of the specific type.
 	 * 
@@ -68,9 +78,12 @@ public interface IStorageChannel<T extends IAEStack<T>>
 	 * Create a new {@link IAEStack} subtype of the specific object.
 	 * 
 	 * The parameter is unbound to allow a slightly more flexible approach.
-	 * But the general intention is about converting an {@link ItemStack} into the corresponding {@link IAEItemStack}.
+	 * But the general intention is about converting an {@link ItemStack} or {@link FluidStack} into the corresponding
+	 * {@link IAEStack}.
 	 * Another valid case might be to use it instead of {@link IAEStack#copy()}, but this might not be supported by all
 	 * types.
+	 * IAEStacks that use custom items for {@link IAEStack#asItemStackRepresentation()} must also be able to convert
+	 * these.
 	 * 
 	 * @param input The object to turn into an {@link IAEStack}
 	 * @return The converted stack or null
@@ -88,29 +101,11 @@ public interface IStorageChannel<T extends IAEStack<T>>
 	T readFromPacket( @Nonnull ByteBuf input ) throws IOException;
 
 	/**
-	 * use energy from energy, to remove request items from cell, at the request of src.
-	 *
-	 * @param energy to be drained energy source
-	 * @param cell cell of requested items
-	 * @param request requested items
-	 * @param src action source
-	 *
-	 * @return items that successfully extracted.
+	 * create from nbt data
+	 * 
+	 * @param nbt
+	 * @return
 	 */
 	@Nullable
-	T poweredExtraction( @Nonnull IEnergySource energy, @Nonnull IMEInventory<T> cell, @Nonnull T request, @Nonnull IActionSource src );
-
-	/**
-	 * use energy from energy, to inject input items into cell, at the request of src
-	 *
-	 * @param energy to be added energy source
-	 * @param cell injected cell
-	 * @param input to be injected items
-	 * @param src action source
-	 *
-	 * @return items that failed to insert.
-	 */
-	@Nullable
-	T poweredInsert( @Nonnull IEnergySource energy, @Nonnull IMEInventory<T> cell, @Nonnull T input, @Nonnull IActionSource src );
-
+	T createFromNBT( @Nonnull NBTTagCompound nbt );
 }

src/api/java/appeng/api/storage/IStorageHelper.java

@@ -30,8 +30,11 @@ import javax.annotation.Nonnull;
 
 import net.minecraft.nbt.NBTTagCompound;
 
+import appeng.api.config.Actionable;
 import appeng.api.networking.crafting.ICraftingLink;
 import appeng.api.networking.crafting.ICraftingRequester;
+import appeng.api.networking.energy.IEnergySource;
+import appeng.api.networking.security.IActionSource;
 import appeng.api.storage.data.IAEFluidStack;
 import appeng.api.storage.data.IAEItemStack;
 import appeng.api.storage.data.IAEStack;
@@ -90,4 +93,27 @@ public interface IStorageHelper
 	 */
 	ICraftingLink loadCraftingLink( NBTTagCompound data, ICraftingRequester req );
 
+	/**
+	 * Extracts items from a {@link IMEInventory} respecting power requirements.
+	 * 
+	 * @param energy Energy source.
+	 * @param inv Inventory to extract from.
+	 * @param request Requested item and count.
+	 * @param src Action source.
+	 * @param mode Simulate or modulate
+	 * @return extracted items or {@code null} of nothing was extracted.
+	 */
+	<T extends IAEStack<T>> T poweredExtraction( final IEnergySource energy, final IMEInventory<T> inv, final T request, final IActionSource src, final Actionable mode );
+
+	/**
+	 * Inserts items into a {@link IMEInventory} respecting power requirements.
+	 * 
+	 * @param energy Energy source.
+	 * @param inv Inventory to insert into.
+	 * @param request Items to insert.
+	 * @param src Action source.
+	 * @param mode Simulate or modulate
+	 * @return items not inserted or {@code null} if everything was inserted.
+	 */
+	<T extends IAEStack<T>> T poweredInsert( final IEnergySource energy, final IMEInventory<T> inv, final T input, final IActionSource src, final Actionable mode );
 }

src/api/java/appeng/api/util/IClientHelper.java

@@ -0,0 +1,21 @@
+
+package appeng.api.util;
+
+
+import java.util.List;
+
+import appeng.api.storage.ICellInventoryHandler;
+import appeng.api.storage.data.IAEStack;
+
+
+public interface IClientHelper
+{
+	/**
+	 * Add cell information to the provided list. Used for tooltip content.
+	 * 
+	 * @param handler Cell handler.
+	 * @param lines List of lines to add to.
+	 */
+	<T extends IAEStack<T>> void addCellInformation( ICellInventoryHandler<T> handler, List<String> lines );
+
+}