1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
package Torello.HTML.Tools.JavaDoc;

import Torello.HTML.Tools.JavaDoc.JavaDocError;
import Torello.Java.EXCC;
import Torello.Java.StorageWriter;
import Torello.Java.StrIndent;
import Torello.Java.UnreachableError;
import Torello.Java.Shell.C;

import java.util.Vector;

/**
 * A replacement for <CODE>System&#46;out, System&#46;err</CODE> and even the {@link StorageWriter}
 * class used to send error messages to the terminal about upgrade progress.  
 * 
 * <BR /><BR /><EMBED CLASS="external-html" DATA-FILE-ID="JDMESSAGER">
 */
public class Messager
{
    private Messager() { }

    // ********************************************************************************************
    // ********************************************************************************************
    // Main Fields
    // ********************************************************************************************
    // ********************************************************************************************

    // Error Message for {@code TypeNotPresentException}
    static final String TNPE = 
        "TypeNotPresentException thrown attempting to load Configuration Class.\n" +
        "Class requires correct Package-Name, options are:\n" +
        "    1) No Package-Name  2) Same Package-Name as the Package it's configuring";


    private static StorageWriter sw = new StorageWriter();

    private static Appendable logAppendable = null;

    static void setLogAppendable(Appendable lApp) { logAppendable = lApp; }

    // Copies directly from the Upgrader.VERBOSE
    private static boolean VERBOSE_PRINT_STEPS;

    /** Please review the Java code-body to understand what this does. */
    public static boolean isVerbose() { return VERBOSE_PRINT_STEPS; }

    static void setVerbose(boolean VERBOSE_PRINT_STEPS)
    { Messager.VERBOSE_PRINT_STEPS = VERBOSE_PRINT_STEPS; }

