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 | package Torello.JavaDoc.Messager; import Torello.Java.StrIndent; import Torello.JavaDoc.Declaration; import Torello.JavaDoc.ReflHTML; import Torello.Java.C; import static Torello.Java.C.RESET; import static Torello.Java.C.BWHITE; import static Torello.Java.C.RED_BKGND; import java.util.Vector; // A replacement for <CODE>System.out, System.err</CODE> and even the StorageWriter // class used to send error messages to the terminal about upgrade progress. public class Messager { // ******************************************************************************************** // ******************************************************************************************** // Scoped-Values / ThreadLocal-Instance & Constructor // ******************************************************************************************** // ******************************************************************************************** private static final java.lang.ThreadLocal<Messager> tlInstance = new java.lang.ThreadLocal<>(); public static void initializeThreadLocalInstance (final int verbosityLevel, final Appendable logAppendable) { if (tlInstance.get() != null) throw new InternalError( "The Messager's `java.lang.ThreadLocal' instance has already been initialized for " + "this thread." ); if ((verbosityLevel < 0) || (verbosityLevel > 3)) throw new InternalError( "verbosityLevel=" + verbosityLevel + ", " + "but it must be between 0 and 3." ); final PrintRecord printRecord = new PrintRecord(verbosityLevel, logAppendable); final PrintHeading printHeading = new PrintHeading(printRecord); final PrintMessage printMessage = new PrintMessage(printRecord, printHeading); final Messager messager = new Messager(printRecord, printMessage); tlInstance.set(messager); } // ******************************************************************************************** // ******************************************************************************************** // Constructor & Fields // ******************************************************************************************** // ******************************************************************************************** private final PrintRecord printRecord; private final PrintMessage printMessage; private Messager(final PrintRecord printRecord, final PrintMessage printMessage) { this.printRecord = printRecord; this.printMessage = printMessage; } // ******************************************************************************************** // ******************************************************************************************** // Simple print / println ... and one "warning" Printer-Method // ******************************************************************************************** // ******************************************************************************************** public static void print(final String s) { final Messager m = tlInstance.get(); if (m.printRecord.verbosityLevel >= 2) m.printRecord.screenWriterSW.print(s); } public static void println(final String s) { final Messager m = tlInstance.get(); if (m.printRecord.verbosityLevel >= 2) m.printRecord.screenWriterSW.println(s); } public static void println() { final Messager m = tlInstance.get(); if (m.printRecord.verbosityLevel >= 2) m.printRecord.screenWriterSW.println(); } public static void printQuiet(final String s) { final Messager m = tlInstance.get(); if (m.printRecord.verbosityLevel == 1) m.printRecord.screenWriterSW.print(s); } public static void printSilent(final boolean dotOrNewLine) { final Messager m = tlInstance.get(); if (m.printRecord.verbosityLevel == 0) m.printRecord.screenWriterSW.print(dotOrNewLine ? '.' : '\n'); } public static void ifVerboseAppendVerbose() { final Messager m = tlInstance.get(); if (m.printRecord.verbosityLevel == 3) m.printRecord.screenWriterSW.print(MsgVerbose.getAndClear()); } public static void warning(final String message, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.WARNING(message, WHERE_AM_I); m.printRecord.writeSBToScreen(); } // ******************************************************************************************** // ******************************************************************************************** // Fatal-Assert: Throws to Stop Program-Execution Immediatley // ******************************************************************************************** // ******************************************************************************************** public static Error assertFail(final String message, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.ERROR( message, null, // signature true, // FATAL WHERE_AM_I ); m.printRecord.writeSBToScreen(); throw new AssertFail(); } public static Error assertFail (final String message, final String signature, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.ERROR( message, signature, true, // FATAL WHERE_AM_I ); m.printRecord.writeSBToScreen(); throw new AssertFail(); } public static Error assertFail (final Throwable t, final String message, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.ERROR( message, null, // signature true, // FATAL WHERE_AM_I ); m.printRecord.writeSBToScreen(); throw new AssertFail(); } public static Error assertFail (final Throwable t, final String message, final String signature, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.ERROR( message, signature, true, // FATAL WHERE_AM_I ); m.printRecord.writeSBToScreen(); throw new AssertFail(); } // ******************************************************************************************** // ******************************************************************************************** // Non-Fatal Assert: Error, but it doesn't need to stop immediately // ******************************************************************************************** // ******************************************************************************************** public static void assertFailContinue(final String message, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.ERROR( message, null, // signature false, // NON-FATAL WHERE_AM_I ); m.printRecord.writeSBToScreen(); } public static void assertFailContinue (final Throwable t, final String message, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.ERROR( t, message, null, // signature false, // NON-FATAL false, // Don't Show Stack-Trace WHERE_AM_I ); m.printRecord.writeSBToScreen(); } // ******************************************************************************************** // ******************************************************************************************** // Fatal-User-Error: Throws to Stop Program-Execution Immediatley // ******************************************************************************************** // ******************************************************************************************** public static Error userErrorHalt(final String message, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.ERROR( message, null, // signature true, // FATAL WHERE_AM_I ); m.printRecord.writeSBToScreen(); throw new MessagerGeneratedError(); } public static Error userErrorHalt (final Throwable t, final String message, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.ERROR( t, // Exception that was thrown message, // THE MESSAGE null, // signature true, // FATAL true, // Show Stack-Trace WHERE_AM_I ); m.printRecord.writeSBToScreen(); throw new MessagerGeneratedError(); } // ******************************************************************************************** // ******************************************************************************************** // User-Error: Program-Flow Execution Continues // ******************************************************************************************** // ******************************************************************************************** public static void userErrorContinue(final String message, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.ERROR( message, null, // signature false, // NON-FATAL WHERE_AM_I ); m.printRecord.writeSBToScreen(); } public static void userErrorContinue (final String message, final String signature, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.ERROR( message, signature, false, // NON-FATAL WHERE_AM_I ); m.printRecord.writeSBToScreen(); } public static void userErrorContinue (final Throwable t, final String message, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.ERROR( t, message, null, // signature false, // NON-FATAL false, // Don't Show Stack-Trace WHERE_AM_I ); m.printRecord.writeSBToScreen(); } public static void userErrorContinueST (final Throwable t, final String message, final Where_Am_I WHERE_AM_I) { final Messager m = tlInstance.get(); m.printMessage.ERROR( t, message, null, // signature false, // NON-FATAL true, // SHOW STACK TRACE WHERE_AM_I ); m.printRecord.writeSBToScreen(); } // ******************************************************************************************** // ******************************************************************************************** // The Old Class "MsgControl" // ******************************************************************************************** // ******************************************************************************************** public static void setCurrentFileName(final String fName, final String fNameKind) { final Messager m = tlInstance.get(); m.printRecord.setCurrentFileName(fName, fNameKind); } public static void setTopDescriptionSection() { final Messager m = tlInstance.get(); m.printRecord.setTopDescriptionSection(); } public static void setDeclaration(final Declaration declaration) { final Messager m = tlInstance.get(); m.printRecord.setDeclaration(declaration); } public static boolean hadErrors() { final Messager m = tlInstance.get(); return m.printRecord.hadErrors(); } public static void ifLogCheckPointLog() { final Messager m = tlInstance.get(); if (! m.printRecord.hasLogAppendable) return; m.printRecord.checkPointLog(); } } |