blob: be6f096f7bd2ce5f7573b986872ddaa8eb99fc9a [file] [log] [blame]
package org.apache.maven.plugin.compiler;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.utils.StringUtils;
import org.apache.maven.shared.utils.logging.MessageUtils;
import org.apache.maven.toolchain.Toolchain;
import org.apache.maven.toolchain.java.DefaultJavaToolChain;
import org.codehaus.plexus.compiler.util.scan.SimpleSourceInclusionScanner;
import org.codehaus.plexus.compiler.util.scan.SourceInclusionScanner;
import org.codehaus.plexus.compiler.util.scan.StaleSourceScanner;
import org.codehaus.plexus.languages.java.jpms.JavaModuleDescriptor;
import org.codehaus.plexus.languages.java.jpms.LocationManager;
import org.codehaus.plexus.languages.java.jpms.QDoxModuleInfoParser;
import org.codehaus.plexus.languages.java.jpms.ResolvePathsRequest;
import org.codehaus.plexus.languages.java.jpms.ResolvePathsResult;
import org.codehaus.plexus.languages.java.jpms.ResolvePathsResult.ModuleNameSource;
/**
* Compiles application sources
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl </a>
* @version $Id$
* @since 2.0
*/
@Mojo( name = "compile", defaultPhase = LifecyclePhase.COMPILE, threadSafe = true,
requiresDependencyResolution = ResolutionScope.COMPILE )
public class CompilerMojo
extends AbstractCompilerMojo
{
/**
* The source directories containing the sources to be compiled.
*/
@Parameter( defaultValue = "${project.compileSourceRoots}", readonly = true, required = true )
private List<String> compileSourceRoots;
/**
* The directory for compiled classes.
*/
@Parameter( defaultValue = "${project.build.outputDirectory}", required = true, readonly = true )
private File outputDirectory;
/**
* Projects main artifact.
*
* @todo this is an export variable, really
*/
@Parameter( defaultValue = "${project.artifact}", readonly = true, required = true )
private Artifact projectArtifact;
/**
* A list of inclusion filters for the compiler.
*/
@Parameter
private Set<String> includes = new HashSet<String>();
/**
* A list of exclusion filters for the compiler.
*/
@Parameter
private Set<String> excludes = new HashSet<String>();
/**
* <p>
* Specify where to place generated source files created by annotation processing. Only applies to JDK 1.6+
* </p>
*
* @since 2.2
*/
@Parameter( defaultValue = "${project.build.directory}/generated-sources/annotations" )
private File generatedSourcesDirectory;
/**
* Set this to 'true' to bypass compilation of main sources. Its use is NOT RECOMMENDED, but quite convenient on
* occasion.
*/
@Parameter( property = "maven.main.skip" )
private boolean skipMain;
@Parameter( defaultValue = "${project.compileClasspathElements}", readonly = true, required = true )
private List<String> compilePath;
@Parameter
private boolean allowPartialRequirements;
private QDoxModuleInfoParser moduleInfoParser = new QDoxModuleInfoParser();
private LocationManager locationManager = new LocationManager();
private List<String> classpathElements;
private List<String> modulepathElements;
protected List<String> getCompileSourceRoots()
{
return compileSourceRoots;
}
protected List<String> getClasspathElements()
{
return classpathElements;
}
@Override
protected List<String> getModulepathElements()
{
return modulepathElements;
}
protected File getOutputDirectory()
{
return outputDirectory;
}
public void execute()
throws MojoExecutionException, CompilationFailureException
{
if ( skipMain )
{
getLog().info( "Not compiling main sources" );
return;
}
super.execute();
if ( outputDirectory.isDirectory() )
{
projectArtifact.setFile( outputDirectory );
}
}
@Override
protected void preparePaths( Set<File> sourceFiles )
{
assert compilePath != null;
JavaModuleDescriptor moduleDescriptor = null;
boolean hasModuleDescriptor = false;
for ( File sourceFile : sourceFiles )
{
if ( "module-info.java".equals( sourceFile.getName() ) )
{
try
{
moduleDescriptor = moduleInfoParser.fromSourcePath( sourceFile.getParentFile().toPath() );
}
catch ( IOException e )
{
getLog().warn( "Failed to parse module-info.java: " + e.getMessage() );
}
hasModuleDescriptor = true;
break;
}
}
if ( hasModuleDescriptor )
{
// For now only allow named modules. Once we can create a graph with ASM we can specify exactly the modules
// and we can detect if auto modules are used. In that case, MavenProject.setFile() should not be used, so
// you cannot depend on this project and so it won't be distributed.
modulepathElements = new ArrayList<String>( compilePath.size() );
classpathElements = new ArrayList<String>( compilePath.size() );
ResolvePathsResult<File> analyzerResult;
try
{
Collection<File> dependencyArtifacts = getCompileClasspathElements( getProject() );
ResolvePathsRequest<File> request =
ResolvePathsRequest.withFiles( dependencyArtifacts ).setMainModuleDescriptor( moduleDescriptor );
Toolchain toolchain = getToolchain();
if ( toolchain != null && toolchain instanceof DefaultJavaToolChain )
{
request.setJdkHome( new File( ( (DefaultJavaToolChain) toolchain ).getJavaHome() ) );
}
analyzerResult = locationManager.resolvePaths( request );
for ( Map.Entry<File, ModuleNameSource> entry : analyzerResult.getModulepathElements().entrySet() )
{
if ( ModuleNameSource.FILENAME.equals( entry.getValue() ) )
{
final String message = "Required filename-based automodules detected. "
+ "Please don't publish this project to a public artifact repository!";
if ( moduleDescriptor.exports().isEmpty() )
{
// application
getLog().info( message );
}
else
{
// library
writeBoxedWarning( message );
}
break;
}
}
for ( File file : analyzerResult.getClasspathElements() )
{
classpathElements.add( file.getPath() );
}
for ( File file : analyzerResult.getModulepathElements().keySet() )
{
modulepathElements.add( file.getPath() );
}
}
catch ( IOException e )
{
getLog().warn( e.getMessage() );
}
}
else
{
classpathElements = compilePath;
modulepathElements = Collections.emptyList();
}
}
private List<File> getCompileClasspathElements( MavenProject project )
{
List<File> list = new ArrayList<File>( project.getArtifacts().size() + 1 );
list.add( new File( project.getBuild().getOutputDirectory() ) );
for ( Artifact a : project.getArtifacts() )
{
list.add( a.getFile() );
}
return list;
}
protected SourceInclusionScanner getSourceInclusionScanner( int staleMillis )
{
SourceInclusionScanner scanner;
if ( includes.isEmpty() && excludes.isEmpty() )
{
scanner = new StaleSourceScanner( staleMillis );
}
else
{
if ( includes.isEmpty() )
{
includes.add( "**/*.java" );
}
scanner = new StaleSourceScanner( staleMillis, includes, excludes );
}
return scanner;
}
protected SourceInclusionScanner getSourceInclusionScanner( String inputFileEnding )
{
SourceInclusionScanner scanner;
// it's not defined if we get the ending with or without the dot '.'
String defaultIncludePattern = "**/*" + ( inputFileEnding.startsWith( "." ) ? "" : "." ) + inputFileEnding;
if ( includes.isEmpty() && excludes.isEmpty() )
{
includes = Collections.singleton( defaultIncludePattern );
scanner = new SimpleSourceInclusionScanner( includes, Collections.<String>emptySet() );
}
else
{
if ( includes.isEmpty() )
{
includes.add( defaultIncludePattern );
}
scanner = new SimpleSourceInclusionScanner( includes, excludes );
}
return scanner;
}
protected String getSource()
{
return source;
}
protected String getTarget()
{
return target;
}
@Override
protected String getRelease()
{
return release;
}
protected String getCompilerArgument()
{
return compilerArgument;
}
protected Map<String, String> getCompilerArguments()
{
return compilerArguments;
}
protected File getGeneratedSourcesDirectory()
{
return generatedSourcesDirectory;
}
private void writeBoxedWarning( String message )
{
String line = StringUtils.repeat( "*", message.length() + 4 );
getLog().warn( line );
getLog().warn( "* " + MessageUtils.buffer().strong( message ) + " *" );
getLog().warn( line );
}
}