Simplify tooltip handling and allow modifying rich tooltips

Author: mezz

Common/src/main/java/mezz/jei/common/gui/JeiTooltip.java

@@ -94,11 +94,15 @@ public void addAll(Collection<? extends FormattedText> components) {
 	}
 
 	@Override
-	public void clear() {
-		this.lines.clear();
+	public void clearIngredient() {
 		this.typedIngredient = null;
 	}
 
+	@Override
+	public List<Either<FormattedText, TooltipComponent>> getLines() {
+		return lines;
+	}
+
 	public void addAll(JeiTooltip tooltip) {
 		lines.addAll(tooltip.lines);
 	}
@@ -107,9 +111,8 @@ public boolean isEmpty() {
 		return lines.isEmpty() && typedIngredient == null;
 	}
 
-	@SuppressWarnings("removal")
-	@Override
-	public List<Component> toLegacyToComponents() {
+	@Deprecated
+	public List<Component> getLegacyComponents() {
 		return lines.stream()
 			.<Component>mapMulti((e, consumer) -> {
 				e.left().ifPresent(f -> {
@@ -123,6 +126,14 @@ public List<Component> toLegacyToComponents() {
 
 	@SuppressWarnings("removal")
 	@Override
+	@Deprecated
+	public List<Component> toLegacyToComponents() {
+		return getLegacyComponents();
+	}
+
+	@SuppressWarnings("removal")
+	@Override
+	@Deprecated
 	public void removeAll(List<Component> components) {
 		for (Component component : components) {
 			lines.remove(Either.left(component));

Common/src/main/java/mezz/jei/common/platform/IPlatformFluidHelperInternal.java

@@ -10,6 +10,7 @@
 import net.minecraft.network.chat.Component;
 import net.minecraft.world.item.TooltipFlag;
 
+import java.util.List;
 import java.util.Optional;
 
 public interface IPlatformFluidHelperInternal<T> extends IPlatformFluidHelper<T> {
@@ -26,7 +27,7 @@ public interface IPlatformFluidHelperInternal<T> extends IPlatformFluidHelper<T>
 
 	DataComponentPatch getComponentsPatch(T ingredient);
 
-	void getTooltip(ITooltipBuilder tooltip, T ingredient, TooltipFlag tooltipFlag);
+	void getTooltip(List<Component> tooltip, T ingredient, TooltipFlag tooltipFlag);
 
 	T copy(T ingredient);
 

Common/src/main/java/mezz/jei/common/util/SafeIngredientUtil.java

@@ -20,6 +20,7 @@
 import net.minecraft.world.item.TooltipFlag;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.jetbrains.annotations.Unmodifiable;
 
 import java.util.HashSet;
 import java.util.List;
@@ -34,14 +35,14 @@ public final class SafeIngredientUtil {
 	private SafeIngredientUtil() {
 	}
 
-	public static <T> void getTooltip(ITooltipBuilder tooltip, IIngredientManager ingredientManager, IIngredientRenderer<T> ingredientRenderer, ITypedIngredient<T> typedIngredient) {
+	public static <T> void getRichTooltip(ITooltipBuilder tooltip, IIngredientManager ingredientManager, IIngredientRenderer<T> ingredientRenderer, ITypedIngredient<T> typedIngredient) {
 		Minecraft minecraft = Minecraft.getInstance();
 		TooltipFlag.Default tooltipFlag = minecraft.options.advancedItemTooltips ? TooltipFlag.Default.ADVANCED : TooltipFlag.Default.NORMAL;
 		tooltipFlag = tooltipFlag.asCreative();
-		getTooltip(tooltip, ingredientManager, ingredientRenderer, typedIngredient, tooltipFlag);
+		getRichTooltip(tooltip, ingredientManager, ingredientRenderer, typedIngredient, tooltipFlag);
 	}
 
-	public static <T> void getTooltip(
+	public static <T> void getRichTooltip(
 		ITooltipBuilder tooltip,
 		IIngredientManager ingredientManager,
 		IIngredientRenderer<T> ingredientRenderer,
@@ -68,6 +69,28 @@ public static <T> void getTooltip(
 		}
 	}
 
+	@Unmodifiable
+	public static <T> List<Component> getPlainTooltipForSearch(
+		IIngredientManager ingredientManager,
+		IIngredientRenderer<T> ingredientRenderer,
+		ITypedIngredient<T> typedIngredient,
+		TooltipFlag.Default tooltipFlag
+	) {
+		T ingredient = typedIngredient.getIngredient();
+
+		if (CRASHING_INGREDIENT_TOOLTIPS.contains(ingredient)) {
+			return List.of();
+		}
+
+		try {
+			return ingredientRenderer.getTooltip(ingredient, tooltipFlag);
+		} catch (RuntimeException | LinkageError e) {
+			CRASHING_INGREDIENT_TOOLTIPS.add(ingredient);
+			ErrorUtil.logIngredientCrash(e, "Caught an error getting an Ingredient's tooltip", ingredientManager, typedIngredient.getType(), ingredient);
+			return List.of();
+		}
+	}
+
 	private static void getTooltipErrorTooltip(ITooltipBuilder tooltip) {
 		MutableComponent crash = Component.translatable("jei.tooltip.error.crash");
 		tooltip.add(crash.withStyle(ChatFormatting.RED));

CommonApi/src/main/java/mezz/jei/api/gui/builder/ITooltipBuilder.java

@@ -1,5 +1,6 @@
 package mezz.jei.api.gui.builder;
 
+import com.mojang.datafixers.util.Either;
 import mezz.jei.api.ingredients.ITypedIngredient;
 import net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent;
 import net.minecraft.network.chat.Component;
@@ -56,7 +57,27 @@ public interface ITooltipBuilder {
 	 *
 	 * @since 19.16.4
 	 */
-	void clear();
+	default void clear() {
+		clearIngredient();
+		getLines().clear();
+	}
+
+	/**
+	 * Remove the ingredient from this tooltip.
+	 *
+	 * @see #setIngredient(ITypedIngredient)
+	 *
+	 * @since 21.1.0
+	 */
+	void clearIngredient();
+
+	/**
+	 * Get the lines stored by this tooltip builder.
+	 * These lines are directly modifiable.
+	 *
+	 * @since 21.1.0
+	 */
+	List<Either<FormattedText, TooltipComponent>> getLines();
 
 	/**
 	 * @deprecated this is only for legacy tooltip support and will be removed

CommonApi/src/main/java/mezz/jei/api/gui/ingredient/IRecipeSlotDrawable.java

@@ -43,16 +43,27 @@ public interface IRecipeSlotDrawable extends IRecipeSlotView {
 	 * Get the plain tooltip for this recipe slot.
 	 *
 	 * @since 11.5.0
+	 * @deprecated use {@link #drawTooltip}
 	 */
+	@Deprecated(since = "21.1.0", forRemoval = true)
 	List<Component> getTooltip();
 
 	/**
 	 * Get the rich tooltip for this recipe slot.
 	 *
 	 * @since 19.5.4
+	 * @deprecated use {@link #drawTooltip}
 	 */
+	@Deprecated(since = "21.1.0", forRemoval = true)
 	void getTooltip(ITooltipBuilder tooltipBuilder);
 
+	/**
+	 * Draw the tooltip for this recipe slot at the given mouse position.
+	 *
+	 * @since 21.1.0
+	 */
+	void drawTooltip(GuiGraphics guiGraphics, int mouseX, int mouseY);
+
 	/**
 	 * Return true if the mouse is over the slot.
 	 *

CommonApi/src/main/java/mezz/jei/api/gui/ingredient/IRecipeSlotTooltipCallback.java

@@ -24,7 +24,7 @@ public interface IRecipeSlotTooltipCallback {
 	 * Change the tooltip for an ingredient.
 	 *
 	 * @since 9.3.0
-	 * @deprecated in favor of {@link IRecipeSlotRichTooltipCallback}
+	 * @deprecated use {@link IRecipeSlotRichTooltipCallback} instead
 	 */
 	@Deprecated(since = "19.5.4", forRemoval = true)
 	void onTooltip(IRecipeSlotView recipeSlotView, List<Component> tooltip);
@@ -33,7 +33,7 @@ public interface IRecipeSlotTooltipCallback {
 	 * Add to the tooltip for an ingredient.
 	 *
 	 * @since 19.5.4
-	 * @deprecated in favor of {@link IRecipeSlotRichTooltipCallback}
+	 * @deprecated use {@link IRecipeSlotRichTooltipCallback} instead
 	 */
 	@Deprecated(since = "19.8.5", forRemoval = true)
 	@SuppressWarnings({"removal", "DeprecatedIsStillUsed"})

CommonApi/src/main/java/mezz/jei/api/ingredients/IIngredientRenderer.java

@@ -63,15 +63,12 @@ default void renderBatch(GuiGraphics guiGraphics, List<BatchRenderElement<T>> el
 	}
 
 	/**
-	 * Get the tooltip text for this ingredient. JEI renders the tooltip based on this.
+	 * Get the tooltip text for this ingredient. JEI searches tooltips based on this.
 	 *
 	 * @param ingredient  The ingredient to get the tooltip for.
 	 * @param tooltipFlag Whether to show advanced information on item tooltips, toggled by F3+H
 	 * @return The tooltip text for the ingredient.
-	 *
-	 * @deprecated use {@link #getTooltip(ITooltipBuilder, Object, TooltipFlag)}
 	 */
-	@Deprecated(since = "19.5.4", forRemoval = true)
 	List<Component> getTooltip(T ingredient, TooltipFlag tooltipFlag);
 
 	/**

CommonApi/src/main/java/mezz/jei/api/recipe/category/extensions/IRecipeCategoryExtension.java

@@ -29,7 +29,7 @@ public interface IRecipeCategoryExtension<T> {
 	/**
 	 * Draw additional info about the recipe.
 	 * Use the mouse position for things like button highlights.
-	 * Tooltips are handled by {@link #getTooltipStrings(Object, double, double)}
+	 * Tooltips are handled by {@link #getTooltip(ITooltipBuilder, Object, double, double)}
 	 *
 	 * @param mouseX the X position of the mouse, relative to the recipe.
 	 * @param mouseY the Y position of the mouse, relative to the recipe.

Gui/src/main/java/mezz/jei/gui/ingredients/ListElementInfo.java

@@ -9,6 +9,8 @@
 import mezz.jei.common.util.SafeIngredientUtil;
 import mezz.jei.common.util.StringUtil;
 import mezz.jei.common.util.Translator;
+import net.minecraft.network.chat.Component;
+import net.minecraft.network.chat.FormattedText;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.item.CreativeModeTab;
 import net.minecraft.world.item.CreativeModeTabs;
@@ -123,9 +125,8 @@ public final Set<String> getTooltipStrings(IIngredientFilterConfig config, IIngr
 		TooltipFlag.Default tooltipFlag = config.getSearchAdvancedTooltips() ? TooltipFlag.Default.ADVANCED : TooltipFlag.Default.NORMAL;
 		tooltipFlag = tooltipFlag.asCreative();
 
-		ListElementInfoTooltip tooltip = new ListElementInfoTooltip();
-		SafeIngredientUtil.getTooltip(tooltip, ingredientManager, ingredientRenderer, value, tooltipFlag);
-		Set<String> strings = tooltip.getStrings();
+		List<Component> tooltip = SafeIngredientUtil.getPlainTooltipForSearch(ingredientManager, ingredientRenderer, value, tooltipFlag);
+		Set<String> strings = getStrings(tooltip);
 
 		strings.remove(this.names.getFirst());
 		strings.remove(this.modNames.getFirst().toLowerCase(Locale.ENGLISH));
@@ -135,6 +136,20 @@ public final Set<String> getTooltipStrings(IIngredientFilterConfig config, IIngr
 		return strings;
 	}
 
+	public static Set<String> getStrings(@Unmodifiable List<Component> tooltip) {
+		Set<String> result = new HashSet<>();
+		for (FormattedText component : tooltip) {
+			String string = component.getString();
+			string = StringUtil.removeChatFormatting(string);
+			string = Translator.toLowercaseWithLocale(string);
+			// Split tooltip strings into words to keep them from being too long.
+			// Longer strings are more expensive for the suffix tree to handle.
+			String[] strings = string.split(" ");
+			Collections.addAll(result, strings);
+		}
+		return result;
+	}
+
 	@Override
 	public Collection<String> getTagStrings(IIngredientManager ingredientManager) {
 		ITypedIngredient<V> value = element.getTypedIngredient();