AST: Introduce Decl::isUnavailable().

tshortli · tshortli · commit 1dc7aa5b7be1 · 2024-12-02T07:35:58.000-08:00
Replace calls to `AvailableAttr::isUnavailable()` with `Decl::isUnavailable()`.
diff --git a/include/swift/AST/Decl.h b/include/swift/AST/Decl.h
@@ -1378,16 +1378,29 @@ class alignas(1 << DeclAlignInBits) Decl : public ASTAllocated<Decl>, public Swi
   /// @_originalDefinedIn attribute, this function returns this module name.
   StringRef getAlternateModuleName() const;
 
-  // Is this Decl an SPI? It can be directly marked with @_spi or is defined in
-  // an @_spi context.
+  /// Is this Decl an SPI? It can be directly marked with @_spi or is defined in
+  /// an @_spi context.
   bool isSPI() const;
 
+  /// Returns true if the attribute providing the platform availability
+  /// introduction for this decl is an `@_spi_available` attribute.
   bool isAvailableAsSPI() const;
 
   /// Determine whether this Decl has either Private or FilePrivate access,
   /// and its DeclContext does not.
   bool isOutermostPrivateOrFilePrivateScope() const;
 
+  /// Returns true if the decl is always unavailable in this compilation
+  /// context. For example, the decl could be marked explicitly unavailable on
+  /// either the current platform or in the current language mode. Returns false
+  /// for declarations that are only _potentially_ unavailable because of a
+  /// condition that could be satisfied at runtime (like requiring an operating
+  /// system version that is higher than the current deployment target).
+  ///
+  /// Note that this query only considers the attributes that are attached
+  /// directly to this decl (or the extension it is declared in, if applicable).
+  bool isUnavailable() const;
+
   /// Retrieve the @available attribute that provides the OS version range that
   /// this declaration is available in.
   ///
@@ -1406,7 +1419,7 @@ class alignas(1 << DeclAlignInBits) Decl : public ASTAllocated<Decl>, public Swi
   /// the attribute.
   ///
   /// Note that this notion of unavailability is broader than that which is
-  /// checked by \c AvailableAttr::isUnavailable.
+  /// checked by \c isUnavailable().
   std::optional<std::pair<const AvailableAttr *, const Decl *>>
   getSemanticUnavailableAttr(bool ignoreAppExtensions = false) const;
 
diff --git a/lib/APIDigester/ModuleAnalyzerNodes.cpp b/lib/APIDigester/ModuleAnalyzerNodes.cpp
@@ -1767,8 +1767,8 @@ SDKContext::shouldIgnore(Decl *D, const Decl* Parent) const {
     if (D->isPrivateSystemDecl(false))
       return true;
   }
