package Torello.JavaDoc.Messager;

import Torello.Java.StringParse;
import Torello.Java.StrIndent;
import Torello.Java.StrPrint;
import Torello.Java.EXCC;

import Torello.JavaDoc.ReflHTML;
import Torello.JavaDoc.Declaration;

import static Torello.Java.C.*;
import static Torello.JavaDoc.Messager.Where_Am_I.LABEL_COLOR;

import java.io.File;


// This class exports two main methods named "ERROR".  These two methods are invoked by the
// actual, "public", part of this Messager-Package.  The actual class "Messager" has quite a number
// of "versions" of the two ERROR(...) Methods that are exported by this Package-Private class.
// 
// There is also a small "warning(...)" method that this class exports.  There is some likelihood
// that this will be eliminated.  Early on it seemed like there could be the potential for many
// User-Caused "Warning" Messages.  However, there really haven't been any, whatsoever.  That very
// well could change with later code-reviews and bug-finding episodes.
// 
// NOT-SURE-YET !  For now, "warning(...)" will remain.
// 
// This entire class serves the primary purpose of "worrying about" all of the levels of
// indentation that are needed to make the Error-Messages that the JDU generates actually look nice
// and be readable.  The whole concept of printing the "Current Working File-Name and the "Current 
// Working Processor Name" with proper indentation is accomplished by simply making note (by
// updating a 'fileName' and 'Where_Am_I' internal / private field) whenever the JDU moves onto a
// different file or a different HTML-Processor.
// 
// It sort of is "that simple".  The thing is that it is really difficult to make this "Messager
// Package" look simple - even though it certainly is pretty simple.  Explaining what the JDU
// Error-Reporting Code is expected to do is actually a little bit tricky.  I mean, all it really 
// is doing is printing what would other-wise be an exception throw - to the screen, and then 
// allowing Program Control-Flow to move onto the next thing that they do...
// 
// Sporadically, througout the JDU, there are checks which necessitate that if errors hae occurred
// then the JDU-Tool must exit.  **FUNDAMENTALLY** - the entire purpose of a Messager-Class or 
// Messager-Package is to print as many errors as possible to the user's terminal before exiting 
// the application.  When debugging a project, the user simply cannot be bothered with restarting
// his ugrader by, laboriousy, once for each and every "documentation bug" that exists in his 
// upgrade configurations.
// 
// If the JDK's 'javac' command printed only 1 error when compiling many files, and then exited
// unti each bug found had been eliminated - NOBODY WOULD USE JAVA, JAVAC OR THE JDK AT ALL because
// it would be thought of as way too slow!
// 
// The Packages "JDUInternal.MainJDU" and "JDUInternal.Features" (along with other
// classes/packages) are all expected to report to this Messager whenever they have begun
// processing the next Java-Doc '.html' Web-Page, or begun using the next ReflHTML "Feature" 
// Processor.
// 
// Again, all this Messager class really does is export Two "ERROR" printing methods and one 
// "WARNIGN" printing method (which isn't even used right now, except in single location).  These
// "Error Printers" do a verifiable "ton" of work to make sure the Error-Messages which are 
// printed to the User's Terminal have great indentation, are properly wrapped if the text goes
// on too long, and that all heading information for the errors are properly printed above the
// messages.
// 
// The actual JDU Classes in this package all make calls to class 'Messager', rather than
// 'MsgPkgPrivate'.

/**
 * This is an internally used class whose primary purpose is to generate the actual Java-Strings 
 * which are printed to the User's Terminal on Error.
 * 
 * <BR /><BR /><EMBED CLASS='external-html' DATA-FILE-ID=PRINT_MESSAGE>
 */
