Merge pull request #83 from CodaFi/trash-removal

Deprecate BasicBlock.delete() with a stern warning

Author: CodaFi

Sources/LLVM/BasicBlock.swift

@@ -63,15 +63,11 @@ public struct BasicBlock: IRValue {
     }
   }
 
-  /// Deletes the basic block from its containing function.
-  /// - note: This does not remove breaks to this block from the
-  ///         function. Ensure you have removed all instructions that reference
-  ///         this basic block before deleting it.
-  public func delete() {
-    LLVMDeleteBasicBlock(llvm)
-  }
-
   /// Removes this basic block from a function but keeps it alive.
+  ///
+  /// - note: To ensure correct removal of the block, you must invalidate any 
+  ///         references to it and its child instructions.  The block must also
+  ///         have no successor blocks that make reference to it.
   public func removeFromParent() {
     LLVMRemoveBasicBlockFromParent(llvm)
   }
@@ -87,6 +83,18 @@ public struct BasicBlock: IRValue {
   }
 }
 
+extension BasicBlock {
+  /// Deletes the basic block from its containing function.
+  /// - note: This does not remove breaks to this block from the
+  ///         function. Ensure you have removed all instructions that reference
+  ///         this basic block before deleting it.
+  @available(*, deprecated, message: "it is hard to use correctly and will be removed.  See BasicBlock.removeFromParent() instead")
+  public func delete() {
+    LLVMDeleteBasicBlock(llvm)
+  }
+
+}
+
 extension BasicBlock {
   /// An `Address` represents a function-relative address of a basic block for
   /// use with the `indirectbr` instruction.