//

// RouteComposer

// SearchOptions.swift

// https://github.com/ekazaev/route-composer

//

// Created by Eugene Kazaev in 2018-2022.

// Distributed under the MIT license.

//

// Become a sponsor:

// https://github.com/sponsors/ekazaev

//

import Foundation

/// A set of options for the `findViewController` method

public struct SearchOptions: OptionSet, CaseIterable, CustomStringConvertible {

    public let rawValue: Int

    // MARK: Options

    /// Compare to a view controller provided

    public static let current = SearchOptions(rawValue: 1 << 0)

    /// If a view controller is a container, search in its visible view controllers

    public static let visible = SearchOptions(rawValue: 1 << 1)

    /// If a view controller is a container, search in all the view controllers it contains

    public static let contained = SearchOptions(rawValue: 1 << 2)

    /// Start search from the view controller provided and search in all view controllers it presented

    public static let presented = SearchOptions(rawValue: 1 << 3)

    /// Start search from the view controller provided and search in all view controllers that are presenting it

    public static let presenting = SearchOptions(rawValue: 1 << 4)

    /// Start search from the view controller provided and search in all its parent view controllers

    public static let parent = SearchOptions(rawValue: 1 << 5)

    // MARK: Combinations

    /// If a view controller is a container, search in all the view controllers it contains

    public static let currentAllStack: SearchOptions = [.current, .contained]

    /// If a view controller is a container, search in all visible view controllers it contains

    public static let currentVisibleOnly: SearchOptions = [.current, .visible]

    /// Iterate through the all visible view controllers in the stack.

    public static let allVisible: SearchOptions = [.currentVisibleOnly, .presented, .presenting]

    /// Iterate through the all view controllers in the stack.

    public static let fullStack: SearchOptions = [.current, .contained, .presented, .presenting]

    /// Iterate through the all view controllers on the current level and all the view controllers

    /// presented from the current level.

    public static let currentAndUp: SearchOptions = [.currentAllStack, .presented]

    /// Iterate through the all view controllers on the current level and all the view controllers

    /// that are presenting the current level.

    public static let currentAndDown: SearchOptions = [.currentAllStack, .presenting]

    // MARK: Methods

}