fix: Aligned disposable patterns (#746)

* fix: Aligned disposable patterns

* Lucene.Net.Analysis.Util.CharArrayMap: Reverted changes to avoid conflict with other work that has been done to CharArrayMap

* SWEEP: Added comments to indicate places where we have diverged from Lucene to implement the disposable pattern properly.

* Lucene.Net.Codecs.Memory.MemoryDocValuesConsumer: Changed code order of Dispose() and Dispose(bool) to align with other classes

Co-authored-by: Shad Storhaug <[email protected]>

src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/PrefixAndSuffixAwareTokenFilter.cs

@@ -1,4 +1,4 @@
-// Lucene version compatibility level 4.8.1
+// Lucene version compatibility level 4.8.1
 namespace Lucene.Net.Analysis.Miscellaneous
 {
     /*
@@ -96,6 +96,7 @@ protected override void Dispose(bool disposing)
             {
                 suffix.Dispose();
             }
+            base.Dispose(disposing); // LUCENENET specific - disposable pattern requires calling the base class implementation
         }
 
         public override void End()

src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/PrefixAwareTokenFilter.cs

@@ -1,4 +1,4 @@
-// Lucene version compatibility level 4.8.1
+// Lucene version compatibility level 4.8.1
 using Lucene.Net.Analysis.TokenAttributes;
 using Lucene.Net.Util;
 
@@ -182,6 +182,7 @@ protected override void Dispose(bool disposing)
                 prefix.Dispose();
                 suffix.Dispose();
             }
+            base.Dispose(disposing); // LUCENENET specific - disposable pattern requires calling the base class implementation
         }
 
         public override void Reset()

src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs

@@ -138,6 +138,7 @@ protected override void Dispose(bool disposing)
                 this.isDisposing = false;
 #endif
             }
+            base.Dispose(disposing); // LUCENENET specific - disposable pattern requires calling the base class implementation
         }
 
         /// <summary>

src/Lucene.Net.Benchmark/ByTask/Tasks/NearRealtimeReaderTask.cs

@@ -123,6 +123,7 @@ protected override void Dispose(bool disposing)
                 }
                 Console.WriteLine();
             }
+            base.Dispose(disposing); // LUCENENET specific - disposable pattern requires calling the base class implementation
         }
 
         public override bool SupportsParams => true;

src/Lucene.Net.Benchmark/ByTask/Tasks/TaskSequence.cs

@@ -76,6 +76,7 @@ protected override void Dispose(bool disposing)
                 }
                 RunData.DocMaker.Dispose();
             }
+            base.Dispose(disposing); // LUCENENET specific - disposable pattern requires calling the base class implementation
         }
 
         private void InitTasksArray()

src/Lucene.Net.Codecs/Memory/MemoryDocValuesConsumer.cs

@@ -499,8 +499,17 @@ private void EncodeValues(int count)
 
             public void Dispose()
             {
-                this.counts.Dispose();
-                this.ords.Dispose();
+                Dispose(true);
+                GC.SuppressFinalize(this);
+            }
+
+            protected virtual void Dispose(bool disposing)
+            {
+                if (disposing)
+                {
+                    this.counts.Dispose();
+                    this.ords.Dispose();
+                }
             }
 
             // LUCENENET: Remove() not supported in .NET

src/Lucene.Net.Facet/Taxonomy/WriterCache/CollisionMap.cs

@@ -213,7 +213,7 @@ internal virtual int GetMemoryUsage()
             return memoryUsage;
         }
 
-        private class EntryEnumerator : IEnumerator<Entry>
+        private sealed class EntryEnumerator : IEnumerator<Entry> // LUCENENET: Marked sealed
         {
             internal Entry next; // next entry to return
             internal int index; // current slot

src/Lucene.Net.Spatial/Prefix/AbstractVisitingPrefixTreeFilter.cs

@@ -367,7 +367,7 @@ protected internal virtual void Scan(int scanDetailLevel)
         /// <summary>
         /// Used for <see cref="VNode.children"/>.
         /// </summary>
-        private class VNodeCellEnumerator : IEnumerator<VNode>
+        private sealed class VNodeCellEnumerator : IEnumerator<VNode>// LUCENENET: Marked sealed
         {
             internal readonly IEnumerator<Cell> cellIter;
             private readonly VNode vNode;

src/Lucene.Net/Analysis/TokenFilter.cs

@@ -82,6 +82,7 @@ protected override void Dispose(bool disposing)
             {
                 m_input.Dispose();
             }
+            base.Dispose(disposing); // LUCENENET specific - disposable pattern requires calling the base class implementation
         }
 
         /// <summary>

src/Lucene.Net/Analysis/Tokenizer.cs

@@ -79,6 +79,7 @@ protected override void Dispose(bool disposing)
                 inputPending = ILLEGAL_STATE_READER;
                 m_input = ILLEGAL_STATE_READER;
             }
+            base.Dispose(disposing); // LUCENENET specific - disposable pattern requires calling the base class implementation
         }
 
         /// <summary>

src/Lucene.Net/Codecs/PerField/PerFieldDocValuesFormat.cs

@@ -1,4 +1,4 @@
-using J2N.Runtime.CompilerServices;
+using J2N.Runtime.CompilerServices;
 using Lucene.Net.Diagnostics;
 using System;
 using System.Collections.Generic;
@@ -94,7 +94,16 @@ internal class ConsumerAndSuffix : IDisposable
 
             public void Dispose()
             {
-                Consumer.Dispose();
+                Dispose(true);
+                GC.SuppressFinalize(this);
+            }
+
+            protected virtual void Dispose(bool disposing)
+            {
+                if (disposing)
+                {
+                    Consumer.Dispose();
+                }
             }
         }
 

src/Lucene.Net/Codecs/PerField/PerFieldPostingsFormat.cs

@@ -89,7 +89,16 @@ internal class FieldsConsumerAndSuffix : IDisposable
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
             public void Dispose()
             {
-                Consumer.Dispose();
+                Dispose(true);
+                GC.SuppressFinalize(this);
+            }
+
+            protected virtual void Dispose(bool disposing)
+            {
+                if (disposing)
+                {
+                    Consumer.Dispose();
+                }
             }
         }
 

src/Lucene.Net/Index/IndexWriter.cs

@@ -593,7 +593,16 @@ public virtual void Release(ReadersAndUpdates rld, bool assertInfoLive)
 
             public void Dispose()
             {
-                DropAll(false);
+                Dispose(true);
+                GC.SuppressFinalize(this);
+            }
+
+            protected virtual void Dispose(bool disposing)
+            {
+                if (disposing)
+                {
+                    DropAll(false);
+                }
             }
 
             /// <summary>

src/Lucene.Net/Index/PrefixCodedTerms.cs

@@ -87,7 +87,7 @@ internal PrefixCodedTermsIterator(RAMFile buffer)
             public void Dispose()
             {
                 Dispose(true);
-                GC.SuppressFinalize(true);
+                GC.SuppressFinalize(this);
             }
 
             protected virtual void Dispose(bool disposing)

src/Lucene.Net/Store/FSDirectory.cs

@@ -562,6 +562,7 @@ protected override void Dispose(bool disposing)
                         }
                     }
                 }
+                //base.Dispose(disposing); // LUCENENET: No need to call base class, we are not using the functionality of BufferedIndexOutput
             }
 
             /// <summary>

src/Lucene.Net/Support/IO/SafeTextWriterWrapper.cs

@@ -358,6 +358,7 @@ protected override void Dispose(bool disposing)
             {
                 textWriter.Dispose();
             }
+            base.Dispose(disposing); // LUCENENET specific - disposable pattern requires calling the base class implementation
         }
     }
 }

src/Lucene.Net/Support/Index/TaskMergeScheduler.cs

@@ -621,14 +621,23 @@ private void Run(CancellationToken cancellationToken)
 
             public void Dispose()
             {
-                if (_isDisposed)
+                Dispose(true);
+                GC.SuppressFinalize(this);
+            }
+
+            protected virtual void Dispose(bool disposing)
+            {
+                if (disposing)
                 {
-                    return;
-                }
+                    if (_isDisposed)
+                    {
+                        return;
+                    }
 
-                _isDisposed = true;
-                _lock.Dispose();
-                _cancellationTokenSource.Dispose();
+                    _isDisposed = true;
+                    _lock.Dispose();
+                    _cancellationTokenSource.Dispose();
+                }
             }
 
             public override string ToString()

src/Lucene.Net/Util/PrintStreamInfoStream.cs

@@ -1,4 +1,4 @@
-using J2N.Threading.Atomic;
+using J2N.Threading.Atomic;
 using Lucene.Net.Support.IO;
 using System;
 using System.IO;
@@ -90,6 +90,7 @@ protected override void Dispose(bool disposing)
             {
                 m_stream.Dispose();
             }
+            base.Dispose(disposing); // LUCENENET specific - disposable pattern requires calling the base class implementation
         }
 
         public virtual bool IsSystemStream => isSystemStream;

src/dotnet/tools/lucene-cli/CommandLine/CommandLineApplication.cs

@@ -534,7 +534,7 @@ private static void HandleUnexpectedArg(CommandLineApplication command, string[]
             }
         }
 
-        private class CommandArgumentEnumerator : IEnumerator<CommandArgument>
+        private sealed class CommandArgumentEnumerator : IEnumerator<CommandArgument>
         {
             private readonly IEnumerator<CommandArgument> _enumerator;
 

src/dotnet/tools/lucene-cli/SourceCode/SourceCodeSectionReader.cs

@@ -150,6 +150,7 @@ protected override void Dispose(bool disposing)
             {
                 this.reader?.Dispose();
             }
+            base.Dispose(disposing);
         }
     }
 }