fix(plc4j/codgen): add byte order to read/writer, add enum example

apache · Oct 8, 2021 · 5f268d3 · 5f268d3
1 parent 72852a0
commit 5f268d3
Show file tree

Hide file tree

Showing 24 changed files with 224 additions and 8 deletions.
diff --git a/code-generation/language-java-ng/src/main/resources/templates/java/io-template.java.ftlh b/code-generation/language-java-ng/src/main/resources/templates/java/io-template.java.ftlh
@@ -323,10 +323,7 @@ public class ${type.name}IO implements <#if outputFlavor != "passive">MessageIO<
 
         FieldReader${field.typeName?cap_first}.INSTANCE.read${field.typeName?cap_first}Field(String logicalName, new DataReaderSimple${helper.getLanguageTypeNameForTypeReference(simpleTypeReference, false)}(readBuffer), ${type.name}.${constField.name?upper_case}))
         <#else>
-        ${helper.getLanguageTypeNameForField(field)} ${constField.name} = ${helper.getLanguageTypeNameForField(field)}.enumForValue(${helper.getReadBufferReadMethodCall(constField.name, helper.getEnumBaseTypeReference(constField.type), "", constField)});
-        if(${constField.name} != ${type.name}.${constField.name?upper_case}) {
-            throw new ParseException("Expected constant value " + ${type.name}.${constField.name?upper_case} + " but got " + ${constField.name});
-        }
+        FieldReader${field.typeName?cap_first}.INSTANCE.read${field.typeName?cap_first}Field(String logicalName, new DataReaderEnumDefault(${helper.getLanguageTypeNameForField(field)}::enumForValue, new DataReaderSimple${helper.getLanguageTypeNameForTypeReference(simpleTypeReference, false)}(readBuffer), ${type.name}.${constField.name?upper_case})))
         </#if>
         <#break>
     <#case "discriminator">

diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderComplexDefault.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderComplexDefault.java
@@ -18,6 +18,7 @@
  */
 package org.apache.plc4x.java.spi.codegen.io;
 
+import org.apache.plc4x.java.spi.generation.ByteOrder;
 import org.apache.plc4x.java.spi.generation.ParseException;
 import org.apache.plc4x.java.spi.generation.ReadBuffer;
 import org.apache.plc4x.java.spi.generation.WithReaderArgs;
