describe compiler configuration on run

hboutemy · hboutemy · commit 592e5c85e794 · 2022-12-15T23:57:40.000+01:00
diff --git a/plexus-compiler-api/src/main/java/org/codehaus/plexus/compiler/AbstractCompiler.java b/plexus-compiler-api/src/main/java/org/codehaus/plexus/compiler/AbstractCompiler.java
@@ -74,6 +74,8 @@ protected AbstractCompiler( CompilerOutputStyle compilerOutputStyle, String inpu
     //
     // ----------------------------------------------------------------------
 
+    public abstract String getCompilerId();
+
     public CompilerResult performCompile(CompilerConfiguration configuration)
             throws CompilerException 
     {
@@ -308,7 +310,8 @@ protected void logCompiling( String[] sourceFiles, CompilerConfiguration config
                 config.getWorkingDirectory().toPath().relativize( new File( config.getOutputLocation() ).toPath() ).toString();
             getLogger().info( "Compiling " +
                                   ( sourceFiles == null ? "" : ( sourceFiles.length + " source file" + ( sourceFiles.length == 1 ? " " : "s " ) ) ) +
-                                  "to " + to );
+                                  "with " + config.describe( getCompilerId() ) +
+                                  " to " + to );
         }
   }
 }
diff --git a/plexus-compiler-api/src/main/java/org/codehaus/plexus/compiler/CompilerConfiguration.java b/plexus-compiler-api/src/main/java/org/codehaus/plexus/compiler/CompilerConfiguration.java
@@ -24,6 +24,8 @@
  * SOFTWARE.
  */
 
+import org.codehaus.plexus.util.StringUtils;
+
 import java.io.File;
 import java.util.AbstractMap;
 import java.util.ArrayList;
@@ -812,4 +814,54 @@ public void setImplicitOption( String implicitOption )
     {
         this.implicitOption = implicitOption;
     }
+
+    public String describe( String id )
+    {
+        List<String> params = new ArrayList<>();
+        params.add( id );
+        if ( isFork() )
+        {
+            params.add( "forked" );
+        }
+
+        // base options: debug, optimize, verbose, deprecation
+        if ( isDebug() )
+        {
+            if ( StringUtils.isNotEmpty( getDebugLevel() ) )
+            {
+                params.add( "debug:" + getDebugLevel() );
+            }
+            else
+            {
+                params.add( "debug" );
+            }
+        }
+        if ( isOptimize() )
+        {
+            params.add( "optimize" );
+        }
+        if ( isVerbose() )
+        {
+            params.add( "verbose" );
+        }
+        if ( isShowDeprecation() )
+        {
+            params.add( "deprecation" );
+        }
+
+        // target bytecode options: release or target, module-path
+        if ( !StringUtils.isEmpty( getReleaseVersion() ) )
+        {
+            params.add( "release " + getReleaseVersion() );
+        }
+        else if ( !StringUtils.isEmpty( getTargetVersion() ) )
+        {
+            params.add( "target " + getTargetVersion() );
+        }
+        if ( getModulepathEntries() != null && !getModulepathEntries().isEmpty() )
+        {
+            params.add( "module-path" );
+        }
+        return String.join( " ", params );
+    }
 }
diff --git a/plexus-compiler-its/src/main/it/simple-javac-fork/pom.xml b/plexus-compiler-its/src/main/it/simple-javac-fork/pom.xml
@@ -24,16 +24,15 @@
   <modelVersion>4.0.0</modelVersion>
 
   <groupId>org.codehaus.plexus.compiler.it</groupId>
-  <artifactId>simple-javac</artifactId>
+  <artifactId>simple-javac-forked</artifactId>
   <version>1.0-SNAPSHOT</version>
 
-  <name>Test for default configuration</name>
+  <name>Test for default configuration with forked=true</name>
 
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-    <maven.compiler.source>11</maven.compiler.source>
-    <maven.compiler.target>11</maven.compiler.target>
+    <maven.compiler.release>11</maven.compiler.release>
     <plexus.compiler.version>@pom.version@</plexus.compiler.version>
   </properties>
 
diff --git a/plexus-compilers/plexus-compiler-aspectj/src/main/java/org/codehaus/plexus/compiler/ajc/AspectJCompiler.java b/plexus-compilers/plexus-compiler-aspectj/src/main/java/org/codehaus/plexus/compiler/ajc/AspectJCompiler.java
@@ -303,6 +303,12 @@ public AspectJCompiler()
         super( CompilerOutputStyle.ONE_OUTPUT_FILE_PER_INPUT_FILE, "", ".class", null );
     }
 
