如何在Swift中创建NS_OPTIONS风格的位掩码枚举？

Question

在 Apple 关于与 C API 交互的文档中，他们描述了将标记NS_ENUM C 样式枚举导入为 Swift 枚举的方式。这是有道理的，并且由于 Swift 中的枚举很容易作为枚举值类型提供，因此很容易看到如何创建我们自己的枚举值类型。

再往下看，它是关于NS_OPTIONS标记的C样式选项的：

Swift还导入标有NS_options宏的选项。虽然选项的行为类似于导入的枚举，但选项也可以支持一些按位操作，例如

鉴于Swift中没有选项值类型，我们如何创建一个C-Style选项变量来使用？




Answer 1

文档中的 Swift 2.0 示例：

struct PackagingOptions : OptionSetType {
    let rawValue: Int
    init(rawValue: Int) { self.rawValue = rawValue }

    static let Box = PackagingOptions(rawValue: 1)
    static let Carton = PackagingOptions(rawValue: 2)
    static let Bag = PackagingOptions(rawValue: 4)
    static let Satchel = PackagingOptions(rawValue: 8)
    static let BoxOrBag: PackagingOptions = [Box, Bag]
    static let BoxOrCartonOrBag: PackagingOptions = [Box, Carton, Bag]
}

你可以在这里找到它

Answer 2

Xcode 6.1 Beta 2对< code>RawOptionSetType协议进行了一些更改(参见这篇Airspeedvelocity博客条目和Apple发行说明)。

基于Nate Cooks示例，此处是一个更新的解决方案。您可以像这样定义自己的选项集：

struct MyOptions : RawOptionSetType, BooleanType {
    private var value: UInt
    init(_ rawValue: UInt) { self.value = rawValue }

    // MARK: _RawOptionSetType
    init(rawValue: UInt) { self.value = rawValue }

    // MARK: NilLiteralConvertible
    init(nilLiteral: ()) { self.value = 0}

    // MARK: RawRepresentable
    var rawValue: UInt { return self.value }

    // MARK: BooleanType
    var boolValue: Bool { return self.value != 0 }

    // MARK: BitwiseOperationsType
    static var allZeros: MyOptions { return self(0) }

    // MARK: User defined bit values
    static var None: MyOptions          { return self(0) }
    static var FirstOption: MyOptions   { return self(1 << 0) }
    static var SecondOption: MyOptions  { return self(1 << 1) }
    static var ThirdOption: MyOptions   { return self(1 << 2) }
    static var All: MyOptions           { return self(0b111) }
}

然后可以像这样使用它来定义变量：

let opt1 = MyOptions.FirstOption
let opt2:MyOptions = .SecondOption
let opt3 = MyOptions(4)

像这样测试比特：

let singleOption = MyOptions.FirstOption
let multipleOptions: MyOptions = singleOption | .SecondOption
if multipleOptions & .SecondOption {
    println("multipleOptions has SecondOption")
}

let allOptions = MyOptions.All
if allOptions & .ThirdOption {
    println("allOptions has ThirdOption")
}

Answer 3

匿名用户

几乎与 Swift 2.0 相同。OptionSetType 已重命名为 OptionSet，枚举按照惯例写成小写。

struct MyOptions : OptionSet {
    let rawValue: Int

    static let firstOption  = MyOptions(rawValue: 1 << 0)
    static let secondOption = MyOptions(rawValue: 1 << 1)
    static let thirdOption  = MyOptions(rawValue: 1 << 2)
}

Swift 3 建议不要提供 none 选项，而是简单地使用空数组文字：

let noOptions: MyOptions = []

其他用法：

let singleOption = MyOptions.firstOption
let multipleOptions: MyOptions = [.firstOption, .secondOption]
if multipleOptions.contains(.secondOption) {
    print("multipleOptions has SecondOption")
}
let allOptions = MyOptions(rawValue: 7)
if allOptions.contains(.thirdOption) {
    print("allOptions has ThirdOption")
}

在Swift 2.0中，协议扩展处理了这些的大部分样板文件，这些样板文件现在作为符合OptionSetType的结构导入。（RawOptionSetType在Swift 2 beta 2中已经消失。）声明要简单得多：

struct MyOptions : OptionSetType {
    let rawValue: Int

    static let None         = MyOptions(rawValue: 0)
    static let FirstOption  = MyOptions(rawValue: 1 << 0)
    static let SecondOption = MyOptions(rawValue: 1 << 1)
    static let ThirdOption  = MyOptions(rawValue: 1 << 2)
}

现在，我们可以将基于集合的语义用于< code>MyOptions:

let singleOption = MyOptions.FirstOption
let multipleOptions: MyOptions = [.FirstOption, .SecondOption]
if multipleOptions.contains(.SecondOption) {
    print("multipleOptions has SecondOption")
}
let allOptions = MyOptions(rawValue: 7)
if allOptions.contains(.ThirdOption) {
    print("allOptions has ThirdOption")
}

查看Swift导入的Objective-C选项（例如，UIViewAutoresze），我们可以看到选项被声明为符合协议RawOptionSetType的结构，而该协议又符合_RawOptionSetType、等价、RawReposable、BitwiseoperationsType和Nil文学转换。我们可以像这样创建自己的：

struct MyOptions : RawOptionSetType {
    typealias RawValue = UInt
    private var value: UInt = 0
    init(_ value: UInt) { self.value = value }
    init(rawValue value: UInt) { self.value = value }
    init(nilLiteral: ()) { self.value = 0 }
    static var allZeros: MyOptions { return self(0) }
    static func fromMask(raw: UInt) -> MyOptions { return self(raw) }
    var rawValue: UInt { return self.value }

    static var None: MyOptions { return self(0) }
    static var FirstOption: MyOptions   { return self(1 << 0) }
    static var SecondOption: MyOptions  { return self(1 << 1) }
    static var ThirdOption: MyOptions   { return self(1 << 2) }
}

现在我们可以像Apple的留档中描述的那样对待这个新的选项集，MyOptions：您可以使用enum-like语法：

let opt1 = MyOptions.FirstOption
let opt2: MyOptions = .SecondOption
let opt3 = MyOptions(4)

它也表现得像我们期望的选项表现：

let singleOption = MyOptions.FirstOption
let multipleOptions: MyOptions = singleOption | .SecondOption
if multipleOptions & .SecondOption != nil {     // see note
    println("multipleOptions has SecondOption")
}
let allOptions = MyOptions.fromMask(7)   // aka .fromMask(0b111)
if allOptions & .ThirdOption != nil {
    println("allOptions has ThirdOption")
}

我已经构建了一个生成器来创建 Swift 选项集，而无需所有查找/替换。

最新:Swift 1.1 beta 3的修改。