Merge pull request #1162 from drewnoakes/nullable-annotations-100-percent

Complete the nullable annotations

Author: drewnoakes

src/Directory.Build.props

@@ -1,14 +1,13 @@
 <Project>
 
   <PropertyGroup>
-    <LangVersion>13</LangVersion>
+    <LangVersion>14</LangVersion>
     <Nullable>enable</Nullable>
     <ProduceReferenceAssembly>true</ProduceReferenceAssembly>
     <AccelerateBuildsInVisualStudio>true</AccelerateBuildsInVisualStudio>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="JetBrains.Annotations" Version="2022.3.1" PrivateAssets="All" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
   </ItemGroup>
 

src/NetMQ.Tests/CleanupAfterFixture.cs

@@ -1,9 +1,7 @@
 using System;
-using JetBrains.Annotations;
 
 namespace NetMQ.Tests
 {
-    [UsedImplicitly]
     public sealed class CleanupAfterFixture : IDisposable
     {
         public void Dispose() => NetMQConfig.Cleanup();

src/NetMQ.Tests/NetMQ.Tests.csproj

@@ -54,7 +54,6 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Update="JetBrains.Annotations" Version="2025.2.4" />
     <PackageReference Update="Microsoft.SourceLink.GitHub" Version="10.0.202" />
   </ItemGroup>
 

src/NetMQ/Annotations.cs

@@ -87,4 +87,56 @@ internal sealed class DoesNotReturnIfAttribute : Attribute
     }
 }
 
+#endif
+
+#if !NET5_0_OR_GREATER
+
+namespace System.Diagnostics.CodeAnalysis
+{
+    /// <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
+    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Property, Inherited = false, AllowMultiple = true)]
+    internal sealed class MemberNotNullAttribute : Attribute
+    {
+        /// <summary>Initializes the attribute with a field or property member.</summary>
+        /// <param name="member">The field or property member that is promised to be not-null.</param>
+        public MemberNotNullAttribute(string member) => Members = [member];
+
+        /// <summary>Initializes the attribute with the list of field and property members.</summary>
+        /// <param name="members">The list of field and property members that are promised to be not-null.</param>
+        public MemberNotNullAttribute(params string[] members) => Members = members;
+
+        /// <summary>Gets field or property member names.</summary>
+        public string[] Members { get; }
+    }
+
+    /// <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
+    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Property, Inherited = false, AllowMultiple = true)]
+    internal sealed class MemberNotNullWhenAttribute : Attribute
+    {
+        /// <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
+        /// <param name="returnValue">The return value condition. If the method returns this value, the associated parameter will not be null.</param>
+        /// <param name="member">The field or property member that is promised to be not-null.</param>
+        public MemberNotNullWhenAttribute(bool returnValue, string member)
+        {
+            ReturnValue = returnValue;
+            Members = [member];
+        }
+
+        /// <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
+        /// <param name="returnValue">The return value condition. If the method returns this value, the associated parameter will not be null.</param>
+        /// <param name="members">The list of field and property members that are promised to be not-null.</param>
+        public MemberNotNullWhenAttribute(bool returnValue, params string[] members)
+        {
+            ReturnValue = returnValue;
+            Members = members;
+        }
+
+        /// <summary>Gets the return value condition.</summary>
+        public bool ReturnValue { get; }
+
+        /// <summary>Gets field or property member names.</summary>
+        public string[] Members { get; }
+    }
+}
+
 #endif

src/NetMQ/Core/Ctx.cs

@@ -19,15 +19,11 @@ You should have received a copy of the GNU Lesser General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-#nullable disable
-
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
 using System.Threading;
