SPI 3 Refactoring #2382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

chrisdutz wants to merge 61 commits into develop from refactor/spi3

The diff you're trying to view is too large. We only load the first 3000 changed files.

code-generation/language/java-jp/pom.xml

-Original file line number
+Diff line change
@@ -0,0 +1,150 @@
+    <?xml version="1.0" encoding="UTF-8"?>
+    <!--
+      Licensed to the Apache Software Foundation (ASF) under one
+      or more contributor license agreements.  See the NOTICE file
+      distributed with this work for additional information
+      regarding copyright ownership.  The ASF licenses this file
+      to you under the Apache License, Version 2.0 (the
+      "License"); you may not use this file except in compliance
+      with the License.  You may obtain a copy of the License at
+          https://www.apache.org/licenses/LICENSE-2.0
+      Unless required by applicable law or agreed to in writing,
+      software distributed under the License is distributed on an
+      "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+      KIND, either express or implied.  See the License for the
+      specific language governing permissions and limitations
+      under the License.
+      -->
+    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+      <modelVersion>4.0.0</modelVersion>
+      <parent>
+        <groupId>org.apache.plc4x</groupId>
+        <artifactId>plc4x-code-generation-language</artifactId>
+        <version>0.14.0-SNAPSHOT</version>
+      </parent>
+      <artifactId>plc4x-code-generation-language-java-jp</artifactId>
+      <name>Code-Generation: Language: Java (JavaPoet)</name>
+      <description>Code generation template for generating Java code (JavaPoet based version for SPI3)</description>
+      <properties>
+        <project.build.outputTimestamp>2025-08-02T13:55:11Z</project.build.outputTimestamp>
+      </properties>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-surefire-plugin</artifactId>
+            <configuration>
+              <skip>true</skip>
+            </configuration>
+          </plugin>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-invoker-plugin</artifactId>
+            <executions>
+              <execution>
+                <id>integration-test</id>
+                <goals>
+                  <!-- Install the current project artifacts into the maven local repo, so they can be used in the test -->
+                  <goal>install</goal>
+                  <!-- Execute the maven builds defines in src/test/resources -->
+                  <goal>integration-test</goal>
+                  <!-- Checks the results of the maven builds -->
+                  <goal>verify</goal>
+                </goals>
+                <configuration>
+                  <skipInvocation>${skip-code-generation-tests}</skipInvocation>
+                  <debug>true</debug>
+                  <!-- Use the "test" scope for filling the tests local repository -->
+                  <scope>test</scope>
+                  <streamLogsOnFailures>true</streamLogsOnFailures>
+                  <localRepositoryPath>${project.build.directory}/local-repo</localRepositoryPath>
+                  <projectsDirectory>src/test/resources</projectsDirectory>
+                  <cloneProjectsTo>${project.build.directory}/integration-tests</cloneProjectsTo>
+                  <settingsFile>src/test/resources/settings.xml</settingsFile>
+                  <extraArtifacts>
+                    <extraArtifact>org.apache.plc4x.plugins:plc4x-code-generation-language-base:${plc4x-code-generation.version}</extraArtifact>
+                    <extraArtifact>org.apache.plc4x.plugins:plc4x-maven-plugin:${plc4x-code-generation.version}</extraArtifact>
+                    <extraArtifact>org.apache.plc4x.plugins:plc4x-code-generation-protocol-base:${plc4x-code-generation.version}</extraArtifact>
+                    <extraArtifact>org.apache.plc4x.plugins:plc4x-code-generation-types-base:${plc4x-code-generation.version}</extraArtifact>
+                  </extraArtifacts>
+                  <pomIncludes>
+                    <pomInclude>*/pom.xml</pomInclude>
+                  </pomIncludes>
+                  <mavenOpts>--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED</mavenOpts>
+                  <!-- The goals we will be executing in the test-projects -->
+                  <goals>
+                    <goal>test</goal>
+                  </goals>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+      <dependencies>
+        <!-- PLC4J API -->
+        <dependency>
+          <groupId>org.apache.plc4x</groupId>
+          <artifactId>plc4j-api</artifactId>
+          <version>0.14.0-SNAPSHOT</version>
+        </dependency>
+        <!-- Logging -->
+        <dependency>
+          <groupId>org.slf4j</groupId>
+          <artifactId>slf4j-api</artifactId>
+        </dependency>
+        <!-- PLC4X Code Generation Dependencies -->
+        <dependency>
+          <groupId>org.apache.plc4x</groupId>
+          <artifactId>plc4x-code-generation-protocol-base-mspec</artifactId>
+          <version>0.14.0-SNAPSHOT</version>
+        </dependency>
+        <dependency>
+          <groupId>org.apache.plc4x.plugins</groupId>
+          <artifactId>plc4x-code-generation-types-base</artifactId>
+          <version>${plc4x-code-generation.version}</version>
+        </dependency>
+        <dependency>
+          <groupId>org.apache.plc4x.plugins</groupId>
+          <artifactId>plc4x-code-generation-language-base</artifactId>
+          <version>${plc4x-code-generation.version}</version>
+        </dependency>
+        <!-- Just needed for some utility methods -->
+        <dependency>
+          <groupId>org.apache.plc4x</groupId>
+          <artifactId>plc4j-spi-utils</artifactId>
+          <version>0.14.0-SNAPSHOT</version>
+        </dependency>
+        <dependency>
+          <groupId>org.apache.plc4x</groupId>
+          <artifactId>plc4j-spi-buffers-api</artifactId>
+          <version>0.14.0-SNAPSHOT</version>
+        </dependency>
+        <dependency>
+          <groupId>org.apache.plc4x</groupId>
+          <artifactId>plc4j-spi-buffers-byte</artifactId>
+          <version>0.14.0-SNAPSHOT</version>
+        </dependency>
+        <!-- https://github.com/palantir/javapoet -->
+        <dependency>
+          <groupId>com.palantir.javapoet</groupId>
+          <artifactId>javapoet</artifactId>
+          <version>0.7.0</version>
+        </dependency>
+      </dependencies>
+    </project>

