| | | 1 | | //======================================================================= |
| | | 2 | | // TrailblazerLogger.cs |
| | | 3 | | //======================================================================= |
| | | 4 | | // MIT License, Copyright (c) 2024-present David Oravsky (mrdav30) |
| | | 5 | | // See LICENSE file in the project root for full license information. |
| | | 6 | | //======================================================================= |
| | | 7 | | |
| | | 8 | | global using SwiftCollections.Diagnostics; |
| | | 9 | | |
| | | 10 | | using System; |
| | | 11 | | |
| | | 12 | | namespace Trailblazer; |
| | | 13 | | |
| | | 14 | | /// <summary> |
| | | 15 | | /// Provides centralized diagnostics for Trailblazer runtime code. |
| | | 16 | | /// </summary> |
| | | 17 | | /// <remarks> |
| | | 18 | | /// Warning and error diagnostics are controlled through <see cref="MinimumLevel"/>. |
| | | 19 | | /// Trace-style diagnostics that were previously debug-only are additionally gated by |
| | | 20 | | /// <see cref="EnableDebugLogging"/> so hosts can opt into verbose runtime output explicitly. |
| | | 21 | | /// </remarks> |
| | | 22 | | public static class TrailblazerLogger |
| | | 23 | | { |
| | 1 | 24 | | private static readonly TrailblazerDiagnosticLogger _logger = new(); |
| | | 25 | | |
| | | 26 | | /// <summary> |
| | | 27 | | /// Gets or sets a value indicating whether verbose debug diagnostics should be emitted. |
| | | 28 | | /// </summary> |
| | | 29 | | public static bool EnableDebugLogging |
| | | 30 | | { |
| | 7 | 31 | | get => _logger.EnableDebugLogging; |
| | 13 | 32 | | set => _logger.EnableDebugLogging = value; |
| | | 33 | | } |
| | | 34 | | |
| | | 35 | | /// <summary> |
| | | 36 | | /// Gets the diagnostic channel used for Trailblazer warnings and errors. |
| | | 37 | | /// </summary> |
| | 34 | 38 | | public static DiagnosticChannel Channel => _logger.Channel; |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// Gets the diagnostic channel used for verbose debug diagnostics. |
| | | 42 | | /// </summary> |
| | 2202 | 43 | | public static DiagnosticChannel DebugChannel => _logger.DebugChannel; |
| | | 44 | | |
| | | 45 | | /// <summary> |
| | | 46 | | /// Gets or sets the minimum severity required for non-debug diagnostics to be emitted. |
| | | 47 | | /// </summary> |
| | | 48 | | public static DiagnosticLevel MinimumLevel |
| | | 49 | | { |
| | 8 | 50 | | get => _logger.MinimumLevel; |
| | 18 | 51 | | set => _logger.MinimumLevel = value; |
| | | 52 | | } |
| | | 53 | | |
| | | 54 | | /// <summary> |
| | | 55 | | /// Gets or sets the delegate used to write formatted log messages. |
| | | 56 | | /// Assigning <see langword="null"/> restores <see cref="DefaultLogHandler"/>. |
| | | 57 | | /// </summary> |
| | | 58 | | public static Action<DiagnosticLevel, string, string> LogHandler |
| | | 59 | | { |
| | 8 | 60 | | get => _logger.LogHandler; |
| | 14 | 61 | | set => _logger.LogHandler = value; |
| | | 62 | | } |
| | | 63 | | |
| | | 64 | | /// <summary> |
| | | 65 | | /// Gets or sets the formatter used to transform log arguments into a final log entry. |
| | | 66 | | /// Assigning <see langword="null"/> restores <see cref="DefaultLogFormatter"/>. |
| | | 67 | | /// </summary> |
| | | 68 | | public static Func<DiagnosticLevel, string, string, string> CustomFormatter |
| | | 69 | | { |
| | 6 | 70 | | get => _logger.CustomFormatter; |
| | 6 | 71 | | set => _logger.CustomFormatter = value; |
| | | 72 | | } |
| | | 73 | | |
| | | 74 | | /// <summary> |
| | | 75 | | /// Determines whether non-debug diagnostics at the specified level are currently enabled. |
| | | 76 | | /// </summary> |
| | | 77 | | /// <param name="level">The diagnostic level to evaluate.</param> |
| | | 78 | | /// <returns><see langword="true"/> when messages at <paramref name="level"/> will be emitted; otherwise, <see langw |
| | | 79 | | public static bool IsEnabled(DiagnosticLevel level) |
| | | 80 | | { |
| | 4 | 81 | | return _logger.IsEnabled(level); |
| | | 82 | | } |
| | | 83 | | |
| | | 84 | | /// <summary> |
| | | 85 | | /// The default handler for Trailblazer log messages. |
| | | 86 | | /// </summary> |
| | | 87 | | public static void DefaultLogHandler(DiagnosticLevel level, string message, string source) |
| | | 88 | | { |
| | 1 | 89 | | _logger.DefaultLogHandler(level, message, source); |
| | 1 | 90 | | } |
| | | 91 | | |
| | | 92 | | /// <summary> |
| | | 93 | | /// Formats a Trailblazer log entry using a deterministic, source-first layout. |
| | | 94 | | /// </summary> |
| | | 95 | | public static string DefaultLogFormatter(DiagnosticLevel level, string message, string source) |
| | | 96 | | { |
| | 1 | 97 | | return _logger.DefaultLogFormatter(level, message, source); |
| | | 98 | | } |
| | | 99 | | |
| | | 100 | | private sealed class TrailblazerDiagnosticLogger : DiagnosticLogger |
| | | 101 | | { |
| | | 102 | | public TrailblazerDiagnosticLogger() |
| | 1 | 103 | | : base("Trailblazer") |
| | | 104 | | { |
| | 1 | 105 | | } |
| | | 106 | | } |
| | | 107 | | } |