+    @Override
+    public String getCompilerId()
+    {
+        return "aspectj";
+    }
+
     public CompilerResult performCompile( CompilerConfiguration config )
         throws CompilerException
     {
diff --git a/plexus-compilers/plexus-compiler-csharp/src/main/java/org/codehaus/plexus/compiler/csharp/CSharpCompiler.java b/plexus-compilers/plexus-compiler-csharp/src/main/java/org/codehaus/plexus/compiler/csharp/CSharpCompiler.java
@@ -84,6 +84,12 @@ public CSharpCompiler()
     // Compiler Implementation
     // ----------------------------------------------------------------------
 
+    @Override
+    public String getCompilerId()
+    {
+        return "csharp";
+    }
+
     public boolean canUpdateTarget( CompilerConfiguration configuration )
         throws CompilerException
     {
diff --git a/plexus-compilers/plexus-compiler-eclipse/src/main/java/org/codehaus/plexus/compiler/eclipse/EclipseJavaCompiler.java b/plexus-compilers/plexus-compiler-eclipse/src/main/java/org/codehaus/plexus/compiler/eclipse/EclipseJavaCompiler.java
@@ -72,6 +72,12 @@ public EclipseJavaCompiler()
     // ----------------------------------------------------------------------
     boolean errorsAsWarnings = false;
 
+    @Override
+    public String getCompilerId()
+    {
+        return "eclipse";
+    }
+
     @Override
     public CompilerResult performCompile( CompilerConfiguration config )
         throws CompilerException
@@ -371,6 +377,10 @@ public void report( Diagnostic<? extends JavaFileObject> diagnostic )
                     args.add( errorF.toString() );
                     args.addAll( allSources );
 
+                    String to = ( config.getWorkingDirectory() == null ) ? config.getOutputLocation() :
+                        config.getWorkingDirectory().toPath().relativize( new File( config.getOutputLocation() ).toPath() ).toString();
+                    getLogger().info( "Compiling with " + config.describe( "eclipse" ) +
+                            " to " + to );
                     getLogger().debug( "ecj command line: " + args );
 
                     success = BatchCompiler.compile( args.toArray( new String[args.size()] ), devNull, devNull,
diff --git a/plexus-compilers/plexus-compiler-j2objc/src/main/java/org/codehaus/plexus/compiler/j2objc/J2ObjCCompiler.java b/plexus-compilers/plexus-compiler-j2objc/src/main/java/org/codehaus/plexus/compiler/j2objc/J2ObjCCompiler.java
@@ -51,7 +51,7 @@
  *         Ma&icirc;tre</a>
  *
  */
-@Component( role = Compiler.class, hint = "j2objc ")
+@Component( role = Compiler.class, hint = "j2objc")
 public class J2ObjCCompiler
     extends AbstractCompiler
 {
@@ -98,6 +98,12 @@ public J2ObjCCompiler()
     // Compiler Implementation
     // ----------------------------------------------------------------------
 
+    @Override
+    public String getCompilerId()
+    {
+        return "j2objc";
+    }
+
     public boolean canUpdateTarget( CompilerConfiguration configuration )
         throws CompilerException
     {
diff --git a/plexus-compilers/plexus-compiler-javac-errorprone/src/main/java/org/codehaus/plexus/compiler/javac/errorprone/JavacCompilerWithErrorProne.java b/plexus-compilers/plexus-compiler-javac-errorprone/src/main/java/org/codehaus/plexus/compiler/javac/errorprone/JavacCompilerWithErrorProne.java
@@ -44,6 +44,12 @@
 public class JavacCompilerWithErrorProne
     extends JavacCompiler
 {
+    @Override
+    public String getCompilerId()
+    {
+        return "javac-with-errorprone";
+    }
+
     private static class NonDelegatingClassLoader
         extends URLClassLoader
     {
diff --git a/plexus-compilers/plexus-compiler-javac/src/main/java/org/codehaus/plexus/compiler/javac/JavacCompiler.java b/plexus-compilers/plexus-compiler-javac/src/main/java/org/codehaus/plexus/compiler/javac/JavacCompiler.java
@@ -123,6 +123,12 @@ public JavacCompiler()
     // Compiler Implementation
     // ----------------------------------------------------------------------
 
+    @Override
+    public String getCompilerId()
+    {
+        return "javac";
+    }
+
     @Override
     public CompilerResult performCompile( CompilerConfiguration config )
         throws CompilerException

Original file line number	Diff line number	Diff line change
`@@ -74,6 +74,8 @@ protected AbstractCompiler( CompilerOutputStyle compilerOutputStyle, String inpu`
`74`	`74`	`//`
`75`	`75`	`// ----------------------------------------------------------------------`
`76`	`76`
	`77`	`+ public abstract String getCompilerId();`
	`78`	`+`
`77`	`79`	`public CompilerResult performCompile(CompilerConfiguration configuration)`
`78`	`80`	`throws CompilerException`
`79`	`81`	`{`
`@@ -308,7 +310,8 @@ protected void logCompiling( String[] sourceFiles, CompilerConfiguration config`
`308`	`310`	`config.getWorkingDirectory().toPath().relativize( new File( config.getOutputLocation() ).toPath() ).toString();`
`309`	`311`	`getLogger().info( "Compiling " +`
`310`	`312`	`( sourceFiles == null ? "" : ( sourceFiles.length + " source file" + ( sourceFiles.length == 1 ? " " : "s " ) ) ) +`
`311`		`- "to " + to );`
	`313`	`+ "with " + config.describe( getCompilerId() ) +`
	`314`	`+ " to " + to );`
`312`	`315`	`}`
`313`	`316`	`}`
`314`	`317`	`}`
Original file line number	Diff line number	Diff line change
`@@ -303,6 +303,12 @@ public AspectJCompiler()`
`303`	`303`	`super( CompilerOutputStyle.ONE_OUTPUT_FILE_PER_INPUT_FILE, "", ".class", null );`
`304`	`304`	`}`
`305`	`305`
	`306`	`+ @Override`
	`307`	`+ public String getCompilerId()`
	`308`	`+ {`
	`309`	`+ return "aspectj";`
	`310`	`+ }`
	`311`	`+`
`306`	`312`	`public CompilerResult performCompile( CompilerConfiguration config )`
`307`	`313`	`throws CompilerException`
`308`	`314`	`{`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,12 @@`
`44`	`44`	`public class JavacCompilerWithErrorProne`
`45`	`45`	`extends JavacCompiler`
`46`	`46`	`{`
	`47`	`+ @Override`
	`48`	`+ public String getCompilerId()`
	`49`	`+ {`
	`50`	`+ return "javac-with-errorprone";`
	`51`	`+ }`
	`52`	`+`
`47`	`53`	`private static class NonDelegatingClassLoader`
`48`	`54`	`extends URLClassLoader`
`49`	`55`	`{`