http://hsqldb.org: HSQLDB - Lightweight 100% Java SQL Database Engine (The HSQL Development Group)
  • Blaine Simpson 
/* Copyright (c) 2001-2007, The HSQL Development Group
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * Neither the name of the HSQL Development Group nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */


package org.hsqldb.util.preprocessor;

import java.io.File;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.taskdefs.MatchingTask;

/* $Id: PreprocessorAntTask.java 5793 2018-01-06 13:12:38Z fredt $ */


Provides a facility for invoking the Preprocessor from ANT. 

Example ANT target: 


    
    
    



Task attributes :


    
        
namedescription

    
    
    

        srcdir (required)
        string - directory under which input files are located
    

    

        targetdir (required)
        string - directory under which output files are to be written
    

    

        altext (optional)
        string - alternate extension to use for output file names. 

        If needed, leading dot should be provided		
    

    

        backup (optional - default: false)
        boolean - whether to back up pre-existing target files. 

        When true, pre-existing target files are preserved by renaming with
        postfix "~"		
    

    

        encoding (optional)
        string - the encoding with which to read and write file content.

        If specified, must be a valid Java encoding identifier, such as "UTF8". 

        When unspecified, the default Java platformn encoding is used.		
    

    

        filter (optional - default: false)
        boolean - whether to exclude directive lines from output.
    

    

        indent (optional - default: false)
        boolean - whether to indent directive lines in output.
    

    

        symbols (optional)
        string - CSV list of preprocessor symbols to predefine. 

        When specified, each list element must be of the form: 

        IDENT (ASSIGN? (STRING | NUMBER | IDENT) )?

        Not that forward assignments are illegal. 
 See Preprocessor for details		
    

    

        testonly (optional - default: false)
        boolean - whether to omit writing output files.
    

    

        verbose (optional - default: false)
        boolean - whether to log detailed information.
    

    



Author:Campbell Burnet (campbell-burnet@users dot sourceforge.net)
Version:1.8.1
Since:1.8.1
/**
 * Provides a facility for invoking the Preprocessor from ANT. <p>
 *
 * Example ANT target: <p>
 *
 * <pre>
 * <target
 *     name="preprocess"
 *     depends="build-preprocessor">
 *
 *     <taskdef
 *         name="preprocess"
 *         classname="org.hsqldb.util.preprocessor.PreprocessorAntTask"
 *         classpath="${preprocessor.class.path}"/>
 *
 *     <preprocess
 *         srcdir="${src.dir}"
 *         targetdir="${target.dir}"
 *         altext=".pre"
 *         backup="true"
 *         encoding="UTF8"
 *         filter="true"
 *         indent="false"
 *         symbols="java_version=${java.version}, jdbc_version=${jdbc.version}"
 *         testonly="false"
 *         verbose="true"
 *         if="${preprocess.if}"
 *         unless="${preprocess.unless}">
 *     </preprocess>
 *
 * </target>
 * </pre>
 *
 * Task attributes :
 *
 * <table>
 *     <thead>
 *         <tr><td>name</td><td>description</td></tr>
 *     </thead>
 *     <tbody>
 *     <tr>
 *         <td>srcdir (required)</td>
 *         <td>string - directory under which input files are located</td>
 *     </tr>
 *     <tr>
 *         <td>targetdir (required)</td>
 *         <td>string - directory under which output files are to be written</td>
 *     </tr>
 *     <tr>
 *         <td>altext (optional)</td>
 *         <td>string - alternate extension to use for output file names. <br/>
 *         If needed, leading dot should be provided</td>
 *     </tr>
 *     <tr>
 *         <td>backup (optional - default: false)</td>
 *         <td>boolean - whether to back up pre-existing target files. <br/>
 *         When true, pre-existing target files are preserved by renaming with
 *         postfix "~"</td>
 *     </tr>
 *     <tr>
 *         <td>encoding (optional)</td>
 *         <td>string - the encoding with which to read and write file content.<br/>
 *         If specified, must be a valid Java encoding identifier, such as "UTF8". <br/>
 *         When unspecified, the default Java platformn encoding is used.</td>
 *     </tr>
 *     <tr>
 *         <td>filter (optional - default: false)</td>
 *         <td>boolean - whether to exclude directive lines from output.</td>
 *     </tr>
 *     <tr>
 *         <td>indent (optional - default: false)</td>
 *         <td>boolean - whether to indent directive lines in output.</td>
 *     </tr>
 *     <tr>
 *         <td>symbols (optional)</td>
 *         <td>string - CSV list of preprocessor symbols to predefine. <br/>
 *         When specified, each list element must be of the form: <br/>
 *         IDENT (ASSIGN? (STRING | NUMBER | IDENT) )?<br/>
 *         Not that forward assignments are illegal. <br/>
 *         See {@link Preprocessor Preprocessor} for details</td>
 *     </tr>
 *     <tr>
 *         <td>testonly (optional - default: false)</td>
 *         <td>boolean - whether to omit writing output files.</td>
 *     </tr>
 *     <tr>
 *         <td>verbose (optional - default: false)</td>
 *         <td>boolean - whether to log detailed information.</td>
 *     </tr>
 *     <tbody>
 * </table>
 *
 * @author Campbell Burnet (campbell-burnet@users dot sourceforge.net)
 * @version 1.8.1
 * @since 1.8.1
 */
