Simple-Code-Generator/README.md

Simple-Code-Generator

This Tool is a very Simple Code Generator that can read a template file and segment it based on a Set of variables that can be defined. Separate to that this tool can replace text via simple Regular Expression mapping. It has a cache that keeps track of the input (if it was changed), and only cares that the file format is Text based.

It is as bare bones as it can get but that also makes it flexible.

How to install

Using Gradle:

repositories {
    maven {
        url = "https://maven.speiger.com/repository/main"
    }
}
dependencies {
	compile 'de.speiger:Simple-Code-Generator:1.1.4'
}

How to create a Template Processor

Create a class that extends TemplateProcessor.
And run the process method
SourceFolder: Is the folder that is traversed through and Files are given back.
OutputFolder: Is the folder where the Processed files get put into. If the "relativePackages" are set to true then the source folder structure is transferred.
DataFolder: Is the folder where the input cache is stored. It uses a MD5 generator to compare inputs. Right now only FileNames without extensions are stored in there.
So no Duplicated FileName support for now.

Methods:

init: Is called when the Processes was started for the first time.
isFileValid: The Method that checks if a File can be used for a template.
relativePackages: If the Folder Structure from the SourceFolder should be transferred to the OutputFolder.
createProcesses: The Main Function that provides the FileName (without extension) and a consumer of how the file should be processed.
A TemplateProcess is a Collection of Variables that is used for File Segmentation and a List of UnaryOperators that allow to edit the build code.
A Simple sum up: Template Process is Tuple<Set, List> that also contains the new FileName.

package test.example;

public class ExampleClass
{
#if METHOD_ONE
	public void methodOne() {}
#else if METHOD_TWO && !SKIP
	public void methodTwo() {}
#else
	public void methodThree() {}
#endif
}

If the Variable "METHOD_ONE" is present only the code in the if is parsed into the template process.
If the Variable "METHOD_TWO" is present and the "SKIP" Variable is missing then the code in the else if block is parsed into the template process
Otherwise the else block is included.
Whenever a if is started, it has to end with a #endif, Even if the last condition is a else if or a else.
Recursion is supported and necessary