jcpp-maven-plugin

maven plugin for jcpp.

License

License

MIT
Categories

Categories

Maven Build Tools
GroupId

GroupId

com.xenoamess
ArtifactId

ArtifactId

jcpp-maven-plugin
Last Version

Last Version

0.2.3
Release Date

Release Date

Type

Type

maven-plugin
Description

Description

jcpp-maven-plugin
maven plugin for jcpp.
Project URL

Project URL

https://github.com/XenoAmess/jcpp-maven-plugin
Source Code Management

Source Code Management

https://github.com/XenoAmess/jcpp-maven-plugin

Download jcpp-maven-plugin

How to add to project

<plugin>
    <groupId>com.xenoamess</groupId>
    <artifactId>jcpp-maven-plugin</artifactId>
    <version>0.2.3</version>
</plugin>

Dependencies

compile (1)

Group / Artifact Type Version
org.anarres : jcpp jar 1.4.14

provided (4)

Group / Artifact Type Version
org.apache.maven : maven-plugin-api jar [3.0.0,4.0.0)
org.apache.maven : maven-core jar [3.0.0,4.0.0)
org.apache.maven : maven-artifact jar [3.0.0,4.0.0)
org.apache.maven.plugin-tools : maven-plugin-annotations jar 3.6.0

test (3)

Group / Artifact Type Version
org.apache.maven : maven-compat jar [3.0.0,4.0.0)
junit : junit jar 4.13
org.apache.maven.plugin-testing : maven-plugin-testing-harness jar 3.3.0

Project Modules

There are no modules declared in this project.

jcpp-maven-plugin

Maven Central

jcpp-maven-plugin, A plugin for C pre processing in maven project.

Goal:

Use a c pre processor (org.anarres.jcpp) to process your java templates in a specified folder before build.

Usage:

  1. include it in your <build>

    <build>
        <plugins>
            <plugin>
                <groupId>com.xenoamess</groupId>
                <artifactId>jcpp-maven-plugin</artifactId>
                <version>0.2.0</version>
                <executions>
                    <execution>
                        <id>preprocess-sources</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>preprocess-sources</goal>
                        </goals>
                        <configuration>
                            <sourceDirectory>
                                ${basedir}/src/main/java-templates
                            </sourceDirectory>
                            <outputDirectory>
                                ${project.build.directory}/generated-sources/src/main/java
                            </outputDirectory>
                            <libPaths>
                                <param>${basedir}/src/main/resources/templates
                                </param>
                            </libPaths>
                        </configuration>
                    </execution>
                    <execution>
                        <id>preprocess-test-sources</id>
                        <phase>generate-test-sources</phase>
                        <goals>
                            <goal>preprocess-test-sources</goal>
                        </goals>
                        <configuration>
                            <sourceDirectory>
                                ${basedir}/src/test/java-templates
                            </sourceDirectory>
                            <outputDirectory>
                                ${project.build.directory}/generated-test-sources/src/test/java
                            </outputDirectory>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    
  2. write your code template. put source template code into <sourceDirectory> put additional libPaths for your template codes into <libPaths>

  3. mvn compile and get the result.

Params:

All params and their default value are listed here.

    @Parameter(defaultValue = "${basedir}/src/main/java-templates", property = "sourceDir", required = true)
    private File sourceDirectory;

    @Parameter(defaultValue = "${project.build.directory}/generated-sources/src/main/java", property = "outputDir",
            required = true)
    private File outputDirectory;

    @Parameter(property = "args")
    private String[] args;

    @Parameter(defaultValue = "${project.build.sourceEncoding}", property = "encoding")
    private String encoding;

    @Parameter(property = "libPaths")
    private String[] libPaths;
    
    @Parameter(defaultValue = "${project}")
    private MavenProject project;

sourceDirectory means a directory which contains your templates.

outputDirectory means a directory to put preprocessed outputDirectory.

args means additional args for org.anarres.jcpp.Main

encoding means encoding of your source files.

libPaths means additional libraries paths for preprocessing your templates. libPaths will be uniqued before the plugin use libPaths, so don't worry if you have duplicated strings in libPaths. sourceDirectory will always be added to libPaths automatically before the plugin use libPaths.

project means your project. I don't think it shall be changed but if you insisted, then you are free to do what you want.

Live Demo:

Projects using this: https://github.com/XenoAmess/commonx

Versions

Version
0.2.3
0.2.2
0.2.1
0.2.0
0.1.0