diff --git a/src/it/MCOMPILER-205/invoker.properties b/src/it/MCOMPILER-205/invoker.properties new file mode 100644 index 000000000..8595721d9 --- /dev/null +++ b/src/it/MCOMPILER-205/invoker.properties @@ -0,0 +1,19 @@ +# 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. + +invoker.goals = clean compile +invoker.buildResult = success diff --git a/src/it/MCOMPILER-205/pom.xml b/src/it/MCOMPILER-205/pom.xml new file mode 100644 index 000000000..2f291f70a --- /dev/null +++ b/src/it/MCOMPILER-205/pom.xml @@ -0,0 +1,44 @@ + + + + + 4.0.0 + + blah + blah + 1.0 + jar + + + UTF-8 + + + + + org.apache.maven.plugins + maven-compiler-plugin + @pom.version@ + + + + diff --git a/src/it/MCOMPILER-205/src/main/java/dummy/HelloWorld.java b/src/it/MCOMPILER-205/src/main/java/dummy/HelloWorld.java new file mode 100644 index 000000000..f223c74d3 --- /dev/null +++ b/src/it/MCOMPILER-205/src/main/java/dummy/HelloWorld.java @@ -0,0 +1,28 @@ +package dummy; + +/* + * 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. + */ + + +public class HelloWorld +{ + public static void main(String[] argv) { + System.out.println("Hello World"); + } +} diff --git a/src/it/MCOMPILER-205/src/main/java/dummy/package-info.java b/src/it/MCOMPILER-205/src/main/java/dummy/package-info.java new file mode 100644 index 000000000..ed72542b8 --- /dev/null +++ b/src/it/MCOMPILER-205/src/main/java/dummy/package-info.java @@ -0,0 +1,23 @@ +/* + * 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. + */ + +/** + * This is the package javadoc + */ +package dummy; \ No newline at end of file diff --git a/src/it/MCOMPILER-205/verify.groovy b/src/it/MCOMPILER-205/verify.groovy new file mode 100644 index 000000000..1526f8669 --- /dev/null +++ b/src/it/MCOMPILER-205/verify.groovy @@ -0,0 +1,21 @@ + +/* + * 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. + */ +def packageInfoClassFile = new File( basedir, 'target/classes/dummy/package-info.class' ) +assert packageInfoClassFile.exists() diff --git a/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java b/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java index 5b3b09c7e..44f706915 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java +++ b/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java @@ -82,6 +82,8 @@ import org.codehaus.plexus.compiler.util.scan.mapping.SuffixMapping; import org.codehaus.plexus.languages.java.jpms.JavaModuleDescriptor; import org.codehaus.plexus.languages.java.version.JavaVersion; +import org.objectweb.asm.ClassWriter; +import org.objectweb.asm.Opcodes; /** * TODO: At least one step could be optimized, currently the plugin will do two @@ -520,6 +522,18 @@ public abstract class AbstractCompilerMojo @Parameter( defaultValue = "true", property = "maven.compiler.useIncrementalCompilation" ) private boolean useIncrementalCompilation = true; + /** + * Package info source files that only contain javadoc and no annotation on the package + * can lead to no class file being generated by the compiler. This causes a file miss + * on the next compilations and forces an unnecessary recompilation. The default value + * of true causes an empty class file to be generated. This behavior can + * be changed by setting this parameter to false. + * + * @since 3.10 + */ + @Parameter( defaultValue = "true", property = "maven.compiler.createMissingPackageInfoClass" ) + private boolean createMissingPackageInfoClass = true; + /** * Resolves the artifacts needed. */ @@ -1182,6 +1196,21 @@ else if ( !values[0].equals( descriptor.name() ) ) throw new MojoExecutionException( "Fatal error compiling", e ); } + if ( createMissingPackageInfoClass && compilerResult.isSuccess() + && compiler.getCompilerOutputStyle() == CompilerOutputStyle.ONE_OUTPUT_FILE_PER_INPUT_FILE ) + { + try + { + SourceMapping sourceMapping = getSourceMapping( compilerConfiguration, compiler ); + createMissingPackageInfoClasses( compilerConfiguration, sourceMapping, sources ); + } + catch ( Exception e ) + { + getLog().warn( "Error creating missing package info classes", e ); + + } + } + if ( useIncrementalCompilation ) { if ( incrementalBuildHelperRequest.getOutputDirectory().exists() ) @@ -1286,6 +1315,72 @@ else if ( message.getKind() == CompilerMessage.Kind.WARNING } } + private void createMissingPackageInfoClasses( CompilerConfiguration compilerConfiguration, + SourceMapping sourceMapping, + Set sources ) + throws InclusionScanException, IOException + { + for ( File source : sources ) + { + String path = source.toString(); + if ( path.endsWith( File.separator + "package-info.java" ) ) + { + for ( String root : getCompileSourceRoots() ) + { + root = root + File.separator; + if ( path.startsWith( root ) ) + { + String rel = path.substring( root.length() ); + Set files = sourceMapping.getTargetFiles( getOutputDirectory(), rel ); + for ( File file : files ) + { + if ( !file.exists() ) + { + byte[] bytes = generatePackage( compilerConfiguration, rel ); + Files.write( file.toPath(), bytes ); + } + } + } + } + } + } + } + + private byte[] generatePackage( CompilerConfiguration compilerConfiguration, String javaFile ) + { + int version = getOpcode( compilerConfiguration ); + ClassWriter cw = new ClassWriter( 0 ); + cw.visitSource( "package-info.java", null ); + cw.visit( version, + Opcodes.ACC_SYNTHETIC | Opcodes.ACC_ABSTRACT | Opcodes.ACC_INTERFACE, + javaFile.substring( 0, javaFile.length() - ".java".length() ), + null, "java/lang/Object", null ); + return cw.toByteArray(); + } + + private int getOpcode( CompilerConfiguration compilerConfiguration ) + { + String version = compilerConfiguration.getReleaseVersion(); + if ( version == null ) + { + version = compilerConfiguration.getTargetVersion(); + if ( version == null ) + { + version = "1.5"; + } + } + if ( version.startsWith( "1." ) ) + { + version = version.substring( 2 ); + } + int iVersion = Integer.parseInt( version ); + if ( iVersion < 2 ) + { + throw new IllegalArgumentException( "Unsupported java version '" + version + "'" ); + } + return iVersion - 2 + Opcodes.V1_2; + } + protected boolean isTestCompile() { return false;