Address more getSuggestions deprecations (#3277)

SirYwell · me4502 · web-flow · commit a33e23443110 · 2025-08-10T13:34:41.000+02:00
* Allow factory suggestions to have parser context (#2236) (cherry picked from commit 98fd5dc) * Add property suggestions for hand,offhand,pos1 patterns (#2269) (cherry picked from commit d960fa2) * Fix getSuggestions deprecations in FAWE code --------- Co-authored-by: Maddy Miller <mnmiller1@me.com>
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/RichParser.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/RichParser.java
@@ -92,7 +92,7 @@ public List<String> getMatchedAliases() {
     }
 
     @Override
-    public Stream<String> getSuggestions(String input) {
+    public Stream<String> getSuggestions(String input, ParserContext context) {
         return Arrays.stream(this.prefixes)
                 .filter(validPrefix(input))
                 .flatMap(extractArguments(input, new ParserContext()));
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/pattern/BiomePatternParser.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/pattern/BiomePatternParser.java
@@ -45,11 +45,11 @@ public Pattern parseFromInput(String input, ParserContext context) throws InputP
 
     // overridden to provide $<biome> too
     @Override
-    public Stream<String> getSuggestions(String input) {
+    public Stream<String> getSuggestions(String input, ParserContext context) {
         if (input.startsWith(BIOME_PREFIX)) {
             return BiomeType.REGISTRY.getSuggestions(input.substring(1)).map(biome -> BIOME_PREFIX + biome);
         } else {
-            return super.getSuggestions(input);
+            return super.getSuggestions(input, context);
         }
     }
 
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/transform/RandomTransformParser.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/transform/RandomTransformParser.java
@@ -23,7 +23,7 @@ public RandomTransformParser(WorldEdit worldEdit) {
     }
 
     @Override
-    public Stream<String> getSuggestions(String input) {
+    public Stream<String> getSuggestions(String input, ParserContext context) {
         if (input.isEmpty()) {
             return Stream.empty();
         }
@@ -36,7 +36,7 @@ public Stream<String> getSuggestions(String input) {
             builder.append(split.get(i)).append(',');
         }
         String previous = builder.toString();
-        return worldEdit.getTransformFactory().getSuggestions(split.get(split.size() - 1)).stream()
+        return worldEdit.getTransformFactory().getSuggestions(split.getLast(), context).stream()
                 .map(s -> previous + s);
     }
 
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/command/util/SuggestionHelper.java b/worldedit-core/src/main/java/com/sk89q/worldedit/command/util/SuggestionHelper.java
@@ -72,8 +72,7 @@ public static Stream<String> getBlockCategorySuggestions(String tag, boolean all
         return Stream.empty();
     }
 
-    public static Stream<String> getBlockPropertySuggestions(String blockType, String props) {
-        BlockType type = BlockTypes.get(blockType.toLowerCase(Locale.ROOT));
+    public static Stream<String> getBlockPropertySuggestions(String blockTypeString, BlockType type, String props) {
         if (type == null) {
             return Stream.empty();
         }
@@ -90,7 +89,7 @@ public static Stream<String> getBlockPropertySuggestions(String blockType, Strin
                 // suggest for next property
                 String previous = Arrays.stream(propParts, 0, propParts.length - 1).collect(Collectors.joining(","))
                         + (propParts.length == 1 ? "" : ",");
-                String lastValidInput = (blockType + "[" + previous).toLowerCase(Locale.ROOT);
+                String lastValidInput = (blockTypeString + "[" + previous).toLowerCase(Locale.ROOT);
                 if (propVal.length == 1) {
                     // only property, no value yet
                     final List<? extends Property<?>> matchingProps = propertyMap.entrySet().stream()
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/DefaultBlockParser.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/DefaultBlockParser.java
@@ -31,6 +31,7 @@
 import com.google.common.collect.Maps;
 import com.sk89q.jnbt.CompoundTag;
 import com.sk89q.worldedit.IncompleteRegionException;
+import com.sk89q.worldedit.LocalSession;
 import com.sk89q.worldedit.NotABlockException;
 import com.sk89q.worldedit.WorldEdit;
 import com.sk89q.worldedit.WorldEditException;
@@ -319,23 +320,52 @@ public static Map<Property<?>, Object> parseProperties(
     }
 
     @Override
-    public Stream<String> getSuggestions(String input) {
+    public Stream<String> getSuggestions(String input, ParserContext context) {
         final int idx = input.lastIndexOf('[');
         if (idx < 0) {
             return SuggestionHelper.getNamespacedRegistrySuggestions(BlockType.REGISTRY, input);
         }
         String blockType = input.substring(0, idx);
         BlockType type = BlockTypes.get(blockType.toLowerCase(Locale.ROOT));
         if (type == null) {
-            return Stream.empty();
+            var lowerBlockType = blockType.toLowerCase(Locale.ROOT);
+            switch (lowerBlockType) {
+                case "hand", "offhand" -> {
+                    var actor = context.getActor();
+                    if (actor instanceof Player player) {
+                        var itemInHand = player.getItemInHand(lowerBlockType.equals("hand") ? HandSide.MAIN_HAND : HandSide.OFF_HAND);
+                        if (itemInHand.getType().hasBlockType()) {
+                            type = itemInHand.getType().getBlockType();
+                        }
+                    }
+                }
+                case "pos1" -> {
+                    // Get the block type from the "primary position"
+                    World world = context.getWorld();
+                    LocalSession session = context.getSession();
+                    if (world != null && session != null) {
+                        try {
+                            BlockVector3 primaryPosition = session.getRegionSelector(world).getPrimaryPosition();
+                            type = world.getBlock(primaryPosition).getBlockType();
+                        } catch (IncompleteRegionException ignored) {
+                        }
+                    }
+                }
+                default -> {
+                }
+            }
+
+            if (type == null) {
+                return Stream.empty();
+            }
         }
 
         String props = input.substring(idx + 1);
         if (props.isEmpty()) {
             return type.getProperties().stream().map(p -> input + p.getName() + "=");
         }
 
-        return SuggestionHelper.getBlockPropertySuggestions(blockType, props);
+        return SuggestionHelper.getBlockPropertySuggestions(blockType, type, props);
     }
 
     @Nonnull
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/mask/BlocksMaskParser.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/mask/BlocksMaskParser.java
@@ -40,8 +40,8 @@ public BlocksMaskParser(WorldEdit worldEdit) {
     }
 
     @Override
-    public Stream<String> getSuggestions(String input) {
-        return worldEdit.getBlockFactory().getSuggestions(input).stream();
+    public Stream<String> getSuggestions(String input, ParserContext context) {
+        return worldEdit.getBlockFactory().getSuggestions(input, context).stream();
     }
 
     @Override
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/mask/NegateMaskParser.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/mask/NegateMaskParser.java
@@ -43,14 +43,14 @@ public NegateMaskParser(WorldEdit worldEdit) {
     }
 
     @Override
-    public Stream<String> getSuggestions(String input) {
+    public Stream<String> getSuggestions(String input, ParserContext context) {
         if (input.isEmpty()) {
             return Stream.of("!");
         }
         if (input.charAt(0) != '!') {
             return Stream.empty();
         }
-        return worldEdit.getMaskFactory().getSuggestions(input.substring(1)).stream().map(s -> "!" + s);
+        return worldEdit.getMaskFactory().getSuggestions(input.substring(1), context).stream().map(s -> "!" + s);
     }
 
     @Override
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/mask/OffsetMaskParser.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/mask/OffsetMaskParser.java
@@ -44,15 +44,15 @@ public OffsetMaskParser(WorldEdit worldEdit) {
     }
 
     @Override
-    public Stream<String> getSuggestions(String input) {
+    public Stream<String> getSuggestions(String input, ParserContext context) {
         if (input.isEmpty()) {
             return Stream.of(">", "<");
         }
         final char firstChar = input.charAt(0);
         if (firstChar != '>' && firstChar != '<') {
             return Stream.empty();
         }
-        return worldEdit.getMaskFactory().getSuggestions(input.substring(1)).stream().map(s -> firstChar + s);
+        return worldEdit.getMaskFactory().getSuggestions(input.substring(1), context).stream().map(s -> firstChar + s);
     }
 
     @Override
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/pattern/RandomPatternParser.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/pattern/RandomPatternParser.java
@@ -27,7 +27,7 @@ public RandomPatternParser(WorldEdit worldEdit) {
     }
 
     @Override
-    public Stream<String> getSuggestions(String input) {
+    public Stream<String> getSuggestions(String input, ParserContext context) {
         //FAWE start
         List<String> patterns = StringUtil.split(input, ',', '[', ']');
         if (patterns.isEmpty()) {
@@ -46,7 +46,7 @@ public Stream<String> getSuggestions(String input) {
         }
         String previous = patterns.size() == 1 ? "" : String.join(",", patterns.subList(0, patterns.size() - 1)) + ",";
         String prefix = previous + (percent == null ? "" : percent + "%");
-        final List<String> innerSuggestions = worldEdit.getPatternFactory().getSuggestions(token);
+        final List<String> innerSuggestions = worldEdit.getPatternFactory().getSuggestions(token, context);
         return innerSuggestions.stream().map(s -> prefix + s);
     }
 
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/pattern/RandomStatePatternParser.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/pattern/RandomStatePatternParser.java
@@ -42,15 +42,15 @@ public RandomStatePatternParser(WorldEdit worldEdit) {
     }
 
     @Override
-    public Stream<String> getSuggestions(String input) {
+    public Stream<String> getSuggestions(String input, ParserContext context) {
         if (input.isEmpty()) {
             return Stream.of("*");
         }
         if (!input.startsWith("*")) {
             return Stream.empty();
         }
 
-        return worldEdit.getBlockFactory().getSuggestions(input.substring(1)).stream().map(s -> "*" + s);
+        return worldEdit.getBlockFactory().getSuggestions(input.substring(1), context).stream().map(s -> "*" + s);
     }
 
     @Override
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/pattern/SingleBlockPatternParser.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/pattern/SingleBlockPatternParser.java
@@ -34,8 +34,8 @@ public SingleBlockPatternParser(WorldEdit worldEdit) {
     }
 
     @Override
-    public Stream<String> getSuggestions(String input) {
-        return worldEdit.getBlockFactory().getSuggestions(input).stream();
+    public Stream<String> getSuggestions(String input, ParserContext context) {
+        return worldEdit.getBlockFactory().getSuggestions(input, context).stream();
     }
 
     @Override
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/pattern/TypeOrStateApplyingPatternParser.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/parser/pattern/TypeOrStateApplyingPatternParser.java
@@ -33,10 +33,13 @@
 import com.sk89q.worldedit.function.pattern.TypeApplyingPattern;
 import com.sk89q.worldedit.internal.registry.InputParser;
 import com.sk89q.worldedit.util.formatting.text.TextComponent;
+import com.sk89q.worldedit.world.block.BlockType;
+import com.sk89q.worldedit.world.block.BlockTypes;
 
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.stream.Stream;
 
@@ -49,7 +52,7 @@ public TypeOrStateApplyingPatternParser(WorldEdit worldEdit) {
     }
 
     @Override
-    public Stream<String> getSuggestions(String input) {
+    public Stream<String> getSuggestions(String input, ParserContext context) {
         if (input.isEmpty()) {
             return Stream.of("^");
         }
@@ -62,12 +65,13 @@ public Stream<String> getSuggestions(String input) {
         String type = parts[0];
 
         if (parts.length == 1) {
-            return worldEdit.getBlockFactory().getSuggestions(input).stream().map(s -> "^" + s);
+            return worldEdit.getBlockFactory().getSuggestions(input, context).stream().map(s -> "^" + s);
         } else {
             if (type.isEmpty()) {
                 return Stream.empty(); // without knowing a type, we can't really suggest states
             } else {
-                return SuggestionHelper.getBlockPropertySuggestions(type, parts[1]).map(s -> "^" + s);
+                BlockType blockType = BlockTypes.get(type.toLowerCase(Locale.ROOT));
+                return SuggestionHelper.getBlockPropertySuggestions(type, blockType, parts[1]).map(s -> "^" + s);
             }
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ public List<String> getMatchedAliases() {`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`@Override`
`95`		`- public Stream<String> getSuggestions(String input) {`
	`95`	`+ public Stream<String> getSuggestions(String input, ParserContext context) {`
`96`	`96`	`return Arrays.stream(this.prefixes)`
`97`	`97`	`.filter(validPrefix(input))`
`98`	`98`	`.flatMap(extractArguments(input, new ParserContext()));`
Original file line number	Diff line number	Diff line change
`@@ -45,11 +45,11 @@ public Pattern parseFromInput(String input, ParserContext context) throws InputP`
`45`	`45`
`46`	`46`	`// overridden to provide $<biome> too`
`47`	`47`	`@Override`
`48`		`- public Stream<String> getSuggestions(String input) {`
	`48`	`+ public Stream<String> getSuggestions(String input, ParserContext context) {`
`49`	`49`	`if (input.startsWith(BIOME_PREFIX)) {`
`50`	`50`	`return BiomeType.REGISTRY.getSuggestions(input.substring(1)).map(biome -> BIOME_PREFIX + biome);`
`51`	`51`	`} else {`
`52`		`- return super.getSuggestions(input);`
	`52`	`+ return super.getSuggestions(input, context);`
`53`	`53`	`}`
`54`	`54`	`}`
`55`	`55`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public RandomTransformParser(WorldEdit worldEdit) {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`@Override`
`26`		`- public Stream<String> getSuggestions(String input) {`
	`26`	`+ public Stream<String> getSuggestions(String input, ParserContext context) {`
`27`	`27`	`if (input.isEmpty()) {`
`28`	`28`	`return Stream.empty();`
`29`	`29`	`}`
`@@ -36,7 +36,7 @@ public Stream<String> getSuggestions(String input) {`
`36`	`36`	`builder.append(split.get(i)).append(',');`
`37`	`37`	`}`
`38`	`38`	`String previous = builder.toString();`
`39`		`- return worldEdit.getTransformFactory().getSuggestions(split.get(split.size() - 1)).stream()`
	`39`	`+ return worldEdit.getTransformFactory().getSuggestions(split.getLast(), context).stream()`
`40`	`40`	`.map(s -> previous + s);`
`41`	`41`	`}`
`42`	`42`
Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,8 @@ public BlocksMaskParser(WorldEdit worldEdit) {`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`@Override`
`43`		`- public Stream<String> getSuggestions(String input) {`
`44`		`- return worldEdit.getBlockFactory().getSuggestions(input).stream();`
	`43`	`+ public Stream<String> getSuggestions(String input, ParserContext context) {`
	`44`	`+ return worldEdit.getBlockFactory().getSuggestions(input, context).stream();`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -43,14 +43,14 @@ public NegateMaskParser(WorldEdit worldEdit) {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`@Override`
`46`		`- public Stream<String> getSuggestions(String input) {`
	`46`	`+ public Stream<String> getSuggestions(String input, ParserContext context) {`
`47`	`47`	`if (input.isEmpty()) {`
`48`	`48`	`return Stream.of("!");`
`49`	`49`	`}`
`50`	`50`	`if (input.charAt(0) != '!') {`
`51`	`51`	`return Stream.empty();`
`52`	`52`	`}`
`53`		`- return worldEdit.getMaskFactory().getSuggestions(input.substring(1)).stream().map(s -> "!" + s);`
	`53`	`+ return worldEdit.getMaskFactory().getSuggestions(input.substring(1), context).stream().map(s -> "!" + s);`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -44,15 +44,15 @@ public OffsetMaskParser(WorldEdit worldEdit) {`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`@Override`
`47`		`- public Stream<String> getSuggestions(String input) {`
	`47`	`+ public Stream<String> getSuggestions(String input, ParserContext context) {`
`48`	`48`	`if (input.isEmpty()) {`
`49`	`49`	`return Stream.of(">", "<");`
`50`	`50`	`}`
`51`	`51`	`final char firstChar = input.charAt(0);`
`52`	`52`	`if (firstChar != '>' && firstChar != '<') {`
`53`	`53`	`return Stream.empty();`
`54`	`54`	`}`
`55`		`- return worldEdit.getMaskFactory().getSuggestions(input.substring(1)).stream().map(s -> firstChar + s);`
	`55`	`+ return worldEdit.getMaskFactory().getSuggestions(input.substring(1), context).stream().map(s -> firstChar + s);`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public RandomPatternParser(WorldEdit worldEdit) {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`@Override`
`30`		`- public Stream<String> getSuggestions(String input) {`
	`30`	`+ public Stream<String> getSuggestions(String input, ParserContext context) {`
`31`	`31`	`//FAWE start`
`32`	`32`	`List<String> patterns = StringUtil.split(input, ',', '[', ']');`
`33`	`33`	`if (patterns.isEmpty()) {`
`@@ -46,7 +46,7 @@ public Stream<String> getSuggestions(String input) {`
`46`	`46`	`}`
`47`	`47`	`String previous = patterns.size() == 1 ? "" : String.join(",", patterns.subList(0, patterns.size() - 1)) + ",";`
`48`	`48`	`String prefix = previous + (percent == null ? "" : percent + "%");`
`49`		`- final List<String> innerSuggestions = worldEdit.getPatternFactory().getSuggestions(token);`
	`49`	`+ final List<String> innerSuggestions = worldEdit.getPatternFactory().getSuggestions(token, context);`
`50`	`50`	`return innerSuggestions.stream().map(s -> prefix + s);`
`51`	`51`	`}`
`52`	`52`
Original file line number	Diff line number	Diff line change
`@@ -42,15 +42,15 @@ public RandomStatePatternParser(WorldEdit worldEdit) {`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`@Override`
`45`		`- public Stream<String> getSuggestions(String input) {`
	`45`	`+ public Stream<String> getSuggestions(String input, ParserContext context) {`
`46`	`46`	`if (input.isEmpty()) {`
`47`	`47`	`return Stream.of("*");`
`48`	`48`	`}`
`49`	`49`	`if (!input.startsWith("*")) {`
`50`	`50`	`return Stream.empty();`
`51`	`51`	`}`
`52`	`52`
`53`		`- return worldEdit.getBlockFactory().getSuggestions(input.substring(1)).stream().map(s -> "*" + s);`
	`53`	`+ return worldEdit.getBlockFactory().getSuggestions(input.substring(1), context).stream().map(s -> "*" + s);`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`@Override`