diff options
Diffstat (limited to 'lib/Utils/src/Logging')
| -rw-r--r-- | lib/Utils/src/Logging/ILogProvider.cs | 79 | ||||
| -rw-r--r-- | lib/Utils/src/Logging/LogLevel.cs | 33 | ||||
| -rw-r--r-- | lib/Utils/src/Logging/LoggerExtensions.cs | 60 |
3 files changed, 172 insertions, 0 deletions
diff --git a/lib/Utils/src/Logging/ILogProvider.cs b/lib/Utils/src/Logging/ILogProvider.cs new file mode 100644 index 0000000..55dbd6f --- /dev/null +++ b/lib/Utils/src/Logging/ILogProvider.cs @@ -0,0 +1,79 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Utils +* File: ILogProvider.cs +* +* ILogProvider.cs is part of VNLib.Utils which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Utils is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Utils is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Utils. If not, see http://www.gnu.org/licenses/. +*/ + +using System; + +namespace VNLib.Utils.Logging +{ + /// <summary> + /// Self-contained logging interface that allows for applications events to be written to an + /// output source + /// </summary> + public interface ILogProvider + { + /// <summary> + /// Flushes any buffers to the output source + /// </summary> + abstract void Flush(); + + /// <summary> + /// Writes the string to the log with the specified priority log level + /// </summary> + /// <param name="level">The log priority level</param> + /// <param name="value">The message to print</param> + void Write(LogLevel level, string value); + /// <summary> + /// Writes the exception and optional string to the log with the specified priority log level + /// </summary> + /// <param name="level">The log priority level</param> + /// <param name="exception">An exception object to write</param> + /// <param name="value">The message to print</param> + void Write(LogLevel level, Exception exception, string value = ""); + /// <summary> + /// Writes the template string and params arguments to the log with the specified priority log level + /// </summary> + /// <param name="level">The log priority level</param> + /// <param name="value">The log template string</param> + /// <param name="args">Variable length array of objects to log with the specified templatre</param> + void Write(LogLevel level, string value, params object?[] args); + /// <summary> + /// Writes the template string and params arguments to the log with the specified priority log level + /// </summary> + /// <param name="level">The log priority level</param> + /// <param name="value">The log template string</param> + /// <param name="args">Variable length array of objects to log with the specified templatre</param> + void Write(LogLevel level, string value, params ValueType[] args); + + /// <summary> + /// Gets the underlying log source + /// </summary> + /// <returns>The underlying log source</returns> + object GetLogProvider(); + /// <summary> + /// Gets the underlying log source + /// </summary> + /// <returns>The underlying log source</returns> + public virtual T GetLogProvider<T>() => (T)GetLogProvider(); + } +} diff --git a/lib/Utils/src/Logging/LogLevel.cs b/lib/Utils/src/Logging/LogLevel.cs new file mode 100644 index 0000000..1851c26 --- /dev/null +++ b/lib/Utils/src/Logging/LogLevel.cs @@ -0,0 +1,33 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Utils +* File: LogLevel.cs +* +* LogLevel.cs is part of VNLib.Utils which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Utils is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Utils is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Utils. If not, see http://www.gnu.org/licenses/. +*/ + +using System; + +namespace VNLib.Utils.Logging +{ + public enum LogLevel + { + Verbose, Debug, Information, Warning, Error, Fatal + } +} diff --git a/lib/Utils/src/Logging/LoggerExtensions.cs b/lib/Utils/src/Logging/LoggerExtensions.cs new file mode 100644 index 0000000..cd314ed --- /dev/null +++ b/lib/Utils/src/Logging/LoggerExtensions.cs @@ -0,0 +1,60 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Utils +* File: LoggerExtensions.cs +* +* LoggerExtensions.cs is part of VNLib.Utils which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Utils is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Utils is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Utils. If not, see http://www.gnu.org/licenses/. +*/ + +#pragma warning disable CA1062 // Validate arguments of public methods + +using System; + +namespace VNLib.Utils.Logging +{ + /// <summary> + /// Extension helper methods for writing logs to a <see cref="ILogProvider"/> + /// </summary> + public static class LoggerExtensions + { + public static void Debug(this ILogProvider log, Exception exp, string value = "") => log.Write(LogLevel.Debug, exp, value); + public static void Debug(this ILogProvider log, string value) => log.Write(LogLevel.Debug, value); + public static void Debug(this ILogProvider log, string format, params object?[] args) => log.Write(LogLevel.Debug, format, args); + public static void Debug(this ILogProvider log, string format, params ValueType[] args) => log.Write(LogLevel.Debug, format, args); + public static void Error(this ILogProvider log, Exception exp, string value = "") => log.Write(LogLevel.Error, exp, value); + public static void Error(this ILogProvider log, string value) => log.Write(LogLevel.Error, value); + public static void Error(this ILogProvider log, string format, params object?[] args) => log.Write(LogLevel.Error, format, args); + public static void Fatal(this ILogProvider log, Exception exp, string value = "") => log.Write(LogLevel.Fatal, exp, value); + public static void Fatal(this ILogProvider log, string value) => log.Write(LogLevel.Fatal, value); + public static void Fatal(this ILogProvider log, string format, params object?[] args) => log.Write(LogLevel.Fatal, format, args); + public static void Fatal(this ILogProvider log, string format, params ValueType[] args) => log.Write(LogLevel.Fatal, format, args); + public static void Information(this ILogProvider log, Exception exp, string value = "") => log.Write(LogLevel.Information, exp, value); + public static void Information(this ILogProvider log, string value) => log.Write(LogLevel.Information, value); + public static void Information(this ILogProvider log, string format, params object?[] args) => log.Write(LogLevel.Information, format, args); + public static void Information(this ILogProvider log, string format, params ValueType[] args) => log.Write(LogLevel.Information, format, args); + public static void Verbose(this ILogProvider log, Exception exp, string value = "") => log.Write(LogLevel.Verbose, exp, value); + public static void Verbose(this ILogProvider log, string value) => log.Write(LogLevel.Verbose, value); + public static void Verbose(this ILogProvider log, string format, params object?[] args) => log.Write(LogLevel.Verbose, format, args); + public static void Verbose(this ILogProvider log, string format, params ValueType[] args) => log.Write(LogLevel.Verbose, format, args); + public static void Warn(this ILogProvider log, Exception exp, string value = "") => log.Write(LogLevel.Warning, exp, value); + public static void Warn(this ILogProvider log, string value) => log.Write(LogLevel.Warning, value); + public static void Warn(this ILogProvider log, string format, params object?[] args) => log.Write(LogLevel.Warning, format, args); + public static void Warn(this ILogProvider log, string format, params ValueType[] args) => log.Write(LogLevel.Warning, format, args); + } +} |