Don’t include <vector> in IDEBridging.h

Author: ahoppen

include/swift/IDE/IDEBridging.h

@@ -14,10 +14,13 @@
 #define SWIFT_IDE_IDEBRIDGING
 
 #include "swift/Basic/BasicBridging.h"
+
+#ifdef USED_IN_CPP_SOURCE
 #include "swift/Basic/SourceLoc.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/CAS/CASReference.h"
 #include <vector>
+#endif
 
 enum class LabelRangeType {
   None,
@@ -37,6 +40,7 @@ enum class LabelRangeType {
 
 enum class ResolvedLocContext { Default, Selector, Comment, StringLiteral };
 
+#ifdef USED_IN_CPP_SOURCE
 struct ResolvedLoc {
   /// The range of the call's base name.
   swift::CharSourceRange range;
@@ -65,13 +69,6 @@ struct ResolvedLoc {
 
   ResolvedLocContext context;
 
-  SWIFT_NAME(
-      "init(range:labelRanges:firstTrailingLabel:labelType:isActive:context:)")
-  ResolvedLoc(BridgedCharSourceRange range,
-              BridgedCharSourceRangeVector labelRanges,
-              unsigned firstTrailingLabel, LabelRangeType labelType,
-              bool isActive, ResolvedLocContext context);
-
   ResolvedLoc(swift::CharSourceRange range,
               std::vector<swift::CharSourceRange> labelRanges,
               llvm::Optional<unsigned> firstTrailingLabel,
@@ -81,60 +78,68 @@ struct ResolvedLoc {
   ResolvedLoc();
 };
 
+#endif // USED_IN_CPP_SOURCE
+
+/// An opaque, heap-allocated `ResolvedLoc`.
+///
+/// This type is manually memory managed. The creator of the object needs to
+/// ensure that `takeUnbridged` is called to free the memory.
+struct BridgedResolvedLoc {
+  /// Opaque pointer to `ResolvedLoc`.
+  void *resolvedLoc;
+
+  /// This consumes `labelRanges` by calling `takeUnbridged` on it.
+  SWIFT_NAME(
+      "init(range:labelRanges:firstTrailingLabel:labelType:isActive:context:)")
+  BridgedResolvedLoc(BridgedCharSourceRange range,
+                     BridgedCharSourceRangeVector labelRanges,
+                     unsigned firstTrailingLabel, LabelRangeType labelType,
+                     bool isActive, ResolvedLocContext context);
+
+#ifdef USED_IN_CPP_SOURCE
+  ResolvedLoc takeUnbridged() {
+    ResolvedLoc *resolvedLocPtr = static_cast<ResolvedLoc *>(resolvedLoc);
+    ResolvedLoc unbridged = *resolvedLocPtr;
+    delete resolvedLocPtr;
+    return unbridged;
+  }
+#endif
+};
+
 /// A heap-allocated `std::vector<ResoledLoc>` that can be represented by an
 /// opaque pointer value.
 ///
-/// This allows us to perform all the memory management for the heap-allocated
-/// vector in C++. This makes it easier to manage because creating and
-/// destorying an object in C++ is consistent with whether elements within the
-/// vector are destroyed as well.
-///
-/// - Note: This should no longer be necessary when we use C++ to Swift interop.
-///   In that case `swift_SwiftIDEUtilsBridging_runNameMatcher` can return a
-///   `ResolvedLocVector`.
+/// This type is manually memory managed. The creator of the object needs to
+/// ensure that `takeUnbridged` is called to free the memory.
 class BridgedResolvedLocVector {
-  friend void *BridgedResolvedLocVector_getOpaqueValue(const BridgedResolvedLocVector &vector);
-
-  std::vector<ResolvedLoc> *vector;
+  /// Opaque pointer to `std::vector<ResolvedLoc>`
+  void *vector;
 
 public:
-  /// Create heap-allocaed vector with the same elements as `vector`.
-  BridgedResolvedLocVector(const std::vector<ResolvedLoc> &vector);
+  BridgedResolvedLocVector();
 
   /// Create a `BridgedResolvedLocVector` from an opaque value obtained from
   /// `getOpaqueValue`.
   BridgedResolvedLocVector(void *opaqueValue);
 
-  void push_back(const ResolvedLoc &Loc);
-
-  /// Get the underlying vector.
-  const std::vector<ResolvedLoc> &unbridged();
-
-  /// Delete the heap-allocated memory owned by this object. Accessing
-  /// `unbridged` is illegal after calling `destroy`.
-  void destroy();
+  /// This consumes `Loc`, calling `takeUnbridged` on it.
+  SWIFT_NAME("append(_:)")
+  void push_back(BridgedResolvedLoc Loc);
+
+#ifdef USED_IN_CPP_SOURCE
+  std::vector<ResolvedLoc> takeUnbridged() {
+    std::vector<ResolvedLoc> *vectorPtr =
+        static_cast<std::vector<ResolvedLoc> *>(vector);
+    std::vector<ResolvedLoc> unbridged = *vectorPtr;
+    delete vectorPtr;
+    return unbridged;
+  }
+#endif
 
   SWIFT_IMPORT_UNSAFE
   void *getOpaqueValue() const;
 };
 
-
-SWIFT_NAME("BridgedResolvedLocVector.empty()")
-BridgedResolvedLocVector BridgedResolvedLocVector_createEmpty();
-
-typedef std::vector<BridgedSourceLoc> SourceLocVector;
-
-/// Needed so that we can manually conform `SourceLocVectorIterator` to
-/// `UnsafeCxxInputIterator` on the Swift side because the conformance is not
-/// automatically generated by C++ interop by a Swift 5.8 compiler.
-typedef std::vector<BridgedSourceLoc>::const_iterator SourceLocVectorIterator;
-
-SWIFT_NAME("SourceLocVectorIterator.equals(_:_:)")
-inline bool SourceLocVectorIterator_equal(const SourceLocVectorIterator &lhs,
-                                          const SourceLocVectorIterator &rhs) {
-  return lhs == rhs;
-}
-
 #ifdef __cplusplus
 extern "C" {
 #endif

lib/ASTGen/Sources/SwiftIDEUtilsBridging/NameMatcherBridging.swift

@@ -37,9 +37,9 @@ fileprivate extension BridgedCharSourceRangeVector {
 
 fileprivate extension BridgedResolvedLocVector {
   init(from resolvedLocs: some Sequence<DeclNameLocation>, in sourceFile: ExportedSourceFile) {
-    self = .empty()
+    self = .init()
     for resolvedLoc in resolvedLocs {
-      self.push_back(IDEBridging.ResolvedLoc(from: resolvedLoc, in: sourceFile))
+      self.append(BridgedResolvedLoc(from: resolvedLoc, in: sourceFile))
     }
   }
 }
@@ -56,7 +56,7 @@ fileprivate extension IDEBridging.LabelRangeType {
   }
 }
 
-extension IDEBridging.ResolvedLoc {
+extension BridgedResolvedLoc {
   init(from resolvedLoc: DeclNameLocation, in sourceFile: ExportedSourceFile) {
     let firstTrailingClosureIndex: UInt32
     if case .call(_, .some(let index)) = resolvedLoc.arguments {

lib/IDE/IDEBridging.cpp

@@ -14,16 +14,6 @@
 #include "llvm/Support/raw_ostream.h"
 #include <climits>
 
-ResolvedLoc::ResolvedLoc(BridgedCharSourceRange range,
-                         BridgedCharSourceRangeVector labelRanges,
-                         unsigned firstTrailingLabel, LabelRangeType labelType,
-                         bool isActive, ResolvedLocContext context)
-    : range(range.unbridged()), labelRanges(labelRanges.takeUnbridged()),
-      firstTrailingLabel(firstTrailingLabel == UINT_MAX
-                             ? llvm::None
-                             : llvm::Optional<unsigned>(firstTrailingLabel)),
-      labelType(labelType), isActive(isActive), context(context) {}
-
 ResolvedLoc::ResolvedLoc(swift::CharSourceRange range,
                          std::vector<swift::CharSourceRange> labelRanges,
                          llvm::Optional<unsigned> firstTrailingLabel,
@@ -35,27 +25,27 @@ ResolvedLoc::ResolvedLoc(swift::CharSourceRange range,
 
 ResolvedLoc::ResolvedLoc() {}
 
-BridgedResolvedLocVector BridgedResolvedLocVector_createEmpty() {
-  return BridgedResolvedLocVector(new std::vector<ResolvedLoc>());
-}
-
-void BridgedResolvedLocVector::push_back(const ResolvedLoc &Loc) {
-  this->vector->push_back(Loc);
+BridgedResolvedLoc::BridgedResolvedLoc(BridgedCharSourceRange range,
+                                       BridgedCharSourceRangeVector labelRanges,
+                                       unsigned firstTrailingLabel,
+                                       LabelRangeType labelType, bool isActive,
+                                       ResolvedLocContext context)
+    : resolvedLoc(
+          new ResolvedLoc(range.unbridged(), labelRanges.takeUnbridged(),
+                          firstTrailingLabel == UINT_MAX
+                              ? llvm::None
+                              : llvm::Optional<unsigned>(firstTrailingLabel),
+                          labelType, isActive, context)) {}
+
+BridgedResolvedLocVector::BridgedResolvedLocVector()
+    : vector(new std::vector<BridgedResolvedLoc>()) {}
+
+void BridgedResolvedLocVector::push_back(BridgedResolvedLoc Loc) {
+  static_cast<std::vector<ResolvedLoc> *>(vector)->push_back(
+      Loc.takeUnbridged());
 }
 
-BridgedResolvedLocVector::BridgedResolvedLocVector(
-    const std::vector<ResolvedLoc> &vector)
-    : vector(new std::vector<ResolvedLoc>(vector)) {}
-
 BridgedResolvedLocVector::BridgedResolvedLocVector(void *opaqueValue)
-    : vector(static_cast<std::vector<ResolvedLoc> *>(opaqueValue)) {}
+    : vector(opaqueValue) {}
 
-const std::vector<ResolvedLoc> &BridgedResolvedLocVector::unbridged() {
-  return *vector;
-}
-
-void BridgedResolvedLocVector::destroy() { delete vector; }
-
-void *BridgedResolvedLocVector::getOpaqueValue() const {
-  return static_cast<void *>(this->vector);
-}
+void *BridgedResolvedLocVector::getOpaqueValue() const { return vector; }

lib/Refactoring/SyntacticRename.cpp

@@ -81,9 +81,8 @@ swift::ide::resolveRenameLocations(ArrayRef<RenameLoc> RenameLocs,
       swift_SwiftIDEUtilsBridging_runNameMatcher(SF.getExportedSourceFile(),
                                                  BridgedUnresolvedLocs.data(),
                                                  BridgedUnresolvedLocs.size());
-  SWIFT_DEFER { bridgedResolvedLocs.destroy(); };
   const std::vector<ResolvedLoc> &resolvedLocsInSourceOrder =
-      bridgedResolvedLocs.unbridged();
+      bridgedResolvedLocs.takeUnbridged();
 
   // Callers expect the resolved locs in the same order as the unresolved locs.
   // Sort them.