Suggestions should ultimately just contain a list of strings at a range, not each with an individual range

This commit is contained in:
Nathan Adams 2017-11-21 10:51:56 +01:00
parent 095498c94e
commit ab95e809e2
10 changed files with 113 additions and 87 deletions

View file

@ -354,7 +354,7 @@ public class CommandDispatcher<S> {
for (final CompletableFuture<Suggestions> future : futures) { for (final CompletableFuture<Suggestions> future : futures) {
suggestions.add(future.join()); suggestions.add(future.join());
} }
result.complete(Suggestions.merge(suggestions)); result.complete(Suggestions.merge(parse.getReader().getString(), suggestions));
}); });
return result; return result;

View file

@ -61,4 +61,5 @@ public class StringRange {
", end=" + end + ", end=" + end +
'}'; '}';
} }
} }

View file

@ -65,4 +65,19 @@ public class Suggestion implements Comparable<Suggestion> {
public int compareTo(final Suggestion o) { public int compareTo(final Suggestion o) {
return text.compareTo(o.text); return text.compareTo(o.text);
} }
public String expand(final String command, final StringRange range) {
if (range.equals(this.range)) {
return text;
}
final StringBuilder result = new StringBuilder();
if (range.getStart() < this.range.getStart()) {
result.append(command.substring(range.getStart(), this.range.getStart()));
}
result.append(text);
if (range.getEnd() > this.range.getEnd()) {
result.append(command.substring(this.range.getEnd(), range.getEnd()));
}
return result.toString();
}
} }

View file

@ -6,44 +6,28 @@ import com.mojang.brigadier.context.StringRange;
import java.util.Collection; import java.util.Collection;
import java.util.Collections; import java.util.Collections;
import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Objects; import java.util.Objects;
import java.util.Set; import java.util.Set;
import java.util.concurrent.CompletableFuture; import java.util.concurrent.CompletableFuture;
public class Suggestions { public class Suggestions {
private static final Suggestions EMPTY = new Suggestions("", Lists.newArrayList()); private static final Suggestions EMPTY = new Suggestions(new StringRange(0, 0), Lists.newArrayList());
private final String input;
private final StringRange range; private final StringRange range;
private final List<Suggestion> suggestions; private final List<String> suggestions;
public Suggestions(final String input, final List<Suggestion> suggestions) { public Suggestions(final StringRange range, final List<String> suggestions) {
this.input = input; this.range = range;
this.suggestions = suggestions; this.suggestions = suggestions;
if (suggestions.isEmpty()) {
range = new StringRange(input.length(), input.length());
} else {
int start = Integer.MAX_VALUE;
int end = Integer.MIN_VALUE;
for (final Suggestion suggestion : suggestions) {
start = Math.min(start, suggestion.getRange().getStart());
end = Math.max(end, suggestion.getRange().getEnd());
}
range = new StringRange(start, end);
}
}
public String getInput() {
return input;
} }
public StringRange getRange() { public StringRange getRange() {
return range; return range;
} }
public List<Suggestion> getList() { public List<String> getList() {
return suggestions; return suggestions;
} }
@ -60,33 +44,60 @@ public class Suggestions {
return false; return false;
} }
final Suggestions that = (Suggestions) o; final Suggestions that = (Suggestions) o;
return Objects.equals(input, that.input) && return Objects.equals(range, that.range) &&
Objects.equals(range, that.range) &&
Objects.equals(suggestions, that.suggestions); Objects.equals(suggestions, that.suggestions);
} }
@Override @Override
public int hashCode() { public int hashCode() {
return Objects.hash(input, range, suggestions); return Objects.hash(range, suggestions);
}
@Override
public String toString() {
return "Suggestions{" +
"range=" + range +
", suggestions=" + suggestions +
'}';
} }
public static CompletableFuture<Suggestions> empty() { public static CompletableFuture<Suggestions> empty() {
return CompletableFuture.completedFuture(EMPTY); return CompletableFuture.completedFuture(EMPTY);
} }
public static Suggestions merge(final Collection<Suggestions> inputs) { public static Suggestions merge(final String command, final Collection<Suggestions> input) {
if (inputs.isEmpty()) { if (input.isEmpty()) {
return EMPTY; return EMPTY;
} else if (inputs.size() == 1) { } else if (input.size() == 1) {
return inputs.iterator().next(); return input.iterator().next();
} }
final Set<Suggestion> suggestions = Sets.newHashSet(); final Set<Suggestion> texts = new HashSet<>();
for (final Suggestions input : inputs) { for (final Suggestions suggestions : input) {
suggestions.addAll(input.getList()); for (final String text : suggestions.getList()) {
texts.add(new Suggestion(suggestions.getRange(), text));
} }
final List<Suggestion> sorted = Lists.newArrayList(suggestions); }
return create(command, texts);
}
public static Suggestions create(final String command, final Collection<Suggestion> suggestions) {
if (suggestions.isEmpty()) {
return EMPTY;
}
int start = Integer.MAX_VALUE;
int end = Integer.MIN_VALUE;
for (final Suggestion suggestion : suggestions) {
start = Math.min(suggestion.getRange().getStart(), start);
end = Math.max(suggestion.getRange().getEnd(), end);
}
final StringRange range = new StringRange(start, end);
final Set<String> texts = Sets.newHashSet();
for (final Suggestion suggestion : suggestions) {
texts.add(suggestion.expand(command, range));
}
final List<String> sorted = Lists.newArrayList(texts);
Collections.sort(sorted); Collections.sort(sorted);
return new Suggestions(inputs.iterator().next().getInput(), sorted); return new Suggestions(range, sorted);
} }
} }

