org_scala_tools_maven.ScalaCompilerSupport Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-scala-plugin Show documentation
Show all versions of maven-scala-plugin Show documentation
The maven-scala-plugin is used for compiling/testing/running/documenting scala code in maven.
The newest version!
/*
* Copyright 2007 scala-tools.org
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions
* and limitations under the License.
*/
package org_scala_tools_maven;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.codehaus.plexus.util.FileUtils;
import org_scala_tools_maven_executions.JavaMainCaller;
import org_scala_tools_maven_executions.MainHelper;
/**
* Abstract parent of all Scala Mojo who run compilation
*/
public abstract class ScalaCompilerSupport extends ScalaSourceMojoSupport {
public static final String ALL = "all";
public static final String MODIFIED_ONLY = "modified-only";
/**
* Keeps track of if we get compile errors in incremental mode
*/
private boolean compileErrors;
/**
* Pause duration between to scan to detect changed file to compile.
* Used only if compileInLoop or testCompileInLoop is true.
*/
protected long loopSleep = 2500;
/**
* compilation-mode to use when sources was previously compiled and there is at least one change:
* "modified-only" => only modified source was recompiled (pre 2.13 behavior), "all" => every source are recompiled
* @parameter expression="${recompilation-mode}" default-value="all"
*/
private String recompileMode = ALL;
/**
* notifyCompilation if true then print a message "path: compiling"
* for each root directory or files that will be compiled.
* Usefull for debug, and for integration with Editor/IDE to reset markers only for compiled files.
*
* @parameter expression="${notifyCompilation}" default-value="true"
*/
private boolean notifyCompilation = true;
abstract protected File getOutputDir() throws Exception;
abstract protected List getClasspathElements() throws Exception;
private long _lastCompileAt = -1;
@Override
protected void doExecute() throws Exception {
File outputDir = normalize(getOutputDir());
if (!outputDir.exists()) {
outputDir.mkdirs();
}
if (getLog().isDebugEnabled()) {
for(File directory : getSourceDirectories()) {
getLog().debug(directory.getCanonicalPath());
}
}
int nbFiles = compile(getSourceDirectories(), outputDir, getClasspathElements(), false);
switch (nbFiles) {
case -1:
getLog().warn("No source files found.");
break;
case 0:
getLog().info("Nothing to compile - all classes are up to date");;
break;
default:
break;
}
}
protected int compile(File sourceDir, File outputDir, List classpathElements, boolean compileInLoop) throws Exception, InterruptedException {
//getLog().warn("Using older form of compile");
return compile(Arrays.asList(sourceDir), outputDir, classpathElements, compileInLoop);
}
protected int compile(List sourceRootDirs, File outputDir, List classpathElements, boolean compileInLoop) throws Exception, InterruptedException {
long t0 = System.currentTimeMillis();
if (_lastCompileAt < 0) {
_lastCompileAt = findLastSuccessfullCompilation(outputDir);
}
List files = getFilesToCompile(sourceRootDirs, _lastCompileAt);
if (files == null) {
return -1;
}
if (files.size() < 1) {
return 0;
}
long t1 = System.currentTimeMillis();
getLog().info(String.format("Compiling %d source files to %s at %d", files.size(), outputDir.getAbsolutePath(), t1));
JavaMainCaller jcmd = getScalaCommand();
jcmd.redirectToLog();
jcmd.addArgs("-classpath", MainHelper.toMultiPath(classpathElements));
jcmd.addArgs("-d", outputDir.getAbsolutePath());
//jcmd.addArgs("-sourcepath", sourceDir.getAbsolutePath());
for (File f : files) {
jcmd.addArgs(f.getAbsolutePath());
}
if (jcmd.run(displayCmd, !compileInLoop)) {
setLastSuccessfullCompilation(outputDir, t1);
}
else {
compileErrors = true;
}
getLog().info(String.format("prepare-compile in %d s", (t1 - t0) / 1000));
getLog().info(String.format("compile in %d s", (System.currentTimeMillis() - t1) / 1000));
_lastCompileAt = t1;
return files.size();
}
/**
* Returns true if the previous compile failed
*/
protected boolean hasCompileErrors() {
return compileErrors;
}
protected void clearCompileErrors() {
compileErrors = false;
}
protected List getFilesToCompile(List sourceRootDirs, long lastSuccessfullCompileTime) throws Exception {
List sourceFiles = findSourceWithFilters(sourceRootDirs);
if (sourceFiles.size() == 0) {
return null;
}
// filter uptodate
// filter is not applied to .java, because scalac failed to used existing .class for unmodified .java
// failed with "error while loading Xxx, class file '.../target/classes/.../Xxxx.class' is broken"
// (restore how it work in 2.11 and failed in 2.12)
//TODO a better behavior : if there is at least one .scala to compile then add all .java, if there is at least one .java then add all .scala (because we don't manage class dependency)
List files = new ArrayList(sourceFiles.size());
if (_lastCompileAt > 0 || (!ALL.equals(recompileMode) && (lastSuccessfullCompileTime > 0))) {
ArrayList modifiedScalaFiles = new ArrayList(sourceFiles.size());
ArrayList modifiedJavaFiles = new ArrayList(sourceFiles.size());
ArrayList allJavaFiles = new ArrayList(sourceFiles.size());
for (File f : sourceFiles) {
if (f.getName().endsWith(".java")) {
allJavaFiles.add(f);
}
if (f.lastModified() >= lastSuccessfullCompileTime) {
if (f.getName().endsWith(".java")) {
modifiedJavaFiles.add(f);
} else {
modifiedScalaFiles.add(f);
}
}
}
if ((modifiedScalaFiles.size() != 0) || (modifiedJavaFiles.size() != 0)) {
if ((modifiedScalaFiles.size() != 0) && MODIFIED_ONLY.equals(recompileMode)) {
files.addAll(allJavaFiles);
files.addAll(modifiedScalaFiles);
notifyCompilation(files);
} else {
files.addAll(sourceFiles);
notifyCompilation(sourceRootDirs);
}
}
} else {
files.addAll(sourceFiles);
notifyCompilation(sourceRootDirs);
}
return files;
}
private void notifyCompilation(List files) throws Exception {
if (notifyCompilation) {
for (File f : files) {
getLog().info(String.format("%s:-1: info: compiling", f.getCanonicalPath()));
}
}
}
private long findLastSuccessfullCompilation(File outputDir) throws Exception {
long back = -1;
final File lastCompileAtFile = new File(outputDir + ".timestamp");
if (lastCompileAtFile.exists() && outputDir.exists() && (outputDir.list().length > 0)) {
back = lastCompileAtFile.lastModified();
}
return back;
}
private void setLastSuccessfullCompilation(File outputDir, long v) throws Exception {
final File lastCompileAtFile = new File(outputDir + ".timestamp");
if (lastCompileAtFile.exists()) {
} else {
FileUtils.fileWrite(lastCompileAtFile.getAbsolutePath(), ".");
}
lastCompileAtFile.setLastModified(v);
}
}