| | | 1 | | //======================================================================= |
| | | 2 | | // DiagnosticChannelLoggingExtensions.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 | | namespace SwiftCollections.Diagnostics; |
| | | 9 | | |
| | | 10 | | using System.IO; |
| | | 11 | | using System.Runtime.CompilerServices; |
| | | 12 | | |
| | | 13 | | /// <summary> |
| | | 14 | | /// Provides interpolated diagnostic logging helpers for <see cref="DiagnosticChannel"/>. |
| | | 15 | | /// </summary> |
| | | 16 | | public static class DiagnosticChannelLoggingExtensions |
| | | 17 | | { |
| | | 18 | | /// <summary> |
| | | 19 | | /// Writes an info diagnostic message without evaluating formatted expressions when info diagnostics are disabled. |
| | | 20 | | /// </summary> |
| | | 21 | | /// <param name="channel">The diagnostic channel that receives the message.</param> |
| | | 22 | | /// <param name="message">The interpolated diagnostic message.</param> |
| | | 23 | | /// <param name="source">An optional source identifier. When omitted, caller information is used.</param> |
| | | 24 | | /// <param name="method">The calling method name, automatically captured.</param> |
| | | 25 | | /// <param name="filePath">The calling file name, automatically captured to get the class name.</param> |
| | | 26 | | public static void Info( |
| | | 27 | | this DiagnosticChannel channel, |
| | | 28 | | [InterpolatedStringHandlerArgument("channel")] DiagnosticMessageHandler<InfoDiagnosticLevel> message, |
| | | 29 | | string source = "", |
| | | 30 | | [CallerMemberName] string method = "", |
| | | 31 | | [CallerFilePath] string filePath = "") |
| | | 32 | | { |
| | 43 | 33 | | if (!message.IsEnabled) |
| | 37 | 34 | | return; |
| | | 35 | | |
| | 6 | 36 | | WriteCore(channel, DiagnosticLevel.Info, message.Message, ResolveSource(source, method, filePath)); |
| | 5 | 37 | | } |
| | | 38 | | |
| | | 39 | | /// <summary> |
| | | 40 | | /// Writes a warning diagnostic message without evaluating formatted expressions when warning diagnostics are disabl |
| | | 41 | | /// </summary> |
| | | 42 | | /// <param name="channel">The diagnostic channel that receives the message.</param> |
| | | 43 | | /// <param name="message">The interpolated diagnostic message.</param> |
| | | 44 | | /// <param name="source">An optional source identifier. When omitted, caller information is used.</param> |
| | | 45 | | /// <param name="method">The calling method name, automatically captured.</param> |
| | | 46 | | /// <param name="filePath">The calling file name, automatically captured to get the class name.</param> |
| | | 47 | | public static void Warn( |
| | | 48 | | this DiagnosticChannel channel, |
| | | 49 | | [InterpolatedStringHandlerArgument("channel")] DiagnosticMessageHandler<WarningDiagnosticLevel> message, |
| | | 50 | | string source = "", |
| | | 51 | | [CallerMemberName] string method = "", |
| | | 52 | | [CallerFilePath] string filePath = "") |
| | | 53 | | { |
| | 3 | 54 | | if (!message.IsEnabled) |
| | 1 | 55 | | return; |
| | | 56 | | |
| | 2 | 57 | | WriteCore(channel, DiagnosticLevel.Warning, message.Message, ResolveSource(source, method, filePath)); |
| | 2 | 58 | | } |
| | | 59 | | |
| | | 60 | | /// <summary> |
| | | 61 | | /// Writes an error diagnostic message without evaluating formatted expressions when error diagnostics are disabled. |
| | | 62 | | /// </summary> |
| | | 63 | | /// <param name="channel">The diagnostic channel that receives the message.</param> |
| | | 64 | | /// <param name="message">The interpolated diagnostic message.</param> |
| | | 65 | | /// <param name="source">An optional source identifier. When omitted, caller information is used.</param> |
| | | 66 | | /// <param name="method">The calling method name, automatically captured.</param> |
| | | 67 | | /// <param name="filePath">The calling file name, automatically captured to get the class name.</param> |
| | | 68 | | public static void Error( |
| | | 69 | | this DiagnosticChannel channel, |
| | | 70 | | [InterpolatedStringHandlerArgument("channel")] DiagnosticMessageHandler<ErrorDiagnosticLevel> message, |
| | | 71 | | string source = "", |
| | | 72 | | [CallerMemberName] string method = "", |
| | | 73 | | [CallerFilePath] string filePath = "") |
| | | 74 | | { |
| | 4 | 75 | | if (!message.IsEnabled) |
| | 2 | 76 | | return; |
| | | 77 | | |
| | 2 | 78 | | WriteCore(channel, DiagnosticLevel.Error, message.Message, ResolveSource(source, method, filePath)); |
| | 2 | 79 | | } |
| | | 80 | | |
| | | 81 | | /// <summary> |
| | | 82 | | /// Writes a dynamic-level diagnostic message without evaluating formatted expressions when the level is disabled. |
| | | 83 | | /// </summary> |
| | | 84 | | /// <param name="channel">The diagnostic channel that receives the message.</param> |
| | | 85 | | /// <param name="level">The severity level of the diagnostic event.</param> |
| | | 86 | | /// <param name="message">The interpolated diagnostic message.</param> |
| | | 87 | | /// <param name="source">An optional source identifier. When omitted, caller information is used.</param> |
| | | 88 | | /// <param name="method">The calling method name, automatically captured.</param> |
| | | 89 | | /// <param name="filePath">The calling file name, automatically captured to get the class name.</param> |
| | | 90 | | public static void Log( |
| | | 91 | | this DiagnosticChannel channel, |
| | | 92 | | DiagnosticLevel level, |
| | | 93 | | [InterpolatedStringHandlerArgument("channel", "level")] DiagnosticMessageHandler<DynamicDiagnosticLevel> message |
| | | 94 | | string source = "", |
| | | 95 | | [CallerMemberName] string method = "", |
| | | 96 | | [CallerFilePath] string filePath = "") |
| | | 97 | | { |
| | 3 | 98 | | if (!message.IsEnabled) |
| | 1 | 99 | | return; |
| | | 100 | | |
| | 2 | 101 | | WriteCore(channel, level, message.Message, ResolveSource(source, method, filePath)); |
| | 2 | 102 | | } |
| | | 103 | | |
| | | 104 | | private static void WriteCore( |
| | | 105 | | DiagnosticChannel channel, |
| | | 106 | | DiagnosticLevel level, |
| | | 107 | | DiagnosticInterpolatedStringHandler message, |
| | | 108 | | string source) |
| | | 109 | | { |
| | 12 | 110 | | SwiftThrowHelper.ThrowIfNull(channel, nameof(channel)); |
| | 11 | 111 | | channel.Write(level, message, source); |
| | 11 | 112 | | } |
| | | 113 | | |
| | | 114 | | private static string ResolveSource(string source, string method, string filePath) |
| | | 115 | | { |
| | 12 | 116 | | if (!string.IsNullOrEmpty(source)) |
| | 7 | 117 | | return source; |
| | | 118 | | |
| | 5 | 119 | | string className = Path.GetFileNameWithoutExtension(filePath); |
| | 5 | 120 | | if (string.IsNullOrEmpty(className)) |
| | 1 | 121 | | return method; |
| | | 122 | | |
| | 4 | 123 | | if (string.IsNullOrEmpty(method)) |
| | 1 | 124 | | return className; |
| | | 125 | | |
| | 3 | 126 | | return $"{className}.{method}"; |
| | | 127 | | } |
| | | 128 | | } |