fix(codegen): optional fields respect condition now on write

apache · May 16, 2022 · dd3b0cf · dd3b0cf
1 parent aa609ac
commit dd3b0cf
Show file tree

Hide file tree

Showing 749 changed files with 4,103 additions and 970 deletions.
diff --git a/code-generation/language-go/src/main/resources/templates/go/complex-type-template.go.ftlh b/code-generation/language-go/src/main/resources/templates/go/complex-type-template.go.ftlh
@@ -726,13 +726,15 @@ func (m *${type.name}) GetLengthInBytes() uint16 {
 <#assign hasParserArguments=parserArguments?has_content/>
 <#assign parserArgumentList><#if hasParserArguments><#list parserArguments as parserArgument>${parserArgument.name} <#if parserArgument.type.isNonSimpleTypeReference() && !parserArgument.type.isEnumTypeReference()>*</#if>${helper.getLanguageTypeNameForTypeReference(parserArgument.type)}<#sep>, </#sep></#list></#if></#assign>
 func ${type.name}Parse(readBuffer utils.ReadBuffer<#if hasParserArguments>, ${parserArgumentList}</#if>) (*${type.name}, error) {
+	positionAware := readBuffer
+	_ = positionAware
 	if pullErr := readBuffer.PullContext("${type.name}"); pullErr != nil {
 		return nil, pullErr
 	}
-	currentPos := readBuffer.GetPos()
+	currentPos := positionAware.GetPos()
 	_ = currentPos
 	<#if helper.requiresStartPosAndCurPos()>
-	var startPos = readBuffer.GetPos()
+	var startPos = positionAware.GetPos()
 	var curPos uint16
 	</#if>
 	<#list type.fields as field>
@@ -770,7 +772,7 @@ func ${type.name}Parse(readBuffer utils.ReadBuffer<#if hasParserArguments>, ${pa
 	}
 			<#-- Only update curPos if the length expression uses it -->
 					<#if arrayField.loopExpression.contains("curPos")>
-	curPos = readBuffer.GetPos() - startPos
+	curPos = positionAware.GetPos() - startPos
 					</#if>
 			<#-- If this is a count array, we can directly initialize an array with the given size -->
 					<#if field.isCountArrayField()>
@@ -826,16 +828,16 @@ func ${type.name}Parse(readBuffer utils.ReadBuffer<#if hasParserArguments>, ${pa
 	${arrayField.name} := make(${helper.getLanguageTypeNameForField(field)}, 0)
 	{
 		_${arrayField.name}Length := ${helper.toIntegerParseExpression(arrayField, 16, arrayField.loopExpression, parserArguments)}
-		_${arrayField.name}EndPos := readBuffer.GetPos() + uint16(_${arrayField.name}Length)
-		for ;readBuffer.GetPos() < _${arrayField.name}EndPos; {
+		_${arrayField.name}EndPos := positionAware.GetPos() + uint16(_${arrayField.name}Length)
+		for ;positionAware.GetPos() < _${arrayField.name}EndPos; {
 			_item, _err := <#if arrayElementType.isSimpleTypeReference()>${helper.getReadBufferReadMethodCall("", arrayElementType.asSimpleTypeReference().orElseThrow(), arrayField)}<#else>${arrayElementType.asComplexTypeReference().orElseThrow().name}Parse(readBuffer<#if arrayElementType.asComplexTypeReference().orElseThrow().params.isPresent()>, <#list arrayElementType.asComplexTypeReference().orElseThrow().params.orElseThrow() as parserArgument><#if <#--TODO: here DF1ResponseMessage throws a payloadLength not present: meaning that some feature is not rightfully implemented as the result should be a error not a missing pointer-->type.getPropertyFieldFromThisOrParentByName(parserArgument.name).isPresent() && type.getPropertyFieldFromThisOrParentByName(parserArgument.name).orElseThrow().isOptionalField()>*</#if>${helper.toTypedParseExpression(arrayField, helper.getArgumentType(arrayElementType, parserArgument?index), parserArgument, parserArguments)}<#sep>, </#sep></#list></#if>)</#if>
 			if _err != nil {
 				return nil, errors.Wrap(_err, "Error parsing '${arrayField.name}' field")<@emitImport import="github.com/pkg/errors" />
 			}
 			${arrayField.name} = append(${arrayField.name}, _item)
 						<#-- After parsing, update the current position, but only if it's needed -->
 							<#if arrayField.loopExpression.contains("curPos")>
-			curPos = readBuffer.GetPos() - startPos
+			curPos = positionAware.GetPos() - startPos
 							</#if>
 		}
 	}
@@ -883,7 +885,7 @@ func ${type.name}Parse(readBuffer utils.ReadBuffer<#if hasParserArguments>, ${pa
 
 						<#-- After parsing, update the current position, but only if it's needed -->
 							<#if arrayField.loopExpression.contains("curPos")>
-			curPos = readBuffer.GetPos() - startPos
+			curPos = positionAware.GetPos() - startPos
 							</#if>
 		}
 	}
@@ -1005,7 +1007,7 @@ func ${type.name}Parse(readBuffer utils.ReadBuffer<#if hasParserArguments>, ${pa
 	// Manual Array Field (${manualArrayField.name})
 			<#-- Only update curPos if the length expression uses it -->
 				<#if manualArrayField.loopExpression.contains("curPos")>
-	curPos = readBuffer.GetPos() - startPos
+	curPos = positionAware.GetPos() - startPos
 				</#if>
 			<#-- If this is a count array, we can directly initialize an array with the given size -->
 				<#if field.isCountArrayField()>
@@ -1022,12 +1024,12 @@ func ${type.name}Parse(readBuffer utils.ReadBuffer<#if hasParserArguments>, ${pa
 	// Length array
 	_${manualArrayField.name}Length := ${helper.toIntegerParseExpression(manualArrayField, 16, manualArrayField.loopExpression, parserArguments)}
 	_${manualArrayField.name}List := make(${helper.getLanguageTypeNameForField(manualArrayField)}, 0)
-	${manualArrayField.name}EndPos := readBuffer.GetPos() + _${manualArrayField.name}Length
-	for ;readBuffer.GetPos() < ${manualArrayField.name}EndPos; {
+	${manualArrayField.name}EndPos := positionAware.GetPos() + _${manualArrayField.name}Length
+	for ;positionAware.GetPos() < ${manualArrayField.name}EndPos; {
 		_${manualArrayField.name}List = append(_${manualArrayField.name}List, ((${helper.getLanguageTypeNameForField(field)}) (${helper.toParseExpression(manualArrayField, arrayElementType, manualArrayField.parseExpression, parserArguments)})))
 					<#-- After parsing, update the current position, but only if it's needed -->
 						<#if manualArrayField.loopExpression.contains("curPos")>
-		curPos = readBuffer.GetPos() - startPos
+		curPos = positionAware.GetPos() - startPos
 						</#if>
 	}
 					<#-- A terminated array keeps on reading data as long as the termination expression evaluates to false -->
@@ -1042,7 +1044,7 @@ func ${type.name}Parse(readBuffer utils.ReadBuffer<#if hasParserArguments>, ${pa
 
 					<#-- After parsing, update the current position, but only if it's needed -->
 						<#if manualArrayField.loopExpression.contains("curPos")>
-			curPos = readBuffer.GetPos() - startPos
+			curPos = positionAware.GetPos() - startPos
 						</#if>
 		}
 	}
@@ -1079,7 +1081,7 @@ func ${type.name}Parse(readBuffer utils.ReadBuffer<#if hasParserArguments>, ${pa
 
 	// Optional Field (${optionalField.name}) (Can be skipped, if a given expression evaluates to false)
 				<#if optionalField.conditionExpression.present && optionalField.conditionExpression.get().contains("curPos")>
-	curPos = readBuffer.GetPos() - startPos
+	curPos = positionAware.GetPos() - startPos
 				</#if>
 	var ${optionalField.name} *${helper.getLanguageTypeNameForField(field)} = nil
 	<#if optionalField.conditionExpression.present>
@@ -1103,7 +1105,7 @@ func ${type.name}Parse(readBuffer utils.ReadBuffer<#if hasParserArguments>, ${pa
 			return nil, closeErr
 		}
 			<#else>
-		currentPos = readBuffer.GetPos()
+		currentPos = positionAware.GetPos()
 		if pullErr := readBuffer.PullContext("${optionalField.name}"); pullErr != nil {
 			return nil, pullErr
 		}
@@ -1148,7 +1150,7 @@ func ${type.name}Parse(readBuffer utils.ReadBuffer<#if hasParserArguments>, ${pa
 
 	// Assert Field (${assertField.name}) (Can be skipped, if a given expression evaluates to false)
 				<#if assertField.conditionExpression.contains("curPos")>
-	curPos = readBuffer.GetPos() - startPos
+	curPos = positionAware.GetPos() - startPos
 				</#if>
 			<#if assertField.type.isSimpleTypeReference()>
 	${assertField.name}, _err := ${helper.getReadBufferReadMethodCall(assertField.name, assertField.type.asSimpleTypeReference().orElseThrow(), assertField)}
@@ -1372,13 +1374,13 @@ func ${type.name}Parse(readBuffer utils.ReadBuffer<#if hasParserArguments>, ${pa
 
 				// Peek Field (${peekField.name})
                 <#if peekField.type.isSimpleTypeReference()>
-				currentPos = readBuffer.GetPos()
+				currentPos = positionAware.GetPos()
 				${peekField.name}, _err := ${helper.getReadBufferReadMethodCall(peekField.name, peekField.type.asSimpleTypeReference().orElseThrow(), peekField)}
 				if _err != nil {
 					return nil, errors.Wrap(_err, "Error parsing '${peekField.name}' field")<@emitImport import="github.com/pkg/errors" />
 				}
                 <#elseif helper.isEnumField(field)>
-				currentPos = readBuffer.GetPos()
+				currentPos = positionAware.GetPos()
 				if pullErr := readBuffer.PullContext("${peekField.name}"); pullErr != nil {
 					return nil, pullErr
 				}
@@ -1390,7 +1392,7 @@ func ${type.name}Parse(readBuffer utils.ReadBuffer<#if hasParserArguments>, ${pa
 					return nil, closeErr
 				}
                 <#else>
-				currentPos = readBuffer.GetPos()
+				currentPos = positionAware.GetPos()
 				if pullErr := readBuffer.PullContext("${peekField.name}"); pullErr != nil {
 					return nil, pullErr
 				}
@@ -1464,6 +1466,8 @@ func (m *${type.name}) SerializeParent(writeBuffer utils.WriteBuffer, child I${t
 <#else>
 func (m *${type.name}) Serialize(writeBuffer utils.WriteBuffer) error {
 </#if>
+	positionAware := writeBuffer
+	_ = positionAware
 	<#if helper.hasFieldOfType("unknown")>
 	return errors.New("Unknown field not serializable")
 	<#else>

diff --git a/...anguage-java/src/main/java/org/apache/plc4x/language/java/JavaLanguageTemplateHelper.java b/...anguage-java/src/main/java/org/apache/plc4x/language/java/JavaLanguageTemplateHelper.java
@@ -690,7 +690,7 @@ private String toLiteralTermExpression(Field field, TypeReference resultType, Li
             tracer = tracer.dive("variable literal instanceOf");
             VariableLiteral variableLiteral = (VariableLiteral) literal;
             if ("curPos".equals(((VariableLiteral) literal).getName())) {
-                return "(readBuffer.getPos() - startPos)";
+                return "(positionAware.getPos() - startPos)";
             }
             // If this literal references an Enum type, then we have to output it differently.
             if (getTypeDefinitions().get(variableLiteral.getName()) instanceof EnumTypeDefinition) {

diff --git a/...eneration/language-java/src/main/resources/templates/java/complex-type-template.java.ftlh b/...eneration/language-java/src/main/resources/templates/java/complex-type-template.java.ftlh
@@ -229,10 +229,11 @@ public<#if type.isDiscriminatedParentTypeDefinition()> abstract</#if> class ${ty
     </#if>
     public void serialize(WriteBuffer writeBuffer) throws SerializationException {
 </#if>
+        PositionAware positionAware = writeBuffer;
         <#if helper.hasFieldOfType("unknown")>
             throw new SerializationException("Unknown field not serializable");
         <#else>
-            int startPos = writeBuffer.getPos();
+            int startPos = positionAware.getPos();
             writeBuffer.pushContext("${type.name}");
             <#list type.fields as field>
                 <#switch field.typeName>
@@ -315,11 +316,11 @@ public<#if type.isDiscriminatedParentTypeDefinition()> abstract</#if> class ${ty
 
                         // Optional Field (${optionalField.name}) (Can be skipped, if the value is null)
                         <#if optionalField.type.isEnumTypeReference()>
-                            writeOptionalEnumField("${optionalField.name}", "${helper.getLanguageTypeNameForField(field)}", ${optionalField.name}, ${helper.getEnumDataWriterCall(optionalField.type, optionalField.name, "value")});
+                            writeOptionalEnumField("${optionalField.name}", "${helper.getLanguageTypeNameForField(field)}", ${optionalField.name}, ${helper.getEnumDataWriterCall(optionalField.type, optionalField.name, "value")}<#if optionalField.conditionExpression.present>, ${helper.toSerializationExpression(optionalField, helper.boolTypeReference, optionalField.conditionExpression.get(), parserArguments)}</#if>);
                         <#elseif optionalField.type.isDataIoTypeReference()>
-                            writeOptionalField("${optionalField.name}", ${optionalField.name}, new DataWriterDataIoDefault(writeBuffer, (wb, val) -> ${optionalField.type.asComplexTypeReference().orElseThrow().name}.staticSerialize(wb, val<#if optionalField.type.asComplexTypeReference().orElseThrow().params?has_content>, <#list optionalField.type.asComplexTypeReference().orElseThrow().params.orElseThrow() as param>${helper.toParseExpression(optionalField, helper.anyTypeReference, param, parserArguments)}<#sep>, </#sep></#list></#if>)));
+                            writeOptionalField("${optionalField.name}", ${optionalField.name}, new DataWriterDataIoDefault(writeBuffer, (wb, val) -> ${optionalField.type.asComplexTypeReference().orElseThrow().name}.staticSerialize(wb, val<#if optionalField.type.asComplexTypeReference().orElseThrow().params?has_content>, <#list optionalField.type.asComplexTypeReference().orElseThrow().params.orElseThrow() as param>${helper.toParseExpression(optionalField, helper.anyTypeReference, param, parserArguments)}<#sep>, </#sep></#list></#if>))<#if optionalField.conditionExpression.present>, ${helper.toSerializationExpression(optionalField, helper.boolTypeReference, optionalField.conditionExpression.get(), parserArguments)}</#if>);
                         <#else>
-                            writeOptionalField("${optionalField.name}", ${optionalField.name}, ${helper.getDataWriterCall(typedField.type, optionalField.name)});
+                            writeOptionalField("${optionalField.name}", ${optionalField.name}, ${helper.getDataWriterCall(typedField.type, optionalField.name)}<#if optionalField.conditionExpression.present>, ${helper.toSerializationExpression(optionalField, helper.boolTypeReference, optionalField.conditionExpression.get(), parserArguments)}</#if>);
                         </#if>
                         <#break>
                     <#case "padding">
@@ -555,6 +556,7 @@ public<#if type.isDiscriminatedParentTypeDefinition()> abstract</#if> class ${ty
 <#-- The parse and serialize methods here are just proxies for forwardning the requests to static counterparts -->
     <#if !type.isDiscriminatedChildTypeDefinition()>
     public static ${type.name} staticParse(ReadBuffer readBuffer, Object... args) throws ParseException {
+        PositionAware positionAware = readBuffer;
         <#if parserArguments?has_content>
         if((args == null) || (args.length != ${parserArguments?size})) {
             throw new PlcRuntimeException("Wrong number of arguments, expected ${parserArguments?size}, but got " + args.length);
@@ -582,7 +584,8 @@ public<#if type.isDiscriminatedParentTypeDefinition()> abstract</#if> class ${ty
     <#assign parserArgumentList><#if hasParserArguments><#list parserArguments as parserArgument>${helper.getLanguageTypeNameForTypeReference(parserArgument.type, false)} ${parserArgument.name}<#sep>, </#sep></#list></#if></#assign>
     public static ${type.name}<#if type.isDiscriminatedChildTypeDefinition()>Builder staticParseBuilder<#else> staticParse</#if>(ReadBuffer readBuffer<#if hasParserArguments>, ${parserArgumentList}</#if>) throws ParseException {
         readBuffer.pullContext("${type.name}");
-        int startPos = readBuffer.getPos();
+        PositionAware positionAware = readBuffer;
+        int startPos = positionAware.getPos();
         int curPos;
     <#list type.fields as field>
         <#switch field.typeName>

diff --git a/plc4go/internal/plc4go/abeth/readwrite/model/CIPEncapsulationConnectionRequest.go b/plc4go/internal/plc4go/abeth/readwrite/model/CIPEncapsulationConnectionRequest.go
diff --git a/plc4go/internal/plc4go/abeth/readwrite/model/CIPEncapsulationConnectionResponse.go b/plc4go/internal/plc4go/abeth/readwrite/model/CIPEncapsulationConnectionResponse.go
diff --git a/plc4go/internal/plc4go/abeth/readwrite/model/CIPEncapsulationPacket.go b/plc4go/internal/plc4go/abeth/readwrite/model/CIPEncapsulationPacket.go
diff --git a/plc4go/internal/plc4go/abeth/readwrite/model/CIPEncapsulationReadRequest.go b/plc4go/internal/plc4go/abeth/readwrite/model/CIPEncapsulationReadRequest.go
diff --git a/plc4go/internal/plc4go/abeth/readwrite/model/CIPEncapsulationReadResponse.go b/plc4go/internal/plc4go/abeth/readwrite/model/CIPEncapsulationReadResponse.go
diff --git a/plc4go/internal/plc4go/abeth/readwrite/model/DF1CommandRequestMessage.go b/plc4go/internal/plc4go/abeth/readwrite/model/DF1CommandRequestMessage.go