Merge branch 'new_reader' of https://github.com/LogExperts/LogExpert into new_reader

Author: BRUNER Patrick

src/ColumnizerLib/ILogLine.cs

@@ -11,6 +11,33 @@ public interface ILogLine : ITextValue
     #endregion
 }
 
+/// <summary>
+/// Represents a single log line, including its full text and line number.
+/// </summary>
+/// <remarks>
+/// <para>
+/// <b>Purpose:</b> <br/>
+/// The <c>LogLine</c> struct encapsulates the content and line number of a log entry. It is used throughout the
+/// columnizer and log processing infrastructure to provide a strongly-typed, immutable representation of a log line.
+/// </para>
+/// <para>
+/// <b>Usage:</b> <br/>
+/// This struct implements the <see cref="ILogLine"/> interface, allowing it to be used wherever an <c>ILogLine</c>
+/// is expected. It provides value semantics and is intended to be lightweight and efficiently passed by value.
+/// </para>
+/// <para>
+/// <b>Relationship to ILogLine:</b> <br/>
+/// <c>LogLine</c> is a concrete, immutable implementation of the <see cref="ILogLine"/> interface, providing
+/// properties for the full line text and its line number.
+/// </para>
+/// <para>
+/// <b>Why struct instead of record:</b> <br/>
+/// A <c>struct</c> is preferred over a <c>record</c> here to avoid heap allocations and to provide value-type
+/// semantics, which are beneficial for performance when processing large numbers of log lines. The struct is
+/// immutable (readonly), ensuring thread safety and predictability. The previous <c>record</c> implementation
+/// was replaced to better align with these performance and semantic requirements.
+/// </para>
+/// </remarks>
 public readonly struct LogLine (string fullLine, int lineNumber) : ILogLine
 {
     public string FullLine { get; } = fullLine;

src/ColumnizerLib/ILogLineSpanColumnizer.cs

@@ -1,6 +1,5 @@
 namespace ColumnizerLib;
 
-// ColumnizerLib/ILogLineSpanColumnizer.cs
 public interface ILogLineSpanColumnizer : ILogLineColumnizer
 {
     /// <summary>

src/ColumnizerLib/ITextValue.cs

@@ -14,7 +14,7 @@ public interface ITextValue
 
 public static class TextValueExtensions
 {
-    [Obsolete("Use FullLine property directly")]
+    [Obsolete("Use ILogLine.FullLine property directly instead of this extension method")]
     public static string GetText (this ILogLine logLine) => logLine.FullLine;
 
     [Obsolete("Use DisplayValue property directly")]

src/LogExpert.Benchmarks/StreamReaderBenchmarks.cs

@@ -183,6 +183,6 @@ public static class Program
 {
     public static void Main (string[] args)
     {
-        var summary = BenchmarkRunner.Run<StreamReaderBenchmarks>();
+        _ = BenchmarkRunner.Run<StreamReaderBenchmarks>();
     }
 }

src/LogExpert.Core/Classes/Log/LogBuffer.cs

@@ -24,7 +24,8 @@ public class LogBuffer
 
     //public LogBuffer() { }
 
-    //Dont use Primary Constructor, MAX_LINES will not be initialized correctly
+    // Don't use a primary constructor here: field initializers (like MAX_LINES) run before primary constructor parameters are assigned,
+    // so MAX_LINES would always be set to its default value before the constructor body can assign it. Use a regular constructor instead.
     public LogBuffer (ILogFileInfo fileInfo, int maxLines)
     {
         FileInfo = fileInfo;

src/LogExpert.Core/Classes/Log/PositionAwareStreamReaderPipeline.cs

@@ -157,6 +157,7 @@ protected override void Dispose (bool disposing)
                     {
                         segment.Dispose();
                     }
+
                     _lineQueue.Dispose();
                 }
 
@@ -200,6 +201,13 @@ private void RestartPipeline (long newPosition)
         }
     }
 
+    /// <summary>
+    /// Cancels the current pipeline operation and releases associated resources. This method should be called while
+    /// holding the appropriate lock to ensure thread safety.
+    /// </summary>
+    /// <remarks>This method cancels any ongoing producer task, marks the internal queue as complete to
+    /// unblock waiting consumers, and disposes of pipeline resources. It is intended for internal use and must be
+    /// invoked only when the pipeline is in a valid state for cancellation.</remarks>
     private void CancelPipelineLocked ()
     {
         if (_cts == null)
@@ -226,7 +234,7 @@ private void CancelPipelineLocked ()
         }
         finally
         {
-            _cts?.Dispose();
+            _cts.Dispose();
             _cts = null;
         }
 
@@ -444,15 +452,12 @@ private void EnqueueLine (LineSegment segment)
                 }
 
                 // If still no space, force process current content as truncated line