View file

@ -32,11 +32,11 @@ public class SuggestionsBuilder {
} }
public Suggestions build() { public Suggestions build() {
return new Suggestions(input, result); return Suggestions.create(input, result);
} }
public CompletableFuture<Suggestions> buildFuture() { public CompletableFuture<Suggestions> buildFuture() {
return CompletableFuture.completedFuture(new Suggestions(input, result)); return CompletableFuture.completedFuture(build());
} }
public SuggestionsBuilder suggest(final String text) { public SuggestionsBuilder suggest(final String text) {

View file

@ -2,7 +2,6 @@ package com.mojang.brigadier;
import com.google.common.collect.Lists; import com.google.common.collect.Lists;
import com.mojang.brigadier.context.StringRange; import com.mojang.brigadier.context.StringRange;
import com.mojang.brigadier.suggestion.Suggestion;
import com.mojang.brigadier.suggestion.Suggestions; import com.mojang.brigadier.suggestion.Suggestions;
import com.mojang.brigadier.tree.LiteralCommandNode; import com.mojang.brigadier.tree.LiteralCommandNode;
import org.junit.Before; import org.junit.Before;
@ -39,11 +38,7 @@ public class CommandSuggestionsTest {
final Suggestions result = subject.getCompletionSuggestions(subject.parse("", source)).join(); final Suggestions result = subject.getCompletionSuggestions(subject.parse("", source)).join();
assertThat(result.getRange(), equalTo(new StringRange(0, 0))); assertThat(result.getRange(), equalTo(new StringRange(0, 0)));
assertThat(result.getList(), equalTo(Lists.newArrayList( assertThat(result.getList(), equalTo(Lists.newArrayList("bar", "baz", "foo")));
new Suggestion(new StringRange(0, 0), "bar"),
new Suggestion(new StringRange(0, 0), "baz"),
new Suggestion(new StringRange(0, 0), "foo")
)));
} }
@Test @Test
@ -55,10 +50,7 @@ public class CommandSuggestionsTest {
final Suggestions result = subject.getCompletionSuggestions(subject.parse("b", source)).join(); final Suggestions result = subject.getCompletionSuggestions(subject.parse("b", source)).join();
assertThat(result.getRange(), equalTo(new StringRange(1, 1))); assertThat(result.getRange(), equalTo(new StringRange(1, 1)));
assertThat(result.getList(), equalTo(Lists.newArrayList( assertThat(result.getList(), equalTo(Lists.newArrayList("ar", "az")));
new Suggestion(new StringRange(1, 1), "ar"),
new Suggestion(new StringRange(1, 1), "az")
)));
} }
@Test @Test
@ -73,11 +65,7 @@ public class CommandSuggestionsTest {
final Suggestions result = subject.getCompletionSuggestions(subject.parse("parent ", source)).join(); final Suggestions result = subject.getCompletionSuggestions(subject.parse("parent ", source)).join();
assertThat(result.getRange(), equalTo(new StringRange(7, 7))); assertThat(result.getRange(), equalTo(new StringRange(7, 7)));
assertThat(result.getList(), equalTo(Lists.newArrayList( assertThat(result.getList(), equalTo(Lists.newArrayList("bar", "baz", "foo")));
new Suggestion(new StringRange(7, 7), "bar"),
new Suggestion(new StringRange(7, 7), "baz"),
new Suggestion(new StringRange(7, 7), "foo")
)));
} }
@Test @Test
@ -93,10 +81,7 @@ public class CommandSuggestionsTest {
final Suggestions result = subject.getCompletionSuggestions(parse).join(); final Suggestions result = subject.getCompletionSuggestions(parse).join();
assertThat(result.getRange(), equalTo(new StringRange(8, 8))); assertThat(result.getRange(), equalTo(new StringRange(8, 8)));
assertThat(result.getList(), equalTo(Lists.newArrayList( assertThat(result.getList(), equalTo(Lists.newArrayList("ar", "az")));
new Suggestion(new StringRange(8, 8), "ar"),
new Suggestion(new StringRange(8, 8), "az")
)));
} }
@Test @Test
@ -108,9 +93,7 @@ public class CommandSuggestionsTest {
final Suggestions result = subject.getCompletionSuggestions(parse).join(); final Suggestions result = subject.getCompletionSuggestions(parse).join();
assertThat(result.getRange(), equalTo(new StringRange(9, 9))); assertThat(result.getRange(), equalTo(new StringRange(9, 9)));
assertThat(result.getList(), equalTo(Lists.newArrayList( assertThat(result.getList(), equalTo(Lists.newArrayList("sub")));
new Suggestion(new StringRange(9, 9), "sub")
)));
} }
@Test @Test
@ -122,9 +105,7 @@ public class CommandSuggestionsTest {
final Suggestions result = subject.getCompletionSuggestions(parse).join(); final Suggestions result = subject.getCompletionSuggestions(parse).join();
assertThat(result.getRange(), equalTo(new StringRange(10, 10))); assertThat(result.getRange(), equalTo(new StringRange(10, 10)));
assertThat(result.getList(), equalTo(Lists.newArrayList( assertThat(result.getList(), equalTo(Lists.newArrayList("ub")));
new Suggestion(new StringRange(10, 10), "ub")
)));
} }
@Test @Test
@ -144,9 +125,7 @@ public class CommandSuggestionsTest {
final Suggestions result = subject.getCompletionSuggestions(subject.parse("redirect loop 1 loop 02 loop 003 ", source)).join(); final Suggestions result = subject.getCompletionSuggestions(subject.parse("redirect loop 1 loop 02 loop 003 ", source)).join();
assertThat(result.getRange(), equalTo(new StringRange(33, 33))); assertThat(result.getRange(), equalTo(new StringRange(33, 33)));
assertThat(result.getList(), equalTo(Lists.newArrayList( assertThat(result.getList(), equalTo(Lists.newArrayList("loop")));
new Suggestion(new StringRange(33, 33), "loop")
)));
} }
@Test @Test
@ -207,9 +186,6 @@ public class CommandSuggestionsTest {
final Suggestions result = subject.getCompletionSuggestions(parse).join(); final Suggestions result = subject.getCompletionSuggestions(parse).join();
assertThat(result.getRange(), equalTo(new StringRange(18, 18))); assertThat(result.getRange(), equalTo(new StringRange(18, 18)));
assertThat(result.getList(), equalTo(Lists.newArrayList( assertThat(result.getList(), equalTo(Lists.newArrayList("bar", "baz")));
new Suggestion(new StringRange(18, 18), "bar"),
new Suggestion(new StringRange(18, 18), "baz")
)));
} }
} }

