Как создать перечисления битовой маски в стиле параметров NS в Swift?
в документации Apple о взаимодействии с API C они описывают способ NS_ENUM
-отмеченные перечисления в стиле C импортируются как быстрые перечисления. Это имеет смысл, и поскольку перечисления в Swift легко предоставляются как enum
тип значения легко увидеть, как создать свой собственный.
ниже, он говорит Это О NS_OPTIONS
- отмеченные параметры C-стиля:
Swift также импортирует параметры, помеченные
NS_OPTIONS
макрос. Поскольку опции похожи на импортные перечислений, варианты поддержка некоторых побитовых операций, таких как&
,|
и~
. В Objective-C, вы представляете пустой набор опций с постоянным нулем (0
). В Свифт, используйтеnil
чтобы представить отсутствие каких-либо вариантов.
учитывая, что нет options
тип значения в Swift, как мы можем создать переменную параметров C-Style для работы?
15 ответов
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)
}
вместо none
опция, рекомендация Swift 3-просто использовать пустой литерал массива:
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
просмотр параметров Objective-C, которые были импортированы Swift (UIViewAutoresizing
, например), мы видим, что функции объявлены как struct
, что соответствует протоколу RawOptionSetType
, что в свою очередь соответствует _RawOptionSetType
, Equatable
, RawRepresentable
, BitwiseOperationsType
и NilLiteralConvertible
. Мы можем создать свой собственный, как это:
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
, как описано в документации Apple: вы можете использовать enum
синтаксис:
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 1.1 beta 3.
Xcode 6.1 Beta 2 внес некоторые изменения в 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")
}
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]
}
вы можете найти здесь
в Swift 2 (в настоящее время бета-версия как часть бета-версии Xcode 7),NS_OPTIONS
- типы стилей импортируются как подтипы нового OptionSetType
тип. И благодаря новому Расширения Протокола функции и особенности OptionSetType
реализован в стандартной библиотеке, вы можете объявить свои собственные типы, которые расширяют OptionsSetType
и получить все те же функции и методы, импортированные NS_OPTIONS
- типы стилей get.
но эти функции не основаны на побитовое арифметическое операторов больше нет. То, что работа с набором неисключительных булевых опций в C требует маскировки и скручивания битов в поле, является деталью реализации. Действительно, набор опций-это set... коллекция уникальных предметов. Так что OptionsSetType
получает все методы от SetAlgebraType
протокол, как создание из синтаксиса массива литералов, запросы, такие как contains
, маска с intersection
, etc. (Больше не нужно помнить, какой забавный персонаж использовать для какого членства тест!)
//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`
}
Если вам не нужно взаимодействовать с 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!")
}
и так далее. Никаких реальных битов здесь нет. Это операции set для непрозрачных значений. Вы можете найти суть здесь.
Если единственная функциональность, которая нам нужна, - это способ объединить параметры с |
и проверьте, содержат ли комбинированные опции определенную опцию с &
альтернативой ответу Нейта Кука может быть следующее:
создать функции 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)
как уже упоминал Рикстер, вы можете использовать OptionSetType в Swift 2.0.
Типы NS_OPTIONS импортируются в соответствии с OptionSetType
протокол, который представляет собой набор-подобный интерфейс для опций:
struct CoffeeManipulators : OptionSetType {
let rawValue: Int
static let Milk = CoffeeManipulators(rawValue: 1)
static let Sugar = CoffeeManipulators(rawValue: 2)
static let MilkAndSugar = [Milk, Sugar]
}
Это дает вам такой способ работы:
struct Coffee {
let manipulators:[CoffeeManipulators]
// You can now simply check if an option is used with contains
func hasMilk() -> Bool {
return manipulators.contains(.Milk)
}
func hasManipulators() -> Bool {
return manipulators.count != 0
}
}
просто разместив дополнительный пример для тех, кто задавался вопросом, Можно ли комбинировать составные параметры. Вы можете, и они объединяются, как вы ожидаете, если вы привыкли к старой доброй полей:
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)"
Если мы думаем (может быть, к диаграмме Венна?) о том, что на самом деле представляет собой битовая маска, это, возможно, пустой набор.
конечно, при подходе к проблеме из первых принципов мы теряем удобство побитовых операторов, но получаем мощные методы на основе множества, которые улучшают читаемость.
вот моя возня например:
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, которые бросали бы вызов этой другой парадигме, где целочисленные необработанные значения все еще показывают достоинства.
во избежание жесткого кодирования битовых позиций, что неизбежно при использовании (1 << 0)
, (1 << 1)
, (1 << 15)
etc. или еще хуже!--4-->, 2
, 16384
etc. или какая-то шестнадцатеричная вариация, можно сначала определить биты в enum
, затем пусть сказал перечисление сделать бит порядковый расчет:
// Bits
enum Options : UInt {
case firstOption
case secondOption
case thirdOption
}
// Byte
struct MyOptions : OptionSet {
let rawValue: UInt
static let firstOption = MyOptions(rawValue: 1 << Options.firstOption.rawValue)
static let secondOption = MyOptions(rawValue: 1 << Options.secondOption.rawValue)
static let thirdOption = MyOptions(rawValue: 1 << Options.thirdOption.rawValue)
}
Я использую следующее, Мне нужны оба значения, которые я могу получить, rawValue для индексирования массивов и value для флагов.
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"
}
}
}
re: песочница и закладки творения с помощью наборов опций с несколькими вариантами
let options:NSURL.BookmarkCreationOptions = [.withSecurityScope,.securityScopeAllowOnlyReadAccess]
let temp = try link.bookmarkData(options: options, includingResourceValuesForKeys: nil, relativeTo: nil)
решение необходимости комбинировать параметры для творений, полезно, когда не все параметры являются взаимоисключающими.
ответ Нейта хорошо, но я бы сделал это 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)
}
используйте тип набора опций, в 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]
}