/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.tools.ws.ant;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.taskdefs.Execute;
import org.apache.tools.ant.taskdefs.LogStreamHandler;
import org.apache.tools.ant.types.*;
import java.io.*;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
/**
* apt task for use with the JAXWS project.
*/
public class Apt extends Task {
/** -classpath option */
protected Path compileClasspath = null;
public Path getClasspath() { return compileClasspath; }
public void setClasspath(Path classpath) {
if (compileClasspath == null) {
compileClasspath = classpath;
} else {
compileClasspath.append(classpath);
}
}
/**
* Creates a nested classpath element.
*/
public Path createClasspath() {
if (compileClasspath == null) {
compileClasspath = new Path(project);
}
return compileClasspath.createPath();
}
/**
* Adds a reference to a CLASSPATH defined elsewhere.
*/
public void setClasspathRef(Reference r) {
createClasspath().setRefid(r);
}
/** -d option: directory to output processor and javac generated class files */
private File destDir = null;
public File getDestdir() { return this.destDir; }
public void setDestdir(File base) { this.destDir = base; }
/** -s option: directory to place processor generated source files */
private File sourceDestDir;
public void setSourcedestdir(File sourceBase) { this.sourceDestDir = sourceBase; }
public File getSourcedestdir() { return sourceDestDir; }
/** -A option */
protected List<Option> options = new ArrayList<Option>();
public List<Option> getOptions() { return options; }
public Option createOption() {
Option option = new Option();
options.add(option);
return option;
}
/** -J<flag> option: Pass <flag> directly to the runtime */
protected List<Jvmarg> jvmargs = new ArrayList<Jvmarg>();
public List<Jvmarg> getJvmargs() { return jvmargs; }
public Jvmarg createJvmarg() {
Jvmarg jvmarg = new Jvmarg();
jvmargs.add(jvmarg);
return jvmarg;
}
/** -nocompile option */
private boolean noCompile = false;
public boolean isNocompile() { return noCompile; }
public void setNocompile(boolean noCompile) { this.noCompile = noCompile; }
/******************** -print option **********************/
private boolean print = false;
public boolean isPrint() { return print; }
public void setPrint(boolean print) { this.print = print; }
/******************** -factorypath option **********************/
private File factoryPath = null;
public File getFactorypath() { return factoryPath; }
public void setFactorypath(File factoryPath) { this.factoryPath = factoryPath; }
/******************** -factory option **********************/
private String factory = null;
public String getFactory() { return factory; }
public void setFactory(String factory) { this.factory = factory; }
/******************** -XListAnnotationTypes option **********************/
private boolean xListAnnotationTypes = false;
public boolean isXlistannotationtypes() { return xListAnnotationTypes; }
public void setXlistannotationtypes(boolean xListAnnotationTypes) { this.xListAnnotationTypes = xListAnnotationTypes; }
/******************** -XListDeclarations option **********************/
private boolean xListDeclarations = false;
public boolean isXlistdeclarations() { return xListDeclarations; }
public void setXlistdeclarations(boolean xListDeclarations) { this.xListDeclarations = xListDeclarations; }
/******************** -XPrintAptRounds option **********************/
private boolean xPrintAptRounds = false;
public boolean isXprintaptrounds() { return xPrintAptRounds; }
public void setXprintaptrounds(boolean xPrintAptRounds) { this.xPrintAptRounds = xPrintAptRounds; }
/******************** -XPrintFactoryInfo option **********************/
private boolean xPrintFactoryInfo = false;
public boolean isXprintfactoryinfo() { return xPrintFactoryInfo; }
public void setXprintfactoryinfo(boolean xPrintFactoryInfo) { this.xPrintFactoryInfo = xPrintFactoryInfo; }
/******************** -XclassesAsDecls option **********************/
private boolean xClassesAsDecls = false;
public boolean isXclassesasdecls() { return xClassesAsDecls; }
public void setXclassesasdecls(boolean xClassesAsDecls) { this.xClassesAsDecls = xClassesAsDecls; }
/** Inherited from javac */
/** -g option: debugging info */
protected boolean debug = false;
public boolean isDebug() { return debug; }
public void setDebug(boolean debug) { this.debug = debug; }
/** debug level */
protected String debugLevel = null;
public String getDebuglevel() { return debugLevel; }
public void setDebuglevel(String debugLevel) { this.debugLevel = debugLevel; }
/** -nowarn option: generate no warnings */
protected boolean nowarn = false;
public boolean isNowarn() { return nowarn; }
public void setNowarn(boolean nowarn) { this.nowarn = nowarn; }
/** -deprecation option: output source locations where deprecated APIs are used */
protected boolean deprecation = false;
public boolean isDeprecation() { return deprecation; }
public void setDeprecation(boolean deprecation) { this.deprecation = deprecation; }
/** -bootclasspath option: override location of bootstrap class files */
protected Path bootclassPath = null;
public Path getBootclasspath() { return bootclassPath; }
public void setBootclasspath(Path bootclassPath) { this.bootclassPath = bootclassPath; }
/** -extdirs option: override location of installed extensions */
protected String extdirs = null;
public String getExtdirs() { return extdirs; }
public void setExtdirs(String extdirs) { this.extdirs = extdirs; }
/** -endorseddirs option: override location of endorsed standards path */
protected String endorseddirs = null;
public String getEndorseddirs() { return endorseddirs; }
public void setEndorseddirs(String endorseddirs) { this.endorseddirs = endorseddirs; }
/** -verbose option: output messages about what the compiler is doing */
protected boolean verbose = false;
public boolean isVerbose() { return verbose; }
public void setVerbose(boolean verbose) { this.verbose = verbose; }
/** -sourcepath option: Specify where to find input source files */
protected Path sourcePath = null;
public Path getSourcepath() { return sourcePath; }
public void setSourcepath(Path sourcePath) { this.sourcePath = sourcePath; }
/** -encoding option: character encoding used by the source files */
protected String encoding = null;
public String getEncoding() { return encoding; }
public void setEncoding(String encoding) { this.encoding = encoding; }
/** -target option: generate class files for specific VM version */
protected String targetVM = null;
public String getTarget() { return targetVM; }
public void setTarget(String target) { this.targetVM = target; }
/** Others */
/** -fork option: */
protected boolean fork = false;
public boolean isFork() { return fork; }
public void setFork(boolean fork) { this.fork = fork; }
protected List<FileSet> sourceFileset = new ArrayList<FileSet>();
public void addConfiguredSource(FileSet fileset) {
sourceFileset.add(fileset);
}
private Commandline setupAptCommand() {
Commandline cmd = setupAptArgs();
// classpath option (cp option just uses classpath option)
Path classpath = getClasspath();
if (classpath != null && !classpath.toString().equals("")) {
cmd.createArgument().setValue("-classpath");
cmd.createArgument().setPath(classpath);
}
return cmd;
}
private Commandline setupAptForkCommand() {
CommandlineJava forkCmd = new CommandlineJava();
Path classpath = getClasspath();
forkCmd.createClasspath(getProject()).append(classpath);
forkCmd.setClassname("com.sun.tools.apt.Main");
if (null != getJvmargs()) {
for (Jvmarg jvmarg : jvmargs) {
forkCmd.createVmArgument().setLine(jvmarg.getValue());
}
}
Commandline cmd = setupAptArgs();
cmd.createArgument(true).setLine(forkCmd.toString());
return cmd;
}
private Commandline setupAptArgs() {
Commandline cmd = new Commandline();
if (null != getDestdir() && !getDestdir().getName().equals("")) {
cmd.createArgument().setValue("-d");
cmd.createArgument().setFile(getDestdir());
}
if (null != getSourcedestdir() && !getSourcedestdir().getName().equals("")) {
cmd.createArgument().setValue("-s");
cmd.createArgument().setFile(getSourcedestdir());
}
if (getSourcepath() == null)
throw new BuildException("\"sourcePath\" attribute must be set.");
if (getSourcepath() != null && !getSourcepath().toString().equals("")) {
cmd.createArgument().setValue("-sourcepath");
cmd.createArgument().setValue(getSourcepath().toString());
}
if (getBootclasspath() != null && !getBootclasspath().toString().equals("")) {
cmd.createArgument().setValue("-bootclasspath");
cmd.createArgument().setValue(getBootclasspath().toString());
}
if (getExtdirs() != null && !getExtdirs().equals("")) {
cmd.createArgument().setValue("-extdirs");
cmd.createArgument().setValue(getExtdirs());
}
if (getEndorseddirs() != null && !getEndorseddirs().equals("")) {
cmd.createArgument().setValue("-endorseddirs");
cmd.createArgument().setValue(getEndorseddirs());
}
if (isDebug()) {
String debugOption = "";
debugOption = "-g";
if (getDebuglevel() != null && !getDebuglevel().equals(""))
debugOption += ":" + getDebuglevel();
cmd.createArgument().setValue(debugOption);
} else
cmd.createArgument().setValue("-g:none");
if (isVerbose())
cmd.createArgument().setValue("-verbose");
if (getEncoding() != null && !getEncoding().equals("")) {
cmd.createArgument().setValue("-encoding");
cmd.createArgument().setValue(getEncoding());
}
if (getTarget() != null && !getTarget().equals("")) {
cmd.createArgument().setValue("-target");
cmd.createArgument().setValue(getTarget());
}
for (Option option : options) {
cmd.createArgument().setValue("-A" + option.getKey() + "=" + option.getValue());
}
if(isNowarn()){
cmd.createArgument().setValue("-nowarn");
}
if(isNocompile()){
cmd.createArgument().setValue("-nocompile");
}
if(isDeprecation()){
cmd.createArgument().setValue("-deprecation");
}
if(isPrint()){
cmd.createArgument().setValue("-print");
}
if(getFactorypath() != null){
cmd.createArgument().setValue("-factorypath");
cmd.createArgument().setValue(getFactorypath().toString());
}
if(getFactory() != null){
cmd.createArgument().setValue("-factory");
cmd.createArgument().setValue(getFactory());
}
if (isXlistannotationtypes()) {
cmd.createArgument().setValue("-XListAnnotationTypes");
}
if (isXlistdeclarations()) {
cmd.createArgument().setValue("-XListDeclarations");
}
if (isXprintaptrounds()) {
cmd.createArgument().setValue("-XPrintAptRounds");
}
if (isXprintfactoryinfo()) {
cmd.createArgument().setValue("-XPrintFactoryInfo");
}
if (isXprintfactoryinfo()) {
cmd.createArgument().setValue("-XclassesAsDecls");
}
Set<File> sourceFiles = new HashSet<File>();
prepareSourceList(sourceFiles);
if(!sourceFiles.isEmpty()){
for(File source : sourceFiles){
cmd.createArgument().setFile(source);
}
}
return cmd;
}
void prepareSourceList(Set<File> sourceFiles) throws BuildException {
if (sourceFileset != null) {
for (FileSet fileset : sourceFileset) {
DirectoryScanner ds = fileset.getDirectoryScanner(getProject());
String[] includedFiles = ds.getIncludedFiles();
File baseDir = ds.getBasedir();
for (int i = 0; i < includedFiles.length; ++i) {
sourceFiles.add(new File(baseDir, includedFiles[i]));
}
}
}
}
/** Called by the project to let the task do it's work **/
public void execute() throws BuildException {
PrintWriter writer = null;
boolean ok = false;
try {
Commandline cmd = fork ?
setupAptForkCommand() : setupAptCommand();
if (verbose) {
log("command line: " + "apt " + cmd.toString());
}
int status = 0;
if (fork) {
status = run(cmd.getCommandline());
} else {
ByteArrayOutputStream baos = new ByteArrayOutputStream();
writer = new PrintWriter(baos);
ClassLoader old = Thread.currentThread().getContextClassLoader();
Thread.currentThread().setContextClassLoader(this.getClass().getClassLoader());
try {
com.sun.tools.apt.Main aptTool = new com.sun.tools.apt.Main();
status = aptTool.process(writer, cmd.getArguments());
writer.flush();
if (verbose || baos.size()!=0)
log(baos.toString());
} finally {
Thread.currentThread().setContextClassLoader(old);
}
}
ok = (status == 0) ? true : false;
if (!ok) {
if (!verbose) {
log("Command invoked: "+"apt "+cmd.toString());
}
throw new BuildException("apt failed", location);
}
} catch (Exception ex) {
if (ex instanceof BuildException) {
throw (BuildException)ex;
} else {
throw new BuildException("Error starting apt: ", ex,
getLocation());
}
} finally {
if (writer != null) {
writer.close();
}
}
}
/**
* Executes the given classname with the given arguments in a separate VM.
*/
private int run(String[] command) throws BuildException {
FileOutputStream fos = null;
Execute exe = null;
LogStreamHandler logstr = new LogStreamHandler(this,
Project.MSG_INFO, Project.MSG_WARN);
exe = new Execute(logstr);
exe.setAntRun(project);
exe.setCommandline(command);
try {
int rc = exe.execute();
if (exe.killedProcess()) {
log("Timeout: killed the sub-process", Project.MSG_WARN);
}
return rc;
} catch (IOException e) {
throw new BuildException(e, location);
}
}
public static class Option {
protected String key;
protected String value;
public String getKey() { return key; }
public void setKey(String key) { this.key = key; }
public String getValue() { return value; }
public void setValue(String value) { this.value = value; }
}
public static class Jvmarg {
protected String value;
public String getValue() { return value; }
public void setValue(String value) { this.value = value; }
}
}