optimisations

Author: Hirogen

src/AutoColumnizer/AutoColumnizer.cs

@@ -1,5 +1,3 @@
-using System;
-
 using LogExpert;
 
 namespace AutoColumnizer;
@@ -20,6 +18,11 @@ public string GetName ()
         return "Auto Columnizer";
     }
 
+    public string GetCustomName ()
+    {
+        return GetName();
+    }
+
     public string GetDescription ()
     {
         return "Automatically find the right columnizer for any file";

src/ColumnizerLib/ILogLineColumnizer.cs

@@ -1,12 +1,10 @@
-using System;
-
 namespace LogExpert;
 
 ///<summary>
 /// This interface defines a so-called 'Columnizer' for LogExpert.
 /// A columnizer splits a single text line into well defined columns. These columns
 /// are used in the data grid view of LogExpert.
-/// <br></br><br></br> 
+/// <br></br><br></br>
 /// Optionally a columnizer can parse the log line to determine the date/time of
 /// the log line (assuming that all log lines have a timestamp). This is needed for
 /// some of the features of LogExpert (see user documentation for more information).
@@ -20,45 +18,50 @@ public interface ILogLineColumnizer
     /// <summary>
     /// Returns the name for the columnizer. This name is used for the columnizer selection dialog.
     /// </summary>
-    string GetName();
+    string GetName ();
+
+    /// <summary>
+    /// Returns the name that is given by the user for this columnizer.
+    /// </summary>
+    string GetCustomName ();
 
     /// <summary>
     /// Returns the description of the columnizer. This text is used in the columnizer selection dialog.
     /// </summary>
-    string GetDescription();
+    string GetDescription ();
 
     /// <summary>
-    /// Returns the number of columns the columnizer will split lines into. 
+    /// Returns the number of columns the columnizer will split lines into.
     /// </summary>
     /// <remarks>
-    /// This value does not include the column for displaying the line number. The line number column 
+    /// This value does not include the column for displaying the line number. The line number column
     /// is added by LogExpert and is not handled by columnizers.
     /// </remarks>
-    int GetColumnCount();
+    int GetColumnCount ();
 
     /// <summary>
     /// Returns the names of the columns. The returned names are used by LogExpert for the column headers in the data grid view.
-    /// The names are expected in order from left to right. 
+    /// The names are expected in order from left to right.
     /// </summary>
-    string[] GetColumnNames();
+    string[] GetColumnNames ();
 
     /// <summary>
-    /// Given a single line of the logfile this function splits the line content into columns. The function returns 
+    /// Given a single line of the logfile this function splits the line content into columns. The function returns
     /// a string array containing the splitted content.
     /// </summary>
     /// <remarks>
     /// This function is called by LogExpert for every line that has to be drawn in the grid view. The faster your code
     /// handles the splitting, the faster LogExpert can draw the grid view content.<br></br>
     /// <br></br>
     /// Notes about timeshift handling:<br></br>
-    /// If your columnizer implementation supports timeshift (see <see cref="IsTimeshiftImplemented">IsTimeshiftImplemented</see>) 
+    /// If your columnizer implementation supports timeshift (see <see cref="IsTimeshiftImplemented">IsTimeshiftImplemented</see>)
     /// you have to add the timestamp offset to the columns representing the timestamp (e.g. columns like 'date' and 'time').
-    /// In practice this means you have to parse the date/time value of your log line (see <see cref="GetTimestamp">GetTimestamp</see>) 
+    /// In practice this means you have to parse the date/time value of your log line (see <see cref="GetTimestamp">GetTimestamp</see>)
     /// add the offset and convert the timestamp back to string value(s).
     /// </remarks>
     /// <param name="callback">Callback interface with functions which can be used by the columnizer</param>
     /// <param name="line">The line content to be splitted</param>
-    IColumnizedLogLine SplitLine(ILogLineColumnizerCallback callback, ILogLine line);
+    IColumnizedLogLine SplitLine (ILogLineColumnizerCallback callback, ILogLine line);
 
     /// <summary>
     /// Returns true, if the columnizer supports timeshift handling.
@@ -67,23 +70,23 @@ public interface ILogLineColumnizer
     /// If you return true, you also have to implement the function SetTimeOffset(), GetTimeOffset() and GetTimestamp().
     /// You also must handle PushValue() for the column(s) that displays the timestamp.
     /// </remarks>
-    bool IsTimeshiftImplemented();
+    bool IsTimeshiftImplemented ();
 
     /// <summary>
-    /// Sets an offset to be used for displaying timestamp values. You have to implement this function, if 
+    /// Sets an offset to be used for displaying timestamp values. You have to implement this function, if
     /// your IsTimeshiftImplemented() function return true.
     /// </summary>
     /// <remarks>
-    /// You have to store the given value in the Columnizer instance and add this offset to the timestamp column(s) returned by SplitLine() 
+    /// You have to store the given value in the Columnizer instance and add this offset to the timestamp column(s) returned by SplitLine()
     /// (e.g. in the date and time columns).
     /// </remarks>
     /// <param name="msecOffset">The timestamp offset in milliseconds.</param>
-    void SetTimeOffset(int msecOffset);
+    void SetTimeOffset (int msecOffset);
 
     /// <summary>
     /// Returns the current stored timestamp offset (set by SetTimeOffset()).
     /// </summary>
-    int GetTimeOffset();
+    int GetTimeOffset ();
 
     /// <summary>
     /// Returns the timestamp value of the given line as a .NET DateTime object. If there's no valid timestamp in the
@@ -99,7 +102,7 @@ public interface ILogLineColumnizer
     /// </remarks>
     /// <param name="callback">Callback interface with functions which can be used by the columnizer</param>
     /// <param name="line">The line content which timestamp has to be returned.</param>
-    DateTime GetTimestamp(ILogLineColumnizerCallback callback, ILogLine line);
+    DateTime GetTimestamp (ILogLineColumnizerCallback callback, ILogLine line);
 
     /// <summary>
     /// This function is called if the user changes a value in a column (edit mode in the log view).
@@ -114,7 +117,7 @@ public interface ILogLineColumnizer
     /// <param name="column">The column number which value has changed.</param>
     /// <param name="value">The new value.</param>
     /// <param name="oldValue">The old value.</param>
-    void PushValue(ILogLineColumnizerCallback callback, int column, string value, string oldValue);
+    void PushValue (ILogLineColumnizerCallback callback, int column, string value, string oldValue);
 
     #endregion
 }

