ASTPrinter: Remove ASTPrinter's dependency on Sema. (#10985)

Author: nkcsgexi

include/swift/AST/ASTPrinter.h

@@ -305,9 +305,6 @@ class ExtraIndentStreamPrinter : public StreamPrinter {
   }
 };
 
-bool shouldPrint(const Decl *D, PrintOptions &Options);
-bool shouldPrintPattern(const Pattern *P, PrintOptions &Options);
-
 void printContext(raw_ostream &os, DeclContext *dc);
 
 bool printRequirementStub(ValueDecl *Requirement, DeclContext *Adopter,

include/swift/AST/PrintOptions.h

@@ -24,6 +24,7 @@ namespace swift {
 class GenericEnvironment;
 class CanType;
 class Decl;
+class Pattern;
 class ValueDecl;
 class ExtensionDecl;
 class NominalTypeDecl;
@@ -49,32 +50,6 @@ struct TypeTransformContext {
   bool isPrintingSynthesizedExtension() const;
 };
 
-typedef std::pair<ExtensionDecl*, bool> ExtensionAndIsSynthesized;
-typedef llvm::function_ref<void(ArrayRef<ExtensionAndIsSynthesized>)>
-  ExtensionGroupOperation;
-
-class SynthesizedExtensionAnalyzer {
-  struct Implementation;
-  Implementation &Impl;
-public:
-  SynthesizedExtensionAnalyzer(NominalTypeDecl *Target,
-                               PrintOptions Options,
-                               bool IncludeUnconditional = true);
-  ~SynthesizedExtensionAnalyzer();
-
-  enum class MergeGroupKind : char {
-    All,
-    MergeableWithTypeDef,
-    UnmergeableWithTypeDef,
-  };
-
-  void forEachExtensionMergeGroup(MergeGroupKind Kind,
-                                  ExtensionGroupOperation Fn);
-  bool isInSynthesizedExtension(const ValueDecl *VD);
-  bool shouldPrintRequirement(ExtensionDecl *ED, StringRef Req);
-  bool hasMergeGroup(MergeGroupKind Kind);
-};
-
 class BracketOptions {
   Decl* Target;
   bool OpenExtension;
@@ -131,6 +106,12 @@ class AnyAttrKind {
   bool operator!=(AnyAttrKind K) const { return !(*this == K); }
 };
 
+struct ShouldPrintChecker {
+  virtual bool shouldPrint(const Decl *D, PrintOptions &Options);
+  bool shouldPrint(const Pattern *P, PrintOptions &Options);
+  virtual ~ShouldPrintChecker() = default;
+};
+
 /// Options for printing AST nodes.
 ///
 /// A default-constructed PrintOptions is suitable for printing to users;
@@ -294,6 +275,9 @@ struct PrintOptions {
   /// Whether to print the extensions from conforming protocols.
   bool PrintExtensionFromConformingProtocols = false;
 
+  std::shared_ptr<ShouldPrintChecker> CurrentPrintabilityChecker =
+    std::make_shared<ShouldPrintChecker>();
+
   enum class ArgAndParamPrintingMode {
     ArgumentOnly,
     MatchSource,
@@ -423,6 +407,7 @@ struct PrintOptions {
     return result;
   }
 
+  static PrintOptions printModuleInterface();
   static PrintOptions printTypeInterface(Type T);
 
   void setBaseType(Type T);
@@ -431,6 +416,13 @@ struct PrintOptions {
 
   void clearSynthesizedExtension();
 
+  bool shouldPrint(const Decl* D) {
+    return CurrentPrintabilityChecker->shouldPrint(D, *this);
+  }
+  bool shouldPrint(const Pattern* P) {
+    return CurrentPrintabilityChecker->shouldPrint(P, *this);
+  }
+
   /// Retrieve the print options that are suitable to print the testable interface.
   static PrintOptions printTestableInterface() {
     PrintOptions result = printInterface();
@@ -449,19 +441,7 @@ struct PrintOptions {
 
   /// Retrieve the set of options suitable for interface generation for
   /// documentation purposes.
-  static PrintOptions printDocInterface() {
-    PrintOptions result = PrintOptions::printInterface();
-    result.PrintAccessibility = false;
-    result.SkipUnavailable = false;
-    result.ExcludeAttrList.push_back(DAK_Available);
-    result.ArgAndParamPrinting =
-      PrintOptions::ArgAndParamPrintingMode::BothAlways;
-    result.PrintDocumentationComments = false;
-    result.PrintRegularClangComments = false;
-    result.PrintAccessibility = false;
-    result.PrintFunctionRepresentationAttrs = false;
-    return result;
-  }
+  static PrintOptions printDocInterface();
 
   /// Retrieve the set of options suitable for printing SIL functions.
   static PrintOptions printSIL() {

include/swift/Sema/IDETypeChecking.h

@@ -29,6 +29,11 @@ namespace swift {
   class LazyResolver;
   class ExtensionDecl;
   class ProtocolDecl;
+  class Type;
+  class DeclContext;
+  class ConcreteDeclRef;
+  class ValueDecl;
+  class DeclName;
 
   /// \brief Typecheck a declaration parsed during code completion.
   ///
@@ -131,6 +136,33 @@ namespace swift {
 
   /// Creates a lazy type resolver for use in lookups.
   OwnedResolver createLazyResolver(ASTContext &Ctx);
+
+  typedef std::pair<ExtensionDecl*, bool> ExtensionAndIsSynthesized;
+
+  typedef llvm::function_ref<void(ArrayRef<ExtensionAndIsSynthesized>)>
+    ExtensionGroupOperation;
+
+  class SynthesizedExtensionAnalyzer {
+    struct Implementation;
+    Implementation &Impl;
+  public:
+    SynthesizedExtensionAnalyzer(NominalTypeDecl *Target,
+                                 PrintOptions Options,
+                                 bool IncludeUnconditional = true);
+    ~SynthesizedExtensionAnalyzer();
+
+    enum class MergeGroupKind : char {
+      All,
+      MergeableWithTypeDef,
+      UnmergeableWithTypeDef,
+    };
+
+    void forEachExtensionMergeGroup(MergeGroupKind Kind,
+                                    ExtensionGroupOperation Fn);
+    bool isInSynthesizedExtension(const ValueDecl *VD);
+    bool shouldPrintRequirement(ExtensionDecl *ED, StringRef Req);
+    bool hasMergeGroup(MergeGroupKind Kind);
+  };
 }
 
 #endif

lib/AST/ASTPrinter.cpp

@@ -36,7 +36,6 @@
 #include "swift/Basic/StringExtras.h"
 #include "swift/Config.h"
 #include "swift/Parse/Lexer.h"
-#include "swift/Sema/IDETypeChecking.h"
 #include "swift/Strings.h"
 #include "clang/AST/ASTContext.h"
 #include "clang/AST/Decl.h"
@@ -52,17 +51,6 @@
 
 using namespace swift;
 
-PrintOptions PrintOptions::printTypeInterface(Type T) {
-  PrintOptions result = printInterface();
-  result.PrintExtensionFromConformingProtocols = true;
-  result.TransformContext = TypeTransformContext(T);
-  result.printExtensionContentAsMembers = [T](const ExtensionDecl *ED) {
-    return isExtensionApplied(*T->getNominalOrBoundGenericNominal()->
-                              getDeclContext(), T, ED);
-  };
-  return result;
-}
-
 void PrintOptions::setBaseType(Type T) {
   TransformContext = TypeTransformContext(T);
 }
@@ -830,17 +818,17 @@ static const unsigned ErrorDepth = ~0U;
 /// A helper function to return the depth of a type.
 static unsigned getDepthOfType(Type ty) {
   unsigned depth = ErrorDepth;
-  
+
   auto combineDepth = [&depth](unsigned newDepth) -> bool {
     // If there is no current depth (depth == ErrorDepth), then assign to
     // newDepth; otherwise, choose the deeper of the current and new depth.
-    
+
     // Since ErrorDepth == ~0U, ErrorDepth + 1 == 0, which is smaller than any
     // valid depth + 1.
     depth = std::max(depth+1U, newDepth+1U) - 1U;
     return false;
   };
-  
+
   ty.findIf([combineDepth](Type t) -> bool {
     if (auto paramTy = t->getAs<GenericTypeParamType>())
       return combineDepth(paramTy->getDepth());
@@ -856,7 +844,7 @@ static unsigned getDepthOfType(Type ty) {
 
     return false;
   });
-  
+
   return depth;
 }
 
@@ -1222,16 +1210,8 @@ void PrintAST::printRequirement(const Requirement &req) {
   printType(req.getSecondType());
 }
 
-bool swift::shouldPrintPattern(const Pattern *P, PrintOptions &Options) {
-  bool ShouldPrint = false;
-  P->forEachVariable([&](VarDecl *VD) {
-    ShouldPrint |= shouldPrint(VD, Options);
-  });
-  return ShouldPrint;
-}
-
 bool PrintAST::shouldPrintPattern(const Pattern *P) {
-  return swift::shouldPrintPattern(P, Options);
+  return Options.shouldPrint(P);
 }
 
 void PrintAST::printPatternType(const Pattern *P) {
@@ -1241,24 +1221,15 @@ void PrintAST::printPatternType(const Pattern *P) {
   }
 }
 
-static bool shouldPrintAsFavorable(const Decl *D, PrintOptions &Options) {
-  if (!Options.TransformContext || !D->getDeclContext()->isExtensionContext() ||
-      !Options.TransformContext->isPrintingSynthesizedExtension())
-    return true;
-  NominalTypeDecl *Target = Options.TransformContext->getNominal();
-  Type BaseTy = Target->getDeclaredTypeInContext();
-  const auto *FD = dyn_cast<FuncDecl>(D);
-  if (!FD)
-    return true;
-  ResolvedMemberResult Result = resolveValueMember(*Target->getDeclContext(),
-                                                  BaseTy,
-                                                  FD->getEffectiveFullName());
-  return !(Result.hasBestOverload() && Result.getBestOverload() != D);
+bool ShouldPrintChecker::shouldPrint(const Pattern *P, PrintOptions &Options) {
+  bool ShouldPrint = false;
+  P->forEachVariable([&](const VarDecl *VD) {
+    ShouldPrint |= shouldPrint(VD, Options);
+  });
+  return ShouldPrint;
 }
 
-bool swift::shouldPrint(const Decl *D, PrintOptions &Options) {
-  if (!shouldPrintAsFavorable(D, Options))
-    return false;
+bool ShouldPrintChecker::shouldPrint(const Decl *D, PrintOptions &Options) {
   if (auto *ED= dyn_cast<ExtensionDecl>(D)) {
     if (Options.printExtensionContentAsMembers(ED))
       return false;
@@ -1358,7 +1329,7 @@ bool swift::shouldPrint(const Decl *D, PrintOptions &Options) {
   if (auto *PD = dyn_cast<PatternBindingDecl>(D)) {
     auto ShouldPrint = false;
     for (auto entry : PD->getPatternList()) {
-      ShouldPrint |= shouldPrintPattern(entry.getPattern(), Options);
+      ShouldPrint |= shouldPrint(entry.getPattern(), Options);
       if (ShouldPrint)
         return true;
     }
@@ -1368,7 +1339,7 @@ bool swift::shouldPrint(const Decl *D, PrintOptions &Options) {
 }
 
 bool PrintAST::shouldPrint(const Decl *D, bool Notify) {
-  auto Result = swift::shouldPrint(D, Options);
+  auto Result = Options.shouldPrint(D);
   if (!Result && Notify)
     Printer.callAvoidPrintDeclPost(D);
   return Result;
@@ -3600,7 +3571,7 @@ class TypePrinter : public TypeVisitor<TypePrinter> {
     };
 
     printFunctionExtInfo(T->getExtInfo());
-    
+
     // If we're stripping argument labels from types, do it when printing.
     Type inputType = T->getInput();
     if (auto tupleTy = dyn_cast<TupleType>(inputType.getPointer())) {
@@ -3614,15 +3585,15 @@ class TypePrinter : public TypeVisitor<TypePrinter> {
     bool needsParens =
       !isa<ParenType>(inputType.getPointer()) &&
       !inputType->is<TupleType>();
-    
+
     if (needsParens)
       Printer << "(";
 
     visit(inputType);
-    
+
     if (needsParens)
       Printer << ")";
-    
+
     if (T->throws())
       Printer << " " << tok::kw_throws;
 
@@ -3653,7 +3624,7 @@ class TypePrinter : public TypeVisitor<TypePrinter> {
     bool needsParens =
       !isa<ParenType>(T->getInput().getPointer()) &&
       !T->getInput()->is<TupleType>();
-      
+
     if (needsParens)
       Printer << "(";
 
@@ -3742,7 +3713,7 @@ class TypePrinter : public TypeVisitor<TypePrinter> {
       PrintOptions subOptions = Options;
       subOptions.GenericEnv = nullptr;
       TypePrinter sub(Printer, subOptions);
-      
+
       // Capture list used here to ensure we don't print anything using `this`
       // printer, but only the sub-Printer.
       [&sub, T]{
@@ -3764,7 +3735,7 @@ class TypePrinter : public TypeVisitor<TypePrinter> {
         sub.Printer << " }";
       }();
     }
-    
+
     // The arguments to the layout, if any, do come from the outer environment.
     if (!T->getGenericArgs().empty()) {
       Printer << " <";