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.

Sign up for GitHub

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

change KindIdentifier into a struct to handle unknown symbol kinds #7

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

change KindIdentifier into a struct to handle unknown symbol kinds #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b277035
store unknown symbol kinds to prevent loss of data
QuietMisdreavus Dec 7, 2021
378980d
tweak definitions of static KindIdentifiers
QuietMisdreavus Dec 15, 2021
783742b
tweak definition of `kind` in isKnownIdentifier
QuietMisdreavus Dec 15, 2021
7f66ceb
use the type name in favor of Self
QuietMisdreavus Dec 15, 2021
a1339c1
simplify lookupIdentifier using allCases lookup
QuietMisdreavus Dec 15, 2021
462f374
simplify trailing-closure syntax
QuietMisdreavus Dec 20, 2021
3c8b73d
Update Sources/SymbolKit/SymbolGraph/Symbol/Symbol+KindIdentifier.swift
QuietMisdreavus Dec 21, 2021
e28aab7
Update Sources/SymbolKit/SymbolGraph/Symbol/Symbol+KindIdentifier.swift
QuietMisdreavus Dec 21, 2021
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
143 changes: 60 additions & 83 deletions Sources/SymbolKit/SymbolGraph/Symbol/KindIdentifier.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,93 +14,65 @@ extension SymbolGraph.Symbol {
/**
A unique identifier of a symbol's kind, such as a structure or protocol.
*/
public enum KindIdentifier: Equatable, Hashable, Codable, CaseIterable {
case `associatedtype`
case `class`
case `deinit`
case `enum`
case `case`
case `func`
case `operator`
case `init`
case method
case property
case `protocol`
case snippet
case snippetGroup
case `struct`
case `subscript`
case typeMethod
case typeProperty
case typeSubscript
case `typealias`
case `var`
public struct KindIdentifier: Equatable, Hashable, Codable {
public let identifier: String

case module

case unknown

/// A string that uniquely identifies the symbol kind.
///
/// If the original kind string was not recognized, this will return `"unknown"`.
public var identifier: String {
switch self {
case .associatedtype: return "associatedtype"
case .class: return "class"
case .deinit: return "deinit"
case .enum: return "enum"
case .case: return "enum.case"
case .func: return "func"
case .operator: return "func.op"
case .`init`: return "init"
case .method: return "method"
case .property: return "property"
case .protocol: return "protocol"
case .snippet: return "snippet"
case .snippetGroup: return "snippetGroup"
case .struct: return "struct"
case .subscript: return "subscript"
case .typeMethod: return "type.method"
case .typeProperty: return "type.property"
case .typeSubscript: return "type.subscript"
case .typealias: return "typealias"
case .var: return "var"
case .module: return "module"
case .unknown: return "unknown"
}
private init(rawIdentifier: String) {
self.identifier = rawIdentifier
}

// FIXME: Save "unknown" symbol kinds in a synchronized set to prevent loss of data (rdar://84276085)
public static let `associatedtype` = KindIdentifier(rawIdentifier: "associatedtype")
public static let `class` = KindIdentifier(rawIdentifier: "class")
public static let `deinit` = KindIdentifier(rawIdentifier: "deinit")
public static let `enum` = KindIdentifier(rawIdentifier: "enum")
public static let `case` = KindIdentifier(rawIdentifier: "enum.case")
public static let `func` = KindIdentifier(rawIdentifier: "func")
public static let `operator` = KindIdentifier(rawIdentifier: "func.op")
public static let `init` = KindIdentifier(rawIdentifier: "init")
public static let `method` = KindIdentifier(rawIdentifier: "method")
public static let `property` = KindIdentifier(rawIdentifier: "property")
public static let `protocol` = KindIdentifier(rawIdentifier: "protocol")
public static let snippet = KindIdentifier(rawIdentifier: "snippet")
public static let snippetGroup = KindIdentifier(rawIdentifier: "snippetGroup")
public static let `struct` = KindIdentifier(rawIdentifier: "struct")
public static let `subscript` = KindIdentifier(rawIdentifier: "subscript")
public static let typeMethod = KindIdentifier(rawIdentifier: "type.method")
public static let typeProperty = KindIdentifier(rawIdentifier: "type.property")
public static let typeSubscript = KindIdentifier(rawIdentifier: "type.subscript")
public static let `typealias` = KindIdentifier(rawIdentifier: "typealias")
public static let `var` = KindIdentifier(rawIdentifier: "var")
public static let module = KindIdentifier(rawIdentifier: "module")

public static let allCases: [KindIdentifier] = [
.associatedtype,
.class,
.deinit,
.enum,
.case,
.func,
.operator,
.`init`,
.method,
.property,
.protocol,
.snippet,
.snippetGroup,
.struct,
.subscript,
.typeMethod,
.typeProperty,
.typeSubscript,
.typealias,
.var,
.module,
]

/// Check the given identifier string against the list of known identifiers.
///
/// - Parameter identifier: The identifier string to check.
/// - Returns: The matching `KindIdentifier` case, or `nil` if there was no match.
private static func lookupIdentifier(identifier: String) -> KindIdentifier? {
switch identifier {
case "associatedtype": return .associatedtype
case "class": return .class
case "deinit": return .deinit
case "enum": return .enum
case "enum.case": return .case
case "func": return .func
case "func.op": return .operator
case "init": return .`init`
case "method": return .method
case "property": return .property
case "protocol": return .protocol
case "snippet": return .snippet
case "snippetGroup": return .snippetGroup
case "struct": return .struct
case "subscript": return .subscript
case "type.method": return .typeMethod
case "type.property": return .typeProperty
case "type.subscript": return .typeSubscript
case "typealias": return .typealias
case "var": return .var
case "module": return .module
default: return nil
}
allCases.first { $0.identifier == identifier }
}

/// Compares the given identifier against the known default symbol kinds, and returns whether it matches one.
Expand All @@ -111,13 +83,13 @@ extension SymbolGraph.Symbol {
/// - Parameter identifier: The identifier string to compare.
/// - Returns: `true` if the given identifier matches a known symbol kind; otherwise `false`.
public static func isKnownIdentifier(_ identifier: String) -> Bool {
var kind: KindIdentifier?
let kind: KindIdentifier?

if let cachedDetail = Self.lookupIdentifier(identifier: identifier) {
if let cachedDetail = KindIdentifier.lookupIdentifier(identifier: identifier) {
kind = cachedDetail
} else {
let cleanIdentifier = KindIdentifier.cleanIdentifier(identifier)
kind = Self.lookupIdentifier(identifier: cleanIdentifier)
kind = KindIdentifier.lookupIdentifier(identifier: cleanIdentifier)
}

return kind != nil
Expand All @@ -131,14 +103,19 @@ extension SymbolGraph.Symbol {
/// - Parameter identifier: The identifier string to parse.
public init(identifier: String) {
// Check if the identifier matches a symbol kind directly.
if let firstParse = Self.lookupIdentifier(identifier: identifier) {
if let firstParse = KindIdentifier.lookupIdentifier(identifier: identifier) {
self = firstParse
} else {
// For symbol graphs which include a language identifier with their symbol kinds
// (e.g. "swift.func" instead of just "func"), strip off the language prefix and
// try again.
let cleanIdentifier = KindIdentifier.cleanIdentifier(identifier)
self = Self.lookupIdentifier(identifier: cleanIdentifier) ?? .unknown
if let secondParse = KindIdentifier.lookupIdentifier(identifier: cleanIdentifier) {
self = secondParse
} else {
// If we still don't have a match, store the whole original string.
self.init(rawIdentifier: identifier)
}
}
}

Expand Down
2 changes: 2 additions & 0 deletions Sources/SymbolKit/SymbolGraph/Symbol/Symbol.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/

import Foundation

extension SymbolGraph {
/**
A symbol from a module.
Expand Down
4 changes: 2 additions & 2 deletions Tests/SymbolKitTests/SymbolGraph/Symbol/SymbolKindTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ class SymbolKindTests: XCTestCase {
// Verify a bare language is not recognized.
XCTAssertFalse(SymbolGraph.Symbol.KindIdentifier.isKnownIdentifier("swift"))
kind = SymbolGraph.Symbol.KindIdentifier(identifier: "swift")
XCTAssertEqual(kind, .unknown)
XCTAssertEqual(kind.identifier, "swift")

// Verify if nothing is recognized, identifier and name is still there.
XCTAssertFalse(SymbolGraph.Symbol.KindIdentifier.isKnownIdentifier("swift.madeupapi"))
kind = SymbolGraph.Symbol.KindIdentifier(identifier: "swift.madeupapi")
XCTAssertEqual(kind, .unknown)
XCTAssertEqual(kind.identifier, "swift.madeupapi")
}

func testKindDecoding() throws {
Expand Down