Add a Bookmarks list to the left side of the screen (mezz#1408)

.gitignore

@@ -23,3 +23,8 @@ build/*
 changelog.html
 /classes
 /logs
+/build/
+\.classpath
+\.project
+\.settings/
+*.launch

src/main/java/mezz/jei/Internal.java

@@ -3,6 +3,8 @@
 import javax.annotation.Nullable;
 
 import com.google.common.base.Preconditions;
+
+import mezz.jei.bookmarks.BookmarkList;
 import mezz.jei.color.ColorNamer;
 import mezz.jei.gui.GuiEventHandler;
 import mezz.jei.ingredients.IngredientFilter;
@@ -33,6 +35,8 @@ public final class Internal {
 	private static GuiEventHandler guiEventHandler;
 	@Nullable
 	private static InputHandler inputHandler;
+	@Nullable
+	private static BookmarkList bookmarkList;
 
 	private Internal() {
 
@@ -117,4 +121,14 @@ public static void setInputHandler(InputHandler inputHandler) {
 		Internal.inputHandler = inputHandler;
 		MinecraftForge.EVENT_BUS.register(inputHandler);
 	}
+
+	public static BookmarkList getBookmarkList() {
+		Preconditions.checkState(bookmarkList != null, "BookmarkList has not been created yet.");
+		return bookmarkList;
+	}
+
+	public static void setBookmarkList(BookmarkList bookmarkList) {
+		Internal.bookmarkList = bookmarkList;
+	}
+
 }

src/main/java/mezz/jei/bookmarks/BookmarkList.java

@@ -0,0 +1,222 @@
+package mezz.jei.bookmarks;
+
+import mezz.jei.api.ingredients.IIngredientHelper;
+import mezz.jei.api.ingredients.VanillaTypes;
+import mezz.jei.api.recipe.IIngredientType;
+import mezz.jei.config.Config;
+import mezz.jei.gui.ingredients.IIngredientListElement;
+import mezz.jei.gui.overlay.IIngredientGridSource;
+import mezz.jei.ingredients.IngredientListElementFactory;
+import mezz.jei.ingredients.IngredientRegistry;
+import mezz.jei.startup.ForgeModIdHelper;
+import mezz.jei.util.LegacyUtil;
+import mezz.jei.util.Log;
+import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.JsonToNBT;
+import net.minecraft.nbt.NBTException;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraftforge.fluids.FluidStack;
+import org.apache.commons.io.IOUtils;
+
+import javax.annotation.Nullable;
+import java.io.File;
+import java.io.FileReader;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.LinkedList;
+import java.util.List;
+
+public class BookmarkList implements IIngredientGridSource {
+
+	private static final String MARKER_OTHER = "O:";
+	private static final String MARKER_STACK = "T:";
+
+	private final List<Object> list = new LinkedList<>();
+	private final List<IIngredientListElement> ingredientListElements = new LinkedList<>();
+	private final IngredientRegistry ingredientRegistry;
+	private final List<IIngredientGridSource.Listener> listeners = new ArrayList<>();
+
+	public BookmarkList(IngredientRegistry ingredientRegistry) {
+		this.ingredientRegistry = ingredientRegistry;
+	}
+
+	public <T> boolean add(T ingredient) {
+		Object normalized = normalize(ingredient);
+		if (!contains(normalized)) {
+			if (addToLists(normalized, true)) {
+				notifyListenersOfChange();
+				saveBookmarks();
+				return true;
+			}
+		}
+		return false;
+	}
+
+	protected <T> T normalize(T ingredient) {
+		IIngredientHelper<T> ingredientHelper = ingredientRegistry.getIngredientHelper(ingredient);
+		T copy = LegacyUtil.getIngredientCopy(ingredient, ingredientHelper);
+		if (copy instanceof ItemStack) {
+			((ItemStack) copy).setCount(1);
+		} else if (copy instanceof FluidStack) {
+			((FluidStack) copy).amount = 1000;
+		}
+		return copy;
+	}
+
+	private boolean contains(Object ingredient) {
+		// We cannot assume that ingredients have a working equals() implementation. Even ItemStack doesn't have one...
+		IIngredientHelper<Object> ingredientHelper = ingredientRegistry.getIngredientHelper(ingredient);
+		for (Object existing : list) {
+			if (ingredient == existing) {
+				return true;
+			}
+			if (existing != null && existing.getClass() == ingredient.getClass()) {
+				if (ingredientHelper.getUniqueId(existing).equals(ingredientHelper.getUniqueId(ingredient))) {
+					return true;
+				}
+			}
+		}
+		return false;
+	}
+
+	public boolean remove(Object ingredient) {
+		int index = 0;
+		for (Object existing : list) {
+			if (ingredient == existing) {
+				list.remove(index);
+				ingredientListElements.remove(index);
+				notifyListenersOfChange();
+				saveBookmarks();
+				return true;
+			}
+			index++;
+		}
+		return false;
+	}
+
+	public void saveBookmarks() {
+		List<String> strings = new ArrayList<>();
+		for (IIngredientListElement<?> element : ingredientListElements) {
+			Object object = element.getIngredient();
+			if (object instanceof ItemStack) {
+				strings.add(MARKER_STACK + ((ItemStack) object).writeToNBT(new NBTTagCompound()).toString());
+			} else {
+				strings.add(MARKER_OTHER + getUid(element));
+			}
+		}
+		File file = Config.getBookmarkFile();
+		if (file != null) {
+			try (FileWriter writer = new FileWriter(file)) {
+				IOUtils.writeLines(strings, "\n", writer);
+			} catch (IOException e) {
+				Log.get().error("Failed to save bookmarks list to file {}", file, e);
+			}
+		}
+	}
+
+	private static <T> String getUid(IIngredientListElement<T> element) {
+		IIngredientHelper<T> ingredientHelper = element.getIngredientHelper();
+		return ingredientHelper.getUniqueId(element.getIngredient());
+	}
+
+	public void loadBookmarks() {
+		File file = Config.getBookmarkFile();
+		if (file == null || !file.exists()) {
+			return;
+		}
+		List<String> ingredientJsonStrings;
+		try (FileReader reader = new FileReader(file)) {
+			ingredientJsonStrings = IOUtils.readLines(reader);
+		} catch (IOException e) {
+			Log.get().error("Failed to load bookmarks from file {}", file, e);
+			return;
+		}
+
+		Collection<IIngredientType> otherIngredientTypes = new ArrayList<>(ingredientRegistry.getRegisteredIngredientTypes());
+		otherIngredientTypes.remove(VanillaTypes.ITEM);
+
+		list.clear();
+		ingredientListElements.clear();
+		for (String ingredientJsonString : ingredientJsonStrings) {
+			if (ingredientJsonString.startsWith(MARKER_STACK)) {
+				String itemStackAsJson = ingredientJsonString.substring(MARKER_STACK.length());
+				try {
+					NBTTagCompound itemStackAsNbt = JsonToNBT.getTagFromJson(itemStackAsJson);
+					ItemStack itemStack = new ItemStack(itemStackAsNbt);
+					if (!itemStack.isEmpty()) {
+						ItemStack normalized = normalize(itemStack);
+						addToLists(normalized, false);
+					} else {
+						Log.get().warn("Failed to load bookmarked ItemStack from json string, the item no longer exists:\n{}", itemStackAsJson);
+					}
+				} catch (NBTException e) {
+					Log.get().error("Failed to load bookmarked ItemStack from json string:\n{}", itemStackAsJson, e);
+				}
+			} else if (ingredientJsonString.startsWith(MARKER_OTHER)) {
+				String uid = ingredientJsonString.substring(MARKER_OTHER.length());
+				Object ingredient = getUnknownIngredientByUid(otherIngredientTypes, uid);
+				if (ingredient != null) {
+					Object normalized = normalize(ingredient);
+					addToLists(normalized, false);
+				}
+			} else {
+				Log.get().error("Failed to load unknown bookmarked ingredient:\n{}", ingredientJsonString);
+			}
+		}
+		notifyListenersOfChange();
+	}
+
+	@Nullable
+	private Object getUnknownIngredientByUid(Collection<IIngredientType> ingredientTypes, String uid) {
+		for (IIngredientType<?> ingredientType : ingredientTypes) {
+			Object ingredient = ingredientRegistry.getIngredientByUid(ingredientType, uid);
+			if (ingredient != null) {
+				return ingredient;
+			}
+		}
+		return null;
+	}
+
+	private <T> boolean addToLists(T ingredient, boolean addToFront) {
+		IIngredientType<T> ingredientType = ingredientRegistry.getIngredientType(ingredient);
+		IIngredientListElement<T> element = IngredientListElementFactory.createUnorderedElement(ingredientRegistry, ingredientType, ingredient, ForgeModIdHelper.getInstance());
+		if (element != null) {
+			if (addToFront) {
+				list.add(0, ingredient);
+				ingredientListElements.add(0, element);
+			} else {
+				list.add(ingredient);
+				ingredientListElements.add(element);
+			}
+			return true;
+		}
+		return false;
+	}
+
+	@Override
+	public List<IIngredientListElement> getIngredientList() {
+		return ingredientListElements;
+	}
+
+	@Override
+	public int size() {
+		return ingredientListElements.size();
+	}
+
+	public boolean isEmpty() {
+		return ingredientListElements.isEmpty();
+	}
+
+	@Override
+	public void addListener(IIngredientGridSource.Listener listener) {
+		listeners.add(listener);
+	}
+
+	private void notifyListenersOfChange() {
+		for (IIngredientGridSource.Listener listener : listeners) {
+			listener.onChange();
+		}
+	}
+}

src/main/java/mezz/jei/bookmarks/package-info.java

@@ -0,0 +1,9 @@
+@ParametersAreNonnullByDefault
+@FieldsAreNonnullByDefault
+@MethodsReturnNonnullByDefault
+package mezz.jei.bookmarks;
+
+import mcp.MethodsReturnNonnullByDefault;
+import mezz.jei.util.FieldsAreNonnullByDefault;
+
+import javax.annotation.ParametersAreNonnullByDefault;

src/main/java/mezz/jei/collect/package-info.java

@@ -0,0 +1,9 @@
+@ParametersAreNonnullByDefault
+@FieldsAreNonnullByDefault
+@MethodsReturnNonnullByDefault
+package mezz.jei.collect;
+
+import mcp.MethodsReturnNonnullByDefault;
+import mezz.jei.util.FieldsAreNonnullByDefault;
+
+import javax.annotation.ParametersAreNonnullByDefault;

src/main/java/mezz/jei/config/BookmarkOverlayToggleEvent.java

@@ -0,0 +1,15 @@
+package mezz.jei.config;
+
+import net.minecraftforge.fml.common.eventhandler.Event;
+
+public class BookmarkOverlayToggleEvent extends Event {
+	private final boolean bookmarkOverlayEnabled;
+
+	public BookmarkOverlayToggleEvent(boolean bookmarkOverlayEnabled) {
+		this.bookmarkOverlayEnabled = bookmarkOverlayEnabled;
+	}
+
+	public boolean isBookmarkOverlayEnabled() {
+		return bookmarkOverlayEnabled;
+	}
+}