Merge pull request swiftlang#29948 from davidungar/unit-test-users-v5a

[Incremental, NFC] Rearrange code creating `SourceFileDepGraph`

Author: David Ungar

include/swift/AST/AbstractSourceFileDepGraphFactory.h

@@ -0,0 +1,85 @@
+//===----- AbstractSourceFileDepGraphFactory.h ----------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_AST_SOURCE_FILE_DEP_GRAPH_CONSTRUCTOR_H
+#define SWIFT_AST_SOURCE_FILE_DEP_GRAPH_CONSTRUCTOR_H
+
+#include "swift/AST/DeclContext.h"
+#include "swift/AST/FineGrainedDependencies.h"
+
+namespace swift {
+class DiagnosticEngine;
+namespace fine_grained_dependencies {
+
+/// Abstract class for building a \c SourceFileDepGraph from either a real
+/// \c SourceFile or a unit test
+class AbstractSourceFileDepGraphFactory {
+protected:
+  /// To match the existing system, set this to false.
+  /// To include even private entities and get intra-file info, set to true.
+  const bool includePrivateDeps;
+
+  /// If there was an error, cannot get accurate info.
+  const bool hadCompilationError;
+
+  /// The name of the swiftDeps file.
+  const std::string swiftDeps;
+
+  /// The fingerprint of the whole file
+  const std::string fileFingerprint;
+
+  /// For debugging
+  const bool emitDotFileAfterConstruction;
+
+  DiagnosticEngine &diags;
+
+  /// Graph under construction
+  SourceFileDepGraph g;
+
+public:
+  /// Expose this layer to enable faking up a constructor for testing.
+  /// See the instance variable comments for explanation.
+  AbstractSourceFileDepGraphFactory(bool includePrivateDeps,
+                                    bool hadCompilationError,
+                                    StringRef swiftDeps,
+                                    StringRef fileFingerprint,
+                                    bool emitDotFileAfterConstruction,
+                                    DiagnosticEngine &diags);
+
+  virtual ~AbstractSourceFileDepGraphFactory() = default;
+
+  /// Create a SourceFileDepGraph.
+  SourceFileDepGraph construct();
+
+private:
+  void addSourceFileNodesToGraph();
+
+  /// Add the "provides" nodes when mocking up a graph
+  virtual void addAllDefinedDecls() = 0;
+
+  /// Add the "depends" nodes and arcs when mocking a graph
+  virtual void addAllUsedDecls() = 0;
+
+protected:
+  /// Add an pair of interface, implementation nodes to the graph, which
+  /// represent some \c Decl defined in this source file. \param key the
+  /// interface key of the pair
+  void addADefinedDecl(const DependencyKey &key,
+                       Optional<StringRef> fingerprint);
+
+  void addAUsedDecl(const DependencyKey &def, const DependencyKey &use);
+};
+
+} // namespace fine_grained_dependencies
+} // namespace swift
+
+#endif // SWIFT_AST_SOURCE_FILE_DEP_GRAPH_CONSTRUCTOR_H

include/swift/AST/FineGrainedDependencies.h

@@ -378,7 +378,6 @@ const std::string NodeKindNames[]{
     "topLevel",      "nominal",        "potentialMember",  "member",
     "dynamicLookup", "externalDepend", "sourceFileProvide"};
 
-
 /// Instead of the status quo scheme of two kinds of "Depends", cascading and
 /// non-cascading this code represents each entity ("Provides" in the status
 /// quo), by a pair of nodes. One node represents the "implementation." If the
@@ -398,7 +397,6 @@ template <typename FnT> void forEachAspect(FnT fn) {
     fn(DeclAspect(i));
 }
 
-
 /// A pair of nodes that represent the two aspects of a given entity.
 /// Templated in order to serve for either SourceFileDepGraphNodes or
 /// ModuleDepGraphNodes.
@@ -585,7 +583,6 @@ struct std::hash<typename swift::fine_grained_dependencies::NodeKind> {
   }
 };
 
-
 namespace swift {
 namespace fine_grained_dependencies {
 using ContextNameFingerprint =

include/swift/AST/FrontendSourceFileDepGraphFactory.h

@@ -0,0 +1,60 @@
+//===----- FrontendSourceFileDepGraphFactory.h -------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef FrontendSourceFileDepGraphFactory_h
+#define FrontendSourceFileDepGraphFactory_h
+
+#include "swift/AST/AbstractSourceFileDepGraphFactory.h"
+namespace swift {
+namespace fine_grained_dependencies {
+
+/// Constructs a SourceFileDepGraph from a *real* \c SourceFile
+/// Reads the information provided by the frontend and builds the
+/// SourceFileDepGraph
+
+class FrontendSourceFileDepGraphFactory
+    : public AbstractSourceFileDepGraphFactory {
+  SourceFile *const SF;
+  const DependencyTracker &depTracker;
+
+public:
+  FrontendSourceFileDepGraphFactory(SourceFile *SF, StringRef outputPath,
+                                    const DependencyTracker &depTracker,
+                                    bool alsoEmitDotFile);
+
+  ~FrontendSourceFileDepGraphFactory() override = default;
+
+private:
+  static std::string getFingerprint(SourceFile *SF);
+
+  static bool computeIncludePrivateDeps(SourceFile *SF);
+  static std::string getInterfaceHash(SourceFile *SF);
+
+  void addAllDefinedDecls() override;
+  void addAllUsedDecls() override;
+
+  /// Given an array of Decls or pairs of them in \p declsOrPairs
+  /// create node pairs for context and name
+  template <NodeKind kind, typename ContentsT>
+  void addAllDefinedDeclsOfAGivenType(std::vector<ContentsT> &contentsVec);
+
+  /// At present, only nominals, protocols, and extensions have (body)
+  /// fingerprints
+  static Optional<std::string>
+  getFingerprintIfAny(std::pair<const NominalTypeDecl *, const ValueDecl *>);
+  static Optional<std::string> getFingerprintIfAny(const Decl *d);
+};
+
+} // namespace fine_grained_dependencies
+} // namespace swift
+
+#endif /* FrontendSourceFileDepGraphFactory_h */