View file

@ -48,4 +48,34 @@ public class SuggestionTest {
final Suggestion suggestion = new Suggestion(new StringRange(0, 12), "Oh dear."); final Suggestion suggestion = new Suggestion(new StringRange(0, 12), "Oh dear.");
assertThat(suggestion.apply("Hello world!"), equalTo("Oh dear.")); assertThat(suggestion.apply("Hello world!"), equalTo("Oh dear."));
} }
@Test
public void expand_unchanged() {
final Suggestion suggestion = new Suggestion(new StringRange(1, 1), "oo");
assertThat(suggestion.expand("f", new StringRange(1, 1)), equalTo("oo"));
}
@Test
public void expand_left() {
final Suggestion suggestion = new Suggestion(new StringRange(1, 1), "oo");
assertThat(suggestion.expand("f", new StringRange(0, 1)), equalTo("foo"));
}
@Test
public void expand_right() {
final Suggestion suggestion = new Suggestion(new StringRange(0, 0), "minecraft:");
assertThat(suggestion.expand("fish", new StringRange(0, 4)), equalTo("minecraft:fish"));
}
@Test
public void expand_both() {
final Suggestion suggestion = new Suggestion(new StringRange(11, 11), "minecraft:");
assertThat(suggestion.expand("give Steve fish_block", new StringRange(5, 21)), equalTo("Steve minecraft:fish_block"));
}
@Test
public void expand_replacement() {
final Suggestion suggestion = new Suggestion(new StringRange(6, 11), "strangers");
assertThat(suggestion.expand("Hello world!", new StringRange(0, 12)), equalTo("Hello strangers!"));
}
} }

