Bridging: Bridge swift::SourceLoc directly

Author: AnthonyLatsis

SwiftCompilerSources/Sources/AST/DiagnosticEngine.swift

@@ -78,15 +78,14 @@ public struct DiagnosticEngine {
                        at position: SourceLoc?,
                        highlight: CharSourceRange? = nil,
                        fixIts: [DiagnosticFixIt] = []) {
-
-    let bridgedSourceLoc: BridgedSourceLoc = position.bridged
-    let highlightStart: BridgedSourceLoc
+    let bridgedSourceLoc = position.bridgedLocation
+    let highlightStart: swift.SourceLoc
     let highlightLength: UInt32
     if let highlight = highlight {
       highlightStart = highlight.start.bridged
       highlightLength = highlight.byteLength
     } else {
-      highlightStart = BridgedSourceLoc()
+      highlightStart = .init()
       highlightLength = 0
     }
     var bridgedArgs: [BridgedDiagnosticArgument] = []

SwiftCompilerSources/Sources/Basic/SourceLoc.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2022 Apple Inc. and the Swift project authors
+// Copyright (c) 2022 - 2025 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -17,24 +17,20 @@ import BasicBridging
 /// In contrast to just having a filename+line+column, this allows displaying the context around
 /// the location when printing diagnostics.
 public struct SourceLoc {
-  public let bridged: BridgedSourceLoc
+  public let bridged: swift.SourceLoc
 
-  public init?(bridged: BridgedSourceLoc) {
-    guard bridged.isValid else {
+  public init?(bridged: swift.SourceLoc) {
+    guard bridged.isValid() else {
       return nil
     }
     self.bridged = bridged
   }
 }
 
-extension SourceLoc {
-  public func advanced(by n: Int) -> SourceLoc {
-    SourceLoc(bridged: bridged.advanced(by: n))!
-  }
-}
-
-extension Optional where Wrapped == SourceLoc {
-  public var bridged: BridgedSourceLoc {
+extension Optional<SourceLoc> {
+  // TODO: This can go back to being 'bridged' once we upgrade to a toolchain
+  // where https://github.com/swiftlang/swift/issues/82609 is fixed.
+  public var bridgedLocation: swift.SourceLoc {
     self?.bridged ?? .init()
   }
 }
@@ -48,7 +44,7 @@ public struct CharSourceRange {
     self.byteLength = byteLength
   }
 
-  public init?(bridgedStart: BridgedSourceLoc, byteLength: UInt32) {
+  public init?(bridgedStart: swift.SourceLoc, byteLength: UInt32) {
     guard let start = SourceLoc(bridged: bridgedStart) else {
       return nil
     }

include/swift/AST/ASTBridging.h

@@ -38,7 +38,7 @@ SWIFT_BEGIN_NULLABILITY_ANNOTATIONS
 
 BridgedConsumedLookupResult::BridgedConsumedLookupResult(
     swift::Identifier name, swift::SourceLoc sourceLoc, SwiftInt flag)
-    : Name(name), NameLoc(BridgedSourceLoc(sourceLoc)), Flag(flag) {}
+    : Name(name), NameLoc(swift::SourceLoc(sourceLoc)), Flag(flag) {}
 
 //===----------------------------------------------------------------------===//
 // MARK: BridgedDeclNameRef
@@ -141,9 +141,8 @@ bool BridgedSourceFile_isScriptMode(BridgedSourceFile sf) {
 // MARK: BridgedDeclObj
 //===----------------------------------------------------------------------===//
 
-BridgedSourceLoc BridgedDeclObj::getLoc() const {
-  swift::SourceLoc sourceLoc = unbridged()->getLoc();
-  return BridgedSourceLoc(sourceLoc.getOpaquePointerValue());
+swift::SourceLoc BridgedDeclObj::getLoc() const {
+  return unbridged()->getLoc();
 }
 
 BridgedDeclObj BridgedDeclObj::getModuleContext() const {
@@ -162,8 +161,8 @@ BridgedStringRef BridgedDeclObj::Value_getUserFacingName() const {
   return getAs<swift::ValueDecl>()->getBaseName().userFacingName();
 }
 
-BridgedSourceLoc BridgedDeclObj::Value_getNameLoc() const {
-  return BridgedSourceLoc(getAs<swift::ValueDecl>()->getNameLoc().getOpaquePointerValue());
+swift::SourceLoc BridgedDeclObj::Value_getNameLoc() const {
+  return getAs<swift::ValueDecl>()->getNameLoc();
 }
 
 bool BridgedDeclObj::hasClangNode() const {
@@ -360,15 +359,15 @@ BridgedVarDecl_asAbstractStorageDecl(BridgedVarDecl decl) {
 //===----------------------------------------------------------------------===//
 
 swift::Argument BridgedCallArgument::unbridged() const {
-  return swift::Argument(labelLoc.unbridged(), label, argExpr.unbridged());
+  return swift::Argument(labelLoc, label, argExpr.unbridged());
 }
 
 //===----------------------------------------------------------------------===//
 // MARK: BridgedLabeledStmtInfo
 //===----------------------------------------------------------------------===//
 
 swift::LabeledStmtInfo BridgedLabeledStmtInfo::unbridged() const {
-  return {Name, Loc.unbridged()};
+  return {Name, Loc};
 }
 
 //===----------------------------------------------------------------------===//
@@ -845,9 +844,7 @@ swift::IfConfigClauseRangeInfo BridgedIfConfigClauseRangeInfo::unbridged() const
     break;
   }
 
-  return swift::IfConfigClauseRangeInfo(directiveLoc.unbridged(),
-                                        bodyLoc.unbridged(),
-                                        endLoc.unbridged(),
+  return swift::IfConfigClauseRangeInfo(directiveLoc, bodyLoc, endLoc,
                                         clauseKind);
 }
 
@@ -916,13 +913,13 @@ BridgedVarDecl BridgedCaptureListEntry::getVarDecl() const {
 //===----------------------------------------------------------------------===//
 
 void BridgedFloatLiteralExpr_setNegative(BridgedFloatLiteralExpr cExpr,
-                                         BridgedSourceLoc cLoc) {
-  cExpr.unbridged()->setNegative(cLoc.unbridged());
+                                         swift::SourceLoc loc) {
+  cExpr.unbridged()->setNegative(loc);
 }
 
 void BridgedIntegerLiteralExpr_setNegative(BridgedIntegerLiteralExpr cExpr,
-                                           BridgedSourceLoc cLoc) {
-  cExpr.unbridged()->setNegative(cLoc.unbridged());
+                                           swift::SourceLoc loc) {
+  cExpr.unbridged()->setNegative(loc);
 }
 
 //===----------------------------------------------------------------------===//

include/swift/AST/ASTBridgingImpl.h

@@ -31,6 +31,7 @@
 #include "swift/Basic/SwiftBridging.h"
 
 #include "swift/Basic/BridgedSwiftObject.h"
+#include "swift/Basic/SourceLoc.h"
 #include <stddef.h>
 #include <stdint.h>
 
@@ -40,7 +41,6 @@
 #include <cassert>
 #include "llvm/CAS/CASReference.h"
 
-#include "swift/Basic/SourceLoc.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/ADT/APInt.h"
 #include <string>
@@ -317,50 +317,22 @@ class BridgedOStream {
 
 BridgedOStream Bridged_dbgs();
 
-//===----------------------------------------------------------------------===//
-// MARK: SourceLoc
-//===----------------------------------------------------------------------===//
-
-class BridgedSourceLoc {
-  const void *_Nullable Raw;
-
-public:
-  BridgedSourceLoc() : Raw(nullptr) {}
-
-  SWIFT_NAME("init(raw:)")
-  BridgedSourceLoc(const void *_Nullable raw) : Raw(raw) {}
-
-  BRIDGED_INLINE BridgedSourceLoc(swift::SourceLoc loc);
-
-  BRIDGED_INLINE swift::SourceLoc unbridged() const;
-
-  SWIFT_IMPORT_UNSAFE
-  const void *_Nullable getOpaquePointerValue() const { return Raw; }
-
-  SWIFT_COMPUTED_PROPERTY
-  bool getIsValid() const { return Raw != nullptr; }
-
-  SWIFT_NAME("advanced(by:)")
-  BRIDGED_INLINE
-  BridgedSourceLoc advancedBy(size_t n) const;
-};
-
 //===----------------------------------------------------------------------===//
 // MARK: SourceRange
 //===----------------------------------------------------------------------===//
 
 class BridgedSourceRange {
 public:
   SWIFT_NAME("start")
-  BridgedSourceLoc Start;
+  swift::SourceLoc Start;
 
   SWIFT_NAME("end")
-  BridgedSourceLoc End;
+  swift::SourceLoc End;
 
   BridgedSourceRange() : Start(), End() {}
 
   SWIFT_NAME("init(start:end:)")
-  BridgedSourceRange(BridgedSourceLoc start, BridgedSourceLoc end)
+  BridgedSourceRange(swift::SourceLoc start, swift::SourceLoc end)
       : Start(start), End(end) {}
 
   BRIDGED_INLINE BridgedSourceRange(swift::SourceRange range);
@@ -375,21 +347,21 @@ class BridgedSourceRange {
 class BridgedCharSourceRange {
 public:
   SWIFT_UNAVAILABLE("Use '.start' instead")
-  BridgedSourceLoc Start;
+  swift::SourceLoc Start;
 
   SWIFT_UNAVAILABLE("Use '.byteLength' instead")
   unsigned ByteLength;
 
   SWIFT_NAME("init(start:byteLength:)")
-  BridgedCharSourceRange(BridgedSourceLoc start, unsigned byteLength)
+  BridgedCharSourceRange(swift::SourceLoc start, unsigned byteLength)
       : Start(start), ByteLength(byteLength) {}
 
   BRIDGED_INLINE BridgedCharSourceRange(swift::CharSourceRange range);
 
   BRIDGED_INLINE swift::CharSourceRange unbridged() const;
 
   SWIFT_COMPUTED_PROPERTY
-  BridgedSourceLoc getStart() const { return Start; }
+  swift::SourceLoc getStart() const { return Start; }
 
   SWIFT_COMPUTED_PROPERTY
   SwiftInt getByteLength() const { return static_cast<SwiftInt>(ByteLength); }

include/swift/Basic/BasicBridging.h

@@ -38,21 +38,6 @@ llvm::StringRef BridgedStringRef::unbridged() const {
 
 llvm::StringRef BridgedOwnedString::unbridgedRef() const { return llvm::StringRef(Data, Length); }
 
-//===----------------------------------------------------------------------===//
-// MARK: BridgedSourceLoc
-//===----------------------------------------------------------------------===//
-
-BridgedSourceLoc::BridgedSourceLoc(swift::SourceLoc loc)
-  : Raw(loc.getOpaquePointerValue()) {}
-
-swift::SourceLoc BridgedSourceLoc::unbridged() const {
-  return swift::SourceLoc::getFromPointer(static_cast<const char *>(Raw));
-}
-
-BridgedSourceLoc BridgedSourceLoc::advancedBy(size_t n) const {
-  return BridgedSourceLoc(unbridged().getAdvancedLoc(n));
-}
-
 //===----------------------------------------------------------------------===//
 // MARK: BridgedSourceRange
 //===----------------------------------------------------------------------===//
@@ -61,7 +46,7 @@ BridgedSourceRange::BridgedSourceRange(swift::SourceRange range)
     : Start(range.Start), End(range.End) {}
 
 swift::SourceRange BridgedSourceRange::unbridged() const {
-  return swift::SourceRange(Start.unbridged(), End.unbridged());
+  return swift::SourceRange(Start, End);
 }
 
 //===----------------------------------------------------------------------===//
@@ -72,7 +57,7 @@ BridgedCharSourceRange::BridgedCharSourceRange(swift::CharSourceRange range)
     : Start(range.getStart()), ByteLength(range.getByteLength()) {}
 
 swift::CharSourceRange BridgedCharSourceRange::unbridged() const {
-  return swift::CharSourceRange(Start.unbridged(), ByteLength);
+  return swift::CharSourceRange(Start, ByteLength);
 }
 
 //===----------------------------------------------------------------------===//