1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
@_implementationOnly
import CIndexStoreDB
public enum IndexSymbolKind: Hashable, Sendable {
case unknown
case module
case namespace
case namespaceAlias
case macro
case `enum`
case `struct`
case `class`
case `protocol`
case `extension`
case union
case `typealias`
case function
case variable
case field
case enumConstant
case instanceMethod
case classMethod
case staticMethod
case instanceProperty
case classProperty
case staticProperty
case constructor
case destructor
case conversionFunction
case parameter
case using
case concept
case commentTag
}
public enum Language: Hashable, Sendable {
case c
case cxx
case objc
case swift
}
public struct Symbol: Hashable, Sendable {
public var usr: String
public var name: String
public var kind: IndexSymbolKind
public var properties: SymbolProperty
public var language: Language
public init(
usr: String,
name: String,
kind: IndexSymbolKind,
properties: SymbolProperty = SymbolProperty(),
language: Language
) {
self.usr = usr
self.name = name
self.kind = kind
self.properties = properties
self.language = language
}
}
extension Symbol: Comparable {
public static func <(a: Symbol, b: Symbol) -> Bool {
return (a.usr, a.name) < (b.usr, b.name)
}
}
extension Symbol: CustomStringConvertible {
public var description: String {
if properties.isEmpty {
return "\(name) | \(kind) | \(usr) | \(language)"
}
return "\(name) | \(kind) (\(properties)) | \(usr) | \(language)"
}
}
extension Symbol {
/// Returns a copy of the symbol with the new name, usr, kind, and/or properties.
public func with(
name: String? = nil,
usr: String? = nil,
kind: IndexSymbolKind? = nil,
properties: SymbolProperty? = nil,
language: Language? = nil
) -> Symbol {
return Symbol(
usr: usr ?? self.usr,
name: name ?? self.name,
kind: kind ?? self.kind,
properties: properties ?? self.properties,
language: language ?? self.language
)
}
/// Returns a SymbolOccurrence with the given location and roles.
public func at(_ location: SymbolLocation, symbolProvider: SymbolProviderKind, roles: SymbolRole) -> SymbolOccurrence {
return SymbolOccurrence(symbol: self, location: location, roles: roles, symbolProvider: symbolProvider)
}
}
// MARK: CIndexStoreDB conversions
fileprivate extension Language {
init(_ value: indexstoredb_language_t) {
switch value {
case INDEXSTOREDB_LANGUAGE_C:
self = .c
case INDEXSTOREDB_LANGUAGE_CXX:
self = .cxx
case INDEXSTOREDB_LANGUAGE_OBJC:
self = .objc
case INDEXSTOREDB_LANGUAGE_SWIFT:
self = .swift
default:
preconditionFailure("Unhandled case from C enum indexstoredb_language_t")
}
}
}
extension Symbol {
/// Note: `value` is expected to be passed +1.
init(_ value: indexstoredb_symbol_t) {
self.init(
usr: String(cString: indexstoredb_symbol_usr(value)),
name: String(cString: indexstoredb_symbol_name(value)),
kind: IndexSymbolKind(indexstoredb_symbol_kind(value)),
properties: SymbolProperty(rawValue: indexstoredb_symbol_properties(value)),
language: Language(indexstoredb_symbol_language(value))
)
}
}
extension IndexSymbolKind {
init(_ cSymbolKind: indexstoredb_symbol_kind_t) {
switch cSymbolKind {
case INDEXSTOREDB_SYMBOL_KIND_UNKNOWN:
self = .unknown
case INDEXSTOREDB_SYMBOL_KIND_MODULE:
self = .module
case INDEXSTOREDB_SYMBOL_KIND_NAMESPACE:
self = .namespace
case INDEXSTOREDB_SYMBOL_KIND_NAMESPACEALIAS:
self = .namespaceAlias
case INDEXSTOREDB_SYMBOL_KIND_MACRO:
self = .macro
case INDEXSTOREDB_SYMBOL_KIND_ENUM:
self = .enum
case INDEXSTOREDB_SYMBOL_KIND_STRUCT:
self = .struct
case INDEXSTOREDB_SYMBOL_KIND_CLASS:
self = .class
case INDEXSTOREDB_SYMBOL_KIND_PROTOCOL:
self = .protocol
case INDEXSTOREDB_SYMBOL_KIND_EXTENSION:
self = .extension
case INDEXSTOREDB_SYMBOL_KIND_UNION:
self = .union
case INDEXSTOREDB_SYMBOL_KIND_TYPEALIAS:
self = .typealias
case INDEXSTOREDB_SYMBOL_KIND_FUNCTION:
self = .function
case INDEXSTOREDB_SYMBOL_KIND_VARIABLE:
self = .variable
case INDEXSTOREDB_SYMBOL_KIND_FIELD:
self = .field
case INDEXSTOREDB_SYMBOL_KIND_ENUMCONSTANT:
self = .enumConstant
case INDEXSTOREDB_SYMBOL_KIND_INSTANCEMETHOD:
self = .instanceMethod
case INDEXSTOREDB_SYMBOL_KIND_CLASSMETHOD:
self = .classMethod
case INDEXSTOREDB_SYMBOL_KIND_STATICMETHOD:
self = .staticMethod
case INDEXSTOREDB_SYMBOL_KIND_INSTANCEPROPERTY:
self = .instanceProperty
case INDEXSTOREDB_SYMBOL_KIND_CLASSPROPERTY:
self = .classProperty
case INDEXSTOREDB_SYMBOL_KIND_STATICPROPERTY:
self = .staticProperty
case INDEXSTOREDB_SYMBOL_KIND_CONSTRUCTOR:
self = .constructor
case INDEXSTOREDB_SYMBOL_KIND_DESTRUCTOR:
self = .destructor
case INDEXSTOREDB_SYMBOL_KIND_CONVERSIONFUNCTION:
self = .conversionFunction
case INDEXSTOREDB_SYMBOL_KIND_PARAMETER:
self = .parameter
case INDEXSTOREDB_SYMBOL_KIND_USING:
self = .using
case INDEXSTOREDB_SYMBOL_KIND_CONCEPT:
self = .concept
case INDEXSTOREDB_SYMBOL_KIND_COMMENTTAG:
self = .commentTag
default:
self = .unknown
}
}
}
|