README.md

Coplt.Dropping

Auto gen dispose pattern

• Auto handle Dispose(bool dispoing) pattern
• Auto handle destructor/finalizer
• Allow multiple drops
• Specify the drop order [Drop(Order = X)]
• The first argument of Drop target method can be bool disposing
• Mark Drop directly on fields and properties (requires target type have Dispose method)
• Dose not supported AsyncDispose, too complicated, it is recommended to implement it manually
• Drop can mark on static methods, will pass this on first argument, if have bool disposing will be the second argument

Example

• Basic usage

  [Dropping]
  public partial class Foo1
  {
      [Drop]
      public void Drop()
      {
          Console.WriteLine(1);
      }
  }

  Generate output:

  Foo1.dropping.g.cs

  // <auto-generated/>
  
  #nullable enable
  
  using Coplt.Dropping;
  
  public partial class Foo1 : global::System.IDisposable
  {
  
      protected virtual void Dispose(bool disposing)
      {
          if (disposing) Drop();
      }
  
      public void Dispose()
      {
          Dispose(true);
          GC.SuppressFinalize(this);
      }
  
      ~Foo1()
      {
          Dispose(false);
      }
  
  }

  
  

• Unmanaged resources

  [Dropping(Unmanaged = true /* set drop in the class all default is unmanaged */)]
  public partial class Foo2
  {
      [Drop]
      private void Drop()
      {
          Console.WriteLine(1);
      }
  
      [Drop(Unmanaged = false)]
      private void Drop2()
      {
          Console.WriteLine(2);
      }
  }

  Generate output:

  Foo2.dropping.g.cs

  // <auto-generated/>
  
  #nullable enable
  
  using Coplt.Dropping;
  
  public partial class Foo2 : global::System.IDisposable
  {
  
      protected virtual void Dispose(bool disposing)
      {
          Drop();
          if (disposing) Drop2();
      }
  
      public void Dispose()
      {
          Dispose(true);
          GC.SuppressFinalize(this);
      }
  
      ~Foo2()
      {
          Dispose(false);
      }
  
  }

  
  

• Inherit

  [Dropping]
  public partial class Foo3 : Foo2
  {
      [Drop]
      private void Drop()
      {
          Console.WriteLine(1);
      }
  
      [Drop(Unmanaged = true)]
      private void Drop2()
      {
          Console.WriteLine(2);
      }
  }

  Generate output:

  Foo3.dropping.g.cs

  // <auto-generated/>
  
  #nullable enable
  
  using Coplt.Dropping;
  
  public partial class Foo3 : global::System.IDisposable
  {
  
      protected override void Dispose(bool disposing)
      {
          if (disposing) Drop();
          Drop2();
          base.Dispose(disposing);
      }
  
  }

  
  

• Sealed And Struct

  [Dropping]
  public sealed partial class Foo4
  {
      [Drop]
      public void Drop()
      {
          Console.WriteLine(1);
      }
  }
  
  [Dropping(Unmanaged = true)]
  public sealed partial class Foo5
  {
      [Drop]
      public void Drop()
      {
          Console.WriteLine(1);
      }
  }
  
  [Dropping]
  public partial struct Foo6
  {
      [Drop]
      private void Drop()
      {
          Console.WriteLine(1);
      }
  }

  Generate output:

  Foo4.dropping.g.cs

  // <auto-generated/>
  
  #nullable enable
  
  using Coplt.Dropping;
  
  public partial class Foo4 : global::System.IDisposable
  {
  
      public void Dispose()
      {
          Drop();
      }
  
  }

  Foo5.dropping.g.cs

  // <auto-generated/>
  
  #nullable enable
  
  using Coplt.Dropping;
  
  public partial class Foo5 : global::System.IDisposable
  {
  
      public void Dispose()
      {
          Drop();
          GC.SuppressFinalize(this);
      }
  
      ~Foo5()
      {
          Dispose();
      }
  
  }

  Foo6.dropping.g.cs

  // <auto-generated/>
  
  #nullable enable
  
  using Coplt.Dropping;
  
  public partial struct Foo6 : global::System.IDisposable
  {
  
      public void Dispose()
      {
          Drop();
      }
  
  }

  
  

More see Tests