-  if (AvailableAttr::isUnavailable(D))
-     return true;
+  if (D->isUnavailable())
+    return true;
   if (auto VD = dyn_cast<ValueDecl>(D)) {
     switch (getAccessLevel(VD)) {
     case AccessLevel::Internal:
diff --git a/lib/AST/Availability.cpp b/lib/AST/Availability.cpp
@@ -486,6 +486,8 @@ bool Decl::isAvailableAsSPI() const {
   return AvailabilityInference::isAvailableAsSPI(this);
 }
 
+bool Decl::isUnavailable() const { return AvailableAttr::isUnavailable(this); }
+
 std::optional<AvailableAttrDeclPair>
 SemanticUnavailableAttrRequest::evaluate(Evaluator &evaluator, const Decl *decl,
                                          bool ignoreAppExtensions) const {
diff --git a/lib/AST/Decl.cpp b/lib/AST/Decl.cpp
@@ -4377,7 +4377,7 @@ bool ValueDecl::shouldHideFromEditor() const {
       getAttrs().hasAttribute<ShowInInterfaceAttr>())
     return true;
 
-  if (AvailableAttr::isUnavailable(this))
+  if (isUnavailable())
     return true;
 
   // Hide 'swift_private' clang decls. They are imported with '__' prefix.
diff --git a/lib/AST/DeclContext.cpp b/lib/AST/DeclContext.cpp
@@ -1534,7 +1534,7 @@ bool DeclContext::isAlwaysAvailableConformanceContext() const {
   if (ext == nullptr)
     return true;
 
-  if (AvailableAttr::isUnavailable(ext))
+  if (ext->isUnavailable())
     return false;
 
   auto &ctx = getASTContext();
diff --git a/lib/AST/ProtocolConformanceRef.cpp b/lib/AST/ProtocolConformanceRef.cpp
@@ -335,7 +335,7 @@ bool ProtocolConformanceRef::hasUnavailableConformance() const {
   auto concrete = getConcrete();
   auto *dc = concrete->getRootConformance()->getDeclContext();
   auto ext = dyn_cast<ExtensionDecl>(dc);
-  if (ext && AvailableAttr::isUnavailable(ext))
+  if (ext && ext->isUnavailable())
     return true;
 
   // Check the conformances in the substitution map.
diff --git a/lib/Index/Index.cpp b/lib/Index/Index.cpp
@@ -617,7 +617,7 @@ class IndexSwiftASTWalker : public SourceEntityWalker {
 
   bool walkToDeclPre(Decl *D, CharSourceRange Range) override {
     // Do not handle unavailable decls from other modules.
-    if (IsModuleFile && AvailableAttr::isUnavailable(D))
+    if (IsModuleFile && D->isUnavailable())
       return false;
 
     if (!handleCustomAttrInitRefs(D))
diff --git a/lib/Sema/CodeSynthesis.cpp b/lib/Sema/CodeSynthesis.cpp
@@ -1177,7 +1177,7 @@ static void collectNonOveriddenSuperclassInits(
       continue;
 
     // Skip unavailable superclass initializers.
-    if (AvailableAttr::isUnavailable(superclassCtor))
+    if (superclassCtor->isUnavailable())
       continue;
 
     if (!overriddenInits.count(superclassCtor))
diff --git a/lib/Sema/LookupVisibleDecls.cpp b/lib/Sema/LookupVisibleDecls.cpp
@@ -987,13 +987,13 @@ class OverrideFilteringConsumer : public VisibleDeclConsumer {
                         /*skipProtocolExtensionCheck*/true)) {
           FoundConflicting = true;
 
-          if (!AvailableAttr::isUnavailable(VD)) {
+          if (!VD->isUnavailable()) {
             bool preferVD = (
                 // Prefer derived requirements over their witnesses.
                 Reason == DeclVisibilityKind::
                               MemberOfProtocolDerivedByCurrentNominal ||
                 // Prefer available one.
-                AvailableAttr::isUnavailable(OtherVD) ||
+                OtherVD->isUnavailable() ||
                 // Prefer more accessible one.
                 VD->getFormalAccess() > OtherVD->getFormalAccess());
             if (preferVD) {
diff --git a/lib/Sema/TypeCheckAttr.cpp b/lib/Sema/TypeCheckAttr.cpp
@@ -3076,7 +3076,7 @@ SynthesizeMainFunctionRequest::evaluate(Evaluator &evaluator,
 
   if (mainFunction->hasAsync() &&
       context.LangOpts.isConcurrencyModelTaskToThread() &&
-      !AvailableAttr::isUnavailable(mainFunction)) {
+      !mainFunction->isUnavailable()) {
     mainFunction->diagnose(diag::concurrency_task_to_thread_model_async_main,
                            "task-to-thread concurrency model");
     return nullptr;
@@ -4221,7 +4221,7 @@ void AttributeChecker::visitCustomAttr(CustomAttr *attr) {
   }
 
   if (nominal->isMainActor() && Ctx.LangOpts.isConcurrencyModelTaskToThread() &&
-      !AvailableAttr::isUnavailable(D)) {
+      !D->isUnavailable()) {
     SourceLoc loc;
     if (attr->isImplicit()) {
       loc = D->getStartLoc();
@@ -7337,7 +7337,7 @@ void AttributeChecker::visitGlobalActorAttr(GlobalActorAttr *attr) {
 
   auto &context = nominal->getASTContext();
   if (context.LangOpts.isConcurrencyModelTaskToThread() &&
-      !AvailableAttr::isUnavailable(nominal)) {
+      !nominal->isUnavailable()) {
     context.Diags.diagnose(attr->getLocation(),
                            diag::concurrency_task_to_thread_model_global_actor,
                            "task-to-thread concurrency model");
diff --git a/lib/Sema/TypeCheckAvailability.cpp b/lib/Sema/TypeCheckAvailability.cpp
@@ -4180,7 +4180,7 @@ bool swift::diagnoseDeclAvailability(const ValueDecl *D, SourceRange R,
   if (accessor) {
     // If the property/subscript is unconditionally unavailable, don't bother
     // with any of the rest of this.
-    if (AvailableAttr::isUnavailable(accessor->getStorage()))
+    if (accessor->getStorage()->isUnavailable())
       return false;
   }
 
@@ -4792,7 +4792,7 @@ static bool declNeedsExplicitAvailability(const Decl *decl) {
     return false;
 
   // Skip unavailable decls.
-  if (AvailableAttr::isUnavailable(decl))
+  if (decl->isUnavailable())
     return false;
 
   // Warn on decls without an introduction version.
diff --git a/lib/Sema/TypeCheckBitwise.cpp b/lib/Sema/TypeCheckBitwise.cpp
@@ -413,7 +413,7 @@ bool swift::checkBitwiseCopyableConformance(ProtocolConformance *conformance,
 
   // If this is an always-unavailable conformance, there's nothing to check.
   if (auto ext = dyn_cast<ExtensionDecl>(conformanceDC)) {
-    if (AvailableAttr::isUnavailable(ext))
+    if (ext->isUnavailable())
       return false;
   }
 
diff --git a/lib/Sema/TypeCheckConcurrency.cpp b/lib/Sema/TypeCheckConcurrency.cpp
@@ -249,7 +249,7 @@ bool IsDefaultActorRequest::evaluate(
   if (foundExecutorPropertyImpl) {
     if (!isDefaultActor &&
         classDecl->getASTContext().LangOpts.isConcurrencyModelTaskToThread() &&
-        !AvailableAttr::isUnavailable(classDecl)) {
+        !classDecl->isUnavailable()) {
       classDecl->diagnose(
           diag::concurrency_task_to_thread_model_custom_executor,
           "task-to-thread concurrency model");
@@ -6478,7 +6478,7 @@ bool swift::checkSendableConformance(
   // superclass conformance to find an unavailable attribute.
   if (auto ext = dyn_cast<ExtensionDecl>(
           conformance->getRootConformance()->getDeclContext())) {
-    if (AvailableAttr::isUnavailable(ext))
+    if (ext->isUnavailable())
       return false;
   }
 
diff --git a/lib/Sema/TypeCheckProtocol.cpp b/lib/Sema/TypeCheckProtocol.cpp
@@ -6391,7 +6391,7 @@ void TypeChecker::checkConformancesInContext(IterableDeclContext *idc) {
         // as long as the inherited conformance isn't unavailable.
         auto *conformance = SendableConformance->getRootConformance();
         auto *decl = conformance->getDeclContext()->getAsDecl();
-        if (!AvailableAttr::isUnavailable(decl)) {
+        if (!decl->isUnavailable()) {
           continue;
         }
 
diff --git a/lib/Sema/TypeCheckSwitchStmt.cpp b/lib/Sema/TypeCheckSwitchStmt.cpp
@@ -814,7 +814,7 @@ namespace {
               children, std::back_inserter(arr), [&](EnumElementDecl *eed) {
                 // Don't force people to match unavailable cases since they
                 // should not be instantiated at run time.
-                if (AvailableAttr::isUnavailable(eed)) {
+                if (eed->isUnavailable()) {
                   return Space();
                 }
 
diff --git a/lib/Sema/TypeCheckType.cpp b/lib/Sema/TypeCheckType.cpp
@@ -3382,7 +3382,7 @@ Type TypeResolver::resolveGlobalActor(SourceLoc loc, TypeResolutionOptions optio
   if (!result->hasError() && !attr->isInvalid() &&
       getASTContext().LangOpts.isConcurrencyModelTaskToThread()) {
     if (Decl *decl = getDeclContext()->getAsDecl()) {
-      if (!AvailableAttr::isUnavailable(decl))
+      if (!decl->isUnavailable())
         diagnose(attr->getLocation(),
                  diag::concurrency_task_to_thread_model_global_actor_annotation,
                  attr->getTypeRepr(), "task-to-thread concurrency model");
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftDocSupport.cpp b/tools/SourceKit/lib/SwiftLang/SwiftDocSupport.cpp
@@ -443,7 +443,7 @@ static bool initDocEntityInfo(const Decl *D,
     SwiftLangSupport::printUSR((const ValueDecl*)DefaultImplementationOf, OS);
   }
 
-  Info.IsUnavailable = AvailableAttr::isUnavailable(D);
+  Info.IsUnavailable = D->isUnavailable();
   Info.IsDeprecated = D->getAttrs().isDeprecated(D->getASTContext());
   Info.IsOptional = D->getAttrs().hasAttribute<OptionalAttr>();
   if (auto *AFD = dyn_cast<AbstractFunctionDecl>(D)) {
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp b/tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp
@@ -1000,7 +1000,7 @@ class SemanticAnnotator : public SourceEntityWalker {
       return true;
 
     // Do not annotate references to unavailable decls.
-    if (AvailableAttr::isUnavailable(D))
+    if (D->isUnavailable())
       return true;
 
     auto &SM = D->getASTContext().SourceMgr;
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftSourceDocInfo.cpp b/tools/SourceKit/lib/SwiftLang/SwiftSourceDocInfo.cpp
@@ -804,7 +804,7 @@ struct DeclInfo {
     // The synthesized properties $foo and _foo aren't unavailable even if
     // the original property foo is, so check them rather than the original
     // property.
-    Unavailable = AvailableAttr::isUnavailable(VD);
+    Unavailable = VD->isUnavailable();
     // No point computing the rest since they won't be used anyway.
     if (Unavailable)
       return;

Original file line number	Diff line number	Diff line change
`@@ -486,6 +486,8 @@ bool Decl::isAvailableAsSPI() const {`
`486`	`486`	`return AvailabilityInference::isAvailableAsSPI(this);`
`487`	`487`	`}`
`488`	`488`
	`489`	`+bool Decl::isUnavailable() const { return AvailableAttr::isUnavailable(this); }`
	`490`	`+`
`489`	`491`	`std::optional<AvailableAttrDeclPair>`
`490`	`492`	`SemanticUnavailableAttrRequest::evaluate(Evaluator &evaluator, const Decl *decl,`
`491`	`493`	`bool ignoreAppExtensions) const {`