...va-jp/src/main/java/org/apache/plc4x/codegeneration/language/java/JavaLanguageOutput.java

-Original file line number
+Diff line change
@@ -0,0 +1,191 @@
+    /*
+     * Licensed to the Apache Software Foundation (ASF) under one
+     * or more contributor license agreements.  See the NOTICE file
+     * distributed with this work for additional information
+     * regarding copyright ownership.  The ASF licenses this file
+     * to you under the Apache License, Version 2.0 (the
+     * "License"); you may not use this file except in compliance
+     * with the License.  You may obtain a copy of the License at
+     *
+     *   http://www.apache.org/licenses/LICENSE-2.0
+     *
+     * Unless required by applicable law or agreed to in writing,
+     * software distributed under the License is distributed on an
+     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+     * KIND, either express or implied.  See the License for the
+     * specific language governing permissions and limitations
+     * under the License.
+     */
+    package org.apache.plc4x.codegeneration.language.java;
+    import org.apache.plc4x.codegeneration.language.java.generators.ComplexTypeGenerator;
+    import org.apache.plc4x.codegeneration.language.java.generators.ConstantsTypeGenerator;
+    import org.apache.plc4x.codegeneration.language.java.generators.DataIoGenerator;
+    import org.apache.plc4x.codegeneration.language.java.generators.EnumGenerator;
+    import org.apache.plc4x.java.spi.buffers.api.exceptions.BufferException;
+    import org.apache.plc4x.plugins.codegenerator.language.LanguageOutput;
+    import org.apache.plc4x.plugins.codegenerator.language.mspec.model.definitions.DefaultComplexTypeDefinition;
+    import org.apache.plc4x.plugins.codegenerator.language.mspec.model.definitions.DefaultDataIoTypeDefinition;
+    import org.apache.plc4x.plugins.codegenerator.language.mspec.model.definitions.DefaultDiscriminatedComplexTypeDefinition;
+    import org.apache.plc4x.plugins.codegenerator.language.mspec.model.definitions.DefaultEnumTypeDefinition;
+    import org.apache.plc4x.plugins.codegenerator.language.mspec.model.terms.DefaultBooleanLiteral;
+    import org.apache.plc4x.plugins.codegenerator.types.definitions.ConstantsTypeDefinition;
+    import org.apache.plc4x.plugins.codegenerator.types.definitions.TypeDefinition;
+    import org.apache.plc4x.plugins.codegenerator.types.exceptions.GenerationException;
+    import org.apache.plc4x.plugins.codegenerator.types.terms.BooleanLiteral;
+    import org.apache.plc4x.plugins.codegenerator.types.terms.Term;
+    import org.slf4j.Logger;
+    import org.slf4j.LoggerFactory;
+    import java.io.File;
+    import java.util.*;
+    import java.util.stream.Collectors;
+    public class JavaLanguageOutput implements LanguageOutput {
+        private static final Logger LOGGER = LoggerFactory.getLogger(JavaLanguageOutput.class);
+        private final Formatter formatter = new Formatter();
+        @Override
+        public String getName() {
+            return "Java";
+        }
+        @Override
+        public Set<String> supportedOptions() {
+            return new HashSet<>(Arrays.asList(
+                // Overrides the package name generated.
+                "package",
+                // Generates additional properties to save values of reserved fields for the case that the value differs from the expected value.
+                "generate-properties-for-reserved-fields",
+                // Map containing the type-names for external types.
+                "externalTypes"));
+        }
+        @Override
+        @SuppressWarnings("unchecked")
+        public void generate(File outputRootDir, String version, String languageName, String protocolName, String outputFlavor, Map<String, TypeDefinition> types, Map<String, Object> options) throws GenerationException {
+            Map<String, String> externalTypes = (Map<String, String>) options.get("externalTypes");
+            String targetPackage = (String) options.getOrDefault("package", "org.apache.plc4x." + languageName + "." + protocolName.replace("-", "") + "." + outputFlavor.replace("-", ""));
+            File outputDirectory = new File(outputRootDir, targetPackage.replace('.', '/'));
+            if (!outputDirectory.exists() && !outputDirectory.mkdirs()) {
+                throw new GenerationException("Unable to create output directory " + outputDirectory);
+            }
+            // Output a general plan of what we are planning on generating.
+            outputGenerationPlan(types);
+            try {
+                ArrayList<ConstantsTypeDefinition> constantTypes = types.values().stream().filter(typeDefinition -> typeDefinition instanceof ConstantsTypeDefinition).map(typeDefinition -> (ConstantsTypeDefinition) typeDefinition).collect(Collectors.toCollection(ArrayList::new));
+                ConstantsTypeGenerator constantsTypeGenerator = new ConstantsTypeGenerator(targetPackage, outputDirectory, outputRootDir, types, externalTypes, options);
+                for (ConstantsTypeDefinition constantType : constantTypes) {
+                    Term external = constantType.getAttribute("external").orElse(new DefaultBooleanLiteral(false));
+                    // Only output a file if it's not an "external" type.
+                    if (external.isLiteral() &&
+                        ((external.asLiteral().orElseThrow() instanceof BooleanLiteral) &&
+                            !((BooleanLiteral) external.asLiteral().orElseThrow()).getValue())) {
+                        constantsTypeGenerator.generate(constantType);
+                    }
+                }
+                ArrayList<DefaultComplexTypeDefinition> rootComplexTypes = types.values().stream().filter(typeDefinition -> typeDefinition instanceof DefaultComplexTypeDefinition).map(typeDefinition -> (DefaultComplexTypeDefinition) typeDefinition).filter(defaultComplexTypeDefinition -> !((defaultComplexTypeDefinition instanceof DefaultDiscriminatedComplexTypeDefinition) || (defaultComplexTypeDefinition instanceof DefaultDataIoTypeDefinition))).collect(Collectors.toCollection(ArrayList::new));
+                ComplexTypeGenerator complexTypeGenerator = new ComplexTypeGenerator(targetPackage, outputDirectory, outputRootDir, types, externalTypes, options);
+                for (DefaultComplexTypeDefinition rootComplexType : rootComplexTypes) {
+                    Term external = rootComplexType.getAttribute("external").orElse(new DefaultBooleanLiteral(false));
+                    // Only output a file if it's not an "external" type.
+                    if (external.isLiteral() &&
+                        ((external.asLiteral().orElseThrow() instanceof BooleanLiteral) &&
+                            !((BooleanLiteral) external.asLiteral().orElseThrow()).getValue())) {
+                        complexTypeGenerator.generate(rootComplexType);
+                        // Generate the children of this type (if he has any):
+                        if (rootComplexType.isAbstract()) {
+                            generateChildren(rootComplexType, types, complexTypeGenerator);
+                        }
+                    }
+                }
+                ArrayList<DefaultEnumTypeDefinition> enumTypes = types.values().stream().filter(typeDefinition -> typeDefinition instanceof DefaultEnumTypeDefinition).map(typeDefinition -> (DefaultEnumTypeDefinition) typeDefinition).collect(Collectors.toCollection(ArrayList::new));
+                EnumGenerator enumGenerator = new EnumGenerator(targetPackage, outputDirectory, outputRootDir, types, externalTypes, options);
+                for (DefaultEnumTypeDefinition enumType : enumTypes) {
+                    Term external = enumType.getAttribute("external").orElse(new DefaultBooleanLiteral(false));
+                    // Only output a file if it's not an "external" type.
+                    if (external.isLiteral() &&
+                        ((external.asLiteral().orElseThrow() instanceof BooleanLiteral) &&
+                            !((BooleanLiteral) external.asLiteral().orElseThrow()).getValue())) {
+                        enumGenerator.generate(enumType);
+                    }
+                }
+                ArrayList<DefaultDataIoTypeDefinition> dataIoTypes = types.values().stream().filter(typeDefinition -> typeDefinition instanceof DefaultDataIoTypeDefinition).map(typeDefinition -> (DefaultDataIoTypeDefinition) typeDefinition).collect(Collectors.toCollection(ArrayList::new));
+                DataIoGenerator dataIoGenerator = new DataIoGenerator(targetPackage, outputDirectory, outputRootDir, types, externalTypes, options);
+                for (DefaultDataIoTypeDefinition ioType : dataIoTypes) {
+                    Term external = ioType.getAttribute("external").orElse(new DefaultBooleanLiteral(false));
+                    // Only output a file if it's not an "external" type.
+                    if (external.isLiteral() &&
+                        ((external.asLiteral().orElseThrow() instanceof BooleanLiteral) &&
+                            !((BooleanLiteral) external.asLiteral().orElseThrow()).getValue())) {
+                        dataIoGenerator.generate(ioType);
+                    }
+                }
+            } catch (BufferException e) {
+                throw new GenerationException("Error while generating code", e);
+            }
+        }
+        @Override
+        public List<String> supportedOutputFlavors() {
+            return Arrays.asList("read-write", "read-only", "passive");
+        }
+        protected void outputGenerationPlan(Map<String, TypeDefinition> types) {
+            LOGGER.info("");
+            LOGGER.info("Complex Types:");
+            ArrayList<DefaultComplexTypeDefinition> rootComplexTypes = types.values().stream().filter(typeDefinition -> typeDefinition instanceof DefaultComplexTypeDefinition).map(typeDefinition -> (DefaultComplexTypeDefinition) typeDefinition).filter(defaultComplexTypeDefinition -> !((defaultComplexTypeDefinition instanceof DefaultDiscriminatedComplexTypeDefinition) || (defaultComplexTypeDefinition instanceof DefaultDataIoTypeDefinition))).collect(Collectors.toCollection(ArrayList::new));
+            rootComplexTypes.forEach(defaultComplexTypeDefinition -> {
+                LOGGER.info(" - {}", defaultComplexTypeDefinition.getName());
+                // List the children of this type:
+                if (defaultComplexTypeDefinition.isAbstract()) {
+                    listChildren(defaultComplexTypeDefinition, types, "   - ");
+                }
+            });
+            LOGGER.info("");
+            LOGGER.info("Enum Types:");
+            ArrayList<DefaultEnumTypeDefinition> enumTypes = types.values().stream().filter(typeDefinition -> typeDefinition instanceof DefaultEnumTypeDefinition).map(typeDefinition -> (DefaultEnumTypeDefinition) typeDefinition).collect(Collectors.toCollection(ArrayList::new));
+            enumTypes.forEach(defaultEnumTypeDefinition -> {
+                LOGGER.info(" - {}", defaultEnumTypeDefinition.getName());
+            });
+            LOGGER.info("");
+            LOGGER.info("DataIo Types:");
+            ArrayList<DefaultDataIoTypeDefinition> dataIoTypes = types.values().stream().filter(typeDefinition -> typeDefinition instanceof DefaultDataIoTypeDefinition).map(typeDefinition -> (DefaultDataIoTypeDefinition) typeDefinition).collect(Collectors.toCollection(ArrayList::new));
+            dataIoTypes.forEach(defaultEnumTypeDefinition -> {
+                LOGGER.info(" - {}", defaultEnumTypeDefinition.getName());
+            });
+        }
+        protected void listChildren(DefaultComplexTypeDefinition parent, Map<String, TypeDefinition> types, String indent) {
+            ArrayList<DefaultComplexTypeDefinition> children = types.values().stream().filter(typeDefinition -> typeDefinition instanceof DefaultComplexTypeDefinition).map(typeDefinition -> (DefaultComplexTypeDefinition) typeDefinition).filter(defaultComplexTypeDefinition -> defaultComplexTypeDefinition.getParentType().isPresent() && defaultComplexTypeDefinition.getParentType().get() == parent).collect(Collectors.toCollection(ArrayList::new));
+            children.forEach(child -> {
+                LOGGER.info("{}{}", indent, child.getName());
+                if (child.isAbstract()) {
+                    listChildren(child, types, "  " + indent);
+                }
+            });
+        }
+        protected void generateChildren(DefaultComplexTypeDefinition parent, Map<String, TypeDefinition> types, ComplexTypeGenerator complexTypeGenerator) throws BufferException {
+            ArrayList<DefaultComplexTypeDefinition> children = types.values().stream().filter(typeDefinition -> typeDefinition instanceof DefaultComplexTypeDefinition).map(typeDefinition -> (DefaultComplexTypeDefinition) typeDefinition).filter(defaultComplexTypeDefinition -> defaultComplexTypeDefinition.getParentType().isPresent() && defaultComplexTypeDefinition.getParentType().get() == parent).collect(Collectors.toCollection(ArrayList::new));
+            for (DefaultComplexTypeDefinition child : children) {
+                complexTypeGenerator.generate(child);
+                if (child.isAbstract()) {
+                    generateChildren(child, types, complexTypeGenerator);
+                }
+            }
+        }
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SPI 3 Refactoring #2382

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!

Uh oh!

SPI 3 Refactoring #2382

Are you sure you want to change the base?

Uh oh!

SPI 3 Refactoring #2382

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!

Uh oh!