You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by sr...@apache.org on 2022/02/23 17:07:55 UTC

[plc4x] branch feature/cleaned-up-type-references updated: fix(codegen): small improvements

This is an automated email from the ASF dual-hosted git repository.

sruehl pushed a commit to branch feature/cleaned-up-type-references
in repository https://gitbox.apache.org/repos/asf/plc4x.git


The following commit(s) were added to refs/heads/feature/cleaned-up-type-references by this push:
     new d3a7113  fix(codegen): small improvements
d3a7113 is described below

commit d3a71139494dd72e079f687671db7d89e0f555b3
Author: Sebastian Rühl <sr...@apache.org>
AuthorDate: Wed Feb 23 18:07:45 2022 +0100

    fix(codegen): small improvements
---
 .../freemarker/FreemarkerLanguageOutput.java       |  1 +
 .../resources/templates/c/pojo-template.c.ftlh     | 11 +++++----
 .../model/references/DefaultEnumTypeReference.java |  1 -
 .../mspec/parser/MessageFormatListener.java        | 27 ++++++++++++----------
 .../apache/plc4x/protocol/test/TestProtocol.java   |  8 +++++--
 5 files changed, 28 insertions(+), 20 deletions(-)

diff --git a/code-generation/language-base-freemarker/src/main/java/org/apache/plc4x/plugins/codegenerator/protocol/freemarker/FreemarkerLanguageOutput.java b/code-generation/language-base-freemarker/src/main/java/org/apache/plc4x/plugins/codegenerator/protocol/freemarker/FreemarkerLanguageOutput.java
index c1a75b0..35e59a7 100644
--- a/code-generation/language-base-freemarker/src/main/java/org/apache/plc4x/plugins/codegenerator/protocol/freemarker/FreemarkerLanguageOutput.java
+++ b/code-generation/language-base-freemarker/src/main/java/org/apache/plc4x/plugins/codegenerator/protocol/freemarker/FreemarkerLanguageOutput.java
@@ -108,6 +108,7 @@ public abstract class FreemarkerLanguageOutput implements LanguageOutput {
             // Generate the output for the given type.
             LOGGER.info("Generating type {}", typeEntry.getKey());
             for (Template template : templateList) {
+                LOGGER.debug("Applying template {}", template.getName());
                 try {
                     renderTemplate(outputDir, template, typeContext);
                 } catch (IOException | TemplateException e) {
diff --git a/code-generation/language-c/src/main/resources/templates/c/pojo-template.c.ftlh b/code-generation/language-c/src/main/resources/templates/c/pojo-template.c.ftlh
index a5c393a..85f4f18 100644
--- a/code-generation/language-c/src/main/resources/templates/c/pojo-template.c.ftlh
+++ b/code-generation/language-c/src/main/resources/templates/c/pojo-template.c.ftlh
@@ -251,7 +251,7 @@ plc4c_return_code ${helper.getCTypeName(type.name)}_parse(plc4c_spi_read_buffer*
 <#if indentContent>  </#if>  // Discriminator Field (${discriminatorField.name}) (Used as input to a switch field)
 <#if indentContent>  </#if>  ${helper.getLanguageTypeNameForField(field)} ${discriminatorField.name} = ${helper.getNullValueForTypeReference(discriminatorField.type)};
 <#if indentContent>  </#if>  _res = ${helper.getReadBufferReadMethodCall(discriminatorField.type, "&" + discriminatorField.name, field)};
-        <#elseif helper.isEnumField(field)>
+        <#elseif field.isEnumField()>
             <#assign simpleTypeReference = discriminatorField.type>
 <#if indentContent>  </#if>  enum ${helper.getLanguageTypeNameForTypeReference(discriminatorField.type)} ${discriminatorField.name};
 <#if indentContent>  </#if>  _res = ${helper.getReadBufferReadMethodCall(helper.getEnumBaseTypeReference(discriminatorField.type), "&${discriminatorField.name}", field)};
@@ -388,12 +388,13 @@ plc4c_return_code ${helper.getCTypeName(type.name)}_parse(plc4c_spi_read_buffer*
                     <#list case.discriminatorValueTerms as discriminatorValueTerm>
                         <#if case.discriminatorValueTerms?size &gt; 1>(</#if>
                         <#assign discriminatorExpression=switchField.discriminatorExpressions[discriminatorValueTerm?index].asLiteral().orElseThrow().asVariableLiteral().orElseThrow()>
-                        <#assign discriminatorType=helper.getDiscriminatorTypes()[discriminatorExpression.discriminatorName].asNonSimpleTypeReference().orElseThrow()>
+                        <#assign discriminatorType=helper.getDiscriminatorTypes()[discriminatorExpression.discriminatorName]>
+                        <#if discriminatorType.isNonSimpleTypeReference()><#assign typeDefinition=discriminatorType.asNonSimpleTypeReference().orElseThrow().typeDefinition></#if>
                         ${helper.toVariableParseExpression(baseType, switchField, discriminatorExpression, parserArguments)} ==
-                        <#if helper.isEnumTypeReference(discriminatorType)>
-                            ${helper.getLanguageTypeNameForTypeReference(discriminatorType)}_${helper.toParseExpression(discriminatorType.typeDefinition, switchField, discriminatorValueTerm, parserArguments)?replace("plc4c_spi_evaluation_helper_", "")?upper_case}
+                        <#if discriminatorType.isEnumTypeReference()>
+                            ${helper.getLanguageTypeNameForTypeReference(discriminatorType)}_${helper.toParseExpression(typeDefinition, switchField, discriminatorValueTerm, parserArguments)?replace("plc4c_spi_evaluation_helper_", "")?upper_case}
                         <#else>
-                            ${helper.toParseExpression(discriminatorType.typeDefinition, switchField, discriminatorValueTerm, parserArguments)}
+                            ${helper.toParseExpression(typeDefinition, switchField, discriminatorValueTerm, parserArguments)}
                         </#if>
                         <#if case.discriminatorValueTerms?size &gt; 1>)</#if>
                         <#sep> && </#sep>
diff --git a/code-generation/protocol-base-mspec/src/main/java/org/apache/plc4x/plugins/codegenerator/language/mspec/model/references/DefaultEnumTypeReference.java b/code-generation/protocol-base-mspec/src/main/java/org/apache/plc4x/plugins/codegenerator/language/mspec/model/references/DefaultEnumTypeReference.java
index a611d26..4f0af1a 100644
--- a/code-generation/protocol-base-mspec/src/main/java/org/apache/plc4x/plugins/codegenerator/language/mspec/model/references/DefaultEnumTypeReference.java
+++ b/code-generation/protocol-base-mspec/src/main/java/org/apache/plc4x/plugins/codegenerator/language/mspec/model/references/DefaultEnumTypeReference.java
@@ -18,7 +18,6 @@
  */
 package org.apache.plc4x.plugins.codegenerator.language.mspec.model.references;
 
-import org.apache.plc4x.plugins.codegenerator.types.definitions.ComplexTypeDefinition;
 import org.apache.plc4x.plugins.codegenerator.types.definitions.EnumTypeDefinition;
 import org.apache.plc4x.plugins.codegenerator.types.definitions.TypeDefinition;
 import org.apache.plc4x.plugins.codegenerator.types.references.EnumTypeReference;
diff --git a/code-generation/protocol-base-mspec/src/main/java/org/apache/plc4x/plugins/codegenerator/language/mspec/parser/MessageFormatListener.java b/code-generation/protocol-base-mspec/src/main/java/org/apache/plc4x/plugins/codegenerator/language/mspec/parser/MessageFormatListener.java
index 796691e..2b8776f 100644
--- a/code-generation/protocol-base-mspec/src/main/java/org/apache/plc4x/plugins/codegenerator/language/mspec/parser/MessageFormatListener.java
+++ b/code-generation/protocol-base-mspec/src/main/java/org/apache/plc4x/plugins/codegenerator/language/mspec/parser/MessageFormatListener.java
@@ -713,8 +713,7 @@ public class MessageFormatListener extends MSpecBaseListener implements LazyType
         InputStream inputStream = IOUtils.toInputStream(expressionString, Charset.defaultCharset());
         ExpressionStringParser parser = new ExpressionStringParser(this, currentTypeName);
         try {
-            Term term = parser.parse(inputStream);
-            return term;
+            return parser.parse(inputStream);
         } catch (Exception e) {
             throw new RuntimeException("Error parsing expression: '" + expressionString + "'", e);
         }
@@ -738,31 +737,34 @@ public class MessageFormatListener extends MSpecBaseListener implements LazyType
     }
 
     private String unquoteString(String quotedString) {
-        if (quotedString != null && quotedString.length() >= 2) {
-            return quotedString.substring(1, quotedString.length() - 1);
+        if (quotedString == null || quotedString.length() < 2) {
+            return quotedString;
         }
-        return quotedString;
+        return quotedString.substring(1, quotedString.length() - 1);
     }
 
     private String getIdString(MSpecParser.IdExpressionContext ctx) {
-        if (ctx.id != null) {
-            return ctx.id.getText();
+        if (ctx.id == null) {
+            return null;
         }
-        return null;
+        return ctx.id.getText();
     }
 
     private String getExprString(MSpecParser.ExpressionContext ctx) {
-        if (ctx.expr != null) {
-            return ctx.expr.getText();
+        if (ctx.expr == null) {
+            return null;
         }
-        return null;
+        return ctx.expr.getText();
     }
 
     public void dispatchType(String typeName, TypeDefinition type) {
-        types.put(typeName, type);
         LOGGER.debug("dispatching {}:{}", typeName, type);
+
+        types.put(typeName, type);
+
         List<Consumer<TypeDefinition>> waitingConsumers = typeDefinitionConsumers.getOrDefault(typeName, new LinkedList<>());
         LOGGER.debug("{} waiting for {}", waitingConsumers.size(), typeName);
+
         Iterator<Consumer<TypeDefinition>> consumerIterator = waitingConsumers.iterator();
         while (consumerIterator.hasNext()) {
             Consumer<TypeDefinition> setter = consumerIterator.next();
@@ -776,6 +778,7 @@ public class MessageFormatListener extends MSpecBaseListener implements LazyType
     @Override
     public void setOrScheduleTypeDefinitionConsumer(String typeRefName, Consumer<TypeDefinition> setTypeDefinition) {
         LOGGER.debug("set or schedule {}", typeRefName);
+
         TypeDefinition typeDefinition = types.get(typeRefName);
         if (typeDefinition != null) {
             LOGGER.debug("{} present so setting for {}", typeRefName, setTypeDefinition);
diff --git a/code-generation/protocol-test/src/main/java/org/apache/plc4x/protocol/test/TestProtocol.java b/code-generation/protocol-test/src/main/java/org/apache/plc4x/protocol/test/TestProtocol.java
index b24b9ef..48f7b78b 100644
--- a/code-generation/protocol-test/src/main/java/org/apache/plc4x/protocol/test/TestProtocol.java
+++ b/code-generation/protocol-test/src/main/java/org/apache/plc4x/protocol/test/TestProtocol.java
@@ -37,10 +37,14 @@ public class TestProtocol implements Protocol {
     @Override
     public TypeContext getTypeContext() throws GenerationException {
         InputStream schemaInputStream = TestProtocol.class.getResourceAsStream("/protocols/test/test.mspec");
-        if(schemaInputStream == null) {
+        if (schemaInputStream == null) {
             throw new GenerationException("Error loading message-format schema for protocol '" + getName() + "'");
         }
-        return new MessageFormatParser().parse(schemaInputStream);
+        TypeContext typeContext = new MessageFormatParser().parse(schemaInputStream);
+        if (typeContext.getUnresolvedTypeReferences().size() > 0) {
+            throw new GenerationException("Unresolved types left: " + typeContext.getUnresolvedTypeReferences());
+        }
+        return typeContext;
     }
 
 }