Swift 3.0

Question

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

再向下，它说明了NS_OPTIONS - 标记为C风格的选项：

Swift还会导入标有NS_OPTIONS宏的选项。而 options的行为与导入的枚举类似，选项也可以支持一些按位操作，例如&，|和~。在Objective-C中，您表示一个空的选项集，其常量为零（0）。在 Swift，使用nil表示没有任何选项。

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

Answer 1

Swift 3.0

几乎与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

在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)
}

现在我们可以使用基于集合的语义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 1.2

查看Swift导入的Objective-C选项（例如UIViewAutoresizing），我们可以看到选项被声明为符合协议struct的{{1}}，它反过来符合RawOptionSetType，_RawOptionSetType，Equatable，RawRepresentable和BitwiseOperationsType。我们可以像这样创建自己的：

NilLiteralConvertible

现在我们可以像处理Apple的文档中所描述的那样处理这个新选项集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) } }：您可以使用MyOptions - 就像语法一样：

enum

它的行为也像我们期望的行为选择：

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

我已经构建了generator to create a Swift option set而没有找到/替换所有内容。

最新消息： Swift 1.1 beta 3的修改。

Answer 2

Xcode 6.1 Beta 2对RawOptionSetType协议进行了一些更改（请参阅此Airspeedvelocity blog entry和Apple release notes）。

基于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示例：

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]
}

你可以找到它here

Answer 4

