68 lines
2.4 KiB
Swift
68 lines
2.4 KiB
Swift
/// The accessibility of a Swift source declaration.
|
|
///
|
|
/// - SeeAlso: https://github.com/apple/swift/blob/main/docs/AccessControl.md
|
|
public enum AccessControlLevel: String, CustomStringConvertible {
|
|
/// Accessible by the declaration's immediate lexical scope.
|
|
case `private` = "source.lang.swift.accessibility.private"
|
|
/// Accessible by the declaration's same file.
|
|
case `fileprivate` = "source.lang.swift.accessibility.fileprivate"
|
|
/// Accessible by the declaration's same module, or modules importing it with the `@testable` attribute.
|
|
case `internal` = "source.lang.swift.accessibility.internal"
|
|
/// Accessible by the declaration's same program.
|
|
case `public` = "source.lang.swift.accessibility.public"
|
|
/// Accessible and customizable (via subclassing or overrides) by the declaration's same program.
|
|
case `open` = "source.lang.swift.accessibility.open"
|
|
|
|
/// Initializes an access control level by its Swift source keyword value.
|
|
///
|
|
/// - parameter value: The value used to describe this level in Swift source code.
|
|
public init?(description value: String) {
|
|
switch value {
|
|
case "private": self = .private
|
|
case "fileprivate": self = .fileprivate
|
|
case "internal": self = .internal
|
|
case "public": self = .public
|
|
case "open": self = .open
|
|
default: return nil
|
|
}
|
|
}
|
|
|
|
/// Initializes an access control level by its SourceKit unique identifier.
|
|
///
|
|
/// - parameter value: The value used by SourceKit to refer to this access control level.
|
|
internal init?(identifier value: String) {
|
|
self.init(rawValue: value)
|
|
}
|
|
|
|
public var description: String {
|
|
switch self {
|
|
case .private: return "private"
|
|
case .fileprivate: return "fileprivate"
|
|
case .internal: return "internal"
|
|
case .public: return "public"
|
|
case .open: return "open"
|
|
}
|
|
}
|
|
|
|
/// Returns true if is `private` or `fileprivate`
|
|
public var isPrivate: Bool {
|
|
return self == .private || self == .fileprivate
|
|
}
|
|
}
|
|
|
|
extension AccessControlLevel: Comparable {
|
|
private var priority: Int {
|
|
switch self {
|
|
case .private: return 1
|
|
case .fileprivate: return 2
|
|
case .internal: return 3
|
|
case .public: return 4
|
|
case .open: return 5
|
|
}
|
|
}
|
|
|
|
public static func < (lhs: AccessControlLevel, rhs: AccessControlLevel) -> Bool {
|
|
return lhs.priority < rhs.priority
|
|
}
|
|
}
|