Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introducing SwiftDeclarationAttributeKind #507

Merged
merged 1 commit into from
Apr 8, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@

##### Enhancements

* Add `SwiftDeclarationAttributeKind` that represents declaration attributes in Swift.
[Daniel Metzing](https://github.com/dirtydanee)
[#504](https://github.com/jpsim/SourceKitten/issues/504)

* Add `SourceKitObject` that represents `sourcekitd_object_t` in Swift.
[Norio Nomura](https://github.com/norio-nomura)
[#489](https://github.com/jpsim/SourceKitten/issues/489)
Expand Down
90 changes: 90 additions & 0 deletions Source/SourceKittenFramework/SwiftDeclarationAttributeKind.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
//
// SwiftDeclarationAttributeKind.swift
// SourceKittenFramework
//
// Created by Daniel.Metzing on 2018-04-04.
// Copyright © 2018 SourceKitten. All rights reserved.
//

import Foundation

/// Swift declaration attribute kinds.
/// Found in `strings SourceKitService | grep source.decl.attribute.`.
public enum SwiftDeclarationAttributeKind: String {
case ibaction = "source.decl.attribute.ibaction"
case iboutlet = "source.decl.attribute.iboutlet"
case ibdesignable = "source.decl.attribute.ibdesignable"
case ibinspectable = "source.decl.attribute.ibinspectable"
case gkinspectable = "source.decl.attribute.gkinspectable"
case objc = "source.decl.attribute.objc"
case objcName = "source.decl.attribute.objc.name"
case silgenName = "source.decl.attribute._silgen_name"
case available = "source.decl.attribute.available"
case `final` = "source.decl.attribute.final"
case `required` = "source.decl.attribute.required"
case `optional` = "source.decl.attribute.optional"
case noreturn = "source.decl.attribute.noreturn"
case epxorted = "source.decl.attribute._exported"
case nsCopying = "source.decl.attribute.NSCopying"
case nsManaged = "source.decl.attribute.NSManaged"
case `lazy` = "source.decl.attribute.lazy"
case lldbDebuggerFunction = "source.decl.attribute.LLDBDebuggerFunction"
case uiApplicationMain = "source.decl.attribute.UIApplicationMain"
case unsafeNoObjcTaggedPointer = "source.decl.attribute.unsafe_no_objc_tagged_pointer"
case inline = "source.decl.attribute.inline"
case semantics = "source.decl.attribute._semantics"
case dynamic = "source.decl.attribute.dynamic"
case infix = "source.decl.attribute.infix"
case prefix = "source.decl.attribute.prefix"
case postfix = "source.decl.attribute.postfix"
case transparent = "source.decl.attribute._transparent"
case requiresStoredProperyInits = "source.decl.attribute.requires_stored_property_inits"
case nonobjc = "source.decl.attribute.nonobjc"
case fixedLayout = "source.decl.attribute._fixed_layout"
case inlineable = "source.decl.attribute._inlineable"
case specialize = "source.decl.attribute._specialize"
case objcMembers = "source.decl.attribute.objcMembers"
case mutating = "source.decl.attribute.mutating"
case nonmutating = "source.decl.attribute.nonmutating"
case convenience = "source.decl.attribute.convenience"
case `override` = "source.decl.attribute.override"
case silSorted = "source.decl.attribute.sil_stored"
case `weak` = "source.decl.attribute.weak"
case effects = "source.decl.attribute.effects"
case objcBriged = "source.decl.attribute.__objc_bridged"
case nsApplicationMain = "source.decl.attribute.NSApplicationMain"
case objcNonLazyRealization = "source.decl.attribute.objc_non_lazy_realization"
case synthesizedProtocol = "source.decl.attribute.__synthesized_protocol"
case testable = "source.decl.attribute.testable"
case alignment = "source.decl.attribute._alignment"
case `rethrows` = "source.decl.attribute.rethrows"
case swiftNativeObjcRuntimeBase = "source.decl.attribute._swift_native_objc_runtime_base"
case indirect = "source.decl.attribute.indirect"
case warnUnqualifiedAccess = "source.decl.attribute.warn_unqualified_access"
case cdecl = "source.decl.attribute._cdecl"
case versioned = "source.decl.attribute._versioned"
case discardableResult = "source.decl.attribute.discardableResult"
case implements = "source.decl.attribute._implements"
case objcRuntimeName = "source.decl.attribute._objcRuntimeName"
case staticInitializeObjCMetadata = "source.decl.attribute._staticInitializeObjCMetadata"
case restatedObjCConformance = "source.decl.attribute._restatedObjCConformance"

#if (swift(>=4.1) || (swift(>=3.3) && !swift(>=4.0)))
case `private` = "source.decl.attribute.private"
case `fileprivate` = "source.decl.attribute.fileprivate"
case `internal` = "source.decl.attribute.internal"
case `public` = "source.decl.attribute.public"
case `open` = "source.decl.attribute.open"
case setterPrivate = "source.decl.attribute.setter_access.private"
case setterFilePrivate = "source.decl.attribute.setter_access.fileprivate"
case setterInternal = "source.decl.attribute.setter_access.internal"
case setterPublic = "source.decl.attribute.setter_access.public"
case setterOpen = "source.decl.attribute.setter_access.open"
case optimize = "source.decl.attribute._optimize"
case consuming = "source.decl.attribute.__consuming"
case implicitlyUnwrappedOptional = "source.decl.attribute._implicitly_unwrapped_optional"
#else
case autoclosure = "source.decl.attribute.autoclosure"
case noescape = "source.decl.attribute.noescape"
#endif
}
99 changes: 99 additions & 0 deletions Tests/SourceKittenFrameworkTests/SourceKitTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ private func sourcekitStrings(startingWith pattern: String) -> Set<String> {
})
}

// swiftlint:disable:next type_body_length
class SourceKitTests: XCTestCase {

func testStatementKinds() {
Expand Down Expand Up @@ -174,6 +175,103 @@ class SourceKitTests: XCTestCase {
}
}

// swiftlint:disable:next function_body_length
func testSwiftDeclarationAttributeKind() {
var expected: [SwiftDeclarationAttributeKind] = [
.ibaction,
.iboutlet,
.ibdesignable,
.ibinspectable,
.gkinspectable,
.objc,
.objcName,
.silgenName,
.available,
.final,
.required,
.optional,
.noreturn,
.epxorted,
.nsCopying,
.nsManaged,
.lazy,
.lldbDebuggerFunction,
.uiApplicationMain,
.unsafeNoObjcTaggedPointer,
.inline,
.semantics,
.dynamic,
.infix,
.prefix,
.postfix,
.transparent,
.requiresStoredProperyInits,
.nonobjc,
.fixedLayout,
.inlineable,
.specialize,
.objcMembers,
.mutating,
.nonmutating,
.convenience,
.override,
.silSorted,
.weak,
.effects,
.objcBriged,
.nsApplicationMain,
.objcNonLazyRealization,
.synthesizedProtocol,
.testable,
.alignment,
.rethrows,
.swiftNativeObjcRuntimeBase,
.indirect,
.warnUnqualifiedAccess,
.cdecl,
.versioned,
.discardableResult,
.implements,
.objcRuntimeName,
.staticInitializeObjCMetadata,
.restatedObjCConformance
]

#if (swift(>=4.1) || (swift(>=3.3) && !swift(>=4.0)))
expected.append(contentsOf: [
.private,
.fileprivate,
.internal,
.public,
.open,
.setterPrivate,
.setterFilePrivate,
.setterInternal,
.setterPublic,
.setterOpen,
.implicitlyUnwrappedOptional,
.optimize,
.consuming
])
#else
expected.append(contentsOf: [
.autoclosure,
.noescape
])
#endif

let actual = sourcekitStrings(startingWith: "source.decl.attribute.")
let expectedStrings = Set(expected.map { $0.rawValue })
XCTAssertEqual(
actual,
expectedStrings
)
if actual != expectedStrings {
print("the following strings were added: \(actual.subtracting(expectedStrings))")
print("the following strings were removed: \(expectedStrings.subtracting(actual))")
}
}

func testLibraryWrappersAreUpToDate() {
let sourceKittenFrameworkModule = Module(xcodeBuildArguments: sourcekittenXcodebuildArguments, name: nil, inPath: projectRoot)!
let modules: [(module: String, path: String, linuxPath: String?, spmModule: String)] = [
Expand Down Expand Up @@ -230,6 +328,7 @@ extension SourceKitTests {
("testStatementKinds", testStatementKinds),
("testSyntaxKinds", testSyntaxKinds),
("testSwiftDeclarationKind", testSwiftDeclarationKind),
("testSwiftDeclarationAttributeKind", testSwiftDeclarationAttributeKind),
("testIndex", testIndex),
("testYamlRequest", testYamlRequest)
]
Expand Down
4 changes: 4 additions & 0 deletions sourcekitten.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
objects = {

/* Begin PBXBuildFile section */
182F385020753FAD0054F063 /* SwiftDeclarationAttributeKind.swift in Sources */ = {isa = PBXBuildFile; fileRef = 182F384F20753FAD0054F063 /* SwiftDeclarationAttributeKind.swift */; };
2C55B3321BEB3CA7002E8C6B /* Result.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = E834D61D1B2D054B002AA1FE /* Result.framework */; };
2C55B3331BEB3CAB002E8C6B /* Commandant.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = E8EBAA5D1A5D374B002F1B8E /* Commandant.framework */; };
2E8FF7101C6268C100F280F0 /* StatementKind.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED279151C61E2A100084460 /* StatementKind.swift */; };
Expand Down Expand Up @@ -135,6 +136,7 @@
/* End PBXCopyFilesBuildPhase section */

/* Begin PBXFileReference section */
182F384F20753FAD0054F063 /* SwiftDeclarationAttributeKind.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SwiftDeclarationAttributeKind.swift; sourceTree = "<group>"; };
2ED279151C61E2A100084460 /* StatementKind.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = StatementKind.swift; sourceTree = "<group>"; };
3DEC5005206F7F180097835E /* ModuleInfoCommand.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ModuleInfoCommand.swift; sourceTree = "<group>"; };
3DEF4C581DBF9C2D00B3B54A /* DocInfoTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DocInfoTests.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -426,6 +428,7 @@
E8AE53C61A5B5FCA0092D24A /* String+SourceKitten.swift */,
E834740E1A593B5B00532B9A /* Structure.swift */,
E89291A81A5B800300D91568 /* SwiftDeclarationKind.swift */,
182F384F20753FAD0054F063 /* SwiftDeclarationAttributeKind.swift */,
E89291A61A5B7FF800D91568 /* SwiftDocKey.swift */,
E8A18A3E1A592246000362B7 /* SwiftDocs.swift */,
2ED279151C61E2A100084460 /* StatementKind.swift */,
Expand Down Expand Up @@ -702,6 +705,7 @@
E8AE53C71A5B5FCA0092D24A /* String+SourceKitten.swift in Sources */,
E834740F1A593B5B00532B9A /* Structure.swift in Sources */,
E89291A91A5B800300D91568 /* SwiftDeclarationKind.swift in Sources */,
182F385020753FAD0054F063 /* SwiftDeclarationAttributeKind.swift in Sources */,
E89291A71A5B7FF800D91568 /* SwiftDocKey.swift in Sources */,
E8A18A3F1A592246000362B7 /* SwiftDocs.swift in Sources */,
E80F23691A5CB01A00FD2352 /* SyntaxKind.swift in Sources */,
Expand Down