AST: Adopt AvailabilityDomain in unavailability diagnostics.

Author: tshortli

include/swift/AST/AvailabilityDomain.h

@@ -72,6 +72,8 @@ class AvailabilityDomain final {
     return AvailabilityDomain(Kind::PackageDescription);
   }
 
+  Kind getKind() const { return kind; }
+
   bool isUniversal() const { return kind == Kind::Universal; }
 
   bool isPlatform() const { return kind == Kind::Platform; }
@@ -86,6 +88,10 @@ class AvailabilityDomain final {
     return platform;
   }
 
+  /// Returns the string to use in diagnostics to identify the domain. May
+  /// return an empty string.
+  llvm::StringRef getNameForDiagnostics() const;
+
   /// Returns the string to use when printing an `@available` attribute.
   llvm::StringRef getNameForAttributePrinting() const;
 };

lib/AST/AvailabilityDomain.cpp

@@ -36,6 +36,19 @@ Decl::getDomainForAvailableAttr(const AvailableAttr *attr) const {
   }
 }
 
+llvm::StringRef AvailabilityDomain::getNameForDiagnostics() const {
+  switch (kind) {
+  case Kind::Universal:
+    return "";
+  case Kind::Platform:
+    return swift::prettyPlatformString(getPlatformKind());
+  case Kind::SwiftLanguage:
+    return "Swift";
+  case Kind::PackageDescription:
+    return "PackageDescription";
+  }
+}
+
 llvm::StringRef AvailabilityDomain::getNameForAttributePrinting() const {
   switch (kind) {
   case Kind::Universal:

lib/Sema/TypeCheckAvailability.cpp

@@ -21,6 +21,7 @@
 #include "TypeCheckType.h"
 #include "TypeChecker.h"
 #include "swift/AST/ASTWalker.h"
+#include "swift/AST/AvailabilityDomain.h"
 #include "swift/AST/AvailabilityScope.h"
 #include "swift/AST/ClangModuleLoader.h"
 #include "swift/AST/DiagnosticsParse.h"
@@ -2961,32 +2962,37 @@ class UnavailabilityDiagnosticInfo {
 private:
   Status DiagnosticStatus;
   const AvailableAttr *Attr;
-  StringRef Platform;
-  StringRef VersionedPlatform;
+  AvailabilityDomain Domain;
 
 public:
   UnavailabilityDiagnosticInfo(Status status, const AvailableAttr *attr,
-                               StringRef platform, StringRef versionedPlatform)
-      : DiagnosticStatus(status), Attr(attr), Platform(platform),
-        VersionedPlatform(versionedPlatform) {
+                               AvailabilityDomain domain)
+      : DiagnosticStatus(status), Attr(attr), Domain(domain) {
     assert(attr);
-    assert(status == Status::AlwaysUnavailable || !VersionedPlatform.empty());
   };
 
   Status getStatus() const { return DiagnosticStatus; }
   const AvailableAttr *getAttr() const { return Attr; }
+  AvailabilityDomain getDomain() const { return Domain; }
+  StringRef getDomainName() const { return Domain.getNameForDiagnostics(); }
 
-  /// Returns the platform name (or "Swift" for a declaration that is
-  /// unavailable in Swift) to print in the main unavailability diangostic. May
-  /// be empty.
-  StringRef getPlatform() const { return Platform; }
+  bool shouldHideDomainNameInUnversionedDiagnostics() const {
+    switch (getDomain().getKind()) {
+    case AvailabilityDomain::Kind::Universal:
+      return true;
+    case AvailabilityDomain::Kind::Platform:
+      return false;
 
-  /// Returns the platform name to print in diagnostic notes about the version
-  /// in which a declaration either will become available or previously became
-  /// obsoleted.
-  StringRef getVersionedPlatform() const {
-    assert(DiagnosticStatus != Status::AlwaysUnavailable);
-    return VersionedPlatform;
+    case AvailabilityDomain::Kind::PackageDescription:
+    case AvailabilityDomain::Kind::SwiftLanguage:
+      switch (DiagnosticStatus) {
+      case Status::AlwaysUnavailable:
+        return false;
+      case Status::IntroducedInVersion:
+      case Status::Obsoleted:
+        return true;
+      }
+    }
   }
 };
 
@@ -2998,32 +3004,7 @@ getExplicitUnavailabilityDiagnosticInfo(const Decl *decl,
     return std::nullopt;
 
   ASTContext &ctx = decl->getASTContext();
-  StringRef platform = "";
-  StringRef versionedPlatform = "";
-  switch (attr->getPlatformAgnosticAvailability()) {
-  case PlatformAgnosticAvailabilityKind::Deprecated:
-    llvm_unreachable("shouldn't see deprecations in explicit unavailability");
-
-  case PlatformAgnosticAvailabilityKind::NoAsync:
-    llvm_unreachable("shouldn't see noasync in explicit unavailability");
-
-  case PlatformAgnosticAvailabilityKind::None:
-  case PlatformAgnosticAvailabilityKind::Unavailable:
-    if (attr->getPlatform() != PlatformKind::none) {
-      platform = attr->prettyPlatformString();
-      versionedPlatform = platform;
-    }
-    break;
-  case PlatformAgnosticAvailabilityKind::SwiftVersionSpecific:
-    versionedPlatform = "Swift";
-    break;
-  case PlatformAgnosticAvailabilityKind::PackageDescriptionVersionSpecific:
-    versionedPlatform = "PackageDescription";
-    break;
-  case PlatformAgnosticAvailabilityKind::UnavailableInSwift:
-    platform = "Swift";
-    break;
-  }
+  auto domain = decl->getDomainForAvailableAttr(attr);
 
   switch (attr->getVersionAvailability(ctx)) {
   case AvailableVersionComparison::Available:
@@ -3036,18 +3017,17 @@ getExplicitUnavailabilityDiagnosticInfo(const Decl *decl,
         attr->Introduced.has_value()) {
       return UnavailabilityDiagnosticInfo(
           UnavailabilityDiagnosticInfo::Status::IntroducedInVersion, attr,
-          platform, versionedPlatform);
+          domain);
     } else {
       return UnavailabilityDiagnosticInfo(
           UnavailabilityDiagnosticInfo::Status::AlwaysUnavailable, attr,
-          platform, versionedPlatform);
+          domain);
     }
     break;
 
   case AvailableVersionComparison::Obsoleted:
     return UnavailabilityDiagnosticInfo(
-        UnavailabilityDiagnosticInfo::Status::Obsoleted, attr, platform,
-        versionedPlatform);
+        UnavailabilityDiagnosticInfo::Status::Obsoleted, attr, domain);
   }
 }
 
