Merge pull request #41447 from gottesmm/pr-0a43136a0997cf857b363ce49caf55b57bb51abc

[irgen] Implement irgen::IRBuilder::SavedInsertionPointRAII.

Author: gottesmm

lib/IRGen/IRBuilder.h

@@ -68,6 +68,9 @@ class IRBuilder : public IRBuilderBase {
 #endif
     {}
 
+  /// Defined below.
+  class SavedInsertionPointRAII;
+
   /// Determines if the current location is apparently reachable.  The
   /// invariant we maintain is that the insertion point of the builder
   /// always points within a block unless the current location is
@@ -345,6 +348,72 @@ class IRBuilder : public IRBuilderBase {
     }
     return result;
   }
+
+  bool insertingAtEndOfBlock() const {
+    assert(hasValidIP() && "Must have insertion point to ask about it");
+    return InsertPt == BB->end();
+  }
+};
+
+/// Given a Builder as input to its constructor, this class resets the Builder
+/// so it has the same insertion point at end of scope.
+class IRBuilder::SavedInsertionPointRAII {
+  IRBuilder &builder;
+  PointerUnion<llvm::Instruction *, llvm::BasicBlock *> savedInsertionPoint;
+
+public:
+  /// Constructor that saves a Builder's insertion point without changing the
+  /// builder's underlying insertion point.
+  SavedInsertionPointRAII(IRBuilder &inputBuilder)
+      : builder(inputBuilder), savedInsertionPoint() {
+    // If our builder does not have a valid insertion point, just put nullptr
+    // into SavedIP.
+    if (!builder.hasValidIP()) {
+      savedInsertionPoint = static_cast<llvm::BasicBlock *>(nullptr);
+      return;
+    }
+
+    // If we are inserting into the end of the block, stash the insertion block.
+    if (builder.insertingAtEndOfBlock()) {
+      savedInsertionPoint = builder.GetInsertBlock();
+      return;
+    }
+
+    // Otherwise, stash the instruction.
+    auto *i = &*builder.GetInsertPoint();
+    savedInsertionPoint = i;
+  }
+
+  SavedInsertionPointRAII(IRBuilder &b, llvm::Instruction *newInsertionPoint)
+      : SavedInsertionPointRAII(b) {
+    builder.SetInsertPoint(newInsertionPoint);
+  }
+
+  SavedInsertionPointRAII(IRBuilder &b, llvm::BasicBlock *block,
+                          llvm::BasicBlock::iterator iter)
+      : SavedInsertionPointRAII(b) {
+    builder.SetInsertPoint(block, iter);
+  }
+
+  SavedInsertionPointRAII(IRBuilder &b, llvm::BasicBlock *insertionBlock)
+      : SavedInsertionPointRAII(b) {
+    builder.SetInsertPoint(insertionBlock);
+  }
+
+  SavedInsertionPointRAII(const SavedInsertionPointRAII &) = delete;
+  SavedInsertionPointRAII &operator=(const SavedInsertionPointRAII &) = delete;
+  SavedInsertionPointRAII(SavedInsertionPointRAII &&) = delete;
+  SavedInsertionPointRAII &operator=(SavedInsertionPointRAII &&) = delete;
+
+  ~SavedInsertionPointRAII() {
+    if (savedInsertionPoint.isNull()) {
+      builder.ClearInsertionPoint();
+    } else if (savedInsertionPoint.is<llvm::Instruction *>()) {
+      builder.SetInsertPoint(savedInsertionPoint.get<llvm::Instruction *>());
+    } else {
+      builder.SetInsertPoint(savedInsertionPoint.get<llvm::BasicBlock *>());
+    }
+  }
 };
 
 } // end namespace irgen