Split up Request.swift.

Author: ainopara

Source/SourceKittenFramework/Request.swift

@@ -0,0 +1,49 @@
+//
+//  Request+CodeCompletion.swift
+//  SourceKittenFramework
+//
+//  Created by Zheng Li on 25/11/2017.
+//  Copyright © 2017 SourceKitten. All rights reserved.
+//
+
+import Foundation
+
+// swiftlint:disable nesting
+extension Request {
+    /// A `codecomplete` request by passing in the file name, contents, offset
+    /// for which to generate code completion options and array of compiler arguments.
+    public struct CodeComplete: RequestType {
+        public struct Source {
+            public let sourceFile: String?
+            public let sourceText: String?
+
+            public static func path(_ path: String) -> Source {
+                return Source(sourceFile: path, sourceText: nil)
+            }
+
+            public static func text(_ text: String, name: String? = nil) -> Source {
+                return Source(sourceFile: name, sourceText: text)
+            }
+        }
+        public let source: Source
+        public let offset: Int64
+        public let arguments: [String]
+
+        public func sourcekitObject() -> sourcekitd_object_t {
+            let requestBuilder = RequestBuilder(type: .codeComplete)
+            requestBuilder[.sourceFile] = source.sourceFile
+            requestBuilder[.sourceText] = source.sourceText
+            requestBuilder[.offset] = offset
+            requestBuilder[.compilerArgs] = arguments
+            return requestBuilder.makeRequest()
+        }
+    }
+
+    public static func codeCompletionRequest(file: String, contents: String, offset: Int64, arguments: [String]) -> Request {
+        return .codeComplete(source: .text(contents, name: file), offset: offset, arguments: arguments)
+    }
+
+    public static func codeComplete(source: CodeComplete.Source, offset: Int64, arguments: [String]) -> Request {
+        return Request(type: CodeComplete(source: source, offset: offset, arguments: arguments))
+    }
+}

Source/SourceKittenFramework/Requests/Request+CodeComplete.swift