@@ -3069,7 +3049,11 @@ bool diagnoseExplicitUnavailability(
 
   auto type = rootConf->getType();
   auto proto = rootConf->getProtocol()->getDeclaredInterfaceType();
-  StringRef platform = diagnosticInfo->getPlatform();
+  StringRef versionedPlatform = diagnosticInfo->getDomainName();
+  StringRef platform =
+      diagnosticInfo->shouldHideDomainNameInUnversionedDiagnostics()
+          ? ""
+          : versionedPlatform;
   const AvailableAttr *attr = diagnosticInfo->getAttr();
 
   // Downgrade unavailable Sendable conformance diagnostics where
@@ -3093,13 +3077,12 @@ bool diagnoseExplicitUnavailability(
     break;
   case UnavailabilityDiagnosticInfo::Status::IntroducedInVersion:
     diags.diagnose(ext, diag::conformance_availability_introduced_in_version,
-                   type, proto, diagnosticInfo->getVersionedPlatform(),
-                   *attr->Introduced);
+                   type, proto, versionedPlatform, *attr->Introduced);
     break;
   case UnavailabilityDiagnosticInfo::Status::Obsoleted:
     diags
         .diagnose(ext, diag::conformance_availability_obsoleted, type, proto,
-                  diagnosticInfo->getVersionedPlatform(), *attr->Obsoleted)
+                  versionedPlatform, *attr->Obsoleted)
         .highlight(attr->getRange());
     break;
   }
@@ -3496,7 +3479,11 @@ bool diagnoseExplicitUnavailability(
   SourceLoc Loc = R.Start;
   ASTContext &ctx = D->getASTContext();
   auto &diags = ctx.Diags;
-  StringRef platform = diagnosticInfo->getPlatform();
+  StringRef versionedPlatform = diagnosticInfo->getDomainName();
+  StringRef platform =
+      diagnosticInfo->shouldHideDomainNameInUnversionedDiagnostics()
+          ? ""
+          : versionedPlatform;
 
   // TODO: Consider removing this.
   // ObjC keypaths components weren't checked previously, so errors are demoted
@@ -3549,13 +3536,13 @@ bool diagnoseExplicitUnavailability(
   case UnavailabilityDiagnosticInfo::Status::IntroducedInVersion:
     diags
         .diagnose(D, diag::availability_introduced_in_version, D,
-                  diagnosticInfo->getVersionedPlatform(), *Attr->Introduced)
+                  versionedPlatform, *Attr->Introduced)
         .highlight(Attr->getRange());
     break;
   case UnavailabilityDiagnosticInfo::Status::Obsoleted:
     diags
-        .diagnose(D, diag::availability_obsoleted, D,
-                  diagnosticInfo->getVersionedPlatform(), *Attr->Obsoleted)
+        .diagnose(D, diag::availability_obsoleted, D, versionedPlatform,
+                  *Attr->Obsoleted)
         .highlight(Attr->getRange());
     break;
   }