public class PrintMessage
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Constructor & Field
    // ********************************************************************************************
    // ********************************************************************************************


    private final PrintRecord   printRecord;
    private final PrintHeading  printHeading;

    PrintMessage(final PrintRecord printRecord, final PrintHeading printHeading)
    {
        this.printRecord    = printRecord;
        this.printHeading   = printHeading;
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Two, very simple, PRIVATE, Static-Fields
    // ********************************************************************************************
    // ********************************************************************************************


    // This is used *ONCE* to print decide whether to print a particular stack-trace.
    // It's the kind of thing that I really need, but the end user really shouldn't even expect
    // to see it.

    private static final boolean DEBUGGING = true;

    private static final String BLUE_LINE =
        BLUE_BKGND + BWHITE + StringParse.nChars('*', 70) + RESET + '\n';


    // ********************************************************************************************
    // ********************************************************************************************
    // Two Main, Configurable, Error Message Printers
    // ********************************************************************************************
    // ********************************************************************************************


    // Does not have a "Throwable"
    void ERROR(
            final String        message,
            final String        signature,
            final boolean       FATAL,
            final Where_Am_I    WHERE_AM_I
        )
    {
        final String oneLinerNote = null;

        this.printRecord.incErrorCountAndCheck();

        this.printHeading.printHeadingIfNecessary(WHERE_AM_I);


        // In the lines below, String.trim() is used.  This is *ALWAYS* OK - unless the
        // String being trimmed starts with a UNIX Color-Code Escape-Sequence.  The first character
        // of a UNIX Escape Sequence is (synonymously named "ESCAPE") '\u001B'
        //
        // Java's String.trim() seems to be trimming that chacter!
        // 
        // However since "signature" and oneLinerNote are not supposed to have any Color-Codes in 
        // them, it should not matter right here!

        final String sigStr = (signature == null)
            ? ""
            : (
                '\n' +
                LABEL_COLOR + " Entity-Signature " + RESET + '\n' +
                StrIndent.indent((signature.trim().replace("\t", "    ")), 4) + '\n'
            );

        final String firstLineNote =
            ' ' +
            (FATAL ? "Fatal " : "") +
            ((oneLinerNote != null) ? oneLinerNote.trim() : "Error") +
            ' ';

        final int firstWrap = 100 - firstLineNote.length();

        this.printRecord.sb
            .append(
                StrIndent.indent(
                    LABEL_COLOR + firstLineNote + RESET +
                    ' ' +
                    StrIndent.indentAfter2ndLine(
                        StrPrint.wrapToIndentationPlus(
                            message
                                .replaceAll("^[\\s]+|[\\s]+$", "") // Cannot use 'trim()'
                                .replace("\t", "    "),
                            firstWrap,
                            100,

                        ),
                        4,
                        true,
                        true
                    ) +
                    '\n' +
                    sigStr,
                    this.printRecord.getIndentation()
                ))
            .append('\n');
    }

    // Has Throwable **AND** 'showST'
    void ERROR(
            final Throwable     t,
            final String        message,
            final String        signature,
            final boolean       FATAL,
            final boolean       showST,
            final Where_Am_I    WHERE_AM_I
        )
    {
        final String oneLinerNote = null;

        this.printRecord.incErrorCountAndCheck();

        this.printHeading.printHeadingIfNecessary(WHERE_AM_I);

        final String sigStr = (signature == null)
            ? ""
            : (
                LABEL_COLOR + " Entity-Signature " + RESET + '\n' +
                StrIndent.indent((signature.trim().replace("\t", "    ")), 4) + '\n' +
                BLUE_LINE
            );

        final String topNote = (oneLinerNote != null)
            ? (LABEL_COLOR + ' ' + oneLinerNote.trim() + ' ' + RESET + 
                " (Exception Thrown)\n")
            : (
                LABEL_COLOR + ' ' +
                (FATAL ? "Fatal " : "") +
                "Error, Exception Thrown " + RESET + '\n'
            );

        final String exceptionStr = (FATAL || showST)
            ? EXCC.toString(t)
            : (
                LABEL_COLOR + " Exception-Name " + RESET + "    " +
                    BRED + t.getClass().getCanonicalName() +
                    RESET +'\n' +
                LABEL_COLOR + " Exception-Message " + RESET + ' ' +
                    t.getMessage() + '\n' +
                LABEL_COLOR + " Abbreviated-Trace " + RESET + ' ' +
                    (DEBUGGING ? " (Debugging-Mode On, Abbreviation Off)" : "") +
                    '\n' + 
                    (DEBUGGING ? EXCC.toString(t, 4) : EXCC.toStringMaxTraces(t, 2, 4))
            );


        // String.trim() ==> It trims the UNIX Escape-Sequence Character '\u001B'
        // It is not supposed to, acording to Chat-GPT !!  But it does anyway!
        // 
        // System.out.println(exceptionStr.trim());
        // System.out.println(exceptionStr.replaceAll("^[\\s]+|[\\s]+$", ""));
        // Torello.Java.Q.BP();

        this.printRecord.sb
            .append(
                StrIndent.indent(
                    StrPrint.wrapToIndentationPlus(
                        topNote +
                        BLUE_LINE +
                        exceptionStr
                            .replaceAll("^[\\s]+|[\\s]+$", "") // Cannot use 'trim()'
                            .replace("\t", "    ") +
                            '\n' +
                        BLUE_LINE +
                        message
                            .replaceAll("^[\\s]+|[\\s]+$", "") // Cannot use 'trim()'
                            .replace("\t", "    ") +
                            '\n' +
                        BLUE_LINE +
                        sigStr,
                        100,
                        100,

                    ),
                    this.printRecord.getIndentation()
                ))
            .append('\n');
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Warning
    // ********************************************************************************************
    // ********************************************************************************************


    // Does not wahave a "Throwable"
    void WARNING(
            final String        message,
            final Where_Am_I    WHERE_AM_I
        )
    {
        this.printRecord.incWarningCount();

        this.printHeading.printHeadingIfNecessary(WHERE_AM_I);

        this.printRecord.sb
            .append(
                StrPrint.wrapToIndentationPlus(
                    this.printRecord.getIndentationStr() + 
                    LABEL_COLOR + " Warning " + RESET + ' ' +

                    StrIndent.indentAfter2ndLine(
                        message.replace("\t", "    "),
                        4 + this.printRecord.getIndentation(),
                        true,
                        true
                    ),
                    100,
                    100,

                ) +
                '\n'
            )
            .append('\n');
    }
}