[ASTPrint] Introduce a printing option to hide underscored protocols in the stdlib.

Author: akyrtzi

include/swift/AST/PrintOptions.h

@@ -97,6 +97,9 @@ struct PrintOptions {
   /// Whether to skip internal stdlib declarations.
   bool SkipPrivateStdlibDecls = false;
 
+  /// Whether to skip underscored stdlib protocols.
+  bool SkipUnderscoredStdlibProtocols = false;
+
   /// Whether to skip extensions that don't add protocols or no members.
   bool SkipEmptyExtensionDecls = true;
 

include/swift/AST/Type.h

@@ -137,7 +137,7 @@ class Type {
   Type subst(ModuleDecl *module, TypeSubstitutionMap &substitutions,
              SubstOptions options) const;
 
-  bool isPrivateStdlibType() const;
+  bool isPrivateStdlibType(bool whitelistProtocols=true) const;
 
   void dump() const;
   void dump(raw_ostream &os, unsigned indent = 0) const;

lib/AST/ASTPrinter.cpp

@@ -775,7 +775,9 @@ bool swift::shouldPrint(const Decl *D, PrintOptions &Options) {
       return false;
   }
 
-  if (Options.SkipPrivateStdlibDecls && D->isPrivateStdlibDecl())
+  if (Options.SkipPrivateStdlibDecls &&
+      D->isPrivateStdlibDecl(
+                /*whitelistProtocols=*/!Options.SkipUnderscoredStdlibProtocols))
     return false;
 
   if (Options.SkipEmptyExtensionDecls && isa<ExtensionDecl>(D)) {

lib/AST/Decl.cpp

@@ -382,7 +382,7 @@ bool Decl::isBeingTypeChecked() {
 bool Decl::isPrivateStdlibDecl(bool whitelistProtocols) const {
   const Decl *D = this;
   if (auto ExtD = dyn_cast<ExtensionDecl>(D))
-    return ExtD->getExtendedType().isPrivateStdlibType();
+    return ExtD->getExtendedType().isPrivateStdlibType(whitelistProtocols);
 
   DeclContext *DC = D->getDeclContext()->getModuleScopeContext();
   if (DC->getParentModule()->isBuiltinModule() ||

lib/AST/Type.cpp

@@ -3116,23 +3116,23 @@ TypeTraitResult TypeBase::canBeClass() {
   return TypeTraitResult::IsNot;
 }
 
-bool Type::isPrivateStdlibType() const {
+bool Type::isPrivateStdlibType(bool whitelistProtocols) const {
   Type Ty = *this;
   if (!Ty)
     return false;
 
   // A 'public' typealias can have an 'internal' type.
   if (NameAliasType *NAT = dyn_cast<NameAliasType>(Ty.getPointer()))
-    return NAT->getDecl()->isPrivateStdlibDecl();
+    return NAT->getDecl()->isPrivateStdlibDecl(whitelistProtocols);
 
   if (auto Paren = dyn_cast<ParenType>(Ty.getPointer()))
-    return Paren->getUnderlyingType().isPrivateStdlibType();
+    return Paren->getUnderlyingType().isPrivateStdlibType(whitelistProtocols);
 
   if (Type Unwrapped = Ty->getAnyOptionalObjectType())
-    return Unwrapped.isPrivateStdlibType();
+    return Unwrapped.isPrivateStdlibType(whitelistProtocols);
 
   if (auto TyD = Ty->getAnyNominal())
-    if (TyD->isPrivateStdlibDecl())
+    if (TyD->isPrivateStdlibDecl(whitelistProtocols))
       return true;
 
   return false;

test/IDE/print_stdlib.swift

@@ -11,6 +11,10 @@
 // RUN: %target-swift-ide-test -print-module -module-to-print=Swift -source-filename %s -print-interface-doc > %t-doc.txt
 // RUN: FileCheck %s < %t-doc.txt
 
+// RUN: %target-swift-ide-test -print-module -module-to-print=Swift -source-filename %s -print-interface -skip-underscored-stdlib-protocols > %t-prot.txt
+// RUN: FileCheck -check-prefix=CHECK-UNDERSCORED-PROT %s < %t-prot.txt
+// CHECK-UNDERSCORED-PROT-NOT: protocol _
+
 // CHECK-ARGC: static var argc: CInt { get }
 
 // CHECK-NOT: @rethrows

tools/swift-ide-test/swift-ide-test.cpp

@@ -451,6 +451,11 @@ SkipPrivateStdlibDecls("skip-private-stdlib-decls",
                 llvm::cl::desc("Don't print declarations that start with '_'"),
                 llvm::cl::init(false));
 
+static llvm::cl::opt<bool>
+SkipUnderscoredStdlibProtocols("skip-underscored-stdlib-protocols",
+                llvm::cl::desc("Don't print protocols that start with '_'"),
+                llvm::cl::init(false));
+
 static llvm::cl::opt<bool>
 PrintRegularComments("print-regular-comments",
              llvm::cl::desc("Print regular comments from clang module headers"),
@@ -2556,6 +2561,8 @@ int main(int argc, char *argv[]) {
         = PrintOptions::ArgAndParamPrintingMode::ArgumentOnly;
     }
   }
+  PrintOpts.SkipUnderscoredStdlibProtocols =
+    options::SkipUnderscoredStdlibProtocols;
 
   if (PrintOpts.PrintDocumentationComments) {
     InitInvok.getLangOptions().AttachCommentsToDecls = true;