Merge pull request #62652 from apple/es-pkg-acl

[NFC] Add 'package' access modifier to AccessLevel

Author: elsh

include/swift/AST/AccessScope.h

@@ -98,7 +98,6 @@ class AccessScope {
     }
     if (isPackage())
       return AS.isPublic();
-
     // If this is public, it can't be less than access level of AS
     // so return false
     return false;

include/swift/AST/AttrKind.h

@@ -60,6 +60,12 @@ enum class AccessLevel : uint8_t {
   FilePrivate,
   /// Internal access is limited to the current module.
   Internal,
+  /// Package access is not limited, but some capabilities may be
+  /// restricted outside of the current package containing modules.
+  /// It's similar to Public in that it's accessible from other modules
+  /// and subclassable only within the defining module as long as
+  /// the modules are in the same package.
+  Package,
   /// Public access is not limited, but some capabilities may be
   /// restricted outside of the current module.
   Public,

include/swift/AST/Decl.h

@@ -693,13 +693,14 @@ class alignas(1 << DeclAlignInBits) Decl : public ASTAllocated<Decl> {
     NumPathElements : 8
   );
 
-  SWIFT_INLINE_BITFIELD(ExtensionDecl, Decl, 3+1,
+  SWIFT_INLINE_BITFIELD(ExtensionDecl, Decl, 4+1,
     /// An encoding of the default and maximum access level for this extension.
+    /// The value 4 corresponds to AccessLevel::Public
     ///
     /// This is encoded as (1 << (maxAccess-1)) | (1 << (defaultAccess-1)),
     /// which works because the maximum is always greater than or equal to the
     /// default, and 'private' is never used. 0 represents an uncomputed value.
-    DefaultAndMaxAccessLevel : 3,
+    DefaultAndMaxAccessLevel : 4,
 
     /// Whether there is are lazily-loaded conformances for this extension.
     HasLazyConformances : 1

include/swift/AST/DiagnosticsSema.def

@@ -1742,6 +1742,7 @@ SDKContext::shouldIgnore(Decl *D, const Decl* Parent) const {
     case AccessLevel::Private:
     case AccessLevel::FilePrivate:
       return true;
+    case AccessLevel::Package:
     case AccessLevel::Public:
     case AccessLevel::Open:
       break;

lib/APIDigester/ModuleAnalyzerNodes.cpp

@@ -730,6 +730,9 @@ class PrintAST : public ASTVisitor<PrintAST> {
     case AccessLevel::Public:
       Printer << tok::kw_public;
       break;
+    case AccessLevel::Package:
+      Printer.printKeyword("package", Options);
+      break;
     case AccessLevel::Open:
       Printer.printKeyword("open", Options);
       break;

lib/AST/ASTPrinter.cpp

@@ -941,7 +941,7 @@ class Verifier : public ASTWalker {
         PrettyStackTraceDecl debugStack("verifying access", D);
         if (!D->getASTContext().isAccessControlDisabled() &&
             D->getFormalAccessScope().isPublic() &&
-            D->getFormalAccess() < AccessLevel::Public) {
+            D->getFormalAccess() <= AccessLevel::Package) {
           Out << "non-public decl has no formal access scope\n";
           D->dump(Out);
           abort();

lib/AST/ASTVerifier.cpp

@@ -251,6 +251,8 @@ DefaultAndMaxAccessLevelRequest::evaluate(Evaluator &evaluator,
       maxAccess = AccessLevel::Public;
     } else if (maxScope->isPublic()) {
       maxAccess = AccessLevel::Public;
+    } else if (maxScope->isPackage()) {
+      maxAccess = AccessLevel::Package;
     } else if (isa<ModuleDecl>(maxScope->getDeclContext())) {
       maxAccess = AccessLevel::Internal;
     } else {

lib/AST/AccessRequests.cpp

@@ -75,6 +75,7 @@ StringRef swift::getAccessLevelSpelling(AccessLevel value) {
   case AccessLevel::Private: return "private";
   case AccessLevel::FilePrivate: return "fileprivate";
   case AccessLevel::Internal: return "internal";
+  case AccessLevel::Package: return "package";
   case AccessLevel::Public: return "public";
   case AccessLevel::Open: return "open";
   }

lib/AST/Attr.cpp

@@ -3652,6 +3652,7 @@ AccessLevel ValueDecl::getEffectiveAccess() const {
   switch (effectiveAccess) {
   case AccessLevel::Open:
     break;
+  case AccessLevel::Package:
   case AccessLevel::Public:
   case AccessLevel::Internal:
     if (getModuleContext()->isTestingEnabled() ||
@@ -3774,6 +3775,7 @@ getAccessScopeForFormalAccess(const ValueDecl *VD,
                                      : AccessLimitKind::None);
   case AccessLevel::Internal:
     return AccessScope(resultDC->getParentModule());
+  case AccessLevel::Package:
   case AccessLevel::Public:
   case AccessLevel::Open:
     return AccessScope::getPublic();
@@ -3923,6 +3925,7 @@ static bool checkAccess(const DeclContext *useDC, const ValueDecl *VD,
     auto *useSF = dyn_cast<SourceFile>(useFile);
     return useSF && useSF->hasTestableOrPrivateImport(access, sourceModule);
   }
+  case AccessLevel::Package:
   case AccessLevel::Public:
   case AccessLevel::Open:
     return true;

lib/AST/Decl.cpp

@@ -2762,6 +2762,7 @@ bool SourceFile::hasTestableOrPrivateImport(
   auto *module = ofDecl->getModuleContext();
   switch (accessLevel) {
   case AccessLevel::Internal:
+  case AccessLevel::Package:
   case AccessLevel::Public:
     // internal/public access only needs an import marked as @_private. The
     // filename does not need to match (and we don't serialize it for such

lib/AST/Module.cpp

@@ -179,6 +179,11 @@ class CodeCompletionResultBuilder {
     case AccessLevel::Internal:
       // 'internal' is the default, don't add it.
       break;
+    case AccessLevel::Package:
+      addChunkWithTextNoCopy(
+          CodeCompletionString::Chunk::ChunkKind::AccessControlKeyword,
+          "package ");
+      break;
     case AccessLevel::Public:
       addChunkWithTextNoCopy(
           CodeCompletionString::Chunk::ChunkKind::AccessControlKeyword,

lib/IDE/CodeCompletionResultBuilder.h

@@ -1525,6 +1525,7 @@ bool IRGenerator::hasLazyMetadata(TypeDecl *type) {
       switch (type->getEffectiveAccess()) {
       case AccessLevel::Open:
       case AccessLevel::Public:
+      case AccessLevel::Package:
         // We can't remove metadata for externally visible types.
         return false;
       case AccessLevel::Internal:

lib/IRGen/GenDecl.cpp

@@ -40,6 +40,7 @@ FormalLinkage swift::getDeclLinkage(const ValueDecl *D) {
     return FormalLinkage::PublicNonUnique;
 
   switch (D->getEffectiveAccess()) {
+  case AccessLevel::Package:
   case AccessLevel::Public:
   case AccessLevel::Open:
     return FormalLinkage::PublicUnique;

lib/SIL/IR/SIL.cpp

@@ -607,6 +607,7 @@ SILLinkage SILDeclRef::getDefinitionLinkage() const {
       return SILLinkage::Shared;
     return SILLinkage::Hidden;
 
+  case AccessLevel::Package:
   case AccessLevel::Public:
   case AccessLevel::Open:
     switch (limit) {
@@ -1516,6 +1517,7 @@ SubclassScope SILDeclRef::getSubclassScope() const {
     // SILModule, so we don't need to do anything.
     return SubclassScope::NotApplicable;
   case AccessLevel::Internal:
+  case AccessLevel::Package:
   case AccessLevel::Public:
     // If the class is internal or public, it can only be subclassed from
     // the same AST Module, but possibly a different SILModule.

lib/SIL/IR/SILDeclRef.cpp

@@ -926,6 +926,7 @@ SILLinkage swift::getDeclSILLinkage(const ValueDecl *decl) {
   case AccessLevel::Internal:
     linkage = SILLinkage::Hidden;
     break;
+  case AccessLevel::Package:
   case AccessLevel::Public:
   case AccessLevel::Open:
     linkage = SILLinkage::Public;

lib/SIL/IR/SILModule.cpp

@@ -177,6 +177,7 @@ void CalleeCache::computeWitnessMethodCalleesForWitnessTable(
     switch (Conf->getProtocol()->getEffectiveAccess()) {
       case AccessLevel::Open:
         llvm_unreachable("protocols cannot have open access level");
+      case AccessLevel::Package:
       case AccessLevel::Public:
         canCallUnknown = true;
         break;

lib/SILOptimizer/Analysis/BasicCalleeAnalysis.cpp

@@ -394,6 +394,7 @@ class DeadFunctionAndGlobalElimination {
     case AccessLevel::Internal:
       linkage = SILLinkage::Hidden;
       break;
+    case AccessLevel::Package:
     case AccessLevel::Public:
     case AccessLevel::Open:
       linkage = SILLinkage::Public;

lib/SILOptimizer/IPO/DeadFunctionElimination.cpp

@@ -490,6 +490,7 @@ static bool canBeChangedExternally(SILGlobalVariable *SILG) {
       return false;
     case AccessLevel::Internal:
       return !SILG->getModule().isWholeModule();
+    case AccessLevel::Package:
     case AccessLevel::Public:
     case AccessLevel::Open:
       return true;

lib/SILOptimizer/IPO/GlobalOpt.cpp

@@ -305,6 +305,7 @@ static bool isDefaultCaseKnown(ClassHierarchyAnalysis *CHA,
   case AccessLevel::Open:
     return false;
   case AccessLevel::Public:
+  case AccessLevel::Package:
   case AccessLevel::Internal:
     if (!AI.getModule().isWholeModule())
       return false;

lib/SILOptimizer/Transforms/SpeculativeDevirtualizer.cpp

@@ -156,6 +156,7 @@ static bool isKnownFinalClass(ClassDecl *cd, SILModule &module,
   case AccessLevel::Open:
     return false;
   case AccessLevel::Public:
+  case AccessLevel::Package:
   case AccessLevel::Internal:
     if (!module.isWholeModule())
       return false;
@@ -177,6 +178,7 @@ static bool isKnownFinalClass(ClassDecl *cd, SILModule &module,
       case AccessLevel::Open:
         return false;
       case AccessLevel::Public:
+      case AccessLevel::Package:
       case AccessLevel::Internal:
         if (!module.isWholeModule())
           return false;

lib/SILOptimizer/Utils/Devirtualize.cpp

@@ -1344,6 +1344,7 @@ bool swift::calleesAreStaticallyKnowable(SILModule &module, ValueDecl *vd) {
   case AccessLevel::Open:
     return false;
   case AccessLevel::Public:
+  case AccessLevel::Package:
     if (isa<ConstructorDecl>(vd)) {
       // Constructors are special: a derived class in another module can
       // "override" a constructor if its class is "open", although the

lib/SILOptimizer/Utils/InstOptUtils.cpp

@@ -5626,6 +5626,7 @@ void swift::fixItAccess(InFlightDiagnostic &diag, ValueDecl *VD,
   case AccessLevel::Private:      fixItString = "private ";      break;
   case AccessLevel::FilePrivate:  fixItString = "fileprivate ";  break;
   case AccessLevel::Internal:     fixItString = "internal ";     break;
+  case AccessLevel::Package:      fixItString = "package ";      break;
   case AccessLevel::Public:       fixItString = "public ";       break;
   case AccessLevel::Open:         fixItString = "open ";         break;
   }

lib/Sema/MiscDiagnostics.cpp

@@ -2105,6 +2105,7 @@ static void checkExtensionGenericParamAccess(const ExtensionDecl *ED) {
   case AccessLevel::Internal:
     desiredAccessScope = AccessScope(ED->getModuleContext());
     break;
+  case AccessLevel::Package:
   case AccessLevel::Public:
   case AccessLevel::Open:
     break;

lib/Sema/TypeCheckAccess.cpp

@@ -3489,6 +3489,7 @@ class DeclChecker : public DeclVisitor<DeclChecker> {
         case AccessLevel::Open:
           requiredAccess = AccessLevel::Public;
           break;
+        case AccessLevel::Package:
         case AccessLevel::Public:
         case AccessLevel::Internal:
           requiredAccess = AccessLevel::Internal;

lib/Sema/TypeCheckDeclPrimary.cpp

@@ -6180,6 +6180,7 @@ static void diagnoseUnstableName(ProtocolConformance *conformance,
     case AccessLevel::Internal:
     case AccessLevel::Open:
     case AccessLevel::Public:
+    case AccessLevel::Package:
       break;
     }
   }

lib/Sema/TypeCheckProtocol.cpp

@@ -2493,6 +2493,7 @@ static Optional<swift::AccessLevel> getActualAccessLevel(uint8_t raw) {
   CASE(Private)
   CASE(FilePrivate)
   CASE(Internal)
+  CASE(Package)
   CASE(Public)
   CASE(Open)
 #undef CASE

lib/Serialization/Deserialization.cpp

@@ -58,7 +58,7 @@ const uint16_t SWIFTMODULE_VERSION_MAJOR = 0;
 /// describe what change you made. The content of this comment isn't important;
 /// it just ensures a conflict if two people change the module format.
 /// Don't worry about adhering to the 80-column limit for this line.
-const uint16_t SWIFTMODULE_VERSION_MINOR = 735; // @attached
+const uint16_t SWIFTMODULE_VERSION_MINOR = 736; // add package access modifier
 
 /// A standard hash seed used for all string hashes in a serialized module.
 ///
@@ -521,6 +521,7 @@ enum class AccessLevel : uint8_t {
   Private = 0,
   FilePrivate,
   Internal,
+  Package,
   Public,
   Open,
 };

lib/Serialization/ModuleFormat.h

@@ -2195,6 +2195,7 @@ static uint8_t getRawStableAccessLevel(swift::AccessLevel access) {
   CASE(Private)
   CASE(FilePrivate)
   CASE(Internal)
+  CASE(Package)
   CASE(Public)
   CASE(Open)
 #undef CASE

lib/Serialization/Serialization.cpp

@@ -1134,6 +1134,7 @@ namespace  {
 static UIdent getAccessLevelUID(AccessLevel Access) {
   static UIdent AccessOpen("source.lang.swift.accessibility.open");
   static UIdent AccessPublic("source.lang.swift.accessibility.public");
+  static UIdent AccessPackage("source.lang.swift.accessibility.package");
   static UIdent AccessInternal("source.lang.swift.accessibility.internal");
   static UIdent AccessFilePrivate("source.lang.swift.accessibility.fileprivate");
   static UIdent AccessPrivate("source.lang.swift.accessibility.private");
@@ -1145,6 +1146,8 @@ static UIdent getAccessLevelUID(AccessLevel Access) {
     return AccessFilePrivate;
   case AccessLevel::Internal:
     return AccessInternal;
+  case AccessLevel::Package:
+    return AccessPackage;
   case AccessLevel::Public:
     return AccessPublic;
   case AccessLevel::Open:

tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp

@@ -74,11 +74,13 @@ static UIdent Attr_ObjcNamed("source.decl.attribute.objc.name");
 static UIdent Attr_Private("source.decl.attribute.private");
 static UIdent Attr_FilePrivate("source.decl.attribute.fileprivate");
 static UIdent Attr_Internal("source.decl.attribute.internal");
+static UIdent Attr_Package("source.decl.attribute.package");
 static UIdent Attr_Public("source.decl.attribute.public");
 static UIdent Attr_Open("source.decl.attribute.open");
 static UIdent Attr_Setter_Private("source.decl.attribute.setter_access.private");
 static UIdent Attr_Setter_FilePrivate("source.decl.attribute.setter_access.fileprivate");
 static UIdent Attr_Setter_Internal("source.decl.attribute.setter_access.internal");
+static UIdent Attr_Setter_Package("source.decl.attribute.setter_access.package");
 static UIdent Attr_Setter_Public("source.decl.attribute.setter_access.public");
 static UIdent Attr_Setter_Open("source.decl.attribute.setter_access.open");
 static UIdent EffectiveAccess_Public("source.decl.effective_access.public");
@@ -794,6 +796,8 @@ Optional<UIdent> SwiftLangSupport::getUIDForDeclAttribute(const swift::DeclAttri
           return Attr_FilePrivate;
         case AccessLevel::Internal:
           return Attr_Internal;
+        case AccessLevel::Package:
+          return Attr_Package;
         case AccessLevel::Public:
           return Attr_Public;
         case AccessLevel::Open:
@@ -808,6 +812,8 @@ Optional<UIdent> SwiftLangSupport::getUIDForDeclAttribute(const swift::DeclAttri
           return Attr_Setter_FilePrivate;
         case AccessLevel::Internal:
           return Attr_Setter_Internal;
+        case AccessLevel::Package:
+          return Attr_Setter_Package;
         case AccessLevel::Public:
           return Attr_Setter_Public;
         case AccessLevel::Open:

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.cpp

@@ -833,6 +833,7 @@ def __init__(self, name, swift_name=None):
     DeclAttributeAlias('fileprivate', 'AccessControl', swift_name='fileprivateKeyword'),
     DeclAttributeAlias('internal', 'AccessControl', swift_name='internalKeyword'),
     DeclAttributeAlias('public', 'AccessControl', swift_name='publicKeyword'),
+    ContextualDeclAttributeAlias('package', 'AccessControl'),
     ContextualDeclAttributeAlias('open', 'AccessControl'),
     DeclAttribute('__setter_access', 'SetterAccess',
                   OnVar, OnSubscript,