File: DOTModuleDependencyGraphSerializer.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (76 lines) | stat: -rw-r--r-- 2,720 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
//===----------- DOTModuleDependencyGraphSerializer.swift - Swift ---------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2019 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
//
//===----------------------------------------------------------------------===//
import TSCBasic

/// Serializes a module dependency graph to a .dot graph
@_spi(Testing) public struct DOTModuleDependencyGraphSerializer {
  let graph: InterModuleDependencyGraph

  public init(_ interModuleDependencyGraph: InterModuleDependencyGraph) {
    self.graph = interModuleDependencyGraph
  }

  func label(for moduleId: ModuleDependencyId) -> String {
    let label: String
    switch moduleId {
    case .swift(let string):
      label = "\(string)"
    case .swiftPlaceholder(let string):
      label = "\(string) (Placeholder)"
    case .swiftPrebuiltExternal(let string):
      label = "\(string) (Prebuilt)"
    case .clang(let string):
      label = "\(string) (C)"
    }
    return label
  }

  func quoteName(_ name: String) -> String {
    return "\"" + name.replacingOccurrences(of: "\"", with: "\\\"") + "\""
  }

  func outputNode(for moduleId: ModuleDependencyId) -> String {
    let nodeName = quoteName(label(for: moduleId))
    let output: String
    let font = "fontname=\"Helvetica Bold\""

    if moduleId == .swift(graph.mainModuleName) {
      output = "  \(nodeName) [shape=box, style=bold, color=navy, \(font)];\n"
    } else {
      switch moduleId {
      case .swift(_):
        output = "  \(nodeName) [style=bold, color=orange, style=filled, \(font)];\n"
      case .swiftPlaceholder(_):
        output = "  \(nodeName) [style=bold, color=gold, style=filled, \(font)];\n"
      case .swiftPrebuiltExternal(_):
        output = "  \(nodeName) [style=bold, color=darkorange3, style=filled, \(font)];\n"
      case .clang(_):
        output = "  \(nodeName) [style=bold, color=lightskyblue, style=filled, \(font)];\n"
      }
    }
    return output
  }

  public func writeDOT<Stream: TextOutputStream>(to stream: inout Stream) {
    stream.write("digraph Modules {\n")
    for (moduleId, moduleInfo) in graph.modules {
      stream.write(outputNode(for: moduleId))
      guard let dependencies = moduleInfo.directDependencies else {
        continue
      }
      for dependencyId in dependencies {
        stream.write("  \(quoteName(label(for: moduleId))) -> \(quoteName(label(for: dependencyId))) [color=black];\n")
      }
    }
    stream.write("}\n")
  }
}