Bridging: Rename USED_IN_CPP_SOURCE and define it in Basic/SwiftBridging.h

AnthonyLatsis · AnthonyLatsis · commit b8038612574c · 2025-07-10T17:58:13.000+01:00
diff --git a/include/swift/AST/ASTBridging.h b/include/swift/AST/ASTBridging.h
@@ -29,7 +29,7 @@
 #include "swift/AST/PlatformKind.h"
 #include "swift/Basic/BasicBridging.h"
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
 #include "swift/AST/Attr.h"
 #include "swift/AST/Decl.h"
 #endif
@@ -379,7 +379,7 @@ struct OptionalBridgedDeclObj {
 
   OptionalBridgedDeclObj(OptionalSwiftObject obj) : obj(obj) {}
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
   template <class D> D *_Nullable getAs() const {
     if (obj)
       return llvm::cast<D>(static_cast<swift::Decl *>(obj));
@@ -391,7 +391,7 @@ struct OptionalBridgedDeclObj {
 struct BridgedDeclObj {
   SwiftObject obj;
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
   template <class D> D *_Nonnull getAs() const {
     return llvm::cast<D>(static_cast<swift::Decl *>(obj));
   }
diff --git a/include/swift/Basic/BasicBridging.h b/include/swift/Basic/BasicBridging.h
@@ -13,36 +13,26 @@
 #ifndef SWIFT_BASIC_BASICBRIDGING_H
 #define SWIFT_BASIC_BASICBRIDGING_H
 
-#if !defined(COMPILED_WITH_SWIFT) || !defined(PURE_BRIDGING_MODE)
-#define USED_IN_CPP_SOURCE
-#endif
-
 // Do not add other C++/llvm/swift header files here!
 // Function implementations should be placed into BasicBridging.cpp and required header files should be added there.
 //
 // Pure bridging mode does not permit including any C++/llvm/swift headers.
 // See also the comments for `BRIDGING_MODE` in the top-level CMakeLists.txt file.
 //
-//
-// Note: On Windows ARM64, how a C++ struct/class value type is
-// returned is sensitive to conditions including whether a
-// user-defined constructor exists, etc. See
-// https://learn.microsoft.com/en-us/cpp/build/arm64-windows-abi-conventions?view=msvc-170#return-values
-// So, if a C++ struct/class type is returned as a value between Swift
-// and C++, we need to be careful to match the return convention
-// matches between the non-USED_IN_CPP_SOURCE (Swift) side and the
-// USE_IN_CPP_SOURCE (C++) side.
-//
 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-// !! Do not put any constructors inside an `#ifdef USED_IN_CPP_SOURCE` block !!
+// !! Do not put any constructors inside an                                   !!
+// !! `#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE` block               !!
 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
-#include "swift/Basic/BridgedSwiftObject.h"
+/// This header defines `NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE`, so it
+/// needs to be imported before the first use of the macro.
 #include "swift/Basic/SwiftBridging.h"
 
+#include "swift/Basic/BridgedSwiftObject.h"
 #include <stddef.h>
 #include <stdint.h>
-#ifdef USED_IN_CPP_SOURCE
+
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
 // Workaround to avoid a compiler error because `cas::ObjectRef` is not defined
 // when including VirtualFileSystem.h
 #include <cassert>
@@ -146,7 +136,7 @@ class BridgedArrayRef {
   BridgedArrayRef(const void *_Nullable data, size_t length)
       : Data(data), Length(length) {}
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
   template <typename T>
   BridgedArrayRef(llvm::ArrayRef<T> arr)
       : Data(arr.data()), Length(arr.size()) {}
@@ -285,7 +275,7 @@ class BridgedOwnedString {
   };
 BRIDGED_OPTIONAL(SwiftInt, Int)
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
 inline BridgedOptionalInt getFromAPInt(llvm::APInt i) {
   if (i.getSignificantBits() <=
       std::min(std::numeric_limits<SwiftInt>::digits, 64)) {
@@ -421,7 +411,7 @@ class BridgedCharSourceRangeVector {
   SWIFT_NAME("append(_:)")
   void push_back(BridgedCharSourceRange range);
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
   /// Returns the `std::vector<swift::CharSourceRange>` that this
   /// `BridgedCharSourceRangeVector` represents and frees the memory owned by
   /// this `BridgedCharSourceRangeVector`.
diff --git a/include/swift/Basic/SwiftBridging.h b/include/swift/Basic/SwiftBridging.h
@@ -96,5 +96,27 @@
 #define SWIFT_UNAVAILABLE(msg)
 #endif
 
+#if !(defined(COMPILED_WITH_SWIFT) && defined(PURE_BRIDGING_MODE))
+/// Use this macro in a `#ifdef`/`#endif` fashion to wrap code that should not
+/// be imported into Swift in pure bridging mode, e.g. because an API is
+/// irrelevant on the Swift side, or because it requires std/llvm headers, which
+/// we don't want to import in this mode.
+///
+/// - Important: Do not put a constructor inside a
+/// `NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE` block unless there already is
+/// another unconditionally available user-defined constructor!
+///
+/// Note: On Windows ARM64, how a C++ struct/class value type is
+/// returned is sensitive to conditions including whether a
+/// user-defined constructor exists, etc. See
+/// https://learn.microsoft.com/en-us/cpp/build/arm64-windows-abi-conventions?view=msvc-170#return-values
+///
+/// So, if a C++ struct/class type is returned as a value between Swift
+/// and C++, we need to be careful to match the return convention
+/// matches between the `NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE` (C++) side
+/// and the non-`NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE` (Swift) side.
+#define NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
+#endif
+
 #endif // SWIFT_BASIC_SWIFT_BRIDGING_H
 
diff --git a/include/swift/IDE/IDEBridging.h b/include/swift/IDE/IDEBridging.h
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2022 - 2023 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
@@ -15,8 +15,7 @@
 
 #include "swift/Basic/BasicBridging.h"
 
-#ifdef USED_IN_CPP_SOURCE
-#include "swift/Basic/SourceLoc.h"
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
 #include "llvm/CAS/CASReference.h"
 #include <optional>
 #include <vector>
@@ -66,7 +65,7 @@ enum class LabelRangeType {
 
 enum class ResolvedLocContext { Default, Selector, Comment, StringLiteral };
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
 struct ResolvedLoc {
   /// The range of the call's base name.
   swift::CharSourceRange range;
@@ -105,7 +104,7 @@ struct ResolvedLoc {
   ResolvedLoc();
 };
 
-#endif // USED_IN_CPP_SOURCE
+#endif // #ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
 
 /// An opaque, heap-allocated `ResolvedLoc`.
 ///
@@ -123,7 +122,7 @@ struct BridgedResolvedLoc {
                      unsigned firstTrailingLabel, LabelRangeType labelType,
                      bool isActive, ResolvedLocContext context);
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
   ResolvedLoc takeUnbridged() {
     ResolvedLoc *resolvedLocPtr = static_cast<ResolvedLoc *>(resolvedLoc);
     ResolvedLoc unbridged = *resolvedLocPtr;
@@ -153,7 +152,7 @@ class BridgedResolvedLocVector {
   SWIFT_NAME("append(_:)")
   void push_back(BridgedResolvedLoc Loc);
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
   std::vector<ResolvedLoc> takeUnbridged() {
     std::vector<ResolvedLoc> *vectorPtr =
         static_cast<std::vector<ResolvedLoc> *>(vector);
diff --git a/include/swift/SIL/SILBridging.h b/include/swift/SIL/SILBridging.h
@@ -22,7 +22,7 @@
 //
 #include "swift/AST/ASTBridging.h"
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
 #include "llvm/ADT/ArrayRef.h"
 #include "swift/SIL/SILInstruction.h"
 #include "swift/SIL/SILWitnessTable.h"
@@ -329,7 +329,7 @@ struct BridgedValueArray {
   const BridgeValueExistential * _Nullable base;
   size_t count;
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
   llvm::ArrayRef<swift::SILValue> getValues(llvm::SmallVectorImpl<swift::SILValue> &storage);
 #endif
 };
@@ -639,7 +639,7 @@ struct BridgedSILDebugVariable {
 struct BridgedInstruction {
   SwiftObject obj;
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
   template <class I> I *_Nonnull getAs() const {
     return llvm::cast<I>(static_cast<swift::SILNode *>(obj)->castToInstruction());
   }
@@ -1068,7 +1068,7 @@ struct BridgedWitnessTableEntry {
     baseProtocol
   };
 
-#ifdef USED_IN_CPP_SOURCE
+#ifdef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
   static BridgedWitnessTableEntry bridge(const swift::SILWitnessTable::Entry &entry) {
     BridgedWitnessTableEntry bridgedEntry;
     *reinterpret_cast<swift::SILWitnessTable::Entry *>(&bridgedEntry.storage) = entry;
diff --git a/include/swift/SILOptimizer/OptimizerBridging.h b/include/swift/SILOptimizer/OptimizerBridging.h
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 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
@@ -23,7 +23,7 @@
 #include "swift/AST/ASTBridging.h"
 #include "swift/SIL/SILBridging.h"
 
-#ifndef USED_IN_CPP_SOURCE
+#ifndef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
 
 // Pure bridging mode does not permit including any C++/llvm/swift headers.
 // See also the comments for `BRIDGING_MODE` in the top-level CMakeLists.txt file.
@@ -34,7 +34,7 @@
 #error "should not include llvm headers into bridging header"
 #endif
 
-#endif // USED_IN_CPP_SOURCE
+#endif // #ifndef NOT_COMPILED_WITH_SWIFT_PURE_BRIDGING_MODE
 
 SWIFT_BEGIN_NULLABILITY_ANNOTATIONS
 
