File: ToolingUtil.swift

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (196 lines) | stat: -rw-r--r-- 9,806 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
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
//===------- ToolingUtil.swift - Swift Driver Source Version--------------===//
//
// This source file is part of the Swift.org 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 https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import class TSCBasic.DiagnosticsEngine
import struct TSCBasic.Diagnostic
import class TSCBasic.ProcessSet
import enum TSCBasic.ProcessEnv
import var TSCBasic.localFileSystem
import SwiftOptions

//typedef enum {
//  SWIFTDRIVER_TOOLING_DIAGNOSTIC_ERROR = 0,
//  SWIFTDRIVER_TOOLING_DIAGNOSTIC_WARNING = 1,
//  SWIFTDRIVER_TOOLING_DIAGNOSTIC_REMARK = 2,
//  SWIFTDRIVER_TOOLING_DIAGNOSTIC_NOTE = 3
//} swiftdriver_tooling_diagnostic_kind;
public let SWIFTDRIVER_TOOLING_DIAGNOSTIC_ERROR: CInt = 0;
public let SWIFTDRIVER_TOOLING_DIAGNOSTIC_WARNING: CInt = 1;
public let SWIFTDRIVER_TOOLING_DIAGNOSTIC_REMARK: CInt = 2;
public let SWIFTDRIVER_TOOLING_DIAGNOSTIC_NOTE: CInt = 3;

@_cdecl("swift_getSingleFrontendInvocationFromDriverArgumentsV2")
public func getSingleFrontendInvocationFromDriverArgumentsV2(driverPath: UnsafePointer<CChar>,
                                                             argListCount: CInt,
                                                             argList: UnsafePointer<UnsafePointer<CChar>?>,
                                                             action: @convention(c) (CInt, UnsafePointer<UnsafePointer<CChar>?>) -> Bool,
                                                             diagnosticCallback: @convention(c) (CInt, UnsafePointer<CChar>) -> Void,
                                                             forceNoOutputs: Bool = false) -> Bool {
  return getSingleFrontendInvocationFromDriverArgumentsV3(driverPath: driverPath, argListCount: argListCount,
                                                          argList: argList, action: action,
                                                          diagnosticCallback: diagnosticCallback,
                                                          compilerIntegratedTooling: true)
}

@_cdecl("swift_getSingleFrontendInvocationFromDriverArgumentsV3")
public func getSingleFrontendInvocationFromDriverArgumentsV3(driverPath: UnsafePointer<CChar>,
                                                             argListCount: CInt,
                                                             argList: UnsafePointer<UnsafePointer<CChar>?>,
                                                             action: @convention(c) (CInt, UnsafePointer<UnsafePointer<CChar>?>) -> Bool,
                                                             diagnosticCallback: @convention(c) (CInt, UnsafePointer<CChar>) -> Void,
                                                             compilerIntegratedTooling: Bool = false,
                                                             forceNoOutputs: Bool = false) -> Bool {
  // Bridge the driver path argument
  let bridgedDriverPath = String(cString: driverPath)

  // Bridge the argv equivalent
  let argListBufferPtr = UnsafeBufferPointer<UnsafePointer<CChar>?>(start: argList, count: Int(argListCount))
  let bridgedArgList = [bridgedDriverPath] + argListBufferPtr.map { String(cString: $0!) }

  // Bridge the action callback
  let bridgedAction: ([String]) -> Bool = { args in
    return withArrayOfCStrings(args) {
      return action(CInt(args.count), $0!)
    }
  }

  // Bridge the diagnostic callback
  let bridgedDiagnosticCallback: (CInt, String) -> Void = { diagKind, message in
    diagnosticCallback(diagKind, message)
  }

  var diagnostics: [Diagnostic] = []
  let result = getSingleFrontendInvocationFromDriverArgumentsV2(driverPath: bridgedDriverPath,
                                                                argList: bridgedArgList,
                                                                action: bridgedAction,
                                                                diagnostics: &diagnostics,
                                                                diagnosticCallback: bridgedDiagnosticCallback,
                                                                compilerIntegratedTooling: compilerIntegratedTooling,
                                                                forceNoOutputs: forceNoOutputs)
  return result
}

