Skip to content

Commit

Permalink
feat(plc4j/codegen): render virtual fields in boxes
Browse files Browse the repository at this point in the history
  • Loading branch information
@sruehl
sruehl committed Dec 2, 2021
1 parent 37ebe6a commit 17086bd
Show file tree
Hide file tree
Showing 6 changed files with 190 additions and 111 deletions.
1 change: 1 addition & 0 deletions code-generation/language-java/src/main/resources/templates/java/pojo-template.java.ftlh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,7 @@ public<#if type.isDiscriminatedParentTypeDefinition()> abstract</#if> class ${ty

// Virtual field (doesn't actually serialize anything, just makes the value available)
${helper.getLanguageTypeNameForField(field)} ${namedField.name} = get${namedField.name?cap_first}();
writeBuffer.writeVirtual("${namedField.name}", ${namedField.name});
<#break>
</#switch>
</#list>
Expand Down
4 changes: 4 additions & 0 deletions plc4j/spi/src/main/java/org/apache/plc4x/java/spi/generation/WriteBuffer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,10 @@ default void writeBigDecimal(int bitLength, BigDecimal value) throws Serializati

void writeString(String logicalName, int bitLength, String encoding, String value, WithWriterArgs... writerArgs) throws SerializationException;

default void writeVirtual(String logicalName, Object value, WithWriterArgs... writerArgs) throws SerializationException {
// No-Op
}

default void writeString(int bitLength, String encoding, String value) throws SerializationException {
writeString("", bitLength, encoding, value);
}
Expand Down
91 changes: 65 additions & 26 deletions plc4j/spi/src/main/java/org/apache/plc4x/java/spi/generation/WriteBufferBoxBased.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@

import io.vavr.control.Either;
import org.apache.commons.lang3.StringUtils;
import org.apache.plc4x.java.spi.utils.Serializable;
import org.apache.plc4x.java.spi.utils.ascii.AsciiBox;
import org.apache.plc4x.java.spi.utils.ascii.AsciiBoxWriter;
import org.apache.plc4x.java.spi.utils.hex.Hex;

import java.math.BigDecimal;
Expand All @@ -30,21 +32,28 @@
import java.util.LinkedList;
import java.util.Deque;

import static org.apache.plc4x.java.spi.utils.ascii.AsciiBoxUtils.*;

public class WriteBufferBoxBased implements WriteBuffer, BufferCommons {

private Deque<Either<AsciiBox, Deque<AsciiBox>>> boxes = new LinkedList<>();
private int desiredWidth = 120;
private int currentWidth = 118;
private boolean mergeSingleBoxes;
private boolean omitEmptyBoxes;
private final Deque<Either<AsciiBox, Deque<AsciiBox>>> boxes = new LinkedList<>();
private final AsciiBoxWriter asciiBoxWriter;
private final AsciiBoxWriter asciiBoxWriterLight;
private final int desiredWidth = 120;
private final boolean mergeSingleBoxes;
private final boolean omitEmptyBoxes;
private int currentWidth = desiredWidth - 2;

public WriteBufferBoxBased() {

this(false, false);
}

public WriteBufferBoxBased(boolean mergeSingleBoxes, boolean omitEmptyBoxes) {
this(AsciiBoxWriter.DEFAULT, AsciiBoxWriter.LIGHT, mergeSingleBoxes, omitEmptyBoxes);
}


private WriteBufferBoxBased(AsciiBoxWriter asciiBoxWriter, AsciiBoxWriter asciiBoxWriterLight, boolean mergeSingleBoxes, boolean omitEmptyBoxes) {
this.asciiBoxWriter = asciiBoxWriter;
this.asciiBoxWriterLight = asciiBoxWriterLight;
this.mergeSingleBoxes = mergeSingleBoxes;
this.omitEmptyBoxes = omitEmptyBoxes;
}
Expand Down Expand Up @@ -74,13 +83,13 @@ public void pushContext(String logicalName, WithWriterArgs... writerArgs) {
@Override
public void writeBit(String logicalName, boolean value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("b%d %b%s", value ? 1 : 0, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("b%d %b%s", value ? 1 : 0, value, additionalStringRepresentation), 0)));
}

@Override
public void writeByte(String logicalName, byte value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("%02x%s", value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("%02x%s", value, additionalStringRepresentation), 0)));
}

