README.md

Overview

The Gradle JPP Plugin is a PrecompileProcessor gradle porting.It allows you to preprocess macros in your java source code.

Getting Started Using the Plugin

Please follow the below steps to add the Gradle JPP Plugin to your Gradle build script.

Step 1: Apply the plugin to your Gradle build script

To apply the plugin, please add the following snippets to your build.gradle file:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'org.flakor.jpp:gradle-jpp-plugin:0.1.1'
    }
}
apply plugin: 'jpp'

• If you have a multi project build make sure to apply the plugin and the plugin configuration to every project which its source code you wish to preprocess.

Step 2: Add the jpp configuration closure to your build.gradle file

Add the below "jpp" closure with some properties.

jpp {
    destDir = 'dest'
    defines {
        sdk_debugable = false
    }
    sourceSets {
        main {
            java {
                srcDirs = ['src/main/java']
            }
        }
    }'
    ...
}

Mandatory parameters:

1. destDir --- destination directory your code files locate
2. sourceSets --- same as java plugin's sourceSets

Optional parameters

1. defines --- macros you defined
2. defineFile --- a file holded macros
3. encode --- source file encoding (default utf-8)
4. baseDir --- base directory your code files locate

Step 3: Set your final sourceSets

To make your processed files as source files,you must set the final directory which is dest property plus SourceSets srcDirs in jpp closure to Java plugin or Android plugin SourceSets.

Java Plugin

sourceSets {
    main {
        java {
            srcDirs = ['dest/src/main/java'] //set dest source dir
        }
    }
}

Android Plugin

android {
    compileSdkVersion 23
    buildToolsVersion "23.0.2"

    sourceSets {
        main {
            java.srcDirs = ['dest/src/main/java'] //set dest source dir
        }
    }
    ...
}

Step 4: Run the build

gradle javaPreprocess

JVM Compatibility: Java 6 and above.

Document

Chinese Doc you can check at this PCP Chinese Doc

License

This plugin is available under the Apache License, Version 2.0.

(c) All rights reserved Steve Hsu