/// Generates the list of arguments that would be passed to the compiler
/// frontend from the given driver arguments, for a single-compiler-invocation
/// context.
///
/// \param driverPath the driver executable path
/// \param argList The driver arguments (i.e. normal arguments for \c swiftc).
/// \param diagnostics Contains the diagnostics emitted by the driver
/// \param action invokes a user-provided action on the resulting frontend invocation command
/// \param compilerIntegratedTooling If true, this code is executed in the context of a
///        Swift compiler image which contains symbols normally queried from a libSwiftScan instance.
/// \param forceNoOutputs If true, override the output mode to "-typecheck" and
/// produce no outputs. For example, this disables "-emit-module" and "-c" and
/// prevents the creation of temporary files.
///
/// \returns true on error
///
/// \note This function is not intended to create invocations which are
/// suitable for use in REPL or immediate modes.
public func getSingleFrontendInvocationFromDriverArgumentsV2(driverPath: String,
                                                             argList: [String],
                                                             action: ([String]) -> Bool,
                                                             diagnostics: inout [Diagnostic],
                                                             diagnosticCallback:  @escaping (CInt, String) -> Void,
                                                             compilerIntegratedTooling: Bool = false,
                                                             forceNoOutputs: Bool = false) -> Bool {
  /// Handler for emitting diagnostics to tooling clients.
  let toolingDiagnosticsHandler: DiagnosticsEngine.DiagnosticsHandler = { diagnostic in
    let diagnosticKind: CInt
    switch diagnostic.message.behavior {
    case .error:
      diagnosticKind = SWIFTDRIVER_TOOLING_DIAGNOSTIC_ERROR
    case .warning:
      diagnosticKind = SWIFTDRIVER_TOOLING_DIAGNOSTIC_WARNING
    case .note:
      diagnosticKind = SWIFTDRIVER_TOOLING_DIAGNOSTIC_NOTE
    case .remark:
      diagnosticKind = SWIFTDRIVER_TOOLING_DIAGNOSTIC_REMARK
    default:
      diagnosticKind = SWIFTDRIVER_TOOLING_DIAGNOSTIC_ERROR
    }
    diagnosticCallback(diagnosticKind, diagnostic.message.text)
  }
  let diagnosticsEngine = DiagnosticsEngine(handlers: [toolingDiagnosticsHandler])
  defer { diagnostics = diagnosticsEngine.diagnostics }

  var singleFrontendTaskCommand: [String] = []
  var args: [String] = []
  args.append(contentsOf: argList)

  // When creating a CompilerInvocation, ensure that the driver creates a single
  // frontend command.
  args.append("-whole-module-optimization")

  // Explicitly disable batch mode to avoid a spurious warning when combining
  // -enable-batch-mode with -whole-module-optimization.  This is an
  // implementation detail.
  args.append("-disable-batch-mode");

  // Prevent having a separate job for emit-module, we would like
  // to just have one job
  args.append("-no-emit-module-separately-wmo")

  // Avoid using filelists
  args.append("-driver-filelist-threshold");
  args.append(String(Int.max));

  do {
    args = try [driverPath] + Driver.expandResponseFiles(args,
                                                         fileSystem: localFileSystem,
                                                         diagnosticsEngine: diagnosticsEngine)

    let optionTable = OptionTable()
    var parsedOptions = try optionTable.parse(Array(args), for: .batch, delayThrows: true)
    if forceNoOutputs {
      // Clear existing output modes and supplementary outputs.
      parsedOptions.eraseAllArguments(in: .modes)
      parsedOptions.eraseSupplementaryOutputs()
      parsedOptions.addOption(.typecheck, argument: .none)
    }

    // Instantiate the driver, setting up the toolchain in the process, etc.
    let resolver = try ArgsResolver(fileSystem: localFileSystem)
    let executor = SimpleExecutor(resolver: resolver,
                                  fileSystem: localFileSystem,
                                  env: ProcessEnv.vars)
    var driver = try Driver(args: parsedOptions.commandLine,
                            diagnosticsOutput: .engine(diagnosticsEngine),
                            executor: executor,
                            compilerIntegratedTooling: compilerIntegratedTooling)
    if diagnosticsEngine.hasErrors {
      return true
    }

    let buildPlan = try driver.planBuild()
    if diagnosticsEngine.hasErrors {
      return true
    }
    let compileJobs = buildPlan.filter({ $0.kind == .compile })
    guard let compileJob = compileJobs.spm_only else {
      diagnosticsEngine.emit(.error_expected_one_frontend_job())
      return true
    }
    if !compileJob.commandLine.starts(with: [.flag("-frontend")]) {
      diagnosticsEngine.emit(.error_expected_frontend_command())
      return true
    }
    singleFrontendTaskCommand = try executor.description(of: compileJob,
                                                         forceResponseFiles: false).components(separatedBy: " ")
  } catch {
    print("Unexpected error: \(error).")
    return true
  }

  return action(singleFrontendTaskCommand)
}