-                if (charsInBuffer >= _charBufferSize - 100)
+                if (charsInBuffer >= _charBufferSize - 100 && charsInBuffer > 0)
                 {
-                    if (charsInBuffer > 0)
-                    {
-                        var segment = CreateSegment(charBuffer, 0, charsInBuffer, 0, byteOffset);
-                        byteOffset += segment.ByteLength;
-                        EnqueueLine(segment);
-                        charsInBuffer = 0;
-                    }
+                    var segment = CreateSegment(charBuffer, 0, charsInBuffer, 0, byteOffset);
+                    byteOffset += segment.ByteLength;
+                    EnqueueLine(segment);
+                    charsInBuffer = 0;
                 }
 
                 charsAvailable = _charBufferSize - charsInBuffer;

src/LogExpert.Core/Interface/ILogStreamReaderSpan.cs

@@ -1,9 +1,34 @@
 namespace LogExpert.Core.Interface;
 
-internal interface ILogStreamReaderSpan : ILogStreamReader
+public interface ILogStreamReaderSpan : ILogStreamReader
 {
 
+    /// <summary>
+    /// Attempts to read the next line from the stream.
+    /// </summary>
+    /// <param name="lineMemory">
+    /// When this method returns <c>true</c>, contains a <see cref="ReadOnlyMemory{Char}"/> representing the next line read from the stream.
+    /// The memory is only valid until the next call to <see cref="TryReadLine"/> or until <see cref="ReturnMemory"/> is called.
+    /// </param>
+    /// <returns>
+    /// <c>true</c> if a line was successfully read; <c>false</c> if the end of the stream has been reached or no more lines are available.
+    /// </returns>
+    /// <remarks>
+    /// The returned memory is only valid until the next call to <see cref="TryReadLine"/> or until <see cref="ReturnMemory"/> is called.
+    /// This method is not guaranteed to be thread-safe; concurrent access should be synchronized externally.
+    /// </remarks>
     bool TryReadLine (out ReadOnlyMemory<char> lineMemory);
 
+    /// <summary>
+    /// Returns the memory buffer previously obtained from <see cref="TryReadLine"/> to the underlying pool or resource manager.
+    /// </summary>
+    /// <param name="memory">
+    /// The <see cref="ReadOnlyMemory{Char}"/> instance previously obtained from <see cref="TryReadLine"/>.
+    /// </param>
+    /// <remarks>
+    /// Call this method when you are done processing the memory returned by <see cref="TryReadLine"/> to avoid memory leaks or resource retention.
+    /// Failing to call this method may result in increased memory usage.
+    /// It is safe to call this method multiple times for the same memory, but only the first call will have an effect.
+    /// </remarks>
     void ReturnMemory (ReadOnlyMemory<char> memory);
 }

src/LogExpert.UI/Controls/LogWindow/LogWindow.cs

@@ -7934,7 +7934,7 @@ public void RefreshLogView ()
         RefreshAllGrids();
     }
 
-    //Replace any digit, to normalize numbers
+    //Replace any digit, to normalize numbers.
     [GeneratedRegex("\\d")]
     private static partial Regex ReplaceDigit ();
 

src/PluginRegistry/PluginHashGenerator.Generated.cs

