package Torello.Java.Build;

import Torello.Java.StringParse;
import Torello.Java.FileNode;
import Torello.Java.RTC;

import Torello.Java.Additional.Counter;

import java.io.File;
import java.io.FilenameFilter;
import java.io.IOException;

import java.util.ArrayList;
import java.util.function.Predicate;

import Torello.Java.ReadOnly.ROArrayListBuilder;
import Torello.Java.ReadOnly.ROHashtableBuilder;
import Torello.Java.ReadOnly.ReadOnlyList;
import Torello.Java.ReadOnly.ReadOnlyArrayList;

import Torello.Java.StrCSV;

import static Torello.Java.C.BRED;
import static Torello.Java.C.RESET;

/**
 * Given a list of Java-Packages, this class will collate a list of files to be processed.
 * 
 * <BR /><BR />This class is a utility used internally by the following Build-Stages:
 *
 * <BR /><BR /><UL CLASS=JDUL>
 * <LI>Compilation / Stage-1</LI>
 * <LI>Documentation / Java-Doc / Stage-2</LI>
 * </UL>
 * 
 * <BR />
 * <EMBED CLASS='external-html' DATA-FILE-ID=INTERNAL_CLASS_NOTE>
 */
@Torello.JavaDoc.StaticFunctional
public class Files
{
    // Completely irrelevant, and the 'private' modifier keeps it off of JavaDoc
    private Files() { }

    private static final String FS = File.separator;


    // ********************************************************************************************
    // ********************************************************************************************
    // File-Array Builder
    // ********************************************************************************************
    // ********************************************************************************************