@@ -0,0 +1,105 @@
+//
+//  Request+CursorInfo.swift
+//  SourceKittenFramework
+//
+//  Created by Zheng Li on 25/11/2017.
+//  Copyright © 2017 SourceKitten. All rights reserved.
+//
+
+import Foundation
+
+// swiftlint:disable nesting
+extension Request {
+    /// A `cursorinfo` request for an offset or an usr in the given file, using the `arguments` given.
+    public struct CursorInfo: RequestType {
+        public let name: String
+        public let sourceFile: String
+
+        public struct Location {
+            public let usr: String?
+            public let offset: Int64?
+            public let length: Int64?
+            public let retrieveRefactorActions: Bool?
+
+            public static func offset(_ offset: Int64, length: Int64? = nil, retrieveRefactorActions: Bool? = nil) -> Location {
+                return Location(usr: nil, offset: offset, length: length, retrieveRefactorActions: retrieveRefactorActions)
+            }
+
+            public static func usr(_ usr: String) -> Location {
+                return Location(usr: usr, offset: nil, length: nil, retrieveRefactorActions: nil)
+            }
+        }
+        public let location: Location
+        public let cancelOnSubsequentRequest: Bool?
+        public let arguments: [String]
+
+        public func sourcekitObject() -> sourcekitd_object_t {
+            let requestBuilder = RequestBuilder(type: .cursorInfo)
+            requestBuilder[.name] = name
+            requestBuilder[.sourceFile] = sourceFile
+            requestBuilder[.cancelOnSubsequentRequest] = cancelOnSubsequentRequest
+            requestBuilder[.uSR] = location.usr
+            requestBuilder[.offset] = location.offset
+            requestBuilder[.length] = location.length
+            requestBuilder[.retrieveRefactorActions] = location.retrieveRefactorActions
+            requestBuilder[.compilerArgs] = arguments
+            return requestBuilder.makeRequest()
+        }
+    }
+
+    public static func cursorInfo(file: String, offset: Int64, arguments: [String]) -> Request {
+        return .cursorInfo(name: file, file: file, location: .offset(offset), arguments: arguments)
+    }
+
+    public static func cursorInfo(
+        name: String,
+        file: String,
+        location: CursorInfo.Location,
+        cancelOnSubsequentRequest: Bool? = nil,
+        arguments: [String]
+        ) -> Request {
+        return Request(type: CursorInfo(
+            name: name,
+            sourceFile: file,
+            location: location,
+            cancelOnSubsequentRequest: cancelOnSubsequentRequest,
+            arguments: arguments
+        ))
+    }
+}
+
+// MARK: - CursorInfo reuse
+
+extension Request {
+
+    /**
+     Create a Request.CursorInfo.sourcekitObject() from a file path and compiler arguments.
+
+     - parameter filePath:  Path of the file to create request.
+     - parameter arguments: Compiler arguments.
+
+     - returns: sourcekitd_object_t representation of the Request, if successful.
+     */
+    internal static func cursorInfoRequest(filePath: String?, arguments: [String]) -> sourcekitd_object_t? {
+        if let path = filePath {
+            return Request.cursorInfo(file: path, offset: 0, arguments: arguments).type.sourcekitObject()
+        }
+        return nil
+    }
+
+    /**
+     Send a Request.CursorInfo by updating its offset. Returns SourceKit response if successful.
+
+     - parameter cursorInfoRequest: sourcekitd_object_t representation of Request.CursorInfo
+     - parameter offset:            Offset to update request.
+
+     - returns: SourceKit response if successful.
+     */
+    internal static func send(cursorInfoRequest: sourcekitd_object_t, atOffset offset: Int64) -> [String: SourceKitRepresentable]? {
+        if offset == 0 {
+            return nil
+        }
+        sourcekitd_request_dictionary_set_int64(cursorInfoRequest, sourcekitd_uid_get_from_cstr(SwiftDocKey.offset.rawValue)!, offset)
+        return try? Request.customRequest(request: cursorInfoRequest).failableSend()
+    }
+}

Source/SourceKittenFramework/Requests/Request+CursorInfo.swift

@@ -0,0 +1,24 @@
+//
+//  Request+Custom.swift
+//  SourceKittenFramework
+//
+//  Created by Zheng Li on 25/11/2017.
+//  Copyright © 2017 SourceKitten. All rights reserved.
+//
+
+import Foundation
+
+extension Request {
+    /// A custom request by passing in the sourcekitd_object_t directly.
+    public struct Custom: RequestType {
+        public let request: sourcekitd_object_t
+
+        public func sourcekitObject() -> sourcekitd_object_t {
+            return request
+        }
+    }
+
+    public static func customRequest(request: sourcekitd_object_t) -> Request {
+        return Request(type: Custom(request: request))
+    }
+}

Source/SourceKittenFramework/Requests/Request+Custom.swift

@@ -0,0 +1,27 @@
+//
+//  Request+Demangle.swift
+//  SourceKittenFramework
+//
+//  Created by Zheng Li on 25/11/2017.
+//  Copyright © 2017 SourceKitten. All rights reserved.
+//
+
+import Foundation
+
+extension Request {
+    /// Demangle swift names
+    public struct Demangle: RequestType {
+        public let names: [String]
+
+        public func sourcekitObject() -> sourcekitd_object_t {
+            let requestBuilder = RequestBuilder(type: .demangle)
+            requestBuilder[.names] = names
+
+            return requestBuilder.makeRequest()
+        }
+    }
+
+    public static func demangle(names: [String]) -> Request {
+        return Request(type: Demangle(names: names))
+    }
+}

Source/SourceKittenFramework/Requests/Request+Demangle.swift