@@ -45,6 +46,16 @@ public void setPos(int position) {
         readBuffer.reset(position);
     }
 
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
+
     @Override
     public T read(String logicalName, WithReaderArgs... readerArgs) throws ParseException {
         return read(logicalName, complexSupplier, readerArgs);

diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderEnum.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderEnum.java
@@ -21,7 +21,7 @@
 import org.apache.plc4x.java.spi.generation.ParseException;
 import org.apache.plc4x.java.spi.generation.WithReaderArgs;
 
-public interface DataReaderEnum<T> extends DataReader {
+public interface DataReaderEnum<T> extends DataReader<T> {
 
     T read(String logicalName, WithReaderArgs... readerArgs) throws ParseException;
 

diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderEnumDefault.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderEnumDefault.java
@@ -18,7 +18,7 @@
  */
 package org.apache.plc4x.java.spi.codegen.io;
 
-import org.apache.plc4x.java.spi.codegen.WithOption;
+import org.apache.plc4x.java.spi.generation.ByteOrder;
 import org.apache.plc4x.java.spi.generation.ParseException;
 import org.apache.plc4x.java.spi.generation.WithReaderArgs;
 
@@ -44,6 +44,16 @@ public void setPos(int position) {
         dataReader.setPos(position);
     }
 
+    @Override
+    public ByteOrder getByteOrder() {
+        return dataReader.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        dataReader.setByteOrder(byteOrder);
+    }
+
     @Override
     public T read(String logicalName, WithReaderArgs... readerArgs) throws ParseException {
         return read(logicalName, enumResolver, readerArgs);

diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleBigDecimal.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleBigDecimal.java
@@ -43,4 +43,13 @@ public void setPos(int position) {
         readBuffer.reset(position);
     }
 
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleBoolean.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleBoolean.java
@@ -45,4 +45,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleByte.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleByte.java
@@ -43,4 +43,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleByteArray.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleByteArray.java
@@ -43,4 +43,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleDouble.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleDouble.java
@@ -40,4 +40,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleFloat.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleFloat.java
@@ -40,4 +40,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/.../src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleSignedBigInteger.java b/.../src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleSignedBigInteger.java
@@ -42,4 +42,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleSignedByte.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleSignedByte.java
@@ -40,4 +40,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleSignedInt.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleSignedInt.java
@@ -40,4 +40,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleSignedLong.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleSignedLong.java
@@ -40,4 +40,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/...j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleSignedShort.java b/...j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleSignedShort.java
@@ -40,4 +40,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/...rc/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleUnsignedBigInteger.java b/...rc/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleUnsignedBigInteger.java
@@ -42,4 +42,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/.../spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleUnsignedByte.java b/.../spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleUnsignedByte.java
@@ -40,4 +40,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/...j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleUnsignedInt.java b/...j/spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleUnsignedInt.java
@@ -40,4 +40,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/.../spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleUnsignedLong.java b/.../spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleUnsignedLong.java
@@ -40,4 +40,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/...spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleUnsignedShort.java b/...spi/src/main/java/org/apache/plc4x/java/spi/codegen/io/DataReaderSimpleUnsignedShort.java
@@ -29,7 +29,7 @@ public DataReaderSimpleUnsignedShort(ReadBuffer readBuffer) {
     }
 
     @Override
-    public Short read(String logicalName, int bitLength, WithReaderArgs... readerArgs) throws ParseException  {
+    public Short read(String logicalName, int bitLength, WithReaderArgs... readerArgs) throws ParseException {
         return readBuffer.readUnsignedShort(logicalName, bitLength, readerArgs);
     }
 
@@ -40,4 +40,14 @@ public int getPos() {
     public void setPos(int position) {
         readBuffer.reset(position);
     }
+
+    @Override
+    public ByteOrder getByteOrder() {
+        return readBuffer.getByteOrder();
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        readBuffer.setByteOrder(byteOrder);
+    }
 }
diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/generation/ReadBuffer.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/generation/ReadBuffer.java
@@ -28,6 +28,10 @@ public interface ReadBuffer {
 
     boolean hasMore(int numBits);
 
+    ByteOrder getByteOrder();
+
+    void setByteOrder(ByteOrder byteOrder);
+
     void pullContext(String logicalName, WithReaderArgs... readerArgs);
 
     boolean readBit(String logicalName, WithReaderArgs... readerArgs) throws ParseException;

diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/generation/ReadBufferByteBased.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/generation/ReadBufferByteBased.java
@@ -26,18 +26,21 @@
 import java.math.BigDecimal;
 import java.math.BigInteger;
 import java.nio.charset.Charset;
+import java.util.Objects;
 
 public class ReadBufferByteBased implements ReadBuffer {
 
     private final MyDefaultBitInput bi;
-    private final ByteOrder byteOrder;
+    private ByteOrder byteOrder;
     private final long totalBytes;
 
     public ReadBufferByteBased(byte[] input) {
         this(input, ByteOrder.BIG_ENDIAN);
     }
 
     public ReadBufferByteBased(byte[] input, ByteOrder byteOrder) {
+        Objects.requireNonNull(input);
+        Objects.requireNonNull(byteOrder);
         ArrayByteInput abi = new ArrayByteInput(input);
         this.bi = new MyDefaultBitInput(abi);
         this.byteOrder = byteOrder;
@@ -70,6 +73,16 @@ public boolean hasMore(int numBits) {
         return (numBits / 8) <= (totalBytes - getPos());
     }
 
+    @Override
+    public ByteOrder getByteOrder() {
+        return byteOrder;
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        this.byteOrder = byteOrder;
+    }
+
     public byte peekByte(int offset) throws ParseException {
         // Remember the old index.
         int oldIndex = bi.getDelegate().getIndex();

diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/generation/ReadBufferJsonBased.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/generation/ReadBufferJsonBased.java
@@ -72,6 +72,17 @@ public boolean hasMore(int numBits) {
         return false;
     }
 
+    @Override
+    public ByteOrder getByteOrder() {
+        // NO OP
+        return ByteOrder.BIG_ENDIAN;
+    }
+
+    @Override
+    public void setByteOrder(ByteOrder byteOrder) {
+        // NO OP
+    }
+
     @Override
     public void pullContext(String logicalName, WithReaderArgs... readerArgs) {
         logicalName = sanitizeLogicalName(logicalName);