@Override
Expand All @@ -89,91 +98,121 @@ public void writeByteArray(String logicalName, byte[] bytes, WithWriterArgs... w
if (StringUtils.isNotBlank(additionalStringRepresentation)) {
additionalStringRepresentation += "\n";
}
boxes.offerLast(Either.left(boxString(logicalName, String.format("%s%s", Hex.dump(bytes), additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("%s%s", Hex.dump(bytes), additionalStringRepresentation), 0)));
}

@Override
public void writeUnsignedByte(String logicalName, int bitLength, byte value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeUnsignedShort(String logicalName, int bitLength, short value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeUnsignedInt(String logicalName, int bitLength, int value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeUnsignedLong(String logicalName, int bitLength, long value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeUnsignedBigInteger(String logicalName, int bitLength, BigInteger value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeSignedByte(String logicalName, int bitLength, byte value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeShort(String logicalName, int bitLength, short value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeInt(String logicalName, int bitLength, int value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeLong(String logicalName, int bitLength, long value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeBigInteger(String logicalName, int bitLength, BigInteger value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeFloat(String logicalName, int bitLength, float value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeDouble(String logicalName, int bitLength, double value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeBigDecimal(String logicalName, int bitLength, BigDecimal value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("0x%0" + Math.max(bitLength / 4, 1) + "x %d%s", value, value, additionalStringRepresentation), 0)));
}

@Override
public void writeString(String logicalName, int bitLength, String encoding, String value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
boxes.offerLast(Either.left(boxString(logicalName, String.format("%s%s", value, additionalStringRepresentation), 0)));
boxes.offerLast(Either.left(asciiBoxWriter.boxString(logicalName, String.format("%s%s", value, additionalStringRepresentation), 0)));
}

@Override
public void writeVirtual(String logicalName, Object value, WithWriterArgs... writerArgs) throws SerializationException {
String additionalStringRepresentation = extractAdditionalStringRepresentation(writerArgs).map(s -> " " + s).orElse("");
AsciiBox virtualBox;
if (value instanceof String) {
virtualBox = asciiBoxWriterLight.boxString(logicalName, String.format("%s%s", value, additionalStringRepresentation), 0);
} else if (value instanceof Number) {
// TODO: adjust rendering
Number number = (Number) value;
virtualBox = asciiBoxWriterLight.boxString(logicalName, String.format("0x%x %d%s", number, number, additionalStringRepresentation), 0);
} else if (value instanceof Boolean) {
virtualBox = asciiBoxWriterLight.boxString(logicalName, String.format("b%d %b%s", (Boolean) value ? 1 : 0, value, additionalStringRepresentation), 0);
} else if (value instanceof Enum) {
Enum<?> enumValue = (Enum<?>) value;
virtualBox = asciiBoxWriterLight.boxString(logicalName, String.format("%s%s", enumValue.name(), additionalStringRepresentation), 0);
} else if (value instanceof Serializable) {
Serializable serializable = (Serializable) value;
try {
WriteBufferBoxBased writeBuffer = new WriteBufferBoxBased(asciiBoxWriterLight, asciiBoxWriterLight, true, true);
serializable.serialize(writeBuffer);
virtualBox = asciiBoxWriterLight.boxBox(logicalName, writeBuffer.getBox(), 0);
} catch (SerializationException e) {
virtualBox = asciiBoxWriterLight.boxString(logicalName, e.getMessage(), 0);
}
} else {
virtualBox = asciiBoxWriterLight.boxString(logicalName, "un-renderable", 0);
}
boxes.offerLast(Either.left(virtualBox));
}

@Override
Expand Down Expand Up @@ -208,7 +247,7 @@ public void popContext(String logicalName, WithWriterArgs... writerArgs) {
boxes.offerLast(Either.left(onlyChild));
return;
}
AsciiBox asciiBox = boxBox(logicalName, alignBoxes(finalBoxes, currentWidth), 0);
AsciiBox asciiBox = asciiBoxWriter.boxBox(logicalName, asciiBoxWriter.alignBoxes(finalBoxes, currentWidth), 0);
if (omitEmptyBoxes && asciiBox.isEmpty()) {
return;
}
Expand Down
28 changes: 17 additions & 11 deletions plc4j/spi/src/main/java/org/apache/plc4x/java/spi/utils/ascii/AsciiBox.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,18 @@
import java.util.Objects;
import java.util.regex.Matcher;

import static org.apache.plc4x.java.spi.utils.ascii.AsciiBoxUtils.*;

public class AsciiBox {
private final AsciiBoxWriter asciiBoxWriter;

private final String data;

public AsciiBox(String data) {
protected AsciiBox(String data) {
asciiBoxWriter = AsciiBoxWriter.DEFAULT;
this.data = data;
}

protected AsciiBox(AsciiBoxWriter asciiBoxWriter, String data) {
this.asciiBoxWriter = asciiBoxWriter;
this.data = data;
}

Expand Down Expand Up @@ -62,25 +68,25 @@ public String[] lines() {
}

public String getBoxName() {
Matcher matcher = boxNameRegex.matcher(data);
Matcher matcher = asciiBoxWriter.boxNameRegex.matcher(data);
if (!matcher.find()) {
return "";
}
return matcher.group("name");
}

public AsciiBox changeBoxName(String newName) {
if (!hasBorders(this)) {
return boxString(newName, this.toString(), 0);
if (!asciiBoxWriter.hasBorders(this)) {
return asciiBoxWriter.boxString(newName, this.toString(), 0);
}
int minimumWidthWithNewName = (upperLeftCorner + horizontalLine + newName + upperRightCorner).length();
int nameLengthDifference = minimumWidthWithNewName - (unwrap(this).width() + borderWidth + borderWidth);
return boxString(newName, unwrap(this).toString(), this.width() + nameLengthDifference);
int minimumWidthWithNewName = (asciiBoxWriter.upperLeftCorner + asciiBoxWriter.horizontalLine + newName + asciiBoxWriter.upperRightCorner).length();
int nameLengthDifference = minimumWidthWithNewName - (asciiBoxWriter.unwrap(this).width() + asciiBoxWriter.borderWidth + asciiBoxWriter.borderWidth);
return asciiBoxWriter.boxString(newName, asciiBoxWriter.unwrap(this).toString(), this.width() + nameLengthDifference);
}

public boolean isEmpty() {
if (hasBorders(this)) {
return StringUtils.isBlank(unwrap(this).toString());
if (asciiBoxWriter.hasBorders(this)) {
return StringUtils.isBlank(asciiBoxWriter.unwrap(this).toString());
}
return StringUtils.isBlank(this.toString());
}
Expand Down
Loading

0 comments on commit 17086bd

Please sign in to comment.