/*
    * Copyright 2010-2013 smartics, Kronseder & Reiner GmbH
    *
    * 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 de.smartics.testdoc.collect.processor;
  
  import java.util.HashSet;
  import java.util.Set;
  import java.util.logging.Logger;
  
  import javax.annotation.processing.RoundEnvironment;
  import javax.lang.model.element.Element;
  import javax.lang.model.element.ElementKind;
  import javax.lang.model.element.ExecutableElement;
  import javax.lang.model.element.TypeElement;
  import javax.lang.model.element.VariableElement;
  
  import de.smartics.testdoc.collect.extractor.ExtractorConfig;
  import de.smartics.testdoc.collect.extractor.TestDocMethodExtractor;
  import de.smartics.testdoc.collect.extractor.TestDocTypeExtractor;
  import de.smartics.testdoc.collect.extractor.TestDocVariableExtractor;
  import de.smartics.testdoc.core.doc.ScenarioTestDoc;
  import de.smartics.testdoc.core.doc.Type;
  import de.smartics.testdoc.core.doc.UnitTestDoc;
  import de.smartics.testdoc.core.export.ExportAdapter;
  
  /**
   * Processes the UUT annotations passed to the annotation processor.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public class UutProcess
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * Class logger.
     */
    private static final Logger LOG = Logger
        .getLogger(UutProcess.class.getName());
  
    // --- members --------------------------------------------------------------
  
    /**
     * The set of types that have already been cleaned during the execution of
     * this process. Each type has to be removed before it is processed so that no
     * removed information persists in the index.
     */
    private final Set<Type> alreadyClearedTestCaseTypes = new HashSet<Type>();
  
    /**
     * The logger to use to log to the processor context.
     */
    private final ProcessorLogHelper processorLog;
  
    /**
     * The adapter to export unit test documentation.
     */
    private final ExportAdapter exporter;
  
    /**
     * Utilities to extract information.
     */
    private final ExtractorConfig extractorConfig;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     */
    public UutProcess(final ProcessorLogHelper processorLog,
        final ExportAdapter exporter, final ExtractorConfig extractorConfig)
    {
      this.processorLog = processorLog;
      this.exporter = exporter;
      this.extractorConfig = extractorConfig;
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   // --- business -------------------------------------------------------------
 
   public void processElements(final RoundEnvironment roundEnv,
       final TypeElement annotation)
   {
     final AnnotationLogHelper log =
         new AnnotationLogHelper(LOG, processorLog, annotation);
 
     final Set<? extends Element> elements =
         roundEnv.getElementsAnnotatedWith(annotation);
     for (final Element element : elements)
     {
       final ElementKind kind = element.getKind();
 
       log.logProcessingElementEntry(element, kind);
 
       if (ElementKind.CLASS.equals(kind))
       {
         process((TypeElement) element);
       }
       else if (ElementKind.METHOD.equals(kind))
       {
         process((ExecutableElement) element);
       }
       else if (ElementKind.FIELD.equals(kind))
       {
         process((VariableElement) element);
       }
       else if (ElementKind.LOCAL_VARIABLE.equals(kind))
       {
         // Does not work currently.
         process((VariableElement) element);
       }
       else
       {
         log.note("Unsupported annotation target '"
                  + element.getClass().getName() + "'.");
       }
       log.logProcessingElementExit();
     }
   }
 
   private void process(final TypeElement testCaseType)
   {
     final TestDocTypeExtractor extractor =
         new TestDocTypeExtractor(extractorConfig, testCaseType);
     final UnitTestDoc testDoc = extractor.readTestDoc();
     if (testDoc != null)
     {
       clearIfRequired(testDoc);
       exporter.export(testDoc);
     }
   }
 
   private void process(final ExecutableElement element)
   {
     final ElementKind kind = element.getKind();
     if (ElementKind.METHOD.equals(kind))
     {
       final TestDocMethodExtractor extractor =
           new TestDocMethodExtractor(extractorConfig, element);
       final UnitTestDoc testDoc = extractor.readTestDoc();
       if (testDoc != null)
       {
         clearIfRequired(testDoc);
         exporter.export(testDoc);
       }
     }
   }
 
   private void process(final VariableElement element)
   {
     final ElementKind kind = element.getKind();
     if (ElementKind.FIELD.equals(kind))
     {
       final TestDocVariableExtractor extractor =
           new TestDocVariableExtractor(extractorConfig, element);
       final UnitTestDoc testDoc = extractor.readTestDoc();
       clearIfRequired(testDoc);
       exporter.export(testDoc);
     }
     // else if (ElementKind.LOCAL_VARIABLE.equals(kind))
     // {
     // // Does not work currently.
     // }
     // else
     // {
     // note("Unsupported annotation target type '" + kind.toString()
     // + "' for a variable.");
     // }
   }
 
   private void clearIfRequired(final UnitTestDoc testDoc)
   {
     for (ScenarioTestDoc scenario : testDoc.getScenarios())
     {
       final Type testCaseType = scenario.getTestCaseType();
       if (!alreadyClearedTestCaseTypes.contains(testCaseType))
       {
         exporter.clear(testCaseType);
         alreadyClearedTestCaseTypes.add(testCaseType);
       }
     }
   }
 
   // --- object basics --------------------------------------------------------
 
 }