@@ -10,35 +10,35 @@ public static partial class PluginValidator
 {
     /// <summary>
     /// Gets pre-calculated SHA256 hashes for built-in plugins.
-    /// Generated: 2025-12-03 10:17:08 UTC
+    /// Generated: 2025-12-06 09:27:13 UTC
     /// Configuration: Release
     /// Plugin count: 21
     /// </summary>
     public static Dictionary<string, string> GetBuiltInPluginHashes()
     {
         return new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)
         {
-                         ["AutoColumnizer.dll"] = "DEFEE4450E0B6EC0848902A7BEEC141AAE89DE8B71F92F9EBD2206632D96F17A",
+                         ["AutoColumnizer.dll"] = "5B32841702FD32BEABC182E07DD22EE80C1AF57B4F79C8A8DFEFA48DE98A7580",
             ["BouncyCastle.Cryptography.dll"] = "E5EEAF6D263C493619982FD3638E6135077311D08C961E1FE128F9107D29EBC6",
             ["BouncyCastle.Cryptography.dll (x86)"] = "E5EEAF6D263C493619982FD3638E6135077311D08C961E1FE128F9107D29EBC6",
-            ["CsvColumnizer.dll"] = "46827846AD2C2A1BDF6600A5BD7080BC8799B54C81329CDFB23015BDCBF7A480",
-            ["CsvColumnizer.dll (x86)"] = "46827846AD2C2A1BDF6600A5BD7080BC8799B54C81329CDFB23015BDCBF7A480",
-            ["DefaultPlugins.dll"] = "B6DC411F1394D7C2A83B242990E2E4356B0EF523CB518B9FF5658BBC2E05BF5F",
-            ["FlashIconHighlighter.dll"] = "70545A26BB7D433EE3B2735AC38DE233CB5BF4B1F0623E716323C9C95242072B",
-            ["GlassfishColumnizer.dll"] = "FEB269CB14C068698F19ABE3B93C4F5E2DC11116713509FD718C1A0929CDE716",
-            ["JsonColumnizer.dll"] = "99E86FC39F0DF73550E184D50939BB468EB11930E72CBE78353DC9733B9D7365",
-            ["JsonCompactColumnizer.dll"] = "630ED6696B8976596EC2A20228D5F8E9EC6FA94CB544936196C8E9849F692F5A",
-            ["Log4jXmlColumnizer.dll"] = "EB1DF83134242B6A38A354ED50AC16EC25EB9AF02123620CB89209A46CDD0102",
-            ["LogExpert.Core.dll"] = "16AF8E6719D60D5C4B3FFDB63FAA9F81478C1A2445070185E28B3259C5AC0786",
+            ["CsvColumnizer.dll"] = "A6759EE1723545C2FB380C77840F08908DCC68AE4ACEBF74BF706398A431E998",
+            ["CsvColumnizer.dll (x86)"] = "A6759EE1723545C2FB380C77840F08908DCC68AE4ACEBF74BF706398A431E998",
+            ["DefaultPlugins.dll"] = "17D5B3D9D1EDB46BABA354A851F4C85036C17ACF1EA3AC1B5B59DCB96B62DBE9",
+            ["FlashIconHighlighter.dll"] = "859E6BA2D268966FBE9C474FD7AC3DC1963838EAFFB5B7ACC01DD5D749FB9617",
+            ["GlassfishColumnizer.dll"] = "D3EE363792399A7183EFC616F632297E149CC1414EDD3E61272248F3C7F73112",
+            ["JsonColumnizer.dll"] = "523D17BC9340CC2AA47F88564D7D1654088D9E2AE979458B93FCD54935D6E410",
+            ["JsonCompactColumnizer.dll"] = "20B1AED3C2CD9DC45593D2729FD1171A212B2F7B7BBC9A26B2A553750E11FA6A",
+            ["Log4jXmlColumnizer.dll"] = "A3E27F2B4A3892FF1237346BC2174FB00132790422FCD7A131393749A59B05E2",
+            ["LogExpert.Core.dll"] = "C112EB8FA9356670628BA9E6907A9F485E4397F01AA7A4B5D7654DF7568B662C",
             ["Microsoft.Extensions.DependencyInjection.Abstractions.dll"] = "67FA4325000DB017DC0C35829B416F024F042D24EFB868BCF17A895EE6500A93",
             ["Microsoft.Extensions.DependencyInjection.Abstractions.dll (x86)"] = "67FA4325000DB017DC0C35829B416F024F042D24EFB868BCF17A895EE6500A93",
             ["Microsoft.Extensions.Logging.Abstractions.dll"] = "BB853130F5AFAF335BE7858D661F8212EC653835100F5A4E3AA2C66A4D4F685D",
             ["Microsoft.Extensions.Logging.Abstractions.dll (x86)"] = "BB853130F5AFAF335BE7858D661F8212EC653835100F5A4E3AA2C66A4D4F685D",
-            ["RegexColumnizer.dll"] = "98E8A88829BA43CE7E763D197145F1A0863D891F6F274528B8EFE6EF64443063",
-            ["SftpFileSystem.dll"] = "C98EA0176B51E21F685F53EF0CD6CA3B2B4108700EEC19BC0A85019B32BB6067",
-            ["SftpFileSystem.dll (x86)"] = "F65FBD5E63A7D4E801366B5BE043FDA1B12762C21668B8B00ADA3727E469DF9F",
-            ["SftpFileSystem.Resources.dll"] = "B9AF09F4B77E6CD439240DFC94332AD909500478963BFB049BAD6D30A3842113",
-            ["SftpFileSystem.Resources.dll (x86)"] = "B9AF09F4B77E6CD439240DFC94332AD909500478963BFB049BAD6D30A3842113",
+            ["RegexColumnizer.dll"] = "BCF84A9BF5FA11B2842F9E8BB08F91697C6139F6E2748108A748265E377BD5F6",
+            ["SftpFileSystem.dll"] = "37149960232EC87DCE0CA208D6F08CB852A81546297E6879BC63E63677BB490A",
+            ["SftpFileSystem.dll (x86)"] = "C46E4C25C429E8E1F44F8E5B0C707411E0E674355C4B97D4589B6F7CA859C80F",
+            ["SftpFileSystem.Resources.dll"] = "53F44F2DD6D7D77ED5F4A5789FF264025E2D99C04972A1AED4C8939193D57D38",
+            ["SftpFileSystem.Resources.dll (x86)"] = "53F44F2DD6D7D77ED5F4A5789FF264025E2D99C04972A1AED4C8939193D57D38",
 
         };
     }