/*
    * DaCapo Benchmark Maven Plugin
    * Copyright (C) 2010 Technische Universität Darmstadt
    * info@scalabench.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.scalabench.plugins.dacapo;
  
  import java.util.Set;
  
  import org.apache.maven.artifact.Artifact;
  import org.apache.maven.plugin.AbstractMojo;
  import org.apache.maven.plugin.MojoExecutionException;
  import org.apache.maven.project.MavenProject;
  import org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException;
  import org.apache.maven.shared.artifact.filter.collection.FilterArtifacts;
  import org.apache.maven.shared.artifact.filter.collection.ScopeFilter;
  
  public abstract class AbstractDacapoBenchmarkMojo extends AbstractMojo {
      
      /**
       * The Maven project being built.
       * 
       * @required
       * @readonly
       * @parameter expression="${project}"
       */
      private MavenProject project;
      
      /**
       * The name of the benchmark. If unspecified, it is derived from the project's <code>artifactId</code>.
       * 
       * If the <code>artifactId</code> matches one of the following patterns, the benchmark name is extracted from it as
       * indicated:
       * 
       * <ul>
       *   <li><code>${benchmarkName}</code>-dacapo-benchmark</li>
       *   <li>dacapo-<code>${benchmarkName}</code>-benchmark</li>
       * </ul>
       * 
       * Otherwise, the <code>artifactId</code> is taken wholesale.
       * 
       * @parameter
       */
      private String benchmarkName;
      
      public MavenProject getProject() {
          return project;
      }
      
      public String getBenchmarkName() {
          if (benchmarkName == null)
              return getBenchmarkNameFromArtifactId(getProject().getArtifactId());
          else
              return benchmarkName;
      }
      
      public static String getBenchmarkNameFromArtifactId(String artifactId) {
          final String DACAPO_BENCHMARK_SUFFIX = "-dacapo-benchmark";
          final String DACAPO_PREFIX = "dacapo-";
          final String BENCHMARK_SUFFIX = "-benchmark";
          
          if (artifactId.endsWith(DACAPO_BENCHMARK_SUFFIX))
              return artifactId.substring(0, artifactId.length() - DACAPO_BENCHMARK_SUFFIX.length());
          else if (artifactId.startsWith(DACAPO_PREFIX) && artifactId.endsWith(BENCHMARK_SUFFIX))
              return artifactId.substring(DACAPO_PREFIX.length(), artifactId.length() - BENCHMARK_SUFFIX.length());
          else
              return artifactId;
      }
      
      /**
       * Gets the library artifacts the benchmark depends on.
       * 
       * All provided-scoped dependencies are assumed to be dependencies of the benchmark itself (as opposed to dependencies of
       * the harness).
       */
      public Set<Artifact> getLibraries() throws MojoExecutionException {
          final FilterArtifacts filter = new FilterArtifacts();
          filter.addFilter(new ScopeFilter(Artifact.SCOPE_PROVIDED, ""));
          
          try {
              return filter.filter(getProject().getArtifacts());
          } catch (ArtifactFilterException e) {
              throw new MojoExecutionException(e.getMessage(), e);
          }
      }
      
      public void logDebug(String format, Object... args) {
         getLog().debug(String.format(format, args));
     }
     
     public void logInfo(String format, Object... args) {
         getLog().info(String.format(format, args));
     }
     
     public void logWarn(String format, Object... args) {
         getLog().warn(String.format(format, args));
     }
     
     public void logError(String format, Object... args) {
         getLog().error(String.format(format, args));
     }
 }