src/CsvColumnizer/CsvColumnizer.cs

@@ -72,6 +72,11 @@ public string GetName ()
         return "CSV Columnizer";
     }
 
+    public string GetCustomName ()
+    {
+        return GetName();
+    }
+
     public string GetDescription ()
     {
         return "Splits CSV files into columns.\r\n\r\nCredits:\r\nThis Columnizer uses the CsvHelper. https://github.com/JoshClose/CsvHelper. \r\n";

src/GlassfishColumnizer/GlassfishColumnizer.cs

@@ -13,7 +13,7 @@ internal class GlassfishColumnizer : ILogLineXmlColumnizer
     public const int COLUMN_COUNT = 2;
     private const string DATETIME_FORMAT = "yyyy-MM-ddTHH:mm:ss.fffzzzz";
     private const string DATETIME_FORMAT_OUT = "yyyy-MM-dd HH:mm:ss.fff";
-    private const char separatorChar = '|';
+    private const char SEPARATOR_CHAR = '|';
 
     private static readonly XmlConfig xmlConfig = new();
 
@@ -42,7 +42,7 @@ public ILogLine GetLineTextForClipboard (ILogLine logLine, ILogLineColumnizerCal
     {
         GlassFishLogLine line = new()
         {
-            FullLine = logLine.FullLine.Replace(separatorChar, '|'),
+            FullLine = logLine.FullLine.Replace(SEPARATOR_CHAR, '|'),
             LineNumber = logLine.LineNumber
         };
 
@@ -51,7 +51,12 @@ public ILogLine GetLineTextForClipboard (ILogLine logLine, ILogLineColumnizerCal
 
     public string GetName ()
     {
-        return "Classfish";
+        return "Glassfish";
+    }
+
+    public string GetCustomName ()
+    {
+        return GetName();
     }
 
     public string GetDescription ()
@@ -171,7 +176,7 @@ public DateTime GetTimestamp (ILogLineColumnizerCallback callback, ILogLine logL
             return DateTime.MinValue;
         }
 
-        var endIndex = temp.IndexOf(separatorChar, 1);
+        var endIndex = temp.IndexOf(SEPARATOR_CHAR, 1);
         if (endIndex is > 28 or < 0)
         {
             return DateTime.MinValue;

src/JsonColumnizer/JsonColumnizer.cs

@@ -216,5 +216,10 @@ protected virtual IColumnizedLogLine SplitJsonLine (ILogLine line, JObject json)
         return cLogLine;
     }
 
+    public string GetCustomName ()
+    {
+        return GetName();
+    }
+
     #endregion
 }

src/Log4jXmlColumnizer/Log4jXmlColumnizer.cs

@@ -59,6 +59,8 @@ public string GetName ()
         return "Log4j XML";
     }
 
+    public string GetCustomName () => GetName();
+
     public string GetDescription ()
     {
         return "Reads and formats XML log files written with log4j.";

src/LogExpert.Core/Classes/Columnizer/ClfColumnizer.cs

@@ -192,5 +192,10 @@ public IColumnizedLogLine SplitLine (ILogLineColumnizerCallback callback, ILogLi
         return cLogLine;
     }
 
+    public string GetCustomName ()
+    {
+        return GetName();
+    }
+
     #endregion
 }

src/LogExpert.Core/Classes/Columnizer/SquareBracketColumnizer.cs

@@ -107,6 +107,8 @@ public string GetName ()
         return "Square Bracket Columnizer";
     }
 
+    public string GetCustomName () => GetName();
+
     public string GetDescription ()
     {
         return "Splits every line into n fields: Date, Time and the rest of the log message";

src/LogExpert.Core/Classes/Columnizer/TimestampColumnizer.cs

@@ -87,6 +87,8 @@ public string GetName ()
         return "Timestamp Columnizer";
     }
 
+    public string GetCustomName () => GetName();
+
     public string GetDescription ()
     {
         return "Splits every line into 3 fields: Date, Time and the rest of the log message";