Skip to content

Commit 8b82cf8

Browse files
aciidghaciidgh
committed
Refactor describe(), add llbuild tool types
1 parent c3e97ac commit 8b82cf8

File tree

3 files changed

+208
-89
lines changed

3 files changed

+208
-89
lines changed

‎Sources/Build/YAML.swift

Lines changed: 24 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -8,56 +8,37 @@
88
See http://swift.org/CONTRIBUTORS.txt for Swift project authors
99
*/
1010

11-
import struct Utility.Path
12-
import struct libc.FILE
13-
import func libc.fclose
14-
import POSIX
15-
16-
class YAML {
17-
let path: String
18-
private let fp: UnsafeMutablePointer<FILE>
19-
20-
init(path: String...) throws {
21-
self.path = Path.join(path)
22-
fp = try fopen(self.path, mode: .Write)
23-
}
11+
protocol YAMLRepresentable {
12+
var YAML: String { get }
13+
}
2414

25-
func close() {
26-
fclose(fp)
15+
extension String: YAMLRepresentable {
16+
var YAML: String {
17+
if self == "" { return "\"\"" }
18+
return self
2719
}
20+
}
2821

29-
func write(anys: Any...) throws {
30-
var anys = anys
31-
try fputs(anys.removeFirst() as! String, fp)
32-
if !anys.isEmpty {
33-
try fputs(anys.map(toYAML).joinWithSeparator(""), fp)
34-
}
35-
try fputs("\n", fp)
36-
22+
extension Bool: YAMLRepresentable {
23+
var YAML: String {
24+
if self { return "true" }
25+
return "false"
3726
}
3827
}
3928

40-
private func toYAML(any: Any) -> String {
41-
42-
func quote(input: String) -> String {
43-
for c in input.characters {
44-
if c == "@" || c == " " || c == "-" {
45-
return "\"\(input)\""
29+
extension Array: YAMLRepresentable {
30+
var YAML: String {
31+
let stringArray = self.flatMap { $0 as? String }
32+
guard stringArray.count == self.count else { return "" }
33+
34+
func quote(input: String) -> String {
35+
for c in input.characters {
36+
if c == "@" || c == " " || c == "-" {
37+
return "\"\(input)\""
38+
}
4639
}
40+
return input
4741
}
48-
return input
49-
}
50-
51-
switch any {
52-
case let string as String where string == "":
53-
return "\"\""
54-
case let string as String:
55-
return string
56-
case let array as [String]:
57-
return "[" + array.map(quote).joinWithSeparator(", ") + "]"
58-
case let bool as Bool:
59-
return bool ? "true" : "false"
60-
default:
61-
fatalError("Unimplemented YAML type")
42+
return "[" + stringArray.map(quote).joinWithSeparator(", ") + "]"
6243
}
6344
}

‎Sources/Build/describe().swift

Lines changed: 58 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import func POSIX.getenv
1212
import func POSIX.mkdir
1313
import PackageType
1414
import Utility
15+
import func POSIX.fopen
1516

1617
/**
1718
- Returns: path to generated YAML for consumption by the llbuild based swift-build-tool
@@ -25,25 +26,20 @@ public func describe(prefix: String, _ conf: Configuration, _ modules: [Module],
2526
let Xcc = Xcc.flatMap{ ["-Xcc", $0] } + extraImports()
2627
let Xld = Xld.flatMap{ ["-Xlinker", $0] }
2728
let prefix = try mkdir(prefix, conf.dirname)
28-
let yaml = try YAML(path: "\(prefix).yaml")
29-
let write = yaml.write
3029

31-
let (buildableTests, buildableNonTests) = (modules.map{$0 as Buildable} + products.map{$0 as Buildable}).partition{$0.isTest}
32-
let (tests, nontests) = (buildableTests.map{$0.targetName}, buildableNonTests.map{$0.targetName})
33-
34-
defer { yaml.close() }
35-
36-
try write("client:")
37-
try write(" name: swift-build")
38-
try write("tools: {}")
39-
try write("targets:")
40-
try write(" default: ", nontests)
41-
try write(" test: ", tests)
42-
try write("commands: ")
30+
var nonTests = [Command]()
31+
var tests = [Command]()
32+
33+
/// Appends the command to appropriate array
34+
func append(command: Command, buildable: Buildable) {
35+
if buildable.isTest {
36+
tests.append(command)
37+
} else {
38+
nonTests.append(command)
39+
}
40+
}
4341

4442
var mkdirs = Set<String>()
45-
46-
4743
let swiftcArgs = Xcc + Xswiftc
4844

4945
for case let module as SwiftModule in modules {
@@ -65,23 +61,22 @@ public func describe(prefix: String, _ conf: Configuration, _ modules: [Module],
6561
#endif
6662

6763
let node = IncrementalNode(module: module, prefix: prefix)
68-
69-
try write(" ", module.targetName, ":")
70-
try write(" tool: swift-compiler")
71-
try write(" executable: ", Resources.path.swiftc)
72-
try write(" module-name: ", module.c99name)
73-
try write(" module-output-path: ", node.moduleOutputPath)
74-
try write(" inputs: ", node.inputs)
75-
try write(" outputs: ", node.outputs)
76-
try write(" import-paths: ", prefix)
77-
try write(" temps-path: ", node.tempsPath)
78-
try write(" objects: ", node.objectPaths)
79-
try write(" other-args: ", args + otherArgs)
80-
try write(" sources: ", module.sources.paths)
81-
82-
// this must be set or swiftc compiles single source file
83-
// modules with a main() for some reason
84-
try write(" is-library: ", module.type == .Library)
64+
let swiftc = SwiftcTool(
65+
inputs: node.inputs,
66+
outputs: node.outputs,
67+
executable: Resources.path.swiftc,
68+
moduleName: module.c99name,
69+
moduleOutputPath: node.moduleOutputPath,
70+
importPaths: prefix,
71+
tempsPath: node.tempsPath,
72+
objects: node.objectPaths,
73+
otherArgs: args + otherArgs,
74+
sources: module.sources.paths,
75+
isLibrary: module.type == .Library) /// this must be set or swiftc compiles single source
76+
/// file modules with a main() for some reason
77+
78+
let command = Command(name: module.targetName, tool: swiftc)
79+
append(command, buildable: module)
8580

8681
for o in node.objectPaths {
8782
mkdirs.insert(o.parentDirectory)
@@ -96,12 +91,14 @@ public func describe(prefix: String, _ conf: Configuration, _ modules: [Module],
9691
args += ["-parse-as-library"]
9792
}
9893

99-
try write(" ", module.targetName, ":")
100-
try write(" tool: shell")
101-
try write(" description: Compiling \(module.name)")
102-
try write(" inputs: ", inputs)
103-
try write(" outputs: ", [productPath, module.targetName])
104-
try write(" args: ", [Resources.path.swiftc, "-o", productPath] + args + module.sources.paths + otherArgs)
94+
let shell = ShellTool(
95+
description: "Compiling \(module.name)",
96+
inputs: inputs,
97+
outputs: [productPath, module.targetName],
98+
args: [Resources.path.swiftc, "-o", productPath] + args + module.sources.paths + otherArgs)
99+
100+
let command = Command(name: module.targetName, tool: shell)
101+
append(command, buildable: module)
105102
}
106103
}
107104

@@ -175,15 +172,30 @@ public func describe(prefix: String, _ conf: Configuration, _ modules: [Module],
175172

176173
let inputs = product.modules.flatMap{ [$0.targetName] + IncrementalNode(module: $0, prefix: prefix).inputs }
177174

178-
try write(" \(product.targetName):")
179-
try write(" tool: shell")
180-
try write(" description: Linking \(product)")
181-
try write(" inputs: ", inputs)
182-
try write(" outputs: ", [product.targetName, outpath])
183-
try write(" args: ", args)
175+
let shell = ShellTool(
176+
description: "Linking \(product)",
177+
inputs: inputs,
178+
outputs: [product.targetName, outpath],
179+
args: args)
180+
181+
let command = Command(name: product.targetName, tool: shell)
182+
append(command, buildable: product)
184183
}
185184

186-
return yaml.path
185+
//Create Targets
186+
let nontestTarget = Target(name: "default", commands: nonTests)
187+
let testTarget = Target(name: "test", commands: tests)
188+
189+
//Generate YAML String for the targets
190+
let yamlString = llbuildYAML(targets: [nontestTarget, testTarget])
191+
192+
//Write YAML to file
193+
let yamlPath = "\(prefix).yaml"
194+
let fp = try fopen(yamlPath, mode: .Write)
195+
defer { fclose(fp) }
196+
try fputs(yamlString, fp)
197+
198+
return yamlPath
187199
}
188200

189201

‎Sources/Build/llbuild.swift

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
/*
2+
This source file is part of the Swift.org open source project
3+
4+
Copyright 2015 - 2016 Apple Inc. and the Swift project authors
5+
Licensed under Apache License v2.0 with Runtime Library Exception
6+
7+
See http://swift.org/LICENSE.txt for license information
8+
See http://swift.org/CONTRIBUTORS.txt for Swift project authors
9+
*/
10+
11+
protocol ToolType {
12+
var name: String { get }
13+
var inputs: [String] { get }
14+
var outputs: [String] { get }
15+
///YAML representation of the tool
16+
var llbuildYAML: String { get }
17+
}
18+
19+
protocol ShellToolType: ToolType {
20+
var description: String { get }
21+
var args: [String] { get }
22+
}
23+
24+
extension ShellToolType {
25+
26+
var name: String {
27+
return "shell"
28+
}
29+
30+
var llbuildYAML: String {
31+
var yaml = ""
32+
yaml += " tool: " + name.YAML + "\n"
33+
yaml += " description: " + description.YAML + "\n"
34+
yaml += " inputs: " + inputs.YAML + "\n"
35+
yaml += " outputs: " + outputs.YAML + "\n"
36+
yaml += " args: " + args.YAML + "\n"
37+
return yaml
38+
}
39+
}
40+
41+
struct ShellTool: ShellToolType {
42+
let description: String
43+
let inputs: [String]
44+
let outputs: [String]
45+
let args: [String]
46+
}
47+
48+
protocol SwiftcToolType: ToolType {
49+
var executable: String { get }
50+
var moduleName: String { get }
51+
var moduleOutputPath: String { get }
52+
var importPaths: String { get }
53+
var tempsPath: String { get }
54+
var objects: [String] { get }
55+
var otherArgs: [String] { get }
56+
var sources: [String] { get }
57+
var isLibrary: Bool { get }
58+
}
59+
60+
extension SwiftcToolType {
61+
62+
var name: String {
63+
return "swift-compiler"
64+
}
65+
66+
var llbuildYAML: String {
67+
var yaml = ""
68+
yaml += " tool: " + name.YAML + "\n"
69+
yaml += " executable: " + executable.YAML + "\n"
70+
yaml += " module-name: " + moduleName.YAML + "\n"
71+
yaml += " module-output-path: " + moduleOutputPath.YAML + "\n"
72+
yaml += " inputs: " + inputs.YAML + "\n"
73+
yaml += " outputs: " + outputs.YAML + "\n"
74+
yaml += " import-paths: " + importPaths.YAML + "\n"
75+
yaml += " temps-path: " + tempsPath.YAML + "\n"
76+
yaml += " objects: " + objects.YAML + "\n"
77+
yaml += " other-args: " + otherArgs.YAML + "\n"
78+
yaml += " sources: " + sources.YAML + "\n"
79+
yaml += " is-library: " + isLibrary.YAML + "\n"
80+
return yaml
81+
}
82+
}
83+
84+
struct SwiftcTool: SwiftcToolType {
85+
let inputs: [String]
86+
let outputs: [String]
87+
let executable: String
88+
let moduleName: String
89+
let moduleOutputPath: String
90+
let importPaths: String
91+
let tempsPath: String
92+
let objects: [String]
93+
let otherArgs: [String]
94+
let sources: [String]
95+
let isLibrary: Bool
96+
}
97+
98+
typealias Command = (name: String, tool: ToolType)
99+
100+
struct Target {
101+
let name: String
102+
let commands: [Command]
103+
}
104+
105+
func llbuildYAML(targets targets: [Target]) -> String {
106+
107+
var yaml = ""
108+
yaml += "client:" + "\n"
109+
yaml += " name: swift-build" + "\n"
110+
yaml += "tools: {}" + "\n"
111+
112+
yaml += "targets:" + "\n"
113+
for target in targets {
114+
yaml += " \(target.name): " + target.commands.map{$0.name}.YAML + "\n"
115+
}
116+
117+
yaml += "commands: " + "\n"
118+
119+
let commands = targets.reduce([Command]()) { $0 + $1.commands }
120+
for command in commands {
121+
yaml += " " + command.name + ":" + "\n"
122+
yaml += command.tool.llbuildYAML
123+
}
124+
125+
return yaml
126+
}

0 commit comments

Comments
 (0)