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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2022 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import ArgumentParser
import Basics
import CoreCommands
import Foundation
import PackageModel
import XCBuildSupport
struct DumpSymbolGraph: SwiftCommand {
static let configuration = CommandConfiguration(
abstract: "Dump Symbol Graph")
static let defaultMinimumAccessLevel = SymbolGraphExtract.AccessLevel.public
@OptionGroup(visibility: .hidden)
var globalOptions: GlobalOptions
@Flag(help: "Pretty-print the output JSON.")
var prettyPrint = false
@Flag(help: "Skip members inherited through classes or default implementations.")
var skipSynthesizedMembers = false
@Option(help: "Include symbols with this access level or more. Possible values: \(SymbolGraphExtract.AccessLevel.allValueStrings.joined(separator: " | "))")
var minimumAccessLevel = defaultMinimumAccessLevel
@Flag(help: "Skip emitting doc comments for members inherited through classes or default implementations.")
var skipInheritedDocs = false
@Flag(help: "Add symbols with SPI information to the symbol graph.")
var includeSPISymbols = false
@Flag(help: "Emit extension block symbols for extensions to external types or directly associate members and conformances with the extended nominal.")
var extensionBlockSymbolBehavior: ExtensionBlockSymbolBehavior = .omitExtensionBlockSymbols
func run(_ swiftCommandState: SwiftCommandState) throws {
// Build the current package.
//
// We turn build manifest caching off because we need the build plan.
let buildSystem = try swiftCommandState.createBuildSystem(explicitBuildSystem: .native, cacheBuildManifest: false)
try buildSystem.build()
// Configure the symbol graph extractor.
let symbolGraphExtractor = try SymbolGraphExtract(
fileSystem: swiftCommandState.fileSystem,
tool: swiftCommandState.getTargetToolchain().getSymbolGraphExtract(),
observabilityScope: swiftCommandState.observabilityScope,
skipSynthesizedMembers: skipSynthesizedMembers,
minimumAccessLevel: minimumAccessLevel,
skipInheritedDocs: skipInheritedDocs,
includeSPISymbols: includeSPISymbols,
emitExtensionBlockSymbols: extensionBlockSymbolBehavior == .emitExtensionBlockSymbols,
outputFormat: .json(pretty: prettyPrint)
)
// Run the tool once for every library and executable target in the root package.
let buildPlan = try buildSystem.buildPlan
let symbolGraphDirectory = buildPlan.destinationBuildParameters.dataPath.appending("symbolgraph")
let targets = try buildSystem.getPackageGraph().rootPackages.flatMap{ $0.modules }.filter{ $0.type == .library }
for target in targets {
print("-- Emitting symbol graph for", target.name)
let result = try symbolGraphExtractor.extractSymbolGraph(
module: target,
buildPlan: buildPlan,
buildParameters: buildPlan.destinationBuildParameters,
outputRedirection: .collect(redirectStderr: true),
outputDirectory: symbolGraphDirectory,
verboseOutput: swiftCommandState.logLevel <= .info
)
if result.exitStatus != .terminated(code: 0) {
let commandline = "\nUsing commandline: \(result.arguments)"
switch result.output {
case .success(let value):
swiftCommandState.observabilityScope.emit(error: "Failed to emit symbol graph for '\(target.c99name)': \(String(decoding: value, as: UTF8.self))\(commandline)")
case .failure(let error):
swiftCommandState.observabilityScope.emit(error: "Internal error while emitting symbol graph for '\(target.c99name)': \(error)\(commandline)")
}
}
}
print("Files written to", symbolGraphDirectory.pathString)
}
}
enum ExtensionBlockSymbolBehavior: String, EnumerableFlag {
case emitExtensionBlockSymbols
case omitExtensionBlockSymbols
}
struct DumpPackage: AsyncSwiftCommand {
static let configuration = CommandConfiguration(
abstract: "Print parsed Package.swift as JSON")
@OptionGroup(visibility: .hidden)
var globalOptions: GlobalOptions
func run(_ swiftCommandState: SwiftCommandState) async throws {
let workspace = try swiftCommandState.getActiveWorkspace()
let root = try swiftCommandState.getWorkspaceRoot()
let rootManifests = try await workspace.loadRootManifests(
packages: root.packages,
observabilityScope: swiftCommandState.observabilityScope
)
guard let rootManifest = rootManifests.values.first else {
throw StringError("invalid manifests at \(root.packages)")
}
let encoder = JSONEncoder.makeWithDefaults()
encoder.userInfo[Manifest.dumpPackageKey] = true
let jsonData = try encoder.encode(rootManifest)
let jsonString = String(decoding: jsonData, as: UTF8.self)
print(jsonString)
}
}
struct DumpPIF: SwiftCommand {
// hides this command from CLI `--help` output
static let configuration = CommandConfiguration(shouldDisplay: false)
@OptionGroup(visibility: .hidden)
var globalOptions: GlobalOptions
@Flag(help: "Preserve the internal structure of PIF")
var preserveStructure: Bool = false
func run(_ swiftCommandState: SwiftCommandState) throws {
let graph = try swiftCommandState.loadPackageGraph()
let pif = try PIFBuilder.generatePIF(
buildParameters: swiftCommandState.productsBuildParameters,
packageGraph: graph,
fileSystem: swiftCommandState.fileSystem,
observabilityScope: swiftCommandState.observabilityScope,
preservePIFModelStructure: preserveStructure)
print(pif)
}
var toolWorkspaceConfiguration: ToolWorkspaceConfiguration {
return .init(wantsMultipleTestProducts: true)
}
}
|