public class PreprocessorAntTask extends MatchingTask {

    private String ifExpr;
    private String unlessExpr;
    private File   sourceDir;
    private File   targetDir;
    private String defines;
    private String altExt;
    private String encoding;
    private int    options = Option.INDENT;

    public void init() {
        super.init();
    }

    public void setSrcdir(final File value) {
        sourceDir = value;
    }

    public void setTargetdir(final File value) {
        targetDir = value;
    }

    public void setSymbols(final String value) {
        defines = value;
    }

    public void setVerbose(final boolean verbose) {
        options = Option.setVerbose(options, verbose);
    }

    public void setBackup(final boolean backup) {
        options = Option.setBackup(options, backup);
    }

    public void setIndent(final boolean indent) {
        options = Option.setIndent(options, indent);
    }

    public void setTestonly(final boolean testOnly) {
        options = Option.setTestOnly(options, testOnly);
    }

    public void setFilter(final boolean filter) {
        options = Option.setFilter(options, filter);
    }

    public void setAltext(final String ext) {
        this.altExt = ext;
    }

    public void setEncoding(final String encoding) {
          this.encoding = encoding;
    }

    public void setIf(final String expr) {
        this.ifExpr = expr;
    }

    public void setUnless(final String expr) {
        this.unlessExpr = expr;
    }

    public boolean isActive() {
        return (this.ifExpr == null
                || getProject().getProperty(this.ifExpr) != null
                || this.unlessExpr == null
                || getProject().getProperty(this.unlessExpr) == null);
    }

    public void execute() throws BuildException {

        if (!isActive()) {
            return;
        }

        checkTargetDir();

        this.sourceDir = getProject().resolveFile("" + this.sourceDir);

        IResolver resolver = new AntResolver(getProject());
        String[]  files    = getFiles();

        log("Preprocessing " + files.length + " file(s)");

        try {
            Preprocessor.preprocessBatch(this.sourceDir, this.targetDir, files,
                    this.altExt, this.encoding, this.options, this.defines,
                    resolver);
        } catch (Exception ex) {
            ex.printStackTrace();

            throw new BuildException("Preprocessing failed: " + ex,
                    ex);
        }
    }

    private String[] getFiles() {
        return getDirectoryScanner(sourceDir).getIncludedFiles();
    }

    private void checkTargetDir() throws BuildException {
        if (targetDir == null) {
            throw new BuildException("Target directory required.");
        }
    }
}