-using JetBrains.Annotations;
-
 namespace NetMQ.Core
 {
     /// <summary>
@@ -54,7 +50,7 @@ public class Endpoint
             /// </summary>
             /// <param name="socket">the socket for this new Endpoint</param>
             /// <param name="options">the Options to assign to this new Endpoint</param>
-            public Endpoint([NotNull] SocketBase socket, [NotNull] Options options)
+            public Endpoint(SocketBase socket, Options options)
             {
                 Socket = socket;
                 Options = options;
@@ -63,13 +59,11 @@ public Endpoint([NotNull] SocketBase socket, [NotNull] Options options)
             /// <summary>
             /// Get the socket associated with this Endpoint.
             /// </summary>
-            [NotNull]
             public SocketBase Socket { get; }
 
             /// <summary>
             /// Get the Options of this Endpoint.
             /// </summary>
-            [NotNull]
             public Options Options { get; }
         }
 
@@ -109,7 +103,7 @@ public Endpoint([NotNull] SocketBase socket, [NotNull] Options options)
         /// <summary>
         /// The reaper thread.
         /// </summary>
-        [CanBeNull] private Reaper m_reaper;
+        private Reaper? m_reaper;
 
         /// <summary>
         /// List of I/O threads.
@@ -124,7 +118,7 @@ public Endpoint([NotNull] SocketBase socket, [NotNull] Options options)
         /// <summary>
         /// Array of pointers to mailboxes for both application and I/O threads.
         /// </summary>
-        [CanBeNull] private IMailbox[] m_slots;
+        private IMailbox?[]? m_slots;
 
         /// <summary>
         /// Mailbox for zmq_term thread.
@@ -202,9 +196,9 @@ public void Terminate(bool block)
                             socket.Stop();
 
                         if (!block)
-                            m_reaper.ForceStop();
+                            m_reaper!.ForceStop();
                         else if (m_sockets.Count == 0)
-                            m_reaper.Stop();
+                            m_reaper!.Stop();
                     }
                     finally
                     {
@@ -265,7 +259,6 @@ public int MaxSockets
         /// <exception cref="TerminatingException">Cannot create new socket while terminating.</exception>
         /// <exception cref="NetMQException">Maximum number of sockets reached.</exception>
         /// <exception cref="TerminatingException">The context (Ctx) must not be already terminating.</exception>
-        [NotNull]
         public SocketBase CreateSocket(ZmqSocketType type)
         {
             lock (m_slotSync)
@@ -343,7 +336,7 @@ public SocketBase CreateSocket(ZmqSocketType type)
                 SocketBase s = SocketBase.Create(type, this, slot, socketId);
 
                 m_sockets.Add(s);
-                m_slots[slot] = s.Mailbox;
+                m_slots![slot] = s.Mailbox;
 
                 //LOG.debug("NEW Slot [" + slot + "] " + s);
 
@@ -359,14 +352,14 @@ public SocketBase CreateSocket(ZmqSocketType type)
         /// <remarks>
         /// If this was the last socket, then stop the reaper.
         /// </remarks>
-        public void DestroySocket([NotNull] SocketBase socket)
+        public void DestroySocket(SocketBase socket)
         {
             // Free the associated thread slot.
             lock (m_slotSync)
             {
                 int threadId = socket.ThreadId;
                 m_emptySlots.Push(threadId);
-                m_slots[threadId].Close();
+                m_slots![threadId]!.Close();
                 m_slots[threadId] = null;
 
                 // Remove the socket from the list of sockets.
@@ -375,7 +368,7 @@ public void DestroySocket([NotNull] SocketBase socket)
                 // If zmq_term() was already called and there are no more socket
                 // we can ask reaper thread to terminate.
                 if (m_terminating && m_sockets.Count == 0)
-                    m_reaper.Stop();
+                    m_reaper!.Stop();
             }
 
             //LOG.debug("Released Slot [" + socket_ + "] ");
@@ -386,31 +379,30 @@ public void DestroySocket([NotNull] SocketBase socket)
         /// </summary>
         public ZObject GetReaper()
         {
-            return m_reaper;
+            return m_reaper!;
         }
 
         /// <summary>
         /// Send a command to the given destination thread.
         /// </summary>
-        public void SendCommand(int threadId, [NotNull] Command command)
+        public void SendCommand(int threadId, Command command)
         {
-            m_slots[threadId].Send(command);
+            m_slots![threadId]!.Send(command);
         }
 
         /// <summary>
         /// Returns the <see cref="IOThread"/> that is the least busy at the moment.
         /// </summary>
         /// <paramref name="affinity">Which threads are eligible (0 = all).</paramref>
         /// <returns>The least busy thread, or <c>null</c> if none is available.</returns>
-        [CanBeNull]
-        public IOThread ChooseIOThread(long affinity)
+        public IOThread? ChooseIOThread(long affinity)
         {
             if (m_ioThreads.Count == 0)
                 return null;
 
             // Find the I/O thread with minimum load.
             int minLoad = -1;
-            IOThread selectedIOThread = null;
+            IOThread? selectedIOThread = null;
 
             for (int i = 0; i != m_ioThreads.Count; i++)
             {
@@ -435,7 +427,7 @@ public IOThread ChooseIOThread(long affinity)
         /// <param name="address">the textual name to give this endpoint</param>
         /// <param name="endpoint">the Endpoint to remember</param>
         /// <returns>true if the given address was NOT already registered</returns>
-        public bool RegisterEndpoint([NotNull] string address, [NotNull] Endpoint endpoint)
+        public bool RegisterEndpoint(string address, Endpoint endpoint)
         {
             lock (m_endpointsSync)
             {
@@ -453,12 +445,12 @@ public bool RegisterEndpoint([NotNull] string address, [NotNull] Endpoint endpoi
         /// <param name="address">the (string) address denoting the endpoint to unregister</param>
         /// <param name="socket">the socket associated with that endpoint</param>
         /// <returns>true if the endpoint having this address and socket is found, false otherwise</returns>
-        public bool UnregisterEndpoint([NotNull] string address, [NotNull] SocketBase socket)
+        public bool UnregisterEndpoint(string address, SocketBase socket)
         {
             lock (m_endpointsSync)
             {
 
-                if (!m_endpoints.TryGetValue(address, out Endpoint endpoint))
+                if (!m_endpoints.TryGetValue(address, out Endpoint? endpoint))
                     return false;
 
                 if (socket != endpoint.Socket)
@@ -473,7 +465,7 @@ public bool UnregisterEndpoint([NotNull] string address, [NotNull] SocketBase so
         /// Remove from the list of endpoints, all endpoints that reference the given socket.
         /// </summary>
         /// <param name="socket">the socket to remove all references to</param>
-        public void UnregisterEndpoints([NotNull] SocketBase socket)
+        public void UnregisterEndpoints(SocketBase socket)
         {
             lock (m_endpointsSync)
             {
@@ -494,11 +486,8 @@ public void UnregisterEndpoints([NotNull] SocketBase socket)
         /// By calling this method, the socket associated with that returned EndPoint has it's Seqnum incremented,
         /// in order to prevent it from being de-allocated before a command can be sent to it.
         /// </remarks>
-        [NotNull]
-        public Endpoint FindEndpoint([NotNull] string addr)
+        public Endpoint FindEndpoint(string addr)
         {
-            Debug.Assert(addr != null);
-
             lock (m_endpointsSync)
             {
                 if (!m_endpoints.ContainsKey(addr))