    // MESSAGER: Throws JDE on Error, and sets both the fileName and processorName
    static boolean checkPointLog()
    {
        String temp = C.toHTML(sw.getString(), true, true, true)
            .replace("\t", "        ");

        try
        {
            logAppendable.append(temp + "\n\n");
            sw.erase();

            return true;
        }

        catch (Exception e)
        {
            Messager.setProcessorName("Messager");
            Messager.setCurrentFileName("User Provided Log", null);

            Messager.assertFailGeneralPurpose(
                e,
                "Exception thrown while attempting to write to User-Provided Appendable-Log",
                null
            );

            return false;
        }
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Top Level Heading Dispatch
    // ********************************************************************************************
    // ********************************************************************************************


    private static Integer indentation = 4;

    private static String INDENT() { return (indentation==4) ? "    " : "        "; }

    private static void printHeadingIfNecessary()
    {
        if (indentation == 4)       printFileHeadingIfNecessary();
        else if (indentation == 8)  printDetailHeadingIfNecessary();
        else                        throw new UnreachableError();
        sw.println(INDENT() + "Processor [" + C.BCYAN + processorName + C.RESET + "]");
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // HEADING-VALUES
    // ********************************************************************************************
    // ********************************************************************************************


    private static String processorName = null;

    static void setProcessorName(String processorName)
    { Messager.processorName = processorName; }

    // The "current" Java Doc HTML File being analyzed
    private static String fileName = null;

    private static String fileNameKind = null;

    // The first time that an error or warning is printed, the detail-section location must be
    // printed at the top of the message.  All subsequent messges do not need this error
    // header message.

    private static boolean printedFirstFileName = false;

    static void setCurrentFileName(String fName, String fNameKind)
    {
        fileNameKind            = fNameKind;
        fileName                = fName;
        printedFirstFileName    = false;
        indentation             = 4;
        // Also clear the detail section
        detailSection           = null;
        printedFirstDetails     = false;
    }

    private static void printFileHeadingIfNecessary()
    {
        if (Messager.printedFirstFileName) return;

        Messager.printedFirstFileName = true;

        Messager.sw.println(
            "Processing File: " +
            "[" + C.BYELLOW + fileName + C.RESET + "]" +
            ((fileNameKind != null) ? (", (" + fileNameKind + ")") : "") + ':'
        );
    }


    // The "current" detail section about which error messages will be printed (if there are)
    // any.

    private static ReflHTML<?> detailSection = null;

    // The "EmbedTag" processor treats the "TopDescription" as one of the details section.  It
    // really isn't "a hack" - because the code is so long and the "Top Description" Embed Tag's
    // are the exact same as the "Details" EmbedTag's.  This is also true for the "HiLiteDividers"

    private static boolean topDescriptionAsDetails = false;

    // The first time that an error or warning is printed, the detail-section location must be
    // printed at the top of the message.  All subsequent messges do not need this error
    // header message.

    private static boolean printedFirstDetails = false;

    static void setCurrentDetailSection(ReflHTML<?> detailSection)
    {
        Messager.detailSection              = detailSection;
        Messager.printedFirstDetails        = false;
        Messager.topDescriptionAsDetails    = false;
        Messager.indentation                = 8;
    }

    static void setTopDescriptionSection()
    {
        Messager.detailSection              = null;
        Messager.printedFirstDetails        = false;
        Messager.topDescriptionAsDetails    = true;
        Messager.indentation                = 8;
    }

    private static void printDetailHeadingIfNecessary()
    {
        printFileHeadingIfNecessary();

        if (printedFirstDetails) return;

        printedFirstDetails = true;

        if (topDescriptionAsDetails)
            sw.println
                ("    Processing [" + C.BCYAN + "Main Type Description, at top" + C.RESET + "]");

        else
        {
            // System.out.println("detailSection: " + detailSection);
            // System.out.println("detailSection.entity: " + detailSection.entity);
            String ln1 = (detailSection.entity.signatureLineNumber != -1)
                ? ("Signature Line [" + C.BGREEN + detailSection.entity.signatureLineNumber +
                    C.RESET + "]")
                : null;

            String ln2 = (detailSection.entity.jdStartLineNumber != -1)
                ? ("JavaDoc Start Line [" + C.BGREEN + detailSection.entity.jdStartLineNumber +
                    C.RESET + "]")
                : null;

            String line = "";

            if (ln1 != null)        line = ln1 + ((ln2 != null) ? (", " + ln2) : "");
            else if (ln2 != null)   line = ln2;

            sw.println(
                "    Processing " + C.BCYAN + detailSection.entityAsEnum.toString() + C.RESET +
                    " Details Section " +
                "for " + detailSection.entityAsEnum.toString() +
                " [" + C.BRED + detailSection.entity.name + C.RESET + "], " +
                line
            );
        }
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Counts
    // ********************************************************************************************
    // ********************************************************************************************


    private static int errorCount   = 0;
    private static int warningCount = 0;

    static boolean hadErrors()  { return errorCount > 0;    }
    static int numErrors()      { return errorCount;        }
    static int numWarnings()    { return warningCount;      }

    static int totalErrorsAndWarnings()
    { return errorCount + warningCount; }

    static boolean reachedMaxErrorsOrWarnings()
    { return totalErrorsAndWarnings() > 25; }

    public static boolean hadErrorsOrWarnings()
    { return (errorCount > 0) || (warningCount > 0); }


    // ********************************************************************************************
    // ********************************************************************************************
    // Cute Little Musings
    // ********************************************************************************************
    // ********************************************************************************************


    public static void warning(String message)
    {
        warningCount++;
        printHeadingIfNecessary();

        sw.println(
            INDENT() + "Warning: " +
            StrIndent.indentAfter2ndLine(message, 4 + indentation, true, true)
        );
    }

    public static void note(String message)
    {
        Messager.printHeadingIfNecessary();

        sw.println(
            INDENT() + "Note: " +
            StrIndent.indentAfter2ndLine(message, 4 + indentation, true, true)
        );
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // MAIN-PRINTING
    // ********************************************************************************************
    // ********************************************************************************************


    private static void ASSERT_FAIL(String oneLinerNote, String message, String signature)
    {
        errorCount++;
        printHeadingIfNecessary();

        signature = (signature != null)
            ? ("Entity-Signature:\n" + StrIndent.indent((signature = signature.trim()), 4))
            : "";

        Messager.sw.println(
            StrIndent.indent(
                oneLinerNote +
                StrIndent.indentAfter2ndLine(message.trim(), 4, true, true) + '\n' +
                signature,
                indentation
            ));
    }

    private static void ASSERT_FAIL
        (String oneLinerNote, Throwable t, String message, String signature)
    {
        errorCount++;
        printHeadingIfNecessary();

        signature = (signature != null)
            ? ( "Entity-Signature:\n" + StrIndent.indent((signature=signature.trim()), 4) + '\n' +
                "************************************************************************\n")
            : "";

        Messager.sw.println(
            StrIndent.indent(
                oneLinerNote + " (Exception Thrown)\n" +
                "************************************************************************\n" +
                EXCC.toString(t) + '\n' +
                "************************************************************************\n" +
                message + '\n' +
                "************************************************************************\n" +
                signature,
                indentation
            ));
    }

    private static void ERROR(Throwable t, String message, boolean FATAL, boolean showST)
    {
        errorCount++;
        Messager.printHeadingIfNecessary();

        Messager.sw.println(
            StrIndent.indent(
                (FATAL ? "Fatal Error: " : "Error: ") + "Exception Thrown:\n" +
                "************************************************************************\n" +
                (showST ? EXCC.toString(t) : ("Exception-Message: " + t.getMessage())) + '\n' +
                "************************************************************************\n" +
                message + '\n' +
                "************************************************************************\n",
                indentation
            ));
    }

    private static void ERROR(String message, boolean FATAL)
    {
        errorCount++;
        Messager.printHeadingIfNecessary();

        Messager.sw.println(
            INDENT() + (FATAL ? "Fatail Error: " : "Error: ") + 
            StrIndent.indentAfter2ndLine(message, 4 + indentation, true, true)
        );
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // ASSERTS, Assert's have to be thought-of as **LIKELY** My-Fault
    // ********************************************************************************************
    // ********************************************************************************************


    static <T> T assertFailCheckup(String message)
    {
        ASSERT_FAIL("Assertion-Checkup Error: ", message, null);
        throw new JavaDocError();
    }

    static <T> T assertFailHTML(String message, String signature)
    {
        ASSERT_FAIL("Java-Doc HTML Parsing Error: ", message, signature);
        throw new JavaDocHTMLParseException(message, signature);
    }

    static <T> T assertFailHTML(Throwable t, String message, String signature)
    {
        ASSERT_FAIL("Java-Doc HTML Parsing Error: ", t, message, signature);
        throw new JavaDocHTMLParseException(message, t, signature);
    }

    static <T> T assertFailJavaParser(String message, String signature)
    {
        ASSERT_FAIL("Java-Parser Source-Code Parsing Error: ", message, signature);
        throw new SourceCodeParseException(message, signature);
    }

    static <T> T assertFailJavaParser(Throwable t, String message, String signature)
    {
        ASSERT_FAIL("Java-Parser Source-Code Parsing Error: ", t, message, signature);
        throw new SourceCodeParseException(message, t, signature);
    }

    static <T> T assertFailGeneralPurpose(String message, String signature)
    {
        ASSERT_FAIL("Java-Doc Upgrader Error: ", message, signature);
        throw new UpgradeException();
    }

    static <T> T assertFailGeneralPurpose(Throwable t, String message, String signature)
    {
        ASSERT_FAIL("Java-Doc Upgrader Error: ", t, message, signature);
        throw new UpgradeException();
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // NON-ASSERT ERRORS, These are **LIKELY** Their-Fault (Not guaranteed anybody's fault)
    // ********************************************************************************************
    // ********************************************************************************************
    //
    // NOTE: These are all the exact same thing..


    static <T> T  userErrorHalt(String message)
    {
        ERROR(message, true /* FATAL */);
        throw new JavaDocError();
    }

    static <T> T userErrorHalt(Throwable t, String message)
    {
        ERROR(t, message, true /* FATAL */, true /* Show Stack-Trace */);
        throw new JavaDocError();
    }

    static void userErrorContinue(String message)
    { ERROR(message, false /* NON-FATAL */); }

    static void userErrorContinue(Throwable t, String message)
    { ERROR(t, message, false /* NON-FATAL */, false  /* Don't Show Stack-Trace */); }

    static void errorExitingNow(Throwable t, String message)
    { ERROR(t, message, true /* FATAL */, true  /* Show Stack-Trace */); }

    static void errorExitingNow(String message)
    { ERROR(message, true /* FATAL */); }

    static void errorContinue(String message)
    { ERROR(message, false /* NON-FATAL */); }

    static void errorContinue(Throwable t, String message)
    { ERROR(t, message, false /* NON-FATAL */, false  /* Don't Show Stack-Trace */); }


    // ********************************************************************************************
    // ********************************************************************************************
    // Simple Printing
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Prints input {@code 's'}
     * @param s Any {@code java.lang.String}
     */
    public static void print(String s)
    { sw.print(s); }

    /**
     * Prints input {@code 's'}, followed by a newline.
     * @param s Any {@code java.lang.String}
     */
    public static void println(String s)
    { sw.println(s); }

    /** Prints a newline character */
    public static void println()
    { sw.println(); }

    /**
     * This prints a message to the parent-class {@link StorageWriter}, but only if the user has
     * requested {@link Upgrade#VERBOSE_PRINT_STEPS}
     * 
     * <BR /><BR /><B>MINOR NOTE:</B> If the message being passed involves some complicated Java
     * {@code StringBuilder}, it would be smarter &amp; more efficient, to only build that message
     * after the {@code 'VERBOSE'} flag has been checked.  <I>Essentially, using this method is
     * silly, if {@code 's'} has a bunch of {@code '+'} symbols before it is passed here.</I>
     * 
     * @param s The message to print to {@code StorageWriter} (the {@code Messager's} parent class)
     */
    public static void ifVPrintln(String s)
    { if (VERBOSE_PRINT_STEPS) sw.println(s); }

    /**
     * This prints a message to the parent-class {@link StorageWriter}, but only if the user has
     * requested {@link Upgrade#VERBOSE_PRINT_STEPS}
     * 
     * <BR /><BR /><B>MINOR NOTE:</B> If the message being passed involves some complicated Java
     * {@code StringBuilder}, it would be smarter &amp; more efficient, to only build that message
     * after the {@code 'VERBOSE'} flag has been checked.  <I>Essentially, using this method is
     * silly, if {@code 's'} has a bunch of {@code '+'} symbols before it is passed here.</I>
     * 
     * @param s The message to print to {@code StorageWriter} (the {@code Messager's} parent class)
     */
    public static void ifVPrint(String s)
    { if (VERBOSE_PRINT_STEPS) sw.print(s); }
}