SerialPortStream: Reenable the readonly check.

The keyword `readonly` is applied to objects that are classes, where it is safe to do so. Native methods do not have readonly flags set.
jcurl · Jan 5, 2023 · 01ebfbe · 01ebfbe
1 parent 1c58634
commit 01ebfbe
Show file tree

Hide file tree

Showing 18 changed files with 42 additions and 38 deletions.
diff --git a/code/Datastructures/CircularBuffer.cs b/code/Datastructures/CircularBuffer.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2016
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -34,7 +34,7 @@ internal class CircularBuffer<T>
         /// Circular buffer itself. Exposed by property "Array".
         /// </summary>
         [DebuggerBrowsable(DebuggerBrowsableState.Never)]
-        private T[] m_Array;
+        private readonly T[] m_Array;
 
         /// <summary>
         /// Start index into the buffer. Exposed by property "Start".

diff --git a/code/Datastructures/ReusableList.cs b/code/Datastructures/ReusableList.cs
@@ -15,9 +15,9 @@
     internal class ReusableList<T> : IList<T> where T : class
     {
         private int m_Count;
-        private int m_MinCapacity;
-        private T[] m_ReusableList;
-        private T[][] m_ReusableListCache;
+        private readonly int m_MinCapacity;
+        private readonly T[] m_ReusableList;
+        private readonly T[][] m_ReusableListCache;
 
         public ReusableList(int minCapacity, int maxCapacity)
         {
@@ -87,7 +87,7 @@ public void CopyTo(T[] array, int arrayIndex)
 
         private sealed class ArrayEnumerator : IEnumerator<T>
         {
-            private ReusableList<T> m_Parent;
+            private readonly ReusableList<T> m_Parent;
             private int m_Index;
 
             public ArrayEnumerator(ReusableList<T> parent)

diff --git a/code/Datastructures/TimerExpiry.cs b/code/Datastructures/TimerExpiry.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2016
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -49,7 +49,7 @@ namespace RJCP.Datastructures
     /// </remarks>
     internal sealed class TimerExpiry
     {
-        private Stopwatch m_StopWatch = new Stopwatch();
+        private readonly Stopwatch m_StopWatch = new Stopwatch();
         private int m_Milliseconds;
 
         /// <summary>

diff --git a/code/GlobalSuppressions.cs b/code/GlobalSuppressions.cs
@@ -7,8 +7,8 @@
 
 using System.Diagnostics.CodeAnalysis;
 
-[assembly: SuppressMessage("Style", "IDE0044:Add readonly modifier", Justification = "<Pending>")]
 [assembly: SuppressMessage("Style", "IDE0031:Use null propagation", Justification = ".NET Framework / Core compatibility")]
+[assembly: SuppressMessage("Style", "IDE0044:Add readonly modifier", Justification = "P/Invoke", Scope = "namespaceanddescendants", Target = "~N:RJCP.IO.Ports.Native")]
 [assembly: SuppressMessage("Style", "IDE0056:Use index operator", Justification = ".NET Framework / Core compatibility")]
 [assembly: SuppressMessage("Style", "IDE1006:Naming Styles", Justification = "P/Invoke", Scope = "namespaceanddescendants", Target = "~N:RJCP.IO.Ports.Native")]
 [assembly: SuppressMessage("Major Code Smell", "S1066:Collapsible \"if\" statements should be merged", Justification = "No benefit")]

diff --git a/code/Native/ReadToCache.cs b/code/Native/ReadToCache.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2021
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -31,7 +31,7 @@ internal class ReadToCache
 
         private Encoding m_Encoding = Encoding.GetEncoding("UTF-8");
         private Decoder m_Decoder;
-        private LogSource m_Log;
+        private readonly LogSource m_Log;
 
         public ReadToCache() : this(new LogSource()) { }
 

diff --git a/code/Native/SerialBuffer.cs b/code/Native/SerialBuffer.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2016
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -288,7 +288,7 @@ void ISerialBufferStreamData.DiscardInBuffer()
             }
         }
 
-        private WaitHandle[] m_BufferStreamWaitForWriteCountHandles;
+        private readonly WaitHandle[] m_BufferStreamWaitForWriteCountHandles;
 
         bool ISerialBufferStreamData.WaitForWrite(int count, int timeout)
         {
@@ -352,7 +352,7 @@ int ISerialBufferStreamData.BytesToWrite
             }
         }
 
-        private WaitHandle[] m_BufferStreamFlushHandles;
+        private readonly WaitHandle[] m_BufferStreamFlushHandles;
 
         bool ISerialBufferStreamData.Flush(int timeout)
         {

diff --git a/code/Native/WinNativeSerial.cs b/code/Native/WinNativeSerial.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2016
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -32,7 +32,7 @@ internal class WinNativeSerial : INativeSerial
         private CommOverlappedIo m_CommOverlappedIo;
 
         private string m_Version;
-        private LogSource m_Log;
+        private readonly LogSource m_Log;
 
         public WinNativeSerial() : this(new LogSource()) { }
 

diff --git a/code/Native/Windows/CommErrorEventArgs.cs b/code/Native/Windows/CommErrorEventArgs.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2016
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -8,7 +8,7 @@ namespace RJCP.IO.Ports.Native.Windows
 
     internal class CommErrorEventArgs : EventArgs
     {
-        private NativeMethods.ComStatErrors m_EventType;
+        private readonly NativeMethods.ComStatErrors m_EventType;
 
         /// <summary>
         /// Constructor.

diff --git a/code/Native/Windows/CommEventArgs.cs b/code/Native/Windows/CommEventArgs.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2016
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -8,7 +8,7 @@ namespace RJCP.IO.Ports.Native.Windows
 
     internal class CommEventArgs : EventArgs
     {
-        private NativeMethods.SerialEventMask m_EventType;
+        private readonly NativeMethods.SerialEventMask m_EventType;
 
         /// <summary>
         /// Constructor.

diff --git a/code/Native/Windows/CommOverlappedIo.cs b/code/Native/Windows/CommOverlappedIo.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2021
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -94,7 +94,7 @@ internal class CommOverlappedIo : IDisposable
         private bool m_ReadByteEof;
 
         private string m_Name;
-        private LogSource m_Log;
+        private readonly LogSource m_Log;
         #endregion
 
         #region Constructors

diff --git a/code/Native/Windows/CommProperties.cs b/code/Native/Windows/CommProperties.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2016
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -13,7 +13,7 @@ namespace RJCP.IO.Ports.Native.Windows
     /// </summary>
     internal sealed class CommProperties
     {
-        private SafeFileHandle m_ComPortHandle;
+        private readonly SafeFileHandle m_ComPortHandle;
         private NativeMethods.CommProp m_CommProp = new NativeMethods.CommProp();
 
         internal CommProperties(SafeFileHandle handle)

diff --git a/code/Native/Windows/CommState.cs b/code/Native/Windows/CommState.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2016
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -13,7 +13,7 @@ namespace RJCP.IO.Ports.Native.Windows
     /// </summary>
     internal sealed class CommState
     {
-        private SafeFileHandle m_ComPortHandle;
+        private readonly SafeFileHandle m_ComPortHandle;
         private NativeMethods.DCB m_Dcb = new NativeMethods.DCB();
 
         /// <summary>

diff --git a/code/SerialErrorReceivedEventArgs.cs b/code/SerialErrorReceivedEventArgs.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2016
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -11,7 +11,7 @@ namespace RJCP.IO.Ports
     /// </summary>
     public class SerialErrorReceivedEventArgs : EventArgs
     {
-        private SerialError m_EventType;
+        private readonly SerialError m_EventType;
 
         /// <summary>
         /// Constructor

diff --git a/code/SerialPinChangedEventArgs.cs b/code/SerialPinChangedEventArgs.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2016
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -11,7 +11,7 @@ namespace RJCP.IO.Ports
     /// </summary>
     public class SerialPinChangedEventArgs : EventArgs
     {
-        private SerialPinChange m_EventType;
+        private readonly SerialPinChange m_EventType;
 
         /// <summary>
         /// Constructor.

diff --git a/code/SerialPortStream.cs b/code/SerialPortStream.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2021
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -45,7 +45,7 @@ public partial class SerialPortStream : Stream, ISerialPortStream
         private INativeSerial m_NativeSerial;
         private SerialBuffer m_Buffer;
         private ReadToCache m_ReadTo;
-        private LogSource m_Log;
+        private readonly LogSource m_Log;
 
         #region Public constants
         /// <summary>
@@ -2012,7 +2012,7 @@ public override void SetLength(long value)
 
         #region Event Handling and Abstraction
         private readonly object m_EventLock = new object();
-        private ManualResetEvent m_EventProcessing = new ManualResetEvent(false);
+        private readonly ManualResetEvent m_EventProcessing = new ManualResetEvent(false);
         private SerialData m_SerialDataFlags = SerialData.NoData;
         private SerialError m_SerialErrorFlags = SerialError.NoError;
         private SerialPinChange m_SerialPinChange = SerialPinChange.NoChange;

diff --git a/code/System/IO/Ports/SerialPort.cs b/code/System/IO/Ports/SerialPort.cs
@@ -1,7 +1,7 @@
 namespace System.IO.Ports
 {
     /// <summary>
-    /// Class SerialPort compatibility layer for .NET Stanard 1.5
+    /// Class SerialPort compatibility layer for .NET Standard 1.5
     /// </summary>
     internal class SerialPort
     {

diff --git a/code/Trace/LineSplitter.cs b/code/Trace/LineSplitter.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2019-2021
+// Copyright © Jason Curl 2019-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -12,7 +12,7 @@ namespace RJCP.IO.Ports.Trace
 
     internal sealed class LineSplitter : IEnumerable<string>
     {
-        private StringBuilder m_Line = new StringBuilder();
+        private readonly StringBuilder m_Line = new StringBuilder();
         private List<string> m_Lines = new List<string>();
 
         public bool IsCached { get { return m_Line.Length > 0; } }

diff --git a/code/Trace/LogSource.cs b/code/Trace/LogSource.cs
@@ -1,4 +1,4 @@
-// Copyright © Jason Curl 2012-2021
+// Copyright © Jason Curl 2012-2023
 // Sources at https://github.com/jcurl/SerialPortStream
 // Licensed under the Microsoft Public License (Ms-PL)
 
@@ -25,9 +25,13 @@ namespace RJCP.IO.Ports.Trace
     /// </remarks>
     internal sealed class LogSource : IDisposable
     {
-        private string m_Name;
+        private readonly string m_Name;
         private TraceSource m_TraceSource;
+#if NETSTANDARD1_5
         private long m_TraceLevels;
+#else
+        private readonly long m_TraceLevels;
+#endif
 
         public LogSource()
         {