/*
    * Themis: Java Project Framework
    * Copyright 2012-2026. Tony Washer
    *
    * 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 io.github.tonywasher.joceanus.themis.lethe.analysis;
  
  import io.github.tonywasher.joceanus.oceanus.base.OceanusException;
  
  import java.io.File;
  import java.util.ArrayList;
  import java.util.List;
  import java.util.Objects;
  
  /**
   * Package.
   */
  public class ThemisAnalysisPackage
          implements ThemisAnalysisElement {
      /**
       * The java suffix.
       */
      public static final String SFX_JAVA = ".java";
  
      /**
       * The package-info file.
       */
      private static final String PACKAGE_INFO = "package-info" + SFX_JAVA;
  
      /**
       * The package name.
       */
      private final String thePackage;
  
      /**
       * The list of files in this package.
       */
      private final List<ThemisAnalysisFile> theFiles;
  
      /**
       * The initial dataMap.
       */
      private final ThemisAnalysisDataMap theDataMap;
  
      /**
       * Module Constructor.
       *
       * @param pModule  the owning module
       * @param pPackage the package name.
       * @throws OceanusException on error
       */
      ThemisAnalysisPackage(final ThemisAnalysisModule pModule,
                            final String pPackage) throws OceanusException {
          /* Initialise class */
          this(pModule.getLocation(), new ThemisAnalysisDataMap(pModule.getDataMap()), pPackage);
      }
  
      /**
       * Constructor.
       *
       * @param pLocation the base location for the package
       * @param pPackage  the package name.
       * @throws OceanusException on error
       */
      ThemisAnalysisPackage(final File pLocation,
                            final String pPackage) throws OceanusException {
          /* Initialise class */
          this(pLocation, new ThemisAnalysisDataMap(), pPackage);
  
          /* initialPass */
          performConsolidationPass();
  
          /* consolidationPass */
          performConsolidationPass();
  
          /* finalPass */
          performFinalPass();
      }
  
      /**
       * Constructor.
       *
       * @param pLocation the base location for the package
       * @param pDataMap  the dataMap
       * @param pPackage  the package name.
       */
      private ThemisAnalysisPackage(final File pLocation,
                                    final ThemisAnalysisDataMap pDataMap,
                                   final String pPackage) {
         /* Store package name and dataMap */
         thePackage = pPackage;
         theDataMap = pDataMap;
 
         /* Create directory path and record the location */
         final String myPath = pPackage.replace(ThemisAnalysisChar.PERIOD, File.separatorChar);
         final File myLocation = new File(pLocation, myPath);
 
         /* Build list of files */
         theFiles = listFiles(myLocation);
     }
 
     /**
      * Obtain the files.
      *
      * @return the files
      */
     public List<ThemisAnalysisFile> getFiles() {
         return theFiles;
     }
 
     /**
      * Obtain the dataMap.
      *
      * @return the map
      */
     ThemisAnalysisDataMap getDataMap() {
         return theDataMap;
     }
 
     /**
      * Build list of files.
      *
      * @param pLocation the location
      * @return the list of files
      */
     List<ThemisAnalysisFile> listFiles(final File pLocation) {
         /* Allocate the list */
         final List<ThemisAnalysisFile> myClasses = new ArrayList<>();
 
         /* Loop through the entries in the directory */
         for (File myFile : Objects.requireNonNull(pLocation.listFiles())) {
             /* Handle files */
             if (!myFile.isDirectory()) {
                 /* Access the name of the file */
                 final String myName = myFile.getName();
 
                 /* If this is a .java that is not package-info */
                 if (myName.endsWith(SFX_JAVA)
                         && !PACKAGE_INFO.equals(myName)) {
                     /* Add the class */
                     final ThemisAnalysisFile myClass = new ThemisAnalysisFile(this, myFile);
                     myClasses.add(myClass);
                 }
             }
         }
 
         /* Return the classes */
         return myClasses;
     }
 
     /**
      * initialPass process files.
      *
      * @throws OceanusException on error
      */
     void performInitialPass() throws OceanusException {
         /* Loop through the classes */
         for (ThemisAnalysisFile myFile : theFiles) {
             /* Process the file */
             myFile.processFile();
         }
     }
 
     /**
      * consolidationPass process files.
      *
      * @throws OceanusException on error
      */
     void performConsolidationPass() throws OceanusException {
         /* Loop through the classes */
         for (ThemisAnalysisFile myFile : theFiles) {
             /* Process the file */
             myFile.consolidationProcessingPass();
         }
     }
 
     /**
      * finalPass process files.
      *
      * @throws OceanusException on error
      */
     void performFinalPass() throws OceanusException {
         /* Loop through the classes */
         for (ThemisAnalysisFile myFile : theFiles) {
             /* Process the file */
             myFile.finalProcessingPass();
         }
     }
 
     /**
      * Obtain the package.
      *
      * @return the package
      */
     public String getPackage() {
         return thePackage;
     }
 
     /**
      * Is the line a package?
      *
      * @param pLine the line
      * @return true/false
      * @throws OceanusException on error
      */
     static boolean isPackage(final ThemisAnalysisLine pLine) throws OceanusException {
         /* If we are ended by a semi-colon and this is a package line */
         if (pLine.endsWithChar(ThemisAnalysisChar.SEMICOLON)
                 && pLine.isStartedBy(ThemisAnalysisKeyWord.PACKAGE.getKeyWord())) {
             /* Strip the semi-colon and return true */
             pLine.stripEndChar(ThemisAnalysisChar.SEMICOLON);
             return true;
         }
 
         /* return false */
         return false;
     }
 
     @Override
     public String toString() {
         return thePackage;
     }
 }