Skip to content

Commit

Permalink
[PlaybackSerialiser] Rewrite modules, added tests
Browse files Browse the repository at this point in the history 
- Added tests for error handling
  • Loading branch information
@ScribbleTAS
ScribbleTAS committed Jun 14, 2024
1 parent d2fdf9f commit ccfd759
Show file tree
Hide file tree
Showing 8 changed files with 487 additions and 126 deletions.
6 changes: 4 additions & 2 deletions ...main/java/com/minecrafttas/tasmod/playback/filecommands/PlaybackFileCommandsRegistry.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,10 @@ public void unregister(PlaybackFileCommandExtension extension) {

public void setEnabled(String extensionName, boolean enabled) {
PlaybackFileCommandExtension extension = REGISTRY.get(extensionName);
extension.setEnabled(enabled);
enabledExtensions = getEnabled();
if(extension != null) {
extension.setEnabled(enabled);
enabledExtensions = getEnabled();
}
}

private void disableAll() {
Expand Down
7 changes: 1 addition & 6 deletions src/main/java/com/minecrafttas/tasmod/playback/tasfile/PlaybackSerialiser2.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,13 +155,8 @@ public static BigArrayList<TickContainer> loadFromFile(File file, SerialiserFlav

// Deserialise Header
List<String> headerLines = flavor.extractHeader(lines);
List<PlaybackMetadata> deserialisedMetadata = new ArrayList<>();
List<String> deserialisedExtensionNames = new ArrayList<>();

flavor.deserialiseHeader(headerLines, deserialisedMetadata, deserialisedExtensionNames);

TASmodRegistry.PLAYBACK_METADATA.handleOnLoad(deserialisedMetadata);
TASmodRegistry.PLAYBACK_FILE_COMMAND.setEnabled(deserialisedExtensionNames);
flavor.deserialiseHeader(headerLines);

// Deserialise main data
BigArrayList<TickContainer> deserialisedContainers = flavor.deserialise(lines, headerLines.size());
Expand Down
201 changes: 164 additions & 37 deletions src/main/java/com/minecrafttas/tasmod/playback/tasfile/flavor/SerialiserFlavorBase.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ public List<String> serialiseHeader(List<PlaybackMetadata> metadataList, List<Pl
List<String> out = new ArrayList<>();
out.add(headerStart());
serialiseFlavorName(out);
serialiseFileCommandNames(out, extensionList);
serialiseMetadata(out, metadataList);
serialiseFileCommandNames(out);
serialiseMetadata(out);
out.add(headerEnd());
return out;
}
Expand All @@ -82,13 +82,16 @@ protected void serialiseFlavorName(List<String> out) {
out.add("Flavor: " + flavorName());
}

protected void serialiseFileCommandNames(List<String> out, List<PlaybackFileCommandExtension> extensionList) {
protected void serialiseFileCommandNames(List<String> out) {
List<String> stringlist = new ArrayList<>();
List<PlaybackFileCommandExtension> extensionList = TASmodRegistry.PLAYBACK_FILE_COMMAND.getEnabled();
extensionList.forEach(extension -> stringlist.add(extension.name()));
out.add("FC_Extensions: " + String.join(", ", stringlist));
out.add("FileCommand-Extensions: " + String.join(", ", stringlist));
}

protected void serialiseMetadata(List<String> out, List<PlaybackMetadata> metadataList) {
protected void serialiseMetadata(List<String> out) {
List<PlaybackMetadata> metadataList = TASmodRegistry.PLAYBACK_METADATA.handleOnStore();

for (PlaybackMetadata metadata : metadataList) {
serialiseMetadataName(out, metadata.getExtensionName());
serialiseMetadataValue(out, metadata.getData());
Expand Down Expand Up @@ -302,7 +305,7 @@ protected String joinNotEmpty(String delimiter, String... args) {
*
*/

private TickContainer previousTickContainer = null;
protected TickContainer previousTickContainer = null;

public boolean deserialiseFlavorName(List<String> headerLines) {
for (String line : headerLines) {
Expand All @@ -315,9 +318,8 @@ public boolean deserialiseFlavorName(List<String> headerLines) {
return false;
}

public void deserialiseHeader(List<String> headerLines, List<PlaybackMetadata> metadataList, List<String> activeExtensionList) {

metadataList.addAll(deserialiseMetadata(headerLines));
public void deserialiseHeader(List<String> headerLines) {
deserialiseMetadata(headerLines);
deserialiseFileCommandNames(headerLines);
}

Expand All @@ -338,21 +340,22 @@ public List<String> extractHeader(BigArrayList<String> lines) {
throw new PlaybackLoadException("Cannot find the end of the header");
}

public List<String> deserialiseFileCommandNames(List<String> headerLines) {
public void deserialiseFileCommandNames(List<String> headerLines) {
for (String line : headerLines) {
Matcher matcher = extract("FC_Extensions: ?(.*)", line);
Matcher matcher = extract("FileCommand-Extensions: ?(.*)", line);

if (matcher.find()) {
String extensionStrings = matcher.group(1);
String[] extensionNames = extensionStrings.split(", ");
String[] extensionNames = extensionStrings.split(", ?");

return Arrays.asList(extensionNames);
TASmodRegistry.PLAYBACK_FILE_COMMAND.setEnabled(Arrays.asList(extensionNames));
return;
}
}
throw new PlaybackLoadException("Extensions value was not found in the header");
throw new PlaybackLoadException("FileCommand-Extensions value was not found in the header");
}

public List<PlaybackMetadata> deserialiseMetadata(List<String> headerLines) {
public void deserialiseMetadata(List<String> headerLines) {
List<PlaybackMetadata> out = new ArrayList<>();

String metadataName = null;
Expand Down Expand Up @@ -382,7 +385,7 @@ public List<PlaybackMetadata> deserialiseMetadata(List<String> headerLines) {
if (metadataName != null)
out.add(PlaybackMetadata.fromHashMap(metadataName, values));

return out;
TASmodRegistry.PLAYBACK_METADATA.handleOnLoad(out);
}

/**
Expand All @@ -407,27 +410,148 @@ public BigArrayList<TickContainer> deserialise(BigArrayList<String> lines, long
return out;
}

protected enum ExtractPhases {
/**
* InlineComment phase.
* <pre>
* ---
* // This is a comment
* // $fileCommand();
*
* ---
* </pre>
* Empty lines also count as comments
*/
COMMENTS,
/**
* Tick phase. Start with a number, then a | character
* <pre>
* ---
* 57|W,LCONTROL;w|;0,887,626|17.85;-202.74799
* ---
* </pre>
* Only one line should be in this phase
*/
TICK,
/**
* Subtick phase. Start with a tabulator, then a number, then a | character
* <pre>
* ---
* 1||RC;0,1580,658|17.85;-202.74799\t\t// This is an endline comment
* 2||;0,1580,658|17.85;-202.74799
* ---
* Can have multiple subticks
*/
SUBTICK,
/**
* We are outside a tick
*/
NONE
}

/**
* Reads the next lines, until a full tickcontainer is reached
* <p>
* Extracts all the lines corresponding to one tick+subticks a.k.a one
* "container" from the incoming lines.<br>
* The extracted ticks are easier to process than using a huge list.<br>
* <p>
* A container has multiple parts to it, that are split into
* {@link ExtractPhases}<br>
* The container starts in {@link ExtractPhases#NONE}.
*
* <pre>
* --- {@link ExtractPhases#COMMENTS Comment phase} ---
* // This is a comment
* // $fileCommand();
* --- {@link ExtractPhases#TICK Tick phase} ---
* 57|W,LCONTROL;w|;0,887,626|17.85;-202.74799
* --- {@link ExtractPhases#SUBTICK Subtick phase} ---
* 1||RC;0,1580,658|17.85;-202.74799 // This is an endline comment
* 2||;0,1580,658|17.85;-202.74799
* ---------------------
* </pre>
* <h2>Logic</h2>
* <ol>
* <li>Phase: None
* <ol>
* <li>If a comment is found, set the phase to comment</li>
* <li>If a tick is found, set the phase to tick</li>
* <li>If a subtick is found, throw an error. Subticks always come after ticks</li>
* </ol></li>
* <li>Phase: Comment
* <ol>
* <li>If a tick is found, set the phase to tick</li>
* <li>If a subtick is found, throw an error. Subticks always come after ticks</li>
* </ol></li>
* <li>Phase: Tick
* <ol>
* <li>If a subtick is found, set the phase to subticks</li>
* <li>If a tick is found, end the extraction</li>
* <li>If a comment is found, end the extraction</li>
* </ol></li>
* <li>Phase: Subtick
* <ol>
* <li>If a tick is found, end the extraction</li>
* <li>If a comment is found, end the extraction</li>
* </ol></li>
* </ol>
* @param extracted The extracted lines, passed in by reference
* @param lines The line list
* @param startPos The start position of this tick
* @return The updated index for the next tick
*/
protected long extractContainer(List<String> extracted, BigArrayList<String> lines, long startPos) {
boolean shouldStop = false;
ExtractPhases phase = ExtractPhases.NONE;

String commentRegex = "^//";
String tickRegex = "^\\d+\\|";
String subtickRegex = "^\t\\d+\\|";

long counter = 0L;
for (long i = startPos; i < lines.size(); i++) {
String line = lines.get(i);
if (contains("^\\d+\\|", line)) {
if (shouldStop) {
return startPos + counter - 1;
} else {
shouldStop = true;
}

switch (phase) {
case NONE:
if (contains(subtickRegex, line)) { // Subtick
throw new PlaybackLoadException(currentTick, currentSubtick, "Error while trying to parse line %s in line %s. This should not be a subtick at this position", line, startPos + counter);
}

if (contains(commentRegex, line)||line.isEmpty()) { // Comment
phase = ExtractPhases.COMMENTS;
}
else if (contains(tickRegex, line)) { // Tick
phase = ExtractPhases.TICK;
}

break;
case COMMENTS:
if (contains(subtickRegex, line)) { // Subtick
throw new PlaybackLoadException(currentTick, currentSubtick, "Error while trying to parse line %s in line %s. This should not be a subtick at this position", line, startPos + counter);
}

if (contains(tickRegex, line)) {
phase = ExtractPhases.TICK;
}

break;
case TICK:
if (contains(subtickRegex, line)) {
phase = ExtractPhases.SUBTICK;
}

if (contains(commentRegex, line) || contains(tickRegex, line) || line.isEmpty()) {
return startPos + counter - 1;
}

break;
case SUBTICK:
if (contains(commentRegex, line) || contains(tickRegex, line) || line.isEmpty()) {
return startPos + counter - 1;
}
break;
}
if (shouldStop) {
if (phase != ExtractPhases.NONE) {
extracted.add(line);
}
counter++;
Expand Down Expand Up @@ -535,9 +659,9 @@ protected VirtualMouse deserialiseMouse(List<String> mouseStrings) {
VirtualMouse out = new VirtualMouse();

currentSubtick = 0;
Integer previousCursorX = previousTickContainer == null? null : previousTickContainer.getMouse().getCursorX();
Integer previousCursorY = previousTickContainer== null? null : previousTickContainer.getMouse().getCursorY();
Integer previousCursorX = previousTickContainer == null ? null : previousTickContainer.getMouse().getCursorX();
Integer previousCursorY = previousTickContainer == null ? null : previousTickContainer.getMouse().getCursorY();

for (String line : mouseStrings) {
Matcher matcher = extract("(.*?);(.+)", line);
if (matcher.find()) {
Expand All @@ -554,11 +678,11 @@ protected VirtualMouse deserialiseMouse(List<String> mouseStrings) {
cursorX = deserialiseRelativeInt("cursorX", functions[1], previousCursorX);
cursorY = deserialiseRelativeInt("cursorY", functions[2], previousCursorY);
} else {
throw new PlaybackLoadException("Mouse functions do not have the correct length");
throw new PlaybackLoadException(currentTick, currentSubtick, "Mouse functions do not have the correct length");
}

out.updateFromState(keycodes, scrollwheel, cursorX, cursorY);

previousCursorX = cursorX;
previousCursorY = cursorY;
}
Expand All @@ -573,7 +697,7 @@ protected VirtualCameraAngle deserialiseCameraAngle(List<String> cameraAngleStri
currentSubtick = 0;
Float previousPitch = previousTickContainer == null ? null : previousTickContainer.getCameraAngle().getPitch();
Float previousYaw = previousTickContainer == null ? null : previousTickContainer.getCameraAngle().getYaw();

for (String line : cameraAngleStrings) {
Matcher matcher = extract("(.+?);(.+)", line);

Expand Down Expand Up @@ -628,10 +752,10 @@ protected int parseInt(String name, String intstring) {

protected int deserialiseRelativeInt(String name, String intstring, Integer previous) {
int out = 0;
if(intstring.startsWith("~")) {
if (intstring.startsWith("~")) {
intstring = intstring.replace("~", "");
int relative = parseInt(name, intstring);
if(previous != null) {
if (previous != null) {
out = previous + relative;
} else {
throw new PlaybackLoadException(currentTick, currentSubtick, "Can't process relative value ~%s in %s. Previous value for comparing is not available", intstring, name);
Expand All @@ -641,7 +765,7 @@ protected int deserialiseRelativeInt(String name, String intstring, Integer prev
}
return out;
}

protected float parseFloat(String name, String floatstring) {
try {
return Float.parseFloat(floatstring);
Expand All @@ -652,10 +776,10 @@ protected float parseFloat(String name, String floatstring) {

protected float deserialiseRelativeFloat(String name, String floatstring, Float previous) {
float out = 0;
if(floatstring.startsWith("~")) {
if (floatstring.startsWith("~")) {
floatstring = floatstring.replace("~", "");
float relative = parseFloat(name, floatstring);
if(previous != null) {
if (previous != null) {
out = previous + relative;
} else {
throw new PlaybackLoadException(currentTick, currentSubtick, "Can't process relative value ~%s in %s. Previous value for comparing is not available", floatstring, name);
Expand All @@ -665,7 +789,7 @@ protected float deserialiseRelativeFloat(String name, String floatstring, Float
}
return out;
}

protected void splitInputs(List<String> lines, List<String> serialisedKeyboard, List<String> serialisedMouse, List<String> serialisedCameraAngle, List<String> commentsAtEnd, List<List<PlaybackFileCommand>> endlineFileCommands) {

for (String line : lines) {
Expand Down Expand Up @@ -773,4 +897,7 @@ public static <T extends Serializable> void addAll(BigArrayList<T> list, List<T>
list.add(element);
}
}

@Override
protected abstract SerialiserFlavorBase clone();
}
2 changes: 1 addition & 1 deletion src/main/java/com/minecrafttas/tasmod/playback/tasfile/flavor/SerialiserFlavorRegistry.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public Set<String> getFlavorNames(){
}

public SerialiserFlavorBase getFlavor(String name) {
return REGISTRY.get(name);
return REGISTRY.get(name).clone();
}

public List<SerialiserFlavorBase> getFlavors() {
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/com/minecrafttas/tasmod/playback/tasfile/flavor/integrated/Beta1Flavor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,9 @@ protected List<String> serialiseMouse(VirtualMouse mouse) {
protected List<String> serialiseCameraAngle(VirtualCameraAngle cameraAngle) {
return null;
}

@Override
protected SerialiserFlavorBase clone() {
return new Beta1Flavor();
}
}
1 change: 1 addition & 0 deletions src/main/java/com/minecrafttas/tasmod/util/TASmodRegistry.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,5 @@ public class TASmodRegistry {
* The resulting flavor can be registered here and can be found as a saving option with /saveTAS
*/
public static final SerialiserFlavorRegistry SERIALISER_FLAVOR = new SerialiserFlavorRegistry();

}
Loading

0 comments on commit ccfd759

Please sign in to comment.