├── .gitignore ├── .pre-commit-config.yaml ├── .swiftformat ├── .swiftlint.yml ├── Fixtures └── CProject │ ├── hello.c │ ├── hello.h │ └── main.c ├── LICENSE ├── Package.resolved ├── Package.swift ├── README.md ├── Sources └── Slake │ ├── FileDependency.swift │ └── TaskRunner.swift └── Tests └── SlakeTests └── SlakeTests.swift /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | /.build 3 | /Packages 4 | /*.xcodeproj 5 | xcuserdata/ 6 | .swiftpm 7 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | # See https://pre-commit.com for more information 2 | # See https://pre-commit.com/hooks.html for more hooks 3 | repos: 4 | - repo: https://github.com/pre-commit/pre-commit-hooks 5 | rev: v2.5.0 6 | hooks: 7 | - id: trailing-whitespace 8 | - id: end-of-file-fixer 9 | - id: check-yaml 10 | - id: check-added-large-files 11 | - id: detect-private-key 12 | - id: check-merge-conflict 13 | - repo: https://github.com/hodovani/pre-commit-swift 14 | rev: master 15 | hooks: 16 | - id: swift-lint 17 | - id: swift-format 18 | -------------------------------------------------------------------------------- /.swiftformat: -------------------------------------------------------------------------------- 1 | --indent 2 2 | --indentcase false 3 | --trimwhitespace always 4 | --voidtype tuple 5 | --nospaceoperators ..<,... 6 | --ifdef noindent 7 | --stripunusedargs closure-only 8 | --maxwidth 100 9 | --wraparguments before-first 10 | --funcattributes prev-line 11 | --disable andOperator 12 | --swiftversion 5.3 13 | -------------------------------------------------------------------------------- /.swiftlint.yml: -------------------------------------------------------------------------------- 1 | disabled_rules: 2 | - trailing_comma 3 | - identifier_name 4 | - void_return 5 | - operator_whitespace 6 | - nesting 7 | - cyclomatic_complexity 8 | - multiple_closures_with_trailing_closure 9 | - type_name 10 | - todo 11 | - large_tuple 12 | - opening_brace 13 | 14 | line_length: 100 15 | 16 | function_body_length: 17 | - 50 18 | 19 | included: 20 | - Sources 21 | - Tests 22 | -------------------------------------------------------------------------------- /Fixtures/CProject/hello.c: -------------------------------------------------------------------------------- 1 | // 2 | // Created by Max Desiatov on 29/11/2020. 3 | // 4 | 5 | #include "hello.h" 6 | 7 | void hello() { 8 | printf("Hello, world!\n"); 9 | } 10 | -------------------------------------------------------------------------------- /Fixtures/CProject/hello.h: -------------------------------------------------------------------------------- 1 | // 2 | // Created by Max Desiatov on 29/11/2020. 3 | // 4 | 5 | #ifndef File_h 6 | #define File_h 7 | 8 | #include 9 | 10 | void hello(void); 11 | 12 | #endif /* File_h */ 13 | -------------------------------------------------------------------------------- /Fixtures/CProject/main.c: -------------------------------------------------------------------------------- 1 | // 2 | // Created by Max Desiatov on 29/11/2020. 3 | // 4 | 5 | #include "hello.h" 6 | 7 | int main(int argc, char **argv) { 8 | hello(); 9 | return 0; 10 | } 11 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2020 Digital Signal Limited and Slake contributors 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Package.resolved: -------------------------------------------------------------------------------- 1 | { 2 | "object": { 3 | "pins": [ 4 | { 5 | "package": "CombineExpectations", 6 | "repositoryURL": "https://github.com/groue/CombineExpectations.git", 7 | "state": { 8 | "branch": null, 9 | "revision": "96d5604151c94b21fbca6877b237e80af9e821dd", 10 | "version": "0.5.0" 11 | } 12 | }, 13 | { 14 | "package": "swift-tools-support-core", 15 | "repositoryURL": "https://github.com/apple/swift-tools-support-core.git", 16 | "state": { 17 | "branch": null, 18 | "revision": "243beea77d20db46647a3de4765c96e2c801c7c7", 19 | "version": "0.1.12" 20 | } 21 | } 22 | ] 23 | }, 24 | "version": 1 25 | } 26 | -------------------------------------------------------------------------------- /Package.swift: -------------------------------------------------------------------------------- 1 | // swift-tools-version:5.3 2 | // The swift-tools-version declares the minimum version of Swift required to build this package. 3 | 4 | import PackageDescription 5 | 6 | let package = Package( 7 | name: "Slake", 8 | platforms: [.macOS(.v10_15)], 9 | products: [ 10 | // Products define the executables and libraries a package produces, and make them visible to other packages. 11 | .library( 12 | name: "Slake", 13 | targets: ["Slake"] 14 | ), 15 | ], 16 | dependencies: [ 17 | // Dependencies declare other packages that this package depends on. 18 | // .package(url: /* package url */, from: "1.0.0"), 19 | .package(url: "https://github.com/groue/CombineExpectations.git", from: "0.5.0"), 20 | .package(url: "https://github.com/apple/swift-tools-support-core.git", from: "0.1.12"), 21 | ], 22 | targets: [ 23 | // Targets are the basic building blocks of a package. A target can define a module or a test suite. 24 | // Targets can depend on other targets in this package, and on products in packages this package depends on. 25 | .target( 26 | name: "Slake", 27 | dependencies: [ 28 | .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"), 29 | ] 30 | ), 31 | .testTarget( 32 | name: "SlakeTests", 33 | dependencies: ["Slake", "CombineExpectations"] 34 | ), 35 | ] 36 | ) 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Slake 2 | 3 | ## A simple build system based on [Combine](https://developer.apple.com/documentation/combine), inspired by [llbuild2](https://github.com/apple/swift-llbuild2) and [rock](https://github.com/ollef/rock) 4 | 5 | Slake is a prototype of a [query-based](https://ollef.github.io/blog/posts/query-based-compilers.html) build system. 6 | It is still at a very early stage, and there isn't much usable code at the moment. 7 | -------------------------------------------------------------------------------- /Sources/Slake/FileDependency.swift: -------------------------------------------------------------------------------- 1 | // 2 | // Created by Max Desiatov on 24/11/2020. 3 | // 4 | 5 | import Combine 6 | import Dispatch 7 | import TSCBasic 8 | 9 | private let fsQueue = DispatchQueue.global(qos: .utility) 10 | 11 | struct FileInfo: Hashable, Codable { 12 | let path: AbsolutePath 13 | let size: UInt64 14 | let hash: [UInt8] 15 | } 16 | 17 | struct CObjectFile: Query { 18 | let sourceFile: FileInfo 19 | 20 | func task(for runner: TaskRunner) -> Task { 21 | runner.fork("cc", "-c", sourceFile.path.pathString) 22 | .flatMap { _ in 23 | runner.fileInfo( 24 | sourceFile.path.parentDirectory.appending( 25 | component: "\(sourceFile.path.basenameWithoutExt).o" 26 | ) 27 | ) 28 | }.eraseToTask() 29 | } 30 | } 31 | 32 | struct LinkExecutable: Query { 33 | let objectFiles: [FileInfo] 34 | let executableFile: AbsolutePath 35 | 36 | func task(for runner: TaskRunner) -> Task { 37 | runner.fork(["ld"] + objectFiles.map(\.path.pathString)) 38 | .flatMap { _ in 39 | runner.fileInfo( 40 | executableFile.parentDirectory.appending( 41 | component: executableFile.basenameWithoutExt 42 | ) 43 | ) 44 | } 45 | .eraseToTask() 46 | } 47 | } 48 | 49 | struct BuildCExecutable: Query { 50 | let sourceFiles: [AbsolutePath] 51 | let executableFile: AbsolutePath 52 | 53 | func task(for runner: TaskRunner) -> Task { 54 | runner.fileInfo(sourceFiles) 55 | .flatMap(maxPublishers: .unlimited) { 56 | runner.query(CObjectFile(sourceFile: $0)) 57 | } 58 | .collect() 59 | .flatMap { 60 | runner.query(LinkExecutable(objectFiles: $0, executableFile: executableFile)) 61 | } 62 | .map(\.path) 63 | .eraseToTask() 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /Sources/Slake/TaskRunner.swift: -------------------------------------------------------------------------------- 1 | import Combine 2 | import Dispatch 3 | import TSCBasic 4 | 5 | public protocol Query: Hashable, Codable { 6 | associatedtype Output 7 | associatedtype Failure: Error 8 | 9 | func task(for runner: TaskRunner) -> Task 10 | } 11 | 12 | public final class Task { 13 | init(publisher: AnyPublisher) { 14 | self.publisher = publisher 15 | } 16 | 17 | let publisher: AnyPublisher 18 | } 19 | 20 | public extension Publisher { 21 | func eraseToTask() -> Task { 22 | .init(publisher: eraseToAnyPublisher()) 23 | } 24 | } 25 | 26 | public final class Cache { 27 | init( 28 | getter: @escaping (AnyHashable) -> Any?, 29 | setter: @escaping (AnyHashable, Any?) -> (), 30 | queue: DispatchQueue 31 | ) { 32 | self.getter = getter 33 | self.setter = setter 34 | self.queue = queue 35 | } 36 | 37 | let getter: (AnyHashable) -> Any? 38 | let setter: (AnyHashable, Any?) -> () 39 | let queue: DispatchQueue 40 | 41 | subscript(_ key: AnyHashable) -> Any? { 42 | set { setter(key, newValue) } 43 | get { getter(key) } 44 | } 45 | 46 | public static var inMemory: Self { 47 | var cache = [AnyHashable: Any]() 48 | 49 | return .init(getter: { cache[$0] }, setter: { cache[$0] = $1 }, queue: DispatchQueue.main) 50 | } 51 | } 52 | 53 | public final class TaskRunner { 54 | private var resultsCache: Cache 55 | private var inProgress = [AnyHashable: Any]() 56 | 57 | public init(resultsCache: Cache) { 58 | self.resultsCache = resultsCache 59 | } 60 | 61 | public func query(_ query: Q) -> AnyPublisher { 62 | print("Running \(query)") 63 | 64 | if let inProgressTask = inProgress[query] as? AnyPublisher { 65 | print("Found in progress task for \(query)") 66 | return inProgressTask 67 | } 68 | 69 | if let cached = resultsCache[query] as? Q.Output { 70 | print("Found cached output for \(query)") 71 | return Just(cached).setFailureType(to: Q.Failure.self).eraseToAnyPublisher() 72 | } 73 | 74 | let task = query.task(for: self) 75 | print("Storing a reference to \(query) as in progress") 76 | inProgress[query] = task 77 | 78 | return task 79 | .publisher 80 | .receive(on: resultsCache.queue) 81 | .handleEvents( 82 | receiveOutput: { 83 | print("caching result \($0) for query \(query)") 84 | self.resultsCache[query] = $0 85 | }, 86 | receiveCompletion: { _ in 87 | self.inProgress[query] = nil 88 | } 89 | ).eraseToAnyPublisher() 90 | } 91 | 92 | func fileInfo(_ files: AbsolutePath...) -> AnyPublisher { 93 | fileInfo(files) 94 | } 95 | 96 | func fileInfo(_ files: [AbsolutePath]) -> AnyPublisher { 97 | Empty().eraseToAnyPublisher() 98 | } 99 | 100 | func fork(_ arguments: String...) -> AnyPublisher<(), Error> { 101 | fork(arguments) 102 | } 103 | 104 | func fork(_ arguments: [String]) -> AnyPublisher<(), Error> { 105 | Empty().eraseToAnyPublisher() 106 | } 107 | } 108 | -------------------------------------------------------------------------------- /Tests/SlakeTests/SlakeTests.swift: -------------------------------------------------------------------------------- 1 | import Combine 2 | import CombineExpectations 3 | import Slake 4 | import XCTest 5 | 6 | struct A: Query { 7 | func task(for runner: TaskRunner) -> Task { 8 | Just(10).eraseToTask() 9 | } 10 | } 11 | 12 | struct B: Query { 13 | func task(for runner: TaskRunner) -> Task { 14 | runner.query(A()).map { $0 + 20 }.eraseToTask() 15 | } 16 | } 17 | 18 | struct C: Query { 19 | func task(for runner: TaskRunner) -> Task { 20 | runner.query(A()).map { $0 + 30 }.eraseToTask() 21 | } 22 | } 23 | 24 | struct D: Query { 25 | func task(for runner: TaskRunner) -> Task { 26 | runner.query(B()) 27 | .zip(runner.query(C())) 28 | .map { $0.0 + $0.1 } 29 | .eraseToTask() 30 | } 31 | } 32 | 33 | final class SlakeTests: XCTestCase { 34 | func testSimpleQuery() throws { 35 | let runner = TaskRunner(resultsCache: .inMemory) 36 | 37 | let publisher1 = runner.query(D()) 38 | let recorder1 = publisher1.record() 39 | let elements1 = try wait(for: recorder1.elements, timeout: 0.1) 40 | 41 | XCTAssertEqual(elements1, [70]) 42 | 43 | print("First execution complete") 44 | 45 | let publisher2 = runner.query(D()) 46 | let recorder2 = publisher2.record() 47 | let elements2 = try wait(for: recorder2.elements, timeout: 0.1) 48 | XCTAssertEqual(elements2, [70]) 49 | } 50 | } 51 | --------------------------------------------------------------------------------