    private static final int addMore(
            final ROArrayListBuilder<String>    b,
            final String                        dir,
            final boolean                       depth,
            final FilenameFilter                filter
        )
    {
        Counter c = new Counter(0);

        FileNode
            .createRoot         (dir)
            .loadTree           (depth ? -1 : 0, filter, null)
            .flattenJustFiles   (RTC.FULLPATH_VECTOR())
            .forEach            ((String srcFileName) -> { c.addOne(); b.add(srcFileName); });

        return c.get();
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Stage 01, Compile Files
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Retrieve the Stage 1 Files List of {@code '.java'} Files.  The master list that is returned
     * as a result of this method is the complete list of files sent to {@code 'javac'}, as command
     * line parameters.
     * 
     * @param packagesToCompile The list of packages whose files need to be compiled.  This list,
     * itself, was built by class {@link Packages} method
     * {@link Packages#packagesToCompile(BuilderRecord) builder} using all User-Provided
     * Configurations, and Command-Line Switch Choices.
     * 
     * @param logAndScreen Prints log information to both the log and the terminal-screen.
     * 
     * @return The list of files to be compiled by the Stage 1 Build-Class
     * {@link S01_JavaCompiler}.
     * 
     * @throws IOException Required due to the {@code Appendable} parameter {@code 'logAndScreen'}
     * @see Printing#printFilesCount(ReadOnlyList, ArrayList, Appendable)
     */
    static ReadOnlyList<String> filesToCompile(
            final ReadOnlyList<BuildPackage>    packagesToCompile,
            final Appendable                    logAndScreen
        )
        throws IOException
    {
        // This is much easier to understand.  It is actually smarter to just go to the class
        // "Files" and look what it is doing.  The loop that collects the files for a "Package"
        // uses the following BuildPackage boolean-fields, which are defined, as below, inside the
        // BuildPackage-Constructor:
        //
        // BuildPackage.hasSubPackages     = (flags & HAS_SUB_PACKAGES)    >= 1;
        // BuildPackage.pkgRootDirectory   = classPathLocation + fullName.replace(".", FS) + FS;
        //
        // this.helperPackages = (helperPackages == null) || (helperPackages.length == 0)
        //     ? EMPTY_LIST
        //     : ReadOnlyList.of(helperPackages);
        //
        // Just go to class "Files" to see how those "BuildPackage" boolean Configuration-Fields
        // pick files to insert into the "filesToCompile" list.

        // This keeps a complete list of all files that will need to be compiled
        ROArrayListBuilder<String> roalb = new ROArrayListBuilder<>();

        // This is used for printing to the screen only, it is discarded when this method
        // exits.

        final ArrayList<Integer> packageFilesCount = new ArrayList<>(packagesToCompile.size());

        for (final BuildPackage pkg : packagesToCompile)
        {
            int count = 0;

            count += addMore(roalb, pkg.pkgRootDirectory, pkg.hasSubPackages, FileNode.JAVA_FILES);

            if (pkg.hasUpgradeFilesDir) count += addMore
                (roalb, pkg.pkgRootDirectory + "upgrade-files" + FS, true, FileNode.JAVA_FILES);

            if (pkg.hasPackageSourceDir) count += addMore
                (roalb, pkg.pkgRootDirectory + "package-source" + FS, true, FileNode.JAVA_FILES);

            for (String helperPkgDirName : pkg.helperPackages) count += addMore
                (roalb, helperPkgDirName, false, FileNode.JAVA_FILES);

            packageFilesCount.add(Integer.valueOf(count));
        }


        // Prints out the number of '.java' Files that were found, in each of the
        // package-directories.
        // 
        // TRUE ==> '.java' Files (FALSE ==> '.class' Files)

        Printing.printFilesCount(packagesToCompile, packageFilesCount, logAndScreen, true);

        return roalb.build();
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Stage 01, Optional-Action, First Delete '.class' Files.  Retrieve all '.class' File-Names
    // ********************************************************************************************
    // ********************************************************************************************


    // This method was Block-Copied (^C^V), directly from the previous method.  This meethod,
    // instead of finding and retrieving all of the '.java' Files that need to be compiled, it
    // retrieves the names of all of the old '.class' Files that are to be deleted, before the
    // '.java' files are compiled.

    static ReadOnlyList<String> classFilesToDeleteBeforeCompilation(
            final ReadOnlyList<BuildPackage>    packagesToCompile,
            final Appendable                    logAndScreen
        )
        throws IOException
    {
        ROArrayListBuilder<String> roalb = new ROArrayListBuilder<>();

        final ArrayList<Integer> packageFilesCount = new ArrayList<>(packagesToCompile.size());

        for (final BuildPackage pkg : packagesToCompile)
        {
            int count = 0;

            count += addMore(roalb, pkg.pkgRootDirectory, pkg.hasSubPackages, FileNode.CLASS_FILES);

            if (pkg.hasUpgradeFilesDir) count += addMore
                (roalb, pkg.pkgRootDirectory + "upgrade-files" + FS, true, FileNode.CLASS_FILES);

            if (pkg.hasPackageSourceDir) count += addMore
                (roalb, pkg.pkgRootDirectory + "package-source" + FS, true, FileNode.CLASS_FILES);

            for (String helperPkgDirName : pkg.helperPackages) count += addMore
                (roalb, helperPkgDirName, false, FileNode.CLASS_FILES);

            packageFilesCount.add(Integer.valueOf(count));
        }


        // Prints out the number of '.class' Files that were found, in each of the
        // package-directories.
        // 
        // TRUE ==> '.java' Files, FALSE ==> '.class' Files

        Printing.printFilesCount(packagesToCompile, packageFilesCount, logAndScreen, false);

        return roalb.build();
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Stage 02, JavaDoc Files
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Retrieve the Stage 1 Files List of {@code '.java'} Files.  The master list that is returned
     * as a result of this method is the complete list of files sent to {@code 'javadoc'}, as
     * command line parameters.
     * 
     * @param packagesToJavaDoc The list of packages whose files need to be compiled.  This list,
     * itself, was built by class {@link Packages} method
     * {@link Packages#packagesToCompile(BuilderRecord) builder} using all User-Provided
     * Configurations, and Command-Line Switch Choices.
     * 
     * @param logAndScreen Prints log information to both the log and the terminal-screen.
     * 
     * @return The list of files to be compiled by the Stage 2 Build-Class
     * {@link S02_JavaDoc}.
     * 
     * @throws IOException Required due to the {@code Appendable} parameter {@code 'logAndScreen'}
     */
    static ReadOnlyList<String> filesToJavaDoc(
            final ReadOnlyList<BuildPackage>    packagesToJavaDoc,
            final Appendable                    logAndScreen
        )
        throws IOException
    {
        // This keeps a complete list of all files that will need to be compiled
        ROArrayListBuilder<String> roalb = new ROArrayListBuilder<>();

        // This is used for printing to the screen only, it is discarded when this method
        // exits.

        final ArrayList<Integer> packageFilesCount = new ArrayList<>(packagesToJavaDoc.size());

        for (final BuildPackage pkg : packagesToJavaDoc)
        {
            int count = 0;

            count += addMore(roalb, pkg.pkgRootDirectory, false, FileNode.JAVA_FILES);

            if (pkg.hasPackageSourceDir) count += addMore
                (roalb, pkg.pkgRootDirectory + "package-source" + FS, true, FileNode.JAVA_FILES);

            packageFilesCount.add(Integer.valueOf(count));
        }


        // Prints out the number of '.java' Files that were found, in each of the
        // package-directories.
        // 
        // TRUE ==> '.java' Files (FALSE ==> '.class' Files)

        Printing.printFilesCount(packagesToJavaDoc, packageFilesCount, logAndScreen, true);

        return roalb.build();
    }
}