Splitflap/Sources/TokenGenerator.swift

90 lines
2.4 KiB
Swift

/*
* Splitflap
*
* Copyright 2015-present Yannick Loriot.
* http://yannickloriot.com
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
import Foundation
/**
A TokenGenerator helps the flap view by choosing the right token rescpecting the
initial order.
*/
final class TokenGenerator: IteratorProtocol {
typealias Element = String
let tokens: [String]
required init(tokens: [String]) {
self.tokens = tokens
}
// MARK: - Implementing GeneratorType
/// Current element index
fileprivate var currentIndex = 0
/// Returns the current element of the generator, nil otherwise.
var currentElement: Element? {
get {
if currentIndex < tokens.count {
return tokens[currentIndex]
}
return nil
}
set(newValue) {
if let value = newValue {
currentIndex = tokens.index(of: value) ?? currentIndex
}
else {
currentIndex = 0
}
}
}
/// Advance to the next element and return it, or `nil` if no next.
/// element exists.
@discardableResult
func next() -> Element? {
let tokenCount = tokens.count
guard tokenCount > 0 else {
return nil
}
currentIndex = (currentIndex + 1) % tokens.count
return tokens[currentIndex]
}
// MARK: - Convenience Methods
/// Returns the first token, or `nil` if no token.
var firstToken: String? {
get {
return tokens.first
}
}
}