View file

@ -21,7 +21,7 @@ public class SuggestionsBuilderTest {
@Test @Test
public void suggest_appends() { public void suggest_appends() {
final Suggestions result = builder.suggest("world!").build(); final Suggestions result = builder.suggest("world!").build();
assertThat(result.getList(), equalTo(Lists.newArrayList(new Suggestion(new StringRange(7, 7), "orld!")))); assertThat(result.getList(), equalTo(Lists.newArrayList("orld!")));
assertThat(result.getRange(), equalTo(new StringRange(7, 7))); assertThat(result.getRange(), equalTo(new StringRange(7, 7)));
assertThat(result.isEmpty(), is(false)); assertThat(result.isEmpty(), is(false));
} }
@ -29,7 +29,7 @@ public class SuggestionsBuilderTest {
@Test @Test
public void suggest_replaces() { public void suggest_replaces() {
final Suggestions result = builder.suggest("everybody").build(); final Suggestions result = builder.suggest("everybody").build();
assertThat(result.getList(), equalTo(Lists.newArrayList(new Suggestion(new StringRange(6, 7), "everybody")))); assertThat(result.getList(), equalTo(Lists.newArrayList("everybody")));
assertThat(result.getRange(), equalTo(new StringRange(6, 7))); assertThat(result.getRange(), equalTo(new StringRange(6, 7)));
assertThat(result.isEmpty(), is(false)); assertThat(result.isEmpty(), is(false));
} }
@ -38,14 +38,13 @@ public class SuggestionsBuilderTest {
public void suggest_noop() { public void suggest_noop() {
final Suggestions result = builder.suggest("w").build(); final Suggestions result = builder.suggest("w").build();
assertThat(result.getList(), equalTo(Lists.newArrayList())); assertThat(result.getList(), equalTo(Lists.newArrayList()));
assertThat(result.getRange(), equalTo(new StringRange(7, 7)));
assertThat(result.isEmpty(), is(true)); assertThat(result.isEmpty(), is(true));
} }
@Test @Test
public void suggest_multiple() { public void suggest_multiple() {
final Suggestions result = builder.suggest("world!").suggest("everybody").suggest("weekend").build(); final Suggestions result = builder.suggest("world!").suggest("everybody").suggest("weekend").build();
assertThat(result.getList(), equalTo(Lists.newArrayList(new Suggestion(new StringRange(7, 7), "orld!"), new Suggestion(new StringRange(6, 7), "everybody"), new Suggestion(new StringRange(7, 7), "eekend")))); assertThat(result.getList(), equalTo(Lists.newArrayList("everybody", "weekend", "world!")));
assertThat(result.getRange(), equalTo(new StringRange(6, 7))); assertThat(result.getRange(), equalTo(new StringRange(6, 7)));
assertThat(result.isEmpty(), is(false)); assertThat(result.isEmpty(), is(false));
} }

View file

@ -13,26 +13,22 @@ import static org.junit.Assert.assertThat;
public class SuggestionsTest { public class SuggestionsTest {
@Test @Test
public void merge_empty() { public void merge_empty() {
final Suggestions merged = Suggestions.merge(Collections.emptyList()); final Suggestions merged = Suggestions.merge("foo b", Collections.emptyList());
assertThat(merged.isEmpty(), is(true)); assertThat(merged.isEmpty(), is(true));
} }
@Test @Test
public void merge_single() { public void merge_single() {
final Suggestions suggestions = new Suggestions("", Lists.newArrayList(new Suggestion(new StringRange(0, 0), "foo"))); final Suggestions suggestions = new Suggestions(new StringRange(5, 5), Lists.newArrayList("ar"));
final Suggestions merged = Suggestions.merge(Collections.singleton(suggestions)); final Suggestions merged = Suggestions.merge("foo b", Collections.singleton(suggestions));
assertThat(merged, equalTo(suggestions)); assertThat(merged, equalTo(suggestions));
} }
@Test @Test
public void merge_multiple() { public void merge_multiple() {
final Suggestion foo = new Suggestion(new StringRange(0, 0), "foo"); final Suggestions a = new Suggestions(new StringRange(5, 5), Lists.newArrayList("ar", "az"));
final Suggestion bar = new Suggestion(new StringRange(0, 0), "bar"); final Suggestions b = new Suggestions(new StringRange(4, 5), Lists.newArrayList("foo", "qux", "apple"));
final Suggestion baz = new Suggestion(new StringRange(0, 0), "baz"); final Suggestions merged = Suggestions.merge("foo b", Lists.newArrayList(a, b));
final Suggestion qux = new Suggestion(new StringRange(0, 0), "qux"); assertThat(merged.getList(), equalTo(Lists.newArrayList("apple", "bar", "baz", "foo", "qux")));
final Suggestions a = new Suggestions("", Lists.newArrayList(foo, bar));
final Suggestions b = new Suggestions("", Lists.newArrayList(baz, qux));
final Suggestions merged = Suggestions.merge(Lists.newArrayList(a, b));
assertThat(merged.getList(), equalTo(Lists.newArrayList(bar, baz, foo, qux)));
} }
} }

View file

@ -8,9 +8,7 @@ import com.mojang.brigadier.CommandDispatcher;
import com.mojang.brigadier.StringReader; import com.mojang.brigadier.StringReader;
import com.mojang.brigadier.builder.LiteralArgumentBuilder; import com.mojang.brigadier.builder.LiteralArgumentBuilder;
import com.mojang.brigadier.context.CommandContextBuilder; import com.mojang.brigadier.context.CommandContextBuilder;
import com.mojang.brigadier.context.StringRange;
import com.mojang.brigadier.exceptions.CommandSyntaxException; import com.mojang.brigadier.exceptions.CommandSyntaxException;
import com.mojang.brigadier.suggestion.Suggestion;
import com.mojang.brigadier.suggestion.Suggestions; import com.mojang.brigadier.suggestion.Suggestions;
import com.mojang.brigadier.suggestion.SuggestionsBuilder; import com.mojang.brigadier.suggestion.SuggestionsBuilder;
import org.junit.Before; import org.junit.Before;
@ -81,7 +79,7 @@ public class LiteralCommandNodeTest extends AbstractCommandNodeTest {
@Test @Test
public void testSuggestions() throws Exception { public void testSuggestions() throws Exception {
final Suggestions empty = node.listSuggestions(contextBuilder.build(""), new SuggestionsBuilder("", 0)).join(); final Suggestions empty = node.listSuggestions(contextBuilder.build(""), new SuggestionsBuilder("", 0)).join();
assertThat(empty.getList(), equalTo(Lists.newArrayList(new Suggestion(new StringRange(0, 0), "foo")))); assertThat(empty.getList(), equalTo(Lists.newArrayList("foo")));
final Suggestions foo = node.listSuggestions(contextBuilder.build("foo"), new SuggestionsBuilder("foo", 0)).join(); final Suggestions foo = node.listSuggestions(contextBuilder.build("foo"), new SuggestionsBuilder("foo", 0)).join();
assertThat(foo.isEmpty(), is(true)); assertThat(foo.isEmpty(), is(true));