在Swift 2（目前作为Xcode 7测试版的一部分测试版）中，NS_OPTIONS - 样式类型作为新OptionSetType类型的子类型导入。由于新的Protocol Extensions功能以及OptionSetType在标准库中的实现方式，您可以声明自己的扩展OptionsSetType的类型，并获取导入{{{1}的所有相同功能和方法{1}} - 样式类型得到。

但这些功能不再基于按位算术运算符。在C中使用一组非排他性布尔选项需要在字段中屏蔽和修整位是一个实现细节。实际上，一组选项是 set ...一组独特的项目。因此NS_OPTIONS获取SetAlgebraType协议中的所有方法，例如从数组文字语法创建，OptionsSetType之类的查询，contains屏蔽等等。（不再需要记住哪个有趣的角色用于哪个会员考试！）

Answer 5

//Swift 2.0
 //create
    struct Direction : OptionSetType {
        let rawValue: Int
        static let None   = Direction(rawValue: 0)
        static let Top    = Direction(rawValue: 1 << 0)
        static let Bottom = Direction(rawValue: 1 << 1)
        static let Left   = Direction(rawValue: 1 << 2)
        static let Right  = Direction(rawValue: 1 << 3)
    }
//declare
var direction: Direction = Direction.None
//using
direction.insert(Direction.Right)
//check
if direction.contains(.Right) {
    //`enter code here`
}

Answer 6

如果你不需要与Objective-C进行互操作，只需要在Swift中使用位掩码的表面语义，我就编写了一个名为BitwiseOptions的简单“库”，它可以用常规的Swift枚举，例如：

enum Animal: BitwiseOptionsType {
    case Chicken
    case Cow
    case Goat
    static let allOptions = [.Chicken, .Cow, .Goat]
}

var animals = Animal.Chicken | Animal.Goat
animals ^= .Goat
if animals & .Chicken == .Chicken {
    println("Chick-Fil-A!")
}

等等。这里没有翻转实际位。这些是对不透明值的设置操作。你可以找到要点here。

Answer 7

如果我们需要的唯一功能是将选项与|组合在一起，并检查组合选项是否包含&的特定选项，那么替代Nate Cook的答案可能是：

创建选项protocol并重载|和&：

protocol OptionsProtocol {

    var value: UInt { get }
    init (_ value: UInt)

}

func | <T: OptionsProtocol>(left: T, right: T) -> T {
    return T(left.value | right.value)
}

func & <T: OptionsProtocol>(left: T, right: T) -> Bool {
    if right.value == 0 {
        return left.value == 0
    }
    else {
        return left.value & right.value == right.value
    }
}

现在我们可以更简单地创建选项结构：

struct MyOptions: OptionsProtocol {

    private(set) var value: UInt
    init (_ val: UInt) {value = val}

    static var None: MyOptions { return self(0) }
    static var One: MyOptions { return self(1 << 0) }
    static var Two: MyOptions { return self(1 << 1) }
    static var Three: MyOptions { return self(1 << 2) }
}

可以按如下方式使用：

func myMethod(#options: MyOptions) {
    if options & .One {
        // Do something
    }
}

myMethod(options: .One | .Three)

Answer 8

只是为其他想知道你是否可以组合复合选项的人发布了一个额外的例子。你可以，如果你已经习惯了旧的比特场，它们会像你期望的那样结合起来：

struct State: OptionSetType {
    let rawValue: Int
    static let A      = State(rawValue: 1 << 0)
    static let B      = State(rawValue: 1 << 1)
    static let X      = State(rawValue: 1 << 2)

    static let AB:State  = [.A, .B]
    static let ABX:State = [.AB, .X]    // Combine compound state with .X
}

let state: State = .ABX
state.contains(.A)        // true
state.contains(.AB)       // true

它将集合[.AB, .X]展平为[.A, .B, .X]（至少在语义上）：

print(state)      // 0b111 as expected: "State(rawValue: 7)"
print(State.AB)   // 0b11 as expected: "State(rawValue: 3)"

Answer 9

正如Rickster已经提到的，你可以在Swift 2.0中使用OptionSetType。导入的NS_OPTIONS类型符合# on build machine cd myproject pip wheel --wheel-dir wheelbase . scp -r wheelbase me@target.example.org # on target machine pip install --no-index --find-links=wheelbase myproject协议，该协议为选项提供类似集合的界面：

OptionSetType

它为您提供了这种工作方式：

struct CoffeeManipulators : OptionSetType {
    let rawValue: Int
    static let Milk     = CoffeeManipulators(rawValue: 1)
    static let Sugar    = CoffeeManipulators(rawValue: 2)
    static let MilkAndSugar = [Milk, Sugar]
}

Answer 10

没有人提到它 - 我在经过一些修补之后对它有点失误 - 但是Swift Set看起来运作得相当好。

如果我们想（可能是维恩图？）关于实际代表的掩码是什么，它可能是空集。

当然，在从第一原则处理问题时，我们失去了按位运算符的便利性，但获得了强大的基于集合的方法，从而提高了可读性。

以下是我的修修补补：

enum Toppings : String {
    // Just strings 'cause there's no other way to get the raw name that I know of...
    // Could be 1 << x too...
    case Tomato = "tomato"
    case Salami = "salami"
    case Cheese = "cheese"
    case Chicken = "chicken"
    case Beef = "beef"
    case Anchovies = "anchovies"

    static let AllOptions: Set<Toppings> = [.Tomato, .Salami, .Cheese, .Chicken, .Anchovies, .Beef]
}

func checkPizza(toppings: Set<Toppings>) {
    if toppings.contains(.Cheese) {
        print("Possible dairy allergies?")
    }

    let meats: Set<Toppings> = [.Beef, .Chicken, .Salami]
    if toppings.isDisjointWith(meats) {
        print("Vego-safe!")
    }
    if toppings.intersect(meats).count > 1 {
        print("Limit one meat, or 50¢ extra charge!")
    }

    if toppings == [Toppings.Cheese] {
        print("A bit boring?")
    }
}

checkPizza([.Tomato, .Cheese, .Chicken, .Beef])

checkPizza([.Cheese])

我发现这很好，因为我觉得它来自问题的第一原理方法 - 就像Swift一样 - 而不是试图适应C风格的解决方案。

还希望听到一些Obj-C用例会挑战这种不同的范例，其中整数原始值仍然显示出优点。

Answer 11

为了避免对位位置进行硬编码，这在使用(1 << 0)，(1 << 1)，(1 << 15)等甚至更差1时是不可避免的，{{1} }，2等或一些十六进制变体，可以先定义16384中的位，然后让所述枚举进行位序计算：

enum

Answer 12

我使用以下内容我需要我可以得到的两个值，rawValue用于索引数组和标记值。

enum MyEnum: Int {
    case one
    case two
    case four
    case eight

    var value: UInt8 {
        return UInt8(1 << self.rawValue)
    }
}

let flags: UInt8 = MyEnum.one.value ^ MyEnum.eight.value

(flags & MyEnum.eight.value) > 0 // true
(flags & MyEnum.four.value) > 0  // false
(flags & MyEnum.two.value) > 0   // false
(flags & MyEnum.one.value) > 0   // true

MyEnum.eight.rawValue // 3
MyEnum.four.rawValue  // 2

如果需要更多，只需添加计算属性。

enum MyEnum: Int {
    case one
    case two
    case four
    case eight

    var value: UInt8 {
        return UInt8(1 << self.rawValue)
    }

    var string: String {
        switch self {
        case .one:
            return "one"
        case .two:
            return "two"
        case .four:
            return "four"
        case .eight:
            return "eight"
        }
    }
}

Answer 13

re：使用带有多个选项的选项集进行沙盒和书签创作

let options:NSURL.BookmarkCreationOptions = [.withSecurityScope,.securityScopeAllowOnlyReadAccess]
let temp = try link.bookmarkData(options: options, includingResourceValuesForKeys: nil, relativeTo: nil)

需要组合创作选项的解决方案，当并非所有选项都互相排斥时非常有用。

Answer 14

Nate's answer很好，但我会把它DIY，就像这样：

struct MyOptions : OptionSetType {
    let rawValue: Int

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

Answer 15

使用选项集类型，在swift 3中使用OptionSet

struct ShippingOptions: OptionSet {
    let rawValue: Int

    static let nextDay    = ShippingOptions(rawValue: 1 << 0)
    static let secondDay  = ShippingOptions(rawValue: 1 << 1)
    static let priority   = ShippingOptions(rawValue: 1 << 2)
    static let standard   = ShippingOptions(rawValue: 1 << 3)

    static let express: ShippingOptions = [.nextDay, .secondDay]
    static let all: ShippingOptions = [.express, .priority, .standard]
}

如何在Swift中创建NS_OPTIONS样式的位掩码枚举？

15 个答案:

Swift 3.0

Swift 2.0

Swift 1.2