@@ -0,0 +1,50 @@
+//
+//  Request+DocInfo.swift
+//  SourceKittenFramework
+//
+//  Created by Zheng Li on 25/11/2017.
+//  Copyright © 2017 SourceKitten. All rights reserved.
+//
+
+import Foundation
+
+extension Request {
+    /// A documentation request for the given source text.
+    /// Or a documentation request for the given module.
+    public struct DocInfo: RequestType {
+        public let name: String
+
+        public struct Source {
+            public let sourceText: String?
+            public let moduleName: String?
+
+            public static func text(_ sourceText: String) -> Source {
+                return Source(sourceText: sourceText, moduleName: nil)
+            }
+
+            public static func module(name moduleName: String) -> Source {
+                return Source(sourceText: nil, moduleName: moduleName)
+            }
+        }
+        public let source: Source
+        public let arguments: [String]
+
+        public func sourcekitObject() -> sourcekitd_object_t {
+            let requestBuilder = RequestBuilder(type: .docInfo)
+            requestBuilder[.name] = name
+            requestBuilder[.sourceText] = source.sourceText
+            requestBuilder[.moduleName] = source.moduleName
+            requestBuilder[.compilerArgs] = arguments
+
+            return requestBuilder.makeRequest()
+        }
+    }
+
+    public static func docInfo(text: String, arguments: [String]) -> Request {
+        return Request(type: DocInfo(name: NSUUID().uuidString, source: .text(text), arguments: arguments))
+    }
+
+    public static func moduleInfo(module: String, arguments: [String]) -> Request {
+        return Request(type: DocInfo(name: NSUUID().uuidString, source: .module(name: module), arguments: arguments))
+    }
+}

Source/SourceKittenFramework/Requests/Request+DocInfo.swift

@@ -0,0 +1,28 @@
+//
+//  Request+EditorFindUSR.swift
+//  SourceKittenFramework
+//
+//  Created by Zheng Li on 25/11/2017.
+//  Copyright © 2017 SourceKitten. All rights reserved.
+//
+
+import Foundation
+
+extension Request {
+    /// Find USR
+    public struct EditorFindUSR: RequestType {
+        public let sourceFile: String
+        public let usr: String
+
+        public func sourcekitObject() -> sourcekitd_object_t {
+            let requestBuilder = RequestBuilder(type: .editorFindUSR)
+            requestBuilder[.sourceFile] = sourceFile
+            requestBuilder[.uSR] = usr
+            return requestBuilder.makeRequest()
+        }
+    }
+
+    public static func findUSR(file: String, usr: String) -> Request {
+        return Request(type: EditorFindUSR(sourceFile: file, usr: usr))
+    }
+}

Source/SourceKittenFramework/Requests/Request+EditorFindUSR.swift

@@ -0,0 +1,48 @@
+//
+//  Request+EditorFormat.swift
+//  SourceKittenFramework
+//
+//  Created by Zheng Li on 25/11/2017.
+//  Copyright © 2017 SourceKitten. All rights reserved.
+//
+
+import Foundation
+
+extension Request {
+    /// Format
+    public struct EditorFormatText: RequestType {
+        public let name: String
+        public let line: Int64
+
+        public struct Options {
+            public let indentWidth: Int64
+            public let tabWidth: Int64
+            public let useTabs: Bool
+        }
+        public let options: Options
+
+        public func sourcekitObject() -> sourcekitd_object_t {
+            let requestBuilder = RequestBuilder(type: .editorFormatText)
+            requestBuilder[.name] = name
+            requestBuilder[.line] = line
+
+            let formatOptions: [String: Any] = [
+                "key.editor.format.indentwidth": options.indentWidth,
+                "key.editor.format.tabwidth": options.tabWidth,
+                "key.editor.format.usetabs": options.useTabs
+            ]
+            requestBuilder[.formatOptions] = formatOptions
+
+            return requestBuilder.makeRequest()
+        }
+    }
+
+    public static func format(file: String, line: Int64, useTabs: Bool, indentWidth: Int64) -> Request {
+        let options = EditorFormatText.Options(
+            indentWidth: indentWidth,
+            tabWidth: indentWidth,
+            useTabs: useTabs
+        )
+        return Request(type: EditorFormatText(name: file, line: line, options: options))
+    }
+}